Florian Charlier
bd5a68a1a7
Also impacts mass_mailing_sms, test_mail_sms, test_mass_mailing This PR adds support to receive sms delivery reports. Before this PR, an SMS was considered 'sent' when successfully handled by the third party. The user couldn't know if/when an SMS was actually sent for delivery or delivered to the recipient's device. This was similar to the behavior for emails as delivery reports are not commonly used (and not supported in Odoo). With this work, the SMS `pending` state is introduced in mail, mass_mailing, sms and mass_mailing_sms contexts although only fully used in the latter two modules (+tests of course). Because of the huge cost related to upgrading very large existing databases, the following compromises were made: 1. An email and sms notification/trace SENT means DELIVERED. Those that are sent but NOT DELIVERED are PENDING. The difference between email and sms traces reinforced with this PR is that an email sent will be counted as "sent" ~ "delivered" unless an error is returned for emails while for SMS it can only be reached if a delivery report is received. 2. The Link between an SMS uuid (shared with trusted parties) and the tracking records (notifications or traces) is done via an explicit relationship table (sms_tracker) instead of via a new field. This however allowed to nicely concentrate the state update logic. A `process` state is added to represent an intermediate step in the sending process, such as held at IAP for SMS. A few adjustments are also included to update for IAP api v3. Also, adapts and includes new tests. Task-2560666 Part-of: odoo/odoo#133392
111 lines
4.7 KiB
Python
111 lines
4.7 KiB
Python
# -*- 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')
|
|
|
|
@api.model_create_multi
|
|
def create(self, values_list):
|
|
""" Override mail_mail creation to create an entry in mail.mail.statistics """
|
|
# TDE note: should be after 'all values computed', to have values (FIXME after merging other branch holding create refactoring)
|
|
mails = super(MailMail, self).create(values_list)
|
|
for mail, values in zip(mails, values_list):
|
|
if values.get('mailing_trace_ids'):
|
|
mail.mailing_trace_ids.write({'message_id': mail.message_id})
|
|
return mails
|
|
|
|
def _get_tracking_url(self):
|
|
token = self._generate_mail_recipient_token(self.id)
|
|
return werkzeug.urls.url_join(
|
|
self.get_base_url(),
|
|
f'mail/track/{self.id}/{token}/blank.gif'
|
|
)
|
|
|
|
@api.model
|
|
def _generate_mail_recipient_token(self, mail_id):
|
|
return tools.hmac(self.env(su=True), 'mass_mailing-mail_mail-open', mail_id)
|
|
|
|
def _prepare_outgoing_body(self):
|
|
""" Override to add the tracking URL to the body and to add trace ID in
|
|
shortened urls """
|
|
self.ensure_one()
|
|
# super() already cleans pseudo-void content from editor
|
|
body = super()._prepare_outgoing_body()
|
|
|
|
if body and self.mailing_id and self.mailing_trace_ids:
|
|
for match in set(re.findall(tools.URL_REGEX, body)):
|
|
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,
|
|
f'<img src="{tracking_url}"/>',
|
|
plaintext=False,
|
|
)
|
|
return body
|
|
|
|
def _prepare_outgoing_list(self, recipients_follower_status=None):
|
|
""" Update mailing specific links to replace generic unsubscribe and
|
|
view links by email-specific links. Also add headers to allow
|
|
unsubscribe from email managers. """
|
|
email_list = super()._prepare_outgoing_list(recipients_follower_status)
|
|
if not self.res_id or not self.mailing_id:
|
|
return email_list
|
|
|
|
base_url = self.mailing_id.get_base_url()
|
|
for email_values in email_list:
|
|
if not email_values['email_to']:
|
|
continue
|
|
|
|
emails = tools.email_split(email_values['email_to'][0])
|
|
email_to = emails[0] if emails else False
|
|
unsubscribe_url = self.mailing_id._get_unsubscribe_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(email_values['body']):
|
|
if f'{base_url}/unsubscribe_from_list' in email_values['body']:
|
|
email_values['body'] = email_values['body'].replace(
|
|
f'{base_url}/unsubscribe_from_list',
|
|
unsubscribe_url,
|
|
)
|
|
if f'{base_url}/view' in email_values['body']:
|
|
email_values['body'] = email_values['body'].replace(
|
|
f'{base_url}/view',
|
|
view_url,
|
|
)
|
|
|
|
# add headers
|
|
email_values['headers'].update({
|
|
'List-Unsubscribe': f'<{unsubscribe_url}>',
|
|
'List-Unsubscribe-Post': 'List-Unsubscribe=One-Click',
|
|
'Precedence': 'list',
|
|
'X-Auto-Response-Suppress': 'OOF', # avoid out-of-office replies from MS Exchange
|
|
})
|
|
return email_list
|
|
|
|
def _postprocess_sent_message(self, success_pids, failure_reason=False, failure_type=None):
|
|
if failure_type: # we consider that a recipient error is a failure with mass mailing and show them as failed
|
|
self.filtered('mailing_id').mailing_trace_ids.set_failed(failure_type=failure_type)
|
|
else:
|
|
self.filtered('mailing_id').mailing_trace_ids.set_sent()
|
|
return super()._postprocess_sent_message(success_pids, failure_reason=failure_reason, failure_type=failure_type)
|