From 9395b7d8f1b898909aeaa1be3f7d4d9245d07495 Mon Sep 17 00:00:00 2001 From: Enric Tobella Date: Wed, 5 Nov 2025 20:52:06 +0100 Subject: [PATCH] [ADD] mail_external_cleaner --- mail_external_cleaner/README.rst | 89 ++++ mail_external_cleaner/__init__.py | 1 + mail_external_cleaner/__manifest__.py | 20 + mail_external_cleaner/models/__init__.py | 3 + .../models/ir_mail_server.py | 123 +++++ mail_external_cleaner/models/mail_mail.py | 58 +++ mail_external_cleaner/models/mail_thread.py | 19 + mail_external_cleaner/readme/CONTRIBUTORS.md | 3 + mail_external_cleaner/readme/DESCRIPTION.md | 5 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 437 ++++++++++++++++++ mail_external_cleaner/tests/__init__.py | 1 + .../tests/portal_fake_model.py | 15 + .../tests/test_mail_external_cleaner.py | 104 +++++ setup/.setuptools-odoo-make-default-ignore | 2 + setup/README | 2 + .../odoo/addons/mail_external_cleaner | 1 + setup/mail_external_cleaner/setup.py | 6 + test-requirements.txt | 1 + 19 files changed, 890 insertions(+) create mode 100644 mail_external_cleaner/README.rst create mode 100644 mail_external_cleaner/__init__.py create mode 100644 mail_external_cleaner/__manifest__.py create mode 100644 mail_external_cleaner/models/__init__.py create mode 100644 mail_external_cleaner/models/ir_mail_server.py create mode 100644 mail_external_cleaner/models/mail_mail.py create mode 100644 mail_external_cleaner/models/mail_thread.py create mode 100644 mail_external_cleaner/readme/CONTRIBUTORS.md create mode 100644 mail_external_cleaner/readme/DESCRIPTION.md create mode 100644 mail_external_cleaner/static/description/icon.png create mode 100644 mail_external_cleaner/static/description/index.html create mode 100644 mail_external_cleaner/tests/__init__.py create mode 100644 mail_external_cleaner/tests/portal_fake_model.py create mode 100644 mail_external_cleaner/tests/test_mail_external_cleaner.py create mode 100644 setup/.setuptools-odoo-make-default-ignore create mode 100644 setup/README create mode 120000 setup/mail_external_cleaner/odoo/addons/mail_external_cleaner create mode 100644 setup/mail_external_cleaner/setup.py create mode 100644 test-requirements.txt diff --git a/mail_external_cleaner/README.rst b/mail_external_cleaner/README.rst new file mode 100644 index 000000000..cc66e38c7 --- /dev/null +++ b/mail_external_cleaner/README.rst @@ -0,0 +1,89 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +===================== +Mail External Cleaner +===================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:1c85e0de80c033bfd956777cbb17624817cc912e71041b8bda835cbcc1d1b0ca + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fmail-lightgray.png?logo=github + :target: https://github.com/OCA/mail/tree/16.0/mail_external_cleaner + :alt: OCA/mail +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/mail-16-0/mail-16-0-mail_external_cleaner + :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/mail&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module removes all the link images on the mail and replaces it by +the source image. + +This has sense when Our Odoo instance is not open to our customers. + +Also removes portal headers and so on and keeps it only for internal +users. + +**Table of contents** + +.. contents:: + :local: + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Dixmit +* CreuBlanca + +Contributors +------------ + +- `Dixmit `__ + + - Enric Tobella + +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/mail `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mail_external_cleaner/__init__.py b/mail_external_cleaner/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/mail_external_cleaner/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/mail_external_cleaner/__manifest__.py b/mail_external_cleaner/__manifest__.py new file mode 100644 index 000000000..ed56b0064 --- /dev/null +++ b/mail_external_cleaner/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2025 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Mail External Cleaner", + "summary": """ + Clean up email content by removing unnecessary external resources. + Makes sense for isolated environments with emails. + """, + "version": "16.0.1.0.0", + "license": "AGPL-3", + "author": "Dixmit,CreuBlanca,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/mail", + "depends": [ + "mail", + "portal", + ], + "data": [], + "demo": [], +} diff --git a/mail_external_cleaner/models/__init__.py b/mail_external_cleaner/models/__init__.py new file mode 100644 index 000000000..9a3c30ed9 --- /dev/null +++ b/mail_external_cleaner/models/__init__.py @@ -0,0 +1,3 @@ +from . import mail_mail +from . import mail_thread +from . import ir_mail_server diff --git a/mail_external_cleaner/models/ir_mail_server.py b/mail_external_cleaner/models/ir_mail_server.py new file mode 100644 index 000000000..805724906 --- /dev/null +++ b/mail_external_cleaner/models/ir_mail_server.py @@ -0,0 +1,123 @@ +import base64 +import itertools +import mimetypes +import re + +from odoo import models + +_DATA_URI_RE = re.compile( + r'src=(["\'])data:(?P[^;]+);base64,(?P[A-Za-z0-9+/=\s]+)\1', + re.IGNORECASE, +) + + +def extract_inline_images_from_html(html, existing_names=()): + """ + Finds and returns: + new_html, inline_attachments, inline_names + where: + - inline_attachments: list of (filename, bytes, mime) to append to your attachments + - inline_names: set of the filenames we generated (these will become CIDs) + """ + counter = itertools.count(1) + existing = {n for n in existing_names if n} + inline_attachments = [] + inline_names = set() + + def repl(m): + mime = m.group("mime").strip().lower() + ext = mimetypes.guess_extension(mime) or ".bin" + # unique filename we’ll also use as the CID + while True: + name = f"inline-{next(counter)}{ext}" + if name not in existing: + break + b64 = re.sub(r"\s+", "", m.group("b64")) + data = base64.b64decode(b64) + inline_attachments.append((name, data, mime)) + inline_names.add(name) + return f'src="cid:{name}"' # noqa: E231 + + new_html = _DATA_URI_RE.sub(repl, html) + return new_html, inline_attachments, inline_names + + +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", + ): + existing_names = [ + a[0] for a in (attachments or []) if isinstance(a, (list, tuple)) and a + ] + if subtype == "html" and body: + body, inline_atts, inline_names = extract_inline_images_from_html( + body, existing_names + ) + else: + inline_atts, inline_names = [], set() + # Append our inline attachments to your normal attachments (no function change) + attachments = (attachments or []) + inline_atts + msg = super().build_email( + email_from, + email_to, + subject, + 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, + ) + for part in msg.iter_attachments(): + fname = part.get_filename() + if fname and fname in inline_names: + # Content-ID used by + if "Content-ID" in part: + del part["Content-ID"] + part.add_header("Content-ID", f"<{fname}>") + + # Inline disposition so clients don’t show them as regular downloads + if part.get("Content-Disposition"): + part.replace_header( + "Content-Disposition", + f'inline; filename="{fname}"', # noqa: E702 + ) + else: + part.add_header( + "Content-Disposition", + f'inline; filename="{fname}"', # noqa: E702 + ) + + # Ensure base64 transfer encoding (usually already set by add_attachment) + cte = (part.get("Content-Transfer-Encoding") or "").lower() + if cte != "base64": + payload = part.get_payload(decode=True) + part.set_payload(base64.b64encode(payload).decode("ascii")) + if cte: + part.replace_header("Content-Transfer-Encoding", "base64") + else: + part.add_header("Content-Transfer-Encoding", "base64") + return msg diff --git a/mail_external_cleaner/models/mail_mail.py b/mail_external_cleaner/models/mail_mail.py new file mode 100644 index 000000000..153c9f282 --- /dev/null +++ b/mail_external_cleaner/models/mail_mail.py @@ -0,0 +1,58 @@ +# Copyright 2025 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +import base64 +import io +import re + +from odoo import models +from odoo.tools.mimetypes import guess_mimetype + +IMAGE_REGEX = r"(\)" # noqa: B950 + + +class MailMail(models.Model): + + _inherit = "mail.mail" + + def _send_prepare_body(self): + body = super()._send_prepare_body() + return self._embed_images(body) + + def _get_image_attachment(self, path): + if m := re.match(r"\/logo\.png\?company=(\d+)", path): + company = self.env["res.company"].browse(int(m.group(1))) + image_base64 = base64.b64decode(company.logo_web) + io.BytesIO(image_base64) + mimetype = guess_mimetype(image_base64, default="image/png") + imgext = "." + mimetype.split("/")[1] + if imgext == ".svg+xml": + imgext = ".svg" + return mimetype, company.logo_web.decode("utf-8") + if m := re.match(r"\/web\/image\/(\d+)", path): + image = self.env["ir.attachment"].browse(int(m.group(1))) + if image.exists(): + return image.mimetype, image.datas.decode("utf-8") + + def _embed_images(self, body): + base_url = ( + self.env["ir.config_parameter"] + .sudo() + .get_param("web.base.url", default="http://localhost:8069") + ) + for data in set( + re.findall( + IMAGE_REGEX, + body, + ) + ): + pre_data, url, path, post_data = data + if url == base_url: + img_data = f"{pre_data}{url}{path}{post_data}" + attachment = self._get_image_attachment(path) + if attachment: + body = body.replace( + img_data, + f"{pre_data}data:{attachment[0]};base64,{attachment[1]}{post_data}", # noqa: E231, E702, B950 + ) + return body diff --git a/mail_external_cleaner/models/mail_thread.py b/mail_external_cleaner/models/mail_thread.py new file mode 100644 index 000000000..e7060fcd1 --- /dev/null +++ b/mail_external_cleaner/models/mail_thread.py @@ -0,0 +1,19 @@ +# Copyright 2025 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import models + + +class MailThread(models.AbstractModel): + + _inherit = "mail.thread" + + def _notify_get_recipients_groups(self, msg_vals=None): + """ + Override to disable portal customer button access in email notifications. + """ + groups = super()._notify_get_recipients_groups(msg_vals=msg_vals) + for group, _group_func, group_vals in groups: + if group == "portal_customer": + group_vals["has_button_access"] = False + return groups diff --git a/mail_external_cleaner/readme/CONTRIBUTORS.md b/mail_external_cleaner/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..4caf9c08f --- /dev/null +++ b/mail_external_cleaner/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- [Dixmit](https://www.dixmit.com) + - Enric Tobella + \ No newline at end of file diff --git a/mail_external_cleaner/readme/DESCRIPTION.md b/mail_external_cleaner/readme/DESCRIPTION.md new file mode 100644 index 000000000..ab4214583 --- /dev/null +++ b/mail_external_cleaner/readme/DESCRIPTION.md @@ -0,0 +1,5 @@ +This module removes all the link images on the mail and replaces it by the source image. + +This has sense when Our Odoo instance is not open to our customers. + +Also removes portal headers and so on and keeps it only for internal users. \ No newline at end of file diff --git a/mail_external_cleaner/static/description/icon.png b/mail_external_cleaner/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/mail_external_cleaner/static/description/index.html b/mail_external_cleaner/static/description/index.html new file mode 100644 index 000000000..1ec12b9b0 --- /dev/null +++ b/mail_external_cleaner/static/description/index.html @@ -0,0 +1,437 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

