diff --git a/mail_autosubscribe/README.rst b/mail_autosubscribe/README.rst new file mode 100644 index 000000000..764236571 --- /dev/null +++ b/mail_autosubscribe/README.rst @@ -0,0 +1,98 @@ +================== +Mail Autosubscribe +================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/14.0/mail_autosubscribe + :alt: OCA/social +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/social-14-0/social-14-0-mail_autosubscribe + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/205/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows you to configure partners that will be automatically in copy +of their company's business documents. + +For example, you can configure an accountant to be in copy of all invoices +sent for a given commercial partner, regardless of the invoicing address. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +Go to Configuration > Technical > Automation > Autosubscribe Models and configure +the models for which you want the feature to work. + +Then, on each partner, you can check the company documents subscriptions in the +field `In copy of`. + +This feature can be disabled on specific templates, if required, by disabling the +Autosubscribe followers field. + +Known issues / Roadmap +====================== + +* Consider implementing domain-based autosubscription rules. + This was considered during first development but it wasn't a requirement at the time. + If pursuit, this has to be done carefully to avoid affecting performance. + +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Camptocamp SA + +Contributors +~~~~~~~~~~~~ + +* `Camptocamp `_ + + * Iván Todorovich + +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_autosubscribe/__init__.py b/mail_autosubscribe/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/mail_autosubscribe/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/mail_autosubscribe/__manifest__.py b/mail_autosubscribe/__manifest__.py new file mode 100644 index 000000000..ad70c7cec --- /dev/null +++ b/mail_autosubscribe/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + "name": "Mail Autosubscribe", + "summary": "Automatically subscribe partners to its company's business documents", + "version": "15.0.1.0.0", + "author": "Camptocamp SA, Odoo Community Association (OCA)", + "license": "AGPL-3", + "category": "Marketing", + "depends": ["mail"], + "website": "https://github.com/OCA/social", + "data": [ + "security/ir.model.access.csv", + "views/mail_autosubscribe.xml", + "views/mail_template.xml", + "views/res_partner.xml", + ], +} diff --git a/mail_autosubscribe/i18n/ca.po b/mail_autosubscribe/i18n/ca.po new file mode 100644 index 000000000..3568db2b1 --- /dev/null +++ b/mail_autosubscribe/i18n/ca.po @@ -0,0 +1,129 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_autosubscribe +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2022-01-25 15:40+0000\n" +"Last-Translator: jabelchi \n" +"Language-Team: none\n" +"Language: ca\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.3.2\n" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner__mail_autosubscribe_ids +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_users__mail_autosubscribe_ids +#: model:ir.ui.menu,name:mail_autosubscribe.menu_mail_autosubscribe +msgid "Autosubscribe Models" +msgstr "Models autosubscripció" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_base +msgid "Base" +msgstr "Base" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_res_partner +msgid "Contact" +msgstr "Contacte" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__create_uid +msgid "Created by" +msgstr "Creat per" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__create_date +msgid "Created on" +msgstr "Creat el" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__display_name +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template__display_name +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_thread__display_name +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner__display_name +msgid "Display Name" +msgstr "Nom a mostrar" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_mail_template +msgid "Email Templates" +msgstr "Plantilles de correu" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_mail_thread +msgid "Email Thread" +msgstr "Fil de correus" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__id +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template__id +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_thread__id +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner__id +msgid "ID" +msgstr "ID" + +#. module: mail_autosubscribe +#: model_terms:ir.ui.view,arch_db:mail_autosubscribe.view_partner_form +msgid "In copy of" +msgstr "En còpia de" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe____last_update +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template____last_update +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_thread____last_update +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner____last_update +msgid "Last Modified on" +msgstr "Darrera modificació el" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__write_uid +msgid "Last Updated by" +msgstr "Darrera actualització per" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__write_date +msgid "Last Updated on" +msgstr "Darrera modificació el" + +#. module: mail_autosubscribe +#: model:ir.actions.act_window,name:mail_autosubscribe.action_mail_autosubscribe +msgid "Mail Auto Subscribe" +msgstr "Auto subscripció de correu electrònic" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_mail_autosubscribe +msgid "Mail Autosubscribe" +msgstr "Autosubscripció Email" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__model_id +msgid "Model" +msgstr "Model" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__model +msgid "Model Name" +msgstr "Nom del model" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__name +#: model_terms:ir.ui.view,arch_db:mail_autosubscribe.view_mail_autosubscribe_form +msgid "Name" +msgstr "Nom" + +#. module: mail_autosubscribe +#: model:ir.model.constraint,message:mail_autosubscribe.constraint_mail_autosubscribe_model_id_unique +msgid "There's already a rule for this model" +msgstr "Ja existeix una regla per a aquest model" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template__use_autosubscribe_followers +msgid "Use Autosubscribe Followers" +msgstr "Usar seguidors autosubscrits" diff --git a/mail_autosubscribe/i18n/mail_autosubscribe.pot b/mail_autosubscribe/i18n/mail_autosubscribe.pot new file mode 100644 index 000000000..4b473f975 --- /dev/null +++ b/mail_autosubscribe/i18n/mail_autosubscribe.pot @@ -0,0 +1,126 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_autosubscribe +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.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_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner__mail_autosubscribe_ids +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_users__mail_autosubscribe_ids +#: model:ir.ui.menu,name:mail_autosubscribe.menu_mail_autosubscribe +msgid "Autosubscribe Models" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_base +msgid "Base" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_res_partner +msgid "Contact" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__create_uid +msgid "Created by" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__create_date +msgid "Created on" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__display_name +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template__display_name +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_thread__display_name +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner__display_name +msgid "Display Name" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_mail_template +msgid "Email Templates" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__id +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template__id +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_thread__id +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner__id +msgid "ID" +msgstr "" + +#. module: mail_autosubscribe +#: model_terms:ir.ui.view,arch_db:mail_autosubscribe.view_partner_form +msgid "In copy of" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe____last_update +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template____last_update +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_thread____last_update +#: model:ir.model.fields,field_description:mail_autosubscribe.field_res_partner____last_update +msgid "Last Modified on" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__write_date +msgid "Last Updated on" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.actions.act_window,name:mail_autosubscribe.action_mail_autosubscribe +msgid "Mail Auto Subscribe" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model,name:mail_autosubscribe.model_mail_autosubscribe +msgid "Mail Autosubscribe" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__model_id +msgid "Model" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__model +msgid "Model Name" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_autosubscribe__name +#: model_terms:ir.ui.view,arch_db:mail_autosubscribe.view_mail_autosubscribe_form +msgid "Name" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.constraint,message:mail_autosubscribe.constraint_mail_autosubscribe_model_id_unique +msgid "There's already a rule for this model" +msgstr "" + +#. module: mail_autosubscribe +#: model:ir.model.fields,field_description:mail_autosubscribe.field_mail_template__use_autosubscribe_followers +msgid "Use Autosubscribe Followers" +msgstr "" diff --git a/mail_autosubscribe/models/__init__.py b/mail_autosubscribe/models/__init__.py new file mode 100644 index 000000000..84c59e66d --- /dev/null +++ b/mail_autosubscribe/models/__init__.py @@ -0,0 +1,5 @@ +from . import models +from . import res_partner +from . import mail_thread +from . import mail_autosubscribe +from . import mail_template diff --git a/mail_autosubscribe/models/mail_autosubscribe.py b/mail_autosubscribe/models/mail_autosubscribe.py new file mode 100644 index 000000000..96e0382c3 --- /dev/null +++ b/mail_autosubscribe/models/mail_autosubscribe.py @@ -0,0 +1,42 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import api, fields, models + + +class MailAutosubscribe(models.Model): + _name = "mail.autosubscribe" + _description = "Mail Autosubscribe" + + _sql_constraints = [ + ( + "model_id_unique", + "UNIQUE(model_id)", + "There's already a rule for this model", + ) + ] + + model_id = fields.Many2one( + "ir.model", + required=True, + index=True, + ondelete="cascade", + ) + model = fields.Char( + related="model_id.model", + string="Model Name", + store=True, + index=True, + ) + name = fields.Char( + compute="_compute_name", + store=True, + readonly=False, + ) + + @api.depends("model_id") + def _compute_name(self): + for rec in self: + if not rec.name: + rec.name = rec.model_id.name diff --git a/mail_autosubscribe/models/mail_template.py b/mail_autosubscribe/models/mail_template.py new file mode 100644 index 000000000..abbf25197 --- /dev/null +++ b/mail_autosubscribe/models/mail_template.py @@ -0,0 +1,34 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class MailTemplate(models.Model): + _inherit = "mail.template" + + use_autosubscribe_followers = fields.Boolean(default=True) + + def generate_recipients(self, results, res_ids): + res = super().generate_recipients(results, res_ids) + autosubscribe_followers = ( + self.use_autosubscribe_followers + and not self.env.context.get("no_autosubscribe_followers") + # In this case, autosubscribers will be added by + # :func:`_message_get_default_recipients` + and not self.use_default_to + and not self.env.context.get("tpl_force_default_to") + ) + if autosubscribe_followers: + for res_id in res.keys(): + partners = ( + self.env["res.partner"].sudo().browse(res[res_id]["partner_ids"]) + ) + ResModel = self.env[self.model] + followers = ResModel._message_get_autosubscribe_followers(partners) + follower_ids = [ + follower.id for follower in followers if follower not in partners + ] + res[res_id]["partner_ids"] += follower_ids + return res diff --git a/mail_autosubscribe/models/mail_thread.py b/mail_autosubscribe/models/mail_thread.py new file mode 100644 index 000000000..be8d4738c --- /dev/null +++ b/mail_autosubscribe/models/mail_thread.py @@ -0,0 +1,26 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + + +class MailThread(models.AbstractModel): + _inherit = "mail.thread" + + def message_subscribe(self, partner_ids=None, subtype_ids=None): + # Overload to automatically subscribe autosubscribe followers. + autosubscribe_followers = not self.env.context.get("no_autosubscribe_followers") + if partner_ids and autosubscribe_followers: + partners = self.env["res.partner"].sudo().browse(partner_ids) + followers = self._message_get_autosubscribe_followers(partners) + follower_ids = [ + follower.id + for follower in followers + if follower not in partners and follower not in self.message_partner_ids + ] + partner_ids += follower_ids + return super().message_subscribe( + partner_ids=partner_ids, + subtype_ids=subtype_ids, + ) diff --git a/mail_autosubscribe/models/models.py b/mail_autosubscribe/models/models.py new file mode 100644 index 000000000..77f1a5d88 --- /dev/null +++ b/mail_autosubscribe/models/models.py @@ -0,0 +1,37 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import api, models + + +class BaseModel(models.AbstractModel): + _inherit = "base" + + @api.model + def _message_get_autosubscribe_followers_domain(self, partners): + return [ + ("id", "child_of", partners.commercial_partner_id.ids), + ("mail_autosubscribe_ids.model", "=", self._name), + ] + + @api.model + def _message_get_autosubscribe_followers(self, partners): + domain = self._message_get_autosubscribe_followers_domain(partners) + return self.env["res.partner"].sudo().search(domain) + + def _message_get_default_recipients(self): + # Overload to include auto follow document partners in the composer + # Note: This only works if the template is configured with 'Default recipients' + res = super()._message_get_default_recipients() + if self.env.context.get("no_autosubscribe_followers"): + return res + for rec in self: + partner_ids = res[rec.id]["partner_ids"] + partners = self.env["res.partner"].sudo().browse(partner_ids) + followers = rec._message_get_autosubscribe_followers(partners) + follower_ids = [ + follower.id for follower in followers if follower not in partners + ] + partner_ids += follower_ids + return res diff --git a/mail_autosubscribe/models/res_partner.py b/mail_autosubscribe/models/res_partner.py new file mode 100644 index 000000000..a3848abd8 --- /dev/null +++ b/mail_autosubscribe/models/res_partner.py @@ -0,0 +1,16 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class ResPartner(models.Model): + _inherit = "res.partner" + + mail_autosubscribe_ids = fields.Many2many( + "mail.autosubscribe", + string="Autosubscribe Models", + column1="partner_id", + column2="model_id", + ) diff --git a/mail_autosubscribe/readme/CONFIGURE.rst b/mail_autosubscribe/readme/CONFIGURE.rst new file mode 100644 index 000000000..f8af04401 --- /dev/null +++ b/mail_autosubscribe/readme/CONFIGURE.rst @@ -0,0 +1,8 @@ +Go to Configuration > Technical > Automation > Autosubscribe Models and configure +the models for which you want the feature to work. + +Then, on each partner, you can check the company documents subscriptions in the +field `In copy of`. + +This feature can be disabled on specific templates, if required, by disabling the +Autosubscribe followers field. diff --git a/mail_autosubscribe/readme/CONTRIBUTORS.rst b/mail_autosubscribe/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..df7472d00 --- /dev/null +++ b/mail_autosubscribe/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `Camptocamp `_ + + * Iván Todorovich diff --git a/mail_autosubscribe/readme/DESCRIPTION.rst b/mail_autosubscribe/readme/DESCRIPTION.rst new file mode 100644 index 000000000..cf2d11484 --- /dev/null +++ b/mail_autosubscribe/readme/DESCRIPTION.rst @@ -0,0 +1,5 @@ +This module allows you to configure partners that will be automatically in copy +of their company's business documents. + +For example, you can configure an accountant to be in copy of all invoices +sent for a given commercial partner, regardless of the invoicing address. diff --git a/mail_autosubscribe/readme/ROADMAP.rst b/mail_autosubscribe/readme/ROADMAP.rst new file mode 100644 index 000000000..893174032 --- /dev/null +++ b/mail_autosubscribe/readme/ROADMAP.rst @@ -0,0 +1,3 @@ +* Consider implementing domain-based autosubscription rules. + This was considered during first development but it wasn't a requirement at the time. + If pursuit, this has to be done carefully to avoid affecting performance. diff --git a/mail_autosubscribe/security/ir.model.access.csv b/mail_autosubscribe/security/ir.model.access.csv new file mode 100644 index 000000000..e517cc4b1 --- /dev/null +++ b/mail_autosubscribe/security/ir.model.access.csv @@ -0,0 +1,3 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_mail_autosubscribe_user,access_mail_autosubscribe_user,model_mail_autosubscribe,base.group_user,1,0,0,0 +access_mail_autosubscribe_system,access_mail_autosubscribe_system,model_mail_autosubscribe,base.group_system,1,1,1,1 diff --git a/mail_autosubscribe/static/description/icon.png b/mail_autosubscribe/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/mail_autosubscribe/static/description/icon.png differ diff --git a/mail_autosubscribe/static/description/index.html b/mail_autosubscribe/static/description/index.html new file mode 100644 index 000000000..4b1deb1dc --- /dev/null +++ b/mail_autosubscribe/static/description/index.html @@ -0,0 +1,447 @@ + + + + + + +Mail Autosubscribe + + + +
+

