]> git.mxchange.org Git - friendica.git/blobdiff - src/App.php
Remove code parameter from HTTPException constructor
[friendica.git] / src / App.php
index f698d06c8280dca36a6dc3e7fb85f57a74d330c3..328a1a15226652ff8b7cf0d1054b49ff07864088 100644 (file)
@@ -8,7 +8,6 @@ use Detection\MobileDetect;
 use DOMDocument;
 use DOMXPath;
 use Exception;
-use FastRoute\RouteCollector;
 use Friendica\Core\Config\Cache\IConfigCache;
 use Friendica\Core\Config\Configuration;
 use Friendica\Core\Hook;
@@ -16,6 +15,7 @@ use Friendica\Core\Theme;
 use Friendica\Database\DBA;
 use Friendica\Model\Profile;
 use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\Util\BaseURL;
 use Friendica\Util\Config\ConfigFileLoader;
 use Friendica\Util\HTTPSignature;
 use Friendica\Util\Profiler;
@@ -49,7 +49,6 @@ class App
        public $page_contact;
        public $content;
        public $data = [];
-       public $error = false;
        public $cmd = '';
        public $argv;
        public $argc;
@@ -79,9 +78,14 @@ class App
        private $mode;
 
        /**
-        * @var string The App URL path
+        * @var App\Router
         */
