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

  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\Log\Package;
  9. use Shopware\Core\Framework\Uuid\Uuid;
  10. use Shopware\Core\PlatformRequest;
  11. use Shopware\Core\SalesChannelRequest;
  12. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceInterface;
  13. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceParameters;
  14. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  15. use Shopware\Core\System\SystemConfig\Event\SystemConfigChangedEvent;
  16. use Shopware\Storefront\Controller\ErrorController;
  17. use Shopware\Storefront\Framework\Routing\StorefrontResponse;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpFoundation\RequestStack;
  21. use Symfony\Component\HttpFoundation\Response;
  22. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  23. use Symfony\Component\HttpKernel\Exception\HttpException;
  24. use Symfony\Component\HttpKernel\KernelEvents;
  25. use Symfony\Contracts\Cache\CacheInterface;
  26. use Symfony\Contracts\Cache\ItemInterface;
  27. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  29. /**
  30.  * @internal
  31.  */
  32. #[Package('storefront')]
  33. class NotFoundSubscriber implements EventSubscriberInterface
  34. {
  35.     private const ALL_TAG = 'error-page';
  36.     private const SYSTEM_CONFIG_KEY = 'core.basicInformation.http404Page';
  38.     /**
  39.      * @internal
  40.      *
  41.      * @param AbstractCacheTracer<Response> $cacheTracer
  42.      */
  43.     public function __construct(
  44.         private readonly ErrorController $controller,
  45.         private readonly RequestStack $requestStack,
  46.         private readonly SalesChannelContextServiceInterface $contextService,
  47.         private bool $kernelDebug,
  48.         private readonly CacheInterface $cache,
  49.         private readonly AbstractCacheTracer $cacheTracer,
  50.         private readonly EntityCacheKeyGenerator $generator,
  51.         private readonly CacheInvalidator $cacheInvalidator,
  52.         private readonly EventDispatcherInterface $eventDispatcher
  53.     ) {
  54.     }
  56.     public static function getSubscribedEvents(): array
  57.     {
  58.         return [
  59.             KernelEvents::EXCEPTION => [
  60.                 ['onError', -100],
  61.             ],
  62.             SystemConfigChangedEvent::class => 'onSystemConfigChanged',
  63.         ];
  64.     }
  66.     public function onError(ExceptionEvent $event): void
  67.     {
  68.         $request = $event->getRequest();
  69.         if ($this->kernelDebug) {
  70.             return;
  71.         }
  73.         $event->stopPropagation();
  75.         $salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID, '');
  76.         $domainId = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID, '');
  77.         $languageId = $request->attributes->get(PlatformRequest::HEADER_LANGUAGE_ID, '');
  79.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)) {
  80.             // When no sales-channel context is resolved, we need to resolve it now.
  81.             $this->setSalesChannelContext($request);
  82.         }
  84.         $is404StatusCode = $event->getThrowable() instanceof HttpException && $event->getThrowable()->getStatusCode() === Response::HTTP_NOT_FOUND;
  86.         // If the exception is not a 404 status code, we don't need to cache it.
  87.         if (!$is404StatusCode) {
  88.             $event->setResponse($this->controller->error(
  89.                 $event->getThrowable(),
  90.                 $request,
  91.                 $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  92.             ));
  94.             return;
  95.         }
  97.         /** @var SalesChannelContext $context */
  98.         $context = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  100.         $name = self::buildName($salesChannelId, $domainId, $languageId);
  101.         $key = $this->generateKey($salesChannelId, $domainId, $languageId, $request, $context);
  103.         $response = $this->cache->get($key, function (ItemInterface $item) use ($event, $name, $context) {
  104.             /** @var StorefrontResponse $response */
  105.             $response = $this->cacheTracer->trace($name, function () use ($event) {
  106.                 /** @var Request $request */
  107.                 $request = $this->requestStack->getMainRequest();
  109.                 return $this->controller->error(
  110.                     $event->getThrowable(),
  111.                     $request,
  112.                     $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  113.                 );
  114.             });
  116.             $item->tag($this->generateTags($name, $event->getRequest(), $context));
  118.             $response->setData([]);
  119.             $response->setContext(null);
  121.             return $response;
  122.         });
  124.         $event->setResponse($response);
  125.     }
  127.     public function onSystemConfigChanged(SystemConfigChangedEvent $event): void
  128.     {
  129.         if ($event->getKey() !== self::SYSTEM_CONFIG_KEY) {
  130.             return;
  131.         }
  133.         $this->cacheInvalidator->invalidate([self::ALL_TAG]);
  134.     }
  136.     private static function buildName(string $salesChannelId, string $domainId, string $languageId): string
  137.     {
  138.         return 'error-page-' . $salesChannelId . $domainId . $languageId;
  139.     }
  141.     private function generateKey(string $salesChannelId, string $domainId, string $languageId, Request $request, SalesChannelContext $context): string
  142.     {
  143.         $key = self::buildName($salesChannelId, $domainId, $languageId) . md5($this->generator->getSalesChannelContextHash($context));
  145.         $event = new NotFoundPageCacheKeyEvent($key, $request, $context);
  147.         $this->eventDispatcher->dispatch($event);
  149.         return $event->getKey();
  150.     }
  152.     /**
  153.      * @return array<string>
  154.      */
  155.     private function generateTags(string $name, Request $request, SalesChannelContext $context): array
  156.     {
  157.         $tags = array_merge(
  158.             $this->cacheTracer->get($name),
  159.             [$name, self::ALL_TAG]
  160.         );
  162.         $event = new NotFoundPageTagsEvent($tags, $request, $context);
  164.         $this->eventDispatcher->dispatch($event);
  166.         return array_unique(array_filter($event->getTags()));
  167.     }
  169.     private function setSalesChannelContext(Request $request): void
  170.     {
  171.         $salesChannelId = (string) $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  173.         $context = $this->contextService->get(
  174.             new SalesChannelContextServiceParameters(
  175.                 $salesChannelId,
  176.                 Uuid::randomHex(),
  177.                 $request->headers->get(PlatformRequest::HEADER_LANGUAGE_ID),
  178.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID),
  179.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID)
  180.             )
  181.         );
  183.         $request->attributes->set(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT, $context);
  184.     }
  185. }