WebSVN – oidplus – Blame – /trunk/includes/classes/OIDplus.class.php

Rev	Author	Line No.	Line
2	daniel-mar	1	<?php
		2
		3	/*
		4	* OIDplus 2.0
1073	daniel-mar	5	* Copyright 2019 - 2023 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
1050	daniel-mar	20	namespace ViaThinkSoft\OIDplus;
511	daniel-mar	21
1086	daniel-mar	22	// phpcs:disable PSR1.Files.SideEffects
		23	\defined('INSIDE_OIDPLUS') or die;
		24	// phpcs:enable PSR1.Files.SideEffects
		25
730	daniel-mar	26	class OIDplus extends OIDplusBaseClass {
281	daniel-mar	27	private static /OIDplusPagePlugin[]/ $pagePlugins = array();
		28	private static /OIDplusAuthPlugin[]/ $authPlugins = array();
289	daniel-mar	29	private static /OIDplusLoggerPlugin[]/ $loggerPlugins = array();
227	daniel-mar	30	private static /OIDplusObjectTypePlugin[]/ $objectTypePlugins = array();
		31	private static /string[]/ $enabledObjectTypes = array();
		32	private static /string[]/ $disabledObjectTypes = array();
		33	private static /OIDplusDatabasePlugin[]/ $dbPlugins = array();
702	daniel-mar	34	private static /OIDplusCaptchaPlugin[]/ $captchaPlugins = array();
274	daniel-mar	35	private static /OIDplusSqlSlangPlugin[]/ $sqlSlangPlugins = array();
355	daniel-mar	36	private static /OIDplusLanguagePlugin[]/ $languagePlugins = array();
449	daniel-mar	37	private static /OIDplusDesignPlugin[]/ $designPlugins = array();
2	daniel-mar	38
280	daniel-mar	39	protected static $html = true;
236	daniel-mar	40
812	daniel-mar	41	/public/ const PATH_RELATIVE = 1; // e.g. "../"
		42	/public/ const PATH_ABSOLUTE = 2; // e.g. "http://www.example.com/oidplus/"
		43	/public/ const PATH_ABSOLUTE_CANONICAL = 3; // e.g. "http://www.example.org/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
		44	/public/ const PATH_RELATIVE_TO_ROOT = 4; // e.g. "/oidplus/"
		45	/public/ const PATH_RELATIVE_TO_ROOT_CANONICAL = 5; // e.g. "/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
801	daniel-mar	46
778	daniel-mar	47	// These plugin types can contain HTML code and therefore may
		48	// emit (non-setup) CSS/JS code via their manifest.
1072	daniel-mar	49	// Note that design plugins may only output CSS, not JS.
778	daniel-mar	50	/public/ const INTERACTIVE_PLUGIN_TYPES = array(
		51	'publicPages',
		52	'raPages',
		53	'adminPages',
		54	'objectTypes',
		55	'captcha'
		56	);
		57
1073	daniel-mar	58	const UUID_NAMEBASED_NS_Base64PubKey = 'fd16965c-8bab-11ed-8744-3c4a92df8582';
		59
2	daniel-mar	60	private function __construct() {
		61	}
295	daniel-mar	62
1068	daniel-mar	63	private static function insideSetup(): bool {
		64	if (PHP_SAPI == 'cli') return false;
		65	if (!isset($_SERVER['REQUEST_URI'])) return false;
1055	daniel-mar	66	return (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE_TO_ROOT).'setup/') === 0);
		67	}
		68
1050	daniel-mar	69	// --- Static classes
274	daniel-mar	70
263	daniel-mar	71	private static $baseConfig = null;
1050	daniel-mar	72	private static $oldConfigFormatLoaded = false;
261	daniel-mar	73	public static function baseConfig() {
263	daniel-mar	74	$first_init = false;
274	daniel-mar	75
263	daniel-mar	76	if ($first_init = is_null(self::$baseConfig)) {
		77	self::$baseConfig = new OIDplusBaseConfig();
261	daniel-mar	78	}
		79
1055	daniel-mar	80	if (self::insideSetup()) return self::$baseConfig;
		81	if ((basename($_SERVER['SCRIPT_NAME']) === 'oidplus.min.js.php') && isset($_REQUEST['noBaseConfig']) && ($_REQUEST['noBaseConfig'] == '1')) return self::$baseConfig;
		82	if ((basename($_SERVER['SCRIPT_NAME']) === 'oidplus.min.css.php') && isset($_REQUEST['noBaseConfig']) && ($_REQUEST['noBaseConfig'] == '1')) return self::$baseConfig;
		83
263	daniel-mar	84	if ($first_init) {
261	daniel-mar	85	// Include a file containing various size/depth limitations of OIDs
294	daniel-mar	86	// It is important to include it before userdata/baseconfig/config.inc.php was included,
		87	// so we can give userdata/baseconfig/config.inc.php the chance to override the values.
261	daniel-mar	88
496	daniel-mar	89	include OIDplus::localpath().'includes/oidplus_limits.inc.php';
261	daniel-mar	90
		91	// Include config file
295	daniel-mar	92
496	daniel-mar	93	$config_file = OIDplus::localpath() . 'userdata/baseconfig/config.inc.php';
		94	$config_file_old = OIDplus::localpath() . 'includes/config.inc.php'; // backwards compatibility
295	daniel-mar	95
294	daniel-mar	96	if (!file_exists($config_file) && file_exists($config_file_old)) {
		97	$config_file = $config_file_old;
		98	}
261	daniel-mar	99
294	daniel-mar	100	if (file_exists($config_file)) {
1050	daniel-mar	101	if (self::$oldConfigFormatLoaded) {
263	daniel-mar	102	// Note: We may only include it once due to backwards compatibility,
		103	// since in version 2.0, the configuration was defined using define() statements
		104	// Attention: This does mean that a full re-init (e.g. for test cases) is not possible
		105	// if a version 2.0 config is used!
1050	daniel-mar	106
		107	// We need to do this, because define() cannot be undone
		108	// Note: This can only happen in very special cases (e.g. test cases) where you call init() twice
		109	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	110	} else {
1050	daniel-mar	111	$tmp = file_get_contents($config_file);
		112	$ns = "ViaThinkSoft\OIDplus\OIDplus";
		113	$uses = "use $ns;";
		114	if ((strpos($tmp,'OIDplus::') !== false) && (strpos($tmp,$uses) === false)) {
		115	// Migrate config file to namespace class names
		116	// Note: Only config files version 2.1 are affected. Not 2.0 ones
		117
		118	$tmp = "<?php\r\n\r\n$uses /* Automatically added by migration procedure */\r\n?>$tmp";
		119	$tmp = str_replace('?><?php', '', $tmp);
		120
		121	$tmp = str_replace("\$ns\OIDplusCaptchaPluginRecaptcha::", "OIDplusCaptchaPluginRecaptcha::", $tmp);
		122	$tmp = str_replace("OIDplusCaptchaPluginRecaptcha::", "\$ns\OIDplusCaptchaPluginRecaptcha::", $tmp);
		123
		124	$tmp = str_replace('DISABLE_PLUGIN_OIDplusPagePublicRdap',
		125	'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicRdap', $tmp);
		126	$tmp = str_replace('DISABLE_PLUGIN_OIDplusPagePublicAltIds',
		127	'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicAltIds', $tmp);
1051	daniel-mar	128	$tmp = str_replace('DISABLE_PLUGIN_OIDplusPagePublicUITweaks',
		129	'DISABLE_PLUGIN_TushevOrg\OIDplus\OIDplusPagePublicUITweaks', $tmp);
1050	daniel-mar	130	$tmp = str_replace('DISABLE_PLUGIN_OIDplus',
		131	'DISABLE_PLUGIN_ViaThinkSoft\OIDplus\OIDplus', $tmp);
		132
		133	if (@file_put_contents($config_file, $tmp) === false) {
		134	eval('?>'.$tmp);
		135	} else {
		136	include $config_file;
		137	}
		138	} else {
		139	include $config_file;
		140	}
263	daniel-mar	141	}
261	daniel-mar	142
1055	daniel-mar	143	// Backwards compatibility 2.0 => 2.1
261	daniel-mar	144	if (defined('OIDPLUS_CONFIG_VERSION') && (OIDPLUS_CONFIG_VERSION == 2.0)) {
1050	daniel-mar	145	self::$oldConfigFormatLoaded = true;
261	daniel-mar	146	foreach (get_defined_constants(true)['user'] as $name => $value) {
		147	$name = str_replace('OIDPLUS_', '', $name);
		148	if ($name == 'SESSION_SECRET') $name = 'SERVER_SECRET';
		149	if ($name == 'MYSQL_QUERYLOG') $name = 'QUERY_LOGFILE';
1050	daniel-mar	150	$name = str_replace('DISABLE_PLUGIN_OIDplusPagePublicRdap',
		151	'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicRdap', $name);
		152	$name = str_replace('DISABLE_PLUGIN_OIDplusPagePublicAltIds',
		153	'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicAltIds', $name);
1051	daniel-mar	154	$name = str_replace('DISABLE_PLUGIN_OIDplusPagePublicUITweaks',
		155	'DISABLE_PLUGIN_TushevOrg\OIDplus\OIDplusPagePublicUITweaks', $name);
1050	daniel-mar	156	$name = str_replace('DISABLE_PLUGIN_OIDplus',
		157	'DISABLE_PLUGIN_ViaThinkSoft\OIDplus\OIDplus', $name);
1055	daniel-mar	158	if ($name == 'CONFIG_VERSION') {
		159	$value = 2.1;
		160	} else if (($name == 'MYSQL_PASSWORD') \|\| ($name == 'ODBC_PASSWORD') \|\| ($name == 'PDO_PASSWORD') \|\| ($name == 'PGSQL_PASSWORD')) {
		161	$value = base64_decode($value);
261	daniel-mar	162	}
1055	daniel-mar	163	self::$baseConfig->setValue($name, $value);
261	daniel-mar	164	}
		165	}
		166	} else {
496	daniel-mar	167	if (!is_dir(OIDplus::localpath().'setup')) {
1050	daniel-mar	168	throw new OIDplusConfigInitializationException(_L('File %1 is missing, but setup can\'t be started because its directory missing.',$config_file));
261	daniel-mar	169	} else {
280	daniel-mar	170	if (self::$html) {
1055	daniel-mar	171	if (!self::insideSetup()) {
801	daniel-mar	172	header('Location:'.OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/');
360	daniel-mar	173	die(_L('Redirecting to setup...'));
349	daniel-mar	174	} else {
		175	return self::$baseConfig;
		176	}
261	daniel-mar	177	} else {
		178	// This can be displayed in e.g. ajax.php
1050	daniel-mar	179	throw new OIDplusConfigInitializationException(_L('File %1 is missing. Please run setup again.',$config_file));
261	daniel-mar	180	}
		181	}
		182	}
		183
		184	// Check important config settings
		185
263	daniel-mar	186	if (self::$baseConfig->getValue('CONFIG_VERSION') != 2.1) {
801	daniel-mar	187	if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/') !== 0) {
503	daniel-mar	188	throw new OIDplusConfigInitializationException(_L("The information located in %1 is outdated.",realpath($config_file)));
		189	}
261	daniel-mar	190	}
		191
263	daniel-mar	192	if (self::$baseConfig->getValue('SERVER_SECRET', '') === '') {
801	daniel-mar	193	if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/') !== 0) {
503	daniel-mar	194	throw new OIDplusConfigInitializationException(_L("You must set a value for SERVER_SECRET in %1 for the system to operate secure.",realpath($config_file)));
		195	}
261	daniel-mar	196	}
		197	}
		198
263	daniel-mar	199	return self::$baseConfig;
261	daniel-mar	200	}
		201
