CRM/Mailing/BAO/Mailing.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 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 require_once 'Mail/mime.php';
  18
  19 /**
  20  * Class CRM_Mailing_BAO_Mailing
  21  */
  22 class CRM_Mailing_BAO_Mailing extends CRM_Mailing_DAO_Mailing {
  23
  24   /**
  25    * An array that holds the complete templates
  26    * including any headers or footers that need to be prepended
  27    * or appended to the body.
  28    * @var array
  29    */
  30   private $preparedTemplates = NULL;
  31
  32   /**
  33    * An array that holds the complete templates
  34    * including any headers or footers that need to be prepended
  35    * or appended to the body.
  36    * @var array
  37    */
  38   private $templates = NULL;
  39
  40   /**
  41    * An array that holds the tokens that are specifically found in our text and html bodies.
  42    * @var array
  43    */
  44   private $tokens = NULL;
  45
  46   /**
  47    * An array that holds the tokens that are specifically found in our text and html bodies.
  48    * @var array
  49    */
  50   private $flattenedTokens = NULL;
  51
  52   /**
  53    * The header associated with this mailing.
  54    * @var string
  55    */
  56   private $header = NULL;
  57
  58   /**
  59    * The footer associated with this mailing.
  60    * @var string
  61    */
  62   private $footer = NULL;
  63
  64   /**
  65    * The HTML content of the message.
  66    * @var string
  67    */
  68   private $html = NULL;
  69
  70   /**
  71    * The text content of the message.
  72    * @var string
  73    */
  74   private $text = NULL;
  75
  76   /**
  77    * Cached BAO for the domain.
  78    * @var int
  79    */
  80   private $_domain = NULL;
  81
  82   /**
  83    * Class constructor.
  84    */
  85   public function __construct() {
  86     parent::__construct();
  87   }
  88
  89   /**
  90    * @deprecated
  91    *
  92    * @param int $mailingID
  93    *
  94    * @return int
  95    */
  96   public static function getRecipientsCount($mailingID) {
  97     //rebuild the recipients
  98     self::getRecipients($mailingID);
  99
 100     return civicrm_api3('MailingRecipients', 'getcount', ['mailing_id' => $mailingID]);
 101   }
 102
 103   /**
 104    * This function retrieve recipients of selected mailing groups.
 105    *
 106    * @param int $mailingID
 107    *
 108    * @return void
 109    */
 110   public static function getRecipients($mailingID) {
 111     // load mailing object
 112     $mailingObj = new self();
 113     $mailingObj->id = $mailingID;
 114     $mailingObj->find(TRUE);
 115
 116     $mailing = CRM_Mailing_BAO_Mailing::getTableName();
 117     $contact = CRM_Contact_DAO_Contact::getTableName();
 118     $isSMSmode = (!CRM_Utils_System::isNull($mailingObj->sms_provider_id));
 119
 120     $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
 121     $recipientsGroup = $excludeSmartGroupIDs = $includeSmartGroupIDs = $priorMailingIDs = [];
 122     $dao = CRM_Utils_SQL_Select::from('civicrm_mailing_group')
 123       ->select('GROUP_CONCAT(DISTINCT entity_id SEPARATOR ",") as group_ids, group_type, entity_table')
 124       ->where('mailing_id = #mailing_id AND entity_table RLIKE "^civicrm_(group.*|mailing)$" ')
 125       ->groupBy(['group_type', 'entity_table'])
 126       ->param('!groupTableName', CRM_Contact_BAO_Group::getTableName())
 127       ->param('#mailing_id', $mailingID)
 128       ->execute();
 129     while ($dao->fetch()) {
 130       if ($dao->entity_table == 'civicrm_mailing') {
 131         $priorMailingIDs[$dao->group_type] = explode(',', $dao->group_ids);
 132       }
 133       else {
 134         $recipientsGroup[$dao->group_type] = empty($recipientsGroup[$dao->group_type]) ? explode(',', $dao->group_ids) : array_merge($recipientsGroup[$dao->group_type], explode(',', $dao->group_ids));
 135       }
 136     }
 137
 138     // there is no need to proceed further if no mailing group is selected to include recipients,
 139     // but before return clear the mailing recipients populated earlier since as per current params no group is selected
 140     if (empty($recipientsGroup['Include']) && empty($priorMailingIDs['Include'])) {
 141       CRM_Core_DAO::executeQuery(" DELETE FROM civicrm_mailing_recipients WHERE  mailing_id = %1 ", [
 142         1 => [
 143           $mailingID,
 144           'Integer',
 145         ],
 146       ]);
 147       return;
 148     }
 149
 150     list($location_filter, $order_by) = self::getLocationFilterAndOrderBy($mailingObj->email_selection_method, $mailingObj->location_type_id);
 151
 152     // get all the saved searches AND hierarchical groups
 153     // and load them in the cache
 154     foreach ($recipientsGroup as $groupType => $groupIDs) {
 155       $groupDAO = CRM_Utils_SQL_Select::from('civicrm_group')
 156         ->where('id IN (#groupIDs)')
 157         ->where('saved_search_id != 0 OR saved_search_id IS NOT NULL OR children IS NOT NULL')
 158         ->param('#groupIDs', $groupIDs)
 159         ->execute();
 160       while ($groupDAO->fetch()) {
 161         // hidden smart groups always have a cache date and there is no other way
 162         //  we can rebuilt the contact list from UI so consider such smart group
 163         if ($groupDAO->cache_date == NULL || $groupDAO->is_hidden) {
 164           CRM_Contact_BAO_GroupContactCache::load($groupDAO);
 165         }
 166         if ($groupType == 'Include') {
 167           $includeSmartGroupIDs[] = $groupDAO->id;
 168         }
 169         elseif ($groupType == 'Exclude') {
 170           $excludeSmartGroupIDs[] = $groupDAO->id;
 171         }
 172         //NOTE: Do nothing for base
 173       }
 174     }
 175
 176     // Create a temp table for contact exclusion.
 177     $excludeTempTable = CRM_Utils_SQL_TempTable::build()->setCategory('exrecipient')->setMemory()->createWithColumns('contact_id int primary key');
 178     $excludeTempTablename = $excludeTempTable->getName();
 179     // populate exclude temp-table with recipients to be excluded from the list
 180     //  on basis of selected recipients groups and/or previous mailing
 181     if (!empty($recipientsGroup['Exclude'])) {
 182       CRM_Utils_SQL_Select::from('civicrm_group_contact')
 183         ->select('DISTINCT contact_id')
 184         ->where('status = "Added" AND group_id IN (#groups)')
 185         ->param('#groups', $recipientsGroup['Exclude'])
 186         ->insertInto($excludeTempTablename, ['contact_id'])
 187         ->execute();
 188
 189       if (count($excludeSmartGroupIDs)) {
 190         CRM_Utils_SQL_Select::from('civicrm_group_contact_cache')
 191           ->select('contact_id')
 192           ->where('group_id IN (#groups)')
 193           ->param('#groups', $excludeSmartGroupIDs)
 194           ->insertIgnoreInto($excludeTempTablename, ['contact_id'])
 195           ->execute();
 196       }
 197     }
 198     if (!empty($priorMailingIDs['Exclude'])) {
 199       CRM_Utils_SQL_Select::from('civicrm_mailing_recipients')
 200         ->select('DISTINCT contact_id')
 201         ->where('mailing_id IN (#mailings)')
 202         ->param('#mailings', $priorMailingIDs['Exclude'])
 203         ->insertIgnoreInto($excludeTempTablename, ['contact_id'])
 204         ->execute();
 205     }
 206
 207     if (!empty($recipientsGroup['Base'])) {
 208       CRM_Utils_SQL_Select::from('civicrm_group_contact')
 209         ->select('DISTINCT contact_id')
 210         ->where('status = "Removed" AND group_id IN (#groups)')
 211         ->param('#groups', $recipientsGroup['Base'])
 212         ->insertIgnoreInto($excludeTempTablename, ['contact_id'])
 213         ->execute();
 214     }
 215
 216     $entityColumn = $isSMSmode ? 'phone_id' : 'email_id';
 217     $entityTable = $isSMSmode ? CRM_Core_DAO_Phone::getTableName() : CRM_Core_DAO_Email::getTableName();
 218     // Get all the group contacts we want to include.
 219     $includedTempTable = CRM_Utils_SQL_TempTable::build()->setCategory('inrecipient')->setMemory()->createWithColumns('contact_id int primary key, ' . $entityColumn . ' int');
 220     $includedTempTablename = $includedTempTable->getName();
 221
 222     if ($isSMSmode) {
 223       $criteria = [
 224         'is_opt_out' => CRM_Utils_SQL_Select::fragment()->where("$contact.is_opt_out = 0"),
 225         'is_deceased' => CRM_Utils_SQL_Select::fragment()->where("$contact.is_deceased <> 1"),
 226         'do_not_sms' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_sms = 0"),
 227         'location_filter' => CRM_Utils_SQL_Select::fragment()->where("$entityTable.phone_type_id = " . CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_Phone', 'phone_type_id', 'Mobile')),
 228         'phone_not_null' => CRM_Utils_SQL_Select::fragment()->where("$entityTable.phone IS NOT NULL"),
 229         'phone_not_empty' => CRM_Utils_SQL_Select::fragment()->where("$entityTable.phone != ''"),
 230         'mailing_id' => CRM_Utils_SQL_Select::fragment()->where("mg.mailing_id = #mailingID"),
 231         'temp_contact_null' => CRM_Utils_SQL_Select::fragment()->where('temp.contact_id IS null'),
 232         'order_by' => CRM_Utils_SQL_Select::fragment()->orderBy("$entityTable.is_primary"),
 233       ];
 234     }
 235     else {
 236       // Criterias to filter recipients that need to be included
 237       $criteria = [
 238         'do_not_email' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_email = 0"),
 239         'is_opt_out' => CRM_Utils_SQL_Select::fragment()->where("$contact.is_opt_out = 0"),
 240         'is_deceased' => CRM_Utils_SQL_Select::fragment()->where("$contact.is_deceased <> 1"),
 241         'location_filter' => CRM_Utils_SQL_Select::fragment()->where($location_filter),
 242         'email_not_null' => CRM_Utils_SQL_Select::fragment()->where("$entityTable.email IS NOT NULL"),
 243         'email_not_empty' => CRM_Utils_SQL_Select::fragment()->where("$entityTable.email != ''"),
 244         'email_not_on_hold' => CRM_Utils_SQL_Select::fragment()->where("$entityTable.on_hold = 0"),
 245         'mailing_id' => CRM_Utils_SQL_Select::fragment()->where("mg.mailing_id = #mailingID"),
 246         'temp_contact_null' => CRM_Utils_SQL_Select::fragment()->where('temp.contact_id IS NULL'),
 247         'order_by' => CRM_Utils_SQL_Select::fragment()->orderBy($order_by),
 248       ];
 249     }
 250
 251     // Allow user to alter query responsible to fetch mailing recipients before build,
 252     //   by changing the mail filters identified $params
 253     CRM_Utils_Hook::alterMailingRecipients($mailingObj, $criteria, 'pre');
 254
 255     // Get the group contacts, but only those which are not in the
 256     // exclusion temp table.
 257     if (!empty($recipientsGroup['Include'])) {
 258       CRM_Utils_SQL_Select::from($entityTable)
 259         ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
 260         ->join($contact, " INNER JOIN $contact ON $entityTable.contact_id = $contact.id ")
 261         ->join('gc', " INNER JOIN civicrm_group_contact gc ON gc.contact_id = $contact.id ")
 262         ->join('mg', " INNER JOIN civicrm_mailing_group mg  ON  gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
 263         ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
 264         ->where('gc.group_id IN (#groups) AND gc.status = "Added"')
 265         ->merge($criteria)
 266         ->groupBy(["$contact.id", "$entityTable.id"])
 267         ->replaceInto($includedTempTablename, ['contact_id', $entityColumn])
 268         ->param('#groups', $recipientsGroup['Include'])
 269         ->param('#mailingID', $mailingID)
 270         ->execute();
 271     }
 272
 273     // Get recipients selected in prior mailings
 274     if (!empty($priorMailingIDs['Include'])) {
 275       CRM_Utils_SQL_Select::from('civicrm_mailing_recipients')
 276         ->select("DISTINCT civicrm_mailing_recipients.contact_id, $entityColumn")
 277         ->join('temp', " LEFT JOIN $excludeTempTablename temp ON civicrm_mailing_recipients.contact_id = temp.contact_id ")
 278         ->where('mailing_id IN (#mailings)')
 279         ->where('temp.contact_id IS NULL')
 280         ->param('#mailings', $priorMailingIDs['Include'])
 281         ->insertIgnoreInto($includedTempTablename, [
 282           'contact_id',
 283           $entityColumn,
 284         ])
 285         ->execute();
 286     }
 287
 288     if (count($includeSmartGroupIDs)) {
 289       $query = CRM_Utils_SQL_Select::from($contact)
 290         ->select("$contact.id as contact_id, $entityTable.id as $entityColumn")
 291         ->join($entityTable, " INNER JOIN $entityTable ON $entityTable.contact_id = $contact.id ")
 292         ->join('gc', " INNER JOIN civicrm_group_contact_cache gc ON $contact.id = gc.contact_id ")
 293         ->join('gcr', " LEFT JOIN civicrm_group_contact gcr ON gc.group_id = gcr.group_id AND gc.contact_id = gcr.contact_id")
 294         ->join('mg', " INNER JOIN civicrm_mailing_group mg  ON  gc.group_id = mg.entity_id AND mg.search_id IS NULL ")
 295         ->join('temp', " LEFT JOIN $excludeTempTablename temp ON $contact.id = temp.contact_id ")
 296         ->where('gc.group_id IN (#groups)')
 297         ->where('gcr.status IS NULL OR gcr.status != "Removed"')
 298         ->merge($criteria)
 299         ->replaceInto($includedTempTablename, ['contact_id', $entityColumn])
 300         ->param('#groups', $includeSmartGroupIDs)
 301         ->param('#mailingID', $mailingID)
 302         ->execute();
 303     }
 304
 305     // Construct the filtered search queries.
 306     $dao = CRM_Utils_SQL_Select::from('civicrm_mailing_group')
 307       ->select('search_id, search_args, entity_id')
 308       ->where('search_id IS NOT NULL AND mailing_id = #mailingID')
 309       ->param('#mailingID', $mailingID)
 310       ->execute();
 311     while ($dao->fetch()) {
 312       $customSQL = CRM_Contact_BAO_SearchCustom::civiMailSQL($dao->search_id,
 313         $dao->search_args,
 314         $dao->entity_id
 315       );
 316       $query = "REPLACE INTO {$includedTempTablename} ($entityColumn, contact_id) {$customSQL} ";
 317       $mailingGroup->query($query);
 318     }
 319
 320     list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause();
 321
 322     // clear all the mailing recipients before populating
 323     CRM_Core_DAO::executeQuery(" DELETE FROM civicrm_mailing_recipients WHERE  mailing_id = %1 ", [
 324       1 => [
 325         $mailingID,
 326         'Integer',
 327       ],
 328     ]);
 329
 330     $selectClause = ['#mailingID', 'i.contact_id', "i.$entityColumn"];
 331     // CRM-3975
 332     $orderBy = ["i.contact_id", "i.$entityColumn"];
 333
 334     $query = CRM_Utils_SQL_Select::from('civicrm_contact contact_a')
 335       ->join('i', " INNER JOIN {$includedTempTablename} i ON contact_a.id = i.contact_id ");
 336     if (!$isSMSmode && $mailingObj->dedupe_email) {
 337       $orderBy = ["MIN(i.contact_id)", "MIN(i.$entityColumn)"];
 338       $query = $query->join('e', " INNER JOIN civicrm_email e ON e.id = i.email_id ")
 339         ->groupBy("e.email");
 340       if (CRM_Utils_SQL::supportsFullGroupBy()) {
 341         $selectClause = [
 342           '#mailingID',
 343           'ANY_VALUE(i.contact_id) contact_id',
 344           "ANY_VALUE(i.$entityColumn) $entityColumn",
 345           "e.email",
 346         ];
 347       }
 348     }
 349
 350     $query = $query->select($selectClause)->orderBy($orderBy);
 351     if (!CRM_Utils_System::isNull($aclFrom)) {
 352       $query = $query->join('acl', $aclFrom);
 353     }
 354     if (!CRM_Utils_System::isNull($aclWhere)) {
 355       $query = $query->where($aclWhere);
 356     }
 357
 358     // this mean if dedupe_email AND the mysql 5.7 supports ONLY_FULL_GROUP_BY mode then as
 359     //  SELECT must contain 'email' column as its used in GROUP BY, so in order to resolve This
 360     //  here the whole SQL code is wrapped up in FROM table i and not selecting email column for INSERT
 361     if ($key = array_search('e.email', $selectClause)) {
 362       unset($selectClause[$key]);
 363       $sql = $query->toSQL();
 364       CRM_Utils_SQL_Select::from("( $sql ) AS i ")
 365         ->select($selectClause)
 366         ->insertInto('civicrm_mailing_recipients', ['mailing_id', 'contact_id', $entityColumn])
 367         ->param('#mailingID', $mailingID)
 368         ->execute();
 369     }
 370     else {
 371       $query->insertInto('civicrm_mailing_recipients', ['mailing_id', 'contact_id', $entityColumn])
 372         ->param('#mailingID', $mailingID)
 373         ->execute();
 374     }
 375
 376     // if we need to add all emails marked bulk, do it as a post filter
 377     // on the mailing recipients table
 378     if (CRM_Core_BAO_Email::isMultipleBulkMail()) {
 379       self::addMultipleEmails($mailingID);
 380     }
 381
 382     // Delete the temp table.
 383     $mailingGroup->reset();
 384     $excludeTempTable->drop();
 385     $includedTempTable->drop();
 386
 387     CRM_Utils_Hook::alterMailingRecipients($mailingObj, $criteria, 'post');
 388   }
 389
 390   /**
 391    * Function to retrieve location filter and order by clause later used by SQL query that is used to fetch and include mailing recipients
 392    *
 393    * @param string $email_selection_method
 394    * @param int $location_type_id
 395    *
 396    * @return array
 397    */
 398   public static function getLocationFilterAndOrderBy($email_selection_method, $location_type_id) {
 399     $email = CRM_Core_DAO_Email::getTableName();
 400     // Note: When determining the ORDER that results are returned, it's
 401     // the record that comes last that counts. That's because we are
 402     // INSERT'ing INTO a table with a primary id so that last record
 403     // over writes any previous record.
 404     switch ($email_selection_method) {
 405       case 'location-exclude':
 406         $location_filter = "($email.location_type_id != $location_type_id)";
 407         // If there is more than one email that doesn't match the location,
 408         // prefer the one marked is_bulkmail, followed by is_primary.
 409         $orderBy = ["$email.is_bulkmail", "$email.is_primary"];
 410         break;
 411
 412       case 'location-only':
 413         $location_filter = "($email.location_type_id = $location_type_id)";
 414         // If there is more than one email of the desired location, prefer
 415         // the one marked is_bulkmail, followed by is_primary.
 416         $orderBy = ["$email.is_bulkmail", "$email.is_primary"];
 417         break;
 418
 419       case 'location-prefer':
 420         $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
 421         // ORDER BY is more complicated because we have to set an arbitrary
 422         // order that prefers the location that we want. We do that using
 423         // the FIELD function. For more info, see:
 424         // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
 425         // We assign the location type we want the value "1" by putting it
 426         // in the first position after we name the field. All other location
 427         // types are left out, so they will be assigned the value 0. That
 428         // means, they will all be equally tied for first place, with our
 429         // location being last.
 430         $orderBy = [
 431           "FIELD($email.location_type_id, $location_type_id)",
 432           "$email.is_bulkmail",
 433           "$email.is_primary",
 434         ];
 435         break;
 436
 437       case 'automatic':
 438         // fall through to default
 439       default:
 440         $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
 441         $orderBy = ["$email.is_bulkmail"];
 442     }
 443
 444     return [$location_filter, $orderBy];
 445   }
 446
 447   /**
 448    * @param string $type
 449    *
 450    * @return array
 451    */
 452   private function _getMailingGroupIds($type = 'Include') {
 453     $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
 454     $group = CRM_Contact_DAO_Group::getTableName();
 455     if (!isset($this->id)) {
 456       // we're just testing tokens, so return any group
 457       $query = "SELECT   id AS entity_id
 458                       FROM     $group
 459                       ORDER BY id
 460                       LIMIT 1";
 461     }
 462     else {
 463       $mg = CRM_Mailing_DAO_MailingGroup::getTableName();
 464       $query = "SELECT entity_id
 465                       FROM   $mg
 466                       WHERE  mailing_id = {$this->id}
 467                       AND    group_type = '$type'
 468                       AND    entity_table = '$group'";
 469     }
 470     $mailingGroup->query($query);
 471
 472     $groupIds = [];
 473     while ($mailingGroup->fetch()) {
 474       $groupIds[] = $mailingGroup->entity_id;
 475     }
 476
 477     return $groupIds;
 478   }
 479
 480   /**
 481    * Returns the regex patterns that are used for preparing the text and html templates.
 482    *
 483    * @param bool $onlyHrefs
 484    *
 485    * @return array|string
 486    */
 487   private function getPatterns($onlyHrefs = FALSE) {
 488
 489     $patterns = [];
 490
 491     $protos = '(https?|ftp|mailto)';
 492     $letters = '\w';
 493     $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
 494     $punc = '.:?\-';
 495     $any = "{$letters}{$gunk}{$punc}";
 496     if ($onlyHrefs) {
 497       $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
 498     }
 499     else {
 500       $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
 501     }
 502
 503     $patterns[] = $pattern;
 504     $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
 505     $patterns[] = '\{\w+\.\w+\}';
 506
 507     $patterns = '{' . implode('|', $patterns) . '}imu';
 508
 509     return $patterns;
 510   }
 511
 512   /**
 513    * Returns an array that denotes the type of token that we are dealing with
 514    * we use the type later on when we are doing a token replacement lookup
 515    *
 516    * @param string $token
 517    *   The token for which we will be doing adata lookup.
 518    *
 519    * @return array
 520    *   An array that holds the token itself and the type.
 521    *                             the type will tell us which function to use for the data lookup
 522    *                             if we need to do a lookup at all
 523    */
 524   public function &getDataFunc($token) {
 525     static $_categories = NULL;
 526     static $_categoryString = NULL;
 527     if (!$_categories) {
 528       $_categories = [
 529         'domain' => NULL,
 530         'action' => NULL,
 531         'mailing' => NULL,
 532         'contact' => NULL,
 533       ];
 534
 535       CRM_Utils_Hook::tokens($_categories);
 536       $_categoryString = implode('|', array_keys($_categories));
 537     }
 538
 539     $funcStruct = ['type' => NULL, 'token' => $token];
 540     $matches = [];
 541     if ((preg_match('/^href/i', $token) || preg_match('/^http/i', $token))) {
 542       // it is a url so we need to check to see if there are any tokens embedded
 543       // if so then call this function again to get the token dataFunc
 544       // and assign the type 'embedded'  so that the data retrieving function
 545       // will know what how to handle this token.
 546       if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
 547         $funcStruct['type'] = 'embedded_url';
 548         $funcStruct['embed_parts'] = $funcStruct['token'] = [];
 549         foreach ($matches[1] as $match) {
 550           $preg_token = '/' . preg_quote($match, '/') . '/';
 551           $list = preg_split($preg_token, $token, 2);
 552           $funcStruct['embed_parts'][] = $list[0];
 553           $token = $list[1];
 554           $funcStruct['token'][] = $this->getDataFunc($match);
 555         }
 556         // fixed truncated url, CRM-7113
 557         if ($token) {
 558           $funcStruct['embed_parts'][] = $token;
 559         }
 560       }
 561       else {
 562         $funcStruct['type'] = 'url';
 563       }
 564     }
 565     elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
 566       $funcStruct['type'] = $matches[1];
 567       $funcStruct['token'] = $matches[2];
 568     }
 569     elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
 570       // we are an escaped token
 571       // so remove the escape chars
 572       $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
 573       $funcStruct['token'] = '{' . $unescaped_token . '}';
 574     }
 575     return $funcStruct;
 576   }
 577
 578   /**
 579    * Prepares the text and html templates
 580    * for generating the emails and returns a copy of the
 581    * prepared templates
 582    *
 583    * @deprecated
 584    *   This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
 585    */
 586   private function getPreparedTemplates() {
 587     if (!$this->preparedTemplates) {
 588       $patterns['html'] = $this->getPatterns(TRUE);
 589       $patterns['subject'] = $patterns['text'] = $this->getPatterns();
 590       $templates = $this->getTemplates();
 591
 592       $this->preparedTemplates = [];
 593
 594       foreach ([
 595         'html',
 596         'text',
 597         'subject',
 598       ] as $key) {
 599         if (!isset($templates[$key])) {
 600           continue;
 601         }
 602
 603         $matches = [];
 604         $tokens = [];
 605         $split_template = [];
 606
 607         $email = $templates[$key];
 608         preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER);
 609         foreach ($matches[0] as $idx => $token) {
 610           $preg_token = '/' . preg_quote($token, '/') . '/im';
 611           list($split_template[], $email) = preg_split($preg_token, $email, 2);
 612           array_push($tokens, $this->getDataFunc($token));
 613         }
 614         if ($email) {
 615           $split_template[] = $email;
 616         }
 617         $this->preparedTemplates[$key]['template'] = $split_template;
 618         $this->preparedTemplates[$key]['tokens'] = $tokens;
 619       }
 620     }
 621     return ($this->preparedTemplates);
 622   }
 623
 624   /**
 625    * Retrieve a ref to an array that holds the email and text templates for this email
 626    * assembles the complete template including the header and footer
 627    * that the user has uploaded or declared (if they have done that)
 628    *
 629    * @return array
 630    *   reference to an assoc array
 631    */
 632   public function getTemplates() {
 633     if (!$this->templates) {
 634       $this->getHeaderFooter();
 635       $this->templates = [];
 636       if ($this->body_text || !empty($this->header)) {
 637         $template = [];
 638         if (!empty($this->header->body_text)) {
 639           $template[] = $this->header->body_text;
 640         }
 641         elseif (!empty($this->header->body_html)) {
 642           $template[] = CRM_Utils_String::htmlToText($this->header->body_html);
 643         }
 644
 645         if ($this->body_text) {
 646           $template[] = $this->body_text;
 647         }
 648         else {
 649           $template[] = CRM_Utils_String::htmlToText($this->body_html);
 650         }
 651
 652         if (!empty($this->footer->body_text)) {
 653           $template[] = $this->footer->body_text;
 654         }
 655         elseif (!empty($this->footer->body_html)) {
 656           $template[] = CRM_Utils_String::htmlToText($this->footer->body_html);
 657         }
 658
 659         $this->templates['text'] = implode("\n", $template);
 660       }
 661
 662       // To check for an html part strip tags
 663       if (trim(strip_tags($this->body_html, '<img>'))) {
 664
 665         $template = [];
 666         if ($this->header) {
 667           $template[] = $this->header->body_html;
 668         }
 669
 670         $template[] = $this->body_html;
 671
 672         if ($this->footer) {
 673           $template[] = $this->footer->body_html;
 674         }
 675
 676         $this->templates['html'] = implode("\n", $template);
 677
 678         // this is where we create a text template from the html template if the text template did not exist
 679         // this way we ensure that every recipient will receive an email even if the pref is set to text and the
 680         // user uploads an html email only
 681         if (empty($this->templates['text'])) {
 682           $this->templates['text'] = CRM_Utils_String::htmlToText($this->templates['html']);
 683         }
 684       }
 685
 686       if ($this->subject) {
 687         $template = [];
 688         $template[] = $this->subject;
 689         $this->templates['subject'] = implode("\n", $template);
 690       }
 691
 692       $this->templates['mailingID'] = $this->id;
 693       $this->templates['campaign_id'] = $this->campaign_id;
 694       $this->templates['template_type'] = $this->template_type;
 695       CRM_Utils_Hook::alterMailContent($this->templates);
 696     }
 697     return $this->templates;
 698   }
 699
 700   /**
 701    *
 702    *  Retrieve a ref to an array that holds all of the tokens in the email body
 703    *  where the keys are the type of token and the values are ordinal arrays
 704    *  that hold the token names (even repeated tokens) in the order in which
 705    *  they appear in the body of the email.
 706    *
 707    *  note: the real work is done in the _getTokens() function
 708    *
 709    *  this function needs to have some sort of a body assigned
 710    *  either text or html for this to have any meaningful impact
 711    *
 712    * @return array
 713    *   reference to an assoc array
 714    */
 715   public function &getTokens() {
 716     if (!$this->tokens) {
 717
 718       $this->tokens = ['html' => [], 'text' => [], 'subject' => []];
 719
 720       if ($this->body_html) {
 721         $this->_getTokens('html');
 722         if (!$this->body_text) {
 723           // Since the text template was created from html, use the html tokens.
 724           // @see CRM_Mailing_BAO_Mailing::getTemplates()
 725           $this->tokens['text'] = $this->tokens['html'];
 726         }
 727       }
 728
 729       if ($this->body_text) {
 730         $this->_getTokens('text');
 731       }
 732
 733       if ($this->subject) {
 734         $this->_getTokens('subject');
 735       }
 736     }
 737
 738     return $this->tokens;
 739   }
 740
 741   /**
 742    * Returns the token set for all 3 parts as one set. This allows it to be sent to the
 743    * hook in one call and standardizes it across other token workflows
 744    *
 745    * @return array
 746    *   reference to an assoc array
 747    */
 748   public function &getFlattenedTokens() {
 749     if (!$this->flattenedTokens) {
 750       $tokens = $this->getTokens();
 751
 752       $this->flattenedTokens = CRM_Utils_Token::flattenTokens($tokens);
 753     }
 754
 755     return $this->flattenedTokens;
 756   }
 757
 758   /**
 759    *
 760    *  _getTokens parses out all of the tokens that have been
 761    *  included in the html and text bodies of the email
 762    *  we get the tokens and then separate them into an
 763    *  internal structure named tokens that has the same
 764    *  form as the static tokens property(?) of the CRM_Utils_Token class.
 765    *  The difference is that there might be repeated token names as we want the
 766    *  structures to represent the order in which tokens were found from left to right, top to bottom.
 767    *
 768    *
 769    * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
 770    *   Name of the property that holds the text that we want to scan for tokens (html, text).
 771    *
 772    * @return void
 773    */
 774   private function _getTokens($prop) {
 775     $templates = $this->getTemplates();
 776
 777     $newTokens = CRM_Utils_Token::getTokens($templates[$prop]);
 778
 779     foreach ($newTokens as $type => $names) {
 780       if (!isset($this->tokens[$prop][$type])) {
 781         $this->tokens[$prop][$type] = [];
 782       }
 783       foreach ($names as $key => $name) {
 784         $this->tokens[$prop][$type][] = $name;
 785       }
 786     }
 787   }
 788
 789   /**
 790    * Generate an event queue for a test job.
 791    *
 792    * @param array $testParams
 793    *   Contains form values.
 794    *
 795    * @return void
 796    */
 797   public function getTestRecipients($testParams) {
 798     if (!empty($testParams['test_group']) && array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant::group())) {
 799       $contacts = civicrm_api('contact', 'get', [
 800         'version' => 3,
 801         'group' => $testParams['test_group'],
 802         'return' => 'id',
 803         'options' => [
 804           'limit' => 100000000000,
 805         ],
 806       ]);
 807
 808       foreach (array_keys($contacts['values']) as $groupContact) {
 809         $query = "
 810 SELECT     civicrm_email.id AS email_id,
 811            civicrm_email.is_primary as is_primary,
 812            civicrm_email.is_bulkmail as is_bulkmail
 813 FROM       civicrm_email
 814 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
 815 WHERE      (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
 816 AND        civicrm_contact.id = {$groupContact}
 817 AND        civicrm_contact.do_not_email = 0
 818 AND        civicrm_contact.is_deceased <> 1
 819 AND        civicrm_email.on_hold = 0
 820 AND        civicrm_contact.is_opt_out = 0
 821 GROUP BY   civicrm_email.id
 822 ORDER BY   civicrm_email.is_bulkmail DESC
 823 ";
 824         $dao = CRM_Core_DAO::executeQuery($query);
 825         if ($dao->fetch()) {
 826           $params = [
 827             'job_id' => $testParams['job_id'],
 828             'email_id' => $dao->email_id,
 829             'contact_id' => $groupContact,
 830           ];
 831           CRM_Mailing_Event_BAO_Queue::create($params);
 832         }
 833       }
 834     }
 835   }
 836
 837   /**
 838    * Load this->header and this->footer.
 839    */
 840   private function getHeaderFooter() {
 841     if (!$this->header and $this->header_id) {
 842       $this->header = new CRM_Mailing_BAO_MailingComponent();
 843       $this->header->id = $this->header_id;
 844       $this->header->find(TRUE);
 845     }
 846
 847     if (!$this->footer and $this->footer_id) {
 848       $this->footer = new CRM_Mailing_BAO_MailingComponent();
 849       $this->footer->id = $this->footer_id;
 850       $this->footer->find(TRUE);
 851     }
 852   }
 853
 854   /**
 855    * Given and array of headers and a prefix, job ID, event queue ID, and hash,
 856    * add a Message-ID header if needed.
 857    *
 858    * i.e. if the global includeMessageId is set and there isn't already a
 859    * Message-ID in the array.
 860    * The message ID is structured the same way as a verp. However no interpretation
 861    * is placed on the values received, so they do not need to follow the verp
 862    * convention.
 863    *
 864    * @param array $headers
 865    *   Array of message headers to update, in-out.
 866    * @param string $prefix
 867    *   Prefix for the message ID, use same prefixes as verp.
 868    *                                wherever possible
 869    * @param string $job_id
 870    *   Job ID component of the generated message ID.
 871    * @param string $event_queue_id
 872    *   Event Queue ID component of the generated message ID.
 873    * @param string $hash
 874    *   Hash component of the generated message ID.
 875    *
 876    * @return void
 877    */
 878   public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
 879     $config = CRM_Core_Config::singleton();
 880     $localpart = CRM_Core_BAO_MailSettings::defaultLocalpart();
 881     $emailDomain = CRM_Core_BAO_MailSettings::defaultDomain();
 882     $includeMessageId = CRM_Core_BAO_MailSettings::includeMessageId();
 883     $fields = [];
 884     $fields[] = 'Message-ID';
 885     // CRM-17754 check if Resent-Message-id is set also if not add it in when re-laying reply email
 886     if ($prefix == 'r') {
 887       $fields[] = 'Resent-Message-ID';
 888     }
 889     foreach ($fields as $field) {
 890       if ($includeMessageId && (!array_key_exists($field, $headers))) {
 891         $headers[$field] = '<' . implode($config->verpSeparator,
 892             [
 893               $localpart . $prefix,
 894               $job_id,
 895               $event_queue_id,
 896               $hash,
 897             ]
 898           ) . "@{$emailDomain}>";
 899       }
 900     }
 901
 902   }
 903
 904   /**
 905    * Static wrapper for getting verp and urls.
 906    *
 907    * @param int $job_id
 908    *   ID of the Job associated with this message.
 909    * @param int $event_queue_id
 910    *   ID of the EventQueue.
 911    * @param string $hash
 912    *   Hash of the EventQueue.
 913    * @param string $email
 914    *   Destination address.
 915    *
 916    * @return array
 917    *   (reference) array    array ref that hold array refs to the verp info and urls
 918    */
 919   public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
 920     // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
 921     $config = CRM_Core_Config::singleton();
 922     $bao = new CRM_Mailing_BAO_Mailing();
 923     $bao->_domain = CRM_Core_BAO_Domain::getDomain();
 924     $bao->from_name = $bao->from_email = $bao->subject = '';
 925
 926     // use $bao's instance method to get verp and urls
 927     list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
 928     return [$verp, $urls];
 929   }
 930
 931   /**
 932    * Get verp, urls and headers
 933    *
 934    * @param int $job_id
 935    *   ID of the Job associated with this message.
 936    * @param int $event_queue_id
 937    *   ID of the EventQueue.
 938    * @param string $hash
 939    *   Hash of the EventQueue.
 940    * @param string $email
 941    *   Destination address.
 942    *
 943    * @param bool $isForward
 944    *
 945    * @return array
 946    *   array ref that hold array refs to the verp info, urls, and headers
 947    */
 948   public function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
 949     $config = CRM_Core_Config::singleton();
 950
 951     /**
 952      * Inbound VERP keys:
 953      *  reply:          user replied to mailing
 954      *  bounce:         email address bounced
 955      *  unsubscribe:    contact opts out of all target lists for the mailing
 956      *  resubscribe:    contact opts back into all target lists for the mailing
 957      *  optOut:         contact unsubscribes from the domain
 958      */
 959     $verp = [];
 960     $verpTokens = [
 961       'reply' => 'r',
 962       'bounce' => 'b',
 963       'unsubscribe' => 'u',
 964       'resubscribe' => 'e',
 965       'optOut' => 'o',
 966     ];
 967
 968     $localpart = CRM_Core_BAO_MailSettings::defaultLocalpart();
 969     $emailDomain = CRM_Core_BAO_MailSettings::defaultDomain();
 970     // Make sure the user configured the site correctly, otherwise you just get "Could not identify any recipients. Perhaps the group is empty?" from the mailing UI
 971     if (empty($emailDomain)) {
 972       CRM_Core_Error::debug_log_message('Error setting verp parameters, defaultDomain is NULL.  Did you configure the bounce processing account for this domain?');
 973     }
 974
 975     foreach ($verpTokens as $key => $value) {
 976       $verp[$key] = implode($config->verpSeparator,
 977           [
 978             $localpart . $value,
 979             $job_id,
 980             $event_queue_id,
 981             $hash,
 982           ]
 983         ) . "@$emailDomain";
 984     }
 985
 986     //handle should override VERP address.
 987     $skipEncode = FALSE;
 988
 989     if ($job_id &&
 990       self::overrideVerp($job_id)
 991     ) {
 992       $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
 993     }
 994
 995     $urls = [
 996       'forward' => CRM_Utils_System::url('civicrm/mailing/forward', "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}", TRUE, NULL, TRUE, TRUE),
 997       'unsubscribeUrl' => CRM_Utils_System::url('civicrm/mailing/unsubscribe', "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}", TRUE, NULL, TRUE, TRUE),
 998       'resubscribeUrl' => CRM_Utils_System::url('civicrm/mailing/resubscribe', "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}", TRUE, NULL, TRUE, TRUE),
 999       'optOutUrl' => CRM_Utils_System::url('civicrm/mailing/optout', "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}", TRUE, NULL, TRUE, TRUE),
1000       'subscribeUrl' => CRM_Utils_System::url('civicrm/mailing/subscribe', 'reset=1', TRUE, NULL, TRUE, TRUE),
1001     ];
1002
1003     $headers = [
1004       'Reply-To' => $verp['reply'],
1005       'Return-Path' => $verp['bounce'],
1006       'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1007       'Subject' => $this->subject,
1008       'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1009     ];
1010     self::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1011     if ($isForward) {
1012       $headers['Subject'] = "[Fwd:{$this->subject}]";
1013     }
1014     return [&$verp, &$urls, &$headers];
1015   }
1016
1017   /**
1018    * Compose a message.
1019    *
1020    * @deprecated
1021    *   This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1022    * @param int $job_id
1023    *   ID of the Job associated with this message.
1024    * @param int $event_queue_id
1025    *   ID of the EventQueue.
1026    * @param string $hash
1027    *   Hash of the EventQueue.
1028    * @param string $contactId
1029    *   ID of the Contact.
1030    * @param string $email
1031    *   Destination address.
1032    * @param string $recipient
1033    *   To: of the recipient.
1034    * @param bool $test
1035    *   Is this mailing a test?.
1036    * @param $contactDetails
1037    * @param $attachments
1038    * @param bool $isForward
1039    *   Is this mailing compose for forward?.
1040    * @param string $fromEmail
1041    *   Email address of who is forwardinf it.
1042    *
1043    * @param null $replyToEmail
1044    *
1045    * @return Mail_mime               The mail object
1046    */
1047   public function compose(
1048     $job_id, $event_queue_id, $hash, $contactId,
1049     $email, &$recipient, $test,
1050     $contactDetails, &$attachments, $isForward = FALSE,
1051     $fromEmail = NULL, $replyToEmail = NULL
1052   ) {
1053     $config = CRM_Core_Config::singleton();
1054     $this->getTokens();
1055
1056     if ($this->_domain == NULL) {
1057       $this->_domain = CRM_Core_BAO_Domain::getDomain();
1058     }
1059
1060     list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1061       $job_id,
1062       $event_queue_id,
1063       $hash,
1064       $email,
1065       $isForward
1066     );
1067
1068     //set from email who is forwarding it and not original one.
1069     if ($fromEmail) {
1070       unset($headers['From']);
1071       $headers['From'] = "<{$fromEmail}>";
1072     }
1073
1074     if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1075       $headers['Reply-To'] = "{$replyToEmail}";
1076     }
1077
1078     if ($contactDetails) {
1079       $contact = $contactDetails;
1080     }
1081     elseif ($contactId === 0) {
1082       //anonymous user
1083       $contact = [];
1084       CRM_Utils_Hook::tokenValues($contact, [$contactId], $job_id);
1085     }
1086     else {
1087       $params = [['contact_id', '=', $contactId, 0, 0]];
1088       list($contact) = CRM_Contact_BAO_Query::apiQuery($params);
1089       // $contact is an array of [ contactID => contactDetails ]
1090
1091       // also call the hook to get contact details
1092       CRM_Utils_Hook::tokenValues($contact, [$contactId], $job_id);
1093
1094       // Don't send if contact doesn't exist
1095       $contact = reset($contact);
1096       if (!$contact || is_a($contact, 'CRM_Core_Error')) {
1097         CRM_Core_Error::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1098           [1 => $contactId]
1099         ));
1100         // setting this because function is called by reference
1101         //@todo test not calling function by reference
1102         $res = NULL;
1103         return $res;
1104       }
1105     }
1106
1107     $pTemplates = $this->getPreparedTemplates();
1108     $pEmails = [];
1109
1110     foreach ($pTemplates as $type => $pTemplate) {
1111       $html = $type == 'html';
1112       $pEmails[$type] = [];
1113       $pEmail = &$pEmails[$type];
1114       $template = &$pTemplates[$type]['template'];
1115       $tokens = &$pTemplates[$type]['tokens'];
1116       $idx = 0;
1117       if (!empty($tokens)) {
1118         foreach ($tokens as $idx => $token) {
1119           $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1120           array_push($pEmail, $template[$idx]);
1121           array_push($pEmail, $token_data);
1122         }
1123       }
1124       else {
1125         array_push($pEmail, $template[$idx]);
1126       }
1127
1128       if (isset($template[($idx + 1)])) {
1129         array_push($pEmail, $template[($idx + 1)]);
1130       }
1131     }
1132
1133     $html = NULL;
1134     if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1135       $html = &$pEmails['html'];
1136     }
1137
1138     $text = NULL;
1139     if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1140       $text = &$pEmails['text'];
1141     }
1142
1143     // push the tracking url on to the html email if necessary
1144     if ($this->open_tracking && $html) {
1145       array_push($html, "\n" . '<img src="' . CRM_Utils_System::externUrl('extern/open', "q=$event_queue_id")
1146         . '" width="1" height="1" alt="" border="0">'
1147       );
1148     }
1149
1150     $message = new Mail_mime("\n");
1151
1152     $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY;
1153     if ($useSmarty) {
1154       $smarty = CRM_Core_Smarty::singleton();
1155       // also add the contact tokens to the template
1156       $smarty->assign_by_ref('contact', $contact);
1157     }
1158
1159     $mailParams = $headers;
1160     if ($text && ($test || $contact['preferred_mail_format'] == 'Text' ||
1161         $contact['preferred_mail_format'] == 'Both' ||
1162         ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1163       )
1164     ) {
1165       $textBody = implode('', $text);
1166       if ($useSmarty) {
1167         $textBody = $smarty->fetch("string:$textBody");
1168       }
1169       $mailParams['text'] = $textBody;
1170     }
1171
1172     if ($html && ($test || ($contact['preferred_mail_format'] == 'HTML' ||
1173           $contact['preferred_mail_format'] == 'Both'
1174         ))
1175     ) {
1176       $htmlBody = implode('', $html);
1177       if ($useSmarty) {
1178         $htmlBody = $smarty->fetch("string:$htmlBody");
1179       }
1180       $mailParams['html'] = $htmlBody;
1181     }
1182
1183     if (empty($mailParams['text']) && empty($mailParams['html'])) {
1184       // CRM-9833
1185       // something went wrong, lets log it and return null (by reference)
1186       CRM_Core_Error::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1187         [1 => $email]
1188       ));
1189       $res = NULL;
1190       return $res;
1191     }
1192
1193     $mailParams['attachments'] = $attachments;
1194
1195     $mailParams['Subject'] = $pEmails['subject'] ?? NULL;
1196     if (is_array($mailParams['Subject'])) {
1197       $mailParams['Subject'] = implode('', $mailParams['Subject']);
1198     }
1199
1200     $mailParams['toName'] = CRM_Utils_Array::value('display_name',
1201       $contact
1202     );
1203     $mailParams['toEmail'] = $email;
1204
1205     // Add job ID to mailParams for external email delivery service to utilise
1206     $mailParams['job_id'] = $job_id;
1207
1208     CRM_Utils_Hook::alterMailParams($mailParams, 'civimail');
1209
1210     // CRM-10699 support custom email headers
1211     if (!empty($mailParams['headers'])) {
1212       $headers = array_merge($headers, $mailParams['headers']);
1213     }
1214     //cycle through mailParams and set headers array
1215     foreach ($mailParams as $paramKey => $paramValue) {
1216       //exclude values not intended for the header
1217       if (!in_array($paramKey, [
1218         'text',
1219         'html',
1220         'attachments',
1221         'toName',
1222         'toEmail',
1223       ])
1224       ) {
1225         $headers[$paramKey] = $paramValue;
1226       }
1227     }
1228
1229     if (!empty($mailParams['text'])) {
1230       $message->setTxtBody($mailParams['text']);
1231     }
1232
1233     if (!empty($mailParams['html'])) {
1234       $message->setHTMLBody($mailParams['html']);
1235     }
1236
1237     if (!empty($mailParams['attachments'])) {
1238       foreach ($mailParams['attachments'] as $fileID => $attach) {
1239         $message->addAttachment($attach['fullPath'],
1240           $attach['mime_type'],
1241           $attach['cleanName']
1242         );
1243       }
1244     }
1245
1246     //pickup both params from mail params.
1247     $toName = trim($mailParams['toName']);
1248     $toEmail = trim($mailParams['toEmail']);
1249     if ($toName == $toEmail ||
1250       strpos($toName, '@') !== FALSE
1251     ) {
1252       $toName = NULL;
1253     }
1254     else {
1255       $toName = CRM_Utils_Mail::formatRFC2822Name($toName);
1256     }
1257
1258     $headers['To'] = "$toName <$toEmail>";
1259
1260     $headers['Precedence'] = 'bulk';
1261     // Will test in the mail processor if the X-VERP is set in the bounced email.
1262     // (As an option to replace real VERP for those that can't set it up)
1263     $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1264
1265     //CRM-5058
1266     //token replacement of subject
1267     $headers['Subject'] = $mailParams['Subject'];
1268
1269     CRM_Utils_Mail::setMimeParams($message);
1270     $headers = $message->headers($headers);
1271
1272     //get formatted recipient
1273     $recipient = $headers['To'];
1274
1275     // make sure we unset a lot of stuff
1276     unset($verp);
1277     unset($urls);
1278     unset($params);
1279     unset($contact);
1280     unset($ids);
1281
1282     return $message;
1283   }
1284
1285   /**
1286    * Replace tokens.
1287    *
1288    * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
1289    *
1290    * @deprecated
1291    *   This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1292    * @param CRM_Mailing_BAO_Mailing $mailing
1293    */
1294   public static function tokenReplace(&$mailing) {
1295     $domain = CRM_Core_BAO_Domain::getDomain();
1296
1297     foreach (['text', 'html'] as $type) {
1298       $tokens = $mailing->getTokens();
1299       if (isset($mailing->templates[$type])) {
1300         $mailing->templates[$type] = CRM_Utils_Token::replaceSubscribeInviteTokens($mailing->templates[$type]);
1301         $mailing->templates[$type] = CRM_Utils_Token::replaceDomainTokens(
1302           $mailing->templates[$type],
1303           $domain,
1304           $type == 'html',
1305           $tokens[$type]
1306         );
1307         $mailing->templates[$type] = CRM_Utils_Token::replaceMailingTokens($mailing->templates[$type], $mailing, NULL, $tokens[$type]);
1308       }
1309     }
1310   }
1311
1312   /**
1313    * Get data to resolve tokens.
1314    *
1315    * @deprecated
1316    *   This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
1317    *
1318    * @param array $token_a
1319    * @param bool $html
1320    *   Whether to encode the token result for use in HTML email
1321    * @param array $contact
1322    * @param string $verp
1323    * @param array $urls
1324    * @param int $event_queue_id
1325    *
1326    * @return bool|mixed|null|string
1327    */
1328   private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1329     $type = $token_a['type'];
1330     $token = $token_a['token'];
1331     $data = $token;
1332
1333     $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY;
1334
1335     if ($type == 'embedded_url') {
1336       $embed_data = [];
1337       foreach ($token as $t) {
1338         $embed_data[] = $this->getTokenData($t, $html, $contact, $verp, $urls, $event_queue_id);
1339       }
1340       $numSlices = count($embed_data);
1341       $url = '';
1342       for ($i = 0; $i < $numSlices; $i++) {
1343         $embed_url_data = parse_url($embed_data[$i]);
1344         if (!empty($embed_url_data['scheme'])) {
1345           $token_a['embed_parts'][$i] = preg_replace("/href=\"(https*:\/\/)/", "href=\"", $token_a['embed_parts'][$i]);
1346         }
1347         $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1348       }
1349       if (isset($token_a['embed_parts'][$numSlices])) {
1350         $url .= $token_a['embed_parts'][$numSlices];
1351       }
1352       // add trailing quote since we've gobbled it up in a previous regex
1353       // function getPatterns, line 431
1354       if (preg_match("/^href[ ]*=[ ]*'.*[^']$/", $url)) {
1355         $url .= "'";
1356       }
1357       elseif (preg_match('/^href[ ]*=[ ]*".*[^"]$/', $url)) {
1358         $url .= '"';
1359       }
1360       $data = $url;
1361       // CRM-20206 Fix ampersand encoding in plain text emails
1362       if (empty($html)) {
1363         $data = CRM_Utils_String::unstupifyUrl($data);
1364       }
1365     }
1366     elseif ($type == 'url') {
1367       if ($this->url_tracking && !empty($this->id)) {
1368         // ensure that Google CSS and any .css files are not tracked.
1369         if (!(strpos($token, 'css?family') || strpos($token, '.css'))) {
1370           $data = CRM_Mailing_BAO_TrackableURL::getTrackerURL($token, $this->id, $event_queue_id);
1371           if (!empty($html)) {
1372             $data = htmlentities($data, ENT_NOQUOTES);
1373           }
1374         }
1375       }
1376       else {
1377         $data = $token;
1378       }
1379     }
1380     elseif ($type == 'contact') {
1381       $data = CRM_Utils_Token::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1382     }
1383     elseif ($type == 'action') {
1384       $data = CRM_Utils_Token::getActionTokenReplacement($token, $verp, $urls, $html);
1385     }
1386     elseif ($type == 'domain') {
1387       $domain = CRM_Core_BAO_Domain::getDomain();
1388       $data = CRM_Utils_Token::getDomainTokenReplacement($token, $domain, $html);
1389     }
1390     elseif ($type == 'mailing') {
1391       if ($token == 'name') {
1392         $data = $this->name;
1393       }
1394       elseif ($token == 'group') {
1395         $groups = $this->getGroupNames();
1396         $data = implode(', ', $groups);
1397       }
1398     }
1399     else {
1400       $data = $contact["{$type}.{$token}"] ?? NULL;
1401     }
1402     return $data;
1403   }
1404
1405   /**
1406    * Return a list of group names for this mailing.  Does not work with
1407    * prior-mailing targets.
1408    *
1409    * @return array
1410    *   Names of groups receiving this mailing
1411    */
1412   public function &getGroupNames() {
1413     if (!isset($this->id)) {
1414       return [];
1415     }
1416     $mg = new CRM_Mailing_DAO_MailingGroup();
1417     $mgtable = CRM_Mailing_DAO_MailingGroup::getTableName();
1418     $group = CRM_Contact_BAO_Group::getTableName();
1419
1420     $mg->query("SELECT      $group.title as name FROM $mgtable
1421                     INNER JOIN  $group ON $mgtable.entity_id = $group.id
1422                     WHERE       $mgtable.mailing_id = {$this->id}
1423                         AND     $mgtable.entity_table = '$group'
1424                         AND     $mgtable.group_type = 'Include'
1425                     ORDER BY    $group.name");
1426
1427     $groups = [];
1428     while ($mg->fetch()) {
1429       $groups[] = $mg->name;
1430     }
1431     return $groups;
1432   }
1433
1434   /**
1435    * Add the mailings.
1436    *
1437    * @param array $params
1438    *   Reference array contains the values submitted by the form.
1439    * @param array $ids
1440    *   Reference array contains the id.
1441    *
1442    *
1443    * @return CRM_Mailing_DAO_Mailing
1444    */
1445   public static function add(&$params, $ids = []) {
1446     $id = $params['id'] ?? $ids['mailing_id'] ?? NULL;
1447
1448     if (empty($params['id']) && !empty($ids)) {
1449       CRM_Core_Error::deprecatedWarning('Parameter $ids is no longer used by Mailing::add. Use the api or just pass $params');
1450     }
1451
1452     if ($id) {
1453       CRM_Utils_Hook::pre('edit', 'Mailing', $id, $params);
1454     }
1455     else {
1456       CRM_Utils_Hook::pre('create', 'Mailing', NULL, $params);
1457     }
1458
1459     $mailing = new static();
1460     if ($id) {
1461       $mailing->id = $id;
1462       $mailing->find(TRUE);
1463     }
1464     $mailing->domain_id = CRM_Utils_Array::value('domain_id', $params, CRM_Core_Config::domainID());
1465
1466     if (((!$id && empty($params['replyto_email'])) || !isset($params['replyto_email'])) &&
1467       isset($params['from_email'])
1468     ) {
1469       $params['replyto_email'] = $params['from_email'];
1470     }
1471     $mailing->copyValues($params);
1472
1473     // CRM-20892 Unset Modifed Date here so that MySQL can correctly set an updated modfied date.
1474     unset($mailing->modified_date);
1475     $result = $mailing->save();
1476
1477     // CRM-20892 Re find record after saing so we can set the updated modified date in the result.
1478     $mailing->find(TRUE);
1479
1480     if (isset($mailing->modified_date)) {
1481       $result->modified_date = $mailing->modified_date;
1482     }
1483
1484     if ($id) {
1485       CRM_Utils_Hook::post('edit', 'Mailing', $mailing->id, $mailing);
1486     }
1487     else {
1488       CRM_Utils_Hook::post('create', 'Mailing', $mailing->id, $mailing);
1489     }
1490
1491     return $result;
1492   }
1493
1494   /**
1495    * Construct a new mailing object, along with job and mailing_group
1496    * objects, from the form values of the create mailing wizard.
1497    *
1498    * This function is a bit evil. It not only merges $params and saves
1499    * the mailing -- it also schedules the mailing and chooses the recipients.
1500    * Since it merges $params, it's also the only place to correctly trigger
1501    * multi-field validation. It should be broken up.
1502    *
1503    * In the mean time, use-cases which break under the weight of this
1504    * evil may find reprieve in these extra evil params:
1505    *
1506    *  - _skip_evil_bao_auto_recipients_: bool
1507    *  - _skip_evil_bao_auto_schedule_: bool
1508    *  - _evil_bao_validator_: string|callable
1509    *
1510    * </twowrongsmakesaright>
1511    *
1512    * @params array $params
1513    *   Form values.
1514    *
1515    * @param array $params
1516    * @param array $ids
1517    *
1518    * @return object
1519    *   $mailing      The new mailing object
1520    *
1521    * @throws \CRM_Core_Exception
1522    * @throws \CiviCRM_API3_Exception
1523    */
1524   public static function create(&$params, $ids = []) {
1525
1526     if (empty($params['id']) && (array_filter($ids) !== [])) {
1527       $params['id'] = $ids['mailing_id'] ?? $ids['id'];
1528       CRM_Core_Error::deprecatedWarning('Parameter $ids is no longer used by Mailing::create. Use the api or just pass $params');
1529     }
1530
1531     // CRM-#1843
1532     // If it is a mass sms, set url_tracking to false
1533     if (!empty($params['sms_provider_id'])) {
1534       $params['url_tracking'] = 0;
1535     }
1536
1537     // CRM-12430
1538     // Do the below only for an insert
1539     // for an update, we should not set the defaults
1540     if (!isset($params['id'])) {
1541       // Retrieve domain email and name for default sender
1542       $domain = civicrm_api(
1543         'Domain',
1544         'getsingle',
1545         [
1546           'version' => 3,
1547           'current_domain' => 1,
1548           'sequential' => 1,
1549         ]
1550       );
1551       if (isset($domain['from_email'])) {
1552         $domain_email = $domain['from_email'];
1553         $domain_name = $domain['from_name'];
1554       }
1555       else {
1556         $domain_email = 'info@EXAMPLE.ORG';
1557         $domain_name = 'EXAMPLE.ORG';
1558       }
1559       if (!isset($params['created_id'])) {
1560         $params['created_id'] = CRM_Core_Session::getLoggedInContactID();
1561       }
1562       $defaults = [
1563         // load the default config settings for each
1564         // eg reply_id, unsubscribe_id need to use
1565         // correct template IDs here
1566         'override_verp' => TRUE,
1567         'forward_replies' => FALSE,
1568         'open_tracking' => Civi::settings()->get('open_tracking_default'),
1569         'url_tracking' => Civi::settings()->get('url_tracking_default'),
1570         'visibility' => 'Public Pages',
1571         'replyto_email' => $domain_email,
1572         'header_id' => CRM_Mailing_PseudoConstant::defaultComponent('header_id', ''),
1573         'footer_id' => CRM_Mailing_PseudoConstant::defaultComponent('footer_id', ''),
1574         'from_email' => $domain_email,
1575         'from_name' => $domain_name,
1576         'msg_template_id' => NULL,
1577         'created_id' => $params['created_id'],
1578         'approver_id' => NULL,
1579         'auto_responder' => 0,
1580         'created_date' => date('YmdHis'),
1581         'scheduled_date' => NULL,
1582         'approval_date' => NULL,
1583       ];
1584
1585       // Get the default from email address, if not provided.
1586       if (empty($defaults['from_email'])) {
1587         $defaultAddress = CRM_Core_BAO_Domain::getNameAndEmail(TRUE, TRUE);
1588         foreach ($defaultAddress as $id => $value) {
1589           if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1590             $defaults['from_email'] = $match[2];
1591             $defaults['from_name'] = $match[1];
1592           }
1593         }
1594       }
1595
1596       $params = array_merge($defaults, $params);
1597     }
1598
1599     /**
1600      * Could check and warn for the following cases:
1601      *
1602      * - groups OR mailings should be populated.
1603      * - body html OR body text should be populated.
1604      */
1605
1606     $transaction = new CRM_Core_Transaction();
1607
1608     $mailing = self::add($params);
1609
1610     if (is_a($mailing, 'CRM_Core_Error')) {
1611       $transaction->rollback();
1612       return $mailing;
1613     }
1614     // update mailings with hash values
1615     CRM_Contact_BAO_Contact_Utils::generateChecksum($mailing->id, NULL, NULL, NULL, 'mailing', 16);
1616
1617     $groupTableName = CRM_Contact_BAO_Group::getTableName();
1618
1619     /* Create the mailing group record */
1620     $mg = new CRM_Mailing_DAO_MailingGroup();
1621     $groupTypes = [
1622       'include' => 'Include',
1623       'exclude' => 'Exclude',
1624       'base' => 'Base',
1625     ];
1626     foreach (['groups', 'mailings'] as $entity) {
1627       foreach (['include', 'exclude', 'base'] as $type) {
1628         if (isset($params[$entity][$type])) {
1629           self::replaceGroups($mailing->id, $groupTypes[$type], $entity, $params[$entity][$type]);
1630         }
1631       }
1632     }
1633
1634     if (!empty($params['search_id']) && !empty($params['group_id'])) {
1635       $mg->reset();
1636       $mg->mailing_id = $mailing->id;
1637       $mg->entity_table = $groupTableName;
1638       $mg->entity_id = $params['group_id'];
1639       $mg->search_id = $params['search_id'];
1640       $mg->search_args = $params['search_args'];
1641       $mg->group_type = 'Include';
1642       $mg->save();
1643     }
1644
1645     // check and attach and files as needed
1646     CRM_Core_BAO_File::processAttachment($params, 'civicrm_mailing', $mailing->id);
1647
1648     // If we're going to autosend, then check validity before saving.
1649     if (empty($params['is_completed']) && !empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1650       $cb = Civi\Core\Resolver::singleton()
1651         ->get($params['_evil_bao_validator_']);
1652       $errors = call_user_func($cb, $mailing);
1653       if (!empty($errors)) {
1654         $fields = implode(',', array_keys($errors));
1655         throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1656       }
1657     }
1658
1659     $transaction->commit();
1660
1661     // Create parent job if not yet created.
1662     // Condition on the existence of a scheduled date.
1663     if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1664       $job = new CRM_Mailing_BAO_MailingJob();
1665       $job->mailing_id = $mailing->id;
1666       // If we are creating a new Completed mailing (e.g. import from another system) set the job to completed.
1667       // Keeping former behaviour when an id is present is precautionary and may warrant reconsideration later.
1668       $job->status = ((empty($params['is_completed']) || !empty($params['id'])) ? 'Scheduled' : 'Complete');
1669       $job->is_test = 0;
1670
1671       if (!$job->find(TRUE)) {
1672         // Don't schedule job until we populate the recipients.
1673         $job->scheduled_date = NULL;
1674         $job->save();
1675       }
1676       // Schedule the job now that it has recipients.
1677       $job->scheduled_date = $params['scheduled_date'];
1678       $job->save();
1679     }
1680
1681     // Populate the recipients.
1682     if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1683       self::getRecipients($mailing->id);
1684     }
1685
1686     return $mailing;
1687   }
1688
1689   /**
1690    * @deprecated
1691    *   This is used by CiviMail but will be made redundant by FlexMailer.
1692    * @param CRM_Mailing_DAO_Mailing $mailing
1693    *   The mailing which may or may not be sendable.
1694    * @return array
1695    *   List of error messages.
1696    */
1697   public static function checkSendable($mailing) {
1698     $errors = [];
1699     foreach (['subject', 'name', 'from_name', 'from_email'] as $field) {
1700       if (empty($mailing->{$field})) {
1701         $errors[$field] = ts('Field "%1" is required.', [
1702           1 => $field,
1703         ]);
1704       }
1705     }
1706     if (empty($mailing->body_html) && empty($mailing->body_text)) {
1707       $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1708     }
1709
1710     if (!Civi::settings()->get('disable_mandatory_tokens_check')) {
1711       $header = $mailing->header_id && $mailing->header_id != 'null' ? CRM_Mailing_BAO_MailingComponent::findById($mailing->header_id) : NULL;
1712       $footer = $mailing->footer_id && $mailing->footer_id != 'null' ? CRM_Mailing_BAO_MailingComponent::findById($mailing->footer_id) : NULL;
1713       foreach (['body_html', 'body_text'] as $field) {
1714         if (empty($mailing->{$field})) {
1715           continue;
1716         }
1717         $str = ($header ? $header->{$field} : '') . $mailing->{$field} . ($footer ? $footer->{$field} : '');
1718         $err = CRM_Utils_Token::requiredTokens($str);
1719         if ($err !== TRUE) {
1720           foreach ($err as $token => $desc) {
1721             $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1722               [1 => $token, 2 => $desc]
1723             );
1724           }
1725         }
1726       }
1727     }
1728
1729     return $errors;
1730   }
1731
1732   /**
1733    * Replace the list of recipients on a given mailing.
1734    *
1735    * @param int $mailingId
1736    * @param string $type
1737    *   'include' or 'exclude'.
1738    * @param string $entity
1739    *   'groups' or 'mailings'.
1740    * @param array $entityIds
1741    * @throws CiviCRM_API3_Exception
1742    */
1743   public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1744     $values = [];
1745     foreach ($entityIds as $entityId) {
1746       $values[] = ['entity_id' => $entityId];
1747     }
1748     civicrm_api3('mailing_group', 'replace', [
1749       'mailing_id' => $mailingId,
1750       'group_type' => $type,
1751       'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group::getTableName() : CRM_Mailing_BAO_Mailing::getTableName(),
1752       'values' => $values,
1753     ]);
1754   }
1755
1756   /**
1757    * Get hash value of the mailing.
1758    *
1759    * @param $id
1760    *
1761    * @return null|string
1762    */
1763   public static function getMailingHash($id) {
1764     $hash = NULL;
1765     if (Civi::settings()->get('hash_mailing_url') && !empty($id)) {
1766       $hash = CRM_Core_DAO::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1767     }
1768     return $hash;
1769   }
1770
1771   /**
1772    * Generate a report.  Fetch event count information, mailing data, and job
1773    * status.
1774    *
1775    * @param int $id
1776    *   The mailing id to report.
1777    * @param bool $skipDetails
1778    *   Whether return all detailed report.
1779    *
1780    * @param bool $isSMS
1781    *
1782    * @return array
1783    *   Associative array of reporting data
1784    */
1785   public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1786     $mailing_id = CRM_Utils_Type::escape($id, 'Integer');
1787
1788     $mailing = new CRM_Mailing_BAO_Mailing();
1789
1790     $t = [
1791       'mailing' => self::getTableName(),
1792       'mailing_group' => CRM_Mailing_DAO_MailingGroup::getTableName(),
1793       'group' => CRM_Contact_BAO_Group::getTableName(),
1794       'job' => CRM_Mailing_BAO_MailingJob::getTableName(),
1795       'queue' => CRM_Mailing_Event_BAO_Queue::getTableName(),
1796       'delivered' => CRM_Mailing_Event_BAO_Delivered::getTableName(),
1797       'opened' => CRM_Mailing_Event_BAO_Opened::getTableName(),
1798       'reply' => CRM_Mailing_Event_BAO_Reply::getTableName(),
1799       'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe::getTableName(),
1800       'bounce' => CRM_Mailing_Event_BAO_Bounce::getTableName(),
1801       'forward' => CRM_Mailing_Event_BAO_Forward::getTableName(),
1802       'url' => CRM_Mailing_BAO_TrackableURL::getTableName(),
1803       'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen::getTableName(),
1804       'component' => CRM_Mailing_BAO_MailingComponent::getTableName(),
1805       'spool' => CRM_Mailing_BAO_Spool::getTableName(),
1806     ];
1807
1808     $report = [];
1809     $additionalWhereClause = " AND ";
1810     if (!$isSMS) {
1811       $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1812     }
1813     else {
1814       $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1815     }
1816
1817     /* Get the mailing info */
1818
1819     $mailing->query("
1820             SELECT          {$t['mailing']}.*
1821             FROM            {$t['mailing']}
1822             WHERE           {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1823
1824     $mailing->fetch();
1825
1826     $report['mailing'] = [];
1827     foreach (array_keys(self::fields()) as $field) {
1828       $field = self::fields()[$field]['name'];
1829       $report['mailing'][$field] = $mailing->$field;
1830     }
1831
1832     //get the campaign
1833     if ($campaignId = CRM_Utils_Array::value('campaign_id', $report['mailing'])) {
1834       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
1835       $report['mailing']['campaign'] = $campaigns[$campaignId];
1836     }
1837
1838     //mailing report is called by activity
1839     //we dont need all detail report
1840     if ($skipDetails) {
1841       return $report;
1842     }
1843
1844     /* Get the component info */
1845
1846     $query = [];
1847
1848     $components = [
1849       'header' => ts('Header'),
1850       'footer' => ts('Footer'),
1851       'reply' => ts('Reply'),
1852       'optout' => ts('Opt-Out'),
1853       'resubscribe' => ts('Resubscribe'),
1854       'unsubscribe' => ts('Unsubscribe'),
1855     ];
1856     foreach (array_keys($components) as $type) {
1857       $query[] = "SELECT          {$t['component']}.name as name,
1858                                         '$type' as type,
1859                                         {$t['component']}.id as id
1860                         FROM            {$t['component']}
1861                         INNER JOIN      {$t['mailing']}
1862                                 ON      {$t['mailing']}.{$type}_id =
1863                                                 {$t['component']}.id
1864                         WHERE           {$t['mailing']}.id = $mailing_id";
1865     }
1866     $q = '(' . implode(') UNION (', $query) . ')';
1867     $mailing->query($q);
1868
1869     $report['component'] = [];
1870     while ($mailing->fetch()) {
1871       $report['component'][] = [
1872         'type' => $components[$mailing->type],
1873         'name' => $mailing->name,
1874         'link' => CRM_Utils_System::url('civicrm/mailing/component', "reset=1&action=update&id={$mailing->id}"),
1875       ];
1876     }
1877
1878     /* Get the recipient group info */
1879
1880     $mailing->query("
1881             SELECT          {$t['mailing_group']}.group_type as group_type,
1882                             {$t['group']}.id as group_id,
1883                             {$t['group']}.title as group_title,
1884                             {$t['group']}.is_hidden as group_hidden,
1885                             {$t['mailing']}.id as mailing_id,
1886                             {$t['mailing']}.name as mailing_name
1887             FROM            {$t['mailing_group']}
1888             LEFT JOIN       {$t['group']}
1889                     ON      {$t['mailing_group']}.entity_id = {$t['group']}.id
1890                     AND     {$t['mailing_group']}.entity_table =
1891                                                                 '{$t['group']}'
1892             LEFT JOIN       {$t['mailing']}
1893                     ON      {$t['mailing_group']}.entity_id =
1894                                                             {$t['mailing']}.id
1895                     AND     {$t['mailing_group']}.entity_table =
1896                                                             '{$t['mailing']}'
1897
1898             WHERE           {$t['mailing_group']}.mailing_id = $mailing_id
1899             ");
1900
1901     $report['group'] = ['include' => [], 'exclude' => [], 'base' => []];
1902     while ($mailing->fetch()) {
1903       $row = [];
1904       if (isset($mailing->group_id)) {
1905         $row['id'] = $mailing->group_id;
1906         $row['name'] = $mailing->group_title;
1907         $row['link'] = CRM_Utils_System::url('civicrm/group/search',
1908           "reset=1&force=1&context=smog&gid={$row['id']}"
1909         );
1910       }
1911       else {
1912         $row['id'] = $mailing->mailing_id;
1913         $row['name'] = $mailing->mailing_name;
1914         $row['mailing'] = TRUE;
1915         $row['link'] = CRM_Utils_System::url('civicrm/mailing/report',
1916           "mid={$row['id']}"
1917         );
1918       }
1919
1920       /* Rename hidden groups */
1921
1922       if ($mailing->group_hidden == 1) {
1923         $row['name'] = "Search Results";
1924       }
1925
1926       if ($mailing->group_type == 'Include') {
1927         $report['group']['include'][] = $row;
1928       }
1929       elseif ($mailing->group_type == 'Base') {
1930         $report['group']['base'][] = $row;
1931       }
1932       else {
1933         $report['group']['exclude'][] = $row;
1934       }
1935     }
1936
1937     /* Get the event totals, grouped by job (retries) */
1938
1939     $mailing->query("
1940             SELECT          {$t['job']}.*,
1941                             COUNT(DISTINCT {$t['queue']}.id) as queue,
1942                             COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1943                             COUNT(DISTINCT {$t['reply']}.id) as reply,
1944                             COUNT(DISTINCT {$t['forward']}.id) as forward,
1945                             COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1946                             COUNT(DISTINCT {$t['urlopen']}.id) as url,
1947                             COUNT(DISTINCT {$t['spool']}.id) as spool
1948             FROM            {$t['job']}
1949             LEFT JOIN       {$t['queue']}
1950                     ON      {$t['queue']}.job_id = {$t['job']}.id
1951             LEFT JOIN       {$t['reply']}
1952                     ON      {$t['reply']}.event_queue_id = {$t['queue']}.id
1953             LEFT JOIN       {$t['forward']}
1954                     ON      {$t['forward']}.event_queue_id = {$t['queue']}.id
1955             LEFT JOIN       {$t['bounce']}
1956                     ON      {$t['bounce']}.event_queue_id = {$t['queue']}.id
1957             LEFT JOIN       {$t['delivered']}
1958                     ON      {$t['delivered']}.event_queue_id = {$t['queue']}.id
1959                     AND     {$t['bounce']}.id IS null
1960             LEFT JOIN       {$t['urlopen']}
1961                     ON      {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1962             LEFT JOIN       {$t['spool']}
1963                     ON      {$t['spool']}.job_id = {$t['job']}.id
1964             WHERE           {$t['job']}.mailing_id = $mailing_id
1965                     AND     {$t['job']}.is_test = 0
1966             GROUP BY        {$t['job']}.id");
1967
1968     $report['jobs'] = [];
1969     $report['event_totals'] = [];
1970     $path = 'civicrm/mailing/report/event';
1971     $elements = [
1972       'queue',
1973       'delivered',
1974       'url',
1975       'forward',
1976       'reply',
1977       'unsubscribe',
1978       'optout',
1979       'opened',
1980       'total_opened',
1981       'bounce',
1982       'spool',
1983     ];
1984
1985     // initialize various counters
1986     foreach ($elements as $field) {
1987       $report['event_totals'][$field] = 0;
1988     }
1989
1990     while ($mailing->fetch()) {
1991       $row = [];
1992       foreach ($elements as $field) {
1993         if (isset($mailing->$field)) {
1994           $row[$field] = $mailing->$field;
1995           $report['event_totals'][$field] += $mailing->$field;
1996         }
1997       }
1998
1999       // compute open total separately to discount duplicates
2000       // CRM-1258
2001       $row['opened'] = CRM_Mailing_Event_BAO_Opened::getTotalCount($mailing_id, $mailing->id, TRUE);
2002       $report['event_totals']['opened'] += $row['opened'];
2003       $row['total_opened'] = CRM_Mailing_Event_BAO_Opened::getTotalCount($mailing_id, $mailing->id);
2004       $report['event_totals']['total_opened'] += $row['total_opened'];
2005
2006       // compute unsub total separately to discount duplicates
2007       // CRM-1783
2008       $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe::getTotalCount($mailing_id, $mailing->id, TRUE, TRUE);
2009       $report['event_totals']['unsubscribe'] += $row['unsubscribe'];
2010
2011       $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe::getTotalCount($mailing_id, $mailing->id, TRUE, FALSE);
2012       $report['event_totals']['optout'] += $row['optout'];
2013
2014       foreach (array_keys(CRM_Mailing_BAO_MailingJob::fields()) as $field) {
2015         // Get the field name from the MailingJob fields as that will not have any prefixing.
2016         // dev/mailing#56
2017         $field = CRM_Mailing_BAO_MailingJob::fields()[$field]['name'];
2018         $row[$field] = $mailing->$field;
2019       }
2020
2021       if ($mailing->queue) {
2022         $row['delivered_rate'] = (100.0 * $mailing->delivered) / $mailing->queue;
2023         $row['bounce_rate'] = (100.0 * $mailing->bounce) / $mailing->queue;
2024         $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue;
2025         $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue;
2026         $row['opened_rate'] = $mailing->delivered ? (($row['opened'] / $mailing->delivered) * 100.0) : 0;
2027         $row['clickthrough_rate'] = $mailing->delivered ? (($mailing->url / $mailing->delivered) * 100.0) : 0;
2028       }
2029       else {
2030         $row['delivered_rate'] = 0;
2031         $row['bounce_rate'] = 0;
2032         $row['unsubscribe_rate'] = 0;
2033         $row['optout_rate'] = 0;
2034         $row['opened_rate'] = 0;
2035         $row['clickthrough_rate'] = 0;
2036       }
2037
2038       $arg = "reset=1&mid=$mailing_id&jid={$mailing->id}";
2039       $row['links'] = [
2040         'clicks' => CRM_Utils_System::url($path, "$arg&event=click"),
2041         'queue' => CRM_Utils_System::url($path, "$arg&event=queue"),
2042         'delivered' => CRM_Utils_System::url($path, "$arg&event=delivered"),
2043         'bounce' => CRM_Utils_System::url($path, "$arg&event=bounce"),
2044         'unsubscribe' => CRM_Utils_System::url($path, "$arg&event=unsubscribe"),
2045         'forward' => CRM_Utils_System::url($path, "$arg&event=forward"),
2046         'reply' => CRM_Utils_System::url($path, "$arg&event=reply"),
2047         'opened' => CRM_Utils_System::url($path, "$arg&event=opened"),
2048       ];
2049
2050       foreach (['scheduled_date', 'start_date', 'end_date'] as $key) {
2051         $row[$key] = CRM_Utils_Date::customFormat($row[$key]);
2052       }
2053       $report['jobs'][] = $row;
2054     }
2055
2056     $newTableSize = CRM_Mailing_BAO_Recipients::mailingSize($mailing_id);
2057
2058     // we need to do this for backward compatibility, since old mailings did not
2059     // use the mailing_recipients table
2060     if ($newTableSize > 0) {
2061       $report['event_totals']['queue'] = $newTableSize;
2062     }
2063     else {
2064       $report['event_totals']['queue'] = self::getRecipientsCount($mailing_id);
2065     }
2066
2067     if (!empty($report['event_totals']['queue'])) {
2068       $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2069       $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2070       $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2071       $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2072       $report['event_totals']['opened_rate'] = !empty($report['event_totals']['delivered']) ? (($report['event_totals']['opened'] / $report['event_totals']['delivered']) * 100.0) : 0;
2073       $report['event_totals']['clickthrough_rate'] = !empty($report['event_totals']['delivered']) ? (($report['event_totals']['url'] / $report['event_totals']['delivered']) * 100.0) : 0;
2074     }
2075     else {
2076       $report['event_totals']['delivered_rate'] = 0;
2077       $report['event_totals']['bounce_rate'] = 0;
2078       $report['event_totals']['unsubscribe_rate'] = 0;
2079       $report['event_totals']['optout_rate'] = 0;
2080       $report['event_totals']['opened_rate'] = 0;
2081       $report['event_totals']['clickthrough_rate'] = 0;
2082     }
2083
2084     /* Get the click-through totals, grouped by URL */
2085
2086     $mailing->query("
2087             SELECT      {$t['url']}.url,
2088                         {$t['url']}.id,
2089                         COUNT({$t['urlopen']}.id) as clicks,
2090                         COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2091             FROM        {$t['url']}
2092             LEFT JOIN   {$t['urlopen']}
2093                     ON  {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2094             LEFT JOIN  {$t['queue']}
2095                     ON  {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2096             LEFT JOIN  {$t['job']}
2097                     ON  {$t['queue']}.job_id = {$t['job']}.id
2098             WHERE       {$t['url']}.mailing_id = $mailing_id
2099                     AND {$t['job']}.is_test = 0
2100             GROUP BY    {$t['url']}.id
2101             ORDER BY    unique_clicks DESC");
2102
2103     $report['click_through'] = [];
2104
2105     while ($mailing->fetch()) {
2106       $report['click_through'][] = [
2107         'url' => $mailing->url,
2108         'link' => CRM_Utils_System::url($path, "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"),
2109         'link_unique' => CRM_Utils_System::url($path, "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"),
2110         'clicks' => $mailing->clicks,
2111         'unique' => $mailing->unique_clicks,
2112         'rate' => !empty($report['event_totals']['delivered']) ? (100.0 * $mailing->unique_clicks) / $report['event_totals']['delivered'] : 0,
2113         'report' => CRM_Report_Utils_Report::getNextUrl('mailing/clicks', "reset=1&mailing_id_value={$mailing_id}&url_value={$mailing->url}", FALSE, TRUE),
2114       ];
2115     }
2116
2117     $arg = "reset=1&mid=$mailing_id";
2118     $report['event_totals']['links'] = [
2119       'clicks' => CRM_Utils_System::url($path, "$arg&event=click"),
2120       'clicks_unique' => CRM_Utils_System::url($path, "$arg&event=click&distinct=1"),
2121       'queue' => CRM_Utils_System::url($path, "$arg&event=queue"),
2122       'delivered' => CRM_Utils_System::url($path, "$arg&event=delivered"),
2123       'bounce' => CRM_Utils_System::url($path, "$arg&event=bounce"),
2124       'unsubscribe' => CRM_Utils_System::url($path, "$arg&event=unsubscribe"),
2125       'optout' => CRM_Utils_System::url($path, "$arg&event=optout"),
2126       'forward' => CRM_Utils_System::url($path, "$arg&event=forward"),
2127       'reply' => CRM_Utils_System::url($path, "$arg&event=reply"),
2128       'opened' => CRM_Utils_System::url($path, "$arg&event=opened"),
2129     ];
2130
2131     $actionLinks = [CRM_Core_Action::VIEW => ['name' => ts('Report')]];
2132     $actionLinks[CRM_Core_Action::ADVANCED] = [
2133       'name' => ts('Advanced Search'),
2134       'url' => 'civicrm/contact/search/advanced',
2135     ];
2136     $action = array_sum(array_keys($actionLinks));
2137
2138     $report['event_totals']['actionlinks'] = [];
2139     foreach (['clicks', 'clicks_unique', 'queue', 'delivered', 'bounce', 'unsubscribe', 'forward', 'reply', 'opened', 'opened_unique', 'optout'] as $key) {
2140       $url = 'mailing/detail';
2141       $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2142       $searchFilter = "force=1&mailing_id=%%mid%%";
2143       switch ($key) {
2144         case 'delivered':
2145           $reportFilter .= "&delivery_status_value=successful";
2146           $searchFilter .= "&mailing_delivery_status=Y";
2147           break;
2148
2149         case 'bounce':
2150           $url = "mailing/bounce";
2151           $searchFilter .= "&mailing_delivery_status=N";
2152           break;
2153
2154         case 'forward':
2155           $reportFilter .= "&is_forwarded_value=1";
2156           $searchFilter .= "&mailing_forward=1";
2157           break;
2158
2159         case 'reply':
2160           $reportFilter .= "&is_replied_value=1";
2161           $searchFilter .= "&mailing_reply_status=Y";
2162           break;
2163
2164         case 'unsubscribe':
2165           $reportFilter .= "&is_unsubscribed_value=1";
2166           $searchFilter .= "&mailing_unsubscribe=1";
2167           break;
2168
2169         case 'optout':
2170           $reportFilter .= "&is_optout_value=1";
2171           $searchFilter .= "&mailing_optout=1";
2172           break;
2173
2174         case 'opened':
2175           // do not use group by clause in report, because same report used for total and unique open
2176           $reportFilter .= "&distinct=0";
2177         case 'opened_unique':
2178           $url = "mailing/opened";
2179           $searchFilter .= "&mailing_open_status=Y";
2180           break;
2181
2182         case 'clicks':
2183         case 'clicks_unique':
2184           $url = "mailing/clicks";
2185           $searchFilter .= "&mailing_click_status=Y";
2186           break;
2187       }
2188       $actionLinks[CRM_Core_Action::VIEW]['url'] = CRM_Report_Utils_Report::getNextUrl($url, $reportFilter, FALSE, TRUE);
2189       if (array_key_exists(CRM_Core_Action::ADVANCED, $actionLinks)) {
2190         $actionLinks[CRM_Core_Action::ADVANCED]['qs'] = $searchFilter;
2191       }
2192       $report['event_totals']['actionlinks'][$key] = CRM_Core_Action::formLink(
2193         $actionLinks,
2194         $action,
2195         ['mid' => $mailing_id],
2196         ts('more'),
2197         FALSE,
2198         'mailing.report.action',
2199         'Mailing',
2200         $mailing_id
2201       );
2202     }
2203
2204     return $report;
2205   }
2206
2207   /**
2208    * Get the count of mailings.
2209    *
2210    * @param
2211    *
2212    * @return int
2213    *   Count
2214    */
2215   public function getCount() {
2216     $this->selectAdd();
2217     $this->selectAdd('COUNT(id) as count');
2218
2219     $session = CRM_Core_Session::singleton();
2220     $this->find(TRUE);
2221
2222     return $this->count;
2223   }
2224
2225   /**
2226    * @param int $id
2227    *
2228    * @throws Exception
2229    */
2230   public static function checkPermission($id) {
2231     if (!$id) {
2232       return;
2233     }
2234
2235     $mailingIDs = self::mailingACLIDs();
2236     if ($mailingIDs === TRUE) {
2237       return;
2238     }
2239
2240     if (!in_array($id, $mailingIDs)) {
2241       throw new CRM_Core_Exception(ts('You do not have permission to access this mailing report'));
2242     }
2243   }
2244
2245   /**
2246    * @param null $alias
2247    *
2248    * @return string
2249    */
2250   public static function mailingACL($alias = NULL) {
2251     $mailingACL = " ( 0 ) ";
2252
2253     $mailingIDs = self::mailingACLIDs();
2254     if ($mailingIDs === TRUE) {
2255       return " ( 1 ) ";
2256     }
2257
2258     if (!empty($mailingIDs)) {
2259       $mailingIDs = implode(',', $mailingIDs);
2260       $tableName = !$alias ? self::getTableName() : $alias;
2261       $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2262     }
2263     return $mailingACL;
2264   }
2265
2266   /**
2267    * Returns all the mailings that this user can access. This is dependent on
2268    * all the groups that the user has access to.
2269    * However since most civi installs dont use ACL's we special case the condition
2270    * where the user has access to ALL groups, and hence ALL mailings and return a
2271    * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2272    *
2273    * @return bool|array
2274    *   TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2275    */
2276   public static function mailingACLIDs() {
2277     // CRM-11633
2278     // optimize common case where admin has access
2279     // to all mailings
2280     if (
2281       CRM_Core_Permission::check('view all contacts') ||
2282       CRM_Core_Permission::check('edit all contacts')
2283     ) {
2284       return TRUE;
2285     }
2286
2287     $mailingIDs = [];
2288
2289     // get all the groups that this user can access
2290     // if they dont have universal access
2291     $groupNames = civicrm_api3('Group', 'get', [
2292       'check_permissions' => TRUE,
2293       'return' => ['title', 'id'],
2294       'options' => ['limit' => 0],
2295     ]);
2296     foreach ($groupNames['values'] as $group) {
2297       $groups[$group['id']] = $group['title'];
2298     }
2299     if (!empty($groups)) {
2300       $groupIDs = implode(',', array_keys($groups));
2301       $domain_id = CRM_Core_Config::domainID();
2302
2303       // get all the mailings that are in this subset of groups
2304       $query = "
2305 SELECT    DISTINCT( m.id ) as id
2306   FROM    civicrm_mailing m
2307 LEFT JOIN civicrm_mailing_group g ON g.mailing_id   = m.id
2308  WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2309     OR   ( g.entity_table IS NULL AND g.entity_id IS NULL AND m.domain_id = $domain_id ) )
2310 ";
2311       $dao = CRM_Core_DAO::executeQuery($query);
2312
2313       $mailingIDs = [];
2314       while ($dao->fetch()) {
2315         $mailingIDs[] = $dao->id;
2316       }
2317       //CRM-18181 Get all mailings that use the mailings found earlier as receipients
2318       if (!empty($mailingIDs)) {
2319         $mailings = implode(',', $mailingIDs);
2320         $mailingQuery = "
2321            SELECT DISTINCT ( m.id ) as id
2322            FROM civicrm_mailing m
2323            LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2324            WHERE g.entity_table like 'civicrm_mailing%' AND g.entity_id IN ($mailings)";
2325         $mailingDao = CRM_Core_DAO::executeQuery($mailingQuery);
2326         while ($mailingDao->fetch()) {
2327           $mailingIDs[] = $mailingDao->id;
2328         }
2329       }
2330     }
2331
2332     return $mailingIDs;
2333   }
2334
2335   /**
2336    * Get the rows for a browse operation.
2337    *
2338    * @param int $offset
2339    *   The row number to start from.
2340    * @param int $rowCount
2341    *   The nmber of rows to return.
2342    * @param string $sort
2343    *   The sql string that describes the sort order.
2344    *
2345    * @param null $additionalClause
2346    * @param array $additionalParams
2347    *
2348    * @return array
2349    *   The rows
2350    */
2351   public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2352     $mailing = self::getTableName();
2353     $job = CRM_Mailing_BAO_MailingJob::getTableName();
2354     $group = CRM_Mailing_DAO_MailingGroup::getTableName();
2355     $session = CRM_Core_Session::singleton();
2356
2357     $mailingACL = self::mailingACL();
2358
2359     //get all campaigns.
2360     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2361     $select = [
2362       "$mailing.id",
2363       "$mailing.name",
2364       "$job.status",
2365       "$mailing.approval_status_id",
2366       "createdContact.sort_name as created_by",
2367       "scheduledContact.sort_name as scheduled_by",
2368       "$mailing.created_id as created_id",
2369       "$mailing.scheduled_id as scheduled_id",
2370       "$mailing.is_archived as archived",
2371       "$mailing.created_date as created_date",
2372       "campaign_id",
2373       "$mailing.sms_provider_id as sms_provider_id",
2374       "$mailing.language",
2375     ];
2376
2377     // we only care about parent jobs, since that holds all the info on
2378     // the mailing
2379     $selectClause = implode(', ', $select);
2380     $groupFromSelect = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($select, "$mailing.id");
2381     $query = "
2382             SELECT      {$selectClause},
2383                         MIN($job.scheduled_date) as scheduled_date,
2384                         MIN($job.start_date) as start_date,
2385                         MAX($job.end_date) as end_date
2386             FROM        $mailing
2387             LEFT JOIN   $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2388             LEFT JOIN   civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2389             LEFT JOIN   civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2390             WHERE       $mailingACL $additionalClause";
2391
2392     if (!empty($groupFromSelect)) {
2393       $query .= $groupFromSelect;
2394     }
2395
2396     if ($sort) {
2397       $orderBy = trim($sort->orderBy());
2398       if (!empty($orderBy)) {
2399         $query .= " ORDER BY $orderBy";
2400       }
2401     }
2402
2403     if ($rowCount) {
2404       $offset = CRM_Utils_Type::escape($offset, 'Int');
2405       $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
2406
2407       $query .= " LIMIT $offset, $rowCount ";
2408     }
2409
2410     if (!$additionalParams) {
2411       $additionalParams = [];
2412     }
2413
2414     $dao = CRM_Core_DAO::executeQuery($query, $additionalParams);
2415
2416     $rows = [];
2417     while ($dao->fetch()) {
2418       $rows[] = [
2419         'id' => $dao->id,
2420         'name' => $dao->name,
2421         'status' => $dao->status ? $dao->status : 'Not scheduled',
2422         'created_date' => CRM_Utils_Date::customFormat($dao->created_date),
2423         'scheduled' => CRM_Utils_Date::customFormat($dao->scheduled_date),
2424         'scheduled_iso' => $dao->scheduled_date,
2425         'start' => CRM_Utils_Date::customFormat($dao->start_date),
2426         'end' => CRM_Utils_Date::customFormat($dao->end_date),
2427         'created_by' => $dao->created_by,
2428         'scheduled_by' => $dao->scheduled_by,
2429         'created_id' => $dao->created_id,
2430         'scheduled_id' => $dao->scheduled_id,
2431         'archived' => $dao->archived,
2432         'approval_status_id' => $dao->approval_status_id,
2433         'campaign_id' => $dao->campaign_id,
2434         'campaign' => empty($dao->campaign_id) ? NULL : $allCampaigns[$dao->campaign_id],
2435         'sms_provider_id' => $dao->sms_provider_id,
2436         'language' => $dao->language,
2437       ];
2438     }
2439     return $rows;
2440   }
2441
2442   /**
2443    * Show detail Mailing report.
2444    *
2445    * @param int $id
2446    *
2447    * @return string
2448    */
2449   public static function showEmailDetails($id) {
2450     return CRM_Utils_System::url('civicrm/mailing/report', "mid=$id");
2451   }
2452
2453   /**
2454    * Delete Mails and all its associated records.
2455    *
2456    * @param int $id
2457    *   Id of the mail to delete.
2458    *
2459    * @return void
2460    */
2461   public static function del($id) {
2462     if (empty($id)) {
2463       throw new CRM_Core_Exception(ts('No id passed to mailing del function'));
2464     }
2465
2466     CRM_Utils_Hook::pre('delete', 'Mailing', $id);
2467
2468     // delete all file attachments
2469     CRM_Core_BAO_File::deleteEntityFile('civicrm_mailing',
2470       $id
2471     );
2472
2473     $dao = new CRM_Mailing_DAO_Mailing();
2474     $dao->id = $id;
2475     $dao->delete();
2476
2477     CRM_Core_Session::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2478
2479     CRM_Utils_Hook::post('delete', 'Mailing', $id, $dao);
2480   }
2481
2482   /**
2483    * @deprecated
2484    *  Use CRM_Mailing_BAO_MailingJob::del($id)
2485    *
2486    * @param int $id
2487    *   Id of the Job to delete.
2488    *
2489    * @return void
2490    */
2491   public static function delJob($id) {
2492     if (empty($id)) {
2493       throw new CRM_Core_Exception(ts('No id passed to mailing delJob function'));
2494     }
2495
2496     CRM_Core_Error::deprecatedWarning('This function is deprecated, use CRM_Mailing_BAO_MailingJob::del instead');
2497
2498     CRM_Mailing_BAO_MailingJob::del($id);
2499   }
2500
2501   /**
2502    * @deprecated
2503    *   This is used by CiviMail but will be made redundant by FlexMailer/TokenProcessor.
2504    * @return array
2505    */
2506   public function getReturnProperties() {
2507     $tokens = &$this->getTokens();
2508
2509     $properties = [];
2510     if (isset($tokens['html']) &&
2511       isset($tokens['html']['contact'])
2512     ) {
2513       $properties = array_merge($properties, $tokens['html']['contact']);
2514     }
2515
2516     if (isset($tokens['text']) &&
2517       isset($tokens['text']['contact'])
2518     ) {
2519       $properties = array_merge($properties, $tokens['text']['contact']);
2520     }
2521
2522     if (isset($tokens['subject']) &&
2523       isset($tokens['subject']['contact'])
2524     ) {
2525       $properties = array_merge($properties, $tokens['subject']['contact']);
2526     }
2527
2528     $returnProperties = [];
2529     $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2530
2531     foreach ($properties as $p) {
2532       $returnProperties[$p] = 1;
2533     }
2534
2535     return $returnProperties;
2536   }
2537
2538   /**
2539    * Build the  compose mail form.
2540    *
2541    * @param CRM_Core_Form $form
2542    *
2543    * @return void
2544    */
2545   public static function commonCompose(&$form) {
2546     //get the tokens.
2547     $tokens = [];
2548
2549     if (method_exists($form, 'listTokens')) {
2550       $tokens = array_merge($form->listTokens(), $tokens);
2551     }
2552
2553     //sorted in ascending order tokens by ignoring word case
2554     $form->assign('tokens', CRM_Utils_Token::formatTokensForDisplay($tokens));
2555
2556     $templates = [];
2557
2558     $textFields = [
2559       'text_message' => ts('HTML Format'),
2560       'sms_text_message' => ts('SMS Message'),
2561     ];
2562     $modePrefixes = ['Mail' => NULL, 'SMS' => 'SMS'];
2563
2564     $className = CRM_Utils_System::getClassName($form);
2565
2566     if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2567       $className != 'CRM_Contact_Form_Task_SMS'
2568     ) {
2569       $form->add('wysiwyg', 'html_message',
2570         strstr($className, 'PDF') ? ts('Document Body') : ts('HTML Format'),
2571         [
2572           'cols' => '80',
2573           'rows' => '8',
2574           'onkeyup' => "return verify(this)",
2575         ]
2576       );
2577
2578       if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2579         unset($modePrefixes['SMS']);
2580       }
2581     }
2582     else {
2583       unset($textFields['text_message']);
2584       unset($modePrefixes['Mail']);
2585     }
2586
2587     //insert message Text by selecting "Select Template option"
2588     foreach ($textFields as $id => $label) {
2589       $prefix = NULL;
2590       if ($id == 'sms_text_message') {
2591         $prefix = "SMS";
2592         $form->assign('max_sms_length', CRM_SMS_Provider::MAX_SMS_CHAR);
2593       }
2594       $form->add('textarea', $id, $label,
2595         [
2596           'cols' => '80',
2597           'rows' => '8',
2598           'onkeyup' => "return verify(this, '{$prefix}')",
2599         ]
2600       );
2601     }
2602
2603     foreach ($modePrefixes as $prefix) {
2604       if ($prefix == 'SMS') {
2605         $templates[$prefix] = CRM_Core_BAO_MessageTemplate::getMessageTemplates(FALSE, TRUE);
2606       }
2607       else {
2608         $templates[$prefix] = CRM_Core_BAO_MessageTemplate::getMessageTemplates(FALSE);
2609       }
2610       if (!empty($templates[$prefix])) {
2611         $form->assign('templates', TRUE);
2612
2613         $form->add('select', "{$prefix}template", ts('Use Template'),
2614           ['' => ts('- select -')] + $templates[$prefix], FALSE,
2615           ['onChange' => "selectValue( this.value, '{$prefix}');"]
2616         );
2617       }
2618       $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2619
2620       $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2621         ['onclick' => "showSaveDetails(this, '{$prefix}');"]
2622       );
2623       $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2624     }
2625
2626     // I'm not sure this is ever called.
2627     $action = CRM_Utils_Request::retrieve('action', 'String', $form, FALSE);
2628     if ((CRM_Utils_System::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2629       $action == CRM_Core_Action::VIEW
2630     ) {
2631       $form->freeze('html_message');
2632     }
2633   }
2634
2635   /**
2636    * Get the search based mailing Ids.
2637    *
2638    * @return array
2639    *   , searched base mailing ids.
2640    */
2641   public function searchMailingIDs() {
2642     $group = CRM_Mailing_DAO_MailingGroup::getTableName();
2643     $mailing = self::getTableName();
2644
2645     $query = "
2646 SELECT  $mailing.id as mailing_id
2647   FROM  $mailing, $group
2648  WHERE  $group.mailing_id = $mailing.id
2649    AND  $group.group_type = 'Base'";
2650
2651     $searchDAO = CRM_Core_DAO::executeQuery($query);
2652     $mailingIDs = [];
2653     while ($searchDAO->fetch()) {
2654       $mailingIDs[] = $searchDAO->mailing_id;
2655     }
2656
2657     return $mailingIDs;
2658   }
2659
2660   /**
2661    * Get the content/components of mailing based on mailing Id
2662    *
2663    * @param array $report
2664    *   of mailing report.
2665    *
2666    * @param $form
2667    *   Reference of this.
2668    *
2669    * @param bool $isSMS
2670    *
2671    * @return array
2672    *   array content/component.
2673    */
2674   public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2675     $htmlHeader = $textHeader = NULL;
2676     $htmlFooter = $textFooter = NULL;
2677
2678     if (!$isSMS) {
2679       if ($report['mailing']['header_id']) {
2680         $header = new CRM_Mailing_BAO_MailingComponent();
2681         $header->id = $report['mailing']['header_id'];
2682         $header->find(TRUE);
2683         $htmlHeader = $header->body_html;
2684         $textHeader = $header->body_text;
2685       }
2686
2687       if ($report['mailing']['footer_id']) {
2688         $footer = new CRM_Mailing_BAO_MailingComponent();
2689         $footer->id = $report['mailing']['footer_id'];
2690         $footer->find(TRUE);
2691         $htmlFooter = $footer->body_html;
2692         $textFooter = $footer->body_text;
2693       }
2694     }
2695
2696     $mailingKey = $form->_mailing_id;
2697     if (!$isSMS) {
2698       if ($hash = CRM_Mailing_BAO_Mailing::getMailingHash($mailingKey)) {
2699         $mailingKey = $hash;
2700       }
2701     }
2702
2703     if (!empty($report['mailing']['body_text'])) {
2704       $url = CRM_Utils_System::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2705       $form->assign('textViewURL', $url);
2706     }
2707
2708     if (!$isSMS) {
2709       if (!empty($report['mailing']['body_html'])) {
2710         $url = CRM_Utils_System::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2711         $form->assign('htmlViewURL', $url);
2712       }
2713     }
2714
2715     if (!$isSMS) {
2716       $report['mailing']['attachment'] = CRM_Core_BAO_File::attachmentInfo('civicrm_mailing', $form->_mailing_id);
2717     }
2718     return $report;
2719   }
2720
2721   /**
2722    * @param int $jobID
2723    *
2724    * @return mixed
2725    */
2726   public static function overrideVerp($jobID) {
2727     static $_cache = [];
2728
2729     if (!isset($_cache[$jobID])) {
2730       $query = "
2731 SELECT     override_verp
2732 FROM       civicrm_mailing
2733 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2734 WHERE  civicrm_mailing_job.id = %1
2735 ";
2736       $params = [1 => [$jobID, 'Integer']];
2737       $_cache[$jobID] = CRM_Core_DAO::singleValueQuery($query, $params);
2738     }
2739     return $_cache[$jobID];
2740   }
2741
2742   /**
2743    * @param null $mode
2744    *
2745    * @return bool
2746    * @throws Exception
2747    */
2748   public static function processQueue($mode = NULL) {
2749     $config = CRM_Core_Config::singleton();
2750
2751     if ($mode == NULL && CRM_Core_BAO_MailSettings::defaultDomain() == "EXAMPLE.ORG") {
2752       throw new CRM_Core_Exception(ts('The <a href="%1">default mailbox</a> has not been configured. You will find <a href="%2">more info in the online system administrator guide</a>', [
2753         1 => CRM_Utils_System::url('civicrm/admin/mailSettings', 'reset=1'),
2754         2 => "https://docs.civicrm.org/sysadmin/en/latest/setup/civimail/",
2755       ]));
2756     }
2757
2758     // check if we are enforcing number of parallel cron jobs
2759     // CRM-8460
2760     $gotCronLock = FALSE;
2761
2762     $mailerJobsMax = Civi::settings()->get('mailerJobsMax');
2763     if (is_numeric($mailerJobsMax) && $mailerJobsMax > 0) {
2764       $lockArray = range(1, $mailerJobsMax);
2765
2766       // Shuffle the array to improve chances of quickly finding an open thread
2767       shuffle($lockArray);
2768
2769       // Check if we are using global locks
2770       foreach ($lockArray as $lockID) {
2771         $cronLock = Civi::lockManager()
2772           ->acquire("worker.mailing.send.{$lockID}");
2773         if ($cronLock->isAcquired()) {
2774           $gotCronLock = TRUE;
2775           break;
2776         }
2777       }
2778
2779       // Exit here since we have enough mailing processes running
2780       if (!$gotCronLock) {
2781         CRM_Core_Error::debug_log_message('Returning early, since the maximum number of mailing processes are running');
2782         return TRUE;
2783       }
2784
2785       if (getenv('CIVICRM_CRON_HOLD')) {
2786         // In testing, we may need to simulate some slow activities.
2787         sleep(getenv('CIVICRM_CRON_HOLD'));
2788       }
2789     }
2790
2791     // Split up the parent jobs into multiple child jobs
2792     $mailerJobSize = Civi::settings()->get('mailerJobSize');
2793     CRM_Mailing_BAO_MailingJob::runJobs_pre($mailerJobSize, $mode);
2794     CRM_Mailing_BAO_MailingJob::runJobs(NULL, $mode);
2795     CRM_Mailing_BAO_MailingJob::runJobs_post($mode);
2796
2797     // Release the global lock if we do have one
2798     if ($gotCronLock) {
2799       $cronLock->release();
2800     }
2801
2802     return TRUE;
2803   }
2804
2805   /**
2806    * @param int $mailingID
2807    */
2808   private static function addMultipleEmails($mailingID) {
2809     $sql = "
2810 INSERT INTO civicrm_mailing_recipients
2811     (mailing_id, email_id, contact_id)
2812 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2813 WHERE  e.on_hold = 0
2814 AND    e.is_bulkmail = 1
2815 AND    e.contact_id IN
2816     ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2817 AND    e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2818 ";
2819     $params = [1 => [$mailingID, 'Integer']];
2820
2821     $dao = CRM_Core_DAO::executeQuery($sql, $params);
2822   }
2823
2824   /**
2825    * @param bool $isSMS
2826    *
2827    * @return mixed
2828    */
2829   public static function getMailingsList($isSMS = FALSE) {
2830     static $list = [];
2831     $where = " WHERE ";
2832     if (!$isSMS) {
2833       $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2834     }
2835     else {
2836       $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2837     }
2838
2839     if (empty($list)) {
2840       $query = "
2841 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2842 FROM   civicrm_mailing
2843 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2844 ORDER BY civicrm_mailing.name";
2845       $mailing = CRM_Core_DAO::executeQuery($query);
2846
2847       while ($mailing->fetch()) {
2848         $list[$mailing->id] = "{$mailing->name} :: {$mailing->end_date}";
2849       }
2850     }
2851
2852     return $list;
2853   }
2854
2855   /**
2856    * wrapper for ajax activity selector.
2857    *
2858    * @param array $params
2859    *   Associated array for params record id.
2860    *
2861    * @return array
2862    *   associated array of contact activities
2863    */
2864   public static function getContactMailingSelector(&$params) {
2865     // format the params
2866     $params['offset'] = ($params['page'] - 1) * $params['rp'];
2867     $params['rowCount'] = $params['rp'];
2868     $params['sort'] = $params['sortBy'] ?? NULL;
2869     $params['caseId'] = NULL;
2870
2871     // get contact mailings
2872     $mailings = CRM_Mailing_BAO_Mailing::getContactMailings($params);
2873
2874     // add total
2875     $params['total'] = CRM_Mailing_BAO_Mailing::getContactMailingsCount($params);
2876
2877     //CRM-12814
2878     if (!empty($mailings)) {
2879       $openCounts = CRM_Mailing_Event_BAO_Opened::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2880       $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2881     }
2882
2883     // format params and add links
2884     $contactMailings = [];
2885     foreach ($mailings as $mailingId => $values) {
2886       $mailing = [];
2887       $mailing['subject'] = $values['subject'];
2888       $mailing['creator_name'] = CRM_Utils_System::href(
2889         $values['creator_name'],
2890         'civicrm/contact/view',
2891         "reset=1&cid={$values['creator_id']}");
2892       $mailing['recipients'] = CRM_Utils_System::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2893         "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2894       $mailing['start_date'] = CRM_Utils_Date::customFormat($values['start_date']);
2895       //CRM-12814
2896       $mailing['openstats'] = "Opens: " .
2897         CRM_Utils_Array::value($values['mailing_id'], $openCounts, 0) .
2898         "<br />Clicks: " .
2899         CRM_Utils_Array::value($values['mailing_id'], $clickCounts, 0);
2900
2901       $actionLinks = [
2902         CRM_Core_Action::VIEW => [
2903           'name' => ts('View'),
2904           'url' => 'civicrm/mailing/view',
2905           'qs' => "reset=1&id=%%mkey%%",
2906           'title' => ts('View Mailing'),
2907           'class' => 'crm-popup',
2908         ],
2909         CRM_Core_Action::BROWSE => [
2910           'name' => ts('Mailing Report'),
2911           'url' => 'civicrm/mailing/report',
2912           'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
2913           'title' => ts('View Mailing Report'),
2914         ],
2915       ];
2916
2917       $mailingKey = $values['mailing_id'];
2918       if ($hash = CRM_Mailing_BAO_Mailing::getMailingHash($mailingKey)) {
2919         $mailingKey = $hash;
2920       }
2921
2922       $mailing['links'] = CRM_Core_Action::formLink(
2923         $actionLinks,
2924         NULL,
2925         [
2926           'mid' => $values['mailing_id'],
2927           'cid' => $params['contact_id'],
2928           'mkey' => $mailingKey,
2929         ],
2930         ts('more'),
2931         FALSE,
2932         'mailing.contact.action',
2933         'Mailing',
2934         $values['mailing_id']
2935       );
2936
2937       array_push($contactMailings, $mailing);
2938     }
2939
2940     $contactMailingsDT = [];
2941     $contactMailingsDT['data'] = $contactMailings;
2942     $contactMailingsDT['recordsTotal'] = $params['total'];
2943     $contactMailingsDT['recordsFiltered'] = $params['total'];
2944
2945     return $contactMailingsDT;
2946   }
2947
2948   /**
2949    * Retrieve contact mailing.
2950    *
2951    * @param array $params
2952    *
2953    * @return array
2954    *   Array of mailings for a contact
2955    *
2956    */
2957   public static function getContactMailings(&$params) {
2958     $params['version'] = 3;
2959     $params['offset'] = ($params['page'] - 1) * $params['rp'];
2960     $params['limit'] = $params['rp'];
2961     $params['sort'] = $params['sortBy'] ?? NULL;
2962
2963     $result = civicrm_api('MailingContact', 'get', $params);
2964     return $result['values'];
2965   }
2966
2967   /**
2968    * Retrieve contact mailing count.
2969    *
2970    * @param array $params
2971    *
2972    * @return int
2973    *   count of mailings for a contact
2974    *
2975    */
2976   public static function getContactMailingsCount(&$params) {
2977     $params['version'] = 3;
2978     return civicrm_api('MailingContact', 'getcount', $params);
2979   }
2980
2981   /**
2982    * Get a list of permissions required for CRUD'ing each field
2983    * (when workflow is enabled).
2984    *
2985    * @return array
2986    *   Array (string $fieldName => string $permName)
2987    */
2988   public static function getWorkflowFieldPerms() {
2989     $fieldNames = array_keys(CRM_Mailing_DAO_Mailing::fields());
2990     $fieldPerms = [];
2991     foreach ($fieldNames as $fieldName) {
2992       if ($fieldName == 'id') {
2993         $fieldPerms[$fieldName] = [
2994           // OR
2995           [
2996             'access CiviMail',
2997             'schedule mailings',
2998             'approve mailings',
2999           ],
3000         ];
3001       }
3002       elseif (in_array($fieldName, ['scheduled_date', 'scheduled_id'])) {
3003         $fieldPerms[$fieldName] = [
3004           // OR
3005           ['access CiviMail', 'schedule mailings'],
3006         ];
3007       }
3008       elseif (in_array($fieldName, [
3009         'approval_date',
3010         'approver_id',
3011         'approval_status_id',
3012         'approval_note',
3013       ])) {
3014         $fieldPerms[$fieldName] = [
3015           // OR
3016           ['access CiviMail', 'approve mailings'],
3017         ];
3018       }
3019       else {
3020         $fieldPerms[$fieldName] = [
3021           // OR
3022           ['access CiviMail', 'create mailings'],
3023         ];
3024       }
3025     }
3026     return $fieldPerms;
3027   }
3028
3029   /**
3030    * White-list of possible values for the entity_table field.
3031    *
3032    * @return array
3033    */
3034   public static function mailingGroupEntityTables() {
3035     return [
3036       CRM_Contact_BAO_Group::getTableName() => 'Group',
3037       CRM_Mailing_BAO_Mailing::getTableName() => 'Mailing',
3038     ];
3039   }
3040
3041   /**
3042    * Get the public view url.
3043    *
3044    * @param int $id
3045    * @param bool $absolute
3046    *
3047    * @return string
3048    */
3049   public static function getPublicViewUrl($id, $absolute = TRUE) {
3050     if ((civicrm_api3('Mailing', 'getvalue', [
3051       'id' => $id,
3052       'return' => 'visibility',
3053     ])) === 'Public Pages') {
3054
3055       // if hash setting is on then we change the public url into a hash
3056       $hash = CRM_Mailing_BAO_Mailing::getMailingHash($id);
3057       if (!empty($hash)) {
3058         $id = $hash;
3059       }
3060
3061       return CRM_Utils_System::url('civicrm/mailing/view', ['id' => $id], $absolute, NULL, TRUE, TRUE);
3062     }
3063   }
3064
3065   /**
3066    * Get a list of template types which can be used as `civicrm_mailing.template_type`.
3067    *
3068    * @return array
3069    *   A list of template-types, keyed numerically. Each defines:
3070    *     - name: string, a short symbolic name
3071    *     - editorUrl: string, Angular template name
3072    *
3073    *   Ex: $templateTypes[0] === array('name' => 'mosaico', 'editorUrl' => '~/crmMosaico/editor.html').
3074    */
3075   public static function getTemplateTypes() {
3076     if (!isset(Civi::$statics[__CLASS__]['templateTypes'])) {
3077       $types = [];
3078       $types[] = [
3079         'name' => 'traditional',
3080         'editorUrl' => CRM_Mailing_Info::workflowEnabled() ? '~/crmMailing/EditMailingCtrl/workflow.html' : '~/crmMailing/EditMailingCtrl/2step.html',
3081         'weight' => 0,
3082       ];
3083
3084       CRM_Utils_Hook::mailingTemplateTypes($types);
3085
3086       $defaults = ['weight' => 0];
3087       foreach (array_keys($types) as $typeName) {
3088         $types[$typeName] = array_merge($defaults, $types[$typeName]);
3089       }
3090       usort($types, function ($a, $b) {
3091         if ($a['weight'] === $b['weight']) {
3092           return 0;
3093         }
3094         return $a['weight'] < $b['weight'] ? -1 : 1;
3095       });
3096
3097       Civi::$statics[__CLASS__]['templateTypes'] = $types;
3098     }
3099
3100     return Civi::$statics[__CLASS__]['templateTypes'];
3101   }
3102
3103   /**
3104    * Get a list of template types.
3105    *
3106    * @return array
3107    *   Array(string $name => string $label).
3108    */
3109   public static function getTemplateTypeNames() {
3110     $r = [];
3111     foreach (self::getTemplateTypes() as $type) {
3112       $r[$type['name']] = $type['name'];
3113     }
3114     return $r;
3115   }
3116
3117 }