Commit | Line | Data |
---|---|---|
c0a1f187 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
c0a1f187 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
c0a1f187 TO |
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 | |
9e1e6020 TO |
33 | * grew (with robust metadata, system overrides, extension support, |
34 | * and multi-tenancy), the $config started to store a mix of: | |
c0a1f187 TO |
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 | ||
7f835399 | 57 | private $locals, $settings; |
c0a1f187 | 58 | |
7dba62da TO |
59 | private $cache = array(); |
60 | ||
8246bca4 | 61 | /** |
62 | * CRM_Core_Config_MagicMerge constructor. | |
63 | */ | |
c0a1f187 TO |
64 | public function __construct() { |
65 | $this->map = self::getPropertyMap(); | |
66 | } | |
67 | ||
8246bca4 | 68 | /** |
69 | * Set the map to the property map. | |
70 | */ | |
c0a1f187 TO |
71 | public function __wakeup() { |
72 | $this->map = self::getPropertyMap(); | |
73 | } | |
74 | ||
75 | /** | |
f806379b TO |
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 | * | |
c0a1f187 TO |
84 | * @return array |
85 | */ | |
86 | public static function getPropertyMap() { | |
e3d28c74 TO |
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. | |
c0a1f187 | 90 | return array( |
9e1e6020 TO |
91 | // "local" properties are unique to each instance of CRM_Core_Config (each request). |
92 | 'doNotResetCache' => array('local'), | |
93 | 'inCiviCRM' => array('local'), | |
5f900b59 | 94 | 'keyDisable' => array('local'), |
9e1e6020 | 95 | 'userFrameworkFrontend' => array('local'), |
d4330c62 | 96 | 'userPermissionTemp' => array('local'), |
9e1e6020 TO |
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'), | |
9e1e6020 TO |
103 | 'userFrameworkClass' => array('runtime'), |
104 | 'userFrameworkDSN' => array('runtime'), | |
9e1e6020 | 105 | 'userFrameworkURLVar' => array('runtime'), |
9e1e6020 TO |
106 | 'userHookClass' => array('runtime'), |
107 | 'cleanURL' => array('runtime'), | |
108 | 'configAndLogDir' => array('runtime'), | |
109 | 'templateCompileDir' => array('runtime'), | |
110 | 'templateDir' => array('runtime'), | |
111 | ||
d4330c62 | 112 | // "boot-svc" properties are critical services needed during init. |
7f835399 | 113 | // See also: Civi\Core\Container::getBootService(). |
d4330c62 TO |
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 | ||
9e1e6020 TO |
121 | // "setting" properties are loaded through the setting layer, esp |
122 | // table "civicrm_setting" and global $civicrm_setting. | |
123 | // See also: Civi::settings(). | |
e3d28c74 | 124 | 'backtrace' => array('setting'), |
9e1e6020 | 125 | 'contact_default_language' => array('setting'), |
e3d28c74 | 126 | 'countryLimit' => array('setting'), |
43d1ad94 | 127 | 'customTranslateFunction' => array('setting'), |
e3d28c74 TO |
128 | 'dateInputFormat' => array('setting'), |
129 | 'dateformatDatetime' => array('setting'), | |
130 | 'dateformatFull' => array('setting'), | |
131 | 'dateformatPartial' => array('setting'), | |
132 | 'dateformatTime' => array('setting'), | |
133 | 'dateformatYear' => array('setting'), | |
37846436 | 134 | 'dateformatFinancialBatch' => array('setting'), |
080ee9d3 | 135 | 'dateformatshortdate' => array('setting'), |
c0a1f187 | 136 | 'debug' => array('setting', 'debug_enabled'), // renamed. |
e3d28c74 TO |
137 | 'defaultContactCountry' => array('setting'), |
138 | 'defaultContactStateProvince' => array('setting'), | |
139 | 'defaultCurrency' => array('setting'), | |
140 | 'defaultSearchProfileID' => array('setting'), | |
141 | 'doNotAttachPDFReceipt' => array('setting'), | |
142 | 'empoweredBy' => array('setting'), | |
c0a1f187 | 143 | 'enableComponents' => array('setting', 'enable_components'), // renamed. |
e3d28c74 TO |
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'), | |
c0a1f187 | 167 | 'maxAttachments' => array('setting', 'max_attachments'), // renamed. |
e3d28c74 TO |
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'), | |
606999ec | 176 | 'replyTo' => array('setting'), |
e3d28c74 TO |
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 | ||
9e1e6020 TO |
187 | // "setting-path" properties are settings with special filtering |
188 | // to return normalized file paths. | |
cdbea577 C |
189 | // Option: `mkdir` - auto-create dir |
190 | // Option: `restrict` - auto-restrict remote access | |
ac47f7ca | 191 | 'customFileUploadDir' => array('setting-path', NULL, array('mkdir', 'restrict')), |
e3d28c74 TO |
192 | 'customPHPPathDir' => array('setting-path'), |
193 | 'customTemplateDir' => array('setting-path'), | |
8dac2d39 | 194 | 'extensionsDir' => array('setting-path', NULL, array('mkdir')), |
ac47f7ca TO |
195 | 'imageUploadDir' => array('setting-path', NULL, array('mkdir')), |
196 | 'uploadDir' => array('setting-path', NULL, array('mkdir', 'restrict')), | |
e3d28c74 | 197 | |
cdbea577 C |
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'), | |
c0a1f187 | 207 | |
9e1e6020 | 208 | // "callback" properties are generated on-demand by calling a function. |
0d1823d7 | 209 | // @todo remove geocodeMethod. As of Feb 2018, $config->geocodeMethod works but gives a deprecation warning. |
c0a1f187 | 210 | 'geocodeMethod' => array('callback', 'CRM_Utils_Geocode', 'getProviderClass'), |
d7c217ae | 211 | 'defaultCurrencySymbol' => array('callback', 'CRM_Core_BAO_Country', 'getDefaultCurrencySymbol'), |
c0a1f187 TO |
212 | ); |
213 | } | |
214 | ||
8246bca4 | 215 | /** |
216 | * Get value. | |
217 | * | |
218 | * @param string $k | |
219 | * | |
220 | * @return mixed | |
221 | * @throws \CRM_Core_Exception | |
222 | */ | |
c0a1f187 TO |
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 | } | |
fd78a9e5 | 227 | if (isset($this->cache[$k])) { |
7dba62da TO |
228 | return $this->cache[$k]; |
229 | } | |
e3d28c74 TO |
230 | |
231 | $type = $this->map[$k][0]; | |
232 | $name = isset($this->map[$k][1]) ? $this->map[$k][1] : $k; | |
c0a1f187 TO |
233 | |
234 | switch ($type) { | |
235 | case 'setting': | |
23bb9c85 | 236 | return $this->getSettings()->get($name); |
c0a1f187 TO |
237 | |
238 | case 'setting-path': | |
ac47f7ca | 239 | // Array(0 => $type, 1 => $setting, 2 => $actions). |
e3d28c74 | 240 | $value = $this->getSettings()->get($name); |
e3d28c74 TO |
241 | $value = Civi::paths()->getPath($value); |
242 | if ($value) { | |
243 | $value = CRM_Utils_File::addTrailingSlash($value); | |
ac47f7ca | 244 | if (isset($this->map[$k][2]) && in_array('mkdir', $this->map[$k][2])) { |
f7cc6e55 | 245 | if (!is_dir($value) && !CRM_Utils_File::createDir($value, FALSE)) { |
895c19e7 TO |
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 | } | |
e3d28c74 | 251 | } |
ac47f7ca | 252 | if (isset($this->map[$k][2]) && in_array('restrict', $this->map[$k][2])) { |
e3d28c74 TO |
253 | CRM_Utils_File::restrictAccess($value); |
254 | } | |
255 | } | |
7dba62da | 256 | $this->cache[$k] = $value; |
e3d28c74 TO |
257 | return $value; |
258 | ||
cdbea577 C |
259 | case 'setting-url': |
260 | $options = !empty($this->map[$k][2]) ? $this->map[$k][2] : array(); | |
6ec7e639 | 261 | $value = $this->getSettings()->get($name); |
cdbea577 C |
262 | if ($value && !(in_array('noslash', $options))) { |
263 | $value = CRM_Utils_File::addTrailingSlash($value, '/'); | |
6ec7e639 | 264 | } |
cdbea577 C |
265 | $this->cache[$k] = Civi::paths()->getUrl($value, |
266 | in_array('rel', $options) ? 'relative' : 'absolute'); | |
7dba62da | 267 | return $this->cache[$k]; |
c0a1f187 TO |
268 | |
269 | case 'runtime': | |
7f835399 | 270 | return \Civi\Core\Container::getBootService('runtime')->{$name}; |
c0a1f187 | 271 | |
d4330c62 TO |
272 | case 'boot-svc': |
273 | $this->cache[$k] = \Civi\Core\Container::getBootService($name); | |
274 | return $this->cache[$k]; | |
275 | ||
c0a1f187 TO |
276 | case 'local': |
277 | $this->initLocals(); | |
278 | return $this->locals[$name]; | |
279 | ||
d4330c62 TO |
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 | ||
c0a1f187 TO |
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 | ||
8246bca4 | 300 | /** |
301 | * Set value. | |
302 | * | |
303 | * @param string $k | |
304 | * @param mixed $v | |
305 | * | |
306 | * @throws \CRM_Core_Exception | |
307 | */ | |
c0a1f187 TO |
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 | } | |
7dba62da | 312 | unset($this->cache[$k]); |
dc640254 | 313 | $type = $this->map[$k][0]; |
82eff07b | 314 | |
82eff07b JM |
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; | |
c0a1f187 TO |
318 | |
319 | switch ($type) { | |
320 | case 'setting': | |
dc640254 | 321 | case 'setting-path': |
cdbea577 | 322 | case 'setting-url': |
d4330c62 | 323 | case 'user-system': |
c0a1f187 | 324 | case 'runtime': |
dc640254 | 325 | case 'callback': |
6504e96d | 326 | case 'boot-svc': |
dc640254 TO |
327 | // In the past, changes to $config were not persisted automatically. |
328 | $this->cache[$name] = $v; | |
c0a1f187 TO |
329 | return; |
330 | ||
331 | case 'local': | |
332 | $this->initLocals(); | |
333 | $this->locals[$name] = $v; | |
334 | return; | |
335 | ||
c0a1f187 TO |
336 | default: |
337 | throw new \CRM_Core_Exception("Cannot set property CRM_Core_Config::\${$k} ($type)"); | |
338 | } | |
339 | } | |
340 | ||
8246bca4 | 341 | /** |
342 | * Is value set. | |
343 | * | |
344 | * @param string $k | |
345 | * | |
346 | * @return bool | |
347 | */ | |
c0a1f187 TO |
348 | public function __isset($k) { |
349 | return isset($this->map[$k]); | |
350 | } | |
351 | ||
8246bca4 | 352 | /** |
353 | * Unset value. | |
354 | * | |
355 | * @param string $k | |
356 | * | |
357 | * @throws \CRM_Core_Exception | |
358 | */ | |
c0a1f187 TO |
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 | } | |
7dba62da | 363 | unset($this->cache[$k]); |
dc640254 TO |
364 | $type = $this->map[$k][0]; |
365 | $name = isset($this->map[$k][1]) ? $this->map[$k][1] : $k; | |
c0a1f187 TO |
366 | |
367 | switch ($type) { | |
368 | case 'setting': | |
369 | case 'setting-path': | |
cdbea577 | 370 | case 'setting-url': |
23bb9c85 | 371 | $this->getSettings()->revert($k); |
c0a1f187 TO |
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 | ||
23bb9c85 TO |
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 | ||
8246bca4 | 402 | /** |
403 | * Initialise local settings. | |
404 | */ | |
c0a1f187 TO |
405 | private function initLocals() { |
406 | if ($this->locals === NULL) { | |
407 | $this->locals = array( | |
408 | 'inCiviCRM' => FALSE, | |
409 | 'doNotResetCache' => 0, | |
5f900b59 | 410 | 'keyDisable' => FALSE, |
c0a1f187 TO |
411 | 'initialized' => FALSE, |
412 | 'userFrameworkFrontend' => FALSE, | |
d4330c62 | 413 | 'userPermissionTemp' => NULL, |
c0a1f187 TO |
414 | ); |
415 | } | |
416 | } | |
417 | ||
418 | } |