odoo-addon-fs-attachment-s3 16.0.2.0.0__py3-none-any.whl

odoo/addons/fs_attachment_s3/README.rst

@@ -0,0 +1,178 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+================
+Fs Attachment S3
+================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:c7fa84a6b0932b3673afbfca4f7c1f4c6b8858362c51783043d6c5a360de5282
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fstorage-lightgray.png?logo=github
+    :target: https://github.com/OCA/storage/tree/16.0/fs_attachment_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-fs_attachment_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|
+
+This module extends the functionality of
+`fs_attachment <https://github.com/OCA/storage/tree/16.0/fs_attachment>`__
+to better support Amazon S3 storage. It includes features such as:
+
+- Special handling of X-Accel-Redirect headers for S3 storages.
+- Options for using signed URLs in X-Accel-Redirect. (This is required
+  to be able to serve files from a private S3 bucket using
+  X-Accel-Redirect without exposing the files publicly.)
+- Enforcing the mimetype of files stored in S3.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+On the Odoo instance, go to *Settings* > *Technical* > *Storage* > *File
+Storage*.
+
+When you create a new storage for s3 or modify an existing one, when you
+activate the option "Use X-Sendfile To Serve Internal Url", 2 additional
+fields will appear:
+
+- **S3 Uses Signed URL For X-Accel-Redirect**: If checked, the
+  X-Accel-Redirect path will be a signed URL, which is useful for S3
+  storages that require signed URLs for access.
+- **S3 Signed URL Expiration**: The expiration time for the signed URL
+  in seconds. This field is only relevant if the previous option is
+  checked. By default, it is set to 30 seconds but it could be less
+  since the url generated into the X-Accel-Redirect process is directly
+  used by the web server to serve the file.
+
+The value of these fields can also be set in the server environment
+variables using the keys:
+
+- *s3_uses_signed_url_for_x_sendfile*
+- *s3_signed_url_expiration*
+
+When the option "Use X-Sendfile To Serve Internal Url" is enabled, the
+system will generate an X-Accel-Redirect header in the response to a
+request to get a file. In the case of S3 storages, it will follow the
+format:
+
+.. code:: text
+
+   X-Accel-Redirect: /fs_x_sendfile/{scheme}/{host}/{path with query if any}
+
+Where:
+
+- ``{scheme}``: The URL scheme (http or https).
+- ``{host}``: The host of the S3 storage.
+- ``{path with query if any}``: The path to the file in the S3 storage,
+  including any query parameters. (Query parameters are set when the
+  ``s3_uses_signed_url_for_x_sendfile`` option is enabled.)
+
+In order to serve files using X-Accel-Redirect, you must ensure that
+your web server is configured to handle these headers correctly. This
+typically involves setting up a location block in your web server
+configuration that matches the X-Accel-Redirect path and proxies the
+request to the S3 storage.
+
+For example, if you are using Nginx, you would add a location block like
+this:
+
+.. code:: nginx
+
+
+       location ~ ^/fs_x_sendfile/(.*?)/(.*?)/(.*) {
+           internal;
+           set $url_scheme $1;
+           set $url_host $2;
+           set $url_path $3;
+           set $url $url_scheme://$url_host/$url_path;
+
+           proxy_pass $url$is_args$args;
+           proxy_set_header Host $url_host;
+           proxy_ssl_server_name on;
+        
+       }
+
+Unlike the standard implementation of X-Accel-Redirect on non S3
+storages, the S3 implementation does not require a base URL to be set in
+the storage configuration. The X-Accel-Redirect path is constructed
+directly from the S3 storage's URL defined for the connection, the
+directory name as bucket name, and the file path.
+
+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:%20fs_attachment_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
+-------
+
+* ACSONE SA/NV
+
+Contributors
+------------
+
+- Laurent Mignon laurent.mignon@acsone.eu (https://www.acsone.eu)
+- Stéphane Bidoul stephane.bidoul@acsone.eu (https://www.acsone.eu)
+
+Other credits
+-------------
+
+The development of this module has been financially supported by:
+
+- ACSONE SA/NV (https://www.acsone.eu)
+- Alcyon Belux
+
+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.
+
+.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px
+    :target: https://github.com/lmignon
+    :alt: lmignon
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-lmignon| 
+
+This module is part of the `OCA/storage <https://github.com/OCA/storage/tree/16.0/fs_attachment_s3>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

odoo/addons/fs_attachment_s3/__init__.py

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

odoo/addons/fs_attachment_s3/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2025 ACSONE SA/NV
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Fs Attachment S3",
+    "summary": """Store attachments into S3 complient filesystem""",
+    "version": "16.0.2.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/storage",
+    "depends": ["fs_attachment"],
+    "external_dependencies": {
+        "python": [
+            "fsspec[s3]",
+        ],
+    },
+    "data": [
+        "views/fs_storage.xml",
+    ],
+    "maintainers": ["lmignon"],
+}

odoo/addons/fs_attachment_s3/i18n/fs_attachment_s3.pot

@@ -0,0 +1,48 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* fs_attachment_s3
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.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: fs_attachment_s3
+#: model:ir.model,name:fs_attachment_s3.model_ir_attachment
+msgid "Attachment"
+msgstr ""
+
+#. module: fs_attachment_s3
+#: model:ir.model,name:fs_attachment_s3.model_fs_storage
+msgid "FS Storage"
+msgstr ""
+
+#. module: fs_attachment_s3
+#: model:ir.model.fields,help:fs_attachment_s3.field_fs_storage__s3_uses_signed_url_for_x_sendfile
+msgid ""
+"If checked, the storage will use signed URLs for attachments when using "
+"X-Accel-Redirect. This is useful for S3 storage where the file path is not "
+"directly accessible without authentication."
+msgstr ""
+
+#. module: fs_attachment_s3
+#: model:ir.model.fields,field_description:fs_attachment_s3.field_fs_storage__s3_signed_url_expiration
+msgid "Signed URL Expiration (seconds)"
+msgstr ""
+
+#. module: fs_attachment_s3
+#: model:ir.model.fields,help:fs_attachment_s3.field_fs_storage__s3_signed_url_expiration
+msgid ""
+"The expiration time for the signed URL in seconds. Default is 30 seconds."
+msgstr ""
+
+#. module: fs_attachment_s3
+#: model:ir.model.fields,field_description:fs_attachment_s3.field_fs_storage__s3_uses_signed_url_for_x_sendfile
+msgid "Use signed URL for X-Accel-Redirect"
+msgstr ""

odoo/addons/fs_attachment_s3/models/__init__.py

@@ -0,0 +1,2 @@
+from . import fs_storage
+from . import ir_attachment

odoo/addons/fs_attachment_s3/models/fs_storage.py

@@ -0,0 +1,55 @@
+# Copyright 2025 ACSONE SA/NV
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import fsspec.asyn
+
+from odoo import api, fields, models
+
+
+class FsStorage(models.Model):
+
+    _inherit = "fs.storage"
+
+    s3_uses_signed_url_for_x_sendfile = fields.Boolean(
+        string="Use signed URL for X-Accel-Redirect",
+        help="If checked, the storage will use signed URLs for attachments "
+        "when using X-Accel-Redirect. This is useful for S3 storage where the "
+        "file path is not directly accessible without authentication.",
+    )
+    s3_signed_url_expiration = fields.Integer(
+        string="Signed URL Expiration (seconds)",
+        default=30,
+        help="The expiration time for the signed URL in seconds. "
+        "Default is 30 seconds.",
+    )
+
+    @property
+    def _server_env_fields(self):
+        """Override to include S3 specific fields."""
+        fields = super()._server_env_fields
+        fields.update(
+            {
+                "s3_uses_signed_url_for_x_sendfile": {},
+                "s3_signed_url_expiration": {},
+            }
+        )
+        return fields
+
+    @property
+    def is_s3_storage(self):
+        """Check if the storage is an S3 storage."""
+        self.ensure_one()
+        return hasattr(self._get_root_filesystem(self.fs), "s3")
+
+    @api.model
+    def _s3_call_generate_presigned_url(self, s3_client, *args, **kwargs):
+        """Generate a presigned URL for S3 operations."""
+        # s3fs uses aiobotocore as s3 client, which is asynchronous.
+        # We need to run the async function in a synchronous context.
+        return fsspec.asyn.sync(
+            fsspec.asyn.get_loop(),
+            s3_client.generate_presigned_url,
+            *args,
+            timeout=None,
+            **kwargs,
+        )

odoo/addons/fs_attachment_s3/models/ir_attachment.py

@@ -0,0 +1,82 @@
+# Copyright 2025 ACSONE SA/NV
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+from urllib.parse import urlparse
+
+from odoo import models
+
+
+class IrAttachment(models.Model):
+
+    _inherit = "ir.attachment"
+
+    def _storage_write_option(self, fs):
+        option = super()._storage_write_option(fs)
+        mimetype = self.env.context.get("mimetype")
+        if mimetype:
+            root_fs = self.env["fs.storage"]._get_root_filesystem(fs)
+            if hasattr(root_fs, "s3"):
+                option["ContentType"] = mimetype
+        return option
+
+    def _get_x_sendfile_path(self):
+        self.ensure_one()
+        storage = self.fs_storage_id
+        if storage.is_s3_storage:
+            return self._get_s3_x_sendfile_path()
+        return super()._get_x_sendfile_path()
+
+    def _fs_use_x_sendfile(self):
+        self.ensure_one()
+        storage = self.fs_storage_id
+        if storage.is_s3_storage:
+            return storage.use_x_sendfile_to_serve_internal_url
+        return super()._fs_use_x_sendfile()
+
+    def _get_s3_x_sendfile_path(self):
+        """Generate the X-Accel-Redirect path for S3 storage.
+
+        This method is used to generate the path for S3 storage when using
+        X-Accel-Redirect. It constructs the path based on the S3 bucket and
+        file path, ensuring that it is compatible with the S3 storage
+        configuration and the Odoo file storage system.
+
+        Args:
+            attachment (IrAttachment): The attachment record for which the
+                X-Accel-Redirect path is being generated.
+        Returns:
+            str: The X-Accel-Redirect path for the S3 storage.
+
+        The path is formatted as:
+            /fs_x_sendfile/<scheme>/<netloc>/<path>
+
+        where:
+        - `<scheme>` is the scheme of the base URL (e.g., 'https').
+        - `<netloc>` is the netloc of the base URL (e.g., 's3.amazonaws.com').
+        - `<path>` is the path to the file in the S3 bucket, including the
+          bucket name
+        """
+        fs, storage_code, file_path = self._get_fs_parts()
+        storage = self.env["fs.storage"].sudo().get_by_code(storage_code)
+        root_fs = storage._get_root_filesystem(fs)
+        s3_client = root_fs.s3
+        bucket_name = storage.directory_path.strip("/").rstrip("/")
+        if storage.s3_uses_signed_url_for_x_sendfile:
+            file_url = storage._s3_call_generate_presigned_url(
+                s3_client,
+                "get_object",
+                Params={"Bucket": bucket_name, "Key": file_path},
+                ExpiresIn=storage.s3_signed_url_expiration,
+            )
+        else:
+            file_url = (
+                f"{s3_client.meta.endpoint_url.rstrip('/')}/"
+                f"{bucket_name}/{file_path.lstrip('/')}"
+            )
+
+        parsed_url = urlparse(file_url)
+        path = parsed_url.path.strip("/")
+        query = parsed_url.query
+        redirect_path = f"/fs_x_sendfile/{parsed_url.scheme}/{parsed_url.netloc}/{path}"
+        if query:
+            redirect_path += f"?{query}"
+        return redirect_path

odoo/addons/fs_attachment_s3/readme/CONFIGURE.md

@@ -0,0 +1,64 @@
+On the Odoo instance, go to *Settings* > *Technical* > *Storage* > *File Storage*.
+
+When you create a new storage for s3 or modify an existing one, when you activate
+the option "Use X-Sendfile To Serve Internal Url", 2 additional fields will appear:
+
+- **S3 Uses Signed URL For X-Accel-Redirect**: If checked, the X-Accel-Redirect
+  path will be a signed URL, which is useful for S3 storages that require
+  signed URLs for access.
+- **S3 Signed URL Expiration**: The expiration time for the signed URL in seconds.
+  This field is only relevant if the previous option is checked. By default,
+  it is set to 30 seconds but it could be less since the url generated into
+  the X-Accel-Redirect process is directly used by the web server to serve the file.
+
+The value of these fields can also be set in the server environment variables using
+the keys:
+
+- *s3_uses_signed_url_for_x_sendfile*
+- *s3_signed_url_expiration*
+
+When the option "Use X-Sendfile To Serve Internal Url" is enabled, the system will
+generate an X-Accel-Redirect header in the response to a request to get a file.
+In the case of S3 storages, it will follow the format:
+
+```text
+X-Accel-Redirect: /fs_x_sendfile/{scheme}/{host}/{path with query if any}
+```
+
+Where:
+
+- `{scheme}`: The URL scheme (http or https).
+- `{host}`: The host of the S3 storage.
+- `{path with query if any}`: The path to the file in the S3 storage,
+  including any query parameters. (Query parameters are set when the
+  `s3_uses_signed_url_for_x_sendfile` option is enabled.)
+
+In order to serve files using X-Accel-Redirect, you must ensure that your
+web server is configured to handle these headers correctly. This typically
+involves setting up a location block in your web server configuration that
+matches the X-Accel-Redirect path and proxies the request to the S3 storage.
+
+For example, if you are using Nginx, you would add a location block like this:
+
+```nginx
+
+    location ~ ^/fs_x_sendfile/(.*?)/(.*?)/(.*) {
+        internal;
+        set $url_scheme $1;
+        set $url_host $2;
+        set $url_path $3;
+        set $url $url_scheme://$url_host/$url_path;
+
+        proxy_pass $url$is_args$args;
+        proxy_set_header Host $url_host;
+        proxy_ssl_server_name on;
+     
+    }
+```
+
+
+Unlike the standard implementation of X-Accel-Redirect on non S3 storages,
+the S3 implementation does not require a base URL to be set in the storage
+configuration. The X-Accel-Redirect path is constructed directly from the
+S3 storage's URL defined for the connection, the directory name as
+bucket name, and the file path.

odoo/addons/fs_attachment_s3/readme/CONTRIBUTORS.md

@@ -0,0 +1,2 @@
+- Laurent Mignon <laurent.mignon@acsone.eu> (https://www.acsone.eu)
+- Stéphane Bidoul <stephane.bidoul@acsone.eu> (https://www.acsone.eu)

odoo/addons/fs_attachment_s3/readme/CREDITS.md

@@ -0,0 +1,4 @@
+The development of this module has been financially supported by:
+
+- ACSONE SA/NV (https://www.acsone.eu)
+- Alcyon Belux

odoo/addons/fs_attachment_s3/readme/DESCRIPTION.md

@@ -0,0 +1,7 @@
+This module extends the functionality of [fs_attachment](https://github.com/OCA/storage/tree/16.0/fs_attachment) 
+to better support Amazon S3 storage. It includes features such as:
+
+- Special handling of X-Accel-Redirect headers for S3 storages.
+- Options for using signed URLs in X-Accel-Redirect. (This is required to be able to serve files from a private S3 bucket 
+  using X-Accel-Redirect without exposing the files publicly.)
+- Enforcing the mimetype of files stored in S3.