[14.0][IMP] edi_oca: Add new model edi.configuration

account_invoice_import_simple_pdf/__manifest__.py

@@ -16,7 +16,7 @@
         "python": [
             "regex",
             "dateparser",
-            "pypdf>=3.1.0",
+            "pypdf>=3.1.0,<5.0",
         ],
         "deb": ["libmupdf-dev", "mupdf", "mupdf-tools", "poppler-utils"],
     },

edi_oca/README.rst

@@ -166,6 +166,7 @@ Contributors
 
 * Simone Orsi <[email protected]>
 * Enric Tobella <[email protected]>
+* Thien Vo <[email protected]>
 
 Maintainers
 ~~~~~~~~~~~

edi_oca/__manifest__.py

@@ -29,13 +29,15 @@
         "data/sequence.xml",
         "data/job_channel.xml",
         "data/job_function.xml",
+        "data/edi_configuration.xml",
         "security/res_groups.xml",
         "security/ir_model_access.xml",
         "views/edi_backend_views.xml",
         "views/edi_backend_type_views.xml",
         "views/edi_exchange_record_views.xml",
         "views/edi_exchange_type_views.xml",
         "views/edi_exchange_type_rule_views.xml",
+        "views/edi_configuration_views.xml",
         "views/menuitems.xml",
         "templates/exchange_chatter_msg.xml",
         "templates/exchange_mixin_buttons.xml",

edi_oca/components/__init__.py

@@ -2,3 +2,4 @@
 from . import base_output
 from . import base_input
 from . import base_validate
+from . import base_listener_config

edi_oca/components/base_listener_config.py

@@ -0,0 +1,33 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo.addons.component.core import Component
+
+
+class EDIBackendListenerComponentConfig(Component):
+    _name = "edi.component.listener.config"
+    _inherit = "base.event.listener"
+
+    # Added *_configuration to avoid being called from other create/write actions.
+    def on_record_write_configuration(self, record, fields=None, **kwargs):
+        trigger = "on_record_write"
+        if kwargs.get("vals", False):
+            for rec in record:
+                confs = self.env["edi.configuration"].edi_get_conf(
+                    trigger, rec._name, rec.partner_id
+                )
+                for conf in confs:
+                    conf.edi_exec_snippet_do(rec, **kwargs)
+
+    # Added *_configuration to avoid being called from other create/write actions.
+    def on_record_create_configuration(self, record, fields=None, **kwargs):
+        trigger = "on_record_create"
+        val_list = kwargs.get("vals", False)
+        if val_list:
+            for rec, vals in zip(record, val_list):
+                kwargs["vals"] = {rec.id: vals}
+                confs = self.env["edi.configuration"].edi_get_conf(
+                    trigger, rec._name, rec.partner_id
+                )
+                for conf in confs:
+                    conf.edi_exec_snippet_do(rec, **kwargs)

edi_oca/data/edi_configuration.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="edi_conf_send_via_email" model="edi.configuration">
+        <field name="name">Send Via Email</field>
+        <field name="active">False</field>
+        <field name="code">send_via_email</field>
+        <field name="trigger">on_email_send</field>
+        <field name="snippet_do">record._edi_send_via_email()</field>
+    </record>
+
+    <!-- Add type_id to use Send Via EDI -->
+    <record id="edi_conf_send_via_edi" model="edi.configuration">
+        <field name="name">Send Via EDI</field>
+        <field name="active">False</field>
+        <field name="code">send_via_edi</field>
+        <field name="snippet_do">record._edi_send_via_edi(conf.type_id)</field>
+    </record>
+</odoo>

edi_oca/models/__init__.py

@@ -5,3 +5,5 @@
 from . import edi_exchange_type
 from . import edi_exchange_type_rule
 from . import edi_id_mixin
+from . import edi_configuration
+from . import edi_configuration_mixin

edi_oca/models/edi_backend.py

@@ -377,6 +377,18 @@ def _cron_check_output_exchange_sync(self, **kw):
         for backend in self:
             backend._check_output_exchange_sync(**kw)
 
