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

Subversion Repositories oidplus

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