Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 | 11 | |
383b23e3 | 12 | |
0b6fe14b | 13 | use Dompdf\Dompdf; |
2256f347 | 14 | use Dompdf\Options; |
6714d8d2 | 15 | |
6a488035 TO |
16 | /** |
17 | * | |
18 | * @package CRM | |
ca5cec67 | 19 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
20 | */ |
21 | class CRM_Utils_PDF_Utils { | |
22 | ||
5bc392e6 | 23 | /** |
4f308883 TO |
24 | * @param array $text |
25 | * List of HTML snippets. | |
5bc392e6 | 26 | * @param string $fileName |
3ed92c14 TO |
27 | * The logical filename to display. |
28 | * Ex: "HelloWorld.pdf". | |
5bc392e6 | 29 | * @param bool $output |
3ed92c14 | 30 | * FALSE to display PDF. TRUE to return as string. |
5bc392e6 | 31 | * @param null $pdfFormat |
3ed92c14 | 32 | * Unclear. Possibly PdfFormat or formValues. |
5bc392e6 EM |
33 | * |
34 | * @return string|void | |
35 | */ | |
56d5847d | 36 | public static function html2pdf($text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) { |
6a488035 TO |
37 | if (is_array($text)) { |
38 | $pages = &$text; | |
39 | } | |
40 | else { | |
be2fb01f | 41 | $pages = [$text]; |
6a488035 TO |
42 | } |
43 | // Get PDF Page Format | |
44 | $format = CRM_Core_BAO_PdfFormat::getDefaultValues(); | |
45 | if (is_array($pdfFormat)) { | |
46 | // PDF Page Format parameters passed in | |
47 | $format = array_merge($format, $pdfFormat); | |
48 | } | |
18a3e0c0 | 49 | elseif (!empty($pdfFormat)) { |
6a488035 TO |
50 | // PDF Page Format ID passed in |
51 | $format = CRM_Core_BAO_PdfFormat::getById($pdfFormat); | |
52 | } | |
353ffa53 TO |
53 | $paperSize = CRM_Core_BAO_PaperSize::getByName($format['paper_size']); |
54 | $paper_width = self::convertMetric($paperSize['width'], $paperSize['metric'], 'pt'); | |
6a488035 TO |
55 | $paper_height = self::convertMetric($paperSize['height'], $paperSize['metric'], 'pt'); |
56 | // dompdf requires dimensions in points | |
be2fb01f | 57 | $paper_size = [0, 0, $paper_width, $paper_height]; |
6a488035 | 58 | $orientation = CRM_Core_BAO_PdfFormat::getValue('orientation', $format); |
353ffa53 TO |
59 | $metric = CRM_Core_BAO_PdfFormat::getValue('metric', $format); |
60 | $t = CRM_Core_BAO_PdfFormat::getValue('margin_top', $format); | |
61 | $r = CRM_Core_BAO_PdfFormat::getValue('margin_right', $format); | |
62 | $b = CRM_Core_BAO_PdfFormat::getValue('margin_bottom', $format); | |
63 | $l = CRM_Core_BAO_PdfFormat::getValue('margin_left', $format); | |
bdfa67c3 | 64 | |
be2fb01f | 65 | $margins = [$metric, $t, $r, $b, $l]; |
6a488035 | 66 | |
b0500874 | 67 | // Add a special region for the HTML header of PDF files: |
7419f31d | 68 | $pdfHeaderRegion = CRM_Core_Region::instance('export-document-header', FALSE); |
b0500874 AH |
69 | $htmlHeader = ($pdfHeaderRegion) ? $pdfHeaderRegion->render('', FALSE) : ''; |
70 | ||
6a488035 TO |
71 | $html = " |
72 | <html> | |
73 | <head> | |
74 | <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/> | |
75 | <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style> | |
56d5847d | 76 | <style type=\"text/css\">@import url(" . CRM_Core_Config::singleton()->userFrameworkResourceURL . "css/print.css);</style> |
b0500874 | 77 | {$htmlHeader} |
6a488035 TO |
78 | </head> |
79 | <body> | |
80 | <div id=\"crm-container\">\n"; | |
81 | ||
82 | // Strip <html>, <header>, and <body> tags from each page | |
fe276fa5 | 83 | |
56d5847d | 84 | $htmlElementstoStrip = [ |
fe276fa5 J |
85 | '<head[^>]*?>.*?</head>', |
86 | '<script[^>]*?>.*?</script>', | |
87 | '<body>', | |
88 | '</body>', | |
89 | '<html[^>]*?>', | |
90 | '</html>', | |
91 | '<!DOCTYPE[^>]*?>', | |
56d5847d | 92 | ]; |
6a488035 | 93 | foreach ($pages as & $page) { |
fe276fa5 J |
94 | foreach ($htmlElementstoStrip as $pattern) { |
95 | $page = mb_eregi_replace($pattern, '', $page); | |
96 | } | |
6a488035 TO |
97 | } |
98 | // Glue the pages together | |
99 | $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages); | |
100 | $html .= " | |
101 | </div> | |
102 | </body> | |
103 | </html>"; | |
56d5847d | 104 | if (CRM_Core_Config::singleton()->wkhtmltopdfPath) { |
6a488035 TO |
105 | return self::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName); |
106 | } | |
107 | else { | |
8d7ae5ee | 108 | return self::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName); |
6a488035 TO |
109 | } |
110 | } | |
111 | ||
2e2605fe EM |
112 | /** |
113 | * Convert html to tcpdf. | |
114 | * | |
0677f5a4 | 115 | * @deprecated |
2e2605fe EM |
116 | * @param $paper_size |
117 | * @param $orientation | |
118 | * @param $margins | |
119 | * @param $html | |
120 | * @param $output | |
121 | * @param $fileName | |
122 | * @param $stationery_path | |
123 | */ | |
00be9182 | 124 | public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) { |
f713b8b6 SL |
125 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Utils_PDF::_html2pdf_dompdf'); |
126 | return self::_html2pdf_dompdf($paper_size, $orientation, $margins, $html, $output, $fileName); | |
bdfa67c3 | 127 | // Documentation on the TCPDF library can be found at: http://www.tcpdf.org |
128 | // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/ | |
129 | // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc | |
130 | require_once 'tcpdf/tcpdf.php'; | |
6714d8d2 SL |
131 | // This library is only in the 'packages' area as of version 4.5 |
132 | require_once 'FPDI/fpdi.php'; | |
bdfa67c3 | 133 | |
be2fb01f | 134 | $paper_size_arr = [$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'); |
292c8687 | 169 | CRM_Utils_System::civiExit(); |
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) { |
2256f347 SL |
182 | // CRM-12165 - Remote file support required for image handling. |
183 | $options = new Options(); | |
184 | $options->set('isRemoteEnabled', TRUE); | |
185 | ||
186 | $dompdf = new DOMPDF($options); | |
6a488035 TO |
187 | $dompdf->set_paper($paper_size, $orientation); |
188 | $dompdf->load_html($html); | |
189 | $dompdf->render(); | |
190 | ||
191 | if ($output) { | |
192 | return $dompdf->output(); | |
193 | } | |
194 | else { | |
53a39759 | 195 | // CRM-19183 remove .pdf extension from filename |
196 | $fileName = basename($fileName, ".pdf"); | |
6a488035 TO |
197 | $dompdf->stream($fileName); |
198 | } | |
199 | } | |
200 | ||
5bc392e6 EM |
201 | /** |
202 | * @param $paper_size | |
203 | * @param $orientation | |
204 | * @param $margins | |
205 | * @param $html | |
206 | * @param $output | |
100fef9d | 207 | * @param string $fileName |
5bc392e6 | 208 | */ |
00be9182 | 209 | public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) { |
6a488035 TO |
210 | require_once 'packages/snappy/src/autoload.php'; |
211 | $config = CRM_Core_Config::singleton(); | |
212 | $snappy = new Knp\Snappy\Pdf($config->wkhtmltopdfPath); | |
213 | $snappy->setOption("page-width", $paper_size[2] . "pt"); | |
214 | $snappy->setOption("page-height", $paper_size[3] . "pt"); | |
215 | $snappy->setOption("orientation", $orientation); | |
216 | $snappy->setOption("margin-top", $margins[1] . $margins[0]); | |
217 | $snappy->setOption("margin-right", $margins[2] . $margins[0]); | |
218 | $snappy->setOption("margin-bottom", $margins[3] . $margins[0]); | |
219 | $snappy->setOption("margin-left", $margins[4] . $margins[0]); | |
220 | $pdf = $snappy->getOutputFromHtml($html); | |
221 | if ($output) { | |
222 | return $pdf; | |
223 | } | |
224 | else { | |
d42a224c CW |
225 | CRM_Utils_System::setHttpHeader('Content-Type', 'application/pdf'); |
226 | CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"'); | |
6a488035 TO |
227 | echo $pdf; |
228 | } | |
229 | } | |
230 | ||
5bc392e6 | 231 | /** |
fe482240 | 232 | * convert value from one metric to another. |
d424ffde | 233 | * |
5bc392e6 EM |
234 | * @param $value |
235 | * @param $from | |
236 | * @param $to | |
237 | * @param null $precision | |
238 | * | |
239 | * @return float|int | |
240 | */ | |
00be9182 | 241 | public static function convertMetric($value, $from, $to, $precision = NULL) { |
6a488035 TO |
242 | switch ($from . $to) { |
243 | case 'incm': | |
244 | $value *= 2.54; | |
245 | break; | |
246 | ||
247 | case 'inmm': | |
248 | $value *= 25.4; | |
249 | break; | |
250 | ||
251 | case 'inpt': | |
252 | $value *= 72; | |
253 | break; | |
254 | ||
255 | case 'cmin': | |
256 | $value /= 2.54; | |
257 | break; | |
258 | ||
259 | case 'cmmm': | |
260 | $value *= 10; | |
261 | break; | |
262 | ||
263 | case 'cmpt': | |
264 | $value *= 72 / 2.54; | |
265 | break; | |
266 | ||
267 | case 'mmin': | |
268 | $value /= 25.4; | |
269 | break; | |
270 | ||
271 | case 'mmcm': | |
272 | $value /= 10; | |
273 | break; | |
274 | ||
275 | case 'mmpt': | |
276 | $value *= 72 / 25.4; | |
277 | break; | |
278 | ||
279 | case 'ptin': | |
280 | $value /= 72; | |
281 | break; | |
282 | ||
283 | case 'ptcm': | |
284 | $value *= 2.54 / 72; | |
285 | break; | |
286 | ||
287 | case 'ptmm': | |
288 | $value *= 25.4 / 72; | |
289 | break; | |
290 | } | |
291 | if (!is_null($precision)) { | |
292 | $value = round($value, $precision); | |
293 | } | |
294 | return $value; | |
295 | } | |
296 | ||
6a488035 | 297 | } |