Mail Autosubscribe

+ + +

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

+

This module allows you to configure partners that will be automatically in copy +of their company’s business documents.

+

For example, you can configure an accountant to be in copy of all invoices +sent for a given commercial partner, regardless of the invoicing address.

+

Table of contents

+ +
+

Configuration

+

Go to Configuration > Technical > Automation > Autosubscribe Models and configure +the models for which you want the feature to work.

+

Then, on each partner, you can check the company documents subscriptions in the +field In copy of.

+

This feature can be disabled on specific templates, if required, by disabling the +Autosubscribe followers field.

+
+
+

Known issues / Roadmap

+
    +
  • Consider implementing domain-based autosubscription rules. +This was considered during first development but it wasn’t a requirement at the time. +If pursuit, this has to be done carefully to avoid affecting performance.
    • +
+
+
+

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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp SA
    • +
+
+
+

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_autosubscribe/tests/__init__.py b/mail_autosubscribe/tests/__init__.py new file mode 100644 index 000000000..a59dadaee --- /dev/null +++ b/mail_autosubscribe/tests/__init__.py @@ -0,0 +1 @@ +from . import test_mail_autosubscribe diff --git a/mail_autosubscribe/tests/models/__init__.py b/mail_autosubscribe/tests/models/__init__.py new file mode 100644 index 000000000..4327a4b6e --- /dev/null +++ b/mail_autosubscribe/tests/models/__init__.py @@ -0,0 +1 @@ +from . import fake_order diff --git a/mail_autosubscribe/tests/models/fake_order.py b/mail_autosubscribe/tests/models/fake_order.py new file mode 100644 index 000000000..b14a40f17 --- /dev/null +++ b/mail_autosubscribe/tests/models/fake_order.py @@ -0,0 +1,13 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class FakeOrder(models.Model): + _name = "fake.order" + _inherit = "mail.thread" + _description = "Fake sale.order like model" + + partner_id = fields.Many2one("res.partner", required=True) diff --git a/mail_autosubscribe/tests/test_mail_autosubscribe.py b/mail_autosubscribe/tests/test_mail_autosubscribe.py new file mode 100644 index 000000000..6c16f0368 --- /dev/null +++ b/mail_autosubscribe/tests/test_mail_autosubscribe.py @@ -0,0 +1,132 @@ +# Copyright 2021 Camptocamp (http://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo_test_helper import FakeModelLoader + +from odoo.tests.common import Form, TransactionCase, tagged + + +@tagged("post_install", "-at_install") +class TestMailAutosubscribe(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + # Setup env + cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True)) + # Load fake order model + cls.loader = FakeModelLoader(cls.env, cls.__module__) + cls.loader.backup_registry() + from .models.fake_order import FakeOrder + + cls.loader.update_registry((FakeOrder,)) + cls.fake_order_model = cls.env["ir.model"].search( + [("model", "=", "fake.order")] + ) + # Email Template + cls.mail_template = cls.env["mail.template"].create( + { + "model_id": cls.fake_order_model.id, + "name": "Fake Order: Send by Mail", + "subject": "Fake Order: ${object.partner_id.name}", + "partner_to": "${object.partner_id.id}", + "body_html": "Hello, this is a fake order", + } + ) + # Partners + cls.commercial_partner = cls.env.ref("base.res_partner_4") + cls.partner_1 = cls.env.ref("base.res_partner_address_13") + cls.partner_2 = cls.env.ref("base.res_partner_address_14") + cls.partner_3 = cls.env.ref("base.res_partner_address_24") + # Autosubscribe rules + cls.autosubscribe_fake_order = cls.env["mail.autosubscribe"].create( + {"model_id": cls.fake_order_model.id} + ) + cls.partner_3.mail_autosubscribe_ids = [(4, cls.autosubscribe_fake_order.id)] + # Empty fake.order + cls.order = cls.env["fake.order"].create({"partner_id": cls.partner_2.id}) + + @classmethod + def tearDownClass(cls): + cls.loader.restore_registry() + return super().tearDownClass() + + def test_message_subscribe(self): + """Test autosubscribe on a basic workflow""" + self.assertFalse(self.order.message_partner_ids, "No subscribers yet") + self.order.message_subscribe([self.order.partner_id.id]) + self.assertEqual( + self.order.message_partner_ids, + self.partner_2 | self.partner_3, + "Partner 3 is automatically subscribed", + ) + + def test_message_subscribe_disabled(self): + """Test autosubscribe on a basic workflow (disabled)""" + self.partner_3.mail_autosubscribe_ids = [(5, False)] + self.assertFalse(self.order.message_partner_ids, "No subscribers yet") + self.order.message_subscribe([self.order.partner_id.id]) + self.assertEqual( + self.order.message_partner_ids, + self.partner_2, + "Partner 2 is the only subscriber", + ) + + def test_mail_template(self): + """Test autosubscribe when partner is set in the mail.template partners_to""" + self.mail_template.send_mail(self.order.id) + message = self.order.message_ids[0] + self.assertEqual(message.partner_ids, self.partner_2 | self.partner_3) + + def test_mail_template_disabled(self): + """Test autosubscribe when the partner is not an autosubscribe follower""" + self.partner_3.mail_autosubscribe_ids = [(5, False)] + self.mail_template.send_mail(self.order.id) + message = self.order.message_ids[0] + self.assertEqual(message.partner_ids, self.partner_2) + + def test_mail_template_no_autosubscribe_followers(self): + """Test autosubscribe doesn't apply if it's disabled on the template""" + self.mail_template.use_autosubscribe_followers = False + self.mail_template.send_mail(self.order.id) + message = self.order.message_ids[0] + self.assertEqual(message.partner_ids, self.partner_2) + + def test_mail_template_default_recipients(self): + """Test autosubscribe when using default recipients""" + self.mail_template.use_default_to = True + self.mail_template.send_mail(self.order.id) + message = self.order.message_ids[0] + self.assertEqual(message.partner_ids, self.partner_2 | self.partner_3) + + def test_mail_message_composer(self): + """Test autosubscribe when using the mail composer""" + self.assertFalse(self.order.message_partner_ids, "No subscribers yet") + composer = Form( + self.env["mail.compose.message"].with_context( + default_model="fake.order", + default_res_id=self.order.id, + default_use_template=True, + default_template_id=self.mail_template.id, + default_composition_mode="comment", + ) + ) + composer.save().send_mail() + message = self.order.message_ids[0] + self.assertEqual(message.partner_ids, self.partner_2 | self.partner_3) + + def test_mail_message_composer_no_autosubscribe_followers(self): + """Test autosubscribe when using the mail composer and it's disabled""" + self.mail_template.use_autosubscribe_followers = False + composer = Form( + self.env["mail.compose.message"].with_context( + default_model="fake.order", + default_res_id=self.order.id, + default_use_template=True, + default_template_id=self.mail_template.id, + default_composition_mode="comment", + ) + ) + composer.save().send_mail() + message = self.order.message_ids[0] + self.assertEqual(message.partner_ids, self.partner_2) diff --git a/mail_autosubscribe/views/mail_autosubscribe.xml b/mail_autosubscribe/views/mail_autosubscribe.xml new file mode 100644 index 000000000..c0a13dc0b --- /dev/null +++ b/mail_autosubscribe/views/mail_autosubscribe.xml @@ -0,0 +1,53 @@ + + + + + + mail.autosubscribe + +
+ +
+

