Thibault Delavallée
772e1c0cc4
PURPOSE
Mass mailing is currently a bit messy. As SMS will be added as a way to notify
people in mass through SMS let us take this opportunity to somehow clean this
application: organization, light code cleaning, model renaming.
SPECIFICATIONS
Rename mail.mass_mailing.list and mail.mass_mailing.list to mailing.list
and mailing.list.merge. Rename mail.mass_mailing.contact to mailing.contact.
Rename mail.mailing_list.list_contact_rel to mailing.contact.subscription.
Rationale :
* those new names are easier to understand: mailing.list and mailing.contact
are less mail-related, especially taking into account that SMS will allow
to be less mail-oriented;
* those names are easier to read / find / understand;
* align wizard and sub-models naming with the main naming;
* have a mailing as first part of namespacing;
MIGRATION
mail.mass_mailing.list model -> mailing.list
mail.mass_mailing.list.merge model -> mailing.list.merge
mail.mass_mailing.contact model -> mailing.contact
mail.mass_mailing.list_contact_rel model -> mailing.contact.subscription
mail_mass_mailing_contact_list_rel table -> mailing_contact_list_rel (specific
case of a decorated m2m)
fields updated (no column change)
* mailing.list: subscription_contact_ids -> subscription_ids
LINKS
Task ID 2037906
Preparing task ID 1997464 (SMS addition in mass mailing)
PR #34938
165 lines
8.4 KiB
Python
165 lines
8.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
import base64
|
|
|
|
import werkzeug
|
|
|
|
from odoo import _, exceptions, http, tools
|
|
from odoo.http import request
|
|
from odoo.tools import consteq
|
|
|
|
|
|
class MassMailController(http.Controller):
|
|
|
|
def _valid_unsubscribe_token(self, mailing_id, res_id, email, token):
|
|
if not (mailing_id and res_id and email and token):
|
|
return False
|
|
mailing = request.env['mail.mass_mailing'].sudo().browse(mailing_id)
|
|
return consteq(mailing._unsubscribe_token(res_id, email), token)
|
|
|
|
def _log_blacklist_action(self, blacklist_entry, mailing_id, description):
|
|
mailing = request.env['mail.mass_mailing'].sudo().browse(mailing_id)
|
|
model_display = mailing.mailing_model_id.display_name
|
|
blacklist_entry._message_log(body=description + " ({})".format(model_display))
|
|
|
|
@http.route(['/unsubscribe_from_list'], type='http', website=True, multilang=False, auth='public', sitemap=False)
|
|
def unsubscribe_placeholder_link(self, **post):
|
|
"""Dummy route so placeholder is not prefixed by language, MUST have multilang=False"""
|
|
raise werkzeug.exceptions.NotFound()
|
|
|
|
@http.route(['/mail/mailing/<int:mailing_id>/unsubscribe'], type='http', website=True, auth='public')
|
|
def mailing(self, mailing_id, email=None, res_id=None, token="", **post):
|
|
mailing = request.env['mail.mass_mailing'].sudo().browse(mailing_id)
|
|
if mailing.exists():
|
|
res_id = res_id and int(res_id)
|
|
if not self._valid_unsubscribe_token(mailing_id, res_id, email, str(token)):
|
|
raise exceptions.AccessDenied()
|
|
|
|
if mailing.mailing_model_real == 'mailing.contact':
|
|
# Unsubscribe directly + Let the user choose his subscriptions
|
|
mailing.update_opt_out(email, mailing.contact_list_ids.ids, True)
|
|
|
|
contacts = request.env['mailing.contact'].sudo().search([('email_normalized', '=', tools.email_normalize(email))])
|
|
subscription_list_ids = contacts.mapped('subscription_list_ids')
|
|
# In many user are found : if user is opt_out on the list with contact_id 1 but not with contact_id 2,
|
|
# assume that the user is not opt_out on both
|
|
# TODO DBE Fixme : Optimise the following to get real opt_out and opt_in
|
|
opt_out_list_ids = subscription_list_ids.filtered(lambda rel: rel.opt_out).mapped('list_id')
|
|
opt_in_list_ids = subscription_list_ids.filtered(lambda rel: not rel.opt_out).mapped('list_id')
|
|
opt_out_list_ids = set([list.id for list in opt_out_list_ids if list not in opt_in_list_ids])
|
|
|
|
unique_list_ids = set([list.list_id.id for list in subscription_list_ids])
|
|
list_ids = request.env['mailing.list'].sudo().browse(unique_list_ids)
|
|
unsubscribed_list = ', '.join(str(list.name) for list in mailing.contact_list_ids if list.is_public)
|
|
return request.render('mass_mailing.page_unsubscribe', {
|
|
'contacts': contacts,
|
|
'list_ids': list_ids,
|
|
'opt_out_list_ids': opt_out_list_ids,
|
|
'unsubscribed_list': unsubscribed_list,
|
|
'email': email,
|
|
'mailing_id': mailing_id,
|
|
'res_id': res_id,
|
|
'show_blacklist_button': request.env['ir.config_parameter'].sudo().get_param('mass_mailing.show_blacklist_buttons'),
|
|
})
|
|
else:
|
|
opt_in_lists = request.env['mailing.contact.subscription'].sudo().search([
|
|
('contact_id.email_normalized', '=', email),
|
|
('opt_out', '=', False)
|
|
]).mapped('list_id')
|
|
blacklist_rec = request.env['mail.blacklist'].sudo()._add(email)
|
|
self._log_blacklist_action(
|
|
blacklist_rec, mailing_id,
|
|
_("""Requested blacklisting via unsubscribe link."""))
|
|
return request.render('mass_mailing.page_unsubscribed', {
|
|
'email': email,
|
|
'mailing_id': mailing_id,
|
|
'res_id': res_id,
|
|
'list_ids': opt_in_lists,
|
|
'show_blacklist_button': request.env['ir.config_parameter'].sudo().get_param(
|
|
'mass_mailing.show_blacklist_buttons'),
|
|
})
|
|
return request.redirect('/web')
|
|
|
|
@http.route('/mail/mailing/unsubscribe', type='json', auth='public')
|
|
def unsubscribe(self, mailing_id, opt_in_ids, opt_out_ids, email, res_id, token):
|
|
mailing = request.env['mail.mass_mailing'].sudo().browse(mailing_id)
|
|
if mailing.exists():
|
|
if not self._valid_unsubscribe_token(mailing_id, res_id, email, token):
|
|
return 'unauthorized'
|
|
mailing.update_opt_out(email, opt_in_ids, False)
|
|
mailing.update_opt_out(email, opt_out_ids, True)
|
|
return True
|
|
return 'error'
|
|
|
|
@http.route('/mail/track/<int:mail_id>/blank.gif', type='http', auth='public')
|
|
def track_mail_open(self, mail_id, **post):
|
|
""" Email tracking. """
|
|
request.env['mailing.trace'].sudo().set_opened(mail_mail_ids=[mail_id])
|
|
response = werkzeug.wrappers.Response()
|
|
response.mimetype = 'image/gif'
|
|
response.data = base64.b64decode(b'R0lGODlhAQABAIAAANvf7wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==')
|
|
|
|
return response
|
|
|
|
@http.route('/r/<string:code>/m/<int:mailing_trace_id>', type='http', auth="public")
|
|
def full_url_redirect(self, code, mailing_trace_id, **post):
|
|
# don't assume geoip is set, it is part of the website module
|
|
# which mass_mailing doesn't depend on
|
|
country_code = request.session.get('geoip', False) and request.session.geoip.get('country_code', False)
|
|
|
|
request.env['link.tracker.click'].sudo().add_click(
|
|
code,
|
|
ip=request.httprequest.remote_addr,
|
|
country_code=country_code,
|
|
mailing_trace_id=mailing_trace_id
|
|
)
|
|
return werkzeug.utils.redirect(request.env['link.tracker'].get_url_from_code(code), 301)
|
|
|
|
@http.route('/mailing/blacklist/check', type='json', auth='public')
|
|
def blacklist_check(self, mailing_id, res_id, email, token):
|
|
if not self._valid_unsubscribe_token(mailing_id, res_id, email, token):
|
|
return 'unauthorized'
|
|
if email:
|
|
record = request.env['mail.blacklist'].sudo().with_context(active_test=False).search([('email', '=', tools.email_normalize(email))])
|
|
if record['active']:
|
|
return True
|
|
return False
|
|
return 'error'
|
|
|
|
@http.route('/mailing/blacklist/add', type='json', auth='public')
|
|
def blacklist_add(self, mailing_id, res_id, email, token):
|
|
if not self._valid_unsubscribe_token(mailing_id, res_id, email, token):
|
|
return 'unauthorized'
|
|
if email:
|
|
blacklist_rec = request.env['mail.blacklist'].sudo()._add(email)
|
|
self._log_blacklist_action(
|
|
blacklist_rec, mailing_id,
|
|
_("""Requested blacklisting via unsubscription page."""))
|
|
return True
|
|
return 'error'
|
|
|
|
@http.route('/mailing/blacklist/remove', type='json', auth='public')
|
|
def blacklist_remove(self, mailing_id, res_id, email, token):
|
|
if not self._valid_unsubscribe_token(mailing_id, res_id, email, token):
|
|
return 'unauthorized'
|
|
if email:
|
|
blacklist_rec = request.env['mail.blacklist'].sudo()._remove(email)
|
|
self._log_blacklist_action(
|
|
blacklist_rec, mailing_id,
|
|
_("""Requested de-blacklisting via unsubscription page."""))
|
|
return True
|
|
return 'error'
|
|
|
|
@http.route('/mailing/feedback', type='json', auth='public')
|
|
def send_feedback(self, mailing_id, res_id, email, feedback, token):
|
|
mailing = request.env['mail.mass_mailing'].sudo().browse(mailing_id)
|
|
if mailing.exists() and email:
|
|
if not self._valid_unsubscribe_token(mailing_id, res_id, email, token):
|
|
return 'unauthorized'
|
|
model = request.env[mailing.mailing_model_real]
|
|
records = model.sudo().search([('email_normalized', '=', tools.email_normalize(email))])
|
|
for record in records:
|
|
record.sudo().message_post(body=_("Feedback from %s: %s" % (email, feedback)))
|
|
return bool(records)
|
|
return 'error'
|