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