[16.0][MIG] storage_backend_s3: Migration to 16.0

requirements.txt

@@ -1,4 +1,5 @@
 # generated from manifests external_dependencies
+boto3>=1.35.0,<1.42.31
 fsspec>=2024.5.0
 fsspec>=2025.3.0
 fsspec[s3]

setup/storage_backend_s3/odoo/addons/storage_backend_s3

@@ -0,0 +1 @@
+../../../../storage_backend_s3

setup/storage_backend_s3/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)

storage_backend_s3/README.rst

@@ -0,0 +1,83 @@
+==================
+Storage Backend S3
+==================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:76e4ebc7d37af8aa2744514100e89ce4934c00275d1271e22f1d0249bedff7fa
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fstorage-lightgray.png?logo=github
+    :target: https://github.com/OCA/storage/tree/16.0/storage_backend_s3
+    :alt: OCA/storage
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/storage-16-0/storage-16-0-storage_backend_s3
+    :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/storage&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Add the possibility to store and get data from amazon S3 for your storage backend
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Known issues / Roadmap
+======================
+
+There is an issue with the latest version of `boto3` and `urllib3`
+- boto3 needs to be `boto3<=1.15.18` related with https://github.com/OCA/storage/issues/67
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/storage/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/storage/issues/new?body=module:%20storage_backend_s3%0Aversion:%2016.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
+~~~~~~~
+
+* Akretion
+
+Contributors
+~~~~~~~~~~~~
+
+* Sebastien Beau <sebastien.beau@akretion.com>
+* Raphaël Reverdy <raphael.reverdy@akretion.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/storage <https://github.com/OCA/storage/tree/16.0/storage_backend_s3>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

storage_backend_s3/__init__.py

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

storage_backend_s3/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2017 Akretion (http://www.akretion.com).
+# @author Sébastien BEAU <sebastien.beau@akretion.com>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "Storage Backend S3",
+    "summary": "Implement amazon S3 Storage",
+    "version": "16.0.1.0.0",
+    "category": "Storage",
+    "website": "https://github.com/OCA/storage",
+    "author": " Akretion, Odoo Community Association (OCA)",
+    "license": "LGPL-3",
+    "installable": True,
+    "external_dependencies": {"python": ["boto3>=1.35.0,<1.42.31"]},
+    "depends": ["storage_backend"],
+    "data": ["views/backend_storage_view.xml"],
+}

storage_backend_s3/components/__init__.py

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

storage_backend_s3/components/s3_adapter.py

