Feat / Adds user tracking via Matomo (#1608)

Author: Alihassanc5

Diff for: docker-compose.yml

@@ -32,7 +32,7 @@ services:
       PUSH_NOTIFICATION: 'enable'
       JQUERY: 'enable'
       MATOMO_TRACKING: 'enable'
-      MATOMO_URL: ''
+      MATOMO_SERVER_URL: ''
       MATOMO_SITE_ID: ''
       IMAGE_SIZE_PRESET: ''
     command: python manage.py runserver 0.0.0.0:8000

Diff for: home/processors.py

@@ -19,9 +19,3 @@ def jquery(request):
     return {
         'jquery': settings.JQUERY,
     }
-
-
-def matomo_tracking(request):
-    return {
-        'matomo_tracking': settings.MATOMO_TRACKING,
-    }

Diff for: iogt/settings/base.py

@@ -143,7 +143,6 @@
                 'django.template.context_processors.i18n',
                 'home.processors.commit_hash',
                 'home.processors.show_footers',
-                'home.processors.matomo_tracking',
                 'messaging.processors.add_vapid_public_key',
                 'notifications.processors.push_notification',
                 'home.processors.jquery',
@@ -560,7 +559,7 @@
 
 # Matomo tracking server and site information
 
-MATOMO_URL = os.getenv('MATOMO_URL', '')
+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'
 

Diff for: iogt/templates/base.html

@@ -44,7 +44,7 @@
     {% block extra_css %}
         {# Override this in templates to add extra stylesheets #}
     {% endblock %}
-    {% if matomo_tracking %} {% tracking_code %} {% endif %}
+    {% matomo_tracking_tags %}
 </head>
 
 {% get_current_language_bidi as LANGUAGE_BIDI %}

Diff for: matomo/__init__.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class MatomoConfig(AppConfig):
+    name = 'matomo'

Diff for: matomo/apps.py

@@ -0,0 +1,20 @@
+<!-- Matomo -->
+{% if tracking_enabled %}
+    <script type="text/javascript">
+      var _paq = window._paq = window._paq || [];
+      /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+      _paq.push(['trackPageView']);
+      _paq.push(['enableLinkTracking']);
+      (function() {
+        var u="{{ matomo_server_url }}";
+        _paq.push(['setTrackerUrl', u+'matomo.php']);
+        _paq.push(['setSiteId', '{{ matomo_site_id }}']);
+        var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+        g.type='text/javascript'; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+      })();
+    </script>
+    <noscript>
+      <img src="{{ matomo_server_url }}matomo.php?idsite={{ matomo_site_id }}&rec=1" style="border:0" alt="" />
+    </noscript>
+{% endif %}
+<!-- End Matomo Code -->

Diff for: matomo/templates/matomo_tracking_tags.html

@@ -0,0 +1,19 @@
+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):
+    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
+    })
+    return context

Diff for: matomo/templatetags/matomo_tags.py

@@ -30,5 +30,4 @@ django-google-analytics-app==5.0.5
 django-filter==2.4.0
 drf-yasg~=1.21.3
 django-webpush==0.3.4
-django-matomo==0.1.6
 git+https://github.com/IDEMSInternational/wagtail-transfer.git@enh/show-error-for-unimported-referenced-pages#egg=wagtail-transfer