Thibault Delavallée
2520bfe625
Purpose of this commit is to remove the "done" field computation. Indeed
it is based on either
* mail_sent field if scheduler is global to the event (before or after
event). This computation is light as this field changes only once
when emails are scheduled and sent;
* status of event registrations compared to all sent communication on
those registrations. This is costly as adding a new registration changes
In this commit we therefore
* rename ``done`` to ``mail_done`` to ease grep and understanding;
* remove ``mail_sent`` as it is integrated within ``done``;
* manually update ``mail_done`` when updating schedulers instead of doing
it through a compute method;
Some code cleaning is performed to make it clearer and easier to understand.
LINKS
Task ID-2414658
COM PR odoo/odoo#63093
UPG PR odoo/upgrade#2014
263 lines
12 KiB
Python
263 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import logging
|
|
import random
|
|
import threading
|
|
|
|
from datetime import datetime
|
|
from dateutil.relativedelta import relativedelta
|
|
|
|
from odoo import api, fields, models, tools
|
|
from odoo.tools import exception_to_unicode
|
|
from odoo.tools.translate import _
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
_INTERVALS = {
|
|
'hours': lambda interval: relativedelta(hours=interval),
|
|
'days': lambda interval: relativedelta(days=interval),
|
|
'weeks': lambda interval: relativedelta(days=7*interval),
|
|
'months': lambda interval: relativedelta(months=interval),
|
|
'now': lambda interval: relativedelta(hours=0),
|
|
}
|
|
|
|
|
|
class EventTypeMail(models.Model):
|
|
""" Template of event.mail to attach to event.type. Those will be copied
|
|
upon all events created in that type to ease event creation. """
|
|
_name = 'event.type.mail'
|
|
_description = 'Mail Scheduling on Event Category'
|
|
|
|
event_type_id = fields.Many2one(
|
|
'event.type', string='Event Type',
|
|
ondelete='cascade', required=True)
|
|
notification_type = fields.Selection([('mail', 'Mail')], string='Send', default='mail', required=True)
|
|
interval_nbr = fields.Integer('Interval', default=1)
|
|
interval_unit = fields.Selection([
|
|
('now', 'Immediately'),
|
|
('hours', 'Hours'), ('days', 'Days'),
|
|
('weeks', 'Weeks'), ('months', 'Months')],
|
|
string='Unit', default='hours', required=True)
|
|
interval_type = fields.Selection([
|
|
('after_sub', 'After each registration'),
|
|
('before_event', 'Before the event'),
|
|
('after_event', 'After the event')],
|
|
string='Trigger', default="before_event", required=True)
|
|
template_id = fields.Many2one(
|
|
'mail.template', string='Email Template',
|
|
domain=[('model', '=', 'event.registration')], ondelete='restrict',
|
|
help='This field contains the template of the mail that will be automatically sent')
|
|
|
|
@api.model
|
|
def _get_event_mail_fields_whitelist(self):
|
|
""" Whitelist of fields that are copied from event_type_mail_ids to event_mail_ids when
|
|
changing the event_type_id field of event.event """
|
|
return ['notification_type', 'template_id', 'interval_nbr', 'interval_unit', 'interval_type']
|
|
|
|
|
|
class EventMailScheduler(models.Model):
|
|
""" Event automated mailing. This model replaces all existing fields and
|
|
configuration allowing to send emails on events since Odoo 9. A cron exists
|
|
that periodically checks for mailing to run. """
|
|
_name = 'event.mail'
|
|
_rec_name = 'event_id'
|
|
_description = 'Event Automated Mailing'
|
|
|
|
event_id = fields.Many2one('event.event', string='Event', required=True, ondelete='cascade')
|
|
sequence = fields.Integer('Display order')
|
|
notification_type = fields.Selection([('mail', 'Mail')], string='Send', default='mail', required=True)
|
|
interval_nbr = fields.Integer('Interval', default=1)
|
|
interval_unit = fields.Selection([
|
|
('now', 'Immediately'),
|
|
('hours', 'Hours'), ('days', 'Days'),
|
|
('weeks', 'Weeks'), ('months', 'Months')],
|
|
string='Unit', default='hours', required=True)
|
|
interval_type = fields.Selection([
|
|
('after_sub', 'After each registration'),
|
|
('before_event', 'Before the event'),
|
|
('after_event', 'After the event')],
|
|
string='Trigger ', default="before_event", required=True)
|
|
template_id = fields.Many2one(
|
|
'mail.template', string='Email Template',
|
|
domain=[('model', '=', 'event.registration')], ondelete='restrict',
|
|
help='This field contains the template of the mail that will be automatically sent')
|
|
scheduled_date = fields.Datetime('Schedule Date', compute='_compute_scheduled_date', store=True)
|
|
# contact and status
|
|
mail_registration_ids = fields.One2many(
|
|
'event.mail.registration', 'scheduler_id',
|
|
help='Communication related to event registrations')
|
|
mail_done = fields.Boolean("Sent", copy=False, readonly=True)
|
|
mail_state = fields.Selection(
|
|
[('running', 'Running'), ('scheduled', 'Scheduled'), ('sent', 'Sent')],
|
|
string='Global communication Status', compute='_compute_mail_state')
|
|
mail_count_done = fields.Integer('# Sent', copy=False, readonly=True)
|
|
|
|
@api.depends('event_id.date_begin', 'event_id.date_end', 'interval_type', 'interval_unit', 'interval_nbr')
|
|
def _compute_scheduled_date(self):
|
|
for scheduler in self:
|
|
if scheduler.interval_type == 'after_sub':
|
|
date, sign = scheduler.event_id.create_date, 1
|
|
elif scheduler.interval_type == 'before_event':
|
|
date, sign = scheduler.event_id.date_begin, -1
|
|
else:
|
|
date, sign = scheduler.event_id.date_end, 1
|
|
|
|
scheduler.scheduled_date = date + _INTERVALS[scheduler.interval_unit](sign * scheduler.interval_nbr) if date else False
|
|
|
|
@api.depends('interval_type', 'scheduled_date', 'mail_done')
|
|
def _compute_mail_state(self):
|
|
for scheduler in self:
|
|
# registrations based
|
|
if scheduler.interval_type == 'after_sub':
|
|
scheduler.mail_state = 'running'
|
|
# global event based
|
|
elif scheduler.mail_done:
|
|
scheduler.mail_state = 'sent'
|
|
elif scheduler.scheduled_date:
|
|
scheduler.mail_state = 'scheduled'
|
|
else:
|
|
scheduler.mail_state = 'running'
|
|
|
|
def execute(self):
|
|
for scheduler in self:
|
|
now = fields.Datetime.now()
|
|
if scheduler.interval_type == 'after_sub':
|
|
new_registrations = scheduler.event_id.registration_ids.filtered_domain(
|
|
[('state', 'not in', ('cancel', 'draft'))]
|
|
) - scheduler.mail_registration_ids.registration_id
|
|
scheduler._create_missing_mail_registrations(new_registrations)
|
|
|
|
# execute scheduler on registrations
|
|
scheduler.mail_registration_ids.execute()
|
|
total_sent = len(scheduler.mail_registration_ids.filtered(lambda reg: reg.mail_sent))
|
|
scheduler.update({
|
|
'mail_done': total_sent >= (scheduler.event_id.seats_reserved + scheduler.event_id.seats_used),
|
|
'mail_count_done': total_sent,
|
|
})
|
|
else:
|
|
# before or after event -> one shot email
|
|
if scheduler.mail_done or scheduler.notification_type != 'mail':
|
|
continue
|
|
# no template -> ill configured, skip and avoid crash
|
|
if not scheduler.template_id:
|
|
continue
|
|
# do not send emails if the mailing was scheduled before the event but the event is over
|
|
if scheduler.scheduled_date <= now and (scheduler.interval_type != 'before_event' or scheduler.event_id.date_end > now):
|
|
scheduler.event_id.mail_attendees(scheduler.template_id.id)
|
|
scheduler.update({
|
|
'mail_done': True,
|
|
'mail_count_done': scheduler.event_id.seats_reserved + scheduler.event_id.seats_used,
|
|
})
|
|
return True
|
|
|
|
def _create_missing_mail_registrations(self, registrations):
|
|
new = []
|
|
for scheduler in self:
|
|
new += [{
|
|
'registration_id': registration.id,
|
|
'scheduler_id': scheduler.id,
|
|
} for registration in registrations]
|
|
if new:
|
|
return self.env['event.mail.registration'].create(new)
|
|
return self.env['event.mail.registration']
|
|
|
|
@api.model
|
|
def _warn_template_error(self, scheduler, exception):
|
|
# We warn ~ once by hour ~ instead of every 10 min if the interval unit is more than 'hours'.
|
|
if random.random() < 0.1666 or scheduler.interval_unit in ('now', 'hours'):
|
|
ex_s = exception_to_unicode(exception)
|
|
try:
|
|
event, template = scheduler.event_id, scheduler.template_id
|
|
emails = list(set([event.organizer_id.email, event.user_id.email, template.write_uid.email]))
|
|
subject = _("WARNING: Event Scheduler Error for event: %s", event.name)
|
|
body = _("""Event Scheduler for:
|
|
- Event: %(event_name)s (%(event_id)s)
|
|
- Scheduled: %(date)s
|
|
- Template: %(template_name)s (%(template_id)s)
|
|
|
|
Failed with error:
|
|
- %(error)s
|
|
|
|
You receive this email because you are:
|
|
- the organizer of the event,
|
|
- or the responsible of the event,
|
|
- or the last writer of the template.
|
|
""",
|
|
event_name=event.name,
|
|
event_id=event.id,
|
|
date=scheduler.scheduled_date,
|
|
template_name=template.name,
|
|
template_id=template.id,
|
|
error=ex_s)
|
|
email = self.env['ir.mail_server'].build_email(
|
|
email_from=self.env.user.email,
|
|
email_to=emails,
|
|
subject=subject, body=body,
|
|
)
|
|
self.env['ir.mail_server'].send_email(email)
|
|
except Exception as e:
|
|
_logger.error("Exception while sending traceback by email: %s.\n Original Traceback:\n%s", e, exception)
|
|
pass
|
|
|
|
@api.model
|
|
def run(self, autocommit=False):
|
|
""" Backward compatible method, notably if crons are not updated when
|
|
migrating for some reason. """
|
|
return self.schedule_communications(autocommit=autocommit)
|
|
|
|
@api.model
|
|
def schedule_communications(self, autocommit=False):
|
|
schedulers = self.search([
|
|
('mail_done', '=', False),
|
|
('scheduled_date', '<=', fields.Datetime.now())
|
|
])
|
|
|
|
for scheduler in schedulers:
|
|
try:
|
|
with self.env.cr.savepoint():
|
|
# Prevent a mega prefetch of the registration ids of all the events of all the schedulers
|
|
self.browse(scheduler.id).execute()
|
|
except Exception as e:
|
|
_logger.exception(e)
|
|
self.invalidate_cache()
|
|
self._warn_template_error(scheduler, e)
|
|
else:
|
|
if autocommit and not getattr(threading.currentThread(), 'testing', False):
|
|
self.env.cr.commit()
|
|
return True
|
|
|
|
|
|
class EventMailRegistration(models.Model):
|
|
_name = 'event.mail.registration'
|
|
_description = 'Registration Mail Scheduler'
|
|
_rec_name = 'scheduler_id'
|
|
_order = 'scheduled_date DESC'
|
|
|
|
scheduler_id = fields.Many2one('event.mail', 'Mail Scheduler', required=True, ondelete='cascade')
|
|
registration_id = fields.Many2one('event.registration', 'Attendee', required=True, ondelete='cascade')
|
|
scheduled_date = fields.Datetime('Scheduled Time', compute='_compute_scheduled_date', store=True)
|
|
mail_sent = fields.Boolean('Mail Sent')
|
|
|
|
def execute(self):
|
|
now = fields.Datetime.now()
|
|
todo = self.filtered(lambda reg_mail:
|
|
not reg_mail.mail_sent and \
|
|
reg_mail.registration_id.state in ['open', 'done'] and \
|
|
(reg_mail.scheduled_date and reg_mail.scheduled_date <= now) and \
|
|
reg_mail.scheduler_id.notification_type == 'mail'
|
|
)
|
|
for reg_mail in todo:
|
|
reg_mail.scheduler_id.template_id.send_mail(reg_mail.registration_id.id)
|
|
todo.write({'mail_sent': True})
|
|
|
|
@api.depends('registration_id', 'scheduler_id.interval_unit', 'scheduler_id.interval_type')
|
|
def _compute_scheduled_date(self):
|
|
for mail in self:
|
|
if mail.registration_id:
|
|
date_open = mail.registration_id.date_open
|
|
date_open_datetime = date_open or fields.Datetime.now()
|
|
mail.scheduled_date = date_open_datetime + _INTERVALS[mail.scheduler_id.interval_unit](mail.scheduler_id.interval_nbr)
|
|
else:
|
|
mail.scheduled_date = False
|