CRM/Utils/PDF/Utils.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12
  13 use Dompdf\Dompdf;
  14 use Dompdf\Options;
  15
  16 /**
  17  *
  18  * @package CRM
  19  * @copyright CiviCRM LLC https://civicrm.org/licensing
  20  */
  21 class CRM_Utils_PDF_Utils {
  22
  23   /**
  24    * @param array $text
  25    *   List of HTML snippets.
  26    * @param string $fileName
  27    *   The logical filename to display.
  28    *   Ex: "HelloWorld.pdf".
  29    * @param bool $output
  30    *   FALSE to display PDF. TRUE to return as string.
  31    * @param array|int|null $pdfFormat
  32    *   Unclear. Possibly PdfFormat or formValues.
  33    *
  34    * @return string|void
  35    */
  36   public static function html2pdf($text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
  37     if (is_array($text)) {
  38       $pages = &$text;
  39     }
  40     else {
  41       $pages = [$text];
  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     }
  49     elseif (!empty($pdfFormat)) {
  50       // PDF Page Format ID passed in
  51       $format = CRM_Core_BAO_PdfFormat::getById($pdfFormat);
  52     }
  53     $paperSize = CRM_Core_BAO_PaperSize::getByName($format['paper_size']);
  54     $paper_width = self::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
  55     $paper_height = self::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
  56     // dompdf requires dimensions in points
  57     $paper_size = [0, 0, $paper_width, $paper_height];
  58     $orientation = CRM_Core_BAO_PdfFormat::getValue('orientation', $format);
  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);
  64
  65     $margins = [$metric, $t, $r, $b, $l];
  66
  67     // Add a special region for the HTML header of PDF files:
  68     $pdfHeaderRegion = CRM_Core_Region::instance('export-document-header', FALSE);
  69     $htmlHeader = ($pdfHeaderRegion) ? $pdfHeaderRegion->render('', FALSE) : '';
  70
  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>
  76     <style type=\"text/css\">@import url(" . CRM_Core_Config::singleton()->userFrameworkResourceURL . "css/print.css);</style>
  77     {$htmlHeader}
  78   </head>
  79   <body>
  80     <div id=\"crm-container\">\n";
  81
  82     // Strip <html>, <header>, and <body> tags from each page
  83
  84     $htmlElementstoStrip = [
  85       '<head[^>]*?>.*?</head>',
  86       '<script[^>]*?>.*?</script>',
  87       '<body>',
  88       '</body>',
  89       '<html[^>]*?>',
  90       '</html>',
  91       '<!DOCTYPE[^>]*?>',
  92     ];
  93     foreach ($pages as & $page) {
  94       foreach ($htmlElementstoStrip as $pattern) {
  95         $page = mb_eregi_replace($pattern, '', $page);
  96       }
  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>";
 104     if (CRM_Core_Config::singleton()->wkhtmltopdfPath) {
 105       return self::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
 106     }
 107     else {
 108       return self::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
 109     }
 110   }
 111
 112   /**
 113    * Convert html to tcpdf.
 114    *
 115    * @deprecated
 116    * @param $paper_size
 117    * @param $orientation
 118    * @param $margins
 119    * @param $html
 120    * @param $output
 121    * @param $fileName
 122    * @param $stationery_path
 123    */
 124   public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) {
 125     CRM_Core_Error::deprecatedFunctionWarning('CRM_Utils_PDF::_html2pdf_dompdf');
 126     return self::_html2pdf_dompdf($paper_size, $orientation, $margins, $html, $output, $fileName);
 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';
 131     // This library is only in the 'packages' area as of version 4.5
 132     require_once 'FPDI/fpdi.php';
 133
 134     $paper_size_arr = [$paper_size[2], $paper_size[3]];
 135
 136     $pdf = new TCPDF($orientation, 'pt', $paper_size_arr);
 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 = '';
 158
 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();
 170   }
 171
 172   /**
 173    * @param $paper_size
 174    * @param $orientation
 175    * @param $html
 176    * @param $output
 177    * @param string $fileName
 178    *
 179    * @return string
 180    */
 181   public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
 182     $options = self::getDompdfOptions();
 183     $dompdf = new DOMPDF($options);
 184     $dompdf->set_paper($paper_size, $orientation);
 185     $dompdf->load_html($html);
 186     $dompdf->render();
 187
 188     if ($output) {
 189       return $dompdf->output();
 190     }
 191     // CRM-19183 remove .pdf extension from filename
 192     $fileName = basename($fileName, ".pdf");
 193     if (CIVICRM_UF === 'UnitTests' && headers_sent()) {
 194       // Streaming content will 'die' in unit tests unless ob_start()
 195       // has been called.
 196       throw new CRM_Core_Exception_PrematureExitException('_html2pdf_dompdf called', [
 197         'html' => $html,
 198         'fileName' => $fileName,
 199       ]);
 200     }
 201     $dompdf->stream($fileName);
 202   }
 203
 204   /**
 205    * @param (float|int)[] $paper_size
 206    * @param string $orientation
 207    * @param array $margins
 208    * @param string $html
 209    * @param bool $output
 210    * @param string $fileName
 211    */
 212   public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
 213     require_once 'snappy/src/autoload.php';
 214     $config = CRM_Core_Config::singleton();
 215     $snappy = new Knp\Snappy\Pdf($config->wkhtmltopdfPath);
 216     $snappy->setOption("page-width", $paper_size[2] . "pt");
 217     $snappy->setOption("page-height", $paper_size[3] . "pt");
 218     $snappy->setOption("orientation", $orientation);
 219     $snappy->setOption("margin-top", $margins[1] . $margins[0]);
 220     $snappy->setOption("margin-right", $margins[2] . $margins[0]);
 221     $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
 222     $snappy->setOption("margin-left", $margins[4] . $margins[0]);
 223     $pdf = $snappy->getOutputFromHtml($html);
 224     if ($output) {
 225       return $pdf;
 226     }
 227     else {
 228       CRM_Utils_System::setHttpHeader('Content-Type', 'application/pdf');
 229       CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"');
 230       echo $pdf;
 231     }
 232   }
 233
 234   /**
 235    * convert value from one metric to another.
 236    *
 237    * @param int $value
 238    * @param string $from
 239    * @param string $to
 240    * @param int|null $precision
 241    *
 242    * @return float|int
 243    */
 244   public static function convertMetric($value, $from, $to, $precision = NULL) {
 245     switch ($from . $to) {
 246       case 'incm':
 247         $value *= 2.54;
 248         break;
 249
 250       case 'inmm':
 251         $value *= 25.4;
 252         break;
 253
 254       case 'inpt':
 255         $value *= 72;
 256         break;
 257
 258       case 'cmin':
 259         $value /= 2.54;
 260         break;
 261
 262       case 'cmmm':
 263         $value *= 10;
 264         break;
 265
 266       case 'cmpt':
 267         $value *= 72 / 2.54;
 268         break;
 269
 270       case 'mmin':
 271         $value /= 25.4;
 272         break;
 273
 274       case 'mmcm':
 275         $value /= 10;
 276         break;
 277
 278       case 'mmpt':
 279         $value *= 72 / 25.4;
 280         break;
 281
 282       case 'ptin':
 283         $value /= 72;
 284         break;
 285
 286       case 'ptcm':
 287         $value *= 2.54 / 72;
 288         break;
 289
 290       case 'ptmm':
 291         $value *= 25.4 / 72;
 292         break;
 293     }
 294     if (!is_null($precision)) {
 295       $value = round($value, $precision);
 296     }
 297     return $value;
 298   }
 299
 300   /**
 301    * Allow setting some dompdf options.
 302    *
 303    * We don't support all the available dompdf options.
 304    *
 305    * @return \Dompdf\Options
 306    */
 307   private static function getDompdfOptions(): Options {
 308     $options = new Options();
 309     $settings = [
 310       // CRM-12165 - Remote file support required for image handling so default to TRUE
 311       'enable_remote' => \Civi::settings()->get('dompdf_enable_remote') ?? TRUE,
 312     ];
 313     // only set these ones if a setting exists for them
 314     foreach (['font_dir', 'chroot', 'log_output_file'] as $setting) {
 315       $value = \Civi::settings()->get("dompdf_$setting");
 316       if (isset($value)) {
 317         $settings[$setting] = $value;
 318       }
 319     }
 320     $options->set($settings);
 321     return $options;
 322   }
 323
 324 }