github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-29 01:52:07 -05:00
Code Issues Projects Releases Packages Wiki Activity

tpl: Add Do Not Track (dnt) option to Vimeo shortcode

Browse source 
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
This commit is contained in:
Josh Gerdes 2020-10-02 14:52:00 -05:00 committed by Bjørn Erik Pedersen
parent 05e358fd33
commit edc5c4741c
7 changed files with 33 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
config/privacy/privacyConfig.go
View file

@ -80,6 +80,10 @@ type Twitter struct {
type Vimeo struct { type Vimeo struct {
Service `mapstructure:",squash"` 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 // 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 // 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. // be taken to the video page on vimeo.com in a new browser tab.

3
config/privacy/privacyConfig_test.go
View file

@ -45,6 +45,7 @@ enableDNT = true
simple = true simple = true
[privacy.vimeo] [privacy.vimeo]
disable = true disable = true
enableDNT = true
simple = true simple = true
[privacy.youtube] [privacy.youtube]
disable = true disable = true
@ -63,7 +64,7 @@ simple = true
pc.GoogleAnalytics.RespectDoNotTrack, pc.GoogleAnalytics.AnonymizeIP, pc.GoogleAnalytics.RespectDoNotTrack, pc.GoogleAnalytics.AnonymizeIP,
pc.GoogleAnalytics.UseSessionStorage, pc.Instagram.Disable, pc.GoogleAnalytics.UseSessionStorage, pc.Instagram.Disable,
pc.Instagram.Simple, pc.Twitter.Disable, pc.Twitter.EnableDNT, 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, pc.YouTube.PrivacyEnhanced, pc.YouTube.Disable,
} }

4
docs/content/en/about/hugo-and-gdpr.md
View file

@ -51,6 +51,7 @@ enableDNT = false
simple = false simple = false
[privacy.vimeo] [privacy.vimeo]
disable = false disable = false
enableDNT = false
simple = false simple = false
[privacy.youtube] [privacy.youtube]
disable = false disable = false
@ -128,6 +129,9 @@ privacyEnhanced
### Vimeo ### 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 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. : 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.

4
resources/page/page_marshaljson.autogen.go
View file

@ -21,6 +21,7 @@ import (
"github.com/gohugoio/hugo/common/maps" "github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/hugofs/files" "github.com/gohugoio/hugo/hugofs/files"
"github.com/gohugoio/hugo/identity"
"github.com/gohugoio/hugo/langs" "github.com/gohugoio/hugo/langs"
"github.com/gohugoio/hugo/media" "github.com/gohugoio/hugo/media"
"github.com/gohugoio/hugo/navigation" "github.com/gohugoio/hugo/navigation"
@ -87,6 +88,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) {
isTranslated := p.IsTranslated() isTranslated := p.IsTranslated()
allTranslations := p.AllTranslations() allTranslations := p.AllTranslations()
translations := p.Translations() translations := p.Translations()
getIdentity := p.GetIdentity()
s := struct { s := struct {
Content interface{} Content interface{}
@ -143,6 +145,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) {
IsTranslated bool IsTranslated bool
AllTranslations Pages AllTranslations Pages
Translations Pages Translations Pages
GetIdentity identity.Identity
}{ }{
Content: content, Content: content,
Plain: plain, Plain: plain,
@ -198,6 +201,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) {
IsTranslated: isTranslated, IsTranslated: isTranslated,
AllTranslations: allTranslations, AllTranslations: allTranslations,
Translations: translations, Translations: translations,
GetIdentity: getIdentity,
} }
return json.Marshal(&s) return json.Marshal(&s)

17
tpl/tplimpl/embedded/templates.autogen.go generated
View file

@ -496,16 +496,19 @@ if (!doNotTrack) {
{{ template "_internal/shortcodes/vimeo_simple.html" . }} {{ template "_internal/shortcodes/vimeo_simple.html" . }}
{{- else -}} {{- else -}}
{{ if .IsNamedParams }}<div {{ if .Get "class" }}class="{{ .Get "class" }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}> {{ if .IsNamedParams }}<div {{ if .Get "class" }}class="{{ .Get "class" }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}>
<iframe src="https://player.vimeo.com/video/{{ .Get "id" }}" {{ if not (.Get "class") }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if .Get "title"}}title="{{ .Get "title" }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe> <iframe src="https://player.vimeo.com/video/{{ .Get "id" }}{{- if $pc.EnableDNT -}}?dnt=1{{- end -}}" {{ if not (.Get "class") }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if .Get "title"}}title="{{ .Get "title" }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div>{{ else }} </div>{{ else }}
<div {{ if gt (len .Params) 1 }}class="{{ .Get 1 }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}> <div {{ if gt (len .Params) 1 }}class="{{ .Get 1 }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}>
<iframe src="https://player.vimeo.com/video/{{ .Get 0 }}" {{ if len .Params | eq 1 }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if len .Params | eq 3 }}title="{{ .Get 2 }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe> <iframe src="https://player.vimeo.com/video/{{ .Get 0 }}{{- if $pc.EnableDNT -}}?dnt=1{{- end -}}" {{ if len .Params | eq 1 }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if len .Params | eq 3 }}title="{{ .Get 2 }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div> </div>
{{ end }} {{ end }}
{{- end -}} {{- end -}}
{{- end -}}`}, {{- end -}}`},
{`shortcodes/vimeo_simple.html`, `{{ $id := .Get "id" | default (.Get 0) }} {`shortcodes/vimeo_simple.html`, `{{- $pc := .Page.Site.Config.Privacy.Vimeo -}}
{{- $item := getJSON "https://vimeo.com/api/oembed.json?url=https://vimeo.com/" $id -}} {{- 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) }} {{ $class := .Get "class" | default (.Get 1) }}
{{ $hasClass := $class }} {{ $hasClass := $class }}
{{ $class := $class | default "__h_video" }} {{ $class := $class | default "__h_video" }}
@ -522,7 +525,7 @@ if (!doNotTrack) {
<img src="{{ $thumb }}" srcset="{{ $thumb }} 1x, {{ $original }} 2x" alt="{{ .title }}"> <img src="{{ $thumb }}" srcset="{{ $thumb }} 1x, {{ $original }} 2x" alt="{{ .title }}">
<div class="play">{{ template "__h_simple_icon_play" $ }}</div></a></div> <div class="play">{{ template "__h_simple_icon_play" $ }}</div></a></div>
{{- end -}} {{- end -}}
`}, {{- end -}}`},
{`shortcodes/youtube.html`, `{{- $pc := .Page.Site.Config.Privacy.YouTube -}} {`shortcodes/youtube.html`, `{{- $pc := .Page.Site.Config.Privacy.YouTube -}}
{{- if not $pc.Disable -}} {{- if not $pc.Disable -}}
{{- $ytHost := cond $pc.PrivacyEnhanced "www.youtube-nocookie.com" "www.youtube.com" -}} {{- $ytHost := cond $pc.PrivacyEnhanced "www.youtube-nocookie.com" "www.youtube.com" -}}

8
tpl/tplimpl/embedded/templates/shortcodes/vimeo.html
View file

@ -4,11 +4,11 @@
{{ template "_internal/shortcodes/vimeo_simple.html" . }} {{ template "_internal/shortcodes/vimeo_simple.html" . }}
{{- else -}} {{- else -}}
{{ if .IsNamedParams }}<div {{ if .Get "class" }}class="{{ .Get "class" }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}> {{ if .IsNamedParams }}<div {{ if .Get "class" }}class="{{ .Get "class" }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}>
<iframe src="https://player.vimeo.com/video/{{ .Get "id" }}" {{ if not (.Get "class") }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if .Get "title"}}title="{{ .Get "title" }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe> <iframe src="https://player.vimeo.com/video/{{ .Get "id" }}{{- if $pc.EnableDNT -}}?dnt=1{{- end -}}" {{ if not (.Get "class") }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if .Get "title"}}title="{{ .Get "title" }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div>{{ else }} </div>{{ else }}
<div {{ if gt (len .Params) 1 }}class="{{ .Get 1 }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}> <div {{ if gt (len .Params) 1 }}class="{{ .Get 1 }}"{{ else }}style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;"{{ end }}>
<iframe src="https://player.vimeo.com/video/{{ .Get 0 }}" {{ if len .Params | eq 1 }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if len .Params | eq 3 }}title="{{ .Get 2 }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe> <iframe src="https://player.vimeo.com/video/{{ .Get 0 }}{{- if $pc.EnableDNT -}}?dnt=1{{- end -}}" {{ if len .Params | eq 1 }}style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" {{ end }}{{ if len .Params | eq 3 }}title="{{ .Get 2 }}"{{ else }}title="vimeo video"{{ end }} webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div> </div>
{{ end }} {{ end }}
{{- end -}} {{- end -}}
{{- end -}} {{- end -}}

6
tpl/tplimpl/embedded/templates/shortcodes/vimeo_simple.html
View file

@ -1,5 +1,8 @@
{{- $pc := .Page.Site.Config.Privacy.Vimeo -}}
{{- if not $pc.Disable -}}
{{ $id := .Get "id" | default (.Get 0) }} {{ $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) }} {{ $class := .Get "class" | default (.Get 1) }}
{{ $hasClass := $class }} {{ $hasClass := $class }}
{{ $class := $class | default "__h_video" }} {{ $class := $class | default "__h_video" }}
@ -16,3 +19,4 @@
<img src="{{ $thumb }}" srcset="{{ $thumb }} 1x, {{ $original }} 2x" alt="{{ .title }}"> <img src="{{ $thumb }}" srcset="{{ $thumb }} 1x, {{ $original }} 2x" alt="{{ .title }}">
<div class="play">{{ template "__h_simple_icon_play" $ }}</div></a></div> <div class="play">{{ template "__h_simple_icon_play" $ }}</div></a></div>
{{- end -}} {{- end -}}
{{- end -}}