1
0
mirror of https://github.com/golang/go synced 2024-11-17 21:14:44 -07:00

html/template: attach functions to namespace

The text/template functions are stored in a data structure shared by
all related templates, so do the same with the original, unwrapped,
functions on the html/template side.

For #39807
Fixes #43295

Change-Id: I9f64a0a601f1151c863a2833b5be2baf649b6cef
Reviewed-on: https://go-review.googlesource.com/c/go/+/279492
Trust: Ian Lance Taylor <iant@golang.org>
Run-TryBot: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Emmanuel Odeke <emmanuel@orijtech.com>
This commit is contained in:
Ian Lance Taylor 2020-12-21 11:21:59 -08:00
parent 6da2d3b7d7
commit e60cffa4ca
2 changed files with 47 additions and 19 deletions

View File

@ -1776,3 +1776,23 @@ func TestRecursiveExecute(t *testing.T) {
t.Fatal(err) t.Fatal(err)
} }
} }
// Issue 43295.
func TestTemplateFuncsAfterClone(t *testing.T) {
s := `{{ f . }}`
want := "test"
orig := New("orig").Funcs(map[string]interface{}{
"f": func(in string) string {
return in
},
}).New("child")
overviewTmpl := Must(Must(orig.Clone()).Parse(s))
var out strings.Builder
if err := overviewTmpl.Execute(&out, want); err != nil {
t.Fatal(err)
}
if got := out.String(); got != want {
t.Fatalf("got %q; want %q", got, want)
}
}

View File

@ -27,9 +27,7 @@ type Template struct {
// template's in sync. // template's in sync.
text *template.Template text *template.Template
// The underlying template's parse tree, updated to be HTML-safe. // The underlying template's parse tree, updated to be HTML-safe.
Tree *parse.Tree Tree *parse.Tree
// The original functions, before wrapping.
funcMap FuncMap
*nameSpace // common to all associated templates *nameSpace // common to all associated templates
} }
@ -42,6 +40,8 @@ type nameSpace struct {
set map[string]*Template set map[string]*Template
escaped bool escaped bool
esc escaper esc escaper
// The original functions, before wrapping.
funcMap FuncMap
} }
// Templates returns a slice of the templates associated with t, including t // Templates returns a slice of the templates associated with t, including t
@ -260,7 +260,6 @@ func (t *Template) AddParseTree(name string, tree *parse.Tree) (*Template, error
nil, nil,
text, text,
text.Tree, text.Tree,
nil,
t.nameSpace, t.nameSpace,
} }
t.set[name] = ret t.set[name] = ret
@ -287,14 +286,19 @@ func (t *Template) Clone() (*Template, error) {
} }
ns := &nameSpace{set: make(map[string]*Template)} ns := &nameSpace{set: make(map[string]*Template)}
ns.esc = makeEscaper(ns) ns.esc = makeEscaper(ns)
if t.nameSpace.funcMap != nil {
ns.funcMap = make(FuncMap, len(t.nameSpace.funcMap))
for name, fn := range t.nameSpace.funcMap {
ns.funcMap[name] = fn
}
}
wrapFuncs(ns, textClone, ns.funcMap)
ret := &Template{ ret := &Template{
nil, nil,
textClone, textClone,
textClone.Tree, textClone.Tree,
t.funcMap,
ns, ns,
} }
ret.wrapFuncs()
ret.set[ret.Name()] = ret ret.set[ret.Name()] = ret
for _, x := range textClone.Templates() { for _, x := range textClone.Templates() {
name := x.Name() name := x.Name()
@ -307,10 +311,8 @@ func (t *Template) Clone() (*Template, error) {
nil, nil,
x, x,
x.Tree, x.Tree,
src.funcMap,
ret.nameSpace, ret.nameSpace,
} }
tc.wrapFuncs()
ret.set[name] = tc ret.set[name] = tc
} }
// Return the template associated with the name of this template. // Return the template associated with the name of this template.
@ -325,7 +327,6 @@ func New(name string) *Template {
nil, nil,
template.New(name), template.New(name),
nil, nil,
nil,
ns, ns,
} }
tmpl.set[name] = tmpl tmpl.set[name] = tmpl
@ -351,7 +352,6 @@ func (t *Template) new(name string) *Template {
nil, nil,
t.text.New(name), t.text.New(name),
nil, nil,
nil,
t.nameSpace, t.nameSpace,
} }
if existing, ok := tmpl.set[name]; ok { if existing, ok := tmpl.set[name]; ok {
@ -382,23 +382,31 @@ type FuncMap map[string]interface{}
// type. However, it is legal to overwrite elements of the map. The return // type. However, it is legal to overwrite elements of the map. The return
// value is the template, so calls can be chained. // value is the template, so calls can be chained.
func (t *Template) Funcs(funcMap FuncMap) *Template { func (t *Template) Funcs(funcMap FuncMap) *Template {
t.funcMap = funcMap t.nameSpace.mu.Lock()
t.wrapFuncs() if t.nameSpace.funcMap == nil {
t.nameSpace.funcMap = make(FuncMap, len(funcMap))
}
for name, fn := range funcMap {
t.nameSpace.funcMap[name] = fn
}
t.nameSpace.mu.Unlock()
wrapFuncs(t.nameSpace, t.text, funcMap)
return t return t
} }
// wrapFuncs records the functions with text/template. We wrap them to // wrapFuncs records the functions with text/template. We wrap them to
// unlock the nameSpace. See TestRecursiveExecute for a test case. // unlock the nameSpace. See TestRecursiveExecute for a test case.
func (t *Template) wrapFuncs() { func wrapFuncs(ns *nameSpace, textTemplate *template.Template, funcMap FuncMap) {
if len(t.funcMap) == 0 { if len(funcMap) == 0 {
return return
} }
tfuncs := make(template.FuncMap, len(t.funcMap)) tfuncs := make(template.FuncMap, len(funcMap))
for name, fn := range t.funcMap { for name, fn := range funcMap {
fnv := reflect.ValueOf(fn) fnv := reflect.ValueOf(fn)
wrapper := func(args []reflect.Value) []reflect.Value { wrapper := func(args []reflect.Value) []reflect.Value {
t.nameSpace.mu.RUnlock() ns.mu.RUnlock()
defer t.nameSpace.mu.RLock() defer ns.mu.RLock()
if fnv.Type().IsVariadic() { if fnv.Type().IsVariadic() {
return fnv.CallSlice(args) return fnv.CallSlice(args)
} else { } else {
@ -408,7 +416,7 @@ func (t *Template) wrapFuncs() {
wrapped := reflect.MakeFunc(fnv.Type(), wrapper) wrapped := reflect.MakeFunc(fnv.Type(), wrapper)
tfuncs[name] = wrapped.Interface() tfuncs[name] = wrapped.Interface()
} }
t.text.Funcs(tfuncs) textTemplate.Funcs(tfuncs)
} }
// Delims sets the action delimiters to the specified strings, to be used in // Delims sets the action delimiters to the specified strings, to be used in