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');
592	daniel-mar	272	throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
449	daniel-mar	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');
592	daniel-mar	300	throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
449	daniel-mar	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
594	daniel-mar	570	/**
		571	* @return array<OIDplusPluginManifest>\|array<string,array<string,OIDplusPluginManifest>>
		572	*/
307	daniel-mar	573	public static function getAllPluginManifests($pluginFolderMask='*', $flat=true): array {
277	daniel-mar	574	$out = array();
279	daniel-mar	575	// Note: glob() will sort by default, so we do not need a page priority attribute.
		576	// So you just need to use a numeric plugin directory prefix (padded).
496	daniel-mar	577	$ary = glob(OIDplus::localpath().'plugins/'.$pluginFolderMask.'/'.'*'.'/manifest.xml');
426	daniel-mar	578	sort($ary);
277	daniel-mar	579	foreach ($ary as $ini) {
		580	if (!file_exists($ini)) continue;
		581
307	daniel-mar	582	$manifest = new OIDplusPluginManifest();
		583	$manifest->loadManifest($ini);
277	daniel-mar	584
473	daniel-mar	585	$class_name = $manifest->getPhpMainClass();
		586	if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
		587	continue;
		588	}
		589
307	daniel-mar	590	if ($flat) {
		591	$out[] = $manifest;
		592	} else {
		593	$plugintype_folder = basename(dirname(dirname($ini)));
		594	$pluginname_folder = basename(dirname($ini));
		595
		596	if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
		597	if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
		598	$out[$plugintype_folder][$pluginname_folder] = $manifest;
		599	}
277	daniel-mar	600	}
		601	return $out;
		602	}
		603
594	daniel-mar	604	/**
		605	* @return array<string>
		606	*/
277	daniel-mar	607	public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
		608	$out = array();
525	daniel-mar	609	if (is_array($pluginDirName)) {
		610	$ary = array();
		611	foreach ($pluginDirName as $pluginDirName_) {
		612	$ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
		613	}
		614	} else {
		615	$ary = self::getAllPluginManifests($pluginDirName, false);
		616	}
320	daniel-mar	617	$known_plugin_oids = array();
456	daniel-mar	618	if (OIDplus::baseConfig()->getValue('DEBUG')) {
		619	$fake_feature = uuid_to_oid(gen_uuid());
588	daniel-mar	620	} else {
		621	$fake_feature = null;
456	daniel-mar	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;
295	daniel-mar	720	self::$dbMainSession = null;
		721	self::$dbIsolatedSession = null;
263	daniel-mar	722	self::$pagePlugins = array();
		723	self::$authPlugins = array();
289	daniel-mar	724	self::$loggerPlugins = array();
263	daniel-mar	725	self::$objectTypePlugins = array();
		726	self::$enabledObjectTypes = array();
		727	self::$disabledObjectTypes = array();
		728	self::$dbPlugins = array();
274	daniel-mar	729	self::$sqlSlangPlugins = array();
355	daniel-mar	730	self::$languagePlugins = array();
449	daniel-mar	731	self::$designPlugins = array();
263	daniel-mar	732	self::$system_id_cache = null;
		733	self::$sslAvailableCache = null;
468	daniel-mar	734	self::$translationArray = array();
74	daniel-mar	735
263	daniel-mar	736	// Continue...
		737
294	daniel-mar	738	OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
263	daniel-mar	739	// You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
		740
150	daniel-mar	741	// Register database types (highest priority)
		742
274	daniel-mar	743	// SQL slangs
		744
294	daniel-mar	745	self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin'));
274	daniel-mar	746	foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
		747	$plugin->init($html);
		748	}
		749
		750	// Database providers
		751
277	daniel-mar	752	self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin'));
237	daniel-mar	753	foreach (OIDplus::getDatabasePlugins() as $plugin) {
		754	$plugin->init($html);
		755	}
		756
42	daniel-mar	757	// Do redirect stuff etc.
74	daniel-mar	758
230	daniel-mar	759	self::isSslAvailable(); // This function does automatic redirects
61	daniel-mar	760
263	daniel-mar	761	// Construct the configuration manager
66	daniel-mar	762
263	daniel-mar	763	OIDplus::config(); // During the construction, various system settings are prepared if required
66	daniel-mar	764
74	daniel-mar	765	// Initialize public / private keys
		766
