Merge pull request #18 from YannLe/main

Add optional texter for local pickup

Author: roadster31

Config/module.xml

@@ -7,7 +7,7 @@
     <descriptive locale="fr_FR">
         <title>Retrait sur place</title>
     </descriptive>
-    <version>2.0.5</version>
+    <version>2.1.0</version>
     <author>
         <name>Thelia</name>
         <email>info@thelia.net</email>

Controller/ConfigurationController.php

@@ -50,10 +50,12 @@ public function configure()
             $price = $vform->get('price')->getData();
             $description = $vform->get('description')->getData();
             $email = $vform->get('email')->getData();
+            $sms = $vform->get('sms')->getData();
 
             LocalPickup::setConfigValue(LocalPickup::PRICE_VAR_NAME, (float) $price);
             LocalPickup::setConfigValue(LocalPickup::DESCRIPTION_VAR_NAME, $description, $this->getCurrentEditionLocale());
             LocalPickup::setConfigValue(LocalPickup::EMAIL_VAR_NAME, $email, $this->getCurrentEditionLocale());
+            LocalPickup::setConfigValue(LocalPickup::SMS_VAR_NAME, (bool) $sms);
         } catch (FormValidationException $ex) {
             $errmes = $this->createStandardFormValidationErrorMessage($ex);
         } catch (\Exception $ex) {

EventListeners/APIListener.php

@@ -12,19 +12,32 @@
 
 namespace LocalPickup\EventListeners;
 
+use libphonenumber\NumberParseException;
+use libphonenumber\PhoneNumber;
+use libphonenumber\PhoneNumberFormat;
+use libphonenumber\PhoneNumberUtil;
 use LocalPickup\LocalPickup;
 use OpenApi\Events\DeliveryModuleOptionEvent;
 use OpenApi\Events\OpenApiEvents;
 use OpenApi\Model\Api\DeliveryModuleOption;
 use OpenApi\Model\Api\ModelFactory;
 use Propel\Runtime\Exception\PropelException;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use SmartyException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
-use Thelia\Core\Event\TheliaEvents;
+use Symfony\Component\Notifier\Exception\TransportExceptionInterface;
+use Symfony\Component\Notifier\Message\SmsMessage;
+use Symfony\Component\Notifier\TexterInterface;
 use Thelia\Core\Event\Order\OrderEvent;
+use Thelia\Core\Event\TheliaEvents;
+use Thelia\Core\Template\ParserInterface;
+use Thelia\Core\Template\TemplateHelperInterface;
+use Thelia\Exception\TheliaProcessException;
 use Thelia\Mailer\MailerFactory;
+use Thelia\Model\CountryQuery;
+use Thelia\Model\MessageQuery;
 use Thelia\Model\ModuleQuery;
+use Thelia\Model\Order;
 use Thelia\Model\OrderStatus;
 
 class APIListener implements EventSubscriberInterface
@@ -40,20 +53,24 @@ class APIListener implements EventSubscriberInterface
      */
     protected $mailer;
 
+
     /**
      * APIListener constructor.
-     *
-     * @param ContainerInterface $container We need the container because we use a service from another module
-     *                                      which is not mandatory, and using its service without it being installed will crash
      */
-    public function __construct(ModelFactory $modelFactory, RequestStack $requestStack, MailerFactory $mailer)
+    public function __construct(
+        ModelFactory                    $modelFactory,
+        RequestStack                    $requestStack,
+        MailerFactory                   $mailer,
+        private ?TexterInterface        $texter,
+        private ParserInterface         $parser,
+        private TemplateHelperInterface $templateHelper
+    )
     {
         $this->modelFactory = $modelFactory;
         $this->requestStack = $requestStack;
         $this->mailer = $mailer;
     }
 
-
     public function getDeliveryModuleOptions(DeliveryModuleOptionEvent $deliveryModuleOptionEvent): void
     {
         $module = ModuleQuery::create()->findOneByCode(LocalPickup::getModuleCode());
@@ -96,8 +113,7 @@ public function getDeliveryModuleOptions(DeliveryModuleOptionEvent $deliveryModu
             ->setMaximumDeliveryDate($maximumDeliveryDate)
             ->setPostage($postage)
             ->setPostageTax($postageTax)
-            ->setPostageUntaxed($postage - $postageTax)
-        ;
+            ->setPostageUntaxed($postage - $postageTax);
 
         // Pre-5.3.x compatibility
         if (method_exists($deliveryModuleOption, 'setDescription')) {
@@ -109,26 +125,117 @@ public function getDeliveryModuleOptions(DeliveryModuleOptionEvent $deliveryModu
 
     /**
      * @throws PropelException
+     * @throws TransportExceptionInterface
+     * @throws SmartyException
      */
-    public function getOrderStatus(OrderEvent $orderEvent)
+    public function getOrderStatus(OrderEvent $orderEvent): void
     {
         $order = $orderEvent->getOrder();
-
-        if ($order->getDeliveryModuleId() !== LocalPickup::getModuleId() || $order->getOrderStatus()->getCode() !== OrderStatus::CODE_SENT) {
+        if (!$this->isEligibleForLocalPickupNotification($order)) {
             return;
         }
+        $this->sendLocalPickupEmail($order);
+        if ($this->texter && LocalPickup::getConfigValue(LocalPickup::SMS_VAR_NAME)) {
+            $this->sendSmsIfNeeded($order);
+        }
+    }
 
+    private function isEligibleForLocalPickupNotification(Order $order): bool
+    {
+        return $order->getDeliveryModuleId() === LocalPickup::getModuleId()
+            && $order->getOrderStatus()->getCode() === OrderStatus::CODE_SENT;
+    }
+
+    private function sendLocalPickupEmail(Order $order): void
+    {
         $this->mailer->sendEmailToCustomer(
             LocalPickup::EMAIL_CUSTOM_LOCAL_PICKUP,
             $order->getCustomer(),
             [
                 'order_id' => $order->getId(),
                 'order_ref' => $order->getRef(),
-                'comment' => LocalPickup::getConfigValue(LocalPickup::EMAIL_VAR_NAME, '', $order->getLang()->getLocale()),
+                'comment' => LocalPickup::getConfigValue(
+                    LocalPickup::EMAIL_VAR_NAME,
+                    '',
+                    $order->getLang()->getLocale()
+                ),
             ]
         );
     }
 
+    /**
+     * @throws PropelException|TransportExceptionInterface
+     * @throws SmartyException
+     */
+    private function sendSmsIfNeeded(Order $order): void
+    {
+        $phoneNumber = $order->getOrderAddressRelatedByDeliveryOrderAddressId()->getPhone();
+        $cellPhoneNumber = $order->getOrderAddressRelatedByDeliveryOrderAddressId()->getCellphone();
+
+        $numberToUse = $cellPhoneNumber ?? $phoneNumber;
+        if ($numberToUse === null || $this->isSurtaxedNumber($numberToUse)) {
+            return;
+        }
+
+        $langCode = $this->getOrderLangCode($order);
+        $internationalNumber = $this->internationalizePhoneNumber($numberToUse, $langCode);
+        $message = MessageQuery::create()
+            ->filterByName(LocalPickup::SMS_CUSTOM_LOCAL_PICKUP)
+            ->findOne();
+        if (!$message) {
+            throw new TheliaProcessException('Template  ' . LocalPickup::SMS_CUSTOM_LOCAL_PICKUP . ' not found.');
+        }
+        $this->parser->setTemplateDefinition(
+            $this->templateHelper->getActiveAdminTemplate(),
+            true
+        );
+        $sms = new SmsMessage(
+            $internationalNumber,
+            $this->parser->render($message->getHtmlTemplateFileName(), ['order_id' => $order->getId()])
+        );
+        $this->texter->send($sms);
+    }
+
+    private function isSurtaxedNumber(string $phoneNumber): bool
+    {
+        $surtaxedPatterns = [
+            '/^089[0-9]{1}/',   // Start by 089
+            '/^08[0-9]{2}/',    // Start by 08 (can be surtaxed)
+            '/^36[0-9]{2}/',    // Short numbers (for instance 36xx, often surtaxed)
+        ];
+
+        foreach ($surtaxedPatterns as $pattern) {
+            if (preg_match($pattern, $phoneNumber)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @throws NumberParseException
+     */
+    private function internationalizePhoneNumber(string $phoneNumber, string $region = 'FR'): string
+    {
+        $phoneUtil = PhoneNumberUtil::getInstance();
+        /** @var PhoneNumber $phoneNumberObject */
+        $phoneNumberObject = $phoneUtil->parse($phoneNumber, $region);
+
+        return $phoneUtil->format($phoneNumberObject, PhoneNumberFormat::E164);
+    }
+
+    /**
+     * @throws PropelException
+     */
+    private function getOrderLangCode(Order $order): string
+    {
+        $country = CountryQuery::create()
+            ->findOneById($order->getOrderAddressRelatedByDeliveryOrderAddressId()->getCountryId());
+
+        return $country ? $country->getIsoalpha2() : 'FR';
+    }
+
     public static function getSubscribedEvents()
     {
         $listenedEvents = [];

Listener/UpdateDeliveryAddress.php EventListeners/UpdateDeliveryAddress.phpListener/UpdateDeliveryAddress.php renamed to EventListeners/UpdateDeliveryAddress.php

@@ -13,6 +13,7 @@
 namespace LocalPickup\Form;
 
 use LocalPickup\LocalPickup;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\NumberType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
@@ -70,6 +71,25 @@ protected function buildForm()
                     ],
                 ]
             )
+            ->add(
+                "sms",
+                CheckboxType::class,
+                [
+                    "required" => false,
+                    "label"=> Translator::getInstance()->trans("Send SMS", [], LocalPickup::DOMAIN_NAME),
+                    'attr' => [
+                        'rows' => 5,
+                    ],
+                    "label_attr"=> [
+                        "for"=>"sms",
+                        'help' => Translator::getInstance()->trans(
+                            'Help SMS',
+                            [],
+                            LocalPickup::DOMAIN_NAME
+                        ),
+                    ],
+                ]
+            )
         ;
     }
 

Form/ConfigurationForm.php

@@ -41,6 +41,7 @@ public function onModuleConfiguration(HookRenderEvent $event): void
                     'price' => (float) LocalPickup::getConfigValue(LocalPickup::PRICE_VAR_NAME, 0),
                     'description' => LocalPickup::getConfigValue(LocalPickup::DESCRIPTION_VAR_NAME, '', $locale),
                     'email' => LocalPickup::getConfigValue(LocalPickup::EMAIL_VAR_NAME, '', $locale),
+                    'sms' => LocalPickup::getConfigValue(LocalPickup::SMS_VAR_NAME, false),
                 ]
             )
         );

Hook/HookManager.php

@@ -5,4 +5,6 @@
     'Commentary email' => 'Write a comment visible for the user in the email',
     'Price' => 'Price without taxes',
     'price must be a number !' => 'price must be a number !',
+    'Send SMS' => 'Send an sms to the customer when the command status is sent',
+    'Help SMS' => 'Need configuration of a Texter with a valid DSN',
 );

I18n/en_US.php

@@ -5,4 +5,6 @@
     'Commentary email' => 'Vous pouvez indiquer un commentaire qui sera affiché à vos client dans l\'email',
     'Price' => 'Prix HT',
     'price must be a number !' => 'Le prix doit être un nombre !',
+    'Send SMS' => 'Envoyer un sms au client lorsque le statut de la commande passe à Envoyé',
+    'Help SMS' => 'Nécessite la configuration d\'un Texter avec un DSN valide',
 );