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	});
1088	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/)? Empty = OIDplus decides.', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
		287	if (trim($value) === '') return; // OIDplus decides
		288
453	daniel-mar	289	$good = true;
		290	if (strpos($value,'/') !== false) $good = false;
		291	if (strpos($value,'\\') !== false) $good = false;
		292	if (strpos($value,'..') !== false) $good = false;
		293	if (!$good) {
		294	throw new OIDplusException(_L('Invalid auth plugin folder name. Do only enter a folder name, not an absolute or relative path'));
		295	}
		296
1088	daniel-mar	297	OIDplus::checkRaAuthPluginAvailable($value);
453	daniel-mar	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
1088	daniel-mar	488	public static function getAuthPluginByFoldername($foldername)/: ?OIDplusAuthPlugin/ {
		489	$plugins = OIDplus::getAuthPlugins();
		490	foreach ($plugins as $plugin) {
		491	if (basename($plugin->getPluginDirectory()) === $foldername) {
		492	return $plugin;
		493	}
		494	}
		495	return null;
		496	}
		497
		498	private static function checkRaAuthPluginAvailable($plugin_foldername) {
		499	// if (!wildcard_is_dir(OIDplus::localpath().'plugins/'.'*'.'/auth/'.$plugin_foldername)) {
		500	$plugin = OIDplus::getAuthPluginByFoldername($plugin_foldername);
		501	if (is_null($plugin)) {
		502	throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$plugin_foldername,'plugins/[vendorname]/auth/'));
		503	}
		504
		505	$reason = '';
		506	if (!$plugin->available($reason)) {
		507	throw new OIDplusException(trim(_L('The auth plugin "%1" is not available on this system.',$plugin_foldername).' '.$reason));
		508	}
		509	}
		510
		511	public static function getDefaultRaAuthPlugin()/: OIDplusAuthPlugin/ {
		512	// 1. Priority: Use the auth plugin the user prefers
		513	$def_plugin_foldername = OIDplus::config()->getValue('default_ra_auth_method');
		514	if (trim($def_plugin_foldername) !== '') {
		515	OIDplus::checkRaAuthPluginAvailable($def_plugin_foldername);
		516	$plugin = OIDplus::getAuthPluginByFoldername($def_plugin_foldername);
		517	return $plugin;
		518	}
		519
		520	// 2. Priority: If empty (i.e. OIDplus may decide), choose the best ViaThinkSoft plugin that is supported on this system
		521	$preferred_auth_plugins = array(
		522	'A4_argon2',
		523	'A3_bcrypt',
1090	daniel-mar	524	'A5_vts_mcf'
1088	daniel-mar	525	);
		526	foreach ($preferred_auth_plugins as $plugin_foldername) {
		527	$plugin = OIDplus::getAuthPluginByFoldername($plugin_foldername);
		528	if (is_null($plugin)) continue;
		529
		530	$reason = '';
		531	if (!$plugin->available($reason)) continue;
		532
		533	return $plugin;
		534	}
		535
		536	// 3. Priority: If nothing found, take the first found plugin
		537	$plugins = OIDplus::getAuthPlugins();
		538	if (count($plugins) > 0) {
		539	return $plugins[0];
		540	}
		541
		542	// 4. Priority: We must deny the creation of the password because we have no auth plugin!
		543	throw new OIDplusException(_L('Could not find a fitting auth plugin!'));
		544	}
		545
227	daniel-mar	546	private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
1089	daniel-mar	547	$reason = '';
		548	if (OIDplus::baseConfig()->getValue('DEBUG') && $plugin->available($reason)) {
456	daniel-mar	549	$password = generateRandomString(25);
459	daniel-mar	550
461	daniel-mar	551	try {
		552	$authInfo = $plugin->generate($password);
		553	} catch (OIDplusException $e) {
1090	daniel-mar	554	// This can happen when the AuthKey is too long for the database field
1088	daniel-mar	555	// Note: The constructor and setters of OIDplusRAAuthInfo() already check for length and null/false values.
461	daniel-mar	556	throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
		557	}
1088	daniel-mar	558
461	daniel-mar	559	$authKey = $authInfo->getAuthKey();
459	daniel-mar	560
461	daniel-mar	561	$authInfo_AuthKeyDiff = clone $authInfo;
		562	$authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
		563
		564	if ((!$plugin->verify($authInfo,$password)) \|\|
		565	($plugin->verify($authInfo_AuthKeyDiff,$password)) \|\|
		566	($plugin->verify($authInfo,$password.'x'))) {
1088	daniel-mar	567	throw new OIDplusException(_L('Auth plugin "%1" is erroneous: Generate/Verify self-test failed',basename($plugin->getPluginDirectory())));
456	daniel-mar	568	}
453	daniel-mar	569	}
		570
227	daniel-mar	571	self::$authPlugins[] = $plugin;
		572	return true;
		573	}
		574
221	daniel-mar	575	public static function getAuthPlugins() {
		576	return self::$authPlugins;
		577	}
		578
1050	daniel-mar	579	// --- Language plugin
355	daniel-mar	580
		581	private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
		582	self::$languagePlugins[] = $plugin;
		583	return true;
		584	}
		585
		586	public static function getLanguagePlugins() {
		587	return self::$languagePlugins;
		588	}
		589
1050	daniel-mar	590	// --- Design plugin
449	daniel-mar	591
		592	private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
		593	self::$designPlugins[] = $plugin;
		594	return true;
		595	}
		596
		597	public static function getDesignPlugins() {
		598	return self::$designPlugins;
		599	}
		600
819	daniel-mar	601	public static function getActiveDesignPlugin() {
		602	$plugins = OIDplus::getDesignPlugins();
		603	foreach ($plugins as $plugin) {
		604	if ((basename($plugin->getPluginDirectory())) == OIDplus::config()->getValue('design','default')) {
		605	return $plugin;
		606	}
		607	}
		608	return null;
		609	}
		610
1050	daniel-mar	611	// --- Logger plugin
289	daniel-mar	612
		613	private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
		614	self::$loggerPlugins[] = $plugin;
		615	return true;
		616	}
		617
		618	public static function getLoggerPlugins() {
		619	return self::$loggerPlugins;
		620	}
		621
1050	daniel-mar	622	// --- Object type plugin
227	daniel-mar	623
		624	private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
		625	self::$objectTypePlugins[] = $plugin;
		626
		627	$ot = $plugin::getObjectTypeClassName();
		628	self::registerObjectType($ot);
		629
		630	return true;
		631	}
		632
