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
511	daniel-mar	5	* Copyright 2019 - 2021 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
2	daniel-mar	22	class OIDplus {
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();
274	daniel-mar	30	private static /OIDplusSqlSlangPlugin[]/ $sqlSlangPlugins = array();
355	daniel-mar	31	private static /OIDplusLanguagePlugin[]/ $languagePlugins = array();
449	daniel-mar	32	private static /OIDplusDesignPlugin[]/ $designPlugins = array();
2	daniel-mar	33
280	daniel-mar	34	protected static $html = true;
236	daniel-mar	35
362	daniel-mar	36	/public/ const DEFAULT_LANGUAGE = 'enus'; // the language of the source code
355	daniel-mar	37
2	daniel-mar	38	private function __construct() {
		39	}
295	daniel-mar	40
263	daniel-mar	41	# --- Static classes
274	daniel-mar	42
263	daniel-mar	43	private static $baseConfig = null;
		44	private static $old_config_format = false;
261	daniel-mar	45	public static function baseConfig() {
263	daniel-mar	46	$first_init = false;
274	daniel-mar	47
263	daniel-mar	48	if ($first_init = is_null(self::$baseConfig)) {
		49	self::$baseConfig = new OIDplusBaseConfig();
261	daniel-mar	50	}
		51
263	daniel-mar	52	if ($first_init) {
261	daniel-mar	53	// Include a file containing various size/depth limitations of OIDs
294	daniel-mar	54	// It is important to include it before userdata/baseconfig/config.inc.php was included,
		55	// so we can give userdata/baseconfig/config.inc.php the chance to override the values.
261	daniel-mar	56
496	daniel-mar	57	include OIDplus::localpath().'includes/oidplus_limits.inc.php';
261	daniel-mar	58
		59	// Include config file
295	daniel-mar	60
496	daniel-mar	61	$config_file = OIDplus::localpath() . 'userdata/baseconfig/config.inc.php';
		62	$config_file_old = OIDplus::localpath() . 'includes/config.inc.php'; // backwards compatibility
295	daniel-mar	63
294	daniel-mar	64	if (!file_exists($config_file) && file_exists($config_file_old)) {
		65	$config_file = $config_file_old;
		66	}
261	daniel-mar	67
294	daniel-mar	68	if (file_exists($config_file)) {
263	daniel-mar	69	if (self::$old_config_format) {
		70	// Note: We may only include it once due to backwards compatibility,
		71	// since in version 2.0, the configuration was defined using define() statements
		72	// Attention: This does mean that a full re-init (e.g. for test cases) is not possible
		73	// if a version 2.0 config is used!
294	daniel-mar	74	include_once $config_file;
263	daniel-mar	75	} else {
294	daniel-mar	76	include $config_file;
263	daniel-mar	77	}
261	daniel-mar	78
		79	if (defined('OIDPLUS_CONFIG_VERSION') && (OIDPLUS_CONFIG_VERSION == 2.0)) {
263	daniel-mar	80	self::$old_config_format = true;
274	daniel-mar	81
261	daniel-mar	82	// Backwards compatibility 2.0 => 2.1
		83	foreach (get_defined_constants(true)['user'] as $name => $value) {
		84	$name = str_replace('OIDPLUS_', '', $name);
		85	if ($name == 'SESSION_SECRET') $name = 'SERVER_SECRET';
		86	if ($name == 'MYSQL_QUERYLOG') $name = 'QUERY_LOGFILE';
		87	if (($name == 'MYSQL_PASSWORD') \|\| ($name == 'ODBC_PASSWORD') \|\| ($name == 'PDO_PASSWORD') \|\| ($name == 'PGSQL_PASSWORD')) {
263	daniel-mar	88	self::$baseConfig->setValue($name, base64_decode($value));
261	daniel-mar	89	} else {
		90	if ($name == 'CONFIG_VERSION') $value = 2.1;
263	daniel-mar	91	self::$baseConfig->setValue($name, $value);
261	daniel-mar	92	}
		93	}
		94	}
		95	} else {
496	daniel-mar	96	if (!is_dir(OIDplus::localpath().'setup')) {
360	daniel-mar	97	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	98	} else {
280	daniel-mar	99	if (self::$html) {
496	daniel-mar	100	if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,true).'setup/') !== 0) {
		101	header('Location:'.OIDplus::webpath().'setup/');
360	daniel-mar	102	die(_L('Redirecting to setup...'));
349	daniel-mar	103	} else {
		104	return self::$baseConfig;
		105	}
261	daniel-mar	106	} else {
		107	// This can be displayed in e.g. ajax.php
360	daniel-mar	108	throw new OIDplusConfigInitializationException(_L('File %1 is missing. Please run setup again.','userdata/baseconfig/config.inc.php'));
261	daniel-mar	109	}
		110	}
		111	}
		112
		113	// Check important config settings
		114
263	daniel-mar	115	if (self::$baseConfig->getValue('CONFIG_VERSION') != 2.1) {
503	daniel-mar	116	if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,true).'setup/') !== 0) {
		117	throw new OIDplusConfigInitializationException(_L("The information located in %1 is outdated.",realpath($config_file)));
		118	}
261	daniel-mar	119	}
		120
263	daniel-mar	121	if (self::$baseConfig->getValue('SERVER_SECRET', '') === '') {
503	daniel-mar	122	if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,true).'setup/') !== 0) {
		123	throw new OIDplusConfigInitializationException(_L("You must set a value for SERVER_SECRET in %1 for the system to operate secure.",realpath($config_file)));
		124	}
261	daniel-mar	125	}
		126	}
		127
263	daniel-mar	128	return self::$baseConfig;
261	daniel-mar	129	}
		130
