mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
341 lines
8.8 KiB
Go
341 lines
8.8 KiB
Go
// Copyright 2016 The Hugo Authors. All rights reserved.
|
|
//
|
|
// 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 hugolib
|
|
|
|
import (
|
|
"fmt"
|
|
"path"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/gohugoio/hugo/cache"
|
|
"github.com/gohugoio/hugo/helpers"
|
|
)
|
|
|
|
// PageCollections contains the page collections for a site.
|
|
type PageCollections struct {
|
|
// Includes only pages of all types, and only pages in the current language.
|
|
Pages Pages
|
|
|
|
// Includes all pages in all languages, including the current one.
|
|
// Includes pages of all types.
|
|
AllPages Pages
|
|
|
|
// A convenience cache for the traditional index types, taxonomies, home page etc.
|
|
// This is for the current language only.
|
|
indexPages Pages
|
|
|
|
// A convenience cache for the regular pages.
|
|
// This is for the current language only.
|
|
RegularPages Pages
|
|
|
|
// A convenience cache for the all the regular pages.
|
|
AllRegularPages Pages
|
|
|
|
// Includes absolute all pages (of all types), including drafts etc.
|
|
rawAllPages Pages
|
|
|
|
// Includes headless bundles, i.e. bundles that produce no output for its content page.
|
|
headlessPages Pages
|
|
|
|
pageIndex *cache.Lazy
|
|
}
|
|
|
|
// Get initializes the index if not already done so, then
|
|
// looks up the given page ref, returns nil if no value found.
|
|
func (c *PageCollections) getFromCache(ref string) (*Page, error) {
|
|
v, found, err := c.pageIndex.Get(ref)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if !found {
|
|
return nil, nil
|
|
}
|
|
|
|
p := v.(*Page)
|
|
|
|
if p != ambiguityFlag {
|
|
return p, nil
|
|
}
|
|
return nil, fmt.Errorf("page reference %q is ambiguous", ref)
|
|
}
|
|
|
|
var ambiguityFlag = &Page{Kind: kindUnknown, title: "ambiguity flag"}
|
|
|
|
func (c *PageCollections) refreshPageCaches() {
|
|
c.indexPages = c.findPagesByKindNotIn(KindPage, c.Pages)
|
|
c.RegularPages = c.findPagesByKindIn(KindPage, c.Pages)
|
|
c.AllRegularPages = c.findPagesByKindIn(KindPage, c.AllPages)
|
|
|
|
indexLoader := func() (map[string]interface{}, error) {
|
|
index := make(map[string]interface{})
|
|
|
|
add := func(ref string, p *Page) {
|
|
existing := index[ref]
|
|
if existing == nil {
|
|
index[ref] = p
|
|
} else if existing != ambiguityFlag && existing != p {
|
|
index[ref] = ambiguityFlag
|
|
}
|
|
}
|
|
|
|
for _, pageCollection := range []Pages{c.RegularPages, c.headlessPages} {
|
|
for _, p := range pageCollection {
|
|
sourceRef := p.absoluteSourceRef()
|
|
|
|
if sourceRef != "" {
|
|
// index the canonical ref
|
|
// e.g. /section/article.md
|
|
add(sourceRef, p)
|
|
}
|
|
|
|
// Ref/Relref supports this potentially ambiguous lookup.
|
|
add(p.Source.LogicalName(), p)
|
|
|
|
translationBaseName := p.Source.TranslationBaseName()
|
|
|
|
dir, _ := path.Split(sourceRef)
|
|
dir = strings.TrimSuffix(dir, "/")
|
|
|
|
if translationBaseName == "index" {
|
|
add(dir, p)
|
|
add(path.Base(dir), p)
|
|
} else {
|
|
add(translationBaseName, p)
|
|
}
|
|
|
|
// We need a way to get to the current language version.
|
|
pathWithNoExtensions := path.Join(dir, translationBaseName)
|
|
add(pathWithNoExtensions, p)
|
|
}
|
|
}
|
|
|
|
for _, p := range c.indexPages {
|
|
// index the canonical, unambiguous ref for any backing file
|
|
// e.g. /section/_index.md
|
|
sourceRef := p.absoluteSourceRef()
|
|
if sourceRef != "" {
|
|
add(sourceRef, p)
|
|
}
|
|
|
|
ref := path.Join(p.sections...)
|
|
|
|
// index the canonical, unambiguous virtual ref
|
|
// e.g. /section
|
|
// (this may already have been indexed above)
|
|
add("/"+ref, p)
|
|
}
|
|
|
|
return index, nil
|
|
}
|
|
|
|
c.pageIndex = cache.NewLazy(indexLoader)
|
|
}
|
|
|
|
func newPageCollections() *PageCollections {
|
|
return &PageCollections{}
|
|
}
|
|
|
|
func newPageCollectionsFromPages(pages Pages) *PageCollections {
|
|
return &PageCollections{rawAllPages: pages}
|
|
}
|
|
|
|
// This is an adapter func for the old API with Kind as first argument.
|
|
// This is invoked when you do .Site.GetPage. We drop the Kind and fails
|
|
// if there are more than 2 arguments, which would be ambigous.
|
|
func (c *PageCollections) getPageOldVersion(ref ...string) (*Page, error) {
|
|
var refs []string
|
|
for _, r := range ref {
|
|
// A common construct in the wild is
|
|
// .Site.GetPage "home" "" or
|
|
// .Site.GetPage "home" "/"
|
|
if r != "" && r != "/" {
|
|
refs = append(refs, r)
|
|
}
|
|
}
|
|
|
|
var key string
|
|
|
|
if len(refs) > 2 {
|
|
// This was allowed in Hugo <= 0.44, but we cannot support this with the
|
|
// new API. This should be the most unusual case.
|
|
return nil, fmt.Errorf(`too many arguments to .Site.GetPage: %v. Use lookups on the form {{ .Site.GetPage "/posts/mypage-md" }}`, ref)
|
|
}
|
|
|
|
if len(refs) == 0 || refs[0] == KindHome {
|
|
key = "/"
|
|
} else if len(refs) == 1 {
|
|
if len(ref) == 2 && refs[0] == KindSection {
|
|
// This is an old style reference to the "Home Page section".
|
|
// Typically fetched via {{ .Site.GetPage "section" .Section }}
|
|
// See https://github.com/gohugoio/hugo/issues/4989
|
|
key = "/"
|
|
} else {
|
|
key = refs[0]
|
|
}
|
|
} else {
|
|
key = refs[1]
|
|
}
|
|
|
|
key = filepath.ToSlash(key)
|
|
if !strings.HasPrefix(key, "/") {
|
|
key = "/" + key
|
|
}
|
|
|
|
return c.getPageNew(nil, key)
|
|
}
|
|
|
|
// Only used in tests.
|
|
func (c *PageCollections) getPage(typ string, sections ...string) *Page {
|
|
refs := append([]string{typ}, path.Join(sections...))
|
|
p, _ := c.getPageOldVersion(refs...)
|
|
return p
|
|
}
|
|
|
|
// Ref is either unix-style paths (i.e. callers responsible for
|
|
// calling filepath.ToSlash as necessary) or shorthand refs.
|
|
func (c *PageCollections) getPageNew(context *Page, ref string) (*Page, error) {
|
|
var anError error
|
|
|
|
// Absolute (content root relative) reference.
|
|
if strings.HasPrefix(ref, "/") {
|
|
p, err := c.getFromCache(ref)
|
|
if err == nil && p != nil {
|
|
return p, nil
|
|
}
|
|
if err != nil {
|
|
anError = err
|
|
}
|
|
|
|
} else if context != nil {
|
|
// Try the page-relative path.
|
|
ppath := path.Join("/", strings.Join(context.sections, "/"), ref)
|
|
p, err := c.getFromCache(ppath)
|
|
if err == nil && p != nil {
|
|
return p, nil
|
|
}
|
|
if err != nil {
|
|
anError = err
|
|
}
|
|
}
|
|
|
|
if !strings.HasPrefix(ref, "/") {
|
|
// Many people will have "post/foo.md" in their content files.
|
|
p, err := c.getFromCache("/" + ref)
|
|
if err == nil && p != nil {
|
|
if context != nil {
|
|
// TODO(bep) remove this case and the message below when the storm has passed
|
|
helpers.DistinctFeedbackLog.Printf(`WARNING: make non-relative ref/relref page reference(s) in page %q absolute, e.g. {{< ref "/blog/my-post.md" >}}`, context.absoluteSourceRef())
|
|
}
|
|
return p, nil
|
|
}
|
|
if err != nil {
|
|
anError = err
|
|
}
|
|
}
|
|
|
|
// Last try.
|
|
ref = strings.TrimPrefix(ref, "/")
|
|
p, err := c.getFromCache(ref)
|
|
if err != nil {
|
|
anError = err
|
|
}
|
|
|
|
if p == nil && anError != nil {
|
|
if context != nil {
|
|
return nil, fmt.Errorf("failed to resolve path from page %q: %s", context.absoluteSourceRef(), anError)
|
|
}
|
|
return nil, fmt.Errorf("failed to resolve page: %s", anError)
|
|
}
|
|
|
|
return p, nil
|
|
}
|
|
|
|
func (*PageCollections) findPagesByKindIn(kind string, inPages Pages) Pages {
|
|
var pages Pages
|
|
for _, p := range inPages {
|
|
if p.Kind == kind {
|
|
pages = append(pages, p)
|
|
}
|
|
}
|
|
return pages
|
|
}
|
|
|
|
func (*PageCollections) findFirstPageByKindIn(kind string, inPages Pages) *Page {
|
|
for _, p := range inPages {
|
|
if p.Kind == kind {
|
|
return p
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (*PageCollections) findPagesByKindNotIn(kind string, inPages Pages) Pages {
|
|
var pages Pages
|
|
for _, p := range inPages {
|
|
if p.Kind != kind {
|
|
pages = append(pages, p)
|
|
}
|
|
}
|
|
return pages
|
|
}
|
|
|
|
func (c *PageCollections) findPagesByKind(kind string) Pages {
|
|
return c.findPagesByKindIn(kind, c.Pages)
|
|
}
|
|
|
|
func (c *PageCollections) addPage(page *Page) {
|
|
c.rawAllPages = append(c.rawAllPages, page)
|
|
}
|
|
|
|
func (c *PageCollections) removePageFilename(filename string) {
|
|
if i := c.rawAllPages.findPagePosByFilename(filename); i >= 0 {
|
|
c.clearResourceCacheForPage(c.rawAllPages[i])
|
|
c.rawAllPages = append(c.rawAllPages[:i], c.rawAllPages[i+1:]...)
|
|
}
|
|
|
|
}
|
|
|
|
func (c *PageCollections) removePage(page *Page) {
|
|
if i := c.rawAllPages.findPagePos(page); i >= 0 {
|
|
c.clearResourceCacheForPage(c.rawAllPages[i])
|
|
c.rawAllPages = append(c.rawAllPages[:i], c.rawAllPages[i+1:]...)
|
|
}
|
|
|
|
}
|
|
|
|
func (c *PageCollections) findPagesByShortcode(shortcode string) Pages {
|
|
var pages Pages
|
|
|
|
for _, p := range c.rawAllPages {
|
|
if p.shortcodeState != nil {
|
|
if _, ok := p.shortcodeState.nameSet[shortcode]; ok {
|
|
pages = append(pages, p)
|
|
}
|
|
}
|
|
}
|
|
return pages
|
|
}
|
|
|
|
func (c *PageCollections) replacePage(page *Page) {
|
|
// will find existing page that matches filepath and remove it
|
|
c.removePage(page)
|
|
c.addPage(page)
|
|
}
|
|
|
|
func (c *PageCollections) clearResourceCacheForPage(page *Page) {
|
|
if len(page.Resources) > 0 {
|
|
page.s.ResourceSpec.DeleteCacheByPrefix(page.relTargetPathBase)
|
|
}
|
|
}
|