Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
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 | */ | |
6a488035 TO |
45 | static function html2pdf(&$text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) { |
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 | } | |
62 | $paperSize = CRM_Core_BAO_PaperSize::getByName($format['paper_size']); | |
63 | $paper_width = self::convertMetric($paperSize['width'], $paperSize['metric'], 'pt'); | |
64 | $paper_height = self::convertMetric($paperSize['height'], $paperSize['metric'], 'pt'); | |
65 | // dompdf requires dimensions in points | |
66 | $paper_size = array(0, 0, $paper_width, $paper_height); | |
67 | $orientation = CRM_Core_BAO_PdfFormat::getValue('orientation', $format); | |
68 | $metric = CRM_Core_BAO_PdfFormat::getValue('metric', $format); | |
69 | $t = CRM_Core_BAO_PdfFormat::getValue('margin_top', $format); | |
8e637fa3 | 70 | $r = CRM_Core_BAO_PdfFormat::getValue('margin_right', $format); |
6a488035 TO |
71 | $b = CRM_Core_BAO_PdfFormat::getValue('margin_bottom', $format); |
72 | $l = CRM_Core_BAO_PdfFormat::getValue('margin_left', $format); | |
bdfa67c3 | 73 | |
74 | $stationery_path_partial = CRM_Core_BAO_PdfFormat::getValue('stationery', $format); | |
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 | ||
6a488035 TO |
82 | $margins = array($metric,$t,$r,$b,$l); |
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 { | |
bdfa67c3 | 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 | ||
bdfa67c3 | 127 | static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) { |
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'; | |
132 | require_once('FPDI/fpdi.php'); // This library is only in the 'packages' area as of version 4.5 | |
133 | ||
134 | $paper_size_arr = array( $paper_size[2], $paper_size[3]); | |
135 | ||
8e637fa3 | 136 | $pdf = new TCPDF($orientation, 'pt', $paper_size_arr); |
bdfa67c3 | 137 | $pdf->Open(); |
138 | ||
139 | if (is_readable($stationery_path)){ | |
140 | $pdf->SetStationery( $stationery_path ); | |
141 | } | |
142 | ||
143 | $pdf->SetAuthor(''); | |
144 | $pdf->SetKeywords('CiviCRM.org'); | |
145 | $pdf->setPageUnit( $margins[0] ) ; | |
146 | $pdf->SetMargins($margins[4], $margins[1], $margins[2], true); | |
147 | ||
148 | $pdf->setJPEGQuality('100'); | |
149 | $pdf->SetAutoPageBreak(true, $margins[3]); | |
150 | ||
151 | $pdf->AddPage(); | |
152 | ||
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(); | |
167 | $pdf_file = 'CiviLetter'.'.pdf'; | |
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 | |
177 | * @param $fileName | |
178 | * | |
179 | * @return string | |
180 | */ | |
6a488035 TO |
181 | static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) { |
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 | |
203 | * @param $fileName | |
204 | */ | |
6a488035 TO |
205 | static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) { |
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 | ||
227 | /* | |
228 | * function to convert value from one metric to another | |
229 | */ | |
5bc392e6 EM |
230 | /** |
231 | * @param $value | |
232 | * @param $from | |
233 | * @param $to | |
234 | * @param null $precision | |
235 | * | |
236 | * @return float|int | |
237 | */ | |
6a488035 TO |
238 | static function convertMetric($value, $from, $to, $precision = NULL) { |
239 | switch ($from . $to) { | |
240 | case 'incm': | |
241 | $value *= 2.54; | |
242 | break; | |
243 | ||
244 | case 'inmm': | |
245 | $value *= 25.4; | |
246 | break; | |
247 | ||
248 | case 'inpt': | |
249 | $value *= 72; | |
250 | break; | |
251 | ||
252 | case 'cmin': | |
253 | $value /= 2.54; | |
254 | break; | |
255 | ||
256 | case 'cmmm': | |
257 | $value *= 10; | |
258 | break; | |
259 | ||
260 | case 'cmpt': | |
261 | $value *= 72 / 2.54; | |
262 | break; | |
263 | ||
264 | case 'mmin': | |
265 | $value /= 25.4; | |
266 | break; | |
267 | ||
268 | case 'mmcm': | |
269 | $value /= 10; | |
270 | break; | |
271 | ||
272 | case 'mmpt': | |
273 | $value *= 72 / 25.4; | |
274 | break; | |
275 | ||
276 | case 'ptin': | |
277 | $value /= 72; | |
278 | break; | |
279 | ||
280 | case 'ptcm': | |
281 | $value *= 2.54 / 72; | |
282 | break; | |
283 | ||
284 | case 'ptmm': | |
285 | $value *= 25.4 / 72; | |
286 | break; | |
287 | } | |
288 | if (!is_null($precision)) { | |
289 | $value = round($value, $precision); | |
290 | } | |
291 | return $value; | |
292 | } | |
293 | ||
5bc392e6 EM |
294 | /** |
295 | * @param $fileName | |
296 | * @param $searchPath | |
297 | * @param $values | |
298 | * @param int $numPages | |
299 | * @param bool $echo | |
300 | * @param string $output | |
301 | * @param string $creator | |
302 | * @param string $author | |
303 | * @param string $title | |
304 | */ | |
6a488035 TO |
305 | static function &pdflib($fileName, |
306 | $searchPath, | |
307 | &$values, | |
308 | $numPages = 1, | |
309 | $echo = TRUE, | |
310 | $output = 'College_Match_App', | |
311 | $creator = 'CiviCRM', | |
312 | $author = 'http://www.civicrm.org/', | |
313 | $title = '2006 College Match Scholarship Application' | |
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 | ||
358 | ||
359 | $status = array(); | |
360 | /* Fill all text blocks with dynamic data */ | |
361 | ||
362 | foreach ($values as $key => $value) { | |
363 | if (is_array($value)) { | |
364 | continue; | |
365 | } | |
366 | ||
367 | // pdflib does like the forward slash character, hence convert | |
368 | $value = str_replace('/', '_', $value); | |
369 | ||
370 | $res = $pdf->fill_textblock($page, | |
371 | $key, | |
372 | $value, | |
373 | 'embedding encoding=winansi' | |
374 | ); | |
375 | ||
376 | /** | |
377 | if ( $res == 0 ) { | |
378 | CRM_Core_Error::debug( "$key, $value: $res", $pdf->get_errmsg( ) ); | |
379 | } else { | |
380 | CRM_Core_Error::debug( "SUCCESS: $key, $value", null ); | |
381 | } | |
382 | **/ | |
383 | } | |
384 | ||
385 | $pdf->end_page_ext(''); | |
386 | $pdf->close_pdi_page($page); | |
387 | } | |
388 | ||
389 | $pdf->end_document(''); | |
390 | $pdf->close_pdi($blockContainer); | |
391 | ||
392 | $buf = $pdf->get_buffer(); | |
393 | $len = strlen($buf); | |
394 | ||
395 | if ($echo) { | |
396 | header('Content-type: application/pdf'); | |
397 | header("Content-Length: $len"); | |
398 | header("Content-Disposition: inline; filename={$output}.pdf"); | |
399 | echo $buf; | |
400 | CRM_Utils_System::civiExit(); | |
401 | } | |
402 | else { | |
403 | return $buf; | |
404 | } | |
405 | } | |
406 | catch(PDFlibException$excp) { | |
407 | CRM_Core_Error::statusBounce('PDFlib Error: Exception' . | |
408 | "[" . $excp->get_errnum() . "] " . $excp->get_apiname() . ": " . | |
409 | $excp->get_errmsg() | |
410 | ); | |
411 | } | |
412 | catch(Exception$excp) { | |
413 | CRM_Core_Error::statusBounce("PDFlib Error: " . $excp->get_errmsg()); | |
414 | } | |
415 | } | |
416 | } | |
417 |