263	daniel-mar	131	private static $config = null;
2	daniel-mar	132	public static function config() {
263	daniel-mar	133	if ($first_init = is_null(self::$config)) {
		134	self::$config = new OIDplusConfig();
2	daniel-mar	135	}
263	daniel-mar	136
		137	if ($first_init) {
		138	// These are important settings for base functionalities and therefore are not inside plugins
		139	self::$config->prepareConfigKey('system_title', 'What is the name of your RA?', 'OIDplus 2.0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
		140	if (empty($value)) {
360	daniel-mar	141	throw new OIDplusException(_L('Please enter a value for the system title.'));
263	daniel-mar	142	}
		143	});
		144	self::$config->prepareConfigKey('admin_email', 'E-Mail address of the system administrator', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
		145	if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
360	daniel-mar	146	throw new OIDplusException(_L('This is not a correct email address'));
263	daniel-mar	147	}
		148	});
		149	self::$config->prepareConfigKey('global_cc', 'Global CC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
		150	if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
360	daniel-mar	151	throw new OIDplusException(_L('This is not a correct email address'));
263	daniel-mar	152	}
		153	});
		154	self::$config->prepareConfigKey('objecttypes_initialized', 'List of object type plugins that were initialized once', '', OIDplusConfig::PROTECTION_READONLY, function($value) {
		155	// Nothing here yet
		156	});
		157	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) {
		158	# 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?
		159
		160	$ary = explode(';',$value);
		161	$uniq_ary = array_unique($ary);
		162
		163	if (count($ary) != count($uniq_ary)) {
360	daniel-mar	164	throw new OIDplusException(_L('Please check your input. Some object types are double.'));
263	daniel-mar	165	}
		166
		167	foreach ($ary as $ot_check) {
		168	$ns_found = false;
		169	foreach (OIDplus::getEnabledObjectTypes() as $ot) {
		170	if ($ot::ns() == $ot_check) {
		171	$ns_found = true;
		172	break;
		173	}
		174	}
		175	foreach (OIDplus::getDisabledObjectTypes() as $ot) {
		176	if ($ot::ns() == $ot_check) {
		177	$ns_found = true;
		178	break;
		179	}
		180	}
		181	if (!$ns_found) {
360	daniel-mar	182	throw new OIDplusException(_L('Please check your input. Namespace "%1" is not found',$ot_check));
263	daniel-mar	183	}
		184	}
		185	});
		186	self::$config->prepareConfigKey('oidplus_private_key', 'Private key for this system', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
		187	// Nothing here yet
		188	});
		189	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) {
		190	// Nothing here yet
		191	});
324	daniel-mar	192	self::$config->prepareConfigKey('last_known_system_url', 'Last known System URL', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
		193	// Nothing here yet
		194	});
412	daniel-mar	195	self::$config->prepareConfigKey('last_known_version', 'Last known OIDplus Version', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
		196	// Nothing here yet
		197	});
456	daniel-mar	198	self::$config->prepareConfigKey('default_ra_auth_method', 'Default auth method used for generating password of RAs (must exist in plugins/auth/)?', 'A3_bcrypt', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
453	daniel-mar	199	$good = true;
		200	if (strpos($value,'/') !== false) $good = false;
		201	if (strpos($value,'\\') !== false) $good = false;
		202	if (strpos($value,'..') !== false) $good = false;
		203	if (!$good) {
		204	throw new OIDplusException(_L('Invalid auth plugin folder name. Do only enter a folder name, not an absolute or relative path'));
		205	}
		206
496	daniel-mar	207	if (!is_dir(OIDplus::localpath().'plugins/auth/'.$value)) {
453	daniel-mar	208	throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$value,'plugins/auth/'));
		209	}
		210	});
263	daniel-mar	211	}
		212
		213	return self::$config;
2	daniel-mar	214	}
		215
263	daniel-mar	216	private static $gui = null;
2	daniel-mar	217	public static function gui() {
263	daniel-mar	218	if (is_null(self::$gui)) {
		219	self::$gui = new OIDplusGui();
86	daniel-mar	220	}
263	daniel-mar	221	return self::$gui;
2	daniel-mar	222	}
		223
263	daniel-mar	224	private static $authUtils = null;
2	daniel-mar	225	public static function authUtils() {
263	daniel-mar	226	if (is_null(self::$authUtils)) {
		227	self::$authUtils = new OIDplusAuthUtils();
86	daniel-mar	228	}
263	daniel-mar	229	return self::$authUtils;
2	daniel-mar	230	}
		231
263	daniel-mar	232	private static $mailUtils = null;
250	daniel-mar	233	public static function mailUtils() {
263	daniel-mar	234	if (is_null(self::$mailUtils)) {
		235	self::$mailUtils = new OIDplusMailUtils();
250	daniel-mar	236	}
263	daniel-mar	237	return self::$mailUtils;
250	daniel-mar	238	}
		239
557	daniel-mar	240	private static $cookieUtils = null;
		241	public static function cookieUtils() {
		242	if (is_null(self::$cookieUtils)) {
		243	self::$cookieUtils = new OIDplusCookieUtils();
		244	}
		245	return self::$cookieUtils;
		246	}
		247
263	daniel-mar	248	private static $menuUtils = null;
250	daniel-mar	249	public static function menuUtils() {
263	daniel-mar	250	if (is_null(self::$menuUtils)) {
		251	self::$menuUtils = new OIDplusMenuUtils();
250	daniel-mar	252	}
263	daniel-mar	253	return self::$menuUtils;
250	daniel-mar	254	}
		255
263	daniel-mar	256	private static $logger = null;
115	daniel-mar	257	public static function logger() {
263	daniel-mar	258	if (is_null(self::$logger)) {
		259	self::$logger = new OIDplusLogger();
115	daniel-mar	260	}
263	daniel-mar	261	return self::$logger;
115	daniel-mar	262	}
		263
263	daniel-mar	264	private static $sesHandler = null;
86	daniel-mar	265	public static function sesHandler() {
263	daniel-mar	266	if (is_null(self::$sesHandler)) {
		267	self::$sesHandler = new OIDplusSessionHandler();
86	daniel-mar	268	}
263	daniel-mar	269	return self::$sesHandler;
86	daniel-mar	270	}
		271
274	daniel-mar	272	# --- SQL slang plugin
		273
		274	private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) {
		275	$name = $plugin::id();
		276	if ($name === false) return false;
		277
449	daniel-mar	278	if (isset(self::$sqlSlangPlugins[$name])) {
451	daniel-mar	279	$plugintype_hf = _L('SQL slang');
449	daniel-mar	280	throw new OIDplusException('Multiple %1 plugins use the ID %2', $plugintype_hf, $name);
		281	}
		282
274	daniel-mar	283	self::$sqlSlangPlugins[$name] = $plugin;
		284
		285	return true;
		286	}
		287
		288	public static function getSqlSlangPlugins() {
		289	return self::$sqlSlangPlugins;
		290	}
		291
318	daniel-mar	292	public static function getSqlSlangPlugin($id)/: ?OIDplusSqlSlangPlugin/ {
		293	if (isset(self::$sqlSlangPlugins[$id])) {
		294	return self::$sqlSlangPlugins[$id];
		295	} else {
		296	return null;
		297	}
		298	}
		299
