Delegees

Author: bep

go.mod

@@ -22,6 +22,7 @@ require (
 	github.com/bep/overlayfs v0.10.0
 	github.com/bep/simplecobra v0.6.0
 	github.com/bep/tmc v0.5.1
+	github.com/bits-and-blooms/bitset v1.22.0
 	github.com/cespare/xxhash/v2 v2.3.0
 	github.com/clbanning/mxj/v2 v2.7.0
 	github.com/disintegration/gift v1.2.1
@@ -118,7 +119,6 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/ssooidc v1.26.4 // indirect
 	github.com/aws/aws-sdk-go-v2/service/sts v1.30.3 // indirect
 	github.com/aws/smithy-go v1.22.2 // indirect
-	github.com/bits-and-blooms/bitset v1.22.0 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect
 	github.com/dlclark/regexp2 v1.11.5 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect

hugolib/content_map.go

@@ -97,6 +97,10 @@ func (r *resourceSource) GetIdentity() identity.Identity {
 	return r.path
 }
 
+func (p *resourceSource) matchDirectOrInDelegees(doctree.Dimensions) contentNodeI {
+	panic("not implemented")
+}
+
 func (r *resourceSource) ForEeachIdentity(f func(identity.Identity) bool) bool {
 	return f(r.GetIdentity())
 }
@@ -137,6 +141,10 @@ func (n resourceSources) resetBuildState() {
 	}
 }
 
