Add disable_cookies config settings to disable use of cookies (#30)

The new `disable_cookies` setting allows to disable cookies to better comply with the GDPR.

For now, the default value will be `false` to stay BC. Make sure to configure this value explicitly if it really is what you want – the default will be changed in the next major version.

Thanks @FabianSchmick.

Author: FabianSchmick

DependencyInjection/Configuration.php

@@ -23,6 +23,7 @@ public function getConfigTreeBuilder()
             ->scalarNode('piwik_host')->isRequired()->end()
             ->scalarNode('tracker_path')->defaultValue('/js/')->end()
             ->scalarNode('site_id')->isRequired()->end()
+            ->scalarNode('disable_cookies')->defaultValue(null)->end()
             ->end();
 
         return $treeBuilder;

DependencyInjection/WebfactoryPiwikExtension.php

@@ -18,7 +18,16 @@ public function load(array $configs, ContainerBuilder $container)
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
-        foreach (['disabled', 'piwik_host', 'tracker_path', 'site_id'] as $configParameterKey) {
+        if (null === $config['disable_cookies']) {
+            $config['disable_cookies'] = false;
+            @trigger_error(
+                'The "disableCookies" configuration key is missing. In the next major version, it will default to "true". 
+                Please configure the "disableCookies" key explicitly if this is not what you want.',
+                E_USER_DEPRECATED
+            );
+        }
+
+        foreach (['disabled', 'piwik_host', 'tracker_path', 'site_id', 'disable_cookies'] as $configParameterKey) {
             $container->setParameter("webfactory_piwik.$configParameterKey", $config[$configParameterKey]);
         }
     }

README.md

@@ -46,12 +46,17 @@ You can configure the bundle in your `config.yml`. Full Example:
 webfactory_piwik:
     # Required, no default. Must be set to the site id found in the Matomo control panel
     site_id: 1
-    # Required, has default. Usually, you only want to include the tracking code in a production environment
-    disabled: '%kernel.debug%'
     # Required. no default. Hostname and path to the Matomo host.
     piwik_host: my.piwik.hostname
-    # Required, has default. Path to the tracking script on the host.
+    # Optional, has default. Usually, you only want to include the tracking code in a production environment
+    disabled: '%kernel.debug%'
+    # Optional, has default. Path to the tracking script on the host.
     tracker_path: "/js/"
+    # Optional, has default. Disable cookies in favor of GDPR
+    # https://matomo.org/faq/new-to-piwik/how-do-i-use-matomo-analytics-without-consent-or-cookie-banner/ & https://matomo.org/faq/general/faq_157/
+    # 
+    # In the next major release the default will be true!
+    disable_cookies: false
 ```
 
 Add calls to the JavaScript tracker API

Resources/config/services.xml

@@ -9,6 +9,7 @@
             <argument>%webfactory_piwik.site_id%</argument>
             <argument>%webfactory_piwik.piwik_host%</argument>
             <argument>%webfactory_piwik.tracker_path%</argument>
+            <argument>%webfactory_piwik.disable_cookies%</argument>
             <tag name="twig.extension" />
         </service>
 

Tests/Twig/ExtensionTest.php

@@ -61,6 +61,12 @@ public function testTrackPageViewEnabledByDefault()
         $this->assertContains('"trackPageView"', $extension->piwikCode());
     }
 
+    public function testCookiesCanBeDisabled()
+    {
+        $extension = new Extension(false, 1, 'my.host', false, true);
+        $this->assertContains('"disableCookies"', $extension->piwikCode());
+    }
+
     public function testTrackSiteSearchDisablesPageTracking()
     {
         $extension = new Extension(false, 1, 'my.host', false);

Twig/Extension.php

@@ -27,17 +27,23 @@ class Extension extends AbstractExtension
      */
     private $trackerPath;
 
+    /**
+     * @var bool
+     */
+    private $disableCookies;
+
     /**
      * @var array
      */
     private $paqs = [];
 
-    public function __construct(bool $disabled, string $siteId, string $piwikHost, string $trackerPath)
+    public function __construct(bool $disabled, string $siteId, string $piwikHost, string $trackerPath, bool $disableCookies = false)
     {
         $this->disabled = $disabled;
         $this->siteId = $siteId;
         $this->piwikHost = rtrim($piwikHost, '/');
         $this->trackerPath = ltrim($trackerPath, '/');
+        $this->disableCookies = $disableCookies;
     }
 
     public function getFunctions()
@@ -59,6 +65,14 @@ public function piwikCode()
             return '<!-- Piwik is disabled due to webfactory_piwik.disabled=true in your configuration -->';
         }
 
+        /*
+         * https://matomo.org/faq/general/faq_157/
+         * Call disableCookies before calling trackPageView
+         */
+        if (true === $this->disableCookies) {
+            $this->paqs[] = ['disableCookies'];
+        }
+
         $this->addDefaultApiCalls();
 
         $paq = json_encode($this->paqs);