263	daniel-mar	202	private static $config = null;
2	daniel-mar	203	public static function config() {
263	daniel-mar	204	if ($first_init = is_null(self::$config)) {
		205	self::$config = new OIDplusConfig();
2	daniel-mar	206	}
263	daniel-mar	207
		208	if ($first_init) {
		209	// These are important settings for base functionalities and therefore are not inside plugins
		210	self::$config->prepareConfigKey('system_title', 'What is the name of your RA?', 'OIDplus 2.0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
		211	if (empty($value)) {
360	daniel-mar	212	throw new OIDplusException(_L('Please enter a value for the system title.'));
263	daniel-mar	213	}
		214	});
		215	self::$config->prepareConfigKey('admin_email', 'E-Mail address of the system administrator', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
		216	if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
360	daniel-mar	217	throw new OIDplusException(_L('This is not a correct email address'));
263	daniel-mar	218	}
		219	});
875	daniel-mar	220	self::$config->prepareConfigKey('global_cc', 'Global CC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function(&$value) {
		221	$value = trim($value);
		222	if ($value === '') return;
		223	$addrs = explode(';', $value);
		224	foreach ($addrs as $addr) {
		225	$addr = trim($addr);
		226	if (!empty($addr) && !OIDplus::mailUtils()->validMailAddress($addr)) {
		227	throw new OIDplusException(_L('%1 is not a correct email address',$addr));
		228	}
263	daniel-mar	229	}
		230	});
875	daniel-mar	231	self::$config->prepareConfigKey('global_bcc', 'Global BCC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function(&$value) {
		232	$value = trim($value);
		233	if ($value === '') return;
		234	$addrs = explode(';', $value);
		235	foreach ($addrs as $addr) {
		236	$addr = trim($addr);
		237	if (!empty($addr) && !OIDplus::mailUtils()->validMailAddress($addr)) {
		238	throw new OIDplusException(_L('%1 is not a correct email address',$addr));
		239	}
		240	}
		241	});
263	daniel-mar	242	self::$config->prepareConfigKey('objecttypes_initialized', 'List of object type plugins that were initialized once', '', OIDplusConfig::PROTECTION_READONLY, function($value) {
		243	// Nothing here yet
		244	});
		245	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) {
1050	daniel-mar	246	// 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?
263	daniel-mar	247
		248	$ary = explode(';',$value);
		249	$uniq_ary = array_unique($ary);
		250
		251	if (count($ary) != count($uniq_ary)) {
360	daniel-mar	252	throw new OIDplusException(_L('Please check your input. Some object types are double.'));
263	daniel-mar	253	}
		254
		255	foreach ($ary as $ot_check) {
		256	$ns_found = false;
		257	foreach (OIDplus::getEnabledObjectTypes() as $ot) {
		258	if ($ot::ns() == $ot_check) {
		259	$ns_found = true;
		260	break;
		261	}
		262	}
		263	foreach (OIDplus::getDisabledObjectTypes() as $ot) {
		264	if ($ot::ns() == $ot_check) {
		265	$ns_found = true;
		266	break;
		267	}
		268	}
		269	if (!$ns_found) {
360	daniel-mar	270	throw new OIDplusException(_L('Please check your input. Namespace "%1" is not found',$ot_check));
263	daniel-mar	271	}
		272	}
		273	});
		274	self::$config->prepareConfigKey('oidplus_private_key', 'Private key for this system', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
		275	// Nothing here yet
		276	});
		277	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) {
		278	// Nothing here yet
		279	});
324	daniel-mar	280	self::$config->prepareConfigKey('last_known_system_url', 'Last known System URL', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
		281	// Nothing here yet
		282	});
412	daniel-mar	283	self::$config->prepareConfigKey('last_known_version', 'Last known OIDplus Version', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
		284	// Nothing here yet
		285	});
635	daniel-mar	286	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	287	$good = true;
		288	if (strpos($value,'/') !== false) $good = false;
		289	if (strpos($value,'\\') !== false) $good = false;
		290	if (strpos($value,'..') !== false) $good = false;
		291	if (!$good) {
		292	throw new OIDplusException(_L('Invalid auth plugin folder name. Do only enter a folder name, not an absolute or relative path'));
		293	}
		294
926	daniel-mar	295	if (!wildcard_is_dir(OIDplus::localpath().'plugins/'.'*'.'/auth/'.$value)) {
635	daniel-mar	296	throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$value,'plugins/[vendorname]/auth/'));
453	daniel-mar	297	}
		298	});
263	daniel-mar	299	}
		300
		301	return self::$config;
2	daniel-mar	302	}
		303
263	daniel-mar	304	private static $gui = null;
2	daniel-mar	305	public static function gui() {
263	daniel-mar	306	if (is_null(self::$gui)) {
		307	self::$gui = new OIDplusGui();
86	daniel-mar	308	}
263	daniel-mar	309	return self::$gui;
2	daniel-mar	310	}
		311
263	daniel-mar	312	private static $authUtils = null;
2	daniel-mar	313	public static function authUtils() {
263	daniel-mar	314	if (is_null(self::$authUtils)) {
		315	self::$authUtils = new OIDplusAuthUtils();
86	daniel-mar	316	}
263	daniel-mar	317	return self::$authUtils;
2	daniel-mar	318	}
		319
263	daniel-mar	320	private static $mailUtils = null;
250	daniel-mar	321	public static function mailUtils() {
263	daniel-mar	322	if (is_null(self::$mailUtils)) {
		323	self::$mailUtils = new OIDplusMailUtils();
250	daniel-mar	324	}
263	daniel-mar	325	return self::$mailUtils;
250	daniel-mar	326	}
		327
557	daniel-mar	328	private static $cookieUtils = null;
		329	public static function cookieUtils() {
		330	if (is_null(self::$cookieUtils)) {
		331	self::$cookieUtils = new OIDplusCookieUtils();
		332	}
		333	return self::$cookieUtils;
		334	}
		335
263	daniel-mar	336	private static $menuUtils = null;
250	daniel-mar	337	public static function menuUtils() {
263	daniel-mar	338	if (is_null(self::$menuUtils)) {
		339	self::$menuUtils = new OIDplusMenuUtils();
250	daniel-mar	340	}
263	daniel-mar	341	return self::$menuUtils;
250	daniel-mar	342	}
		343
263	daniel-mar	344	private static $logger = null;
115	daniel-mar	345	public static function logger() {
263	daniel-mar	346	if (is_null(self::$logger)) {
		347	self::$logger = new OIDplusLogger();
115	daniel-mar	348	}
263	daniel-mar	349	return self::$logger;
115	daniel-mar	350	}
		351
1050	daniel-mar	352	// --- SQL slang plugin
274	daniel-mar	353
		354	private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) {
		355	$name = $plugin::id();
591	daniel-mar	356	if ($name === '') return false;
274	daniel-mar	357
449	daniel-mar	358	if (isset(self::$sqlSlangPlugins[$name])) {
451	daniel-mar	359	$plugintype_hf = _L('SQL slang');
592	daniel-mar	360	throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
449	daniel-mar	361	}
		362
274	daniel-mar	363	self::$sqlSlangPlugins[$name] = $plugin;
		364
		365	return true;
		366	}
		367
		368	public static function getSqlSlangPlugins() {
		369	return self::$sqlSlangPlugins;
		370	}
		371
318	daniel-mar	372	public static function getSqlSlangPlugin($id)/: ?OIDplusSqlSlangPlugin/ {
		373	if (isset(self::$sqlSlangPlugins[$id])) {
		374	return self::$sqlSlangPlugins[$id];
		375	} else {
		376	return null;
		377	}
		378	}
		379
1050	daniel-mar	380	// --- Database plugin
74	daniel-mar	381
227	daniel-mar	382	private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) {
275	daniel-mar	383	$name = $plugin::id();
591	daniel-mar	384	if ($name === '') return false;
150	daniel-mar	385
449	daniel-mar	386	if (isset(self::$dbPlugins[$name])) {
		387	$plugintype_hf = _L('Database');
592	daniel-mar	388	throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
449	daniel-mar	389	}
		390
150	daniel-mar	391	self::$dbPlugins[$name] = $plugin;
		392
		393	return true;
		394	}
		395
		396	public static function getDatabasePlugins() {
		397	return self::$dbPlugins;
		398	}
		399
295	daniel-mar	400	public static function getActiveDatabasePlugin() {
702	daniel-mar	401	$db_plugin_name = OIDplus::baseConfig()->getValue('DATABASE_PLUGIN','');
		402	if ($db_plugin_name === '') {
360	daniel-mar	403	throw new OIDplusConfigInitializationException(_L('No database plugin selected in config file'));
260	daniel-mar	404	}
1016	daniel-mar	405	foreach (self::$dbPlugins as $name => $plugin) {
		406	if (strtolower($name) == strtolower($db_plugin_name)) {
		407	return $plugin;
		408	}
227	daniel-mar	409	}
1016	daniel-mar	410	throw new OIDplusConfigInitializationException(_L('Database plugin "%1" not found',$db_plugin_name));
227	daniel-mar	411	}
		412
295	daniel-mar	413	private static $dbMainSession = null;
		414	public static function db() {
		415	if (is_null(self::$dbMainSession)) {
		416	self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
		417	}
		418	if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
		419	return self::$dbMainSession;
		420	}
		421
		422	private static $dbIsolatedSession = null;
		423	public static function dbIsolated() {
		424	if (is_null(self::$dbIsolatedSession)) {
		425	self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
		426	}
		427	if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
		428	return self::$dbIsolatedSession;
		429	}
		430
1050	daniel-mar	431	// --- CAPTCHA plugin
702	daniel-mar	432
		433	private static function registerCaptchaPlugin(OIDplusCaptchaPlugin $plugin) {
		434	$name = $plugin::id();
		435	if ($name === '') return false;
		436
		437	if (isset(self::$captchaPlugins[$name])) {
		438	$plugintype_hf = _L('CAPTCHA');
		439	throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
		440	}
		441
		442	self::$captchaPlugins[$name] = $plugin;
		443
		444	return true;
		445	}
		446
		447	public static function getCaptchaPlugins() {
		448	return self::$captchaPlugins;
		449	}
		450
704	daniel-mar	451	public static function getActiveCaptchaPluginId() {
702	daniel-mar	452	$captcha_plugin_name = OIDplus::baseConfig()->getValue('CAPTCHA_PLUGIN', '');
		453
		454	if (OIDplus::baseConfig()->getValue('RECAPTCHA_ENABLED', false) && ($captcha_plugin_name === '')) {
		455	// Legacy config file support!
1016	daniel-mar	456	$captcha_plugin_name = 'reCAPTCHA';
702	daniel-mar	457	}
		458
704	daniel-mar	459	if ($captcha_plugin_name === '') $captcha_plugin_name = 'None'; // the "None" plugin is a must-have!
702	daniel-mar	460
704	daniel-mar	461	return $captcha_plugin_name;
		462	}
		463
		464	public static function getActiveCaptchaPlugin() {
		465	$captcha_plugin_name = OIDplus::getActiveCaptchaPluginId();
1016	daniel-mar	466	foreach (self::$captchaPlugins as $name => $plugin) {
		467	if (strtolower($name) == strtolower($captcha_plugin_name)) {
		468	return $plugin;
		469	}
702	daniel-mar	470	}
1016	daniel-mar	471	throw new OIDplusConfigInitializationException(_L('CAPTCHA plugin "%1" not found',$captcha_plugin_name));
702	daniel-mar	472	}
		473
1050	daniel-mar	474	// --- Page plugin
227	daniel-mar	475
224	daniel-mar	476	private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
281	daniel-mar	477	self::$pagePlugins[] = $plugin;
61	daniel-mar	478
		479	return true;
		480	}
		481
281	daniel-mar	482	public static function getPagePlugins() {
		483	return self::$pagePlugins;
61	daniel-mar	484	}
		485
1050	daniel-mar	486	// --- Auth plugin
227	daniel-mar	487
		488	private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
