Florian Charlier
b0f233ba86
Purpose Fix bugs in link replacement (html and text version) 1/ The replacement of urls in text (not html) was buggy when * a string includes multiple urls, and * `base_url` is one of them and not the first * Also in SMS marketing when adding the sms `id` When it came to base_url's turn, the replace function for the content would replace the `base_url` part of a previously shortened url instead of the distinct `base_url` link. 2/ Ampersand character A) The ampersand character prevented replacement of an url inside a `Markup`. Previous tests passed as the tracker was created but the url was not replaced. B) The ampersand character was not recognized as part of an url for simple strings. 3/ Replacement of already short links A faulty logic made it possible to replace "/r/" urls when no "blacklist" was passed. Commit * Ensures that only the base_url link would be replaced instead in this case. * Adds support for urls with "&" * Does prevent shortening short urls * Improves link conversion performance (regex + avoid duplication when there are several occurrences of the same url) * Adds multiple unit tests Task-2783844 closes odoo/odoo#91164 X-original-commit: 61026806d831b49a7cf5c44ffef3d762986781ce Signed-off-by: Thibault Delavallee (tde) <tde@openerp.com>
88 lines
3.9 KiB
Python
88 lines
3.9 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 = 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('body') 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
|
|
|
|
urls_to_replace = [
|
|
(base_url + '/unsubscribe_from_list', self.mailing_id._get_unsubscribe_url(email_to, self.res_id)),
|
|
(base_url + '/view', self.mailing_id._get_view_url(email_to, self.res_id))
|
|
]
|
|
|
|
for url_to_replace, new_url in urls_to_replace:
|
|
if url_to_replace in res['body']:
|
|
res['body'] = res['body'].replace(url_to_replace, new_url if new_url else '#')
|
|
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)
|