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