456	daniel-mar	489	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		490	$password = generateRandomString(25);
459	daniel-mar	491
461	daniel-mar	492	try {
		493	$authInfo = $plugin->generate($password);
		494	} catch (OIDplusException $e) {
		495	// This can happen when the AuthKey or Salt is too long
		496	throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
		497	}
459	daniel-mar	498	$salt = $authInfo->getSalt();
461	daniel-mar	499	$authKey = $authInfo->getAuthKey();
459	daniel-mar	500
461	daniel-mar	501	$authInfo_SaltDiff = clone $authInfo;
		502	$authInfo_SaltDiff->setSalt(strrev($authInfo_SaltDiff->getSalt()));
		503
		504	$authInfo_AuthKeyDiff = clone $authInfo;
		505	$authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
		506
		507	if ((!$plugin->verify($authInfo,$password)) \|\|
		508	(!empty($salt) && $plugin->verify($authInfo_SaltDiff,$password)) \|\|
		509	($plugin->verify($authInfo_AuthKeyDiff,$password)) \|\|
		510	($plugin->verify($authInfo,$password.'x'))) {
456	daniel-mar	511	throw new OIDplusException(_L('Auth plugin "%1" is erroneous: Generate/Verify self test failed',basename($plugin->getPluginDirectory())));
		512	}
453	daniel-mar	513	}
		514
227	daniel-mar	515	self::$authPlugins[] = $plugin;
		516	return true;
		517	}
		518
221	daniel-mar	519	public static function getAuthPlugins() {
		520	return self::$authPlugins;
		521	}
		522
1050	daniel-mar	523	// --- Language plugin
355	daniel-mar	524
		525	private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
		526	self::$languagePlugins[] = $plugin;
		527	return true;
		528	}
		529
		530	public static function getLanguagePlugins() {
		531	return self::$languagePlugins;
		532	}
		533
1050	daniel-mar	534	// --- Design plugin
449	daniel-mar	535
		536	private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
		537	self::$designPlugins[] = $plugin;
		538	return true;
		539	}
		540
		541	public static function getDesignPlugins() {
		542	return self::$designPlugins;
		543	}
		544
819	daniel-mar	545	public static function getActiveDesignPlugin() {
		546	$plugins = OIDplus::getDesignPlugins();
		547	foreach ($plugins as $plugin) {
		548	if ((basename($plugin->getPluginDirectory())) == OIDplus::config()->getValue('design','default')) {
		549	return $plugin;
		550	}
		551	}
		552	return null;
		553	}
		554
1050	daniel-mar	555	// --- Logger plugin
289	daniel-mar	556
		557	private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
		558	self::$loggerPlugins[] = $plugin;
		559	return true;
		560	}
		561
		562	public static function getLoggerPlugins() {
		563	return self::$loggerPlugins;
		564	}
		565
1050	daniel-mar	566	// --- Object type plugin
227	daniel-mar	567
		568	private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
		569	self::$objectTypePlugins[] = $plugin;
		570
		571	$ot = $plugin::getObjectTypeClassName();
		572	self::registerObjectType($ot);
		573
		574	return true;
		575	}
		576
224	daniel-mar	577	private static function registerObjectType($ot) {
66	daniel-mar	578	$ns = $ot::ns();
860	daniel-mar	579	if (empty($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace must not be empty',$ot));
66	daniel-mar	580
860	daniel-mar	581	// Currently, we must enforce that namespaces in objectType plugins are lowercase, because prefilterQuery() makes all namespaces lowercase and the DBMS should be case-sensitive
		582	if ($ns != strtolower($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace %2 must be lower-case',$ot,$ns));
66	daniel-mar	583
860	daniel-mar	584	$root = $ot::root();
		585	if (!str_starts_with($root,$ns.':')) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Root node (%2) is in wrong namespace (needs starts with %3)!',$ot,$root,$ns.':'));
		586
66	daniel-mar	587	$ns_found = false;
227	daniel-mar	588	foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
66	daniel-mar	589	if ($test_ot::ns() == $ns) {
		590	$ns_found = true;
		591	break;
		592	}
		593	}
		594	if ($ns_found) {
360	daniel-mar	595	throw new OIDplusException(_L('Attention: Two objectType plugins use the same namespace "%1"!',$ns));
66	daniel-mar	596	}
		597
		598	$init = OIDplus::config()->getValue("objecttypes_initialized");
		599	$init_ary = empty($init) ? array() : explode(';', $init);
70	daniel-mar	600	$init_ary = array_map('trim', $init_ary);
66	daniel-mar	601
		602	$enabled = OIDplus::config()->getValue("objecttypes_enabled");
		603	$enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
70	daniel-mar	604	$enabled_ary = array_map('trim', $enabled_ary);
66	daniel-mar	605
79	daniel-mar	606	$do_enable = false;
		607	if (in_array($ns, $enabled_ary)) {
447	daniel-mar	608	// If it is in the list of enabled object types, it is enabled (obviously)
79	daniel-mar	609	$do_enable = true;
		610	} else {
447	daniel-mar	611	if (!OIDplus::config()->getValue('oobe_objects_done')) {
		612	// If the OOBE wizard is NOT done, then just enable the "oid" object type by default
79	daniel-mar	613	$do_enable = $ns == 'oid';
		614	} else {
447	daniel-mar	615	// If the OOBE wizard was done (once), then
		616	// we will enable all object types which were never initialized
		617	// (i.e. a plugin folder was freshly added)
79	daniel-mar	618	$do_enable = !in_array($ns, $init_ary);
		619	}
		620	}
		621
		622	if ($do_enable) {
227	daniel-mar	623	self::$enabledObjectTypes[] = $ot;
		624	usort(self::$enabledObjectTypes, function($a, $b) {
66	daniel-mar	625	$enabled = OIDplus::config()->getValue("objecttypes_enabled");
		626	$enabled_ary = explode(';', $enabled);
		627
		628	$idx_a = array_search($a::ns(), $enabled_ary);
		629	$idx_b = array_search($b::ns(), $enabled_ary);
		630
		631	if ($idx_a == $idx_b) {
		632	return 0;
		633	}
		634	return ($idx_a > $idx_b) ? +1 : -1;
		635	});
74	daniel-mar	636	} else {
		637	self::$disabledObjectTypes[] = $ot;
66	daniel-mar	638	}
		639
		640	if (!in_array($ns, $init_ary)) {
		641	// Was never initialized before, so we add it to the list of enabled object types once
		642
79	daniel-mar	643	if ($do_enable) {
		644	$enabled_ary[] = $ns;
672	daniel-mar	645	// Important: Don't validate the input, because the other object types might not be initialized yet! So use setValueNoCallback() instead setValue().
		646	OIDplus::config()->setValueNoCallback("objecttypes_enabled", implode(';', $enabled_ary));
79	daniel-mar	647	}
66	daniel-mar	648
		649	$init_ary[] = $ns;
		650	OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
		651	}
61	daniel-mar	652	}
		653
227	daniel-mar	654	public static function getObjectTypePlugins() {
		655	return self::$objectTypePlugins;
61	daniel-mar	656	}
		657
227	daniel-mar	658	public static function getObjectTypePluginsEnabled() {
		659	$res = array();
		660	foreach (self::$objectTypePlugins as $plugin) {
		661	$ot = $plugin::getObjectTypeClassName();
		662	if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
		663	}
		664	return $res;
74	daniel-mar	665	}
		666
227	daniel-mar	667	public static function getObjectTypePluginsDisabled() {
		668	$res = array();
		669	foreach (self::$objectTypePlugins as $plugin) {
		670	$ot = $plugin::getObjectTypeClassName();
		671	if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
74	daniel-mar	672	}
227	daniel-mar	673	return $res;
74	daniel-mar	674	}
		675
227	daniel-mar	676	public static function getEnabledObjectTypes() {
		677	return self::$enabledObjectTypes;
		678	}
74	daniel-mar	679
227	daniel-mar	680	public static function getDisabledObjectTypes() {
		681	return self::$disabledObjectTypes;
		682	}
74	daniel-mar	683
1050	daniel-mar	684	// --- Plugin handling functions
277	daniel-mar	685
320	daniel-mar	686	public static function getAllPlugins()/: array/ {
		687	$res = array();
		688	$res = array_merge($res, self::$pagePlugins);
		689	$res = array_merge($res, self::$authPlugins);
		690	$res = array_merge($res, self::$loggerPlugins);
		691	$res = array_merge($res, self::$objectTypePlugins);
		692	$res = array_merge($res, self::$dbPlugins);
702	daniel-mar	693	$res = array_merge($res, self::$captchaPlugins);
320	daniel-mar	694	$res = array_merge($res, self::$sqlSlangPlugins);
355	daniel-mar	695	$res = array_merge($res, self::$languagePlugins);
449	daniel-mar	696	$res = array_merge($res, self::$designPlugins);
320	daniel-mar	697	return $res;
		698	}
		699
321	daniel-mar	700	public static function getPluginByOid($oid)/: ?OIDplusPlugin/ {
320	daniel-mar	701	$plugins = self::getAllPlugins();
321	daniel-mar	702	foreach ($plugins as $plugin) {
		703	if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
		704	return $plugin;
320	daniel-mar	705	}
		706	}
		707	return null;
		708	}
		709
380	daniel-mar	710	public static function getPluginByClassName($classname)/: ?OIDplusPlugin/ {
		711	$plugins = self::getAllPlugins();
		712	foreach ($plugins as $plugin) {
		713	if (get_class($plugin) === $classname) {
		714	return $plugin;
		715	}
		716	}
		717	return null;
277	daniel-mar	718	}
		719
594	daniel-mar	720	/**
1050	daniel-mar	721	* Checks if the plugin is disabled
		722	* @return boolean true if plugin is enabled, false if plugin is disabled
		723	* @throws OIDplusException if the class name or config file (disabled setting) does not contain a namespace
		724	*/
		725	private static function pluginCheckDisabled($class_name): bool {
		726	$path = explode('\\', $class_name);
		727
		728	if (count($path) == 1) {
		729	throw new OIDplusException(_L('Plugin "%1" is erroneous',$class_name).': '._L('The plugin uses no namespaces. The new version of OIDplus requires plugin class files to be in a namespace. Please notify your plugin author and ask for an update.'));
		730	}
		731
		732	$class_end = end($path);
		733	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_end, false)) {
		734	throw new OIDplusConfigInitializationException(_L('Your base configuration file is outdated. Please change "%1" to "%2".','DISABLE_PLUGIN_'.$class_end,'DISABLE_PLUGIN_'.$class_name));
		735	}
		736
		737	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
		738	return false;
		739	}
		740
		741	return true;
		742	}
		743
		744	/**
594	daniel-mar	745	* @return array<OIDplusPluginManifest>\|array<string,array<string,OIDplusPluginManifest>>
		746	*/
