initial commit 2

1 files changed, 130 insertions, 0 deletions

diff --git a/addons/mass_mailing/models/mailing_trace.py b/addons/mass_mailing/models/mailing_trace.py
new file mode 100644
index 00000000..b4a798e0
--- /dev/null
+++ b/addons/mass_mailing/models/mailing_trace.py
@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import api, fields, models
+
+
+class MailingTrace(models.Model):
+    """ MailingTrace models the statistics collected about emails. Those statistics
+    are stored in a separated model and table to avoid bloating the mail_mail table
+    with statistics values. This also allows to delete emails send with mass mailing
+    without loosing the statistics about them. """
+    _name = 'mailing.trace'
+    _description = 'Mailing Statistics'
+    _rec_name = 'id'
+    _order = 'scheduled DESC'
+
+    trace_type = fields.Selection([('mail', 'Mail')], string='Type', default='mail', required=True)
+    display_name = fields.Char(compute='_compute_display_name')
+    # mail data
+    mail_mail_id = fields.Many2one('mail.mail', string='Mail', index=True)
+    mail_mail_id_int = fields.Integer(
+        string='Mail ID (tech)',
+        help='ID of the related mail_mail. This field is an integer field because '
+             'the related mail_mail can be deleted separately from its statistics. '
+             'However the ID is needed for several action and controllers.',
+        index=True,
+    )
+    email = fields.Char(string="Email", help="Normalized email address")
+    message_id = fields.Char(string='Message-ID')
+    # document
+    model = fields.Char(string='Document model')
+    res_id = fields.Integer(string='Document ID')
+    # campaign / wave data
+    mass_mailing_id = fields.Many2one('mailing.mailing', string='Mailing', index=True, ondelete='cascade')
+    campaign_id = fields.Many2one(
+        related='mass_mailing_id.campaign_id',
+        string='Campaign',
+        store=True, readonly=True, index=True)
+    # Bounce and tracking
+    ignored = fields.Datetime(help='Date when the email has been invalidated. '
+                                   'Invalid emails are blacklisted, opted-out or invalid email format')
+    scheduled = fields.Datetime(help='Date when the email has been created', default=fields.Datetime.now)
+    sent = fields.Datetime(help='Date when the email has been sent')
+    exception = fields.Datetime(help='Date of technical error leading to the email not being sent')
+    opened = fields.Datetime(help='Date when the email has been opened the first time')
+    replied = fields.Datetime(help='Date when this email has been replied for the first time.')
+    bounced = fields.Datetime(help='Date when this email has bounced.')
+    # Link tracking
+    links_click_ids = fields.One2many('link.tracker.click', 'mailing_trace_id', string='Links click')
+    clicked = fields.Datetime(help='Date when customer clicked on at least one tracked link')
+    # Status
+    state = fields.Selection(compute="_compute_state",
+                             selection=[('outgoing', 'Outgoing'),
+                                        ('exception', 'Exception'),
+                                        ('sent', 'Sent'),
+                                        ('opened', 'Opened'),
+                                        ('replied', 'Replied'),
+                                        ('bounced', 'Bounced'),
+                                        ('ignored', 'Ignored')], store=True)
+    failure_type = fields.Selection(selection=[
+        ("SMTP", "Connection failed (outgoing mail server problem)"),
+        ("RECIPIENT", "Invalid email address"),
+        ("BOUNCE", "Email address rejected by destination"),
+        ("UNKNOWN", "Unknown error"),
+    ], string='Failure type')
+    state_update = fields.Datetime(compute="_compute_state", string='State Update',
+                                   help='Last state update of the mail',
+                                   store=True)
+
+    @api.depends('trace_type', 'mass_mailing_id')
+    def _compute_display_name(self):
+        for trace in self:
+            trace.display_name = '%s: %s (%s)' % (trace.trace_type, trace.mass_mailing_id.name, trace.id)
+
+    @api.depends('sent', 'opened', 'clicked', 'replied', 'bounced', 'exception', 'ignored')
+    def _compute_state(self):
+        self.update({'state_update': fields.Datetime.now()})
+        for stat in self:
+            if stat.ignored:
+                stat.state = 'ignored'
+            elif stat.exception:
+                stat.state = 'exception'
+            elif stat.replied:
+                stat.state = 'replied'
+            elif stat.opened or stat.clicked:
+                stat.state = 'opened'
+            elif stat.bounced:
+                stat.state = 'bounced'
+            elif stat.sent:
+                stat.state = 'sent'
+            else:
+                stat.state = 'outgoing'
+
+    @api.model_create_multi
+    def create(self, values_list):
+        for values in values_list:
+            if 'mail_mail_id' in values:
+                values['mail_mail_id_int'] = values['mail_mail_id']
+        return super(MailingTrace, self).create(values_list)
+
+    def _get_records(self, mail_mail_ids=None, mail_message_ids=None, domain=None):
+        if not self.ids and mail_mail_ids:
+            base_domain = [('mail_mail_id_int', 'in', mail_mail_ids)]
+        elif not self.ids and mail_message_ids:
+            base_domain = [('message_id', 'in', mail_message_ids)]
+        else:
+            base_domain = [('id', 'in', self.ids)]
+        if domain:
+            base_domain = ['&'] + domain + base_domain
+        return self.search(base_domain)
+
+    def set_opened(self, mail_mail_ids=None, mail_message_ids=None):
+        traces = self._get_records(mail_mail_ids, mail_message_ids, [('opened', '=', False)])
+        traces.write({'opened': fields.Datetime.now(), 'bounced': False})
+        return traces
+
+    def set_clicked(self, mail_mail_ids=None, mail_message_ids=None):
+        traces = self._get_records(mail_mail_ids, mail_message_ids, [('clicked', '=', False)])
+        traces.write({'clicked': fields.Datetime.now()})
+        return traces
+
+    def set_replied(self, mail_mail_ids=None, mail_message_ids=None):
+        traces = self._get_records(mail_mail_ids, mail_message_ids, [('replied', '=', False)])
+        traces.write({'replied': fields.Datetime.now()})
+        return traces
+
+    def set_bounced(self, mail_mail_ids=None, mail_message_ids=None):
+        traces = self._get_records(mail_mail_ids, mail_message_ids, [('bounced', '=', False), ('opened', '=', False)])
+        traces.write({'bounced': fields.Datetime.now()})
+        return traces