230	daniel-mar	300	# --- Database plugin
74	daniel-mar	301
227	daniel-mar	302	private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) {
275	daniel-mar	303	$name = $plugin::id();
150	daniel-mar	304	if ($name === false) return false;
		305
449	daniel-mar	306	if (isset(self::$dbPlugins[$name])) {
		307	$plugintype_hf = _L('Database');
		308	throw new OIDplusException('Multiple %1 plugins use the ID %2', $plugintype_hf, $name);
		309	}
		310
150	daniel-mar	311	self::$dbPlugins[$name] = $plugin;
		312
		313	return true;
		314	}
		315
		316	public static function getDatabasePlugins() {
		317	return self::$dbPlugins;
		318	}
		319
295	daniel-mar	320	public static function getActiveDatabasePlugin() {
261	daniel-mar	321	if (OIDplus::baseConfig()->getValue('DATABASE_PLUGIN', '') === '') {
360	daniel-mar	322	throw new OIDplusConfigInitializationException(_L('No database plugin selected in config file'));
260	daniel-mar	323	}
261	daniel-mar	324	if (!isset(self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')])) {
360	daniel-mar	325	$db_plugin_name = OIDplus::baseConfig()->getValue('DATABASE_PLUGIN');
		326	throw new OIDplusConfigInitializationException(_L('Database plugin "%1" not found',$db_plugin_name));
227	daniel-mar	327	}
295	daniel-mar	328	return self::$dbPlugins[OIDplus::baseConfig()->getValue('DATABASE_PLUGIN')];
227	daniel-mar	329	}
		330
295	daniel-mar	331	private static $dbMainSession = null;
		332	public static function db() {
		333	if (is_null(self::$dbMainSession)) {
		334	self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
		335	}
		336	if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
		337	return self::$dbMainSession;
		338	}
		339
		340	private static $dbIsolatedSession = null;
		341	public static function dbIsolated() {
		342	if (is_null(self::$dbIsolatedSession)) {
		343	self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
		344	}
		345	if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
		346	return self::$dbIsolatedSession;
		347	}
		348
227	daniel-mar	349	# --- Page plugin
		350
224	daniel-mar	351	private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
281	daniel-mar	352	self::$pagePlugins[] = $plugin;
61	daniel-mar	353
		354	return true;
		355	}
		356
281	daniel-mar	357	public static function getPagePlugins() {
		358	return self::$pagePlugins;
61	daniel-mar	359	}
		360
227	daniel-mar	361	# --- Auth plugin
		362
		363	private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
456	daniel-mar	364	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		365	$password = generateRandomString(25);
459	daniel-mar	366
461	daniel-mar	367	try {
		368	$authInfo = $plugin->generate($password);
		369	} catch (OIDplusException $e) {
		370	// This can happen when the AuthKey or Salt is too long
		371	throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
		372	}
459	daniel-mar	373	$salt = $authInfo->getSalt();
461	daniel-mar	374	$authKey = $authInfo->getAuthKey();
459	daniel-mar	375
461	daniel-mar	376	$authInfo_SaltDiff = clone $authInfo;
		377	$authInfo_SaltDiff->setSalt(strrev($authInfo_SaltDiff->getSalt()));
		378
		379	$authInfo_AuthKeyDiff = clone $authInfo;
		380	$authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
		381
		382	if ((!$plugin->verify($authInfo,$password)) \|\|
		383	(!empty($salt) && $plugin->verify($authInfo_SaltDiff,$password)) \|\|
		384	($plugin->verify($authInfo_AuthKeyDiff,$password)) \|\|
		385	($plugin->verify($authInfo,$password.'x'))) {
456	daniel-mar	386	throw new OIDplusException(_L('Auth plugin "%1" is erroneous: Generate/Verify self test failed',basename($plugin->getPluginDirectory())));
		387	}
453	daniel-mar	388	}
		389
227	daniel-mar	390	self::$authPlugins[] = $plugin;
		391	return true;
		392	}
		393
221	daniel-mar	394	public static function getAuthPlugins() {
		395	return self::$authPlugins;
		396	}
		397
355	daniel-mar	398	# --- Language plugin
		399
		400	private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
		401	self::$languagePlugins[] = $plugin;
		402	return true;
		403	}
		404
		405	public static function getLanguagePlugins() {
		406	return self::$languagePlugins;
		407	}
		408
449	daniel-mar	409	# --- Design plugin
		410
		411	private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
		412	self::$designPlugins[] = $plugin;
		413	return true;
		414	}
		415
		416	public static function getDesignPlugins() {
		417	return self::$designPlugins;
		418	}
		419
289	daniel-mar	420	# --- Logger plugin
		421
		422	private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
		423	self::$loggerPlugins[] = $plugin;
		424	return true;
		425	}
		426
		427	public static function getLoggerPlugins() {
		428	return self::$loggerPlugins;
		429	}
		430
227	daniel-mar	431	# --- Object type plugin
		432
		433	private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
		434	self::$objectTypePlugins[] = $plugin;
		435
		436	$ot = $plugin::getObjectTypeClassName();
		437	self::registerObjectType($ot);
		438
		439	return true;
		440	}
		441
224	daniel-mar	442	private static function registerObjectType($ot) {
66	daniel-mar	443	$ns = $ot::ns();
		444
360	daniel-mar	445	if (empty($ns)) throw new OIDplusException(_L('Attention: Empty NS at %1',$ot));
66	daniel-mar	446
		447	$ns_found = false;
227	daniel-mar	448	foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
66	daniel-mar	449	if ($test_ot::ns() == $ns) {
		450	$ns_found = true;
		451	break;
		452	}
		453	}
		454	if ($ns_found) {
360	daniel-mar	455	throw new OIDplusException(_L('Attention: Two objectType plugins use the same namespace "%1"!',$ns));
66	daniel-mar	456	}
		457
		458	$init = OIDplus::config()->getValue("objecttypes_initialized");
		459	$init_ary = empty($init) ? array() : explode(';', $init);
70	daniel-mar	460	$init_ary = array_map('trim', $init_ary);
66	daniel-mar	461
		462	$enabled = OIDplus::config()->getValue("objecttypes_enabled");
		463	$enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
