3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 * Class CRM_Core_Config_Runtime
31 * The runtime describes the environment in which CiviCRM executes -- ie
32 * the DSN, CMS type, CMS URL, etc. Generally, runtime properties must be
33 * determined externally (before loading CiviCRM).
35 class CRM_Core_Config_Runtime
extends CRM_Core_Config_MagicMerge
{
40 * The name of user framework
44 public $userFramework;
46 public $userFrameworkBaseURL;
48 public $userFrameworkClass;
51 * The dsn of the database connection for user framework
55 public $userFrameworkDSN;
58 * The name of user framework url variable name
62 public $userFrameworkURLVar = 'q';
64 public $userFrameworkVersion;
66 public $useFrameworkRelativeBase;
68 public $userHookClass;
71 * Are we generating clean url's and using mod_rewrite
77 * The root directory of our template tree.
83 * @param bool $loadFromDB
85 public function initialize($loadFromDB = TRUE) {
86 if (!defined('CIVICRM_DSN') && $loadFromDB) {
87 $this->fatal('You need to define CIVICRM_DSN in civicrm.settings.php');
89 $this->dsn
= defined('CIVICRM_DSN') ? CIVICRM_DSN
: NULL;
91 if (!defined('CIVICRM_UF')) {
92 $this->fatal('You need to define CIVICRM_UF in civicrm.settings.php');
95 $this->userFramework
= CIVICRM_UF
;
96 $this->userFrameworkClass
= 'CRM_Utils_System_' . CIVICRM_UF
;
97 $this->userHookClass
= 'CRM_Utils_Hook_' . CIVICRM_UF
;
99 if (CIVICRM_UF
== 'Joomla') {
100 $this->userFrameworkURLVar
= 'task';
103 if (defined('CIVICRM_UF_DSN')) {
104 $this->userFrameworkDSN
= CIVICRM_UF_DSN
;
107 // this is dynamically figured out in the civicrm.settings.php file
108 if (defined('CIVICRM_CLEANURL')) {
109 $this->cleanURL
= CIVICRM_CLEANURL
;
115 $this->templateDir
= [dirname(dirname(dirname(__DIR__
))) . DIRECTORY_SEPARATOR
. 'templates' . DIRECTORY_SEPARATOR
];
117 $this->initialized
= 1;
121 * Exit processing after a fatal event, outputting the message.
123 * @param string $message
125 private function fatal($message) {
131 * Include custom PHP and template paths
133 public function includeCustomPath() {
134 $customProprtyName = ['customPHPPathDir', 'customTemplateDir'];
135 foreach ($customProprtyName as $property) {
136 $value = $this->getSettings()->get($property);
137 if (!empty($value)) {
138 $customPath = Civi
::paths()->getPath($value);
139 set_include_path($customPath . PATH_SEPARATOR
. get_include_path());
145 * Create a unique identification code for this runtime.
147 * If two requests involve a different hostname, different
148 * port, different DSN, etc., then they should also have a
149 * different runtime ID.
153 public static function getId() {
154 if (!isset(Civi
::$statics[__CLASS__
]['id'])) {
155 Civi
::$statics[__CLASS__
]['id'] = md5(implode(\CRM_Core_DAO
::VALUE_SEPARATOR
, [
156 // e.g. one database, multi URL
157 defined('CIVICRM_DOMAIN_ID') ? CIVICRM_DOMAIN_ID
: 1,
158 // e.g. one codebase, multi database
159 parse_url(CIVICRM_DSN
, PHP_URL_PATH
),
160 // e.g. CMS vs extern vs installer
161 \CRM_Utils_Array
::value('SCRIPT_FILENAME', $_SERVER, ''),
162 // e.g. name-based vhosts
163 \CRM_Utils_Array
::value('HTTP_HOST', $_SERVER, ''),
164 // e.g. port-based vhosts
165 \CRM_Utils_Array
::value('SERVER_PORT', $_SERVER, ''),
167 defined('CIVICRM_TEST') ?
1 : 0,
168 // Depending on deployment arch, these signals *could* be redundant, but who cares?
171 return Civi
::$statics[__CLASS__
]['id'];