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, create_missing=True, 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             :param bool create_missing: create notifications for missing entries
 235                 (i.e. when acting on displayed messages not notified)
 236         """
 237         notification_obj = self.pool.get('mail.notification')
 238         user_pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
 239         domain = [('partner_id', '=', user_pid), ('message_id', 'in', msg_ids)]
 240         if not create_missing:
 241             domain += [('read', '=', not read)]
 242         notif_ids = notification_obj.search(cr, uid, domain, context=context)
 243
 244         # all message have notifications: already set them as (un)read
 245         if len(notif_ids) == len(msg_ids) or not create_missing:
 246             return notification_obj.write(cr, uid, notif_ids, {'read': read}, context=context)
 247
 248         # some messages do not have notifications: find which one, create notification, update read status
 249         notified_msg_ids = [notification.message_id.id for notification in notification_obj.browse(cr, uid, notif_ids, context=context)]
 250         to_create_msg_ids = list(set(msg_ids) - set(notified_msg_ids))
 251         for msg_id in to_create_msg_ids:
 252             notification_obj.create(cr, uid, {'partner_id': user_pid, 'read': read, 'message_id': msg_id}, context=context)
 253         return notification_obj.write(cr, uid, notif_ids, {'read': read}, context=context)
 254
 255     def set_message_starred(self, cr, uid, msg_ids, starred, create_missing=True, context=None):
 256         """ Set messages as (un)starred. Technically, the notifications related
 257             to uid are set to (un)starred.
 258
 259             :param bool starred: set notification as (un)starred
 260             :param bool create_missing: create notifications for missing entries
 261                 (i.e. when acting on displayed messages not notified)
 262         """
 263         notification_obj = self.pool.get('mail.notification')
 264         user_pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=context)['partner_id'][0]
 265         domain = [('partner_id', '=', user_pid), ('message_id', 'in', msg_ids)]
 266         if not create_missing:
 267             domain += [('starred', '=', not read)]
 268         notif_ids = notification_obj.search(cr, uid, domain, context=context)
 269
 270         # all message have notifications: already set them as (un)starred
 271         if len(notif_ids) == len(msg_ids) or not create_missing:
 272             notification_obj.write(cr, uid, notif_ids, {'starred': starred}, context=context)
 273             return starred
 274
 275         # some messages do not have notifications: find which one, create notification, update starred status
 276         notified_msg_ids = [notification.message_id.id for notification in notification_obj.browse(cr, uid, notif_ids, context=context)]
 277         to_create_msg_ids = list(set(msg_ids) - set(notified_msg_ids))
 278         for msg_id in to_create_msg_ids:
 279             notification_obj.create(cr, uid, {'partner_id': user_pid, 'starred': starred, 'message_id': msg_id}, context=context)
 280         notification_obj.write(cr, uid, notif_ids, {'starred': starred}, context=context)
 281         return starred
 282
 283     #------------------------------------------------------
 284     # Message loading for web interface
 285     #------------------------------------------------------
 286
 287     def _message_read_dict_postprocess(self, cr, uid, messages, message_tree, context=None):
 288         """ Post-processing on values given by message_read. This method will
 289             handle partners in batch to avoid doing numerous queries.
 290
 291             :param list messages: list of message, as get_dict result
 292             :param dict message_tree: {[msg.id]: msg browse record}
 293         """
 294         res_partner_obj = self.pool.get('res.partner')
 295         ir_attachment_obj = self.pool.get('ir.attachment')
 296         pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=None)['partner_id'][0]
 297
 298         # 1. Aggregate partners (author_id and partner_ids) and attachments
 299         partner_ids = set()
 300         attachment_ids = set()
 301         for key, message in message_tree.iteritems():
 302             if message.author_id:
 303                 partner_ids |= set([message.author_id.id])
 304             if message.partner_ids:
 305                 partner_ids |= set([partner.id for partner in message.partner_ids])
 306             if message.attachment_ids:
 307                 attachment_ids |= set([attachment.id for attachment in message.attachment_ids])
 308         # Read partners as SUPERUSER -> display the names like classic m2o even if no access
 309         partners = res_partner_obj.name_get(cr, SUPERUSER_ID, list(partner_ids), context=context)
 310         partner_tree = dict((partner[0], partner) for partner in partners)
 311
 312         # 2. Attachments as SUPERUSER, because could receive msg and attachments for doc uid cannot see
 313         attachments = ir_attachment_obj.read(cr, SUPERUSER_ID, list(attachment_ids), ['id', 'datas_fname'], context=context)
 314         attachments_tree = dict((attachment['id'], {'id': attachment['id'], 'filename': attachment['datas_fname']}) for attachment in attachments)
 315
 316         # 3. Update message dictionaries
 317         for message_dict in messages:
 318             message_id = message_dict.get('id')
 319             message = message_tree[message_id]
 320             if message.author_id:
 321                 author = partner_tree[message.author_id.id]
 322             else:
 323                 author = (0, message.email_from)
 324             partner_ids = []
 325             for partner in message.partner_ids:
 326                 if partner.id in partner_tree:
 327                     partner_ids.append(partner_tree[partner.id])
 328             attachment_ids = []
 329             for attachment in message.attachment_ids:
 330                 if attachment.id in attachments_tree:
 331                     attachment_ids.append(attachments_tree[attachment.id])
 332             message_dict.update({
 333                 'is_author': pid == author[0],
 334                 'author_id': author,
 335                 'partner_ids': partner_ids,
 336                 'attachment_ids': attachment_ids,
 337                 })
 338         return True
 339
 340     def _message_read_dict(self, cr, uid, message, parent_id=False, context=None):
 341         """ Return a dict representation of the message. This representation is
 342             used in the JS client code, to display the messages. Partners and
 343             attachments related stuff will be done in post-processing in batch.
 344
 345             :param dict message: mail.message browse record
 346         """
 347         # private message: no model, no res_id
 348         is_private = False
 349         if not message.model or not message.res_id:
 350             is_private = True
 351         # votes and favorites: res.users ids, no prefetching should be done
 352         vote_nb = len(message.vote_user_ids)
 353         has_voted = uid in [user.id for user in message.vote_user_ids]
 354
 355         return {'id': message.id,
 356                 'type': message.type,
 357                 'body': html_email_clean(message.body or ''),
 358                 'model': message.model,
 359                 'res_id': message.res_id,
 360                 'record_name': message.record_name,
 361                 'subject': message.subject,
 362                 'date': message.date,
 363                 'to_read': message.to_read,
 364                 'parent_id': parent_id,
 365                 'is_private': is_private,
 366                 'author_id': False,
 367                 'is_author': False,
 368                 'partner_ids': [],
 369                 'vote_nb': vote_nb,
 370                 'has_voted': has_voted,
 371                 'is_favorite': message.starred,
 372                 'attachment_ids': [],
 373             }
 374
 375     def _message_read_add_expandables(self, cr, uid, messages, message_tree, parent_tree,
 376             message_unload_ids=[], thread_level=0, domain=[], parent_id=False, context=None):
 377         """ Create expandables for message_read, to load new messages.
 378             1. get the expandable for new threads
 379                 if display is flat (thread_level == 0):
 380                     fetch message_ids < min(already displayed ids), because we
 381                     want a flat display, ordered by id
 382                 else:
 383                     fetch message_ids that are not childs of already displayed
 384                     messages
 385             2. get the expandables for new messages inside threads if display
 386                is not flat
 387                 for each thread header, search for its childs
 388                     for each hole in the child list based on message displayed,
 389                     create an expandable
 390
 391             :param list messages: list of message structure for the Chatter
 392                 widget to which expandables are added
 393             :param dict message_tree: dict [id]: browse record of this message
 394             :param dict parent_tree: dict [parent_id]: [child_ids]
 395             :param list message_unload_ids: list of message_ids we do not want
 396                 to load
 397             :return bool: True
 398         """
 399         def _get_expandable(domain, message_nb, parent_id, max_limit):
 400             return {
 401                 'domain': domain,
 402                 'nb_messages': message_nb,
 403                 'type': 'expandable',
 404                 'parent_id': parent_id,
 405                 'max_limit':  max_limit,
 406             }
 407
 408         if not messages:
 409             return True
 410         message_ids = sorted(message_tree.keys())
 411
 412         # 1. get the expandable for new threads
 413         if thread_level == 0:
 414             exp_domain = domain + [('id', '<', min(message_unload_ids + message_ids))]
 415         else:
 416             exp_domain = domain + ['!', ('id', 'child_of', message_unload_ids + parent_tree.keys())]
 417         ids = self.search(cr, uid, exp_domain, context=context, limit=1)
 418         if ids:
 419             # inside a thread: prepend
 420             if parent_id:
 421                 messages.insert(0, _get_expandable(exp_domain, -1, parent_id, True))
 422             # new threads: append
 423             else:
 424                 messages.append(_get_expandable(exp_domain, -1, parent_id, True))
 425
 426         # 2. get the expandables for new messages inside threads if display is not flat
 427         if thread_level == 0:
 428             return True
 429         for message_id in message_ids:
 430             message = message_tree[message_id]
 431
 432             # generate only for thread header messages (TDE note: parent_id may be False is uid cannot see parent_id, seems ok)
 433             if message.parent_id:
 434                 continue
 435
 436             # check there are message for expandable
 437             child_ids = set([child.id for child in message.child_ids]) - set(message_unload_ids)
 438             child_ids = sorted(list(child_ids), reverse=True)
 439             if not child_ids:
 440                 continue
 441
 442             # make groups of unread messages
 443             id_min, id_max, nb = max(child_ids), 0, 0
 444             for child_id in child_ids:
 445                 if not child_id in message_ids:
 446                     nb += 1
 447                     if id_min > child_id:
 448                         id_min = child_id
 449                     if id_max < child_id:
 450                         id_max = child_id
 451                 elif nb > 0:
 452                     exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
 453                     idx = [msg.get('id') for msg in messages].index(child_id) + 1
 454                     # messages.append(_get_expandable(exp_domain, nb, message_id, False))
 455                     messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
 456                     id_min, id_max, nb = max(child_ids), 0, 0
 457                 else:
 458                     id_min, id_max, nb = max(child_ids), 0, 0
 459             if nb > 0:
 460                 exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
 461                 idx = [msg.get('id') for msg in messages].index(message_id) + 1
 462                 # messages.append(_get_expandable(exp_domain, nb, message_id, id_min))
 463                 messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
 464
 465         return True
 466
 467     def message_read(self, cr, uid, ids=None, domain=None, message_unload_ids=None,
 468                         thread_level=0, context=None, parent_id=False, limit=None):
 469         """ Read messages from mail.message, and get back a list of structured
 470             messages to be displayed as discussion threads. If IDs is set,
 471             fetch these records. Otherwise use the domain to fetch messages.
 472             After having fetch messages, their ancestors will be added to obtain
 473             well formed threads, if uid has access to them.
 474
 475             After reading the messages, expandable messages are added in the
 476             message list (see ``_message_read_add_expandables``). It consists
 477             in messages holding the 'read more' data: number of messages to
 478             read, domain to apply.
 479
 480             :param list ids: optional IDs to fetch
 481             :param list domain: optional domain for searching ids if ids not set
 482             :param list message_unload_ids: optional ids we do not want to fetch,
 483                 because i.e. they are already displayed somewhere
 484             :param int parent_id: context of parent_id
 485                 - if parent_id reached when adding ancestors, stop going further
 486                   in the ancestor search
 487                 - if set in flat mode, ancestor_id is set to parent_id
 488             :param int limit: number of messages to fetch, before adding the
 489                 ancestors and expandables
 490             :return list: list of message structure for the Chatter widget
 491         """
 492         assert thread_level in [0, 1], 'message_read() thread_level should be 0 (flat) or 1 (1 level of thread); given %s.' % thread_level
 493         domain = domain if domain is not None else []
 494         message_unload_ids = message_unload_ids if message_unload_ids is not None else []
 495         if message_unload_ids:
 496             domain += [('id', 'not in', message_unload_ids)]
 497         notification_obj = self.pool.get('mail.notification')
 498         limit = limit or self._message_read_limit
 499         message_tree = {}
 500         message_list = []
 501         parent_tree = {}
 502
 503         # no specific IDS given: fetch messages according to the domain, add their parents if uid has access to
 504         if ids is None:
 505             ids = self.search(cr, uid, domain, context=context, limit=limit)
 506
 507         # fetch parent if threaded, sort messages
 508         for message in self.browse(cr, uid, ids, context=context):
 509             message_id = message.id
 510             if message_id in message_tree:
 511                 continue
 512             message_tree[message_id] = message
 513
 514             # find parent_id
 515             if thread_level == 0:
 516                 tree_parent_id = parent_id
 517             else:
 518                 tree_parent_id = message_id
 519                 parent = message
 520                 while parent.parent_id and parent.parent_id.id != parent_id:
 521                     parent = parent.parent_id
 522                     tree_parent_id = parent.id
 523                 if not parent.id in message_tree:
 524                     message_tree[parent.id] = parent
 525             # newest messages first
 526             parent_tree.setdefault(tree_parent_id, [])
 527             if tree_parent_id != message_id:
 528                 parent_tree[tree_parent_id].append(self._message_read_dict(cr, uid, message_tree[message_id], parent_id=tree_parent_id, context=context))
 529
 530         if thread_level:
 531             for key, message_id_list in parent_tree.iteritems():
 532                 message_id_list.sort(key=lambda item: item['id'])
 533                 message_id_list.insert(0, self._message_read_dict(cr, uid, message_tree[key], context=context))
 534
 535         # create final ordered message_list based on parent_tree
 536         parent_list = parent_tree.items()
 537         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)
 538         message_list = [message for (key, msg_list) in parent_list for message in msg_list]
 539
 540         # get the child expandable messages for the tree
 541         self._message_read_dict_postprocess(cr, uid, message_list, message_tree, context=context)
 542         self._message_read_add_expandables(cr, uid, message_list, message_tree, parent_tree,
 543             thread_level=thread_level, message_unload_ids=message_unload_ids, domain=domain, parent_id=parent_id, context=context)
 544         return message_list
 545
 546     #------------------------------------------------------
 547     # mail_message internals
 548     #------------------------------------------------------
 549
 550     def init(self, cr):
 551         cr.execute("""SELECT indexname FROM pg_indexes WHERE indexname = 'mail_message_model_res_id_idx'""")
 552         if not cr.fetchone():
 553             cr.execute("""CREATE INDEX mail_message_model_res_id_idx ON mail_message (model, res_id)""")
 554
 555     def _find_allowed_model_wise(self, cr, uid, doc_model, doc_dict, context=None):
 556         doc_ids = doc_dict.keys()
 557         allowed_doc_ids = self.pool.get(doc_model).search(cr, uid, [('id', 'in', doc_ids)], context=context)
 558         return set([message_id for allowed_doc_id in allowed_doc_ids for message_id in doc_dict[allowed_doc_id]])
 559
 560     def _find_allowed_doc_ids(self, cr, uid, model_ids, context=None):
 561         model_access_obj = self.pool.get('ir.model.access')
 562         allowed_ids = set()
 563         for doc_model, doc_dict in model_ids.iteritems():
 564             if not model_access_obj.check(cr, uid, doc_model, 'read', False):
 565                 continue
 566             allowed_ids |= self._find_allowed_model_wise(cr, uid, doc_model, doc_dict, context=context)
 567         return allowed_ids
 568
 569     def _search(self, cr, uid, args, offset=0, limit=None, order=None,
 570         context=None, count=False, access_rights_uid=None):
 571         """ Override that adds specific access rights of mail.message, to remove
 572             ids uid could not see according to our custom rules. Please refer
 573             to check_access_rule for more details about those rules.
 574
 575             After having received ids of a classic search, keep only:
 576             - if author_id == pid, uid is the author, OR
 577             - a notification (id, pid) exists, uid has been notified, OR
 578             - uid have read access to the related document is model, res_id
 579             - otherwise: remove the id
 580         """
 581         # Rules do not apply to administrator
 582         if uid == SUPERUSER_ID:
 583             return super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
 584                 context=context, count=count, access_rights_uid=access_rights_uid)
 585         # Perform a super with count as False, to have the ids, not a counter
 586         ids = super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
 587             context=context, count=False, access_rights_uid=access_rights_uid)
 588         if not ids and count:
 589             return 0
 590         elif not ids:
 591             return ids
 592
 593         pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'])['partner_id'][0]
 594         author_ids, partner_ids, allowed_ids = set([]), set([]), set([])
 595         model_ids = {}
 596
 597         messages = super(mail_message, self).read(cr, uid, ids, ['author_id', 'model', 'res_id', 'notified_partner_ids'], context=context)
 598         for message in messages:
 599             if message.get('author_id') and message.get('author_id')[0] == pid:
 600                 author_ids.add(message.get('id'))
 601             elif pid in message.get('notified_partner_ids'):
 602                 partner_ids.add(message.get('id'))
 603             elif message.get('model') and message.get('res_id'):
 604                 model_ids.setdefault(message.get('model'), {}).setdefault(message.get('res_id'), set()).add(message.get('id'))
 605
 606         allowed_ids = self._find_allowed_doc_ids(cr, uid, model_ids, context=context)
 607         final_ids = author_ids | partner_ids | allowed_ids
 608
 609         if count:
 610             return len(final_ids)
 611         else:
 612             # re-construct a list based on ids, because set did not keep the original order
 613             id_list = [id for id in ids if id in final_ids]
 614             return id_list
 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         # all partner_ids of the mail.message have to be notified
 859         if message.partner_ids:
 860             partners_to_notify |= set(message.partner_ids)
 861         # all followers of the mail.message document have to be added as partners and notified
 862         if message.model and message.res_id:
 863             fol_obj = self.pool.get("mail.followers")
 864             # browse as SUPERUSER because rules could restrict the search results
 865             fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
 866                 ('res_model', '=', message.model),
 867                 ('res_id', '=', message.res_id),
 868                 ('subtype_ids', 'in', message.subtype_id.id)
 869                 ], context=context)
 870             partners_to_notify |= set(fo.partner_id for fo in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context))
 871         # remove me from notified partners, unless the message is written on my own wall
 872         if message.author_id and message.model == "res.partner" and message.res_id == message.author_id.id:
 873             partners_to_notify |= set([message.author_id])
 874         elif message.author_id:
 875             partners_to_notify = partners_to_notify - set([message.author_id])
 876
 877         # notify
 878         if partners_to_notify:
 879             self.write(cr, SUPERUSER_ID, [newid], {'notified_partner_ids': [(4, p.id) for p in partners_to_notify]}, context=context)
 880         notification_obj._notify(cr, uid, newid, context=context)
 881         message.refresh()
 882
 883         # An error appear when a user receive a notification without notifying
 884         # the parent message -> add a read notification for the parent
 885         if message.parent_id:
 886             # all notified_partner_ids of the mail.message have to be notified for the parented messages
 887             partners_to_parent_notify = set(message.notified_partner_ids).difference(message.parent_id.notified_partner_ids)
 888             for partner in partners_to_parent_notify:
 889                 notification_obj.create(cr, uid, {
 890                         'message_id': message.parent_id.id,
 891                         'partner_id': partner.id,
 892                         'read': True,
 893                     }, context=context)
 894
 895     #------------------------------------------------------
 896     # Tools
 897     #------------------------------------------------------
 898
 899     def check_partners_email(self, cr, uid, partner_ids, context=None):
 900         """ Verify that selected partner_ids have an email_address defined.
 901             Otherwise throw a warning. """
 902         partner_wo_email_lst = []
 903         for partner in self.pool.get('res.partner').browse(cr, uid, partner_ids, context=context):
 904             if not partner.email:
 905                 partner_wo_email_lst.append(partner)
 906         if not partner_wo_email_lst:
 907             return {}
 908         warning_msg = _('The following partners chosen as recipients for the email have no email address linked :')
 909         for partner in partner_wo_email_lst:
 910             warning_msg += '\n- %s' % (partner.name)
 911         return {'warning': {
 912                     'title': _('Partners email addresses not found'),
 913                     'message': warning_msg,
 914                     }
 915                 }