Subversion Repositories oidplus

Rev

Rev 297 | Rev 308 | 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
        }
295 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
295 daniel-mar 54
 
294 daniel-mar 55
                        $config_file = OIDplus::basePath() . '/userdata/baseconfig/config.inc.php';
56
                        $config_file_old = OIDplus::basePath() . '/includes/config.inc.php'; // backwards compatibility
295 daniel-mar 57
 
294 daniel-mar 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
 
295 daniel-mar 262
        public static function getActiveDatabasePlugin() {
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
                }
295 daniel-mar 269
                return self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')];
227 daniel-mar 270
        }
271
 
295 daniel-mar 272
        private static $dbMainSession = null;
273
        public static function db() {
274
                if (is_null(self::$dbMainSession)) {
275
                        self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
276
                }
277
                if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
278
                return self::$dbMainSession;
279
        }
280
 
281
        private static $dbIsolatedSession = null;
282
        public static function dbIsolated() {
283
                if (is_null(self::$dbIsolatedSession)) {
284
                        self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
285
                }
286
                if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
287
                return self::$dbIsolatedSession;
288
        }
289
 
227 daniel-mar 290
        # --- Page plugin
291
 
224 daniel-mar 292
        private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
281 daniel-mar 293
                self::$pagePlugins[] = $plugin;
61 daniel-mar 294
 
295
                return true;
296
        }
297
 
281 daniel-mar 298
        public static function getPagePlugins() {
299
                return self::$pagePlugins;
61 daniel-mar 300
        }
301
 
227 daniel-mar 302
        # --- Auth plugin
303
 
304
        private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
305
                self::$authPlugins[] = $plugin;
306
                return true;
307
        }
308
 
221 daniel-mar 309
        public static function getAuthPlugins() {
310
                return self::$authPlugins;
311
        }
312
 
289 daniel-mar 313
        # --- Logger plugin
314
 
315
        private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
316
                self::$loggerPlugins[] = $plugin;
317
                return true;
318
        }
319
 
320
        public static function getLoggerPlugins() {
321
                return self::$loggerPlugins;
322
        }
323
 
227 daniel-mar 324
        # --- Object type plugin
325
 
326
        private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
327
                self::$objectTypePlugins[] = $plugin;
328
 
329
                $ot = $plugin::getObjectTypeClassName();
330
                self::registerObjectType($ot);
331
 
332
                return true;
333
        }
334
 
224 daniel-mar 335
        private static function registerObjectType($ot) {
66 daniel-mar 336
                $ns = $ot::ns();
337
 
250 daniel-mar 338
                if (empty($ns)) throw new OIDplusException("Attention: Empty NS at $ot\n");
66 daniel-mar 339
 
340
                $ns_found = false;
227 daniel-mar 341
                foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
66 daniel-mar 342
                        if ($test_ot::ns() == $ns) {
343
                                $ns_found = true;
344
                                break;
345
                        }
346
                }
347
                if ($ns_found) {
250 daniel-mar 348
                        throw new OIDplusException("Attention: Two objectType plugins use the same namespace \"$ns\"!");
66 daniel-mar 349
                }
350
 
351
                $init = OIDplus::config()->getValue("objecttypes_initialized");
352
                $init_ary = empty($init) ? array() : explode(';', $init);
70 daniel-mar 353
                $init_ary = array_map('trim', $init_ary);
66 daniel-mar 354
 
355
                $enabled = OIDplus::config()->getValue("objecttypes_enabled");
356
                $enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
70 daniel-mar 357
                $enabled_ary = array_map('trim', $enabled_ary);
66 daniel-mar 358
 
79 daniel-mar 359
                $do_enable = false;
360
                if (in_array($ns, $enabled_ary)) {
361
                        $do_enable = true;
362
                } else {
363
                        if (!OIDplus::config()->getValue('registration_done')) {
364
                                $do_enable = $ns == 'oid';
365
                        } else {
366
                                $do_enable = !in_array($ns, $init_ary);
367
                        }
368
                }
369
 
370
                if ($do_enable) {
227 daniel-mar 371
                        self::$enabledObjectTypes[] = $ot;
372
                        usort(self::$enabledObjectTypes, function($a, $b) {
66 daniel-mar 373
                                $enabled = OIDplus::config()->getValue("objecttypes_enabled");
374
                                $enabled_ary = explode(';', $enabled);
375
 
376
                                $idx_a = array_search($a::ns(), $enabled_ary);
377
                                $idx_b = array_search($b::ns(), $enabled_ary);
378
 
379
                                if ($idx_a == $idx_b) {
380
                                    return 0;
381
                                }
382
                                return ($idx_a > $idx_b) ? +1 : -1;
383
                        });
74 daniel-mar 384
                } else {
385
                        self::$disabledObjectTypes[] = $ot;
66 daniel-mar 386
                }
387
 
388
                if (!in_array($ns, $init_ary)) {
389
                        // Was never initialized before, so we add it to the list of enabled object types once
390
 
79 daniel-mar 391
                        if ($do_enable) {
392
                                $enabled_ary[] = $ns;
393
                                OIDplus::config()->setValue("objecttypes_enabled", implode(';', $enabled_ary));
394
                        }
66 daniel-mar 395
 
396
                        $init_ary[] = $ns;
397
                        OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
398
                }
61 daniel-mar 399
        }
400
 
227 daniel-mar 401
        public static function getObjectTypePlugins() {
402
                return self::$objectTypePlugins;
61 daniel-mar 403
        }
404
 
227 daniel-mar 405
        public static function getObjectTypePluginsEnabled() {
406
                $res = array();
407
                foreach (self::$objectTypePlugins as $plugin) {
408
                        $ot = $plugin::getObjectTypeClassName();
409
                        if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
410
                }
411
                return $res;
74 daniel-mar 412
        }
413
 
227 daniel-mar 414
        public static function getObjectTypePluginsDisabled() {
415
                $res = array();
416
                foreach (self::$objectTypePlugins as $plugin) {
417
                        $ot = $plugin::getObjectTypeClassName();
418
                        if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
74 daniel-mar 419
                }
227 daniel-mar 420
                return $res;
74 daniel-mar 421
        }
422
 
227 daniel-mar 423
        public static function getEnabledObjectTypes() {
424
                return self::$enabledObjectTypes;
425
        }
74 daniel-mar 426
 
227 daniel-mar 427
        public static function getDisabledObjectTypes() {
428
                return self::$disabledObjectTypes;
429
        }
74 daniel-mar 430
 
277 daniel-mar 431
        # --- Plugin handling functions
432
 
307 daniel-mar 433
        public static function getPluginManifest($class_name)/*: ?OIDplusPluginManifest*/ {
277 daniel-mar 434
                $reflector = new ReflectionClass($class_name);
435
                $ini = dirname($reflector->getFileName()).'/manifest.ini';
307 daniel-mar 436
                $manifest = new OIDplusPluginManifest();
437
                return $manifest->loadManifest($ini) ? $manifest : null;
277 daniel-mar 438
        }
439
 
307 daniel-mar 440
        public static function getAllPluginManifests($pluginFolderMask='*', $flat=true): array {
277 daniel-mar 441
                $out = array();
279 daniel-mar 442
                // Note: glob() will sort by default, so we do not need a page priority attribute.
443
                //       So you just need to use a numeric plugin directory prefix (padded).
294 daniel-mar 444
                $ary = glob(OIDplus::basePath().'/plugins/'.$pluginFolderMask.'/'.'*'.'/manifest.ini');
277 daniel-mar 445
                foreach ($ary as $ini) {
446
                        if (!file_exists($ini)) continue;
447
 
307 daniel-mar 448
                        $manifest = new OIDplusPluginManifest();
449
                        $manifest->loadManifest($ini);
277 daniel-mar 450
 
307 daniel-mar 451
                        if ($flat) {
452
                                $out[] = $manifest;
453
                        } else {
454
                                $plugintype_folder = basename(dirname(dirname($ini)));
455
                                $pluginname_folder = basename(dirname($ini));
456
 
457
                                if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
458
                                if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
459
                                $out[$plugintype_folder][$pluginname_folder] = $manifest;
460
                        }
277 daniel-mar 461
                }
462
                return $out;
463
        }
464
 
465
        public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
466
                $out = array();
307 daniel-mar 467
                $ary = self::getAllPluginManifests($pluginDirName, false);
277 daniel-mar 468
                foreach ($ary as $plugintype_folder => $bry) {
469
                        foreach ($bry as $pluginname_folder => $cry) {
307 daniel-mar 470
                                $class_name = $cry->getPhpMainClass();
471
                                if (!$class_name) {
472
                                        throw new OIDplusException("Plugin '$plugintype_folder/$pluginname_folder' is errornous: Manifest does not declare a PHP main class");
277 daniel-mar 473
                                }
297 daniel-mar 474
                                if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
475
                                        continue;
476
                                }
292 daniel-mar 477
                                if (!class_exists($class_name)) {
307 daniel-mar 478
                                        throw new OIDplusException("Plugin '$plugintype_folder/$pluginname_folder' is errornous: Manifest declares PHP main class as '$class_name', but it could not be found");
292 daniel-mar 479
                                }
279 daniel-mar 480
                                if (!is_subclass_of($class_name, $expectedPluginClass)) {
307 daniel-mar 481
                                        throw new OIDplusException("Plugin '$plugintype_folder/$pluginname_folder' is errornous: Plugin main class '$class_name' is expected to be a subclass of '$expectedPluginClass'");
279 daniel-mar 482
                                }
483
                                $out[] = $class_name;
484
                                if (!is_null($registerCallback)) {
485
                                        call_user_func($registerCallback, new $class_name());
486
                                }
277 daniel-mar 487
                        }
488
 
489
                }
490
                return $out;
491
        }
492
 
227 daniel-mar 493
        # --- Initialization of OIDplus
206 daniel-mar 494
 
2 daniel-mar 495
        public static function init($html=true) {
236 daniel-mar 496
                self::$html = $html;
497
 
263 daniel-mar 498
                // Reset internal state, so we can re-init verything if required
274 daniel-mar 499
 
263 daniel-mar 500
                if (self::$old_config_format) {
501
                        // Note: This can only happen in very special cases (e.g. test cases) where you call init() twice
502
                        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.');
503
                }
274 daniel-mar 504
 
263 daniel-mar 505
                self::$config = null;
506
                self::$baseConfig = null;
507
                self::$gui = null;
508
                self::$authUtils = null;
509
                self::$mailUtils = null;
510
                self::$menuUtils = null;
511
                self::$logger = null;
512
                self::$sesHandler = null;
295 daniel-mar 513
                self::$dbMainSession = null;
514
                self::$dbIsolatedSession = null;
263 daniel-mar 515
                self::$pagePlugins = array();
516
                self::$authPlugins = array();
289 daniel-mar 517
                self::$loggerPlugins = array();
263 daniel-mar 518
                self::$objectTypePlugins = array();
519
                self::$enabledObjectTypes = array();
520
                self::$disabledObjectTypes = array();
521
                self::$dbPlugins = array();
274 daniel-mar 522
                self::$sqlSlangPlugins = array();
263 daniel-mar 523
                self::$system_id_cache = null;
524
                self::$sslAvailableCache = null;
74 daniel-mar 525
 
263 daniel-mar 526
                // Continue...
527
 
294 daniel-mar 528
                OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
263 daniel-mar 529
                                       // You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
530
 
150 daniel-mar 531
                // Register database types (highest priority)
532
 
274 daniel-mar 533
                // SQL slangs
534
 
294 daniel-mar 535
                self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin'));
274 daniel-mar 536
                foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
537
                        $plugin->init($html);
538
                }
539
 
540
                // Database providers
541
 
277 daniel-mar 542
                self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin'));
237 daniel-mar 543
                foreach (OIDplus::getDatabasePlugins() as $plugin) {
544
                        $plugin->init($html);
545
                }
546
 
42 daniel-mar 547
                // Do redirect stuff etc.
74 daniel-mar 548
 
230 daniel-mar 549
                self::isSslAvailable(); // This function does automatic redirects
61 daniel-mar 550
 
263 daniel-mar 551
                // Construct the configuration manager
66 daniel-mar 552
 
263 daniel-mar 553
                OIDplus::config(); // During the construction, various system settings are prepared if required
66 daniel-mar 554
 
74 daniel-mar 555
                // Initialize public / private keys
556
 
227 daniel-mar 557
                OIDplus::getPkiStatus(true);
74 daniel-mar 558
 
237 daniel-mar 559
                // Register non-DB plugins
74 daniel-mar 560
 
277 daniel-mar 561
                self::registerAllPlugins('*Pages', 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin'));
562
                self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin'));
289 daniel-mar 563
                self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin'));
277 daniel-mar 564
                self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin'));
150 daniel-mar 565
 
237 daniel-mar 566
                // Initialize non-DB plugins
224 daniel-mar 567
 
281 daniel-mar 568
                foreach (OIDplus::getPagePlugins() as $plugin) {
74 daniel-mar 569
                        $plugin->init($html);
570
                }
230 daniel-mar 571
                foreach (OIDplus::getAuthPlugins() as $plugin) {
572
                        $plugin->init($html);
573
                }
289 daniel-mar 574
                foreach (OIDplus::getLoggerPlugins() as $plugin) {
575
                        $plugin->init($html);
576
                }
230 daniel-mar 577
                foreach (OIDplus::getObjectTypePlugins() as $plugin) {
578
                        $plugin->init($html);
579
                }
2 daniel-mar 580
        }
42 daniel-mar 581
 
227 daniel-mar 582
        # --- System URL, System ID, PKI, and other functions
583
 
294 daniel-mar 584
        public static function basePath() {
585
                return realpath(__DIR__ . '/../../');
586
        }
587
 
227 daniel-mar 588
        public static function getSystemUrl($relative=false) {
589
                if (!isset($_SERVER["SCRIPT_NAME"])) return false;
590
 
591
                $test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
269 daniel-mar 592
                $test_dir = str_replace('\\', '/', $test_dir);
227 daniel-mar 593
                $c = 0;
594
                while (!file_exists($test_dir.'/oidplus_base.js')) {
595
                        $test_dir = dirname($test_dir);
596
                        $c++;
597
                        if ($c == 1000) return false;
598
                }
599
 
600
                $res = dirname($_SERVER['SCRIPT_NAME'].'xxx');
601
 
602
                for ($i=1; $i<=$c; $i++) {
603
                        $res = dirname($res);
604
                }
605
 
269 daniel-mar 606
                $res = str_replace('\\', '/', $res);
227 daniel-mar 607
                if ($res == '/') $res = '';
608
                $res .= '/';
609
 
610
                if (!$relative) {
228 daniel-mar 611
                        $is_ssl = isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
612
                        $protocol = $is_ssl ? 'https' : 'http';
613
                        $host = $_SERVER['HTTP_HOST'];
614
                        $port = $_SERVER['SERVER_PORT'];
615
                        if ($is_ssl && ($port != 443)) {
616
                                $port_add = ":$port";
617
                        } else if (!$is_ssl && ($port != 80)) {
618
                                $port_add = ":$port";
619
                        } else {
620
                                $port_add = "";
621
                        }
622
                        $res = $protocol.'://'.$host.$port_add.$res;
227 daniel-mar 623
                }
624
 
625
                return $res;
626
        }
627
 
628
        private static $system_id_cache = null;
629
        public static function getSystemId($oid=false) {
630
                if (!is_null(self::$system_id_cache)) {
631
                        $out = self::$system_id_cache;
632
                } else {
633
                        $out = false;
634
 
635
                        if (self::getPkiStatus(true)) {
636
                                $pubKey = OIDplus::config()->getValue('oidplus_public_key');
637
                                if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
638
                                        $out = smallhash(base64_decode($m[1]));
639
                                }
640
                        }
641
                        self::$system_id_cache = $out;
642
                }
291 daniel-mar 643
                return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
227 daniel-mar 644
        }
645
 
646
        public static function getPkiStatus($try_generate=true) {
647
                if (!function_exists('openssl_pkey_new')) return false;
648
 
649
                $privKey = OIDplus::config()->getValue('oidplus_private_key');
650
                $pubKey = OIDplus::config()->getValue('oidplus_public_key');
651
 
652
                if ($try_generate && !verify_private_public_key($privKey, $pubKey)) {
263 daniel-mar 653
                        $pkey_config = array(
227 daniel-mar 654
                            "digest_alg" => "sha512",
655
                            "private_key_bits" => 2048,
656
                            "private_key_type" => OPENSSL_KEYTYPE_RSA,
657
                        );
658
 
659
                        // Create the private and public key
263 daniel-mar 660
                        $res = openssl_pkey_new($pkey_config);
256 daniel-mar 661
 
239 daniel-mar 662
                        if (!$res) return false;
227 daniel-mar 663
 
664
                        // Extract the private key from $res to $privKey
665
                        openssl_pkey_export($res, $privKey);
666
 
667
                        // Extract the public key from $res to $pubKey
668
                        $pubKey = openssl_pkey_get_details($res)["key"];
669
 
239 daniel-mar 670
                        // Log
288 daniel-mar 671
                        OIDplus::logger()->log("[INFO]A!", "Generating new SystemID using a new key pair");
239 daniel-mar 672
 
227 daniel-mar 673
                        // Save the key pair to database
674
                        OIDplus::config()->setValue('oidplus_private_key', $privKey);
675
                        OIDplus::config()->setValue('oidplus_public_key', $pubKey);
676
 
677
                        // Log the new system ID
678
                        if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
679
                                $system_id = smallhash(base64_decode($m[1]));
288 daniel-mar 680
                                OIDplus::logger()->log("[INFO]A!", "Your SystemID is now $system_id");
227 daniel-mar 681
                        }
682
                }
