diff --git a/setup/sql_export_mail/odoo/addons/sql_export_mail b/setup/sql_export_mail/odoo/addons/sql_export_mail new file mode 120000 index 000000000..2c1bd4889 --- /dev/null +++ b/setup/sql_export_mail/odoo/addons/sql_export_mail @@ -0,0 +1 @@ +../../../../sql_export_mail \ No newline at end of file diff --git a/setup/sql_export_mail/setup.py b/setup/sql_export_mail/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/sql_export_mail/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/sql_export_mail/README.rst b/sql_export_mail/README.rst new file mode 100644 index 000000000..89058c698 --- /dev/null +++ b/sql_export_mail/README.rst @@ -0,0 +1,85 @@ +=============== +SQL Export Mail +=============== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/14.0/sql_export_mail + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-14-0/server-tools-14-0-sql_export_mail + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Allow to send the result of a query (made with the module sql_export) by mail. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure this module, you need to: + +#. Go to the sql query for which you want users to be notified by e-mail. +#. Add users to be notified in the field Users Notified by e-mail. +#. Click on the button create a cron and then configure the cron to run when + you want to. If you already have created a cron for another query, you can + use it again for other queries + +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 +~~~~~~~ + +* Akretion + +Contributors +~~~~~~~~~~~~ + +* Florian da Costa +* Helly kapatel + +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/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/sql_export_mail/__init__.py b/sql_export_mail/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/sql_export_mail/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/sql_export_mail/__manifest__.py b/sql_export_mail/__manifest__.py new file mode 100644 index 000000000..e6768b832 --- /dev/null +++ b/sql_export_mail/__manifest__.py @@ -0,0 +1,20 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +{ + "name": "SQL Export Mail", + "version": "16.0.1.0.0", + "category": "Generic Modules", + "summary": "Send csv file generated by sql query by mail.", + "author": "Akretion,GRAP,Odoo Community Association (OCA)", + "maintainers": ["legalsylvain"], + "website": "https://github.com/OCA/reporting-engine", + "depends": [ + "mail", + "sql_export", + ], + "license": "AGPL-3", + "data": [ + "views/sql_export_view.xml", + "data/mail_template.xml", + ], + "installable": True, +} diff --git a/sql_export_mail/data/mail_template.xml b/sql_export_mail/data/mail_template.xml new file mode 100644 index 000000000..d5d40a75a --- /dev/null +++ b/sql_export_mail/data/mail_template.xml @@ -0,0 +1,23 @@ + + + + + + SQL Export + admin@example.com + ${object.get_email_address_for_template()} + ${object.name or ''} + + + + +

You will find the report ${object.name or ''} as an attachment of the mail.

+ + + ]]> + + + diff --git a/sql_export_mail/i18n/ca.po b/sql_export_mail/i18n/ca.po new file mode 100644 index 000000000..df754f2ca --- /dev/null +++ b/sql_export_mail/i18n/ca.po @@ -0,0 +1,139 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * sql_export_mail +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: Automatically generated\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" + +#. module: sql_export_mail +#: model:mail.template,body_html:sql_export_mail.sql_export_mailer +msgid "" +"\n" +"
\n" +"\n" +"

You will find the report ${object.name or ''} as an attachment of the mail.

