src/App/Router.php

   1 <?php
   2
   3 namespace Friendica\App;
   4
   5
   6 use FastRoute\DataGenerator\GroupCountBased;
   7 use FastRoute\Dispatcher;
   8 use FastRoute\RouteCollector;
   9 use FastRoute\RouteParser\Std;
  10 use Friendica\Core\Hook;
  11 use Friendica\DI;
  12 use Friendica\Network\HTTPException;
  13
  14 /**
  15  * Wrapper for FastRoute\Router
  16  *
  17  * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
  18  * module class.
  19  *
  20  * Actual routes are defined in App->collectRoutes.
  21  *
  22  * @package Friendica\App
  23  */
  24 class Router
  25 {
  26         const POST = 'POST';
  27         const GET  = 'GET';
  28
  29         const ALLOWED_METHODS = [
  30                 self::POST,
  31                 self::GET,
  32         ];
  33
  34         /** @var RouteCollector */
  35         protected $routeCollector;
  36
  37         /**
  38          * @var string The HTTP method
  39          */
  40         private $httpMethod;
  41
  42         /**
  43          * @var array Module parameters
  44          */
  45         private $parameters = [];
  46
  47         /**
  48          * @param array $server The $_SERVER variable
  49          * @param RouteCollector|null $routeCollector Optional the loaded Route collector
  50          */
  51         public function __construct(array $server, RouteCollector $routeCollector = null)
  52         {
  53                 $httpMethod = $server['REQUEST_METHOD'] ?? self::GET;
  54                 $this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
  55
  56                 $this->routeCollector = isset($routeCollector) ?
  57                         $routeCollector :
  58                         new RouteCollector(new Std(), new GroupCountBased());
  59         }
  60
  61         /**
  62          * @param array $routes The routes to add to the Router
  63          *
  64          * @return self The router instance with the loaded routes
  65          *
  66          * @throws HTTPException\InternalServerErrorException In case of invalid configs
  67          */
  68         public function loadRoutes(array $routes)
  69         {
  70                 $routeCollector = (isset($this->routeCollector) ?
  71                         $this->routeCollector :
  72                         new RouteCollector(new Std(), new GroupCountBased()));
  73
  74                 $this->addRoutes($routeCollector, $routes);
  75
  76                 $this->routeCollector = $routeCollector;
  77
  78                 return $this;
  79         }
  80
  81         private function addRoutes(RouteCollector $routeCollector, array $routes)
  82         {
  83                 foreach ($routes as $route => $config) {
  84                         if ($this->isGroup($config)) {
  85                                 $this->addGroup($route, $config, $routeCollector);
  86                         } elseif ($this->isRoute($config)) {
  87                                 $routeCollector->addRoute($config[1], $route, $config[0]);
  88                         } else {
  89                                 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
  90                         }
  91                 }
  92         }
  93
  94         /**
  95          * Adds a group of routes to a given group
  96          *
  97          * @param string         $groupRoute     The route of the group
  98          * @param array          $routes         The routes of the group
  99          * @param RouteCollector $routeCollector The route collector to add this group
 100          */
 101         private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
 102         {
 103                 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
 104                         $this->addRoutes($routeCollector, $routes);
 105                 });
 106         }
 107
 108         /**
 109          * Returns true in case the config is a group config
 110          *
 111          * @param array $config
 112          *
 113          * @return bool
 114          */
 115         private function isGroup(array $config)
 116         {
 117                 return
 118                         is_array($config) &&
 119                         is_string(array_keys($config)[0]) &&
 120                         // This entry should NOT be a BaseModule
 121                         (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
 122                         // The second argument is an array (another routes)
 123                         is_array(array_values($config)[0]);
 124         }
 125
 126         /**
 127          * Returns true in case the config is a route config
 128          *
 129          * @param array $config
 130          *
 131          * @return bool
 132          */
 133         private function isRoute(array $config)
 134         {
 135                 return
 136                         // The config array should at least have one entry
 137                         !empty($config[0]) &&
 138                         // This entry should be a BaseModule
 139                         (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
 140                         // Either there is no other argument
 141                         (empty($config[1]) ||
 142                          // Or the second argument is an array (HTTP-Methods)
 143                          is_array($config[1]));
 144         }
 145
 146         /**
 147          * The current route collector
 148          *
 149          * @return RouteCollector|null
 150          */
 151         public function getRouteCollector()
 152         {
 153                 return $this->routeCollector;
 154         }
 155
 156         /**
 157          * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
 158          *
 159          * @param string $cmd The path component of the request URL without the query string
 160          *
 161          * @return string A Friendica\BaseModule-extending class name if a route rule matched
 162          *
 163          * @throws HTTPException\InternalServerErrorException
 164          * @throws HTTPException\MethodNotAllowedException    If a rule matched but the method didn't
 165          * @throws HTTPException\NotFoundException            If no rule matched
 166          */
 167         public function getModuleClass($cmd)
 168         {
 169                 // Add routes from addons
 170                 Hook::callAll('route_collection', $this->routeCollector);
 171
 172                 $cmd = '/' . ltrim($cmd, '/');
 173
 174                 $dispatcher = new Dispatcher\GroupCountBased($this->routeCollector->getData());
 175
 176                 $moduleClass = null;
 177                 $this->parameters = [];
 178
 179                 $routeInfo  = $dispatcher->dispatch($this->httpMethod, $cmd);
 180                 if ($routeInfo[0] === Dispatcher::FOUND) {
 181                         $moduleClass = $routeInfo[1];
 182                         $this->parameters = $routeInfo[2];
 183                 } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
 184                         throw new HTTPException\MethodNotAllowedException(DI::l10n()->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
 185                 } else {
 186                         throw new HTTPException\NotFoundException(DI::l10n()->t('Page not found.'));
 187                 }
 188
 189                 return $moduleClass;
 190         }
 191
 192         /**
 193          * Returns the module parameters.
 194          *
 195          * @return array parameters
 196          */
 197         public function getModuleParameters()
 198         {
 199                 return $this->parameters;
 200         }
 201 }