<?php
/**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
namespace Friendica\App;
-
+use Dice\Dice;
use FastRoute\DataGenerator\GroupCountBased;
use FastRoute\Dispatcher;
use FastRoute\RouteCollector;
use FastRoute\RouteParser\Std;
-use Friendica\Core\Cache\Duration;
-use Friendica\Core\Cache\ICache;
+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 Psr\Log\LoggerInterface;
/**
* Wrapper for FastRoute\Router
*/
class Router
{
- const POST = 'POST';
- const GET = 'GET';
+ const DELETE = 'DELETE';
+ const GET = 'GET';
+ const PATCH = 'PATCH';
+ const POST = 'POST';
+ const PUT = 'PUT';
+ const OPTIONS = 'OPTIONS';
const ALLOWED_METHODS = [
- self::POST,
+ self::DELETE,
self::GET,
+ self::PATCH,
+ self::POST,
+ self::PUT,
+ self::OPTIONS
];
/** @var RouteCollector */
/** @var L10n */
private $l10n;
- /** @var ICache */
+ /** @var ICanCache */
private $cache;
+ /** @var ICanLock */
+ private $lock;
+
+ /** @var Arguments */
+ private $args;
+
+ /** @var IManageConfigValues */
+ private $config;
+
+ /** @var LoggerInterface */
+ private $logger;
+
+ /** @var float */
+ private $dice_profiler_threshold;
+
+ /** @var Dice */
+ private $dice;
+
/** @var string */
private $baseRoutesFilepath;
+ /** @var array */
+ private $server;
+
/**
* @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 ICache $cache
+ * @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, ICache $cache, RouteCollector $routeCollector = null)
+ 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);
+
+ $httpMethod = $this->server['REQUEST_METHOD'] ?? self::GET;
- $httpMethod = $server['REQUEST_METHOD'] ?? self::GET;
$this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
$this->routeCollector = isset($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.');
+ }
}
/**
/**
* 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 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 Dispatcher\GroupCountBased($this->getCachedDispatchData());
- $moduleClass = null;
$this->parameters = [];
$routeInfo = $dispatcher->dispatch($this->httpMethod, $cmd);
$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])));
+ if ($this->httpMethod === static::OPTIONS) {
+ // Default response for HTTP OPTIONS requests in case there is no special treatment
+ $moduleClass = Options::class;
+ } else {
+ 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;
}
- /**
- * Returns the module parameters.
- *
- * @return array parameters
- */
- public function getModuleParameters()
+ public function getModule(?string $module_class = null): ICanHandleRequests
{
- return $this->parameters;
+ $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]);
+ }
+ }
+ }
}
/**
{
$dispatchData = [];
- if ($this->baseRoutesFilepath && file_exists($this->baseRoutesFilepath)) {
+ if ($this->baseRoutesFilepath) {
$dispatchData = require $this->baseRoutesFilepath;
if (!is_array($dispatchData)) {
throw new HTTPException\InternalServerErrorException('Invalid base routes file');
* 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 ($routerDispatchData) {
+ 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