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

Subversion Repositories oidplus

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