diff --git a/mail_restrict_follower_selection/README.rst b/mail_restrict_follower_selection/README.rst new file mode 100644 index 0000000000..25cdb40087 --- /dev/null +++ b/mail_restrict_follower_selection/README.rst @@ -0,0 +1,105 @@ +=========================== +Restrict follower selection +=========================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:5afe605fd4213b36044bc3ff7b459c564bbb92a3bbad79765ad83bd596d687ff + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github + :target: https://github.com/OCA/social/tree/18.0/mail_restrict_follower_selection + :alt: OCA/social +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/social-18-0/social-18-0-mail_restrict_follower_selection + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/social&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module was written to allow you to restrict the selection of +possible followers. For example, if you use the social ERP functions +only internally, it makes sense to filter possible followers for being +employees. Otherwise, you'll get a quite crowded list of partners to +choose from. + +Moreover, the module disables the option to automatically add followers +that do not meet the domain. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure this module, you need to go to System parameters and adjust +mail_restrict_follower_selection.domain as you see fit. This restricts +followers globally, if you want to restrict only the followers for a +certain record type (or have different restrictions for different record +types), create a parameter +mail_restrict_follower_selection.domain.$your_model. + +As an example, you could use [('category_id.name', '=', 'Employees')] to +allow only contacts with 'Employees' tag to be added as follower - this +also is the default. + +Note: This module won't change existing followers! + +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 +------- + +* Therp BV +* Creu Blanca + +Contributors +------------ + +- Holger Brunn +- Nguyen Tan Phuc +- Enric Tobella +- `Quartile `__: + + - Aung Ko Ko Lin + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/social `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mail_restrict_follower_selection/__init__.py b/mail_restrict_follower_selection/__init__.py new file mode 100644 index 0000000000..52c9640c7f --- /dev/null +++ b/mail_restrict_follower_selection/__init__.py @@ -0,0 +1,6 @@ +# Copyright (C) 2015 Therp BV +# Copyright (C) 2017 Komit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import models +from . import utils diff --git a/mail_restrict_follower_selection/__manifest__.py b/mail_restrict_follower_selection/__manifest__.py new file mode 100644 index 0000000000..7d58876693 --- /dev/null +++ b/mail_restrict_follower_selection/__manifest__.py @@ -0,0 +1,17 @@ +# Copyright (C) 2015 Therp BV +# Copyright (C) 2017 Komit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Restrict follower selection", + "version": "18.0.1.0.0", + "author": "Therp BV,Creu Blanca,Odoo Community Association (OCA)", + "license": "AGPL-3", + "category": "Social Network", + "website": "https://github.com/OCA/social", + "summary": "Define a domain from which followers can be selected", + "depends": ["mail"], + "data": ["data/ir_config_parameter.xml", "data/ir_actions.xml"], + "demo": ["demo/ir_config_parameter_demo.xml"], + "installable": True, +} diff --git a/mail_restrict_follower_selection/data/ir_actions.xml b/mail_restrict_follower_selection/data/ir_actions.xml new file mode 100644 index 0000000000..59478e10b6 --- /dev/null +++ b/mail_restrict_follower_selection/data/ir_actions.xml @@ -0,0 +1,13 @@ + + + + Configure the restriction on followers + ir.config_parameter + + form + + + Configure the restriction on followers + + + diff --git a/mail_restrict_follower_selection/data/ir_config_parameter.xml b/mail_restrict_follower_selection/data/ir_config_parameter.xml new file mode 100644 index 0000000000..b44c26557e --- /dev/null +++ b/mail_restrict_follower_selection/data/ir_config_parameter.xml @@ -0,0 +1,7 @@ + + + + mail_restrict_follower_selection.domain + [('category_id.name', '=', 'Employees')] + + diff --git a/mail_restrict_follower_selection/demo/ir_config_parameter_demo.xml b/mail_restrict_follower_selection/demo/ir_config_parameter_demo.xml new file mode 100644 index 0000000000..cb534bb72b --- /dev/null +++ b/mail_restrict_follower_selection/demo/ir_config_parameter_demo.xml @@ -0,0 +1,7 @@ + + + + mail_restrict_follower_selection.domain.res.partner + [(1, '=', 1)] + + diff --git a/mail_restrict_follower_selection/i18n/de.po b/mail_restrict_follower_selection/i18n/de.po new file mode 100644 index 0000000000..eff22263ff --- /dev/null +++ b/mail_restrict_follower_selection/i18n/de.po @@ -0,0 +1,37 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_restrict_follower_selection +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 11.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2018-12-15 14:58+0000\n" +"Last-Translator: Maria Sparenberg \n" +"Language-Team: none\n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 3.3\n" + +#. module: mail_restrict_follower_selection +#: model:ir.actions.act_window,name:mail_restrict_follower_selection.action_setup +msgid "Configure the restriction on followers" +msgstr "Beschränkung der Abonnenten konfigurieren" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_followers +msgid "Document Followers" +msgstr "Abonnenten des Dokuments" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_wizard_invite +msgid "Invite wizard" +msgstr "Assistent zum Einladen von Abonnenten" diff --git a/mail_restrict_follower_selection/i18n/fr.po b/mail_restrict_follower_selection/i18n/fr.po new file mode 100644 index 0000000000..7f96c92b0f --- /dev/null +++ b/mail_restrict_follower_selection/i18n/fr.po @@ -0,0 +1,40 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_restrict_follower_selection +# +# Translators: +# Quentin THEURET , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-07-22 09:45+0000\n" +"PO-Revision-Date: 2018-06-18 09:40+0000\n" +"Last-Translator: c2cdidier \n" +"Language-Team: French (https://www.transifex.com/oca/teams/23907/fr/)\n" +"Language: fr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" +"X-Generator: Weblate 3.0.1\n" + +#. module: mail_restrict_follower_selection +#: model:ir.actions.act_window,name:mail_restrict_follower_selection.action_setup +msgid "Configure the restriction on followers" +msgstr "Configurer les restrictions sur les abonnés" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_followers +msgid "Document Followers" +msgstr "Suiveurs du document" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_wizard_invite +msgid "Invite wizard" +msgstr "Assistant d'invitation" diff --git a/mail_restrict_follower_selection/i18n/hr.po b/mail_restrict_follower_selection/i18n/hr.po new file mode 100644 index 0000000000..38a74e130e --- /dev/null +++ b/mail_restrict_follower_selection/i18n/hr.po @@ -0,0 +1,40 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_restrict_follower_selection +# +# Translators: +# Bole , 2016 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2016-11-29 14:24+0000\n" +"PO-Revision-Date: 2016-11-29 14:24+0000\n" +"Last-Translator: Bole , 2016\n" +"Language-Team: Croatian (https://www.transifex.com/oca/teams/23907/hr/)\n" +"Language: hr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n" +"%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n" + +#. module: mail_restrict_follower_selection +#: model:ir.actions.act_window,name:mail_restrict_follower_selection.action_setup +msgid "Configure the restriction on followers" +msgstr "Postavi ograničenja na pratitelje" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_followers +msgid "Document Followers" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_wizard_invite +msgid "Invite wizard" +msgstr "Čarobnjak za pozivnce" diff --git a/mail_restrict_follower_selection/i18n/it.po b/mail_restrict_follower_selection/i18n/it.po new file mode 100644 index 0000000000..64dc2f8dd2 --- /dev/null +++ b/mail_restrict_follower_selection/i18n/it.po @@ -0,0 +1,49 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_restrict_follower_selection +# +# Translators: +# Marius Marolla , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-05-17 01:02+0000\n" +"PO-Revision-Date: 2024-02-26 16:34+0000\n" +"Last-Translator: mymage \n" +"Language-Team: Italian (https://www.transifex.com/oca/teams/23907/it/)\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: mail_restrict_follower_selection +#: model:ir.actions.act_window,name:mail_restrict_follower_selection.action_setup +msgid "Configure the restriction on followers" +msgstr "Imposta restrizioni sui follower" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_followers +msgid "Document Followers" +msgstr "Follower Documento" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_thread +msgid "Email Thread" +msgstr "Discussione e-mail" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_wizard_invite +msgid "Invite wizard" +msgstr "Wizard Creazione Invito" + +#~ msgid "Display Name" +#~ msgstr "Nome da visualizzare" + +#~ msgid "ID" +#~ msgstr "ID" + +#~ msgid "Last Modified on" +#~ msgstr "Ultima modifica il" diff --git a/mail_restrict_follower_selection/i18n/mail_restrict_follower_selection.pot b/mail_restrict_follower_selection/i18n/mail_restrict_follower_selection.pot new file mode 100644 index 0000000000..32acee97c1 --- /dev/null +++ b/mail_restrict_follower_selection/i18n/mail_restrict_follower_selection.pot @@ -0,0 +1,34 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_restrict_follower_selection +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: mail_restrict_follower_selection +#: model:ir.actions.act_window,name:mail_restrict_follower_selection.action_setup +msgid "Configure the restriction on followers" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_followers +msgid "Document Followers" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_wizard_invite +msgid "Invite wizard" +msgstr "" diff --git a/mail_restrict_follower_selection/i18n/sl.po b/mail_restrict_follower_selection/i18n/sl.po new file mode 100644 index 0000000000..b350b02642 --- /dev/null +++ b/mail_restrict_follower_selection/i18n/sl.po @@ -0,0 +1,41 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_restrict_follower_selection +# +# Translators: +# Matjaž Mozetič , 2015 +msgid "" +msgstr "" +"Project-Id-Version: social (8.0)\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-09-30 16:56+0000\n" +"PO-Revision-Date: 2015-10-01 13:00+0000\n" +"Last-Translator: Matjaž Mozetič \n" +"Language-Team: Slovenian (http://www.transifex.com/oca/OCA-social-8-0/" +"language/sl/)\n" +"Language: sl\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n" +"%100==4 ? 2 : 3);\n" + +#. module: mail_restrict_follower_selection +#: model:ir.actions.act_window,name:mail_restrict_follower_selection.action_setup +msgid "Configure the restriction on followers" +msgstr "Nastavitev omejitev za sledilce" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_followers +msgid "Document Followers" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_restrict_follower_selection +#: model:ir.model,name:mail_restrict_follower_selection.model_mail_wizard_invite +msgid "Invite wizard" +msgstr "Čarovnik za vabila" diff --git a/mail_restrict_follower_selection/models/__init__.py b/mail_restrict_follower_selection/models/__init__.py new file mode 100644 index 0000000000..d6a528cb70 --- /dev/null +++ b/mail_restrict_follower_selection/models/__init__.py @@ -0,0 +1,7 @@ +# Copyright (C) 2015 Therp BV +# Copyright (C) 2017 Komit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import mail_followers +from . import mail_wizard_invite +from . import mail_thread diff --git a/mail_restrict_follower_selection/models/mail_followers.py b/mail_restrict_follower_selection/models/mail_followers.py new file mode 100644 index 0000000000..9b942bb667 --- /dev/null +++ b/mail_restrict_follower_selection/models/mail_followers.py @@ -0,0 +1,59 @@ +# Copyright (C) 2018 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import models +from odoo.tools import config +from odoo.tools.safe_eval import safe_eval + +from ..utils import _id_get + + +class MailFollowers(models.Model): + _inherit = "mail.followers" + + def _add_followers( + self, + res_model, + res_ids, + partner_ids, + subtypes, + check_existing=False, + existing_policy="skip", + ): + test_condition = config["test_enable"] and not self.env.context.get( + "test_restrict_follower" + ) + if test_condition or self.env.context.get("no_restrict_follower"): + return super()._add_followers( + res_model, + res_ids, + partner_ids, + subtypes, + check_existing=check_existing, + existing_policy=existing_policy, + ) + domain = str( + self.env["mail.wizard.invite"]._mail_restrict_follower_selection_get_domain( + res_model=res_model + ) + ) + partners = self.env["res.partner"].search( + [("id", "in", partner_ids)] + + safe_eval( + domain, locals_dict={"ref": lambda str_id: _id_get(self.env, str_id)} + ) + ) + _res_ids = res_ids.copy() or [0] + new, update = super()._add_followers( + res_model, + res_ids, + partners.ids, + subtypes, + check_existing=check_existing, + existing_policy=existing_policy, + ) + + for res_id in _res_ids: + if res_id not in new: + new.setdefault(res_id, list()) + return new, update diff --git a/mail_restrict_follower_selection/models/mail_thread.py b/mail_restrict_follower_selection/models/mail_thread.py new file mode 100644 index 0000000000..56af245273 --- /dev/null +++ b/mail_restrict_follower_selection/models/mail_thread.py @@ -0,0 +1,40 @@ +from odoo import models +from odoo.tools import config +from odoo.tools.safe_eval import safe_eval + +from ..utils import _id_get + + +class MailThread(models.AbstractModel): + _inherit = "mail.thread" + + def _message_add_suggested_recipient( + self, result, partner=None, email=None, lang=None, reason="" + ): + result = super()._message_add_suggested_recipient( + result, partner=partner, email=email, lang=lang, reason=reason + ) + test_condition = config["test_enable"] and not self.env.context.get( + "test_restrict_follower" + ) + if test_condition or self.env.context.get("no_restrict_follower"): + return result + domain = self.env[ + "mail.wizard.invite" + ]._mail_restrict_follower_selection_get_domain() + eval_domain = safe_eval( + str(domain), locals_dict={"ref": lambda str_id: _id_get(self.env, str_id)} + ) + items_to_remove = [] + for item in result: + partner_id = item.get("partner_id", False) + if partner_id: + partner_count = self.env["res.partner"].search_count( + [("id", "=", partner_id)] + eval_domain + ) + if not partner_count: + items_to_remove.append(item) + for item in items_to_remove: + result.remove(item) + + return result diff --git a/mail_restrict_follower_selection/models/mail_wizard_invite.py b/mail_restrict_follower_selection/models/mail_wizard_invite.py new file mode 100644 index 0000000000..24cadd3e16 --- /dev/null +++ b/mail_restrict_follower_selection/models/mail_wizard_invite.py @@ -0,0 +1,49 @@ +# Copyright (C) 2015 Therp BV +# Copyright (C) 2017 Komit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + + +from lxml import etree + +from odoo import api, models +from odoo.osv import expression +from odoo.tools.safe_eval import safe_eval + +from ..utils import _id_get + + +class MailWizardInvite(models.TransientModel): + _inherit = "mail.wizard.invite" + + @api.model + def _mail_restrict_follower_selection_get_domain(self, res_model=None): + if not res_model: + res_model = self.env.context.get("default_res_model") + parameter_name = "mail_restrict_follower_selection.domain" + parameter_domain = ( + self.env["ir.config_parameter"] + .sudo() + .get_param( + f"{parameter_name}.{res_model}", + self.env["ir.config_parameter"] + .sudo() + .get_param(parameter_name, default="[]"), + ) + ) + domain = expression.AND( + [safe_eval(parameter_domain), self._fields["partner_ids"].domain] + ) + return domain + + @api.model + def get_view(self, view_id=None, view_type="form", **options): + result = super().get_view(view_id=view_id, view_type=view_type, **options) + arch = etree.fromstring(result["arch"]) + domain = self._mail_restrict_follower_selection_get_domain() + eval_domain = safe_eval( + str(domain), locals_dict={"ref": lambda str_id: _id_get(self.env, str_id)} + ) + for field in arch.xpath('//field[@name="partner_ids"]'): + field.attrib["domain"] = str(eval_domain) + result["arch"] = etree.tostring(arch) + return result diff --git a/mail_restrict_follower_selection/pyproject.toml b/mail_restrict_follower_selection/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/mail_restrict_follower_selection/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/mail_restrict_follower_selection/readme/CONFIGURE.md b/mail_restrict_follower_selection/readme/CONFIGURE.md new file mode 100644 index 0000000000..9213b8be16 --- /dev/null +++ b/mail_restrict_follower_selection/readme/CONFIGURE.md @@ -0,0 +1,12 @@ +To configure this module, you need to go to System parameters and adjust +mail_restrict_follower_selection.domain as you see fit. This restricts +followers globally, if you want to restrict only the followers for a +certain record type (or have different restrictions for different record +types), create a parameter +mail_restrict_follower_selection.domain.\$your_model. + +As an example, you could use \[('category_id.name', '=', 'Employees')\] +to allow only contacts with 'Employees' tag to be added as follower - +this also is the default. + +Note: This module won't change existing followers! diff --git a/mail_restrict_follower_selection/readme/CONTRIBUTORS.md b/mail_restrict_follower_selection/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..f70ff58194 --- /dev/null +++ b/mail_restrict_follower_selection/readme/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +- Holger Brunn \<\> +- Nguyen Tan Phuc \<\> +- Enric Tobella \<\> +- [Quartile](https://www.quartile.co): + - Aung Ko Ko Lin diff --git a/mail_restrict_follower_selection/readme/DESCRIPTION.md b/mail_restrict_follower_selection/readme/DESCRIPTION.md new file mode 100644 index 0000000000..2d7e37a290 --- /dev/null +++ b/mail_restrict_follower_selection/readme/DESCRIPTION.md @@ -0,0 +1,8 @@ +This module was written to allow you to restrict the selection of +possible followers. For example, if you use the social ERP functions +only internally, it makes sense to filter possible followers for being +employees. Otherwise, you'll get a quite crowded list of partners to +choose from. + +Moreover, the module disables the option to automatically add followers +that do not meet the domain. diff --git a/mail_restrict_follower_selection/static/description/icon.png b/mail_restrict_follower_selection/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/mail_restrict_follower_selection/static/description/icon.png differ diff --git a/mail_restrict_follower_selection/static/description/index.html b/mail_restrict_follower_selection/static/description/index.html new file mode 100644 index 0000000000..ebfa18c36a --- /dev/null +++ b/mail_restrict_follower_selection/static/description/index.html @@ -0,0 +1,450 @@ + + + + + +Restrict follower selection + + + +
+