\n" +"\n" +"
\n" +" " +msgstr "" + +#. module: sql_export_mail +#: model:mail.template,subject:sql_export_mail.sql_export_mailer +msgid "${object.name or ''}" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,help:sql_export_mail.field_sql_export__mail_user_ids +msgid "" +"Add the users who want to receive the report by e-mail. You need to link the" +" sql query with a cron to send mail automatically" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__assigned_attachment_ids +msgid "Assigned Attachments" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__changeset_change_ids +msgid "Changeset Changes" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__changeset_ids +msgid "Changesets" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__count_pending_changeset_changes +msgid "Count Pending Changeset Changes" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__count_pending_changesets +msgid "Count Pending Changesets" +msgstr "" + +#. module: sql_export_mail +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Create Cron" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__cron_ids +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Crons" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__display_name +msgid "Display Name" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields.selection,name:sql_export_mail.selection__sql_export__mail_condition__not_empty +msgid "File Not Empty" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__id +msgid "ID" +msgstr "" + +#. module: sql_export_mail +#: code:addons/sql_export_mail/models/sql_export.py:0 +#, python-format +msgid "" +"It is not possible to execute and send a query automatically by mail if " +"there are parameters to fill" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export____last_update +msgid "Last Modified on" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__mail_condition +msgid "Mail Condition" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model,name:sql_export_mail.model_sql_export +msgid "SQL export" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__smart_search +msgid "Smart Search" +msgstr "" + +#. module: sql_export_mail +#: code:addons/sql_export_mail/models/sql_export.py:0 +#, python-format +msgid "The user does not have any e-mail address." +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__user_can_see_changeset +msgid "User Can See Changeset" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__mail_user_ids +msgid "User to notify" +msgstr "" + +#. module: sql_export_mail +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Users Notified by e-mail" +msgstr "" diff --git a/sql_export_mail/i18n/fr.po b/sql_export_mail/i18n/fr.po new file mode 100644 index 000000000..c616a5c03 --- /dev/null +++ b/sql_export_mail/i18n/fr.po @@ -0,0 +1,158 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * sql_export_mail +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 8.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-07-18 13:15+0000\n" +"PO-Revision-Date: 2017-07-18 13:15+0000\n" +"Last-Translator: <>\n" +"Language-Team: \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: sql_export_mail +#: model:mail.template,body_html:sql_export_mail.sql_export_mailer +#, fuzzy +msgid "" +"\n" +"
\n" +"\n" +"

You will find the report ${object.name or ''} as an attachment of the " +"mail.

\n" +"\n" +"
\n" +" " +msgstr "" +"\n" +"
\n" +"\n" +"

Vous trouverez le rapport ${object.name or ''} en pièce jointe de ce mail." +"

\n" +"\n" +"
\n" +" " + +#. module: sql_export_mail +#: model:mail.template,subject:sql_export_mail.sql_export_mailer +msgid "${object.name or ''}" +msgstr "${object.name or ''}" + +#. module: sql_export_mail +#: model:ir.model.fields,help:sql_export_mail.field_sql_export__mail_user_ids +msgid "" +"Add the users who want to receive the report by e-mail. You need to link the " +"sql query with a cron to send mail automatically" +msgstr "" +"Ajoutez les utilisateurs voulant recevoir le rapport par mail. Vous devez " +"ensuite créer une tâche planifiée pour envoyer le mail automatiquement." + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__assigned_attachment_ids +msgid "Assigned Attachments" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__changeset_change_ids +msgid "Changeset Changes" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__changeset_ids +msgid "Changesets" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__count_pending_changeset_changes +msgid "Count Pending Changeset Changes" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__count_pending_changesets +msgid "Count Pending Changesets" +msgstr "" + +#. module: sql_export_mail +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Create Cron" +msgstr "Créer une tâche planfiée" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__cron_ids +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Crons" +msgstr "Tâches planifiées" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__display_name +msgid "Display Name" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields.selection,name:sql_export_mail.selection__sql_export__mail_condition__not_empty +msgid "File Not Empty" +msgstr "Fichier non vide." + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__id +msgid "ID" +msgstr "" + +#. module: sql_export_mail +#: code:addons/sql_export_mail/models/sql_export.py:0 +#, python-format +msgid "" +"It is not possible to execute and send a query automatically by mail if " +"there are parameters to fill" +msgstr "" +"Il n'est pas possible d'exécuter en envoyer le résultat d'une requête par " +"mail si celle-ci contient des paramètres." + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export____last_update +msgid "Last Modified on" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__mail_condition +#, fuzzy +msgid "Mail Condition" +msgstr "Condition d'envoi par mail" + +#. module: sql_export_mail +#: model:ir.model,name:sql_export_mail.model_sql_export +msgid "SQL export" +msgstr "Export SQL" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__smart_search +msgid "Smart Search" +msgstr "" + +#. module: sql_export_mail +#: code:addons/sql_export_mail/models/sql_export.py:0 +#, python-format +msgid "The user does not have any e-mail address." +msgstr "L'utilisateur selectionné n'a pas d'addresse mail." + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__user_can_see_changeset +msgid "User Can See Changeset" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__mail_user_ids +msgid "User to notify" +msgstr "Utilisateurs à notifier par mail" + +#. module: sql_export_mail +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Users Notified by e-mail" +msgstr "Utilisateurs notifiés par mail" diff --git a/sql_export_mail/i18n/sql_export_mail.pot b/sql_export_mail/i18n/sql_export_mail.pot new file mode 100644 index 000000000..68bf42e1e --- /dev/null +++ b/sql_export_mail/i18n/sql_export_mail.pot @@ -0,0 +1,138 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * sql_export_mail +# +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: sql_export_mail +#: model:mail.template,body_html:sql_export_mail.sql_export_mailer +msgid "" +"\n" +"
\n" +"\n" +"

