CRM/Admin/Form/Setting.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  */
  34
  35 /**
  36  * This class generates form components generic to CiviCRM settings
  37  */
  38 class CRM_Admin_Form_Setting extends CRM_Core_Form {
  39
  40   protected $_defaults;
  41   protected $_settings = array();
  42
  43   /**
  44    * Set default values for the form.
  45    *
  46    * Default values are retrieved from the database.
  47    */
  48   public function setDefaultValues() {
  49     if (!$this->_defaults) {
  50       $this->_defaults = array();
  51       $formArray = array('Component', 'Localization');
  52       $formMode = FALSE;
  53       if (in_array($this->_name, $formArray)) {
  54         $formMode = TRUE;
  55       }
  56
  57       CRM_Core_BAO_ConfigSetting::retrieve($this->_defaults);
  58
  59       CRM_Core_Config_Defaults::setValues($this->_defaults, $formMode);
  60
  61       $list = array_flip(CRM_Core_OptionGroup::values('contact_autocomplete_options',
  62         FALSE, FALSE, TRUE, NULL, 'name'
  63       ));
  64
  65       $cRlist = array_flip(CRM_Core_OptionGroup::values('contact_reference_options',
  66         FALSE, FALSE, TRUE, NULL, 'name'
  67       ));
  68
  69       $listEnabled = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  70         'contact_autocomplete_options'
  71       );
  72       $cRlistEnabled = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  73         'contact_reference_options'
  74       );
  75
  76       $autoSearchFields = array();
  77       if (!empty($list) && !empty($listEnabled)) {
  78         $autoSearchFields = array_combine($list, $listEnabled);
  79       }
  80
  81       $cRSearchFields = array();
  82       if (!empty($cRlist) && !empty($cRlistEnabled)) {
  83         $cRSearchFields = array_combine($cRlist, $cRlistEnabled);
  84       }
  85
  86       //Set defaults for autocomplete and contact reference options
  87       $this->_defaults['autocompleteContactSearch'] = array(
  88           '1' => 1,
  89         ) + $autoSearchFields;
  90       $this->_defaults['autocompleteContactReference'] = array(
  91           '1' => 1,
  92         ) + $cRSearchFields;
  93
  94       // we can handle all the ones defined in the metadata here. Others to be converted
  95       foreach ($this->_settings as $setting => $group) {
  96         $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
  97         $this->_defaults[$setting] = civicrm_api('setting', 'getvalue', array(
  98             'version' => 3,
  99             'name' => $setting,
 100             'group' => $group,
 101             'default_value' => CRM_Utils_Array::value('default', $settingMetaData['values'][$setting]),
 102           )
 103         );
 104       }
 105
 106       $this->_defaults['enableSSL'] = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'enableSSL', NULL, 0);
 107       $this->_defaults['verifySSL'] = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL', NULL, 1);
 108     }
 109
 110     return $this->_defaults;
 111   }
 112
 113   /**
 114    * Build the form object
 115    */
 116   public function buildQuickForm() {
 117     $session = CRM_Core_Session::singleton();
 118     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
 119     $args = func_get_args();
 120     $check = reset($args);
 121     $this->addButtons(array(
 122         array(
 123           'type' => 'next',
 124           'name' => ts('Save'),
 125           'isDefault' => TRUE,
 126         ),
 127         array(
 128           'type' => 'cancel',
 129           'name' => ts('Cancel'),
 130         ),
 131       )
 132     );
 133
 134     foreach ($this->_settings as $setting => $group) {
 135       $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
 136       $props = $settingMetaData['values'][$setting];
 137       if (isset($props['quick_form_type'])) {
 138         $add = 'add' . $props['quick_form_type'];
 139         if ($add == 'addElement') {
 140           $this->$add(
 141             $props['html_type'],
 142             $setting,
 143             ts($props['title']),
 144             CRM_Utils_Array::value($props['html_type'] == 'select' ? 'option_values' : 'html_attributes', $props, array()),
 145             $props['html_type'] == 'select' ? CRM_Utils_Array::value('html_attributes', $props) : NULL
 146           );
 147         }
 148         else {
 149           $this->$add($setting, ts($props['title']));
 150         }
 151         $this->assign("{$setting}_description", ts($props['description']));
 152         if ($setting == 'max_attachments') {
 153           //temp hack @todo fix to get from metadata
 154           $this->addRule('max_attachments', ts('Value should be a positive number'), 'positiveInteger');
 155         }
 156         if ($setting == 'maxFileSize') {
 157           //temp hack
 158           $this->addRule('maxFileSize', ts('Value should be a positive number'), 'positiveInteger');
 159         }
 160
 161       }
 162     }
 163   }
 164
 165   /**
 166    * Process the form submission.
 167    */
 168   public function postProcess() {
 169     // store the submitted values in an array
 170     $params = $this->controller->exportValues($this->_name);
 171
 172     self::commonProcess($params);
 173   }
 174
 175   /**
 176    * @param array $params
 177    */
 178   public function commonProcess(&$params) {
 179
 180     // save autocomplete search options
 181     if (!empty($params['autocompleteContactSearch'])) {
 182       $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
 183           array_keys($params['autocompleteContactSearch'])
 184         ) . CRM_Core_DAO::VALUE_SEPARATOR;
 185
 186       CRM_Core_BAO_Setting::setItem($value,
 187         CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 188         'contact_autocomplete_options'
 189       );
 190
 191       unset($params['autocompleteContactSearch']);
 192     }
 193
 194     // save autocomplete contact reference options
 195     if (!empty($params['autocompleteContactReference'])) {
 196       $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
 197           array_keys($params['autocompleteContactReference'])
 198         ) . CRM_Core_DAO::VALUE_SEPARATOR;
 199
 200       CRM_Core_BAO_Setting::setItem($value,
 201         CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 202         'contact_reference_options'
 203       );
 204
 205       unset($params['autocompleteContactReference']);
 206     }
 207
 208     // save components to be enabled
 209     if (array_key_exists('enableComponents', $params)) {
 210       CRM_Core_BAO_Setting::setItem($params['enableComponents'],
 211         CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'enable_components');
 212
 213       // unset params by emptying the values, so while retrieving we can detect and load from settings table
 214       // instead of config-backend for backward compatibility. We could use unset() in later releases.
 215       $params['enableComponents'] = $params['enableComponentIDs'] = array();
 216     }
 217
 218     // save checksum timeout
 219     if (!empty($params['checksumTimeout'])) {
 220       CRM_Core_BAO_Setting::setItem($params['checksumTimeout'],
 221         CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 222         'checksum_timeout'
 223       );
 224     }
 225
 226     // update time for date formats when global time is changed
 227     if (!empty($params['timeInputFormat'])) {
 228       $query = "
 229 UPDATE civicrm_preferences_date
 230 SET    time_format = %1
 231 WHERE  time_format IS NOT NULL
 232 AND    time_format <> ''
 233 ";
 234       $sqlParams = array(1 => array($params['timeInputFormat'], 'String'));
 235       CRM_Core_DAO::executeQuery($query, $sqlParams);
 236     }
 237
 238     // verify ssl peer option
 239     if (isset($params['verifySSL'])) {
 240       CRM_Core_BAO_Setting::setItem($params['verifySSL'],
 241         CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 242         'verifySSL'
 243       );
 244       unset($params['verifySSL']);
 245     }
 246
 247     // force secure URLs
 248     if (isset($params['enableSSL'])) {
 249       CRM_Core_BAO_Setting::setItem($params['enableSSL'],
 250         CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 251         'enableSSL'
 252       );
 253       unset($params['enableSSL']);
 254     }
 255     $settings = array_intersect_key($params, $this->_settings);
 256     $result = civicrm_api('setting', 'create', $settings + array('version' => 3));
 257     foreach ($settings as $setting => $settingGroup) {
 258       //@todo array_diff this
 259       unset($params[$setting]);
 260     }
 261     CRM_Core_BAO_ConfigSetting::create($params);
 262     CRM_Core_Session::setStatus(" ", ts('Changes Saved'), "success");
 263   }
 264
 265   public function rebuildMenu() {
 266     // ensure config is set with new values
 267     $config = CRM_Core_Config::singleton(TRUE, TRUE);
 268
 269     // rebuild menu items
 270     CRM_Core_Menu::store();
 271
 272     // also delete the IDS file so we can write a new correct one on next load
 273     $configFile = $config->uploadDir . 'Config.IDS.ini';
 274     @unlink($configFile);
 275   }
 276 }