WebSVN – oidplus – Diff – /trunk/includes/classes/OIDplus.class.php

 // phpcs:disable PSR1.Files.SideEffects
 \defined('INSIDE_OIDPLUS') or die;
 // phpcs:enable PSR1.Files.SideEffects
 class OIDplus extends OIDplusBaseClass {
+        /**
+         * @var OIDplusPagePlugin[]
+         */
         private static /*OIDplusPagePlugin[]*/ $pagePlugins = array();
+        /**
+         * @var OIDplusAuthPlugin[]
+         */
         private static /*OIDplusAuthPlugin[]*/ $authPlugins = array();
+        /**
+         * @var OIDplusLoggerPlugin[]
+         */
         private static /*OIDplusLoggerPlugin[]*/ $loggerPlugins = array();
+        /**
+         * @var OIDplusObjectTypePlugin[]
+         */
         private static /*OIDplusObjectTypePlugin[]*/ $objectTypePlugins = array();
+        /**
+         * @var string[]|OIDplusObject[] Classnames of OIDplusObject classes
+         */
         private static /*string[]*/ $enabledObjectTypes = array();
+        /**
+         * @var string[]|OIDplusObject[] Classnames of OIDplusObject classes
+         */
         private static /*string[]*/ $disabledObjectTypes = array();
+        /**
+         * @var OIDplusDatabasePlugin[]
+         */
         private static /*OIDplusDatabasePlugin[]*/ $dbPlugins = array();
+        /**
+         * @var OIDplusCaptchaPlugin[]
+         */
         private static /*OIDplusCaptchaPlugin[]*/ $captchaPlugins = array();
+        /**
+         * @var OIDplusSqlSlangPlugin[]
+         */
         private static /*OIDplusSqlSlangPlugin[]*/ $sqlSlangPlugins = array();
+        /**
+         * @var OIDplusLanguagePlugin[]
+         */
         private static /*OIDplusLanguagePlugin[]*/ $languagePlugins = array();
+        /**
+         * @var OIDplusDesignPlugin[]
+         */
         private static /*OIDplusDesignPlugin[]*/ $designPlugins = array();
+        /**
+         * @var bool
+         */
         protected static $html = true;
+        /**
+         * e.g. "../"
+         */
-        /*public*/ const PATH_RELATIVE = 1;                   // e.g. "../"
+        /*public*/ const PATH_RELATIVE = 1;
+        /**
-        /*public*/ const PATH_ABSOLUTE = 2;                   // e.g. "http://www.example.com/oidplus/"
+         * e.g. "http://www.example.com/oidplus/"
+         */
+        /*public*/ const PATH_ABSOLUTE = 2;
+        /**
-        /*public*/ const PATH_ABSOLUTE_CANONICAL = 3;         // e.g. "http://www.example.org/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
+         * e.g. "http://www.example.org/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
+         */
+        /*public*/ const PATH_ABSOLUTE_CANONICAL = 3;
+        /**
+         * e.g. "/oidplus/"
+         */
-        /*public*/ const PATH_RELATIVE_TO_ROOT = 4;           // e.g. "/oidplus/"
+        /*public*/ const PATH_RELATIVE_TO_ROOT = 4;
+        /**
-        /*public*/ const PATH_RELATIVE_TO_ROOT_CANONICAL = 5; // e.g. "/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
+         * e.g. "/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
+         */
+        /*public*/ const PATH_RELATIVE_TO_ROOT_CANONICAL = 5;
+        /**
-        // These plugin types can contain HTML code and therefore may
+         * These plugin types can contain HTML code and therefore may
-        // emit (non-setup) CSS/JS code via their manifest.
+         * emit (non-setup) CSS/JS code via their manifest.
-        // Note that design plugins may only output CSS, not JS.
+         * Note that design plugins may only output CSS, not JS.
+         */
         /*public*/ const INTERACTIVE_PLUGIN_TYPES = array(
                 'publicPages',
                 'raPages',
                 'adminPages',
                 'objectTypes',
                 'captcha'
         );
         const UUID_NAMEBASED_NS_Base64PubKey = 'fd16965c-8bab-11ed-8744-3c4a92df8582';
+        /**
+         * Private constructor (Singleton)
+         */
         private function __construct() {
+        }
+        /**
+         * @return bool
+         * @throws OIDplusException
+         */
         private static function insideSetup(): bool {
                 if (PHP_SAPI == 'cli') return false;
                 if (!isset($_SERVER['REQUEST_URI'])) return false;
                 return (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE_TO_ROOT).'setup/') === 0);
+        }
         // --- Static classes
         private static $baseConfig = null;
         private static $oldConfigFormatLoaded = false;
