add: prevent admin users from tracking their own views :-)

Author: renickbuettner

README.md

@@ -1,25 +1,27 @@
 # Renick.Matomo
 
-Just a simple OctoberCMS plugin for embedding matomo analytics. These features are provided by the initial release of 
+Just a simple OctoberCMS plugin for embedding matomo analytics. These features are provided by the initial release of
 this plugin:
 
 - [x] store matomo api key as well as page id
 - [x] middleware for matomo server-side tracking
 - [x] component for matomo javascript integration
 - [x] component for matomo tag manager javascript integration
+- [x] components hide the matomo script when an admin user is logged in
 - [x] integration of analytic reports within the OctoberCMS backend
 
 To install this plugin, you can just run the following command:
 ```bash
 php artisan plugin:install Renick.Matomo [email protected]:renickbuettner/matomo-plugin.git
 ```
 
-Feel free to ask, raise ideas, mind bugs or contribute on the Github repository. Please create a new issue or pull 
+Feel free to ask, raise ideas, mind bugs or contribute on the Github repository. Please create a new issue or pull
 request.
 
 ---
 
-Future ideas: 
+Future ideas:
 
-- [ ] measure impact of accessing plugins config from database on site performance - may add support for in-memory cache? 
+- [ ] measure impact of accessing plugins config from database on site performance - may add support for in-memory cache?
 - [ ] add more report widgets (api is prepared...)
+- [ ] what use-cases do we may need?

components/MTagJs.php

@@ -31,4 +31,8 @@ public function containerId(): string
     {
         return $this->settings->container_id ?? "";
     }
-}
+
+    public function isLoggedInAdmin(): bool {
+        return $this->settings->isLoggedInAdmin();
+    }
+}

components/MatomoJs.php

@@ -36,4 +36,8 @@ public function useCookies(): bool
     {
         return $this->settings->use_cookies ?? false;
     }
-}
+
+    public function isLoggedInAdmin(): bool {
+        return $this->settings->isLoggedInAdmin();
+    }
+}

components/matomojs/default.htm

@@ -1,18 +1,20 @@
-{% if __SELF__.remoteUrl and __SELF__.siteId %}
-<script>
-    var _paq = window._paq = window._paq || [];
-    {% if not __SELF__.useCookies() %}
-    _paq.push(['disableCookies']);
-    {% endif %}
-    _paq.push(['trackPageView']);
-    _paq.push(['enableLinkTracking']);
-    (function() {
-        var u="{{ __SELF__.remoteUrl }}";
-        _paq.push(['setTrackerUrl', u+'matomo.php']);
-        _paq.push(['setSiteId', '{{ __SELF__.siteId }}']);
-        var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
-        g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
-    })();
-</script>
-<noscript><p><img src="{{ __SELF__.remoteUrl }}matomo.php?idsite={{ __SELF__.siteId }}&amp;rec=1" style="border:0;" alt="" /></p></noscript>
+{% if __SELF__.isLoggedInAdmin() %}
+    <script>const _paq = 'disabled for admin user';</script>
+{% else %}
+    <script>
+        var _paq = window._paq = window._paq || [];
+        {% if not __SELF__.useCookies() %}
+        _paq.push(['disableCookies']);
+        {% endif %}
+        _paq.push(['trackPageView']);
+        _paq.push(['enableLinkTracking']);
+        (function() {
+            var u="{{ __SELF__.remoteUrl }}";
+            _paq.push(['setTrackerUrl', u+'matomo.php']);
+            _paq.push(['setSiteId', '{{ __SELF__.siteId }}']);
+            var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+            g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+        })();
+    </script>
+    <noscript><p><img src="{{ __SELF__.remoteUrl }}matomo.php?idsite={{ __SELF__.siteId }}&amp;rec=1" style="border:0;" alt="" /></p></noscript>
 {% endif %}

components/mtagjs/default.htm

@@ -1,6 +1,10 @@
+{% if __SELF__.isLoggedInAdmin() %}
+<script>const _mtm = 'disabled for admin user';</script>
+{% else %}
 <script>
     var _mtm = window._mtm = window._mtm || [];
     _mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
     var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
     g.async=true; g.src='{{ __SELF__.remoteUrl }}js/container_{{ __SELF__.containerId }}.js'; s.parentNode.insertBefore(g,s);
-</script>
+</script>
+{% endif %}

models/Settings.php

@@ -98,4 +98,18 @@ public function getValidAttribute(): bool
 
         return true;
     }
-}
+
+    /**
+     * We want to detect, if an admin user is logged
+     * @return bool
+     */
+    public function isLoggedInAdmin(): bool {
+        try {
+            $user = \Backend\Facades\BackendAuth::getUser();
+            return $user !== null;
+
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+}