693	daniel-mar	747	public static function getAllPluginManifests($pluginFolderMasks='*', $flat=true): array {
277	daniel-mar	748	$out = array();
279	daniel-mar	749	// Note: glob() will sort by default, so we do not need a page priority attribute.
		750	// So you just need to use a numeric plugin directory prefix (padded).
693	daniel-mar	751	$ary = array();
		752	foreach (explode(',',$pluginFolderMasks) as $pluginFolderMask) {
		753	$ary = array_merge($ary,glob(OIDplus::localpath().'plugins/'.''.'/'.$pluginFolderMask.'/'.''.'/manifest.xml'));
		754	}
646	daniel-mar	755
		756	// Sort the plugins by their type and name, as if they would be in a single vendor-folder!
		757	uasort($ary, function($a,$b) {
		758	if ($a == $b) return 0;
		759
		760	$ary = explode('/',$a);
		761	$bry = explode('/',$b);
		762
		763	// First sort by type (publicPage, auth, database, language, ...)
		764	$a_type = $ary[count($ary)-1-2];
		765	$b_type = $bry[count($bry)-1-2];
		766	if ($a_type < $b_type) return -1;
		767	if ($a_type > $b_type) return 1;
		768
		769	// Then sort by name (090_login, 100_whois, etc.)
		770	$a_name = $ary[count($ary)-1-1];
		771	$b_name = $bry[count($bry)-1-1];
		772	if ($a_name < $b_name) return -1;
		773	if ($a_name > $b_name) return 1;
		774
		775	// If it is still equal, then finally sort by vendorname
		776	$a_vendor = $ary[count($ary)-1-3];
		777	$b_vendor = $bry[count($bry)-1-3];
		778	if ($a_vendor < $b_vendor) return -1;
		779	if ($a_vendor > $b_vendor) return 1;
		780	return 0;
		781	});
		782
277	daniel-mar	783	foreach ($ary as $ini) {
		784	if (!file_exists($ini)) continue;
		785
307	daniel-mar	786	$manifest = new OIDplusPluginManifest();
		787	$manifest->loadManifest($ini);
277	daniel-mar	788
473	daniel-mar	789	$class_name = $manifest->getPhpMainClass();
1050	daniel-mar	790	if ($class_name) if (!self::pluginCheckDisabled($class_name)) continue;
473	daniel-mar	791
307	daniel-mar	792	if ($flat) {
		793	$out[] = $manifest;
		794	} else {
		795	$plugintype_folder = basename(dirname(dirname($ini)));
		796	$pluginname_folder = basename(dirname($ini));
		797
		798	if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
		799	if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
		800	$out[$plugintype_folder][$pluginname_folder] = $manifest;
		801	}
277	daniel-mar	802	}
		803	return $out;
		804	}
		805
594	daniel-mar	806	/**
		807	* @return array<string>
		808	*/
277	daniel-mar	809	public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
		810	$out = array();
525	daniel-mar	811	if (is_array($pluginDirName)) {
		812	$ary = array();
		813	foreach ($pluginDirName as $pluginDirName_) {
		814	$ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
		815	}
		816	} else {
		817	$ary = self::getAllPluginManifests($pluginDirName, false);
		818	}
320	daniel-mar	819	$known_plugin_oids = array();
456	daniel-mar	820	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		821	$fake_feature = uuid_to_oid(gen_uuid());
588	daniel-mar	822	} else {
		823	$fake_feature = null;
456	daniel-mar	824	}
277	daniel-mar	825	foreach ($ary as $plugintype_folder => $bry) {
438	daniel-mar	826	foreach ($bry as $pluginname_folder => $manifest) {
		827	$class_name = $manifest->getPhpMainClass();
		828
		829	// Before we load the plugin, we want to make some checks to confirm
		830	// that the plugin is working correctly.
		831
307	daniel-mar	832	if (!$class_name) {
1050	daniel-mar	833	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('Manifest does not declare a PHP main class'));
277	daniel-mar	834	}
1050	daniel-mar	835	if (!self::pluginCheckDisabled($class_name)) {
		836	continue; // Plugin is disabled
297	daniel-mar	837	}
1072	daniel-mar	838
		839	// Do some basic checks on the plugin PHP main class
292	daniel-mar	840	if (!class_exists($class_name)) {
1050	daniel-mar	841	throw new OIDplusException(_L('Plugin "%1" 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	842	}
279	daniel-mar	843	if (!is_subclass_of($class_name, $expectedPluginClass)) {
1050	daniel-mar	844	throw new OIDplusException(_L('Plugin "%1" 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	845	}
438	daniel-mar	846	if (($class_name!=$manifest->getTypeClass()) && (!is_subclass_of($class_name,$manifest->getTypeClass()))) {
1050	daniel-mar	847	throw new OIDplusException(_L('Plugin "%1" 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	848	}
438	daniel-mar	849	if (($manifest->getTypeClass()!=$expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(),$expectedPluginClass))) {
1050	daniel-mar	850	throw new OIDplusException(_L('Plugin "%1" 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	851	}
		852
1072	daniel-mar	853	// Do some basic checks on the plugin OID
438	daniel-mar	854	$plugin_oid = $manifest->getOid();
320	daniel-mar	855	if (!$plugin_oid) {
1050	daniel-mar	856	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('Does not have an OID'));
320	daniel-mar	857	}
		858	if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) {
1050	daniel-mar	859	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('Plugin OID "%1" is invalid (needs to be valid dot-notation)',$plugin_oid));
320	daniel-mar	860	}
		861	if (isset($known_plugin_oids[$plugin_oid])) {
1050	daniel-mar	862	throw new OIDplusException(_L('Plugin "%1" 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	863	}
646	daniel-mar	864
1072	daniel-mar	865	// Additional check: Are third-party plugins using ViaThinkSoft plugin folders, OIDs or class namespaces?
632	daniel-mar	866	$full_plugin_dir = dirname($manifest->getManifestFile());
		867	$full_plugin_dir = substr($full_plugin_dir, strlen(OIDplus::localpath()));
988	daniel-mar	868	$dir_is_viathinksoft = str_starts_with($full_plugin_dir, 'plugins/viathinksoft/') \|\| str_starts_with($full_plugin_dir, 'plugins\\viathinksoft\\');
		869	$oid_is_viathinksoft = str_starts_with($plugin_oid, '1.3.6.1.4.1.37476.2.5.2.4.'); // { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) 37476 products(2) oidplus(5) v2(2) plugins(4) }
1050	daniel-mar	870	$class_is_viathinksoft = str_starts_with($class_name, 'ViaThinkSoft\\');
1072	daniel-mar	871	if ($oid_is_viathinksoft != $class_is_viathinksoft) {
		872	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('Third-party plugins must not use the ViaThinkSoft PHP namespace. Please use your own vendor namespace.'));
		873	}
		874	$plugin_is_viathinksoft = $oid_is_viathinksoft && $class_is_viathinksoft;
		875	if ($dir_is_viathinksoft != $plugin_is_viathinksoft) {
1050	daniel-mar	876	throw new OIDplusException(_L('Plugin "%1" 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	877	}
1072	daniel-mar	878
		879	// Additional check: does the plugin define JS/CSS although it is not an interactive plugin type?
		880	$has_js = $manifest->getJSFiles();
		881	$has_css = $manifest->getCSSFiles();
		882	$is_interactive = in_array(basename($plugintype_folder), OIDplus::INTERACTIVE_PLUGIN_TYPES);
		883	$is_design = basename($plugintype_folder) === 'design';
		884	if (!$is_interactive && $has_js) {
		885	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('%1 files are included in the manifest XML, but this plugin type does not allow such files.','JavaScript'));
1050	daniel-mar	886	}
1072	daniel-mar	887	if (!$is_interactive && !$is_design && $has_css) {
		888	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('%1 files are included in the manifest XML, but this plugin type does not allow such files.','CSS'));
		889	}
320	daniel-mar	890
1072	daniel-mar	891	// Additional check: Check "Setup CSS" and "Setup JS" (Allowed for plugin types: database, captcha)
		892	$has_js_setup = $manifest->getJSFilesSetup();
		893	$has_css_setup = $manifest->getCSSFilesSetup();
		894	$is_database = basename($plugintype_folder) === 'database';
		895	$is_captcha = basename($plugintype_folder) === 'captcha';
		896	if (!$is_database && !$is_captcha && $has_js_setup) {
		897	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('%1 files are included in the manifest XML, but this plugin type does not allow such files.','Setup JavaScript'));
		898	}
		899	if (!$is_database && !$is_captcha && $has_css_setup) {
		900	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('%1 files are included in the manifest XML, but this plugin type does not allow such files.','Setup CSS'));
		901	}
632	daniel-mar	902
1072	daniel-mar	903	// Additional check: Are all CSS/JS files there?
		904	$tmp = $manifest->getManifestLinkedFiles();
		905	foreach ($tmp as $file) {
		906	if (!file_exists($file)) {
		907	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('File %1 was defined in manifest, but it is not existing',$file));
		908	}
		909	}
		910
		911	// For the next check, we need an instance of the object
438	daniel-mar	912	$obj = new $class_name();
456	daniel-mar	913
1072	daniel-mar	914	// Additional check: Does the plugin misuse implementsFeature()?
		915	// This is not enabled b default, because the GUID generation is slow on some machines.
		916	// Also, it is very unlikely that someone misuses implementsFeature().
456	daniel-mar	917	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		918	if ($obj->implementsFeature($fake_feature)) {
		919	// see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663
1050	daniel-mar	920	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('implementsFeature() always returns true'));
456	daniel-mar	921	}
438	daniel-mar	922	}
		923
		924	// Now we can continue
1072	daniel-mar	925	$known_plugin_oids[$plugin_oid] = $plugintype_folder.'/'.$pluginname_folder;
279	daniel-mar	926	$out[] = $class_name;
		927	if (!is_null($registerCallback)) {
438	daniel-mar	928	call_user_func($registerCallback, $obj);
444	daniel-mar	929
		930	// Alternative approaches:
		931	//$registerCallback[0]::{$registerCallback[1]}($obj);
		932	// or:
		933	//forward_static_call($registerCallback, $obj);
279	daniel-mar	934	}
277	daniel-mar	935	}
		936
		937	}
		938	return $out;
		939	}
		940
1050	daniel-mar	941	// --- Initialization of OIDplus
206	daniel-mar	942
374	daniel-mar	943	public static function init($html=true, $keepBaseConfig=true) {
236	daniel-mar	944	self::$html = $html;
		945
263	daniel-mar	946	// Reset internal state, so we can re-init verything if required
274	daniel-mar	947
263	daniel-mar	948	self::$config = null;
374	daniel-mar	949	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	950	self::$gui = null;
		951	self::$authUtils = null;
		952	self::$mailUtils = null;
		953	self::$menuUtils = null;
		954	self::$logger = null;
295	daniel-mar	955	self::$dbMainSession = null;
		956	self::$dbIsolatedSession = null;
263	daniel-mar	957	self::$pagePlugins = array();
		958	self::$authPlugins = array();
289	daniel-mar	959	self::$loggerPlugins = array();
263	daniel-mar	960	self::$objectTypePlugins = array();
		961	self::$enabledObjectTypes = array();
		962	self::$disabledObjectTypes = array();
		963	self::$dbPlugins = array();
702	daniel-mar	964	self::$captchaPlugins = array();
274	daniel-mar	965	self::$sqlSlangPlugins = array();
355	daniel-mar	966	self::$languagePlugins = array();
449	daniel-mar	967	self::$designPlugins = array();
263	daniel-mar	968	self::$system_id_cache = null;
		969	self::$sslAvailableCache = null;
468	daniel-mar	970	self::$translationArray = array();
74	daniel-mar	971
263	daniel-mar	972	// Continue...
		973
294	daniel-mar	974	OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
263	daniel-mar	975	// You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
		976
150	daniel-mar	977	// Register database types (highest priority)
		978
274	daniel-mar	979	// SQL slangs
		980
1050	daniel-mar	981	self::registerAllPlugins('sqlSlang', OIDplusSqlSlangPlugin::class, array(OIDplus::class,'registerSqlSlangPlugin'));
274	daniel-mar	982	foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
		983	$plugin->init($html);
		984	}
		985
		986	// Database providers
		987
1050	daniel-mar	988	self::registerAllPlugins('database', OIDplusDatabasePlugin::class, array(OIDplus::class,'registerDatabasePlugin'));
237	daniel-mar	989	foreach (OIDplus::getDatabasePlugins() as $plugin) {
		990	$plugin->init($html);
		991	}
		992
42	daniel-mar	993	// Do redirect stuff etc.
74	daniel-mar	994
230	daniel-mar	995	self::isSslAvailable(); // This function does automatic redirects
61	daniel-mar	996
263	daniel-mar	997	// Construct the configuration manager
66	daniel-mar	998
263	daniel-mar	999	OIDplus::config(); // During the construction, various system settings are prepared if required
66	daniel-mar	1000
74	daniel-mar	1001	// Initialize public / private keys
		1002
227	daniel-mar	1003	OIDplus::getPkiStatus(true);
74	daniel-mar	1004
237	daniel-mar	1005	// Register non-DB plugins
74	daniel-mar	1006
1050	daniel-mar	1007	self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), OIDplusPagePlugin::class, array(OIDplus::class,'registerPagePlugin'));
		1008	self::registerAllPlugins('auth', OIDplusAuthPlugin::class, array(OIDplus::class,'registerAuthPlugin'));
		1009	self::registerAllPlugins('logger', OIDplusLoggerPlugin::class, array(OIDplus::class,'registerLoggerPlugin'));
825	daniel-mar	1010	OIDplusLogger::reLogMissing(); // Some previous plugins might have tried to log. Repeat that now.
1050	daniel-mar	1011	self::registerAllPlugins('objectTypes', OIDplusObjectTypePlugin::class, array(OIDplus::class,'registerObjectTypePlugin'));
		1012	self::registerAllPlugins('language', OIDplusLanguagePlugin::class, array(OIDplus::class,'registerLanguagePlugin'));
		1013	self::registerAllPlugins('design', OIDplusDesignPlugin::class, array(OIDplus::class,'registerDesignPlugin'));
		1014	self::registerAllPlugins('captcha', OIDplusCaptchaPlugin::class, array(OIDplus::class,'registerCaptchaPlugin'));
150	daniel-mar	1015
237	daniel-mar	1016	// Initialize non-DB plugins
224	daniel-mar	1017
281	daniel-mar	1018	foreach (OIDplus::getPagePlugins() as $plugin) {
74	daniel-mar	1019	$plugin->init($html);
		1020	}
230	daniel-mar	1021	foreach (OIDplus::getAuthPlugins() as $plugin) {
		1022	$plugin->init($html);
		1023	}
289	daniel-mar	1024	foreach (OIDplus::getLoggerPlugins() as $plugin) {
		1025	$plugin->init($html);
		1026	}
230	daniel-mar	1027	foreach (OIDplus::getObjectTypePlugins() as $plugin) {
		1028	$plugin->init($html);
		1029	}
355	daniel-mar	1030	foreach (OIDplus::getLanguagePlugins() as $plugin) {
		1031	$plugin->init($html);
		1032	}
449	daniel-mar	1033	foreach (OIDplus::getDesignPlugins() as $plugin) {
		1034	$plugin->init($html);
		1035	}
778	daniel-mar	1036	foreach (OIDplus::getCaptchaPlugins() as $plugin) {
		1037	$plugin->init($html);
		1038	}
412	daniel-mar	1039
778	daniel-mar	1040	if (PHP_SAPI != 'cli') {
		1041
		1042	// Prepare some security related response headers (default values)
		1043
		1044	$content_language =
		1045	strtolower(substr(OIDplus::getCurrentLang(),0,2)) . '-' .
		1046	strtoupper(substr(OIDplus::getCurrentLang(),2,2)); // e.g. 'en-US'
		1047
		1048	$http_headers = array(
		1049	"X-Content-Type-Options" => "nosniff",
		1050	"X-XSS-Protection" => "1; mode=block",
		1051	"X-Frame-Options" => "SAMEORIGIN",
		1052	"Referrer-Policy" => array(
		1053	"no-referrer-when-downgrade"
		1054	),
		1055	"Cache-Control" => array(
		1056	"no-cache",
		1057	"no-store",
		1058	"must-revalidate"
		1059	),
		1060	"Pragma" => "no-cache",
		1061	"Content-Language" => $content_language,
		1062	"Expires" => "0",
		1063	"Content-Security-Policy" => array(
1001	daniel-mar	1064	// see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
		1065
		1066	// --- Fetch directives ---
		1067	"child-src" => array(
		1068	"'self'",
		1069	"blob:"
		1070	),
		1071	"connect-src" => array(
		1072	"'self'",
		1073	"blob:"
		1074	),
778	daniel-mar	1075	"default-src" => array(
		1076	"'self'",
		1077	"blob:",
		1078	"https://cdnjs.cloudflare.com/"
		1079	),
1001	daniel-mar	1080	"font-src" => array(
778	daniel-mar	1081	"'self'",
1001	daniel-mar	1082	"blob:"
778	daniel-mar	1083	),
1001	daniel-mar	1084	"frame-src" => array(
		1085	"'self'",
		1086	"blob:"
		1087	),
778	daniel-mar	1088	"img-src" => array(
1001	daniel-mar	1089	"blob:",
778	daniel-mar	1090	"data:",
		1091	"http:",
		1092	"https:"
		1093	),
1001	daniel-mar	1094	"manifest-src" => array(
		1095	"'self'",
		1096	"blob:"
		1097	),
		1098	"media-src" => array(
		1099	"'self'",
		1100	"blob:"
		1101	),
		1102	"object-src" => array(
		1103	"'none'"
		1104	),
		1105	"prefetch-src" => array(
		1106	"'self'",
		1107	"blob:"
		1108	),
778	daniel-mar	1109	"script-src" => array(
		1110	"'self'",
		1111	"'unsafe-inline'",
		1112	"'unsafe-eval'",
		1113	"blob:",
		1114	"https://cdnjs.cloudflare.com/",
		1115	"https://polyfill.io/"
		1116	),
1001	daniel-mar	1117	// script-src-elem not used
		1118	// script-src-attr not used
		1119	"style-src" => array(
		1120	"'self'",
		1121	"'unsafe-inline'",
		1122	"https://cdnjs.cloudflare.com/"
		1123	),
		1124	// style-src-elem not used
		1125	// style-src-attr not used
		1126	"worker-src" => array(
		1127	"'self'",
		1128	"blob:"
		1129	),
		1130
		1131	// --- Navigation directives ---
778	daniel-mar	1132	"frame-ancestors" => array(
		1133	"'none'"
		1134	),
		1135	)
		1136	);
		1137
780	daniel-mar	1138	// Give plugins the opportunity to manipulate/extend the headers
778	daniel-mar	1139
		1140	foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
		1141	$plugin->httpHeaderCheck($http_headers);
		1142	}
1015	daniel-mar	1143	//foreach (OIDplus::getDatabasePlugins() as $plugin) {
		1144	if ($plugin = OIDplus::getActiveDatabasePlugin()) {
778	daniel-mar	1145	$plugin->httpHeaderCheck($http_headers);
		1146	}
		1147	foreach (OIDplus::getPagePlugins() as $plugin) {
		1148	$plugin->httpHeaderCheck($http_headers);
		1149	}
		1150	foreach (OIDplus::getAuthPlugins() as $plugin) {
		1151	$plugin->httpHeaderCheck($http_headers);
		1152	}
		1153	foreach (OIDplus::getLoggerPlugins() as $plugin) {
		1154	$plugin->httpHeaderCheck($http_headers);
		1155	}
		1156	foreach (OIDplus::getObjectTypePlugins() as $plugin) {
		1157	$plugin->httpHeaderCheck($http_headers);
		1158	}
		1159	foreach (OIDplus::getLanguagePlugins() as $plugin) {
		1160	$plugin->httpHeaderCheck($http_headers);
		1161	}
		1162	foreach (OIDplus::getDesignPlugins() as $plugin) {
		1163	$plugin->httpHeaderCheck($http_headers);
		1164	}
1015	daniel-mar	1165	//foreach (OIDplus::getCaptchaPlugins() as $plugin) {
		1166	if ($plugin = OIDplus::getActiveCaptchaPlugin()) {
778	daniel-mar	1167	$plugin->httpHeaderCheck($http_headers);
		1168	}
		1169
		1170	// Prepare to send the headers to the client
		1171	// The headers are sent automatically when the first output comes or the script ends
		1172
		1173	foreach ($http_headers as $name => $val) {
		1174
		1175	// Plugins can remove standard OIDplus headers by setting the value to null.
		1176	if (is_null($val)) continue; /** @phpstan-ignore-line */
		1177
		1178	// Some headers can be written as arrays to make it easier for plugin authors
		1179	// to manipulate/extend the contents.
		1180	if (is_array($val)) {
		1181	if ((strtolower($name) == 'cache-control') \|\|
		1182	(strtolower($name) == 'referrer-policy'))
		1183	{
		1184	if (count($val) == 0) continue;
		1185	$val = implode(', ', $val);
		1186	} else if (strtolower($name) == 'content-security-policy') {
		1187	if (count($val) == 0) continue;
780	daniel-mar	1188	foreach ($val as $tmp1 => &$tmp2) {
		1189	$tmp2 = array_unique($tmp2);
		1190	$tmp2 = $tmp1.' '.implode(' ', $tmp2);
		1191	}
778	daniel-mar	1192	$val = implode('; ', $val);
		1193	} else {
779	daniel-mar	1194	throw new OIDplusException(_L('HTTP header "%1" cannot be written as array. A newly installed plugin is probably misusing the method "%2".',$name,'httpHeaderCheck'));
778	daniel-mar	1195	}
		1196	}
		1197
		1198	if (is_string($val)) {
		1199	header("$name: $val");
		1200	}
		1201	}
		1202
		1203	} // endif (PHP_SAPI != 'cli')
		1204
412	daniel-mar	1205	// Initialize other stuff (i.e. things which require the logger!)
		1206
		1207	OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
		1208	OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
2	daniel-mar	1209	}
42	daniel-mar	1210
1050	daniel-mar	1211	// --- System URL, System ID, PKI, and other functions
227	daniel-mar	1212
412	daniel-mar	1213	private static function recognizeSystemUrl() {
		1214	try {
1072	daniel-mar	1215	$url = OIDplus::webpath(null,self::PATH_ABSOLUTE_CANONICAL);
412	daniel-mar	1216	OIDplus::config()->setValue('last_known_system_url', $url);
1050	daniel-mar	1217	} catch (\Exception $e) {
412	daniel-mar	1218	}
		1219	}
