INFRA-132 comments to end with full stops
[civicrm-core.git] / CRM / Utils / PDF / Utils.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13 | |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
18 | |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
32 * $Id$
33 *
34 */
35class CRM_Utils_PDF_Utils {
36
5bc392e6
EM
37 /**
38 * @param $text
39 * @param string $fileName
40 * @param bool $output
41 * @param null $pdfFormat
42 *
43 * @return string|void
44 */
00be9182 45 public static function html2pdf(&$text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
6a488035
TO
46 if (is_array($text)) {
47 $pages = &$text;
48 }
49 else {
50 $pages = array($text);
51 }
52 // Get PDF Page Format
53 $format = CRM_Core_BAO_PdfFormat::getDefaultValues();
54 if (is_array($pdfFormat)) {
55 // PDF Page Format parameters passed in
56 $format = array_merge($format, $pdfFormat);
57 }
58 else {
59 // PDF Page Format ID passed in
60 $format = CRM_Core_BAO_PdfFormat::getById($pdfFormat);
61 }
353ffa53
TO
62 $paperSize = CRM_Core_BAO_PaperSize::getByName($format['paper_size']);
63 $paper_width = self::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
6a488035
TO
64 $paper_height = self::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
65 // dompdf requires dimensions in points
353ffa53 66 $paper_size = array(0, 0, $paper_width, $paper_height);
6a488035 67 $orientation = CRM_Core_BAO_PdfFormat::getValue('orientation', $format);
353ffa53
TO
68 $metric = CRM_Core_BAO_PdfFormat::getValue('metric', $format);
69 $t = CRM_Core_BAO_PdfFormat::getValue('margin_top', $format);
70 $r = CRM_Core_BAO_PdfFormat::getValue('margin_right', $format);
71 $b = CRM_Core_BAO_PdfFormat::getValue('margin_bottom', $format);
72 $l = CRM_Core_BAO_PdfFormat::getValue('margin_left', $format);
bdfa67c3 73
353ffa53 74 $stationery_path_partial = CRM_Core_BAO_PdfFormat::getValue('stationery', $format);
bdfa67c3 75
76 $stationery_path = NULL;
8e637fa3 77 if (strlen($stationery_path_partial)) {
78 $doc_root = $_SERVER['DOCUMENT_ROOT'];
79 $stationery_path = $doc_root . "/" . $stationery_path_partial;
bdfa67c3 80 }
81
353ffa53 82 $margins = array($metric, $t, $r, $b, $l);
6a488035
TO
83
84 $config = CRM_Core_Config::singleton();
85 $html = "
86<html>
87 <head>
88 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
89 <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style>
90 <style type=\"text/css\">@import url({$config->userFrameworkResourceURL}css/print.css);</style>
91 </head>
92 <body>
93 <div id=\"crm-container\">\n";
94
95 // Strip <html>, <header>, and <body> tags from each page
96 $htmlElementstoStrip = array(
97 '@<head[^>]*?>.*?</head>@siu',
8e637fa3 98 '@<script[^>]*?>.*?</script>@siu',
6a488035
TO
99 '@<body>@siu',
100 '@</body>@siu',
101 '@<html[^>]*?>@siu',
102 '@</html>@siu',
103 '@<!DOCTYPE[^>]*?>@siu',
104 );
105 $htmlElementsInstead = array('', '', '', '', '', '');
106 foreach ($pages as & $page) {
107 $page = preg_replace($htmlElementstoStrip,
108 $htmlElementsInstead,
109 $page
110 );
111 }
112 // Glue the pages together
113 $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages);
114 $html .= "
115 </div>
116 </body>
117</html>";
118 if ($config->wkhtmltopdfPath) {
119 return self::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
120 }
121 else {
8d7ae5ee 122 return self::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
123 //return self::_html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path);
6a488035
TO
124 }
125 }
126
2e2605fe
EM
127 /**
128 * Convert html to tcpdf.
129 *
130 * @param $paper_size
131 * @param $orientation
132 * @param $margins
133 * @param $html
134 * @param $output
135 * @param $fileName
136 * @param $stationery_path
137 */
00be9182 138 public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) {
bdfa67c3 139 // Documentation on the TCPDF library can be found at: http://www.tcpdf.org
140 // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/
141 // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc
142 require_once 'tcpdf/tcpdf.php';
e7292422 143 require_once 'FPDI/fpdi.php'; // This library is only in the 'packages' area as of version 4.5
bdfa67c3 144
353ffa53 145 $paper_size_arr = array($paper_size[2], $paper_size[3]);
bdfa67c3 146
8e637fa3 147 $pdf = new TCPDF($orientation, 'pt', $paper_size_arr);
bdfa67c3 148 $pdf->Open();
149
9b873358 150 if (is_readable($stationery_path)) {
481a74f4 151 $pdf->SetStationery($stationery_path);
bdfa67c3 152 }
153
154 $pdf->SetAuthor('');
155 $pdf->SetKeywords('CiviCRM.org');
481a74f4 156 $pdf->setPageUnit($margins[0]);
e7292422 157 $pdf->SetMargins($margins[4], $margins[1], $margins[2], TRUE);
bdfa67c3 158
159 $pdf->setJPEGQuality('100');
e7292422 160 $pdf->SetAutoPageBreak(TRUE, $margins[3]);
bdfa67c3 161
162 $pdf->AddPage();
163
e7292422
TO
164 $ln = TRUE;
165 $fill = FALSE;
166 $reset_parm = FALSE;
167 $cell = FALSE;
168 $align = '';
8e637fa3 169
bdfa67c3 170 // output the HTML content
171 $pdf->writeHTML($html, $ln, $fill, $reset_parm, $cell, $align);
172
173 // reset pointer to the last page
174 $pdf->lastPage();
175
176 // close and output the PDF
177 $pdf->Close();
92fcb95f 178 $pdf_file = 'CiviLetter' . '.pdf';
bdfa67c3 179 $pdf->Output($pdf_file, 'D');
180 CRM_Utils_System::civiExit(1);
bdfa67c3 181 }
182
5bc392e6
EM
183 /**
184 * @param $paper_size
185 * @param $orientation
186 * @param $html
187 * @param $output
100fef9d 188 * @param string $fileName
5bc392e6
EM
189 *
190 * @return string
191 */
00be9182 192 public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
6a488035
TO
193 require_once 'packages/dompdf/dompdf_config.inc.php';
194 spl_autoload_register('DOMPDF_autoload');
195 $dompdf = new DOMPDF();
196 $dompdf->set_paper($paper_size, $orientation);
197 $dompdf->load_html($html);
198 $dompdf->render();
199
200 if ($output) {
201 return $dompdf->output();
202 }
203 else {
204 $dompdf->stream($fileName);
205 }
206 }
207
5bc392e6
EM
208 /**
209 * @param $paper_size
210 * @param $orientation
211 * @param $margins
212 * @param $html
213 * @param $output
100fef9d 214 * @param string $fileName
5bc392e6 215 */
00be9182 216 public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
6a488035
TO
217 require_once 'packages/snappy/src/autoload.php';
218 $config = CRM_Core_Config::singleton();
219 $snappy = new Knp\Snappy\Pdf($config->wkhtmltopdfPath);
220 $snappy->setOption("page-width", $paper_size[2] . "pt");
221 $snappy->setOption("page-height", $paper_size[3] . "pt");
222 $snappy->setOption("orientation", $orientation);
223 $snappy->setOption("margin-top", $margins[1] . $margins[0]);
224 $snappy->setOption("margin-right", $margins[2] . $margins[0]);
225 $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
226 $snappy->setOption("margin-left", $margins[4] . $margins[0]);
227 $pdf = $snappy->getOutputFromHtml($html);
228 if ($output) {
229 return $pdf;
230 }
231 else {
232 header('Content-Type: application/pdf');
233 header('Content-Disposition: attachment; filename="' . $fileName . '"');
234 echo $pdf;
235 }
236 }
237
5bc392e6 238 /**
fe482240 239 * convert value from one metric to another.
d424ffde 240 *
5bc392e6
EM
241 * @param $value
242 * @param $from
243 * @param $to
244 * @param null $precision
245 *
246 * @return float|int
247 */
00be9182 248 public static function convertMetric($value, $from, $to, $precision = NULL) {
6a488035
TO
249 switch ($from . $to) {
250 case 'incm':
251 $value *= 2.54;
252 break;
253
254 case 'inmm':
255 $value *= 25.4;
256 break;
257
258 case 'inpt':
259 $value *= 72;
260 break;
261
262 case 'cmin':
263 $value /= 2.54;
264 break;
265
266 case 'cmmm':
267 $value *= 10;
268 break;
269
270 case 'cmpt':
271 $value *= 72 / 2.54;
272 break;
273
274 case 'mmin':
275 $value /= 25.4;
276 break;
277
278 case 'mmcm':
279 $value /= 10;
280 break;
281
282 case 'mmpt':
283 $value *= 72 / 25.4;
284 break;
285
286 case 'ptin':
287 $value /= 72;
288 break;
289
290 case 'ptcm':
291 $value *= 2.54 / 72;
292 break;
293
294 case 'ptmm':
295 $value *= 25.4 / 72;
296 break;
297 }
298 if (!is_null($precision)) {
299 $value = round($value, $precision);
300 }
301 return $value;
302 }
303
5bc392e6 304 /**
100fef9d 305 * @param string $fileName
5bc392e6
EM
306 * @param $searchPath
307 * @param $values
308 * @param int $numPages
309 * @param bool $echo
310 * @param string $output
311 * @param string $creator
312 * @param string $author
313 * @param string $title
314 */
13efab9d 315 public static function &pdflib(
a3e55d9c 316 $fileName,
6a488035
TO
317 $searchPath,
318 &$values,
319 $numPages = 1,
e7292422
TO
320 $echo = TRUE,
321 $output = 'College_Match_App',
322 $creator = 'CiviCRM',
323 $author = 'http://www.civicrm.org/',
324 $title = '2006 College Match Scholarship Application'
6a488035
TO
325 ) {
326 try {
327 $pdf = new PDFlib();
328 $pdf->set_parameter("compatibility", "1.6");
329 $pdf->set_parameter("licensefile", "/home/paras/bin/license/pdflib.txt");
330
331 if ($pdf->begin_document('', '') == 0) {
332 CRM_Core_Error::statusBounce("PDFlib Error: " . $pdf->get_errmsg());
333 }
334
335 $config = CRM_Core_Config::singleton();
336 $pdf->set_parameter('resourcefile', $config->templateDir . '/Quest/pdf/pdflib.upr');
337 $pdf->set_parameter('textformat', 'utf8');
338
339 /* Set the search path for fonts and PDF files */
340
341 $pdf->set_parameter('SearchPath', $searchPath);
342
343 /* This line is required to avoid problems on Japanese systems */
344
345 $pdf->set_parameter('hypertextencoding', 'winansi');
346
347 $pdf->set_info('Creator', $creator);
348 $pdf->set_info('Author', $author);
349 $pdf->set_info('Title', $title);
350
351 $blockContainer = $pdf->open_pdi($fileName, '', 0);
352 if ($blockContainer == 0) {
353 CRM_Core_Error::statusBounce('PDFlib Error: ' . $pdf->get_errmsg());
354 }
355
356 for ($i = 1; $i <= $numPages; $i++) {
357 $page = $pdf->open_pdi_page($blockContainer, $i, '');
358 if ($page == 0) {
359 CRM_Core_Error::statusBounce('PDFlib Error: ' . $pdf->get_errmsg());
360 }
361
362 /* dummy page size */
363 $pdf->begin_page_ext(20, 20, '');
364
365 /* This will adjust the page size to the block container's size. */
366
367 $pdf->fit_pdi_page($page, 0, 0, 'adjustpage');
368
6a488035
TO
369 $status = array();
370 /* Fill all text blocks with dynamic data */
371
372 foreach ($values as $key => $value) {
373 if (is_array($value)) {
374 continue;
375 }
376
377 // pdflib does like the forward slash character, hence convert
378 $value = str_replace('/', '_', $value);
379
380 $res = $pdf->fill_textblock($page,
381 $key,
382 $value,
383 'embedding encoding=winansi'
384 );
385
6a488035
TO
386 }
387
388 $pdf->end_page_ext('');
389 $pdf->close_pdi_page($page);
390 }
391
392 $pdf->end_document('');
393 $pdf->close_pdi($blockContainer);
394
395 $buf = $pdf->get_buffer();
396 $len = strlen($buf);
397
398 if ($echo) {
399 header('Content-type: application/pdf');
400 header("Content-Length: $len");
401 header("Content-Disposition: inline; filename={$output}.pdf");
402 echo $buf;
403 CRM_Utils_System::civiExit();
404 }
405 else {
406 return $buf;
407 }
408 }
353ffa53 409 catch (PDFlibException$excp) {
6a488035
TO
410 CRM_Core_Error::statusBounce('PDFlib Error: Exception' .
411 "[" . $excp->get_errnum() . "] " . $excp->get_apiname() . ": " .
412 $excp->get_errmsg()
413 );
414 }
353ffa53 415 catch (Exception$excp) {
6a488035
TO
416 CRM_Core_Error::statusBounce("PDFlib Error: " . $excp->get_errmsg());
417 }
418 }
96025800 419
6a488035 420}