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         result['active_domain'] = '%s' % context.get('active_domain', [])
  77
  78         # get default values according to the composition mode
  79         if composition_mode == 'reply':
  80             vals = self.get_message_data(cr, uid, message_id, context=context)
  81         elif composition_mode == 'comment' and model and res_id:
  82             vals = self.get_record_data(cr, uid, model, res_id, context=context)
  83         elif composition_mode == 'mass_mail' and model and active_ids:
  84             vals = {'model': model, 'res_id': res_id}
  85         else:
  86             vals = {'model': model, 'res_id': res_id}
  87         if composition_mode:
  88             vals['composition_mode'] = composition_mode
  89
  90         for field in vals:
  91             if field in fields:
  92                 result[field] = vals[field]
  93
  94         # TDE HACK: as mailboxes used default_model='res.users' and default_res_id=uid
  95         # (because of lack of an accessible pid), creating a message on its own
  96         # profile may crash (res_users does not allow writing on it)
  97         # Posting on its own profile works (res_users redirect to res_partner)
  98         # but when creating the mail.message to create the mail.compose.message
  99         # access rights issues may rise
 100         # We therefore directly change the model and res_id
 101         if result.get('model') == 'res.users' and result.get('res_id') == uid:
 102             result['model'] = 'res.partner'
 103             result['res_id'] = self.pool.get('res.users').browse(cr, uid, uid).partner_id.id
 104         return result
 105
 106     def _get_composition_mode_selection(self, cr, uid, context=None):
 107         return [('comment', 'Comment a document'), ('reply', 'Reply to a message'), ('mass_mail', 'Mass mailing')]
 108
 109     _columns = {
 110         'composition_mode': fields.selection(
 111             lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
 112             string='Composition mode'),
 113         'partner_ids': fields.many2many('res.partner',
 114             'mail_compose_message_res_partner_rel',
 115             'wizard_id', 'partner_id', 'Additional contacts'),
 116         'use_active_domain': fields.boolean('Use active domain'),
 117         'active_domain': fields.char('Active domain', readonly=True),
 118         'post': fields.boolean('Post a copy in the document',
 119             help='Post a copy of the message on the document communication history.'),
 120         'notify': fields.boolean('Notify followers',
 121             help='Notify followers of the document'),
 122         'same_thread': fields.boolean('Replies in the document',
 123             help='Replies to the messages will go into the selected document.'),
 124         'attachment_ids': fields.many2many('ir.attachment',
 125             'mail_compose_message_ir_attachments_rel',
 126             'wizard_id', 'attachment_id', 'Attachments'),
 127         'filter_id': fields.many2one('ir.filters', 'Filters'),
 128     }
 129
 130     _defaults = {
 131         'composition_mode': 'comment',
 132         'body': lambda self, cr, uid, ctx={}: '',
 133         'subject': lambda self, cr, uid, ctx={}: False,
 134         'partner_ids': lambda self, cr, uid, ctx={}: [],
 135         'post': lambda self, cr, uid, ctx={}: True,
 136         'same_thread': lambda self, cr, uid, ctx={}: True,
 137     }
 138
 139     def check_access_rule(self, cr, uid, ids, operation, context=None):
 140         """ Access rules of mail.compose.message:
 141             - create: if
 142                 - model, no res_id, I create a message in mass mail mode
 143             - then: fall back on mail.message acces rules
 144         """
 145         if isinstance(ids, (int, long)):
 146             ids = [ids]
 147
 148         # Author condition (CREATE (mass_mail))
 149         if operation == 'create' and uid != SUPERUSER_ID:
 150             # read mail_compose_message.ids to have their values
 151             message_values = {}
 152             cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
 153             for id, rmod, rid in cr.fetchall():
 154                 message_values[id] = {'model': rmod, 'res_id': rid}
 155             # remove from the set to check the ids that mail_compose_message accepts
 156             author_ids = [mid for mid, message in message_values.iteritems()
 157                 if message.get('model') and not message.get('res_id')]
 158             ids = list(set(ids) - set(author_ids))
 159
 160         return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
 161
 162     def _notify(self, cr, uid, newid, context=None, force_send=False, user_signature=True):
 163         """ Override specific notify method of mail.message, because we do
 164             not want that feature in the wizard. """
 165         return
 166
 167     def get_record_data(self, cr, uid, model, res_id, context=None):
 168         """ Returns a defaults-like dict with initial values for the composition
 169             wizard when sending an email related to the document record
 170             identified by ``model`` and ``res_id``.
 171
 172             :param str model: model name of the document record this mail is
 173                 related to.
 174             :param int res_id: id of the document record this mail is related to
 175         """
 176         doc_name_get = self.pool[model].name_get(cr, uid, [res_id], context=context)
 177         record_name = False
 178         if doc_name_get:
 179             record_name = doc_name_get[0][1]
 180         values = {
 181             'model': model,
 182             'res_id': res_id,
 183             'record_name': record_name,
 184         }
 185         if record_name:
 186             values['subject'] = 'Re: %s' % record_name
 187         return values
 188
 189     def get_message_data(self, cr, uid, message_id, context=None):
 190         """ Returns a defaults-like dict with initial values for the composition
 191             wizard when replying to the given message (e.g. including the quote
 192             of the initial message, and the correct recipients).
 193
 194             :param int message_id: id of the mail.message to which the user
 195                 is replying.
 196         """
 197         if not message_id:
 198             return {}
 199         if context is None:
 200             context = {}
 201         message_data = self.pool.get('mail.message').browse(cr, uid, message_id, context=context)
 202
 203         # create subject
 204         re_prefix = _('Re:')
 205         reply_subject = tools.ustr(message_data.subject or message_data.record_name or '')
 206         if not (reply_subject.startswith('Re:') or reply_subject.startswith(re_prefix)) and message_data.subject:
 207             reply_subject = "%s %s" % (re_prefix, reply_subject)
 208         # get partner_ids from original message
 209         partner_ids = [partner.id for partner in message_data.partner_ids] if message_data.partner_ids else []
 210         partner_ids += context.get('default_partner_ids', [])
 211
 212         # update the result
 213         result = {
 214             'record_name': message_data.record_name,
 215             'model': message_data.model,
 216             'res_id': message_data.res_id,
 217             'parent_id': message_data.id,
 218             'subject': reply_subject,
 219             'partner_ids': partner_ids,
 220         }
 221         return result
 222
 223     #------------------------------------------------------
 224     # Wizard validation and send
 225     #------------------------------------------------------
 226
 227     def send_mail(self, cr, uid, ids, context=None):
 228         """ Process the wizard content and proceed with sending the related
 229             email(s), rendering any template patterns on the fly if needed. """
 230         if context is None:
 231             context = {}
 232         ir_attachment_obj = self.pool.get('ir.attachment')
 233         active_ids = context.get('active_ids')
 234         is_log = context.get('mail_compose_log', False)
 235
 236         for wizard in self.browse(cr, uid, ids, context=context):
 237             mass_mail_mode = wizard.composition_mode == 'mass_mail'
 238             active_model_pool = self.pool[wizard.model if wizard.model else 'mail.thread']
 239             if not hasattr(active_model_pool, 'message_post'):
 240                 context['thread_model'] = wizard.model
 241                 active_model_pool = self.pool['mail.thread']
 242
 243             # wizard works in batch mode: [res_id] or active_ids or active_domain
 244             if mass_mail_mode and wizard.use_active_domain and wizard.model:
 245                 res_ids = self.pool[wizard.model].search(cr, uid, eval(wizard.active_domain), context=context)
 246             elif mass_mail_mode and wizard.model and active_ids:
 247                 res_ids = active_ids
 248             else:
 249                 res_ids = [wizard.res_id]
 250
 251             for res_id in res_ids:
 252                 # mail.message values, according to the wizard options
 253                 post_values = {
 254                     'subject': wizard.subject,
 255                     'body': wizard.body,
 256                     'parent_id': wizard.parent_id and wizard.parent_id.id,
 257                     'partner_ids': [partner.id for partner in wizard.partner_ids],
 258                     'attachment_ids': [attach.id for attach in wizard.attachment_ids],
 259                 }
 260                 # mass mailing: render and override default values
 261                 if mass_mail_mode and wizard.model:
 262                     email_dict = self.render_message(cr, uid, wizard, res_id, context=context)
 263                     post_values['partner_ids'] += email_dict.pop('partner_ids', [])
 264                     post_values['attachments'] = email_dict.pop('attachments', [])
 265                     attachment_ids = []
 266                     for attach_id in post_values.pop('attachment_ids'):
 267                         new_attach_id = ir_attachment_obj.copy(cr, uid, attach_id, {'res_model': self._name, 'res_id': wizard.id}, context=context)
 268                         attachment_ids.append(new_attach_id)
 269                     post_values['attachment_ids'] = attachment_ids
 270                     # email_from: mass mailing only can specify another email_from
 271                     if email_dict.get('email_from'):
 272                         post_values['email_from'] = email_dict.pop('email_from')
 273                     # replies redirection: mass mailing only
 274                     if not wizard.same_thread:
 275                         post_values['reply_to'] = email_dict.pop('reply_to')
 276                     else:
 277                         email_dict.pop('reply_to')
 278                     post_values.update(email_dict)
 279                 # clean the context (hint: mass mailing sets some default values that
 280                 # could be wrongly interpreted by mail_mail)
 281                 context.pop('default_email_to', None)
 282                 context.pop('default_partner_ids', None)
 283                 # post the message
 284                 if mass_mail_mode and not wizard.post:
 285                     post_values['body_html'] = post_values.get('body', '')
 286                     post_values['recipient_ids'] = [(4, id) for id in post_values.pop('partner_ids', [])]
 287                     self.pool.get('mail.mail').create(cr, uid, post_values, context=context)
 288                 else:
 289                     subtype = 'mail.mt_comment'
 290                     if is_log:  # log a note: subtype is False
 291                         subtype = False
 292                     elif mass_mail_mode:  # mass mail: is a log pushed to recipients unless specified, author not added
 293                         if not wizard.notify:
 294                             subtype = False
 295                         context = dict(context,
 296                                     mail_notify_force_send=False,  # do not send emails directly but use the queue instead
 297                                     mail_create_nosubscribe=True)  # add context key to avoid subscribing the author
 298                     active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **post_values)
 299
 300         return {'type': 'ir.actions.act_window_close'}
 301
 302     def render_message(self, cr, uid, wizard, res_id, context=None):
 303         """ Generate an email from the template for given (wizard.model, res_id)
 304             pair. This method is meant to be inherited by email_template that
 305             will produce a more complete dictionary. """
 306         return {
 307             'subject': self.render_template(cr, uid, wizard.subject, wizard.model, res_id, context),
 308             'body': self.render_template(cr, uid, wizard.body, wizard.model, res_id, context),
 309             'email_from': self.render_template(cr, uid, wizard.email_from, wizard.model, res_id, context),
 310             'reply_to': self.render_template(cr, uid, wizard.reply_to, wizard.model, res_id, context),
 311         }
 312
 313     def render_template(self, cr, uid, template, model, res_id, context=None):
 314         """ Render the given template text, replace mako-like expressions ``${expr}``
 315             with the result of evaluating these expressions with an evaluation context
 316             containing:
 317
 318                 * ``user``: browse_record of the current user
 319                 * ``object``: browse_record of the document record this mail is
 320                               related to
 321                 * ``context``: the context passed to the mail composition wizard
 322
 323             :param str template: the template text to render
 324             :param str model: model name of the document record this mail is related to.
 325             :param int res_id: id of the document record this mail is related to.
 326         """
 327         if context is None:
 328             context = {}
 329
 330         def merge(match):
 331             exp = str(match.group()[2:-1]).strip()
 332             result = eval(exp, {
 333                 'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
 334                 'object': self.pool[model].browse(cr, uid, res_id, context=context),
 335                 'context': dict(context),  # copy context to prevent side-effects of eval
 336                 })
 337             return result and tools.ustr(result) or ''
 338         return template and EXPRESSION_PATTERN.sub(merge, template)