CRM/Utils/Token.php

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