custom/plugins/RpayPayments/src/Components/Account/Subscriber/AccountSubscriber.php line 121

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * Copyright (c) Ratepay GmbH
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Ratepay\RpayPayments\Components\Account\Subscriber;
  14. use Ratepay\RpayPayments\Components\Account\Event\PaymentUpdateRequestBagValidatedEvent;
  15. use Ratepay\RpayPayments\Components\Checkout\Model\Extension\OrderExtension;
  16. use Ratepay\RpayPayments\Components\Checkout\Model\RatepayOrderDataEntity;
  17. use Ratepay\RpayPayments\Components\Checkout\Service\ExtensionService;
  18. use Ratepay\RpayPayments\Components\PaymentHandler\AbstractPaymentHandler;
  19. use Ratepay\RpayPayments\Components\PaymentHandler\Event\PaymentFailedEvent;
  20. use Ratepay\RpayPayments\Components\RedirectException\Exception\ForwardException;
  21. use Ratepay\RpayPayments\Util\CriteriaHelper;
  22. use Ratepay\RpayPayments\Util\DataValidationHelper;
  23. use Ratepay\RpayPayments\Util\MethodHelper;
  24. use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionStateHandler;
  25. use Shopware\Core\Checkout\Order\OrderEntity;
  26. use Shopware\Core\Checkout\Payment\Cart\PaymentHandler\PaymentHandlerRegistry;
  27. use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
  28. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  29. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  30. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  31. use Shopware\Core\Framework\Validation\DataValidationDefinition;
  32. use Shopware\Core\Framework\Validation\DataValidator;
  33. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  34. use Shopware\Storefront\Event\RouteRequest\HandlePaymentMethodRouteRequestEvent;
  35. use Shopware\Storefront\Event\RouteRequest\SetPaymentOrderRouteRequestEvent;
  36. use Shopware\Storefront\Page\Account\Order\AccountEditOrderPageLoadedEvent;
  37. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  38. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  40. class AccountSubscriber implements EventSubscriberInterface
  41. {
  42.     protected ExtensionService $extensionService;
  44.     private DataValidator $dataValidator;
  46.     private EntityRepositoryInterface $paymentMethodRepository;
  48.     private PaymentHandlerRegistry $paymentHandlerRegistry;
  50.     private EntityRepositoryInterface $orderRepository;
  52.     private EventDispatcherInterface $eventDispatcher;
  54.     private OrderTransactionStateHandler $orderTransactionStateHandler;
  56.     public function __construct(
  57.         ExtensionService $extensionService,
  58.         PaymentHandlerRegistry $paymentHandlerRegistry,
  59.         EntityRepositoryInterface $paymentMethodRepository,
  60.         EntityRepositoryInterface $orderRepository,
  61.         DataValidator $dataValidator,
  62.         EventDispatcherInterface $eventDispatcher,
  63.         OrderTransactionStateHandler $orderTransactionStateHandler
  64.     )
  65.     {
  66.         $this->extensionService = $extensionService;
  67.         $this->dataValidator = $dataValidator;
  68.         $this->paymentMethodRepository = $paymentMethodRepository;
  69.         $this->paymentHandlerRegistry = $paymentHandlerRegistry;
  70.         $this->orderRepository = $orderRepository;
  71.         $this->eventDispatcher = $eventDispatcher;
  72.         $this->orderTransactionStateHandler = $orderTransactionStateHandler;
  73.     }
  75.     public static function getSubscribedEvents(): array
  76.     {
  77.         return [
  78.             AccountEditOrderPageLoadedEvent::class => ['addRatepayTemplateData', 310],
  79.             HandlePaymentMethodRouteRequestEvent::class => 'onHandlePaymentMethodRouteRequest',
  80.             SetPaymentOrderRouteRequestEvent::class => 'onPaymentOrderRouteRequest',
  81.         ];
  82.     }
  84.     public function addRatepayTemplateData(AccountEditOrderPageLoadedEvent $event): void
  85.     {
  86.         $page = $event->getPage();
  87.         $order = $page->getOrder();
  88.         /** @var RatepayOrderDataEntity $ratepayData */
  89.         $ratepayData = $order->getExtension(OrderExtension::EXTENSION_NAME);
  90.         if ($ratepayData && MethodHelper::isRatepayOrder($order) && $ratepayData->isSuccessful()) {
  91.             // You can't change the payment if it is a ratepay order
  92.             $page->setPaymentChangeable(false);
  93.         } else {
  94.             $order = $this->orderRepository->search(CriteriaHelper::getCriteriaForOrder($order->getId()), $event->getContext())->first();
  95.             // Payment change is allowed, prepare ratepay payment data if a ratepay payment method is selected
  96.             $paymentMethod = $event->getSalesChannelContext()->getPaymentMethod();
  97.             if (MethodHelper::isRatepayMethod($paymentMethod->getHandlerIdentifier()) &&
  98.                 $event->getPage()->getPaymentMethods()->has($paymentMethod->getId())
  99.             ) {
  100.                 $extension = $this->extensionService->buildPaymentDataExtension(
  101.                     $event->getSalesChannelContext(),
  102.                     $order
  103.                 );
  104.                 if ($extension) {
  105.                     $event->getPage()->addExtension(ExtensionService::PAYMENT_PAGE_EXTENSION_NAME, $extension);
  106.                 }
  107.             }
  108.         }
  109.     }
  111.     public function onHandlePaymentMethodRouteRequest(HandlePaymentMethodRouteRequestEvent $event): void
  112.     {
  113.         if ($event->getStorefrontRequest()->request->has('ratepay')) {
  114.             $event->getStoreApiRequest()->request->set(
  115.                 'ratepay',
  116.                 $event->getStorefrontRequest()->request->get('ratepay')
  117.             );
  118.         }
  119.     }
  121.     public function onPaymentOrderRouteRequest(SetPaymentOrderRouteRequestEvent $event): void
  122.     {
  123.         if ($event->getStorefrontRequest()->attributes->get('_route') !== 'frontend.account.edit-order.update-order') {
  124.             // make sure that this subscriber only got processed when the order got updated (e.g. switch of payment method or failed payment)
  125.             return;
  126.         }
  128.         $orderId = $event->getStoreApiRequest()->get('orderId');
  129.         /** @var OrderEntity $orderEntity */
  130.         $orderEntity = $this->orderRepository->search(CriteriaHelper::getCriteriaForOrder($orderId), $event->getContext())->first();
  132.         $paymentMethodId = $event->getStoreApiRequest()->get('paymentMethodId');
  133.         /** @var PaymentMethodEntity $paymentMethod */
  134.         $paymentMethod = $this->paymentMethodRepository->search(new Criteria([$paymentMethodId]), $event->getContext())->first();
  135.         if ($orderEntity === null ||
  136.             $paymentMethod === null ||
  137.             MethodHelper::isRatepayMethod($paymentMethod->getHandlerIdentifier()) === false
  138.         ) {
  139.             // not a ratepay method - nothing to do.
  140.             return;
  141.         }
  143.         /** @var AbstractPaymentHandler $paymentHandler */
  144.         $paymentHandler = $this->paymentHandlerRegistry->getHandler($paymentMethod->getHandlerIdentifier());
  146.         // we need to add some functionality to validate the payment data and the response from the gateway.
  147.         // cause shopware do have the opportunity to output custom messages, we will throw an ForwardException, which
  148.         // got caught in the `RedirectException` component and will be rewritten into forward.
  150.         // we must validate the ratepay data on our own. to prevent errors with other extensions, we will only validate ratepay-data.
  151.         $validationDefinitions = $paymentHandler->getValidationDefinitions($event->getStorefrontRequest(), $orderEntity);
  152.         $definition = new DataValidationDefinition();
  153.         $definition->addSub('ratepay', DataValidationHelper::addSubConstraints(new DataValidationDefinition(), $validationDefinitions));
  154.         $requestData = $event->getStorefrontRequest()->request->get('ratepay');
  155.         try {
  156.             $this->dataValidator->validate(['ratepay' => $requestData], $definition);
  157.         } catch (ConstraintViolationException $formViolations) {
  158.             throw new ForwardException('frontend.account.edit-order.page', ['orderId' => $orderEntity->getId()], ['formViolations' => $formViolations], $formViolations);
  159.         }
  161.         $this->eventDispatcher->dispatch(new PaymentUpdateRequestBagValidatedEvent(
  162.             $orderEntity,
  163.             $paymentHandler,
  164.             new RequestDataBag(['ratepay' => $requestData]),
  165.             $event->getSalesChannelContext()
  166.         ));
  168.         // we register an payment-failed-subscriber to throw a forward-exception during the payment-complete in the update-payment process.
  169.         // the listener must have a very low priority to make sure that all other event-subscriber can process
  170.         $orderTransactionStateHandler = $this->orderTransactionStateHandler;
  171.         $this->eventDispatcher->addListener(PaymentFailedEvent::class, static function (PaymentFailedEvent $event) use ($orderTransactionStateHandler) {
  172.             // set the transaction to failed. Without this, the customer will not be able to try a repayment.
  173.             // NOTE: this is not required during the validation or the PaymentQuery, cause in this state,
  174.             // the transaction is not set as "open". Only after the PaymentHandler got called
  175.             $orderTransactionStateHandler->fail($event->getTransaction()->getOrderTransaction()->getId(), $event->getContext());
  177.             // determine the correct error message for the customer.
  178.             $message = $event->getException()->getMessage();
  179.             if ($response = $event->getResponse()) {
  180.                 $message = $response->getCustomerMessage();
  181.                 $message = $message ?: $response->getReasonMessage();
  182.             }
  183.             throw new ForwardException('frontend.account.edit-order.page', ['orderId' => $event->getOrder()->getId()], ['ratepay-errors' => [$message]], $event->getException());
  184.         }, -9999999);
  185.     }
  186. }