-        public static function baseConfig() {
-                $first_init = false;
+        /**
+         * @return OIDplusBaseConfig
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
+        public static function baseConfig(): OIDplusBaseConfig {
                 if ($first_init = is_null(self::$baseConfig)) {
                         self::$baseConfig = new OIDplusBaseConfig();
+                }
                 if (self::insideSetup()) return self::$baseConfig;
                 return self::$baseConfig;
+        }
         private static $config = null;
+        /**
+         * @return OIDplusConfig
+         * @throws OIDplusException
+         */
-        public static function config() {
+        public static function config(): OIDplusConfig {
                 if ($first_init = is_null(self::$config)) {
                         self::$config = new OIDplusConfig();
+                }
                 if ($first_init) {
                 return self::$config;
+        }
         private static $gui = null;
+        /**
+         * @return OIDplusGui
+         */
-        public static function gui() {
+        public static function gui(): OIDplusGui {
                 if (is_null(self::$gui)) {
                         self::$gui = new OIDplusGui();
+                }
                 return self::$gui;
+        }
         private static $authUtils = null;
+        /**
+         * @return OIDplusAuthUtils
+         */
-        public static function authUtils() {
+        public static function authUtils(): OIDplusAuthUtils {
                 if (is_null(self::$authUtils)) {
                         self::$authUtils = new OIDplusAuthUtils();
+                }
                 return self::$authUtils;
+        }
         private static $mailUtils = null;
+        /**
+         * @return OIDplusMailUtils
+         */
-        public static function mailUtils() {
+        public static function mailUtils(): OIDplusMailUtils {
                 if (is_null(self::$mailUtils)) {
                         self::$mailUtils = new OIDplusMailUtils();
+                }
                 return self::$mailUtils;
+        }
         private static $cookieUtils = null;
+        /**
+         * @return OIDplusCookieUtils
+         */
-        public static function cookieUtils() {
+        public static function cookieUtils(): OIDplusCookieUtils {
                 if (is_null(self::$cookieUtils)) {
                         self::$cookieUtils = new OIDplusCookieUtils();
+                }
                 return self::$cookieUtils;
+        }
         private static $menuUtils = null;
+        /**
+         * @return OIDplusMenuUtils
+         */
-        public static function menuUtils() {
+        public static function menuUtils(): OIDplusMenuUtils {
                 if (is_null(self::$menuUtils)) {
                         self::$menuUtils = new OIDplusMenuUtils();
+                }
                 return self::$menuUtils;
+        }
         private static $logger = null;
+        /**
+         * @return OIDplusLogger
+         */
-        public static function logger() {
+        public static function logger(): OIDplusLogger {
                 if (is_null(self::$logger)) {
                         self::$logger = new OIDplusLogger();
+                }
                 return self::$logger;
+        }
         // --- SQL slang plugin
         /**
+         * @param OIDplusSqlSlangPlugin $plugin
-        * @return void
+         * @return void
+         * @throws OIDplusException
-        */
+         */
         private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) {
                 $name = $plugin::id();
                 if ($name === '') {
+                }
                 self::$sqlSlangPlugins[$name] = $plugin;
+        }
+        /**
+         * @return OIDplusSqlSlangPlugin[]
+         */
-        public static function getSqlSlangPlugins() {
+        public static function getSqlSlangPlugins(): array {
                 return self::$sqlSlangPlugins;
+        }
+        /**
+         * @param string $id
+         * @return OIDplusSqlSlangPlugin|null
+         */
-        public static function getSqlSlangPlugin($id)/*: ?OIDplusSqlSlangPlugin*/ {
+        public static function getSqlSlangPlugin(string $id)/*: ?OIDplusSqlSlangPlugin*/ {
                 if (isset(self::$sqlSlangPlugins[$id])) {
                         return self::$sqlSlangPlugins[$id];
                 } else {
                         return null;
+                }
+        }
         // --- Database plugin
         /**
+         * @param OIDplusDatabasePlugin $plugin
-        * @return void
+         * @return void
+         * @throws OIDplusException
-        */
+         */
         private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) {
                 $name = $plugin::id();
                 if ($name === '') {
+                }
                 self::$dbPlugins[$name] = $plugin;
+        }
+        /**
+         * @return OIDplusDatabasePlugin[]
+         */
-        public static function getDatabasePlugins() {
+        public static function getDatabasePlugins(): array {
                 return self::$dbPlugins;
+        }
+        /**
+         * @return OIDplusDatabasePlugin
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
-        public static function getActiveDatabasePlugin() {
+        public static function getActiveDatabasePlugin(): OIDplusDatabasePlugin {
                 $db_plugin_name = OIDplus::baseConfig()->getValue('DATABASE_PLUGIN','');
                 if ($db_plugin_name === '') {
                         throw new OIDplusConfigInitializationException(_L('No database plugin selected in config file'));
+                }
                 foreach (self::$dbPlugins as $name => $plugin) {
+                        }
+                }
                 throw new OIDplusConfigInitializationException(_L('Database plugin "%1" not found',$db_plugin_name));
+        }
+        /**
+         * @var OIDplusDatabaseConnection|null
+         */
         private static $dbMainSession = null;
+        /**
+         * @return OIDplusDatabaseConnection
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
-        public static function db() {
+        public static function db(): OIDplusDatabaseConnection {
                 if (is_null(self::$dbMainSession)) {
                         self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
+                }
                 if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
                 return self::$dbMainSession;
+        }
+        /**
+         * @var OIDplusDatabaseConnection|null
+         */
         private static $dbIsolatedSession = null;
+        /**
+         * @return OIDplusDatabaseConnection
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
-        public static function dbIsolated() {
+        public static function dbIsolated(): OIDplusDatabaseConnection {
                 if (is_null(self::$dbIsolatedSession)) {
                         self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
+                }
                 if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
                 return self::$dbIsolatedSession;
+        }
         // --- CAPTCHA plugin
         /**
+         * @param OIDplusCaptchaPlugin $plugin
-        * @return void
+         * @return void
+         * @throws OIDplusException
-        */
+         */
         private static function registerCaptchaPlugin(OIDplusCaptchaPlugin $plugin) {
                 $name = $plugin::id();
                 if ($name === '') {
+                }
                 self::$captchaPlugins[$name] = $plugin;
+        }
+        /**
+         * @return OIDplusCaptchaPlugin[]
+         */
-        public static function getCaptchaPlugins() {
+        public static function getCaptchaPlugins(): array {
                 return self::$captchaPlugins;
+        }
+        /**
+         * @return string
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
-        public static function getActiveCaptchaPluginId() {
+        public static function getActiveCaptchaPluginId(): string {
                 $captcha_plugin_name = OIDplus::baseConfig()->getValue('CAPTCHA_PLUGIN', '');
                 if (OIDplus::baseConfig()->getValue('RECAPTCHA_ENABLED', false) && ($captcha_plugin_name === '')) {
                         // Legacy config file support!
                         $captcha_plugin_name = 'reCAPTCHA';
                 if ($captcha_plugin_name === '') $captcha_plugin_name = 'None'; // the "None" plugin is a must-have!
                 return $captcha_plugin_name;
+        }
+        /**
+         * @return OIDplusCaptchaPlugin
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
-        public static function getActiveCaptchaPlugin() {
+        public static function getActiveCaptchaPlugin(): OIDplusCaptchaPlugin {
                 $captcha_plugin_name = OIDplus::getActiveCaptchaPluginId();
                 foreach (self::$captchaPlugins as $name => $plugin) {
                         if (strtolower($name) == strtolower($captcha_plugin_name)) {
                                 return $plugin;
+                        }
+        }
         // --- Page plugin
         /**
+         * @param OIDplusPagePlugin $plugin
-        * @return void
+         * @return void
-        */
+         */
         private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
                 self::$pagePlugins[] = $plugin;
+        }
+        /**
+         * @return OIDplusPagePlugin[]
+         */
-        public static function getPagePlugins() {
+        public static function getPagePlugins(): array {
                 return self::$pagePlugins;
+        }
         // --- Auth plugin
+        /**
+         * @param string $foldername
+         * @return OIDplusAuthPlugin|null
+         */
-        public static function getAuthPluginByFoldername($foldername)/*: ?OIDplusAuthPlugin*/ {
+        public static function getAuthPluginByFoldername(string $foldername)/*: ?OIDplusAuthPlugin*/ {
                 $plugins = OIDplus::getAuthPlugins();
                 foreach ($plugins as $plugin) {
                         if (basename($plugin->getPluginDirectory()) === $foldername) {
                                 return $plugin;
+                        }
+                }
                 return null;
+        }
+        /**
+         * @param string $plugin_foldername
+         * @param bool $must_hash
+         * @return void
+         * @throws OIDplusException
+         */
-        private static function checkRaAuthPluginAvailable($plugin_foldername, $must_hash) {
+        private static function checkRaAuthPluginAvailable(string $plugin_foldername, bool $must_hash) {
                         // if (!wildcard_is_dir(OIDplus::localpath().'plugins/'.'*'.'/auth/'.$plugin_foldername)) {
                         $plugin = OIDplus::getAuthPluginByFoldername($plugin_foldername);
                         if (is_null($plugin)) {
                                 throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$plugin_foldername,'plugins/[vendorname]/auth/'));
+                        }
                         if ($must_hash && !$plugin->availableForHash($reason)) {
                                 throw new OIDplusException(trim(_L('The auth plugin "%1" is not available for hashing on this system.',$plugin_foldername).' '.$reason));
+                        }
+        }
+        /**
+         * @param bool $must_hash
+         * @return OIDplusAuthPlugin|null
+         * @throws OIDplusException
+         */
-        public static function getDefaultRaAuthPlugin($must_hash)/*: OIDplusAuthPlugin*/ {
+        public static function getDefaultRaAuthPlugin(bool $must_hash)/*: OIDplusAuthPlugin*/ {
                 // 1. Priority: Use the auth plugin the user prefers
                 $def_plugin_foldername = OIDplus::config()->getValue('default_ra_auth_method');
                 if (trim($def_plugin_foldername) !== '') {
                         OIDplus::checkRaAuthPluginAvailable($def_plugin_foldername, $must_hash);
-                        $plugin = OIDplus::getAuthPluginByFoldername($def_plugin_foldername);
+                        return OIDplus::getAuthPluginByFoldername($def_plugin_foldername);
-                        return $plugin;
+                }
                 // 2. Priority: If empty (i.e. OIDplus may decide), choose the best ViaThinkSoft plugin that is supported on this system
                 $preferred_auth_plugins = array(
                         // Sorted by preference
                 // 4. Priority: We must deny the creation of the password because we have no auth plugin!
                 throw new OIDplusException(_L('Could not find a fitting auth plugin!'));
+        }
         /**
+         * @param OIDplusAuthPlugin $plugin
-        * @return void
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
-        */
+         */
         private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
                 $reason = '';
                 if (OIDplus::baseConfig()->getValue('DEBUG') && $plugin->availableForHash($reason) && $plugin->availableForVerify($reason)) {
                         $password = generateRandomString(25);
                                 // This can happen when the AuthKey is too long for the database field
                                 // Note: The constructor and setters of OIDplusRAAuthInfo() already check for length and null/false values.
                                 throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
+                        }
-                        $authKey = $authInfo->getAuthKey();
                         $authInfo_AuthKeyDiff = clone $authInfo;
                         $authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
                         if ((!$plugin->verify($authInfo,$password)) ||
                            ($plugin->verify($authInfo_AuthKeyDiff,$password)) ||
+                }
                 self::$authPlugins[] = $plugin;
+        }
+        /**
+         * @return OIDplusAuthPlugin[]
+         */
-        public static function getAuthPlugins() {
+        public static function getAuthPlugins(): array {
                 return self::$authPlugins;
+        }
         // --- Language plugin
         /**
+         * @param OIDplusLanguagePlugin $plugin
-        * @return void
+         * @return void
-        */
+         */
         private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
                 self::$languagePlugins[] = $plugin;
+        }
+        /**
+         * @return OIDplusLanguagePlugin[]
+         */
-        public static function getLanguagePlugins() {
+        public static function getLanguagePlugins(): array {
                 return self::$languagePlugins;
+        }
         // --- Design plugin
         /**
+         * @param OIDplusDesignPlugin $plugin
-        * @return void
+         * @return void
-        */
+         */
         private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
                 self::$designPlugins[] = $plugin;
+        }
+        /**
+         * @return OIDplusDesignPlugin[]
+         */
-        public static function getDesignPlugins() {
+        public static function getDesignPlugins(): array {
                 return self::$designPlugins;
+        }
+        /**
+         * @return OIDplusDesignPlugin|null
+         * @throws OIDplusException
+         */
-        public static function getActiveDesignPlugin() {
+        public static function getActiveDesignPlugin()/*: ?OIDplusDesignPlugin*/ {
                 $plugins = OIDplus::getDesignPlugins();
                 foreach ($plugins as $plugin) {
                         if ((basename($plugin->getPluginDirectory())) == OIDplus::config()->getValue('design','default')) {
                                 return $plugin;
+                        }
+        }
         // --- Logger plugin
         /**
+         * @param OIDplusLoggerPlugin $plugin
-        * @return void
+         * @return void
-        */
+         */
         private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
                 self::$loggerPlugins[] = $plugin;
+        }
+        /**
+         * @return OIDplusLoggerPlugin[]
+         */
-        public static function getLoggerPlugins() {
+        public static function getLoggerPlugins(): array {
                 return self::$loggerPlugins;
+        }
         // --- Object type plugin
         /**
+         * @param OIDplusObjectTypePlugin $plugin
-        * @return void
+         * @return void
+         * @throws OIDplusException
-        */
+         */
         private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
                 self::$objectTypePlugins[] = $plugin;
                 $ot = $plugin::getObjectTypeClassName();
                 self::registerObjectType($ot);
+        }
         /**
+         * @param string|OIDplusObject $ot Object type class name (OIDplusObject)
-        * @return void
+         * @return void
+         * @throws OIDplusException
-        */
+         */
         private static function registerObjectType($ot) {
                 $ns = $ot::ns();
                 if (empty($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace must not be empty',$ot));
                 $enabled = OIDplus::config()->getValue("objecttypes_enabled");
                 $enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
                 $enabled_ary = array_map('trim', $enabled_ary);
-                $do_enable = false;
                 if (in_array($ns, $enabled_ary)) {
                         // If it is in the list of enabled object types, it is enabled (obviously)
                         $do_enable = true;
                 } else {
                         if (!OIDplus::config()->getValue('oobe_objects_done')) {
                         $init_ary[] = $ns;
                         OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
+                }
+        }
+        /**
+         * @return OIDplusObjectTypePlugin[]
+         */
-        public static function getObjectTypePlugins() {
+        public static function getObjectTypePlugins(): array {
                 return self::$objectTypePlugins;
+        }
+        /**
+         * @return OIDplusObjectTypePlugin[]
+         */
-        public static function getObjectTypePluginsEnabled() {
+        public static function getObjectTypePluginsEnabled(): array {
                 $res = array();
                 foreach (self::$objectTypePlugins as $plugin) {
                         $ot = $plugin::getObjectTypeClassName();
                         if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
+                }
                 return $res;
+        }
+        /**
+         * @return OIDplusObjectTypePlugin[]
+         */
-        public static function getObjectTypePluginsDisabled() {
+        public static function getObjectTypePluginsDisabled(): array {
                 $res = array();
                 foreach (self::$objectTypePlugins as $plugin) {
                         $ot = $plugin::getObjectTypeClassName();
                         if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
+                }
                 return $res;
+        }
+        /**
+         * @return string[]|OIDplusObject[] Classname of a OIDplusObject class
+         */
-        public static function getEnabledObjectTypes() {
+        public static function getEnabledObjectTypes(): array {
                 return self::$enabledObjectTypes;
+        }
+        /**
+         * @return string[]|OIDplusObject[] Classname of a OIDplusObject class
+         */
-        public static function getDisabledObjectTypes() {
+        public static function getDisabledObjectTypes(): array {
                 return self::$disabledObjectTypes;
+        }
         // --- Plugin handling functions
+        /**
+         * @return OIDplusPlugin[]
+         */
-        public static function getAllPlugins()/*: array*/ {
+        public static function getAllPlugins(): array {
                 $res = array();
                 $res = array_merge($res, self::$pagePlugins);
                 $res = array_merge($res, self::$authPlugins);
                 $res = array_merge($res, self::$loggerPlugins);
                 $res = array_merge($res, self::$objectTypePlugins);
                 $res = array_merge($res, self::$dbPlugins);
                 $res = array_merge($res, self::$captchaPlugins);
                 $res = array_merge($res, self::$sqlSlangPlugins);
                 $res = array_merge($res, self::$languagePlugins);
-                $res = array_merge($res, self::$designPlugins);
+                return array_merge($res, self::$designPlugins);
-                return $res;
+        }
+        /**
+         * @param string $oid
+         * @return OIDplusPlugin|null
+         */
-        public static function getPluginByOid($oid)/*: ?OIDplusPlugin*/ {
+        public static function getPluginByOid(string $oid)/*: ?OIDplusPlugin*/ {
                 $plugins = self::getAllPlugins();
                 foreach ($plugins as $plugin) {
                         if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
                                 return $plugin;
+                        }
+                }
                 return null;
+        }
+        /**
+         * @param string $classname
+         * @return OIDplusPlugin|null
+         */
-        public static function getPluginByClassName($classname)/*: ?OIDplusPlugin*/ {
+        public static function getPluginByClassName(string $classname)/*: ?OIDplusPlugin*/ {
                 $plugins = self::getAllPlugins();
                 foreach ($plugins as $plugin) {
                         if (get_class($plugin) === $classname) {
                                 return $plugin;
+                        }
                 return null;
+        }
         /**
         * Checks if the plugin is disabled
-        * @return boolean true if plugin is enabled, false if plugin is disabled
+        * @return bool true if plugin is enabled, false if plugin is disabled
         * @throws OIDplusException if the class name or config file (disabled setting) does not contain a namespace
         */
         private static function pluginCheckDisabled($class_name): bool {
                 $path = explode('\\', $class_name);
                 return true;
+        }
         /**
+         * @param string $pluginFolderMasks
+         * @param bool $flat
-        * @return array<OIDplusPluginManifest>|array<string,array<string,OIDplusPluginManifest>>
+         * @return OIDplusPluginManifest[]|array<string,array<string,OIDplusPluginManifest>>
+         * @throws OIDplusException
-        */
+         */
-        public static function getAllPluginManifests($pluginFolderMasks='*', $flat=true): array {
+        public static function getAllPluginManifests(string $pluginFolderMasks='*', bool $flat=true): array {
                 $out = array();
                 // Note: glob() will sort by default, so we do not need a page priority attribute.
                 //       So you just need to use a numeric plugin directory prefix (padded).
                 $ary = array();
                 foreach (explode(',',$pluginFolderMasks) as $pluginFolderMask) {
                         if ($class_name) if (!self::pluginCheckDisabled($class_name)) continue;
                         if ($flat) {
                                 $out[] = $manifest;
                         } else {
-                                $plugintype_folder = basename(dirname(dirname($ini)));
+                                $plugintype_folder = basename(dirname($ini, 2));
                                 $pluginname_folder = basename(dirname($ini));
                                 if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
                                 if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
                                 $out[$plugintype_folder][$pluginname_folder] = $manifest;
+                }
                 return $out;
+        }
         /**
+         * @param $pluginDirName
+         * @param $expectedPluginClass
+         * @param $registerCallback
-        * @return array<string>
+         * @return string[]
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         * @throws \ReflectionException
-        */
+         */
         public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
                 $out = array();
                 if (is_array($pluginDirName)) {
                         $ary = array();
                 return $out;
+        }
         // --- Initialization of OIDplus
+        /**
+         * @param bool $html
+         * @param bool $keepBaseConfig
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        public static function init($html=true, $keepBaseConfig=true) {
+        public static function init(bool $html=true, bool $keepBaseConfig=true) {
                 self::$html = $html;
                 // Reset internal state, so we can re-init verything if required
                 self::$config = null;
                         // The headers are sent automatically when the first output comes or the script ends
                         foreach ($http_headers as $name => $val) {
                                 // Plugins can remove standard OIDplus headers by setting the value to null.
-                                if (is_null($val)) continue; /** @phpstan-ignore-line */
+                                if (is_null($val)) continue;
                                 // Some headers can be written as arrays to make it easier for plugin authors
                                 // to manipulate/extend the contents.
                                 if (is_array($val)) {
                                         if ((strtolower($name) == 'cache-control') ||
                 OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
+        }
         // --- System URL, System ID, PKI, and other functions
+        /**
+         * @return void
+         */
         private static function recognizeSystemUrl() {
                 try {
                         $url = OIDplus::webpath(null,self::PATH_ABSOLUTE_CANONICAL);
                         OIDplus::config()->setValue('last_known_system_url', $url);
                 } catch (\Exception $e) {
+                }
+        }
+        /**
+         * @return false|int
+         */
         private static function getExecutingScriptPathDepth() {
                 if (PHP_SAPI == 'cli') {
                         global $argv;
                         $test_dir = dirname(realpath($argv[0]));
                 } else {
                         if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
+                }
                 return $steps_up;
+        }
+        /**
+         * @return bool
+         */
-        public static function isSSL() {
+        public static function isSSL(): bool {
                 return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
+        }
         /**
          * Returns the URL of the system.
          * @param int $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
          *                  PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
          *                  results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
          *                  but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
          * @return string|false The URL, with guaranteed trailing path delimiter for directories
+         * @throws OIDplusException
          */
-        private static function getSystemUrl($mode) {
+        private static function getSystemUrl(int $mode) {
                 if ($mode === self::PATH_RELATIVE) {
                         $steps_up = self::getExecutingScriptPathDepth();
                         if ($steps_up === false) {
                                 return false;
                         } else {
                                 return $protocol.'://'.$host.$res.'/';
+                        }
+                }
+        }
+        /**
+         * @param $pubKey
+         * @return false|string
+         */
         private static function pubKeyToRaw($pubKey) {
                 $m = array();
                 if (preg_match('@BEGIN PUBLIC KEY\\-+([^\\-]+)\\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
                         return base64_decode($m[1], false);
+                }
                 return false;
+        }
+        /**
+         * @param $pubKey
+         * @return false|int
+         */
         private static function getSystemIdFromPubKey($pubKey) {
                 $rawData = self::pubKeyToRaw($pubKey);
                 if ($rawData === false) return false;
                 return smallhash($rawData);
+        }
+        /**
+         * @param $pubKey
+         * @return false|string
+         */
         private static function getSystemGuidFromPubKey($pubKey) {
                 $rawData = self::pubKeyToRaw($pubKey);
                 if ($rawData === false) return false;
                 $normalizedBase64 = base64_encode($rawData);
                 return gen_uuid_sha1_namebased(self::UUID_NAMEBASED_NS_Base64PubKey, $normalizedBase64);
+        }
         private static $system_id_cache = null;
+        /**
+         * @param bool $oid
+         * @return false|string
+         * @throws OIDplusException
+         */
-        public static function getSystemId($oid=false) {
+        public static function getSystemId(bool $oid=false) {
                 if (!is_null(self::$system_id_cache)) {
                         $out = self::$system_id_cache;
                 } else {
                         $out = false;
                 if (!$out) return false;
                 return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
+        }
         private static $system_guid_cache = null;
+        /**
+         * @return false|string
+         * @throws OIDplusException
+         */
         public static function getSystemGuid() {
                 if (!is_null(self::$system_guid_cache)) {
                         $out = self::$system_guid_cache;
                 } else {
                         $out = false;
+                }
                 if (!$out) return false;
                 return $out;
+        }
+        /**
+         * @return array|string
+         */
         public static function getOpenSslCnf() {
                 // The following functions need a config file, otherway they don't work
                 // - openssl_csr_new
                 // - openssl_csr_sign
                 // - openssl_pkey_export
                 // Bug reports are more than 10 years old and nobody cares...
                 // Use our own config file
                 return __DIR__.'/../../vendor/phpseclib/phpseclib/phpseclib/openssl.cnf';
+        }
+        /**
+         * @return string
+         */
-        private static function getPrivKeyPassphraseFilename() {
+        private static function getPrivKeyPassphraseFilename(): string {
                 return OIDplus::localpath() . 'userdata/privkey_secret.php';
+        }
+        /**
+         * @return void
+         */
         private static function tryCreatePrivKeyPassphrase() {
                 $file = self::getPrivKeyPassphraseFilename();
                 $passphrase = generateRandomString(64);
                 $cont = "<?php\n";
                 $cont .= "// End of file\n";
                 @file_put_contents($file, $cont);
+        }
+        /**
+         * @return string|false
+         */
         private static function getPrivKeyPassphrase() {
                 $file = self::getPrivKeyPassphraseFilename();
                 if (!file_exists($file)) return false;
                 $cont = file_get_contents($file);
                 $m = array();
                 if (!preg_match("@'(.+)'@isU", $cont, $m)) return false;
                 return $m[1];
+        }
+        /**
+         * @return string|false
+         * @throws OIDplusException
+         */
         public static function getSystemPrivateKey() {
                 $privKey = OIDplus::config()->getValue('oidplus_private_key');
                 if ($privKey == '') return false;
                 $passphrase = self::getPrivKeyPassphrase();
+                }
                 return $privKey;
+        }
+        /**
+         * @return string|false
+         * @throws OIDplusException
+         */
         public static function getSystemPublicKey() {
                 $pubKey = OIDplus::config()->getValue('oidplus_public_key');
                 if ($pubKey == '') return false;
                 return $pubKey;
+        }
+        /**
+         * @param bool $try_generate
+         * @return bool
+         * @throws OIDplusException
+         */
-        public static function getPkiStatus($try_generate=false) {
+        public static function getPkiStatus(bool $try_generate=false): bool {
                 if (!function_exists('openssl_pkey_new')) return false;
                 if ($try_generate) {
                         // For debug purposes: Invalidate current key once:
                         //OIDplus::config()->setValue('oidplus_private_key', '');
                 $privKey = OIDplus::getSystemPrivateKey();
                 $pubKey = OIDplus::getSystemPublicKey();
                 return verify_private_public_key($privKey, $pubKey);
+        }
+        /**
+         * @return string|void
+         */
         public static function getInstallType() {
                 $counter = 0;
                 if ($new_version_file_exists = file_exists(OIDplus::localpath().'.version.php')) {
                         $counter++;
                 else if ($version_file_exists) {
                         return 'svn-snapshot'; // do not translate
+                }
+        }
+        /**
+         * @return void
+         */
         private static function recognizeVersion() {
                 try {
                         $ver_prev = OIDplus::config()->getValue("last_known_version");
                         $ver_now = OIDplus::getVersion();
                         if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
                         OIDplus::config()->setValue("last_known_version", $ver_now);
                 } catch (\Exception $e) {
+                }
+        }
+        /**
+         * @return false|string|null
+         */
         public static function getVersion() {
                 static $cachedVersion = null;
                 if (!is_null($cachedVersion)) {
                         return $cachedVersion;
+                }
                         if ($ver)
                                 return ($cachedVersion = 'svn-'.$ver);
+                }
                 if ($installType === 'git-wc') {
-                        $ver = OIDplus::getGitsvnRevision(OIDplus::localpath());
+                        $ver = OIDplus::getGitsvnRevision();
                         if ($ver)
                                 return ($cachedVersion = 'svn-'.$ver);
+                }
                 if ($installType === 'svn-snapshot') {
         const ENFORCE_SSL_NO   = 0;
         const ENFORCE_SSL_YES  = 1;
         const ENFORCE_SSL_AUTO = 2;
         private static $sslAvailableCache = null;
+        /**
+         * @return bool|void|null
+         * @throws OIDplusException, OIDplusConfigInitializationException
+         */
         public static function isSslAvailable() {
                 if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
                 if (PHP_SAPI == 'cli') {
                         self::$sslAvailableCache = false;
+                }
+        }
         /**
          * Gets a local path pointing to a resource
-         * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
+         * @param string|null $target Target resource (file or directory must exist), or null to get the OIDplus base directory
-         * @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
+         * @param bool $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
          * @return string|false The local path, with guaranteed trailing path delimiter for directories
          */
-        public static function localpath($target=null, $relative=false) {
+        public static function localpath(string $target=null, bool $relative=false) {
                 if (is_null($target)) {
                         $target = __DIR__.'/../../';
+                }
                 if ($relative) {
                         $res = realpath($target);
+                }
                 if (is_dir($target)) $res .= '/';
-                $res = str_replace('/', DIRECTORY_SEPARATOR, $res);
+                return str_replace('/', DIRECTORY_SEPARATOR, $res);
-                return $res;
+        }
         /**
          * Gets a URL pointing to a resource
-         * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
+         * @param string|null $target Target resource (file or directory must exist), or null to get the OIDplus base directory
-         * @param int|boolean $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
+         * @param int|bool $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
          *                          PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
          *                          results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
          *                          but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
          * @return string|false The URL, with guaranteed trailing path delimiter for directories
+         * @throws OIDplusException
          */
-        public static function webpath($target=null, $mode=self::PATH_ABSOLUTE_CANONICAL) {
+        public static function webpath(string $target=null, $mode=self::PATH_ABSOLUTE_CANONICAL) {
                 // backwards compatibility
                 if ($mode === true) $mode = self::PATH_RELATIVE;
                 if ($mode === false) $mode = self::PATH_ABSOLUTE;
                 if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT) {
+                }
                 return $res;
+        }
+        /**
+         * @return false|string
+         * @throws OIDplusException
+         */
         public static function canonicalURL() {
                 // First part: OIDplus system URL (or canonical system URL)
                 $sysurl = OIDplus::getSystemUrl(self::PATH_ABSOLUTE_CANONICAL);
                 // Second part: Directory
                 return $sysurl.$res.$tmp.$tmp2;
+        }
         private static $shutdown_functions = array();
+        /**
+         * @param $func
+         * @return void
+         */
         public static function register_shutdown_function($func) {
                 self::$shutdown_functions[] = $func;
+        }
+        /**
+         * @return void
+         */
         public static function invoke_shutdown() {
                 foreach (self::$shutdown_functions as $func) {
                         $func();
+                }
+        }
+        /**
+         * @return string[]
+         * @throws OIDplusException
+         */
-        public static function getAvailableLangs() {
+        public static function getAvailableLangs(): array {
                 $langs = array();
                 foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
                         $code = $pluginManifest->getLanguageCode();
                         $langs[] = $code;
+                }
                 return $langs;
+        }
+        /**
+         * @return string
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        public static function getDefaultLang() {
+        public static function getDefaultLang(): string {
                 static $thrownOnce = false; // avoid endless loop inside OIDplusConfigInitializationException
                 $lang = self::baseConfig()->getValue('DEFAULT_LANGUAGE', 'enus');
                 if (!in_array($lang,self::getAvailableLangs())) {
+                }
                 return $lang;
+        }
+        /**
+         * @return false|string
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         public static function getCurrentLang() {
                 if (isset($_GET['lang'])) {
                         $lang = $_GET['lang'];
                 } else if (isset($_POST['lang'])) {
                         $lang = $_POST['lang'];
                 } else if (isset($_COOKIE['LANGUAGE'])) {
                         $lang = $_COOKIE['LANGUAGE'];
                 } else {
                         $lang = self::getDefaultLang();
+                }
-                $lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
+                return substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
-                return $lang;
+        }
+        /**
+         * @return void
+         * @throws OIDplusException
+         */
         public static function handleLangArgument() {
                 if (isset($_GET['lang'])) {
                         // The "?lang=" argument is only for NoScript-Browsers/SearchEngines
                         // In case someone who has JavaScript clicks a ?lang= link, they should get
                         // the page in that language, but the cookie must be set, otherwise
                         OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
+                }
+        }
         private static $translationArray = array();
+        /**
+         * @param $translation_file
+         * @return array|mixed
+         */
         protected static function getTranslationFileContents($translation_file) {
                 // First, try the cache
                 $cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
                 if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
                         $cac = @unserialize(file_get_contents($cache_file));
+                }
                 @file_put_contents($cache_file,serialize($cac));
                 @touch($cache_file,filemtime($translation_file));
                 return $cac;
+        }
+        /**
+         * @param string $requested_lang
+         * @return array
+         * @throws OIDplusException
+         */
-        public static function getTranslationArray($requested_lang='*') {
+        public static function getTranslationArray(string $requested_lang='*'): array {
                 foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
                         $lang = $pluginManifest->getLanguageCode();
                         if (strpos($lang,'/') !== false) continue; // just to be sure
                         if (strpos($lang,'\\') !== false) continue; // just to be sure
                         if (strpos($lang,'..') !== false) continue; // just to be sure
+                        }
+                }
                 return self::$translationArray;
+        }
+        /**
+         * @return mixed
+         */
         public static function getEditionInfo() {
                 return @parse_ini_file(__DIR__.'/../edition.ini', true)['Edition'];
+        }
+        /**
+         * @return false|string
+         */
         public static function findGitFolder() {
                 // Git command line saves git information in folder ".git"
                 // Plesk git saves git information in folder "../../../git/oidplus/" (or similar)
                 $dir = OIDplus::localpath();
                 if (is_dir($dir.'/.git')) return $dir.'/.git';
                         $i++;
                 } while (($i<100) && ($dir != ($new_dir = @realpath($dir.'/../'))) && ($dir = $new_dir));
                 return false;
+        }
+        /**
+         * @return false|string
+         */
-        public static function getGitsvnRevision($dir='') {
+        public static function getGitsvnRevision() {
                 try {
                         // tries command line and binary parsing
                         // requires vendor/danielmarschall/git_utils.inc.php
                         $git_dir = OIDplus::findGitFolder();
                         if ($git_dir === false) return false;
                 } else {
                         return false;
+                }
+        }
+        /**
+         * @param string $static_node_id
+         * @param bool $throw_exception
+         * @return string
+         */
-        public static function prefilterQuery($static_node_id, $throw_exception) {
+        public static function prefilterQuery(string $static_node_id, bool $throw_exception): string {
                 // Let namespace be case-insensitive
                 $ary = explode(':', $static_node_id, 2);
                 $ary[0] = strtolower($ary[0]);
                 $static_node_id = implode(':', $ary);
+                }
                 return $static_node_id;
+        }
+        /**
+         * @return bool
+         */
-        public static function isCronjob() {
+        public static function isCronjob(): bool {
                 return explode('.',basename($_SERVER['SCRIPT_NAME']))[0] === 'cron';
+        }
+        /**
+         * Since OIDplus svn-184, entries in the database need to have a canonical ID
+         * If the ID is not canonical (e.g. GUIDs missing hyphens), the object cannot be opened in OIDplus
+         * This script re-canonizes the object IDs if required.
+         * In SVN Rev 856, the canonization for GUID, IPv4 and IPv6 have changed, requiring another
+         * re-canonization
+         * @return void
+         * @throws OIDplusException
+         */
         private static function recanonizeObjects() {
-                //
-                // Since OIDplus svn-184, entries in the database need to have a canonical ID
-                // If the ID is not canonical (e.g. GUIDs missing hyphens), the object cannot be opened in OIDplus
-                // This script re-canonizes the object IDs if required.
-                // In SVN Rev 856, the canonization for GUID, IPv4 and IPv6 have changed, requiring another
-                // re-canonization
-                //
                 $res = OIDplus::db()->query("select id from ###objects");
                 while ($row = $res->fetch_array()) {
                         $ida = $row['id'];
                         $obj = OIDplusObject::parse($ida);
                         if (!$obj) continue;

Subversion Repositories oidplus

oidplus/trunk/includes/classes/OIDplus.class.php @ 1127 – Rev 1112 → 1116