From 46251db167c8d2a32a0a7f96b1c897ad7faf4afc Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 1 Apr 2012 23:57:15 +0200 Subject: [PATCH] Qual: Use a shared function to define logo heigth. Qual: Add more phpunit tests Fix: This also solve overlapping logos. --- htdocs/core/lib/pdf.lib.php | 21 +++ .../commande/doc/pdf_edison.modules.php | 3 +- .../commande/doc/pdf_einstein.modules.php | 3 +- .../doc/pdf_expedition_merou.modules.php | 3 +- .../doc/pdf_expedition_rouget.modules.php | 3 +- .../modules/facture/doc/pdf_crabe.modules.php | 3 +- .../facture/doc/pdf_oursin.modules.php | 5 +- .../fichinter/doc/pdf_soleil.modules.php | 3 +- .../livraison/pdf/pdf_typhon.modules.php | 3 +- .../project/pdf/pdf_baleine.modules.php | 3 +- .../modules/propale/doc/pdf_azur.modules.php | 3 +- .../modules/propale/doc/pdf_jaune.modules.php | 3 +- .../pdf/pdf_canelle.modules.php | 3 +- .../pdf/pdf_muscadet.modules.php | 3 +- test/phpunit/AllTests.php | 2 + test/phpunit/ImagesLibTest.php | 146 ++++++++++++++++++ test/phpunit/PdfDocTest.php | 16 ++ test/phpunit/img250x50.jpg | Bin 0 -> 2467 bytes 18 files changed, 211 insertions(+), 15 deletions(-) create mode 100644 test/phpunit/ImagesLibTest.php create mode 100644 test/phpunit/img250x50.jpg diff --git a/htdocs/core/lib/pdf.lib.php b/htdocs/core/lib/pdf.lib.php index 941028ccb61..2914d5feaa9 100644 --- a/htdocs/core/lib/pdf.lib.php +++ b/htdocs/core/lib/pdf.lib.php @@ -168,6 +168,27 @@ function pdf_getPDFFontSize($outputlangs) } +/** + * Return height to use for Logo onot PDF + * + * @param string $logo Full path to logo file to use + * @return number + */ +function pdf_getHeightForLogo($logo) +{ + $height=22; $maxwidth=130; + include_once(DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php'); + $tmp=dol_getImageSize($logo); + if ($tmp['height']) + { + $width=round($height*$tmp['width']/$tmp['height']); + if ($width > $maxwidth) $height=$height*$maxwidth/$width; + } + //print $tmp['width'].' '.$tmp['height'].' '.$width; exit; + return $height; +} + + /** * Return a string with full address formated * diff --git a/htdocs/core/modules/commande/doc/pdf_edison.modules.php b/htdocs/core/modules/commande/doc/pdf_edison.modules.php index 894efc2d7be..4dd0ba21ab5 100644 --- a/htdocs/core/modules/commande/doc/pdf_edison.modules.php +++ b/htdocs/core/modules/commande/doc/pdf_edison.modules.php @@ -547,7 +547,8 @@ class pdf_edison extends ModelePDFCommandes { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/commande/doc/pdf_einstein.modules.php b/htdocs/core/modules/commande/doc/pdf_einstein.modules.php index 7db414e044a..809f2d7f4ac 100644 --- a/htdocs/core/modules/commande/doc/pdf_einstein.modules.php +++ b/htdocs/core/modules/commande/doc/pdf_einstein.modules.php @@ -889,7 +889,8 @@ class pdf_einstein extends ModelePDFCommandes { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/expedition/doc/pdf_expedition_merou.modules.php b/htdocs/core/modules/expedition/doc/pdf_expedition_merou.modules.php index e5c8a7099cb..d22c561d156 100644 --- a/htdocs/core/modules/expedition/doc/pdf_expedition_merou.modules.php +++ b/htdocs/core/modules/expedition/doc/pdf_expedition_merou.modules.php @@ -382,7 +382,8 @@ Class pdf_expedition_merou extends ModelePdfExpedition { if (is_readable($logo)) { - $pdf->Image($logo,10, 5, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo,10, 5, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/expedition/doc/pdf_expedition_rouget.modules.php b/htdocs/core/modules/expedition/doc/pdf_expedition_rouget.modules.php index b42c27930e5..554a6a6887d 100644 --- a/htdocs/core/modules/expedition/doc/pdf_expedition_rouget.modules.php +++ b/htdocs/core/modules/expedition/doc/pdf_expedition_rouget.modules.php @@ -343,7 +343,8 @@ Class pdf_expedition_rouget extends ModelePdfExpedition { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/facture/doc/pdf_crabe.modules.php b/htdocs/core/modules/facture/doc/pdf_crabe.modules.php index 4b22f27c319..29438a05af7 100755 --- a/htdocs/core/modules/facture/doc/pdf_crabe.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_crabe.modules.php @@ -1032,7 +1032,8 @@ class pdf_crabe extends ModelePDFFactures { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/facture/doc/pdf_oursin.modules.php b/htdocs/core/modules/facture/doc/pdf_oursin.modules.php index 3d17e5b4b49..7b6719be03a 100755 --- a/htdocs/core/modules/facture/doc/pdf_oursin.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_oursin.modules.php @@ -834,9 +834,8 @@ class pdf_oursin extends ModelePDFFactures { if (is_readable($logo)) { - $taille=getimagesize($logo); - $length=$taille[0]/2.835; - $pdf->Image($logo, $this->marges['g'], $this->marges['h'], 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marges['g'], $this->marges['h'], 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php b/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php index 272460695c0..5807a8b5efa 100644 --- a/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php +++ b/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php @@ -444,7 +444,8 @@ class pdf_soleil extends ModelePDFFicheinter { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php b/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php index e48f7420f77..a24c480e39b 100644 --- a/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php +++ b/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php @@ -510,7 +510,8 @@ class pdf_typhon extends ModelePDFDeliveryOrder { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/project/pdf/pdf_baleine.modules.php b/htdocs/core/modules/project/pdf/pdf_baleine.modules.php index 2b5d4477c0b..70e948178ba 100644 --- a/htdocs/core/modules/project/pdf/pdf_baleine.modules.php +++ b/htdocs/core/modules/project/pdf/pdf_baleine.modules.php @@ -351,7 +351,8 @@ class pdf_baleine extends ModelePDFProjects { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/propale/doc/pdf_azur.modules.php b/htdocs/core/modules/propale/doc/pdf_azur.modules.php index 5aa3c76baea..13a68888d54 100644 --- a/htdocs/core/modules/propale/doc/pdf_azur.modules.php +++ b/htdocs/core/modules/propale/doc/pdf_azur.modules.php @@ -923,7 +923,8 @@ class pdf_azur extends ModelePDFPropales { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/propale/doc/pdf_jaune.modules.php b/htdocs/core/modules/propale/doc/pdf_jaune.modules.php index 5755ab38f17..eaa01e02955 100644 --- a/htdocs/core/modules/propale/doc/pdf_jaune.modules.php +++ b/htdocs/core/modules/propale/doc/pdf_jaune.modules.php @@ -908,7 +908,8 @@ class pdf_jaune extends ModelePDFPropales { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/supplier_invoice/pdf/pdf_canelle.modules.php b/htdocs/core/modules/supplier_invoice/pdf/pdf_canelle.modules.php index 0fdf0884ea0..b1fd2d28a37 100755 --- a/htdocs/core/modules/supplier_invoice/pdf/pdf_canelle.modules.php +++ b/htdocs/core/modules/supplier_invoice/pdf/pdf_canelle.modules.php @@ -804,7 +804,8 @@ class pdf_canelle extends ModelePDFSuppliersInvoices { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/htdocs/core/modules/supplier_order/pdf/pdf_muscadet.modules.php b/htdocs/core/modules/supplier_order/pdf/pdf_muscadet.modules.php index 8eba413a4d7..5a760ead098 100644 --- a/htdocs/core/modules/supplier_order/pdf/pdf_muscadet.modules.php +++ b/htdocs/core/modules/supplier_order/pdf/pdf_muscadet.modules.php @@ -873,7 +873,8 @@ class pdf_muscadet extends ModelePDFSuppliersOrders { if (is_readable($logo)) { - $pdf->Image($logo, $this->marge_gauche, $posy, 0, 22); // width=0 (auto), max height=22 + $height=pdf_getHeightForLogo($logo); + $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto) } else { diff --git a/test/phpunit/AllTests.php b/test/phpunit/AllTests.php index 7bb39e25bdc..7d984e398c7 100644 --- a/test/phpunit/AllTests.php +++ b/test/phpunit/AllTests.php @@ -68,6 +68,8 @@ class AllTests $suite->addTestSuite('DateLibTest'); require_once dirname(__FILE__).'/FilesLibTest.php'; $suite->addTestSuite('FilesLibTest'); + require_once dirname(__FILE__).'/ImagesLibTest.php'; + $suite->addTestSuite('ImagesLibTest'); require_once dirname(__FILE__).'/FunctionsTest.php'; $suite->addTestSuite('FunctionsTest'); require_once dirname(__FILE__).'/PdfDocTest.php'; diff --git a/test/phpunit/ImagesLibTest.php b/test/phpunit/ImagesLibTest.php new file mode 100644 index 00000000000..d1e25797e0d --- /dev/null +++ b/test/phpunit/ImagesLibTest.php @@ -0,0 +1,146 @@ + + * Copyright (C) 2012 Regis Houssin + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * or see http://www.gnu.org/ + */ + +/** + * \file test/phpunit/ImagesLibTest.php + * \ingroup test + * \brief PHPUnit test + * \remarks To run this script as CLI: phpunit filename.php + */ + +global $conf,$user,$langs,$db; +//define('TEST_DB_FORCE_TYPE','mysql'); // This is to force using mysql driver +require_once 'PHPUnit/Autoload.php'; +require_once dirname(__FILE__).'/../../htdocs/master.inc.php'; +require_once dirname(__FILE__).'/../../htdocs/core/lib/images.lib.php'; + +if (empty($user->id)) +{ + print "Load permissions for admin user nb 1\n"; + $user->fetch(1); + $user->getrights(); +} +$conf->global->MAIN_DISABLE_ALL_MAILS=1; + + +/** + * Class for PHPUnit tests + * + * @backupGlobals disabled + * @backupStaticAttributes enabled + * @remarks backupGlobals must be disabled to have db,conf,user and lang not erased. + */ +class ImagesLibTest extends PHPUnit_Framework_TestCase +{ + protected $savconf; + protected $savuser; + protected $savlangs; + protected $savdb; + + /** + * Constructor + * We save global variables into local variables + * + * @return ImagesLibTest + */ + function ImagesLibTest() + { + //$this->sharedFixture + global $conf,$user,$langs,$db; + $this->savconf=$conf; + $this->savuser=$user; + $this->savlangs=$langs; + $this->savdb=$db; + + print __METHOD__." db->type=".$db->type." user->id=".$user->id; + //print " - db ".$db->db; + print "\n"; + } + + // Static methods + public static function setUpBeforeClass() + { + global $conf,$user,$langs,$db; + $db->begin(); // This is to have all actions inside a transaction even if test launched without suite. + + print __METHOD__."\n"; + } + public static function tearDownAfterClass() + { + global $conf,$user,$langs,$db; + $db->rollback(); + + print __METHOD__."\n"; + } + + /** + * Init phpunit tests + * + * @return void + */ + protected function setUp() + { + global $conf,$user,$langs,$db; + $conf=$this->savconf; + $user=$this->savuser; + $langs=$this->savlangs; + $db=$this->savdb; + + print __METHOD__."\n"; + } + /** + * End phpunit tests + * + * @return void + */ + protected function tearDown() + { + print __METHOD__."\n"; + } + + /** + * testDolCountNbOfLine + * + * @return int + */ + public function testgetImageSize() + { + $file=dirname(__FILE__).'/img250x50.jpg'; + $tmp=dol_getImageSize($file); + print __METHOD__." result=".$tmp['width'].'/'.$tmp['height']."\n"; + $this->assertEquals($tmp['width'],250); + $this->assertEquals($tmp['height'],50); + + $file=dirname(__FILE__).'/img250x20.png'; + $tmp=dol_getImageSize($file); + print __METHOD__." result=".$tmp['width'].'/'.$tmp['height']."\n"; + $this->assertEquals($tmp['width'],250); + $this->assertEquals($tmp['height'],20); + + /*$file=dirname(__FILE__).'/filenotfound.png'; + $tmp=dol_getImageSize($file); + print __METHOD__." result=".$tmp['width'].'/'.$tmp['height']."\n"; + $this->assertEquals($tmp['width'],250); + $this->assertEquals($tmp['height'],20);*/ + + return $result; + } + +} +?> \ No newline at end of file diff --git a/test/phpunit/PdfDocTest.php b/test/phpunit/PdfDocTest.php index 7d5b931c0b1..8f092b1a6ba 100755 --- a/test/phpunit/PdfDocTest.php +++ b/test/phpunit/PdfDocTest.php @@ -145,5 +145,21 @@ class PdfDocTest extends PHPUnit_Framework_TestCase $this->assertEquals($result,"PIDRESS - Label 1\nThis is a description with a é accent\n(Country of origin: France)"); } + /** + * testPdfGetHeightForLogo + * + * @return void + */ + public function testPdfGetHeightForLogo() + { + $file=dirname(__FILE__).'/img250x50.jpg'; + $result=pdf_getHeightForLogo($file); + print __METHOD__." result=".$result."\n"; + $this->assertEquals($result,22); + $file=dirname(__FILE__).'/img250x20.png'; + $result=pdf_getHeightForLogo($file); + print __METHOD__." result=".$result."\n"; + $this->assertEquals($result,10.4); + } } ?> \ No newline at end of file diff --git a/test/phpunit/img250x50.jpg b/test/phpunit/img250x50.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c69ab2634d8874623150692b4cf835dcf79b918e GIT binary patch literal 2467 zcmb7Ddpy(o8~<)Iaa?Cuv02zjWQ4UM={V$0Z7GLzN^LRs*>odi6}q^TEG8;6a>>rb zTz-^G_H#08IBs(tLP`sXZadTK^}GD@`{Va~KCkDG=lwkI=lQ%ppO0)nHV$ZdxVXCj zAP@*}lP^H_9e_KHgU~pX|0FDj1IgL|eEv9kq=J2ZN}$ZW~+wns}mFQOCxKQP47h!4YF<4@L6ojq9}kO$_{C zlOqN&c^C|lcm7XP7#yrcfEZah%7y?{IRu75V8CABTiRR!rK%`o&y_bh(odo<48aGb zp#@{&?|q?PAQ3K!v}yi`jVR3FTn;%QyW&(lYB^zCo>=|~nx2n9+G20afL6uJG~V@( z&1kxCAH9D!t8+H4FOG3@)t!@-UxpbtiFUeR@0X=w2Kha-kR4WqzU0yqj@V@>fo6K| z#QRGrA95-s%J((S3lC+!OfQq>6elxg%1PsGrusfs9>c?AO3+8aqqbOe9Cw$9yV4P zr5^}=cUPZI_cA!yGV-`+xG%W5vi;Qk6vKQ?3-WOk&)>XuVd9R!yJk@aybyW~rQJQ$ zZTzUC9cp_VGtpvsBkO}?5SN=9xVkP#aBI|1)nBBWR%+Y1GGI(VEZxK%e&eWnIvZuI z^1T13{S%hAASr&&{GMi;@%K3kDj36*pay^TXX9K=jIN8h1zo!2z2!B}!Qf;5<8`^B zf2;K;ZhK=>_-HmY%z2|@CzW?hXL(rVoJF#WAOVh(exF+(d0n+)J9*LcO^Nya2fcJ% zBC86{t!jR0IemRd+;KjIrIrTz>R>8Qp7|khkz-fLw`Q_4HLoDJKyuwq2J}T~anm0J zy-~!yh6FV(%K##aQpXb}HwM?5xLs}vt|Q%qeXLLIkI*rj%-r@B7oB6JMv7$CzTkyL z!sWNDcowM3x^%J5hrWJ1l4#bdO7tu=JN4yx>L0B=7Fe! zscX0R_T6}9kwZ-PLaSQk!(e5lNGguNvNM8r{+B2%aG$ zuT3HBy+|}qV@jzLJDS#oK(Q42dVawZRKwFKQxQ8nkM3?Q+7(FEd^J+RzGM;-`{Y(h z?NI;Me)Gs|pA)w#A=}%1P`OKxZ+ky+vkOT!zV4_UZm~|SQ@a8qqmxGER5-nD&h0L9 z$f0x18I1QylL;kJ;$Pr4Jvv^oM3?t@T&A7p1gA}OMdMj#rD}TgIU0#GuaT6%)mTi` zF-+P@Dq-z1(em}cWYq7>y@#dr1QnjvqezGwb5wgeUqqcJ|S9(DZ`X(Z#SQ3HfD2jk7*q08>vt8^Ehi*TvC#+7m(ES zaH3m_uNfcllJ-F4MX*MAtCi_cTqn?Q@y_^5-kng3P)8mCG87Bi?E_ zZI_3=%bA>B&)lupxF?fA)C)CYGR{{j+BCA?eYe+Q4hdBG*HEZsjaaVYL7URSyi0pn zZbwejI&1B|qx{PEpS4!jn+VQ0U+kDN*t+Vr9QYM~TOFMvqLd!VG0o}^6O4$Tj2_u` zzzL=5Vi#hP$|f#akH*@|fSQg>#ETqr$<`$s2y1b$X_NS<vl(pvT#!n{s4G}dREpx{wL=JWVl%ak%^5*K-Q)_E#cprYi z{AHVhmf(|B(xU@c%l#fg*P6^-d2`G&U~vt1y#3=&D*&Jn^c@ zE+CXy-Fpo_N~DE__sSE$z;;!;O6= zd0qdgIXv-{^XecyG}N{r9cE`WHC8k8ZZ_{>U&B2W*WYy4ZWz}$FmO#}Gg6jWq`tSP zWG>X`6eXb|uG)SfcDiP$_@{N&5xv_iHvXjLywyVQQeFQ$?&;)!&w%cDTen>+RZ^W8 zRJ%g~>5%vIj&C)r9mBucyfD0yRrlMs$msrQ^FND1!odP*q-E=zVa4@=CZ_EXKdWYp zfCAb6o>tIfk&voPrCz;~e|BFVVlTfe*}~etBN5FGjCX=uMW_gDe?3eeD7WkCG#upV zhD4%JOM!0#ns~FtbI=RN;3b8U;3V#rq-BaxX{zwv0zE91#}o6t{almlqaGYEl_==8 zKX>7)cdTKbZTlRj0*l2vvQz5Gj1H3X_H?ePGmJz`G3p?1Wtd+lDEMm^D9K}*%zwr1 v%K?W!!&4Xz>nSyxDfL_<@D*nT{Q|QrliLdWItefx1?OL!o&Tpp%Le}jxTRwY literal 0 HcmV?d00001