Fixes #21: Add noscript fallback functionality and setting (#22)

Author: indigoxela

config/matomo.settings.json

@@ -22,6 +22,7 @@
     "cache": 0,
     "last_cache": 0,
     "translation_set": 0,
+    "noscript": 0,
     "codesnippet_before": "",
     "codesnippet_after": "",
     "js_scope": "header",

matomo.admin.inc

@@ -389,6 +389,13 @@ function matomo_admin_settings_form($form_state) {
     );
   }
 
+  $form['advanced']['noscript'] = array(
+    '#type' => 'checkbox',
+    '#title' => t('Also track when JavaScript is disabled'),
+    '#description' => t('If checked, a <em>noscript</em> fallback will be added to the page, to also track when JavaScript is disabled in a browser.'),
+    '#default_value' => $config->get('noscript'),
+  );
+
   // Code snippet settings.
   $user_access_add_js_snippets = !user_access('add js snippets for matomo');
   $user_access_add_js_snippets_permission_warning = $user_access_add_js_snippets ? ' <em>' . t('This field has been disabled because you do not have sufficient permissions to edit it.') . '</em>' : '';

matomo.install

@@ -98,3 +98,15 @@ function matomo_update_1000() {
 
   $config->save();
 }
+
+/**
+ * Add the noscript setting.
+ */
+function matomo_update_1001() {
+  $config = config('matomo.settings');
+  $noscript = $config->get('noscript');
+  if (!isset($noscript)) {
+    $config->set('noscript', 0);
+    $config->save();
+  }
+}

matomo.module

@@ -87,10 +87,13 @@ function matomo_config_info() {
 }
 
 /**
- * Implements hook_page_alter() to insert JavaScript to the appropriate scope/region of the page.
+ * Implements hook_preprocess_page().
+ *
+ * Insert JavaScript to the appropriate scope/region of the page, insert the
+ * noscript fallback to page_bottom if enabled.
  */
-function matomo_preprocess_layout(&$variables) {
-  global $user;
+function matomo_preprocess_page(&$variables) {
+  global $user, $is_https;
   $config = config('matomo.settings');
 
   $id = $config->get('site_id');
@@ -361,6 +364,14 @@ function matomo_preprocess_layout(&$variables) {
 
     // Add tracker code to scope.
     backdrop_add_js($script, array('scope' => $scope, 'type' => 'inline'));
+
+    // Add the noscript fallback markup to the page_bottom string.
+    if ($config->get('noscript')) {
+      $src_url = ($is_https && !empty($url_https)) ? check_url($url_https) : check_url($url_http);
+      $src_url = rtrim($src_url, '/') . "/matomo.php?idsite=$id&rec=1";
+      $img = '<img src="' . $src_url . '" style="border:0" alt="" />';
+      $variables['page_bottom'] .= "<!-- Matomo --><noscript><p>$img</p></noscript><!-- End Matomo -->";
+    }
   }
 }
 

tests/matomo.test

@@ -208,6 +208,37 @@ class MatomoBasicTest extends BackdropWebTestCase {
     $this->assertRaw('t2.trackPageView', '[testMatomoTrackingCode]: After codesnippet with "t2" tracker has been found.');
   }
 
+  /**
+   * Test the noscript fallback tracking code.
+   */
+  public function testMatomoNojsFallback() {
+    $config = config('matomo.settings');
+    $config->set('site_id', '5');
+    $config->set('noscript', FALSE);
+    $config->set('url_http', 'https://example.com/');
+    $config->set('url_https', 'https://example.com/');
+    $config->save();
+    $fallback_code = '<!-- Matomo --><noscript><p><img src="https://example.com/matomo.php?idsite=5&amp;rec=1" style="border:0" alt="" /></p></noscript><!-- End Matomo -->';
+
+    $this->backdropGet('<front>');
+    $this->assertNoRaw($fallback_code, '[testMatomoTrackingCode]: Fallback code not added when disabled.');
+
+    $config->set('noscript', TRUE);
+    $config->save();
+    cache('page')->flush();
+    $this->backdropGet('<front>');
+    $this->assertRaw($fallback_code, '[testMatomoTrackingCode]: Fallback code present when enabled.');
+
+    // Now only track anonymous.
+    $config->set('roles', array(BACKDROP_ANONYMOUS_ROLE => BACKDROP_ANONYMOUS_ROLE));
+    $config->save();
+    $this->backdropGet('<front>');
+    $this->assertNoRaw($fallback_code, '[testMatomoTrackingCode]: Fallback code not added when role not tracked.');
+
+    $this->backdropLogout();
+    $this->backdropGet('<front>');
+    $this->assertRaw($fallback_code, '[testMatomoTrackingCode]: Fallback code present when role is tracked.');
+  }
 }
 
 /**