+func (n resourceSources) matchDirectOrInDelegees(doctree.Dimensions) contentNodeI {
+	panic("not implemented")
+}
+
 func (n resourceSources) GetIdentity() identity.Identity {
 	for _, r := range n {
 		if r != nil {

hugolib/content_map_page.go

@@ -17,6 +17,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"iter"
 	"path"
 	"sort"
 	"strconv"
@@ -367,8 +368,9 @@ func (m *pageMap) getPagesInSection(q pageMapQueryPagesInSection) page.Pages {
 		}
 
 		w := &doctree.NodeShiftTreeWalker[contentNodeI]{
-			Tree:   m.treePages,
-			Prefix: prefix,
+			Tree:            m.treePages,
+			Prefix:          prefix,
+			DelegeeFallback: true,
 		}
 
 		w.Handle = func(key string, n contentNodeI, match doctree.DimensionFlag) (bool, error) {
@@ -649,6 +651,7 @@ type contentNodeI interface {
 	identity.ForEeachIdentityProvider
 	Path() string
 	isContentNodeBranch() bool
+	matchDirectOrInDelegees(doctree.Dimensions) contentNodeI
 	buildStateReseter
 	resource.StaleMarker
 }
@@ -672,6 +675,10 @@ func (n contentNodeIs) isContentNodeBranch() bool {
 	return n.one().isContentNodeBranch()
 }
 
+func (p contentNodeIs) matchDirectOrInDelegees(doctree.Dimensions) contentNodeI {
+	panic("not implemented")
+}
+
 func (n contentNodeIs) GetIdentity() identity.Identity {
 	return n.one().GetIdentity()
 }
@@ -750,8 +757,18 @@ func (s *contentNodeShifter) Delete(n contentNodeI, dimension doctree.Dimensions
 	}
 }
 
-func (s *contentNodeShifter) Shift(n contentNodeI, dims doctree.Dimensions, exact bool) (contentNodeI, bool, doctree.DimensionFlag) {
-	// How accurate is the match.
+func (s *contentNodeShifter) findDelegee(q doctree.Dimensions, candidates iter.Seq[contentNodeI]) contentNodeI {
+	for n := range candidates {
+		if nn := n.matchDirectOrInDelegees(q); nn != nil {
+			return nn
+		}
+	}
+	return nil
+}
+
+func (s *contentNodeShifter) Shift(n contentNodeI, dims doctree.Dimensions, exact, delegeeFallback bool) (contentNodeI, bool, doctree.DimensionFlag) {
+	// dims: language, version and role
+	// How accurate is the match. TODO1 revise this.
 	accuracy := doctree.DimensionLanguage
 	switch v := n.(type) {
 	case contentNodeIs:
@@ -762,6 +779,20 @@ func (s *contentNodeShifter) Shift(n contentNodeI, dims doctree.Dimensions, exac
 		if vv != nil {
 			return vv, true, accuracy
 		}
+		if !delegeeFallback {
+			return nil, false, 0
+		}
+		iter := func(yield func(n contentNodeI) bool) {
+			for _, nn := range v {
+				if !yield(nn) {
+					return
+				}
+			}
+		}
+		if vv = s.findDelegee(dims, iter); vv != nil {
+			fmt.Println(n.Path(), "found delegee", dims, vv) // TODO1
+			return vv, true, accuracy
+		}
 		return nil, false, 0
 	case resourceSources:
 		vv := v[dims]
@@ -1050,7 +1081,7 @@ func (m *pageMap) debugPrint(prefix string, maxLevel int, w io.Writer) {
 
 		resourceWalker.Handle = func(ss string, n contentNodeI, match doctree.DimensionFlag) (bool, error) {
 			if isBranch {
-				ownerKey, _ := pageWalker.Tree.LongestPrefix(ss, true, nil)
+				ownerKey, _ := pageWalker.Tree.LongestPrefix(ss, true, false, nil)
 				if ownerKey != keyPage {
 					// Stop walking downwards, someone else owns this resource.
 					pageWalker.SkipPrefix(ownerKey + "/")
@@ -1500,7 +1531,7 @@ func (sa *sitePagesAssembler) applyAggregates() error {
 
 		rw.Handle = func(resourceKey string, n contentNodeI, match doctree.DimensionFlag) (bool, error) {
 			if isBranch {
-				ownerKey, _ := pw.Tree.LongestPrefix(resourceKey, true, nil)
+				ownerKey, _ := pw.Tree.LongestPrefix(resourceKey, true, false, nil)
 				if ownerKey != keyPage {
 					// Stop walking downwards, someone else owns this resource.
 					rw.SkipPrefix(ownerKey + "/")

hugolib/doctree/nodeshifttree.go

@@ -54,7 +54,7 @@ type (
 		// Shift shifts T into the given dimension
 		// and returns the shifted T and a bool indicating if the shift was successful and
 		// how accurate a match T is according to its dimensions.
-		Shift(v T, dimension Dimensions, exact bool) (T, bool, DimensionFlag)
+		Shift(v T, dimension Dimensions, exact, delegeeFallback bool) (T, bool, DimensionFlag)
 	}
 )
 
@@ -226,12 +226,12 @@ func (t *NodeShiftTree[T]) Lock(writable bool) (commit func()) {
 
 // LongestPrefix finds the longest prefix of s that exists in the tree that also matches the predicate (if set).
 // Set exact to true to only match exact in the current dimension (e.g. language).
-func (r *NodeShiftTree[T]) LongestPrefix(s string, exact bool, predicate func(v T) bool) (string, T) {
+func (r *NodeShiftTree[T]) LongestPrefix(s string, exact, delegeeFallback bool, predicate func(v T) bool) (string, T) {
 	for {
 		longestPrefix, v, found := r.tree.LongestPrefix(s)
 
 		if found {
-			if t, ok, _ := r.shift(v.(T), exact); ok && (predicate == nil || predicate(t)) {
+			if t, ok, _ := r.shift(v.(T), exact, delegeeFallback); ok && (predicate == nil || predicate(t)) {
 				return longestPrefix, t
 			}
 		}
@@ -317,6 +317,9 @@ type NodeShiftTreeWalker[T any] struct {
 	// Don't fall back to alternative dimensions (e.g. language).
 	Exact bool
 
+	// TODO1 document this and check vs exact.
+	DelegeeFallback bool
+
 	// Used in development only.
 	Debug bool
 
@@ -408,7 +411,7 @@ func (r *NodeShiftTreeWalker[T]) toT(tree *NodeShiftTree[T], v any) (t T, ok boo
 		t = v.(T)
 		ok = true
 	} else {
-		t, ok, exact = tree.shift(v.(T), r.Exact)
+		t, ok, exact = tree.shift(v.(T), r.Exact, r.DelegeeFallback)
 	}
 	return
 }
@@ -422,10 +425,10 @@ func (t NodeShiftTree[T]) clone() *NodeShiftTree[T] {
 	return &t
 }
 
-func (r *NodeShiftTree[T]) shift(t T, exact bool) (T, bool, DimensionFlag) {
+func (r *NodeShiftTree[T]) shift(t T, exact, delegeeFallback bool) (T, bool, DimensionFlag) {
 	// TODO1 exact.
 	exact = true
-	return r.shifter.Shift(t, r.dims, exact)
+	return r.shifter.Shift(t, r.dims, exact, delegeeFallback)
 }
 
 func (r *NodeShiftTree[T]) get(s string) (T, bool) {
@@ -435,7 +438,7 @@ func (r *NodeShiftTree[T]) get(s string) (T, bool) {
 		var t T
 		return t, false
 	}
-	t, ok, _ := r.shift(v.(T), true)
+	t, ok, _ := r.shift(v.(T), true, false) // TODO1
 	return t, ok
 }
 

hugolib/page.go

@@ -44,6 +44,7 @@ import (
 	"github.com/gohugoio/hugo/common/text"
 	"github.com/gohugoio/hugo/resources/kinds"
 	"github.com/gohugoio/hugo/resources/page"
+	"github.com/gohugoio/hugo/resources/page/pagemeta"
 	"github.com/gohugoio/hugo/resources/resource"
 )
 
@@ -218,6 +219,21 @@ func (p *pageState) isContentNodeBranch() bool {
 	return p.IsNode()
 }
 
+func (p *pageState) matchDirectOrInDelegees(dims doctree.Dimensions) contentNodeI {
+	pc := p.m.pageConfig
+	if !pagemeta.MatchLanguageOrLanguageDelegee(pc, dims) {
+		return nil
+	}
+	if !pagemeta.MatchVersionOrVersionDelegee(pc, dims) {
+		return nil
+	}
+	if !pagemeta.MatchRoleOrRoleDelegee(pc, dims) {
+		return nil
+	}
+	fmt.Println(p.Path(), p.s.dims, "====>", dims, pc.LanguagesCompiledSet, pc.VersionsCompiledSet, pc.RolesCompiledSet)
+	return p
+}
+
 // Eq returns whether the current page equals the given page.
 // This is what's invoked when doing `{{ if eq $page $otherPage }}`
 func (p *pageState) Eq(other any) bool {

hugolib/page__meta.go

@@ -268,13 +268,11 @@ func (p *pageMeta) setMetaPre(pi *contentParseInfo, logger loggers.Logger, conf
 		// Look for path, lang, roles and kind, all of which values we need early on.
 		if v, found := frontmatter["path"]; found {
 			pcfg.Path = paths.ToSlashPreserveLeading(cast.ToString(v))
-			pcfg.Params["path"] = pcfg.Path
 		}
 		if v, found := frontmatter["lang"]; found {
 			lang := strings.ToLower(cast.ToString(v))
 			if _, ok := conf.PathParser().LanguageIndex[lang]; ok {
 				pcfg.Lang = lang
-				pcfg.Params["lang"] = pcfg.Lang
 			}
 		}
 		if v, found := frontmatter["kind"]; found {
@@ -284,20 +282,25 @@ func (p *pageMeta) setMetaPre(pi *contentParseInfo, logger loggers.Logger, conf
 				if pcfg.Kind == "" {
 					return fmt.Errorf("unknown kind %q in front matter", s)
 				}
-				pcfg.Params["kind"] = pcfg.Kind
 			}
 		}
 		if v, found := frontmatter["roles"]; found {
 			pcfg.Roles = cast.ToStringSlice(v)
-			pcfg.Params["roles"] = pcfg.Roles
 		}
 		if v, found := frontmatter["versions"]; found {
 			pcfg.Versions = cast.ToStringSlice(v)
-			pcfg.Params["versions"] = pcfg.Versions
 		}
 		if v, found := frontmatter["languages"]; found {
 			pcfg.Languages = cast.ToStringSlice(v)
-			pcfg.Params["languages"] = pcfg.Languages
+		}
+		if v, found := frontmatter["languagedelegees"]; found {
+			pcfg.LanguageDelegees = cast.ToStringSlice(v)
+		}
+		if v, found := frontmatter["versiondelegees"]; found {
+			pcfg.VersionDelegees = cast.ToStringSlice(v)
+		}
+		if v, found := frontmatter["roledelegees"]; found {
+			pcfg.RoleDelegees = cast.ToStringSlice(v)
 		}
 
 	} else if p.pageMetaParams.pageConfig.Params == nil {

hugolib/page__tree.go

@@ -66,7 +66,7 @@ func (pt pageTree) CurrentSection() page.Page {
 		return pt.p.s.home
 	}
 
-	_, n := pt.p.s.pageMap.treePages.LongestPrefix(dir, true, func(n contentNodeI) bool { return n.isContentNodeBranch() })
+	_, n := pt.p.s.pageMap.treePages.LongestPrefix(dir, true, false, func(n contentNodeI) bool { return n.isContentNodeBranch() })
 	if n != nil {
 		return n.(page.Page)
 	}
@@ -81,7 +81,7 @@ func (pt pageTree) FirstSection() page.Page {
 	}
 
 	for {
-		k, n := pt.p.s.pageMap.treePages.LongestPrefix(s, true, func(n contentNodeI) bool { return n.isContentNodeBranch() })
+		k, n := pt.p.s.pageMap.treePages.LongestPrefix(s, true, false, func(n contentNodeI) bool { return n.isContentNodeBranch() })
 		if n == nil {
 			return nil
 		}
@@ -125,7 +125,7 @@ func (pt pageTree) Parent() page.Page {
 	}
 
 	for {
-		_, n := pt.p.s.pageMap.treePages.LongestPrefix(dir, true, nil)
+		_, n := pt.p.s.pageMap.treePages.LongestPrefix(dir, true, false, nil)
 		if n == nil {
 			return pt.p.s.home
 		}

hugolib/roles/roles_integration_test.go

@@ -72,12 +72,12 @@ title: "Public v3"
 versions: ["v3.*"]
 ---
 Users with guest role will see this.
--- layouts/home.html --
+-- layouts/all.html --
 Role: {{ .Site.Role.Name }}|Version: {{ .Site.Version.Name }}|Lang: {{ .Site.Language.Lang }}|
 Roles: {{ range .Site.Roles }}Name: {{ .Name }} Site.Version: {{.Site.Version.Name }} Site.Language.Lang: {{ .Site.Language.Lang}}|{{ end }}$
 Versions: {{ range site.Versions }}Name: {{ .Name }} Site.Role: {{ .Site.Role.Name }} Site.Language.Lang: {{ .Site.Language.Lang }}|{{ end }}$
--- layouts/page.html --
-{{ .Title }}|{{ .Content }}|{{ .Site.Version.Name }}|{{ .Site.Role.Name }}|
+RegularPages: {{ range .RegularPages }}{{ .RelPermalink }} r: {{ .Site.Language.Name }}  v: {{ .Site.Version.Name }} l: {{ .Site.Role.Name }}|{{ end }}$
+
 `
 
 	b := hugolib.Test(t, files)
@@ -96,4 +96,6 @@ Versions: {{ range site.Versions }}Name: {{ .Name }} Site.Role: {{ .Site.Role.Na
 		"Role: guest|Version: v2.0.0|",
 		"Roles: Name: member Site.Version: v2.0.0 Site.Language.Lang: en|Name: guest Site.Version: v2.0.0 Site.Language.Lang: en|$",
 		"Versions: Name: v3.0.0 Site.Role: guest Site.Language.Lang: en|Name: v2.1.0 Site.Role: guest Site.Language.Lang: en|Name: v2.0.0 Site.Role: guest Site.Language.Lang: en|Name: v1.2.3 Site.Role: guest Site.Language.Lang: en|$")
+
+	// b.AssertFileContent("public/guest/v3.0.0/en/index.html", "asdf")
 }

langs/language.go

@@ -32,7 +32,8 @@ import (
 
 type Language struct {
 	// The language code, e.g. "en" or "no".
-	// This is currently only settable as the key in the language map in the config.
+	// This is the key used in the languages map in the configuration,
+	// and currently only settable as the key in the language map in the config.
 	Lang string
 
 	// Fields from the language config.
@@ -55,6 +56,11 @@ type Language struct {
 	params maps.Params
 }
 
+// Name is an alias for Lang.
+func (l *Language) Name() string {
+	return l.Lang
+}
+
 // TODO1 add Site.
 
 // NewLanguage creates a new language.