1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2021 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Http\Middleware;
use Aura\Router\RouterContainer;
use Aura\Router\Rule\Accepts;
use Aura\Router\Rule\Allows;
use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Services\TreeService;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Webtrees;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use function app;
use function response;
use function str_contains;
/**
* Simple class to help migrate to a third-party routing library.
*/
class Router implements MiddlewareInterface
{
/** @var ModuleService */
private $module_service;
/** @var RouterContainer */
private $router_container;
/** @var TreeService */
private $tree_service;
/**
* Router constructor.
*
* @param ModuleService $module_service
* @param RouterContainer $router_container
* @param TreeService $tree_service
*/
public function __construct(ModuleService $module_service, RouterContainer $router_container, TreeService $tree_service)
{
$this->module_service = $module_service;
$this->router_container = $router_container;
$this->tree_service = $tree_service;
}
/**
* @param ServerRequestInterface $request
* @param RequestHandlerInterface $handler
*
* @return ResponseInterface
*/
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
// Turn the ugly URL into a pretty one, so the router can parse it.
$pretty = $request;
if ($request->getAttribute('rewrite_urls') !== '1') {
// Ugly URLs store the path in a query parameter.
$url_route = $request->getQueryParams()['route'] ?? '';
$uri = $request->getUri()->withPath($url_route);
$pretty = $request->withUri($uri);
}
// Match the request to a route.
$matcher = $this->router_container->getMatcher();
$route = $matcher->match($pretty);
// No route matched?
if ($route === false) {
$failed_route = $matcher->getFailedRoute();
switch ($failed_route->failedRule) {
case Allows::class:
return response('', StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, [
'Allow' => implode(', ', $failed_route->allows),
]);
case Accepts::class:
// We don't use this, but modules might.
return response('Negotiation failed', StatusCodeInterface::STATUS_NOT_ACCEPTABLE);
default:
// Not found
return $handler->handle($request);
}
}
// Add the route as attribute of the request
$request = $request->withAttribute('route', $route);
// This middleware cannot run until after the routing, as it needs to know the route.
$post_routing_middleware = [CheckCsrf::class];
// Firstly, apply the route middleware
$route_middleware = $route->extras['middleware'] ?? [];
// Secondly, apply any module middleware
$module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all();
// Finally, run the handler using middleware
$handler_middleware = [RequestHandler::class];
$middleware = array_merge(
$post_routing_middleware,
$route_middleware,
$module_middleware,
$handler_middleware
);
// Add the matched attributes to the request.
foreach ($route->attributes as $key => $value) {
if ($key === 'tree') {
$value = $this->tree_service->all()->get($value);
app()->instance(Tree::class, $value);
// Missing mandatory parameter? Let the default handler take care of it.
if ($value === null && str_contains($route->path, '{tree}')) {
return $handler->handle($request);
}
}
$request = $request->withAttribute((string) $key, $value);
}
// Bind the updated request into the container
app()->instance(ServerRequestInterface::class, $request);
return Webtrees::dispatch($request, $middleware);
}
}
|
