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'):
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])
307 # Filter author_ids uid can see
308 partners = res_partner_obj.name_get(cr, SUPERUSER_ID, list(partner_ids), context=context)
309 partner_tree = dict((partner[0], partner) for partner in partners)
312 attachments = ir_attachment_obj.read(cr, SUPERUSER_ID, list(attachment_ids), ['id', 'datas_fname'], context=context)
313 attachments_tree = dict((attachment['id'], {'id': attachment['id'], 'filename': attachment['datas_fname']}) for attachment in attachments)
315 # 3. Update message dictionaries
316 for message_dict in messages:
317 message_id = message_dict.get('id')
318 message = message_tree[message_id]
319 if message.author_id:
320 author = partner_tree[message.author_id.id]
322 author = (0, message.email_from)
324 for partner in message.partner_ids:
325 if partner.id in partner_tree:
326 partner_ids.append(partner_tree[partner.id])
328 for attachment in message.attachment_ids:
329 if attachment.id in attachments_tree:
330 attachment_ids.append(attachments_tree[attachment.id])
331 message_dict.update({
332 'is_author': pid == author[0],
334 'partner_ids': partner_ids,
335 'attachment_ids': attachment_ids,
339 def _message_read_dict(self, cr, uid, message, parent_id=False, context=None):
340 """ Return a dict representation of the message. This representation is
341 used in the JS client code, to display the messages. Partners and
342 attachments related stuff will be done in post-processing in batch.
344 :param dict message: mail.message browse record
346 # private message: no model, no res_id
348 if not message.model or not message.res_id:
350 # votes and favorites: res.users ids, no prefetching should be done
351 vote_nb = len(message.vote_user_ids)
352 has_voted = uid in [user.id for user in message.vote_user_ids]
354 return {'id': message.id,
355 'type': message.type,
356 'body': html_email_clean(message.body or ''),
357 'model': message.model,
358 'res_id': message.res_id,
359 'record_name': message.record_name,
360 'subject': message.subject,
361 'date': message.date,
362 'to_read': message.to_read,
363 'parent_id': parent_id,
364 'is_private': is_private,
369 'has_voted': has_voted,
370 'is_favorite': message.starred,
371 'attachment_ids': [],
374 def _message_read_add_expandables(self, cr, uid, messages, message_tree, parent_tree,
375 message_unload_ids=[], thread_level=0, domain=[], parent_id=False, context=None):
376 """ Create expandables for message_read, to load new messages.
377 1. get the expandable for new threads
378 if display is flat (thread_level == 0):
379 fetch message_ids < min(already displayed ids), because we
380 want a flat display, ordered by id
382 fetch message_ids that are not childs of already displayed
384 2. get the expandables for new messages inside threads if display
386 for each thread header, search for its childs
387 for each hole in the child list based on message displayed,
390 :param list messages: list of message structure for the Chatter
391 widget to which expandables are added
392 :param dict message_tree: dict [id]: browse record of this message
393 :param dict parent_tree: dict [parent_id]: [child_ids]
394 :param list message_unload_ids: list of message_ids we do not want
398 def _get_expandable(domain, message_nb, parent_id, max_limit):
401 'nb_messages': message_nb,
402 'type': 'expandable',
403 'parent_id': parent_id,
404 'max_limit': max_limit,
409 message_ids = sorted(message_tree.keys())
411 # 1. get the expandable for new threads
412 if thread_level == 0:
413 exp_domain = domain + [('id', '<', min(message_unload_ids + message_ids))]
415 exp_domain = domain + ['!', ('id', 'child_of', message_unload_ids + parent_tree.keys())]
416 ids = self.search(cr, uid, exp_domain, context=context, limit=1)
418 # inside a thread: prepend
420 messages.insert(0, _get_expandable(exp_domain, -1, parent_id, True))
421 # new threads: append
423 messages.append(_get_expandable(exp_domain, -1, parent_id, True))
425 # 2. get the expandables for new messages inside threads if display is not flat
426 if thread_level == 0:
428 for message_id in message_ids:
429 message = message_tree[message_id]
431 # generate only for thread header messages (TDE note: parent_id may be False is uid cannot see parent_id, seems ok)
432 if message.parent_id:
435 # check there are message for expandable
436 child_ids = set([child.id for child in message.child_ids]) - set(message_unload_ids)
437 child_ids = sorted(list(child_ids), reverse=True)
441 # make groups of unread messages
442 id_min, id_max, nb = max(child_ids), 0, 0
443 for child_id in child_ids:
444 if not child_id in message_ids:
446 if id_min > child_id:
448 if id_max < child_id:
451 exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
452 idx = [msg.get('id') for msg in messages].index(child_id) + 1
453 # messages.append(_get_expandable(exp_domain, nb, message_id, False))
454 messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
455 id_min, id_max, nb = max(child_ids), 0, 0
457 id_min, id_max, nb = max(child_ids), 0, 0
459 exp_domain = [('id', '>=', id_min), ('id', '<=', id_max), ('id', 'child_of', message_id)]
460 idx = [msg.get('id') for msg in messages].index(message_id) + 1
461 # messages.append(_get_expandable(exp_domain, nb, message_id, id_min))
462 messages.insert(idx, _get_expandable(exp_domain, nb, message_id, False))
466 def message_read(self, cr, uid, ids=None, domain=None, message_unload_ids=None,
467 thread_level=0, context=None, parent_id=False, limit=None):
468 """ Read messages from mail.message, and get back a list of structured
469 messages to be displayed as discussion threads. If IDs is set,
470 fetch these records. Otherwise use the domain to fetch messages.
471 After having fetch messages, their ancestors will be added to obtain
472 well formed threads, if uid has access to them.
474 After reading the messages, expandable messages are added in the
475 message list (see ``_message_read_add_expandables``). It consists
476 in messages holding the 'read more' data: number of messages to
477 read, domain to apply.
479 :param list ids: optional IDs to fetch
480 :param list domain: optional domain for searching ids if ids not set
481 :param list message_unload_ids: optional ids we do not want to fetch,
482 because i.e. they are already displayed somewhere
483 :param int parent_id: context of parent_id
484 - if parent_id reached when adding ancestors, stop going further
485 in the ancestor search
486 - if set in flat mode, ancestor_id is set to parent_id
487 :param int limit: number of messages to fetch, before adding the
488 ancestors and expandables
489 :return list: list of message structure for the Chatter widget
491 assert thread_level in [0, 1], 'message_read() thread_level should be 0 (flat) or 1 (1 level of thread); given %s.' % thread_level
492 domain = domain if domain is not None else []
493 message_unload_ids = message_unload_ids if message_unload_ids is not None else []
494 if message_unload_ids:
495 domain += [('id', 'not in', message_unload_ids)]
496 limit = limit or self._message_read_limit
501 # no specific IDS given: fetch messages according to the domain, add their parents if uid has access to
503 ids = self.search(cr, uid, domain, context=context, limit=limit)
505 # fetch parent if threaded, sort messages
506 for message in self.browse(cr, uid, ids, context=context):
507 message_id = message.id
508 if message_id in message_tree:
510 message_tree[message_id] = message
513 if thread_level == 0:
514 tree_parent_id = parent_id
516 tree_parent_id = message_id
518 while parent.parent_id and parent.parent_id.id != parent_id:
519 parent = parent.parent_id
520 tree_parent_id = parent.id
521 if not parent.id in message_tree:
522 message_tree[parent.id] = parent
523 # newest messages first
524 parent_tree.setdefault(tree_parent_id, [])
525 if tree_parent_id != message_id:
526 parent_tree[tree_parent_id].append(self._message_read_dict(cr, uid, message_tree[message_id], parent_id=tree_parent_id, context=context))
529 for key, message_id_list in parent_tree.iteritems():
530 message_id_list.sort(key=lambda item: item['id'])
531 message_id_list.insert(0, self._message_read_dict(cr, uid, message_tree[key], context=context))
533 parent_list = parent_tree.items()
534 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)
535 message_list = [message for (key, msg_list) in parent_list for message in msg_list]
537 # get the child expandable messages for the tree
538 self._message_read_dict_postprocess(cr, uid, message_list, message_tree, context=context)
539 self._message_read_add_expandables(cr, uid, message_list, message_tree, parent_tree,
540 thread_level=thread_level, message_unload_ids=message_unload_ids, domain=domain, parent_id=parent_id, context=context)
543 #------------------------------------------------------
544 # mail_message internals
545 #------------------------------------------------------
548 cr.execute("""SELECT indexname FROM pg_indexes WHERE indexname = 'mail_message_model_res_id_idx'""")
549 if not cr.fetchone():
550 cr.execute("""CREATE INDEX mail_message_model_res_id_idx ON mail_message (model, res_id)""")
552 def _search(self, cr, uid, args, offset=0, limit=None, order=None,
553 context=None, count=False, access_rights_uid=None):
554 """ Override that adds specific access rights of mail.message, to remove
555 ids uid could not see according to our custom rules. Please refer
556 to check_access_rule for more details about those rules.
558 After having received ids of a classic search, keep only:
559 - if author_id == pid, uid is the author, OR
560 - a notification (id, pid) exists, uid has been notified, OR
561 - uid have read access to the related document is model, res_id
562 - otherwise: remove the id
564 # Rules do not apply to administrator
565 if uid == SUPERUSER_ID:
566 return super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
567 context=context, count=count, access_rights_uid=access_rights_uid)
568 # Perform a super with count as False, to have the ids, not a counter
569 ids = super(mail_message, self)._search(cr, uid, args, offset=offset, limit=limit, order=order,
570 context=context, count=False, access_rights_uid=access_rights_uid)
571 if not ids and count:
576 pid = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'])['partner_id'][0]
577 author_ids, partner_ids, allowed_ids = set([]), set([]), set([])
580 messages = super(mail_message, self).read(cr, uid, ids, ['author_id', 'model', 'res_id', 'notified_partner_ids'], context=context)
581 for message in messages:
582 if message.get('author_id') and message.get('author_id')[0] == pid:
583 author_ids.add(message.get('id'))
584 elif pid in message.get('notified_partner_ids'):
585 partner_ids.add(message.get('id'))
586 elif message.get('model') and message.get('res_id'):
587 model_ids.setdefault(message.get('model'), {}).setdefault(message.get('res_id'), set()).add(message.get('id'))
589 model_access_obj = self.pool.get('ir.model.access')
590 for doc_model, doc_dict in model_ids.iteritems():
591 if not model_access_obj.check(cr, uid, doc_model, 'read', False):
593 doc_ids = doc_dict.keys()
594 allowed_doc_ids = self.pool.get(doc_model).search(cr, uid, [('id', 'in', doc_ids)], context=context)
595 allowed_ids |= set([message_id for allowed_doc_id in allowed_doc_ids for message_id in doc_dict[allowed_doc_id]])
597 final_ids = author_ids | partner_ids | allowed_ids
599 return len(final_ids)
601 return list(final_ids)
603 def check_access_rule(self, cr, uid, ids, operation, context=None):
604 """ Access rules of mail.message:
606 - author_id == pid, uid is the author, OR
607 - mail_notification (id, pid) exists, uid has been notified, OR
608 - uid have read access to the related document if model, res_id
611 - no model, no res_id, I create a private message OR
612 - pid in message_follower_ids if model, res_id OR
613 - mail_notification (parent_id.id, pid) exists, uid has been notified of the parent, OR
614 - uid have write access on the related document if model, res_id, OR
617 - author_id == pid, uid is the author, OR
618 - uid has write access on the related document if model, res_id
621 - uid has write access on the related document if model, res_id
624 def _generate_model_record_ids(msg_val, msg_ids=[]):
625 """ :param model_record_ids: {'model': {'res_id': (msg_id, msg_id)}, ... }
626 :param message_values: {'msg_id': {'model': .., 'res_id': .., 'author_id': ..}}
628 model_record_ids = {}
630 if msg_val[id]['model'] and msg_val[id]['res_id']:
631 model_record_ids.setdefault(msg_val[id]['model'], dict()).setdefault(msg_val[id]['res_id'], set()).add(msg_val[id]['res_id'])
632 return model_record_ids
634 if uid == SUPERUSER_ID:
636 if isinstance(ids, (int, long)):
638 not_obj = self.pool.get('mail.notification')
639 fol_obj = self.pool.get('mail.followers')
640 partner_id = self.pool.get('res.users').read(cr, uid, uid, ['partner_id'], context=None)['partner_id'][0]
642 # Read mail_message.ids to have their values
643 message_values = dict.fromkeys(ids)
644 cr.execute('SELECT DISTINCT id, model, res_id, author_id, parent_id FROM "%s" WHERE id = ANY (%%s)' % self._table, (ids,))
645 for id, rmod, rid, author_id, parent_id in cr.fetchall():
646 message_values[id] = {'model': rmod, 'res_id': rid, 'author_id': author_id, 'parent_id': parent_id}
648 # Author condition (READ, WRITE, CREATE (private)) -> could become an ir.rule ?
650 if operation == 'read' or operation == 'write':
651 author_ids = [mid for mid, message in message_values.iteritems()
652 if message.get('author_id') and message.get('author_id') == partner_id]
653 elif operation == 'create':
654 author_ids = [mid for mid, message in message_values.iteritems()
655 if not message.get('model') and not message.get('res_id')]
657 # Parent condition, for create (check for received notifications for the created message parent)
659 if operation == 'create':
660 parent_ids = [message.get('parent_id') for mid, message in message_values.iteritems()
661 if message.get('parent_id')]
662 not_ids = not_obj.search(cr, SUPERUSER_ID, [('message_id.id', 'in', parent_ids), ('partner_id', '=', partner_id)], context=context)
663 not_parent_ids = [notif.message_id.id for notif in not_obj.browse(cr, SUPERUSER_ID, not_ids, context=context)]
664 notified_ids += [mid for mid, message in message_values.iteritems()
665 if message.get('parent_id') in not_parent_ids]
667 # 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
668 other_ids = set(ids).difference(set(author_ids), set(notified_ids))
669 model_record_ids = _generate_model_record_ids(message_values, other_ids)
670 if operation == 'read':
671 not_ids = not_obj.search(cr, SUPERUSER_ID, [
672 ('partner_id', '=', partner_id),
673 ('message_id', 'in', ids),
675 notified_ids = [notification.message_id.id for notification in not_obj.browse(cr, SUPERUSER_ID, not_ids, context=context)]
676 elif operation == 'create':
677 for doc_model, doc_dict in model_record_ids.items():
678 fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
679 ('res_model', '=', doc_model),
680 ('res_id', 'in', list(doc_dict.keys())),
681 ('partner_id', '=', partner_id),
683 fol_mids = [follower.res_id for follower in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context)]
684 notified_ids += [mid for mid, message in message_values.iteritems()
685 if message.get('model') == doc_model and message.get('res_id') in fol_mids]
687 # CRUD: Access rights related to the document
688 other_ids = other_ids.difference(set(notified_ids))
689 model_record_ids = _generate_model_record_ids(message_values, other_ids)
690 document_related_ids = []
691 for model, doc_dict in model_record_ids.items():
692 model_obj = self.pool.get(model)
693 mids = model_obj.exists(cr, uid, doc_dict.keys())
694 if operation in ['create', 'write', 'unlink']:
695 model_obj.check_access_rights(cr, uid, 'write')
696 model_obj.check_access_rule(cr, uid, mids, 'write', context=context)
698 model_obj.check_access_rights(cr, uid, operation)
699 model_obj.check_access_rule(cr, uid, mids, operation, context=context)
700 document_related_ids += [mid for mid, message in message_values.iteritems()
701 if message.get('model') == model and message.get('res_id') in mids]
703 # Calculate remaining ids: if not void, raise an error
704 other_ids = other_ids.difference(set(document_related_ids))
707 raise orm.except_orm(_('Access Denied'),
708 _('The requested operation cannot be completed due to security restrictions. Please contact your system administrator.\n\n(Document type: %s, Operation: %s)') % \
709 (self._description, operation))
711 def create(self, cr, uid, values, context=None):
714 default_starred = context.pop('default_starred', False)
715 if not values.get('message_id') and values.get('res_id') and values.get('model'):
716 values['message_id'] = tools.generate_tracking_message_id('%(res_id)s-%(model)s' % values)
717 elif not values.get('message_id'):
718 values['message_id'] = tools.generate_tracking_message_id('private')
719 newid = super(mail_message, self).create(cr, uid, values, context)
720 self._notify(cr, uid, newid, context=context)
721 # TDE FIXME: handle default_starred. Why not setting an inv on starred ?
722 # Because starred will call set_message_starred, that looks for notifications.
723 # When creating a new mail_message, it will create a notification to a message
724 # that does not exist, leading to an error (key not existing). Also this
725 # this means unread notifications will be created, yet we can not assure
726 # this is what we want.
728 self.set_message_starred(cr, uid, [newid], True, context=context)
731 def read(self, cr, uid, ids, fields=None, context=None, load='_classic_read'):
732 """ Override to explicitely call check_access_rule, that is not called
733 by the ORM. It instead directly fetches ir.rules and apply them. """
734 self.check_access_rule(cr, uid, ids, 'read', context=context)
735 res = super(mail_message, self).read(cr, uid, ids, fields=fields, context=context, load=load)
738 def unlink(self, cr, uid, ids, context=None):
739 # cascade-delete attachments that are directly attached to the message (should only happen
740 # for mail.messages that act as parent for a standalone mail.mail record).
741 self.check_access_rule(cr, uid, ids, 'unlink', context=context)
742 attachments_to_delete = []
743 for message in self.browse(cr, uid, ids, context=context):
744 for attach in message.attachment_ids:
745 if attach.res_model == self._name and attach.res_id == message.id:
746 attachments_to_delete.append(attach.id)
747 if attachments_to_delete:
748 self.pool.get('ir.attachment').unlink(cr, uid, attachments_to_delete, context=context)
749 return super(mail_message, self).unlink(cr, uid, ids, context=context)
751 def copy(self, cr, uid, id, default=None, context=None):
752 """ Overridden to avoid duplicating fields that are unique to each email """
755 default.update(message_id=False, headers=False)
756 return super(mail_message, self).copy(cr, uid, id, default=default, context=context)
758 #------------------------------------------------------
760 #------------------------------------------------------
762 # TDE note: this code is not used currently, will be improved in a future merge, when quoted context
763 # will be added to email send for notifications. Currently only WIP.
764 MAIL_TEMPLATE = """<div>
766 ${display_message(message)}
768 % for ctx_msg in context_messages:
769 ${display_message(ctx_msg)}
772 ${display_expandable()}
774 ${display_message(header_message)}
777 <%def name="display_message(message)">
779 Subject: ${message.subject}<br />
780 Body: ${message.body}
784 <%def name="display_expandable()">
785 <div>This is an expandable.</div>
789 def message_quote_context(self, cr, uid, id, context=None, limit=3, add_original=False):
791 1. message.parent_id = False: new thread, no quote_context
792 2. get the lasts messages in the thread before message
793 3. get the message header
794 4. add an expandable between them
796 :param dict quote_context: options for quoting
797 :return string: html quote
799 add_expandable = False
801 message = self.browse(cr, uid, id, context=context)
802 if not message.parent_id:
804 context_ids = self.search(cr, uid, [
805 ('parent_id', '=', message.parent_id.id),
806 ('id', '<', message.id),
807 ], limit=limit, context=context)
809 if len(context_ids) >= limit:
810 add_expandable = True
811 context_ids = context_ids[0:-1]
813 context_ids.append(message.parent_id.id)
814 context_messages = self.browse(cr, uid, context_ids, context=context)
815 header_message = context_messages.pop()
820 result = MakoTemplate(self.MAIL_TEMPLATE).render_unicode(message=message,
821 context_messages=context_messages,
822 header_message=header_message,
823 add_expandable=add_expandable,
824 # context kw would clash with mako internals
826 format_exceptions=True)
827 result = result.strip()
830 _logger.exception("failed to render mako template for quoting message")
834 def _notify(self, cr, uid, newid, context=None):
835 """ Add the related record followers to the destination partner_ids if is not a private message.
836 Call mail_notification.notify to manage the email sending
838 notification_obj = self.pool.get('mail.notification')
839 message = self.browse(cr, uid, newid, context=context)
841 partners_to_notify = set([])
842 # message has no subtype_id: pure log message -> no partners, no one notified
843 if not message.subtype_id:
845 # all partner_ids of the mail.message have to be notified
846 if message.partner_ids:
847 partners_to_notify |= set(message.partner_ids)
848 # all followers of the mail.message document have to be added as partners and notified
849 if message.model and message.res_id:
850 fol_obj = self.pool.get("mail.followers")
851 fol_ids = fol_obj.search(cr, SUPERUSER_ID, [
852 ('res_model', '=', message.model),
853 ('res_id', '=', message.res_id),
854 ('subtype_ids', 'in', message.subtype_id.id)
856 partners_to_notify |= set(fo.partner_id for fo in fol_obj.browse(cr, SUPERUSER_ID, fol_ids, context=context))
857 # remove me from notified partners, unless the message is written on my own wall
858 if message.author_id and message.model == "res.partner" and message.res_id == message.author_id.id:
859 partners_to_notify |= set([message.author_id])
860 elif message.author_id:
861 partners_to_notify = partners_to_notify - set([message.author_id])
863 if partners_to_notify:
864 self.write(cr, SUPERUSER_ID, [newid], {'notified_partner_ids': [(4, p.id) for p in partners_to_notify]}, context=context)
866 notification_obj._notify(cr, uid, newid, context=context)
868 # An error appear when a user receive a notify to a message without notify to his parent message.
869 # Add a notification with read = true to the parented message if there are no notification
870 if message.parent_id:
871 # all notified_partner_ids of the mail.message have to be notified for the parented messages
872 if message.notified_partner_ids:
873 partners_to_notify |= set(message.notified_partner_ids)
874 partners_to_parent_notify = set(partners_to_notify) - set(message.parent_id.notified_partner_ids)
875 for partner in partners_to_parent_notify:
876 notification_obj.create(cr, uid, {
877 'message_id': message.parent_id.id,
878 'partner_id': partner.id,
882 #------------------------------------------------------
884 #------------------------------------------------------
886 def check_partners_email(self, cr, uid, partner_ids, context=None):
887 """ Verify that selected partner_ids have an email_address defined.
888 Otherwise throw a warning. """
889 partner_wo_email_lst = []
890 for partner in self.pool.get('res.partner').browse(cr, uid, partner_ids, context=context):
891 if not partner.email:
892 partner_wo_email_lst.append(partner)
893 if not partner_wo_email_lst:
895 warning_msg = _('The following partners chosen as recipients for the email have no email address linked :')
896 for partner in partner_wo_email_lst:
897 warning_msg += '\n- %s' % (partner.name)
899 'title': _('Partners email addresses not found'),
900 'message': warning_msg,