@@ -0,0 +1,121 @@
+# Copyright 2017 Akretion (http://www.akretion.com).
+# @author Sébastien BEAU <sebastien.beau@akretion.com>
+# Copyright 2019 Camptocamp SA (http://www.camptocamp.com).
+# @author Simone Orsi <simone.orsi@camptocamp.com>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+import io
+import logging
+
+from odoo import _, exceptions
+
+from odoo.addons.component.core import Component
+
+_logger = logging.getLogger(__name__)
+
+try:
+    import boto3
+    from botocore.exceptions import ClientError, EndpointConnectionError
+
+except ImportError as err:  # pragma: no cover
+    _logger.debug(err)
+
+
+class S3StorageAdapter(Component):
+    _name = "s3.adapter"
+    _inherit = "base.storage.adapter"
+    _usage = "amazon_s3"
+
+    def _aws_bucket_params(self):
+        params = {
+            "aws_access_key_id": self.collection.aws_access_key_id,
+            "aws_secret_access_key": self.collection.aws_secret_access_key,
+        }
+        if self.collection.aws_host:
+            params["endpoint_url"] = self.collection.aws_host
+
+        if self.collection.aws_region:
+            if self.collection.aws_region != "other":
+                params["region_name"] = self.collection.aws_region
+            elif self.collection.aws_other_region:
+                params["region_name"] = self.collection.aws_other_region
+        return params
+
+    def _get_bucket(self):
+        params = self._aws_bucket_params()
+        s3 = boto3.resource("s3", **params)
+        bucket_name = self.collection.aws_bucket
+        bucket = s3.Bucket(bucket_name)
+        exists = True
+        try:
+            s3.meta.client.head_bucket(Bucket=bucket_name)
+        except ClientError as e:
+            # If a client error is thrown, then check that it was a 404 error.
+            # If it was a 404 error, then the bucket does not exist.
+            error_code = e.response["Error"]["Code"]
+            if error_code == "404":
+                exists = False
+        except EndpointConnectionError as error:
+            # log verbose error from s3, return short message for user
+            _logger.exception("Error during connection on S3")
+            raise exceptions.UserError(str(error)) from error
+        region_name = params.get("region_name")
+        if not exists:
+            if not region_name:
+                bucket = s3.create_bucket(Bucket=bucket_name)
+            else:
+                bucket = s3.create_bucket(
+                    Bucket=bucket_name,
+                    CreateBucketConfiguration={"LocationConstraint": region_name},
+                )
+        return bucket
+
+    def _get_object(self, relative_path=None):
+        bucket = self._get_bucket()
+        path = None
+        if relative_path:
+            path = self._fullpath(relative_path)
+        return bucket.Object(key=path)
+
+    def add(self, relative_path, bin_data, mimetype=None, **kwargs):
+        s3object = self._get_object(relative_path)
+        file_params = self._aws_upload_fileobj_params(mimetype=mimetype, **kwargs)
+        with io.BytesIO() as fileobj:
+            fileobj.write(bin_data)
+            fileobj.seek(0)
+            try:
+                s3object.upload_fileobj(fileobj, **file_params)
+            except ClientError as error:
+                # log verbose error from s3, return short message for user
+                _logger.exception("Error during storage of the file %s" % relative_path)
+                raise exceptions.UserError(
+                    _("The file could not be stored: %s") % str(error)
+                ) from error
+
+    def _aws_upload_fileobj_params(self, mimetype=None, **kw):
+        extra_args = {}
+        if mimetype:
+            extra_args["ContentType"] = mimetype
+        if self.collection.aws_cache_control:
+            extra_args["CacheControl"] = self.collection.aws_cache_control
+        if self.collection.aws_file_acl:
+            extra_args["ACL"] = self.collection.aws_file_acl
+        if extra_args:
+            return {"ExtraArgs": extra_args}
+        return {}
+
+    def get(self, relative_path):
+        s3object = self._get_object(relative_path)
+        return s3object.get()["Body"].read()
+
+    def list(self, relative_path):
+        bucket = self._get_bucket()
+        dir_path = self.collection.directory_path or ""
+        return [
+            o.key.replace(dir_path, "").lstrip("/")
+            for o in bucket.objects.filter(Prefix=dir_path)
+        ]
+
+    def delete(self, relative_path):
+        s3object = self._get_object(relative_path)
+        s3object.delete()

storage_backend_s3/i18n/storage_backend_s3.pot

@@ -0,0 +1,116 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* storage_backend_s3
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 15.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: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_host
+msgid "AWS Host"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_access_key_id
+msgid "Access Key ID"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__backend_type__amazon_s3
+#: model_terms:ir.ui.view,arch_db:storage_backend_s3.storage_backend_view_form
+msgid "Amazon S3"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_cache_control
+msgid "Aws Cache Control"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_file_acl
+msgid "Aws File Acl"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__backend_type
+msgid "Backend Type"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_bucket
+msgid "Bucket"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,help:storage_backend_s3.field_storage_backend__aws_host
+msgid "If you are using a different host than standard AWS ones, eg: Exoscale"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_other_region
+msgid "Other region"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_region
+msgid "Region"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields,field_description:storage_backend_s3.field_storage_backend__aws_secret_access_key
+msgid "Secret Access Key"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model,name:storage_backend_s3.model_storage_backend
+msgid "Storage Backend"
+msgstr ""
+
+#. module: storage_backend_s3
+#: code:addons/storage_backend_s3/components/s3_adapter.py:0
+#, python-format
+msgid "The file could not be stored: %s"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__authenticated-read
+msgid "authenticated-read"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__aws-exec-read
+msgid "aws-exec-read"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__bucket-owner-full-control
+msgid "bucket-owner-full-control"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__bucket-owner-read
+msgid "bucket-owner-read"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__private
+msgid "private"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__public-read
+msgid "public-read"
+msgstr ""
+
+#. module: storage_backend_s3
+#: model:ir.model.fields.selection,name:storage_backend_s3.selection__storage_backend__aws_file_acl__public-read-write
+msgid "public-read-write"
+msgstr ""

storage_backend_s3/models/__init__.py

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