Subversion Repositories oidplus

Rev

Rev 928 | Rev 978 | 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 - 2022 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. if (!defined('INSIDE_OIDPLUS')) die();
  21.  
  22. class OIDplus extends OIDplusBaseClass {
  23.         private static /*OIDplusPagePlugin[]*/ $pagePlugins = array();
  24.         private static /*OIDplusAuthPlugin[]*/ $authPlugins = array();
  25.         private static /*OIDplusLoggerPlugin[]*/ $loggerPlugins = array();
  26.         private static /*OIDplusObjectTypePlugin[]*/ $objectTypePlugins = array();
  27.         private static /*string[]*/ $enabledObjectTypes = array();
  28.         private static /*string[]*/ $disabledObjectTypes = array();
  29.         private static /*OIDplusDatabasePlugin[]*/ $dbPlugins = array();
  30.         private static /*OIDplusCaptchaPlugin[]*/ $captchaPlugins = array();
  31.         private static /*OIDplusSqlSlangPlugin[]*/ $sqlSlangPlugins = array();
  32.         private static /*OIDplusLanguagePlugin[]*/ $languagePlugins = array();
  33.         private static /*OIDplusDesignPlugin[]*/ $designPlugins = array();
  34.  
  35.         protected static $html = true;
  36.  
  37.         /*public*/ const DEFAULT_LANGUAGE = 'enus'; // the language of the source code
  38.  
  39.         /*public*/ const PATH_RELATIVE = 1;                   // e.g. "../"
  40.         /*public*/ const PATH_ABSOLUTE = 2;                   // e.g. "http://www.example.com/oidplus/"
  41.         /*public*/ const PATH_ABSOLUTE_CANONICAL = 3;         // e.g. "http://www.example.org/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
  42.         /*public*/ const PATH_RELATIVE_TO_ROOT = 4;           // e.g. "/oidplus/"
  43.         /*public*/ const PATH_RELATIVE_TO_ROOT_CANONICAL = 5; // e.g. "/oidplus/" (if baseconfig CANONICAL_SYSTEM_URL is set)
  44.  
  45.         // These plugin types can contain HTML code and therefore may
  46.         // emit (non-setup) CSS/JS code via their manifest.
  47.         /*public*/ const INTERACTIVE_PLUGIN_TYPES = array(
  48.                 'publicPages',
  49.                 'raPages',
  50.                 'adminPages',
  51.                 'objectTypes',
  52.                 'captcha'
  53.         );
  54.  
  55.         private function __construct() {
  56.         }
  57.  
  58.         # --- Static classes
  59.  
  60.         private static $baseConfig = null;
  61.         private static $old_config_format = false;
  62.         public static function baseConfig() {
  63.                 $first_init = false;
  64.  
  65.                 if ($first_init = is_null(self::$baseConfig)) {
  66.                         self::$baseConfig = new OIDplusBaseConfig();
  67.                 }
  68.  
  69.                 if ($first_init) {
  70.                         // Include a file containing various size/depth limitations of OIDs
  71.                         // It is important to include it before userdata/baseconfig/config.inc.php was included,
  72.                         // so we can give userdata/baseconfig/config.inc.php the chance to override the values.
  73.  
  74.                         include OIDplus::localpath().'includes/oidplus_limits.inc.php';
  75.  
  76.                         // Include config file
  77.  
  78.                         $config_file = OIDplus::localpath() . 'userdata/baseconfig/config.inc.php';
  79.                         $config_file_old = OIDplus::localpath() . 'includes/config.inc.php'; // backwards compatibility
  80.  
  81.                         if (!file_exists($config_file) && file_exists($config_file_old)) {
  82.                                 $config_file = $config_file_old;
  83.                         }
  84.  
  85.                         if (file_exists($config_file)) {
  86.                                 if (self::$old_config_format) {
  87.                                         // Note: We may only include it once due to backwards compatibility,
  88.                                         //       since in version 2.0, the configuration was defined using define() statements
  89.                                         // Attention: This does mean that a full re-init (e.g. for test cases) is not possible
  90.                                         //            if a version 2.0 config is used!
  91.                                         include_once $config_file;
  92.                                 } else {
  93.                                         include $config_file;
  94.                                 }
  95.  
  96.                                 if (defined('OIDPLUS_CONFIG_VERSION') && (OIDPLUS_CONFIG_VERSION == 2.0)) {
  97.                                         self::$old_config_format = true;
  98.  
  99.                                         // Backwards compatibility 2.0 => 2.1
  100.                                         foreach (get_defined_constants(true)['user'] as $name => $value) {
  101.                                                 $name = str_replace('OIDPLUS_', '', $name);
  102.                                                 if ($name == 'SESSION_SECRET') $name = 'SERVER_SECRET';
  103.                                                 if ($name == 'MYSQL_QUERYLOG') $name = 'QUERY_LOGFILE';
  104.                                                 if (($name == 'MYSQL_PASSWORD') || ($name == 'ODBC_PASSWORD') || ($name == 'PDO_PASSWORD') || ($name == 'PGSQL_PASSWORD')) {
  105.                                                         self::$baseConfig->setValue($name, base64_decode($value));
  106.                                                 } else {
  107.                                                         if ($name == 'CONFIG_VERSION') $value = 2.1;
  108.                                                         self::$baseConfig->setValue($name, $value);
  109.                                                 }
  110.                                         }
  111.                                 }
  112.                         } else {
  113.                                 if (!is_dir(OIDplus::localpath().'setup')) {
  114.                                         throw new OIDplusConfigInitializationException(_L('File %1 is missing, but setup can\'t be started because its directory missing.','userdata/baseconfig/config.inc.php'));
  115.                                 } else {
  116.                                         if (self::$html) {
  117.                                                 if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE_TO_ROOT).'setup/') !== 0) {
  118.                                                         header('Location:'.OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/');
  119.                                                         die(_L('Redirecting to setup...'));
  120.                                                 } else {
  121.                                                         return self::$baseConfig;
  122.                                                 }
  123.                                         } else {
  124.                                                 // This can be displayed in e.g. ajax.php
  125.                                                 throw new OIDplusConfigInitializationException(_L('File %1 is missing. Please run setup again.','userdata/baseconfig/config.inc.php'));
  126.                                         }
  127.                                 }
  128.                         }
  129.  
  130.                         // Check important config settings
  131.  
  132.                         if (self::$baseConfig->getValue('CONFIG_VERSION') != 2.1) {
  133.                                 if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/') !== 0) {
  134.                                         throw new OIDplusConfigInitializationException(_L("The information located in %1 is outdated.",realpath($config_file)));
  135.                                 }
  136.                         }
  137.  
  138.                         if (self::$baseConfig->getValue('SERVER_SECRET', '') === '') {
  139.                                 if (strpos($_SERVER['REQUEST_URI'], OIDplus::webpath(null,OIDplus::PATH_RELATIVE).'setup/') !== 0) {
  140.                                         throw new OIDplusConfigInitializationException(_L("You must set a value for SERVER_SECRET in %1 for the system to operate secure.",realpath($config_file)));
  141.                                 }
  142.                         }
  143.                 }
  144.  
  145.                 return self::$baseConfig;
  146.         }
  147.  
  148.         private static $config = null;
  149.         public static function config() {
  150.                 if ($first_init = is_null(self::$config)) {
  151.                         self::$config = new OIDplusConfig();
  152.                 }
  153.  
  154.                 if ($first_init) {
  155.                         // These are important settings for base functionalities and therefore are not inside plugins
  156.                         self::$config->prepareConfigKey('system_title', 'What is the name of your RA?', 'OIDplus 2.0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  157.                                 if (empty($value)) {
  158.                                         throw new OIDplusException(_L('Please enter a value for the system title.'));
  159.                                 }
  160.                         });
  161.                         self::$config->prepareConfigKey('admin_email', 'E-Mail address of the system administrator', '', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  162.                                 if (!empty($value) && !OIDplus::mailUtils()->validMailAddress($value)) {
  163.                                         throw new OIDplusException(_L('This is not a correct email address'));
  164.                                 }
  165.                         });
  166.                         self::$config->prepareConfigKey('global_cc', 'Global CC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function(&$value) {
  167.                                 $value = trim($value);
  168.                                 if ($value === '') return;
  169.                                 $addrs = explode(';', $value);
  170.                                 foreach ($addrs as $addr) {
  171.                                         $addr = trim($addr);
  172.                                         if (!empty($addr) && !OIDplus::mailUtils()->validMailAddress($addr)) {
  173.                                                 throw new OIDplusException(_L('%1 is not a correct email address',$addr));
  174.                                         }
  175.                                 }
  176.                         });
  177.                         self::$config->prepareConfigKey('global_bcc', 'Global BCC for all outgoing emails?', '', OIDplusConfig::PROTECTION_EDITABLE, function(&$value) {
  178.                                 $value = trim($value);
  179.                                 if ($value === '') return;
  180.                                 $addrs = explode(';', $value);
  181.                                 foreach ($addrs as $addr) {
  182.                                         $addr = trim($addr);
  183.                                         if (!empty($addr) && !OIDplus::mailUtils()->validMailAddress($addr)) {
  184.                                                 throw new OIDplusException(_L('%1 is not a correct email address',$addr));
  185.                                         }
  186.                                 }
  187.                         });
  188.                         self::$config->prepareConfigKey('objecttypes_initialized', 'List of object type plugins that were initialized once', '', OIDplusConfig::PROTECTION_READONLY, function($value) {
  189.                                 // Nothing here yet
  190.                         });
  191.                         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) {
  192.                                 # 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?
  193.  
  194.                                 $ary = explode(';',$value);
  195.                                 $uniq_ary = array_unique($ary);
  196.  
  197.                                 if (count($ary) != count($uniq_ary)) {
  198.                                         throw new OIDplusException(_L('Please check your input. Some object types are double.'));
  199.                                 }
  200.  
  201.                                 foreach ($ary as $ot_check) {
  202.                                         $ns_found = false;
  203.                                         foreach (OIDplus::getEnabledObjectTypes() as $ot) {
  204.                                                 if ($ot::ns() == $ot_check) {
  205.                                                         $ns_found = true;
  206.                                                         break;
  207.                                                 }
  208.                                         }
  209.                                         foreach (OIDplus::getDisabledObjectTypes() as $ot) {
  210.                                                 if ($ot::ns() == $ot_check) {
  211.                                                         $ns_found = true;
  212.                                                         break;
  213.                                                 }
  214.                                         }
  215.                                         if (!$ns_found) {
  216.                                                 throw new OIDplusException(_L('Please check your input. Namespace "%1" is not found',$ot_check));
  217.                                         }
  218.                                 }
  219.                         });
  220.                         self::$config->prepareConfigKey('oidplus_private_key', 'Private key for this system', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
  221.                                 // Nothing here yet
  222.                         });
  223.                         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) {
  224.                                 // Nothing here yet
  225.                         });
  226.                         self::$config->prepareConfigKey('last_known_system_url', 'Last known System URL', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
  227.                                 // Nothing here yet
  228.                         });
  229.                         self::$config->prepareConfigKey('last_known_version', 'Last known OIDplus Version', '', OIDplusConfig::PROTECTION_HIDDEN, function($value) {
  230.                                 // Nothing here yet
  231.                         });
  232.                         self::$config->prepareConfigKey('default_ra_auth_method', 'Default auth method used for generating password of RAs (must exist in plugins/[vendorname]/auth/)?', 'A3_bcrypt', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  233.                                 $good = true;
  234.                                 if (strpos($value,'/') !== false) $good = false;
  235.                                 if (strpos($value,'\\') !== false) $good = false;
  236.                                 if (strpos($value,'..') !== false) $good = false;
  237.                                 if (!$good) {
  238.                                         throw new OIDplusException(_L('Invalid auth plugin folder name. Do only enter a folder name, not an absolute or relative path'));
  239.                                 }
  240.  
  241.                                 if (!wildcard_is_dir(OIDplus::localpath().'plugins/'.'*'.'/auth/'.$value)) {
  242.                                         throw new OIDplusException(_L('The auth plugin "%1" does not exist in plugin directory %2',$value,'plugins/[vendorname]/auth/'));
  243.                                 }
  244.                         });
  245.                 }
  246.  
  247.                 return self::$config;
  248.         }
  249.  
  250.         private static $gui = null;
  251.         public static function gui() {
  252.                 if (is_null(self::$gui)) {
  253.                         self::$gui = new OIDplusGui();
  254.                 }
  255.                 return self::$gui;
  256.         }
  257.  
  258.         private static $authUtils = null;
  259.         public static function authUtils() {
  260.                 if (is_null(self::$authUtils)) {
  261.                         self::$authUtils = new OIDplusAuthUtils();
  262.                 }
  263.                 return self::$authUtils;
  264.         }
  265.  
  266.         private static $mailUtils = null;
  267.         public static function mailUtils() {
  268.                 if (is_null(self::$mailUtils)) {
  269.                         self::$mailUtils = new OIDplusMailUtils();
  270.                 }
  271.                 return self::$mailUtils;
  272.         }
  273.  
  274.         private static $cookieUtils = null;
  275.         public static function cookieUtils() {
  276.                 if (is_null(self::$cookieUtils)) {
  277.                         self::$cookieUtils = new OIDplusCookieUtils();
  278.                 }
  279.                 return self::$cookieUtils;
  280.         }
  281.  
  282.         private static $menuUtils = null;
  283.         public static function menuUtils() {
  284.                 if (is_null(self::$menuUtils)) {
  285.                         self::$menuUtils = new OIDplusMenuUtils();
  286.                 }
  287.                 return self::$menuUtils;
  288.         }
  289.  
  290.         private static $logger = null;
  291.         public static function logger() {
  292.                 if (is_null(self::$logger)) {
  293.                         self::$logger = new OIDplusLogger();
  294.                 }
  295.                 return self::$logger;
  296.         }
  297.  
  298.         # --- SQL slang plugin
  299.  
  300.         private static function registerSqlSlangPlugin(OIDplusSqlSlangPlugin $plugin) {
  301.                 $name = $plugin::id();
  302.                 if ($name === '') return false;
  303.  
  304.                 if (isset(self::$sqlSlangPlugins[$name])) {
  305.                         $plugintype_hf = _L('SQL slang');
  306.                         throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
  307.                 }
  308.  
  309.                 self::$sqlSlangPlugins[$name] = $plugin;
  310.  
  311.                 return true;
  312.         }
  313.  
  314.         public static function getSqlSlangPlugins() {
  315.                 return self::$sqlSlangPlugins;
  316.         }
  317.  
  318.         public static function getSqlSlangPlugin($id)/*: ?OIDplusSqlSlangPlugin*/ {
  319.                 if (isset(self::$sqlSlangPlugins[$id])) {
  320.                         return self::$sqlSlangPlugins[$id];
  321.                 } else {
  322.                         return null;
  323.                 }
  324.         }
  325.  
  326.         # --- Database plugin
  327.  
  328.         private static function registerDatabasePlugin(OIDplusDatabasePlugin $plugin) {
  329.                 $name = $plugin::id();
  330.                 if ($name === '') return false;
  331.  
  332.                 if (isset(self::$dbPlugins[$name])) {
  333.                         $plugintype_hf = _L('Database');
  334.                         throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
  335.                 }
  336.  
  337.                 self::$dbPlugins[$name] = $plugin;
  338.  
  339.                 return true;
  340.         }
  341.  
  342.         public static function getDatabasePlugins() {
  343.                 return self::$dbPlugins;
  344.         }
  345.  
  346.         public static function getActiveDatabasePlugin() {
  347.                 $db_plugin_name = OIDplus::baseConfig()->getValue('DATABASE_PLUGIN','');
  348.                 if ($db_plugin_name === '') {
  349.                         throw new OIDplusConfigInitializationException(_L('No database plugin selected in config file'));
  350.                 }
  351.                 if (!isset(self::$dbPlugins[$db_plugin_name])) {
  352.                         throw new OIDplusConfigInitializationException(_L('Database plugin "%1" not found',$db_plugin_name));
  353.                 }
  354.                 return self::$dbPlugins[$db_plugin_name];
  355.         }
  356.  
  357.         private static $dbMainSession = null;
  358.         public static function db() {
  359.                 if (is_null(self::$dbMainSession)) {
  360.                         self::$dbMainSession = self::getActiveDatabasePlugin()->newConnection();
  361.                 }
  362.                 if (!self::$dbMainSession->isConnected()) self::$dbMainSession->connect();
  363.                 return self::$dbMainSession;
  364.         }
  365.  
  366.         private static $dbIsolatedSession = null;
  367.         public static function dbIsolated() {
  368.                 if (is_null(self::$dbIsolatedSession)) {
  369.                         self::$dbIsolatedSession = self::getActiveDatabasePlugin()->newConnection();
  370.                 }
  371.                 if (!self::$dbIsolatedSession->isConnected()) self::$dbIsolatedSession->connect();
  372.                 return self::$dbIsolatedSession;
  373.         }
  374.  
  375.         # --- CAPTCHA plugin
  376.  
  377.         private static function registerCaptchaPlugin(OIDplusCaptchaPlugin $plugin) {
  378.                 $name = $plugin::id();
  379.                 if ($name === '') return false;
  380.  
  381.                 if (isset(self::$captchaPlugins[$name])) {
  382.                         $plugintype_hf = _L('CAPTCHA');
  383.                         throw new OIDplusException(_L('Multiple %1 plugins use the ID %2', $plugintype_hf, $name));
  384.                 }
  385.  
  386.                 self::$captchaPlugins[$name] = $plugin;
  387.  
  388.                 return true;
  389.         }
  390.  
  391.         public static function getCaptchaPlugins() {
  392.                 return self::$captchaPlugins;
  393.         }
  394.  
  395.         public static function getActiveCaptchaPluginId() {
  396.                 $captcha_plugin_name = OIDplus::baseConfig()->getValue('CAPTCHA_PLUGIN', '');
  397.  
  398.                 if (OIDplus::baseConfig()->getValue('RECAPTCHA_ENABLED', false) && ($captcha_plugin_name === '')) {
  399.                         // Legacy config file support!
  400.                         $captcha_plugin_name = 'ReCAPTCHA';
  401.                 }
  402.  
  403.                 if ($captcha_plugin_name === '') $captcha_plugin_name = 'None'; // the "None" plugin is a must-have!
  404.  
  405.                 return $captcha_plugin_name;
  406.         }
  407.  
  408.         public static function getActiveCaptchaPlugin() {
  409.                 $captcha_plugin_name = OIDplus::getActiveCaptchaPluginId();
  410.  
  411.                 if (!isset(self::$captchaPlugins[$captcha_plugin_name])) {
  412.                         throw new OIDplusConfigInitializationException(_L('CAPTCHA plugin "%1" not found',$captcha_plugin_name));
  413.                 }
  414.                 return self::$captchaPlugins[$captcha_plugin_name];
  415.         }
  416.  
  417.         # --- Page plugin
  418.  
  419.         private static function registerPagePlugin(OIDplusPagePlugin $plugin) {
  420.                 self::$pagePlugins[] = $plugin;
  421.  
  422.                 return true;
  423.         }
  424.  
  425.         public static function getPagePlugins() {
  426.                 return self::$pagePlugins;
  427.         }
  428.  
  429.         # --- Auth plugin
  430.  
  431.         private static function registerAuthPlugin(OIDplusAuthPlugin $plugin) {
  432.                 if (OIDplus::baseConfig()->getValue('DEBUG')) {
  433.                         $password = generateRandomString(25);
  434.  
  435.                         try {
  436.                                 $authInfo = $plugin->generate($password);
  437.                         } catch (OIDplusException $e) {
  438.                                 // This can happen when the AuthKey or Salt is too long
  439.                                 throw new OIDplusException(_L('Auth plugin "%1" is erroneous: %2',basename($plugin->getPluginDirectory()),$e->getMessage()));
  440.                         }
  441.                         $salt = $authInfo->getSalt();
  442.                         $authKey = $authInfo->getAuthKey();
  443.  
  444.                         $authInfo_SaltDiff = clone $authInfo;
  445.                         $authInfo_SaltDiff->setSalt(strrev($authInfo_SaltDiff->getSalt()));
  446.  
  447.                         $authInfo_AuthKeyDiff = clone $authInfo;
  448.                         $authInfo_AuthKeyDiff->setAuthKey(strrev($authInfo_AuthKeyDiff->getAuthKey()));
  449.  
  450.                         if ((!$plugin->verify($authInfo,$password)) ||
  451.                            (!empty($salt) && $plugin->verify($authInfo_SaltDiff,$password)) ||
  452.                            ($plugin->verify($authInfo_AuthKeyDiff,$password)) ||
  453.                            ($plugin->verify($authInfo,$password.'x'))) {
  454.                                 throw new OIDplusException(_L('Auth plugin "%1" is erroneous: Generate/Verify self test failed',basename($plugin->getPluginDirectory())));
  455.                         }
  456.                 }
  457.  
  458.                 self::$authPlugins[] = $plugin;
  459.                 return true;
  460.         }
  461.  
  462.         public static function getAuthPlugins() {
  463.                 return self::$authPlugins;
  464.         }
  465.  
  466.         # --- Language plugin
  467.  
  468.         private static function registerLanguagePlugin(OIDplusLanguagePlugin $plugin) {
  469.                 self::$languagePlugins[] = $plugin;
  470.                 return true;
  471.         }
  472.  
  473.         public static function getLanguagePlugins() {
  474.                 return self::$languagePlugins;
  475.         }
  476.  
  477.         # --- Design plugin
  478.  
  479.         private static function registerDesignPlugin(OIDplusDesignPlugin $plugin) {
  480.                 self::$designPlugins[] = $plugin;
  481.                 return true;
  482.         }
  483.  
  484.         public static function getDesignPlugins() {
  485.                 return self::$designPlugins;
  486.         }
  487.  
  488.         public static function getActiveDesignPlugin() {
  489.                 $plugins = OIDplus::getDesignPlugins();
  490.                 foreach ($plugins as $plugin) {
  491.                         if ((basename($plugin->getPluginDirectory())) == OIDplus::config()->getValue('design','default')) {
  492.                                 return $plugin;
  493.                         }
  494.                 }
  495.                 return null;
  496.         }
  497.  
  498.         # --- Logger plugin
  499.  
  500.         private static function registerLoggerPlugin(OIDplusLoggerPlugin $plugin) {
  501.                 self::$loggerPlugins[] = $plugin;
  502.                 return true;
  503.         }
  504.  
  505.         public static function getLoggerPlugins() {
  506.                 return self::$loggerPlugins;
  507.         }
  508.  
  509.         # --- Object type plugin
  510.  
  511.         private static function registerObjectTypePlugin(OIDplusObjectTypePlugin $plugin) {
  512.                 self::$objectTypePlugins[] = $plugin;
  513.  
  514.                 $ot = $plugin::getObjectTypeClassName();
  515.                 self::registerObjectType($ot);
  516.  
  517.                 return true;
  518.         }
  519.  
  520.         private static function registerObjectType($ot) {
  521.                 $ns = $ot::ns();
  522.                 if (empty($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace must not be empty',$ot));
  523.  
  524.                 // Currently, we must enforce that namespaces in objectType plugins are lowercase, because prefilterQuery() makes all namespaces lowercase and the DBMS should be case-sensitive
  525.                 if ($ns != strtolower($ns)) throw new OIDplusException(_L('ObjectType plugin %1 is erroneous: Namespace %2 must be lower-case',$ot,$ns));
  526.  
  527.                 $root = $ot::root();
  528.                 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.':'));
  529.  
  530.                 $ns_found = false;
  531.                 foreach (array_merge(OIDplus::getEnabledObjectTypes(), OIDplus::getDisabledObjectTypes()) as $test_ot) {
  532.                         if ($test_ot::ns() == $ns) {
  533.                                 $ns_found = true;
  534.                                 break;
  535.                         }
  536.                 }
  537.                 if ($ns_found) {
  538.                         throw new OIDplusException(_L('Attention: Two objectType plugins use the same namespace "%1"!',$ns));
  539.                 }
  540.  
  541.                 $init = OIDplus::config()->getValue("objecttypes_initialized");
  542.                 $init_ary = empty($init) ? array() : explode(';', $init);
  543.                 $init_ary = array_map('trim', $init_ary);
  544.  
  545.                 $enabled = OIDplus::config()->getValue("objecttypes_enabled");
  546.                 $enabled_ary = empty($enabled) ? array() : explode(';', $enabled);
  547.                 $enabled_ary = array_map('trim', $enabled_ary);
  548.  
  549.                 $do_enable = false;
  550.                 if (in_array($ns, $enabled_ary)) {
  551.                         // If it is in the list of enabled object types, it is enabled (obviously)
  552.                         $do_enable = true;
  553.                 } else {
  554.                         if (!OIDplus::config()->getValue('oobe_objects_done')) {
  555.                                 // If the OOBE wizard is NOT done, then just enable the "oid" object type by default
  556.                                 $do_enable = $ns == 'oid';
  557.                         } else {
  558.                                 // If the OOBE wizard was done (once), then
  559.                                 // we will enable all object types which were never initialized
  560.                                 // (i.e. a plugin folder was freshly added)
  561.                                 $do_enable = !in_array($ns, $init_ary);
  562.                         }
  563.                 }
  564.  
  565.                 if ($do_enable) {
  566.                         self::$enabledObjectTypes[] = $ot;
  567.                         usort(self::$enabledObjectTypes, function($a, $b) {
  568.                                 $enabled = OIDplus::config()->getValue("objecttypes_enabled");
  569.                                 $enabled_ary = explode(';', $enabled);
  570.  
  571.                                 $idx_a = array_search($a::ns(), $enabled_ary);
  572.                                 $idx_b = array_search($b::ns(), $enabled_ary);
  573.  
  574.                                 if ($idx_a == $idx_b) {
  575.                                     return 0;
  576.                                 }
  577.                                 return ($idx_a > $idx_b) ? +1 : -1;
  578.                         });
  579.                 } else {
  580.                         self::$disabledObjectTypes[] = $ot;
  581.                 }
  582.  
  583.                 if (!in_array($ns, $init_ary)) {
  584.                         // Was never initialized before, so we add it to the list of enabled object types once
  585.  
  586.                         if ($do_enable) {
  587.                                 $enabled_ary[] = $ns;
  588.                                 // Important: Don't validate the input, because the other object types might not be initialized yet! So use setValueNoCallback() instead setValue().
  589.                                 OIDplus::config()->setValueNoCallback("objecttypes_enabled", implode(';', $enabled_ary));
  590.                         }
  591.  
  592.                         $init_ary[] = $ns;
  593.                         OIDplus::config()->setValue("objecttypes_initialized", implode(';', $init_ary));
  594.                 }
  595.         }
  596.  
  597.         public static function getObjectTypePlugins() {
  598.                 return self::$objectTypePlugins;
  599.         }
  600.  
  601.         public static function getObjectTypePluginsEnabled() {
  602.                 $res = array();
  603.                 foreach (self::$objectTypePlugins as $plugin) {
  604.                         $ot = $plugin::getObjectTypeClassName();
  605.                         if (in_array($ot, self::$enabledObjectTypes)) $res[] = $plugin;
  606.                 }
  607.                 return $res;
  608.         }
  609.  
  610.         public static function getObjectTypePluginsDisabled() {
  611.                 $res = array();
  612.                 foreach (self::$objectTypePlugins as $plugin) {
  613.                         $ot = $plugin::getObjectTypeClassName();
  614.                         if (in_array($ot, self::$disabledObjectTypes)) $res[] = $plugin;
  615.                 }
  616.                 return $res;
  617.         }
  618.  
  619.         public static function getEnabledObjectTypes() {
  620.                 return self::$enabledObjectTypes;
  621.         }
  622.  
  623.         public static function getDisabledObjectTypes() {
  624.                 return self::$disabledObjectTypes;
  625.         }
  626.  
  627.         # --- Plugin handling functions
  628.  
  629.         public static function getAllPlugins()/*: array*/ {
  630.                 $res = array();
  631.                 $res = array_merge($res, self::$pagePlugins);
  632.                 $res = array_merge($res, self::$authPlugins);
  633.                 $res = array_merge($res, self::$loggerPlugins);
  634.                 $res = array_merge($res, self::$objectTypePlugins);
  635.                 $res = array_merge($res, self::$dbPlugins);
  636.                 $res = array_merge($res, self::$captchaPlugins);
  637.                 $res = array_merge($res, self::$sqlSlangPlugins);
  638.                 $res = array_merge($res, self::$languagePlugins);
  639.                 $res = array_merge($res, self::$designPlugins);
  640.                 return $res;
  641.         }
  642.  
  643.         public static function getPluginByOid($oid)/*: ?OIDplusPlugin*/ {
  644.                 $plugins = self::getAllPlugins();
  645.                 foreach ($plugins as $plugin) {
  646.                         if (oid_dotnotation_equal($plugin->getManifest()->getOid(), $oid)) {
  647.                                 return $plugin;
  648.                         }
  649.                 }
  650.                 return null;
  651.         }
  652.  
  653.         public static function getPluginByClassName($classname)/*: ?OIDplusPlugin*/ {
  654.                 $plugins = self::getAllPlugins();
  655.                 foreach ($plugins as $plugin) {
  656.                         if (get_class($plugin) === $classname) {
  657.                                 return $plugin;
  658.                         }
  659.                 }
  660.                 return null;
  661.         }
  662.  
  663.         /**
  664.         * @return array<OIDplusPluginManifest>|array<string,array<string,OIDplusPluginManifest>>
  665.         */
  666.         public static function getAllPluginManifests($pluginFolderMasks='*', $flat=true): array {
  667.                 $out = array();
  668.                 // Note: glob() will sort by default, so we do not need a page priority attribute.
  669.                 //       So you just need to use a numeric plugin directory prefix (padded).
  670.                 $ary = array();
  671.                 foreach (explode(',',$pluginFolderMasks) as $pluginFolderMask) {
  672.                         $ary = array_merge($ary,glob(OIDplus::localpath().'plugins/'.'*'.'/'.$pluginFolderMask.'/'.'*'.'/manifest.xml'));
  673.                 }
  674.  
  675.                 // Sort the plugins by their type and name, as if they would be in a single vendor-folder!
  676.                 uasort($ary, function($a,$b) {
  677.                         if ($a == $b) return 0;
  678.  
  679.                         $ary = explode('/',$a);
  680.                         $bry = explode('/',$b);
  681.  
  682.                         // First sort by type (publicPage, auth, database, language, ...)
  683.                         $a_type = $ary[count($ary)-1-2];
  684.                         $b_type = $bry[count($bry)-1-2];
  685.                         if ($a_type < $b_type) return -1;
  686.                         if ($a_type > $b_type) return 1;
  687.  
  688.                         // Then sort by name (090_login, 100_whois, etc.)
  689.                         $a_name = $ary[count($ary)-1-1];
  690.                         $b_name = $bry[count($bry)-1-1];
  691.                         if ($a_name < $b_name) return -1;
  692.                         if ($a_name > $b_name) return 1;
  693.  
  694.                         // If it is still equal, then finally sort by vendorname
  695.                         $a_vendor = $ary[count($ary)-1-3];
  696.                         $b_vendor = $bry[count($bry)-1-3];
  697.                         if ($a_vendor < $b_vendor) return -1;
  698.                         if ($a_vendor > $b_vendor) return 1;
  699.                         return 0;
  700.                 });
  701.  
  702.                 foreach ($ary as $ini) {
  703.                         if (!file_exists($ini)) continue;
  704.  
  705.                         $manifest = new OIDplusPluginManifest();
  706.                         $manifest->loadManifest($ini);
  707.  
  708.                         $class_name = $manifest->getPhpMainClass();
  709.                         if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
  710.                                 continue;
  711.                         }
  712.  
  713.                         if ($flat) {
  714.                                 $out[] = $manifest;
  715.                         } else {
  716.                                 $plugintype_folder = basename(dirname(dirname($ini)));
  717.                                 $pluginname_folder = basename(dirname($ini));
  718.  
  719.                                 if (!isset($out[$plugintype_folder])) $out[$plugintype_folder] = array();
  720.                                 if (!isset($out[$plugintype_folder][$pluginname_folder])) $out[$plugintype_folder][$pluginname_folder] = array();
  721.                                 $out[$plugintype_folder][$pluginname_folder] = $manifest;
  722.                         }
  723.                 }
  724.                 return $out;
  725.         }
  726.  
  727.         /**
  728.         * @return array<string>
  729.         */
  730.         public static function registerAllPlugins($pluginDirName, $expectedPluginClass, $registerCallback): array {
  731.                 $out = array();
  732.                 if (is_array($pluginDirName)) {
  733.                         $ary = array();
  734.                         foreach ($pluginDirName as $pluginDirName_) {
  735.                                 $ary = array_merge($ary, self::getAllPluginManifests($pluginDirName_, false));
  736.                         }
  737.                 } else {
  738.                         $ary = self::getAllPluginManifests($pluginDirName, false);
  739.                 }
  740.                 $known_plugin_oids = array();
  741.                 if (OIDplus::baseConfig()->getValue('DEBUG')) {
  742.                         $fake_feature = uuid_to_oid(gen_uuid());
  743.                 } else {
  744.                         $fake_feature = null;
  745.                 }
  746.                 foreach ($ary as $plugintype_folder => $bry) {
  747.                         foreach ($bry as $pluginname_folder => $manifest) {
  748.                                 $class_name = $manifest->getPhpMainClass();
  749.  
  750.                                 // Before we load the plugin, we want to make some checks to confirm
  751.                                 // that the plugin is working correctly.
  752.  
  753.                                 if (!$class_name) {
  754.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Manifest does not declare a PHP main class'));
  755.                                 }
  756.                                 if (OIDplus::baseConfig()->getValue('DISABLE_PLUGIN_'.$class_name, false)) {
  757.                                         continue;
  758.                                 }
  759.                                 if (!class_exists($class_name)) {
  760.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Manifest declares PHP main class as "%1", but it could not be found',$class_name));
  761.                                 }
  762.                                 if (!is_subclass_of($class_name, $expectedPluginClass)) {
  763.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Plugin main class "%1" is expected to be a subclass of "%2"',$class_name,$expectedPluginClass));
  764.                                 }
  765.                                 if (($class_name!=$manifest->getTypeClass()) && (!is_subclass_of($class_name,$manifest->getTypeClass()))) {
  766.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Plugin main class "%1" is expected to be a subclass of "%2", according to type declared in manifest',$class_name,$manifest->getTypeClass()));
  767.                                 }
  768.                                 if (($manifest->getTypeClass()!=$expectedPluginClass) && (!is_subclass_of($manifest->getTypeClass(),$expectedPluginClass))) {
  769.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Class declared in manifest is "%1" does not fit expected class for this plugin type "%2"',$manifest->getTypeClass(),$expectedPluginClass));
  770.                                 }
  771.  
  772.                                 $plugin_oid = $manifest->getOid();
  773.                                 if (!$plugin_oid) {
  774.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Does not have an OID'));
  775.                                 }
  776.                                 if (!oid_valid_dotnotation($plugin_oid, false, false, 2)) {
  777.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('Plugin OID "%1" is invalid (needs to be valid dot-notation)',$plugin_oid));
  778.                                 }
  779.                                 if (isset($known_plugin_oids[$plugin_oid])) {
  780.                                         throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('The OID "%1" is already used by the plugin "%2"',$plugin_oid,$known_plugin_oids[$plugin_oid]));
  781.                                 }
  782.  
  783.                                 $full_plugin_dir = dirname($manifest->getManifestFile());
  784.                                 $full_plugin_dir = substr($full_plugin_dir, strlen(OIDplus::localpath()));
  785.                                 // { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) 37476 products(2) oidplus(5) v2(2) plugins(4) }
  786.                                 if (str_starts_with($full_plugin_dir, 'plugins/viathinksoft/') != str_starts_with($plugin_oid, '1.3.6.1.4.1.37476.2.5.2.4.')) {
  787.                                         throw new OIDplusException(_L('Plugin "%1/%2" is misplaced',$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/'));
  788.                                 }
  789.  
  790.                                 $known_plugin_oids[$plugin_oid] = $plugintype_folder.'/'.$pluginname_folder;
  791.  
  792.                                 $obj = new $class_name();
  793.  
  794.                                 if (OIDplus::baseConfig()->getValue('DEBUG')) {
  795.                                         if ($obj->implementsFeature($fake_feature)) {
  796.                                                 // see https://devblogs.microsoft.com/oldnewthing/20040211-00/?p=40663
  797.                                                 throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('implementsFeature() always returns true'));
  798.                                         }
  799.                                 }
  800.  
  801.                                 // TODO: Maybe as additional plugin-test, we should also check if plugins are allowed to define CSS/JS, i.e. the plugin type is element of OIDplus::INTERACTIVE_PLUGIN_TYPES
  802.                                 $tmp = array_merge(
  803.                                         $manifest->getJSFiles(),
  804.                                         $manifest->getCSSFiles(),
  805.                                         $manifest->getJSFilesSetup(),
  806.                                         $manifest->getCSSFilesSetup()
  807.                                 );
  808.                                 foreach ($tmp as $file) {
  809.                                         if (!file_exists($file)) {
  810.                                                 throw new OIDplusException(_L('Plugin "%1/%2" is erroneous',$plugintype_folder,$pluginname_folder).': '._L('File %1 was defined in manifest, but it is not existing',$file));
  811.                                         }
  812.                                 }
  813.  
  814.                                 // Now we can continue
  815.  
  816.                                 $out[] = $class_name;
  817.                                 if (!is_null($registerCallback)) {
  818.                                         call_user_func($registerCallback, $obj);
  819.  
  820.                                         // Alternative approaches:
  821.                                         //$registerCallback[0]::{$registerCallback[1]}($obj);
  822.                                         // or:
  823.                                         //forward_static_call($registerCallback, $obj);
  824.                                 }
  825.                         }
  826.  
  827.                 }
  828.                 return $out;
  829.         }
  830.  
  831.         # --- Initialization of OIDplus
  832.  
  833.         public static function init($html=true, $keepBaseConfig=true) {
  834.                 self::$html = $html;
  835.  
  836.                 // Reset internal state, so we can re-init verything if required
  837.  
  838.                 if (self::$old_config_format) {
  839.                         // We need to do this, because define() cannot be undone
  840.                         // Note: This can only happen in very special cases (e.g. test cases) where you call init() twice
  841.                         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.'));
  842.                 }
  843.  
  844.                 self::$config = null;
  845.                 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
  846.                 self::$gui = null;
  847.                 self::$authUtils = null;
  848.                 self::$mailUtils = null;
  849.                 self::$menuUtils = null;
  850.                 self::$logger = null;
  851.                 self::$dbMainSession = null;
  852.                 self::$dbIsolatedSession = null;
  853.                 self::$pagePlugins = array();
  854.                 self::$authPlugins = array();
  855.                 self::$loggerPlugins = array();
  856.                 self::$objectTypePlugins = array();
  857.                 self::$enabledObjectTypes = array();
  858.                 self::$disabledObjectTypes = array();
  859.                 self::$dbPlugins = array();
  860.                 self::$captchaPlugins = array();
  861.                 self::$sqlSlangPlugins = array();
  862.                 self::$languagePlugins = array();
  863.                 self::$designPlugins = array();
  864.                 self::$system_id_cache = null;
  865.                 self::$sslAvailableCache = null;
  866.                 self::$translationArray = array();
  867.  
  868.                 // Continue...
  869.  
  870.                 OIDplus::baseConfig(); // this loads the base configuration located in userdata/baseconfig/config.inc.php (once!)
  871.                                        // You can do changes to the configuration afterwards using OIDplus::baseConfig()->...
  872.  
  873.                 // Register database types (highest priority)
  874.  
  875.                 // SQL slangs
  876.  
  877.                 self::registerAllPlugins('sqlSlang', 'OIDplusSqlSlangPlugin', array('OIDplus','registerSqlSlangPlugin'));
  878.                 foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
  879.                         $plugin->init($html);
  880.                 }
  881.  
  882.                 // Database providers
  883.  
  884.                 self::registerAllPlugins('database', 'OIDplusDatabasePlugin', array('OIDplus','registerDatabasePlugin'));
  885.                 foreach (OIDplus::getDatabasePlugins() as $plugin) {
  886.                         $plugin->init($html);
  887.                 }
  888.  
  889.                 // Do redirect stuff etc.
  890.  
  891.                 self::isSslAvailable(); // This function does automatic redirects
  892.  
  893.                 // Construct the configuration manager
  894.  
  895.                 OIDplus::config(); // During the construction, various system settings are prepared if required
  896.  
  897.                 // Initialize public / private keys
  898.  
  899.                 OIDplus::getPkiStatus(true);
  900.  
  901.                 // Register non-DB plugins
  902.  
  903.                 self::registerAllPlugins(array('publicPages', 'raPages', 'adminPages'), 'OIDplusPagePlugin', array('OIDplus','registerPagePlugin'));
  904.                 self::registerAllPlugins('auth', 'OIDplusAuthPlugin', array('OIDplus','registerAuthPlugin'));
  905.                 self::registerAllPlugins('logger', 'OIDplusLoggerPlugin', array('OIDplus','registerLoggerPlugin'));
  906.                 OIDplusLogger::reLogMissing(); // Some previous plugins might have tried to log. Repeat that now.
  907.                 self::registerAllPlugins('objectTypes', 'OIDplusObjectTypePlugin', array('OIDplus','registerObjectTypePlugin'));
  908.                 self::registerAllPlugins('language', 'OIDplusLanguagePlugin', array('OIDplus','registerLanguagePlugin'));
  909.                 self::registerAllPlugins('design', 'OIDplusDesignPlugin', array('OIDplus','registerDesignPlugin'));
  910.                 self::registerAllPlugins('captcha', 'OIDplusCaptchaPlugin', array('OIDplus','registerCaptchaPlugin'));
  911.  
  912.                 // Initialize non-DB plugins
  913.  
  914.                 foreach (OIDplus::getPagePlugins() as $plugin) {
  915.                         $plugin->init($html);
  916.                 }
  917.                 foreach (OIDplus::getAuthPlugins() as $plugin) {
  918.                         $plugin->init($html);
  919.                 }
  920.                 foreach (OIDplus::getLoggerPlugins() as $plugin) {
  921.                         $plugin->init($html);
  922.                 }
  923.                 foreach (OIDplus::getObjectTypePlugins() as $plugin) {
  924.                         $plugin->init($html);
  925.                 }
  926.                 foreach (OIDplus::getLanguagePlugins() as $plugin) {
  927.                         $plugin->init($html);
  928.                 }
  929.                 foreach (OIDplus::getDesignPlugins() as $plugin) {
  930.                         $plugin->init($html);
  931.                 }
  932.                 foreach (OIDplus::getCaptchaPlugins() as $plugin) {
  933.                         $plugin->init($html);
  934.                 }
  935.  
  936.                 if (PHP_SAPI != 'cli') {
  937.  
  938.                         // Prepare some security related response headers (default values)
  939.  
  940.                         $content_language =
  941.                                 strtolower(substr(OIDplus::getCurrentLang(),0,2)) . '-' .
  942.                                 strtoupper(substr(OIDplus::getCurrentLang(),2,2)); // e.g. 'en-US'
  943.  
  944.                         $http_headers = array(
  945.                                 "X-Content-Type-Options" => "nosniff",
  946.                                 "X-XSS-Protection" => "1; mode=block",
  947.                                 "X-Frame-Options" => "SAMEORIGIN",
  948.                                 "Referrer-Policy" => array(
  949.                                         "no-referrer-when-downgrade"
  950.                                 ),
  951.                                 "Cache-Control" => array(
  952.                                         "no-cache",
  953.                                         "no-store",
  954.                                         "must-revalidate"
  955.                                 ),
  956.                                 "Pragma" => "no-cache",
  957.                                 "Content-Language" => $content_language,
  958.                                 "Expires" => "0",
  959.                                 "Content-Security-Policy" => array(
  960.                                         "default-src" => array(
  961.                                                 "'self'",
  962.                                                 "blob:",
  963.                                                 "https://fonts.gstatic.com",
  964.                                                 "https://www.google.com/",
  965.                                                 "https://www.gstatic.com/",
  966.                                                 "https://cdnjs.cloudflare.com/"
  967.                                         ),
  968.                                         "style-src" => array(
  969.                                                 "'self'",
  970.                                                 "'unsafe-inline'",
  971.                                                 "https://cdnjs.cloudflare.com/"
  972.                                         ),
  973.                                         "img-src" => array(
  974.                                                "blob:",
  975.                                                 "data:",
  976.                                                 "http:",
  977.                                                 "https:"
  978.                                         ),
  979.                                         "script-src" => array(
  980.                                                 "'self'",
  981.                                                 "'unsafe-inline'",
  982.                                                 "'unsafe-eval'",
  983.                                                 "blob:",
  984.                                                 "https://www.google.com/",
  985.                                                 "https://www.gstatic.com/",
  986.                                                 "https://cdnjs.cloudflare.com/",
  987.                                                 "https://polyfill.io/"
  988.                                         ),
  989.                                         "frame-ancestors" => array(
  990.                                                "'none'"
  991.                                         ),
  992.                                         "object-src" => array(
  993.                                                "'none'"
  994.                                         )
  995.                                 )
  996.                         );
  997.  
  998.                         // Give plugins the opportunity to manipulate/extend the headers
  999.  
  1000.                         foreach (OIDplus::getSqlSlangPlugins() as $plugin) {
  1001.                                 $plugin->httpHeaderCheck($http_headers);
  1002.                         }
  1003.                         foreach (OIDplus::getDatabasePlugins() as $plugin) {
  1004.                                 $plugin->httpHeaderCheck($http_headers);
  1005.                         }
  1006.                         foreach (OIDplus::getPagePlugins() as $plugin) {
  1007.                                 $plugin->httpHeaderCheck($http_headers);
  1008.                         }
  1009.                         foreach (OIDplus::getAuthPlugins() as $plugin) {
  1010.                                 $plugin->httpHeaderCheck($http_headers);
  1011.                         }
  1012.                         foreach (OIDplus::getLoggerPlugins() as $plugin) {
  1013.                                 $plugin->httpHeaderCheck($http_headers);
  1014.                         }
  1015.                         foreach (OIDplus::getObjectTypePlugins() as $plugin) {
  1016.                                 $plugin->httpHeaderCheck($http_headers);
  1017.                         }
  1018.                         foreach (OIDplus::getLanguagePlugins() as $plugin) {
  1019.                                 $plugin->httpHeaderCheck($http_headers);
  1020.                         }
  1021.                         foreach (OIDplus::getDesignPlugins() as $plugin) {
  1022.                                 $plugin->httpHeaderCheck($http_headers);
  1023.                         }
  1024.                         foreach (OIDplus::getCaptchaPlugins() as $plugin) {
  1025.                                 $plugin->httpHeaderCheck($http_headers);
  1026.                         }
  1027.  
  1028.                         // Prepare to send the headers to the client
  1029.                         // The headers are sent automatically when the first output comes or the script ends
  1030.  
  1031.                         foreach ($http_headers as $name => $val) {
  1032.  
  1033.                                 // Plugins can remove standard OIDplus headers by setting the value to null.
  1034.                                 if (is_null($val)) continue; /** @phpstan-ignore-line */
  1035.  
  1036.                                 // Some headers can be written as arrays to make it easier for plugin authors
  1037.                                 // to manipulate/extend the contents.
  1038.                                 if (is_array($val)) {
  1039.                                         if ((strtolower($name) == 'cache-control') ||
  1040.                                             (strtolower($name) == 'referrer-policy'))
  1041.                                         {
  1042.                                                 if (count($val) == 0) continue;
  1043.                                                 $val = implode(', ', $val);
  1044.                                         } else if (strtolower($name) == 'content-security-policy') {
  1045.                                                 if (count($val) == 0) continue;
  1046.                                                 foreach ($val as $tmp1 => &$tmp2) {
  1047.                                                         $tmp2 = array_unique($tmp2);
  1048.                                                         $tmp2 = $tmp1.' '.implode(' ', $tmp2);
  1049.                                                 }
  1050.                                                 $val = implode('; ', $val);
  1051.                                         } else {
  1052.                                                 throw new OIDplusException(_L('HTTP header "%1" cannot be written as array. A newly installed plugin is probably misusing the method "%2".',$name,'httpHeaderCheck'));
  1053.                                         }
  1054.                                 }
  1055.  
  1056.                                 if (is_string($val)) {
  1057.                                         header("$name: $val");
  1058.                                 }
  1059.                         }
  1060.  
  1061.                 } // endif (PHP_SAPI != 'cli')
  1062.  
  1063.                 // Initialize other stuff (i.e. things which require the logger!)
  1064.  
  1065.                 OIDplus::recognizeSystemUrl(); // Make sure "last_known_system_url" is set
  1066.                 OIDplus::recognizeVersion(); // Make sure "last_known_version" is set and a log entry is created
  1067.         }
  1068.  
  1069.         # --- System URL, System ID, PKI, and other functions
  1070.  
  1071.         private static function recognizeSystemUrl() {
  1072.                 try {
  1073.                         $url = OIDplus::webpath(null,self::PATH_ABSOLUTE_CANONICAL); // TODO: canonical or not?
  1074.                         OIDplus::config()->setValue('last_known_system_url', $url);
  1075.                 } catch (Exception $e) {
  1076.                 }
  1077.         }
  1078.  
  1079.         private static function getExecutingScriptPathDepth() {
  1080.                 if (PHP_SAPI == 'cli') {
  1081.                         global $argv;
  1082.                         $test_dir = dirname(realpath($argv[0]));
  1083.                 } else {
  1084.                         if (!isset($_SERVER["SCRIPT_FILENAME"])) return false;
  1085.                         $test_dir = dirname($_SERVER['SCRIPT_FILENAME']);
  1086.                 }
  1087.                 $test_dir = str_replace('\\', '/', $test_dir);
  1088.                 $steps_up = 0;
  1089.                 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!
  1090.                         $test_dir = dirname($test_dir);
  1091.                         $steps_up++;
  1092.                         if ($steps_up == 1000) return false; // to make sure there will never be an infinite loop
  1093.                 }
  1094.                 return $steps_up;
  1095.         }
  1096.  
  1097.         public static function isSSL() {
  1098.                 return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on');
  1099.         }
  1100.  
  1101.         /**
  1102.          * Returns the URL of the system.
  1103.          * @param int $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
  1104.          *                  PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
  1105.          *                  results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
  1106.          *                  but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
  1107.          * @return string|false The URL, with guaranteed trailing path delimiter for directories
  1108.          */
  1109.         private static function getSystemUrl($mode) {
  1110.                 if ($mode === self::PATH_RELATIVE) {
  1111.                         $steps_up = self::getExecutingScriptPathDepth();
  1112.                         if ($steps_up === false) {
  1113.                                 return false;
  1114.                         } else {
  1115.                                 return str_repeat('../', $steps_up);
  1116.                         }
  1117.                 } else {
  1118.                         if ($mode === self::PATH_ABSOLUTE_CANONICAL) {
  1119.                                 $tmp = OIDplus::baseConfig()->getValue('CANONICAL_SYSTEM_URL', '');
  1120.                                 if ($tmp) {
  1121.                                         return rtrim($tmp,'/').'/';
  1122.                                 }
  1123.                         }
  1124.  
  1125.                         if (PHP_SAPI == 'cli') {
  1126.                                 try {
  1127.                                         return OIDplus::config()->getValue('last_known_system_url', false);
  1128.                                 } catch (Exception $e) {
  1129.                                         return false;
  1130.                                 }
  1131.                         } else {
  1132.                                 // First, try to find out how many levels we need to go up
  1133.                                 $steps_up = self::getExecutingScriptPathDepth();
  1134.  
  1135.                                 // Then go up these amount of levels, based on SCRIPT_NAME/argv[0]
  1136.                                 $res = dirname($_SERVER['SCRIPT_NAME'].'index.php'); // This fake 'index.php' ensures that SCRIPT_NAME does not end with '/', which would make dirname() fail
  1137.                                 for ($i=0; $i<$steps_up; $i++) {
  1138.                                         $res = dirname($res);
  1139.                                 }
  1140.                                 $res = str_replace('\\', '/', $res);
  1141.                                 if ($res == '/') $res = '';
  1142.  
  1143.                                 // Add protocol and hostname
  1144.                                 $is_ssl = self::isSSL();
  1145.                                 $protocol = $is_ssl ? 'https' : 'http'; // do not translate
  1146.                                 $host = $_SERVER['HTTP_HOST']; // includes port if it is not 80/443
  1147.  
  1148.                                 return $protocol.'://'.$host.$res.'/';
  1149.                         }
  1150.                 }
  1151.         }
  1152.  
  1153.         private static function getSystemIdFromPubKey($pubKey) {
  1154.                 $m = array();
  1155.                 if (preg_match('@BEGIN PUBLIC KEY\-+(.+)\-+END PUBLIC KEY@ismU', $pubKey, $m)) {
  1156.                         return smallhash(base64_decode($m[1]));
  1157.                 }
  1158.                 return false;
  1159.         }
  1160.  
  1161.         private static $system_id_cache = null;
  1162.         public static function getSystemId($oid=false) {
  1163.                 if (!is_null(self::$system_id_cache)) {
  1164.                         $out = self::$system_id_cache;
  1165.                 } else {
  1166.                         $out = false;
  1167.  
  1168.                         if (self::getPkiStatus(true)) {
  1169.                                 $pubKey = OIDplus::getSystemPublicKey();
  1170.                                 $out = self::getSystemIdFromPubKey($pubKey);
  1171.                         }
  1172.                         self::$system_id_cache = $out;
  1173.                 }
  1174.                 if (!$out) return false;
  1175.                 return ($oid ? '1.3.6.1.4.1.37476.30.9.' : '').$out;
  1176.         }
  1177.  
  1178.         public static function getOpenSslCnf() {
  1179.                 // The following functions need a config file, otherway they don't work
  1180.                 // - openssl_csr_new
  1181.                 // - openssl_csr_sign
  1182.                 // - openssl_pkey_export
  1183.                 // - openssl_pkey_export_to_file
  1184.                 // - openssl_pkey_new
  1185.                 $tmp = @getenv('OPENSSL_CONF');
  1186.                 if ($tmp && file_exists($tmp)) return $tmp;
  1187.  
  1188.                 // OpenSSL in XAMPP does not work OOBE, since the OPENSSL_CONF is
  1189.                 // C:/xampp/apache/bin/openssl.cnf and not C:/xampp/apache/conf/openssl.cnf
  1190.                 // Bug reports are more than 10 years old and nobody cares...
  1191.                 // Use our own config file
  1192.                 return __DIR__.'/../../vendor/phpseclib/phpseclib/phpseclib/openssl.cnf';
  1193.         }
  1194.  
  1195.         private static function getPrivKeyPassphraseFilename() {
  1196.                 return OIDplus::localpath() . 'userdata/privkey_secret.php';
  1197.         }
  1198.  
  1199.         private static function tryCreatePrivKeyPassphrase() {
  1200.                 $file = self::getPrivKeyPassphraseFilename();
  1201.  
  1202.                 $passphrase = generateRandomString(64);
  1203.                 $cont = "<?php\n";
  1204.                 $cont .= "// ATTENTION! This file was automatically generated by OIDplus to encrypt the private key\n";
  1205.                 $cont .= "// that is located in your database configuration table. DO NOT ALTER OR DELETE THIS FILE,\n";
  1206.                 $cont .= "// otherwise you will lose your OIDplus System-ID and all services connected with it!\n";
  1207.                 $cont .= "// If multiple systems access the same database, then this file must be synchronous\n";
  1208.                 $cont .= "// between all systems, otherwise you will lose your system ID, too!\n";
  1209.                 $cont .= "\$passphrase = '$passphrase';\n";
  1210.                 $cont .= "// End of file\n";
  1211.  
  1212.                 @file_put_contents($file, $cont);
  1213.         }
  1214.  
  1215.         private static function getPrivKeyPassphrase() {
  1216.                 $file = self::getPrivKeyPassphraseFilename();
  1217.                 if (!file_exists($file)) return false;
  1218.                 $cont = file_get_contents($file);
  1219.                 $m = array();
  1220.                 if (!preg_match("@'(.+)'@isU", $cont, $m)) return false;
  1221.                 return $m[1];
  1222.         }
  1223.  
  1224.         public static function getSystemPrivateKey() {
  1225.                 $privKey = OIDplus::config()->getValue('oidplus_private_key');
  1226.                 if ($privKey == '') return false;
  1227.  
  1228.                 $passphrase = self::getPrivKeyPassphrase();
  1229.                 if ($passphrase !== false) {
  1230.                         $privKey = decrypt_private_key($privKey, $passphrase);
  1231.                 }
  1232.  
  1233.                 if (is_privatekey_encrypted($privKey)) {
  1234.                         // This can happen if the key file has vanished
  1235.                         return false;
  1236.                 }
  1237.  
  1238.                 return $privKey;
  1239.         }
  1240.  
  1241.         public static function getSystemPublicKey() {
  1242.                 $pubKey = OIDplus::config()->getValue('oidplus_public_key');
  1243.                 if ($pubKey == '') return false;
  1244.                 return $pubKey;
  1245.         }
  1246.  
  1247.         public static function getPkiStatus($try_generate=false) {
  1248.                 if (!function_exists('openssl_pkey_new')) return false;
  1249.  
  1250.                 if ($try_generate) {
  1251.                         // For debug purposes: Invalidate current key once:
  1252.                         //OIDplus::config()->setValue('oidplus_private_key', '');
  1253.  
  1254.                         $privKey = OIDplus::getSystemPrivateKey();
  1255.                         $pubKey = OIDplus::getSystemPublicKey();
  1256.                         if (!verify_private_public_key($privKey, $pubKey)) {
  1257.                                 if ($pubKey) {
  1258.                                         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.");
  1259.                                 }
  1260.  
  1261.                                 $pkey_config = array(
  1262.                                     "digest_alg" => "sha512",
  1263.                                     "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
  1264.                                     "private_key_type" => OPENSSL_KEYTYPE_RSA,
  1265.                                     "config" => OIDplus::getOpenSslCnf()
  1266.                                 );
  1267.  
  1268.                                 // Create the private and public key
  1269.                                 $res = openssl_pkey_new($pkey_config);
  1270.                                 if ($res === false) return false;
  1271.  
  1272.                                 // Extract the private key from $res to $privKey
  1273.                                 if (openssl_pkey_export($res, $privKey, null, $pkey_config) === false) return false;
  1274.  
  1275.                                 // Extract the public key from $res to $pubKey
  1276.                                 $tmp = openssl_pkey_get_details($res);
  1277.                                 if ($tmp === false) return false;
  1278.                                 $pubKey = $tmp["key"];
  1279.  
  1280.                                 // encrypt new keys using a passphrase stored in a secret file
  1281.                                 self::tryCreatePrivKeyPassphrase(); // *try* (re)generate this file
  1282.                                 $passphrase = self::getPrivKeyPassphrase();
  1283.                                 if ($passphrase !== false) {
  1284.                                         $privKey = encrypt_private_key($privKey, $passphrase);
  1285.                                 }
  1286.  
  1287.                                 // Calculate the system ID from the public key
  1288.                                 $system_id = self::getSystemIdFromPubKey($pubKey);
  1289.                                 if ($system_id !== false) {
  1290.                                         // Save the key pair to database
  1291.                                         OIDplus::config()->setValue('oidplus_private_key', $privKey);
  1292.                                         OIDplus::config()->setValue('oidplus_public_key', $pubKey);
  1293.  
  1294.                                         // Log the new system ID
  1295.                                         OIDplus::logger()->log("[INFO]A!", "A new private/public key-pair for your system had been generated. Your SystemID is now $system_id");
  1296.                                 }
  1297.                         } else {
  1298.                                 $passphrase = self::getPrivKeyPassphrase();
  1299.                                 $rawPrivKey = OIDplus::config()->getValue('oidplus_private_key');
  1300.                                 if (($passphrase === false) || !is_privatekey_encrypted($rawPrivKey)) {
  1301.                                         // Upgrade to new encrypted keys
  1302.                                         self::tryCreatePrivKeyPassphrase(); // *try* generate this file
  1303.                                         $passphrase = self::getPrivKeyPassphrase();
  1304.                                         if ($passphrase !== false) {
  1305.                                                 $privKey = encrypt_private_key($privKey, $passphrase);
  1306.                                                 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());
  1307.                                                 OIDplus::config()->setValue('oidplus_private_key', $privKey);
  1308.                                         }
  1309.                                 }
  1310.                         }
  1311.                 }
  1312.  
  1313.                 $privKey = OIDplus::getSystemPrivateKey();
  1314.                 $pubKey = OIDplus::getSystemPublicKey();
  1315.                 return verify_private_public_key($privKey, $pubKey);
  1316.         }
  1317.  
  1318.         public static function getInstallType() {
  1319.                 $counter = 0;
  1320.  
  1321.                 if ($new_version_file_exists = file_exists(OIDplus::localpath().'.version.php')) {
  1322.                         $counter++;
  1323.                 }
  1324.                 if ($old_version_file_exists = file_exists(OIDplus::localpath().'oidplus_version.txt')) {
  1325.                         $counter++;
  1326.                 }
  1327.                 $version_file_exists = $old_version_file_exists | $new_version_file_exists;
  1328.                 if ($svn_dir_exists = (is_dir(OIDplus::localpath().'.svn') ||
  1329.                                        is_dir(OIDplus::localpath().'../.svn'))) { // in case we checked out the root instead of the "trunk"
  1330.                         $counter++;
  1331.                 }
  1332.                 // if ($git_dir_exists = is_dir(OIDplus::localpath().'.git')) {
  1333.                 if ($git_dir_exists = (OIDplus::findGitFolder() !== false)) {
  1334.                         $counter++;
  1335.                 }
  1336.  
  1337.                 if ($counter === 0) {
  1338.                         return 'unknown'; // do not translate
  1339.                 }
  1340.                 else if ($counter > 1) {
  1341.                         return 'ambigous'; // do not translate
  1342.                 }
  1343.                 else if ($svn_dir_exists) {
  1344.                         return 'svn-wc'; // do not translate
  1345.                 }
  1346.                 else if ($git_dir_exists) {
  1347.                         return 'git-wc'; // do not translate
  1348.                 }
  1349.                 else if ($version_file_exists) {
  1350.                         return 'svn-snapshot'; // do not translate
  1351.                 }
  1352.         }
  1353.  
  1354.         private static function recognizeVersion() {
  1355.                 try {
  1356.                         $ver_prev = OIDplus::config()->getValue("last_known_version");
  1357.                         $ver_now = OIDplus::getVersion();
  1358.                         if (($ver_now != '') && ($ver_prev != '') && ($ver_now != $ver_prev)) {
  1359.                                 // TODO: Problem: When the system was updated using SVN, then the IP address of the next random visitor of the website is logged!
  1360.                                 OIDplus::logger()->log("[INFO]A!", "System version changed from '$ver_prev' to '$ver_now'");
  1361.  
  1362.                                 // Just to be sure, recanonize objects (we don't do it at every page visit due to performance reasons)
  1363.                                 self::recanonizeObjects();
  1364.                         }
  1365.                         OIDplus::config()->setValue("last_known_version", $ver_now);
  1366.                 } catch (Exception $e) {
  1367.                 }
  1368.         }
  1369.  
  1370.         public static function getVersion() {
  1371.                 static $cachedVersion = null;
  1372.                 if (!is_null($cachedVersion)) {
  1373.                         return $cachedVersion;
  1374.                 }
  1375.  
  1376.                 $installType = OIDplus::getInstallType();
  1377.  
  1378.                 if ($installType === 'svn-wc') {
  1379.                         $ver = get_svn_revision(OIDplus::localpath());
  1380.                         if ($ver)
  1381.                                 return ($cachedVersion = 'svn-'.$ver);
  1382.                         $ver = get_svn_revision(OIDplus::localpath().'../'); // in case we checked out the root instead of the "trunk"
  1383.                         if ($ver)
  1384.                                 return ($cachedVersion = 'svn-'.$ver);
  1385.                 }
  1386.  
  1387.                 if ($installType === 'git-wc') {
  1388.                         $ver = OIDplus::getGitsvnRevision(OIDplus::localpath());
  1389.                         if ($ver)
  1390.                                 return ($cachedVersion = 'svn-'.$ver);
  1391.                 }
  1392.  
  1393.                 if ($installType === 'svn-snapshot') {
  1394.                         $cont = '';
  1395.                         if (file_exists($filename = OIDplus::localpath().'oidplus_version.txt'))
  1396.                                 $cont = file_get_contents($filename);
  1397.                         if (file_exists($filename = OIDplus::localpath().'.version.php'))
  1398.                                 $cont = file_get_contents($filename);
  1399.                         $m = array();
  1400.                         if (preg_match('@Revision (\d+)@', $cont, $m)) // do not translate
  1401.                                 return ($cachedVersion = 'svn-'.$m[1]); // do not translate
  1402.                 }
  1403.  
  1404.                 return ($cachedVersion = false); // version ambigous or unknown
  1405.         }
  1406.  
  1407.         const ENFORCE_SSL_NO   = 0;
  1408.         const ENFORCE_SSL_YES  = 1;
  1409.         const ENFORCE_SSL_AUTO = 2;
  1410.         private static $sslAvailableCache = null;
  1411.         public static function isSslAvailable() {
  1412.                 if (!is_null(self::$sslAvailableCache)) return self::$sslAvailableCache;
  1413.  
  1414.                 if (PHP_SAPI == 'cli') {
  1415.                         self::$sslAvailableCache = false;
  1416.                         return false;
  1417.                 }
  1418.  
  1419.                 $timeout = 2;
  1420.                 $already_ssl = self::isSSL();
  1421.                 $ssl_port = 443;
  1422.  
  1423.                 if ($already_ssl) {
  1424.                         OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false, null, true/*forceInsecure*/);
  1425.                         self::$sslAvailableCache = true;
  1426.                         return true;
  1427.                 } else {
  1428.                         if (isset($_COOKIE['SSL_CHECK']) && ($_COOKIE['SSL_CHECK'] == '1')) {
  1429.                                 // The cookie "SSL_CHECK" is set once a website was loaded with HTTPS.
  1430.                                 // It forces subsequent HTTP calls to redirect to HTTPS (like HSTS).
  1431.                                 // The reason is the following problem:
  1432.                                 // If you open the page with HTTPS first, then the CSRF token cookies will get the "secure" flag
  1433.                                 // If you open the page then with HTTP, the HTTP cannot access the secure CSRF cookies,
  1434.                                 // Chrome will then block "Set-Cookie" since the HTTP cookie would overwrite the HTTPS cookie.
  1435.                                 // Note: SSL_CHECK is NOT a replacement for HSTS! You should use HSTS,
  1436.                                 // because on there your browser ensures that HTTPS is called, before the server
  1437.                                 // is even contacted (and therefore, no HTTP connection can be hacked).
  1438.                                 $mode = OIDplus::ENFORCE_SSL_YES;
  1439.                         } else {
  1440.                                 $mode = OIDplus::baseConfig()->getValue('ENFORCE_SSL', OIDplus::ENFORCE_SSL_AUTO);
  1441.                         }
  1442.  
  1443.                         if ($mode == OIDplus::ENFORCE_SSL_NO) {
  1444.                                 // No SSL available
  1445.                                 self::$sslAvailableCache = false;
  1446.                                 return false;
  1447.                         } else if ($mode == OIDplus::ENFORCE_SSL_YES) {
  1448.                                 // Force SSL
  1449.                                 $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
  1450.                                 header('Location:'.$location);
  1451.                                 die(_L('Redirecting to HTTPS...'));
  1452.                         } else if ($mode == OIDplus::ENFORCE_SSL_AUTO) {
  1453.                                 // Automatic SSL detection
  1454.                                 if (isset($_COOKIE['SSL_CHECK'])) {
  1455.                                         // We already had the HTTPS detection done before.
  1456.                                         if ($_COOKIE['SSL_CHECK'] == '1') {
  1457.                                                 // HTTPS was detected before, but we are HTTP. Redirect now
  1458.                                                 $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
  1459.                                                 header('Location:'.$location);
  1460.                                                 die(_L('Redirecting to HTTPS...'));
  1461.                                         } else {
  1462.                                                 // No HTTPS available. Do nothing.
  1463.                                                 self::$sslAvailableCache = false;
  1464.                                                 return false;
  1465.                                         }
  1466.                                 } else {
  1467.                                         // This is our first check (or the browser didn't accept the SSL_CHECK cookie)
  1468.                                         $errno = -1;
  1469.                                         $errstr = '';
  1470.                                         if (@fsockopen($_SERVER['HTTP_HOST'], $ssl_port, $errno, $errstr, $timeout)) {
  1471.                                                 // HTTPS detected. Redirect now, and remember that we had detected HTTPS
  1472.                                                 OIDplus::cookieUtils()->setcookie('SSL_CHECK', '1', 0, false, null, true/*forceInsecure*/);
  1473.                                                 $location = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
  1474.                                                 header('Location:'.$location);
  1475.                                                 die(_L('Redirecting to HTTPS...'));
  1476.                                         } else {
  1477.                                                 // No HTTPS detected. Do nothing, and next time, don't try to detect HTTPS again.
  1478.                                                 OIDplus::cookieUtils()->setcookie('SSL_CHECK', '0', 0, false, null, true/*forceInsecure*/);
  1479.                                                 self::$sslAvailableCache = false;
  1480.                                                 return false;
  1481.                                         }
  1482.                                 }
  1483.                         }
  1484.                 }
  1485.         }
  1486.  
  1487.         /**
  1488.          * Gets a local path pointing to a resource
  1489.          * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
  1490.          * @param boolean $relative If true, the returning path is relative to the currently executed PHP file (not the CLI working directory)
  1491.          * @return string|false The local path, with guaranteed trailing path delimiter for directories
  1492.          */
  1493.         public static function localpath($target=null, $relative=false) {
  1494.                 if (is_null($target)) {
  1495.                         $target = __DIR__.'/../../';
  1496.                 }
  1497.  
  1498.                 if ($relative) {
  1499.                         // First, try to find out how many levels we need to go up
  1500.                         $steps_up = self::getExecutingScriptPathDepth();
  1501.                         if ($steps_up === false) return false;
  1502.  
  1503.                         // Virtually go back from the executing PHP script to the OIDplus base path
  1504.                         $res = str_repeat('../',$steps_up);
  1505.  
  1506.                         // Then go to the desired location
  1507.                         $basedir = realpath(__DIR__.'/../../');
  1508.                         $target = realpath($target);
  1509.                         if ($target === false) return false;
  1510.                         $res .= substr($target, strlen($basedir)+1);
  1511.                         $res = rtrim($res,'/'); // avoid '..//' for localpath(null,true)
  1512.                 } else {
  1513.                         $res = realpath($target);
  1514.                 }
  1515.  
  1516.                 if (is_dir($target)) $res .= '/';
  1517.  
  1518.                 $res = str_replace('/', DIRECTORY_SEPARATOR, $res);
  1519.  
  1520.                 return $res;
  1521.         }
  1522.  
  1523.         /**
  1524.          * Gets a URL pointing to a resource
  1525.          * @param string $target Target resource (file or directory must exist), or null to get the OIDplus base directory
  1526.          * @param int|boolean $mode If true or OIDplus::PATH_RELATIVE, the returning path is relative to the currently executed
  1527.          *                          PHP script (i.e. index.php , not the plugin PHP script!). False or OIDplus::PATH_ABSOLUTE is
  1528.          *                          results in an absolute URL. OIDplus::PATH_ABSOLUTE_CANONICAL is an absolute URL,
  1529.          *                          but a canonical path (set by base config setting CANONICAL_SYSTEM_URL) is preferred.
  1530.          * @return string|false The URL, with guaranteed trailing path delimiter for directories
  1531.          */
  1532.         public static function webpath($target=null, $mode=self::PATH_ABSOLUTE_CANONICAL) {
  1533.                 // backwards compatibility
  1534.                 if ($mode === true) $mode = self::PATH_RELATIVE;
  1535.                 if ($mode === false) $mode = self::PATH_ABSOLUTE;
  1536.  
  1537.                 if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT) {
  1538.                         $tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE);
  1539.                         if ($tmp === false) return false;
  1540.                         $tmp = parse_url($tmp);
  1541.                         if ($tmp === false) return false;
  1542.                         if (!isset($tmp['path'])) return false;
  1543.                         return $tmp['path'];
  1544.                 }
  1545.  
  1546.                 if ($mode == OIDplus::PATH_RELATIVE_TO_ROOT_CANONICAL) {
  1547.                         $tmp = OIDplus::webpath($target,OIDplus::PATH_ABSOLUTE_CANONICAL);
  1548.                         if ($tmp === false) return false;
  1549.                         $tmp = parse_url($tmp);
  1550.                         if ($tmp === false) return false;
  1551.                         if (!isset($tmp['path'])) return false;
  1552.                         return $tmp['path'];
  1553.                 }
  1554.  
  1555.                 $res = self::getSystemUrl($mode); // Note: already contains a trailing path delimiter
  1556.                 if ($res === false) return false;
  1557.  
  1558.                 if (!is_null($target)) {
  1559.                         $basedir = realpath(__DIR__.'/../../');
  1560.                         $target = realpath($target);
  1561.                         if ($target === false) return false;
  1562.                         $tmp = substr($target, strlen($basedir)+1);
  1563.                         $res .= str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
  1564.                         if (is_dir($target)) $res .= '/';
  1565.                 }
  1566.  
  1567.                 return $res;
  1568.         }
  1569.  
  1570.         public static function canonicalURL() {
  1571.                 // First part: OIDplus system URL (or canonical system URL)
  1572.                 $sysurl = OIDplus::getSystemUrl(self::PATH_ABSOLUTE_CANONICAL);
  1573.  
  1574.                 // Second part: Directory
  1575.                 $basedir = realpath(__DIR__.'/../../');
  1576.                 $target = realpath('.');
  1577.                 if ($target === false) return false;
  1578.                 $tmp = substr($target, strlen($basedir)+1);
  1579.                 $res = str_replace(DIRECTORY_SEPARATOR,'/',$tmp); // remove OS specific path delimiters introduced by realpath()
  1580.                 if (is_dir($target) && ($res != '')) $res .= '/';
  1581.  
  1582.                 // Third part: File name
  1583.                 $tmp = explode('/',$_SERVER['SCRIPT_NAME']);
  1584.                 $tmp = end($tmp);
  1585.  
  1586.                 // Fourth part: Query string (ordered)
  1587.                 $tmp2 = getSortedQuery();
  1588.                 if ($tmp2 != '') $tmp2 = '?'.$tmp2;
  1589.  
  1590.                 return $sysurl.$res.$tmp.$tmp2;
  1591.         }
  1592.  
  1593.         private static $shutdown_functions = array();
  1594.         public static function register_shutdown_function($func) {
  1595.                 self::$shutdown_functions[] = $func;
  1596.         }
  1597.  
  1598.         public static function invoke_shutdown() {
  1599.                 foreach (self::$shutdown_functions as $func) {
  1600.                         $func();
  1601.                 }
  1602.         }
  1603.  
  1604.         public static function getAvailableLangs() {
  1605.                 $langs = array();
  1606.                 foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
  1607.                         $code = $pluginManifest->getLanguageCode();
  1608.                         $langs[] = $code;
  1609.                 }
  1610.                 return $langs;
  1611.         }
  1612.  
  1613.         public static function getCurrentLang() {
  1614.                 if (isset($_GET['lang'])) {
  1615.                         $lang = $_GET['lang'];
  1616.                 } else if (isset($_POST['lang'])) {
  1617.                         $lang = $_POST['lang'];
  1618.                 } else if (isset($_COOKIE['LANGUAGE'])) {
  1619.                         $lang = $_COOKIE['LANGUAGE'];
  1620.                 } else {
  1621.                         $lang = self::DEFAULT_LANGUAGE;
  1622.                 }
  1623.                 $lang = substr(preg_replace('@[^a-z]@ismU', '', $lang),0,4); // sanitize
  1624.                 return $lang;
  1625.         }
  1626.  
  1627.         public static function handleLangArgument() {
  1628.                 if (isset($_GET['lang'])) {
  1629.                         // The "?lang=" argument is only for NoScript-Browsers/SearchEngines
  1630.                         // In case someone who has JavaScript clicks a ?lang= link, they should get
  1631.                         // the page in that language, but the cookie must be set, otherwise
  1632.                         // the menu and other stuff would be in their cookie-based-language and not the
  1633.                         // argument-based-language.
  1634.                         OIDplus::cookieUtils()->setcookie('LANGUAGE', $_GET['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
  1635.                 } else if (isset($_POST['lang'])) {
  1636.                         OIDplus::cookieUtils()->setcookie('LANGUAGE', $_POST['lang'], 0, true/*HttpOnly off, because JavaScript also needs translation*/);
  1637.                 }
  1638.         }
  1639.  
  1640.         private static $translationArray = array();
  1641.         protected static function getTranslationFileContents($translation_file) {
  1642.                 // First, try the cache
  1643.                 $cache_file = __DIR__ . '/../../userdata/cache/translation_'.md5($translation_file).'.ser';
  1644.                 if (file_exists($cache_file) && (filemtime($cache_file) == filemtime($translation_file))) {
  1645.                         $cac = @unserialize(file_get_contents($cache_file));
  1646.                         if ($cac) return $cac;
  1647.                 }
  1648.  
  1649.                 // If not successful, then load the XML file
  1650.                 $xml = @simplexml_load_string(file_get_contents($translation_file));
  1651.                 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
  1652.                 $cac = array();
  1653.                 foreach ($xml->message as $msg) {
  1654.                         $src = trim($msg->source->__toString());
  1655.                         $dst = trim($msg->target->__toString());
  1656.                         $cac[$src] = $dst;
  1657.                 }
  1658.                 @file_put_contents($cache_file,serialize($cac));
  1659.                 @touch($cache_file,filemtime($translation_file));
  1660.                 return $cac;
  1661.         }
  1662.         public static function getTranslationArray($requested_lang='*') {
  1663.                 foreach (OIDplus::getAllPluginManifests('language') as $pluginManifest) {
  1664.                         $lang = $pluginManifest->getLanguageCode();
  1665.                         if (strpos($lang,'/') !== false) continue; // just to be sure
  1666.                         if (strpos($lang,'\\') !== false) continue; // just to be sure
  1667.                         if (strpos($lang,'..') !== false) continue; // just to be sure
  1668.  
  1669.                         if (($requested_lang != '*') && ($lang != $requested_lang)) continue;
  1670.  
  1671.                         if (!isset(self::$translationArray[$lang])) {
  1672.                                 self::$translationArray[$lang] = array();
  1673.  
  1674.                                 $wildcard = $pluginManifest->getLanguageMessages();
  1675.                                 if (strpos($wildcard,'/') !== false) continue; // just to be sure
  1676.                                 if (strpos($wildcard,'\\') !== false) continue; // just to be sure
  1677.                                 if (strpos($wildcard,'..') !== false) continue; // just to be sure
  1678.  
  1679.                                 $translation_files = glob(__DIR__.'/../../plugins/'.'*'.'/language/'.$lang.'/'.$wildcard);
  1680.                                 sort($translation_files);
  1681.                                 foreach ($translation_files as $translation_file) {
  1682.                                         if (!file_exists($translation_file)) continue;
  1683.                                         $cac = self::getTranslationFileContents($translation_file);
  1684.                                         foreach ($cac as $src => $dst) {
  1685.                                                 self::$translationArray[$lang][$src] = $dst;
  1686.                                         }
  1687.                                 }
  1688.                         }
  1689.                 }
  1690.                 return self::$translationArray;
  1691.         }
  1692.  
  1693.         public static function getEditionInfo() {
  1694.                 return @parse_ini_file(__DIR__.'/../edition.ini', true)['Edition'];
  1695.         }
  1696.  
  1697.         public static function findGitFolder() {
  1698.                 // Git command line saves git information in folder ".git"
  1699.                 // Plesk git saves git information in folder "../../../git/oidplus/" (or similar)
  1700.                 $dir = OIDplus::localpath();
  1701.                 if (is_dir($dir.'/.git')) return $dir.'/.git';
  1702.                 $i = 0;
  1703.                 do {
  1704.                         if (is_dir($dir.'/git')) {
  1705.                                 $confs = @glob($dir.'/git/'.'*'.'/config');
  1706.                                 if ($confs) foreach ($confs as $conf) {
  1707.                                         $cont = file_get_contents($conf);
  1708.                                         if (isset(OIDplus::getEditionInfo()['gitrepo']) && (OIDplus::getEditionInfo()['gitrepo'] != '') && (strpos($cont, OIDplus::getEditionInfo()['gitrepo']) !== false)) {
  1709.                                                 return dirname($conf);
  1710.                                         }
  1711.                                 }
  1712.                         }
  1713.                         $i++;
  1714.                 } while (($i<100) && ($dir != ($new_dir = @realpath($dir.'/../'))) && ($dir = $new_dir));
  1715.                 return false;
  1716.         }
  1717.  
  1718.         public static function getGitsvnRevision($dir='') {
  1719.                 try {
  1720.                         // tries command line and binary parsing
  1721.                         // requires vendor/danielmarschall/git_utils.inc.php
  1722.                         $git_dir = OIDplus::findGitFolder();
  1723.                         if ($git_dir === false) return false;
  1724.                         $commit_msg = git_get_latest_commit_message($git_dir);
  1725.                 } catch (Exception $e) {
  1726.                         return false;
  1727.                 }
  1728.  
  1729.                 $m = array();
  1730.                 if (preg_match('%git-svn-id: (.+)@(\\d+) %ismU', $commit_msg, $m)) {
  1731.                         return $m[2];
  1732.                 } else {
  1733.                         return false;
  1734.                 }
  1735.         }
  1736.  
  1737.         public static function prefilterQuery($static_node_id, $throw_exception) {
  1738.                 // Let namespace be case-insensitive
  1739.                 $ary = explode(':', $static_node_id, 2);
  1740.                 $ary[0] = strtolower($ary[0]);
  1741.                 $static_node_id = implode(':', $ary);
  1742.  
  1743.                 // Ask plugins if they want to change the node id
  1744.                 foreach (OIDplus::getObjectTypePluginsEnabled() as $plugin) {
  1745.                         $static_node_id = $plugin->prefilterQuery($static_node_id, $throw_exception);
  1746.                 }
  1747.  
  1748.                 return $static_node_id;
  1749.         }
  1750.  
  1751.         public static function isCronjob() {
  1752.                 return explode('.',basename($_SERVER['SCRIPT_NAME']))[0] === 'cron';
  1753.         }
  1754.  
  1755.         private static function recanonizeObjects() {
  1756.                 #
  1757.                 # Since OIDplus svn-184, entries in the database need to have a canonical ID
  1758.                 # If the ID is not canonical (e.g. GUIDs missing hyphens), the object cannot be opened in OIDplus
  1759.                 # This script re-canonizes the object IDs if required.
  1760.                 # In SVN Rev 856, the canonization for GUID, IPv4 and IPv6 have changed, requiring another
  1761.                 # re-canonization
  1762.                 #
  1763.                 $res = OIDplus::db()->query("select id from ###objects");
  1764.                 while ($row = $res->fetch_array()) {
  1765.                         $ida = $row['id'];
  1766.                         $obj = OIDplusObject::parse($ida);
  1767.                         if (!$obj) continue;
  1768.                         $idb = $obj->nodeId();
  1769.                         if (($idb) && ($ida != $idb)) {
  1770.                                 OIDplus::db()->transaction_begin();
  1771.                                 OIDplus::db()->query("update ###objects set id = ? where id = ?", array($idb, $ida));
  1772.                                 OIDplus::db()->query("update ###asn1id set oid = ? where oid = ?", array($idb, $ida));
  1773.                                 OIDplus::db()->query("update ###iri set oid = ? where oid = ?", array($idb, $ida));
  1774.                                 OIDplus::db()->query("update ###log_object set id = ? where id = ?", array($idb, $ida));
  1775.                                 OIDplus::logger()->log("[INFO]A!", "Object name '$ida' has been changed to '$idb' during re-canonization");
  1776.                                 OIDplus::db()->transaction_commit();
  1777.                         }
  1778.                 }
  1779.         }
  1780.  
  1781. }
  1782.