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

Subversion Repositories oidplus

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