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

Subversion Repositories oidplus

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