Subversion Repositories oidplus

Rev

Rev 1123 | Rev 1130 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. <?php
  2.  
  3. /*
  4.  * OIDplus 2.0
  5.  * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
  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.  
  20. namespace ViaThinkSoft\OIDplus;
  21.  
  22. // phpcs:disable PSR1.Files.SideEffects
  23. \defined('INSIDE_OIDPLUS') or die;
  24. // phpcs:enable PSR1.Files.SideEffects
  25.  
  26. class OIDplus extends OIDplusBaseClass {
  27.         /**
  28.          * @var OIDplusPagePlugin[]
  29.          */
  30.         private static /*OIDplusPagePlugin[]*/ $pagePlugins = array();
  31.         /**
  32.          * @var OIDplusAuthPlugin[]
  33.          */
  34.         private static /*OIDplusAuthPlugin[]*/ $authPlugins = array();
  35.         /**
  36.          * @var OIDplusLoggerPlugin[]
  37.          */
  38.         private static /*OIDplusLoggerPlugin[]*/ $loggerPlugins = array();
  39.         /**
  40.          * @var OIDplusObjectTypePlugin[]
  41.          */
  42.         private static /*OIDplusObjectTypePlugin[]*/ $objectTypePlugins = array();
  43.         /**
  44.          * @var string[]|OIDplusObject[] Classnames of OIDplusObject classes
  45.          */
  46.         private static /*string[]*/ $enabledObjectTypes = array();
  47.         /**
  48.          * @var string[]|OIDplusObject[] Classnames of OIDplusObject classes
  49.          */
  50.         private static /*string[]*/ $disabledObjectTypes = array();
  51.         /**
  52.          * @var OIDplusDatabasePlugin[]
  53.          */
  54.         private static /*OIDplusDatabasePlugin[]*/ $dbPlugins = array();
  55.         /**
  56.          * @var OIDplusCaptchaPlugin[]
  57.          */
  58.         private static /*OIDplusCaptchaPlugin[]*/ $captchaPlugins = array();
  59.         /**
  60.          * @var OIDplusSqlSlangPlugin[]
  61.          */
  62.         private static /*OIDplusSqlSlangPlugin[]*/ $sqlSlangPlugins = array();
  63.         /**
  64.          * @var OIDplusLanguagePlugin[]
  65.          */
  66.         private static /*OIDplusLanguagePlugin[]*/ $languagePlugins = array();
  67.         /**
  68.          * @var OIDplusDesignPlugin[]
  69.          */
  70.         private static /*OIDplusDesignPlugin[]*/ $designPlugins = array();
  71.  
  72.         /**
  73.          * @var bool
  74.          */
  75.         protected static $html = true;
  76.  
  77.         /**
  78.          * e.g. "../"
  79.          */
  80.         /*public*/ const PATH_RELATIVE = 1;
  81.  
  82.         /**
  83.          * e.g. "http://www.example.com/oidplus/"
  84.          */
  85.         /*public*/ const PATH_ABSOLUTE = 2;
  86.  
  87.         /**
  88.          * e.g. "http://www.example.org/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
  89.          */
  90.         /*public*/ const PATH_ABSOLUTE_CANONICAL = 3;
  91.  
  92.         /**
  93.          * e.g. "/oidplus/"
  94.          */
  95.         /*public*/ const PATH_RELATIVE_TO_ROOT = 4;
  96.  
  97.         /**
  98.          * e.g. "/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
  99.          */
  100.         /*public*/ const PATH_RELATIVE_TO_ROOT_CANONICAL = 5;
  101.  
  102.         /**
  103.          * These plugin types can contain HTML code and therefore may
  104.          * emit (non-setup) CSS/JS code via their manifest.
  105.          * Note that design plugins may only output CSS, not JS.
  106.          */
  107.         /*public*/ const INTERACTIVE_PLUGIN_TYPES = array(
  108.         'publicPages',
  109.         'raPages',
  110.         'adminPages',
  111.         'objectTypes',
  112.         'captcha'
  113. );
  114.  
  115.         const UUID_NAMEBASED_NS_Base64PubKey = 'fd16965c-8bab-11ed-8744-3c4a92df8582';
  116.  
  117.         /**
  118.          * Private constructor (Singleton)
  119.          */
  120.         private function __construct() {
  121.         }
  122.  
  123.         /**
  124.          * @return bool
  125.          * @throws OIDplusException
  126.          */
  127.         private static function insideSetup(): bool {
  128.                 if (PHP_SAPI == 'cli') return false;
  129.                 if (!isset($_SERVER['REQUEST_URI'])) return false;
  130.                 return (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE_TO_ROOT).'setup/') === 0);
  131.         }
  132.  
  133.         // --- Static classes
  134.  
  135.         private static $baseConfig = null;
  136.         private static $oldConfigFormatLoaded = false;
  137.  
  138.         /**
  139.          * @return OIDplusBaseConfig
  140.          * @throws OIDplusException, OIDplusConfigInitializationException
  141.          */
  142.         public static function baseConfig(): OIDplusBaseConfig {
  143.                 if ($first_init = is_null(self::$baseConfig)) {
  144.                         self::$baseConfig = new OIDplusBaseConfig();
  145.                 }
  146.  
  147.                 if (self::insideSetup()) return self::$baseConfig;
  148.                 if ((basename($_SERVER['SCRIPT_NAME']) === 'oidplus.min.js.php') && isset($_REQUEST['noBaseConfig']) && ($_REQUEST['noBaseConfig'] == '1')) return self::$baseConfig;
  149.                 if ((basename($_SERVER['SCRIPT_NAME']) === 'oidplus.min.css.php') && isset($_REQUEST['noBaseConfig']) && ($_REQUEST['noBaseConfig'] == '1')) return self::$baseConfig;
  150.  
  151.                 if ($first_init) {
  152.                         // Include a file containing various size/depth limitations of OIDs
  153.                         // It is important to include it before userdata/baseconfig/config.inc.php was included,
  154.                         // so we can give userdata/baseconfig/config.inc.php the chance to override the values.
  155.  
  156.                         include OIDplus::localpath().'includes/oidplus_limits.inc.php';
  157.  
  158.                         // Include config file
  159.  
  160.                         $config_file = OIDplus::localpath() . 'userdata/baseconfig/config.inc.php';
  161.                         $config_file_old = OIDplus::localpath() . 'includes/config.inc.php'; // backwards compatibility
  162.  
  163.                         if (!file_exists($config_file) && file_exists($config_file_old)) {
  164.                                 $config_file = $config_file_old;
  165.                         }
  166.  
  167.                         if (file_exists($config_file)) {
  168.                                 if (self::$oldConfigFormatLoaded) {
  169.                                         // Note: We may only include it once due to backwards compatibility,
  170.                                         //       since in version 2.0, the configuration was defined using define() statements
  171.                                         // Attention: This does mean that a full re-init (e.g. for test cases) is not possible
  172.                                         //            if a version 2.0 config is used!
  173.  
  174.                                         // We need to do this, because define() cannot be undone
  175.                                         // Note: This can only happen in very special cases (e.g. test cases) where you call init() twice
  176.                                         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.'));
  177.                                 } else {
  178.                                         $tmp = file_get_contents($config_file);
  179.                                         $ns = "ViaThinkSoft\OIDplus\OIDplus";
  180.                                         $uses = "use $ns;";
  181.                                         if ((strpos($tmp,'OIDplus::') !== false) && (strpos($tmp,$uses) === false)) {
  182.                                                 // Migrate config file to namespace class names
  183.                                                 // Note: Only config files version 2.1 are affected. Not 2.0 ones
  184.  
  185.                                                 $tmp = "<?php\r\n\r\n$uses /* Automatically added by migration procedure */\r\n?>$tmp";
  186.                                                 $tmp = str_replace('?><?php', '', $tmp);
  187.  
  188.                                                 $tmp = str_replace("\$ns\OIDplusCaptchaPluginRecaptcha::", "OIDplusCaptchaPluginRecaptcha::", $tmp);
  189.                                                 $tmp = str_replace("OIDplusCaptchaPluginRecaptcha::", "\$ns\OIDplusCaptchaPluginRecaptcha::", $tmp);
  190.  
  191.                                                 $tmp = str_replace('DISABLE_PLUGIN_OIDplusPagePublicRdap',
  192.                                                         'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicRdap', $tmp);
  193.                                                 $tmp = str_replace('DISABLE_PLUGIN_OIDplusPagePublicAltIds',
  194.                                                         'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicAltIds', $tmp);
  195.                                                 $tmp = str_replace('DISABLE_PLUGIN_OIDplusPagePublicUITweaks',
  196.                                                         'DISABLE_PLUGIN_TushevOrg\OIDplus\OIDplusPagePublicUITweaks', $tmp);
  197.                                                 $tmp = str_replace('DISABLE_PLUGIN_OIDplus',
  198.                                                         'DISABLE_PLUGIN_ViaThinkSoft\OIDplus\OIDplus', $tmp);
  199.  
  200.                                                 if (@file_put_contents($config_file, $tmp) === false) {
  201.                                                         eval('?>'.$tmp);
  202.                                                 } else {
  203.                                                         include $config_file;
  204.                                                 }
  205.                                         } else {
  206.                                                 include $config_file;
  207.                                         }
  208.                                 }
  209.  
  210.                                 // Backwards compatibility 2.0 => 2.1
  211.                                 if (defined('OIDPLUS_CONFIG_VERSION') && (OIDPLUS_CONFIG_VERSION == 2.0)) {
  212.                                         self::$oldConfigFormatLoaded = true;
  213.                                         foreach (get_defined_constants(true)['user'] as $name => $value) {
  214.                                                 $name = str_replace('OIDPLUS_', '', $name);
  215.                                                 if ($name == 'SESSION_SECRET') $name = 'SERVER_SECRET';
  216.                                                 if ($name == 'MYSQL_QUERYLOG') $name = 'QUERY_LOGFILE';
  217.                                                 $name = str_replace('DISABLE_PLUGIN_OIDplusPagePublicRdap',
  218.                                                         'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicRdap', $name);
  219.                                                 $name = str_replace('DISABLE_PLUGIN_OIDplusPagePublicAltIds',
  220.                                                         'DISABLE_PLUGIN_Frdlweb\OIDplus\OIDplusPagePublicAltIds', $name);
  221.                                                 $name = str_replace('DISABLE_PLUGIN_OIDplusPagePublicUITweaks',
  222.                                                         'DISABLE_PLUGIN_TushevOrg\OIDplus\OIDplusPagePublicUITweaks', $name);
  223.                                                 $name = str_replace('DISABLE_PLUGIN_OIDplus',
  224.                                                         'DISABLE_PLUGIN_ViaThinkSoft\OIDplus\OIDplus', $name);
  225.                                                 if ($name == 'CONFIG_VERSION') {
  226.                                                         $value = 2.1;
  227.                                                 } else if (($name == 'MYSQL_PASSWORD') || ($name == 'ODBC_PASSWORD') || ($name == 'PDO_PASSWORD') || ($name == 'PGSQL_PASSWORD')) {
  228.                                                         $value = base64_decode($value);
  229.                                                 }
  230.                                                 self::$baseConfig->setValue($name, $value);
  231.                                         }
  232.                                 }
  233.                         } else {
  234.                                 if (!is_dir(OIDplus::localpath().'setup')) {
  235.                                         throw new OIDplusConfigInitializationException(_L('File %1 is missing, but setup can\'t be started because its directory missing.',$config_file));
  236.                                 } else {
  237.                                         if (self::$html) {
  238.                                                 if (!self::insideSetup()) {
  239.                                                         header('Location:'.OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/');
  240.                                                         die(_L('Redirecting to setup...'));
  241.                                                 } else {
  242.                                                         return self::$baseConfig;
  243.                                                 }
  244.                                         } else {
  245.                                                 // This can be displayed in e.g. ajax.php
  246.                                                 throw new OIDplusConfigInitializationException(_L('File %1 is missing. Please run setup again.',$config_file));
  247.                                         }
  248.                                 }
  249.                         }
  250.  
  251.                         // Check important config settings
  252.  
  253.                         if (self::$baseConfig->getValue('CONFIG_VERSION') != 2.1) {
  254.                                 if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/') !== 0) {
  255.                                         throw new OIDplusConfigInitializationException(_L("The information located in %1 is outdated.",realpath($config_file)));
  256.                                 }
  257.                         }
  258.  
  259.                         if (self::$baseConfig->getValue('SERVER_SECRET', '') === '') {
  260.                                 if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/') !== 0) {
  261.                                         throw new OIDplusConfigInitializationException(_L("You must set a value for SERVER_SECRET in %1 for the system to operate secure.",realpath($config_file)));
  262.                                 }
  263.                         }
  264.                 }
  265.  
  266.                 return self::$baseConfig;
  267.         }
  268.  
  269.         private static $config = null;
  270.  
  271.         /**
  272.          * @return OIDplusConfig
  273.          * @throws OIDplusException
  274.          */
  275.         public static function config(): OIDplusConfig {
  276.                 if ($first_init = is_null(self::$config)) {
  277.                         self::$config = new OIDplusConfig();
  278.                 }
  279.  
  280.                 if ($first_init) {
  281.                         // These are important settings for base functionalities and therefore are not inside plugins
  282.                         self::$config->prepareConfigKey('system_title', 'What is the name of your RA?', 'OIDplus 2.0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  283.                                 if (empty($value)) {
  284.                                         throw new OIDplusException(_L('Please enter a value for the system title.'));
  285.                                 }
  286.                         });
  287.                         self::$config->prepareConfigKey('admin_email', 'E-Mail address of the system administrator', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  288.                                 if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
  289.                                         throw new OIDplusException(_L('This is not a correct email address'));
  290.                                 }
  291.                         });
  292.                         self::$config->prepareConfigKey('global_cc', 'Global CC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function(&$value) {
  293.                                 $value = trim($value);
  294.                                 if ($value === '') return;
  295.                                 $addrs = explode(';', $value);
  296.                                 foreach ($addrs as $addr) {
  297.                                         $addr = trim($addr);
  298.                                         if (!empty($addr) && !OIDplus::mailUtils()->validMailAddress($addr)) {
  299.                                                 throw new OIDplusException(_L('%1 is not a correct email address',$addr));
  300.                                         }
  301.                                 }
  302.                         });
  303.                         self::$config->prepareConfigKey('global_bcc', 'Global BCC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function(&$value) {
  304.                                 $value = trim($value);
  305.                                 if ($value === '') return;
  306.                                 $addrs = explode(';', $value);
  307.                                 foreach ($addrs as $addr) {
  308.                                         $addr = trim($addr);
  309.                                         if (!empty($addr) && !OIDplus::mailUtils()->validMailAddress($addr)) {
  310.                                                 throw new OIDplusException(_L('%1 is not a correct email address',$addr));
  311.                                         }
  312.                                 }
  313.                         });
  314.                         self::$config->prepareConfigKey('objecttypes_initialized', 'List of object type plugins that were initialized once', '', OIDplusConfig::PROTECTION_READONLY, function($value) {
  315.                                 // Nothing here yet
  316.                         });
  317.                         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) {
  318.                                 // 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?
  319.  
  320.                                 $ary = explode(';',$value);
  321.                                 $uniq_ary = array_unique($ary);
  322.  
  323.                                 if (count($ary) != count($uniq_ary)) {
  324.                                         throw new OIDplusException(_L('Please check your input. Some object types are double.'));
  325.                                 }
  326.  
  327.                                 foreach ($ary as $ot_check) {
  328.                                         $ns_found = false;
  329.                                         foreach (OIDplus::getEnabledObjectTypes() as $ot) {
  330.                                                 if ($ot::ns() == $ot_check) {
  331.                                                         $ns_found = true;
  332.                                                         break;
  333.                                                 }
  334.                                         }
  335.                                         foreach (OIDplus::getDisabledObjectTypes() as $ot) {
  336.                                                 if ($ot::ns() == $ot_check) {
  337.                                                         $ns_found = true;
  338.                                                         break;
  339.                                                 }
  340.                                         }
  341.                                         if (!$ns_found) {
  342.                                                 throw new OIDplusException(_L('Please check your input. Namespace "%1" is not found',$ot_check));
  343.                                         }
  344.                                 }
  345.                         });
  346.                         self::$config->prepareConfigKey('oidplus_private_key', 'Private key for this system', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
  347.                                 // Nothing here yet
  348.                         });
  349.                         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) {
  350.                                 // Nothing here yet
  351.                         });
  352.                         self::$config->prepareConfigKey('last_known_system_url', 'Last known System URL', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
  353.                                 // Nothing here yet
  354.                         });
  355.                         self::$config->prepareConfigKey('last_known_version', 'Last known OIDplus Version', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
  356.                                 // Nothing here yet
  357.                         });
  358.                         self::$config->prepareConfigKey('default_ra_auth_method', 'Default auth method used for generating password of RAs (must exist in plugins/[vendorname]/auth/)? Empty = OIDplus decides.', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  359.                                 if (trim($value) === '') return; // OIDplus decides
  360.  
  361.                                 $good = true;
  362.                                 if (strpos($value,'/') !== false) $good = false;
  363.                                 if (strpos($value,'\\') !== false) $good = false;
  364.                                 if (strpos($value,'..') !== false) $good = false;
  365.                                 if (!$good) {
  366.                                         throw new OIDplusException(_L('Invalid auth plugin folder name. Do only enter a folder name, not an absolute or relative path'));
  367.                                 }
  368.  
  369.                                 OIDplus::checkRaAuthPluginAvailable($value, true);
  370.                         });
  371.                 }
  372.  
  373.                 return self::$config;
  374.         }
  375.  
  376.         private static $gui = null;
  377.  
  378.         /**
  379.          * @return OIDplusGui
  380.          */
  381.         public static function gui(): OIDplusGui {
  382.                 if (is_null(self::$gui)) {
  383.                         self::$gui = new OIDplusGui();
  384.                 }
  385.                 return self::$gui;
  386.         }
  387.  
  388.         private static $authUtils = null;
  389.  
  390.         /**
  391.          * @return OIDplusAuthUtils
  392.          */
  393.         public static function authUtils(): OIDplusAuthUtils {
  394.                 if (is_null(self::$authUtils)) {
  395.                         self::$authUtils = new OIDplusAuthUtils();
  396.                 }
  397.                 return self::$authUtils;
  398.         }
  399.  
  400.         private static $mailUtils = null;
  401.  
  402.         /**
  403.          * @return OIDplusMailUtils
  404.          */
  405.         public static function mailUtils(): OIDplusMailUtils {
  406.                 if (is_null(self::$mailUtils)) {
  407.                         self::$mailUtils = new OIDplusMailUtils();
  408.                 }
  409.                 return self::$mailUtils;
  410.         }
  411.  
  412.         private static $cookieUtils = null;
  413.  
  414.         /**
  415.          * @return OIDplusCookieUtils
  416.          */
  417.         public static function cookieUtils(): OIDplusCookieUtils {
  418.                 if (is_null(self::$cookieUtils)) {
  419.                         self::$cookieUtils = new OIDplusCookieUtils();
  420.                 }
  421.                 return self::$cookieUtils;
  422.         }
  423.  
  424.         private static $menuUtils = null;
  425.  
  426.         /**
  427.          * @return OIDplusMenuUtils
  428.          */
  429.         public static function menuUtils(): OIDplusMenuUtils {
  430.                 if (is_null(self::$menuUtils)) {
  431.                         self::$menuUtils = new OIDplusMenuUtils();
  432.                 }
  433.                 return self::$menuUtils;
  434.         }
  435.  
  436.         private static $logger = null;
  437.  
  438.         /**
  439.          * @return OIDplusLogger
  440.          */
  441.         public static function logger(): OIDplusLogger {
  442.                 if (is_null(self::$logger)) {
  443.                         self::$logger = new OIDplusLogger();
  444.                 }
  445.                 return self::$logger;
  446.         }
  447.  
  448.         // --- SQL slang plugin
  449.  
  450.         /**
  451.          * @param OIDplusSqlSlangPlugin $plugin
  452.          * @return void
  453.          * @throws OIDplusException
  454.          */
  455.         private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) {
  456.                 $name = $plugin::id();
  457.  
  458.                 if ($name === '') {
  459.                         throw new OIDplusException(_L('Plugin %1 cannot be registered because it does not return a valid ID', $plugin->getPluginDirectory()));
  460.                 }
  461.  
  462.                 if (isset(self::$sqlSlangPlugins[$name])) {
  463.                         $plugintype_hf = _L('SQL slang');
  464.                         throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
  465.                 }
  466.  
  467.                 self::$sqlSlangPlugins[$name] = $plugin;
  468.         }
  469.  
  470.         /**
  471.          * @return OIDplusSqlSlangPlugin[]
  472.          */
  473.         public static function getSqlSlangPlugins(): array {
  474.                 return self::$sqlSlangPlugins;
  475.         }
  476.  
  477.         /**
  478.          * @param string $id
  479.          * @return OIDplusSqlSlangPlugin|null
  480.          */
  481.         public static function getSqlSlangPlugin(string $id)/*: ?OIDplusSqlSlangPlugin*/ {
  482.                 if (isset(self::$sqlSlangPlugins[$id])) {
  483.                         return self::$sqlSlangPlugins[$id];
  484.                 } else {
  485.                         return null;
  486.                 }
  487.         }
  488.  
  489.         // --- Database plugin
  490.  
  491.         /**
  492.          * @param OIDplusDatabasePlugin $plugin
  493.          * @return void
  494.          * @throws OIDplusException
  495.          */
  496.         private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) {
  497.                 $name = $plugin::id();
  498.  
  499.                 if ($name === '') {
  500.                         throw new OIDplusException(_L('Plugin %1 cannot be registered because it does not return a valid ID', $plugin->getPluginDirectory()));
  501.                 }
  502.  
  503.                 if (isset(self::$dbPlugins[$name])) {
  504.                         $plugintype_hf = _L('Database');
  505.                         throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
  506.                 }
  507.  
  508.                 self::$dbPlugins[$name] = $plugin;
  509.         }
  510.  
  511.         /**
  512.          * @return OIDplusDatabasePlugin[]
  513.          */
  514.         public static function getDatabasePlugins(): array {
  515.                 return self::$dbPlugins;
  516.         }
  517.  
  518.         /**
  519.          * @return OIDplusDatabasePlugin
  520.          * @throws OIDplusException, OIDplusConfigInitializationException
  521.          */
  522.         public static function getActiveDatabasePlugin(): OIDplusDatabasePlugin {
  523.                 $db_plugin_name = OIDplus::baseConfig()->getValue('DATABASE_PLUGIN','');
  524.                 if ($db_plugin_name === '') {
  525.                         throw new OIDplusConfigInitializationException(_L('No database plugin selected in config file'));
  526.                 }
  527.                 foreach (self::$dbPlugins as $name => $plugin) {
  528.                         if (strtolower($name) == strtolower($db_plugin_name)) {
  529.                                 return $plugin;
  530.                         }
  531.                 }
  532.                 throw new OIDplusConfigInitializationException(_L('Database plugin "%1" not found',$db_plugin_name));
  533.         }
  534.  
  535.         /**
  536.          * @var OIDplusDatabaseConnection|null
  537.          */
  538.         private static $dbMainSession = null;
  539.  
  540.         /**
  541.          * @return OIDplusDatabaseConnection
  542.          * @throws OIDplusException, OIDplusConfigInitializationException
  543.          */
  544.         public static function db(): OIDplusDatabaseConnection {
  545.                 if (is_null(self::$dbMainSession)) {
  546.                         self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
  547.                 }
  548.                 if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
  549.                 return self::$dbMainSession;
  550.         }
  551.  
  552.         /**
  553.          * @var OIDplusDatabaseConnection|null
  554.          */
  555.         private static $dbIsolatedSession = null;
  556.  
  557.         /**
  558.          * @return OIDplusDatabaseConnection
  559.          * @throws OIDplusException, OIDplusConfigInitializationException
  560.          */
  561.         public static function dbIsolated(): OIDplusDatabaseConnection {
  562.                 if (is_null(self::$dbIsolatedSession)) {
  563.                         self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
  564.                 }
  565.                 if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
  566.                 return self::$dbIsolatedSession;
  567.         }
  568.  
  569.         // --- CAPTCHA plugin
  570.  
  571.         /**
  572.          * @param OIDplusCaptchaPlugin $plugin
  573.          * @return void
  574.          * @throws OIDplusException
  575.          */
  576.         private static function registerCaptchaPlugin(OIDplusCaptchaPlugin $plugin) {
  577.                 $name = $plugin::id();
  578.  
  579.                 if ($name === '') {
  580.                         throw new OIDplusException(_L('Plugin %1 cannot be registered because it does not return a valid ID', $plugin->getPluginDirectory()));
  581.                 }
  582.  
  583.                 if (isset(self::$captchaPlugins[$name])) {
  584.                         $plugintype_hf = _L('CAPTCHA');
  585.                         throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
  586.                 }
  587.  
  588.                 self::$captchaPlugins[$name] = $plugin;
  589.         }
  590.  
  591.         /**
  592.          * @return OIDplusCaptchaPlugin[]
  593.          */
  594.         public static function getCaptchaPlugins(): array {
  595.                 return self::$captchaPlugins;
  596.         }
  597.  
  598.         /**
  599.          * @return string
  600.          * @throws OIDplusException, OIDplusConfigInitializationException
  601.          */
  602.         public static function getActiveCaptchaPluginId(): string {
  603.                 $captcha_plugin_name = OIDplus::baseConfig()->getValue('CAPTCHA_PLUGIN', '');
  604.  
  605.                 if (OIDplus::baseConfig()->getValue('RECAPTCHA_ENABLED', false) && ($captcha_plugin_name === '')) {
  606.                         // Legacy config file support!
  607.                         $captcha_plugin_name = 'reCAPTCHA';
  608.                 }
  609.  
  610.                 if ($captcha_plugin_name === '') $captcha_plugin_name = 'None'; // the "None" plugin is a must-have!
  611.  
  612.                 return $captcha_plugin_name;
  613.         }
  614.  
  615.         /**
  616.          * @return OIDplusCaptchaPlugin
  617.          * @throws OIDplusException, OIDplusConfigInitializationException
  618.          */
  619.         public static function getActiveCaptchaPlugin(): OIDplusCaptchaPlugin {
  620.                 $captcha_plugin_name = OIDplus::getActiveCaptchaPluginId();
  621.                 foreach (self::$captchaPlugins as $name => $plugin) {
  622.                         if (strtolower($name) == strtolower($captcha_plugin_name)) {
  623.                                 return $plugin;
  624.                         }
  625.                 }
  626.                 throw new OIDplusConfigInitializationException(_L('CAPTCHA plugin "%1" not found',$captcha_plugin_name));
  627.         }
  628.  
  629.         // --- Page plugin
  630.  
  631.         /**
  632.          * @param OIDplusPagePlugin $plugin
  633.          * @return void
  634.          */
  635.         private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
  636.                 self::$pagePlugins[] = $plugin;
  637.         }
  638.  
  639.         /**
  640.          * @return OIDplusPagePlugin[]
  641.          */
  642.         public static function getPagePlugins(): array {
  643.                 return self::$pagePlugins;
  644.         }
  645.  
  646.         // --- Auth plugin
  647.  
  648.         /**
  649.          * @param string $foldername
  650.          * @return OIDplusAuthPlugin|null
  651.          */
  652.         public static function getAuthPluginByFoldername(string $foldername)/*: ?OIDplusAuthPlugin*/ {
  653.                 $plugins = OIDplus::getAuthPlugins();
  654.                 foreach ($plugins as $plugin) {
  655.                         if (basename($plugin->getPluginDirectory()) === $foldername) {
  656.                                 return $plugin;
  657.                         }
  658.                 }
  659.                 return null;
  660.         }
  661.  
  662.         /**
  663.          * @param string $plugin_foldername
  664.          * @param bool $must_hash
  665.          * @return void
  666.          * @throws OIDplusException
  667.          */
  668.         private static function checkRaAuthPluginAvailable(string $plugin_foldername, bool $must_hash) {
  669.                 // if (!wildcard_is_dir(OIDplus::localpath().'plugins/'.'*'.'/auth/'.$plugin_foldername)) {
  670.                 $plugin = OIDplus::getAuthPluginByFoldername($plugin_foldername);
  671.                 if (is_null($plugin)) {
  672.                         throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$plugin_foldername,'plugins/[vendorname]/auth/'));
  673.                 }
  674.  
  675.                 $reason = '';
  676.                 if (!$plugin->availableForVerify($reason)) {
  677.                         throw new OIDplusException(trim(_L('The auth plugin "%1" is not available for password verification on this system.',$plugin_foldername).' '.$reason));
  678.                 }
  679.                 if ($must_hash && !$plugin->availableForHash($reason)) {
  680.                         throw new OIDplusException(trim(_L('The auth plugin "%1" is not available for hashing on this system.',$plugin_foldername).' '.$reason));
  681.                 }
  682.         }
  683.  
  684.         /**
  685.          * @param bool $must_hash
  686.          * @return OIDplusAuthPlugin|null
  687.          * @throws OIDplusException
  688.          */
  689.         public static function getDefaultRaAuthPlugin(bool $must_hash)/*: OIDplusAuthPlugin*/ {
  690.                 // 1. Priority: Use the auth plugin the user prefers
  691.                 $def_plugin_foldername = OIDplus::config()->getValue('default_ra_auth_method');
  692.                 if (trim($def_plugin_foldername) !== '') {
  693.                         OIDplus::checkRaAuthPluginAvailable($def_plugin_foldername, $must_hash);
  694.                         return OIDplus::getAuthPluginByFoldername($def_plugin_foldername);
  695.                 }
  696.  
  697.                 // 2. Priority: If empty (i.e. OIDplus may decide), choose the best ViaThinkSoft plugin that is supported on this system
  698.                 $preferred_auth_plugins = array(
  699.                         // Sorted by preference
  700.                         'A4_argon2',  // usually Salted Argon2id
  701.                         'A3_bcrypt',  // usually Salted BCrypt
  702.                         'A5_vts_mcf', // usually SHA3-512-HMAC
  703.                         'A6_crypt'    // usually Salted SHA512 with 5000 rounds
  704.                 );
  705.                 foreach ($preferred_auth_plugins as $plugin_foldername) {
  706.                         $plugin = OIDplus::getAuthPluginByFoldername($plugin_foldername);
  707.                         if (is_null($plugin)) continue;
  708.  
  709.                         $reason = '';
  710.                         if (!$plugin->availableForHash($reason)) continue;
  711.                         if ($must_hash && !$plugin->availableForVerify($reason)) continue;
  712.                         return $plugin;
  713.                 }
  714.  
  715.                 // 3. Priority: If nothing found, take the first found plugin
  716.                 $plugins = OIDplus::getAuthPlugins();
  717.                 foreach ($plugins as $plugin) {
  718.                         $reason = '';
  719.                         if (!$plugin->availableForHash($reason)) continue;
  720.                         if ($must_hash && !$plugin->availableForVerify($reason)) continue;
  721.                         return $plugin;
  722.                 }
  723.  
  724.                 // 4. Priority: We must deny the creation of the password because we have no auth plugin!
  725.                 throw new OIDplusException(_L('Could not find a fitting auth plugin!'));
  726.         }
  727.  
  728.         /**
  729.          * @param OIDplusAuthPlugin $plugin
  730.          * @return void
  731.          * @throws OIDplusConfigInitializationException
  732.          * @throws OIDplusException
  733.          */
  734.         private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
  735.                 $reason = '';
  736.                 if (OIDplus::baseConfig()->getValue('DEBUG') && $plugin->availableForHash($reason) && $plugin->availableForVerify($reason)) {
  737.                         $password = generateRandomString(25);
  738.  
  739.                         try {
  740.                                 $authInfo = $plugin->generate($password);
  741.                         } catch (OIDplusException $e) {
  742.                                 // This can happen when the AuthKey is too long for the database field
  743.                                 // Note: The constructor and setters of OIDplusRAAuthInfo() already check for length and null/false values.
  744.                                 throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
  745.                         }
  746.  
  747.                         $authInfo_AuthKeyDiff = clone $authInfo;
  748.                         $authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
  749.  
  750.                         if ((!$plugin->verify($authInfo,$password)) ||
  751.                                 ($plugin->verify($authInfo_AuthKeyDiff,$password)) ||
  752.                                 ($plugin->verify($authInfo,$password.'x'))) {
  753.                                 throw new OIDplusException(_L('Auth plugin "%1" is erroneous: Generate/Verify self-test failed',basename($plugin->getPluginDirectory())));
  754.                         }
  755.                 }
  756.  
  757.                 self::$authPlugins[] = $plugin;
  758.         }
  759.  
  760.         /**
  761.          * @return OIDplusAuthPlugin[]
  762.          */
  763.         public static function getAuthPlugins(): array {
  764.                 return self::$authPlugins;
  765.         }
  766.  
  767.         // --- Language plugin
  768.  
  769.         /**
  770.          * @param OIDplusLanguagePlugin $plugin
  771.          * @return void
  772.          */
  773.         private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
  774.                 self::$languagePlugins[] = $plugin;
  775.         }
  776.  
  777.         /**
  778.          * @return OIDplusLanguagePlugin[]
  779.          */
  780.         public static function getLanguagePlugins(): array {
  781.                 return self::$languagePlugins;
  782.         }
  783.  
  784.         // --- Design plugin
  785.  
  786.         /**
  787.          * @param OIDplusDesignPlugin $plugin
  788.          * @return void
  789.          */
  790.         private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
  791.                 self::$designPlugins[] = $plugin;
  792.         }
  793.  
  794.         /**
  795.          * @return OIDplusDesignPlugin[]
  796.          */
  797.         public static function getDesignPlugins(): array {
  798.                 return self::$designPlugins;
  799.         }
  800.  
  801.         /**
  802.          * @return OIDplusDesignPlugin|null
  803.          * @throws OIDplusException
  804.          */
  805.         public static function getActiveDesignPlugin()/*: ?OIDplusDesignPlugin*/ {
  806.                 $plugins = OIDplus::getDesignPlugins();
  807.                 foreach ($plugins as $plugin) {
  808.                         if ((basename($plugin->getPluginDirectory())) == OIDplus::config()->getValue('design','default')) {
  809.                                 return $plugin;
  810.                         }
  811.                 }
  812.                 return null;
  813.         }
  814.  
  815.         // --- Logger plugin
  816.  
  817.         /**
  818.          * @param OIDplusLoggerPlugin $plugin
  819.          * @return void
  820.          */
  821.         private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
  822.                 self::$loggerPlugins[] = $plugin;
  823.         }
  824.  
  825.         /**
  826.          * @return OIDplusLoggerPlugin[]
  827.          */
  828.         public static function getLoggerPlugins(): array {
  829.                 return self::$loggerPlugins;
  830.         }
  831.  
  832.         // --- Object type plugin
  833.  
  834.         /**
  835.          * @param OIDplusObjectTypePlugin $plugin
  836.          * @return void
  837.          * @throws OIDplusException
  838.          */
  839.         private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
  840.                 self::$objectTypePlugins[] = $plugin;
  841.  
  842.                 $ot = $plugin::getObjectTypeClassName();
  843.                 self::registerObjectType($ot);
  844.         }
  845.  
  846.         /**
  847.          * @param string|OIDplusObject $ot Object type class name (OIDplusObject)
  848.          * @return void
  849.          * @throws OIDplusException
  850.          */
  851.         private static function registerObjectType($ot) {
  852.                 $ns = $ot::ns();
  853.                 if (empty($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace must not be empty',$ot));
  854.  
  855.                 // Currently, we must enforce that namespaces in objectType plugins are lowercase, because prefilterQuery() makes all namespaces lowercase and the DBMS should be case-sensitive
  856.                 if ($ns != strtolower($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace %2 must be lower-case',$ot,$ns));
  857.  
  858.                 $root = $ot::root();
  859.                 if (!str_starts_with($root,$ns.':')) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Root node (%2) is in wrong namespace (needs starts with %3)!',$ot,$root,$ns.':'));
  860.  
  861.                 $ns_found = false;
  862.                 foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
  863.                         if ($test_ot::ns() == $ns) {
  864.                                 $ns_found = true;
  865.                                 break;
  866.                         }
  867.                 }
  868.                 if ($ns_found) {
  869.                         throw new OIDplusException(_L('Attention: Two objectType plugins use the same namespace "%1"!',$ns));
  870.                 }
  871.  
  872.                 $init = OIDplus::config()->getValue("objecttypes_initialized");
  873.                 $init_ary = empty($init) ? array() : explode(';', $init);
  874.                 $init_ary = array_map('trim', $init_ary);
  875.  
  876.                 $enabled = OIDplus::config()->getValue("objecttypes_enabled");
  877.                 $enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
  878.                 $enabled_ary = array_map('trim', $enabled_ary);
  879.  
  880.                 if (in_array($ns, $enabled_ary)) {
  881.                         // If it is in the list of enabled object types, it is enabled (obviously)
  882.                         $do_enable = true;
  883.                 } else {
  884.                         if (!OIDplus::config()->getValue('oobe_objects_done')) {
  885.                                 // If the OOBE wizard is NOT done, then just enable the "oid" object type by default
  886.                                 $do_enable = $ns == 'oid';
  887.                         } else {
  888.                                 // If the OOBE wizard was done (once), then
  889.                                 // we will enable all object types which were never initialized
  890.                                 // (i.e. a plugin folder was freshly added)
  891.                                 $do_enable = !in_array($ns, $init_ary);
  892.                         }
  893.                 }
  894.  
  895.                 if ($do_enable) {
  896.                         self::$enabledObjectTypes[] = $ot;
  897.                         usort(self::$enabledObjectTypes, function($a, $b) {
  898.                                 $enabled = OIDplus::config()->getValue("objecttypes_enabled");
  899.                                 $enabled_ary = explode(';', $enabled);
  900.  
  901.                                 $idx_a = array_search($a::ns(), $enabled_ary);
  902.                                 $idx_b = array_search($b::ns(), $enabled_ary);
  903.  
  904.                                 if ($idx_a == $idx_b) return 0;
  905.                                 return ($idx_a > $idx_b) ? +1 : -1;
  906.                         });
  907.                 } else {
  908.                         self::$disabledObjectTypes[] = $ot;
  909.                 }
  910.  
  911.                 if (!in_array($ns, $init_ary)) {
  912.                         // Was never initialized before, so we add it to the list of enabled object types once
  913.  
  914.                         if ($do_enable) {
  915.                                 $enabled_ary[] = $ns;
  916.                                 // Important: Don't validate the input, because the other object types might not be initialized yet! So use setValueNoCallback() instead setValue().
  917.                                 OIDplus::config()->setValueNoCallback("objecttypes_enabled", implode(';', $enabled_ary));
  918.                         }
  919.  
  920.                         $init_ary[] = $ns;
  921.                         OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
  922.                 }
  923.         }
  924.  
  925.         /**
  926.          * @return OIDplusObjectTypePlugin[]
  927.          */
  928.         public static function getObjectTypePlugins(): array {
  929.                 return self::$objectTypePlugins;
  930.         }
  931.  
  932.         /**
  933.          * @return OIDplusObjectTypePlugin[]
  934.          */
  935.         public static function getObjectTypePluginsEnabled(): array {
  936.                 $res = array();
  937.                 foreach (self::$objectTypePlugins as $plugin) {
  938.                         $ot = $plugin::getObjectTypeClassName();
  939.                         if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
  940.                 }
  941.                 return $res;
  942.         }
  943.  
  944.         /**
  945.          * @return OIDplusObjectTypePlugin[]
  946.          */
  947.         public static function getObjectTypePluginsDisabled(): array {
  948.                 $res = array();
  949.                 foreach (self::$objectTypePlugins as $plugin) {
  950.                         $ot = $plugin::getObjectTypeClassName();
  951.                         if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
  952.                 }
  953.                 return $res;
  954.         }
  955.  
  956.         /**
  957.          * @return string[]|OIDplusObject[] Classname of a OIDplusObject class
  958.          */
  959.         public static function getEnabledObjectTypes(): array {
  960.                 return self::$enabledObjectTypes;
  961.         }
  962.  
  963.         /**
  964.          * @return string[]|OIDplusObject[] Classname of a OIDplusObject class
  965.          */
  966.         public static function getDisabledObjectTypes(): array {
  967.                 return self::$disabledObjectTypes;
  968.         }
  969.  
  970.         // --- Plugin handling functions
  971.  
  972.         /**
  973.          * @return OIDplusPlugin[]
  974.          */
  975.         public static function getAllPlugins(): array {
  976.                 $res = array();
  977.                 $res = array_merge($res, self::$pagePlugins);
  978.                 $res = array_merge($res, self::$authPlugins);
  979.                 $res = array_merge($res, self::$loggerPlugins);
  980.                 $res = array_merge($res, self::$objectTypePlugins);
  981.                 $res = array_merge($res, self::$dbPlugins);
  982.                 $res = array_merge($res, self::$captchaPlugins);
  983.                 $res = array_merge($res, self::$sqlSlangPlugins);
  984.                 $res = array_merge($res, self::$languagePlugins);
  985.                 return array_merge($res, self::$designPlugins);
  986.         }
  987.  
  988.         /**
  989.          * @param string $oid
  990.          * @return OIDplusPlugin|null
  991.          */
  992.         public static function getPluginByOid(string $oid)/*: ?OIDplusPlugin*/ {
  993.                 $plugins = self::getAllPlugins();
  994.                 foreach ($plugins as $plugin) {
  995.                         if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
  996.                                 return $plugin;
  997.                         }
  998.                 }
  999.                 return null;
  1000.         }
  1001.  
  1002.         /**
  1003.          * @param string $classname
  1004.          * @return OIDplusPlugin|null
  1005.          */
  1006.         public static function getPluginByClassName(string $classname)/*: ?OIDplusPlugin*/ {
  1007.                 $plugins = self::getAllPlugins();
  1008.                 foreach ($plugins as $plugin) {
  1009.                         if (get_class($plugin) === $classname) {
  1010.                                 return $plugin;
  1011.                         }
  1012.                 }
  1013.                 return null;
  1014.         }
  1015.  
  1016.         /**
  1017.          * Checks if the plugin is disabled
  1018.          * @return bool true if plugin is enabled, false if plugin is disabled
  1019.          * @throws OIDplusException if the class name or config file (disabled setting) does not contain a namespace
  1020.          */
  1021.         private static function pluginCheckDisabled($class_name): bool {
  1022.                 $path = explode('\\', $class_name);
  1023.  
  1024.                 if (count($path) == 1) {
  1025.                         throw new OIDplusException(_L('Plugin "%1" is erroneous',$class_name).': '._L('The plugin uses no namespaces. The new version of OIDplus requires plugin class files to be in a namespace. Please notify your plugin author and ask for an update.'));
  1026.                 }
  1027.  
  1028.                 $class_end = end($path);
  1029.                 if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_end, false)) {
  1030.                         throw new OIDplusConfigInitializationException(_L('Your base configuration file is outdated. Please change "%1" to "%2".','DISABLE_PLUGIN_'.$class_end,'DISABLE_PLUGIN_'.$class_name));
  1031.                 }
  1032.  
  1033.                 if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
  1034.                         return false;
  1035.                 }
  1036.  
  1037.                 return true;
  1038.         }
  1039.  
  1040.         /**
  1041.          * @param string $pluginFolderMasks
  1042.          * @param bool $flat
  1043.          * @return OIDplusPluginManifest[]|array<string,array<string,OIDplusPluginManifest>>
  1044.          * @throws OIDplusException
  1045.          */
  1046.         public static function getAllPluginManifests(string $pluginFolderMasks='*', bool $flat=true): array {
  1047.                 $out = array();
  1048.                 // Note: glob() will sort by default, so we do not need a page priority attribute.
  1049.                 //       So you just need to use a numeric plugin directory prefix (padded).
  1050.                 $ary = array();
  1051.                 foreach (explode(',',$pluginFolderMasks) as $pluginFolderMask) {
  1052.                         $ary = array_merge($ary,glob(OIDplus::localpath().'plugins/'.'*'.'/'.$pluginFolderMask.'/'.'*'.'/manifest.xml'));
  1053.                 }
  1054.  
  1055.                 // Sort the plugins by their type and name, as if they would be in a single vendor-folder!
  1056.                 uasort($ary, function($a,$b) {
  1057.                         if ($a == $b) return 0;
  1058.  
  1059.                         $a = str_replace('\\', '/', $a);
  1060.                         $ary = explode('/',$a);
  1061.                         $bry = explode('/',$b);
  1062.  
  1063.                         // First sort by type (publicPage, auth, database, language, ...)
  1064.                         $a_type = $ary[count($ary)-1-2];
  1065.                         $b_type = $bry[count($bry)-1-2];
  1066.                         if ($a_type < $b_type) return -1;
  1067.                         if ($a_type > $b_type) return 1;
  1068.  
  1069.                         // Then sort by name (090_login, 100_whois, etc.)
  1070.                         $a_name = $ary[count($ary)-1-1];
  1071.                         $b_name = $bry[count($bry)-1-1];
  1072.                         if ($a_name < $b_name) return -1;
  1073.                         if ($a_name > $b_name) return 1;
  1074.  
  1075.                         // If it is still equal, then finally sort by vendorname
  1076.                         $a_vendor = $ary[count($ary)-1-3];
  1077.                         $b_vendor = $bry[count($bry)-1-3];
  1078.                         if ($a_vendor < $b_vendor) return -1;
  1079.                         if ($a_vendor > $b_vendor) return 1;
  1080.                         return 0;
  1081.                 });
  1082.  
  1083.                 foreach ($ary as $ini) {
  1084.                         if (!file_exists($ini)) continue;
  1085.  
  1086.                         $manifest = new OIDplusPluginManifest();
  1087.                         $manifest->loadManifest($ini);
  1088.  
  1089.                         $class_name = $manifest->getPhpMainClass();
  1090.                         if ($class_name) if (!self::pluginCheckDisabled($class_name)) continue;
  1091.  
  1092.                         if ($flat) {
  1093.                                 $out[] = $manifest;
  1094.                         } else {
  1095.                                 $vendor_folder = basename(dirname($ini, 3));
  1096.                                 $plugintype_folder = basename(dirname($ini, 2));
  1097.                                 $pluginname_folder = basename(dirname($ini));
  1098.  
  1099.                                 if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
  1100.                                 if (!isset($out[$plugintype_folder][$vendor_folder])) $out[$plugintype_folder][$vendor_folder] = array();
  1101.                                 $out[$plugintype_folder][$vendor_folder][$pluginname_folder] = $manifest;
  1102.                         }
  1103.                 }
  1104.                 return $out;
  1105.         }
  1106.  
  1107.         /**
  1108.          * @param $pluginDirName
  1109.          * @param $expectedPluginClass
  1110.          * @param $registerCallback
  1111.          * @return string[]
  1112.          * @throws OIDplusConfigInitializationException
  1113.          * @throws OIDplusException
  1114.          * @throws \ReflectionException
  1115.          */
  1116.         public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
  1117.                 $out = array();
  1118.                 if (is_array($pluginDirName)) {
  1119.                         $ary = array();
  1120.                         foreach ($pluginDirName as $pluginDirName_) {
  1121.                                 $ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
  1122.                         }
  1123.                 } else {
  1124.                         $ary = self::getAllPluginManifests($pluginDirName, false);
  1125.                 }
  1126.                 $known_plugin_oids = array();
  1127.                 if (OIDplus::baseConfig()->getValue('DEBUG')) {
  1128.                         $fake_feature = uuid_to_oid(gen_uuid());
  1129.                 } else {
  1130.                         $fake_feature = null;
  1131.                 }
  1132.                 $known_main_classes_no_namespace = array();
  1133.                 foreach ($ary as $plugintype_folder => $bry) {
  1134.                         foreach ($bry as $vendor_folder => $cry) {
  1135.                                 foreach ($cry as $pluginname_folder => $manifest) {
  1136.                                         $class_name = $manifest->getPhpMainClass();
  1137.  
  1138.                                         // Before we load the plugin, we want to make some checks to confirm
  1139.                                         // that the plugin is working correctly.
  1140.  
  1141.                                         if (!$class_name) {
  1142.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Manifest does not declare a PHP main class'));
  1143.                                         }
  1144.                                         if (!self::pluginCheckDisabled($class_name)) {
  1145.                                                 continue; // Plugin is disabled
  1146.                                         }
  1147.  
  1148.                                         // The auto-loader of OIDplus currently does not accept PHP namespaces.
  1149.                                         // Reason: The autoloader detects the classes inside plugins/*/*/*/*.class.php, but it cannot know
  1150.                                         //         which namespace these files have, because their folder names do not reveal the namespace.
  1151.                                         //         So it just ignores the namespace and loads all classes with the same name.
  1152.                                         // TODO: Think about a solution; There was a discussion here https://github.com/frdl/frdl-oidplus-plugin-type-pen/issues/1
  1153.                                         $tmp = explode('\\',$class_name);
  1154.                                         $class_name_no_namespace = end($tmp);
  1155.                                         if (in_array($class_name_no_namespace, $known_main_classes_no_namespace)) {
  1156.                                                 // Removed check for now, since everything should work correctly
  1157.                                                 // throw new OIDplusException(_L('More than one plugin has the PHP class name "%1". This is currently no supported, not even if they are in different namespaces.', $class_name_no_namespace));
  1158.                                         }
  1159.                                         $known_main_classes_no_namespace[] = $class_name_no_namespace;
  1160.  
  1161.                                         // Do some basic checks on the plugin PHP main class
  1162.                                         if (!class_exists($class_name)) {
  1163.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Manifest declares PHP main class as "%1", but it could not be found', $class_name));
  1164.                                         }
  1165.                                         if (!is_subclass_of($class_name, $expectedPluginClass)) {
  1166.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Plugin main class "%1" is expected to be a subclass of "%2"', $class_name, $expectedPluginClass));
  1167.                                         }
  1168.                                         if (($class_name != $manifest->getTypeClass()) && (!is_subclass_of($class_name, $manifest->getTypeClass()))) {
  1169.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $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()));
  1170.                                         }
  1171.                                         if (($manifest->getTypeClass() != $expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(), $expectedPluginClass))) {
  1172.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Class declared in manifest is "%1" does not fit expected class for this plugin type "%2"', $manifest->getTypeClass(), $expectedPluginClass));
  1173.                                         }
  1174.  
  1175.                                         // Do some basic checks on the plugin OID
  1176.                                         $plugin_oid = $manifest->getOid();
  1177.                                         if (!$plugin_oid) {
  1178.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Does not have an OID'));
  1179.                                         }
  1180.                                         if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) {
  1181.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Plugin OID "%1" is invalid (needs to be valid dot-notation)', $plugin_oid));
  1182.                                         }
  1183.                                         if (isset($known_plugin_oids[$plugin_oid])) {
  1184.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('The OID "%1" is already used by the plugin "%2"', $plugin_oid, $known_plugin_oids[$plugin_oid]));
  1185.                                         }
  1186.  
  1187.                                         // Additional check: Are third-party plugins using ViaThinkSoft plugin folders, OIDs or class namespaces?
  1188.                                         $full_plugin_dir = dirname($manifest->getManifestFile());
  1189.                                         $full_plugin_dir = substr($full_plugin_dir, strlen(OIDplus::localpath()));
  1190.                                         $dir_is_viathinksoft = str_starts_with($full_plugin_dir, 'plugins/viathinksoft/') || str_starts_with($full_plugin_dir, 'plugins\\viathinksoft\\');
  1191.                                         $oid_is_viathinksoft = str_starts_with($plugin_oid, '1.3.6.1.4.1.37476.2.5.2.4.'); // { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) 37476 products(2) oidplus(5) v2(2) plugins(4) }
  1192.                                         $class_is_viathinksoft = str_starts_with($class_name, 'ViaThinkSoft\\');
  1193.                                         if ($oid_is_viathinksoft != $class_is_viathinksoft) {
  1194.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('Third-party plugins must not use the ViaThinkSoft PHP namespace. Please use your own vendor namespace.'));
  1195.                                         }
  1196.                                         $plugin_is_viathinksoft = $oid_is_viathinksoft && $class_is_viathinksoft;
  1197.                                         if ($dir_is_viathinksoft != $plugin_is_viathinksoft) {
  1198.                                                 throw new OIDplusException(_L('Plugin "%1" is misplaced', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('The plugin is in the wrong folder. The folder %1 can only be used by official ViaThinkSoft plugins', 'plugins/viathinksoft/'));
  1199.                                         }
  1200.  
  1201.                                         // Additional check: does the plugin define JS/CSS although it is not an interactive plugin type?
  1202.                                         $has_js = $manifest->getJSFiles();
  1203.                                         $has_css = $manifest->getCSSFiles();
  1204.                                         $is_interactive = in_array(basename($plugintype_folder), OIDplus::INTERACTIVE_PLUGIN_TYPES);
  1205.                                         $is_design = basename($plugintype_folder) === 'design';
  1206.                                         if (!$is_interactive && $has_js) {
  1207.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('%1 files are included in the manifest XML, but this plugin type does not allow such files.', 'JavaScript'));
  1208.                                         }
  1209.                                         if (!$is_interactive && !$is_design && $has_css) {
  1210.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('%1 files are included in the manifest XML, but this plugin type does not allow such files.', 'CSS'));
  1211.                                         }
  1212.  
  1213.                                         // Additional check: Check "Setup CSS" and "Setup JS" (Allowed for plugin types: database, captcha)
  1214.                                         $has_js_setup = $manifest->getJSFilesSetup();
  1215.                                         $has_css_setup = $manifest->getCSSFilesSetup();
  1216.                                         $is_database = basename($plugintype_folder) === 'database';
  1217.                                         $is_captcha = basename($plugintype_folder) === 'captcha';
  1218.                                         if (!$is_database && !$is_captcha && $has_js_setup) {
  1219.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('%1 files are included in the manifest XML, but this plugin type does not allow such files.', 'Setup JavaScript'));
  1220.                                         }
  1221.                                         if (!$is_database && !$is_captcha && $has_css_setup) {
  1222.                                                 throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('%1 files are included in the manifest XML, but this plugin type does not allow such files.', 'Setup CSS'));
  1223.                                         }
  1224.  
  1225.                                         // Additional check: Are all CSS/JS files there?
  1226.                                         $tmp = $manifest->getManifestLinkedFiles();
  1227.                                         foreach ($tmp as $file) {
  1228.                                                 if (!file_exists($file)) {
  1229.                                                         throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('File %1 was defined in manifest, but it is not existing', $file));
  1230.                                                 }
  1231.                                         }
  1232.  
  1233.                                         // For the next check, we need an instance of the object
  1234.                                         $obj = new $class_name();
  1235.  
  1236.                                         // Additional check: Does the plugin misuse implementsFeature()?
  1237.                                         // This is not enabled b default, because the GUID generation is slow on some machines.
  1238.                                         // Also, it is very unlikely that someone misuses implementsFeature().
  1239.                                         if (OIDplus::baseConfig()->getValue('DEBUG')) {
  1240.                                                 if ($obj->implementsFeature($fake_feature)) {
  1241.                                                         // see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663
  1242.                                                         throw new OIDplusException(_L('Plugin "%1" is erroneous', $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder) . ': ' . _L('implementsFeature() always returns true'));
  1243.                                                 }
  1244.                                         }
  1245.  
  1246.                                         // Now we can continue
  1247.                                         $known_plugin_oids[$plugin_oid] = $vendor_folder . '/' . $plugintype_folder . '/' . $pluginname_folder;
  1248.                                         $out[] = $class_name;
  1249.                                         if (!is_null($registerCallback)) {
  1250.                                                 call_user_func($registerCallback, $obj);
  1251.  
  1252.                                                 // Alternative approaches:
  1253.                                                 //$registerCallback[0]::{$registerCallback[1]}($obj);
  1254.                                                 // or:
  1255.                                                 //forward_static_call($registerCallback, $obj);
  1256.                                         }
  1257.                                 }
  1258.                         }
  1259.                 }
  1260.                 return $out;
  1261.         }
  1262.  
  1263.         // --- Initialization of OIDplus
  1264.  
  1265.         /**
  1266.          * @param bool $html
  1267.          * @param bool $keepBaseConfig
  1268.          * @return void
  1269.          * @throws OIDplusConfigInitializationException
  1270.          * @throws OIDplusException
  1271.          */
  1272.         public static function init(bool $html=true, bool $keepBaseConfig=true) {
  1273.                 self::$html = $html;
  1274.  
  1275.                 // Reset internal state, so we can re-init verything if required
  1276.  
  1277.                 self::$config = null;
  1278.                 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
  1279.                 self::$gui = null;
  1280.                 self::$authUtils = null;
  1281.                 self::$mailUtils = null;
  1282.                 self::$menuUtils = null;
  1283.                 self::$logger = null;
  1284.                 self::$dbMainSession = null;
  1285.                 self::$dbIsolatedSession = null;
  1286.                 self::$pagePlugins = array();
  1287.                 self::$authPlugins = array();
  1288.                 self::$loggerPlugins = array();
  1289.                 self::$objectTypePlugins = array();
  1290.                 self::$enabledObjectTypes = array();
  1291.                 self::$disabledObjectTypes = array();
  1292.                 self::$dbPlugins = array();
  1293.                 self::$captchaPlugins = array();
  1294.                 self::$sqlSlangPlugins = array();
  1295.                 self::$languagePlugins = array();
  1296.                 self::$designPlugins = array();
  1297.                 self::$system_id_cache = null;
  1298.                 self::$sslAvailableCache = null;
  1299.                 self::$translationArray = array();
  1300.  
  1301.                 // Continue...
  1302.  
  1303.                 OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
  1304.                 // You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
  1305.  
  1306.                 // Register database types (highest priority)
  1307.  
  1308.                 // SQL slangs
  1309.  
  1310.                 self::registerAllPlugins('sqlSlang', OIDplusSqlSlangPlugin::class, array(OIDplus::class,'registerSqlSlangPlugin'));
  1311.                 foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
  1312.                         $plugin->init($html);
  1313.                 }
  1314.  
  1315.                 // Database providers
  1316.  
  1317.                 self::registerAllPlugins('database', OIDplusDatabasePlugin::class, array(OIDplus::class,'registerDatabasePlugin'));
  1318.                 foreach (OIDplus::getDatabasePlugins() as $plugin) {
  1319.                         $plugin->init($html);
  1320.                 }
  1321.  
  1322.                 // Do redirect stuff etc.
  1323.  
  1324.                 self::isSslAvailable(); // This function does automatic redirects
  1325.  
  1326.                 // Construct the configuration manager
  1327.  
  1328.                 OIDplus::config(); // During the construction, various system settings are prepared if required
  1329.  
  1330.                 // Initialize public / private keys
  1331.  
  1332.                 OIDplus::getPkiStatus(true);
  1333.  
  1334.                 // Register non-DB plugins
  1335.  
  1336.                 self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), OIDplusPagePlugin::class, array(OIDplus::class,'registerPagePlugin'));
  1337.                 self::registerAllPlugins('auth', OIDplusAuthPlugin::class, array(OIDplus::class,'registerAuthPlugin'));
  1338.                 self::registerAllPlugins('logger', OIDplusLoggerPlugin::class, array(OIDplus::class,'registerLoggerPlugin'));
  1339.                 OIDplusLogger::reLogMissing(); // Some previous plugins might have tried to log. Repeat that now.
  1340.                 self::registerAllPlugins('objectTypes', OIDplusObjectTypePlugin::class, array(OIDplus::class,'registerObjectTypePlugin'));
  1341.                 self::registerAllPlugins('language', OIDplusLanguagePlugin::class, array(OIDplus::class,'registerLanguagePlugin'));
  1342.                 self::registerAllPlugins('design', OIDplusDesignPlugin::class, array(OIDplus::class,'registerDesignPlugin'));
  1343.                 self::registerAllPlugins('captcha', OIDplusCaptchaPlugin::class, array(OIDplus::class,'registerCaptchaPlugin'));
  1344.  
  1345.                 // Initialize non-DB plugins
  1346.  
  1347.                 foreach (OIDplus::getPagePlugins() as $plugin) {
  1348.                         $plugin->init($html);
  1349.                 }
  1350.                 foreach (OIDplus::getAuthPlugins() as $plugin) {
  1351.                         $plugin->init($html);
  1352.                 }
  1353.                 foreach (OIDplus::getLoggerPlugins() as $plugin) {
  1354.                         $plugin->init($html);
  1355.                 }
  1356.                 foreach (OIDplus::getObjectTypePlugins() as $plugin) {
  1357.                         $plugin->init($html);
  1358.                 }
  1359.                 foreach (OIDplus::getLanguagePlugins() as $plugin) {
  1360.                         $plugin->init($html);
  1361.                 }
  1362.                 foreach (OIDplus::getDesignPlugins() as $plugin) {
  1363.                         $plugin->init($html);
  1364.                 }
  1365.                 foreach (OIDplus::getCaptchaPlugins() as $plugin) {
  1366.                         $plugin->init($html);
  1367.                 }
  1368.  
  1369.                 if (PHP_SAPI != 'cli') {
  1370.  
  1371.                         // Prepare some security related response headers (default values)
  1372.  
  1373.                         $content_language =
  1374.                                 strtolower(substr(OIDplus::getCurrentLang(),0,2)) . '-' .
  1375.                                 strtoupper(substr(OIDplus::getCurrentLang(),2,2)); // e.g. 'en-US'
  1376.  
  1377.                         $http_headers = array(
  1378.                                 "X-Content-Type-Options" => "nosniff",
  1379.                                 "X-XSS-Protection" => "1; mode=block",
  1380.                                 "X-Frame-Options" => "SAMEORIGIN",
  1381.                                 "Referrer-Policy" => array(
  1382.                                         "no-referrer-when-downgrade"
  1383.                                 ),
  1384.                                 "Cache-Control" => array(
  1385.                                         "no-cache",
  1386.                                         "no-store",
  1387.                                         "must-revalidate"
  1388.                                 ),
  1389.                                 "Pragma" => "no-cache",
  1390.                                 "Content-Language" => $content_language,
  1391.                                 "Expires" => "0",
  1392.                                 "Content-Security-Policy" => array(
  1393.                                         // see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
  1394.  
  1395.                                         // --- Fetch directives ---
  1396.                                         "child-src" => array(
  1397.                                                 "'self'",
  1398.                                                 "blob:"
  1399.                                         ),
  1400.                                         "connect-src" => array(
  1401.                                                 "'self'",
  1402.                                                 "blob:"
  1403.                                         ),
  1404.                                         "default-src" => array(
  1405.                                                 "'self'",
  1406.                                                 "blob:",
  1407.                                                 "https://cdnjs.cloudflare.com/"
  1408.                                         ),
  1409.                                         "font-src" => array(
  1410.                                                 "'self'",
  1411.                                                 "blob:"
  1412.                                         ),
  1413.                                         "frame-src" => array(
  1414.                                                 "'self'",
  1415.                                                 "blob:"
  1416.                                         ),
  1417.                                         "img-src" => array(
  1418.                                                 "blob:",
  1419.                                                 "data:",
  1420.                                                 "http:",
  1421.                                                 "https:"
  1422.                                         ),
  1423.                                         "manifest-src" => array(
  1424.                                                 "'self'",
  1425.                                                 "blob:"
  1426.                                         ),
  1427.                                         "media-src" => array(
  1428.                                                 "'self'",
  1429.                                                 "blob:"
  1430.                                         ),
  1431.                                         "object-src" => array(
  1432.                                                 "'none'"
  1433.                                         ),
  1434.                                         "prefetch-src" => array(
  1435.                                                 "'self'",
  1436.                                                 "blob:"
  1437.                                         ),
  1438.                                         "script-src" => array(
  1439.                                                 "'self'",
  1440.                                                 "'unsafe-inline'",
  1441.                                                 "'unsafe-eval'",
  1442.                                                 "blob:",
  1443.                                                 "https://cdnjs.cloudflare.com/",
  1444.                                                 "https://polyfill.io/"
  1445.                                         ),
  1446.                                         // script-src-elem not used
  1447.                                         // script-src-attr not used
  1448.                                         "style-src" => array(
  1449.                                                 "'self'",
  1450.                                                 "'unsafe-inline'",
  1451.                                                 "https://cdnjs.cloudflare.com/"
  1452.                                         ),
  1453.                                         // style-src-elem not used
  1454.                                         // style-src-attr not used
  1455.                                         "worker-src" => array(
  1456.                                                 "'self'",
  1457.                                                 "blob:"
  1458.                                         ),
  1459.  
  1460.                                         // --- Navigation directives ---
  1461.                                         "frame-ancestors" => array(
  1462.                                                 "'none'"
  1463.                                         ),
  1464.                                 )
  1465.                         );
  1466.  
  1467.                         // Give plugins the opportunity to manipulate/extend the headers
  1468.  
  1469.                         foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
  1470.                                 $plugin->httpHeaderCheck($http_headers);
  1471.                         }
  1472.                         //foreach (OIDplus::getDatabasePlugins() as $plugin) {
  1473.                         if ($plugin = OIDplus::getActiveDatabasePlugin()) {
  1474.                                 $plugin->httpHeaderCheck($http_headers);
  1475.                         }
  1476.                         foreach (OIDplus::getPagePlugins() as $plugin) {
  1477.                                 $plugin->httpHeaderCheck($http_headers);
  1478.                         }
  1479.                         foreach (OIDplus::getAuthPlugins() as $plugin) {
  1480.                                 $plugin->httpHeaderCheck($http_headers);
  1481.                         }
  1482.                         foreach (OIDplus::getLoggerPlugins() as $plugin) {
  1483.                                 $plugin->httpHeaderCheck($http_headers);
  1484.                         }
  1485.                         foreach (OIDplus::getObjectTypePlugins() as $plugin) {
  1486.                                 $plugin->httpHeaderCheck($http_headers);
  1487.                         }
  1488.                         foreach (OIDplus::getLanguagePlugins() as $plugin) {
  1489.                                 $plugin->httpHeaderCheck($http_headers);
  1490.                         }
  1491.                         foreach (OIDplus::getDesignPlugins() as $plugin) {
  1492.                                 $plugin->httpHeaderCheck($http_headers);
  1493.                         }
  1494.                         //foreach (OIDplus::getCaptchaPlugins() as $plugin) {
  1495.                         if ($plugin = OIDplus::getActiveCaptchaPlugin()) {
  1496.                                 $plugin->httpHeaderCheck($http_headers);
  1497.                         }
  1498.  
  1499.                         // Prepare to send the headers to the client
  1500.                         // The headers are sent automatically when the first output comes or the script ends
  1501.  
  1502.                         foreach ($http_headers as $name => $val) {
  1503.  
  1504.                                 // Plugins can remove standard OIDplus headers by setting the value to null.
  1505.                                 if (is_null($val)) continue;
  1506.  
  1507.                                 // Some headers can be written as arrays to make it easier for plugin authors
  1508.                                 // to manipulate/extend the contents.
  1509.                                 if (is_array($val)) {
  1510.                                         if ((strtolower($name) == 'cache-control') ||
  1511.                                                 (strtolower($name) == 'referrer-policy'))
  1512.                                         {
  1513.                                                 if (count($val) == 0) continue;
  1514.                                                 $val = implode(', ', $val);
  1515.                                         } else if (strtolower($name) == 'content-security-policy') {
  1516.                                                 if (count($val) == 0) continue;
  1517.                                                 foreach ($val as $tmp1 => &$tmp2) {
  1518.                                                         $tmp2 = array_unique($tmp2);
  1519.                                                         $tmp2 = $tmp1.' '.implode(' ', $tmp2);
  1520.                                                 }
  1521.                                                 $val = implode('; ', $val);
  1522.                                         } else {
  1523.                                                 throw new OIDplusException(_L('HTTP header "%1" cannot be written as array. A newly installed plugin is probably misusing the method "%2".',$name,'httpHeaderCheck'));
  1524.                                         }
  1525.                                 }
  1526.  
  1527.                                 if (is_string($val)) {
  1528.                                         header("$name: $val");
  1529.                                 }
  1530.                         }
  1531.  
  1532.                 } // endif (PHP_SAPI != 'cli')
  1533.  
  1534.                 // Initialize other stuff (i.e. things which require the logger!)
  1535.  
  1536.                 OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
  1537.                 OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
  1538.         }
  1539.  
  1540.         // --- System URL, System ID, PKI, and other functions
  1541.  
  1542.         /**
  1543.          * @return void
  1544.          */
  1545.         private static function recognizeSystemUrl() {
  1546.                 try {
  1547.                         $url = OIDplus::webpath(null,self::PATH_ABSOLUTE_CANONICAL);
  1548.                         OIDplus::config()->setValue('last_known_system_url', $url);
  1549.                 } catch (\Exception $e) {
  1550.                 }
  1551.         }
  1552.  
  1553.         /**
  1554.          * @return false|int
  1555.          */
  1556.         private static function getExecutingScriptPathDepth() {
  1557.                 if (PHP_SAPI == 'cli') {
  1558.                         global $argv;
  1559.                         $test_dir = dirname(realpath($argv[0]));
  1560.                 } else {
  1561.                         if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
  1562.                         $test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
  1563.                 }
  1564.                 $test_dir = str_replace('\\', '/', $test_dir);
  1565.                 $steps_up = 0;
  1566.                 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 subordinate directory!
  1567.                         $test_dir = dirname($test_dir);
  1568.                         $steps_up++;
  1569.                         if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
  1570.                 }
  1571.                 return $steps_up;
  1572.         }
  1573.  
  1574.         /**
  1575.          * @return bool
  1576.          */
  1577.         public static function isSSL(): bool {
  1578.                 return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
  1579.         }
  1580.  
  1581.         /**
  1582.          * Returns the URL of the system.
  1583.          * @param int $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
  1584.          *                  PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
  1585.          *                  results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
  1586.          *                  but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
  1587.          * @return string|false The URL, with guaranteed trailing path delimiter for directories
  1588.          * @throws OIDplusException
  1589.          */
  1590.         private static function getSystemUrl(int $mode) {
  1591.                 if ($mode === self::PATH_RELATIVE) {
  1592.                         $steps_up = self::getExecutingScriptPathDepth();
  1593.                         if ($steps_up === false) {
  1594.                                 return false;
  1595.                         } else {
  1596.                                 return str_repeat('../', $steps_up);
  1597.                         }
  1598.                 } else {
  1599.                         if ($mode === self::PATH_ABSOLUTE_CANONICAL) {
  1600.                                 $tmp = OIDplus::baseConfig()->getValue('CANONICAL_SYSTEM_URL', '');
  1601.                                 if ($tmp) {
  1602.                                         return rtrim($tmp,'/').'/';
  1603.                                 }
  1604.                         }
  1605.  
  1606.                         if (PHP_SAPI == 'cli') {
  1607.                                 try {
  1608.                                         return OIDplus::config()->getValue('last_known_system_url', false);
  1609.                                 } catch (\Exception $e) {
  1610.                                         return false;
  1611.                                 }
  1612.                         } else {
  1613.                                 // First, try to find out how many levels we need to go up
  1614.                                 $steps_up = self::getExecutingScriptPathDepth();
  1615.  
  1616.                                 // Then go up these amount of levels, based on SCRIPT_NAME/argv[0]
  1617.                                 $res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
  1618.                                 for ($i=0; $i<$steps_up; $i++) {
  1619.                                         $res = dirname($res);
  1620.                                 }
  1621.                                 $res = str_replace('\\', '/', $res);
  1622.                                 if ($res == '/') $res = '';
  1623.  
  1624.                                 // Add protocol and hostname
  1625.                                 $is_ssl = self::isSSL();
  1626.                                 $protocol = $is_ssl ? 'https' : 'http'; // do not translate
  1627.                                 $host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
  1628.  
  1629.                                 return $protocol.'://'.$host.$res.'/';
  1630.                         }
  1631.                 }
  1632.         }
  1633.  
  1634.         /**
  1635.          * @param $pubKey
  1636.          * @return false|string
  1637.          */
  1638.         private static function pubKeyToRaw($pubKey) {
  1639.                 $m = array();
  1640.                 if (preg_match('@BEGIN PUBLIC KEY\\-+([^\\-]+)\\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
  1641.                         return base64_decode($m[1], false);
  1642.                 }
  1643.                 return false;
  1644.         }
  1645.  
  1646.         /**
  1647.          * @param $pubKey
  1648.          * @return false|int
  1649.          */
  1650.         private static function getSystemIdFromPubKey($pubKey) {
  1651.                 $rawData = self::pubKeyToRaw($pubKey);
  1652.                 if ($rawData === false) return false;
  1653.                 return smallhash($rawData);
  1654.         }
  1655.  
  1656.         /**
  1657.          * @param $pubKey
  1658.          * @return false|string
  1659.          */
  1660.         private static function getSystemGuidFromPubKey($pubKey) {
  1661.                 $rawData = self::pubKeyToRaw($pubKey);
  1662.                 if ($rawData === false) return false;
  1663.                 $normalizedBase64 = base64_encode($rawData);
  1664.                 return gen_uuid_sha1_namebased(self::UUID_NAMEBASED_NS_Base64PubKey, $normalizedBase64);
  1665.         }
  1666.  
  1667.         private static $system_id_cache = null;
  1668.  
  1669.         /**
  1670.          * @param bool $oid
  1671.          * @return false|string
  1672.          * @throws OIDplusException
  1673.          */
  1674.         public static function getSystemId(bool $oid=false) {
  1675.                 if (!is_null(self::$system_id_cache)) {
  1676.                         $out = self::$system_id_cache;
  1677.                 } else {
  1678.                         $out = false;
  1679.  
  1680.                         if (self::getPkiStatus(true)) {
  1681.                                 $pubKey = OIDplus::getSystemPublicKey();
  1682.                                 $out = self::getSystemIdFromPubKey($pubKey);
  1683.                         }
  1684.                         self::$system_id_cache = $out;
  1685.                 }
  1686.                 if (!$out) return false;
  1687.                 return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
  1688.         }
  1689.  
  1690.         private static $system_guid_cache = null;
  1691.  
  1692.         /**
  1693.          * @return false|string
  1694.          * @throws OIDplusException
  1695.          */
  1696.         public static function getSystemGuid() {
  1697.                 if (!is_null(self::$system_guid_cache)) {
  1698.                         $out = self::$system_guid_cache;
  1699.                 } else {
  1700.                         $out = false;
  1701.  
  1702.                         if (self::getPkiStatus(true)) {
  1703.                                 $pubKey = OIDplus::getSystemPublicKey();
  1704.                                 $out = self::getSystemGuidFromPubKey($pubKey);
  1705.                         }
  1706.                         self::$system_guid_cache = $out;
  1707.                 }
  1708.                 if (!$out) return false;
  1709.                 return $out;
  1710.         }
  1711.  
  1712.         /**
  1713.          * @return array|string
  1714.          */
  1715.         public static function getOpenSslCnf() {
  1716.                 // The following functions need a config file, otherway they don't work
  1717.                 // - openssl_csr_new
  1718.                 // - openssl_csr_sign
  1719.                 // - openssl_pkey_export
  1720.                 // - openssl_pkey_export_to_file
  1721.                 // - openssl_pkey_new
  1722.                 $tmp = @getenv('OPENSSL_CONF');
  1723.                 if ($tmp && file_exists($tmp)) return $tmp;
  1724.  
  1725.                 // OpenSSL in XAMPP does not work OOBE, since the OPENSSL_CONF is
  1726.                 // C:/xampp/apache/bin/openssl.cnf and not C:/xampp/apache/conf/openssl.cnf
  1727.                 // Bug reports are more than 10 years old and nobody cares...
  1728.                 // Use our own config file
  1729.                 return __DIR__.'/../../vendor/phpseclib/phpseclib/phpseclib/openssl.cnf';
  1730.         }
  1731.  
  1732.         /**
  1733.          * @return string
  1734.          */
  1735.         private static function getPrivKeyPassphraseFilename(): string {
  1736.                 return OIDplus::localpath() . 'userdata/privkey_secret.php';
  1737.         }
  1738.  
  1739.         /**
  1740.          * @return void
  1741.          */
  1742.         private static function tryCreatePrivKeyPassphrase() {
  1743.                 $file = self::getPrivKeyPassphraseFilename();
  1744.  
  1745.                 $passphrase = generateRandomString(64);
  1746.                 $cont = "<?php\n";
  1747.                 $cont .= "// ATTENTION! This file was automatically generated by OIDplus to encrypt the private key\n";
  1748.                 $cont .= "// that is located in your database configuration table. DO NOT ALTER OR DELETE THIS FILE,\n";
  1749.                 $cont .= "// otherwise you will lose your OIDplus System-ID and all services connected with it!\n";
  1750.                 $cont .= "// If multiple systems access the same database, then this file must be synchronous\n";
  1751.                 $cont .= "// between all systems, otherwise you will lose your system ID, too!\n";
  1752.                 $cont .= "\$passphrase = '$passphrase';\n";
  1753.                 $cont .= "// End of file\n";
  1754.  
  1755.                 @file_put_contents($file, $cont);
  1756.         }
  1757.  
  1758.         /**
  1759.          * @return string|false
  1760.          */
  1761.         private static function getPrivKeyPassphrase() {
  1762.                 $file = self::getPrivKeyPassphraseFilename();
  1763.                 if (!file_exists($file)) return false;
  1764.                 $cont = file_get_contents($file);
  1765.                 $m = array();
  1766.                 if (!preg_match("@'(.+)'@isU", $cont, $m)) return false;
  1767.                 return $m[1];
  1768.         }
  1769.  
  1770.         /**
  1771.          * @return string|false
  1772.          * @throws OIDplusException
  1773.          */
  1774.         public static function getSystemPrivateKey() {
  1775.                 $privKey = OIDplus::config()->getValue('oidplus_private_key');
  1776.                 if ($privKey == '') return false;
  1777.  
  1778.                 $passphrase = self::getPrivKeyPassphrase();
  1779.                 if ($passphrase !== false) {
  1780.                         $privKey = decrypt_private_key($privKey, $passphrase);
  1781.                 }
  1782.  
  1783.                 if (is_privatekey_encrypted($privKey)) {
  1784.                         // This can happen if the key file has vanished
  1785.                         return false;
  1786.                 }
  1787.  
  1788.                 return $privKey;
  1789.         }
  1790.  
  1791.         /**
  1792.          * @return string|false
  1793.          * @throws OIDplusException
  1794.          */
  1795.         public static function getSystemPublicKey() {
  1796.                 $pubKey = OIDplus::config()->getValue('oidplus_public_key');
  1797.                 if ($pubKey == '') return false;
  1798.                 return $pubKey;
  1799.         }
  1800.  
  1801.         /**
  1802.          * @param bool $try_generate
  1803.          * @return bool
  1804.          * @throws OIDplusException
  1805.          */
  1806.         public static function getPkiStatus(bool $try_generate=false): bool {
  1807.                 if (!function_exists('openssl_pkey_new')) return false;
  1808.  
  1809.                 if ($try_generate) {
  1810.                         // For debug purposes: Invalidate current key once:
  1811.                         //OIDplus::config()->setValue('oidplus_private_key', '');
  1812.  
  1813.                         $privKey = OIDplus::getSystemPrivateKey();
  1814.                         $pubKey = OIDplus::getSystemPublicKey();
  1815.                         if (!verify_private_public_key($privKey, $pubKey)) {
  1816.                                 if ($pubKey) {
  1817.                                         OIDplus::logger()->log("[WARN]A!", "The private/public key-pair is broken. A new key-pair will now be generated for your system. Your System-ID will change.");
  1818.                                 }
  1819.  
  1820.                                 $pkey_config = array(
  1821.                                         "digest_alg" => "sha512",
  1822.                                         "private_key_bits" => defined('OPENSSL_SUPPLEMENT') ? 1024 : 2048, // openssl_supplement.inc.php is based on phpseclib, which is very slow. So we use 1024 bits instead of 2048 bits
  1823.                                         "private_key_type" => OPENSSL_KEYTYPE_RSA,
  1824.                                         "config" => OIDplus::getOpenSslCnf()
  1825.                                 );
  1826.  
  1827.                                 // Create the private and public key
  1828.                                 $res = openssl_pkey_new($pkey_config);
  1829.                                 if ($res === false) return false;
  1830.  
  1831.                                 // Extract the private key from $res to $privKey
  1832.                                 if (openssl_pkey_export($res, $privKey, null, $pkey_config) === false) return false;
  1833.  
  1834.                                 // Extract the public key from $res to $pubKey
  1835.                                 $tmp = openssl_pkey_get_details($res);
  1836.                                 if ($tmp === false) return false;
  1837.                                 $pubKey = $tmp["key"];
  1838.  
  1839.                                 // encrypt new keys using a passphrase stored in a secret file
  1840.                                 self::tryCreatePrivKeyPassphrase(); // *try* (re)generate this file
  1841.                                 $passphrase = self::getPrivKeyPassphrase();
  1842.                                 if ($passphrase !== false) {
  1843.                                         $privKey = encrypt_private_key($privKey, $passphrase);
  1844.                                 }
  1845.  
  1846.                                 // Calculate the system ID from the public key
  1847.                                 $system_id = self::getSystemIdFromPubKey($pubKey);
  1848.                                 if ($system_id !== false) {
  1849.                                         // Save the key pair to database
  1850.                                         OIDplus::config()->setValue('oidplus_private_key', $privKey);
  1851.                                         OIDplus::config()->setValue('oidplus_public_key', $pubKey);
  1852.  
  1853.                                         // Log the new system ID
  1854.                                         OIDplus::logger()->log("[INFO]A!", "A new private/public key-pair for your system had been generated. Your SystemID is now $system_id");
  1855.                                 }
  1856.                         } else {
  1857.                                 $passphrase = self::getPrivKeyPassphrase();
  1858.                                 $rawPrivKey = OIDplus::config()->getValue('oidplus_private_key');
  1859.                                 if (($passphrase === false) || !is_privatekey_encrypted($rawPrivKey)) {
  1860.                                         // Upgrade to new encrypted keys
  1861.                                         self::tryCreatePrivKeyPassphrase(); // *try* generate this file
  1862.                                         $passphrase = self::getPrivKeyPassphrase();
  1863.                                         if ($passphrase !== false) {
  1864.                                                 $privKey = encrypt_private_key($privKey, $passphrase);
  1865.                                                 OIDplus::logger()->log("[INFO]A!", "The private/public key-pair has been upgraded to an encrypted key-pair. The key is saved in ".self::getPrivKeyPassphraseFilename());
  1866.                                                 OIDplus::config()->setValue('oidplus_private_key', $privKey);
  1867.                                         }
  1868.                                 }
  1869.                         }
  1870.                 }
  1871.  
  1872.                 $privKey = OIDplus::getSystemPrivateKey();
  1873.                 $pubKey = OIDplus::getSystemPublicKey();
  1874.                 return verify_private_public_key($privKey, $pubKey);
  1875.         }
  1876.  
  1877.         /**
  1878.          * @return string|void
  1879.          */
  1880.         public static function getInstallType() {
  1881.                 $counter = 0;
  1882.  
  1883.                 if ($new_version_file_exists = file_exists(OIDplus::localpath().'.version.php')) {
  1884.                         $counter++;
  1885.                 }
  1886.                 if ($old_version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) {
  1887.                         $counter++;
  1888.                 }
  1889.                 $version_file_exists = $old_version_file_exists | $new_version_file_exists;
  1890.                 if ($svn_dir_exists = (is_dir(OIDplus::localpath().'.svn') ||
  1891.                         is_dir(OIDplus::localpath().'../.svn'))) { // in case we checked out the root instead of the "trunk"
  1892.                         $counter++;
  1893.                 }
  1894.                 // if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) {
  1895.                 if ($git_dir_exists = (OIDplus::findGitFolder() !== false)) {
  1896.                         $counter++;
  1897.                 }
  1898.  
  1899.                 if ($counter === 0) {
  1900.                         return 'unknown'; // do not translate
  1901.                 }
  1902.                 else if ($counter > 1) {
  1903.                         return 'ambigous'; // do not translate
  1904.                 }
  1905.                 else if ($svn_dir_exists) {
  1906.                         return 'svn-wc'; // do not translate
  1907.                 }
  1908.                 else if ($git_dir_exists) {
  1909.                         return 'git-wc'; // do not translate
  1910.                 }
  1911.                 else if ($version_file_exists) {
  1912.                         return 'svn-snapshot'; // do not translate
  1913.                 }
  1914.         }
  1915.  
  1916.         /**
  1917.          * @return void
  1918.          */
  1919.         private static function recognizeVersion() {
  1920.                 try {
  1921.                         $ver_prev = OIDplus::config()->getValue("last_known_version");
  1922.                         $ver_now = OIDplus::getVersion();
  1923.                         if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
  1924.                                 // TODO: Problem: When the system was updated using SVN, then the IP address of the next random visitor of the website is logged!
  1925.                                 OIDplus::logger()->log("[INFO]A!", "Detected system version change from '$ver_prev' to '$ver_now'");
  1926.  
  1927.                                 // Just to be sure, recanonize objects (we don't do it at every page visit due to performance reasons)
  1928.                                 self::recanonizeObjects();
  1929.                         }
  1930.                         OIDplus::config()->setValue("last_known_version", $ver_now);
  1931.                 } catch (\Exception $e) {
  1932.                 }
  1933.         }
  1934.  
  1935.         /**
  1936.          * @return false|string|null
  1937.          */
  1938.         public static function getVersion() {
  1939.                 static $cachedVersion = null;
  1940.                 if (!is_null($cachedVersion)) {
  1941.                         return $cachedVersion;
  1942.                 }
  1943.  
  1944.                 $installType = OIDplus::getInstallType();
  1945.  
  1946.                 if ($installType === 'svn-wc') {
  1947.                         $ver = get_svn_revision(OIDplus::localpath());
  1948.                         if ($ver)
  1949.                                 return ($cachedVersion = 'svn-'.$ver);
  1950.                         $ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk"
  1951.                         if ($ver)
  1952.                                 return ($cachedVersion = 'svn-'.$ver);
  1953.                 }
  1954.  
  1955.                 if ($installType === 'git-wc') {
  1956.                         $ver = OIDplus::getGitsvnRevision();
  1957.                         if ($ver)
  1958.                                 return ($cachedVersion = 'svn-'.$ver);
  1959.                 }
  1960.  
  1961.                 if ($installType === 'svn-snapshot') {
  1962.                         $cont = '';
  1963.                         if (file_exists($filename = OIDplus::localpath().'oidplus_version.txt'))
  1964.                                 $cont = file_get_contents($filename);
  1965.                         if (file_exists($filename = OIDplus::localpath().'.version.php'))
  1966.                                 $cont = file_get_contents($filename);
  1967.                         $m = array();
  1968.                         if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
  1969.                                 return ($cachedVersion = 'svn-'.$m[1]); // do not translate
  1970.                 }
  1971.  
  1972.                 return ($cachedVersion = false); // version ambigous or unknown
  1973.         }
  1974.  
  1975.         const ENFORCE_SSL_NO   = 0;
  1976.         const ENFORCE_SSL_YES  = 1;
  1977.         const ENFORCE_SSL_AUTO = 2;
  1978.  
  1979.         /**
  1980.          * @var bool|null
  1981.          */
  1982.         private static $sslAvailableCache = null;
  1983.  
  1984.         /**
  1985.          * @return bool
  1986.          * @throws OIDplusException, OIDplusConfigInitializationException
  1987.          */
  1988.         public static function isSslAvailable(): bool {
  1989.                 if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
  1990.  
  1991.                 if (PHP_SAPI == 'cli') {
  1992.                         self::$sslAvailableCache = false;
  1993.                         return false;
  1994.                 }
  1995.  
  1996.                 $timeout = 2;
  1997.                 $already_ssl = self::isSSL();
  1998.                 $ssl_port = 443;
  1999.                 $host_with_port = $_SERVER['HTTP_HOST'];
  2000.                 $host_no_port = explode(':',$host_with_port)[0];
  2001.                 $host_ssl = $host_no_port . ($ssl_port != 443 ? ':'.$ssl_port : '');
  2002.  
  2003.                 if ($already_ssl) {
  2004.                         OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, true/*allowJS*/, null/*samesite*/, true/*forceInsecure*/);
  2005.                         self::$sslAvailableCache = true;
  2006.                         return true;
  2007.                 } else {
  2008.                         if (isset($_COOKIE['SSL_CHECK']) && ($_COOKIE['SSL_CHECK'] == '1')) {
  2009.                                 // The cookie "SSL_CHECK" is set once a website was loaded with HTTPS.
  2010.                                 // It forces subsequent HTTP calls to redirect to HTTPS (like HSTS).
  2011.                                 // The reason is the following problem:
  2012.                                 // If you open the page with HTTPS first, then the CSRF token cookies will get the "secure" flag
  2013.                                 // If you open the page then with HTTP, the HTTP cannot access the secure CSRF cookies,
  2014.                                 // Chrome will then block "Set-Cookie" since the HTTP cookie would overwrite the HTTPS cookie.
  2015.                                 // So we MUST redirect, even if the Mode is ENFORCE_SSL_NO.
  2016.                                 // Note: SSL_CHECK is NOT a replacement for HSTS! You should use HSTS,
  2017.                                 //       because on there your browser ensures that HTTPS is called, before the server
  2018.                                 //       is even contacted (and therefore, no HTTP connection can be hacked).
  2019.                                 $mode = OIDplus::ENFORCE_SSL_YES;
  2020.                         } else {
  2021.                                 $mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', OIDplus::ENFORCE_SSL_AUTO);
  2022.                         }
  2023.  
  2024.                         if ($mode == OIDplus::ENFORCE_SSL_NO) {
  2025.                                 // No SSL available
  2026.                                 self::$sslAvailableCache = false;
  2027.                                 return false;
  2028.                         } else if ($mode == OIDplus::ENFORCE_SSL_YES) {
  2029.                                 // Force SSL
  2030.                                 $location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
  2031.                                 header('Location:'.$location);
  2032.                                 die(_L('Redirecting to HTTPS...'));
  2033.                         } else if ($mode == OIDplus::ENFORCE_SSL_AUTO) {
  2034.                                 // Automatic SSL detection
  2035.                                 if (isset($_COOKIE['SSL_CHECK'])) {
  2036.                                         // We already had the HTTPS detection done before.
  2037.                                         if ($_COOKIE['SSL_CHECK'] == '1') {
  2038.                                                 // HTTPS was detected before, but we are HTTP. Redirect now
  2039.                                                 $location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
  2040.                                                 header('Location:'.$location);
  2041.                                                 die(_L('Redirecting to HTTPS...'));
  2042.                                         } else {
  2043.                                                 // No HTTPS available. Do nothing.
  2044.                                                 self::$sslAvailableCache = false;
  2045.                                                 return false;
  2046.                                         }
  2047.                                 } else {
  2048.                                         // This is our first check (or the browser didn't accept the SSL_CHECK cookie)
  2049.                                         $errno = -1;
  2050.                                         $errstr = '';
  2051.                                         if (@fsockopen($host_no_port, $ssl_port, $errno, $errstr, $timeout)) {
  2052.                                                 // HTTPS detected. Redirect now, and remember that we had detected HTTPS
  2053.                                                 OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, true/*allowJS*/, null/*samesite*/, true/*forceInsecure*/);
  2054.                                                 $location = 'https://' . $host_ssl . $_SERVER['REQUEST_URI'];
  2055.                                                 header('Location:'.$location);
  2056.                                                 die(_L('Redirecting to HTTPS...'));
  2057.                                         } else {
  2058.                                                 // No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
  2059.                                                 OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, true/*allowJS*/, null/*samesite*/, true/*forceInsecure*/);
  2060.                                                 self::$sslAvailableCache = false;
  2061.                                                 return false;
  2062.                                         }
  2063.                                 }
  2064.                         } else {
  2065.                                 assert(false);
  2066.                                 return false;
  2067.                         }
  2068.                 }
  2069.         }
  2070.  
  2071.         /**
  2072.          * Gets a local path pointing to a resource
  2073.          * @param string|null $target Target resource (file or directory must exist), or null to get the OIDplus base directory
  2074.          * @param bool $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
  2075.          * @return string|false The local path, with guaranteed trailing path delimiter for directories
  2076.          */
  2077.         public static function localpath(string $target=null, bool $relative=false) {
  2078.                 if (is_null($target)) {
  2079.                         $target = __DIR__.'/../../';
  2080.                 }
  2081.  
  2082.                 if ($relative) {
  2083.                         // First, try to find out how many levels we need to go up
  2084.                         $steps_up = self::getExecutingScriptPathDepth();
  2085.                         if ($steps_up === false) return false;
  2086.  
  2087.                         // Virtually go back from the executing PHP script to the OIDplus base path
  2088.                         $res = str_repeat('../',$steps_up);
  2089.  
  2090.                         // Then go to the desired location
  2091.                         $basedir = realpath(__DIR__.'/../../');
  2092.                         $target = realpath($target);
  2093.                         if ($target === false) return false;
  2094.                         $res .= substr($target, strlen($basedir)+1);
  2095.                         $res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
  2096.                 } else {
  2097.                         $res = realpath($target);
  2098.                 }
  2099.  
  2100.                 if (is_dir($target)) $res .= '/';
  2101.  
  2102.                 return str_replace('/', DIRECTORY_SEPARATOR, $res);
  2103.         }
  2104.  
  2105.         /**
  2106.          * Gets a URL pointing to a resource
  2107.          * @param string|null $target Target resource (file or directory must exist), or null to get the OIDplus base directory
  2108.          * @param int|bool $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
  2109.          *                          PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
  2110.          *                          results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
  2111.          *                          but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
  2112.          * @return string|false The URL, with guaranteed trailing path delimiter for directories
  2113.          * @throws OIDplusException
  2114.          */
  2115.         public static function webpath(string $target=null, $mode=self::PATH_ABSOLUTE_CANONICAL) {
  2116.                 // backwards compatibility
  2117.                 if ($mode === true) $mode = self::PATH_RELATIVE;
  2118.                 if ($mode === false) $mode = self::PATH_ABSOLUTE;
  2119.  
  2120.                 if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT) {
  2121.                         $tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE);
  2122.                         if ($tmp === false) return false;
  2123.                         $tmp = parse_url($tmp);
  2124.                         if ($tmp === false) return false;
  2125.                         if (!isset($tmp['path'])) return false;
  2126.                         return $tmp['path'];
  2127.                 }
  2128.  
  2129.                 if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT_CANONICAL) {
  2130.                         $tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE_CANONICAL);
  2131.                         if ($tmp === false) return false;
  2132.                         $tmp = parse_url($tmp);
  2133.                         if ($tmp === false) return false;
  2134.                         if (!isset($tmp['path'])) return false;
  2135.                         return $tmp['path'];
  2136.                 }
  2137.  
  2138.                 $res = self::getSystemUrl($mode); // Note: already contains a trailing path delimiter
  2139.                 if ($res === false) return false;
  2140.  
  2141.                 if (!is_null($target)) {
  2142.                         $basedir = realpath(__DIR__.'/../../');
  2143.                         $target = realpath($target);
  2144.                         if ($target === false) return false;
  2145.                         $tmp = substr($target, strlen($basedir)+1);
  2146.                         $res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
  2147.                         if (is_dir($target)) $res .= '/';
  2148.                 }
  2149.  
  2150.                 return $res;
  2151.         }
  2152.  
  2153.         /**
  2154.          * @return false|string
  2155.          * @throws OIDplusException
  2156.          */
  2157.         public static function canonicalURL() {
  2158.                 // First part: OIDplus system URL (or canonical system URL)
  2159.                 $sysurl = OIDplus::getSystemUrl(self::PATH_ABSOLUTE_CANONICAL);
  2160.  
  2161.                 // Second part: Directory
  2162.                 $basedir = realpath(__DIR__.'/../../');
  2163.                 $target = realpath('.');
  2164.                 if ($target === false) return false;
  2165.                 $tmp = substr($target, strlen($basedir)+1);
  2166.                 $res = str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
  2167.                 if (is_dir($target) && ($res != '')) $res .= '/';
  2168.  
  2169.                 // Third part: File name
  2170.                 $tmp = explode('/',$_SERVER['SCRIPT_NAME']);
  2171.                 $tmp = end($tmp);
  2172.  
  2173.                 // Fourth part: Query string (ordered)
  2174.                 $tmp2 = getSortedQuery();
  2175.                 if ($tmp2 != '') $tmp2 = '?'.$tmp2;
  2176.  
  2177.                 return $sysurl.$res.$tmp.$tmp2;
  2178.         }
  2179.  
  2180.         private static $shutdown_functions = array();
  2181.  
  2182.         /**
  2183.          * @param $func
  2184.          * @return void
  2185.          */
  2186.         public static function register_shutdown_function($func) {
  2187.                 self::$shutdown_functions[] = $func;
  2188.         }
  2189.  
  2190.         /**
  2191.          * @return void
  2192.          */
  2193.         public static function invoke_shutdown() {
  2194.                 foreach (self::$shutdown_functions as $func) {
  2195.                         $func();
  2196.                 }
  2197.         }
  2198.  
  2199.         /**
  2200.          * @return string[]
  2201.          * @throws OIDplusException
  2202.          */
  2203.         public static function getAvailableLangs(): array {
  2204.                 $langs = array();
  2205.                 foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
  2206.                         $code = $pluginManifest->getLanguageCode();
  2207.                         $langs[] = $code;
  2208.                 }
  2209.                 return $langs;
  2210.         }
  2211.  
  2212.         /**
  2213.          * @return string
  2214.          * @throws OIDplusConfigInitializationException
  2215.          * @throws OIDplusException
  2216.          */
  2217.         public static function getDefaultLang(): string {
  2218.                 static $thrownOnce = false; // avoid endless loop inside OIDplusConfigInitializationException
  2219.  
  2220.                 $lang = self::baseConfig()->getValue('DEFAULT_LANGUAGE', 'enus');
  2221.  
  2222.                 if (!in_array($lang,self::getAvailableLangs())) {
  2223.                         if (!$thrownOnce) {
  2224.                                 $thrownOnce = true;
  2225.                                 throw new OIDplusConfigInitializationException(_L('DEFAULT_LANGUAGE points to an invalid language plugin. (Consider setting to "enus" = "English USA".)'));
  2226.                         } else {
  2227.                                 return 'enus';
  2228.                         }
  2229.                 }
  2230.  
  2231.                 return $lang;
  2232.         }
  2233.  
  2234.         /**
  2235.          * @return false|string
  2236.          * @throws OIDplusConfigInitializationException
  2237.          * @throws OIDplusException
  2238.          */
  2239.         public static function getCurrentLang() {
  2240.                 if (isset($_GET['lang'])) {
  2241.                         $lang = $_GET['lang'];
  2242.                 } else if (isset($_POST['lang'])) {
  2243.                         $lang = $_POST['lang'];
  2244.                 } else if (isset($_COOKIE['LANGUAGE'])) {
  2245.                         $lang = $_COOKIE['LANGUAGE'];
  2246.                 } else {
  2247.                         $lang = self::getDefaultLang();
  2248.                 }
  2249.                 return substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
  2250.         }
  2251.  
  2252.         /**
  2253.          * @return void
  2254.          * @throws OIDplusException
  2255.          */
  2256.         public static function handleLangArgument() {
  2257.                 if (isset($_GET['lang'])) {
  2258.                         // The "?lang=" argument is only for NoScript-Browsers/SearchEngines
  2259.                         // In case someone who has JavaScript clicks a ?lang= link, they should get
  2260.                         // the page in that language, but the cookie must be set, otherwise
  2261.                         // the menu and other stuff would be in their cookie-based-language and not the
  2262.                         // argument-based-language.
  2263.                         OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
  2264.                 } else if (isset($_POST['lang'])) {
  2265.                         OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
  2266.                 }
  2267.         }
  2268.  
  2269.         private static $translationArray = array();
  2270.  
  2271.         /**
  2272.          * @param $translation_file
  2273.          * @return array|mixed
  2274.          */
  2275.         protected static function getTranslationFileContents($translation_file) {
  2276.                 // First, try the cache
  2277.                 $cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
  2278.                 if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
  2279.                         $cac = @unserialize(file_get_contents($cache_file));
  2280.                         if ($cac) return $cac;
  2281.                 }
  2282.  
  2283.                 // If not successful, then load the XML file
  2284.                 $xml = @simplexml_load_string(file_get_contents($translation_file));
  2285.                 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
  2286.                 $cac = array();
  2287.                 foreach ($xml->message as $msg) {
  2288.                         $src = trim($msg->source->__toString());
  2289.                         $dst = trim($msg->target->__toString());
  2290.                         $cac[$src] = $dst;
  2291.                 }
  2292.                 @file_put_contents($cache_file,serialize($cac));
  2293.                 @touch($cache_file,filemtime($translation_file));
  2294.                 return $cac;
  2295.         }
  2296.  
  2297.         /**
  2298.          * @param string $requested_lang
  2299.          * @return array
  2300.          * @throws OIDplusException
  2301.          */
  2302.         public static function getTranslationArray(string $requested_lang='*'): array {
  2303.                 foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
  2304.                         $lang = $pluginManifest->getLanguageCode();
  2305.                         if (strpos($lang,'/') !== false) continue; // just to be sure
  2306.                         if (strpos($lang,'\\') !== false) continue; // just to be sure
  2307.                         if (strpos($lang,'..') !== false) continue; // just to be sure
  2308.  
  2309.                         if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
  2310.  
  2311.                         if (!isset(self::$translationArray[$lang])) {
  2312.                                 self::$translationArray[$lang] = array();
  2313.  
  2314.                                 $wildcard = $pluginManifest->getLanguageMessages();
  2315.                                 if (strpos($wildcard,'/') !== false) continue; // just to be sure
  2316.                                 if (strpos($wildcard,'\\') !== false) continue; // just to be sure
  2317.                                 if (strpos($wildcard,'..') !== false) continue; // just to be sure
  2318.  
  2319.                                 $translation_files = glob(__DIR__.'/../../plugins/'.'*'.'/language/'.$lang.'/'.$wildcard);
  2320.                                 sort($translation_files);
  2321.                                 foreach ($translation_files as $translation_file) {
  2322.                                         if (!file_exists($translation_file)) continue;
  2323.                                         $cac = self::getTranslationFileContents($translation_file);
  2324.                                         foreach ($cac as $src => $dst) {
  2325.                                                 self::$translationArray[$lang][$src] = $dst;
  2326.                                         }
  2327.                                 }
  2328.                         }
  2329.                 }
  2330.                 return self::$translationArray;
  2331.         }
  2332.  
  2333.         /**
  2334.          * @return mixed
  2335.          */
  2336.         public static function getEditionInfo() {
  2337.                 return @parse_ini_file(__DIR__.'/../edition.ini', true)['Edition'];
  2338.         }
  2339.  
  2340.         /**
  2341.          * @return false|string
  2342.          */
  2343.         public static function findGitFolder() {
  2344.                 // Git command line saves git information in folder ".git"
  2345.                 // Plesk git saves git information in folder "../../../git/oidplus/" (or similar)
  2346.                 $dir = OIDplus::localpath();
  2347.                 if (is_dir($dir.'/.git')) return $dir.'/.git';
  2348.                 $i = 0;
  2349.                 do {
  2350.                         if (is_dir($dir.'/git')) {
  2351.                                 $confs = @glob($dir.'/git/'.'*'.'/config');
  2352.                                 if ($confs) foreach ($confs as $conf) {
  2353.                                         $cont = file_get_contents($conf);
  2354.                                         if (isset(OIDplus::getEditionInfo()['gitrepo']) && (OIDplus::getEditionInfo()['gitrepo'] != '') && (strpos($cont, OIDplus::getEditionInfo()['gitrepo']) !== false)) {
  2355.                                                 return dirname($conf);
  2356.                                         }
  2357.                                 }
  2358.                         }
  2359.                         $i++;
  2360.                 } while (($i<100) && ($dir != ($new_dir = @realpath($dir.'/../'))) && ($dir = $new_dir));
  2361.                 return false;
  2362.         }
  2363.  
  2364.         /**
  2365.          * @return false|string
  2366.          */
  2367.         public static function getGitsvnRevision() {
  2368.                 try {
  2369.                         // tries command line and binary parsing
  2370.                         // requires vendor/danielmarschall/git_utils.inc.php
  2371.                         $git_dir = OIDplus::findGitFolder();
  2372.                         if ($git_dir === false) return false;
  2373.                         $commit_msg = git_get_latest_commit_message($git_dir);
  2374.                 } catch (\Exception $e) {
  2375.                         return false;
  2376.                 }
  2377.  
  2378.                 $m = array();
  2379.                 if (preg_match('%git-svn-id: (.+)@(\\d+) %ismU', $commit_msg, $m)) {
  2380.                         return $m[2];
  2381.                 } else {
  2382.                         return false;
  2383.                 }
  2384.         }
  2385.  
  2386.         /**
  2387.          * @param string $static_node_id
  2388.          * @param bool $throw_exception
  2389.          * @return string
  2390.          */
  2391.         public static function prefilterQuery(string $static_node_id, bool $throw_exception): string {
  2392.                 // Let namespace be case-insensitive
  2393.                 $ary = explode(':', $static_node_id, 2);
  2394.                 $ary[0] = strtolower($ary[0]);
  2395.                 $static_node_id = implode(':', $ary);
  2396.  
  2397.                 // Ask plugins if they want to change the node id
  2398.                 foreach (OIDplus::getObjectTypePluginsEnabled() as $plugin) {
  2399.                         $static_node_id = $plugin->prefilterQuery($static_node_id, $throw_exception);
  2400.                 }
  2401.  
  2402.                 return $static_node_id;
  2403.         }
  2404.  
  2405.         /**
  2406.          * @return bool
  2407.          */
  2408.         public static function isCronjob(): bool {
  2409.                 return explode('.',basename($_SERVER['SCRIPT_NAME']))[0] === 'cron';
  2410.         }
  2411.  
  2412.         /**
  2413.          * Since OIDplus svn-184, entries in the database need to have a canonical ID
  2414.          * If the ID is not canonical (e.g. GUIDs missing hyphens), the object cannot be opened in OIDplus
  2415.          * This script re-canonizes the object IDs if required.
  2416.          * In SVN Rev 856, the canonization for GUID, IPv4 and IPv6 have changed, requiring another
  2417.          * re-canonization
  2418.          * @return void
  2419.          * @throws OIDplusException
  2420.          */
  2421.         private static function recanonizeObjects() {
  2422.                 $res = OIDplus::db()->query("select id from ###objects");
  2423.                 while ($row = $res->fetch_array()) {
  2424.                         $ida = $row['id'];
  2425.                         $obj = OIDplusObject::parse($ida);
  2426.                         if (!$obj) continue;
  2427.                         $idb = $obj->nodeId();
  2428.                         if (($idb) && ($ida != $idb)) {
  2429.                                 OIDplus::db()->transaction_begin();
  2430.                                 OIDplus::db()->query("update ###objects set id = ? where id = ?", array($idb, $ida));
  2431.                                 OIDplus::db()->query("update ###asn1id set oid = ? where oid = ?", array($idb, $ida));
  2432.                                 OIDplus::db()->query("update ###iri set oid = ? where oid = ?", array($idb, $ida));
  2433.                                 OIDplus::db()->query("update ###log_object set id = ? where id = ?", array($idb, $ida));
  2434.                                 OIDplus::logger()->log("[INFO]A!", "Object name '$ida' has been changed to '$idb' during re-canonization");
  2435.                                 OIDplus::db()->transaction_commit();
  2436.                                 OIDplusObject::resetObjectInformationCache();
  2437.                         }
  2438.                 }
  2439.         }
  2440.  
  2441. }
  2442.