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'))
  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         return result
 101
 102     def _get_composition_mode_selection(self, cr, uid, context=None):
 103         return [('comment', 'Post on a document'),
 104                 ('mass_mail', 'Email Mass Mailing'),
 105                 ('mass_post', 'Post on Multiple Documents')]
 106
 107     _columns = {
 108         'composition_mode': fields.selection(
 109             lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
 110             string='Composition mode'),
 111         'partner_ids': fields.many2many('res.partner',
 112             'mail_compose_message_res_partner_rel',
 113             'wizard_id', 'partner_id', 'Additional Contacts'),
 114         'use_active_domain': fields.boolean('Use active domain'),
 115         'active_domain': fields.char('Active domain', readonly=True),
 116         'attachment_ids': fields.many2many('ir.attachment',
 117             'mail_compose_message_ir_attachments_rel',
 118             'wizard_id', 'attachment_id', 'Attachments'),
 119         'is_log': fields.boolean('Log an Internal Note',
 120                                  help='Whether the message is an internal note (comment mode only)'),
 121         # mass mode options
 122         'notify': fields.boolean('Notify followers',
 123             help='Notify followers of the document (mass post only)'),
 124     }
 125     _defaults = {
 126         'composition_mode': 'comment',
 127         'body': lambda self, cr, uid, ctx={}: '',
 128         'subject': lambda self, cr, uid, ctx={}: False,
 129         'partner_ids': lambda self, cr, uid, ctx={}: [],
 130     }
 131
 132     def check_access_rule(self, cr, uid, ids, operation, context=None):
 133         """ Access rules of mail.compose.message:
 134             - create: if
 135                 - model, no res_id, I create a message in mass mail mode
 136             - then: fall back on mail.message acces rules
 137         """
 138         if isinstance(ids, (int, long)):
 139             ids = [ids]
 140
 141         # Author condition (CREATE (mass_mail))
 142         if operation == 'create' and uid != SUPERUSER_ID:
 143             # read mail_compose_message.ids to have their values
 144             message_values = {}
 145             cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
 146             for id, rmod, rid in cr.fetchall():
 147                 message_values[id] = {'model': rmod, 'res_id': rid}
 148             # remove from the set to check the ids that mail_compose_message accepts
 149             author_ids = [mid for mid, message in message_values.iteritems()
 150                 if message.get('model') and not message.get('res_id')]
 151             ids = list(set(ids) - set(author_ids))
 152
 153         return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
 154
 155     def _notify(self, cr, uid, newid, context=None, force_send=False, user_signature=True):
 156         """ Override specific notify method of mail.message, because we do
 157             not want that feature in the wizard. """
 158         return
 159
 160     def get_record_data(self, cr, uid, values, context=None):
 161         """ Returns a defaults-like dict with initial values for the composition
 162         wizard when sending an email related a previous email (parent_id) or
 163         a document (model, res_id). This is based on previously computed default
 164         values. """
 165         if context is None:
 166             context = {}
 167         result, subject = {}, False
 168         if values.get('parent_id'):
 169             parent = self.pool.get('mail.message').browse(cr, uid, values.get('parent_id'), context=context)
 170             result['record_name'] = parent.record_name,
 171             subject = tools.ustr(parent.subject or parent.record_name or '')
 172             if not values.get('model'):
 173                 result['model'] = parent.model
 174             if not values.get('res_id'):
 175                 result['res_id'] = parent.res_id
 176             partner_ids = values.get('partner_ids', list()) + [partner.id for partner in parent.partner_ids]
 177             if context.get('is_private') and parent.author_id:  # check message is private then add author also in partner list.
 178                 partner_ids += [parent.author_id.id]
 179             result['partner_ids'] = partner_ids
 180         elif values.get('model') and values.get('res_id'):
 181             doc_name_get = self.pool[values.get('model')].name_get(cr, uid, [values.get('res_id')], context=context)
 182             result['record_name'] = doc_name_get and doc_name_get[0][1] or ''
 183             subject = tools.ustr(result['record_name'])
 184
 185         re_prefix = _('Re:')
 186         if subject and not (subject.startswith('Re:') or subject.startswith(re_prefix)):
 187             subject = "%s %s" % (re_prefix, subject)
 188         result['subject'] = subject
 189
 190         return result
 191
 192     #------------------------------------------------------
 193     # Wizard validation and send
 194     #------------------------------------------------------
 195
 196     def send_mail(self, cr, uid, ids, context=None):
 197         """ Process the wizard content and proceed with sending the related
 198             email(s), rendering any template patterns on the fly if needed. """
 199         context = dict(context or {})
 200
 201         # clean the context (hint: mass mailing sets some default values that
 202         # could be wrongly interpreted by mail_mail)
 203         context.pop('default_email_to', None)
 204         context.pop('default_partner_ids', None)
 205
 206         for wizard in self.browse(cr, uid, ids, context=context):
 207             mass_mode = wizard.composition_mode in ('mass_mail', 'mass_post')
 208             active_model_pool = self.pool[wizard.model if wizard.model else 'mail.thread']
 209             if not hasattr(active_model_pool, 'message_post'):
 210                 context['thread_model'] = wizard.model
 211                 active_model_pool = self.pool['mail.thread']
 212
 213             # wizard works in batch mode: [res_id] or active_ids or active_domain
 214             if mass_mode and wizard.use_active_domain and wizard.model:
 215                 res_ids = self.pool[wizard.model].search(cr, uid, eval(wizard.active_domain), context=context)
 216             elif mass_mode and wizard.model and context.get('active_ids'):
 217                 res_ids = context['active_ids']
 218             else:
 219                 res_ids = [wizard.res_id]
 220
 221             sliced_res_ids = [res_ids[i:i + self._batch_size] for i in range(0, len(res_ids), self._batch_size)]
 222             for res_ids in sliced_res_ids:
 223                 all_mail_values = self.get_mail_values(cr, uid, wizard, res_ids, context=context)
 224                 for res_id, mail_values in all_mail_values.iteritems():
 225                     if wizard.composition_mode == 'mass_mail':
 226                         self.pool['mail.mail'].create(cr, uid, mail_values, context=context)
 227                     else:
 228                         subtype = 'mail.mt_comment'
 229                         if context.get('mail_compose_log') or (wizard.composition_mode == 'mass_post' and not wizard.notify):  # log a note: subtype is False
 230                             subtype = False
 231                         if wizard.composition_mode == 'mass_post':
 232                             context = dict(context,
 233                                            mail_notify_force_send=False,  # do not send emails directly but use the queue instead
 234                                            mail_create_nosubscribe=True)  # add context key to avoid subscribing the author
 235                         active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **mail_values)
 236
 237         return {'type': 'ir.actions.act_window_close'}
 238
 239     def get_mail_values(self, cr, uid, wizard, res_ids, context=None):
 240         """Generate the values that will be used by send_mail to create mail_messages
 241         or mail_mails. """
 242         results = dict.fromkeys(res_ids, False)
 243         rendered_values, default_recipients = {}, {}
 244         mass_mail_mode = wizard.composition_mode == 'mass_mail'
 245
 246         # render all template-based value at once
 247         if mass_mail_mode and wizard.model:
 248             rendered_values = self.render_message_batch(cr, uid, wizard, res_ids, context=context)
 249         # compute alias-based reply-to in batch
 250         reply_to_value = dict.fromkeys(res_ids, None)
 251         if mass_mail_mode and wizard.same_thread:
 252             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))
 253
 254         for res_id in res_ids:
 255             # static wizard (mail.message) values
 256             mail_values = {
 257                 'subject': wizard.subject,
 258                 'body': wizard.body,
 259                 'parent_id': wizard.parent_id and wizard.parent_id.id,
 260                 'partner_ids': [partner.id for partner in wizard.partner_ids],
 261                 'attachment_ids': [attach.id for attach in wizard.attachment_ids],
 262                 'author_id': wizard.author_id.id,
 263                 'email_from': wizard.email_from,
 264                 'record_name': wizard.record_name,
 265             }
 266             # mass mailing: rendering override wizard static values
 267             if mass_mail_mode and wizard.model:
 268                 # always keep a copy, reset record name (avoid browsing records)
 269                 mail_values.update(notification=True, model=wizard.model, res_id=res_id, record_name=False)
 270                 # auto deletion of mail_mail
 271                 if 'mail_auto_delete' in context:
 272                     mail_values['auto_delete'] = context.get('mail_auto_delete')
 273                 # rendered values using template
 274                 email_dict = rendered_values[res_id]
 275                 mail_values['partner_ids'] += email_dict.pop('partner_ids', [])
 276                 mail_values.update(email_dict)
 277                 if wizard.same_thread:
 278                     mail_values.pop('reply_to')
 279                     if reply_to_value.get(res_id):
 280                         mail_values['reply_to'] = reply_to_value[res_id]
 281                 if not wizard.same_thread and not mail_values.get('reply_to'):
 282                     mail_values['reply_to'] = mail_values['email_from']
 283                 # mail_mail values: body -> body_html, partner_ids -> recipient_ids
 284                 mail_values['body_html'] = mail_values.get('body', '')
 285                 mail_values['recipient_ids'] = [(4, id) for id in mail_values.pop('partner_ids', [])]
 286
 287                 # process attachments: should not be encoded before being processed by message_post / mail_mail create
 288                 mail_values['attachments'] = [(name, base64.b64decode(enc_cont)) for name, enc_cont in email_dict.pop('attachments', list())]
 289                 attachment_ids = []
 290                 for attach_id in mail_values.pop('attachment_ids'):
 291                     new_attach_id = self.pool.get('ir.attachment').copy(cr, uid, attach_id, {'res_model': self._name, 'res_id': wizard.id}, context=context)
 292                     attachment_ids.append(new_attach_id)
 293                 mail_values['attachment_ids'] = self.pool['mail.thread']._message_preprocess_attachments(
 294                     cr, uid, mail_values.pop('attachments', []),
 295                     attachment_ids, 'mail.message', 0, context=context)
 296
 297             results[res_id] = mail_values
 298         return results
 299
 300     #------------------------------------------------------
 301     # Template rendering
 302     #------------------------------------------------------
 303
 304     def render_message_batch(self, cr, uid, wizard, res_ids, context=None):
 305         """Generate template-based values of wizard, for the document records given
 306         by res_ids. This method is meant to be inherited by email_template that
 307         will produce a more complete dictionary, using Jinja2 templates.
 308
 309         Each template is generated for all res_ids, allowing to parse the template
 310         once, and render it multiple times. This is useful for mass mailing where
 311         template rendering represent a significant part of the process.
 312
 313         Default recipients are also computed, based on mail_thread method
 314         message_get_default_recipients. This allows to ensure a mass mailing has
 315         always some recipients specified.
 316
 317         :param browse wizard: current mail.compose.message browse record
 318         :param list res_ids: list of record ids
 319
 320         :return dict results: for each res_id, the generated template values for
 321                               subject, body, email_from and reply_to
 322         """
 323         subjects = self.render_template_batch(cr, uid, wizard.subject, wizard.model, res_ids, context=context)
 324         bodies = self.render_template_batch(cr, uid, wizard.body, wizard.model, res_ids, context=context, post_process=True)
 325         emails_from = self.render_template_batch(cr, uid, wizard.email_from, wizard.model, res_ids, context=context)
 326         replies_to = self.render_template_batch(cr, uid, wizard.reply_to, wizard.model, res_ids, context=context)
 327
 328         ctx = dict(context, thread_model=wizard.model)
 329         default_recipients = self.pool['mail.thread'].message_get_default_recipients(cr, uid, res_ids, context=ctx)
 330
 331         results = dict.fromkeys(res_ids, False)
 332         for res_id in res_ids:
 333             results[res_id] = {
 334                 'subject': subjects[res_id],
 335                 'body': bodies[res_id],
 336                 'email_from': emails_from[res_id],
 337                 'reply_to': replies_to[res_id],
 338             }
 339             results[res_id].update(default_recipients.get(res_id, dict()))
 340         return results
 341
 342     def render_template_batch(self, cr, uid, template, model, res_ids, context=None, post_process=False):
 343         """ Render the given template text, replace mako-like expressions ``${expr}``
 344         with the result of evaluating these expressions with an evaluation context
 345         containing:
 346
 347             * ``user``: browse_record of the current user
 348             * ``object``: browse_record of the document record this mail is
 349                           related to
 350             * ``context``: the context passed to the mail composition wizard
 351
 352         :param str template: the template text to render
 353         :param str model: model name of the document record this mail is related to
 354         :param list res_ids: list of record ids
 355         """
 356         if context is None:
 357             context = {}
 358         results = dict.fromkeys(res_ids, False)
 359
 360         for res_id in res_ids:
 361             def merge(match):
 362                 exp = str(match.group()[2:-1]).strip()
 363                 result = eval(exp, {
 364                     'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
 365                     'object': self.pool[model].browse(cr, uid, res_id, context=context),
 366                     'context': dict(context),  # copy context to prevent side-effects of eval
 367                 })
 368                 return result and tools.ustr(result) or ''
 369             results[res_id] = template and EXPRESSION_PATTERN.sub(merge, template)
 370         return results
 371
 372     # Compatibility methods
 373     def render_template(self, cr, uid, template, model, res_id, context=None):
 374         return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
 375
 376     def render_message(self, cr, uid, wizard, res_id, context=None):
 377         return self.render_message_batch(cr, uid, wizard, [res_id], context)[res_id]