224	daniel-mar	633	private static function registerObjectType($ot) {
66	daniel-mar	634	$ns = $ot::ns();
860	daniel-mar	635	if (empty($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace must not be empty',$ot));
66	daniel-mar	636
860	daniel-mar	637	// Currently, we must enforce that namespaces in objectType plugins are lowercase, because prefilterQuery() makes all namespaces lowercase and the DBMS should be case-sensitive
		638	if ($ns != strtolower($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace %2 must be lower-case',$ot,$ns));
66	daniel-mar	639
860	daniel-mar	640	$root = $ot::root();
		641	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.':'));
		642
66	daniel-mar	643	$ns_found = false;
227	daniel-mar	644	foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
66	daniel-mar	645	if ($test_ot::ns() == $ns) {
		646	$ns_found = true;
		647	break;
		648	}
		649	}
		650	if ($ns_found) {
360	daniel-mar	651	throw new OIDplusException(_L('Attention: Two objectType plugins use the same namespace "%1"!',$ns));
66	daniel-mar	652	}
		653
		654	$init = OIDplus::config()->getValue("objecttypes_initialized");
		655	$init_ary = empty($init) ? array() : explode(';', $init);
70	daniel-mar	656	$init_ary = array_map('trim', $init_ary);
66	daniel-mar	657
		658	$enabled = OIDplus::config()->getValue("objecttypes_enabled");
		659	$enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
70	daniel-mar	660	$enabled_ary = array_map('trim', $enabled_ary);
66	daniel-mar	661
79	daniel-mar	662	$do_enable = false;
		663	if (in_array($ns, $enabled_ary)) {
447	daniel-mar	664	// If it is in the list of enabled object types, it is enabled (obviously)
79	daniel-mar	665	$do_enable = true;
		666	} else {
447	daniel-mar	667	if (!OIDplus::config()->getValue('oobe_objects_done')) {
		668	// If the OOBE wizard is NOT done, then just enable the "oid" object type by default
79	daniel-mar	669	$do_enable = $ns == 'oid';
		670	} else {
447	daniel-mar	671	// If the OOBE wizard was done (once), then
		672	// we will enable all object types which were never initialized
		673	// (i.e. a plugin folder was freshly added)
79	daniel-mar	674	$do_enable = !in_array($ns, $init_ary);
		675	}
		676	}
		677
		678	if ($do_enable) {
227	daniel-mar	679	self::$enabledObjectTypes[] = $ot;
		680	usort(self::$enabledObjectTypes, function($a, $b) {
66	daniel-mar	681	$enabled = OIDplus::config()->getValue("objecttypes_enabled");
		682	$enabled_ary = explode(';', $enabled);
		683
		684	$idx_a = array_search($a::ns(), $enabled_ary);
		685	$idx_b = array_search($b::ns(), $enabled_ary);
		686
		687	if ($idx_a == $idx_b) {
		688	return 0;
		689	}
		690	return ($idx_a > $idx_b) ? +1 : -1;
		691	});
74	daniel-mar	692	} else {
		693	self::$disabledObjectTypes[] = $ot;
66	daniel-mar	694	}
		695
		696	if (!in_array($ns, $init_ary)) {
		697	// Was never initialized before, so we add it to the list of enabled object types once
		698
79	daniel-mar	699	if ($do_enable) {
		700	$enabled_ary[] = $ns;
672	daniel-mar	701	// Important: Don't validate the input, because the other object types might not be initialized yet! So use setValueNoCallback() instead setValue().
		702	OIDplus::config()->setValueNoCallback("objecttypes_enabled", implode(';', $enabled_ary));
79	daniel-mar	703	}
66	daniel-mar	704
		705	$init_ary[] = $ns;
		706	OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
		707	}
61	daniel-mar	708	}
		709
227	daniel-mar	710	public static function getObjectTypePlugins() {
		711	return self::$objectTypePlugins;
61	daniel-mar	712	}
		713
227	daniel-mar	714	public static function getObjectTypePluginsEnabled() {
		715	$res = array();
		716	foreach (self::$objectTypePlugins as $plugin) {
		717	$ot = $plugin::getObjectTypeClassName();
		718	if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
		719	}
		720	return $res;
74	daniel-mar	721	}
		722
227	daniel-mar	723	public static function getObjectTypePluginsDisabled() {
		724	$res = array();
		725	foreach (self::$objectTypePlugins as $plugin) {
		726	$ot = $plugin::getObjectTypeClassName();
		727	if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
74	daniel-mar	728	}
227	daniel-mar	729	return $res;
74	daniel-mar	730	}
		731
227	daniel-mar	732	public static function getEnabledObjectTypes() {
		733	return self::$enabledObjectTypes;
		734	}
74	daniel-mar	735
227	daniel-mar	736	public static function getDisabledObjectTypes() {
		737	return self::$disabledObjectTypes;
		738	}
74	daniel-mar	739
1050	daniel-mar	740	// --- Plugin handling functions
277	daniel-mar	741
320	daniel-mar	742	public static function getAllPlugins()/: array/ {
		743	$res = array();
		744	$res = array_merge($res, self::$pagePlugins);
		745	$res = array_merge($res, self::$authPlugins);
		746	$res = array_merge($res, self::$loggerPlugins);
		747	$res = array_merge($res, self::$objectTypePlugins);
		748	$res = array_merge($res, self::$dbPlugins);
702	daniel-mar	749	$res = array_merge($res, self::$captchaPlugins);
320	daniel-mar	750	$res = array_merge($res, self::$sqlSlangPlugins);
355	daniel-mar	751	$res = array_merge($res, self::$languagePlugins);
449	daniel-mar	752	$res = array_merge($res, self::$designPlugins);
320	daniel-mar	753	return $res;
		754	}
		755
321	daniel-mar	756	public static function getPluginByOid($oid)/: ?OIDplusPlugin/ {
320	daniel-mar	757	$plugins = self::getAllPlugins();
321	daniel-mar	758	foreach ($plugins as $plugin) {
		759	if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
		760	return $plugin;
320	daniel-mar	761	}
		762	}
		763	return null;
		764	}
		765
380	daniel-mar	766	public static function getPluginByClassName($classname)/: ?OIDplusPlugin/ {
		767	$plugins = self::getAllPlugins();
		768	foreach ($plugins as $plugin) {
		769	if (get_class($plugin) === $classname) {
		770	return $plugin;
		771	}
		772	}
		773	return null;
277	daniel-mar	774	}
		775
594	daniel-mar	776	/**
1050	daniel-mar	777	* Checks if the plugin is disabled
		778	* @return boolean true if plugin is enabled, false if plugin is disabled
		779	* @throws OIDplusException if the class name or config file (disabled setting) does not contain a namespace
		780	*/
		781	private static function pluginCheckDisabled($class_name): bool {
		782	$path = explode('\\', $class_name);
		783
		784	if (count($path) == 1) {
		785	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.'));
		786	}
		787
		788	$class_end = end($path);
		789	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_end, false)) {
		790	throw new OIDplusConfigInitializationException(_L('Your base configuration file is outdated. Please change "%1" to "%2".','DISABLE_PLUGIN_'.$class_end,'DISABLE_PLUGIN_'.$class_name));
		791	}
		792
		793	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
		794	return false;
		795	}
		796
		797	return true;
		798	}
		799
		800	/**
594	daniel-mar	801	* @return array<OIDplusPluginManifest>\|array<string,array<string,OIDplusPluginManifest>>
		802	*/
693	daniel-mar	803	public static function getAllPluginManifests($pluginFolderMasks='*', $flat=true): array {
277	daniel-mar	804	$out = array();
279	daniel-mar	805	// Note: glob() will sort by default, so we do not need a page priority attribute.
		806	// So you just need to use a numeric plugin directory prefix (padded).
693	daniel-mar	807	$ary = array();
		808	foreach (explode(',',$pluginFolderMasks) as $pluginFolderMask) {
		809	$ary = array_merge($ary,glob(OIDplus::localpath().'plugins/'.''.'/'.$pluginFolderMask.'/'.''.'/manifest.xml'));
		810	}
646	daniel-mar	811
		812	// Sort the plugins by their type and name, as if they would be in a single vendor-folder!
		813	uasort($ary, function($a,$b) {
		814	if ($a == $b) return 0;
		815
		816	$ary = explode('/',$a);
		817	$bry = explode('/',$b);
		818
		819	// First sort by type (publicPage, auth, database, language, ...)
		820	$a_type = $ary[count($ary)-1-2];
		821	$b_type = $bry[count($bry)-1-2];
		822	if ($a_type < $b_type) return -1;
		823	if ($a_type > $b_type) return 1;
		824
		825	// Then sort by name (090_login, 100_whois, etc.)
		826	$a_name = $ary[count($ary)-1-1];
		827	$b_name = $bry[count($bry)-1-1];
		828	if ($a_name < $b_name) return -1;
		829	if ($a_name > $b_name) return 1;
		830
		831	// If it is still equal, then finally sort by vendorname
		832	$a_vendor = $ary[count($ary)-1-3];
		833	$b_vendor = $bry[count($bry)-1-3];
		834	if ($a_vendor < $b_vendor) return -1;
		835	if ($a_vendor > $b_vendor) return 1;
		836	return 0;
		837	});
		838
277	daniel-mar	839	foreach ($ary as $ini) {
		840	if (!file_exists($ini)) continue;
		841
307	daniel-mar	842	$manifest = new OIDplusPluginManifest();
		843	$manifest->loadManifest($ini);
277	daniel-mar	844
473	daniel-mar	845	$class_name = $manifest->getPhpMainClass();
1050	daniel-mar	846	if ($class_name) if (!self::pluginCheckDisabled($class_name)) continue;
473	daniel-mar	847
307	daniel-mar	848	if ($flat) {
		849	$out[] = $manifest;
		850	} else {
		851	$plugintype_folder = basename(dirname(dirname($ini)));
		852	$pluginname_folder = basename(dirname($ini));
		853
		854	if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
		855	if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
		856	$out[$plugintype_folder][$pluginname_folder] = $manifest;
		857	}
277	daniel-mar	858	}
		859	return $out;
		860	}
		861
594	daniel-mar	862	/**
		863	* @return array<string>
		864	*/
277	daniel-mar	865	public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
		866	$out = array();
525	daniel-mar	867	if (is_array($pluginDirName)) {
		868	$ary = array();
		869	foreach ($pluginDirName as $pluginDirName_) {
		870	$ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
		871	}
		872	} else {
		873	$ary = self::getAllPluginManifests($pluginDirName, false);
		874	}
320	daniel-mar	875	$known_plugin_oids = array();
456	daniel-mar	876	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		877	$fake_feature = uuid_to_oid(gen_uuid());
588	daniel-mar	878	} else {
		879	$fake_feature = null;
456	daniel-mar	880	}
277	daniel-mar	881	foreach ($ary as $plugintype_folder => $bry) {
438	daniel-mar	882	foreach ($bry as $pluginname_folder => $manifest) {
		883	$class_name = $manifest->getPhpMainClass();
		884
		885	// Before we load the plugin, we want to make some checks to confirm
		886	// that the plugin is working correctly.
		887
307	daniel-mar	888	if (!$class_name) {
1050	daniel-mar	889	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('Manifest does not declare a PHP main class'));
277	daniel-mar	890	}
1050	daniel-mar	891	if (!self::pluginCheckDisabled($class_name)) {
		892	continue; // Plugin is disabled
297	daniel-mar	893	}
1072	daniel-mar	894
		895	// Do some basic checks on the plugin PHP main class
292	daniel-mar	896	if (!class_exists($class_name)) {
1050	daniel-mar	897	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	898	}
279	daniel-mar	899	if (!is_subclass_of($class_name, $expectedPluginClass)) {
1050	daniel-mar	900	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	901	}
438	daniel-mar	902	if (($class_name!=$manifest->getTypeClass()) && (!is_subclass_of($class_name,$manifest->getTypeClass()))) {
1050	daniel-mar	903	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	904	}
438	daniel-mar	905	if (($manifest->getTypeClass()!=$expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(),$expectedPluginClass))) {
1050	daniel-mar	906	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	907	}
		908
