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

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. namespace Shopware\Storefront\Framework\Routing\NotFound;
  3. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  4. use Shopware\Core\Framework\Adapter\Cache\CacheInvalidator;
  5. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  6. use Shopware\Core\Framework\Feature;
  7. use Shopware\Core\Framework\Uuid\Uuid;
  8. use Shopware\Core\PlatformRequest;
  9. use Shopware\Core\SalesChannelRequest;
  10. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceInterface;
  11. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceParameters;
  12. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  13. use Shopware\Core\System\SystemConfig\Event\SystemConfigChangedEvent;
  14. use Shopware\Storefront\Controller\ErrorController;
  15. use Shopware\Storefront\Framework\Routing\StorefrontResponse;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\RequestStack;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  21. use Symfony\Component\HttpKernel\Exception\HttpException;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  23. use Symfony\Contracts\Cache\CacheInterface;
  24. use Symfony\Contracts\Cache\ItemInterface;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  26. class NotFoundSubscriber implements EventSubscriberInterface
  27. {
  28.     private const ALL_TAG 'error-page';
  29.     private const SYSTEM_CONFIG_KEY 'core.basicInformation.http404Page';
  30.     private ErrorController $controller;
  31.     private RequestStack $requestStack;
  32.     private SalesChannelContextServiceInterface $contextService;
  33.     private bool $kernelDebug;
  34.     private CacheInterface $cache;
  35.     /**
  36.      * @var AbstractCacheTracer<Response>
  37.      */
  38.     private AbstractCacheTracer $cacheTracer;
  39.     private EntityCacheKeyGenerator $generator;
  40.     private CacheInvalidator $cacheInvalidator;
  41.     private EventDispatcherInterface $eventDispatcher;
  42.     /**
  43.      * @internal
  44.      *
  45.      * @param AbstractCacheTracer<Response> $cacheTracer
  46.      */
  47.     public function __construct(
  48.         ErrorController $controller,
  49.         RequestStack $requestStack,
  50.         SalesChannelContextServiceInterface $contextService,
  51.         bool $kernelDebug,
  52.         CacheInterface $cache,
  53.         AbstractCacheTracer $cacheTracer,
  54.         EntityCacheKeyGenerator $generator,
  55.         CacheInvalidator $cacheInvalidator,
  56.         EventDispatcherInterface $eventDispatcher
  57.     ) {
  58.         $this->controller $controller;
  59.         $this->requestStack $requestStack;
  60.         $this->contextService $contextService;
  61.         $this->kernelDebug $kernelDebug;
  62.         $this->cache $cache;
  63.         $this->cacheTracer $cacheTracer;
  64.         $this->generator $generator;
  65.         $this->cacheInvalidator $cacheInvalidator;
  66.         $this->eventDispatcher $eventDispatcher;
  67.     }
  68.     public static function getSubscribedEvents(): array
  69.     {
  70.         if (Feature::isActive('v6.5.0.0')) {
  71.             return [
  72.                 KernelEvents::EXCEPTION => [
  73.                     ['onError', -100],
  74.                 ],
  75.                 SystemConfigChangedEvent::class => 'onSystemConfigChanged',
  76.             ];
  77.         }
  78.         return [
  79.             SystemConfigChangedEvent::class => 'onSystemConfigChanged',
  80.         ];
  81.     }
  82.     public function onError(ExceptionEvent $event): void
  83.     {
  84.         $request $event->getRequest();
  85.         if ($this->kernelDebug || $request->attributes->has(SalesChannelRequest::ATTRIBUTE_STORE_API_PROXY)) {
  86.             return;
  87.         }
  88.         $event->stopPropagation();
  89.         $salesChannelId $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID'');
  90.         $domainId $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID'');
  91.         $languageId $request->attributes->get(PlatformRequest::HEADER_LANGUAGE_ID'');
  92.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)) {
  93.             // When no sales-channel context is resolved, we need to resolve it now.
  94.             $this->setSalesChannelContext($request);
  95.         }
  96.         $is404StatusCode $event->getThrowable() instanceof HttpException && $event->getThrowable()->getStatusCode() === Response::HTTP_NOT_FOUND;
  97.         // If the exception is not a 404 status code, we don't need to cache it.
  98.         if (!$is404StatusCode) {
  99.             $event->setResponse($this->controller->error(
  100.                 $event->getThrowable(),
  101.                 $request,
  102.                 $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  103.             ));
  104.             return;
  105.         }
  106.         /** @var SalesChannelContext $context */
  107.         $context $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  108.         $name self::buildName($salesChannelId$domainId$languageId);
  109.         $key $this->generateKey($salesChannelId$domainId$languageId$request$context);
  110.         $response $this->cache->get($key, function (ItemInterface $item) use ($event$name$context) {
  111.             /** @var StorefrontResponse $response */
  112.             $response $this->cacheTracer->trace($name, function () use ($event) {
  113.                 /** @var Request $request */
  114.                 $request $this->requestStack->getMainRequest();
  115.                 return $this->controller->error(
  116.                     $event->getThrowable(),
  117.                     $request,
  118.                     $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  119.                 );
  120.             });
  121.             $item->tag($this->generateTags($name$event->getRequest(), $context));
  122.             $response->setData(null);
  123.             $response->setContext(null);
  124.             return $response;
  125.         });
  126.         $event->setResponse($response);
  127.     }
  128.     public function onSystemConfigChanged(SystemConfigChangedEvent $event): void
  129.     {
  130.         if ($event->getKey() !== self::SYSTEM_CONFIG_KEY) {
  131.             return;
  132.         }
  133.         $this->cacheInvalidator->invalidate([self::ALL_TAG]);
  134.     }
  135.     public static function buildName(string $salesChannelIdstring $domainIdstring $languageId): string
  136.     {
  137.         return 'error-page-' $salesChannelId $domainId $languageId;
  138.     }
  139.     private function generateKey(string $salesChannelIdstring $domainIdstring $languageIdRequest $requestSalesChannelContext $context): string
  140.     {
  141.         $key self::buildName($salesChannelId$domainId$languageId) . md5($this->generator->getSalesChannelContextHash($context));
  142.         $event = new NotFoundPageCacheKeyEvent($key$request$context);
  143.         $this->eventDispatcher->dispatch($event);
  144.         return $event->getKey();
  145.     }
  146.     private function generateTags(string $nameRequest $requestSalesChannelContext $context): array
  147.     {
  148.         $tags array_merge(
  149.             $this->cacheTracer->get($name),
  150.             [$nameself::ALL_TAG]
  151.         );
  152.         $event = new NotFoundPageTagsEvent($tags$request$context);
  153.         $this->eventDispatcher->dispatch($event);
  154.         return array_unique(array_filter($event->getTags()));
  155.     }
  156.     private function setSalesChannelContext(Request $request): void
  157.     {
  158.         $salesChannelId = (string) $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  159.         $context $this->contextService->get(
  160.             new SalesChannelContextServiceParameters(
  161.                 $salesChannelId,
  162.                 Uuid::randomHex(),
  163.                 $request->headers->get(PlatformRequest::HEADER_LANGUAGE_ID),
  164.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID),
  165.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID)
  166.             )
  167.         );
  168.         $request->attributes->set(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT$context);
  169.     }
  170. }