Subversion Repositories oidplus

Rev

Rev 698 | Rev 702 | 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
511 daniel-mar 5
 * Copyright 2019 - 2021 Daniel Marschall, ViaThinkSoft
2 daniel-mar 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
 
511 daniel-mar 20
if (!defined('INSIDE_OIDPLUS')) die();
21
 
2 daniel-mar 22
class OIDplus {
281 daniel-mar 23
        private static /*OIDplusPagePlugin[]*/ $pagePlugins = array();
24
        private static /*OIDplusAuthPlugin[]*/ $authPlugins = array();
289 daniel-mar 25
        private static /*OIDplusLoggerPlugin[]*/ $loggerPlugins = array();
227 daniel-mar 26
        private static /*OIDplusObjectTypePlugin[]*/ $objectTypePlugins = array();
27
        private static /*string[]*/ $enabledObjectTypes = array();
28
        private static /*string[]*/ $disabledObjectTypes = array();
29
        private static /*OIDplusDatabasePlugin[]*/ $dbPlugins = array();
274 daniel-mar 30
        private static /*OIDplusSqlSlangPlugin[]*/ $sqlSlangPlugins = array();
355 daniel-mar 31
        private static /*OIDplusLanguagePlugin[]*/ $languagePlugins = array();
449 daniel-mar 32
        private static /*OIDplusDesignPlugin[]*/ $designPlugins = array();
2 daniel-mar 33
 
280 daniel-mar 34
        protected static $html = true;
236 daniel-mar 35
 
362 daniel-mar 36
        /*public*/ const DEFAULT_LANGUAGE = 'enus'; // the language of the source code
355 daniel-mar 37
 
2 daniel-mar 38
        private function __construct() {
39
        }
295 daniel-mar 40
 
263 daniel-mar 41
        # --- Static classes
274 daniel-mar 42
 
263 daniel-mar 43
        private static $baseConfig = null;
44
        private static $old_config_format = false;
261 daniel-mar 45
        public static function baseConfig() {
263 daniel-mar 46
                $first_init = false;
274 daniel-mar 47
 
263 daniel-mar 48
                if ($first_init = is_null(self::$baseConfig)) {
49
                        self::$baseConfig = new OIDplusBaseConfig();
261 daniel-mar 50
                }
51
 
263 daniel-mar 52
                if ($first_init) {
261 daniel-mar 53
                        // Include a file containing various size/depth limitations of OIDs
294 daniel-mar 54
                        // It is important to include it before userdata/baseconfig/config.inc.php was included,
55
                        // so we can give userdata/baseconfig/config.inc.php the chance to override the values.
261 daniel-mar 56
 
496 daniel-mar 57
                        include OIDplus::localpath().'includes/oidplus_limits.inc.php';
261 daniel-mar 58
 
59
                        // Include config file
295 daniel-mar 60
 
496 daniel-mar 61
                        $config_file = OIDplus::localpath() . 'userdata/baseconfig/config.inc.php';
62
                        $config_file_old = OIDplus::localpath() . 'includes/config.inc.php'; // backwards compatibility
295 daniel-mar 63
 
294 daniel-mar 64
                        if (!file_exists($config_file) && file_exists($config_file_old)) {
65
                                $config_file = $config_file_old;
66
                        }
261 daniel-mar 67
 
294 daniel-mar 68
                        if (file_exists($config_file)) {
263 daniel-mar 69
                                if (self::$old_config_format) {
70
                                        // Note: We may only include it once due to backwards compatibility,
71
                                        //       since in version 2.0, the configuration was defined using define() statements
72
                                        // Attention: This does mean that a full re-init (e.g. for test cases) is not possible
73
                                        //            if a version 2.0 config is used!
294 daniel-mar 74
                                        include_once $config_file;
263 daniel-mar 75
                                } else {
294 daniel-mar 76
                                        include $config_file;
263 daniel-mar 77
                                }
261 daniel-mar 78
 
79
                                if (defined('OIDPLUS_CONFIG_VERSION') && (OIDPLUS_CONFIG_VERSION == 2.0)) {
263 daniel-mar 80
                                        self::$old_config_format = true;
274 daniel-mar 81
 
261 daniel-mar 82
                                        // Backwards compatibility 2.0 => 2.1
83
                                        foreach (get_defined_constants(true)['user'] as $name => $value) {
84
                                                $name = str_replace('OIDPLUS_', '', $name);
85
                                                if ($name == 'SESSION_SECRET') $name = 'SERVER_SECRET';
86
                                                if ($name == 'MYSQL_QUERYLOG') $name = 'QUERY_LOGFILE';
87
                                                if (($name == 'MYSQL_PASSWORD') || ($name == 'ODBC_PASSWORD') || ($name == 'PDO_PASSWORD') || ($name == 'PGSQL_PASSWORD')) {
263 daniel-mar 88
                                                        self::$baseConfig->setValue($name, base64_decode($value));
261 daniel-mar 89
                                                } else {
90
                                                        if ($name == 'CONFIG_VERSION') $value = 2.1;
263 daniel-mar 91
                                                        self::$baseConfig->setValue($name, $value);
261 daniel-mar 92
                                                }
93
                                        }
94
                                }
95
                        } else {
496 daniel-mar 96
                                if (!is_dir(OIDplus::localpath().'setup')) {
360 daniel-mar 97
                                        throw new OIDplusConfigInitializationException(_L('File %1 is missing, but setup can\'t be started because its directory missing.','userdata/baseconfig/config.inc.php'));
261 daniel-mar 98
                                } else {
280 daniel-mar 99
                                        if (self::$html) {
496 daniel-mar 100
                                                if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,true).'setup/') !== 0) {
101
                                                        header('Location:'.OIDplus::webpath().'setup/');
360 daniel-mar 102
                                                        die(_L('Redirecting to setup...'));
349 daniel-mar 103
                                                } else {
104
                                                        return self::$baseConfig;
105
                                                }
261 daniel-mar 106
                                        } else {
107
                                                // This can be displayed in e.g. ajax.php
360 daniel-mar 108
                                                throw new OIDplusConfigInitializationException(_L('File %1 is missing. Please run setup again.','userdata/baseconfig/config.inc.php'));
261 daniel-mar 109
                                        }
110
                                }
111
                        }
112
 
113
                        // Check important config settings
114
 
263 daniel-mar 115
                        if (self::$baseConfig->getValue('CONFIG_VERSION') != 2.1) {
503 daniel-mar 116
                                if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,true).'setup/') !== 0) {
117
                                        throw new OIDplusConfigInitializationException(_L("The information located in %1 is outdated.",realpath($config_file)));
118
                                }
261 daniel-mar 119
                        }
120
 
263 daniel-mar 121
                        if (self::$baseConfig->getValue('SERVER_SECRET', '') === '') {
503 daniel-mar 122
                                if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,true).'setup/') !== 0) {
123
                                        throw new OIDplusConfigInitializationException(_L("You must set a value for SERVER_SECRET in %1 for the system to operate secure.",realpath($config_file)));
124
                                }
261 daniel-mar 125
                        }
126
                }
127
 
263 daniel-mar 128
                return self::$baseConfig;
261 daniel-mar 129
        }
130
 
263 daniel-mar 131
        private static $config = null;
2 daniel-mar 132
        public static function config() {
263 daniel-mar 133
                if ($first_init = is_null(self::$config)) {
134
                        self::$config = new OIDplusConfig();
2 daniel-mar 135
                }
263 daniel-mar 136
 
137
                if ($first_init) {
138
                        // These are important settings for base functionalities and therefore are not inside plugins
139
                        self::$config->prepareConfigKey('system_title', 'What is the name of your RA?', 'OIDplus 2.0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
140
                                if (empty($value)) {
360 daniel-mar 141
                                        throw new OIDplusException(_L('Please enter a value for the system title.'));
263 daniel-mar 142
                                }
143
                        });
144
                        self::$config->prepareConfigKey('admin_email', 'E-Mail address of the system administrator', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
145
                                if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
360 daniel-mar 146
                                        throw new OIDplusException(_L('This is not a correct email address'));
263 daniel-mar 147
                                }
148
                        });
