Aurélien Warnon
1e25946a76
PURPOSE This commit consolidates UTM usage across all applications. Global purpose is to avoid having undesired side-effects, such as unlinking an utm.source/utm.medium/utm.campaign and at the same time cascading the deletion to various records without noticing. SPECS ALLOW MORE PEOPLE TO CLEAN UTM RECORDS Currently, not even the system administrator can delete utm.mediums and utm.sources (he can only delete campaigns). These were considered as "technical records", but allowing some cleanup is a good idea since these records are often automatically generated and can create a lot of unnecessary noise in the database. That's why we now allow the following groups to delete all UTM records (sources, mediums and campaigns): - group_system - group_mass_mailing_user - group_social_manager (enterprise) PREVENT DELETION For some use cases, removing an utm.source/utm.medium/utm.campaign would cascade delete the related record, which was unintended / hidden side effect. These combinations were secured by preventing to unlink: - mailing.mailing source_id field Trying to delete the utm.source will throw an error message - mailing.mailing medium_id field Trying to delete the utm.medium will throw an error message - hr.recruitment.source source_id field Trying to delete the utm.source will throw an error message ADDING CLEAN ERROR MESSAGES When trying to delete an UTM record that is linked with ondelete="restrict", we improved the error message to give a clear explication to the user, e.g: "You can't delete these UTM sources as they are linked to the following mailings in the Mass Mailing APP, and deleting the source would break the statistics: Newsletter" SPECIFY 'ondelete' strategy For a lot of uses of sources/mediums/campaigns, the 'ondelete' strategy was not specified, leading to the confusion of "is this really how we want to handle this?". A lot of ondelete="set null" have been added in various field definitions to ensure that this is the desired and logical strategy we want for that specific model. PREVENT REMOVING HARDCODED UTM RECORDS In some functional flows, UTM records are hardcoded using their direct record reference. This is notably the case for the recruitment process and its creation of aliases, and for the Email / SMS Marketing flows. As deleting them would break these flows, we prevent their deletion in a "api.ondelete" method. ENFORCE NEW RULES WITH TESTS A lot of python tests have been added to make sure we enforce the decisions taken here above. LINKS ENT PR odoo/enterprise#19048 Task-2459480 closes odoo/odoo#72239 Signed-off-by: Thibault Delavallee (tde) <tde@openerp.com>
93 lines
3.9 KiB
Python
93 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import werkzeug.urls
|
|
|
|
from odoo import fields, models, _
|
|
|
|
|
|
class SMSComposer(models.TransientModel):
|
|
_inherit = 'sms.composer'
|
|
|
|
# mass mode with mass sms
|
|
mass_sms_allow_unsubscribe = fields.Boolean('Include opt-out link', default=True)
|
|
mailing_id = fields.Many2one('mailing.mailing', string='Mailing')
|
|
utm_campaign_id = fields.Many2one('utm.campaign', string='Campaign', ondelete='set null')
|
|
|
|
# ------------------------------------------------------------
|
|
# Mass mode specific
|
|
# ------------------------------------------------------------
|
|
|
|
def _get_unsubscribe_url(self, res_id, trace_code, number):
|
|
return werkzeug.urls.url_join(
|
|
self.get_base_url(),
|
|
'/sms/%s/%s' % (self.mailing_id.id, trace_code)
|
|
)
|
|
|
|
def _prepare_mass_sms_trace_values(self, record, sms_values):
|
|
trace_code = self.env['mailing.trace']._get_random_code()
|
|
trace_values = {
|
|
'model': self.res_model,
|
|
'res_id': record.id,
|
|
'trace_type': 'sms',
|
|
'mass_mailing_id': self.mailing_id.id,
|
|
'sms_number': sms_values['number'],
|
|
'sms_code': trace_code,
|
|
}
|
|
if sms_values['state'] == 'error':
|
|
trace_values['failure_type'] = sms_values['failure_type']
|
|
trace_values['trace_status'] = 'error'
|
|
elif sms_values['state'] == 'canceled':
|
|
trace_values['failure_type'] = sms_values['failure_type']
|
|
trace_values['trace_status'] = 'cancel'
|
|
else:
|
|
if self.mass_sms_allow_unsubscribe:
|
|
sms_values['body'] = '%s\n%s' % (sms_values['body'] or '', _('STOP SMS : %s', self._get_unsubscribe_url(record.id, trace_code, sms_values['number'])))
|
|
return trace_values
|
|
|
|
def _get_optout_record_ids(self, records, recipients_info):
|
|
""" Fetch opt-out records based on mailing. """
|
|
res = super(SMSComposer, self)._get_optout_record_ids(records, recipients_info)
|
|
if self.mailing_id:
|
|
optout_res_ids = self.mailing_id._get_opt_out_list_sms()
|
|
res += optout_res_ids
|
|
return res
|
|
|
|
def _get_done_record_ids(self, records, recipients_info):
|
|
""" A/B testing could lead to records having been already mailed. """
|
|
res = super(SMSComposer, self)._get_done_record_ids(records, recipients_info)
|
|
if self.mailing_id:
|
|
seen_ids, seen_list = self.mailing_id._get_seen_list_sms()
|
|
res += seen_ids
|
|
return res
|
|
|
|
def _prepare_body_values(self, records):
|
|
all_bodies = super(SMSComposer, self)._prepare_body_values(records)
|
|
if self.mailing_id:
|
|
tracker_values = self.mailing_id._get_link_tracker_values()
|
|
for sms_id, body in all_bodies.items():
|
|
body = self.env['mail.render.mixin'].sudo()._shorten_links_text(body, tracker_values)
|
|
all_bodies[sms_id] = body
|
|
return all_bodies
|
|
|
|
def _prepare_mass_sms_values(self, records):
|
|
result = super(SMSComposer, self)._prepare_mass_sms_values(records)
|
|
if self.composition_mode == 'mass' and self.mailing_id:
|
|
for record in records:
|
|
sms_values = result[record.id]
|
|
|
|
trace_values = self._prepare_mass_sms_trace_values(record, sms_values)
|
|
sms_values.update({
|
|
'mailing_id': self.mailing_id.id,
|
|
'mailing_trace_ids': [(0, 0, trace_values)],
|
|
})
|
|
return result
|
|
|
|
def _prepare_mass_sms(self, records, sms_record_values):
|
|
sms_all = super(SMSComposer, self)._prepare_mass_sms(records, sms_record_values)
|
|
if self.mailing_id:
|
|
updated_bodies = sms_all._update_body_short_links()
|
|
for sms in sms_all:
|
|
sms.body = updated_bodies[sms.id]
|
|
return sms_all
|