galette/lib/Galette/IO/Pdf.php

   1 <?php
   2
   3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   4
   5 /**
   6  * PDF class for galette
   7  * Traps tcpdf errors by overloading tcpdf::error method
   8  * Adds convenient method to convert color html codes
   9  * Adds a _parsegif function to convert gif to png
  10  *
  11  * PHP version 5
  12  *
  13  * Copyright © 2007-2014 The Galette Team
  14  *
  15  * This file is part of Galette (http://galette.tuxfamily.org).
  16  *
  17  * Galette is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * Galette is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
  29  *
  30  * @category  IO
  31  * @package   Galette
  32  *
  33  * @author    John Perr <johnperr@abul.org>
  34  * @author    Johan Cwiklinski <johan@x-tnd.be>
  35  * @copyright 2007-2014 The Galette Team
  36  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  37  * @version   SVN: $Id$
  38  * @link      http://galette.tuxfamily.org
  39  * @since     Available since 0.7dev - 2007-07-21
  40  */
  41
  42 namespace Galette\IO;
  43
  44 use Galette\Core\Preferences;
  45 use Galette\Entity\PdfModel;
  46 use Analog\Analog;
  47
  48 /*
  49  * TCPDF configuration file for Galette
  50  */
  51 require_once GALETTE_CONFIG_PATH . 'galette_tcpdf_config.php';
  52
  53 /**
  54  * PDF class for galette
  55  *
  56  * @category  IO
  57  * @name      PDF
  58  * @package   Galette
  59  * @abstract  Class for expanding TCPDF.
  60  * @author    John Perr <johnperr@abul.org>
  61  * @author    Johan Cwiklinski <johan@x-tnd.be>
  62  * @copyright 2007-2014 The Galette Team
  63  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  64  * @link      http://galette.tuxfamily.org
  65  * @since     Available since 0.7dev - 2007-07-21
  66  */
  67
  68 class Pdf extends \TCPDF
  69 {
  70
  71     const FONT = 'DejaVuSans';
  72     const FONT_SIZE = 10;
  73
  74     protected $preferences;
  75     protected $i18n;
  76     private $model;
  77     private $paginated = false;
  78     protected $filename;
  79
  80     /**
  81      * Main constructor, set creator and author
  82      *
  83      * @param Preferences $prefs Preferences
  84      * @param PdfModel    $model Related model
  85      */
  86     public function __construct(Preferences $prefs, $model = null)
  87     {
  88         global $i18n;
  89
  90         $this->preferences = $prefs;
  91         $this->i18n = $i18n;
  92         parent::__construct('P', 'mm', 'A4', true, 'UTF-8');
  93         //set some values
  94         $this->SetCreator(PDF_CREATOR);
  95         //add helvetica, hard-called from lib
  96         $this->SetFont('helvetica');
  97         //and then, set real font
  98         $this->SetFont(self::FONT, '', self::FONT_SIZE);
  99         $name = preg_replace(
 100             '/%s/',
 101             $this->preferences->pref_nom,
 102             _T("Association %s")
 103         );
 104         $this->SetAuthor(
 105             $name . ' (using Galette ' . GALETTE_VERSION . ')'
 106         );
 107
 108         if ($this->i18n->isRTL()) {
 109             $this->setRTL(true);
 110         }
 111
 112         if ($model !== null) {
 113             if ($model instanceof PdfModel) {
 114                 $this->model = $model;
 115                 $this->SetTitle($this->model->htitle);
 116             } else {
 117                 throw new \UnexpectedValueException(
 118                     'Provided model must be an instance of PdfModel!'
 119                 );
 120             }
 121         }
 122     }
 123
 124     /**
 125      * Set show pagination
 126      *
 127      * @return void
 128      */
 129     public function showPagination()
 130     {
 131         $this->paginated = true;
 132     }
 133
 134     /**
 135      * Destructor
 136      */
 137     public function __destruct()
 138     {
 139         parent::__destruct();
 140     }
 141
 142     /**
 143      * This method is automatically called in case of fatal error;
 144      * it simply outputs the message and halts the execution.
 145      * An inherited class may override it to customize the error
 146      * handling but should always halt the script, or the resulting
 147      * document would probably be invalid.
 148      * 2004-06-11 :: Nicola Asuni : changed bold tag with strong
 149      * 2007-07-21 :: John Perr : changed function to return error to session
 150      * 2017-02-14 :: Johan Cwiklinski : use slim's flash message; do not rely on session for redirect
 151      *
 152      * @param string $msg The error message
 153      *
 154      * @return void
 155      * @access public
 156      * @since 1.0
 157      */
 158     public function Error($msg) // phpcs:ignore PSR1.Methods.CamelCapsMethodName
 159     {
 160         global $container;
 161
 162         Analog::log(
 163             'PDF error: ' .$msg,
 164             Analog::ERROR
 165         );
 166
 167         $container->get('flash')->addMessage(
 168             'error_detected',
 169             $msg
 170         );
 171
 172         $redirect = (isset($_SERVER['HTTP_REFERER']) ?
 173             $_SERVER['HTTP_REFERER'] :
 174             $container->get('router')->pathFor('slash'));
 175         header('Location: ' . $redirect);
 176         die();
 177     }
 178
 179     /**
 180      * Converts color from HTML format #RRVVBB
 181      * to RGB 3 colors array.
 182      *
 183      *  @param string $hex6 7 chars string #RRVVBB
 184      *
 185      * @return array
 186      */
 187     public function colorHex2Dec($hex6)
 188     {
 189         $dec = array(
 190             "R" => hexdec(substr($hex6, 1, 2)),
 191             "G" => hexdec(substr($hex6, 3, 2)),
 192             "B" => hexdec(substr($hex6, 5, 2))
 193         );
 194         return $dec;
 195     }
 196
 197     /** FIXME: is this function used somewhere? */
 198     /**
 199      * Extract info from a GIF file
 200      * (In fact: converts gif image to png and feeds it to _parsepng)
 201      *
 202      * @param string $file path to the gif file
 203      *
 204      * @return void
 205      * @access protected
 206      */
 207     protected function parsegif($file)
 208     {
 209         $a=GetImageSize($file);
 210         if (empty($a)) {
 211             $this->Error(_T("Missing or incorrect image file ") . $file);
 212         }
 213         if ($a[2]!=1) {
 214             $this->Error(_T("Not a GIF file ") . $file);
 215         }
 216
 217         // Tentative d'ouverture du fichier
 218         if (function_exists('gd_info')) {
 219             $data = @imagecreatefromgif($file);
 220
 221             // Test d'échec & Affichage d'un message d'erreur
 222             if (!$data) {
 223                     $this->Error(_T("Error loading ").$file);
 224             }
 225             if (imagepng($data, GALETTE_ROOT . 'tempimages/gif2png.png')) {
 226                 return $this->_parsepng(GALETTE_ROOT . 'tempimages/gif2png.png');
 227             } else {
 228                 $this->Error(_T("Error creating temporary png file from ").$file);
 229             }
 230         } else {
 231             $this->Error(_T("Unable to convert GIF file ").$file);
 232         }
 233     }
 234
 235     /**
 236      * Draws PDF page Header
 237      *
 238      * @return void
 239      */
 240     public function Header() // phpcs:ignore PSR1.Methods.CamelCapsMethodName
 241     {
 242         //just ovverride default header to prevent black line at top
 243     }
 244
 245     /**
 246      * Draws PDF page footer
 247      *
 248      * @return void
 249      */
 250     public function Footer() // phpcs:ignore PSR1.Methods.CamelCapsMethodName
 251     {
 252         $this->SetY(-20);
 253         if (isset($this->model)) {
 254             $hfooter = '';
 255             if (trim($this->model->hstyles) !== '') {
 256                 $hfooter .= "<style>\n" . $this->model->hstyles . "\n</style>\n\n";
 257             }
 258             $hfooter .= $this->model->hfooter;
 259             $this->writeHtml($hfooter);
 260         } else {
 261             $this->SetFont(self::FONT, '', self::FONT_SIZE - 2);
 262             $this->SetTextColor(0, 0, 0);
 263
 264             $name = preg_replace(
 265                 '/%s/',
 266                 $this->preferences->pref_nom,
 267                 _T("Association %s")
 268             );
 269
 270             $address = $this->preferences->getPostalAddress();
 271
 272             $this->MultiCell(
 273                 0,
 274                 4,
 275                 $address,
 276                 0,
 277                 'C'
 278             );
 279
 280             if ($this->paginated) {
 281                 $this->SetFont(self::FONT, '', self::FONT_SIZE - 3);
 282                 $this->Ln();
 283                 $this->Cell(
 284                     0,
 285                     4,
 286                     $this->getAliasRightShift() . $this->PageNo() .
 287                     '/' . $this->getAliasNbPages(),
 288                     0,
 289                     1,
 290                     ($this->i18n->isRTL() ? 'L' : 'R')
 291                 );
 292             }
 293         }
 294     }
 295
 296     /**
 297      * Draws PDF page header
 298      *
 299      * @param string $title Additionnal title to display just after logo
 300      *
 301      * @return void
 302      */
 303     public function PageHeader($title = null) // phpcs:ignore PSR1.Methods.CamelCapsMethodName
 304     {
 305         if (isset($this->model)) {
 306             $html = null;
 307             if (trim($this->model->hstyles) !== '') {
 308                 $html .= "<style>\n" . $this->model->hstyles . "\n</style>\n\n";
 309             }
 310             $html .= "<div dir=\"".($this->i18n->isRTL() ? 'rtl' : 'ltr')."\">" . $this->model->hheader . "</div>";
 311             $this->writeHtml($html, true, false, true, false, '');
 312
 313             if ($title !== null) {
 314                 $this->writeHtml('<h2 style="text-align:center;">' . $title . '</h2>');
 315             }
 316
 317             if (trim($this->model->title) !== '') {
 318                 $htitle = '';
 319                 if (trim($this->model->hstyles) !== '') {
 320                     $htitle .= "<style>\n" . $this->model->hstyles .
 321                         "\n</style>\n\n";
 322                 }
 323                 $htitle .= '<div id="pdf_title">' . $this->model->htitle . '</div>';
 324                 $this->writeHtml($htitle);
 325             }
 326             if (trim($this->model->subtitle) !== '') {
 327                 $hsubtitle = '';
 328                 if (trim($this->model->hstyles) !== '') {
 329                     $hsubtitle .= "<style>\n" . $this->model->hstyles .
 330                         "\n</style>\n\n";
 331                 }
 332                 $hsubtitle .= '<div id="pdf_subtitle">' . $this->model->hsubtitle .
 333                     '</div>';
 334                 $this->writeHtml($hsubtitle);
 335             }
 336             if (trim($this->model->title) !== ''
 337                 || trim($this->model->subtitle) !== ''
 338             ) {
 339                 $this->Ln(5);
 340             }
 341         } else {
 342             //default header
 343             $print_logo = new \Galette\Core\PrintLogo();
 344             $logofile = $print_logo->getPath();
 345
 346             // Set logo size to max width 30 mm or max height 25 mm
 347             $ratio = $print_logo->getWidth()/$print_logo->getHeight();
 348             if ($ratio < 1) {
 349                 if ($print_logo->getHeight() > 16) {
 350                     $hlogo = 25;
 351                 } else {
 352                     $hlogo = $print_logo->getHeight();
 353                 }
 354                 $wlogo = round($hlogo*$ratio);
 355             } else {
 356                 if ($print_logo->getWidth() > 16) {
 357                     $wlogo = 30;
 358                 } else {
 359                     $wlogo = $print_logo->getWidth();
 360                 }
 361                 $hlogo = round($wlogo/$ratio);
 362             }
 363
 364             $this->SetFont(self::FONT, 'B', self::FONT_SIZE + 4);
 365             $this->SetTextColor(0, 0, 0);
 366
 367             $y = $this->GetY();
 368             $this->Ln(2);
 369             $ystart = $this->GetY();
 370
 371             $this->MultiCell(
 372                 180 - $wlogo,
 373                 6,
 374                 $this->preferences->pref_nom,
 375                 0,
 376                 ($this->i18n->isRTL() ? 'R' : 'L')
 377             );
 378             $this->SetFont(self::FONT, 'B', self::FONT_SIZE + 2);
 379
 380             if ($title !== null) {
 381                 $this->Cell(0, 6, $title, 0, 1, ($this->i18n->isRTL() ? 'R' : 'L'), 0);
 382             }
 383             $yend = $this->getY();//store position at the end of the text
 384
 385             $this->SetY($ystart);
 386             if ($this->i18n->isRTL()) {
 387                 $x = $this->getX();
 388             } else {
 389                 $x = 190 - $wlogo; //right align
 390             }
 391             $this->Image($logofile, $x, $this->GetY(), $wlogo, $hlogo);
 392             $this->y += $hlogo + 3;
 393             //if position after logo is < than position after text,
 394             //we have to change y
 395             if ($this->getY() < $yend) {
 396                 $this->setY($yend);
 397             }
 398         }
 399     }
 400
 401     /**
 402      * Draws body from model
 403      *
 404      * @return void
 405      */
 406     public function PageBody() // phpcs:ignore PSR1.Methods.CamelCapsMethodName
 407     {
 408         $hbody = '';
 409         if (trim($this->model->hstyles) !== '') {
 410             $hbody .= "<style>\n" . $this->model->hstyles . "\n</style>\n\n";
 411         }
 412         $hbody .= $this->model->hbody;
 413         $this->writeHtml($hbody);
 414     }
 415
 416     /**
 417      * Fix text size
 418      *
 419      * @param string  $text      Text content
 420      * @param integer $maxsize   Maximal size
 421      * @param integer $fontsize  Font size
 422      * @param string  $fontstyle Font style (defaults to '')
 423      * @param string  $fontname  Font name (defaults to static::FONT)
 424      *
 425      * @return void
 426      */
 427     protected function fixSize($text, $maxsize, $fontsize, $fontstyle = '', $fontname = null)
 428     {
 429         if ($fontname === null) {
 430             $fontname = static::FONT;
 431         }
 432         $this->SetFontSize($fontsize);
 433         while ($this->GetStringWidth($text, $fontname, $fontstyle, $fontsize) > $maxsize) {
 434             $fontsize--;
 435             $this->SetFontSize($fontsize);
 436         }
 437     }
 438
 439     /**
 440      * Cut a string
 441      *
 442      * @param string  $str    Original string
 443      * @param integer $length Max length
 444      *
 445      * @return string
 446      */
 447     protected function cut($str, $length)
 448     {
 449         $length = $length -2; //keep a margin
 450         if ($this->GetStringWidth($str) > $length) {
 451             while ($this->GetStringWidth($str . '...') > $length) {
 452                 $str = mb_substr($str, 0, -1, 'UTF-8');
 453             }
 454             $str .= '...';
 455         }
 456         return $str;
 457     }
 458
 459     /**
 460      * Stretch a header string
 461      *
 462      * @param string  $str    Original string
 463      * @param integer $length Max length
 464      *
 465      * @return string
 466      */
 467     protected function stretchHead($str, $length)
 468     {
 469         $this->SetFont(self::FONT, 'B', self::FONT_SIZE);
 470         $stretch = 100;
 471         if ($this->GetStringWidth($str) > $length) {
 472             while ($this->GetStringWidth($str) > $length) {
 473                 $this->setFontStretching(--$stretch);
 474             }
 475         }
 476         return $str;
 477     }
 478
 479     /**
 480      * Get filename
 481      *
 482      * @return string
 483      */
 484     public function getFilename()
 485     {
 486         return $this->filename;
 487     }
 488
 489     /**
 490      * Download PDF from browser
 491      *
 492      * @return void
 493      */
 494     public function download()
 495     {
 496         $this->Output($this->filename, 'D');
 497     }
 498 }