-
Notifications
You must be signed in to change notification settings - Fork 16
/
MiddlewareStackResolver.php
143 lines (124 loc) · 4.58 KB
/
MiddlewareStackResolver.php
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
<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Core\Http;
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
use TYPO3\CMS\Core\Cache\Frontend\PhpFrontend as PhpFrontendCache;
use TYPO3\CMS\Core\Package\PackageManager;
use TYPO3\CMS\Core\Service\DependencyOrderingService;
/**
* This class resolves middleware stacks from defined configuration in all active packages.
*/
class MiddlewareStackResolver
{
/**
* @var PackageManager
*/
protected $packageManager;
/**
* @var DependencyOrderingService
*/
protected $dependencyOrderingService;
/**
* @var PhpFrontendCache
*/
protected $cache;
public function __construct(
PackageManager $packageManager,
DependencyOrderingService $dependencyOrderingService,
PhpFrontendCache $cache
) {
$this->packageManager = $packageManager;
$this->dependencyOrderingService = $dependencyOrderingService;
$this->cache = $cache;
}
/**
* Returns the middleware stack registered in all packages within Configuration/RequestMiddlewares.php
* which are sorted by given dependency requirements
*
* @param string $stackName
* @return array
* @throws \TYPO3\CMS\Core\Cache\Exception\InvalidDataException
* @throws \TYPO3\CMS\Core\Exception
*/
public function resolve(string $stackName): array
{
// Check if the registered middlewares from all active packages have already been cached
$cacheIdentifier = $this->getCacheIdentifier($stackName);
if ($this->cache->has($cacheIdentifier)) {
return $this->cache->requireOnce($cacheIdentifier);
}
$allMiddlewares = $this->loadConfiguration();
$middlewares = $this->sanitizeMiddlewares($allMiddlewares);
// Ensure that we create a cache for $stackName, even if the stack is empty
if (!isset($middlewares[$stackName])) {
$middlewares[$stackName] = [];
}
foreach ($middlewares as $stack => $middlewaresOfStack) {
$this->cache->set($this->getCacheIdentifier($stack), 'return ' . var_export($middlewaresOfStack, true) . ';');
}
return $middlewares[$stackName];
}
/**
* Loop over all packages and check for a Configuration/RequestMiddlewares.php file
*
* @return array
*/
protected function loadConfiguration(): array
{
$packages = $this->packageManager->getActivePackages();
$allMiddlewares = [];
foreach ($packages as $package) {
$packageConfiguration = $package->getPackagePath() . 'Configuration/RequestMiddlewares.php';
if (file_exists($packageConfiguration)) {
$middlewaresInPackage = require $packageConfiguration;
if (is_array($middlewaresInPackage)) {
$allMiddlewares = array_merge_recursive($allMiddlewares, $middlewaresInPackage);
}
}
}
return $allMiddlewares;
}
/**
* Order each stack and sanitize to a plain array
*
* @param array
* @return array
*/
protected function sanitizeMiddlewares(array $allMiddlewares): array
{
$middlewares = [];
foreach ($allMiddlewares as $stack => $middlewaresOfStack) {
$middlewaresOfStack = $this->dependencyOrderingService->orderByDependencies($middlewaresOfStack);
$sanitizedMiddlewares = [];
foreach ($middlewaresOfStack as $name => $middleware) {
if (isset($middleware['disabled']) && $middleware['disabled'] === true) {
// Skip this middleware if disabled by configuration
continue;
}
$sanitizedMiddlewares[$name] = $middleware['target'];
}
// Order reverse, MiddlewareDispatcher executes the last middleware in the array first (last in, first out).
$middlewares[$stack] = array_reverse($sanitizedMiddlewares);
}
return $middlewares;
}
/**
* @param string $stackName
* @return string
*/
protected function getCacheIdentifier(string $stackName): string
{
return 'middlewares_' . $stackName . '_' . sha1(TYPO3_version . PATH_site);
}
}