[20.0][MIG] edi_storage_oca: Migration to 20.0

edi_storage_oca/README.rst

@@ -0,0 +1,142 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+===========================
+EDI Storage backend support
+===========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:efca3241d581023ae1e96a7ae2db56201e17c53a8221d37b55a07058bff6f3d5
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/license-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/20.0/edi_storage_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-20-0/edi-framework-20-0-edi_storage_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=20.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Allow exchange files using storage backends from OCA/storage.
+
+This module adds a storage backend relation on the EDI backend. There
+you can configure the backend to be used (most often and SFTP) and the
+paths where to read or put files.
+
+Often the convention when exchanging files via SFTP is to have one input
+forder (to receive files) and an output folder (to send files).
+
+Inside this folder you have this hierarchy:
+
+::
+
+   input/output folder
+       |- pending
+       |- done
+       |- error
+
+- pending folder contains files that have been just sent
+- done folder contains files that have been processes successfully
+- error folder contains files with errors and cannot be processed
+
+The storage handlers take care of reading files and putting files
+in/from the right place and update exchange records data accordingly.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+This module has two **inactive** global ``edi.configuration`` records
+that move the input file across the storage directories on
+``on_edi_exchange_done`` / ``on_edi_exchange_error``:
+
+- \*Storage: move input file, pending → done (fallback error → done)
+- \*Storage: move input file, pending → error
+
+Before enabling them you **must** set ``backend_id`` on the record:
+otherwise the global match runs against every backend in the database,
+including non-storage ones.
+
+Usage
+=====
+
+Go to "EDI -> EDI backend" then configure your backend to use a storage
+backend.
+
+Known issues / Roadmap
+======================
+
+- clean deprecated methods in the storage
+
+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_oca%0Aversion:%2020.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
+-------
+
+* ACSONE
+
+Contributors
+------------
+
+- Simone Orsi <simahawk@gmail.com>
+- Foram Shah <foram.shah@initos.com>
+- Lois Rilo <lois.rilo@forgeflow.com>
+- Duong (Tran Quoc) <duongtq@trobz.com>
+- `Dixmit <https://www.dixmit.com>`__:
+
+  - Enric Tobella
+
+- Daniel Reis <dreis.pt@gmail.com>
+
+Other credits
+-------------
+
+The migration of this module from 15.0 to 16.0 was financially supported
+by Camptocamp.
+
+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/20.0/edi_storage_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

edi_storage_oca/__init__.py

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

edi_storage_oca/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2020 ACSONE
+# @author: Simone Orsi <simahawk@gmail.com>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "EDI Storage backend support",
+    "summary": "Base module to allow exchanging files via storage backend (eg: SFTP).",
+    "version": "20.0.1.0.0",
+    "development_status": "Beta",
+    "license": "LGPL-3",
+    "website": "https://github.com/OCA/edi-framework",
+    "author": "ACSONE,Odoo Community Association (OCA)",
+    "depends": ["edi_core_oca", "fs_storage"],
+    "data": [
+        "data/cron.xml",
+        "data/edi_configuration.xml",
+        "security/ir.access.csv",
+        "views/edi_backend_views.xml",
+    ],
+    "installable": True,
+}

edi_storage_oca/data/cron.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo noupdate="1">
+    <record id="cron_check_storage_pending_input" model="ir.cron" forcecreate="True">
+        <field name="name">EDI backend storage check pending input</field>
+        <field name="active" eval="True" />
+        <field name="user_id" ref="base.user_root" />
+        <field name="interval_number" eval="1" />
+        <field name="interval_type">hours</field>
+        <field name="model_id" ref="edi_core_oca.model_edi_backend" />
+        <field name="state">code</field>
+        <field
+            name="code"
+        >model.search([('storage_id', '!=', False)])._storage_cron_check_pending_input()</field>
+    </record>
+</odoo>