+    def exchange_generate_send(self, recordset, skip_generate=False, skip_send=False):
+        for rec in recordset:
+            if skip_generate:
+                job1 = rec
+            else:
+                job1 = rec.delayable().action_exchange_generate()
+            if not skip_send:
+                # Chain send job.
+                # Raise prio to max to send the record out as fast as possible.
+                job1.on_done(rec.delayable(priority=0).action_exchange_send())
+            job1.delay()
+
     def _check_output_exchange_sync(
         self, skip_send=False, skip_sent=True, record_ids=None
     ):
@@ -396,13 +408,8 @@ def _check_output_exchange_sync(
             "EDI Exchange output sync: found %d new records to process.",
             len(new_records),
         )
-        for rec in new_records:
-            job1 = rec.delayable().action_exchange_generate()
-            if not skip_send:
-                # Chain send job.
-                # Raise prio to max to send the record out as fast as possible.
-                job1.on_done(rec.delayable(priority=0).action_exchange_send())
-            job1.delay()
+        if new_records:
+            self.exchange_generate_send(new_records, skip_send=skip_send)
 
         if skip_send:
             return

edi_oca/models/edi_configuration.py

@@ -0,0 +1,222 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import datetime
+
+import pytz
+
+from odoo import _, api, exceptions, fields, models
+from odoo.tools import DotDict, safe_eval
+
+
+def date_to_datetime(dt):
+    """Convert date to datetime."""
+    if isinstance(dt, datetime.date):
+        return datetime.datetime.combine(dt, datetime.datetime.min.time())
+    return dt
+
+
+def to_utc(dt):
+    """Convert date or datetime to UTC."""
+    # Gracefully convert to datetime if needed 1st
+    return date_to_datetime(dt).astimezone(pytz.UTC)
+
+
+class EdiConfiguration(models.Model):
+    _name = "edi.configuration"
+    _description = """
+        This model is used to configure EDI (Electronic Data Interchange) flows.
+        It allows users to create their own configurations, which can be tailored
+        to meet the specific needs of their business processes.
+    """
+
+    name = fields.Char(string="Name", required=True)
+    active = fields.Boolean(default=True)
+    code = fields.Char(required=True, copy=False, index=True, unique=True)
+    description = fields.Char(help="Describe what the conf is for")
+    backend_id = fields.Many2one(string="Backend", comodel_name="edi.backend")
+    type_id = fields.Many2one(
+        string="Exchange Type",
+        comodel_name="edi.exchange.type",
+        ondelete="cascade",
+        auto_join=True,
+        index=True,
+    )
+    model = fields.Many2one(
+        "ir.model",
+        string="Model",
+        help="Model the conf applies to. Leave blank to apply for all models",
+    )
+    model_name = fields.Char(related="model.model", store=True)
+    partner_ids = fields.Many2many(
+        string="Enabled for partners",
+        comodel_name="res.partner",
+        relation="res_partner_edi_configuration_rel",
+        column1="conf_id",
+        column2="partner_id",
+        help="Leave blank to apply for all partners.",
+    )
+    trigger = fields.Selection(
+        [
+            ("on_record_write", "Update Record"),
+            ("on_record_create", "Create Record"),
+            ("on_email_send", "Send Email"),
+        ],
+        string="Trigger",
+        default=False,
+    )
+    snippet_before_do = fields.Text(
+        string="Snippet Before Do",
+        help="Snippet to validate the state and collect records to do",
+    )
+    snippet_do = fields.Text(
+        string="Snippet Do",
+        help="""Used to do something specific here.
+        Receives: operation, edi_action, vals, old_vals.""",
+    )
+
+    @api.constrains("backend_id", "type_id")
+    def _constrains_backend(self):
+        for rec in self:
+            if rec.type_id.backend_id:
+                if rec.type_id.backend_id != rec.backend_id:
+                    raise exceptions.ValidationError(
+                        _("Backend must match with exchange type's backend!")
+                    )
+            else:
+                if rec.type_id.backend_type_id != rec.backend_id.backend_type_id:
+                    raise exceptions.ValidationError(
+                        _("Backend type must match with exchange type's backend type!")
+                    )
+
+    @api.model
+    def default_get(self, fields):
+        vals = super().default_get(fields)
+        model = self.env.context.get("default_model_name", False)
+        partners = self.env.context.get("default_partner_ids", False)
+        if model:
+            vals["model"] = self.env["ir.model"]._get_id(model)
+        if partners and isinstance(partners, list):
+            vals["partner_ids"] = [(6, 0, partners)]
+        return vals
+
+    def _code_snippet_valued(self, snippet):
+        snippet = snippet or ""
+        return bool(
+            [
+                not line.startswith("#")
+                for line in (snippet.splitlines())
+                if line.strip("")
+            ]
+        )
+
+    @staticmethod
+    def _date_to_string(dt, utc=True):
+        if not dt:
+            return ""
+        if utc:
+            dt = to_utc(dt)
+        return fields.Date.to_string(dt)
+
+    @staticmethod
+    def _datetime_to_string(dt, utc=True):
+        if not dt:
+            return ""
+        if utc:
+            dt = to_utc(dt)
+        return fields.Datetime.to_string(dt)
+
+    def _time_utils(self):
+        return {
+            "datetime": safe_eval.datetime,
+            "dateutil": safe_eval.dateutil,
+            "time": safe_eval.time,
+            "utc_now": fields.Datetime.now(),
+            "date_to_string": self._date_to_string,
+            "datetime_to_string": self._datetime_to_string,
+            "time_to_string": lambda dt: dt.strftime("%H:%M:%S") if dt else "",
+            "first_of": fields.first,
+        }
+
+    def _get_code_snippet_eval_context(self):
+        """Prepare the context used when evaluating python code
+
+        :returns: dict -- evaluation context given to safe_eval
+        """
+        ctx = {
+            "uid": self.env.uid,
+            "user": self.env.user,
+            "DotDict": DotDict,
+            "conf": self,
+        }
+        ctx.update(self._time_utils())
+        return ctx
+
+    def _evaluate_code_snippet(self, snippet, **render_values):
+        if not self._code_snippet_valued(snippet):
+            return {}
+        eval_ctx = dict(render_values, **self._get_code_snippet_eval_context())
+        safe_eval.safe_eval(snippet, eval_ctx, mode="exec", nocopy=True)
+        result = eval_ctx.get("result", {})
+        if not isinstance(result, dict):
+            return {}
+        return result
+
+    def edi_exec_snippet_before_do(self, record, **kwargs):
+        self.ensure_one()
+        vals = {
+            "todo": kwargs.get("todo", True),
+        }
+        # Execute snippet before do
+        vals_before_do = self._evaluate_code_snippet(
+            self.snippet_before_do, record=record, **kwargs
+        )
+
+        # Prepare data
+        vals.update(
+            {
+                "todo": vals_before_do.get("todo", True),
+                "snippet_do_vars": vals_before_do.get("snippet_do_vars", False),
+                "event_only": vals_before_do.get("event_only", False),
+                "tracked_fields": vals_before_do.get("tracked_fields", False),
+                "edi_action": vals_before_do.get("edi_action", False),
+            }
+        )
+        return vals
+
+    def edi_exec_snippet_do(self, record, **kwargs):
+        self.ensure_one()
+
+        old_value = kwargs.get("old_vals", {}).get(record.id, {})
+        new_value = kwargs.get("vals", {}).get(record.id, {})
+        vals = {
+            "todo": kwargs.get("todo", True),
+            "record": record,
+            "operation": kwargs.get("operation", False),
+            "edi_action": kwargs.get("edi_action", False),
+            "old_value": old_value,
+            "vals": new_value,
+        }
+        if self.snippet_before_do:
+            before_do_vals = self.edi_exec_snippet_before_do(record, **kwargs)
+            vals.update(before_do_vals)
+        if vals["todo"]:
+            return self._evaluate_code_snippet(self.snippet_do, **vals)
+        return True
+
+    @api.model
+    def edi_get_conf(self, trigger, model_name=None, partners=None, backend=None):
+        domain = [("trigger", "=", trigger)]
+        if model_name:
+            domain += ["|", ("model_name", "=", model_name), ("model_name", "=", False)]
+        if partners:
+            domain += [
+                "|",
+                ("partner_ids", "in", partners.ids),
+                ("partner_ids", "=", False),
+            ]
+        else:
+            domain.append(("partner_ids", "=", False))
+        if backend:
+            domain.append(("backend_id", "=", backend.id))
+        return self.search(domain)