From d5443c214511e3c6d7b911bf9b7f370a242e54d9 Mon Sep 17 00:00:00 2001
From: Ian Stride <ianstride@gmail.com>
Date: Thu, 12 Oct 2023 17:40:46 +0100
Subject: [PATCH 1/6] Create session-based user tracking ID

When JavaScript is disabled in the browser, we use the Matomo Image Tracker to
gather analytics data. In this case, first party cookies are also disabled and
Matomo is not able to differentiate between different visitors very well. The
tracking ID is intended to provide the same function as the visitor ID that is
usually provided by Matomo when JS is enabled.
---
 matomo/templates/matomo_tracking_tags.html |  8 ++---
 matomo/templatetags/matomo_tags.py         | 38 +++++++++++++++++-----
 2 files changed, 33 insertions(+), 13 deletions(-)

diff --git a/matomo/templates/matomo_tracking_tags.html b/matomo/templates/matomo_tracking_tags.html
index bd8519eae..ec904538e 100644
--- a/matomo/templates/matomo_tracking_tags.html
+++ b/matomo/templates/matomo_tracking_tags.html
@@ -17,10 +17,10 @@
       })();
     </script>
     <noscript>
-      <img src="{{ matomo_server_url }}matomo.php?idsite={{ matomo_site_id }}&rec=1" style="border:0" alt="" />
-      {% if matomo_additional_site_id %}
-      <img src="{{ matomo_server_url }}matomo.php?idsite={{ matomo_additional_site_id }}&rec=1" style="border:0" alt="" />
-      {% endif %}
+        <img src="{{ matomo_image_tracker_url }}" style="border:0" alt="" />
+        {% if matomo_additional_image_tracker_url %}
+        <img src="{{ matomo_additional_image_tracker_url }}" style="border:0" alt="" />
+        {% endif %}
     </noscript>
 {% endif %}
 <!-- End Matomo Code -->
diff --git a/matomo/templatetags/matomo_tags.py b/matomo/templatetags/matomo_tags.py
index 60157d6d3..3e4e0817c 100644
--- a/matomo/templatetags/matomo_tags.py
+++ b/matomo/templatetags/matomo_tags.py
@@ -1,26 +1,46 @@
+from uuid import uuid4
+
 from django import template
 from django.conf import settings
 
-
 register = template.Library()
 
 
 @register.inclusion_tag("matomo_tracking_tags.html", takes_context=True)
 def matomo_tracking_tags(context):
+    server_url = settings.MATOMO_SERVER_URL
+    site_id = settings.MATOMO_SITE_ID
+    uid = user_tracking_id(context["request"].session)
+
     context.update(
         {
-            "tracking_enabled": (
-                settings.MATOMO_TRACKING
-                and settings.MATOMO_SERVER_URL
-                and settings.MATOMO_SITE_ID
-            ),
-            "matomo_site_id": settings.MATOMO_SITE_ID,
-            "matomo_server_url": settings.MATOMO_SERVER_URL,
+            "tracking_enabled": (settings.MATOMO_TRACKING and server_url and site_id),
+            "matomo_site_id": site_id,
+            "matomo_server_url": server_url,
+            "matomo_image_tracker_url": image_tracker(server_url, site_id, uid),
         }
     )
 
     additional_site_id = settings.MATOMO_ADDITIONAL_SITE_ID
     if type(additional_site_id) is int and additional_site_id > 0:
-        context.update({"matomo_additional_site_id": additional_site_id})
+        context.update(
+            {
+                "matomo_additional_site_id": additional_site_id,
+                "matomo_additional_image_tracker_url": image_tracker(
+                    server_url, additional_site_id, uid
+                ),
+            }
+        )
 
     return context
+
+
+def user_tracking_id(session):
+    if not session.get("tid"):
+        session["tid"] = str(uuid4())
+
+    return session["tid"]
+
+
+def image_tracker(server_url, site_id, uid):
+    return f"{server_url}matomo.php?idsite={site_id}&rec=1&uid={uid}"

From 90a1b39649d901859f1dcdf4aaf4f94386fe4065 Mon Sep 17 00:00:00 2001
From: Ian Stride <ianstride@gmail.com>
Date: Mon, 16 Oct 2023 14:00:55 +0100
Subject: [PATCH 2/6] Fix tests for Matomo tags

---
 matomo/tests/test_matomo_tags.py | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/matomo/tests/test_matomo_tags.py b/matomo/tests/test_matomo_tags.py
index fbf9bd7ec..94cd0810e 100644
--- a/matomo/tests/test_matomo_tags.py
+++ b/matomo/tests/test_matomo_tags.py
@@ -10,26 +10,35 @@
 )
 class MatomoTagsTests(TestCase):
     def test_only_enabled_when_required_settings_are_set(self):
-        self.assertTrue(matomo_tracking_tags(dict()).get("tracking_enabled"))
+        self.assertTrue(matomo_tracking_tags(create_context()).get("tracking_enabled"))
 
     def test_additional_site_id_must_be_positive_integer(self):
         with override_settings(MATOMO_ADDITIONAL_SITE_ID=567):
             self.assertEqual(
-                matomo_tracking_tags(dict()).get("matomo_additional_site_id"),
+                matomo_tracking_tags(create_context()).get("matomo_additional_site_id"),
                 567,
             )
 
         with override_settings(MATOMO_ADDITIONAL_SITE_ID=0):
             self.assertFalse(
-                "matomo_additional_site_id" in matomo_tracking_tags(dict())
+                "matomo_additional_site_id" in matomo_tracking_tags(create_context())
             )
 
         with override_settings(MATOMO_ADDITIONAL_SITE_ID=None):
             self.assertFalse(
-                "matomo_additional_site_id" in matomo_tracking_tags(dict())
+                "matomo_additional_site_id" in matomo_tracking_tags(create_context())
             )
 
-        with override_settings(MATOMO_ADDITIONAL_SITE_ID='123'):
+        with override_settings(MATOMO_ADDITIONAL_SITE_ID="123"):
             self.assertFalse(
-                "matomo_additional_site_id" in matomo_tracking_tags(dict())
+                "matomo_additional_site_id" in matomo_tracking_tags(create_context())
             )
+
+
+class MockRequest:
+    def __init__(self):
+        self.session = dict()
+
+
+def create_context():
+    return {"request": MockRequest()}

From 9d51db5b2301d5707a21a46e86c77f61f71894b8 Mon Sep 17 00:00:00 2001
From: Ian Stride <ianstride@gmail.com>
Date: Mon, 16 Oct 2023 16:31:27 +0100
Subject: [PATCH 3/6] Set user id on Matomo JavaScript tracker

---
 matomo/templates/matomo_tracking_tags.html | 2 +-
 matomo/templatetags/matomo_tags.py         | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/matomo/templates/matomo_tracking_tags.html b/matomo/templates/matomo_tracking_tags.html
index ec904538e..d5f0af1b4 100644
--- a/matomo/templates/matomo_tracking_tags.html
+++ b/matomo/templates/matomo_tracking_tags.html
@@ -2,7 +2,7 @@
 {% if tracking_enabled %}
     <script type="text/javascript">
       var _paq = window._paq = window._paq || [];
-      /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+      _paq.push(['setUserId', '{{ matomo_user_id }}']);
       _paq.push(['trackPageView']);
       _paq.push(['enableLinkTracking']);
       (function() {
diff --git a/matomo/templatetags/matomo_tags.py b/matomo/templatetags/matomo_tags.py
index 3e4e0817c..6572ad730 100644
--- a/matomo/templatetags/matomo_tags.py
+++ b/matomo/templatetags/matomo_tags.py
@@ -18,6 +18,7 @@ def matomo_tracking_tags(context):
             "matomo_site_id": site_id,
             "matomo_server_url": server_url,
             "matomo_image_tracker_url": image_tracker(server_url, site_id, uid),
+            "matomo_user_id": uid,
         }
     )
 

From c0a527a0ae10ca2c7da17ee7592dde4620591d8c Mon Sep 17 00:00:00 2001
From: Ian Stride <ianstride@gmail.com>
Date: Wed, 1 Nov 2023 13:43:59 +0000
Subject: [PATCH 4/6] Generate a visitor ID instead of a user ID

The user ID is supposed to identify a registered user of a site, but we are
actually using it to identify a visitor. This change generates a visitor ID in a
similar way to the Matomo JS client, for the particular case where the visitor
does not have a JS-enabled browser. The user ID feature can then be implemented
later on without coming into conflict with this visitor ID feature.
---
 matomo/templates/matomo_tracking_tags.html |  1 -
 matomo/templatetags/matomo_tags.py         | 36 ++++++++++++++++------
 2 files changed, 26 insertions(+), 11 deletions(-)

diff --git a/matomo/templates/matomo_tracking_tags.html b/matomo/templates/matomo_tracking_tags.html
index d5f0af1b4..941c5a69e 100644
--- a/matomo/templates/matomo_tracking_tags.html
+++ b/matomo/templates/matomo_tracking_tags.html
@@ -2,7 +2,6 @@
 {% if tracking_enabled %}
     <script type="text/javascript">
       var _paq = window._paq = window._paq || [];
