[16.0][MIG] mail_embed_image module

mail_embed_image/README.rst

@@ -0,0 +1,86 @@
+================
+Mail Embed Image
+================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:a365995cc3558fa6f105e5354c6a4317efd6453f04a5647e0acdff4c5adb3c12
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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-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%2Fsocial-lightgray.png?logo=github
+    :target: https://github.com/OCA/social/tree/16.0/mail_embed_image
+    :alt: OCA/social
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_embed_image
+    :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/social&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module finds images attached to outgoing emails and replaces their urls
+with cids. This will avoid rendering issues with some email clients.
+
+It also provides 2 options to embed internal URL images in a mail body:
+ - CIDs: add fileparts as CIDs
+ - Data URLs: add images as data URLs
+
+This option is configurable in an company settings variables.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/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/social/issues/new?body=module:%20mail_embed_image%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
+~~~~~~~
+
+* Therp BV
+
+Contributors
+~~~~~~~~~~~~
+
+* George Daramouskas <[email protected]>
+* Giovanni Francesco Capalbo <[email protected]>
+* Italo LOPES <[email protected]>
+* Stéphane Mangin <[email protected]>
+
+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/social <https://github.com/OCA/social/tree/16.0/mail_embed_image>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_embed_image/__init__.py

@@ -0,0 +1,3 @@
+# Copyright 2019 Therp BV <https://therp.nl>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+from . import models

mail_embed_image/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2019 Therp BV <https://therp.nl>
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+{
+    "name": "Mail Embed Image",
+    "version": "16.0.1.0.0",
+    "author": "Therp BV,Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "category": "Social",
+    "summary": "Replace img.src's which start with http with inline cids",
+    "website": "https://github.com/OCA/social",
+    "depends": [
+        "mail",
+        "web",
+    ],
+    "data": [
+        "views/res_config_settings_views.xml",
+    ],
+    "installable": True,
+    "application": False,
+}

mail_embed_image/i18n/mail_embed_image.pot

@@ -0,0 +1,20 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* mail_embed_image
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.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: mail_embed_image
+#: model:ir.model,name:mail_embed_image.model_ir_mail_server
+msgid "ir.mail_server"
+msgstr ""
+

mail_embed_image/models/__init__.py

@@ -0,0 +1,6 @@
+# Copyright 2019 Therp BV <https://therp.nl>
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+from . import ir_mail_server
+from . import company
+from . import res_config_settings

mail_embed_image/models/company.py

@@ -0,0 +1,17 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from odoo import fields, models
+
+
+class ResCompany(models.Model):
+    _inherit = "res.company"
+
+    image_embedding_method = fields.Selection(
+        selection=[
+            ("none", "No postprocessing"),
+            ("cid", "Content-ID (Gmail, Office compatible)"),
+            ("data", "HTML Inline Data"),
+        ],
+        default="cid",
+        required=True,
+    )

mail_embed_image/models/ir_mail_server.py

