CRM/Contribute/Form/Task/PDFLetterCommon.php

   1 <?php
   2
   3 /**
   4  * This class provides the common functionality for creating PDF letter for
   5  * one or a group of contact ids.
   6  */
   7 class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLetterCommon {
   8
   9   /**
  10    * Build the form object.
  11    *
  12    * @var CRM_Core_Form $form
  13    */
  14   public static function buildQuickForm(&$form) {
  15     // use contact form as a base
  16     CRM_Contact_Form_Task_PDFLetterCommon::buildQuickForm($form);
  17
  18     // Contribute PDF tasks allow you to email as well, so we need to add email address to those forms
  19     $form->add('select', 'from_email_address', ts('From Email Address'), $form->_fromEmails, TRUE);
  20     parent::buildQuickForm($form);
  21   }
  22
  23   /**
  24    * Process the form after the input has been submitted and validated.
  25    *
  26    * @param CRM_Contribute_Form_Task $form
  27    * @param array $formValues
  28    */
  29   public static function postProcess(&$form, $formValues = NULL) {
  30     if (empty($formValues)) {
  31       $formValues = $form->controller->exportValues($form->getName());
  32     }
  33     list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self::processMessageTemplate($formValues);
  34     $isPDF = FALSE;
  35     $emailParams = [];
  36     if (!empty($formValues['email_options'])) {
  37       $returnProperties['email'] = $returnProperties['on_hold'] = $returnProperties['is_deceased'] = $returnProperties['do_not_email'] = 1;
  38       $emailParams = [
  39         'subject' => $formValues['subject'] ?? NULL,
  40         'from' => $formValues['from_email_address'] ?? NULL,
  41       ];
  42
  43       $emailParams['from'] = CRM_Utils_Mail::formatFromAddress($emailParams['from']);
  44
  45       // We need display_name for emailLetter() so add to returnProperties here
  46       $returnProperties['display_name'] = 1;
  47       if (stristr($formValues['email_options'], 'pdfemail')) {
  48         $isPDF = TRUE;
  49       }
  50     }
  51     // update dates ?
  52     $receipt_update = $formValues['receipt_update'] ?? FALSE;
  53     $thankyou_update = $formValues['thankyou_update'] ?? FALSE;
  54     $nowDate = date('YmdHis');
  55     $receipts = $thanks = $emailed = 0;
  56     $updateStatus = '';
  57     $task = 'CRM_Contribution_Form_Task_PDFLetterCommon';
  58     $realSeparator = ', ';
  59     $tableSeparators = [
  60       'td' => '</td><td>',
  61       'tr' => '</td></tr><tr><td>',
  62     ];
  63     //the original thinking was mutliple options - but we are going with only 2 (comma & td) for now in case
  64     // there are security (& UI) issues we need to think through
  65     if (isset($formValues['group_by_separator'])) {
  66       if (in_array($formValues['group_by_separator'], ['td', 'tr'])) {
  67         $realSeparator = $tableSeparators[$formValues['group_by_separator']];
  68       }
  69       elseif ($formValues['group_by_separator'] == 'br') {
  70         $realSeparator = "<br />";
  71       }
  72     }
  73     // a placeholder in case the separator is common in the string - e.g ', '
  74     $separator = '****~~~~';
  75     $groupBy = $formValues['group_by'];
  76
  77     // skip some contacts ?
  78     $skipOnHold = $form->skipOnHold ?? FALSE;
  79     $skipDeceased = $form->skipDeceased ?? TRUE;
  80     $contributionIDs = $form->getVar('_contributionIds');
  81     if ($form->_includesSoftCredits) {
  82       //@todo - comment on what is stored there
  83       $contributionIDs = $form->getVar('_contributionContactIds');
  84     }
  85     list($contributions, $contacts) = self::buildContributionArray($groupBy, $contributionIDs, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $task, $separator, $form->_includesSoftCredits);
  86     $html = [];
  87     $contactHtml = $emailedHtml = [];
  88     foreach ($contributions as $contributionId => $contribution) {
  89       $contact = &$contacts[$contribution['contact_id']];
  90       $grouped = FALSE;
  91       $groupByID = 0;
  92       if ($groupBy) {
  93         $groupByID = empty($contribution[$groupBy]) ? 0 : $contribution[$groupBy];
  94         $contribution = $contact['combined'][$groupBy][$groupByID];
  95         $grouped = TRUE;
  96       }
  97
  98       if (empty($groupBy) || empty($contact['is_sent'][$groupBy][$groupByID])) {
  99         $html[$contributionId] = self::generateHtml($contact, $contribution, $groupBy, $contributions, $realSeparator, $tableSeparators, $messageToken, $html_message, $separator, $grouped, $groupByID);
 100         $contactHtml[$contact['contact_id']][] = $html[$contributionId];
 101         if (!empty($formValues['email_options'])) {
 102           if (self::emailLetter($contact, $html[$contributionId], $isPDF, $formValues, $emailParams)) {
 103             $emailed++;
 104             if (!stristr($formValues['email_options'], 'both')) {
 105               $emailedHtml[$contributionId] = TRUE;
 106             }
 107           }
 108         }
 109         $contact['is_sent'][$groupBy][$groupByID] = TRUE;
 110       }
 111       // Update receipt/thankyou dates
 112       $contributionParams = ['id' => $contributionId];
 113       if ($receipt_update) {
 114         $contributionParams['receipt_date'] = $nowDate;
 115       }
 116       if ($thankyou_update) {
 117         $contributionParams['thankyou_date'] = $nowDate;
 118       }
 119       if ($receipt_update || $thankyou_update) {
 120         civicrm_api3('Contribution', 'create', $contributionParams);
 121         $receipts = ($receipt_update ? $receipts + 1 : $receipts);
 122         $thanks = ($thankyou_update ? $thanks + 1 : $thanks);
 123       }
 124     }
 125
 126     $contactIds = array_keys($contacts);
 127     self::createActivities($form, $html_message, $contactIds, CRM_Utils_Array::value('subject', $formValues, ts('Thank you letter')), CRM_Utils_Array::value('campaign_id', $formValues), $contactHtml);
 128     $html = array_diff_key($html, $emailedHtml);
 129
 130     if (!empty($formValues['is_unit_test'])) {
 131       return $html;
 132     }
 133
 134     //CRM-19761
 135     if (!empty($html)) {
 136       $type = $formValues['document_type'];
 137
 138       if ($type == 'pdf') {
 139         CRM_Utils_PDF_Utils::html2pdf($html, "CiviLetter.pdf", FALSE, $formValues);
 140       }
 141       else {
 142         CRM_Utils_PDF_Document::html2doc($html, "CiviLetter.$type", $formValues);
 143       }
 144     }
 145
 146     $form->postProcessHook();
 147
 148     if ($emailed) {
 149       $updateStatus = ts('Receipts have been emailed to %1 contributions.', [1 => $emailed]);
 150     }
 151     if ($receipts) {
 152       $updateStatus = ts('Receipt date has been updated for %1 contributions.', [1 => $receipts]);
 153     }
 154     if ($thanks) {
 155       $updateStatus .= ' ' . ts('Thank-you date has been updated for %1 contributions.', [1 => $thanks]);
 156     }
 157
 158     if ($updateStatus) {
 159       CRM_Core_Session::setStatus($updateStatus);
 160     }
 161     if (!empty($html)) {
 162       // ie. we have only sent emails - lets no show a white screen
 163       CRM_Utils_System::civiExit();
 164     }
 165   }
 166
 167   /**
 168    * Check whether any of the tokens exist in the html outside a table cell.
 169    * If they do the table cell separator is not supported (return false)
 170    * At this stage we are only anticipating contributions passed in this way but
 171    * it would be easy to add others
 172    * @param $tokens
 173    * @param $html
 174    *
 175    * @return bool
 176    */
 177   public static function isValidHTMLWithTableSeparator($tokens, $html) {
 178     $relevantEntities = ['contribution'];
 179     foreach ($relevantEntities as $entity) {
 180       if (isset($tokens[$entity]) && is_array($tokens[$entity])) {
 181         foreach ($tokens[$entity] as $token) {
 182           if (!self::isHtmlTokenInTableCell($token, $entity, $html)) {
 183             return FALSE;
 184           }
 185         }
 186       }
 187     }
 188     return TRUE;
 189   }
 190
 191   /**
 192    * Check that the token only appears in a table cell. The '</td><td>' separator cannot otherwise work
 193    * Calculate the number of times it appears IN the cell & the number of times it appears - should be the same!
 194    *
 195    * @param string $token
 196    * @param string $entity
 197    * @param string $textToSearch
 198    *
 199    * @return bool
 200    */
 201   public static function isHtmlTokenInTableCell($token, $entity, $textToSearch) {
 202     $tokenToMatch = $entity . '\.' . $token;
 203     $pattern = '|<td(?![\w-])((?!</td>).)*\{' . $tokenToMatch . '\}.*?</td>|si';
 204     $within = preg_match_all($pattern, $textToSearch);
 205     $total = preg_match_all("|{" . $tokenToMatch . "}|", $textToSearch);
 206     return ($within == $total);
 207   }
 208
 209   /**
 210    *
 211    * @param string $html_message
 212    * @param array $contact
 213    * @param array $contribution
 214    * @param array $messageToken
 215    * @param bool $grouped
 216    *   Does this letter represent more than one contribution.
 217    * @param string $separator
 218    *   What is the preferred letter separator.
 219    * @return string
 220    */
 221   private static function resolveTokens($html_message, $contact, $contribution, $messageToken, $grouped, $separator) {
 222     $categories = self::getTokenCategories();
 223     $domain = CRM_Core_BAO_Domain::getDomain();
 224     $tokenHtml = CRM_Utils_Token::replaceDomainTokens($html_message, $domain, TRUE, $messageToken);
 225     $tokenHtml = CRM_Utils_Token::replaceContactTokens($tokenHtml, $contact, TRUE, $messageToken);
 226     if ($grouped) {
 227       $tokenHtml = CRM_Utils_Token::replaceMultipleContributionTokens($separator, $tokenHtml, $contribution, TRUE, $messageToken);
 228     }
 229     else {
 230       // no change to normal behaviour to avoid risk of breakage
 231       $tokenHtml = CRM_Utils_Token::replaceContributionTokens($tokenHtml, $contribution, TRUE, $messageToken);
 232     }
 233     $tokenHtml = CRM_Utils_Token::replaceHookTokens($tokenHtml, $contact, $categories, TRUE);
 234     if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
 235       $smarty = CRM_Core_Smarty::singleton();
 236       // also add the tokens to the template
 237       $smarty->assign_by_ref('contact', $contact);
 238       $tokenHtml = $smarty->fetch("string:$tokenHtml");
 239     }
 240     return $tokenHtml;
 241   }
 242
 243   /**
 244    * Generate the contribution array from the form, we fill in the contact details and determine any aggregation
 245    * around contact_id of contribution_recur_id
 246    *
 247    * @param string $groupBy
 248    * @param array $contributionIDs
 249    * @param array $returnProperties
 250    * @param bool $skipOnHold
 251    * @param bool $skipDeceased
 252    * @param array $messageToken
 253    * @param string $task
 254    * @param string $separator
 255    * @param bool $isIncludeSoftCredits
 256    *
 257    * @return array
 258    */
 259   public static function buildContributionArray($groupBy, $contributionIDs, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $task, $separator, $isIncludeSoftCredits) {
 260     $contributions = $contacts = [];
 261     foreach ($contributionIDs as $item => $contributionId) {
 262       $contribution = CRM_Contribute_BAO_Contribution::getContributionTokenValues($contributionId, $messageToken)['values'][$contributionId];
 263       $contribution['campaign'] = $contribution['contribution_campaign_title'] ?? NULL;
 264       $contributions[$contributionId] = $contribution;
 265
 266       if ($isIncludeSoftCredits) {
 267         //@todo find out why this happens & add comments
 268         list($contactID) = explode('-', $item);
 269         $contactID = (int) $contactID;
 270       }
 271       else {
 272         $contactID = $contribution['contact_id'];
 273       }
 274       if (!isset($contacts[$contactID])) {
 275         $contacts[$contactID] = [];
 276         $contacts[$contactID]['contact_aggregate'] = 0;
 277         $contacts[$contactID]['combined'] = $contacts[$contactID]['contribution_ids'] = [];
 278       }
 279
 280       $contacts[$contactID]['contact_aggregate'] += $contribution['total_amount'];
 281       $groupByID = empty($contribution[$groupBy]) ? 0 : $contribution[$groupBy];
 282
 283       $contacts[$contactID]['contribution_ids'][$groupBy][$groupByID][$contributionId] = TRUE;
 284       if (!isset($contacts[$contactID]['combined'][$groupBy]) || !isset($contacts[$contactID]['combined'][$groupBy][$groupByID])) {
 285         $contacts[$contactID]['combined'][$groupBy][$groupByID] = $contribution;
 286         $contacts[$contactID]['aggregates'][$groupBy][$groupByID] = $contribution['total_amount'];
 287       }
 288       else {
 289         $contacts[$contactID]['combined'][$groupBy][$groupByID] = self::combineContributions($contacts[$contactID]['combined'][$groupBy][$groupByID], $contribution, $separator);
 290         $contacts[$contactID]['aggregates'][$groupBy][$groupByID] += $contribution['total_amount'];
 291       }
 292     }
 293     // Assign the available contributions before calling tokens so hooks parsing smarty can access it.
 294     // Note that in core code you can only use smarty here if enable if for the whole site, incl
 295     // CiviMail, with a big performance impact.
 296     // Hooks allow more nuanced smarty usage here.
 297     CRM_Core_Smarty::singleton()->assign('contributions', $contributions);
 298     foreach ($contacts as $contactID => $contact) {
 299       $tokenResolvedContacts = CRM_Utils_Token::getTokenDetails(['contact_id' => $contactID],
 300         $returnProperties,
 301         $skipOnHold,
 302         $skipDeceased,
 303         NULL,
 304         $messageToken,
 305         $task
 306       );
 307       $contacts[$contactID] = array_merge($tokenResolvedContacts[0][$contactID], $contact);
 308     }
 309     return [$contributions, $contacts];
 310   }
 311
 312   /**
 313    * We combine the contributions by adding the contribution to each field with the separator in
 314    * between the existing value and the new one. We put the separator there even if empty so it is clear what the
 315    * value for previous contributions was
 316    *
 317    * @param array $existing
 318    * @param array $contribution
 319    * @param string $separator
 320    *
 321    * @return array
 322    */
 323   public static function combineContributions($existing, $contribution, $separator) {
 324     foreach ($contribution as $field => $value) {
 325       $existing[$field] = isset($existing[$field]) ? $existing[$field] . $separator : '';
 326       $existing[$field] .= $value;
 327     }
 328     return $existing;
 329   }
 330
 331   /**
 332    * We are going to retrieve the combined contribution and if smarty mail is enabled we
 333    * will also assign an array of contributions for this contact to the smarty template
 334    *
 335    * @param array $contact
 336    * @param array $contributions
 337    * @param $groupBy
 338    * @param int $groupByID
 339    */
 340   public static function assignCombinedContributionValues($contact, $contributions, $groupBy, $groupByID) {
 341     CRM_Core_Smarty::singleton()->assign('contact_aggregate', $contact['contact_aggregate']);
 342     CRM_Core_Smarty::singleton()
 343       ->assign('contributions', array_intersect_key($contributions, $contact['contribution_ids'][$groupBy][$groupByID]));
 344     CRM_Core_Smarty::singleton()->assign('contribution_aggregate', $contact['aggregates'][$groupBy][$groupByID]);
 345
 346   }
 347
 348   /**
 349    * Send pdf by email.
 350    *
 351    * @param array $contact
 352    * @param string $html
 353    *
 354    * @param $is_pdf
 355    * @param array $format
 356    * @param array $params
 357    *
 358    * @return bool
 359    */
 360   public static function emailLetter($contact, $html, $is_pdf, $format = [], $params = []) {
 361     try {
 362       if (empty($contact['email'])) {
 363         return FALSE;
 364       }
 365       $mustBeEmpty = ['do_not_email', 'is_deceased', 'on_hold'];
 366       foreach ($mustBeEmpty as $emptyField) {
 367         if (!empty($contact[$emptyField])) {
 368           return FALSE;
 369         }
 370       }
 371
 372       $defaults = [
 373         'toName' => $contact['display_name'],
 374         'toEmail' => $contact['email'],
 375         'text' => '',
 376         'html' => $html,
 377       ];
 378       if (empty($params['from'])) {
 379         $emails = CRM_Core_BAO_Email::getFromEmail();
 380         $emails = array_keys($emails);
 381         $defaults['from'] = array_pop($emails);
 382       }
 383       else {
 384         $defaults['from'] = $params['from'];
 385       }
 386       if (!empty($params['subject'])) {
 387         $defaults['subject'] = $params['subject'];
 388       }
 389       else {
 390         $defaults['subject'] = ts('Thank you for your contribution/s');
 391       }
 392       if ($is_pdf) {
 393         $defaults['html'] = ts('Please see attached');
 394         $defaults['attachments'] = [CRM_Utils_Mail::appendPDF('ThankYou.pdf', $html, $format)];
 395       }
 396       $params = array_merge($defaults);
 397       return CRM_Utils_Mail::send($params);
 398     }
 399     catch (CRM_Core_Exception $e) {
 400       return FALSE;
 401     }
 402   }
 403
 404   /**
 405    * @param $contact
 406    * @param $formValues
 407    * @param $contribution
 408    * @param $groupBy
 409    * @param $contributions
 410    * @param $realSeparator
 411    * @param $tableSeparators
 412    * @param $messageToken
 413    * @param $html_message
 414    * @param $separator
 415    * @param $categories
 416    * @param bool $grouped
 417    * @param int $groupByID
 418    *
 419    * @return string
 420    */
 421   protected static function generateHtml(&$contact, $contribution, $groupBy, $contributions, $realSeparator, $tableSeparators, $messageToken, $html_message, $separator, $grouped, $groupByID) {
 422     static $validated = FALSE;
 423     $html = NULL;
 424
 425     self::assignCombinedContributionValues($contact, $contributions, $groupBy, $groupByID);
 426
 427     if (empty($groupBy) || empty($contact['is_sent'][$groupBy][$groupByID])) {
 428       if (!$validated && in_array($realSeparator, $tableSeparators) && !self::isValidHTMLWithTableSeparator($messageToken, $html_message)) {
 429         $realSeparator = ', ';
 430         CRM_Core_Session::setStatus(ts('You have selected the table cell separator, but one or more token fields are not placed inside a table cell. This would result in invalid HTML, so comma separators have been used instead.'));
 431       }
 432       $validated = TRUE;
 433       $html = str_replace($separator, $realSeparator, self::resolveTokens($html_message, $contact, $contribution, $messageToken, $grouped, $separator));
 434     }
 435
 436     return $html;
 437   }
 438
 439 }