vendor/shopware/storefront/Framework/Cache/HttpCacheKeyGenerator.php line 45

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Cache;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  7. use Shopware\Core\SalesChannelRequest;
  8. use Shopware\Storefront\Framework\Cache\Event\HttpCacheGenerateKeyEvent;
  9. use Shopware\Storefront\Framework\Routing\RequestTransformer;
  10. use Symfony\Component\HttpFoundation\Request;
  11. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  13. #[Package('storefront')]
  14. class HttpCacheKeyGenerator extends AbstractHttpCacheKeyGenerator
  15. {
  16.     private string $cacheHash;
  18.     private EventDispatcherInterface $eventDispatcher;
  20.     /**
  21.      * @var string[]
  22.      */
  23.     private array $ignoredParameters;
  25.     /**
  26.      * @param string[] $ignoredParameters
  27.      *
  28.      * @internal
  29.      */
  30.     public function __construct(
  31.         string $cacheHash,
  32.         EventDispatcherInterface $eventDispatcher,
  33.         array $ignoredParameters
  34.     ) {
  35.         $this->cacheHash = $cacheHash;
  36.         $this->eventDispatcher = $eventDispatcher;
  37.         $this->ignoredParameters = $ignoredParameters;
  38.     }
  40.     public function getDecorated(): AbstractHttpCacheKeyGenerator
  41.     {
  42.         throw new DecorationPatternException(self::class);
  43.     }
  45.     public function generate(Request $request): string
  46.     {
  47.         $uri = $this->getRequestUri($request) . $this->cacheHash;
  49.         $event = new HttpCacheGenerateKeyEvent($request, 'md' . hash('sha256', $uri));
  51.         $this->eventDispatcher->dispatch($event);
  53.         $hash = $event->getHash();
  55.         if ($request->cookies->has(CacheResponseSubscriber::CONTEXT_CACHE_COOKIE)) {
  56.             return 'http-cache-' . hash('sha256', $hash . '-' . $request->cookies->get(CacheResponseSubscriber::CONTEXT_CACHE_COOKIE));
  57.         }
  59.         if ($request->cookies->has(CacheResponseSubscriber::CURRENCY_COOKIE)) {
  60.             return 'http-cache-' . hash('sha256', $hash . '-' . $request->cookies->get(CacheResponseSubscriber::CURRENCY_COOKIE));
  61.         }
  63.         if ($request->attributes->has(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID)) {
  64.             return 'http-cache-' . hash('sha256', $hash . '-' . $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID));
  65.         }
  67.         return 'http-cache-' . $hash;
  68.     }
  70.     private function getRequestUri(Request $request): string
  71.     {
  72.         $params = $request->query->all();
  73.         foreach (array_keys($params) as $key) {
  74.             if (\in_array($key, $this->ignoredParameters, true)) {
  75.                 unset($params[$key]);
  76.             }
  77.         }
  78.         ksort($params);
  79.         $params = http_build_query($params);
  81.         return sprintf(
  82.             '%s%s%s%s',
  83.             $request->getSchemeAndHttpHost(),
  84.             $request->attributes->get(RequestTransformer::SALES_CHANNEL_BASE_URL),
  85.             $request->getPathInfo(),
  86.             '?' . $params
  87.         );
  88.     }
  89. }