From 50762307e45737161050f6ea0973190599fa1813 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thibault=20Delavall=C3=A9e?= <tde@odoo.com>
Date: Mon, 5 Jun 2023 10:45:52 +0000
Subject: [PATCH] [IMP] base, mail: split company email colors from document
 colors

PURPOSE

Settings allow to change colors used in emails (primary and secondary colors).
Those are used for headers and buttons. They are currently shared with colors
used for base documents and reports layout: changing email colors change
documents colors, which is not expected nor clearly indicated.

SPECIFICATIONS

Split configuration: colors used in documents may differ from colors used in
emails. Duplicate color fields (primary and secondary). To ease setup when
updating documents colors, update mail colors accordingly. Inverse is not
true as we consider documents being the main configuration, and emails a
more fine-grain configuration.

Task-3346388

Part-of: odoo/odoo#123678
---
 addons/digest/data/digest_data.xml            |  4 +-
 addons/mail/__manifest__.py                   |  2 +-
 .../data/mail_templates_email_layouts.xml     | 10 ++--
 addons/mail/models/res_company.py             | 27 +++++++++-
 addons/mail/models/res_config_settings.py     |  4 +-
 addons/mail/tests/__init__.py                 |  1 +
 addons/mail/tests/test_res_company.py         | 52 +++++++++++++++++++
 .../mail/views/res_config_settings_views.xml  |  4 +-
 .../data/mailing_data_templates.xml           |  2 +-
 9 files changed, 93 insertions(+), 13 deletions(-)
 create mode 100644 addons/mail/tests/test_res_company.py

diff --git a/addons/digest/data/digest_data.xml b/addons/digest/data/digest_data.xml
index eec141479cc..5f8b2c16820 100644
--- a/addons/digest/data/digest_data.xml
+++ b/addons/digest/data/digest_data.xml
@@ -11,7 +11,7 @@
         <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=no;"/>
         <meta http-equiv="X-UA-Compatible" content="IE=9; IE=8; IE=7; IE=EDGE" />
         <style type="text/css">