Mail External Cleaner

+ +

Beta License: AGPL-3 OCA/mail Translate me on Weblate Try me on Runboat

+

This module removes all the link images on the mail and replaces it by +the source image.

+

This has sense when Our Odoo instance is not open to our customers.

+

Also removes portal headers and so on and keeps it only for internal +users.

+

Table of contents

+ +
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Dixmit
    • +
  • CreuBlanca
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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/mail project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/mail_external_cleaner/tests/__init__.py b/mail_external_cleaner/tests/__init__.py new file mode 100644 index 000000000..930a333fe --- /dev/null +++ b/mail_external_cleaner/tests/__init__.py @@ -0,0 +1 @@ +from . import test_mail_external_cleaner diff --git a/mail_external_cleaner/tests/portal_fake_model.py b/mail_external_cleaner/tests/portal_fake_model.py new file mode 100644 index 000000000..39b8e6397 --- /dev/null +++ b/mail_external_cleaner/tests/portal_fake_model.py @@ -0,0 +1,15 @@ +# Copyright 2025 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class PortalFakeModel(models.Model): + _name = "portal.fake.model" + _inherit = ["portal.mixin", "mail.thread", "mail.activity.mixin"] + _description = "Portal Fake Model" + + name = fields.Char() + partner_id = fields.Many2one( + comodel_name="res.partner", + ) diff --git a/mail_external_cleaner/tests/test_mail_external_cleaner.py b/mail_external_cleaner/tests/test_mail_external_cleaner.py new file mode 100644 index 000000000..0548d05eb --- /dev/null +++ b/mail_external_cleaner/tests/test_mail_external_cleaner.py @@ -0,0 +1,104 @@ +# Copyright 2025 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +import base64 + +from odoo_test_helper import FakeModelLoader + +from odoo.addons.mail.tests.common import MailCommon + + +class TestMailExternalCleaner(MailCommon): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.loader = FakeModelLoader(cls.env, cls.__module__) + cls.loader.backup_registry() + cls.addClassCleanup(cls.loader.restore_registry) + from .portal_fake_model import PortalFakeModel + + cls.loader.update_registry((PortalFakeModel,)) + cls.partner = cls.env["res.partner"].create( + { + "name": "Partner Test", + "email": "partner_test@test.example.com", + "company_id": cls.env.company.id, + } + ) + cls.portal = cls.env["portal.fake.model"].create( + { + "name": "Portal Test", + "partner_id": cls.partner.id, + } + ) + cls.attachment = cls.env["ir.attachment"].create( + { + "name": "test.txt", + "datas": base64.b64encode(b"test attachment data"), + "mimetype": "text/plain", + } + ) + cls.url = ( + cls.env["ir.config_parameter"] + .sudo() + .get_param("web.base.url", default="http://localhost:8069") + ) + + def test_company_logo(self): + image_src = f"{self.url}/logo.png?company={self.env.company.id}" + with self.mock_mail_gateway(): + self.portal.message_post( + body=f'

