CRM/Core/Config.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Config handles all the run time configuration changes that the system needs to deal with.
  14  *
  15  * Typically we'll have different values for a user's sandbox, a qa sandbox and a production area.
  16  * The default values in general, should reflect production values (minimizes chances of screwing up)
  17  *
  18  * @package CRM
  19  * @copyright CiviCRM LLC https://civicrm.org/licensing
  20  */
  21
  22 require_once 'Log.php';
  23 require_once 'Mail.php';
  24
  25 require_once 'api/api.php';
  26
  27 /**
  28  * Class CRM_Core_Config
  29  *
  30  * @property CRM_Utils_System_Base $userSystem
  31  * @property CRM_Core_Permission_Base $userPermissionClass
  32  * @property array $enableComponents
  33  * @property array $languageLimit
  34  * @property bool $debug
  35  * @property bool $doNotResetCache
  36  * @property string $maxFileSize
  37  * @property string $defaultCurrency
  38  * @property string $defaultCurrencySymbol
  39  * @property string $lcMessages
  40  * @property string $fieldSeparator
  41  * @property string $userFramework
  42  * @property string $verpSeparator
  43  * @property string $dateFormatFull
  44  * @property string $resourceBase
  45  * @property string $dsn
  46  * @property string $customTemplateDir
  47  * @property string $defaultContactCountry
  48  * @property string $defaultContactStateProvince
  49  * @property string $monetaryDecimalPoint
  50  * @property string $monetaryThousandSeparator
  51  * @property array fiscalYearStart
  52  */
  53 class CRM_Core_Config extends CRM_Core_Config_MagicMerge {
  54
  55   /**
  56    * The handle to the log that we are using
  57    * @var object
  58    */
  59   private static $_log = NULL;
  60
  61   /**
  62    * We only need one instance of this object. So we use the singleton
  63    * pattern and cache the instance in this variable
  64    *
  65    * @var CRM_Core_Config
  66    */
  67   private static $_singleton = NULL;
  68
  69   /**
  70    * The constructor. Sets domain id if defined, otherwise assumes
  71    * single instance installation.
  72    */
  73   public function __construct() {
  74     parent::__construct();
  75   }
  76
  77   /**
  78    * Singleton function used to manage this object.
  79    *
  80    * @param bool $loadFromDB
  81    *   whether to load from the database.
  82    * @param bool $force
  83    *   whether to force a reconstruction.
  84    *
  85    * @return CRM_Core_Config
  86    */
  87   public static function &singleton($loadFromDB = TRUE, $force = FALSE) {
  88     if (self::$_singleton === NULL || $force) {
  89       $GLOBALS['civicrm_default_error_scope'] = CRM_Core_TemporaryErrorScope::create(['CRM_Core_Error', 'exceptionHandler'], 1);
  90       $errorScope = CRM_Core_TemporaryErrorScope::create(['CRM_Core_Error', 'simpleHandler']);
  91
  92       self::$_singleton = new CRM_Core_Config();
  93       \Civi\Core\Container::boot($loadFromDB);
  94       if ($loadFromDB && self::$_singleton->dsn) {
  95         $domain = \CRM_Core_BAO_Domain::getDomain();
  96         \CRM_Core_BAO_ConfigSetting::applyLocale(\Civi::settings($domain->id), $domain->locales);
  97
  98         unset($errorScope);
  99
 100         CRM_Utils_Hook::config(self::$_singleton);
 101         self::$_singleton->authenticate();
 102
 103         // Extreme backward compat: $config binds to active domain at moment of setup.
 104         self::$_singleton->getSettings();
 105
 106         Civi::service('settings_manager')->useDefaults();
 107
 108         self::$_singleton->handleFirstRun();
 109       }
 110     }
 111     return self::$_singleton;
 112   }
 113
 114   /**
 115    * Returns the singleton logger for the application.
 116    *
 117    * @deprecated
 118    * @return object
 119    * @see Civi::log()
 120    */
 121   public static function &getLog() {
 122     if (!isset(self::$_log)) {
 123       self::$_log = Log::singleton('display');
 124     }
 125
 126     return self::$_log;
 127   }
 128
 129   /**
 130    * Retrieve a mailer to send any mail from the application.
 131    *
 132    * @return Mail
 133    * @deprecated
 134    * @see Civi::service()
 135    */
 136   public static function getMailer() {
 137     return Civi::service('pear_mail');
 138   }
 139
 140   /**
 141    * Deletes the web server writable directories.
 142    *
 143    * @param int $value
 144    *   1: clean templates_c, 2: clean upload, 3: clean both
 145    * @param bool $rmdir
 146    */
 147   public function cleanup($value, $rmdir = TRUE) {
 148     $value = (int ) $value;
 149
 150     if ($value & 1) {
 151       // clean templates_c
 152       CRM_Utils_File::cleanDir($this->templateCompileDir, $rmdir);
 153       CRM_Utils_File::createDir($this->templateCompileDir);
 154     }
 155     if ($value & 2) {
 156       // clean upload dir
 157       CRM_Utils_File::cleanDir($this->uploadDir);
 158       CRM_Utils_File::createDir($this->uploadDir);
 159     }
 160
 161     // Whether we delete/create or simply preserve directories, we should
 162     // certainly make sure the restrictions are enforced.
 163     foreach ([
 164       $this->templateCompileDir,
 165       $this->uploadDir,
 166       $this->configAndLogDir,
 167       $this->customFileUploadDir,
 168     ] as $dir) {
 169       if ($dir && is_dir($dir)) {
 170         CRM_Utils_File::restrictAccess($dir);
 171       }
 172     }
 173   }
 174
 175   /**
 176    * Verify that the needed parameters are not null in the config.
 177    *
 178    * @param CRM_Core_Config $config (reference) the system config object
 179    * @param array $required (reference) the parameters that need a value
 180    *
 181    * @return bool
 182    */
 183   public static function check(&$config, &$required) {
 184     foreach ($required as $name) {
 185       if (CRM_Utils_System::isNull($config->$name)) {
 186         return FALSE;
 187       }
 188     }
 189     return TRUE;
 190   }
 191
 192   /**
 193    * Reset the serialized array and recompute.
 194    * use with care
 195    *
 196    * @deprecated
 197    */
 198   public function reset() {
 199     // This is what it used to do. However, it hasn't meant anything since 4.6.
 200     // $query = "UPDATE civicrm_domain SET config_backend = null";
 201     // CRM_Core_DAO::executeQuery($query);
 202   }
 203
 204   /**
 205    * This method should initialize auth sources.
 206    */
 207   public function authenticate() {
 208     // make sure session is always initialised
 209     $session = CRM_Core_Session::singleton();
 210
 211     // for logging purposes, pass the userID to the db
 212     $userID = $session->get('userID');
 213     if ($userID) {
 214       CRM_Core_DAO::executeQuery('SET @civicrm_user_id = %1',
 215         [1 => [$userID, 'Integer']]
 216       );
 217     }
 218
 219     if ($session->get('userID') && !$session->get('authSrc')) {
 220       $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_LOGIN);
 221     }
 222
 223     // checksum source
 224     CRM_Contact_BAO_Contact_Permission::initChecksumAuthSrc();
 225   }
 226
 227   /**
 228    * One function to get domain ID.
 229    *
 230    * @param int $domainID
 231    * @param bool $reset
 232    *
 233    * @return int|null
 234    */
 235   public static function domainID($domainID = NULL, $reset = FALSE) {
 236     static $domain;
 237     if ($domainID) {
 238       $domain = $domainID;
 239     }
 240     if ($reset || empty($domain)) {
 241       $domain = defined('CIVICRM_DOMAIN_ID') ? CIVICRM_DOMAIN_ID : 1;
 242     }
 243
 244     return (int) $domain;
 245   }
 246
 247   /**
 248    * Function to get environment.
 249    *
 250    * @param string $env
 251    * @param bool $reset
 252    *
 253    * @return string
 254    */
 255   public static function environment($env = NULL, $reset = FALSE) {
 256     if ($env) {
 257       $environment = $env;
 258     }
 259     if ($reset || empty($environment)) {
 260       $environment = Civi::settings()->get('environment');
 261     }
 262     if (!$environment) {
 263       $environment = 'Production';
 264     }
 265     return $environment;
 266   }
 267
 268   /**
 269    * Do general cleanup of caches, temp directories and temp tables
 270    * @see https://issues.civicrm.org/jira/browse/CRM-8739
 271    *
 272    * @param bool $sessionReset
 273    */
 274   public function cleanupCaches($sessionReset = TRUE) {
 275     // cleanup templates_c directory
 276     $this->cleanup(1, FALSE);
 277
 278     // clear all caches
 279     self::clearDBCache();
 280     Civi::cache('session')->clear();
 281     CRM_Utils_System::flushCache();
 282
 283     if ($sessionReset) {
 284       $session = CRM_Core_Session::singleton();
 285       $session->reset(2);
 286     }
 287   }
 288
 289   /**
 290    * Do general cleanup of module permissions.
 291    */
 292   public function cleanupPermissions() {
 293     $module_files = CRM_Extension_System::singleton()->getMapper()->getActiveModuleFiles();
 294     if ($this->userPermissionClass->isModulePermissionSupported()) {
 295       // Can store permissions -- so do it!
 296       $this->userPermissionClass->upgradePermissions(
 297         CRM_Core_Permission::basicPermissions()
 298       );
 299     }
 300     else {
 301       // Cannot store permissions -- warn if any modules require them
 302       $modules_with_perms = [];
 303       foreach ($module_files as $module_file) {
 304         $perms = $this->userPermissionClass->getModulePermissions($module_file['prefix']);
 305         if (!empty($perms)) {
 306           $modules_with_perms[] = $module_file['prefix'];
 307         }
 308       }
 309       if (!empty($modules_with_perms)) {
 310         CRM_Core_Session::setStatus(
 311           ts('Some modules define permissions, but the CMS cannot store them: %1', [1 => implode(', ', $modules_with_perms)]),
 312           ts('Permission Error'),
 313           'error'
 314         );
 315       }
 316     }
 317   }
 318
 319   /**
 320    * Flush information about loaded modules.
 321    */
 322   public function clearModuleList() {
 323     CRM_Extension_System::singleton()->getCache()->flush();
 324     CRM_Utils_Hook::singleton(TRUE);
 325     CRM_Core_PseudoConstant::getModuleExtensions(TRUE);
 326     CRM_Core_Module::getAll(TRUE);
 327   }
 328
 329   /**
 330    * Clear db cache.
 331    */
 332   public static function clearDBCache() {
 333     $queries = [
 334       'TRUNCATE TABLE civicrm_acl_cache',
 335       'TRUNCATE TABLE civicrm_acl_contact_cache',
 336       'TRUNCATE TABLE civicrm_cache',
 337       'TRUNCATE TABLE civicrm_prevnext_cache',
 338       'UPDATE civicrm_group SET cache_date = NULL',
 339       'TRUNCATE TABLE civicrm_group_contact_cache',
 340       'TRUNCATE TABLE civicrm_menu',
 341       'UPDATE civicrm_setting SET value = NULL WHERE name="navigation" AND contact_id IS NOT NULL',
 342     ];
 343
 344     foreach ($queries as $query) {
 345       CRM_Core_DAO::executeQuery($query);
 346     }
 347
 348     // also delete all the import and export temp tables
 349     self::clearTempTables();
 350   }
 351
 352   /**
 353    * Clear leftover temporary tables.
 354    *
 355    * This is called on upgrade, during tests and site move, from the cron and via clear caches in the UI.
 356    *
 357    * Currently the UI clear caches does not pass a time interval - which may need review as it does risk
 358    * ripping the tables out from underneath a current action. This was considered but
 359    * out-of-scope for CRM-16167
 360    *
 361    * @param string|bool $timeInterval
 362    *   Optional time interval for mysql date function.g '2 day'. This can be used to prevent
 363    *   tables created recently from being deleted.
 364    */
 365   public static function clearTempTables($timeInterval = FALSE) {
 366
 367     $dao = new CRM_Core_DAO();
 368     $query = "
 369       SELECT TABLE_NAME as tableName
 370       FROM   INFORMATION_SCHEMA.TABLES
 371       WHERE  TABLE_SCHEMA = %1
 372       AND (
 373         TABLE_NAME LIKE 'civicrm_import_job_%'
 374         OR TABLE_NAME LIKE 'civicrm_report_temp%'
 375         OR TABLE_NAME LIKE 'civicrm_tmp_d%'
 376         )
 377     ";
 378     // NOTE: Cannot find use-cases where "civicrm_report_temp" would be durable. Could probably remove.
 379
 380     if ($timeInterval) {
 381       $query .= " AND CREATE_TIME < DATE_SUB(NOW(), INTERVAL {$timeInterval})";
 382     }
 383
 384     $tableDAO = CRM_Core_DAO::executeQuery($query, [1 => [$dao->database(), 'String']]);
 385     $tables = [];
 386     while ($tableDAO->fetch()) {
 387       $tables[] = $tableDAO->tableName;
 388     }
 389     if (!empty($tables)) {
 390       $table = implode(',', $tables);
 391       // drop leftover temporary tables
 392       CRM_Core_DAO::executeQuery("DROP TABLE $table");
 393     }
 394   }
 395
 396   /**
 397    * Check if running in upgrade mode.
 398    *
 399    * @param string $path
 400    *
 401    * @return bool
 402    */
 403   public static function isUpgradeMode($path = NULL) {
 404     if (defined('CIVICRM_UPGRADE_ACTIVE')) {
 405       return TRUE;
 406     }
 407
 408     $upgradeInProcess = CRM_Core_Session::singleton()->get('isUpgradePending');
 409     if ($upgradeInProcess) {
 410       return TRUE;
 411     }
 412
 413     if (!$path) {
 414       // note: do not re-initialize config here, since this function is part of
 415       // config initialization itself
 416       $urlVar = 'q';
 417       if (defined('CIVICRM_UF') && CIVICRM_UF == 'Joomla') {
 418         $urlVar = 'task';
 419       }
 420
 421       $path = $_GET[$urlVar] ?? NULL;
 422     }
 423
 424     if ($path && preg_match('/^civicrm\/upgrade(\/.*)?$/', $path)) {
 425       return TRUE;
 426     }
 427
 428     if ($path && preg_match('/^civicrm\/ajax\/l10n-js/', $path)
 429       && !empty($_SERVER['HTTP_REFERER'])
 430     ) {
 431       $ref = parse_url($_SERVER['HTTP_REFERER']);
 432       if (
 433         (!empty($ref['path']) && preg_match('/civicrm\/upgrade/', $ref['path'])) ||
 434         (!empty($ref['query']) && preg_match('/civicrm\/upgrade/', urldecode($ref['query'])))
 435       ) {
 436         return TRUE;
 437       }
 438     }
 439
 440     return FALSE;
 441   }
 442
 443   /**
 444    * Is back office credit card processing enabled for this site - ie are there any installed processors that support
 445    * it?
 446    * This function is used for determining whether to show the submit credit card link, not for determining which processors to show, hence
 447    * it is a config var
 448    * @return bool
 449    */
 450   public static function isEnabledBackOfficeCreditCardPayments() {
 451     return CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(['BackOffice']);
 452   }
 453
 454   /**
 455    * @deprecated
 456    */
 457   public function addressSequence() {
 458     CRM_Core_Error::deprecatedFunctionWarning('CRM_Utils_Address::sequence(Civi::settings()->get(\'address_format\')');
 459     return CRM_Utils_Address::sequence(Civi::settings()->get('address_format'));
 460   }
 461
 462   /**
 463    * @deprecated
 464    */
 465   public function defaultContactCountry() {
 466     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_Country::defaultContactCountry');
 467     return CRM_Core_BAO_Country::defaultContactCountry();
 468   }
 469
 470   /**
 471    * @deprecated
 472    */
 473   public function defaultContactCountryName() {
 474     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_Country::defaultContactCountryName');
 475     return CRM_Core_BAO_Country::defaultContactCountryName();
 476   }
 477
 478   /**
 479    * @deprecated
 480    *
 481    * @param string $defaultCurrency
 482    *
 483    * @return string
 484    */
 485   public function defaultCurrencySymbol($defaultCurrency = NULL) {
 486     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_Country::defaultCurrencySymbol');
 487     return CRM_Core_BAO_Country::defaultCurrencySymbol($defaultCurrency);
 488   }
 489
 490   /**
 491    * Resets the singleton, so that the next call to CRM_Core_Config::singleton()
 492    * reloads completely.
 493    *
 494    * While normally we could call the singleton function with $force = TRUE,
 495    * this function addresses a very specific use-case in the CiviCRM installer,
 496    * where we cannot yet force a reload, but we want to make sure that the next
 497    * call to this object gets a fresh start (ex: to initialize the DAO).
 498    */
 499   public function free() {
 500     self::$_singleton = NULL;
 501   }
 502
 503   /**
 504    * Conditionally fire an event during the first page run.
 505    *
 506    * The install system is currently implemented several times, so it's hard to add
 507    * new installation logic. We use a makeshift method to detect the first run.
 508    *
 509    * Situations to test:
 510    *  - New installation
 511    *  - Upgrade from an old version (predating first-run tracker)
 512    *  - Upgrade from an old version (with first-run tracking)
 513    */
 514   public function handleFirstRun() {
 515     // Ordinarily, we prefetch settings en masse and find that the system is already installed.
 516     // No extra SQL queries required.
 517     if (Civi::settings()->get('installed')) {
 518       return;
 519     }
 520
 521     // Q: How should this behave during testing?
 522     if (defined('CIVICRM_TEST')) {
 523       return;
 524     }
 525
 526     // If schema hasn't been loaded yet, then do nothing. Don't want to interfere
 527     // with the existing installers. NOTE: If we change the installer pageflow,
 528     // then we may want to modify this behavior.
 529     if (!CRM_Core_DAO::checkTableExists('civicrm_domain')) {
 530       return;
 531     }
 532
 533     // If we're handling an upgrade, then the system has already been used, so this
 534     // is not the first run.
 535     if (CRM_Core_Config::isUpgradeMode()) {
 536       return;
 537     }
 538     $dao = CRM_Core_DAO::executeQuery('SELECT version FROM civicrm_domain');
 539     while ($dao->fetch()) {
 540       if ($dao->version && version_compare($dao->version, CRM_Utils_System::version(), '<')) {
 541         return;
 542       }
 543     }
 544
 545     // The installation flag is stored in civicrm_setting, which is domain-aware. The
 546     // flag could have been stored under a different domain.
 547     $dao = CRM_Core_DAO::executeQuery('
 548       SELECT domain_id, value FROM civicrm_setting
 549       WHERE is_domain = 1 AND name = "installed"
 550     ');
 551     while ($dao->fetch()) {
 552       $value = CRM_Utils_String::unserialize($dao->value);
 553       if (!empty($value)) {
 554         Civi::settings()->set('installed', 1);
 555         return;
 556       }
 557     }
 558
 559     // OK, this looks new.
 560     Civi::dispatcher()->dispatch('civi.core.install', new \Civi\Core\Event\SystemInstallEvent());
 561     Civi::settings()->set('installed', 1);
 562   }
 563
 564   /**
 565    * Is the system permitted to flush caches at the moment.
 566    */
 567   public static function isPermitCacheFlushMode() {
 568     return !CRM_Core_Config::singleton()->doNotResetCache;
 569   }
 570
 571   /**
 572    * Set cache clearing to enabled or disabled.
 573    *
 574    * This might be enabled at the start of a long running process
 575    * such as an import in order to delay clearing caches until the end.
 576    *
 577    * @param bool $enabled
 578    *   If true then caches can be cleared at this time.
 579    */
 580   public static function setPermitCacheFlushMode($enabled) {
 581     CRM_Core_Config::singleton()->doNotResetCache = $enabled ? 0 : 1;
 582   }
 583
 584 }