149
                        self::$config->prepareConfigKey('global_cc', 'Global CC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
150
                                if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
360 daniel-mar 151
                                        throw new OIDplusException(_L('This is not a correct email address'));
263 daniel-mar 152
                                }
153
                        });
154
                        self::$config->prepareConfigKey('objecttypes_initialized', 'List of object type plugins that were initialized once', '', OIDplusConfig::PROTECTION_READONLY, function($value) {
155
                                // Nothing here yet
156
                        });
157
                        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) {
158
                                # 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?
159
 
160
                                $ary = explode(';',$value);
161
                                $uniq_ary = array_unique($ary);
162
 
163
                                if (count($ary) != count($uniq_ary)) {
360 daniel-mar 164
                                        throw new OIDplusException(_L('Please check your input. Some object types are double.'));
263 daniel-mar 165
                                }
166
 
167
                                foreach ($ary as $ot_check) {
168
                                        $ns_found = false;
169
                                        foreach (OIDplus::getEnabledObjectTypes() as $ot) {
170
                                                if ($ot::ns() == $ot_check) {
171
                                                        $ns_found = true;
172
                                                        break;
173
                                                }
174
                                        }
175
                                        foreach (OIDplus::getDisabledObjectTypes() as $ot) {
176
                                                if ($ot::ns() == $ot_check) {
177
                                                        $ns_found = true;
178
                                                        break;
179
                                                }
180
                                        }
181
                                        if (!$ns_found) {
360 daniel-mar 182
                                                throw new OIDplusException(_L('Please check your input. Namespace "%1" is not found',$ot_check));
263 daniel-mar 183
                                        }
184
                                }
185
                        });
186
                        self::$config->prepareConfigKey('oidplus_private_key', 'Private key for this system', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
187
                                // Nothing here yet
188
                        });
189
                        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) {
190
                                // Nothing here yet
191
                        });
324 daniel-mar 192
                        self::$config->prepareConfigKey('last_known_system_url', 'Last known System URL', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
193
                                // Nothing here yet
194
                        });
412 daniel-mar 195
                        self::$config->prepareConfigKey('last_known_version', 'Last known OIDplus Version', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
196
                                // Nothing here yet
197
                        });
635 daniel-mar 198
                        self::$config->prepareConfigKey('default_ra_auth_method', 'Default auth method used for generating password of RAs (must exist in plugins/[vendorname]/auth/)?', 'A3_bcrypt', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
453 daniel-mar 199
                                $good = true;
200
                                if (strpos($value,'/') !== false) $good = false;
201
                                if (strpos($value,'\\') !== false) $good = false;
202
                                if (strpos($value,'..') !== false) $good = false;
203
                                if (!$good) {
204
                                        throw new OIDplusException(_L('Invalid auth plugin folder name. Do only enter a folder name, not an absolute or relative path'));
205
                                }
206
 
635 daniel-mar 207
                                if (!rec_is_dir(OIDplus::localpath().'plugins/'.'*'.'/auth/'.$value)) {
208
                                        throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$value,'plugins/[vendorname]/auth/'));
453 daniel-mar 209
                                }
210
                        });
263 daniel-mar 211
                }
212
 
213
                return self::$config;
2 daniel-mar 214
        }
215
 
263 daniel-mar 216
        private static $gui = null;
2 daniel-mar 217
        public static function gui() {
263 daniel-mar 218
                if (is_null(self::$gui)) {
219
                        self::$gui = new OIDplusGui();
86 daniel-mar 220
                }
263 daniel-mar 221
                return self::$gui;
2 daniel-mar 222
        }
223
 
263 daniel-mar 224
        private static $authUtils = null;
2 daniel-mar 225
        public static function authUtils() {
263 daniel-mar 226
                if (is_null(self::$authUtils)) {
227
                        self::$authUtils = new OIDplusAuthUtils();
86 daniel-mar 228
                }
263 daniel-mar 229
                return self::$authUtils;
2 daniel-mar 230
        }
231
 
263 daniel-mar 232
        private static $mailUtils = null;
250 daniel-mar 233
        public static function mailUtils() {
263 daniel-mar 234
                if (is_null(self::$mailUtils)) {
235
                        self::$mailUtils = new OIDplusMailUtils();
250 daniel-mar 236
                }
263 daniel-mar 237
                return self::$mailUtils;
250 daniel-mar 238
        }
239
 
557 daniel-mar 240
        private static $cookieUtils = null;
241
        public static function cookieUtils() {
242
                if (is_null(self::$cookieUtils)) {
243
                        self::$cookieUtils = new OIDplusCookieUtils();
244
                }
245
                return self::$cookieUtils;
246
        }
247
 
263 daniel-mar 248
        private static $menuUtils = null;
250 daniel-mar 249
        public static function menuUtils() {
263 daniel-mar 250
                if (is_null(self::$menuUtils)) {
251
                        self::$menuUtils = new OIDplusMenuUtils();
250 daniel-mar 252
                }
263 daniel-mar 253
                return self::$menuUtils;
250 daniel-mar 254
        }
255
 
263 daniel-mar 256
        private static $logger = null;
115 daniel-mar 257
        public static function logger() {
263 daniel-mar 258
                if (is_null(self::$logger)) {
259
                        self::$logger = new OIDplusLogger();
115 daniel-mar 260
                }
263 daniel-mar 261
                return self::$logger;
115 daniel-mar 262
        }
263
 
274 daniel-mar 264
        # --- SQL slang plugin
265
 
266
        private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) {
267
                $name = $plugin::id();
591 daniel-mar 268
                if ($name === '') return false;
274 daniel-mar 269
 
449 daniel-mar 270
                if (isset(self::$sqlSlangPlugins[$name])) {
451 daniel-mar 271
                        $plugintype_hf = _L('SQL slang');
592 daniel-mar 272
                        throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
449 daniel-mar 273
                }
274
 
274 daniel-mar 275
                self::$sqlSlangPlugins[$name] = $plugin;
276
 
277
                return true;
278
        }
279
 
280
        public static function getSqlSlangPlugins() {
281
                return self::$sqlSlangPlugins;
282
        }
283
 
318 daniel-mar 284
        public static function getSqlSlangPlugin($id)/*: ?OIDplusSqlSlangPlugin*/ {
285
                if (isset(self::$sqlSlangPlugins[$id])) {
286
                        return self::$sqlSlangPlugins[$id];
287
                } else {
288
                        return null;
289
                }
290
        }
291
 
230 daniel-mar 292
        # --- Database plugin
74 daniel-mar 293
 
227 daniel-mar 294
        private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) {
275 daniel-mar 295
                $name = $plugin::id();
591 daniel-mar 296
                if ($name === '') return false;
150 daniel-mar 297
 
449 daniel-mar 298
                if (isset(self::$dbPlugins[$name])) {
299
                        $plugintype_hf = _L('Database');
592 daniel-mar 300
                        throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
449 daniel-mar 301
                }
302
 
150 daniel-mar 303
                self::$dbPlugins[$name] = $plugin;
304
 
305
                return true;
306
        }
307
 
308
        public static function getDatabasePlugins() {
309
                return self::$dbPlugins;
310
        }
311
 
295 daniel-mar 312
        public static function getActiveDatabasePlugin() {
261 daniel-mar 313
                if (OIDplus::baseConfig()->getValue('DATABASE_PLUGIN', '') === '') {
360 daniel-mar 314
                        throw new OIDplusConfigInitializationException(_L('No database plugin selected in config file'));
260 daniel-mar 315
                }
261 daniel-mar 316
                if (!isset(self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')])) {
360 daniel-mar 317
                        $db_plugin_name = OIDplus::baseConfig()->getValue('DATABASE_PLUGIN');
318
                        throw new OIDplusConfigInitializationException(_L('Database plugin "%1" not found',$db_plugin_name));
227 daniel-mar 319
                }
295 daniel-mar 320
                return self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')];
227 daniel-mar 321
        }
322
 
295 daniel-mar 323
        private static $dbMainSession = null;
324
        public static function db() {
325
                if (is_null(self::$dbMainSession)) {
326
                        self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
327
                }
328
                if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
329
                return self::$dbMainSession;
330
        }
331
 
332
        private static $dbIsolatedSession = null;
333
        public static function dbIsolated() {
334
                if (is_null(self::$dbIsolatedSession)) {
335
                        self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
336
                }
337
                if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
338
                return self::$dbIsolatedSession;
339
        }
340
 
227 daniel-mar 341
        # --- Page plugin
342
 
224 daniel-mar 343
        private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
281 daniel-mar 344
                self::$pagePlugins[] = $plugin;
61 daniel-mar 345
 
346
                return true;
347
        }
