vendor/shopware/storefront/Controller/CheckoutController.php line 124

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Checkout\Cart\Error\Error;
  6. use Shopware\Core\Checkout\Cart\Error\ErrorCollection;
  7. use Shopware\Core\Checkout\Cart\Exception\CartTokenNotFoundException;
  8. use Shopware\Core\Checkout\Cart\Exception\CustomerNotLoggedInException;
  9. use Shopware\Core\Checkout\Cart\Exception\InvalidCartException;
  10. use Shopware\Core\Checkout\Cart\Exception\OrderNotFoundException;
  11. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  12. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractLogoutRoute;
  13. use Shopware\Core\Checkout\Order\Exception\EmptyCartException;
  14. use Shopware\Core\Checkout\Order\SalesChannel\OrderService;
  15. use Shopware\Core\Checkout\Payment\Exception\InvalidOrderException;
  16. use Shopware\Core\Checkout\Payment\Exception\PaymentProcessException;
  17. use Shopware\Core\Checkout\Payment\Exception\UnknownPaymentMethodException;
  18. use Shopware\Core\Checkout\Payment\PaymentService;
  19. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  20. use Shopware\Core\Framework\Routing\Annotation\Since;
  21. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  22. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  23. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  24. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  25. use Shopware\Core\System\SystemConfig\SystemConfigService;
  26. use Shopware\Storefront\Checkout\Cart\Error\PaymentMethodChangedError;
  27. use Shopware\Storefront\Checkout\Cart\Error\ShippingMethodChangedError;
  28. use Shopware\Storefront\Framework\AffiliateTracking\AffiliateTrackingListener;
  29. use Shopware\Storefront\Framework\Routing\Annotation\NoStore;
  30. use Shopware\Storefront\Page\Checkout\Cart\CheckoutCartPageLoadedHook;
  31. use Shopware\Storefront\Page\Checkout\Cart\CheckoutCartPageLoader;
  32. use Shopware\Storefront\Page\Checkout\Confirm\CheckoutConfirmPageLoadedHook;
  33. use Shopware\Storefront\Page\Checkout\Confirm\CheckoutConfirmPageLoader;
  34. use Shopware\Storefront\Page\Checkout\Finish\CheckoutFinishPageLoadedHook;
  35. use Shopware\Storefront\Page\Checkout\Finish\CheckoutFinishPageLoader;
  36. use Shopware\Storefront\Page\Checkout\Offcanvas\CheckoutInfoWidgetLoadedHook;
  37. use Shopware\Storefront\Page\Checkout\Offcanvas\CheckoutOffcanvasWidgetLoadedHook;
  38. use Shopware\Storefront\Page\Checkout\Offcanvas\OffcanvasCartPageLoader;
  39. use Symfony\Component\HttpFoundation\RedirectResponse;
  40. use Symfony\Component\HttpFoundation\Request;
  41. use Symfony\Component\HttpFoundation\Response;
  42. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  43. use Symfony\Component\Routing\Annotation\Route;
  45. /**
  46.  * @RouteScope(scopes={"storefront"})
  47.  */
  48. class CheckoutController extends StorefrontController
  49. {
  50.     private const REDIRECTED_FROM_SAME_ROUTE = 'redirected';
  52.     /**
  53.      * @var CartService
  54.      */
  55.     private $cartService;
  57.     /**
  58.      * @var CheckoutCartPageLoader
  59.      */
  60.     private $cartPageLoader;
  62.     /**
  63.      * @var CheckoutConfirmPageLoader
  64.      */
  65.     private $confirmPageLoader;
  67.     /**
  68.      * @var CheckoutFinishPageLoader
  69.      */
  70.     private $finishPageLoader;
  72.     /**
  73.      * @var OrderService
  74.      */
  75.     private $orderService;
  77.     /**
  78.      * @var PaymentService
  79.      */
  80.     private $paymentService;
  82.     /**
  83.      * @var OffcanvasCartPageLoader
  84.      */
  85.     private $offcanvasCartPageLoader;
  87.     /**
  88.      * @var SystemConfigService
  89.      */
  90.     private $config;
  92.     /**
  93.      * @var AbstractLogoutRoute
  94.      */
  95.     private $logoutRoute;
  97.     public function __construct(
  98.         CartService $cartService,
  99.         CheckoutCartPageLoader $cartPageLoader,
  100.         CheckoutConfirmPageLoader $confirmPageLoader,
  101.         CheckoutFinishPageLoader $finishPageLoader,
  102.         OrderService $orderService,
  103.         PaymentService $paymentService,
  104.         OffcanvasCartPageLoader $offcanvasCartPageLoader,
  105.         SystemConfigService $config,
  106.         AbstractLogoutRoute $logoutRoute
  107.     ) {
  108.         $this->cartService = $cartService;
  109.         $this->cartPageLoader = $cartPageLoader;
  110.         $this->confirmPageLoader = $confirmPageLoader;
  111.         $this->finishPageLoader = $finishPageLoader;
  112.         $this->orderService = $orderService;
  113.         $this->paymentService = $paymentService;
  114.         $this->offcanvasCartPageLoader = $offcanvasCartPageLoader;
  115.         $this->config = $config;
  116.         $this->logoutRoute = $logoutRoute;
  117.     }
  119.     /**
  120.      * @Since("6.0.0.0")
  121.      * @NoStore
  122.      * @Route("/checkout/cart", name="frontend.checkout.cart.page", options={"seo"="false"}, methods={"GET"})
  123.      */
  124.     public function cartPage(Request $request, SalesChannelContext $context): Response
  125.     {
  126.         $page = $this->cartPageLoader->load($request, $context);
  127.         $cart = $page->getCart();
  128.         $cartErrors = $cart->getErrors();
  130.         $this->hook(new CheckoutCartPageLoadedHook($page, $context));
  132.         $this->addCartErrors($cart);
  134.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  135.             $cartErrors->clear();
  137.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  138.             return $this->redirectToRoute(
  139.                 'frontend.checkout.cart.page',
  140.                 [
  141.                     self::REDIRECTED_FROM_SAME_ROUTE => true,
  142.                 ]
  143.             );
  144.         }
  145.         $cartErrors->clear();
  147.         return $this->renderStorefront('@Storefront/storefront/page/checkout/cart/index.html.twig', ['page' => $page]);
  148.     }
  150.     /**
  151.      * @Since("6.0.0.0")
  152.      * @NoStore
  153.      * @Route("/checkout/confirm", name="frontend.checkout.confirm.page", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  154.      */
  155.     public function confirmPage(Request $request, SalesChannelContext $context): Response
  156.     {
  157.         if (!$context->getCustomer()) {
  158.             return $this->redirectToRoute('frontend.checkout.register.page');
  159.         }
  161.         if ($this->cartService->getCart($context->getToken(), $context)->getLineItems()->count() === 0) {
  162.             return $this->redirectToRoute('frontend.checkout.cart.page');
  163.         }
  165.         $page = $this->confirmPageLoader->load($request, $context);
  167.         $this->hook(new CheckoutConfirmPageLoadedHook($page, $context));
  169.         $this->addCartErrors($page->getCart());
  171.         return $this->renderStorefront('@Storefront/storefront/page/checkout/confirm/index.html.twig', ['page' => $page]);
  172.     }
  174.     /**
  175.      * @Since("6.0.0.0")
  176.      * @Route("/checkout/finish", name="frontend.checkout.finish.page", options={"seo"="false"}, methods={"GET"})
  177.      * @NoStore
  178.      *
  179.      * @throws CustomerNotLoggedInException
  180.      * @throws MissingRequestParameterException
  181.      * @throws OrderNotFoundException
  182.      */
  183.     public function finishPage(Request $request, SalesChannelContext $context, RequestDataBag $dataBag): Response
  184.     {
  185.         if ($context->getCustomer() === null) {
  186.             return $this->redirectToRoute('frontend.checkout.register.page');
  187.         }
  189.         $page = $this->finishPageLoader->load($request, $context);
  191.         $this->hook(new CheckoutFinishPageLoadedHook($page, $context));
  193.         if ($page->isPaymentFailed() === true) {
  194.             return $this->redirectToRoute(
  195.                 'frontend.account.edit-order.page',
  196.                 [
  197.                     'orderId' => $request->get('orderId'),
  198.                     'error-code' => 'CHECKOUT__UNKNOWN_ERROR',
  199.                 ]
  200.             );
  201.         }
  203.         if ($context->getCustomer()->getGuest() && $this->config->get('core.cart.logoutGuestAfterCheckout', $context->getSalesChannelId())) {
  204.             $this->logoutRoute->logout($context, $dataBag);
  205.         }
  207.         return $this->renderStorefront('@Storefront/storefront/page/checkout/finish/index.html.twig', ['page' => $page]);
  208.     }
  210.     /**
  211.      * @Since("6.0.0.0")
  212.      * @Route("/checkout/order", name="frontend.checkout.finish.order", options={"seo"="false"}, methods={"POST"})
  213.      */
  214.     public function order(RequestDataBag $data, SalesChannelContext $context, Request $request): Response
  215.     {
  216.         if (!$context->getCustomer()) {
  217.             return $this->redirectToRoute('frontend.checkout.register.page');
  218.         }
  220.         try {
  221.             $this->addAffiliateTracking($data, $request->getSession());
  223.             $orderId = $this->orderService->createOrder($data, $context);
  224.         } catch (ConstraintViolationException $formViolations) {
  225.             return $this->forwardToRoute('frontend.checkout.confirm.page', ['formViolations' => $formViolations]);
  226.         } catch (InvalidCartException | Error | EmptyCartException $error) {
  227.             $this->addCartErrors(
  228.                 $this->cartService->getCart($context->getToken(), $context)
  229.             );
  231.             return $this->forwardToRoute('frontend.checkout.confirm.page');
  232.         }
  234.         try {
  235.             $finishUrl = $this->generateUrl('frontend.checkout.finish.page', ['orderId' => $orderId]);
  236.             $errorUrl = $this->generateUrl('frontend.account.edit-order.page', ['orderId' => $orderId]);
  238.             $response = $this->paymentService->handlePaymentByOrder($orderId, $data, $context, $finishUrl, $errorUrl);
  240.             return $response ?? new RedirectResponse($finishUrl);
  241.         } catch (PaymentProcessException | InvalidOrderException | UnknownPaymentMethodException $e) {
  242.             return $this->forwardToRoute('frontend.checkout.finish.page', ['orderId' => $orderId, 'changedPayment' => false, 'paymentFailed' => true]);
  243.         }
  244.     }
  246.     /**
  247.      * @Since("6.0.0.0")
  248.      * @Route("/widgets/checkout/info", name="frontend.checkout.info", methods={"GET"}, defaults={"XmlHttpRequest"=true})
  249.      *
  250.      * @throws CartTokenNotFoundException
  251.      */
  252.     public function info(Request $request, SalesChannelContext $context): Response
  253.     {
  254.         $page = $this->offcanvasCartPageLoader->load($request, $context);
  256.         $this->hook(new CheckoutInfoWidgetLoadedHook($page, $context));
  258.         $response = $this->renderStorefront('@Storefront/storefront/layout/header/actions/cart-widget.html.twig', ['page' => $page]);
  259.         $response->headers->set('x-robots-tag', 'noindex');
  261.         return $response;
  262.     }
  264.     /**
  265.      * @Since("6.0.0.0")
  266.      * @Route("/checkout/offcanvas", name="frontend.cart.offcanvas", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  267.      *
  268.      * @throws CartTokenNotFoundException
  269.      */
  270.     public function offcanvas(Request $request, SalesChannelContext $context): Response
  271.     {
  272.         $page = $this->offcanvasCartPageLoader->load($request, $context);
  274.         $this->hook(new CheckoutOffcanvasWidgetLoadedHook($page, $context));
  276.         $cart = $page->getCart();
  277.         $this->addCartErrors($cart);
  278.         $cartErrors = $cart->getErrors();
  280.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  281.             $cartErrors->clear();
  283.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  284.             return $this->redirectToRoute(
  285.                 'frontend.cart.offcanvas',
  286.                 [
  287.                     self::REDIRECTED_FROM_SAME_ROUTE => true,
  288.                 ]
  289.             );
  290.         }
  292.         $cartErrors->clear();
  294.         return $this->renderStorefront('@Storefront/storefront/component/checkout/offcanvas-cart.html.twig', ['page' => $page]);
  295.     }
  297.     private function addAffiliateTracking(RequestDataBag $dataBag, SessionInterface $session): void
  298.     {
  299.         $affiliateCode = $session->get(AffiliateTrackingListener::AFFILIATE_CODE_KEY);
  300.         $campaignCode = $session->get(AffiliateTrackingListener::CAMPAIGN_CODE_KEY);
  301.         if ($affiliateCode) {
  302.             $dataBag->set(AffiliateTrackingListener::AFFILIATE_CODE_KEY, $affiliateCode);
  303.         }
  305.         if ($campaignCode) {
  306.             $dataBag->set(AffiliateTrackingListener::CAMPAIGN_CODE_KEY, $campaignCode);
  307.         }
  308.     }
  310.     private function routeNeedsReload(ErrorCollection $cartErrors): bool
  311.     {
  312.         foreach ($cartErrors as $error) {
  313.             if ($error instanceof ShippingMethodChangedError || $error instanceof PaymentMethodChangedError) {
  314.                 return true;
  315.             }
  316.         }
  318.         return false;
  319.     }
  320. }