]> git.mxchange.org Git - friendica.git/blobdiff - src/App.php
1) Refactor App->config[] into Core\Config
[friendica.git] / src / App.php
index 6f95b8edb7d1994637012409b7f7a078eb965dc3..db35c45c195c86f80cf8a1ced679789658ade159 100644 (file)
@@ -10,9 +10,7 @@ use DOMXPath;
 use Exception;
 use Friendica\Database\DBA;
 use Friendica\Network\HTTPException\InternalServerErrorException;
-
-require_once 'boot.php';
-require_once 'include/text.php';
+use Psr\Log\LoggerInterface;
 
 /**
  *
@@ -104,6 +102,16 @@ class App
         */
        private $isAjax;
 
+       /**
+        * @var MobileDetect
+        */
+       public $mobileDetect;
+
+       /**
+        * @var LoggerInterface The current logger of this App
+        */
+       private $logger;
+
        /**
         * Register a stylesheet file path to be included in the <head> tag of every page.
         * Inclusion is done in App->initHead().
@@ -112,6 +120,7 @@ class App
         * @see initHead()
         *
         * @param string $path
+        * @throws InternalServerErrorException
         */
        public function registerStylesheet($path)
        {
@@ -128,6 +137,7 @@ class App
         * @see initFooter()
         *
         * @param string $path
+        * @throws InternalServerErrorException
         */
        public function registerFooterScript($path)
        {
@@ -144,13 +154,16 @@ class App
        /**
         * @brief App constructor.
         *
-        * @param string $basePath  Path to the app base folder
-        * @param bool   $isBackend Whether it is used for backend or frontend (Default true=backend)
+        * @param string           $basePath  Path to the app base folder
+        * @param LoggerInterface  $logger    Logger of this application
+        * @param bool             $isBackend Whether it is used for backend or frontend (Default true=backend)
         *
         * @throws Exception if the Basepath is not usable
         */
-       public function __construct($basePath, $isBackend = true)
+       public function __construct($basePath, LoggerInterface $logger, $isBackend = true)
        {
+               $this->logger = $logger;
+
                if (!static::isDirectoryUsable($basePath, false)) {
                        throw new Exception('Basepath ' . $basePath . ' isn\'t usable.');
                }
@@ -271,6 +284,9 @@ class App
 
                // Detect mobile devices
                $mobile_detect = new MobileDetect();
+
+               $this->mobileDetect = $mobile_detect;
+
                $this->is_mobile = $mobile_detect->isMobile();
                $this->is_tablet = $mobile_detect->isTablet();
 
@@ -296,6 +312,21 @@ class App
                return $this->mode;
        }
 
+       /**
+        * Returns the Logger of the Application
+        *
+        * @return LoggerInterface The Logger
+        * @throws InternalServerErrorException when the logger isn't created
+        */
+       public function getLogger()
+       {
+               if (empty($this->logger)) {
+                       throw new InternalServerErrorException('Logger of the Application is not defined');
+               }
+
+               return $this->logger;
+       }
+
        /**
         * Reloads the whole app instance
         */
@@ -323,6 +354,8 @@ class App
                Core\L10n::init();
 
                $this->process_id = Core\System::processID('log');
+
+               Core\Logger::setLogger($this->logger);
        }
 
        /**
@@ -348,28 +381,29 @@ class App
 
                        include $this->getBasePath() . '/.htconfig.php';
 
-                       $this->setConfigValue('database', 'hostname', $db_host);
-                       $this->setConfigValue('database', 'username', $db_user);
-                       $this->setConfigValue('database', 'password', $db_pass);
-                       $this->setConfigValue('database', 'database', $db_data);
-                       if (isset($a->config['system']['db_charset'])) {
-                               $this->setConfigValue('database', 'charset', $a->config['system']['db_charset']);
+                       Core\Config::setConfigValue('database', 'hostname', $db_host);
+                       Core\Config::setConfigValue('database', 'username', $db_user);
+                       Core\Config::setConfigValue('database', 'password', $db_pass);
+                       Core\Config::setConfigValue('database', 'database', $db_data);
+                       $charset = Core\Config::getConfigValue('system', 'db_charset');
+                       if (isset($charset)) {
+                               Core\Config::setConfigValue('database', 'charset', $charset);
                        }
 
                        unset($db_host, $db_user, $db_pass, $db_data);
 
                        if (isset($default_timezone)) {
-                               $this->setConfigValue('system', 'default_timezone', $default_timezone);
+                               Core\Config::setConfigValue('system', 'default_timezone', $default_timezone);
                                unset($default_timezone);
                        }
 
                        if (isset($pidfile)) {
-                               $this->setConfigValue('system', 'pidfile', $pidfile);
+                               Core\Config::setConfigValue('system', 'pidfile', $pidfile);
                                unset($pidfile);
                        }
 
                        if (isset($lang)) {
-                               $this->setConfigValue('system', 'language', $lang);
+                               Core\Config::setConfigValue('system', 'language', $lang);
                                unset($lang);
                        }
                }
@@ -404,7 +438,7 @@ class App
                        throw new Exception('Error parsing INI config file ' . $filepath);
                }
 
-               $this->loadConfigArray($config, $overwrite);
+               Core\Config::loadConfigArray($config, $overwrite);
        }
 
        /**
@@ -435,7 +469,7 @@ class App
                        throw new Exception('Error loading config file ' . $filepath);
                }
 
-               $this->loadConfigArray($config, $overwrite);
+               Core\Config::loadConfigArray($config, $overwrite);
        }
 
        /**
@@ -457,26 +491,6 @@ class App
                }
        }
 
-       /**
-        * Tries to load the specified configuration array into the App->config array.
-        * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
-        *
-        * @param array $config
-        * @param bool  $overwrite Force value overwrite if the config key already exists
-        */
-       private function loadConfigArray(array $config, $overwrite = false)
-       {
-               foreach ($config as $category => $values) {
-                       foreach ($values as $key => $value) {
-                               if ($overwrite) {
-                                       $this->setConfigValue($category, $key, $value);
-                               } else {
-                                       $this->setDefaultConfigValue($category, $key, $value);
-                               }
-                       }
-               }
-       }
-
        /**
         * Loads the default timezone
         *
@@ -486,8 +500,8 @@ class App
         */
        private function loadDefaultTimezone()
        {
-               if ($this->getConfigValue('system', 'default_timezone')) {
-                       $this->timezone = $this->getConfigValue('system', 'default_timezone');
+               if (Core\Config::getConfigValue('system', 'default_timezone')) {
+                       $this->timezone = Core\Config::getConfigValue('system', 'default_timezone');
                } else {
                        global $default_timezone;
                        $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
@@ -513,7 +527,7 @@ class App
                $relative_script_path = defaults($_SERVER, 'SCRIPT_URL'         , $relative_script_path);
                $relative_script_path = defaults($_SERVER, 'REQUEST_URI'        , $relative_script_path);
 
-               $this->urlPath = $this->getConfigValue('system', 'urlpath');
+               $this->urlPath = Core\Config::getConfigValue('system', 'urlpath');
 
                /* $relative_script_path gives /relative/path/to/friendica/module/parameter
                 * QUERY_STRING gives pagename=module/parameter
@@ -523,7 +537,7 @@ class App
                if (!empty($relative_script_path)) {
                        // Module
                        if (!empty($_SERVER['QUERY_STRING'])) {
-                               $path = trim(dirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
+                               $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
                        } else {
                                // Root page
                                $path = trim($relative_script_path, '/');
@@ -541,11 +555,11 @@ class App
                        return;
                }
 
-               $db_host = $this->getConfigValue('database', 'hostname');
-               $db_user = $this->getConfigValue('database', 'username');
-               $db_pass = $this->getConfigValue('database', 'password');
-               $db_data = $this->getConfigValue('database', 'database');
-               $charset = $this->getConfigValue('database', 'charset');
+               $db_host = Core\Config::getConfigValue('database', 'hostname');
+               $db_user = Core\Config::getConfigValue('database', 'username');
+               $db_pass = Core\Config::getConfigValue('database', 'password');
+               $db_data = Core\Config::getConfigValue('database', 'database');
+               $charset = Core\Config::getConfigValue('database', 'charset');
 
                // Use environment variables for mysql if they are set beforehand
                if (!empty(getenv('MYSQL_HOST'))
@@ -585,6 +599,7 @@ class App
         * finally for PWD
         *
         * @return string
+        * @throws InternalServerErrorException
         */
        public function getBasePath()
        {
@@ -644,6 +659,7 @@ class App
         *
         * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
         * @return string Friendica server base URL
+        * @throws InternalServerErrorException
         */
        public function getBaseURL($ssl = false)
        {
@@ -668,7 +684,7 @@ class App
                        $this->hostname = Core\Config::get('config', 'hostname');
                }
 
-               return $scheme . '://' . $this->hostname . !empty($this->getURLPath() ? '/' . $this->getURLPath() : '' );
+               return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
        }
 
        /**
@@ -677,6 +693,7 @@ class App
         * Clears the baseurl cache to prevent inconsistencies
         *
         * @param string $url
+        * @throws InternalServerErrorException
         */
        public function setBaseURL($url)
        {
@@ -753,9 +770,9 @@ class App
                // compose the page title from the sitename and the
                // current module called
                if (!$this->module == '') {
-                       $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
+                       $this->page['title'] = Core\Config::getConfigValue('config', 'sitename') . ' (' . $this->module . ')';
                } else {
-                       $this->page['title'] = $this->config['sitename'];
+                       $this->page['title'] = Core\Config::getConfigValue('config', 'sitename');
                }
 
                if (!empty(Core\Renderer::$theme['stylesheet'])) {
@@ -776,7 +793,7 @@ class App
                        $touch_icon = 'images/friendica-128.png';
                }
 
-               Core\Addon::callHooks('head', $this->page['htmlhead']);
+               Core\Hook::callAll('head', $this->page['htmlhead']);
 
                $tpl = Core\Renderer::getMarkupTemplate('head.tpl');
                /* put the head template at the beginning of page['htmlhead']
@@ -835,7 +852,7 @@ class App
                        ]);
                }
 
-               Core\Addon::callHooks('footer', $this->page['footer']);
+               Core\Hook::callAll('footer', $this->page['footer']);
 
                $tpl = Core\Renderer::getMarkupTemplate('footer.tpl');
                $this->page['footer'] = Core\Renderer::replaceMacros($tpl, [
@@ -850,6 +867,7 @@ class App
         * @param string $origURL
         *
         * @return string The cleaned url
+        * @throws InternalServerErrorException
         */
        public function removeBaseURL($origURL)
        {
@@ -875,7 +893,9 @@ class App
         */
        public function saveTimestamp($timestamp, $value)
        {
-               if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
+               $profiler = Core\Config::getConfigValue('system', 'profiler');
+
+               if (!isset($profiler) || !$profiler) {
                        return;
                }
 
@@ -903,6 +923,7 @@ class App
         * Returns the current UserAgent as a String
         *
         * @return string the UserAgent as a String
+        * @throws InternalServerErrorException
         */
        public function getUserAgent()
        {
@@ -1026,6 +1047,7 @@ class App
         * @brief Checks if the minimal memory is reached
         *
         * @return bool Is the memory limit reached?
+        * @throws InternalServerErrorException
         */
        public function isMinMemoryReached()
        {
@@ -1070,6 +1092,7 @@ class App
         * @brief Checks if the maximum load is reached
         *
         * @return bool Is the load reached?
+        * @throws InternalServerErrorException
         */
        public function isMaxLoadReached()
        {
@@ -1102,6 +1125,7 @@ class App
         *
         * @param string $command The command to execute
         * @param array  $args    Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
+        * @throws InternalServerErrorException
         */
        public function proc_run($command, $args)
        {
@@ -1109,7 +1133,7 @@ class App
                        return;
                }
 
-               $cmdline = $this->getConfigValue('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
+               $cmdline = Core\Config::getConfigValue('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
 
                foreach ($args as $key => $value) {
                        if (!is_null($value) && is_bool($value) && !$value) {
@@ -1158,7 +1182,10 @@ class App
        /**
         * @brief Checks if a given directory is usable for the system
         *
+        * @param      $directory
+        * @param bool $check_writable
         * @return boolean the directory is usable
+        * @throws Exception
         */
        public static function isDirectoryUsable($directory, $check_writable = true)
        {
@@ -1190,87 +1217,6 @@ class App
                return true;
        }
 
-       /**
-        * @param string $cat     Config category
-        * @param string $k       Config key
-        * @param mixed  $default Default value if it isn't set
-        *
-        * @return string Returns the value of the Config entry
-        */
-       public function getConfigValue($cat, $k, $default = null)
-       {
-               $return = $default;
-
-               if ($cat === 'config') {
-                       if (isset($this->config[$k])) {
-                               $return = $this->config[$k];
-                       }
-               } else {
-                       if (isset($this->config[$cat][$k])) {
-                               $return = $this->config[$cat][$k];
-                       }
-               }
-
-               return $return;
-       }
-
-       /**
-        * Sets a default value in the config cache. Ignores already existing keys.
-        *
-        * @param string $cat Config category
-        * @param string $k   Config key
-        * @param mixed  $v   Default value to set
-        */
-       private function setDefaultConfigValue($cat, $k, $v)
-       {
-               if (!isset($this->config[$cat][$k])) {
-                       $this->setConfigValue($cat, $k, $v);
-               }
-       }
-
-       /**
-        * Sets a value in the config cache. Accepts raw output from the config table
-        *
-        * @param string $cat Config category
-        * @param string $k   Config key
-        * @param mixed  $v   Value to set
-        */
-       public function setConfigValue($cat, $k, $v)
-       {
-               // Only arrays are serialized in database, so we have to unserialize sparingly
-               $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
-
-               if ($cat === 'config') {
-                       $this->config[$k] = $value;
-               } else {
-                       if (!isset($this->config[$cat])) {
-                               $this->config[$cat] = [];
-                       }
-
-                       $this->config[$cat][$k] = $value;
-               }
-       }
-
-       /**
-        * Deletes a value from the config cache
-        *
-        * @param string $cat Config category
-        * @param string $k   Config key
-        */
-       public function deleteConfigValue($cat, $k)
-       {
-               if ($cat === 'config') {
-                       if (isset($this->config[$k])) {
-                               unset($this->config[$k]);
-                       }
-               } else {
-                       if (isset($this->config[$cat][$k])) {
-                               unset($this->config[$cat][$k]);
-                       }
-               }
-       }
-
-
        /**
         * Retrieves a value from the user config cache
         *
@@ -1336,6 +1282,7 @@ class App
         * Generates the site's default sender email address
         *
         * @return string
+        * @throws InternalServerErrorException
         */
        public function getSenderEmailAddress()
        {
@@ -1356,6 +1303,7 @@ class App
         * Returns the current theme name.
         *
         * @return string the name of the current theme
+        * @throws InternalServerErrorException
         */
        public function getCurrentTheme()
        {
@@ -1363,14 +1311,18 @@ class App
                        return '';
                }
 
-               //// @TODO Compute the current theme only once (this behavior has
-               /// already been implemented, but it didn't work well -
-               /// https://github.com/friendica/friendica/issues/5092)
-               $this->computeCurrentTheme();
+               if (!$this->currentTheme) {
+                       $this->computeCurrentTheme();
+               }
 
                return $this->currentTheme;
        }
 
+       public function setCurrentTheme($theme)
+       {
+               $this->currentTheme = $theme;
+       }
+
        /**
         * Computes the current theme name based on the node settings, the user settings and the device type
         *
@@ -1433,6 +1385,7 @@ class App
         * Provide a sane default if nothing is chosen or the specified theme does not exist.
         *
         * @return string
+        * @throws InternalServerErrorException
         */
        public function getCurrentThemeStylesheetPath()
        {
@@ -1525,7 +1478,7 @@ class App
                        }
 
                        Core\Session::init();
-                       Core\Addon::callHooks('init_1');
+                       Core\Hook::callAll('init_1');
                }
 
                // Exclude the backend processes from the session management
@@ -1709,23 +1662,14 @@ class App
                        }
                }
 
-               // Load current theme info
-               $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
-               if (file_exists($theme_info_file)) {
-                       require_once $theme_info_file;
-               }
+               $content = '';
 
-               // initialise content region
-               if ($this->getMode()->isNormal()) {
-                       Core\Addon::callHooks('page_content_top', $this->page['content']);
-               }
-
-               // Call module functions
+               // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
                if ($this->module_loaded) {
                        $this->page['page_title'] = $this->module;
                        $placeholder = '';
 
-                       Core\Addon::callHooks($this->module . '_mod_init', $placeholder);
+                       Core\Hook::callAll($this->module . '_mod_init', $placeholder);
 
                        call_user_func([$this->module_class, 'init']);
 
@@ -1734,37 +1678,47 @@ class App
                        if (!$this->error) {
                                call_user_func([$this->module_class, 'rawContent']);
                        }
+               }
 
-                       if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
-                               $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
-                               $func($this);
-                       }
+               // Load current theme info after module has been initialized as theme could have been set in module
+               $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
+               if (file_exists($theme_info_file)) {
+                       require_once $theme_info_file;
+               }
+
+               if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
+                       $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
+                       $func($this);
+               }
 
+               if ($this->module_loaded) {
                        if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
-                               Core\Addon::callHooks($this->module . '_mod_post', $_POST);
+                               Core\Hook::callAll($this->module . '_mod_post', $_POST);
                                call_user_func([$this->module_class, 'post']);
                        }
 
                        if (! $this->error) {
-                               Core\Addon::callHooks($this->module . '_mod_afterpost', $placeholder);
+                               Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
                                call_user_func([$this->module_class, 'afterpost']);
                        }
 
                        if (! $this->error) {
-                               $arr = ['content' => $this->page['content']];
-                               Core\Addon::callHooks($this->module . '_mod_content', $arr);
-                               $this->page['content'] = $arr['content'];
+                               $arr = ['content' => $content];
+                               Core\Hook::callAll($this->module . '_mod_content', $arr);
+                               $content = $arr['content'];
                                $arr = ['content' => call_user_func([$this->module_class, 'content'])];
-                               Core\Addon::callHooks($this->module . '_mod_aftercontent', $arr);
-                               $this->page['content'] .= $arr['content'];
+                               Core\Hook::callAll($this->module . '_mod_aftercontent', $arr);
+                               $content .= $arr['content'];
                        }
+               }
 
-                       if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_content_loaded')) {
-                               $func = str_replace('-', '_', $this->getCurrentTheme()) . '_content_loaded';
-                               $func($this);
-                       }
+               // initialise content region
+               if ($this->getMode()->isNormal()) {
+                       Core\Hook::callAll('page_content_top', $this->page['content']);
                }
 
+               $this->page['content'] .= $content;
+
                /* Create the page head after setting the language
                 * and getting any auth credentials.
                 *
@@ -1787,7 +1741,7 @@ class App
                }
 
                // Report anything which needs to be communicated in the notification area (before the main body)
-               Core\Addon::callHooks('page_end', $this->page['content']);
+               Core\Hook::callAll('page_end', $this->page['content']);
 
                // Add the navigation (menu) template
                if ($this->module != 'install' && $this->module != 'maintenance') {
@@ -1817,14 +1771,14 @@ class App
                                // And then append it to the target
                                $target->documentElement->appendChild($item);
                        }
-               }
 
-               if (isset($_GET["mode"]) && ($_GET["mode"] == "raw")) {
-                       header("Content-type: text/html; charset=utf-8");
+                       if ($_GET["mode"] == "raw") {
+                               header("Content-type: text/html; charset=utf-8");
 
-                       echo substr($target->saveHTML(), 6, -8);
+                               echo substr($target->saveHTML(), 6, -8);
 
-                       exit();
+                               exit();
+                       }
                }
 
                $page    = $this->page;
@@ -1880,7 +1834,7 @@ class App
         */
        public function internalRedirect($toUrl = '', $ssl = false)
        {
-               if (filter_var($toUrl, FILTER_VALIDATE_URL)) {
+               if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
                        throw new InternalServerErrorException("'$toUrl is not a relative path, please use System::externalRedirectTo");
                }
 
@@ -1893,11 +1847,11 @@ class App
         * Should only be used if it isn't clear if the URL is either internal or external
         *
         * @param string $toUrl The target URL
-        *
+        * @throws InternalServerErrorException
         */
        public function redirect($toUrl)
        {
-               if (filter_var($toUrl, FILTER_VALIDATE_URL)) {
+               if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) {
                        Core\System::externalRedirect($toUrl);
                } else {
                        $this->internalRedirect($toUrl);