CRM/Admin/Form/ScheduleReminders.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 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 = array('hour' => 'hour') + CRM_Core_OptionGroup::values('recur_frequency_units');
 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       $title = ts('Email or SMS');
 143       $isActive = ts('Send email or SMS');
 144       $recordActivity = ts('Record activity for automated email or SMS');
 145       $options = CRM_Core_OptionGroup::values('msg_mode');
 146       $this->add('select', 'mode', ts('Send as'), $options);
 147
 148       $providers = CRM_SMS_BAO_Provider::getProviders(NULL, NULL, TRUE, 'is_default desc');
 149
 150       $providerSelect = array();
 151       foreach ($providers as $provider) {
 152         $providerSelect[$provider['id']] = $provider['title'];
 153       }
 154       $this->add('select', 'sms_provider_id', ts('From'), $providerSelect, TRUE);
 155     }
 156
 157     $this->assign('title', $title);
 158     foreach ($this->_freqUnits as $val => $label) {
 159       $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
 160     }
 161
 162     $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing'));
 163
 164     //reminder_frequency
 165     $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE);
 166
 167     $condition = array('before' => ts('before'),
 168       'after' => ts('after'),
 169     );
 170     //reminder_action
 171     $this->add('select', 'start_action_condition', ts('Action Condition'), $condition);
 172
 173     $this->add('select', 'start_action_date', ts('Date Field'), $sel4, TRUE);
 174
 175     $this->addElement('checkbox', 'record_activity', $recordActivity);
 176
 177     $this->addElement('checkbox', 'is_repeat', ts('Repeat'),
 178       NULL, array('onclick' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);")
 179     );
 180
 181     $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay);
 182     $this->add('select', 'repetition_frequency_interval', ts('every'), $numericOptions);
 183     $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay);
 184     $this->add('select', 'end_frequency_interval', ts('until'), $numericOptions);
 185     $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE);
 186     $this->add('select', 'end_date', ts('Date Field'), $sel4, TRUE);
 187
 188     $recipient = 'activity_contacts';
 189     $recipientListingOptions = array();
 190
 191     if ($mappingID) {
 192       $recipient = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionMapping',
 193         $mappingID,
 194         'entity_recipient'
 195       );
 196     }
 197
 198     $limitOptions = array(1 => ts('Limit to'), 0 => ts('Addition to'));
 199     $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions);
 200
 201     $this->add('select', 'recipient', ts('Recipients'), $sel5[$recipient],
 202       FALSE, array('onClick' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);")
 203     );
 204
 205     if (!empty($_POST['is_recipient_listing'])) {
 206       $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($_POST['entity'][0], $_POST['recipient']);
 207     }
 208     elseif (!empty($this->_values['recipient_listing'])) {
 209       $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($this->_values['mapping_id'], $this->_values['recipient']);
 210     }
 211     $recipientListing = $this->add('select', 'recipient_listing', ts('Recipient Listing'), $recipientListingOptions);
 212     $recipientListing->setMultiple(TRUE);
 213     $this->add('hidden', 'is_recipient_listing', empty($recipientListingOptions) ? FALSE : TRUE, array('id' => 'is_recipient_listing'));
 214
 215     //auto-complete url
 216     $dataUrl = CRM_Utils_System::url('civicrm/ajax/rest',
 217       'className=CRM_Contact_Page_AJAX&fnName=getContactList&json=1&context=activity&reset=1',
 218       FALSE, NULL, FALSE
 219     );
 220
 221     $this->assign('dataUrl', $dataUrl);
 222     //token input url
 223     $tokenUrl = CRM_Utils_System::url('civicrm/ajax/checkemail',
 224       'noemail=1',
 225       FALSE, NULL, FALSE
 226     );
 227     $this->assign('tokenUrl', $tokenUrl);
 228     $this->add('text', 'recipient_manual_id', ts('Manual Recipients'));
 229
 230     $this->addElement(
 231       'select',
 232       'group_id',
 233       ts('Group'),
 234       // CRM-13577
 235       CRM_Core_PseudoConstant::group()
 236     );
 237
 238     CRM_Mailing_BAO_Mailing::commonCompose($this);
 239
 240     $this->add('text', 'subject', ts('Subject'),
 241       CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject')
 242     );
 243
 244     $this->add('checkbox', 'is_active', $isActive);
 245
 246     $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'));
 247   }
 248   /**
 249    * global form rule
 250    *
 251    * @param array $fields  the input form values
 252    *
 253    * @return true if no errors, else array of errors
 254    * @access public
 255    * @static
 256    */
 257   static function formRule($fields) {
 258     $errors = array();
 259     if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] == 0) ||
 260       (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0)
 261     ) {
 262       $errors['entity'] = ts('Please select appropriate value');
 263     }
 264
 265     if (!empty($fields['is_active']) &&
 266       CRM_Utils_System::isNull($fields['subject'])
 267     ) {
 268       $errors['subject'] = ts('Subject is a required field.');
 269     }
 270
 271     if (CRM_Utils_System::isNull(CRM_Utils_Array::value(1, $fields['entity']))) {
 272       $errors['entity'] = ts('Please select entity value');
 273     }
 274
 275     if (!CRM_Utils_System::isNull($fields['absolute_date'])) {
 276       if (CRM_Utils_Date::format(CRM_Utils_Date::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date::format(date('YmdHi00'))) {
 277         $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.');
 278       }
 279     }
 280
 281     if (!empty($errors)) {
 282       return $errors;
 283     }
 284
 285     return empty($errors) ? TRUE : $errors;
 286   }
 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         $recipients = array();
 324         foreach (explode(',', $defaults['recipient_manual']) as $cid) {
 325           $recipients[$cid] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 326             $cid,
 327             'sort_name'
 328           );
 329         }
 330         $this->assign('recipients', $recipients);
 331       }
 332     }
 333
 334     return $defaults;
 335   }
 336
 337   /**
 338    * Function to process the form
 339    *
 340    * @access public
 341    *
 342    * @return void
 343    */
 344   public function postProcess() {
 345     if ($this->_action & CRM_Core_Action::DELETE) {
 346       // delete reminder
 347       CRM_Core_BAO_ActionSchedule::del($this->_id);
 348       CRM_Core_Session::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success');
 349       if ($this->_context == 'event' && $this->_eventId) {
 350         $url = CRM_Utils_System::url('civicrm/event/manage/reminder',
 351           "reset=1&action=update&id={$this->_eventId}"
 352         );
 353         $session = CRM_Core_Session::singleton();
 354         $session->pushUserContext($url);
 355       }
 356       return;
 357     }
 358     $values = $this->controller->exportValues($this->getName());
 359
 360     $keys = array(
 361       'title',
 362       'subject',
 363       'absolute_date',
 364       'group_id',
 365       'record_activity',
 366       'limit_to',
 367       'mode',
 368       'sms_provider_id'
 369     );
 370     foreach ($keys as $key) {
 371       $params[$key] = CRM_Utils_Array::value($key, $values);
 372     }
 373
 374     $moreKeys = array(
 375       'start_action_offset',
 376       'start_action_unit',
 377       'start_action_condition',
 378       'start_action_date',
 379       'repetition_frequency_unit',
 380       'repetition_frequency_interval',
 381       'end_frequency_unit',
 382       'end_frequency_interval',
 383       'end_action',
 384       'end_date',
 385     );
 386
 387     if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $params)) {
 388       $params['absolute_date'] = CRM_Utils_Date::processDate($absoluteDate);
 389       foreach ($moreKeys as $mkey) {
 390         $params[$mkey] = 'null';
 391       }
 392     }
 393     else {
 394       $params['absolute_date'] = 'null';
 395       foreach ($moreKeys as $mkey) {
 396         $params[$mkey] = CRM_Utils_Array::value($mkey, $values);
 397       }
 398     }
 399
 400     $params['body_text'] = CRM_Utils_Array::value('text_message', $values);
 401     $params['body_html'] = CRM_Utils_Array::value('html_message', $values);
 402
 403     if (CRM_Utils_Array::value('recipient', $values) == 'manual') {
 404       $params['recipient_manual'] = CRM_Utils_Array::value('recipient_manual_id', $values);
 405       $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null';
 406     }
 407     elseif (CRM_Utils_Array::value('recipient', $values) == 'group') {
 408       $params['group_id'] = $values['group_id'];
 409       $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null';
 410     }
 411     elseif (!CRM_Utils_System::isNull($values['recipient_listing'])) {
 412       $params['recipient'] = CRM_Utils_Array::value('recipient', $values);
 413       $params['recipient_listing'] = implode(CRM_Core_DAO::VALUE_SEPARATOR,
 414         CRM_Utils_Array::value('recipient_listing', $values)
 415       );
 416       $params['group_id'] = $params['recipient_manual'] = 'null';
 417     }
 418     else {
 419       $params['recipient'] = CRM_Utils_Array::value('recipient', $values);
 420       $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null';
 421     }
 422
 423     $params['mapping_id'] = $values['entity'][0];
 424     $entity_value = $values['entity'][1];
 425     $entity_status = $values['entity'][2];
 426
 427     foreach (array(
 428       'entity_value', 'entity_status') as $key) {
 429       $params[$key] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $$key);
 430     }
 431
 432     $params['is_active'] = CRM_Utils_Array::value('is_active', $values, 0);
 433     $params['is_repeat'] = CRM_Utils_Array::value('is_repeat', $values, 0);
 434
 435     if (CRM_Utils_Array::value('is_repeat', $values) == 0) {
 436       $params['repetition_frequency_unit'] = 'null';
 437       $params['repetition_frequency_interval'] = 'null';
 438       $params['end_frequency_unit'] = 'null';
 439       $params['end_frequency_interval'] = 'null';
 440       $params['end_action'] = 'null';
 441       $params['end_date'] = 'null';
 442     }
 443
 444     if ($this->_action & CRM_Core_Action::UPDATE) {
 445       $params['id'] = $this->_id;
 446     }
 447     elseif ($this->_action & CRM_Core_Action::ADD) {
 448       // we do this only once, so name never changes
 449       $params['name'] = CRM_Utils_String::munge($params['title'], '_', 64);
 450     }
 451
 452     $composeFields = array(
 453       'template', 'saveTemplate',
 454       'updateTemplate', 'saveTemplateName',
 455     );
 456     $msgTemplate = NULL;
 457     //mail template is composed
 458
 459     $composeParams = array();
 460     foreach ($composeFields as $key) {
 461       if (!empty($values[$key])) {
 462         $composeParams[$key] = $values[$key];
 463       }
 464     }
 465
 466     if (!empty($composeParams['updateTemplate'])) {
 467       $templateParams = array(
 468         'msg_text' => $params['body_text'],
 469         'msg_html' => $params['body_html'],
 470         'msg_subject' => $params['subject'],
 471         'is_active' => TRUE,
 472       );
 473
 474       $templateParams['id'] = $values['template'];
 475
 476       $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
 477     }
 478
 479     if (!empty($composeParams['saveTemplate'])) {
 480       $templateParams = array(
 481         'msg_text' => $params['body_text'],
 482         'msg_html' => $params['body_html'],
 483         'msg_subject' => $params['subject'],
 484         'is_active' => TRUE,
 485       );
 486
 487       $templateParams['msg_title'] = $composeParams['saveTemplateName'];
 488
 489       $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
 490     }
 491
 492     if (isset($msgTemplate->id)) {
 493       $params['msg_template_id'] = $msgTemplate->id;
 494     }
 495     else {
 496       $params['msg_template_id'] = CRM_Utils_Array::value('template', $values);
 497     }
 498
 499     $bao = CRM_Core_BAO_ActionSchedule::add($params);
 500     // we need to set this on the form so that hooks can identify the created entity
 501     $this->set('id', $bao->id);
 502     $bao->free();
 503
 504     $status = ts("Your new Reminder titled %1 has been saved.",
 505       array(1 => "<strong>{$values['title']}</strong>")
 506     );
 507     if ($this->_action & CRM_Core_Action::UPDATE) {
 508       $status = ts("Your Reminder titled %1 has been updated.",
 509         array(1 => "<strong>{$values['title']}</strong>")
 510       );
 511
 512       if ($this->_context == 'event' && $this->_eventId) {
 513         $url = CRM_Utils_System::url('civicrm/event/manage/reminder',
 514           "reset=1&action=update&id={$this->_eventId}"
 515         );
 516         $session = CRM_Core_Session::singleton();
 517         $session->pushUserContext($url);
 518       }
 519     }
 520     CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
 521   }
 522 }
 523