Checking My Image

', + subject="Test Email with External Image", + partner_ids=self.partner.ids, + attachments=[(self.attachment.name, self.attachment.datas)], + ) + self.assertEqual(len(self._mails), 1) + self.assertNotIn(self.url, self._mails[0]["body_alternative"]) + + def test_image_attachment(self): + image = self.env["ir.attachment"].create( + { + "name": "test_image.png", + "datas": base64.b64encode(b"test image data"), + "mimetype": "image/png", + } + ) + image_src = f"{self.url}/web/image/{image.id}" + with self.mock_mail_gateway(): + self.portal.message_post( + body=f'

Checking My Image

', + subject="Test Email with External Image", + partner_ids=self.partner.ids, + attachments=[(self.attachment.name, self.attachment.datas)], + ) + self.assertEqual(len(self._mails), 1) + self.assertNotIn(self.url, self._mails[0]["body_alternative"]) + + def test_other_images(self): + """Should not replace as we don't know how to handle them.""" + image_src = f"{self.url}/image.png" + with self.mock_mail_gateway(): + self.portal.message_post( + body=f'

Checking My Image

', + subject="Test Email with External Image", + partner_ids=self.partner.ids, + attachments=[(self.attachment.name, self.attachment.datas)], + ) + self.assertEqual(len(self._mails), 1) + self.assertIn(self.url, self._mails[0]["body_alternative"]) + + def test_outside_images(self): + """Should not replace them.""" + image_src = "http://localhostlocalhost:8069/image.png" + with self.mock_mail_gateway(): + self.portal.message_post( + body=f'

Checking My Image

', + subject="Test Email with External Image", + partner_ids=self.partner.ids, + attachments=[(self.attachment.name, self.attachment.datas)], + ) + self.assertEqual(len(self._mails), 1) + self.assertIn( + "http://localhostlocalhost:8069", self._mails[0]["body_alternative"] + ) diff --git a/setup/.setuptools-odoo-make-default-ignore b/setup/.setuptools-odoo-make-default-ignore new file mode 100644 index 000000000..207e61533 --- /dev/null +++ b/setup/.setuptools-odoo-make-default-ignore @@ -0,0 +1,2 @@ +# addons listed in this file are ignored by +# setuptools-odoo-make-default (one addon per line) diff --git a/setup/README b/setup/README new file mode 100644 index 000000000..a63d633e8 --- /dev/null +++ b/setup/README @@ -0,0 +1,2 @@ +To learn more about this directory, please visit +https://pypi.python.org/pypi/setuptools-odoo diff --git a/setup/mail_external_cleaner/odoo/addons/mail_external_cleaner b/setup/mail_external_cleaner/odoo/addons/mail_external_cleaner new file mode 120000 index 000000000..a78f52619 --- /dev/null +++ b/setup/mail_external_cleaner/odoo/addons/mail_external_cleaner @@ -0,0 +1 @@ +../../../../mail_external_cleaner \ No newline at end of file diff --git a/setup/mail_external_cleaner/setup.py b/setup/mail_external_cleaner/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/mail_external_cleaner/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 000000000..66bc2cbae --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +odoo_test_helper