CRM/Admin/Form/ScheduleReminders.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 /**
  35  * This class generates form components for Scheduling Reminders.
  36  */
  37 class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form {
  38
  39   /**
  40    * Scheduled Reminder ID.
  41    */
  42   protected $_id = NULL;
  43
  44   public $_freqUnits;
  45
  46   /**
  47    * Build the form object.
  48    */
  49   public function buildQuickForm() {
  50     parent::buildQuickForm();
  51     $this->_mappingID = $mappingID = NULL;
  52     $providersCount = CRM_SMS_BAO_Provider::activeProviderCount();
  53     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
  54
  55     //CRM-16777: Don't provide access to administer schedule reminder page, with user that does not have 'administer CiviCRM' permission
  56     if (empty($this->_context) && !CRM_Core_Permission::check('administer CiviCRM')) {
  57       CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
  58     }
  59     //CRM-16777: When user have ACLs 'edit' permission for specific event, do not give access to add, delete & updtae
  60     //schedule reminder for other events.
  61     else {
  62       $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this);
  63       if (!CRM_Event_BAO_Event::checkPermission($this->_compId, CRM_Core_Permission::EDIT)) {
  64         CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
  65       }
  66     }
  67
  68     if ($this->_action & (CRM_Core_Action::DELETE)) {
  69       $reminderName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id, 'title');
  70       if ($this->_context == 'event') {
  71         $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this);
  72       }
  73       $this->assign('reminderName', $reminderName);
  74       return;
  75     }
  76     elseif ($this->_action & (CRM_Core_Action::UPDATE)) {
  77       $this->_mappingID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id, 'mapping_id');
  78       if ($this->_context == 'event') {
  79         $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this);
  80       }
  81     }
  82     elseif (!empty($this->_context)) {
  83       if ($this->_context == 'event') {
  84         $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this);
  85         $isTemplate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_compId, 'is_template');
  86         $mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings(array(
  87           'id' => $isTemplate ? CRM_Event_ActionMapping::EVENT_TPL_MAPPING_ID : CRM_Event_ActionMapping::EVENT_NAME_MAPPING_ID,
  88         )));
  89         if ($mapping) {
  90           $this->_mappingID = $mapping->getId();
  91         }
  92         else {
  93           CRM_Core_Error::fatal('Could not find mapping for event scheduled reminders.');
  94         }
  95       }
  96     }
  97
  98     if (!empty($_POST) && !empty($_POST['entity']) && empty($this->_context)) {
  99       $mappingID = $_POST['entity'][0];
 100     }
 101     elseif ($this->_mappingID) {
 102       $mappingID = $this->_mappingID;
 103       if ($this->_context == 'event') {
 104         $this->add('hidden', 'mappingID', $mappingID);
 105       }
 106     }
 107
 108     $this->add(
 109       'text',
 110       'title',
 111       ts('Title'),
 112       CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionSchedule', 'title'),
 113       TRUE
 114     );
 115
 116     $mappings = CRM_Core_BAO_ActionSchedule::getMappings();
 117     $selectedMapping = $mappings[$mappingID ? $mappingID : 1];
 118     $entityRecipientLabels = $selectedMapping->getRecipientTypes() + CRM_Core_BAO_ActionSchedule::getAdditionalRecipients();
 119     $this->assign('entityMapping', json_encode(
 120       CRM_Utils_Array::collectMethod('getEntity', $mappings)
 121     ));
 122     $this->assign('recipientMapping', json_encode(
 123       array_combine(array_keys($entityRecipientLabels), array_keys($entityRecipientLabels))
 124     ));
 125
 126     if (empty($this->_context)) {
 127       $sel = &$this->add(
 128         'hierselect',
 129         'entity',
 130         ts('Entity'),
 131         array(
 132           'name' => 'entity[0]',
 133           'style' => 'vertical-align: top;',
 134         )
 135       );
 136       $sel->setOptions(array(
 137         CRM_Utils_Array::collectMethod('getLabel', $mappings),
 138         CRM_Core_BAO_ActionSchedule::getAllEntityValueLabels(),
 139         CRM_Core_BAO_ActionSchedule::getAllEntityStatusLabels(),
 140       ));
 141
 142       if (is_a($sel->_elements[1], 'HTML_QuickForm_select')) {
 143         // make second selector a multi-select -
 144         $sel->_elements[1]->setMultiple(TRUE);
 145         $sel->_elements[1]->setSize(5);
 146       }
 147
 148       if (is_a($sel->_elements[2], 'HTML_QuickForm_select')) {
 149         // make third selector a multi-select -
 150         $sel->_elements[2]->setMultiple(TRUE);
 151         $sel->_elements[2]->setSize(5);
 152       }
 153     }
 154     else {
 155       // Dig deeper - this code is sublimely stupid.
 156       $allEntityStatusLabels = CRM_Core_BAO_ActionSchedule::getAllEntityStatusLabels();
 157       $options = $allEntityStatusLabels[$this->_mappingID][0];
 158       $attributes = array('multiple' => 'multiple', 'class' => 'crm-select2 huge', 'placeholder' => $options[0]);
 159       unset($options[0]);
 160       $this->add('select', 'entity', ts('Recipient(s)'), $options, TRUE, $attributes);
 161       $this->assign('context', $this->_context);
 162     }
 163
 164     //get the frequency units.
 165     $this->_freqUnits = CRM_Core_SelectValues::getRecurringFrequencyUnits();
 166
 167     //reminder_interval
 168     $this->add('number', 'start_action_offset', ts('When'), array('class' => 'six', 'min' => 0));
 169     $this->addRule('start_action_offset', ts('Value should be a positive number'), 'positiveInteger');
 170
 171     $isActive = ts('Scheduled Reminder Active');
 172     $recordActivity = ts('Record activity for automated email');
 173     if ($providersCount) {
 174       $this->assign('sms', $providersCount);
 175       $recordActivity = ts('Record activity for automated email or SMS');
 176       $options = CRM_Core_OptionGroup::values('msg_mode');
 177       $this->add('select', 'mode', ts('Send as'), $options);
 178
 179       $providers = CRM_SMS_BAO_Provider::getProviders(NULL, NULL, TRUE, 'is_default desc');
 180
 181       $providerSelect = array();
 182       foreach ($providers as $provider) {
 183         $providerSelect[$provider['id']] = $provider['title'];
 184       }
 185       $this->add('select', 'sms_provider_id', ts('SMS Provider'), $providerSelect, TRUE);
 186     }
 187
 188     foreach ($this->_freqUnits as $val => $label) {
 189       $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
 190     }
 191
 192     $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing'));
 193
 194     //reminder_frequency
 195     $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE);
 196
 197     $condition = array(
 198       'before' => ts('before'),
 199       'after' => ts('after'),
 200     );
 201     //reminder_action
 202     $this->add('select', 'start_action_condition', ts('Action Condition'), $condition);
 203
 204     $this->add('select', 'start_action_date', ts('Date Field'), $selectedMapping->getDateFields(), TRUE);
 205
 206     $this->addElement('checkbox', 'record_activity', $recordActivity);
 207
 208     $this->addElement('checkbox', 'is_repeat', ts('Repeat'),
 209       NULL, array('onchange' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);")
 210     );
 211
 212     $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay);
 213     $this->add('number', 'repetition_frequency_interval', ts('every'), array('class' => 'six', 'min' => 0));
 214     $this->addRule('repetition_frequency_interval', ts('Value should be a positive number'), 'positiveInteger');
 215
 216     $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay);
 217     $this->add('number', 'end_frequency_interval', ts('until'), array('class' => 'six', 'min' => 0));
 218     $this->addRule('end_frequency_interval', ts('Value should be a positive number'), 'positiveInteger');
 219
 220     $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE);
 221     $this->add('select', 'end_date', ts('Date Field'), $selectedMapping->getDateFields(), TRUE);
 222
 223     $this->add('text', 'from_name', ts('From Name'));
 224     $this->add('text', 'from_email', ts('From Email'));
 225
 226     $recipientListingOptions = array();
 227
 228     if ($mappingID) {
 229       $mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings(array(
 230         'id' => $mappingID,
 231       )));
 232     }
 233
 234     $limitOptions = array('' => '-neither-', 1 => ts('Limit to'), 0 => ts('Also include'));
 235
 236     $recipientLabels = array('activity' => ts('Recipients'), 'other' => ts('Limit or Add Recipients'));
 237     $this->assign('recipientLabels', $recipientLabels);
 238
 239     $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions, FALSE, array('onChange' => "showHideByValue('limit_to','','recipient', 'select','select',true);"));
 240
 241     $this->add('select', 'recipient', $recipientLabels['other'], $entityRecipientLabels,
 242       FALSE, array('onchange' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);")
 243     );
 244
 245     if (!empty($this->_submitValues['recipient_listing'])) {
 246       if (!empty($this->_context)) {
 247         $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($this->_mappingID, $this->_submitValues['recipient']);
 248       }
 249       else {
 250         $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($_POST['entity'][0], $_POST['recipient']);
 251       }
 252     }
 253     elseif (!empty($this->_values['recipient_listing'])) {
 254       $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($this->_values['mapping_id'], $this->_values['recipient']);
 255     }
 256
 257     $this->add('select', 'recipient_listing', ts('Recipient Roles'), $recipientListingOptions, FALSE,
 258       array('multiple' => TRUE, 'class' => 'crm-select2 huge', 'placeholder' => TRUE));
 259
 260     $this->addEntityRef('recipient_manual_id', ts('Manual Recipients'), array('multiple' => TRUE, 'create' => TRUE));
 261
 262     $this->add('select', 'group_id', ts('Group'),
 263       CRM_Core_PseudoConstant::nestedGroup('Mailing'), FALSE, array('class' => 'crm-select2 huge')
 264     );
 265
 266     // multilingual only options
 267     $multilingual = CRM_Core_I18n::isMultilingual();
 268     if ($multilingual) {
 269       $smarty = CRM_Core_Smarty::singleton();
 270       $smarty->assign('multilingual', $multilingual);
 271
 272       $languages = CRM_Core_I18n::languages(TRUE);
 273       $languageFilter = $languages + array(CRM_Core_I18n::NONE => ts('Contacts with no preferred language'));
 274       $element = $this->add('select', 'filter_contact_language', ts('Recipients language'), $languageFilter, FALSE,
 275         array('multiple' => TRUE, 'class' => 'crm-select2', 'placeholder' => TRUE));
 276
 277       $communicationLanguage = array(
 278         '' => ts('System default language'),
 279         CRM_Core_I18n::AUTO => ts('Follow recipient preferred language'),
 280       );
 281       $communicationLanguage = $communicationLanguage + $languages;
 282       $this->add('select', 'communication_language', ts('Communication language'), $communicationLanguage);
 283     }
 284
 285     CRM_Mailing_BAO_Mailing::commonCompose($this);
 286
 287     $this->add('text', 'subject', ts('Subject'),
 288       CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject')
 289     );
 290
 291     $this->add('checkbox', 'is_active', $isActive);
 292
 293     $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'), $this);
 294
 295     $this->setPageTitle(ts('Scheduled Reminder'));
 296   }
 297
 298   /**
 299    * Global form rule.
 300    *
 301    * @param array $fields
 302    *   The input form values.
 303    * @param array $files
 304    * @param CRM_Admin_Form_ScheduleReminders $self
 305    *
 306    * @return array|bool
 307    *   True if no errors, else array of errors
 308    */
 309   public static function formRule($fields, $files, $self) {
 310     $errors = array();
 311     if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] === 0) ||
 312       (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0)
 313     ) {
 314       $errors['entity'] = ts('Please select appropriate value');
 315     }
 316
 317     if (!empty($fields['is_active']) &&
 318       CRM_Utils_System::isNull($fields['subject'])
 319     ) {
 320       $errors['subject'] = ts('Subject is a required field.');
 321     }
 322     if (!empty($fields['is_active']) &&
 323       CRM_Utils_System::isNull(trim(strip_tags($fields['html_message'])))
 324     ) {
 325       $errors['html_message'] = ts('The HTML message is a required field.');
 326     }
 327
 328     if (empty($self->_context) && CRM_Utils_System::isNull(CRM_Utils_Array::value(1, $fields['entity']))) {
 329       $errors['entity'] = ts('Please select entity value');
 330     }
 331
 332     if (!CRM_Utils_System::isNull($fields['absolute_date'])) {
 333       if (CRM_Utils_Date::format(CRM_Utils_Date::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date::format(date('Ymd'))) {
 334         $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.');
 335       }
 336     }
 337
 338     $recipientKind = array(
 339       'participant_role' => array(
 340         'name' => 'participant role',
 341         'target_id' => 'recipient_listing',
 342       ),
 343       'manual' => array(
 344         'name' => 'recipient',
 345         'target_id' => 'recipient_manual_id',
 346       ),
 347     );
 348     if ($fields['limit_to'] != '' && array_key_exists($fields['recipient'], $recipientKind) && empty($fields[$recipientKind[$fields['recipient']]['target_id']])) {
 349       $errors[$recipientKind[$fields['recipient']]['target_id']] = ts('If "Also include" or "Limit to" are selected, you must specify at least one %1', array(1 => $recipientKind[$fields['recipient']]['name']));
 350     }
 351
 352     $actionSchedule = $self->parseActionSchedule($fields);
 353     if ($actionSchedule->mapping_id) {
 354       $mapping = CRM_Core_BAO_ActionSchedule::getMapping($actionSchedule->mapping_id);
 355       CRM_Utils_Array::extend($errors, $mapping->validateSchedule($actionSchedule));
 356     }
 357
 358     if (!empty($errors)) {
 359       return $errors;
 360     }
 361
 362     return empty($errors) ? TRUE : $errors;
 363   }
 364
 365   /**
 366    * @return int
 367    */
 368   public function setDefaultValues() {
 369     if ($this->_action & CRM_Core_Action::ADD) {
 370       $defaults['is_active'] = 1;
 371       $defaults['mode'] = 'Email';
 372       $defaults['record_activity'] = 1;
 373     }
 374     else {
 375       $defaults = $this->_values;
 376       $entityValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('entity_value', $defaults));
 377       $entityStatus = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('entity_status', $defaults));
 378       if (empty($this->_context)) {
 379         $defaults['entity'][0] = CRM_Utils_Array::value('mapping_id', $defaults);
 380         $defaults['entity'][1] = $entityValue;
 381         $defaults['entity'][2] = $entityStatus;
 382       }
 383       else {
 384         $defaults['entity'] = $entityStatus;
 385       }
 386       if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $defaults)) {
 387         list($date, $time) = CRM_Utils_Date::setDateDefaults($absoluteDate);
 388         $defaults['absolute_date'] = $date;
 389       }
 390
 391       if ($recipientListing = CRM_Utils_Array::value('recipient_listing', $defaults)) {
 392         $defaults['recipient_listing'] = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 393           $recipientListing
 394         );
 395       }
 396       $defaults['text_message'] = CRM_Utils_Array::value('body_text', $defaults);
 397       $defaults['html_message'] = CRM_Utils_Array::value('body_html', $defaults);
 398       $defaults['sms_text_message'] = CRM_Utils_Array::value('sms_body_text', $defaults);
 399       $defaults['template'] = CRM_Utils_Array::value('msg_template_id', $defaults);
 400       $defaults['SMStemplate'] = CRM_Utils_Array::value('sms_template_id', $defaults);
 401       if (!empty($defaults['group_id'])) {
 402         $defaults['recipient'] = 'group';
 403       }
 404       elseif (!empty($defaults['recipient_manual'])) {
 405         $defaults['recipient'] = 'manual';
 406         $defaults['recipient_manual_id'] = $defaults['recipient_manual'];
 407       }
 408       if ($contactLanguage = CRM_Utils_Array::value('filter_contact_language', $defaults)) {
 409         $defaults['filter_contact_language'] = explode(CRM_Core_DAO::VALUE_SEPARATOR, $contactLanguage);
 410       }
 411     }
 412
 413     return $defaults;
 414   }
 415
 416   /**
 417    * Process the form submission.
 418    */
 419   public function postProcess() {
 420     if ($this->_action & CRM_Core_Action::DELETE) {
 421       // delete reminder
 422       CRM_Core_BAO_ActionSchedule::del($this->_id);
 423       CRM_Core_Session::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success');
 424       if ($this->_context == 'event' && $this->_compId) {
 425         $url = CRM_Utils_System::url('civicrm/event/manage/reminder',
 426           "reset=1&action=browse&id={$this->_compId}&component={$this->_context}&setTab=1"
 427         );
 428         $session = CRM_Core_Session::singleton();
 429         $session->pushUserContext($url);
 430       }
 431       return;
 432     }
 433     $values = $this->controller->exportValues($this->getName());
 434     $bao = $this->parseActionSchedule($values)->save();
 435
 436     // we need to set this on the form so that hooks can identify the created entity
 437     $this->set('id', $bao->id);
 438     $bao->free();
 439
 440     $status = ts("Your new Reminder titled %1 has been saved.",
 441       array(1 => "<strong>{$values['title']}</strong>")
 442     );
 443
 444     if ($this->_action) {
 445       if ($this->_action & CRM_Core_Action::UPDATE) {
 446         $status = ts("Your Reminder titled %1 has been updated.",
 447           array(1 => "<strong>{$values['title']}</strong>")
 448         );
 449       }
 450
 451       if ($this->_context == 'event' && $this->_compId) {
 452         $url = CRM_Utils_System::url('civicrm/event/manage/reminder', "reset=1&action=browse&id={$this->_compId}&component={$this->_context}&setTab=1");
 453         $session = CRM_Core_Session::singleton();
 454         $session->pushUserContext($url);
 455       }
 456     }
 457     CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
 458   }
 459
 460   /**
 461    * @param array $values
 462    *   The submitted form values.
 463    * @return CRM_Core_DAO_ActionSchedule
 464    */
 465   public function parseActionSchedule($values) {
 466     $params = array();
 467
 468     $keys = array(
 469       'title',
 470       'subject',
 471       'absolute_date',
 472       'group_id',
 473       'record_activity',
 474       'limit_to',
 475       'mode',
 476       'sms_provider_id',
 477       'from_name',
 478       'from_email',
 479     );
 480     foreach ($keys as $key) {
 481       $params[$key] = CRM_Utils_Array::value($key, $values);
 482     }
 483
 484     $params['is_repeat'] = CRM_Utils_Array::value('is_repeat', $values, 0);
 485
 486     $moreKeys = array(
 487       'start_action_offset',
 488       'start_action_unit',
 489       'start_action_condition',
 490       'start_action_date',
 491       'repetition_frequency_unit',
 492       'repetition_frequency_interval',
 493       'end_frequency_unit',
 494       'end_frequency_interval',
 495       'end_action',
 496       'end_date',
 497     );
 498
 499     if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $params)) {
 500       $params['absolute_date'] = CRM_Utils_Date::processDate($absoluteDate);
 501     }
 502     else {
 503       $params['absolute_date'] = 'null';
 504     }
 505     foreach ($moreKeys as $mkey) {
 506       if ($params['absolute_date'] != 'null' && CRM_Utils_String::startsWith($mkey, 'start_action')) {
 507         $params[$mkey] = 'null';
 508         continue;
 509       }
 510       $params[$mkey] = CRM_Utils_Array::value($mkey, $values);
 511     }
 512
 513     $params['body_text'] = CRM_Utils_Array::value('text_message', $values);
 514     $params['sms_body_text'] = CRM_Utils_Array::value('sms_text_message', $values);
 515     $params['body_html'] = CRM_Utils_Array::value('html_message', $values);
 516
 517     if (CRM_Utils_Array::value('recipient', $values) == 'manual') {
 518       $params['recipient_manual'] = CRM_Utils_Array::value('recipient_manual_id', $values);
 519       $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null';
 520     }
 521     elseif (CRM_Utils_Array::value('recipient', $values) == 'group') {
 522       $params['group_id'] = $values['group_id'];
 523       $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null';
 524     }
 525     elseif (isset($values['recipient_listing']) && isset($values['limit_to']) && !CRM_Utils_System::isNull($values['recipient_listing']) && !CRM_Utils_System::isNull($values['limit_to'])) {
 526       $params['recipient'] = CRM_Utils_Array::value('recipient', $values);
 527       $params['recipient_listing'] = implode(CRM_Core_DAO::VALUE_SEPARATOR,
 528         CRM_Utils_Array::value('recipient_listing', $values)
 529       );
 530       $params['group_id'] = $params['recipient_manual'] = 'null';
 531     }
 532     else {
 533       $params['recipient'] = CRM_Utils_Array::value('recipient', $values);
 534       $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null';
 535     }
 536
 537     if (!empty($this->_mappingID) && !empty($this->_compId)) {
 538       $params['mapping_id'] = $this->_mappingID;
 539       $params['entity_value'] = $this->_compId;
 540       $params['entity_status'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values['entity']);
 541     }
 542     else {
 543       $params['mapping_id'] = $values['entity'][0];
 544       if ($params['mapping_id'] == 1) {
 545         $params['limit_to'] = 1;
 546       }
 547
 548       $entity_value = CRM_Utils_Array::value(1, $values['entity'], array());
 549       $entity_status = CRM_Utils_Array::value(2, $values['entity'], array());
 550       $params['entity_value'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $entity_value);
 551       $params['entity_status'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $entity_status);
 552     }
 553
 554     $params['is_active'] = CRM_Utils_Array::value('is_active', $values, 0);
 555
 556     if (CRM_Utils_Array::value('is_repeat', $values) == 0) {
 557       $params['repetition_frequency_unit'] = 'null';
 558       $params['repetition_frequency_interval'] = 'null';
 559       $params['end_frequency_unit'] = 'null';
 560       $params['end_frequency_interval'] = 'null';
 561       $params['end_action'] = 'null';
 562       $params['end_date'] = 'null';
 563     }
 564
 565     // multilingual options
 566     $params['filter_contact_language'] = CRM_Utils_Array::value('filter_contact_language', $values, array());
 567     $params['filter_contact_language'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params['filter_contact_language']);
 568     $params['communication_language'] = CRM_Utils_Array::value('communication_language', $values, NULL);
 569
 570     if ($this->_action & CRM_Core_Action::UPDATE) {
 571       $params['id'] = $this->_id;
 572     }
 573     elseif ($this->_action & CRM_Core_Action::ADD) {
 574       // we do this only once, so name never changes
 575       $params['name'] = CRM_Utils_String::munge($params['title'], '_', 64);
 576     }
 577
 578     $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
 579
 580     if ($params['mode'] == 'Email' || empty($params['sms_provider_id'])) {
 581       unset($modePrefixes['SMS']);
 582     }
 583     elseif ($params['mode'] == 'SMS') {
 584       unset($modePrefixes['Mail']);
 585     }
 586
 587     //TODO: handle postprocessing of SMS and/or Email info based on $modePrefixes
 588
 589     $composeFields = array(
 590       'template',
 591       'saveTemplate',
 592       'updateTemplate',
 593       'saveTemplateName',
 594     );
 595     $msgTemplate = NULL;
 596     //mail template is composed
 597
 598     foreach ($modePrefixes as $prefix) {
 599       $composeParams = array();
 600       foreach ($composeFields as $key) {
 601         $key = $prefix . $key;
 602         if (!empty($values[$key])) {
 603           $composeParams[$key] = $values[$key];
 604         }
 605       }
 606
 607       if (!empty($composeParams[$prefix . 'updateTemplate'])) {
 608         $templateParams = array('is_active' => TRUE);
 609         if ($prefix == 'SMS') {
 610           $templateParams += array(
 611             'msg_text' => $params['sms_body_text'],
 612             'is_sms' => TRUE,
 613           );
 614         }
 615         else {
 616           $templateParams += array(
 617             'msg_text' => $params['body_text'],
 618             'msg_html' => $params['body_html'],
 619             'msg_subject' => $params['subject'],
 620           );
 621         }
 622         $templateParams['id'] = $values[$prefix . 'template'];
 623
 624         $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
 625       }
 626
 627       if (!empty($composeParams[$prefix . 'saveTemplate'])) {
 628         $templateParams = array('is_active' => TRUE);
 629         if ($prefix == 'SMS') {
 630           $templateParams += array(
 631             'msg_text' => $params['sms_body_text'],
 632             'is_sms' => TRUE,
 633           );
 634         }
 635         else {
 636           $templateParams += array(
 637             'msg_text' => $params['body_text'],
 638             'msg_html' => $params['body_html'],
 639             'msg_subject' => $params['subject'],
 640           );
 641         }
 642         $templateParams['msg_title'] = $composeParams[$prefix . 'saveTemplateName'];
 643
 644         $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
 645       }
 646
 647       if ($prefix == 'SMS') {
 648         if (isset($msgTemplate->id)) {
 649           $params['sms_template_id'] = $msgTemplate->id;
 650         }
 651         else {
 652           $params['sms_template_id'] = CRM_Utils_Array::value('SMStemplate', $values);
 653         }
 654       }
 655       else {
 656         if (isset($msgTemplate->id)) {
 657           $params['msg_template_id'] = $msgTemplate->id;
 658         }
 659         else {
 660           $params['msg_template_id'] = CRM_Utils_Array::value('template', $values);
 661         }
 662       }
 663     }
 664
 665     $actionSchedule = new CRM_Core_DAO_ActionSchedule();
 666     $actionSchedule->copyValues($params);
 667     return $actionSchedule;
 668   }
 669
 670   /**
 671    * List available tokens for this form.
 672    *
 673    * @return array
 674    */
 675   public function listTokens() {
 676     $tokens = CRM_Core_SelectValues::contactTokens();
 677     $tokens = array_merge(CRM_Core_SelectValues::activityTokens(), $tokens);
 678     $tokens = array_merge(CRM_Core_SelectValues::eventTokens(), $tokens);
 679     $tokens = array_merge(CRM_Core_SelectValues::membershipTokens(), $tokens);
 680     $tokens = array_merge(CRM_Core_SelectValues::contributionTokens(), $tokens);
 681     return $tokens;
 682   }
 683
 684 }