custom/plugins/MaxiaTaxSwitch6/src/Storefront/Subscriber/StorefrontSubscriber.php line 267

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Maxia\MaxiaTaxSwitch6\Storefront\Subscriber;
  5. use Maxia\MaxiaTaxSwitch6\Storefront\Events\GenerateCacheHashEvent;
  6. use Maxia\MaxiaTaxSwitch6\Storefront\Service\TaxSwitchService;
  7. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  8. use Shopware\Core\Framework\Event\BeforeSendResponseEvent;
  9. use Shopware\Core\Framework\Struct\ArrayEntity;
  10. use Shopware\Core\Framework\Util\Random;
  11. use Shopware\Core\PlatformRequest;
  12. use Shopware\Core\SalesChannelRequest;
  13. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceInterface;
  14. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceParameters;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  16. use Shopware\Storefront\Event\StorefrontRenderEvent;
  17. use Shopware\Storefront\Framework\Cache\CacheResponseSubscriber;
  18. use Shopware\Storefront\Framework\Cache\Event\HttpCacheGenerateKeyEvent;
  19. use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
  20. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  21. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  22. use Symfony\Component\HttpFoundation\Cookie;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\RequestStack;
  25. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  26. use Symfony\Component\HttpKernel\KernelEvents;
  28. /**
  29.  * @package Maxia\MaxiaAdvBlockPrices6\Subscriber
  30.  */
  31. class StorefrontSubscriber implements EventSubscriberInterface
  32. {
  33.     public static function getSubscribedEvents(): array
  34.     {
  35.         return [
  36.             StorefrontRenderEvent::class => 'addContextExtension',
  37.             KernelEvents::RESPONSE => [
  38.                 ['updateContextHash', -2005],
  39.                 ['updateCookie', -1000]
  40.             ],
  41.             BeforeSendResponseEvent::class => [
  42.                 ['removeDuplicateSession', -100],
  43.             ],
  44.             HttpCacheGenerateKeyEvent::class => 'updateHttpCacheKey'
  45.         ];
  46.     }
  48.     /** @var RequestStack */
  49.     private $requestStack;
  51.     /** @var SalesChannelContextServiceInterface */
  52.     private $contextService;
  54.     /** @var TagAwareAdapterInterface */
  55.     private $cache;
  57.     /** @var TaxSwitchService */
  58.     private $taxSwitchService;
  60.     /**
  61.      * @param RequestStack $requestStack
  62.      * @param CartService $cartService
  63.      * @param TaxSwitchService $taxSwitchService
  64.      */
  65.     public function __construct(
  66.         RequestStack $requestStack,
  67.         EventDispatcherInterface $eventDispatcher,
  68.         SalesChannelContextServiceInterface $contextService,
  69.         TagAwareAdapterInterface $cache,
  70.         TaxSwitchService $taxSwitchService
  71.     ) {
  72.         $this->requestStack = $requestStack;
  73.         $this->eventDispatcher = $eventDispatcher;
  74.         $this->contextService = $contextService;
  75.         $this->cache = $cache;
  76.         $this->taxSwitchService = $taxSwitchService;
  77.     }
  79.     /**
  80.      * @param StorefrontRenderEvent $event
  81.      */
  82.     public function addContextExtension(StorefrontRenderEvent $event)
  83.     {
  84.         $context = $event->getSalesChannelContext();
  85.         $entity = new ArrayEntity($this->taxSwitchService->getContext($context));
  86.         $context->addExtension('maxiaTaxSwitch', $entity);
  87.     }
  89.     /**
  90.      * Add isNet parameter to the HTTP cache key.
  91.      *
  92.      * @param HttpCacheGenerateKeyEvent $event
  93.      * @return void
  94.      */
  95.     public function updateHttpCacheKey(HttpCacheGenerateKeyEvent $event)
  96.     {
  97.         $request = $event->getRequest();
  99.         $config = $this->getCachedPluginConfig($request);
  101.         if (!$config || !$config['pluginEnabled']) {
  102.             return;
  103.         }
  105.         $isNet = $config['preselection'] === 'net';
  106.         $overrideSetting = false;
  108.         if ($request->query->has($config['urlParameterName']) && $config['urlParameterActive']) {
  109.             $isNet = (bool)$request->query->get($config['urlParameterName'], $isNet);
  110.             $overrideSetting = true;
  112.         } else if ($request->cookies->has(TaxSwitchService::COOKIE_NAME)) {
  113.             $isNet = (bool)$request->cookies->get(TaxSwitchService::COOKIE_NAME, $isNet);
  114.         }
  116.         if (!$request->cookies->has(CacheResponseSubscriber::CONTEXT_CACHE_COOKIE) || $overrideSetting) {
  117.             $value = $isNet ? $config['netContextHash'] : $config['grossContextHash'];
  118.             $request->cookies->set(CacheResponseSubscriber::CONTEXT_CACHE_COOKIE, $value);
  119.         }
  120.     }
  122.     /**
  123.      * Loads some basic plugin settings relevant for generating the HTTP cache key.
  124.      *
  125.      * @param Request $request
  126.      * @return array|null
  127.      */
  128.     protected function getCachedPluginConfig(Request $request): ?array
  129.     {
  130.         $salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  131.         $language = $request->headers->get(PlatformRequest::HEADER_LANGUAGE_ID);
  132.         $currencyId = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID);
  134.         if (!$salesChannelId) {
  135.             return null;
  136.         }
  138.         $cacheKey = 'maxia-tax-switch-config-' . implode('-', [
  139.             $salesChannelId, $language, $currencyId
  140.         ]);
  142.         $cacheItem = $this->cache->getItem($cacheKey);
  144.         if (!$cacheItem->isHit()) {
  145.             $contextToken = Random::getAlphanumericString(32);
  147.             $context = $this->contextService
  148.                 ->get(new SalesChannelContextServiceParameters($salesChannelId, $contextToken, $language, $currencyId));
  150.             $config = $this->taxSwitchService->getConfig($context);
  152.             $result = [
  153.                 'pluginEnabled' => $config['pluginEnabled'],
  154.                 'preselection' => $config['preselection'],
  155.                 'urlParameterActive' => $config['urlParameterActive'],
  156.                 'urlParameterName' => $config['urlParameterName'],
  157.                 'cookieRequired' => $config['cookieRequired'],
  158.                 'netContextHash' => $this->buildCacheHash($context, true),
  159.                 'grossContextHash' => $this->buildCacheHash($context, false)
  160.             ];
  162.             $cacheItem->set(json_encode($result));
  163.             $this->cache->save($cacheItem);
  165.         } else {
  166.             $result = json_decode($cacheItem->get(), true);
  167.         }
  169.         return $result;
  170.     }
  172.     /**
  173.      * Updates the sw-cache-hash cookie, taking the tax switch setting into account.
  174.      *
  175.      * @param ResponseEvent $event
  176.      */
  177.     public function updateContextHash(ResponseEvent $event): void
  178.     {
  179.         $master = $this->getMainRequest();
  180.         $response = $event->getResponse();
  182.         if (!$master ||
  183.             !$master->attributes->get(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST) ||
  184.             !$master->attributes->get(TaxSwitchService::TAX_SWITCH_ACTIVE_ATTR)) {
  185.             return;
  186.         }
  188.         /** @var SalesChannelContext $context */
  189.         $context = $master->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  191.         if (!$context) {
  192.             return;
  193.         }
  195.         $isNet = $this->taxSwitchService->getDisplayNet($context);
  197.         if ($isNet === null) {
  198.             return;
  199.         }
  201.         $cookieName = CacheResponseSubscriber::CONTEXT_CACHE_COOKIE;
  202.         $currentHash = $master->cookies->get($cookieName);
  203.         $newHash = $this->buildCacheHash($context, $isNet);
  205.         // remove context cookie from headers if already set
  206.         $responseHash = null;
  207.         $headers = $response->headers->all();
  209.         if (isset($headers['set-cookie'])) {
  210.             foreach ($headers['set-cookie'] as $key => $value) {
  211.                 if (preg_match('/' . preg_quote($cookieName, '/') . '=(.+);/', $value, $matches)) {
  212.                     unset($headers['set-cookie'][$key]);
  213.                     $response->headers->set('set-cookie', $headers['set-cookie']);
  214.                     $responseHash = $matches[1];
  215.                     break;
  216.                 }
  217.             }
  218.         }
  220.         // update cookie if needed
  221.         if ($currentHash !== $newHash || ($responseHash && $responseHash !== $newHash)) {
  222.             $cookie = Cookie::create($cookieName, $newHash);
  223.             $cookie->setSecureDefault($master->isSecure());
  225.             $response->headers->setCookie($cookie);
  226.         }
  227.     }
  229.     /**
  230.      * Returns the value for the sw-cache-hash cookie.
  231.      * @todo Extend SW implementation when possible
  232.      *
  233.      * @param SalesChannelContext $context
  234.      * @param bool $isNet
  235.      * @return string
  236.      */
  237.     protected function buildCacheHash(SalesChannelContext $context, bool $isNet): string
  238.     {
  239.         $data = [
  240.             $context->getRuleIds(),
  241.             $context->getContext()->getVersionId(),
  242.             $context->getCurrency()->getId(),
  243.             $context->getCustomer() ? 'logged-in' : 'not-logged-in',
  244.             $isNet
  245.         ];
  247.         $acrisCacheHashExtension = $context->getExtension('acris_cache_hash');
  249.         if ($acrisCacheHashExtension) {
  250.             $acrisCacheHash = md5(json_encode($acrisCacheHashExtension->all()));
  251.             $data[] = $acrisCacheHash;
  252.         }
  254.         $event = new GenerateCacheHashEvent($data, $context);
  256.         $this->eventDispatcher->dispatch($event);
  258.         return md5(json_encode($event->getParameters()));
  259.     }
  261.     /**
  262.      * Updates the tax switch cookie, if the setting has been changed.
  263.      * Will be ignored, if the cookie was not set beforehand on the client side.
  264.      *
  265.      * @param ResponseEvent $event
  266.      */
  267.     public function updateCookie(ResponseEvent $event): void
  268.     {
  269.         $master = $this->getMainRequest();
  271.         if (!$master || !$master->attributes->get(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST)) {
  272.             return;
  273.         }
  275.         if (!$master
  276.             || !$master->attributes->get(TaxSwitchService::TAX_SWITCH_ACTIVE_ATTR)
  277.             || !$master->attributes->get(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST)
  278.             || !$master->attributes->get(TaxSwitchService::STATE_CHANGED_ATTR)
  279.             || $master->cookies->get(TaxSwitchService::COOKIE_NAME) === null)
  280.         {
  281.             return;
  282.         }
  284.         /** @var SalesChannelContext $context */
  285.         $context = $master->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  287.         if (!$context) {
  288.             return;
  289.         }
  291.         $isNet = $this->taxSwitchService->getDisplayNet($context);
  293.         if ($isNet === null) {
  294.             return;
  295.         }
  297.         $cookie = Cookie::create(TaxSwitchService::COOKIE_NAME, (string)((int)$isNet))
  298.             ->withHttpOnly(false)
  299.             ->withExpires((new \DateTime())->add(new \DateInterval('P30D')));
  300.         $cookie->setSecureDefault($master->isSecure());
  302.         $event->getResponse()->headers->setCookie($cookie);
  303.     }
  305.     /**
  306.      * Remove the duplicate session cookie as this can result in the wrong tax setting being read
  307.      * https://issues.shopware.com/issues/NEXT-10238
  308.      * @todo Remove when possible
  309.      *
  310.      * @param BeforeSendResponseEvent $event
  311.      */
  312.     public function removeDuplicateSession(BeforeSendResponseEvent $event): void
  313.     {
  314.         if (!$event->getRequest()->attributes->get(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST)) {
  315.             return;
  316.         }
  318.         $hasSessionCookie = false;
  320.         if (session_id() && headers_list()) {
  321.             $cookies = array_filter(headers_list(), function ($item) {
  322.                 return strpos($item, 'session-='.session_id()) !== false;
  323.             });
  325.             $hasSessionCookie = count($cookies) > 0;
  326.         }
  328.         $response = $event->getResponse();
  329.         $headers = $response->headers->all();
  331.         if (isset($headers['set-cookie'])) {
  332.             foreach ($headers['set-cookie'] as $key => $value) {
  333.                 if (str_starts_with($value, 'PHPSESSID=')) {
  334.                     unset($headers['set-cookie'][$key]);
  335.                 }
  337.                 if ($hasSessionCookie && str_starts_with($value, 'session-=')) {
  338.                     if (strpos($value, session_id()) === false) {
  339.                         unset($headers['set-cookie'][$key]);
  340.                     }
  341.                 }
  342.             }
  344.             if ($headers['set-cookie']) {
  345.                 $response->headers->set('set-cookie', $headers['set-cookie']);
  346.                 $event->setResponse($response);
  347.             }
  348.         }
  349.     }
  351.     /**
  352.      * @return \Symfony\Component\HttpFoundation\Request|null
  353.      */
  354.     protected function getMainRequest()
  355.     {
  356.         return method_exists($this->requestStack, 'getMainRequest')
  357.             ? $this->requestStack->getMainRequest()
  358.             : $this->requestStack->getMasterRequest();
  359.     }
  360. }