Commit | Line | Data |
---|---|---|
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class 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 | ||
00be9182 | 127 | public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) { |
bdfa67c3 | 128 | // Documentation on the TCPDF library can be found at: http://www.tcpdf.org |
129 | // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/ | |
130 | // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc | |
131 | require_once 'tcpdf/tcpdf.php'; | |
e7292422 | 132 | require_once 'FPDI/fpdi.php'; // This library is only in the 'packages' area as of version 4.5 |
bdfa67c3 | 133 | |
353ffa53 | 134 | $paper_size_arr = array($paper_size[2], $paper_size[3]); |
bdfa67c3 | 135 | |
8e637fa3 | 136 | $pdf = new TCPDF($orientation, 'pt', $paper_size_arr); |
bdfa67c3 | 137 | $pdf->Open(); |
138 | ||
9b873358 | 139 | if (is_readable($stationery_path)) { |
481a74f4 | 140 | $pdf->SetStationery($stationery_path); |
bdfa67c3 | 141 | } |
142 | ||
143 | $pdf->SetAuthor(''); | |
144 | $pdf->SetKeywords('CiviCRM.org'); | |
481a74f4 | 145 | $pdf->setPageUnit($margins[0]); |
e7292422 | 146 | $pdf->SetMargins($margins[4], $margins[1], $margins[2], TRUE); |
bdfa67c3 | 147 | |
148 | $pdf->setJPEGQuality('100'); | |
e7292422 | 149 | $pdf->SetAutoPageBreak(TRUE, $margins[3]); |
bdfa67c3 | 150 | |
151 | $pdf->AddPage(); | |
152 | ||
e7292422 TO |
153 | $ln = TRUE; |
154 | $fill = FALSE; | |
155 | $reset_parm = FALSE; | |
156 | $cell = FALSE; | |
157 | $align = ''; | |
8e637fa3 | 158 | |
bdfa67c3 | 159 | // output the HTML content |
160 | $pdf->writeHTML($html, $ln, $fill, $reset_parm, $cell, $align); | |
161 | ||
162 | // reset pointer to the last page | |
163 | $pdf->lastPage(); | |
164 | ||
165 | // close and output the PDF | |
166 | $pdf->Close(); | |
92fcb95f | 167 | $pdf_file = 'CiviLetter' . '.pdf'; |
bdfa67c3 | 168 | $pdf->Output($pdf_file, 'D'); |
169 | CRM_Utils_System::civiExit(1); | |
bdfa67c3 | 170 | } |
171 | ||
5bc392e6 EM |
172 | /** |
173 | * @param $paper_size | |
174 | * @param $orientation | |
175 | * @param $html | |
176 | * @param $output | |
100fef9d | 177 | * @param string $fileName |
5bc392e6 EM |
178 | * |
179 | * @return string | |
180 | */ | |
00be9182 | 181 | public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) { |
6a488035 TO |
182 | require_once 'packages/dompdf/dompdf_config.inc.php'; |
183 | spl_autoload_register('DOMPDF_autoload'); | |
184 | $dompdf = new DOMPDF(); | |
185 | $dompdf->set_paper($paper_size, $orientation); | |
186 | $dompdf->load_html($html); | |
187 | $dompdf->render(); | |
188 | ||
189 | if ($output) { | |
190 | return $dompdf->output(); | |
191 | } | |
192 | else { | |
193 | $dompdf->stream($fileName); | |
194 | } | |
195 | } | |
196 | ||
5bc392e6 EM |
197 | /** |
198 | * @param $paper_size | |
199 | * @param $orientation | |
200 | * @param $margins | |
201 | * @param $html | |
202 | * @param $output | |
100fef9d | 203 | * @param string $fileName |
5bc392e6 | 204 | */ |
00be9182 | 205 | public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) { |
6a488035 TO |
206 | require_once 'packages/snappy/src/autoload.php'; |
207 | $config = CRM_Core_Config::singleton(); | |
208 | $snappy = new Knp\Snappy\Pdf($config->wkhtmltopdfPath); | |
209 | $snappy->setOption("page-width", $paper_size[2] . "pt"); | |
210 | $snappy->setOption("page-height", $paper_size[3] . "pt"); | |
211 | $snappy->setOption("orientation", $orientation); | |
212 | $snappy->setOption("margin-top", $margins[1] . $margins[0]); | |
213 | $snappy->setOption("margin-right", $margins[2] . $margins[0]); | |
214 | $snappy->setOption("margin-bottom", $margins[3] . $margins[0]); | |
215 | $snappy->setOption("margin-left", $margins[4] . $margins[0]); | |
216 | $pdf = $snappy->getOutputFromHtml($html); | |
217 | if ($output) { | |
218 | return $pdf; | |
219 | } | |
220 | else { | |
221 | header('Content-Type: application/pdf'); | |
222 | header('Content-Disposition: attachment; filename="' . $fileName . '"'); | |
223 | echo $pdf; | |
224 | } | |
225 | } | |
226 | ||
5bc392e6 | 227 | /** |
d424ffde CW |
228 | * convert value from one metric to another |
229 | * | |
5bc392e6 EM |
230 | * @param $value |
231 | * @param $from | |
232 | * @param $to | |
233 | * @param null $precision | |
234 | * | |
235 | * @return float|int | |
236 | */ | |
00be9182 | 237 | public static function convertMetric($value, $from, $to, $precision = NULL) { |
6a488035 TO |
238 | switch ($from . $to) { |
239 | case 'incm': | |
240 | $value *= 2.54; | |
241 | break; | |
242 | ||
243 | case 'inmm': | |
244 | $value *= 25.4; | |
245 | break; | |
246 | ||
247 | case 'inpt': | |
248 | $value *= 72; | |
249 | break; | |
250 | ||
251 | case 'cmin': | |
252 | $value /= 2.54; | |
253 | break; | |
254 | ||
255 | case 'cmmm': | |
256 | $value *= 10; | |
257 | break; | |
258 | ||
259 | case 'cmpt': | |
260 | $value *= 72 / 2.54; | |
261 | break; | |
262 | ||
263 | case 'mmin': | |
264 | $value /= 25.4; | |
265 | break; | |
266 | ||
267 | case 'mmcm': | |
268 | $value /= 10; | |
269 | break; | |
270 | ||
271 | case 'mmpt': | |
272 | $value *= 72 / 25.4; | |
273 | break; | |
274 | ||
275 | case 'ptin': | |
276 | $value /= 72; | |
277 | break; | |
278 | ||
279 | case 'ptcm': | |
280 | $value *= 2.54 / 72; | |
281 | break; | |
282 | ||
283 | case 'ptmm': | |
284 | $value *= 25.4 / 72; | |
285 | break; | |
286 | } | |
287 | if (!is_null($precision)) { | |
288 | $value = round($value, $precision); | |
289 | } | |
290 | return $value; | |
291 | } | |
292 | ||
5bc392e6 | 293 | /** |
100fef9d | 294 | * @param string $fileName |
5bc392e6 EM |
295 | * @param $searchPath |
296 | * @param $values | |
297 | * @param int $numPages | |
298 | * @param bool $echo | |
299 | * @param string $output | |
300 | * @param string $creator | |
301 | * @param string $author | |
302 | * @param string $title | |
303 | */ | |
13efab9d | 304 | public static function &pdflib( |
a3e55d9c | 305 | $fileName, |
6a488035 TO |
306 | $searchPath, |
307 | &$values, | |
308 | $numPages = 1, | |
e7292422 TO |
309 | $echo = TRUE, |
310 | $output = 'College_Match_App', | |
311 | $creator = 'CiviCRM', | |
312 | $author = 'http://www.civicrm.org/', | |
313 | $title = '2006 College Match Scholarship Application' | |
6a488035 TO |
314 | ) { |
315 | try { | |
316 | $pdf = new PDFlib(); | |
317 | $pdf->set_parameter("compatibility", "1.6"); | |
318 | $pdf->set_parameter("licensefile", "/home/paras/bin/license/pdflib.txt"); | |
319 | ||
320 | if ($pdf->begin_document('', '') == 0) { | |
321 | CRM_Core_Error::statusBounce("PDFlib Error: " . $pdf->get_errmsg()); | |
322 | } | |
323 | ||
324 | $config = CRM_Core_Config::singleton(); | |
325 | $pdf->set_parameter('resourcefile', $config->templateDir . '/Quest/pdf/pdflib.upr'); | |
326 | $pdf->set_parameter('textformat', 'utf8'); | |
327 | ||
328 | /* Set the search path for fonts and PDF files */ | |
329 | ||
330 | $pdf->set_parameter('SearchPath', $searchPath); | |
331 | ||
332 | /* This line is required to avoid problems on Japanese systems */ | |
333 | ||
334 | $pdf->set_parameter('hypertextencoding', 'winansi'); | |
335 | ||
336 | $pdf->set_info('Creator', $creator); | |
337 | $pdf->set_info('Author', $author); | |
338 | $pdf->set_info('Title', $title); | |
339 | ||
340 | $blockContainer = $pdf->open_pdi($fileName, '', 0); | |
341 | if ($blockContainer == 0) { | |
342 | CRM_Core_Error::statusBounce('PDFlib Error: ' . $pdf->get_errmsg()); | |
343 | } | |
344 | ||
345 | for ($i = 1; $i <= $numPages; $i++) { | |
346 | $page = $pdf->open_pdi_page($blockContainer, $i, ''); | |
347 | if ($page == 0) { | |
348 | CRM_Core_Error::statusBounce('PDFlib Error: ' . $pdf->get_errmsg()); | |
349 | } | |
350 | ||
351 | /* dummy page size */ | |
352 | $pdf->begin_page_ext(20, 20, ''); | |
353 | ||
354 | /* This will adjust the page size to the block container's size. */ | |
355 | ||
356 | $pdf->fit_pdi_page($page, 0, 0, 'adjustpage'); | |
357 | ||
6a488035 TO |
358 | $status = array(); |
359 | /* Fill all text blocks with dynamic data */ | |
360 | ||
361 | foreach ($values as $key => $value) { | |
362 | if (is_array($value)) { | |
363 | continue; | |
364 | } | |
365 | ||
366 | // pdflib does like the forward slash character, hence convert | |
367 | $value = str_replace('/', '_', $value); | |
368 | ||
369 | $res = $pdf->fill_textblock($page, | |
370 | $key, | |
371 | $value, | |
372 | 'embedding encoding=winansi' | |
373 | ); | |
374 | ||
6a488035 TO |
375 | } |
376 | ||
377 | $pdf->end_page_ext(''); | |
378 | $pdf->close_pdi_page($page); | |
379 | } | |
380 | ||
381 | $pdf->end_document(''); | |
382 | $pdf->close_pdi($blockContainer); | |
383 | ||
384 | $buf = $pdf->get_buffer(); | |
385 | $len = strlen($buf); | |
386 | ||
387 | if ($echo) { | |
388 | header('Content-type: application/pdf'); | |
389 | header("Content-Length: $len"); | |
390 | header("Content-Disposition: inline; filename={$output}.pdf"); | |
391 | echo $buf; | |
392 | CRM_Utils_System::civiExit(); | |
393 | } | |
394 | else { | |
395 | return $buf; | |
396 | } | |
397 | } | |
353ffa53 | 398 | catch (PDFlibException$excp) { |
6a488035 TO |
399 | CRM_Core_Error::statusBounce('PDFlib Error: Exception' . |
400 | "[" . $excp->get_errnum() . "] " . $excp->get_apiname() . ": " . | |
401 | $excp->get_errmsg() | |
402 | ); | |
403 | } | |
353ffa53 | 404 | catch (Exception$excp) { |
6a488035 TO |
405 | CRM_Core_Error::statusBounce("PDFlib Error: " . $excp->get_errmsg()); |
406 | } | |
407 | } | |
408 | } |