]> git.mxchange.org Git - friendica.git/blobdiff - src/App/Page.php
Reverted some changes that won't work with PHP7.3
[friendica.git] / src / App / Page.php
index af1f1810b705d36e92d966aaac1e7e85679584f7..0f14d9f6e6530106ecbb87b0bd922a894ddcf4e8 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -26,17 +26,20 @@ use DOMDocument;
 use DOMXPath;
 use Friendica\App;
 use Friendica\Content\Nav;
-use Friendica\Core\Config\IConfig;
-use Friendica\Core\PConfig\IPConfig;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
 use Friendica\Core\Hook;
 use Friendica\Core\L10n;
+use Friendica\Core\Logger;
 use Friendica\Core\Renderer;
+use Friendica\Core\System;
 use Friendica\Core\Theme;
-use Friendica\Module\Special\HTTPException as ModuleHTTPException;
+use Friendica\Module\Response;
 use Friendica\Network\HTTPException;
 use Friendica\Util\Network;
 use Friendica\Util\Strings;
 use Friendica\Util\Profiler;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Contains the page specific environment variables for the current Page
@@ -76,14 +79,42 @@ class Page implements ArrayAccess
         */
        private $basePath;
 
+       private $timestamp = 0;
+       private $method    = '';
+       private $module    = '';
+       private $command   = '';
+
        /**
         * @param string $basepath The Page basepath
         */
        public function __construct(string $basepath)
        {
+               $this->timestamp = microtime(true);
                $this->basePath = $basepath;
        }
 
+       public function setLogging(string $method, string $module, string $command)
+       {
+               $this->method  = $method;
+               $this->module  = $module;
+               $this->command = $command;
+       }
+
+       public function logRuntime(IManageConfigValues $config, string $origin = '')
+       {
+               $ignore = $config->get('system', 'runtime_ignore');
+               if (in_array($this->module, $ignore) || in_array($this->command, $ignore)) {
+                       return;
+               }
+
+               $signature = !empty($_SERVER['HTTP_SIGNATURE']);
+               $load      = number_format(System::currentLoad(), 2);
+               $runtime   = number_format(microtime(true) - $this->timestamp, 3);
+               if ($runtime > $config->get('system', 'runtime_loglimit')) {
+                       Logger::debug('Runtime', ['method' => $this->method, 'module' => $this->module, 'runtime' => $runtime, 'load' => $load, 'origin' => $origin, 'signature' => $signature, 'request' => $_SERVER['REQUEST_URI'] ?? '']);
+               }
+       }
+
        /**
         * Whether a offset exists
         *
@@ -99,7 +130,7 @@ class Page implements ArrayAccess
         * The return value will be casted to boolean if non-boolean was returned.
         * @since 5.0.0
         */
-       public function offsetExists($offset)
+       public function offsetExists($offset): bool
        {
                return isset($this->page[$offset]);
        }
@@ -169,9 +200,9 @@ class Page implements ArrayAccess
         * @param string $media
         * @see Page::initHead()
         */
