# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import base64
import logging
from collections import defaultdict
from hashlib import sha512
from secrets import choice
from odoo import _, api, fields, models, tools, Command
from odoo.addons.base.models.avatar_mixin import get_hsl_from_seed
from odoo.exceptions import UserError, ValidationError
from odoo.osv import expression
from odoo.tools import html_escape
from odoo.tools.misc import DEFAULT_SERVER_DATETIME_FORMAT
_logger = logging.getLogger(__name__)
channel_avatar = ''''''
group_avatar = ''''''
class Channel(models.Model):
""" A mail.channel is a discussion group that may behave like a listener
on documents. """
_description = 'Discussion Channel'
_name = 'mail.channel'
_mail_flat_thread = False
_mail_post_access = 'read'
_inherit = ['mail.thread']
MAX_BOUNCE_LIMIT = 10
@api.model
def _generate_random_token(self):
# Built to be shared on invitation link. It uses non-ambiguous characters and it is of a
# reasonable length: enough to avoid brute force, but short enough to be shareable easily.
# This token should not contain "mail.guest"._cookie_separator value.
return ''.join(choice('abcdefghijkmnopqrstuvwxyzABCDEFGHIJKLMNPQRSTUVWXYZ23456789') for _i in range(10))
# description
name = fields.Char('Name', required=True)
active = fields.Boolean(default=True, help="Set active to false to hide the channel without removing it.")
channel_type = fields.Selection([
('chat', 'Chat'),
('channel', 'Channel'),
('group', 'Group')],
string='Channel Type', required=True, default='channel', readonly=True, help="Chat is private and unique between 2 persons. Group is private among invited persons. Channel can be freely joined (depending on its configuration).")
is_chat = fields.Boolean(string='Is a chat', compute='_compute_is_chat')
default_display_mode = fields.Selection(string="Default Display Mode", selection=[('video_full_screen', "Full screen video")], help="Determines how the channel will be displayed by default when opening it from its invitation link. No value means display text (no voice/video).")
description = fields.Text('Description')
image_128 = fields.Image("Image", max_width=128, max_height=128)
avatar_128 = fields.Image("Avatar", max_width=128, max_height=128, compute='_compute_avatar_128')
channel_partner_ids = fields.Many2many(
'res.partner', string='Partners',
compute='_compute_channel_partner_ids', inverse='_inverse_channel_partner_ids',
compute_sudo=True, search='_search_channel_partner_ids',
groups='base.group_user')
channel_member_ids = fields.One2many(
'mail.channel.member', 'channel_id', string='Members',
groups='base.group_user')
rtc_session_ids = fields.One2many('mail.channel.rtc.session', 'channel_id', groups="base.group_system")
is_member = fields.Boolean('Is Member', compute='_compute_is_member', search='_search_is_member')
member_count = fields.Integer(string="Member Count", compute='_compute_member_count', compute_sudo=True)
group_ids = fields.Many2many(
'res.groups', string='Auto Subscription',
help="Members of those groups will automatically added as followers. "
"Note that they will be able to manage their subscription manually "
"if necessary.")
# access
uuid = fields.Char('UUID', size=50, default=_generate_random_token, copy=False)
group_public_id = fields.Many2one('res.groups', string='Authorized Group', compute='_compute_group_public_id', readonly=False, store=True)
invitation_url = fields.Char('Invitation URL', compute='_compute_invitation_url')
_sql_constraints = [
('channel_type_not_null', 'CHECK(channel_type IS NOT NULL)', 'The channel type cannot be empty'),
('uuid_unique', 'UNIQUE(uuid)', 'The channel UUID must be unique'),
('group_public_id_check',
"CHECK (channel_type = 'channel' OR group_public_id IS NULL)",
'Group authorization and group auto-subscription are only supported on channels.')
]
# CONSTRAINTS
@api.constrains('channel_member_ids', 'channel_partner_ids')
def _constraint_partners_chat(self):
for ch in self.sudo().filtered(lambda ch: ch.channel_type == 'chat'):
if len(ch.channel_member_ids) > 2 or len(ch.channel_partner_ids) > 2:
raise ValidationError(_("A channel of type 'chat' cannot have more than two users."))
@api.constrains('group_public_id', 'group_ids')
def _constraint_group_id_channel(self):
failing_channels = self.sudo().filtered(lambda channel: channel.channel_type != 'channel' and (channel.group_public_id or channel.group_ids))
if failing_channels:
raise ValidationError(_("For %(channels)s, channel_type should be 'channel' to have the group-based authorization or group auto-subscription.", channels=', '.join([ch.name for ch in failing_channels])))
# COMPUTE / INVERSE
@api.depends('channel_type')
def _compute_is_chat(self):
for record in self:
record.is_chat = record.channel_type == 'chat'
@api.depends('channel_type', 'image_128', 'uuid')
def _compute_avatar_128(self):
for record in self:
record.avatar_128 = record.image_128 or record._generate_avatar()
def _generate_avatar(self):
if self.channel_type not in ('channel', 'group'):
return False
avatar = group_avatar if self.channel_type == 'group' else channel_avatar
bgcolor = get_hsl_from_seed(self.uuid)
avatar = avatar.replace('fill="#875a7b"', f'fill="{bgcolor}"')
return base64.b64encode(avatar.encode())
@api.depends('channel_member_ids.partner_id')
def _compute_channel_partner_ids(self):
for channel in self:
channel.channel_partner_ids = channel.channel_member_ids.partner_id
def _inverse_channel_partner_ids(self):
new_members = []
outdated = self.env['mail.channel.member']
for channel in self:
current_members = channel.channel_member_ids
partners = channel.channel_partner_ids
partners_new = partners - current_members.partner_id
new_members += [{
'channel_id': channel.id,
'partner_id': partner.id,
} for partner in partners_new]
outdated += current_members.filtered(lambda m: m.partner_id not in partners)
if new_members:
self.env['mail.channel.member'].create(new_members)
if outdated:
outdated.sudo().unlink()
def _search_channel_partner_ids(self, operator, operand):
return [(
'channel_member_ids',
'in',
self.env['mail.channel.member'].sudo()._search([
('partner_id', operator, operand)
])
)]
@api.depends_context('uid', 'guest')
@api.depends('channel_member_ids')
def _compute_is_member(self):
if not self:
return
if self.env.user._is_public():
guest = self.env['mail.guest']._get_guest_from_context()
if not guest:
self.is_member = False
return
user_domain = [('guest_id', '=', guest.id)]
else:
user_domain = [('partner_id', '=', self.env.user.partner_id.id)]
members = self.env['mail.channel.member'].sudo().search(expression.AND([[('channel_id', 'in', self.ids)], user_domain]))
is_member_channels = {member.channel_id for member in members}
for channel in self:
channel.is_member = channel in is_member_channels
def _search_is_member(self, operator, operand):
is_in = (operator == '=' and operand) or (operator == '!=' and not operand)
if self.env.user._is_public():
guest = self.env['mail.guest']._get_guest_from_context()
if not guest:
return expression.FALSE_DOMAIN if is_in else expression.TRUE_DOMAIN
user_domain = [('guest_id', '=', guest.id)]
else:
user_domain = [('partner_id', '=', self.env.user.partner_id.id)]
return [(
'channel_member_ids',
'in' if is_in else 'not in',
self.env['mail.channel.member'].sudo()._search(user_domain)
)]
@api.depends('channel_member_ids')
def _compute_member_count(self):
read_group_res = self.env['mail.channel.member']._read_group(domain=[('channel_id', 'in', self.ids)], fields=['channel_id'], groupby=['channel_id'])
member_count_by_channel_id = {item['channel_id'][0]: item['channel_id_count'] for item in read_group_res}
for channel in self:
channel.member_count = member_count_by_channel_id.get(channel.id, 0)
@api.depends('channel_type')
def _compute_group_public_id(self):
channels = self.filtered(lambda channel: channel.channel_type == 'channel')
channels.filtered(lambda channel: not channel.group_public_id).group_public_id = self.env.ref('base.group_user')
(self - channels).group_public_id = None
@api.depends('uuid')
def _compute_invitation_url(self):
for channel in self:
channel.invitation_url = f"/chat/{channel.id}/{channel.uuid}"
# ------------------------------------------------------------
# CRUD
# ------------------------------------------------------------
@api.model_create_multi
def create(self, vals_list):
for vals in vals_list:
# find partners to add from partner_ids
partner_ids_cmd = vals.get('channel_partner_ids') or []
if any(cmd[0] not in (4, 6) for cmd in partner_ids_cmd):
raise ValidationError(_('Invalid value when creating a channel with members, only 4 or 6 are allowed.'))
partner_ids = [cmd[1] for cmd in partner_ids_cmd if cmd[0] == 4]
partner_ids += [cmd[2] for cmd in partner_ids_cmd if cmd[0] == 6]
# find partners to add from channel_member_ids
membership_ids_cmd = vals.get('channel_member_ids', [])
if any(cmd[0] != 0 for cmd in membership_ids_cmd):
raise ValidationError(_('Invalid value when creating a channel with memberships, only 0 is allowed.'))
membership_pids = [cmd[2]['partner_id'] for cmd in membership_ids_cmd if cmd[0] == 0]
# always add current user to new channel to have right values for
# is_pinned + ensure they have rights to see channel
partner_ids_to_add = list(set(partner_ids + [self.env.user.partner_id.id]))
vals['channel_member_ids'] = membership_ids_cmd + [
(0, 0, {'partner_id': pid})
for pid in partner_ids_to_add if pid not in membership_pids
]
# clean vals
vals.pop('channel_partner_ids', False)
# Create channel and alias
channels = super(Channel, self.with_context(mail_create_bypass_create_check=self.env['mail.channel.member']._bypass_create_check, mail_create_nolog=True, mail_create_nosubscribe=True)).create(vals_list)
channels._subscribe_users_automatically()
return channels
@api.ondelete(at_uninstall=False)
def _unlink_except_all_employee_channel(self):
# Delete mail.channel
try:
all_emp_group = self.env.ref('mail.channel_all_employees')
except ValueError:
all_emp_group = None
if all_emp_group and all_emp_group in self:
raise UserError(_('You cannot delete those groups, as the Whole Company group is required by other modules.'))
self.env['bus.bus']._sendmany([(channel, 'mail.channel/delete', {'id': channel.id}) for channel in self])
def write(self, vals):
if 'channel_type' in vals:
failing_channels = self.sudo().filtered(lambda channel: channel.channel_type != vals.get('channel_type'))
if failing_channels:
raise UserError(_('Cannot change the channel type of: %(channel_names)s'), channel_names=', '.join(failing_channels.mapped('name')))
result = super(Channel, self).write(vals)
if vals.get('group_ids'):
self._subscribe_users_automatically()
if 'image_128' in vals:
notifications = []
for channel in self:
notifications.append([channel, 'mail.channel/insert', {
'avatarCacheKey': channel._get_avatar_cache_key(),
'id': channel.id,
}])
self.env['bus.bus']._sendmany(notifications)
return result
def init(self):
self._cr.execute('SELECT indexname FROM pg_indexes WHERE indexname = %s', ('mail_channel_member_seen_message_id_idx',))
if not self._cr.fetchone():
self._cr.execute('CREATE INDEX mail_channel_member_seen_message_id_idx ON mail_channel_member (channel_id,partner_id,seen_message_id)')
# ------------------------------------------------------------
# MEMBERS MANAGEMENT
# ------------------------------------------------------------
def _subscribe_users_automatically(self):
new_members = self._subscribe_users_automatically_get_members()
if new_members:
to_create = [
{'channel_id': channel_id, 'partner_id': partner_id}
for channel_id in new_members
for partner_id in new_members[channel_id]
]
self.env['mail.channel.member'].sudo().create(to_create)
def _subscribe_users_automatically_get_members(self):
""" Return new members per channel ID """
return dict(
(channel.id, (channel.group_ids.users.partner_id - channel.channel_partner_ids).ids)
for channel in self
)
def action_unfollow(self):
self._action_unfollow(self.env.user.partner_id)
def _action_unfollow(self, partner):
self.message_unsubscribe(partner.ids)
if partner not in self.with_context(active_test=False).channel_partner_ids:
return True
channel_info = self.channel_info()[0] # must be computed before leaving the channel (access rights)
member = self.env['mail.channel.member'].search([('channel_id', '=', self.id), ('partner_id', '=', partner.id)])
member_id = member.id
member.unlink()
# side effect of unsubscribe that wasn't taken into account because
# channel_info is called before actually unpinning the channel
channel_info['is_pinned'] = False
self.env['bus.bus']._sendone(partner, 'mail.channel/leave', channel_info)
notification = _('
left the channel
')
# post 'channel left' message as root since the partner just unsubscribed from the channel
self.sudo().message_post(body=notification, subtype_xmlid="mail.mt_comment", author_id=partner.id)
self.env['bus.bus']._sendone(self, 'mail.channel/insert', {
'channelMembers': [('insert-and-unlink', {'id': member_id})],
'id': self.id,
'memberCount': self.member_count,
})
def add_members(self, partner_ids=None, guest_ids=None, invite_to_rtc_call=False, open_chat_window=False, post_joined_message=True):
""" Adds the given partner_ids and guest_ids as member of self channels. """
self.check_access_rights('write')
self.check_access_rule('write')
current_partner = self.env['res.partner']
current_guest = self.env['mail.guest']
guest = self.env['mail.guest']._get_guest_from_context()
if self.env.user._is_public() and guest:
current_guest = guest
else:
current_partner = self.env.user.partner_id
partners = self.env['res.partner'].browse(partner_ids or []).exists()
guests = self.env['mail.guest'].browse(guest_ids or []).exists()
notifications = []
for channel in self:
members_to_create = []
if channel.group_public_id:
invalid_partners = partners.filtered(lambda partner: channel.group_public_id not in partner.user_ids.groups_id)
if invalid_partners:
raise UserError(_(
'Channel "%(channel_name)s" only accepts members of group "%(group_name)s". Forbidden for: %(partner_names)s',
channel_name=channel.name,
group_name=channel.group_public_id.name,
partner_names=', '.join(partner.name for partner in invalid_partners)
))
if guests:
raise UserError(_(
'Channel "%(channel_name)s" only accepts members of group "%(group_name)s". Forbidden for: %(guest_names)s',
channel_name=channel.name,
group_name=channel.group_public_id.name,
guest_names=', '.join(guest.name for guest in guests)
))
existing_members = self.env['mail.channel.member'].search(expression.AND([
[('channel_id', '=', channel.id)],
expression.OR([
[('partner_id', 'in', partners.ids)],
[('guest_id', 'in', guests.ids)]
])
]))
members_to_create += [{
'partner_id': partner.id,
'channel_id': channel.id,
} for partner in partners - existing_members.partner_id]
members_to_create += [{
'guest_id': guest.id,
'channel_id': channel.id,
} for guest in guests - existing_members.guest_id]
new_members = self.env['mail.channel.member'].sudo().create(members_to_create)
for member in new_members.filtered(lambda member: member.partner_id):
# notify invited members through the bus
user = member.partner_id.user_ids[0] if member.partner_id.user_ids else self.env['res.users']
if user:
notifications.append((member.partner_id, 'mail.channel/joined', {
'channel': member.channel_id.with_user(user).with_context(allowed_company_ids=user.company_ids.ids).sudo().channel_info()[0],
'invited_by_user_id': self.env.user.id,
'open_chat_window': open_chat_window,
}))
if post_joined_message:
# notify existing members with a new message in the channel
if member.partner_id == self.env.user.partner_id:
notification = _('
joined the channel
')
else:
notification = _(
'
invited %s to the channel
',
member.partner_id._get_html_link(),
)
member.channel_id.message_post(body=notification, message_type="notification", subtype_xmlid="mail.mt_comment")
for member in new_members.filtered(lambda member: member.guest_id):
member.channel_id.message_post(body=_('
joined the channel
'), message_type="notification", subtype_xmlid="mail.mt_comment")
guest = member.guest_id
if guest:
notifications.append((guest, 'mail.channel/joined', {
'channel': member.channel_id.sudo().channel_info()[0],
}))
notifications.append((channel, 'mail.channel/insert', {
'channelMembers': [('insert', list(new_members._mail_channel_member_format().values()))],
'id': channel.id,
'memberCount': channel.member_count,
}))
if existing_members:
# If the current user invited these members but they are already present, notify the current user about their existence as well.
# In particular this fixes issues where the current user is not aware of its own member in the following case:
# create channel from form view, and then join from discuss without refreshing the page.
notifications.append((current_partner or current_guest, 'mail.channel/insert', {
'channelMembers': [('insert', list(existing_members._mail_channel_member_format().values()))],
'id': channel.id,
'memberCount': channel.member_count,
}))
if invite_to_rtc_call:
for channel in self:
current_channel_member = self.env['mail.channel.member'].sudo().search([('channel_id', '=', channel.id), ('partner_id', '=', current_partner.id), ('guest_id', '=', current_guest.id)])
if current_channel_member and current_channel_member.rtc_session_ids:
current_channel_member._rtc_invite_members(member_ids=new_members.ids)
self.env['bus.bus']._sendmany(notifications)
def _can_invite(self, partner_id):
"""Return True if the current user can invite the partner to the channel.
* channel -- public channel: ok;
* -- group restricted channel: both current user and target must in the group;
* chat/group: current user must be member;
:return boolean: whether inviting is ok"""
partner = self.env['res.partner'].browse(partner_id)
for channel in self.sudo():
if channel.channel_type != 'channel' and not channel.is_member:
return False
if channel.group_public_id:
if not partner.user_ids or channel.group_public_id not in partner.user_ids.groups_id:
return False
if channel.group_public_id not in self.env.user.groups_id:
return False
return True
# ------------------------------------------------------------
# RTC
# ------------------------------------------------------------
def _rtc_cancel_invitations(self, member_ids=None):
""" Cancels the invitations of the RTC call from all invited members,
if member_ids is provided, only the invitations of the specified members are canceled.
:param list member_ids: list of the members ids from which the invitation has to be removed
"""
self.ensure_one()
channel_member_domain = [
('channel_id', '=', self.id),
('rtc_inviting_session_id', '!=', False),
]
if member_ids:
channel_member_domain = expression.AND([channel_member_domain, [('id', 'in', member_ids)]])
invitation_notifications = []
members = self.env['mail.channel.member'].search(channel_member_domain)
for member in members:
member.rtc_inviting_session_id = False
if member.partner_id:
target = member.partner_id
else:
target = member.guest_id
invitation_notifications.append((target, 'mail.thread/insert', {
'id': self.id,
'model': 'mail.channel',
'rtcInvitingSession': [('unlink',)],
}))
self.env['bus.bus']._sendmany(invitation_notifications)
channel_data = {'id': self.id, 'model': 'mail.channel'}
if members:
channel_data['invitedMembers'] = [('insert-and-unlink', list(members._mail_channel_member_format(fields={'id': True, 'channel': {}, 'persona': {'partner': {'id', 'name', 'im_status'}, 'guest': {'id', 'name', 'im_status'}}}).values()))]
self.env['bus.bus']._sendone(self, 'mail.thread/insert', channel_data)
return channel_data
# ------------------------------------------------------------
# MAILING
# ------------------------------------------------------------
def _notify_get_recipients(self, message, msg_vals, **kwargs):
""" Override recipients computation as channel is not a standard
mail.thread document. Indeed there are no followers on a channel.
Instead of followers it has members that should be notified.
:param message: see ``MailThread._notify_get_recipients()``;
:param msg_vals: see ``MailThread._notify_get_recipients()``;
:param kwargs: see ``MailThread._notify_get_recipients()``;
:return recipients: structured data holding recipients data. See
``MailThread._notify_thread()`` for more details about its content
and use;
"""
# get values from msg_vals or from message if msg_vals doen't exists
msg_sudo = message.sudo()
message_type = msg_vals.get('message_type', 'email') if msg_vals else msg_sudo.message_type
pids = msg_vals.get('partner_ids', []) if msg_vals else msg_sudo.partner_ids.ids
# notify only user input (comment or incoming emails)
if message_type not in ('comment', 'email'):
return []
# notify only mailing lists or if mentioning recipients
if not pids:
return []
email_from = tools.email_normalize(msg_vals.get('email_from') or msg_sudo.email_from)
author_id = msg_vals.get('author_id') or msg_sudo.author_id.id
recipients_data = []
if pids:
self.env['res.partner'].flush_model(['active', 'email', 'partner_share'])
self.env['res.users'].flush_model(['notification_type', 'partner_id'])
sql_query = """
SELECT DISTINCT ON (partner.id) partner.id,
partner.partner_share,
users.notification_type
FROM res_partner partner
LEFT JOIN res_users users on partner.id = users.partner_id
WHERE partner.active IS TRUE
AND partner.email != %s
AND partner.id = ANY(%s) AND partner.id != ANY(%s)"""
self.env.cr.execute(
sql_query,
(email_from or '', list(pids), [author_id] if author_id else [], )
)
for partner_id, partner_share, notif in self._cr.fetchall():
# ocn_client: will add partners to recipient recipient_data. more ocn notifications. We neeed to filter them maybe
recipients_data.append({
'id': partner_id,
'share': partner_share,
'active': True,
'notif': notif or 'email',
'type': 'user' if not partner_share and notif else 'customer',
'groups': [],
})
return recipients_data
def _notify_get_recipients_groups(self, msg_vals=None):
""" All recipients of a message on a channel are considered as partners.
This means they will receive a minimal email, without a link to access
in the backend. Mailing lists should indeed send minimal emails to avoid
the noise. """
groups = super(Channel, self)._notify_get_recipients_groups(msg_vals=msg_vals)
for (index, (group_name, _group_func, group_data)) in enumerate(groups):
if group_name != 'customer':
groups[index] = (group_name, lambda partner: False, group_data)
return groups
def _notify_thread(self, message, msg_vals=False, **kwargs):
# link message to channel
rdata = super(Channel, self)._notify_thread(message, msg_vals=msg_vals, **kwargs)
message_format_values = message.message_format()[0]
bus_notifications = self._channel_message_notifications(message, message_format_values)
# Last interest and is_pinned are updated for a chat when posting a message.
# So a notification is needed to update UI, and it should come before the
# notification of the message itself to ensure the channel automatically opens.
if self.is_chat or self.channel_type == 'group':
for member in self.channel_member_ids.filtered('partner_id'):
bus_notifications.insert(0, [member.partner_id, 'mail.channel/last_interest_dt_changed', {
'id': self.id,
'isServerPinned': member.is_pinned,
'last_interest_dt': member.last_interest_dt,
}])
self.env['bus.bus'].sudo()._sendmany(bus_notifications)
return rdata
def _message_receive_bounce(self, email, partner):
""" Override bounce management to unsubscribe bouncing addresses """
for p in partner:
if p.message_bounce >= self.MAX_BOUNCE_LIMIT:
self._action_unfollow(p)
return super(Channel, self)._message_receive_bounce(email, partner)
def _message_compute_author(self, author_id=None, email_from=None, raise_on_email=True):
return super()._message_compute_author(author_id=author_id, email_from=email_from, raise_on_email=False)
def _message_compute_parent_id(self, parent_id):
# super() unravels the chain of parents to set parent_id as the first
# ancestor. We don't want that in channel.
if not parent_id:
return parent_id
return self.env['mail.message'].search(
[('id', '=', parent_id),
('model', '=', self._name),
('res_id', '=', self.id)
]).id
@api.returns('mail.message', lambda value: value.id)
def message_post(self, *, message_type='notification', **kwargs):
self.filtered(lambda channel: channel.is_chat or channel.channel_type == 'group').mapped('channel_member_ids').sudo().write({
'is_pinned': True,
'last_interest_dt': fields.Datetime.now(),
})
# mail_post_autofollow=False is necessary to prevent adding followers
# when using mentions in channels. Followers should not be added to
# channels, and especially not automatically (because channel membership
# should be managed with mail.channel.member instead).
# The current client code might be setting the key to True on sending
# message but it is only useful when targeting customers in chatter.
# This value should simply be set to False in channels no matter what.
return super(Channel, self.with_context(mail_create_nosubscribe=True, mail_post_autofollow=False)).message_post(message_type=message_type, **kwargs)
def _message_post_after_hook(self, message, msg_vals):
"""
Automatically set the message posted by the current user as seen for themselves.
"""
self._set_last_seen_message(message)
return super()._message_post_after_hook(message=message, msg_vals=msg_vals)
def _check_can_update_message_content(self, message):
""" We don't call super in this override as we want to ignore the
mail.thread behavior completely """
if not message.message_type == 'comment':
raise UserError(_("Only messages type comment can have their content updated on model 'mail.channel'"))
def _message_update_content_after_hook(self, message):
self.ensure_one()
self.env['bus.bus']._sendone(self, 'mail.message/insert', {
'id': message.id,
'body': message.body,
'attachments': message.attachment_ids._attachment_format(),
})
return super()._message_update_content_after_hook(message=message)
def _message_add_reaction_after_hook(self, message, content):
self.ensure_one()
guest = self.env['mail.guest']._get_guest_from_context()
if self.env.user._is_public() and guest:
guests = [('insert', {'id': guest.id})]
partners = []
else:
guests = []
partners = [('insert', {'id': self.env.user.partner_id.id})]
reactions = self.env['mail.message.reaction'].sudo().search([('message_id', '=', message.id), ('content', '=', content)])
self.env['bus.bus']._sendone(self, 'mail.message/insert', {
'id': message.id,
'messageReactionGroups': [('insert' if len(reactions) > 0 else 'insert-and-unlink', {
'content': content,
'count': len(reactions),
'guests': guests,
'message': {'id': message.id},
'partners': partners,
})],
})
return super()._message_add_reaction_after_hook(message=message, content=content)
def _message_remove_reaction_after_hook(self, message, content):
self.ensure_one()
guest = self.env['mail.guest']._get_guest_from_context()
if self.env.user._is_public() and guest:
guests = [('insert-and-unlink', {'id': guest.id})]
partners = []
else:
guests = []
partners = [('insert-and-unlink', {'id': self.env.user.partner_id.id})]
reactions = self.env['mail.message.reaction'].sudo().search([('message_id', '=', message.id), ('content', '=', content)])
self.env['bus.bus']._sendone(self, 'mail.message/insert', {
'id': message.id,
'messageReactionGroups': [('insert' if len(reactions) > 0 else 'insert-and-unlink', {
'content': content,
'count': len(reactions),
'guests': guests,
'message': {'id': message.id},
'partners': partners,
})],
})
return super()._message_remove_reaction_after_hook(message=message, content=content)
def _message_subscribe(self, partner_ids=None, subtype_ids=None, customer_ids=None):
""" Do not allow follower subscription on channels. Only members are
considered. """
raise UserError(_('Adding followers on channels is not possible. Consider adding members instead.'))
# ------------------------------------------------------------
# BROADCAST
# ------------------------------------------------------------
# Anonymous method
def _broadcast(self, partner_ids):
""" Broadcast the current channel header to the given partner ids
:param partner_ids : the partner to notify
"""
notifications = self._channel_channel_notifications(partner_ids)
self.env['bus.bus']._sendmany(notifications)
def _channel_channel_notifications(self, partner_ids):
""" Generate the bus notifications of current channel for the given partner ids
:param partner_ids : the partner to send the current channel header
:returns list of bus notifications (tuple (bus_channe, message_content))
"""
notifications = []
for partner in self.env['res.partner'].browse(partner_ids):
user_id = partner.user_ids and partner.user_ids[0] or False
if user_id:
user_channels = self.with_user(user_id).with_context(
allowed_company_ids=user_id.company_ids.ids
)
for channel_info in user_channels.channel_info():
notifications.append((partner, 'mail.channel/legacy_insert', channel_info))
return notifications
def _channel_message_notifications(self, message, message_format=False):
""" Generate the bus notifications for the given message
:param message : the mail.message to sent
:returns list of bus notifications (tuple (bus_channe, message_content))
"""
message_format = message_format or message.message_format()[0]
notifications = []
for channel in self:
payload = {
'id': channel.id,
'message': dict(message_format),
}
notifications.append((channel, 'mail.channel/new_message', payload))
return notifications
# ------------------------------------------------------------
# INSTANT MESSAGING API
# ------------------------------------------------------------
# A channel header should be broadcasted:
# - when adding user to channel (only to the new added partners)
# - when folding/minimizing a channel (only to the user making the action)
# A message should be broadcasted:
# - when a message is posted on a channel (to the channel, using _notify() method)
# ------------------------------------------------------------
def channel_info(self):
""" Get the informations header for the current channels
:returns a list of channels values
:rtype : list(dict)
"""
if not self:
return []
channel_infos = []
rtc_sessions_by_channel = self.sudo().rtc_session_ids._mail_rtc_session_format_by_channel()
channel_last_message_ids = dict((r['id'], r['message_id']) for r in self._channel_last_message_ids())
current_partner = self.env['res.partner']
current_guest = self.env['mail.guest']
guest = self.env['mail.guest']._get_guest_from_context()
if self.env.user._is_public and guest:
current_guest = guest
else:
current_partner = self.env.user.partner_id
all_needed_members_domain = expression.OR([
[('channel_id.channel_type', '!=', 'channel')],
[('rtc_inviting_session_id', '!=', False)],
[('partner_id', '=', current_partner.id) if current_partner else expression.FALSE_LEAF],
[('guest_id', '=', current_guest.id) if current_guest else expression.FALSE_LEAF],
])
all_needed_members = self.env['mail.channel.member'].search(expression.AND([[('channel_id', 'in', self.ids)], all_needed_members_domain]), order='id')
all_needed_members.partner_id.sudo().mail_partner_format() # prefetch in batch
members_by_channel = defaultdict(lambda: self.env['mail.channel.member'])
invited_members_by_channel = defaultdict(lambda: self.env['mail.channel.member'])
member_of_current_user_by_channel = defaultdict(lambda: self.env['mail.channel.member'])
for member in all_needed_members:
members_by_channel[member.channel_id] |= member
if member.rtc_inviting_session_id:
invited_members_by_channel[member.channel_id] |= member
if (current_partner and member.partner_id == current_partner) or (current_guest and member.guest_id == current_guest):
member_of_current_user_by_channel[member.channel_id] = member
for channel in self:
channel_data = {
'avatarCacheKey': channel._get_avatar_cache_key(),
'channel_type': channel.channel_type,
'id': channel.id,
'memberCount': channel.member_count,
}
info = {
'id': channel.id,
'name': channel.name,
'defaultDisplayMode': channel.default_display_mode,
'description': channel.description,
'uuid': channel.uuid,
'state': 'open',
'is_minimized': False,
'group_based_subscription': bool(channel.group_ids),
'create_uid': channel.create_uid.id,
'authorizedGroupFullName': channel.group_public_id.full_name,
}
# add last message preview (only used in mobile)
info['last_message_id'] = channel_last_message_ids.get(channel.id, False)
# find the channel member state
if current_partner or current_guest:
info['message_needaction_counter'] = channel.message_needaction_counter
member = member_of_current_user_by_channel.get(channel, self.env['mail.channel.member']).with_prefetch([m.id for m in member_of_current_user_by_channel.values()])
if member:
channel_data['channelMembers'] = [('insert', list(member._mail_channel_member_format().values()))]
info['state'] = member.fold_state or 'open'
channel_data['serverMessageUnreadCounter'] = member.message_unread_counter
info['is_minimized'] = member.is_minimized
info['seen_message_id'] = member.seen_message_id.id
channel_data['custom_channel_name'] = member.custom_channel_name
info['is_pinned'] = member.is_pinned
info['last_interest_dt'] = member.last_interest_dt.strftime(DEFAULT_SERVER_DATETIME_FORMAT)
if member.rtc_inviting_session_id:
info['rtc_inviting_session'] = {'id': member.rtc_inviting_session_id.id}
# add members info
if channel.channel_type != 'channel':
# avoid sending potentially a lot of members for big channels
# exclude chat and other small channels from this optimization because they are
# assumed to be smaller and it's important to know the member list for them
channel_data['channelMembers'] = [('insert', list(members_by_channel[channel]._mail_channel_member_format().values()))]
info['seen_partners_info'] = sorted([{
'id': cp.id,
'partner_id': cp.partner_id.id,
'fetched_message_id': cp.fetched_message_id.id,
'seen_message_id': cp.seen_message_id.id,
} for cp in members_by_channel[channel] if cp.partner_id], key=lambda p: p['partner_id'])
# add RTC sessions info
info.update({
'invitedMembers': [('insert', list(invited_members_by_channel[channel]._mail_channel_member_format(fields={'id': True, 'channel': {}, 'persona': {'partner': {'id', 'name', 'im_status'}, 'guest': {'id', 'name', 'im_status'}}}).values()))],
'rtcSessions': [('insert', rtc_sessions_by_channel.get(channel, []))],
})
info['channel'] = channel_data
channel_infos.append(info)
return channel_infos
def _channel_fetch_message(self, last_id=False, limit=20):
""" Return message values of the current channel.
:param last_id : last message id to start the research
:param limit : maximum number of messages to fetch
:returns list of messages values
:rtype : list(dict)
"""
self.ensure_one()
domain = ["&", ("model", "=", "mail.channel"), ("res_id", "in", self.ids)]
if last_id:
domain.append(("id", "<", last_id))
return self.env['mail.message']._message_fetch(domain=domain, limit=limit).message_format()
def _channel_format(self, fields=None):
if not fields:
fields = {'id': True}
channels_formatted_data = {}
for channel in self:
data = {}
if 'id' in fields:
data['id'] = channel.id
channels_formatted_data[channel] = data
return channels_formatted_data
# User methods
@api.model
def channel_get(self, partners_to, pin=True):
""" Get the canonical private channel between some partners, create it if needed.
To reuse an old channel (conversation), this one must be private, and contains
only the given partners.
:param partners_to : list of res.partner ids to add to the conversation
:param pin : True if getting the channel should pin it for the current user
:returns: channel_info of the created or existing channel
:rtype: dict
"""
if self.env.user.partner_id.id not in partners_to:
partners_to.append(self.env.user.partner_id.id)
if len(partners_to) > 2:
raise UserError(_("A chat should not be created with more than 2 persons. Create a group instead."))
# determine type according to the number of partner in the channel
self.flush_model()
self.env['mail.channel.member'].flush_model()
self.env.cr.execute("""
SELECT M.channel_id
FROM mail_channel C, mail_channel_member M
WHERE M.channel_id = C.id
AND M.partner_id IN %s
AND C.channel_type LIKE 'chat'
AND NOT EXISTS (
SELECT 1
FROM mail_channel_member M2
WHERE M2.channel_id = C.id
AND M2.partner_id NOT IN %s
)
GROUP BY M.channel_id
HAVING ARRAY_AGG(DISTINCT M.partner_id ORDER BY M.partner_id) = %s
LIMIT 1
""", (tuple(partners_to), tuple(partners_to), sorted(list(partners_to)),))
result = self.env.cr.dictfetchall()
if result:
# get the existing channel between the given partners
channel = self.browse(result[0].get('channel_id'))
# pin up the channel for the current partner
if pin:
self.env['mail.channel.member'].search([('partner_id', '=', self.env.user.partner_id.id), ('channel_id', '=', channel.id)]).write({
'is_pinned': True,
'last_interest_dt': fields.Datetime.now(),
})
channel._broadcast(self.env.user.partner_id.ids)
else:
# create a new one
channel = self.create({
'channel_partner_ids': [Command.link(partner_id) for partner_id in partners_to],
'channel_member_ids': [
Command.create({
'partner_id': partner_id,
# only pin for the current user, so the chat does not show up for the correspondent until a message has been sent
'is_pinned': partner_id == self.env.user.partner_id.id
}) for partner_id in partners_to
],
'channel_type': 'chat',
'name': ', '.join(self.env['res.partner'].sudo().browse(partners_to).mapped('name')),
})
channel._broadcast(partners_to)
return channel.channel_info()[0]
def channel_fold(self, state=None):
""" Update the fold_state of the given session. In order to syncronize web browser
tabs, the change will be broadcast to themselves (the current user channel).
Note: the user need to be logged
:param state : the new status of the session for the current user.
"""
domain = [('partner_id', '=', self.env.user.partner_id.id), ('channel_id', 'in', self.ids)]
for session_state in self.env['mail.channel.member'].search(domain):
if not state:
state = session_state.fold_state
if session_state.fold_state == 'open':
state = 'folded'
else:
state = 'open'
is_minimized = bool(state != 'closed')
vals = {}
if session_state.fold_state != state:
vals['fold_state'] = state
if session_state.is_minimized != is_minimized:
vals['is_minimized'] = is_minimized
if vals:
session_state.write(vals)
self.env['bus.bus']._sendone(self.env.user.partner_id, 'mail.thread/insert', {
'id': session_state.channel_id.id,
'model': 'mail.channel',
'serverFoldState': state,
})
def channel_pin(self, pinned=False):
self.ensure_one()
member = self.env['mail.channel.member'].search(
[('partner_id', '=', self.env.user.partner_id.id), ('channel_id', '=', self.id), ('is_pinned', '!=', pinned)])
if member:
member.write({'is_pinned': pinned})
if not pinned:
self.env['bus.bus']._sendone(self.env.user.partner_id, 'mail.channel/unpin', {'id': self.id})
else:
self.env['bus.bus']._sendone(self.env.user.partner_id, 'mail.channel/legacy_insert', self.channel_info()[0])
def _channel_seen(self, last_message_id=None):
"""
Mark channel as seen by updating seen message id of the current logged partner
:param last_message_id: the id of the message to be marked as seen, last message of the
thread by default. This param SHOULD be required, the default behaviour is DEPRECATED and
kept only for compatibility reasons.
"""
self.ensure_one()
domain = ["&", ("model", "=", "mail.channel"), ("res_id", "in", self.ids)]
if last_message_id:
domain = expression.AND([domain, [('id', '<=', last_message_id)]])
last_message = self.env['mail.message'].search(domain, order="id DESC", limit=1)
if not last_message:
return
self._set_last_seen_message(last_message)
data = {
'channel_id': self.id,
'last_message_id': last_message.id,
'partner_id': self.env.user.partner_id.id,
}
target = self if self.channel_type == 'chat' else self.env.user.partner_id
self.env['bus.bus']._sendone(target, 'mail.channel.member/seen', data)
return last_message.id
def _set_last_seen_message(self, last_message):
"""
Set last seen message of `self` channels for the current user.
:param last_message: the message to set as last seen message
"""
channel_member_domain = expression.AND([
[('channel_id', 'in', self.ids)],
[('partner_id', '=', self.env.user.partner_id.id)],
expression.OR([
[('seen_message_id', '=', False)],
[('seen_message_id', '<', last_message.id)]
])
])
member = self.env['mail.channel.member'].search(channel_member_domain)
member.write({
'fetched_message_id': last_message.id,
'seen_message_id': last_message.id,
'last_seen_dt': fields.Datetime.now(),
})
def channel_fetched(self):
""" Broadcast the channel_fetched notification to channel members
"""
for channel in self:
if not channel.message_ids.ids:
return
if channel.channel_type != 'chat':
return
last_message_id = channel.message_ids.ids[0] # zero is the index of the last message
member = self.env['mail.channel.member'].search([('channel_id', '=', channel.id), ('partner_id', '=', self.env.user.partner_id.id)], limit=1)
if member.fetched_message_id.id == last_message_id:
# last message fetched by user is already up-to-date
return
# Avoid serialization error when multiple tabs are opened.
query = """
UPDATE mail_channel_member
SET fetched_message_id = %s
WHERE id IN (
SELECT id FROM mail_channel_member WHERE id = %s
FOR NO KEY UPDATE SKIP LOCKED
)
"""
self.env.cr.execute(query, (last_message_id, member.id))
self.env['bus.bus']._sendone(channel, 'mail.channel.member/fetched', {
'channel_id': channel.id,
'id': member.id,
'last_message_id': last_message_id,
'partner_id': self.env.user.partner_id.id,
})
def channel_set_custom_name(self, name):
self.ensure_one()
member = self.env['mail.channel.member'].search([('partner_id', '=', self.env.user.partner_id.id), ('channel_id', '=', self.id)])
member.write({'custom_channel_name': name})
self.env['bus.bus']._sendone(member.partner_id, 'mail.channel/insert', {
'custom_channel_name': name,
'id': self.id,
})
def channel_rename(self, name):
self.ensure_one()
self.write({'name': name})
self.env['bus.bus']._sendone(self, 'mail.thread/insert', {
'id': self.id,
'model': 'mail.channel',
'name': name,
})
def channel_change_description(self, description):
self.ensure_one()
self.write({'description': description})
self.env['bus.bus']._sendone(self, 'mail.thread/insert', {
'id': self.id,
'description': description,
'model': 'mail.channel',
})
def channel_join(self):
""" Shortcut to add the current user as member of self channels.
Prefer calling add_members() directly when possible.
"""
self.add_members(self.env.user.partner_id.ids)
@api.model
def channel_create(self, name, group_id):
""" Create a channel and add the current partner, broadcast it (to make the user directly
listen to it when polling)
:param name : the name of the channel to create
:param group_id : the group allowed to join the channel.
:return dict : channel header
"""
# create the channel
vals = {
'channel_type': 'channel',
'name': name,
}
new_channel = self.create(vals)
group = self.env['res.groups'].search([('id', '=', group_id)]) if group_id else None
new_channel.group_public_id = group.id if group else None
notification = _('
', new_channel.id, new_channel.name)
new_channel.message_post(body=notification, message_type="notification", subtype_xmlid="mail.mt_comment")
channel_info = new_channel.channel_info()[0]
self.env['bus.bus']._sendone(self.env.user.partner_id, 'mail.channel/legacy_insert', channel_info)
return channel_info
@api.model
def create_group(self, partners_to, default_display_mode=False, name=''):
""" Creates a group channel.
:param partners_to : list of res.partner ids to add to the conversation
:param str default_display_mode: how the channel will be displayed by default
:param str name: group name. default name is computed client side from the list of members if no name is set
:returns: channel_info of the created channel
:rtype: dict
"""
channel = self.create({
'channel_member_ids': [Command.create({'partner_id': partner_id}) for partner_id in partners_to],
'channel_type': 'group',
'default_display_mode': default_display_mode,
'name': name,
})
channel._broadcast(partners_to)
return channel.channel_info()[0]
@api.model
def get_mention_suggestions(self, search, limit=8):
""" Return 'limit'-first channels' id, name, channel_type and authorizedGroupFullName fields such that the
name matches a 'search' string. Exclude channels of type chat (DM) and group.
"""
domain = expression.AND([
[('name', 'ilike', search)],
[('channel_type', '=', 'channel')],
[('channel_partner_ids', 'in', [self.env.user.partner_id.id])]
])
channels = self.search(domain, limit=limit)
return [{
'authorizedGroupFullName': channel.group_public_id.full_name,
'channel': {
'channel_type': channel.channel_type,
'id': channel.id,
},
'id': channel.id,
'name': channel.name,
} for channel in channels]
def channel_fetch_preview(self):
""" Return the last message of the given channels """
if not self:
return []
channels_last_message_ids = self._channel_last_message_ids()
channels_preview = dict((r['message_id'], r) for r in channels_last_message_ids)
last_messages = self.env['mail.message'].browse(channels_preview).message_format()
for message in last_messages:
channel = channels_preview[message['id']]
del(channel['message_id'])
channel['last_message'] = message
return list(channels_preview.values())
def _channel_last_message_ids(self):
""" Return the last message of the given channels."""
if not self:
return []
self.env['mail.message'].flush_model()
self.env.cr.execute("""
SELECT res_id AS id, MAX(id) AS message_id
FROM mail_message
WHERE model = 'mail.channel' AND res_id IN %s
GROUP BY res_id
""", (tuple(self.ids),))
return self.env.cr.dictfetchall()
def load_more_members(self, known_member_ids):
self.ensure_one()
unknown_members = self.env['mail.channel.member'].search(
domain=[('id', 'not in', known_member_ids), ('channel_id', '=', self.id)],
limit=100
)
count = self.env['mail.channel.member'].search_count(
domain=[('channel_id', '=', self.id)],
)
return {
'channelMembers': [('insert', list(unknown_members._mail_channel_member_format().values()))],
'memberCount': count,
}
def _get_avatar_cache_key(self):
if not self.avatar_128:
return 'no-avatar'
return sha512(self.avatar_128).hexdigest()
# ------------------------------------------------------------
# COMMANDS
# ------------------------------------------------------------
def _send_transient_message(self, partner_to, content):
""" Notifies partner_to that a message (not stored in DB) has been
written in this channel.
`content` is HTML, dynamic parts should be escaped by the caller.
"""
self.env['bus.bus']._sendone(partner_to, 'mail.channel/transient_message', {
'body': "" + content + "",
'model': self._name,
'res_id': self.id,
})
def execute_command_help(self, **kwargs):
partner = self.env.user.partner_id
if self.channel_type == 'channel':
msg = _("You are in channel #%s.", html_escape(self.name))
else:
all_channel_members = self.env['mail.channel.member'].with_context(active_test=False)
channel_members = all_channel_members.search([('partner_id', '!=', partner.id), ('channel_id', '=', self.id)])
msg = _("You are in a private conversation with @%s.", _(" @").join(html_escape(member.partner_id.name or member.guest_id.name) for member in channel_members) if channel_members else _("Anonymous"))
msg += self._execute_command_help_message_extra()
self._send_transient_message(partner, msg)
def _execute_command_help_message_extra(self):
msg = _("""
Type @username to mention someone, and grab their attention.
Type #channel to mention a channel.
Type /command to execute a command. """)
return msg
def execute_command_leave(self, **kwargs):
if self.channel_type in ('channel', 'group'):
self.action_unfollow()
else:
self.channel_pin(False)
def execute_command_who(self, **kwargs):
channel_members = self.env['mail.channel.member'].with_context(active_test=False).search([('partner_id', '!=', self.env.user.partner_id.id), ('channel_id', '=', self.id)])
members = [
m.partner_id._get_html_link(title=f"@{m.partner_id.name}") if m.partner_id else f'@{html_escape(m.guest_id.name)}'
for m in channel_members[:30]
]
if len(members) == 0:
msg = _("You are alone in this channel.")
else:
dots = "..." if len(members) != len(channel_members) else ""
msg = _("Users in this channel: %(members)s %(dots)s and you.", members=", ".join(members), dots=dots)
self._send_transient_message(self.env.user.partner_id, msg)