-       private $urlPath;
+       private $router;
+
+       /**
+        * @var BaseURL
+        */
+       private $baseURL;
 
        /**
         * @var bool true, if the call is from the Friendica APP, otherwise false
@@ -133,6 +137,16 @@ class App
                return $this->config->getCache();
        }
 
+       /**
+        * Returns the current config of this node
+        *
+        * @return Configuration
+        */
+       public function getConfig()
+       {
+               return $this->config;
+       }
+
        /**
         * The basepath of this app
         *
@@ -173,6 +187,16 @@ class App
                return $this->mode;
        }
 
+       /**
+        * Returns the router of the Application
+        *
+        * @return App\Router
+        */
+       public function getRouter()
+       {
+               return $this->router;
+       }
+
        /**
         * Register a stylesheet file path to be included in the <head> tag of every page.
         * Inclusion is done in App->initHead().
@@ -181,7 +205,6 @@ class App
         * @see initHead()
         *
         * @param string $path
-        * @throws InternalServerErrorException
         */
        public function registerStylesheet($path)
        {
@@ -200,7 +223,6 @@ class App
         * @see initFooter()
         *
         * @param string $path
-        * @throws InternalServerErrorException
         */
        public function registerFooterScript($path)
        {
@@ -210,30 +232,31 @@ class App
        }
 
        public $queue;
-       private $scheme;
-       private $hostname;
 
        /**
         * @brief App constructor.
         *
         * @param Configuration    $config    The Configuration
         * @param App\Mode         $mode      The mode of this Friendica app
+        * @param App\Router       $router    The router of this Friendica app
+        * @param BaseURL          $baseURL   The full base URL of this Friendica app
         * @param LoggerInterface  $logger    The current app logger
         * @param Profiler         $profiler  The profiler 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(Configuration $config, App\Mode $mode, LoggerInterface $logger, Profiler $profiler, $isBackend = true)
+       public function __construct(Configuration $config, App\Mode $mode, App\Router $router, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, $isBackend = true)
        {
                BaseObject::setApp($this);
 
-               $this->logger   = $logger;
                $this->config   = $config;
-               $this->profiler = $profiler;
                $this->mode     = $mode;
+               $this->router   = $router;
+               $this->baseURL  = $baseURL;
+               $this->profiler = $profiler;
+               $this->logger   = $logger;
 
-               $this->checkBackend($isBackend);
                $this->checkFriendicaApp();
 
                $this->profiler->reset();
@@ -245,26 +268,6 @@ class App
                // This has to be quite large to deal with embedded private photos
                ini_set('pcre.backtrack_limit', 500000);
 
-               $this->scheme = 'http';
-
-               if (!empty($_SERVER['HTTPS']) ||
-                       !empty($_SERVER['HTTP_FORWARDED']) && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED']) ||
-                       !empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ||
-                       !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on' ||
-                       !empty($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on' ||
-                       !empty($_SERVER['SERVER_PORT']) && (intval($_SERVER['SERVER_PORT']) == 443) // XXX: reasonable assumption, but isn't this hardcoding too much?
-               ) {
-                       $this->scheme = 'https';
-               }
-
-               if (!empty($_SERVER['SERVER_NAME'])) {
-                       $this->hostname = $_SERVER['SERVER_NAME'];
-
-                       if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
-                               $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
-                       }
-               }
-
                set_include_path(
                        get_include_path() . PATH_SEPARATOR
                        . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
@@ -323,6 +326,8 @@ class App
                        $this->module = 'home';
                }
 
+               $this->isBackend = $isBackend || $this->checkBackend($this->module);
+
                // Detect mobile devices
                $mobile_detect = new MobileDetect();
 
@@ -342,8 +347,6 @@ class App
         */
        public function reload()
        {
-               $this->determineURLPath();
-
                $this->getMode()->determine($this->getBasePath());
 
                if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
@@ -386,97 +389,28 @@ class App
        }
 
        /**
-        * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
+        * Returns the scheme of the current call
+        * @return string
+        *
+        * @deprecated 2019.06 - use BaseURL->getScheme() instead
         */
-       private function determineURLPath()
-       {
-               /*
-                * The automatic path detection in this function is currently deactivated,
-                * see issue https://github.com/friendica/friendica/issues/6679
-                *
-                * The problem is that the function seems to be confused with some url.
-                * These then confuses the detection which changes the url path.
-                */
-
-               /* Relative script path to the web server root
-                * Not all of those $_SERVER properties can be present, so we do by inverse priority order
-                */
-/*
-               $relative_script_path = '';
-               $relative_script_path = defaults($_SERVER, 'REDIRECT_URL'       , $relative_script_path);
-               $relative_script_path = defaults($_SERVER, 'REDIRECT_URI'       , $relative_script_path);
-               $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
-               $relative_script_path = defaults($_SERVER, 'SCRIPT_URL'         , $relative_script_path);
-               $relative_script_path = defaults($_SERVER, 'REQUEST_URI'        , $relative_script_path);
-*/
-               $this->urlPath = $this->config->get('system', 'urlpath');
-
-               /* $relative_script_path gives /relative/path/to/friendica/module/parameter
-                * QUERY_STRING gives pagename=module/parameter
-                *
-                * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
-                */
-/*
-               if (!empty($relative_script_path)) {
-                       // Module
-                       if (!empty($_SERVER['QUERY_STRING'])) {
-                               $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
-                       } else {
-                               // Root page
-                               $path = trim($relative_script_path, '/');
-                       }
-
-                       if ($path && $path != $this->urlPath) {
-                               $this->urlPath = $path;
-                       }
-               }
-*/
-       }
-
        public function getScheme()
        {
-               return $this->scheme;
+               return $this->baseURL->getScheme();
        }
 
        /**
-        * @brief Retrieves the Friendica instance base URL
+        * Retrieves the Friendica instance base URL
         *
-        * This function assembles the base URL from multiple parts:
-        * - Protocol is determined either by the request or a combination of
-        * system.ssl_policy and the $ssl parameter.
-        * - Host name is determined either by system.hostname or inferred from request
-        * - Path is inferred from SCRIPT_NAME
+        * @param bool $ssl Whether to append http or https under BaseURL::SSL_POLICY_SELFSIGN
         *
-        * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
-        *
-        * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
         * @return string Friendica server base URL
-        * @throws InternalServerErrorException
+        *
+        * @deprecated 2019.06 - use BaseURL->get($ssl) instead
         */
        public function getBaseURL($ssl = false)
        {
-               $scheme = $this->scheme;
-
-               if ($this->config->get('system', 'ssl_policy') == SSL_POLICY_FULL) {
-                       $scheme = 'https';
-               }
-
-               //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
-               //      (and also the login link). Anything seen by an outsider will have it turned off.
-
-               if ($this->config->get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
-                       if ($ssl) {
-                               $scheme = 'https';
-                       } else {
-                               $scheme = 'http';
-                       }
-               }
-
-               if ($this->config->get('config', 'hostname') != '') {
-                       $this->hostname = $this->config->get('config', 'hostname');
-               }
-
-               return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
+               return $this->baseURL->get($ssl);
        }
 
        /**
@@ -485,55 +419,36 @@ class App
         * Clears the baseurl cache to prevent inconsistencies
         *
         * @param string $url
-        * @throws InternalServerErrorException
+        *
+        * @deprecated 2019.06 - use BaseURL->saveByURL($url) instead
         */
        public function setBaseURL($url)
        {
-               $parsed = @parse_url($url);
-               $hostname = '';
-
-               if (!empty($parsed)) {
-                       if (!empty($parsed['scheme'])) {
-                               $this->scheme = $parsed['scheme'];
-                       }
-
-                       if (!empty($parsed['host'])) {
-                               $hostname = $parsed['host'];
-                       }
-
-                       if (!empty($parsed['port'])) {
-                               $hostname .= ':' . $parsed['port'];
-                       }
-                       if (!empty($parsed['path'])) {
-                               $this->urlPath = trim($parsed['path'], '\\/');
-                       }
-
-                       if (file_exists($this->getBasePath() . '/.htpreconfig.php')) {
-                               include $this->getBasePath() . '/.htpreconfig.php';
-                       }
-
-                       if ($this->config->get('config', 'hostname') != '') {
-                               $this->hostname = $this->config->get('config', 'hostname');
-                       }
-
-                       if (!isset($this->hostname) || ($this->hostname == '')) {
-                               $this->hostname = $hostname;
-                       }
-               }
+               $this->baseURL->saveByURL($url);
        }
 
+       /**
+        * Returns the current hostname
+        *
+        * @return string
+        *
+        * @deprecated 2019.06 - use BaseURL->getHostname() instead
+        */
        public function getHostName()
        {
-               if ($this->config->get('config', 'hostname') != '') {
-                       $this->hostname = $this->config->get('config', 'hostname');
-               }
-
-               return $this->hostname;
+               return $this->baseURL->getHostname();
        }
 
+       /**
+        * Returns the sub-path of the full URL
+        *
+        * @return string
+        *
+        * @deprecated 2019.06 - use BaseURL->getUrlPath() instead
+        */
        public function getURLPath()
        {
-               return $this->urlPath;
+               return $this->baseURL->getUrlPath();
        }
 
        /**
@@ -718,21 +633,26 @@ class App
         * This isn't a perfect solution. But we need this check very early.
         * So we cannot wait until the modules are loaded.
         *
-        * @param string $backend true, if the backend flag was set during App initialization
-        *
+        * @param string $module
+        * @return bool
         */
-       private function checkBackend($backend) {
+       private function checkBackend($module) {
                static $backends = [
                        '_well_known',
                        'api',
                        'dfrn_notify',
+                       'feed',
                        'fetch',
+                       'followers',
+                       'following',
                        'hcard',
                        'hostxrd',
+                       'inbox',
                        'manifest',
                        'nodeinfo',
                        'noscrape',
-                       'p',
+                       'objects',
+                       'outbox',
                        'poco',
                        'post',
                        'proxy',
@@ -746,7 +666,7 @@ class App
                ];
 
                // Check if current module is in backend or backend flag is set
-               $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
+               return in_array($module, $backends);
        }
 
        /**
@@ -928,7 +848,7 @@ class App
        {
                $sender_email = $this->config->get('config', 'sender_email');
                if (empty($sender_email)) {
-                       $hostname = $this->getHostName();
+                       $hostname = $this->baseURL->getHostname();
                        if (strpos($hostname, ':')) {
                                $hostname = substr($hostname, 0, strpos($hostname, ':'));
                        }
@@ -1073,7 +993,7 @@ class App
                // and www.example.com vs example.com.
                // We will only change the url to an ip address if there is no existing setting
 
-               if (empty($url) || (!Util\Strings::compareLink($url, $this->getBaseURL())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->getHostName()))) {
+               if (empty($url) || (!Util\Strings::compareLink($url, $this->getBaseURL())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->baseURL->getHostname()))) {
                        $this->config->set('system', 'url', $this->getBaseURL());
                }
        }
@@ -1107,10 +1027,7 @@ class App
 
                if (!$this->getMode()->isInstall()) {
                        // Force SSL redirection
-                       if ($this->config->get('system', 'force_ssl') && ($this->getScheme() == "http")
-                               && intval($this->config->get('system', 'ssl_policy')) == SSL_POLICY_FULL
-                               && strpos($this->getBaseURL(), 'https://') === 0
-                               && $_SERVER['REQUEST_METHOD'] == 'GET') {
+                       if ($this->baseURL->checkRedirectHttps()) {
                                header('HTTP/1.1 302 Moved Temporarily');
                                header('Location: ' . $this->getBaseURL() . '/' . $this->query_string);
                                exit();
@@ -1248,14 +1165,25 @@ class App
                                $this->module = "login";
                        }
 
-                       $router = new App\Router();
-                       $this->collectRoutes($router->routeCollector);
+                       /*
+                        * ROUTING
+                        *
+                        * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
+                        * post() and/or content() static methods can be respectively called to produce a data change or an output.
+                        */
+
+                       // First we try explicit routes defined in App\Router
+                       $this->router->collectRoutes();
+
+                       $data = $this->router->getRouteCollector();
+                       Hook::callAll('route_collection', $data);
 
-                       $this->module_class = $router->getModuleClass($this->cmd);
+                       $this->module_class = $this->router->getModuleClass($this->cmd);
 
-                       $privateapps = $this->config->get('config', 'private_addons', false);
+                       // Then we try addon-provided modules that we wrap in the LegacyModule class
                        if (!$this->module_class && Core\Addon::isEnabled($this->module) && file_exists("addon/{$this->module}/{$this->module}.php")) {
                                //Check if module is an app and if public access to apps is allowed or not
+                               $privateapps = $this->config->get('config', 'private_addons', false);
                                if ((!local_user()) && Core\Hook::isAddonApp($this->module) && $privateapps) {
                                        info(Core\L10n::t("You must be logged in to use addons. "));
                                } else {
@@ -1267,12 +1195,12 @@ class App
                                }
                        }
 
-                       // Controller class routing
+                       // Then we try name-matching a Friendica\Module class
                        if (!$this->module_class && class_exists('Friendica\\Module\\' . ucfirst($this->module))) {
                                $this->module_class = 'Friendica\\Module\\' . ucfirst($this->module);
                        }
 
-                       /* If not, next look for a 'standard' program module in the 'mod' directory
+                       /* Finally, we look for a 'standard' program module in the 'mod' directory
                         * We emulate a Module class through the LegacyModule class
                         */
                        if (!$this->module_class && file_exists("mod/{$this->module}.php")) {
@@ -1323,9 +1251,7 @@ class App
 
                        // "rawContent" is especially meant for technical endpoints.
                        // This endpoint doesn't need any theme initialization or other comparable stuff.
-                       if (!$this->error) {
                                call_user_func([$this->module_class, 'rawContent']);
-                       }
                }
 
                // Load current theme info after module has been initialized as theme could have been set in module
@@ -1340,24 +1266,20 @@ class App
                }
 
                if ($this->module_class) {
-                       if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
+                       if ($_SERVER['REQUEST_METHOD'] === 'POST') {
                                Core\Hook::callAll($this->module . '_mod_post', $_POST);
                                call_user_func([$this->module_class, 'post']);
                        }
 
-                       if (! $this->error) {
                                Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder);
                                call_user_func([$this->module_class, 'afterpost']);
-                       }
 
-                       if (! $this->error) {
                                $arr = ['content' => $content];
                                Core\Hook::callAll($this->module . '_mod_content', $arr);
                                $content = $arr['content'];
                                $arr = ['content' => call_user_func([$this->module_class, 'content'])];
                                Core\Hook::callAll($this->module . '_mod_aftercontent', $arr);
                                $content .= $arr['content'];
-                       }
                }
 
                // initialise content region
