Merge pull request #417 from Zasilkovna/PES-3084-bugfix-carrier-load-external-points

zemekoule · web-flow · commit c1a6ce164f48 · 2026-02-18T07:14:30.000+01:00
PES-3084: bugfix - carrier load external points
diff --git a/packetery/CHANGE_LOG.txt b/packetery/CHANGE_LOG.txt
@@ -1,5 +1,6 @@
 
-v3.4
+v3.4.0
+       - Updated: If Packeta pick-up point list is not loaded correctly in administration Order detail, log error and do not display button for choose pick-up point/change address.
        - Added: Information about the selected pickup point to emails for e-shop owner.
        - Updated: Loading the widget javascript library only on the checkout page.
        - Updated: Multiple issues form PrestaShop validator resolved.
diff --git a/packetery/libs/Exceptions/EmptyArrayToJsonConvertException.php b/packetery/libs/Exceptions/EmptyArrayToJsonConvertException.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * @author    Packeta s.r.o. <e-commerce.support@packeta.com>
+ * @copyright 2015-2026 Packeta s.r.o.
+ * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ */
+
+namespace Packetery\Exceptions;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class EmptyArrayToJsonConvertException extends \Exception
+{
+}
diff --git a/packetery/libs/Exceptions/FailedToConvertJsonException.php b/packetery/libs/Exceptions/FailedToConvertJsonException.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * @author    Packeta s.r.o. <e-commerce.support@packeta.com>
+ * @copyright 2015-2026 Packeta s.r.o.
+ * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ */
+
+namespace Packetery\Exceptions;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class FailedToConvertJsonException extends \Exception
+{
+}
diff --git a/packetery/libs/LogWrapper/PrestashopLogWrapper.php b/packetery/libs/LogWrapper/PrestashopLogWrapper.php
@@ -14,6 +14,7 @@
 class PrestashopLogWrapper
 {
     public const LEVEL_INFO = 1;
+    public const LEVEL_WARNING = 2;
     public const LEVEL_ERROR = 3;
 
     /**
diff --git a/packetery/libs/Module/Helper.php b/packetery/libs/Module/Helper.php
@@ -7,6 +7,9 @@
 
 namespace Packetery\Module;
 
+use Packetery\Exceptions\EmptyArrayToJsonConvertException;
+use Packetery\Exceptions\FailedToConvertJsonException;
+
 if (!defined('_PS_VERSION_')) {
     exit;
 }
@@ -48,4 +51,48 @@ public static function unserialize(
             ]
         );
     }
+
+    /**
+     * Transforms non-empty array to JSON string
+     *
+     * @param array<int|string, mixed> $data
+     *
+     * @return string
+     *
+     * @throws EmptyArrayToJsonConvertException
+     * @throws FailedToConvertJsonException
+     */
+    public static function transformArrayToJson(array $data): string
+    {
+        if ($data === []) {
+            throw new EmptyArrayToJsonConvertException('Function transformArrayToJson got empty array.');
+        }
+
+        $json = json_encode($data, JSON_UNESCAPED_UNICODE);
+        if ($json === false) {
+            throw new FailedToConvertJsonException(json_last_error_msg());
+        }
+
+        return $json;
+    }
+
+    /**
+     * Recursively escapes all string values in common array
+     * Non-string values (int, float, bool, null) are preserved.
+     *
+     * @param array<int|string, mixed> $array
+     *
+     * @return array<int|string, mixed>
+     */
+    public static function escapeArray(array $array): array
+    {
+        $resultArray = $array;
+        array_walk_recursive($resultArray, function (&$value) {
+            if (is_string($value)) {
+                $value = htmlspecialchars($value, ENT_QUOTES | ENT_HTML5);
+            }
+        });
+
+        return $resultArray;
+    }
 }
diff --git a/packetery/packetery.php b/packetery/packetery.php
@@ -26,6 +26,8 @@ class Packetery extends CarrierModule
     public const LOCAL = 'local';
     public const REMOTE = 'remote';
 
+    private const PACKETA_SUPPORT_EMAIL = 'e-commerce.support@packeta.com';
+
     protected $config_form = false;
 
     /** @var Packetery\DI\Container */
@@ -986,6 +988,7 @@ public function packeteryHookDisplayAdminOrder($params)
         $apiKey = $configHelper->getApiKey();
 
         $pickupPointChangeAllowed = false;
+        $widgetOptions = null;
         if ($apiKey !== false && (bool) $packeteryCarrier === true) {
             if ($isAddressDelivery === true) {
                 $isAddressValidated = false;
@@ -1019,15 +1022,21 @@ public function packeteryHookDisplayAdminOrder($params)
                         $isAddressValidated = true;
                     }
                     $this->context->smarty->assign('validatedAddress', $validatedAddress);
-                    $this->prepareAddressChange($apiKey, $packeteryOrder);
+                    $widgetOptions = $this->prepareAddressChange($apiKey, $packeteryOrder, $orderId);
                 }
+
                 $this->context->smarty->assign('isAddressValidated', $isAddressValidated);
             } elseif ((int) $packeteryOrder['id_carrier'] !== 0) {
-                $this->preparePickupPointChange($apiKey, $packeteryOrder, $orderId, $packeteryCarrier);
                 $pickupPointChangeAllowed = true;
+                $widgetOptions = $this->preparePickupPointChange($apiKey, $packeteryOrder, $orderId, $packeteryCarrier);
+                if ($widgetOptions === null) {
+                    $pickupPointChangeAllowed = false;
+                }
             }
         }
 
+        $this->context->smarty->assign('widgetOptions', $widgetOptions);
+
         /** @var Packetery\Weight\Calculator $weightCalculator */
         $weightCalculator = $this->diContainer->get(Packetery\Weight\Calculator::class);
         $orderWeight = $weightCalculator->getFinalWeight($packeteryOrder);
@@ -1105,16 +1114,15 @@ public function packeteryHookDisplayAdminOrder($params)
     }
 
     /**
-     * @param string $apiKey
-     * @param array $packeteryOrder
+     * @param array<string,string> $packeteryOrder
      *
      * @throws PrestaShopDatabaseException
      * @throws PrestaShopException
      */
-    private function prepareAddressChange($apiKey, array $packeteryOrder)
+    private function prepareAddressChange(string $apiKey, array $packeteryOrder, int $orderId): ?string
     {
         if (!in_array($packeteryOrder['ps_country'], Packetery\Carrier\CarrierRepository::ADDRESS_VALIDATION_COUNTRIES, true)) {
-            return;
+            return null;
         }
 
         /** @var Packetery\Tools\ConfigHelper $configHelper */
@@ -1132,25 +1140,22 @@ private function prepareAddressChange($apiKey, array $packeteryOrder)
             $widgetOptions['city'] = $packeteryOrder['city'];
             $widgetOptions['zip'] = str_replace(' ', '', $packeteryOrder['zip']);
         } else {
-            $order = new Order($packeteryOrder['id_order']);
+            $order = new Order($orderId);
             $deliveryAddress = new Address($order->id_address_delivery);
             $widgetOptions['houseNumber'] = '';
             $widgetOptions['zip'] = str_replace(' ', '', $deliveryAddress->postcode);
             $widgetOptions['city'] = $deliveryAddress->city;
             $widgetOptions['street'] = $deliveryAddress->address1;
         }
-        $this->context->smarty->assign('widgetOptions', json_encode($widgetOptions));
+
+        return $this->getValidWidgetOptions($widgetOptions, $orderId);
     }
 
     /**
-     * @param string $apiKey
-     * @param array $packeteryOrder
-     * @param int $orderId
-     * @param array $packeteryCarrier
-     *
-     * @throws PrestaShopException
+     * @param array<string,string> $packeteryOrder
+     * @param array<string,string> $packeteryCarrier
      */
-    private function preparePickupPointChange($apiKey, $packeteryOrder, $orderId, $packeteryCarrier)
+    private function preparePickupPointChange(string $apiKey, array $packeteryOrder, int $orderId, array $packeteryCarrier): ?string
     {
         /** @var Packetery\Tools\ConfigHelper $configHelper */
         $configHelper = $this->diContainer->get(Packetery\Tools\ConfigHelper::class);
@@ -1163,6 +1168,7 @@ private function preparePickupPointChange($apiKey, $packeteryOrder, $orderId, $p
             'lang' => $configHelper->getBackendLanguage($this),
             'vendors' => $this->getAllowedVendorsForOrder($orderId, $country),
         ];
+
         if (
             $packeteryCarrier['pickup_point_type'] === 'external'
             && $packeteryOrder['id_branch'] !== null
@@ -1172,7 +1178,8 @@ private function preparePickupPointChange($apiKey, $packeteryOrder, $orderId, $p
         } elseif ($packeteryCarrier['pickup_point_type'] === 'internal') {
             $widgetOptions['carriers'] = Packetery\Carrier\CarrierVendors::INTERNAL_PICKUP_POINT_CARRIER;
         }
-        $this->context->smarty->assign('widgetOptions', json_encode($widgetOptions));
+
+        return $this->getValidWidgetOptions($widgetOptions, $orderId);
     }
 
     /**
@@ -1717,4 +1724,34 @@ public function hookActionProductDelete(array $params): void
         $productAttributeRepository = $this->diContainer->get(Packetery\Product\ProductAttributeRepository::class);
         $productAttributeRepository->delete($params['product']->id);
     }
+
+    /**
+     * Validates and encodes widget options to escaped JSON string
+     *
+     * @param array<string, string|int> $widgetOptions
+     *
+     * @return string|null Escaped JSON string or null on failure
+     */
+    private function getValidWidgetOptions(array $widgetOptions, int $orderId): ?string
+    {
+        $logMessage = sprintf(
+            $this->l('Can not change delivery place in administration detail for order id %d, please copy this log to %s.'),
+            $orderId,
+            self::PACKETA_SUPPORT_EMAIL
+        );
+        $logMessage .= ' ';
+
+        try {
+            return htmlspecialchars(Packetery\Module\Helper::transformArrayToJson($widgetOptions), ENT_QUOTES);
+        } catch (Packetery\Exceptions\EmptyArrayToJsonConvertException $e) {
+            $logMessage .= $this->l($e->getMessage());
+            Packetery\LogWrapper\PrestashopLogWrapper::addLog($logMessage, Packetery\LogWrapper\PrestashopLogWrapper::LEVEL_WARNING);
+        } catch (Packetery\Exceptions\FailedToConvertJsonException $e) {
+            $logMessage .= $this->l('Function transformArrayToJson failed:') . ' ' . $e->getMessage() . ', ';
+            $logMessage .= $this->l('data:') . ' ' . print_r(Packetery\Module\Helper::escapeArray($widgetOptions), true);
+            Packetery\LogWrapper\PrestashopLogWrapper::addLog($logMessage, Packetery\LogWrapper\PrestashopLogWrapper::LEVEL_WARNING);
+        }
+
+        return null;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`class PrestashopLogWrapper`
`15`	`15`	`{`
`16`	`16`	`public const LEVEL_INFO = 1;`
	`17`	`+ public const LEVEL_WARNING = 2;`
`17`	`18`	`public const LEVEL_ERROR = 3;`
`18`	`19`
`19`	`20`	`/**`