3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2014
38 * file contains functions used in civicrm configuration
41 class CRM_Core_BAO_ConfigSetting
{
44 * Create civicrm settings. This is the same as add but it clears the cache and
45 * reloads the config object
47 * @param array $params
48 * Associated array of civicrm variables.
52 public static function create($params) {
54 $cache = CRM_Utils_Cache
::singleton();
55 $cache->delete('CRM_Core_Config');
56 $cache->delete('CRM_Core_Config' . CRM_Core_Config
::domainID());
57 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
61 * Add civicrm settings.
63 * @param array $params
64 * Associated array of civicrm variables.
68 public static function add(&$params) {
69 self
::fixParams($params);
71 // also set a template url so js files can use this
73 $params['civiRelativeURL'] = CRM_Utils_System
::url('CIVI_BASE_TEMPLATE');
74 $params['civiRelativeURL']
78 $params['civiRelativeURL']
81 // also add the version number for use by template / js etc
82 $params['civiVersion'] = CRM_Utils_System
::version();
84 $domain = new CRM_Core_DAO_Domain();
85 $domain->id
= CRM_Core_Config
::domainID();
87 if ($domain->config_backend
) {
88 $values = unserialize($domain->config_backend
);
89 self
::formatParams($params, $values);
93 if (isset($params['localeCustomStrings']) &&
94 is_array($params['localeCustomStrings'])
96 $domain->locale_custom_strings
= serialize($params['localeCustomStrings']);
99 // unset any of the variables we read from file that should not be stored in the database
100 // the username and certpath are stored flat with _test and _live
102 $skipVars = self
::skipVars();
103 foreach ($skipVars as $var) {
104 unset($params[$var]);
107 CRM_Core_BAO_Setting
::fixAndStoreDirAndURL($params);
109 // also skip all Dir Params, we dont need to store those in the DB!
110 foreach ($params as $name => $val) {
111 if (substr($name, -3) == 'Dir') {
112 unset($params[$name]);
116 //keep user preferred language upto date, CRM-7746
117 $session = CRM_Core_Session
::singleton();
118 $lcMessages = CRM_Utils_Array
::value('lcMessages', $params);
119 if ($lcMessages && $session->get('userID')) {
120 $languageLimit = CRM_Utils_Array
::value('languageLimit', $params);
121 if (is_array($languageLimit) &&
122 !in_array($lcMessages, array_keys($languageLimit))
124 $lcMessages = $session->get('lcMessages');
127 $ufm = new CRM_Core_DAO_UFMatch();
128 $ufm->contact_id
= $session->get('userID');
129 if ($lcMessages && $ufm->find(TRUE)) {
130 $ufm->language
= $lcMessages;
132 $session->set('lcMessages', $lcMessages);
133 $params['lcMessages'] = $lcMessages;
137 $domain->config_backend
= serialize($params);
142 * Fix civicrm setting variables.
144 * @param array $params
145 * Associated array of civicrm variables.
149 public static function fixParams(&$params) {
150 // in our old civicrm.settings.php we were using ISO code for country and
151 // province limit, now we have changed it to use ids
153 $countryIsoCodes = CRM_Core_PseudoConstant
::countryIsoCode();
155 $specialArray = array('countryLimit', 'provinceLimit');
157 foreach ($params as $key => $value) {
158 if (in_array($key, $specialArray) && is_array($value)) {
159 foreach ($value as $k => $val) {
160 if (!is_numeric($val)) {
161 $params[$key][$k] = array_search($val, $countryIsoCodes);
165 elseif ($key == 'defaultContactCountry') {
166 if (!is_numeric($value)) {
167 $params[$key] = array_search($value, $countryIsoCodes);
174 * Format the array containing before inserting in db.
176 * @param array $params
177 * Associated array of civicrm variables(submitted).
178 * @param array $values
179 * Associated array of civicrm variables stored in db.
183 public static function formatParams(&$params, &$values) {
184 if (empty($params) ||
190 foreach ($params as $key => $val) {
191 if (array_key_exists($key, $values)) {
192 unset($values[$key]);
195 $params = array_merge($params, $values);
200 * Retrieve the settings values from db.
206 public static function retrieve(&$defaults) {
207 $domain = new CRM_Core_DAO_Domain();
209 //we are initializing config, really can't use, CRM-7863
211 if (defined('CIVICRM_UF') && CIVICRM_UF
== 'Joomla') {
215 if (CRM_Core_Config
::isUpgradeMode()) {
216 $domain->selectAdd('config_backend');
218 elseif (CRM_Utils_Array
::value($urlVar, $_GET) == 'admin/modules/list/confirm') {
219 $domain->selectAdd('config_backend', 'locales');
222 $domain->selectAdd('config_backend, locales, locale_custom_strings');
225 $domain->id
= CRM_Core_Config
::domainID();
227 if ($domain->config_backend
) {
228 $defaults = unserialize($domain->config_backend
);
229 if ($defaults === FALSE ||
!is_array($defaults)) {
234 $skipVars = self
::skipVars();
235 foreach ($skipVars as $skip) {
236 if (array_key_exists($skip, $defaults)) {
237 unset($defaults[$skip]);
241 // check if there are any locale strings
242 if ($domain->locale_custom_strings
) {
243 $defaults['localeCustomStrings'] = unserialize($domain->locale_custom_strings
);
246 $defaults['localeCustomStrings'] = NULL;
249 // are we in a multi-language setup?
250 $multiLang = $domain->locales ?
TRUE : FALSE;
252 // set the current language
255 $session = CRM_Core_Session
::singleton();
257 // on multi-lang sites based on request and civicrm_uf_match
259 $lcMessagesRequest = CRM_Utils_Request
::retrieve('lcMessages', 'String', $this);
260 $languageLimit = array();
261 if (array_key_exists('languageLimit', $defaults) && is_array($defaults['languageLimit'])) {
262 $languageLimit = $defaults['languageLimit'];
265 if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
266 $lcMessages = $lcMessagesRequest;
268 //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
269 CRM_Core_BAO_Cache
::deleteGroup('navigation');
272 $lcMessagesRequest = NULL;
275 if (!$lcMessagesRequest) {
276 $lcMessagesSession = $session->get('lcMessages');
277 if (in_array($lcMessagesSession, array_keys($languageLimit))) {
278 $lcMessages = $lcMessagesSession;
281 $lcMessagesSession = NULL;
285 if ($lcMessagesRequest) {
286 $ufm = new CRM_Core_DAO_UFMatch();
287 $ufm->contact_id
= $session->get('userID');
288 if ($ufm->find(TRUE)) {
289 $ufm->language
= $lcMessages;
292 $session->set('lcMessages', $lcMessages);
295 if (!$lcMessages and $session->get('userID')) {
296 $ufm = new CRM_Core_DAO_UFMatch();
297 $ufm->contact_id
= $session->get('userID');
298 if ($ufm->find(TRUE) &&
299 in_array($ufm->language
, array_keys($languageLimit))
301 $lcMessages = $ufm->language
;
303 $session->set('lcMessages', $lcMessages);
308 // try to inherit the language from the hosting CMS
309 if (!empty($defaults['inheritLocale'])) {
310 // FIXME: On multilanguage installs, CRM_Utils_System::getUFLocale() in many cases returns nothing if $dbLocale is not set
311 $dbLocale = $multiLang ?
"_{$defaults['lcMessages']}" : '';
312 $lcMessages = CRM_Utils_System
::getUFLocale();
313 if ($domain->locales
and !in_array($lcMessages, explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
321 if (empty($lcMessages)) {
322 //CRM-11993 - if a single-lang site, use default
323 $lcMessages = CRM_Utils_Array
::value('lcMessages', $defaults);
326 // set suffix for table names - use views if more than one language
327 $dbLocale = $multiLang ?
"_{$lcMessages}" : '';
329 // FIXME: an ugly hack to fix CRM-4041
331 $tsLocale = $lcMessages;
333 // FIXME: as bad aplace as any to fix CRM-5428
334 // (to be moved to a sane location along with the above)
335 if (function_exists('mb_internal_encoding')) {
336 mb_internal_encoding('UTF-8');
340 // dont add if its empty
341 if (!empty($defaults)) {
342 // retrieve directory and url preferences also
343 CRM_Core_BAO_Setting
::retrieveDirectoryAndURLPreferences($defaults);
345 // Pickup enabled-components from settings table if found.
346 $enableComponents = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components', NULL, array());
347 if (!empty($enableComponents)) {
348 $defaults['enableComponents'] = $enableComponents;
350 $components = CRM_Core_Component
::getComponents();
351 $enabledComponentIDs = array();
352 foreach ($defaults['enableComponents'] as $name) {
353 $enabledComponentIDs[] = $components[$name]->componentID
;
355 $defaults['enableComponentIDs'] = $enabledComponentIDs;
363 public static function getConfigSettings() {
364 $config = CRM_Core_Config
::singleton();
366 $url = $dir = $siteName = $siteRoot = NULL;
367 if ($config->userFramework
== 'Joomla') {
369 '|administrator/components/com_civicrm/civicrm/|',
371 $config->userFrameworkResourceURL
374 // lets use imageUploadDir since we dont mess around with its values
375 // in the config object, lets kep it a bit generic since folks
376 // might have different values etc
378 //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
379 if (DIRECTORY_SEPARATOR
== '\\') {
381 '|civicrm[/\\\\]templates_c[/\\\\].*$|',
383 $config->templateCompileDir
388 '|civicrm/templates_c/.*$|',
390 $config->templateCompileDir
394 $siteRoot = preg_replace(
395 '|/media/civicrm/.*$|',
397 $config->imageUploadDir
400 elseif ($config->userFramework
== 'WordPress') {
402 '|wp-content/plugins/civicrm/civicrm/|',
404 $config->userFrameworkResourceURL
407 // lets use imageUploadDir since we dont mess around with its values
408 // in the config object, lets kep it a bit generic since folks
409 // might have different values etc
411 //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
412 if (DIRECTORY_SEPARATOR
== '\\') {
414 '|civicrm[/\\\\]templates_c[/\\\\].*$|',
416 $config->templateCompileDir
421 '|civicrm/templates_c/.*$|',
423 $config->templateCompileDir
427 $siteRoot = preg_replace(
428 '|/wp-content/plugins/files/civicrm/.*$|',
430 $config->imageUploadDir
435 '|sites/[\w\.\-\_]+/modules/civicrm/|',
437 $config->userFrameworkResourceURL
440 // lets use imageUploadDir since we dont mess around with its values
441 // in the config object, lets kep it a bit generic since folks
442 // might have different values etc
444 //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
445 if (DIRECTORY_SEPARATOR
== '\\') {
447 '|[/\\\\]files[/\\\\]civicrm[/\\\\].*$|',
449 $config->imageUploadDir
454 '|/files/civicrm/.*$|',
456 $config->imageUploadDir
462 '|/sites/([\w\.\-\_]+)/|',
463 $config->imageUploadDir
,
466 $siteName = $matches[1];
468 $siteName = "/sites/$siteName/";
469 $siteNamePos = strpos($dir, $siteName);
470 if ($siteNamePos !== FALSE) {
471 $siteRoot = substr($dir, 0, $siteNamePos);
477 return array($url, $dir, $siteName, $siteRoot);
481 * Return likely default settings.
485 * - $dir Base Directory
489 public static function getBestGuessSettings() {
490 $config = CRM_Core_Config
::singleton();
492 //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
493 if (DIRECTORY_SEPARATOR
== '\\') {
494 $needle = 'civicrm[/\\\\]templates_c[/\\\\].*$';
497 $needle = 'civicrm/templates_c/.*$';
503 $config->templateCompileDir
506 list($url, $siteName, $siteRoot) = $config->userSystem
->getDefaultSiteSettings($dir);
507 return array($url, $dir, $siteName, $siteRoot);
511 * @param array $defaultValues
516 public static function doSiteMove($defaultValues = array()) {
517 $moveStatus = ts('Beginning site move process...') . '<br />';
518 // get the current and guessed values
519 list($oldURL, $oldDir, $oldSiteName, $oldSiteRoot) = self
::getConfigSettings();
520 list($newURL, $newDir, $newSiteName, $newSiteRoot) = self
::getBestGuessSettings();
522 // retrieve these values from the argument list
523 $variables = array('URL', 'Dir', 'SiteName', 'SiteRoot', 'Val_1', 'Val_2', 'Val_3');
524 $states = array('old', 'new');
525 foreach ($variables as $varSuffix) {
526 foreach ($states as $state) {
527 $var = "{$state}{$varSuffix}";
529 if (isset($defaultValues[$var])) {
530 $
$var = $defaultValues[$var];
536 $
$var = CRM_Utils_Request
::retrieve($var,
538 CRM_Core_DAO
::$_nullArray,
546 $from = $to = array();
547 foreach ($variables as $varSuffix) {
548 $oldVar = "old{$varSuffix}";
549 $newVar = "new{$varSuffix}";
550 //skip it if either is empty or both are exactly the same
561 SELECT config_backend
565 $params = array(1 => array(CRM_Core_Config
::domainID(), 'Integer'));
566 $configBackend = CRM_Core_DAO
::singleValueQuery($sql, $params);
567 if (!$configBackend) {
568 CRM_Core_Error
::fatal(ts('Returning early due to unexpected error - civicrm_domain.config_backend column value is NULL. Try visiting CiviCRM Home page.'));
570 $configBackend = unserialize($configBackend);
572 $configBackend = str_replace($from,
577 $configBackend = serialize($configBackend);
579 UPDATE civicrm_domain
580 SET config_backend = %2
583 $params[2] = array($configBackend, 'String');
584 CRM_Core_DAO
::executeQuery($sql, $params);
586 // Apply the changes to civicrm_option_values
587 $optionGroups = array('url_preferences', 'directory_preferences');
588 foreach ($optionGroups as $option) {
589 foreach ($variables as $varSuffix) {
590 $oldVar = "old{$varSuffix}";
591 $newVar = "new{$varSuffix}";
596 if ($from && $to && $from != $to) {
598 UPDATE civicrm_option_value
599 SET value = REPLACE(value, %1, %2)
600 WHERE option_group_id = (
602 FROM civicrm_option_group
606 1 => array($from, 'String'),
607 2 => array($to, 'String'),
608 3 => array($option, 'String'),
610 CRM_Core_DAO
::executeQuery($sql, $params);
616 ts('Directory and Resource URLs have been updated in the moved database to reflect current site location.') .
619 $config = CRM_Core_Config
::singleton();
621 // clear the template_c and upload directory also
622 $config->cleanup(3, TRUE);
623 $moveStatus .= ts('Template cache and upload directory have been cleared.') . '<br />';
626 CRM_Core_Config
::clearDBCache();
627 $moveStatus .= ts('Database cache tables cleared.') . '<br />';
629 $resetSessionTable = CRM_Utils_Request
::retrieve('resetSessionTable',
631 CRM_Core_DAO
::$_nullArray,
636 if ($config->userSystem
->is_drupal
&&
639 db_query("DELETE FROM {sessions} WHERE 1");
640 $moveStatus .= ts('Drupal session table cleared.') . '<br />';
643 $session = CRM_Core_Session
::singleton();
645 $moveStatus .= ts('Session has been reset.') . '<br />';
652 * Takes a componentName and enables it in the config.
653 * Primarily used during unit testing
655 * @param string $componentName
656 * Name of the component to be enabled, needs to be valid.
659 * true if valid component name and enabling succeeds, else false
661 public static function enableComponent($componentName) {
662 $config = CRM_Core_Config
::singleton();
663 if (in_array($componentName, $config->enableComponents
)) {
664 // component is already enabled
668 // return if component does not exist
669 if (!array_key_exists($componentName, CRM_Core_Component
::getComponents())) {
673 // get enabled-components from DB and add to the list
675 = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components', NULL, array());
676 $enabledComponents[] = $componentName;
678 self
::setEnabledComponents($enabledComponents);
684 * Disable specified component.
686 * @param string $componentName
690 public static function disableComponent($componentName) {
691 $config = CRM_Core_Config
::singleton();
692 if (!in_array($componentName, $config->enableComponents
) ||
693 !array_key_exists($componentName, CRM_Core_Component
::getComponents())
695 // Post-condition is satisfied.
699 // get enabled-components from DB and add to the list
701 = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components', NULL, array());
702 $enabledComponents = array_diff($enabledComponents, array($componentName));
704 self
::setEnabledComponents($enabledComponents);
710 * Set enabled components.
712 * @param array $enabledComponents
714 public static function setEnabledComponents($enabledComponents) {
715 $config = CRM_Core_Config
::singleton();
716 $components = CRM_Core_Component
::getComponents();
718 $enabledComponentIDs = array();
719 foreach ($enabledComponents as $name) {
720 $enabledComponentIDs[] = $components[$name]->componentID
;
723 // fix the config object
724 $config->enableComponents
= $enabledComponents;
725 $config->enableComponentIDs
= $enabledComponentIDs;
727 // also force reset of component array
728 CRM_Core_Component
::getEnabledComponents(TRUE);
731 CRM_Core_BAO_Setting
::setItem($enabledComponents,
732 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components');
738 public static function skipVars() {
741 'templateCompileDir',
744 'userFrameworkBaseURL',
745 'userFrameworkClass',
747 'userPermissionClass',
748 'userFrameworkURLVar',
749 'userFrameworkVersion',
755 'gettextResourceDir',
757 'locale_custom_strings',
758 'localeCustomStrings',
759 'autocompleteContactSearch',
760 'autocompleteContactReference',