1072	daniel-mar	909	// Do some basic checks on the plugin OID
438	daniel-mar	910	$plugin_oid = $manifest->getOid();
320	daniel-mar	911	if (!$plugin_oid) {
1050	daniel-mar	912	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('Does not have an OID'));
320	daniel-mar	913	}
		914	if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) {
1050	daniel-mar	915	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	916	}
		917	if (isset($known_plugin_oids[$plugin_oid])) {
1050	daniel-mar	918	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	919	}
646	daniel-mar	920
1072	daniel-mar	921	// Additional check: Are third-party plugins using ViaThinkSoft plugin folders, OIDs or class namespaces?
632	daniel-mar	922	$full_plugin_dir = dirname($manifest->getManifestFile());
		923	$full_plugin_dir = substr($full_plugin_dir, strlen(OIDplus::localpath()));
988	daniel-mar	924	$dir_is_viathinksoft = str_starts_with($full_plugin_dir, 'plugins/viathinksoft/') \|\| str_starts_with($full_plugin_dir, 'plugins\\viathinksoft\\');
		925	$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	926	$class_is_viathinksoft = str_starts_with($class_name, 'ViaThinkSoft\\');
1072	daniel-mar	927	if ($oid_is_viathinksoft != $class_is_viathinksoft) {
		928	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.'));
		929	}
		930	$plugin_is_viathinksoft = $oid_is_viathinksoft && $class_is_viathinksoft;
		931	if ($dir_is_viathinksoft != $plugin_is_viathinksoft) {
1050	daniel-mar	932	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	933	}
1072	daniel-mar	934
		935	// Additional check: does the plugin define JS/CSS although it is not an interactive plugin type?
		936	$has_js = $manifest->getJSFiles();
		937	$has_css = $manifest->getCSSFiles();
		938	$is_interactive = in_array(basename($plugintype_folder), OIDplus::INTERACTIVE_PLUGIN_TYPES);
		939	$is_design = basename($plugintype_folder) === 'design';
		940	if (!$is_interactive && $has_js) {
		941	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	942	}
1072	daniel-mar	943	if (!$is_interactive && !$is_design && $has_css) {
		944	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'));
		945	}
320	daniel-mar	946
1072	daniel-mar	947	// Additional check: Check "Setup CSS" and "Setup JS" (Allowed for plugin types: database, captcha)
		948	$has_js_setup = $manifest->getJSFilesSetup();
		949	$has_css_setup = $manifest->getCSSFilesSetup();
		950	$is_database = basename($plugintype_folder) === 'database';
		951	$is_captcha = basename($plugintype_folder) === 'captcha';
		952	if (!$is_database && !$is_captcha && $has_js_setup) {
		953	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'));
		954	}
		955	if (!$is_database && !$is_captcha && $has_css_setup) {
		956	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'));
		957	}
632	daniel-mar	958
1072	daniel-mar	959	// Additional check: Are all CSS/JS files there?
		960	$tmp = $manifest->getManifestLinkedFiles();
		961	foreach ($tmp as $file) {
		962	if (!file_exists($file)) {
		963	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));
		964	}
		965	}
		966
		967	// For the next check, we need an instance of the object
438	daniel-mar	968	$obj = new $class_name();
456	daniel-mar	969
1072	daniel-mar	970	// Additional check: Does the plugin misuse implementsFeature()?
		971	// This is not enabled b default, because the GUID generation is slow on some machines.
		972	// Also, it is very unlikely that someone misuses implementsFeature().
456	daniel-mar	973	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		974	if ($obj->implementsFeature($fake_feature)) {
		975	// see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663
1050	daniel-mar	976	throw new OIDplusException(_L('Plugin "%1" is erroneous',$plugintype_folder.'/'.$pluginname_folder).': '._L('implementsFeature() always returns true'));
456	daniel-mar	977	}
438	daniel-mar	978	}
		979
		980	// Now we can continue
1072	daniel-mar	981	$known_plugin_oids[$plugin_oid] = $plugintype_folder.'/'.$pluginname_folder;
279	daniel-mar	982	$out[] = $class_name;
		983	if (!is_null($registerCallback)) {
438	daniel-mar	984	call_user_func($registerCallback, $obj);
444	daniel-mar	985
		986	// Alternative approaches:
		987	//$registerCallback[0]::{$registerCallback[1]}($obj);
		988	// or:
		989	//forward_static_call($registerCallback, $obj);
279	daniel-mar	990	}
277	daniel-mar	991	}
		992
		993	}
		994	return $out;
		995	}
		996
1050	daniel-mar	997	// --- Initialization of OIDplus
206	daniel-mar	998
374	daniel-mar	999	public static function init($html=true, $keepBaseConfig=true) {
236	daniel-mar	1000	self::$html = $html;
		1001
263	daniel-mar	1002	// Reset internal state, so we can re-init verything if required
274	daniel-mar	1003
263	daniel-mar	1004	self::$config = null;
374	daniel-mar	1005	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	1006	self::$gui = null;
		1007	self::$authUtils = null;
		1008	self::$mailUtils = null;
		1009	self::$menuUtils = null;
		1010	self::$logger = null;
295	daniel-mar	1011	self::$dbMainSession = null;
		1012	self::$dbIsolatedSession = null;
263	daniel-mar	1013	self::$pagePlugins = array();
		1014	self::$authPlugins = array();
289	daniel-mar	1015	self::$loggerPlugins = array();
263	daniel-mar	1016	self::$objectTypePlugins = array();
		1017	self::$enabledObjectTypes = array();
		1018	self::$disabledObjectTypes = array();
		1019	self::$dbPlugins = array();
702	daniel-mar	1020	self::$captchaPlugins = array();
274	daniel-mar	1021	self::$sqlSlangPlugins = array();
355	daniel-mar	1022	self::$languagePlugins = array();
449	daniel-mar	1023	self::$designPlugins = array();
263	daniel-mar	1024	self::$system_id_cache = null;
		1025	self::$sslAvailableCache = null;
468	daniel-mar	1026	self::$translationArray = array();
74	daniel-mar	1027
263	daniel-mar	1028	// Continue...
		1029
294	daniel-mar	1030	OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
263	daniel-mar	1031	// You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
		1032
150	daniel-mar	1033	// Register database types (highest priority)
		1034
274	daniel-mar	1035	// SQL slangs
		1036
1050	daniel-mar	1037	self::registerAllPlugins('sqlSlang', OIDplusSqlSlangPlugin::class, array(OIDplus::class,'registerSqlSlangPlugin'));
274	daniel-mar	1038	foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
		1039	$plugin->init($html);
		1040	}
		1041
		1042	// Database providers
		1043
1050	daniel-mar	1044	self::registerAllPlugins('database', OIDplusDatabasePlugin::class, array(OIDplus::class,'registerDatabasePlugin'));
237	daniel-mar	1045	foreach (OIDplus::getDatabasePlugins() as $plugin) {
		1046	$plugin->init($html);
		1047	}
		1048
42	daniel-mar	1049	// Do redirect stuff etc.
74	daniel-mar	1050
230	daniel-mar	1051	self::isSslAvailable(); // This function does automatic redirects
61	daniel-mar	1052
263	daniel-mar	1053	// Construct the configuration manager
66	daniel-mar	1054
263	daniel-mar	1055	OIDplus::config(); // During the construction, various system settings are prepared if required
66	daniel-mar	1056
74	daniel-mar	1057	// Initialize public / private keys
		1058
227	daniel-mar	1059	OIDplus::getPkiStatus(true);
74	daniel-mar	1060
237	daniel-mar	1061	// Register non-DB plugins
74	daniel-mar	1062
1050	daniel-mar	1063	self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), OIDplusPagePlugin::class, array(OIDplus::class,'registerPagePlugin'));
		1064	self::registerAllPlugins('auth', OIDplusAuthPlugin::class, array(OIDplus::class,'registerAuthPlugin'));
		1065	self::registerAllPlugins('logger', OIDplusLoggerPlugin::class, array(OIDplus::class,'registerLoggerPlugin'));
825	daniel-mar	1066	OIDplusLogger::reLogMissing(); // Some previous plugins might have tried to log. Repeat that now.
1050	daniel-mar	1067	self::registerAllPlugins('objectTypes', OIDplusObjectTypePlugin::class, array(OIDplus::class,'registerObjectTypePlugin'));
		1068	self::registerAllPlugins('language', OIDplusLanguagePlugin::class, array(OIDplus::class,'registerLanguagePlugin'));
		1069	self::registerAllPlugins('design', OIDplusDesignPlugin::class, array(OIDplus::class,'registerDesignPlugin'));
		1070	self::registerAllPlugins('captcha', OIDplusCaptchaPlugin::class, array(OIDplus::class,'registerCaptchaPlugin'));
