CRM/Core/Config/MagicMerge.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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  * Class CRM_Core_Config_MagicMerge
  30  *
  31  * Originally, the $config object was based on a single, serialized
  32  * data object stored in the database. As the needs for settings
  33  * grew (with robust metadata, system overrides, extension support,
  34  * and multi-tenancy), the $config started to store a mix of:
  35  *   (a) canonical config options,
  36  *   (b) dynamically generated runtime data,
  37  *   (c) cached data derived from other sources (esp civicrm_setting)
  38  *   (d) instances of service objects
  39  *
  40  * The config object is now deprecated. Settings and service objects
  41  * should generally be accessed via Civi::settings() and Civi::service().
  42  *
  43  * MagicMerge provides backward compatibility. You may still access
  44  * old properties via $config, but they will be loaded from their
  45  * new services.
  46  */
  47 class CRM_Core_Config_MagicMerge {
  48
  49   /**
  50    * Map old config properties to their contemporary counterparts.
  51    *
  52    * @var array
  53    *   Array(string $configAlias => Array(string $realType, string $realName)).
  54    */
  55   private $map;
  56
  57   private $locals, $settings;
  58
  59   private $cache = array();
  60
  61   /**
  62    * CRM_Core_Config_MagicMerge constructor.
  63    */
  64   public function __construct() {
  65     $this->map = self::getPropertyMap();
  66   }
  67
  68   /**
  69    * Set the map to the property map.
  70    */
  71   public function __wakeup() {
  72     $this->map = self::getPropertyMap();
  73   }
  74
  75   /**
  76    * Get a list of $config properties and the entities to which they map.
  77    *
  78    * This is used for two purposes:
  79    *
  80    *  1. Runtime: Provide backward-compatible interface for reading these
  81    *     properties.
  82    *  2. Upgrade: Migrate old properties of config_backend into settings.
  83    *
  84    * @return array
  85    */
  86   public static function getPropertyMap() {
  87     // Each mapping: $propertyName => Array(0 => $type, 1 => $foreignName|NULL, ...).
  88     // If $foreignName is omitted/null, then it's assumed to match the $propertyName.
  89     // Other parameters may be specified, depending on the type.
  90     return array(
  91       // "local" properties are unique to each instance of CRM_Core_Config (each request).
  92       'doNotResetCache' => array('local'),
  93       'inCiviCRM' => array('local'),
  94       'keyDisable' => array('local'),
  95       'userFrameworkFrontend' => array('local'),
  96       'userPermissionTemp' => array('local'),
  97
  98       // "runtime" properties are computed from define()s, $_ENV, etc.
  99       // See also: CRM_Core_Config_Runtime.
 100       'dsn' => array('runtime'),
 101       'initialized' => array('runtime'),
 102       'userFramework' => array('runtime'),
 103       'userFrameworkClass' => array('runtime'),
 104       'userFrameworkDSN' => array('runtime'),
 105       'userFrameworkURLVar' => array('runtime'),
 106       'userHookClass' => array('runtime'),
 107       'cleanURL' => array('runtime'),
 108       'configAndLogDir' => array('runtime'),
 109       'templateCompileDir' => array('runtime'),
 110       'templateDir' => array('runtime'),
 111
 112       // "boot-svc" properties are critical services needed during init.
 113       // See also: Civi\Core\Container::getBootService().
 114       'userSystem' => array('boot-svc'),
 115       'userPermissionClass' => array('boot-svc'),
 116
 117       'userFrameworkBaseURL' => array('user-system', 'getAbsoluteBaseURL'),
 118       'userFrameworkVersion' => array('user-system', 'getVersion'),
 119       'useFrameworkRelativeBase' => array('user-system', 'getRelativeBaseURL'), // ugh typo.
 120
 121       // "setting" properties are loaded through the setting layer, esp
 122       // table "civicrm_setting" and global $civicrm_setting.
 123       // See also: Civi::settings().
 124       'backtrace' => array('setting'),
 125       'contact_default_language' => array('setting'),
 126       'countryLimit' => array('setting'),
 127       'customTranslateFunction' => array('setting'),
 128       'dateInputFormat' => array('setting'),
 129       'dateformatDatetime' => array('setting'),
 130       'dateformatFull' => array('setting'),
 131       'dateformatPartial' => array('setting'),
 132       'dateformatTime' => array('setting'),
 133       'dateformatYear' => array('setting'),
 134       'dateformatFinancialBatch' => array('setting'),
 135       'dateformatshortdate' => array('setting'),
 136       'debug' => array('setting', 'debug_enabled'), // renamed.
 137       'defaultContactCountry' => array('setting'),
 138       'defaultContactStateProvince' => array('setting'),
 139       'defaultCurrency' => array('setting'),
 140       'defaultSearchProfileID' => array('setting'),
 141       'doNotAttachPDFReceipt' => array('setting'),
 142       'empoweredBy' => array('setting'),
 143       'enableComponents' => array('setting', 'enable_components'), // renamed.
 144       'enableSSL' => array('setting'),
 145       'fatalErrorHandler' => array('setting'),
 146       'fieldSeparator' => array('setting'),
 147       'fiscalYearStart' => array('setting'),
 148       'geoAPIKey' => array('setting'),
 149       'geoProvider' => array('setting'),
 150       'includeAlphabeticalPager' => array('setting'),
 151       'includeEmailInName' => array('setting'),
 152       'includeNickNameInName' => array('setting'),
 153       'includeOrderByClause' => array('setting'),
 154       'includeWildCardInName' => array('setting'),
 155       'inheritLocale' => array('setting'),
 156       'languageLimit' => array('setting'),
 157       'lcMessages' => array('setting'),
 158       'legacyEncoding' => array('setting'),
 159       'logging' => array('setting'),
 160       'mailThrottleTime' => array('setting'),
 161       'mailerBatchLimit' => array('setting'),
 162       'mailerJobSize' => array('setting'),
 163       'mailerJobsMax' => array('setting'),
 164       'mapAPIKey' => array('setting'),
 165       'mapProvider' => array('setting'),
 166       'maxFileSize' => array('setting'),
 167       'maxAttachments' => array('setting', 'max_attachments'), // renamed.
 168       'monetaryDecimalPoint' => array('setting'),
 169       'monetaryThousandSeparator' => array('setting'),
 170       'moneyformat' => array('setting'),
 171       'moneyvalueformat' => array('setting'),
 172       'provinceLimit' => array('setting'),
 173       'recaptchaOptions' => array('setting'),
 174       'recaptchaPublicKey' => array('setting'),
 175       'recaptchaPrivateKey' => array('setting'),
 176       'replyTo' => array('setting'),
 177       'secondDegRelPermissions' => array('setting'),
 178       'smartGroupCacheTimeout' => array('setting'),
 179       'timeInputFormat' => array('setting'),
 180       'userFrameworkLogging' => array('setting'),
 181       'userFrameworkUsersTableName' => array('setting'),
 182       'verpSeparator' => array('setting'),
 183       'wkhtmltopdfPath' => array('setting'),
 184       'wpBasePage' => array('setting'),
 185       'wpLoadPhp' => array('setting'),
 186
 187       // "setting-path" properties are settings with special filtering
 188       // to return normalized file paths.
 189       // Option: `mkdir` - auto-create dir
 190       // Option: `restrict` - auto-restrict remote access
 191       'customFileUploadDir' => array('setting-path', NULL, array('mkdir', 'restrict')),
 192       'customPHPPathDir' => array('setting-path'),
 193       'customTemplateDir' => array('setting-path'),
 194       'extensionsDir' => array('setting-path', NULL, array('mkdir')),
 195       'imageUploadDir' => array('setting-path', NULL, array('mkdir')),
 196       'uploadDir' => array('setting-path', NULL, array('mkdir', 'restrict')),
 197
 198       // "setting-url" properties are settings with special filtering
 199       // to return normalized URLs.
 200       // Option: `noslash` - don't append trailing slash
 201       // Option: `rel` - convert to relative URL (if possible)
 202       'customCSSURL' => array('setting-url', NULL, array('noslash')),
 203       'extensionsURL' => array('setting-url'),
 204       'imageUploadURL' => array('setting-url'),
 205       'resourceBase' => array('setting-url', 'userFrameworkResourceURL', array('rel')),
 206       'userFrameworkResourceURL' => array('setting-url'),
 207
 208       // "callback" properties are generated on-demand by calling a function.
 209       // @todo remove geocodeMethod. As of Feb 2018, $config->geocodeMethod works but gives a deprecation warning.
 210       'geocodeMethod' => array('callback', 'CRM_Utils_Geocode', 'getProviderClass'),
 211       'defaultCurrencySymbol' => array('callback', 'CRM_Core_BAO_Country', 'getDefaultCurrencySymbol'),
 212     );
 213   }
 214
 215   /**
 216    * Get value.
 217    *
 218    * @param string $k
 219    *
 220    * @return mixed
 221    * @throws \CRM_Core_Exception
 222    */
 223   public function __get($k) {
 224     if (!isset($this->map[$k])) {
 225       throw new \CRM_Core_Exception("Cannot read unrecognized property CRM_Core_Config::\${$k}.");
 226     }
 227     if (isset($this->cache[$k])) {
 228       return $this->cache[$k];
 229     }
 230
 231     $type = $this->map[$k][0];
 232     $name = isset($this->map[$k][1]) ? $this->map[$k][1] : $k;
 233
 234     switch ($type) {
 235       case 'setting':
 236         return $this->getSettings()->get($name);
 237
 238       case 'setting-path':
 239         // Array(0 => $type, 1 => $setting, 2 => $actions).
 240         $value = $this->getSettings()->get($name);
 241         $value = Civi::paths()->getPath($value);
 242         if ($value) {
 243           $value = CRM_Utils_File::addTrailingSlash($value);
 244           if (isset($this->map[$k][2]) && in_array('mkdir', $this->map[$k][2])) {
 245             if (!is_dir($value) && !CRM_Utils_File::createDir($value, FALSE)) {
 246               CRM_Core_Session::setStatus(ts('Failed to make directory (%1) at "%2". Please update the settings or file permissions.', array(
 247                 1 => $k,
 248                 2 => $value,
 249               )));
 250             }
 251           }
 252           if (isset($this->map[$k][2]) && in_array('restrict', $this->map[$k][2])) {
 253             CRM_Utils_File::restrictAccess($value);
 254           }
 255         }
 256         $this->cache[$k] = $value;
 257         return $value;
 258
 259       case 'setting-url':
 260         $options = !empty($this->map[$k][2]) ? $this->map[$k][2] : array();
 261         $value = $this->getSettings()->get($name);
 262         if ($value && !(in_array('noslash', $options))) {
 263           $value = CRM_Utils_File::addTrailingSlash($value, '/');
 264         }
 265         $this->cache[$k] = Civi::paths()->getUrl($value,
 266           in_array('rel', $options) ? 'relative' : 'absolute');
 267         return $this->cache[$k];
 268
 269       case 'runtime':
 270         return \Civi\Core\Container::getBootService('runtime')->{$name};
 271
 272       case 'boot-svc':
 273         $this->cache[$k] = \Civi\Core\Container::getBootService($name);
 274         return $this->cache[$k];
 275
 276       case 'local':
 277         $this->initLocals();
 278         return $this->locals[$name];
 279
 280       case 'user-system':
 281         $userSystem = \Civi\Core\Container::getBootService('userSystem');
 282         $this->cache[$k] = call_user_func(array($userSystem, $name));
 283         return $this->cache[$k];
 284
 285       case 'service':
 286         return \Civi::service($name);
 287
 288       case 'callback':
 289         // Array(0 => $type, 1 => $obj, 2 => $getter, 3 => $setter, 4 => $unsetter).
 290         if (!isset($this->map[$k][1], $this->map[$k][2])) {
 291           throw new \CRM_Core_Exception("Cannot find getter for property CRM_Core_Config::\${$k}");
 292         }
 293         return \Civi\Core\Resolver::singleton()->call(array($this->map[$k][1], $this->map[$k][2]), array($k));
 294
 295       default:
 296         throw new \CRM_Core_Exception("Cannot read property CRM_Core_Config::\${$k} ($type)");
 297     }
 298   }
 299
 300   /**
 301    * Set value.
 302    *
 303    * @param string $k
 304    * @param mixed $v
 305    *
 306    * @throws \CRM_Core_Exception
 307    */
 308   public function __set($k, $v) {
 309     if (!isset($this->map[$k])) {
 310       throw new \CRM_Core_Exception("Cannot set unrecognized property CRM_Core_Config::\${$k}");
 311     }
 312     unset($this->cache[$k]);
 313     $type = $this->map[$k][0];
 314
 315     // If foreign name is set, use that name (except with callback types because
 316     // their second parameter is the object, not the foreign name).
 317     $name = isset($this->map[$k][1]) && $type != 'callback' ? $this->map[$k][1] : $k;
 318
 319     switch ($type) {
 320       case 'setting':
 321       case 'setting-path':
 322       case 'setting-url':
 323       case 'user-system':
 324       case 'runtime':
 325       case 'callback':
 326       case 'boot-svc':
 327         // In the past, changes to $config were not persisted automatically.
 328         $this->cache[$name] = $v;
 329         return;
 330
 331       case 'local':
 332         $this->initLocals();
 333         $this->locals[$name] = $v;
 334         return;
 335
 336       default:
 337         throw new \CRM_Core_Exception("Cannot set property CRM_Core_Config::\${$k} ($type)");
 338     }
 339   }
 340
 341   /**
 342    * Is value set.
 343    *
 344    * @param string $k
 345    *
 346    * @return bool
 347    */
 348   public function __isset($k) {
 349     return isset($this->map[$k]);
 350   }
 351
 352   /**
 353    * Unset value.
 354    *
 355    * @param string $k
 356    *
 357    * @throws \CRM_Core_Exception
 358    */
 359   public function __unset($k) {
 360     if (!isset($this->map[$k])) {
 361       throw new \CRM_Core_Exception("Cannot unset unrecognized property CRM_Core_Config::\${$k}");
 362     }
 363     unset($this->cache[$k]);
 364     $type = $this->map[$k][0];
 365     $name = isset($this->map[$k][1]) ? $this->map[$k][1] : $k;
 366
 367     switch ($type) {
 368       case 'setting':
 369       case 'setting-path':
 370       case 'setting-url':
 371         $this->getSettings()->revert($k);
 372         return;
 373
 374       case 'local':
 375         $this->initLocals();
 376         $this->locals[$name] = NULL;
 377         return;
 378
 379       case 'callback':
 380         // Array(0 => $type, 1 => $obj, 2 => $getter, 3 => $setter, 4 => $unsetter).
 381         if (!isset($this->map[$k][1], $this->map[$k][4])) {
 382           throw new \CRM_Core_Exception("Cannot find unsetter for property CRM_Core_Config::\${$k}");
 383         }
 384         \Civi\Core\Resolver::singleton()->call(array($this->map[$k][1], $this->map[$k][4]), array($k));
 385         return;
 386
 387       default:
 388         throw new \CRM_Core_Exception("Cannot unset property CRM_Core_Config::\${$k} ($type)");
 389     }
 390   }
 391
 392   /**
 393    * @return \Civi\Core\SettingsBag
 394    */
 395   protected function getSettings() {
 396     if ($this->settings === NULL) {
 397       $this->settings = Civi::settings();
 398     }
 399     return $this->settings;
 400   }
 401
 402   /**
 403    * Initialise local settings.
 404    */
 405   private function initLocals() {
 406     if ($this->locals === NULL) {
 407       $this->locals = array(
 408         'inCiviCRM' => FALSE,
 409         'doNotResetCache' => 0,
 410         'keyDisable' => FALSE,
 411         'initialized' => FALSE,
 412         'userFrameworkFrontend' => FALSE,
 413         'userPermissionTemp' => NULL,
 414       );
 415     }
 416   }
 417
 418 }