f43beef566e1700983c8ce787b98fe3a7e32f6d2
[odoo/odoo.git] / addons / email_template / email_template.py
1 # -*- coding: utf-8 -*-
2 ##############################################################################
3 #
4 #    OpenERP, Open Source Management Solution
5 #    Copyright (C) 2009 Sharoon Thomas
6 #    Copyright (C) 2010-Today OpenERP SA (<http://www.openerp.com>)
7 #
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.
12 #
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.
17 #
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/>
20 #
21 ##############################################################################
22
23 import base64
24 import datetime
25 import dateutil.relativedelta as relativedelta
26 import logging
27 import lxml
28 import urlparse
29
30 import openerp
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
36
37
38 _logger = logging.getLogger(__name__)
39
40 try:
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
45     # be accessed.
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
60     )
61     mako_template_env.globals.update({
62         'str': str,
63         'quote': quote,
64         'urlencode': urlencode,
65         'datetime': datetime,
66         'len': len,
67         'abs': abs,
68         'min': min,
69         'max': max,
70         'sum': sum,
71         'filter': filter,
72         'reduce': reduce,
73         'map': map,
74         'round': round,
75
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),
80     })
81 except ImportError:
82     _logger.warning("jinja2 not available, templating features will not work!")
83
84
85 class email_template(osv.osv):
86     "Templates for sending email"
87     _name = "email.template"
88     _description = 'Email Templates'
89     _order = 'name'
90
91     def default_get(self, cr, uid, fields, context=None):
92         res = super(email_template, self).default_get(cr, uid, fields, context)
93         if res.get('model'):
94             res['model_id'] = self.pool['ir.model'].search(cr, uid, [('model', '=', res.pop('model'))], context=context)[0]
95         return res
96
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. """
100         if not html:
101             return html
102
103         # form a tree
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)
108
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)
111
112         def _process_link(url):
113             new_url = 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))
117             return new_url
118
119         # check all nodes, replace :
120         # - img src -> check URL
121         # - a href -> check URL
122         for node in root.iter():
123             if node.tag == 'a':
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')))
127
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>'):
131             html = html[5:-6]
132         return html
133
134     def render_post_process(self, cr, uid, html, context=None):
135         html = self._replace_local_links(cr, uid, html, context=context)
136         return html
137
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:
142
143                 * ``user``: browse_record of the current user
144                 * ``object``: browse_record of the document record this mail is
145                               related to
146                 * ``context``: the context passed to the mail composition wizard
147
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.
151         """
152         if context is None:
153             context = {}
154         res_ids = filter(None, res_ids)         # to avoid browsing [None] below
155         results = dict.fromkeys(res_ids, u"")
156
157         # try to load the template
158         try:
159             template = mako_template_env.from_string(tools.ustr(template))
160         except Exception:
161             _logger.exception("Failed to load template %r", template)
162             return results
163
164         # prepare template variables
165         user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
166         records = self.pool[model].browse(cr, uid, res_ids, context=context) or [None]
167         variables = {
168             'user': user,
169             'ctx': context,  # context kw would clash with mako internals
170         }
171         for record in records:
172             res_id = record.id if record else None
173             variables['object'] = record
174             try:
175                 render_result = template.render(variables)
176             except Exception:
177                 _logger.exception("Failed to render template %r using values %r" % (template, variables))
178                 render_result = u""
179             if render_result == u"False":
180                 render_result = u""
181             results[res_id] = render_result
182
183         if post_process:
184             for res_id, result in results.iteritems():
185                 results[res_id] = self.render_post_process(cr, uid, result, context=context)
186         return results
187
188     def get_email_template_batch(self, cr, uid, template_id=False, res_ids=None, context=None):
189         if context is None:
190             context = {}
191         if res_ids is None:
192             res_ids = [None]
193         results = dict.fromkeys(res_ids, False)
194
195         if not template_id:
196             return results
197         template = self.browse(cr, uid, template_id, context)
198         langs = self.render_template_batch(cr, uid, template.lang, template.model, res_ids, context)
199         for res_id, lang in langs.iteritems():
200             if lang:
201                 # Use translated template if necessary
202                 ctx = context.copy()
203                 ctx['lang'] = lang
204                 template = self.browse(cr, uid, template.id, ctx)
205             else:
206                 template = self.browse(cr, uid, int(template_id), context)
207             results[res_id] = template
208         return results
209
210     def onchange_model_id(self, cr, uid, ids, model_id, context=None):
211         mod_name = False
212         if model_id:
213             mod_name = self.pool.get('ir.model').browse(cr, uid, model_id, context).model
214         return {'value': {'model': mod_name}}
215
216     _columns = {
217         'name': fields.char('Name'),
218         'model_id': fields.many2one('ir.model', 'Applies to', help="The kind of document with with this template can be used"),
219         'model': fields.related('model_id', 'model', type='char', string='Related Document Model',
220                                  select=True, store=True, readonly=True),
221         'lang': fields.char('Language',
222                             help="Optional translation language (ISO code) to select when sending out an email. "
223                                  "If not set, the english version will be used. "
224                                  "This should usually be a placeholder expression "
225                                  "that provides the appropriate language, e.g. "
226                                  "${object.partner_id.lang}.",
227                             placeholder="${object.partner_id.lang}"),
228         'user_signature': fields.boolean('Add Signature',
229                                          help="If checked, the user's signature will be appended to the text version "
230                                               "of the message"),
231         'subject': fields.char('Subject', translate=True, help="Subject (placeholders may be used here)",),
232         'email_from': fields.char('From',
233             help="Sender address (placeholders may be used here). If not set, the default "
234                     "value will be the author's email alias if configured, or email address."),
235         'use_default_to': fields.boolean(
236             'Default recipients',
237             help="Default recipients of the record:\n"
238                  "- partner (using id on a partner or the partner_id field) OR\n"
239                  "- email (using email_from or email field)"),
240         'email_to': fields.char('To (Emails)', help="Comma-separated recipient addresses (placeholders may be used here)"),
241         'partner_to': fields.char('To (Partners)',
242             help="Comma-separated ids of recipient partners (placeholders may be used here)",
243             oldname='email_recipients'),
244         'email_cc': fields.char('Cc', help="Carbon copy recipients (placeholders may be used here)"),
245         'reply_to': fields.char('Reply-To', help="Preferred response address (placeholders may be used here)"),
246         'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing Mail Server', readonly=False,
247                                           help="Optional preferred server for outgoing mails. If not set, the highest "
248                                                "priority one will be used."),
249         'body_html': fields.html('Body', translate=True, sanitize=False, help="Rich-text/HTML version of the message (placeholders may be used here)"),
250         'report_name': fields.char('Report Filename', translate=True,
251                                    help="Name to use for the generated report file (may contain placeholders)\n"
252                                         "The extension can be omitted and will then come from the report type."),
253         'report_template': fields.many2one('ir.actions.report.xml', 'Optional report to print and attach'),
254         'ref_ir_act_window': fields.many2one('ir.actions.act_window', 'Sidebar action', readonly=True, copy=False,
255                                             help="Sidebar action to make this template available on records "
256                                                  "of the related document model"),
257         'ref_ir_value': fields.many2one('ir.values', 'Sidebar Button', readonly=True, copy=False,
258                                        help="Sidebar button to open the sidebar action"),
259         'attachment_ids': fields.many2many('ir.attachment', 'email_template_attachment_rel', 'email_template_id',
260                                            'attachment_id', 'Attachments',
261                                            help="You may attach files to this template, to be added to all "
262                                                 "emails created from this template"),
263         'auto_delete': fields.boolean('Auto Delete', help="Permanently delete this email after sending it, to save space"),
264
265         # Fake fields used to implement the placeholder assistant
266         'model_object_field': fields.many2one('ir.model.fields', string="Field",
267                                               help="Select target field from the related document model.\n"
268                                                    "If it is a relationship field you will be able to select "
269                                                    "a target field at the destination of the relationship."),
270         'sub_object': fields.many2one('ir.model', 'Sub-model', readonly=True,
271                                       help="When a relationship field is selected as first field, "
272                                            "this field shows the document model the relationship goes to."),
273         'sub_model_object_field': fields.many2one('ir.model.fields', 'Sub-field',
274                                                   help="When a relationship field is selected as first field, "
275                                                        "this field lets you select the target field within the "
276                                                        "destination document model (sub-model)."),
277         'null_value': fields.char('Default Value', help="Optional value to use if the target field is empty"),
278         'copyvalue': fields.char('Placeholder Expression', help="Final placeholder expression, to be copy-pasted in the desired template field."),
279     }
280
281     _defaults = {
282         'auto_delete': True,
283     }
284
285     def create_action(self, cr, uid, ids, context=None):
286         action_obj = self.pool.get('ir.actions.act_window')
287         data_obj = self.pool.get('ir.model.data')
288         for template in self.browse(cr, uid, ids, context=context):
289             src_obj = template.model_id.model
290             model_data_id = data_obj._get_id(cr, uid, 'mail', 'email_compose_message_wizard_form')
291             res_id = data_obj.browse(cr, uid, model_data_id, context=context).res_id
292             button_name = _('Send Mail (%s)') % template.name
293             act_id = action_obj.create(cr, SUPERUSER_ID, {
294                  'name': button_name,
295                  'type': 'ir.actions.act_window',
296                  'res_model': 'mail.compose.message',
297                  'src_model': src_obj,
298                  'view_type': 'form',
299                  'context': "{'default_composition_mode': 'mass_mail', 'default_template_id' : %d, 'default_use_template': True}" % (template.id),
300                  'view_mode':'form,tree',
301                  'view_id': res_id,
302                  'target': 'new',
303                  'auto_refresh':1
304             }, context)
305             ir_values_id = self.pool.get('ir.values').create(cr, SUPERUSER_ID, {
306                  'name': button_name,
307                  'model': src_obj,
308                  'key2': 'client_action_multi',
309                  'value': "ir.actions.act_window,%s" % act_id,
310                  'object': True,
311              }, context)
312
313             template.write({
314                 'ref_ir_act_window': act_id,
315                 'ref_ir_value': ir_values_id,
316             })
317
318         return True
319
320     def unlink_action(self, cr, uid, ids, context=None):
321         for template in self.browse(cr, uid, ids, context=context):
322             try:
323                 if template.ref_ir_act_window:
324                     self.pool.get('ir.actions.act_window').unlink(cr, SUPERUSER_ID, template.ref_ir_act_window.id, context)
325                 if template.ref_ir_value:
326                     ir_values_obj = self.pool.get('ir.values')
327                     ir_values_obj.unlink(cr, SUPERUSER_ID, template.ref_ir_value.id, context)
328             except Exception:
329                 raise osv.except_osv(_("Warning"), _("Deletion of the action record failed."))
330         return True
331
332     def unlink(self, cr, uid, ids, context=None):
333         self.unlink_action(cr, uid, ids, context=context)
334         return super(email_template, self).unlink(cr, uid, ids, context=context)
335
336     def copy(self, cr, uid, id, default=None, context=None):
337         template = self.browse(cr, uid, id, context=context)
338         default = dict(default or {},
339                        name=_("%s (copy)") % template.name)
340         return super(email_template, self).copy(cr, uid, id, default, context)
341
342     def build_expression(self, field_name, sub_field_name, null_value):
343         """Returns a placeholder expression for use in a template field,
344            based on the values provided in the placeholder assistant.
345
346           :param field_name: main field name
347           :param sub_field_name: sub field name (M2O)
348           :param null_value: default value if the target value is empty
349           :return: final placeholder expression
350         """
351         expression = ''
352         if field_name:
353             expression = "${object." + field_name
354             if sub_field_name:
355                 expression += "." + sub_field_name
356             if null_value:
357                 expression += " or '''%s'''" % null_value
358             expression += "}"
359         return expression
360
361     def onchange_sub_model_object_value_field(self, cr, uid, ids, model_object_field, sub_model_object_field=False, null_value=None, context=None):
362         result = {
363             'sub_object': False,
364             'copyvalue': False,
365             'sub_model_object_field': False,
366             'null_value': False
367             }
368         if model_object_field:
369             fields_obj = self.pool.get('ir.model.fields')
370             field_value = fields_obj.browse(cr, uid, model_object_field, context)
371             if field_value.ttype in ['many2one', 'one2many', 'many2many']:
372                 res_ids = self.pool.get('ir.model').search(cr, uid, [('model', '=', field_value.relation)], context=context)
373                 sub_field_value = False
374                 if sub_model_object_field:
375                     sub_field_value = fields_obj.browse(cr, uid, sub_model_object_field, context)
376                 if res_ids:
377                     result.update({
378                         'sub_object': res_ids[0],
379                         'copyvalue': self.build_expression(field_value.name, sub_field_value and sub_field_value.name or False, null_value or False),
380                         'sub_model_object_field': sub_model_object_field or False,
381                         'null_value': null_value or False
382                         })
383             else:
384                 result.update({
385                         'copyvalue': self.build_expression(field_value.name, False, null_value or False),
386                         'null_value': null_value or False
387                         })
388         return {'value': result}
389
390     def generate_recipients_batch(self, cr, uid, results, template_id, res_ids, context=None):
391         """Generates the recipients of the template. Default values can ben generated
392         instead of the template values if requested by template or context.
393         Emails (email_to, email_cc) can be transformed into partners if requested
394         in the context. """
395         if context is None:
396             context = {}
397         template = self.browse(cr, uid, template_id, context=context)
398
399         if template.use_default_to or context.get('tpl_force_default_to'):
400             ctx = dict(context, thread_model=template.model)
401             default_recipients = self.pool['mail.thread'].message_get_default_recipients(cr, uid, res_ids, context=ctx)
402             for res_id, recipients in default_recipients.iteritems():
403                 results[res_id].pop('partner_to', None)
404                 results[res_id].update(recipients)
405
406         for res_id, values in results.iteritems():
407             partner_ids = values.get('partner_ids', list())
408             if context and context.get('tpl_partners_only'):
409                 mails = tools.email_split(values.pop('email_to', '')) + tools.email_split(values.pop('email_cc', ''))
410                 for mail in mails:
411                     partner_id = self.pool.get('res.partner').find_or_create(cr, uid, mail, context=context)
412                     partner_ids.append(partner_id)
413             partner_to = values.pop('partner_to', '')
414             if partner_to:
415                 # placeholders could generate '', 3, 2 due to some empty field values
416                 tpl_partner_ids = [int(pid) for pid in partner_to.split(',') if pid]
417                 partner_ids += self.pool['res.partner'].exists(cr, SUPERUSER_ID, tpl_partner_ids, context=context)
418             results[res_id]['partner_ids'] = partner_ids
419         return results
420
421     def generate_email_batch(self, cr, uid, template_id, res_ids, context=None, fields=None):
422         """Generates an email from the template for given the given model based on
423         records given by res_ids.
424
425         :param template_id: id of the template to render.
426         :param res_id: id of the record to use for rendering the template (model
427                        is taken from template definition)
428         :returns: a dict containing all relevant fields for creating a new
429                   mail.mail entry, with one extra key ``attachments``, in the
430                   format [(report_name, data)] where data is base64 encoded.
431         """
432         if context is None:
433             context = {}
434         if fields is None:
435             fields = ['subject', 'body_html', 'email_from', 'email_to', 'partner_to', 'email_cc', 'reply_to']
436
437         report_xml_pool = self.pool.get('ir.actions.report.xml')
438         res_ids_to_templates = self.get_email_template_batch(cr, uid, template_id, res_ids, context)
439
440         # templates: res_id -> template; template -> res_ids
441         templates_to_res_ids = {}
442         for res_id, template in res_ids_to_templates.iteritems():
443             templates_to_res_ids.setdefault(template, []).append(res_id)
444
445         results = dict()
446         for template, template_res_ids in templates_to_res_ids.iteritems():
447             # generate fields value for all res_ids linked to the current template
448             for field in fields:
449                 generated_field_values = self.render_template_batch(
450                     cr, uid, getattr(template, field), template.model, template_res_ids,
451                     post_process=(field == 'body_html'),
452                     context=context)
453                 for res_id, field_value in generated_field_values.iteritems():
454                     results.setdefault(res_id, dict())[field] = field_value
455             # compute recipients
456             results = self.generate_recipients_batch(cr, uid, results, template.id, template_res_ids, context=context)
457             # update values for all res_ids
458             for res_id in template_res_ids:
459                 values = results[res_id]
460                 # body: add user signature, sanitize
461                 if 'body_html' in fields and template.user_signature:
462                     signature = self.pool.get('res.users').browse(cr, uid, uid, context).signature
463                     values['body_html'] = tools.append_content_to_html(values['body_html'], signature)
464                 if values.get('body_html'):
465                     values['body'] = tools.html_sanitize(values['body_html'])
466                 # technical settings
467                 values.update(
468                     mail_server_id=template.mail_server_id.id or False,
469                     auto_delete=template.auto_delete,
470                     model=template.model,
471                     res_id=res_id or False,
472                     attachment_ids=[attach.id for attach in template.attachment_ids],
473                 )
474
475             # Add report in attachments: generate once for all template_res_ids
476             if template.report_template:
477                 for res_id in template_res_ids:
478                     attachments = []
479                     report_name = self.render_template(cr, uid, template.report_name, template.model, res_id, context=context)
480                     report = report_xml_pool.browse(cr, uid, template.report_template.id, context)
481                     report_service = report.report_name
482                     # Ensure report is rendered using template's language
483                     ctx = context.copy()
484                     if template.lang:
485                         ctx['lang'] = self.render_template_batch(cr, uid, template.lang, template.model, [res_id], context)[res_id]  # take 0 ?
486
487                     if report.report_type in ['qweb-html', 'qweb-pdf']:
488                         result, format = self.pool['report'].get_pdf(cr, uid, [res_id], report_service, context=ctx), 'pdf'
489                     else:
490                         result, format = openerp.report.render_report(cr, uid, [res_id], report_service, {'model': template.model}, ctx)
491             
492                     # TODO in trunk, change return format to binary to match message_post expected format
493                     result = base64.b64encode(result)
494                     if not report_name:
495                         report_name = 'report.' + report_service
496                     ext = "." + format
497                     if not report_name.endswith(ext):
498                         report_name += ext
499                     attachments.append((report_name, result))
500                     results[res_id]['attachments'] = attachments
501
502         return results
503
504     @api.cr_uid_id_context
505     def send_mail(self, cr, uid, template_id, res_id, force_send=False, raise_exception=False, context=None):
506         """Generates a new mail message for the given template and record,
507            and schedules it for delivery through the ``mail`` module's scheduler.
508
509            :param int template_id: id of the template to render
510            :param int res_id: id of the record to render the template with
511                               (model is taken from the template)
512            :param bool force_send: if True, the generated mail.message is
513                 immediately sent after being created, as if the scheduler
514                 was executed for this message only.
515            :returns: id of the mail.message that was created
516         """
517         if context is None:
518             context = {}
519         mail_mail = self.pool.get('mail.mail')
520         ir_attachment = self.pool.get('ir.attachment')
521
522         # create a mail_mail based on values, without attachments
523         values = self.generate_email(cr, uid, template_id, res_id, context=context)
524         if not values.get('email_from'):
525             raise osv.except_osv(_('Warning!'), _("Sender email is missing or empty after template rendering. Specify one to deliver your message"))
526         values['recipient_ids'] = [(4, pid) for pid in values.get('partner_ids', list())]
527         attachment_ids = values.pop('attachment_ids', [])
528         attachments = values.pop('attachments', [])
529         msg_id = mail_mail.create(cr, uid, values, context=context)
530         mail = mail_mail.browse(cr, uid, msg_id, context=context)
531
532         # manage attachments
533         for attachment in attachments:
534             attachment_data = {
535                 'name': attachment[0],
536                 'datas_fname': attachment[0],
537                 'datas': attachment[1],
538                 'res_model': 'mail.message',
539                 'res_id': mail.mail_message_id.id,
540             }
541             context = dict(context)
542             context.pop('default_type', None)
543             attachment_ids.append(ir_attachment.create(cr, uid, attachment_data, context=context))
544         if attachment_ids:
545             values['attachment_ids'] = [(6, 0, attachment_ids)]
546             mail_mail.write(cr, uid, msg_id, {'attachment_ids': [(6, 0, attachment_ids)]}, context=context)
547
548         if force_send:
549             mail_mail.send(cr, uid, [msg_id], raise_exception=raise_exception, context=context)
550         return msg_id
551
552     # Compatibility method
553     def render_template(self, cr, uid, template, model, res_id, context=None):
554         return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
555
556     def get_email_template(self, cr, uid, template_id=False, record_id=None, context=None):
557         return self.get_email_template_batch(cr, uid, template_id, [record_id], context)[record_id]
558
559     def generate_email(self, cr, uid, template_id, res_id, context=None):
560         return self.generate_email_batch(cr, uid, template_id, [res_id], context)[res_id]
561
562 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: