vendor/shopware/storefront/Framework/Routing/StorefrontSubscriber.php line 195

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Routing;
  5. use Shopware\Core\Checkout\Cart\Exception\CustomerNotLoggedInException;
  6. use Shopware\Core\Checkout\Customer\Event\CustomerLoginEvent;
  7. use Shopware\Core\Checkout\Customer\Event\CustomerLogoutEvent;
  8. use Shopware\Core\Content\Seo\HreflangLoaderInterface;
  9. use Shopware\Core\Content\Seo\HreflangLoaderParameter;
  10. use Shopware\Core\Framework\App\ActiveAppsLoader;
  11. use Shopware\Core\Framework\App\Exception\AppUrlChangeDetectedException;
  12. use Shopware\Core\Framework\App\ShopId\ShopIdProvider;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\Framework\Routing\Event\SalesChannelContextResolvedEvent;
  15. use Shopware\Core\Framework\Routing\KernelListenerPriorities;
  16. use Shopware\Core\Framework\Util\Random;
  17. use Shopware\Core\PlatformRequest;
  18. use Shopware\Core\SalesChannelRequest;
  19. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  20. use Shopware\Core\System\SystemConfig\SystemConfigService;
  21. use Shopware\Storefront\Event\StorefrontRenderEvent;
  22. use Shopware\Storefront\Theme\StorefrontPluginRegistryInterface;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  24. use Symfony\Component\HttpFoundation\RedirectResponse;
  25. use Symfony\Component\HttpFoundation\RequestStack;
  26. use Symfony\Component\HttpFoundation\Response;
  27. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  28. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  29. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  30. use Symfony\Component\HttpKernel\Event\RequestEvent;
  31. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  32. use Symfony\Component\HttpKernel\KernelEvents;
  33. use Symfony\Component\Routing\RouterInterface;
  35. /**
  36.  * @internal
  37.  */
  38. #[Package('storefront')]
  39. class StorefrontSubscriber implements EventSubscriberInterface
  40. {
  41.     /**
  42.      * @internal
  43.      */
  44.     public function __construct(
  45.         private readonly RequestStack $requestStack,
  46.         private readonly RouterInterface $router,
  47.         private readonly HreflangLoaderInterface $hreflangLoader,
  48.         private readonly MaintenanceModeResolver $maintenanceModeResolver,
  49.         private readonly ShopIdProvider $shopIdProvider,
  50.         private readonly ActiveAppsLoader $activeAppsLoader,
  51.         private readonly SystemConfigService $systemConfigService,
  52.         private readonly StorefrontPluginRegistryInterface $themeRegistry
  53.     ) {
  54.     }
  56.     public static function getSubscribedEvents(): array
  57.     {
  58.         return [
  59.             KernelEvents::REQUEST => [
  60.                 ['startSession', 40],
  61.                 ['maintenanceResolver'],
  62.             ],
  63.             KernelEvents::EXCEPTION => [
  64.                 ['customerNotLoggedInHandler'],
  65.                 ['maintenanceResolver'],
  66.             ],
  67.             KernelEvents::CONTROLLER => [
  68.                 ['preventPageLoadingFromXmlHttpRequest', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE],
  69.             ],
  70.             CustomerLoginEvent::class => [
  71.                 'updateSessionAfterLogin',
  72.             ],
  73.             CustomerLogoutEvent::class => [
  74.                 'updateSessionAfterLogout',
  75.             ],
  76.             StorefrontRenderEvent::class => [
  77.                 ['addHreflang'],
  78.                 ['addShopIdParameter'],
  79.                 ['addIconSetConfig'],
  80.             ],
  81.             SalesChannelContextResolvedEvent::class => [
  82.                 ['replaceContextToken'],
  83.             ],
  84.         ];
  85.     }
  87.     public function startSession(): void
  88.     {
  89.         $master = $this->requestStack->getMainRequest();
  91.         if (!$master) {
  92.             return;
  93.         }
  94.         if (!$master->attributes->get(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST)) {
  95.             return;
  96.         }
  98.         if (!$master->hasSession()) {
  99.             return;
  100.         }
  102.         $session = $master->getSession();
  104.         if (!$session->isStarted()) {
  105.             $session->setName('session-');
  106.             $session->start();
  107.             $session->set('sessionId', $session->getId());
  108.         }
  110.         $salesChannelId = $master->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  111.         if ($salesChannelId === null) {
  112.             /** @var SalesChannelContext|null $salesChannelContext */
  113.             $salesChannelContext = $master->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  114.             if ($salesChannelContext !== null) {
  115.                 $salesChannelId = $salesChannelContext->getSalesChannel()->getId();
  116.             }
  117.         }
  119.         if ($this->shouldRenewToken($session, $salesChannelId)) {
  120.             $token = Random::getAlphanumericString(32);
  121.             $session->set(PlatformRequest::HEADER_CONTEXT_TOKEN, $token);
  122.             $session->set(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID, $salesChannelId);
  123.         }
  125.         $master->headers->set(
  126.             PlatformRequest::HEADER_CONTEXT_TOKEN,
  127.             $session->get(PlatformRequest::HEADER_CONTEXT_TOKEN)
  128.         );
  129.     }
  131.     public function updateSessionAfterLogin(CustomerLoginEvent $event): void
  132.     {
  133.         $token = $event->getContextToken();
  135.         $this->updateSession($token);
  136.     }
  138.     public function updateSessionAfterLogout(): void
  139.     {
  140.         $newToken = Random::getAlphanumericString(32);
  142.         $this->updateSession($newToken, true);
  143.     }
  145.     public function updateSession(string $token, bool $destroyOldSession = false): void
  146.     {
  147.         $master = $this->requestStack->getMainRequest();
  148.         if (!$master) {
  149.             return;
  150.         }
  151.         if (!$master->attributes->get(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST)) {
  152.             return;
  153.         }
  155.         if (!$master->hasSession()) {
  156.             return;
  157.         }
  159.         $session = $master->getSession();
  160.         $session->migrate($destroyOldSession);
  161.         $session->set('sessionId', $session->getId());
  163.         $session->set(PlatformRequest::HEADER_CONTEXT_TOKEN, $token);
  164.         $master->headers->set(PlatformRequest::HEADER_CONTEXT_TOKEN, $token);
  165.     }
  167.     public function customerNotLoggedInHandler(ExceptionEvent $event): void
  168.     {
  169.         if (!$event->getRequest()->attributes->has(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST)) {
  170.             return;
  171.         }
  173.         if (!$event->getThrowable() instanceof CustomerNotLoggedInException) {
  174.             return;
  175.         }
  177.         $request = $event->getRequest();
  179.         $parameters = [
  180.             'redirectTo' => $request->attributes->get('_route'),
  181.             'redirectParameters' => json_encode($request->attributes->get('_route_params'), \JSON_THROW_ON_ERROR),
  182.         ];
  184.         $redirectResponse = new RedirectResponse($this->router->generate('frontend.account.login.page', $parameters));
  186.         $event->setResponse($redirectResponse);
  187.     }
  189.     public function maintenanceResolver(RequestEvent $event): void
  190.     {
  191.         if ($this->maintenanceModeResolver->shouldRedirect($event->getRequest())) {
  192.             $event->setResponse(
  193.                 new RedirectResponse(
  194.                     $this->router->generate('frontend.maintenance.page'),
  195.                     RedirectResponse::HTTP_TEMPORARY_REDIRECT
  196.                 )
  197.             );
  198.         }
  199.     }
  201.     public function preventPageLoadingFromXmlHttpRequest(ControllerEvent $event): void
  202.     {
  203.         if (!$event->getRequest()->isXmlHttpRequest()) {
  204.             return;
  205.         }
  207.         /** @var list<string> $scope */
  208.         $scope = $event->getRequest()->attributes->get(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, []);
  210.         if (!\in_array(StorefrontRouteScope::ID, $scope, true)) {
  211.             return;
  212.         }
  214.         /** @var callable(): Response $controller */
  215.         $controller = $event->getController();
  217.         // happens if Controller is a closure
  218.         if (!\is_array($controller)) {
  219.             return;
  220.         }
  222.         $isAllowed = $event->getRequest()->attributes->getBoolean('XmlHttpRequest');
  224.         if ($isAllowed) {
  225.             return;
  226.         }
  228.         throw new AccessDeniedHttpException('PageController can\'t be requested via XmlHttpRequest.');
  229.     }
  231.     // used to switch session token - when the context token expired
  232.     public function replaceContextToken(SalesChannelContextResolvedEvent $event): void
  233.     {
  234.         $context = $event->getSalesChannelContext();
  236.         // only update session if token expired and switched
  237.         if ($event->getUsedToken() === $context->getToken()) {
  238.             return;
  239.         }
  241.         $this->updateSession($context->getToken());
  242.     }
  244.     public function addHreflang(StorefrontRenderEvent $event): void
  245.     {
  246.         $request = $event->getRequest();
  247.         $route = $request->attributes->get('_route');
  249.         if ($route === null) {
  250.             return;
  251.         }
  253.         $routeParams = $request->attributes->get('_route_params', []);
  254.         $salesChannelContext = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  255.         $parameter = new HreflangLoaderParameter($route, $routeParams, $salesChannelContext);
  256.         $event->setParameter('hrefLang', $this->hreflangLoader->load($parameter));
  257.     }
  259.     public function addShopIdParameter(StorefrontRenderEvent $event): void
  260.     {
  261.         if (!$this->activeAppsLoader->getActiveApps()) {
  262.             return;
  263.         }
  265.         try {
  266.             $shopId = $this->shopIdProvider->getShopId();
  267.         } catch (AppUrlChangeDetectedException) {
  268.             return;
  269.         }
  271.         $event->setParameter('appShopId', $shopId);
  272.     }
  274.     public function addIconSetConfig(StorefrontRenderEvent $event): void
  275.     {
  276.         $request = $event->getRequest();
  278.         // get name if theme is not inherited
  279.         $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_NAME);
  281.         if (!$theme) {
  282.             // get theme name from base theme because for inherited themes the name is always null
  283.             $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME);
  284.         }
  286.         if (!$theme) {
  287.             return;
  288.         }
  290.         $themeConfig = $this->themeRegistry->getConfigurations()->getByTechnicalName($theme);
  292.         if (!$themeConfig) {
  293.             return;
  294.         }
  296.         $iconConfig = [];
  297.         foreach ($themeConfig->getIconSets() as $pack => $path) {
  298.             $iconConfig[$pack] = [
  299.                 'path' => $path,
  300.                 'namespace' => $theme,
  301.             ];
  302.         }
  304.         $event->setParameter('themeIconConfig', $iconConfig);
  305.     }
  307.     private function shouldRenewToken(SessionInterface $session, ?string $salesChannelId = null): bool
  308.     {
  309.         if (!$session->has(PlatformRequest::HEADER_CONTEXT_TOKEN) || $salesChannelId === null) {
  310.             return true;
  311.         }
  313.         if ($this->systemConfigService->get('core.systemWideLoginRegistration.isCustomerBoundToSalesChannel')) {
  314.             return $session->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID) !== $salesChannelId;
  315.         }
  317.         return false;
  318.     }
  319. }