custom/plugins/SwagPayPal/src/Webhook/Handler/AbstractWebhookHandler.php line 100

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. /*
  3. * (c) shopware AG <info@shopware.com>
  4. * For the full copyright and license information, please view the LICENSE
  5. * file that was distributed with this source code.
  6. */
  8. namespace Swag\PayPal\Webhook\Handler;
  10. use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
  11. use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionStateHandler;
  12. use Shopware\Core\Framework\Context;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  16. use Swag\PayPal\RestApi\PayPalApiStruct;
  17. use Swag\PayPal\RestApi\V1\Api\Webhook as WebhookV1;
  18. use Swag\PayPal\RestApi\V2\Api\Order\PurchaseUnit\Payments\Payment;
  19. use Swag\PayPal\RestApi\V2\Api\Webhook as WebhookV2;
  20. use Swag\PayPal\SwagPayPal;
  21. use Swag\PayPal\Webhook\Exception\ParentPaymentNotFoundException;
  22. use Swag\PayPal\Webhook\Exception\WebhookException;
  23. use Swag\PayPal\Webhook\Exception\WebhookOrderTransactionNotFoundException;
  24. use Swag\PayPal\Webhook\WebhookHandler;
  26. abstract class AbstractWebhookHandler implements WebhookHandler
  27. {
  28. protected EntityRepository $orderTransactionRepository;
  30. protected OrderTransactionStateHandler $orderTransactionStateHandler;
  32. /**
  33. * @internal
  34. */
  35. public function __construct(
  36. EntityRepository $orderTransactionRepository,
  37. OrderTransactionStateHandler $orderTransactionStateHandler
  38. ) {
  39. $this->orderTransactionRepository = $orderTransactionRepository;
  40. $this->orderTransactionStateHandler = $orderTransactionStateHandler;
  41. }
  43. abstract public function getEventType(): string;
  45. /**
  46. * @param WebhookV1|WebhookV2 $webhook
  47. */
  48. abstract public function invoke(PayPalApiStruct $webhook, Context $context): void;
  50. /**
  51. * @throws ParentPaymentNotFoundException
  52. * @throws WebhookOrderTransactionNotFoundException
  53. */
  54. protected function getOrderTransaction(WebhookV1 $webhook, Context $context): OrderTransactionEntity
  55. {
  56. $payPalTransactionId = $webhook->getResource()->getParentPayment();
  58. if ($payPalTransactionId === null) {
  59. throw new ParentPaymentNotFoundException($this->getEventType());
  60. }
  62. $criteria = new Criteria();
  63. $criteria->addAssociation('order');
  64. $criteria->addFilter(
  65. new EqualsFilter(
  66. \sprintf('customFields.%s', SwagPayPal::ORDER_TRANSACTION_CUSTOM_FIELDS_PAYPAL_TRANSACTION_ID),
  67. $payPalTransactionId
  68. )
  69. );
  70. /** @var OrderTransactionEntity|null $orderTransaction */
  71. $orderTransaction = $this->orderTransactionRepository->search($criteria, $context)->first();
  73. if ($orderTransaction === null) {
  74. throw new WebhookOrderTransactionNotFoundException(
  75. \sprintf('with the PayPal ID "%s"', $payPalTransactionId),
  76. $this->getEventType()
  77. );
  78. }
  80. return $orderTransaction;
  81. }
  83. protected function getOrderTransactionV2(Payment $resource, Context $context): OrderTransactionEntity
  84. {
  85. $customId = $resource->getCustomId() ?? '[]';
  86. $customIdArray = \json_decode($customId, true);
  87. if (!\is_array($customIdArray)) {
  88. $orderTransactionId = $customId;
  89. } else {
  90. $orderTransactionId = $customIdArray['orderTransactionId'];
  91. }
  93. if ($orderTransactionId === null) {
  94. throw new WebhookException($this->getEventType(), 'Given webhook resource data does not contain needed custom ID');
  95. }
  97. $criteria = new Criteria([$orderTransactionId]);
  98. $criteria->addAssociation('order');
  99. /** @var OrderTransactionEntity|null $orderTransaction */
  100. $orderTransaction = $this->orderTransactionRepository->search($criteria, $context)->first();
  102. if ($orderTransaction === null) {
  103. throw new WebhookOrderTransactionNotFoundException(
  104. \sprintf('with custom ID "%s" (order transaction ID)', $orderTransactionId),
  105. $this->getEventType()
  106. );
  107. }
  109. return $orderTransaction;
  110. }
  112. protected function isChangeAllowed(OrderTransactionEntity $orderTransaction, string $invalidStatus): bool
  113. {
  114. $state = $orderTransaction->getStateMachineState();
  115. if ($state === null) {
  116. return true;
  117. }
  119. return $state->getTechnicalName() !== $invalidStatus;
  120. }
  121. }