vendor/shopware/storefront/Framework/Routing/NotFound/NotFoundSubscriber.php line 164

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Routing\NotFound;
  5. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  6. use Shopware\Core\Framework\Adapter\Cache\CacheInvalidator;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  8. use Shopware\Core\Framework\Feature;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Shopware\Core\Framework\Uuid\Uuid;
  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\Core\System\SystemConfig\Event\SystemConfigChangedEvent;
  17. use Shopware\Storefront\Controller\ErrorController;
  18. use Shopware\Storefront\Framework\Routing\StorefrontResponse;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\HttpFoundation\RequestStack;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  24. use Symfony\Component\HttpKernel\Exception\HttpException;
  25. use Symfony\Component\HttpKernel\KernelEvents;
  26. use Symfony\Contracts\Cache\CacheInterface;
  27. use Symfony\Contracts\Cache\ItemInterface;
  28. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  30. /**
  31.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  32.  */
  33. #[Package('storefront')]
  34. class NotFoundSubscriber implements EventSubscriberInterface
  35. {
  36.     private const ALL_TAG = 'error-page';
  37.     private const SYSTEM_CONFIG_KEY = 'core.basicInformation.http404Page';
  39.     private ErrorController $controller;
  41.     private RequestStack $requestStack;
  43.     private SalesChannelContextServiceInterface $contextService;
  45.     private bool $kernelDebug;
  47.     private CacheInterface $cache;
  49.     /**
  50.      * @var AbstractCacheTracer<Response>
  51.      */
  52.     private AbstractCacheTracer $cacheTracer;
  54.     private EntityCacheKeyGenerator $generator;
  56.     private CacheInvalidator $cacheInvalidator;
  58.     private EventDispatcherInterface $eventDispatcher;
  60.     /**
  61.      * @internal
  62.      *
  63.      * @param AbstractCacheTracer<Response> $cacheTracer
  64.      */
  65.     public function __construct(
  66.         ErrorController $controller,
  67.         RequestStack $requestStack,
  68.         SalesChannelContextServiceInterface $contextService,
  69.         bool $kernelDebug,
  70.         CacheInterface $cache,
  71.         AbstractCacheTracer $cacheTracer,
  72.         EntityCacheKeyGenerator $generator,
  73.         CacheInvalidator $cacheInvalidator,
  74.         EventDispatcherInterface $eventDispatcher
  75.     ) {
  76.         $this->controller = $controller;
  77.         $this->requestStack = $requestStack;
  78.         $this->contextService = $contextService;
  79.         $this->kernelDebug = $kernelDebug;
  80.         $this->cache = $cache;
  81.         $this->cacheTracer = $cacheTracer;
  82.         $this->generator = $generator;
  83.         $this->cacheInvalidator = $cacheInvalidator;
  84.         $this->eventDispatcher = $eventDispatcher;
  85.     }
  87.     public static function getSubscribedEvents(): array
  88.     {
  89.         if (Feature::isActive('v6.5.0.0')) {
  90.             return [
  91.                 KernelEvents::EXCEPTION => [
  92.                     ['onError', -100],
  93.                 ],
  94.                 SystemConfigChangedEvent::class => 'onSystemConfigChanged',
  95.             ];
  96.         }
  98.         return [
  99.             SystemConfigChangedEvent::class => 'onSystemConfigChanged',
  100.         ];
  101.     }
  103.     public function onError(ExceptionEvent $event): void
  104.     {
  105.         $request = $event->getRequest();
  106.         if ($this->kernelDebug || $request->attributes->has(SalesChannelRequest::ATTRIBUTE_STORE_API_PROXY)) {
  107.             return;
  108.         }
  110.         $event->stopPropagation();
  112.         $salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID, '');
  113.         $domainId = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID, '');
  114.         $languageId = $request->attributes->get(PlatformRequest::HEADER_LANGUAGE_ID, '');
  116.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)) {
  117.             // When no sales-channel context is resolved, we need to resolve it now.
  118.             $this->setSalesChannelContext($request);
  119.         }
  121.         $is404StatusCode = $event->getThrowable() instanceof HttpException && $event->getThrowable()->getStatusCode() === Response::HTTP_NOT_FOUND;
  123.         // If the exception is not a 404 status code, we don't need to cache it.
  124.         if (!$is404StatusCode) {
  125.             $event->setResponse($this->controller->error(
  126.                 $event->getThrowable(),
  127.                 $request,
  128.                 $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  129.             ));
  131.             return;
  132.         }
  134.         /** @var SalesChannelContext $context */
  135.         $context = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  137.         $name = self::buildName($salesChannelId, $domainId, $languageId);
  138.         $key = $this->generateKey($salesChannelId, $domainId, $languageId, $request, $context);
  140.         $response = $this->cache->get($key, function (ItemInterface $item) use ($event, $name, $context) {
  141.             /** @var StorefrontResponse $response */
  142.             $response = $this->cacheTracer->trace($name, function () use ($event) {
  143.                 /** @var Request $request */
  144.                 $request = $this->requestStack->getMainRequest();
  146.                 return $this->controller->error(
  147.                     $event->getThrowable(),
  148.                     $request,
  149.                     $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  150.                 );
  151.             });
  153.             $item->tag($this->generateTags($name, $event->getRequest(), $context));
  155.             $response->setData(null);
  156.             $response->setContext(null);
  158.             return $response;
  159.         });
  161.         $event->setResponse($response);
  162.     }
  164.     public function onSystemConfigChanged(SystemConfigChangedEvent $event): void
  165.     {
  166.         if ($event->getKey() !== self::SYSTEM_CONFIG_KEY) {
  167.             return;
  168.         }
  170.         $this->cacheInvalidator->invalidate([self::ALL_TAG]);
  171.     }
  173.     /**
  174.      * @deprecated tag:v6.5.0 - reason:visibility-change - method will become private in v6.5.0
  175.      */
  176.     public static function buildName(string $salesChannelId, string $domainId, string $languageId): string
  177.     {
  178.         return 'error-page-' . $salesChannelId . $domainId . $languageId;
  179.     }
  181.     private function generateKey(string $salesChannelId, string $domainId, string $languageId, Request $request, SalesChannelContext $context): string
  182.     {
  183.         $key = self::buildName($salesChannelId, $domainId, $languageId) . md5($this->generator->getSalesChannelContextHash($context));
  185.         $event = new NotFoundPageCacheKeyEvent($key, $request, $context);
  187.         $this->eventDispatcher->dispatch($event);
  189.         return $event->getKey();
  190.     }
  192.     /**
  193.      * @return list<string>
  194.      */
  195.     private function generateTags(string $name, Request $request, SalesChannelContext $context): array
  196.     {
  197.         $tags = array_merge(
  198.             $this->cacheTracer->get($name),
  199.             [$name, self::ALL_TAG]
  200.         );
  202.         $event = new NotFoundPageTagsEvent($tags, $request, $context);
  204.         $this->eventDispatcher->dispatch($event);
  206.         return array_unique(array_filter($event->getTags()));
  207.     }
  209.     private function setSalesChannelContext(Request $request): void
  210.     {
  211.         $salesChannelId = (string) $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  213.         $context = $this->contextService->get(
  214.             new SalesChannelContextServiceParameters(
  215.                 $salesChannelId,
  216.                 Uuid::randomHex(),
  217.                 $request->headers->get(PlatformRequest::HEADER_LANGUAGE_ID),
  218.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID),
  219.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID)
  220.             )
  221.         );
  223.         $request->attributes->set(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT, $context);
  224.     }
  225. }