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;
44 use Psr\Log\LoggerInterface;
47 * Wrapper for FastRoute\Router
49 * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
52 * Actual routes are defined in App->collectRoutes.
54 * @package Friendica\App
58 const DELETE = 'DELETE';
60 const PATCH = 'PATCH';
63 const OPTIONS = 'OPTIONS';
65 const ALLOWED_METHODS = [
74 /** @var RouteCollector */
75 protected $routeCollector;
78 * @var string The HTTP method
83 * @var array Module parameters
85 private $parameters = [];
99 /** @var IManageConfigValues */
102 /** @var LoggerInterface */
106 private $dice_profiler_threshold;
112 private $baseRoutesFilepath;
118 * @param array $server The $_SERVER variable
119 * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
121 * @param ICanCache $cache
122 * @param ICanLock $lock
123 * @param IManageConfigValues $config
124 * @param Arguments $args
125 * @param LoggerInterface $logger
127 * @param RouteCollector|null $routeCollector
129 public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, IManageConfigValues $config, Arguments $args, LoggerInterface $logger, Dice $dice, RouteCollector $routeCollector = null)
131 $this->baseRoutesFilepath = $baseRoutesFilepath;
133 $this->cache = $cache;
136 $this->config = $config;
138 $this->server = $server;
139 $this->logger = $logger;
140 $this->dice_profiler_threshold = $config->get('system', 'dice_profiler_threshold', 0);
142 $httpMethod = $this->server['REQUEST_METHOD'] ?? self::GET;
144 // @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
145 // @todo Check allowed methods per requested path
146 if ($httpMethod === static::OPTIONS) {
147 header('Allow: ' . implode(',', Router::ALLOWED_METHODS));
148 throw new NoContentException();
151 $this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
153 $this->routeCollector = isset($routeCollector) ?
155 new RouteCollector(new Std(), new GroupCountBased());
157 if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
158 throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
163 * This will be called either automatically if a base routes file path was submitted,
164 * or can be called manually with a custom route array.
166 * @param array $routes The routes to add to the Router
168 * @return self The router instance with the loaded routes
170 * @throws HTTPException\InternalServerErrorException In case of invalid configs
172 public function loadRoutes(array $routes)
174 $routeCollector = (isset($this->routeCollector) ?
175 $this->routeCollector :
176 new RouteCollector(new Std(), new GroupCountBased()));
178 $this->addRoutes($routeCollector, $routes);
180 $this->routeCollector = $routeCollector;
182 // Add routes from addons
183 Hook::callAll('route_collection', $this->routeCollector);
188 private function addRoutes(RouteCollector $routeCollector, array $routes)
190 foreach ($routes as $route => $config) {
191 if ($this->isGroup($config)) {
192 $this->addGroup($route, $config, $routeCollector);
193 } elseif ($this->isRoute($config)) {
194 $routeCollector->addRoute($config[1], $route, $config[0]);
196 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
202 * Adds a group of routes to a given group
204 * @param string $groupRoute The route of the group
205 * @param array $routes The routes of the group
206 * @param RouteCollector $routeCollector The route collector to add this group
208 private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
210 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
211 $this->addRoutes($routeCollector, $routes);
216 * Returns true in case the config is a group config
218 * @param array $config
222 private function isGroup(array $config)
226 is_string(array_keys($config)[0]) &&
227 // This entry should NOT be a BaseModule
228 (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
229 // The second argument is an array (another routes)
230 is_array(array_values($config)[0]);
234 * Returns true in case the config is a route config
236 * @param array $config
240 private function isRoute(array $config)
243 // The config array should at least have one entry
244 !empty($config[0]) &&
245 // This entry should be a BaseModule
246 (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
247 // Either there is no other argument
248 (empty($config[1]) ||
249 // Or the second argument is an array (HTTP-Methods)
250 is_array($config[1]));
254 * The current route collector
256 * @return RouteCollector|null
258 public function getRouteCollector()
260 return $this->routeCollector;
264 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
266 * @return string A Friendica\BaseModule-extending class name if a route rule matched
268 * @throws HTTPException\InternalServerErrorException
269 * @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't
270 * @throws HTTPException\NotFoundException If no rule matched
272 private function getModuleClass()
274 $cmd = $this->args->getCommand();
275 $cmd = '/' . ltrim($cmd, '/');
277 $dispatcher = new Dispatcher\GroupCountBased($this->getCachedDispatchData());
279 $this->parameters = [];
281 $routeInfo = $dispatcher->dispatch($this->httpMethod, $cmd);
282 if ($routeInfo[0] === Dispatcher::FOUND) {
283 $moduleClass = $routeInfo[1];
284 $this->parameters = $routeInfo[2];
285 } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
286 throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
288 throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
294 public function getModule(?string $module_class = null): ICanHandleRequests
296 $module_parameters = [$this->server];
300 * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
301 * post() and/or content() static methods can be respectively called to produce a data change or an output.
304 $module_class = $module_class ?? $this->getModuleClass();
305 $module_parameters[] = $this->parameters;
306 } catch (MethodNotAllowedException $e) {
307 $module_class = MethodNotAllowed::class;
308 } catch (NotFoundException $e) {
309 $moduleName = $this->args->getModuleName();
310 // Then we try addon-provided modules that we wrap in the LegacyModule class
311 if (Addon::isEnabled($moduleName) && file_exists("addon/{$moduleName}/{$moduleName}.php")) {
312 //Check if module is an app and if public access to apps is allowed or not
313 $privateapps = $this->config->get('config', 'private_addons', false);
314 if ((!local_user()) && Hook::isAddonApp($moduleName) && $privateapps) {
315 throw new MethodNotAllowedException($this->l10n->t("You must be logged in to use addons. "));
317 include_once "addon/{$moduleName}/{$moduleName}.php";
318 if (function_exists($moduleName . '_module')) {
319 $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
320 $module_class = LegacyModule::class;
325 /* Finally, we look for a 'standard' program module in the 'mod' directory
326 * We emulate a Module class through the LegacyModule class
328 if (!$module_class && file_exists("mod/{$moduleName}.php")) {
329 $module_parameters[] = "mod/{$moduleName}.php";
330 $module_class = LegacyModule::class;
333 $module_class = $module_class ?: PageNotFound::class;
336 $stamp = microtime(true);
339 /** @var ICanHandleRequests $module */
340 return $this->dice->create($module_class, $module_parameters);
342 if ($this->dice_profiler_threshold > 0) {
343 $dur = floatval(microtime(true) - $stamp);
344 if ($dur >= $this->dice_profiler_threshold) {
345 $this->logger->warning('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $module_class, 'parameters' => $module_parameters]);
352 * If a base routes file path has been provided, we can load routes from it if the cache misses.
355 * @throws HTTPException\InternalServerErrorException
357 private function getDispatchData()
361 if ($this->baseRoutesFilepath) {
362 $dispatchData = require $this->baseRoutesFilepath;
363 if (!is_array($dispatchData)) {
364 throw new HTTPException\InternalServerErrorException('Invalid base routes file');
368 $this->loadRoutes($dispatchData);
370 return $this->routeCollector->getData();
374 * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
375 * takes about 850ms for each requests.
377 * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
378 * is any changes in the enabled addons list.
380 * Additionally, we check for the base routes file last modification time to automatically
381 * trigger re-computing the dispatch data.
383 * @return array|mixed
384 * @throws HTTPException\InternalServerErrorException
386 private function getCachedDispatchData()
388 $routerDispatchData = $this->cache->get('routerDispatchData');
389 $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
390 $forceRecompute = false;
392 if ($this->baseRoutesFilepath) {
393 $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
394 $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
397 if (!$forceRecompute && $routerDispatchData) {
398 return $routerDispatchData;
401 if (!$this->lock->acquire('getCachedDispatchData', 0)) {
402 // Immediately return uncached data when we can't aquire a lock
403 return $this->getDispatchData();
406 $routerDispatchData = $this->getDispatchData();
408 $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
409 if (!empty($routesFileModifiedTime)) {
410 $this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
413 if ($this->lock->isLocked('getCachedDispatchData')) {
414 $this->lock->release('getCachedDispatchData');
417 return $routerDispatchData;