From edc5c4741caaee36ba4d42b5947c195a3e02e6aa Mon Sep 17 00:00:00 2001 From: Josh Gerdes Date: Fri, 2 Oct 2020 14:52:00 -0500 Subject: [PATCH] tpl: Add Do Not Track (dnt) option to Vimeo shortcode Added a Vimeo EnableDNT privacy option to the Hugo config. This will enable the Vimeo 'Do Not Track' flag when either Vimeo shortcode tempalte options are used. When enabled, it will force the Vimeo player to be blocked from tracking any session data, including all cookies and stats. Fixes #7700 --- config/privacy/privacyConfig.go | 4 ++++ config/privacy/privacyConfig_test.go | 3 ++- docs/content/en/about/hugo-and-gdpr.md | 4 ++++ resources/page/page_marshaljson.autogen.go | 4 ++++ tpl/tplimpl/embedded/templates.autogen.go | 17 ++++++++++------- .../embedded/templates/shortcodes/vimeo.html | 8 ++++---- .../templates/shortcodes/vimeo_simple.html | 6 +++++- 7 files changed, 33 insertions(+), 13 deletions(-) diff --git a/config/privacy/privacyConfig.go b/config/privacy/privacyConfig.go index ea34563eb..a36046364 100644 --- a/config/privacy/privacyConfig.go +++ b/config/privacy/privacyConfig.go @@ -80,6 +80,10 @@ type Twitter struct { type Vimeo struct { Service `mapstructure:",squash"` + // When set to true, the Vimeo player will be blocked from tracking any session data, + // including all cookies and stats. + EnableDNT bool + // If simple mode is enabled, only a thumbnail is fetched from i.vimeocdn.com and // shown with a play button overlaid. If a user clicks the button, he/she will // be taken to the video page on vimeo.com in a new browser tab. diff --git a/config/privacy/privacyConfig_test.go b/config/privacy/privacyConfig_test.go index d798721e1..a750ba282 100644 --- a/config/privacy/privacyConfig_test.go +++ b/config/privacy/privacyConfig_test.go @@ -45,6 +45,7 @@ enableDNT = true simple = true [privacy.vimeo] disable = true +enableDNT = true simple = true [privacy.youtube] disable = true @@ -63,7 +64,7 @@ simple = true pc.GoogleAnalytics.RespectDoNotTrack, pc.GoogleAnalytics.AnonymizeIP, pc.GoogleAnalytics.UseSessionStorage, pc.Instagram.Disable, pc.Instagram.Simple, pc.Twitter.Disable, pc.Twitter.EnableDNT, - pc.Twitter.Simple, pc.Vimeo.Disable, pc.Vimeo.Simple, + pc.Twitter.Simple, pc.Vimeo.Disable, pc.Vimeo.EnableDNT, pc.Vimeo.Simple, pc.YouTube.PrivacyEnhanced, pc.YouTube.Disable, } diff --git a/docs/content/en/about/hugo-and-gdpr.md b/docs/content/en/about/hugo-and-gdpr.md index 7c1c9bed4..df0234a3b 100644 --- a/docs/content/en/about/hugo-and-gdpr.md +++ b/docs/content/en/about/hugo-and-gdpr.md @@ -51,6 +51,7 @@ enableDNT = false simple = false [privacy.vimeo] disable = false +enableDNT = false simple = false [privacy.youtube] disable = false @@ -128,6 +129,9 @@ privacyEnhanced ### Vimeo +enableDNT +: Enabling this for the vimeo shortcode, the Vimeo player will be blocked from tracking any session data, including all cookies and stats. + simple : If simple mode is enabled, the video thumbnail is fetched from Vimeo's servers and it is overlayed with a play button. If the user clicks to play the video, it will open in a new tab directly on Vimeo's website. diff --git a/resources/page/page_marshaljson.autogen.go b/resources/page/page_marshaljson.autogen.go index c01dceeaf..2286f1e63 100644 --- a/resources/page/page_marshaljson.autogen.go +++ b/resources/page/page_marshaljson.autogen.go @@ -21,6 +21,7 @@ import ( "github.com/gohugoio/hugo/common/maps" "github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/hugofs/files" + "github.com/gohugoio/hugo/identity" "github.com/gohugoio/hugo/langs" "github.com/gohugoio/hugo/media" "github.com/gohugoio/hugo/navigation" @@ -87,6 +88,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) { isTranslated := p.IsTranslated() allTranslations := p.AllTranslations() translations := p.Translations() + getIdentity := p.GetIdentity() s := struct { Content interface{} @@ -143,6 +145,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) { IsTranslated bool AllTranslations Pages Translations Pages + GetIdentity identity.Identity }{ Content: content, Plain: plain, @@ -198,6 +201,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) { IsTranslated: isTranslated, AllTranslations: allTranslations, Translations: translations, + GetIdentity: getIdentity, } return json.Marshal(&s) diff --git a/tpl/tplimpl/embedded/templates.autogen.go b/tpl/tplimpl/embedded/templates.autogen.go index 6a6844933..ccdc9197b 100644 --- a/tpl/tplimpl/embedded/templates.autogen.go +++ b/tpl/tplimpl/embedded/templates.autogen.go @@ -496,16 +496,19 @@ if (!doNotTrack) { {{ template "_internal/shortcodes/vimeo_simple.html" . }} {{- else -}} {{ if .IsNamedParams }}
- -
{{ else }} + +{{ else }}
- -
+ + {{ end }} {{- end -}} {{- end -}}`}, - {`shortcodes/vimeo_simple.html`, `{{ $id := .Get "id" | default (.Get 0) }} -{{- $item := getJSON "https://vimeo.com/api/oembed.json?url=https://vimeo.com/" $id -}} + {`shortcodes/vimeo_simple.html`, `{{- $pc := .Page.Site.Config.Privacy.Vimeo -}} +{{- if not $pc.Disable -}} +{{ $id := .Get "id" | default (.Get 0) }} +{{ $dnt := cond (eq $pc.EnableDNT true) "?dnt=1" "" }} +{{- $item := getJSON (print "https://vimeo.com/api/oembed.json?url=https://vimeo.com/" $id $dnt) -}} {{ $class := .Get "class" | default (.Get 1) }} {{ $hasClass := $class }} {{ $class := $class | default "__h_video" }} @@ -522,7 +525,7 @@ if (!doNotTrack) { {{ .title }}
{{ template "__h_simple_icon_play" $ }}
{{- end -}} -`}, +{{- end -}}`}, {`shortcodes/youtube.html`, `{{- $pc := .Page.Site.Config.Privacy.YouTube -}} {{- if not $pc.Disable -}} {{- $ytHost := cond $pc.PrivacyEnhanced "www.youtube-nocookie.com" "www.youtube.com" -}} diff --git a/tpl/tplimpl/embedded/templates/shortcodes/vimeo.html b/tpl/tplimpl/embedded/templates/shortcodes/vimeo.html index 1680c1694..8ddad9b43 100644 --- a/tpl/tplimpl/embedded/templates/shortcodes/vimeo.html +++ b/tpl/tplimpl/embedded/templates/shortcodes/vimeo.html @@ -4,11 +4,11 @@ {{ template "_internal/shortcodes/vimeo_simple.html" . }} {{- else -}} {{ if .IsNamedParams }}
- -
{{ else }} + +{{ else }}
- -
+ + {{ end }} {{- end -}} {{- end -}} \ No newline at end of file diff --git a/tpl/tplimpl/embedded/templates/shortcodes/vimeo_simple.html b/tpl/tplimpl/embedded/templates/shortcodes/vimeo_simple.html index 9a4fb794d..00080ab59 100644 --- a/tpl/tplimpl/embedded/templates/shortcodes/vimeo_simple.html +++ b/tpl/tplimpl/embedded/templates/shortcodes/vimeo_simple.html @@ -1,5 +1,8 @@ +{{- $pc := .Page.Site.Config.Privacy.Vimeo -}} +{{- if not $pc.Disable -}} {{ $id := .Get "id" | default (.Get 0) }} -{{- $item := getJSON "https://vimeo.com/api/oembed.json?url=https://vimeo.com/" $id -}} +{{ $dnt := cond (eq $pc.EnableDNT true) "?dnt=1" "" }} +{{- $item := getJSON (print "https://vimeo.com/api/oembed.json?url=https://vimeo.com/" $id $dnt) -}} {{ $class := .Get "class" | default (.Get 1) }} {{ $hasClass := $class }} {{ $class := $class | default "__h_video" }} @@ -16,3 +19,4 @@ {{ .title }}
{{ template "__h_simple_icon_play" $ }}
{{- end -}} +{{- end -}} \ No newline at end of file