src/App/Router.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\App;
  23
  24 use Dice\Dice;
  25 use FastRoute\DataGenerator\GroupCountBased;
  26 use FastRoute\Dispatcher;
  27 use FastRoute\RouteCollector;
  28 use FastRoute\RouteParser\Std;
  29 use Friendica\Capabilities\ICanHandleRequests;
  30 use Friendica\Core\Addon;
  31 use Friendica\Core\Cache\Enum\Duration;
  32 use Friendica\Core\Cache\Capability\ICanCache;
  33 use Friendica\Core\Config\Capability\IManageConfigValues;
  34 use Friendica\Core\Hook;
  35 use Friendica\Core\L10n;
  36 use Friendica\Core\Lock\Capability\ICanLock;
  37 use Friendica\Core\Session;
  38 use Friendica\LegacyModule;
  39 use Friendica\Module\HTTPException\MethodNotAllowed;
  40 use Friendica\Module\HTTPException\PageNotFound;
  41 use Friendica\Module\Special\Options;
  42 use Friendica\Network\HTTPException;
  43 use Friendica\Network\HTTPException\MethodNotAllowedException;
  44 use Friendica\Network\HTTPException\NotFoundException;
  45 use Friendica\Util\Router\FriendicaGroupCountBased;
  46 use Psr\Log\LoggerInterface;
  47
  48 /**
  49  * Wrapper for FastRoute\Router
  50  *
  51  * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
  52  * module class.
  53  *
  54  * Actual routes are defined in App->collectRoutes.
  55  *
  56  * @package Friendica\App
  57  */
  58 class Router
  59 {
  60         const DELETE  = 'DELETE';
  61         const GET     = 'GET';
  62         const PATCH   = 'PATCH';
  63         const POST    = 'POST';
  64         const PUT     = 'PUT';
  65         const OPTIONS = 'OPTIONS';
  66
  67         const ALLOWED_METHODS = [
  68                 self::DELETE,
  69                 self::GET,
  70                 self::PATCH,
  71                 self::POST,
  72                 self::PUT,
  73                 self::OPTIONS
  74         ];
  75
  76         /** @var RouteCollector */
  77         protected $routeCollector;
  78
  79         /**
  80          * @var array Module parameters
  81          */
  82         private $parameters = [];
  83
  84         /** @var L10n */
  85         private $l10n;
  86
  87         /** @var ICanCache */
  88         private $cache;
  89
  90         /** @var ICanLock */
  91         private $lock;
  92
  93         /** @var Arguments */
  94         private $args;
  95
  96         /** @var IManageConfigValues */
  97         private $config;
  98
  99         /** @var LoggerInterface */
 100         private $logger;
 101
 102         /** @var float */
 103         private $dice_profiler_threshold;
 104
 105         /** @var Dice */
 106         private $dice;
 107
 108         /** @var string */
 109         private $baseRoutesFilepath;
 110
 111         /** @var array */
 112         private $server;
 113
 114         /**
 115          * @param array               $server             The $_SERVER variable
 116          * @param string              $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
 117          * @param L10n                $l10n
 118          * @param ICanCache           $cache
 119          * @param ICanLock            $lock
 120          * @param IManageConfigValues $config
 121          * @param Arguments           $args
 122          * @param LoggerInterface     $logger
 123          * @param Dice                $dice
 124          * @param RouteCollector|null $routeCollector
 125          */
 126         public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, IManageConfigValues $config, Arguments $args, LoggerInterface $logger, Dice $dice, RouteCollector $routeCollector = null)
 127         {
 128                 $this->baseRoutesFilepath      = $baseRoutesFilepath;
 129                 $this->l10n                    = $l10n;
 130                 $this->cache                   = $cache;
 131                 $this->lock                    = $lock;
 132                 $this->args                    = $args;
 133                 $this->config                  = $config;
 134                 $this->dice                    = $dice;
 135                 $this->server                  = $server;
 136                 $this->logger                  = $logger;
 137                 $this->dice_profiler_threshold = $config->get('system', 'dice_profiler_threshold', 0);
 138
 139                 $this->routeCollector = $routeCollector ?? new RouteCollector(new Std(), new GroupCountBased());
 140
 141                 if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
 142                         throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
 143                 }
 144         }
 145
 146         /**
 147          * This will be called either automatically if a base routes file path was submitted,
 148          * or can be called manually with a custom route array.
 149          *
 150          * @param array $routes The routes to add to the Router
 151          *
 152          * @return self The router instance with the loaded routes
 153          *
 154          * @throws HTTPException\InternalServerErrorException In case of invalid configs
 155          */
 156         public function loadRoutes(array $routes): Router
 157         {
 158                 $routeCollector = ($this->routeCollector ?? new RouteCollector(new Std(), new GroupCountBased()));
 159
 160                 $this->addRoutes($routeCollector, $routes);
 161
 162                 $this->routeCollector = $routeCollector;
 163
 164                 // Add routes from addons
 165                 Hook::callAll('route_collection', $this->routeCollector);
 166
 167                 return $this;
 168         }
 169
 170         /**
 171          * Adds multiple routes to a route collector
 172          *
 173          * @param RouteCollector $routeCollector Route collector instance
 174          * @param array $routes Multiple routes to be added
 175          * @throws HTTPException\InternalServerErrorException If route was wrong (somehow)
 176          */
 177         private function addRoutes(RouteCollector $routeCollector, array $routes)
 178         {
 179                 foreach ($routes as $route => $config) {
 180                         if ($this->isGroup($config)) {
 181                                 $this->addGroup($route, $config, $routeCollector);
 182                         } elseif ($this->isRoute($config)) {
 183                                 // Always add the OPTIONS endpoint to a route
 184                                 $httpMethods   = (array) $config[1];
 185                                 $httpMethods[] = Router::OPTIONS;
 186                                 $routeCollector->addRoute($httpMethods, $route, $config[0]);
 187                         } else {
 188                                 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
 189                         }
 190                 }
 191         }
 192
 193         /**
 194          * Adds a group of routes to a given group
 195          *
 196          * @param string         $groupRoute     The route of the group
 197          * @param array          $routes         The routes of the group
 198          * @param RouteCollector $routeCollector The route collector to add this group
 199          */
 200         private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
 201         {
 202                 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
 203                         $this->addRoutes($routeCollector, $routes);
 204                 });
 205         }
 206
 207         /**
 208          * Returns true in case the config is a group config
 209          *
 210          * @param array $config
 211          *
 212          * @return bool
 213          */
 214         private function isGroup(array $config)
 215         {
 216                 return
 217                         is_array($config) &&
 218                         is_string(array_keys($config)[0]) &&
 219                         // This entry should NOT be a BaseModule
 220                         (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
 221                         // The second argument is an array (another routes)
 222                         is_array(array_values($config)[0]);
 223         }
 224
 225         /**
 226          * Returns true in case the config is a route config
 227          *
 228          * @param array $config
 229          *
 230          * @return bool
 231          */
 232         private function isRoute(array $config): bool
 233         {
 234                 return
 235                         // The config array should at least have one entry
 236                         !empty($config[0]) &&
 237                         // This entry should be a BaseModule
 238                         (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
 239                         // Either there is no other argument
 240                         (empty($config[1]) ||
 241                          // Or the second argument is an array (HTTP-Methods)
 242                          is_array($config[1]));
 243         }
 244
 245         /**
 246          * The current route collector
 247          *
 248          * @return RouteCollector|null
 249          */
 250         public function getRouteCollector()
 251         {
 252                 return $this->routeCollector;
 253         }
 254
 255         /**
 256          * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
 257          *
 258          * @return string A Friendica\BaseModule-extending class name if a route rule matched
 259          *
 260          * @throws HTTPException\InternalServerErrorException
 261          * @throws HTTPException\MethodNotAllowedException    If a rule matched but the method didn't
 262          * @throws HTTPException\NotFoundException            If no rule matched
 263          */
 264         private function getModuleClass(): string
 265         {
 266                 $cmd = $this->args->getCommand();
 267                 $cmd = '/' . ltrim($cmd, '/');
 268
 269                 $dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
 270
 271                 $this->parameters = [];
 272
 273                 // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
 274                 if ($this->args->getMethod() === static::OPTIONS) {
 275                         $moduleClass      = Options::class;
 276                         $this->parameters = ['allowedMethods' => $dispatcher->getOptions($cmd)];
 277                 } else {
 278                         $routeInfo = $dispatcher->dispatch($this->args->getMethod(), $cmd);
 279                         if ($routeInfo[0] === Dispatcher::FOUND) {
 280                                 $moduleClass      = $routeInfo[1];
 281                                 $this->parameters = $routeInfo[2];
 282                         } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
 283                                 throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
 284                         } else {
 285                                 throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
 286                         }
 287                 }
 288
 289                 return $moduleClass;
 290         }
 291
 292         public function getModule(?string $module_class = null): ICanHandleRequests
 293         {
 294                 $module_parameters = [$this->server];
 295                 /**
 296                  * ROUTING
 297                  *
 298                  * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
 299                  * post() and/or content() static methods can be respectively called to produce a data change or an output.
 300                  **/
 301                 try {
 302                         $module_class        = $module_class ?? $this->getModuleClass();
 303                         $module_parameters[] = $this->parameters;
 304                 } catch (MethodNotAllowedException $e) {
 305                         $module_class = MethodNotAllowed::class;
 306                 } catch (NotFoundException $e) {
 307                         $moduleName = $this->args->getModuleName();
 308                         // Then we try addon-provided modules that we wrap in the LegacyModule class
 309                         if (Addon::isEnabled($moduleName) && file_exists("addon/{$moduleName}/{$moduleName}.php")) {
 310                                 //Check if module is an app and if public access to apps is allowed or not
 311                                 $privateapps = $this->config->get('config', 'private_addons', false);
 312                                 if (!Session::getLocalUser() && Hook::isAddonApp($moduleName) && $privateapps) {
 313                                         throw new MethodNotAllowedException($this->l10n->t("You must be logged in to use addons. "));
 314                                 } else {
 315                                         include_once "addon/{$moduleName}/{$moduleName}.php";
 316                                         if (function_exists($moduleName . '_module')) {
 317                                                 $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
 318                                                 $module_class        = LegacyModule::class;
 319                                         }
 320                                 }
 321                         }
 322
 323                         /* Finally, we look for a 'standard' program module in the 'mod' directory
 324                          * We emulate a Module class through the LegacyModule class
 325                          */
 326                         if (!$module_class && file_exists("mod/{$moduleName}.php")) {
 327                                 $module_parameters[] = "mod/{$moduleName}.php";
 328                                 $module_class        = LegacyModule::class;
 329                         }
 330
 331                         $module_class = $module_class ?: PageNotFound::class;
 332                 }
 333
 334                 $stamp = microtime(true);
 335
 336                 try {
 337                         /** @var ICanHandleRequests $module */
 338                         return $this->dice->create($module_class, $module_parameters);
 339                 } finally {
 340                         if ($this->dice_profiler_threshold > 0) {
 341                                 $dur = floatval(microtime(true) - $stamp);
 342                                 if ($dur >= $this->dice_profiler_threshold) {
 343                                         $this->logger->notice('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $module_class, 'parameters' => $module_parameters]);
 344                                 }
 345                         }
 346                 }
 347         }
 348
 349         /**
 350          * If a base routes file path has been provided, we can load routes from it if the cache misses.
 351          *
 352          * @return array
 353          * @throws HTTPException\InternalServerErrorException
 354          */
 355         private function getDispatchData()
 356         {
 357                 $dispatchData = [];
 358
 359                 if ($this->baseRoutesFilepath) {
 360                         $dispatchData = require $this->baseRoutesFilepath;
 361                         if (!is_array($dispatchData)) {
 362                                 throw new HTTPException\InternalServerErrorException('Invalid base routes file');
 363                         }
 364                 }
 365
 366                 $this->loadRoutes($dispatchData);
 367
 368                 return $this->routeCollector->getData();
 369         }
 370
 371         /**
 372          * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
 373          * takes about 850ms for each requests.
 374          *
 375          * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
 376          * is any changes in the enabled addons list.
 377          *
 378          * Additionally, we check for the base routes file last modification time to automatically
 379          * trigger re-computing the dispatch data.
 380          *
 381          * @return array|mixed
 382          * @throws HTTPException\InternalServerErrorException
 383          */
 384         private function getCachedDispatchData()
 385         {
 386                 $routerDispatchData         = $this->cache->get('routerDispatchData');
 387                 $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
 388                 $forceRecompute             = false;
 389
 390                 if ($this->baseRoutesFilepath) {
 391                         $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
 392                         $forceRecompute         = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
 393                 }
 394
 395                 if (!$forceRecompute && $routerDispatchData) {
 396                         return $routerDispatchData;
 397                 }
 398
 399                 if (!$this->lock->acquire('getCachedDispatchData', 0)) {
 400                         // Immediately return uncached data when we can't aquire a lock
 401                         return $this->getDispatchData();
 402                 }
 403
 404                 $routerDispatchData = $this->getDispatchData();
 405
 406                 $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
 407                 if (!empty($routesFileModifiedTime)) {
 408                         $this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
 409                 }
 410
 411                 if ($this->lock->isLocked('getCachedDispatchData')) {
 412                         $this->lock->release('getCachedDispatchData');
 413                 }
 414
 415                 return $routerDispatchData;
 416         }
 417 }