497	daniel-mar	1220
496	daniel-mar	1221	private static function getExecutingScriptPathDepth() {
		1222	if (PHP_SAPI == 'cli') {
		1223	global $argv;
		1224	$test_dir = dirname(realpath($argv[0]));
		1225	} else {
		1226	if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
		1227	$test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
		1228	}
		1229	$test_dir = str_replace('\\', '/', $test_dir);
		1230	$steps_up = 0;
928	daniel-mar	1231	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 subordinate directory!
496	daniel-mar	1232	$test_dir = dirname($test_dir);
		1233	$steps_up++;
		1234	if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
		1235	}
		1236	return $steps_up;
		1237	}
632	daniel-mar	1238
580	daniel-mar	1239	public static function isSSL() {
		1240	return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
		1241	}
412	daniel-mar	1242
806	daniel-mar	1243	/**
		1244	* Returns the URL of the system.
		1245	* @param int $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
		1246	* PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
		1247	* results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
		1248	* but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
		1249	* @return string\|false The URL, with guaranteed trailing path delimiter for directories
		1250	*/
801	daniel-mar	1251	private static function getSystemUrl($mode) {
806	daniel-mar	1252	if ($mode === self::PATH_RELATIVE) {
778	daniel-mar	1253	$steps_up = self::getExecutingScriptPathDepth();
		1254	if ($steps_up === false) {
		1255	return false;
		1256	} else {
		1257	return str_repeat('../', $steps_up);
		1258	}
		1259	} else {
806	daniel-mar	1260	if ($mode === self::PATH_ABSOLUTE_CANONICAL) {
		1261	$tmp = OIDplus::baseConfig()->getValue('CANONICAL_SYSTEM_URL', '');
		1262	if ($tmp) {
		1263	return rtrim($tmp,'/').'/';
		1264	}
326	daniel-mar	1265	}
778	daniel-mar	1266
495	daniel-mar	1267	if (PHP_SAPI == 'cli') {
494	daniel-mar	1268	try {
		1269	return OIDplus::config()->getValue('last_known_system_url', false);
1050	daniel-mar	1270	} catch (\Exception $e) {
494	daniel-mar	1271	return false;
		1272	}
778	daniel-mar	1273	} else {
		1274	// First, try to find out how many levels we need to go up
		1275	$steps_up = self::getExecutingScriptPathDepth();
326	daniel-mar	1276
778	daniel-mar	1277	// Then go up these amount of levels, based on SCRIPT_NAME/argv[0]
		1278	$res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
		1279	for ($i=0; $i<$steps_up; $i++) {
		1280	$res = dirname($res);
		1281	}
		1282	$res = str_replace('\\', '/', $res);
		1283	if ($res == '/') $res = '';
227	daniel-mar	1284
778	daniel-mar	1285	// Add protocol and hostname
580	daniel-mar	1286	$is_ssl = self::isSSL();
495	daniel-mar	1287	$protocol = $is_ssl ? 'https' : 'http'; // do not translate
		1288	$host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
778	daniel-mar	1289
		1290	return $protocol.'://'.$host.$res.'/';
495	daniel-mar	1291	}
227	daniel-mar	1292	}
		1293	}
		1294
