vendor/shopware/platform/src/Storefront/Controller/CheckoutController.php line 96

Open in your IDE?
  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\ErrorCollection;
  8. use Shopware\Core\Checkout\Cart\Exception\InvalidCartException;
  9. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  10. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractLogoutRoute;
  11. use Shopware\Core\Checkout\Order\Exception\EmptyCartException;
  12. use Shopware\Core\Checkout\Order\SalesChannel\OrderService;
  13. use Shopware\Core\Checkout\Payment\Exception\InvalidOrderException;
  14. use Shopware\Core\Checkout\Payment\Exception\PaymentProcessException;
  15. use Shopware\Core\Checkout\Payment\Exception\UnknownPaymentMethodException;
  16. use Shopware\Core\Checkout\Payment\PaymentService;
  17. use Shopware\Core\Framework\Feature;
  18. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  19. use Shopware\Core\Framework\Routing\Annotation\Since;
  20. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  21. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  22. use Shopware\Core\Profiling\Profiler;
  23. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  24. use Shopware\Core\System\SystemConfig\SystemConfigService;
  25. use Shopware\Storefront\Checkout\Cart\Error\PaymentMethodChangedError;
  26. use Shopware\Storefront\Checkout\Cart\Error\ShippingMethodChangedError;
  27. use Shopware\Storefront\Framework\AffiliateTracking\AffiliateTrackingListener;
  28. use Shopware\Storefront\Framework\Routing\Annotation\NoStore;
  29. use Shopware\Storefront\Page\Checkout\Cart\CheckoutCartPageLoadedHook;
  30. use Shopware\Storefront\Page\Checkout\Cart\CheckoutCartPageLoader;
  31. use Shopware\Storefront\Page\Checkout\Confirm\CheckoutConfirmPageLoadedHook;
  32. use Shopware\Storefront\Page\Checkout\Confirm\CheckoutConfirmPageLoader;
  33. use Shopware\Storefront\Page\Checkout\Finish\CheckoutFinishPageLoadedHook;
  34. use Shopware\Storefront\Page\Checkout\Finish\CheckoutFinishPageLoader;
  35. use Shopware\Storefront\Page\Checkout\Offcanvas\CheckoutInfoWidgetLoadedHook;
  36. use Shopware\Storefront\Page\Checkout\Offcanvas\CheckoutOffcanvasWidgetLoadedHook;
  37. use Shopware\Storefront\Page\Checkout\Offcanvas\OffcanvasCartPageLoader;
  38. use Symfony\Component\HttpFoundation\RedirectResponse;
  39. use Symfony\Component\HttpFoundation\Request;
  40. use Symfony\Component\HttpFoundation\Response;
  41. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  42. use Symfony\Component\Routing\Annotation\Route;
  44. /**
  45.  * @Route(defaults={"_routeScope"={"storefront"}})
  46.  */
  47. class CheckoutController extends StorefrontController
  48. {
  49.     private const REDIRECTED_FROM_SAME_ROUTE = 'redirected';
  51.     private CartService $cartService;
  53.     private CheckoutCartPageLoader $cartPageLoader;
  55.     private CheckoutConfirmPageLoader $confirmPageLoader;
  57.     private CheckoutFinishPageLoader $finishPageLoader;
  59.     private OrderService $orderService;
  61.     private PaymentService $paymentService;
  63.     private OffcanvasCartPageLoader $offcanvasCartPageLoader;
  65.     private SystemConfigService $config;
  67.     private AbstractLogoutRoute $logoutRoute;
  69.     public function __construct(
  70.         CartService $cartService,
  71.         CheckoutCartPageLoader $cartPageLoader,
  72.         CheckoutConfirmPageLoader $confirmPageLoader,
  73.         CheckoutFinishPageLoader $finishPageLoader,
  74.         OrderService $orderService,
  75.         PaymentService $paymentService,
  76.         OffcanvasCartPageLoader $offcanvasCartPageLoader,
  77.         SystemConfigService $config,
  78.         AbstractLogoutRoute $logoutRoute
  79.     ) {
  80.         $this->cartService = $cartService;
  81.         $this->cartPageLoader = $cartPageLoader;
  82.         $this->confirmPageLoader = $confirmPageLoader;
  83.         $this->finishPageLoader = $finishPageLoader;
  84.         $this->orderService = $orderService;
  85.         $this->paymentService = $paymentService;
  86.         $this->offcanvasCartPageLoader = $offcanvasCartPageLoader;
  87.         $this->config = $config;
  88.         $this->logoutRoute = $logoutRoute;
  89.     }
  91.     /**
  92.      * @Since("6.0.0.0")
  93.      * @NoStore
  94.      * @Route("/checkout/cart", name="frontend.checkout.cart.page", options={"seo"="false"}, methods={"GET"})
  95.      */
  96.     public function cartPage(Request $request, SalesChannelContext $context): Response
  97.     {
  98.         $page = $this->cartPageLoader->load($request, $context);
  99.         $cart = $page->getCart();
  100.         $cartErrors = $cart->getErrors();
  102.         $this->hook(new CheckoutCartPageLoadedHook($page, $context));
  104.         $this->addCartErrors($cart);
  106.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  107.             $cartErrors->clear();
  109.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  110.             return $this->redirectToRoute(
  111.                 'frontend.checkout.cart.page',
  112.                 [
  113.                     self::REDIRECTED_FROM_SAME_ROUTE => true,
  114.                 ]
  115.             );
  116.         }
  117.         $cartErrors->clear();
  119.         return $this->renderStorefront('@Storefront/storefront/page/checkout/cart/index.html.twig', ['page' => $page]);
  120.     }
  122.     /**
  123.      * @Since("6.0.0.0")
  124.      * @NoStore
  125.      * @Route("/checkout/confirm", name="frontend.checkout.confirm.page", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  126.      */
  127.     public function confirmPage(Request $request, SalesChannelContext $context): Response
  128.     {
  129.         if (!$context->getCustomer()) {
  130.             return $this->redirectToRoute('frontend.checkout.register.page');
  131.         }
  133.         if ($this->cartService->getCart($context->getToken(), $context)->getLineItems()->count() === 0) {
  134.             return $this->redirectToRoute('frontend.checkout.cart.page');
  135.         }
  137.         $page = $this->confirmPageLoader->load($request, $context);
  139.         $this->hook(new CheckoutConfirmPageLoadedHook($page, $context));
  141.         $this->addCartErrors($page->getCart());
  143.         return $this->renderStorefront('@Storefront/storefront/page/checkout/confirm/index.html.twig', ['page' => $page]);
  144.     }
  146.     /**
  147.      * @Since("6.0.0.0")
  148.      * @Route("/checkout/finish", name="frontend.checkout.finish.page", options={"seo"="false"}, methods={"GET"})
  149.      * @NoStore
  150.      */
  151.     public function finishPage(Request $request, SalesChannelContext $context, RequestDataBag $dataBag): Response
  152.     {
  153.         if ($context->getCustomer() === null) {
  154.             return $this->redirectToRoute('frontend.checkout.register.page');
  155.         }
  157.         $page = $this->finishPageLoader->load($request, $context);
  159.         $this->hook(new CheckoutFinishPageLoadedHook($page, $context));
  161.         if ($page->isPaymentFailed() === true) {
  162.             return $this->redirectToRoute(
  163.                 'frontend.account.edit-order.page',
  164.                 [
  165.                     'orderId' => $request->get('orderId'),
  166.                     'error-code' => 'CHECKOUT__UNKNOWN_ERROR',
  167.                 ]
  168.             );
  169.         }
  171.         if ($context->getCustomer()->getGuest() && $this->config->get('core.cart.logoutGuestAfterCheckout', $context->getSalesChannelId())) {
  172.             $this->logoutRoute->logout($context, $dataBag);
  173.         }
  175.         return $this->renderStorefront('@Storefront/storefront/page/checkout/finish/index.html.twig', ['page' => $page]);
  176.     }
  178.     /**
  179.      * @Since("6.0.0.0")
  180.      * @Route("/checkout/order", name="frontend.checkout.finish.order", options={"seo"="false"}, methods={"POST"})
  181.      */
  182.     public function order(RequestDataBag $data, SalesChannelContext $context, Request $request): Response
  183.     {
  184.         if (!$context->getCustomer()) {
  185.             return $this->redirectToRoute('frontend.checkout.register.page');
  186.         }
  188.         try {
  189.             $this->addAffiliateTracking($data, $request->getSession());
  191.             $orderId = Profiler::trace('checkout-order', function () use ($data, $context) {
  192.                 return $this->orderService->createOrder($data, $context);
  193.             });
  194.         } catch (ConstraintViolationException $formViolations) {
  195.             return $this->forwardToRoute('frontend.checkout.confirm.page', ['formViolations' => $formViolations]);
  196.         } catch (InvalidCartException | Error | EmptyCartException $error) {
  197.             $this->addCartErrors(
  198.                 $this->cartService->getCart($context->getToken(), $context)
  199.             );
  201.             return $this->forwardToRoute('frontend.checkout.confirm.page');
  202.         }
  204.         try {
  205.             $finishUrl = $this->generateUrl('frontend.checkout.finish.page', ['orderId' => $orderId]);
  206.             $errorUrl = $this->generateUrl('frontend.account.edit-order.page', ['orderId' => $orderId]);
  208.             $response = Profiler::trace('handle-payment', function () use ($orderId, $data, $context, $finishUrl, $errorUrl): ?RedirectResponse {
  209.                 return $this->paymentService->handlePaymentByOrder($orderId, $data, $context, $finishUrl, $errorUrl);
  210.             });
  212.             return $response ?? new RedirectResponse($finishUrl);
  213.         } catch (PaymentProcessException | InvalidOrderException | UnknownPaymentMethodException $e) {
  214.             return $this->forwardToRoute('frontend.checkout.finish.page', ['orderId' => $orderId, 'changedPayment' => false, 'paymentFailed' => true]);
  215.         }
  216.     }
  218.     /**
  219.      * @Since("6.0.0.0")
  220.      * @Route("/widgets/checkout/info", name="frontend.checkout.info", methods={"GET"}, defaults={"XmlHttpRequest"=true})
  221.      */
  222.     public function info(Request $request, SalesChannelContext $context): Response
  223.     {
  224.         $cart = $this->cartService->getCart($context->getToken(), $context);
  225.         if ($cart->getLineItems()->count() <= 0
  226.             && (Feature::isActive('v6.5.0.0') || Feature::isActive('PERFORMANCE_TWEAKS'))
  227.         ) {
  228.             return new Response(null, Response::HTTP_NO_CONTENT);
  229.         }
  231.         $page = $this->offcanvasCartPageLoader->load($request, $context);
  233.         $this->hook(new CheckoutInfoWidgetLoadedHook($page, $context));
  235.         $response = $this->renderStorefront('@Storefront/storefront/layout/header/actions/cart-widget.html.twig', ['page' => $page]);
  236.         $response->headers->set('x-robots-tag', 'noindex');
  238.         return $response;
  239.     }
  241.     /**
  242.      * @Since("6.0.0.0")
  243.      * @Route("/checkout/offcanvas", name="frontend.cart.offcanvas", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  244.      */
  245.     public function offcanvas(Request $request, SalesChannelContext $context): Response
  246.     {
  247.         $page = $this->offcanvasCartPageLoader->load($request, $context);
  249.         $this->hook(new CheckoutOffcanvasWidgetLoadedHook($page, $context));
  251.         $cart = $page->getCart();
  252.         $this->addCartErrors($cart);
  253.         $cartErrors = $cart->getErrors();
  255.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  256.             $cartErrors->clear();
  258.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  259.             return $this->redirectToRoute(
  260.                 'frontend.cart.offcanvas',
  261.                 [
  262.                     self::REDIRECTED_FROM_SAME_ROUTE => true,
  263.                 ]
  264.             );
  265.         }
  267.         $cartErrors->clear();
  269.         return $this->renderStorefront('@Storefront/storefront/component/checkout/offcanvas-cart.html.twig', ['page' => $page]);
  270.     }
  272.     private function addAffiliateTracking(RequestDataBag $dataBag, SessionInterface $session): void
  273.     {
  274.         $affiliateCode = $session->get(AffiliateTrackingListener::AFFILIATE_CODE_KEY);
  275.         $campaignCode = $session->get(AffiliateTrackingListener::CAMPAIGN_CODE_KEY);
  276.         if ($affiliateCode) {
  277.             $dataBag->set(AffiliateTrackingListener::AFFILIATE_CODE_KEY, $affiliateCode);
  278.         }
  280.         if ($campaignCode) {
  281.             $dataBag->set(AffiliateTrackingListener::CAMPAIGN_CODE_KEY, $campaignCode);
  282.         }
  283.     }
  285.     private function routeNeedsReload(ErrorCollection $cartErrors): bool
  286.     {
  287.         foreach ($cartErrors as $error) {
  288.             if ($error instanceof ShippingMethodChangedError || $error instanceof PaymentMethodChangedError) {
  289.                 return true;
  290.             }
  291.         }
  293.         return false;
  294.     }
  295. }