Commit | Line | Data |
---|---|---|
c0a1f187 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
c0a1f187 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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_Runtime | |
30 | * | |
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). | |
34 | */ | |
1b81ed50 | 35 | class CRM_Core_Config_Runtime extends CRM_Core_Config_MagicMerge { |
c0a1f187 TO |
36 | |
37 | public $dsn; | |
38 | ||
39 | /** | |
40 | * The name of user framework | |
41 | * | |
42 | * @var string | |
43 | */ | |
44 | public $userFramework; | |
45 | ||
46 | public $userFrameworkBaseURL; | |
47 | ||
48 | public $userFrameworkClass; | |
49 | ||
50 | /** | |
51 | * The dsn of the database connection for user framework | |
52 | * | |
53 | * @var string | |
54 | */ | |
55 | public $userFrameworkDSN; | |
56 | ||
57 | /** | |
58 | * The name of user framework url variable name | |
59 | * | |
60 | * @var string | |
61 | */ | |
62 | public $userFrameworkURLVar = 'q'; | |
63 | ||
606999ec TO |
64 | public $userFrameworkVersion; |
65 | ||
c0a1f187 TO |
66 | public $useFrameworkRelativeBase; |
67 | ||
68 | public $userHookClass; | |
69 | ||
c0a1f187 TO |
70 | /** |
71 | * Are we generating clean url's and using mod_rewrite | |
72 | * @var string | |
73 | */ | |
74 | public $cleanURL; | |
75 | ||
c0a1f187 TO |
76 | /** |
77 | * The root directory of our template tree. | |
78 | * @var string | |
79 | */ | |
80 | public $templateDir; | |
81 | ||
c0a1f187 TO |
82 | /** |
83 | * @param bool $loadFromDB | |
84 | */ | |
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'); | |
88 | } | |
89 | $this->dsn = defined('CIVICRM_DSN') ? CIVICRM_DSN : NULL; | |
90 | ||
c0a1f187 TO |
91 | if (!defined('CIVICRM_UF')) { |
92 | $this->fatal('You need to define CIVICRM_UF in civicrm.settings.php'); | |
93 | } | |
c0a1f187 | 94 | |
d4330c62 TO |
95 | $this->userFramework = CIVICRM_UF; |
96 | $this->userFrameworkClass = 'CRM_Utils_System_' . CIVICRM_UF; | |
97 | $this->userHookClass = 'CRM_Utils_Hook_' . CIVICRM_UF; | |
c0a1f187 | 98 | |
d4330c62 | 99 | if (CIVICRM_UF == 'Joomla') { |
c0a1f187 TO |
100 | $this->userFrameworkURLVar = 'task'; |
101 | } | |
102 | ||
c0a1f187 TO |
103 | if (defined('CIVICRM_UF_DSN')) { |
104 | $this->userFrameworkDSN = CIVICRM_UF_DSN; | |
105 | } | |
106 | ||
107 | // this is dynamically figured out in the civicrm.settings.php file | |
108 | if (defined('CIVICRM_CLEANURL')) { | |
109 | $this->cleanURL = CIVICRM_CLEANURL; | |
110 | } | |
111 | else { | |
112 | $this->cleanURL = 0; | |
113 | } | |
d4330c62 | 114 | |
be2fb01f | 115 | $this->templateDir = [dirname(dirname(dirname(__DIR__))) . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR]; |
d4330c62 | 116 | |
d4330c62 | 117 | $this->initialized = 1; |
c0a1f187 TO |
118 | } |
119 | ||
f2ac86d1 | 120 | /** |
121 | * Exit processing after a fatal event, outputting the message. | |
122 | * | |
123 | * @param string $message | |
124 | */ | |
c0a1f187 TO |
125 | private function fatal($message) { |
126 | echo $message; | |
127 | exit(); | |
128 | } | |
129 | ||
1b81ed50 | 130 | /** |
131 | * Include custom PHP and template paths | |
132 | */ | |
133 | public function includeCustomPath() { | |
be2fb01f | 134 | $customProprtyName = ['customPHPPathDir', 'customTemplateDir']; |
1b81ed50 | 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()); | |
140 | } | |
141 | } | |
142 | } | |
143 | ||
83617886 TO |
144 | /** |
145 | * Create a unique identification code for this runtime. | |
146 | * | |
147 | * If two requests involve a different hostname, different | |
148 | * port, different DSN, etc., then they should also have a | |
149 | * different runtime ID. | |
150 | * | |
151 | * @return mixed | |
152 | */ | |
153 | public static function getId() { | |
154 | if (!isset(Civi::$statics[__CLASS__]['id'])) { | |
be2fb01f | 155 | Civi::$statics[__CLASS__]['id'] = md5(implode(\CRM_Core_DAO::VALUE_SEPARATOR, [ |
518fa0ee SL |
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, ''), | |
83617886 | 166 | // Depending on deployment arch, these signals *could* be redundant, but who cares? |
be2fb01f | 167 | ])); |
83617886 TO |
168 | } |
169 | return Civi::$statics[__CLASS__]['id']; | |
170 | } | |
171 | ||
c0a1f187 | 172 | } |