Files
odoo_source/addons/data_recycle/models/data_recycle_model.py
T
Thibault Delavallée 17e6cd1e14 [IMP] mail: add a notification parameter to allow notifying the author
Currently notification process called notably by message_{post,notify} does
not notify message's author by default. Rationale is that as he typed the
message he is already aware of it.

However in some cases we want to skip this step, notably when messages are
generated in the name of the author and when we want him to be notified if
he should.

This is currently controllable through a context key 'mail_notify_author'.
In this commit we add an explicit parameter propagated through the notify
process, allowing to remove some context key usage and instead use real
parameters.

Note that all context keys usage cannot be removed as it is not always
possible to propagate this parameter.

Followup of odoo#99482

Task-2710804 (Mail: Clean MailThread API)

Part-of: odoo/odoo#107356
2023-01-27 19:56:03 +01:00

211 lines
9.2 KiB
Python

# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import ast
from collections import defaultdict
from dateutil.relativedelta import relativedelta
from odoo import api, fields, models, _
from odoo.exceptions import UserError
from odoo.tools import config, split_every
from odoo.osv import expression
# When recycle_mode = automatic, _recycle_records calls action_validate.
# This is quite slow so requires smaller batch size.
DR_CREATE_STEP_AUTO = 5000
DR_CREATE_STEP_MANUAL = 50000
class DataRecycleModel(models.Model):
_name = 'data_recycle.model'
_description = 'Recycling Model'
_order = 'name'
active = fields.Boolean(default=True)
name = fields.Char(
compute='_compute_name', string='Name', readonly=False, store=True, required=True, copy=True)
res_model_id = fields.Many2one('ir.model', string='Model', required=True, ondelete='cascade')
res_model_name = fields.Char(
related='res_model_id.model', string='Model Name', readonly=True, store=True)
recycle_record_ids = fields.One2many('data_recycle.record', 'recycle_model_id')
recycle_mode = fields.Selection([
('manual', 'Manual'),
('automatic', 'Automatic'),
], string='Recycle Mode', default='manual', required=True)
recycle_action = fields.Selection([
('archive', 'Archive'),
('unlink', 'Delete'),
], string="Recycle Action", default='unlink', required=True)
# Rule
domain = fields.Char(string="Filter", compute='_compute_domain', readonly=False, store=True)
time_field_id = fields.Many2one(
'ir.model.fields', string='Time Field',
domain="[('model_id', '=', res_model_id), ('ttype', 'in', ('date', 'datetime')), ('store', '=', True)]",
ondelete='cascade')
time_field_delta = fields.Integer(string='Delta', default=1)
time_field_delta_unit = fields.Selection([
('days', 'Days'),
('weeks', 'Weeks'),
('months', 'Months'),
('years', 'Years')], string='Delta Unit', default='months')
include_archived = fields.Boolean()
records_to_recycle_count = fields.Integer(
'Records To Recycle', compute='_compute_records_to_recycle_count')
# User Notifications for Manual clean
notify_user_ids = fields.Many2many(
'res.users', string='Notify Users',
domain=lambda self: [('groups_id', 'in', self.env.ref('base.group_system').id)],
default=lambda self: self.env.user,
help='List of users to notify when there are new records to recycle')
notify_frequency = fields.Integer(string='Notify', default=1)
notify_frequency_period = fields.Selection([
('days', 'Days'),
('weeks', 'Weeks'),
('months', 'Months')], string='Notify Frequency Period', default='weeks')
last_notification = fields.Datetime(readonly=True)
_sql_constraints = [
('check_notif_freq', 'CHECK(notify_frequency > 0)', 'The notification frequency should be greater than 0'),
]
@api.constrains('recycle_action')
def _check_recycle_action(self):
for model in self:
if model.recycle_action == 'archive' and 'active' not in self.env[model.res_model_name]:
raise UserError(_("This model doesn't manage archived records. Only deletion is possible."))
@api.depends('res_model_id')
def _compute_domain(self):
self.domain = '[]'
@api.depends('res_model_id')
def _compute_name(self):
for model in self:
if model.name:
continue
model.name = model.res_model_id.name if model.res_model_id else ''
def _compute_records_to_recycle_count(self):
count_data = self.env['data_recycle.record']._read_group(
[('recycle_model_id', 'in', self.ids)],
['recycle_model_id'],
['recycle_model_id'])
counts = {cd['recycle_model_id'][0]: cd['recycle_model_id_count'] for cd in count_data}
for model in self:
model.records_to_recycle_count = counts[model.id] if model.id in counts else 0
def _cron_recycle_records(self):
self.sudo().search([])._recycle_records(batch_commits=True)
self.sudo()._notify_records_to_recycle()
def _recycle_records(self, batch_commits=False):
self.env.flush_all()
records_to_clean = []
is_test = bool(config['test_enable'] or config['test_file'])
existing_recycle_records = self.env['data_recycle.record'].with_context(
active_test=False).search([('recycle_model_id', 'in', self.ids)])
mapped_existing_records = defaultdict(list)
for recycle_record in existing_recycle_records:
mapped_existing_records[recycle_record.recycle_model_id].append(recycle_record.res_id)
for recycle_model in self:
rule_domain = ast.literal_eval(recycle_model.domain) if recycle_model.domain and recycle_model.domain != '[]' else []
if recycle_model.time_field_id and recycle_model.time_field_delta and recycle_model.time_field_delta_unit:
if recycle_model.time_field_id.ttype == 'date':
now = fields.Date.today()
else:
now = fields.Datetime.now()
delta = relativedelta(**{recycle_model.time_field_delta_unit: recycle_model.time_field_delta})
rule_domain = expression.AND([rule_domain, [(recycle_model.time_field_id.name, '<=', now - delta)]])
model = self.env[recycle_model.res_model_name]
if recycle_model.include_archived:
model = model.with_context(active_test=False)
records_to_recycle = model.search(rule_domain)
records_to_create = [{
'res_id': record.id,
'recycle_model_id': recycle_model.id,
} for record in records_to_recycle if record.id not in mapped_existing_records[recycle_model]]
if recycle_model.recycle_mode == 'automatic':
for records_to_create_batch in split_every(DR_CREATE_STEP_AUTO, records_to_create):
self.env['data_recycle.record'].create(records_to_create_batch).action_validate()
if batch_commits and not is_test:
# Commit after each batch iteration to avoid complete rollback on timeout as
# this can create lots of new records.
self.env.cr.commit()
else:
records_to_clean = records_to_clean + records_to_create
for records_to_clean_batch in split_every(DR_CREATE_STEP_MANUAL, records_to_clean):
self.env['data_recycle.record'].create(records_to_clean_batch)
if batch_commits and not is_test:
self.env.cr.commit()
@api.model
def _notify_records_to_recycle(self):
for recycle in self.search([('recycle_mode', '=', 'manual')]):
if not recycle.notify_user_ids or not recycle.notify_frequency:
continue
if recycle.notify_frequency_period == 'days':
delta = relativedelta(days=recycle.notify_frequency)
elif recycle.notify_frequency_period == 'weeks':
delta = relativedelta(weeks=recycle.notify_frequency)
else:
delta = relativedelta(months=recycle.notify_frequency)
if not recycle.last_notification or\
(recycle.last_notification + delta) < fields.Datetime.now():
recycle.last_notification = fields.Datetime.now()
recycle._send_notification(delta)
def _send_notification(self, delta):
self.ensure_one()
last_date = fields.Date.today() - delta
records_count = self.env['data_recycle.record'].search_count([
('recycle_model_id', '=', self.id),
('create_date', '>=', last_date)
])
partner_ids = self.notify_user_ids.partner_id.ids if records_count else []
if partner_ids:
menu_id = self.env.ref('data_recycle.menu_data_cleaning_root').id
self.env['mail.thread'].message_notify(
body=self.env['ir.qweb']._render(
'data_recycle.notification',
{
'records_count': records_count,
'res_model_label': self.res_model_id.name,
'recycle_model_id': self.id,
'menu_id': menu_id
}
),
model=self._name,
notify_author=True,
partner_ids=partner_ids,
res_id=self.id,
subject=_('Data to Recycle'),
)
def write(self, vals):
if 'active' in vals and not vals['active']:
self.env['data_recycle.record'].search([('recycle_model_id', 'in', self.ids)]).unlink()
super().write(vals)
def open_records(self):
self.ensure_one()
action = self.env["ir.actions.actions"]._for_xml_id("data_recycle.action_data_recycle_record")
action['context'] = dict(ast.literal_eval(action.get('context')), searchpanel_default_recycle_model_id=self.id)
return action
def action_recycle_records(self):
self.sudo()._recycle_records()
if self.recycle_mode == 'manual':
return self.open_records()
return