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
  22 class CRM_Utils_PDF_Utils {
  23
  24   public static function enqueuePDF($pdf) {
  25
  26     $fname = time().'_lp.pdf';
  27     file_put_contents('/tmp/'.$fname, $pdf);
  28     header('Location: /civicrm/lp-setup?file='.$fname);
  29     exit;
  30
  31   }
  32
  33   public static function latex2pdf(&$text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
  34           /* FIXME: get $paper_size, $orientation, $margins */
  35
  36     if (is_array($text)) {
  37       $pages = &$text;
  38     }
  39     else {
  40       $pages = array($text);
  41     }
  42
  43     $head='\documentclass[12pt]{letter}
  44 \usepackage{url}
  45 \usepackage{ucs}
  46 \usepackage{graphicx}
  47 \usepackage[T1]{fontenc}
  48 \usepackage{fullpage}
  49 \usepackage{fontspec,xunicode}
  50 %% VERY IMPORTANT.  Configures supported languages and fonts to use for each one.
  51 \usepackage[Latin, Hebrew, Arabics, CJK, Diacritics]{ucharclasses}
  52 \setDefaultTransitions{\fontspec{FreeSerif}}{}
  53 \setTransitionsForLatin{\fontspec{FreeSerif}}{}
  54 \setTransitionsForArabics{\fontspec{FreeSerif}}{}
  55 \setTransitionsForCJK{\fontspec{WenQuanYi Zen Hei}}{}
  56 \setTransitionsForDiacritics{\fontspec{FreeSerif}}{}
  57 \setTransitionTo{Hebrew}{\fontspec{FreeSerif}}
  58 \setmainfont{FreeSerif}
  59
  60 \newcommand{\fsfclosing}[1]{\par\nobreak\vspace{\parskip}
  61   \stopbreaks
  62   \noindent
  63   \ifx\@empty\fromaddress\else
  64   \hspace*{\longindentation}\fi
  65   \parbox{\indentedwidth}{\raggedright
  66        \ignorespaces #1\\\\[1\medskipamount]
  67        \hspace*{-0.25in}\includegraphics[scale=1.0]{/var/www/drupal-7.27/sites/all/modules/civicrm/sigjohns.pdf}
  68        \\\\
  69
  70        \ifx\@empty\fromsig
  71            \fromname
  72        \else \fromsig \fi\strut}
  73    \par}
  74 \medskipamount=\parskip
  75
  76 %% This line might be necessary, but it was not able to find utf8.def on my
  77 %% machine.
  78 %% \usepackage[utf8x]{inputenc}
  79 \pagestyle{empty}
  80 \tolerance=8000
  81 \address{\vspace{0.05in}}
  82 \signature{John Sullivan \\\\ Executive Director}
  83 \usepackage[
  84 top    = 1.5in,
  85 bottom = 1.25in,
  86 left   = 1.0in,
  87 right  = 1.0in]{geometry}
  88 \begin{document}
  89 ';
  90                  $footer='
  91 \end{document}';
  92
  93     $latex = $head;
  94     foreach ($pages as $page) {
  95                         $latex.=$page;
  96                 }
  97     $latex.=$footer;
  98
  99                 $descriptorspec = array(
 100          0 => array("pipe", "r"),
 101          1 => array("pipe", "w")
 102                 );
 103
 104
 105
 106                 $process = proc_open("/usr/local/bin/pdflatex_wrapper.sh", $descriptorspec, $pipes);
 107
 108
 109           if (is_resource($process)) {
 110                         fwrite($pipes[0], $latex);
 111                         fclose($pipes[0]);
 112
 113       $pdf = stream_get_contents($pipes[1]);
 114                         fclose($pipes[1]);
 115           } else {
 116                         CRM_Core_Error::debug_log_message("ERROR creating PDF. Check /tmp/pdflatex_*");
 117                 }
 118
 119     if ($output) {
 120       return $pdf;
 121     }
 122     else {
 123       header('Content-Type: application/pdf');
 124       header('Content-Disposition: attachment; filename="' . $fileName . '"');
 125       echo $pdf;
 126 //      CRM_Utils_PDF_Utils::enqueuePDF($pdf);
 127
 128     }
 129   }
 130
 131   /**
 132    * @param array $text
 133    *   List of HTML snippets.
 134    * @param string $fileName
 135    *   The logical filename to display.
 136    *   Ex: "HelloWorld.pdf".
 137    * @param bool $output
 138    *   FALSE to display PDF. TRUE to return as string.
 139    * @param array|int|null $pdfFormat
 140    *   Unclear. Possibly PdfFormat or formValues.
 141    *
 142    * @return string|void
 143    */
 144   public static function html2pdf($text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
 145     if (is_array($text)) {
 146       $pages = &$text;
 147     }
 148     else {
 149       $pages = [$text];
 150     }
 151     // Get PDF Page Format
 152     $format = CRM_Core_BAO_PdfFormat::getDefaultValues();
 153     if (is_array($pdfFormat)) {
 154       // PDF Page Format parameters passed in
 155       $format = array_merge($format, $pdfFormat);
 156     }
 157     elseif (!empty($pdfFormat)) {
 158       // PDF Page Format ID passed in
 159       $format = CRM_Core_BAO_PdfFormat::getById($pdfFormat);
 160     }
 161     $paperSize = CRM_Core_BAO_PaperSize::getByName($format['paper_size']);
 162     $paper_width = self::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
 163     $paper_height = self::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
 164     // dompdf requires dimensions in points
 165     $paper_size = [0, 0, $paper_width, $paper_height];
 166     $orientation = CRM_Core_BAO_PdfFormat::getValue('orientation', $format);
 167     $metric = CRM_Core_BAO_PdfFormat::getValue('metric', $format);
 168     $t = CRM_Core_BAO_PdfFormat::getValue('margin_top', $format);
 169     $r = CRM_Core_BAO_PdfFormat::getValue('margin_right', $format);
 170     $b = CRM_Core_BAO_PdfFormat::getValue('margin_bottom', $format);
 171     $l = CRM_Core_BAO_PdfFormat::getValue('margin_left', $format);
 172
 173     $margins = [$metric, $t, $r, $b, $l];
 174
 175     // Add a special region for the HTML header of PDF files:
 176     $pdfHeaderRegion = CRM_Core_Region::instance('export-document-header', FALSE);
 177     $htmlHeader = ($pdfHeaderRegion) ? $pdfHeaderRegion->render('', FALSE) : '';
 178
 179     $html = "
 180 <html>
 181   <head>
 182     <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
 183     <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style>
 184     <style type=\"text/css\">@import url(" . CRM_Core_Config::singleton()->userFrameworkResourceURL . "css/print.css);</style>
 185     {$htmlHeader}
 186   </head>
 187   <body>
 188     <div id=\"crm-container\">\n";
 189
 190     // Strip <html>, <header>, and <body> tags from each page
 191
 192     $htmlElementstoStrip = [
 193       '<head[^>]*?>.*?</head>',
 194       '<script[^>]*?>.*?</script>',
 195       '<body>',
 196       '</body>',
 197       '<html[^>]*?>',
 198       '</html>',
 199       '<!DOCTYPE[^>]*?>',
 200     ];
 201     foreach ($pages as & $page) {
 202       foreach ($htmlElementstoStrip as $pattern) {
 203         $page = mb_eregi_replace($pattern, '', $page);
 204       }
 205     }
 206     // Glue the pages together
 207     $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages);
 208     $html .= "
 209     </div>
 210   </body>
 211 </html>";
 212     if (CRM_Core_Config::singleton()->wkhtmltopdfPath) {
 213       return self::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
 214     }
 215     else {
 216       return self::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
 217     }
 218   }
 219
 220   /**
 221    * Convert html to tcpdf.
 222    *
 223    * @deprecated
 224    * @param $paper_size
 225    * @param $orientation
 226    * @param $margins
 227    * @param $html
 228    * @param $output
 229    * @param $fileName
 230    * @param $stationery_path
 231    */
 232   public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) {
 233     CRM_Core_Error::deprecatedFunctionWarning('CRM_Utils_PDF::_html2pdf_dompdf');
 234     return self::_html2pdf_dompdf($paper_size, $orientation, $margins, $html, $output, $fileName);
 235     // Documentation on the TCPDF library can be found at: http://www.tcpdf.org
 236     // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/
 237     // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc
 238     require_once 'tcpdf/tcpdf.php';
 239     // This library is only in the 'packages' area as of version 4.5
 240     require_once 'FPDI/fpdi.php';
 241
 242     $paper_size_arr = [$paper_size[2], $paper_size[3]];
 243
 244     $pdf = new TCPDF($orientation, 'pt', $paper_size_arr);
 245     $pdf->Open();
 246
 247     if (is_readable($stationery_path)) {
 248       $pdf->SetStationery($stationery_path);
 249     }
 250
 251     $pdf->SetAuthor('');
 252     $pdf->SetKeywords('CiviCRM.org');
 253     $pdf->setPageUnit($margins[0]);
 254     $pdf->SetMargins($margins[4], $margins[1], $margins[2], TRUE);
 255
 256     $pdf->setJPEGQuality('100');
 257     $pdf->SetAutoPageBreak(TRUE, $margins[3]);
 258
 259     $pdf->AddPage();
 260
 261     $ln = TRUE;
 262     $fill = FALSE;
 263     $reset_parm = FALSE;
 264     $cell = FALSE;
 265     $align = '';
 266
 267     // output the HTML content
 268     $pdf->writeHTML($html, $ln, $fill, $reset_parm, $cell, $align);
 269
 270     // reset pointer to the last page
 271     $pdf->lastPage();
 272
 273     // close and output the PDF
 274     $pdf->Close();
 275     $pdf_file = 'CiviLetter' . '.pdf';
 276     $pdf->Output($pdf_file, 'D');
 277     CRM_Utils_System::civiExit();
 278   }
 279
 280   /**
 281    * @param $paper_size
 282    * @param $orientation
 283    * @param $html
 284    * @param $output
 285    * @param string $fileName
 286    *
 287    * @return string
 288    */
 289   public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
 290     $options = self::getDompdfOptions();
 291     $dompdf = new DOMPDF($options);
 292     $dompdf->set_paper($paper_size, $orientation);
 293     $dompdf->load_html($html);
 294     $dompdf->render();
 295
 296     if ($output) {
 297       return $dompdf->output();
 298     }
 299     // CRM-19183 remove .pdf extension from filename
 300     $fileName = basename($fileName, ".pdf");
 301     if (CIVICRM_UF === 'UnitTests') {
 302       // Streaming content will 'die' in unit tests unless ob_start()
 303       // has been called.
 304       throw new CRM_Core_Exception_PrematureExitException('_html2pdf_dompdf called', [
 305         'html' => $html,
 306         'fileName' => $fileName,
 307         'output' => 'pdf',
 308       ]);
 309     }
 310     $dompdf->stream($fileName);
 311   }
 312
 313   /**
 314    * @param float|int[] $paper_size
 315    * @param string $orientation
 316    * @param array $margins
 317    * @param string $html
 318    * @param bool $output
 319    * @param string $fileName
 320    */
 321   public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
 322     require_once 'snappy/src/autoload.php';
 323     $config = CRM_Core_Config::singleton();
 324     $snappy = new Knp\Snappy\Pdf($config->wkhtmltopdfPath);
 325     $snappy->setOption("page-width", $paper_size[2] . "pt");
 326     $snappy->setOption("page-height", $paper_size[3] . "pt");
 327     $snappy->setOption("orientation", $orientation);
 328     $snappy->setOption("margin-top", $margins[1] . $margins[0]);
 329     $snappy->setOption("margin-right", $margins[2] . $margins[0]);
 330     $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
 331     $snappy->setOption("margin-left", $margins[4] . $margins[0]);
 332     $html = preg_replace('/{ }/', ' ', $html);
 333     $pdf = $snappy->getOutputFromHtml($html);
 334     if ($output) {
 335       return $pdf;
 336     }
 337     else {
 338       CRM_Utils_System::setHttpHeader('Content-Type', 'application/pdf');
 339       CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"');
 340       echo $pdf;
 341       //CRM_Utils_PDF_Utils::enqueuePDF($pdf);
 342
 343     }
 344   }
 345
 346   /**
 347    * convert value from one metric to another.
 348    *
 349    * @param int $value
 350    * @param string $from
 351    * @param string $to
 352    * @param int|null $precision
 353    *
 354    * @return float|int
 355    */
 356   public static function convertMetric($value, $from, $to, $precision = NULL) {
 357     switch ($from . $to) {
 358       case 'incm':
 359         $value *= 2.54;
 360         break;
 361
 362       case 'inmm':
 363         $value *= 25.4;
 364         break;
 365
 366       case 'inpt':
 367         $value *= 72;
 368         break;
 369
 370       case 'cmin':
 371         $value /= 2.54;
 372         break;
 373
 374       case 'cmmm':
 375         $value *= 10;
 376         break;
 377
 378       case 'cmpt':
 379         $value *= 72 / 2.54;
 380         break;
 381
 382       case 'mmin':
 383         $value /= 25.4;
 384         break;
 385
 386       case 'mmcm':
 387         $value /= 10;
 388         break;
 389
 390       case 'mmpt':
 391         $value *= 72 / 25.4;
 392         break;
 393
 394       case 'ptin':
 395         $value /= 72;
 396         break;
 397
 398       case 'ptcm':
 399         $value *= 2.54 / 72;
 400         break;
 401
 402       case 'ptmm':
 403         $value *= 25.4 / 72;
 404         break;
 405     }
 406     if (!is_null($precision)) {
 407       $value = round($value, $precision);
 408     }
 409     return $value;
 410   }
 411
 412   /**
 413    * Allow setting some dompdf options.
 414    *
 415    * We don't support all the available dompdf options.
 416    *
 417    * @return \Dompdf\Options
 418    */
 419   private static function getDompdfOptions(): Options {
 420     $options = new Options();
 421     $settings = [
 422       // CRM-12165 - Remote file support required for image handling so default to TRUE
 423       'enable_remote' => \Civi::settings()->get('dompdf_enable_remote') ?? TRUE,
 424     ];
 425     // only set these ones if a setting exists for them
 426     foreach (['font_dir', 'chroot', 'log_output_file'] as $setting) {
 427       $value = \Civi::settings()->get("dompdf_$setting");
 428       if (isset($value)) {
 429         $settings[$setting] = $value;
 430       }
 431     }
 432     $options->set($settings);
 433     return $options;
 434   }
 435
 436 }