[18.0][ADD] edi_storage_component_oca

edi_storage_component_oca/README.rst

@@ -0,0 +1,80 @@
+=========================
+EDI Storage Component OCA
+=========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:929f63d432944d358bc315e8419381157ce9ed930aa5c68995ae6f66c85feea6
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github
+    :target: https://github.com/OCA/edi-framework/tree/18.0/edi_storage_component_oca
+    :alt: OCA/edi-framework
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/edi-framework-18-0/edi-framework-18-0-edi_storage_component_oca
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/edi-framework&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Glue module between edi_storage_oca and edi_component_oca.
+
+It implements the EDI processing listener using the OCA component
+framework, allowing custom behaviors to be executed when EDI records are
+processed.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi-framework/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/edi-framework/issues/new?body=module:%20edi_storage_component_oca%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* ForgeFlow
+
+Contributors
+------------
+
+- Arnau Cruz <arnau.cruz@forgeflow.com>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/edi-framework <https://github.com/OCA/edi-framework/tree/18.0/edi_storage_component_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

edi_storage_component_oca/__init__.py

@@ -0,0 +1 @@
+from . import models

edi_storage_component_oca/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2020 ACSONE
+# @author: Simone Orsi <simahawk@gmail.com>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "EDI Storage Component OCA",
+    "summary": """
+    Glue module between edi_storage_oca and edi_component_oca.
+    """,
+    "version": "18.0.1.0.0",
+    "development_status": "Beta",
+    "license": "LGPL-3",
+    "website": "https://github.com/OCA/edi-framework",
+    "author": "ForgeFlow, Odoo Community Association (OCA)",
+    "depends": ["edi_storage_oca", "edi_component_oca"],
+    "data": [],
+}

edi_storage_component_oca/models/__init__.py

@@ -0,0 +1 @@
+from . import edi_event_listener

edi_storage_component_oca/models/edi_event_listener.py

@@ -0,0 +1,78 @@
+# Copyright 2021 ForgeFlow S.L. (https://www.forgeflow.com)
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+import functools
+import os
+from pathlib import PurePath
+
+from odoo.addons.component.core import Component
+from odoo.addons.edi_storage_oca import utils
+
+
+class EdiStorageListener(Component):
+    _name = "edi.storage.component.listener"
+    _inherit = "base.event.listener"
+
+    def _move_file(self, storage, from_dir_str, to_dir_str, filename):
+        from_dir = PurePath(from_dir_str)
+        to_dir = PurePath(to_dir_str)
+        # - storage.list_files now includes path in fs_storage, breaking change
+        # - we remove path
+        files = utils.list_files(storage, from_dir.as_posix())
+        files = [os.path.basename(f) for f in files]
+        if filename not in files:
+            return False
+        self._add_post_commit_hook(
+            utils.move_files,
+            storage,
+            [(from_dir / filename).as_posix()],
+            to_dir.as_posix(),
+        )
+        return True
+
+    def _add_post_commit_hook(
+        self, move_func, storage, sftp_filepath, sftp_destination_path
+    ):
+        """Add hook after commit to move the file when transaction is over."""
+        self.env.cr.postcommit.add(
+            functools.partial(move_func, storage, sftp_filepath, sftp_destination_path)
+        )
+
+    def on_edi_exchange_done(self, record):
+        storage = record.storage_id
+        res = False
+        if record.direction == "input" and storage:
+            file = record.exchange_filename
+            pending_dir = record.type_id._storage_fullpath(
+                record.backend_id.input_dir_pending
+            ).as_posix()
+            done_dir = record.type_id._storage_fullpath(
+                record.backend_id.input_dir_done
+            ).as_posix()
+            error_dir = record.type_id._storage_fullpath(
+                record.backend_id.input_dir_error
+            ).as_posix()
+            if not done_dir:
+                return res
+            res = self._move_file(storage, pending_dir, done_dir, file)
+            if not res:
+                # If a file previously failed it should have been previously
+                # moved to the error dir, therefore it is not present in the
+                # pending dir and we need to retry from error dir.
+                res = self._move_file(storage, error_dir, done_dir, file)
+        return res
+
+    def on_edi_exchange_error(self, record):
+        storage = record.storage_id
+        res = False
+        if record.direction == "input" and storage:
+            file = record.exchange_filename
+            pending_dir = record.type_id._storage_fullpath(
+                record.backend_id.input_dir_pending
+            ).as_posix()
+            error_dir = record.type_id._storage_fullpath(
+                record.backend_id.input_dir_error
+            ).as_posix()
+            if error_dir:
+                res = self._move_file(storage, pending_dir, error_dir, file)
+        return res

edi_storage_component_oca/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

edi_storage_component_oca/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- Arnau Cruz \<arnau.cruz@forgeflow.com\>

edi_storage_component_oca/readme/DESCRIPTION.md

@@ -0,0 +1,4 @@
+Glue module between edi_storage_oca and edi_component_oca.
+
+It implements the EDI processing listener using the OCA component framework,
+allowing custom behaviors to be executed when EDI records are processed.