CRM/Utils/Token.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 use Civi\Token\TokenProcessor;
  13
  14 /**
  15  *
  16  * @package CRM
  17  * @copyright CiviCRM LLC https://civicrm.org/licensing
  18  */
  19
  20 /**
  21  * Class to abstract token replacement.
  22  */
  23 class CRM_Utils_Token {
  24   public static $_requiredTokens = NULL;
  25
  26   public static $_tokens = [
  27     'action' => [
  28       'forward',
  29       'optOut',
  30       'optOutUrl',
  31       'reply',
  32       'unsubscribe',
  33       'unsubscribeUrl',
  34       'resubscribe',
  35       'resubscribeUrl',
  36       'subscribeUrl',
  37     ],
  38     'mailing' => [
  39       'id',
  40       'key',
  41       'name',
  42       'group',
  43       'subject',
  44       'viewUrl',
  45       'editUrl',
  46       'scheduleUrl',
  47       'approvalStatus',
  48       'approvalNote',
  49       'approveUrl',
  50       'creator',
  51       'creatorEmail',
  52     ],
  53     'user' => [
  54       // we extract the stuff after the role / permission and return the
  55       // civicrm email addresses of all users with that role / permission
  56       // useful with rules integration
  57       'permission:',
  58       'role:',
  59     ],
  60     // populate this dynamically
  61     'contact' => NULL,
  62     // populate this dynamically
  63     'contribution' => NULL,
  64     'domain' => [
  65       'name',
  66       'phone',
  67       'address',
  68       'email',
  69       'id',
  70       'description',
  71     ],
  72     'subscribe' => ['group'],
  73     'unsubscribe' => ['group'],
  74     'resubscribe' => ['group'],
  75     'welcome' => ['group'],
  76   ];
  77
  78   /**
  79    * @deprecated
  80    *   This is used by CiviMail but will be made redundant by FlexMailer.
  81    * @return array
  82    */
  83   public static function getRequiredTokens() {
  84     if (self::$_requiredTokens == NULL) {
  85       self::$_requiredTokens = [
  86         'domain.address' => ts("Domain address - displays your organization's postal address."),
  87         'action.optOutUrl or action.unsubscribeUrl' => [
  88           'action.optOut' => ts("'Opt out via email' - displays an email address for recipients to opt out of receiving emails from your organization."),
  89           '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."),
  90           'action.unsubscribe' => ts("'Unsubscribe via email' - displays an email address for recipients to unsubscribe from the specific mailing list used to send this message."),
  91           '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."),
  92         ],
  93       ];
  94     }
  95     return self::$_requiredTokens;
  96   }
  97
  98   /**
  99    * Check a string (mailing body) for required tokens.
 100    *
 101    * @param string $str
 102    *   The message.
 103    *
 104    * @return bool|array
 105    *   true if all required tokens are found,
 106    *    else an array of the missing tokens
 107    */
 108   public static function requiredTokens(&$str) {
 109     // 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.
 110     $requiredTokens = defined('CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS') ? Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS, []) : CRM_Utils_Token::getRequiredTokens();
 111
 112     $missing = [];
 113     foreach ($requiredTokens as $token => $value) {
 114       if (!is_array($value)) {
 115         if (!preg_match('/(^|[^\{])' . preg_quote('{' . $token . '}') . '/', $str)) {
 116           $missing[$token] = $value;
 117         }
 118       }
 119       else {
 120         $present = FALSE;
 121         $desc = NULL;
 122         foreach ($value as $t => $d) {
 123           $desc = $d;
 124           if (preg_match('/(^|[^\{])' . preg_quote('{' . $t . '}') . '/', $str)) {
 125             $present = TRUE;
 126           }
 127         }
 128         if (!$present) {
 129           $missing[$token] = $desc;
 130         }
 131       }
 132     }
 133
 134     if (empty($missing)) {
 135       return TRUE;
 136     }
 137     return $missing;
 138   }
 139
 140   /**
 141    * Wrapper for token matching.
 142    *
 143    * @param string $type
 144    *   The token type (domain,mailing,contact,action).
 145    * @param string $var
 146    *   The token variable.
 147    * @param string $str
 148    *   The string to search.
 149    *
 150    * @return bool
 151    *   Was there a match
 152    */
 153   public static function token_match($type, $var, &$str) {
 154     $token = preg_quote('{' . "$type.$var") . '(\|.+?)?' . preg_quote('}');
 155     return preg_match("/(^|[^\{])$token/", $str);
 156   }
 157
 158   /**
 159    * Wrapper for token replacing.
 160    *
 161    * @param string $type
 162    *   The token type.
 163    * @param string $var
 164    *   The token variable.
 165    * @param string $value
 166    *   The value to substitute for the token.
 167    * @param string $str (reference) The string to replace in
 168    *
 169    * @param bool $escapeSmarty
 170    *
 171    * @return string
 172    *   The processed string
 173    */
 174   public static function token_replace($type, $var, $value, &$str, $escapeSmarty = FALSE) {
 175     $token = preg_quote('{' . "$type.$var") . '(\|([^\}]+?))?' . preg_quote('}');
 176     if (!$value) {
 177       $value = '$3';
 178     }
 179     if ($escapeSmarty) {
 180       $value = self::tokenEscapeSmarty($value);
 181     }
 182     $str = preg_replace("/([^\{])?$token/", "\${1}$value", $str);
 183     return $str;
 184   }
 185
 186   /**
 187    * Get the regex for token replacement
 188    *
 189    * @param string $token_type
 190    *   A string indicating the the type of token to be used in the expression.
 191    *
 192    * @return string
 193    *   regular expression suitable for using in preg_replace
 194    */
 195   private static function tokenRegex(string $token_type) {
 196     return '/(?<!\{|\\\\)\{' . $token_type . '\.([\w]+(:|\.)?\w*(\-[\w\s]+)?)\}(?!\})/';
 197   }
 198
 199   /**
 200    * Escape the string so a malicious user cannot inject smarty code into the template.
 201    *
 202    * @param string $string
 203    *   A string that needs to be escaped from smarty parsing.
 204    *
 205    * @return string
 206    *   the escaped string
 207    */
 208   public static function tokenEscapeSmarty($string) {
 209     // need to use negative look-behind, as both str_replace() and preg_replace() are sequential
 210     return preg_replace(['/{/', '/(?<!{ldelim)}/'], ['{ldelim}', '{rdelim}'], $string);
 211   }
 212
 213   /**
 214    * Replace all the domain-level tokens in $str
 215    *
 216    * @deprecated
 217    *
 218    * @param string $str
 219    *   The string with tokens to be replaced.
 220    * @param object $domain
 221    *   The domain BAO.
 222    * @param bool $html
 223    *   Replace tokens with HTML or plain text.
 224    *
 225    * @param null $knownTokens
 226    * @param bool $escapeSmarty
 227    *
 228    * @return string
 229    *   The processed string
 230    */
 231   public static function replaceDomainTokens(
 232     $str,
 233     $domain,
 234     $html = FALSE,
 235     $knownTokens = NULL,
 236     $escapeSmarty = FALSE
 237   ) {
 238     $key = 'domain';
 239     if (
 240       !$knownTokens || empty($knownTokens[$key])
 241     ) {
 242       return $str;
 243     }
 244
 245     $str = preg_replace_callback(
 246       self::tokenRegex($key),
 247       function ($matches) use ($domain, $html, $escapeSmarty) {
 248         return CRM_Utils_Token::getDomainTokenReplacement($matches[1], $domain, $html, $escapeSmarty);
 249       },
 250       $str
 251     );
 252     return $str;
 253   }
 254
 255   /**
 256    * Do not use.
 257    *
 258    * @deprecated
 259    *
 260    * @param string $token
 261    * @param CRM_Core_BAO_Domain $domain
 262    * @param bool $html
 263    * @param bool $escapeSmarty
 264    *
 265    * @return null|string
 266    */
 267   public static function getDomainTokenReplacement($token, $domain, $html = FALSE, $escapeSmarty = FALSE): ?string {
 268     $tokens = CRM_Core_DomainTokens::getDomainTokenValues($domain->id, $html);
 269     $value = $tokens[$token] ?? "{domain.$token}";
 270     if ($escapeSmarty) {
 271       $value = self::tokenEscapeSmarty($value);
 272     }
 273     return $value;
 274   }
 275
 276   /**
 277    * Replace all the org-level tokens in $str
 278    *
 279    * @fixme: This function appears to be broken, as it depended on
 280    * nonexistant method: CRM_Core_BAO_CustomValue::getContactValues()
 281    * Marking as deprecated until this is clarified.
 282    *
 283    * @deprecated
 284    *  - the above hard-breakage was there from 2015 to 2021 and
 285    * no error was ever reported on it -does that mean
 286    * 1) the code is never hit because the only function that
 287    * calls this function is never called or
 288    * 2) it was called but never required to resolve any tokens
 289    * or more specifically custom field tokens
 290    *
 291    * The handling for custom fields with the removed token has
 292    * now been removed.
 293    *
 294    * @param string $str
 295    *   The string with tokens to be replaced.
 296    * @param object $org
 297    *   Associative array of org properties.
 298    * @param bool $html
 299    *   Replace tokens with HTML or plain text.
 300    *
 301    * @param bool $escapeSmarty
 302    *
 303    * @return string
 304    *   The processed string
 305    */
 306   public static function replaceOrgTokens($str, &$org, $html = FALSE, $escapeSmarty = FALSE) {
 307     CRM_Core_Error::deprecatedFunctionWarning('token processor');
 308     self::$_tokens['org']
 309       = array_merge(
 310         array_keys(CRM_Contact_BAO_Contact::importableFields('Organization')),
 311         ['address', 'display_name', 'checksum', 'contact_id']
 312       );
 313
 314     foreach (self::$_tokens['org'] as $token) {
 315       // print "Getting token value for $token<br/><br/>";
 316       if ($token === '') {
 317         continue;
 318       }
 319
 320       // If the string doesn't contain this token, skip it.
 321
 322       if (!self::token_match('org', $token, $str)) {
 323         continue;
 324       }
 325
 326       // Construct value from $token and $contact
 327
 328       $value = NULL;
 329
 330       if ($token === 'checksum') {
 331         $cs = CRM_Contact_BAO_Contact_Utils::generateChecksum($org['contact_id']);
 332         $value = "cs={$cs}";
 333       }
 334       elseif ($token === 'address') {
 335         // Build the location values array
 336
 337         $loc = [];
 338         $loc['display_name'] = CRM_Utils_Array::retrieveValueRecursive($org, 'display_name');
 339         $loc['street_address'] = CRM_Utils_Array::retrieveValueRecursive($org, 'street_address');
 340         $loc['city'] = CRM_Utils_Array::retrieveValueRecursive($org, 'city');
 341         $loc['state_province'] = CRM_Utils_Array::retrieveValueRecursive($org, 'state_province');
 342         $loc['postal_code'] = CRM_Utils_Array::retrieveValueRecursive($org, 'postal_code');
 343
 344         // Construct the address token
 345
 346         $value = CRM_Utils_Address::format($loc);
 347         if ($html) {
 348           $value = str_replace("\n", '<br />', $value);
 349         }
 350       }
 351       else {
 352         $value = CRM_Utils_Array::retrieveValueRecursive($org, $token);
 353       }
 354
 355       self::token_replace('org', $token, $value, $str, $escapeSmarty);
 356     }
 357
 358     return $str;
 359   }
 360
 361   /**
 362    * Replace all mailing tokens in $str
 363    *
 364    * @param string $str
 365    *   The string with tokens to be replaced.
 366    * @param object $mailing
 367    *   The mailing BAO, or null for validation.
 368    * @param bool $html
 369    *   Replace tokens with HTML or plain text.
 370    *
 371    * @param null $knownTokens
 372    * @param bool $escapeSmarty
 373    *
 374    * @return string
 375    *   The processed string
 376    *
 377    * @deprecated
 378    */
 379   public static function &replaceMailingTokens(
 380     $str,
 381     &$mailing,
 382     $html = FALSE,
 383     $knownTokens = NULL,
 384     $escapeSmarty = FALSE
 385   ) {
 386     $key = 'mailing';
 387     if (!$knownTokens || !isset($knownTokens[$key])) {
 388       return $str;
 389     }
 390
 391     $str = preg_replace_callback(
 392       self::tokenRegex($key),
 393       function ($matches) use (&$mailing, $escapeSmarty) {
 394         return CRM_Utils_Token::getMailingTokenReplacement($matches[1], $mailing, $escapeSmarty);
 395       },
 396       $str
 397     );
 398     return $str;
 399   }
 400
 401   /**
 402    * @param $token
 403    * @param $mailing
 404    * @param bool $escapeSmarty
 405    *
 406    * @return string
 407    */
 408   public static function getMailingTokenReplacement($token, &$mailing, $escapeSmarty = FALSE) {
 409     $value = '';
 410     switch ($token) {
 411       // CRM-7663
 412
 413       case 'id':
 414         $value = $mailing ? $mailing->id : 'undefined';
 415         break;
 416
 417       // Key is the ID, or the hash when the hash URLs setting is enabled
 418       case 'key':
 419         $value = $mailing->id;
 420         if ($hash = CRM_Mailing_BAO_Mailing::getMailingHash($value)) {
 421           $value = $hash;
 422         }
 423         break;
 424
 425       case 'name':
 426         $value = $mailing ? $mailing->name : 'Mailing Name';
 427         break;
 428
 429       case 'group':
 430         $groups = $mailing ? $mailing->getGroupNames() : ['Mailing Groups'];
 431         $value = implode(', ', $groups);
 432         break;
 433
 434       case 'subject':
 435         $value = $mailing->subject;
 436         break;
 437
 438       case 'viewUrl':
 439         $mailingKey = $mailing->id;
 440         if ($hash = CRM_Mailing_BAO_Mailing::getMailingHash($mailingKey)) {
 441           $mailingKey = $hash;
 442         }
 443         $value = CRM_Utils_System::url('civicrm/mailing/view',
 444           "reset=1&id={$mailingKey}",
 445           TRUE, NULL, FALSE, TRUE
 446         );
 447         break;
 448
 449       case 'editUrl':
 450       case 'scheduleUrl':
 451         // Note: editUrl and scheduleUrl used to be different, but now there's
 452         // one screen which can adapt based on permissions (in workflow mode).
 453         $value = CRM_Utils_System::url('civicrm/mailing/send',
 454           "reset=1&mid={$mailing->id}&continue=true",
 455           TRUE, NULL, FALSE, TRUE
 456         );
 457         break;
 458
 459       case 'html':
 460         $page = new CRM_Mailing_Page_View();
 461         $value = $page->run($mailing->id, NULL, FALSE, TRUE);
 462         break;
 463
 464       case 'approvalStatus':
 465         $value = CRM_Core_PseudoConstant::getLabel('CRM_Mailing_DAO_Mailing', 'approval_status_id', $mailing->approval_status_id);
 466         break;
 467
 468       case 'approvalNote':
 469         $value = $mailing->approval_note;
 470         break;
 471
 472       case 'approveUrl':
 473         $value = CRM_Utils_System::url('civicrm/mailing/approve',
 474           "reset=1&mid={$mailing->id}",
 475           TRUE, NULL, FALSE, TRUE
 476         );
 477         break;
 478
 479       case 'creator':
 480         $value = CRM_Contact_BAO_Contact::displayName($mailing->created_id);
 481         break;
 482
 483       case 'creatorEmail':
 484         $value = CRM_Contact_BAO_Contact::getPrimaryEmail($mailing->created_id);
 485         break;
 486
 487       default:
 488         $value = "{mailing.$token}";
 489         break;
 490     }
 491
 492     if ($escapeSmarty) {
 493       $value = self::tokenEscapeSmarty($value);
 494     }
 495     return $value;
 496   }
 497
 498   /**
 499    * Replace all action tokens in $str
 500    *
 501    * @param string $str
 502    *   The string with tokens to be replaced.
 503    * @param array $addresses
 504    *   Assoc. array of VERP event addresses.
 505    * @param array $urls
 506    *   Assoc. array of action URLs.
 507    * @param bool $html
 508    *   Replace tokens with HTML or plain text.
 509    * @param array $knownTokens
 510    *   A list of tokens that are known to exist in the email body.
 511    *
 512    * @param bool $escapeSmarty
 513    *
 514    * @return string
 515    *   The processed string
 516    */
 517   public static function &replaceActionTokens(
 518     $str,
 519     &$addresses,
 520     &$urls,
 521     $html = FALSE,
 522     $knownTokens = NULL,
 523     $escapeSmarty = FALSE
 524   ) {
 525     $key = 'action';
 526     // here we intersect with the list of pre-configured valid tokens
 527     // so that we remove anything we do not recognize
 528     // I hope to move this step out of here soon and
 529     // then we will just iterate on a list of tokens that are passed to us
 530     if (!$knownTokens || empty($knownTokens[$key])) {
 531       return $str;
 532     }
 533
 534     $str = preg_replace_callback(
 535       self::tokenRegex($key),
 536       function ($matches) use (&$addresses, &$urls, $html, $escapeSmarty) {
 537         return CRM_Utils_Token::getActionTokenReplacement($matches[1], $addresses, $urls, $html, $escapeSmarty);
 538       },
 539       $str
 540     );
 541     return $str;
 542   }
 543
 544   /**
 545    * @deprecated
 546    *
 547    * @param $token
 548    * @param $addresses
 549    * @param $urls
 550    * @param bool $html
 551    * @param bool $escapeSmarty
 552    *
 553    * @return mixed|string
 554    */
 555   public static function getActionTokenReplacement(
 556     $token,
 557     &$addresses,
 558     &$urls,
 559     $html = FALSE,
 560     $escapeSmarty = FALSE
 561   ) {
 562     // If the token is an email action, use it.  Otherwise, find the
 563     // appropriate URL.
 564
 565     if (!in_array($token, self::$_tokens['action'])) {
 566       $value = "{action.$token}";
 567     }
 568     else {
 569       $value = $addresses[$token] ?? NULL;
 570
 571       if ($value == NULL) {
 572         $value = $urls[$token] ?? NULL;
 573       }
 574
 575       if ($value && $html) {
 576         // fix for CRM-2318
 577         if ((substr($token, -3) != 'Url') && ($token != 'forward')) {
 578           $value = "mailto:$value";
 579         }
 580       }
 581       elseif ($value && !$html) {
 582         $value = str_replace('&amp;', '&', $value);
 583       }
 584     }
 585
 586     if ($escapeSmarty) {
 587       $value = self::tokenEscapeSmarty($value);
 588     }
 589     return $value;
 590   }
 591
 592   /**
 593    * Replace all the contact-level tokens in $str with information from
 594    * $contact.
 595    *
 596    * @param string $str
 597    *   The string with tokens to be replaced.
 598    * @param array $contact
 599    *   Associative array of contact properties.
 600    * @param bool $html
 601    *   Replace tokens with HTML or plain text.
 602    * @param array $knownTokens
 603    *   A list of tokens that are known to exist in the email body.
 604    * @param bool $returnBlankToken
 605    *   Return unevaluated token if value is null.
 606    *
 607    * @deprecated
 608    *
 609    * @param bool $escapeSmarty
 610    *
 611    * @return string
 612    *   The processed string
 613    */
 614   public static function replaceContactTokens(
 615     $str,
 616     &$contact,
 617     $html = FALSE,
 618     $knownTokens = NULL,
 619     $returnBlankToken = FALSE,
 620     $escapeSmarty = FALSE
 621   ) {
 622     // Refresh contact tokens in case they have changed. There is heavy caching
 623     // in exportable fields so there is no benefit in doing this conditionally.
 624     self::$_tokens['contact'] = array_merge(
 625       array_keys(CRM_Contact_BAO_Contact::exportableFields('All')),
 626       ['checksum', 'contact_id']
 627     );
 628
 629     $key = 'contact';
 630     // here we intersect with the list of pre-configured valid tokens
 631     // so that we remove anything we do not recognize
 632     // I hope to move this step out of here soon and
 633     // then we will just iterate on a list of tokens that are passed to us
 634     if (!$knownTokens || empty($knownTokens[$key])) {
 635       return $str;
 636     }
 637
 638     $str = preg_replace_callback(
 639       self::tokenRegex($key),
 640       function ($matches) use (&$contact, $html, $returnBlankToken, $escapeSmarty) {
 641         return CRM_Utils_Token::getContactTokenReplacement($matches[1], $contact, $html, $returnBlankToken, $escapeSmarty);
 642       },
 643       $str
 644     );
 645
 646     $str = preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
 647     return $str;
 648   }
 649
 650   /**
 651    * Do Not use.
 652    *
 653    * Only core usage is from a deprecated unused function and
 654    * from deprecated BAO_Mailing code (to be replaced by flexmailer).
 655    *
 656    * @deprecated
 657    *
 658    * @param $token
 659    * @param $contact
 660    * @param bool $html
 661    * @param bool $returnBlankToken
 662    * @param bool $escapeSmarty
 663    *
 664    * @return bool|mixed|null|string
 665    */
 666   public static function getContactTokenReplacement(
 667     $token,
 668     &$contact,
 669     $html = FALSE,
 670     $returnBlankToken = FALSE,
 671     $escapeSmarty = FALSE
 672   ) {
 673     if (self::$_tokens['contact'] == NULL) {
 674       /* This should come from UF */
 675
 676       self::$_tokens['contact']
 677         = array_merge(
 678           array_keys(CRM_Contact_BAO_Contact::exportableFields('All')),
 679           ['checksum', 'contact_id']
 680         );
 681     }
 682
 683     // Construct value from $token and $contact
 684
 685     $value = NULL;
 686     $noReplace = FALSE;
 687
 688     // Support legacy tokens
 689     $token = CRM_Utils_Array::value($token, self::legacyContactTokens(), $token);
 690
 691     // check if the token we were passed is valid
 692     // we have to do this because this function is
 693     // called only when we find a token in the string
 694
 695     if (!in_array(str_replace(':label', '', $token), self::$_tokens['contact'])) {
 696       $noReplace = TRUE;
 697     }
 698     elseif ($token == 'checksum') {
 699       $hash = $contact['hash'] ?? NULL;
 700       $contactID = CRM_Utils_Array::retrieveValueRecursive($contact, 'contact_id');
 701       $cs = CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID,
 702         NULL,
 703         NULL,
 704         $hash
 705       );
 706       $value = "cs={$cs}";
 707     }
 708     else {
 709       $value = (array) CRM_Utils_Array::retrieveValueRecursive($contact, str_replace(':label', '', $token));
 710
 711       foreach ($value as $index => $item) {
 712         $value[$index] = self::convertPseudoConstantsUsingMetadata($value[$index], str_replace(':label', '', $token));
 713       }
 714       $value = implode(', ', $value);
 715     }
 716
 717     if (!$html) {
 718       $value = str_replace('&amp;', '&', $value);
 719     }
 720
 721     // if null then return actual token
 722     if ($returnBlankToken && !$value) {
 723       $noReplace = TRUE;
 724     }
 725
 726     if ($noReplace) {
 727       $value = "{contact.$token}";
 728     }
 729
 730     if ($escapeSmarty
 731       && !($returnBlankToken && $noReplace)
 732     ) {
 733       // $returnBlankToken means the caller wants to do further attempts at
 734       // processing unreplaced tokens -- so don't escape them yet in this case.
 735       $value = self::tokenEscapeSmarty($value);
 736     }
 737
 738     return $value;
 739   }
 740
 741   /**
 742    * Do not use - unused in core.
 743    *
 744    * Replace all the hook tokens in $str with information from
 745    * $contact.
 746    *
 747    * @deprecated
 748    *
 749    * @param string $str
 750    *   The string with tokens to be replaced.
 751    * @param array $contact
 752    *   Associative array of contact properties (including hook token values).
 753    * @param $categories
 754    * @param bool $html
 755    *   Replace tokens with HTML or plain text.
 756    *
 757    * @param bool $escapeSmarty
 758    *
 759    * @return string
 760    *   The processed string
 761    */
 762   public static function &replaceHookTokens(
 763     $str,
 764     &$contact,
 765     $categories = NULL,
 766     $html = FALSE,
 767     $escapeSmarty = FALSE
 768   ) {
 769     if (!$categories) {
 770       $categories = self::getTokenCategories();
 771     }
 772     foreach ($categories as $key) {
 773       $str = preg_replace_callback(
 774         self::tokenRegex($key),
 775         function ($matches) use (&$contact, $key, $html, $escapeSmarty) {
 776           return CRM_Utils_Token::getHookTokenReplacement($matches[1], $contact, $key, $html, $escapeSmarty);
 777         },
 778         $str
 779       );
 780     }
 781     return $str;
 782   }
 783
 784   /**
 785    * Get the categories required for rendering tokens.
 786    *
 787    * @return array
 788    */
 789   public static function getTokenCategories(): array {
 790     if (!isset(\Civi::$statics[__CLASS__]['token_categories'])) {
 791       $tokens = [];
 792       \CRM_Utils_Hook::tokens($tokens);
 793       \Civi::$statics[__CLASS__]['token_categories'] = array_keys($tokens);
 794     }
 795     return \Civi::$statics[__CLASS__]['token_categories'];
 796   }
 797
 798   /**
 799    * Parse html through Smarty resolving any smarty functions.
 800    * @param string $tokenHtml
 801    * @param array $entity
 802    * @param string $entityType
 803    * @return string
 804    *   html parsed through smarty
 805    * @deprecated
 806    */
 807   public static function parseThroughSmarty($tokenHtml, $entity, $entityType = 'contact') {
 808     if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
 809       $smarty = CRM_Core_Smarty::singleton();
 810       // also add the tokens to the template
 811       $smarty->assign_by_ref($entityType, $entity);
 812       $tokenHtml = $smarty->fetch("string:$tokenHtml");
 813     }
 814     return $tokenHtml;
 815   }
 816
 817   /**
 818    * Do not use, unused in core.
 819    *
 820    * @deprecated
 821    *
 822    * @param $token
 823    * @param $contact
 824    * @param $category
 825    * @param bool $html
 826    * @param bool $escapeSmarty
 827    *
 828    * @return mixed|string
 829    */
 830   public static function getHookTokenReplacement(
 831     $token,
 832     &$contact,
 833     $category,
 834     $html = FALSE,
 835     $escapeSmarty = FALSE
 836   ) {
 837     $value = $contact["{$category}.{$token}"] ?? NULL;
 838
 839     if ($value && !$html) {
 840       $value = str_replace('&amp;', '&', $value);
 841     }
 842
 843     if ($escapeSmarty) {
 844       $value = self::tokenEscapeSmarty($value);
 845     }
 846
 847     return $value;
 848   }
 849
 850   /**
 851    * unescapeTokens removes any characters that caused the replacement routines to skip token replacement
 852    * for example {{token}}  or \{token}  will result in {token} in the final email
 853    *
 854    * this routine will remove the extra backslashes and braces
 855    *
 856    * @deprecated
 857    *
 858    * @param string $str ref to the string that will be scanned and modified
 859    */
 860   public static function unescapeTokens(&$str) {
 861     $str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str);
 862   }
 863
 864   /**
 865    * Replace unsubscribe tokens.
 866    *
 867    * @param string $str
 868    *   The string with tokens to be replaced.
 869    * @param object $domain
 870    *   The domain BAO.
 871    * @param array $groups
 872    *   The groups (if any) being unsubscribed.
 873    * @param bool $html
 874    *   Replace tokens with html or plain text.
 875    * @param int $contact_id
 876    *   The contact ID.
 877    * @param string $hash The security hash of the unsub event
 878    *
 879    * @return string
 880    *   The processed string
 881    */
 882   public static function &replaceUnsubscribeTokens(
 883     $str,
 884     &$domain,
 885     &$groups,
 886     $html,
 887     $contact_id,
 888     $hash
 889   ) {
 890     if (self::token_match('unsubscribe', 'group', $str)) {
 891       if (!empty($groups)) {
 892         $config = CRM_Core_Config::singleton();
 893         $base = CRM_Utils_System::baseURL();
 894
 895         // FIXME: an ugly hack for CRM-2035, to be dropped once CRM-1799 is implemented
 896         $dao = new CRM_Contact_DAO_Group();
 897         $dao->find();
 898         while ($dao->fetch()) {
 899           if (substr($dao->visibility, 0, 6) == 'Public') {
 900             $visibleGroups[] = $dao->id;
 901           }
 902         }
 903         $value = implode(', ', $groups);
 904         self::token_replace('unsubscribe', 'group', $value, $str);
 905       }
 906     }
 907     return $str;
 908   }
 909
 910   /**
 911    * Replace resubscribe tokens.
 912    *
 913    * @param string $str
 914    *   The string with tokens to be replaced.
 915    * @param object $domain
 916    *   The domain BAO.
 917    * @param array $groups
 918    *   The groups (if any) being resubscribed.
 919    * @param bool $html
 920    *   Replace tokens with html or plain text.
 921    * @param int $contact_id
 922    *   The contact ID.
 923    * @param string $hash The security hash of the resub event
 924    *
 925    * @return string
 926    *   The processed string
 927    */
 928   public static function &replaceResubscribeTokens(
 929     $str, &$domain, &$groups, $html,
 930     $contact_id, $hash
 931   ) {
 932     if (self::token_match('resubscribe', 'group', $str)) {
 933       if (!empty($groups)) {
 934         $value = implode(', ', $groups);
 935         self::token_replace('resubscribe', 'group', $value, $str);
 936       }
 937     }
 938     return $str;
 939   }
 940
 941   /**
 942    * Replace subscription-confirmation-request tokens
 943    *
 944    * @param string $str
 945    *   The string with tokens to be replaced.
 946    * @param string $group
 947    *   The name of the group being subscribed.
 948    * @param $url
 949    * @param bool $html
 950    *   Replace tokens with html or plain text.
 951    *
 952    * @return string
 953    *   The processed string
 954    */
 955   public static function &replaceSubscribeTokens($str, $group, $url, $html) {
 956     if (self::token_match('subscribe', 'group', $str)) {
 957       self::token_replace('subscribe', 'group', $group, $str);
 958     }
 959     if (self::token_match('subscribe', 'url', $str)) {
 960       self::token_replace('subscribe', 'url', $url, $str);
 961     }
 962     return $str;
 963   }
 964
 965   /**
 966    * Replace subscription-invitation tokens
 967    *
 968    * @param string $str
 969    *   The string with tokens to be replaced.
 970    *
 971    * @return string
 972    *   The processed string
 973    */
 974   public static function &replaceSubscribeInviteTokens($str) {
 975     if (preg_match('/\{action\.subscribeUrl\}/', $str)) {
 976       $url = CRM_Utils_System::url('civicrm/mailing/subscribe',
 977         'reset=1',
 978         TRUE, NULL, FALSE, TRUE
 979       );
 980       $str = preg_replace('/\{action\.subscribeUrl\}/', $url, $str);
 981     }
 982
 983     if (preg_match('/\{action\.subscribeUrl.\d+\}/', $str, $matches)) {
 984       foreach ($matches as $key => $value) {
 985         $gid = substr($value, 21, -1);
 986         $url = CRM_Utils_System::url('civicrm/mailing/subscribe',
 987           "reset=1&gid={$gid}",
 988           TRUE, NULL, FALSE, TRUE
 989         );
 990         $str = preg_replace('/' . preg_quote($value) . '/', $url, $str);
 991       }
 992     }
 993
 994     if (preg_match('/\{action\.subscribe.\d+\}/', $str, $matches)) {
 995       foreach ($matches as $key => $value) {
 996         $gid = substr($value, 18, -1);
 997         $config = CRM_Core_Config::singleton();
 998         $domain = CRM_Core_BAO_MailSettings::defaultDomain();
 999         $localpart = CRM_Core_BAO_MailSettings::defaultLocalpart();
1000         // we add the 0.0000000000000000 part to make this match the other email patterns (with action, two ids and a hash)
1001         $str = preg_replace('/' . preg_quote($value) . '/', "mailto:{$localpart}s.{$gid}.0.0000000000000000@$domain", $str);
1002       }
1003     }
1004     return $str;
1005   }
1006
1007   /**
1008    * Replace welcome/confirmation tokens
1009    *
1010    * @param string $str
1011    *   The string with tokens to be replaced.
1012    * @param string $group
1013    *   The name of the group being subscribed.
1014    * @param bool $html
1015    *   Replace tokens with html or plain text.
1016    *
1017    * @return string
1018    *   The processed string
1019    */
1020   public static function &replaceWelcomeTokens($str, $group, $html) {
1021     if (self::token_match('welcome', 'group', $str)) {
1022       self::token_replace('welcome', 'group', $group, $str);
1023     }
1024     return $str;
1025   }
1026
1027   /**
1028    * Find unprocessed tokens (call this last)
1029    *
1030    * @param string $str
1031    *   The string to search.
1032    *
1033    * @return array
1034    *   Array of tokens that weren't replaced
1035    */
1036   public static function &unmatchedTokens(&$str) {
1037     //preg_match_all('/[^\{\\\\]\{(\w+\.\w+)\}[^\}]/', $str, $match);
1038     preg_match_all('/\{(\w+\.\w+)\}/', $str, $match);
1039     return $match[1];
1040   }
1041
1042   /**
1043    * Find and replace tokens for each component.
1044    *
1045    * @param string $str
1046    *   The string to search.
1047    * @param array $contact
1048    *   Associative array of contact properties.
1049    * @param array $components
1050    *   A list of tokens that are known to exist in the email body.
1051    *
1052    * @param bool $escapeSmarty
1053    * @param bool $returnEmptyToken
1054    *
1055    * @return string
1056    *   The processed string
1057    *
1058    * @deprecated
1059    */
1060   public static function replaceComponentTokens(&$str, $contact, $components, $escapeSmarty = FALSE, $returnEmptyToken = TRUE) {
1061     CRM_Core_Error::deprecatedFunctionWarning('use the token processor');
1062     if (!is_array($components) || empty($contact)) {
1063       return $str;
1064     }
1065
1066     foreach ($components as $name => $tokens) {
1067       if (!is_array($tokens) || empty($tokens)) {
1068         continue;
1069       }
1070
1071       foreach ($tokens as $token) {
1072         if (self::token_match($name, $token, $str) && isset($contact[$name . '.' . $token])) {
1073           self::token_replace($name, $token, $contact[$name . '.' . $token], $str, $escapeSmarty);
1074         }
1075         elseif (!$returnEmptyToken) {
1076           //replacing empty token
1077           self::token_replace($name, $token, "", $str, $escapeSmarty);
1078         }
1079       }
1080     }
1081     return $str;
1082   }
1083
1084   /**
1085    * Get array of string tokens.
1086    *
1087    * @param string $string
1088    *   The input string to parse for tokens.
1089    *
1090    * @return array
1091    *   array of tokens mentioned in field
1092    */
1093   public static function getTokens($string) {
1094     $matches = [];
1095     $tokens = [];
1096     preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+(:|.)?\w*)\}(?!\})/',
1097       $string,
1098       $matches,
1099       PREG_PATTERN_ORDER
1100     );
1101
1102     if ($matches[1]) {
1103       foreach ($matches[1] as $token) {
1104         $parts = explode('.', $token, 3);
1105         $type = $parts[0];
1106         $name = $parts[1];
1107         $suffix = !empty($parts[2]) ? ('.' . $parts[2]) : '';
1108         if ($name && $type) {
1109           if (!isset($tokens[$type])) {
1110             $tokens[$type] = [];
1111           }
1112           $tokens[$type][] = $name . $suffix;
1113         }
1114       }
1115     }
1116     return $tokens;
1117   }
1118
1119   /**
1120    * Function to determine which values to retrieve to insert into tokens. The heavy resemblance between this function
1121    * and getTokens appears to be historical rather than intentional and should be reviewed
1122    * @param $string
1123    * @return array
1124    *   fields to pass in as return properties when populating token
1125    */
1126   public static function getReturnProperties(&$string) {
1127     $returnProperties = [];
1128     $matches = [];
1129     preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
1130       $string,
1131       $matches,
1132       PREG_PATTERN_ORDER
1133     );
1134     if ($matches[1]) {
1135       foreach ($matches[1] as $token) {
1136         [$type, $name] = preg_split('/\./', $token, 2);
1137         if ($name) {
1138           $returnProperties["{$name}"] = 1;
1139         }
1140       }
1141     }
1142
1143     return $returnProperties;
1144   }
1145
1146   /**
1147    * Do not use this function.
1148    *
1149    * Gives required details of contacts in an indexed array format so we
1150    * can iterate in a nice loop and do token evaluation
1151    *
1152    * @param array $contactIDs
1153    * @param array $returnProperties
1154    *   Of required properties.
1155    * @param bool $skipOnHold Don't return on_hold contact info also.
1156    *   Don't return on_hold contact info also.
1157    * @param bool $skipDeceased Don't return deceased contact info.
1158    *   Don't return deceased contact info.
1159    * @param array $extraParams
1160    *   Extra params - DEPRECATED
1161    * @param array $tokens
1162    *   The list of tokens we've extracted from the content.
1163    * @param string|null $className
1164    * @param int|null $jobID
1165    *   The mailing list jobID - this is a legacy param.
1166    *
1167    * @deprecated
1168    *
1169    * @return array - e.g [[1 => ['first_name' => 'bob'...], 34 => ['first_name' => 'fred'...]]]
1170    */
1171   public static function getTokenDetails(
1172     $contactIDs,
1173     $returnProperties = NULL,
1174     $skipOnHold = TRUE,
1175     $skipDeceased = TRUE,
1176     $extraParams = NULL,
1177     $tokens = [],
1178     $className = NULL,
1179     $jobID = NULL
1180   ) {
1181     CRM_Core_Error::deprecatedFunctionWarning('If you hit this in mailing code you should use flexmailer - otherwise use the token processor');
1182     $params = [];
1183     foreach ($contactIDs as $contactID) {
1184       $params[] = [
1185         CRM_Core_Form::CB_PREFIX . $contactID,
1186         '=',
1187         1,
1188         0,
1189         0,
1190       ];
1191     }
1192
1193     // fix for CRM-2613
1194     if ($skipDeceased) {
1195       $params[] = ['is_deceased', '=', 0, 0, 0];
1196     }
1197
1198     //fix for CRM-3798
1199     if ($skipOnHold) {
1200       $params[] = ['on_hold', '=', 0, 0, 0];
1201     }
1202
1203     if ($extraParams) {
1204       CRM_Core_Error::deprecatedWarning('Passing $extraParams to getTokenDetails() is not supported and will be removed in a future version');
1205       $params = array_merge($params, $extraParams);
1206     }
1207
1208     // if return properties are not passed then get all return properties
1209     if (empty($returnProperties)) {
1210       $fields = array_merge(array_keys(CRM_Contact_BAO_Contact::exportableFields()),
1211         ['display_name', 'checksum', 'contact_id']
1212       );
1213       foreach ($fields as $val) {
1214         // The unavailable fields are not available as tokens, do not have a one-2-one relationship
1215         // with contacts and are expensive to resolve.
1216         // @todo see CRM-17253 - there are some other fields (e.g note) that should be excluded
1217         // and upstream calls to this should populate return properties.
1218         $unavailableFields = ['group', 'tag'];
1219         if (!in_array($val, $unavailableFields)) {
1220           $returnProperties[$val] = 1;
1221         }
1222       }
1223     }
1224
1225     $custom = [];
1226     foreach ($returnProperties as $name => $dontCare) {
1227       $cfID = CRM_Core_BAO_CustomField::getKeyID($name);
1228       if ($cfID) {
1229         $custom[] = $cfID;
1230       }
1231     }
1232
1233     [$contactDetails] = CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, NULL, NULL, 0, count($contactIDs), TRUE, FALSE, TRUE, CRM_Contact_BAO_Query::MODE_CONTACTS, NULL, TRUE);
1234
1235     foreach ($contactIDs as $contactID) {
1236       if (array_key_exists($contactID, $contactDetails)) {
1237         if (!empty($contactDetails[$contactID]['preferred_communication_method'])
1238         ) {
1239           $communicationPreferences = [];
1240           foreach ((array) $contactDetails[$contactID]['preferred_communication_method'] as $val) {
1241             if ($val) {
1242               $communicationPreferences[$val] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_communication_method', $val);
1243             }
1244           }
1245           $contactDetails[$contactID]['preferred_communication_method'] = implode(', ', $communicationPreferences);
1246         }
1247
1248         foreach ($custom as $cfID) {
1249           if (isset($contactDetails[$contactID]["custom_{$cfID}"])) {
1250             $contactDetails[$contactID]["custom_{$cfID}"] = CRM_Core_BAO_CustomField::displayValue($contactDetails[$contactID]["custom_{$cfID}"], $cfID);
1251           }
1252         }
1253
1254         // special case for greeting replacement
1255         foreach ([
1256           'email_greeting',
1257           'postal_greeting',
1258           'addressee',
1259         ] as $val) {
1260           if (!empty($contactDetails[$contactID][$val])) {
1261             $contactDetails[$contactID][$val] = $contactDetails[$contactID]["{$val}_display"];
1262           }
1263         }
1264       }
1265     }
1266
1267     // $contactDetails = &$details[0] = is an array of [ contactID => contactDetails ]
1268     // also call a hook and get token details
1269     CRM_Utils_Hook::tokenValues($contactDetails,
1270       $contactIDs,
1271       $jobID,
1272       $tokens,
1273       $className
1274     );
1275     return [$contactDetails];
1276   }
1277
1278   /**
1279    * Call hooks on tokens for anonymous users - contact id is set to 0 - this allows non-contact
1280    * specific tokens to be rendered
1281    *
1282    * @param array $contactIDs
1283    *   This should always be array(0) or its not anonymous - left to keep signature same.
1284    *   as main fn
1285    * @param string $returnProperties
1286    * @param bool $skipOnHold
1287    * @param bool $skipDeceased
1288    * @param string $extraParams
1289    * @param array $tokens
1290    * @param string $className
1291    *   Sent as context to the hook.
1292    * @param string $jobID
1293    * @return array
1294    *   contactDetails with hooks swapped out
1295    *
1296    * @deprecated
1297    */
1298   public static function getAnonymousTokenDetails($contactIDs = [0],
1299                                            $returnProperties = NULL,
1300                                            $skipOnHold = TRUE,
1301                                            $skipDeceased = TRUE,
1302                                            $extraParams = NULL,
1303                                            $tokens = [],
1304                                            $className = NULL,
1305                                            $jobID = NULL) {
1306     $details = [0 => []];
1307     // also call a hook and get token details
1308     CRM_Utils_Hook::tokenValues($details[0],
1309       $contactIDs,
1310       $jobID,
1311       $tokens,
1312       $className
1313     );
1314     return $details;
1315   }
1316
1317   /**
1318    * Get Membership Token Details.
1319    * @param array $membershipIDs
1320    *   Array of membership IDS.
1321    *
1322    * @deprecated
1323    */
1324   public static function getMembershipTokenDetails($membershipIDs) {
1325     $memberships = civicrm_api3('membership', 'get', [
1326       'options' => ['limit' => 0],
1327       'membership_id' => ['IN' => (array) $membershipIDs],
1328     ]);
1329     return $memberships['values'];
1330   }
1331
1332   /**
1333    * Replace existing greeting tokens in message/subject.
1334    *
1335    * This function operates by reference, modifying the first parameter. Other
1336    * methods for token replacement in this class return the modified string.
1337    * This leads to inconsistency in how these methods must be applied.
1338    *
1339    * @TODO Remove that inconsistency in usage.
1340    *
1341    * @param string $tokenString
1342    * @param array $contactDetails
1343    * @param int $contactId
1344    * @param string $className
1345    * @param bool $escapeSmarty
1346    */
1347   public static function replaceGreetingTokens(&$tokenString, $contactDetails = NULL, $contactId = NULL, $className = NULL, $escapeSmarty = FALSE) {
1348
1349     if (!$contactDetails && !$contactId) {
1350       return;
1351     }
1352     // check if there are any tokens
1353     $greetingTokens = self::getTokens($tokenString);
1354     $context = $contactId ? ['contactId' => $contactId] : [];
1355     if ($contactDetails) {
1356       $context['contact'] = isset($contactDetails[0]) ? reset($contactDetails[0]) : $contactDetails;
1357     }
1358     $tokenProcessor = new TokenProcessor(\Civi::dispatcher(), [
1359       'smarty' => FALSE,
1360       'class' => $className,
1361     ]);
1362     $tokenProcessor->addRow($context);
1363     $tokenProcessor->addMessage('greeting', $tokenString, 'text/plain');
1364     $tokenProcessor->evaluate();
1365     foreach ($tokenProcessor->getRows() as $row) {
1366       $tokenString = $row->render('greeting');
1367     }
1368   }
1369
1370   /**
1371    * At this point, $contactDetails has loaded the contact from the DAO. Any
1372    * (non-custom) missing fields are null.  By removing them, we can avoid
1373    * expensive calls to CRM_Contact_BAO_Query.
1374    *
1375    * @deprecated unused in core
1376    *
1377    * @param string $tokenString
1378    * @param array $contactDetails
1379    * @param array $greetingTokens
1380    */
1381   private static function removeNullContactTokens(&$tokenString, $contactDetails, &$greetingTokens) {
1382
1383     // Only applies to contact tokens
1384     if (!array_key_exists('contact', $greetingTokens)) {
1385       return;
1386     }
1387
1388     $greetingTokensOriginal = $greetingTokens;
1389     $contactFieldList = CRM_Contact_DAO_Contact::fields();
1390     // Sometimes contactDetails are in a multidemensional array, sometimes a
1391     // single-dimension array.
1392     if (array_key_exists(0, $contactDetails) && is_array($contactDetails[0])) {
1393       $contactDetails = current($contactDetails[0]);
1394     }
1395     $nullFields = array_keys(array_diff_key($contactFieldList, $contactDetails));
1396
1397     // Handle legacy tokens
1398     foreach (self::legacyContactTokens() as $oldToken => $newToken) {
1399       if (CRM_Utils_Array::key($newToken, $nullFields)) {
1400         $nullFields[] = $oldToken;
1401       }
1402     }
1403
1404     // Remove null contact fields from $greetingTokens
1405     $greetingTokens['contact'] = array_diff($greetingTokens['contact'], $nullFields);
1406
1407     // Also remove them from $tokenString
1408     $removedTokens = array_diff($greetingTokensOriginal['contact'], $greetingTokens['contact']);
1409     // Handle legacy tokens again, sigh
1410     if (!empty($removedTokens)) {
1411       foreach ($removedTokens as $token) {
1412         if (CRM_Utils_Array::value($token, self::legacyContactTokens()) !== NULL) {
1413           $removedTokens[] = CRM_Utils_Array::value($token, self::legacyContactTokens());
1414         }
1415       }
1416       foreach ($removedTokens as $token) {
1417         $tokenString = str_replace("{contact.$token}", '', $tokenString);
1418       }
1419     }
1420   }
1421
1422   /**
1423    * @param $tokens
1424    *
1425    * @return array
1426    */
1427   public static function flattenTokens(&$tokens) {
1428     $flattenTokens = [];
1429
1430     foreach ([
1431       'html',
1432       'text',
1433       'subject',
1434     ] as $prop) {
1435       if (!isset($tokens[$prop])) {
1436         continue;
1437       }
1438       foreach ($tokens[$prop] as $type => $names) {
1439         if (!isset($flattenTokens[$type])) {
1440           $flattenTokens[$type] = [];
1441         }
1442         foreach ($names as $name) {
1443           $flattenTokens[$type][$name] = 1;
1444         }
1445       }
1446     }
1447
1448     return $flattenTokens;
1449   }
1450
1451   /**
1452    * Replace all user tokens in $str
1453    *
1454    * @param string $str
1455    *   The string with tokens to be replaced.
1456    *
1457    * @param null $knownTokens
1458    * @param bool $escapeSmarty
1459    *
1460    * @return string
1461    *   The processed string
1462    */
1463   public static function &replaceUserTokens($str, $knownTokens = NULL, $escapeSmarty = FALSE) {
1464     $key = 'user';
1465     if (!$knownTokens ||
1466       !isset($knownTokens[$key])
1467     ) {
1468       return $str;
1469     }
1470
1471     $str = preg_replace_callback(
1472       self::tokenRegex($key),
1473       function ($matches) use ($escapeSmarty) {
1474         return CRM_Utils_Token::getUserTokenReplacement($matches[1], $escapeSmarty);
1475       },
1476       $str
1477     );
1478     return $str;
1479   }
1480
1481   /**
1482    * @param $token
1483    * @param bool $escapeSmarty
1484    *
1485    * @return string
1486    */
1487   public static function getUserTokenReplacement($token, $escapeSmarty = FALSE) {
1488     $value = '';
1489
1490     [$objectName, $objectValue] = explode('-', $token, 2);
1491
1492     switch ($objectName) {
1493       case 'permission':
1494         $value = CRM_Core_Permission::permissionEmails($objectValue);
1495         break;
1496
1497       case 'role':
1498         $value = CRM_Core_Permission::roleEmails($objectValue);
1499         break;
1500     }
1501
1502     if ($escapeSmarty) {
1503       $value = self::tokenEscapeSmarty($value);
1504     }
1505
1506     return $value;
1507   }
1508
1509   /**
1510    * @deprecated
1511    *
1512    * Do not use this function - it still needs full removal from active code
1513    * in CRM_Contribute_Form_Task_PDFLetter.
1514    */
1515   protected static function _buildContributionTokens() {
1516     $key = 'contribution';
1517
1518     if (!isset(Civi::$statics[__CLASS__][__FUNCTION__][$key])) {
1519       $tokens = array_merge(CRM_Contribute_BAO_Contribution::exportableFields('All'),
1520         ['campaign' => [], 'financial_type' => [], 'payment_instrument' => []],
1521         self::getCustomFieldTokens('Contribution'),
1522         [
1523           'financial_type_id:label',
1524           'financial_type_id:name',
1525           'contribution_page_id:label',
1526           'contribution_page_id:name',
1527           'payment_instrument_id:label',
1528           'payment_instrument_id:name',
1529           'is_test:label',
1530           'is_pay_later:label',
1531           'contribution_status_id:label',
1532           'contribution_status_id:name',
1533           'is_template:label',
1534           'campaign_id:label',
1535           'campaign_id:name',
1536         ]
1537       );
1538       foreach ($tokens as $token) {
1539         if (!empty($token['name'])) {
1540           $tokens[$token['name']] = [];
1541         }
1542         elseif (is_string($token) && strpos($token, ':') !== FALSE) {
1543           $tokens[$token] = [];
1544         }
1545       }
1546       Civi::$statics[__CLASS__][__FUNCTION__][$key] = array_keys($tokens);
1547     }
1548     self::$_tokens[$key] = Civi::$statics[__CLASS__][__FUNCTION__][$key];
1549   }
1550
1551   /**
1552    * Do not use.
1553    *
1554    * @deprecated
1555    *
1556    * Replace tokens for an entity.
1557    * @param string $entity
1558    * @param array $entityArray
1559    *   (e.g. in format from api).
1560    * @param string $str
1561    *   String to replace in.
1562    * @param array $knownTokens
1563    *   Array of tokens present.
1564    * @param bool $escapeSmarty
1565    * @return string
1566    *   string with replacements made
1567    */
1568   public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = [], $escapeSmarty = FALSE) {
1569     if (!$knownTokens || empty($knownTokens[$entity])) {
1570       return $str;
1571     }
1572
1573     $fn = 'get' . ucfirst($entity) . 'TokenReplacement';
1574     $fn = is_callable(['CRM_Utils_Token', $fn]) ? $fn : 'getApiTokenReplacement';
1575     // since we already know the tokens lets just use them & do str_replace which is faster & simpler than preg_replace
1576     foreach ($knownTokens[$entity] as $token) {
1577       // We are now supporting the syntax case_type_id:label
1578       // so strip anything after the ':'
1579       // (we aren't supporting 'name' at this stage, so we can assume 'label'
1580       // test cover in TokenConsistencyTest.
1581       $parts = explode(':', $token);
1582       $replacement = self::$fn($entity, $parts[0], $entityArray);
1583       if ($escapeSmarty) {
1584         $replacement = self::tokenEscapeSmarty($replacement);
1585       }
1586       $str = str_replace('{' . $entity . '.' . $token . '}', $replacement, $str);
1587     }
1588     return preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
1589   }
1590
1591   /**
1592    * @deprecated
1593    *
1594    * @param int $caseId
1595    * @param string $str
1596    * @param array $knownTokens
1597    * @param bool $escapeSmarty
1598    * @return string
1599    * @throws \CiviCRM_API3_Exception
1600    */
1601   public static function replaceCaseTokens($caseId, $str, $knownTokens = NULL, $escapeSmarty = FALSE): string {
1602     if (strpos($str, '{case.') === FALSE) {
1603       return $str;
1604     }
1605     if (!$knownTokens) {
1606       $knownTokens = self::getTokens($str);
1607     }
1608     $case = civicrm_api3('case', 'getsingle', ['id' => $caseId]);
1609     return self::replaceEntityTokens('case', $case, $str, $knownTokens, $escapeSmarty);
1610   }
1611
1612   /**
1613    * Generic function for formatting token replacement for an api field
1614    *
1615    * @deprecated
1616    *
1617    * @param string $entity
1618    * @param string $token
1619    * @param array $entityArray
1620    * @return string
1621    * @throws \CiviCRM_API3_Exception
1622    */
1623   public static function getApiTokenReplacement($entity, $token, $entityArray) {
1624     if (!isset($entityArray[$token])) {
1625       return '';
1626     }
1627     $field = civicrm_api3($entity, 'getfield', ['action' => 'get', 'name' => $token, 'get_options' => 'get']);
1628     $field = $field['values'];
1629     $fieldType = $field['type'] ?? NULL;
1630     // Boolean fields
1631     if ($fieldType == CRM_Utils_Type::T_BOOLEAN && empty($field['options'])) {
1632       $field['options'] = [ts('No'), ts('Yes')];
1633     }
1634     // Match pseudoconstants
1635     if (!empty($field['options'])) {
1636       $ret = [];
1637       foreach ((array) $entityArray[$token] as $val) {
1638         $ret[] = $field['options'][$val];
1639       }
1640       return implode(', ', $ret);
1641     }
1642     // Format date fields
1643     elseif ($entityArray[$token] && in_array($fieldType, [CRM_Utils_Type::T_DATE, CRM_Utils_Type::T_TIMESTAMP, (CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME)])) {
1644       return CRM_Utils_Date::customFormat($entityArray[$token]);
1645     }
1646     return implode(', ', (array) $entityArray[$token]);
1647   }
1648
1649   /**
1650    * Do not use - unused in core.
1651    *
1652    * Replace Contribution tokens in html.
1653    *
1654    * @param string $str
1655    * @param array $contribution
1656    * @param bool|string $html
1657    * @param string $knownTokens
1658    * @param bool|string $escapeSmarty
1659    *
1660    * @deprecated
1661    *
1662    * @return mixed
1663    */
1664   public static function replaceContributionTokens($str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) {
1665     $key = 'contribution';
1666     if (!$knownTokens || empty($knownTokens[$key])) {
1667       //early return
1668       return $str;
1669     }
1670
1671     // here we intersect with the list of pre-configured valid tokens
1672     // so that we remove anything we do not recognize
1673     // I hope to move this step out of here soon and
1674     // then we will just iterate on a list of tokens that are passed to us
1675
1676     $str = preg_replace_callback(
1677       self::tokenRegex($key),
1678       function ($matches) use (&$contribution, $html, $escapeSmarty) {
1679         return CRM_Utils_Token::getContributionTokenReplacement($matches[1], $contribution, $html, $escapeSmarty);
1680       },
1681       $str
1682     );
1683
1684     $str = preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
1685     return $str;
1686   }
1687
1688   /**
1689    * We have a situation where we are rendering more than one token in each field because we are combining
1690    * tokens from more than one contribution when pdf thank you letters are grouped (CRM-14367)
1691    *
1692    * The replaceContributionToken doesn't handle receive_date correctly in this scenario because of the formatting
1693    * it applies (other tokens are OK including date fields)
1694    *
1695    * So we sort this out & then call the main function. Note that we are not escaping smarty on this fields like the main function
1696    * does - but the fields is already being formatted through a date function
1697    *
1698    * @param string $separator
1699    * @param string $str
1700    * @param array $contributions
1701    * @param array $knownTokens
1702    *
1703    * @deprecated
1704    *
1705    * @return string
1706    */
1707   public static function replaceMultipleContributionTokens(string $separator, string $str, array $contributions, array $knownTokens): string {
1708     CRM_Core_Error::deprecatedFunctionWarning('no alternative');
1709     foreach ($knownTokens['contribution'] ?? [] as $token) {
1710       $resolvedTokens = [];
1711       foreach ($contributions as $contribution) {
1712         $resolvedTokens[] = self::replaceContributionTokens('{contribution.' . $token . '}', $contribution, FALSE, $knownTokens);
1713       }
1714       $str = self::token_replace('contribution', $token, implode($separator, $resolvedTokens), $str);
1715     }
1716     return $str;
1717   }
1718
1719   /**
1720    * Get replacement strings for any membership tokens (only a small number of tokens are implemnted in the first instance
1721    * - this is used by the pdfLetter task from membership search
1722    *
1723    * This is called via replaceEntityTokens.
1724    *
1725    * In the near term it will not be called at all from core as
1726    * the pdf letter task is updated to use the processor.
1727    *
1728    * @deprecated
1729    *
1730    * @param string $entity
1731    *   should always be "membership"
1732    * @param string $token
1733    *   field name
1734    * @param array $membership
1735    *   An api result array for a single membership.
1736    * @return string token replacement
1737    */
1738   public static function getMembershipTokenReplacement($entity, $token, $membership) {
1739     $supportedTokens = [
1740       'id',
1741       'status',
1742       'status_id',
1743       'type',
1744       'membership_type_id',
1745       'start_date',
1746       'join_date',
1747       'end_date',
1748       'fee',
1749     ];
1750     switch ($token) {
1751       case 'type':
1752         // membership_type_id would only be requested if the calling
1753         // class is mapping it to '{membership:membership_type_id:label'}
1754       case 'membership_type_id':
1755         $value = $membership['membership_name'];
1756         break;
1757
1758       case 'status':
1759         // status_id would only be requested if the calling
1760         // class is mapping it to '{membership:status_id:label'}
1761       case 'status_id':
1762         $statuses = CRM_Member_BAO_Membership::buildOptions('status_id');
1763         $value = $statuses[$membership['status_id']];
1764         break;
1765
1766       case 'fee':
1767         try {
1768           $value = civicrm_api3('membership_type', 'getvalue', [
1769             'id' => $membership['membership_type_id'],
1770             'return' => 'minimum_fee',
1771           ]);
1772           $value = CRM_Utils_Money::format($value, NULL, NULL, TRUE);
1773         }
1774         catch (CiviCRM_API3_Exception $e) {
1775           // we can anticipate we will get an error if the minimum fee is set to 'NULL' because of the way the
1776           // api handles NULL (4.4)
1777           $value = 0;
1778         }
1779         break;
1780
1781       default:
1782         if (in_array($token, $supportedTokens)) {
1783           $value = $membership[$token];
1784           if (CRM_Utils_String::endsWith($token, '_date')) {
1785             $value = CRM_Utils_Date::customFormat($value);
1786           }
1787         }
1788         else {
1789           // ie unchanged
1790           $value = "{$entity}.{$token}";
1791         }
1792         break;
1793     }
1794
1795     return $value;
1796   }
1797
1798   /**
1799    * Do not use - unused in core.
1800    *
1801    * @param $token
1802    * @param $contribution
1803    * @param bool $html
1804    * @param bool $escapeSmarty
1805    *
1806    * @deprecated
1807    *
1808    * @return mixed|string
1809    * @throws \CRM_Core_Exception
1810    */
1811   public static function getContributionTokenReplacement($token, $contribution, $html = FALSE, $escapeSmarty = FALSE) {
1812     self::_buildContributionTokens();
1813
1814     switch ($token) {
1815       case 'total_amount':
1816       case 'net_amount':
1817       case 'fee_amount':
1818       case 'non_deductible_amount':
1819         // FIXME: Is this ever a multi-dimensional array?  Why use retrieveValueRecursive()?
1820         $amount = CRM_Utils_Array::retrieveValueRecursive($contribution, $token);
1821         $currency = CRM_Utils_Array::retrieveValueRecursive($contribution, 'currency');
1822         $value = CRM_Utils_Money::format($amount, $currency);
1823         break;
1824
1825       case 'receive_date':
1826       case 'receipt_date':
1827         $value = CRM_Utils_Array::retrieveValueRecursive($contribution, $token);
1828         $config = CRM_Core_Config::singleton();
1829         $value = CRM_Utils_Date::customFormat($value, $config->dateformatDatetime);
1830         break;
1831
1832       case 'source':
1833         $value = CRM_Utils_Array::retrieveValueRecursive($contribution, 'contribution_source');
1834         break;
1835
1836       default:
1837         if (!in_array($token, self::$_tokens['contribution'])) {
1838           $value = "{contribution.$token}";
1839         }
1840         else {
1841           $value = CRM_Utils_Array::retrieveValueRecursive($contribution, $token);
1842         }
1843         break;
1844     }
1845
1846     if ($escapeSmarty) {
1847       $value = self::tokenEscapeSmarty($value);
1848     }
1849     return $value;
1850   }
1851
1852   /**
1853    * @deprecated
1854    *
1855    * Only used from deprecated functions not called by core.
1856    *
1857    * @return array
1858    *   [legacy_token => new_token]
1859    */
1860   public static function legacyContactTokens() {
1861     return [
1862       'individual_prefix' => 'prefix_id',
1863       'individual_suffix' => 'suffix_id',
1864       'gender' => 'gender_id',
1865       'communication_style' => 'communication_style_id',
1866     ];
1867   }
1868
1869   /**
1870    * Get all custom field tokens of $entity
1871    *
1872    * @deprecated
1873    *
1874    * @param string $entity
1875    * @return array
1876    *   return custom field tokens in array('custom_N' => 'label') format
1877    */
1878   public static function getCustomFieldTokens($entity) {
1879     $customTokens = [];
1880     foreach (CRM_Core_BAO_CustomField::getFields($entity) as $id => $info) {
1881       $customTokens['custom_' . $id] = $info['label'] . ' :: ' . $info['groupTitle'];
1882     }
1883     return $customTokens;
1884   }
1885
1886   /**
1887    * Formats a token list for the select2 widget
1888    *
1889    * @param $tokens
1890    * @return array
1891    */
1892   public static function formatTokensForDisplay($tokens) {
1893     $sorted = $output = [];
1894
1895     // Sort in ascending order by ignoring word case
1896     natcasesort($tokens);
1897
1898     // Attempt to place tokens into optgroups
1899     // @todo These groupings could be better and less hackish. Getting them pre-grouped from upstream would be nice.
1900     foreach ($tokens as $k => $v) {
1901       // Check to see if this token is already in a group e.g. for custom fields
1902       $split = explode(' :: ', $v);
1903       if (!empty($split[1])) {
1904         $sorted[$split[1]][] = ['id' => $k, 'text' => $split[0]];
1905       }
1906       // Group by entity
1907       else {
1908         $split = explode('.', trim($k, '{}'));
1909         if (isset($split[1])) {
1910           $entity = array_key_exists($split[1], CRM_Core_DAO_Address::export()) ? 'Address' : ucwords(str_replace('_', ' ', $split[0]));
1911         }
1912         else {
1913           $entity = 'Contact';
1914         }
1915         $sorted[ts($entity)][] = ['id' => $k, 'text' => $v];
1916       }
1917     }
1918
1919     ksort($sorted);
1920     foreach ($sorted as $k => $v) {
1921       $output[] = ['text' => $k, 'children' => $v];
1922     }
1923
1924     return $output;
1925   }
1926
1927   /**
1928    * @param $value
1929    * @param $token
1930    *
1931    * @return bool|int|mixed|string|null
1932    */
1933   protected static function convertPseudoConstantsUsingMetadata($value, $token) {
1934     // Convert pseudoconstants using metadata
1935     if ($value && is_numeric($value)) {
1936       $allFields = CRM_Contact_BAO_Contact::exportableFields('All');
1937       if (!empty($allFields[$token]['pseudoconstant'])) {
1938         $value = CRM_Core_PseudoConstant::getLabel('CRM_Contact_BAO_Contact', $token, $value);
1939       }
1940     }
1941     elseif ($value && CRM_Utils_String::endsWith($token, '_date')) {
1942       $value = CRM_Utils_Date::customFormat($value);
1943     }
1944     return $value;
1945   }
1946
1947   /**
1948    * Get token deprecation information.
1949    *
1950    * @return array
1951    */
1952   public static function getTokenDeprecations(): array {
1953     return [
1954       'WorkFlowMessageTemplates' => [
1955         'contribution_invoice_receipt' => [
1956           '$display_name' => 'contact.display_name',
1957         ],
1958         'contribution_online_receipt' => [
1959           '$contributeMode' => 'no longer available / relevant',
1960           '$first_name' => 'contact.first_name',
1961           '$last_name' => 'contact.last_name',
1962           '$displayName' => 'contact.display_name',
1963         ],
1964         'membership_offline_receipt' => [
1965           // receipt_text_renewal appears to be long gone.
1966           'receipt_text_renewal' => 'receipt_text',
1967         ],
1968         'pledge_acknowledgement' => [
1969           '$domain' => 'no longer available / relevant',
1970           '$contact' => 'no longer available / relevant',
1971         ],
1972         'pledge_reminder' => [
1973           '$domain' => 'no longer available / relevant',
1974           '$contact' => 'no longer available / relevant',
1975         ],
1976       ],
1977     ];
1978   }
1979
1980 }