@@ -0,0 +1,158 @@
+# Copyright 2019 Therp BV <https://therp.nl>
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import logging
+import uuid
+from base64 import b64encode
+from email.mime.image import MIMEImage
+from email.mime.multipart import MIMEMultipart
+
+import requests
+from lxml.html import fromstring, tostring
+
+from odoo import models
+
+_logger = logging.getLogger(__name__)
+
+
+class IrMailServer(models.Model):
+    _inherit = "ir.mail_server"
+
+    def build_email(
+        self,
+        email_from,
+        email_to,
+        subject,
+        body,
+        email_cc=None,
+        email_bcc=None,
+        reply_to=False,
+        attachments=None,
+        message_id=None,
+        references=None,
+        object_id=False,
+        subtype="plain",
+        headers=None,
+        body_alternative=None,
+        subtype_alternative="plain",
+    ):
+        image_embedding_method = self.env.company.image_embedding_method
+        fileparts = None
+        if subtype == "html" and image_embedding_method != "none":
+            body, fileparts = self._build_email_replace_img_src(body)
+
+        # TODO check if we can add attachments here.
+        result = super(IrMailServer, self).build_email(
+            email_from=email_from,
+            email_to=email_to,
+            subject=subject,
+            body=body,
+            email_cc=email_cc,
+            email_bcc=email_bcc,
+            reply_to=reply_to,
+            attachments=attachments,
+            message_id=message_id,
+            references=references,
+            object_id=object_id,
+            subtype=subtype,
+            headers=headers,
+            body_alternative=body_alternative,
+            subtype_alternative=subtype_alternative,
+        )
+        if fileparts:
+            # Multipart method MUST be multipart/related for CIDs embedding
+            # Gmail and Office won't process the images otherwise
+            if image_embedding_method == "cid":
+                result.set_type("multipart/related")
+            for fpart in fileparts:
+                result.attach(fpart)
+            # after all part where added, we need to reorganize the parts
+            #
+            # Before:
+            # - boundary 1
+            #   - text/plain
+            #   - text/html
+            #   - image/png
+            # After:
+            # - boundary 1
+            #   - multipart/alternative
+            #     - boundary 2
+            #       - text/plain
+            #       - text/html
+            #   - image/png
+            # If an attachment is present, the parts are already in the right
+            # order in this case, we don't need to reorganize the parts
+            # but if we find later text/plain or text/html parts, we will need
+            # to append them to the first multipart/alternative.
+            #
+            # It possible to have multiple parts of type multipart/alternative,
+            # but it's not a common case.
+            all_parts = []
+            for part in result.iter_parts():
+                if part.get_content_type() == "multipart/alternative":
+                    all_parts.append(part)
+
+            if not all_parts:
+                all_parts = [MIMEMultipart("alternative")]
+
+            for part in result.iter_parts():
+                if part.get_content_type() in ["text/html", "text/plain"]:
+                    all_parts[0].attach(part)
+                elif part.get_content_type() == "multipart/alternative":
+                    pass
+                else:
+                    all_parts.append(part)
+            result.set_payload(all_parts)
+        return result
+
+    def _build_email_replace_img_src(self, html_body):
+        """Replace img src with base64 encoded image."""
+        if not html_body:
+            return html_body
+
+        base_url = self.env["ir.config_parameter"].get_param("web.base.url")
+        image_embedding_method = self.env.company.image_embedding_method
+        root = fromstring(html_body)
+        fileparts = []
+        # Limit results to only internal resources to avoid malicious external
+        # image injections
+        for img in root.xpath(
+            ".//img[starts-with(@src, '%s')]"
+            "| .//img[starts-with(@src, '/web/image')]" % (base_url)
+        ):
+            image_path = img.get("src")
+            try:
+                response = requests.get(image_path, timeout=10)
+                _logger.debug("Fetching image from %s", image_path)
+                if response.status_code == 200:
+                    image_content = response.content
+                    filepart = MIMEImage(image_content)
+                    if image_embedding_method == "data":
+                        raw_content = filepart.get_payload(decode=True)
+                        base_64_content = b64encode(raw_content).decode("utf-8")
+                        mimetype = filepart.get_content_type()
+                        img.set("src", f"data:{mimetype};base64,{base_64_content}")
+                    elif image_embedding_method == "cid":
+                        cid = uuid.uuid4().hex
+                        # convert cid to rfc2047 encoding
+                        filename_encoded = "=?utf-8?b?%s?=" % b64encode(
+                            cid.encode("utf-8")
+                        ).decode("utf-8")
+                        filepart.add_header("Content-ID", f"<{cid}>")
+                        filepart.add_header(
+                            "Content-Disposition",
+                            "inline",
+                            filename=filename_encoded,
+                        )
+                        img.set("src", f"cid:{cid}")
+                        fileparts.append(filepart)
+                else:
+                    _logger.warning(
+                        "Could not get %s: HTTP status code %s",
+                        img.get("src"),
+                        response.status_code,
+                    )
+            except Exception as e:
+                _logger.warning("Could not get %s: %s", img.get("src"), str(e))
+        return tostring(root, encoding="unicode"), fileparts

mail_embed_image/models/res_config_settings.py

@@ -0,0 +1,12 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from odoo import fields, models
+
+
+class ResConfigSettings(models.TransientModel):
+    _inherit = "res.config.settings"
+
+    image_embedding_method = fields.Selection(
+        related="company_id.image_embedding_method",
+        readonly=False,
+    )

mail_embed_image/readme/CONTRIBUTORS.rst

@@ -0,0 +1,4 @@
+* George Daramouskas <[email protected]>
+* Giovanni Francesco Capalbo <[email protected]>
+* Italo LOPES <[email protected]>
+* Stéphane Mangin <[email protected]>

mail_embed_image/readme/DESCRIPTION.rst

@@ -0,0 +1,8 @@
+This module finds images attached to outgoing emails and replaces their urls
+with cids. This will avoid rendering issues with some email clients.
+
+It also provides 2 options to embed internal URL images in a mail body:
+ - CIDs: add fileparts as CIDs
+ - Data URLs: add images as data URLs
+
+This option is configurable in an company settings variables.