70	daniel-mar	464	$enabled_ary = array_map('trim', $enabled_ary);
66	daniel-mar	465
79	daniel-mar	466	$do_enable = false;
		467	if (in_array($ns, $enabled_ary)) {
447	daniel-mar	468	// If it is in the list of enabled object types, it is enabled (obviously)
79	daniel-mar	469	$do_enable = true;
		470	} else {
447	daniel-mar	471	if (!OIDplus::config()->getValue('oobe_objects_done')) {
		472	// If the OOBE wizard is NOT done, then just enable the "oid" object type by default
79	daniel-mar	473	$do_enable = $ns == 'oid';
		474	} else {
447	daniel-mar	475	// If the OOBE wizard was done (once), then
		476	// we will enable all object types which were never initialized
		477	// (i.e. a plugin folder was freshly added)
79	daniel-mar	478	$do_enable = !in_array($ns, $init_ary);
		479	}
		480	}
		481
		482	if ($do_enable) {
227	daniel-mar	483	self::$enabledObjectTypes[] = $ot;
		484	usort(self::$enabledObjectTypes, function($a, $b) {
66	daniel-mar	485	$enabled = OIDplus::config()->getValue("objecttypes_enabled");
		486	$enabled_ary = explode(';', $enabled);
		487
		488	$idx_a = array_search($a::ns(), $enabled_ary);
		489	$idx_b = array_search($b::ns(), $enabled_ary);
		490
		491	if ($idx_a == $idx_b) {
		492	return 0;
		493	}
		494	return ($idx_a > $idx_b) ? +1 : -1;
		495	});
74	daniel-mar	496	} else {
		497	self::$disabledObjectTypes[] = $ot;
66	daniel-mar	498	}
		499
		500	if (!in_array($ns, $init_ary)) {
		501	// Was never initialized before, so we add it to the list of enabled object types once
		502
79	daniel-mar	503	if ($do_enable) {
		504	$enabled_ary[] = $ns;
		505	OIDplus::config()->setValue("objecttypes_enabled", implode(';', $enabled_ary));
		506	}
66	daniel-mar	507
		508	$init_ary[] = $ns;
		509	OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
		510	}
61	daniel-mar	511	}
		512
227	daniel-mar	513	public static function getObjectTypePlugins() {
		514	return self::$objectTypePlugins;
61	daniel-mar	515	}
		516
227	daniel-mar	517	public static function getObjectTypePluginsEnabled() {
		518	$res = array();
		519	foreach (self::$objectTypePlugins as $plugin) {
		520	$ot = $plugin::getObjectTypeClassName();
		521	if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
		522	}
		523	return $res;
74	daniel-mar	524	}
		525
227	daniel-mar	526	public static function getObjectTypePluginsDisabled() {
		527	$res = array();
		528	foreach (self::$objectTypePlugins as $plugin) {
		529	$ot = $plugin::getObjectTypeClassName();
		530	if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
74	daniel-mar	531	}
227	daniel-mar	532	return $res;
74	daniel-mar	533	}
		534
227	daniel-mar	535	public static function getEnabledObjectTypes() {
		536	return self::$enabledObjectTypes;
		537	}
74	daniel-mar	538
227	daniel-mar	539	public static function getDisabledObjectTypes() {
		540	return self::$disabledObjectTypes;
		541	}
74	daniel-mar	542
277	daniel-mar	543	# --- Plugin handling functions
		544
320	daniel-mar	545	public static function getAllPlugins()/: array/ {
		546	$res = array();
		547	$res = array_merge($res, self::$pagePlugins);
		548	$res = array_merge($res, self::$authPlugins);
		549	$res = array_merge($res, self::$loggerPlugins);
		550	$res = array_merge($res, self::$objectTypePlugins);
		551	$res = array_merge($res, self::$dbPlugins);
		552	$res = array_merge($res, self::$sqlSlangPlugins);
355	daniel-mar	553	$res = array_merge($res, self::$languagePlugins);
449	daniel-mar	554	$res = array_merge($res, self::$designPlugins);
320	daniel-mar	555	return $res;
		556	}
		557
321	daniel-mar	558	public static function getPluginByOid($oid)/: ?OIDplusPlugin/ {
320	daniel-mar	559	$plugins = self::getAllPlugins();
321	daniel-mar	560	foreach ($plugins as $plugin) {
		561	if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
		562	return $plugin;
320	daniel-mar	563	}
		564	}
		565	return null;
		566	}
		567
380	daniel-mar	568	public static function getPluginByClassName($classname)/: ?OIDplusPlugin/ {
		569	$plugins = self::getAllPlugins();
		570	foreach ($plugins as $plugin) {
		571	if (get_class($plugin) === $classname) {
		572	return $plugin;
		573	}
		574	}
		575	return null;
277	daniel-mar	576	}
		577
307	daniel-mar	578	public static function getAllPluginManifests($pluginFolderMask='*', $flat=true): array {
277	daniel-mar	579	$out = array();
279	daniel-mar	580	// Note: glob() will sort by default, so we do not need a page priority attribute.
		581	// So you just need to use a numeric plugin directory prefix (padded).
496	daniel-mar	582	$ary = glob(OIDplus::localpath().'plugins/'.$pluginFolderMask.'/'.'*'.'/manifest.xml');
426	daniel-mar	583	sort($ary);
277	daniel-mar	584	foreach ($ary as $ini) {
		585	if (!file_exists($ini)) continue;
		586
307	daniel-mar	587	$manifest = new OIDplusPluginManifest();
		588	$manifest->loadManifest($ini);
277	daniel-mar	589
473	daniel-mar	590	$class_name = $manifest->getPhpMainClass();
		591	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
		592	continue;
		593	}
		594
307	daniel-mar	595	if ($flat) {
		596	$out[] = $manifest;
		597	} else {
		598	$plugintype_folder = basename(dirname(dirname($ini)));
		599	$pluginname_folder = basename(dirname($ini));
		600
		601	if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
		602	if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
		603	$out[$plugintype_folder][$pluginname_folder] = $manifest;
		604	}
277	daniel-mar	605	}
		606	return $out;
		607	}
		608
		609	public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
		610	$out = array();
525	daniel-mar	611	if (is_array($pluginDirName)) {
		612	$ary = array();
		613	foreach ($pluginDirName as $pluginDirName_) {
		614	$ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
		615	}
		616	} else {
		617	$ary = self::getAllPluginManifests($pluginDirName, false);
		618	}
320	daniel-mar	619	$known_plugin_oids = array();
456	daniel-mar	620	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		621	$fake_feature = uuid_to_oid(gen_uuid());
		622	}
277	daniel-mar	623	foreach ($ary as $plugintype_folder => $bry) {
438	daniel-mar	624	foreach ($bry as $pluginname_folder => $manifest) {
		625	$class_name = $manifest->getPhpMainClass();
		626
		627	// Before we load the plugin, we want to make some checks to confirm
		628	// that the plugin is working correctly.
		629
307	daniel-mar	630	if (!$class_name) {
438	daniel-mar	631	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	632	}
297	daniel-mar	633	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
		634	continue;
		635	}
292	daniel-mar	636	if (!class_exists($class_name)) {
438	daniel-mar	637	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	638	}
279	daniel-mar	639	if (!is_subclass_of($class_name, $expectedPluginClass)) {
438	daniel-mar	640	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	641	}
438	daniel-mar	642	if (($class_name!=$manifest->getTypeClass()) && (!is_subclass_of($class_name,$manifest->getTypeClass()))) {
		643	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	644	}
438	daniel-mar	645	if (($manifest->getTypeClass()!=$expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(),$expectedPluginClass))) {
		646	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	647	}
		648
438	daniel-mar	649	$plugin_oid = $manifest->getOid();
320	daniel-mar	650	if (!$plugin_oid) {
438	daniel-mar	651	throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Does not have an OID'));
320	daniel-mar	652	}
		653	if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) {
438	daniel-mar	654	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	655	}
		656	if (isset($known_plugin_oids[$plugin_oid])) {
438	daniel-mar	657	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	658	} else {
		659	$known_plugin_oids[$plugin_oid] = $plugintype_folder.'/'.$pluginname_folder;
		660	}
		661
438	daniel-mar	662	$obj = new $class_name();
456	daniel-mar	663
		664	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		665	if ($obj->implementsFeature($fake_feature)) {
		666	// see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663
		667	throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('implementsFeature() always returns true'));
		668	}
438	daniel-mar	669	}
		670
		671	// TODO: Maybe as additional plugin-test, we should also check if plugins are allowed to define CSS/JS (since only page plugins may have them!)
		672	$tmp = array_merge(
		673	$manifest->getJSFiles(),
		674	$manifest->getCSSFiles(),
		675	$manifest->getJSFilesSetup(),
		676	$manifest->getCSSFilesSetup()
		677	);
		678	foreach ($tmp as $file) {
		679	if (!file_exists($file)) {
		680	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));
		681	}
		682	}
		683
		684	// Now we can continue
		685
279	daniel-mar	686	$out[] = $class_name;
		687	if (!is_null($registerCallback)) {
438	daniel-mar	688	call_user_func($registerCallback, $obj);
444	daniel-mar	689
		690	// Alternative approaches:
		691	//$registerCallback[0]::{$registerCallback[1]}($obj);
		692	// or:
		693	//forward_static_call($registerCallback, $obj);
279	daniel-mar	694	}
277	daniel-mar	695	}
		696
		697	}
		698	return $out;
		699	}
		700
227	daniel-mar	701	# --- Initialization of OIDplus
206	daniel-mar	702
374	daniel-mar	703	public static function init($html=true, $keepBaseConfig=true) {
236	daniel-mar	704	self::$html = $html;
		705
263	daniel-mar	706	// Reset internal state, so we can re-init verything if required
274	daniel-mar	707
263	daniel-mar	708	if (self::$old_config_format) {
		709	// Note: This can only happen in very special cases (e.g. test cases) where you call init() twice
360	daniel-mar	710	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	711	}
274	daniel-mar	712
263	daniel-mar	713	self::$config = null;
374	daniel-mar	714	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	715	self::$gui = null;
		716	self::$authUtils = null;
		717	self::$mailUtils = null;
		718	self::$menuUtils = null;
		719	self::$logger = null;
		720	self::$sesHandler = null;
295	daniel-mar	721	self::$dbMainSession = null;
		722	self::$dbIsolatedSession = null;
263	daniel-mar	723	self::$pagePlugins = array();
		724	self::$authPlugins = array();
289	daniel-mar	725	self::$loggerPlugins = array();
263	daniel-mar	726	self::$objectTypePlugins = array();
		727	self::$enabledObjectTypes = array();
		728	self::$disabledObjectTypes = array();
		729	self::$dbPlugins = array();
274	daniel-mar	730	self::$sqlSlangPlugins = array();
355	daniel-mar	731	self::$languagePlugins = array();
449	daniel-mar	732	self::$designPlugins = array();
263	daniel-mar	733	self::$system_id_cache = null;
		734	self::$sslAvailableCache = null;
468	daniel-mar	735	self::$translationArray = array();
74	daniel-mar	736
263	daniel-mar	737	// Continue...
		738
294	daniel-mar	739	OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
263	daniel-mar	740	// You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
		741
150	daniel-mar	742	// Register database types (highest priority)
		743
274	daniel-mar	744	// SQL slangs
		745
294	daniel-mar	746	self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin'));
274	daniel-mar	747	foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
		748	$plugin->init($html);
		749	}
		750
		751	// Database providers
		752
277	daniel-mar	753	self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin'));
237	daniel-mar	754	foreach (OIDplus::getDatabasePlugins() as $plugin) {
		755	$plugin->init($html);
		756	}
		757
42	daniel-mar	758	// Do redirect stuff etc.
74	daniel-mar	759
230	daniel-mar	760	self::isSslAvailable(); // This function does automatic redirects
61	daniel-mar	761
263	daniel-mar	762	// Construct the configuration manager
66	daniel-mar	763
263	daniel-mar	764	OIDplus::config(); // During the construction, various system settings are prepared if required
66	daniel-mar	765
74	daniel-mar	766	// Initialize public / private keys
		767
227	daniel-mar	768	OIDplus::getPkiStatus(true);
74	daniel-mar	769
237	daniel-mar	770	// Register non-DB plugins
74	daniel-mar	771
525	daniel-mar	772	self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin'));
277	daniel-mar	773	self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin'));
289	daniel-mar	774	self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin'));
277	daniel-mar	775	self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin'));
355	daniel-mar	776	self::registerAllPlugins('language', 'OIDplusLanguagePlugin', array('OIDplus','registerLanguagePlugin'));
449	daniel-mar	777	self::registerAllPlugins('design', 'OIDplusDesignPlugin', array('OIDplus','registerDesignPlugin'));
150	daniel-mar	778
237	daniel-mar	779	// Initialize non-DB plugins
224	daniel-mar	780
281	daniel-mar	781	foreach (OIDplus::getPagePlugins() as $plugin) {
74	daniel-mar	782	$plugin->init($html);
		783	}
230	daniel-mar	784	foreach (OIDplus::getAuthPlugins() as $plugin) {
		785	$plugin->init($html);
		786	}
289	daniel-mar	787	foreach (OIDplus::getLoggerPlugins() as $plugin) {
		788	$plugin->init($html);
		789	}
