src/Storefront/Controller/StorefrontController.php line 255

  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\StorefrontRenderEvent;
  18. use Shopware\Storefront\Framework\Routing\RequestTransformer;
  19. use Shopware\Storefront\Framework\Routing\Router;
  20. use Shopware\Storefront\Framework\Routing\StorefrontResponse;
  21. use Shopware\Storefront\Framework\Twig\Extension\IconCacheTwigFilter;
  22. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpKernel\EventListener\AbstractSessionListener;
  26. use Twig\Environment;
  28. #[Package('storefront')]
  29. abstract class StorefrontController extends AbstractController
  30. {
  31.     public const SUCCESS = 'success';
  32.     public const DANGER = 'danger';
  33.     public const INFO = 'info';
  34.     public const WARNING = 'warning';
  36.     private Environment $twig;
  38.     public function setTwig(Environment $twig): void
  39.     {
  40.         $this->twig = $twig;
  41.     }
  43.     /**
  44.      * @param array<string, mixed> $parameters
  45.      */
  46.     protected function renderStorefront(string $view, array $parameters = []): Response
  47.     {
  48.         $request = $this->container->get('request_stack')->getCurrentRequest();
  50.         if ($request === null) {
  51.             $request = new Request();
  52.         }
  54.         $salesChannelContext = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  56.         $event = new StorefrontRenderEvent($view, $parameters, $request, $salesChannelContext);
  58.         $this->container->get('event_dispatcher')->dispatch($event);
  60.         $iconCacheEnabled = $this->getSystemConfigService()->get('core.storefrontSettings.iconCache') ?? true;
  62.         if ($iconCacheEnabled) {
  63.             IconCacheTwigFilter::enable();
  64.         }
  66.         $response = Profiler::trace('twig-rendering', fn () => $this->render($view, $event->getParameters(), new StorefrontResponse()));
  68.         if ($iconCacheEnabled) {
  69.             IconCacheTwigFilter::disable();
  70.         }
  72.         if (!$response instanceof StorefrontResponse) {
  73.             throw new \RuntimeException('Symfony render implementation changed. Providing a response is no longer supported');
  74.         }
  76.         $host = $request->attributes->get(RequestTransformer::STOREFRONT_URL);
  78.         $seoUrlReplacer = $this->container->get(SeoUrlPlaceholderHandlerInterface::class);
  79.         $content = $response->getContent();
  80.         if ($content !== false) {
  81.             $response->setContent(
  82.                 $seoUrlReplacer->replace($content, $host, $salesChannelContext)
  83.             );
  84.         }
  86.         $response->setData($parameters);
  87.         $response->setContext($salesChannelContext);
  88.         $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, '1');
  89.         $response->headers->set('Content-Type', 'text/html');
  91.         return $response;
  92.     }
  94.     /**
  95.      * @param array<string, mixed> $parameters
  96.      */
  97.     protected function trans(string $snippet, array $parameters = []): string
  98.     {
  99.         return $this->container
  100.             ->get('translator')
  101.             ->trans($snippet, $parameters);
  102.     }
  104.     protected function createActionResponse(Request $request): Response
  105.     {
  106.         if ($request->get('redirectTo') || $request->get('redirectTo') === '') {
  107.             $params = $this->decodeParam($request, 'redirectParameters');
  109.             $redirectTo = $request->get('redirectTo');
  111.             if ($redirectTo) {
  112.                 return $this->redirectToRoute($redirectTo, $params);
  113.             }
  115.             return $this->redirectToRoute('frontend.home.page', $params);
  116.         }
  118.         if ($request->get('forwardTo')) {
  119.             $params = $this->decodeParam($request, 'forwardParameters');
  121.             return $this->forwardToRoute($request->get('forwardTo'), [], $params);
  122.         }
  124.         return new Response();
  125.     }
  127.     /**
  128.      * @param array<string, mixed> $attributes
  129.      * @param array<string, mixed> $routeParameters
  130.      */
  131.     protected function forwardToRoute(string $routeName, array $attributes = [], array $routeParameters = []): Response
  132.     {
  133.         $router = $this->container->get('router');
  135.         $url = $this->generateUrl($routeName, $routeParameters, Router::PATH_INFO);
  137.         // for the route matching the request method is set to "GET" because
  138.         // this method is not ought to be used as a post passthrough
  139.         // rather it shall return templates or redirects to display results of the request ahead
  140.         $method = $router->getContext()->getMethod();
  141.         $router->getContext()->setMethod(Request::METHOD_GET);
  143.         $route = $router->match($url);
  144.         $router->getContext()->setMethod($method);
  146.         $request = $this->container->get('request_stack')->getCurrentRequest();
  148.         if ($request === null) {
  149.             $request = new Request();
  150.         }
  152.         $attributes = array_merge(
  153.             $this->container->get(RequestTransformerInterface::class)->extractInheritableAttributes($request),
  154.             $route,
  155.             $attributes,
  156.             ['_route_params' => $routeParameters]
  157.         );
  159.         return $this->forward($route['_controller'], $attributes, $routeParameters);
  160.     }
  162.     /**
  163.      * @return array<string, mixed>
  164.      */
  165.     protected function decodeParam(Request $request, string $param): array
  166.     {
  167.         $params = $request->get($param);
  169.         if (\is_string($params)) {
  170.             $params = json_decode($params, true);
  171.         }
  173.         if (empty($params)) {
  174.             $params = [];
  175.         }
  177.         return $params;
  178.     }
  180.     protected function addCartErrors(Cart $cart, ?\Closure $filter = null): void
  181.     {
  182.         $errors = $cart->getErrors();
  183.         if ($filter !== null) {
  184.             $errors = $errors->filter($filter);
  185.         }
  187.         $groups = [
  188.             'info' => $errors->getNotices(),
  189.             'warning' => $errors->getWarnings(),
  190.             'danger' => $errors->getErrors(),
  191.         ];
  193.         $request = $this->container->get('request_stack')->getMainRequest();
  194.         $exists = [];
  196.         if ($request && $request->hasSession() && method_exists($session = $request->getSession(), 'getFlashBag')) {
  197.             $exists = $session->getFlashBag()->peekAll();
  198.         }
  200.         $flat = [];
  201.         foreach ($exists as $messages) {
  202.             $flat = array_merge($flat, $messages);
  203.         }
  205.         /** @var array<string, Error[]> $groups */
  206.         foreach ($groups as $type => $errors) {
  207.             foreach ($errors as $error) {
  208.                 $parameters = [];
  210.                 foreach ($error->getParameters() as $key => $value) {
  211.                     $parameters['%' . $key . '%'] = $value;
  212.                 }
  214.                 if ($error->getRoute() instanceof ErrorRoute) {
  215.                     $parameters['%url%'] = $this->generateUrl(
  216.                         $error->getRoute()->getKey(),
  217.                         $error->getRoute()->getParams()
  218.                     );
  219.                 }
  221.                 $message = $this->trans('checkout.' . $error->getMessageKey(), $parameters);
  223.                 if (\in_array($message, $flat, true)) {
  224.                     continue;
  225.                 }
  227.                 $this->addFlash($type, $message);
  228.             }
  229.         }
  230.     }
  232.     /**
  233.      * @param array<string, mixed> $parameters
  234.      */
  235.     protected function renderView(string $view, array $parameters = []): string
  236.     {
  237.         $view = $this->getTemplateFinder()->find($view);
  239.         if (isset($this->twig)) {
  240.             return $this->twig->render($view, $parameters);
  241.         }
  243.         throw new \Exception(
  244.             sprintf('Class %s does not have twig injected. Add to your service definition a method call to setTwig with the twig instance', static::class)
  245.         );
  246.     }
  248.     protected function getTemplateFinder(): TemplateFinder
  249.     {
  250.         return $this->container->get(TemplateFinder::class);
  251.     }
  253.     protected function hook(Hook $hook): void
  254.     {
  255.         $this->container->get(ScriptExecutor::class)->execute($hook);
  256.     }
  258.     protected function getSystemConfigService(): SystemConfigService
  259.     {
  260.         return $this->container->get(SystemConfigService::class);
  261.     }
  262. }