3 namespace Friendica\App;
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\Core\L10n;
12 use Friendica\Network\HTTPException;
15 * Wrapper for FastRoute\Router
17 * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
20 * Actual routes are defined in App->collectRoutes.
22 * @package Friendica\App
29 const ALLOWED_METHODS = [
34 /** @var RouteCollector */
35 protected $routeCollector;
38 * @var string The HTTP method
43 * @var array Module parameters
45 private $parameters = [];
51 * @param array $server The $_SERVER variable
53 * @param RouteCollector|null $routeCollector Optional the loaded Route collector
55 public function __construct(array $server, L10n $l10n, RouteCollector $routeCollector = null)
59 $httpMethod = $server['REQUEST_METHOD'] ?? self::GET;
60 $this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
62 $this->routeCollector = isset($routeCollector) ?
64 new RouteCollector(new Std(), new GroupCountBased());
68 * @param array $routes The routes to add to the Router
70 * @return self The router instance with the loaded routes
72 * @throws HTTPException\InternalServerErrorException In case of invalid configs
74 public function loadRoutes(array $routes)
76 $routeCollector = (isset($this->routeCollector) ?
77 $this->routeCollector :
78 new RouteCollector(new Std(), new GroupCountBased()));
80 $this->addRoutes($routeCollector, $routes);
82 $this->routeCollector = $routeCollector;
87 private function addRoutes(RouteCollector $routeCollector, array $routes)
89 foreach ($routes as $route => $config) {
90 if ($this->isGroup($config)) {
91 $this->addGroup($route, $config, $routeCollector);
92 } elseif ($this->isRoute($config)) {
93 $routeCollector->addRoute($config[1], $route, $config[0]);
95 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
101 * Adds a group of routes to a given group
103 * @param string $groupRoute The route of the group
104 * @param array $routes The routes of the group
105 * @param RouteCollector $routeCollector The route collector to add this group
107 private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
109 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
110 $this->addRoutes($routeCollector, $routes);
115 * Returns true in case the config is a group config
117 * @param array $config
121 private function isGroup(array $config)
125 is_string(array_keys($config)[0]) &&
126 // This entry should NOT be a BaseModule
127 (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
128 // The second argument is an array (another routes)
129 is_array(array_values($config)[0]);
133 * Returns true in case the config is a route config
135 * @param array $config
139 private function isRoute(array $config)
142 // The config array should at least have one entry
143 !empty($config[0]) &&
144 // This entry should be a BaseModule
145 (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
146 // Either there is no other argument
147 (empty($config[1]) ||
148 // Or the second argument is an array (HTTP-Methods)
149 is_array($config[1]));
153 * The current route collector
155 * @return RouteCollector|null
157 public function getRouteCollector()
159 return $this->routeCollector;
163 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
165 * @param string $cmd The path component of the request URL without the query string
167 * @return string A Friendica\BaseModule-extending class name if a route rule matched
169 * @throws HTTPException\InternalServerErrorException
170 * @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't
171 * @throws HTTPException\NotFoundException If no rule matched
173 public function getModuleClass($cmd)
175 // Add routes from addons
176 Hook::callAll('route_collection', $this->routeCollector);
178 $cmd = '/' . ltrim($cmd, '/');
180 $dispatcher = new Dispatcher\GroupCountBased($this->routeCollector->getData());
183 $this->parameters = [];
185 $routeInfo = $dispatcher->dispatch($this->httpMethod, $cmd);
186 if ($routeInfo[0] === Dispatcher::FOUND) {
187 $moduleClass = $routeInfo[1];
188 $this->parameters = $routeInfo[2];
189 } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
190 throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
192 throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
199 * Returns the module parameters.
201 * @return array parameters
203 public function getModuleParameters()
205 return $this->parameters;