1073	daniel-mar	1295	private static function pubKeyToRaw($pubKey) {
827	daniel-mar	1296	$m = array();
1073	daniel-mar	1297	if (preg_match('@BEGIN PUBLIC KEY\\-+([^\\-]+)\\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
		1298	return base64_decode($m[1], false);
827	daniel-mar	1299	}
		1300	return false;
		1301	}
		1302
1073	daniel-mar	1303	private static function getSystemIdFromPubKey($pubKey) {
		1304	$rawData = self::pubKeyToRaw($pubKey);
		1305	if ($rawData === false) return false;
		1306	return smallhash($rawData);
		1307	}
		1308
		1309	private static function getSystemGuidFromPubKey($pubKey) {
		1310	$rawData = self::pubKeyToRaw($pubKey);
		1311	if ($rawData === false) return false;
		1312	$normalizedBase64 = base64_encode($rawData);
		1313	return gen_uuid_sha1_namebased(self::UUID_NAMEBASED_NS_Base64PubKey, $normalizedBase64);
		1314	}
		1315
227	daniel-mar	1316	private static $system_id_cache = null;
		1317	public static function getSystemId($oid=false) {
		1318	if (!is_null(self::$system_id_cache)) {
		1319	$out = self::$system_id_cache;
		1320	} else {
		1321	$out = false;
		1322
		1323	if (self::getPkiStatus(true)) {
830	daniel-mar	1324	$pubKey = OIDplus::getSystemPublicKey();
827	daniel-mar	1325	$out = self::getSystemIdFromPubKey($pubKey);
227	daniel-mar	1326	}
		1327	self::$system_id_cache = $out;
		1328	}
350	daniel-mar	1329	if (!$out) return false;
291	daniel-mar	1330	return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
227	daniel-mar	1331	}
		1332
1073	daniel-mar	1333	private static $system_guid_cache = null;
		1334	public static function getSystemGuid() {
		1335	if (!is_null(self::$system_guid_cache)) {
		1336	$out = self::$system_guid_cache;
		1337	} else {
		1338	$out = false;
		1339
		1340	if (self::getPkiStatus(true)) {
		1341	$pubKey = OIDplus::getSystemPublicKey();
		1342	$out = self::getSystemGuidFromPubKey($pubKey);
		1343	}
		1344	self::$system_guid_cache = $out;
		1345	}
		1346	if (!$out) return false;
		1347	return $out;
		1348	}
		1349
825	daniel-mar	1350	public static function getOpenSslCnf() {
		1351	// The following functions need a config file, otherway they don't work
		1352	// - openssl_csr_new
		1353	// - openssl_csr_sign
		1354	// - openssl_pkey_export
		1355	// - openssl_pkey_export_to_file
		1356	// - openssl_pkey_new
		1357	$tmp = @getenv('OPENSSL_CONF');
		1358	if ($tmp && file_exists($tmp)) return $tmp;
		1359
		1360	// OpenSSL in XAMPP does not work OOBE, since the OPENSSL_CONF is
		1361	// C:/xampp/apache/bin/openssl.cnf and not C:/xampp/apache/conf/openssl.cnf
		1362	// Bug reports are more than 10 years old and nobody cares...
		1363	// Use our own config file
		1364	return __DIR__.'/../../vendor/phpseclib/phpseclib/phpseclib/openssl.cnf';
		1365	}
		1366
830	daniel-mar	1367	private static function getPrivKeyPassphraseFilename() {
		1368	return OIDplus::localpath() . 'userdata/privkey_secret.php';
		1369	}
227	daniel-mar	1370
830	daniel-mar	1371	private static function tryCreatePrivKeyPassphrase() {
		1372	$file = self::getPrivKeyPassphraseFilename();
827	daniel-mar	1373
830	daniel-mar	1374	$passphrase = generateRandomString(64);
		1375	$cont = "<?php\n";
		1376	$cont .= "// ATTENTION! This file was automatically generated by OIDplus to encrypt the private key\n";
		1377	$cont .= "// that is located in your database configuration table. DO NOT ALTER OR DELETE THIS FILE,\n";
		1378	$cont .= "// otherwise you will lose your OIDplus System-ID and all services connected with it!\n";
831	daniel-mar	1379	$cont .= "// If multiple systems access the same database, then this file must be synchronous\n";
		1380	$cont .= "// between all systems, otherwise you will lose your system ID, too!\n";
830	daniel-mar	1381	$cont .= "\$passphrase = '$passphrase';\n";
		1382	$cont .= "// End of file\n";
		1383
		1384	@file_put_contents($file, $cont);
		1385	}
		1386
		1387	private static function getPrivKeyPassphrase() {
		1388	$file = self::getPrivKeyPassphraseFilename();
		1389	if (!file_exists($file)) return false;
		1390	$cont = file_get_contents($file);
		1391	$m = array();
		1392	if (!preg_match("@'(.+)'@isU", $cont, $m)) return false;
		1393	return $m[1];
		1394	}
		1395
		1396	public static function getSystemPrivateKey() {
227	daniel-mar	1397	$privKey = OIDplus::config()->getValue('oidplus_private_key');
830	daniel-mar	1398	if ($privKey == '') return false;
		1399
		1400	$passphrase = self::getPrivKeyPassphrase();
		1401	if ($passphrase !== false) {
		1402	$privKey = decrypt_private_key($privKey, $passphrase);
		1403	}
		1404
		1405	if (is_privatekey_encrypted($privKey)) {
		1406	// This can happen if the key file has vanished
		1407	return false;
		1408	}
		1409
		1410	return $privKey;
		1411	}
		1412
		1413	public static function getSystemPublicKey() {
227	daniel-mar	1414	$pubKey = OIDplus::config()->getValue('oidplus_public_key');
830	daniel-mar	1415	if ($pubKey == '') return false;
		1416	return $pubKey;
		1417	}
227	daniel-mar	1418
830	daniel-mar	1419	public static function getPkiStatus($try_generate=false) {
		1420	if (!function_exists('openssl_pkey_new')) return false;
227	daniel-mar	1421
830	daniel-mar	1422	if ($try_generate) {
		1423	// For debug purposes: Invalidate current key once:
		1424	//OIDplus::config()->setValue('oidplus_private_key', '');
256	daniel-mar	1425
830	daniel-mar	1426	$privKey = OIDplus::getSystemPrivateKey();
		1427	$pubKey = OIDplus::getSystemPublicKey();
		1428	if (!verify_private_public_key($privKey, $pubKey)) {
		1429	if ($pubKey) {
		1430	OIDplus::logger()->log("[WARN]A!", "The private/public key-pair is broken. A new key-pair will now be generated for your system. Your System-ID will change.");
		1431	}
227	daniel-mar	1432
830	daniel-mar	1433	$pkey_config = array(
		1434	"digest_alg" => "sha512",
		1435	"private_key_bits" => defined('OPENSSL_SUPPLEMENT') ? 1024 : 2048, // openssl_supplement.inc.php is based on phpseclib, which is very slow. So we use 1024 bits instead of 2048 bits
		1436	"private_key_type" => OPENSSL_KEYTYPE_RSA,
		1437	"config" => OIDplus::getOpenSslCnf()
		1438	);
227	daniel-mar	1439
830	daniel-mar	1440	// Create the private and public key
		1441	$res = openssl_pkey_new($pkey_config);
		1442	if ($res === false) return false;
239	daniel-mar	1443
830	daniel-mar	1444	// Extract the private key from $res to $privKey
		1445	if (openssl_pkey_export($res, $privKey, null, $pkey_config) === false) return false;
227	daniel-mar	1446
830	daniel-mar	1447	// Extract the public key from $res to $pubKey
		1448	$tmp = openssl_pkey_get_details($res);
		1449	if ($tmp === false) return false;
		1450	$pubKey = $tmp["key"];
		1451
		1452	// encrypt new keys using a passphrase stored in a secret file
		1453	self::tryCreatePrivKeyPassphrase(); // try (re)generate this file
		1454	$passphrase = self::getPrivKeyPassphrase();
		1455	if ($passphrase !== false) {
		1456	$privKey = encrypt_private_key($privKey, $passphrase);
		1457	}
		1458
		1459	// Calculate the system ID from the public key
		1460	$system_id = self::getSystemIdFromPubKey($pubKey);
		1461	if ($system_id !== false) {
		1462	// Save the key pair to database
		1463	OIDplus::config()->setValue('oidplus_private_key', $privKey);
		1464	OIDplus::config()->setValue('oidplus_public_key', $pubKey);
		1465
		1466	// Log the new system ID
		1467	OIDplus::logger()->log("[INFO]A!", "A new private/public key-pair for your system had been generated. Your SystemID is now $system_id");
		1468	}
		1469	} else {
		1470	$passphrase = self::getPrivKeyPassphrase();
831	daniel-mar	1471	$rawPrivKey = OIDplus::config()->getValue('oidplus_private_key');
		1472	if (($passphrase === false) \|\| !is_privatekey_encrypted($rawPrivKey)) {
830	daniel-mar	1473	// Upgrade to new encrypted keys
		1474	self::tryCreatePrivKeyPassphrase(); // try generate this file
		1475	$passphrase = self::getPrivKeyPassphrase();
		1476	if ($passphrase !== false) {
		1477	$privKey = encrypt_private_key($privKey, $passphrase);
		1478	OIDplus::logger()->log("[INFO]A!", "The private/public key-pair has been upgraded to an encrypted key-pair. The key is saved in ".self::getPrivKeyPassphraseFilename());
		1479	OIDplus::config()->setValue('oidplus_private_key', $privKey);
		1480	}
		1481	}
227	daniel-mar	1482	}
		1483	}
		1484
830	daniel-mar	1485	$privKey = OIDplus::getSystemPrivateKey();
		1486	$pubKey = OIDplus::getSystemPublicKey();
227	daniel-mar	1487	return verify_private_public_key($privKey, $pubKey);
		1488	}
		1489
170	daniel-mar	1490	public static function getInstallType() {
486	daniel-mar	1491	$counter = 0;
		1492
661	daniel-mar	1493	if ($new_version_file_exists = file_exists(OIDplus::localpath().'.version.php')) {
486	daniel-mar	1494	$counter++;
591	daniel-mar	1495	}
661	daniel-mar	1496	if ($old_version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) {
		1497	$counter++;
		1498	}
		1499	$version_file_exists = $old_version_file_exists \| $new_version_file_exists;
681	daniel-mar	1500	if ($svn_dir_exists = (is_dir(OIDplus::localpath().'.svn') \|\|
		1501	is_dir(OIDplus::localpath().'../.svn'))) { // in case we checked out the root instead of the "trunk"
486	daniel-mar	1502	$counter++;
591	daniel-mar	1503	}
681	daniel-mar	1504	// if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) {
698	daniel-mar	1505	if ($git_dir_exists = (OIDplus::findGitFolder() !== false)) {
486	daniel-mar	1506	$counter++;
591	daniel-mar	1507	}
486	daniel-mar	1508
		1509	if ($counter === 0) {
360	daniel-mar	1510	return 'unknown'; // do not translate
170	daniel-mar	1511	}
591	daniel-mar	1512	else if ($counter > 1) {
360	daniel-mar	1513	return 'ambigous'; // do not translate
170	daniel-mar	1514	}
591	daniel-mar	1515	else if ($svn_dir_exists) {
360	daniel-mar	1516	return 'svn-wc'; // do not translate
170	daniel-mar	1517	}
591	daniel-mar	1518	else if ($git_dir_exists) {
486	daniel-mar	1519	return 'git-wc'; // do not translate
		1520	}
591	daniel-mar	1521	else if ($version_file_exists) {
360	daniel-mar	1522	return 'svn-snapshot'; // do not translate
170	daniel-mar	1523	}
		1524	}
		1525
412	daniel-mar	1526	private static function recognizeVersion() {
		1527	try {
		1528	$ver_prev = OIDplus::config()->getValue("last_known_version");
		1529	$ver_now = OIDplus::getVersion();
		1530	if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
455	daniel-mar	1531	// TODO: Problem: When the system was updated using SVN, then the IP address of the next random visitor of the website is logged!
1072	daniel-mar	1532	OIDplus::logger()->log("[INFO]A!", "Detected system version change from '$ver_prev' to '$ver_now'");
856	daniel-mar	1533
		1534	// Just to be sure, recanonize objects (we don't do it at every page visit due to performance reasons)
857	daniel-mar	1535	self::recanonizeObjects();
412	daniel-mar	1536	}
		1537	OIDplus::config()->setValue("last_known_version", $ver_now);
1050	daniel-mar	1538	} catch (\Exception $e) {
412	daniel-mar	1539	}
		1540	}
		1541
