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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use FastRoute\DataGenerator\GroupCountBased as DataGeneratorGroupCountBased;
use FastRoute\Dispatcher;
use FastRoute\Dispatcher\GroupCountBased as DispatcherGroupCountBased;
use FastRoute\RouteCollector;
use FastRoute\RouteParser\Std as RouteParserStd;
use PhpMyAdmin\Controllers\HomeController;
use PhpMyAdmin\Http\ServerRequest;
use Psr\Container\ContainerInterface;
use function __;
use function file_exists;
use function file_put_contents;
use function htmlspecialchars;
use function is_array;
use function is_readable;
use function is_string;
use function is_writable;
use function rawurldecode;
use function sprintf;
use function trigger_error;
use function var_export;
use const CACHE_DIR;
use const E_USER_WARNING;
use const ROOT_PATH;
/**
* Class used to warm up the routing cache and manage routing.
*/
class Routing
{
public const ROUTES_CACHE_FILE = CACHE_DIR . 'routes.cache.php';
public static function getDispatcher(): Dispatcher
{
$routes = require ROOT_PATH . 'libraries/routes.php';
return self::routesCachedDispatcher($routes);
}
public static function skipCache(): bool
{
return ($GLOBALS['cfg']['environment'] ?? '') === 'development';
}
public static function canWriteCache(): bool
{
$cacheFileExists = file_exists(self::ROUTES_CACHE_FILE);
$canWriteFile = is_writable(self::ROUTES_CACHE_FILE);
if ($cacheFileExists && $canWriteFile) {
return true;
}
// Write without read does not work, chmod 200 for example
if (! $cacheFileExists && is_writable(CACHE_DIR) && is_readable(CACHE_DIR)) {
return true;
}
return $canWriteFile;
}
private static function routesCachedDispatcher(callable $routeDefinitionCallback): Dispatcher
{
$skipCache = self::skipCache();
// If skip cache is enabled, do not try to read the file
// If no cache skipping then read it and use it
if (! $skipCache && file_exists(self::ROUTES_CACHE_FILE)) {
/** @psalm-suppress MissingFile, UnresolvableInclude, MixedAssignment */
$dispatchData = require self::ROUTES_CACHE_FILE;
if (self::isRoutesCacheFileValid($dispatchData)) {
return new DispatcherGroupCountBased($dispatchData);
}
}
$routeCollector = new RouteCollector(
new RouteParserStd(),
new DataGeneratorGroupCountBased()
);
$routeDefinitionCallback($routeCollector);
$dispatchData = $routeCollector->getData();
$canWriteCache = self::canWriteCache();
// If skip cache is enabled, do not try to write it
// If no skip cache then try to write if write is possible
if (! $skipCache && $canWriteCache) {
$writeWorks = self::writeCache(
'<?php return ' . var_export($dispatchData, true) . ';'
);
if (! $writeWorks) {
trigger_error(
sprintf(
__(
'The routing cache could not be written, '
. 'you need to adjust permissions on the folder/file "%s"'
),
self::ROUTES_CACHE_FILE
),
E_USER_WARNING
);
}
}
return new DispatcherGroupCountBased($dispatchData);
}
public static function writeCache(string $cacheContents): bool
{
return @file_put_contents(self::ROUTES_CACHE_FILE, $cacheContents) !== false;
}
/**
* Call associated controller for a route using the dispatcher
*/
public static function callControllerForRoute(
ServerRequest $request,
Dispatcher $dispatcher,
ContainerInterface $container
): void {
$route = $request->getRoute();
$routeInfo = $dispatcher->dispatch($request->getMethod(), rawurldecode($route));
if ($routeInfo[0] === Dispatcher::NOT_FOUND) {
/** @var ResponseRenderer $response */
$response = $container->get(ResponseRenderer::class);
$response->setHttpResponseCode(404);
echo Message::error(sprintf(
__('Error 404! The page %s was not found.'),
'<code>' . htmlspecialchars($route) . '</code>'
))->getDisplay();
return;
}
if ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
/** @var ResponseRenderer $response */
$response = $container->get(ResponseRenderer::class);
$response->setHttpResponseCode(405);
echo Message::error(__('Error 405! Request method not allowed.'))->getDisplay();
return;
}
if ($routeInfo[0] !== Dispatcher::FOUND) {
return;
}
/** @psalm-var class-string $controllerName */
$controllerName = $routeInfo[1];
/** @var array<string, string> $vars */
$vars = $routeInfo[2];
/**
* @psalm-var callable(ServerRequest=, array<string, string>=):void $controller
*/
$controller = $container->get($controllerName);
$controller($request, $vars);
}
/**
* @param mixed $dispatchData
*
* @psalm-assert-if-true array[] $dispatchData
*/
private static function isRoutesCacheFileValid($dispatchData): bool
{
return is_array($dispatchData)
&& isset($dispatchData[0], $dispatchData[1])
&& is_array($dispatchData[0]) && is_array($dispatchData[1])
&& isset($dispatchData[0]['GET']) && is_array($dispatchData[0]['GET'])
&& isset($dispatchData[0]['GET']['/']) && is_string($dispatchData[0]['GET']['/'])
&& $dispatchData[0]['GET']['/'] === HomeController::class;
}
}
|
