From d229817c5a735b1152ff11a435434fc5a61e65f9 Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Tue, 23 Apr 2019 18:21:41 +0200 Subject: [PATCH 1/7] [ADD] mail_embed_image module --- mail_embed_image/README.rst | 78 ++++++++++++++++ mail_embed_image/__init__.py | 4 + mail_embed_image/__manifest__.py | 18 ++++ mail_embed_image/models/__init__.py | 4 + mail_embed_image/models/ir_mail_server.py | 88 ++++++++++++++++++ mail_embed_image/static/description/icon.png | Bin 0 -> 9455 bytes mail_embed_image/tests/__init__.py | 4 + .../tests/test_mail_embed_image.py | 25 +++++ 8 files changed, 221 insertions(+) create mode 100644 mail_embed_image/README.rst create mode 100644 mail_embed_image/__init__.py create mode 100644 mail_embed_image/__manifest__.py create mode 100644 mail_embed_image/models/__init__.py create mode 100644 mail_embed_image/models/ir_mail_server.py create mode 100644 mail_embed_image/static/description/icon.png create mode 100644 mail_embed_image/tests/__init__.py create mode 100644 mail_embed_image/tests/test_mail_embed_image.py diff --git a/mail_embed_image/README.rst b/mail_embed_image/README.rst new file mode 100644 index 00000000..5725e1e3 --- /dev/null +++ b/mail_embed_image/README.rst @@ -0,0 +1,78 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +================ +mail_embed_image +================ + +This module was written to extend the functionality of ... to support ... +and allow you to ... + +Installation +============ + +To install this module, you need to: + +#. do this ... + +Configuration +============= + +To configure this module, you need to: + +#. go to ... + +Usage +===== + +To use this module, you need to: + +#. go to ... +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/205/10.0 + + +Known issues / Roadmap +====================== + +* Some src attributes might contain data instead of urls. Deal with it. + +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 smashing it by providing a detailed and welcomed feedback. + +Credits +======= + +Images +------ + +* Odoo Community Association: `Icon `_. + +Contributors +------------ + +* George Daramouskas + +Do not contact contributors directly about help with questions or problems concerning this addon, but use the `community mailing list `_ or the `appropriate specialized mailinglist `_ for help, and the bug tracker linked in `Bug Tracker`_ above for technical issues. + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit https://odoo-community.org. diff --git a/mail_embed_image/__init__.py b/mail_embed_image/__init__.py new file mode 100644 index 00000000..cff20de5 --- /dev/null +++ b/mail_embed_image/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import models diff --git a/mail_embed_image/__manifest__.py b/mail_embed_image/__manifest__.py new file mode 100644 index 00000000..b4850394 --- /dev/null +++ b/mail_embed_image/__manifest__.py @@ -0,0 +1,18 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +{ + "name": "mail_embed_image", + "version": "10.0.1.0.0", + "author": "Therp BV,Odoo Community Association (OCA)", + "license": "AGPL-3", + "category": "", + "summary": "", + "depends": [ + 'mail', + ], + "data": [ + ], + "installable": True, + "application": False, +} diff --git a/mail_embed_image/models/__init__.py b/mail_embed_image/models/__init__.py new file mode 100644 index 00000000..4278fd5d --- /dev/null +++ b/mail_embed_image/models/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import ir_mail_server diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py new file mode 100644 index 00000000..3ddfdce2 --- /dev/null +++ b/mail_embed_image/models/ir_mail_server.py @@ -0,0 +1,88 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +import requests +import uuid +from odoo import models +from odoo.addons.base.ir.ir_mail_server import encode_header_param +from lxml.html.soupparser import fromstring +from lxml import etree +from base64 import b64encode +from email.mime.base import MIMEBase +from email import Encoders + + +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=None, + attachments=None, + message_id=None, + references=None, + object_id=None, + subtype='plain', + headers=None, + body_alternative=None, + subtype_alternative='plain'): + result = super(IrMailServer, self).build_email( + email_from, + email_to, + subject, + body, + email_cc, + email_bcc, + reply_to, + attachments, + message_id, + references, + object_id, + subtype, + headers, + body_alternative, + subtype_alternative, + ) + + def replace_img_src(msg, attachments): + """replace_img_src Given a message, find it's img tags and if they + are URLs, replace them with cids + + :param msg: A email.message.Message + """ + if msg.is_multipart(): + for part in msg.get_payload(): + replace_img_src(part, attachments) + else: + if msg.get_content_subtype() == 'html': + body = msg.get_payload(decode=True) + root = fromstring(body) + for img in root.xpath('//img'): + src = img.get('src') + if src.startswith('http'): + content = requests.get(src).content + content_base64 = b64encode(content) + cid = uuid.uuid4().hex + filename_rfc2047 = encode_header_param(cid) + part = MIMEBase('application', 'octet-stream') + part.set_param('name', filename_rfc2047) + part.add_header( + 'Content-Disposition', + 'attachment', + cid=cid, + filename=filename_rfc2047, + content=content_base64, + ) + part.set_payload(content) + Encoders.encode_base64(part) + result.attach(part) + img.set('src', 'cid:%s' % (cid)) + msg.set_payload(etree.tostring(root)) + replace_img_src(result, attachments) + return result diff --git a/mail_embed_image/static/description/icon.png b/mail_embed_image/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_embed_image/tests/__init__.py b/mail_embed_image/tests/__init__.py new file mode 100644 index 00000000..5a437961 --- /dev/null +++ b/mail_embed_image/tests/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import test_mail_embed_image diff --git a/mail_embed_image/tests/test_mail_embed_image.py b/mail_embed_image/tests/test_mail_embed_image.py new file mode 100644 index 00000000..153a40d8 --- /dev/null +++ b/mail_embed_image/tests/test_mail_embed_image.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from openerp.tests.common import TransactionCase +from lxml import etree + + +class TestMailEmbedImage(TransactionCase): + + post_install = True + at_install = False + + def test_mail_embed_image(self): + server = self.env['ir.mail_server'] + root = etree.Element('div') + etree.SubElement(root, 'img') + etree.SubElement(root, 'img') + body = etree.tostring(root) + message = server.build_email( + 'test@example.com', + 'test@example.com', + 'subject', + body, + ) + # TODO assertions From d5e82ae716f1cbc75e6a0b3bdcbe77faa83e335f Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Wed, 26 Jun 2019 13:12:44 +0200 Subject: [PATCH 2/7] fixup! [ADD] mail_embed_image module --- mail_embed_image/README.rst | 12 ++-- mail_embed_image/__manifest__.py | 8 +-- mail_embed_image/models/ir_mail_server.py | 69 +++++++++++------------ 3 files changed, 44 insertions(+), 45 deletions(-) diff --git a/mail_embed_image/README.rst b/mail_embed_image/README.rst index 5725e1e3..4c586898 100644 --- a/mail_embed_image/README.rst +++ b/mail_embed_image/README.rst @@ -14,21 +14,23 @@ Installation To install this module, you need to: -#. do this ... +Follow the usual procedure for your version of Odoo. Configuration ============= To configure this module, you need to: -#. go to ... +There are no configuration parameters for now + Usage ===== -To use this module, you need to: +When this module is installed all the emails that will be sent will be examined +and if they contain images with their src attribute pointing to a url, then +that will change to Content Id cid. -#. go to ... .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas :alt: Try me on Runbot :target: https://runbot.odoo-community.org/runbot/205/10.0 @@ -37,7 +39,7 @@ To use this module, you need to: Known issues / Roadmap ====================== -* Some src attributes might contain data instead of urls. Deal with it. +* None so far. Bug Tracker =========== diff --git a/mail_embed_image/__manifest__.py b/mail_embed_image/__manifest__.py index b4850394..f92233a2 100644 --- a/mail_embed_image/__manifest__.py +++ b/mail_embed_image/__manifest__.py @@ -2,17 +2,15 @@ # Copyright 2019 Therp BV # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). { - "name": "mail_embed_image", + "name": "Mail Embed Image", "version": "10.0.1.0.0", "author": "Therp BV,Odoo Community Association (OCA)", "license": "AGPL-3", - "category": "", - "summary": "", + "category": "Social", + "summary": "Replace img.src's which start with http with inline cids", "depends": [ 'mail', ], - "data": [ - ], "installable": True, "application": False, } diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py index 3ddfdce2..3feba5fd 100644 --- a/mail_embed_image/models/ir_mail_server.py +++ b/mail_embed_image/models/ir_mail_server.py @@ -37,52 +37,51 @@ class IrMailServer(models.Model): email_to, subject, body, - email_cc, - email_bcc, - reply_to, - attachments, - message_id, - references, - object_id, - subtype, - headers, - body_alternative, - subtype_alternative, + 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, ) - def replace_img_src(msg, attachments): - """replace_img_src Given a message, find it's img tags and if they - are URLs, replace them with cids + def _build_email_replace_img_src(msg, attachments): + """ Given a message, find it's img tags and if they + are URLs, replace them with cids. :param msg: A email.message.Message """ if msg.is_multipart(): for part in msg.get_payload(): - replace_img_src(part, attachments) + _build_email_replace_img_src(part, attachments) else: if msg.get_content_subtype() == 'html': body = msg.get_payload(decode=True) root = fromstring(body) - for img in root.xpath('//img'): + for img in root.xpath("//img[@src^='http']"): src = img.get('src') - if src.startswith('http'): - content = requests.get(src).content - content_base64 = b64encode(content) - cid = uuid.uuid4().hex - filename_rfc2047 = encode_header_param(cid) - part = MIMEBase('application', 'octet-stream') - part.set_param('name', filename_rfc2047) - part.add_header( - 'Content-Disposition', - 'attachment', - cid=cid, - filename=filename_rfc2047, - content=content_base64, - ) - part.set_payload(content) - Encoders.encode_base64(part) - result.attach(part) - img.set('src', 'cid:%s' % (cid)) + content = requests.get(src).content + content_base64 = b64encode(content) + cid = uuid.uuid4().hex + filename_rfc2047 = encode_header_param(cid) + part = MIMEBase('application', 'octet-stream') + part.set_param('name', filename_rfc2047) + part.add_header( + 'Content-Disposition', + 'attachment', + cid=cid, + filename=filename_rfc2047, + content=content_base64, + ) + part.set_payload(content) + Encoders.encode_base64(part) + result.attach(part) + img.set('src', 'cid:%s' % (cid)) msg.set_payload(etree.tostring(root)) - replace_img_src(result, attachments) + _build_email_replace_img_src(result, attachments) return result From fbdadcaaccdd8f5b6ece42ef343c63b253a23897 Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Wed, 26 Jun 2019 14:44:58 +0200 Subject: [PATCH 3/7] fixup! fixup! [ADD] mail_embed_image module --- mail_embed_image/models/ir_mail_server.py | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py index 3feba5fd..a604b399 100644 --- a/mail_embed_image/models/ir_mail_server.py +++ b/mail_embed_image/models/ir_mail_server.py @@ -8,7 +8,7 @@ from odoo.addons.base.ir.ir_mail_server import encode_header_param from lxml.html.soupparser import fromstring from lxml import etree from base64 import b64encode -from email.mime.base import MIMEBase +from email.mime.image import MIMEImage from email import Encoders @@ -63,22 +63,24 @@ class IrMailServer(models.Model): if msg.get_content_subtype() == 'html': body = msg.get_payload(decode=True) root = fromstring(body) - for img in root.xpath("//img[@src^='http']"): - src = img.get('src') - content = requests.get(src).content - content_base64 = b64encode(content) + for img in root.xpath( + "//img[starts-with(@src, '/web/image')]"): + base_url = self.env['ir.config_parameter'].get_param( + 'web.base.url') + src = base_url + img.get('src') + response = requests.get(src) + #content_base64 = b64encode(response.content) cid = uuid.uuid4().hex filename_rfc2047 = encode_header_param(cid) - part = MIMEBase('application', 'octet-stream') + part = MIMEImage(response.content) part.set_param('name', filename_rfc2047) part.add_header( 'Content-Disposition', 'attachment', cid=cid, filename=filename_rfc2047, - content=content_base64, ) - part.set_payload(content) + part.set_payload(response.content) Encoders.encode_base64(part) result.attach(part) img.set('src', 'cid:%s' % (cid)) From 49eb4bdac35ff8451adc0a4246474de345dcf541 Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Wed, 26 Jun 2019 15:59:55 +0200 Subject: [PATCH 4/7] fixup! fixup! fixup! [ADD] mail_embed_image module --- mail_embed_image/models/ir_mail_server.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py index a604b399..c9d125e9 100644 --- a/mail_embed_image/models/ir_mail_server.py +++ b/mail_embed_image/models/ir_mail_server.py @@ -7,6 +7,7 @@ from odoo import models from odoo.addons.base.ir.ir_mail_server import encode_header_param from lxml.html.soupparser import fromstring from lxml import etree +from lxml.etree import tostring from base64 import b64encode from email.mime.image import MIMEImage from email import Encoders @@ -69,14 +70,13 @@ class IrMailServer(models.Model): 'web.base.url') src = base_url + img.get('src') response = requests.get(src) - #content_base64 = b64encode(response.content) cid = uuid.uuid4().hex filename_rfc2047 = encode_header_param(cid) part = MIMEImage(response.content) part.set_param('name', filename_rfc2047) part.add_header( 'Content-Disposition', - 'attachment', + 'inline', cid=cid, filename=filename_rfc2047, ) @@ -84,6 +84,6 @@ class IrMailServer(models.Model): Encoders.encode_base64(part) result.attach(part) img.set('src', 'cid:%s' % (cid)) - msg.set_payload(etree.tostring(root)) + msg.set_payload(b64encode(tostring(root))) _build_email_replace_img_src(result, attachments) return result From f92a807960192ff251efbbf08d4290845b4efa76 Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Thu, 27 Jun 2019 15:04:23 +0200 Subject: [PATCH 5/7] fixup! fixup! fixup! fixup! [ADD] mail_embed_image module --- mail_embed_image/models/ir_mail_server.py | 1 - .../tests/test_mail_embed_image.py | 62 ++++++++++++++----- 2 files changed, 48 insertions(+), 15 deletions(-) diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py index c9d125e9..dc44cdab 100644 --- a/mail_embed_image/models/ir_mail_server.py +++ b/mail_embed_image/models/ir_mail_server.py @@ -6,7 +6,6 @@ import uuid from odoo import models from odoo.addons.base.ir.ir_mail_server import encode_header_param from lxml.html.soupparser import fromstring -from lxml import etree from lxml.etree import tostring from base64 import b64encode from email.mime.image import MIMEImage diff --git a/mail_embed_image/tests/test_mail_embed_image.py b/mail_embed_image/tests/test_mail_embed_image.py index 153a40d8..810fd69a 100644 --- a/mail_embed_image/tests/test_mail_embed_image.py +++ b/mail_embed_image/tests/test_mail_embed_image.py @@ -1,8 +1,11 @@ # -*- coding: utf-8 -*- # Copyright 2019 Therp BV # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). -from openerp.tests.common import TransactionCase -from lxml import etree +from odoo.tests.common import TransactionCase +from requests import get +from base64 import b64encode +from lxml.html.soupparser import fromstring +from odoo.addons.base.ir.ir_mail_server import encode_header_param class TestMailEmbedImage(TransactionCase): @@ -11,15 +14,46 @@ class TestMailEmbedImage(TransactionCase): at_install = False def test_mail_embed_image(self): - server = self.env['ir.mail_server'] - root = etree.Element('div') - etree.SubElement(root, 'img') - etree.SubElement(root, 'img') - body = etree.tostring(root) - message = server.build_email( - 'test@example.com', - 'test@example.com', - 'subject', - body, - ) - # TODO assertions + """ The following are tested here: + 1) Create an email with no image, send it. + 2) Create an email with three images, one base64 content, one http + full url and one of the format `/web/image/.*` + + We assert that nothing has changed on 1) and only the `/web/image/.*` + has changed in 2) + """ + model_mail_mail = self.env['mail.mail'] + base_url = self.env['ir.config_parameter'].get_param('web.base.url') + image_url = base_url + '/mail_embed_image/static/description/icon.png' + image = get(image_url).content + body1 = '
this is an email
' + email1 = model_mail_mail.create({'body': body1}) + email1.send() + message_body = self.env.cr.execute( + "SELECT body FROM mail_message WHERE message_id = %s LIMIT 1", + (email1.message_id, )) + self.assertEquals(message_body, body1) + body2 = """ +
+ this is an email + + + +
""" % ( + b64encode(image), + image_url, + '/web/image/res.partner/1/image', + ) + email2 = model_mail_mail.create({'body': body2}) + email2.send() + message_body = self.env.cr.execute( + "SELECT body FROM mail_message WHERE message_id = %s LIMIT 1", + (email1.message_id, )) + body2final = fromstring(message_body) + self.assertEquals(len(body2final.xpath('//img')), 3) + srcs = [x.get('src') for x in body2final.xpath('//img')] + self.assertIn('base64:', srcs[0]) + self.assertIn('http:', srcs[1]) + self.assertIn('cid:', srcs[2]) + cid = srcs[2][3:] + self.assertEquals(email2.attachment_ids.name, encode_header_param(cid)) From 7be0398c2e06a3a2e3866198f3cd3586e0c28501 Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Fri, 28 Jun 2019 11:00:31 +0200 Subject: [PATCH 6/7] fixup! fixup! fixup! fixup! fixup! [ADD] mail_embed_image module --- mail_embed_image/models/ir_mail_server.py | 2 +- .../tests/test_mail_embed_image.py | 28 +++++++++++-------- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py index dc44cdab..7f95adf0 100644 --- a/mail_embed_image/models/ir_mail_server.py +++ b/mail_embed_image/models/ir_mail_server.py @@ -1,8 +1,8 @@ # -*- coding: utf-8 -*- # Copyright 2019 Therp BV # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). -import requests import uuid +import requests from odoo import models from odoo.addons.base.ir.ir_mail_server import encode_header_param from lxml.html.soupparser import fromstring diff --git a/mail_embed_image/tests/test_mail_embed_image.py b/mail_embed_image/tests/test_mail_embed_image.py index 810fd69a..002ee211 100644 --- a/mail_embed_image/tests/test_mail_embed_image.py +++ b/mail_embed_image/tests/test_mail_embed_image.py @@ -2,6 +2,7 @@ # Copyright 2019 Therp BV # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). from odoo.tests.common import TransactionCase +from mock import patch from requests import get from base64 import b64encode from lxml.html.soupparser import fromstring @@ -13,7 +14,11 @@ class TestMailEmbedImage(TransactionCase): post_install = True at_install = False - def test_mail_embed_image(self): + @patch( + 'odoo.fields.html_sanitize', + side_effect=lambda *args, **kwargs: args[0], + ) + def test_mail_embed_image(self, html_sanitize): """ The following are tested here: 1) Create an email with no image, send it. 2) Create an email with three images, one base64 content, one http @@ -27,12 +32,13 @@ class TestMailEmbedImage(TransactionCase): image_url = base_url + '/mail_embed_image/static/description/icon.png' image = get(image_url).content body1 = '
this is an email
' - email1 = model_mail_mail.create({'body': body1}) + email1 = model_mail_mail.create({ + 'body_html': body1, + 'body': body1, + 'email_to': 'test@example.com', + }) email1.send() - message_body = self.env.cr.execute( - "SELECT body FROM mail_message WHERE message_id = %s LIMIT 1", - (email1.message_id, )) - self.assertEquals(message_body, body1) + self.assertEquals(email1.body_html, body1) body2 = """
this is an email @@ -44,12 +50,12 @@ class TestMailEmbedImage(TransactionCase): image_url, '/web/image/res.partner/1/image', ) - email2 = model_mail_mail.create({'body': body2}) + email2 = model_mail_mail.create({ + 'body_html': body2, + 'email_to': 'test@example.com', + }) email2.send() - message_body = self.env.cr.execute( - "SELECT body FROM mail_message WHERE message_id = %s LIMIT 1", - (email1.message_id, )) - body2final = fromstring(message_body) + body2final = fromstring(email2.body_html) self.assertEquals(len(body2final.xpath('//img')), 3) srcs = [x.get('src') for x in body2final.xpath('//img')] self.assertIn('base64:', srcs[0]) From 692b5339dfe1ca2f72144af985b6fce25963e53b Mon Sep 17 00:00:00 2001 From: George Daramouskas Date: Mon, 1 Jul 2019 11:12:40 +0200 Subject: [PATCH 7/7] fixup! fixup! fixup! fixup! fixup! fixup! [ADD] mail_embed_image module --- mail_embed_image/models/ir_mail_server.py | 118 ++++++++++++------ .../tests/test_mail_embed_image.py | 5 +- 2 files changed, 82 insertions(+), 41 deletions(-) diff --git a/mail_embed_image/models/ir_mail_server.py b/mail_embed_image/models/ir_mail_server.py index 7f95adf0..5cf98a3f 100644 --- a/mail_embed_image/models/ir_mail_server.py +++ b/mail_embed_image/models/ir_mail_server.py @@ -2,12 +2,15 @@ # Copyright 2019 Therp BV # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). import uuid -import requests +from werkzeug.routing import Rule, Map from odoo import models +from odoo.tools.image import image_resize_image +from odoo.addons.web.controllers.main import Binary +from odoo.modules import get_resource_path from odoo.addons.base.ir.ir_mail_server import encode_header_param from lxml.html.soupparser import fromstring from lxml.etree import tostring -from base64 import b64encode +from base64 import b64encode, b64decode from email.mime.image import MIMEImage from email import Encoders @@ -33,10 +36,10 @@ class IrMailServer(models.Model): body_alternative=None, subtype_alternative='plain'): result = super(IrMailServer, self).build_email( - email_from, - email_to, - subject, - body, + email_from=email_from, + email_to=email_to, + subject=subject, + body=body, email_cc=email_cc, email_bcc=email_bcc, reply_to=reply_to, @@ -49,40 +52,75 @@ class IrMailServer(models.Model): body_alternative=body_alternative, subtype_alternative=subtype_alternative, ) + return self._build_email_replace_img_src(result, result) + + def _build_email_replace_img_src(self, email, email_part): + """ Given a message, find it's img tags and if they + are URLs, replace them with cids. - def _build_email_replace_img_src(msg, attachments): - """ Given a message, find it's img tags and if they - are URLs, replace them with cids. + :param email: The root email.message.Message, used for reference + :param email_part: The current part of email being examined + """ + if email_part.is_multipart(): + for part in email_part.get_payload(): + self._build_email_replace_img_src(email, part) + else: + if email_part.get_content_subtype() == 'html': + body = email_part.get_payload(decode=True) + root = fromstring(body) + for img in root.xpath( + "//img[starts-with(@src, '/web/image')]"): + base_url = self.env['ir.config_parameter'].get_param( + 'web.base.url') + response = self._get_image(base_url, img.get('src')) + cid = uuid.uuid4().hex + filename_rfc2047 = encode_header_param(cid) + part = MIMEImage(response) + part.set_param('name', filename_rfc2047) + part.add_header( + 'Content-Disposition', + 'inline', + cid=cid, + filename=filename_rfc2047, + ) + part.set_payload(response) + Encoders.encode_base64(part) + # attach the image into the email as attachment + email.attach(part) + img.set('src', 'cid:%s' % (cid)) + email_part.set_payload(b64encode(tostring(root))) + return email - :param msg: A email.message.Message - """ - if msg.is_multipart(): - for part in msg.get_payload(): - _build_email_replace_img_src(part, attachments) + def _get_image(self, base_url, src): + """ This function emulates the operations of + odoo.addons.web.controllers.main.Binary.content_image() because + we cannot call this from here + Given an absolute url, return the raw image data. + """ + routes = Binary.content_image.routing['routes'] + map_rules = Map([Rule(x) for x in routes]) + urls = map_rules.bind(base_url) + endpoint, kwargs = urls.match(src) + status, headers, content = self.env['ir.http'].binary_content( + env=self.env, **kwargs) + height = int(kwargs.get('height', 0)) + width = int(kwargs.get('width', 0)) + if content and (height or width): + if height > 500: + height = 500 + if width > 500: + width = 500 + content = image_resize_image( + content, + (width or None, height or None), + filetype='PNG', + ) + if content: + content = b64decode(content) else: - if msg.get_content_subtype() == 'html': - body = msg.get_payload(decode=True) - root = fromstring(body) - for img in root.xpath( - "//img[starts-with(@src, '/web/image')]"): - base_url = self.env['ir.config_parameter'].get_param( - 'web.base.url') - src = base_url + img.get('src') - response = requests.get(src) - cid = uuid.uuid4().hex - filename_rfc2047 = encode_header_param(cid) - part = MIMEImage(response.content) - part.set_param('name', filename_rfc2047) - part.add_header( - 'Content-Disposition', - 'inline', - cid=cid, - filename=filename_rfc2047, - ) - part.set_payload(response.content) - Encoders.encode_base64(part) - result.attach(part) - img.set('src', 'cid:%s' % (cid)) - msg.set_payload(b64encode(tostring(root))) - _build_email_replace_img_src(result, attachments) - return result + path_placeholder = '/web/static/src/img/placeholder.png' + with open(get_resource_path(path_placeholder)) as f: + content = f.read() + else: + content = b64decode(content) + return content diff --git a/mail_embed_image/tests/test_mail_embed_image.py b/mail_embed_image/tests/test_mail_embed_image.py index 002ee211..81f3edac 100644 --- a/mail_embed_image/tests/test_mail_embed_image.py +++ b/mail_embed_image/tests/test_mail_embed_image.py @@ -34,7 +34,7 @@ class TestMailEmbedImage(TransactionCase): body1 = '
this is an email
' email1 = model_mail_mail.create({ 'body_html': body1, - 'body': body1, + 'email_from': 'test@example.com', 'email_to': 'test@example.com', }) email1.send() @@ -52,9 +52,12 @@ class TestMailEmbedImage(TransactionCase): ) email2 = model_mail_mail.create({ 'body_html': body2, + 'email_from': 'test@example.com', 'email_to': 'test@example.com', }) email2.send() + # TODO the below will not work, assert build_email called and return + # value (remove the tests above as well, they are foolish) body2final = fromstring(email2.body_html) self.assertEquals(len(body2final.xpath('//img')), 3) srcs = [x.get('src') for x in body2final.xpath('//img')]