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 from openerp import tools
  25
  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         - 'reply': reply to a previous message. The wizard is pre-populated
  42             via ``get_message_data``.
  43         - 'comment': new post on a record. The wizard is pre-populated via
  44             ``get_record_data``
  45         - 'mass_mail': wizard in mass mailing mode where the mail details can
  46             contain template placeholders that will be merged with actual data
  47             before being sent to each recipient.
  48     """
  49     _name = 'mail.compose.message'
  50     _inherit = 'mail.message'
  51     _description = 'Email composition wizard'
  52     _log_access = True
  53
  54     def default_get(self, cr, uid, fields, context=None):
  55         """ Handle composition mode. Some details about context keys:
  56             - comment: default mode, model and ID of a record the user comments
  57                 - default_model or active_model
  58                 - default_res_id or active_id
  59             - reply: active_id of a message the user replies to
  60                 - default_parent_id or message_id or active_id: ID of the
  61                     mail.message we reply to
  62                 - message.res_model or default_model
  63                 - message.res_id or default_res_id
  64             - mass_mail: model and IDs of records the user mass-mails
  65                 - active_ids: record IDs
  66                 - default_model or active_model
  67         """
  68         if context is None:
  69             context = {}
  70         result = super(mail_compose_message, self).default_get(cr, uid, fields, context=context)
  71
  72         # get some important values from context
  73         composition_mode = context.get('default_composition_mode', context.get('mail.compose.message.mode'))
  74         model = context.get('default_model', context.get('active_model'))
  75         res_id = context.get('default_res_id', context.get('active_id'))
  76         message_id = context.get('default_parent_id', context.get('message_id', context.get('active_id')))
  77         active_ids = context.get('active_ids')
  78
  79         # get default values according to the composition mode
  80         if composition_mode == 'reply':
  81             vals = self.get_message_data(cr, uid, message_id, context=context)
  82         elif composition_mode == 'comment' and model and res_id:
  83             vals = self.get_record_data(cr, uid, model, res_id, context=context)
  84         elif composition_mode == 'mass_mail' and model and active_ids:
  85             vals = {'model': model, 'res_id': res_id}
  86         else:
  87             vals = {'model': model, 'res_id': res_id}
  88         if composition_mode:
  89             vals['composition_mode'] = composition_mode
  90
  91         for field in vals:
  92             if field in fields:
  93                 result[field] = vals[field]
  94
  95         # TDE HACK: as mailboxes used default_model='res.users' and default_res_id=uid
  96         # (because of lack of an accessible pid), creating a message on its own
  97         # profile may crash (res_users does not allow writing on it)
  98         # Posting on its own profile works (res_users redirect to res_partner)
  99         # but when creating the mail.message to create the mail.compose.message
 100         # access rights issues may rise
 101         # We therefore directly change the model and res_id
 102         if result.get('model') == 'res.users' and result.get('res_id') == uid:
 103             result['model'] = 'res.partner'
 104             result['res_id'] = self.pool.get('res.users').browse(cr, uid, uid).partner_id.id
 105         return result
 106
 107     def _get_composition_mode_selection(self, cr, uid, context=None):
 108         return [('comment', 'Comment a document'), ('reply', 'Reply to a message'), ('mass_mail', 'Mass mailing')]
 109
 110     _columns = {
 111         'composition_mode': fields.selection(
 112             lambda s, *a, **k: s._get_composition_mode_selection(*a, **k),
 113             string='Composition mode'),
 114         'partner_ids': fields.many2many('res.partner',
 115             'mail_compose_message_res_partner_rel',
 116             'wizard_id', 'partner_id', 'Additional contacts'),
 117         'attachment_ids': fields.many2many('ir.attachment',
 118             'mail_compose_message_ir_attachments_rel',
 119             'wizard_id', 'attachment_id', 'Attachments'),
 120         'filter_id': fields.many2one('ir.filters', 'Filters'),
 121     }
 122
 123     _defaults = {
 124         'composition_mode': 'comment',
 125         'body': lambda self, cr, uid, ctx={}: '',
 126         'subject': lambda self, cr, uid, ctx={}: False,
 127         'partner_ids': lambda self, cr, uid, ctx={}: [],
 128     }
 129
 130     def check_access_rule(self, cr, uid, ids, operation, context=None):
 131         """ Access rules of mail.compose.message:
 132             - create: if
 133                 - model, no res_id, I create a message in mass mail mode
 134             - then: fall back on mail.message acces rules
 135         """
 136         if isinstance(ids, (int, long)):
 137             ids = [ids]
 138
 139         # Author condition (CREATE (mass_mail))
 140         if operation == 'create' and uid != SUPERUSER_ID:
 141             # read mail_compose_message.ids to have their values
 142             message_values = {}
 143             cr.execute('SELECT DISTINCT id, model, res_id FROM "%s" WHERE id = ANY (%%s) AND res_id = 0' % self._table, (ids,))
 144             for id, rmod, rid in cr.fetchall():
 145                 message_values[id] = {'model': rmod, 'res_id': rid}
 146             # remove from the set to check the ids that mail_compose_message accepts
 147             author_ids = [mid for mid, message in message_values.iteritems()
 148                 if message.get('model') and not message.get('res_id')]
 149             ids = list(set(ids) - set(author_ids))
 150
 151         return super(mail_compose_message, self).check_access_rule(cr, uid, ids, operation, context=context)
 152
 153     def _notify(self, cr, uid, newid, context=None):
 154         """ Override specific notify method of mail.message, because we do
 155             not want that feature in the wizard. """
 156         return
 157
 158     def get_record_data(self, cr, uid, model, res_id, context=None):
 159         """ Returns a defaults-like dict with initial values for the composition
 160             wizard when sending an email related to the document record
 161             identified by ``model`` and ``res_id``.
 162
 163             :param str model: model name of the document record this mail is
 164                 related to.
 165             :param int res_id: id of the document record this mail is related to
 166         """
 167         doc_name_get = self.pool.get(model).name_get(cr, uid, [res_id], context=context)
 168         if doc_name_get:
 169             record_name = doc_name_get[0][1]
 170         else:
 171             record_name = False
 172         return {'model': model, 'res_id': res_id, 'record_name': record_name}
 173
 174     def get_message_data(self, cr, uid, message_id, context=None):
 175         """ Returns a defaults-like dict with initial values for the composition
 176             wizard when replying to the given message (e.g. including the quote
 177             of the initial message, and the correct recipients).
 178
 179             :param int message_id: id of the mail.message to which the user
 180                 is replying.
 181         """
 182         if not message_id:
 183             return {}
 184         if context is None:
 185             context = {}
 186         message_data = self.pool.get('mail.message').browse(cr, uid, message_id, context=context)
 187
 188         # create subject
 189         re_prefix = _('Re:')
 190         reply_subject = tools.ustr(message_data.subject or '')
 191         if not (reply_subject.startswith('Re:') or reply_subject.startswith(re_prefix)) and message_data.subject:
 192             reply_subject = "%s %s" % (re_prefix, reply_subject)
 193         # get partner_ids from original message
 194         partner_ids = [partner.id for partner in message_data.partner_ids] if message_data.partner_ids else []
 195         partner_ids += context.get('default_partner_ids', [])
 196
 197         # update the result
 198         result = {
 199             'record_name': message_data.record_name,
 200             'model': message_data.model,
 201             'res_id': message_data.res_id,
 202             'parent_id': message_data.id,
 203             'subject': reply_subject,
 204             'partner_ids': partner_ids,
 205         }
 206         return result
 207
 208     #------------------------------------------------------
 209     # Wizard validation and send
 210     #------------------------------------------------------
 211
 212     def send_mail(self, cr, uid, ids, context=None):
 213         """ Process the wizard content and proceed with sending the related
 214             email(s), rendering any template patterns on the fly if needed. """
 215         if context is None:
 216             context = {}
 217         active_ids = context.get('active_ids')
 218         is_log = context.get('mail_compose_log', False)
 219
 220         for wizard in self.browse(cr, uid, ids, context=context):
 221             mass_mail_mode = wizard.composition_mode == 'mass_mail'
 222             active_model_pool = self.pool.get(wizard.model if wizard.model else 'mail.thread')
 223
 224             # wizard works in batch mode: [res_id] or active_ids
 225             res_ids = active_ids if mass_mail_mode and wizard.model and active_ids else [wizard.res_id]
 226             for res_id in res_ids:
 227                 # default values, according to the wizard options
 228                 post_values = {
 229                     'subject': wizard.subject,
 230                     'body': wizard.body,
 231                     'parent_id': wizard.parent_id and wizard.parent_id.id,
 232                     'partner_ids': [partner.id for partner in wizard.partner_ids],
 233                     'attachments': [(attach.datas_fname or attach.name, base64.b64decode(attach.datas)) for attach in wizard.attachment_ids],
 234                 }
 235                 # mass mailing: render and override default values
 236                 if mass_mail_mode and wizard.model:
 237                     email_dict = self.render_message(cr, uid, wizard, res_id, context=context)
 238                     new_partner_ids = email_dict.pop('partner_ids', [])
 239                     post_values['partner_ids'] += new_partner_ids
 240                     new_attachments = email_dict.pop('attachments', [])
 241                     post_values['attachments'] += new_attachments
 242                     post_values.update(email_dict)
 243                 # post the message
 244                 subtype = 'mail.mt_comment'
 245                 if is_log:  # log a note: subtype is False
 246                     subtype = False
 247                 elif mass_mail_mode:  # mass mail: is a log pushed to recipients, author not added
 248                     subtype = False
 249                     context = dict(context, mail_create_nosubscribe=True)  # add context key to avoid subscribing the author
 250                 msg_id = active_model_pool.message_post(cr, uid, [res_id], type='comment', subtype=subtype, context=context, **post_values)
 251                 # mass_mailing: notify specific partners, because subtype was False, and no-one was notified
 252                 if mass_mail_mode and post_values['partner_ids']:
 253                     self.pool.get('mail.notification')._notify(cr, uid, msg_id, post_values['partner_ids'], context=context)
 254
 255         return {'type': 'ir.actions.act_window_close'}
 256
 257     def render_message(self, cr, uid, wizard, res_id, context=None):
 258         """ Generate an email from the template for given (wizard.model, res_id)
 259             pair. This method is meant to be inherited by email_template that
 260             will produce a more complete dictionary. """
 261         return {
 262             'subject': self.render_template(cr, uid, wizard.subject, wizard.model, res_id, context),
 263             'body': self.render_template(cr, uid, wizard.body, wizard.model, res_id, context),
 264         }
 265
 266     def render_template(self, cr, uid, template, model, res_id, context=None):
 267         """ Render the given template text, replace mako-like expressions ``${expr}``
 268             with the result of evaluating these expressions with an evaluation context
 269             containing:
 270
 271                 * ``user``: browse_record of the current user
 272                 * ``object``: browse_record of the document record this mail is
 273                               related to
 274                 * ``context``: the context passed to the mail composition wizard
 275
 276             :param str template: the template text to render
 277             :param str model: model name of the document record this mail is related to.
 278             :param int res_id: id of the document record this mail is related to.
 279         """
 280         if context is None:
 281             context = {}
 282
 283         def merge(match):
 284             exp = str(match.group()[2:-1]).strip()
 285             result = eval(exp, {
 286                 'user': self.pool.get('res.users').browse(cr, uid, uid, context=context),
 287                 'object': self.pool.get(model).browse(cr, uid, res_id, context=context),
 288                 'context': dict(context),  # copy context to prevent side-effects of eval
 289                 })
 290             return result and tools.ustr(result) or ''
 291         return template and EXPRESSION_PATTERN.sub(merge, template)