CRM/Admin/Form/Preferences.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  * Base class for settings forms.
  36  */
  37 class CRM_Admin_Form_Preferences extends CRM_Core_Form {
  38
  39   use CRM_Admin_Form_SettingTrait;
  40
  41   protected $_system = FALSE;
  42   protected $_contactID = NULL;
  43   public $_action = NULL;
  44
  45   protected $_checkbox = NULL;
  46
  47   protected $_varNames = [];
  48
  49   protected $_config = NULL;
  50
  51   protected $_params = NULL;
  52
  53   public function preProcess() {
  54     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive',
  55       $this, FALSE
  56     );
  57     $this->_system = CRM_Utils_Request::retrieve('system', 'Boolean',
  58       $this, FALSE, TRUE
  59     );
  60     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
  61       $this, FALSE, 'update'
  62     );
  63     if (isset($action)) {
  64       $this->assign('action', $action);
  65     }
  66
  67     $session = CRM_Core_Session::singleton();
  68
  69     $this->_config = new CRM_Core_DAO();
  70
  71     if ($this->_system) {
  72       if (CRM_Core_Permission::check('administer CiviCRM')) {
  73         $this->_contactID = NULL;
  74       }
  75       else {
  76         CRM_Utils_System::fatal('You do not have permission to edit preferences');
  77       }
  78       $this->_config->contact_id = NULL;
  79     }
  80     else {
  81       if (!$this->_contactID) {
  82         $this->_contactID = $session->get('userID');
  83         if (!$this->_contactID) {
  84           CRM_Utils_System::fatal('Could not retrieve contact id');
  85         }
  86         $this->set('cid', $this->_contactID);
  87       }
  88       $this->_config->contact_id = $this->_contactID;
  89     }
  90
  91     $this->addFieldsDefinedInSettingsMetadata();
  92     $settings = Civi::settings();
  93     // @todo replace this by defining all in settings.
  94     foreach ($this->_varNames as $groupName => $settingNames) {
  95       CRM_Core_Error::deprecatedFunctionWarning('deprecated use of preferences form. This will be removed from core soon');
  96       foreach ($settingNames as $settingName => $options) {
  97         $this->_config->$settingName = $settings->get($settingName);
  98       }
  99     }
 100     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
 101   }
 102
 103   /**
 104    * @return array
 105    */
 106   public function setDefaultValues() {
 107     $this->_defaults = [];
 108
 109     $this->setDefaultsForMetadataDefinedFields();
 110     foreach ($this->_varNames as $groupName => $settings) {
 111       CRM_Core_Error::deprecatedFunctionWarning('deprecated use of preferences form. This will be removed from core soon');
 112       foreach ($settings as $settingName => $settingDetails) {
 113         $this->_defaults[$settingName] = isset($this->_config->$settingName) ? $this->_config->$settingName : CRM_Utils_Array::value('default', $settingDetails, NULL);
 114       }
 115     }
 116
 117     return $this->_defaults;
 118   }
 119
 120   /**
 121    * @todo deprecate in favour of setting using metadata.
 122    *
 123    * @param $defaults
 124    */
 125   public function cbsDefaultValues(&$defaults) {
 126
 127     foreach ($this->_varNames as $groupName => $groupValues) {
 128       CRM_Core_Error::deprecatedFunctionWarning('deprecated use of preferences form. This will be removed from core soon');
 129       foreach ($groupValues as $settingName => $fieldValue) {
 130         if ($fieldValue['html_type'] == 'checkboxes') {
 131           if (isset($this->_config->$settingName) &&
 132             $this->_config->$settingName
 133           ) {
 134             $value = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 135               substr($this->_config->$settingName, 1, -1)
 136             );
 137             if (!empty($value)) {
 138               $defaults[$settingName] = [];
 139               foreach ($value as $n => $v) {
 140                 $defaults[$settingName][$v] = 1;
 141               }
 142             }
 143           }
 144         }
 145       }
 146     }
 147   }
 148
 149   /**
 150    * Build the form object.
 151    */
 152   public function buildQuickForm() {
 153     parent::buildQuickForm();
 154
 155     if (!empty($this->_varNames)) {
 156       CRM_Core_Error::deprecatedFunctionWarning('deprecated use of preferences form. This will be removed from core soon');
 157       foreach ($this->_varNames as $groupName => $groupValues) {
 158         $formName = CRM_Utils_String::titleToVar($groupName);
 159         $this->assign('formName', $formName);
 160         $fields = [];
 161         foreach ($groupValues as $fieldName => $fieldValue) {
 162           $fields[$fieldName] = $fieldValue;
 163
 164           switch ($fieldValue['html_type']) {
 165             case 'text':
 166               $this->addElement('text',
 167                 $fieldName,
 168                 $fieldValue['title'],
 169                 [
 170                   'maxlength' => 64,
 171                   'size' => 32,
 172                 ]
 173               );
 174               break;
 175
 176             case 'textarea':
 177             case 'checkbox':
 178               $this->add($fieldValue['html_type'],
 179                 $fieldName,
 180                 $fieldValue['title']
 181               );
 182               break;
 183
 184             case 'radio':
 185               $options = CRM_Core_OptionGroup::values($fieldName, FALSE, FALSE, TRUE);
 186               $this->addRadio($fieldName, $fieldValue['title'], $options, NULL, '&nbsp;&nbsp;');
 187               break;
 188
 189             case 'YesNo':
 190               $this->addRadio($fieldName, $fieldValue['title'], [0 => 'No', 1 => 'Yes'], NULL, '&nbsp;&nbsp;');
 191               break;
 192
 193             case 'checkboxes':
 194               $options = array_flip(CRM_Core_OptionGroup::values($fieldName, FALSE, FALSE, TRUE));
 195               $newOptions = [];
 196               foreach ($options as $key => $val) {
 197                 $newOptions[$key] = $val;
 198               }
 199               $this->addCheckBox($fieldName,
 200                 $fieldValue['title'],
 201                 $newOptions,
 202                 NULL, NULL, NULL, NULL,
 203                 ['&nbsp;&nbsp;', '&nbsp;&nbsp;', '<br/>']
 204               );
 205               break;
 206
 207             case 'select':
 208               $this->addElement('select',
 209                 $fieldName,
 210                 $fieldValue['title'],
 211                 $fieldValue['option_values'],
 212                 CRM_Utils_Array::value('attributes', $fieldValue)
 213               );
 214               break;
 215
 216             case 'wysiwyg':
 217               $this->add('wysiwyg', $fieldName, $fieldValue['title'], $fieldValue['attributes']);
 218               break;
 219
 220             case 'entity_reference':
 221               $this->addEntityRef($fieldName, $fieldValue['title'], CRM_Utils_Array::value('options', $fieldValue, []));
 222           }
 223         }
 224
 225         $fields = CRM_Utils_Array::crmArraySortByField($fields, 'weight');
 226         $this->assign('fields', $fields);
 227       }
 228     }
 229
 230     $this->addButtons([
 231       [
 232         'type' => 'next',
 233         'name' => ts('Save'),
 234         'isDefault' => TRUE,
 235       ],
 236       [
 237         'type' => 'cancel',
 238         'name' => ts('Cancel'),
 239       ],
 240     ]);
 241
 242     if ($this->_action == CRM_Core_Action::VIEW) {
 243       $this->freeze();
 244     }
 245   }
 246
 247   /**
 248    * Process the form submission.
 249    */
 250   public function postProcess() {
 251     $config = CRM_Core_Config::singleton();
 252     if ($this->_action == CRM_Core_Action::VIEW) {
 253       return;
 254     }
 255
 256     $this->_params = $this->controller->exportValues($this->_name);
 257
 258     $this->postProcessCommon();
 259   }
 260
 261   /**
 262    * Process the form submission.
 263    */
 264   public function postProcessCommon() {
 265     try {
 266       $this->saveMetadataDefinedSettings($this->_params);
 267       $this->filterParamsSetByMetadata($this->_params);
 268     }
 269     catch (CiviCRM_API3_Exception $e) {
 270       CRM_Core_Session::setStatus($e->getMessage(), ts('Save Failed'), 'error');
 271     }
 272
 273     foreach ($this->_varNames as $groupName => $groupValues) {
 274       foreach ($groupValues as $settingName => $fieldValue) {
 275         switch ($fieldValue['html_type']) {
 276           case 'checkboxes':
 277             if (!empty($this->_params[$settingName]) &&
 278               is_array($this->_params[$settingName])
 279             ) {
 280               $this->_config->$settingName = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
 281                   array_keys($this->_params[$settingName])
 282                 ) . CRM_Core_DAO::VALUE_SEPARATOR;
 283             }
 284             else {
 285               $this->_config->$settingName = NULL;
 286             }
 287             break;
 288
 289           case 'checkbox':
 290             $this->_config->$settingName = !empty($this->_params[$settingName]) ? 1 : 0;
 291             break;
 292
 293           case 'text':
 294           case 'select':
 295           case 'radio':
 296           case 'YesNo':
 297           case 'entity_reference':
 298             $this->_config->$settingName = CRM_Utils_Array::value($settingName, $this->_params);
 299             break;
 300
 301           case 'textarea':
 302             $value = CRM_Utils_Array::value($settingName, $this->_params);
 303             if ($value) {
 304               $value = trim($value);
 305               $value = str_replace(["\r\n", "\r"], "\n", $value);
 306             }
 307             $this->_config->$settingName = $value;
 308             break;
 309         }
 310       }
 311     }
 312
 313     foreach ($this->_varNames as $groupName => $groupValues) {
 314       foreach ($groupValues as $settingName => $fieldValue) {
 315         $settingValue = isset($this->_config->$settingName) ? $this->_config->$settingName : NULL;
 316         Civi::settings()->set($settingName, $settingValue);
 317       }
 318     }
 319     // Update any settings stored in dynamic js
 320     CRM_Core_Resources::singleton()->resetCacheCode();
 321
 322     CRM_Core_Session::setStatus(ts('Your changes have been saved.'), ts('Saved'), 'success');
 323   }
 324
 325 }