sysvmsg extension is no longer required + modernized module

thelia-modules · Aug 6, 2024 · 9f56542 · 9f56542
1 parent 713369b
commit 9f56542
Show file tree

Hide file tree

Showing 10 changed files with 106 additions and 97 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,7 @@
+name: "Auto Release" 
+on:
+  push:
+    branches: [ master, main ]
+jobs:
+  release:
+    uses: thelia-modules/ReusableWorkflow/.github/workflows/auto_release.yml@main 
diff --git a/Config/config.xml b/Config/config.xml
@@ -4,28 +4,9 @@
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://thelia.net/schema/dic/config http://thelia.net/schema/dic/config/thelia-1.0.xsd">
 
-    <loops>
-        <!-- sample definition
-        <loop name="MySuperLoop" class="InvoiceRef\Loop\MySuperLoop" />
-        -->
-    </loops>
-
-    <forms>
-        <form name="invoiceref_configuration" class="InvoiceRef\Form\ConfigurationForm" />
-        <!--
-        <form name="MyFormName" class="InvoiceRef\Form\MySuperForm" />
-        -->
-    </forms>
-
-    <commands>
-        <!--
-        <command class="InvoiceRef\Command\MySuperCommand" />
-        -->
-    </commands>
-
-    <!--<services>
-        <service id="invoiceRef.listener" class="InvoiceRef\EventListeners\OrderListener">
-            <tag name="kernel.event_subscriber"/>
-        </service>
-    </services>-->
+  <hooks>
+    <hook id="invoiceref.back.hook" class="InvoiceRef\Hook\BackHook">
+      <tag name="hook.event_listener" event="module.configuration" type="back" method="onModuleConfiguration"/>
+    </hook>
+  </hooks>
 </config>
diff --git a/Config/module.xml b/Config/module.xml
@@ -4,7 +4,7 @@
         xsi:schemaLocation="http://thelia.net/schema/dic/module http://thelia.net/schema/dic/module/module-2_1.xsd">
     <fullnamespace>InvoiceRef\InvoiceRef</fullnamespace>
     <descriptive locale="en_US">
-        <title>Manage invoive ref</title>
+        <title>Invoice references management</title>
     </descriptive>
     <descriptive locale="fr_FR">
         <title>Gestion des numéros de facture</title>
@@ -13,7 +13,7 @@
         <language>en_US</language>
         <language>fr_FR</language>
     </languages>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <author>
         <name>Manuel Raynaud</name>
         <email>[email protected]</email>

diff --git a/EventListeners/OrderListener.php b/EventListeners/OrderListener.php
@@ -1,56 +1,68 @@
 <?php
-/*************************************************************************************/
-/*      This file is part of the Thelia package.                                     */
-/*                                                                                   */
-/*      Copyright (c) OpenStudio                                                     */
-/*      email : [email protected]                                                       */
-/*      web : http://www.thelia.net                                                  */
-/*                                                                                   */
-/*      For the full copyright and license information, please view the LICENSE.txt  */
-/*      file that was distributed with this source code.                             */
-/*************************************************************************************/
+
+/*
+ * This file is part of the Thelia package.
+ * http://www.thelia.net
+ *
+ * (c) OpenStudio <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/*      Copyright (c) OpenStudio */
+/*      email : [email protected] */
+/*      web : http://www.thelia.net */
+
+/*      For the full copyright and license information, please view the LICENSE.txt */
+/*      file that was distributed with this source code. */
 
 namespace InvoiceRef\EventListeners;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\Lock\Factory;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\Store\FlockStore;
-use Symfony\Component\Lock\Store\SemaphoreStore;
 use Thelia\Core\Event\Order\OrderEvent;
 use Thelia\Core\Event\TheliaEvents;