230	daniel-mar	790	foreach (OIDplus::getObjectTypePlugins() as $plugin) {
		791	$plugin->init($html);
		792	}
355	daniel-mar	793	foreach (OIDplus::getLanguagePlugins() as $plugin) {
		794	$plugin->init($html);
		795	}
449	daniel-mar	796	foreach (OIDplus::getDesignPlugins() as $plugin) {
		797	$plugin->init($html);
		798	}
412	daniel-mar	799
		800	// Initialize other stuff (i.e. things which require the logger!)
		801
		802	OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
		803	OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
2	daniel-mar	804	}
42	daniel-mar	805
227	daniel-mar	806	# --- System URL, System ID, PKI, and other functions
		807
412	daniel-mar	808	private static function recognizeSystemUrl() {
		809	try {
496	daniel-mar	810	$url = OIDplus::webpath();
412	daniel-mar	811	OIDplus::config()->setValue('last_known_system_url', $url);
		812	} catch (Exception $e) {
		813	}
		814	}
497	daniel-mar	815
496	daniel-mar	816	private static function getExecutingScriptPathDepth() {
		817	if (PHP_SAPI == 'cli') {
		818	global $argv;
		819	$test_dir = dirname(realpath($argv[0]));
		820	} else {
		821	if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
		822	$test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
		823	}
		824	$test_dir = str_replace('\\', '/', $test_dir);
		825	$steps_up = 0;
		826	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!
		827	$test_dir = dirname($test_dir);
		828	$steps_up++;
		829	if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
		830	}
		831	return $steps_up;
		832	}
412	daniel-mar	833
496	daniel-mar	834	private static function getSystemUrl($relative=false) {
326	daniel-mar	835	if (!$relative) {
		836	$res = OIDplus::baseConfig()->getValue('EXPLICIT_ABSOLUTE_SYSTEM_URL', '');
		837	if ($res !== '') {
494	daniel-mar	838	return rtrim($res,'/').'/';
326	daniel-mar	839	}
495	daniel-mar	840	if (PHP_SAPI == 'cli') {
494	daniel-mar	841	try {
		842	return OIDplus::config()->getValue('last_known_system_url', false);
		843	} catch (Exception $e) {
		844	return false;
		845	}
		846	}
326	daniel-mar	847	}
		848
494	daniel-mar	849	// First, try to find out how many levels we need to go up
496	daniel-mar	850	$steps_up = self::getExecutingScriptPathDepth();
		851	if ($steps_up === false) return false;
227	daniel-mar	852
496	daniel-mar	853	// Now go up these amount of levels, based on SCRIPT_NAME/argv[0]
495	daniel-mar	854	if (PHP_SAPI == 'cli') {
		855	if ($relative) {
		856	return str_repeat('../',$steps_up);
		857	} else {
		858	return false;
		859	}
		860	} else {
		861	$res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
		862	for ($i=0; $i<$steps_up; $i++) {
		863	$res = dirname($res);
		864	}
		865	$res = str_replace('\\', '/', $res);
		866	if ($res == '/') $res = '';
		867	$res .= '/';
496	daniel-mar	868
495	daniel-mar	869	// Do we want to have an absolute URI?
		870	if (!$relative) {
		871	$is_ssl = isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
		872	$protocol = $is_ssl ? 'https' : 'http'; // do not translate
		873	$host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
		874	$res = $protocol.'://'.$host.$res;
		875	}
496	daniel-mar	876
495	daniel-mar	877	return $res;
227	daniel-mar	878	}
		879	}
		880
		881	private static $system_id_cache = null;
		882	public static function getSystemId($oid=false) {
		883	if (!is_null(self::$system_id_cache)) {
		884	$out = self::$system_id_cache;
		885	} else {
		886	$out = false;
		887
		888	if (self::getPkiStatus(true)) {
		889	$pubKey = OIDplus::config()->getValue('oidplus_public_key');
386	daniel-mar	890	$m = array();
227	daniel-mar	891	if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
		892	$out = smallhash(base64_decode($m[1]));
		893	}
		894	}
		895	self::$system_id_cache = $out;
		896	}
350	daniel-mar	897	if (!$out) return false;
291	daniel-mar	898	return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
227	daniel-mar	899	}
		900
		901	public static function getPkiStatus($try_generate=true) {
		902	if (!function_exists('openssl_pkey_new')) return false;
		903
		904	$privKey = OIDplus::config()->getValue('oidplus_private_key');
		905	$pubKey = OIDplus::config()->getValue('oidplus_public_key');
		906
		907	if ($try_generate && !verify_private_public_key($privKey, $pubKey)) {
263	daniel-mar	908	$pkey_config = array(
227	daniel-mar	909	"digest_alg" => "sha512",
		910	"private_key_bits" => 2048,
		911	"private_key_type" => OPENSSL_KEYTYPE_RSA,
		912	);
		913
		914	// Create the private and public key
263	daniel-mar	915	$res = openssl_pkey_new($pkey_config);
256	daniel-mar	916
239	daniel-mar	917	if (!$res) return false;
227	daniel-mar	918
		919	// Extract the private key from $res to $privKey
		920	openssl_pkey_export($res, $privKey);
		921
		922	// Extract the public key from $res to $pubKey
		923	$pubKey = openssl_pkey_get_details($res)["key"];
		924
239	daniel-mar	925	// Log
288	daniel-mar	926	OIDplus::logger()->log("[INFO]A!", "Generating new SystemID using a new key pair");
239	daniel-mar	927
227	daniel-mar	928	// Save the key pair to database
		929	OIDplus::config()->setValue('oidplus_private_key', $privKey);
		930	OIDplus::config()->setValue('oidplus_public_key', $pubKey);
		931
		932	// Log the new system ID
386	daniel-mar	933	$m = array();
227	daniel-mar	934	if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
		935	$system_id = smallhash(base64_decode($m[1]));
288	daniel-mar	936	OIDplus::logger()->log("[INFO]A!", "Your SystemID is now $system_id");
227	daniel-mar	937	}
		938	}
		939
		940	return verify_private_public_key($privKey, $pubKey);
		941	}
		942
