vendor/shopware/storefront/Controller/StorefrontController.php line 199

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Checkout\Cart\Cart;
  6. use Shopware\Core\Checkout\Cart\Error\Error;
  7. use Shopware\Core\Checkout\Cart\Error\ErrorRoute;
  8. use Shopware\Core\Content\Seo\SeoUrlPlaceholderHandlerInterface;
  9. use Shopware\Core\Framework\Adapter\Twig\TemplateFinder;
  10. use Shopware\Core\Framework\Log\Package;
  11. use Shopware\Core\Framework\Routing\RequestTransformerInterface;
  12. use Shopware\Core\Framework\Script\Execution\Hook;
  13. use Shopware\Core\Framework\Script\Execution\ScriptExecutor;
  14. use Shopware\Core\PlatformRequest;
  15. use Shopware\Core\Profiling\Profiler;
  16. use Shopware\Core\System\SystemConfig\SystemConfigService;
  17. use Shopware\Storefront\Event\StorefrontRedirectEvent;
  18. use Shopware\Storefront\Event\StorefrontRenderEvent;
  19. use Shopware\Storefront\Framework\Routing\RequestTransformer;
  20. use Shopware\Storefront\Framework\Routing\Router;
  21. use Shopware\Storefront\Framework\Routing\StorefrontResponse;
  22. use Shopware\Storefront\Framework\Twig\Extension\IconCacheTwigFilter;
  23. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  24. use Symfony\Component\HttpFoundation\RedirectResponse;
  25. use Symfony\Component\HttpFoundation\Request;
  26. use Symfony\Component\HttpFoundation\Response;
  27. use Symfony\Component\HttpFoundation\Session\FlashBagAwareSessionInterface;
  28. use Twig\Environment;
  30. #[Package('storefront')]
  31. abstract class StorefrontController extends AbstractController
  32. {
  33.     public const SUCCESS = 'success';
  34.     public const DANGER = 'danger';
  35.     public const INFO = 'info';
  36.     public const WARNING = 'warning';
  38.     private ?Environment $twig = null;
  40.     public function setTwig(Environment $twig): void
  41.     {
  42.         $this->twig = $twig;
  43.     }
  45.     /**
  46.      * @param array<string, mixed> $parameters
  47.      */
  48.     protected function renderStorefront(string $view, array $parameters = []): Response
  49.     {
  50.         $request = $this->container->get('request_stack')->getCurrentRequest();
  52.         if ($request === null) {
  53.             $request = new Request();
  54.         }
  56.         $salesChannelContext = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  58.         $event = new StorefrontRenderEvent($view, $parameters, $request, $salesChannelContext);
  60.         $this->container->get('event_dispatcher')->dispatch($event);
  62.         $iconCacheEnabled = $this->getSystemConfigService()->get('core.storefrontSettings.iconCache') ?? true;
  64.         if ($iconCacheEnabled) {
  65.             IconCacheTwigFilter::enable();
  66.         }
  68.         $response = Profiler::trace('twig-rendering', fn () => $this->render($view, $event->getParameters(), new StorefrontResponse()));
  70.         if ($iconCacheEnabled) {
  71.             IconCacheTwigFilter::disable();
  72.         }
  74.         if (!$response instanceof StorefrontResponse) {
  75.             throw new \RuntimeException('Symfony render implementation changed. Providing a response is no longer supported');
  76.         }
  78.         $host = $request->attributes->get(RequestTransformer::STOREFRONT_URL);
  80.         $seoUrlReplacer = $this->container->get(SeoUrlPlaceholderHandlerInterface::class);
  81.         $content = $response->getContent();
  82.         if ($content !== false) {
  83.             $response->setContent(
  84.                 $seoUrlReplacer->replace($content, $host, $salesChannelContext)
  85.             );
  86.         }
  88.         $response->setData($parameters);
  89.         $response->setContext($salesChannelContext);
  91.         $response->headers->set('Content-Type', 'text/html');
  93.         return $response;
  94.     }
  96.     /**
  97.      * @param array<string, mixed> $parameters
  98.      */
  99.     protected function trans(string $snippet, array $parameters = []): string
  100.     {
  101.         return $this->container
  102.             ->get('translator')
  103.             ->trans($snippet, $parameters);
  104.     }
  106.     protected function createActionResponse(Request $request): Response
  107.     {
  108.         if ($request->get('redirectTo') || $request->get('redirectTo') === '') {
  109.             $params = $this->decodeParam($request, 'redirectParameters');
  111.             $redirectTo = $request->get('redirectTo');
  113.             if ($redirectTo) {
  114.                 return $this->redirectToRoute($redirectTo, $params);
  115.             }
  117.             return $this->redirectToRoute('frontend.home.page', $params);
  118.         }
  120.         if ($request->get('forwardTo')) {
  121.             $params = $this->decodeParam($request, 'forwardParameters');
  123.             return $this->forwardToRoute($request->get('forwardTo'), [], $params);
  124.         }
  126.         return new Response();
  127.     }
  129.     /**
  130.      * @param array<string, mixed> $attributes
  131.      * @param array<string, mixed> $routeParameters
  132.      */
  133.     protected function forwardToRoute(string $routeName, array $attributes = [], array $routeParameters = []): Response
  134.     {
  135.         $router = $this->container->get('router');
  137.         $url = $this->generateUrl($routeName, $routeParameters, Router::PATH_INFO);
  139.         // for the route matching the request method is set to "GET" because
  140.         // this method is not ought to be used as a post passthrough
  141.         // rather it shall return templates or redirects to display results of the request ahead
  142.         $method = $router->getContext()->getMethod();
  143.         $router->getContext()->setMethod(Request::METHOD_GET);
  145.         $route = $router->match($url);
  146.         $router->getContext()->setMethod($method);
  148.         $request = $this->container->get('request_stack')->getCurrentRequest();
  150.         if ($request === null) {
  151.             $request = new Request();
  152.         }
  154.         $attributes = array_merge(
  155.             $this->container->get(RequestTransformerInterface::class)->extractInheritableAttributes($request),
  156.             $route,
  157.             $attributes,
  158.             ['_route_params' => $routeParameters]
  159.         );
  161.         return $this->forward($route['_controller'], $attributes, $routeParameters);
  162.     }
  164.     /**
  165.      * @return array<string, mixed>
  166.      */
  167.     protected function decodeParam(Request $request, string $param): array
  168.     {
  169.         $params = $request->get($param);
  171.         if (\is_string($params)) {
  172.             $params = json_decode($params, true);
  173.         }
  175.         if (empty($params)) {
  176.             $params = [];
  177.         }
  179.         return $params;
  180.     }
  182.     protected function addCartErrors(Cart $cart, ?\Closure $filter = null): void
  183.     {
  184.         $errors = $cart->getErrors();
  185.         if ($filter !== null) {
  186.             $errors = $errors->filter($filter);
  187.         }
  189.         $groups = [
  190.             'info' => $errors->getNotices(),
  191.             'warning' => $errors->getWarnings(),
  192.             'danger' => $errors->getErrors(),
  193.         ];
  195.         $request = $this->container->get('request_stack')->getMainRequest();
  196.         $exists = [];
  198.         if ($request && $request->hasSession() && $request->getSession() instanceof FlashBagAwareSessionInterface) {
  199.             $exists = $request->getSession()->getFlashBag()->peekAll();
  200.         }
  202.         $flat = [];
  203.         foreach ($exists as $messages) {
  204.             $flat = array_merge($flat, $messages);
  205.         }
  207.         /** @var array<string, Error[]> $groups */
  208.         foreach ($groups as $type => $errors) {
  209.             foreach ($errors as $error) {
  210.                 $parameters = [];
  212.                 foreach ($error->getParameters() as $key => $value) {
  213.                     $parameters['%' . $key . '%'] = $value;
  214.                 }
  216.                 if ($error->getRoute() instanceof ErrorRoute) {
  217.                     $parameters['%url%'] = $this->generateUrl(
  218.                         $error->getRoute()->getKey(),
  219.                         $error->getRoute()->getParams()
  220.                     );
  221.                 }
  223.                 $message = $this->trans('checkout.' . $error->getMessageKey(), $parameters);
  225.                 if (\in_array($message, $flat, true)) {
  226.                     continue;
  227.                 }
  229.                 $this->addFlash($type, $message);
  230.             }
  231.         }
  232.     }
  234.     /**
  235.      * @param array<string, mixed> $parameters
  236.      */
  237.     protected function redirectToRoute(string $route, array $parameters = [], int $status = Response::HTTP_FOUND): RedirectResponse
  238.     {
  239.         $event = new StorefrontRedirectEvent($route, $parameters, $status);
  240.         $this->container->get('event_dispatcher')->dispatch($event);
  242.         return parent::redirectToRoute($event->getRoute(), $event->getParameters(), $event->getStatus());
  243.     }
  245.     /**
  246.      * @param array<string, mixed> $parameters
  247.      */
  248.     protected function renderView(string $view, array $parameters = []): string
  249.     {
  250.         $view = $this->getTemplateFinder()->find($view);
  252.         if ($this->twig !== null) {
  253.             return $this->twig->render($view, $parameters);
  254.         }
  256.         throw new \Exception(
  257.             sprintf('Class %s does not have twig injected. Add to your service definition a method call to setTwig with the twig instance', static::class)
  258.         );
  259.     }
  261.     protected function getTemplateFinder(): TemplateFinder
  262.     {
  263.         return $this->container->get(TemplateFinder::class);
  264.     }
  266.     protected function hook(Hook $hook): void
  267.     {
  268.         $this->container->get(ScriptExecutor::class)->execute($hook);
  269.     }
  271.     protected function getSystemConfigService(): SystemConfigService
  272.     {
  273.         return $this->container->get(SystemConfigService::class);
  274.     }
  275. }