Add RespectDoNotTrack to GDPR privacy policy for Google Analytics

See #4616

diff --git a/config/privacy/privacyConfig.go b/config/privacy/privacyConfig.go
index c93137da441b5ce0792ed748e3a72085df200aa6..0241b5704562516a2ed730dd4321b68c47de7275 100644 (file)
--- a/config/privacy/privacyConfig.go
+++ b/config/privacy/privacyConfig.go
@@ -44,6 +44,10 @@ type Disqus struct {
 // GoogleAnalytics holds the privacy configuration settings related to the Google Analytics template.
 type GoogleAnalytics struct {
        Service `mapstructure:",squash"`
+
+       // Enabling this will make the GA templates respect the
+       // "Do Not Track" HTTP header. See  https://www.paulfurley.com/google-analytics-dnt/.
+       RespectDoNotTrack bool
 }
 
 // Instagram holds the privacy configuration settings related to the Instagram shortcode.

diff --git a/config/privacy/privacyConfig_test.go b/config/privacy/privacyConfig_test.go
index 9b0d75e31d5639594bcb072dd18c79af629fd173..f8e2ebbd163fb9ca6f04b742af2a92b4e901fce4 100644 (file)
--- a/config/privacy/privacyConfig_test.go
+++ b/config/privacy/privacyConfig_test.go
@@ -33,6 +33,7 @@ someOtherValue = "foo"
 disable = true
 [privacy.googleAnalytics]
 disable = true
+respectDoNotTrack = true
 [privacy.instagram]
 disable = true
 [privacy.speakerDeck]
@@ -54,6 +55,7 @@ noCookie = true
 
        assert.True(pc.Disqus.Disable)
        assert.True(pc.GoogleAnalytics.Disable)
+       assert.True(pc.GoogleAnalytics.RespectDoNotTrack)
        assert.True(pc.Instagram.Disable)
        assert.True(pc.SpeakerDeck.Disable)
        assert.True(pc.Tweet.Disable)

diff --git a/tpl/tplimpl/embedded/templates.autogen.go b/tpl/tplimpl/embedded/templates.autogen.go
index 8556c32c7f5f5f5c0d9b39ecf47614f3573786d4..71a1fd14fbdc5abe3756db71bf5f592c315d4f3d 100644 (file)
--- a/tpl/tplimpl/embedded/templates.autogen.go
+++ b/tpl/tplimpl/embedded/templates.autogen.go
@@ -103,23 +103,37 @@ var EmbeddedTemplates = [][2]string{
 {{- if not $pc.Disable -}}
 {{ with .Site.GoogleAnalytics }}
 <script>
-(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
-
-ga('create', '{{ . }}', 'auto');
-ga('send', 'pageview');
+{{ template "__ga_js_set_doNotTrack" $ }}
+if (!doNotTrack) {
+       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+       })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+       ga('create', '{{ . }}', 'auto');
+       ga('send', 'pageview');
+}
 </script>
 {{ end }}
+{{- end -}}
+{{- define "__ga_js_set_doNotTrack" -}}{{/* This is also used in the async version. */}}
+{{- $pc := .Site.PrivacyConfig.GoogleAnalytics -}}
+{{- if not $pc.RespectDoNotTrack -}}
+var doNotTrack = false;
+{{- else -}}
+var dnt = (navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack);
+var doNotTrack = (dnt == "1" || dnt == "yes");
+{{- end -}}
 {{- end -}}`},
        {`google_analytics_async.html`, `{{- $pc := .Site.PrivacyConfig.GoogleAnalytics -}}
 {{- if not $pc.Disable -}}
 {{ with .Site.GoogleAnalytics }}
 <script>
-window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
-ga('create', '{{ . }}', 'auto');
-ga('send', 'pageview');
+{{ template "__ga_js_set_doNotTrack" $ }}
+if (!doNotTrack) {
+       window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
+       ga('create', '{{ . }}', 'auto');
+       ga('send', 'pageview');
+}
 </script>
 <script async src='//www.google-analytics.com/analytics.js'></script>
 {{ end }}

diff --git a/tpl/tplimpl/embedded/templates/google_analytics.html b/tpl/tplimpl/embedded/templates/google_analytics.html
index 89c1932406dad2454567badc441f06ad0e03b646..8c7951b589b3ac4aa4050e77b3ee406d7e4d80ab 100755 (executable)
--- a/tpl/tplimpl/embedded/templates/google_analytics.html
+++ b/tpl/tplimpl/embedded/templates/google_analytics.html
@@ -2,13 +2,24 @@
 {{- if not $pc.Disable -}}
 {{ with .Site.GoogleAnalytics }}
 <script>
-(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
-
-ga('create', '{{ . }}', 'auto');
-ga('send', 'pageview');
+{{ template "__ga_js_set_doNotTrack" $ }}
+if (!doNotTrack) {
+       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+       })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+       ga('create', '{{ . }}', 'auto');
+       ga('send', 'pageview');
+}
 </script>
 {{ end }}
+{{- end -}}
+{{- define "__ga_js_set_doNotTrack" -}}{{/* This is also used in the async version. */}}
+{{- $pc := .Site.PrivacyConfig.GoogleAnalytics -}}
+{{- if not $pc.RespectDoNotTrack -}}
+var doNotTrack = false;
+{{- else -}}
+var dnt = (navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack);
+var doNotTrack = (dnt == "1" || dnt == "yes");
+{{- end -}}
 {{- end -}}
\ No newline at end of file

diff --git a/tpl/tplimpl/embedded/templates/google_analytics_async.html b/tpl/tplimpl/embedded/templates/google_analytics_async.html
index eb4fe9b8878d10a4d3015e12601bb5cb97ead1ce..48a24c1c038e2c8e24c257d4107e5a97e80d093c 100755 (executable)
--- a/tpl/tplimpl/embedded/templates/google_analytics_async.html
+++ b/tpl/tplimpl/embedded/templates/google_analytics_async.html
@@ -2,9 +2,12 @@
 {{- if not $pc.Disable -}}
 {{ with .Site.GoogleAnalytics }}
 <script>
-window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
-ga('create', '{{ . }}', 'auto');
-ga('send', 'pageview');
+{{ template "__ga_js_set_doNotTrack" $ }}
+if (!doNotTrack) {
+       window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
+       ga('create', '{{ . }}', 'auto');
+       ga('send', 'pageview');
+}
 </script>
 <script async src='//www.google-analytics.com/analytics.js'></script>
 {{ end }}