1: <?php
  2: /*
  3:  You may not change or alter any portion of this comment or credits
  4:  of supporting developers from this source code or any supporting source code
  5:  which is considered copyrighted (c) material of the original comment or credit authors.
  6: 
  7:  This program is distributed in the hope that it will be useful,
  8:  but WITHOUT ANY WARRANTY; without even the implied warranty of
  9:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 10: */
 11: 
 12: use Xoops\Core\Service\AbstractContract;
 13: use Xoops\Core\Service\Contract\HtmlToPdfInterface;
 14: 
 15: /**
 16:  * HtmlToPdf provider for service manager
 17:  *
 18:  * @category  ServiceProvider
 19:  * @package   HtmlToPdfProvider
 20:  * @author    Richard Griffith <richard@geekwright.com>
 21:  * @copyright 2013-2014 XOOPS Project (http://xoops.org)
 22:  * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 23:  * @link      http://xoops.org
 24:  * @since     2.6.0
 25:  */
 26: class HtmlToPdfProvider extends AbstractContract implements HtmlToPdfInterface
 27: {
 28:     /** @var string $moddir */
 29:     private $moddir = 'pdf';
 30: 
 31:     /** @var TCPDF $pdfEngine */
 32:     protected $pdfEngine;
 33: 
 34:     /** @var string $pageOrientation */
 35:     protected $pageOrientation = 'P';
 36: 
 37:     /** @var string $pageSize */
 38:     protected $pageSize = 'A4';
 39: 
 40:     /** @var string $unit */
 41:     protected $unit = 'mm';
 42: 
 43:     /** @var float $leftMargin */
 44:     protected $leftMargin;
 45: 
 46:     /** @var float $topMargin */
 47:     protected $topMargin;
 48: 
 49:     /** @var float $rightMargin */
 50:     protected $rightMargin;
 51: 
 52:     /** @var float $bottomMargin */
 53:     protected $bottomMargin;
 54: 
 55:     /** @var string $fontFamily */
 56:     protected $fontFamily;
 57: 
 58:     /** @var string $fontStyle  */
 59:     protected $fontStyle;
 60: 
 61:     /** @var float $fontSize   */
 62:     protected $fontSize;
 63: 
 64:     /** @var string $monoFontFamily */
 65:     protected $monoFontFamily;
 66: 
 67:     /** @var string $pdfAuthor */
 68:     protected $pdfAuthor;
 69: 
 70:     /** @var string $pdfTitle */
 71:     protected $pdfTitle;
 72: 
 73:     /** @var string $pdfSubject */
 74:     protected $pdfSubject;
 75: 
 76:     /** @var string[] $pdfKeywords */
 77:     protected $pdfKeywords;
 78: 
 79:     /** @var string $pdfCreator */
 80:     protected $pdfCreator;
 81: 
 82:     /** @var string[] $moduleConfigs */
 83:     protected $moduleConfigs;
 84: 
 85:     /**
 86:      * __construct
 87:      */
 88:     public function __construct()
 89:     {
 90:         $this->resetPdf();
 91:     }
 92: 
 93:     /**
 94:      * setFromConfigs - set property from config value or default
 95:      *
 96:      * @param string $name     config name
 97:      * @param string $property property name
 98:      * @param mixed  $default  default value
 99:      *
100:      * @return void
101:      */
102:     private function setFromConfigs($name, $property, $default)
103:     {
104:         $this->$property = $default;
105:         if (isset($this->moduleConfigs[$name])) {
106:             $value = $this->moduleConfigs[$name];
107:             $this->$property = empty($value) ? $default : $value;
108:         }
109:     }
110:     /**
111:      * resetPdf - resets to default state
112:      *
113:      * @return void
114:      */
115:     protected function resetPdf()
116:     {
117:         unset($this->pdfEngine);
118: 
119:         unset($this->pdfAuthor);
120:         unset($this->pdfTitle);
121:         unset($this->pdfSubject);
122:         unset($this->pdfKeywords);
123: 
124:         $this->moduleConfigs = \Xoops::getInstance()->getModuleConfigs($this->moddir);
125: 
126:         $this->setFromConfigs('page_orientation', 'pageOrientation', 'P');
127:         $this->setFromConfigs('page_size', 'pageSize', 'A4');
128:         $this->setFromConfigs('pdf_creator', 'pdfCreator', 'XOOPS');
129: 
130:         $this->setFromConfigs('font_family', 'fontFamily', null);
131:         $this->setFromConfigs('font_style', 'fontStyle', '');
132:         $this->setFromConfigs('font_style', 'fontStyle', '');
133:         $this->setFromConfigs('font_size', 'fontSize', 10);
134:         $this->setFromConfigs('monofont_family', 'monoFontFamily', null);
135:         $this->setFromConfigs('size_unit', 'unit', 'mm');
136:         $this->setFromConfigs('margin_left', 'leftMargin', null);
137:         $this->setFromConfigs('margin_top', 'topMargin', null);
138:         $this->setFromConfigs('margin_right', 'rightMargin', null);
139:         $this->setFromConfigs('margin_bottom', 'bottomMargin', null);
140:     }
141: 
142:     /**
143:      * startPdf - start a new pdf
144:      *
145:      * @param Response $response \Xoops\Core\Service\Response object
146:      *
147:      * @return void
148:      */
149:     public function startPdf($response)
150:     {
151:         $this->resetPdf();
152:     }
153: 
154:     /**
155:      * getName - get a short name for this service provider. This should be unique within the
156:      * scope of the named service, so using module dirname is suggested.
157:      *
158:      * @return string - a unique name for the service provider
159:      */
160:     public function getName()
161:     {
162:         return 'pdf';
163:     }
164: 
165:     /**
166:      * getDescription - get human readable description of the service provider
167:      *
168:      * @return string
169:      */
170:     public function getDescription()
171:     {
172:         return 'Simple HTML to PDF using TCPDF.';
173:     }
174: 
175:     /**
176:      * setPageOrientation - set page orientation
177:      *
178:      * @param Response $response        \Xoops\Core\Service\Response object
179:      * @param string   $pageOrientation page orientation, 'P' for portrait, 'L' for landscape
180:      *
181:      * @return void
182:      */
183:     public function setPageOrientation($response, $pageOrientation)
184:     {
185:         $this->pageOrientation = $pageOrientation;
186:         if (isset($this->pdfEngine)) {
187:             $this->pdfEngine->setPageOrientation($this->pageOrientation, true, $this->bottomMargin);
188:         }
189:     }
190: 
191:     /**
192:      * setPageSize - set standard page size
193:      *
194:      * @param Response $response \Xoops\Core\Service\Response object
195:      * @param string   $pageSize standard named page size, i.e. 'LETTER', 'A4', etc.
196:      *
197:      * @return void
198:      */
199:     public function setPageSize($response, $pageSize)
200:     {
201:         $this->pageSize = $pageSize;
202:         if (isset($this->pdfEngine)) {
203:             $this->pdfEngine->setPageFormat($this->pageSize, $this->pageOrientation);
204:         }
205:     }
206: 
207:     /**
208:      * setBaseUnit - set unit of measure for page size, margins, etc.
209:      *
210:      * @param Response $response \Xoops\Core\Service\Response object
211:      * @param string   $unit     unit used in page size, margins. Possible values include
212:      *                           'mm' = millimeter, "in" = inches, 'pt' = typographic points
213:      *
214:      * @return void
215:      */
216:     public function setBaseUnit($response, $unit)
217:     {
218:         $this->unit = $unit;
219:         if (isset($this->pdfEngine)) {
220:             $this->pdfEngine->setPageUnit($unit);
221:         }
222:     }
223: 
224:     /**
225:      * setMargins - set margin sizes
226:      *
227:      * @param Response $response     \Xoops\Core\Service\Response object
228:      * @param float    $leftMargin   left margin in base units, @see setBaseUnits()
229:      * @param float    $topMargin    top margin in base units
230:      * @param float    $rightMargin  right margin in base units
231:      * @param float    $bottomMargin bottom margin in base units
232:      *
233:      * @return void - response->value set to absolute URL to avatar image
234:      */
235:     public function setMargins($response, $leftMargin, $topMargin, $rightMargin, $bottomMargin)
236:     {
237:         $this->$leftMargin = $leftMargin;
238:         $this->$topMargin = $topMargin;
239:         $this->$rightMargin = $rightMargin;
240:         $this->$bottomMargin = $bottomMargin;
241:         if (isset($this->pdfEngine)) {
242:             $this->pdfEngine->SetMargins($this->leftMargin, $this->topMargin, $this->rightMargin);
243:             if (empty($this->bottomMargin)) {
244:                 $this->bottomMargin = PDF_MARGIN_BOTTOM;
245:             }
246:             $this->pdfEngine->SetAutoPageBreak(true, $this->bottomMargin);
247:         }
248:     }
249: 
250:     /**
251:      * setBaseFont - set the base font used in rendering
252:      *
253:      * @param Response $response   \Xoops\Core\Service\Response object
254:      * @param string   $fontFamily font family
255:      * @param string   $fontStyle  font style ('bold', 'italic', etc.)
256:      * @param float    $fontSize   font size in points
257:      *
258:      * @return void
259:      */
260:     public function setBaseFont($response, $fontFamily, $fontStyle = '', $fontSize = null)
261:     {
262:         $this->fontFamily = $fontFamily;
263:         $this->fontStyle  = $fontStyle;
264:         $this->fontSize   = $fontSize;
265:         if (isset($this->pdfEngine)) {
266:             $this->pdfEngine->SetFont($this->fontFamily, $this->fontStyle, $this->fontSize);
267:         }
268:     }
269: 
270:     /**
271:      * setDefaultMonospacedFont - default monotype font used in rendering
272:      *
273:      * @param Response $response       \Xoops\Core\Service\Response object
274:      * @param string   $monoFontFamily font family
275:      *
276:      * @return void
277:      */
278:     public function setDefaultMonospacedFont($response, $monoFontFamily)
279:     {
280:         $this->monoFontFamily = $monoFontFamily;
281:         if (isset($this->pdfEngine)) {
282:             $this->pdfEngine->SetDefaultMonospacedFont($this->monoFontFamily);
283:         }
284:     }
285: 
286:     /**
287:      * setAuthor - set author in pdf meta data
288:      *
289:      * @param Response $response  \Xoops\Core\Service\Response object
290:      * @param string   $pdfAuthor author name
291:      *
292:      * @return void
293:      */
294:     public function setAuthor($response, $pdfAuthor)
295:     {
296:         $this->pdfAuthor = $this->decodeEntities($pdfAuthor);
297:         if (isset($this->pdfEngine)) {
298:             $this->pdfEngine->SetAuthor($this->pdfAuthor);
299:         }
300:     }
301: 
302:     /**
303:      * setTitle - set title in pdf meta data
304:      *
305:      * @param Response $response \Xoops\Core\Service\Response object
306:      * @param string   $pdfTitle document title
307:      *
308:      * @return void
309:      */
310:     public function setTitle($response, $pdfTitle)
311:     {
312:         $this->pdfTitle = $this->decodeEntities($pdfTitle);
313:         if (isset($this->pdfEngine)) {
314:             $this->pdfEngine->SetTitle($this->pdfTitle);
315:         }
316:     }
317: 
318:     /**
319:      * setSubject - set subject in pdf meta data
320:      *
321:      * @param Response $response   \Xoops\Core\Service\Response object
322:      * @param string   $pdfSubject document subject
323:      *
324:      * @return void
325:      */
326:     public function setSubject($response, $pdfSubject)
327:     {
328:         $this->pdfSubject = $this->decodeEntities($pdfSubject);
329:         if (isset($this->pdfEngine)) {
330:             $this->pdfEngine->SetSubject($this->pdfSubject);
331:         }
332:     }
333: 
334:     /**
335:      * setKeywords - set keywords in pdf meta data
336:      *
337:      * @param Response $response    \Xoops\Core\Service\Response object
338:      * @param string[] $pdfKeywords array of keywords pertaining to document
339:      *
340:      * @return void
341:      */
342:     public function setKeywords($response, $pdfKeywords)
343:     {
344:         $this->pdfKeywords = $pdfKeywords;
345:         if (isset($this->pdfEngine)) {
346:             $keywords =
347:                 is_array($this->pdfKeywords) ? implode(', ', $this->pdfKeywords) : (string) $this->pdfKeywords;
348:             $this->pdfEngine->SetKeywords($keywords);
349:         }
350:     }
351: 
352:     /**
353:      * addHtml - add HTML formatted text to document. This may be called multiple times
354:      *
355:      * @param Response $response \Xoops\Core\Service\Response object
356:      * @param string   $html     HTML formated text to include in document
357:      *                           array     user info, 'uid', 'uname' and 'email' required
358:      *
359:      * @return void
360:      */
361:     public function addHtml($response, $html)
362:     {
363:         $this->initPdf();
364:         $this->pdfEngine->AddPage();
365:         $this->pdfEngine->writeHTML($html, true, false, true, false, '');
366:     }
367: 
368:     /**
369:      * outputPdfInline - output a named pdf document file inline
370:      *
371:      * @param Response $response \Xoops\Core\Service\Response object
372:      * @param string   $name     filename for file
373:      *
374:      * @return void
375:      */
376:     public function outputPdfInline($response, $name)
377:     {
378:         $this->initPdf();
379:         if (empty($name)) {
380:             $name = 'requested.pdf';
381:         }
382:         $this->pdfEngine->lastPage();
383:         $this->pdfEngine->Output($name, 'I');
384:     }
385: 
386:     /**
387:      * outputPdfDownload - output a named pdf document file for download
388:      *
389:      * @param Response $response \Xoops\Core\Service\Response object
390:      * @param string   $name     filename for file
391:      *
392:      * @return void
393:      */
394:     public function outputPdfDownload($response, $name)
395:     {
396:         $this->initPdf();
397:         if (empty($name)) {
398:             $name = 'requested.pdf';
399:         }
400:         $this->pdfEngine->lastPage();
401:         $this->pdfEngine->Output($name, 'D');
402:     }
403: 
404:     /**
405:      * fetchPdf - fetch rendered document as a string
406:      *
407:      * @param Response $response \Xoops\Core\Service\Response object
408:      *
409:      * @return void - response->value set to string containing document
410:      */
411:     public function fetchPdf($response)
412:     {
413:         $this->initPdf();
414:         $this->pdfEngine->lastPage();
415:         $response->seValue($this->pdfEngine->Output('', 'S'));
416:     }
417: 
418:     /**
419:      * initPdf - initialize TCPDF with current setting
420:      *
421:      * @return void
422:      */
423:     private function initPdf()
424:     {
425:         if (empty($this->pdfEngine)) {
426:             $this->pdfEngine = new TCPDF($this->pageOrientation, $this->unit, $this->pageSize, true, 'UTF-8', false);
427:             if (isset($this->pdfAuthor)) {
428:                 $this->pdfEngine->SetAuthor($this->pdfAuthor);
429:             }
430:             if (isset($this->pdfTitle)) {
431:                 $this->pdfEngine->SetTitle($this->pdfTitle);
432:             }
433:             if (isset($this->pdfSubject)) {
434:                 $this->pdfEngine->SetSubject($this->pdfSubject);
435:             }
436:             if (isset($this->pdfKeywords)) {
437:                 $keywords =
438:                     is_array($this->pdfKeywords) ? implode(', ', $this->pdfKeywords) : (string) $this->pdfKeywords;
439:                 $this->pdfEngine->SetKeywords($keywords);
440:             }
441:             if (!empty($this->pdfCreator)) {
442:                 $this->pdfEngine->SetCreator($this->pdfCreator);
443:             }
444:             if (!empty($this->fontFamily)) {
445:                 $this->pdfEngine->SetFont($this->fontFamily, $this->fontStyle, $this->fontSize);
446:             }
447:             if (!empty($this->monoFontFamily)) {
448:                 $this->pdfEngine->SetDefaultMonospacedFont($this->monoFontFamily);
449:             }
450:             if (!empty($this->leftMargin)) {
451:                 $this->pdfEngine->SetMargins($this->leftMargin, $this->topMargin, $this->rightMargin);
452:             }
453:             if (empty($this->bottomMargin)) {
454:                 $this->bottomMargin = PDF_MARGIN_BOTTOM;
455:             }
456:             $this->pdfEngine->SetAutoPageBreak(true, $this->bottomMargin);
457:         }
458:     }
459: 
460:     /**
461:      * decodeEntities - handles numeric entities
462:      *
463:      * @param string $text text to decode
464:      *
465:      * @return string decoded string
466:      */
467:     private function decodeEntities($text)
468:     {
469:         $text= html_entity_decode($text, ENT_QUOTES, "UTF-8");
470:         $text= preg_replace_callback(
471:             '/&#(\d+);/m',
472:             function ($m) {
473:                 return utf8_encode(chr($m[1]));
474:             },
475:             $text
476:         ); // decimal notation
477:         $text= preg_replace_callback(
478:             '/&#x([a-f0-9]+);/mi',
479:             function ($m) {
480:                 return utf8_encode(chr('0x'.$m[1]));
481:             },
482:             $text
483:         );  //hex notation
484:         return $text;
485:     }
486: }
487: