TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:09 +02:00
commit af8cc155b5
6818 changed files with 642608 additions and 0 deletions
@@ -0,0 +1,163 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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!
+ */
+
+namespace TYPO3\CMS\Core\Http;
+
+use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use TYPO3\CMS\Core\Attribute\AsEventListener;
+use TYPO3\CMS\Core\Cache\Event\CacheWarmupEvent;
+use TYPO3\CMS\Core\Cache\Frontend\PhpFrontend as PhpFrontendCache;
+use TYPO3\CMS\Core\Service\DependencyOrderingService;
+
+/**
+ * This class resolves middleware stacks from defined configuration in all active packages.
+ *
+ * @internal
+ */
+class MiddlewareStackResolver
+{
+    /**
+     * @var ContainerInterface
+     */
+    protected $container;
+
+    /**
+     * @var DependencyOrderingService
+     */
+    protected $dependencyOrderingService;
+
+    /**
+     * @var PhpFrontendCache
+     */
+    protected $cache;
+
+    private string $baseCacheIdentifier;
+
+    public function __construct(
+        ContainerInterface $container,
+        DependencyOrderingService $dependencyOrderingService,
+        #[Autowire(service: 'cache.core')]
+        PhpFrontendCache $cache,
+        #[Autowire(expression: 'service("package-dependent-cache-identifier").toString()')]
+        string $baseCacheIdentifier
+    ) {
+        $this->container = $container;
+        $this->dependencyOrderingService = $dependencyOrderingService;
+        $this->cache = $cache;
+        $this->baseCacheIdentifier = '_' . $baseCacheIdentifier;
+    }
+
+    /**
+     * Returns the middleware stack registered in all packages within Configuration/RequestMiddlewares.php
+     * which are sorted by given dependency requirements
+     *
+     * @throws \TYPO3\CMS\Core\Cache\Exception\InvalidDataException
+     * @throws \TYPO3\CMS\Core\Exception
+     */
+    public function resolve(string $stackName): \ArrayObject
+    {
+        return new \ArrayObject($this->getFromCache($stackName) ?? $this->computeMiddlewareStack($stackName));
+    }
+
+    protected function getFromCache(string $stackName): ?array
+    {
+        $cacheIdentifier = $this->getCacheIdentifier($stackName);
+        if (!$this->cache->has($cacheIdentifier)) {
+            return null;
+        }
+        $result = $this->cache->require($cacheIdentifier);
+        if ($result === false) {
+            // Cache entry has been removed in the meantime
+            return null;
+        }
+        if (!is_array($result)) {
+            // An invalid result is to be ignored (cache will be recreated)
+            return null;
+        }
+        return $result;
+    }
+
+    protected function computeMiddlewareStack(string $stackName): array
+    {
+        $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];
+    }
+
+    /**
+     * Lazy load configuration from the container
+     */
+    protected function loadConfiguration(): \ArrayObject
+    {
+        return $this->container->get('middlewares');
+    }
+
+    /**
+     * Order each stack and sanitize to a plain array
+     */
+    protected function sanitizeMiddlewares(\ArrayObject $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;
+    }
+
+    protected function getCacheIdentifier(string $stackName): string
+    {
+        return 'middlewares_' . $stackName . $this->baseCacheIdentifier;
+    }
+
+    #[AsEventListener('typo3-core/middlewares')]
+    public function warmupCaches(CacheWarmupEvent $event): void
+    {
+        if ($event->hasGroup('system')) {
+            $allMiddlewares = $this->loadConfiguration();
+            $middlewares = $this->sanitizeMiddlewares($allMiddlewares);
+
+            foreach ($middlewares as $stack => $middlewaresOfStack) {
+                $this->cache->set($this->getCacheIdentifier($stack), 'return ' . var_export($middlewaresOfStack, true) . ';');
+            }
+        }
+    }
+}