170	daniel-mar	943	public static function getInstallType() {
486	daniel-mar	944	$counter = 0;
		945
496	daniel-mar	946	if ($version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt'))
486	daniel-mar	947	$counter++;
496	daniel-mar	948	if ($svn_dir_exists = is_dir(OIDplus::localpath().'.svn'))
486	daniel-mar	949	$counter++;
496	daniel-mar	950	if ($git_dir_exists = is_dir(OIDplus::localpath().'.git'))
486	daniel-mar	951	$counter++;
		952
		953	if ($counter === 0) {
360	daniel-mar	954	return 'unknown'; // do not translate
170	daniel-mar	955	}
486	daniel-mar	956	if ($counter > 1) {
360	daniel-mar	957	return 'ambigous'; // do not translate
170	daniel-mar	958	}
486	daniel-mar	959	if ($svn_dir_exists) {
360	daniel-mar	960	return 'svn-wc'; // do not translate
170	daniel-mar	961	}
486	daniel-mar	962	if ($git_dir_exists) {
		963	return 'git-wc'; // do not translate
		964	}
		965	if ($version_file_exists) {
360	daniel-mar	966	return 'svn-snapshot'; // do not translate
170	daniel-mar	967	}
		968	}
		969
412	daniel-mar	970	private static function recognizeVersion() {
		971	try {
		972	$ver_prev = OIDplus::config()->getValue("last_known_version");
		973	$ver_now = OIDplus::getVersion();
		974	if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
455	daniel-mar	975	// 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	976	OIDplus::logger()->log("[INFO]A!", "System version changed from '$ver_prev' to '$ver_now'");
		977	}
		978	OIDplus::config()->setValue("last_known_version", $ver_now);
		979	} catch (Exception $e) {
		980	}
		981	}
		982
111	daniel-mar	983	public static function getVersion() {
412	daniel-mar	984	static $cachedVersion = null;
		985	if (!is_null($cachedVersion)) {
		986	return $cachedVersion;
		987	}
		988
486	daniel-mar	989	$installType = OIDplus::getInstallType();
		990
		991	if ($installType === 'svn-wc') {
496	daniel-mar	992	$ver = get_svn_revision(OIDplus::localpath());
486	daniel-mar	993	if ($ver)
		994	return ($cachedVersion = 'svn-'.$ver);
111	daniel-mar	995	}
162	daniel-mar	996
486	daniel-mar	997	if ($installType === 'git-wc') {
496	daniel-mar	998	$ver = get_gitsvn_revision(OIDplus::localpath());
486	daniel-mar	999	if ($ver)
		1000	return ($cachedVersion = 'svn-'.$ver);
162	daniel-mar	1001	}
		1002
486	daniel-mar	1003	if ($installType === 'svn-snapshot') {
496	daniel-mar	1004	$cont = file_get_contents(OIDplus::localpath().'oidplus_version.txt');
386	daniel-mar	1005	$m = array();
360	daniel-mar	1006	if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
412	daniel-mar	1007	return ($cachedVersion = 'svn-'.$m[1]); // do not translate
162	daniel-mar	1008	}
		1009
486	daniel-mar	1010	return ($cachedVersion = false); // version ambigous or unknown
111	daniel-mar	1011	}
		1012
230	daniel-mar	1013	private static $sslAvailableCache = null;
		1014	public static function isSslAvailable() {
		1015	if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
256	daniel-mar	1016
495	daniel-mar	1017	if (PHP_SAPI == 'cli') {
230	daniel-mar	1018	self::$sslAvailableCache = false;
		1019	return false;
		1020	}
		1021
49	daniel-mar	1022	$timeout = 2;
80	daniel-mar	1023	$already_ssl = isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] == "on");
		1024	$ssl_port = 443;
42	daniel-mar	1025
261	daniel-mar	1026	$mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', 2/auto/);
		1027
		1028	if ($mode == 0) {
80	daniel-mar	1029	// No SSL available
230	daniel-mar	1030	self::$sslAvailableCache = $already_ssl;
80	daniel-mar	1031	return $already_ssl;
		1032	}
		1033
261	daniel-mar	1034	if ($mode == 1) {
80	daniel-mar	1035	// Force SSL
		1036	if ($already_ssl) {
230	daniel-mar	1037	self::$sslAvailableCache = true;
80	daniel-mar	1038	return true;
42	daniel-mar	1039	} else {
80	daniel-mar	1040	$location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
		1041	header('Location:'.$location);
360	daniel-mar	1042	die(_L('Redirecting to HTTPS...'));
230	daniel-mar	1043	self::$sslAvailableCache = true;
80	daniel-mar	1044	return true;
		1045	}
		1046	}
		1047
261	daniel-mar	1048	if ($mode == 2) {
80	daniel-mar	1049	// Automatic SSL detection
		1050
		1051	if ($already_ssl) {
		1052	// we are already on HTTPS
557	daniel-mar	1053	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false);
230	daniel-mar	1054	self::$sslAvailableCache = true;
80	daniel-mar	1055	return true;
		1056	} else {
		1057	if (isset($_COOKIE['SSL_CHECK'])) {
		1058	// We already had the HTTPS detection done before.
		1059	if ($_COOKIE['SSL_CHECK']) {
		1060	// HTTPS was detected before, but we are HTTP. Redirect now
		1061	$location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
		1062	header('Location:'.$location);
360	daniel-mar	1063	die(_L('Redirecting to HTTPS...'));
230	daniel-mar	1064	self::$sslAvailableCache = true;
80	daniel-mar	1065	return true;
		1066	} else {
		1067	// No HTTPS available. Do nothing.
230	daniel-mar	1068	self::$sslAvailableCache = false;
80	daniel-mar	1069	return false;
		1070	}
49	daniel-mar	1071	} else {
80	daniel-mar	1072	// This is our first check (or the browser didn't accept the SSL_CHECK cookie)
386	daniel-mar	1073	$errno = -1;
		1074	$errstr = '';
80	daniel-mar	1075	if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) {
		1076	// HTTPS detected. Redirect now, and remember that we had detected HTTPS
557	daniel-mar	1077	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false);
80	daniel-mar	1078	$location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
		1079	header('Location:'.$location);
360	daniel-mar	1080	die(_L('Redirecting to HTTPS...'));
230	daniel-mar	1081	self::$sslAvailableCache = true;
80	daniel-mar	1082	return true;
		1083	} else {
		1084	// No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
557	daniel-mar	1085	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, false);
230	daniel-mar	1086	self::$sslAvailableCache = false;
80	daniel-mar	1087	return false;
		1088	}
49	daniel-mar	1089	}
42	daniel-mar	1090	}
		1091	}
		1092	}
