1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2010-today OpenERP SA (<http://www.openerp.com>)
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
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
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/>
20 ##############################################################################
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 _
31 _logger = logging.getLogger(__name__)
34 from mako.template import Template as MakoTemplate
36 _logger.warning("payment_acquirer: mako templates not available, payment acquirer will not work!")
39 """ Some tools for parsing / creating email fields """
41 """Returns unicode() string conversion of the the given encoded smtp header text"""
43 text = decode_header(text.replace('\r', ''))
44 return ''.join([tools.ustr(x[0], x[1]) for x in text])
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']
54 _rec_name = 'record_name'
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
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)
68 def _shorten_name(self, name):
69 if len(name) <= (self._message_record_name_length + 3):
71 return name[:self._message_record_name_length] + '...'
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']):
81 result[message['id']] = self._shorten_name(self.pool.get(message['model']).name_get(cr, SUPERUSER_ID, [message['res_id']], context=context)[0][1])
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),
94 for notif in notif_obj.browse(cr, uid, notif_ids, context=context):
95 res[notif.message_id.id] = True
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])]
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),
113 for notif in notif_obj.browse(cr, uid, notif_ids, context=context):
114 res[notif.message_id.id] = True
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])]
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)):
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(' :'))))
133 'type': fields.selection([
135 ('comment', 'Comment'),
136 ('notification', 'System notification'),
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,
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'),
179 def _needaction_domain_get(self, cr, uid, context=None):
180 return [('to_read', '=', True)]
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]
187 'date': lambda *a: fields.datetime.now(),
188 'author_id': lambda self, cr, uid, ctx={}: self._get_default_author(cr, uid, ctx),
192 #------------------------------------------------------
194 #------------------------------------------------------
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'))
202 self.write(cr, SUPERUSER_ID, message.get('id'), {'vote_user_ids': [(4, uid)]}, context=context)
204 self.write(cr, SUPERUSER_ID, message.get('id'), {'vote_user_ids': [(3, uid)]}, context=context)
205 return new_has_voted or False
207 #------------------------------------------------------
208 # download an attachment
209 #------------------------------------------------------
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:
218 'base64': attachment.datas,
219 'filename': attachment.datas_fname,
223 #------------------------------------------------------
225 #------------------------------------------------------
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),
233 :param bool read: set notification as (un)read
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)
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)
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)
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),
259 :param bool starred: set notification as (un)starred
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)
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)
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)
281 #------------------------------------------------------
282 # Message loading for web interface
283 #------------------------------------------------------
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.
289 :param list messages: list of message, as get_dict result
290 :param dict message_tree: {[msg.id]: msg browse record}
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]
296 # 1. Aggregate partners (author_id and partner_ids) and attachments
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)
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)
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]
321 author = (0, message.email_from)
323 for partner in message.partner_ids:
324 if partner.id in partner_tree:
325 partner_ids.append(partner_tree[partner.id])
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],
333 'partner_ids': partner_ids,
334 'attachment_ids': attachment_ids,
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.
343 :param dict message: mail.message browse record
345 # private message: no model, no res_id
347 if not message.model or not message.res_id:
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]
353 return {'id': message.id,
354 'type': message.type,
355 'body': html_email_clean(message.body or ''),
356 'model': message.model,
357 'res_id': message.res_id,
358 'record_name': message.record_name,
359 'subject': message.subject,
360 'date': message.date,
361 'to_read': message.to_read,
362 'parent_id': parent_id,
363 'is_private': is_private,
368 'has_voted': has_voted,
369 'is_favorite': message.starred,
370 'attachment_ids': [],
373 def _message_read_add_expandables(self, cr, uid, messages, message_tree, parent_tree,
374 message_unload_ids=[], thread_level=0, domain=[], parent_id=False, context=None):
375 """ Create expandables for message_read, to load new messages.
376 1. get the expandable for new threads
377 if display is flat (thread_level == 0):
378 fetch message_ids < min(already displayed ids), because we
379 want a flat display, ordered by id
381 fetch message_ids that are not childs of already displayed
383 2. get the expandables for new messages inside threads if display
385 for each thread header, search for its childs
386 for each hole in the child list based on message displayed,
389 :param list messages: list of message structure for the Chatter
390 widget to which expandables are added
391 :param dict message_tree: dict [id]: browse record of this message
392 :param dict parent_tree: dict [parent_id]: [child_ids]
393 :param list message_unload_ids: list of message_ids we do not want
397 def _get_expandable(domain, message_nb, parent_id, max_limit):
400 'nb_messages': message_nb,
401 'type': 'expandable',
402 'parent_id': parent_id,
403 'max_limit': max_limit,
408 message_ids = sorted(message_tree.keys())
410 # 1. get the expandable for new threads
411 if thread_level == 0:
412 exp_domain = domain + [('id', '<', min(message_unload_ids + message_ids))]
414 exp_domain = domain + ['!', ('id', 'child_of', message_unload_ids + parent_tree.keys())]
415 ids = self.search(cr, uid, exp_domain, context=context, limit=1)
417 # inside a thread: prepend
419 messages.insert(0, _get_expandable(exp_domain, -1, parent_id, True))
420 # new threads: append
422 messages.append(_get_expandable(exp_domain, -1, parent_id, True))
424 # 2. get the expandables for new messages inside threads if display is not flat
425 if thread_level == 0:
427 for message_id in message_ids:
428 message = message_tree[message_id]
430 # generate only for thread header messages (TDE note: parent_id may be False is uid cannot see parent_id, seems ok)
431 if message.parent_id:
434 # check there are message for expandable
435 child_ids = set([child.id for child in message.child_ids]) - set(message_unload_ids)
436 child_ids = sorted(list(child_ids), reverse=True)
440 # make groups of unread messages
441 id_min, id_max, nb = max(child_ids), 0, 0
442 for child_id in child_ids:
443 if not child_id in message_ids:
445 if id_min > child_id:
447 if id_max < child_id:
450 exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
451 idx = [msg.get('id') for msg in messages].index(child_id) + 1
452 # messages.append(_get_expandable(exp_domain, nb, message_id, False))
453 messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
454 id_min, id_max, nb = max(child_ids), 0, 0
456 id_min, id_max, nb = max(child_ids), 0, 0
458 exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
459 idx = [msg.get('id') for msg in messages].index(message_id) + 1
460 # messages.append(_get_expandable(exp_domain, nb, message_id, id_min))
461 messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
465 def message_read(self, cr, uid, ids=None, domain=None, message_unload_ids=None,
466 thread_level=0, context=None, parent_id=False, limit=None):
467 """ Read messages from mail.message, and get back a list of structured
468 messages to be displayed as discussion threads. If IDs is set,
469 fetch these records. Otherwise use the domain to fetch messages.
470 After having fetch messages, their ancestors will be added to obtain
471 well formed threads, if uid has access to them.
473 After reading the messages, expandable messages are added in the
474 message list (see ``_message_read_add_expandables``). It consists
475 in messages holding the 'read more' data: number of messages to
476 read, domain to apply.
478 :param list ids: optional IDs to fetch
479 :param list domain: optional domain for searching ids if ids not set
480 :param list message_unload_ids: optional ids we do not want to fetch,
481 because i.e. they are already displayed somewhere
482 :param int parent_id: context of parent_id
483 - if parent_id reached when adding ancestors, stop going further
484 in the ancestor search
485 - if set in flat mode, ancestor_id is set to parent_id
486 :param int limit: number of messages to fetch, before adding the
487 ancestors and expandables
488 :return list: list of message structure for the Chatter widget
490 assert thread_level in [0, 1], 'message_read() thread_level should be 0 (flat) or 1 (1 level of thread); given %s.' % thread_level
491 domain = domain if domain is not None else []
492 message_unload_ids = message_unload_ids if message_unload_ids is not None else []
493 if message_unload_ids:
494 domain += [('id', 'not in', message_unload_ids)]
495 limit = limit or self._message_read_limit
500 # no specific IDS given: fetch messages according to the domain, add their parents if uid has access to
502 ids = self.search(cr, uid, domain, context=context, limit=limit)
504 # fetch parent if threaded, sort messages
505 for message in self.browse(cr, uid, ids, context=context):
506 message_id = message.id
507 if message_id in message_tree:
509 message_tree[message_id] = message
512 if thread_level == 0:
513 tree_parent_id = parent_id
515 tree_parent_id = message_id
517 while parent.parent_id and parent.parent_id.id != parent_id:
518 parent = parent.parent_id
519 tree_parent_id = parent.id
520 if not parent.id in message_tree:
521 message_tree[parent.id] = parent
522 # newest messages first
523 parent_tree.setdefault(tree_parent_id, [])
524 if tree_parent_id != message_id:
525 parent_tree[tree_parent_id].append(self._message_read_dict(cr, uid, message_tree[message_id], parent_id=tree_parent_id, context=context))
528 for key, message_id_list in parent_tree.iteritems():
529 message_id_list.sort(key=lambda item: item['id'])
530 message_id_list.insert(0, self._message_read_dict(cr, uid, message_tree[key], context=context))
532 parent_list = parent_tree.items()
533 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)
534 message_list = [message for (key, msg_list) in parent_list for message in msg_list]
536 # get the child expandable messages for the tree
537 self._message_read_dict_postprocess(cr, uid, message_list, message_tree, context=context)
538 self._message_read_add_expandables(cr, uid, message_list, message_tree, parent_tree,
539 thread_level=thread_level, message_unload_ids=message_unload_ids, domain=domain, parent_id=parent_id, context=context)
542 #------------------------------------------------------
543 # mail_message internals
544 #------------------------------------------------------
547 cr.execute("""SELECT indexname FROM pg_indexes WHERE indexname = 'mail_message_model_res_id_idx'""")
548 if not cr.fetchone():
549 cr.execute("""CREATE INDEX mail_message_model_res_id_idx ON mail_message (model, res_id)""")
551 def _find_allowed_model_wise(self, cr, uid, doc_model, doc_dict, context=None):
552 doc_ids = doc_dict.keys()
553 allowed_doc_ids = self.pool.get(doc_model).search(cr, uid, [('id', 'in', doc_ids)], context=context)
554 return set([message_id for allowed_doc_id in allowed_doc_ids for message_id in doc_dict[allowed_doc_id]])
556 def _find_allowed_doc_ids(self, cr, uid, model_ids, context=None):
557 model_access_obj = self.pool.get('ir.model.access')
559 for doc_model, doc_dict in model_ids.iteritems():
560 if not model_access_obj.check(cr, uid, doc_model, 'read', False):
562 allowed_ids |= self._find_allowed_model_wise(cr, uid, doc_model, doc_dict, context=context)
565 def _search(self, cr, uid, args, offset=0, limit=None, order=None,
566 context=None, count=False, access_rights_uid=None):
567 """ Override that adds specific access rights of mail.message, to remove
568 ids uid could not see according to our custom rules. Please refer
569 to check_access_rule for more details about those rules.
571 After having received ids of a classic search, keep only:
572 - if author_id == pid, uid is the author, OR
573 - a notification (id, pid) exists, uid has been notified, OR
574 - uid have read access to the related document is model, res_id
575 - otherwise: remove the id
577 # Rules do not apply to administrator
578 if uid == SUPERUSER_ID:
579 return super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
580 context=context, count=count, access_rights_uid=access_rights_uid)
581 # Perform a super with count as False, to have the ids, not a counter
582 ids = super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
583 context=context, count=False, access_rights_uid=access_rights_uid)
584 if not ids and count:
589 pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'])['partner_id'][0]
590 author_ids, partner_ids, allowed_ids = set([]), set([]), set([])
593 messages = super(mail_message, self).read(cr, uid, ids, ['author_id', 'model', 'res_id', 'notified_partner_ids'], context=context)
594 for message in messages:
595 if message.get('author_id') and message.get('author_id')[0] == pid:
596 author_ids.add(message.get('id'))
597 elif pid in message.get('notified_partner_ids'):
598 partner_ids.add(message.get('id'))
599 elif message.get('model') and message.get('res_id'):
600 model_ids.setdefault(message.get('model'), {}).setdefault(message.get('res_id'), set()).add(message.get('id'))
602 allowed_ids = self._find_allowed_doc_ids(cr, uid, model_ids, context=context)
604 final_ids = author_ids | partner_ids | allowed_ids
606 return len(final_ids)
608 return list(final_ids)
610 def check_access_rule(self, cr, uid, ids, operation, context=None):
611 """ Access rules of mail.message:
613 - author_id == pid, uid is the author, OR
614 - mail_notification (id, pid) exists, uid has been notified, OR
615 - uid have read access to the related document if model, res_id
618 - no model, no res_id, I create a private message OR
619 - pid in message_follower_ids if model, res_id OR
620 - mail_notification (parent_id.id, pid) exists, uid has been notified of the parent, OR
621 - uid have write access on the related document if model, res_id, OR
624 - author_id == pid, uid is the author, OR
625 - uid has write access on the related document if model, res_id
628 - uid has write access on the related document if model, res_id
631 def _generate_model_record_ids(msg_val, msg_ids=[]):
632 """ :param model_record_ids: {'model': {'res_id': (msg_id, msg_id)}, ... }
633 :param message_values: {'msg_id': {'model': .., 'res_id': .., 'author_id': ..}}
635 model_record_ids = {}
637 if msg_val[id]['model'] and msg_val[id]['res_id']:
638 model_record_ids.setdefault(msg_val[id]['model'], dict()).setdefault(msg_val[id]['res_id'], set()).add(msg_val[id]['res_id'])
639 return model_record_ids
641 if uid == SUPERUSER_ID:
643 if isinstance(ids, (int, long)):
645 not_obj = self.pool.get('mail.notification')
646 fol_obj = self.pool.get('mail.followers')
647 partner_id = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=None)['partner_id'][0]
649 # Read mail_message.ids to have their values
650 message_values = dict.fromkeys(ids)
651 cr.execute('SELECT DISTINCT id, model, res_id, author_id, parent_id FROM "%s" WHERE id = ANY (%%s)' % self._table, (ids,))
652 for id, rmod, rid, author_id, parent_id in cr.fetchall():
653 message_values[id] = {'model': rmod, 'res_id': rid, 'author_id': author_id, 'parent_id': parent_id}
655 # Author condition (READ, WRITE, CREATE (private)) -> could become an ir.rule ?
657 if operation == 'read' or operation == 'write':
658 author_ids = [mid for mid, message in message_values.iteritems()
659 if message.get('author_id') and message.get('author_id') == partner_id]
660 elif operation == 'create':
661 author_ids = [mid for mid, message in message_values.iteritems()
662 if not message.get('model') and not message.get('res_id')]
664 # Parent condition, for create (check for received notifications for the created message parent)
666 if operation == 'create':
667 parent_ids = [message.get('parent_id') for mid, message in message_values.iteritems()
668 if message.get('parent_id')]
669 not_ids = not_obj.search(cr, SUPERUSER_ID, [('message_id.id', 'in', parent_ids), ('partner_id', '=', partner_id)], context=context)
670 not_parent_ids = [notif.message_id.id for notif in not_obj.browse(cr, SUPERUSER_ID, not_ids, context=context)]
671 notified_ids += [mid for mid, message in message_values.iteritems()
672 if message.get('parent_id') in not_parent_ids]
674 # 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
675 other_ids = set(ids).difference(set(author_ids), set(notified_ids))
676 model_record_ids = _generate_model_record_ids(message_values, other_ids)
677 if operation == 'read':
678 not_ids = not_obj.search(cr, SUPERUSER_ID, [
679 ('partner_id', '=', partner_id),
680 ('message_id', 'in', ids),
682 notified_ids = [notification.message_id.id for notification in not_obj.browse(cr, SUPERUSER_ID, not_ids, context=context)]
683 elif operation == 'create':
684 for doc_model, doc_dict in model_record_ids.items():
685 fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
686 ('res_model', '=', doc_model),
687 ('res_id', 'in', list(doc_dict.keys())),
688 ('partner_id', '=', partner_id),
690 fol_mids = [follower.res_id for follower in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context)]
691 notified_ids += [mid for mid, message in message_values.iteritems()
692 if message.get('model') == doc_model and message.get('res_id') in fol_mids]
694 # CRUD: Access rights related to the document
695 other_ids = other_ids.difference(set(notified_ids))
696 model_record_ids = _generate_model_record_ids(message_values, other_ids)
697 document_related_ids = []
698 for model, doc_dict in model_record_ids.items():
699 model_obj = self.pool.get(model)
700 mids = model_obj.exists(cr, uid, doc_dict.keys())
701 if operation in ['create', 'write', 'unlink']:
702 model_obj.check_access_rights(cr, uid, 'write')
703 model_obj.check_access_rule(cr, uid, mids, 'write', context=context)
705 model_obj.check_access_rights(cr, uid, operation)
706 model_obj.check_access_rule(cr, uid, mids, operation, context=context)
707 document_related_ids += [mid for mid, message in message_values.iteritems()
708 if message.get('model') == model and message.get('res_id') in mids]
710 # Calculate remaining ids: if not void, raise an error
711 other_ids = other_ids.difference(set(document_related_ids))
714 raise orm.except_orm(_('Access Denied'),
715 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
716 (self._description, operation))
718 def create(self, cr, uid, values, context=None):
721 default_starred = context.pop('default_starred', False)
722 if not values.get('message_id') and values.get('res_id') and values.get('model'):
723 values['message_id'] = tools.generate_tracking_message_id('%(res_id)s-%(model)s' % values)
724 elif not values.get('message_id'):
725 values['message_id'] = tools.generate_tracking_message_id('private')
726 newid = super(mail_message, self).create(cr, uid, values, context)
727 self._notify(cr, uid, newid, context=context)
728 # TDE FIXME: handle default_starred. Why not setting an inv on starred ?
729 # Because starred will call set_message_starred, that looks for notifications.
730 # When creating a new mail_message, it will create a notification to a message
731 # that does not exist, leading to an error (key not existing). Also this
732 # this means unread notifications will be created, yet we can not assure
733 # this is what we want.
735 self.set_message_starred(cr, uid, [newid], True, context=context)
738 def read(self, cr, uid, ids, fields=None, context=None, load='_classic_read'):
739 """ Override to explicitely call check_access_rule, that is not called
740 by the ORM. It instead directly fetches ir.rules and apply them. """
741 self.check_access_rule(cr, uid, ids, 'read', context=context)
742 res = super(mail_message, self).read(cr, uid, ids, fields=fields, context=context, load=load)
745 def unlink(self, cr, uid, ids, context=None):
746 # cascade-delete attachments that are directly attached to the message (should only happen
747 # for mail.messages that act as parent for a standalone mail.mail record).
748 self.check_access_rule(cr, uid, ids, 'unlink', context=context)
749 attachments_to_delete = []
750 for message in self.browse(cr, uid, ids, context=context):
751 for attach in message.attachment_ids:
752 if attach.res_model == self._name and attach.res_id == message.id:
753 attachments_to_delete.append(attach.id)
754 if attachments_to_delete:
755 self.pool.get('ir.attachment').unlink(cr, uid, attachments_to_delete, context=context)
756 return super(mail_message, self).unlink(cr, uid, ids, context=context)
758 def copy(self, cr, uid, id, default=None, context=None):
759 """ Overridden to avoid duplicating fields that are unique to each email """
762 default.update(message_id=False, headers=False)
763 return super(mail_message, self).copy(cr, uid, id, default=default, context=context)
765 #------------------------------------------------------
767 #------------------------------------------------------
769 # TDE note: this code is not used currently, will be improved in a future merge, when quoted context
770 # will be added to email send for notifications. Currently only WIP.
771 MAIL_TEMPLATE = """<div>
773 ${display_message(message)}
775 % for ctx_msg in context_messages:
776 ${display_message(ctx_msg)}
779 ${display_expandable()}
781 ${display_message(header_message)}
784 <%def name="display_message(message)">
786 Subject: ${message.subject}<br />
787 Body: ${message.body}
791 <%def name="display_expandable()">
792 <div>This is an expandable.</div>
796 def message_quote_context(self, cr, uid, id, context=None, limit=3, add_original=False):
798 1. message.parent_id = False: new thread, no quote_context
799 2. get the lasts messages in the thread before message
800 3. get the message header
801 4. add an expandable between them
803 :param dict quote_context: options for quoting
804 :return string: html quote
806 add_expandable = False
808 message = self.browse(cr, uid, id, context=context)
809 if not message.parent_id:
811 context_ids = self.search(cr, uid, [
812 ('parent_id', '=', message.parent_id.id),
813 ('id', '<', message.id),
814 ], limit=limit, context=context)
816 if len(context_ids) >= limit:
817 add_expandable = True
818 context_ids = context_ids[0:-1]
820 context_ids.append(message.parent_id.id)
821 context_messages = self.browse(cr, uid, context_ids, context=context)
822 header_message = context_messages.pop()
827 result = MakoTemplate(self.MAIL_TEMPLATE).render_unicode(message=message,
828 context_messages=context_messages,
829 header_message=header_message,
830 add_expandable=add_expandable,
831 # context kw would clash with mako internals
833 format_exceptions=True)
834 result = result.strip()
837 _logger.exception("failed to render mako template for quoting message")
841 def _notify(self, cr, uid, newid, context=None):
842 """ Add the related record followers to the destination partner_ids if is not a private message.
843 Call mail_notification.notify to manage the email sending
845 notification_obj = self.pool.get('mail.notification')
846 message = self.browse(cr, uid, newid, context=context)
848 partners_to_notify = set([])
849 # message has no subtype_id: pure log message -> no partners, no one notified
850 if not message.subtype_id:
852 # all partner_ids of the mail.message have to be notified
853 if message.partner_ids:
854 partners_to_notify |= set(message.partner_ids)
855 # all followers of the mail.message document have to be added as partners and notified
856 if message.model and message.res_id:
857 fol_obj = self.pool.get("mail.followers")
858 # browse as SUPERUSER because rules could restrict the search results
859 fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
860 ('res_model', '=', message.model),
861 ('res_id', '=', message.res_id),
862 ('subtype_ids', 'in', message.subtype_id.id)
864 partners_to_notify |= set(fo.partner_id for fo in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context))
865 # remove me from notified partners, unless the message is written on my own wall
866 if message.author_id and message.model == "res.partner" and message.res_id == message.author_id.id:
867 partners_to_notify |= set([message.author_id])
868 elif message.author_id:
869 partners_to_notify = partners_to_notify - set([message.author_id])
872 if partners_to_notify:
873 self.write(cr, SUPERUSER_ID, [newid], {'notified_partner_ids': [(4, p.id) for p in partners_to_notify]}, context=context)
874 notification_obj._notify(cr, uid, newid, context=context)
877 # An error appear when a user receive a notification without notifying
878 # the parent message -> add a read notification for the parent
879 if message.parent_id:
880 # all notified_partner_ids of the mail.message have to be notified for the parented messages
881 partners_to_parent_notify = set(message.notified_partner_ids).difference(message.parent_id.notified_partner_ids)
882 for partner in partners_to_parent_notify:
883 notification_obj.create(cr, uid, {
884 'message_id': message.parent_id.id,
885 'partner_id': partner.id,
889 #------------------------------------------------------
891 #------------------------------------------------------
893 def check_partners_email(self, cr, uid, partner_ids, context=None):
894 """ Verify that selected partner_ids have an email_address defined.
895 Otherwise throw a warning. """
896 partner_wo_email_lst = []
897 for partner in self.pool.get('res.partner').browse(cr, uid, partner_ids, context=context):
898 if not partner.email:
899 partner_wo_email_lst.append(partner)
900 if not partner_wo_email_lst:
902 warning_msg = _('The following partners chosen as recipients for the email have no email address linked :')
903 for partner in partner_wo_email_lst:
904 warning_msg += '\n- %s' % (partner.name)
906 'title': _('Partners email addresses not found'),
907 'message': warning_msg,