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         'partner_ids': lambda self, cr, uid, ctx={}: [],
 134         'post': lambda self, cr, uid, ctx={}: True,
 135         'same_thread': lambda self, cr, uid, ctx={}: True,
 136     }
 137
 138     def check_access_rule(self, cr, uid, ids, operation, context=None):
 139         """ Access rules of mail.compose.message:
 140             - create: if
 141                 - model, no res_id, I create a message in mass mail mode
 142             - then: fall back on mail.message acces rules
 143         """
 144         if isinstance(ids, (int, long)):
 145             ids = [ids]
 146
 147         # Author condition (CREATE (mass_mail))
 148         if operation == 'create' and uid != SUPERUSER_ID:
 149             # read mail_compose_message.ids to have their values
 150             message_values = {}
 151             cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
 152             for id, rmod, rid in cr.fetchall():
 153                 message_values[id] = {'model': rmod, 'res_id': rid}
 154             # remove from the set to check the ids that mail_compose_message accepts
 155             author_ids = [mid for mid, message in message_values.iteritems()
 156                 if message.get('model') and not message.get('res_id')]
 157             ids = list(set(ids) - set(author_ids))
 158
 159         return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
 160
 161     def _notify(self, cr, uid, newid, context=None, force_send=False, user_signature=True):
 162         """ Override specific notify method of mail.message, because we do
 163             not want that feature in the wizard. """
 164         return
 165
 166     def get_record_data(self, cr, uid, model, res_id, context=None):
 167         """ Returns a defaults-like dict with initial values for the composition
 168             wizard when sending an email related to the document record
 169             identified by ``model`` and ``res_id``.
 170
 171             :param str model: model name of the document record this mail is
 172                 related to.
 173             :param int res_id: id of the document record this mail is related to
 174         """
 175         doc_name_get = self.pool[model].name_get(cr, uid, [res_id], context=context)
 176         record_name = False
 177         if doc_name_get:
 178             record_name = doc_name_get[0][1]
 179         values = {
 180             'model': model,
 181             'res_id': res_id,
 182             'record_name': record_name,
 183         }
 184         if record_name:
 185             values['subject'] = 'Re: %s' % record_name
 186         return values
 187
 188     def get_message_data(self, cr, uid, message_id, context=None):
 189         """ Returns a defaults-like dict with initial values for the composition
 190             wizard when replying to the given message (e.g. including the quote
 191             of the initial message, and the correct recipients).
 192
 193             :param int message_id: id of the mail.message to which the user
 194                 is replying.
 195         """
 196         if not message_id:
 197             return {}
 198         if context is None:
 199             context = {}
 200         message_data = self.pool.get('mail.message').browse(cr, uid, message_id, context=context)
 201
 202         # create subject
 203         re_prefix = _('Re:')
 204         reply_subject = tools.ustr(message_data.subject or message_data.record_name or '')
 205         if not (reply_subject.startswith('Re:') or reply_subject.startswith(re_prefix)) and message_data.subject:
 206             reply_subject = "%s %s" % (re_prefix, reply_subject)
 207         # get partner_ids from original message
 208         partner_ids = [partner.id for partner in message_data.partner_ids] if message_data.partner_ids else []
 209         partner_ids += context.get('default_partner_ids', [])
 210
 211         # update the result
 212         result = {
 213             'record_name': message_data.record_name,
 214             'model': message_data.model,
 215             'res_id': message_data.res_id,
 216             'parent_id': message_data.id,
 217             'subject': reply_subject,
 218             'partner_ids': partner_ids,
 219         }
 220         return result
 221
 222     #------------------------------------------------------
 223     # Wizard validation and send
 224     #------------------------------------------------------
 225
 226     def send_mail(self, cr, uid, ids, context=None):
 227         """ Process the wizard content and proceed with sending the related
 228             email(s), rendering any template patterns on the fly if needed. """
 229         if context is None:
 230             context = {}
 231         ir_attachment_obj = self.pool.get('ir.attachment')
 232         active_ids = context.get('active_ids')
 233         is_log = context.get('mail_compose_log', False)
 234
 235         for wizard in self.browse(cr, uid, ids, context=context):
 236             mass_mail_mode = wizard.composition_mode == 'mass_mail'
 237             active_model_pool = self.pool[wizard.model if wizard.model else 'mail.thread']
 238             if not hasattr(active_model_pool, 'message_post'):
 239                 context['thread_model'] = wizard.model
 240                 active_model_pool = self.pool['mail.thread']
 241
 242             # wizard works in batch mode: [res_id] or active_ids or active_domain
 243             if mass_mail_mode and wizard.use_active_domain and wizard.model:
 244                 res_ids = self.pool[wizard.model].search(cr, uid, eval(wizard.active_domain), context=context)
 245             elif mass_mail_mode and wizard.model and active_ids:
 246                 res_ids = active_ids
 247             else:
 248                 res_ids = [wizard.res_id]
 249
 250             for res_id in res_ids:
 251                 # mail.message values, according to the wizard options
 252                 post_values = {
 253                     'subject': wizard.subject,
 254                     'body': wizard.body,
 255                     'parent_id': wizard.parent_id and wizard.parent_id.id,
 256                     'partner_ids': [partner.id for partner in wizard.partner_ids],
 257                     'attachment_ids': [attach.id for attach in wizard.attachment_ids],
 258                 }
 259                 # mass mailing: render and override default values
 260                 if mass_mail_mode and wizard.model:
 261                     email_dict = self.render_message(cr, uid, wizard, res_id, context=context)
 262                     post_values['partner_ids'] += email_dict.pop('partner_ids', [])
 263                     post_values['attachments'] = email_dict.pop('attachments', [])
 264                     attachment_ids = []
 265                     for attach_id in post_values.pop('attachment_ids'):
 266                         new_attach_id = ir_attachment_obj.copy(cr, uid, attach_id, {'res_model': self._name, 'res_id': wizard.id}, context=context)
 267                         attachment_ids.append(new_attach_id)
 268                     post_values['attachment_ids'] = attachment_ids
 269                     # email_from: mass mailing only can specify another email_from
 270                     if email_dict.get('email_from'):
 271                         post_values['email_from'] = email_dict.pop('email_from')
 272                     # replies redirection: mass mailing only
 273                     if not wizard.same_thread:
 274                         post_values['reply_to'] = email_dict.pop('reply_to')
 275                     else:
 276                         email_dict.pop('reply_to')
 277                     post_values.update(email_dict)
 278                 # clean the context (hint: mass mailing sets some default values that
 279                 # could be wrongly interpreted by mail_mail)
 280                 context.pop('default_email_to', None)
 281                 context.pop('default_partner_ids', None)
 282                 # post the message
 283                 if mass_mail_mode and not wizard.post:
 284                     post_values['body_html'] = post_values.get('body', '')
 285                     post_values['recipient_ids'] = [(4, id) for id in post_values.pop('partner_ids', [])]
 286                     self.pool.get('mail.mail').create(cr, uid, post_values, context=context)
 287                 else:
 288                     subtype = 'mail.mt_comment'
 289                     if is_log:  # log a note: subtype is False
 290                         subtype = False
 291                     elif mass_mail_mode:  # mass mail: is a log pushed to recipients unless specified, author not added
 292                         if not wizard.notify:
 293                             subtype = False
 294                         context = dict(context,
 295                                     mail_notify_force_send=False,  # do not send emails directly but use the queue instead
 296                                     mail_create_nosubscribe=True)  # add context key to avoid subscribing the author
 297                     active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **post_values)
 298
 299         return {'type': 'ir.actions.act_window_close'}
 300
 301     def render_message(self, cr, uid, wizard, res_id, context=None):
 302         """ Generate an email from the template for given (wizard.model, res_id)
 303             pair. This method is meant to be inherited by email_template that
 304             will produce a more complete dictionary. """
 305         return {
 306             'subject': self.render_template(cr, uid, wizard.subject, wizard.model, res_id, context),
 307             'body': self.render_template(cr, uid, wizard.body, wizard.model, res_id, context),
 308             'email_from': self.render_template(cr, uid, wizard.email_from, wizard.model, res_id, context),
 309             'reply_to': self.render_template(cr, uid, wizard.reply_to, wizard.model, res_id, context),
 310         }
 311
 312     def render_template(self, cr, uid, template, model, res_id, context=None):
 313         """ Render the given template text, replace mako-like expressions ``${expr}``
 314             with the result of evaluating these expressions with an evaluation context
 315             containing:
 316
 317                 * ``user``: browse_record of the current user
 318                 * ``object``: browse_record of the document record this mail is
 319                               related to
 320                 * ``context``: the context passed to the mail composition wizard
 321
 322             :param str template: the template text to render
 323             :param str model: model name of the document record this mail is related to.
 324             :param int res_id: id of the document record this mail is related to.
 325         """
 326         if context is None:
 327             context = {}
 328
 329         def merge(match):
 330             exp = str(match.group()[2:-1]).strip()
 331             result = eval(exp, {
 332                 'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
 333                 'object': self.pool[model].browse(cr, uid, res_id, context=context),
 334                 'context': dict(context),  # copy context to prevent side-effects of eval
 335                 })
 336             return result and tools.ustr(result) or ''
 337         return template and EXPRESSION_PATTERN.sub(merge, template)