348
 
281 daniel-mar 349
        public static function getPagePlugins() {
350
                return self::$pagePlugins;
61 daniel-mar 351
        }
352
 
227 daniel-mar 353
        # --- Auth plugin
354
 
355
        private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
456 daniel-mar 356
                if (OIDplus::baseConfig()->getValue('DEBUG')) {
357
                        $password = generateRandomString(25);
459 daniel-mar 358
 
461 daniel-mar 359
                        try {
360
                                $authInfo = $plugin->generate($password);
361
                        } catch (OIDplusException $e) {
362
                                // This can happen when the AuthKey or Salt is too long
363
                                throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
364
                        }
459 daniel-mar 365
                        $salt = $authInfo->getSalt();
461 daniel-mar 366
                        $authKey = $authInfo->getAuthKey();
459 daniel-mar 367
 
461 daniel-mar 368
                        $authInfo_SaltDiff = clone $authInfo;
369
                        $authInfo_SaltDiff->setSalt(strrev($authInfo_SaltDiff->getSalt()));
370
 
371
                        $authInfo_AuthKeyDiff = clone $authInfo;
372
                        $authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
373
 
374
                        if ((!$plugin->verify($authInfo,$password)) ||
375
                           (!empty($salt) && $plugin->verify($authInfo_SaltDiff,$password)) ||
376
                           ($plugin->verify($authInfo_AuthKeyDiff,$password)) ||
377
                           ($plugin->verify($authInfo,$password.'x'))) {
456 daniel-mar 378
                                throw new OIDplusException(_L('Auth plugin "%1" is erroneous: Generate/Verify self test failed',basename($plugin->getPluginDirectory())));
379
                        }
453 daniel-mar 380
                }
381
 
227 daniel-mar 382
                self::$authPlugins[] = $plugin;
383
                return true;
384
        }
385
 
221 daniel-mar 386
        public static function getAuthPlugins() {
387
                return self::$authPlugins;
388
        }
389
 
355 daniel-mar 390
        # --- Language plugin
391
 
392
        private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
393
                self::$languagePlugins[] = $plugin;
394
                return true;
395
        }
396
 
397
        public static function getLanguagePlugins() {
398
                return self::$languagePlugins;
399
        }
400
 
449 daniel-mar 401
        # --- Design plugin
402
 
403
        private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
404
                self::$designPlugins[] = $plugin;
405
                return true;
406
        }
407
 
408
        public static function getDesignPlugins() {
409
                return self::$designPlugins;
410
        }
411
 
289 daniel-mar 412
        # --- Logger plugin
413
 
414
        private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
415
                self::$loggerPlugins[] = $plugin;
416
                return true;
417
        }
418
 
419
        public static function getLoggerPlugins() {
420
                return self::$loggerPlugins;
421
        }
422
 
227 daniel-mar 423
        # --- Object type plugin
424
 
425
        private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
426
                self::$objectTypePlugins[] = $plugin;
427
 
428
                $ot = $plugin::getObjectTypeClassName();
429
                self::registerObjectType($ot);
430
 
431
                return true;
432
        }
433
 
224 daniel-mar 434
        private static function registerObjectType($ot) {
66 daniel-mar 435
                $ns = $ot::ns();
436
 
360 daniel-mar 437
                if (empty($ns)) throw new OIDplusException(_L('Attention: Empty NS at %1',$ot));
66 daniel-mar 438
 
439
                $ns_found = false;
227 daniel-mar 440
                foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
66 daniel-mar 441
                        if ($test_ot::ns() == $ns) {
442
                                $ns_found = true;
443
                                break;
444
                        }
445
                }
446
                if ($ns_found) {
360 daniel-mar 447
                        throw new OIDplusException(_L('Attention: Two objectType plugins use the same namespace "%1"!',$ns));
66 daniel-mar 448
                }
449
 
450
                $init = OIDplus::config()->getValue("objecttypes_initialized");
451
                $init_ary = empty($init) ? array() : explode(';', $init);
70 daniel-mar 452
                $init_ary = array_map('trim', $init_ary);
66 daniel-mar 453
 
454
                $enabled = OIDplus::config()->getValue("objecttypes_enabled");
455
                $enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
70 daniel-mar 456
                $enabled_ary = array_map('trim', $enabled_ary);
66 daniel-mar 457
 
79 daniel-mar 458
                $do_enable = false;
459
                if (in_array($ns, $enabled_ary)) {
447 daniel-mar 460
                        // If it is in the list of enabled object types, it is enabled (obviously)
79 daniel-mar 461
                        $do_enable = true;
462
                } else {
447 daniel-mar 463
                        if (!OIDplus::config()->getValue('oobe_objects_done')) {
464
                                // If the OOBE wizard is NOT done, then just enable the "oid" object type by default
79 daniel-mar 465
                                $do_enable = $ns == 'oid';
466
                        } else {
447 daniel-mar 467
                                // If the OOBE wizard was done (once), then
468
                                // we will enable all object types which were never initialized
469
                                // (i.e. a plugin folder was freshly added)
79 daniel-mar 470
                                $do_enable = !in_array($ns, $init_ary);
471
                        }
472
                }
473
 
474
                if ($do_enable) {
227 daniel-mar 475
                        self::$enabledObjectTypes[] = $ot;
476
                        usort(self::$enabledObjectTypes, function($a, $b) {
66 daniel-mar 477
                                $enabled = OIDplus::config()->getValue("objecttypes_enabled");
478
                                $enabled_ary = explode(';', $enabled);
479
 
480
                                $idx_a = array_search($a::ns(), $enabled_ary);
481
                                $idx_b = array_search($b::ns(), $enabled_ary);
482
 
483
                                if ($idx_a == $idx_b) {
484
                                    return 0;
485
                                }
486
                                return ($idx_a > $idx_b) ? +1 : -1;
487
                        });
74 daniel-mar 488
                } else {
489
                        self::$disabledObjectTypes[] = $ot;
66 daniel-mar 490
                }
491
 
492
                if (!in_array($ns, $init_ary)) {
493
                        // Was never initialized before, so we add it to the list of enabled object types once
494
 
79 daniel-mar 495
                        if ($do_enable) {
496
                                $enabled_ary[] = $ns;
672 daniel-mar 497
                                // Important: Don't validate the input, because the other object types might not be initialized yet! So use setValueNoCallback() instead setValue().
498
                                OIDplus::config()->setValueNoCallback("objecttypes_enabled", implode(';', $enabled_ary));
79 daniel-mar 499
                        }
66 daniel-mar 500
 
501
                        $init_ary[] = $ns;
502
                        OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
503
                }
61 daniel-mar 504
        }
505
 
227 daniel-mar 506
        public static function getObjectTypePlugins() {
507
                return self::$objectTypePlugins;
61 daniel-mar 508
        }
509
 
227 daniel-mar 510
        public static function getObjectTypePluginsEnabled() {
511
                $res = array();
512
                foreach (self::$objectTypePlugins as $plugin) {
513
                        $ot = $plugin::getObjectTypeClassName();
514
                        if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
515
                }
516
                return $res;
74 daniel-mar 517
        }
518
 
227 daniel-mar 519
        public static function getObjectTypePluginsDisabled() {
520
                $res = array();
521
                foreach (self::$objectTypePlugins as $plugin) {
522
                        $ot = $plugin::getObjectTypeClassName();
523
                        if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
74 daniel-mar 524
                }
227 daniel-mar 525
                return $res;
74 daniel-mar 526
        }
527
 
227 daniel-mar 528
        public static function getEnabledObjectTypes() {
529
                return self::$enabledObjectTypes;
530
        }
74 daniel-mar 531
 
227 daniel-mar 532
        public static function getDisabledObjectTypes() {
533
                return self::$disabledObjectTypes;
534
        }
74 daniel-mar 535
 
277 daniel-mar 536
        # --- Plugin handling functions
537
 
320 daniel-mar 538
        public static function getAllPlugins()/*: array*/ {
539
                $res = array();
540
                $res = array_merge($res, self::$pagePlugins);
541
                $res = array_merge($res, self::$authPlugins);
542
                $res = array_merge($res, self::$loggerPlugins);
543
                $res = array_merge($res, self::$objectTypePlugins);
544
                $res = array_merge($res, self::$dbPlugins);
545
                $res = array_merge($res, self::$sqlSlangPlugins);
355 daniel-mar 546
                $res = array_merge($res, self::$languagePlugins);
449 daniel-mar 547
                $res = array_merge($res, self::$designPlugins);
320 daniel-mar 548
                return $res;
549
        }
550
 
321 daniel-mar 551
        public static function getPluginByOid($oid)/*: ?OIDplusPlugin*/ {
320 daniel-mar 552
                $plugins = self::getAllPlugins();
321 daniel-mar 553
                foreach ($plugins as $plugin) {
554
                        if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
555
                                return $plugin;
320 daniel-mar 556
                        }
557
                }
558
                return null;
559
        }
560
 
380 daniel-mar 561
        public static function getPluginByClassName($classname)/*: ?OIDplusPlugin*/ {
562
                $plugins = self::getAllPlugins();
563
                foreach ($plugins as $plugin) {
564
                        if (get_class($plugin) === $classname) {
565
                                return $plugin;
566
                        }
567
                }
568
                return null;
277 daniel-mar 569
        }
570
 
594 daniel-mar 571
        /**
572
        * @return array<OIDplusPluginManifest>|array<string,array<string,OIDplusPluginManifest>>
573
        */
693 daniel-mar 574
        public static function getAllPluginManifests($pluginFolderMasks='*', $flat=true): array {
277 daniel-mar 575
                $out = array();
279 daniel-mar 576
                // Note: glob() will sort by default, so we do not need a page priority attribute.
577
                //       So you just need to use a numeric plugin directory prefix (padded).
693 daniel-mar 578
                $ary = array();
579
                foreach (explode(',',$pluginFolderMasks) as $pluginFolderMask) {
580
                        $ary = array_merge($ary,glob(OIDplus::localpath().'plugins/'.'*'.'/'.$pluginFolderMask.'/'.'*'.'/manifest.xml'));
581
                }
646 daniel-mar 582
 
583
                // Sort the plugins by their type and name, as if they would be in a single vendor-folder!
584
                uasort($ary, function($a,$b) {
585
                        if ($a == $b) return 0;
586
 
587
                        $ary = explode('/',$a);
588
                        $bry = explode('/',$b);
589
 
590
                        // First sort by type (publicPage, auth, database, language, ...)
591
                        $a_type = $ary[count($ary)-1-2];
592
                        $b_type = $bry[count($bry)-1-2];
593
                        if ($a_type < $b_type) return -1;
594
                        if ($a_type > $b_type) return 1;
595
 
596
                        // Then sort by name (090_login, 100_whois, etc.)
597
                        $a_name = $ary[count($ary)-1-1];
598
                        $b_name = $bry[count($bry)-1-1];
599
                        if ($a_name < $b_name) return -1;
600
                        if ($a_name > $b_name) return 1;
601
 
602
                        // If it is still equal, then finally sort by vendorname
603
                        $a_vendor = $ary[count($ary)-1-3];
604
                        $b_vendor = $bry[count($bry)-1-3];
605
                        if ($a_vendor < $b_vendor) return -1;
606
                        if ($a_vendor > $b_vendor) return 1;
607
                        return 0;
608
                });
609
 
277 daniel-mar 610
                foreach ($ary as $ini) {
611
                        if (!file_exists($ini)) continue;
612
 
307 daniel-mar 613
                        $manifest = new OIDplusPluginManifest();
614
                        $manifest->loadManifest($ini);
277 daniel-mar 615
 
473 daniel-mar 616
                        $class_name = $manifest->getPhpMainClass();
617
                        if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
618
                                continue;
619
                        }
620
 
307 daniel-mar 621
                        if ($flat) {
622
                                $out[] = $manifest;
623
                        } else {
624
                                $plugintype_folder = basename(dirname(dirname($ini)));
625
                                $pluginname_folder = basename(dirname($ini));
626
 
627
                                if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
628
                                if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
629
                                $out[$plugintype_folder][$pluginname_folder] = $manifest;
630
                        }
277 daniel-mar 631
                }
632
                return $out;
633
        }
634
 
594 daniel-mar 635
        /**
636
        * @return array<string>
637
        */
277 daniel-mar 638
        public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
639
                $out = array();
525 daniel-mar 640
                if (is_array($pluginDirName)) {
641
                        $ary = array();
642
                        foreach ($pluginDirName as $pluginDirName_) {
643
                                $ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
644
                        }
645
                } else {
646
                        $ary = self::getAllPluginManifests($pluginDirName, false);
647
                }
320 daniel-mar 648
                $known_plugin_oids = array();
456 daniel-mar 649
                if (OIDplus::baseConfig()->getValue('DEBUG')) {
650
                        $fake_feature = uuid_to_oid(gen_uuid());
588 daniel-mar 651
                } else {
652
                        $fake_feature = null;
456 daniel-mar 653
                }
277 daniel-mar 654
                foreach ($ary as $plugintype_folder => $bry) {
438 daniel-mar 655
                        foreach ($bry as $pluginname_folder => $manifest) {
656
                                $class_name = $manifest->getPhpMainClass();
657
 
658
                                // Before we load the plugin, we want to make some checks to confirm
659
                                // that the plugin is working correctly.
660
 
307 daniel-mar 661
                                if (!$class_name) {
438 daniel-mar 662
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Manifest does not declare a PHP main class'));
277 daniel-mar 663
                                }
297 daniel-mar 664
                                if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
665
                                        continue;
666
                                }
292 daniel-mar 667
                                if (!class_exists($class_name)) {
438 daniel-mar 668
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Manifest declares PHP main class as "%1", but it could not be found',$class_name));
292 daniel-mar 669
                                }
279 daniel-mar 670
                                if (!is_subclass_of($class_name, $expectedPluginClass)) {
438 daniel-mar 671
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Plugin main class "%1" is expected to be a subclass of "%2"',$class_name,$expectedPluginClass));
279 daniel-mar 672
                                }
438 daniel-mar 673
                                if (($class_name!=$manifest->getTypeClass()) && (!is_subclass_of($class_name,$manifest->getTypeClass()))) {
674
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Plugin main class "%1" is expected to be a subclass of "%2", according to type declared in manifest',$class_name,$manifest->getTypeClass()));
308 daniel-mar 675
                                }
438 daniel-mar 676
                                if (($manifest->getTypeClass()!=$expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(),$expectedPluginClass))) {
677
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Class declared in manifest is "%1" does not fit expected class for this plugin type "%2"',$manifest->getTypeClass(),$expectedPluginClass));
308 daniel-mar 678
                                }
679
 
438 daniel-mar 680
                                $plugin_oid = $manifest->getOid();
320 daniel-mar 681
                                if (!$plugin_oid) {
438 daniel-mar 682
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Does not have an OID'));
320 daniel-mar 683
                                }
684
                                if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) {
438 daniel-mar 685
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Plugin OID "%1" is invalid (needs to be valid dot-notation)',$plugin_oid));
320 daniel-mar 686
                                }
687
                                if (isset($known_plugin_oids[$plugin_oid])) {
438 daniel-mar 688
                                        throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('The OID "%1" is already used by the plugin "%2"',$plugin_oid,$known_plugin_oids[$plugin_oid]));
320 daniel-mar 689
                                }
646 daniel-mar 690
 
632 daniel-mar 691
                                $full_plugin_dir = dirname($manifest->getManifestFile());
692
                                $full_plugin_dir = substr($full_plugin_dir, strlen(OIDplus::localpath()));
633 daniel-mar 693
                                // { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) 37476 products(2) oidplus(5) v2(2) plugins(4) }
635 daniel-mar 694
                                if (str_starts_with($full_plugin_dir, 'plugins/viathinksoft/') != str_starts_with($plugin_oid, '1.3.6.1.4.1.37476.2.5.2.4.')) {
695
                                        throw new OIDplusException(_L('Plugin "%1/%2" is misplaced',$plugintype_folder,$pluginname_folder).': '._L('The plugin is in the wrong folder. The folder %1 can only be used by official ViaThinkSoft plugins','plugins/viathinksoft/'));
632 daniel-mar 696
                                }
320 daniel-mar 697
 
632 daniel-mar 698
                                $known_plugin_oids[$plugin_oid] = $plugintype_folder.'/'.$pluginname_folder;
699
 
438 daniel-mar 700
                                $obj = new $class_name();
456 daniel-mar 701
 
702
                                if (OIDplus::baseConfig()->getValue('DEBUG')) {
703
                                        if ($obj->implementsFeature($fake_feature)) {
704
                                                // see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663
705
                                                throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('implementsFeature() always returns true'));
706
                                        }
438 daniel-mar 707
                                }
708
 
709
                                // TODO: Maybe as additional plugin-test, we should also check if plugins are allowed to define CSS/JS (since only page plugins may have them!)
710
                                $tmp = array_merge(
711
                                        $manifest->getJSFiles(),
712
                                        $manifest->getCSSFiles(),
713
                                        $manifest->getJSFilesSetup(),
714
                                        $manifest->getCSSFilesSetup()
715
                                );
716
                                foreach ($tmp as $file) {
717
                                        if (!file_exists($file)) {
718
                                                throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('File %1 was defined in manifest, but it is not existing',$file));
719
                                        }
720
                                }
721
 
722
                                // Now we can continue
723
 
279 daniel-mar 724
                                $out[] = $class_name;
725
                                if (!is_null($registerCallback)) {
438 daniel-mar 726
                                        call_user_func($registerCallback, $obj);
444 daniel-mar 727
 
728
                                        // Alternative approaches:
729
                                        //$registerCallback[0]::{$registerCallback[1]}($obj);
730
                                        // or:
731
                                        //forward_static_call($registerCallback, $obj);
279 daniel-mar 732
                                }
277 daniel-mar 733
                        }
734
 
735
                }
736
                return $out;
737
        }
738
 
227 daniel-mar 739
        # --- Initialization of OIDplus
206 daniel-mar 740
 
374 daniel-mar 741
        public static function init($html=true, $keepBaseConfig=true) {
236 daniel-mar 742
                self::$html = $html;
743
 
263 daniel-mar 744
                // Reset internal state, so we can re-init verything if required
274 daniel-mar 745
 
263 daniel-mar 746
                if (self::$old_config_format) {
747
                        // Note: This can only happen in very special cases (e.g. test cases) where you call init() twice
360 daniel-mar 748
                        throw new OIDplusConfigInitializationException(_L('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.'));
263 daniel-mar 749
                }
274 daniel-mar 750
 
263 daniel-mar 751
                self::$config = null;
374 daniel-mar 752
                if (!$keepBaseConfig) self::$baseConfig = null;  // for test cases we need to be able to control base config and setting values manually, so $keepBaseConfig needs to be true
263 daniel-mar 753
                self::$gui = null;
754
                self::$authUtils = null;
755
                self::$mailUtils = null;
756
                self::$menuUtils = null;
757
                self::$logger = null;
295 daniel-mar 758
                self::$dbMainSession = null;
759
                self::$dbIsolatedSession = null;
263 daniel-mar 760
                self::$pagePlugins = array();
761
                self::$authPlugins = array();
289 daniel-mar 762
                self::$loggerPlugins = array();
263 daniel-mar 763
                self::$objectTypePlugins = array();
764
                self::$enabledObjectTypes = array();
765
                self::$disabledObjectTypes = array();
766
                self::$dbPlugins = array();
274 daniel-mar 767
                self::$sqlSlangPlugins = array();
355 daniel-mar 768
                self::$languagePlugins = array();
449 daniel-mar 769
                self::$designPlugins = array();
263 daniel-mar 770
                self::$system_id_cache = null;
771
                self::$sslAvailableCache = null;
468 daniel-mar 772
                self::$translationArray = array();
74 daniel-mar 773
 
263 daniel-mar 774
                // Continue...
775
 
294 daniel-mar 776
                OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
263 daniel-mar 777
                                       // You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
778
 
150 daniel-mar 779
                // Register database types (highest priority)
780
 
274 daniel-mar 781
                // SQL slangs
782
 
294 daniel-mar 783
                self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin'));
274 daniel-mar 784
                foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
785
                        $plugin->init($html);
786
                }
787
 
788
                // Database providers
789
 
277 daniel-mar 790
                self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin'));
237 daniel-mar 791
                foreach (OIDplus::getDatabasePlugins() as $plugin) {
792
                        $plugin->init($html);
793
                }
794
 
42 daniel-mar 795
                // Do redirect stuff etc.
74 daniel-mar 796
 
230 daniel-mar 797
                self::isSslAvailable(); // This function does automatic redirects
61 daniel-mar 798
 
263 daniel-mar 799
                // Construct the configuration manager
66 daniel-mar 800
 
263 daniel-mar 801
                OIDplus::config(); // During the construction, various system settings are prepared if required
66 daniel-mar 802
 
74 daniel-mar 803
                // Initialize public / private keys
804
 
227 daniel-mar 805
                OIDplus::getPkiStatus(true);
74 daniel-mar 806
 
237 daniel-mar 807
                // Register non-DB plugins
74 daniel-mar 808
 
525 daniel-mar 809
                self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin'));
277 daniel-mar 810
                self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin'));
289 daniel-mar 811
                self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin'));
277 daniel-mar 812
                self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin'));
355 daniel-mar 813
                self::registerAllPlugins('language', 'OIDplusLanguagePlugin', array('OIDplus','registerLanguagePlugin'));
449 daniel-mar 814
                self::registerAllPlugins('design', 'OIDplusDesignPlugin', array('OIDplus','registerDesignPlugin'));
150 daniel-mar 815
 
237 daniel-mar 816
                // Initialize non-DB plugins
224 daniel-mar 817
 
281 daniel-mar 818
                foreach (OIDplus::getPagePlugins() as $plugin) {
74 daniel-mar 819
                        $plugin->init($html);
820
                }
230 daniel-mar 821
                foreach (OIDplus::getAuthPlugins() as $plugin) {
822
                        $plugin->init($html);
823
                }
289 daniel-mar 824
                foreach (OIDplus::getLoggerPlugins() as $plugin) {
825
                        $plugin->init($html);
826
                }
230 daniel-mar 827
                foreach (OIDplus::getObjectTypePlugins() as $plugin) {
828
                        $plugin->init($html);
829
                }
355 daniel-mar 830
                foreach (OIDplus::getLanguagePlugins() as $plugin) {
831
                        $plugin->init($html);
832
                }
449 daniel-mar 833
                foreach (OIDplus::getDesignPlugins() as $plugin) {
834
                        $plugin->init($html);
835
                }
412 daniel-mar 836
 
837
                // Initialize other stuff (i.e. things which require the logger!)
838
 
839
                OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
840
                OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
2 daniel-mar 841
        }
42 daniel-mar 842
 
227 daniel-mar 843
        # --- System URL, System ID, PKI, and other functions
844
 
412 daniel-mar 845
        private static function recognizeSystemUrl() {
846
                try {
496 daniel-mar 847
                        $url = OIDplus::webpath();
412 daniel-mar 848
                        OIDplus::config()->setValue('last_known_system_url', $url);
849
                } catch (Exception $e) {
850
                }
851
        }