@@ -1388,8 +1310,9 @@ class App
                        header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . Core\L10n::t('Permission denied.'));
                }
 
-               // Report anything which needs to be communicated in the notification area (before the main body)
-               Core\Hook::callAll('page_end', $this->page['content']);
+               if (!$this->isAjax()) {
+                       Core\Hook::callAll('page_end', $this->page['content']);
+               }
 
                // Add the navigation (menu) template
                if ($this->module != 'install' && $this->module != 'maintenance') {
@@ -1435,7 +1358,7 @@ class App
                header("X-Friendica-Version: " . FRIENDICA_VERSION);
                header("Content-type: text/html; charset=utf-8");
 
-               if ($this->config->get('system', 'hsts') && ($this->config->get('system', 'ssl_policy') == SSL_POLICY_FULL)) {
+               if ($this->config->get('system', 'hsts') && ($this->baseURL->getSSLPolicy() == BaseUrl::SSL_POLICY_FULL)) {
                        header("Strict-Transport-Security: max-age=31536000");
                }
 
@@ -1505,24 +1428,4 @@ class App
                        $this->internalRedirect($toUrl);
                }
        }
-
-       /**
-        * @brief Static declaration of Friendica routes.
-        *
-        * Supports:
-        * - Route groups
-        * - Variable parts
-        * Disregards:
-        * - HTTP method other than GET
-        * - Named parameters
-        *
-        * Handler must be the name of a class extending Friendica\BaseModule.
-        *
-        * @param RouteCollector $routeCollector
-        * @throws InternalServerErrorException
-        */
-       private function collectRoutes(RouteCollector $routeCollector)
-       {
-               Hook::callAll('route_collection', $routeCollector);
-       }
 }