497	daniel-mar	1093
496	daniel-mar	1094	/**
		1095	* Gets a local path pointing to a resource
		1096	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
		1097	* @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
		1098	* @return string The local path, with guaranteed trailing path delimiter for directories
		1099	*/
		1100	public static function localpath($target=null, $relative=false) {
		1101	if (is_null($target)) {
		1102	$target = __DIR__.'/../../';
		1103	}
241	daniel-mar	1104
496	daniel-mar	1105	if ($relative) {
		1106	// First, try to find out how many levels we need to go up
		1107	$steps_up = self::getExecutingScriptPathDepth();
		1108	if ($steps_up === false) return false;
497	daniel-mar	1109
496	daniel-mar	1110	// Virtually go back from the executing PHP script to the OIDplus base path
		1111	$res = str_repeat('../',$steps_up);
497	daniel-mar	1112
496	daniel-mar	1113	// Then go to the desired location
		1114	$basedir = realpath(__DIR__.'/../../');
		1115	$target = realpath($target);
500	daniel-mar	1116	if ($target === false) return false;
496	daniel-mar	1117	$res .= substr($target, strlen($basedir)+1);
		1118	$res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
		1119	} else {
		1120	$res = realpath($target);
241	daniel-mar	1121	}
497	daniel-mar	1122
498	daniel-mar	1123	if (is_null($target) \|\| is_dir($target)) $res .= DIRECTORY_SEPARATOR;
497	daniel-mar	1124
496	daniel-mar	1125	return $res;
241	daniel-mar	1126	}
355	daniel-mar	1127
496	daniel-mar	1128	/**
		1129	* Gets a URL pointing to a resource
		1130	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
		1131	* @param boolean $relative If true, the returning path is relative to the currently executed PHP script (i.e. index.php , not the plugin PHP script!)
		1132	* @return string The URL, with guaranteed trailing path delimiter for directories
		1133	*/
		1134	public static function webpath($target=null, $relative=false) {
		1135	$res = self::getSystemUrl($relative); // Note: already contains a trailing path delimiter
		1136	if (!$res) return false;
497	daniel-mar	1137
496	daniel-mar	1138	if (!is_null($target)) {
		1139	$basedir = realpath(__DIR__.'/../../');
		1140	$target = realpath($target);
500	daniel-mar	1141	if ($target === false) return false;
496	daniel-mar	1142	$tmp = substr($target, strlen($basedir)+1);
500	daniel-mar	1143	$res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
497	daniel-mar	1144	if (is_dir($target)) $res .= '/';
496	daniel-mar	1145	}
497	daniel-mar	1146
496	daniel-mar	1147	return $res;
		1148	}
497	daniel-mar	1149
360	daniel-mar	1150	public static function getAvailableLangs() {
		1151	$langs = array();
		1152	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1153	$code = $pluginManifest->getLanguageCode();
360	daniel-mar	1154	$langs[] = $code;
		1155	}
		1156	return $langs;
		1157	}
		1158
355	daniel-mar	1159	public static function getCurrentLang() {
360	daniel-mar	1160	if (isset($_GET['lang'])) {
		1161	$lang = $_GET['lang'];
		1162	} else if (isset($_POST['lang'])) {
		1163	$lang = $_POST['lang'];
		1164	} else if (isset($_COOKIE['LANGUAGE'])) {
		1165	$lang = $_COOKIE['LANGUAGE'];
		1166	} else {
		1167	$lang = self::DEFAULT_LANGUAGE;
		1168	}
		1169	$lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
355	daniel-mar	1170	return $lang;
		1171	}
		1172
362	daniel-mar	1173	public static function handleLangArgument() {
		1174	if (isset($_GET['lang'])) {
		1175	// The "?lang=" argument is only for NoScript-Browsers/SearchEngines
		1176	// In case someone who has JavaScript clicks a ?lang= link, they should get
		1177	// the page in that language, but the cookie must be set, otherwise
		1178	// the menu and other stuff would be in their cookie-based-language and not the
		1179	// argument-based-language.
557	daniel-mar	1180	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1181	} else if (isset($_POST['lang'])) {
557	daniel-mar	1182	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1183	}
		1184	}
		1185
468	daniel-mar	1186	private static $translationArray = array();
469	daniel-mar	1187	protected static function getTranslationFileContents($translation_file) {
		1188	// First, try the cache
481	daniel-mar	1189	$cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
469	daniel-mar	1190	if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
		1191	$cac = @unserialize(file_get_contents($cache_file));
		1192	if ($cac) return $cac;
		1193	}
481	daniel-mar	1194
469	daniel-mar	1195	// If not successful, then load the XML file
		1196	$xml = @simplexml_load_string(file_get_contents($translation_file));
		1197	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
		1198	$cac = array();
		1199	foreach ($xml->message as $msg) {
		1200	$src = trim($msg->source->__toString());
		1201	$dst = trim($msg->target->__toString());
		1202	$cac[$src] = $dst;
		1203	}
		1204	@file_put_contents($cache_file,serialize($cac));
		1205	@touch($cache_file,filemtime($translation_file));
		1206	return $cac;
		1207	}
468	daniel-mar	1208	public static function getTranslationArray($requested_lang='*') {
362	daniel-mar	1209	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1210	$lang = $pluginManifest->getLanguageCode();
362	daniel-mar	1211	if (strpos($lang,'/') !== false) continue; // just to be sure
		1212	if (strpos($lang,'\\') !== false) continue; // just to be sure
		1213	if (strpos($lang,'..') !== false) continue; // just to be sure
401	daniel-mar	1214
468	daniel-mar	1215	if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
401	daniel-mar	1216
468	daniel-mar	1217	if (!isset(self::$translationArray[$lang])) {
		1218	self::$translationArray[$lang] = array();
		1219
		1220	$wildcard = $pluginManifest->getLanguageMessages();
		1221	if (strpos($wildcard,'/') !== false) continue; // just to be sure
		1222	if (strpos($wildcard,'\\') !== false) continue; // just to be sure
		1223	if (strpos($wildcard,'..') !== false) continue; // just to be sure
		1224
		1225	$translation_files = glob(__DIR__.'/../../plugins/language/'.$lang.'/'.$wildcard);
		1226	sort($translation_files);
		1227	foreach ($translation_files as $translation_file) {
		1228	if (!file_exists($translation_file)) continue;
469	daniel-mar	1229	$cac = self::getTranslationFileContents($translation_file);
		1230	foreach ($cac as $src => $dst) {
		1231	self::$translationArray[$lang][$src] = $dst;
468	daniel-mar	1232	}
401	daniel-mar	1233	}
362	daniel-mar	1234	}
		1235	}
468	daniel-mar	1236	return self::$translationArray;
362	daniel-mar	1237	}
		1238
374	daniel-mar	1239	}

Subversion Repositories oidplus

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