From f62baec5922cda6e2119759461ba76622b087fe9 Mon Sep 17 00:00:00 2001
From: Dan Scott <dan@coffeecode.net>
Date: Wed, 3 Jul 2019 11:19:42 -0700
Subject: [PATCH] LP1517298: Basic Matomo Analytics support for tt2 files

Signed-off-by: Dan Scott <dan@coffeecode.net>
Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
Signed-off-by: Rogan Hamby <rogan.hamby@gmail.com>
Signed-off-by: Jason Boyer <JBoyer@equinoxinitiative.org>
---
 Open-ILS/src/templates/opac/parts/base.tt2             |  1 +
 Open-ILS/src/templates/opac/parts/matomo_analytics.tt2 | 18 ++++++++++++++++++
 .../pages/designing_your_catalog.adoc                  | 13 +++++++++++++
 docs/modules/opac/pages/new_skin_customizations.adoc   |  2 +-
 4 files changed, 33 insertions(+), 1 deletion(-)
 create mode 100644 Open-ILS/src/templates/opac/parts/matomo_analytics.tt2

diff --git a/Open-ILS/src/templates/opac/parts/base.tt2 b/Open-ILS/src/templates/opac/parts/base.tt2
index b6c2876a8a..69210a5fc2 100644
--- a/Open-ILS/src/templates/opac/parts/base.tt2
+++ b/Open-ILS/src/templates/opac/parts/base.tt2
@@ -44,6 +44,7 @@
 
         [% IF !ctx.is_staff %]
             [% INCLUDE 'opac/parts/goog_analytics.tt2' %]
+            [% INCLUDE 'opac/parts/matomo_analytics.tt2' %]
         [% END %]
         [% PROCESS 'opac/parts/stripe.tt2' %]
     </head>
diff --git a/Open-ILS/src/templates/opac/parts/matomo_analytics.tt2 b/Open-ILS/src/templates/opac/parts/matomo_analytics.tt2
new file mode 100644
index 0000000000..5f2ffd84d1
--- /dev/null
+++ b/Open-ILS/src/templates/opac/parts/matomo_analytics.tt2
@@ -0,0 +1,18 @@
+[%- PROCESS "opac/parts/header.tt2";
+    IF matomo_analytics.enabled == 'true' -%]
+<!-- Matomo -->
+<script type="text/javascript">
+  var _paq = window._paq || [];
+  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+  _paq.push(['trackPageView']);
+  _paq.push(['enableLinkTracking']);
+  (function() {
+    var u="[% matomo_analytics.url %]";
+    _paq.push(['setTrackerUrl', u+'matomo.php']);
+    _paq.push(['setSiteId', '[% matomo_analytics.site %]']);
+    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+    g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+  })();
+</script>
+<!-- End Matomo Code -->
+[%- END -%]
diff --git a/docs/modules/admin_initial_setup/pages/designing_your_catalog.adoc b/docs/modules/admin_initial_setup/pages/designing_your_catalog.adoc
index 43b8ffc53c..128f6afd6d 100644
--- a/docs/modules/admin_initial_setup/pages/designing_your_catalog.adoc
+++ b/docs/modules/admin_initial_setup/pages/designing_your_catalog.adoc
@@ -541,6 +541,19 @@ will need to edit _config.tt2_ in your template. To enable the service set
 the value of google_analytics.enabled to true and change the value of 
 _google_analytics.code_ to be the code in your Google Analytics account.
 
+=== Matomo Analytics ===
+
+Matomo Analytics (https://matomo.org/) is free software that you can host
+yourself, so that you can collect web site statistics without sharing your
+users' data with third parties.  Statistic tracking is disabled by default
+through the Evergreen client software when library staff use your site within
+the client, but active when anyone uses the site without the client.  This was
+a preventive measure to reduce the potential risks for leaking patron
+information. To use Matomo Analytics you need to:
+
+. Set up a hosted instance of Matomo
+. Add your Evergreen catalogue as a site
+
 === NoveList ===
 
 Novelist is a subscription-based service providing reviews and recommendation
diff --git a/docs/modules/opac/pages/new_skin_customizations.adoc b/docs/modules/opac/pages/new_skin_customizations.adoc
index 2e7872966e..47ebef0817 100644
--- a/docs/modules/opac/pages/new_skin_customizations.adoc
+++ b/docs/modules/opac/pages/new_skin_customizations.adoc
@@ -47,7 +47,7 @@ NOTE: All paths are relative to `/openils/var/templates/opac`
   ** hiding the *Place Hold* button for available items
   ** enabling RefWorks support for citation management
   ** adding OpenURL resolution for electronic resources
-  ** enabling Google Analytics tracking for your TPAC
+  ** enabling Google Analytics or Matomo Analytics tracking for your TPAC
   ** displaying the "Forgot your password?" prompt
   ** controlling the size of cover art on the record details page
   ** defining which facets to display, and in which order
-- 
2.11.0