-            <t t-set="color_company" t-value="company.secondary_color or '#875a7b'"/>
+            <t t-set="color_company" t-value="company.email_secondary_color or '#875a7b'"/>
             /* Remove space around the email design. */
             html,
             body {
@@ -360,7 +360,7 @@
                                                             <t t-set="kpi_subtitle" t-value="kpi_info['kpi_col1']['col_subtitle']" />
                                                         </div>
                                                     </td>
-                                                    <td t-if="kpi_info.get('kpi_col2')" class="kpi_cell" t-att-style="'border-top: 2px solid ' + (company.secondary_color or  '#875a7b')">
+                                                    <td t-if="kpi_info.get('kpi_col2')" class="kpi_cell" t-att-style="'border-top: 2px solid ' + (company.email_secondary_color or '#875a7b')">
                                                         <div t-call="digest.digest_tool_kpi">
                                                             <t t-set="kpi_value" t-value="kpi_info['kpi_col2']['value']" />
                                                             <t t-set="kpi_margin" t-value="kpi_info['kpi_col2'].get('margin')" />
diff --git a/addons/mail/__manifest__.py b/addons/mail/__manifest__.py
index e676fb37c32..fc26aee58c3 100644
--- a/addons/mail/__manifest__.py
+++ b/addons/mail/__manifest__.py
@@ -2,7 +2,7 @@
 
 {
     'name': 'Discuss',
-    'version': '1.13',
+    'version': '1.14',
     'category': 'Productivity/Discuss',
     'sequence': 145,
     'summary': 'Chat, mail gateway and private channels',
diff --git a/addons/mail/data/mail_templates_email_layouts.xml b/addons/mail/data/mail_templates_email_layouts.xml
index b631713e0bb..ddac4b4a6bb 100644
--- a/addons/mail/data/mail_templates_email_layouts.xml
+++ b/addons/mail/data/mail_templates_email_layouts.xml
@@ -37,7 +37,7 @@
                     <table cellspacing="0" cellpadding="0" border="0">
                         <tbody>
                             <tr>
-                                <td t-if="has_button_access" t-att-style="'border-radius: 3px; text-align: center; background: ' + (company.secondary_color if company.secondary_color else '#875A7B')">
+                                <td t-if="has_button_access" t-att-style="'border-radius: 3px; text-align: center; background: ' + (company.email_secondary_color or '#875A7B') + ';'">
                                     <a t-att-href="button_access['url']" style="font-size: 12px; color: #FFFFFF; display: block; padding: 8px 12px 11px; text-decoration: none !important; font-weight: 400;">
                                         <t t-out="button_access['title']"/>
                                     </a>
@@ -46,7 +46,7 @@
 
                                 <td t-if="actions">
                                     <t t-foreach="actions" t-as="action">
-                                        <a t-att-href="action['url']" t-att-style="'font-size: 12px; color: ' + (company.secondary_color or '#875A7B')+ '; text-decoration:none !important;'">
+                                        <a t-att-href="action['url']" t-att-style="'font-size: 12px; color: ' + (company.email_secondary_color or '#875A7B')+ '; text-decoration:none !important;'">
                                             <t t-out="action['title']"/>
                                         </a>
                                         &amp;nbsp;&amp;nbsp;
@@ -101,7 +101,8 @@
     </p>
 </div>
 <div style="color: #555555; font-size:11px;">
-    Powered by <a target="_blank" href="https://www.odoo.com?utm_source=db&amp;utm_medium=email" style="color: #875A7B;">Odoo</a>
+    Powered by <a target="_blank" href="https://www.odoo.com?utm_source=db&amp;utm_medium=email"
+                  t-att-style="'color: ' + (company.email_secondary_color or '#875A7B') + ';'">Odoo</a>
     <span id="mail_unfollow">
         | <a href="/mail/unfollow" style="text-decoration:none; color:#555555;">Unfollow</a>
     </span>
@@ -174,7 +175,8 @@
 </td></tr>
 <!-- POWERED BY -->
 <tr><td align="center" style="min-width: 590px;">
-        Powered by <a target="_blank" href="https://www.odoo.com?utm_source=db&amp;utm_medium=email" style="color: #875A7B;">Odoo</a>
+        Powered by <a target="_blank" href="https://www.odoo.com?utm_source=db&amp;utm_medium=email"
+                      t-att-style="'color: ' + (company.email_secondary_color or '#875A7B') + ';'">Odoo</a>
     <span id="mail_unfollow">
         | <a href="/mail/unfollow" style="text-decoration:none; color:#555555;">Unfollow</a>
     </span>
diff --git a/addons/mail/models/res_company.py b/addons/mail/models/res_company.py
index fc21ad3616d..9714aa68f10 100644
--- a/addons/mail/models/res_company.py
+++ b/addons/mail/models/res_company.py
@@ -12,8 +12,15 @@ class Company(models.Model):
     catchall_formatted = fields.Char(string="Catchall", compute="_compute_catchall")
     # the compute method is sudo'ed because it needs to access res.partner records
     # portal users cannot access those (but they should be able to read the company email address)
-    email_formatted = fields.Char(string="Formatted Email",
+    email_formatted = fields.Char(
+        string="Formatted Email",
         compute="_compute_email_formatted", compute_sudo=True)
+    email_primary_color = fields.Char(
+        "Email Header Color", compute="_compute_email_primary_color",
+        readonly=False, store=True)
+    email_secondary_color = fields.Char(
+        "Email Button Color", compute="_compute_email_secondary_color",
+        readonly=False, store=True)
 
     @api.depends('name')
     def _compute_catchall(self):
@@ -38,3 +45,21 @@ class Company(models.Model):
                 company.email_formatted = company.catchall_formatted
             else:
                 company.email_formatted = ''
+
+    @api.depends('primary_color')
+    def _compute_email_primary_color(self):
+        """ When updating documents layout colors, force usage of same colors
+        for emails as it is considered as base colors for all communication.
+        Inverse is not true, people may change email colors without changing
+        their overall layout. """
+        for company in self:
+            company.email_primary_color = company.primary_color or '#000000'
+
+    @api.depends('secondary_color')
+    def _compute_email_secondary_color(self):
+        """ When updating documents layout colors, force usage of same colors
+        for emails as it is considered as base colors for all communication.
+        Inverse is not true, people may change email colors without changing
+        their overall layout. """
+        for company in self:
+            company.email_secondary_color = company.secondary_color or '#875A7B'
diff --git a/addons/mail/models/res_config_settings.py b/addons/mail/models/res_config_settings.py
index b42e390076d..dcd4eababa9 100644
--- a/addons/mail/models/res_config_settings.py
+++ b/addons/mail/models/res_config_settings.py
@@ -36,8 +36,8 @@ class ResConfigSettings(models.TransientModel):
         'Twilio Account Auth Token',
         config_parameter='mail.twilio_account_token',
     )
-    primary_color = fields.Char(related='company_id.primary_color', string="Header Color", readonly=False)
-    secondary_color = fields.Char(related='company_id.secondary_color', string="Button Color", readonly=False)
+    email_primary_color = fields.Char(related='company_id.email_primary_color', readonly=False)
+    email_secondary_color = fields.Char(related='company_id.email_secondary_color', readonly=False)
 
     tenor_api_key = fields.Char(
         'Tenor API key',
diff --git a/addons/mail/tests/__init__.py b/addons/mail/tests/__init__.py
index 1f40f135c9c..47b456a3f75 100644
--- a/addons/mail/tests/__init__.py
+++ b/addons/mail/tests/__init__.py
@@ -7,6 +7,7 @@ from . import test_mail_full_composer
 from . import test_mail_render
 from . import test_mail_template
 from . import test_mail_tools
+from . import test_res_company
 from . import test_res_partner
 from . import test_res_users
 from . import test_res_users_settings
diff --git a/addons/mail/tests/test_res_company.py b/addons/mail/tests/test_res_company.py
new file mode 100644
index 00000000000..beac0b97858
--- /dev/null
+++ b/addons/mail/tests/test_res_company.py
@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo.addons.mail.tests.common import MailCommon
+from odoo.tests.common import tagged, users
+
+
+@tagged('res_company')
+class TestCompany(MailCommon):
+
+    @users('admin')
+    def test_company_colors(self):
+        """ Test primary and secondary color management, especially the choice
+        between document colors and email-specific colors. When setting document
+        layout colors, email colors are updated. When updating email colors
+        layout is not updated, they are less important. """
+        # propagate at create
+        new_company = self.env['res.company'].create({
+            'name': 'Test Colors',
+            'primary_color': '#AAAAAA',
+            'secondary_color': '#BBBBBB',
+        })
+        self.assertEqual(new_company.primary_color, '#AAAAAA')
+        self.assertEqual(new_company.secondary_color, '#BBBBBB')
+        self.assertEqual(new_company.email_primary_color, '#AAAAAA',
+                         'Updating document colors changes email colors')
+        self.assertEqual(new_company.email_secondary_color, '#BBBBBB',
+                         'Updating document colors changes email colors')
+
+        # email can be changed independently
+        new_company.write({
+            'email_primary_color': '#CCCCCC',
+            'email_secondary_color': '#DDDDDD',
+        })
+        self.assertEqual(new_company.primary_color, '#AAAAAA',
+                         'Updating email colors does not change global layout')
+        self.assertEqual(new_company.secondary_color, '#BBBBBB',
+                         'Updating email colors does not change global layout')
+        self.assertEqual(new_company.email_primary_color, '#CCCCCC')
+        self.assertEqual(new_company.email_secondary_color, '#DDDDDD')
+
+        # reset document -> reset email
+        new_company.write({
+            'primary_color': '#EEEEEE',
+            'secondary_color': '#FFFFFF',
+        })
+        self.assertEqual(new_company.primary_color, '#EEEEEE')
+        self.assertEqual(new_company.secondary_color, '#FFFFFF')
+        self.assertEqual(new_company.email_primary_color, '#EEEEEE',
+                         'Updating document colors changes email colors')
+        self.assertEqual(new_company.email_secondary_color, '#FFFFFF',
+                         'Updating document colors changes email colors')
diff --git a/addons/mail/views/res_config_settings_views.xml b/addons/mail/views/res_config_settings_views.xml
index a6d86032d74..f732ed13f8f 100644
--- a/addons/mail/views/res_config_settings_views.xml
+++ b/addons/mail/views/res_config_settings_views.xml
@@ -92,11 +92,11 @@
                     <setting string="Email Templates" help="Customize the look and feel of automated emails" id="mail_templates_setting" groups="mail.group_mail_template_editor,base.group_system">
                         <div class="w-50 row">
                             <span class="d-block w-75 py-2">Header Color</span>
-                            <field name="primary_color" class="d-block w-25 p-0 m-0" widget="color"/>
+                            <field name="email_primary_color" class="d-block w-25 p-0 m-0" widget="color"/>
                         </div>
                         <div class="w-50 row mt-1">
                             <span class="d-block w-75 py-2">Button Color</span>
-                            <field name="secondary_color" class="d-block w-25 p-0 m-0" widget="color"/>
+                            <field name="email_secondary_color" class="d-block w-25 p-0 m-0" widget="color"/>
                         </div>
                         <button name="open_email_layout" icon="oi-arrow-right"
                             type="object" string="Update Mail Layout"
diff --git a/addons/mass_mailing/data/mailing_data_templates.xml b/addons/mass_mailing/data/mailing_data_templates.xml
index e3c9b53da3f..14dc81da528 100644
--- a/addons/mass_mailing/data/mailing_data_templates.xml
+++ b/addons/mass_mailing/data/mailing_data_templates.xml
@@ -162,7 +162,7 @@
             <tr>
                 <td style="margin: 0; padding:0;">
                     <table cellspacing="0" cellpadding="0" border="0" align="center" style="width:100%; border-collapse: collapse;">
-                        <tr t-att-style="'color: ' + (company.secondary_color or  '#875a7b') + '; font-size: 16px; font-weight: 500;'">
+                        <tr t-att-style="'color: ' + (company.email_secondary_color or '#875a7b') + '; font-size: 16px; font-weight: 500;'">
                             <td style="width: 70%;padding: 10px 0; text-align: center; border: 1px solid #e7e7e7;">Button Label</td>
                             <td style="width: 30%;padding: 10px 0; text-align: center; border: 1px solid #e7e7e7;">%Click (Total)</td>
                         </tr>