401 lines
21 KiB
Python
401 lines
21 KiB
Python
# -*- coding: utf-8 -*-
|
|
##############################################################################
|
|
#
|
|
# OpenERP, Open Source Management Solution
|
|
# Copyright (C) 2009 Sharoon Thomas
|
|
# Copyright (C) 2010-Today OpenERP SA (<http://www.openerp.com>)
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
#
|
|
##############################################################################
|
|
|
|
import base64
|
|
import logging
|
|
|
|
import netsvc
|
|
from osv import osv
|
|
from osv import fields
|
|
import tools
|
|
from tools.translate import _
|
|
from urllib import quote as quote
|
|
|
|
try:
|
|
from mako.template import Template as MakoTemplate
|
|
except ImportError:
|
|
logging.getLogger('init').warning("email_template: mako templates not available, templating features will not work!")
|
|
|
|
class email_template(osv.osv):
|
|
"Templates for sending email"
|
|
_inherit = 'mail.message'
|
|
_name = "email.template"
|
|
_description = 'Email Templates'
|
|
_rec_name = 'name' # override mail.message's behavior
|
|
|
|
def render_template(self, cr, uid, template, model, res_id, context=None):
|
|
"""Render the given template text, replace mako expressions ``${expr}``
|
|
with the result of evaluating these expressions with
|
|
an evaluation context containing:
|
|
|
|
* ``user``: browse_record of the current user
|
|
* ``object``: browse_record of the document record this mail is
|
|
related to
|
|
* ``context``: the context passed to the mail composition wizard
|
|
|
|
:param str template: the template text to render
|
|
:param str model: model name of the document record this mail is related to.
|
|
:param int res_id: id of the document record this mail is related to.
|
|
"""
|
|
if not template: return u""
|
|
try:
|
|
template = tools.ustr(template)
|
|
record = None
|
|
if res_id:
|
|
record = self.pool.get(model).browse(cr, uid, res_id, context=context)
|
|
user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
|
|
result = MakoTemplate(template).render_unicode(object=record,
|
|
user=user,
|
|
# context kw would clash with mako internals
|
|
ctx=context,
|
|
quote=quote,
|
|
format_exceptions=True)
|
|
if result == u'False':
|
|
result = u''
|
|
return result
|
|
except Exception:
|
|
logging.exception("failed to render mako template value %r", template)
|
|
return u""
|
|
|
|
def get_email_template(self, cr, uid, template_id=False, record_id=None, context=None):
|
|
if context is None:
|
|
context = {}
|
|
if not template_id:
|
|
return False
|
|
template = self.browse(cr, uid, template_id, context)
|
|
lang = self.render_template(cr, uid, template.lang, template.model, record_id, context)
|
|
if lang:
|
|
# Use translated template if necessary
|
|
ctx = context.copy()
|
|
ctx['lang'] = lang
|
|
template = self.browse(cr, uid, template.id, ctx)
|
|
else:
|
|
template = self.browse(cr, uid, int(template_id), context)
|
|
return template
|
|
|
|
def onchange_model_id(self, cr, uid, ids, model_id, context=None):
|
|
mod_name = False
|
|
if model_id:
|
|
mod_name = self.pool.get('ir.model').browse(cr, uid, model_id, context).model
|
|
return {'value':{'model': mod_name}}
|
|
|
|
_columns = {
|
|
'name': fields.char('Name', size=250),
|
|
'model_id': fields.many2one('ir.model', 'Related document model'),
|
|
'lang': fields.char('Language Selection', size=250,
|
|
help="Optional translation language (ISO code) to select when sending out an email. "
|
|
"If not set, the english version will be used. "
|
|
"This should usually be a placeholder expression "
|
|
"that provides the appropriate language code, e.g. "
|
|
"${object.partner_id.lang.code}."),
|
|
'user_signature': fields.boolean('Add Signature',
|
|
help="If checked, the user's signature will be appended to the text version "
|
|
"of the message"),
|
|
'report_name': fields.char('Report Filename', size=200, translate=True,
|
|
help="Name to use for the generated report file (may contain placeholders)\n"
|
|
"The extension can be omitted and will then come from the report type."),
|
|
'report_template':fields.many2one('ir.actions.report.xml', 'Optional report to print and attach'),
|
|
'ref_ir_act_window':fields.many2one('ir.actions.act_window', 'Sidebar action', readonly=True,
|
|
help="Sidebar action to make this template available on records "
|
|
"of the related document model"),
|
|
'ref_ir_value':fields.many2one('ir.values', 'Sidebar button', readonly=True,
|
|
help="Sidebar button to open the sidebar action"),
|
|
'track_campaign_item': fields.boolean('Resource Tracking',
|
|
help="Enable this is you wish to include a special tracking marker "
|
|
"in outgoing emails so you can identify replies and link "
|
|
"them back to the corresponding resource record. "
|
|
"This is useful for CRM leads for example"),
|
|
|
|
# Overridden mail.message.common fields for technical reasons:
|
|
'model': fields.related('model_id','model', type='char', string='Related Document model',
|
|
size=128, select=True, store=True, readonly=True),
|
|
# we need a separate m2m table to avoid ID collisions with the original mail.message entries
|
|
'attachment_ids': fields.many2many('ir.attachment', 'email_template_attachment_rel', 'email_template_id',
|
|
'attachment_id', 'Files to attach',
|
|
help="You may attach files to this template, to be added to all "
|
|
"emails created from this template"),
|
|
|
|
# Overridden mail.message.common fields to make tooltips more appropriate:
|
|
'subject':fields.char('Subject', size=512, translate=True, help="Subject (placeholders may be used here)",),
|
|
'email_from': fields.char('From', size=128, help="Sender address (placeholders may be used here)"),
|
|
'email_to': fields.char('To', size=256, help="Comma-separated recipient addresses (placeholders may be used here)"),
|
|
'email_cc': fields.char('Cc', size=256, help="Carbon copy recipients (placeholders may be used here)"),
|
|
'email_bcc': fields.char('Bcc', size=256, help="Blind carbon copy recipients (placeholders may be used here)"),
|
|
'reply_to': fields.char('Reply-To', size=250, help="Preferred response address (placeholders may be used here)"),
|
|
'mail_server_id': fields.many2one('ir.mail_server', 'Outgoing Mail Server', readonly=False,
|
|
help="Optional preferred server for outgoing mails. If not set, the highest "
|
|
"priority one will be used."),
|
|
'body_text': fields.text('Text contents', translate=True, help="Plaintext version of the message (placeholders may be used here)"),
|
|
'body_html': fields.text('Rich-text contents', help="Rich-text/HTML version of the message (placeholders may be used here)"),
|
|
'message_id': fields.char('Message-Id', size=256, help="Message-ID SMTP header to use in outgoing messages based on this template. "
|
|
"Please note that this overrides the 'Resource Tracking' option, "
|
|
"so if you simply need to track replies to outgoing emails, enable "
|
|
"that option instead.\n"
|
|
"Placeholders must be used here, as this value always needs to be unique!"),
|
|
|
|
# Fake fields used to implement the placeholder assistant
|
|
'model_object_field': fields.many2one('ir.model.fields', string="Field",
|
|
help="Select target field from the related document model.\n"
|
|
"If it is a relationship field you will be able to select "
|
|
"a target field at the destination of the relationship."),
|
|
'sub_object': fields.many2one('ir.model', 'Sub-model', readonly=True,
|
|
help="When a relationship field is selected as first field, "
|
|
"this field shows the document model the relationship goes to."),
|
|
'sub_model_object_field': fields.many2one('ir.model.fields', 'Sub-field',
|
|
help="When a relationship field is selected as first field, "
|
|
"this field lets you select the target field within the "
|
|
"destination document model (sub-model)."),
|
|
'null_value': fields.char('Null value', help="Optional value to use if the target field is empty", size=128),
|
|
'copyvalue': fields.char('Expression', size=256, help="Final placeholder expression, to be copy-pasted in the desired template field."),
|
|
}
|
|
|
|
_defaults = {
|
|
'track_campaign_item': True
|
|
}
|
|
|
|
def create_action(self, cr, uid, ids, context=None):
|
|
vals = {}
|
|
action_obj = self.pool.get('ir.actions.act_window')
|
|
data_obj = self.pool.get('ir.model.data')
|
|
for template in self.browse(cr, uid, ids, context=context):
|
|
src_obj = template.model_id.model
|
|
model_data_id = data_obj._get_id(cr, uid, 'mail', 'email_compose_message_wizard_form')
|
|
res_id = data_obj.browse(cr, uid, model_data_id, context=context).res_id
|
|
button_name = _('Send Mail (%s)') % template.name
|
|
vals['ref_ir_act_window'] = action_obj.create(cr, uid, {
|
|
'name': button_name,
|
|
'type': 'ir.actions.act_window',
|
|
'res_model': 'mail.compose.message',
|
|
'src_model': src_obj,
|
|
'view_type': 'form',
|
|
'context': "{'mail.compose.message.mode':'mass_mail', 'mail.compose.template_id' : %d}" % (template.id),
|
|
'view_mode':'form,tree',
|
|
'view_id': res_id,
|
|
'target': 'new',
|
|
'auto_refresh':1
|
|
}, context)
|
|
vals['ref_ir_value'] = self.pool.get('ir.values').create(cr, uid, {
|
|
'name': button_name,
|
|
'model': src_obj,
|
|
'key2': 'client_action_multi',
|
|
'value': "ir.actions.act_window," + str(vals['ref_ir_act_window']),
|
|
'object': True,
|
|
}, context)
|
|
self.write(cr, uid, ids, {
|
|
'ref_ir_act_window': vals.get('ref_ir_act_window',False),
|
|
'ref_ir_value': vals.get('ref_ir_value',False),
|
|
}, context)
|
|
return True
|
|
|
|
def unlink_action(self, cr, uid, ids, context=None):
|
|
for template in self.browse(cr, uid, ids, context=context):
|
|
try:
|
|
if template.ref_ir_act_window:
|
|
self.pool.get('ir.actions.act_window').unlink(cr, uid, template.ref_ir_act_window.id, context)
|
|
if template.ref_ir_value:
|
|
ir_values_obj = self.pool.get('ir.values')
|
|
ir_values_obj.unlink(cr, uid, template.ref_ir_value.id, context)
|
|
except:
|
|
raise osv.except_osv(_("Warning"), _("Deletion of the action record failed."))
|
|
return True
|
|
|
|
def unlink(self, cr, uid, ids, context=None):
|
|
self.unlink_action(cr, uid, ids, context=context)
|
|
return super(email_template, self).unlink(cr, uid, ids, context=context)
|
|
|
|
def copy(self, cr, uid, id, default=None, context=None):
|
|
template = self.browse(cr, uid, id, context=context)
|
|
if default is None:
|
|
default = {}
|
|
default = default.copy()
|
|
default['name'] = template.name + _('(copy)')
|
|
return super(email_template, self).copy(cr, uid, id, default, context)
|
|
|
|
def build_expression(self, field_name, sub_field_name, null_value):
|
|
"""Returns a placeholder expression for use in a template field,
|
|
based on the values provided in the placeholder assistant.
|
|
|
|
:param field_name: main field name
|
|
:param sub_field_name: sub field name (M2O)
|
|
:param null_value: default value if the target value is empty
|
|
:return: final placeholder expression
|
|
"""
|
|
expression = ''
|
|
if field_name:
|
|
expression = "${object." + field_name
|
|
if sub_field_name:
|
|
expression += "." + sub_field_name
|
|
if null_value:
|
|
expression += " or '''%s'''" % null_value
|
|
expression += "}"
|
|
return expression
|
|
|
|
def onchange_sub_model_object_value_field(self, cr, uid, ids, model_object_field, sub_model_object_field=False, null_value=None, context=None):
|
|
result = {
|
|
'sub_object': False,
|
|
'copyvalue': False,
|
|
'sub_model_object_field': False,
|
|
'null_value': False
|
|
}
|
|
if model_object_field:
|
|
fields_obj = self.pool.get('ir.model.fields')
|
|
field_value = fields_obj.browse(cr, uid, model_object_field, context)
|
|
if field_value.ttype in ['many2one', 'one2many', 'many2many']:
|
|
res_ids = self.pool.get('ir.model').search(cr, uid, [('model', '=', field_value.relation)], context=context)
|
|
sub_field_value = False
|
|
if sub_model_object_field:
|
|
sub_field_value = fields_obj.browse(cr, uid, sub_model_object_field, context)
|
|
if res_ids:
|
|
result.update({
|
|
'sub_object': res_ids[0],
|
|
'copyvalue': self.build_expression(field_value.name, sub_field_value and sub_field_value.name or False, null_value or False),
|
|
'sub_model_object_field': sub_model_object_field or False,
|
|
'null_value': null_value or False
|
|
})
|
|
else:
|
|
result.update({
|
|
'copyvalue': self.build_expression(field_value.name, False, null_value or False),
|
|
'null_value': null_value or False
|
|
})
|
|
return {'value':result}
|
|
|
|
|
|
def generate_email(self, cr, uid, template_id, res_id, context=None):
|
|
"""Generates an email from the template for given (model, res_id) pair.
|
|
|
|
:param template_id: id of the template to render.
|
|
:param res_id: id of the record to use for rendering the template (model
|
|
is taken from template definition)
|
|
:returns: a dict containing all relevant fields for creating a new
|
|
mail.message entry, with the addition one additional
|
|
special key ``attachments`` containing a list of
|
|
"""
|
|
if context is None:
|
|
context = {}
|
|
values = {
|
|
'subject': False,
|
|
'body_text': False,
|
|
'body_html': False,
|
|
'email_from': False,
|
|
'email_to': False,
|
|
'email_cc': False,
|
|
'email_bcc': False,
|
|
'reply_to': False,
|
|
'auto_delete': False,
|
|
'model': False,
|
|
'res_id': False,
|
|
'mail_server_id': False,
|
|
'attachments': False,
|
|
'attachment_ids': False,
|
|
'message_id': False,
|
|
'state': 'outgoing',
|
|
'subtype': 'plain',
|
|
}
|
|
if not template_id:
|
|
return values
|
|
|
|
report_xml_pool = self.pool.get('ir.actions.report.xml')
|
|
template = self.get_email_template(cr, uid, template_id, res_id, context)
|
|
|
|
for field in ['subject', 'body_text', 'body_html', 'email_from',
|
|
'email_to', 'email_cc', 'email_bcc', 'reply_to',
|
|
'message_id']:
|
|
values[field] = self.render_template(cr, uid, getattr(template, field),
|
|
template.model, res_id, context=context) \
|
|
or False
|
|
|
|
if values['body_html']:
|
|
values.update(subtype='html')
|
|
|
|
if template.user_signature:
|
|
signature = self.pool.get('res.users').browse(cr, uid, uid, context).signature
|
|
values['body_text'] += '\n\n' + signature
|
|
|
|
values.update(mail_server_id = template.mail_server_id.id or False,
|
|
auto_delete = template.auto_delete,
|
|
model=template.model,
|
|
res_id=res_id or False)
|
|
|
|
attachments = {}
|
|
# Add report as a Document
|
|
if template.report_template:
|
|
report_name = template.report_name
|
|
report_service = 'report.' + report_xml_pool.browse(cr, uid, template.report_template.id, context).report_name
|
|
# Ensure report is rendered using template's language
|
|
ctx = context.copy()
|
|
if template.lang:
|
|
ctx['lang'] = self.render_template(cr, uid, template.lang, template.model, res_id, context)
|
|
service = netsvc.LocalService(report_service)
|
|
(result, format) = service.create(cr, uid, [res_id], {'model': template.model}, ctx)
|
|
result = base64.b64encode(result)
|
|
if not report_name:
|
|
report_name = report_service
|
|
ext = "." + format
|
|
if not report_name.endswith(ext):
|
|
report_name += ext
|
|
attachments[report_name] = result
|
|
|
|
# Add document attachments
|
|
for attach in template.attachment_ids:
|
|
# keep the bytes as fetched from the db, base64 encoded
|
|
attachments[attach.datas_fname] = attach.datas
|
|
|
|
values['attachments'] = attachments
|
|
return values
|
|
|
|
def send_mail(self, cr, uid, template_id, res_id, force_send=False, context=None):
|
|
"""Generates a new mail message for the given template and record,
|
|
and schedules it for delivery through the ``mail`` module's scheduler.
|
|
|
|
:param int template_id: id of the template to render
|
|
:param int res_id: id of the record to render the template with
|
|
(model is taken from the template)
|
|
:param bool force_send: if True, the generated mail.message is
|
|
immediately sent after being created, as if the scheduler
|
|
was executed for this message only.
|
|
:returns: id of the mail.message that was created
|
|
"""
|
|
mail_message = self.pool.get('mail.message')
|
|
ir_attachment = self.pool.get('ir.attachment')
|
|
template = self.browse(cr, uid, template_id, context)
|
|
values = self.generate_email(cr, uid, template_id, res_id, context=context)
|
|
attachments = values.pop('attachments') or {}
|
|
msg_id = mail_message.create(cr, uid, values, context=context)
|
|
# link attachments
|
|
attachment_ids = []
|
|
for fname, fcontent in attachments.iteritems():
|
|
attachment_data = {
|
|
'name': fname,
|
|
'datas_fname': fname,
|
|
'datas': fcontent,
|
|
'res_model': mail_message._name,
|
|
'res_id': msg_id,
|
|
}
|
|
if context.has_key('default_type'):
|
|
del context['default_type']
|
|
attachment_ids.append(ir_attachment.create(cr, uid, attachment_data, context=context))
|
|
if force_send:
|
|
mail_message.send(cr, uid, [msg_id], context=context)
|
|
return msg_id
|
|
|
|
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
|