497 daniel-mar 852
 
496 daniel-mar 853
        private static function getExecutingScriptPathDepth() {
854
                if (PHP_SAPI == 'cli') {
855
                        global $argv;
856
                        $test_dir = dirname(realpath($argv[0]));
857
                } else {
858
                        if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
859
                        $test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
860
                }
861
                $test_dir = str_replace('\\', '/', $test_dir);
862
                $steps_up = 0;
863
                while (!file_exists($test_dir.'/oidplus.min.css.php')) { // We just assume that only the OIDplus base directory contains "oidplus.min.css.php" and not any subsequent directory!
864
                        $test_dir = dirname($test_dir);
865
                        $steps_up++;
866
                        if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
867
                }
868
                return $steps_up;
869
        }
632 daniel-mar 870
 
580 daniel-mar 871
        public static function isSSL() {
872
                return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
873
        }
412 daniel-mar 874
 
496 daniel-mar 875
        private static function getSystemUrl($relative=false) {
326 daniel-mar 876
                if (!$relative) {
877
                        $res = OIDplus::baseConfig()->getValue('EXPLICIT_ABSOLUTE_SYSTEM_URL', '');
878
                        if ($res !== '') {
494 daniel-mar 879
                                return rtrim($res,'/').'/';
326 daniel-mar 880
                        }
495 daniel-mar 881
                        if (PHP_SAPI == 'cli') {
494 daniel-mar 882
                                try {
883
                                        return OIDplus::config()->getValue('last_known_system_url', false);
884
                                } catch (Exception $e) {
885
                                        return false;
886
                                }
887
                        }
326 daniel-mar 888
                }
889
 
494 daniel-mar 890
                // First, try to find out how many levels we need to go up
496 daniel-mar 891
                $steps_up = self::getExecutingScriptPathDepth();
892
                if ($steps_up === false) return false;
227 daniel-mar 893
 
496 daniel-mar 894
                // Now go up these amount of levels, based on SCRIPT_NAME/argv[0]
495 daniel-mar 895
                if (PHP_SAPI == 'cli') {
896
                        if ($relative) {
897
                                return str_repeat('../',$steps_up);
898
                        } else {
899
                                return false;
900
                        }
901
                } else {
902
                        $res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
903
                        for ($i=0; $i<$steps_up; $i++) {
904
                                $res = dirname($res);
905
                        }
906
                        $res = str_replace('\\', '/', $res);
907
                        if ($res == '/') $res = '';
908
                        $res .= '/';
496 daniel-mar 909
 
495 daniel-mar 910
                        // Do we want to have an absolute URI?
911
                        if (!$relative) {
580 daniel-mar 912
                                $is_ssl = self::isSSL();
495 daniel-mar 913
                                $protocol = $is_ssl ? 'https' : 'http'; // do not translate
914
                                $host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
915
                                $res = $protocol.'://'.$host.$res;
916
                        }
496 daniel-mar 917
 
495 daniel-mar 918
                        return $res;
227 daniel-mar 919
                }
920
        }
921
 
922
        private static $system_id_cache = null;
923
        public static function getSystemId($oid=false) {
924
                if (!is_null(self::$system_id_cache)) {
925
                        $out = self::$system_id_cache;
926
                } else {
927
                        $out = false;
928
 
929
                        if (self::getPkiStatus(true)) {
930
                                $pubKey = OIDplus::config()->getValue('oidplus_public_key');
386 daniel-mar 931
                                $m = array();
227 daniel-mar 932
                                if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
933
                                        $out = smallhash(base64_decode($m[1]));
934
                                }
935
                        }
936
                        self::$system_id_cache = $out;
937
                }
350 daniel-mar 938
                if (!$out) return false;
291 daniel-mar 939
                return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
227 daniel-mar 940
        }
941
 
942
        public static function getPkiStatus($try_generate=true) {
943
                if (!function_exists('openssl_pkey_new')) return false;
944
 
945
                $privKey = OIDplus::config()->getValue('oidplus_private_key');
946
                $pubKey = OIDplus::config()->getValue('oidplus_public_key');
947
 
948
                if ($try_generate && !verify_private_public_key($privKey, $pubKey)) {
263 daniel-mar 949
                        $pkey_config = array(
227 daniel-mar 950
                            "digest_alg" => "sha512",
951
                            "private_key_bits" => 2048,
952
                            "private_key_type" => OPENSSL_KEYTYPE_RSA,
953
                        );
954
 
955
                        // Create the private and public key
263 daniel-mar 956
                        $res = openssl_pkey_new($pkey_config);
256 daniel-mar 957
 
239 daniel-mar 958
                        if (!$res) return false;
227 daniel-mar 959
 
960
                        // Extract the private key from $res to $privKey
961
                        openssl_pkey_export($res, $privKey);
962
 
963
                        // Extract the public key from $res to $pubKey
964
                        $pubKey = openssl_pkey_get_details($res)["key"];
965
 
239 daniel-mar 966
                        // Log
288 daniel-mar 967
                        OIDplus::logger()->log("[INFO]A!", "Generating new SystemID using a new key pair");
239 daniel-mar 968
 
227 daniel-mar 969
                        // Save the key pair to database
970
                        OIDplus::config()->setValue('oidplus_private_key', $privKey);
971
                        OIDplus::config()->setValue('oidplus_public_key', $pubKey);
972
 
973
                        // Log the new system ID
386 daniel-mar 974
                        $m = array();
227 daniel-mar 975
                        if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
976
                                $system_id = smallhash(base64_decode($m[1]));
288 daniel-mar 977
                                OIDplus::logger()->log("[INFO]A!", "Your SystemID is now $system_id");
227 daniel-mar 978
                        }
979
                }
980
 
981
                return verify_private_public_key($privKey, $pubKey);
982
        }
983
 
170 daniel-mar 984
        public static function getInstallType() {
486 daniel-mar 985
                $counter = 0;
986
 
661 daniel-mar 987
                if ($new_version_file_exists = file_exists(OIDplus::localpath().'.version.php')) {
486 daniel-mar 988
                        $counter++;
591 daniel-mar 989
                }
661 daniel-mar 990
                if ($old_version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) {
991
                        $counter++;
992
                }
993
                $version_file_exists = $old_version_file_exists | $new_version_file_exists;
681 daniel-mar 994
                if ($svn_dir_exists = (is_dir(OIDplus::localpath().'.svn') ||
995
                                       is_dir(OIDplus::localpath().'../.svn'))) { // in case we checked out the root instead of the "trunk"
486 daniel-mar 996
                        $counter++;
591 daniel-mar 997
                }
681 daniel-mar 998
                // if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) {
698 daniel-mar 999
                if ($git_dir_exists = (OIDplus::findGitFolder() !== false)) {
486 daniel-mar 1000
                        $counter++;
591 daniel-mar 1001
                }
486 daniel-mar 1002
 
1003
                if ($counter === 0) {
360 daniel-mar 1004
                        return 'unknown'; // do not translate
170 daniel-mar 1005
                }
591 daniel-mar 1006
                else if ($counter > 1) {
360 daniel-mar 1007
                        return 'ambigous'; // do not translate
170 daniel-mar 1008
                }
591 daniel-mar 1009
                else if ($svn_dir_exists) {
360 daniel-mar 1010
                        return 'svn-wc'; // do not translate
170 daniel-mar 1011
                }
591 daniel-mar 1012
                else if ($git_dir_exists) {
486 daniel-mar 1013
                        return 'git-wc'; // do not translate
1014
                }
591 daniel-mar 1015
                else if ($version_file_exists) {
360 daniel-mar 1016
                        return 'svn-snapshot'; // do not translate
170 daniel-mar 1017
                }
1018
        }
1019
 
412 daniel-mar 1020
        private static function recognizeVersion() {
1021
                try {
1022
                        $ver_prev = OIDplus::config()->getValue("last_known_version");
1023
                        $ver_now = OIDplus::getVersion();
1024
                        if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
455 daniel-mar 1025
                                // TODO: Problem: When the system was updated using SVN, then the IP address of the next random visitor of the website is logged!
412 daniel-mar 1026
                                OIDplus::logger()->log("[INFO]A!", "System version changed from '$ver_prev' to '$ver_now'");
1027
                        }
1028
                        OIDplus::config()->setValue("last_known_version", $ver_now);
1029
                } catch (Exception $e) {
1030
                }