227	daniel-mar	767	OIDplus::getPkiStatus(true);
74	daniel-mar	768
237	daniel-mar	769	// Register non-DB plugins
74	daniel-mar	770
525	daniel-mar	771	self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin'));
277	daniel-mar	772	self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin'));
289	daniel-mar	773	self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin'));
277	daniel-mar	774	self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin'));
355	daniel-mar	775	self::registerAllPlugins('language', 'OIDplusLanguagePlugin', array('OIDplus','registerLanguagePlugin'));
449	daniel-mar	776	self::registerAllPlugins('design', 'OIDplusDesignPlugin', array('OIDplus','registerDesignPlugin'));
150	daniel-mar	777
237	daniel-mar	778	// Initialize non-DB plugins
224	daniel-mar	779
281	daniel-mar	780	foreach (OIDplus::getPagePlugins() as $plugin) {
74	daniel-mar	781	$plugin->init($html);
		782	}
230	daniel-mar	783	foreach (OIDplus::getAuthPlugins() as $plugin) {
		784	$plugin->init($html);
		785	}
289	daniel-mar	786	foreach (OIDplus::getLoggerPlugins() as $plugin) {
		787	$plugin->init($html);
		788	}
230	daniel-mar	789	foreach (OIDplus::getObjectTypePlugins() as $plugin) {
		790	$plugin->init($html);
		791	}
355	daniel-mar	792	foreach (OIDplus::getLanguagePlugins() as $plugin) {
		793	$plugin->init($html);
		794	}
449	daniel-mar	795	foreach (OIDplus::getDesignPlugins() as $plugin) {
		796	$plugin->init($html);
		797	}
412	daniel-mar	798
		799	// Initialize other stuff (i.e. things which require the logger!)
		800
		801	OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
		802	OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
2	daniel-mar	803	}
42	daniel-mar	804
227	daniel-mar	805	# --- System URL, System ID, PKI, and other functions
		806
412	daniel-mar	807	private static function recognizeSystemUrl() {
		808	try {
496	daniel-mar	809	$url = OIDplus::webpath();
412	daniel-mar	810	OIDplus::config()->setValue('last_known_system_url', $url);
		811	} catch (Exception $e) {
		812	}
		813	}
497	daniel-mar	814
496	daniel-mar	815	private static function getExecutingScriptPathDepth() {
		816	if (PHP_SAPI == 'cli') {
		817	global $argv;
		818	$test_dir = dirname(realpath($argv[0]));
		819	} else {
		820	if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
		821	$test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
		822	}
		823	$test_dir = str_replace('\\', '/', $test_dir);
		824	$steps_up = 0;
		825	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!
		826	$test_dir = dirname($test_dir);
		827	$steps_up++;
		828	if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
		829	}
		830	return $steps_up;
		831	}
580	daniel-mar	832
		833	public static function isSSL() {
		834	return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
		835	}
412	daniel-mar	836
496	daniel-mar	837	private static function getSystemUrl($relative=false) {
326	daniel-mar	838	if (!$relative) {
		839	$res = OIDplus::baseConfig()->getValue('EXPLICIT_ABSOLUTE_SYSTEM_URL', '');
		840	if ($res !== '') {
494	daniel-mar	841	return rtrim($res,'/').'/';
326	daniel-mar	842	}
495	daniel-mar	843	if (PHP_SAPI == 'cli') {
494	daniel-mar	844	try {
		845	return OIDplus::config()->getValue('last_known_system_url', false);
		846	} catch (Exception $e) {
		847	return false;
		848	}
		849	}
326	daniel-mar	850	}
		851
494	daniel-mar	852	// First, try to find out how many levels we need to go up
496	daniel-mar	853	$steps_up = self::getExecutingScriptPathDepth();
		854	if ($steps_up === false) return false;
227	daniel-mar	855
496	daniel-mar	856	// Now go up these amount of levels, based on SCRIPT_NAME/argv[0]
495	daniel-mar	857	if (PHP_SAPI == 'cli') {
		858	if ($relative) {
		859	return str_repeat('../',$steps_up);
		860	} else {
		861	return false;
		862	}
		863	} else {
		864	$res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
		865	for ($i=0; $i<$steps_up; $i++) {
		866	$res = dirname($res);
		867	}
		868	$res = str_replace('\\', '/', $res);
		869	if ($res == '/') $res = '';
		870	$res .= '/';
496	daniel-mar	871
495	daniel-mar	872	// Do we want to have an absolute URI?
		873	if (!$relative) {
580	daniel-mar	874	$is_ssl = self::isSSL();
495	daniel-mar	875	$protocol = $is_ssl ? 'https' : 'http'; // do not translate
		876	$host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
		877	$res = $protocol.'://'.$host.$res;
		878	}
496	daniel-mar	879
495	daniel-mar	880	return $res;
227	daniel-mar	881	}
		882	}
		883
		884	private static $system_id_cache = null;
		885	public static function getSystemId($oid=false) {
		886	if (!is_null(self::$system_id_cache)) {
		887	$out = self::$system_id_cache;
		888	} else {
		889	$out = false;
		890
		891	if (self::getPkiStatus(true)) {
		892	$pubKey = OIDplus::config()->getValue('oidplus_public_key');
386	daniel-mar	893	$m = array();
227	daniel-mar	894	if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
		895	$out = smallhash(base64_decode($m[1]));
		896	}
		897	}
		898	self::$system_id_cache = $out;
		899	}
