<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\App;
-
+use Dice\Dice;
use FastRoute\DataGenerator\GroupCountBased;
use FastRoute\Dispatcher;
use FastRoute\RouteCollector;
use FastRoute\RouteParser\Std;
-use Friendica\Module;
+use Friendica\Capabilities\ICanHandleRequests;
+use Friendica\Core\Addon;
+use Friendica\Core\Cache\Enum\Duration;
+use Friendica\Core\Cache\Capability\ICanCache;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\Hook;
+use Friendica\Core\L10n;
+use Friendica\Core\Lock\Capability\ICanLock;
+use Friendica\LegacyModule;
+use Friendica\Module\HTTPException\MethodNotAllowed;
+use Friendica\Module\HTTPException\PageNotFound;
+use Friendica\Module\Special\Options;
+use Friendica\Network\HTTPException;
+use Friendica\Network\HTTPException\MethodNotAllowedException;
+use Friendica\Network\HTTPException\NotFoundException;
+use Friendica\Util\Router\FriendicaGroupCountBased;
+use Psr\Log\LoggerInterface;
/**
* Wrapper for FastRoute\Router
*/
class Router
{
+ const DELETE = 'DELETE';
+ const GET = 'GET';
+ const PATCH = 'PATCH';
+ const POST = 'POST';
+ const PUT = 'PUT';
+ const OPTIONS = 'OPTIONS';
+
+ const ALLOWED_METHODS = [
+ self::DELETE,
+ self::GET,
+ self::PATCH,
+ self::POST,
+ self::PUT,
+ self::OPTIONS
+ ];
+
/** @var RouteCollector */
protected $routeCollector;
/**
- * Static declaration of Friendica routes.
- *
- * Supports:
- * - Route groups
- * - Variable parts
- * Disregards:
- * - HTTP method other than GET
- * - Named parameters
- *
- * Handler must be the name of a class extending Friendica\BaseModule.
- *
- * @brief Static declaration of Friendica routes.
+ * @var array Module parameters
*/
- public function collectRoutes()
- {
- $this->routeCollector->addRoute(['GET'], '[/]', Module\Home::class);
- $this->routeCollector->addGroup('/.well-known', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '/host-meta' , Module\WellKnown\HostMeta::class);
- $collector->addRoute(['GET'], '/nodeinfo[/1.0]' , Module\NodeInfo::class);
- $collector->addRoute(['GET'], '/webfinger' , Module\Xrd::class);
- $collector->addRoute(['GET'], '/x-social-relay' , Module\WellKnown\XSocialRelay::class);
- });
- $this->routeCollector->addGroup('/2fa', function (RouteCollector $collector) {
- $collector->addRoute(['GET', 'POST'], '[/]' , Module\TwoFactor\Verify::class);
- $collector->addRoute(['GET', 'POST'], '/recovery' , Module\TwoFactor\Recovery::class);
- });
- $this->routeCollector->addGroup('/admin', function (RouteCollector $collector) {
- $collector->addRoute(['GET'] , '[/]' , Module\Admin\Summary::class);
+ private $parameters = [];
- $collector->addRoute(['GET', 'POST'], '/addons' , Module\Admin\Addons\Index::class);
- $collector->addRoute(['GET', 'POST'], '/addons/{addon}' , Module\Admin\Addons\Details::class);
+ /** @var L10n */
+ private $l10n;
- $collector->addRoute(['GET', 'POST'], '/blocklist/contact' , Module\Admin\Blocklist\Contact::class);
- $collector->addRoute(['GET', 'POST'], '/blocklist/server' , Module\Admin\Blocklist\Server::class);
+ /** @var ICanCache */
+ private $cache;
- $collector->addRoute(['GET'] , '/dbsync[/check]' , Module\Admin\DBSync::class);
- $collector->addRoute(['GET'] , '/dbsync/{update:\d+}' , Module\Admin\DBSync::class);
- $collector->addRoute(['GET'] , '/dbsync/mark/{update:\d+}', Module\Admin\DBSync::class);
+ /** @var ICanLock */
+ private $lock;
- $collector->addRoute(['GET', 'POST'], '/features' , Module\Admin\Features::class);
- $collector->addRoute(['GET'] , '/federation' , Module\Admin\Federation::class);
+ /** @var Arguments */
+ private $args;
- $collector->addRoute(['GET', 'POST'], '/item/delete' , Module\Admin\Item\Delete::class);
- $collector->addRoute(['GET', 'POST'], '/item/source[/{guid}]' , Module\Admin\Item\Source::class);
+ /** @var IManageConfigValues */
+ private $config;
- $collector->addRoute(['GET'] , '/logs/view' , Module\Admin\Logs\View::class);
- $collector->addRoute(['GET', 'POST'], '/logs' , Module\Admin\Logs\Settings::class);
+ /** @var LoggerInterface */
+ private $logger;
- $collector->addRoute(['GET'] , '/phpinfo' , Module\Admin\PhpInfo::class);
+ /** @var float */
+ private $dice_profiler_threshold;
- $collector->addRoute(['GET'] , '/queue[/deferred]' , Module\Admin\Queue::class);
+ /** @var Dice */
+ private $dice;
- $collector->addRoute(['GET', 'POST'], '/site' , Module\Admin\Site::class);
+ /** @var string */
+ private $baseRoutesFilepath;
- $collector->addRoute(['GET', 'POST'], '/themes' , Module\Admin\Themes\Index::class);
- $collector->addRoute(['GET', 'POST'], '/themes/{theme}' , Module\Admin\Themes\Details::class);
- $collector->addRoute(['GET', 'POST'], '/themes/{theme}/embed' , Module\Admin\Themes\Embed::class);
+ /** @var array */
+ private $server;
- $collector->addRoute(['GET', 'POST'], '/tos' , Module\Admin\Tos::class);
+ /**
+ * @param array $server The $_SERVER variable
+ * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
+ * @param L10n $l10n
+ * @param ICanCache $cache
+ * @param ICanLock $lock
+ * @param IManageConfigValues $config
+ * @param Arguments $args
+ * @param LoggerInterface $logger
+ * @param Dice $dice
+ * @param RouteCollector|null $routeCollector
+ */
+ public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, IManageConfigValues $config, Arguments $args, LoggerInterface $logger, Dice $dice, RouteCollector $routeCollector = null)
+ {
+ $this->baseRoutesFilepath = $baseRoutesFilepath;
+ $this->l10n = $l10n;
+ $this->cache = $cache;
+ $this->lock = $lock;
+ $this->args = $args;
+ $this->config = $config;
+ $this->dice = $dice;
+ $this->server = $server;
+ $this->logger = $logger;
+ $this->dice_profiler_threshold = $config->get('system', 'dice_profiler_threshold', 0);
- $collector->addRoute(['GET', 'POST'], '/users[/{action}/{uid}]' , Module\Admin\Users::class);
- });
- $this->routeCollector->addRoute(['GET'], '/amcd', Module\AccountManagementControlDocument::class);
- $this->routeCollector->addRoute(['GET'], '/acctlink', Module\Acctlink::class);
- $this->routeCollector->addRoute(['GET'], '/allfriends/{id:\d+}', Module\AllFriends::class);
- $this->routeCollector->addRoute(['GET'], '/apps', Module\Apps::class);
- $this->routeCollector->addRoute(['GET'], '/attach/{item:\d+}', Module\Attach::class);
- $this->routeCollector->addRoute(['GET'], '/babel', Module\Debug\Babel::class);
- $this->routeCollector->addRoute(['GET'], '/bookmarklet', Module\Bookmarklet::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/compose[/{type}]', Module\Item\Compose::class);
- $this->routeCollector->addGroup('/contact', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '[/]', Module\Contact::class);
- $collector->addRoute(['GET', 'POST'], '/{id:\d+}[/]', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/archive', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/block', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/conversations', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/drop', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/ignore', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/posts', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/update', Module\Contact::class);
- $collector->addRoute(['GET'], '/{id:\d+}/updateprofile', Module\Contact::class);
- $collector->addRoute(['GET'], '/archived', Module\Contact::class);
- $collector->addRoute(['GET', 'POST'], '/batch', Module\Contact::class);
- $collector->addRoute(['GET'], '/blocked', Module\Contact::class);
- $collector->addRoute(['GET'], '/hidden', Module\Contact::class);
- $collector->addRoute(['GET'], '/ignored', Module\Contact::class);
- });
- $this->routeCollector->addRoute(['GET'], '/credits', Module\Credits::class);
- $this->routeCollector->addRoute(['GET'], '/dirfind', Module\Search\Directory::class);
- $this->routeCollector->addRoute(['GET'], '/directory', Module\Directory::class);
- $this->routeCollector->addGroup('/feed', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '/{nickname}', Module\Feed::class);
- $collector->addRoute(['GET'], '/{nickname}/posts', Module\Feed::class);
- $collector->addRoute(['GET'], '/{nickname}/comments', Module\Feed::class);
- $collector->addRoute(['GET'], '/{nickname}/replies', Module\Feed::class);
- $collector->addRoute(['GET'], '/{nickname}/activity', Module\Feed::class);
- });
- $this->routeCollector->addRoute(['GET'], '/feedtest', Module\Debug\Feed::class);
- $this->routeCollector->addGroup('/fetch', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '/post/{guid}', Module\Diaspora\Fetch::class);
- $collector->addRoute(['GET'], '/status_message/{guid}', Module\Diaspora\Fetch::class);
- $collector->addRoute(['GET'], '/reshare/{guid}', Module\Diaspora\Fetch::class);
- });
- $this->routeCollector->addRoute(['GET'], '/filer[/{id:\d+}]', Module\Filer\SaveTag::class);
- $this->routeCollector->addRoute(['GET'], '/filerm/{id:\d+}', Module\Filer\RemoveTag::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/follow_confirm', Module\FollowConfirm::class);
- $this->routeCollector->addRoute(['GET'], '/followers/{owner}', Module\Followers::class);
- $this->routeCollector->addRoute(['GET'], '/following/{owner}', Module\Following::class);
- $this->routeCollector->addRoute(['GET'], '/friendica[/json]', Module\Friendica::class);
- $this->routeCollector->addGroup('/group', function (RouteCollector $collector) {
- $collector->addRoute(['GET', 'POST'], '[/]', Module\Group::class);
- $collector->addRoute(['GET', 'POST'], '/{group:\d+}', Module\Group::class);
- $collector->addRoute(['GET', 'POST'], '/none', Module\Group::class);
- $collector->addRoute(['GET', 'POST'], '/new', Module\Group::class);
- $collector->addRoute(['GET', 'POST'], '/drop/{group:\d+}', Module\Group::class);
- $collector->addRoute(['GET', 'POST'], '/{group:\d+}/{contact:\d+}', Module\Group::class);
-
- $collector->addRoute(['GET', 'POST'], '/{group:\d+}/add/{contact:\d+}', Module\Group::class);
- $collector->addRoute(['GET', 'POST'], '/{group:\d+}/remove/{contact:\d+}', Module\Group::class);
- });
- $this->routeCollector->addRoute(['GET'], '/hashtag', Module\Hashtag::class);
- $this->routeCollector->addRoute(['GET'], '/home', Module\Home::class);
- $this->routeCollector->addRoute(['GET'], '/help[/{doc:.+}]', Module\Help::class);
- $this->routeCollector->addRoute(['GET'], '/inbox[/{nickname}]', Module\Inbox::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/invite', Module\Invite::class);
- $this->routeCollector->addGroup('/install', function (RouteCollector $collector) {
- $collector->addRoute(['GET', 'POST'], '[/]', Module\Install::class);
- $collector->addRoute(['GET'], '/testrewrite', Module\Install::class);
- });
- $this->routeCollector->addRoute(['GET'], '/like/{item:\d+}', Module\Like::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/localtime', Module\Debug\Localtime::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/login', Module\Login::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/logout', Module\Logout::class);
- $this->routeCollector->addRoute(['GET'], '/magic', Module\Magic::class);
- $this->routeCollector->addRoute(['GET'], '/maintenance', Module\Maintenance::class);
- $this->routeCollector->addRoute(['GET'], '/manifest', Module\Manifest::class);
- $this->routeCollector->addRoute(['GET'], '/modexp/{nick}', Module\PublicRSAKey::class);
- $this->routeCollector->addRoute(['GET'], '/newmember', Module\Welcome::class);
- $this->routeCollector->addRoute(['GET'], '/nodeinfo/1.0', Module\NodeInfo::class);
- $this->routeCollector->addRoute(['GET'], '/nogroup', Module\Group::class);
- $this->routeCollector->addGroup('/notify', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '[/]', Module\Notifications\Notify::class);
- $collector->addRoute(['GET'], '/view/{id:\d+}', Module\Notifications\Notify::class);
- $collector->addRoute(['GET'], '/mark/all', Module\Notifications\Notify::class);
- });
- $this->routeCollector->addRoute(['GET'], '/objects/{guid}', Module\Objects::class);
- $this->routeCollector->addGroup('/oembed', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '/b2h', Module\Oembed::class);
- $collector->addRoute(['GET'], '/h2b', Module\Oembed::class);
- $collector->addRoute(['GET'], '/{hash}', Module\Oembed::class);
- });
- $this->routeCollector->addRoute(['GET'], '/outbox/{owner}', Module\Outbox::class);
- $this->routeCollector->addRoute(['GET'], '/owa', Module\Owa::class);
- $this->routeCollector->addRoute(['GET'], '/opensearch', Module\OpenSearch::class);
- $this->routeCollector->addGroup('/photo', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '/{name}', Module\Photo::class);
- $collector->addRoute(['GET'], '/{type}/{name}', Module\Photo::class);
- $collector->addRoute(['GET'], '/{type}/{customize}/{name}', Module\Photo::class);
- });
- $this->routeCollector->addRoute(['GET'], '/pretheme', Module\ThemeDetails::class);
- $this->routeCollector->addRoute(['GET'], '/probe', Module\Debug\Probe::class);
- $this->routeCollector->addGroup('/profile', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '/{nickname}', Module\Profile::class);
- $collector->addRoute(['GET'], '/{nickname}/{to:\d{4}-\d{2}-\d{2}}/{from:\d{4}-\d{2}-\d{2}}', Module\Profile::class);
- $collector->addRoute(['GET'], '/{nickname}/contacts[/{type}]', Module\Profile\Contacts::class);
- $collector->addRoute(['GET'], '/{profile:\d+}/view', Module\Profile::class);
- });
- $this->routeCollector->addGroup('/proxy', function (RouteCollector $collector) {
- $collector->addRoute(['GET'], '[/]' , Module\Proxy::class);
- $collector->addRoute(['GET'], '/{url}' , Module\Proxy::class);
- $collector->addRoute(['GET'], '/{sub1}/{url}' , Module\Proxy::class);
- $collector->addRoute(['GET'], '/{sub1}/{sub2}/{url}' , Module\Proxy::class);
- });
+ $this->routeCollector = $routeCollector ?? new RouteCollector(new Std(), new GroupCountBased());
+
+ if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
+ throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
+ }
+ }
+
+ /**
+ * This will be called either automatically if a base routes file path was submitted,
+ * or can be called manually with a custom route array.
+ *
+ * @param array $routes The routes to add to the Router
+ *
+ * @return self The router instance with the loaded routes
+ *
+ * @throws HTTPException\InternalServerErrorException In case of invalid configs
+ */
+ public function loadRoutes(array $routes)
+ {
+ $routeCollector = ($this->routeCollector ?? new RouteCollector(new Std(), new GroupCountBased()));
+
+ $this->addRoutes($routeCollector, $routes);
- $this->routeCollector->addGroup('/settings', function (RouteCollector $collector) {
- $collector->addGroup('/2fa', function (RouteCollector $collector) {
- $collector->addRoute(['GET', 'POST'], '[/]' , Module\Settings\TwoFactor\Index::class);
- $collector->addRoute(['GET', 'POST'], '/recovery' , Module\Settings\TwoFactor\Recovery::class);
- $collector->addRoute(['GET', 'POST'], '/app_specific' , Module\Settings\TwoFactor\AppSpecific::class);
- $collector->addRoute(['GET', 'POST'], '/verify' , Module\Settings\TwoFactor\Verify::class);
- });
+ $this->routeCollector = $routeCollector;
+
+ // Add routes from addons
+ Hook::callAll('route_collection', $this->routeCollector);
+
+ return $this;
+ }
+
+ private function addRoutes(RouteCollector $routeCollector, array $routes)
+ {
+ foreach ($routes as $route => $config) {
+ if ($this->isGroup($config)) {
+ $this->addGroup($route, $config, $routeCollector);
+ } elseif ($this->isRoute($config)) {
+ // Always add the OPTIONS endpoint to a route
+ $httpMethods = (array) $config[1];
+ $httpMethods[] = Router::OPTIONS;
+ $routeCollector->addRoute($httpMethods, $route, $config[0]);
+ } else {
+ throw new HTTPException\InternalServerErrorException("Wrong route config for route '" . print_r($route, true) . "'");
+ }
+ }
+ }
+
+ /**
+ * Adds a group of routes to a given group
+ *
+ * @param string $groupRoute The route of the group
+ * @param array $routes The routes of the group
+ * @param RouteCollector $routeCollector The route collector to add this group
+ */
+ private function addGroup(string $groupRoute, array $routes, RouteCollector $routeCollector)
+ {
+ $routeCollector->addGroup($groupRoute, function (RouteCollector $routeCollector) use ($routes) {
+ $this->addRoutes($routeCollector, $routes);
});
- $this->routeCollector->addRoute(['GET'], '/randprof', Module\RandomProfile::class);
- $this->routeCollector->addRoute(['GET', 'POST'], '/register', Module\Register::class);
- $this->routeCollector->addRoute(['GET'], '/robots.txt', Module\RobotsTxt::class);
- $this->routeCollector->addRoute(['GET'], '/rsd.xml', Module\ReallySimpleDiscovery::class);
- $this->routeCollector->addRoute(['GET'], '/smilies[/json]', Module\Smilies::class);
- $this->routeCollector->addRoute(['GET'], '/statistics.json', Module\Statistics::class);
- $this->routeCollector->addRoute(['GET'], '/starred/{item:\d+}', Module\Starred::class);
- $this->routeCollector->addRoute(['GET'], '/toggle_mobile', Module\ToggleMobile::class);
- $this->routeCollector->addRoute(['GET'], '/tos', Module\Tos::class);
- $this->routeCollector->addRoute(['GET'], '/view/theme/{theme}/style.pcss', Module\Theme::class);
- $this->routeCollector->addRoute(['GET'], '/viewsrc/{item:\d+}', Module\Debug\ItemBody::class);
- $this->routeCollector->addRoute(['GET'], '/webfinger', Module\Debug\WebFinger::class);
- $this->routeCollector->addRoute(['GET'], '/xrd', Module\Xrd::class);
}
- public function __construct()
+ /**
+ * Returns true in case the config is a group config
+ *
+ * @param array $config
+ *
+ * @return bool
+ */
+ private function isGroup(array $config)
+ {
+ return
+ is_array($config) &&
+ is_string(array_keys($config)[0]) &&
+ // This entry should NOT be a BaseModule
+ (substr(array_keys($config)[0], 0, strlen('Friendica\Module')) !== 'Friendica\Module') &&
+ // The second argument is an array (another routes)
+ is_array(array_values($config)[0]);
+ }
+
+ /**
+ * Returns true in case the config is a route config
+ *
+ * @param array $config
+ *
+ * @return bool
+ */
+ private function isRoute(array $config)
{
- $this->routeCollector = new RouteCollector(new Std(), new GroupCountBased());
+ return
+ // The config array should at least have one entry
+ !empty($config[0]) &&
+ // This entry should be a BaseModule
+ (substr($config[0], 0, strlen('Friendica\Module')) === 'Friendica\Module') &&
+ // Either there is no other argument
+ (empty($config[1]) ||
+ // Or the second argument is an array (HTTP-Methods)
+ is_array($config[1]));
}
+ /**
+ * The current route collector
+ *
+ * @return RouteCollector|null
+ */
public function getRouteCollector()
{
return $this->routeCollector;
/**
* Returns the relevant module class name for the given page URI or NULL if no route rule matched.
*
- * @param string $cmd The path component of the request URL without the query string
- * @return string|null A Friendica\BaseModule-extending class name if a route rule matched
+ * @return string A Friendica\BaseModule-extending class name if a route rule matched
+ *
+ * @throws HTTPException\InternalServerErrorException
+ * @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't
+ * @throws HTTPException\NotFoundException If no rule matched
*/
- public function getModuleClass($cmd)
+ private function getModuleClass()
{
+ $cmd = $this->args->getCommand();
$cmd = '/' . ltrim($cmd, '/');
- $dispatcher = new \FastRoute\Dispatcher\GroupCountBased($this->routeCollector->getData());
+ $dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
- $moduleClass = null;
+ $this->parameters = [];
- // @TODO: Enable method-specific modules
- $httpMethod = 'GET';
- $routeInfo = $dispatcher->dispatch($httpMethod, $cmd);
- if ($routeInfo[0] === Dispatcher::FOUND) {
- $moduleClass = $routeInfo[1];
+ // Check if the HTTP method ist OPTIONS and return the special Options Module with the possible HTTP methods
+ if ($this->args->getMethod() === static::OPTIONS) {
+ $routeOptions = $dispatcher->getOptions($cmd);
+
+ $moduleClass = Options::class;
+ $this->parameters = ['allowedMethods' => $routeOptions];
+ } else {
+ $routeInfo = $dispatcher->dispatch($this->args->getMethod(), $cmd);
+ if ($routeInfo[0] === Dispatcher::FOUND) {
+ $moduleClass = $routeInfo[1];
+ $this->parameters = $routeInfo[2];
+ } elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
+ throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
+ } else {
+ throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
+ }
}
return $moduleClass;
}
+
+ public function getModule(?string $module_class = null): ICanHandleRequests
+ {
+ $module_parameters = [$this->server];
+ /**
+ * ROUTING
+ *
+ * From the request URL, routing consists of obtaining the name of a BaseModule-extending class of which the
+ * post() and/or content() static methods can be respectively called to produce a data change or an output.
+ **/
+ try {
+ $module_class = $module_class ?? $this->getModuleClass();
+ $module_parameters[] = $this->parameters;
+ } catch (MethodNotAllowedException $e) {
+ $module_class = MethodNotAllowed::class;
+ } catch (NotFoundException $e) {
+ $moduleName = $this->args->getModuleName();
+ // Then we try addon-provided modules that we wrap in the LegacyModule class
+ if (Addon::isEnabled($moduleName) && file_exists("addon/{$moduleName}/{$moduleName}.php")) {
+ //Check if module is an app and if public access to apps is allowed or not
+ $privateapps = $this->config->get('config', 'private_addons', false);
+ if ((!local_user()) && Hook::isAddonApp($moduleName) && $privateapps) {
+ throw new MethodNotAllowedException($this->l10n->t("You must be logged in to use addons. "));
+ } else {
+ include_once "addon/{$moduleName}/{$moduleName}.php";
+ if (function_exists($moduleName . '_module')) {
+ $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
+ $module_class = LegacyModule::class;
+ }
+ }
+ }
+
+ /* Finally, we look for a 'standard' program module in the 'mod' directory
+ * We emulate a Module class through the LegacyModule class
+ */
+ if (!$module_class && file_exists("mod/{$moduleName}.php")) {
+ $module_parameters[] = "mod/{$moduleName}.php";
+ $module_class = LegacyModule::class;
+ }
+
+ $module_class = $module_class ?: PageNotFound::class;
+ }
+
+ $stamp = microtime(true);
+
+ try {
+ /** @var ICanHandleRequests $module */
+ return $this->dice->create($module_class, $module_parameters);
+ } finally {
+ if ($this->dice_profiler_threshold > 0) {
+ $dur = floatval(microtime(true) - $stamp);
+ if ($dur >= $this->dice_profiler_threshold) {
+ $this->logger->warning('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $module_class, 'parameters' => $module_parameters]);
+ }
+ }
+ }
+ }
+
+ /**
+ * If a base routes file path has been provided, we can load routes from it if the cache misses.
+ *
+ * @return array
+ * @throws HTTPException\InternalServerErrorException
+ */
+ private function getDispatchData()
+ {
+ $dispatchData = [];
+
+ if ($this->baseRoutesFilepath) {
+ $dispatchData = require $this->baseRoutesFilepath;
+ if (!is_array($dispatchData)) {
+ throw new HTTPException\InternalServerErrorException('Invalid base routes file');
+ }
+ }
+
+ $this->loadRoutes($dispatchData);
+
+ return $this->routeCollector->getData();
+ }
+
+ /**
+ * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
+ * takes about 850ms for each requests.
+ *
+ * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
+ * is any changes in the enabled addons list.
+ *
+ * Additionally, we check for the base routes file last modification time to automatically
+ * trigger re-computing the dispatch data.
+ *
+ * @return array|mixed
+ * @throws HTTPException\InternalServerErrorException
+ */
+ private function getCachedDispatchData()
+ {
+ $routerDispatchData = $this->cache->get('routerDispatchData');
+ $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
+ $forceRecompute = false;
+
+ if ($this->baseRoutesFilepath) {
+ $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
+ $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
+ }
+
+ if (!$forceRecompute && $routerDispatchData) {
+ return $routerDispatchData;
+ }
+
+ if (!$this->lock->acquire('getCachedDispatchData', 0)) {
+ // Immediately return uncached data when we can't aquire a lock
+ return $this->getDispatchData();
+ }
+
+ $routerDispatchData = $this->getDispatchData();
+
+ $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
+ if (!empty($routesFileModifiedTime)) {
+ $this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
+ }
+
+ if ($this->lock->isLocked('getCachedDispatchData')) {
+ $this->lock->release('getCachedDispatchData');
+ }
+
+ return $routerDispatchData;
+ }
}
projects / friendica.git / blobdiff