3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
35 * Class to abstract token replacement.
37 class CRM_Utils_Token
{
38 static $_requiredTokens = NULL;
40 static $_tokens = array(
67 // we extract the stuff after the role / permission and return the
68 // civicrm email addresses of all users with that role / permission
69 // useful with rules integration
73 // populate this dynamically
75 // populate this dynamically
76 'contribution' => NULL,
85 'subscribe' => array('group'),
86 'unsubscribe' => array('group'),
87 'resubscribe' => array('group'),
88 'welcome' => array('group'),
94 * This is used by CiviMail but will be made redundant by FlexMailer.
97 public static function getRequiredTokens() {
98 if (self
::$_requiredTokens == NULL) {
99 self
::$_requiredTokens = array(
100 'domain.address' => ts("Domain address - displays your organization's postal address."),
101 'action.optOutUrl or action.unsubscribeUrl' => array(
102 'action.optOut' => ts("'Opt out via email' - displays an email address for recipients to opt out of receiving emails from your organization."),
103 'action.optOutUrl' => ts("'Opt out via web page' - creates a link for recipients to click if they want to opt out of receiving emails from your organization. Alternatively, you can include the 'Opt out via email' token."),
104 'action.unsubscribe' => ts("'Unsubscribe via email' - displays an email address for recipients to unsubscribe from the specific mailing list used to send this message."),
105 'action.unsubscribeUrl' => ts("'Unsubscribe via web page' - creates a link for recipients to unsubscribe from the specific mailing list used to send this message. Alternatively, you can include the 'Unsubscribe via email' token or one of the Opt-out tokens."),
109 return self
::$_requiredTokens;
113 * Check a string (mailing body) for required tokens.
119 * true if all required tokens are found,
120 * else an array of the missing tokens
122 public static function requiredTokens(&$str) {
123 // FlexMailer is a refactoring of CiviMail which provides new hooks/APIs/docs. If the sysadmin has opted to enable it, then use that instead of CiviMail.
124 $requiredTokens = defined('CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS') ? Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS
, array()) : CRM_Utils_Token
::getRequiredTokens();
127 foreach ($requiredTokens as $token => $value) {
128 if (!is_array($value)) {
129 if (!preg_match('/(^|[^\{])' . preg_quote('{' . $token . '}') . '/', $str)) {
130 $missing[$token] = $value;
136 foreach ($value as $t => $d) {
138 if (preg_match('/(^|[^\{])' . preg_quote('{' . $t . '}') . '/', $str)) {
143 $missing[$token] = $desc;
148 if (empty($missing)) {
155 * Wrapper for token matching.
157 * @param string $type
158 * The token type (domain,mailing,contact,action).
160 * The token variable.
162 * The string to search.
167 public static function token_match($type, $var, &$str) {
168 $token = preg_quote('{' . "$type.$var") . '(\|.+?)?' . preg_quote('}');
169 return preg_match("/(^|[^\{])$token/", $str);
173 * Wrapper for token replacing.
175 * @param string $type
178 * The token variable.
179 * @param string $value
180 * The value to substitute for the token.
181 * @param string (reference) $str The string to replace in
183 * @param bool $escapeSmarty
186 * The processed string
188 public static function &token_replace($type, $var, $value, &$str, $escapeSmarty = FALSE) {
189 $token = preg_quote('{' . "$type.$var") . '(\|([^\}]+?))?' . preg_quote('}');
194 $value = self
::tokenEscapeSmarty($value);
196 $str = preg_replace("/([^\{])?$token/", "\${1}$value", $str);
201 * Get< the regex for token replacement
203 * @param string $token_type
204 * A string indicating the the type of token to be used in the expression.
207 * regular expression sutiable for using in preg_replace
209 private static function tokenRegex($token_type) {
210 return '/(?<!\{|\\\\)\{' . $token_type . '\.([\w]+(\-[\w\s]+)?)\}(?!\})/';
214 * Escape the string so a malicious user cannot inject smarty code into the template.
216 * @param string $string
217 * A string that needs to be escaped from smarty parsing.
222 public static function tokenEscapeSmarty($string) {
223 // need to use negative look-behind, as both str_replace() and preg_replace() are sequential
224 return preg_replace(array('/{/', '/(?<!{ldelim)}/'), array('{ldelim}', '{rdelim}'), $string);
228 * Replace all the domain-level tokens in $str
231 * The string with tokens to be replaced.
232 * @param object $domain
235 * Replace tokens with HTML or plain text.
237 * @param null $knownTokens
238 * @param bool $escapeSmarty
241 * The processed string
243 public static function &replaceDomainTokens(
248 $escapeSmarty = FALSE
252 !$knownTokens ||
empty($knownTokens[$key])
257 $str = preg_replace_callback(
258 self
::tokenRegex($key),
259 function ($matches) use (&$domain, $html, $escapeSmarty) {
260 return CRM_Utils_Token
::getDomainTokenReplacement($matches[1], $domain, $html, $escapeSmarty);
271 * @param bool $escapeSmarty
273 * @return mixed|null|string
275 public static function getDomainTokenReplacement($token, &$domain, $html = FALSE, $escapeSmarty = FALSE) {
276 // check if the token we were passed is valid
277 // we have to do this because this function is
278 // called only when we find a token in the string
280 $loc = &$domain->getLocationValues();
282 if (!in_array($token, self
::$_tokens['domain'])) {
283 $value = "{domain.$token}";
285 elseif ($token == 'address') {
286 static $addressCache = array();
288 $cache_key = $html ?
'address-html' : 'address-text';
289 if (array_key_exists($cache_key, $addressCache)) {
290 return $addressCache[$cache_key];
294 // Construct the address token
296 if (!empty($loc[$token])) {
298 $value = $loc[$token][1]['display'];
299 $value = str_replace("\n", '<br />', $value);
302 $value = $loc[$token][1]['display_text'];
304 $addressCache[$cache_key] = $value;
307 elseif ($token == 'name' ||
$token == 'id' ||
$token == 'description') {
308 $value = $domain->$token;
310 elseif ($token == 'phone' ||
$token == 'email') {
311 // Construct the phone and email tokens
314 if (!empty($loc[$token])) {
315 foreach ($loc[$token] as $index => $entity) {
316 $value = $entity[$token];
323 $value = self
::tokenEscapeSmarty($value);
330 * Replace all the org-level tokens in $str
332 * @fixme: This function appears to be broken, as it depends on
333 * nonexistant method: CRM_Core_BAO_CustomValue::getContactValues()
334 * Marking as deprecated until this is fixed
338 * The string with tokens to be replaced.
340 * Associative array of org properties.
342 * Replace tokens with HTML or plain text.
344 * @param bool $escapeSmarty
347 * The processed string
349 public static function &replaceOrgTokens($str, &$org, $html = FALSE, $escapeSmarty = FALSE) {
350 self
::$_tokens['org']
352 array_keys(CRM_Contact_BAO_Contact
::importableFields('Organization')),
353 array('address', 'display_name', 'checksum', 'contact_id')
357 foreach (self
::$_tokens['org'] as $token) {
358 // print "Getting token value for $token<br/><br/>";
363 // If the string doesn't contain this token, skip it.
365 if (!self
::token_match('org', $token, $str)) {
369 // Construct value from $token and $contact
373 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($token)) {
374 // only generate cv if we need it
376 $cv = CRM_Core_BAO_CustomValue
::getContactValues($org['contact_id']);
378 foreach ($cv as $cvFieldID => $value) {
379 if ($cvFieldID == $cfID) {
380 $value = CRM_Core_BAO_CustomField
::displayValue($value, $cfID);
385 elseif ($token == 'checksum') {
386 $cs = CRM_Contact_BAO_Contact_Utils
::generateChecksum($org['contact_id']);
389 elseif ($token == 'address') {
390 // Build the location values array
393 $loc['display_name'] = CRM_Utils_Array
::retrieveValueRecursive($org, 'display_name');
394 $loc['street_address'] = CRM_Utils_Array
::retrieveValueRecursive($org, 'street_address');
395 $loc['city'] = CRM_Utils_Array
::retrieveValueRecursive($org, 'city');
396 $loc['state_province'] = CRM_Utils_Array
::retrieveValueRecursive($org, 'state_province');
397 $loc['postal_code'] = CRM_Utils_Array
::retrieveValueRecursive($org, 'postal_code');
399 // Construct the address token
401 $value = CRM_Utils_Address
::format($loc);
403 $value = str_replace("\n", '<br />', $value);
407 $value = CRM_Utils_Array
::retrieveValueRecursive($org, $token);
410 self
::token_replace('org', $token, $value, $str, $escapeSmarty);
417 * Replace all mailing tokens in $str
420 * The string with tokens to be replaced.
421 * @param object $mailing
422 * The mailing BAO, or null for validation.
424 * Replace tokens with HTML or plain text.
426 * @param null $knownTokens
427 * @param bool $escapeSmarty
430 * The processed string
432 public static function &replaceMailingTokens(
437 $escapeSmarty = FALSE
440 if (!$knownTokens ||
!isset($knownTokens[$key])) {
444 $str = preg_replace_callback(
445 self
::tokenRegex($key),
446 function ($matches) use (&$mailing, $escapeSmarty) {
447 return CRM_Utils_Token
::getMailingTokenReplacement($matches[1], $mailing, $escapeSmarty);
457 * @param bool $escapeSmarty
461 public static function getMailingTokenReplacement($token, &$mailing, $escapeSmarty = FALSE) {
467 $value = $mailing ?
$mailing->id
: 'undefined';
471 $value = $mailing ?
$mailing->name
: 'Mailing Name';
475 $groups = $mailing ?
$mailing->getGroupNames() : array('Mailing Groups');
476 $value = implode(', ', $groups);
480 $value = $mailing->subject
;
484 $mailingKey = $mailing->id
;
485 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
488 $value = CRM_Utils_System
::url('civicrm/mailing/view',
489 "reset=1&id={$mailingKey}",
490 TRUE, NULL, FALSE, TRUE
496 // Note: editUrl and scheduleUrl used to be different, but now there's
497 // one screen which can adapt based on permissions (in workflow mode).
498 $value = CRM_Utils_System
::url('civicrm/mailing/send',
499 "reset=1&mid={$mailing->id}&continue=true",
500 TRUE, NULL, FALSE, TRUE
505 $page = new CRM_Mailing_Page_View();
506 $value = $page->run($mailing->id
, NULL, FALSE, TRUE);
509 case 'approvalStatus':
510 $value = CRM_Core_PseudoConstant
::getLabel('CRM_Mailing_DAO_Mailing', 'approval_status_id', $mailing->approval_status_id
);
514 $value = $mailing->approval_note
;
518 $value = CRM_Utils_System
::url('civicrm/mailing/approve',
519 "reset=1&mid={$mailing->id}",
520 TRUE, NULL, FALSE, TRUE
525 $value = CRM_Contact_BAO_Contact
::displayName($mailing->created_id
);
529 $value = CRM_Contact_BAO_Contact
::getPrimaryEmail($mailing->created_id
);
533 $value = "{mailing.$token}";
538 $value = self
::tokenEscapeSmarty($value);
544 * Replace all action tokens in $str
547 * The string with tokens to be replaced.
548 * @param array $addresses
549 * Assoc. array of VERP event addresses.
551 * Assoc. array of action URLs.
553 * Replace tokens with HTML or plain text.
554 * @param array $knownTokens
555 * A list of tokens that are known to exist in the email body.
557 * @param bool $escapeSmarty
560 * The processed string
562 public static function &replaceActionTokens(
568 $escapeSmarty = FALSE
571 // here we intersect with the list of pre-configured valid tokens
572 // so that we remove anything we do not recognize
573 // I hope to move this step out of here soon and
574 // then we will just iterate on a list of tokens that are passed to us
575 if (!$knownTokens ||
empty($knownTokens[$key])) {
579 $str = preg_replace_callback(
580 self
::tokenRegex($key),
581 function ($matches) use (&$addresses, &$urls, $html, $escapeSmarty) {
582 return CRM_Utils_Token
::getActionTokenReplacement($matches[1], $addresses, $urls, $html, $escapeSmarty);
594 * @param bool $escapeSmarty
596 * @return mixed|string
598 public static function getActionTokenReplacement(
603 $escapeSmarty = FALSE
605 // If the token is an email action, use it. Otherwise, find the
608 if (!in_array($token, self
::$_tokens['action'])) {
609 $value = "{action.$token}";
612 $value = CRM_Utils_Array
::value($token, $addresses);
614 if ($value == NULL) {
615 $value = CRM_Utils_Array
::value($token, $urls);
618 if ($value && $html) {
620 if ((substr($token, -3) != 'Url') && ($token != 'forward')) {
621 $value = "mailto:$value";
624 elseif ($value && !$html) {
625 $value = str_replace('&', '&', $value);
630 $value = self
::tokenEscapeSmarty($value);
636 * Replace all the contact-level tokens in $str with information from
640 * The string with tokens to be replaced.
641 * @param array $contact
642 * Associative array of contact properties.
644 * Replace tokens with HTML or plain text.
645 * @param array $knownTokens
646 * A list of tokens that are known to exist in the email body.
647 * @param bool $returnBlankToken
648 * Return unevaluated token if value is null.
650 * @param bool $escapeSmarty
653 * The processed string
655 public static function &replaceContactTokens(
660 $returnBlankToken = FALSE,
661 $escapeSmarty = FALSE
663 // Refresh contact tokens in case they have changed. There is heavy caching
664 // in exportable fields so there is no benefit in doing this conditionally.
665 self
::$_tokens['contact'] = array_merge(
666 array_keys(CRM_Contact_BAO_Contact
::exportableFields('All')),
667 array('checksum', 'contact_id')
671 // here we intersect with the list of pre-configured valid tokens
672 // so that we remove anything we do not recognize
673 // I hope to move this step out of here soon and
674 // then we will just iterate on a list of tokens that are passed to us
675 if (!$knownTokens ||
empty($knownTokens[$key])) {
679 $str = preg_replace_callback(
680 self
::tokenRegex($key),
681 function ($matches) use (&$contact, $html, $returnBlankToken, $escapeSmarty) {
682 return CRM_Utils_Token
::getContactTokenReplacement($matches[1], $contact, $html, $returnBlankToken, $escapeSmarty);
687 $str = preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
695 * @param bool $returnBlankToken
696 * @param bool $escapeSmarty
698 * @return bool|mixed|null|string
700 public static function getContactTokenReplacement(
704 $returnBlankToken = FALSE,
705 $escapeSmarty = FALSE
707 if (self
::$_tokens['contact'] == NULL) {
708 /* This should come from UF */
710 self
::$_tokens['contact']
712 array_keys(CRM_Contact_BAO_Contact
::exportableFields('All')),
713 array('checksum', 'contact_id')
717 // Construct value from $token and $contact
722 // Support legacy tokens
723 $token = CRM_Utils_Array
::value($token, self
::legacyContactTokens(), $token);
725 // check if the token we were passed is valid
726 // we have to do this because this function is
727 // called only when we find a token in the string
729 if (!in_array($token, self
::$_tokens['contact'])) {
732 elseif ($token == 'checksum') {
733 $hash = CRM_Utils_Array
::value('hash', $contact);
734 $contactID = CRM_Utils_Array
::retrieveValueRecursive($contact, 'contact_id');
735 $cs = CRM_Contact_BAO_Contact_Utils
::generateChecksum($contactID,
743 $value = CRM_Utils_Array
::retrieveValueRecursive($contact, $token);
745 // FIXME: for some pseudoconstants we get array ( 0 => id, 1 => label )
746 if (is_array($value)) {
749 // Convert pseudoconstants using metadata
750 elseif ($value && is_numeric($value)) {
751 $allFields = CRM_Contact_BAO_Contact
::exportableFields('All');
752 if (!empty($allFields[$token]['pseudoconstant'])) {
753 $value = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $token, $value);
756 elseif ($value && CRM_Utils_String
::endsWith($token, '_date')) {
757 $value = CRM_Utils_Date
::customFormat($value);
762 $value = str_replace('&', '&', $value);
765 // if null then return actual token
766 if ($returnBlankToken && !$value) {
771 $value = "{contact.$token}";
775 && !($returnBlankToken && $noReplace)
777 // $returnBlankToken means the caller wants to do further attempts at
778 // processing unreplaced tokens -- so don't escape them yet in this case.
779 $value = self
::tokenEscapeSmarty($value);
786 * Replace all the hook tokens in $str with information from
790 * The string with tokens to be replaced.
791 * @param array $contact
792 * Associative array of contact properties (including hook token values).
795 * Replace tokens with HTML or plain text.
797 * @param bool $escapeSmarty
800 * The processed string
802 public static function &replaceHookTokens(
807 $escapeSmarty = FALSE
809 foreach ($categories as $key) {
810 $str = preg_replace_callback(
811 self
::tokenRegex($key),
812 function ($matches) use (&$contact, $key, $html, $escapeSmarty) {
813 return CRM_Utils_Token
::getHookTokenReplacement($matches[1], $contact, $key, $html, $escapeSmarty);
822 * Parse html through Smarty resolving any smarty functions.
823 * @param string $tokenHtml
824 * @param array $entity
825 * @param string $entityType
827 * html parsed through smarty
829 public static function parseThroughSmarty($tokenHtml, $entity, $entityType = 'contact') {
830 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
831 $smarty = CRM_Core_Smarty
::singleton();
832 // also add the tokens to the template
833 $smarty->assign_by_ref($entityType, $entity);
834 $tokenHtml = $smarty->fetch("string:$tokenHtml");
844 * @param bool $escapeSmarty
846 * @return mixed|string
848 public static function getHookTokenReplacement(
853 $escapeSmarty = FALSE
855 $value = CRM_Utils_Array
::value("{$category}.{$token}", $contact);
857 if ($value && !$html) {
858 $value = str_replace('&', '&', $value);
862 $value = self
::tokenEscapeSmarty($value);
869 * unescapeTokens removes any characters that caused the replacement routines to skip token replacement
870 * for example {{token}} or \{token} will result in {token} in the final email
872 * this routine will remove the extra backslashes and braces
874 * @param $str ref to the string that will be scanned and modified
876 public static function unescapeTokens(&$str) {
877 $str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str);
881 * Replace unsubscribe tokens.
884 * The string with tokens to be replaced.
885 * @param object $domain
887 * @param array $groups
888 * The groups (if any) being unsubscribed.
890 * Replace tokens with html or plain text.
891 * @param int $contact_id
893 * @param string $hash The security hash of the unsub event
896 * The processed string
898 public static function &replaceUnsubscribeTokens(
906 if (self
::token_match('unsubscribe', 'group', $str)) {
907 if (!empty($groups)) {
908 $config = CRM_Core_Config
::singleton();
909 $base = CRM_Utils_System
::baseURL();
911 // FIXME: an ugly hack for CRM-2035, to be dropped once CRM-1799 is implemented
912 $dao = new CRM_Contact_DAO_Group();
914 while ($dao->fetch()) {
915 if (substr($dao->visibility
, 0, 6) == 'Public') {
916 $visibleGroups[] = $dao->id
;
919 $value = implode(', ', $groups);
920 self
::token_replace('unsubscribe', 'group', $value, $str);
927 * Replace resubscribe tokens.
930 * The string with tokens to be replaced.
931 * @param object $domain
933 * @param array $groups
934 * The groups (if any) being resubscribed.
936 * Replace tokens with html or plain text.
937 * @param int $contact_id
939 * @param string $hash The security hash of the resub event
942 * The processed string
944 public static function &replaceResubscribeTokens(
945 $str, &$domain, &$groups, $html,
948 if (self
::token_match('resubscribe', 'group', $str)) {
949 if (!empty($groups)) {
950 $value = implode(', ', $groups);
951 self
::token_replace('resubscribe', 'group', $value, $str);
958 * Replace subscription-confirmation-request tokens
961 * The string with tokens to be replaced.
962 * @param string $group
963 * The name of the group being subscribed.
966 * Replace tokens with html or plain text.
969 * The processed string
971 public static function &replaceSubscribeTokens($str, $group, $url, $html) {
972 if (self
::token_match('subscribe', 'group', $str)) {
973 self
::token_replace('subscribe', 'group', $group, $str);
975 if (self
::token_match('subscribe', 'url', $str)) {
976 self
::token_replace('subscribe', 'url', $url, $str);
982 * Replace subscription-invitation tokens
985 * The string with tokens to be replaced.
988 * The processed string
990 public static function &replaceSubscribeInviteTokens($str) {
991 if (preg_match('/\{action\.subscribeUrl\}/', $str)) {
992 $url = CRM_Utils_System
::url('civicrm/mailing/subscribe',
994 TRUE, NULL, FALSE, TRUE
996 $str = preg_replace('/\{action\.subscribeUrl\}/', $url, $str);
999 if (preg_match('/\{action\.subscribeUrl.\d+\}/', $str, $matches)) {
1000 foreach ($matches as $key => $value) {
1001 $gid = substr($value, 21, -1);
1002 $url = CRM_Utils_System
::url('civicrm/mailing/subscribe',
1003 "reset=1&gid={$gid}",
1004 TRUE, NULL, FALSE, TRUE
1006 $str = preg_replace('/' . preg_quote($value) . '/', $url, $str);
1010 if (preg_match('/\{action\.subscribe.\d+\}/', $str, $matches)) {
1011 foreach ($matches as $key => $value) {
1012 $gid = substr($value, 18, -1);
1013 $config = CRM_Core_Config
::singleton();
1014 $domain = CRM_Core_BAO_MailSettings
::defaultDomain();
1015 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1016 // we add the 0.0000000000000000 part to make this match the other email patterns (with action, two ids and a hash)
1017 $str = preg_replace('/' . preg_quote($value) . '/', "mailto:{$localpart}s.{$gid}.0.0000000000000000@$domain", $str);
1024 * Replace welcome/confirmation tokens
1026 * @param string $str
1027 * The string with tokens to be replaced.
1028 * @param string $group
1029 * The name of the group being subscribed.
1031 * Replace tokens with html or plain text.
1034 * The processed string
1036 public static function &replaceWelcomeTokens($str, $group, $html) {
1037 if (self
::token_match('welcome', 'group', $str)) {
1038 self
::token_replace('welcome', 'group', $group, $str);
1044 * Find unprocessed tokens (call this last)
1046 * @param string $str
1047 * The string to search.
1050 * Array of tokens that weren't replaced
1052 public static function &unmatchedTokens(&$str) {
1053 //preg_match_all('/[^\{\\\\]\{(\w+\.\w+)\}[^\}]/', $str, $match);
1054 preg_match_all('/\{(\w+\.\w+)\}/', $str, $match);
1059 * Find and replace tokens for each component.
1061 * @param string $str
1062 * The string to search.
1063 * @param array $contact
1064 * Associative array of contact properties.
1065 * @param array $components
1066 * A list of tokens that are known to exist in the email body.
1068 * @param bool $escapeSmarty
1069 * @param bool $returnEmptyToken
1072 * The processed string
1074 public static function &replaceComponentTokens(&$str, $contact, $components, $escapeSmarty = FALSE, $returnEmptyToken = TRUE) {
1075 if (!is_array($components) ||
empty($contact)) {
1079 foreach ($components as $name => $tokens) {
1080 if (!is_array($tokens) ||
empty($tokens)) {
1084 foreach ($tokens as $token) {
1085 if (self
::token_match($name, $token, $str) && isset($contact[$name . '.' . $token])) {
1086 self
::token_replace($name, $token, $contact[$name . '.' . $token], $str, $escapeSmarty);
1088 elseif (!$returnEmptyToken) {
1089 //replacing empty token
1090 self
::token_replace($name, $token, "", $str, $escapeSmarty);
1098 * Get array of string tokens.
1100 * @param string $string
1101 * The input string to parse for tokens.
1104 * array of tokens mentioned in field
1106 public static function getTokens($string) {
1109 preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
1116 foreach ($matches[1] as $token) {
1117 list($type, $name) = preg_split('/\./', $token, 2);
1118 if ($name && $type) {
1119 if (!isset($tokens[$type])) {
1120 $tokens[$type] = array();
1122 $tokens[$type][] = $name;
1130 * Function to determine which values to retrieve to insert into tokens. The heavy resemblance between this function
1131 * and getTokens appears to be historical rather than intentional and should be reviewed
1134 * fields to pass in as return properties when populating token
1136 public static function getReturnProperties(&$string) {
1137 $returnProperties = array();
1139 preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
1145 foreach ($matches[1] as $token) {
1146 list($type, $name) = preg_split('/\./', $token, 2);
1148 $returnProperties["{$name}"] = 1;
1153 return $returnProperties;
1157 * Gives required details of contacts in an indexed array format so we
1158 * can iterate in a nice loop and do token evaluation
1160 * @param array $contactIDs
1161 * @param array $returnProperties
1162 * Of required properties.
1163 * @param bool $skipOnHold Don't return on_hold contact info also.
1164 * Don't return on_hold contact info also.
1165 * @param bool $skipDeceased Don't return deceased contact info.
1166 * Don't return deceased contact info.
1167 * @param array $extraParams
1169 * @param array $tokens
1170 * The list of tokens we've extracted from the content.
1171 * @param null $className
1173 * The mailing list jobID - this is a legacy param.
1177 public static function getTokenDetails(
1179 $returnProperties = NULL,
1181 $skipDeceased = TRUE,
1182 $extraParams = NULL,
1189 foreach ($contactIDs as $contactID) {
1191 CRM_Core_Form
::CB_PREFIX
. $contactID,
1200 if ($skipDeceased) {
1201 $params[] = array('is_deceased', '=', 0, 0, 0);
1206 $params[] = array('on_hold', '=', 0, 0, 0);
1210 $params = array_merge($params, $extraParams);
1213 // if return properties are not passed then get all return properties
1214 if (empty($returnProperties)) {
1215 $fields = array_merge(array_keys(CRM_Contact_BAO_Contact
::exportableFields()),
1216 array('display_name', 'checksum', 'contact_id')
1218 foreach ($fields as $val) {
1219 // The unavailable fields are not available as tokens, do not have a one-2-one relationship
1220 // with contacts and are expensive to resolve.
1221 // @todo see CRM-17253 - there are some other fields (e.g note) that should be excluded
1222 // and upstream calls to this should populate return properties.
1223 $unavailableFields = array('group', 'tag');
1224 if (!in_array($val, $unavailableFields)) {
1225 $returnProperties[$val] = 1;
1231 foreach ($returnProperties as $name => $dontCare) {
1232 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
1238 $details = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, count($contactIDs), TRUE, FALSE, TRUE, CRM_Contact_BAO_Query
::MODE_CONTACTS
, NULL, TRUE);
1240 $contactDetails = &$details[0];
1242 foreach ($contactIDs as $contactID) {
1243 if (array_key_exists($contactID, $contactDetails)) {
1244 if (!empty($contactDetails[$contactID]['preferred_communication_method'])
1246 $communicationPreferences = array();
1247 foreach ($contactDetails[$contactID]['preferred_communication_method'] as $val) {
1249 $communicationPreferences[$val] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_communication_method', $val);
1252 $contactDetails[$contactID]['preferred_communication_method'] = implode(', ', $communicationPreferences);
1255 foreach ($custom as $cfID) {
1256 if (isset($contactDetails[$contactID]["custom_{$cfID}"])) {
1257 $contactDetails[$contactID]["custom_{$cfID}"] = CRM_Core_BAO_CustomField
::displayValue($contactDetails[$contactID]["custom_{$cfID}"], $cfID);
1261 // special case for greeting replacement
1267 if (!empty($contactDetails[$contactID][$val])) {
1268 $contactDetails[$contactID][$val] = $contactDetails[$contactID]["{$val}_display"];
1274 // also call a hook and get token details
1275 CRM_Utils_Hook
::tokenValues($details[0],
1285 * Call hooks on tokens for anonymous users - contact id is set to 0 - this allows non-contact
1286 * specific tokens to be rendered
1288 * @param array $contactIDs
1289 * This should always be array(0) or its not anonymous - left to keep signature same.
1291 * @param string $returnProperties
1292 * @param bool $skipOnHold
1293 * @param bool $skipDeceased
1294 * @param string $extraParams
1295 * @param array $tokens
1296 * @param string $className
1297 * Sent as context to the hook.
1298 * @param string $jobID
1300 * contactDetails with hooks swapped out
1302 public static function getAnonymousTokenDetails($contactIDs = array(
1305 $returnProperties = NULL,
1307 $skipDeceased = TRUE,
1308 $extraParams = NULL,
1312 $details = array(0 => array());
1313 // also call a hook and get token details
1314 CRM_Utils_Hook
::tokenValues($details[0],
1324 * Get Membership Token Details.
1325 * @param array $membershipIDs
1326 * Array of membership IDS.
1328 public static function getMembershipTokenDetails($membershipIDs) {
1329 $memberships = civicrm_api3('membership', 'get', array(
1330 'options' => array('limit' => 0),
1331 'membership_id' => array('IN' => (array) $membershipIDs),
1333 return $memberships['values'];
1337 * Replace existing greeting tokens in message/subject.
1339 * This function operates by reference, modifying the first parameter. Other
1340 * methods for token replacement in this class return the modified string.
1341 * This leads to inconsistency in how these methods must be applied.
1343 * @TODO Remove that inconsistency in usage.
1345 * ::replaceContactTokens() may need to be called after this method, to
1346 * replace tokens supplied from this method.
1348 * @param string $tokenString
1349 * @param array $contactDetails
1350 * @param int $contactId
1351 * @param string $className
1352 * @param bool $escapeSmarty
1354 public static function replaceGreetingTokens(&$tokenString, $contactDetails = NULL, $contactId = NULL, $className = NULL, $escapeSmarty = FALSE) {
1356 if (!$contactDetails && !$contactId) {
1360 // check if there are any tokens
1361 $greetingTokens = self
::getTokens($tokenString);
1363 if (!empty($greetingTokens)) {
1364 // first use the existing contact object for token replacement
1365 if (!empty($contactDetails)) {
1366 $tokenString = CRM_Utils_Token
::replaceContactTokens($tokenString, $contactDetails, TRUE, $greetingTokens, TRUE, $escapeSmarty);
1369 self
::removeNullContactTokens($tokenString, $contactDetails, $greetingTokens);
1370 // check if there are any unevaluated tokens
1371 $greetingTokens = self
::getTokens($tokenString);
1373 // $greetingTokens not empty, means there are few tokens which are not
1374 // evaluated, like custom data etc
1375 // so retrieve it from database
1376 if (!empty($greetingTokens) && array_key_exists('contact', $greetingTokens)) {
1377 $greetingsReturnProperties = array_flip(CRM_Utils_Array
::value('contact', $greetingTokens));
1378 $greetingsReturnProperties = array_fill_keys(array_keys($greetingsReturnProperties), 1);
1379 $contactParams = array('contact_id' => $contactId);
1381 $greetingDetails = self
::getTokenDetails($contactParams,
1382 $greetingsReturnProperties,
1388 // again replace tokens
1389 $tokenString = CRM_Utils_Token
::replaceContactTokens($tokenString,
1398 // check if there are still any unevaluated tokens
1399 $remainingTokens = self
::getTokens($tokenString);
1401 // $greetingTokens not empty, there are customized or hook tokens to replace
1402 if (!empty($remainingTokens)) {
1403 // Fill the return properties array
1404 $greetingTokens = $remainingTokens;
1405 reset($greetingTokens);
1406 $greetingsReturnProperties = array();
1407 foreach ($greetingTokens as $value) {
1408 $props = array_flip($value);
1409 $props = array_fill_keys(array_keys($props), 1);
1410 $greetingsReturnProperties = $greetingsReturnProperties +
$props;
1412 $contactParams = array('contact_id' => $contactId);
1413 $greetingDetails = self
::getTokenDetails($contactParams,
1414 $greetingsReturnProperties,
1419 // Prepare variables for calling replaceHookTokens
1420 $categories = array_keys($greetingTokens);
1421 list($contact) = $greetingDetails;
1422 // Replace tokens defined in Hooks.
1423 $tokenString = CRM_Utils_Token
::replaceHookTokens($tokenString, $contact[$contactId], $categories);
1429 * At this point, $contactDetails has loaded the contact from the DAO. Any
1430 * (non-custom) missing fields are null. By removing them, we can avoid
1431 * expensive calls to CRM_Contact_BAO_Query.
1433 * @param string $tokenString
1434 * @param array $contactDetails
1436 private static function removeNullContactTokens(&$tokenString, $contactDetails, &$greetingTokens) {
1437 $greetingTokensOriginal = $greetingTokens;
1438 $contactFieldList = CRM_Contact_DAO_Contact
::fields();
1439 // Sometimes contactDetails are in a multidemensional array, sometimes a
1440 // single-dimension array.
1441 if (array_key_exists(0, $contactDetails) && is_array($contactDetails[0])) {
1442 $contactDetails = current($contactDetails[0]);
1444 $nullFields = array_keys(array_diff_key($contactFieldList, $contactDetails));
1446 // Handle legacy tokens
1447 foreach (self
::legacyContactTokens() as $oldToken => $newToken) {
1448 if (CRM_Utils_Array
::key($newToken, $nullFields)) {
1449 $nullFields[] = $oldToken;
1453 // Remove null contact fields from $greetingTokens
1454 $greetingTokens['contact'] = array_diff($greetingTokens['contact'], $nullFields);
1456 // Also remove them from $tokenString
1457 $removedTokens = array_diff($greetingTokensOriginal['contact'], $greetingTokens['contact']);
1458 // Handle legacy tokens again, sigh
1459 if (!empty($removedTokens)) {
1460 foreach ($removedTokens as $token) {
1461 if (CRM_Utils_Array
::value($token, self
::legacyContactTokens()) !== NULL) {
1462 $removedTokens[] = CRM_Utils_Array
::value($token, self
::legacyContactTokens());
1465 foreach ($removedTokens as $token) {
1466 $tokenString = str_replace("{contact.$token}", '', $tokenString);
1476 public static function flattenTokens(&$tokens) {
1477 $flattenTokens = array();
1484 if (!isset($tokens[$prop])) {
1487 foreach ($tokens[$prop] as $type => $names) {
1488 if (!isset($flattenTokens[$type])) {
1489 $flattenTokens[$type] = array();
1491 foreach ($names as $name) {
1492 $flattenTokens[$type][$name] = 1;
1497 return $flattenTokens;
1501 * Replace all user tokens in $str
1503 * @param string $str
1504 * The string with tokens to be replaced.
1506 * @param null $knownTokens
1507 * @param bool $escapeSmarty
1510 * The processed string
1512 public static function &replaceUserTokens($str, $knownTokens = NULL, $escapeSmarty = FALSE) {
1514 if (!$knownTokens ||
1515 !isset($knownTokens[$key])
1520 $str = preg_replace_callback(
1521 self
::tokenRegex($key),
1522 function ($matches) use ($escapeSmarty) {
1523 return CRM_Utils_Token
::getUserTokenReplacement($matches[1], $escapeSmarty);
1532 * @param bool $escapeSmarty
1536 public static function getUserTokenReplacement($token, $escapeSmarty = FALSE) {
1539 list($objectName, $objectValue) = explode('-', $token, 2);
1541 switch ($objectName) {
1543 $value = CRM_Core_Permission
::permissionEmails($objectValue);
1547 $value = CRM_Core_Permission
::roleEmails($objectValue);
1551 if ($escapeSmarty) {
1552 $value = self
::tokenEscapeSmarty($value);
1558 protected static function _buildContributionTokens() {
1559 $key = 'contribution';
1560 if (self
::$_tokens[$key] == NULL) {
1561 self
::$_tokens[$key] = array_keys(array_merge(CRM_Contribute_BAO_Contribution
::exportableFields('All'),
1562 array('campaign', 'financial_type'),
1563 self
::getCustomFieldTokens('Contribution')
1569 * Store membership tokens on the static _tokens array.
1571 protected static function _buildMembershipTokens() {
1572 $key = 'membership';
1573 if (!isset(self
::$_tokens[$key]) || self
::$_tokens[$key] == NULL) {
1574 $membershipTokens = array();
1575 $tokens = CRM_Core_SelectValues
::membershipTokens();
1576 foreach ($tokens as $token => $dontCare) {
1577 $membershipTokens[] = substr($token, (strpos($token, '.') +
1), -1);
1579 self
::$_tokens[$key] = $membershipTokens;
1584 * Replace tokens for an entity.
1585 * @param string $entity
1586 * @param array $entityArray
1587 * (e.g. in format from api).
1588 * @param string $str
1589 * String to replace in.
1590 * @param array $knownTokens
1591 * Array of tokens present.
1592 * @param bool $escapeSmarty
1594 * string with replacements made
1596 public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = array(), $escapeSmarty = FALSE) {
1597 if (!$knownTokens ||
empty($knownTokens[$entity])) {
1601 $fn = 'get' . ucfirst($entity) . 'TokenReplacement';
1602 $fn = is_callable(array('CRM_Utils_Token', $fn)) ?
$fn : 'getApiTokenReplacement';
1603 // since we already know the tokens lets just use them & do str_replace which is faster & simpler than preg_replace
1604 foreach ($knownTokens[$entity] as $token) {
1605 $replacement = self
::$fn($entity, $token, $entityArray);
1606 if ($escapeSmarty) {
1607 $replacement = self
::tokenEscapeSmarty($replacement);
1609 $str = str_replace('{' . $entity . '.' . $token . '}', $replacement, $str);
1611 return preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
1615 * @param int $caseId
1617 * @param array $knownTokens
1618 * @param bool $escapeSmarty
1620 * @throws \CiviCRM_API3_Exception
1622 public static function replaceCaseTokens($caseId, $str, $knownTokens = array(), $escapeSmarty = FALSE) {
1623 if (!$knownTokens ||
empty($knownTokens['case'])) {
1626 $case = civicrm_api3('case', 'getsingle', array('id' => $caseId));
1627 return self
::replaceEntityTokens('case', $case, $str, $knownTokens, $escapeSmarty);
1631 * Generic function for formatting token replacement for an api field
1633 * @param string $entity
1634 * @param string $token
1635 * @param array $entityArray
1637 * @throws \CiviCRM_API3_Exception
1639 public static function getApiTokenReplacement($entity, $token, $entityArray) {
1640 if (!isset($entityArray[$token])) {
1643 $field = civicrm_api3($entity, 'getfield', array('action' => 'get', 'name' => $token, 'get_options' => 'get'));
1644 $field = $field['values'];
1645 $fieldType = CRM_Utils_Array
::value('type', $field);
1647 if ($fieldType == CRM_Utils_Type
::T_BOOLEAN
&& empty($field['options'])) {
1648 $field['options'] = array(ts('No'), ts('Yes'));
1650 // Match pseudoconstants
1651 if (!empty($field['options'])) {
1653 foreach ((array) $entityArray[$token] as $val) {
1654 $ret[] = $field['options'][$val];
1656 return implode(', ', $ret);
1658 // Format date fields
1659 elseif ($entityArray[$token] && $fieldType == CRM_Utils_Type
::T_DATE
) {
1660 return CRM_Utils_Date
::customFormat($entityArray[$token]);
1662 return implode(', ', (array) $entityArray[$token]);
1666 * Replace Contribution tokens in html.
1668 * @param string $str
1669 * @param array $contribution
1670 * @param bool|string $html
1671 * @param string $knownTokens
1672 * @param bool|string $escapeSmarty
1676 public static function replaceContributionTokens($str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) {
1677 $key = 'contribution';
1678 if (!$knownTokens ||
!CRM_Utils_Array
::value($key, $knownTokens)) {
1679 return $str; //early return
1681 self
::_buildContributionTokens();
1683 // here we intersect with the list of pre-configured valid tokens
1684 // so that we remove anything we do not recognize
1685 // I hope to move this step out of here soon and
1686 // then we will just iterate on a list of tokens that are passed to us
1688 $str = preg_replace_callback(
1689 self
::tokenRegex($key),
1690 function ($matches) use (&$contribution, $html, $escapeSmarty) {
1691 return CRM_Utils_Token
::getContributionTokenReplacement($matches[1], $contribution, $html, $escapeSmarty);
1696 $str = preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
1701 * We have a situation where we are rendering more than one token in each field because we are combining
1702 * tokens from more than one contribution when pdf thank you letters are grouped (CRM-14367)
1704 * The replaceContributionToken doesn't handle receive_date correctly in this scenario because of the formatting
1705 * it applies (other tokens are OK including date fields)
1707 * So we sort this out & then call the main function. Note that we are not escaping smarty on this fields like the main function
1708 * does - but the fields is already being formatted through a date function
1710 * @param string $separator
1711 * @param string $str
1712 * @param array $contribution
1713 * @param bool|string $html
1714 * @param string $knownTokens
1715 * @param bool|string $escapeSmarty
1719 public static function replaceMultipleContributionTokens($separator, $str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) {
1720 if (empty($knownTokens['contribution'])) {
1724 if (in_array('receive_date', $knownTokens['contribution'])) {
1725 $formattedDates = array();
1726 $dates = explode($separator, $contribution['receive_date']);
1727 foreach ($dates as $date) {
1728 $formattedDates[] = CRM_Utils_Date
::customFormat($date, NULL, array('j', 'm', 'Y'));
1730 $str = str_replace("{contribution.receive_date}", implode($separator, $formattedDates), $str);
1731 unset($knownTokens['contribution']['receive_date']);
1733 return self
::replaceContributionTokens($str, $contribution, $html, $knownTokens, $escapeSmarty);
1737 * Get replacement strings for any membership tokens (only a small number of tokens are implemnted in the first instance
1738 * - this is used by the pdfLetter task from membership search
1739 * @param string $entity
1740 * should always be "membership"
1741 * @param string $token
1743 * @param array $membership
1744 * An api result array for a single membership.
1745 * @return string token replacement
1747 public static function getMembershipTokenReplacement($entity, $token, $membership) {
1748 self
::_buildMembershipTokens();
1751 $value = $membership['membership_name'];
1755 $statuses = CRM_Member_BAO_Membership
::buildOptions('status_id');
1756 $value = $statuses[$membership['status_id']];
1761 $value = civicrm_api3('membership_type', 'getvalue', array(
1762 'id' => $membership['membership_type_id'],
1763 'return' => 'minimum_fee',
1765 $value = CRM_Utils_Money
::format($value, NULL, NULL, TRUE);
1767 catch (CiviCRM_API3_Exception
$e) {
1768 // we can anticipate we will get an error if the minimum fee is set to 'NULL' because of the way the
1769 // api handles NULL (4.4)
1775 if (in_array($token, self
::$_tokens[$entity])) {
1776 $value = $membership[$token];
1777 if (CRM_Utils_String
::endsWith($token, '_date')) {
1778 $value = CRM_Utils_Date
::customFormat($value);
1783 $value = "{$entity}.{$token}";
1793 * @param $contribution
1795 * @param bool $escapeSmarty
1797 * @return mixed|string
1799 public static function getContributionTokenReplacement($token, &$contribution, $html = FALSE, $escapeSmarty = FALSE) {
1800 self
::_buildContributionTokens();
1803 case 'total_amount':
1806 case 'non_deductible_amount':
1807 $value = CRM_Utils_Money
::format(CRM_Utils_Array
::retrieveValueRecursive($contribution, $token));
1810 case 'receive_date':
1811 $value = CRM_Utils_Array
::retrieveValueRecursive($contribution, $token);
1812 $value = CRM_Utils_Date
::customFormat($value, NULL, array('j', 'm', 'Y'));
1816 if (!in_array($token, self
::$_tokens['contribution'])) {
1817 $value = "{contribution.$token}";
1820 $value = CRM_Utils_Array
::retrieveValueRecursive($contribution, $token);
1825 if ($escapeSmarty) {
1826 $value = self
::tokenEscapeSmarty($value);
1833 * [legacy_token => new_token]
1835 public static function legacyContactTokens() {
1837 'individual_prefix' => 'prefix_id',
1838 'individual_suffix' => 'suffix_id',
1839 'gender' => 'gender_id',
1840 'communication_style' => 'communication_style_id',
1845 * Get all custom field tokens of $entity
1847 * @param string $entity
1848 * @param bool $usedForTokenWidget
1850 * @return array $customTokens
1851 * return custom field tokens in array('custom_N' => 'label') format
1853 public static function getCustomFieldTokens($entity, $usedForTokenWidget = FALSE) {
1854 $customTokens = array();
1855 $tokenName = $usedForTokenWidget ?
"{contribution.custom_%d}" : "custom_%d";
1856 foreach (CRM_Core_BAO_CustomField
::getFields($entity) as $id => $info) {
1857 $customTokens[sprintf($tokenName, $id)] = $info['label'];
1860 return $customTokens;
1864 * Formats a token list for the select2 widget
1869 public static function formatTokensForDisplay($tokens) {
1870 $sorted = $output = array();
1872 // Sort in ascending order by ignoring word case
1873 natcasesort($tokens);
1875 // Attempt to place tokens into optgroups
1876 // @todo These groupings could be better and less hackish. Getting them pre-grouped from upstream would be nice.
1877 foreach ($tokens as $k => $v) {
1878 // Check to see if this token is already in a group e.g. for custom fields
1879 $split = explode(' :: ', $v);
1880 if (!empty($split[1])) {
1881 $sorted[$split[1]][] = array('id' => $k, 'text' => $split[0]);
1885 $split = explode('.', trim($k, '{}'));
1886 if (isset($split[1])) {
1887 $entity = array_key_exists($split[1], CRM_Core_DAO_Address
::export()) ?
'Address' : ucfirst($split[0]);
1890 $entity = 'Contact';
1892 $sorted[ts($entity)][] = array('id' => $k, 'text' => $v);
1897 foreach ($sorted as $k => $v) {
1898 $output[] = array('text' => $k, 'children' => $v);