CRM-13555, remove description column from default list atleast for upgrade.
[civicrm-core.git] / CRM / Core / BAO / ActionSchedule.php
1 <?php
2 /*
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. |
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-2013
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 static function getMapping($id = NULL) {
43 static $_action_mapping;
44
45 if ($id && !is_null($_action_mapping) && isset($_action_mapping[$id])) {
46 return $_action_mapping[$id];
47 }
48
49 $dao = new CRM_Core_DAO_ActionMapping();
50 if ($id) {
51 $dao->id = $id;
52 }
53 $dao->find();
54
55 $mapping = array();
56 while ($dao->fetch()) {
57 $defaults = array();
58 CRM_Core_DAO::storeValues($dao, $defaults);
59 $mapping[$dao->id] = $defaults;
60 }
61 $_action_mapping = $mapping;
62
63 return $mapping;
64 }
65
66 /**
67 * Retrieve list of selections/drop downs for Scheduled Reminder form
68 *
69 * @param bool $id mapping id
70 *
71 * @return array associated array of all the drop downs in the form
72 * @static
73 * @access public
74 */
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);
79
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();
86
87 asort($activityType);
88
89 $sel1 = $sel2 = $sel3 = $sel4 = $sel5 = array();
90 $options = array(
91 'manual' => ts('Choose Recipient(s)'),
92 'group' => ts('Select a Group'),
93 );
94
95 $entityMapping = array();
96 $recipientMapping = array_combine(array_keys($options), array_keys($options));
97
98 if (!$id) {
99 $id = 1;
100 }
101
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);
109
110 $sel1Val = NULL;
111 switch ($entityValue) {
112 case 'activity_type':
113 if ($value['entity'] == 'civicrm_activity') {
114 $sel1Val = ts('Activity');
115 }
116 $sel2[$key] = $valueLabel + $activityType;
117 break;
118
119 case 'event_type':
120 if ($value['entity'] == 'civicrm_participant') {
121 $sel1Val = ts('Event Type');
122 }
123 $sel2[$key] = $valueLabel + $eventType;
124 break;
125
126 case 'event_template':
127 if ($value['entity'] == 'civicrm_participant') {
128 $sel1Val = ts('Event Template');
129 }
130 $sel2[$key] = $valueLabel + $eventTemplate;
131 break;
132
133 case 'civicrm_event':
134 if ($value['entity'] == 'civicrm_participant') {
135 $sel1Val = ts('Event Name');
136 }
137 $sel2[$key] = $valueLabel + $event;
138 break;
139
140 case 'civicrm_membership_type':
141 if ($value['entity'] == 'civicrm_membership') {
142 $sel1Val = ts('Membership');
143 }
144 $sel2[$key] = $valueLabel + $membershipType;
145 break;
146 }
147 $sel1[$key] = $sel1Val;
148
149 if ($key == $id) {
150 if ($startDate = CRM_Utils_Array::value('entity_date_start', $value)) {
151 $sel4[$startDate] = ucwords(str_replace('_', ' ', $startDate));
152 }
153 if ($endDate = CRM_Utils_Array::value('entity_date_end', $value)) {
154 $sel4[$endDate] = ucwords(str_replace('_', ' ', $endDate));
155 }
156
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');
162 break;
163
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');
168 break;
169
170 case NULL:
171 $sel5[$entityRecipient] = $options;
172 break;
173 }
174 }
175 }
176 $sel3 = $sel2;
177
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);
182
183 switch ($entityStatus) {
184 case 'activity_status':
185 foreach ($sel3[$id] as $kkey => & $vval) {
186 $vval = $statusLabel + $activityStatus;
187 }
188 break;
189
190 case 'civicrm_participant_status_type':
191 foreach ($sel3[$id] as $kkey => & $vval) {
192 $vval = $statusLabel + $participantStatus;
193 }
194 break;
195
196 case 'auto_renew_options':
197 foreach ($sel3[$id] as $kkey => & $vval) {
198 $auto = 0;
199 if ($kkey) {
200 $auto = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $kkey, 'auto_renew');
201 }
202 if ( $auto ) {
203 $vval = $statusLabel + $autoRenew;
204 }
205 else {
206 $vval = $statusLabel;
207 }
208 }
209 break;
210
211 case '':
212 $sel3[$id] = '';
213 break;
214
215 }
216 }
217 return array(
218 'sel1' => $sel1,
219 'sel2' => $sel2,
220 'sel3' => $sel3,
221 'sel4' => $sel4,
222 'sel5' => $sel5,
223 'entityMapping' => $entityMapping,
224 'recipientMapping' => $recipientMapping,
225 );
226 }
227
228 static function getSelection1($id = NULL) {
229 $mapping = self::getMapping($id);
230 $sel4 = $sel5 = array();
231 $options = array(
232 'manual' => ts('Choose Recipient(s)'),
233 'group' => ts('Select a Group'),
234 );
235
236 $recipientMapping = array_combine(array_keys($options), array_keys($options));
237
238 foreach ($mapping as $value) {
239 $entityRecipient = CRM_Utils_Array::value('entity_recipient', $value);
240 $key = CRM_Utils_Array::value('id', $value);
241
242 if ($startDate = CRM_Utils_Array::value('entity_date_start', $value)) {
243 $sel4[$startDate] = ucwords(str_replace('_', ' ', $startDate));
244 }
245 if ($endDate = CRM_Utils_Array::value('entity_date_end', $value)) {
246 $sel4[$endDate] = ucwords(str_replace('_', ' ', $endDate));
247 }
248
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');
254 break;
255
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');
260 break;
261
262 case NULL:
263 $sel5[$id] = $options;
264 break;
265 }
266 }
267
268 return array(
269 'sel4' => $sel4,
270 'sel5' => $sel5[$id],
271 'recipientMapping' => $recipientMapping,
272 );
273 }
274
275 /**
276 * Retrieve list of Scheduled Reminders
277 *
278 * @param bool $namesOnly return simple list of names
279 *
280 * @return array (reference) reminder list
281 * @static
282 * @access public
283 */
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();
287
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();
292
293 $auto_renew_options = CRM_Core_OptionGroup::values('auto_renew_options');
294 $civicrm_membership_type = CRM_Member_PseudoConstant::membershipType();
295
296 asort($activity_type);
297 $entity = array(
298 'civicrm_activity' => 'Activity',
299 'civicrm_participant' => 'Event',
300 'civicrm_membership' => 'Member',
301 );
302
303 $query = "
304 SELECT
305 title,
306 cam.entity,
307 cas.id as id,
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,
316 cas.absolute_date,
317 is_repeat,
318 is_active
319
320 FROM civicrm_action_schedule cas
321 LEFT JOIN civicrm_action_mapping cam ON (cam.id = cas.mapping_id)
322 ";
323 $params = CRM_Core_DAO::$_nullArray;
324
325 if ($entityValue and $id) {
326 $where = "
327 WHERE cas.entity_value = $id AND
328 cam.entity_value = '$entityValue'";
329
330 $query .= $where;
331
332 $params = array(
333 1 => array($id, 'Integer'),
334 2 => array($entityValue, 'String'),
335 );
336 }
337
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;
347
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);
352 }
353 $statusIds = implode(', ', $statusArray);
354
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);
359 }
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;
366 }
367
368 return $list;
369 }
370
371 static function sendReminder($contactId, $email, $scheduleID, $from, $tokenParams) {
372
373 $schedule = new CRM_Core_DAO_ActionSchedule();
374 $schedule->id = $scheduleID;
375
376 $domain = CRM_Core_BAO_Domain::getDomain();
377 $result = NULL;
378 $hookTokens = array();
379
380 if ($schedule->find(TRUE)) {
381 $body_text = $schedule->body_text;
382 $body_html = $schedule->body_html;
383 $body_subject = $schedule->subject;
384 if (!$body_text) {
385 $body_text = CRM_Utils_String::htmlToText($body_html);
386 }
387
388 $params = array(array('contact_id', '=', $contactId, 0, 0));
389 list($contact, $_) = CRM_Contact_BAO_Query::apiQuery($params);
390
391 //CRM-4524
392 $contact = reset($contact);
393
394 if (!$contact || is_a($contact, 'CRM_Core_Error')) {
395 return NULL;
396 }
397
398 // merge activity tokens with contact array
399 $contact = array_merge($contact, $tokenParams);
400
401 //CRM-5734
402 CRM_Utils_Hook::tokenValues($contact, $contactId);
403
404 CRM_Utils_Hook::tokens($hookTokens);
405 $categories = array_keys($hookTokens);
406
407 $type = array('html', 'text');
408
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();
414
415 if ($$bodyType) {
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);
421 }
422 }
423 $html = $body_html;
424 $text = $body_text;
425
426 $smarty = CRM_Core_Smarty::singleton();
427 foreach (array(
428 'text', 'html') as $elem) {
429 $$elem = $smarty->fetch("string:{$$elem}");
430 }
431
432 $matches = array();
433 preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
434 $body_subject,
435 $matches,
436 PREG_PATTERN_ORDER
437 );
438
439 $subjectToken = NULL;
440 if ($matches[1]) {
441 foreach ($matches[1] as $token) {
442 list($type, $name) = preg_split('/\./', $token, 2);
443 if ($name) {
444 if (!isset($subjectToken['contact'])) {
445 $subjectToken['contact'] = array();
446 }
447 $subjectToken['contact'][] = $name;
448 }
449 }
450 }
451
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);
456
457 $messageSubject = $smarty->fetch("string:{$messageSubject}");
458
459 // set up the parameters for CRM_Utils_Mail::send
460 $mailParams = array(
461 'groupName' => 'Scheduled Reminder Sender',
462 'from' => $from,
463 'toName' => $contact['display_name'],
464 'toEmail' => $email,
465 'subject' => $messageSubject,
466 );
467
468 if (!$html || $contact['preferred_mail_format'] == 'Text' ||
469 $contact['preferred_mail_format'] == 'Both'
470 ) {
471 // render the &amp; entities in text mode, so that the links work
472 $mailParams['text'] = str_replace('&amp;', '&', $text);
473 }
474 if ($html && ($contact['preferred_mail_format'] == 'HTML' ||
475 $contact['preferred_mail_format'] == 'Both'
476 )) {
477 $mailParams['html'] = $html;
478 }
479
480 $result = CRM_Utils_Mail::send($mailParams);
481 }
482 $schedule->free();
483
484 return $result;
485 }
486
487 /**
488 * Function to add the schedules reminders in the db
489 *
490 * @param array $params (reference ) an assoc array of name/value pairs
491 * @param array $ids the array that holds all the db ids
492 *
493 * @return object CRM_Core_DAO_ActionSchedule
494 * @access public
495 * @static
496 *
497 */
498 static function add(&$params, &$ids) {
499 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
500 $actionSchedule->copyValues($params);
501
502 return $actionSchedule->save();
503 }
504
505 /**
506 * Takes a bunch of params that are needed to match certain criteria and
507 * retrieves the relevant objects. It also stores all the retrieved
508 * values in the default array
509 *
510 * @param array $params (reference ) an assoc array of name/value pairs
511 * @param array $values (reference ) an assoc array to hold the flattened values
512 *
513 * @return object CRM_Core_DAO_ActionSchedule object on success, null otherwise
514 * @access public
515 * @static
516 */
517 static function retrieve(&$params, &$values) {
518 if (empty($params)) {
519 return NULL;
520 }
521 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
522
523 $actionSchedule->copyValues($params);
524
525 if ($actionSchedule->find(TRUE)) {
526 $ids['actionSchedule'] = $actionSchedule->id;
527
528 CRM_Core_DAO::storeValues($actionSchedule, $values);
529
530 return $actionSchedule;
531 }
532 return NULL;
533 }
534
535 /**
536 * Function to delete a Reminder
537 *
538 * @param int $id ID of the Reminder to be deleted.
539 *
540 * @access public
541 * @static
542 */
543 static function del($id) {
544 if ($id) {
545 $dao = new CRM_Core_DAO_ActionSchedule();
546 $dao->id = $id;
547 if ($dao->find(TRUE)) {
548 $dao->delete();
549 return;
550 }
551 }
552 CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
553 }
554
555 /**
556 * update the is_active flag in the db
557 *
558 * @param int $id id of the database record
559 * @param boolean $is_active value we want to set the is_active field
560 *
561 * @return Object DAO object on success, null otherwise
562 * @static
563 */
564 static function setIsActive($id, $is_active) {
565 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_ActionSchedule', $id, 'is_active', $is_active);
566 }
567
568 static function sendMailings($mappingID, $now) {
569 $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
570 $fromEmailAddress = "$domainValues[0] <$domainValues[1]>";
571
572 $mapping = new CRM_Core_DAO_ActionMapping();
573 $mapping->id = $mappingID;
574 $mapping->find(TRUE);
575
576 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
577 $actionSchedule->mapping_id = $mappingID;
578 $actionSchedule->is_active = 1;
579 $actionSchedule->find(FALSE);
580
581 $tokenFields = array();
582 $session = CRM_Core_Session::singleton();
583
584 while ($actionSchedule->fetch()) {
585 $extraSelect = $extraJoin = $extraWhere = $extraOn = '';
586
587 if ($actionSchedule->record_activity) {
588 if ($mapping->entity == 'civicrm_membership') {
589 $activityTypeID =
590 CRM_Core_OptionGroup::getValue('activity_type', 'Membership Renewal Reminder', 'name');
591 }
592 else {
593 $activityTypeID =
594 CRM_Core_OptionGroup::getValue('activity_type', 'Reminder Sent', 'name');
595 }
596
597 $activityStatusID =
598 CRM_Core_OptionGroup::getValue('activity_status', 'Completed', 'name');
599 }
600
601 if ($mapping->entity == 'civicrm_activity') {
602 $tokenEntity = 'activity';
603 $tokenFields = array('activity_id', 'activity_type', 'subject', 'details', 'activity_date_time');
604 $extraSelect = ', ov.label as activity_type, e.id as activity_id';
605 $extraJoin = "
606 INNER JOIN civicrm_option_group og ON og.name = 'activity_type'
607 INNER JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
608 $extraOn = ' AND e.is_current_revision = 1 AND e.is_deleted = 0 ';
609 if ($actionSchedule->limit_to == 0) {
610 $extraJoin = "
611 LEFT JOIN civicrm_option_group og ON og.name = 'activity_type'
612 LEFT JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
613 }
614 }
615
616 if ($mapping->entity == 'civicrm_participant') {
617 $tokenEntity = 'event';
618 $tokenFields = array('event_type', 'title', 'event_id', 'start_date', 'end_date', 'summary', 'description', 'location', 'info_url', 'registration_url', 'fee_amount', 'contact_email', 'contact_phone');
619 $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 ';
620
621 $extraJoin = "
622 INNER JOIN civicrm_event ev ON e.event_id = ev.id
623 INNER JOIN civicrm_option_group og ON og.name = 'event_type'
624 INNER JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
625 LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
626 LEFT JOIN civicrm_address address ON address.id = lb.address_id
627 LEFT JOIN civicrm_email email ON email.id = lb.email_id
628 LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
629 ";
630 if ($actionSchedule->limit_to == 0) {
631 $extraJoin = "
632 LEFT JOIN civicrm_event ev ON e.event_id = ev.id
633 LEFT JOIN civicrm_option_group og ON og.name = 'event_type'
634 LEFT JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
635 LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
636 LEFT JOIN civicrm_address address ON address.id = lb.address_id
637 LEFT JOIN civicrm_email email ON email.id = lb.email_id
638 LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
639 ";
640 }
641 }
642
643 if ($mapping->entity == 'civicrm_membership') {
644 $tokenEntity = 'membership';
645 $tokenFields = array('fee', 'id', 'join_date', 'start_date', 'end_date', 'status', 'type');
646 $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';
647 $extraJoin = '
648 INNER JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
649 INNER JOIN civicrm_membership_status ms ON e.status_id = ms.id';
650
651 if ($actionSchedule->limit_to == 0) {
652 $extraJoin = '
653 LEFT JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
654 LEFT JOIN civicrm_membership_status ms ON e.status_id = ms.id';
655 }
656 }
657
658 $entityJoinClause = "INNER JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
659 if ($actionSchedule->limit_to == 0) {
660 $entityJoinClause = "LEFT JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
661 $extraWhere .= " AND (e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact')";
662 }
663 $entityJoinClause .= $extraOn;
664
665 $query = "
666 SELECT reminder.id as reminderID, reminder.contact_id as contactID, reminder.*, e.id as entityID, e.* {$extraSelect}
667 FROM civicrm_action_log reminder
668 {$entityJoinClause}
669 {$extraJoin}
670 WHERE reminder.action_schedule_id = %1 AND reminder.action_date_time IS NULL
671 {$extraWhere}";
672
673 $dao = CRM_Core_DAO::executeQuery($query,
674 array(1 => array($actionSchedule->id, 'Integer'))
675 );
676
677 while ($dao->fetch()) {
678 $entityTokenParams = array();
679 foreach ($tokenFields as $field) {
680 if ($field == 'location') {
681 $loc = array();
682 $stateProvince = CRM_Core_PseudoConstant::stateProvince();
683 $loc['street_address'] = $dao->street_address;
684 $loc['city'] = $dao->city;
685 $loc['state_province'] = CRM_Utils_array::value($dao->state_province_id, $stateProvince);
686 $loc['postal_code'] = $dao->postal_code;
687 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Address::format($loc);
688 }
689 elseif ($field == 'info_url') {
690 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System::url('civicrm/event/info', 'reset=1&id=' . $dao->event_id, TRUE, NULL, FALSE);
691 }
692 elseif ($field == 'registration_url') {
693 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_System::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id, TRUE, NULL, FALSE);
694 }
695 elseif (in_array($field, array('start_date','end_date','join_date','activity_date_time'))) {
696 $entityTokenParams["{$tokenEntity}." . $field] = CRM_Utils_Date::customFormat($dao->$field);
697 }
698 else {
699 $entityTokenParams["{$tokenEntity}." . $field] = $dao->$field;
700 }
701 }
702
703 $isError = 0;
704 $errorMsg = '';
705 $toEmail = CRM_Contact_BAO_Contact::getPrimaryEmail($dao->contactID);
706 if ($toEmail) {
707 $result =
708 CRM_Core_BAO_ActionSchedule::sendReminder(
709 $dao->contactID,
710 $toEmail,
711 $actionSchedule->id,
712 $fromEmailAddress,
713 $entityTokenParams
714 );
715
716 if (!$result || is_a($result, 'PEAR_Error')) {
717 // we could not send an email, for now we ignore, CRM-3406
718 $isError = 1;
719 }
720 }
721 else {
722 $isError = 1;
723 $errorMsg = "Couldn\'t find recipient\'s email address.";
724 }
725
726 // update action log record
727 $logParams = array(
728 'id' => $dao->reminderID,
729 'is_error' => $isError,
730 'message' => $errorMsg ? $errorMsg : "null",
731 'action_date_time' => $now,
732 );
733 CRM_Core_BAO_ActionLog::create($logParams);
734
735 // insert activity log record if needed
736 if ($actionSchedule->record_activity) {
737 $activityParams = array(
738 'subject' => $actionSchedule->title,
739 'details' => $actionSchedule->body_html,
740 'source_contact_id' =>
741 $session->get('userID') ? $session->get('userID') : $dao->contactID,
742 'target_contact_id' => $dao->contactID,
743 'activity_date_time' => date('YmdHis'),
744 'status_id' => $activityStatusID,
745 'activity_type_id' => $activityTypeID,
746 'source_record_id' => $dao->entityID,
747 );
748 $activity = CRM_Activity_BAO_Activity::create($activityParams);
749 }
750 }
751
752 $dao->free();
753 }
754 }
755
756 static function buildRecipientContacts($mappingID, $now) {
757 $actionSchedule = new CRM_Core_DAO_ActionSchedule();
758 $actionSchedule->mapping_id = $mappingID;
759 $actionSchedule->is_active = 1;
760 $actionSchedule->find();
761
762 while ($actionSchedule->fetch()) {
763 $mapping = new CRM_Core_DAO_ActionMapping();
764 $mapping->id = $mappingID;
765 $mapping->find(TRUE);
766
767 // note: $where - this filtering applies for both
768 // 'limit to' and 'addition to' options
769 // $limitWhere - this filtering applies only for
770 // 'limit to' option
771 $select = $join = $where = $limitWhere = array();
772 $limitTo = $actionSchedule->limit_to;
773 $value = explode(CRM_Core_DAO::VALUE_SEPARATOR,
774 trim($actionSchedule->entity_value, CRM_Core_DAO::VALUE_SEPARATOR)
775 );
776 $value = implode(',', $value);
777
778 $status = explode(CRM_Core_DAO::VALUE_SEPARATOR,
779 trim($actionSchedule->entity_status, CRM_Core_DAO::VALUE_SEPARATOR)
780 );
781 $status = implode(',', $status);
782
783 if (!CRM_Utils_System::isNull($mapping->entity_recipient)) {
784 $recipientOptions = CRM_Core_OptionGroup::values($mapping->entity_recipient, FALSE, FALSE, FALSE, NULL, 'name');
785 }
786 $from = "{$mapping->entity} e";
787
788 if ($mapping->entity == 'civicrm_activity') {
789 $contactField = 'r.contact_id';
790 $table = 'civicrm_activity e';
791 $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
792 $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
793 $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
794 $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
795
796 if ($limitTo == 0) {
797 // including the activity target contacts if 'in addition' is defined
798 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
799 }
800 else {
801 switch (CRM_Utils_Array::value($actionSchedule->recipient, $recipientOptions)) {
802 case 'Activity Assignees':
803 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$assigneeID}";
804 break;
805
806 case 'Activity Source':
807 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$sourceID}";
808 break;
809
810 default:
811 case 'Activity Targets':
812 $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
813 break;
814 }
815 }
816 // build where clause
817 if (!empty($value)) {
818 $where[] = "e.activity_type_id IN ({$value})";
819 }
820 else {
821 $where[] = "e.activity_type_id IS NULL";
822 }
823 if (!empty($status)) {
824 $where[] = "e.status_id IN ({$status})";
825 }
826 $where[] = ' e.is_current_revision = 1 ';
827 $where[] = ' e.is_deleted = 0 ';
828
829 $dateField = 'e.activity_date_time';
830 }
831
832 if ($mapping->entity == 'civicrm_participant') {
833 $table = 'civicrm_event r';
834 $contactField = 'e.contact_id';
835 $join[] = 'INNER JOIN civicrm_event r ON e.event_id = r.id';
836 if ($actionSchedule->recipient_listing && $limitTo) {
837 $rList = explode(CRM_Core_DAO::VALUE_SEPARATOR,
838 trim($actionSchedule->recipient_listing, CRM_Core_DAO::VALUE_SEPARATOR)
839 );
840 $rList = implode(',', $rList);
841
842 switch ($recipientOptions[$actionSchedule->recipient]) {
843 case 'participant_role':
844 $where[] = "e.role_id IN ({$rList})";
845 break;
846
847 default:
848 break;
849 }
850 }
851
852 // build where clause
853 if (!empty($value)) {
854 $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IN ({$value})" : "r.id IN ({$value})";
855 }
856 else {
857 $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IS NULL" : "r.id IS NULL";
858 }
859
860 // participant status criteria not to be implemented
861 // for additional recipients
862 if (!empty($status)) {
863 $limitWhere[] = "e.status_id IN ({$status})";
864 }
865
866 $where[] = 'r.is_active = 1';
867 $where[] = 'r.is_template = 0';
868 $dateField = str_replace('event_', 'r.', $actionSchedule->start_action_date);
869 }
870
871 $notINClause = '';
872 if ($mapping->entity == 'civicrm_membership') {
873 $contactField = 'e.contact_id';
874 $table = 'civicrm_membership e';
875 // build where clause
876 if ( $status == 2 ) {
877 //auto-renew memberships
878 $where[] = "e.contribution_recur_id IS NOT NULL ";
879 }
880 elseif ( $status == 1 ) {
881 $where[] = "e.contribution_recur_id IS NULL ";
882 }
883
884 // build where clause
885 if (!empty($value)) {
886 $where[] = "e.membership_type_id IN ({$value})";
887 }
888 else {
889 $where[] = "e.membership_type_id IS NULL";
890 }
891
892 $where[] = "( e.is_override IS NULL OR e.is_override = 0 )";
893 $dateField = str_replace('membership_', 'e.', $actionSchedule->start_action_date);
894 $notINClause = self::permissionedRelationships($contactField);
895
896 $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(NULL, "(is_current_member = 1 OR name = 'Expired')", 'id');
897 $mStatus = implode (',', $membershipStatus);
898 $where[] = "e.status_id IN ({$mStatus})";
899 }
900
901 if ($limitTo) {
902 if ($actionSchedule->group_id) {
903 $join[] = "INNER JOIN civicrm_group_contact grp ON {$contactField} = grp.contact_id AND grp.status = 'Added'";
904 $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
905 }
906 elseif (!empty($actionSchedule->recipient_manual)) {
907 $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
908 $where[] = "{$contactField} IN ({$rList})";
909 }
910 }
911 else {
912 $addGroup = $addWhere = '';
913 if ($actionSchedule->group_id) {
914 $addGroup = " INNER JOIN civicrm_group_contact grp ON c.id = grp.contact_id AND grp.status = 'Added'";
915 $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
916 }
917 if (!empty($actionSchedule->recipient_manual)) {
918 $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
919 $addWhere = "c.id IN ({$rList})";
920 }
921 }
922
923 $select[] = "{$contactField} as contact_id";
924 $select[] = 'e.id as entity_id';
925 $select[] = "'{$mapping->entity}' as entity_table";
926 $select[] = "{$actionSchedule->id} as action_schedule_id";
927 $reminderJoinClause = "civicrm_action_log reminder ON reminder.contact_id = {$contactField} AND
928 reminder.entity_id = e.id AND
929 reminder.entity_table = '{$mapping->entity}' AND
930 reminder.action_schedule_id = %1";
931
932 $join[] = "INNER JOIN civicrm_contact c ON c.id = {$contactField} AND c.is_deleted = 0 AND c.is_deceased = 0 ";
933
934 if ($actionSchedule->start_action_date) {
935 $startDateClause = array();
936 $op = ($actionSchedule->start_action_condition == 'before' ? '<=' : '>=');
937 $operator = ($actionSchedule->start_action_condition == 'before' ? 'DATE_SUB' : 'DATE_ADD');
938 $date = $operator . "({$dateField}, INTERVAL {$actionSchedule->start_action_offset} {$actionSchedule->start_action_unit})";
939 $startDateClause[] = "'{$now}' >= {$date}";
940 if ($mapping->entity == 'civicrm_participant') {
941 $startDateClause[] = $operator. "({$now}, INTERVAL 1 DAY ) {$op} " . $dateField;
942 }
943 else {
944 $startDateClause[] = "DATE_SUB({$now}, INTERVAL 1 DAY ) <= {$date}";
945 }
946
947 $startDate = implode(' AND ', $startDateClause);
948 }
949 elseif ($actionSchedule->absolute_date) {
950 $startDate = "DATEDIFF(DATE('{$now}'),'{$actionSchedule->absolute_date}') = 0";
951 }
952
953 // ( now >= date_built_from_start_time ) OR ( now = absolute_date )
954 $dateClause = "reminder.id IS NULL AND {$startDate}";
955
956 // start composing query
957 $selectClause = 'SELECT ' . implode(', ', $select);
958 $fromClause = "FROM $from";
959 $joinClause = !empty($join) ? implode(' ', $join) : '';
960 $whereClause = 'WHERE ' . implode(' AND ', $where);
961 $limitWhereClause = '';
962 if (!empty($limitWhere)) {
963 $limitWhereClause = ' AND ' . implode(' AND ', $limitWhere);
964 }
965
966 $query = "
967 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
968 {$selectClause}
969 {$fromClause}
970 {$joinClause}
971 LEFT JOIN {$reminderJoinClause}
972 {$whereClause} {$limitWhereClause} AND {$dateClause} {$notINClause}
973 ";
974 CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
975
976 if ($limitTo == 0) {
977 $additionWhere = ' WHERE ';
978 if ($actionSchedule->start_action_date) {
979 $additionWhere = $whereClause . ' AND ';
980 }
981 $contactTable = "civicrm_contact c";
982 $addSelect = "SELECT c.id as contact_id, c.id as entity_id, 'civicrm_contact' as entity_table, {$actionSchedule->id} as action_schedule_id";
983 $additionReminderClause = "civicrm_action_log reminder ON reminder.contact_id = c.id AND
984 reminder.entity_id = c.id AND
985 reminder.entity_table = 'civicrm_contact' AND
986 reminder.action_schedule_id = {$actionSchedule->id}";
987
988 $insertAdditionalSql ="
989 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
990 {$addSelect}
991 FROM ({$contactTable}, {$table})
992 LEFT JOIN {$additionReminderClause}
993 {$addGroup}
994 {$additionWhere} c.is_deleted = 0 AND c.is_deceased = 0 AND {$addWhere}
995 AND {$dateClause}
996 AND c.id NOT IN (
997 SELECT rem.contact_id
998 FROM civicrm_action_log rem INNER JOIN {$mapping->entity} e ON rem.entity_id = e.id
999 WHERE rem.action_schedule_id = {$actionSchedule->id}
1000 AND rem.entity_table = '{$mapping->entity}'
1001 )
1002 GROUP BY c.id
1003 ";
1004 CRM_Core_DAO::executeQuery($insertAdditionalSql);
1005 }
1006 // if repeat is turned ON:
1007 if ($actionSchedule->is_repeat) {
1008 $repeatEvent = ($actionSchedule->end_action == 'before' ? 'DATE_SUB' : 'DATE_ADD') . "({$dateField}, INTERVAL {$actionSchedule->end_frequency_interval} {$actionSchedule->end_frequency_unit})";
1009
1010 if ($actionSchedule->repetition_frequency_unit == 'day') {
1011 $hrs = 24 * $actionSchedule->repetition_frequency_interval;
1012 }
1013 elseif ($actionSchedule->repetition_frequency_unit == 'week') {
1014 $hrs = 24 * $actionSchedule->repetition_frequency_interval * 7;
1015 }
1016 else {
1017 $hrs = $actionSchedule->repetition_frequency_interval;
1018 }
1019
1020 // (now <= repeat_end_time )
1021 $repeatEventClause = "'{$now}' <= {$repeatEvent}";
1022 // diff(now && logged_date_time) >= repeat_interval
1023 $havingClause = "HAVING TIMEDIFF({$now}, latest_log_time) >= TIME('{$hrs}:00:00')";
1024 $groupByClause = 'GROUP BY reminder.contact_id, reminder.entity_id, reminder.entity_table';
1025 $selectClause .= ', MAX(reminder.action_date_time) as latest_log_time';
1026 $sqlInsertValues = "{$selectClause}
1027 {$fromClause}
1028 {$joinClause}
1029 INNER JOIN {$reminderJoinClause}
1030 {$whereClause} {$limitWhereClause} AND {$repeatEventClause}
1031 {$groupByClause}
1032 {$havingClause}";
1033
1034 $valsqlInsertValues = CRM_Core_DAO::executeQuery($sqlInsertValues, array(1 => array($actionSchedule->id, 'Integer')));
1035
1036 $arrValues = array();
1037 while ($valsqlInsertValues->fetch()) {
1038 $arrValues[] = "( {$valsqlInsertValues->contact_id}, {$valsqlInsertValues->entity_id}, '{$valsqlInsertValues->entity_table}',{$valsqlInsertValues->action_schedule_id} )";
1039 }
1040
1041 $valString = implode(',', $arrValues);
1042
1043 if ($valString) {
1044 $query = '
1045 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1046 CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
1047 }
1048
1049 if ($limitTo == 0) {
1050 $addSelect .= ', MAX(reminder.action_date_time) as latest_log_time';
1051 $sqlEndEventCheck = "
1052 SELECT * FROM {$table}
1053 {$whereClause} AND {$repeatEventClause} LIMIT 1";
1054
1055 $daoCheck = CRM_Core_DAO::executeQuery($sqlEndEventCheck);
1056 if ($daoCheck->fetch()) {
1057 $valSqlAdditionInsert = "
1058 {$addSelect}
1059 FROM {$contactTable}
1060 {$addGroup}
1061 INNER JOIN {$additionReminderClause}
1062 WHERE {$addWhere} AND c.is_deleted = 0 AND c.is_deceased = 0
1063 GROUP BY reminder.contact_id
1064 {$havingClause}
1065 ";
1066 $daoForVals = CRM_Core_DAO::executeQuery($valSqlAdditionInsert);
1067 $addValues = array();
1068 while ($daoForVals->fetch()) {
1069 $addValues[] = "( {$daoForVals->contact_id}, {$daoForVals->entity_id}, '{$daoForVals->entity_table}',{$daoForVals->action_schedule_id} )";
1070 }
1071 $valString = implode(',', $addValues);
1072
1073 if ($valString) {
1074 $query = '
1075 INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
1076 CRM_Core_DAO::executeQuery($query);
1077 }
1078 }
1079 }
1080 }
1081 }
1082 }
1083
1084 static function permissionedRelationships($field) {
1085 $query = '
1086 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
1087 FROM civicrm_membership m
1088 LEFT JOIN civicrm_membership cm ON cm.id = m.owner_membership_id
1089 LEFT JOIN civicrm_membership_type cmt ON cmt.id = m.membership_type_id
1090 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 )
1091 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 ) )
1092 WHERE m.owner_membership_id IS NOT NULL AND
1093 ( rel.is_permission_a_b = 0 OR rel.is_permission_b_a = 0)
1094
1095 ';
1096 $excludeIds = array();
1097 $dao = CRM_Core_DAO::executeQuery($query, array());
1098 while ($dao->fetch()) {
1099 if ($dao->slave_contact == $dao->contact_id_a && $dao->is_permission_b_a == 0) {
1100 $excludeIds[] = $dao->slave_contact;
1101 }
1102 elseif ($dao->slave_contact == $dao->contact_id_b && $dao->is_permission_a_b == 0) {
1103 $excludeIds[] = $dao->slave_contact;
1104 }
1105 }
1106
1107 if (!empty($excludeIds)) {
1108 $clause = "AND {$field} NOT IN ( " .implode(', ', $excludeIds) . ' ) ';
1109 return $clause;
1110 }
1111 return NULL;
1112 }
1113
1114 static function processQueue($now = NULL) {
1115 $now = $now ? CRM_Utils_Time::setTime($now) : CRM_Utils_Time::getTime();
1116
1117 $mappings = self::getMapping();
1118 foreach ($mappings as $mappingID => $mapping) {
1119 self::buildRecipientContacts($mappingID, $now);
1120 self::sendMailings($mappingID, $now);
1121 }
1122
1123 $result = array(
1124 'is_error' => 0,
1125 'messages' => ts('Sent all scheduled reminders successfully'),
1126 );
1127 return $result;
1128 }
1129
1130 static function isConfigured($id, $mappingID) {
1131 $queryString = "SELECT count(id) FROM civicrm_action_schedule
1132 WHERE mapping_id = %1 AND
1133 entity_value = %2";
1134
1135 $params = array(
1136 1 => array($mappingID, 'Integer'),
1137 2 => array($id, 'Integer'),
1138 );
1139 return CRM_Core_DAO::singleValueQuery($queryString, $params);
1140 }
1141
1142 static function getRecipientListing($mappingID, $recipientType) {
1143 $options = array();
1144 if (!$mappingID || !$recipientType) {
1145 return $options;
1146 }
1147
1148 $mapping = self::getMapping($mappingID);
1149
1150 switch ($mapping['entity']) {
1151 case 'civicrm_participant':
1152 $eventContacts = CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1153 if (!CRM_Utils_Array::value($recipientType, $eventContacts)) {
1154 return $options;
1155 }
1156 if ($eventContacts[$recipientType] == 'participant_role') {
1157 $options = CRM_Event_PseudoConstant::participantRole();
1158 }
1159 break;
1160 }
1161
1162 return $options;
1163 }
1164 }
1165