350	daniel-mar	900	if (!$out) return false;
291	daniel-mar	901	return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
227	daniel-mar	902	}
		903
		904	public static function getPkiStatus($try_generate=true) {
		905	if (!function_exists('openssl_pkey_new')) return false;
		906
		907	$privKey = OIDplus::config()->getValue('oidplus_private_key');
		908	$pubKey = OIDplus::config()->getValue('oidplus_public_key');
		909
		910	if ($try_generate && !verify_private_public_key($privKey, $pubKey)) {
263	daniel-mar	911	$pkey_config = array(
227	daniel-mar	912	"digest_alg" => "sha512",
		913	"private_key_bits" => 2048,
		914	"private_key_type" => OPENSSL_KEYTYPE_RSA,
		915	);
		916
		917	// Create the private and public key
263	daniel-mar	918	$res = openssl_pkey_new($pkey_config);
256	daniel-mar	919
239	daniel-mar	920	if (!$res) return false;
227	daniel-mar	921
		922	// Extract the private key from $res to $privKey
		923	openssl_pkey_export($res, $privKey);
		924
		925	// Extract the public key from $res to $pubKey
		926	$pubKey = openssl_pkey_get_details($res)["key"];
		927
239	daniel-mar	928	// Log
288	daniel-mar	929	OIDplus::logger()->log("[INFO]A!", "Generating new SystemID using a new key pair");
239	daniel-mar	930
227	daniel-mar	931	// Save the key pair to database
		932	OIDplus::config()->setValue('oidplus_private_key', $privKey);
		933	OIDplus::config()->setValue('oidplus_public_key', $pubKey);
		934
		935	// Log the new system ID
386	daniel-mar	936	$m = array();
227	daniel-mar	937	if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
		938	$system_id = smallhash(base64_decode($m[1]));
288	daniel-mar	939	OIDplus::logger()->log("[INFO]A!", "Your SystemID is now $system_id");
227	daniel-mar	940	}
		941	}
		942
		943	return verify_private_public_key($privKey, $pubKey);
		944	}
		945
170	daniel-mar	946	public static function getInstallType() {
486	daniel-mar	947	$counter = 0;
		948
591	daniel-mar	949	if ($version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) {
486	daniel-mar	950	$counter++;
591	daniel-mar	951	}
		952	if ($svn_dir_exists = is_dir(OIDplus::localpath().'.svn') \|\|
		953	is_dir(OIDplus::localpath().'../.svn')) { // in case we checked out the root instead of the "trunk"
486	daniel-mar	954	$counter++;
591	daniel-mar	955	}
		956	if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) {
486	daniel-mar	957	$counter++;
591	daniel-mar	958	}
486	daniel-mar	959
		960	if ($counter === 0) {
360	daniel-mar	961	return 'unknown'; // do not translate
170	daniel-mar	962	}
591	daniel-mar	963	else if ($counter > 1) {
360	daniel-mar	964	return 'ambigous'; // do not translate
170	daniel-mar	965	}
591	daniel-mar	966	else if ($svn_dir_exists) {
360	daniel-mar	967	return 'svn-wc'; // do not translate
170	daniel-mar	968	}
591	daniel-mar	969	else if ($git_dir_exists) {
486	daniel-mar	970	return 'git-wc'; // do not translate
		971	}
591	daniel-mar	972	else if ($version_file_exists) {
360	daniel-mar	973	return 'svn-snapshot'; // do not translate
170	daniel-mar	974	}
		975	}
		976
412	daniel-mar	977	private static function recognizeVersion() {
		978	try {
		979	$ver_prev = OIDplus::config()->getValue("last_known_version");
		980	$ver_now = OIDplus::getVersion();
		981	if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
455	daniel-mar	982	// 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	983	OIDplus::logger()->log("[INFO]A!", "System version changed from '$ver_prev' to '$ver_now'");
		984	}
		985	OIDplus::config()->setValue("last_known_version", $ver_now);
		986	} catch (Exception $e) {
		987	}
		988	}
		989
111	daniel-mar	990	public static function getVersion() {
412	daniel-mar	991	static $cachedVersion = null;
		992	if (!is_null($cachedVersion)) {
		993	return $cachedVersion;
		994	}
		995
486	daniel-mar	996	$installType = OIDplus::getInstallType();
		997
		998	if ($installType === 'svn-wc') {
496	daniel-mar	999	$ver = get_svn_revision(OIDplus::localpath());
486	daniel-mar	1000	if ($ver)
		1001	return ($cachedVersion = 'svn-'.$ver);
558	daniel-mar	1002	$ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk"
		1003	if ($ver)
		1004	return ($cachedVersion = 'svn-'.$ver);
111	daniel-mar	1005	}
162	daniel-mar	1006
486	daniel-mar	1007	if ($installType === 'git-wc') {
496	daniel-mar	1008	$ver = get_gitsvn_revision(OIDplus::localpath());
486	daniel-mar	1009	if ($ver)
		1010	return ($cachedVersion = 'svn-'.$ver);
162	daniel-mar	1011	}
		1012
486	daniel-mar	1013	if ($installType === 'svn-snapshot') {
496	daniel-mar	1014	$cont = file_get_contents(OIDplus::localpath().'oidplus_version.txt');
386	daniel-mar	1015	$m = array();
360	daniel-mar	1016	if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
412	daniel-mar	1017	return ($cachedVersion = 'svn-'.$m[1]); // do not translate
162	daniel-mar	1018	}
		1019
486	daniel-mar	1020	return ($cachedVersion = false); // version ambigous or unknown
111	daniel-mar	1021	}
		1022
230	daniel-mar	1023	private static $sslAvailableCache = null;
		1024	public static function isSslAvailable() {
		1025	if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
256	daniel-mar	1026
495	daniel-mar	1027	if (PHP_SAPI == 'cli') {
230	daniel-mar	1028	self::$sslAvailableCache = false;
		1029	return false;
		1030	}
		1031
49	daniel-mar	1032	$timeout = 2;
580	daniel-mar	1033	$already_ssl = self::isSSL();
80	daniel-mar	1034	$ssl_port = 443;
42	daniel-mar	1035
261	daniel-mar	1036	$mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', 2/auto/);
		1037
		1038	if ($mode == 0) {
80	daniel-mar	1039	// No SSL available
230	daniel-mar	1040	self::$sslAvailableCache = $already_ssl;
80	daniel-mar	1041	return $already_ssl;
		1042	}
		1043
261	daniel-mar	1044	if ($mode == 1) {
80	daniel-mar	1045	// Force SSL
		1046	if ($already_ssl) {
230	daniel-mar	1047	self::$sslAvailableCache = true;
80	daniel-mar	1048	return true;
42	daniel-mar	1049	} else {
80	daniel-mar	1050	$location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
		1051	header('Location:'.$location);
360	daniel-mar	1052	die(_L('Redirecting to HTTPS...'));
591	daniel-mar	1053	#self::$sslAvailableCache = true;
		1054	#return true;
80	daniel-mar	1055	}
		1056	}
		1057
261	daniel-mar	1058	if ($mode == 2) {
80	daniel-mar	1059	// Automatic SSL detection
		1060
		1061	if ($already_ssl) {
		1062	// we are already on HTTPS
557	daniel-mar	1063	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false);
230	daniel-mar	1064	self::$sslAvailableCache = true;
80	daniel-mar	1065	return true;
		1066	} else {
		1067	if (isset($_COOKIE['SSL_CHECK'])) {
		1068	// We already had the HTTPS detection done before.
		1069	if ($_COOKIE['SSL_CHECK']) {
		1070	// HTTPS was detected before, but we are HTTP. Redirect now
		1071	$location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
		1072	header('Location:'.$location);
360	daniel-mar	1073	die(_L('Redirecting to HTTPS...'));
591	daniel-mar	1074	#self::$sslAvailableCache = true;
		1075	#return true;
80	daniel-mar	1076	} else {
		1077	// No HTTPS available. Do nothing.
230	daniel-mar	1078	self::$sslAvailableCache = false;
80	daniel-mar	1079	return false;
		1080	}
49	daniel-mar	1081	} else {
80	daniel-mar	1082	// This is our first check (or the browser didn't accept the SSL_CHECK cookie)
386	daniel-mar	1083	$errno = -1;
		1084	$errstr = '';
80	daniel-mar	1085	if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) {
		1086	// HTTPS detected. Redirect now, and remember that we had detected HTTPS
557	daniel-mar	1087	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false);
80	daniel-mar	1088	$location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
		1089	header('Location:'.$location);
360	daniel-mar	1090	die(_L('Redirecting to HTTPS...'));
591	daniel-mar	1091	#self::$sslAvailableCache = true;
		1092	#return true;
80	daniel-mar	1093	} else {
		1094	// No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
557	daniel-mar	1095	OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, false);
230	daniel-mar	1096	self::$sslAvailableCache = false;
80	daniel-mar	1097	return false;
		1098	}
