3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\App;
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\LegacyModule;
38 use Friendica\Module\HTTPException\MethodNotAllowed;
39 use Friendica\Module\HTTPException\PageNotFound;
40 use Friendica\Network\HTTPException;
41 use Friendica\Network\HTTPException\MethodNotAllowedException;
42 use Friendica\Network\HTTPException\NoContentException;
43 use Friendica\Network\HTTPException\NotFoundException;
46 * Wrapper for FastRoute\Router
48 * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
51 * Actual routes are defined in App->collectRoutes.
53 * @package Friendica\App
57 const DELETE = 'DELETE';
59 const PATCH = 'PATCH';
62 const OPTIONS = 'OPTIONS';
64 const ALLOWED_METHODS = [
73 /** @var RouteCollector */
74 protected $routeCollector;
77 * @var string The HTTP method
82 * @var array Module parameters
84 private $parameters = [];
98 /** @var IManageConfigValues */
105 private $baseRoutesFilepath;
111 * @param array $server The $_SERVER variable
112 * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
114 * @param ICanCache $cache
115 * @param ICanLock $lock
116 * @param IManageConfigValues $config
117 * @param Arguments $args
119 * @param RouteCollector|null $routeCollector
121 public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, IManageConfigValues $config, Arguments $args, Dice $dice, RouteCollector $routeCollector = null)
123 $this->baseRoutesFilepath = $baseRoutesFilepath;
125 $this->cache = $cache;
128 $this->config = $config;
130 $this->server = $server;
132 $httpMethod = $this->server['REQUEST_METHOD'] ?? self::GET;
134 // @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
135 // @todo Check allowed methods per requested path
136 if ($httpMethod === static::OPTIONS) {
137 header('Allow: ' . implode(',', Router::ALLOWED_METHODS));
138 throw new NoContentException();
141 $this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
143 $this->routeCollector = isset($routeCollector) ?
145 new RouteCollector(new Std(), new GroupCountBased());
147 if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
148 throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
153 * This will be called either automatically if a base routes file path was submitted,
154 * or can be called manually with a custom route array.
156 * @param array $routes The routes to add to the Router
158 * @return self The router instance with the loaded routes
160 * @throws HTTPException\InternalServerErrorException In case of invalid configs
162 public function loadRoutes(array $routes)
164 $routeCollector = (isset($this->routeCollector) ?
165 $this->routeCollector :
166 new RouteCollector(new Std(), new GroupCountBased()));
168 $this->addRoutes($routeCollector, $routes);
170 $this->routeCollector = $routeCollector;
172 // Add routes from addons
173 Hook::callAll('route_collection', $this->routeCollector);
178 private function addRoutes(RouteCollector $routeCollector, array $routes)
180 foreach ($routes as $route => $config) {
181 if ($this->isGroup($config)) {
182 $this->addGroup($route, $config, $routeCollector);
183 } elseif ($this->isRoute($config)) {
184 $routeCollector->addRoute($config[1], $route, $config[0]);
186 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
192 * Adds a group of routes to a given group
194 * @param string $groupRoute The route of the group
195 * @param array $routes The routes of the group
196 * @param RouteCollector $routeCollector The route collector to add this group
198 private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
200 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
201 $this->addRoutes($routeCollector, $routes);
206 * Returns true in case the config is a group config
208 * @param array $config
212 private function isGroup(array $config)
216 is_string(array_keys($config)[0]) &&
217 // This entry should NOT be a BaseModule
218 (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
219 // The second argument is an array (another routes)
220 is_array(array_values($config)[0]);
224 * Returns true in case the config is a route config
226 * @param array $config
230 private function isRoute(array $config)
233 // The config array should at least have one entry
234 !empty($config[0]) &&
235 // This entry should be a BaseModule
236 (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
237 // Either there is no other argument
238 (empty($config[1]) ||
239 // Or the second argument is an array (HTTP-Methods)
240 is_array($config[1]));
244 * The current route collector
246 * @return RouteCollector|null
248 public function getRouteCollector()
250 return $this->routeCollector;
254 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
256 * @return string A Friendica\BaseModule-extending class name if a route rule matched
258 * @throws HTTPException\InternalServerErrorException
259 * @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't
260 * @throws HTTPException\NotFoundException If no rule matched
262 private function getModuleClass()
264 $cmd = $this->args->getCommand();
265 $cmd = '/' . ltrim($cmd, '/');
267 $dispatcher = new Dispatcher\GroupCountBased($this->getCachedDispatchData());
269 $this->parameters = [];
271 $routeInfo = $dispatcher->dispatch($this->httpMethod, $cmd);
272 if ($routeInfo[0] === Dispatcher::FOUND) {
273 $moduleClass = $routeInfo[1];
274 $this->parameters = $routeInfo[2];
275 } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
276 throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
278 throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
284 public function getModule(?string $module_class = null): ICanHandleRequests
286 $module_parameters = [$this->server];
290 * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
291 * post() and/or content() static methods can be respectively called to produce a data change or an output.
294 $module_class = $module_class ?? $this->getModuleClass();
295 $module_parameters[] = $this->parameters;
296 } catch (MethodNotAllowedException $e) {
297 $module_class = MethodNotAllowed::class;
298 } catch (NotFoundException $e) {
299 $moduleName = $this->args->getModuleName();
300 // Then we try addon-provided modules that we wrap in the LegacyModule class
301 if (Addon::isEnabled($moduleName) && file_exists("addon/{$moduleName}/{$moduleName}.php")) {
302 //Check if module is an app and if public access to apps is allowed or not
303 $privateapps = $this->config->get('config', 'private_addons', false);
304 if ((!local_user()) && Hook::isAddonApp($moduleName) && $privateapps) {
305 throw new MethodNotAllowedException($this->l10n->t("You must be logged in to use addons. "));
307 include_once "addon/{$moduleName}/{$moduleName}.php";
308 if (function_exists($moduleName . '_module')) {
309 $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
310 $module_class = LegacyModule::class;
315 /* Finally, we look for a 'standard' program module in the 'mod' directory
316 * We emulate a Module class through the LegacyModule class
318 if (!$module_class && file_exists("mod/{$moduleName}.php")) {
319 $module_parameters[] = "mod/{$moduleName}.php";
320 $module_class = LegacyModule::class;
323 $module_class = $module_class ?: PageNotFound::class;
326 /** @var ICanHandleRequests $module */
327 return $this->dice->create($module_class, $module_parameters);
331 * If a base routes file path has been provided, we can load routes from it if the cache misses.
334 * @throws HTTPException\InternalServerErrorException
336 private function getDispatchData()
340 if ($this->baseRoutesFilepath) {
341 $dispatchData = require $this->baseRoutesFilepath;
342 if (!is_array($dispatchData)) {
343 throw new HTTPException\InternalServerErrorException('Invalid base routes file');
347 $this->loadRoutes($dispatchData);
349 return $this->routeCollector->getData();
353 * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
354 * takes about 850ms for each requests.
356 * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
357 * is any changes in the enabled addons list.
359 * Additionally, we check for the base routes file last modification time to automatically
360 * trigger re-computing the dispatch data.
362 * @return array|mixed
363 * @throws HTTPException\InternalServerErrorException
365 private function getCachedDispatchData()
367 $routerDispatchData = $this->cache->get('routerDispatchData');
368 $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
369 $forceRecompute = false;
371 if ($this->baseRoutesFilepath) {
372 $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
373 $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
376 if (!$forceRecompute && $routerDispatchData) {
377 return $routerDispatchData;
380 if (!$this->lock->acquire('getCachedDispatchData', 0)) {
381 // Immediately return uncached data when we can't aquire a lock
382 return $this->getDispatchData();
385 $routerDispatchData = $this->getDispatchData();
387 $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
388 if (!empty($routesFileModifiedTime)) {
389 $this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
392 if ($this->lock->isLocked('getCachedDispatchData')) {
393 $this->lock->release('getCachedDispatchData');
396 return $routerDispatchData;