addons/mail/wizard/mail_compose_message.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2010-Today OpenERP SA (<http://www.openerp.com>)
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU General Public License as published by
   9 #    the Free Software Foundation, either version 3 of the License, or
  10 #    (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>
  19 #
  20 ##############################################################################
  21
  22 import base64
  23 import re
  24
  25 from openerp import tools
  26 from openerp import SUPERUSER_ID
  27 from openerp.osv import osv
  28 from openerp.osv import fields
  29 from openerp.tools.safe_eval import safe_eval as eval
  30 from openerp.tools.translate import _
  31
  32 # main mako-like expression pattern
  33 EXPRESSION_PATTERN = re.compile('(\$\{.+?\})')
  34
  35
  36 class mail_compose_message(osv.TransientModel):
  37     """ Generic message composition wizard. You may inherit from this wizard
  38         at model and view levels to provide specific features.
  39
  40         The behavior of the wizard depends on the composition_mode field:
  41         - 'comment': post on a record. The wizard is pre-populated via ``get_record_data``
  42         - 'mass_mail': wizard in mass mailing mode where the mail details can
  43             contain template placeholders that will be merged with actual data
  44             before being sent to each recipient.
  45     """
  46     _name = 'mail.compose.message'
  47     _inherit = 'mail.message'
  48     _description = 'Email composition wizard'
  49     _log_access = True
  50     _batch_size = 500
  51
  52     def default_get(self, cr, uid, fields, context=None):
  53         """ Handle composition mode. Some details about context keys:
  54             - comment: default mode, model and ID of a record the user comments
  55                 - default_model or active_model
  56                 - default_res_id or active_id
  57             - reply: active_id of a message the user replies to
  58                 - default_parent_id or message_id or active_id: ID of the
  59                     mail.message we reply to
  60                 - message.res_model or default_model
  61                 - message.res_id or default_res_id
  62             - mass_mail: model and IDs of records the user mass-mails
  63                 - active_ids: record IDs
  64                 - default_model or active_model
  65         """
  66         if context is None:
  67             context = {}
  68         result = super(mail_compose_message, self).default_get(cr, uid, fields, context=context)
  69
  70         # v6.1 compatibility mode
  71         result['composition_mode'] = result.get('composition_mode', context.get('mail.compose.message.mode', 'comment'))
  72         result['model'] = result.get('model', context.get('active_model'))
  73         result['res_id'] = result.get('res_id', context.get('active_id'))
  74         result['parent_id'] = result.get('parent_id', context.get('message_id'))
  75
  76         # default values according to composition mode - NOTE: reply is deprecated, fall back on comment
  77         if result['composition_mode'] == 'reply':
  78             result['composition_mode'] = 'comment'
  79         vals = {}
  80         if 'active_domain' in context:  # not context.get() because we want to keep global [] domains
  81             vals['use_active_domain'] = True
  82             vals['active_domain'] = '%s' % context.get('active_domain')
  83         if result['composition_mode'] == 'comment':
  84             vals.update(self.get_record_data(cr, uid, result, context=context))
  85
  86         for field in vals:
  87             if field in fields:
  88                 result[field] = vals[field]
  89
  90         # TDE HACK: as mailboxes used default_model='res.users' and default_res_id=uid
  91         # (because of lack of an accessible pid), creating a message on its own
  92         # profile may crash (res_users does not allow writing on it)
  93         # Posting on its own profile works (res_users redirect to res_partner)
  94         # but when creating the mail.message to create the mail.compose.message
  95         # access rights issues may rise
  96         # We therefore directly change the model and res_id
  97         if result['model'] == 'res.users' and result['res_id'] == uid:
  98             result['model'] = 'res.partner'
  99             result['res_id'] = self.pool.get('res.users').browse(cr, uid, uid).partner_id.id
 100
 101         if fields is not None:
 102             [result.pop(field, None) for field in result.keys() if field not in fields]
 103         return result
 104
 105     def _get_composition_mode_selection(self, cr, uid, context=None):
 106         return [('comment', 'Post on a document'),
 107                 ('mass_mail', 'Email Mass Mailing'),
 108                 ('mass_post', 'Post on Multiple Documents')]
 109
 110     _columns = {
 111         'composition_mode': fields.selection(
 112             lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
 113             string='Composition mode'),
 114         'partner_ids': fields.many2many('res.partner',
 115             'mail_compose_message_res_partner_rel',
 116             'wizard_id', 'partner_id', 'Additional Contacts'),
 117         'use_active_domain': fields.boolean('Use active domain'),
 118         'active_domain': fields.char('Active domain', readonly=True),
 119         'attachment_ids': fields.many2many('ir.attachment',
 120             'mail_compose_message_ir_attachments_rel',
 121             'wizard_id', 'attachment_id', 'Attachments'),
 122         'is_log': fields.boolean('Log an Internal Note',
 123                                  help='Whether the message is an internal note (comment mode only)'),
 124         # mass mode options
 125         'notify': fields.boolean('Notify followers',
 126             help='Notify followers of the document (mass post only)'),
 127     }
 128     _defaults = {
 129         'composition_mode': 'comment',
 130         'body': lambda self, cr, uid, ctx={}: '',
 131         'subject': lambda self, cr, uid, ctx={}: False,
 132         'partner_ids': lambda self, cr, uid, ctx={}: [],
 133     }
 134
 135     def check_access_rule(self, cr, uid, ids, operation, context=None):
 136         """ Access rules of mail.compose.message:
 137             - create: if
 138                 - model, no res_id, I create a message in mass mail mode
 139             - then: fall back on mail.message acces rules
 140         """
 141         if isinstance(ids, (int, long)):
 142             ids = [ids]
 143
 144         # Author condition (CREATE (mass_mail))
 145         if operation == 'create' and uid != SUPERUSER_ID:
 146             # read mail_compose_message.ids to have their values
 147             message_values = {}
 148             cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
 149             for id, rmod, rid in cr.fetchall():
 150                 message_values[id] = {'model': rmod, 'res_id': rid}
 151             # remove from the set to check the ids that mail_compose_message accepts
 152             author_ids = [mid for mid, message in message_values.iteritems()
 153                 if message.get('model') and not message.get('res_id')]
 154             ids = list(set(ids) - set(author_ids))
 155
 156         return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
 157
 158     def _notify(self, cr, uid, newid, context=None, force_send=False, user_signature=True):
 159         """ Override specific notify method of mail.message, because we do
 160             not want that feature in the wizard. """
 161         return
 162
 163     def get_record_data(self, cr, uid, values, context=None):
 164         """ Returns a defaults-like dict with initial values for the composition
 165         wizard when sending an email related a previous email (parent_id) or
 166         a document (model, res_id). This is based on previously computed default
 167         values. """
 168         if context is None:
 169             context = {}
 170         result, subject = {}, False
 171         if values.get('parent_id'):
 172             parent = self.pool.get('mail.message').browse(cr, uid, values.get('parent_id'), context=context)
 173             result['record_name'] = parent.record_name,
 174             subject = tools.ustr(parent.subject or parent.record_name or '')
 175             if not values.get('model'):
 176                 result['model'] = parent.model
 177             if not values.get('res_id'):
 178                 result['res_id'] = parent.res_id
 179             partner_ids = values.get('partner_ids', list()) + [partner.id for partner in parent.partner_ids]
 180             if context.get('is_private') and parent.author_id:  # check message is private then add author also in partner list.
 181                 partner_ids += [parent.author_id.id]
 182             result['partner_ids'] = partner_ids
 183         elif values.get('model') and values.get('res_id'):
 184             doc_name_get = self.pool[values.get('model')].name_get(cr, uid, [values.get('res_id')], context=context)
 185             result['record_name'] = doc_name_get and doc_name_get[0][1] or ''
 186             subject = tools.ustr(result['record_name'])
 187
 188         re_prefix = _('Re:')
 189         if subject and not (subject.startswith('Re:') or subject.startswith(re_prefix)):
 190             subject = "%s %s" % (re_prefix, subject)
 191         result['subject'] = subject
 192
 193         return result
 194
 195     #------------------------------------------------------
 196     # Wizard validation and send
 197     #------------------------------------------------------
 198
 199     def send_mail(self, cr, uid, ids, context=None):
 200         """ Process the wizard content and proceed with sending the related
 201             email(s), rendering any template patterns on the fly if needed. """
 202         context = dict(context or {})
 203
 204         # clean the context (hint: mass mailing sets some default values that
 205         # could be wrongly interpreted by mail_mail)
 206         context.pop('default_email_to', None)
 207         context.pop('default_partner_ids', None)
 208
 209         for wizard in self.browse(cr, uid, ids, context=context):
 210             mass_mode = wizard.composition_mode in ('mass_mail', 'mass_post')
 211             active_model_pool = self.pool[wizard.model if wizard.model else 'mail.thread']
 212             if not hasattr(active_model_pool, 'message_post'):
 213                 context['thread_model'] = wizard.model
 214                 active_model_pool = self.pool['mail.thread']
 215
 216             # wizard works in batch mode: [res_id] or active_ids or active_domain
 217             if mass_mode and wizard.use_active_domain and wizard.model:
 218                 res_ids = self.pool[wizard.model].search(cr, uid, eval(wizard.active_domain), context=context)
 219             elif mass_mode and wizard.model and context.get('active_ids'):
 220                 res_ids = context['active_ids']
 221             else:
 222                 res_ids = [wizard.res_id]
 223
 224             sliced_res_ids = [res_ids[i:i + self._batch_size] for i in range(0, len(res_ids), self._batch_size)]
 225             for res_ids in sliced_res_ids:
 226                 all_mail_values = self.get_mail_values(cr, uid, wizard, res_ids, context=context)
 227                 for res_id, mail_values in all_mail_values.iteritems():
 228                     if wizard.composition_mode == 'mass_mail':
 229                         self.pool['mail.mail'].create(cr, uid, mail_values, context=context)
 230                     else:
 231                         subtype = 'mail.mt_comment'
 232                         if context.get('mail_compose_log') or (wizard.composition_mode == 'mass_post' and not wizard.notify):  # log a note: subtype is False
 233                             subtype = False
 234                         if wizard.composition_mode == 'mass_post':
 235                             context = dict(context,
 236                                            mail_notify_force_send=False,  # do not send emails directly but use the queue instead
 237                                            mail_create_nosubscribe=True)  # add context key to avoid subscribing the author
 238                         active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **mail_values)
 239
 240         return {'type': 'ir.actions.act_window_close'}
 241
 242     def get_mail_values(self, cr, uid, wizard, res_ids, context=None):
 243         """Generate the values that will be used by send_mail to create mail_messages
 244         or mail_mails. """
 245         results = dict.fromkeys(res_ids, False)
 246         rendered_values, default_recipients = {}, {}
 247         mass_mail_mode = wizard.composition_mode == 'mass_mail'
 248
 249         # render all template-based value at once
 250         if mass_mail_mode and wizard.model:
 251             rendered_values = self.render_message_batch(cr, uid, wizard, res_ids, context=context)
 252         # compute alias-based reply-to in batch
 253         reply_to_value = dict.fromkeys(res_ids, None)
 254         if mass_mail_mode and not wizard.no_auto_thread:
 255             reply_to_value = self.pool['mail.thread'].message_get_reply_to(cr, uid, res_ids, default=wizard.email_from, context=dict(context, thread_model=wizard.model))
 256
 257         for res_id in res_ids:
 258             # static wizard (mail.message) values
 259             mail_values = {
 260                 'subject': wizard.subject,
 261                 'body': wizard.body,
 262                 'parent_id': wizard.parent_id and wizard.parent_id.id,
 263                 'partner_ids': [partner.id for partner in wizard.partner_ids],
 264                 'attachment_ids': [attach.id for attach in wizard.attachment_ids],
 265                 'author_id': wizard.author_id.id,
 266                 'email_from': wizard.email_from,
 267                 'record_name': wizard.record_name,
 268                 'no_auto_thread': wizard.no_auto_thread,
 269             }
 270             # mass mailing: rendering override wizard static values
 271             if mass_mail_mode and wizard.model:
 272                 # always keep a copy, reset record name (avoid browsing records)
 273                 mail_values.update(notification=True, model=wizard.model, res_id=res_id, record_name=False)
 274                 # auto deletion of mail_mail
 275                 if 'mail_auto_delete' in context:
 276                     mail_values['auto_delete'] = context.get('mail_auto_delete')
 277                 # rendered values using template
 278                 email_dict = rendered_values[res_id]
 279                 mail_values['partner_ids'] += email_dict.pop('partner_ids', [])
 280                 mail_values.update(email_dict)
 281                 if not wizard.no_auto_thread:
 282                     mail_values.pop('reply_to')
 283                     if reply_to_value.get(res_id):
 284                         mail_values['reply_to'] = reply_to_value[res_id]
 285                 if wizard.no_auto_thread and not mail_values.get('reply_to'):
 286                     mail_values['reply_to'] = mail_values['email_from']
 287                 # mail_mail values: body -> body_html, partner_ids -> recipient_ids
 288                 mail_values['body_html'] = mail_values.get('body', '')
 289                 mail_values['recipient_ids'] = [(4, id) for id in mail_values.pop('partner_ids', [])]
 290
 291                 # process attachments: should not be encoded before being processed by message_post / mail_mail create
 292                 mail_values['attachments'] = [(name, base64.b64decode(enc_cont)) for name, enc_cont in email_dict.pop('attachments', list())]
 293                 attachment_ids = []
 294                 for attach_id in mail_values.pop('attachment_ids'):
 295                     new_attach_id = self.pool.get('ir.attachment').copy(cr, uid, attach_id, {'res_model': self._name, 'res_id': wizard.id}, context=context)
 296                     attachment_ids.append(new_attach_id)
 297                 mail_values['attachment_ids'] = self.pool['mail.thread']._message_preprocess_attachments(
 298                     cr, uid, mail_values.pop('attachments', []),
 299                     attachment_ids, 'mail.message', 0, context=context)
 300
 301             results[res_id] = mail_values
 302         return results
 303
 304     #------------------------------------------------------
 305     # Template rendering
 306     #------------------------------------------------------
 307
 308     def render_message_batch(self, cr, uid, wizard, res_ids, context=None):
 309         """Generate template-based values of wizard, for the document records given
 310         by res_ids. This method is meant to be inherited by email_template that
 311         will produce a more complete dictionary, using Jinja2 templates.
 312
 313         Each template is generated for all res_ids, allowing to parse the template
 314         once, and render it multiple times. This is useful for mass mailing where
 315         template rendering represent a significant part of the process.
 316
 317         Default recipients are also computed, based on mail_thread method
 318         message_get_default_recipients. This allows to ensure a mass mailing has
 319         always some recipients specified.
 320
 321         :param browse wizard: current mail.compose.message browse record
 322         :param list res_ids: list of record ids
 323
 324         :return dict results: for each res_id, the generated template values for
 325                               subject, body, email_from and reply_to
 326         """
 327         subjects = self.render_template_batch(cr, uid, wizard.subject, wizard.model, res_ids, context=context)
 328         bodies = self.render_template_batch(cr, uid, wizard.body, wizard.model, res_ids, context=context, post_process=True)
 329         emails_from = self.render_template_batch(cr, uid, wizard.email_from, wizard.model, res_ids, context=context)
 330         replies_to = self.render_template_batch(cr, uid, wizard.reply_to, wizard.model, res_ids, context=context)
 331
 332         ctx = dict(context, thread_model=wizard.model)
 333         default_recipients = self.pool['mail.thread'].message_get_default_recipients(cr, uid, res_ids, context=ctx)
 334
 335         results = dict.fromkeys(res_ids, False)
 336         for res_id in res_ids:
 337             results[res_id] = {
 338                 'subject': subjects[res_id],
 339                 'body': bodies[res_id],
 340                 'email_from': emails_from[res_id],
 341                 'reply_to': replies_to[res_id],
 342             }
 343             results[res_id].update(default_recipients.get(res_id, dict()))
 344         return results
 345
 346     def render_template_batch(self, cr, uid, template, model, res_ids, context=None, post_process=False):
 347         """ Render the given template text, replace mako-like expressions ``${expr}``
 348         with the result of evaluating these expressions with an evaluation context
 349         containing:
 350
 351             * ``user``: browse_record of the current user
 352             * ``object``: browse_record of the document record this mail is
 353                           related to
 354             * ``context``: the context passed to the mail composition wizard
 355
 356         :param str template: the template text to render
 357         :param str model: model name of the document record this mail is related to
 358         :param list res_ids: list of record ids
 359         """
 360         if context is None:
 361             context = {}
 362         results = dict.fromkeys(res_ids, False)
 363
 364         for res_id in res_ids:
 365             def merge(match):
 366                 exp = str(match.group()[2:-1]).strip()
 367                 result = eval(exp, {
 368                     'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
 369                     'object': self.pool[model].browse(cr, uid, res_id, context=context),
 370                     'context': dict(context),  # copy context to prevent side-effects of eval
 371                 })
 372                 return result and tools.ustr(result) or ''
 373             results[res_id] = template and EXPRESSION_PATTERN.sub(merge, template)
 374         return results
 375
 376     # Compatibility methods
 377     def render_template(self, cr, uid, template, model, res_id, context=None):
 378         return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
 379
 380     def render_message(self, cr, uid, wizard, res_id, context=None):
 381         return self.render_message_batch(cr, uid, wizard, [res_id], context)[res_id]