CRM/Admin/Form/ScheduleReminders.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright (C) 2011 Marty Wright                                    |
   7  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  * This class generates form components for Scheduling Reminders
  39  *
  40  */
  41 class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form {
  42
  43   /**
  44    * Scheduled Reminder ID
  45    */
  46   protected $_id = NULL;
  47
  48   public $_freqUnits;
  49
  50   /**
  51    * Function to build the form
  52    *
  53    * @return void
  54    * @access public
  55    */
  56   public function buildQuickForm() {
  57     parent::buildQuickForm();
  58     $this->_mappingID = $mappingID = NULL;
  59     $providersCount = CRM_SMS_BAO_Provider::activeProviderCount();
  60
  61     if ($this->_action & (CRM_Core_Action::DELETE)) {
  62       $reminderName =
  63         CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id, 'title');
  64       $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
  65       if ($this->_context == 'event') {
  66         $this->_eventId = CRM_Utils_Request::retrieve('eventId', 'Integer', $this);
  67       }
  68       $this->assign('reminderName', $reminderName);
  69       return;
  70     }
  71     elseif ($this->_action & (CRM_Core_Action::UPDATE)) {
  72       $this->_mappingID =
  73         CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id, 'mapping_id');
  74       $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
  75       if ($this->_context == 'event') {
  76         $this->_eventId = CRM_Utils_Request::retrieve('eventId', 'Integer', $this);
  77       }
  78     }
  79
  80     if (!empty($_POST) && !empty($_POST['entity'])) {
  81       $mappingID = $_POST['entity'][0];
  82     }
  83     elseif ($this->_mappingID) {
  84       $mappingID = $this->_mappingID;
  85     }
  86
  87     $this->add(
  88       'text',
  89       'title',
  90       ts('Title'),
  91       array('size' => 45, 'maxlength' => 128),
  92       TRUE
  93     );
  94
  95     $selectionOptions = CRM_Core_BAO_ActionSchedule::getSelection($mappingID);
  96     extract($selectionOptions);
  97
  98     if (empty($sel1)) {
  99       CRM_Core_Error::fatal('Could not find mapping for scheduled reminders.');
 100     }
 101     $this->assign('entityMapping', json_encode($entityMapping));
 102     $this->assign('recipientMapping', json_encode($recipientMapping));
 103
 104     $sel = & $this->add(
 105       'hierselect',
 106       'entity',
 107       ts('Entity'),
 108       array(
 109         'name' => 'entity[0]',
 110         'style' => 'vertical-align: top;',
 111       ),
 112       TRUE
 113     );
 114     $sel->setOptions(array($sel1, $sel2, $sel3));
 115
 116     if (is_a($sel->_elements[1], 'HTML_QuickForm_select')) {
 117       // make second selector a multi-select -
 118       $sel->_elements[1]->setMultiple(TRUE);
 119       $sel->_elements[1]->setSize(5);
 120     }
 121
 122     if (is_a($sel->_elements[2], 'HTML_QuickForm_select')) {
 123       // make third selector a multi-select -
 124       $sel->_elements[2]->setMultiple(TRUE);
 125       $sel->_elements[2]->setSize(5);
 126     }
 127
 128     //get the frequency units.
 129     $this->_freqUnits = CRM_Core_SelectValues::getScheduleReminderFrequencyUnits();
 130
 131     //pass the mapping ID in UPDATE mode
 132     $mappings = CRM_Core_BAO_ActionSchedule::getMapping($mappingID);
 133
 134     $numericOptions = CRM_Core_SelectValues::getNumericOptions(0, 30);
 135
 136     //reminder_interval
 137     $this->add('select', 'start_action_offset', ts('When'), $numericOptions);
 138     $title = ts('Email');
 139     $isActive = ts('Send email');
 140     $recordActivity = ts('Record activity for automated email');
 141     if ($providersCount) {
 142       $this->assign('sms', $providersCount);
 143       $title = ts('Email or SMS');
 144       $isActive = ts('Send email or SMS');
 145       $recordActivity = ts('Record activity for automated email or SMS');
 146       $options = CRM_Core_OptionGroup::values('msg_mode');
 147       $this->add('select', 'mode', ts('Send as'), $options);
 148
 149       $providers = CRM_SMS_BAO_Provider::getProviders(NULL, NULL, TRUE, 'is_default desc');
 150
 151       $providerSelect = array();
 152       foreach ($providers as $provider) {
 153         $providerSelect[$provider['id']] = $provider['title'];
 154       }
 155       $this->add('select', 'sms_provider_id', ts('From'), $providerSelect, TRUE);
 156     }
 157
 158     $this->assign('title', $title);
 159     foreach ($this->_freqUnits as $val => $label) {
 160       $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
 161     }
 162
 163     $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing'));
 164
 165     //reminder_frequency
 166     $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE);
 167
 168     $condition = array('before' => ts('before'),
 169       'after' => ts('after'),
 170     );
 171     //reminder_action
 172     $this->add('select', 'start_action_condition', ts('Action Condition'), $condition);
 173
 174     $this->add('select', 'start_action_date', ts('Date Field'), $sel4, TRUE);
 175
 176     $this->addElement('checkbox', 'record_activity', $recordActivity);
 177
 178     $this->addElement('checkbox', 'is_repeat', ts('Repeat'),
 179       NULL, array('onclick' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);")
 180     );
 181
 182     $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay);
 183     $this->add('select', 'repetition_frequency_interval', ts('every'), $numericOptions);
 184     $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay);
 185     $this->add('select', 'end_frequency_interval', ts('until'), $numericOptions);
 186     $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE);
 187     $this->add('select', 'end_date', ts('Date Field'), $sel4, TRUE);
 188
 189     $recipient = 'activity_contacts';
 190     $recipientListingOptions = array();
 191
 192     if ($mappingID) {
 193       $recipient = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionMapping',
 194         $mappingID,
 195         'entity_recipient'
 196       );
 197     }
 198
 199     $limitOptions = array(1 => ts('Limit to'), 0 => ts('Addition to'));
 200     $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions);
 201
 202     $this->add('select', 'recipient', ts('Recipients'), $sel5[$recipient],
 203       FALSE, array('onClick' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);")
 204     );
 205
 206     if (!empty($_POST['is_recipient_listing'])) {
 207       $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($_POST['entity'][0], $_POST['recipient']);
 208     }
 209     elseif (!empty($this->_values['recipient_listing'])) {
 210       $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($this->_values['mapping_id'], $this->_values['recipient']);
 211     }
 212     $recipientListing = $this->add('select', 'recipient_listing', ts('Recipient Listing'), $recipientListingOptions);
 213     $recipientListing->setMultiple(TRUE);
 214     $this->add('hidden', 'is_recipient_listing', empty($recipientListingOptions) ? FALSE : TRUE, array('id' => 'is_recipient_listing'));
 215
 216     $this->addEntityRef('recipient_manual_id', ts('Manual Recipients'), array('multiple' => TRUE, 'create' => TRUE));
 217
 218     $this->addElement(
 219       'select',
 220       'group_id',
 221       ts('Group'),
 222       // CRM-13577
 223       CRM_Core_PseudoConstant::group()
 224     );
 225
 226     CRM_Mailing_BAO_Mailing::commonCompose($this);
 227
 228     $this->add('text', 'subject', ts('Subject'),
 229       CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject')
 230     );
 231
 232     $this->add('checkbox', 'is_active', $isActive);
 233
 234     $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'));
 235   }
 236   /**
 237    * global form rule
 238    *
 239    * @param array $fields  the input form values
 240    *
 241    * @return true if no errors, else array of errors
 242    * @access public
 243    * @static
 244    */
 245   static function formRule($fields) {
 246     $errors = array();
 247     if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] === 0) ||
 248       (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0)
 249     ) {
 250       $errors['entity'] = ts('Please select appropriate value');
 251     }
 252
 253     if (array_key_exists(1, $fields['entity']) && !is_numeric($fields['entity'][1][0])) {
 254       if (count($fields['entity'][1]) > 1) {
 255         $errors['entity'] = ts('You may only select one contact field per reminder');
 256       }
 257       elseif (!(array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] > 0)) {
 258         $errors['entity'] = ts('Please select whether the reminder is sent each year.');
 259       }
 260     }
 261
 262     if (!empty($fields['is_active']) &&
 263       CRM_Utils_System::isNull($fields['subject'])
 264     ) {
 265       $errors['subject'] = ts('Subject is a required field.');
 266     }
 267
 268     if (CRM_Utils_System::isNull(CRM_Utils_Array::value(1, $fields['entity']))) {
 269       $errors['entity'] = ts('Please select entity value');
 270     }
 271
 272     if (!CRM_Utils_System::isNull($fields['absolute_date'])) {
 273       if (CRM_Utils_Date::format(CRM_Utils_Date::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date::format(date('Ymd'))) {
 274         $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.');
 275       }
 276     }
 277
 278     if (!empty($errors)) {
 279       return $errors;
 280     }
 281
 282     return empty($errors) ? TRUE : $errors;
 283   }
 284
 285   /**
 286    * @return int
 287    */
 288   function setDefaultValues() {
 289     if ($this->_action & CRM_Core_Action::ADD) {
 290       $defaults['is_active'] = 1;
 291       $defaults['mode'] = 'Email';
 292       $defaults['record_activity'] = 1;
 293     }
 294     else {
 295       $defaults = $this->_values;
 296       $entityValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 297         CRM_Utils_Array::value('entity_value', $defaults)
 298       );
 299       $entityStatus = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 300         CRM_Utils_Array::value('entity_status', $defaults)
 301       );
 302       $defaults['entity'][0] = CRM_Utils_Array::value('mapping_id', $defaults);
 303       $defaults['entity'][1] = $entityValue;
 304       $defaults['entity'][2] = $entityStatus;
 305       if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $defaults)) {
 306         list($date, $time) = CRM_Utils_Date::setDateDefaults($absoluteDate);
 307         $defaults['absolute_date'] = $date;
 308       }
 309
 310       if ($recipientListing = CRM_Utils_Array::value('recipient_listing', $defaults)) {
 311         $defaults['recipient_listing'] = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 312           $recipientListing
 313         );
 314       }
 315       $defaults['text_message'] = CRM_Utils_Array::value('body_text', $defaults);
 316       $defaults['html_message'] = CRM_Utils_Array::value('body_html', $defaults);
 317       $defaults['template'] = CRM_Utils_Array::value('msg_template_id', $defaults);
 318       if (!empty($defaults['group_id'])) {
 319         $defaults['recipient'] = 'group';
 320       }
 321       elseif (!empty($defaults['recipient_manual'])) {
 322         $defaults['recipient'] = 'manual';
 323         $defaults['recipient_manual_id'] = $defaults['recipient_manual'];
 324       }
 325     }
 326
 327     return $defaults;
 328   }
 329
 330   /**
 331    * Function to process the form
 332    *
 333    * @access public
 334    *
 335    * @return void
 336    */
 337   public function postProcess() {
 338     if ($this->_action & CRM_Core_Action::DELETE) {
 339       // delete reminder
 340       CRM_Core_BAO_ActionSchedule::del($this->_id);
 341       CRM_Core_Session::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success');
 342       if ($this->_context == 'event' && $this->_eventId) {
 343         $url = CRM_Utils_System::url('civicrm/event/manage/reminder',
 344           "reset=1&action=update&id={$this->_eventId}"
 345         );
 346         $session = CRM_Core_Session::singleton();
 347         $session->pushUserContext($url);
 348       }
 349       return;
 350     }
 351     $values = $this->controller->exportValues($this->getName());
 352
 353     $keys = array(
 354       'title',
 355       'subject',
 356       'absolute_date',
 357       'group_id',
 358       'record_activity',
 359       'limit_to',
 360       'mode',
 361       'sms_provider_id'
 362     );
 363     foreach ($keys as $key) {
 364       $params[$key] = CRM_Utils_Array::value($key, $values);
 365     }
 366
 367     $moreKeys = array(
 368       'start_action_offset',
 369       'start_action_unit',
 370       'start_action_condition',
 371       'start_action_date',
 372       'repetition_frequency_unit',
 373       'repetition_frequency_interval',
 374       'end_frequency_unit',
 375       'end_frequency_interval',
 376       'end_action',
 377       'end_date',
 378     );
 379
 380     if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $params)) {
 381       $params['absolute_date'] = CRM_Utils_Date::processDate($absoluteDate);
 382       foreach ($moreKeys as $mkey) {
 383         $params[$mkey] = 'null';
 384       }
 385     }
 386     else {
 387       $params['absolute_date'] = 'null';
 388       foreach ($moreKeys as $mkey) {
 389         $params[$mkey] = CRM_Utils_Array::value($mkey, $values);
 390       }
 391     }
 392
 393     $params['body_text'] = CRM_Utils_Array::value('text_message', $values);
 394     $params['body_html'] = CRM_Utils_Array::value('html_message', $values);
 395
 396     if (CRM_Utils_Array::value('recipient', $values) == 'manual') {
 397       $params['recipient_manual'] = CRM_Utils_Array::value('recipient_manual_id', $values);
 398       $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null';
 399     }
 400     elseif (CRM_Utils_Array::value('recipient', $values) == 'group') {
 401       $params['group_id'] = $values['group_id'];
 402       $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null';
 403     }
 404     elseif (!CRM_Utils_System::isNull($values['recipient_listing'])) {
 405       $params['recipient'] = CRM_Utils_Array::value('recipient', $values);
 406       $params['recipient_listing'] = implode(CRM_Core_DAO::VALUE_SEPARATOR,
 407         CRM_Utils_Array::value('recipient_listing', $values)
 408       );
 409       $params['group_id'] = $params['recipient_manual'] = 'null';
 410     }
 411     else {
 412       $params['recipient'] = CRM_Utils_Array::value('recipient', $values);
 413       $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null';
 414     }
 415
 416     $params['mapping_id'] = $values['entity'][0];
 417     $entity_value = $values['entity'][1];
 418     $entity_status = $values['entity'][2];
 419
 420     foreach (array(
 421       'entity_value', 'entity_status') as $key) {
 422       $params[$key] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $$key);
 423     }
 424
 425     $params['is_active'] = CRM_Utils_Array::value('is_active', $values, 0);
 426     $params['is_repeat'] = CRM_Utils_Array::value('is_repeat', $values, 0);
 427
 428     if (CRM_Utils_Array::value('is_repeat', $values) == 0) {
 429       $params['repetition_frequency_unit'] = 'null';
 430       $params['repetition_frequency_interval'] = 'null';
 431       $params['end_frequency_unit'] = 'null';
 432       $params['end_frequency_interval'] = 'null';
 433       $params['end_action'] = 'null';
 434       $params['end_date'] = 'null';
 435     }
 436
 437     if ($this->_action & CRM_Core_Action::UPDATE) {
 438       $params['id'] = $this->_id;
 439     }
 440     elseif ($this->_action & CRM_Core_Action::ADD) {
 441       // we do this only once, so name never changes
 442       $params['name'] = CRM_Utils_String::munge($params['title'], '_', 64);
 443     }
 444
 445     $composeFields = array(
 446       'template', 'saveTemplate',
 447       'updateTemplate', 'saveTemplateName',
 448     );
 449     $msgTemplate = NULL;
 450     //mail template is composed
 451
 452     $composeParams = array();
 453     foreach ($composeFields as $key) {
 454       if (!empty($values[$key])) {
 455         $composeParams[$key] = $values[$key];
 456       }
 457     }
 458
 459     if (!empty($composeParams['updateTemplate'])) {
 460       $templateParams = array(
 461         'msg_text' => $params['body_text'],
 462         'msg_html' => $params['body_html'],
 463         'msg_subject' => $params['subject'],
 464         'is_active' => TRUE,
 465       );
 466
 467       $templateParams['id'] = $values['template'];
 468
 469       $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
 470     }
 471
 472     if (!empty($composeParams['saveTemplate'])) {
 473       $templateParams = array(
 474         'msg_text' => $params['body_text'],
 475         'msg_html' => $params['body_html'],
 476         'msg_subject' => $params['subject'],
 477         'is_active' => TRUE,
 478       );
 479
 480       $templateParams['msg_title'] = $composeParams['saveTemplateName'];
 481
 482       $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
 483     }
 484
 485     if (isset($msgTemplate->id)) {
 486       $params['msg_template_id'] = $msgTemplate->id;
 487     }
 488     else {
 489       $params['msg_template_id'] = CRM_Utils_Array::value('template', $values);
 490     }
 491
 492     $bao = CRM_Core_BAO_ActionSchedule::add($params);
 493     // we need to set this on the form so that hooks can identify the created entity
 494     $this->set('id', $bao->id);
 495     $bao->free();
 496
 497     $status = ts("Your new Reminder titled %1 has been saved.",
 498       array(1 => "<strong>{$values['title']}</strong>")
 499     );
 500     if ($this->_action & CRM_Core_Action::UPDATE) {
 501       $status = ts("Your Reminder titled %1 has been updated.",
 502         array(1 => "<strong>{$values['title']}</strong>")
 503       );
 504
 505       if ($this->_context == 'event' && $this->_eventId) {
 506         $url = CRM_Utils_System::url('civicrm/event/manage/reminder',
 507           "reset=1&action=update&id={$this->_eventId}"
 508         );
 509         $session = CRM_Core_Session::singleton();
 510         $session->pushUserContext($url);
 511       }
 512     }
 513     CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
 514   }
 515 }
 516