49	daniel-mar	1099	}
42	daniel-mar	1100	}
		1101	}
		1102	}
497	daniel-mar	1103
496	daniel-mar	1104	/**
		1105	* Gets a local path pointing to a resource
		1106	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
		1107	* @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
590	daniel-mar	1108	* @return string\|false The local path, with guaranteed trailing path delimiter for directories
496	daniel-mar	1109	*/
		1110	public static function localpath($target=null, $relative=false) {
		1111	if (is_null($target)) {
		1112	$target = __DIR__.'/../../';
		1113	}
241	daniel-mar	1114
496	daniel-mar	1115	if ($relative) {
		1116	// First, try to find out how many levels we need to go up
		1117	$steps_up = self::getExecutingScriptPathDepth();
		1118	if ($steps_up === false) return false;
497	daniel-mar	1119
496	daniel-mar	1120	// Virtually go back from the executing PHP script to the OIDplus base path
		1121	$res = str_repeat('../',$steps_up);
497	daniel-mar	1122
496	daniel-mar	1123	// Then go to the desired location
		1124	$basedir = realpath(__DIR__.'/../../');
		1125	$target = realpath($target);
500	daniel-mar	1126	if ($target === false) return false;
496	daniel-mar	1127	$res .= substr($target, strlen($basedir)+1);
		1128	$res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
		1129	} else {
		1130	$res = realpath($target);
241	daniel-mar	1131	}
497	daniel-mar	1132
591	daniel-mar	1133	if (is_dir($target)) $res .= DIRECTORY_SEPARATOR;
497	daniel-mar	1134
496	daniel-mar	1135	return $res;
241	daniel-mar	1136	}
355	daniel-mar	1137
496	daniel-mar	1138	/**
		1139	* Gets a URL pointing to a resource
		1140	* @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
		1141	* @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	1142	* @return string\|false The URL, with guaranteed trailing path delimiter for directories
496	daniel-mar	1143	*/
		1144	public static function webpath($target=null, $relative=false) {
		1145	$res = self::getSystemUrl($relative); // Note: already contains a trailing path delimiter
		1146	if (!$res) return false;
497	daniel-mar	1147
496	daniel-mar	1148	if (!is_null($target)) {
		1149	$basedir = realpath(__DIR__.'/../../');
		1150	$target = realpath($target);
500	daniel-mar	1151	if ($target === false) return false;
496	daniel-mar	1152	$tmp = substr($target, strlen($basedir)+1);
500	daniel-mar	1153	$res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
497	daniel-mar	1154	if (is_dir($target)) $res .= '/';
496	daniel-mar	1155	}
497	daniel-mar	1156
496	daniel-mar	1157	return $res;
		1158	}
