CRM/Core/BAO/ActionSchedule.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.5                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright (C) 2011 Marty Wright                                    |
   7   | Licensed to CiviCRM under the Academic Free License version 3.0.   |
   8   +--------------------------------------------------------------------+
   9   | This file is a part of CiviCRM.                                    |
  10   |                                                                    |
  11   | CiviCRM is free software; you can copy, modify, and distribute it  |
  12   | under the terms of the GNU Affero General Public License           |
  13   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14   |                                                                    |
  15   | CiviCRM is distributed in the hope that it will be useful, but     |
  16   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18   | See the GNU Affero General Public License for more details.        |
  19   |                                                                    |
  20   | You should have received a copy of the GNU Affero General Public   |
  21   | License and the CiviCRM Licensing Exception along                  |
  22   | with this program; if not, contact CiviCRM LLC                     |
  23   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24   | GNU Affero General Public License or the licensing of CiviCRM,     |
  25   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26   +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  * This class contains functions for managing Scheduled Reminders
  39  */
  40 class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule {
  41
  42   /**
  43    * @param null $id
  44    *
  45    * @return array
  46    */
  47   static function getMapping($id = NULL) {
  48     static $_action_mapping;
  49
  50     if ($id && !is_null($_action_mapping) && isset($_action_mapping[$id])) {
  51       return $_action_mapping[$id];
  52     }
  53
  54     $dao = new CRM_Core_DAO_ActionMapping();
  55     if ($id) {
  56       $dao->id = $id;
  57     }
  58     $dao->find();
  59
  60     $mapping = array();
  61     while ($dao->fetch()) {
  62       $defaults = array();
  63       CRM_Core_DAO::storeValues($dao, $defaults);
  64       $mapping[$dao->id] = $defaults;
  65     }
  66     $_action_mapping = $mapping;
  67
  68     return $mapping;
  69   }
  70
  71   /**
  72    * Get all fields of the type Date
  73    */
  74
  75   static function getDateFields() {
  76     $allFields = CRM_Core_BAO_CustomField::getFields('');
  77     $dateFields = array('birth_date' => ts('Birth Date'));
  78     foreach ($allFields as $fieldID => $field) {
  79       if ($field['data_type'] == 'Date') {
  80         $dateFields["custom_$fieldID"] = $field['label'];
  81       }
  82     }
  83     return $dateFields;
  84   }
  85
  86   /**
  87    * Retrieve list of selections/drop downs for Scheduled Reminder form
  88    *
  89    * @param bool    $id    mapping id
  90    *
  91    * @return array  associated array of all the drop downs in the form
  92    * @static
  93    * @access public
  94    */
  95   static function getSelection($id = NULL) {
  96     $mapping = self::getMapping($id);
  97     $activityStatus = CRM_Core_PseudoConstant::activityStatus();
  98     $activityType   = CRM_Core_PseudoConstant::activityType(TRUE, TRUE);
  99
 100     $participantStatus = CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label');
 101     $event = CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
 102     $eventType = CRM_Event_PseudoConstant::eventType();
 103     $eventTemplate = CRM_Event_PseudoConstant::eventTemplates();
 104     $autoRenew = CRM_Core_OptionGroup::values('auto_renew_options');
 105     $membershipType = CRM_Member_PseudoConstant::membershipType();
 106     $dateFieldParams = array('data_type' => 'Date');
 107     $dateFields = self::getDateFields();
 108     $contactOptions = CRM_Core_OptionGroup::values('contact_date_reminder_options');
 109
 110     asort($activityType);
 111
 112     $sel1 = $sel2 = $sel3 = $sel4 = $sel5 = array();
 113     $options = array(
 114       'manual' => ts('Choose Recipient(s)'),
 115       'group' => ts('Select a Group'),
 116     );
 117
 118     $entityMapping = array();
 119     $recipientMapping = array_combine(array_keys($options), array_keys($options));
 120
 121     if (!$id) {
 122       $id = 1;
 123     }
 124
 125     foreach ($mapping as $value) {
 126       $entityValue = CRM_Utils_Array::value('entity_value', $value);
 127       $entityStatus = CRM_Utils_Array::value('entity_status', $value);
 128       $entityRecipient = CRM_Utils_Array::value('entity_recipient', $value);
 129       $valueLabel = array('- ' . strtolower(CRM_Utils_Array::value('entity_value_label', $value)) . ' -');
 130       $key = CRM_Utils_Array::value('id', $value);
 131       $entityMapping[$key] = CRM_Utils_Array::value('entity', $value);
 132
 133       $sel1Val = NULL;
 134       switch ($entityValue) {
 135         case 'activity_type':
 136           if ($value['entity'] == 'civicrm_activity') {
 137             $sel1Val = ts('Activity');
 138           }
 139           $sel2[$key] = $valueLabel + $activityType;
 140           break;
 141
 142         case 'event_type':
 143           if ($value['entity'] == 'civicrm_participant') {
 144             $sel1Val = ts('Event Type');
 145           }
 146           $sel2[$key] = $valueLabel + $eventType;
 147           break;
 148
 149         case 'event_template':
 150           if ($value['entity'] == 'civicrm_participant') {
 151             $sel1Val = ts('Event Template');
 152           }
 153           $sel2[$key] = $valueLabel + $eventTemplate;
 154           break;
 155
 156         case 'civicrm_event':
 157           if ($value['entity'] == 'civicrm_participant') {
 158             $sel1Val = ts('Event Name');
 159           }
 160           $sel2[$key] = $valueLabel + $event;
 161           break;
 162
 163         case 'civicrm_membership_type':
 164           if ($value['entity'] == 'civicrm_membership') {
 165             $sel1Val = ts('Membership');
 166           }
 167           $sel2[$key] = $valueLabel + $membershipType;
 168           break;
 169
 170         case 'civicrm_contact':
 171           if ($value['entity'] == 'civicrm_contact') {
 172             $sel1Val = ts('Contact');
 173           }
 174           $sel2[$key] = $dateFields;
 175           break;
 176       }
 177       $sel1[$key] = $sel1Val;
 178
 179       if ($key == $id) {
 180         if ($startDate = CRM_Utils_Array::value('entity_date_start', $value)) {
 181           $sel4[$startDate] = ucwords(str_replace('_', ' ', $startDate));
 182         }
 183         if ($endDate = CRM_Utils_Array::value('entity_date_end', $value)) {
 184           $sel4[$endDate] = ucwords(str_replace('_', ' ', $endDate));
 185         }
 186
 187         switch ($entityRecipient) {
 188           case 'activity_contacts':
 189             $activityContacts = CRM_Core_OptionGroup::values('activity_contacts');
 190             $sel5[$entityRecipient] = $activityContacts + $options;
 191             $recipientMapping += CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 192             break;
 193
 194           case 'event_contacts':
 195             $eventContacts = CRM_Core_OptionGroup::values('event_contacts');
 196             $sel5[$entityRecipient] = $eventContacts + $options;
 197             $recipientMapping += CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 198             break;
 199
 200           case NULL:
 201             $sel5[$entityRecipient] = $options;
 202             break;
 203         }
 204       }
 205     }
 206     $sel3 = $sel2;
 207
 208     foreach ($mapping as $value) {
 209       $entityStatus = CRM_Utils_Array::value('entity_status', $value);
 210       $statusLabel = array('- ' . strtolower(CRM_Utils_Array::value('entity_status_label', $value)) . ' -');
 211       $id = CRM_Utils_Array::value('id', $value);
 212
 213       switch ($entityStatus) {
 214         case 'activity_status':
 215           foreach ($sel3[$id] as $kkey => & $vval) {
 216             $vval = $statusLabel + $activityStatus;
 217           }
 218           break;
 219
 220         case 'civicrm_participant_status_type':
 221           foreach ($sel3[$id] as $kkey => & $vval) {
 222             $vval = $statusLabel + $participantStatus;
 223           }
 224           break;
 225
 226         case 'auto_renew_options':
 227           foreach ($sel3[$id] as $kkey => & $vval) {
 228             $auto = 0;
 229             if ($kkey) {
 230               $auto = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $kkey, 'auto_renew');
 231             }
 232             if ( $auto ) {
 233               $vval = $statusLabel + $autoRenew;
 234             }
 235             else {
 236               $vval = $statusLabel;
 237             }
 238           }
 239           break;
 240
 241         case 'contact_date_reminder_options':
 242           foreach ($sel3[$id] as $kkey => & $vval) {
 243             $vval = $contactOptions;
 244           }
 245           break;
 246
 247         case '':
 248           $sel3[$id] = '';
 249           break;
 250
 251       }
 252     }
 253     return array(
 254       'sel1' => $sel1,
 255       'sel2' => $sel2,
 256       'sel3' => $sel3,
 257       'sel4' => $sel4,
 258       'sel5' => $sel5,
 259       'entityMapping' => $entityMapping,
 260       'recipientMapping' => $recipientMapping,
 261     );
 262   }
 263
 264   /**
 265    * @param null $id
 266    *
 267    * @return array
 268    */
 269   static function getSelection1($id = NULL) {
 270     $mapping = self::getMapping($id);
 271     $sel4 = $sel5 = array();
 272     $options = array(
 273       'manual' => ts('Choose Recipient(s)'),
 274       'group' => ts('Select a Group'),
 275     );
 276
 277     $recipientMapping = array_combine(array_keys($options), array_keys($options));
 278
 279     foreach ($mapping as $value) {
 280       $entityRecipient = CRM_Utils_Array::value('entity_recipient', $value);
 281       $key = CRM_Utils_Array::value('id', $value);
 282
 283       if ($startDate = CRM_Utils_Array::value('entity_date_start', $value)) {
 284         $sel4[$startDate] = ucwords(str_replace('_', ' ', $startDate));
 285       }
 286       if ($endDate = CRM_Utils_Array::value('entity_date_end', $value)) {
 287         $sel4[$endDate] = ucwords(str_replace('_', ' ', $endDate));
 288       }
 289
 290       switch ($entityRecipient) {
 291         case 'activity_contacts':
 292           $activityContacts = CRM_Core_OptionGroup::values('activity_contacts');
 293           $sel5[$id] = $activityContacts + $options;
 294           $recipientMapping += CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 295           break;
 296
 297         case 'event_contacts':
 298           $eventContacts = CRM_Core_OptionGroup::values('event_contacts');
 299           $sel5[$id] = $eventContacts + $options;
 300           $recipientMapping += CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 301           break;
 302
 303         case NULL:
 304           $sel5[$id] = $options;
 305           break;
 306       }
 307     }
 308
 309     return array(
 310       'sel4' => $sel4,
 311       'sel5' => $sel5[$id],
 312       'recipientMapping' => $recipientMapping,
 313     );
 314   }
 315
 316   /**
 317    * Retrieve list of Scheduled Reminders
 318    *
 319    * @param bool $namesOnly return simple list of names
 320    *
 321    * @param null $entityValue
 322    * @param null $id
 323    *
 324    * @return array  (reference)   reminder list
 325    * @static
 326    * @access public
 327    */
 328   static function &getList($namesOnly = FALSE, $entityValue = NULL, $id = NULL) {
 329     $activity_type = CRM_Core_PseudoConstant::activityType(TRUE, TRUE);
 330     $activity_status = CRM_Core_PseudoConstant::activityStatus();
 331
 332     $event_type = CRM_Event_PseudoConstant::eventType();
 333     $civicrm_event = CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
 334     $civicrm_participant_status_type = CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label');
 335     $event_template = CRM_Event_PseudoConstant::eventTemplates();
 336     $civicrm_contact = self::getDateFields();
 337
 338     $auto_renew_options = CRM_Core_OptionGroup::values('auto_renew_options');
 339     $contact_date_reminder_options = CRM_Core_OptionGroup::values('contact_date_reminder_options');
 340     $civicrm_membership_type = CRM_Member_PseudoConstant::membershipType();
 341
 342     $entity = array(
 343       'civicrm_activity' => 'Activity',
 344       'civicrm_participant' => 'Event',
 345       'civicrm_membership' => 'Member',
 346       'civicrm_contact' => 'Contact',
 347     );
 348
 349     $query = "
 350 SELECT
 351        title,
 352        cam.entity,
 353        cas.id as id,
 354        cam.entity_value as entityValue,
 355        cas.entity_value as entityValueIds,
 356        cam.entity_status as entityStatus,
 357        cas.entity_status as entityStatusIds,
 358        cas.start_action_date as entityDate,
 359        cas.start_action_offset,
 360        cas.start_action_unit,
 361        cas.start_action_condition,
 362        cas.absolute_date,
 363        is_repeat,
 364        is_active
 365
 366 FROM civicrm_action_schedule cas
 367 LEFT JOIN civicrm_action_mapping cam ON (cam.id = cas.mapping_id)
 368 ";
 369     $params = CRM_Core_DAO::$_nullArray;
 370
 371     if ($entityValue and $id) {
 372       $where = "
 373 WHERE   cas.entity_value = $id AND
 374         cam.entity_value = '$entityValue'";
 375
 376       $query .= $where;
 377
 378       $params = array(
 379         1 => array($id, 'Integer'),
 380         2 => array($entityValue, 'String'),
 381       );
 382     }
 383
 384     $dao = CRM_Core_DAO::executeQuery($query);
 385     while ($dao->fetch()) {
 386       $list[$dao->id]['id'] = $dao->id;
 387       $list[$dao->id]['title'] = $dao->title;
 388       $list[$dao->id]['start_action_offset'] = $dao->start_action_offset;
 389       $list[$dao->id]['start_action_unit'] = $dao->start_action_unit;
 390       $list[$dao->id]['start_action_condition'] = $dao->start_action_condition;
 391       $list[$dao->id]['entityDate'] = ucwords(str_replace('_', ' ', $dao->entityDate));
 392       $list[$dao->id]['absolute_date'] = $dao->absolute_date;
 393
 394       $status = $dao->entityStatus;
 395       $statusArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $dao->entityStatusIds);
 396       foreach ($statusArray as & $s) {
 397         $s = CRM_Utils_Array::value($s, $$status);
 398       }
 399       $statusIds = implode(', ', $statusArray);
 400
 401       $value = $dao->entityValue;
 402       $valueArray = explode(CRM_Core_DAO::VALUE_SEPARATOR, $dao->entityValueIds);
 403       foreach ($valueArray as & $v) {
 404         $v = CRM_Utils_Array::value($v, $$value);
 405       }
 406       $valueIds = implode(', ', $valueArray);
 407       $list[$dao->id]['entity'] = $entity[$dao->entity];
 408       $list[$dao->id]['value'] = $valueIds;
 409       $list[$dao->id]['status'] = $statusIds;
 410       $list[$dao->id]['is_repeat'] = $dao->is_repeat;
 411       $list[$dao->id]['is_active'] = $dao->is_active;
 412     }
 413
 414     return $list;
 415   }
 416
 417   /**
 418    * @param $contactId
 419    * @param $to
 420    * @param $scheduleID
 421    * @param $from
 422    * @param $tokenParams
 423    *
 424    * @return bool|null
 425    * @throws CRM_Core_Exception
 426    */
 427   static function sendReminder($contactId, $to, $scheduleID, $from, $tokenParams) {
 428     $email = $to['email'];
 429     $phoneNumber = $to['phone'];
 430     $schedule = new CRM_Core_DAO_ActionSchedule();
 431     $schedule->id = $scheduleID;
 432
 433     $domain     = CRM_Core_BAO_Domain::getDomain();
 434     $result     = NULL;
 435     $hookTokens = array();
 436
 437     if ($schedule->find(TRUE)) {
 438       $body_text    = $schedule->body_text;
 439       $body_html    = $schedule->body_html;
 440       $sms_body_text = $schedule->sms_body_text;
 441       $body_subject = $schedule->subject;
 442       if (!$body_text) {
 443         $body_text = CRM_Utils_String::htmlToText($body_html);
 444       }
 445
 446       $params = array(array('contact_id', '=', $contactId, 0, 0));
 447       list($contact, $_) = CRM_Contact_BAO_Query::apiQuery($params);
 448
 449       //CRM-4524
 450       $contact = reset($contact);
 451
 452       if (!$contact || is_a($contact, 'CRM_Core_Error')) {
 453         return NULL;
 454       }
 455
 456       // merge activity tokens with contact array
 457       $contact = array_merge($contact, $tokenParams);
 458
 459       //CRM-5734
 460       CRM_Utils_Hook::tokenValues($contact, $contactId);
 461
 462       CRM_Utils_Hook::tokens($hookTokens);
 463       $categories = array_keys($hookTokens);
 464
 465       $type = array('body_html' => 'html', 'body_text' => 'text', 'sms_body_text' => 'text');
 466
 467       foreach ($type as $bodyType => $value) {
 468         $dummy_mail = new CRM_Mailing_BAO_Mailing();
 469         if ($bodyType == 'sms_body_text') {
 470           $dummy_mail->body_text = $$bodyType;
 471         }
 472         else {
 473           $dummy_mail->$bodyType = $$bodyType;
 474         }
 475         $tokens = $dummy_mail->getTokens();
 476
 477         if ($$bodyType) {
 478           CRM_Utils_Token::replaceGreetingTokens($$bodyType, NULL, $contact['contact_id']);
 479           $$bodyType = CRM_Utils_Token::replaceDomainTokens($$bodyType, $domain, TRUE, $tokens[$value], TRUE);
 480           $$bodyType = CRM_Utils_Token::replaceContactTokens($$bodyType, $contact, FALSE, $tokens[$value], FALSE, TRUE);
 481           $$bodyType = CRM_Utils_Token::replaceComponentTokens($$bodyType, $contact, $tokens[$value], TRUE, FALSE);
 482           $$bodyType = CRM_Utils_Token::replaceHookTokens($$bodyType, $contact, $categories, TRUE);
 483         }
 484       }
 485       $html = $body_html;
 486       $text = $body_text;
 487       $sms_text = $sms_body_text;
 488
 489       $smarty = CRM_Core_Smarty::singleton();
 490       foreach (array(
 491           'text', 'html', 'sms_text') as $elem) {
 492         $$elem = $smarty->fetch("string:{$$elem}");
 493       }
 494
 495       $matches = array();
 496       preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
 497         $body_subject,
 498         $matches,
 499         PREG_PATTERN_ORDER
 500       );
 501
 502       $subjectToken = NULL;
 503       if ($matches[1]) {
 504         foreach ($matches[1] as $token) {
 505           list($type, $name) = preg_split('/\./', $token, 2);
 506           if ($name) {
 507             if (!isset($subjectToken[$type])) {
 508               $subjectToken[$type] = array();
 509             }
 510             $subjectToken[$type][] = $name;
 511           }
 512         }
 513       }
 514
 515       $messageSubject = CRM_Utils_Token::replaceContactTokens($body_subject, $contact, FALSE, $subjectToken);
 516       $messageSubject = CRM_Utils_Token::replaceDomainTokens($messageSubject, $domain, TRUE, $subjectToken);
 517       $messageSubject = CRM_Utils_Token::replaceComponentTokens($messageSubject, $contact, $subjectToken, TRUE);
 518       $messageSubject = CRM_Utils_Token::replaceHookTokens($messageSubject, $contact, $categories, TRUE);
 519
 520       $messageSubject = $smarty->fetch("string:{$messageSubject}");
 521
 522       if ($schedule->mode == 'SMS' or $schedule->mode == 'User_Preference') {
 523         $session = CRM_Core_Session::singleton();
 524         $userID = $session->get('userID') ? $session->get('userID') : $contactId;
 525         $smsParams = array('To' => $phoneNumber, 'provider_id' => $schedule->sms_provider_id, 'activity_subject' => $messageSubject);
 526         $activityTypeID = CRM_Core_OptionGroup::getValue('activity_type',
 527           'SMS',
 528           'name'
 529         );
 530         $activityParams = array(
 531           'source_contact_id' => $userID,
 532           'activity_type_id' => $activityTypeID,
 533           'activity_date_time' => date('YmdHis'),
 534           'subject' => $messageSubject,
 535           'details' => $sms_text,
 536           'status_id' => CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name'),
 537         );
 538
 539         $activity = CRM_Activity_BAO_Activity::create($activityParams);
 540
 541         CRM_Activity_BAO_Activity::sendSMSMessage($contactId,
 542           $sms_text,
 543           $smsParams,
 544           $activity->id,
 545           $userID
 546         );
 547       }
 548
 549       if ($schedule->mode == 'Email' or $schedule->mode == 'User_Preference') {
 550         // set up the parameters for CRM_Utils_Mail::send
 551         $mailParams = array(
 552           'groupName' => 'Scheduled Reminder Sender',
 553           'from' => $from,
 554           'toName' => $contact['display_name'],
 555           'toEmail' => $email,
 556           'subject' => $messageSubject,
 557           'entity' => 'action_schedule',
 558           'entity_id' => $scheduleID,
 559         );
 560
 561         if (!$html || $contact['preferred_mail_format'] == 'Text' ||
 562           $contact['preferred_mail_format'] == 'Both'
 563         ) {
 564           // render the &amp; entities in text mode, so that the links work
 565           $mailParams['text'] = str_replace('&amp;', '&', $text);
 566         }
 567         if ($html && ($contact['preferred_mail_format'] == 'HTML' ||
 568             $contact['preferred_mail_format'] == 'Both'
 569           )
 570         ) {
 571           $mailParams['html'] = $html;
 572         }
 573         $result = CRM_Utils_Mail::send($mailParams);
 574       }
 575     }
 576     $schedule->free();
 577
 578     return $result;
 579   }
 580
 581   /**
 582    * Function to add the schedules reminders in the db
 583    *
 584    * @param array $params (reference ) an assoc array of name/value pairs
 585    * @param array $ids    the array that holds all the db ids
 586    *
 587    * @return object CRM_Core_DAO_ActionSchedule
 588    * @access public
 589    * @static
 590    *
 591    */
 592   static function add(&$params, $ids = array()) {
 593     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 594     $actionSchedule->copyValues($params);
 595
 596     return $actionSchedule->save();
 597   }
 598
 599   /**
 600    * Takes a bunch of params that are needed to match certain criteria and
 601    * retrieves the relevant objects. It also stores all the retrieved
 602    * values in the default array
 603    *
 604    * @param array $params   (reference ) an assoc array of name/value pairs
 605    * @param array $values (reference ) an assoc array to hold the flattened values
 606    *
 607    * @return object CRM_Core_DAO_ActionSchedule object on success, null otherwise
 608    * @access public
 609    * @static
 610    */
 611   static function retrieve(&$params, &$values) {
 612     if (empty($params)) {
 613       return NULL;
 614     }
 615     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 616
 617     $actionSchedule->copyValues($params);
 618
 619     if ($actionSchedule->find(TRUE)) {
 620       $ids['actionSchedule'] = $actionSchedule->id;
 621
 622       CRM_Core_DAO::storeValues($actionSchedule, $values);
 623
 624       return $actionSchedule;
 625     }
 626     return NULL;
 627   }
 628
 629   /**
 630    * Function to delete a Reminder
 631    *
 632    * @param  int  $id     ID of the Reminder to be deleted.
 633    *
 634    * @access public
 635    * @static
 636    */
 637   static function del($id) {
 638     if ($id) {
 639       $dao = new CRM_Core_DAO_ActionSchedule();
 640       $dao->id = $id;
 641       if ($dao->find(TRUE)) {
 642         $dao->delete();
 643         return;
 644       }
 645     }
 646     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 647   }
 648
 649   /**
 650    * update the is_active flag in the db
 651    *
 652    * @param int      $id        id of the database record
 653    * @param boolean  $is_active value we want to set the is_active field
 654    *
 655    * @return Object             DAO object on success, null otherwise
 656    * @static
 657    */
 658   static function setIsActive($id, $is_active) {
 659     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_ActionSchedule', $id, 'is_active', $is_active);
 660   }
 661
 662   /**
 663    * @param $mappingID
 664    * @param $now
 665    *
 666    * @throws CRM_Core_Exception
 667    */
 668   static function sendMailings($mappingID, $now) {
 669     $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 670     $fromEmailAddress = "$domainValues[0] <$domainValues[1]>";
 671
 672     $mapping = new CRM_Core_DAO_ActionMapping();
 673     $mapping->id = $mappingID;
 674     $mapping->find(TRUE);
 675
 676     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 677     $actionSchedule->mapping_id = $mappingID;
 678     $actionSchedule->is_active = 1;
 679     $actionSchedule->find(FALSE);
 680
 681     $tokenFields = array();
 682     $session = CRM_Core_Session::singleton();
 683
 684     while ($actionSchedule->fetch()) {
 685       $extraSelect = $extraJoin = $extraWhere = $extraOn = '';
 686
 687     if ($actionSchedule->from_email)
 688             $fromEmailAddress = "$actionSchedule->from_name <$actionSchedule->from_email>";
 689
 690
 691       if ($actionSchedule->record_activity) {
 692         if ($mapping->entity == 'civicrm_membership') {
 693           $activityTypeID =
 694             CRM_Core_OptionGroup::getValue('activity_type', 'Membership Renewal Reminder', 'name');
 695         }
 696         else {
 697           $activityTypeID =
 698             CRM_Core_OptionGroup::getValue('activity_type', 'Reminder Sent', 'name');
 699         }
 700
 701         $activityStatusID =
 702           CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name');
 703       }
 704
 705       if ($mapping->entity == 'civicrm_activity') {
 706         $tokenEntity = 'activity';
 707         $tokenFields = array('activity_id', 'activity_type', 'subject', 'details', 'activity_date_time');
 708         $extraSelect = ', ov.label as activity_type, e.id as activity_id';
 709         $extraJoin   = "
 710 INNER JOIN civicrm_option_group og ON og.name = 'activity_type'
 711 INNER JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
 712         $extraOn = ' AND e.is_current_revision = 1 AND e.is_deleted = 0 ';
 713         if ($actionSchedule->limit_to == 0) {
 714           $extraJoin   = "
 715 LEFT JOIN civicrm_option_group og ON og.name = 'activity_type'
 716 LEFT JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
 717         }
 718       }
 719
 720       if ($mapping->entity == 'civicrm_participant') {
 721         $tokenEntity = 'event';
 722         $tokenFields = array('event_type', 'title', 'event_id', 'start_date', 'end_date', 'summary', 'description', 'location', 'info_url', 'registration_url', 'fee_amount', 'contact_email', 'contact_phone', 'balance');
 723         $extraSelect = ', ov.label as event_type, ev.title, ev.id as event_id, ev.start_date, ev.end_date, ev.summary, ev.description, address.street_address, address.city, address.state_province_id, address.postal_code, email.email as contact_email, phone.phone as contact_phone ';
 724
 725         $extraJoin   = "
 726 INNER JOIN civicrm_event ev ON e.event_id = ev.id
 727 INNER JOIN civicrm_option_group og ON og.name = 'event_type'
 728 INNER JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
 729 LEFT  JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
 730 LEFT  JOIN civicrm_address address ON address.id = lb.address_id
 731 LEFT  JOIN civicrm_email email ON email.id = lb.email_id
 732 LEFT  JOIN civicrm_phone phone ON phone.id = lb.phone_id
 733 ";
 734         if ($actionSchedule->limit_to == 0) {
 735           $extraJoin   = "
 736 LEFT JOIN civicrm_event ev ON e.event_id = ev.id
 737 LEFT JOIN civicrm_option_group og ON og.name = 'event_type'
 738 LEFT JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
 739 LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
 740 LEFT JOIN civicrm_address address ON address.id = lb.address_id
 741 LEFT JOIN civicrm_email email ON email.id = lb.email_id
 742 LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
 743 ";
 744         }
 745       }
 746
 747       if ($mapping->entity == 'civicrm_membership') {
 748         $tokenEntity = 'membership';
 749         $tokenFields = array('fee', 'id', 'join_date', 'start_date', 'end_date', 'status', 'type');
 750         $extraSelect = ', mt.minimum_fee as fee, e.id as id , e.join_date, e.start_date, e.end_date, ms.name as status, mt.name as type';
 751         $extraJoin   = '
 752  INNER JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
 753  INNER JOIN civicrm_membership_status ms ON e.status_id = ms.id';
 754
 755         if ($actionSchedule->limit_to == 0) {
 756           $extraJoin   = '
 757  LEFT JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
 758  LEFT JOIN civicrm_membership_status ms ON e.status_id = ms.id';
 759         }
 760       }
 761
 762       if ($mapping->entity == 'civicrm_contact') {
 763         $tokenEntity = 'contact';
 764         //TODO: get full list somewhere!
 765         $tokenFields = array('birth_date', 'last_name');
 766         //TODO: is there anything to add here?
 767       }
 768
 769       $entityJoinClause = "INNER JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
 770       if ($actionSchedule->limit_to == 0) {
 771         $entityJoinClause = "LEFT JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
 772         $extraWhere .= " AND (e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact')";
 773       }
 774       $entityJoinClause .= $extraOn;
 775
 776       $query = "
 777 SELECT reminder.id as reminderID, reminder.contact_id as contactID, reminder.entity_table as entityTable, reminder.*, e.id as entityID, e.* {$extraSelect}
 778 FROM  civicrm_action_log reminder
 779 {$entityJoinClause}
 780 {$extraJoin}
 781 WHERE reminder.action_schedule_id = %1 AND reminder.action_date_time IS NULL
 782 {$extraWhere}";
 783
 784       $dao = CRM_Core_DAO::executeQuery($query,
 785         array(1 => array($actionSchedule->id, 'Integer'))
 786       );
 787
 788       while ($dao->fetch()) {
 789         $entityTokenParams = array();
 790         foreach ($tokenFields as $field) {
 791           if ($field == 'location') {
 792             $loc = array();
 793             $stateProvince = CRM_Core_PseudoConstant::stateProvince();
 794             $loc['street_address'] = $dao->street_address;
 795             $loc['city'] = $dao->city;
 796             $loc['state_province'] = CRM_Utils_Array::value($dao->state_province_id, $stateProvince);
 797             $loc['postal_code'] = $dao->postal_code;
 798             $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Address::format($loc);
 799           }
 800           elseif ($field == 'info_url') {
 801             $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id, TRUE, NULL, FALSE);
 802           }
 803           elseif ($field == 'registration_url') {
 804             $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id, TRUE, NULL, FALSE);
 805           }
 806           elseif (in_array($field, array('start_date','end_date','join_date','activity_date_time'))) {
 807             $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Date::customFormat($dao->$field);
 808           }
 809           elseif ($field == 'balance') {
 810             if ($dao->entityTable == 'civicrm_contact') {
 811               $balancePay = 'N/A';
 812             }
 813             elseif (!empty($dao->entityID)) {
 814               $info = CRM_Contribute_BAO_Contribution::getPaymentInfo($dao->entityID, 'event');
 815               $balancePay = CRM_Utils_Array::value('balance', $info);
 816               $balancePay = CRM_Utils_Money::format($balancePay);
 817             }
 818             $entityTokenParams["{$tokenEntity}." . $field] = $balancePay;
 819           }
 820           elseif ($field == 'fee_amount') {
 821             $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Money::format($dao->$field);
 822           }
 823           else {
 824             $entityTokenParams["{$tokenEntity}." . $field] = $dao->$field;
 825           }
 826         }
 827
 828         $isError  = 0;
 829         $errorMsg = $toEmail = $toPhoneNumber = '';
 830
 831         if ($actionSchedule->mode == 'SMS' or $actionSchedule->mode == 'User_Preference') {
 832           $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
 833           $toPhoneNumbers = CRM_Core_BAO_Phone::allPhones($dao->contactID, FALSE, 'Mobile', $filters);
 834           //to get primary mobile ph,if not get a first mobile phONE
 835           if (!empty($toPhoneNumbers)) {
 836             $toPhoneNumberDetails = reset($toPhoneNumbers);
 837             $toPhoneNumber = CRM_Utils_Array::value('phone', $toPhoneNumberDetails);
 838             //contact allows to send sms
 839             $toDoNotSms = 0;
 840           }
 841         }
 842         if ($actionSchedule->mode == 'Email' or $actionSchedule->mode == 'User_Preference') {
 843           $toEmail = CRM_Contact_BAO_Contact::getPrimaryEmail($dao->contactID);
 844         }
 845         if ($toEmail || !(empty($toPhoneNumber) or $toDoNotSms)) {
 846           $to['email'] = $toEmail;
 847           $to['phone'] = $toPhoneNumber;
 848           $result =
 849             CRM_Core_BAO_ActionSchedule::sendReminder(
 850               $dao->contactID,
 851               $to,
 852               $actionSchedule->id,
 853               $fromEmailAddress,
 854               $entityTokenParams
 855             );
 856
 857           if (!$result || is_a($result, 'PEAR_Error')) {
 858             // we could not send an email, for now we ignore, CRM-3406
 859             $isError = 1;
 860           }
 861         }
 862         else {
 863           $isError = 1;
 864           $errorMsg = "Couldn\'t find recipient\'s email address.";
 865         }
 866
 867         // update action log record
 868         $logParams = array(
 869           'id' => $dao->reminderID,
 870           'is_error' => $isError,
 871           'message' => $errorMsg ? $errorMsg : "null",
 872           'action_date_time' => $now,
 873         );
 874         CRM_Core_BAO_ActionLog::create($logParams);
 875
 876         // insert activity log record if needed
 877         if ($actionSchedule->record_activity && !$isError) {
 878           $activityParams = array(
 879             'subject' => $actionSchedule->title,
 880             'details' => $actionSchedule->body_html,
 881             'source_contact_id' =>
 882             $session->get('userID') ? $session->get('userID') : $dao->contactID,
 883             'target_contact_id' => $dao->contactID,
 884             'activity_date_time' => date('YmdHis'),
 885             'status_id' => $activityStatusID,
 886             'activity_type_id' => $activityTypeID,
 887             'source_record_id' => $dao->entityID,
 888           );
 889           CRM_Activity_BAO_Activity::create($activityParams);
 890         }
 891       }
 892
 893       $dao->free();
 894     }
 895   }
 896
 897   /**
 898    * @param $mappingID
 899    * @param $now
 900    * @param array $params
 901    *
 902    * @throws API_Exception
 903    */
 904   static function buildRecipientContacts($mappingID, $now, $params = array()) {
 905     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 906     $actionSchedule->mapping_id = $mappingID;
 907     $actionSchedule->is_active = 1;
 908     if(!empty($params)) {
 909       _civicrm_api3_dao_set_filter($actionSchedule, $params, FALSE, 'ActionSchedule');
 910     }
 911     $actionSchedule->find();
 912
 913     while ($actionSchedule->fetch()) {
 914       $mapping = new CRM_Core_DAO_ActionMapping();
 915       $mapping->id = $mappingID;
 916       $mapping->find(TRUE);
 917
 918       // note: $where - this filtering applies for both
 919       // 'limit to' and 'addition to' options
 920       // $limitWhere - this filtering applies only for
 921       // 'limit to' option
 922       $select = $join = $where = $limitWhere = array();
 923       $limitTo = $actionSchedule->limit_to;
 924       $value = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 925         trim($actionSchedule->entity_value, CRM_Core_DAO::VALUE_SEPARATOR)
 926       );
 927       $value = implode(',', $value);
 928
 929       $status = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 930         trim($actionSchedule->entity_status, CRM_Core_DAO::VALUE_SEPARATOR)
 931       );
 932       $status = implode(',', $status);
 933
 934       $anniversary = false;
 935
 936       if (!CRM_Utils_System::isNull($mapping->entity_recipient)) {
 937         $recipientOptions = CRM_Core_OptionGroup::values($mapping->entity_recipient, FALSE, FALSE, FALSE, NULL, 'name');
 938       }
 939       $from = "{$mapping->entity} e";
 940
 941       if ($mapping->entity == 'civicrm_activity') {
 942         $contactField = 'r.contact_id';
 943         $table = 'civicrm_activity e';
 944         $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 945         $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
 946         $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 947         $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 948
 949         if ($limitTo == 0) {
 950           // including the activity target contacts if 'in addition' is defined
 951           $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
 952         }
 953         else {
 954           switch (CRM_Utils_Array::value($actionSchedule->recipient, $recipientOptions)) {
 955             case 'Activity Assignees':
 956               $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$assigneeID}";
 957               break;
 958
 959             case 'Activity Source':
 960               $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$sourceID}";
 961               break;
 962
 963             default:
 964             case 'Activity Targets':
 965               $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
 966               break;
 967           }
 968         }
 969         // build where clause
 970         if (!empty($value)) {
 971           $where[] = "e.activity_type_id IN ({$value})";
 972         }
 973         else {
 974           $where[] = "e.activity_type_id IS NULL";
 975         }
 976         if (!empty($status)) {
 977           $where[] = "e.status_id IN ({$status})";
 978         }
 979         $where[] = ' e.is_current_revision = 1 ';
 980         $where[] = ' e.is_deleted = 0 ';
 981
 982         $dateField = 'e.activity_date_time';
 983       }
 984
 985       if ($mapping->entity == 'civicrm_participant') {
 986         $table = 'civicrm_event r';
 987         $contactField = 'e.contact_id';
 988         $join[] = 'INNER JOIN civicrm_event r ON e.event_id = r.id';
 989         if ($actionSchedule->recipient_listing && $limitTo) {
 990           $rList = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 991             trim($actionSchedule->recipient_listing, CRM_Core_DAO::VALUE_SEPARATOR)
 992           );
 993           $rList = implode(',', $rList);
 994
 995           switch ($recipientOptions[$actionSchedule->recipient]) {
 996             case 'participant_role':
 997               $where[] = "e.role_id IN ({$rList})";
 998               break;
 999
1000             default:
1001               break;
1002           }
1003         }
1004
1005         // build where clause
1006         if (!empty($value)) {
1007           $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IN ({$value})" : "r.id IN ({$value})";
1008         }
1009         else {
1010           $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IS NULL" : "r.id IS NULL";
1011         }
1012
1013         // participant status criteria not to be implemented
1014         // for additional recipients
1015         if (!empty($status)) {
1016           $limitWhere[] = "e.status_id IN ({$status})";
1017         }
1018
1019         $where[] = 'r.is_active = 1';
1020         $where[] = 'r.is_template = 0';
1021         $dateField = str_replace('event_', 'r.', $actionSchedule->start_action_date);
1022       }
1023
1024       $notINClause = '';
1025       if ($mapping->entity == 'civicrm_membership') {
1026         $contactField = 'e.contact_id';
1027         $table = 'civicrm_membership e';
1028         // build where clause
1029         if ( $status == 2 ) {
1030           //auto-renew memberships
1031           $where[] = "e.contribution_recur_id IS NOT NULL ";
1032         }
1033         elseif ( $status == 1 ) {
1034           $where[] = "e.contribution_recur_id IS NULL ";
1035         }
1036
1037         // build where clause
1038         if (!empty($value)) {
1039           $where[] = "e.membership_type_id IN ({$value})";
1040         }
1041         else {
1042           $where[] = "e.membership_type_id IS NULL";
1043         }
1044
1045         $where[] = "( e.is_override IS NULL OR e.is_override = 0 )";
1046         $dateField = str_replace('membership_', 'e.', $actionSchedule->start_action_date);
1047         $notINClause = self::permissionedRelationships($contactField);
1048
1049         $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(NULL, "(is_current_member = 1 OR name = 'Expired')", 'id');
1050         $mStatus = implode (',', $membershipStatus);
1051         $where[] = "e.status_id IN ({$mStatus})";
1052       }
1053
1054       if ($mapping->entity == 'civicrm_contact') {
1055         if ($value == 'birth_date') {
1056           $dateDBField = 'birth_date';
1057           $table = 'civicrm_contact e';
1058           $contactField = 'e.id';
1059           $where[] = 'e.is_deleted = 0';
1060           $where[] = 'e.is_deceased = 0';
1061         }
1062         else {
1063           //custom field
1064           $customFieldParams = array('id' => substr($value, 7));
1065           $customGroup = $customField = array();
1066           CRM_Core_BAO_CustomField::retrieve($customFieldParams, $customField);
1067           $dateDBField = $customField['column_name'];
1068           $customGroupParams = array('id' => $customField['custom_group_id'], $customGroup);
1069           CRM_Core_BAO_CustomGroup::retrieve($customGroupParams, $customGroup);
1070           $from = $table = "{$customGroup['table_name']} e";
1071           $contactField = 'e.entity_id';
1072           $where[] = '1'; // possible to have no "where" in this case
1073         }
1074
1075         $status_ = explode(',', $status);
1076         if (in_array(2, $status_)) {
1077           // anniversary mode:
1078           $dateField = 'DATE_ADD(e.' . $dateDBField . ', INTERVAL ROUND(DATEDIFF(DATE(' . $now . '), e.' . $dateDBField . ') / 365) YEAR)';
1079           $anniversary = true;
1080         }
1081         else {
1082           // regular mode:
1083           $dateField = 'e.' . $dateDBField;
1084         }
1085         // TODO get this working
1086
1087         // TODO: Make sure everything's provided for repetition, etc.
1088       }
1089
1090       // CRM-13577 Introduce Smart Groups Handling
1091       if ($actionSchedule->group_id) {
1092
1093         // Need to check if its a smart group or not
1094         // Then decide which table to join onto the query
1095         $group = CRM_Contact_DAO_Group::getTableName();
1096
1097         // Get the group information
1098         $sql = "
1099 SELECT     $group.id, $group.cache_date, $group.saved_search_id, $group.children
1100 FROM       $group
1101 WHERE      $group.id = {$actionSchedule->group_id}
1102 ";
1103
1104         $groupDAO = CRM_Core_DAO::executeQuery($sql);
1105         $isSmartGroup = FALSE;
1106         if (
1107           $groupDAO->fetch() &&
1108           !empty($groupDAO->saved_search_id)
1109         ) {
1110           // Check that the group is in place in the cache and up to date
1111           CRM_Contact_BAO_GroupContactCache::check($actionSchedule->group_id);
1112           // Set smart group flag
1113           $isSmartGroup = TRUE;
1114         }
1115       }
1116       // CRM-13577 End Introduce Smart Groups Handling
1117
1118       if ($limitTo) {
1119         if ($actionSchedule->group_id) {
1120           // CRM-13577 If smart group then use Cache table
1121           if ($isSmartGroup) {
1122             $join[] = "INNER JOIN civicrm_group_contact_cache grp ON {$contactField} = grp.contact_id";
1123             $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
1124           } else {
1125             $join[] = "INNER JOIN civicrm_group_contact grp ON {$contactField} = grp.contact_id AND grp.status = 'Added'";
1126             $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
1127           }
1128         }
1129         elseif (!empty($actionSchedule->recipient_manual)) {
1130           $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
1131           $where[] = "{$contactField} IN ({$rList})";
1132         }
1133       }
1134       else {
1135         $addGroup = $addWhere = '';
1136         if ($actionSchedule->group_id) {
1137           // CRM-13577 If smart group then use Cache table
1138           if ($isSmartGroup) {
1139             $addGroup = " INNER JOIN civicrm_group_contact_cache grp ON c.id = grp.contact_id";
1140             $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
1141           } else {
1142             $addGroup = " INNER JOIN civicrm_group_contact grp ON c.id = grp.contact_id AND grp.status = 'Added'";
1143             $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
1144           }
1145         }
1146         if (!empty($actionSchedule->recipient_manual)) {
1147           $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
1148           $addWhere = "c.id IN ({$rList})";
1149         }
1150       }
1151
1152       $select[] = "{$contactField} as contact_id";
1153       $select[] = 'e.id as entity_id';
1154       $select[] = "'{$mapping->entity}' as entity_table";
1155       $select[] = "{$actionSchedule->id} as action_schedule_id";
1156       $reminderJoinClause = "civicrm_action_log reminder ON reminder.contact_id = {$contactField} AND
1157 reminder.entity_id          = e.id AND
1158 reminder.entity_table       = '{$mapping->entity}' AND
1159 reminder.action_schedule_id = %1";
1160
1161       if ($anniversary) {
1162         // only consider reminders less than 11 months ago
1163         $reminderJoinClause .= " AND reminder.action_date_time > DATE_SUB({$now}, INTERVAL 11 MONTH)";
1164       }
1165
1166       if ($table != 'civicrm_contact e') {
1167         $join[] = "INNER JOIN civicrm_contact c ON c.id = {$contactField} AND c.is_deleted = 0 AND c.is_deceased = 0 ";
1168       }
1169
1170       if ($actionSchedule->start_action_date) {
1171         $startDateClause = array();
1172         $op = ($actionSchedule->start_action_condition == 'before' ? '<=' : '>=');
1173         $operator = ($actionSchedule->start_action_condition == 'before' ? 'DATE_SUB' : 'DATE_ADD');
1174         $date = $operator . "({$dateField}, INTERVAL {$actionSchedule->start_action_offset} {$actionSchedule->start_action_unit})";
1175         $startDateClause[] = "'{$now}' >= {$date}";
1176         if ($mapping->entity == 'civicrm_participant') {
1177           $startDateClause[] = $operator. "({$now}, INTERVAL 1 DAY ) {$op} " . $dateField;
1178         }
1179         else {
1180           $startDateClause[] = "DATE_SUB({$now}, INTERVAL 1 DAY ) <= {$date}";
1181         }
1182
1183         $startDate = implode(' AND ', $startDateClause);
1184       }
1185       elseif ($actionSchedule->absolute_date) {
1186         $startDate = "DATEDIFF(DATE('{$now}'),'{$actionSchedule->absolute_date}') = 0";
1187       }
1188
1189       // ( now >= date_built_from_start_time ) OR ( now = absolute_date )
1190       $dateClause = "reminder.id IS NULL AND {$startDate}";
1191
1192       // start composing query
1193       $selectClause = 'SELECT ' . implode(', ', $select);
1194       $fromClause = "FROM $from";
1195       $joinClause = !empty($join) ? implode(' ', $join) : '';
1196       $whereClause = 'WHERE ' . implode(' AND ', $where);
1197       $limitWhereClause = '';
1198       if (!empty($limitWhere)) {
1199         $limitWhereClause = ' AND ' . implode(' AND ', $limitWhere);
1200       }
1201
1202       $query = "
1203 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
1204 {$selectClause}
1205 {$fromClause}
1206 {$joinClause}
1207 LEFT JOIN {$reminderJoinClause}
1208 {$whereClause} {$limitWhereClause} AND {$dateClause} {$notINClause}
1209 ";
1210       CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
1211
1212       if ($limitTo == 0 && (!empty($addGroup) || !empty($addWhere))) {
1213         $additionWhere = ' WHERE ';
1214         if ($actionSchedule->start_action_date) {
1215           $additionWhere = $whereClause . ' AND ';
1216         }
1217         $contactTable = "civicrm_contact c";
1218         $addSelect  = "SELECT c.id as contact_id, c.id as entity_id, 'civicrm_contact' as entity_table, {$actionSchedule->id} as action_schedule_id";
1219         $additionReminderClause = "civicrm_action_log reminder ON reminder.contact_id = c.id AND
1220           reminder.entity_id          = c.id AND
1221           reminder.entity_table       = 'civicrm_contact' AND
1222           reminder.action_schedule_id = {$actionSchedule->id}";
1223         $addWhereClause = '';
1224         if ($addWhere) {
1225           $addWhereClause = "AND {$addWhere}";
1226         }
1227         $insertAdditionalSql ="
1228 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
1229 {$addSelect}
1230 FROM ({$contactTable})
1231 LEFT JOIN {$additionReminderClause}
1232 {$addGroup}
1233 WHERE c.is_deleted = 0 AND c.is_deceased = 0
1234 {$addWhereClause}
1235
1236 AND c.id NOT IN (
1237      SELECT rem.contact_id
1238      FROM civicrm_action_log rem INNER JOIN {$mapping->entity} e ON rem.entity_id = e.id
1239      WHERE rem.action_schedule_id = {$actionSchedule->id}
1240       AND rem.entity_table = '{$mapping->entity}'
1241     )
1242 GROUP BY c.id
1243 ";
1244         CRM_Core_DAO::executeQuery($insertAdditionalSql);
1245       }
1246       // if repeat is turned ON:
1247       if ($actionSchedule->is_repeat) {
1248         $repeatEvent = ($actionSchedule->end_action == 'before' ? 'DATE_SUB' : 'DATE_ADD') . "({$dateField}, INTERVAL {$actionSchedule->end_frequency_interval} {$actionSchedule->end_frequency_unit})";
1249
1250         if ($actionSchedule->repetition_frequency_unit == 'day') {
1251           $hrs = 24 * $actionSchedule->repetition_frequency_interval;
1252         }
1253         elseif ($actionSchedule->repetition_frequency_unit == 'week') {
1254           $hrs = 24 * $actionSchedule->repetition_frequency_interval * 7;
1255         }
1256         elseif ($actionSchedule->repetition_frequency_unit == 'month') {
1257           $hrs = "24*(DATEDIFF(DATE_ADD(latest_log_time, INTERVAL 1 MONTH ), latest_log_time))";
1258         }
1259         elseif ($actionSchedule->repetition_frequency_unit == 'year') {
1260           $hrs = "24*(DATEDIFF(DATE_ADD(latest_log_time, INTERVAL 1 YEAR ), latest_log_time))";
1261         }
1262         else {
1263           $hrs = $actionSchedule->repetition_frequency_interval;
1264         }
1265
1266         // (now <= repeat_end_time )
1267         $repeatEventClause = "'{$now}' <= {$repeatEvent}";
1268         // diff(now && logged_date_time) >= repeat_interval
1269         $havingClause = "HAVING TIMEDIFF({$now}, latest_log_time) >= TIME('{$hrs}:00:00')";
1270         $groupByClause = 'GROUP BY reminder.contact_id, reminder.entity_id, reminder.entity_table';
1271         $selectClause .= ', MAX(reminder.action_date_time) as latest_log_time';
1272         //CRM-15376 - do not send our reminders if original criteria no longer applies
1273         // the first part of the startDateClause array is the earliest the reminder can be sent. If the
1274         // event (e.g membership_end_date) has changed then the reminder may no longer apply
1275         // @todo - this only handles events that get moved later. Potentially they might get moved earlier
1276         $originalEventStartDateClause = empty($startDateClause) ? '' : 'AND' . $startDateClause[0];
1277         $sqlInsertValues = "{$selectClause}
1278 {$fromClause}
1279 {$joinClause}
1280 INNER JOIN {$reminderJoinClause}
1281 {$whereClause} {$limitWhereClause} AND {$repeatEventClause} {$originalEventStartDateClause} {$notINClause}
1282 {$groupByClause}
1283 {$havingClause}";
1284
1285         $valsqlInsertValues = CRM_Core_DAO::executeQuery($sqlInsertValues, array(1 => array($actionSchedule->id, 'Integer')));
1286
1287         $arrValues = array();
1288         while ($valsqlInsertValues->fetch()) {
1289           $arrValues[] = "( {$valsqlInsertValues->contact_id}, {$valsqlInsertValues->entity_id}, '{$valsqlInsertValues->entity_table}',{$valsqlInsertValues->action_schedule_id} )";
1290         }
1291
1292         $valString = implode(',', $arrValues);
1293
1294         if ($valString) {
1295           $query = '
1296               INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1297           CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
1298         }
1299
1300         if ($limitTo == 0) {
1301           $addSelect .= ', MAX(reminder.action_date_time) as latest_log_time';
1302           $sqlEndEventCheck = "
1303 SELECT * FROM {$table}
1304 {$whereClause} AND {$repeatEventClause} LIMIT 1";
1305
1306           $daoCheck = CRM_Core_DAO::executeQuery($sqlEndEventCheck);
1307           if ($daoCheck->fetch()) {
1308             $valSqlAdditionInsert = "
1309 {$addSelect}
1310 FROM  {$contactTable}
1311 {$addGroup}
1312 INNER JOIN {$additionReminderClause}
1313 WHERE {$addWhere} AND c.is_deleted = 0 AND c.is_deceased = 0
1314 GROUP BY reminder.contact_id
1315 {$havingClause}
1316 ";
1317             $daoForVals = CRM_Core_DAO::executeQuery($valSqlAdditionInsert);
1318             $addValues = array();
1319             while ($daoForVals->fetch()) {
1320               $addValues[] = "( {$daoForVals->contact_id}, {$daoForVals->entity_id}, '{$daoForVals->entity_table}',{$daoForVals->action_schedule_id} )";
1321             }
1322             $valString = implode(',', $addValues);
1323
1324             if ($valString) {
1325               $query = '
1326                 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1327               CRM_Core_DAO::executeQuery($query);
1328             }
1329           }
1330         }
1331       }
1332     }
1333   }
1334
1335   /**
1336    * @param $field
1337    *
1338    * @return null|string
1339    */
1340   static function permissionedRelationships($field) {
1341     $query = '
1342 SELECT    cm.id AS owner_id, cm.contact_id AS owner_contact, m.id AS slave_id, m.contact_id AS slave_contact, cmt.relationship_type_id AS relation_type, rel.contact_id_a, rel.contact_id_b, rel.is_permission_a_b, rel.is_permission_b_a
1343 FROM      civicrm_membership m
1344 LEFT JOIN civicrm_membership cm ON cm.id = m.owner_membership_id
1345 LEFT JOIN civicrm_membership_type cmt ON cmt.id = m.membership_type_id
1346 LEFT JOIN civicrm_relationship rel ON ( ( rel.contact_id_a = m.contact_id AND rel.contact_id_b = cm.contact_id AND rel.relationship_type_id = cmt.relationship_type_id )
1347                                         OR ( rel.contact_id_a = cm.contact_id AND rel.contact_id_b = m.contact_id AND rel.relationship_type_id = cmt.relationship_type_id ) )
1348 WHERE     m.owner_membership_id IS NOT NULL AND
1349           ( rel.is_permission_a_b = 0 OR rel.is_permission_b_a = 0)
1350
1351 ';
1352     $excludeIds = array();
1353     $dao = CRM_Core_DAO::executeQuery($query, array());
1354     while ($dao->fetch()) {
1355       if ($dao->slave_contact == $dao->contact_id_a && $dao->is_permission_a_b == 0) {
1356         $excludeIds[] = $dao->slave_contact;
1357       }
1358       elseif ($dao->slave_contact == $dao->contact_id_b && $dao->is_permission_b_a == 0) {
1359         $excludeIds[] = $dao->slave_contact;
1360       }
1361     }
1362
1363     if (!empty($excludeIds)) {
1364       $clause = "AND {$field} NOT IN ( " .implode(', ', $excludeIds) . ' ) ';
1365       return  $clause;
1366     }
1367     return NULL;
1368   }
1369
1370   /**
1371    * @param null $now
1372    * @param array $params
1373    *
1374    * @return array
1375    */
1376   static function processQueue($now = NULL, $params = array()) {
1377     $now = $now ? CRM_Utils_Time::setTime($now) : CRM_Utils_Time::getTime();
1378
1379     $mappings = self::getMapping();
1380     foreach ($mappings as $mappingID => $mapping) {
1381       self::buildRecipientContacts($mappingID, $now, $params);
1382       self::sendMailings($mappingID, $now);
1383     }
1384
1385     $result = array(
1386       'is_error' => 0,
1387       'messages' => ts('Sent all scheduled reminders successfully'),
1388     );
1389     return $result;
1390   }
1391
1392   /**
1393    * @param $id
1394    * @param $mappingID
1395    *
1396    * @return null|string
1397    */
1398   static function isConfigured($id, $mappingID) {
1399     $queryString = "SELECT count(id) FROM civicrm_action_schedule
1400                         WHERE  mapping_id = %1 AND
1401                                entity_value = %2";
1402
1403     $params = array(
1404       1 => array($mappingID, 'Integer'),
1405       2 => array($id, 'Integer'),
1406     );
1407     return CRM_Core_DAO::singleValueQuery($queryString, $params);
1408   }
1409
1410   /**
1411    * @param $mappingID
1412    * @param $recipientType
1413    *
1414    * @return array
1415    */
1416   static function getRecipientListing($mappingID, $recipientType) {
1417     $options = array();
1418     if (!$mappingID || !$recipientType) {
1419       return $options;
1420     }
1421
1422     $mapping = self::getMapping($mappingID);
1423
1424     switch ($mapping['entity']) {
1425       case 'civicrm_participant':
1426         $eventContacts = CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1427         if (empty($eventContacts[$recipientType])) {
1428           return $options;
1429         }
1430         if ($eventContacts[$recipientType] == 'participant_role') {
1431           $options = CRM_Event_PseudoConstant::participantRole();
1432         }
1433         break;
1434     }
1435
1436     return $options;
1437   }
1438 }