111	daniel-mar	1542	public static function getVersion() {
412	daniel-mar	1543	static $cachedVersion = null;
		1544	if (!is_null($cachedVersion)) {
		1545	return $cachedVersion;
		1546	}
		1547
486	daniel-mar	1548	$installType = OIDplus::getInstallType();
		1549
		1550	if ($installType === 'svn-wc') {
496	daniel-mar	1551	$ver = get_svn_revision(OIDplus::localpath());
486	daniel-mar	1552	if ($ver)
		1553	return ($cachedVersion = 'svn-'.$ver);
558	daniel-mar	1554	$ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk"
		1555	if ($ver)
		1556	return ($cachedVersion = 'svn-'.$ver);
111	daniel-mar	1557	}
162	daniel-mar	1558
486	daniel-mar	1559	if ($installType === 'git-wc') {
698	daniel-mar	1560	$ver = OIDplus::getGitsvnRevision(OIDplus::localpath());
486	daniel-mar	1561	if ($ver)
		1562	return ($cachedVersion = 'svn-'.$ver);
162	daniel-mar	1563	}
		1564
486	daniel-mar	1565	if ($installType === 'svn-snapshot') {
661	daniel-mar	1566	$cont = '';
		1567	if (file_exists($filename = OIDplus::localpath().'oidplus_version.txt'))
		1568	$cont = file_get_contents($filename);
		1569	if (file_exists($filename = OIDplus::localpath().'.version.php'))
		1570	$cont = file_get_contents($filename);
386	daniel-mar	1571	$m = array();
360	daniel-mar	1572	if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
412	daniel-mar	1573	return ($cachedVersion = 'svn-'.$m[1]); // do not translate
162	daniel-mar	1574	}
		1575
486	daniel-mar	1576	return ($cachedVersion = false); // version ambigous or unknown
111	daniel-mar	1577	}
		1578
974	daniel-mar	1579	const ENFORCE_SSL_NO = 0;
		1580	const ENFORCE_SSL_YES = 1;
		1581	const ENFORCE_SSL_AUTO = 2;
230	daniel-mar	1582	private static $sslAvailableCache = null;
		1583	public static function isSslAvailable() {
		1584	if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
256	daniel-mar	1585
495	daniel-mar	1586	if (PHP_SAPI == 'cli') {
230	daniel-mar	1587	self::$sslAvailableCache = false;
		1588	return false;
		1589	}
		1590
49	daniel-mar	1591	$timeout = 2;
580	daniel-mar	1592	$already_ssl = self::isSSL();
80	daniel-mar	1593	$ssl_port = 443;
1059	daniel-mar	1594	$host_with_port = $_SERVER['HTTP_HOST'];
		1595	$host_no_port = explode(':',$host_with_port)[0];
		1596	$host_ssl = $host_no_port . ($ssl_port != 443 ? ':'.$ssl_port : '');
42	daniel-mar	1597
974	daniel-mar	1598	if ($already_ssl) {
1059	daniel-mar	1599	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, true/allowJS/, null/samesite/, true/forceInsecure/);
974	daniel-mar	1600	self::$sslAvailableCache = true;
		1601	return true;
		1602	} else {
		1603	if (isset($_COOKIE['SSL_CHECK']) && ($_COOKIE['SSL_CHECK'] == '1')) {
		1604	// The cookie "SSL_CHECK" is set once a website was loaded with HTTPS.
		1605	// It forces subsequent HTTP calls to redirect to HTTPS (like HSTS).
		1606	// The reason is the following problem:
		1607	// If you open the page with HTTPS first, then the CSRF token cookies will get the "secure" flag
		1608	// If you open the page then with HTTP, the HTTP cannot access the secure CSRF cookies,
		1609	// Chrome will then block "Set-Cookie" since the HTTP cookie would overwrite the HTTPS cookie.
1059	daniel-mar	1610	// So we MUST redirect, even if the Mode is ENFORCE_SSL_NO.
974	daniel-mar	1611	// Note: SSL_CHECK is NOT a replacement for HSTS! You should use HSTS,
1059	daniel-mar	1612	// because on there your browser ensures that HTTPS is called, before the server
		1613	// is even contacted (and therefore, no HTTP connection can be hacked).
974	daniel-mar	1614	$mode = OIDplus::ENFORCE_SSL_YES;
		1615	} else {
		1616	$mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', OIDplus::ENFORCE_SSL_AUTO);
		1617	}
261	daniel-mar	1618
974	daniel-mar	1619	if ($mode == OIDplus::ENFORCE_SSL_NO) {
		1620	// No SSL available
		1621	self::$sslAvailableCache = false;
		1622	return false;
		1623	} else if ($mode == OIDplus::ENFORCE_SSL_YES) {
		1624	// Force SSL
1059	daniel-mar	1625	$location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
80	daniel-mar	1626	header('Location:'.$location);
360	daniel-mar	1627	die(_L('Redirecting to HTTPS...'));
974	daniel-mar	1628	} else if ($mode == OIDplus::ENFORCE_SSL_AUTO) {
		1629	// Automatic SSL detection
80	daniel-mar	1630	if (isset($_COOKIE['SSL_CHECK'])) {
		1631	// We already had the HTTPS detection done before.
974	daniel-mar	1632	if ($_COOKIE['SSL_CHECK'] == '1') {
80	daniel-mar	1633	// HTTPS was detected before, but we are HTTP. Redirect now
1059	daniel-mar	1634	$location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
80	daniel-mar	1635	header('Location:'.$location);
360	daniel-mar	1636	die(_L('Redirecting to HTTPS...'));
80	daniel-mar	1637	} else {
		1638	// No HTTPS available. Do nothing.
230	daniel-mar	1639	self::$sslAvailableCache = false;
80	daniel-mar	1640	return false;
		1641	}
49	daniel-mar	1642	} else {
80	daniel-mar	1643	// This is our first check (or the browser didn't accept the SSL_CHECK cookie)
386	daniel-mar	1644	$errno = -1;
		1645	$errstr = '';
1059	daniel-mar	1646	if (@fsockopen($host_no_port, $ssl_port, $errno, $errstr, $timeout)) {
80	daniel-mar	1647	// HTTPS detected. Redirect now, and remember that we had detected HTTPS
1059	daniel-mar	1648	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, true/allowJS/, null/samesite/, true/forceInsecure/);
		1649	$location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
80	daniel-mar	1650	header('Location:'.$location);
360	daniel-mar	1651	die(_L('Redirecting to HTTPS...'));
80	daniel-mar	1652	} else {
		1653	// No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
1059	daniel-mar	1654	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, true/allowJS/, null/samesite/, true/forceInsecure/);
230	daniel-mar	1655	self::$sslAvailableCache = false;
80	daniel-mar	1656	return false;
		1657	}
49	daniel-mar	1658	}
42	daniel-mar	1659	}
		1660	}
		1661	}
497	daniel-mar	1662
496	daniel-mar	1663	/**
		1664	* Gets a local path pointing to a resource
		1665	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
		1666	* @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
590	daniel-mar	1667	* @return string\|false The local path, with guaranteed trailing path delimiter for directories
496	daniel-mar	1668	*/
		1669	public static function localpath($target=null, $relative=false) {
		1670	if (is_null($target)) {
		1671	$target = __DIR__.'/../../';
		1672	}
241	daniel-mar	1673
496	daniel-mar	1674	if ($relative) {
		1675	// First, try to find out how many levels we need to go up
		1676	$steps_up = self::getExecutingScriptPathDepth();
		1677	if ($steps_up === false) return false;
497	daniel-mar	1678
496	daniel-mar	1679	// Virtually go back from the executing PHP script to the OIDplus base path
		1680	$res = str_repeat('../',$steps_up);
497	daniel-mar	1681
496	daniel-mar	1682	// Then go to the desired location
		1683	$basedir = realpath(__DIR__.'/../../');
		1684	$target = realpath($target);
500	daniel-mar	1685	if ($target === false) return false;
496	daniel-mar	1686	$res .= substr($target, strlen($basedir)+1);
		1687	$res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
		1688	} else {
		1689	$res = realpath($target);
241	daniel-mar	1690	}
497	daniel-mar	1691
801	daniel-mar	1692	if (is_dir($target)) $res .= '/';
497	daniel-mar	1693
801	daniel-mar	1694	$res = str_replace('/', DIRECTORY_SEPARATOR, $res);
		1695
496	daniel-mar	1696	return $res;
241	daniel-mar	1697	}
355	daniel-mar	1698
496	daniel-mar	1699	/**
		1700	* Gets a URL pointing to a resource
		1701	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
806	daniel-mar	1702	* @param int\|boolean $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
		1703	* PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
		1704	* results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
		1705	* but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
590	daniel-mar	1706	* @return string\|false The URL, with guaranteed trailing path delimiter for directories
496	daniel-mar	1707	*/
806	daniel-mar	1708	public static function webpath($target=null, $mode=self::PATH_ABSOLUTE_CANONICAL) {
801	daniel-mar	1709	// backwards compatibility
		1710	if ($mode === true) $mode = self::PATH_RELATIVE;
		1711	if ($mode === false) $mode = self::PATH_ABSOLUTE;
		1712
811	daniel-mar	1713	if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT) {
812	daniel-mar	1714	$tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE);
		1715	if ($tmp === false) return false;
		1716	$tmp = parse_url($tmp);
		1717	if ($tmp === false) return false;
		1718	if (!isset($tmp['path'])) return false;
		1719	return $tmp['path'];
811	daniel-mar	1720	}
		1721
812	daniel-mar	1722	if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT_CANONICAL) {
		1723	$tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE_CANONICAL);
		1724	if ($tmp === false) return false;
		1725	$tmp = parse_url($tmp);
		1726	if ($tmp === false) return false;
		1727	if (!isset($tmp['path'])) return false;
		1728	return $tmp['path'];
		1729	}
		1730
