CRM/Admin/Form/MessageTemplates.php

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