Merge pull request #12287 from nupplaphil/bug/fix_router

Fix Legacy Router class routing
This commit is contained in:
Hypolite Petovan 2022-11-28 14:52:01 -05:00 committed by GitHub
commit 1ec4c14501
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -80,7 +80,7 @@ class Router
/** /**
* @var array Module parameters * @var array Module parameters
*/ */
private $parameters = []; protected $parameters = [];
/** @var L10n */ /** @var L10n */
private $l10n; private $l10n;
@ -268,7 +268,6 @@ class Router
* *
* @throws InternalServerErrorException * @throws InternalServerErrorException
* @throws MethodNotAllowedException * @throws MethodNotAllowedException
* @throws NotFoundException
*/ */
public function getModuleClass(): string public function getModuleClass(): string
{ {
@ -284,9 +283,8 @@ class Router
* *
* @return void * @return void
* *
* @throws HTTPException\InternalServerErrorException * @throws HTTPException\InternalServerErrorException Unexpected exceptions
* @throws HTTPException\MethodNotAllowedException If a rule matched but the method didn't * @throws HTTPException\MethodNotAllowedException If a rule is private only
* @throws HTTPException\NotFoundException If no rule matched
*/ */
private function determineModuleClass(): void private function determineModuleClass(): void
{ {
@ -295,39 +293,26 @@ class Router
$dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData()); $dispatcher = new FriendicaGroupCountBased($this->getCachedDispatchData());
$this->parameters = []; $this->parameters = [$this->server];
// 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 {
$routeInfo = $dispatcher->dispatch($this->args->getMethod(), $cmd);
if ($routeInfo[0] === Dispatcher::FOUND) {
$this->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.'));
}
}
}
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 { try {
$module_class = $module_class ?? $this->getModuleClass(); // Check if the HTTP method is OPTIONS and return the special Options Module with the possible HTTP methods
$module_parameters[] = $this->parameters; if ($this->args->getMethod() === static::OPTIONS) {
$this->moduleClass = Options::class;
$this->parameters = ['allowedMethods' => $dispatcher->getOptions($cmd)];
} else {
$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.'));
}
}
} catch (MethodNotAllowedException $e) { } catch (MethodNotAllowedException $e) {
$module_class = MethodNotAllowed::class; $this->moduleClass = MethodNotAllowed::class;
} catch (NotFoundException $e) { } catch (NotFoundException $e) {
$moduleName = $this->args->getModuleName(); $moduleName = $this->args->getModuleName();
// Then we try addon-provided modules that we wrap in the LegacyModule class // Then we try addon-provided modules that we wrap in the LegacyModule class
@ -339,8 +324,8 @@ class Router
} else { } else {
include_once "addon/{$moduleName}/{$moduleName}.php"; include_once "addon/{$moduleName}/{$moduleName}.php";
if (function_exists($moduleName . '_module')) { if (function_exists($moduleName . '_module')) {
$module_parameters[] = "addon/{$moduleName}/{$moduleName}.php"; $this->parameters[] = "addon/{$moduleName}/{$moduleName}.php";
$module_class = LegacyModule::class; $this->moduleClass = LegacyModule::class;
} }
} }
} }
@ -348,24 +333,29 @@ class Router
/* Finally, we look for a 'standard' program module in the 'mod' directory /* Finally, we look for a 'standard' program module in the 'mod' directory
* We emulate a Module class through the LegacyModule class * We emulate a Module class through the LegacyModule class
*/ */
if (!$module_class && file_exists("mod/{$moduleName}.php")) { if (!$this->moduleClass && file_exists("mod/{$moduleName}.php")) {
$module_parameters[] = "mod/{$moduleName}.php"; $this->parameters[] = "mod/{$moduleName}.php";
$module_class = LegacyModule::class; $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); $stamp = microtime(true);
try { try {
/** @var ICanHandleRequests $module */ /** @var ICanHandleRequests $module */
return $this->dice->create($module_class, $module_parameters); return $this->dice->create($moduleClass, $this->parameters);
} finally { } finally {
if ($this->dice_profiler_threshold > 0) { if ($this->dice_profiler_threshold > 0) {
$dur = floatval(microtime(true) - $stamp); $dur = floatval(microtime(true) - $stamp);
if ($dur >= $this->dice_profiler_threshold) { 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]);
} }
} }
} }