Odoo18-Base/addons/mail/models/res_users.py
2025-01-06 10:57:38 +07:00

381 lines
17 KiB
Python

# Part of Odoo. See LICENSE file for full copyright and licensing details.
from collections import defaultdict
from odoo import _, api, Command, fields, models, modules, tools
from odoo.tools import email_normalize
from odoo.addons.mail.tools.discuss import Store
class Users(models.Model):
""" Update of res.users class
- add a preference about sending emails about notifications
- make a new user follow itself
- add a welcome message
- add suggestion preference
"""
_name = 'res.users'
_inherit = ['res.users']
notification_type = fields.Selection([
('email', 'Handle by Emails'),
('inbox', 'Handle in Odoo')],
'Notification', required=True, default='email',
compute='_compute_notification_type', inverse='_inverse_notification_type', store=True,
help="Policy on how to handle Chatter notifications:\n"
"- Handle by Emails: notifications are sent to your email address\n"
"- Handle in Odoo: notifications appear in your Odoo Inbox")
_sql_constraints = [(
"notification_type",
"CHECK (notification_type = 'email' OR NOT share)",
"Only internal user can receive notifications in Odoo",
)]
@api.depends('share', 'groups_id')
def _compute_notification_type(self):
# Because of the `groups_id` in the `api.depends`,
# this code will be called for any change of group on a user,
# even unrelated to the group_mail_notification_type_inbox or share flag.
# e.g. if you add HR > Manager to a user, this method will be called.
# It should therefore be written to be as performant as possible, and make the less change/write as possible
# when it's not `mail.group_mail_notification_type_inbox` or `share` that are being changed.
inbox_group_id = self.env['ir.model.data']._xmlid_to_res_id('mail.group_mail_notification_type_inbox')
self.filtered_domain([
('groups_id', 'in', inbox_group_id), ('notification_type', '!=', 'inbox')
]).notification_type = 'inbox'
self.filtered_domain([
('groups_id', 'not in', inbox_group_id), ('notification_type', '=', 'inbox')
]).notification_type = 'email'
# Special case: internal users with inbox notifications converted to portal must be converted to email users
self.filtered_domain([('share', '=', True), ('notification_type', '=', 'inbox')]).notification_type = 'email'
def _inverse_notification_type(self):
inbox_group = self.env.ref('mail.group_mail_notification_type_inbox')
inbox_users = self.filtered(lambda user: user.notification_type == 'inbox')
inbox_users.write({"groups_id": [Command.link(inbox_group.id)]})
(self - inbox_users).write({"groups_id": [Command.unlink(inbox_group.id)]})
# ------------------------------------------------------------
# CRUD
# ------------------------------------------------------------
@property
def SELF_READABLE_FIELDS(self):
return super().SELF_READABLE_FIELDS + ['notification_type']
@property
def SELF_WRITEABLE_FIELDS(self):
return super().SELF_WRITEABLE_FIELDS + ['notification_type']
@api.model_create_multi
def create(self, vals_list):
users = super(Users, self).create(vals_list)
# log a portal status change (manual tracking)
log_portal_access = not self._context.get('mail_create_nolog') and not self._context.get('mail_notrack')
if log_portal_access:
for user in users:
if user._is_portal():
body = user._get_portal_access_update_body(True)
user.partner_id.message_post(
body=body,
message_type='notification',
subtype_xmlid='mail.mt_note'
)
return users
def write(self, vals):
log_portal_access = 'groups_id' in vals and not self._context.get('mail_create_nolog') and not self._context.get('mail_notrack')
user_portal_access_dict = {
user.id: user._is_portal()
for user in self
} if log_portal_access else {}
previous_email_by_user = {}
if vals.get('email'):
previous_email_by_user = {
user: user.email
for user in self.filtered(lambda user: bool(email_normalize(user.email)))
if email_normalize(user.email) != email_normalize(vals['email'])
}
if 'notification_type' in vals:
user_notification_type_modified = self.filtered(lambda user: user.notification_type != vals['notification_type'])
write_res = super(Users, self).write(vals)
# log a portal status change (manual tracking)
if log_portal_access:
for user in self:
user_has_group = user._is_portal()
portal_access_changed = user_has_group != user_portal_access_dict[user.id]
if portal_access_changed:
body = user._get_portal_access_update_body(user_has_group)
user.partner_id.message_post(
body=body,
message_type='notification',
subtype_xmlid='mail.mt_note'
)
if 'login' in vals:
self._notify_security_setting_update(
_("Security Update: Login Changed"),
_("Your account login has been updated"),
)
if 'password' in vals:
self._notify_security_setting_update(
_("Security Update: Password Changed"),
_("Your account password has been updated"),
)
if 'email' in vals:
# when the email is modified, we want notify the previous address (and not the new one)
for user, previous_email in previous_email_by_user.items():
self._notify_security_setting_update(
_("Security Update: Email Changed"),
_(
"Your account email has been changed from %(old_email)s to %(new_email)s.",
old_email=previous_email,
new_email=user.email,
),
mail_values={'email_to': previous_email},
suggest_password_reset=False,
)
if 'notification_type' in vals:
for user in user_notification_type_modified:
user._bus_send_store(
user.partner_id,
fields=["notification_type"],
main_user_by_partner={user.partner_id: user},
)
return write_res
def action_archive(self):
activities_to_delete = self.env['mail.activity'].search([('user_id', 'in', self.ids)])
activities_to_delete.unlink()
return super(Users, self).action_archive()
def _notify_security_setting_update(self, subject, content, mail_values=None, **kwargs):
""" This method is meant to be called whenever a sensitive update is done on the user's account.
It will send an email to the concerned user warning him about this change and making some security suggestions.
:param str subject: The subject of the sent email (e.g: 'Security Update: Password Changed')
:param str content: The text to embed within the email template (e.g: 'Your password has been changed')
:param kwargs: 'suggest_password_reset' key:
Whether or not to suggest the end-user to reset
his password in the email sent.
Defaults to True. """
mail_create_values = []
for user in self:
body_html = self.env['ir.qweb']._render(
'mail.account_security_setting_update',
user._notify_security_setting_update_prepare_values(content, **kwargs),
minimal_qcontext=True,
)
body_html = self.env['mail.render.mixin']._render_encapsulate(
'mail.mail_notification_light',
body_html,
add_context={
# the 'mail_notification_light' expects a mail.message 'message' context, let's give it one
'message': self.env['mail.message'].sudo().new(dict(body=body_html, record_name=user.name)),
'model_description': _('Account'),
'company': user.company_id,
},
)
vals = {
'auto_delete': True,
'body_html': body_html,
'author_id': self.env.user.partner_id.id,
'email_from': (
user.company_id.partner_id.email_formatted or
self.env.user.email_formatted or
self.env.ref('base.user_root').email_formatted
),
'email_to': kwargs.get('force_email') or user.email_formatted,
'subject': subject,
}
if mail_values:
vals.update(mail_values)
mail_create_values.append(vals)
self.env['mail.mail'].sudo().create(mail_create_values)
def _notify_security_setting_update_prepare_values(self, content, **kwargs):
"""" Prepare rendering values for the 'mail.account_security_setting_update' qweb template """
reset_password_enabled = self.env['ir.config_parameter'].sudo().get_param("auth_signup.reset_password", True)
return {
'company': self.company_id,
'password_reset_url': f"{self.get_base_url()}/web/reset_password",
'security_update_text': content,
'suggest_password_reset': kwargs.get('suggest_password_reset', True) and reset_password_enabled,
'user': self,
'update_datetime': fields.Datetime.now(),
}
def _get_portal_access_update_body(self, access_granted):
body = _('Portal Access Granted') if access_granted else _('Portal Access Revoked')
if self.partner_id.email:
return '%s (%s)' % (body, self.partner_id.email)
return body
def _deactivate_portal_user(self, **post):
"""Blacklist the email of the user after deleting it.
Log a note on the related partner so we know why it's archived.
"""
current_user = self.env.user
for user in self:
user.partner_id._message_log(
body=_('Archived because %(user_name)s (#%(user_id)s) deleted the portal account',
user_name=current_user.name, user_id=current_user.id)
)
if post.get('request_blacklist'):
users_to_blacklist = [(user, user.email) for user in self.filtered(
lambda user: tools.email_normalize(user.email))]
else:
users_to_blacklist = []
super(Users, self)._deactivate_portal_user(**post)
for user, user_email in users_to_blacklist:
self.env['mail.blacklist']._add(
user_email,
message=_('Blocked by deletion of portal account %(portal_user_name)s by %(user_name)s (#%(user_id)s)',
user_name=current_user.name, user_id=current_user.id,
portal_user_name=user.name)
)
# ------------------------------------------------------------
# DISCUSS
# ------------------------------------------------------------
@api.model
def _init_store_data(self, store: Store, /):
"""Initialize the store of the user."""
xmlid_to_res_id = self.env["ir.model.data"]._xmlid_to_res_id
store.add(
{
"action_discuss_id": xmlid_to_res_id("mail.action_discuss"),
"hasLinkPreviewFeature": self.env["mail.link.preview"]._is_link_preview_enabled(),
"internalUserGroupId": self.env.ref("base.group_user").id,
"mt_comment_id": xmlid_to_res_id("mail.mt_comment"),
# sudo: res.partner - exposing OdooBot data is considered acceptable
"odoobot": Store.one(self.env.ref("base.partner_root").sudo()),
}
)
if not self.env.user._is_public():
settings = self.env["res.users.settings"]._find_or_create_for_user(self.env.user)
store.add(
{
"self": Store.one(
self.env.user.partner_id,
fields=[
"active",
"isAdmin",
"name",
"notification_type",
"signature",
"user",
"write_date",
],
main_user_by_partner={self.env.user.partner_id: self.env.user},
),
"settings": settings._res_users_settings_format(),
}
)
elif guest := self.env["mail.guest"]._get_guest_from_context():
store.add({"self": Store.one(guest, fields=["name", "write_date"])})
def _init_messaging(self, store):
self.ensure_one()
self = self.with_user(self)
# sudo: bus.bus: reading non-sensitive last id
bus_last_id = self.env["bus.bus"].sudo()._bus_last_id()
store.add(
{
"inbox": {
"counter": self.partner_id._get_needaction_count(),
"counter_bus_id": bus_last_id,
"id": "inbox",
"model": "mail.box",
},
"starred": {
"counter": self.env["mail.message"].search_count(
[("starred_partner_ids", "in", self.partner_id.ids)]
),
"counter_bus_id": bus_last_id,
"id": "starred",
"model": "mail.box",
},
}
)
@api.model
def _get_activity_groups(self):
search_limit = int(self.env['ir.config_parameter'].sudo().get_param('mail.activity.systray.limit', 1000))
activities = self.env["mail.activity"].search(
[("user_id", "=", self.env.uid)], order='id desc', limit=search_limit)
activities_by_record_by_model_name = defaultdict(lambda: defaultdict(lambda: self.env["mail.activity"]))
for activity in activities:
record = self.env[activity.res_model].browse(activity.res_id)
activities_by_record_by_model_name[activity.res_model][record] += activity
activities_by_model_name = defaultdict(lambda: self.env["mail.activity"])
user_company_ids = self.env.user.company_ids.ids
is_all_user_companies_allowed = set(user_company_ids) == set(self.env.context.get('allowed_company_ids') or [])
for model_name, activities_by_record in activities_by_record_by_model_name.items():
res_ids = [r.id for r in activities_by_record]
Model = self.env[model_name].with_context(**self.env.context)
has_model_access_right = self.env[model_name].has_access('read')
if has_model_access_right:
allowed_records = Model.browse(res_ids)._filtered_access('read')
else:
allowed_records = self.env[model_name]
unallowed_records = Model.browse(res_ids) - allowed_records
# We remove from not allowed records, records that the user has access to through others of his companies
if has_model_access_right and unallowed_records and not is_all_user_companies_allowed:
unallowed_records -= unallowed_records.with_context(
allowed_company_ids=user_company_ids)._filtered_access('read')
for record, activities in activities_by_record.items():
if record in unallowed_records:
activities_by_model_name['mail.activity'] += activities
elif record in allowed_records:
activities_by_model_name[model_name] += activities
model_ids = [self.env["ir.model"]._get_id(name) for name in activities_by_model_name]
user_activities = {}
for model_name, activities in activities_by_model_name.items():
Model = self.env[model_name]
module = Model._original_module
icon = module and modules.module.get_module_icon(module)
model = self.env["ir.model"]._get(model_name).with_prefetch(model_ids)
user_activities[model_name] = {
"id": model.id,
"name": model.name,
"model": model_name,
"type": "activity",
"icon": icon,
"total_count": 0,
"today_count": 0,
"overdue_count": 0,
"planned_count": 0,
"view_type": getattr(Model, '_systray_view', 'list'),
}
if model_name == 'mail.activity':
user_activities[model_name]['activity_ids'] = activities.ids
for activity in activities:
user_activities[model_name]["%s_count" % activity.state] += 1
if activity.state in ("today", "overdue"):
user_activities[model_name]["total_count"] += 1
if "mail.activity" in user_activities:
user_activities["mail.activity"]["name"] = _("Other activities")
return list(user_activities.values())