-      _paq.push(['setUserId', '{{ matomo_user_id }}']);
       _paq.push(['trackPageView']);
       _paq.push(['enableLinkTracking']);
       (function() {
diff --git a/matomo/templatetags/matomo_tags.py b/matomo/templatetags/matomo_tags.py
index 6572ad730..1713ae5b9 100644
--- a/matomo/templatetags/matomo_tags.py
+++ b/matomo/templatetags/matomo_tags.py
@@ -1,8 +1,12 @@
 from uuid import uuid4
+from hashlib import sha1
+from datetime import datetime
 
 from django import template
 from django.conf import settings
 
+
+VISITOR_ID_KEY = "vid"
 register = template.Library()
 
 
@@ -10,15 +14,14 @@
 def matomo_tracking_tags(context):
     server_url = settings.MATOMO_SERVER_URL
     site_id = settings.MATOMO_SITE_ID
-    uid = user_tracking_id(context["request"].session)
+    vid = visitor_id(context["request"])
 
     context.update(
         {
             "tracking_enabled": (settings.MATOMO_TRACKING and server_url and site_id),
             "matomo_site_id": site_id,
             "matomo_server_url": server_url,
-            "matomo_image_tracker_url": image_tracker(server_url, site_id, uid),
-            "matomo_user_id": uid,
+            "matomo_image_tracker_url": image_tracker(server_url, site_id, vid),
         }
     )
 
@@ -28,7 +31,7 @@ def matomo_tracking_tags(context):
             {
                 "matomo_additional_site_id": additional_site_id,
                 "matomo_additional_image_tracker_url": image_tracker(
-                    server_url, additional_site_id, uid
+                    server_url, additional_site_id, vid
                 ),
             }
         )
@@ -36,12 +39,25 @@ def matomo_tracking_tags(context):
     return context
 
 
-def user_tracking_id(session):
-    if not session.get("tid"):
-        session["tid"] = str(uuid4())
+def visitor_id(request):
+    session = request.session
+
+    if not session.get(VISITOR_ID_KEY):
+        session[VISITOR_ID_KEY] = generate_random_id()
+
+    return session[VISITOR_ID_KEY]
+
 
-    return session["tid"]
+def generate_random_id():
+    return sha1(
+        "".join(
+            [
+                datetime.now().isoformat(),
+                str(uuid4()),
+            ]
+        ).encode("utf-8")
+    ).hexdigest()[0:16]
 
 
-def image_tracker(server_url, site_id, uid):
-    return f"{server_url}matomo.php?idsite={site_id}&rec=1&uid={uid}"
+def image_tracker(server_url, site_id, vid):
+    return f"{server_url}matomo.php?idsite={site_id}&rec=1&_id={vid}"

From a1d314263d06194ed58a0a742815cdf367ab5019 Mon Sep 17 00:00:00 2001
From: Ian Stride <ianstride@gmail.com>
Date: Thu, 9 Nov 2023 15:17:15 +0000
Subject: [PATCH 5/6] Add feature flag for visitor id creation

---
 matomo/templatetags/matomo_tags.py | 66 +++++++++++++++++++++++-------
 matomo/tests/test_matomo_tags.py   | 29 ++++++++-----
 2 files changed, 70 insertions(+), 25 deletions(-)

diff --git a/matomo/templatetags/matomo_tags.py b/matomo/templatetags/matomo_tags.py
index 1713ae5b9..1cae9ac15 100644
--- a/matomo/templatetags/matomo_tags.py
+++ b/matomo/templatetags/matomo_tags.py
@@ -12,33 +12,64 @@
 
 @register.inclusion_tag("matomo_tracking_tags.html", takes_context=True)
 def matomo_tracking_tags(context):
+    enabled = is_enabled()
+
+    if not enabled:
+        return context.update({"tracking_enabled": enabled})
+
     server_url = settings.MATOMO_SERVER_URL
     site_id = settings.MATOMO_SITE_ID
-    vid = visitor_id(context["request"])
+    vid = create_visitor_id(context)
 
     context.update(
         {
-            "tracking_enabled": (settings.MATOMO_TRACKING and server_url and site_id),
+            "tracking_enabled": enabled,
             "matomo_site_id": site_id,
             "matomo_server_url": server_url,
             "matomo_image_tracker_url": image_tracker(server_url, site_id, vid),
         }
     )
-
-    additional_site_id = settings.MATOMO_ADDITIONAL_SITE_ID
-    if type(additional_site_id) is int and additional_site_id > 0:
-        context.update(
-            {
-                "matomo_additional_site_id": additional_site_id,
-                "matomo_additional_image_tracker_url": image_tracker(
-                    server_url, additional_site_id, vid
-                ),
-            }
-        )
+    context.update(additional_site_id(server_url, vid))
 
     return context
 
 
+def is_enabled():
+    try:
+        return (
+            settings.MATOMO_TRACKING
+            and settings.MATOMO_SERVER_URL
+            and settings.MATOMO_SITE_ID
+        )
+    except AttributeError:
+        return False
+
+
+def create_visitor_id(context):
+    try:
+        if settings.MATOMO_CREATE_VISITOR_ID:
+            return visitor_id(context["request"])
+    except AttributeError:
+        return None
+
+
+def additional_site_id(server_url, vid=None):
+    try:
+        site_id = settings.MATOMO_ADDITIONAL_SITE_ID
+    except AttributeError:
+        return {}
+
+    if type(site_id) is int and site_id > 0:
+        return {
+            "matomo_additional_site_id": site_id,
+            "matomo_additional_image_tracker_url": image_tracker(
+                server_url, site_id, vid
+            ),
+        }
+    else:
+        return {}
+
+
 def visitor_id(request):
     session = request.session
 
@@ -59,5 +90,10 @@ def generate_random_id():
     ).hexdigest()[0:16]
 
 