150	daniel-mar	1071
237	daniel-mar	1072	// Initialize non-DB plugins
224	daniel-mar	1073
281	daniel-mar	1074	foreach (OIDplus::getPagePlugins() as $plugin) {
74	daniel-mar	1075	$plugin->init($html);
		1076	}
230	daniel-mar	1077	foreach (OIDplus::getAuthPlugins() as $plugin) {
		1078	$plugin->init($html);
		1079	}
289	daniel-mar	1080	foreach (OIDplus::getLoggerPlugins() as $plugin) {
		1081	$plugin->init($html);
		1082	}
230	daniel-mar	1083	foreach (OIDplus::getObjectTypePlugins() as $plugin) {
		1084	$plugin->init($html);
		1085	}
355	daniel-mar	1086	foreach (OIDplus::getLanguagePlugins() as $plugin) {
		1087	$plugin->init($html);
		1088	}
449	daniel-mar	1089	foreach (OIDplus::getDesignPlugins() as $plugin) {
		1090	$plugin->init($html);
		1091	}
778	daniel-mar	1092	foreach (OIDplus::getCaptchaPlugins() as $plugin) {
		1093	$plugin->init($html);
		1094	}
412	daniel-mar	1095
778	daniel-mar	1096	if (PHP_SAPI != 'cli') {
		1097
		1098	// Prepare some security related response headers (default values)
		1099
		1100	$content_language =
		1101	strtolower(substr(OIDplus::getCurrentLang(),0,2)) . '-' .
		1102	strtoupper(substr(OIDplus::getCurrentLang(),2,2)); // e.g. 'en-US'
		1103
		1104	$http_headers = array(
		1105	"X-Content-Type-Options" => "nosniff",
		1106	"X-XSS-Protection" => "1; mode=block",
		1107	"X-Frame-Options" => "SAMEORIGIN",
		1108	"Referrer-Policy" => array(
		1109	"no-referrer-when-downgrade"
		1110	),
		1111	"Cache-Control" => array(
		1112	"no-cache",
		1113	"no-store",
		1114	"must-revalidate"
		1115	),
		1116	"Pragma" => "no-cache",
		1117	"Content-Language" => $content_language,
		1118	"Expires" => "0",
		1119	"Content-Security-Policy" => array(
1001	daniel-mar	1120	// see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
		1121
		1122	// --- Fetch directives ---
		1123	"child-src" => array(
		1124	"'self'",
		1125	"blob:"
		1126	),
		1127	"connect-src" => array(
		1128	"'self'",
		1129	"blob:"
		1130	),
778	daniel-mar	1131	"default-src" => array(
		1132	"'self'",
		1133	"blob:",
		1134	"https://cdnjs.cloudflare.com/"
		1135	),
1001	daniel-mar	1136	"font-src" => array(
778	daniel-mar	1137	"'self'",
1001	daniel-mar	1138	"blob:"
778	daniel-mar	1139	),
1001	daniel-mar	1140	"frame-src" => array(
		1141	"'self'",
		1142	"blob:"
		1143	),
778	daniel-mar	1144	"img-src" => array(
1001	daniel-mar	1145	"blob:",
778	daniel-mar	1146	"data:",
		1147	"http:",
		1148	"https:"
		1149	),
1001	daniel-mar	1150	"manifest-src" => array(
		1151	"'self'",
		1152	"blob:"
		1153	),
		1154	"media-src" => array(
		1155	"'self'",
		1156	"blob:"
		1157	),
		1158	"object-src" => array(
		1159	"'none'"
		1160	),
		1161	"prefetch-src" => array(
		1162	"'self'",
		1163	"blob:"
		1164	),
778	daniel-mar	1165	"script-src" => array(
		1166	"'self'",
		1167	"'unsafe-inline'",
		1168	"'unsafe-eval'",
		1169	"blob:",
		1170	"https://cdnjs.cloudflare.com/",
		1171	"https://polyfill.io/"
		1172	),
1001	daniel-mar	1173	// script-src-elem not used
		1174	// script-src-attr not used
		1175	"style-src" => array(
		1176	"'self'",
		1177	"'unsafe-inline'",
		1178	"https://cdnjs.cloudflare.com/"
		1179	),
		1180	// style-src-elem not used
		1181	// style-src-attr not used
		1182	"worker-src" => array(
		1183	"'self'",
		1184	"blob:"
		1185	),
		1186
		1187	// --- Navigation directives ---
778	daniel-mar	1188	"frame-ancestors" => array(
		1189	"'none'"
		1190	),
		1191	)
		1192	);
		1193
780	daniel-mar	1194	// Give plugins the opportunity to manipulate/extend the headers
778	daniel-mar	1195
		1196	foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
		1197	$plugin->httpHeaderCheck($http_headers);
		1198	}
1015	daniel-mar	1199	//foreach (OIDplus::getDatabasePlugins() as $plugin) {
		1200	if ($plugin = OIDplus::getActiveDatabasePlugin()) {
778	daniel-mar	1201	$plugin->httpHeaderCheck($http_headers);
		1202	}
		1203	foreach (OIDplus::getPagePlugins() as $plugin) {
		1204	$plugin->httpHeaderCheck($http_headers);
		1205	}
		1206	foreach (OIDplus::getAuthPlugins() as $plugin) {
		1207	$plugin->httpHeaderCheck($http_headers);
		1208	}
		1209	foreach (OIDplus::getLoggerPlugins() as $plugin) {
		1210	$plugin->httpHeaderCheck($http_headers);
		1211	}
		1212	foreach (OIDplus::getObjectTypePlugins() as $plugin) {
		1213	$plugin->httpHeaderCheck($http_headers);
		1214	}
		1215	foreach (OIDplus::getLanguagePlugins() as $plugin) {
		1216	$plugin->httpHeaderCheck($http_headers);
		1217	}
		1218	foreach (OIDplus::getDesignPlugins() as $plugin) {
		1219	$plugin->httpHeaderCheck($http_headers);
		1220	}
1015	daniel-mar	1221	//foreach (OIDplus::getCaptchaPlugins() as $plugin) {
		1222	if ($plugin = OIDplus::getActiveCaptchaPlugin()) {
778	daniel-mar	1223	$plugin->httpHeaderCheck($http_headers);
		1224	}
		1225
		1226	// Prepare to send the headers to the client
		1227	// The headers are sent automatically when the first output comes or the script ends
		1228
		1229	foreach ($http_headers as $name => $val) {
		1230
		1231	// Plugins can remove standard OIDplus headers by setting the value to null.
		1232	if (is_null($val)) continue; /** @phpstan-ignore-line */
		1233
		1234	// Some headers can be written as arrays to make it easier for plugin authors
		1235	// to manipulate/extend the contents.
		1236	if (is_array($val)) {
		1237	if ((strtolower($name) == 'cache-control') \|\|
		1238	(strtolower($name) == 'referrer-policy'))
		1239	{
		1240	if (count($val) == 0) continue;
		1241	$val = implode(', ', $val);
		1242	} else if (strtolower($name) == 'content-security-policy') {
		1243	if (count($val) == 0) continue;
780	daniel-mar	1244	foreach ($val as $tmp1 => &$tmp2) {
		1245	$tmp2 = array_unique($tmp2);
		1246	$tmp2 = $tmp1.' '.implode(' ', $tmp2);
		1247	}
778	daniel-mar	1248	$val = implode('; ', $val);
		1249	} else {
779	daniel-mar	1250	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	1251	}
		1252	}
		1253
		1254	if (is_string($val)) {
		1255	header("$name: $val");
		1256	}
		1257	}
		1258
		1259	} // endif (PHP_SAPI != 'cli')
		1260
412	daniel-mar	1261	// Initialize other stuff (i.e. things which require the logger!)
		1262
		1263	OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
		1264	OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
2	daniel-mar	1265	}
42	daniel-mar	1266
1050	daniel-mar	1267	// --- System URL, System ID, PKI, and other functions
227	daniel-mar	1268
412	daniel-mar	1269	private static function recognizeSystemUrl() {
		1270	try {
1072	daniel-mar	1271	$url = OIDplus::webpath(null,self::PATH_ABSOLUTE_CANONICAL);
412	daniel-mar	1272	OIDplus::config()->setValue('last_known_system_url', $url);
1050	daniel-mar	1273	} catch (\Exception $e) {
412	daniel-mar	1274	}
		1275	}
497	daniel-mar	1276
496	daniel-mar	1277	private static function getExecutingScriptPathDepth() {
		1278	if (PHP_SAPI == 'cli') {
		1279	global $argv;
		1280	$test_dir = dirname(realpath($argv[0]));
		1281	} else {
		1282	if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
		1283	$test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
		1284	}
		1285	$test_dir = str_replace('\\', '/', $test_dir);
		1286	$steps_up = 0;
928	daniel-mar	1287	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	1288	$test_dir = dirname($test_dir);
		1289	$steps_up++;
		1290	if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
		1291	}
		1292	return $steps_up;
		1293	}
632	daniel-mar	1294
580	daniel-mar	1295	public static function isSSL() {
		1296	return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
		1297	}
