3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 +--------------------------------------------------------------------+
29 * Config handles all the run time configuration changes that the system needs to deal with.
31 * Typically we'll have different values for a user's sandbox, a qa sandbox and a production area.
32 * The default values in general, should reflect production values (minimizes chances of screwing up)
35 * @copyright CiviCRM LLC (c) 2004-2015
38 require_once 'Log.php';
39 require_once 'Mail.php';
41 require_once 'api/api.php';
44 * Class CRM_Core_Config
46 * @property CRM_Utils_System_Base $userSystem
47 * @property array $enableComponents
48 * @property array $languageLimit
49 * @property bool $debug
50 * @property bool $doNotResetCache
51 * @property string $maxFileSize
52 * @property string $defaultCurrency
53 * @property string $defaultCurrencySymbol
54 * @property string $lcMessages
55 * @property string $fieldSeparator
56 * @property string $userFramework
57 * @property string $verpSeparator
58 * @property string $dateFormatFull
59 * @property string $resourceBase
60 * @property string $dsn
61 * @property string $customTemplateDir
62 * @property string $defaultContactCountry
63 * @property string $defaultContactStateProvince
64 * @property string $monetaryDecimalPoint
65 * @property string $monetaryThousandSeparator
67 class CRM_Core_Config
extends CRM_Core_Config_MagicMerge
{
70 * The handle to the log that we are using
73 private static $_log = NULL;
76 * We only need one instance of this object. So we use the singleton
77 * pattern and cache the instance in this variable
79 * @var CRM_Core_Config
81 private static $_singleton = NULL;
84 * The constructor. Sets domain id if defined, otherwise assumes
85 * single instance installation.
87 public function __construct() {
88 parent
::__construct();
92 * Singleton function used to manage this object.
94 * @param bool $loadFromDB
95 * whether to load from the database.
97 * whether to force a reconstruction.
99 * @return CRM_Core_Config
101 public static function &singleton($loadFromDB = TRUE, $force = FALSE) {
102 if (self
::$_singleton === NULL ||
$force) {
103 $GLOBALS['civicrm_default_error_scope'] = CRM_Core_TemporaryErrorScope
::create(array('CRM_Core_Error', 'handle'));
104 $errorScope = CRM_Core_TemporaryErrorScope
::create(array('CRM_Core_Error', 'simpleHandler'));
106 if (defined('E_DEPRECATED')) {
107 error_reporting(error_reporting() & ~E_DEPRECATED
);
110 self
::$_singleton = new CRM_Core_Config();
111 \Civi\Core\Container
::boot($loadFromDB);
112 if ($loadFromDB && self
::$_singleton->dsn
) {
113 $domain = \CRM_Core_BAO_Domain
::getDomain();
114 \CRM_Core_BAO_ConfigSetting
::applyLocale(\Civi
::settings($domain->id
), $domain->locales
);
118 CRM_Utils_Hook
::config(self
::$_singleton);
119 self
::$_singleton->authenticate();
121 // Extreme backward compat: $config binds to active domain at moment of setup.
122 self
::$_singleton->getSettings();
124 Civi
::service('settings_manager')->useDefaults();
126 self
::$_singleton->handleFirstRun();
129 return self
::$_singleton;
133 * Returns the singleton logger for the application.
139 static public function &getLog() {
140 if (!isset(self
::$_log)) {
141 self
::$_log = Log
::singleton('display');
148 * Retrieve a mailer to send any mail from the application.
152 * @see Civi::service()
154 public static function getMailer() {
155 return Civi
::service('pear_mail');
159 * Deletes the web server writable directories.
162 * 1: clean templates_c, 2: clean upload, 3: clean both
165 public function cleanup($value, $rmdir = TRUE) {
166 $value = (int ) $value;
170 CRM_Utils_File
::cleanDir($this->templateCompileDir
, $rmdir);
171 CRM_Utils_File
::createDir($this->templateCompileDir
);
175 CRM_Utils_File
::cleanDir($this->uploadDir
);
176 CRM_Utils_File
::createDir($this->uploadDir
);
179 // Whether we delete/create or simply preserve directories, we should
180 // certainly make sure the restrictions are enforced.
182 $this->templateCompileDir
,
184 $this->configAndLogDir
,
185 $this->customFileUploadDir
,
187 if ($dir && is_dir($dir)) {
188 CRM_Utils_File
::restrictAccess($dir);
194 * Verify that the needed parameters are not null in the config.
196 * @param CRM_Core_Config $config (reference) the system config object
197 * @param array $required (reference) the parameters that need a value
201 public static function check(&$config, &$required) {
202 foreach ($required as $name) {
203 if (CRM_Utils_System
::isNull($config->$name)) {
211 * Reset the serialized array and recompute.
214 public function reset() {
215 $query = "UPDATE civicrm_domain SET config_backend = null";
216 CRM_Core_DAO
::executeQuery($query);
220 * This method should initialize auth sources.
222 public function authenticate() {
223 // make sure session is always initialised
224 $session = CRM_Core_Session
::singleton();
226 // for logging purposes, pass the userID to the db
227 $userID = $session->get('userID');
229 CRM_Core_DAO
::executeQuery('SET @civicrm_user_id = %1',
230 array(1 => array($userID, 'Integer'))
234 if ($session->get('userID') && !$session->get('authSrc')) {
235 $session->set('authSrc', CRM_Core_Permission
::AUTH_SRC_LOGIN
);
239 CRM_Contact_BAO_Contact_Permission
::initChecksumAuthSrc();
243 * One function to get domain ID.
245 * @param int $domainID
250 public static function domainID($domainID = NULL, $reset = FALSE) {
255 if ($reset ||
empty($domain)) {
256 $domain = defined('CIVICRM_DOMAIN_ID') ? CIVICRM_DOMAIN_ID
: 1;
263 * Do general cleanup of caches, temp directories and temp tables
266 * @param bool $sessionReset
268 public function cleanupCaches($sessionReset = TRUE) {
269 // cleanup templates_c directory
270 $this->cleanup(1, FALSE);
273 self
::clearDBCache();
274 CRM_Utils_System
::flushCache();
277 $session = CRM_Core_Session
::singleton();
283 * Do general cleanup of module permissions.
285 public function cleanupPermissions() {
286 $module_files = CRM_Extension_System
::singleton()->getMapper()->getActiveModuleFiles();
287 if ($this->userPermissionClass
->isModulePermissionSupported()) {
288 // Can store permissions -- so do it!
289 $this->userPermissionClass
->upgradePermissions(
290 CRM_Core_Permission
::basicPermissions()
294 // Cannot store permissions -- warn if any modules require them
295 $modules_with_perms = array();
296 foreach ($module_files as $module_file) {
297 $perms = $this->userPermissionClass
->getModulePermissions($module_file['prefix']);
298 if (!empty($perms)) {
299 $modules_with_perms[] = $module_file['prefix'];
302 if (!empty($modules_with_perms)) {
303 CRM_Core_Session
::setStatus(
304 ts('Some modules define permissions, but the CMS cannot store them: %1', array(1 => implode(', ', $modules_with_perms))),
305 ts('Permission Error'),
313 * Flush information about loaded modules.
315 public function clearModuleList() {
316 CRM_Extension_System
::singleton()->getCache()->flush();
317 CRM_Utils_Hook
::singleton(TRUE);
318 CRM_Core_PseudoConstant
::getModuleExtensions(TRUE);
319 CRM_Core_Module
::getAll(TRUE);
325 public static function clearDBCache() {
327 'TRUNCATE TABLE civicrm_acl_cache',
328 'TRUNCATE TABLE civicrm_acl_contact_cache',
329 'TRUNCATE TABLE civicrm_cache',
330 'TRUNCATE TABLE civicrm_prevnext_cache',
331 'UPDATE civicrm_group SET cache_date = NULL',
332 'TRUNCATE TABLE civicrm_group_contact_cache',
333 'TRUNCATE TABLE civicrm_menu',
334 'UPDATE civicrm_setting SET value = NULL WHERE name="navigation" AND contact_id IS NOT NULL',
335 'DELETE FROM civicrm_setting WHERE name="modulePaths"', // CRM-10543
338 foreach ($queries as $query) {
339 CRM_Core_DAO
::executeQuery($query);
342 // also delete all the import and export temp tables
343 self
::clearTempTables();
347 * Clear leftover temporary tables.
349 * This is called on upgrade, during tests and site move, from the cron and via clear caches in the UI.
351 * Currently the UI clear caches does not pass a time interval - which may need review as it does risk
352 * ripping the tables out from underneath a current action. This was considered but
353 * out-of-scope for CRM-16167
355 * @param string|bool $timeInterval
356 * Optional time interval for mysql date function.g '2 day'. This can be used to prevent
357 * tables created recently from being deleted.
359 public static function clearTempTables($timeInterval = FALSE) {
361 $dao = new CRM_Core_DAO();
363 SELECT TABLE_NAME as tableName
364 FROM INFORMATION_SCHEMA.TABLES
365 WHERE TABLE_SCHEMA = %1
367 TABLE_NAME LIKE 'civicrm_import_job_%'
368 OR TABLE_NAME LIKE 'civicrm_export_temp%'
369 OR TABLE_NAME LIKE 'civicrm_task_action_temp%'
370 OR TABLE_NAME LIKE 'civicrm_report_temp%'
374 $query .= " AND CREATE_TIME < DATE_SUB(NOW(), INTERVAL {$timeInterval})";
377 $tableDAO = CRM_Core_DAO
::executeQuery($query, array(1 => array($dao->database(), 'String')));
379 while ($tableDAO->fetch()) {
380 $tables[] = $tableDAO->tableName
;
382 if (!empty($tables)) {
383 $table = implode(',', $tables);
384 // drop leftover temporary tables
385 CRM_Core_DAO
::executeQuery("DROP TABLE $table");
390 * Check if running in upgrade mode.
392 * @param string $path
396 public static function isUpgradeMode($path = NULL) {
397 if (defined('CIVICRM_UPGRADE_ACTIVE')) {
402 // note: do not re-initialize config here, since this function is part of
403 // config initialization itself
405 if (defined('CIVICRM_UF') && CIVICRM_UF
== 'Joomla') {
409 $path = CRM_Utils_Array
::value($urlVar, $_GET);
412 if ($path && preg_match('/^civicrm\/upgrade(\/.*)?$/', $path)) {
420 * Is back office credit card processing enabled for this site - ie are there any installed processors that support
422 * This function is used for determining whether to show the submit credit card link, not for determining which processors to show, hence
426 public static function isEnabledBackOfficeCreditCardPayments() {
427 return CRM_Financial_BAO_PaymentProcessor
::hasPaymentProcessorSupporting(array('BackOffice'));
433 public function addressSequence() {
434 return CRM_Utils_Address
::sequence(Civi
::settings()->get('address_format'));
440 public function defaultContactCountry() {
441 return CRM_Core_BAO_Country
::defaultContactCountry();
447 public function defaultContactCountryName() {
448 return CRM_Core_BAO_Country
::defaultContactCountryName();
454 * @param string $defaultCurrency
458 public function defaultCurrencySymbol($defaultCurrency = NULL) {
459 return CRM_Core_BAO_Country
::defaultCurrencySymbol($defaultCurrency);
463 * Resets the singleton, so that the next call to CRM_Core_Config::singleton()
464 * reloads completely.
466 * While normally we could call the singleton function with $force = TRUE,
467 * this function addresses a very specific use-case in the CiviCRM installer,
468 * where we cannot yet force a reload, but we want to make sure that the next
469 * call to this object gets a fresh start (ex: to initialize the DAO).
471 public function free() {
472 self
::$_singleton = NULL;
476 * Conditionally fire an event during the first page run.
478 * The install system is currently implemented several times, so it's hard to add
479 * new installation logic. We use a poor-man's method to detect the first run.
481 * Situations to test:
483 * - Upgrade from an old version (predating first-run tracker)
484 * - Upgrade from an old version (with first-run tracking)
486 public function handleFirstRun() {
487 // Ordinarily, we prefetch settings en masse and find that the system is already installed.
488 // No extra SQL queries required.
489 if (Civi
::settings()->get('installed')) {
493 // Q: How should this behave during testing?
494 if (defined('CIVICRM_TEST')) {
498 // If schema hasn't been loaded yet, then do nothing. Don't want to interfere
499 // with the existing installers. NOTE: If we change the installer pageflow,
500 // then we may want to modify this behavior.
501 if (!CRM_Core_DAO
::checkTableExists('civicrm_domain')) {
505 // If we're handling an upgrade, then the system has already been used, so this
506 // is not the first run.
507 if (CRM_Core_Config
::isUpgradeMode()) {
510 $dao = CRM_Core_DAO
::executeQuery('SELECT version FROM civicrm_domain');
511 while ($dao->fetch()) {
512 if ($dao->version
&& version_compare($dao->version
, CRM_Utils_System
::version(), '<')) {
517 // The installation flag is stored in civicrm_setting, which is domain-aware. The
518 // flag could have been stored under a different domain.
519 $dao = CRM_Core_DAO
::executeQuery('
520 SELECT domain_id, value FROM civicrm_setting
521 WHERE is_domain = 1 AND name = "installed"
523 while ($dao->fetch()) {
524 $value = unserialize($dao->value
);
525 if (!empty($value)) {
526 Civi
::settings()->set('installed', 1);
531 // OK, this looks new.
532 Civi
::service('dispatcher')->dispatch(\Civi\Core\Event\SystemInstallEvent
::EVENT_NAME
, new \Civi\Core\Event\
SystemInstallEvent());
533 Civi
::settings()->set('installed', 1);