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