edi_storage_oca/data/edi_configuration.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo noupdate="1">
+    <!--
+        IMPORTANT: these configurations are *inactive* by default. Before
+        activating them, set 'backend_id' to the specific storage backend
+        whose directories should be used, otherwise the snippet will not
+        know which input_dir_pending / input_dir_done / input_dir_error to
+        operate on.
+    -->
+    <record id="edi_conf_storage_move_on_done" model="edi.configuration">
+        <field name="name">Storage: move input file to done</field>
+        <field name="active" eval="False" />
+        <field name="is_global" eval="True" />
+        <field name="trigger_id" ref="edi_core_oca.edi_config_trigger_record_done" />
+        <field
+            name="snippet_do"
+        >record.backend_id._storage_on_edi_exchange_done(record)</field>
+    </record>
+
+    <record id="edi_conf_storage_move_on_error" model="edi.configuration">
+        <field name="name">Storage: move input file to error</field>
+        <field name="active" eval="False" />
+        <field name="is_global" eval="True" />
+        <field name="trigger_id" ref="edi_core_oca.edi_config_trigger_record_error" />
+        <field
+            name="snippet_do"
+        >record.backend_id._storage_on_edi_exchange_error(record)</field>
+    </record>
+</odoo>

edi_storage_oca/i18n/edi_storage_oca.pot

@@ -0,0 +1,142 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* edi_storage_oca
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 19.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__display_name
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_exchange_record__display_name
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_exchange_type__display_name
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_oca_storage_handler__display_name
+msgid "Display Name"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model,name:edi_storage_oca.model_edi_backend
+msgid "EDI Backend"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model,name:edi_storage_oca.model_edi_exchange_type
+msgid "EDI Exchange Type"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.actions.server,name:edi_storage_oca.cron_check_storage_pending_input_ir_actions_server
+msgid "EDI backend storage check pending input"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model,name:edi_storage_oca.model_edi_exchange_record
+msgid "EDI exchange Record"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_exchange_type__exchange_filename_pattern
+msgid "Exchange Filename Pattern"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__storage_id
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_exchange_record__storage_id
+msgid "FS Storage"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_exchange_type__exchange_filename_pattern
+msgid ""
+"For output exchange types this should be a formatting string with the following variables available (to be used between brackets, `{}`): `exchange_record`, `record_name`, `type` and `dt`. For instance, a valid string would be {record_name}-{type.code}-{dt}\n"
+"For input exchange types related to storage backends it should be a regex expression to filter the files to be fetched from the pending directory in the related storage. E.g: `.*my-type-[0-9]*.\\.csv`"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__id
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_exchange_record__id
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_exchange_type__id
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_oca_storage_handler__id
+msgid "ID"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__input_dir_done
+msgid "Input done directory"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__input_dir_error
+msgid "Input error directory"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__input_dir_pending
+msgid "Input pending directory"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__output_dir_done
+msgid "Output done directory"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__output_dir_error
+msgid "Output error directory"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,field_description:edi_storage_oca.field_edi_backend__output_dir_pending
+msgid "Output pending directory"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__input_dir_done
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__output_dir_done
+msgid "Path to folder for doneful operations"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__input_dir_error
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__output_dir_error
+msgid "Path to folder for error operations"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__input_dir_pending
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__output_dir_pending
+msgid "Path to folder for pending operations"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_exchange_record__storage_id
+msgid "Record created from a file found in this FS storage"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model_terms:ir.ui.view,arch_db:edi_storage_oca.edi_backend_view_form
+msgid "Storage"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model,name:edi_storage_oca.model_edi_oca_storage_handler
+msgid "Storage Handler for EDI"
+msgstr ""
+
+#. module: edi_storage_oca
+#. odoo-python
+#: code:addons/edi_storage_oca/models/edi_oca_storage_handler.py:0
+msgid "Storage error while reading %(path)s: %(error)s"
+msgstr ""
+
+#. module: edi_storage_oca
+#: model:ir.model.fields,help:edi_storage_oca.field_edi_backend__storage_id
+msgid "Storage for in-out files"
+msgstr ""