-       public function registerStylesheet($path, string $media = 'screen')
+       public function registerStylesheet(string $path, string $media = 'screen')
        {
-               $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]);
+               $path = Network::appendQueryParam($path, ['v' => App::VERSION]);
 
                if (mb_strpos($path, $this->basePath . DIRECTORY_SEPARATOR) === 0) {
                        $path = mb_substr($path, mb_strlen($this->basePath . DIRECTORY_SEPARATOR));
@@ -190,17 +221,18 @@ class Page implements ArrayAccess
         * - Infinite scroll data
         * - head.tpl template
         *
-        * @param App      $app     The Friendica App instance
-        * @param Module   $module  The loaded Friendica module
-        * @param L10n     $l10n    The l10n language instance
-        * @param IConfig  $config  The Friendica configuration
-        * @param IPConfig $pConfig The Friendica personal configuration (for user)
+        * @param App                         $app      The Friendica App instance
+        * @param Arguments                   $args     The Friendica App Arguments
+        * @param L10n                        $l10n     The l10n language instance
+        * @param IManageConfigValues         $config   The Friendica configuration
+        * @param IManagePersonalConfigValues $pConfig  The Friendica personal configuration (for user)
+        * @param int                         $localUID The local user id
         *
         * @throws HTTPException\InternalServerErrorException
         */
-       private function initHead(App $app, Module $module, L10n $l10n, IConfig $config, IPConfig $pConfig)
+       private function initHead(App $app, Arguments $args, L10n $l10n, IManageConfigValues $config, IManagePersonalConfigValues $pConfig, int $localUID)
        {
-               $interval = ((local_user()) ? $pConfig->get(local_user(), 'system', 'update_interval') : 40000);
+               $interval = ($localUID ? $pConfig->get($localUID, 'system', 'update_interval') : 40000);
 
                // If the update is 'deactivated' set it to the highest integer number (~24 days)
                if ($interval < 0) {
@@ -212,8 +244,8 @@ class Page implements ArrayAccess
                }
 
                // Default title: current module called
-               if (empty($this->page['title']) && $module->getName()) {
-                       $this->page['title'] = ucfirst($module->getName());
+               if (empty($this->page['title']) && $args->getModuleName()) {
+                       $this->page['title'] = ucfirst($args->getModuleName());
                }
 
                // Prepend the sitename to the page title
@@ -229,7 +261,7 @@ class Page implements ArrayAccess
 
                $shortcut_icon = $config->get('system', 'shortcut_icon');
                if ($shortcut_icon == '') {
-                       $shortcut_icon = 'images/friendica-32.png';
+                       $shortcut_icon = 'images/friendica.svg';
                }
 
                $touch_icon = $config->get('system', 'touch_icon');
@@ -245,9 +277,10 @@ class Page implements ArrayAccess
                 * being first
                 */
                $this->page['htmlhead'] = Renderer::replaceMacros($tpl, [
-                       '$local_user'      => local_user(),
-                       '$generator'       => 'Friendica' . ' ' . FRIENDICA_VERSION,
+                       '$local_user'      => $localUID,
+                       '$generator'       => 'Friendica' . ' ' . App::VERSION,
                        '$delitem'         => $l10n->t('Delete this item?'),
+                       '$blockAuthor'     => $l10n->t('Block this author? They won\'t be able to follow you nor see your public posts, and you won\'t be able to see their posts and their notifications.'),
                        '$update_interval' => $interval,
                        '$shortcut_icon'   => $shortcut_icon,
                        '$touch_icon'      => $touch_icon,
@@ -256,6 +289,28 @@ class Page implements ArrayAccess
                ]) . $this->page['htmlhead'];
        }
 
+       /**
+        * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
+        *
+        * Taken from http://webcheatsheet.com/php/get_current_page_url.php
+        */
+       private function curPageURL(): string
+       {
+               $pageURL = 'http';
+               if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
+                       $pageURL .= "s";
+               }
+
+               $pageURL .= "://";
+
+               if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
+                       $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
+               } else {
+                       $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
+               }
+               return $pageURL;
+       }
+      
        /**
         * Initializes Page->page['footer'].
         *
@@ -276,8 +331,8 @@ class Page implements ArrayAccess
                // If you're just visiting, let javascript take you home
                if (!empty($_SESSION['visitor_home'])) {
                        $homebase = $_SESSION['visitor_home'];
-               } elseif (!empty($app->user['nickname'])) {
-                       $homebase = 'profile/' . $app->user['nickname'];
+               } elseif (!empty($app->getLoggedInUserNickname())) {
+                       $homebase = 'profile/' . $app->getLoggedInUserNickname();
                }
 
                if (isset($homebase)) {
@@ -289,9 +344,9 @@ class Page implements ArrayAccess
                 */
                if ($mode->isMobile() || $mode->isTablet()) {
                        if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
-                               $link = 'toggle_mobile?address=' . urlencode(curPageURL());
+                               $link = 'toggle_mobile?address=' . urlencode($this->curPageURL());
                        } else {
-                               $link = 'toggle_mobile?off=1&address=' . urlencode(curPageURL());
+                               $link = 'toggle_mobile?off=1&address=' . urlencode($this->curPageURL());
                        }
                        $this->page['footer'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
                                '$toggle_link' => $link,
@@ -314,34 +369,19 @@ class Page implements ArrayAccess
         * - module content
         * - hooks for content
         *
-        * @param Module $module The module
-        * @param Mode   $mode   The Friendica execution mode
+        * @param ResponseInterface  $response The Module response class
+        * @param Mode               $mode     The Friendica execution mode
         *
         * @throws HTTPException\InternalServerErrorException
         */
-       private function initContent(Module $module, Mode $mode)
+       private function initContent(ResponseInterface $response, Mode $mode)
        {
-               $content = '';
-
-               try {
-                       $moduleClass = $module->getClassName();
-
-                       $arr = ['content' => $content];
-                       Hook::callAll($moduleClass . '_mod_content', $arr);
-                       $content = $arr['content'];
-                       $arr     = ['content' => call_user_func([$moduleClass, 'content'], $module->getParameters())];
-                       Hook::callAll($moduleClass . '_mod_aftercontent', $arr);
-                       $content .= $arr['content'];
-               } catch (HTTPException $e) {
-                       $content = ModuleHTTPException::content($e);
-               }
-
                // initialise content region
                if ($mode->isNormal()) {
                        Hook::callAll('page_content_top', $this->page['content']);
                }
 
-               $this->page['content'] .= $content;
+               $this->page['content'] .= (string)$response->getBody();
        }
 
        /**
@@ -356,29 +396,64 @@ class Page implements ArrayAccess
         */
        public function registerFooterScript($path)
        {
-               $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]);
+               $path = Network::appendQueryParam($path, ['v' => App::VERSION]);
 
                $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
 
                $this->footerScripts[] = trim($url, '/');
        }
 
