262 lines
13 KiB
Python
262 lines
13 KiB
Python
# -*- coding: utf-8 -*-
|
|
##############################################################################
|
|
#
|
|
# OpenERP, Open Source Management Solution
|
|
# Copyright (C) 2009-today OpenERP SA (<http://www.openerp.com>)
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
#
|
|
##############################################################################
|
|
|
|
import threading
|
|
|
|
from openerp.osv import osv, fields
|
|
from openerp import tools, SUPERUSER_ID
|
|
from openerp.tools.translate import _
|
|
from openerp.tools.mail import plaintext2html
|
|
|
|
class mail_followers(osv.Model):
|
|
""" mail_followers holds the data related to the follow mechanism inside
|
|
OpenERP. Partners can choose to follow documents (records) of any kind
|
|
that inherits from mail.thread. Following documents allow to receive
|
|
notifications for new messages.
|
|
A subscription is characterized by:
|
|
:param: res_model: model of the followed objects
|
|
:param: res_id: ID of resource (may be 0 for every objects)
|
|
"""
|
|
_name = 'mail.followers'
|
|
_rec_name = 'partner_id'
|
|
_log_access = False
|
|
_description = 'Document Followers'
|
|
_columns = {
|
|
'res_model': fields.char('Related Document Model',
|
|
required=True, select=1,
|
|
help='Model of the followed resource'),
|
|
'res_id': fields.integer('Related Document ID', select=1,
|
|
help='Id of the followed resource'),
|
|
'partner_id': fields.many2one('res.partner', string='Related Partner',
|
|
ondelete='cascade', required=True, select=1),
|
|
'subtype_ids': fields.many2many('mail.message.subtype', string='Subtype',
|
|
help="Message subtypes followed, meaning subtypes that will be pushed onto the user's Wall."),
|
|
}
|
|
|
|
#
|
|
# Modifying followers change access rights to individual documents. As the
|
|
# cache may contain accessible/inaccessible data, one has to refresh it.
|
|
#
|
|
def create(self, cr, uid, vals, context=None):
|
|
res = super(mail_followers, self).create(cr, uid, vals, context=context)
|
|
self.invalidate_cache(cr, uid, context=context)
|
|
return res
|
|
|
|
def write(self, cr, uid, ids, vals, context=None):
|
|
res = super(mail_followers, self).write(cr, uid, ids, vals, context=context)
|
|
self.invalidate_cache(cr, uid, context=context)
|
|
return res
|
|
|
|
def unlink(self, cr, uid, ids, context=None):
|
|
res = super(mail_followers, self).unlink(cr, uid, ids, context=context)
|
|
self.invalidate_cache(cr, uid, context=context)
|
|
return res
|
|
|
|
_sql_constraints = [('mail_followers_res_partner_res_model_id_uniq','unique(res_model,res_id,partner_id)','Error, a partner cannot follow twice the same object.')]
|
|
|
|
class mail_notification(osv.Model):
|
|
""" Class holding notifications pushed to partners. Followers and partners
|
|
added in 'contacts to notify' receive notifications. """
|
|
_name = 'mail.notification'
|
|
_rec_name = 'partner_id'
|
|
_log_access = False
|
|
_description = 'Notifications'
|
|
|
|
_columns = {
|
|
'partner_id': fields.many2one('res.partner', string='Contact',
|
|
ondelete='cascade', required=True, select=1),
|
|
'is_read': fields.boolean('Read', select=1, oldname='read'),
|
|
'starred': fields.boolean('Starred', select=1,
|
|
help='Starred message that goes into the todo mailbox'),
|
|
'message_id': fields.many2one('mail.message', string='Message',
|
|
ondelete='cascade', required=True, select=1),
|
|
}
|
|
|
|
_defaults = {
|
|
'is_read': False,
|
|
'starred': False,
|
|
}
|
|
|
|
def init(self, cr):
|
|
cr.execute('SELECT indexname FROM pg_indexes WHERE indexname = %s', ('mail_notification_partner_id_read_starred_message_id',))
|
|
if not cr.fetchone():
|
|
cr.execute('CREATE INDEX mail_notification_partner_id_read_starred_message_id ON mail_notification (partner_id, is_read, starred, message_id)')
|
|
|
|
def get_partners_to_email(self, cr, uid, ids, message, context=None):
|
|
""" Return the list of partners to notify, based on their preferences.
|
|
|
|
:param browse_record message: mail.message to notify
|
|
:param list partners_to_notify: optional list of partner ids restricting
|
|
the notifications to process
|
|
"""
|
|
notify_pids = []
|
|
for notification in self.browse(cr, uid, ids, context=context):
|
|
if notification.is_read:
|
|
continue
|
|
partner = notification.partner_id
|
|
# Do not send to partners without email address defined
|
|
if not partner.email:
|
|
continue
|
|
# Do not send to partners having same email address than the author (can cause loops or bounce effect due to messy database)
|
|
if message.author_id and message.author_id.email == partner.email:
|
|
continue
|
|
# Partner does not want to receive any emails or is opt-out
|
|
if partner.notify_email == 'none':
|
|
continue
|
|
notify_pids.append(partner.id)
|
|
return notify_pids
|
|
|
|
def get_signature_footer(self, cr, uid, user_id, res_model=None, res_id=None, context=None, user_signature=True):
|
|
""" Format a standard footer for notification emails (such as pushed messages
|
|
notification or invite emails).
|
|
Format:
|
|
<p>--<br />
|
|
Administrator
|
|
</p>
|
|
<div>
|
|
<small>Sent from <a ...>Your Company</a> using <a ...>OpenERP</a>.</small>
|
|
</div>
|
|
"""
|
|
footer = ""
|
|
if not user_id:
|
|
return footer
|
|
|
|
# add user signature
|
|
user = self.pool.get("res.users").browse(cr, SUPERUSER_ID, [user_id], context=context)[0]
|
|
if user_signature:
|
|
if user.signature:
|
|
signature = user.signature
|
|
else:
|
|
signature = "--<br />%s" % user.name
|
|
footer = tools.append_content_to_html(footer, signature, plaintext=False)
|
|
|
|
# add company signature
|
|
if user.company_id.website:
|
|
website_url = ('http://%s' % user.company_id.website) if not user.company_id.website.lower().startswith(('http:', 'https:')) \
|
|
else user.company_id.website
|
|
company = "<a style='color:inherit' href='%s'>%s</a>" % (website_url, user.company_id.name)
|
|
else:
|
|
company = user.company_id.name
|
|
sent_by = _('Sent by %(company)s using %(odoo)s')
|
|
|
|
signature_company = '<br /><small>%s</small>' % (sent_by % {
|
|
'company': company,
|
|
'odoo': "<a style='color:inherit' href='https://www.odoo.com/'>Odoo</a>"
|
|
})
|
|
footer = tools.append_content_to_html(footer, signature_company, plaintext=False, container_tag='div')
|
|
|
|
return footer
|
|
|
|
def update_message_notification(self, cr, uid, ids, message_id, partner_ids, context=None):
|
|
existing_pids = set()
|
|
new_pids = set()
|
|
new_notif_ids = []
|
|
|
|
for notification in self.browse(cr, uid, ids, context=context):
|
|
existing_pids.add(notification.partner_id.id)
|
|
|
|
# update existing notifications
|
|
self.write(cr, uid, ids, {'is_read': False}, context=context)
|
|
|
|
# create new notifications
|
|
new_pids = set(partner_ids) - existing_pids
|
|
for new_pid in new_pids:
|
|
new_notif_ids.append(self.create(cr, uid, {'message_id': message_id, 'partner_id': new_pid, 'is_read': False}, context=context))
|
|
return new_notif_ids
|
|
|
|
def _notify_email(self, cr, uid, ids, message_id, force_send=False, user_signature=True, context=None):
|
|
message = self.pool['mail.message'].browse(cr, SUPERUSER_ID, message_id, context=context)
|
|
|
|
# compute partners
|
|
email_pids = self.get_partners_to_email(cr, uid, ids, message, context=None)
|
|
if not email_pids:
|
|
return True
|
|
|
|
# compute email body (signature, company data)
|
|
body_html = message.body
|
|
# add user signature except for mail groups, where users are usually adding their own signatures already
|
|
user_id = message.author_id and message.author_id.user_ids and message.author_id.user_ids[0] and message.author_id.user_ids[0].id or None
|
|
signature_company = self.get_signature_footer(cr, uid, user_id, res_model=message.model, res_id=message.res_id, context=context, user_signature=(user_signature and message.model != 'mail.group'))
|
|
if signature_company:
|
|
body_html = tools.append_content_to_html(body_html, signature_company, plaintext=False, container_tag='div')
|
|
|
|
# compute email references
|
|
references = message.parent_id.message_id if message.parent_id else False
|
|
|
|
# custom values
|
|
custom_values = dict()
|
|
if message.model and message.res_id and self.pool.get(message.model) and hasattr(self.pool[message.model], 'message_get_email_values'):
|
|
custom_values = self.pool[message.model].message_get_email_values(cr, uid, message.res_id, message, context=context)
|
|
|
|
# create email values
|
|
max_recipients = 50
|
|
chunks = [email_pids[x:x + max_recipients] for x in xrange(0, len(email_pids), max_recipients)]
|
|
email_ids = []
|
|
for chunk in chunks:
|
|
if message.model and message.res_id and self.pool.get(message.model) and hasattr(self.pool[message.model], 'message_get_recipient_values'):
|
|
recipient_values = self.pool[message.model].message_get_recipient_values(cr, uid, message.res_id, notif_message=message, recipient_ids=chunk, context=context)
|
|
else:
|
|
recipient_values = self.pool['mail.thread'].message_get_recipient_values(cr, uid, message.res_id, notif_message=message, recipient_ids=chunk, context=context)
|
|
mail_values = {
|
|
'mail_message_id': message.id,
|
|
'auto_delete': (context or {}).get('mail_auto_delete', True),
|
|
'mail_server_id': (context or {}).get('mail_server_id', False),
|
|
'body_html': body_html,
|
|
'references': references,
|
|
}
|
|
mail_values.update(custom_values)
|
|
mail_values.update(recipient_values)
|
|
email_ids.append(self.pool.get('mail.mail').create(cr, uid, mail_values, context=context))
|
|
# NOTE:
|
|
# 1. for more than 50 followers, use the queue system
|
|
# 2. do not send emails immediately if the registry is not loaded,
|
|
# to prevent sending email during a simple update of the database
|
|
# using the command-line.
|
|
if force_send and len(chunks) < 2 and \
|
|
(not self.pool._init or
|
|
getattr(threading.currentThread(), 'testing', False)):
|
|
self.pool.get('mail.mail').send(cr, uid, email_ids, context=context)
|
|
return True
|
|
|
|
def _notify(self, cr, uid, message_id, partners_to_notify=None, context=None,
|
|
force_send=False, user_signature=True):
|
|
""" Send by email the notification depending on the user preferences
|
|
|
|
:param list partners_to_notify: optional list of partner ids restricting
|
|
the notifications to process
|
|
:param bool force_send: if True, the generated mail.mail is
|
|
immediately sent after being created, as if the scheduler
|
|
was executed for this message only.
|
|
:param bool user_signature: if True, the generated mail.mail body is
|
|
the body of the related mail.message with the author's signature
|
|
"""
|
|
notif_ids = self.search(cr, SUPERUSER_ID, [('message_id', '=', message_id), ('partner_id', 'in', partners_to_notify)], context=context)
|
|
|
|
# update or create notifications
|
|
new_notif_ids = self.update_message_notification(cr, SUPERUSER_ID, notif_ids, message_id, partners_to_notify, context=context)
|
|
|
|
# mail_notify_noemail (do not send email) or no partner_ids: do not send, return
|
|
if context and context.get('mail_notify_noemail'):
|
|
return True
|
|
|
|
# browse as SUPERUSER_ID because of access to res_partner not necessarily allowed
|
|
self._notify_email(cr, SUPERUSER_ID, new_notif_ids, message_id, force_send, user_signature, context=context)
|