CRM/Admin/Form/MessageTemplates.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   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 Message templates
  36  * used by membership, contributions, event registrations, etc.
  37  */
  38 class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form {
  39   // which (and whether) mailing workflow this template belongs to
  40   protected $_workflow_id = NULL;
  41
  42   // Is document file is already loaded as default value?
  43   protected $_is_document = FALSE;
  44
  45   public function preProcess() {
  46     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  47     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
  48       $this, FALSE, 'add'
  49     );
  50     $this->assign('action', $this->_action);
  51
  52     $this->_BAOName = 'CRM_Core_BAO_MessageTemplate';
  53     $this->set('BAOName', $this->_BAOName);
  54     parent::preProcess();
  55   }
  56
  57   /**
  58    * Set default values for the form.
  59    *
  60    * The default values are retrieved from the database.
  61    */
  62   public function setDefaultValues() {
  63     $defaults = $this->_values;
  64
  65     if (empty($defaults['pdf_format_id'])) {
  66       $defaults['pdf_format_id'] = 'null';
  67     }
  68     if (empty($defaults['file_type'])) {
  69       $defaults['file_type'] = 0;
  70     }
  71
  72     if ($this->_action & CRM_Core_Action::ADD) {
  73       $defaults['is_active'] = 1;
  74     }
  75
  76     if ($this->_action & CRM_Core_Action::UPDATE) {
  77       $documentInfo = CRM_Core_BAO_File::getEntityFile('civicrm_msg_template', $this->_id, TRUE);
  78       if (!empty($documentInfo)) {
  79         $defaults['file_type'] = 1;
  80         $this->_is_document = TRUE;
  81         $this->assign('attachment', $documentInfo);
  82       }
  83     }
  84
  85     return $defaults;
  86   }
  87
  88   /**
  89    * Build the form object.
  90    */
  91   public function buildQuickForm() {
  92     // For VIEW we only want Done button
  93     if ($this->_action & CRM_Core_Action::VIEW) {
  94       // currently, the above action is used solely for previewing default workflow templates
  95       $cancelURL = CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1');
  96       $cancelURL = str_replace('&amp;', '&', $cancelURL);
  97       $this->addButtons(array(
  98           array(
  99             'type' => 'cancel',
 100             'name' => ts('Done'),
 101             'js' => array('onclick' => "location.href='{$cancelURL}'; return false;"),
 102             'isDefault' => TRUE,
 103           ),
 104         )
 105       );
 106     }
 107     else {
 108       $this->_workflow_id = CRM_Utils_Array::value('workflow_id', $this->_values);
 109       $this->checkUserPermission($this->_workflow_id);
 110       $this->assign('workflow_id', $this->_workflow_id);
 111
 112       if ($this->_workflow_id) {
 113         $selectedChild = 'workflow';
 114       }
 115       else {
 116         $selectedChild = 'user';
 117       }
 118
 119       $cancelURL = CRM_Utils_System::url('civicrm/admin/messageTemplates', "selectedChild={$selectedChild}&reset=1");
 120       $cancelURL = str_replace('&amp;', '&', $cancelURL);
 121       $buttons[] = array(
 122         'type' => 'upload',
 123         'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'),
 124         'isDefault' => TRUE,
 125       );
 126       if (!($this->_action & CRM_Core_Action::DELETE)) {
 127         $buttons[] = array(
 128           'type' => 'submit',
 129           'name' => ts('Save and Done'),
 130           'subName' => 'done',
 131         );
 132       }
 133       $buttons[] = array(
 134         'type' => 'cancel',
 135         'name' => ts('Cancel'),
 136         'js' => array('onclick' => "location.href='{$cancelURL}'; return false;"),
 137       );
 138       $this->addButtons($buttons);
 139     }
 140
 141     if ($this->_action & CRM_Core_Action::DELETE) {
 142       return;
 143     }
 144
 145     $breadCrumb = array(
 146       array(
 147         'title' => ts('Message Templates'),
 148         'url' => CRM_Utils_System::url('civicrm/admin/messageTemplates',
 149           'action=browse&reset=1'
 150         ),
 151       ),
 152     );
 153     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 154
 155     $this->applyFilter('__ALL__', 'trim');
 156     $this->add('text', 'msg_title', ts('Message Title'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_MessageTemplate', 'msg_title'), TRUE);
 157
 158     $options = array(ts('Compose On-screen'), ts('Upload Document'));
 159     $element = $this->addRadio('file_type', ts('Source'), $options);
 160     if ($this->_id) {
 161       $element->freeze();
 162     }
 163
 164     $this->addElement('file', "file_id", ts('Upload Document'), 'size=30 maxlength=255');
 165     $this->addUploadElement("file_id");
 166
 167     $this->add('text', 'msg_subject',
 168       ts('Message Subject'),
 169       CRM_Core_DAO::getAttribute('CRM_Core_DAO_MessageTemplate', 'msg_subject')
 170     );
 171
 172     //get the tokens.
 173     $tokens = CRM_Core_SelectValues::contactTokens();
 174
 175     $this->assign('tokens', CRM_Utils_Token::formatTokensForDisplay($tokens));
 176
 177     // if not a system message use a wysiwyg editor, CRM-5971
 178     if ($this->_id &&
 179       CRM_Core_DAO::getFieldValue('CRM_Core_DAO_MessageTemplate',
 180         $this->_id,
 181         'workflow_id'
 182       )
 183     ) {
 184       $this->add('textarea', 'msg_html', ts('HTML Message'),
 185         "cols=50 rows=6"
 186       );
 187     }
 188     else {
 189       $this->add('wysiwyg', 'msg_html', ts('HTML Message'),
 190         array(
 191           'cols' => '80',
 192           'rows' => '8',
 193           'onkeyup' => "return verify(this)",
 194           'preset' => 'civimail',
 195         )
 196       );
 197     }
 198
 199     $this->add('textarea', 'msg_text', ts('Text Message'),
 200       "cols=50 rows=6"
 201     );
 202
 203     $this->add('select', 'pdf_format_id', ts('PDF Page Format'),
 204       array(
 205         'null' => ts('- default -'),
 206       ) + CRM_Core_BAO_PdfFormat::getList(TRUE), FALSE
 207     );
 208
 209     $this->add('checkbox', 'is_active', ts('Enabled?'));
 210     $this->addFormRule(array(__CLASS__, 'formRule'), $this);
 211
 212     if ($this->_action & CRM_Core_Action::VIEW) {
 213       $this->freeze();
 214       CRM_Utils_System::setTitle(ts('View System Default Message Template'));
 215     }
 216   }
 217
 218   /**
 219    * Restrict users access based on permission
 220    *
 221    * @param int $workflowId
 222    */
 223   private function checkUserPermission($workflowId) {
 224     if (isset($workflowId)) {
 225       $canView = CRM_Core_Permission::check('edit system workflow message templates');
 226     }
 227     else {
 228       $canView = CRM_Core_Permission::check('edit user-driven message templates');
 229     }
 230
 231     if (!$canView && !CRM_Core_Permission::check('edit message templates')) {
 232       CRM_Core_Session::setStatus(ts('You do not have permission to view requested page.'), ts('Access Denied'));
 233       $url = CRM_Utils_System::url('civicrm/admin/messageTemplates', "reset=1");
 234       CRM_Utils_System::redirect($url);
 235     }
 236   }
 237
 238   /**
 239    * Global form rule.
 240    *
 241    * @param array $params
 242    *   The input form values.
 243    * @param array $files
 244    *   The uploaded files if any.
 245    * @param array $self
 246    *
 247    * @return array
 248    *   array of errors
 249    */
 250   public static function formRule($params, $files, $self) {
 251     // If user uploads non-document file other than odt/docx
 252     if (!empty($files['file_id']['tmp_name']) &&
 253       array_search($files['file_id']['type'], CRM_Core_SelectValues::documentApplicationType()) == NULL
 254     ) {
 255       $errors['file_id'] = ts('Invalid document file format');
 256     }
 257     // If default is not set and no document file is uploaded
 258     elseif (empty($files['file_id']['tmp_name']) && !empty($params['file_type']) && !$self->_is_document) {
 259       //On edit page of docx/odt message template if user changes file type but forgot to upload document
 260       $errors['file_id'] = ts('Please upload document');
 261     }
 262
 263     return empty($errors) ? TRUE : $errors;
 264   }
 265
 266   /**
 267    * Process the form submission.
 268    */
 269   public function postProcess() {
 270     if ($this->_action & CRM_Core_Action::DELETE) {
 271       CRM_Core_BAO_MessageTemplate::del($this->_id);
 272     }
 273     elseif ($this->_action & CRM_Core_Action::VIEW) {
 274       // currently, the above action is used solely for previewing default workflow templates
 275       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1'));
 276     }
 277     else {
 278       // store the submitted values in an array
 279       $params = $this->controller->exportValues();
 280
 281       if ($this->_action & CRM_Core_Action::UPDATE) {
 282         $params['id'] = $this->_id;
 283       }
 284
 285       if (!empty($params['file_type'])) {
 286         unset($params['msg_html']);
 287         unset($params['msg_text']);
 288         CRM_Utils_File::formatFile($params, 'file_id');
 289       }
 290       // delete related file references if html/text/pdf template are chosen over document
 291       elseif (!empty($this->_id)) {
 292         $entityFileDAO = new CRM_Core_DAO_EntityFile();
 293         $entityFileDAO->entity_id = $this->_id;
 294         $entityFileDAO->entity_table = 'civicrm_msg_template';
 295         if ($entityFileDAO->find(TRUE)) {
 296           $fileDAO = new CRM_Core_DAO_File();
 297           $fileDAO->id = $entityFileDAO->file_id;
 298           $fileDAO->find(TRUE);
 299           $entityFileDAO->delete();
 300           $fileDAO->delete();
 301         }
 302       }
 303
 304       $this->_workflow_id = CRM_Utils_Array::value('workflow_id', $this->_values);
 305       if ($this->_workflow_id) {
 306         $params['workflow_id'] = $this->_workflow_id;
 307         $params['is_active'] = TRUE;
 308       }
 309
 310       $messageTemplate = CRM_Core_BAO_MessageTemplate::add($params);
 311       CRM_Core_Session::setStatus(ts('The Message Template \'%1\' has been saved.', array(1 => $messageTemplate->msg_title)), ts('Saved'), 'success');
 312
 313       if (isset($this->_submitValues['_qf_MessageTemplates_upload'])) {
 314         // Save button was pressed
 315         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates/add', "action=update&id={$messageTemplate->id}&reset=1"));
 316       }
 317       // Save and done button was pressed
 318       if ($this->_workflow_id) {
 319         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1'));
 320       }
 321       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=user&reset=1'));
 322     }
 323   }
 324
 325 }