Initial commit: Mail packages

odoo-bringout-oca-ocb-mass_mailing/mass_mailing/models/mail_mail.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+import re
+import werkzeug.urls
+
+from odoo import api, fields, models, tools
+
+
+class MailMail(models.Model):
+    """Add the mass mailing campaign data to mail"""
+    _inherit = ['mail.mail']
+
+    mailing_id = fields.Many2one('mailing.mailing', string='Mass Mailing')
+    mailing_trace_ids = fields.One2many('mailing.trace', 'mail_mail_id', string='Statistics')
+
+    def _get_tracking_url(self):
+        token = tools.hmac(self.env(su=True), 'mass_mailing-mail_mail-open', self.id)
+        return werkzeug.urls.url_join(self.get_base_url(), 'mail/track/%s/%s/blank.gif' % (self.id, token))
+
+    def _send_prepare_body(self):
+        """ Override to add the tracking URL to the body and to add
+        trace ID in shortened urls """
+        # TDE: temporary addition (mail was parameter) due to semi-new-API
+        self.ensure_one()
+        body = super(MailMail, self)._send_prepare_body()
+
+        if self.mailing_id and body and self.mailing_trace_ids:
+            for match in set(re.findall(tools.URL_REGEX, self.body_html)):
+                href = match[0]
+                url = match[1]
+
+                parsed = werkzeug.urls.url_parse(url, scheme='http')
+
+                if parsed.scheme.startswith('http') and parsed.path.startswith('/r/'):
+                    new_href = href.replace(url, url + '/m/' + str(self.mailing_trace_ids[0].id))
+                    body = body.replace(href, new_href)
+
+            # generate tracking URL
+            tracking_url = self._get_tracking_url()
+            body = tools.append_content_to_html(
+                body,
+                '<img src="%s"/>' % tracking_url,
+                plaintext=False,
+            )
+
+        body = self.env['mail.render.mixin']._replace_local_links(body)
+
+        return body
+
+    def _send_prepare_values(self, partner=None):
+        # TDE: temporary addition (mail was parameter) due to semi-new-API
+        res = super(MailMail, self)._send_prepare_values(partner)
+        if self.mailing_id and res.get('email_to'):
+            base_url = self.mailing_id.get_base_url()
+            emails = tools.email_split(res.get('email_to')[0])
+            email_to = emails and emails[0] or False
+
+            unsubscribe_url = self.mailing_id._get_unsubscribe_url(email_to, self.res_id)
+            unsubscribe_oneclick_url = self.mailing_id._get_unsubscribe_oneclick_url(email_to, self.res_id)
+            view_url = self.mailing_id._get_view_url(email_to, self.res_id)
+
+            # replace links in body
+            if not tools.is_html_empty(res.get('body')):
+                if f'{base_url}/unsubscribe_from_list' in res['body']:
+                    res['body'] = res['body'].replace(
+                        f'{base_url}/unsubscribe_from_list',
+                        unsubscribe_url,
+                    )
+                if f'{base_url}/view' in res.get('body'):
+                    res['body'] = res['body'].replace(
+                        f'{base_url}/view',
+                        view_url,
+                    )
+
+            # add headers
+            res.setdefault("headers", {}).update({
+                'List-Unsubscribe': f'<{unsubscribe_oneclick_url}>',
+                'List-Unsubscribe-Post': 'List-Unsubscribe=One-Click',
+                'Precedence': 'list',
+                'X-Auto-Response-Suppress': 'OOF',  # avoid out-of-office replies from MS Exchange
+            })
+        return res
+
+    def _postprocess_sent_message(self, success_pids, failure_reason=False, failure_type=None):
+        mail_sent = not failure_type  # we consider that a recipient error is a failure with mass mailling and show them as failed
+        for mail in self:
+            if mail.mailing_id:
+                if mail_sent is True and mail.mailing_trace_ids:
+                    mail.mailing_trace_ids.set_sent()
+                elif mail_sent is False and mail.mailing_trace_ids:
+                    mail.mailing_trace_ids.set_failed(failure_type=failure_type)
+        return super(MailMail, self)._postprocess_sent_message(success_pids, failure_reason=failure_reason, failure_type=failure_type)