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 re
  23 from openerp import tools
  24 from openerp import SUPERUSER_ID
  25 from openerp.osv import osv
  26 from openerp.osv import fields
  27 from openerp.tools.safe_eval import safe_eval as eval
  28 from openerp.tools.translate import _
  29
  30 # main mako-like expression pattern
  31 EXPRESSION_PATTERN = re.compile('(\$\{.+?\})')
  32
  33
  34 class mail_compose_message(osv.TransientModel):
  35     """ Generic message composition wizard. You may inherit from this wizard
  36         at model and view levels to provide specific features.
  37
  38         The behavior of the wizard depends on the composition_mode field:
  39         - 'reply': reply to a previous message. The wizard is pre-populated
  40             via ``get_message_data``.
  41         - 'comment': new post on a record. The wizard is pre-populated via
  42             ``get_record_data``
  43         - 'mass_mail': wizard in mass mailing mode where the mail details can
  44             contain template placeholders that will be merged with actual data
  45             before being sent to each recipient.
  46     """
  47     _name = 'mail.compose.message'
  48     _inherit = 'mail.message'
  49     _description = 'Email composition wizard'
  50     _log_access = True
  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         # get some important values from context
  71         composition_mode = context.get('default_composition_mode', context.get('mail.compose.message.mode'))
  72         model = context.get('default_model', context.get('active_model'))
  73         res_id = context.get('default_res_id', context.get('active_id'))
  74         message_id = context.get('default_parent_id', context.get('message_id', context.get('active_id')))
  75         active_ids = context.get('active_ids')
  76         if 'active_domain' in context:  # not context.get() because we want to keep global [] domains
  77             result['use_active_domain'] = True
  78             result['active_domain'] = '%s' % context.get('active_domain')
  79         else:
  80             result['active_domain'] = ''
  81
  82         # get default values according to the composition mode
  83         if composition_mode == 'reply':
  84             vals = self.get_message_data(cr, uid, message_id, context=context)
  85         elif composition_mode == 'comment' and model and res_id:
  86             vals = self.get_record_data(cr, uid, model, res_id, context=context)
  87         elif composition_mode == 'mass_mail' and model and active_ids:
  88             vals = {'model': model, 'res_id': res_id}
  89         else:
  90             vals = {'model': model, 'res_id': res_id}
  91         if composition_mode:
  92             vals['composition_mode'] = composition_mode
  93
  94         for field in vals:
  95             if field in fields:
  96                 result[field] = vals[field]
  97
  98         # TDE HACK: as mailboxes used default_model='res.users' and default_res_id=uid
  99         # (because of lack of an accessible pid), creating a message on its own
 100         # profile may crash (res_users does not allow writing on it)
 101         # Posting on its own profile works (res_users redirect to res_partner)
 102         # but when creating the mail.message to create the mail.compose.message
 103         # access rights issues may rise
 104         # We therefore directly change the model and res_id
 105         if result.get('model') == 'res.users' and result.get('res_id') == uid:
 106             result['model'] = 'res.partner'
 107             result['res_id'] = self.pool.get('res.users').browse(cr, uid, uid).partner_id.id
 108         return result
 109
 110     def _get_composition_mode_selection(self, cr, uid, context=None):
 111         return [('comment', 'Comment a document'), ('reply', 'Reply to a message'), ('mass_mail', 'Mass mailing')]
 112
 113     _columns = {
 114         'composition_mode': fields.selection(
 115             lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
 116             string='Composition mode'),
 117         'partner_ids': fields.many2many('res.partner',
 118             'mail_compose_message_res_partner_rel',
 119             'wizard_id', 'partner_id', 'Additional contacts'),
 120         'use_active_domain': fields.boolean('Use active domain'),
 121         'active_domain': fields.char('Active domain', readonly=True),
 122         'post': fields.boolean('Post a copy in the document',
 123             help='Post a copy of the message on the document communication history.'),
 124         'notify': fields.boolean('Notify followers',
 125             help='Notify followers of the document'),
 126         'same_thread': fields.boolean('Replies in the document',
 127             help='Replies to the messages will go into the selected document.'),
 128         'attachment_ids': fields.many2many('ir.attachment',
 129             'mail_compose_message_ir_attachments_rel',
 130             'wizard_id', 'attachment_id', 'Attachments'),
 131         'filter_id': fields.many2one('ir.filters', 'Filters'),
 132     }
 133
 134     _defaults = {
 135         'composition_mode': 'comment',
 136         'body': lambda self, cr, uid, ctx={}: '',
 137         'subject': lambda self, cr, uid, ctx={}: False,
 138         'partner_ids': lambda self, cr, uid, ctx={}: [],
 139         'post': lambda self, cr, uid, ctx={}: True,
 140         'same_thread': lambda self, cr, uid, ctx={}: True,
 141     }
 142
 143     def check_access_rule(self, cr, uid, ids, operation, context=None):
 144         """ Access rules of mail.compose.message:
 145             - create: if
 146                 - model, no res_id, I create a message in mass mail mode
 147             - then: fall back on mail.message acces rules
 148         """
 149         if isinstance(ids, (int, long)):
 150             ids = [ids]
 151
 152         # Author condition (CREATE (mass_mail))
 153         if operation == 'create' and uid != SUPERUSER_ID:
 154             # read mail_compose_message.ids to have their values
 155             message_values = {}
 156             cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
 157             for id, rmod, rid in cr.fetchall():
 158                 message_values[id] = {'model': rmod, 'res_id': rid}
 159             # remove from the set to check the ids that mail_compose_message accepts
 160             author_ids = [mid for mid, message in message_values.iteritems()
 161                 if message.get('model') and not message.get('res_id')]
 162             ids = list(set(ids) - set(author_ids))
 163
 164         return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
 165
 166     def _notify(self, cr, uid, newid, context=None, force_send=False, user_signature=True):
 167         """ Override specific notify method of mail.message, because we do
 168             not want that feature in the wizard. """
 169         return
 170
 171     def get_record_data(self, cr, uid, model, res_id, context=None):
 172         """ Returns a defaults-like dict with initial values for the composition
 173             wizard when sending an email related to the document record
 174             identified by ``model`` and ``res_id``.
 175
 176             :param str model: model name of the document record this mail is
 177                 related to.
 178             :param int res_id: id of the document record this mail is related to
 179         """
 180         doc_name_get = self.pool[model].name_get(cr, uid, [res_id], context=context)
 181         record_name = False
 182         if doc_name_get:
 183             record_name = doc_name_get[0][1]
 184         values = {
 185             'model': model,
 186             'res_id': res_id,
 187             'record_name': record_name,
 188         }
 189         if record_name:
 190             values['subject'] = 'Re: %s' % record_name
 191         return values
 192
 193     def get_message_data(self, cr, uid, message_id, context=None):
 194         """ Returns a defaults-like dict with initial values for the composition
 195             wizard when replying to the given message (e.g. including the quote
 196             of the initial message, and the correct recipients).
 197
 198             :param int message_id: id of the mail.message to which the user
 199                 is replying.
 200         """
 201         if not message_id:
 202             return {}
 203         if context is None:
 204             context = {}
 205         message_data = self.pool.get('mail.message').browse(cr, uid, message_id, context=context)
 206
 207         # create subject
 208         re_prefix = _('Re:')
 209         reply_subject = tools.ustr(message_data.subject or message_data.record_name or '')
 210         if not (reply_subject.startswith('Re:') or reply_subject.startswith(re_prefix)) and message_data.subject:
 211             reply_subject = "%s %s" % (re_prefix, reply_subject)
 212         # get partner_ids from original message
 213         partner_ids = [partner.id for partner in message_data.partner_ids] if message_data.partner_ids else []
 214         partner_ids += context.get('default_partner_ids', [])
 215
 216         # update the result
 217         result = {
 218             'record_name': message_data.record_name,
 219             'model': message_data.model,
 220             'res_id': message_data.res_id,
 221             'parent_id': message_data.id,
 222             'subject': reply_subject,
 223             'partner_ids': partner_ids,
 224         }
 225         return result
 226
 227     #------------------------------------------------------
 228     # Wizard validation and send
 229     #------------------------------------------------------
 230
 231     def send_mail(self, cr, uid, ids, context=None):
 232         """ Process the wizard content and proceed with sending the related
 233             email(s), rendering any template patterns on the fly if needed. """
 234         if context is None:
 235             context = {}
 236         # clean the context (hint: mass mailing sets some default values that
 237         # could be wrongly interpreted by mail_mail)
 238         context.pop('default_email_to', None)
 239         context.pop('default_partner_ids', None)
 240
 241         active_ids = context.get('active_ids')
 242         is_log = context.get('mail_compose_log', False)
 243
 244         for wizard in self.browse(cr, uid, ids, context=context):
 245             mass_mail_mode = wizard.composition_mode == 'mass_mail'
 246             active_model_pool = self.pool[wizard.model if wizard.model else 'mail.thread']
 247             if not hasattr(active_model_pool, 'message_post'):
 248                 context['thread_model'] = wizard.model
 249                 active_model_pool = self.pool['mail.thread']
 250
 251             # wizard works in batch mode: [res_id] or active_ids or active_domain
 252             if mass_mail_mode and wizard.use_active_domain and wizard.model:
 253                 res_ids = self.pool[wizard.model].search(cr, uid, eval(wizard.active_domain), context=context)
 254             elif mass_mail_mode and wizard.model and active_ids:
 255                 res_ids = active_ids
 256             else:
 257                 res_ids = [wizard.res_id]
 258
 259             all_mail_values = self.get_mail_values(cr, uid, wizard, res_ids, context=context)
 260
 261             for res_id, mail_values in all_mail_values.iteritems():
 262                 if mass_mail_mode and not wizard.post:
 263                     self.pool.get('mail.mail').create(cr, uid, mail_values, context=context)
 264                 else:
 265                     subtype = 'mail.mt_comment'
 266                     if is_log:  # log a note: subtype is False
 267                         subtype = False
 268                     elif mass_mail_mode:  # mass mail: is a log pushed to recipients unless specified, author not added
 269                         if not wizard.notify:
 270                             subtype = False
 271                         context = dict(context,
 272                                        mail_notify_force_send=False,  # do not send emails directly but use the queue instead
 273                                        mail_create_nosubscribe=True)  # add context key to avoid subscribing the author
 274                     active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **mail_values)
 275
 276         return {'type': 'ir.actions.act_window_close'}
 277
 278     def get_mail_values(self, cr, uid, wizard, res_ids, context=None):
 279         """Generate the values that will be used by send_mail to create mail_messages
 280         or mail_mails. """
 281         results = dict.fromkeys(res_ids, False)
 282         mass_mail_mode = wizard.composition_mode == 'mass_mail'
 283
 284         # render all template-based value at once
 285         if mass_mail_mode and wizard.model:
 286             rendered_values = self.render_message_batch(cr, uid, wizard, res_ids, context=context)
 287
 288         for res_id in res_ids:
 289             # static wizard (mail.message) values
 290             mail_values = {
 291                 'subject': wizard.subject,
 292                 'body': wizard.body,
 293                 'parent_id': wizard.parent_id and wizard.parent_id.id,
 294                 'partner_ids': [partner.id for partner in wizard.partner_ids],
 295                 'attachment_ids': [attach.id for attach in wizard.attachment_ids],
 296             }
 297             # mass mailing: rendering override wizard static values
 298             if mass_mail_mode and wizard.model:
 299                 email_dict = rendered_values[res_id]
 300                 mail_values['partner_ids'] += email_dict.pop('partner_ids', [])
 301                 mail_values['attachments'] = email_dict.pop('attachments', [])
 302                 attachment_ids = []
 303                 for attach_id in mail_values.pop('attachment_ids'):
 304                     new_attach_id = self.pool.get('ir.attachment').copy(cr, uid, attach_id, {'res_model': self._name, 'res_id': wizard.id}, context=context)
 305                     attachment_ids.append(new_attach_id)
 306                 mail_values['attachment_ids'] = attachment_ids
 307                 # email_from: mass mailing only can specify another email_from
 308                 if email_dict.get('email_from'):
 309                     mail_values['email_from'] = email_dict.pop('email_from')
 310                 # replies redirection: mass mailing only
 311                 if not wizard.same_thread:
 312                     mail_values['reply_to'] = email_dict.pop('reply_to')
 313                 else:
 314                     email_dict.pop('reply_to')
 315                 mail_values.update(email_dict)
 316             # mass mailing without post: mail_mail values
 317             if mass_mail_mode and not wizard.post:
 318                 if 'mail_auto_delete' in context:
 319                     mail_values['auto_delete'] = context.get('mail_auto_delete')
 320                 mail_values['body_html'] = mail_values.get('body', '')
 321                 mail_values['recipient_ids'] = [(4, id) for id in mail_values.pop('partner_ids', [])]
 322             results[res_id] = mail_values
 323         return results
 324
 325     def render_message_batch(self, cr, uid, wizard, res_ids, context=None):
 326         """Generate template-based values of wizard, for the document records given
 327         by res_ids. This method is meant to be inherited by email_template that
 328         will produce a more complete dictionary, using Jinja2 templates.
 329
 330         Each template is generated for all res_ids, allowing to parse the template
 331         once, and render it multiple times. This is useful for mass mailing where
 332         template rendering represent a significant part of the process.
 333
 334         :param browse wizard: current mail.compose.message browse record
 335         :param list res_ids: list of record ids
 336
 337         :return dict results: for each res_id, the generated template values for
 338                               subject, body, email_from and reply_to
 339         """
 340         subjects = self.render_template_batch(cr, uid, wizard.subject, wizard.model, res_ids, context)
 341         bodies = self.render_template_batch(cr, uid, wizard.body, wizard.model, res_ids, context)
 342         emails_from = self.render_template_batch(cr, uid, wizard.email_from, wizard.model, res_ids, context)
 343         replies_to = self.render_template_batch(cr, uid, wizard.reply_to, wizard.model, res_ids, context)
 344
 345         results = dict.fromkeys(res_ids, False)
 346         for res_id in res_ids:
 347             results[res_id] = {
 348                 'subject': subjects[res_id],
 349                 'body': bodies[res_id],
 350                 'email_from': emails_from[res_id],
 351                 'reply_to': replies_to[res_id],
 352             }
 353         return results
 354
 355     def render_template_batch(self, cr, uid, template, model, res_ids, context=None):
 356         """ Render the given template text, replace mako-like expressions ``${expr}``
 357         with the result of evaluating these expressions with an evaluation context
 358         containing:
 359
 360             * ``user``: browse_record of the current user
 361             * ``object``: browse_record of the document record this mail is
 362                           related to
 363             * ``context``: the context passed to the mail composition wizard
 364
 365         :param str template: the template text to render
 366         :param str model: model name of the document record this mail is related to
 367         :param list res_ids: list of record ids
 368         """
 369         if context is None:
 370             context = {}
 371         results = dict.fromkeys(res_ids, False)
 372
 373         for res_id in res_ids:
 374             def merge(match):
 375                 exp = str(match.group()[2:-1]).strip()
 376                 result = eval(exp, {
 377                     'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
 378                     'object': self.pool[model].browse(cr, uid, res_id, context=context),
 379                     'context': dict(context),  # copy context to prevent side-effects of eval
 380                 })
 381                 return result and tools.ustr(result) or ''
 382             results[res_id] = template and EXPRESSION_PATTERN.sub(merge, template)
 383         return results
 384
 385     # Compatibility methods
 386     def render_template(self, cr, uid, template, model, res_id, context=None):
 387         return self.render_template_batch(cr, uid, template, model, [res_id], context)[res_id]
 388
 389     def render_message(self, cr, uid, wizard, res_id, context=None):
 390         return self.render_message_batch(cr, uid, wizard, [res_id], context)[res_id]