addons/mail/mail_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 Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (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 Affero General Public License for more details
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>
  19 #
  20 ##############################################################################
  21
  22 import logging
  23 from openerp import tools
  24
  25 from email.header import decode_header
  26 from openerp import SUPERUSER_ID
  27 from openerp.osv import osv, orm, fields
  28 from openerp.tools import html_email_clean
  29 from openerp.tools.translate import _
  30
  31 _logger = logging.getLogger(__name__)
  32
  33 try:
  34     from mako.template import Template as MakoTemplate
  35 except ImportError:
  36     _logger.warning("payment_acquirer: mako templates not available, payment acquirer will not work!")
  37
  38
  39 """ Some tools for parsing / creating email fields """
  40 def decode(text):
  41     """Returns unicode() string conversion of the the given encoded smtp header text"""
  42     if text:
  43         text = decode_header(text.replace('\r', ''))
  44         return ''.join([tools.ustr(x[0], x[1]) for x in text])
  45
  46
  47 class mail_message(osv.Model):
  48     """ Messages model: system notification (replacing res.log notifications),
  49         comments (OpenChatter discussion) and incoming emails. """
  50     _name = 'mail.message'
  51     _description = 'Message'
  52     _inherit = ['ir.needaction_mixin']
  53     _order = 'id desc'
  54     _rec_name = 'record_name'
  55
  56     _message_read_limit = 30
  57     _message_read_fields = ['id', 'parent_id', 'model', 'res_id', 'body', 'subject', 'date', 'to_read', 'email_from',
  58         'type', 'vote_user_ids', 'attachment_ids', 'author_id', 'partner_ids', 'record_name']
  59     _message_record_name_length = 18
  60     _message_read_more_limit = 1024
  61
  62     def default_get(self, cr, uid, fields, context=None):
  63         # protection for `default_type` values leaking from menu action context (e.g. for invoices)
  64         if context and context.get('default_type') and context.get('default_type') not in self._columns['type'].selection:
  65             context = dict(context, default_type=None)
  66         return super(mail_message, self).default_get(cr, uid, fields, context=context)
  67
  68     def _shorten_name(self, name):
  69         if len(name) <= (self._message_record_name_length + 3):
  70             return name
  71         return name[:self._message_record_name_length] + '...'
  72
  73     def _get_record_name(self, cr, uid, ids, name, arg, context=None):
  74         """ Return the related document name, using name_get. It is done using
  75             SUPERUSER_ID, to be sure to have the record name correctly stored. """
  76         # TDE note: regroup by model/ids, to have less queries to perform
  77         result = dict.fromkeys(ids, False)
  78         for message in self.read(cr, uid, ids, ['model', 'res_id'], context=context):
  79             if not message.get('model') or not message.get('res_id') or not self.pool.get(message['model']):
  80                 continue
  81             result[message['id']] = self._shorten_name(self.pool.get(message['model']).name_get(cr, SUPERUSER_ID, [message['res_id']], context=context)[0][1])
  82         return result
  83
  84     def _get_to_read(self, cr, uid, ids, name, arg, context=None):
  85         """ Compute if the message is unread by the current user. """
  86         res = dict((id, False) for id in ids)
  87         partner_id = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
  88         notif_obj = self.pool.get('mail.notification')
  89         notif_ids = notif_obj.search(cr, uid, [
  90             ('partner_id', 'in', [partner_id]),
  91             ('message_id', 'in', ids),
  92             ('read', '=', False),
  93         ], context=context)
  94         for notif in notif_obj.browse(cr, uid, notif_ids, context=context):
  95             res[notif.message_id.id] = True
  96         return res
  97
  98     def _search_to_read(self, cr, uid, obj, name, domain, context=None):
  99         """ Search for messages to read by the current user. Condition is
 100             inversed because we search unread message on a read column. """
 101         return ['&', ('notification_ids.partner_id.user_ids', 'in', [uid]), ('notification_ids.read', '=', not domain[0][2])]
 102
 103     def _get_starred(self, cr, uid, ids, name, arg, context=None):
 104         """ Compute if the message is unread by the current user. """
 105         res = dict((id, False) for id in ids)
 106         partner_id = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
 107         notif_obj = self.pool.get('mail.notification')
 108         notif_ids = notif_obj.search(cr, uid, [
 109             ('partner_id', 'in', [partner_id]),
 110             ('message_id', 'in', ids),
 111             ('starred', '=', True),
 112         ], context=context)
 113         for notif in notif_obj.browse(cr, uid, notif_ids, context=context):
 114             res[notif.message_id.id] = True
 115         return res
 116
 117     def _search_starred(self, cr, uid, obj, name, domain, context=None):
 118         """ Search for messages to read by the current user. Condition is
 119             inversed because we search unread message on a read column. """
 120         return ['&', ('notification_ids.partner_id.user_ids', 'in', [uid]), ('notification_ids.starred', '=', domain[0][2])]
 121
 122     def name_get(self, cr, uid, ids, context=None):
 123         # name_get may receive int id instead of an id list
 124         if isinstance(ids, (int, long)):
 125             ids = [ids]
 126         res = []
 127         for message in self.browse(cr, uid, ids, context=context):
 128             name = '%s: %s' % (message.subject or '', message.body or '')
 129             res.append((message.id, self._shorten_name(name.lstrip(' :'))))
 130         return res
 131
 132     _columns = {
 133         'type': fields.selection([
 134                         ('email', 'Email'),
 135                         ('comment', 'Comment'),
 136                         ('notification', 'System notification'),
 137                         ], 'Type',
 138             help="Message type: email for email message, notification for system "\
 139                  "message, comment for other messages such as user replies"),
 140         'email_from': fields.char('From',
 141             help="Email address of the sender. This field is set when no matching partner is found for incoming emails."),
 142         'author_id': fields.many2one('res.partner', 'Author', select=1,
 143             ondelete='set null',
 144             help="Author of the message. If not set, email_from may hold an email address that did not match any partner."),
 145         'partner_ids': fields.many2many('res.partner', string='Recipients'),
 146         'notified_partner_ids': fields.many2many('res.partner', 'mail_notification',
 147             'message_id', 'partner_id', 'Notified partners',
 148             help='Partners that have a notification pushing this message in their mailboxes'),
 149         'attachment_ids': fields.many2many('ir.attachment', 'message_attachment_rel',
 150             'message_id', 'attachment_id', 'Attachments'),
 151         'parent_id': fields.many2one('mail.message', 'Parent Message', select=True,
 152             ondelete='set null', help="Initial thread message."),
 153         'child_ids': fields.one2many('mail.message', 'parent_id', 'Child Messages'),
 154         'model': fields.char('Related Document Model', size=128, select=1),
 155         'res_id': fields.integer('Related Document ID', select=1),
 156         'record_name': fields.function(_get_record_name, type='char',
 157             store=True, string='Message Record Name',
 158             help="Name get of the related document."),
 159         'notification_ids': fields.one2many('mail.notification', 'message_id',
 160             string='Notifications', auto_join=True,
 161             help='Technical field holding the message notifications. Use notified_partner_ids to access notified partners.'),
 162         'subject': fields.char('Subject'),
 163         'date': fields.datetime('Date'),
 164         'message_id': fields.char('Message-Id', help='Message unique identifier', select=1, readonly=1),
 165         'body': fields.html('Contents', help='Automatically sanitized HTML contents'),
 166         'to_read': fields.function(_get_to_read, fnct_search=_search_to_read,
 167             type='boolean', string='To read',
 168             help='Current user has an unread notification linked to this message'),
 169         'starred': fields.function(_get_starred, fnct_search=_search_starred,
 170             type='boolean', string='Starred',
 171             help='Current user has a starred notification linked to this message'),
 172         'subtype_id': fields.many2one('mail.message.subtype', 'Subtype',
 173             ondelete='set null', select=1,),
 174         'vote_user_ids': fields.many2many('res.users', 'mail_vote',
 175             'message_id', 'user_id', string='Votes',
 176             help='Users that voted for this message'),
 177     }
 178
 179     def _needaction_domain_get(self, cr, uid, context=None):
 180         return [('to_read', '=', True)]
 181
 182     def _get_default_author(self, cr, uid, context=None):
 183         return self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
 184
 185     _defaults = {
 186         'type': 'email',
 187         'date': lambda *a: fields.datetime.now(),
 188         'author_id': lambda self, cr, uid, ctx={}: self._get_default_author(cr, uid, ctx),
 189         'body': '',
 190     }
 191
 192     #------------------------------------------------------
 193     # Vote/Like
 194     #------------------------------------------------------
 195
 196     def vote_toggle(self, cr, uid, ids, context=None):
 197         ''' Toggles vote. Performed using read to avoid access rights issues.
 198             Done as SUPERUSER_ID because uid may vote for a message he cannot modify. '''
 199         for message in self.read(cr, uid, ids, ['vote_user_ids'], context=context):
 200             new_has_voted = not (uid in message.get('vote_user_ids'))
 201             if new_has_voted:
 202                 self.write(cr, SUPERUSER_ID, message.get('id'), {'vote_user_ids': [(4, uid)]}, context=context)
 203             else:
 204                 self.write(cr, SUPERUSER_ID, message.get('id'), {'vote_user_ids': [(3, uid)]}, context=context)
 205         return new_has_voted or False
 206
 207     #------------------------------------------------------
 208     # download an attachment
 209     #------------------------------------------------------
 210
 211     def download_attachment(self, cr, uid, id_message, attachment_id, context=None):
 212         """ Return the content of linked attachments. """
 213         message = self.browse(cr, uid, id_message, context=context)
 214         if attachment_id in [attachment.id for attachment in message.attachment_ids]:
 215             attachment = self.pool.get('ir.attachment').browse(cr, SUPERUSER_ID, attachment_id, context=context)
 216             if attachment.datas and attachment.datas_fname:
 217                 return {
 218                     'base64': attachment.datas,
 219                     'filename': attachment.datas_fname,
 220                 }
 221         return False
 222
 223     #------------------------------------------------------
 224     # Notification API
 225     #------------------------------------------------------
 226
 227     def set_message_read(self, cr, uid, msg_ids, read, context=None):
 228         """ Set messages as (un)read. Technically, the notifications related
 229             to uid are set to (un)read. If for some msg_ids there are missing
 230             notifications (i.e. due to load more or thread parent fetching),
 231             they are created.
 232
 233             :param bool read: set notification as (un)read
 234         """
 235         notification_obj = self.pool.get('mail.notification')
 236         user_pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
 237         notif_ids = notification_obj.search(cr, uid, [
 238             ('partner_id', '=', user_pid),
 239             ('message_id', 'in', msg_ids)
 240             ], context=context)
 241
 242         # all message have notifications: already set them as (un)read
 243         if len(notif_ids) == len(msg_ids):
 244             return notification_obj.write(cr, uid, notif_ids, {'read': read}, context=context)
 245
 246         # some messages do not have notifications: find which one, create notification, update read status
 247         notified_msg_ids = [notification.message_id.id for notification in notification_obj.browse(cr, uid, notif_ids, context=context)]
 248         to_create_msg_ids = list(set(msg_ids) - set(notified_msg_ids))
 249         for msg_id in to_create_msg_ids:
 250             notification_obj.create(cr, uid, {'partner_id': user_pid, 'read': read, 'message_id': msg_id}, context=context)
 251         return notification_obj.write(cr, uid, notif_ids, {'read': read}, context=context)
 252
 253     def set_message_starred(self, cr, uid, msg_ids, starred, context=None):
 254         """ Set messages as (un)starred. Technically, the notifications related
 255             to uid are set to (un)starred. If for some msg_ids there are missing
 256             notifications (i.e. due to load more or thread parent fetching),
 257             they are created.
 258
 259             :param bool starred: set notification as (un)starred
 260         """
 261         notification_obj = self.pool.get('mail.notification')
 262         user_pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
 263         notif_ids = notification_obj.search(cr, uid, [
 264             ('partner_id', '=', user_pid),
 265             ('message_id', 'in', msg_ids)
 266             ], context=context)
 267
 268         # all message have notifications: already set them as (un)starred
 269         if len(notif_ids) == len(msg_ids):
 270             notification_obj.write(cr, uid, notif_ids, {'starred': starred}, context=context)
 271             return starred
 272
 273         # some messages do not have notifications: find which one, create notification, update starred status
 274         notified_msg_ids = [notification.message_id.id for notification in notification_obj.browse(cr, uid, notif_ids, context=context)]
 275         to_create_msg_ids = list(set(msg_ids) - set(notified_msg_ids))
 276         for msg_id in to_create_msg_ids:
 277             notification_obj.create(cr, uid, {'partner_id': user_pid, 'starred': starred, 'message_id': msg_id}, context=context)
 278         notification_obj.write(cr, uid, notif_ids, {'starred': starred}, context=context)
 279         return starred
 280
 281     #------------------------------------------------------
 282     # Message loading for web interface
 283     #------------------------------------------------------
 284
 285     def _message_read_dict_postprocess(self, cr, uid, messages, message_tree, context=None):
 286         """ Post-processing on values given by message_read. This method will
 287             handle partners in batch to avoid doing numerous queries.
 288
 289             :param list messages: list of message, as get_dict result
 290             :param dict message_tree: {[msg.id]: msg browse record}
 291         """
 292         res_partner_obj = self.pool.get('res.partner')
 293         ir_attachment_obj = self.pool.get('ir.attachment')
 294         pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=None)['partner_id'][0]
 295
 296         # 1. Aggregate partners (author_id and partner_ids) and attachments
 297         partner_ids = set()
 298         attachment_ids = set()
 299         for key, message in message_tree.iteritems():
 300             if message.author_id:
 301                 partner_ids |= set([message.author_id.id])
 302             if message.partner_ids:
 303                 partner_ids |= set([partner.id for partner in message.partner_ids])
 304             if message.attachment_ids:
 305                 attachment_ids |= set([attachment.id for attachment in message.attachment_ids])
 306         # Read partners as SUPERUSER -> display the names like classic m2o even if no access
 307         partners = res_partner_obj.name_get(cr, SUPERUSER_ID, list(partner_ids), context=context)
 308         partner_tree = dict((partner[0], partner) for partner in partners)
 309
 310         # 2. Attachments as SUPERUSER, because could receive msg and attachments for doc uid cannot see
 311         attachments = ir_attachment_obj.read(cr, SUPERUSER_ID, list(attachment_ids), ['id', 'datas_fname'], context=context)
 312         attachments_tree = dict((attachment['id'], {'id': attachment['id'], 'filename': attachment['datas_fname']}) for attachment in attachments)
 313
 314         # 3. Update message dictionaries
 315         for message_dict in messages:
 316             message_id = message_dict.get('id')
 317             message = message_tree[message_id]
 318             if message.author_id:
 319                 author = partner_tree[message.author_id.id]
 320             else:
 321                 author = (0, message.email_from)
 322             partner_ids = []
 323             for partner in message.partner_ids:
 324                 if partner.id in partner_tree:
 325                     partner_ids.append(partner_tree[partner.id])
 326             attachment_ids = []
 327             for attachment in message.attachment_ids:
 328                 if attachment.id in attachments_tree:
 329                     attachment_ids.append(attachments_tree[attachment.id])
 330             message_dict.update({
 331                 'is_author': pid == author[0],
 332                 'author_id': author,
 333                 'partner_ids': partner_ids,
 334                 'attachment_ids': attachment_ids,
 335                 })
 336         return True
 337
 338     def _message_read_dict(self, cr, uid, message, parent_id=False, context=None):
 339         """ Return a dict representation of the message. This representation is
 340             used in the JS client code, to display the messages. Partners and
 341             attachments related stuff will be done in post-processing in batch.
 342
 343             :param dict message: mail.message browse record
 344         """
 345         # private message: no model, no res_id
 346         is_private = False
 347         if not message.model or not message.res_id:
 348             is_private = True
 349         # votes and favorites: res.users ids, no prefetching should be done
 350         vote_nb = len(message.vote_user_ids)
 351         has_voted = uid in [user.id for user in message.vote_user_ids]
 352
 353         try:
 354             body_html = html_email_clean(message.body)
 355         except Exception:
 356             body_html = '<p><b>Encoding Error : </b><br/>Unable to convert this message (id: %s).</p>' % message.id
 357             _logger.exception(Exception)
 358
 359         return {'id': message.id,
 360                 'type': message.type,
 361                 'body': body_html,
 362                 'model': message.model,
 363                 'res_id': message.res_id,
 364                 'record_name': message.record_name,
 365                 'subject': message.subject,
 366                 'date': message.date,
 367                 'to_read': message.to_read,
 368                 'parent_id': parent_id,
 369                 'is_private': is_private,
 370                 'author_id': False,
 371                 'is_author': False,
 372                 'partner_ids': [],
 373                 'vote_nb': vote_nb,
 374                 'has_voted': has_voted,
 375                 'is_favorite': message.starred,
 376                 'attachment_ids': [],
 377             }
 378
 379     def _message_read_add_expandables(self, cr, uid, messages, message_tree, parent_tree,
 380             message_unload_ids=[], thread_level=0, domain=[], parent_id=False, context=None):
 381         """ Create expandables for message_read, to load new messages.
 382             1. get the expandable for new threads
 383                 if display is flat (thread_level == 0):
 384                     fetch message_ids < min(already displayed ids), because we
 385                     want a flat display, ordered by id
 386                 else:
 387                     fetch message_ids that are not childs of already displayed
 388                     messages
 389             2. get the expandables for new messages inside threads if display
 390                is not flat
 391                 for each thread header, search for its childs
 392                     for each hole in the child list based on message displayed,
 393                     create an expandable
 394
 395             :param list messages: list of message structure for the Chatter
 396                 widget to which expandables are added
 397             :param dict message_tree: dict [id]: browse record of this message
 398             :param dict parent_tree: dict [parent_id]: [child_ids]
 399             :param list message_unload_ids: list of message_ids we do not want
 400                 to load
 401             :return bool: True
 402         """
 403         def _get_expandable(domain, message_nb, parent_id, max_limit):
 404             return {
 405                 'domain': domain,
 406                 'nb_messages': message_nb,
 407                 'type': 'expandable',
 408                 'parent_id': parent_id,
 409                 'max_limit':  max_limit,
 410             }
 411
 412         if not messages:
 413             return True
 414         message_ids = sorted(message_tree.keys())
 415
 416         # 1. get the expandable for new threads
 417         if thread_level == 0:
 418             exp_domain = domain + [('id', '<', min(message_unload_ids + message_ids))]
 419         else:
 420             exp_domain = domain + ['!', ('id', 'child_of', message_unload_ids + parent_tree.keys())]
 421         ids = self.search(cr, uid, exp_domain, context=context, limit=1)
 422         if ids:
 423             # inside a thread: prepend
 424             if parent_id:
 425                 messages.insert(0, _get_expandable(exp_domain, -1, parent_id, True))
 426             # new threads: append
 427             else:
 428                 messages.append(_get_expandable(exp_domain, -1, parent_id, True))
 429
 430         # 2. get the expandables for new messages inside threads if display is not flat
 431         if thread_level == 0:
 432             return True
 433         for message_id in message_ids:
 434             message = message_tree[message_id]
 435
 436             # generate only for thread header messages (TDE note: parent_id may be False is uid cannot see parent_id, seems ok)
 437             if message.parent_id:
 438                 continue
 439
 440             # check there are message for expandable
 441             child_ids = set([child.id for child in message.child_ids]) - set(message_unload_ids)
 442             child_ids = sorted(list(child_ids), reverse=True)
 443             if not child_ids:
 444                 continue
 445
 446             # make groups of unread messages
 447             id_min, id_max, nb = max(child_ids), 0, 0
 448             for child_id in child_ids:
 449                 if not child_id in message_ids:
 450                     nb += 1
 451                     if id_min > child_id:
 452                         id_min = child_id
 453                     if id_max < child_id:
 454                         id_max = child_id
 455                 elif nb > 0:
 456                     exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
 457                     idx = [msg.get('id') for msg in messages].index(child_id) + 1
 458                     # messages.append(_get_expandable(exp_domain, nb, message_id, False))
 459                     messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
 460                     id_min, id_max, nb = max(child_ids), 0, 0
 461                 else:
 462                     id_min, id_max, nb = max(child_ids), 0, 0
 463             if nb > 0:
 464                 exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
 465                 idx = [msg.get('id') for msg in messages].index(message_id) + 1
 466                 # messages.append(_get_expandable(exp_domain, nb, message_id, id_min))
 467                 messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
 468
 469         return True
 470
 471     def message_read(self, cr, uid, ids=None, domain=None, message_unload_ids=None,
 472                         thread_level=0, context=None, parent_id=False, limit=None):
 473         """ Read messages from mail.message, and get back a list of structured
 474             messages to be displayed as discussion threads. If IDs is set,
 475             fetch these records. Otherwise use the domain to fetch messages.
 476             After having fetch messages, their ancestors will be added to obtain
 477             well formed threads, if uid has access to them.
 478
 479             After reading the messages, expandable messages are added in the
 480             message list (see ``_message_read_add_expandables``). It consists
 481             in messages holding the 'read more' data: number of messages to
 482             read, domain to apply.
 483
 484             :param list ids: optional IDs to fetch
 485             :param list domain: optional domain for searching ids if ids not set
 486             :param list message_unload_ids: optional ids we do not want to fetch,
 487                 because i.e. they are already displayed somewhere
 488             :param int parent_id: context of parent_id
 489                 - if parent_id reached when adding ancestors, stop going further
 490                   in the ancestor search
 491                 - if set in flat mode, ancestor_id is set to parent_id
 492             :param int limit: number of messages to fetch, before adding the
 493                 ancestors and expandables
 494             :return list: list of message structure for the Chatter widget
 495         """
 496         assert thread_level in [0, 1], 'message_read() thread_level should be 0 (flat) or 1 (1 level of thread); given %s.' % thread_level
 497         domain = domain if domain is not None else []
 498         message_unload_ids = message_unload_ids if message_unload_ids is not None else []
 499         if message_unload_ids:
 500             domain += [('id', 'not in', message_unload_ids)]
 501         limit = limit or self._message_read_limit
 502         message_tree = {}
 503         message_list = []
 504         parent_tree = {}
 505
 506         # no specific IDS given: fetch messages according to the domain, add their parents if uid has access to
 507         if ids is None:
 508             ids = self.search(cr, uid, domain, context=context, limit=limit)
 509
 510         # fetch parent if threaded, sort messages
 511         for message in self.browse(cr, uid, ids, context=context):
 512             message_id = message.id
 513             if message_id in message_tree:
 514                 continue
 515             message_tree[message_id] = message
 516
 517             # find parent_id
 518             if thread_level == 0:
 519                 tree_parent_id = parent_id
 520             else:
 521                 tree_parent_id = message_id
 522                 parent = message
 523                 while parent.parent_id and parent.parent_id.id != parent_id:
 524                     parent = parent.parent_id
 525                     tree_parent_id = parent.id
 526                 if not parent.id in message_tree:
 527                     message_tree[parent.id] = parent
 528             # newest messages first
 529             parent_tree.setdefault(tree_parent_id, [])
 530             if tree_parent_id != message_id:
 531                 parent_tree[tree_parent_id].append(self._message_read_dict(cr, uid, message_tree[message_id], parent_id=tree_parent_id, context=context))
 532
 533         if thread_level:
 534             for key, message_id_list in parent_tree.iteritems():
 535                 message_id_list.sort(key=lambda item: item['id'])
 536                 message_id_list.insert(0, self._message_read_dict(cr, uid, message_tree[key], context=context))
 537
 538         parent_list = parent_tree.items()
 539         parent_list = sorted(parent_list, key=lambda item: max([msg.get('id') for msg in item[1]]) if item[1] else item[0], reverse=True)
 540         message_list = [message for (key, msg_list) in parent_list for message in msg_list]
 541
 542         # get the child expandable messages for the tree
 543         self._message_read_dict_postprocess(cr, uid, message_list, message_tree, context=context)
 544         self._message_read_add_expandables(cr, uid, message_list, message_tree, parent_tree,
 545             thread_level=thread_level, message_unload_ids=message_unload_ids, domain=domain, parent_id=parent_id, context=context)
 546         return message_list
 547
 548     #------------------------------------------------------
 549     # mail_message internals
 550     #------------------------------------------------------
 551
 552     def init(self, cr):
 553         cr.execute("""SELECT indexname FROM pg_indexes WHERE indexname = 'mail_message_model_res_id_idx'""")
 554         if not cr.fetchone():
 555             cr.execute("""CREATE INDEX mail_message_model_res_id_idx ON mail_message (model, res_id)""")
 556
 557     def _find_allowed_model_wise(self, cr, uid, doc_model, doc_dict, context=None):
 558         doc_ids = doc_dict.keys()
 559         allowed_doc_ids = self.pool.get(doc_model).search(cr, uid, [('id', 'in', doc_ids)], context=context)
 560         return set([message_id for allowed_doc_id in allowed_doc_ids for message_id in doc_dict[allowed_doc_id]])
 561
 562     def _find_allowed_doc_ids(self, cr, uid, model_ids, context=None):
 563         model_access_obj = self.pool.get('ir.model.access')
 564         allowed_ids = set()
 565         for doc_model, doc_dict in model_ids.iteritems():
 566             if not model_access_obj.check(cr, uid, doc_model, 'read', False):
 567                 continue
 568             allowed_ids |= self._find_allowed_model_wise(cr, uid, doc_model, doc_dict, context=context)
 569         return allowed_ids
 570
 571     def _search(self, cr, uid, args, offset=0, limit=None, order=None,
 572         context=None, count=False, access_rights_uid=None):
 573         """ Override that adds specific access rights of mail.message, to remove
 574             ids uid could not see according to our custom rules. Please refer
 575             to check_access_rule for more details about those rules.
 576
 577             After having received ids of a classic search, keep only:
 578             - if author_id == pid, uid is the author, OR
 579             - a notification (id, pid) exists, uid has been notified, OR
 580             - uid have read access to the related document is model, res_id
 581             - otherwise: remove the id
 582         """
 583         # Rules do not apply to administrator
 584         if uid == SUPERUSER_ID:
 585             return super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
 586                 context=context, count=count, access_rights_uid=access_rights_uid)
 587         # Perform a super with count as False, to have the ids, not a counter
 588         ids = super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
 589             context=context, count=False, access_rights_uid=access_rights_uid)
 590         if not ids and count:
 591             return 0
 592         elif not ids:
 593             return ids
 594
 595         pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'])['partner_id'][0]
 596         author_ids, partner_ids, allowed_ids = set([]), set([]), set([])
 597         model_ids = {}
 598
 599         messages = super(mail_message, self).read(cr, uid, ids, ['author_id', 'model', 'res_id', 'notified_partner_ids'], context=context)
 600         for message in messages:
 601             if message.get('author_id') and message.get('author_id')[0] == pid:
 602                 author_ids.add(message.get('id'))
 603             elif pid in message.get('notified_partner_ids'):
 604                 partner_ids.add(message.get('id'))
 605             elif message.get('model') and message.get('res_id'):
 606                 model_ids.setdefault(message.get('model'), {}).setdefault(message.get('res_id'), set()).add(message.get('id'))
 607
 608         allowed_ids = self._find_allowed_doc_ids(cr, uid, model_ids, context=context)
 609
 610         final_ids = author_ids | partner_ids | allowed_ids
 611         if count:
 612             return len(final_ids)
 613         else:
 614             return list(final_ids)
 615
 616     def check_access_rule(self, cr, uid, ids, operation, context=None):
 617         """ Access rules of mail.message:
 618             - read: if
 619                 - author_id == pid, uid is the author, OR
 620                 - mail_notification (id, pid) exists, uid has been notified, OR
 621                 - uid have read access to the related document if model, res_id
 622                 - otherwise: raise
 623             - create: if
 624                 - no model, no res_id, I create a private message OR
 625                 - pid in message_follower_ids if model, res_id OR
 626                 - mail_notification (parent_id.id, pid) exists, uid has been notified of the parent, OR
 627                 - uid have write access on the related document if model, res_id, OR
 628                 - otherwise: raise
 629             - write: if
 630                 - author_id == pid, uid is the author, OR
 631                 - uid has write access on the related document if model, res_id
 632                 - otherwise: raise
 633             - unlink: if
 634                 - uid has write access on the related document if model, res_id
 635                 - otherwise: raise
 636         """
 637         def _generate_model_record_ids(msg_val, msg_ids=[]):
 638             """ :param model_record_ids: {'model': {'res_id': (msg_id, msg_id)}, ... }
 639                 :param message_values: {'msg_id': {'model': .., 'res_id': .., 'author_id': ..}}
 640             """
 641             model_record_ids = {}
 642             for id in msg_ids:
 643                 if msg_val[id]['model'] and msg_val[id]['res_id']:
 644                     model_record_ids.setdefault(msg_val[id]['model'], dict()).setdefault(msg_val[id]['res_id'], set()).add(msg_val[id]['res_id'])
 645             return model_record_ids
 646
 647         if uid == SUPERUSER_ID:
 648             return
 649         if isinstance(ids, (int, long)):
 650             ids = [ids]
 651         not_obj = self.pool.get('mail.notification')
 652         fol_obj = self.pool.get('mail.followers')
 653         partner_id = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=None)['partner_id'][0]
 654
 655         # Read mail_message.ids to have their values
 656         message_values = dict.fromkeys(ids)
 657         cr.execute('SELECT DISTINCT id, model, res_id, author_id, parent_id FROM "%s" WHERE id = ANY (%%s)' % self._table, (ids,))
 658         for id, rmod, rid, author_id, parent_id in cr.fetchall():
 659             message_values[id] = {'model': rmod, 'res_id': rid, 'author_id': author_id, 'parent_id': parent_id}
 660
 661         # Author condition (READ, WRITE, CREATE (private)) -> could become an ir.rule ?
 662         author_ids = []
 663         if operation == 'read' or operation == 'write':
 664             author_ids = [mid for mid, message in message_values.iteritems()
 665                 if message.get('author_id') and message.get('author_id') == partner_id]
 666         elif operation == 'create':
 667             author_ids = [mid for mid, message in message_values.iteritems()
 668                 if not message.get('model') and not message.get('res_id')]
 669
 670         # Parent condition, for create (check for received notifications for the created message parent)
 671         notified_ids = []
 672         if operation == 'create':
 673             parent_ids = [message.get('parent_id') for mid, message in message_values.iteritems()
 674                 if message.get('parent_id')]
 675             not_ids = not_obj.search(cr, SUPERUSER_ID, [('message_id.id', 'in', parent_ids), ('partner_id', '=', partner_id)], context=context)
 676             not_parent_ids = [notif.message_id.id for notif in not_obj.browse(cr, SUPERUSER_ID, not_ids, context=context)]
 677             notified_ids += [mid for mid, message in message_values.iteritems()
 678                 if message.get('parent_id') in not_parent_ids]
 679
 680         # Notification condition, for read (check for received notifications and create (in message_follower_ids)) -> could become an ir.rule, but not till we do not have a many2one variable field
 681         other_ids = set(ids).difference(set(author_ids), set(notified_ids))
 682         model_record_ids = _generate_model_record_ids(message_values, other_ids)
 683         if operation == 'read':
 684             not_ids = not_obj.search(cr, SUPERUSER_ID, [
 685                 ('partner_id', '=', partner_id),
 686                 ('message_id', 'in', ids),
 687             ], context=context)
 688             notified_ids = [notification.message_id.id for notification in not_obj.browse(cr, SUPERUSER_ID, not_ids, context=context)]
 689         elif operation == 'create':
 690             for doc_model, doc_dict in model_record_ids.items():
 691                 fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
 692                     ('res_model', '=', doc_model),
 693                     ('res_id', 'in', list(doc_dict.keys())),
 694                     ('partner_id', '=', partner_id),
 695                     ], context=context)
 696                 fol_mids = [follower.res_id for follower in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context)]
 697                 notified_ids += [mid for mid, message in message_values.iteritems()
 698                     if message.get('model') == doc_model and message.get('res_id') in fol_mids]
 699
 700         # CRUD: Access rights related to the document
 701         other_ids = other_ids.difference(set(notified_ids))
 702         model_record_ids = _generate_model_record_ids(message_values, other_ids)
 703         document_related_ids = []
 704         for model, doc_dict in model_record_ids.items():
 705             model_obj = self.pool.get(model)
 706             mids = model_obj.exists(cr, uid, doc_dict.keys())
 707             if operation in ['create', 'write', 'unlink']:
 708                 model_obj.check_access_rights(cr, uid, 'write')
 709                 model_obj.check_access_rule(cr, uid, mids, 'write', context=context)
 710             else:
 711                 model_obj.check_access_rights(cr, uid, operation)
 712                 model_obj.check_access_rule(cr, uid, mids, operation, context=context)
 713             document_related_ids += [mid for mid, message in message_values.iteritems()
 714                 if message.get('model') == model and message.get('res_id') in mids]
 715
 716         # Calculate remaining ids: if not void, raise an error
 717         other_ids = other_ids.difference(set(document_related_ids))
 718         if not other_ids:
 719             return
 720         raise orm.except_orm(_('Access Denied'),
 721                             _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
 722                             (self._description, operation))
 723
 724     def create(self, cr, uid, values, context=None):
 725         if context is None:
 726             context = {}
 727         default_starred = context.pop('default_starred', False)
 728         if not values.get('message_id') and values.get('res_id') and values.get('model'):
 729             values['message_id'] = tools.generate_tracking_message_id('%(res_id)s-%(model)s' % values)
 730         elif not values.get('message_id'):
 731             values['message_id'] = tools.generate_tracking_message_id('private')
 732         newid = super(mail_message, self).create(cr, uid, values, context)
 733         self._notify(cr, uid, newid, context=context)
 734         # TDE FIXME: handle default_starred. Why not setting an inv on starred ?
 735         # Because starred will call set_message_starred, that looks for notifications.
 736         # When creating a new mail_message, it will create a notification to a message
 737         # that does not exist, leading to an error (key not existing). Also this
 738         # this means unread notifications will be created, yet we can not assure
 739         # this is what we want.
 740         if default_starred:
 741             self.set_message_starred(cr, uid, [newid], True, context=context)
 742         return newid
 743
 744     def read(self, cr, uid, ids, fields=None, context=None, load='_classic_read'):
 745         """ Override to explicitely call check_access_rule, that is not called
 746             by the ORM. It instead directly fetches ir.rules and apply them. """
 747         self.check_access_rule(cr, uid, ids, 'read', context=context)
 748         res = super(mail_message, self).read(cr, uid, ids, fields=fields, context=context, load=load)
 749         return res
 750
 751     def unlink(self, cr, uid, ids, context=None):
 752         # cascade-delete attachments that are directly attached to the message (should only happen
 753         # for mail.messages that act as parent for a standalone mail.mail record).
 754         self.check_access_rule(cr, uid, ids, 'unlink', context=context)
 755         attachments_to_delete = []
 756         for message in self.browse(cr, uid, ids, context=context):
 757             for attach in message.attachment_ids:
 758                 if attach.res_model == self._name and attach.res_id == message.id:
 759                     attachments_to_delete.append(attach.id)
 760         if attachments_to_delete:
 761             self.pool.get('ir.attachment').unlink(cr, uid, attachments_to_delete, context=context)
 762         return super(mail_message, self).unlink(cr, uid, ids, context=context)
 763
 764     def copy(self, cr, uid, id, default=None, context=None):
 765         """ Overridden to avoid duplicating fields that are unique to each email """
 766         if default is None:
 767             default = {}
 768         default.update(message_id=False, headers=False)
 769         return super(mail_message, self).copy(cr, uid, id, default=default, context=context)
 770
 771     #------------------------------------------------------
 772     # Messaging API
 773     #------------------------------------------------------
 774
 775     # TDE note: this code is not used currently, will be improved in a future merge, when quoted context
 776     # will be added to email send for notifications. Currently only WIP.
 777     MAIL_TEMPLATE = """<div>
 778     % if message:
 779         ${display_message(message)}
 780     % endif
 781     % for ctx_msg in context_messages:
 782         ${display_message(ctx_msg)}
 783     % endfor
 784     % if add_expandable:
 785         ${display_expandable()}
 786     % endif
 787     ${display_message(header_message)}
 788     </div>
 789
 790     <%def name="display_message(message)">
 791         <div>
 792             Subject: ${message.subject}<br />
 793             Body: ${message.body}
 794         </div>
 795     </%def>
 796
 797     <%def name="display_expandable()">
 798         <div>This is an expandable.</div>
 799     </%def>
 800     """
 801
 802     def message_quote_context(self, cr, uid, id, context=None, limit=3, add_original=False):
 803         """
 804             1. message.parent_id = False: new thread, no quote_context
 805             2. get the lasts messages in the thread before message
 806             3. get the message header
 807             4. add an expandable between them
 808
 809             :param dict quote_context: options for quoting
 810             :return string: html quote
 811         """
 812         add_expandable = False
 813
 814         message = self.browse(cr, uid, id, context=context)
 815         if not message.parent_id:
 816             return ''
 817         context_ids = self.search(cr, uid, [
 818             ('parent_id', '=', message.parent_id.id),
 819             ('id', '<', message.id),
 820             ], limit=limit, context=context)
 821
 822         if len(context_ids) >= limit:
 823             add_expandable = True
 824             context_ids = context_ids[0:-1]
 825
 826         context_ids.append(message.parent_id.id)
 827         context_messages = self.browse(cr, uid, context_ids, context=context)
 828         header_message = context_messages.pop()
 829
 830         try:
 831             if not add_original:
 832                 message = False
 833             result = MakoTemplate(self.MAIL_TEMPLATE).render_unicode(message=message,
 834                                                         context_messages=context_messages,
 835                                                         header_message=header_message,
 836                                                         add_expandable=add_expandable,
 837                                                         # context kw would clash with mako internals
 838                                                         ctx=context,
 839                                                         format_exceptions=True)
 840             result = result.strip()
 841             return result
 842         except Exception:
 843             _logger.exception("failed to render mako template for quoting message")
 844             return ''
 845         return result
 846
 847     def _notify(self, cr, uid, newid, context=None):
 848         """ Add the related record followers to the destination partner_ids if is not a private message.
 849             Call mail_notification.notify to manage the email sending
 850         """
 851         notification_obj = self.pool.get('mail.notification')
 852         message = self.browse(cr, uid, newid, context=context)
 853
 854         partners_to_notify = set([])
 855         # message has no subtype_id: pure log message -> no partners, no one notified
 856         if not message.subtype_id:
 857             return True
 858
 859         # all followers of the mail.message document have to be added as partners and notified
 860         if message.model and message.res_id:
 861             fol_obj = self.pool.get("mail.followers")
 862             # browse as SUPERUSER because rules could restrict the search results
 863             fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
 864                 ('res_model', '=', message.model),
 865                 ('res_id', '=', message.res_id),
 866                 ('subtype_ids', 'in', message.subtype_id.id)
 867                 ], context=context)
 868             partners_to_notify |= set(fo.partner_id for fo in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context))
 869         # remove me from notified partners, unless the message is written on my own wall
 870         if message.author_id and message.model == "res.partner" and message.res_id == message.author_id.id:
 871             partners_to_notify |= set([message.author_id])
 872         elif message.author_id:
 873             partners_to_notify -= set([message.author_id])
 874
 875         # all partner_ids of the mail.message have to be notified regardless of the above (even the author if explicitly added!)
 876         if message.partner_ids:
 877             partners_to_notify |= set(message.partner_ids)
 878
 879         # notify
 880         if partners_to_notify:
 881             self.write(cr, SUPERUSER_ID, [newid], {'notified_partner_ids': [(4, p.id) for p in partners_to_notify]}, context=context)
 882         notification_obj._notify(cr, uid, newid, context=context)
 883         message.refresh()
 884
 885         # An error appear when a user receive a notification without notifying
 886         # the parent message -> add a read notification for the parent
 887         if message.parent_id:
 888             # all notified_partner_ids of the mail.message have to be notified for the parented messages
 889             partners_to_parent_notify = set(message.notified_partner_ids).difference(message.parent_id.notified_partner_ids)
 890             for partner in partners_to_parent_notify:
 891                 notification_obj.create(cr, uid, {
 892                         'message_id': message.parent_id.id,
 893                         'partner_id': partner.id,
 894                         'read': True,
 895                     }, context=context)
 896
 897     #------------------------------------------------------
 898     # Tools
 899     #------------------------------------------------------
 900
 901     def check_partners_email(self, cr, uid, partner_ids, context=None):
 902         """ Verify that selected partner_ids have an email_address defined.
 903             Otherwise throw a warning. """
 904         partner_wo_email_lst = []
 905         for partner in self.pool.get('res.partner').browse(cr, uid, partner_ids, context=context):
 906             if not partner.email:
 907                 partner_wo_email_lst.append(partner)
 908         if not partner_wo_email_lst:
 909             return {}
 910         warning_msg = _('The following partners chosen as recipients for the email have no email address linked :')
 911         for partner in partner_wo_email_lst:
 912             warning_msg += '\n- %s' % (partner.name)
 913         return {'warning': {
 914                     'title': _('Partners email addresses not found'),
 915                     'message': warning_msg,
 916                     }
 917                 }