Merge pull request #363 from OXID-eSales/PSPAYPAL-826

Custom id passed to PayPal as JSON with additional versioning data

CHANGELOG.md

@@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - add possibility to ignore cached tokens. It helps e.g. for webhook registration
 - use PayPal-Client v2.0.17
 
+### NEW
+
+- Custom id passed to PayPal as JSON with additional versioning data
+
 ## [2.5.1] - 2024-09-20
 
 ### FIX

LATEST_CLIENT_TAG

@@ -1 +1 @@
-v1.0.12
+v2.0.17

metadata.php

@@ -570,5 +570,11 @@
             'value' => 3.5,
             'group' => null
         ],
+        [
+            'name' => 'oscPayPalUseStructuralCustomIdSchema',
+            'type' => 'bool',
+            'value' => false,
+            'group' => null
+        ],
     ],
 ];

src/Controller/Admin/PayPalConfigController.php

@@ -287,6 +287,9 @@ protected function handleSpecialFields(array $conf): array
             $dAmount = (string) str_replace(',', '.', $conf['oscPayPalDefaultShippingPriceExpress']);
             $conf['oscPayPalDefaultShippingPriceExpress'] = $dAmount;
         }
+        if (!isset($conf['oscPayPalUseStructuralCustomIdSchema'])) {
+            $conf['oscPayPalUseStructuralCustomIdSchema'] = false;
+        }
         return $conf;
     }
 

src/Core/Config.php

@@ -343,6 +343,11 @@ public function getStartTimeCleanUpOrders(): int
         return $this->getServiceFromContainer(ModuleSettings::class)->getStartTimeCleanUpOrders();
     }
 
+    public function isCustomIdSchemaStructural(): bool
+    {
+        return $this->getServiceFromContainer(ModuleSettings::class)->isCustomIdSchemaStructural();
+    }
+
     public function tableExists(string $tableName = ''): bool
     {
         $exists = false;

src/Service/ModuleSettings.php

@@ -624,11 +624,17 @@ public function getIsVaultingActive(): bool
     {
         return (bool)$this->getSettingValue('oscPayPalSetVaulting');
     }
+
     public function getIsGooglePayDeliveryAddressActive(): bool
     {
         return (bool)$this->getSettingValue('oscPayPalUseGooglePayAddress');
     }
 
+    public function isCustomIdSchemaStructural(): bool
+    {
+        return (bool)$this->getSettingValue('oscPayPalUseStructuralCustomIdSchema');
+    }
+
     /**
      * @return mixed
      */

src/Service/Payment.php

@@ -24,6 +24,7 @@
 use OxidSolutionCatalysts\PayPal\Exception\PayPalException;
 use OxidSolutionCatalysts\PayPal\Exception\UserPhone as UserPhoneException;
 use OxidSolutionCatalysts\PayPal\Model\PayPalOrder as PayPalOrderModel;
+use OxidSolutionCatalysts\PayPal\Module;
 use OxidSolutionCatalysts\PayPal\Service\ModuleSettings as ModuleSettingsService;
 use OxidSolutionCatalysts\PayPal\Traits\ServiceContainer;
 use OxidSolutionCatalysts\PayPalApi\Exception\ApiException;
@@ -128,7 +129,7 @@ public function doCreatePayPalOrder(
             $basket,
             $intent,
             $userAction,
-            $order instanceof EshopModelOrder ? $order->getFieldData('oxordernr') : null,
+            null, //customId is patched in doCapturePayPalOrder (ordernr is unavailable at this point)
             $processingInstruction,
             $paymentSource,
             null,
@@ -309,18 +310,16 @@ public function doCapturePayPalOrder(
             } elseif ($payPalOrder->status !== Constants::PAYPAL_STATUS_COMPLETED) {
                 $request = new OrderCaptureRequest();
                 //order number must be resolved before order patching
-                $shopOrderId = $order->getFieldData('oxordernr');
-                if (!$shopOrderId) {
+                if (!$order->hasOrderNumber()){
                     $order->setOrderNumber();
-                    $shopOrderId = $order->getFieldData('oxordernr');
                 }
 
                 try {
                     //Patching the order with OXID order number as custom value
                     $this->doPatchPayPalOrder(
                         Registry::getSession()->getBasket(),
                         $checkoutOrderId,
-                        $shopOrderId
+                        $this->getCustomIdParameter($order)
                     );
 
                     /** @var $result ApiOrderModel */
@@ -808,4 +807,29 @@ private function displayErrorIfInstrumentDeclined(?string $issue): void
             );
         }
     }
+
+    /**
+     * @param \OxidEsales\Eshop\Application\Model\Order|null $order
+     * @return mixed|null
+     */
+    public function getCustomIdParameter(?EshopModelOrder $order): string
+    {
+        /** @var ModuleSettingsService $moduleSettings */
+        $moduleSettings = $this->getServiceFromContainer(ModuleSettings::class);
+        $module = oxNew(\OxidEsales\Eshop\Core\Module\Module::class);
+        $module->load(Module::MODULE_ID);
+        $orderNumber = $order instanceof EshopModelOrder ? $order->getFieldData('oxordernr') : null;
+
+        if($moduleSettings->isCustomIdSchemaStructural()){
+            $customID = [
+                'oxordernr' => $orderNumber,
+                'moduleVersion' => $module->getInfo('version'),
+                'oxidVersion' => \OxidEsales\Eshop\Core\ShopVersion::getVersion()
+            ];
+
+            return json_encode($customID);
+        }
+
+        return $orderNumber;
+    }
 }

views/admin/de/admin_lang.php

@@ -289,4 +289,7 @@
 
     // PayPal Payment
     'OSC_PAYPAL_PAYMENT_DEPRECATED'                 => 'Diese PayPal Zahlungsart kann nicht mehr aktiviert werden, da diese demnächst entfernt wird!',
+
+    'OSC_PAYPAL_CUSTOM_ID_CONTENTS_TITLE'           => 'PayPal Inhalte des benutzerdefinierten ID-Feldes',
+    'OSC_PAYPAL_CUSTOM_ID_CONTENTS_DESC'            => 'Das benutzerdefinierte PayPal-ID-Feld kann entweder nur den Bestellnummernwert oder ein JSON mit zusätzlichen Daten enthalten.',
 ];

