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 ##############################################################################
28 from osv import fields
30 from tools.translate import _
31 from urllib import quote as quote
34 from mako.template import Template as MakoTemplate
36 logging.getLogger('init').warning("email_template: mako templates not available, templating features will not work!")
38 class email_template(osv.osv):
39 "Templates for sending email"
40 _inherit = 'mail.message'
41 _name = "email.template"
42 _description = 'Email Templates'
43 _rec_name = 'name' # override mail.message's behavior
45 def render_template(self, cr, uid, template, model, res_id, context=None):
46 """Render the given template text, replace mako expressions ``${expr}``
47 with the result of evaluating these expressions with
48 an evaluation context containing:
50 * ``user``: browse_record of the current user
51 * ``object``: browse_record of the document record this mail is
53 * ``context``: the context passed to the mail composition wizard
55 :param str template: the template text to render
56 :param str model: model name of the document record this mail is related to.
57 :param int res_id: id of the document record this mail is related to.
59 if not template: return u""
63 template = tools.ustr(template)
66 record = self.pool.get(model).browse(cr, uid, res_id, context=context)
67 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
68 result = MakoTemplate(template).render_unicode(object=record,
70 # context kw would clash with mako internals
73 format_exceptions=True)
74 if result == u'False':
78 logging.exception("failed to render mako template value %r", template)
81 def get_email_template(self, cr, uid, template_id=False, record_id=None, context=None):
86 template = self.browse(cr, uid, template_id, context)
87 lang = self.render_template(cr, uid, template.lang, template.model, record_id, context)
89 # Use translated template if necessary
92 template = self.browse(cr, uid, template.id, ctx)
94 template = self.browse(cr, uid, int(template_id), context)
97 def onchange_model_id(self, cr, uid, ids, model_id, context=None):
100 mod_name = self.pool.get('ir.model').browse(cr, uid, model_id, context).model
101 return {'value':{'model': mod_name}}
104 'name': fields.char('Name', size=250),
105 'model_id': fields.many2one('ir.model', 'Related document model'),
106 'lang': fields.char('Language Selection', size=250,
107 help="Optional translation language (ISO code) to select when sending out an email. "
108 "If not set, the english version will be used. "
109 "This should usually be a placeholder expression "
110 "that provides the appropriate language code, e.g. "
111 "${object.partner_id.lang.code}."),
112 'user_signature': fields.boolean('Add Signature',
113 help="If checked, the user's signature will be appended to the text version "
115 'report_name': fields.char('Report Filename', size=200, translate=True,
116 help="Name to use for the generated report file (may contain placeholders)\n"
117 "The extension can be omitted and will then come from the report type."),
118 'report_template':fields.many2one('ir.actions.report.xml', 'Optional report to print and attach'),
119 'ref_ir_act_window':fields.many2one('ir.actions.act_window', 'Sidebar action', readonly=True,
120 help="Sidebar action to make this template available on records "
121 "of the related document model"),
122 'ref_ir_value':fields.many2one('ir.values', 'Sidebar Button', readonly=True,
123 help="Sidebar button to open the sidebar action"),
124 'track_campaign_item': fields.boolean('Resource Tracking',
125 help="Enable this is you wish to include a special tracking marker "
126 "in outgoing emails so you can identify replies and link "
127 "them back to the corresponding resource record. "
128 "This is useful for CRM leads for example"),
130 # Overridden mail.message.common fields for technical reasons:
131 'model': fields.related('model_id','model', type='char', string='Related Document Model',
132 size=128, select=True, store=True, readonly=True),
133 # we need a separate m2m table to avoid ID collisions with the original mail.message entries
134 'attachment_ids': fields.many2many('ir.attachment', 'email_template_attachment_rel', 'email_template_id',
135 'attachment_id', 'Files to attach',
136 help="You may attach files to this template, to be added to all "
137 "emails created from this template"),
139 # Overridden mail.message.common fields to make tooltips more appropriate:
140 'subject':fields.char('Subject', size=512, translate=True, help="Subject (placeholders may be used here)",),
141 'email_from': fields.char('From', size=128, help="Sender address (placeholders may be used here)"),
142 'email_to': fields.char('To', size=256, help="Comma-separated recipient addresses (placeholders may be used here)"),
143 'email_cc': fields.char('Cc', size=256, help="Carbon copy recipients (placeholders may be used here)"),
144 'email_bcc': fields.char('Bcc', size=256, help="Blind carbon copy recipients (placeholders may be used here)"),
145 'reply_to': fields.char('Reply-To', size=250, help="Preferred response address (placeholders may be used here)"),
146 'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing Mail Server', readonly=False,
147 help="Optional preferred server for outgoing mails. If not set, the highest "
148 "priority one will be used."),
149 'body_text': fields.text('Text Contents', translate=True, help="Plaintext version of the message (placeholders may be used here)"),
150 'body_html': fields.text('Rich-text Contents', translate=True, help="Rich-text/HTML version of the message (placeholders may be used here)"),
151 'message_id': fields.char('Message-Id', size=256, help="Message-ID SMTP header to use in outgoing messages based on this template. "
152 "Please note that this overrides the 'Resource Tracking' option, "
153 "so if you simply need to track replies to outgoing emails, enable "
154 "that option instead.\n"
155 "Placeholders must be used here, as this value always needs to be unique!"),
157 # Fake fields used to implement the placeholder assistant
158 'model_object_field': fields.many2one('ir.model.fields', string="Field",
159 help="Select target field from the related document model.\n"
160 "If it is a relationship field you will be able to select "
161 "a target field at the destination of the relationship."),
162 'sub_object': fields.many2one('ir.model', 'Sub-model', readonly=True,
163 help="When a relationship field is selected as first field, "
164 "this field shows the document model the relationship goes to."),
165 'sub_model_object_field': fields.many2one('ir.model.fields', 'Sub-field',
166 help="When a relationship field is selected as first field, "
167 "this field lets you select the target field within the "
168 "destination document model (sub-model)."),
169 'null_value': fields.char('Null value', help="Optional value to use if the target field is empty", size=128),
170 'copyvalue': fields.char('Expression', size=256, help="Final placeholder expression, to be copy-pasted in the desired template field."),
174 'track_campaign_item': True
177 def create_action(self, cr, uid, ids, context=None):
179 action_obj = self.pool.get('ir.actions.act_window')
180 data_obj = self.pool.get('ir.model.data')
181 for template in self.browse(cr, uid, ids, context=context):
182 src_obj = template.model_id.model
183 model_data_id = data_obj._get_id(cr, uid, 'mail', 'email_compose_message_wizard_form')
184 res_id = data_obj.browse(cr, uid, model_data_id, context=context).res_id
185 button_name = _('Send Mail (%s)') % template.name
186 vals['ref_ir_act_window'] = action_obj.create(cr, uid, {
188 'type': 'ir.actions.act_window',
189 'res_model': 'mail.compose.message',
190 'src_model': src_obj,
192 'context': "{'mail.compose.message.mode':'mass_mail', 'mail.compose.template_id' : %d}" % (template.id),
193 'view_mode':'form,tree',
198 vals['ref_ir_value'] = self.pool.get('ir.values').create(cr, uid, {
201 'key2': 'client_action_multi',
202 'value': "ir.actions.act_window," + str(vals['ref_ir_act_window']),
205 self.write(cr, uid, ids, {
206 'ref_ir_act_window': vals.get('ref_ir_act_window',False),
207 'ref_ir_value': vals.get('ref_ir_value',False),
211 def unlink_action(self, cr, uid, ids, context=None):
212 for template in self.browse(cr, uid, ids, context=context):
214 if template.ref_ir_act_window:
215 self.pool.get('ir.actions.act_window').unlink(cr, uid, template.ref_ir_act_window.id, context)
216 if template.ref_ir_value:
217 ir_values_obj = self.pool.get('ir.values')
218 ir_values_obj.unlink(cr, uid, template.ref_ir_value.id, context)
220 raise osv.except_osv(_("Warning"), _("Deletion of the action record failed."))
223 def unlink(self, cr, uid, ids, context=None):
224 self.unlink_action(cr, uid, ids, context=context)
225 return super(email_template, self).unlink(cr, uid, ids, context=context)
227 def copy(self, cr, uid, id, default=None, context=None):
228 template = self.browse(cr, uid, id, context=context)
231 default = default.copy()
232 default['name'] = template.name + _('(copy)')
233 return super(email_template, self).copy(cr, uid, id, default, context)
235 def build_expression(self, field_name, sub_field_name, null_value):
236 """Returns a placeholder expression for use in a template field,
237 based on the values provided in the placeholder assistant.
239 :param field_name: main field name
240 :param sub_field_name: sub field name (M2O)
241 :param null_value: default value if the target value is empty
242 :return: final placeholder expression
246 expression = "${object." + field_name
248 expression += "." + sub_field_name
250 expression += " or '''%s'''" % null_value
254 def onchange_sub_model_object_value_field(self, cr, uid, ids, model_object_field, sub_model_object_field=False, null_value=None, context=None):
258 'sub_model_object_field': False,
261 if model_object_field:
262 fields_obj = self.pool.get('ir.model.fields')
263 field_value = fields_obj.browse(cr, uid, model_object_field, context)
264 if field_value.ttype in ['many2one', 'one2many', 'many2many']:
265 res_ids = self.pool.get('ir.model').search(cr, uid, [('model', '=', field_value.relation)], context=context)
266 sub_field_value = False
267 if sub_model_object_field:
268 sub_field_value = fields_obj.browse(cr, uid, sub_model_object_field, context)
271 'sub_object': res_ids[0],
272 'copyvalue': self.build_expression(field_value.name, sub_field_value and sub_field_value.name or False, null_value or False),
273 'sub_model_object_field': sub_model_object_field or False,
274 'null_value': null_value or False
278 'copyvalue': self.build_expression(field_value.name, False, null_value or False),
279 'null_value': null_value or False
281 return {'value':result}
284 def generate_email(self, cr, uid, template_id, res_id, context=None):
285 """Generates an email from the template for given (model, res_id) pair.
287 :param template_id: id of the template to render.
288 :param res_id: id of the record to use for rendering the template (model
289 is taken from template definition)
290 :returns: a dict containing all relevant fields for creating a new
291 mail.message entry, with the addition one additional
292 special key ``attachments`` containing a list of
305 'auto_delete': False,
308 'mail_server_id': False,
309 'attachments': False,
310 'attachment_ids': False,
318 report_xml_pool = self.pool.get('ir.actions.report.xml')
319 template = self.get_email_template(cr, uid, template_id, res_id, context)
321 for field in ['subject', 'body_text', 'body_html', 'email_from',
322 'email_to', 'email_cc', 'email_bcc', 'reply_to',
324 values[field] = self.render_template(cr, uid, getattr(template, field),
325 template.model, res_id, context=context) \
328 if values['body_html']:
329 values.update(subtype='html')
331 if template.user_signature:
332 signature = self.pool.get('res.users').browse(cr, uid, uid, context).signature
333 values['body_text'] += '\n\n' + signature
335 values.update(mail_server_id = template.mail_server_id.id or False,
336 auto_delete = template.auto_delete,
337 model=template.model,
338 res_id=res_id or False)
341 # Add report as a Document
342 if template.report_template:
343 report_name = self.render_template(cr, uid, template.report_name, template.model, res_id, context=context)
344 report_service = 'report.' + report_xml_pool.browse(cr, uid, template.report_template.id, context).report_name
345 # Ensure report is rendered using template's language
348 ctx['lang'] = self.render_template(cr, uid, template.lang, template.model, res_id, context)
349 service = netsvc.LocalService(report_service)
350 (result, format) = service.create(cr, uid, [res_id], {'model': template.model}, ctx)
351 result = base64.b64encode(result)
353 report_name = report_service
355 if not report_name.endswith(ext):
357 attachments[report_name] = result
359 # Add document attachments
360 for attach in template.attachment_ids:
361 # keep the bytes as fetched from the db, base64 encoded
362 attachments[attach.datas_fname] = attach.datas
364 values['attachments'] = attachments
367 def send_mail(self, cr, uid, template_id, res_id, force_send=False, context=None):
368 """Generates a new mail message for the given template and record,
369 and schedules it for delivery through the ``mail`` module's scheduler.
371 :param int template_id: id of the template to render
372 :param int res_id: id of the record to render the template with
373 (model is taken from the template)
374 :param bool force_send: if True, the generated mail.message is
375 immediately sent after being created, as if the scheduler
376 was executed for this message only.
377 :returns: id of the mail.message that was created
379 if context is None: context = {}
380 mail_message = self.pool.get('mail.message')
381 ir_attachment = self.pool.get('ir.attachment')
382 values = self.generate_email(cr, uid, template_id, res_id, context=context)
383 assert 'email_from' in values, 'email_from is missing or empty after template rendering, send_mail() cannot proceed'
384 attachments = values.pop('attachments') or {}
385 msg_id = mail_message.create(cr, uid, values, context=context)
388 for fname, fcontent in attachments.iteritems():
391 'datas_fname': fname,
393 'res_model': mail_message._name,
396 context.pop('default_type', None)
397 attachment_ids.append(ir_attachment.create(cr, uid, attachment_data, context=context))
399 mail_message.write(cr, uid, msg_id, {'attachment_ids': [(6, 0, attachment_ids)]}, context=context)
401 mail_message.send(cr, uid, [msg_id], context=context)
404 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: