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\NotFoundException;
45 * Wrapper for FastRoute\Router
47 * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
50 * Actual routes are defined in App->collectRoutes.
52 * @package Friendica\App
56 const DELETE = 'DELETE';
58 const PATCH = 'PATCH';
61 const OPTIONS = 'OPTIONS';
63 const ALLOWED_METHODS = [
72 /** @var RouteCollector */
73 protected $routeCollector;
76 * @var string The HTTP method
81 * @var array Module parameters
83 private $parameters = [];
97 /** @var IManageConfigValues */
104 private $baseRoutesFilepath;
107 * @param array $server The $_SERVER variable
108 * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
110 * @param ICanCache $cache
111 * @param ICanLock $lock
112 * @param IManageConfigValues $config
113 * @param Arguments $args
115 * @param RouteCollector|null $routeCollector
117 public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, IManageConfigValues $config, Arguments $args, Dice $dice, RouteCollector $routeCollector = null)
119 $this->baseRoutesFilepath = $baseRoutesFilepath;
121 $this->cache = $cache;
124 $this->config = $config;
127 $httpMethod = $server['REQUEST_METHOD'] ?? self::GET;
128 $this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
130 $this->routeCollector = isset($routeCollector) ?
132 new RouteCollector(new Std(), new GroupCountBased());
134 if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
135 throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
140 * This will be called either automatically if a base routes file path was submitted,
141 * or can be called manually with a custom route array.
143 * @param array $routes The routes to add to the Router
145 * @return self The router instance with the loaded routes
147 * @throws HTTPException\InternalServerErrorException In case of invalid configs
149 public function loadRoutes(array $routes)
151 $routeCollector = (isset($this->routeCollector) ?
152 $this->routeCollector :
153 new RouteCollector(new Std(), new GroupCountBased()));
155 $this->addRoutes($routeCollector, $routes);
157 $this->routeCollector = $routeCollector;
159 // Add routes from addons
160 Hook::callAll('route_collection', $this->routeCollector);
165 private function addRoutes(RouteCollector $routeCollector, array $routes)
167 foreach ($routes as $route => $config) {
168 if ($this->isGroup($config)) {
169 $this->addGroup($route, $config, $routeCollector);
170 } elseif ($this->isRoute($config)) {
171 $routeCollector->addRoute($config[1], $route, $config[0]);
173 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
179 * Adds a group of routes to a given group
181 * @param string $groupRoute The route of the group
182 * @param array $routes The routes of the group
183 * @param RouteCollector $routeCollector The route collector to add this group
185 private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
187 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
188 $this->addRoutes($routeCollector, $routes);
193 * Returns true in case the config is a group config
195 * @param array $config
199 private function isGroup(array $config)
203 is_string(array_keys($config)[0]) &&
204 // This entry should NOT be a BaseModule
205 (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
206 // The second argument is an array (another routes)
207 is_array(array_values($config)[0]);
211 * Returns true in case the config is a route config
213 * @param array $config
217 private function isRoute(array $config)
220 // The config array should at least have one entry
221 !empty($config[0]) &&
222 // This entry should be a BaseModule
223 (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
224 // Either there is no other argument
225 (empty($config[1]) ||
226 // Or the second argument is an array (HTTP-Methods)
227 is_array($config[1]));
231 * The current route collector
233 * @return RouteCollector|null
235 public function getRouteCollector()
237 return $this->routeCollector;
241 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
243 * @return string A Friendica\BaseModule-extending class name if a route rule matched
245 * @throws HTTPException\InternalServerErrorException
246 * @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't
247 * @throws HTTPException\NotFoundException If no rule matched
249 private function getModuleClass()
251 $cmd = $this->args->getCommand();
252 $cmd = '/' . ltrim($cmd, '/');
254 $dispatcher = new Dispatcher\GroupCountBased($this->getCachedDispatchData());
257 $this->parameters = [];
259 $routeInfo = $dispatcher->dispatch($this->httpMethod, $cmd);
260 if ($routeInfo[0] === Dispatcher::FOUND) {
261 $moduleClass = $routeInfo[1];
262 $this->parameters = $routeInfo[2];
263 } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
264 throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
266 throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
272 public function getModule(): ICanHandleRequests
274 $module_class = null;
275 $module_parameters = [];
279 * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
280 * post() and/or content() static methods can be respectively called to produce a data change or an output.
283 $module_class = $this->getModuleClass();
284 $module_parameters[] = $this->parameters;
285 } catch (MethodNotAllowedException $e) {
286 $module_class = MethodNotAllowed::class;
287 } catch (NotFoundException $e) {
288 $moduleName = $this->args->getModuleName();
289 // Then we try addon-provided modules that we wrap in the LegacyModule class
290 if (Addon::isEnabled($moduleName) && file_exists("addon/{$moduleName}/{$moduleName}.php")) {
291 //Check if module is an app and if public access to apps is allowed or not
292 $privateapps = $this->config->get('config', 'private_addons', false);
293 if ((!local_user()) && Hook::isAddonApp($moduleName) && $privateapps) {
294 throw new MethodNotAllowedException($this->l10n->t("You must be logged in to use addons. "));
296 include_once "addon/{$moduleName}/{$moduleName}.php";
297 if (function_exists($moduleName . '_module')) {
298 $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
299 $module_class = LegacyModule::class;
304 /* Finally, we look for a 'standard' program module in the 'mod' directory
305 * We emulate a Module class through the LegacyModule class
307 if (!$module_class && file_exists("mod/{$moduleName}.php")) {
308 $module_parameters[] = "mod/{$moduleName}.php";
309 $module_class = LegacyModule::class;
312 $module_class = $module_class ?: PageNotFound::class;
315 /** @var ICanHandleRequests $module */
316 return $this->dice->create($module_class, $module_parameters);
320 * If a base routes file path has been provided, we can load routes from it if the cache misses.
323 * @throws HTTPException\InternalServerErrorException
325 private function getDispatchData()
329 if ($this->baseRoutesFilepath) {
330 $dispatchData = require $this->baseRoutesFilepath;
331 if (!is_array($dispatchData)) {
332 throw new HTTPException\InternalServerErrorException('Invalid base routes file');
336 $this->loadRoutes($dispatchData);
338 return $this->routeCollector->getData();
342 * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
343 * takes about 850ms for each requests.
345 * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
346 * is any changes in the enabled addons list.
348 * Additionally, we check for the base routes file last modification time to automatically
349 * trigger re-computing the dispatch data.
351 * @return array|mixed
352 * @throws HTTPException\InternalServerErrorException
354 private function getCachedDispatchData()
356 $routerDispatchData = $this->cache->get('routerDispatchData');
357 $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
358 $forceRecompute = false;
360 if ($this->baseRoutesFilepath) {
361 $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
362 $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
365 if (!$forceRecompute && $routerDispatchData) {
366 return $routerDispatchData;
369 if (!$this->lock->acquire('getCachedDispatchData', 0)) {
370 // Immediately return uncached data when we can't aquire a lock
371 return $this->getDispatchData();
374 $routerDispatchData = $this->getDispatchData();
376 $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
377 if (!empty($routesFileModifiedTime)) {
378 $this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
381 if ($this->lock->isLocked('getCachedDispatchData')) {
382 $this->lock->release('getCachedDispatchData');
385 return $routerDispatchData;