views/admin/en/admin_lang.php

@@ -290,4 +290,7 @@
 
     // PayPal Payment
     'OSC_PAYPAL_PAYMENT_DEPRECATED'                 => 'This PayPal payment method can no longer be activated as it will be removed soon!',
+
+    'OSC_PAYPAL_CUSTOM_ID_CONTENTS_TITLE'           => 'PayPal custom id field contents',
+    'OSC_PAYPAL_CUSTOM_ID_CONTENTS_DESC'            => 'PayPal custom id field will be JSON encoded string with order number, shop version and the PayPal module version.',
 ];

views/admin/tpl/oscpaypalconfig.tpl

@@ -546,6 +546,28 @@
                     </div>
                 </div>
             </div>
+
+            <div class="card">
+                <div class="card-header" id="heading11">
+                    <h4 class="collapsed" data-toggle="collapse" data-target="#collapse11" aria-expanded="false" aria-controls="collapse11">
+                        [{oxmultilang ident="OSC_PAYPAL_CUSTOM_ID_CONTENTS_TITLE"}]
+                    </h4>
+                </div>
+                <div id="collapse11" class="collapse" aria-labelledby="heading11" data-parent="#accordion">
+                    <div class="card-body">
+                        <div class="form-group">
+                            <div class="controls">
+                                <div class="form-group">
+                                    <div class="controls">
+                                        <input type="checkbox" name="conf[oscPayPalUseStructuralCustomIdSchema]" value="1" [{if $config->isCustomIdSchemaStructural()}] checked[{/if}]>
+                                        <span class="help-block">[{oxmultilang ident="OSC_PAYPAL_CUSTOM_ID_CONTENTS_DESC"}]</span>
+                                    </div>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
             [{*
             <div class="card">
                 <div class="card-header" id="heading9">