Rev 292 | Rev 295 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2 | daniel-mar | 1 | <?php |
2 | |||
3 | /* |
||
4 | * OIDplus 2.0 |
||
5 | * Copyright 2019 Daniel Marschall, ViaThinkSoft |
||
6 | * |
||
7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
||
8 | * you may not use this file except in compliance with the License. |
||
9 | * You may obtain a copy of the License at |
||
10 | * |
||
11 | * http://www.apache.org/licenses/LICENSE-2.0 |
||
12 | * |
||
13 | * Unless required by applicable law or agreed to in writing, software |
||
14 | * distributed under the License is distributed on an "AS IS" BASIS, |
||
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||
16 | * See the License for the specific language governing permissions and |
||
17 | * limitations under the License. |
||
18 | */ |
||
19 | |||
20 | class OIDplus { |
||
281 | daniel-mar | 21 | private static /*OIDplusPagePlugin[]*/ $pagePlugins = array(); |
22 | private static /*OIDplusAuthPlugin[]*/ $authPlugins = array(); |
||
289 | daniel-mar | 23 | private static /*OIDplusLoggerPlugin[]*/ $loggerPlugins = array(); |
227 | daniel-mar | 24 | private static /*OIDplusObjectTypePlugin[]*/ $objectTypePlugins = array(); |
25 | private static /*string[]*/ $enabledObjectTypes = array(); |
||
26 | private static /*string[]*/ $disabledObjectTypes = array(); |
||
27 | private static /*OIDplusDatabasePlugin[]*/ $dbPlugins = array(); |
||
274 | daniel-mar | 28 | private static /*OIDplusSqlSlangPlugin[]*/ $sqlSlangPlugins = array(); |
2 | daniel-mar | 29 | |
280 | daniel-mar | 30 | protected static $html = true; |
236 | daniel-mar | 31 | |
2 | daniel-mar | 32 | private function __construct() { |
33 | } |
||
294 | daniel-mar | 34 | |
263 | daniel-mar | 35 | # --- Static classes |
274 | daniel-mar | 36 | |
263 | daniel-mar | 37 | private static $baseConfig = null; |
38 | private static $old_config_format = false; |
||
261 | daniel-mar | 39 | public static function baseConfig() { |
263 | daniel-mar | 40 | $first_init = false; |
274 | daniel-mar | 41 | |
263 | daniel-mar | 42 | if ($first_init = is_null(self::$baseConfig)) { |
43 | self::$baseConfig = new OIDplusBaseConfig(); |
||
261 | daniel-mar | 44 | } |
45 | |||
263 | daniel-mar | 46 | if ($first_init) { |
261 | daniel-mar | 47 | // Include a file containing various size/depth limitations of OIDs |
294 | daniel-mar | 48 | // It is important to include it before userdata/baseconfig/config.inc.php was included, |
49 | // so we can give userdata/baseconfig/config.inc.php the chance to override the values. |
||
261 | daniel-mar | 50 | |
294 | daniel-mar | 51 | include OIDplus::basePath().'/includes/limits.inc.php'; |
261 | daniel-mar | 52 | |
53 | // Include config file |
||
294 | daniel-mar | 54 | |
55 | $config_file = OIDplus::basePath() . '/userdata/baseconfig/config.inc.php'; |
||
56 | $config_file_old = OIDplus::basePath() . '/includes/config.inc.php'; // backwards compatibility |
||
57 | |||
58 | if (!file_exists($config_file) && file_exists($config_file_old)) { |
||
59 | $config_file = $config_file_old; |
||
60 | } |
||
261 | daniel-mar | 61 | |
294 | daniel-mar | 62 | if (file_exists($config_file)) { |
263 | daniel-mar | 63 | if (self::$old_config_format) { |
64 | // Note: We may only include it once due to backwards compatibility, |
||
65 | // since in version 2.0, the configuration was defined using define() statements |
||
66 | // Attention: This does mean that a full re-init (e.g. for test cases) is not possible |
||
67 | // if a version 2.0 config is used! |
||
294 | daniel-mar | 68 | include_once $config_file; |
263 | daniel-mar | 69 | } else { |
294 | daniel-mar | 70 | include $config_file; |
263 | daniel-mar | 71 | } |
261 | daniel-mar | 72 | |
73 | if (defined('OIDPLUS_CONFIG_VERSION') && (OIDPLUS_CONFIG_VERSION == 2.0)) { |
||
263 | daniel-mar | 74 | self::$old_config_format = true; |
274 | daniel-mar | 75 | |
261 | daniel-mar | 76 | // Backwards compatibility 2.0 => 2.1 |
77 | foreach (get_defined_constants(true)['user'] as $name => $value) { |
||
78 | $name = str_replace('OIDPLUS_', '', $name); |
||
79 | if ($name == 'SESSION_SECRET') $name = 'SERVER_SECRET'; |
||
80 | if ($name == 'MYSQL_QUERYLOG') $name = 'QUERY_LOGFILE'; |
||
81 | if (($name == 'MYSQL_PASSWORD') || ($name == 'ODBC_PASSWORD') || ($name == 'PDO_PASSWORD') || ($name == 'PGSQL_PASSWORD')) { |
||
263 | daniel-mar | 82 | self::$baseConfig->setValue($name, base64_decode($value)); |
261 | daniel-mar | 83 | } else { |
84 | if ($name == 'CONFIG_VERSION') $value = 2.1; |
||
263 | daniel-mar | 85 | self::$baseConfig->setValue($name, $value); |
261 | daniel-mar | 86 | } |
87 | } |
||
88 | } |
||
89 | } else { |
||
294 | daniel-mar | 90 | if (!is_dir(OIDplus::basePath().'/setup')) { |
91 | throw new OIDplusConfigInitializationException('File userdata/baseconfig/config.inc.php is missing, but setup can\'t be started because its directory missing.'); |
||
261 | daniel-mar | 92 | } else { |
280 | daniel-mar | 93 | if (self::$html) { |
261 | daniel-mar | 94 | header('Location:'.OIDplus::getSystemUrl().'setup/'); |
95 | die('Redirecting to setup...'); |
||
96 | } else { |
||
97 | // This can be displayed in e.g. ajax.php |
||
294 | daniel-mar | 98 | throw new OIDplusConfigInitializationException('File userdata/baseconfig/config.inc.php is missing. Please run setup again.'); |
261 | daniel-mar | 99 | } |
100 | } |
||
101 | } |
||
102 | |||
103 | // Check important config settings |
||
104 | |||
263 | daniel-mar | 105 | if (self::$baseConfig->getValue('CONFIG_VERSION') != 2.1) { |
294 | daniel-mar | 106 | throw new OIDplusConfigInitializationException("The information located in $config_file is outdated."); |
261 | daniel-mar | 107 | } |
108 | |||
263 | daniel-mar | 109 | if (self::$baseConfig->getValue('SERVER_SECRET', '') === '') { |
294 | daniel-mar | 110 | throw new OIDplusConfigInitializationException("You must set a value for SERVER_SECRET in $config_file for the system to operate secure."); |
261 | daniel-mar | 111 | } |
112 | } |
||
113 | |||
263 | daniel-mar | 114 | return self::$baseConfig; |
261 | daniel-mar | 115 | } |
116 | |||
263 | daniel-mar | 117 | private static $config = null; |
2 | daniel-mar | 118 | public static function config() { |
263 | daniel-mar | 119 | if ($first_init = is_null(self::$config)) { |
120 | self::$config = new OIDplusConfig(); |
||
2 | daniel-mar | 121 | } |
263 | daniel-mar | 122 | |
123 | if ($first_init) { |
||
124 | // These are important settings for base functionalities and therefore are not inside plugins |
||
125 | self::$config->prepareConfigKey('system_title', 'What is the name of your RA?', 'OIDplus 2.0', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
||
126 | if (empty($value)) { |
||
127 | throw new OIDplusException("Please enter a value for the system title."); |
||
128 | } |
||
129 | }); |
||
130 | self::$config->prepareConfigKey('admin_email', 'E-Mail address of the system administrator', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
||
131 | if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) { |
||
132 | throw new OIDplusException("This is not a correct email address"); |
||
133 | } |
||
134 | }); |
||
135 | self::$config->prepareConfigKey('global_cc', 'Global CC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
||
136 | if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) { |
||
137 | throw new OIDplusException("This is not a correct email address"); |
||
138 | } |
||
139 | }); |
||
140 | self::$config->prepareConfigKey('objecttypes_initialized', 'List of object type plugins that were initialized once', '', OIDplusConfig::PROTECTION_READONLY, function($value) { |
||
141 | // Nothing here yet |
||
142 | }); |
||
143 | self::$config->prepareConfigKey('objecttypes_enabled', 'Enabled object types and their order, separated with a semicolon (please reload the page so that the change is applied)', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) { |
||
144 | # TODO: when objecttypes_enabled is changed at the admin control panel, we need to do a reload of the page, so that jsTree will be updated. Is there anything we can do? |
||
145 | |||
146 | $ary = explode(';',$value); |
||
147 | $uniq_ary = array_unique($ary); |
||
148 | |||
149 | if (count($ary) != count($uniq_ary)) { |
||
150 | throw new OIDplusException("Please check your input. Some object types are double."); |
||
151 | } |
||
152 | |||
153 | foreach ($ary as $ot_check) { |
||
154 | $ns_found = false; |
||
155 | foreach (OIDplus::getEnabledObjectTypes() as $ot) { |
||
156 | if ($ot::ns() == $ot_check) { |
||
157 | $ns_found = true; |
||
158 | break; |
||
159 | } |
||
160 | } |
||
161 | foreach (OIDplus::getDisabledObjectTypes() as $ot) { |
||
162 | if ($ot::ns() == $ot_check) { |
||
163 | $ns_found = true; |
||
164 | break; |
||
165 | } |
||
166 | } |
||
167 | if (!$ns_found) { |
||
168 | throw new OIDplusException("Please check your input. Namespace \"$ot_check\" is not found"); |
||
169 | } |
||
170 | } |
||
171 | }); |
||
172 | self::$config->prepareConfigKey('oidplus_private_key', 'Private key for this system', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) { |
||
173 | // Nothing here yet |
||
174 | }); |
||
175 | self::$config->prepareConfigKey('oidplus_public_key', 'Public key for this system. If you "clone" your system, you must delete this key (e.g. using phpMyAdmin), so that a new one is created.', '', OIDplusConfig::PROTECTION_READONLY, function($value) { |
||
176 | // Nothing here yet |
||
177 | }); |
||
178 | |||
179 | } |
||
180 | |||
181 | return self::$config; |
||
2 | daniel-mar | 182 | } |
183 | |||
263 | daniel-mar | 184 | private static $gui = null; |
2 | daniel-mar | 185 | public static function gui() { |
263 | daniel-mar | 186 | if (is_null(self::$gui)) { |
187 | self::$gui = new OIDplusGui(); |
||
86 | daniel-mar | 188 | } |
263 | daniel-mar | 189 | return self::$gui; |
2 | daniel-mar | 190 | } |
191 | |||
263 | daniel-mar | 192 | private static $authUtils = null; |
2 | daniel-mar | 193 | public static function authUtils() { |
263 | daniel-mar | 194 | if (is_null(self::$authUtils)) { |
195 | self::$authUtils = new OIDplusAuthUtils(); |
||
86 | daniel-mar | 196 | } |
263 | daniel-mar | 197 | return self::$authUtils; |
2 | daniel-mar | 198 | } |
199 | |||
263 | daniel-mar | 200 | private static $mailUtils = null; |
250 | daniel-mar | 201 | public static function mailUtils() { |
263 | daniel-mar | 202 | if (is_null(self::$mailUtils)) { |
203 | self::$mailUtils = new OIDplusMailUtils(); |
||
250 | daniel-mar | 204 | } |
263 | daniel-mar | 205 | return self::$mailUtils; |
250 | daniel-mar | 206 | } |
207 | |||
263 | daniel-mar | 208 | private static $menuUtils = null; |
250 | daniel-mar | 209 | public static function menuUtils() { |
263 | daniel-mar | 210 | if (is_null(self::$menuUtils)) { |
211 | self::$menuUtils = new OIDplusMenuUtils(); |
||
250 | daniel-mar | 212 | } |
263 | daniel-mar | 213 | return self::$menuUtils; |
250 | daniel-mar | 214 | } |
215 | |||
263 | daniel-mar | 216 | private static $logger = null; |
115 | daniel-mar | 217 | public static function logger() { |
263 | daniel-mar | 218 | if (is_null(self::$logger)) { |
219 | self::$logger = new OIDplusLogger(); |
||
115 | daniel-mar | 220 | } |
263 | daniel-mar | 221 | return self::$logger; |
115 | daniel-mar | 222 | } |
223 | |||
263 | daniel-mar | 224 | private static $sesHandler = null; |
86 | daniel-mar | 225 | public static function sesHandler() { |
263 | daniel-mar | 226 | if (is_null(self::$sesHandler)) { |
227 | self::$sesHandler = new OIDplusSessionHandler(); |
||
86 | daniel-mar | 228 | } |
263 | daniel-mar | 229 | return self::$sesHandler; |
86 | daniel-mar | 230 | } |
231 | |||
274 | daniel-mar | 232 | # --- SQL slang plugin |
233 | |||
234 | private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) { |
||
235 | $name = $plugin::id(); |
||
236 | if ($name === false) return false; |
||
237 | |||
238 | self::$sqlSlangPlugins[$name] = $plugin; |
||
239 | |||
240 | return true; |
||
241 | } |
||
242 | |||
243 | public static function getSqlSlangPlugins() { |
||
244 | return self::$sqlSlangPlugins; |
||
245 | } |
||
246 | |||
230 | daniel-mar | 247 | # --- Database plugin |
74 | daniel-mar | 248 | |
227 | daniel-mar | 249 | private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) { |
275 | daniel-mar | 250 | $name = $plugin::id(); |
150 | daniel-mar | 251 | if ($name === false) return false; |
252 | |||
253 | self::$dbPlugins[$name] = $plugin; |
||
254 | |||
255 | return true; |
||
256 | } |
||
257 | |||
258 | public static function getDatabasePlugins() { |
||
259 | return self::$dbPlugins; |
||
260 | } |
||
261 | |||
227 | daniel-mar | 262 | public static function db() { |
261 | daniel-mar | 263 | if (OIDplus::baseConfig()->getValue('DATABASE_PLUGIN', '') === '') { |
260 | daniel-mar | 264 | throw new OIDplusConfigInitializationException("No database plugin selected in config file"); |
265 | } |
||
261 | daniel-mar | 266 | if (!isset(self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')])) { |
267 | throw new OIDplusConfigInitializationException("Database plugin '".OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')."' not found"); |
||
227 | daniel-mar | 268 | } |
261 | daniel-mar | 269 | $obj = self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')]; |
227 | daniel-mar | 270 | if (!$obj->isConnected()) $obj->connect(); |
271 | return $obj; |
||
272 | } |
||
273 | |||
274 | # --- Page plugin |
||
275 | |||
224 | daniel-mar | 276 | private static function registerPagePlugin(OIDplusPagePlugin $plugin) { |
281 | daniel-mar | 277 | self::$pagePlugins[] = $plugin; |
61 | daniel-mar | 278 | |
279 | return true; |
||
280 | } |
||
281 | |||
281 | daniel-mar | 282 | public static function getPagePlugins() { |
283 | return self::$pagePlugins; |
||
61 | daniel-mar | 284 | } |
285 | |||
227 | daniel-mar | 286 | # --- Auth plugin |
287 | |||
288 | private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) { |
||
289 | self::$authPlugins[] = $plugin; |
||
290 | return true; |
||
291 | } |
||
292 | |||
221 | daniel-mar | 293 | public static function getAuthPlugins() { |
294 | return self::$authPlugins; |
||
295 | } |
||
296 | |||
289 | daniel-mar | 297 | # --- Logger plugin |
298 | |||
299 | private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) { |
||
300 | self::$loggerPlugins[] = $plugin; |
||
301 | return true; |
||
302 | } |
||
303 | |||
304 | public static function getLoggerPlugins() { |
||
305 | return self::$loggerPlugins; |
||
306 | } |
||
307 | |||
227 | daniel-mar | 308 | # --- Object type plugin |
309 | |||
310 | private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) { |
||
311 | self::$objectTypePlugins[] = $plugin; |
||
312 | |||
313 | $ot = $plugin::getObjectTypeClassName(); |
||
314 | self::registerObjectType($ot); |
||
315 | |||
316 | return true; |
||
317 | } |
||
318 | |||
224 | daniel-mar | 319 | private static function registerObjectType($ot) { |
66 | daniel-mar | 320 | $ns = $ot::ns(); |
321 | |||
250 | daniel-mar | 322 | if (empty($ns)) throw new OIDplusException("Attention: Empty NS at $ot\n"); |
66 | daniel-mar | 323 | |
324 | $ns_found = false; |
||
227 | daniel-mar | 325 | foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) { |
66 | daniel-mar | 326 | if ($test_ot::ns() == $ns) { |
327 | $ns_found = true; |
||
328 | break; |
||
329 | } |
||
330 | } |
||
331 | if ($ns_found) { |
||
250 | daniel-mar | 332 | throw new OIDplusException("Attention: Two objectType plugins use the same namespace \"$ns\"!"); |
66 | daniel-mar | 333 | } |
334 | |||
335 | $init = OIDplus::config()->getValue("objecttypes_initialized"); |
||
336 | $init_ary = empty($init) ? array() : explode(';', $init); |
||
70 | daniel-mar | 337 | $init_ary = array_map('trim', $init_ary); |
66 | daniel-mar | 338 | |
339 | $enabled = OIDplus::config()->getValue("objecttypes_enabled"); |
||
340 | $enabled_ary = empty($enabled) ? array() : explode(';', $enabled); |
||
70 | daniel-mar | 341 | $enabled_ary = array_map('trim', $enabled_ary); |
66 | daniel-mar | 342 | |
79 | daniel-mar | 343 | $do_enable = false; |
344 | if (in_array($ns, $enabled_ary)) { |
||
345 | $do_enable = true; |
||
346 | } else { |
||
347 | if (!OIDplus::config()->getValue('registration_done')) { |
||
348 | $do_enable = $ns == 'oid'; |
||
349 | } else { |
||
350 | $do_enable = !in_array($ns, $init_ary); |
||
351 | } |
||
352 | } |
||
353 | |||
354 | if ($do_enable) { |
||
227 | daniel-mar | 355 | self::$enabledObjectTypes[] = $ot; |
356 | usort(self::$enabledObjectTypes, function($a, $b) { |
||
66 | daniel-mar | 357 | $enabled = OIDplus::config()->getValue("objecttypes_enabled"); |
358 | $enabled_ary = explode(';', $enabled); |
||
359 | |||
360 | $idx_a = array_search($a::ns(), $enabled_ary); |
||
361 | $idx_b = array_search($b::ns(), $enabled_ary); |
||
362 | |||
363 | if ($idx_a == $idx_b) { |
||
364 | return 0; |
||
365 | } |
||
366 | return ($idx_a > $idx_b) ? +1 : -1; |
||
367 | }); |
||
74 | daniel-mar | 368 | } else { |
369 | self::$disabledObjectTypes[] = $ot; |
||
66 | daniel-mar | 370 | } |
371 | |||
372 | if (!in_array($ns, $init_ary)) { |
||
373 | // Was never initialized before, so we add it to the list of enabled object types once |
||
374 | |||
79 | daniel-mar | 375 | if ($do_enable) { |
376 | $enabled_ary[] = $ns; |
||
377 | OIDplus::config()->setValue("objecttypes_enabled", implode(';', $enabled_ary)); |
||
378 | } |
||
66 | daniel-mar | 379 | |
380 | $init_ary[] = $ns; |
||
381 | OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary)); |
||
382 | } |
||
61 | daniel-mar | 383 | } |
384 | |||
227 | daniel-mar | 385 | public static function getObjectTypePlugins() { |
386 | return self::$objectTypePlugins; |
||
61 | daniel-mar | 387 | } |
388 | |||
227 | daniel-mar | 389 | public static function getObjectTypePluginsEnabled() { |
390 | $res = array(); |
||
391 | foreach (self::$objectTypePlugins as $plugin) { |
||
392 | $ot = $plugin::getObjectTypeClassName(); |
||
393 | if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin; |
||
394 | } |
||
395 | return $res; |
||
74 | daniel-mar | 396 | } |
397 | |||
227 | daniel-mar | 398 | public static function getObjectTypePluginsDisabled() { |
399 | $res = array(); |
||
400 | foreach (self::$objectTypePlugins as $plugin) { |
||
401 | $ot = $plugin::getObjectTypeClassName(); |
||
402 | if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin; |
||
74 | daniel-mar | 403 | } |
227 | daniel-mar | 404 | return $res; |
74 | daniel-mar | 405 | } |
406 | |||
227 | daniel-mar | 407 | public static function getEnabledObjectTypes() { |
408 | return self::$enabledObjectTypes; |
||
409 | } |
||
74 | daniel-mar | 410 | |
227 | daniel-mar | 411 | public static function getDisabledObjectTypes() { |
412 | return self::$disabledObjectTypes; |
||
413 | } |
||
74 | daniel-mar | 414 | |
277 | daniel-mar | 415 | # --- Plugin handling functions |
416 | |||
417 | public static function getPluginInfo($class_name): array { |
||
418 | $reflector = new ReflectionClass($class_name); |
||
419 | $ini = dirname($reflector->getFileName()).'/manifest.ini'; |
||
420 | if (!file_exists($ini)) return array(); |
||
421 | $bry = parse_ini_file($ini, true, INI_SCANNER_TYPED); |
||
422 | if (!isset($bry['Plugin'])) return array(); |
||
423 | return $bry['Plugin']; |
||
424 | } |
||
425 | |||
426 | public static function getAllPluginManifests($pluginFolderMask='*'): array { |
||
427 | $out = array(); |
||
279 | daniel-mar | 428 | // Note: glob() will sort by default, so we do not need a page priority attribute. |
429 | // So you just need to use a numeric plugin directory prefix (padded). |
||
294 | daniel-mar | 430 | $ary = glob(OIDplus::basePath().'/plugins/'.$pluginFolderMask.'/'.'*'.'/manifest.ini'); |
277 | daniel-mar | 431 | foreach ($ary as $ini) { |
432 | if (!file_exists($ini)) continue; |
||
433 | $bry = parse_ini_file($ini, true, INI_SCANNER_TYPED); |
||
434 | |||
435 | $plugintype_folder = basename(dirname(dirname($ini))); |
||
436 | $pluginname_folder = basename(dirname($ini)); |
||
437 | |||
438 | if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array(); |
||
439 | if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array(); |
||
440 | $out[$plugintype_folder][$pluginname_folder] = $bry; |
||
441 | } |
||
442 | return $out; |
||
443 | } |
||
444 | |||
445 | public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array { |
||
446 | $out = array(); |
||
279 | daniel-mar | 447 | $ary = self::getAllPluginManifests($pluginDirName); |
277 | daniel-mar | 448 | foreach ($ary as $plugintype_folder => $bry) { |
449 | foreach ($bry as $pluginname_folder => $cry) { |
||
279 | daniel-mar | 450 | if (!isset($cry['PHP']) || !isset($cry['PHP']['pluginclass'])) { |
451 | throw new OIDplusException("Plugin '$plugintype_folder/$pluginname_folder' is errornous: Plugin class is not defined (manifest.ini section 'PHP', key 'pluginclass'"); |
||
277 | daniel-mar | 452 | } |
279 | daniel-mar | 453 | $class_name = $cry['PHP']['pluginclass']; |
292 | daniel-mar | 454 | if (!class_exists($class_name)) { |
455 | throw new OIDplusException("Plugin '$plugintype_folder/$pluginname_folder' is errornous: Plugin class '$class_name' not found (manifest.ini section 'PHP', key 'pluginclass'"); |
||
456 | } |
||
279 | daniel-mar | 457 | if (!is_subclass_of($class_name, $expectedPluginClass)) { |
458 | throw new OIDplusException("Plugin '$plugintype_folder/$pluginname_folder' is errornous: Plugin class '$class_name' is expected to be a subclass of '$expectedPluginClass'"); |
||
459 | } |
||
460 | $out[] = $class_name; |
||
461 | if (!is_null($registerCallback)) { |
||
462 | call_user_func($registerCallback, new $class_name()); |
||
463 | } |
||
277 | daniel-mar | 464 | } |
465 | |||
466 | } |
||
467 | return $out; |
||
468 | } |
||
469 | |||
227 | daniel-mar | 470 | # --- Initialization of OIDplus |
206 | daniel-mar | 471 | |
2 | daniel-mar | 472 | public static function init($html=true) { |
236 | daniel-mar | 473 | self::$html = $html; |
474 | |||
263 | daniel-mar | 475 | // Reset internal state, so we can re-init verything if required |
274 | daniel-mar | 476 | |
263 | daniel-mar | 477 | if (self::$old_config_format) { |
478 | // Note: This can only happen in very special cases (e.g. test cases) where you call init() twice |
||
479 | throw new OIDplusConfigInitializationException('A full re-initialization is not possible if a version 2.0 config file (containing "defines") is used. Please update to a config 2.1 file by running setup again.'); |
||
480 | } |
||
274 | daniel-mar | 481 | |
263 | daniel-mar | 482 | self::$config = null; |
483 | self::$baseConfig = null; |
||
484 | self::$gui = null; |
||
485 | self::$authUtils = null; |
||
486 | self::$mailUtils = null; |
||
487 | self::$menuUtils = null; |
||
488 | self::$logger = null; |
||
489 | self::$sesHandler = null; |
||
490 | self::$pagePlugins = array(); |
||
491 | self::$authPlugins = array(); |
||
289 | daniel-mar | 492 | self::$loggerPlugins = array(); |
263 | daniel-mar | 493 | self::$objectTypePlugins = array(); |
494 | self::$enabledObjectTypes = array(); |
||
495 | self::$disabledObjectTypes = array(); |
||
496 | self::$dbPlugins = array(); |
||
274 | daniel-mar | 497 | self::$sqlSlangPlugins = array(); |
263 | daniel-mar | 498 | self::$system_id_cache = null; |
499 | self::$sslAvailableCache = null; |
||
74 | daniel-mar | 500 | |
263 | daniel-mar | 501 | // Continue... |
502 | |||
294 | daniel-mar | 503 | OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!) |
263 | daniel-mar | 504 | // You can do changes to the configuration afterwards using OIDplus::baseConfig()->... |
505 | |||
150 | daniel-mar | 506 | // Register database types (highest priority) |
507 | |||
274 | daniel-mar | 508 | // SQL slangs |
509 | |||
294 | daniel-mar | 510 | self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin')); |
274 | daniel-mar | 511 | foreach (OIDplus::getSqlSlangPlugins() as $plugin) { |
512 | $plugin->init($html); |
||
513 | } |
||
514 | |||
515 | // Database providers |
||
516 | |||
277 | daniel-mar | 517 | self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin')); |
237 | daniel-mar | 518 | foreach (OIDplus::getDatabasePlugins() as $plugin) { |
519 | $plugin->init($html); |
||
520 | } |
||
521 | |||
42 | daniel-mar | 522 | // Do redirect stuff etc. |
74 | daniel-mar | 523 | |
230 | daniel-mar | 524 | self::isSslAvailable(); // This function does automatic redirects |
61 | daniel-mar | 525 | |
263 | daniel-mar | 526 | // Construct the configuration manager |
66 | daniel-mar | 527 | |
263 | daniel-mar | 528 | OIDplus::config(); // During the construction, various system settings are prepared if required |
66 | daniel-mar | 529 | |
74 | daniel-mar | 530 | // Initialize public / private keys |
531 | |||
227 | daniel-mar | 532 | OIDplus::getPkiStatus(true); |
74 | daniel-mar | 533 | |
237 | daniel-mar | 534 | // Register non-DB plugins |
74 | daniel-mar | 535 | |
277 | daniel-mar | 536 | self::registerAllPlugins('*Pages', 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin')); |
537 | self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin')); |
||
289 | daniel-mar | 538 | self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin')); |
277 | daniel-mar | 539 | self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin')); |
150 | daniel-mar | 540 | |
237 | daniel-mar | 541 | // Initialize non-DB plugins |
224 | daniel-mar | 542 | |
281 | daniel-mar | 543 | foreach (OIDplus::getPagePlugins() as $plugin) { |
74 | daniel-mar | 544 | $plugin->init($html); |
545 | } |
||
230 | daniel-mar | 546 | foreach (OIDplus::getAuthPlugins() as $plugin) { |
547 | $plugin->init($html); |
||
548 | } |
||
289 | daniel-mar | 549 | foreach (OIDplus::getLoggerPlugins() as $plugin) { |
550 | $plugin->init($html); |
||
551 | } |
||
230 | daniel-mar | 552 | foreach (OIDplus::getObjectTypePlugins() as $plugin) { |
553 | $plugin->init($html); |
||
554 | } |
||
2 | daniel-mar | 555 | } |
42 | daniel-mar | 556 | |
227 | daniel-mar | 557 | # --- System URL, System ID, PKI, and other functions |
558 | |||
294 | daniel-mar | 559 | public static function basePath() { |
560 | return realpath(__DIR__ . '/../../'); |
||
561 | } |
||
562 | |||
227 | daniel-mar | 563 | public static function getSystemUrl($relative=false) { |
564 | if (!isset($_SERVER["SCRIPT_NAME"])) return false; |
||
565 | |||
566 | $test_dir = dirname($_SERVER['SCRIPT_FILENAME']); |
||
269 | daniel-mar | 567 | $test_dir = str_replace('\\', '/', $test_dir); |
227 | daniel-mar | 568 | $c = 0; |
569 | while (!file_exists($test_dir.'/oidplus_base.js')) { |
||
570 | $test_dir = dirname($test_dir); |
||
571 | $c++; |
||
572 | if ($c == 1000) return false; |
||
573 | } |
||
574 | |||
575 | $res = dirname($_SERVER['SCRIPT_NAME'].'xxx'); |
||
576 | |||
577 | for ($i=1; $i<=$c; $i++) { |
||
578 | $res = dirname($res); |
||
579 | } |
||
580 | |||
269 | daniel-mar | 581 | $res = str_replace('\\', '/', $res); |
227 | daniel-mar | 582 | if ($res == '/') $res = ''; |
583 | $res .= '/'; |
||
584 | |||
585 | if (!$relative) { |
||
228 | daniel-mar | 586 | $is_ssl = isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on'); |
587 | $protocol = $is_ssl ? 'https' : 'http'; |
||
588 | $host = $_SERVER['HTTP_HOST']; |
||
589 | $port = $_SERVER['SERVER_PORT']; |
||
590 | if ($is_ssl && ($port != 443)) { |
||
591 | $port_add = ":$port"; |
||
592 | } else if (!$is_ssl && ($port != 80)) { |
||
593 | $port_add = ":$port"; |
||
594 | } else { |
||
595 | $port_add = ""; |
||
596 | } |
||
597 | $res = $protocol.'://'.$host.$port_add.$res; |
||
227 | daniel-mar | 598 | } |
599 | |||
600 | return $res; |
||
601 | } |
||
602 | |||
603 | private static $system_id_cache = null; |
||
604 | public static function getSystemId($oid=false) { |
||
605 | if (!is_null(self::$system_id_cache)) { |
||
606 | $out = self::$system_id_cache; |
||
607 | } else { |
||
608 | $out = false; |
||
609 | |||
610 | if (self::getPkiStatus(true)) { |
||
611 | $pubKey = OIDplus::config()->getValue('oidplus_public_key'); |
||
612 | if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) { |
||
613 | $out = smallhash(base64_decode($m[1])); |
||
614 | } |
||
615 | } |
||
616 | self::$system_id_cache = $out; |
||
617 | } |
||
291 | daniel-mar | 618 | return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out; |
227 | daniel-mar | 619 | } |
620 | |||
621 | public static function getPkiStatus($try_generate=true) { |
||
622 | if (!function_exists('openssl_pkey_new')) return false; |
||
623 | |||
624 | $privKey = OIDplus::config()->getValue('oidplus_private_key'); |
||
625 | $pubKey = OIDplus::config()->getValue('oidplus_public_key'); |
||
626 | |||
627 | if ($try_generate && !verify_private_public_key($privKey, $pubKey)) { |
||
263 | daniel-mar | 628 | $pkey_config = array( |
227 | daniel-mar | 629 | "digest_alg" => "sha512", |
630 | "private_key_bits" => 2048, |
||
631 | "private_key_type" => OPENSSL_KEYTYPE_RSA, |
||
632 | ); |
||
633 | |||
634 | // Create the private and public key |
||
263 | daniel-mar | 635 | $res = openssl_pkey_new($pkey_config); |
256 | daniel-mar | 636 | |
239 | daniel-mar | 637 | if (!$res) return false; |
227 | daniel-mar | 638 | |
639 | // Extract the private key from $res to $privKey |
||
640 | openssl_pkey_export($res, $privKey); |
||
641 | |||
642 | // Extract the public key from $res to $pubKey |
||
643 | $pubKey = openssl_pkey_get_details($res)["key"]; |
||
644 | |||
239 | daniel-mar | 645 | // Log |
288 | daniel-mar | 646 | OIDplus::logger()->log("[INFO]A!", "Generating new SystemID using a new key pair"); |
239 | daniel-mar | 647 | |
227 | daniel-mar | 648 | // Save the key pair to database |
649 | OIDplus::config()->setValue('oidplus_private_key', $privKey); |
||
650 | OIDplus::config()->setValue('oidplus_public_key', $pubKey); |
||
651 | |||
652 | // Log the new system ID |
||
653 | if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) { |
||
654 | $system_id = smallhash(base64_decode($m[1])); |
||
288 | daniel-mar | 655 | OIDplus::logger()->log("[INFO]A!", "Your SystemID is now $system_id"); |
227 | daniel-mar | 656 | } |
657 | } |
||
658 | |||
659 | return verify_private_public_key($privKey, $pubKey); |
||
660 | } |
||
661 | |||
170 | daniel-mar | 662 | public static function getInstallType() { |
294 | daniel-mar | 663 | if (!file_exists(OIDplus::basePath().'/oidplus_version.txt') && !is_dir(OIDplus::basePath().'/.svn')) { |
170 | daniel-mar | 664 | return 'unknown'; |
665 | } |
||
294 | daniel-mar | 666 | if (file_exists(OIDplus::basePath().'/oidplus_version.txt') && is_dir(OIDplus::basePath().'/.svn')) { |
170 | daniel-mar | 667 | return 'ambigous'; |
668 | } |
||
294 | daniel-mar | 669 | if (is_dir(OIDplus::basePath().'/.svn')) { |
170 | daniel-mar | 670 | return 'svn-wc'; |
671 | } |
||
294 | daniel-mar | 672 | if (file_exists(OIDplus::basePath().'/oidplus_version.txt')) { |
170 | daniel-mar | 673 | return 'svn-snapshot'; |
674 | } |
||
675 | } |
||
676 | |||
111 | daniel-mar | 677 | public static function getVersion() { |
294 | daniel-mar | 678 | if (file_exists(OIDplus::basePath().'/oidplus_version.txt') && is_dir(OIDplus::basePath().'/.svn')) { |
239 | daniel-mar | 679 | return false; // version is ambigous |
111 | daniel-mar | 680 | } |
162 | daniel-mar | 681 | |
294 | daniel-mar | 682 | if (is_dir(OIDplus::basePath().'/.svn')) { |
285 | daniel-mar | 683 | // Try to get the version via SQLite3 |
684 | if (class_exists('SQLite3')) { |
||
685 | try { |
||
294 | daniel-mar | 686 | $db = new SQLite3(OIDplus::basePath().'/.svn/wc.db'); |
285 | daniel-mar | 687 | $results = $db->query('SELECT MIN(revision) AS rev FROM NODES_BASE'); |
688 | while ($row = $results->fetchArray()) { |
||
689 | return 'svn-'.$row['rev']; |
||
690 | } |
||
691 | $db->close(); |
||
692 | $db = null; |
||
693 | } catch (Exception $e) { |
||
694 | } |
||
695 | } |
||
696 | if (class_exists('PDO')) { |
||
697 | try { |
||
294 | daniel-mar | 698 | $pdo = new PDO('sqlite:' . OIDplus::basePath().'/.svn/wc.db'); |
285 | daniel-mar | 699 | $res = $pdo->query('SELECT MIN(revision) AS rev FROM NODES_BASE'); |
700 | $row = $res->fetch(); |
||
701 | if ($row !== false) return 'svn-'.$row['rev']; |
||
702 | $pdo = null; |
||
703 | } catch (Exception $e) { |
||
704 | } |
||
705 | } |
||
706 | |||
162 | daniel-mar | 707 | // Try to find out the SVN version using the shell |
285 | daniel-mar | 708 | // We don't prioritize this method, because a failed shell access will flood the apache error log with STDERR messages |
294 | daniel-mar | 709 | $output = @shell_exec('svnversion '.escapeshellarg(OIDplus::basePath())); |
285 | daniel-mar | 710 | if (preg_match('/\d+/', $output, $match)) { |
239 | daniel-mar | 711 | return 'svn-'.$match[0]; |
162 | daniel-mar | 712 | } |
713 | |||
294 | daniel-mar | 714 | $output = @shell_exec('svn info '.escapeshellarg(OIDplus::basePath())); |
285 | daniel-mar | 715 | if (preg_match('/Revision:\s*(\d+)/m', $output, $match)) { |
716 | return 'svn-'.$match[1]; |
||
162 | daniel-mar | 717 | } |
718 | } |
||
719 | |||
294 | daniel-mar | 720 | if (file_exists(OIDplus::basePath().'/oidplus_version.txt')) { |
721 | $cont = file_get_contents(OIDplus::basePath().'/oidplus_version.txt'); |
||
239 | daniel-mar | 722 | if (preg_match('@Revision (\d+)@', $cont, $m)) |
723 | return 'svn-'.$m[1]; |
||
162 | daniel-mar | 724 | } |
725 | |||
239 | daniel-mar | 726 | return false; |
111 | daniel-mar | 727 | } |
728 | |||
230 | daniel-mar | 729 | private static $sslAvailableCache = null; |
730 | public static function isSslAvailable() { |
||
731 | if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache; |
||
256 | daniel-mar | 732 | |
230 | daniel-mar | 733 | if (php_sapi_name() == 'cli') { |
734 | self::$sslAvailableCache = false; |
||
735 | return false; |
||
736 | } |
||
737 | |||
49 | daniel-mar | 738 | $timeout = 2; |
80 | daniel-mar | 739 | $already_ssl = isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] == "on"); |
740 | $ssl_port = 443; |
||
227 | daniel-mar | 741 | $cookie_path = OIDplus::getSystemUrl(true); |
83 | daniel-mar | 742 | if (empty($cookie_path)) $cookie_path = '/'; |
42 | daniel-mar | 743 | |
261 | daniel-mar | 744 | $mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', 2/*auto*/); |
745 | |||
746 | if ($mode == 0) { |
||
80 | daniel-mar | 747 | // No SSL available |
230 | daniel-mar | 748 | self::$sslAvailableCache = $already_ssl; |
80 | daniel-mar | 749 | return $already_ssl; |
750 | } |
||
751 | |||
261 | daniel-mar | 752 | if ($mode == 1) { |
80 | daniel-mar | 753 | // Force SSL |
754 | if ($already_ssl) { |
||
230 | daniel-mar | 755 | self::$sslAvailableCache = true; |
80 | daniel-mar | 756 | return true; |
42 | daniel-mar | 757 | } else { |
80 | daniel-mar | 758 | $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; |
759 | header('Location:'.$location); |
||
240 | daniel-mar | 760 | die('Redirecting to HTTPS...'); |
230 | daniel-mar | 761 | self::$sslAvailableCache = true; |
80 | daniel-mar | 762 | return true; |
763 | } |
||
764 | } |
||
765 | |||
261 | daniel-mar | 766 | if ($mode == 2) { |
80 | daniel-mar | 767 | // Automatic SSL detection |
768 | |||
769 | if ($already_ssl) { |
||
770 | // we are already on HTTPS |
||
83 | daniel-mar | 771 | setcookie('SSL_CHECK', '1', 0, $cookie_path, '', false, true); |
230 | daniel-mar | 772 | self::$sslAvailableCache = true; |
80 | daniel-mar | 773 | return true; |
774 | } else { |
||
775 | if (isset($_COOKIE['SSL_CHECK'])) { |
||
776 | // We already had the HTTPS detection done before. |
||
777 | if ($_COOKIE['SSL_CHECK']) { |
||
778 | // HTTPS was detected before, but we are HTTP. Redirect now |
||
779 | $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; |
||
780 | header('Location:'.$location); |
||
240 | daniel-mar | 781 | die('Redirecting to HTTPS...'); |
230 | daniel-mar | 782 | self::$sslAvailableCache = true; |
80 | daniel-mar | 783 | return true; |
784 | } else { |
||
785 | // No HTTPS available. Do nothing. |
||
230 | daniel-mar | 786 | self::$sslAvailableCache = false; |
80 | daniel-mar | 787 | return false; |
788 | } |
||
49 | daniel-mar | 789 | } else { |
80 | daniel-mar | 790 | // This is our first check (or the browser didn't accept the SSL_CHECK cookie) |
791 | if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) { |
||
792 | // HTTPS detected. Redirect now, and remember that we had detected HTTPS |
||
83 | daniel-mar | 793 | setcookie('SSL_CHECK', '1', 0, $cookie_path, '', false, true); |
80 | daniel-mar | 794 | $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; |
795 | header('Location:'.$location); |
||
240 | daniel-mar | 796 | die('Redirecting to HTTPS...'); |
230 | daniel-mar | 797 | self::$sslAvailableCache = true; |
80 | daniel-mar | 798 | return true; |
799 | } else { |
||
800 | // No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again. |
||
83 | daniel-mar | 801 | setcookie('SSL_CHECK', '0', 0, $cookie_path, '', false, true); |
230 | daniel-mar | 802 | self::$sslAvailableCache = false; |
80 | daniel-mar | 803 | return false; |
804 | } |
||
49 | daniel-mar | 805 | } |
42 | daniel-mar | 806 | } |
807 | } |
||
808 | } |
||
241 | daniel-mar | 809 | |
810 | public static function webpath($target) { |
||
811 | $dir = __DIR__; |
||
812 | $dir = dirname($dir); |
||
813 | $dir = dirname($dir); |
||
814 | $target = substr($target, strlen($dir)+1, strlen($target)-strlen($dir)-1); |
||
815 | if ($target != '') { |
||
816 | $target = str_replace('\\','/',$target).'/'; |
||
817 | } |
||
818 | return $target; |
||
819 | } |
||
2 | daniel-mar | 820 | } |