683
 
684
                return verify_private_public_key($privKey, $pubKey);
685
        }
686
 
170 daniel-mar 687
        public static function getInstallType() {
294 daniel-mar 688
                if (!file_exists(OIDplus::basePath().'/oidplus_version.txt') && !is_dir(OIDplus::basePath().'/.svn')) {
170 daniel-mar 689
                        return 'unknown';
690
                }
294 daniel-mar 691
                if (file_exists(OIDplus::basePath().'/oidplus_version.txt') && is_dir(OIDplus::basePath().'/.svn')) {
170 daniel-mar 692
                        return 'ambigous';
693
                }
294 daniel-mar 694
                if (is_dir(OIDplus::basePath().'/.svn')) {
170 daniel-mar 695
                        return 'svn-wc';
696
                }
294 daniel-mar 697
                if (file_exists(OIDplus::basePath().'/oidplus_version.txt')) {
170 daniel-mar 698
                        return 'svn-snapshot';
699
                }
700
        }
701
 
111 daniel-mar 702
        public static function getVersion() {
294 daniel-mar 703
                if (file_exists(OIDplus::basePath().'/oidplus_version.txt') && is_dir(OIDplus::basePath().'/.svn')) {
239 daniel-mar 704
                        return false; // version is ambigous
111 daniel-mar 705
                }
162 daniel-mar 706
 
294 daniel-mar 707
                if (is_dir(OIDplus::basePath().'/.svn')) {
285 daniel-mar 708
                        // Try to get the version via SQLite3
709
                        if (class_exists('SQLite3')) {
710
                                try {
294 daniel-mar 711
                                        $db = new SQLite3(OIDplus::basePath().'/.svn/wc.db');
285 daniel-mar 712
                                        $results = $db->query('SELECT MIN(revision) AS rev FROM NODES_BASE');
713
                                        while ($row = $results->fetchArray()) {
714
                                                return 'svn-'.$row['rev'];
715
                                        }
716
                                        $db->close();
717
                                        $db = null;
718
                                } catch (Exception $e) {
719
                                }
720
                        }
721
                        if (class_exists('PDO')) {
722
                                try {
294 daniel-mar 723
                                        $pdo = new PDO('sqlite:' . OIDplus::basePath().'/.svn/wc.db');
285 daniel-mar 724
                                        $res = $pdo->query('SELECT MIN(revision) AS rev FROM NODES_BASE');
725
                                        $row = $res->fetch();
726
                                        if ($row !== false) return 'svn-'.$row['rev'];
727
                                        $pdo = null;
728
                                } catch (Exception $e) {
729
                                }
730
                        }
731
 
162 daniel-mar 732
                        // Try to find out the SVN version using the shell
285 daniel-mar 733
                        // We don't prioritize this method, because a failed shell access will flood the apache error log with STDERR messages
294 daniel-mar 734
                        $output = @shell_exec('svnversion '.escapeshellarg(OIDplus::basePath()));
285 daniel-mar 735
                        if (preg_match('/\d+/', $output, $match)) {
239 daniel-mar 736
                                return 'svn-'.$match[0];
162 daniel-mar 737
                        }
738
 
294 daniel-mar 739
                        $output = @shell_exec('svn info '.escapeshellarg(OIDplus::basePath()));
285 daniel-mar 740
                        if (preg_match('/Revision:\s*(\d+)/m', $output, $match)) {
741
                                return 'svn-'.$match[1];
162 daniel-mar 742
                        }
743
                }
744
 
294 daniel-mar 745
                if (file_exists(OIDplus::basePath().'/oidplus_version.txt')) {
746
                        $cont = file_get_contents(OIDplus::basePath().'/oidplus_version.txt');
239 daniel-mar 747
                        if (preg_match('@Revision (\d+)@', $cont, $m))
748
                                return 'svn-'.$m[1];
162 daniel-mar 749
                }
750
 
239 daniel-mar 751
                return false;
111 daniel-mar 752
        }
