CRM/Core/BAO/ActionSchedule.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2019                                |
   7    +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  10   | CiviCRM is free software; you can copy, modify, and distribute it  |
  11   | under the terms of the GNU Affero General Public License           |
  12   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13   |                                                                    |
  14   | CiviCRM is distributed in the hope that it will be useful, but     |
  15   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17   | See the GNU Affero General Public License for more details.        |
  18   |                                                                    |
  19   | You should have received a copy of the GNU Affero General Public   |
  20   | License and the CiviCRM Licensing Exception along                  |
  21   | with this program; if not, contact CiviCRM LLC                     |
  22   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23   | GNU Affero General Public License or the licensing of CiviCRM,     |
  24   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25   +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class contains functions for managing Scheduled Reminders
  38  */
  39 class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule {
  40
  41   /**
  42    * @param array $filters
  43    *   Filter by property (e.g. 'id').
  44    * @return array
  45    *   Array(scalar $id => Mapping $mapping).
  46    */
  47   public static function getMappings($filters = NULL) {
  48     static $_action_mapping;
  49
  50     if ($_action_mapping === NULL) {
  51       $event = \Civi\Core\Container::singleton()->get('dispatcher')
  52         ->dispatch(\Civi\ActionSchedule\Events::MAPPINGS,
  53           new \Civi\ActionSchedule\Event\MappingRegisterEvent());
  54       $_action_mapping = $event->getMappings();
  55     }
  56
  57     if (empty($filters)) {
  58       return $_action_mapping;
  59     }
  60     elseif (isset($filters['id'])) {
  61       return [
  62         $filters['id'] => $_action_mapping[$filters['id']],
  63       ];
  64     }
  65     else {
  66       throw new CRM_Core_Exception("getMappings() called with unsupported filter: " . implode(', ', array_keys($filters)));
  67     }
  68   }
  69
  70   /**
  71    * @param string|int $id
  72    * @return \Civi\ActionSchedule\Mapping|NULL
  73    */
  74   public static function getMapping($id) {
  75     $mappings = self::getMappings();
  76     return isset($mappings[$id]) ? $mappings[$id] : NULL;
  77   }
  78
  79   /**
  80    * For each entity, get a list of entity-value labels.
  81    *
  82    * @return array
  83    *   Ex: $entityValueLabels[$mappingId][$valueId] = $valueLabel.
  84    * @throws CRM_Core_Exception
  85    */
  86   public static function getAllEntityValueLabels() {
  87     $entityValueLabels = [];
  88     foreach (CRM_Core_BAO_ActionSchedule::getMappings() as $mapping) {
  89       /** @var \Civi\ActionSchedule\Mapping $mapping */
  90       $entityValueLabels[$mapping->getId()] = $mapping->getValueLabels();
  91       $valueLabel = ['- ' . strtolower($mapping->getValueHeader()) . ' -'];
  92       $entityValueLabels[$mapping->getId()] = $valueLabel + $entityValueLabels[$mapping->getId()];
  93     }
  94     return $entityValueLabels;
  95   }
  96
  97   /**
  98    * For each entity, get a list of entity-status labels.
  99    *
 100    * @return array
 101    *   Ex: $entityValueLabels[$mappingId][$valueId][$statusId] = $statusLabel.
 102    */
 103   public static function getAllEntityStatusLabels() {
 104     $entityValueLabels = self::getAllEntityValueLabels();
 105     $entityStatusLabels = [];
 106     foreach (CRM_Core_BAO_ActionSchedule::getMappings() as $mapping) {
 107       /** @var \Civi\ActionSchedule\Mapping $mapping */
 108       $statusLabel = ['- ' . strtolower($mapping->getStatusHeader()) . ' -'];
 109       $entityStatusLabels[$mapping->getId()] = $entityValueLabels[$mapping->getId()];
 110       foreach ($entityStatusLabels[$mapping->getId()] as $kkey => & $vval) {
 111         $vval = $statusLabel + $mapping->getStatusLabels($kkey);
 112       }
 113     }
 114     return $entityStatusLabels;
 115   }
 116
 117   /**
 118    * Retrieve list of Scheduled Reminders.
 119    *
 120    * @param bool $namesOnly
 121    *   Return simple list of names.
 122    *
 123    * @param \Civi\ActionSchedule\Mapping|NULL $filterMapping
 124    *   Filter by the schedule's mapping type.
 125    * @param int $filterValue
 126    *   Filter by the schedule's entity_value.
 127    *
 128    * @return array
 129    *   (reference)   reminder list
 130    */
 131   public static function &getList($namesOnly = FALSE, $filterMapping = NULL, $filterValue = NULL) {
 132     $query = "
 133 SELECT
 134        title,
 135        cas.id as id,
 136        cas.mapping_id,
 137        cas.entity_value as entityValueIds,
 138        cas.entity_status as entityStatusIds,
 139        cas.start_action_date as entityDate,
 140        cas.start_action_offset,
 141        cas.start_action_unit,
 142        cas.start_action_condition,
 143        cas.absolute_date,
 144        is_repeat,
 145        is_active
 146
 147 FROM civicrm_action_schedule cas
 148 ";
 149     $queryParams = [];
 150     $where = " WHERE 1 ";
 151     if ($filterMapping and $filterValue) {
 152       $where .= " AND cas.entity_value = %1 AND cas.mapping_id = %2";
 153       $queryParams[1] = [$filterValue, 'Integer'];
 154       $queryParams[2] = [$filterMapping->getId(), 'String'];
 155     }
 156     $where .= " AND cas.used_for IS NULL";
 157     $query .= $where;
 158     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 159     while ($dao->fetch()) {
 160       /** @var Civi\ActionSchedule\Mapping $filterMapping */
 161       $filterMapping = CRM_Utils_Array::first(self::getMappings([
 162         'id' => $dao->mapping_id,
 163       ]));
 164       $list[$dao->id]['id'] = $dao->id;
 165       $list[$dao->id]['title'] = $dao->title;
 166       $list[$dao->id]['start_action_offset'] = $dao->start_action_offset;
 167       $list[$dao->id]['start_action_unit'] = $dao->start_action_unit;
 168       $list[$dao->id]['start_action_condition'] = $dao->start_action_condition;
 169       $list[$dao->id]['entityDate'] = ucwords(str_replace('_', ' ', $dao->entityDate));
 170       $list[$dao->id]['absolute_date'] = $dao->absolute_date;
 171       $list[$dao->id]['entity'] = $filterMapping->getLabel();
 172       $list[$dao->id]['value'] = implode(', ', CRM_Utils_Array::subset(
 173         $filterMapping->getValueLabels(),
 174         explode(CRM_Core_DAO::VALUE_SEPARATOR, $dao->entityValueIds)
 175       ));
 176       $list[$dao->id]['status'] = implode(', ', CRM_Utils_Array::subset(
 177         $filterMapping->getStatusLabels($dao->entityValueIds),
 178         explode(CRM_Core_DAO::VALUE_SEPARATOR, $dao->entityStatusIds)
 179       ));
 180       $list[$dao->id]['is_repeat'] = $dao->is_repeat;
 181       $list[$dao->id]['is_active'] = $dao->is_active;
 182     }
 183
 184     return $list;
 185   }
 186
 187   /**
 188    * Add the schedules reminders in the db.
 189    *
 190    * @param array $params
 191    *   (reference ) an assoc array of name/value pairs.
 192    * @param array $ids
 193    *   Unused variable.
 194    *
 195    * @return CRM_Core_DAO_ActionSchedule
 196    */
 197   public static function add(&$params, $ids = []) {
 198     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 199     $actionSchedule->copyValues($params);
 200
 201     return $actionSchedule->save();
 202   }
 203
 204   /**
 205    * Retrieve DB object based on input parameters.
 206    *
 207    * It also stores all the retrieved values in the default array.
 208    *
 209    * @param array $params
 210    *   (reference ) an assoc array of name/value pairs.
 211    * @param array $values
 212    *   (reference ) an assoc array to hold the flattened values.
 213    *
 214    * @return CRM_Core_DAO_ActionSchedule|null
 215    *   object on success, null otherwise
 216    */
 217   public static function retrieve(&$params, &$values) {
 218     if (empty($params)) {
 219       return NULL;
 220     }
 221     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 222
 223     $actionSchedule->copyValues($params);
 224
 225     if ($actionSchedule->find(TRUE)) {
 226       $ids['actionSchedule'] = $actionSchedule->id;
 227
 228       CRM_Core_DAO::storeValues($actionSchedule, $values);
 229
 230       return $actionSchedule;
 231     }
 232     return NULL;
 233   }
 234
 235   /**
 236    * Delete a Reminder.
 237    *
 238    * @param int $id
 239    *   ID of the Reminder to be deleted.
 240    *
 241    */
 242   public static function del($id) {
 243     if ($id) {
 244       $dao = new CRM_Core_DAO_ActionSchedule();
 245       $dao->id = $id;
 246       if ($dao->find(TRUE)) {
 247         $dao->delete();
 248         return;
 249       }
 250     }
 251     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 252   }
 253
 254   /**
 255    * Update the is_active flag in the db.
 256    *
 257    * @param int $id
 258    *   Id of the database record.
 259    * @param bool $is_active
 260    *   Value we want to set the is_active field.
 261    *
 262    * @return bool
 263    *   true if we found and updated the object, else false
 264    */
 265   public static function setIsActive($id, $is_active) {
 266     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_ActionSchedule', $id, 'is_active', $is_active);
 267   }
 268
 269   /**
 270    * @param int $mappingID
 271    * @param $now
 272    *
 273    * @throws CRM_Core_Exception
 274    */
 275   public static function sendMailings($mappingID, $now) {
 276     $mapping = CRM_Utils_Array::first(self::getMappings([
 277       'id' => $mappingID,
 278     ]));
 279
 280     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 281     $actionSchedule->mapping_id = $mappingID;
 282     $actionSchedule->is_active = 1;
 283     $actionSchedule->find(FALSE);
 284
 285     while ($actionSchedule->fetch()) {
 286       $query = CRM_Core_BAO_ActionSchedule::prepareMailingQuery($mapping, $actionSchedule);
 287       $dao = CRM_Core_DAO::executeQuery($query,
 288         [1 => [$actionSchedule->id, 'Integer']]
 289       );
 290
 291       $multilingual = CRM_Core_I18n::isMultilingual();
 292       while ($dao->fetch()) {
 293         // switch language if necessary
 294         if ($multilingual) {
 295           $preferred_language = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $dao->contactID, 'preferred_language');
 296           CRM_Core_BAO_ActionSchedule::setCommunicationLanguage($actionSchedule->communication_language, $preferred_language);
 297         }
 298
 299         $errors = [];
 300         try {
 301           $tokenProcessor = self::createTokenProcessor($actionSchedule, $mapping);
 302           $tokenProcessor->addRow()
 303             ->context('contactId', $dao->contactID)
 304             ->context('actionSearchResult', (object) $dao->toArray());
 305           foreach ($tokenProcessor->evaluate()->getRows() as $tokenRow) {
 306             if ($actionSchedule->mode == 'SMS' or $actionSchedule->mode == 'User_Preference') {
 307               CRM_Utils_Array::extend($errors, self::sendReminderSms($tokenRow, $actionSchedule, $dao->contactID));
 308             }
 309
 310             if ($actionSchedule->mode == 'Email' or $actionSchedule->mode == 'User_Preference') {
 311               CRM_Utils_Array::extend($errors, self::sendReminderEmail($tokenRow, $actionSchedule, $dao->contactID));
 312             }
 313             // insert activity log record if needed
 314             if ($actionSchedule->record_activity && empty($errors)) {
 315               $caseID = empty($dao->case_id) ? NULL : $dao->case_id;
 316               CRM_Core_BAO_ActionSchedule::createMailingActivity($tokenRow, $mapping, $dao->contactID, $dao->entityID, $caseID);
 317             }
 318           }
 319         }
 320         catch (\Civi\Token\TokenException $e) {
 321           $errors['token_exception'] = $e->getMessage();
 322         }
 323
 324         // update action log record
 325         $logParams = [
 326           'id' => $dao->reminderID,
 327           'is_error' => !empty($errors),
 328           'message' => empty($errors) ? "null" : implode(' ', $errors),
 329           'action_date_time' => $now,
 330         ];
 331         CRM_Core_BAO_ActionLog::create($logParams);
 332       }
 333
 334       $dao->free();
 335     }
 336   }
 337
 338   /**
 339    * @param int $mappingID
 340    * @param $now
 341    * @param array $params
 342    *
 343    * @throws API_Exception
 344    */
 345   public static function buildRecipientContacts($mappingID, $now, $params = []) {
 346     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 347     $actionSchedule->mapping_id = $mappingID;
 348     $actionSchedule->is_active = 1;
 349     if (!empty($params)) {
 350       _civicrm_api3_dao_set_filter($actionSchedule, $params, FALSE);
 351     }
 352     $actionSchedule->find();
 353
 354     while ($actionSchedule->fetch()) {
 355       /** @var \Civi\ActionSchedule\Mapping $mapping */
 356       $mapping = CRM_Utils_Array::first(self::getMappings([
 357         'id' => $mappingID,
 358       ]));
 359       $builder = new \Civi\ActionSchedule\RecipientBuilder($now, $actionSchedule, $mapping);
 360       $builder->build();
 361     }
 362   }
 363
 364   /**
 365    * @param null $now
 366    * @param array $params
 367    *
 368    * @return array
 369    */
 370   public static function processQueue($now = NULL, $params = []) {
 371     $now = $now ? CRM_Utils_Time::setTime($now) : CRM_Utils_Time::getTime();
 372
 373     $mappings = CRM_Core_BAO_ActionSchedule::getMappings();
 374     foreach ($mappings as $mappingID => $mapping) {
 375       CRM_Core_BAO_ActionSchedule::buildRecipientContacts($mappingID, $now, $params);
 376       CRM_Core_BAO_ActionSchedule::sendMailings($mappingID, $now);
 377     }
 378
 379     $result = [
 380       'is_error' => 0,
 381       'messages' => ts('Sent all scheduled reminders successfully'),
 382     ];
 383     return $result;
 384   }
 385
 386   /**
 387    * @param int $id
 388    * @param int $mappingID
 389    *
 390    * @return null|string
 391    */
 392   public static function isConfigured($id, $mappingID) {
 393     $queryString = "SELECT count(id) FROM civicrm_action_schedule
 394                         WHERE  mapping_id = %1 AND
 395                                entity_value = %2";
 396
 397     $params = [
 398       1 => [$mappingID, 'String'],
 399       2 => [$id, 'Integer'],
 400     ];
 401     return CRM_Core_DAO::singleValueQuery($queryString, $params);
 402   }
 403
 404   /**
 405    * @param int $mappingID
 406    * @param $recipientType
 407    *
 408    * @return array
 409    */
 410   public static function getRecipientListing($mappingID, $recipientType) {
 411     if (!$mappingID) {
 412       return [];
 413     }
 414
 415     /** @var \Civi\ActionSchedule\Mapping $mapping */
 416     $mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings([
 417       'id' => $mappingID,
 418     ]));
 419     return $mapping->getRecipientListing($recipientType);
 420   }
 421
 422   /**
 423    * @param $communication_language
 424    * @param $preferred_language
 425    */
 426   public static function setCommunicationLanguage($communication_language, $preferred_language) {
 427     $currentLocale = CRM_Core_I18n::getLocale();
 428     $language = $currentLocale;
 429
 430     // prepare the language for the email
 431     if ($communication_language == CRM_Core_I18n::AUTO) {
 432       if (!empty($preferred_language)) {
 433         $language = $preferred_language;
 434       }
 435     }
 436     else {
 437       $language = $communication_language;
 438     }
 439
 440     // language not in the existing language, use default
 441     $languages = CRM_Core_I18n::languages(TRUE);
 442     if (!array_key_exists($language, $languages)) {
 443       $language = $currentLocale;
 444     }
 445
 446     // change the language
 447     $i18n = CRM_Core_I18n::singleton();
 448     $i18n->setLocale($language);
 449   }
 450
 451   /**
 452    * Save a record about the delivery of a reminder email.
 453    *
 454    * WISHLIST: Instead of saving $actionSchedule->body_html, call this immediately after
 455    * sending the message and pass in the fully rendered text of the message.
 456    *
 457    * @param object $tokenRow
 458    * @param Civi\ActionSchedule\Mapping $mapping
 459    * @param int $contactID
 460    * @param int $entityID
 461    * @param int|null $caseID
 462    * @throws CRM_Core_Exception
 463    */
 464   protected static function createMailingActivity($tokenRow, $mapping, $contactID, $entityID, $caseID) {
 465     $session = CRM_Core_Session::singleton();
 466
 467     if ($mapping->getEntity() == 'civicrm_membership') {
 468       // @todo - not required with api
 469       $activityTypeID
 470         = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Membership Renewal Reminder');
 471     }
 472     else {
 473       // @todo - not required with api
 474       $activityTypeID
 475         = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Reminder Sent');
 476     }
 477
 478     $activityParams = [
 479       'subject' => $tokenRow->render('subject'),
 480       'details' => $tokenRow->render('body_html'),
 481       'source_contact_id' => $session->get('userID') ? $session->get('userID') : $contactID,
 482       'target_contact_id' => $contactID,
 483       // @todo - not required with api
 484       'activity_date_time' => CRM_Utils_Time::getTime('YmdHis'),
 485       // @todo - not required with api
 486       'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
 487       'activity_type_id' => $activityTypeID,
 488       'source_record_id' => $entityID,
 489     ];
 490     // @todo use api, remove all the above wrangling
 491     $activity = CRM_Activity_BAO_Activity::create($activityParams);
 492
 493     //file reminder on case if source activity is a case activity
 494     if (!empty($caseID)) {
 495       $caseActivityParams = [];
 496       $caseActivityParams['case_id'] = $caseID;
 497       $caseActivityParams['activity_id'] = $activity->id;
 498       CRM_Case_BAO_Case::processCaseActivity($caseActivityParams);
 499     }
 500   }
 501
 502   /**
 503    * @param \Civi\ActionSchedule\MappingInterface $mapping
 504    * @param \CRM_Core_DAO_ActionSchedule $actionSchedule
 505    * @return string
 506    */
 507   protected static function prepareMailingQuery($mapping, $actionSchedule) {
 508     $select = CRM_Utils_SQL_Select::from('civicrm_action_log reminder')
 509       ->select("reminder.id as reminderID, reminder.contact_id as contactID, reminder.entity_table as entityTable, reminder.*, e.id AS entityID")
 510       ->join('e', "!casMailingJoinType !casMappingEntity e ON !casEntityJoinExpr")
 511       ->select("e.id as entityID, e.*")
 512       ->where("reminder.action_schedule_id = #casActionScheduleId")
 513       ->where("reminder.action_date_time IS NULL")
 514       ->param([
 515         'casActionScheduleId' => $actionSchedule->id,
 516         'casMailingJoinType' => ($actionSchedule->limit_to == 0) ? 'LEFT JOIN' : 'INNER JOIN',
 517         'casMappingId' => $mapping->getId(),
 518         'casMappingEntity' => $mapping->getEntity(),
 519         'casEntityJoinExpr' => 'e.id = reminder.entity_id',
 520       ]);
 521
 522     if ($actionSchedule->limit_to == 0) {
 523       $select->where("e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact'");
 524     }
 525
 526     \Civi\Core\Container::singleton()->get('dispatcher')
 527       ->dispatch(
 528         \Civi\ActionSchedule\Events::MAILING_QUERY,
 529         new \Civi\ActionSchedule\Event\MailingQueryEvent($actionSchedule, $mapping, $select)
 530       );
 531
 532     return $select->toSQL();
 533   }
 534
 535   /**
 536    * @param \Civi\Token\TokenRow $tokenRow
 537    * @param CRM_Core_DAO_ActionSchedule $schedule
 538    * @param int $toContactID
 539    * @throws CRM_Core_Exception
 540    * @return array
 541    *   List of error messages.
 542    */
 543   protected static function sendReminderSms($tokenRow, $schedule, $toContactID) {
 544     $toPhoneNumber = self::pickSmsPhoneNumber($toContactID);
 545     if (!$toPhoneNumber) {
 546       return ["sms_phone_missing" => "Couldn't find recipient's phone number."];
 547     }
 548
 549     // dev/core#369 If an SMS provider is deleted then the relevant row in the action_schedule_table is set to NULL
 550     // So we need to exclude them.
 551     if (CRM_Utils_System::isNull($schedule->sms_provider_id)) {
 552       return ["sms_provider_missing" => "SMS reminder cannot be sent because the SMS provider has been deleted."];
 553     }
 554
 555     $messageSubject = $tokenRow->render('subject');
 556     $sms_body_text = $tokenRow->render('sms_body_text');
 557
 558     $session = CRM_Core_Session::singleton();
 559     $userID = $session->get('userID') ? $session->get('userID') : $tokenRow->context['contactId'];
 560     $smsParams = [
 561       'To' => $toPhoneNumber,
 562       'provider_id' => $schedule->sms_provider_id,
 563       'activity_subject' => $messageSubject,
 564     ];
 565     $activityTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS');
 566     $activityParams = [
 567       'source_contact_id' => $userID,
 568       'activity_type_id' => $activityTypeID,
 569       'activity_date_time' => date('YmdHis'),
 570       'subject' => $messageSubject,
 571       'details' => $sms_body_text,
 572       'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'),
 573     ];
 574
 575     $activity = CRM_Activity_BAO_Activity::create($activityParams);
 576
 577     CRM_Activity_BAO_Activity::sendSMSMessage($tokenRow->context['contactId'],
 578       $sms_body_text,
 579       $smsParams,
 580       $activity->id,
 581       $userID
 582     );
 583
 584     return [];
 585   }
 586
 587   /**
 588    * @param CRM_Core_DAO_ActionSchedule $actionSchedule
 589    * @return string
 590    *   Ex: "Alice <alice@example.org>".
 591    */
 592   protected static function pickFromEmail($actionSchedule) {
 593     $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 594     $fromEmailAddress = "$domainValues[0] <$domainValues[1]>";
 595     if ($actionSchedule->from_email) {
 596       $fromEmailAddress = "$actionSchedule->from_name <$actionSchedule->from_email>";
 597       return $fromEmailAddress;
 598     }
 599     return $fromEmailAddress;
 600   }
 601
 602   /**
 603    * @param \Civi\Token\TokenRow $tokenRow
 604    * @param CRM_Core_DAO_ActionSchedule $schedule
 605    * @param int $toContactID
 606    * @return array
 607    *   List of error messages.
 608    */
 609   protected static function sendReminderEmail($tokenRow, $schedule, $toContactID) {
 610     $toEmail = CRM_Contact_BAO_Contact::getPrimaryEmail($toContactID);
 611     if (!$toEmail) {
 612       return ["email_missing" => "Couldn't find recipient's email address."];
 613     }
 614
 615     $body_text = $tokenRow->render('body_text');
 616     $body_html = $tokenRow->render('body_html');
 617     if (!$schedule->body_text) {
 618       $body_text = CRM_Utils_String::htmlToText($body_html);
 619     }
 620
 621     // set up the parameters for CRM_Utils_Mail::send
 622     $mailParams = [
 623       'groupName' => 'Scheduled Reminder Sender',
 624       'from' => self::pickFromEmail($schedule),
 625       'toName' => $tokenRow->context['contact']['display_name'],
 626       'toEmail' => $toEmail,
 627       'subject' => $tokenRow->render('subject'),
 628       'entity' => 'action_schedule',
 629       'entity_id' => $schedule->id,
 630     ];
 631
 632     if (!$body_html || $tokenRow->context['contact']['preferred_mail_format'] == 'Text' ||
 633       $tokenRow->context['contact']['preferred_mail_format'] == 'Both'
 634     ) {
 635       // render the &amp; entities in text mode, so that the links work
 636       $mailParams['text'] = str_replace('&amp;', '&', $body_text);
 637     }
 638     if ($body_html && ($tokenRow->context['contact']['preferred_mail_format'] == 'HTML' ||
 639         $tokenRow->context['contact']['preferred_mail_format'] == 'Both'
 640       )
 641     ) {
 642       $mailParams['html'] = $body_html;
 643     }
 644     $result = CRM_Utils_Mail::send($mailParams);
 645     if (!$result || is_a($result, 'PEAR_Error')) {
 646       return ['email_fail' => 'Failed to send message'];
 647     }
 648
 649     return [];
 650   }
 651
 652   /**
 653    * @param CRM_Core_DAO_ActionSchedule $schedule
 654    * @param \Civi\ActionSchedule\Mapping $mapping
 655    * @return \Civi\Token\TokenProcessor
 656    */
 657   protected static function createTokenProcessor($schedule, $mapping) {
 658     $tp = new \Civi\Token\TokenProcessor(\Civi\Core\Container::singleton()->get('dispatcher'), [
 659       'controller' => __CLASS__,
 660       'actionSchedule' => $schedule,
 661       'actionMapping' => $mapping,
 662       'smarty' => TRUE,
 663     ]);
 664     $tp->addMessage('body_text', $schedule->body_text, 'text/plain');
 665     $tp->addMessage('body_html', $schedule->body_html, 'text/html');
 666     $tp->addMessage('sms_body_text', $schedule->sms_body_text, 'text/plain');
 667     $tp->addMessage('subject', $schedule->subject, 'text/plain');
 668     return $tp;
 669   }
 670
 671   /**
 672    * Pick SMS phone number.
 673    *
 674    * @param int $smsToContactId
 675    *
 676    * @return NULL|string
 677    */
 678   protected static function pickSmsPhoneNumber($smsToContactId) {
 679     $toPhoneNumbers = CRM_Core_BAO_Phone::allPhones($smsToContactId, FALSE, 'Mobile', [
 680       'is_deceased' => 0,
 681       'is_deleted' => 0,
 682       'do_not_sms' => 0,
 683     ]);
 684     //to get primary mobile ph,if not get a first mobile phONE
 685     if (!empty($toPhoneNumbers)) {
 686       $toPhoneNumberDetails = reset($toPhoneNumbers);
 687       $toPhoneNumber = CRM_Utils_Array::value('phone', $toPhoneNumberDetails);
 688       return $toPhoneNumber;
 689     }
 690     return NULL;
 691   }
 692
 693   /**
 694    * Get the list of generic recipient types supported by all entities/mappings.
 695    *
 696    * @return array
 697    *   array(mixed $value => string $label).
 698    */
 699   public static function getAdditionalRecipients() {
 700     return [
 701       'manual' => ts('Choose Recipient(s)'),
 702       'group' => ts('Select Group'),
 703     ];
 704   }
 705
 706 }