src/Storefront/Framework/Cache/CacheResponseSubscriber.php line 61

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Cache;
  5. use Shopware\Core\Checkout\Cart\Cart;
  6. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  7. use Shopware\Core\Framework\Adapter\Cache\CacheStateSubscriber;
  8. use Shopware\Core\Framework\Event\BeforeSendResponseEvent;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Shopware\Core\PlatformRequest;
  11. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextService;
  12. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  13. use Shopware\Storefront\Framework\Routing\MaintenanceModeResolver;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Cookie;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\HttpKernel\Event\RequestEvent;
  19. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  22. /**
  23.  * @internal
  24.  */
  25. #[Package('storefront')]
  26. class CacheResponseSubscriber implements EventSubscriberInterface
  27. {
  28.     final public const STATE_LOGGED_IN = CacheStateSubscriber::STATE_LOGGED_IN;
  29.     final public const STATE_CART_FILLED = CacheStateSubscriber::STATE_CART_FILLED;
  31.     final public const CURRENCY_COOKIE = 'sw-currency';
  32.     final public const CONTEXT_CACHE_COOKIE = 'sw-cache-hash';
  33.     final public const SYSTEM_STATE_COOKIE = 'sw-states';
  34.     final public const INVALIDATION_STATES_HEADER = 'sw-invalidation-states';
  36.     private const CORE_HTTP_CACHED_ROUTES = [
  37.         'api.acl.privileges.get',
  38.     ];
  40.     /**
  41.      * @internal
  42.      */
  43.     public function __construct(private readonly CartService $cartService, private readonly int $defaultTtl, private readonly bool $httpCacheEnabled, private readonly MaintenanceModeResolver $maintenanceResolver, private readonly bool $reverseProxyEnabled, private readonly ?string $staleWhileRevalidate, private readonly ?string $staleIfError)
  44.     {
  45.     }
  47.     /**
  48.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  49.      */
  50.     public static function getSubscribedEvents(): array
  51.     {
  52.         return [
  53.             KernelEvents::REQUEST => 'addHttpCacheToCoreRoutes',
  54.             KernelEvents::RESPONSE => [
  55.                 ['setResponseCache', -1500],
  56.             ],
  57.             BeforeSendResponseEvent::class => 'updateCacheControlForBrowser',
  58.         ];
  59.     }
  61.     public function addHttpCacheToCoreRoutes(RequestEvent $event): void
  62.     {
  63.         $request = $event->getRequest();
  64.         $route = $request->attributes->get('_route');
  66.         if (\in_array($route, self::CORE_HTTP_CACHED_ROUTES, true)) {
  67.             $request->attributes->set(PlatformRequest::ATTRIBUTE_HTTP_CACHE, true);
  68.         }
  69.     }
  71.     public function setResponseCache(ResponseEvent $event): void
  72.     {
  73.         if (!$this->httpCacheEnabled) {
  74.             return;
  75.         }
  77.         $response = $event->getResponse();
  79.         $request = $event->getRequest();
  81.         $context = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  83.         if (!$context instanceof SalesChannelContext) {
  84.             return;
  85.         }
  87.         if (!$this->maintenanceResolver->shouldBeCached($request)) {
  88.             return;
  89.         }
  91.         $route = $request->attributes->get('_route');
  92.         if ($route === 'frontend.checkout.configure') {
  93.             $this->setCurrencyCookie($request, $response);
  94.         }
  96.         $cart = $this->cartService->getCart($context->getToken(), $context);
  98.         $states = $this->updateSystemState($cart, $context, $request, $response);
  100.         // We need to allow it on login, otherwise the state is wrong
  101.         if (!($route === 'frontend.account.login' || $request->getMethod() === Request::METHOD_GET)) {
  102.             return;
  103.         }
  105.         if ($context->getCustomer() || $cart->getLineItems()->count() > 0) {
  106.             $newValue = $this->buildCacheHash($context);
  108.             if ($request->cookies->get(self::CONTEXT_CACHE_COOKIE, '') !== $newValue) {
  109.                 $cookie = Cookie::create(self::CONTEXT_CACHE_COOKIE, $newValue);
  110.                 $cookie->setSecureDefault($request->isSecure());
  112.                 $response->headers->setCookie($cookie);
  113.             }
  114.         } elseif ($request->cookies->has(self::CONTEXT_CACHE_COOKIE)) {
  115.             $response->headers->removeCookie(self::CONTEXT_CACHE_COOKIE);
  116.             $response->headers->clearCookie(self::CONTEXT_CACHE_COOKIE);
  117.         }
  119.         /** @var bool|array{maxAge?: int, states?: list<string>}|null $cache */
  120.         $cache = $request->attributes->get(PlatformRequest::ATTRIBUTE_HTTP_CACHE);
  121.         if (!$cache) {
  122.             return;
  123.         }
  125.         if ($cache === true) {
  126.             $cache = [];
  127.         }
  129.         if ($this->hasInvalidationState($cache['states'] ?? [], $states)) {
  130.             return;
  131.         }
  133.         $maxAge = $cache['maxAge'] ?? $this->defaultTtl;
  135.         $response->setSharedMaxAge($maxAge);
  136.         $response->headers->addCacheControlDirective('must-revalidate');
  137.         $response->headers->set(
  138.             self::INVALIDATION_STATES_HEADER,
  139.             implode(',', $cache['states'] ?? [])
  140.         );
  142.         if ($this->staleIfError !== null) {
  143.             $response->headers->addCacheControlDirective('stale-if-error', $this->staleIfError);
  144.         }
  146.         if ($this->staleWhileRevalidate !== null) {
  147.             $response->headers->addCacheControlDirective('stale-while-revalidate', $this->staleWhileRevalidate);
  148.         }
  149.     }
  151.     /**
  152.      * In the default HttpCache implementation the reverse proxy cache is implemented too in PHP and triggered before the response is send to the client. We don't need to send the "real" cache-control headers to the end client (browser/cloudflare).
  153.      * If a external reverse proxy cache is used we still need to provide the actual cache-control, so the external system can cache the system correctly and set the cache-control again to
  154.      */
  155.     public function updateCacheControlForBrowser(BeforeSendResponseEvent $event): void
  156.     {
  157.         if ($this->reverseProxyEnabled) {
  158.             return;
  159.         }
  161.         $response = $event->getResponse();
  163.         $noStore = $response->headers->getCacheControlDirective('no-store');
  165.         // We don't want that the client will cache the website, if no reverse proxy is configured
  166.         $response->headers->remove('cache-control');
  167.         $response->setPrivate();
  169.         if ($noStore) {
  170.             $response->headers->addCacheControlDirective('no-store');
  171.         } else {
  172.             $response->headers->addCacheControlDirective('no-cache');
  173.         }
  174.     }
  176.     /**
  177.      * @param list<string> $cacheStates
  178.      * @param list<string> $states
  179.      */
  180.     private function hasInvalidationState(array $cacheStates, array $states): bool
  181.     {
  182.         foreach ($states as $state) {
  183.             if (\in_array($state, $cacheStates, true)) {
  184.                 return true;
  185.             }
  186.         }
  188.         return false;
  189.     }
  191.     private function buildCacheHash(SalesChannelContext $context): string
  192.     {
  193.         return md5(json_encode([
  194.             $context->getRuleIds(),
  195.             $context->getContext()->getVersionId(),
  196.             $context->getCurrency()->getId(),
  197.             $context->getCustomer() ? 'logged-in' : 'not-logged-in',
  198.         ], \JSON_THROW_ON_ERROR));
  199.     }
  201.     /**
  202.      * System states can be used to stop caching routes at certain states. For example,
  203.      * the checkout routes are no longer cached if the customer has products in the cart or is logged in.
  204.      *
  205.      * @return list<string>
  206.      */
  207.     private function updateSystemState(Cart $cart, SalesChannelContext $context, Request $request, Response $response): array
  208.     {
  209.         $states = $this->getSystemStates($request, $context, $cart);
  211.         if (empty($states)) {
  212.             if ($request->cookies->has(self::SYSTEM_STATE_COOKIE)) {
  213.                 $response->headers->removeCookie(self::SYSTEM_STATE_COOKIE);
  214.                 $response->headers->clearCookie(self::SYSTEM_STATE_COOKIE);
  215.             }
  217.             return [];
  218.         }
  220.         $newStates = implode(',', $states);
  222.         if ($request->cookies->get(self::SYSTEM_STATE_COOKIE) !== $newStates) {
  223.             $cookie = Cookie::create(self::SYSTEM_STATE_COOKIE, $newStates);
  224.             $cookie->setSecureDefault($request->isSecure());
  226.             $response->headers->setCookie($cookie);
  227.         }
  229.         return $states;
  230.     }
  232.     /**
  233.      * @return list<string>
  234.      */
  235.     private function getSystemStates(Request $request, SalesChannelContext $context, Cart $cart): array
  236.     {
  237.         $states = [];
  238.         $swStates = (string) $request->cookies->get(self::SYSTEM_STATE_COOKIE);
  239.         if ($swStates !== '') {
  240.             $states = array_flip(explode(',', $swStates));
  241.         }
  243.         $states = $this->switchState($states, self::STATE_LOGGED_IN, $context->getCustomer() !== null);
  245.         $states = $this->switchState($states, self::STATE_CART_FILLED, $cart->getLineItems()->count() > 0);
  247.         return array_keys($states);
  248.     }
  250.     /**
  251.      * @param array<string, int|bool> $states
  252.      *
  253.      * @return array<string, int|bool>
  254.      */
  255.     private function switchState(array $states, string $key, bool $match): array
  256.     {
  257.         if ($match) {
  258.             $states[$key] = true;
  260.             return $states;
  261.         }
  263.         unset($states[$key]);
  265.         return $states;
  266.     }
  268.     private function setCurrencyCookie(Request $request, Response $response): void
  269.     {
  270.         $currencyId = $request->get(SalesChannelContextService::CURRENCY_ID);
  272.         if (!$currencyId) {
  273.             return;
  274.         }
  276.         $cookie = Cookie::create(self::CURRENCY_COOKIE, $currencyId);
  277.         $cookie->setSecureDefault($request->isSecure());
  279.         $response->headers->setCookie($cookie);
  280.     }
  281. }