412	daniel-mar	1298
806	daniel-mar	1299	/**
		1300	* Returns the URL of the system.
		1301	* @param int $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
		1302	* PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
		1303	* results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
		1304	* but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
		1305	* @return string\|false The URL, with guaranteed trailing path delimiter for directories
		1306	*/
801	daniel-mar	1307	private static function getSystemUrl($mode) {
806	daniel-mar	1308	if ($mode === self::PATH_RELATIVE) {
778	daniel-mar	1309	$steps_up = self::getExecutingScriptPathDepth();
		1310	if ($steps_up === false) {
		1311	return false;
		1312	} else {
		1313	return str_repeat('../', $steps_up);
		1314	}
		1315	} else {
806	daniel-mar	1316	if ($mode === self::PATH_ABSOLUTE_CANONICAL) {
		1317	$tmp = OIDplus::baseConfig()->getValue('CANONICAL_SYSTEM_URL', '');
		1318	if ($tmp) {
		1319	return rtrim($tmp,'/').'/';
		1320	}
326	daniel-mar	1321	}
778	daniel-mar	1322
495	daniel-mar	1323	if (PHP_SAPI == 'cli') {
494	daniel-mar	1324	try {
		1325	return OIDplus::config()->getValue('last_known_system_url', false);
1050	daniel-mar	1326	} catch (\Exception $e) {
494	daniel-mar	1327	return false;
		1328	}
778	daniel-mar	1329	} else {
		1330	// First, try to find out how many levels we need to go up
		1331	$steps_up = self::getExecutingScriptPathDepth();
326	daniel-mar	1332
778	daniel-mar	1333	// Then go up these amount of levels, based on SCRIPT_NAME/argv[0]
		1334	$res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
		1335	for ($i=0; $i<$steps_up; $i++) {
		1336	$res = dirname($res);
		1337	}
		1338	$res = str_replace('\\', '/', $res);
		1339	if ($res == '/') $res = '';
227	daniel-mar	1340
778	daniel-mar	1341	// Add protocol and hostname
580	daniel-mar	1342	$is_ssl = self::isSSL();
495	daniel-mar	1343	$protocol = $is_ssl ? 'https' : 'http'; // do not translate
		1344	$host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
778	daniel-mar	1345
		1346	return $protocol.'://'.$host.$res.'/';
495	daniel-mar	1347	}
227	daniel-mar	1348	}
		1349	}
		1350
1073	daniel-mar	1351	private static function pubKeyToRaw($pubKey) {
827	daniel-mar	1352	$m = array();
1073	daniel-mar	1353	if (preg_match('@BEGIN PUBLIC KEY\\-+([^\\-]+)\\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
		1354	return base64_decode($m[1], false);
827	daniel-mar	1355	}
		1356	return false;
		1357	}
		1358
1073	daniel-mar	1359	private static function getSystemIdFromPubKey($pubKey) {
		1360	$rawData = self::pubKeyToRaw($pubKey);
		1361	if ($rawData === false) return false;
		1362	return smallhash($rawData);
		1363	}
		1364
		1365	private static function getSystemGuidFromPubKey($pubKey) {
		1366	$rawData = self::pubKeyToRaw($pubKey);
		1367	if ($rawData === false) return false;
		1368	$normalizedBase64 = base64_encode($rawData);
		1369	return gen_uuid_sha1_namebased(self::UUID_NAMEBASED_NS_Base64PubKey, $normalizedBase64);
		1370	}
		1371
227	daniel-mar	1372	private static $system_id_cache = null;
		1373	public static function getSystemId($oid=false) {
		1374	if (!is_null(self::$system_id_cache)) {
		1375	$out = self::$system_id_cache;
		1376	} else {
		1377	$out = false;
		1378
		1379	if (self::getPkiStatus(true)) {
830	daniel-mar	1380	$pubKey = OIDplus::getSystemPublicKey();
827	daniel-mar	1381	$out = self::getSystemIdFromPubKey($pubKey);
227	daniel-mar	1382	}
		1383	self::$system_id_cache = $out;
		1384	}
350	daniel-mar	1385	if (!$out) return false;
291	daniel-mar	1386	return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
227	daniel-mar	1387	}
		1388
1073	daniel-mar	1389	private static $system_guid_cache = null;
		1390	public static function getSystemGuid() {
		1391	if (!is_null(self::$system_guid_cache)) {
		1392	$out = self::$system_guid_cache;
		1393	} else {
		1394	$out = false;
		1395
		1396	if (self::getPkiStatus(true)) {
		1397	$pubKey = OIDplus::getSystemPublicKey();
		1398	$out = self::getSystemGuidFromPubKey($pubKey);
		1399	}
		1400	self::$system_guid_cache = $out;
		1401	}
		1402	if (!$out) return false;
		1403	return $out;
		1404	}
		1405
825	daniel-mar	1406	public static function getOpenSslCnf() {
		1407	// The following functions need a config file, otherway they don't work
		1408	// - openssl_csr_new
		1409	// - openssl_csr_sign
		1410	// - openssl_pkey_export
		1411	// - openssl_pkey_export_to_file
		1412	// - openssl_pkey_new
		1413	$tmp = @getenv('OPENSSL_CONF');
		1414	if ($tmp && file_exists($tmp)) return $tmp;
		1415
		1416	// OpenSSL in XAMPP does not work OOBE, since the OPENSSL_CONF is
		1417	// C:/xampp/apache/bin/openssl.cnf and not C:/xampp/apache/conf/openssl.cnf
		1418	// Bug reports are more than 10 years old and nobody cares...
		1419	// Use our own config file
		1420	return __DIR__.'/../../vendor/phpseclib/phpseclib/phpseclib/openssl.cnf';
		1421	}
		1422
830	daniel-mar	1423	private static function getPrivKeyPassphraseFilename() {
		1424	return OIDplus::localpath() . 'userdata/privkey_secret.php';
		1425	}
227	daniel-mar	1426
830	daniel-mar	1427	private static function tryCreatePrivKeyPassphrase() {
		1428	$file = self::getPrivKeyPassphraseFilename();
827	daniel-mar	1429
830	daniel-mar	1430	$passphrase = generateRandomString(64);
		1431	$cont = "<?php\n";
		1432	$cont .= "// ATTENTION! This file was automatically generated by OIDplus to encrypt the private key\n";
		1433	$cont .= "// that is located in your database configuration table. DO NOT ALTER OR DELETE THIS FILE,\n";
		1434	$cont .= "// otherwise you will lose your OIDplus System-ID and all services connected with it!\n";
831	daniel-mar	1435	$cont .= "// If multiple systems access the same database, then this file must be synchronous\n";
		1436	$cont .= "// between all systems, otherwise you will lose your system ID, too!\n";
830	daniel-mar	1437	$cont .= "\$passphrase = '$passphrase';\n";
		1438	$cont .= "// End of file\n";
		1439
		1440	@file_put_contents($file, $cont);
		1441	}
		1442
		1443	private static function getPrivKeyPassphrase() {
		1444	$file = self::getPrivKeyPassphraseFilename();
		1445	if (!file_exists($file)) return false;
		1446	$cont = file_get_contents($file);
		1447	$m = array();
		1448	if (!preg_match("@'(.+)'@isU", $cont, $m)) return false;
		1449	return $m[1];
		1450	}
		1451
		1452	public static function getSystemPrivateKey() {
227	daniel-mar	1453	$privKey = OIDplus::config()->getValue('oidplus_private_key');
830	daniel-mar	1454	if ($privKey == '') return false;
		1455
		1456	$passphrase = self::getPrivKeyPassphrase();
		1457	if ($passphrase !== false) {
		1458	$privKey = decrypt_private_key($privKey, $passphrase);
		1459	}
		1460
		1461	if (is_privatekey_encrypted($privKey)) {
		1462	// This can happen if the key file has vanished
		1463	return false;
		1464	}
		1465
		1466	return $privKey;
		1467	}
		1468
		1469	public static function getSystemPublicKey() {
227	daniel-mar	1470	$pubKey = OIDplus::config()->getValue('oidplus_public_key');
830	daniel-mar	1471	if ($pubKey == '') return false;
		1472	return $pubKey;
		1473	}
227	daniel-mar	1474
830	daniel-mar	1475	public static function getPkiStatus($try_generate=false) {
		1476	if (!function_exists('openssl_pkey_new')) return false;
227	daniel-mar	1477
830	daniel-mar	1478	if ($try_generate) {
		1479	// For debug purposes: Invalidate current key once:
		1480	//OIDplus::config()->setValue('oidplus_private_key', '');
256	daniel-mar	1481
830	daniel-mar	1482	$privKey = OIDplus::getSystemPrivateKey();
		1483	$pubKey = OIDplus::getSystemPublicKey();
		1484	if (!verify_private_public_key($privKey, $pubKey)) {
		1485	if ($pubKey) {
		1486	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.");
		1487	}
227	daniel-mar	1488
830	daniel-mar	1489	$pkey_config = array(
		1490	"digest_alg" => "sha512",
		1491	"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
		1492	"private_key_type" => OPENSSL_KEYTYPE_RSA,
		1493	"config" => OIDplus::getOpenSslCnf()
		1494	);
227	daniel-mar	1495
830	daniel-mar	1496	// Create the private and public key
		1497	$res = openssl_pkey_new($pkey_config);
		1498	if ($res === false) return false;
239	daniel-mar	1499
830	daniel-mar	1500	// Extract the private key from $res to $privKey
		1501	if (openssl_pkey_export($res, $privKey, null, $pkey_config) === false) return false;
227	daniel-mar	1502
830	daniel-mar	1503	// Extract the public key from $res to $pubKey
		1504	$tmp = openssl_pkey_get_details($res);
		1505	if ($tmp === false) return false;
		1506	$pubKey = $tmp["key"];
		1507
		1508	// encrypt new keys using a passphrase stored in a secret file
		1509	self::tryCreatePrivKeyPassphrase(); // try (re)generate this file
		1510	$passphrase = self::getPrivKeyPassphrase();
		1511	if ($passphrase !== false) {
		1512	$privKey = encrypt_private_key($privKey, $passphrase);
		1513	}
		1514
		1515	// Calculate the system ID from the public key
		1516	$system_id = self::getSystemIdFromPubKey($pubKey);
		1517	if ($system_id !== false) {
		1518	// Save the key pair to database
		1519	OIDplus::config()->setValue('oidplus_private_key', $privKey);
		1520	OIDplus::config()->setValue('oidplus_public_key', $pubKey);
		1521
		1522	// Log the new system ID
		1523	OIDplus::logger()->log("[INFO]A!", "A new private/public key-pair for your system had been generated. Your SystemID is now $system_id");
		1524	}
		1525	} else {
		1526	$passphrase = self::getPrivKeyPassphrase();
831	daniel-mar	1527	$rawPrivKey = OIDplus::config()->getValue('oidplus_private_key');
		1528	if (($passphrase === false) \|\| !is_privatekey_encrypted($rawPrivKey)) {
830	daniel-mar	1529	// Upgrade to new encrypted keys
		1530	self::tryCreatePrivKeyPassphrase(); // try generate this file
		1531	$passphrase = self::getPrivKeyPassphrase();
		1532	if ($passphrase !== false) {
		1533	$privKey = encrypt_private_key($privKey, $passphrase);
		1534	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());
		1535	OIDplus::config()->setValue('oidplus_private_key', $privKey);
		1536	}
		1537	}
227	daniel-mar	1538	}
		1539	}
		1540
830	daniel-mar	1541	$privKey = OIDplus::getSystemPrivateKey();
		1542	$pubKey = OIDplus::getSystemPublicKey();
227	daniel-mar	1543	return verify_private_public_key($privKey, $pubKey);
		1544	}
		1545
