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>
92 lines
3.1 KiB
Python
92 lines
3.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
from random import randint
|
|
|
|
from odoo import _, api, fields, models, SUPERUSER_ID
|
|
from odoo.exceptions import UserError
|
|
|
|
|
|
class UtmStage(models.Model):
|
|
|
|
"""Stage for utm campaigns. """
|
|
_name = 'utm.stage'
|
|
_description = 'Campaign Stage'
|
|
_order = 'sequence'
|
|
|
|
name = fields.Char(required=True, translate=True)
|
|
sequence = fields.Integer()
|
|
|
|
|
|
class UtmMedium(models.Model):
|
|
# OLD crm.case.channel
|
|
_name = 'utm.medium'
|
|
_description = 'UTM Medium'
|
|
_order = 'name'
|
|
|
|
name = fields.Char(string='Medium Name', required=True)
|
|
active = fields.Boolean(default=True)
|
|
|
|
@api.ondelete(at_uninstall=False)
|
|
def _unlink_except_utm_medium_email(self):
|
|
utm_medium_email = self.env.ref('utm.utm_medium_email', raise_if_not_found=False)
|
|
if utm_medium_email and utm_medium_email in self:
|
|
raise UserError(_(
|
|
"The UTM medium '%s' cannot be deleted as it is used in some main "
|
|
"functional flows, such as the recruitment and the mass mailing.",
|
|
utm_medium_email.name
|
|
))
|
|
|
|
|
|
class UtmCampaign(models.Model):
|
|
# OLD crm.case.resource.type
|
|
_name = 'utm.campaign'
|
|
_description = 'UTM Campaign'
|
|
|
|
name = fields.Char(string='Campaign Name', required=True, translate=True)
|
|
|
|
user_id = fields.Many2one(
|
|
'res.users', string='Responsible',
|
|
required=True, default=lambda self: self.env.uid)
|
|
stage_id = fields.Many2one('utm.stage', string='Stage', ondelete='restrict', required=True,
|
|
default=lambda self: self.env['utm.stage'].search([], limit=1),
|
|
group_expand='_group_expand_stage_ids')
|
|
tag_ids = fields.Many2many(
|
|
'utm.tag', 'utm_tag_rel',
|
|
'tag_id', 'campaign_id', string='Tags')
|
|
|
|
is_auto_campaign = fields.Boolean(default=False, string="Automatically Generated Campaign", help="Allows us to filter relevant Campaigns")
|
|
color = fields.Integer(string='Color Index')
|
|
|
|
@api.model
|
|
def _group_expand_stage_ids(self, stages, domain, order):
|
|
""" Read group customization in order to display all the stages in the
|
|
kanban view, even if they are empty
|
|
"""
|
|
stage_ids = stages._search([], order=order, access_rights_uid=SUPERUSER_ID)
|
|
return stages.browse(stage_ids)
|
|
|
|
class UtmSource(models.Model):
|
|
_name = 'utm.source'
|
|
_description = 'UTM Source'
|
|
|
|
name = fields.Char(string='Source Name', required=True, translate=True)
|
|
|
|
class UtmTag(models.Model):
|
|
"""Model of categories of utm campaigns, i.e. marketing, newsletter, ... """
|
|
_name = 'utm.tag'
|
|
_description = 'UTM Tag'
|
|
_order = 'name'
|
|
|
|
def _default_color(self):
|
|
return randint(1, 11)
|
|
|
|
name = fields.Char(required=True, translate=True)
|
|
color = fields.Integer(
|
|
string='Color Index', default=lambda self: self._default_color(),
|
|
help='Tag color. No color means no display in kanban to distinguish internal tags from public categorization tags.')
|
|
|
|
_sql_constraints = [
|
|
('name_uniq', 'unique (name)', "Tag name already exists !"),
|
|
]
|