-def image_tracker(server_url, site_id, vid):
-    return f"{server_url}matomo.php?idsite={site_id}&rec=1&_id={vid}"
+def image_tracker(server_url, site_id, vid=None):
+    url = f"{server_url}matomo.php?idsite={site_id}&rec=1"
+
+    if vid:
+        url += f"&_id={vid}"
+
+    return url
diff --git a/matomo/tests/test_matomo_tags.py b/matomo/tests/test_matomo_tags.py
index 94cd0810e..fbbb6879e 100644
--- a/matomo/tests/test_matomo_tags.py
+++ b/matomo/tests/test_matomo_tags.py
@@ -14,24 +14,33 @@ def test_only_enabled_when_required_settings_are_set(self):
 
     def test_additional_site_id_must_be_positive_integer(self):
         with override_settings(MATOMO_ADDITIONAL_SITE_ID=567):
+            context = matomo_tracking_tags(create_context())
+            self.assertEqual(context.get("matomo_additional_site_id"), 567)
             self.assertEqual(
-                matomo_tracking_tags(create_context()).get("matomo_additional_site_id"),
-                567,
+                context.get("matomo_additional_image_tracker_url"),
+                "https://example.com/matomo.php?idsite=567&rec=1",
             )
 
         with override_settings(MATOMO_ADDITIONAL_SITE_ID=0):
-            self.assertFalse(
-                "matomo_additional_site_id" in matomo_tracking_tags(create_context())
-            )
+            context = matomo_tracking_tags(create_context())
+            self.assertFalse("matomo_additional_site_id" in context)
+            self.assertFalse("matomo_additional_image_tracker_url" in context)
 
         with override_settings(MATOMO_ADDITIONAL_SITE_ID=None):
-            self.assertFalse(
-                "matomo_additional_site_id" in matomo_tracking_tags(create_context())
-            )
+            context = matomo_tracking_tags(create_context())
+            self.assertFalse("matomo_additional_site_id" in context)
+            self.assertFalse("matomo_additional_image_tracker_url" in context)
 
         with override_settings(MATOMO_ADDITIONAL_SITE_ID="123"):
-            self.assertFalse(
-                "matomo_additional_site_id" in matomo_tracking_tags(create_context())
+            context = matomo_tracking_tags(create_context())
+            self.assertFalse("matomo_additional_site_id" in context)
+            self.assertFalse("matomo_additional_image_tracker_url" in context)
+
+    def test_visitor_id_is_created_for_clients_without_javascript(self):
+        with override_settings(MATOMO_CREATE_VISITOR_ID=True):
+            self.assertRegexpMatches(
+                matomo_tracking_tags(create_context()).get("matomo_image_tracker_url"),
+                r"_id=[a-f0-9]{16}",
             )
 
 

From 6eedc174cfde75c8d8509fd4a167a626e7f4c024 Mon Sep 17 00:00:00 2001
From: Ian Stride <ianstride@gmail.com>
Date: Thu, 9 Nov 2023 15:28:11 +0000
Subject: [PATCH 6/6] Add setting to base settings file

---
 iogt/settings/base.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/iogt/settings/base.py b/iogt/settings/base.py
index aafb84c93..c36fae01b 100644
--- a/iogt/settings/base.py
+++ b/iogt/settings/base.py
@@ -560,6 +560,7 @@
 # Matomo tracking server and site information
 
 MATOMO_ADDITIONAL_SITE_ID = int(os.getenv('MATOMO_ADDITIONAL_SITE_ID', '0'))
+MATOMO_CREATE_VISITOR_ID = os.getenv('MATOMO_CREATE_VISITOR_ID', 'disable') == 'enable'
 MATOMO_SERVER_URL = os.getenv('MATOMO_SERVER_URL', '')
 MATOMO_SITE_ID = int(os.getenv('MATOMO_SITE_ID', '') or '0')
 MATOMO_TRACKING = os.getenv('MATOMO_TRACKING', 'disable') == 'enable'