170	daniel-mar	1546	public static function getInstallType() {
486	daniel-mar	1547	$counter = 0;
		1548
661	daniel-mar	1549	if ($new_version_file_exists = file_exists(OIDplus::localpath().'.version.php')) {
486	daniel-mar	1550	$counter++;
591	daniel-mar	1551	}
661	daniel-mar	1552	if ($old_version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) {
		1553	$counter++;
		1554	}
		1555	$version_file_exists = $old_version_file_exists \| $new_version_file_exists;
681	daniel-mar	1556	if ($svn_dir_exists = (is_dir(OIDplus::localpath().'.svn') \|\|
		1557	is_dir(OIDplus::localpath().'../.svn'))) { // in case we checked out the root instead of the "trunk"
486	daniel-mar	1558	$counter++;
591	daniel-mar	1559	}
681	daniel-mar	1560	// if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) {
698	daniel-mar	1561	if ($git_dir_exists = (OIDplus::findGitFolder() !== false)) {
486	daniel-mar	1562	$counter++;
591	daniel-mar	1563	}
486	daniel-mar	1564
		1565	if ($counter === 0) {
360	daniel-mar	1566	return 'unknown'; // do not translate
170	daniel-mar	1567	}
591	daniel-mar	1568	else if ($counter > 1) {
360	daniel-mar	1569	return 'ambigous'; // do not translate
170	daniel-mar	1570	}
591	daniel-mar	1571	else if ($svn_dir_exists) {
360	daniel-mar	1572	return 'svn-wc'; // do not translate
170	daniel-mar	1573	}
591	daniel-mar	1574	else if ($git_dir_exists) {
486	daniel-mar	1575	return 'git-wc'; // do not translate
		1576	}
591	daniel-mar	1577	else if ($version_file_exists) {
360	daniel-mar	1578	return 'svn-snapshot'; // do not translate
170	daniel-mar	1579	}
		1580	}
		1581
412	daniel-mar	1582	private static function recognizeVersion() {
		1583	try {
		1584	$ver_prev = OIDplus::config()->getValue("last_known_version");
		1585	$ver_now = OIDplus::getVersion();
		1586	if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
455	daniel-mar	1587	// 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	1588	OIDplus::logger()->log("[INFO]A!", "Detected system version change from '$ver_prev' to '$ver_now'");
856	daniel-mar	1589
		1590	// Just to be sure, recanonize objects (we don't do it at every page visit due to performance reasons)
857	daniel-mar	1591	self::recanonizeObjects();
412	daniel-mar	1592	}
		1593	OIDplus::config()->setValue("last_known_version", $ver_now);
1050	daniel-mar	1594	} catch (\Exception $e) {
412	daniel-mar	1595	}
		1596	}
		1597
111	daniel-mar	1598	public static function getVersion() {
412	daniel-mar	1599	static $cachedVersion = null;
		1600	if (!is_null($cachedVersion)) {
		1601	return $cachedVersion;
		1602	}
		1603
486	daniel-mar	1604	$installType = OIDplus::getInstallType();
		1605
		1606	if ($installType === 'svn-wc') {
496	daniel-mar	1607	$ver = get_svn_revision(OIDplus::localpath());
486	daniel-mar	1608	if ($ver)
		1609	return ($cachedVersion = 'svn-'.$ver);
558	daniel-mar	1610	$ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk"
		1611	if ($ver)
		1612	return ($cachedVersion = 'svn-'.$ver);
111	daniel-mar	1613	}
162	daniel-mar	1614
486	daniel-mar	1615	if ($installType === 'git-wc') {
698	daniel-mar	1616	$ver = OIDplus::getGitsvnRevision(OIDplus::localpath());
486	daniel-mar	1617	if ($ver)
		1618	return ($cachedVersion = 'svn-'.$ver);
162	daniel-mar	1619	}
		1620
486	daniel-mar	1621	if ($installType === 'svn-snapshot') {
661	daniel-mar	1622	$cont = '';
		1623	if (file_exists($filename = OIDplus::localpath().'oidplus_version.txt'))
		1624	$cont = file_get_contents($filename);
		1625	if (file_exists($filename = OIDplus::localpath().'.version.php'))
		1626	$cont = file_get_contents($filename);
386	daniel-mar	1627	$m = array();
360	daniel-mar	1628	if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
412	daniel-mar	1629	return ($cachedVersion = 'svn-'.$m[1]); // do not translate
162	daniel-mar	1630	}
		1631
486	daniel-mar	1632	return ($cachedVersion = false); // version ambigous or unknown
111	daniel-mar	1633	}
		1634
974	daniel-mar	1635	const ENFORCE_SSL_NO = 0;
		1636	const ENFORCE_SSL_YES = 1;
		1637	const ENFORCE_SSL_AUTO = 2;
