mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
279 lines
7.8 KiB
Go
279 lines
7.8 KiB
Go
// Copyright 2017-present The Hugo Authors. All rights reserved.
|
|
//
|
|
// Portions Copyright The Go Authors.
|
|
|
|
// 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 tplimpl
|
|
|
|
import (
|
|
"context"
|
|
"reflect"
|
|
"strings"
|
|
|
|
"github.com/gohugoio/hugo/common/hreflect"
|
|
"github.com/gohugoio/hugo/common/maps"
|
|
"github.com/gohugoio/hugo/identity"
|
|
"github.com/gohugoio/hugo/tpl"
|
|
|
|
template "github.com/gohugoio/hugo/tpl/internal/go_templates/htmltemplate"
|
|
texttemplate "github.com/gohugoio/hugo/tpl/internal/go_templates/texttemplate"
|
|
|
|
"github.com/gohugoio/hugo/deps"
|
|
|
|
"github.com/gohugoio/hugo/tpl/internal"
|
|
|
|
// Init the namespaces
|
|
_ "github.com/gohugoio/hugo/tpl/cast"
|
|
_ "github.com/gohugoio/hugo/tpl/collections"
|
|
_ "github.com/gohugoio/hugo/tpl/compare"
|
|
_ "github.com/gohugoio/hugo/tpl/crypto"
|
|
_ "github.com/gohugoio/hugo/tpl/css"
|
|
_ "github.com/gohugoio/hugo/tpl/data"
|
|
_ "github.com/gohugoio/hugo/tpl/debug"
|
|
_ "github.com/gohugoio/hugo/tpl/diagrams"
|
|
_ "github.com/gohugoio/hugo/tpl/encoding"
|
|
_ "github.com/gohugoio/hugo/tpl/fmt"
|
|
_ "github.com/gohugoio/hugo/tpl/hugo"
|
|
_ "github.com/gohugoio/hugo/tpl/images"
|
|
_ "github.com/gohugoio/hugo/tpl/inflect"
|
|
_ "github.com/gohugoio/hugo/tpl/js"
|
|
_ "github.com/gohugoio/hugo/tpl/lang"
|
|
_ "github.com/gohugoio/hugo/tpl/math"
|
|
_ "github.com/gohugoio/hugo/tpl/openapi/openapi3"
|
|
_ "github.com/gohugoio/hugo/tpl/os"
|
|
_ "github.com/gohugoio/hugo/tpl/page"
|
|
_ "github.com/gohugoio/hugo/tpl/partials"
|
|
_ "github.com/gohugoio/hugo/tpl/path"
|
|
_ "github.com/gohugoio/hugo/tpl/reflect"
|
|
_ "github.com/gohugoio/hugo/tpl/resources"
|
|
_ "github.com/gohugoio/hugo/tpl/safe"
|
|
_ "github.com/gohugoio/hugo/tpl/site"
|
|
_ "github.com/gohugoio/hugo/tpl/strings"
|
|
_ "github.com/gohugoio/hugo/tpl/templates"
|
|
_ "github.com/gohugoio/hugo/tpl/time"
|
|
_ "github.com/gohugoio/hugo/tpl/transform"
|
|
_ "github.com/gohugoio/hugo/tpl/urls"
|
|
)
|
|
|
|
var (
|
|
_ texttemplate.ExecHelper = (*templateExecHelper)(nil)
|
|
zero reflect.Value
|
|
)
|
|
|
|
type templateExecHelper struct {
|
|
running bool // whether we're in server mode.
|
|
site reflect.Value
|
|
siteParams reflect.Value
|
|
funcs map[string]reflect.Value
|
|
}
|
|
|
|
func (t *templateExecHelper) GetFunc(ctx context.Context, tmpl texttemplate.Preparer, name string) (fn reflect.Value, firstArg reflect.Value, found bool) {
|
|
if fn, found := t.funcs[name]; found {
|
|
if fn.Type().NumIn() > 0 {
|
|
first := fn.Type().In(0)
|
|
if hreflect.IsContextType(first) {
|
|
// TODO(bep) check if we can void this conversion every time -- and if that matters.
|
|
// The first argument may be context.Context. This is never provided by the end user, but it's used to pass down
|
|
// contextual information, e.g. the top level data context (e.g. Page).
|
|
return fn, reflect.ValueOf(ctx), true
|
|
}
|
|
}
|
|
|
|
return fn, zero, true
|
|
}
|
|
return zero, zero, false
|
|
}
|
|
|
|
func (t *templateExecHelper) Init(ctx context.Context, tmpl texttemplate.Preparer) {
|
|
if t.running {
|
|
_, ok := tmpl.(identity.IdentityProvider)
|
|
if ok {
|
|
t.trackDependencies(ctx, tmpl, "", reflect.Value{})
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
func (t *templateExecHelper) GetMapValue(ctx context.Context, tmpl texttemplate.Preparer, receiver, key reflect.Value) (reflect.Value, bool) {
|
|
if params, ok := receiver.Interface().(maps.Params); ok {
|
|
// Case insensitive.
|
|
keystr := strings.ToLower(key.String())
|
|
v, found := params[keystr]
|
|
if !found {
|
|
return zero, false
|
|
}
|
|
return reflect.ValueOf(v), true
|
|
}
|
|
|
|
v := receiver.MapIndex(key)
|
|
|
|
return v, v.IsValid()
|
|
}
|
|
|
|
var typeParams = reflect.TypeOf(maps.Params{})
|
|
|
|
func (t *templateExecHelper) GetMethod(ctx context.Context, tmpl texttemplate.Preparer, receiver reflect.Value, name string) (method reflect.Value, firstArg reflect.Value) {
|
|
if strings.EqualFold(name, "mainsections") && receiver.Type() == typeParams && receiver.Pointer() == t.siteParams.Pointer() {
|
|
// Moved to site.MainSections in Hugo 0.112.0.
|
|
receiver = t.site
|
|
name = "MainSections"
|
|
}
|
|
|
|
if t.running {
|
|
ctx = t.trackDependencies(ctx, tmpl, name, receiver)
|
|
}
|
|
|
|
fn := hreflect.GetMethodByName(receiver, name)
|
|
if !fn.IsValid() {
|
|
return zero, zero
|
|
}
|
|
|
|
if fn.Type().NumIn() > 0 {
|
|
first := fn.Type().In(0)
|
|
if hreflect.IsContextType(first) {
|
|
// The first argument may be context.Context. This is never provided by the end user, but it's used to pass down
|
|
// contextual information, e.g. the top level data context (e.g. Page).
|
|
return fn, reflect.ValueOf(ctx)
|
|
}
|
|
}
|
|
|
|
return fn, zero
|
|
}
|
|
|
|
func (t *templateExecHelper) OnCalled(ctx context.Context, tmpl texttemplate.Preparer, name string, args []reflect.Value, result reflect.Value) {
|
|
if !t.running {
|
|
return
|
|
}
|
|
|
|
// This switch is mostly for speed.
|
|
switch name {
|
|
case "Unmarshal":
|
|
default:
|
|
return
|
|
}
|
|
idm := tpl.Context.GetDependencyManagerInCurrentScope(ctx)
|
|
if idm == nil {
|
|
return
|
|
}
|
|
|
|
for _, arg := range args {
|
|
identity.WalkIdentitiesShallow(arg.Interface(), func(level int, id identity.Identity) bool {
|
|
idm.AddIdentity(id)
|
|
return false
|
|
})
|
|
}
|
|
}
|
|
|
|
func (t *templateExecHelper) trackDependencies(ctx context.Context, tmpl texttemplate.Preparer, name string, receiver reflect.Value) context.Context {
|
|
if tmpl == nil {
|
|
panic("must provide a template")
|
|
}
|
|
|
|
idm := tpl.Context.GetDependencyManagerInCurrentScope(ctx)
|
|
if idm == nil {
|
|
return ctx
|
|
}
|
|
|
|
if info, ok := tmpl.(identity.IdentityProvider); ok {
|
|
idm.AddIdentity(info.GetIdentity())
|
|
}
|
|
|
|
// The receive is the "." in the method execution or map lookup, e.g. the Page in .Resources.
|
|
if hreflect.IsValid(receiver) {
|
|
in := receiver.Interface()
|
|
|
|
if idlp, ok := in.(identity.ForEeachIdentityByNameProvider); ok {
|
|
// This will skip repeated .RelPermalink usage on transformed resources
|
|
// which is not fingerprinted, e.g. to
|
|
// prevent all HTML pages to be re-rendered on a small CSS change.
|
|
idlp.ForEeachIdentityByName(name, func(id identity.Identity) bool {
|
|
idm.AddIdentity(id)
|
|
return false
|
|
})
|
|
} else {
|
|
identity.WalkIdentitiesShallow(in, func(level int, id identity.Identity) bool {
|
|
idm.AddIdentity(id)
|
|
return false
|
|
})
|
|
}
|
|
}
|
|
|
|
return ctx
|
|
}
|
|
|
|
func newTemplateExecuter(d *deps.Deps) (texttemplate.Executer, map[string]reflect.Value) {
|
|
funcs := createFuncMap(d)
|
|
funcsv := make(map[string]reflect.Value)
|
|
|
|
for k, v := range funcs {
|
|
vv := reflect.ValueOf(v)
|
|
funcsv[k] = vv
|
|
}
|
|
|
|
// Duplicate Go's internal funcs here for faster lookups.
|
|
for k, v := range template.GoFuncs {
|
|
if _, exists := funcsv[k]; !exists {
|
|
vv, ok := v.(reflect.Value)
|
|
if !ok {
|
|
vv = reflect.ValueOf(v)
|
|
}
|
|
funcsv[k] = vv
|
|
}
|
|
}
|
|
|
|
for k, v := range texttemplate.GoFuncs {
|
|
if _, exists := funcsv[k]; !exists {
|
|
funcsv[k] = v
|
|
}
|
|
}
|
|
|
|
exeHelper := &templateExecHelper{
|
|
running: d.Conf.Running(),
|
|
funcs: funcsv,
|
|
site: reflect.ValueOf(d.Site),
|
|
siteParams: reflect.ValueOf(d.Site.Params()),
|
|
}
|
|
|
|
return texttemplate.NewExecuter(
|
|
exeHelper,
|
|
), funcsv
|
|
}
|
|
|
|
func createFuncMap(d *deps.Deps) map[string]any {
|
|
funcMap := template.FuncMap{}
|
|
|
|
// Merge the namespace funcs
|
|
for _, nsf := range internal.TemplateFuncsNamespaceRegistry {
|
|
ns := nsf(d)
|
|
if _, exists := funcMap[ns.Name]; exists {
|
|
panic(ns.Name + " is a duplicate template func")
|
|
}
|
|
funcMap[ns.Name] = ns.Context
|
|
for _, mm := range ns.MethodMappings {
|
|
for _, alias := range mm.Aliases {
|
|
if _, exists := funcMap[alias]; exists {
|
|
panic(alias + " is a duplicate template func")
|
|
}
|
|
funcMap[alias] = mm.Method
|
|
}
|
|
}
|
|
}
|
|
|
|
if d.OverloadedTemplateFuncs != nil {
|
|
for k, v := range d.OverloadedTemplateFuncs {
|
|
funcMap[k] = v
|
|
}
|
|
}
|
|
|
|
return funcMap
|
|
}
|