tpl/tplimpl: Fix template truth logic

Before this commit, due to a bug in Go's `text/template` package, this would print different output for typed nil interface values:

```
{{ if .AuthenticatedUser }}User is authenticated!{{ else }}{{ end }}
{{ if not .AuthenticatedUser }}{{ else }}}User is authenticated!{{ end }}
```

This commit works around this by wrapping every `if` and `with` with a custom `getif` template func with truth logic that matches `not`, `and` and `or`.

Those 3 template funcs from Go's stdlib are now pulled into Hugo's source tree and adjusted to support custom zero values, e.g. types that implement `IsZero`.

This means that you can now do:

```
{{ with .Date }}{{ . }}{{ end }}
```

And it would work as expected.

Fixes #5738

tpl/tplimpl/template_ast_transformers.go

@@ -85,31 +85,59 @@ func applyTemplateTransformers(templ *parse.Tree, lookupFn func(name string) *pa
 
 	c := newTemplateContext(lookupFn)
 
-	c.paramsKeysToLower(templ.Root)
+	c.applyTransformations(templ.Root)
 
 	return nil
 }
 
-// paramsKeysToLower is made purposely non-generic to make it not so tempting
-// to do more of these hard-to-maintain AST transformations.
-func (c *templateContext) paramsKeysToLower(n parse.Node) {
+// The truth logic in Go's template package is broken for certain values
+// for the if and with keywords. This works around that problem by wrapping
+// the node passed to if/with in a getif conditional.
+// getif works slightly different than the Go built-in in that it also
+// considers any IsZero methods on the values (as in time.Time).
+// See https://github.com/gohugoio/hugo/issues/5738
+func (c *templateContext) wrapWithGetIf(p *parse.PipeNode) {
+	if len(p.Cmds) == 0 {
+		return
+	}
+
+	// getif will return an empty string if not evaluated as truthful,
+	// which is when we need the value in the with clause.
+	firstArg := parse.NewIdentifier("getif")
+	secondArg := p.CopyPipe()
+	newCmd := p.Cmds[0].Copy().(*parse.CommandNode)
+
+	// secondArg is a PipeNode and will behave as it was wrapped in parens, e.g:
+	// {{ getif (len .Params | eq 2) }}
+	newCmd.Args = []parse.Node{firstArg, secondArg}
+
+	p.Cmds = []*parse.CommandNode{newCmd}
+
+}
+
+// applyTransformations do two things:
+// 1) Make all .Params.CamelCase and similar into lowercase.
+// 2) Wraps every with and if pipe in getif
+func (c *templateContext) applyTransformations(n parse.Node) {
 	switch x := n.(type) {
 	case *parse.ListNode:
 		if x != nil {
-			c.paramsKeysToLowerForNodes(x.Nodes...)
+			c.applyTransformationsToNodes(x.Nodes...)
 		}
 	case *parse.ActionNode:
-		c.paramsKeysToLowerForNodes(x.Pipe)
+		c.applyTransformationsToNodes(x.Pipe)
 	case *parse.IfNode:
-		c.paramsKeysToLowerForNodes(x.Pipe, x.List, x.ElseList)
+		c.applyTransformationsToNodes(x.Pipe, x.List, x.ElseList)
+		c.wrapWithGetIf(x.Pipe)
 	case *parse.WithNode:
-		c.paramsKeysToLowerForNodes(x.Pipe, x.List, x.ElseList)
+		c.applyTransformationsToNodes(x.Pipe, x.List, x.ElseList)
+		c.wrapWithGetIf(x.Pipe)
 	case *parse.RangeNode:
-		c.paramsKeysToLowerForNodes(x.Pipe, x.List, x.ElseList)
+		c.applyTransformationsToNodes(x.Pipe, x.List, x.ElseList)
 	case *parse.TemplateNode:
 		subTempl := c.getIfNotVisited(x.Name)
 		if subTempl != nil {
-			c.paramsKeysToLowerForNodes(subTempl.Root)
+			c.applyTransformationsToNodes(subTempl.Root)
 		}
 	case *parse.PipeNode:
 		if len(x.Decl) == 1 && len(x.Cmds) == 1 {
@@ -118,7 +146,7 @@ func (c *templateContext) paramsKeysToLower(n parse.Node) {
 		}
 
 		for _, cmd := range x.Cmds {
-			c.paramsKeysToLower(cmd)
+			c.applyTransformations(cmd)
 		}
 
 	case *parse.CommandNode:
@@ -129,7 +157,7 @@ func (c *templateContext) paramsKeysToLower(n parse.Node) {
 			case *parse.VariableNode:
 				c.updateIdentsIfNeeded(an.Ident)
 			case *parse.PipeNode:
-				c.paramsKeysToLower(an)
+				c.applyTransformations(an)
 			case *parse.ChainNode:
 				// site.Params...
 				if len(an.Field) > 1 && an.Field[0] == paramsIdentifier {
@@ -140,9 +168,9 @@ func (c *templateContext) paramsKeysToLower(n parse.Node) {
 	}
 }
 
-func (c *templateContext) paramsKeysToLowerForNodes(nodes ...parse.Node) {
+func (c *templateContext) applyTransformationsToNodes(nodes ...parse.Node) {
 	for _, node := range nodes {
-		c.paramsKeysToLower(node)
+		c.applyTransformations(node)
 	}
 }
 

tpl/tplimpl/template_ast_transformers_test.go

@@ -15,9 +15,14 @@ package tplimpl
 import (
 	"bytes"
 	"fmt"
-	"testing"
-
 	"html/template"
+	"testing"
+	"time"
+
+	"github.com/gohugoio/hugo/tpl"
+
+	"github.com/gohugoio/hugo/deps"
+	"github.com/gohugoio/hugo/hugofs"
 
 	"github.com/spf13/cast"
 
@@ -26,6 +31,7 @@ import (
 
 var (
 	testFuncs = map[string]interface{}{
+		"getif":  func(v interface{}) interface{} { return v },
 		"ToTime": func(v interface{}) interface{} { return cast.ToTime(v) },
 		"First":  func(v ...interface{}) interface{} { return v[0] },
 		"Echo":   func(v interface{}) interface{} { return v },
@@ -183,7 +189,7 @@ func TestParamsKeysToLower(t *testing.T) {
 
 	require.Equal(t, -1, c.decl.indexOfReplacementStart([]string{}))
 
-	c.paramsKeysToLower(templ.Tree.Root)
+	c.applyTransformations(templ.Tree.Root)
 
 	var b bytes.Buffer
 
@@ -265,7 +271,7 @@ func BenchmarkTemplateParamsKeysToLower(b *testing.B) {
 
 	for i := 0; i < b.N; i++ {
 		c := newTemplateContext(createParseTreeLookup(templates[i]))
-		c.paramsKeysToLower(templ.Tree.Root)
+		c.applyTransformations(templ.Tree.Root)
 	}
 }
 
@@ -304,7 +310,7 @@ Pretty First3: {{ $__amber_4.COLORS.PRETTY.FIRST}}
 
 	c := newTemplateContext(createParseTreeLookup(templ))
 
-	c.paramsKeysToLower(templ.Tree.Root)
+	c.applyTransformations(templ.Tree.Root)
 
 	var b bytes.Buffer
 
@@ -348,7 +354,7 @@ P2: {{ .Params.LOWER }}
 
 	c := newTemplateContext(createParseTreeLookup(overlayTpl))
 
-	c.paramsKeysToLower(overlayTpl.Tree.Root)
+	c.applyTransformations(overlayTpl.Tree.Root)
 
 	var b bytes.Buffer
 
@@ -377,6 +383,78 @@ func TestTransformRecursiveTemplate(t *testing.T) {
 	require.NoError(t, err)
 
 	c := newTemplateContext(createParseTreeLookup(templ))
-	c.paramsKeysToLower(templ.Tree.Root)
+	c.applyTransformations(templ.Tree.Root)
+
+}
+
+type I interface {
+	Method0()
+}
+
+type T struct {
+	NonEmptyInterfaceTypedNil I
+}
+
+func (T) Method0() {
+}
+
+func TestInsertIsZeroFunc(t *testing.T) {
+	t.Parallel()
+
+	assert := require.New(t)
+
+	var (
+		ctx = map[string]interface{}{
+			"True":     true,
+			"Now":      time.Now(),
+			"TimeZero": time.Time{},
+			"T":        &T{NonEmptyInterfaceTypedNil: (*T)(nil)},
+		}
+
+		templ = `
+{{ if .True }}.True: TRUE{{ else }}.True: FALSE{{ end }}
+{{ if .TimeZero }}.TimeZero1: TRUE{{ else }}.TimeZero1: FALSE{{ end }}
+{{ if (.TimeZero) }}.TimeZero2: TRUE{{ else }}.TimeZero2: FALSE{{ end }}
+{{ if not .TimeZero }}.TimeZero3: TRUE{{ else }}.TimeZero3: FALSE{{ end }}
+{{ if .Now }}.Now: TRUE{{ else }}.Now: FALSE{{ end }}
+{{ with .TimeZero }}.TimeZero1 with: {{ . }}{{ else }}.TimeZero1 with: FALSE{{ end }}
+{{ template "mytemplate" . }}
+{{ if .T.NonEmptyInterfaceTypedNil }}.NonEmptyInterfaceTypedNil: TRUE{{ else }}.NonEmptyInterfaceTypedNil: FALSE{{ end }}
+
+
+{{ define "mytemplate" }}
+{{ if .TimeZero }}.TimeZero1: mytemplate: TRUE{{ else }}.TimeZero1: mytemplate: FALSE{{ end }}
+{{ end }}
+
+`
+	)
+
+	v := newTestConfig()
+	fs := hugofs.NewMem(v)
+
+	depsCfg := newDepsConfig(v)
+	depsCfg.Fs = fs
+	d, err := deps.New(depsCfg)
+	assert.NoError(err)
+
+	provider := DefaultTemplateProvider
+	provider.Update(d)
+
+	h := d.Tmpl.(handler)
+
+	assert.NoError(h.addTemplate("mytemplate.html", templ))
+
+	tt, _ := d.Tmpl.Lookup("mytemplate.html")
+	result, err := tt.(tpl.TemplateExecutor).ExecuteToString(ctx)
+	assert.NoError(err)
+
+	assert.Contains(result, ".True: TRUE")
+	assert.Contains(result, ".TimeZero1: FALSE")
+	assert.Contains(result, ".TimeZero2: FALSE")
+	assert.Contains(result, ".TimeZero3: TRUE")
+	assert.Contains(result, ".Now: TRUE")
+	assert.Contains(result, "TimeZero1 with: FALSE")
+	assert.Contains(result, ".TimeZero1: mytemplate: FALSE")
+	assert.Contains(result, ".NonEmptyInterfaceTypedNil: FALSE")
 
 }