230	daniel-mar	1638	private static $sslAvailableCache = null;
		1639	public static function isSslAvailable() {
		1640	if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
256	daniel-mar	1641
495	daniel-mar	1642	if (PHP_SAPI == 'cli') {
230	daniel-mar	1643	self::$sslAvailableCache = false;
		1644	return false;
		1645	}
		1646
49	daniel-mar	1647	$timeout = 2;
580	daniel-mar	1648	$already_ssl = self::isSSL();
80	daniel-mar	1649	$ssl_port = 443;
1059	daniel-mar	1650	$host_with_port = $_SERVER['HTTP_HOST'];
		1651	$host_no_port = explode(':',$host_with_port)[0];
		1652	$host_ssl = $host_no_port . ($ssl_port != 443 ? ':'.$ssl_port : '');
42	daniel-mar	1653
974	daniel-mar	1654	if ($already_ssl) {
1059	daniel-mar	1655	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, true/allowJS/, null/samesite/, true/forceInsecure/);
974	daniel-mar	1656	self::$sslAvailableCache = true;
		1657	return true;
		1658	} else {
		1659	if (isset($_COOKIE['SSL_CHECK']) && ($_COOKIE['SSL_CHECK'] == '1')) {
		1660	// The cookie "SSL_CHECK" is set once a website was loaded with HTTPS.
		1661	// It forces subsequent HTTP calls to redirect to HTTPS (like HSTS).
		1662	// The reason is the following problem:
		1663	// If you open the page with HTTPS first, then the CSRF token cookies will get the "secure" flag
		1664	// If you open the page then with HTTP, the HTTP cannot access the secure CSRF cookies,
		1665	// Chrome will then block "Set-Cookie" since the HTTP cookie would overwrite the HTTPS cookie.
1059	daniel-mar	1666	// So we MUST redirect, even if the Mode is ENFORCE_SSL_NO.
974	daniel-mar	1667	// Note: SSL_CHECK is NOT a replacement for HSTS! You should use HSTS,
1059	daniel-mar	1668	// because on there your browser ensures that HTTPS is called, before the server
		1669	// is even contacted (and therefore, no HTTP connection can be hacked).
974	daniel-mar	1670	$mode = OIDplus::ENFORCE_SSL_YES;
		1671	} else {
		1672	$mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', OIDplus::ENFORCE_SSL_AUTO);
		1673	}
261	daniel-mar	1674
974	daniel-mar	1675	if ($mode == OIDplus::ENFORCE_SSL_NO) {
		1676	// No SSL available
		1677	self::$sslAvailableCache = false;
		1678	return false;
		1679	} else if ($mode == OIDplus::ENFORCE_SSL_YES) {
		1680	// Force SSL
1059	daniel-mar	1681	$location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
80	daniel-mar	1682	header('Location:'.$location);
360	daniel-mar	1683	die(_L('Redirecting to HTTPS...'));
974	daniel-mar	1684	} else if ($mode == OIDplus::ENFORCE_SSL_AUTO) {
		1685	// Automatic SSL detection
80	daniel-mar	1686	if (isset($_COOKIE['SSL_CHECK'])) {
		1687	// We already had the HTTPS detection done before.
974	daniel-mar	1688	if ($_COOKIE['SSL_CHECK'] == '1') {
80	daniel-mar	1689	// HTTPS was detected before, but we are HTTP. Redirect now
1059	daniel-mar	1690	$location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
80	daniel-mar	1691	header('Location:'.$location);
360	daniel-mar	1692	die(_L('Redirecting to HTTPS...'));
80	daniel-mar	1693	} else {
		1694	// No HTTPS available. Do nothing.
230	daniel-mar	1695	self::$sslAvailableCache = false;
80	daniel-mar	1696	return false;
		1697	}
49	daniel-mar	1698	} else {
80	daniel-mar	1699	// This is our first check (or the browser didn't accept the SSL_CHECK cookie)
386	daniel-mar	1700	$errno = -1;
		1701	$errstr = '';
1059	daniel-mar	1702	if (@fsockopen($host_no_port, $ssl_port, $errno, $errstr, $timeout)) {
80	daniel-mar	1703	// HTTPS detected. Redirect now, and remember that we had detected HTTPS
1059	daniel-mar	1704	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, true/allowJS/, null/samesite/, true/forceInsecure/);
		1705	$location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
80	daniel-mar	1706	header('Location:'.$location);
360	daniel-mar	1707	die(_L('Redirecting to HTTPS...'));
80	daniel-mar	1708	} else {
		1709	// No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
1059	daniel-mar	1710	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, true/allowJS/, null/samesite/, true/forceInsecure/);
230	daniel-mar	1711	self::$sslAvailableCache = false;
80	daniel-mar	1712	return false;
		1713	}
49	daniel-mar	1714	}
42	daniel-mar	1715	}
		1716	}
		1717	}
497	daniel-mar	1718
496	daniel-mar	1719	/**
		1720	* Gets a local path pointing to a resource
		1721	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
		1722	* @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
590	daniel-mar	1723	* @return string\|false The local path, with guaranteed trailing path delimiter for directories
496	daniel-mar	1724	*/
		1725	public static function localpath($target=null, $relative=false) {
		1726	if (is_null($target)) {
		1727	$target = __DIR__.'/../../';
		1728	}
241	daniel-mar	1729
496	daniel-mar	1730	if ($relative) {
		1731	// First, try to find out how many levels we need to go up
		1732	$steps_up = self::getExecutingScriptPathDepth();
		1733	if ($steps_up === false) return false;
497	daniel-mar	1734
496	daniel-mar	1735	// Virtually go back from the executing PHP script to the OIDplus base path
		1736	$res = str_repeat('../',$steps_up);
497	daniel-mar	1737
496	daniel-mar	1738	// Then go to the desired location
		1739	$basedir = realpath(__DIR__.'/../../');
		1740	$target = realpath($target);
500	daniel-mar	1741	if ($target === false) return false;
496	daniel-mar	1742	$res .= substr($target, strlen($basedir)+1);
		1743	$res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
		1744	} else {
		1745	$res = realpath($target);
241	daniel-mar	1746	}
497	daniel-mar	1747
801	daniel-mar	1748	if (is_dir($target)) $res .= '/';
497	daniel-mar	1749
801	daniel-mar	1750	$res = str_replace('/', DIRECTORY_SEPARATOR, $res);
		1751
496	daniel-mar	1752	return $res;
241	daniel-mar	1753	}
355	daniel-mar	1754
496	daniel-mar	1755	/**
		1756	* Gets a URL pointing to a resource
		1757	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
806	daniel-mar	1758	* @param int\|boolean $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
		1759	* PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
		1760	* results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
		1761	* but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
590	daniel-mar	1762	* @return string\|false The URL, with guaranteed trailing path delimiter for directories
496	daniel-mar	1763	*/
806	daniel-mar	1764	public static function webpath($target=null, $mode=self::PATH_ABSOLUTE_CANONICAL) {
801	daniel-mar	1765	// backwards compatibility
		1766	if ($mode === true) $mode = self::PATH_RELATIVE;
		1767	if ($mode === false) $mode = self::PATH_ABSOLUTE;
		1768
811	daniel-mar	1769	if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT) {
812	daniel-mar	1770	$tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE);
		1771	if ($tmp === false) return false;
		1772	$tmp = parse_url($tmp);
		1773	if ($tmp === false) return false;
		1774	if (!isset($tmp['path'])) return false;
		1775	return $tmp['path'];
811	daniel-mar	1776	}
		1777
812	daniel-mar	1778	if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT_CANONICAL) {
		1779	$tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE_CANONICAL);
		1780	if ($tmp === false) return false;
		1781	$tmp = parse_url($tmp);
		1782	if ($tmp === false) return false;
		1783	if (!isset($tmp['path'])) return false;
		1784	return $tmp['path'];
		1785	}
		1786
801	daniel-mar	1787	$res = self::getSystemUrl($mode); // Note: already contains a trailing path delimiter
778	daniel-mar	1788	if ($res === false) return false;
497	daniel-mar	1789
496	daniel-mar	1790	if (!is_null($target)) {
		1791	$basedir = realpath(__DIR__.'/../../');
		1792	$target = realpath($target);
500	daniel-mar	1793	if ($target === false) return false;
496	daniel-mar	1794	$tmp = substr($target, strlen($basedir)+1);
500	daniel-mar	1795	$res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
497	daniel-mar	1796	if (is_dir($target)) $res .= '/';
496	daniel-mar	1797	}
497	daniel-mar	1798
496	daniel-mar	1799	return $res;
		1800	}
497	daniel-mar	1801
778	daniel-mar	1802	public static function canonicalURL() {
		1803	// First part: OIDplus system URL (or canonical system URL)
801	daniel-mar	1804	$sysurl = OIDplus::getSystemUrl(self::PATH_ABSOLUTE_CANONICAL);
778	daniel-mar	1805
		1806	// Second part: Directory
		1807	$basedir = realpath(__DIR__.'/../../');
		1808	$target = realpath('.');
		1809	if ($target === false) return false;
		1810	$tmp = substr($target, strlen($basedir)+1);
		1811	$res = str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
780	daniel-mar	1812	if (is_dir($target) && ($res != '')) $res .= '/';
778	daniel-mar	1813
		1814	// Third part: File name
		1815	$tmp = explode('/',$_SERVER['SCRIPT_NAME']);
		1816	$tmp = end($tmp);
		1817
		1818	// Fourth part: Query string (ordered)
		1819	$tmp2 = getSortedQuery();
		1820	if ($tmp2 != '') $tmp2 = '?'.$tmp2;
		1821
		1822	return $sysurl.$res.$tmp.$tmp2;
		1823	}
		1824
639	daniel-mar	1825	private static $shutdown_functions = array();
		1826	public static function register_shutdown_function($func) {
		1827	self::$shutdown_functions[] = $func;
		1828	}
		1829
		1830	public static function invoke_shutdown() {
		1831	foreach (self::$shutdown_functions as $func) {
		1832	$func();
		1833	}
		1834	}
		1835
360	daniel-mar	1836	public static function getAvailableLangs() {
		1837	$langs = array();
		1838	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1839	$code = $pluginManifest->getLanguageCode();
360	daniel-mar	1840	$langs[] = $code;
		1841	}
		1842	return $langs;
		1843	}
		1844
1041	daniel-mar	1845	public static function getDefaultLang() {
		1846	static $thrownOnce = false; // avoid endless loop inside OIDplusConfigInitializationException
		1847
1049	daniel-mar	1848	$lang = self::baseConfig()->getValue('DEFAULT_LANGUAGE', 'enus');
1041	daniel-mar	1849
		1850	if (!in_array($lang,self::getAvailableLangs())) {
		1851	if (!$thrownOnce) {
		1852	$thrownOnce = true;
1048	daniel-mar	1853	throw new OIDplusConfigInitializationException(_L('DEFAULT_LANGUAGE points to an invalid language plugin. (Consider setting to "enus" = "English USA".)'));
1041	daniel-mar	1854	} else {
		1855	return 'enus';
		1856	}
		1857	}
		1858
		1859	return $lang;
		1860	}
		1861
