mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-04 16:21:57 +00:00
631d768be9
We do lazy initialization and (potentially) reuse of an output format's rendered content. We do this evaluation when we start a new rendering a new output format. There are, however, situation where these borders gets crossed (e.g. accessing content from another output format). We have a check for this in place for most cases, but not the content rendering of inner markdown blocks inside shortcodes. This patch applies that same logic to the newly introduced RenderContent method (which is not available from the templates). Fixes #10391
533 lines
8.7 KiB
Go
533 lines
8.7 KiB
Go
// Copyright 2019 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 page contains the core interfaces and types for the Page resource,
|
|
// a core component in Hugo.
|
|
package page
|
|
|
|
import (
|
|
"bytes"
|
|
"html/template"
|
|
"time"
|
|
|
|
"github.com/gohugoio/hugo/identity"
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
|
|
"github.com/gohugoio/hugo/hugofs/files"
|
|
"github.com/gohugoio/hugo/tpl"
|
|
|
|
"github.com/gohugoio/hugo/hugofs"
|
|
|
|
"github.com/bep/gitmap"
|
|
"github.com/gohugoio/hugo/navigation"
|
|
|
|
"github.com/gohugoio/hugo/common/hugo"
|
|
"github.com/gohugoio/hugo/common/maps"
|
|
"github.com/gohugoio/hugo/source"
|
|
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/langs"
|
|
"github.com/gohugoio/hugo/media"
|
|
"github.com/gohugoio/hugo/related"
|
|
"github.com/gohugoio/hugo/resources/resource"
|
|
)
|
|
|
|
var (
|
|
NopPage Page = new(nopPage)
|
|
NopContentRenderer ContentRenderer = new(nopContentRenderer)
|
|
NopCPageContentRenderer = struct {
|
|
OutputFormatPageContentProvider
|
|
ContentRenderer
|
|
}{
|
|
NopPage,
|
|
NopContentRenderer,
|
|
}
|
|
NilPage *nopPage
|
|
)
|
|
|
|
// PageNop implements Page, but does nothing.
|
|
type nopPage int
|
|
|
|
func (p *nopPage) Err() resource.ResourceError {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Aliases() []string {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Sitemap() config.Sitemap {
|
|
return config.Sitemap{}
|
|
}
|
|
|
|
func (p *nopPage) Layout() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) RSSLink() template.URL {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Author() Author {
|
|
return Author{}
|
|
}
|
|
|
|
func (p *nopPage) Authors() AuthorList {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) AllTranslations() Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) LanguagePrefix() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) AlternativeOutputFormats() OutputFormats {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) BaseFileName() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) BundleType() files.ContentClass {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Content() (any, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) ContentBaseName() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) CurrentSection() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Data() any {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Date() (t time.Time) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) Description() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) RefFrom(argsm map[string]any, source any) (string, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) RelRefFrom(argsm map[string]any, source any) (string, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) Dir() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Draft() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) Eq(other any) bool {
|
|
return p == other
|
|
}
|
|
|
|
func (p *nopPage) ExpiryDate() (t time.Time) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) Ext() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Extension() string {
|
|
return ""
|
|
}
|
|
|
|
var nilFile *source.FileInfo
|
|
|
|
func (p *nopPage) File() source.File {
|
|
return nilFile
|
|
}
|
|
|
|
func (p *nopPage) FileInfo() hugofs.FileMetaInfo {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Filename() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) FirstSection() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) FuzzyWordCount() int {
|
|
return 0
|
|
}
|
|
|
|
func (p *nopPage) GetPage(ref string) (Page, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (p *nopPage) GetPageWithTemplateInfo(info tpl.Info, ref string) (Page, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (p *nopPage) GetParam(key string) any {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) GetTerms(taxonomy string) Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) GitInfo() *gitmap.GitInfo {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) CodeOwners() []string {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) HasMenuCurrent(menuID string, me *navigation.MenuEntry) bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) HasShortcode(name string) bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) Hugo() (h hugo.Info) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) InSection(other any) (bool, error) {
|
|
return false, nil
|
|
}
|
|
|
|
func (p *nopPage) IsAncestor(other any) (bool, error) {
|
|
return false, nil
|
|
}
|
|
|
|
func (p *nopPage) IsDescendant(other any) (bool, error) {
|
|
return false, nil
|
|
}
|
|
|
|
func (p *nopPage) IsDraft() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) IsHome() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) IsMenuCurrent(menuID string, inme *navigation.MenuEntry) bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) IsNode() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) IsPage() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) IsSection() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) IsTranslated() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) Keywords() []string {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Kind() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Lang() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Language() *langs.Language {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Lastmod() (t time.Time) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) Len() int {
|
|
return 0
|
|
}
|
|
|
|
func (p *nopPage) LinkTitle() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) LogicalName() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) MediaType() (m media.Type) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) Menus() (m navigation.PageMenus) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) Name() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Next() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) OutputFormats() OutputFormats {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Pages() Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) RegularPages() Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) RegularPagesRecursive() Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Paginate(seq any, options ...any) (*Pager, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (p *nopPage) Paginator(options ...any) (*Pager, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (p *nopPage) Param(key any) (any, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (p *nopPage) Params() maps.Params {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Page() Page {
|
|
return p
|
|
}
|
|
|
|
func (p *nopPage) Parent() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Path() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Pathc() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Permalink() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Plain() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) PlainWords() []string {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Prev() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) PublishDate() (t time.Time) {
|
|
return
|
|
}
|
|
|
|
func (p *nopPage) PrevInSection() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) NextInSection() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) PrevPage() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) NextPage() Page {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) RawContent() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) ReadingTime() int {
|
|
return 0
|
|
}
|
|
|
|
func (p *nopPage) Ref(argsm map[string]any) (string, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) RelPermalink() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) RelRef(argsm map[string]any) (string, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) Render(layout ...string) (template.HTML, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) RenderString(args ...any) (template.HTML, error) {
|
|
return "", nil
|
|
}
|
|
|
|
func (p *nopPage) ResourceType() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Resources() resource.Resources {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Scratch() *maps.Scratch {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Store() *maps.Scratch {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (p *nopPage) Section() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Sections() Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) SectionsEntries() []string {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) SectionsPath() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Site() Site {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Sites() Sites {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Slug() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) String() string {
|
|
return "nopPage"
|
|
}
|
|
|
|
func (p *nopPage) Summary() template.HTML {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) TableOfContents() template.HTML {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Title() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) TranslationBaseName() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) TranslationKey() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Translations() Pages {
|
|
return nil
|
|
}
|
|
|
|
func (p *nopPage) Truncated() bool {
|
|
return false
|
|
}
|
|
|
|
func (p *nopPage) Type() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) URL() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) UniqueID() string {
|
|
return ""
|
|
}
|
|
|
|
func (p *nopPage) Weight() int {
|
|
return 0
|
|
}
|
|
|
|
func (p *nopPage) WordCount() int {
|
|
return 0
|
|
}
|
|
|
|
func (p *nopPage) GetIdentity() identity.Identity {
|
|
return identity.NewPathIdentity("content", "foo/bar.md")
|
|
}
|
|
|
|
type nopContentRenderer int
|
|
|
|
func (r *nopContentRenderer) RenderContent(content []byte, renderTOC bool) (converter.Result, error) {
|
|
b := &bytes.Buffer{}
|
|
return b, nil
|
|
}
|