3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2013
38 * This class contains functions for managing Scheduled Reminders
40 class CRM_Core_BAO_ActionSchedule
extends CRM_Core_DAO_ActionSchedule
{
42 static function getMapping($id = NULL) {
43 static $_action_mapping;
45 if ($id && !is_null($_action_mapping) && isset($_action_mapping[$id])) {
46 return $_action_mapping[$id];
49 $dao = new CRM_Core_DAO_ActionMapping();
56 while ($dao->fetch()) {
58 CRM_Core_DAO
::storeValues($dao, $defaults);
59 $mapping[$dao->id
] = $defaults;
61 $_action_mapping = $mapping;
67 * Retrieve list of selections/drop downs for Scheduled Reminder form
69 * @param bool $id mapping id
71 * @return array associated array of all the drop downs in the form
75 static function getSelection($id = NULL) {
76 $mapping = self
::getMapping($id);
77 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
78 $activityType = CRM_Core_PseudoConstant
::activityType(FALSE) + CRM_Core_PseudoConstant
::activityType(FALSE, TRUE);
80 $participantStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, NULL, 'label');
81 $event = CRM_Event_PseudoConstant
::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
82 $eventType = CRM_Event_PseudoConstant
::eventType();
83 $eventTemplate = CRM_Event_PseudoConstant
::eventTemplates();
84 $autoRenew = CRM_Core_OptionGroup
::values('auto_renew_options');
85 $membershipType = CRM_Member_PseudoConstant
::membershipType();
89 $sel1 = $sel2 = $sel3 = $sel4 = $sel5 = array();
91 'manual' => ts('Choose Recipient(s)'),
92 'group' => ts('Select a Group'),
95 $entityMapping = array();
96 $recipientMapping = array_combine(array_keys($options), array_keys($options));
102 foreach ($mapping as $value) {
103 $entityValue = CRM_Utils_Array
::value('entity_value', $value);
104 $entityStatus = CRM_Utils_Array
::value('entity_status', $value);
105 $entityRecipient = CRM_Utils_Array
::value('entity_recipient', $value);
106 $valueLabel = array('- ' . strtolower(CRM_Utils_Array
::value('entity_value_label', $value)) . ' -');
107 $key = CRM_Utils_Array
::value('id', $value);
108 $entityMapping[$key] = CRM_Utils_Array
::value('entity', $value);
111 switch ($entityValue) {
112 case 'activity_type':
113 if ($value['entity'] == 'civicrm_activity') {
114 $sel1Val = ts('Activity');
116 $sel2[$key] = $valueLabel +
$activityType;
120 if ($value['entity'] == 'civicrm_participant') {
121 $sel1Val = ts('Event Type');
123 $sel2[$key] = $valueLabel +
$eventType;
126 case 'event_template':
127 if ($value['entity'] == 'civicrm_participant') {
128 $sel1Val = ts('Event Template');
130 $sel2[$key] = $valueLabel +
$eventTemplate;
133 case 'civicrm_event':
134 if ($value['entity'] == 'civicrm_participant') {
135 $sel1Val = ts('Event Name');
137 $sel2[$key] = $valueLabel +
$event;
140 case 'civicrm_membership_type':
141 if ($value['entity'] == 'civicrm_membership') {
142 $sel1Val = ts('Membership');
144 $sel2[$key] = $valueLabel +
$membershipType;
147 $sel1[$key] = $sel1Val;
150 if ($startDate = CRM_Utils_Array
::value('entity_date_start', $value)) {
151 $sel4[$startDate] = ucwords(str_replace('_', ' ', $startDate));
153 if ($endDate = CRM_Utils_Array
::value('entity_date_end', $value)) {
154 $sel4[$endDate] = ucwords(str_replace('_', ' ', $endDate));
157 switch ($entityRecipient) {
158 case 'activity_contacts':
159 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts');
160 $sel5[$entityRecipient] = $activityContacts +
$options;
161 $recipientMapping +
= CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
164 case 'event_contacts':
165 $eventContacts = CRM_Core_OptionGroup
::values('event_contacts');
166 $sel5[$entityRecipient] = $eventContacts +
$options;
167 $recipientMapping +
= CRM_Core_OptionGroup
::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
171 $sel5[$entityRecipient] = $options;
178 foreach ($mapping as $value) {
179 $entityStatus = CRM_Utils_Array
::value('entity_status', $value);
180 $statusLabel = array('- ' . strtolower(CRM_Utils_Array
::value('entity_status_label', $value)) . ' -');
181 $id = CRM_Utils_Array
::value('id', $value);
183 switch ($entityStatus) {
184 case 'activity_status':
185 foreach ($sel3[$id] as $kkey => & $vval) {
186 $vval = $statusLabel +
$activityStatus;
190 case 'civicrm_participant_status_type':
191 foreach ($sel3[$id] as $kkey => & $vval) {
192 $vval = $statusLabel +
$participantStatus;
196 case 'auto_renew_options':
197 foreach ($sel3[$id] as $kkey => & $vval) {
200 $auto = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $kkey, 'auto_renew');
203 $vval = $statusLabel +
$autoRenew;
206 $vval = $statusLabel;
223 'entityMapping' => $entityMapping,
224 'recipientMapping' => $recipientMapping,
228 static function getSelection1($id = NULL) {
229 $mapping = self
::getMapping($id);
230 $sel4 = $sel5 = array();
232 'manual' => ts('Choose Recipient(s)'),
233 'group' => ts('Select a Group'),
236 $recipientMapping = array_combine(array_keys($options), array_keys($options));
238 foreach ($mapping as $value) {
239 $entityRecipient = CRM_Utils_Array
::value('entity_recipient', $value);
240 $key = CRM_Utils_Array
::value('id', $value);
242 if ($startDate = CRM_Utils_Array
::value('entity_date_start', $value)) {
243 $sel4[$startDate] = ucwords(str_replace('_', ' ', $startDate));
245 if ($endDate = CRM_Utils_Array
::value('entity_date_end', $value)) {
246 $sel4[$endDate] = ucwords(str_replace('_', ' ', $endDate));
249 switch ($entityRecipient) {
250 case 'activity_contacts':
251 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts');
252 $sel5[$id] = $activityContacts +
$options;
253 $recipientMapping +
= CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
256 case 'event_contacts':
257 $eventContacts = CRM_Core_OptionGroup
::values('event_contacts');
258 $sel5[$id] = $eventContacts +
$options;
259 $recipientMapping +
= CRM_Core_OptionGroup
::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
263 $sel5[$id] = $options;
270 'sel5' => $sel5[$id],
271 'recipientMapping' => $recipientMapping,
276 * Retrieve list of Scheduled Reminders
278 * @param bool $namesOnly return simple list of names
280 * @return array (reference) reminder list
284 static function &getList($namesOnly = FALSE, $entityValue = NULL, $id = NULL) {
285 $activity_type = CRM_Core_PseudoConstant
::activityType(FALSE) + CRM_Core_PseudoConstant
::activityType(FALSE, TRUE);
286 $activity_status = CRM_Core_PseudoConstant
::activityStatus();
288 $event_type = CRM_Event_PseudoConstant
::eventType();
289 $civicrm_event = CRM_Event_PseudoConstant
::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
290 $civicrm_participant_status_type = CRM_Event_PseudoConstant
::participantStatus(NULL, NULL, 'label');
291 $event_template = CRM_Event_PseudoConstant
::eventTemplates();
293 $auto_renew_options = CRM_Core_OptionGroup
::values('auto_renew_options');
294 $civicrm_membership_type = CRM_Member_PseudoConstant
::membershipType();
296 asort($activity_type);
298 'civicrm_activity' => 'Activity',
299 'civicrm_participant' => 'Event',
300 'civicrm_membership' => 'Member',
308 cam.entity_value as entityValue,
309 cas.entity_value as entityValueIds,
310 cam.entity_status as entityStatus,
311 cas.entity_status as entityStatusIds,
312 cas.start_action_date as entityDate,
313 cas.start_action_offset,
314 cas.start_action_unit,
315 cas.start_action_condition,
320 FROM civicrm_action_schedule cas
321 LEFT JOIN civicrm_action_mapping cam ON (cam.id = cas.mapping_id)
323 $params = CRM_Core_DAO
::$_nullArray;
325 if ($entityValue and $id) {
327 WHERE cas.entity_value = $id AND
328 cam.entity_value = '$entityValue'";
333 1 => array($id, 'Integer'),
334 2 => array($entityValue, 'String'),
338 $dao = CRM_Core_DAO
::executeQuery($query);
339 while ($dao->fetch()) {
340 $list[$dao->id
]['id'] = $dao->id
;
341 $list[$dao->id
]['title'] = $dao->title
;
342 $list[$dao->id
]['start_action_offset'] = $dao->start_action_offset
;
343 $list[$dao->id
]['start_action_unit'] = $dao->start_action_unit
;
344 $list[$dao->id
]['start_action_condition'] = $dao->start_action_condition
;
345 $list[$dao->id
]['entityDate'] = ucwords(str_replace('_', ' ', $dao->entityDate
));
346 $list[$dao->id
]['absolute_date'] = $dao->absolute_date
;
348 $status = $dao->entityStatus
;
349 $statusArray = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $dao->entityStatusIds
);
350 foreach ($statusArray as & $s) {
351 $s = CRM_Utils_Array
::value($s, $
$status);
353 $statusIds = implode(', ', $statusArray);
355 $value = $dao->entityValue
;
356 $valueArray = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $dao->entityValueIds
);
357 foreach ($valueArray as & $v) {
358 $v = CRM_Utils_Array
::value($v, $
$value);
360 $valueIds = implode(', ', $valueArray);
361 $list[$dao->id
]['entity'] = $entity[$dao->entity
];
362 $list[$dao->id
]['value'] = $valueIds;
363 $list[$dao->id
]['status'] = $statusIds;
364 $list[$dao->id
]['is_repeat'] = $dao->is_repeat
;
365 $list[$dao->id
]['is_active'] = $dao->is_active
;
371 static function sendReminder($contactId, $email, $scheduleID, $from, $tokenParams) {
373 $schedule = new CRM_Core_DAO_ActionSchedule();
374 $schedule->id
= $scheduleID;
376 $domain = CRM_Core_BAO_Domain
::getDomain();
378 $hookTokens = array();
380 if ($schedule->find(TRUE)) {
381 $body_text = $schedule->body_text
;
382 $body_html = $schedule->body_html
;
383 $body_subject = $schedule->subject
;
385 $body_text = CRM_Utils_String
::htmlToText($body_html);
388 $params = array(array('contact_id', '=', $contactId, 0, 0));
389 list($contact, $_) = CRM_Contact_BAO_Query
::apiQuery($params);
392 $contact = reset($contact);
394 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
398 // merge activity tokens with contact array
399 $contact = array_merge($contact, $tokenParams);
402 CRM_Utils_Hook
::tokenValues($contact, $contactId);
404 CRM_Utils_Hook
::tokens($hookTokens);
405 $categories = array_keys($hookTokens);
407 $type = array('html', 'text');
409 foreach ($type as $key => $value) {
410 $dummy_mail = new CRM_Mailing_BAO_Mailing();
411 $bodyType = "body_{$value}";
412 $dummy_mail->$bodyType = $
$bodyType;
413 $tokens = $dummy_mail->getTokens();
416 CRM_Utils_Token
::replaceGreetingTokens($
$bodyType, NULL, $contact['contact_id']);
417 $
$bodyType = CRM_Utils_Token
::replaceDomainTokens($
$bodyType, $domain, TRUE, $tokens[$value], TRUE);
418 $
$bodyType = CRM_Utils_Token
::replaceContactTokens($
$bodyType, $contact, FALSE, $tokens[$value], FALSE, TRUE);
419 $
$bodyType = CRM_Utils_Token
::replaceComponentTokens($
$bodyType, $contact, $tokens[$value], TRUE, FALSE);
420 $
$bodyType = CRM_Utils_Token
::replaceHookTokens($
$bodyType, $contact, $categories, TRUE);
426 $smarty = CRM_Core_Smarty
::singleton();
428 'text', 'html') as $elem) {
429 $
$elem = $smarty->fetch("string:{$$elem}");
433 preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
439 $subjectToken = NULL;
441 foreach ($matches[1] as $token) {
442 list($type, $name) = preg_split('/\./', $token, 2);
444 if (!isset($subjectToken['contact'])) {
445 $subjectToken['contact'] = array();
447 $subjectToken['contact'][] = $name;
452 $messageSubject = CRM_Utils_Token
::replaceContactTokens($body_subject, $contact, FALSE, $subjectToken);
453 $messageSubject = CRM_Utils_Token
::replaceDomainTokens($messageSubject, $domain, TRUE, $tokens[$value]);
454 $messageSubject = CRM_Utils_Token
::replaceComponentTokens($messageSubject, $contact, $tokens[$value], TRUE);
455 $messageSubject = CRM_Utils_Token
::replaceHookTokens($messageSubject, $contact, $categories, TRUE);
457 $messageSubject = $smarty->fetch("string:{$messageSubject}");
459 // set up the parameters for CRM_Utils_Mail::send
461 'groupName' => 'Scheduled Reminder Sender',
463 'toName' => $contact['display_name'],
465 'subject' => $messageSubject,
466 'entity' => 'action_schedule',
467 'entity_id' => $scheduleID,
470 if (!$html ||
$contact['preferred_mail_format'] == 'Text' ||
471 $contact['preferred_mail_format'] == 'Both'
473 // render the & entities in text mode, so that the links work
474 $mailParams['text'] = str_replace('&', '&', $text);
476 if ($html && ($contact['preferred_mail_format'] == 'HTML' ||
477 $contact['preferred_mail_format'] == 'Both'
479 $mailParams['html'] = $html;
482 $result = CRM_Utils_Mail
::send($mailParams);
490 * Function to add the schedules reminders in the db
492 * @param array $params (reference ) an assoc array of name/value pairs
493 * @param array $ids the array that holds all the db ids
495 * @return object CRM_Core_DAO_ActionSchedule
500 static function add(&$params, $ids = array()) {
501 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
502 $actionSchedule->copyValues($params);
504 return $actionSchedule->save();
508 * Takes a bunch of params that are needed to match certain criteria and
509 * retrieves the relevant objects. It also stores all the retrieved
510 * values in the default array
512 * @param array $params (reference ) an assoc array of name/value pairs
513 * @param array $values (reference ) an assoc array to hold the flattened values
515 * @return object CRM_Core_DAO_ActionSchedule object on success, null otherwise
519 static function retrieve(&$params, &$values) {
520 if (empty($params)) {
523 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
525 $actionSchedule->copyValues($params);
527 if ($actionSchedule->find(TRUE)) {
528 $ids['actionSchedule'] = $actionSchedule->id
;
530 CRM_Core_DAO
::storeValues($actionSchedule, $values);
532 return $actionSchedule;
538 * Function to delete a Reminder
540 * @param int $id ID of the Reminder to be deleted.
545 static function del($id) {
547 $dao = new CRM_Core_DAO_ActionSchedule();
549 if ($dao->find(TRUE)) {
554 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));
558 * update the is_active flag in the db
560 * @param int $id id of the database record
561 * @param boolean $is_active value we want to set the is_active field
563 * @return Object DAO object on success, null otherwise
566 static function setIsActive($id, $is_active) {
567 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_ActionSchedule', $id, 'is_active', $is_active);
570 static function sendMailings($mappingID, $now) {
571 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
572 $fromEmailAddress = "$domainValues[0] <$domainValues[1]>";
574 $mapping = new CRM_Core_DAO_ActionMapping();
575 $mapping->id
= $mappingID;
576 $mapping->find(TRUE);
578 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
579 $actionSchedule->mapping_id
= $mappingID;
580 $actionSchedule->is_active
= 1;
581 $actionSchedule->find(FALSE);
583 $tokenFields = array();
584 $session = CRM_Core_Session
::singleton();
586 while ($actionSchedule->fetch()) {
587 $extraSelect = $extraJoin = $extraWhere = $extraOn = '';
589 if ($actionSchedule->record_activity
) {
590 if ($mapping->entity
== 'civicrm_membership') {
592 CRM_Core_OptionGroup
::getValue('activity_type', 'Membership Renewal Reminder', 'name');
596 CRM_Core_OptionGroup
::getValue('activity_type', 'Reminder Sent', 'name');
600 CRM_Core_OptionGroup
::getValue('activity_status', 'Completed', 'name');
603 if ($mapping->entity
== 'civicrm_activity') {
604 $tokenEntity = 'activity';
605 $tokenFields = array('activity_id', 'activity_type', 'subject', 'details', 'activity_date_time');
606 $extraSelect = ', ov.label as activity_type, e.id as activity_id';
608 INNER JOIN civicrm_option_group og ON og.name = 'activity_type'
609 INNER JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
610 $extraOn = ' AND e.is_current_revision = 1 AND e.is_deleted = 0 ';
611 if ($actionSchedule->limit_to
== 0) {
613 LEFT JOIN civicrm_option_group og ON og.name = 'activity_type'
614 LEFT JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
618 if ($mapping->entity
== 'civicrm_participant') {
619 $tokenEntity = 'event';
620 $tokenFields = array('event_type', 'title', 'event_id', 'start_date', 'end_date', 'summary', 'description', 'location', 'info_url', 'registration_url', 'fee_amount', 'contact_email', 'contact_phone');
621 $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 ';
624 INNER JOIN civicrm_event ev ON e.event_id = ev.id
625 INNER JOIN civicrm_option_group og ON og.name = 'event_type'
626 INNER JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
627 LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
628 LEFT JOIN civicrm_address address ON address.id = lb.address_id
629 LEFT JOIN civicrm_email email ON email.id = lb.email_id
630 LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
632 if ($actionSchedule->limit_to
== 0) {
634 LEFT JOIN civicrm_event ev ON e.event_id = ev.id
635 LEFT JOIN civicrm_option_group og ON og.name = 'event_type'
636 LEFT JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
637 LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
638 LEFT JOIN civicrm_address address ON address.id = lb.address_id
639 LEFT JOIN civicrm_email email ON email.id = lb.email_id
640 LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
645 if ($mapping->entity
== 'civicrm_membership') {
646 $tokenEntity = 'membership';
647 $tokenFields = array('fee', 'id', 'join_date', 'start_date', 'end_date', 'status', 'type');
648 $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';
650 INNER JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
651 INNER JOIN civicrm_membership_status ms ON e.status_id = ms.id';
653 if ($actionSchedule->limit_to
== 0) {
655 LEFT JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
656 LEFT JOIN civicrm_membership_status ms ON e.status_id = ms.id';
660 $entityJoinClause = "INNER JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
661 if ($actionSchedule->limit_to
== 0) {
662 $entityJoinClause = "LEFT JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
663 $extraWhere .= " AND (e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact')";
665 $entityJoinClause .= $extraOn;
668 SELECT reminder.id as reminderID, reminder.contact_id as contactID, reminder.*, e.id as entityID, e.* {$extraSelect}
669 FROM civicrm_action_log reminder
672 WHERE reminder.action_schedule_id = %1 AND reminder.action_date_time IS NULL
675 $dao = CRM_Core_DAO
::executeQuery($query,
676 array(1 => array($actionSchedule->id
, 'Integer'))
679 while ($dao->fetch()) {
680 $entityTokenParams = array();
681 foreach ($tokenFields as $field) {
682 if ($field == 'location') {
684 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
685 $loc['street_address'] = $dao->street_address
;
686 $loc['city'] = $dao->city
;
687 $loc['state_province'] = CRM_Utils_Array
::value($dao->state_province_id
, $stateProvince);
688 $loc['postal_code'] = $dao->postal_code
;
689 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Address
::format($loc);
691 elseif ($field == 'info_url') {
692 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System
::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id
, TRUE, NULL, FALSE);
694 elseif ($field == 'registration_url') {
695 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System
::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id
, TRUE, NULL, FALSE);
697 elseif (in_array($field, array('start_date','end_date','join_date','activity_date_time'))) {
698 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Date
::customFormat($dao->$field);
701 $entityTokenParams["{$tokenEntity}." . $field] = $dao->$field;
707 $toEmail = CRM_Contact_BAO_Contact
::getPrimaryEmail($dao->contactID
);
710 CRM_Core_BAO_ActionSchedule
::sendReminder(
718 if (!$result ||
is_a($result, 'PEAR_Error')) {
719 // we could not send an email, for now we ignore, CRM-3406
725 $errorMsg = "Couldn\'t find recipient\'s email address.";
728 // update action log record
730 'id' => $dao->reminderID
,
731 'is_error' => $isError,
732 'message' => $errorMsg ?
$errorMsg : "null",
733 'action_date_time' => $now,
735 CRM_Core_BAO_ActionLog
::create($logParams);
737 // insert activity log record if needed
738 if ($actionSchedule->record_activity
) {
739 $activityParams = array(
740 'subject' => $actionSchedule->title
,
741 'details' => $actionSchedule->body_html
,
742 'source_contact_id' =>
743 $session->get('userID') ?
$session->get('userID') : $dao->contactID
,
744 'target_contact_id' => $dao->contactID
,
745 'activity_date_time' => date('YmdHis'),
746 'status_id' => $activityStatusID,
747 'activity_type_id' => $activityTypeID,
748 'source_record_id' => $dao->entityID
,
750 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
758 static function buildRecipientContacts($mappingID, $now, $params = array()) {
759 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
760 $actionSchedule->mapping_id
= $mappingID;
761 $actionSchedule->is_active
= 1;
762 if(!empty($params)) {
763 _civicrm_api3_dao_set_filter($actionSchedule, $params, FALSE, 'ActionSchedule');
765 $actionSchedule->find();
767 while ($actionSchedule->fetch()) {
768 $mapping = new CRM_Core_DAO_ActionMapping();
769 $mapping->id
= $mappingID;
770 $mapping->find(TRUE);
772 // note: $where - this filtering applies for both
773 // 'limit to' and 'addition to' options
774 // $limitWhere - this filtering applies only for
776 $select = $join = $where = $limitWhere = array();
777 $limitTo = $actionSchedule->limit_to
;
778 $value = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
779 trim($actionSchedule->entity_value
, CRM_Core_DAO
::VALUE_SEPARATOR
)
781 $value = implode(',', $value);
783 $status = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
784 trim($actionSchedule->entity_status
, CRM_Core_DAO
::VALUE_SEPARATOR
)
786 $status = implode(',', $status);
788 if (!CRM_Utils_System
::isNull($mapping->entity_recipient
)) {
789 $recipientOptions = CRM_Core_OptionGroup
::values($mapping->entity_recipient
, FALSE, FALSE, FALSE, NULL, 'name');
791 $from = "{$mapping->entity} e";
793 if ($mapping->entity
== 'civicrm_activity') {
794 $contactField = 'r.contact_id';
795 $table = 'civicrm_activity e';
796 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
797 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
798 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
799 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
802 // including the activity target contacts if 'in addition' is defined
803 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
806 switch (CRM_Utils_Array
::value($actionSchedule->recipient
, $recipientOptions)) {
807 case 'Activity Assignees':
808 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$assigneeID}";
811 case 'Activity Source':
812 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$sourceID}";
816 case 'Activity Targets':
817 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
821 // build where clause
822 if (!empty($value)) {
823 $where[] = "e.activity_type_id IN ({$value})";
826 $where[] = "e.activity_type_id IS NULL";
828 if (!empty($status)) {
829 $where[] = "e.status_id IN ({$status})";
831 $where[] = ' e.is_current_revision = 1 ';
832 $where[] = ' e.is_deleted = 0 ';
834 $dateField = 'e.activity_date_time';
837 if ($mapping->entity
== 'civicrm_participant') {
838 $table = 'civicrm_event r';
839 $contactField = 'e.contact_id';
840 $join[] = 'INNER JOIN civicrm_event r ON e.event_id = r.id';
841 if ($actionSchedule->recipient_listing
&& $limitTo) {
842 $rList = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
843 trim($actionSchedule->recipient_listing
, CRM_Core_DAO
::VALUE_SEPARATOR
)
845 $rList = implode(',', $rList);
847 switch ($recipientOptions[$actionSchedule->recipient
]) {
848 case 'participant_role':
849 $where[] = "e.role_id IN ({$rList})";
857 // build where clause
858 if (!empty($value)) {
859 $where[] = ($mapping->entity_value
== 'event_type') ?
"r.event_type_id IN ({$value})" : "r.id IN ({$value})";
862 $where[] = ($mapping->entity_value
== 'event_type') ?
"r.event_type_id IS NULL" : "r.id IS NULL";
865 // participant status criteria not to be implemented
866 // for additional recipients
867 if (!empty($status)) {
868 $limitWhere[] = "e.status_id IN ({$status})";
871 $where[] = 'r.is_active = 1';
872 $where[] = 'r.is_template = 0';
873 $dateField = str_replace('event_', 'r.', $actionSchedule->start_action_date
);
877 if ($mapping->entity
== 'civicrm_membership') {
878 $contactField = 'e.contact_id';
879 $table = 'civicrm_membership e';
880 // build where clause
881 if ( $status == 2 ) {
882 //auto-renew memberships
883 $where[] = "e.contribution_recur_id IS NOT NULL ";
885 elseif ( $status == 1 ) {
886 $where[] = "e.contribution_recur_id IS NULL ";
889 // build where clause
890 if (!empty($value)) {
891 $where[] = "e.membership_type_id IN ({$value})";
894 $where[] = "e.membership_type_id IS NULL";
897 $where[] = "( e.is_override IS NULL OR e.is_override = 0 )";
898 $dateField = str_replace('membership_', 'e.', $actionSchedule->start_action_date
);
899 $notINClause = self
::permissionedRelationships($contactField);
901 $membershipStatus = CRM_Member_PseudoConstant
::membershipStatus(NULL, "(is_current_member = 1 OR name = 'Expired')", 'id');
902 $mStatus = implode (',', $membershipStatus);
903 $where[] = "e.status_id IN ({$mStatus})";
906 // CRM-13577 Introduce Smart Groups Handling
907 if ($actionSchedule->group_id
) {
909 // Need to check if its a smart group or not
910 // Then decide which table to join onto the query
911 $group = CRM_Contact_DAO_Group
::getTableName();
913 // Get the group information
915 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
917 WHERE $group.id = {$actionSchedule->group_id}
920 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
921 $isSmartGroup = FALSE;
923 $groupDAO->fetch() &&
924 !empty($groupDAO->saved_search_id
)
926 // Check that the group is in place in the cache and up to date
927 CRM_Contact_BAO_GroupContactCache
::check($actionSchedule->group_id
);
928 // Set smart group flag
929 $isSmartGroup = TRUE;
932 // CRM-13577 End Introduce Smart Groups Handling
935 if ($actionSchedule->group_id
) {
936 // CRM-13577 If smart group then use Cache table
938 $join[] = "INNER JOIN civicrm_group_contact_cache grp ON {$contactField} = grp.contact_id";
939 $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
941 $join[] = "INNER JOIN civicrm_group_contact grp ON {$contactField} = grp.contact_id AND grp.status = 'Added'";
942 $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
945 elseif (!empty($actionSchedule->recipient_manual
)) {
946 $rList = CRM_Utils_Type
::escape($actionSchedule->recipient_manual
, 'String');
947 $where[] = "{$contactField} IN ({$rList})";
951 $addGroup = $addWhere = '';
952 if ($actionSchedule->group_id
) {
953 // CRM-13577 If smart group then use Cache table
955 $addGroup = " INNER JOIN civicrm_group_contact_cache grp ON c.id = grp.contact_id";
956 $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
958 $addGroup = " INNER JOIN civicrm_group_contact grp ON c.id = grp.contact_id AND grp.status = 'Added'";
959 $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
962 if (!empty($actionSchedule->recipient_manual
)) {
963 $rList = CRM_Utils_Type
::escape($actionSchedule->recipient_manual
, 'String');
964 $addWhere = "c.id IN ({$rList})";
968 $select[] = "{$contactField} as contact_id";
969 $select[] = 'e.id as entity_id';
970 $select[] = "'{$mapping->entity}' as entity_table";
971 $select[] = "{$actionSchedule->id} as action_schedule_id";
972 $reminderJoinClause = "civicrm_action_log reminder ON reminder.contact_id = {$contactField} AND
973 reminder.entity_id = e.id AND
974 reminder.entity_table = '{$mapping->entity}' AND
975 reminder.action_schedule_id = %1";
977 $join[] = "INNER JOIN civicrm_contact c ON c.id = {$contactField} AND c.is_deleted = 0 AND c.is_deceased = 0 ";
979 if ($actionSchedule->start_action_date
) {
980 $startDateClause = array();
981 $op = ($actionSchedule->start_action_condition
== 'before' ?
'<=' : '>=');
982 $operator = ($actionSchedule->start_action_condition
== 'before' ?
'DATE_SUB' : 'DATE_ADD');
983 $date = $operator . "({$dateField}, INTERVAL {$actionSchedule->start_action_offset} {$actionSchedule->start_action_unit})";
984 $startDateClause[] = "'{$now}' >= {$date}";
985 if ($mapping->entity
== 'civicrm_participant') {
986 $startDateClause[] = $operator. "({$now}, INTERVAL 1 DAY ) {$op} " . $dateField;
989 $startDateClause[] = "DATE_SUB({$now}, INTERVAL 1 DAY ) <= {$date}";
992 $startDate = implode(' AND ', $startDateClause);
994 elseif ($actionSchedule->absolute_date
) {
995 $startDate = "DATEDIFF(DATE('{$now}'),'{$actionSchedule->absolute_date}') = 0";
998 // ( now >= date_built_from_start_time ) OR ( now = absolute_date )
999 $dateClause = "reminder.id IS NULL AND {$startDate}";
1001 // start composing query
1002 $selectClause = 'SELECT ' . implode(', ', $select);
1003 $fromClause = "FROM $from";
1004 $joinClause = !empty($join) ?
implode(' ', $join) : '';
1005 $whereClause = 'WHERE ' . implode(' AND ', $where);
1006 $limitWhereClause = '';
1007 if (!empty($limitWhere)) {
1008 $limitWhereClause = ' AND ' . implode(' AND ', $limitWhere);
1012 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
1016 LEFT JOIN {$reminderJoinClause}
1017 {$whereClause} {$limitWhereClause} AND {$dateClause} {$notINClause}
1019 CRM_Core_DAO
::executeQuery($query, array(1 => array($actionSchedule->id
, 'Integer')));
1021 if ($limitTo == 0) {
1022 $additionWhere = ' WHERE ';
1023 if ($actionSchedule->start_action_date
) {
1024 $additionWhere = $whereClause . ' AND ';
1026 $contactTable = "civicrm_contact c";
1027 $addSelect = "SELECT c.id as contact_id, c.id as entity_id, 'civicrm_contact' as entity_table, {$actionSchedule->id} as action_schedule_id";
1028 $additionReminderClause = "civicrm_action_log reminder ON reminder.contact_id = c.id AND
1029 reminder.entity_id = c.id AND
1030 reminder.entity_table = 'civicrm_contact' AND
1031 reminder.action_schedule_id = {$actionSchedule->id}";
1032 $addWhereClause = '';
1034 $addWhereClause = "AND {$addWhere}";
1036 $insertAdditionalSql ="
1037 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
1039 FROM ({$contactTable}, {$table})
1040 LEFT JOIN {$additionReminderClause}
1042 {$additionWhere} c.is_deleted = 0 AND c.is_deceased = 0
1046 SELECT rem.contact_id
1047 FROM civicrm_action_log rem INNER JOIN {$mapping->entity} e ON rem.entity_id = e.id
1048 WHERE rem.action_schedule_id = {$actionSchedule->id}
1049 AND rem.entity_table = '{$mapping->entity}'
1053 CRM_Core_DAO
::executeQuery($insertAdditionalSql);
1055 // if repeat is turned ON:
1056 if ($actionSchedule->is_repeat
) {
1057 $repeatEvent = ($actionSchedule->end_action
== 'before' ?
'DATE_SUB' : 'DATE_ADD') . "({$dateField}, INTERVAL {$actionSchedule->end_frequency_interval} {$actionSchedule->end_frequency_unit})";
1059 if ($actionSchedule->repetition_frequency_unit
== 'day') {
1060 $hrs = 24 * $actionSchedule->repetition_frequency_interval
;
1062 elseif ($actionSchedule->repetition_frequency_unit
== 'week') {
1063 $hrs = 24 * $actionSchedule->repetition_frequency_interval
* 7;
1065 elseif ($actionSchedule->repetition_frequency_unit
== 'month') {
1066 $hrs = "24*(DATEDIFF(DATE_ADD(latest_log_time, INTERVAL 1 MONTH ), latest_log_time))";
1068 elseif ($actionSchedule->repetition_frequency_unit
== 'year') {
1069 $hrs = "24*(DATEDIFF(DATE_ADD(latest_log_time, INTERVAL 1 YEAR ), latest_log_time))";
1072 $hrs = $actionSchedule->repetition_frequency_interval
;
1075 // (now <= repeat_end_time )
1076 $repeatEventClause = "'{$now}' <= {$repeatEvent}";
1077 // diff(now && logged_date_time) >= repeat_interval
1078 $havingClause = "HAVING TIMEDIFF({$now}, latest_log_time) >= TIME('{$hrs}:00:00')";
1079 $groupByClause = 'GROUP BY reminder.contact_id, reminder.entity_id, reminder.entity_table';
1080 $selectClause .= ', MAX(reminder.action_date_time) as latest_log_time';
1081 $sqlInsertValues = "{$selectClause}
1084 INNER JOIN {$reminderJoinClause}
1085 {$whereClause} {$limitWhereClause} AND {$repeatEventClause}
1089 $valsqlInsertValues = CRM_Core_DAO
::executeQuery($sqlInsertValues, array(1 => array($actionSchedule->id
, 'Integer')));
1091 $arrValues = array();
1092 while ($valsqlInsertValues->fetch()) {
1093 $arrValues[] = "( {$valsqlInsertValues->contact_id}, {$valsqlInsertValues->entity_id}, '{$valsqlInsertValues->entity_table}',{$valsqlInsertValues->action_schedule_id} )";
1096 $valString = implode(',', $arrValues);
1100 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1101 CRM_Core_DAO
::executeQuery($query, array(1 => array($actionSchedule->id
, 'Integer')));
1104 if ($limitTo == 0) {
1105 $addSelect .= ', MAX(reminder.action_date_time) as latest_log_time';
1106 $sqlEndEventCheck = "
1107 SELECT * FROM {$table}
1108 {$whereClause} AND {$repeatEventClause} LIMIT 1";
1110 $daoCheck = CRM_Core_DAO
::executeQuery($sqlEndEventCheck);
1111 if ($daoCheck->fetch()) {
1112 $valSqlAdditionInsert = "
1114 FROM {$contactTable}
1116 INNER JOIN {$additionReminderClause}
1117 WHERE {$addWhere} AND c.is_deleted = 0 AND c.is_deceased = 0
1118 GROUP BY reminder.contact_id
1121 $daoForVals = CRM_Core_DAO
::executeQuery($valSqlAdditionInsert);
1122 $addValues = array();
1123 while ($daoForVals->fetch()) {
1124 $addValues[] = "( {$daoForVals->contact_id}, {$daoForVals->entity_id}, '{$daoForVals->entity_table}',{$daoForVals->action_schedule_id} )";
1126 $valString = implode(',', $addValues);
1130 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1131 CRM_Core_DAO
::executeQuery($query);
1139 static function permissionedRelationships($field) {
1141 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
1142 FROM civicrm_membership m
1143 LEFT JOIN civicrm_membership cm ON cm.id = m.owner_membership_id
1144 LEFT JOIN civicrm_membership_type cmt ON cmt.id = m.membership_type_id
1145 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 )
1146 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 ) )
1147 WHERE m.owner_membership_id IS NOT NULL AND
1148 ( rel.is_permission_a_b = 0 OR rel.is_permission_b_a = 0)
1151 $excludeIds = array();
1152 $dao = CRM_Core_DAO
::executeQuery($query, array());
1153 while ($dao->fetch()) {
1154 if ($dao->slave_contact
== $dao->contact_id_a
&& $dao->is_permission_b_a
== 0) {
1155 $excludeIds[] = $dao->slave_contact
;
1157 elseif ($dao->slave_contact
== $dao->contact_id_b
&& $dao->is_permission_a_b
== 0) {
1158 $excludeIds[] = $dao->slave_contact
;
1162 if (!empty($excludeIds)) {
1163 $clause = "AND {$field} NOT IN ( " .implode(', ', $excludeIds) . ' ) ';
1169 static function processQueue($now = NULL, $params = array()) {
1170 $now = $now ? CRM_Utils_Time
::setTime($now) : CRM_Utils_Time
::getTime();
1172 $mappings = self
::getMapping();
1173 foreach ($mappings as $mappingID => $mapping) {
1174 self
::buildRecipientContacts($mappingID, $now, $params);
1175 self
::sendMailings($mappingID, $now);
1180 'messages' => ts('Sent all scheduled reminders successfully'),
1185 static function isConfigured($id, $mappingID) {
1186 $queryString = "SELECT count(id) FROM civicrm_action_schedule
1187 WHERE mapping_id = %1 AND
1191 1 => array($mappingID, 'Integer'),
1192 2 => array($id, 'Integer'),
1194 return CRM_Core_DAO
::singleValueQuery($queryString, $params);
1197 static function getRecipientListing($mappingID, $recipientType) {
1199 if (!$mappingID ||
!$recipientType) {
1203 $mapping = self
::getMapping($mappingID);
1205 switch ($mapping['entity']) {
1206 case 'civicrm_participant':
1207 $eventContacts = CRM_Core_OptionGroup
::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1208 if (!CRM_Utils_Array
::value($recipientType, $eventContacts)) {
1211 if ($eventContacts[$recipientType] == 'participant_role') {
1212 $options = CRM_Event_PseudoConstant
::participantRole();