355	daniel-mar	1862	public static function getCurrentLang() {
360	daniel-mar	1863	if (isset($_GET['lang'])) {
		1864	$lang = $_GET['lang'];
		1865	} else if (isset($_POST['lang'])) {
		1866	$lang = $_POST['lang'];
		1867	} else if (isset($_COOKIE['LANGUAGE'])) {
		1868	$lang = $_COOKIE['LANGUAGE'];
		1869	} else {
1041	daniel-mar	1870	$lang = self::getDefaultLang();
360	daniel-mar	1871	}
		1872	$lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
355	daniel-mar	1873	return $lang;
		1874	}
		1875
362	daniel-mar	1876	public static function handleLangArgument() {
		1877	if (isset($_GET['lang'])) {
		1878	// The "?lang=" argument is only for NoScript-Browsers/SearchEngines
		1879	// In case someone who has JavaScript clicks a ?lang= link, they should get
		1880	// the page in that language, but the cookie must be set, otherwise
		1881	// the menu and other stuff would be in their cookie-based-language and not the
		1882	// argument-based-language.
557	daniel-mar	1883	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1884	} else if (isset($_POST['lang'])) {
557	daniel-mar	1885	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1886	}
		1887	}
		1888
468	daniel-mar	1889	private static $translationArray = array();
469	daniel-mar	1890	protected static function getTranslationFileContents($translation_file) {
		1891	// First, try the cache
481	daniel-mar	1892	$cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
469	daniel-mar	1893	if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
		1894	$cac = @unserialize(file_get_contents($cache_file));
		1895	if ($cac) return $cac;
		1896	}
481	daniel-mar	1897
469	daniel-mar	1898	// If not successful, then load the XML file
		1899	$xml = @simplexml_load_string(file_get_contents($translation_file));
		1900	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
		1901	$cac = array();
		1902	foreach ($xml->message as $msg) {
		1903	$src = trim($msg->source->__toString());
		1904	$dst = trim($msg->target->__toString());
		1905	$cac[$src] = $dst;
		1906	}
		1907	@file_put_contents($cache_file,serialize($cac));
		1908	@touch($cache_file,filemtime($translation_file));
		1909	return $cac;
		1910	}
468	daniel-mar	1911	public static function getTranslationArray($requested_lang='*') {
362	daniel-mar	1912	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1913	$lang = $pluginManifest->getLanguageCode();
362	daniel-mar	1914	if (strpos($lang,'/') !== false) continue; // just to be sure
		1915	if (strpos($lang,'\\') !== false) continue; // just to be sure
		1916	if (strpos($lang,'..') !== false) continue; // just to be sure
401	daniel-mar	1917
468	daniel-mar	1918	if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
401	daniel-mar	1919
468	daniel-mar	1920	if (!isset(self::$translationArray[$lang])) {
		1921	self::$translationArray[$lang] = array();
		1922
		1923	$wildcard = $pluginManifest->getLanguageMessages();
		1924	if (strpos($wildcard,'/') !== false) continue; // just to be sure
		1925	if (strpos($wildcard,'\\') !== false) continue; // just to be sure
		1926	if (strpos($wildcard,'..') !== false) continue; // just to be sure
		1927
635	daniel-mar	1928	$translation_files = glob(__DIR__.'/../../plugins/'.'*'.'/language/'.$lang.'/'.$wildcard);
468	daniel-mar	1929	sort($translation_files);
		1930	foreach ($translation_files as $translation_file) {
		1931	if (!file_exists($translation_file)) continue;
469	daniel-mar	1932	$cac = self::getTranslationFileContents($translation_file);
		1933	foreach ($cac as $src => $dst) {
		1934	self::$translationArray[$lang][$src] = $dst;
468	daniel-mar	1935	}
401	daniel-mar	1936	}
362	daniel-mar	1937	}
		1938	}
468	daniel-mar	1939	return self::$translationArray;
362	daniel-mar	1940	}
		1941
699	daniel-mar	1942	public static function getEditionInfo() {
		1943	return @parse_ini_file(__DIR__.'/../edition.ini', true)['Edition'];
		1944	}
		1945
698	daniel-mar	1946	public static function findGitFolder() {
		1947	// Git command line saves git information in folder ".git"
		1948	// Plesk git saves git information in folder "../../../git/oidplus/" (or similar)
727	daniel-mar	1949	$dir = OIDplus::localpath();
698	daniel-mar	1950	if (is_dir($dir.'/.git')) return $dir.'/.git';
		1951	$i = 0;
		1952	do {
		1953	if (is_dir($dir.'/git')) {
719	daniel-mar	1954	$confs = @glob($dir.'/git/'.'*'.'/config');
		1955	if ($confs) foreach ($confs as $conf) {
698	daniel-mar	1956	$cont = file_get_contents($conf);
699	daniel-mar	1957	if (isset(OIDplus::getEditionInfo()['gitrepo']) && (OIDplus::getEditionInfo()['gitrepo'] != '') && (strpos($cont, OIDplus::getEditionInfo()['gitrepo']) !== false)) {
698	daniel-mar	1958	return dirname($conf);
		1959	}
		1960	}
		1961	}
		1962	$i++;
719	daniel-mar	1963	} while (($i<100) && ($dir != ($new_dir = @realpath($dir.'/../'))) && ($dir = $new_dir));
698	daniel-mar	1964	return false;
		1965	}
		1966
		1967	public static function getGitsvnRevision($dir='') {
		1968	try {
		1969	// tries command line and binary parsing
699	daniel-mar	1970	// requires vendor/danielmarschall/git_utils.inc.php
698	daniel-mar	1971	$git_dir = OIDplus::findGitFolder();
		1972	if ($git_dir === false) return false;
		1973	$commit_msg = git_get_latest_commit_message($git_dir);
1050	daniel-mar	1974	} catch (\Exception $e) {
698	daniel-mar	1975	return false;
		1976	}
		1977
		1978	$m = array();
		1979	if (preg_match('%git-svn-id: (.+)@(\\d+) %ismU', $commit_msg, $m)) {
		1980	return $m[2];
		1981	} else {
		1982	return false;
		1983	}
		1984	}
		1985
775	daniel-mar	1986	public static function prefilterQuery($static_node_id, $throw_exception) {
		1987	// Let namespace be case-insensitive
		1988	$ary = explode(':', $static_node_id, 2);
		1989	$ary[0] = strtolower($ary[0]);
		1990	$static_node_id = implode(':', $ary);
		1991
889	daniel-mar	1992	// Ask plugins if they want to change the node id
		1993	foreach (OIDplus::getObjectTypePluginsEnabled() as $plugin) {
		1994	$static_node_id = $plugin->prefilterQuery($static_node_id, $throw_exception);
775	daniel-mar	1995	}
		1996
		1997	return $static_node_id;
		1998	}
849	daniel-mar	1999
		2000	public static function isCronjob() {
		2001	return explode('.',basename($_SERVER['SCRIPT_NAME']))[0] === 'cron';
		2002	}
856	daniel-mar	2003
857	daniel-mar	2004	private static function recanonizeObjects() {
1050	daniel-mar	2005	//
		2006	// Since OIDplus svn-184, entries in the database need to have a canonical ID
		2007	// If the ID is not canonical (e.g. GUIDs missing hyphens), the object cannot be opened in OIDplus
		2008	// This script re-canonizes the object IDs if required.
		2009	// In SVN Rev 856, the canonization for GUID, IPv4 and IPv6 have changed, requiring another
		2010	// re-canonization
		2011	//
856	daniel-mar	2012	$res = OIDplus::db()->query("select id from ###objects");
		2013	while ($row = $res->fetch_array()) {
		2014	$ida = $row['id'];
857	daniel-mar	2015	$obj = OIDplusObject::parse($ida);
		2016	if (!$obj) continue;
		2017	$idb = $obj->nodeId();
856	daniel-mar	2018	if (($idb) && ($ida != $idb)) {
		2019	OIDplus::db()->transaction_begin();
		2020	OIDplus::db()->query("update ###objects set id = ? where id = ?", array($idb, $ida));
		2021	OIDplus::db()->query("update ###asn1id set oid = ? where oid = ?", array($idb, $ida));
		2022	OIDplus::db()->query("update ###iri set oid = ? where oid = ?", array($idb, $ida));
		2023	OIDplus::db()->query("update ###log_object set id = ? where id = ?", array($idb, $ida));
		2024	OIDplus::logger()->log("[INFO]A!", "Object name '$ida' has been changed to '$idb' during re-canonization");
		2025	OIDplus::db()->transaction_commit();
978	daniel-mar	2026	OIDplusObject::resetObjectInformationCache();
856	daniel-mar	2027	}
		2028	}
		2029	}
		2030
374	daniel-mar	2031	}

Subversion Repositories oidplus

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