CRM/Admin/Form/Setting.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * This class generates form components generic to CiviCRM settings.
  36  */
  37 class CRM_Admin_Form_Setting extends CRM_Core_Form {
  38
  39   protected $_settings = array();
  40
  41   /**
  42    * Set default values for the form.
  43    *
  44    * Default values are retrieved from the database.
  45    */
  46   public function setDefaultValues() {
  47     if (!$this->_defaults) {
  48       $this->_defaults = array();
  49       $formArray = array('Component', 'Localization');
  50       $formMode = FALSE;
  51       if (in_array($this->_name, $formArray)) {
  52         $formMode = TRUE;
  53       }
  54
  55       CRM_Core_BAO_ConfigSetting::retrieve($this->_defaults);
  56
  57       // we can handle all the ones defined in the metadata here. Others to be converted
  58       foreach ($this->_settings as $setting => $group) {
  59         $this->_defaults[$setting] = civicrm_api('setting', 'getvalue', array(
  60             'version' => 3,
  61             'name' => $setting,
  62             'group' => $group,
  63           )
  64         );
  65       }
  66
  67       $this->_defaults['contact_autocomplete_options'] = self::getAutocompleteContactSearch();
  68       $this->_defaults['contact_reference_options'] = self::getAutocompleteContactReference();
  69       $this->_defaults['enableSSL'] = Civi::settings()->get('enableSSL');
  70       $this->_defaults['verifySSL'] = Civi::settings()->get('verifySSL');
  71       $this->_defaults['enableComponents'] = Civi::settings()->get('enable_components');
  72     }
  73
  74     return $this->_defaults;
  75   }
  76
  77   /**
  78    * Build the form object.
  79    */
  80   public function buildQuickForm() {
  81     $session = CRM_Core_Session::singleton();
  82     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
  83     $args = func_get_args();
  84     $check = reset($args);
  85     $this->addButtons(array(
  86         array(
  87           'type' => 'next',
  88           'name' => ts('Save'),
  89           'isDefault' => TRUE,
  90         ),
  91         array(
  92           'type' => 'cancel',
  93           'name' => ts('Cancel'),
  94         ),
  95       )
  96     );
  97
  98     $descriptions = array();
  99     foreach ($this->_settings as $setting => $group) {
 100       $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
 101       $props = $settingMetaData['values'][$setting];
 102       if (isset($props['quick_form_type'])) {
 103         if (isset($props['pseudoconstant'])) {
 104           $options = civicrm_api3('Setting', 'getoptions', array(
 105             'field' => $setting,
 106           ));
 107         }
 108         else {
 109           $options = NULL;
 110         }
 111
 112         $add = 'add' . $props['quick_form_type'];
 113         if ($add == 'addElement') {
 114           $this->$add(
 115             $props['html_type'],
 116             $setting,
 117             ts($props['title']),
 118             ($options !== NULL) ? $options['values'] : CRM_Utils_Array::value('html_attributes', $props, array()),
 119             ($options !== NULL) ? CRM_Utils_Array::value('html_attributes', $props, array()) : NULL
 120           );
 121         }
 122         elseif ($add == 'addSelect') {
 123           $this->addElement('select', $setting, ts($props['title']), $options['values'], CRM_Utils_Array::value('html_attributes', $props));
 124         }
 125         elseif ($add == 'addCheckBox') {
 126           $this->addCheckBox($setting, ts($props['title']), $options['values'], NULL, CRM_Utils_Array::value('html_attributes', $props), NULL, NULL, array('&nbsp;&nbsp;'));
 127         }
 128         elseif ($add == 'addChainSelect') {
 129           $this->addChainSelect($setting, array(
 130             'label' => ts($props['title']),
 131           ));
 132         }
 133         elseif ($add == 'addMonthDay') {
 134           $this->add('date', $setting, ts($props['title']), CRM_Core_SelectValues::date(NULL, 'M d'));
 135         }
 136         else {
 137           $this->$add($setting, ts($props['title']));
 138         }
 139         // Migrate to using an array as easier in smart...
 140         $descriptions[$setting] = ts($props['description']);
 141         $this->assign("{$setting}_description", ts($props['description']));
 142         if ($setting == 'max_attachments') {
 143           //temp hack @todo fix to get from metadata
 144           $this->addRule('max_attachments', ts('Value should be a positive number'), 'positiveInteger');
 145         }
 146         if ($setting == 'maxFileSize') {
 147           //temp hack
 148           $this->addRule('maxFileSize', ts('Value should be a positive number'), 'positiveInteger');
 149         }
 150
 151       }
 152     }
 153     $this->assign('setting_descriptions', $descriptions);
 154   }
 155
 156   /**
 157    * Get default entity.
 158    *
 159    * @return string
 160    */
 161   public function getDefaultEntity() {
 162     return 'Setting';
 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    * Common Process.
 177    *
 178    * @todo Document what I do.
 179    *
 180    * @param array $params
 181    */
 182   public function commonProcess(&$params) {
 183
 184     // save autocomplete search options
 185     if (!empty($params['contact_autocomplete_options'])) {
 186       Civi::settings()->set('contact_autocomplete_options',
 187         CRM_Utils_Array::implodePadded(array_keys($params['contact_autocomplete_options'])));
 188       unset($params['contact_autocomplete_options']);
 189     }
 190
 191     // save autocomplete contact reference options
 192     if (!empty($params['contact_reference_options'])) {
 193       Civi::settings()->set('contact_reference_options',
 194         CRM_Utils_Array::implodePadded(array_keys($params['contact_reference_options'])));
 195       unset($params['contact_reference_options']);
 196     }
 197
 198     // save components to be enabled
 199     if (array_key_exists('enableComponents', $params)) {
 200       civicrm_api3('setting', 'create', array(
 201         'enable_components' => $params['enableComponents'],
 202       ));
 203       unset($params['enableComponents']);
 204     }
 205
 206     foreach (array('verifySSL', 'enableSSL') as $name) {
 207       if (isset($params[$name])) {
 208         Civi::settings()->set($name, $params[$name]);
 209         unset($params[$name]);
 210       }
 211     }
 212     $settings = array_intersect_key($params, $this->_settings);
 213     $result = civicrm_api('setting', 'create', $settings + array('version' => 3));
 214     foreach ($settings as $setting => $settingGroup) {
 215       //@todo array_diff this
 216       unset($params[$setting]);
 217     }
 218     if (!empty($result['error_message'])) {
 219       CRM_Core_Session::setStatus($result['error_message'], ts('Save Failed'), 'error');
 220     }
 221
 222     //CRM_Core_BAO_ConfigSetting::create($params);
 223     $params = CRM_Core_BAO_ConfigSetting::filterSkipVars($params);
 224     if (!empty($params)) {
 225       CRM_Core_Error::fatal('Unrecognized setting. This may be a config field which has not been properly migrated to a setting. (' . implode(', ', array_keys($params)) . ')');
 226     }
 227
 228     CRM_Core_Config::clearDBCache();
 229     CRM_Utils_System::flushCache();
 230     CRM_Core_Resources::singleton()->resetCacheCode();
 231
 232     CRM_Core_Session::setStatus(" ", ts('Changes Saved'), "success");
 233   }
 234
 235   public function rebuildMenu() {
 236     // ensure config is set with new values
 237     $config = CRM_Core_Config::singleton(TRUE, TRUE);
 238
 239     // rebuild menu items
 240     CRM_Core_Menu::store();
 241
 242     // also delete the IDS file so we can write a new correct one on next load
 243     $configFile = $config->uploadDir . 'Config.IDS.ini';
 244     @unlink($configFile);
 245   }
 246
 247   /**
 248    * Ugh, this shouldn't exist.
 249    *
 250    * Get the selected values of "contact_reference_options" formatted for checkboxes.
 251    *
 252    * @return array
 253    */
 254   public static function getAutocompleteContactReference() {
 255     $cRlist = array_flip(CRM_Core_OptionGroup::values('contact_reference_options',
 256       FALSE, FALSE, TRUE, NULL, 'name'
 257     ));
 258     $cRlistEnabled = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 259       'contact_reference_options'
 260     );
 261     $cRSearchFields = array();
 262     if (!empty($cRlist) && !empty($cRlistEnabled)) {
 263       $cRSearchFields = array_combine($cRlist, $cRlistEnabled);
 264     }
 265     return array(
 266       '1' => 1,
 267     ) + $cRSearchFields;
 268   }
 269
 270   /**
 271    * Ugh, this shouldn't exist.
 272    *
 273    * Get the selected values of "contact_autocomplete_options" formatted for checkboxes.
 274    *
 275    * @return array
 276    */
 277   public static function getAutocompleteContactSearch() {
 278     $list = array_flip(CRM_Core_OptionGroup::values('contact_autocomplete_options',
 279       FALSE, FALSE, TRUE, NULL, 'name'
 280     ));
 281     $listEnabled = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 282       'contact_autocomplete_options'
 283     );
 284     $autoSearchFields = array();
 285     if (!empty($list) && !empty($listEnabled)) {
 286       $autoSearchFields = array_combine($list, $listEnabled);
 287     }
 288     //Set defaults for autocomplete and contact reference options
 289     return array(
 290       '1' => 1,
 291     ) + $autoSearchFields;
 292   }
 293
 294 }