From 8a9ab8b8e08e690461c2a60d1b05c08785fcf58a Mon Sep 17 00:00:00 2001 From: Holger Brunn Date: Fri, 17 Jan 2025 16:45:05 +0100 Subject: [PATCH] [ADD] sms_masked_content --- setup/.setuptools-odoo-make-default-ignore | 2 + setup/README | 2 + .../odoo/addons/sms_masked_content | 1 + setup/sms_masked_content/setup.py | 6 + sms_masked_content/README.rst | 106 +++++ sms_masked_content/__init__.py | 1 + sms_masked_content/__manifest__.py | 21 + sms_masked_content/demo/sms_template.xml | 12 + sms_masked_content/models/__init__.py | 3 + sms_masked_content/models/sms_api.py | 29 ++ sms_masked_content/models/sms_sms.py | 35 ++ sms_masked_content/models/sms_template.py | 72 +++ sms_masked_content/readme/CONTRIBUTORS.md | 1 + sms_masked_content/readme/DESCRIPTION.md | 3 + sms_masked_content/readme/USAGE.md | 5 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 445 ++++++++++++++++++ sms_masked_content/tests/__init__.py | 1 + .../tests/test_sms_masked_content.py | 133 ++++++ 19 files changed, 878 insertions(+) create mode 100644 setup/.setuptools-odoo-make-default-ignore create mode 100644 setup/README create mode 120000 setup/sms_masked_content/odoo/addons/sms_masked_content create mode 100644 setup/sms_masked_content/setup.py create mode 100644 sms_masked_content/README.rst create mode 100644 sms_masked_content/__init__.py create mode 100644 sms_masked_content/__manifest__.py create mode 100644 sms_masked_content/demo/sms_template.xml create mode 100644 sms_masked_content/models/__init__.py create mode 100644 sms_masked_content/models/sms_api.py create mode 100644 sms_masked_content/models/sms_sms.py create mode 100644 sms_masked_content/models/sms_template.py create mode 100644 sms_masked_content/readme/CONTRIBUTORS.md create mode 100644 sms_masked_content/readme/DESCRIPTION.md create mode 100644 sms_masked_content/readme/USAGE.md create mode 100644 sms_masked_content/static/description/icon.png create mode 100644 sms_masked_content/static/description/index.html create mode 100644 sms_masked_content/tests/__init__.py create mode 100644 sms_masked_content/tests/test_sms_masked_content.py diff --git a/setup/.setuptools-odoo-make-default-ignore b/setup/.setuptools-odoo-make-default-ignore new file mode 100644 index 00000000..207e6153 --- /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 00000000..a63d633e --- /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/sms_masked_content/odoo/addons/sms_masked_content b/setup/sms_masked_content/odoo/addons/sms_masked_content new file mode 120000 index 00000000..73b50170 --- /dev/null +++ b/setup/sms_masked_content/odoo/addons/sms_masked_content @@ -0,0 +1 @@ +../../../../sms_masked_content \ No newline at end of file diff --git a/setup/sms_masked_content/setup.py b/setup/sms_masked_content/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/sms_masked_content/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/sms_masked_content/README.rst b/sms_masked_content/README.rst new file mode 100644 index 00000000..1b7749c7 --- /dev/null +++ b/sms_masked_content/README.rst @@ -0,0 +1,106 @@ +===================== +Masked content in SMS +===================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:b17dc73de8dc59b512f6e94ddeb2e31b8a0a8c6cd7774642805fd695f6f11405 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |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%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/16.0/sms_masked_content + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-sms_masked_content + :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/web&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows users to mark some SMS content in template as to be +masked, meaning after actually sending an SMS, this content will be +replaced by XXX. + +This is useful when ie sending codes which are long lived enough to give +bad incentives for users having access to the messages. + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To use this module, you need to: + +1. Go to ... +2. When writing a template, use ``mask_content($your expression)`` +3. If you want something else than the default ``XXX`` as replacement, + say ``mask_content($your_expression, 'your replacement')`` + +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 +------- + +* Hunki Enterprises BV +* Therp BV + +Contributors +------------ + +- Holger Brunn + (https://hunki-enterprises.com) + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-hbrunn| image:: https://github.com/hbrunn.png?size=40px + :target: https://github.com/hbrunn + :alt: hbrunn + +Current `maintainer `__: + +|maintainer-hbrunn| + +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/sms_masked_content/__init__.py b/sms_masked_content/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/sms_masked_content/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/sms_masked_content/__manifest__.py b/sms_masked_content/__manifest__.py new file mode 100644 index 00000000..a07b8585 --- /dev/null +++ b/sms_masked_content/__manifest__.py @@ -0,0 +1,21 @@ +# Copyright 2024 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +{ + "name": "Masked content in SMS", + "summary": "Allows to mask some part of SMS content after sending", + "version": "16.0.1.0.0", + "development_status": "Alpha", + "category": "Tools", + "website": "https://github.com/OCA/web", + "author": "Hunki Enterprises BV, Odoo Community Association (OCA), Therp BV", + "maintainers": ["hbrunn"], + "license": "AGPL-3", + "depends": [ + "sms", + ], + "data": [], + "demo": [ + "demo/sms_template.xml", + ], +} diff --git a/sms_masked_content/demo/sms_template.xml b/sms_masked_content/demo/sms_template.xml new file mode 100644 index 00000000..661b9545 --- /dev/null +++ b/sms_masked_content/demo/sms_template.xml @@ -0,0 +1,12 @@ + + + + + Template sending masked content + + This is your name, but masked in the chatter: {{mask_content(object.name)}} + + diff --git a/sms_masked_content/models/__init__.py b/sms_masked_content/models/__init__.py new file mode 100644 index 00000000..1456f825 --- /dev/null +++ b/sms_masked_content/models/__init__.py @@ -0,0 +1,3 @@ +from . import sms_api +from . import sms_sms +from . import sms_template diff --git a/sms_masked_content/models/sms_api.py b/sms_masked_content/models/sms_api.py new file mode 100644 index 00000000..87dc3241 --- /dev/null +++ b/sms_masked_content/models/sms_api.py @@ -0,0 +1,29 @@ +# Copyright 2024 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +from odoo import api, models + + +class SmsApi(models.AbstractModel): + _inherit = "sms.api" + + @api.model + def _send_sms_batch(self, messages): + """ + If message body is a masked string, pass the unmasked content to super + Otherwise, read the sms' unmasked_body field and pass that if set + """ + SmsSms = self.env["sms.sms"] + messages = [ + dict( + message, + content=getattr( + message.get("content"), + "unmasked_content", + SmsSms.browse(message.get("res_id") or []).unmasked_body + or message.get("content"), + ), + ) + for message in messages + ] + return super()._send_sms_batch(messages) diff --git a/sms_masked_content/models/sms_sms.py b/sms_masked_content/models/sms_sms.py new file mode 100644 index 00000000..74dac91f --- /dev/null +++ b/sms_masked_content/models/sms_sms.py @@ -0,0 +1,35 @@ +# Copyright 2024 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +from odoo import api, fields, models + + +class SmsSms(models.Model): + _inherit = "sms.sms" + + unmasked_body = fields.Text( + help="Field that temporarily holds body as it is to be sent" + ) + + @api.model_create_multi + def create(self, vals_list): + """ + Write unmasked_body if we get one passed + """ + return super().create( + dict( + vals, + unmasked_body=vals.get( + "unmasked_body", getattr(vals.get("body"), "unmasked_content", None) + ), + ) + for vals in vals_list + ) + + def write(self, vals): + """ + When sms is marked as sent or cancelled, remove its unmasked body + """ + if vals.get("state") in ("sent", "canceled"): + vals["unmasked_body"] = False + return super().write(vals) diff --git a/sms_masked_content/models/sms_template.py b/sms_masked_content/models/sms_template.py new file mode 100644 index 00000000..134bb81f --- /dev/null +++ b/sms_masked_content/models/sms_template.py @@ -0,0 +1,72 @@ +# Copyright 2024 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +from odoo import api, models + +mask_sentinel = object() + + +class MaskedString(str): + unmasked_content = "" + + def __new__(cls, masked_content, unmasked_content): + result = super().__new__(cls, masked_content) + result.unmasked_content = unmasked_content + return result + + +class SmsTemplate(models.Model): + _inherit = "sms.template" + + @api.model + def _render_template( + self, + template_src, + model, + res_ids, + engine="inline_template", + add_context=None, + options=None, + post_process=False, + ): + """ + Add masking function to context, attach unmasked version to result if masking was used + """ + masking_used = False + + def mask_content(content, replacement="XXX"): + nonlocal masking_used + if self.env.context.get("sms_masked_content_unmask") == mask_sentinel: + return content + else: + masking_used = True + return replacement + + result = super()._render_template( + template_src, + model, + res_ids, + engine=engine, + add_context=dict(add_context or {}, mask_content=mask_content), + options=options, + post_process=post_process, + ) + + if not masking_used: + return result + else: + unmasked_result = self.with_context( + sms_masked_content_unmask=mask_sentinel + )._render_template( + template_src, + model, + res_ids, + engine=engine, + add_context=dict(add_context or {}, mask_content=mask_content), + options=options, + post_process=post_process, + ) + return { + res_id: MaskedString(result[res_id], unmasked_result[res_id]) + for res_id in result + } diff --git a/sms_masked_content/readme/CONTRIBUTORS.md b/sms_masked_content/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..b28199e1 --- /dev/null +++ b/sms_masked_content/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Holger Brunn \ (https://hunki-enterprises.com) diff --git a/sms_masked_content/readme/DESCRIPTION.md b/sms_masked_content/readme/DESCRIPTION.md new file mode 100644 index 00000000..e588d40e --- /dev/null +++ b/sms_masked_content/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module allows users to mark some SMS content in template as to be masked, meaning after actually sending an SMS, this content will be replaced by XXX. + +This is useful when ie sending codes which are long lived enough to give bad incentives for users having access to the messages. diff --git a/sms_masked_content/readme/USAGE.md b/sms_masked_content/readme/USAGE.md new file mode 100644 index 00000000..60f6b640 --- /dev/null +++ b/sms_masked_content/readme/USAGE.md @@ -0,0 +1,5 @@ +To use this module, you need to: + +1. Go to ... +2. When writing a template, use ``mask_content($your expression)`` +3. If you want something else than the default ``XXX`` as replacement, say ``mask_content($your_expression, 'your replacement')`` diff --git a/sms_masked_content/static/description/icon.png b/sms_masked_content/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/sms_masked_content/static/description/index.html b/sms_masked_content/static/description/index.html new file mode 100644 index 00000000..cbe58058 --- /dev/null +++ b/sms_masked_content/static/description/index.html @@ -0,0 +1,445 @@ + + + + + +Masked content in SMS + + + +
+

Masked content in SMS

+ + +

Alpha License: AGPL-3 OCA/web Translate me on Weblate Try me on Runboat

+

This module allows users to mark some SMS content in template as to be +masked, meaning after actually sending an SMS, this content will be +replaced by XXX.

+

This is useful when ie sending codes which are long lived enough to give +bad incentives for users having access to the messages.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to …
    2. +
  2. When writing a template, use mask_content($your expression)
    3. +
  3. If you want something else than the default XXX as replacement, +say mask_content($your_expression, 'your replacement')
    4. +
+
+
+

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

+
    +
  • Hunki Enterprises BV
    • +
  • Therp BV
    • +
+
+ +
+

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.

+

Current maintainer:

+

hbrunn

+

This module is part of the OCA/web project on GitHub.

+

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

+
+
+
+ + diff --git a/sms_masked_content/tests/__init__.py b/sms_masked_content/tests/__init__.py new file mode 100644 index 00000000..8d931b82 --- /dev/null +++ b/sms_masked_content/tests/__init__.py @@ -0,0 +1 @@ +from . import test_sms_masked_content diff --git a/sms_masked_content/tests/test_sms_masked_content.py b/sms_masked_content/tests/test_sms_masked_content.py new file mode 100644 index 00000000..09ebc7c9 --- /dev/null +++ b/sms_masked_content/tests/test_sms_masked_content.py @@ -0,0 +1,133 @@ +# Copyright 2024 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +from unittest import mock + +from odoo.tests.common import TransactionCase + + +def _contact_iap_success(local_endpoint, params): + return [dict(message, state="success") for message in params["messages"]] + + +def _contact_iap_failure(local_endpoint, params): + return [dict(message, state="server_error") for message in params["messages"]] + + +class TestSmsMaskedContent(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.template = cls.env.ref("sms_masked_content.template_demo") + cls.partner = cls.env.ref("base.user_demo").partner_id + + def test_masking_message_post(self): + """Test that masked content is hidden""" + last_sms = self.env["sms.sms"].search([], order="id desc", limit=1) + last_message = self.env["mail.message"].search([], order="id desc", limit=1) + + # successful sending should remove the sms, only leave masked content + with mock.patch.object( + self.env["sms.api"].__class__, "_contact_iap" + ) as contact_iap: + contact_iap.side_effect = _contact_iap_success + self.partner._message_sms_with_template(self.template) + + self.assertIn( + self.partner.name, contact_iap.call_args.args[1]["messages"][0]["content"] + ) + + new_sms = self.env["sms.sms"].search([("id", ">", last_sms.id or 0)]) + new_message = self.env["mail.message"].search( + [("id", ">", last_message.id or 0)] + ) + self.assertFalse(new_sms) + self.assertIn("XXX", new_message.body) + self.assertNotIn(self.partner.name, new_message.body) + + last_message = new_message + + # failed sending should keep unmasked content in sms.sms#unmasked_body + with mock.patch.object( + self.env["sms.api"].__class__, "_contact_iap" + ) as contact_iap: + contact_iap.side_effect = _contact_iap_failure + self.partner._message_sms_with_template(self.template) + + self.assertIn( + self.partner.name, contact_iap.call_args.args[1]["messages"][0]["content"] + ) + + new_sms = self.env["sms.sms"].search([("id", ">", last_sms.id or 0)]) + new_message = self.env["mail.message"].search( + [("id", ">", last_message.id or 0)] + ) + self.assertEqual(new_sms.state, "error") + self.assertNotIn(self.partner.name, new_sms.body) + self.assertIn(self.partner.name, new_sms.unmasked_body) + self.assertNotIn(self.partner.name, new_message.body) + + with mock.patch.object( + self.env["sms.api"].__class__, "_contact_iap" + ) as contact_iap: + contact_iap.side_effect = _contact_iap_success + new_sms._send(unlink_sent=False) + + self.assertIn( + self.partner.name, contact_iap.call_args.args[1]["messages"][0]["content"] + ) + + new_message = self.env["mail.message"].search( + [("id", ">", last_message.id or 0)] + ) + self.assertEqual(new_sms.state, "sent") + self.assertNotIn(self.partner.name, new_sms.body) + self.assertFalse(new_sms.unmasked_body) + self.assertNotIn(self.partner.name, new_message.body) + + def test_masking_composer(self): + """ + Test that masking works for code using the composer + """ + composer = self.env["sms.composer"].create( + { + "composition_mode": "mass", + "res_model": self.partner._name, + "res_id": self.partner.id, + "res_ids": str(self.partner.id), + "template_id": self.template.id, + "mass_force_send": True, + } + ) + + with mock.patch.object( + self.env["sms.api"].__class__, "_contact_iap" + ) as contact_iap: + contact_iap.side_effect = _contact_iap_success + composer.action_send_sms() + + self.assertIn( + self.partner.name, contact_iap.call_args.args[1]["messages"][0]["content"] + ) + + last_sms = self.env["sms.sms"].search([], order="id desc", limit=1) + last_message = self.env["mail.message"].search([], order="id desc", limit=1) + + with mock.patch.object( + self.env["sms.api"].__class__, "_contact_iap" + ) as contact_iap: + contact_iap.side_effect = _contact_iap_failure + composer.action_send_sms() + + self.assertIn( + self.partner.name, contact_iap.call_args.args[1]["messages"][0]["content"] + ) + + new_sms = self.env["sms.sms"].search([("id", ">", last_sms.id or 0)]) + new_message = self.env["mail.message"].search( + [("id", ">", last_message.id or 0)] + ) + self.assertEqual(new_sms.state, "error") + self.assertNotIn(self.partner.name, new_sms.body) + self.assertIn(self.partner.name, new_sms.unmasked_body) + self.assertNotIn(self.partner.name, new_message.body)