Merge pull request #12591 from MrPetovan/task/2023-licence

[friendica.git] / src / App / Router.php

diff --git a/src/App/Router.php b/src/App/Router.php
index 35ea9ada8b76e5c456f4aec424bddd1e507b81a0..0bd66d40f94aedd84983af88f81fd71e5097f4c8 100644 (file)
--- a/src/App/Router.php
+++ b/src/App/Router.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -80,7 +80,7 @@ class Router
        /**
         * @var array Module parameters
         */
-       private $parameters = [];
+       protected $parameters = [];
 
        /** @var L10n */
        private $l10n;
@@ -150,6 +150,8 @@ class Router
                if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
                        throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
                }
+
+               $this->parameters = [$this->server];
        }
 
        /**
@@ -268,7 +270,6 @@ class Router
         *
         * @throws InternalServerErrorException
         * @throws MethodNotAllowedException
-        * @throws NotFoundException
         */
        public function getModuleClass(): string
        {
@@ -284,9 +285,8 @@ class Router
         *
         * @return void
         *
-        * @throws HTTPException\InternalServerErrorException
-        * @throws HTTPException\MethodNotAllowedException    If a rule matched but the method didn't
-        * @throws HTTPException\NotFoundException            If no rule matched
+        * @throws HTTPException\InternalServerErrorException Unexpected exceptions
+        * @throws HTTPException\MethodNotAllowedException    If a rule is private only
         */
        private function determineModuleClass(): void
        {
@@ -295,39 +295,24 @@ class Router
 
                $dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
 
-               $this->parameters = [];
-
-               // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
-               if ($this->args->getMethod() === static::OPTIONS) {
-                       $this->moduleClass = Options::class;
-                       $this->parameters  = ['allowedMethods' => $dispatcher->getOptions($cmd)];
-               } else {
-                       $routeInfo = $dispatcher->dispatch($this->args->getMethod(), $cmd);
-                       if ($routeInfo[0] === Dispatcher::FOUND) {
-                               $this->moduleClass = $routeInfo[1];
-                               $this->parameters  = $routeInfo[2];
-                       } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
-                               throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
+               try {
+                       // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
+                       if ($this->args->getMethod() === static::OPTIONS) {
+                               $this->moduleClass = Options::class;
+                               $this->parameters[] = ['AllowedMethods' => $dispatcher->getOptions($cmd)];
                        } else {
-                               throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
+                               $routeInfo = $dispatcher->dispatch($this->args->getMethod(), $cmd);
+                               if ($routeInfo[0] === Dispatcher::FOUND) {
+                                       $this->moduleClass = $routeInfo[1];
+                                       $this->parameters[] = $routeInfo[2];
+                               } else if ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
+                                       throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
+                               } else {
+                                       throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
+                               }
                        }
-               }
-       }
-
-       public function getModule(?string $module_class = null): ICanHandleRequests
-       {
-               $module_parameters = [$this->server];
-               /**
-                * 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.
-                **/
-               try {
-                       $module_class        = $module_class ?? $this->getModuleClass();
-                       $module_parameters[] = $this->parameters;
                } catch (MethodNotAllowedException $e) {
-                       $module_class = MethodNotAllowed::class;
+                       $this->moduleClass = MethodNotAllowed::class;
                } catch (NotFoundException $e) {
                        $moduleName = $this->args->getModuleName();
                        // Then we try addon-provided modules that we wrap in the LegacyModule class
@@ -339,8 +324,8 @@ class Router
                                } else {
                                        include_once "addon/{$moduleName}/{$moduleName}.php";
                                        if (function_exists($moduleName . '_module')) {
-                                               $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
-                                               $module_class        = LegacyModule::class;
+                                               $this->parameters[] = "addon/{$moduleName}/{$moduleName}.php";
+                                               $this->moduleClass  = LegacyModule::class;
                                        }
                                }
                        }
@@ -348,24 +333,29 @@ class Router
                        /* Finally, we look for a 'standard' program module in the 'mod' directory
                         * We emulate a Module class through the LegacyModule class
                         */
-                       if (!$module_class && file_exists("mod/{$moduleName}.php")) {
-                               $module_parameters[] = "mod/{$moduleName}.php";
-                               $module_class        = LegacyModule::class;
+                       if (!$this->moduleClass && file_exists("mod/{$moduleName}.php")) {
+                               $this->parameters[] = "mod/{$moduleName}.php";
+                               $this->moduleClass  = LegacyModule::class;
                        }
 
-                       $module_class = $module_class ?: PageNotFound::class;
+                       $this->moduleClass = $this->moduleClass ?: PageNotFound::class;
                }
+       }
+
+       public function getModule(?string $module_class = null): ICanHandleRequests
+       {
+               $moduleClass = $module_class ?? $this->getModuleClass();
 
                $stamp = microtime(true);
 
                try {
                        /** @var ICanHandleRequests $module */
-                       return $this->dice->create($module_class, $module_parameters);
+                       return $this->dice->create($moduleClass, $this->parameters);
                } finally {
                        if ($this->dice_profiler_threshold > 0) {
                                $dur = floatval(microtime(true) - $stamp);
                                if ($dur >= $this->dice_profiler_threshold) {
-                                       $this->logger->notice('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $module_class, 'parameters' => $module_parameters]);
+                                       $this->logger->notice('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $moduleClass, 'parameters' => $this->parameters]);
                                }
                        }
                }