1031
        }
1032
 
111 daniel-mar 1033
        public static function getVersion() {
412 daniel-mar 1034
                static $cachedVersion = null;
1035
                if (!is_null($cachedVersion)) {
1036
                        return $cachedVersion;
1037
                }
1038
 
486 daniel-mar 1039
                $installType = OIDplus::getInstallType();
1040
 
1041
                if ($installType === 'svn-wc') {
496 daniel-mar 1042
                        $ver = get_svn_revision(OIDplus::localpath());
486 daniel-mar 1043
                        if ($ver)
1044
                                return ($cachedVersion = 'svn-'.$ver);
558 daniel-mar 1045
                        $ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk"
1046
                        if ($ver)
1047
                                return ($cachedVersion = 'svn-'.$ver);
111 daniel-mar 1048
                }
162 daniel-mar 1049
 
486 daniel-mar 1050
                if ($installType === 'git-wc') {
698 daniel-mar 1051
                        $ver = OIDplus::getGitsvnRevision(OIDplus::localpath());
486 daniel-mar 1052
                        if ($ver)
1053
                                return ($cachedVersion = 'svn-'.$ver);
162 daniel-mar 1054
                }
1055
 
486 daniel-mar 1056
                if ($installType === 'svn-snapshot') {
661 daniel-mar 1057
                        $cont = '';
1058
                        if (file_exists($filename = OIDplus::localpath().'oidplus_version.txt'))
1059
                                $cont = file_get_contents($filename);
1060
                        if (file_exists($filename = OIDplus::localpath().'.version.php'))
1061
                                $cont = file_get_contents($filename);
386 daniel-mar 1062
                        $m = array();
360 daniel-mar 1063
                        if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
412 daniel-mar 1064
                                return ($cachedVersion = 'svn-'.$m[1]); // do not translate
162 daniel-mar 1065
                }
1066
 
486 daniel-mar 1067
                return ($cachedVersion = false); // version ambigous or unknown
111 daniel-mar 1068
        }
1069
 
230 daniel-mar 1070
        private static $sslAvailableCache = null;
1071
        public static function isSslAvailable() {
1072
                if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
256 daniel-mar 1073
 
495 daniel-mar 1074
                if (PHP_SAPI == 'cli') {
230 daniel-mar 1075
                        self::$sslAvailableCache = false;
1076
                        return false;
1077
                }
1078
 
49 daniel-mar 1079
                $timeout = 2;
580 daniel-mar 1080
                $already_ssl = self::isSSL();
80 daniel-mar 1081
                $ssl_port = 443;
42 daniel-mar 1082
 
261 daniel-mar 1083
                $mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', 2/*auto*/);
1084
 
1085
                if ($mode == 0) {
80 daniel-mar 1086
                        // No SSL available
230 daniel-mar 1087
                        self::$sslAvailableCache = $already_ssl;
80 daniel-mar 1088
                        return $already_ssl;
1089
                }
1090
 
261 daniel-mar 1091
                if ($mode == 1) {
80 daniel-mar 1092
                        // Force SSL
1093
                        if ($already_ssl) {
230 daniel-mar 1094
                                self::$sslAvailableCache = true;
80 daniel-mar 1095
                                return true;
42 daniel-mar 1096
                        } else {
80 daniel-mar 1097
                                $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
1098
                                header('Location:'.$location);
360 daniel-mar 1099
                                die(_L('Redirecting to HTTPS...'));
591 daniel-mar 1100
                                #self::$sslAvailableCache = true;
1101
                                #return true;
80 daniel-mar 1102
                        }
1103
                }
1104
 
261 daniel-mar 1105
                if ($mode == 2) {
80 daniel-mar 1106
                        // Automatic SSL detection
1107
 
1108
                        if ($already_ssl) {
1109
                                // we are already on HTTPS
557 daniel-mar 1110
                                OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false);
230 daniel-mar 1111
                                self::$sslAvailableCache = true;
80 daniel-mar 1112
                                return true;
1113
                        } else {
1114
                                if (isset($_COOKIE['SSL_CHECK'])) {
1115
                                        // We already had the HTTPS detection done before.
1116
                                        if ($_COOKIE['SSL_CHECK']) {
1117
                                                // HTTPS was detected before, but we are HTTP. Redirect now
1118
                                                $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
1119
                                                header('Location:'.$location);
360 daniel-mar 1120
                                                die(_L('Redirecting to HTTPS...'));
591 daniel-mar 1121
                                                #self::$sslAvailableCache = true;
1122
                                                #return true;
80 daniel-mar 1123
                                        } else {
1124
                                                // No HTTPS available. Do nothing.
230 daniel-mar 1125
                                                self::$sslAvailableCache = false;
80 daniel-mar 1126
                                                return false;
1127
                                        }
49 daniel-mar 1128
                                } else {
80 daniel-mar 1129
                                        // This is our first check (or the browser didn't accept the SSL_CHECK cookie)
386 daniel-mar 1130
                                        $errno = -1;
1131
                                        $errstr = '';
80 daniel-mar 1132
                                        if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) {
1133
                                                // HTTPS detected. Redirect now, and remember that we had detected HTTPS
557 daniel-mar 1134
                                                OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false);
80 daniel-mar 1135
                                                $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
1136
                                                header('Location:'.$location);
360 daniel-mar 1137
                                                die(_L('Redirecting to HTTPS...'));
591 daniel-mar 1138
                                                #self::$sslAvailableCache = true;
1139
                                                #return true;
80 daniel-mar 1140
                                        } else {
1141
                                                // No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
557 daniel-mar 1142
                                                OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, false);
230 daniel-mar 1143
                                                self::$sslAvailableCache = false;
80 daniel-mar 1144
                                                return false;
1145
                                        }
49 daniel-mar 1146
                                }
42 daniel-mar 1147
                        }
1148
                }
1149
        }
497 daniel-mar 1150
 
496 daniel-mar 1151
        /**
1152
         * Gets a local path pointing to a resource
1153
         * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
1154
         * @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
590 daniel-mar 1155
         * @return string|false The local path, with guaranteed trailing path delimiter for directories
496 daniel-mar 1156
         */
1157
        public static function localpath($target=null, $relative=false) {
1158
                if (is_null($target)) {
1159
                        $target = __DIR__.'/../../';
1160
                }
241 daniel-mar 1161
 
496 daniel-mar 1162
                if ($relative) {
1163
                        // First, try to find out how many levels we need to go up
1164
                        $steps_up = self::getExecutingScriptPathDepth();
1165
                        if ($steps_up === false) return false;
497 daniel-mar 1166
 
496 daniel-mar 1167
                        // Virtually go back from the executing PHP script to the OIDplus base path
1168
                        $res = str_repeat('../',$steps_up);
497 daniel-mar 1169
 
496 daniel-mar 1170
                        // Then go to the desired location
1171
                        $basedir = realpath(__DIR__.'/../../');
1172
                        $target = realpath($target);
500 daniel-mar 1173
                        if ($target === false) return false;
496 daniel-mar 1174
                        $res .= substr($target, strlen($basedir)+1);
1175
                        $res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
1176
                } else {
1177
                        $res = realpath($target);
241 daniel-mar 1178
                }
497 daniel-mar 1179
 
591 daniel-mar 1180
                if (is_dir($target)) $res .= DIRECTORY_SEPARATOR;
497 daniel-mar 1181
 
496 daniel-mar 1182
                return $res;
241 daniel-mar 1183
        }
355 daniel-mar 1184
 
496 daniel-mar 1185
        /**
1186
         * Gets a URL pointing to a resource
1187
         * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
1188
         * @param boolean $relative If true, the returning path is relative to the currently executed PHP script (i.e. index.php , not the plugin PHP script!)
590 daniel-mar 1189
         * @return string|false The URL, with guaranteed trailing path delimiter for directories
496 daniel-mar 1190
         */