801	daniel-mar	1731	$res = self::getSystemUrl($mode); // Note: already contains a trailing path delimiter
778	daniel-mar	1732	if ($res === false) return false;
497	daniel-mar	1733
496	daniel-mar	1734	if (!is_null($target)) {
		1735	$basedir = realpath(__DIR__.'/../../');
		1736	$target = realpath($target);
500	daniel-mar	1737	if ($target === false) return false;
496	daniel-mar	1738	$tmp = substr($target, strlen($basedir)+1);
500	daniel-mar	1739	$res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
497	daniel-mar	1740	if (is_dir($target)) $res .= '/';
496	daniel-mar	1741	}
497	daniel-mar	1742
496	daniel-mar	1743	return $res;
		1744	}
497	daniel-mar	1745
778	daniel-mar	1746	public static function canonicalURL() {
		1747	// First part: OIDplus system URL (or canonical system URL)
801	daniel-mar	1748	$sysurl = OIDplus::getSystemUrl(self::PATH_ABSOLUTE_CANONICAL);
778	daniel-mar	1749
		1750	// Second part: Directory
		1751	$basedir = realpath(__DIR__.'/../../');
		1752	$target = realpath('.');
		1753	if ($target === false) return false;
		1754	$tmp = substr($target, strlen($basedir)+1);
		1755	$res = str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
780	daniel-mar	1756	if (is_dir($target) && ($res != '')) $res .= '/';
778	daniel-mar	1757
		1758	// Third part: File name
		1759	$tmp = explode('/',$_SERVER['SCRIPT_NAME']);
		1760	$tmp = end($tmp);
		1761
		1762	// Fourth part: Query string (ordered)
		1763	$tmp2 = getSortedQuery();
		1764	if ($tmp2 != '') $tmp2 = '?'.$tmp2;
		1765
		1766	return $sysurl.$res.$tmp.$tmp2;
		1767	}
		1768
639	daniel-mar	1769	private static $shutdown_functions = array();
		1770	public static function register_shutdown_function($func) {
		1771	self::$shutdown_functions[] = $func;
		1772	}
		1773
		1774	public static function invoke_shutdown() {
		1775	foreach (self::$shutdown_functions as $func) {
		1776	$func();
		1777	}
		1778	}
		1779
360	daniel-mar	1780	public static function getAvailableLangs() {
		1781	$langs = array();
		1782	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1783	$code = $pluginManifest->getLanguageCode();
360	daniel-mar	1784	$langs[] = $code;
		1785	}
		1786	return $langs;
		1787	}
		1788
1041	daniel-mar	1789	public static function getDefaultLang() {
		1790	static $thrownOnce = false; // avoid endless loop inside OIDplusConfigInitializationException
		1791
1049	daniel-mar	1792	$lang = self::baseConfig()->getValue('DEFAULT_LANGUAGE', 'enus');
1041	daniel-mar	1793
		1794	if (!in_array($lang,self::getAvailableLangs())) {
		1795	if (!$thrownOnce) {
		1796	$thrownOnce = true;
1048	daniel-mar	1797	throw new OIDplusConfigInitializationException(_L('DEFAULT_LANGUAGE points to an invalid language plugin. (Consider setting to "enus" = "English USA".)'));
1041	daniel-mar	1798	} else {
		1799	return 'enus';
		1800	}
		1801	}
		1802
		1803	return $lang;
		1804	}
		1805
355	daniel-mar	1806	public static function getCurrentLang() {
360	daniel-mar	1807	if (isset($_GET['lang'])) {
		1808	$lang = $_GET['lang'];
		1809	} else if (isset($_POST['lang'])) {
		1810	$lang = $_POST['lang'];
		1811	} else if (isset($_COOKIE['LANGUAGE'])) {
		1812	$lang = $_COOKIE['LANGUAGE'];
		1813	} else {
1041	daniel-mar	1814	$lang = self::getDefaultLang();
360	daniel-mar	1815	}
		1816	$lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
355	daniel-mar	1817	return $lang;
		1818	}
		1819
362	daniel-mar	1820	public static function handleLangArgument() {
		1821	if (isset($_GET['lang'])) {
		1822	// The "?lang=" argument is only for NoScript-Browsers/SearchEngines
		1823	// In case someone who has JavaScript clicks a ?lang= link, they should get
		1824	// the page in that language, but the cookie must be set, otherwise
		1825	// the menu and other stuff would be in their cookie-based-language and not the
		1826	// argument-based-language.
557	daniel-mar	1827	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1828	} else if (isset($_POST['lang'])) {
557	daniel-mar	1829	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1830	}
		1831	}
		1832
468	daniel-mar	1833	private static $translationArray = array();
469	daniel-mar	1834	protected static function getTranslationFileContents($translation_file) {
		1835	// First, try the cache
481	daniel-mar	1836	$cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
469	daniel-mar	1837	if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
		1838	$cac = @unserialize(file_get_contents($cache_file));
		1839	if ($cac) return $cac;
		1840	}
481	daniel-mar	1841
469	daniel-mar	1842	// If not successful, then load the XML file
		1843	$xml = @simplexml_load_string(file_get_contents($translation_file));
		1844	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
		1845	$cac = array();
		1846	foreach ($xml->message as $msg) {
		1847	$src = trim($msg->source->__toString());
		1848	$dst = trim($msg->target->__toString());
		1849	$cac[$src] = $dst;
		1850	}
		1851	@file_put_contents($cache_file,serialize($cac));
		1852	@touch($cache_file,filemtime($translation_file));
		1853	return $cac;
		1854	}
468	daniel-mar	1855	public static function getTranslationArray($requested_lang='*') {
362	daniel-mar	1856	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1857	$lang = $pluginManifest->getLanguageCode();
362	daniel-mar	1858	if (strpos($lang,'/') !== false) continue; // just to be sure
		1859	if (strpos($lang,'\\') !== false) continue; // just to be sure
		1860	if (strpos($lang,'..') !== false) continue; // just to be sure
401	daniel-mar	1861
468	daniel-mar	1862	if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
401	daniel-mar	1863
468	daniel-mar	1864	if (!isset(self::$translationArray[$lang])) {
		1865	self::$translationArray[$lang] = array();
		1866
		1867	$wildcard = $pluginManifest->getLanguageMessages();
		1868	if (strpos($wildcard,'/') !== false) continue; // just to be sure
		1869	if (strpos($wildcard,'\\') !== false) continue; // just to be sure
		1870	if (strpos($wildcard,'..') !== false) continue; // just to be sure
		1871
635	daniel-mar	1872	$translation_files = glob(__DIR__.'/../../plugins/'.'*'.'/language/'.$lang.'/'.$wildcard);
468	daniel-mar	1873	sort($translation_files);
		1874	foreach ($translation_files as $translation_file) {
		1875	if (!file_exists($translation_file)) continue;
469	daniel-mar	1876	$cac = self::getTranslationFileContents($translation_file);
		1877	foreach ($cac as $src => $dst) {
		1878	self::$translationArray[$lang][$src] = $dst;
468	daniel-mar	1879	}
401	daniel-mar	1880	}
362	daniel-mar	1881	}
		1882	}
468	daniel-mar	1883	return self::$translationArray;
362	daniel-mar	1884	}
		1885
699	daniel-mar	1886	public static function getEditionInfo() {
		1887	return @parse_ini_file(__DIR__.'/../edition.ini', true)['Edition'];
		1888	}
		1889
698	daniel-mar	1890	public static function findGitFolder() {
		1891	// Git command line saves git information in folder ".git"
		1892	// Plesk git saves git information in folder "../../../git/oidplus/" (or similar)
727	daniel-mar	1893	$dir = OIDplus::localpath();
698	daniel-mar	1894	if (is_dir($dir.'/.git')) return $dir.'/.git';
		1895	$i = 0;
		1896	do {
		1897	if (is_dir($dir.'/git')) {
719	daniel-mar	1898	$confs = @glob($dir.'/git/'.'*'.'/config');
		1899	if ($confs) foreach ($confs as $conf) {
698	daniel-mar	1900	$cont = file_get_contents($conf);
699	daniel-mar	1901	if (isset(OIDplus::getEditionInfo()['gitrepo']) && (OIDplus::getEditionInfo()['gitrepo'] != '') && (strpos($cont, OIDplus::getEditionInfo()['gitrepo']) !== false)) {
698	daniel-mar	1902	return dirname($conf);
		1903	}
		1904	}
		1905	}
		1906	$i++;
719	daniel-mar	1907	} while (($i<100) && ($dir != ($new_dir = @realpath($dir.'/../'))) && ($dir = $new_dir));
698	daniel-mar	1908	return false;
		1909	}
		1910
		1911	public static function getGitsvnRevision($dir='') {
		1912	try {
		1913	// tries command line and binary parsing
699	daniel-mar	1914	// requires vendor/danielmarschall/git_utils.inc.php
698	daniel-mar	1915	$git_dir = OIDplus::findGitFolder();
		1916	if ($git_dir === false) return false;
		1917	$commit_msg = git_get_latest_commit_message($git_dir);
1050	daniel-mar	1918	} catch (\Exception $e) {
698	daniel-mar	1919	return false;
		1920	}
		1921
		1922	$m = array();
		1923	if (preg_match('%git-svn-id: (.+)@(\\d+) %ismU', $commit_msg, $m)) {
		1924	return $m[2];
		1925	} else {
		1926	return false;
		1927	}
		1928	}
		1929
775	daniel-mar	1930	public static function prefilterQuery($static_node_id, $throw_exception) {
		1931	// Let namespace be case-insensitive
		1932	$ary = explode(':', $static_node_id, 2);
		1933	$ary[0] = strtolower($ary[0]);
		1934	$static_node_id = implode(':', $ary);
		1935
889	daniel-mar	1936	// Ask plugins if they want to change the node id
		1937	foreach (OIDplus::getObjectTypePluginsEnabled() as $plugin) {
		1938	$static_node_id = $plugin->prefilterQuery($static_node_id, $throw_exception);
775	daniel-mar	1939	}
		1940
		1941	return $static_node_id;
		1942	}
849	daniel-mar	1943
		1944	public static function isCronjob() {
		1945	return explode('.',basename($_SERVER['SCRIPT_NAME']))[0] === 'cron';
		1946	}
856	daniel-mar	1947
857	daniel-mar	1948	private static function recanonizeObjects() {
1050	daniel-mar	1949	//
		1950	// Since OIDplus svn-184, entries in the database need to have a canonical ID
		1951	// If the ID is not canonical (e.g. GUIDs missing hyphens), the object cannot be opened in OIDplus
		1952	// This script re-canonizes the object IDs if required.
		1953	// In SVN Rev 856, the canonization for GUID, IPv4 and IPv6 have changed, requiring another
		1954	// re-canonization
		1955	//
856	daniel-mar	1956	$res = OIDplus::db()->query("select id from ###objects");
		1957	while ($row = $res->fetch_array()) {
		1958	$ida = $row['id'];
857	daniel-mar	1959	$obj = OIDplusObject::parse($ida);
		1960	if (!$obj) continue;
		1961	$idb = $obj->nodeId();
856	daniel-mar	1962	if (($idb) && ($ida != $idb)) {
		1963	OIDplus::db()->transaction_begin();
		1964	OIDplus::db()->query("update ###objects set id = ? where id = ?", array($idb, $ida));
		1965	OIDplus::db()->query("update ###asn1id set oid = ? where oid = ?", array($idb, $ida));
		1966	OIDplus::db()->query("update ###iri set oid = ? where oid = ?", array($idb, $ida));
		1967	OIDplus::db()->query("update ###log_object set id = ? where id = ?", array($idb, $ida));
		1968	OIDplus::logger()->log("[INFO]A!", "Object name '$ida' has been changed to '$idb' during re-canonization");
		1969	OIDplus::db()->transaction_commit();
978	daniel-mar	1970	OIDplusObject::resetObjectInformationCache();
856	daniel-mar	1971	}
		1972	}
		1973	}
		1974
374	daniel-mar	1975	}

Subversion Repositories oidplus

oidplus/trunk/includes/classes/OIDplus.class.php @ 1127 – Rev 1086