1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2009 Sharoon Thomas
6 # Copyright (C) 2010-Today OpenERP SA (<http://www.openerp.com>)
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>
21 ##############################################################################
25 import dateutil.relativedelta as relativedelta
31 from openerp import SUPERUSER_ID
32 from openerp.osv import osv, fields
33 from openerp import tools
34 from openerp.tools.translate import _
35 from urllib import urlencode, quote as quote
38 _logger = logging.getLogger(__name__)
41 # We use a jinja2 sandboxed environment to render mako templates.
42 # Note that the rendering does not cover all the mako syntax, in particular
43 # arbitrary Python statements are not accepted, and not all expressions are
44 # allowed: only "public" attributes (not starting with '_') of objects may
46 # This is done on purpose: it prevents incidental or malicious execution of
47 # Python code that may break the security of the server.
48 from jinja2.sandbox import SandboxedEnvironment
49 mako_template_env = SandboxedEnvironment(
50 block_start_string="<%",
51 block_end_string="%>",
52 variable_start_string="${",
53 variable_end_string="}",
54 comment_start_string="<%doc>",
55 comment_end_string="</%doc>",
56 line_statement_prefix="%",
57 line_comment_prefix="##",
58 trim_blocks=True, # do not output newline after blocks
59 autoescape=True, # XML/HTML automatic escaping
61 mako_template_env.globals.update({
64 'urlencode': urlencode,
76 # dateutil.relativedelta is an old-style class and cannot be directly
77 # instanciated wihtin a jinja2 expression, so a lambda "proxy" is
78 # is needed, apparently.
79 'relativedelta': lambda *a, **kw : relativedelta.relativedelta(*a, **kw),
82 _logger.warning("jinja2 not available, templating features will not work!")
85 class email_template(osv.osv):
86 "Templates for sending email"
87 _name = "email.template"
88 _description = 'Email Templates'
91 def default_get(self, cr, uid, fields, context=None):
92 res = super(email_template, self).default_get(cr, uid, fields, context)
94 res['model_id'] = self.pool['ir.model'].search(cr, uid, [('model', '=', res.pop('model'))], context=context)[0]
97 def _replace_local_links(self, cr, uid, html, context=None):
98 """ Post-processing of html content to replace local links to absolute
99 links, using web.base.url as base url. """
104 root = lxml.html.fromstring(html)
105 if not len(root) and root.text is None and root.tail is None:
106 html = '<div>%s</div>' % html
107 root = lxml.html.fromstring(html)
109 base_url = self.pool['ir.config_parameter'].get_param(cr, uid, 'web.base.url')
110 (base_scheme, base_netloc, bpath, bparams, bquery, bfragment) = urlparse.urlparse(base_url)
112 def _process_link(url):
114 (scheme, netloc, path, params, query, fragment) = urlparse.urlparse(url)
115 if not scheme and not netloc:
116 new_url = urlparse.urlunparse((base_scheme, base_netloc, path, params, query, fragment))
119 # check all nodes, replace :
120 # - img src -> check URL
121 # - a href -> check URL
122 for node in root.iter():
124 node.set('href', _process_link(node.get('href')))
125 elif node.tag == 'img' and not node.get('src', 'data').startswith('data'):
126 node.set('src', _process_link(node.get('src')))
128 html = lxml.html.tostring(root, pretty_print=False, method='html')
129 # this is ugly, but lxml/etree tostring want to put everything in a 'div' that breaks the editor -> remove that
130 if html.startswith('<div>') and html.endswith('</div>'):
134 def render_post_process(self, cr, uid, html, context=None):
135 html = self._replace_local_links(cr, uid, html, context=context)
138 def render_template_batch(self, cr, uid, template, model, res_ids, context=None, post_process=False):
139 """Render the given template text, replace mako expressions ``${expr}``
140 with the result of evaluating these expressions with
141 an evaluation context containing:
143 * ``user``: browse_record of the current user
144 * ``object``: browse_record of the document record this mail is
146 * ``context``: the context passed to the mail composition wizard
148 :param str template: the template text to render
149 :param str model: model name of the document record this mail is related to.
150 :param int res_ids: list of ids of document records those mails are related to.
154 results = dict.fromkeys(res_ids, u"")
156 # try to load the template
158 template = mako_template_env.from_string(tools.ustr(template))
160 _logger.exception("Failed to load template %r", template)
163 # prepare template variables
164 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
165 records = self.pool[model].browse(cr, uid, res_ids, context=context) or [None]
168 'ctx': context, # context kw would clash with mako internals
170 for record in records:
171 res_id = record.id if record else None
172 variables['object'] = record
174 render_result = template.render(variables)
176 _logger.exception("Failed to render template %r using values %r" % (template, variables))
178 if render_result == u"False":
180 results[res_id] = render_result
183 for res_id, result in results.iteritems():
184 results[res_id] = self.render_post_process(cr, uid, result, context=context)
187 def get_email_template_batch(self, cr, uid, template_id=False, res_ids=None, context=None):
192 results = dict.fromkeys(res_ids, False)
196 template = self.browse(cr, uid, template_id, context)
197 langs = self.render_template_batch(cr, uid, template.lang, template.model, res_ids, context)
198 for res_id, lang in langs.iteritems():
200 # Use translated template if necessary
203 template = self.browse(cr, uid, template.id, ctx)
205 template = self.browse(cr, uid, int(template_id), context)
206 results[res_id] = template
209 def onchange_model_id(self, cr, uid, ids, model_id, context=None):
212 mod_name = self.pool.get('ir.model').browse(cr, uid, model_id, context).model
213 return {'value': {'model': mod_name}}
216 'name': fields.char('Name'),
217 'model_id': fields.many2one('ir.model', 'Applies to', help="The kind of document with with this template can be used"),
218 'model': fields.related('model_id', 'model', type='char', string='Related Document Model',
219 size=128, select=True, store=True, readonly=True),
220 'lang': fields.char('Language',
221 help="Optional translation language (ISO code) to select when sending out an email. "
222 "If not set, the english version will be used. "
223 "This should usually be a placeholder expression "
224 "that provides the appropriate language code, e.g. "
225 "${object.partner_id.lang.code}.",
226 placeholder="${object.partner_id.lang.code}"),
227 'user_signature': fields.boolean('Add Signature',
228 help="If checked, the user's signature will be appended to the text version "
230 'subject': fields.char('Subject', translate=True, help="Subject (placeholders may be used here)",),
231 'email_from': fields.char('From',
232 help="Sender address (placeholders may be used here). If not set, the default "
233 "value will be the author's email alias if configured, or email address."),
234 'email_to': fields.char('To (Emails)', help="Comma-separated recipient addresses (placeholders may be used here)"),
235 'partner_to': fields.char('To (Partners)',
236 help="Comma-separated ids of recipient partners (placeholders may be used here)",
237 oldname='email_recipients'),
238 'email_cc': fields.char('Cc', help="Carbon copy recipients (placeholders may be used here)"),
239 'reply_to': fields.char('Reply-To', help="Preferred response address (placeholders may be used here)"),
240 'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing Mail Server', readonly=False,
241 help="Optional preferred server for outgoing mails. If not set, the highest "
242 "priority one will be used."),
243 'body_html': fields.html('Body', translate=True, sanitize=False, help="Rich-text/HTML version of the message (placeholders may be used here)"),
244 'report_name': fields.char('Report Filename', translate=True,
245 help="Name to use for the generated report file (may contain placeholders)\n"
246 "The extension can be omitted and will then come from the report type."),
247 'report_template': fields.many2one('ir.actions.report.xml', 'Optional report to print and attach'),
248 'ref_ir_act_window': fields.many2one('ir.actions.act_window', 'Sidebar action', readonly=True,
249 help="Sidebar action to make this template available on records "
250 "of the related document model"),
251 'ref_ir_value': fields.many2one('ir.values', 'Sidebar Button', readonly=True,
252 help="Sidebar button to open the sidebar action"),
253 'attachment_ids': fields.many2many('ir.attachment', 'email_template_attachment_rel', 'email_template_id',
254 'attachment_id', 'Attachments',
255 help="You may attach files to this template, to be added to all "
256 "emails created from this template"),
257 'auto_delete': fields.boolean('Auto Delete', help="Permanently delete this email after sending it, to save space"),
259 # Fake fields used to implement the placeholder assistant
260 'model_object_field': fields.many2one('ir.model.fields', string="Field",
261 help="Select target field from the related document model.\n"
262 "If it is a relationship field you will be able to select "
263 "a target field at the destination of the relationship."),
264 'sub_object': fields.many2one('ir.model', 'Sub-model', readonly=True,
265 help="When a relationship field is selected as first field, "
266 "this field shows the document model the relationship goes to."),
267 'sub_model_object_field': fields.many2one('ir.model.fields', 'Sub-field',
268 help="When a relationship field is selected as first field, "
269 "this field lets you select the target field within the "
270 "destination document model (sub-model)."),
271 'null_value': fields.char('Default Value', help="Optional value to use if the target field is empty"),
272 'copyvalue': fields.char('Placeholder Expression', help="Final placeholder expression, to be copy-pasted in the desired template field."),
279 def create_action(self, cr, uid, ids, context=None):
280 action_obj = self.pool.get('ir.actions.act_window')
281 data_obj = self.pool.get('ir.model.data')
282 for template in self.browse(cr, uid, ids, context=context):
283 src_obj = template.model_id.model
284 model_data_id = data_obj._get_id(cr, uid, 'mail', 'email_compose_message_wizard_form')
285 res_id = data_obj.browse(cr, uid, model_data_id, context=context).res_id
286 button_name = _('Send Mail (%s)') % template.name
287 act_id = action_obj.create(cr, SUPERUSER_ID, {
289 'type': 'ir.actions.act_window',
290 'res_model': 'mail.compose.message',
291 'src_model': src_obj,
293 'context': "{'default_composition_mode': 'mass_mail', 'default_template_id' : %d, 'default_use_template': True}" % (template.id),
294 'view_mode':'form,tree',
299 ir_values_id = self.pool.get('ir.values').create(cr, SUPERUSER_ID, {
302 'key2': 'client_action_multi',
303 'value': "ir.actions.act_window,%s" % act_id,
308 'ref_ir_act_window': act_id,
309 'ref_ir_value': ir_values_id,
314 def unlink_action(self, cr, uid, ids, context=None):
315 for template in self.browse(cr, uid, ids, context=context):
317 if template.ref_ir_act_window:
318 self.pool.get('ir.actions.act_window').unlink(cr, SUPERUSER_ID, template.ref_ir_act_window.id, context)
319 if template.ref_ir_value:
320 ir_values_obj = self.pool.get('ir.values')
321 ir_values_obj.unlink(cr, SUPERUSER_ID, template.ref_ir_value.id, context)
323 raise osv.except_osv(_("Warning"), _("Deletion of the action record failed."))
326 def unlink(self, cr, uid, ids, context=None):
327 self.unlink_action(cr, uid, ids, context=context)
328 return super(email_template, self).unlink(cr, uid, ids, context=context)
330 def copy(self, cr, uid, id, default=None, context=None):
331 template = self.browse(cr, uid, id, context=context)
334 default = default.copy()
336 name=_("%s (copy)") % (template.name),
337 ref_ir_act_window=False,
339 return super(email_template, self).copy(cr, uid, id, default, context)
341 def build_expression(self, field_name, sub_field_name, null_value):
342 """Returns a placeholder expression for use in a template field,
343 based on the values provided in the placeholder assistant.
345 :param field_name: main field name
346 :param sub_field_name: sub field name (M2O)
347 :param null_value: default value if the target value is empty
348 :return: final placeholder expression
352 expression = "${object." + field_name
354 expression += "." + sub_field_name
356 expression += " or '''%s'''" % null_value
360 def onchange_sub_model_object_value_field(self, cr, uid, ids, model_object_field, sub_model_object_field=False, null_value=None, context=None):
364 'sub_model_object_field': False,
367 if model_object_field:
368 fields_obj = self.pool.get('ir.model.fields')
369 field_value = fields_obj.browse(cr, uid, model_object_field, context)
370 if field_value.ttype in ['many2one', 'one2many', 'many2many']:
371 res_ids = self.pool.get('ir.model').search(cr, uid, [('model', '=', field_value.relation)], context=context)
372 sub_field_value = False
373 if sub_model_object_field:
374 sub_field_value = fields_obj.browse(cr, uid, sub_model_object_field, context)
377 'sub_object': res_ids[0],
378 'copyvalue': self.build_expression(field_value.name, sub_field_value and sub_field_value.name or False, null_value or False),
379 'sub_model_object_field': sub_model_object_field or False,
380 'null_value': null_value or False
384 'copyvalue': self.build_expression(field_value.name, False, null_value or False),
385 'null_value': null_value or False
387 return {'value': result}
389 def generate_email_batch(self, cr, uid, template_id, res_ids, context=None, fields=None):
390 """Generates an email from the template for given the given model based on
391 records given by res_ids.
393 :param template_id: id of the template to render.
394 :param res_id: id of the record to use for rendering the template (model
395 is taken from template definition)
396 :returns: a dict containing all relevant fields for creating a new
397 mail.mail entry, with one extra key ``attachments``, in the
398 format expected by :py:meth:`mail_thread.message_post`.
403 fields = ['subject', 'body_html', 'email_from', 'email_to', 'partner_to', 'email_cc', 'reply_to']
405 report_xml_pool = self.pool.get('ir.actions.report.xml')
406 res_ids_to_templates = self.get_email_template_batch(cr, uid, template_id, res_ids, context)
408 # templates: res_id -> template; template -> res_ids
409 templates_to_res_ids = {}
410 for res_id, template in res_ids_to_templates.iteritems():
411 templates_to_res_ids.setdefault(template, []).append(res_id)
414 for template, template_res_ids in templates_to_res_ids.iteritems():
415 # generate fields value for all res_ids linked to the current template
417 generated_field_values = self.render_template_batch(
418 cr, uid, getattr(template, field), template.model, template_res_ids,
419 post_process=(field == 'body_html'),
421 for res_id, field_value in generated_field_values.iteritems():
422 results.setdefault(res_id, dict())[field] = field_value
423 # update values for all res_ids
424 for res_id in template_res_ids:
425 values = results[res_id]
426 if 'body_html' in fields and template.user_signature:
427 signature = self.pool.get('res.users').browse(cr, uid, uid, context).signature
428 values['body_html'] = tools.append_content_to_html(values['body_html'], signature)
429 if values.get('body_html'):
430 values['body'] = tools.html_sanitize(values['body_html'])
432 mail_server_id=template.mail_server_id.id or False,
433 auto_delete=template.auto_delete,
434 model=template.model,
435 res_id=res_id or False,
436 attachment_ids=[attach.id for attach in template.attachment_ids],
439 # Add report in attachments: generate once for all template_res_ids
440 if template.report_template:
441 for res_id in template_res_ids:
443 report_name = self.render_template(cr, uid, template.report_name, template.model, res_id, context=context)
444 report = report_xml_pool.browse(cr, uid, template.report_template.id, context)
445 report_service = report.report_name
446 # Ensure report is rendered using template's language
449 ctx['lang'] = self.render_template_batch(cr, uid, template.lang, template.model, [res_id], context)[res_id] # take 0 ?
451 if report.report_type in ['qweb-html', 'qweb-pdf']:
452 result, format = self.pool['report'].get_pdf(cr, uid, [res_id], report_service, context=ctx), 'pdf'
454 result, format = openerp.report.render_report(cr, uid, [res_id], report_service, {'model': template.model}, ctx)
456 result = base64.b64encode(result)
458 report_name = 'report.' + report_service
460 if not report_name.endswith(ext):
462 attachments.append((report_name, result))
463 results[res_id]['attachments'] = attachments
467 def send_mail(self, cr, uid, template_id, res_id, force_send=False, raise_exception=False, context=None):
468 """Generates a new mail message for the given template and record,
469 and schedules it for delivery through the ``mail`` module's scheduler.
471 :param int template_id: id of the template to render
472 :param int res_id: id of the record to render the template with
473 (model is taken from the template)
474 :param bool force_send: if True, the generated mail.message is
475 immediately sent after being created, as if the scheduler
476 was executed for this message only.
477 :returns: id of the mail.message that was created
481 mail_mail = self.pool.get('mail.mail')
482 ir_attachment = self.pool.get('ir.attachment')
484 # create a mail_mail based on values, without attachments
485 values = self.generate_email(cr, uid, template_id, res_id, context=context)
486 if not values.get('email_from'):
487 raise osv.except_osv(_('Warning!'),_("Sender email is missing or empty after template rendering. Specify one to deliver your message"))
488 # process partner_to field that is a comma separated list of partner_ids -> recipient_ids
489 # NOTE: only usable if force_send is True, because otherwise the value is
490 # not stored on the mail_mail, and therefore lost -> fixed in v8
491 values['recipient_ids'] = []
492 partner_to = values.pop('partner_to', '')
494 # placeholders could generate '', 3, 2 due to some empty field values
495 tpl_partner_ids = [pid for pid in partner_to.split(',') if pid]
496 values['recipient_ids'] += [(4, pid) for pid in self.pool['res.partner'].exists(cr, SUPERUSER_ID, tpl_partner_ids, context=context)]
498 attachment_ids = values.pop('attachment_ids', [])
499 attachments = values.pop('attachments', [])
500 msg_id = mail_mail.create(cr, uid, values, context=context)
501 mail = mail_mail.browse(cr, uid, msg_id, context=context)
504 for attachment in attachments:
506 'name': attachment[0],
507 'datas_fname': attachment[0],
508 'datas': attachment[1],
509 'res_model': 'mail.message',
510 'res_id': mail.mail_message_id.id,
512 context.pop('default_type', None)
513 attachment_ids.append(ir_attachment.create(cr, uid, attachment_data, context=context))
515 values['attachment_ids'] = [(6, 0, attachment_ids)]
516 mail_mail.write(cr, uid, msg_id, {'attachment_ids': [(6, 0, attachment_ids)]}, context=context)
519 mail_mail.send(cr, uid, [msg_id], raise_exception=raise_exception, context=context)
522 # Compatibility method
523 def render_template(self, cr, uid, template, model, res_id, context=None):
524 return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
526 def get_email_template(self, cr, uid, template_id=False, record_id=None, context=None):
527 return self.get_email_template_batch(cr, uid, template_id, [record_id], context)[record_id]
529 def generate_email(self, cr, uid, template_id, res_id, context=None):
530 return self.generate_email_batch(cr, uid, template_id, [res_id], context)[res_id]
532 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: