Merge pull request #3612 from jitendrapurohit/CRM-14945
[civicrm-core.git] / CRM / Core / BAO / ActionSchedule.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
06b69b18 4 | CiviCRM version 4.5 |
6a488035
TO
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
06b69b18 32 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
33 * $Id$
34 *
35 */
36
37/**
38 * This class contains functions for managing Scheduled Reminders
39 */
40class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule {
41
b5c2afd0
EM
42 /**
43 * @param null $id
44 *
45 * @return array
46 */
6a488035
TO
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
8d657dde
AH
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
6a488035
TO
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();
d161de06 98 $activityType = CRM_Core_PseudoConstant::activityType(TRUE, TRUE);
6a488035
TO
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();
e7e657f0 104 $autoRenew = CRM_Core_OptionGroup::values('auto_renew_options');
6a488035 105 $membershipType = CRM_Member_PseudoConstant::membershipType();
8d657dde
AH
106 $dateFieldParams = array('data_type' => 'Date');
107 $dateFields = self::getDateFields();
108 $contactOptions = CRM_Core_OptionGroup::values('contact_date_reminder_options');
6a488035
TO
109
110 asort($activityType);
111
112 $sel1 = $sel2 = $sel3 = $sel4 = $sel5 = array();
3e315abc 113 $options = array(
114 'manual' => ts('Choose Recipient(s)'),
115 'group' => ts('Select a Group'),
6a488035
TO
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) {
3e315abc 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);
6a488035
TO
131 $entityMapping[$key] = CRM_Utils_Array::value('entity', $value);
132
3e315abc 133 $sel1Val = NULL;
6a488035
TO
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;
628801bf 169
8d657dde 170 case 'civicrm_contact':
628801bf
AH
171 if ($value['entity'] == 'civicrm_contact') {
172 $sel1Val = ts('Contact');
173 }
8d657dde 174 $sel2[$key] = $dateFields;
628801bf 175 break;
6a488035
TO
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':
e7e657f0 189 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts');
6a488035 190 $sel5[$entityRecipient] = $activityContacts + $options;
e7e657f0 191 $recipientMapping += CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
6a488035
TO
192 break;
193
194 case 'event_contacts':
e7e657f0 195 $eventContacts = CRM_Core_OptionGroup::values('event_contacts');
6a488035 196 $sel5[$entityRecipient] = $eventContacts + $options;
e7e657f0 197 $recipientMapping += CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
6a488035
TO
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);
3e315abc 210 $statusLabel = array('- ' . strtolower(CRM_Utils_Array::value('entity_status_label', $value)) . ' -');
211 $id = CRM_Utils_Array::value('id', $value);
6a488035
TO
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
8d657dde 241 case 'contact_date_reminder_options':
628801bf 242 foreach ($sel3[$id] as $kkey => & $vval) {
8d657dde 243 $vval = $contactOptions;
628801bf
AH
244 }
245 break;
246
6a488035
TO
247 case '':
248 $sel3[$id] = '';
249 break;
250
251 }
252 }
6a488035
TO
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
b5c2afd0
EM
264 /**
265 * @param null $id
266 *
267 * @return array
268 */
6a488035
TO
269 static function getSelection1($id = NULL) {
270 $mapping = self::getMapping($id);
3e315abc 271 $sel4 = $sel5 = array();
272 $options = array(
273 'manual' => ts('Choose Recipient(s)'),
274 'group' => ts('Select a Group'),
6a488035
TO
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':
e7e657f0 292 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts');
6a488035 293 $sel5[$id] = $activityContacts + $options;
e7e657f0 294 $recipientMapping += CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
6a488035
TO
295 break;
296
297 case 'event_contacts':
e7e657f0 298 $eventContacts = CRM_Core_OptionGroup::values('event_contacts');
6a488035 299 $sel5[$id] = $eventContacts + $options;
e7e657f0 300 $recipientMapping += CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
6a488035
TO
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 *
da6b46f4
EM
319 * @param bool $namesOnly return simple list of names
320 *
321 * @param null $entityValue
322 * @param null $id
6a488035
TO
323 *
324 * @return array (reference) reminder list
325 * @static
326 * @access public
327 */
328 static function &getList($namesOnly = FALSE, $entityValue = NULL, $id = NULL) {
7b007e61 329 $activity_type = CRM_Core_PseudoConstant::activityType(TRUE, TRUE);
6a488035
TO
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();
8d657dde 336 $civicrm_contact = self::getDateFields();
6a488035 337
e7e657f0 338 $auto_renew_options = CRM_Core_OptionGroup::values('auto_renew_options');
8d657dde 339 $contact_date_reminder_options = CRM_Core_OptionGroup::values('contact_date_reminder_options');
6a488035
TO
340 $civicrm_membership_type = CRM_Member_PseudoConstant::membershipType();
341
6a488035
TO
342 $entity = array(
343 'civicrm_activity' => 'Activity',
344 'civicrm_participant' => 'Event',
345 'civicrm_membership' => 'Member',
8d657dde 346 'civicrm_contact' => 'Contact',
6a488035
TO
347 );
348
349 $query = "
350SELECT
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
366FROM civicrm_action_schedule cas
367LEFT 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 = "
373WHERE cas.entity_value = $id AND
374 cam.entity_value = '$entityValue'";
375
376 $query .= $where;
377
3e315abc 378 $params = array(
379 1 => array($id, 'Integer'),
380 2 => array($entityValue, 'String'),
6a488035
TO
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
b5c2afd0
EM
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 */
a3e3eea1 427 static function sendReminder($contactId, $to, $scheduleID, $from, $tokenParams) {
428 $email = $to['email'];
429 $phoneNumber = $to['phone'];
6a488035
TO
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 $body_subject = $schedule->subject;
441 if (!$body_text) {
442 $body_text = CRM_Utils_String::htmlToText($body_html);
443 }
444
445 $params = array(array('contact_id', '=', $contactId, 0, 0));
446 list($contact, $_) = CRM_Contact_BAO_Query::apiQuery($params);
447
448 //CRM-4524
449 $contact = reset($contact);
450
451 if (!$contact || is_a($contact, 'CRM_Core_Error')) {
452 return NULL;
453 }
454
455 // merge activity tokens with contact array
456 $contact = array_merge($contact, $tokenParams);
457
458 //CRM-5734
459 CRM_Utils_Hook::tokenValues($contact, $contactId);
460
461 CRM_Utils_Hook::tokens($hookTokens);
462 $categories = array_keys($hookTokens);
463
464 $type = array('html', 'text');
465
466 foreach ($type as $key => $value) {
467 $dummy_mail = new CRM_Mailing_BAO_Mailing();
468 $bodyType = "body_{$value}";
469 $dummy_mail->$bodyType = $$bodyType;
470 $tokens = $dummy_mail->getTokens();
471
472 if ($$bodyType) {
473 CRM_Utils_Token::replaceGreetingTokens($$bodyType, NULL, $contact['contact_id']);
474 $$bodyType = CRM_Utils_Token::replaceDomainTokens($$bodyType, $domain, TRUE, $tokens[$value], TRUE);
475 $$bodyType = CRM_Utils_Token::replaceContactTokens($$bodyType, $contact, FALSE, $tokens[$value], FALSE, TRUE);
476 $$bodyType = CRM_Utils_Token::replaceComponentTokens($$bodyType, $contact, $tokens[$value], TRUE, FALSE);
477 $$bodyType = CRM_Utils_Token::replaceHookTokens($$bodyType, $contact, $categories, TRUE);
478 }
479 }
480 $html = $body_html;
481 $text = $body_text;
482
4ee279f4 483 $smarty = CRM_Core_Smarty::singleton();
484 foreach (array(
485 'text', 'html') as $elem) {
486 $$elem = $smarty->fetch("string:{$$elem}");
487 }
488
6a488035
TO
489 $matches = array();
490 preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
491 $body_subject,
492 $matches,
493 PREG_PATTERN_ORDER
494 );
495
496 $subjectToken = NULL;
497 if ($matches[1]) {
498 foreach ($matches[1] as $token) {
499 list($type, $name) = preg_split('/\./', $token, 2);
500 if ($name) {
748a7b58
BS
501 if (!isset($subjectToken[$type])) {
502 $subjectToken[$type] = array();
6a488035 503 }
748a7b58 504 $subjectToken[$type][] = $name;
6a488035
TO
505 }
506 }
507 }
508
509 $messageSubject = CRM_Utils_Token::replaceContactTokens($body_subject, $contact, FALSE, $subjectToken);
748a7b58
BS
510 $messageSubject = CRM_Utils_Token::replaceDomainTokens($messageSubject, $domain, TRUE, $subjectToken);
511 $messageSubject = CRM_Utils_Token::replaceComponentTokens($messageSubject, $contact, $subjectToken, TRUE);
6a488035
TO
512 $messageSubject = CRM_Utils_Token::replaceHookTokens($messageSubject, $contact, $categories, TRUE);
513
4ee279f4 514 $messageSubject = $smarty->fetch("string:{$messageSubject}");
515
a3e3eea1 516 if ($schedule->mode == 'SMS' or $schedule->mode == 'User_Preference') {
517 $session = CRM_Core_Session::singleton();
518 $userID = $session->get('userID') ? $session->get('userID') : $contactId;
519 $smsParams = array('To' => $phoneNumber, 'provider_id' => $schedule->sms_provider_id, 'activity_subject' => $messageSubject);
520 $activityTypeID = CRM_Core_OptionGroup::getValue('activity_type',
521 'SMS',
522 'name'
523 );
524 $details = $html ? $html : $text;
525 $activityParams = array(
526 'source_contact_id' => $userID,
527 'activity_type_id' => $activityTypeID,
528 'activity_date_time' => date('YmdHis'),
529 'subject' => $messageSubject,
530 'details' => $details,
531 'status_id' => CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name'),
532 );
533
534 $activity = CRM_Activity_BAO_Activity::create($activityParams);
535
536 CRM_Activity_BAO_Activity::sendSMSMessage($contactId,
537 $text,
538 $html,
539 $smsParams,
540 $activity->id,
541 $userID
542 );
6a488035 543 }
a3e3eea1 544
545 if ($schedule->mode == 'Email' or $schedule->mode == 'User_Preference') {
546 // set up the parameters for CRM_Utils_Mail::send
547 $mailParams = array(
548 'groupName' => 'Scheduled Reminder Sender',
549 'from' => $from,
550 'toName' => $contact['display_name'],
551 'toEmail' => $email,
552 'subject' => $messageSubject,
553 'entity' => 'action_schedule',
554 'entity_id' => $scheduleID,
555 );
556
557 if (!$html || $contact['preferred_mail_format'] == 'Text' ||
6a488035 558 $contact['preferred_mail_format'] == 'Both'
a3e3eea1 559 ) {
560 // render the &amp; entities in text mode, so that the links work
561 $mailParams['text'] = str_replace('&amp;', '&', $text);
562 }
563 if ($html && ($contact['preferred_mail_format'] == 'HTML' ||
564 $contact['preferred_mail_format'] == 'Both'
565 )
566 ) {
567 $mailParams['html'] = $html;
568 }
569 $result = CRM_Utils_Mail::send($mailParams);
6a488035 570 }
6a488035
TO
571 }
572 $schedule->free();
573
574 return $result;
575 }
576
577 /**
578 * Function to add the schedules reminders in the db
579 *
580 * @param array $params (reference ) an assoc array of name/value pairs
581 * @param array $ids the array that holds all the db ids
582 *
583 * @return object CRM_Core_DAO_ActionSchedule
584 * @access public
585 * @static
586 *
587 */
5284dd80 588 static function add(&$params, $ids = array()) {
6a488035
TO
589 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
590 $actionSchedule->copyValues($params);
591
592 return $actionSchedule->save();
593 }
594
595 /**
596 * Takes a bunch of params that are needed to match certain criteria and
597 * retrieves the relevant objects. It also stores all the retrieved
598 * values in the default array
599 *
600 * @param array $params (reference ) an assoc array of name/value pairs
601 * @param array $values (reference ) an assoc array to hold the flattened values
602 *
603 * @return object CRM_Core_DAO_ActionSchedule object on success, null otherwise
604 * @access public
605 * @static
606 */
607 static function retrieve(&$params, &$values) {
608 if (empty($params)) {
609 return NULL;
610 }
611 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
612
613 $actionSchedule->copyValues($params);
614
615 if ($actionSchedule->find(TRUE)) {
616 $ids['actionSchedule'] = $actionSchedule->id;
617
618 CRM_Core_DAO::storeValues($actionSchedule, $values);
619
620 return $actionSchedule;
621 }
622 return NULL;
623 }
624
625 /**
626 * Function to delete a Reminder
627 *
628 * @param int $id ID of the Reminder to be deleted.
629 *
630 * @access public
631 * @static
632 */
633 static function del($id) {
634 if ($id) {
635 $dao = new CRM_Core_DAO_ActionSchedule();
636 $dao->id = $id;
637 if ($dao->find(TRUE)) {
638 $dao->delete();
639 return;
640 }
641 }
642 CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
643 }
644
645 /**
646 * update the is_active flag in the db
647 *
648 * @param int $id id of the database record
649 * @param boolean $is_active value we want to set the is_active field
650 *
651 * @return Object DAO object on success, null otherwise
652 * @static
653 */
654 static function setIsActive($id, $is_active) {
655 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_ActionSchedule', $id, 'is_active', $is_active);
656 }
657
b5c2afd0
EM
658 /**
659 * @param $mappingID
660 * @param $now
661 *
662 * @throws CRM_Core_Exception
663 */
6a488035
TO
664 static function sendMailings($mappingID, $now) {
665 $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
666 $fromEmailAddress = "$domainValues[0] <$domainValues[1]>";
667
668 $mapping = new CRM_Core_DAO_ActionMapping();
669 $mapping->id = $mappingID;
670 $mapping->find(TRUE);
671
672 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
673 $actionSchedule->mapping_id = $mappingID;
674 $actionSchedule->is_active = 1;
675 $actionSchedule->find(FALSE);
676
677 $tokenFields = array();
678 $session = CRM_Core_Session::singleton();
679
680 while ($actionSchedule->fetch()) {
bb56ad3d 681 $extraSelect = $extraJoin = $extraWhere = $extraOn = '';
6a488035 682
1991bba1
DG
683 if ($actionSchedule->from_email)
684 $fromEmailAddress = "$actionSchedule->from_name <$actionSchedule->from_email>";
685
686
6a488035
TO
687 if ($actionSchedule->record_activity) {
688 if ($mapping->entity == 'civicrm_membership') {
689 $activityTypeID =
690 CRM_Core_OptionGroup::getValue('activity_type', 'Membership Renewal Reminder', 'name');
691 }
692 else {
693 $activityTypeID =
694 CRM_Core_OptionGroup::getValue('activity_type', 'Reminder Sent', 'name');
695 }
696
697 $activityStatusID =
698 CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name');
699 }
700
701 if ($mapping->entity == 'civicrm_activity') {
702 $tokenEntity = 'activity';
703 $tokenFields = array('activity_id', 'activity_type', 'subject', 'details', 'activity_date_time');
704 $extraSelect = ', ov.label as activity_type, e.id as activity_id';
a4b156a7
PJ
705 $extraJoin = "
706INNER JOIN civicrm_option_group og ON og.name = 'activity_type'
6a488035 707INNER JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
7188a78d 708 $extraOn = ' AND e.is_current_revision = 1 AND e.is_deleted = 0 ';
a4b156a7
PJ
709 if ($actionSchedule->limit_to == 0) {
710 $extraJoin = "
711LEFT JOIN civicrm_option_group og ON og.name = 'activity_type'
712LEFT JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
a4b156a7 713 }
6a488035
TO
714 }
715
716 if ($mapping->entity == 'civicrm_participant') {
717 $tokenEntity = 'event';
13837844 718 $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');
6a488035
TO
719 $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 ';
720
721 $extraJoin = "
722INNER JOIN civicrm_event ev ON e.event_id = ev.id
723INNER JOIN civicrm_option_group og ON og.name = 'event_type'
724INNER JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
725LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
726LEFT JOIN civicrm_address address ON address.id = lb.address_id
727LEFT JOIN civicrm_email email ON email.id = lb.email_id
728LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
729";
a4b156a7
PJ
730 if ($actionSchedule->limit_to == 0) {
731 $extraJoin = "
732LEFT JOIN civicrm_event ev ON e.event_id = ev.id
733LEFT JOIN civicrm_option_group og ON og.name = 'event_type'
734LEFT JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
735LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
736LEFT JOIN civicrm_address address ON address.id = lb.address_id
737LEFT JOIN civicrm_email email ON email.id = lb.email_id
738LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
739";
740 }
6a488035
TO
741 }
742
743 if ($mapping->entity == 'civicrm_membership') {
744 $tokenEntity = 'membership';
745 $tokenFields = array('fee', 'id', 'join_date', 'start_date', 'end_date', 'status', 'type');
746 $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';
747 $extraJoin = '
748 INNER JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
749 INNER JOIN civicrm_membership_status ms ON e.status_id = ms.id';
a4b156a7
PJ
750
751 if ($actionSchedule->limit_to == 0) {
752 $extraJoin = '
753 LEFT JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
754 LEFT JOIN civicrm_membership_status ms ON e.status_id = ms.id';
755 }
756 }
757
628801bf
AH
758 if ($mapping->entity == 'civicrm_contact') {
759 $tokenEntity = 'contact';
760 //TODO: get full list somewhere!
761 $tokenFields = array('birth_date', 'last_name');
762 //TODO: is there anything to add here?
763 }
764
a4b156a7
PJ
765 $entityJoinClause = "INNER JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
766 if ($actionSchedule->limit_to == 0) {
767 $entityJoinClause = "LEFT JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
768 $extraWhere .= " AND (e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact')";
6a488035 769 }
bb56ad3d 770 $entityJoinClause .= $extraOn;
6a488035
TO
771
772 $query = "
a4b156a7 773SELECT reminder.id as reminderID, reminder.contact_id as contactID, reminder.*, e.id as entityID, e.* {$extraSelect}
6a488035 774FROM civicrm_action_log reminder
a4b156a7 775{$entityJoinClause}
6a488035
TO
776{$extraJoin}
777WHERE reminder.action_schedule_id = %1 AND reminder.action_date_time IS NULL
778{$extraWhere}";
779
780 $dao = CRM_Core_DAO::executeQuery($query,
3e315abc 781 array(1 => array($actionSchedule->id, 'Integer'))
6a488035
TO
782 );
783
784 while ($dao->fetch()) {
785 $entityTokenParams = array();
786 foreach ($tokenFields as $field) {
787 if ($field == 'location') {
788 $loc = array();
789 $stateProvince = CRM_Core_PseudoConstant::stateProvince();
790 $loc['street_address'] = $dao->street_address;
791 $loc['city'] = $dao->city;
a124ebd4 792 $loc['state_province'] = CRM_Utils_Array::value($dao->state_province_id, $stateProvince);
6a488035
TO
793 $loc['postal_code'] = $dao->postal_code;
794 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Address::format($loc);
795 }
796 elseif ($field == 'info_url') {
797 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id, TRUE, NULL, FALSE);
798 }
799 elseif ($field == 'registration_url') {
800 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id, TRUE, NULL, FALSE);
801 }
802 elseif (in_array($field, array('start_date','end_date','join_date','activity_date_time'))) {
803 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Date::customFormat($dao->$field);
804 }
13837844
PJ
805 elseif ($field == 'balance') {
806 $info = CRM_Contribute_BAO_Contribution::getPaymentInfo($dao->entityID, 'event');
9ad04fb4
PJ
807 $balancePay = CRM_Utils_Array::value('balance', $info);
808 $balancePay = CRM_Utils_Money::format($balancePay);
809 $entityTokenParams["{$tokenEntity}." . $field] = $balancePay;
13837844 810 }
372ad74d
PJ
811 elseif ($field == 'fee_amount') {
812 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Money::format($dao->$field);
813 }
6a488035
TO
814 else {
815 $entityTokenParams["{$tokenEntity}." . $field] = $dao->$field;
816 }
817 }
818
819 $isError = 0;
a3e3eea1 820 $errorMsg = $toEmail = $toPhoneNumber = '';
821
822 if ($actionSchedule->mode == 'SMS' or $actionSchedule->mode == 'User_Preference') {
823 $filters = array('is_deceased' => 0, 'is_deleted' => 0, 'do_not_sms' => 0);
824 $toPhoneNumbers = CRM_Core_BAO_Phone::allPhones($dao->contactID, FALSE, 'Mobile', $filters);
825 //to get primary mobile ph,if not get a first mobile phONE
826 if (!empty($toPhoneNumbers)) {
827 $toPhoneNumberDetails = reset($toPhoneNumbers);
828 $toPhoneNumber = CRM_Utils_Array::value('phone', $toPhoneNumberDetails);
829 //contact allows to send sms
830 $toDoNotSms = 0;
831 }
832 }
833 if ($actionSchedule->mode == 'Email' or $actionSchedule->mode == 'User_Preference') {
834 $toEmail = CRM_Contact_BAO_Contact::getPrimaryEmail($dao->contactID);
835 }
836 if ($toEmail || !(empty($toPhoneNumber) or $toDoNotSms)) {
837 $to['email'] = $toEmail;
838 $to['phone'] = $toPhoneNumber;
6a488035
TO
839 $result =
840 CRM_Core_BAO_ActionSchedule::sendReminder(
a4b156a7 841 $dao->contactID,
a3e3eea1 842 $to,
6a488035
TO
843 $actionSchedule->id,
844 $fromEmailAddress,
845 $entityTokenParams
846 );
847
848 if (!$result || is_a($result, 'PEAR_Error')) {
849 // we could not send an email, for now we ignore, CRM-3406
850 $isError = 1;
851 }
852 }
853 else {
854 $isError = 1;
855 $errorMsg = "Couldn\'t find recipient\'s email address.";
856 }
857
858 // update action log record
859 $logParams = array(
860 'id' => $dao->reminderID,
861 'is_error' => $isError,
862 'message' => $errorMsg ? $errorMsg : "null",
863 'action_date_time' => $now,
864 );
865 CRM_Core_BAO_ActionLog::create($logParams);
866
867 // insert activity log record if needed
868 if ($actionSchedule->record_activity) {
869 $activityParams = array(
870 'subject' => $actionSchedule->title,
871 'details' => $actionSchedule->body_html,
b319d00a 872 'source_contact_id' =>
a4b156a7
PJ
873 $session->get('userID') ? $session->get('userID') : $dao->contactID,
874 'target_contact_id' => $dao->contactID,
6a488035
TO
875 'activity_date_time' => date('YmdHis'),
876 'status_id' => $activityStatusID,
877 'activity_type_id' => $activityTypeID,
878 'source_record_id' => $dao->entityID,
879 );
880 $activity = CRM_Activity_BAO_Activity::create($activityParams);
881 }
882 }
883
884 $dao->free();
885 }
886 }
887
b5c2afd0
EM
888 /**
889 * @param $mappingID
890 * @param $now
891 * @param array $params
892 *
893 * @throws API_Exception
894 */
73f3e293 895 static function buildRecipientContacts($mappingID, $now, $params = array()) {
6a488035
TO
896 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
897 $actionSchedule->mapping_id = $mappingID;
898 $actionSchedule->is_active = 1;
73f3e293
E
899 if(!empty($params)) {
900 _civicrm_api3_dao_set_filter($actionSchedule, $params, FALSE, 'ActionSchedule');
901 }
6a488035
TO
902 $actionSchedule->find();
903
904 while ($actionSchedule->fetch()) {
905 $mapping = new CRM_Core_DAO_ActionMapping();
906 $mapping->id = $mappingID;
907 $mapping->find(TRUE);
908
6d98dbc7
PJ
909 // note: $where - this filtering applies for both
910 // 'limit to' and 'addition to' options
911 // $limitWhere - this filtering applies only for
912 // 'limit to' option
913 $select = $join = $where = $limitWhere = array();
3e315abc 914 $limitTo = $actionSchedule->limit_to;
6a488035 915 $value = explode(CRM_Core_DAO::VALUE_SEPARATOR,
3e315abc 916 trim($actionSchedule->entity_value, CRM_Core_DAO::VALUE_SEPARATOR)
6a488035
TO
917 );
918 $value = implode(',', $value);
919
920 $status = explode(CRM_Core_DAO::VALUE_SEPARATOR,
3e315abc 921 trim($actionSchedule->entity_status, CRM_Core_DAO::VALUE_SEPARATOR)
6a488035
TO
922 );
923 $status = implode(',', $status);
924
8d657dde
AH
925 $anniversary = false;
926
6a488035 927 if (!CRM_Utils_System::isNull($mapping->entity_recipient)) {
40f2fee3 928 $recipientOptions = CRM_Core_OptionGroup::values($mapping->entity_recipient, FALSE, FALSE, FALSE, NULL, 'name');
6a488035
TO
929 }
930 $from = "{$mapping->entity} e";
931
932 if ($mapping->entity == 'civicrm_activity') {
00b1b9f1 933 $contactField = 'r.contact_id';
6cb6ba4c 934 $table = 'civicrm_activity e';
e7e657f0 935 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
9e74e3ce 936 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
937 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
938 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
b319d00a 939
bb56ad3d
PJ
940 if ($limitTo == 0) {
941 // including the activity target contacts if 'in addition' is defined
942 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
943 }
944 else {
945 switch (CRM_Utils_Array::value($actionSchedule->recipient, $recipientOptions)) {
946 case 'Activity Assignees':
947 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$assigneeID}";
948 break;
6a488035 949
bb56ad3d
PJ
950 case 'Activity Source':
951 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$sourceID}";
952 break;
6a488035 953
bb56ad3d
PJ
954 default:
955 case 'Activity Targets':
956 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
957 break;
958 }
6a488035
TO
959 }
960 // build where clause
961 if (!empty($value)) {
962 $where[] = "e.activity_type_id IN ({$value})";
963 }
964 else {
965 $where[] = "e.activity_type_id IS NULL";
966 }
967 if (!empty($status)) {
968 $where[] = "e.status_id IN ({$status})";
969 }
970 $where[] = ' e.is_current_revision = 1 ';
971 $where[] = ' e.is_deleted = 0 ';
972
973 $dateField = 'e.activity_date_time';
974 }
975
976 if ($mapping->entity == 'civicrm_participant') {
6cb6ba4c 977 $table = 'civicrm_event r';
6a488035
TO
978 $contactField = 'e.contact_id';
979 $join[] = 'INNER JOIN civicrm_event r ON e.event_id = r.id';
bb56ad3d 980 if ($actionSchedule->recipient_listing && $limitTo) {
6a488035 981 $rList = explode(CRM_Core_DAO::VALUE_SEPARATOR,
3e315abc 982 trim($actionSchedule->recipient_listing, CRM_Core_DAO::VALUE_SEPARATOR)
6a488035
TO
983 );
984 $rList = implode(',', $rList);
985
986 switch ($recipientOptions[$actionSchedule->recipient]) {
40f2fee3 987 case 'participant_role':
6a488035
TO
988 $where[] = "e.role_id IN ({$rList})";
989 break;
990
991 default:
992 break;
993 }
994 }
995
996 // build where clause
997 if (!empty($value)) {
998 $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IN ({$value})" : "r.id IN ({$value})";
999 }
1000 else {
1001 $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IS NULL" : "r.id IS NULL";
1002 }
1003
6d98dbc7
PJ
1004 // participant status criteria not to be implemented
1005 // for additional recipients
6a488035 1006 if (!empty($status)) {
6d98dbc7 1007 $limitWhere[] = "e.status_id IN ({$status})";
6a488035
TO
1008 }
1009
1010 $where[] = 'r.is_active = 1';
1011 $where[] = 'r.is_template = 0';
1012 $dateField = str_replace('event_', 'r.', $actionSchedule->start_action_date);
1013 }
1014
1015 $notINClause = '';
1016 if ($mapping->entity == 'civicrm_membership') {
1017 $contactField = 'e.contact_id';
6cb6ba4c 1018 $table = 'civicrm_membership e';
6a488035
TO
1019 // build where clause
1020 if ( $status == 2 ) {
1021 //auto-renew memberships
1022 $where[] = "e.contribution_recur_id IS NOT NULL ";
1023 }
1024 elseif ( $status == 1 ) {
1025 $where[] = "e.contribution_recur_id IS NULL ";
1026 }
1027
1028 // build where clause
1029 if (!empty($value)) {
1030 $where[] = "e.membership_type_id IN ({$value})";
1031 }
1032 else {
1033 $where[] = "e.membership_type_id IS NULL";
1034 }
1035
eec002d2 1036 $where[] = "( e.is_override IS NULL OR e.is_override = 0 )";
6a488035
TO
1037 $dateField = str_replace('membership_', 'e.', $actionSchedule->start_action_date);
1038 $notINClause = self::permissionedRelationships($contactField);
b319d00a 1039
7e9f2e18 1040 $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(NULL, "(is_current_member = 1 OR name = 'Expired')", 'id');
b1998d9c 1041 $mStatus = implode (',', $membershipStatus);
ed920eb1 1042 $where[] = "e.status_id IN ({$mStatus})";
6a488035 1043 }
6d98dbc7 1044
628801bf 1045 if ($mapping->entity == 'civicrm_contact') {
8d657dde
AH
1046 if ($value == 'birth_date') {
1047 $dateDBField = 'birth_date';
1048 $table = 'civicrm_contact e';
1049 $contactField = 'e.id';
1050 $where[] = 'e.is_deleted = 0';
1051 $where[] = 'e.is_deceased = 0';
1052 }
1053 else {
1054 //custom field
1055 $customFieldParams = array('id' => substr($value, 7));
1056 $customGroup = $customField = array();
1057 CRM_Core_BAO_CustomField::retrieve($customFieldParams, $customField);
1058 $dateDBField = $customField['column_name'];
1059 $customGroupParams = array('id' => $customField['custom_group_id'], $customGroup);
1060 CRM_Core_BAO_CustomGroup::retrieve($customGroupParams, $customGroup);
1061 $from = $table = "{$customGroup['table_name']} e";
1062 $contactField = 'e.entity_id';
1063 $where[] = '1'; // possible to have no "where" in this case
1064 }
1065
1066 $status_ = explode(',', $status);
1067 if (in_array(2, $status_)) {
1068 // anniversary mode:
1069 $dateField = 'DATE_ADD(e.' . $dateDBField . ', INTERVAL ROUND(DATEDIFF(NOW(), e.' . $dateDBField . ') / 365) YEAR)';
1070 $anniversary = true;
1071 }
1072 else {
1073 // regular mode:
1074 $dateField = 'e.' . $dateDBField;
1075 }
628801bf 1076 // TODO get this working
8d657dde
AH
1077
1078 // TODO: Make sure everything's provided for repetition, etc.
628801bf
AH
1079 }
1080
f10c69fa
DL
1081 // CRM-13577 Introduce Smart Groups Handling
1082 if ($actionSchedule->group_id) {
1083
1084 // Need to check if its a smart group or not
1085 // Then decide which table to join onto the query
2dd1b730 1086 $group = CRM_Contact_DAO_Group::getTableName();
f10c69fa
DL
1087
1088 // Get the group information
1089 $sql = "
1090SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
1091FROM $group
1092WHERE $group.id = {$actionSchedule->group_id}
1093";
1094
1095 $groupDAO = CRM_Core_DAO::executeQuery($sql);
1096 $isSmartGroup = FALSE;
1097 if (
1098 $groupDAO->fetch() &&
1099 !empty($groupDAO->saved_search_id)
1100 ) {
1101 // Check that the group is in place in the cache and up to date
1102 CRM_Contact_BAO_GroupContactCache::check($actionSchedule->group_id);
1103 // Set smart group flag
1104 $isSmartGroup = TRUE;
1105 }
1106 }
1107 // CRM-13577 End Introduce Smart Groups Handling
1108
6cb6ba4c 1109 if ($limitTo) {
1110 if ($actionSchedule->group_id) {
f10c69fa
DL
1111 // CRM-13577 If smart group then use Cache table
1112 if ($isSmartGroup) {
1113 $join[] = "INNER JOIN civicrm_group_contact_cache grp ON {$contactField} = grp.contact_id";
1114 $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
1115 } else {
1116 $join[] = "INNER JOIN civicrm_group_contact grp ON {$contactField} = grp.contact_id AND grp.status = 'Added'";
1117 $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
1118 }
6cb6ba4c 1119 }
1120 elseif (!empty($actionSchedule->recipient_manual)) {
1121 $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
1122 $where[] = "{$contactField} IN ({$rList})";
1123 }
6a488035 1124 }
6cb6ba4c 1125 else {
a4b156a7 1126 $addGroup = $addWhere = '';
6cb6ba4c 1127 if ($actionSchedule->group_id) {
f10c69fa
DL
1128 // CRM-13577 If smart group then use Cache table
1129 if ($isSmartGroup) {
1130 $addGroup = " INNER JOIN civicrm_group_contact_cache grp ON c.id = grp.contact_id";
1131 $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
1132 } else {
1133 $addGroup = " INNER JOIN civicrm_group_contact grp ON c.id = grp.contact_id AND grp.status = 'Added'";
1134 $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
1135 }
6cb6ba4c 1136 }
1137 if (!empty($actionSchedule->recipient_manual)) {
1138 $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
1139 $addWhere = "c.id IN ({$rList})";
1140 }
6a488035 1141 }
6d98dbc7 1142
3e315abc 1143 $select[] = "{$contactField} as contact_id";
1144 $select[] = 'e.id as entity_id';
1145 $select[] = "'{$mapping->entity}' as entity_table";
1146 $select[] = "{$actionSchedule->id} as action_schedule_id";
6a488035
TO
1147 $reminderJoinClause = "civicrm_action_log reminder ON reminder.contact_id = {$contactField} AND
1148reminder.entity_id = e.id AND
1149reminder.entity_table = '{$mapping->entity}' AND
1150reminder.action_schedule_id = %1";
1151
8d657dde
AH
1152 if ($anniversary) {
1153 // only consider reminders less than 11 months ago
1154 $reminderJoinClause .= " AND reminder.action_date_time > DATE_SUB({$now}, INTERVAL 11 MONTH)";
1155 }
1156
1157 if ($table != 'civicrm_contact e') {
1158 $join[] = "INNER JOIN civicrm_contact c ON c.id = {$contactField} AND c.is_deleted = 0 AND c.is_deceased = 0 ";
1159 }
6a488035
TO
1160
1161 if ($actionSchedule->start_action_date) {
3e315abc 1162 $startDateClause = array();
1163 $op = ($actionSchedule->start_action_condition == 'before' ? '<=' : '>=');
1164 $operator = ($actionSchedule->start_action_condition == 'before' ? 'DATE_SUB' : 'DATE_ADD');
1165 $date = $operator . "({$dateField}, INTERVAL {$actionSchedule->start_action_offset} {$actionSchedule->start_action_unit})";
6a488035
TO
1166 $startDateClause[] = "'{$now}' >= {$date}";
1167 if ($mapping->entity == 'civicrm_participant') {
1168 $startDateClause[] = $operator. "({$now}, INTERVAL 1 DAY ) {$op} " . $dateField;
1169 }
1170 else {
1171 $startDateClause[] = "DATE_SUB({$now}, INTERVAL 1 DAY ) <= {$date}";
1172 }
1173
1174 $startDate = implode(' AND ', $startDateClause);
1175 }
1176 elseif ($actionSchedule->absolute_date) {
1177 $startDate = "DATEDIFF(DATE('{$now}'),'{$actionSchedule->absolute_date}') = 0";
1178 }
1179
1180 // ( now >= date_built_from_start_time ) OR ( now = absolute_date )
1181 $dateClause = "reminder.id IS NULL AND {$startDate}";
1182
1183 // start composing query
1184 $selectClause = 'SELECT ' . implode(', ', $select);
3e315abc 1185 $fromClause = "FROM $from";
1186 $joinClause = !empty($join) ? implode(' ', $join) : '';
1187 $whereClause = 'WHERE ' . implode(' AND ', $where);
7188a78d
PJ
1188 $limitWhereClause = '';
1189 if (!empty($limitWhere)) {
1190 $limitWhereClause = ' AND ' . implode(' AND ', $limitWhere);
1191 }
6cb6ba4c 1192
6a488035
TO
1193 $query = "
1194INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
1195{$selectClause}
1196{$fromClause}
1197{$joinClause}
1198LEFT JOIN {$reminderJoinClause}
7188a78d 1199{$whereClause} {$limitWhereClause} AND {$dateClause} {$notINClause}
bb56ad3d 1200";
6a488035
TO
1201 CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
1202
bb56ad3d 1203 if ($limitTo == 0) {
82bf20c7
PJ
1204 $additionWhere = ' WHERE ';
1205 if ($actionSchedule->start_action_date) {
60d5bcb0 1206 $additionWhere = $whereClause . ' AND ';
82bf20c7 1207 }
3874157e
PJ
1208 $contactTable = "civicrm_contact c";
1209 $addSelect = "SELECT c.id as contact_id, c.id as entity_id, 'civicrm_contact' as entity_table, {$actionSchedule->id} as action_schedule_id";
1210 $additionReminderClause = "civicrm_action_log reminder ON reminder.contact_id = c.id AND
1211 reminder.entity_id = c.id AND
1212 reminder.entity_table = 'civicrm_contact' AND
1213 reminder.action_schedule_id = {$actionSchedule->id}";
8010925d 1214 $addWhereClause = '';
1215 if ($addWhere) {
1216 $addWhereClause = "AND {$addWhere}";
1217 }
bb56ad3d
PJ
1218 $insertAdditionalSql ="
1219INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
3874157e 1220{$addSelect}
fe9bc2c4 1221FROM ({$contactTable})
3874157e 1222LEFT JOIN {$additionReminderClause}
bb56ad3d 1223{$addGroup}
fe9bc2c4 1224WHERE c.is_deleted = 0 AND c.is_deceased = 0
8010925d 1225{$addWhereClause}
fe9bc2c4 1226
82bf20c7 1227AND c.id NOT IN (
bb56ad3d
PJ
1228 SELECT rem.contact_id
1229 FROM civicrm_action_log rem INNER JOIN {$mapping->entity} e ON rem.entity_id = e.id
1230 WHERE rem.action_schedule_id = {$actionSchedule->id}
1231 AND rem.entity_table = '{$mapping->entity}'
1232 )
7188a78d 1233GROUP BY c.id
bb56ad3d
PJ
1234";
1235 CRM_Core_DAO::executeQuery($insertAdditionalSql);
1236 }
6a488035
TO
1237 // if repeat is turned ON:
1238 if ($actionSchedule->is_repeat) {
1239 $repeatEvent = ($actionSchedule->end_action == 'before' ? 'DATE_SUB' : 'DATE_ADD') . "({$dateField}, INTERVAL {$actionSchedule->end_frequency_interval} {$actionSchedule->end_frequency_unit})";
1240
1241 if ($actionSchedule->repetition_frequency_unit == 'day') {
1242 $hrs = 24 * $actionSchedule->repetition_frequency_interval;
1243 }
1244 elseif ($actionSchedule->repetition_frequency_unit == 'week') {
1245 $hrs = 24 * $actionSchedule->repetition_frequency_interval * 7;
1246 }
9aec4088 1247 elseif ($actionSchedule->repetition_frequency_unit == 'month') {
1248 $hrs = "24*(DATEDIFF(DATE_ADD(latest_log_time, INTERVAL 1 MONTH ), latest_log_time))";
1249 }
1250 elseif ($actionSchedule->repetition_frequency_unit == 'year') {
1251 $hrs = "24*(DATEDIFF(DATE_ADD(latest_log_time, INTERVAL 1 YEAR ), latest_log_time))";
1252 }
6a488035
TO
1253 else {
1254 $hrs = $actionSchedule->repetition_frequency_interval;
1255 }
1256
1257 // (now <= repeat_end_time )
1258 $repeatEventClause = "'{$now}' <= {$repeatEvent}";
1259 // diff(now && logged_date_time) >= repeat_interval
1260 $havingClause = "HAVING TIMEDIFF({$now}, latest_log_time) >= TIME('{$hrs}:00:00')";
1261 $groupByClause = 'GROUP BY reminder.contact_id, reminder.entity_id, reminder.entity_table';
1262 $selectClause .= ', MAX(reminder.action_date_time) as latest_log_time';
6a488035
TO
1263 $sqlInsertValues = "{$selectClause}
1264{$fromClause}
1265{$joinClause}
1266INNER JOIN {$reminderJoinClause}
3874157e 1267{$whereClause} {$limitWhereClause} AND {$repeatEventClause}
6a488035
TO
1268{$groupByClause}
1269{$havingClause}";
1270
1271 $valsqlInsertValues = CRM_Core_DAO::executeQuery($sqlInsertValues, array(1 => array($actionSchedule->id, 'Integer')));
1272
1273 $arrValues = array();
1274 while ($valsqlInsertValues->fetch()) {
1275 $arrValues[] = "( {$valsqlInsertValues->contact_id}, {$valsqlInsertValues->entity_id}, '{$valsqlInsertValues->entity_table}',{$valsqlInsertValues->action_schedule_id} )";
1276 }
1277
1278 $valString = implode(',', $arrValues);
1279
1280 if ($valString) {
1281 $query = '
1282 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1283 CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
1284 }
3874157e
PJ
1285
1286 if ($limitTo == 0) {
1287 $addSelect .= ', MAX(reminder.action_date_time) as latest_log_time';
1288 $sqlEndEventCheck = "
1289SELECT * FROM {$table}
1290{$whereClause} AND {$repeatEventClause} LIMIT 1";
1291
1292 $daoCheck = CRM_Core_DAO::executeQuery($sqlEndEventCheck);
1293 if ($daoCheck->fetch()) {
1294 $valSqlAdditionInsert = "
1295{$addSelect}
1296FROM {$contactTable}
1297{$addGroup}
1298INNER JOIN {$additionReminderClause}
1299WHERE {$addWhere} AND c.is_deleted = 0 AND c.is_deceased = 0
1300GROUP BY reminder.contact_id
1301{$havingClause}
1302";
1303 $daoForVals = CRM_Core_DAO::executeQuery($valSqlAdditionInsert);
1304 $addValues = array();
1305 while ($daoForVals->fetch()) {
1306 $addValues[] = "( {$daoForVals->contact_id}, {$daoForVals->entity_id}, '{$daoForVals->entity_table}',{$daoForVals->action_schedule_id} )";
1307 }
1308 $valString = implode(',', $addValues);
1309
1310 if ($valString) {
1311 $query = '
1312 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1313 CRM_Core_DAO::executeQuery($query);
1314 }
1315 }
1316 }
6a488035
TO
1317 }
1318 }
1319 }
1320
b5c2afd0
EM
1321 /**
1322 * @param $field
1323 *
1324 * @return null|string
1325 */
6a488035
TO
1326 static function permissionedRelationships($field) {
1327 $query = '
1328SELECT 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
1329FROM civicrm_membership m
1330LEFT JOIN civicrm_membership cm ON cm.id = m.owner_membership_id
1331LEFT JOIN civicrm_membership_type cmt ON cmt.id = m.membership_type_id
1332LEFT 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 )
1333 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 ) )
1334WHERE m.owner_membership_id IS NOT NULL AND
1335 ( rel.is_permission_a_b = 0 OR rel.is_permission_b_a = 0)
1336
1337';
1338 $excludeIds = array();
1339 $dao = CRM_Core_DAO::executeQuery($query, array());
1340 while ($dao->fetch()) {
1341 if ($dao->slave_contact == $dao->contact_id_a && $dao->is_permission_b_a == 0) {
1342 $excludeIds[] = $dao->slave_contact;
1343 }
1344 elseif ($dao->slave_contact == $dao->contact_id_b && $dao->is_permission_a_b == 0) {
1345 $excludeIds[] = $dao->slave_contact;
1346 }
1347 }
1348
1349 if (!empty($excludeIds)) {
1350 $clause = "AND {$field} NOT IN ( " .implode(', ', $excludeIds) . ' ) ';
1351 return $clause;
1352 }
1353 return NULL;
1354 }
1355
b5c2afd0
EM
1356 /**
1357 * @param null $now
1358 * @param array $params
1359 *
1360 * @return array
1361 */
73f3e293 1362 static function processQueue($now = NULL, $params = array()) {
6a488035
TO
1363 $now = $now ? CRM_Utils_Time::setTime($now) : CRM_Utils_Time::getTime();
1364
1365 $mappings = self::getMapping();
1366 foreach ($mappings as $mappingID => $mapping) {
73f3e293 1367 self::buildRecipientContacts($mappingID, $now, $params);
6a488035
TO
1368 self::sendMailings($mappingID, $now);
1369 }
1370
1371 $result = array(
1372 'is_error' => 0,
1373 'messages' => ts('Sent all scheduled reminders successfully'),
1374 );
1375 return $result;
1376 }
1377
9a4df24c
EM
1378 /**
1379 * @param $id
1380 * @param $mappingID
1381 *
1382 * @return null|string
1383 */
6a488035
TO
1384 static function isConfigured($id, $mappingID) {
1385 $queryString = "SELECT count(id) FROM civicrm_action_schedule
1386 WHERE mapping_id = %1 AND
1387 entity_value = %2";
1388
3e315abc 1389 $params = array(
1390 1 => array($mappingID, 'Integer'),
1391 2 => array($id, 'Integer'),
6a488035
TO
1392 );
1393 return CRM_Core_DAO::singleValueQuery($queryString, $params);
1394 }
1395
b5c2afd0
EM
1396 /**
1397 * @param $mappingID
1398 * @param $recipientType
1399 *
1400 * @return array
1401 */
6a488035
TO
1402 static function getRecipientListing($mappingID, $recipientType) {
1403 $options = array();
1404 if (!$mappingID || !$recipientType) {
1405 return $options;
1406 }
1407
1408 $mapping = self::getMapping($mappingID);
1409
1410 switch ($mapping['entity']) {
1411 case 'civicrm_participant':
e7e657f0 1412 $eventContacts = CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
a7488080 1413 if (empty($eventContacts[$recipientType])) {
6a488035
TO
1414 return $options;
1415 }
40f2fee3 1416 if ($eventContacts[$recipientType] == 'participant_role') {
6a488035
TO
1417 $options = CRM_Event_PseudoConstant::participantRole();
1418 }
1419 break;
1420 }
1421
1422 return $options;
1423 }
1424}