Rev 639 | Rev 661 | 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; |
||
497 | OIDplus::config()->setValue("objecttypes_enabled", implode(';', $enabled_ary)); |
||
498 | } |
||
66 | daniel-mar | 499 | |
500 | $init_ary[] = $ns; |
||
501 | OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary)); |
||
502 | } |
||
61 | daniel-mar | 503 | } |
504 | |||
227 | daniel-mar | 505 | public static function getObjectTypePlugins() { |
506 | return self::$objectTypePlugins; |
||
61 | daniel-mar | 507 | } |
508 | |||
227 | daniel-mar | 509 | public static function getObjectTypePluginsEnabled() { |
510 | $res = array(); |
||
511 | foreach (self::$objectTypePlugins as $plugin) { |
||
512 | $ot = $plugin::getObjectTypeClassName(); |
||
513 | if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin; |
||
514 | } |
||
515 | return $res; |
||
74 | daniel-mar | 516 | } |
517 | |||
227 | daniel-mar | 518 | public static function getObjectTypePluginsDisabled() { |
519 | $res = array(); |
||
520 | foreach (self::$objectTypePlugins as $plugin) { |
||
521 | $ot = $plugin::getObjectTypeClassName(); |
||
522 | if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin; |
||
74 | daniel-mar | 523 | } |
227 | daniel-mar | 524 | return $res; |
74 | daniel-mar | 525 | } |
526 | |||
227 | daniel-mar | 527 | public static function getEnabledObjectTypes() { |
528 | return self::$enabledObjectTypes; |
||
529 | } |
||
74 | daniel-mar | 530 | |
227 | daniel-mar | 531 | public static function getDisabledObjectTypes() { |
532 | return self::$disabledObjectTypes; |
||
533 | } |
||
74 | daniel-mar | 534 | |
277 | daniel-mar | 535 | # --- Plugin handling functions |
536 | |||
320 | daniel-mar | 537 | public static function getAllPlugins()/*: array*/ { |
538 | $res = array(); |
||
539 | $res = array_merge($res, self::$pagePlugins); |
||
540 | $res = array_merge($res, self::$authPlugins); |
||
541 | $res = array_merge($res, self::$loggerPlugins); |
||
542 | $res = array_merge($res, self::$objectTypePlugins); |
||
543 | $res = array_merge($res, self::$dbPlugins); |
||
544 | $res = array_merge($res, self::$sqlSlangPlugins); |
||
355 | daniel-mar | 545 | $res = array_merge($res, self::$languagePlugins); |
449 | daniel-mar | 546 | $res = array_merge($res, self::$designPlugins); |
320 | daniel-mar | 547 | return $res; |
548 | } |
||
549 | |||
321 | daniel-mar | 550 | public static function getPluginByOid($oid)/*: ?OIDplusPlugin*/ { |
320 | daniel-mar | 551 | $plugins = self::getAllPlugins(); |
321 | daniel-mar | 552 | foreach ($plugins as $plugin) { |
553 | if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) { |
||
554 | return $plugin; |
||
320 | daniel-mar | 555 | } |
556 | } |
||
557 | return null; |
||
558 | } |
||
559 | |||
380 | daniel-mar | 560 | public static function getPluginByClassName($classname)/*: ?OIDplusPlugin*/ { |
561 | $plugins = self::getAllPlugins(); |
||
562 | foreach ($plugins as $plugin) { |
||
563 | if (get_class($plugin) === $classname) { |
||
564 | return $plugin; |
||
565 | } |
||
566 | } |
||
567 | return null; |
||
277 | daniel-mar | 568 | } |
569 | |||
594 | daniel-mar | 570 | /** |
571 | * @return array<OIDplusPluginManifest>|array<string,array<string,OIDplusPluginManifest>> |
||
572 | */ |
||
307 | daniel-mar | 573 | public static function getAllPluginManifests($pluginFolderMask='*', $flat=true): array { |
277 | daniel-mar | 574 | $out = array(); |
279 | daniel-mar | 575 | // Note: glob() will sort by default, so we do not need a page priority attribute. |
576 | // So you just need to use a numeric plugin directory prefix (padded). |
||
635 | daniel-mar | 577 | $ary = glob(OIDplus::localpath().'plugins/'.'*'.'/'.$pluginFolderMask.'/'.'*'.'/manifest.xml'); |
646 | daniel-mar | 578 | |
579 | // Sort the plugins by their type and name, as if they would be in a single vendor-folder! |
||
580 | uasort($ary, function($a,$b) { |
||
581 | if ($a == $b) return 0; |
||
582 | |||
583 | $ary = explode('/',$a); |
||
584 | $bry = explode('/',$b); |
||
585 | |||
586 | // First sort by type (publicPage, auth, database, language, ...) |
||
587 | $a_type = $ary[count($ary)-1-2]; |
||
588 | $b_type = $bry[count($bry)-1-2]; |
||
589 | if ($a_type < $b_type) return -1; |
||
590 | if ($a_type > $b_type) return 1; |
||
591 | |||
592 | // Then sort by name (090_login, 100_whois, etc.) |
||
593 | $a_name = $ary[count($ary)-1-1]; |
||
594 | $b_name = $bry[count($bry)-1-1]; |
||
595 | if ($a_name < $b_name) return -1; |
||
596 | if ($a_name > $b_name) return 1; |
||
597 | |||
598 | // If it is still equal, then finally sort by vendorname |
||
599 | $a_vendor = $ary[count($ary)-1-3]; |
||
600 | $b_vendor = $bry[count($bry)-1-3]; |
||
601 | if ($a_vendor < $b_vendor) return -1; |
||
602 | if ($a_vendor > $b_vendor) return 1; |
||
603 | return 0; |
||
604 | }); |
||
605 | |||
277 | daniel-mar | 606 | foreach ($ary as $ini) { |
607 | if (!file_exists($ini)) continue; |
||
608 | |||
307 | daniel-mar | 609 | $manifest = new OIDplusPluginManifest(); |
610 | $manifest->loadManifest($ini); |
||
277 | daniel-mar | 611 | |
473 | daniel-mar | 612 | $class_name = $manifest->getPhpMainClass(); |
613 | if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) { |
||
614 | continue; |
||
615 | } |
||
616 | |||
307 | daniel-mar | 617 | if ($flat) { |
618 | $out[] = $manifest; |
||
619 | } else { |
||
620 | $plugintype_folder = basename(dirname(dirname($ini))); |
||
621 | $pluginname_folder = basename(dirname($ini)); |
||
622 | |||
623 | if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array(); |
||
624 | if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array(); |
||
625 | $out[$plugintype_folder][$pluginname_folder] = $manifest; |
||
626 | } |
||
277 | daniel-mar | 627 | } |
628 | return $out; |
||
629 | } |
||
630 | |||
594 | daniel-mar | 631 | /** |
632 | * @return array<string> |
||
633 | */ |
||
277 | daniel-mar | 634 | public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array { |
635 | $out = array(); |
||
525 | daniel-mar | 636 | if (is_array($pluginDirName)) { |
637 | $ary = array(); |
||
638 | foreach ($pluginDirName as $pluginDirName_) { |
||
639 | $ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false)); |
||
640 | } |
||
641 | } else { |
||
642 | $ary = self::getAllPluginManifests($pluginDirName, false); |
||
643 | } |
||
320 | daniel-mar | 644 | $known_plugin_oids = array(); |
456 | daniel-mar | 645 | if (OIDplus::baseConfig()->getValue('DEBUG')) { |
646 | $fake_feature = uuid_to_oid(gen_uuid()); |
||
588 | daniel-mar | 647 | } else { |
648 | $fake_feature = null; |
||
456 | daniel-mar | 649 | } |
277 | daniel-mar | 650 | foreach ($ary as $plugintype_folder => $bry) { |
438 | daniel-mar | 651 | foreach ($bry as $pluginname_folder => $manifest) { |
652 | $class_name = $manifest->getPhpMainClass(); |
||
653 | |||
654 | // Before we load the plugin, we want to make some checks to confirm |
||
655 | // that the plugin is working correctly. |
||
656 | |||
307 | daniel-mar | 657 | if (!$class_name) { |
438 | daniel-mar | 658 | 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 | 659 | } |
297 | daniel-mar | 660 | if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) { |
661 | continue; |
||
662 | } |
||
292 | daniel-mar | 663 | if (!class_exists($class_name)) { |
438 | daniel-mar | 664 | 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 | 665 | } |
279 | daniel-mar | 666 | if (!is_subclass_of($class_name, $expectedPluginClass)) { |
438 | daniel-mar | 667 | 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 | 668 | } |
438 | daniel-mar | 669 | if (($class_name!=$manifest->getTypeClass()) && (!is_subclass_of($class_name,$manifest->getTypeClass()))) { |
670 | 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 | 671 | } |
438 | daniel-mar | 672 | if (($manifest->getTypeClass()!=$expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(),$expectedPluginClass))) { |
673 | 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 | 674 | } |
675 | |||
438 | daniel-mar | 676 | $plugin_oid = $manifest->getOid(); |
320 | daniel-mar | 677 | if (!$plugin_oid) { |
438 | daniel-mar | 678 | throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Does not have an OID')); |
320 | daniel-mar | 679 | } |
680 | if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) { |
||
438 | daniel-mar | 681 | 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 | 682 | } |
683 | if (isset($known_plugin_oids[$plugin_oid])) { |
||
438 | daniel-mar | 684 | 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 | 685 | } |
646 | daniel-mar | 686 | |
632 | daniel-mar | 687 | $full_plugin_dir = dirname($manifest->getManifestFile()); |
688 | $full_plugin_dir = substr($full_plugin_dir, strlen(OIDplus::localpath())); |
||
633 | daniel-mar | 689 | // { 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 | 690 | 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.')) { |
691 | 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 | 692 | } |
320 | daniel-mar | 693 | |
632 | daniel-mar | 694 | $known_plugin_oids[$plugin_oid] = $plugintype_folder.'/'.$pluginname_folder; |
695 | |||
438 | daniel-mar | 696 | $obj = new $class_name(); |
456 | daniel-mar | 697 | |
698 | if (OIDplus::baseConfig()->getValue('DEBUG')) { |
||
699 | if ($obj->implementsFeature($fake_feature)) { |
||
700 | // see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663 |
||
701 | throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('implementsFeature() always returns true')); |
||
702 | } |
||
438 | daniel-mar | 703 | } |
704 | |||
705 | // 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!) |
||
706 | $tmp = array_merge( |
||
707 | $manifest->getJSFiles(), |
||
708 | $manifest->getCSSFiles(), |
||
709 | $manifest->getJSFilesSetup(), |
||
710 | $manifest->getCSSFilesSetup() |
||
711 | ); |
||
712 | foreach ($tmp as $file) { |
||
713 | if (!file_exists($file)) { |
||
714 | 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)); |
||
715 | } |
||
716 | } |
||
717 | |||
718 | // Now we can continue |
||
719 | |||
279 | daniel-mar | 720 | $out[] = $class_name; |
721 | if (!is_null($registerCallback)) { |
||
438 | daniel-mar | 722 | call_user_func($registerCallback, $obj); |
444 | daniel-mar | 723 | |
724 | // Alternative approaches: |
||
725 | //$registerCallback[0]::{$registerCallback[1]}($obj); |
||
726 | // or: |
||
727 | //forward_static_call($registerCallback, $obj); |
||
279 | daniel-mar | 728 | } |
277 | daniel-mar | 729 | } |
730 | |||
731 | } |
||
732 | return $out; |
||
733 | } |
||
734 | |||
227 | daniel-mar | 735 | # --- Initialization of OIDplus |
206 | daniel-mar | 736 | |
374 | daniel-mar | 737 | public static function init($html=true, $keepBaseConfig=true) { |
236 | daniel-mar | 738 | self::$html = $html; |
739 | |||
263 | daniel-mar | 740 | // Reset internal state, so we can re-init verything if required |
274 | daniel-mar | 741 | |
263 | daniel-mar | 742 | if (self::$old_config_format) { |
743 | // Note: This can only happen in very special cases (e.g. test cases) where you call init() twice |
||
360 | daniel-mar | 744 | 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 | 745 | } |
274 | daniel-mar | 746 | |
263 | daniel-mar | 747 | self::$config = null; |
374 | daniel-mar | 748 | 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 | 749 | self::$gui = null; |
750 | self::$authUtils = null; |
||
751 | self::$mailUtils = null; |
||
752 | self::$menuUtils = null; |
||
753 | self::$logger = null; |
||
295 | daniel-mar | 754 | self::$dbMainSession = null; |
755 | self::$dbIsolatedSession = null; |
||
263 | daniel-mar | 756 | self::$pagePlugins = array(); |
757 | self::$authPlugins = array(); |
||
289 | daniel-mar | 758 | self::$loggerPlugins = array(); |
263 | daniel-mar | 759 | self::$objectTypePlugins = array(); |
760 | self::$enabledObjectTypes = array(); |
||
761 | self::$disabledObjectTypes = array(); |
||
762 | self::$dbPlugins = array(); |
||
274 | daniel-mar | 763 | self::$sqlSlangPlugins = array(); |
355 | daniel-mar | 764 | self::$languagePlugins = array(); |
449 | daniel-mar | 765 | self::$designPlugins = array(); |
263 | daniel-mar | 766 | self::$system_id_cache = null; |
767 | self::$sslAvailableCache = null; |
||
468 | daniel-mar | 768 | self::$translationArray = array(); |
74 | daniel-mar | 769 | |
263 | daniel-mar | 770 | // Continue... |
771 | |||
294 | daniel-mar | 772 | OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!) |
263 | daniel-mar | 773 | // You can do changes to the configuration afterwards using OIDplus::baseConfig()->... |
774 | |||
150 | daniel-mar | 775 | // Register database types (highest priority) |
776 | |||
274 | daniel-mar | 777 | // SQL slangs |
778 | |||
294 | daniel-mar | 779 | self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin')); |
274 | daniel-mar | 780 | foreach (OIDplus::getSqlSlangPlugins() as $plugin) { |
781 | $plugin->init($html); |
||
782 | } |
||
783 | |||
784 | // Database providers |
||
785 | |||
277 | daniel-mar | 786 | self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin')); |
237 | daniel-mar | 787 | foreach (OIDplus::getDatabasePlugins() as $plugin) { |
788 | $plugin->init($html); |
||
789 | } |
||
790 | |||
42 | daniel-mar | 791 | // Do redirect stuff etc. |
74 | daniel-mar | 792 | |
230 | daniel-mar | 793 | self::isSslAvailable(); // This function does automatic redirects |
61 | daniel-mar | 794 | |
263 | daniel-mar | 795 | // Construct the configuration manager |
66 | daniel-mar | 796 | |
263 | daniel-mar | 797 | OIDplus::config(); // During the construction, various system settings are prepared if required |
66 | daniel-mar | 798 | |
74 | daniel-mar | 799 | // Initialize public / private keys |
800 | |||
227 | daniel-mar | 801 | OIDplus::getPkiStatus(true); |
74 | daniel-mar | 802 | |
237 | daniel-mar | 803 | // Register non-DB plugins |
74 | daniel-mar | 804 | |
525 | daniel-mar | 805 | self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin')); |
277 | daniel-mar | 806 | self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin')); |
289 | daniel-mar | 807 | self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin')); |
277 | daniel-mar | 808 | self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin')); |
355 | daniel-mar | 809 | self::registerAllPlugins('language', 'OIDplusLanguagePlugin', array('OIDplus','registerLanguagePlugin')); |
449 | daniel-mar | 810 | self::registerAllPlugins('design', 'OIDplusDesignPlugin', array('OIDplus','registerDesignPlugin')); |
150 | daniel-mar | 811 | |
237 | daniel-mar | 812 | // Initialize non-DB plugins |
224 | daniel-mar | 813 | |
281 | daniel-mar | 814 | foreach (OIDplus::getPagePlugins() as $plugin) { |
74 | daniel-mar | 815 | $plugin->init($html); |
816 | } |
||
230 | daniel-mar | 817 | foreach (OIDplus::getAuthPlugins() as $plugin) { |
818 | $plugin->init($html); |
||
819 | } |
||
289 | daniel-mar | 820 | foreach (OIDplus::getLoggerPlugins() as $plugin) { |
821 | $plugin->init($html); |
||
822 | } |
||
230 | daniel-mar | 823 | foreach (OIDplus::getObjectTypePlugins() as $plugin) { |
824 | $plugin->init($html); |
||
825 | } |
||
355 | daniel-mar | 826 | foreach (OIDplus::getLanguagePlugins() as $plugin) { |
827 | $plugin->init($html); |
||
828 | } |
||
449 | daniel-mar | 829 | foreach (OIDplus::getDesignPlugins() as $plugin) { |
830 | $plugin->init($html); |
||
831 | } |
||
412 | daniel-mar | 832 | |
833 | // Initialize other stuff (i.e. things which require the logger!) |
||
834 | |||
835 | OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set |
||
836 | OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created |
||
2 | daniel-mar | 837 | } |
42 | daniel-mar | 838 | |
227 | daniel-mar | 839 | # --- System URL, System ID, PKI, and other functions |
840 | |||
412 | daniel-mar | 841 | private static function recognizeSystemUrl() { |
842 | try { |
||
496 | daniel-mar | 843 | $url = OIDplus::webpath(); |
412 | daniel-mar | 844 | OIDplus::config()->setValue('last_known_system_url', $url); |
845 | } catch (Exception $e) { |
||
846 | } |
||
847 | } |
||
497 | daniel-mar | 848 | |
496 | daniel-mar | 849 | private static function getExecutingScriptPathDepth() { |
850 | if (PHP_SAPI == 'cli') { |
||
851 | global $argv; |
||
852 | $test_dir = dirname(realpath($argv[0])); |
||
853 | } else { |
||
854 | if (!isset($_SERVER["SCRIPT_FILENAME"])) return false; |
||
855 | $test_dir = dirname($_SERVER['SCRIPT_FILENAME']); |
||
856 | } |
||
857 | $test_dir = str_replace('\\', '/', $test_dir); |
||
858 | $steps_up = 0; |
||
859 | 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! |
||
860 | $test_dir = dirname($test_dir); |
||
861 | $steps_up++; |
||
862 | if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop |
||
863 | } |
||
864 | return $steps_up; |
||
865 | } |
||
632 | daniel-mar | 866 | |
580 | daniel-mar | 867 | public static function isSSL() { |
868 | return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on'); |
||
869 | } |
||
412 | daniel-mar | 870 | |
496 | daniel-mar | 871 | private static function getSystemUrl($relative=false) { |
326 | daniel-mar | 872 | if (!$relative) { |
873 | $res = OIDplus::baseConfig()->getValue('EXPLICIT_ABSOLUTE_SYSTEM_URL', ''); |
||
874 | if ($res !== '') { |
||
494 | daniel-mar | 875 | return rtrim($res,'/').'/'; |
326 | daniel-mar | 876 | } |
495 | daniel-mar | 877 | if (PHP_SAPI == 'cli') { |
494 | daniel-mar | 878 | try { |
879 | return OIDplus::config()->getValue('last_known_system_url', false); |
||
880 | } catch (Exception $e) { |
||
881 | return false; |
||
882 | } |
||
883 | } |
||
326 | daniel-mar | 884 | } |
885 | |||
494 | daniel-mar | 886 | // First, try to find out how many levels we need to go up |
496 | daniel-mar | 887 | $steps_up = self::getExecutingScriptPathDepth(); |
888 | if ($steps_up === false) return false; |
||
227 | daniel-mar | 889 | |
496 | daniel-mar | 890 | // Now go up these amount of levels, based on SCRIPT_NAME/argv[0] |
495 | daniel-mar | 891 | if (PHP_SAPI == 'cli') { |
892 | if ($relative) { |
||
893 | return str_repeat('../',$steps_up); |
||
894 | } else { |
||
895 | return false; |
||
896 | } |
||
897 | } else { |
||
898 | $res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail |
||
899 | for ($i=0; $i<$steps_up; $i++) { |
||
900 | $res = dirname($res); |
||
901 | } |
||
902 | $res = str_replace('\\', '/', $res); |
||
903 | if ($res == '/') $res = ''; |
||
904 | $res .= '/'; |
||
496 | daniel-mar | 905 | |
495 | daniel-mar | 906 | // Do we want to have an absolute URI? |
907 | if (!$relative) { |
||
580 | daniel-mar | 908 | $is_ssl = self::isSSL(); |
495 | daniel-mar | 909 | $protocol = $is_ssl ? 'https' : 'http'; // do not translate |
910 | $host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443 |
||
911 | $res = $protocol.'://'.$host.$res; |
||
912 | } |
||
496 | daniel-mar | 913 | |
495 | daniel-mar | 914 | return $res; |
227 | daniel-mar | 915 | } |
916 | } |
||
917 | |||
918 | private static $system_id_cache = null; |
||
919 | public static function getSystemId($oid=false) { |
||
920 | if (!is_null(self::$system_id_cache)) { |
||
921 | $out = self::$system_id_cache; |
||
922 | } else { |
||
923 | $out = false; |
||
924 | |||
925 | if (self::getPkiStatus(true)) { |
||
926 | $pubKey = OIDplus::config()->getValue('oidplus_public_key'); |
||
386 | daniel-mar | 927 | $m = array(); |
227 | daniel-mar | 928 | if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) { |
929 | $out = smallhash(base64_decode($m[1])); |
||
930 | } |
||
931 | } |
||
932 | self::$system_id_cache = $out; |
||
933 | } |
||
350 | daniel-mar | 934 | if (!$out) return false; |
291 | daniel-mar | 935 | return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out; |
227 | daniel-mar | 936 | } |
937 | |||
938 | public static function getPkiStatus($try_generate=true) { |
||
939 | if (!function_exists('openssl_pkey_new')) return false; |
||
940 | |||
941 | $privKey = OIDplus::config()->getValue('oidplus_private_key'); |
||
942 | $pubKey = OIDplus::config()->getValue('oidplus_public_key'); |
||
943 | |||
944 | if ($try_generate && !verify_private_public_key($privKey, $pubKey)) { |
||
263 | daniel-mar | 945 | $pkey_config = array( |
227 | daniel-mar | 946 | "digest_alg" => "sha512", |
947 | "private_key_bits" => 2048, |
||
948 | "private_key_type" => OPENSSL_KEYTYPE_RSA, |
||
949 | ); |
||
950 | |||
951 | // Create the private and public key |
||
263 | daniel-mar | 952 | $res = openssl_pkey_new($pkey_config); |
256 | daniel-mar | 953 | |
239 | daniel-mar | 954 | if (!$res) return false; |
227 | daniel-mar | 955 | |
956 | // Extract the private key from $res to $privKey |
||
957 | openssl_pkey_export($res, $privKey); |
||
958 | |||
959 | // Extract the public key from $res to $pubKey |
||
960 | $pubKey = openssl_pkey_get_details($res)["key"]; |
||
961 | |||
239 | daniel-mar | 962 | // Log |
288 | daniel-mar | 963 | OIDplus::logger()->log("[INFO]A!", "Generating new SystemID using a new key pair"); |
239 | daniel-mar | 964 | |
227 | daniel-mar | 965 | // Save the key pair to database |
966 | OIDplus::config()->setValue('oidplus_private_key', $privKey); |
||
967 | OIDplus::config()->setValue('oidplus_public_key', $pubKey); |
||
968 | |||
969 | // Log the new system ID |
||
386 | daniel-mar | 970 | $m = array(); |
227 | daniel-mar | 971 | if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) { |
972 | $system_id = smallhash(base64_decode($m[1])); |
||
288 | daniel-mar | 973 | OIDplus::logger()->log("[INFO]A!", "Your SystemID is now $system_id"); |
227 | daniel-mar | 974 | } |
975 | } |
||
976 | |||
977 | return verify_private_public_key($privKey, $pubKey); |
||
978 | } |
||
979 | |||
170 | daniel-mar | 980 | public static function getInstallType() { |
486 | daniel-mar | 981 | $counter = 0; |
982 | |||
591 | daniel-mar | 983 | if ($version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) { |
486 | daniel-mar | 984 | $counter++; |
591 | daniel-mar | 985 | } |
986 | if ($svn_dir_exists = is_dir(OIDplus::localpath().'.svn') || |
||
987 | is_dir(OIDplus::localpath().'../.svn')) { // in case we checked out the root instead of the "trunk" |
||
486 | daniel-mar | 988 | $counter++; |
591 | daniel-mar | 989 | } |
990 | if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) { |
||
486 | daniel-mar | 991 | $counter++; |
591 | daniel-mar | 992 | } |
486 | daniel-mar | 993 | |
994 | if ($counter === 0) { |
||
360 | daniel-mar | 995 | return 'unknown'; // do not translate |
170 | daniel-mar | 996 | } |
591 | daniel-mar | 997 | else if ($counter > 1) { |
360 | daniel-mar | 998 | return 'ambigous'; // do not translate |
170 | daniel-mar | 999 | } |
591 | daniel-mar | 1000 | else if ($svn_dir_exists) { |
360 | daniel-mar | 1001 | return 'svn-wc'; // do not translate |
170 | daniel-mar | 1002 | } |
591 | daniel-mar | 1003 | else if ($git_dir_exists) { |
486 | daniel-mar | 1004 | return 'git-wc'; // do not translate |
1005 | } |
||
591 | daniel-mar | 1006 | else if ($version_file_exists) { |
360 | daniel-mar | 1007 | return 'svn-snapshot'; // do not translate |
170 | daniel-mar | 1008 | } |
1009 | } |
||
1010 | |||
412 | daniel-mar | 1011 | private static function recognizeVersion() { |
1012 | try { |
||
1013 | $ver_prev = OIDplus::config()->getValue("last_known_version"); |
||
1014 | $ver_now = OIDplus::getVersion(); |
||
1015 | if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) { |
||
455 | daniel-mar | 1016 | // 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 | 1017 | OIDplus::logger()->log("[INFO]A!", "System version changed from '$ver_prev' to '$ver_now'"); |
1018 | } |
||
1019 | OIDplus::config()->setValue("last_known_version", $ver_now); |
||
1020 | } catch (Exception $e) { |
||
1021 | } |
||
1022 | } |
||
1023 | |||
111 | daniel-mar | 1024 | public static function getVersion() { |
412 | daniel-mar | 1025 | static $cachedVersion = null; |
1026 | if (!is_null($cachedVersion)) { |
||
1027 | return $cachedVersion; |
||
1028 | } |
||
1029 | |||
486 | daniel-mar | 1030 | $installType = OIDplus::getInstallType(); |
1031 | |||
1032 | if ($installType === 'svn-wc') { |
||
496 | daniel-mar | 1033 | $ver = get_svn_revision(OIDplus::localpath()); |
486 | daniel-mar | 1034 | if ($ver) |
1035 | return ($cachedVersion = 'svn-'.$ver); |
||
558 | daniel-mar | 1036 | $ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk" |
1037 | if ($ver) |
||
1038 | return ($cachedVersion = 'svn-'.$ver); |
||
111 | daniel-mar | 1039 | } |
162 | daniel-mar | 1040 | |
486 | daniel-mar | 1041 | if ($installType === 'git-wc') { |
496 | daniel-mar | 1042 | $ver = get_gitsvn_revision(OIDplus::localpath()); |
486 | daniel-mar | 1043 | if ($ver) |
1044 | return ($cachedVersion = 'svn-'.$ver); |
||
162 | daniel-mar | 1045 | } |
1046 | |||
486 | daniel-mar | 1047 | if ($installType === 'svn-snapshot') { |
496 | daniel-mar | 1048 | $cont = file_get_contents(OIDplus::localpath().'oidplus_version.txt'); |
386 | daniel-mar | 1049 | $m = array(); |
360 | daniel-mar | 1050 | if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate |
412 | daniel-mar | 1051 | return ($cachedVersion = 'svn-'.$m[1]); // do not translate |
162 | daniel-mar | 1052 | } |
1053 | |||
486 | daniel-mar | 1054 | return ($cachedVersion = false); // version ambigous or unknown |
111 | daniel-mar | 1055 | } |
1056 | |||
230 | daniel-mar | 1057 | private static $sslAvailableCache = null; |
1058 | public static function isSslAvailable() { |
||
1059 | if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache; |
||
256 | daniel-mar | 1060 | |
495 | daniel-mar | 1061 | if (PHP_SAPI == 'cli') { |
230 | daniel-mar | 1062 | self::$sslAvailableCache = false; |
1063 | return false; |
||
1064 | } |
||
1065 | |||
49 | daniel-mar | 1066 | $timeout = 2; |
580 | daniel-mar | 1067 | $already_ssl = self::isSSL(); |
80 | daniel-mar | 1068 | $ssl_port = 443; |
42 | daniel-mar | 1069 | |
261 | daniel-mar | 1070 | $mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', 2/*auto*/); |
1071 | |||
1072 | if ($mode == 0) { |
||
80 | daniel-mar | 1073 | // No SSL available |
230 | daniel-mar | 1074 | self::$sslAvailableCache = $already_ssl; |
80 | daniel-mar | 1075 | return $already_ssl; |
1076 | } |
||
1077 | |||
261 | daniel-mar | 1078 | if ($mode == 1) { |
80 | daniel-mar | 1079 | // Force SSL |
1080 | if ($already_ssl) { |
||
230 | daniel-mar | 1081 | self::$sslAvailableCache = true; |
80 | daniel-mar | 1082 | return true; |
42 | daniel-mar | 1083 | } else { |
80 | daniel-mar | 1084 | $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; |
1085 | header('Location:'.$location); |
||
360 | daniel-mar | 1086 | die(_L('Redirecting to HTTPS...')); |
591 | daniel-mar | 1087 | #self::$sslAvailableCache = true; |
1088 | #return true; |
||
80 | daniel-mar | 1089 | } |
1090 | } |
||
1091 | |||
261 | daniel-mar | 1092 | if ($mode == 2) { |
80 | daniel-mar | 1093 | // Automatic SSL detection |
1094 | |||
1095 | if ($already_ssl) { |
||
1096 | // we are already on HTTPS |
||
557 | daniel-mar | 1097 | OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false); |
230 | daniel-mar | 1098 | self::$sslAvailableCache = true; |
80 | daniel-mar | 1099 | return true; |
1100 | } else { |
||
1101 | if (isset($_COOKIE['SSL_CHECK'])) { |
||
1102 | // We already had the HTTPS detection done before. |
||
1103 | if ($_COOKIE['SSL_CHECK']) { |
||
1104 | // HTTPS was detected before, but we are HTTP. Redirect now |
||
1105 | $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; |
||
1106 | header('Location:'.$location); |
||
360 | daniel-mar | 1107 | die(_L('Redirecting to HTTPS...')); |
591 | daniel-mar | 1108 | #self::$sslAvailableCache = true; |
1109 | #return true; |
||
80 | daniel-mar | 1110 | } else { |
1111 | // No HTTPS available. Do nothing. |
||
230 | daniel-mar | 1112 | self::$sslAvailableCache = false; |
80 | daniel-mar | 1113 | return false; |
1114 | } |
||
49 | daniel-mar | 1115 | } else { |
80 | daniel-mar | 1116 | // This is our first check (or the browser didn't accept the SSL_CHECK cookie) |
386 | daniel-mar | 1117 | $errno = -1; |
1118 | $errstr = ''; |
||
80 | daniel-mar | 1119 | if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) { |
1120 | // HTTPS detected. Redirect now, and remember that we had detected HTTPS |
||
557 | daniel-mar | 1121 | OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false); |
80 | daniel-mar | 1122 | $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; |
1123 | header('Location:'.$location); |
||
360 | daniel-mar | 1124 | die(_L('Redirecting to HTTPS...')); |
591 | daniel-mar | 1125 | #self::$sslAvailableCache = true; |
1126 | #return true; |
||
80 | daniel-mar | 1127 | } else { |
1128 | // No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again. |
||
557 | daniel-mar | 1129 | OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, false); |
230 | daniel-mar | 1130 | self::$sslAvailableCache = false; |
80 | daniel-mar | 1131 | return false; |
1132 | } |
||
49 | daniel-mar | 1133 | } |
42 | daniel-mar | 1134 | } |
1135 | } |
||
1136 | } |
||
497 | daniel-mar | 1137 | |
496 | daniel-mar | 1138 | /** |
1139 | * Gets a local path pointing to a resource |
||
1140 | * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory |
||
1141 | * @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory) |
||
590 | daniel-mar | 1142 | * @return string|false The local path, with guaranteed trailing path delimiter for directories |
496 | daniel-mar | 1143 | */ |
1144 | public static function localpath($target=null, $relative=false) { |
||
1145 | if (is_null($target)) { |
||
1146 | $target = __DIR__.'/../../'; |
||
1147 | } |
||
241 | daniel-mar | 1148 | |
496 | daniel-mar | 1149 | if ($relative) { |
1150 | // First, try to find out how many levels we need to go up |
||
1151 | $steps_up = self::getExecutingScriptPathDepth(); |
||
1152 | if ($steps_up === false) return false; |
||
497 | daniel-mar | 1153 | |
496 | daniel-mar | 1154 | // Virtually go back from the executing PHP script to the OIDplus base path |
1155 | $res = str_repeat('../',$steps_up); |
||
497 | daniel-mar | 1156 | |
496 | daniel-mar | 1157 | // Then go to the desired location |
1158 | $basedir = realpath(__DIR__.'/../../'); |
||
1159 | $target = realpath($target); |
||
500 | daniel-mar | 1160 | if ($target === false) return false; |
496 | daniel-mar | 1161 | $res .= substr($target, strlen($basedir)+1); |
1162 | $res = rtrim($res,'/'); // avoid '..//' for localpath(null,true) |
||
1163 | } else { |
||
1164 | $res = realpath($target); |
||
241 | daniel-mar | 1165 | } |
497 | daniel-mar | 1166 | |
591 | daniel-mar | 1167 | if (is_dir($target)) $res .= DIRECTORY_SEPARATOR; |
497 | daniel-mar | 1168 | |
496 | daniel-mar | 1169 | return $res; |
241 | daniel-mar | 1170 | } |
355 | daniel-mar | 1171 | |
496 | daniel-mar | 1172 | /** |
1173 | * Gets a URL pointing to a resource |
||
1174 | * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory |
||
1175 | * @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 | 1176 | * @return string|false The URL, with guaranteed trailing path delimiter for directories |
496 | daniel-mar | 1177 | */ |
1178 | public static function webpath($target=null, $relative=false) { |
||
1179 | $res = self::getSystemUrl($relative); // Note: already contains a trailing path delimiter |
||
1180 | if (!$res) return false; |
||
497 | daniel-mar | 1181 | |
496 | daniel-mar | 1182 | if (!is_null($target)) { |
1183 | $basedir = realpath(__DIR__.'/../../'); |
||
1184 | $target = realpath($target); |
||
500 | daniel-mar | 1185 | if ($target === false) return false; |
496 | daniel-mar | 1186 | $tmp = substr($target, strlen($basedir)+1); |
500 | daniel-mar | 1187 | $res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath() |
497 | daniel-mar | 1188 | if (is_dir($target)) $res .= '/'; |
496 | daniel-mar | 1189 | } |
497 | daniel-mar | 1190 | |
496 | daniel-mar | 1191 | return $res; |
1192 | } |
||
497 | daniel-mar | 1193 | |
639 | daniel-mar | 1194 | private static $shutdown_functions = array(); |
1195 | public static function register_shutdown_function($func) { |
||
1196 | self::$shutdown_functions[] = $func; |
||
1197 | } |
||
1198 | |||
1199 | public static function invoke_shutdown() { |
||
1200 | foreach (self::$shutdown_functions as $func) { |
||
1201 | $func(); |
||
1202 | } |
||
1203 | } |
||
1204 | |||
360 | daniel-mar | 1205 | public static function getAvailableLangs() { |
1206 | $langs = array(); |
||
1207 | foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) { |
||
389 | daniel-mar | 1208 | $code = $pluginManifest->getLanguageCode(); |
360 | daniel-mar | 1209 | $langs[] = $code; |
1210 | } |
||
1211 | return $langs; |
||
1212 | } |
||
1213 | |||
355 | daniel-mar | 1214 | public static function getCurrentLang() { |
360 | daniel-mar | 1215 | if (isset($_GET['lang'])) { |
1216 | $lang = $_GET['lang']; |
||
1217 | } else if (isset($_POST['lang'])) { |
||
1218 | $lang = $_POST['lang']; |
||
1219 | } else if (isset($_COOKIE['LANGUAGE'])) { |
||
1220 | $lang = $_COOKIE['LANGUAGE']; |
||
1221 | } else { |
||
1222 | $lang = self::DEFAULT_LANGUAGE; |
||
1223 | } |
||
1224 | $lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize |
||
355 | daniel-mar | 1225 | return $lang; |
1226 | } |
||
1227 | |||
362 | daniel-mar | 1228 | public static function handleLangArgument() { |
1229 | if (isset($_GET['lang'])) { |
||
1230 | // The "?lang=" argument is only for NoScript-Browsers/SearchEngines |
||
1231 | // In case someone who has JavaScript clicks a ?lang= link, they should get |
||
1232 | // the page in that language, but the cookie must be set, otherwise |
||
1233 | // the menu and other stuff would be in their cookie-based-language and not the |
||
1234 | // argument-based-language. |
||
557 | daniel-mar | 1235 | OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/); |
362 | daniel-mar | 1236 | } else if (isset($_POST['lang'])) { |
557 | daniel-mar | 1237 | OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/); |
362 | daniel-mar | 1238 | } |
1239 | } |
||
1240 | |||
468 | daniel-mar | 1241 | private static $translationArray = array(); |
469 | daniel-mar | 1242 | protected static function getTranslationFileContents($translation_file) { |
1243 | // First, try the cache |
||
481 | daniel-mar | 1244 | $cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser'; |
469 | daniel-mar | 1245 | if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) { |
1246 | $cac = @unserialize(file_get_contents($cache_file)); |
||
1247 | if ($cac) return $cac; |
||
1248 | } |
||
481 | daniel-mar | 1249 | |
469 | daniel-mar | 1250 | // If not successful, then load the XML file |
1251 | $xml = @simplexml_load_string(file_get_contents($translation_file)); |
||
1252 | 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 |
||
1253 | $cac = array(); |
||
1254 | foreach ($xml->message as $msg) { |
||
1255 | $src = trim($msg->source->__toString()); |
||
1256 | $dst = trim($msg->target->__toString()); |
||
1257 | $cac[$src] = $dst; |
||
1258 | } |
||
1259 | @file_put_contents($cache_file,serialize($cac)); |
||
1260 | @touch($cache_file,filemtime($translation_file)); |
||
1261 | return $cac; |
||
1262 | } |
||
468 | daniel-mar | 1263 | public static function getTranslationArray($requested_lang='*') { |
362 | daniel-mar | 1264 | foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) { |
389 | daniel-mar | 1265 | $lang = $pluginManifest->getLanguageCode(); |
362 | daniel-mar | 1266 | if (strpos($lang,'/') !== false) continue; // just to be sure |
1267 | if (strpos($lang,'\\') !== false) continue; // just to be sure |
||
1268 | if (strpos($lang,'..') !== false) continue; // just to be sure |
||
401 | daniel-mar | 1269 | |
468 | daniel-mar | 1270 | if (($requested_lang != '*') && ($lang != $requested_lang)) continue; |
401 | daniel-mar | 1271 | |
468 | daniel-mar | 1272 | if (!isset(self::$translationArray[$lang])) { |
1273 | self::$translationArray[$lang] = array(); |
||
1274 | |||
1275 | $wildcard = $pluginManifest->getLanguageMessages(); |
||
1276 | if (strpos($wildcard,'/') !== false) continue; // just to be sure |
||
1277 | if (strpos($wildcard,'\\') !== false) continue; // just to be sure |
||
1278 | if (strpos($wildcard,'..') !== false) continue; // just to be sure |
||
1279 | |||
635 | daniel-mar | 1280 | $translation_files = glob(__DIR__.'/../../plugins/'.'*'.'/language/'.$lang.'/'.$wildcard); |
468 | daniel-mar | 1281 | sort($translation_files); |
1282 | foreach ($translation_files as $translation_file) { |
||
1283 | if (!file_exists($translation_file)) continue; |
||
469 | daniel-mar | 1284 | $cac = self::getTranslationFileContents($translation_file); |
1285 | foreach ($cac as $src => $dst) { |
||
1286 | self::$translationArray[$lang][$src] = $dst; |
||
468 | daniel-mar | 1287 | } |
401 | daniel-mar | 1288 | } |
362 | daniel-mar | 1289 | } |
1290 | } |
||
468 | daniel-mar | 1291 | return self::$translationArray; |
362 | daniel-mar | 1292 | } |
1293 | |||
374 | daniel-mar | 1294 | } |