[#3476] added raw template function

tools/template/registry.go

@@ -25,17 +25,24 @@ import (
 	"fmt"
 	"html/template"
 	"io/fs"
+	"path/filepath"
 	"strings"
 
 	"github.com/pocketbase/pocketbase/tools/store"
 )
 
-// NewRegistry creates and initializes a new blank templates registry.
+// NewRegistry creates and initializes a new templates registry with
+// some defaults (eg. global "raw" template function for unescaped HTML).
 //
 // Use the Registry.Load* methods to load templates into the registry.
 func NewRegistry() *Registry {
 	return &Registry{
 		cache: store.New[*Renderer](nil),
+		funcs: template.FuncMap{
+			"raw": func(str string) template.HTML {
+				return template.HTML(str)
+			},
+		},
 	}
 }
 
@@ -44,6 +51,31 @@ func NewRegistry() *Registry {
 // Use the Registry.Load* methods to load templates into the registry.
 type Registry struct {
 	cache *store.Store[*Renderer]
+	funcs template.FuncMap
+}
+
+// AddFuncs registers new global template functions.
+//
+// The key of each map entry is the function name that will be used in the templates.
+// If a function with the map entry name already exists it will be replaced with the new one.
+//
+// The value of each map entry is a function that must have either a
+// single return value, or two return values of which the second has type error.
+//
+// Example:
+//
+//  r.AddFuncs(map[string]any{
+//    "toUpper": func(str string) string {
+//        return strings.ToUppser(str)
+//    },
+//    ...
+//  })
+func (r *Registry) AddFuncs(funcs map[string]any) *Registry {
+	for name, f := range funcs {
+		r.funcs[name] = f
+	}
+
+	return r
 }
 
 // LoadFiles caches (if not already) the specified filenames set as a
@@ -57,7 +89,7 @@ func (r *Registry) LoadFiles(filenames ...string) *Renderer {
 
 	if found == nil {
 		// parse and cache
-		tpl, err := template.ParseFiles(filenames...)
+		tpl, err := template.New(filepath.Base(filenames[0])).Funcs(r.funcs).ParseFiles(filenames...)
 		found = &Renderer{template: tpl, parseError: err}
 		r.cache.Set(key, found)
 	}
@@ -72,7 +104,7 @@ func (r *Registry) LoadString(text string) *Renderer {
 
 	if found == nil {
 		// parse and cache (using the text as key)
-		tpl, err := template.New("").Parse(text)
+		tpl, err := template.New("").Funcs(r.funcs).Parse(text)
 		found = &Renderer{template: tpl, parseError: err}
 		r.cache.Set(text, found)
 	}
@@ -85,14 +117,22 @@ func (r *Registry) LoadString(text string) *Renderer {
 //
 // There must be at least 1 file matching the provided globPattern(s)
 // (note that most file names serves as glob patterns matching themselves).
-func (r *Registry) LoadFS(fs fs.FS, globPatterns ...string) *Renderer {
-	key := fmt.Sprintf("%v%v", fs, globPatterns)
+func (r *Registry) LoadFS(fsys fs.FS, globPatterns ...string) *Renderer {
+	key := fmt.Sprintf("%v%v", fsys, globPatterns)
 
 	found := r.cache.Get(key)
 
 	if found == nil {
-		// parse and cache
-		tpl, err := template.ParseFS(fs, globPatterns...)
+		// find the first file to use as template name (it is required when specifying Funcs)
+		var firstFilename string
+		if len(globPatterns) > 0 {
+			list, _ := fs.Glob(fsys, globPatterns[0])
+			if len(list) > 0 {
+				firstFilename = filepath.Base(list[0])
+			}
+		}
+
+		tpl, err := template.New(firstFilename).Funcs(r.funcs).ParseFS(fsys, globPatterns...)
 		found = &Renderer{template: tpl, parseError: err}
 		r.cache.Set(key, found)
 	}