Restrict follower selection

+ + +

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

+

This module was written to allow you to restrict the selection of +possible followers. For example, if you use the social ERP functions +only internally, it makes sense to filter possible followers for being +employees. Otherwise, you’ll get a quite crowded list of partners to +choose from.

+

Moreover, the module disables the option to automatically add followers +that do not meet the domain.

+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to go to System parameters and adjust +mail_restrict_follower_selection.domain as you see fit. This restricts +followers globally, if you want to restrict only the followers for a +certain record type (or have different restrictions for different record +types), create a parameter +mail_restrict_follower_selection.domain.$your_model.

+

As an example, you could use [(‘category_id.name’, ‘=’, ‘Employees’)] to +allow only contacts with ‘Employees’ tag to be added as follower - this +also is the default.

+

Note: This module won’t change existing followers!

+
+
+

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

+
    +
  • Therp BV
    • +
  • Creu Blanca
    • +
+
+
+

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

+

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

+
+
+
+ + diff --git a/mail_restrict_follower_selection/tests/__init__.py b/mail_restrict_follower_selection/tests/__init__.py new file mode 100644 index 0000000000..10093c8f1b --- /dev/null +++ b/mail_restrict_follower_selection/tests/__init__.py @@ -0,0 +1,5 @@ +# Copyright (C) 2015 Therp BV +# Copyright (C) 2017 Komit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import test_mail_restrict_follower_selection diff --git a/mail_restrict_follower_selection/tests/test_mail_restrict_follower_selection.py b/mail_restrict_follower_selection/tests/test_mail_restrict_follower_selection.py new file mode 100644 index 0000000000..e01f50e9d0 --- /dev/null +++ b/mail_restrict_follower_selection/tests/test_mail_restrict_follower_selection.py @@ -0,0 +1,111 @@ +# Copyright (C) 2015 Therp BV +# Copyright (C) 2017 Komit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from lxml import etree + +from odoo.tests.common import TransactionCase + + +class TestMailRestrictFollowerSelection(TransactionCase): + def setUp(self): + super().setUp() + self.category_employees = self.env["res.partner.category"].create( + {"name": "Employees"} + ) + self.param = self.env.ref( + "mail_restrict_follower_selection.parameter_res_partner_domain" + ) + self.param.update({"value": "[('category_id.name', '=', 'Employees')]"}) + + self.partner = self.env["res.partner"].create( + { + "name": "Partner", + "category_id": self.category_employees, + "email": "test@test.com", + } + ) + self.switzerland = self.env.ref("base.ch") + + def _use_ref_in_domain(self): + """Change the general domain to test the safe_eval.""" + param = self.env.ref("mail_restrict_follower_selection.parameter_domain") + country_id = self.env.ref("base.ch").id + param.value = f"[('country_id', '!=', {country_id})]" + + def test_fields_view_get(self): + result = self.env["mail.wizard.invite"].get_view(view_type="form") + for field in etree.fromstring(result["arch"]).xpath( + '//field[@name="partner_ids"]' + ): + self.assertTrue(field.get("domain")) + + def send_action(self): + compose = ( + self.env["mail.compose.message"] + .with_context( + mail_post_autofollow=True, + default_composition_mode="comment", + default_model="res.partner", + default_use_active_domain=True, + test_restrict_follower=True, + ) + .create( + { + "subject": "From Composer Test", + "body": "${object.description}", + "res_ids": self.partner.ids, + "partner_ids": [(4, id) for id in self.partner.ids], + } + ) + ) + self.assertEqual(compose.partner_ids, self.partner) + compose._action_send_mail() + + def test_followers_meet(self): + self.partner.write({"category_id": self.category_employees}) + self.send_action() + self.assertIn( + self.partner, self.partner.message_follower_ids.mapped("partner_id") + ) + + def test_followers_not_meet(self): + self.partner.write({"category_id": False}) + self.send_action() + self.assertNotIn( + self.partner, self.partner.message_follower_ids.mapped("partner_id") + ) + + def test_message_add_suggested_recipient(self): + res = self.partner.with_context( + test_restrict_follower=True + )._message_add_suggested_recipient([], partner=self.partner) + self.assertEqual(res[0]["partner_id"], self.partner.id) + + new_res = self.partner.with_context( + test_restrict_follower=True + )._message_add_suggested_recipient([]) + self.assertFalse(new_res[0].get("partner_id")) + + def test_get_view_eval(self): + """Check using safe_eval in field_view_get.""" + self._use_ref_in_domain() + result = self.env["mail.wizard.invite"].get_view(view_type="form") + for field in etree.fromstring(result["arch"]).xpath( + '//field[@name="partner_ids"]' + ): + domain = field.get("domain") + self.assertTrue(domain.find("country_id") > 0) + self.assertTrue(domain.find(str(self.switzerland.id)) > 0) + + def test_message_add_suggested_recipient_eval(self): + """Check using safe_eval when adding recipients.""" + self._use_ref_in_domain() + partner = self.partner.with_context(test_restrict_follower=True) + res = partner._message_add_suggested_recipient([], partner=self.partner) + self.assertEqual(res[0]["partner_id"], self.partner.id) + + # Partner from Swizterland should be excluded + partner.country_id = self.switzerland + res = partner._message_add_suggested_recipient([], partner=self.partner) + self.assertFalse(res) diff --git a/mail_restrict_follower_selection/utils.py b/mail_restrict_follower_selection/utils.py new file mode 100644 index 0000000000..272bd220a7 --- /dev/null +++ b/mail_restrict_follower_selection/utils.py @@ -0,0 +1,10 @@ +# Copyright 2023 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html) + + +def _id_get(env, id_str): + """Have a more secure ref function for use with safe_eval. + + Returning only the ID of the record. + """ + return env.ref(id_str).id