social/email_template_qweb/models/mail_template.py

105 lines
4.6 KiB
Python

# Copyright 2016 Therp BV <http://therp.nl>
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo import fields, models, tools
from odoo.tools.misc import format_amount
from odoo.addons.mail.models.mail_template import format_date, format_datetime
class MailTemplate(models.Model):
_inherit = "mail.template"
body_type = fields.Selection(
[("jinja2", "Jinja2"), ("qweb", "QWeb")],
"Body templating engine",
default="jinja2",
required=True,
)
body_view_id = fields.Many2one("ir.ui.view", domain=[("type", "=", "qweb")])
body_view_arch = fields.Text(related="body_view_id.arch")
def generate_email(self, res_ids, fields=None):
multi_mode = True
if isinstance(res_ids, int):
res_ids = [res_ids]
multi_mode = False
result = super(MailTemplate, self).generate_email(res_ids, fields=fields)
for res_id, template in self.get_email_template(res_ids).items():
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(
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)
result[res_id]["body_html"] = self.render_post_process(body_html)
result[res_id]["body"] = tools.html_sanitize(
result[res_id]["body_html"]
)
return result if multi_mode else 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.
# fmt: off
"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_datetime(
self.env, dt, tz, format
),
"format_amount":
lambda amount, currency, context=self._context: format_amount(
self.env, amount, currency
),
# fmt: on
"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