[IMP] website_cookiefirst: Replace deprecated Cookiefirst functionality

- replace banner.js with new consent.js script using domain and identifier

Author: NICO-SOLUTIONS

website_cookiefirst/README.rst

@@ -44,9 +44,12 @@ To configure this module, you need to:
 
 1. Go to **Website > Configuration > Settings**
 2. Search 'Cookiefirst' option.
-3. Fill in your 'Cookiefirst ID' (e.g.
-   '00000000-0000-0000-0000-000000000000').
-4. Click on "Save" button.
+3. Enable Use Cookiefirst checkbox
+4. Enter your Cookiefirst **API Key** into **Cookiefirst ID** field
+   (e.g. '00000000-0000-0000-0000-000000000000').
+5. Enter your website domain in the **Domain** field (e.g.,
+   mydomain.com).
+6. Click on "Save" button.
 
 ⚠️ **Please note: if another cookie consent solution is installed (e.g.
 Cookiebot), the execution of the Cookiefirst script will be prevented.

website_cookiefirst/models/res_config_settings.py

@@ -15,13 +15,23 @@ def _compute_cookiefirst_enabled(self):
     def _inverse_cookiefirst_enabled(self):
         for record in self:
             if not record.cookiefirst_enabled:
-                record.website_id.update({"cookiefirst_identifier": False})
+                record.website_id.update(
+                    {
+                        "cookiefirst_identifier": False,
+                        "cookiefirst_domain": False,
+                    }
+                )
 
     cookiefirst_identifier = fields.Char(
         string="Cookiefirst ID",
         related="website_id.cookiefirst_identifier",
         readonly=False,
     )
+    cookiefirst_domain = fields.Char(
+        string="Domain",
+        related="website_id.cookiefirst_domain",
+        readonly=False,
+    )
     cookiefirst_enabled = fields.Boolean(
         string="Use Cookiefirst",
         compute="_compute_cookiefirst_enabled",

website_cookiefirst/models/website.py

@@ -11,3 +11,7 @@ class Website(models.Model):
         string="Cookiefirst ID",
         help="This field holds the ID, needed for Cookiefirst functionality.",
     )
+    cookiefirst_domain = fields.Char(
+        string="Domain",
+        help="Domain used for Cookiefirst consent.js URL.",
+    )

website_cookiefirst/readme/CONFIGURE.md

@@ -2,9 +2,11 @@ To configure this module, you need to:
 
 1.  Go to **Website \> Configuration \> Settings**
 2.  Search 'Cookiefirst' option.
-3.  Fill in your 'Cookiefirst ID' (e.g.
+3.  Enable Use Cookiefirst checkbox
+4.  Enter your Cookiefirst **API Key** into **Cookiefirst ID** field (e.g.
     '00000000-0000-0000-0000-000000000000').
-4.  Click on "Save" button.
+5.  Enter your website domain in the **Domain** field (e.g., mydomain.com).
+6.  Click on "Save" button.
 
 ⚠️ **Please note: if another cookie consent solution is
 installed (e.g. Cookiebot), the execution of the Cookiefirst

website_cookiefirst/static/description/index.html

@@ -392,8 +392,11 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <ol class="arabic simple">
 <li>Go to <strong>Website &gt; Configuration &gt; Settings</strong></li>
 <li>Search ‘Cookiefirst’ option.</li>
-<li>Fill in your ‘Cookiefirst ID’ (e.g.
-‘00000000-0000-0000-0000-000000000000’).</li>
+<li>Enable Use Cookiefirst checkbox</li>
+<li>Enter your Cookiefirst <strong>API Key</strong> into <strong>Cookiefirst ID</strong> field
+(e.g. ‘00000000-0000-0000-0000-000000000000’).</li>
+<li>Enter your website domain in the <strong>Domain</strong> field (e.g.,
+mydomain.com).</li>
 <li>Click on “Save” button.</li>
 </ol>
 <p>⚠️ <strong>Please note: if another cookie consent solution is installed (e.g.

website_cookiefirst/tests/test_website.py

@@ -8,8 +8,15 @@ class TestWebsite(TransactionCase):
     def setUp(self):
         super().setUp()
         self.website = self.env["website"].create(
-            {"name": "Test Website", "cookiefirst_identifier": "1234567890"}
+            {
+                "name": "Test Website",
+                "cookiefirst_identifier": "1234567890",
+                "cookiefirst_domain": "example.com",
+            }
         )
 
     def test_cookiefirst_identifier(self):
         self.assertEqual(self.website.cookiefirst_identifier, "1234567890")
+
+    def test_cookiefirst_domain(self):
+        self.assertEqual(self.website.cookiefirst_domain, "example.com")

website_cookiefirst/views/res_config_settings_views.xml

@@ -11,16 +11,30 @@
                <setting id="website_cookiefirst" help="Add Cookiefirst functionality">
                    <field name="cookiefirst_enabled" />
                    <div class="mt16" invisible="not cookiefirst_enabled">
-                       <label
-                            class="col-md-3 o_light_label"
-                            string="Tracking ID"
-                            for="cookiefirst_identifier"
-                        />
-                       <field
-                            name="cookiefirst_identifier"
-                            required="cookiefirst_enabled"
-                            placeholder="00000000-0000-0000-0000-000000000000"
-                        />
+                       <div class="row">
+                           <label
+                                class="col-md-3 o_light_label"
+                                string="Tracking ID"
+                                for="cookiefirst_identifier"
+                            />
+                           <field
+                                name="cookiefirst_identifier"
+                                required="cookiefirst_enabled"
+                                placeholder="00000000-0000-0000-0000-000000000000"
+                            />
+                       </div>
+                       <div class="row">
+                           <label
+                                class="col-md-3 o_light_label"
+                                string="Domain"
+                                for="cookiefirst_domain"
+                            />
+                           <field
+                                name="cookiefirst_domain"
+                                required="cookiefirst_enabled"
+                                placeholder="domain.com"
+                            />
+                       </div>
                    </div>
                </setting>
            </xpath>

website_cookiefirst/views/website_template.xml

@@ -17,12 +17,17 @@
             <attribute name="data-cookiefirst-category">performance</attribute>
         </xpath>
         <xpath expr="//script[last()]" position="after">
-            <t t-if="website.cookiefirst_identifier">
+            <t t-if="website.cookiefirst_domain and website.cookiefirst_identifier">
                 <script
-                    src="https://consent.cookiefirst.com/banner.js"
-                    t-att-data-cookiefirst-key="website.cookiefirst_identifier"
+                    t-att-src="(
+                        'https://consent.cookiefirst.com/sites/' +
+                        website.cookiefirst_domain + '-' +
+                        website.cookiefirst_identifier +
+                        '/consent.js'
+                    )"
                 />
             </t>
         </xpath>
     </template>
+
 </odoo>