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, api
34 from openerp.tools.translate import _
35 from urllib import urlencode, quote as quote
37 _logger = logging.getLogger(__name__)
40 def format_tz(pool, cr, uid, dt, tz=False, format=False, context=None):
41 context = dict(context or {})
43 context['tz'] = tz or pool.get('res.users').read(cr, SUPERUSER_ID, uid, ['tz'])['tz'] or "UTC"
44 timestamp = datetime.datetime.strptime(dt, tools.DEFAULT_SERVER_DATETIME_FORMAT)
46 ts = fields.datetime.context_timestamp(cr, uid, timestamp, context)
49 return ts.strftime(format)
51 lang = context.get("lang")
54 res_lang = pool.get('res.lang')
55 ids = res_lang.search(cr, uid, [("code", "=", lang)])
57 lang_params = res_lang.read(cr, uid, ids[0], ["date_format", "time_format"])
58 format_date = lang_params.get("date_format", '%B-%d-%Y')
59 format_time = lang_params.get("time_format", '%I-%M %p')
61 fdate = ts.strftime(format_date)
62 ftime = ts.strftime(format_time)
63 return "%s %s (%s)" % (fdate, ftime, tz)
66 # We use a jinja2 sandboxed environment to render mako templates.
67 # Note that the rendering does not cover all the mako syntax, in particular
68 # arbitrary Python statements are not accepted, and not all expressions are
69 # allowed: only "public" attributes (not starting with '_') of objects may
71 # This is done on purpose: it prevents incidental or malicious execution of
72 # Python code that may break the security of the server.
73 from jinja2.sandbox import SandboxedEnvironment
74 mako_template_env = SandboxedEnvironment(
75 block_start_string="<%",
76 block_end_string="%>",
77 variable_start_string="${",
78 variable_end_string="}",
79 comment_start_string="<%doc>",
80 comment_end_string="</%doc>",
81 line_statement_prefix="%",
82 line_comment_prefix="##",
83 trim_blocks=True, # do not output newline after blocks
84 autoescape=True, # XML/HTML automatic escaping
86 mako_template_env.globals.update({
89 'urlencode': urlencode,
101 # dateutil.relativedelta is an old-style class and cannot be directly
102 # instanciated wihtin a jinja2 expression, so a lambda "proxy" is
103 # is needed, apparently.
104 'relativedelta': lambda *a, **kw : relativedelta.relativedelta(*a, **kw),
107 _logger.warning("jinja2 not available, templating features will not work!")
110 class email_template(osv.osv):
111 "Templates for sending email"
112 _name = "email.template"
113 _description = 'Email Templates'
116 def default_get(self, cr, uid, fields, context=None):
117 res = super(email_template, self).default_get(cr, uid, fields, context)
119 res['model_id'] = self.pool['ir.model'].search(cr, uid, [('model', '=', res.pop('model'))], context=context)[0]
122 def _replace_local_links(self, cr, uid, html, context=None):
123 """ Post-processing of html content to replace local links to absolute
124 links, using web.base.url as base url. """
129 root = lxml.html.fromstring(html)
130 if not len(root) and root.text is None and root.tail is None:
131 html = '<div>%s</div>' % html
132 root = lxml.html.fromstring(html)
134 base_url = self.pool['ir.config_parameter'].get_param(cr, uid, 'web.base.url')
135 (base_scheme, base_netloc, bpath, bparams, bquery, bfragment) = urlparse.urlparse(base_url)
137 def _process_link(url):
139 (scheme, netloc, path, params, query, fragment) = urlparse.urlparse(url)
140 if not scheme and not netloc:
141 new_url = urlparse.urlunparse((base_scheme, base_netloc, path, params, query, fragment))
144 # check all nodes, replace :
145 # - img src -> check URL
146 # - a href -> check URL
147 for node in root.iter():
148 if node.tag == 'a' and node.get('href'):
149 node.set('href', _process_link(node.get('href')))
150 elif node.tag == 'img' and not node.get('src', 'data').startswith('data'):
151 node.set('src', _process_link(node.get('src')))
153 html = lxml.html.tostring(root, pretty_print=False, method='html')
154 # this is ugly, but lxml/etree tostring want to put everything in a 'div' that breaks the editor -> remove that
155 if html.startswith('<div>') and html.endswith('</div>'):
159 def render_post_process(self, cr, uid, html, context=None):
160 html = self._replace_local_links(cr, uid, html, context=context)
163 def render_template_batch(self, cr, uid, template, model, res_ids, context=None, post_process=False):
164 """Render the given template text, replace mako expressions ``${expr}``
165 with the result of evaluating these expressions with
166 an evaluation context containing:
168 * ``user``: browse_record of the current user
169 * ``object``: browse_record of the document record this mail is
171 * ``context``: the context passed to the mail composition wizard
173 :param str template: the template text to render
174 :param str model: model name of the document record this mail is related to.
175 :param int res_ids: list of ids of document records those mails are related to.
179 res_ids = filter(None, res_ids) # to avoid browsing [None] below
180 results = dict.fromkeys(res_ids, u"")
182 # try to load the template
184 template = mako_template_env.from_string(tools.ustr(template))
186 _logger.exception("Failed to load template %r", template)
189 # prepare template variables
190 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
191 records = self.pool[model].browse(cr, uid, res_ids, context=context) or [None]
193 'format_tz': lambda dt, tz=False, format=False: format_tz(self.pool, cr, uid, dt, tz, format, context),
195 'ctx': context, # context kw would clash with mako internals
197 for record in records:
198 res_id = record.id if record else None
199 variables['object'] = record
201 render_result = template.render(variables)
203 _logger.exception("Failed to render template %r using values %r" % (template, variables))
205 if render_result == u"False":
207 results[res_id] = render_result
210 for res_id, result in results.iteritems():
211 results[res_id] = self.render_post_process(cr, uid, result, context=context)
214 def get_email_template_batch(self, cr, uid, template_id=False, res_ids=None, context=None):
219 results = dict.fromkeys(res_ids, False)
223 template = self.browse(cr, uid, template_id, context)
224 langs = self.render_template_batch(cr, uid, template.lang, template.model, res_ids, context)
225 for res_id, lang in langs.iteritems():
227 # Use translated template if necessary
230 template = self.browse(cr, uid, template.id, ctx)
232 template = self.browse(cr, uid, int(template_id), context)
233 results[res_id] = template
236 def onchange_model_id(self, cr, uid, ids, model_id, context=None):
239 mod_name = self.pool.get('ir.model').browse(cr, uid, model_id, context).model
240 return {'value': {'model': mod_name}}
243 'name': fields.char('Name'),
244 'model_id': fields.many2one('ir.model', 'Applies to', help="The kind of document with with this template can be used"),
245 'model': fields.related('model_id', 'model', type='char', string='Related Document Model',
246 select=True, store=True, readonly=True),
247 'lang': fields.char('Language',
248 help="Optional translation language (ISO code) to select when sending out an email. "
249 "If not set, the english version will be used. "
250 "This should usually be a placeholder expression "
251 "that provides the appropriate language, e.g. "
252 "${object.partner_id.lang}.",
253 placeholder="${object.partner_id.lang}"),
254 'user_signature': fields.boolean('Add Signature',
255 help="If checked, the user's signature will be appended to the text version "
257 'subject': fields.char('Subject', translate=True, help="Subject (placeholders may be used here)",),
258 'email_from': fields.char('From',
259 help="Sender address (placeholders may be used here). If not set, the default "
260 "value will be the author's email alias if configured, or email address."),
261 'use_default_to': fields.boolean(
262 'Default recipients',
263 help="Default recipients of the record:\n"
264 "- partner (using id on a partner or the partner_id field) OR\n"
265 "- email (using email_from or email field)"),
266 'email_to': fields.char('To (Emails)', help="Comma-separated recipient addresses (placeholders may be used here)"),
267 'partner_to': fields.char('To (Partners)',
268 help="Comma-separated ids of recipient partners (placeholders may be used here)",
269 oldname='email_recipients'),
270 'email_cc': fields.char('Cc', help="Carbon copy recipients (placeholders may be used here)"),
271 'reply_to': fields.char('Reply-To', help="Preferred response address (placeholders may be used here)"),
272 'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing Mail Server', readonly=False,
273 help="Optional preferred server for outgoing mails. If not set, the highest "
274 "priority one will be used."),
275 'body_html': fields.html('Body', translate=True, sanitize=False, help="Rich-text/HTML version of the message (placeholders may be used here)"),
276 'report_name': fields.char('Report Filename', translate=True,
277 help="Name to use for the generated report file (may contain placeholders)\n"
278 "The extension can be omitted and will then come from the report type."),
279 'report_template': fields.many2one('ir.actions.report.xml', 'Optional report to print and attach'),
280 'ref_ir_act_window': fields.many2one('ir.actions.act_window', 'Sidebar action', readonly=True, copy=False,
281 help="Sidebar action to make this template available on records "
282 "of the related document model"),
283 'ref_ir_value': fields.many2one('ir.values', 'Sidebar Button', readonly=True, copy=False,
284 help="Sidebar button to open the sidebar action"),
285 'attachment_ids': fields.many2many('ir.attachment', 'email_template_attachment_rel', 'email_template_id',
286 'attachment_id', 'Attachments',
287 help="You may attach files to this template, to be added to all "
288 "emails created from this template"),
289 'auto_delete': fields.boolean('Auto Delete', help="Permanently delete this email after sending it, to save space"),
291 # Fake fields used to implement the placeholder assistant
292 'model_object_field': fields.many2one('ir.model.fields', string="Field",
293 help="Select target field from the related document model.\n"
294 "If it is a relationship field you will be able to select "
295 "a target field at the destination of the relationship."),
296 'sub_object': fields.many2one('ir.model', 'Sub-model', readonly=True,
297 help="When a relationship field is selected as first field, "
298 "this field shows the document model the relationship goes to."),
299 'sub_model_object_field': fields.many2one('ir.model.fields', 'Sub-field',
300 help="When a relationship field is selected as first field, "
301 "this field lets you select the target field within the "
302 "destination document model (sub-model)."),
303 'null_value': fields.char('Default Value', help="Optional value to use if the target field is empty"),
304 'copyvalue': fields.char('Placeholder Expression', help="Final placeholder expression, to be copy-pasted in the desired template field."),
311 def create_action(self, cr, uid, ids, context=None):
312 action_obj = self.pool.get('ir.actions.act_window')
313 data_obj = self.pool.get('ir.model.data')
314 for template in self.browse(cr, uid, ids, context=context):
315 src_obj = template.model_id.model
316 model_data_id = data_obj._get_id(cr, uid, 'mail', 'email_compose_message_wizard_form')
317 res_id = data_obj.browse(cr, uid, model_data_id, context=context).res_id
318 button_name = _('Send Mail (%s)') % template.name
319 act_id = action_obj.create(cr, SUPERUSER_ID, {
321 'type': 'ir.actions.act_window',
322 'res_model': 'mail.compose.message',
323 'src_model': src_obj,
325 'context': "{'default_composition_mode': 'mass_mail', 'default_template_id' : %d, 'default_use_template': True}" % (template.id),
326 'view_mode':'form,tree',
331 ir_values_id = self.pool.get('ir.values').create(cr, SUPERUSER_ID, {
334 'key2': 'client_action_multi',
335 'value': "ir.actions.act_window,%s" % act_id,
340 'ref_ir_act_window': act_id,
341 'ref_ir_value': ir_values_id,
346 def unlink_action(self, cr, uid, ids, context=None):
347 for template in self.browse(cr, uid, ids, context=context):
349 if template.ref_ir_act_window:
350 self.pool.get('ir.actions.act_window').unlink(cr, SUPERUSER_ID, template.ref_ir_act_window.id, context)
351 if template.ref_ir_value:
352 ir_values_obj = self.pool.get('ir.values')
353 ir_values_obj.unlink(cr, SUPERUSER_ID, template.ref_ir_value.id, context)
355 raise osv.except_osv(_("Warning"), _("Deletion of the action record failed."))
358 def unlink(self, cr, uid, ids, context=None):
359 self.unlink_action(cr, uid, ids, context=context)
360 return super(email_template, self).unlink(cr, uid, ids, context=context)
362 def copy(self, cr, uid, id, default=None, context=None):
363 template = self.browse(cr, uid, id, context=context)
364 default = dict(default or {},
365 name=_("%s (copy)") % template.name)
366 return super(email_template, self).copy(cr, uid, id, default, context)
368 def build_expression(self, field_name, sub_field_name, null_value):
369 """Returns a placeholder expression for use in a template field,
370 based on the values provided in the placeholder assistant.
372 :param field_name: main field name
373 :param sub_field_name: sub field name (M2O)
374 :param null_value: default value if the target value is empty
375 :return: final placeholder expression
379 expression = "${object." + field_name
381 expression += "." + sub_field_name
383 expression += " or '''%s'''" % null_value
387 def onchange_sub_model_object_value_field(self, cr, uid, ids, model_object_field, sub_model_object_field=False, null_value=None, context=None):
391 'sub_model_object_field': False,
394 if model_object_field:
395 fields_obj = self.pool.get('ir.model.fields')
396 field_value = fields_obj.browse(cr, uid, model_object_field, context)
397 if field_value.ttype in ['many2one', 'one2many', 'many2many']:
398 res_ids = self.pool.get('ir.model').search(cr, uid, [('model', '=', field_value.relation)], context=context)
399 sub_field_value = False
400 if sub_model_object_field:
401 sub_field_value = fields_obj.browse(cr, uid, sub_model_object_field, context)
404 'sub_object': res_ids[0],
405 'copyvalue': self.build_expression(field_value.name, sub_field_value and sub_field_value.name or False, null_value or False),
406 'sub_model_object_field': sub_model_object_field or False,
407 'null_value': null_value or False
411 'copyvalue': self.build_expression(field_value.name, False, null_value or False),
412 'null_value': null_value or False
414 return {'value': result}
416 def generate_recipients_batch(self, cr, uid, results, template_id, res_ids, context=None):
417 """Generates the recipients of the template. Default values can ben generated
418 instead of the template values if requested by template or context.
419 Emails (email_to, email_cc) can be transformed into partners if requested
423 template = self.browse(cr, uid, template_id, context=context)
425 if template.use_default_to or context.get('tpl_force_default_to'):
426 ctx = dict(context, thread_model=template.model)
427 default_recipients = self.pool['mail.thread'].message_get_default_recipients(cr, uid, res_ids, context=ctx)
428 for res_id, recipients in default_recipients.iteritems():
429 results[res_id].pop('partner_to', None)
430 results[res_id].update(recipients)
432 for res_id, values in results.iteritems():
433 partner_ids = values.get('partner_ids', list())
434 if context and context.get('tpl_partners_only'):
435 mails = tools.email_split(values.pop('email_to', '')) + tools.email_split(values.pop('email_cc', ''))
437 partner_id = self.pool.get('res.partner').find_or_create(cr, uid, mail, context=context)
438 partner_ids.append(partner_id)
439 partner_to = values.pop('partner_to', '')
441 # placeholders could generate '', 3, 2 due to some empty field values
442 tpl_partner_ids = [int(pid) for pid in partner_to.split(',') if pid]
443 partner_ids += self.pool['res.partner'].exists(cr, SUPERUSER_ID, tpl_partner_ids, context=context)
444 results[res_id]['partner_ids'] = partner_ids
447 def generate_email_batch(self, cr, uid, template_id, res_ids, context=None, fields=None):
448 """Generates an email from the template for given the given model based on
449 records given by res_ids.
451 :param template_id: id of the template to render.
452 :param res_id: id of the record to use for rendering the template (model
453 is taken from template definition)
454 :returns: a dict containing all relevant fields for creating a new
455 mail.mail entry, with one extra key ``attachments``, in the
456 format [(report_name, data)] where data is base64 encoded.
461 fields = ['subject', 'body_html', 'email_from', 'email_to', 'partner_to', 'email_cc', 'reply_to']
463 report_xml_pool = self.pool.get('ir.actions.report.xml')
464 res_ids_to_templates = self.get_email_template_batch(cr, uid, template_id, res_ids, context)
466 # templates: res_id -> template; template -> res_ids
467 templates_to_res_ids = {}
468 for res_id, template in res_ids_to_templates.iteritems():
469 templates_to_res_ids.setdefault(template, []).append(res_id)
472 for template, template_res_ids in templates_to_res_ids.iteritems():
473 # generate fields value for all res_ids linked to the current template
475 generated_field_values = self.render_template_batch(
476 cr, uid, getattr(template, field), template.model, template_res_ids,
477 post_process=(field == 'body_html'),
479 for res_id, field_value in generated_field_values.iteritems():
480 results.setdefault(res_id, dict())[field] = field_value
482 results = self.generate_recipients_batch(cr, uid, results, template.id, template_res_ids, context=context)
483 # update values for all res_ids
484 for res_id in template_res_ids:
485 values = results[res_id]
486 # body: add user signature, sanitize
487 if 'body_html' in fields and template.user_signature:
488 signature = self.pool.get('res.users').browse(cr, uid, uid, context).signature
489 values['body_html'] = tools.append_content_to_html(values['body_html'], signature, plaintext=False)
490 if values.get('body_html'):
491 values['body'] = tools.html_sanitize(values['body_html'])
494 mail_server_id=template.mail_server_id.id or False,
495 auto_delete=template.auto_delete,
496 model=template.model,
497 res_id=res_id or False,
498 attachment_ids=[attach.id for attach in template.attachment_ids],
501 # Add report in attachments: generate once for all template_res_ids
502 if template.report_template:
503 for res_id in template_res_ids:
505 report_name = self.render_template(cr, uid, template.report_name, template.model, res_id, context=context)
506 report = report_xml_pool.browse(cr, uid, template.report_template.id, context)
507 report_service = report.report_name
508 # Ensure report is rendered using template's language
511 ctx['lang'] = self.render_template_batch(cr, uid, template.lang, template.model, [res_id], context)[res_id] # take 0 ?
513 if report.report_type in ['qweb-html', 'qweb-pdf']:
514 result, format = self.pool['report'].get_pdf(cr, uid, [res_id], report_service, context=ctx), 'pdf'
516 result, format = openerp.report.render_report(cr, uid, [res_id], report_service, {'model': template.model}, ctx)
518 # TODO in trunk, change return format to binary to match message_post expected format
519 result = base64.b64encode(result)
521 report_name = 'report.' + report_service
523 if not report_name.endswith(ext):
525 attachments.append((report_name, result))
526 results[res_id]['attachments'] = attachments
530 @api.cr_uid_id_context
531 def send_mail(self, cr, uid, template_id, res_id, force_send=False, raise_exception=False, context=None):
532 """Generates a new mail message for the given template and record,
533 and schedules it for delivery through the ``mail`` module's scheduler.
535 :param int template_id: id of the template to render
536 :param int res_id: id of the record to render the template with
537 (model is taken from the template)
538 :param bool force_send: if True, the generated mail.message is
539 immediately sent after being created, as if the scheduler
540 was executed for this message only.
541 :returns: id of the mail.message that was created
545 mail_mail = self.pool.get('mail.mail')
546 ir_attachment = self.pool.get('ir.attachment')
548 # create a mail_mail based on values, without attachments
549 values = self.generate_email(cr, uid, template_id, res_id, context=context)
550 if not values.get('email_from'):
551 raise osv.except_osv(_('Warning!'), _("Sender email is missing or empty after template rendering. Specify one to deliver your message"))
552 values['recipient_ids'] = [(4, pid) for pid in values.get('partner_ids', list())]
553 attachment_ids = values.pop('attachment_ids', [])
554 attachments = values.pop('attachments', [])
555 msg_id = mail_mail.create(cr, uid, values, context=context)
556 mail = mail_mail.browse(cr, uid, msg_id, context=context)
559 for attachment in attachments:
561 'name': attachment[0],
562 'datas_fname': attachment[0],
563 'datas': attachment[1],
564 'res_model': 'mail.message',
565 'res_id': mail.mail_message_id.id,
567 context = dict(context)
568 context.pop('default_type', None)
569 attachment_ids.append(ir_attachment.create(cr, uid, attachment_data, context=context))
571 values['attachment_ids'] = [(6, 0, attachment_ids)]
572 mail_mail.write(cr, uid, msg_id, {'attachment_ids': [(6, 0, attachment_ids)]}, context=context)
575 mail_mail.send(cr, uid, [msg_id], raise_exception=raise_exception, context=context)
578 # Compatibility method
579 def render_template(self, cr, uid, template, model, res_id, context=None):
580 return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
582 def get_email_template(self, cr, uid, template_id=False, record_id=None, context=None):
583 return self.get_email_template_batch(cr, uid, template_id, [record_id], context)[record_id]
585 def generate_email(self, cr, uid, template_id, res_id, context=None):
586 return self.generate_email_batch(cr, uid, template_id, [res_id], context)[res_id]
588 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: