CRM/Contact/Form/Task/PDFLetterCommon.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  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class provides the common functionality for creating PDF letter for one or a group of contact ids.
  20  */
  21 class CRM_Contact_Form_Task_PDFLetterCommon extends CRM_Core_Form_Task_PDFLetterCommon {
  22
  23   protected static $tokenCategories;
  24
  25   /**
  26    * @return array
  27    *   Array(string $machineName => string $label).
  28    */
  29   public static function getLoggingOptions() {
  30     return [
  31       'none' => ts('Do not record'),
  32       'multiple' => ts('Multiple activities (one per contact)'),
  33       'combined' => ts('One combined activity'),
  34       'combined-attached' => ts('One combined activity plus one file attachment'),
  35       // 'multiple-attached' <== not worth the work
  36     ];
  37   }
  38
  39   /**
  40    * Build all the data structures needed to build the form.
  41    *
  42    * @param CRM_Core_Form $form
  43    */
  44   public static function preProcess(&$form) {
  45     CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($form);
  46     $messageText = [];
  47     $messageSubject = [];
  48     $dao = new CRM_Core_BAO_MessageTemplate();
  49     $dao->is_active = 1;
  50     $dao->find();
  51     while ($dao->fetch()) {
  52       $messageText[$dao->id] = $dao->msg_text;
  53       $messageSubject[$dao->id] = $dao->msg_subject;
  54     }
  55
  56     $form->assign('message', $messageText);
  57     $form->assign('messageSubject', $messageSubject);
  58     parent::preProcess($form);
  59   }
  60
  61   /**
  62    * @param CRM_Core_Form $form
  63    * @param int $cid
  64    */
  65   public static function preProcessSingle(&$form, $cid) {
  66     $form->_contactIds = explode(',', $cid);
  67     // put contact display name in title for single contact mode
  68     if (count($form->_contactIds) === 1) {
  69       CRM_Utils_System::setTitle(ts('Print/Merge Document for %1', [1 => CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name')]));
  70     }
  71   }
  72
  73   /**
  74    * Part of the post process which prepare and extract information from the template.
  75    *
  76    *
  77    * @param array $formValues
  78    *
  79    * @return array
  80    *   [$categories, $html_message, $messageToken, $returnProperties]
  81    */
  82   public static function processMessageTemplate($formValues) {
  83     $html_message = self::processTemplate($formValues);
  84
  85     $categories = self::getTokenCategories();
  86
  87     //time being hack to strip '&nbsp;'
  88     //from particular letter line, CRM-6798
  89     self::formatMessage($html_message);
  90
  91     $messageToken = CRM_Utils_Token::getTokens($html_message);
  92
  93     $returnProperties = [];
  94     if (isset($messageToken['contact'])) {
  95       foreach ($messageToken['contact'] as $key => $value) {
  96         $returnProperties[$value] = 1;
  97       }
  98     }
  99
 100     return [$formValues, $categories, $html_message, $messageToken, $returnProperties];
 101   }
 102
 103   /**
 104    * Process the form after the input has been submitted and validated.
 105    *
 106    * @param CRM_Core_Form $form
 107    *
 108    * @throws \CRM_Core_Exception
 109    */
 110   public static function postProcess(&$form) {
 111     $formValues = $form->controller->exportValues($form->getName());
 112     list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self::processMessageTemplate($formValues);
 113     $skipOnHold = isset($form->skipOnHold) ? $form->skipOnHold : FALSE;
 114     $skipDeceased = isset($form->skipDeceased) ? $form->skipDeceased : TRUE;
 115     $html = $activityIds = [];
 116
 117     // CRM-16725 Skip creation of activities if user is previewing their PDF letter(s)
 118     if (self::isLiveMode($form)) {
 119       $activityIds = self::createActivities($form, $html_message, $form->_contactIds, $formValues['subject'], CRM_Utils_Array::value('campaign_id', $formValues));
 120     }
 121
 122     if (!empty($formValues['document_file_path'])) {
 123       list($html_message, $zip) = CRM_Utils_PDF_Document::unzipDoc($formValues['document_file_path'], $formValues['document_type']);
 124     }
 125
 126     foreach ($form->_contactIds as $item => $contactId) {
 127       $caseId = NULL;
 128       $params = ['contact_id' => $contactId];
 129
 130       list($contact) = CRM_Utils_Token::getTokenDetails($params,
 131         $returnProperties,
 132         $skipOnHold,
 133         $skipDeceased,
 134         NULL,
 135         $messageToken,
 136         'CRM_Contact_Form_Task_PDFLetterCommon'
 137       );
 138
 139       if (civicrm_error($contact)) {
 140         $notSent[] = $contactId;
 141         continue;
 142       }
 143
 144       $tokenHtml = CRM_Utils_Token::replaceContactTokens($html_message, $contact[$contactId], TRUE, $messageToken);
 145       if (!empty($form->_caseId)) {
 146         $caseId = $form->_caseId;
 147       }
 148       if (empty($caseId) && !empty($form->_caseIds[$item])) {
 149         $caseId = $form->_caseIds[$item];
 150       }
 151       if ($caseId) {
 152         $tokenHtml = CRM_Utils_Token::replaceCaseTokens($caseId, $tokenHtml, $messageToken);
 153       }
 154       $tokenHtml = CRM_Utils_Token::replaceHookTokens($tokenHtml, $contact[$contactId], $categories, TRUE);
 155
 156       if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
 157         $smarty = CRM_Core_Smarty::singleton();
 158         // also add the contact tokens to the template
 159         $smarty->assign_by_ref('contact', $contact);
 160         $tokenHtml = $smarty->fetch("string:$tokenHtml");
 161       }
 162
 163       $html[] = $tokenHtml;
 164     }
 165
 166     $tee = NULL;
 167     if (self::isLiveMode($form) && Civi::settings()->get('recordGeneratedLetters') === 'combined-attached') {
 168       if (count($activityIds) !== 1) {
 169         throw new CRM_Core_Exception("When recordGeneratedLetters=combined-attached, there should only be one activity.");
 170       }
 171       $tee = CRM_Utils_ConsoleTee::create()->start();
 172     }
 173
 174     $type = $formValues['document_type'];
 175     $mimeType = self::getMimeType($type);
 176     // ^^ Useful side-effect: consistently throws error for unrecognized types.
 177
 178     if ($type == 'pdf') {
 179       $fileName = "CiviLetter.$type";
 180       CRM_Utils_PDF_Utils::html2pdf($html, $fileName, FALSE, $formValues);
 181     }
 182     elseif (!empty($formValues['document_file_path'])) {
 183       $fileName = pathinfo($formValues['document_file_path'], PATHINFO_FILENAME) . '.' . $type;
 184       CRM_Utils_PDF_Document::printDocuments($html, $fileName, $type, $zip);
 185     }
 186     else {
 187       $fileName = "CiviLetter.$type";
 188       CRM_Utils_PDF_Document::html2doc($html, $fileName, $formValues);
 189     }
 190
 191     if ($tee) {
 192       $tee->stop();
 193       $content = file_get_contents($tee->getFileName(), NULL, NULL, NULL, 5);
 194       if (empty($content)) {
 195         throw new \CRM_Core_Exception("Failed to capture document content (type=$type)!");
 196       }
 197       foreach ($activityIds as $activityId) {
 198         civicrm_api3('Attachment', 'create', [
 199           'entity_table' => 'civicrm_activity',
 200           'entity_id' => $activityId,
 201           'name' => $fileName,
 202           'mime_type' => $mimeType,
 203           'options' => [
 204             'move-file' => $tee->getFileName(),
 205           ],
 206         ]);
 207       }
 208     }
 209
 210     $form->postProcessHook();
 211
 212     CRM_Utils_System::civiExit();
 213   }
 214
 215   /**
 216    * @param CRM_Core_Form $form
 217    * @param string $html_message
 218    * @param array $contactIds
 219    * @param string $subject
 220    * @param int $campaign_id
 221    * @param array $perContactHtml
 222    *
 223    * @return array
 224    *   List of activity IDs.
 225    *   There may be 1 or more, depending on the system-settings
 226    *   and use-case.
 227    *
 228    * @throws CRM_Core_Exception
 229    */
 230   public static function createActivities($form, $html_message, $contactIds, $subject, $campaign_id, $perContactHtml = []) {
 231
 232     $activityParams = [
 233       'subject' => $subject,
 234       'campaign_id' => $campaign_id,
 235       'source_contact_id' => CRM_Core_Session::singleton()->getLoggedInContactID(),
 236       'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Print PDF Letter'),
 237       'activity_date_time' => date('YmdHis'),
 238       'details' => $html_message,
 239     ];
 240     if (!empty($form->_activityId)) {
 241       $activityParams += ['id' => $form->_activityId];
 242     }
 243
 244     $activityIds = [];
 245     switch (Civi::settings()->get('recordGeneratedLetters')) {
 246       case 'none':
 247         return [];
 248
 249       case 'multiple':
 250         // One activity per contact.
 251         foreach ($contactIds as $i => $contactId) {
 252           $fullParams = [
 253             'target_contact_id' => $contactId,
 254           ] + $activityParams;
 255           if (!empty($form->_caseId)) {
 256             $fullParams['case_id'] = $form->_caseId;
 257           }
 258           elseif (!empty($form->_caseIds[$i])) {
 259             $fullParams['case_id'] = $form->_caseIds[$i];
 260           }
 261
 262           if (isset($perContactHtml[$contactId])) {
 263             $fullParams['details'] = implode('<hr>', $perContactHtml[$contactId]);
 264           }
 265           $activity = civicrm_api3('Activity', 'create', $fullParams);
 266           $activityIds[$contactId] = $activity['id'];
 267         }
 268
 269         break;
 270
 271       case 'combined':
 272       case 'combined-attached':
 273         // One activity with all contacts.
 274         $fullParams = [
 275           'target_contact_id' => $contactIds,
 276         ] + $activityParams;
 277         if (!empty($form->_caseId)) {
 278           $fullParams['case_id'] = $form->_caseId;
 279         }
 280         elseif (!empty($form->_caseIds)) {
 281           $fullParams['case_id'] = $form->_caseIds;
 282         }
 283         $activity = civicrm_api3('Activity', 'create', $fullParams);
 284         $activityIds[] = $activity['id'];
 285         break;
 286
 287       default:
 288         throw new CRM_Core_Exception("Unrecognized option in recordGeneratedLetters: " . Civi::settings()->get('recordGeneratedLetters'));
 289     }
 290
 291     return $activityIds;
 292   }
 293
 294   /**
 295    * Convert from a vague-type/file-extension to mime-type.
 296    *
 297    * @param string $type
 298    * @return string
 299    * @throws \CRM_Core_Exception
 300    */
 301   private static function getMimeType($type) {
 302     $mimeTypes = [
 303       'pdf' => 'application/pdf',
 304       'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
 305       'odt' => 'application/vnd.oasis.opendocument.text',
 306       'html' => 'text/html',
 307     ];
 308     if (isset($mimeTypes[$type])) {
 309       return $mimeTypes[$type];
 310     }
 311     else {
 312       throw new \CRM_Core_Exception("Cannot determine mime type");
 313     }
 314   }
 315
 316   /**
 317    * Get the categories required for rendering tokens.
 318    *
 319    * @return array
 320    */
 321   protected static function getTokenCategories() {
 322     if (!isset(Civi::$statics[__CLASS__]['token_categories'])) {
 323       $tokens = [];
 324       CRM_Utils_Hook::tokens($tokens);
 325       Civi::$statics[__CLASS__]['token_categories'] = array_keys($tokens);
 326     }
 327     return Civi::$statics[__CLASS__]['token_categories'];
 328   }
 329
 330   /**
 331    * Is the form in live mode (as opposed to being run as a preview).
 332    *
 333    * Returns true if the user has clicked the Download Document button on a
 334    * Print/Merge Document (PDF Letter) search task form, or false if the Preview
 335    * button was clicked.
 336    *
 337    * @param CRM_Core_Form $form
 338    *
 339    * @return bool
 340    *   TRUE if the Download Document button was clicked (also defaults to TRUE
 341    *     if the form controller does not exist), else FALSE
 342    */
 343   protected static function isLiveMode($form) {
 344     // CRM-21255 - Hrm, CiviCase 4+5 seem to report buttons differently...
 345     $buttonName = $form->controller->getButtonName();
 346     $c = $form->controller->container();
 347     $isLiveMode = ($buttonName == '_qf_PDF_upload') || isset($c['values']['PDF']['buttons']['_qf_PDF_upload']);
 348     return $isLiveMode;
 349   }
 350
 351 }