3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
18 use Civi\Api4\MessageTemplate
;
20 require_once 'Mail/mime.php';
23 * Class CRM_Core_BAO_MessageTemplate.
25 class CRM_Core_BAO_MessageTemplate
extends CRM_Core_DAO_MessageTemplate
{
28 * Fetch object based on array of properties.
30 * @param array $params
31 * (reference ) an assoc array of name/value pairs.
32 * @param array $defaults
33 * (reference ) an assoc array to hold the flattened values.
35 * @return CRM_Core_DAO_MessageTemplate
37 public static function retrieve(&$params, &$defaults) {
38 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
39 $messageTemplates->copyValues($params);
40 if ($messageTemplates->find(TRUE)) {
41 CRM_Core_DAO
::storeValues($messageTemplates, $defaults);
42 return $messageTemplates;
48 * Update the is_active flag in the db.
51 * Id of the database record.
52 * @param bool $is_active
53 * Value we want to set the is_active field.
56 * true if we found and updated the object, else false
58 public static function setIsActive($id, $is_active) {
59 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_MessageTemplate', $id, 'is_active', $is_active);
63 * Add the Message Templates.
65 * @param array $params
66 * Reference array contains the values submitted by the form.
70 * @throws \CiviCRM_API3_Exception
71 * @throws \Civi\API\Exception\UnauthorizedException
73 public static function add(&$params) {
74 // System Workflow Templates have a specific wodkflow_id in them but normal user end message templates don't
75 // If we have an id check to see if we are update, and need to check if original is a system workflow or not.
76 $systemWorkflowPermissionDeniedMessage = 'Editing or creating system workflow messages requires edit system workflow message templates permission or the edit message templates permission';
77 $userWorkflowPermissionDeniedMessage = 'Editing or creating user driven workflow messages requires edit user-driven message templates or the edit message templates permission';
78 if (!empty($params['check_permissions'])) {
79 if (!CRM_Core_Permission
::check('edit message templates')) {
80 if (!empty($params['id'])) {
81 $details = civicrm_api3('MessageTemplate', 'getSingle', ['id' => $params['id']]);
82 if (!empty($details['workflow_id']) ||
!empty($details['workflow_name'])) {
83 if (!CRM_Core_Permission
::check('edit system workflow message templates')) {
84 throw new \Civi\API\Exception\
UnauthorizedException(ts('%1', [1 => $systemWorkflowPermissionDeniedMessage]));
87 elseif (!CRM_Core_Permission
::check('edit user-driven message templates')) {
88 throw new \Civi\API\Exception\
UnauthorizedException(ts('%1', [1 => $userWorkflowPermissionDeniedMessage]));
92 if (!empty($params['workflow_id']) ||
!empty($params['workflow_name'])) {
93 if (!CRM_Core_Permission
::check('edit system workflow message templates')) {
94 throw new \Civi\API\Exception\
UnauthorizedException(ts('%1', [1 => $systemWorkflowPermissionDeniedMessage]));
97 elseif (!CRM_Core_Permission
::check('edit user-driven message templates')) {
98 throw new \Civi\API\Exception\
UnauthorizedException(ts('%1', [1 => $userWorkflowPermissionDeniedMessage]));
103 $hook = empty($params['id']) ?
'create' : 'edit';
104 CRM_Utils_Hook
::pre($hook, 'MessageTemplate', CRM_Utils_Array
::value('id', $params), $params);
106 if (!empty($params['file_id']) && is_array($params['file_id']) && count($params['file_id'])) {
107 $fileParams = $params['file_id'];
108 unset($params['file_id']);
111 // The workflow_id and workflow_name should be sync'd. But what mix of inputs do we have to work with?
112 switch ((empty($params['workflow_id']) ?
'' : 'id') . (empty($params['workflow_name']) ?
'' : 'name')) {
114 $params['workflow_name'] = array_search($params['workflow_id'], self
::getWorkflowNameIdMap());
118 $params['workflow_id'] = self
::getWorkflowNameIdMap()[$params['workflow_name']] ??
NULL;
122 $map = self
::getWorkflowNameIdMap();
123 if ($map[$params['workflow_name']] != $params['workflow_id']) {
124 throw new CRM_Core_Exception("The workflow_id and workflow_name are mismatched. Note: You only need to submit one or the other.");
133 throw new \
RuntimeException("Bad code");
136 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
137 $messageTemplates->copyValues($params);
138 $messageTemplates->save();
140 if (!empty($fileParams)) {
141 $params['file_id'] = $fileParams;
142 CRM_Core_BAO_File
::filePostProcess(
143 $params['file_id']['location'],
145 'civicrm_msg_template',
146 $messageTemplates->id
,
151 $params['file_id']['type']
155 CRM_Utils_Hook
::post($hook, 'MessageTemplate', $messageTemplates->id
, $messageTemplates);
156 return $messageTemplates;
160 * Delete the Message Templates.
162 * @param int $messageTemplatesID
164 * @throws \CRM_Core_Exception
166 public static function del($messageTemplatesID) {
167 // make sure messageTemplatesID is an integer
168 if (!CRM_Utils_Rule
::positiveInteger($messageTemplatesID)) {
169 throw new CRM_Core_Exception(ts('Invalid Message template'));
172 // Set mailing msg template col to NULL
173 $query = "UPDATE civicrm_mailing
174 SET msg_template_id = NULL
175 WHERE msg_template_id = %1";
177 $params = [1 => [$messageTemplatesID, 'Integer']];
178 CRM_Core_DAO
::executeQuery($query, $params);
180 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
181 $messageTemplates->id
= $messageTemplatesID;
182 $messageTemplates->delete();
183 CRM_Core_Session
::setStatus(ts('Selected message template has been deleted.'), ts('Deleted'), 'success');
187 * Get the Message Templates.
196 public static function getMessageTemplates($all = TRUE, $isSMS = FALSE) {
199 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
200 $messageTemplates->is_active
= 1;
201 $messageTemplates->is_sms
= $isSMS;
204 $messageTemplates->workflow_id
= 'NULL';
206 $messageTemplates->find();
207 while ($messageTemplates->fetch()) {
208 $msgTpls[$messageTemplates->id
] = $messageTemplates->msg_title
;
215 * @param int $contactId
217 * @param int $messageTemplateID
221 * @throws \CRM_Core_Exception
223 public static function sendReminder($contactId, $email, $messageTemplateID, $from) {
224 CRM_Core_Error
::deprecatedWarning('CRM_Core_BAO_MessageTemplate::sendReminder is deprecated and will be removed in a future version of CiviCRM');
226 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
227 $messageTemplates->id
= $messageTemplateID;
229 $domain = CRM_Core_BAO_Domain
::getDomain();
233 if ($messageTemplates->find(TRUE)) {
234 $body_text = $messageTemplates->msg_text
;
235 $body_html = $messageTemplates->msg_html
;
236 $body_subject = $messageTemplates->msg_subject
;
238 $body_text = CRM_Utils_String
::htmlToText($body_html);
241 $params = [['contact_id', '=', $contactId, 0, 0]];
242 [$contact] = CRM_Contact_BAO_Query
::apiQuery($params);
245 $contact = reset($contact);
247 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
253 // get tokens to be replaced
254 $tokens = array_merge(CRM_Utils_Token
::getTokens($body_text),
255 CRM_Utils_Token
::getTokens($body_html),
256 CRM_Utils_Token
::getTokens($body_subject));
258 // get replacement text for these tokens
259 $returnProperties = ["preferred_mail_format" => 1];
260 if (isset($tokens['contact'])) {
261 foreach ($tokens['contact'] as $key => $value) {
262 $returnProperties[$value] = 1;
265 [$details] = CRM_Utils_Token
::getTokenDetails([$contactId],
269 'CRM_Core_BAO_MessageTemplate');
270 $contact = reset($details);
274 CRM_Utils_Hook
::tokens($hookTokens);
275 $categories = array_keys($hookTokens);
277 // do replacements in text and html body
278 $type = ['html', 'text'];
279 foreach ($type as $key => $value) {
280 $bodyType = "body_{$value}";
282 CRM_Utils_Token
::replaceGreetingTokens($
$bodyType, NULL, $contact['contact_id']);
283 $
$bodyType = CRM_Utils_Token
::replaceDomainTokens($
$bodyType, $domain, TRUE, $tokens, TRUE);
284 $
$bodyType = CRM_Utils_Token
::replaceContactTokens($
$bodyType, $contact, FALSE, $tokens, FALSE, TRUE);
285 $
$bodyType = CRM_Utils_Token
::replaceComponentTokens($
$bodyType, $contact, $tokens, TRUE);
286 $
$bodyType = CRM_Utils_Token
::replaceHookTokens($
$bodyType, $contact, $categories, TRUE);
292 $smarty = CRM_Core_Smarty
::singleton();
297 $
$elem = $smarty->fetch("string:{$$elem}");
300 // do replacements in message subject
301 $messageSubject = CRM_Utils_Token
::replaceContactTokens($body_subject, $contact, FALSE, $tokens);
302 $messageSubject = CRM_Utils_Token
::replaceDomainTokens($messageSubject, $domain, TRUE, $tokens);
303 $messageSubject = CRM_Utils_Token
::replaceComponentTokens($messageSubject, $contact, $tokens, TRUE);
304 $messageSubject = CRM_Utils_Token
::replaceHookTokens($messageSubject, $contact, $categories, TRUE);
306 $messageSubject = $smarty->fetch("string:{$messageSubject}");
308 // set up the parameters for CRM_Utils_Mail::send
310 'groupName' => 'Scheduled Reminder Sender',
312 'toName' => $contact['display_name'],
314 'subject' => $messageSubject,
316 if (!$html ||
$contact['preferred_mail_format'] == 'Text' ||
317 $contact['preferred_mail_format'] == 'Both'
319 // render the & entities in text mode, so that the links work
320 $mailParams['text'] = str_replace('&', '&', $text);
322 if ($html && ($contact['preferred_mail_format'] == 'HTML' ||
323 $contact['preferred_mail_format'] == 'Both'
326 $mailParams['html'] = $html;
329 $result = CRM_Utils_Mail
::send($mailParams);
336 * Revert a message template to its default subject+text+HTML state.
338 * @param int $id id of the template
340 * @throws \CRM_Core_Exception
342 public static function revert($id) {
343 $diverted = new CRM_Core_BAO_MessageTemplate();
344 $diverted->id
= (int) $id;
347 if ($diverted->N
!= 1) {
348 throw new CRM_Core_Exception(ts('Did not find a message template with id of %1.', [1 => $id]));
351 $orig = new CRM_Core_BAO_MessageTemplate();
352 $orig->workflow_id
= $diverted->workflow_id
;
353 $orig->is_reserved
= 1;
357 throw new CRM_Core_Exception(ts('Message template with id of %1 does not have a default to revert to.', [1 => $id]));
360 $diverted->msg_subject
= $orig->msg_subject
;
361 $diverted->msg_text
= $orig->msg_text
;
362 $diverted->msg_html
= $orig->msg_html
;
363 $diverted->pdf_format_id
= is_null($orig->pdf_format_id
) ?
'null' : $orig->pdf_format_id
;
368 * Send an email from the specified template based on an array of params.
370 * @param array $params
371 * A string-keyed array of function params, see function body for details.
374 * Array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
375 * @throws \CRM_Core_Exception
376 * @throws \API_Exception
378 public static function sendTemplate($params) {
380 // option value name of the template
382 // ID of the template
383 'messageTemplateID' => NULL,
384 // contact id if contact tokens are to be replaced
386 // additional template params (other than the ones already set in the template singleton)
390 // the recipient’s name
392 // the recipient’s email - mail is sent only if set
398 // the Reply-To: header
401 'attachments' => NULL,
402 // whether this is a test email (and hence should include the test banner)
404 // filename of optional PDF version to add as attachment (do not include path)
405 'PDFFilename' => NULL,
407 'disableSmarty' => FALSE,
409 $params = array_merge($defaults, $params);
411 // Core#644 - handle Email ID passed as "From".
412 if (isset($params['from'])) {
413 $params['from'] = CRM_Utils_Mail
::formatFromAddress($params['from']);
416 CRM_Utils_Hook
::alterMailParams($params, 'messageTemplate');
417 if (!is_int($params['messageTemplateID']) && !is_null($params['messageTemplateID'])) {
418 CRM_Core_Error
::deprecatedWarning('message template id should be an integer');
419 $params['messageTemplateID'] = (int) $params['messageTemplateID'];
421 $mailContent = self
::loadTemplate((string) $params['valueName'], $params['isTest'], $params['messageTemplateID'] ??
NULL, $params['groupName'] ??
'');
423 // Overwrite subject from form field
424 if (!empty($params['subject'])) {
425 $mailContent['subject'] = $params['subject'];
428 $mailContent = self
::renderMessageTemplate($mailContent, $params['disableSmarty'], $params['contactId'] ??
NULL, $params['tplParams']);
430 // send the template, honouring the target user’s preferences (if any)
433 // create the params array
434 $params['subject'] = $mailContent['subject'];
435 $params['text'] = $mailContent['text'];
436 $params['html'] = $mailContent['html'];
438 if ($params['toEmail']) {
439 $contactParams = [['email', 'LIKE', $params['toEmail'], 0, 1]];
440 [$contact] = CRM_Contact_BAO_Query
::apiQuery($contactParams);
442 $prefs = array_pop($contact);
444 if (isset($prefs['preferred_mail_format']) and $prefs['preferred_mail_format'] === 'HTML') {
445 $params['text'] = NULL;
448 if (isset($prefs['preferred_mail_format']) and $prefs['preferred_mail_format'] === 'Text') {
449 $params['html'] = NULL;
452 $config = CRM_Core_Config
::singleton();
453 if (isset($params['isEmailPdf']) && $params['isEmailPdf'] == 1) {
454 $pdfHtml = CRM_Contribute_BAO_ContributionPage
::addInvoicePdfToEmail($params['contributionId'], $params['contactId']);
455 if (empty($params['attachments'])) {
456 $params['attachments'] = [];
458 $params['attachments'][] = CRM_Utils_Mail
::appendPDF('Invoice.pdf', $pdfHtml, $mailContent['format']);
461 if ($config->doNotAttachPDFReceipt
&&
462 $params['PDFFilename'] &&
465 if (empty($params['attachments'])) {
466 $params['attachments'] = [];
468 $params['attachments'][] = CRM_Utils_Mail
::appendPDF($params['PDFFilename'], $params['html'], $mailContent['format']);
469 if (isset($params['tplParams']['email_comment'])) {
470 $params['html'] = $params['tplParams']['email_comment'];
471 $params['text'] = strip_tags($params['tplParams']['email_comment']);
475 $sent = CRM_Utils_Mail
::send($params);
478 unlink($pdf_filename);
482 return [$sent, $mailContent['subject'], $mailContent['text'], $mailContent['html']];
486 * Create a map between workflow_name and workflow_id.
489 * Array(string $workflowName => int $workflowId)
491 protected static function getWorkflowNameIdMap() {
492 // There's probably some more clever way to do this, but this seems simple.
493 return CRM_Core_DAO
::executeQuery('SELECT cov.name as name, cov.id as id FROM civicrm_option_group cog INNER JOIN civicrm_option_value cov on cov.option_group_id=cog.id WHERE cog.name LIKE %1', [
494 1 => ['msg_tpl_workflow_%', 'String'],
495 ])->fetchMap('name', 'id');
499 * Load the specified template.
501 * @param string $workflowName
502 * @param bool $isTest
503 * @param int|null $messageTemplateID
504 * @param string $groupName
507 * @throws \API_Exception
508 * @throws \CRM_Core_Exception
510 protected static function loadTemplate(string $workflowName, bool $isTest, int $messageTemplateID = NULL, $groupName = NULL): array {
511 if (!$workflowName && !$messageTemplateID) {
512 throw new CRM_Core_Exception(ts("Message template's option value or ID missing."));
515 $apiCall = MessageTemplate
::get(FALSE)
516 ->addSelect('msg_subject', 'msg_text', 'msg_html', 'pdf_format_id', 'id')
517 ->addWhere('is_default', '=', 1);
519 if ($messageTemplateID) {
520 $apiCall->addWhere('id', '=', (int) $messageTemplateID);
523 $apiCall->addWhere('workflow_name', '=', $workflowName);
525 $messageTemplate = $apiCall->execute()->first();
526 if (empty($messageTemplate['id'])) {
527 if ($messageTemplateID) {
528 throw new CRM_Core_Exception(ts('No such message template: id=%1.', [1 => $messageTemplateID]));
530 throw new CRM_Core_Exception(ts('No message template with workflow name %2.', [2 => $workflowName]));
534 'subject' => $messageTemplate['msg_subject'],
535 'text' => $messageTemplate['msg_text'],
536 'html' => $messageTemplate['msg_html'],
537 'format' => $messageTemplate['pdf_format_id'],
538 // Workflow name is the field in the message templates table that denotes the
539 // workflow the template is used for. This is intended to eventually
540 // replace the non-standard option value/group implementation - see
541 // https://github.com/civicrm/civicrm-core/pull/17227 and the longer
542 // discussion on https://github.com/civicrm/civicrm-core/pull/17180
543 'workflow_name' => $workflowName,
544 // Note messageTemplateID is the id but when present we also know it was specifically requested.
545 'messageTemplateID' => $messageTemplateID,
546 // Group name & valueName are deprecated parameters. At some point it will not be passed out.
547 // https://github.com/civicrm/civicrm-core/pull/17180
548 'groupName' => $groupName,
549 'valueName' => $workflowName,
552 CRM_Utils_Hook
::alterMailContent($mailContent);
554 // add the test banner (if requested)
556 $testText = MessageTemplate
::get(FALSE)
557 ->setSelect(['msg_subject', 'msg_text', 'msg_html'])
558 ->addWhere('workflow_name', '=', 'test_preview')
559 ->addWhere('is_default', '=', TRUE)
560 ->execute()->first();
562 $mailContent['subject'] = $testText['msg_subject'] . $mailContent['subject'];
563 $mailContent['text'] = $testText['msg_text'] . $mailContent['text'];
564 $mailContent['html'] = preg_replace('/<body(.*)$/im', "<body\\1\n{$testText['msg_html']}", $mailContent['html']);
571 * Get an array of the tokens ito be resolved in the template.
577 protected static function getTokensToResolve(array $html): array {
578 $mailing = new CRM_Mailing_BAO_Mailing();
579 $mailing->subject
= $html['subject'];
580 $mailing->body_text
= $html['text'];
581 $mailing->body_html
= $html['html'];
582 return $mailing->getTokens();
586 * @param array $mailContent
587 * @param array $tokens
588 * @param bool $escapeSmarty
591 * @throws \CRM_Core_Exception
593 protected static function resolveDomainTokens(array $mailContent, array $tokens, bool $escapeSmarty): array {
594 $domain = CRM_Core_BAO_Domain
::getDomain();
595 $mailContent['subject'] = CRM_Utils_Token
::replaceDomainTokens($mailContent['subject'], $domain, FALSE, $tokens['subject'], $escapeSmarty);
596 $mailContent['text'] = CRM_Utils_Token
::replaceDomainTokens($mailContent['text'], $domain, FALSE, $tokens['text'], $escapeSmarty);
597 $mailContent['html'] = CRM_Utils_Token
::replaceDomainTokens($mailContent['html'], $domain, TRUE, $tokens, $escapeSmarty);
603 * @param array|null $tokens
604 * @param array $mailContent
605 * @param bool $escapeSmarty
609 protected static function resolveContactTokens($contactID, ?
array $tokens, array $mailContent, bool $escapeSmarty): array {
610 $contactParams = ['contact_id' => $contactID];
611 $returnProperties = [];
613 if (isset($tokens['subject']['contact'])) {
614 foreach ($tokens['subject']['contact'] as $name) {
615 $returnProperties[$name] = 1;
619 if (isset($tokens['text']['contact'])) {
620 foreach ($tokens['text']['contact'] as $name) {
621 $returnProperties[$name] = 1;
625 if (isset($tokens['html']['contact'])) {
626 foreach ($tokens['html']['contact'] as $name) {
627 $returnProperties[$name] = 1;
631 // @todo CRM-17253 don't resolve contact details if there are no tokens
632 // effectively comment out this next (performance-expensive) line
633 // but unfortunately testing is a bit think on the ground to that needs to
635 [$contact] = CRM_Utils_Token
::getTokenDetails($contactParams,
638 CRM_Utils_Token
::flattenTokens($tokens),
639 // we should consider adding valueName here
640 'CRM_Core_BAO_MessageTemplate'
642 $contact = $contact[$contactID];
643 $mailContent['subject'] = CRM_Utils_Token
::replaceContactTokens($mailContent['subject'], $contact, FALSE, $tokens['subject'], FALSE, $escapeSmarty);
644 $mailContent['text'] = CRM_Utils_Token
::replaceContactTokens($mailContent['text'], $contact, FALSE, $tokens['text'], FALSE, $escapeSmarty);
645 $mailContent['html'] = CRM_Utils_Token
::replaceContactTokens($mailContent['html'], $contact, FALSE, $tokens['html'], FALSE, $escapeSmarty);
647 $contactArray = [$contactID => $contact];
648 CRM_Utils_Hook
::tokenValues($contactArray,
651 CRM_Utils_Token
::flattenTokens($tokens),
652 // we should consider adding valueName here
653 'CRM_Core_BAO_MessageTemplate'
655 $contact = $contactArray[$contactID];
658 CRM_Utils_Hook
::tokens($hookTokens);
659 $categories = array_keys($hookTokens);
660 $mailContent['subject'] = CRM_Utils_Token
::replaceHookTokens($mailContent['subject'], $contact, $categories, TRUE);
661 $mailContent['text'] = CRM_Utils_Token
::replaceHookTokens($mailContent['text'], $contact, $categories, TRUE);
662 $mailContent['html'] = CRM_Utils_Token
::replaceHookTokens($mailContent['html'], $contact, $categories, TRUE);
667 * @param array $mailContent
672 protected static function parseThroughSmarty(array $mailContent, $tplParams): array {
673 // strip whitespace from ends and turn into a single line
674 $mailContent['subject'] = "{strip}{$mailContent['subject']}{/strip}";
676 // parse the three elements with Smarty
677 $smarty = CRM_Core_Smarty
::singleton();
678 foreach ($tplParams as $name => $value) {
679 $smarty->assign($name, $value);
681 foreach (['subject', 'text', 'html'] as $elem) {
682 $mailContent[$elem] = $smarty->fetch("string:{$mailContent[$elem]}");
688 * Render the message template, resolving tokens and smarty tokens.
690 * @param array $mailContent
691 * @param bool $disableSmarty
692 * @param int $contactID
693 * @param array $smartyAssigns
696 * @throws \CRM_Core_Exception
698 protected static function renderMessageTemplate(array $mailContent, $disableSmarty, $contactID, $smartyAssigns): array {
699 $tokens = self
::getTokensToResolve($mailContent);
701 // When using Smarty we need to pass the $escapeSmarty parameter.
702 $escapeSmarty = !$disableSmarty;
704 $mailContent = self
::resolveDomainTokens($mailContent, $tokens, $escapeSmarty);
707 $mailContent = self
::resolveContactTokens($contactID, $tokens, $mailContent, $escapeSmarty);
710 // Normally Smarty is run, but it can be disabled using the disableSmarty
711 // parameter, which may be useful for non-core uses of MessageTemplate.send
712 // In particular it helps with the mosaicomsgtpl extension.
713 if (!$disableSmarty) {
714 $mailContent = self
::parseThroughSmarty($mailContent, $smartyAssigns);
717 // Since we're not relying on Smarty for this function, we DIY.
718 // strip whitespace from ends and turn into a single line
719 $mailContent['subject'] = trim(preg_replace('/[\r\n]+/', ' ', $mailContent['subject']));