src/Storefront/Framework/Routing/NotFound/NotFoundSubscriber.php line 57

  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(private readonly ErrorController $controller, private readonly RequestStack $requestStack, private readonly SalesChannelContextServiceInterface $contextService, private bool $kernelDebug, private readonly CacheInterface $cache, private readonly AbstractCacheTracer $cacheTracer, private readonly EntityCacheKeyGenerator $generator, private readonly CacheInvalidator $cacheInvalidator, private readonly EventDispatcherInterface $eventDispatcher)
  44.     {
  45.     }
  47.     public static function getSubscribedEvents(): array
  48.     {
  49.         return [
  50.             KernelEvents::EXCEPTION => [
  51.                 ['onError', -100],
  52.             ],
  53.             SystemConfigChangedEvent::class => 'onSystemConfigChanged',
  54.         ];
  55.     }
  57.     public function onError(ExceptionEvent $event): void
  58.     {
  59.         $request = $event->getRequest();
  60.         if ($this->kernelDebug) {
  61.             return;
  62.         }
  64.         $event->stopPropagation();
  66.         $salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID, '');
  67.         $domainId = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID, '');
  68.         $languageId = $request->attributes->get(PlatformRequest::HEADER_LANGUAGE_ID, '');
  70.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)) {
  71.             // When no sales-channel context is resolved, we need to resolve it now.
  72.             $this->setSalesChannelContext($request);
  73.         }
  75.         $is404StatusCode = $event->getThrowable() instanceof HttpException && $event->getThrowable()->getStatusCode() === Response::HTTP_NOT_FOUND;
  77.         // If the exception is not a 404 status code, we don't need to cache it.
  78.         if (!$is404StatusCode) {
  79.             $event->setResponse($this->controller->error(
  80.                 $event->getThrowable(),
  81.                 $request,
  82.                 $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  83.             ));
  85.             return;
  86.         }
  88.         /** @var SalesChannelContext $context */
  89.         $context = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  91.         $name = self::buildName($salesChannelId, $domainId, $languageId);
  92.         $key = $this->generateKey($salesChannelId, $domainId, $languageId, $request, $context);
  94.         $response = $this->cache->get($key, function (ItemInterface $item) use ($event, $name, $context) {
  95.             /** @var StorefrontResponse $response */
  96.             $response = $this->cacheTracer->trace($name, function () use ($event) {
  97.                 /** @var Request $request */
  98.                 $request = $this->requestStack->getMainRequest();
  100.                 return $this->controller->error(
  101.                     $event->getThrowable(),
  102.                     $request,
  103.                     $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT)
  104.                 );
  105.             });
  107.             $item->tag($this->generateTags($name, $event->getRequest(), $context));
  109.             $response->setData([]);
  110.             $response->setContext(null);
  112.             return $response;
  113.         });
  115.         $event->setResponse($response);
  116.     }
  118.     public function onSystemConfigChanged(SystemConfigChangedEvent $event): void
  119.     {
  120.         if ($event->getKey() !== self::SYSTEM_CONFIG_KEY) {
  121.             return;
  122.         }
  124.         $this->cacheInvalidator->invalidate([self::ALL_TAG]);
  125.     }
  127.     private static function buildName(string $salesChannelId, string $domainId, string $languageId): string
  128.     {
  129.         return 'error-page-' . $salesChannelId . $domainId . $languageId;
  130.     }
  132.     private function generateKey(string $salesChannelId, string $domainId, string $languageId, Request $request, SalesChannelContext $context): string
  133.     {
  134.         $key = self::buildName($salesChannelId, $domainId, $languageId) . md5($this->generator->getSalesChannelContextHash($context));
  136.         $event = new NotFoundPageCacheKeyEvent($key, $request, $context);
  138.         $this->eventDispatcher->dispatch($event);
  140.         return $event->getKey();
  141.     }
  143.     /**
  144.      * @return array<string>
  145.      */
  146.     private function generateTags(string $name, Request $request, SalesChannelContext $context): array
  147.     {
  148.         $tags = array_merge(
  149.             $this->cacheTracer->get($name),
  150.             [$name, self::ALL_TAG]
  151.         );
  153.         $event = new NotFoundPageTagsEvent($tags, $request, $context);
  155.         $this->eventDispatcher->dispatch($event);
  157.         return array_unique(array_filter($event->getTags()));
  158.     }
  160.     private function setSalesChannelContext(Request $request): void
  161.     {
  162.         $salesChannelId = (string) $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  164.         $context = $this->contextService->get(
  165.             new SalesChannelContextServiceParameters(
  166.                 $salesChannelId,
  167.                 Uuid::randomHex(),
  168.                 $request->headers->get(PlatformRequest::HEADER_LANGUAGE_ID),
  169.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID),
  170.                 $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID)
  171.             )
  172.         );
  174.         $request->attributes->set(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT, $context);
  175.     }
  176. }