+ +

+
+ + + + + + +
+ + + + + mail.autosubscribe + + + + + + + + + + Mail Auto Subscribe + mail.autosubscribe + tree,form + + + + + diff --git a/mail_autosubscribe/views/mail_template.xml b/mail_autosubscribe/views/mail_template.xml new file mode 100644 index 000000000..c41388f9a --- /dev/null +++ b/mail_autosubscribe/views/mail_template.xml @@ -0,0 +1,19 @@ + + + + + + mail.template + + + + + + + + + diff --git a/mail_autosubscribe/views/res_partner.xml b/mail_autosubscribe/views/res_partner.xml new file mode 100644 index 000000000..411dd59ec --- /dev/null +++ b/mail_autosubscribe/views/res_partner.xml @@ -0,0 +1,35 @@ + + + + + + res.partner + + + + + + + + + + + + diff --git a/setup/mail_autosubscribe/odoo/addons/mail_autosubscribe b/setup/mail_autosubscribe/odoo/addons/mail_autosubscribe new file mode 120000 index 000000000..c5e462451 --- /dev/null +++ b/setup/mail_autosubscribe/odoo/addons/mail_autosubscribe @@ -0,0 +1 @@ +../../../../mail_autosubscribe \ No newline at end of file diff --git a/setup/mail_autosubscribe/setup.py b/setup/mail_autosubscribe/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/mail_autosubscribe/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)