<?php
/**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @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\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
/** @var RouteCollector */
protected $routeCollector;
- /**
- * @var string The HTTP method
- */
- private $httpMethod;
-
/**
* @var array Module parameters
*/
/** @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 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, 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;
-
- $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());
+ $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);
+
+ $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.');
*/
public function loadRoutes(array $routes)
{
- $routeCollector = (isset($this->routeCollector) ?
- $this->routeCollector :
- new RouteCollector(new Std(), new GroupCountBased()));
+ $routeCollector = ($this->routeCollector ?? new RouteCollector(new Std(), new GroupCountBased()));
$this->addRoutes($routeCollector, $routes);
if ($this->isGroup($config)) {
$this->addGroup($route, $config, $routeCollector);
} elseif ($this->isRoute($config)) {
- $routeCollector->addRoute($config[1], $route, $config[0]);
+ // 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) . "'");
}
/**
* 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());
+ $dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
- $moduleClass = null;
$this->parameters = [];
- $routeInfo = $dispatcher->dispatch($this->httpMethod, $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])));
+ // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
+ if ($this->args->getMethod() === static::OPTIONS) {
+ $moduleClass = Options::class;
+ $this->parameters = ['allowedMethods' => $dispatcher->getOptions($cmd)];
} else {
- throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
+ $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;
}
- /**
- * 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]);
+ }
+ }
+ }
}
/**
*/
private function getCachedDispatchData()
{
- $routerDispatchData = $this->cache->get('routerDispatchData');
+ $routerDispatchData = $this->cache->get('routerDispatchData');
$lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
- $forceRecompute = false;
+ $forceRecompute = false;
if ($this->baseRoutesFilepath) {
$routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
- $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
+ $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
}
if (!$forceRecompute && $routerDispatchData) {
projects / friendica.git / blobdiff