tpl/safe: Make it a package that stands on its own

See #3042
This commit is contained in:
Bjørn Erik Pedersen 2017-04-30 23:06:28 +02:00
parent b958c0c109
commit 4a3463463f
4 changed files with 55 additions and 22 deletions

54
tpl/safe/init.go Normal file
View file

@ -0,0 +1,54 @@
// Copyright 2017 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package safe
import (
"github.com/spf13/hugo/deps"
"github.com/spf13/hugo/tpl/internal"
)
const name = "safe"
func init() {
f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
ctx := New()
examples := [][2]string{
{`{{ "Bat&Man" | safeCSS | safeCSS }}`, `Bat&Man`},
{`{{ "Bat&Man" | safeHTML | safeHTML }}`, `Bat&Man`},
{`{{ "Bat&Man" | safeHTML }}`, `Bat&Man`},
{`{{ "(1*2)" | safeJS | safeJS }}`, `(1*2)`},
{`{{ "http://gohugo.io" | safeURL | safeURL }}`, `http://gohugo.io`},
}
return &internal.TemplateFuncsNamespace{
Name: name,
Context: func() interface{} { return ctx },
Aliases: map[string]interface{}{
"safeCSS": ctx.CSS,
"safeHTML": ctx.HTML,
"safeHTMLAttr": ctx.HTMLAttr,
"safeJS": ctx.JS,
"safeJSStr": ctx.JSStr,
"safeURL": ctx.URL,
"sanitizeURL": ctx.SanitizeURL,
"sanitizeurl": ctx.SanitizeURL,
},
Examples: examples,
}
}
internal.AddTemplateFuncsNamespace(f)
}

View file

@ -21,7 +21,6 @@ import (
bp "github.com/spf13/hugo/bufferpool" bp "github.com/spf13/hugo/bufferpool"
"github.com/spf13/hugo/deps" "github.com/spf13/hugo/deps"
"github.com/spf13/hugo/tpl/safe"
"github.com/spf13/hugo/tpl/time" "github.com/spf13/hugo/tpl/time"
"github.com/spf13/hugo/tpl/transform" "github.com/spf13/hugo/tpl/transform"
"github.com/spf13/hugo/tpl/urls" "github.com/spf13/hugo/tpl/urls"
@ -33,7 +32,6 @@ type templateFuncster struct {
cachedPartials partialCache cachedPartials partialCache
// Namespaces // Namespaces
safe *safe.Namespace
time *time.Namespace time *time.Namespace
transform *transform.Namespace transform *transform.Namespace
urls *urls.Namespace urls *urls.Namespace
@ -47,7 +45,6 @@ func newTemplateFuncster(deps *deps.Deps) *templateFuncster {
cachedPartials: partialCache{p: make(map[string]interface{})}, cachedPartials: partialCache{p: make(map[string]interface{})},
// Namespaces // Namespaces
safe: safe.New(),
time: time.New(), time: time.New(),
transform: transform.New(deps), transform: transform.New(deps),
urls: urls.New(deps), urls: urls.New(deps),

View file

@ -34,6 +34,7 @@ import (
_ "github.com/spf13/hugo/tpl/lang" _ "github.com/spf13/hugo/tpl/lang"
_ "github.com/spf13/hugo/tpl/math" _ "github.com/spf13/hugo/tpl/math"
_ "github.com/spf13/hugo/tpl/os" _ "github.com/spf13/hugo/tpl/os"
_ "github.com/spf13/hugo/tpl/safe"
_ "github.com/spf13/hugo/tpl/strings" _ "github.com/spf13/hugo/tpl/strings"
) )
@ -88,7 +89,6 @@ func (t *templateFuncster) partialCached(name string, context interface{}, varia
func (t *templateFuncster) initFuncMap() { func (t *templateFuncster) initFuncMap() {
funcMap := template.FuncMap{ funcMap := template.FuncMap{
// Namespaces // Namespaces
"safe": t.safe.Namespace,
//"time": t.time.Namespace, //"time": t.time.Namespace,
"transform": t.transform.Namespace, "transform": t.transform.Namespace,
"urls": t.urls.Namespace, "urls": t.urls.Namespace,
@ -113,14 +113,6 @@ func (t *templateFuncster) initFuncMap() {
"relURL": t.urls.RelURL, "relURL": t.urls.RelURL,
"relLangURL": t.urls.RelLangURL, "relLangURL": t.urls.RelLangURL,
"relref": t.urls.RelRef, "relref": t.urls.RelRef,
"safeCSS": t.safe.CSS,
"safeHTML": t.safe.HTML,
"safeHTMLAttr": t.safe.HTMLAttr,
"safeJS": t.safe.JS,
"safeJSStr": t.safe.JSStr,
"safeURL": t.safe.URL,
"sanitizeURL": t.safe.SanitizeURL,
"sanitizeurl": t.safe.SanitizeURL,
"string": func(v interface{}) (string, error) { return cast.ToStringE(v) }, "string": func(v interface{}) (string, error) { return cast.ToStringE(v) },
"time": t.time.AsTime, "time": t.time.AsTime,
"urlize": t.PathSpec.URLize, "urlize": t.PathSpec.URLize,

View file

@ -145,11 +145,6 @@ relLangURL: {{ "index.html" | relLangURL }}
relURL 1: {{ "http://gohugo.io/" | relURL }} relURL 1: {{ "http://gohugo.io/" | relURL }}
relURL 2: {{ "mystyle.css" | relURL }} relURL 2: {{ "mystyle.css" | relURL }}
relURL 3: {{ mul 2 21 | relURL }} relURL 3: {{ mul 2 21 | relURL }}
safeCSS: {{ "Bat&Man" | safeCSS | safeCSS }}
safeHTML: {{ "Bat&Man" | safeHTML | safeHTML }}
safeHTML: {{ "Bat&Man" | safeHTML }}
safeJS: {{ "(1*2)" | safeJS | safeJS }}
safeURL: {{ "http://gohugo.io" | safeURL | safeURL }}
strings.TrimPrefix: {{ strings.TrimPrefix "Goodbye,, world!" "Goodbye," }} strings.TrimPrefix: {{ strings.TrimPrefix "Goodbye,, world!" "Goodbye," }}
time: {{ (time "2015-01-21").Year }} time: {{ (time "2015-01-21").Year }}
urlize: {{ "Bat Man" | urlize }} urlize: {{ "Bat Man" | urlize }}
@ -178,11 +173,6 @@ relLangURL: /hugo/en/index.html
relURL 1: http://gohugo.io/ relURL 1: http://gohugo.io/
relURL 2: /hugo/mystyle.css relURL 2: /hugo/mystyle.css
relURL 3: /hugo/42 relURL 3: /hugo/42
safeCSS: Bat&Man
safeHTML: Bat&Man
safeHTML: Bat&Man
safeJS: (1*2)
safeURL: http://gohugo.io
strings.TrimPrefix: , world! strings.TrimPrefix: , world!
time: 2015 time: 2015
urlize: bat-man urlize: bat-man