3 * @copyright Copyright (C) 2010-2022, 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\Core\Session\Capability\IHandleUserSessions;
38 use Friendica\LegacyModule;
39 use Friendica\Module\HTTPException\MethodNotAllowed;
40 use Friendica\Module\HTTPException\PageNotFound;
41 use Friendica\Module\Special\Options;
42 use Friendica\Network\HTTPException;
43 use Friendica\Network\HTTPException\InternalServerErrorException;
44 use Friendica\Network\HTTPException\MethodNotAllowedException;
45 use Friendica\Network\HTTPException\NotFoundException;
46 use Friendica\Util\Router\FriendicaGroupCountBased;
47 use Psr\Log\LoggerInterface;
50 * Wrapper for FastRoute\Router
52 * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
55 * Actual routes are defined in App->collectRoutes.
57 * @package Friendica\App
61 const DELETE = 'DELETE';
63 const PATCH = 'PATCH';
66 const OPTIONS = 'OPTIONS';
68 const ALLOWED_METHODS = [
77 /** @var RouteCollector */
78 protected $routeCollector;
81 * @var array Module parameters
83 protected $parameters = [];
97 /** @var IManageConfigValues */
100 /** @var LoggerInterface */
104 private $isLocalUser;
107 private $dice_profiler_threshold;
113 private $baseRoutesFilepath;
118 /** @var string|null */
119 protected $moduleClass = null;
122 * @param array $server The $_SERVER variable
123 * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
125 * @param ICanCache $cache
126 * @param ICanLock $lock
127 * @param IManageConfigValues $config
128 * @param Arguments $args
129 * @param LoggerInterface $logger
131 * @param IHandleUserSessions $userSession
132 * @param RouteCollector|null $routeCollector
134 public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, IManageConfigValues $config, Arguments $args, LoggerInterface $logger, Dice $dice, IHandleUserSessions $userSession, RouteCollector $routeCollector = null)
136 $this->baseRoutesFilepath = $baseRoutesFilepath;
138 $this->cache = $cache;
141 $this->config = $config;
143 $this->server = $server;
144 $this->logger = $logger;
145 $this->isLocalUser = !empty($userSession->getLocalUserId());
146 $this->dice_profiler_threshold = $config->get('system', 'dice_profiler_threshold', 0);
148 $this->routeCollector = $routeCollector ?? new RouteCollector(new Std(), new GroupCountBased());
150 if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
151 throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
156 * This will be called either automatically if a base routes file path was submitted,
157 * or can be called manually with a custom route array.
159 * @param array $routes The routes to add to the Router
161 * @return self The router instance with the loaded routes
163 * @throws HTTPException\InternalServerErrorException In case of invalid configs
165 public function loadRoutes(array $routes): Router
167 $routeCollector = ($this->routeCollector ?? new RouteCollector(new Std(), new GroupCountBased()));
169 $this->addRoutes($routeCollector, $routes);
171 $this->routeCollector = $routeCollector;
173 // Add routes from addons
174 Hook::callAll('route_collection', $this->routeCollector);
180 * Adds multiple routes to a route collector
182 * @param RouteCollector $routeCollector Route collector instance
183 * @param array $routes Multiple routes to be added
184 * @throws HTTPException\InternalServerErrorException If route was wrong (somehow)
186 private function addRoutes(RouteCollector $routeCollector, array $routes)
188 foreach ($routes as $route => $config) {
189 if ($this->isGroup($config)) {
190 $this->addGroup($route, $config, $routeCollector);
191 } elseif ($this->isRoute($config)) {
192 // Always add the OPTIONS endpoint to a route
193 $httpMethods = (array) $config[1];
194 $httpMethods[] = Router::OPTIONS;
195 $routeCollector->addRoute($httpMethods, $route, $config[0]);
197 throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
203 * Adds a group of routes to a given group
205 * @param string $groupRoute The route of the group
206 * @param array $routes The routes of the group
207 * @param RouteCollector $routeCollector The route collector to add this group
209 private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
211 $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
212 $this->addRoutes($routeCollector, $routes);
217 * Returns true in case the config is a group config
219 * @param array $config
223 private function isGroup(array $config): bool
227 is_string(array_keys($config)[0]) &&
228 // This entry should NOT be a BaseModule
229 (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
230 // The second argument is an array (another routes)
231 is_array(array_values($config)[0]);
235 * Returns true in case the config is a route config
237 * @param array $config
241 private function isRoute(array $config): bool
244 // The config array should at least have one entry
245 !empty($config[0]) &&
246 // This entry should be a BaseModule
247 (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
248 // Either there is no other argument
249 (empty($config[1]) ||
250 // Or the second argument is an array (HTTP-Methods)
251 is_array($config[1]));
255 * The current route collector
257 * @return RouteCollector|null
259 public function getRouteCollector(): ?RouteCollector
261 return $this->routeCollector;
265 * Returns the Friendica\BaseModule-extending class name if a route rule matched
269 * @throws InternalServerErrorException
270 * @throws MethodNotAllowedException
272 public function getModuleClass(): string
274 if (empty($this->moduleClass)) {
275 $this->determineModuleClass();
278 return $this->moduleClass;
282 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
286 * @throws HTTPException\InternalServerErrorException Unexpected exceptions
287 * @throws HTTPException\MethodNotAllowedException If a rule is private only
289 private function determineModuleClass(): void
291 $cmd = $this->args->getCommand();
292 $cmd = '/' . ltrim($cmd, '/');
294 $dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
296 $this->parameters = [$this->server];
299 // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
300 if ($this->args->getMethod() === static::OPTIONS) {
301 $this->moduleClass = Options::class;
302 $this->parameters = ['allowedMethods' => $dispatcher->getOptions($cmd)];
304 $routeInfo = $dispatcher->dispatch($this->args->getMethod(), $cmd);
305 if ($routeInfo[0] === Dispatcher::FOUND) {
306 $this->moduleClass = $routeInfo[1];
307 $this->parameters[] = $routeInfo[2];
308 } else if ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
309 throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
311 throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
314 } catch (MethodNotAllowedException $e) {
315 $this->moduleClass = MethodNotAllowed::class;
316 } catch (NotFoundException $e) {
317 $moduleName = $this->args->getModuleName();
318 // Then we try addon-provided modules that we wrap in the LegacyModule class
319 if (Addon::isEnabled($moduleName) && file_exists("addon/{$moduleName}/{$moduleName}.php")) {
320 //Check if module is an app and if public access to apps is allowed or not
321 $privateapps = $this->config->get('config', 'private_addons', false);
322 if (!$this->isLocalUser && Hook::isAddonApp($moduleName) && $privateapps) {
323 throw new MethodNotAllowedException($this->l10n->t("You must be logged in to use addons. "));
325 include_once "addon/{$moduleName}/{$moduleName}.php";
326 if (function_exists($moduleName . '_module')) {
327 $this->parameters[] = "addon/{$moduleName}/{$moduleName}.php";
328 $this->moduleClass = LegacyModule::class;
333 /* Finally, we look for a 'standard' program module in the 'mod' directory
334 * We emulate a Module class through the LegacyModule class
336 if (!$this->moduleClass && file_exists("mod/{$moduleName}.php")) {
337 $this->parameters[] = "mod/{$moduleName}.php";
338 $this->moduleClass = LegacyModule::class;
341 $this->moduleClass = $this->moduleClass ?: PageNotFound::class;
345 public function getModule(?string $module_class = null): ICanHandleRequests
347 $moduleClass = $module_class ?? $this->getModuleClass();
349 $stamp = microtime(true);
352 /** @var ICanHandleRequests $module */
353 return $this->dice->create($moduleClass, $this->parameters);
355 if ($this->dice_profiler_threshold > 0) {
356 $dur = floatval(microtime(true) - $stamp);
357 if ($dur >= $this->dice_profiler_threshold) {
358 $this->logger->notice('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $moduleClass, 'parameters' => $this->parameters]);
365 * If a base routes file path has been provided, we can load routes from it if the cache misses.
368 * @throws HTTPException\InternalServerErrorException
370 private function getDispatchData()
374 if ($this->baseRoutesFilepath) {
375 $dispatchData = require $this->baseRoutesFilepath;
376 if (!is_array($dispatchData)) {
377 throw new HTTPException\InternalServerErrorException('Invalid base routes file');
381 $this->loadRoutes($dispatchData);
383 return $this->routeCollector->getData();
387 * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
388 * takes about 850ms for each requests.
390 * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
391 * is any changes in the enabled addons list.
393 * Additionally, we check for the base routes file last modification time to automatically
394 * trigger re-computing the dispatch data.
396 * @return array|mixed
397 * @throws HTTPException\InternalServerErrorException
399 private function getCachedDispatchData()
401 $routerDispatchData = $this->cache->get('routerDispatchData');
402 $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
403 $forceRecompute = false;
405 if ($this->baseRoutesFilepath) {
406 $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
407 $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
410 if (!$forceRecompute && $routerDispatchData) {
411 return $routerDispatchData;
414 if (!$this->lock->acquire('getCachedDispatchData', 0)) {
415 // Immediately return uncached data when we can't aquire a lock
416 return $this->getDispatchData();
419 $routerDispatchData = $this->getDispatchData();
421 $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
422 if (!empty($routesFileModifiedTime)) {
423 $this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
426 if ($this->lock->isLocked('getCachedDispatchData')) {
427 $this->lock->release('getCachedDispatchData');
430 return $routerDispatchData;