You will find the report ${object.name or ''} as an attachment of the mail.

\n" +"\n" +"
\n" +" " +msgstr "" + +#. module: sql_export_mail +#: model:mail.template,subject:sql_export_mail.sql_export_mailer +msgid "${object.name or ''}" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,help:sql_export_mail.field_sql_export__mail_user_ids +msgid "" +"Add the users who want to receive the report by e-mail. You need to link the" +" sql query with a cron to send mail automatically" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__assigned_attachment_ids +msgid "Assigned Attachments" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__changeset_change_ids +msgid "Changeset Changes" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__changeset_ids +msgid "Changesets" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__count_pending_changeset_changes +msgid "Count Pending Changeset Changes" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__count_pending_changesets +msgid "Count Pending Changesets" +msgstr "" + +#. module: sql_export_mail +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Create Cron" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__cron_ids +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Crons" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__display_name +msgid "Display Name" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields.selection,name:sql_export_mail.selection__sql_export__mail_condition__not_empty +msgid "File Not Empty" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__id +msgid "ID" +msgstr "" + +#. module: sql_export_mail +#: code:addons/sql_export_mail/models/sql_export.py:0 +#, python-format +msgid "" +"It is not possible to execute and send a query automatically by mail if " +"there are parameters to fill" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export____last_update +msgid "Last Modified on" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__mail_condition +msgid "Mail Condition" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model,name:sql_export_mail.model_sql_export +msgid "SQL export" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__smart_search +msgid "Smart Search" +msgstr "" + +#. module: sql_export_mail +#: code:addons/sql_export_mail/models/sql_export.py:0 +#, python-format +msgid "The user does not have any e-mail address." +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__user_can_see_changeset +msgid "User Can See Changeset" +msgstr "" + +#. module: sql_export_mail +#: model:ir.model.fields,field_description:sql_export_mail.field_sql_export__mail_user_ids +msgid "User to notify" +msgstr "" + +#. module: sql_export_mail +#: model_terms:ir.ui.view,arch_db:sql_export_mail.sql_export_mail_view_form +msgid "Users Notified by e-mail" +msgstr "" diff --git a/sql_export_mail/models/__init__.py b/sql_export_mail/models/__init__.py new file mode 100644 index 000000000..014462062 --- /dev/null +++ b/sql_export_mail/models/__init__.py @@ -0,0 +1 @@ +from . import sql_export diff --git a/sql_export_mail/models/sql_export.py b/sql_export_mail/models/sql_export.py new file mode 100644 index 000000000..c30d2d4d2 --- /dev/null +++ b/sql_export_mail/models/sql_export.py @@ -0,0 +1,143 @@ +# Copyright 2019 Akretion +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from datetime import datetime, timedelta + +from odoo import SUPERUSER_ID, _, api, fields, models +from odoo.exceptions import UserError + + +class SqlExport(models.Model): + _inherit = "sql.export" + + mail_user_ids = fields.Many2many( + "res.users", + "mail_user_sqlquery_rel", + "sql_id", + "user_id", + "User to notify", + help="Add the users who want to receive the report by e-mail. You " + "need to link the sql query with a cron to send mail automatically", + ) + cron_ids = fields.Many2many( + "ir.cron", "cron_sqlquery_rel", "sql_id", "cron_id", "Crons" + ) + # We could implement other conditions, that is why it is a selection field + mail_condition = fields.Selection( + [("not_empty", "File Not Empty")], default="not_empty" + ) + + def _prepare_cron_mail(self): + self.ensure_one() + return { + "active": True, + "model_id": self.env.ref("sql_export.model_sql_export").id, + "state": "code", + "code": "model._run_all_sql_export_for_cron()", + "name": "SQL Export : %s" % self.name, + "nextcall": datetime.now() + timedelta(hours=2), + "doall": False, + "numbercall": -1, + "user_id": SUPERUSER_ID, + } + + def create_cron(self): + self.ensure_one() + cron = self.env["ir.cron"].create(self._prepare_cron_mail()) + # We need to pass cron_id in the cron args because a cron is not + # aware of itself in the end method and we need it to find all + # linked sql exports + write_vals = {"code": "model._run_all_sql_export_for_cron([%s])" % cron.id} + cron.write(write_vals) + self.write({"cron_ids": [(4, cron.id)]}) + + def send_mail(self, params=None): + self.ensure_one() + params = params or {} + mail_template = self.env.ref("sql_export_mail.sql_export_mailer") + attach_obj = self.env["ir.attachment"] + if self.mail_condition == "not_empty": + res = self._execute_sql_request(params=params, mode="fetchone") + if not res: + return + + wizard = self.env["sql.file.wizard"].create( + { + "sql_export_id": self.id, + } + ) + if "user_id" in params: + wizard = wizard.with_context(force_user=params["user_id"]) + if "company_id" in params: + wizard = wizard.with_context(force_company=params["company_id"]) + + wizard.export_sql() + binary = wizard.binary_file + filename = wizard.file_name + msg_id = mail_template.send_mail(self.id, force_send=False) + mail = self.env["mail.mail"].browse(msg_id) + attach_vals = { + "name": filename, + "datas": binary, + "res_model": "mail.mail", + "res_id": mail.id, + } + attachment = attach_obj.create(attach_vals) + mail.write({"attachment_ids": [(4, attachment.id)]}) + + @api.model + def _run_all_sql_export_for_cron(self, cron_ids): + exports = self.search([("cron_ids", "in", cron_ids)]) + for export in exports: + if "%(company_id)s" in export.query and "%(user_id)s" not in export.query: + variable_dict = {} + companies = self.env["res.company"].search([]) + for company in companies: + users = export.mail_user_ids.filtered( + lambda u: u.company_id == company + ) + if users: + variable_dict["company_id"] = users[0].company_id.id + export.with_context(mail_to=users.ids).send_mail( + params=variable_dict + ) + elif "%(user_id)s" in export.query: + variable_dict = {} + for user in export.mail_user_ids: + variable_dict["user_id"] = user.id + if "%(company_id)s" in export.query: + variable_dict["company_id"] = user.company_id.id + export.with_context(mail_to=[user.id]).send_mail( + params=variable_dict + ) + else: + export.send_mail() + + @api.constrains("field_ids", "mail_user_ids") + def check_no_parameter_if_sent_by_mail(self): + for export in self: + if export.field_ids and export.mail_user_ids: + raise UserError( + _( + "It is not possible to execute and send a query " + "automatically by mail if there are parameters to fill" + ) + ) + + @api.constrains("mail_user_ids") + def check_mail_user(self): + for export in self: + for user in export.mail_user_ids: + if not user.email: + raise UserError(_("The user does not have any e-mail address.")) + + def get_email_address_for_template(self): + """ + Called from mail template + """ + self.ensure_one() + if self.env.context.get("mail_to"): + mail_users = self.env["res.users"].browse(self.env.context.get("mail_to")) + else: + mail_users = self.mail_user_ids + return ",".join([x.email for x in mail_users if x.email]) diff --git a/sql_export_mail/readme/CONFIGURE.rst b/sql_export_mail/readme/CONFIGURE.rst new file mode 100644 index 000000000..17ed7c873 --- /dev/null +++ b/sql_export_mail/readme/CONFIGURE.rst @@ -0,0 +1,7 @@ +To configure this module, you need to: + +#. Go to the sql query for which you want users to be notified by e-mail. +#. Add users to be notified in the field Users Notified by e-mail. +#. Click on the button create a cron and then configure the cron to run when + you want to. If you already have created a cron for another query, you can + use it again for other queries diff --git a/sql_export_mail/readme/CONTRIBUTORS.rst b/sql_export_mail/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..c2183a83d --- /dev/null +++ b/sql_export_mail/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Florian da Costa +* Helly kapatel diff --git a/sql_export_mail/readme/DESCRIPTION.rst b/sql_export_mail/readme/DESCRIPTION.rst new file mode 100644 index 000000000..21dae9d88 --- /dev/null +++ b/sql_export_mail/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +Allow to send the result of a query (made with the module sql_export) by mail. diff --git a/sql_export_mail/static/description/icon.png b/sql_export_mail/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/sql_export_mail/static/description/icon.png differ diff --git a/sql_export_mail/static/description/index.html b/sql_export_mail/static/description/index.html new file mode 100644 index 000000000..680790e0e --- /dev/null +++ b/sql_export_mail/static/description/index.html @@ -0,0 +1,432 @@ + + + + + + +SQL Export Mail + + + +
+

SQL Export Mail

+ + +

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

+

Allow to send the result of a query (made with the module sql_export) by mail.

+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Go to the sql query for which you want users to be notified by e-mail.
    2. +
  2. Add users to be notified in the field Users Notified by e-mail.
    3. +
  3. Click on the button create a cron and then configure the cron to run when +you want to. If you already have created a cron for another query, you can +use it again for other queries
    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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Akretion
    • +
+
+
+

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

+

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

+
+
+
+ + diff --git a/sql_export_mail/tests/__init__.py b/sql_export_mail/tests/__init__.py new file mode 100644 index 000000000..8d5f08c3f --- /dev/null +++ b/sql_export_mail/tests/__init__.py @@ -0,0 +1 @@ +from . import test_sql_query_mail diff --git a/sql_export_mail/tests/test_sql_query_mail.py b/sql_export_mail/tests/test_sql_query_mail.py new file mode 100644 index 000000000..8de0ce9d0 --- /dev/null +++ b/sql_export_mail/tests/test_sql_query_mail.py @@ -0,0 +1,28 @@ +# Copyright (C) 2019 Akretion () +# @author: Florian da Costa +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). + +from odoo import SUPERUSER_ID +from odoo.tests.common import TransactionCase + + +class TestExportSqlQueryMail(TransactionCase): + def setUp(self): + super(TestExportSqlQueryMail, self).setUp() + self.sql_report_demo = self.env.ref("sql_export.sql_export_partner") + self.sql_report_demo.write({"mail_user_ids": [(4, SUPERUSER_ID)]}) + + def test_sql_query_mail(self): + mail_obj = self.env["mail.mail"] + mails = mail_obj.search( + [("model", "=", "sql.export"), ("res_id", "=", self.sql_report_demo.id)] + ) + self.assertFalse(mails) + self.sql_report_demo.create_cron() + self.assertTrue(self.sql_report_demo.cron_ids) + self.sql_report_demo.cron_ids.method_direct_trigger() + mails = mail_obj.search( + [("model", "=", "sql.export"), ("res_id", "=", self.sql_report_demo.id)] + ) + self.assertTrue(mails) + self.assertTrue(mails.attachment_ids) diff --git a/sql_export_mail/views/sql_export_view.xml b/sql_export_mail/views/sql_export_view.xml new file mode 100644 index 000000000..487bad1d9 --- /dev/null +++ b/sql_export_mail/views/sql_export_view.xml @@ -0,0 +1,47 @@ + + + + + + sql.export + + + + + + + + + + + + + + + + + + + + +