497	daniel-mar	1159
360	daniel-mar	1160	public static function getAvailableLangs() {
		1161	$langs = array();
		1162	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1163	$code = $pluginManifest->getLanguageCode();
360	daniel-mar	1164	$langs[] = $code;
		1165	}
		1166	return $langs;
		1167	}
		1168
355	daniel-mar	1169	public static function getCurrentLang() {
360	daniel-mar	1170	if (isset($_GET['lang'])) {
		1171	$lang = $_GET['lang'];
		1172	} else if (isset($_POST['lang'])) {
		1173	$lang = $_POST['lang'];
		1174	} else if (isset($_COOKIE['LANGUAGE'])) {
		1175	$lang = $_COOKIE['LANGUAGE'];
		1176	} else {
		1177	$lang = self::DEFAULT_LANGUAGE;
		1178	}
		1179	$lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
355	daniel-mar	1180	return $lang;
		1181	}
		1182
362	daniel-mar	1183	public static function handleLangArgument() {
		1184	if (isset($_GET['lang'])) {
		1185	// The "?lang=" argument is only for NoScript-Browsers/SearchEngines
		1186	// In case someone who has JavaScript clicks a ?lang= link, they should get
		1187	// the page in that language, but the cookie must be set, otherwise
		1188	// the menu and other stuff would be in their cookie-based-language and not the
		1189	// argument-based-language.
557	daniel-mar	1190	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1191	} else if (isset($_POST['lang'])) {
557	daniel-mar	1192	OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/HttpOnly off, because JavaScript also needs translation/);
362	daniel-mar	1193	}
		1194	}
		1195
468	daniel-mar	1196	private static $translationArray = array();
469	daniel-mar	1197	protected static function getTranslationFileContents($translation_file) {
		1198	// First, try the cache
481	daniel-mar	1199	$cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
469	daniel-mar	1200	if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
		1201	$cac = @unserialize(file_get_contents($cache_file));
		1202	if ($cac) return $cac;
		1203	}
481	daniel-mar	1204
469	daniel-mar	1205	// If not successful, then load the XML file
		1206	$xml = @simplexml_load_string(file_get_contents($translation_file));
		1207	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
		1208	$cac = array();
		1209	foreach ($xml->message as $msg) {
		1210	$src = trim($msg->source->__toString());
		1211	$dst = trim($msg->target->__toString());
		1212	$cac[$src] = $dst;
		1213	}
		1214	@file_put_contents($cache_file,serialize($cac));
		1215	@touch($cache_file,filemtime($translation_file));
		1216	return $cac;
		1217	}
468	daniel-mar	1218	public static function getTranslationArray($requested_lang='*') {
362	daniel-mar	1219	foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
389	daniel-mar	1220	$lang = $pluginManifest->getLanguageCode();
362	daniel-mar	1221	if (strpos($lang,'/') !== false) continue; // just to be sure
		1222	if (strpos($lang,'\\') !== false) continue; // just to be sure
		1223	if (strpos($lang,'..') !== false) continue; // just to be sure
401	daniel-mar	1224
468	daniel-mar	1225	if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
401	daniel-mar	1226
468	daniel-mar	1227	if (!isset(self::$translationArray[$lang])) {
		1228	self::$translationArray[$lang] = array();
		1229
		1230	$wildcard = $pluginManifest->getLanguageMessages();
		1231	if (strpos($wildcard,'/') !== false) continue; // just to be sure
		1232	if (strpos($wildcard,'\\') !== false) continue; // just to be sure
		1233	if (strpos($wildcard,'..') !== false) continue; // just to be sure
		1234
		1235	$translation_files = glob(__DIR__.'/../../plugins/language/'.$lang.'/'.$wildcard);
		1236	sort($translation_files);
		1237	foreach ($translation_files as $translation_file) {
		1238	if (!file_exists($translation_file)) continue;
469	daniel-mar	1239	$cac = self::getTranslationFileContents($translation_file);
		1240	foreach ($cac as $src => $dst) {
		1241	self::$translationArray[$lang][$src] = $dst;
468	daniel-mar	1242	}
401	daniel-mar	1243	}
362	daniel-mar	1244	}
		1245	}
468	daniel-mar	1246	return self::$translationArray;
362	daniel-mar	1247	}
		1248
374	daniel-mar	1249	}

Subversion Repositories oidplus

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