3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
38 * file contains functions used in civicrm configuration
41 class CRM_Core_BAO_ConfigSetting
{
44 * Function to create civicrm settings. This is the same as add but it clears the cache and
45 * reloads the config object
47 * @params array $params associated array of civicrm variables
52 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 * Function to add civicrm settings
63 * @params array $params associated array of civicrm variables
68 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 * Function to fix civicrm setting variables
144 * @params array $params associated array of civicrm variables
149 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 * Function to format the array containing before inserting in db
176 * @param array $params associated array of civicrm variables(submitted)
177 * @param array $values associated array of civicrm variables stored in db
182 static function formatParams(&$params, &$values) {
183 if (empty($params) ||
189 foreach ($params as $key => $val) {
190 if (array_key_exists($key, $values)) {
191 unset($values[$key]);
194 $params = array_merge($params, $values);
199 * Function to retrieve the settings values from db
201 * @return array $defaults
204 static function retrieve(&$defaults) {
205 $domain = new CRM_Core_DAO_Domain();
207 //we are initializing config, really can't use, CRM-7863
209 if (defined('CIVICRM_UF') && CIVICRM_UF
== 'Joomla') {
213 if (CRM_Core_Config
::isUpgradeMode()) {
214 $domain->selectAdd('config_backend');
216 elseif (CRM_Utils_Array
::value($urlVar, $_GET) == 'admin/modules/list/confirm') {
217 $domain->selectAdd('config_backend', 'locales');
220 $domain->selectAdd('config_backend, locales, locale_custom_strings');
223 $domain->id
= CRM_Core_Config
::domainID();
225 if ($domain->config_backend
) {
226 $defaults = unserialize($domain->config_backend
);
227 if ($defaults === FALSE ||
!is_array($defaults)) {
232 $skipVars = self
::skipVars();
233 foreach ($skipVars as $skip) {
234 if (array_key_exists($skip, $defaults)) {
235 unset($defaults[$skip]);
239 // check if there are any locale strings
240 if ($domain->locale_custom_strings
) {
241 $defaults['localeCustomStrings'] = unserialize($domain->locale_custom_strings
);
244 $defaults['localeCustomStrings'] = NULL;
247 // are we in a multi-language setup?
248 $multiLang = $domain->locales ?
TRUE : FALSE;
250 // set the current language
253 $session = CRM_Core_Session
::singleton();
255 // on multi-lang sites based on request and civicrm_uf_match
257 $lcMessagesRequest = CRM_Utils_Request
::retrieve('lcMessages', 'String', $this);
258 $languageLimit = array();
259 if (array_key_exists('languageLimit', $defaults) && is_array($defaults['languageLimit'])) {
260 $languageLimit = $defaults['languageLimit'];
263 if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
264 $lcMessages = $lcMessagesRequest;
266 //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
267 CRM_Core_BAO_Cache
::deleteGroup('navigation');
270 $lcMessagesRequest = NULL;
273 if (!$lcMessagesRequest) {
274 $lcMessagesSession = $session->get('lcMessages');
275 if (in_array($lcMessagesSession, array_keys($languageLimit))) {
276 $lcMessages = $lcMessagesSession;
279 $lcMessagesSession = NULL;
283 if ($lcMessagesRequest) {
284 $ufm = new CRM_Core_DAO_UFMatch();
285 $ufm->contact_id
= $session->get('userID');
286 if ($ufm->find(TRUE)) {
287 $ufm->language
= $lcMessages;
290 $session->set('lcMessages', $lcMessages);
293 if (!$lcMessages and $session->get('userID')) {
294 $ufm = new CRM_Core_DAO_UFMatch();
295 $ufm->contact_id
= $session->get('userID');
296 if ($ufm->find(TRUE) &&
297 in_array($ufm->language
, array_keys($languageLimit))
299 $lcMessages = $ufm->language
;
301 $session->set('lcMessages', $lcMessages);
306 // try to inherit the language from the hosting CMS
307 if (CRM_Utils_Array
::value('inheritLocale', $defaults)) {
308 // FIXME: On multilanguage installs, CRM_Utils_System::getUFLocale() in many cases returns nothing if $dbLocale is not set
309 $dbLocale = $multiLang ?
"_{$defaults['lcMessages']}" : '';
310 $lcMessages = CRM_Utils_System
::getUFLocale();
311 if ($domain->locales
and !in_array($lcMessages, explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
319 // update config lcMessages - CRM-5027 fixed.
320 $defaults['lcMessages'] = $lcMessages;
323 // if a single-lang site or the above didn't yield a result, use default
324 $lcMessages = CRM_Utils_Array
::value( 'lcMessages', $defaults );
327 // set suffix for table names - use views if more than one language
328 $dbLocale = $multiLang ?
"_{$lcMessages}" : '';
330 // FIXME: an ugly hack to fix CRM-4041
332 $tsLocale = $lcMessages;
334 // FIXME: as bad aplace as any to fix CRM-5428
335 // (to be moved to a sane location along with the above)
336 if (function_exists('mb_internal_encoding')) {
337 mb_internal_encoding('UTF-8');
341 // dont add if its empty
342 if (!empty($defaults)) {
343 // retrieve directory and url preferences also
344 CRM_Core_BAO_Setting
::retrieveDirectoryAndURLPreferences($defaults);
346 // Pickup enabled-components from settings table if found.
347 $enableComponents = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components', NULL, array());
348 if (!empty($enableComponents)) {
349 $defaults['enableComponents'] = $enableComponents;
351 $components = CRM_Core_Component
::getComponents();
352 $enabledComponentIDs = array();
353 foreach ($defaults['enableComponents'] as $name) {
354 $enabledComponentIDs[] = $components[$name]->componentID
;
356 $defaults['enableComponentIDs'] = $enabledComponentIDs;
361 static function getConfigSettings() {
362 $config = CRM_Core_Config
::singleton();
364 $url = $dir = $siteName = $siteRoot = NULL;
365 if ($config->userFramework
== 'Joomla') {
367 '|administrator/components/com_civicrm/civicrm/|',
369 $config->userFrameworkResourceURL
372 // lets use imageUploadDir since we dont mess around with its values
373 // in the config object, lets kep it a bit generic since folks
374 // might have different values etc
376 '|civicrm/templates_c/.*$|',
378 $config->templateCompileDir
380 $siteRoot = preg_replace(
381 '|/media/civicrm/.*$|',
383 $config->imageUploadDir
386 else if ($config->userFramework
== 'WordPress') {
388 '|wp-content/plugins/civicrm/civicrm/|',
390 $config->userFrameworkResourceURL
393 // lets use imageUploadDir since we dont mess around with its values
394 // in the config object, lets kep it a bit generic since folks
395 // might have different values etc
397 '|civicrm/templates_c/.*$|',
399 $config->templateCompileDir
401 $siteRoot = preg_replace(
402 '|/wp-content/plugins/files/civicrm/.*$|',
404 $config->imageUploadDir
409 '|sites/[\w\.\-\_]+/modules/civicrm/|',
411 $config->userFrameworkResourceURL
414 // lets use imageUploadDir since we dont mess around with its values
415 // in the config object, lets kep it a bit generic since folks
416 // might have different values etc
418 '|/files/civicrm/.*$|',
420 $config->imageUploadDir
425 '|/sites/([\w\.\-\_]+)/|',
426 $config->imageUploadDir
,
429 $siteName = $matches[1];
431 $siteName = "/sites/$siteName/";
432 $siteNamePos = strpos($dir, $siteName);
433 if ($siteNamePos !== FALSE) {
434 $siteRoot = substr($dir, 0, $siteNamePos);
441 return array($url, $dir, $siteName, $siteRoot);
445 * Return likely default settings
446 * @return array site settings
448 * - $dir Base Directory
452 static function getBestGuessSettings() {
453 $config = CRM_Core_Config
::singleton();
455 '|civicrm/templates_c/.*$|',
457 $config->templateCompileDir
460 list($url, $siteName, $siteRoot) = $config->userSystem
->getDefaultSiteSettings($dir);
461 return array($url, $dir, $siteName, $siteRoot);
464 static function doSiteMove($defaultValues = array() ) {
465 $moveStatus = ts('Beginning site move process...') . '<br />';
466 // get the current and guessed values
467 list($oldURL, $oldDir, $oldSiteName, $oldSiteRoot) = self
::getConfigSettings();
468 list($newURL, $newDir, $newSiteName, $newSiteRoot) = self
::getBestGuessSettings();
471 // retrieve these values from the argument list
472 $variables = array('URL', 'Dir', 'SiteName', 'SiteRoot', 'Val_1', 'Val_2', 'Val_3');
473 $states = array('old', 'new');
474 foreach ($variables as $varSuffix) {
475 foreach ($states as $state) {
476 $var = "{$state}{$varSuffix}";
478 if (isset($defaultValues[$var])) {
479 $
$var = $defaultValues[$var];
485 $
$var = CRM_Utils_Request
::retrieve($var,
487 CRM_Core_DAO
::$_nullArray,
495 $from = $to = array();
496 foreach ($variables as $varSuffix) {
497 $oldVar = "old{$varSuffix}";
498 $newVar = "new{$varSuffix}";
499 //skip it if either is empty or both are exactly the same
510 SELECT config_backend
514 $params = array(1 => array(CRM_Core_Config
::domainID(), 'Integer'));
515 $configBackend = CRM_Core_DAO
::singleValueQuery($sql, $params);
516 if (!$configBackend) {
517 CRM_Core_Error
::fatal(ts('Returning early due to unexpected error - civicrm_domain.config_backend column value is NULL. Try visiting CiviCRM Home page.'));
519 $configBackend = unserialize($configBackend);
521 $configBackend = str_replace($from,
526 $configBackend = serialize($configBackend);
528 UPDATE civicrm_domain
529 SET config_backend = %2
532 $params[2] = array($configBackend, 'String');
533 CRM_Core_DAO
::executeQuery($sql, $params);
535 // Apply the changes to civicrm_option_values
536 $optionGroups = array('url_preferences', 'directory_preferences');
537 foreach ($optionGroups as $option) {
538 foreach ($variables as $varSuffix) {
539 $oldVar = "old{$varSuffix}";
540 $newVar = "new{$varSuffix}";
545 if ($from && $to && $from != $to) {
547 UPDATE civicrm_option_value
548 SET value = REPLACE(value, %1, %2)
549 WHERE option_group_id = (
551 FROM civicrm_option_group
554 $params = array(1 => array($from, 'String'),
555 2 => array($to, 'String'),
556 3 => array($option, 'String'),
558 CRM_Core_DAO
::executeQuery($sql, $params);
563 $moveStatus .= ts('Directory and Resource URLs have been updated in the moved database to reflect current site location.') . '<br />';
565 $config = CRM_Core_Config
::singleton();
567 // clear the template_c and upload directory also
568 $config->cleanup(3, TRUE);
569 $moveStatus .= ts('Template cache and upload directory have been cleared.') . '<br />';
572 CRM_Core_Config
::clearDBCache();
573 $moveStatus .= ts('Database cache tables cleared.') . '<br />';
575 $resetSessionTable = CRM_Utils_Request
::retrieve('resetSessionTable',
577 CRM_Core_DAO
::$_nullArray,
582 if ($config->userSystem
->is_drupal
&&
585 db_query("DELETE FROM {sessions} WHERE 1");
586 $moveStatus .= ts('Drupal session table cleared.') . '<br />';
589 $session = CRM_Core_Session
::singleton();
591 $moveStatus .= ts('Session has been reset.') . '<br />';
598 * takes a componentName and enables it in the config
599 * Primarily used during unit testing
601 * @param string $componentName name of the component to be enabled, needs to be valid
603 * @return boolean - true if valid component name and enabling succeeds, else false
606 static function enableComponent($componentName) {
607 $config = CRM_Core_Config
::singleton();
608 if (in_array($componentName, $config->enableComponents
)) {
609 // component is already enabled
612 $components = CRM_Core_Component
::getComponents();
614 // return if component does not exist
615 if (!array_key_exists($componentName, $components)) {
619 // get enabled-components from DB and add to the list
621 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components', NULL, array());
622 $enabledComponents[] = $componentName;
624 $enabledComponentIDs = array();
625 foreach ($enabledComponents as $name) {
626 $enabledComponentIDs[] = $components[$name]->componentID
;
629 // fix the config object
630 $config->enableComponents
= $enabledComponents;
631 $config->enableComponentIDs
= $enabledComponentIDs;
633 // also force reset of component array
634 CRM_Core_Component
::getEnabledComponents(TRUE);
637 CRM_Core_BAO_Setting
::setItem($enabledComponents,
638 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,'enable_components');
643 static function skipVars() {
645 'dsn', 'templateCompileDir',
648 'userFrameworkBaseURL', 'userFrameworkClass', 'userHookClass',
649 'userPermissionClass', 'userFrameworkURLVar', 'userFrameworkVersion',
650 'newBaseURL', 'newBaseDir', 'newSiteName', 'configAndLogDir',
651 'qfKey', 'gettextResourceDir', 'cleanURL',
652 'locale_custom_strings', 'localeCustomStrings',
653 'autocompleteContactSearch',
654 'autocompleteContactReference',