]> git.mxchange.org Git - friendica.git/blobdiff - src/App/Page.php
API: Accept "redirect_uris" as both array and string
[friendica.git] / src / App / Page.php
index 7019d45985859d5e18dddbf534e470bf7cd027ec..a91d400ee88057d99b220f7e5a7f257b7e0c2b95 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -25,18 +25,21 @@ use ArrayAccess;
 use DOMDocument;
 use DOMXPath;
 use Friendica\App;
-use Friendica\Capabilities\IRespondToRequests;
 use Friendica\Content\Nav;
 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\PConfig\Capability\IManagePersonalConfigValues;
 use Friendica\Core\Renderer;
+use Friendica\Core\System;
 use Friendica\Core\Theme;
+use Friendica\Module\Response;
 use Friendica\Network\HTTPException;
 use Friendica\Util\Network;
-use Friendica\Util\Strings;
 use Friendica\Util\Profiler;
+use Friendica\Util\Strings;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Contains the page specific environment variables for the current Page
@@ -70,90 +73,84 @@ class Page implements ArrayAccess
                'right_aside' => '',
                'template'    => '',
                'title'       => '',
+               'section'     => '',
+               'module'      => '',
        ];
        /**
         * @var string The basepath of the page
         */
        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'] ?? '']);
+               }
+       }
+
+       // ArrayAccess interface
+
        /**
-        * Whether a offset exists
-        *
-        * @link  https://php.net/manual/en/arrayaccess.offsetexists.php
-        *
-        * @param mixed $offset <p>
-        *                      An offset to check for.
-        *                      </p>
-        *
-        * @return boolean true on success or false on failure.
-        * </p>
-        * <p>
-        * The return value will be casted to boolean if non-boolean was returned.
-        * @since 5.0.0
+        * @inheritDoc
         */
-       public function offsetExists($offset)
+       #[\ReturnTypeWillChange]
+       public function offsetExists($offset): bool
        {
                return isset($this->page[$offset]);
        }
 
        /**
-        * Offset to retrieve
-        *
-        * @link  https://php.net/manual/en/arrayaccess.offsetget.php
-        *
-        * @param mixed $offset <p>
-        *                      The offset to retrieve.
-        *                      </p>
-        *
-        * @return mixed Can return all value types.
-        * @since 5.0.0
+        * @inheritDoc
         */
+       #[\ReturnTypeWillChange]
        public function offsetGet($offset)
        {
                return $this->page[$offset] ?? null;
        }
 
        /**
-        * Offset to set
-        *
-        * @link  https://php.net/manual/en/arrayaccess.offsetset.php
-        *
-        * @param mixed $offset <p>
-        *                      The offset to assign the value to.
-        *                      </p>
-        * @param mixed $value  <p>
-        *                      The value to set.
-        *                      </p>
-        *
-        * @return void
-        * @since 5.0.0
+        * @inheritDoc
         */
-       public function offsetSet($offset, $value)
+       #[\ReturnTypeWillChange]
+       public function offsetSet($offset, $value): void
        {
                $this->page[$offset] = $value;
        }
 
        /**
-        * Offset to unset
-        *
-        * @link  https://php.net/manual/en/arrayaccess.offsetunset.php
-        *
-        * @param mixed $offset <p>
-        *                      The offset to unset.
-        *                      </p>
-        *
-        * @return void
-        * @since 5.0.0
+        * @inheritDoc
         */
-       public function offsetUnset($offset)
+       #[\ReturnTypeWillChange]
+       public function offsetUnset($offset): void
        {
                if (isset($this->page[$offset])) {
                        unset($this->page[$offset]);
@@ -169,9 +166,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 +187,18 @@ class Page implements ArrayAccess
         * - Infinite scroll data
         * - head.tpl template
         *
-        * @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 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, Arguments $args, L10n $l10n, IManageConfigValues $config, IManagePersonalConfigValues $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) {
@@ -229,7 +227,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,10 +243,11 @@ 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.'),
+                       '$ignoreAuthor'    => $l10n->t('Ignore this author? You won\'t be able to see their posts and their notifications.'),
                        '$update_interval' => $interval,
                        '$shortcut_icon'   => $shortcut_icon,
                        '$touch_icon'      => $touch_icon,
@@ -262,7 +261,7 @@ class Page implements ArrayAccess
         *
         * Taken from http://webcheatsheet.com/php/get_current_page_url.php
         */
-       private function curPageURL()
+       private function curPageURL(): string
        {
                $pageURL = 'http';
                if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
@@ -278,7 +277,7 @@ class Page implements ArrayAccess
                }
                return $pageURL;
        }
-      
+
        /**
         * Initializes Page->page['footer'].
         *
@@ -337,19 +336,19 @@ class Page implements ArrayAccess
         * - module content
         * - hooks for content
         *
-        * @param IRespondToRequests $response The Module response class
+        * @param ResponseInterface  $response The Module response class
         * @param Mode               $mode     The Friendica execution mode
         *
         * @throws HTTPException\InternalServerErrorException
         */
-       private function initContent(IRespondToRequests $response, Mode $mode)
+       private function initContent(ResponseInterface $response, Mode $mode)
        {
                // initialise content region
                if ($mode->isNormal()) {
                        Hook::callAll('page_content_top', $this->page['content']);
                }
 
-               $this->page['content'] .= $response->getContent();
+               $this->page['content'] .= (string)$response->getBody();
        }
 
        /**
@@ -364,7 +363,7 @@ 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);
 
@@ -374,19 +373,31 @@ class Page implements ArrayAccess
        /**
         * Directly exit with the current response (include setting all headers)
         *
-        * @param IRespondToRequests $response
+        * @param ResponseInterface $response
         */
-       public function exit(IRespondToRequests $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);
+                               header($header_str);
                        } else {
-                               header("$key: $header");
+                               header("$key: $header_str");
                        }
                }
 
