From a790a35bf44cbff8315824cf9b1a4225c59765e8 Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Tue, 7 Apr 2020 15:01:09 +0200 Subject: [PATCH] email_template_qweb: ease override of values, include defaults --- email_template_qweb/models/mail_template.py | 69 +++++++++++++++++++-- email_template_qweb/readme/CONTRIBUTORS.rst | 3 +- 2 files changed, 67 insertions(+), 5 deletions(-) diff --git a/email_template_qweb/models/mail_template.py b/email_template_qweb/models/mail_template.py index 0f87a0825..2b00198b0 100644 --- a/email_template_qweb/models/mail_template.py +++ b/email_template_qweb/models/mail_template.py @@ -1,6 +1,9 @@ # Copyright 2016 Therp BV # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). from odoo import api, fields, tools, models +from odoo.addons.mail.models.mail_template import ( + format_amount, format_date, format_tz +) class MailTemplate(models.Model): @@ -26,10 +29,9 @@ class MailTemplate(models.Model): if template.body_type == 'qweb' and\ (not fields or 'body_html' in fields): for record in self.env[template.model].browse(res_id): - body_html = template.body_view_id.render({ - 'object': record, - 'email_template': template, - }) + body_html = template.body_view_id.render( + template._qweb_render_context(record) + ) # Some wizards, like when sending a sales order, need this # fix to display accents correctly body_html = tools.ustr(body_html) @@ -40,3 +42,62 @@ class MailTemplate(models.Model): result[res_id]['body_html'] ) return multi_mode and result or result[res_ids[0]] + + def _qweb_render_context(self, record): + """Compute variables to render Qweb templates. + + Some vars are added to ease porting of Jinja templates. + """ + res = { + 'object': record, + 'email_template': self, + } + ctx = dict(self.env.context) + if record._name == 'mail.message': + partner_model = self.env['res.partner'] # pragma: no cover + # These variables are usually loaded when the notification is sent. + # It normally happens on `partner._notify` call, + # hence - due to the call here - is going to happen twice. + # Nevertheless there are some important values + # that can be mandatory for your templates + # especially if you load them + # from the mail composer. In this case + # the template will be rendered but it will miss many params. + # NOTE: some keys related to partner-specific permissions + # such as `actions` or `button_follow` won't be available + # until the final rendering happens. + # Check the variable `recipient_template_values` + # that comes from `_message_notification_recipients` + # in `partner._notify`. + ctx.update( + partner_model._notify_prepare_template_context( + record + ) + ) # pragma: no cover + res.update({ + # Same as for Jinja rendering, + # taken from `mail_template.render_template`. + # These ease porting of old Jinja templates to qweb ones. + 'format_date': + lambda date, format=False, + context=self._context: format_date(self.env, date, format), + 'format_tz': + lambda dt, tz=False, format=False, + context=self._context: format_tz(self.env, dt, tz, format), + 'format_amount': + lambda amount, currency, + context=self._context: format_amount( + self.env, amount, currency), + 'user': self.env.user, + # keep it for Jinja template compatibility + 'ctx': ctx, + }) + # Alias `record` to be always the main record needed by the template. + # Imagine a template for sale.order: when you load it in the composer + # the current `object` is the SO you are looking at, + # BUT when you send the message, the `object` is the message + # and not the SO anymore. + # Hence, stick the main record to `record` to make templates robust. + res['record'] = ctx.get('record', record) + res['record_name'] = ctx.get('record_name', record.display_name) + return res diff --git a/email_template_qweb/readme/CONTRIBUTORS.rst b/email_template_qweb/readme/CONTRIBUTORS.rst index e19a18721..cd81941c8 100644 --- a/email_template_qweb/readme/CONTRIBUTORS.rst +++ b/email_template_qweb/readme/CONTRIBUTORS.rst @@ -1,6 +1,7 @@ * Holger Brunn * Dave Lasley * Carlos Lopez Mite +* Simone Orsi * `Tecnativa `_: - * Ernesto Tejeda \ No newline at end of file + * Ernesto Tejeda