+use Thelia\Log\Tlog;
 use Thelia\Model\ConfigQuery;
 
 /**
- * Class OrderListener
- * @package InvoiceRef\EventListeners
+ * Class OrderListener.
+ *
  * @author manuel raynaud <[email protected]>
  */
 class OrderListener implements EventSubscriberInterface
 {
     /**
-     * @param OrderEvent $event
      * @throws \Propel\Runtime\Exception\PropelException
      */
-    public function implementInvoice(OrderEvent $event)
+    public function implementInvoice(OrderEvent $event): void
     {
         $order = $event->getOrder();
 
         if ($order->isPaid() && null === $order->getInvoiceRef()) {
-            $store = new SemaphoreStore();
-            $flockFactory = new LockFactory($store);
+            $lock = null;
 
-            $lock = $flockFactory->createLock('invoice-ref-generation');
+            // Try to acquire lock, being fault-tolerant if it can't be acquired
+            // for whatever reason.
+            try {
+                $flockFactory = new LockFactory(new FlockStore());
+
+                $lock = $flockFactory->createLock('invoice-ref-generation');
 
-            // Acquire a blocking lock
-            $lock->acquire(true);
+                // Acquire a blocking lock
+                $lock->acquire(true);
+            } catch (\Exception $ex) {
+                Tlog::getInstance()->error('Failed to acquire lock : '.$ex->getMessage());
+            }
 
             try {
                 $invoiceRef = ConfigQuery::create()
                     ->findOneByName('invoiceRef');
 
                 if (null === $invoiceRef) {
-                    throw new \RuntimeException("you must set an invoice ref in your admin panel");
+                    throw new \RuntimeException('you must set an invoice ref in your admin panel');
                 }
 
                 $value = $invoiceRef->getValue();
@@ -62,7 +74,7 @@ public function implementInvoice(OrderEvent $event)
                     ->save();
             } finally {
                 // Always release lock !
-                $lock->release();
+                $lock?->release();
             }
         }
     }
@@ -90,7 +102,7 @@ public function implementInvoice(OrderEvent $event)
     public static function getSubscribedEvents()
     {
         return [
-            TheliaEvents::ORDER_UPDATE_STATUS => ['implementInvoice', 100]
+            TheliaEvents::ORDER_UPDATE_STATUS => ['implementInvoice', 100],
         ];
     }
 }
diff --git a/Form/ConfigurationForm.php b/Form/ConfigurationForm.php
@@ -1,14 +1,14 @@
 <?php
-/*************************************************************************************/
-/*      This file is part of the Thelia package.                                     */
-/*                                                                                   */
-/*      Copyright (c) OpenStudio                                                     */
-/*      email : [email protected]                                                       */
-/*      web : http://www.thelia.net                                                  */
-/*                                                                                   */
-/*      For the full copyright and license information, please view the LICENSE.txt  */
-/*      file that was distributed with this source code.                             */
-/*************************************************************************************/
+
+/*
+ * This file is part of the Thelia package.
+ * http://www.thelia.net
+ *
+ * (c) OpenStudio <info@thelia.net>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 
 namespace InvoiceRef\Form;
 
@@ -20,17 +20,15 @@
 use Thelia\Model\ConfigQuery;
 
 /**
- * Class ConfigurationForm
- * @package InvoiceRef\Form
+ * Class ConfigurationForm.
+ *
  * @author manuel raynaud <[email protected]>
  */
 class ConfigurationForm extends BaseForm
 {
-
     /**
-     *
      * in this function you add all the fields you need for your Form.
-     * Form this you have to call add method on $this->formBuilder attribute :
+     * Form this you have to call add method on $this->formBuilder attribute :.
      *
      * $this->formBuilder->add("name", "text")
      *   ->add("email", "email", array(
@@ -52,13 +50,13 @@ protected function buildForm()
         $this->formBuilder
             ->add('invoice', TextType::class, [
                 'constraints' => [
-                    new NotBlank()
+                    new NotBlank(),
                 ],
                 'label' => Translator::getInstance()->trans('invoice ref', [], InvoiceRef::DOMAIN_NAME),
                 'label_attr' => [
-                    'for' => 'invoice-ref'
+                    'for' => 'invoice-ref',
                 ],
-                'data' => ConfigQuery::read('invoiceRef', 0)
+                'data' => ConfigQuery::read('invoiceRef', 0),
             ]);
     }
 
@@ -67,6 +65,6 @@ protected function buildForm()
      */
     public static function getName()
     {
-        return 'invoiceref_config';
+        return 'invoiceref_configuration';
     }
 }
diff --git a/Hook/BackHook.php b/Hook/BackHook.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Thelia package.
+ * http://www.thelia.net
+ *
+ * (c) OpenStudio <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace InvoiceRef\Hook;
+
+use Thelia\Core\Event\Hook\HookRenderEvent;
+use Thelia\Core\Hook\BaseHook;
+
+class BackHook extends BaseHook
+{
+    public function onModuleConfiguration(HookRenderEvent $event): void
+    {
+        $event->add($this->render('module_configuration.html'));
+    }
+}
diff --git a/I18n/en_US.php b/I18n/en_US.php
@@ -1,5 +1,5 @@
 <?php
 
 return array(
-    'invoice ref' => 'invoice ref',
+    'invoice ref' => 'Nex invoice reference number',
 );
diff --git a/I18n/fr_FR.php b/I18n/fr_FR.php
@@ -1,5 +1,5 @@
 <?php
 
 return array(
-    'invoice ref' => 'Numéro de facture',
+    'invoice ref' => 'Prochain numéro de facture',
 );
diff --git a/InvoiceRef.php b/InvoiceRef.php
@@ -1,14 +1,13 @@
 <?php
-/*************************************************************************************/
-/*      This file is part of the Thelia package.                                     */
-/*                                                                                   */
-/*      Copyright (c) OpenStudio                                                     */
-/*      email : [email protected]                                                       */
-/*      web : http://www.thelia.net                                                  */
-/*                                                                                   */
-/*      For the full copyright and license information, please view the LICENSE.txt  */
-/*      file that was distributed with this source code.                             */
-/*************************************************************************************/
+/*
+ * This file is part of the Thelia package.
+ * http://www.thelia.net
+ *
+ * (c) OpenStudio <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 
 namespace InvoiceRef;
 

diff --git a/AdminIncludes/module_configuration.html → ...kOffice/default/module_configuration.html b/AdminIncludes/module_configuration.html → ...kOffice/default/module_configuration.html
@@ -5,12 +5,10 @@
                 {intl d='invoiceref.ai' l="Invoice ref Configuration"}
             </div>
         </div>
-
         <div class="form-container">
             <div class="row">
                 <div class="col-md-12">
                     {form name="invoiceref_configuration"}
-
                         <form action="{url path="/admin/module/InvoiceRef/configure"}" method="post">
                             {form_hidden_fields form=$form}
 
@@ -30,23 +28,13 @@
 
                             <div class="row">
                                 <div class="col-md-4">
-                                    {form_field form=$form field="invoice"}
-                                    <div class="form-group {if $error}has-error{/if}">
-                                        <label for="{$label_attr.for}" class="control-label">
-                                            {$label} {if $required} <span class="required">*</span>{/if}
-
-                                            {form_error form=$form field="invoice"}
-                                                <br />
-                                                <span class="error">{$message|default:null}</span>
-                                            {/form_error}
-                                            <input type="text" {if $required}aria-required="true" required{/if} placeholder="{$label}" id="{$label_attr.for}" name="{$name}" value="{$value}" class="form-control" />
-                                        </label>
-                                        {/form_field}
-                                    </div>
+                                    {render_form_field field="invoice"}
                                 </div>
+                            </div>
                         </form>
                     {/form}
                 </div>
             </div>
         </div>
-    </div>
+    </div>
+</div>