-               echo $response->getContent();
+               echo $response->getBody();
        }
 
        /**
@@ -396,17 +407,24 @@ class Page implements ArrayAccess
         * @param BaseURL                     $baseURL  The Friendica Base URL
         * @param Arguments                   $args     The Friendica App arguments
         * @param Mode                        $mode     The current node mode
-        * @param IRespondToRequests          $response The Response of the module class, including type, content & headers
+        * @param ResponseInterface           $response The Response of the module class, including type, content & headers
         * @param L10n                        $l10n     The l10n language class
+        * @param Profiler                    $profiler
         * @param IManageConfigValues         $config   The Configuration of this node
         * @param IManagePersonalConfigValues $pconfig  The personal/user configuration
-        *
-        * @throws HTTPException\InternalServerErrorException|HTTPException\ServiceUnavailableException
+        * @param Nav                         $nav
+        * @param int                         $localUID
+        * @throws HTTPException\MethodNotAllowedException
+        * @throws HTTPException\InternalServerErrorException
+        * @throws HTTPException\ServiceUnavailableException
         */
-       public function run(App $app, BaseURL $baseURL, Arguments $args, Mode $mode, IRespondToRequests $response, L10n $l10n, Profiler $profiler, IManageConfigValues $config, IManagePersonalConfigValues $pconfig)
+       public function run(App $app, BaseURL $baseURL, Arguments $args, Mode $mode, ResponseInterface $response, L10n $l10n, Profiler $profiler, IManageConfigValues $config, IManagePersonalConfigValues $pconfig, Nav $nav, int $localUID)
        {
                $moduleName = $args->getModuleName();
 
+               $this->command = $moduleName;
+               $this->method  = $args->getMethod();
+
                /* Create the page content.
                 * Calls all hooks which are including content operations
                 *
@@ -414,7 +432,6 @@ class Page implements ArrayAccess
                 */
                $timestamp = microtime(true);
                $this->initContent($response, $mode);
-               $profiler->set(microtime(true) - $timestamp, 'content');
 
                // Load current theme info after module has been initialized as theme could have been set in module
                $currentTheme = $app->getCurrentTheme();
@@ -435,13 +452,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, $args, $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']);
                }
@@ -449,14 +468,20 @@ class Page implements ArrayAccess
                // Add the navigation (menu) template
                if ($moduleName != 'install' && $moduleName != 'maintenance') {
                        $this->page['htmlhead'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('nav_head.tpl'), []);
-                       $this->page['nav']      = Nav::build($app);
+                       $this->page['nav']      = $nav->getHtml();
                }
 
                foreach ($response->getHeaders() as $key => $header) {
+                       if (is_array($header)) {
+                               $header_str = implode(',', $header);
+                       } else {
+                               $header_str = $header;
+                       }
+
                        if (empty($key)) {
-                               header($header);
+                               header($header_str);
                        } else {
-                               header("$key: $header");
+                               header("$key: $header_str");
                        }
                }
 
@@ -484,17 +509,18 @@ 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;
 
-               header("X-Friendica-Version: " . FRIENDICA_VERSION);
+               // add and escape some common but crucial content for direct "echo" in HTML (security)
+               $page['title']   = htmlspecialchars($page['title'] ?? '');
+               $page['section'] = htmlspecialchars($args->get(0) ?? 'generic');
+               $page['module']  = htmlspecialchars($args->getModuleName() ?? '');
+
+               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)) {