PAYOSWXP-113: payment-filter: add validation if addresses are identical (+ activate it for Secured BNPL)

phpunit.xml.dist

@@ -6,6 +6,7 @@
          colors="true">
     <php>
         <ini name="error_reporting" value="-1"/>
+        <env name="KERNEL_CLASS" value="Shopware\Core\Kernel" />
         <env name="APP_ENV" value="test"/>
         <env name="APP_DEBUG" value="1"/>
         <env name="APP_SECRET" value="s$cretf0rt3st"/>

src/Components/ConfigReader/ConfigReader.php

@@ -4,6 +4,7 @@
 
 namespace PayonePayment\Components\ConfigReader;
 
+use PayonePayment\Components\ConfigReader\Exception\ConfigurationPrefixMissingException;
 use PayonePayment\Configuration\ConfigurationPrefixes;
 use PayonePayment\Struct\Configuration;
 use Shopware\Core\System\SystemConfig\SystemConfigService;
@@ -18,6 +19,10 @@ public function __construct(private readonly SystemConfigService $systemConfigSe
 
     public static function getConfigKeyByPaymentHandler(string $paymentHandler, string $configuration): string
     {
+        if (!isset(ConfigurationPrefixes::CONFIGURATION_PREFIXES[$paymentHandler])) {
+            throw new ConfigurationPrefixMissingException(sprintf('No configuration prefix for payment handler "%s" found!', $paymentHandler));
+        }
+
         return self::SYSTEM_CONFIG_DOMAIN . ConfigurationPrefixes::CONFIGURATION_PREFIXES[$paymentHandler] . $configuration;
     }
 

src/Components/ConfigReader/Exception/ConfigurationPrefixMissingException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PayonePayment\Components\ConfigReader\Exception;
+
+class ConfigurationPrefixMissingException extends \Exception
+{
+}

src/Components/PaymentFilter/DefaultPaymentFilterService.php

@@ -4,20 +4,24 @@
 
 namespace PayonePayment\Components\PaymentFilter;
 
+use PayonePayment\Components\ConfigReader\ConfigReader;
+use PayonePayment\Components\ConfigReader\Exception\ConfigurationPrefixMissingException;
 use PayonePayment\Components\PaymentFilter\Exception\PaymentMethodNotAllowedException;
 use PayonePayment\PaymentHandler\AbstractPayonePaymentHandler;
 use Shopware\Core\Checkout\Customer\Aggregate\CustomerAddress\CustomerAddressEntity;
 use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressEntity;
 use Shopware\Core\Checkout\Payment\PaymentMethodCollection;
 use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
 use Shopware\Core\System\Currency\CurrencyEntity;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 
 class DefaultPaymentFilterService implements PaymentFilterServiceInterface
 {
     /**
      * @param class-string<AbstractPayonePaymentHandler> $paymentHandlerClass
      */
     public function __construct(
+        private readonly SystemConfigService $systemConfigService,
         private readonly string $paymentHandlerClass,
         private readonly ?array $allowedCountries = null,
         private readonly ?array $allowedB2bCountries = null,
@@ -31,7 +35,8 @@ final public function filterPaymentMethods(
         PaymentMethodCollection $methodCollection,
         PaymentFilterContext $filterContext
     ): PaymentMethodCollection {
-        if ($this->getSupportedPaymentMethods($methodCollection)->getElements() === []) {
+        $supportedPaymentMethods = $this->getSupportedPaymentMethods($methodCollection);
+        if ($supportedPaymentMethods->getElements() === []) {
             return $methodCollection;
         }
 
@@ -45,6 +50,7 @@ final public function filterPaymentMethods(
             $currentValue = $filterContext->getOrder()->getPrice()->getTotalPrice();
         }
 
+        // Validate and remove all supported payment methods if necessary
         try {
             $this->validateCurrency($currency);
             $this->validateAddress($billingAddress);
@@ -53,9 +59,13 @@ final public function filterPaymentMethods(
                 $this->validateMinValue($currentValue);
                 $this->validateMaxValue($currentValue);
             }
+
+            // Validate and remove a specific payment method if necessary
+            $this->validateDifferentShippingAddress($supportedPaymentMethods, $filterContext);
+
             $this->additionalChecks($methodCollection, $filterContext);
-        } catch (PaymentMethodNotAllowedException) {
-            $methodCollection = $this->removePaymentMethods($methodCollection);
+        } catch (PaymentMethodNotAllowedException $paymentMethodNotAllowedException) {
+            $methodCollection = $this->removePaymentMethods($methodCollection, $paymentMethodNotAllowedException->getDisallowedPaymentMethodCollection());
         }
 
         return $methodCollection;
@@ -76,9 +86,9 @@ private function getSupportedPaymentMethods(PaymentMethodCollection $paymentMeth
             : $paymentMethod->getHandlerIdentifier() === $this->paymentHandlerClass);
     }
 
-    private function removePaymentMethods(PaymentMethodCollection $paymentMethodCollection): PaymentMethodCollection
+    private function removePaymentMethods(PaymentMethodCollection $paymentMethodCollection, ?PaymentMethodCollection $itemsToRemove = null): PaymentMethodCollection
     {
-        $itemsToRemove = $this->getSupportedPaymentMethods($paymentMethodCollection);
+        $itemsToRemove = $itemsToRemove ?: $this->getSupportedPaymentMethods($paymentMethodCollection);
 
         return $paymentMethodCollection->filter(static fn (PaymentMethodEntity $entity) => !$itemsToRemove->has($entity->getUniqueIdentifier()));
     }
@@ -123,4 +133,43 @@ private function validateMaxValue(float $currentValue): void
             throw new PaymentMethodNotAllowedException('The current cart/order value is higher than the allowed max value');
         }
     }
+
+    private function validateDifferentShippingAddress(PaymentMethodCollection $paymentMethods, PaymentFilterContext $filterContext): void
+    {
+        // addresses are already identical - it is not required to check if it is allowed if they are identical or not
+        if ($filterContext->areAddressesIdentical()) {
+            return;
+        }
+
+        $disallowedPaymentMethods = [];
+
+        foreach ($paymentMethods as $paymentMethod) {
+            try {
+                $configKey = ConfigReader::getConfigKeyByPaymentHandler(
+                    $paymentMethod->getHandlerIdentifier(),
+                    'AllowDifferentShippingAddress'
+                );
+            } catch (ConfigurationPrefixMissingException) {
+                continue;
+            }
+
+            /** @var boolean|null $differentShippingAddressAllowed */
+            $differentShippingAddressAllowed = $this->systemConfigService->get(
+                $configKey,
+                $filterContext->getSalesChannelContext()->getSalesChannelId()
+            );
+
+            // if configuration value is null, the payment method should be removed.
+            if ($differentShippingAddressAllowed === false) {
+                $disallowedPaymentMethods[] = $paymentMethod;
+            }
+        }
+
+        if ($disallowedPaymentMethods !== []) {
+            throw new PaymentMethodNotAllowedException(
+                'It is not permitted to use a different shipping address',
+                new PaymentMethodCollection($disallowedPaymentMethods)
+            );
+        }
+    }
 }

src/Components/PaymentFilter/Exception/PaymentMethodNotAllowedException.php

@@ -4,6 +4,19 @@
 
 namespace PayonePayment\Components\PaymentFilter\Exception;
 
+use Shopware\Core\Checkout\Payment\PaymentMethodCollection;
+
 class PaymentMethodNotAllowedException extends \Exception
 {
+    public function __construct(
+        string $message,
+        private readonly ?PaymentMethodCollection $disallowedPaymentMethodCollection = null
+    ) {
+        parent::__construct($message);
+    }
+
+    public function getDisallowedPaymentMethodCollection(): ?PaymentMethodCollection
+    {
+        return $this->disallowedPaymentMethodCollection;
+    }
 }

src/Components/PaymentFilter/PaymentFilterContext.php

@@ -4,6 +4,7 @@
 
 namespace PayonePayment\Components\PaymentFilter;
 
+use PayonePayment\Core\Utils\AddressCompare;
 use Shopware\Core\Checkout\Cart\Cart;
 use Shopware\Core\Checkout\Customer\Aggregate\CustomerAddress\CustomerAddressEntity;
 use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressEntity;
@@ -14,6 +15,8 @@
 
 class PaymentFilterContext extends Struct
 {
+    private bool $_areAddressesIdentical;
+
     public function __construct(
         private readonly SalesChannelContext $salesChannelContext,
         private readonly CustomerAddressEntity|OrderAddressEntity|null $billingAddress = null,
@@ -53,4 +56,31 @@ public function getCart(): ?Cart
     {
         return $this->cart;
     }
+
+    public function areAddressesIdentical(): bool
+    {
+        if (isset($this->_areAddressesIdentical)) {
+            return $this->_areAddressesIdentical;
+        }
+
+        $billingAddress = $this->getBillingAddress();
+        $shippingAddress = $this->getShippingAddress();
+
+        if ($billingAddress instanceof OrderAddressEntity
+            && $shippingAddress instanceof OrderAddressEntity
+            && $billingAddress->getId() !== $shippingAddress->getId()
+            && !AddressCompare::areOrderAddressesIdentical($billingAddress, $shippingAddress)
+        ) {
+            return $this->_areAddressesIdentical = false;
+        }
+
+        if ($billingAddress instanceof CustomerAddressEntity
+            && $shippingAddress instanceof CustomerAddressEntity
+            && $billingAddress->getId() !== $shippingAddress->getId()
+            && !AddressCompare::areCustomerAddressesIdentical($billingAddress, $shippingAddress)) {
+            return $this->_areAddressesIdentical = false;
+        }
+
+        return $this->_areAddressesIdentical = true;
+    }
 }

src/DependencyInjection/payment_method_filter.xml

@@ -33,6 +33,7 @@
         </service>
 
         <service id="payone.payment_filter_method.klarna" class="PayonePayment\Components\PaymentFilter\KlarnaPaymentMethodFilter">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\AbstractKlarnaPaymentHandler</argument>
             <argument key="$allowedCountries" type="collection">
                 <argument>AT</argument>
@@ -61,6 +62,7 @@
         </service>
 
         <service id="payone.payment_filter_method.postfinance" class="PayonePayment\Components\PaymentFilter\DefaultPaymentFilterService">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\AbstractPostfinancePaymentHandler</argument>
             <argument key="$allowedCountries" type="collection">
                 <argument>CH</argument>
@@ -75,6 +77,7 @@
         </service>
 
         <service id="payone.payment_filter_method.przelewy24" class="PayonePayment\Components\PaymentFilter\DefaultPaymentFilterService">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayonePrzelewy24PaymentHandler</argument>
             <argument key="$allowedCountries" type="collection">
                 <argument>PL</argument>
@@ -89,13 +92,16 @@
         </service>
 
         <service id="payone.payment_filter_method.secured_invoice"
-                 class="PayonePayment\Components\PaymentFilter\PayoneBNPLPaymentMethodFilter">
+                 class="PayonePayment\Components\PaymentFilter\DefaultPaymentFilterService">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayoneSecuredInvoicePaymentHandler</argument>
             <argument key="$allowedCountries" type="collection">
                 <argument>DE</argument>
                 <argument>AT</argument>
             </argument>
             <argument key="$allowedB2bCountries" type="collection">
+                <argument>DE</argument>
+                <argument>AT</argument>
             </argument>
             <argument key="$allowedCurrencies" type="collection">
                 <argument>EUR</argument>
@@ -106,7 +112,8 @@
         </service>
 
         <service id="payone.payment_filter_method.secured_installment"
-                 class="PayonePayment\Components\PaymentFilter\PayoneBNPLPaymentMethodFilter">
+                 class="PayonePayment\Components\PaymentFilter\DefaultPaymentFilterService">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayoneSecuredInstallmentPaymentHandler</argument>
             <argument key="$allowedCountries" type="collection">
                 <argument>DE</argument>
@@ -123,7 +130,8 @@
         </service>
 
         <service id="payone.payment_filter_method.secured_direct_debit"
-                 class="PayonePayment\Components\PaymentFilter\PayoneBNPLPaymentMethodFilter">
+                 class="PayonePayment\Components\PaymentFilter\DefaultPaymentFilterService">
+            <argument key="$systemConfigService" type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument key="$paymentHandlerClass">PayonePayment\PaymentHandler\PayoneSecuredDirectDebitPaymentHandler</argument>
             <argument key="$allowedCountries" type="collection">
                 <argument>DE</argument>

src/Payone/RequestParameter/Builder/SecuredInvoice/AuthorizeRequestParameterBuilder.php

@@ -13,6 +13,8 @@
 use PayonePayment\Payone\RequestParameter\Builder\AbstractRequestParameterBuilder;
 use PayonePayment\Payone\RequestParameter\Struct\AbstractRequestParameterStruct;
 use PayonePayment\Payone\RequestParameter\Struct\PaymentTransactionStruct;
+use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressCollection;
+use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressEntity;
 use Shopware\Core\Checkout\Order\OrderEntity;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
@@ -55,6 +57,7 @@ public function getRequestParameter(AbstractRequestParameterStruct $arguments):
 
         $this->applyPhoneParameter($order, $parameters, $dataBag->get('securedInvoicePhone') ?? '', $context);
         $this->applyBirthdayParameter($order, $parameters, $dataBag->get('payoneInvoiceBirthday') ?? '', $context);
+        $this->applyB2bParameters($order, $parameters);
 
         return $parameters;
     }
@@ -82,4 +85,31 @@ protected function getOrder(string $orderId, Context $context): OrderEntity
 
         return $order;
     }
+
+    protected function applyB2bParameters(OrderEntity $order, array &$parameters): void
+    {
+        $billingAddress = $order->getAddresses()?->get($order->getBillingAddressId());
+
+        if ($billingAddress === null) {
+            return;
+        }
+
+        $company = $billingAddress->getCompany();
+        if ($company === null) {
+            return;
+        }
+
+        $parameters['businessrelation'] = 'b2b';
+        $parameters['company'] = $company;
+
+        if ($billingAddress->getVatId()) {
+            $parameters['vatid'] = $billingAddress->getVatId();
+        } else {
+            $vatIds = $order->getOrderCustomer()?->getVatIds();
+
+            if (\is_array($vatIds) && isset($vatIds[0])) {
+                $parameters['vatid'] = $vatIds[0];
+            }
+        }
+    }
 }