+       /**
+        * Directly exit with the current response (include setting all headers)
+        *
+        * @param ResponseInterface $response
+        */
+       public function exit(ResponseInterface $response)
+       {
+               header(sprintf("HTTP/%s %s %s",
+                       $response->getProtocolVersion(),
+                       $response->getStatusCode(),
+                       $response->getReasonPhrase())
+               );
+
+               foreach ($response->getHeaders() as $key => $header) {
+                       if (is_array($header)) {
+                               $header_str = implode(',', $header);
+                       } else {
+                               $header_str = $header;
+                       }
+
+                       if (empty($key)) {
+                               header($header_str);
+                       } else {
+                               header("$key: $header_str");
+                       }
+               }
+
+               echo $response->getBody();
+       }
+
        /**
         * Executes the creation of the current page and prints it to the screen
         *
-        * @param App      $app     The Friendica App
-        * @param BaseURL  $baseURL The Friendica Base URL
-        * @param Mode     $mode    The current node mode
-        * @param Module   $module  The loaded Friendica module
-        * @param L10n     $l10n    The l10n language class
-        * @param IConfig  $config  The Configuration of this node
-        * @param IPConfig $pconfig The personal/user configuration
+        * @param App                         $app      The Friendica App
+        * @param BaseURL                     $baseURL  The Friendica Base URL
+        * @param Arguments                   $args     The Friendica App arguments
+        * @param Mode                        $mode     The current node mode
+        * @param ResponseInterface           $response The Response of the module class, including type, content & headers
+        * @param L10n                        $l10n     The l10n language class
+        * @param IManageConfigValues         $config   The Configuration of this node
+        * @param IManagePersonalConfigValues $pconfig  The personal/user configuration
+        * @param int                         $localUID The UID of the local user
         *
-        * @throws HTTPException\InternalServerErrorException
+        * @throws HTTPException\InternalServerErrorException|HTTPException\ServiceUnavailableException
         */
-       public function run(App $app, BaseURL $baseURL, Mode $mode, Module $module, L10n $l10n, Profiler $profiler, IConfig $config, IPConfig $pconfig)
+       public function run(App $app, BaseURL $baseURL, Arguments $args, Mode $mode, ResponseInterface $response, L10n $l10n, Profiler $profiler, IManageConfigValues $config, IManagePersonalConfigValues $pconfig, int $localUID)
        {
-               $moduleName = $module->getName();
+               $moduleName = $args->getModuleName();
+
+               $this->command = $moduleName;
+               $this->method  = $args->getMethod();
 
                /* Create the page content.
                 * Calls all hooks which are including content operations
@@ -386,8 +461,7 @@ class Page implements ArrayAccess
                 * Sets the $Page->page['content'] variable
                 */
                $timestamp = microtime(true);
-               $this->initContent($module, $mode);
-               $profiler->set(microtime(true) - $timestamp, 'content');
+               $this->initContent($response, $mode);
 
                // Load current theme info after module has been initialized as theme could have been set in module
                $currentTheme = $app->getCurrentTheme();
@@ -408,13 +482,15 @@ class Page implements ArrayAccess
                 * all the module functions have executed so that all
                 * theme choices made by the modules can take effect.
                 */
-               $this->initHead($app, $module, $l10n, $config, $pconfig);
+               $this->initHead($app, $args, $l10n, $config, $pconfig, $localUID);
 
                /* Build the page ending -- this is stuff that goes right before
                 * the closing </body> tag
                 */
                $this->initFooter($app, $mode, $l10n);
 
+               $profiler->set(microtime(true) - $timestamp, 'aftermath');
+
                if (!$mode->isAjax()) {
                        Hook::callAll('page_end', $this->page['content']);
                }
@@ -425,6 +501,20 @@ class Page implements ArrayAccess
                        $this->page['nav']      = Nav::build($app);
                }
 
+               foreach ($response->getHeaders() as $key => $header) {
+                       if (is_array($header)) {
+                               $header_str = implode(',', $header);
+                       } else {
+                               $header_str = $header;
+                       }
+
+                       if (empty($key)) {
+                               header($header_str);
+                       } else {
+                               header("$key: $header_str");
+                       }
+               }
+
                // Build the page - now that we have all the components
                if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
                        $doc = new DOMDocument();
@@ -449,18 +539,13 @@ class Page implements ArrayAccess
                        }
 
                        if ($_GET["mode"] == "raw") {
-                               header("Content-type: text/html; charset=utf-8");
-
-                               echo substr($target->saveHTML(), 6, -8);
-
-                               exit();
+                               System::httpExit(substr($target->saveHTML(), 6, -8), Response::TYPE_HTML);
                        }
                }
 
                $page    = $this->page;
-               $profile = $app->profile;
 
-               header("X-Friendica-Version: " . FRIENDICA_VERSION);
+               header("X-Friendica-Version: " . App::VERSION);
                header("Content-type: text/html; charset=utf-8");
 
                if ($config->get('system', 'hsts') && ($baseURL->getSSLPolicy() == BaseURL::SSL_POLICY_FULL)) {