1191
        public static function webpath($target=null, $relative=false) {
1192
                $res = self::getSystemUrl($relative); // Note: already contains a trailing path delimiter
1193
                if (!$res) return false;
497 daniel-mar 1194
 
496 daniel-mar 1195
                if (!is_null($target)) {
1196
                        $basedir = realpath(__DIR__.'/../../');
1197
                        $target = realpath($target);
500 daniel-mar 1198
                        if ($target === false) return false;
496 daniel-mar 1199
                        $tmp = substr($target, strlen($basedir)+1);
500 daniel-mar 1200
                        $res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
497 daniel-mar 1201
                        if (is_dir($target)) $res .= '/';
496 daniel-mar 1202
                }
497 daniel-mar 1203
 
496 daniel-mar 1204
                return $res;
1205
        }
497 daniel-mar 1206
 
639 daniel-mar 1207
        private static $shutdown_functions = array();
1208
        public static function register_shutdown_function($func) {
1209
                self::$shutdown_functions[] = $func;
1210
        }
1211
 
1212
        public static function invoke_shutdown() {
1213
                foreach (self::$shutdown_functions as $func) {
1214
                        $func();
1215
                }
1216
        }
1217
 
360 daniel-mar 1218
        public static function getAvailableLangs() {
1219
                $langs = array();
1220
                foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389 daniel-mar 1221
                        $code = $pluginManifest->getLanguageCode();
360 daniel-mar 1222
                        $langs[] = $code;
1223
                }
1224
                return $langs;
1225
        }
1226
 
355 daniel-mar 1227
        public static function getCurrentLang() {
360 daniel-mar 1228
                if (isset($_GET['lang'])) {
1229
                        $lang = $_GET['lang'];
1230
                } else if (isset($_POST['lang'])) {
1231
                        $lang = $_POST['lang'];
1232
                } else if (isset($_COOKIE['LANGUAGE'])) {
1233
                        $lang = $_COOKIE['LANGUAGE'];
1234
                } else {
1235
                        $lang = self::DEFAULT_LANGUAGE;
1236
                }
1237
                $lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
355 daniel-mar 1238
                return $lang;
1239
        }
1240
 
362 daniel-mar 1241
        public static function handleLangArgument() {
1242
                if (isset($_GET['lang'])) {
1243
                        // The "?lang=" argument is only for NoScript-Browsers/SearchEngines
1244
                        // In case someone who has JavaScript clicks a ?lang= link, they should get
1245
                        // the page in that language, but the cookie must be set, otherwise
1246
                        // the menu and other stuff would be in their cookie-based-language and not the
1247
                        // argument-based-language.
557 daniel-mar 1248
                        OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
362 daniel-mar 1249
                } else if (isset($_POST['lang'])) {
557 daniel-mar 1250
                        OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
362 daniel-mar 1251
                }
1252
        }
1253
 
468 daniel-mar 1254
        private static $translationArray = array();
469 daniel-mar 1255
        protected static function getTranslationFileContents($translation_file) {
1256
                // First, try the cache
481 daniel-mar 1257
                $cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
469 daniel-mar 1258
                if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
1259
                        $cac = @unserialize(file_get_contents($cache_file));
1260
                        if ($cac) return $cac;
1261
                }
481 daniel-mar 1262
 
469 daniel-mar 1263
                // If not successful, then load the XML file
1264
                $xml = @simplexml_load_string(file_get_contents($translation_file));
1265
                if (!$xml) return array(); // if there is an UTF-8 or parsing error, don't output any errors, otherwise the JavaScript is corrupt and the page won't render correctly
1266
                $cac = array();
1267
                foreach ($xml->message as $msg) {
1268
                        $src = trim($msg->source->__toString());
1269
                        $dst = trim($msg->target->__toString());
1270
                        $cac[$src] = $dst;
1271
                }
1272
                @file_put_contents($cache_file,serialize($cac));
1273
                @touch($cache_file,filemtime($translation_file));
1274
                return $cac;
1275
        }
468 daniel-mar 1276
        public static function getTranslationArray($requested_lang='*') {
362 daniel-mar 1277
                foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389 daniel-mar 1278
                        $lang = $pluginManifest->getLanguageCode();
362 daniel-mar 1279
                        if (strpos($lang,'/') !== false) continue; // just to be sure
1280
                        if (strpos($lang,'\\') !== false) continue; // just to be sure
1281
                        if (strpos($lang,'..') !== false) continue; // just to be sure
401 daniel-mar 1282
 
468 daniel-mar 1283
                        if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
401 daniel-mar 1284
 
468 daniel-mar 1285
                        if (!isset(self::$translationArray[$lang])) {
1286
                                self::$translationArray[$lang] = array();
1287
 
1288
                                $wildcard = $pluginManifest->getLanguageMessages();
1289
                                if (strpos($wildcard,'/') !== false) continue; // just to be sure
1290
                                if (strpos($wildcard,'\\') !== false) continue; // just to be sure
1291
                                if (strpos($wildcard,'..') !== false) continue; // just to be sure
1292
 
635 daniel-mar 1293
                                $translation_files = glob(__DIR__.'/../../plugins/'.'*'.'/language/'.$lang.'/'.$wildcard);
468 daniel-mar 1294
                                sort($translation_files);
1295
                                foreach ($translation_files as $translation_file) {
1296
                                        if (!file_exists($translation_file)) continue;
469 daniel-mar 1297
                                        $cac = self::getTranslationFileContents($translation_file);
1298
                                        foreach ($cac as $src => $dst) {
1299
                                                self::$translationArray[$lang][$src] = $dst;
468 daniel-mar 1300
                                        }
401 daniel-mar 1301
                                }
362 daniel-mar 1302
                        }
1303
                }
468 daniel-mar 1304
                return self::$translationArray;
362 daniel-mar 1305
        }
1306
 
699 daniel-mar 1307
        public static function getEditionInfo() {
1308
                return @parse_ini_file(__DIR__.'/../edition.ini', true)['Edition'];
1309
        }
1310
 
698 daniel-mar 1311
        public static function findGitFolder() {
1312
                // Git command line saves git information in folder ".git"
1313
                // Plesk git saves git information in folder "../../../git/oidplus/" (or similar)
1314
                $dir = realpath(__DIR__);
1315
                if (is_dir($dir.'/.git')) return $dir.'/.git';
1316
                $i = 0;
1317
                do {
1318
                        if (is_dir($dir.'/git')) {
1319
                                $confs = glob($dir.'/git/'.'*'.'/config');
1320
                                foreach ($confs as $conf) {
1321
                                        $cont = file_get_contents($conf);
699 daniel-mar 1322
                                        if (isset(OIDplus::getEditionInfo()['gitrepo']) && (OIDplus::getEditionInfo()['gitrepo'] != '') && (strpos($cont, OIDplus::getEditionInfo()['gitrepo']) !== false)) {
698 daniel-mar 1323
                                                return dirname($conf);
1324
                                        }
1325
                                }
1326
                        }
1327
                        $i++;
1328
                } while (($i<100) && ($dir != ($new_dir = realpath($dir.'/../'))) && ($dir = $new_dir));
1329
                return false;
1330
        }
1331
 
1332
        public static function getGitsvnRevision($dir='') {
1333
                try {
1334
                        // tries command line and binary parsing
699 daniel-mar 1335
                        // requires vendor/danielmarschall/git_utils.inc.php
698 daniel-mar 1336
                        $git_dir = OIDplus::findGitFolder();
1337
                        if ($git_dir === false) return false;
1338
                        $commit_msg = git_get_latest_commit_message($git_dir);
1339
                } catch (Exception $e) {
1340
                        return false;
1341
                }
1342
 
1343
                $m = array();
1344
                if (preg_match('%git-svn-id: (.+)@(\\d+) %ismU', $commit_msg, $m)) {
1345
                        return $m[2];
1346
                } else {
1347
                        return false;
1348
                }
1349
        }
1350
 
374 daniel-mar 1351
}