<?php
/**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
use Friendica\Module\HTTPException\PageNotFound;
use Friendica\Module\Special\Options;
use Friendica\Network\HTTPException;
+use Friendica\Network\HTTPException\InternalServerErrorException;
use Friendica\Network\HTTPException\MethodNotAllowedException;
use Friendica\Network\HTTPException\NotFoundException;
use Friendica\Util\Router\FriendicaGroupCountBased;
/**
* @var array Module parameters
*/
- private $parameters = [];
+ protected $parameters = [];
/** @var L10n */
private $l10n;
/** @var array */
private $server;
+ /** @var string|null */
+ protected $moduleClass = null;
+
/**
* @param array $server The $_SERVER variable
* @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
}
+
+ $this->parameters = [$this->server];
}
/**
*
* @return bool
*/
- private function isGroup(array $config)
+ private function isGroup(array $config): bool
{
return
is_array($config) &&
*
* @return RouteCollector|null
*/
- public function getRouteCollector()
+ public function getRouteCollector(): ?RouteCollector
{
return $this->routeCollector;
}
+ /**
+ * Returns the Friendica\BaseModule-extending class name if a route rule matched
+ *
+ * @return string
+ *
+ * @throws InternalServerErrorException
+ * @throws MethodNotAllowedException
+ */
+ public function getModuleClass(): string
+ {
+ if (empty($this->moduleClass)) {
+ $this->determineModuleClass();
+ }
+
+ return $this->moduleClass;
+ }
+
/**
* Returns the relevant module class name for the given page URI or NULL if no route rule matched.
*
- * @return string A Friendica\BaseModule-extending class name if a route rule matched
+ * @return void
*
- * @throws HTTPException\InternalServerErrorException
- * @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't
- * @throws HTTPException\NotFoundException If no rule matched
+ * @throws HTTPException\InternalServerErrorException Unexpected exceptions
+ * @throws HTTPException\MethodNotAllowedException If a rule is private only
*/
- private function getModuleClass(): string
+ private function determineModuleClass(): void
{
$cmd = $this->args->getCommand();
$cmd = '/' . ltrim($cmd, '/');
$dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
- $this->parameters = [];
-
- // 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 {
- $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])));
+ try {
+ // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
+ if ($this->args->getMethod() === static::OPTIONS) {
+ $this->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) {
+ $this->moduleClass = $routeInfo[1];
+ $this->parameters[] = $routeInfo[2];
+ } else if ($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;
+ $this->moduleClass = MethodNotAllowed::class;
} catch (NotFoundException $e) {
$moduleName = $this->args->getModuleName();
// Then we try addon-provided modules that we wrap in the LegacyModule class
} else {
include_once "addon/{$moduleName}/{$moduleName}.php";
if (function_exists($moduleName . '_module')) {
- $module_parameters[] = "addon/{$moduleName}/{$moduleName}.php";
- $module_class = LegacyModule::class;
+ $this->parameters[] = "addon/{$moduleName}/{$moduleName}.php";
+ $this->moduleClass = 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;
+ if (!$this->moduleClass && file_exists("mod/{$moduleName}.php")) {
+ $this->parameters[] = "mod/{$moduleName}.php";
+ $this->moduleClass = LegacyModule::class;
}
- $module_class = $module_class ?: PageNotFound::class;
+ $this->moduleClass = $this->moduleClass ?: PageNotFound::class;
}
+ }
+
+ public function getModule(?string $module_class = null): ICanHandleRequests
+ {
+ $moduleClass = $module_class ?? $this->getModuleClass();
$stamp = microtime(true);
try {
/** @var ICanHandleRequests $module */
- return $this->dice->create($module_class, $module_parameters);
+ return $this->dice->create($moduleClass, $this->parameters);
} finally {
if ($this->dice_profiler_threshold > 0) {
$dur = floatval(microtime(true) - $stamp);
if ($dur >= $this->dice_profiler_threshold) {
- $this->logger->notice('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $module_class, 'parameters' => $module_parameters]);
+ $this->logger->notice('Dice module creation lasts too long.', ['duration' => round($dur, 3), 'module' => $moduleClass, 'parameters' => $this->parameters]);
}
}
}
}
if (!$this->lock->acquire('getCachedDispatchData', 0)) {
- // Immediately return uncached data when we can't aquire a lock
+ // Immediately return uncached data when we can't acquire a lock
return $this->getDispatchData();
}
projects / friendica.git / blobdiff