753
 
230 daniel-mar 754
        private static $sslAvailableCache = null;
755
        public static function isSslAvailable() {
756
                if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
256 daniel-mar 757
 
230 daniel-mar 758
                if (php_sapi_name() == 'cli') {
759
                        self::$sslAvailableCache = false;
760
                        return false;
761
                }
762
 
49 daniel-mar 763
                $timeout = 2;
80 daniel-mar 764
                $already_ssl = isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] == "on");
765
                $ssl_port = 443;
227 daniel-mar 766
                $cookie_path = OIDplus::getSystemUrl(true);
83 daniel-mar 767
                if (empty($cookie_path)) $cookie_path = '/';
42 daniel-mar 768
 
261 daniel-mar 769
                $mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', 2/*auto*/);
770
 
771
                if ($mode == 0) {
80 daniel-mar 772
                        // No SSL available
230 daniel-mar 773
                        self::$sslAvailableCache = $already_ssl;
80 daniel-mar 774
                        return $already_ssl;
775
                }
776
 
261 daniel-mar 777
                if ($mode == 1) {
80 daniel-mar 778
                        // Force SSL
779
                        if ($already_ssl) {
230 daniel-mar 780
                                self::$sslAvailableCache = true;
80 daniel-mar 781
                                return true;
42 daniel-mar 782
                        } else {
80 daniel-mar 783
                                $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
784
                                header('Location:'.$location);
240 daniel-mar 785
                                die('Redirecting to HTTPS...');
230 daniel-mar 786
                                self::$sslAvailableCache = true;
80 daniel-mar 787
                                return true;
788
                        }
789
                }
790
 
261 daniel-mar 791
                if ($mode == 2) {
80 daniel-mar 792
                        // Automatic SSL detection
793
 
794
                        if ($already_ssl) {
795
                                // we are already on HTTPS
83 daniel-mar 796
                                setcookie('SSL_CHECK', '1', 0, $cookie_path, '', false, true);
230 daniel-mar 797
                                self::$sslAvailableCache = true;
80 daniel-mar 798
                                return true;
799
                        } else {
800
                                if (isset($_COOKIE['SSL_CHECK'])) {
801
                                        // We already had the HTTPS detection done before.
802
                                        if ($_COOKIE['SSL_CHECK']) {
803
                                                // HTTPS was detected before, but we are HTTP. Redirect now
804
                                                $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
805
                                                header('Location:'.$location);
240 daniel-mar 806
                                                die('Redirecting to HTTPS...');
230 daniel-mar 807
                                                self::$sslAvailableCache = true;
80 daniel-mar 808
                                                return true;
809
                                        } else {
810
                                                // No HTTPS available. Do nothing.
230 daniel-mar 811
                                                self::$sslAvailableCache = false;
80 daniel-mar 812
                                                return false;
813
                                        }
49 daniel-mar 814
                                } else {
80 daniel-mar 815
                                        // This is our first check (or the browser didn't accept the SSL_CHECK cookie)
816
                                        if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) {
817
                                                // HTTPS detected. Redirect now, and remember that we had detected HTTPS
83 daniel-mar 818
                                                setcookie('SSL_CHECK', '1', 0, $cookie_path, '', false, true);
80 daniel-mar 819
                                                $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
820
                                                header('Location:'.$location);
240 daniel-mar 821
                                                die('Redirecting to HTTPS...');
230 daniel-mar 822
                                                self::$sslAvailableCache = true;
80 daniel-mar 823
                                                return true;
824
                                        } else {
825
                                                // No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
83 daniel-mar 826
                                                setcookie('SSL_CHECK', '0', 0, $cookie_path, '', false, true);
230 daniel-mar 827
                                                self::$sslAvailableCache = false;
80 daniel-mar 828
                                                return false;
829
                                        }
49 daniel-mar 830
                                }
42 daniel-mar 831
                        }
832
                }
833
        }
241 daniel-mar 834
 
835
        public static function webpath($target) {
836
                $dir = __DIR__;
837
                $dir = dirname($dir);
838
                $dir = dirname($dir);
839
                $target = substr($target, strlen($dir)+1, strlen($target)-strlen($dir)-1);
840
                if ($target != '') {
841
                        $target = str_replace('\\','/',$target).'/';
842
                }
843
                return $target;
844
        }
2 daniel-mar 845
}