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

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Checkout\Cart\CartException;
  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\AbstractCartLoadRoute;
  10. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  11. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractLogoutRoute;
  12. use Shopware\Core\Checkout\Order\Exception\EmptyCartException;
  13. use Shopware\Core\Checkout\Order\OrderException;
  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\PaymentException;
  19. use Shopware\Core\Checkout\Payment\PaymentService;
  20. use Shopware\Core\Framework\Log\Package;
  21. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  22. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  23. use Shopware\Core\Profiling\Profiler;
  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\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.  * @internal
  46.  * Do not use direct or indirect repository calls in a controller. Always use a store-api route to get or put datas
  47.  */
  48. #[Route(defaults: ['_routeScope' => ['storefront']])]
  49. #[Package('storefront')]
  50. class CheckoutController extends StorefrontController
  51. {
  52.     private const REDIRECTED_FROM_SAME_ROUTE = 'redirected';
  54.     /**
  55.      * @internal
  56.      */
  57.     public function __construct(
  58.         private readonly CartService $cartService,
  59.         private readonly CheckoutCartPageLoader $cartPageLoader,
  60.         private readonly CheckoutConfirmPageLoader $confirmPageLoader,
  61.         private readonly CheckoutFinishPageLoader $finishPageLoader,
  62.         private readonly OrderService $orderService,
  63.         private readonly PaymentService $paymentService,
  64.         private readonly OffcanvasCartPageLoader $offcanvasCartPageLoader,
  65.         private readonly SystemConfigService $config,
  66.         private readonly AbstractLogoutRoute $logoutRoute,
  67.         private readonly AbstractCartLoadRoute $cartLoadRoute
  68.     ) {
  69.     }
  71.     #[Route(path: '/checkout/cart', name: 'frontend.checkout.cart.page', options: ['seo' => false], defaults: ['_noStore' => true], methods: ['GET'])]
  72.     public function cartPage(Request $request, SalesChannelContext $context): Response
  73.     {
  74.         $page = $this->cartPageLoader->load($request, $context);
  75.         $cart = $page->getCart();
  76.         $cartErrors = $cart->getErrors();
  78.         $this->hook(new CheckoutCartPageLoadedHook($page, $context));
  80.         $this->addCartErrors($cart);
  82.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  83.             $cartErrors->clear();
  85.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  86.             return $this->redirectToRoute(
  87.                 'frontend.checkout.cart.page',
  88.                 [...$request->query->all(), ...[self::REDIRECTED_FROM_SAME_ROUTE => true]],
  89.             );
  90.         }
  91.         $cartErrors->clear();
  93.         return $this->renderStorefront('@Storefront/storefront/page/checkout/cart/index.html.twig', ['page' => $page]);
  94.     }
  96.     #[Route(path: '/checkout/cart.json', name: 'frontend.checkout.cart.json', methods: ['GET'], options: ['seo' => false], defaults: ['XmlHttpRequest' => true])]
  97.     public function cartJson(Request $request, SalesChannelContext $context): Response
  98.     {
  99.         return $this->cartLoadRoute->load($request, $context);
  100.     }
  102.     #[Route(path: '/checkout/confirm', name: 'frontend.checkout.confirm.page', options: ['seo' => false], defaults: ['XmlHttpRequest' => true, '_noStore' => true], methods: ['GET'])]
  103.     public function confirmPage(Request $request, SalesChannelContext $context): Response
  104.     {
  105.         if (!$context->getCustomer()) {
  106.             return $this->redirectToRoute('frontend.checkout.register.page');
  107.         }
  109.         if ($this->cartService->getCart($context->getToken(), $context)->getLineItems()->count() === 0) {
  110.             return $this->redirectToRoute('frontend.checkout.cart.page');
  111.         }
  113.         $page = $this->confirmPageLoader->load($request, $context);
  114.         $cart = $page->getCart();
  115.         $cartErrors = $cart->getErrors();
  117.         $this->hook(new CheckoutConfirmPageLoadedHook($page, $context));
  119.         $this->addCartErrors($cart);
  121.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  122.             $cartErrors->clear();
  124.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  125.             return $this->redirectToRoute(
  126.                 'frontend.checkout.confirm.page',
  127.                 [...$request->query->all(), ...[self::REDIRECTED_FROM_SAME_ROUTE => true]],
  128.             );
  129.         }
  131.         return $this->renderStorefront('@Storefront/storefront/page/checkout/confirm/index.html.twig', ['page' => $page]);
  132.     }
  134.     #[Route(path: '/checkout/finish', name: 'frontend.checkout.finish.page', options: ['seo' => false], defaults: ['_noStore' => true], methods: ['GET'])]
  135.     public function finishPage(Request $request, SalesChannelContext $context, RequestDataBag $dataBag): Response
  136.     {
  137.         if ($context->getCustomer() === null) {
  138.             return $this->redirectToRoute('frontend.checkout.register.page');
  139.         }
  141.         try {
  142.             $page = $this->finishPageLoader->load($request, $context);
  143.         } catch (OrderException $exception) {
  144.             $this->addFlash(self::DANGER, $this->trans('error.' . $exception->getErrorCode()));
  146.             return $this->redirectToRoute('frontend.checkout.cart.page');
  147.         }
  149.         $this->hook(new CheckoutFinishPageLoadedHook($page, $context));
  151.         if ($page->isPaymentFailed() === true) {
  152.             return $this->redirectToRoute(
  153.                 'frontend.account.edit-order.page',
  154.                 [
  155.                     'orderId' => $request->get('orderId'),
  156.                     'error-code' => 'CHECKOUT__UNKNOWN_ERROR',
  157.                 ]
  158.             );
  159.         }
  161.         if ($context->getCustomer()->getGuest() && $this->config->get('core.cart.logoutGuestAfterCheckout', $context->getSalesChannelId())) {
  162.             $this->logoutRoute->logout($context, $dataBag);
  163.         }
  165.         return $this->renderStorefront('@Storefront/storefront/page/checkout/finish/index.html.twig', ['page' => $page]);
  166.     }
  168.     #[Route(path: '/checkout/order', name: 'frontend.checkout.finish.order', options: ['seo' => false], methods: ['POST'])]
  169.     public function order(RequestDataBag $data, SalesChannelContext $context, Request $request): Response
  170.     {
  171.         if (!$context->getCustomer()) {
  172.             return $this->redirectToRoute('frontend.checkout.register.page');
  173.         }
  175.         try {
  176.             $this->addAffiliateTracking($data, $request->getSession());
  178.             $orderId = Profiler::trace('checkout-order', fn () => $this->orderService->createOrder($data, $context));
  179.         } catch (ConstraintViolationException $formViolations) {
  180.             return $this->forwardToRoute('frontend.checkout.confirm.page', ['formViolations' => $formViolations]);
  181.         } catch (InvalidCartException|Error|EmptyCartException) {
  182.             $this->addCartErrors(
  183.                 $this->cartService->getCart($context->getToken(), $context)
  184.             );
  186.             return $this->forwardToRoute('frontend.checkout.confirm.page');
  187.         } catch (UnknownPaymentMethodException|CartException $e) {
  188.             if ($e->getErrorCode() === CartException::CART_PAYMENT_INVALID_ORDER_STORED_CODE && $e->getParameter('orderId')) {
  189.                 return $this->forwardToRoute('frontend.checkout.finish.page', ['orderId' => $e->getParameter('orderId'), 'changedPayment' => false, 'paymentFailed' => true]);
  190.             }
  191.             $message = $this->trans('error.' . $e->getErrorCode());
  192.             $this->addFlash('danger', $message);
  194.             return $this->forwardToRoute('frontend.checkout.confirm.page');
  195.         }
  197.         try {
  198.             $finishUrl = $this->generateUrl('frontend.checkout.finish.page', ['orderId' => $orderId]);
  199.             $errorUrl = $this->generateUrl('frontend.account.edit-order.page', ['orderId' => $orderId]);
  201.             $response = Profiler::trace('handle-payment', fn (): ?RedirectResponse => $this->paymentService->handlePaymentByOrder($orderId, $data, $context, $finishUrl, $errorUrl));
  203.             return $response ?? new RedirectResponse($finishUrl);
  204.         } catch (PaymentProcessException|InvalidOrderException|PaymentException|UnknownPaymentMethodException) {
  205.             return $this->forwardToRoute('frontend.checkout.finish.page', ['orderId' => $orderId, 'changedPayment' => false, 'paymentFailed' => true]);
  206.         }
  207.     }
  209.     #[Route(path: '/widgets/checkout/info', name: 'frontend.checkout.info', defaults: ['XmlHttpRequest' => true], methods: ['GET'])]
  210.     public function info(Request $request, SalesChannelContext $context): Response
  211.     {
  212.         $cart = $this->cartService->getCart($context->getToken(), $context);
  213.         if ($cart->getLineItems()->count() <= 0) {
  214.             return new Response(null, Response::HTTP_NO_CONTENT);
  215.         }
  217.         $page = $this->offcanvasCartPageLoader->load($request, $context);
  219.         $this->hook(new CheckoutInfoWidgetLoadedHook($page, $context));
  221.         $response = $this->renderStorefront('@Storefront/storefront/layout/header/actions/cart-widget.html.twig', ['page' => $page]);
  222.         $response->headers->set('x-robots-tag', 'noindex');
  224.         return $response;
  225.     }
  227.     #[Route(path: '/checkout/offcanvas', name: 'frontend.cart.offcanvas', options: ['seo' => false], defaults: ['XmlHttpRequest' => true], methods: ['GET'])]
  228.     public function offcanvas(Request $request, SalesChannelContext $context): Response
  229.     {
  230.         $page = $this->offcanvasCartPageLoader->load($request, $context);
  232.         $this->hook(new CheckoutOffcanvasWidgetLoadedHook($page, $context));
  234.         $cart = $page->getCart();
  235.         $this->addCartErrors($cart);
  236.         $cartErrors = $cart->getErrors();
  238.         if (!$request->query->getBoolean(self::REDIRECTED_FROM_SAME_ROUTE) && $this->routeNeedsReload($cartErrors)) {
  239.             $cartErrors->clear();
  241.             // To prevent redirect loops add the identifier that the request already got redirected from the same origin
  242.             return $this->redirectToRoute(
  243.                 'frontend.cart.offcanvas',
  244.                 [...$request->query->all(), ...[self::REDIRECTED_FROM_SAME_ROUTE => true]],
  245.             );
  246.         }
  248.         $cartErrors->clear();
  250.         return $this->renderStorefront('@Storefront/storefront/component/checkout/offcanvas-cart.html.twig', ['page' => $page]);
  251.     }
  253.     private function addAffiliateTracking(RequestDataBag $dataBag, SessionInterface $session): void
  254.     {
  255.         $affiliateCode = $session->get(AffiliateTrackingListener::AFFILIATE_CODE_KEY);
  256.         $campaignCode = $session->get(AffiliateTrackingListener::CAMPAIGN_CODE_KEY);
  257.         if ($affiliateCode) {
  258.             $dataBag->set(AffiliateTrackingListener::AFFILIATE_CODE_KEY, $affiliateCode);
  259.         }
  261.         if ($campaignCode) {
  262.             $dataBag->set(AffiliateTrackingListener::CAMPAIGN_CODE_KEY, $campaignCode);
  263.         }
  264.     }
  266.     private function routeNeedsReload(ErrorCollection $cartErrors): bool
  267.     {
  268.         foreach ($cartErrors as $error) {
  269.             if ($error instanceof ShippingMethodChangedError || $error instanceof PaymentMethodChangedError) {
  270.                 return true;
  271.             }
  272.         }
  274.         return false;
  275.     }
  276. }