mirror of
https://github.com/gohugoio/hugo.git
synced 2024-05-19 07:42:48 +00:00
Compare commits
4 commits
17202b5484
...
67d63b90dc
Author | SHA1 | Date | |
---|---|---|---|
67d63b90dc | |||
503d20954f | |||
b5c5a8bd76 | |||
c9e679075f |
34
cache/dynacache/dynacache.go
vendored
34
cache/dynacache/dynacache.go
vendored
|
@ -385,13 +385,37 @@ type Partition[K comparable, V any] struct {
|
|||
|
||||
// GetOrCreate gets or creates a value for the given key.
|
||||
func (p *Partition[K, V]) GetOrCreate(key K, create func(key K) (V, error)) (V, error) {
|
||||
v, err := p.doGetOrCreate(key, create)
|
||||
if err != nil {
|
||||
return p.zero, err
|
||||
}
|
||||
if resource.StaleVersion(v) > 0 {
|
||||
p.c.Delete(key)
|
||||
return p.doGetOrCreate(key, create)
|
||||
}
|
||||
return v, err
|
||||
}
|
||||
|
||||
func (p *Partition[K, V]) doGetOrCreate(key K, create func(key K) (V, error)) (V, error) {
|
||||
v, _, err := p.c.GetOrCreate(key, create)
|
||||
return v, err
|
||||
}
|
||||
|
||||
func (p *Partition[K, V]) GetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
|
||||
v, err := p.doGetOrCreateWitTimeout(key, duration, create)
|
||||
if err != nil {
|
||||
return p.zero, err
|
||||
}
|
||||
if resource.StaleVersion(v) > 0 {
|
||||
p.c.Delete(key)
|
||||
return p.doGetOrCreateWitTimeout(key, duration, create)
|
||||
}
|
||||
return v, err
|
||||
}
|
||||
|
||||
// GetOrCreateWitTimeout gets or creates a value for the given key and times out if the create function
|
||||
// takes too long.
|
||||
func (p *Partition[K, V]) GetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
|
||||
func (p *Partition[K, V]) doGetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
|
||||
resultch := make(chan V, 1)
|
||||
errch := make(chan error, 1)
|
||||
|
||||
|
@ -448,7 +472,7 @@ func (p *Partition[K, V]) clearOnRebuild(changeset ...identity.Identity) {
|
|||
|
||||
shouldDelete := func(key K, v V) bool {
|
||||
// We always clear elements marked as stale.
|
||||
if resource.IsStaleAny(v) {
|
||||
if resource.StaleVersion(v) > 0 {
|
||||
return true
|
||||
}
|
||||
|
||||
|
@ -503,8 +527,8 @@ func (p *Partition[K, V]) Keys() []K {
|
|||
|
||||
func (p *Partition[K, V]) clearStale() {
|
||||
p.c.DeleteFunc(func(key K, v V) bool {
|
||||
isStale := resource.IsStaleAny(v)
|
||||
if isStale {
|
||||
staleVersion := resource.StaleVersion(v)
|
||||
if staleVersion > 0 {
|
||||
p.trace.Log(
|
||||
logg.StringFunc(
|
||||
func() string {
|
||||
|
@ -514,7 +538,7 @@ func (p *Partition[K, V]) clearStale() {
|
|||
)
|
||||
}
|
||||
|
||||
return isStale
|
||||
return staleVersion > 0
|
||||
})
|
||||
}
|
||||
|
||||
|
|
12
cache/dynacache/dynacache_test.go
vendored
12
cache/dynacache/dynacache_test.go
vendored
|
@ -29,12 +29,12 @@ var (
|
|||
)
|
||||
|
||||
type testItem struct {
|
||||
name string
|
||||
isStale bool
|
||||
name string
|
||||
staleVersion uint32
|
||||
}
|
||||
|
||||
func (t testItem) IsStale() bool {
|
||||
return t.isStale
|
||||
func (t testItem) StaleVersion() uint32 {
|
||||
return t.staleVersion
|
||||
}
|
||||
|
||||
func (t testItem) IdentifierBase() string {
|
||||
|
@ -109,7 +109,7 @@ func newTestCache(t *testing.T) *Cache {
|
|||
|
||||
p2.GetOrCreate("clearBecauseStale", func(string) (testItem, error) {
|
||||
return testItem{
|
||||
isStale: true,
|
||||
staleVersion: 32,
|
||||
}, nil
|
||||
})
|
||||
|
||||
|
@ -121,7 +121,7 @@ func newTestCache(t *testing.T) *Cache {
|
|||
|
||||
p2.GetOrCreate("clearNever", func(string) (testItem, error) {
|
||||
return testItem{
|
||||
isStale: false,
|
||||
staleVersion: 0,
|
||||
}, nil
|
||||
})
|
||||
|
||||
|
|
|
@ -824,10 +824,10 @@ func (s *contentNodeShifter) Insert(old, new contentNodeI) contentNodeI {
|
|||
if !ok {
|
||||
panic(fmt.Sprintf("unknown type %T", new))
|
||||
}
|
||||
if newp != old {
|
||||
resource.MarkStale(old)
|
||||
}
|
||||
if vv.s.languagei == newp.s.languagei {
|
||||
if newp != old {
|
||||
resource.MarkStale(old)
|
||||
}
|
||||
return new
|
||||
}
|
||||
is := make(contentNodeIs, s.numLanguages)
|
||||
|
@ -843,7 +843,6 @@ func (s *contentNodeShifter) Insert(old, new contentNodeI) contentNodeI {
|
|||
if oldp != newp {
|
||||
resource.MarkStale(oldp)
|
||||
}
|
||||
|
||||
vv[newp.s.languagei] = new
|
||||
return vv
|
||||
case *resourceSource:
|
||||
|
@ -852,6 +851,9 @@ func (s *contentNodeShifter) Insert(old, new contentNodeI) contentNodeI {
|
|||
panic(fmt.Sprintf("unknown type %T", new))
|
||||
}
|
||||
if vv.LangIndex() == newp.LangIndex() {
|
||||
if vv != newp {
|
||||
resource.MarkStale(vv)
|
||||
}
|
||||
return new
|
||||
}
|
||||
rs := make(resourceSources, s.numLanguages)
|
||||
|
@ -1064,7 +1066,7 @@ func (h *HugoSites) resolveAndClearStateForIdentities(
|
|||
)
|
||||
|
||||
for _, id := range changes {
|
||||
if staler, ok := id.(resource.Staler); ok && !staler.IsStale() {
|
||||
if staler, ok := id.(resource.Staler); ok {
|
||||
var msgDetail string
|
||||
if p, ok := id.(*pageState); ok && p.File() != nil {
|
||||
msgDetail = fmt.Sprintf(" (%s)", p.File().Filename())
|
||||
|
|
|
@ -418,6 +418,8 @@ func (c *cachedContent) mustSource() []byte {
|
|||
|
||||
func (c *contentParseInfo) contentSource(s resource.StaleInfo) ([]byte, error) {
|
||||
key := c.sourceKey
|
||||
versionv := s.StaleVersion()
|
||||
|
||||
v, err := c.h.cacheContentSource.GetOrCreate(key, func(string) (*resources.StaleValue[[]byte], error) {
|
||||
b, err := c.readSourceAll()
|
||||
if err != nil {
|
||||
|
@ -426,8 +428,8 @@ func (c *contentParseInfo) contentSource(s resource.StaleInfo) ([]byte, error) {
|
|||
|
||||
return &resources.StaleValue[[]byte]{
|
||||
Value: b,
|
||||
IsStaleFunc: func() bool {
|
||||
return s.IsStale()
|
||||
StaleVersionFunc: func() uint32 {
|
||||
return s.StaleVersion() - versionv
|
||||
},
|
||||
}, nil
|
||||
})
|
||||
|
@ -487,7 +489,7 @@ type contentPlainPlainWords struct {
|
|||
func (c *cachedContent) contentRendered(ctx context.Context, cp *pageContentOutput) (contentSummary, error) {
|
||||
ctx = tpl.Context.DependencyScope.Set(ctx, pageDependencyScopeGlobal)
|
||||
key := c.pi.sourceKey + "/" + cp.po.f.Name
|
||||
versionv := cp.contentRenderedVersion
|
||||
versionv := c.version(cp)
|
||||
|
||||
v, err := c.pm.cacheContentRendered.GetOrCreate(key, func(string) (*resources.StaleValue[contentSummary], error) {
|
||||
cp.po.p.s.Log.Trace(logg.StringFunc(func() string {
|
||||
|
@ -504,8 +506,8 @@ func (c *cachedContent) contentRendered(ctx context.Context, cp *pageContentOutp
|
|||
}
|
||||
|
||||
rs := &resources.StaleValue[contentSummary]{
|
||||
IsStaleFunc: func() bool {
|
||||
return c.IsStale() || cp.contentRenderedVersion != versionv
|
||||
StaleVersionFunc: func() uint32 {
|
||||
return c.version(cp) - versionv
|
||||
},
|
||||
}
|
||||
|
||||
|
@ -607,7 +609,7 @@ var setGetContentCallbackInContext = hcontext.NewContextDispatcher[func(*pageCon
|
|||
|
||||
func (c *cachedContent) contentToC(ctx context.Context, cp *pageContentOutput) (contentTableOfContents, error) {
|
||||
key := c.pi.sourceKey + "/" + cp.po.f.Name
|
||||
versionv := cp.contentRenderedVersion
|
||||
versionv := c.version(cp)
|
||||
|
||||
v, err := c.pm.contentTableOfContents.GetOrCreate(key, func(string) (*resources.StaleValue[contentTableOfContents], error) {
|
||||
source, err := c.pi.contentSource(c)
|
||||
|
@ -713,8 +715,8 @@ func (c *cachedContent) contentToC(ctx context.Context, cp *pageContentOutput) (
|
|||
|
||||
return &resources.StaleValue[contentTableOfContents]{
|
||||
Value: ct,
|
||||
IsStaleFunc: func() bool {
|
||||
return c.IsStale() || cp.contentRenderedVersion != versionv
|
||||
StaleVersionFunc: func() uint32 {
|
||||
return c.version(cp) - versionv
|
||||
},
|
||||
}, nil
|
||||
})
|
||||
|
@ -725,16 +727,21 @@ func (c *cachedContent) contentToC(ctx context.Context, cp *pageContentOutput) (
|
|||
return v.Value, nil
|
||||
}
|
||||
|
||||
func (c *cachedContent) version(cp *pageContentOutput) uint32 {
|
||||
// Both of these gets incremented on change.
|
||||
return c.StaleVersion() + cp.contentRenderedVersion
|
||||
}
|
||||
|
||||
func (c *cachedContent) contentPlain(ctx context.Context, cp *pageContentOutput) (contentPlainPlainWords, error) {
|
||||
key := c.pi.sourceKey + "/" + cp.po.f.Name
|
||||
|
||||
versionv := cp.contentRenderedVersion
|
||||
versionv := c.version(cp)
|
||||
|
||||
v, err := c.pm.cacheContentPlain.GetOrCreateWitTimeout(key, cp.po.p.s.Conf.Timeout(), func(string) (*resources.StaleValue[contentPlainPlainWords], error) {
|
||||
var result contentPlainPlainWords
|
||||
rs := &resources.StaleValue[contentPlainPlainWords]{
|
||||
IsStaleFunc: func() bool {
|
||||
return c.IsStale() || cp.contentRenderedVersion != versionv
|
||||
StaleVersionFunc: func() uint32 {
|
||||
return c.version(cp) - versionv
|
||||
},
|
||||
}
|
||||
|
||||
|
|
|
@ -89,8 +89,8 @@ type pageContentOutput struct {
|
|||
// typically included with .RenderShortcodes.
|
||||
otherOutputs map[uint64]*pageContentOutput
|
||||
|
||||
contentRenderedVersion int // Incremented on reset.
|
||||
contentRendered bool // Set on content render.
|
||||
contentRenderedVersion uint32 // Incremented on reset.
|
||||
contentRendered bool // Set on content render.
|
||||
|
||||
// Renders Markdown hooks.
|
||||
renderHooks *renderHooks
|
||||
|
|
|
@ -53,6 +53,11 @@ title: "Home"
|
|||
Home Content.
|
||||
-- content/hometext.txt --
|
||||
Home Text Content.
|
||||
-- content/myothersection/myothersectionpage.md --
|
||||
---
|
||||
title: "myothersectionpage"
|
||||
---
|
||||
myothersectionpage Content.
|
||||
-- layouts/_default/single.html --
|
||||
Single: {{ .Title }}|{{ .Content }}$
|
||||
Resources: {{ range $i, $e := .Resources }}{{ $i }}:{{ .RelPermalink }}|{{ .Content }}|{{ end }}$
|
||||
|
@ -135,8 +140,8 @@ func TestRebuildRenameTextFileInLeafBundle(t *testing.T) {
|
|||
|
||||
b.RenameFile("content/mysection/mysectionbundle/mysectionbundletext.txt", "content/mysection/mysectionbundle/mysectionbundletext2.txt").Build()
|
||||
b.AssertFileContent("public/mysection/mysectionbundle/index.html", "mysectionbundletext2", "My Section Bundle Text 2 Content.", "Len Resources: 2|")
|
||||
b.AssertRenderCountPage(3)
|
||||
b.AssertRenderCountContent(3)
|
||||
b.AssertRenderCountPage(5)
|
||||
b.AssertRenderCountContent(6)
|
||||
})
|
||||
}
|
||||
|
||||
|
@ -147,6 +152,19 @@ func TestRebuilEditContentFileInLeafBundle(t *testing.T) {
|
|||
b.AssertFileContent("public/mysection/mysectionbundle/index.html", "My Section Bundle Content Content Edited.")
|
||||
}
|
||||
|
||||
func TestRebuilEditContentFileThenAnother(t *testing.T) {
|
||||
b := TestRunning(t, rebuildFilesSimple)
|
||||
b.EditFileReplaceAll("content/mysection/mysectionbundle/mysectionbundlecontent.md", "Content Content.", "Content Content Edited.").Build()
|
||||
b.AssertFileContent("public/mysection/mysectionbundle/index.html", "My Section Bundle Content Content Edited.")
|
||||
b.AssertRenderCountPage(1)
|
||||
b.AssertRenderCountContent(2)
|
||||
|
||||
b.EditFileReplaceAll("content/myothersection/myothersectionpage.md", "myothersectionpage Content.", "myothersectionpage Content Edited.").Build()
|
||||
b.AssertFileContent("public/myothersection/myothersectionpage/index.html", "myothersectionpage Content Edited")
|
||||
b.AssertRenderCountPage(1)
|
||||
b.AssertRenderCountContent(1)
|
||||
}
|
||||
|
||||
func TestRebuildRenameTextFileInBranchBundle(t *testing.T) {
|
||||
b := TestRunning(t, rebuildFilesSimple)
|
||||
b.AssertFileContent("public/mysection/index.html", "My Section")
|
||||
|
@ -163,7 +181,7 @@ func TestRebuildRenameTextFileInHomeBundle(t *testing.T) {
|
|||
|
||||
b.RenameFile("content/hometext.txt", "content/hometext2.txt").Build()
|
||||
b.AssertFileContent("public/index.html", "hometext2", "Home Text Content.")
|
||||
b.AssertRenderCountPage(2)
|
||||
b.AssertRenderCountPage(3)
|
||||
}
|
||||
|
||||
func TestRebuildRenameDirectoryWithLeafBundle(t *testing.T) {
|
||||
|
@ -179,7 +197,7 @@ func TestRebuildRenameDirectoryWithBranchBundle(t *testing.T) {
|
|||
b.AssertFileContent("public/mysectionrenamed/index.html", "My Section")
|
||||
b.AssertFileContent("public/mysectionrenamed/mysectionbundle/index.html", "My Section Bundle")
|
||||
b.AssertFileContent("public/mysectionrenamed/mysectionbundle/mysectionbundletext.txt", "My Section Bundle Text 2 Content.")
|
||||
b.AssertRenderCountPage(2)
|
||||
b.AssertRenderCountPage(3)
|
||||
}
|
||||
|
||||
func TestRebuildRenameDirectoryWithRegularPageUsedInHome(t *testing.T) {
|
||||
|
@ -278,7 +296,7 @@ func TestRebuildRenameDirectoryWithBranchBundleFastRender(t *testing.T) {
|
|||
b.AssertFileContent("public/mysectionrenamed/index.html", "My Section")
|
||||
b.AssertFileContent("public/mysectionrenamed/mysectionbundle/index.html", "My Section Bundle")
|
||||
b.AssertFileContent("public/mysectionrenamed/mysectionbundle/mysectionbundletext.txt", "My Section Bundle Text 2 Content.")
|
||||
b.AssertRenderCountPage(2)
|
||||
b.AssertRenderCountPage(3)
|
||||
}
|
||||
|
||||
func TestRebuilErrorRecovery(t *testing.T) {
|
||||
|
|
|
@ -201,6 +201,43 @@ Myshort Original.
|
|||
b.AssertFileContent("public/p1/index.html", "Edited")
|
||||
}
|
||||
|
||||
func TestRenderShortcodesEditSectionContentWithShortcodeInIncludedPageIssue12458(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
files := `
|
||||
-- hugo.toml --
|
||||
disableLiveReload = true
|
||||
disableKinds = ["home", "taxonomy", "term", "rss", "sitemap", "robotsTXT", "404"]
|
||||
-- content/mysection/_index.md --
|
||||
---
|
||||
title: "My Section"
|
||||
---
|
||||
## p1-h1
|
||||
{{% include "p2" %}}
|
||||
-- content/mysection/p2.md --
|
||||
---
|
||||
title: "p2"
|
||||
---
|
||||
### Original
|
||||
{{% myshort %}}
|
||||
-- layouts/shortcodes/include.html --
|
||||
{{ $p := .Page.GetPage (.Get 0) }}
|
||||
{{ $p.RenderShortcodes }}
|
||||
-- layouts/shortcodes/myshort.html --
|
||||
Myshort Original.
|
||||
-- layouts/_default/list.html --
|
||||
{{ .Content }}
|
||||
|
||||
|
||||
|
||||
`
|
||||
b := TestRunning(t, files)
|
||||
|
||||
b.AssertFileContent("public/mysection/index.html", "p1-h1")
|
||||
b.EditFileReplaceAll("content/mysection/_index.md", "p1-h1", "p1-h1 Edited").Build()
|
||||
b.AssertFileContent("public/mysection/index.html", "p1-h1 Edited")
|
||||
}
|
||||
|
||||
func TestRenderShortcodesNestedPageContextIssue12356(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
|
|
@ -487,7 +487,7 @@ Edited!!`, p.Title()))
|
|||
|
||||
// We currently rebuild all the language versions of the same content file.
|
||||
// We could probably optimize that case, but it's not trivial.
|
||||
b.Assert(int(counters.contentRenderCounter.Load()), qt.Equals, 33)
|
||||
b.Assert(int(counters.contentRenderCounter.Load()), qt.Equals, 4)
|
||||
b.AssertFileContent("public"+p.RelPermalink()+"index.html", "Edited!!")
|
||||
}
|
||||
|
||||
|
|
25
markup/bibliography/config.go
Normal file
25
markup/bibliography/config.go
Normal file
|
@ -0,0 +1,25 @@
|
|||
// 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 bibliography
|
||||
|
||||
type Config struct {
|
||||
// File containing bibliography. E.g. 'my-doc.bibtex'. By default assumed
|
||||
// to be in BibTex format.
|
||||
Source string
|
||||
|
||||
// Path to .csl file describing citation file.
|
||||
CitationStyle string
|
||||
}
|
||||
|
||||
var Default Config
|
|
@ -17,8 +17,10 @@ import (
|
|||
"github.com/gohugoio/hugo/common/maps"
|
||||
"github.com/gohugoio/hugo/config"
|
||||
"github.com/gohugoio/hugo/markup/asciidocext/asciidocext_config"
|
||||
"github.com/gohugoio/hugo/markup/bibliography"
|
||||
"github.com/gohugoio/hugo/markup/goldmark/goldmark_config"
|
||||
"github.com/gohugoio/hugo/markup/highlight"
|
||||
"github.com/gohugoio/hugo/markup/pandoc/pandoc_config"
|
||||
"github.com/gohugoio/hugo/markup/tableofcontents"
|
||||
"github.com/mitchellh/mapstructure"
|
||||
)
|
||||
|
@ -33,12 +35,16 @@ type Config struct {
|
|||
|
||||
// Table of contents configuration
|
||||
TableOfContents tableofcontents.Config
|
||||
Bibliography bibliography.Config
|
||||
|
||||
// Configuration for the Goldmark markdown engine.
|
||||
Goldmark goldmark_config.Config
|
||||
|
||||
// Configuration for the Asciidoc external markdown engine.
|
||||
AsciidocExt asciidocext_config.Config
|
||||
|
||||
// Configuration for Pandoc external markdown engine.
|
||||
Pandoc pandoc_config.Config
|
||||
}
|
||||
|
||||
func Decode(cfg config.Provider) (conf Config, err error) {
|
||||
|
@ -102,7 +108,9 @@ var Default = Config{
|
|||
|
||||
TableOfContents: tableofcontents.DefaultConfig,
|
||||
Highlight: highlight.DefaultConfig,
|
||||
Bibliography: bibliography.Default,
|
||||
|
||||
Goldmark: goldmark_config.Default,
|
||||
Pandoc: pandoc_config.Default,
|
||||
AsciidocExt: asciidocext_config.Default,
|
||||
}
|
||||
|
|
|
@ -15,14 +15,34 @@
|
|||
package pandoc
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
|
||||
"github.com/gohugoio/hugo/common/hexec"
|
||||
"github.com/gohugoio/hugo/htesting"
|
||||
"github.com/gohugoio/hugo/identity"
|
||||
"github.com/mitchellh/mapstructure"
|
||||
|
||||
"github.com/gohugoio/hugo/identity"
|
||||
"github.com/gohugoio/hugo/markup/bibliography"
|
||||
"github.com/gohugoio/hugo/markup/converter"
|
||||
"github.com/gohugoio/hugo/markup/internal"
|
||||
"github.com/gohugoio/hugo/markup/pandoc/pandoc_config"
|
||||
|
||||
"path"
|
||||
)
|
||||
|
||||
type paramer interface {
|
||||
Param(interface{}) (interface{}, error)
|
||||
}
|
||||
|
||||
type searchPaths struct {
|
||||
Paths []string
|
||||
}
|
||||
|
||||
func (s *searchPaths) AsResourcePath() string {
|
||||
return strings.Join(s.Paths, ":")
|
||||
}
|
||||
|
||||
// Provider is the package entry point.
|
||||
var Provider converter.ProviderProvider = provider{}
|
||||
|
||||
|
@ -31,19 +51,19 @@ type provider struct{}
|
|||
func (p provider) New(cfg converter.ProviderConfig) (converter.Provider, error) {
|
||||
return converter.NewProvider("pandoc", func(ctx converter.DocumentContext) (converter.Converter, error) {
|
||||
return &pandocConverter{
|
||||
ctx: ctx,
|
||||
cfg: cfg,
|
||||
docCtx: ctx,
|
||||
cfg: cfg,
|
||||
}, nil
|
||||
}), nil
|
||||
}
|
||||
|
||||
type pandocConverter struct {
|
||||
ctx converter.DocumentContext
|
||||
cfg converter.ProviderConfig
|
||||
docCtx converter.DocumentContext
|
||||
cfg converter.ProviderConfig
|
||||
}
|
||||
|
||||
func (c *pandocConverter) Convert(ctx converter.RenderContext) (converter.ResultRender, error) {
|
||||
b, err := c.getPandocContent(ctx.Src, c.ctx)
|
||||
b, err := c.getPandocContent(ctx.Src)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
@ -55,30 +75,50 @@ func (c *pandocConverter) Supports(feature identity.Identity) bool {
|
|||
}
|
||||
|
||||
// getPandocContent calls pandoc as an external helper to convert pandoc markdown to HTML.
|
||||
func (c *pandocConverter) getPandocContent(src []byte, ctx converter.DocumentContext) ([]byte, error) {
|
||||
logger := c.cfg.Logger
|
||||
binaryName := getPandocBinaryName()
|
||||
if binaryName == "" {
|
||||
logger.Println("pandoc not found in $PATH: Please install.\n",
|
||||
" Leaving pandoc content unrendered.")
|
||||
return src, nil
|
||||
func (c *pandocConverter) getPandocContent(src []byte) ([]byte, error) {
|
||||
pandocPath, pandocFound := getPandocBinaryName()
|
||||
if !pandocFound {
|
||||
return nil, errors.New("pandoc not found in $PATH: Please install.")
|
||||
}
|
||||
args := []string{"--mathjax"}
|
||||
return internal.ExternallyRenderContent(c.cfg, ctx, src, binaryName, args)
|
||||
|
||||
var pandocConfig pandoc_config.Config = c.cfg.MarkupConfig().Pandoc
|
||||
var bibConfig bibliography.Config = c.cfg.MarkupConfig().Bibliography
|
||||
|
||||
if pageParameters, ok := c.docCtx.Document.(paramer); ok {
|
||||
if bibParam, err := pageParameters.Param("bibliography"); err == nil {
|
||||
mapstructure.WeakDecode(bibParam, &bibConfig)
|
||||
}
|
||||
|
||||
if pandocParam, err := pageParameters.Param("pandoc"); err == nil {
|
||||
mapstructure.WeakDecode(pandocParam, &pandocConfig)
|
||||
}
|
||||
}
|
||||
|
||||
arguments := pandocConfig.AsPandocArguments()
|
||||
|
||||
if bibConfig.Source != "" {
|
||||
arguments = append(arguments, "--citeproc", "--bibliography", bibConfig.Source)
|
||||
if bibConfig.CitationStyle != "" {
|
||||
arguments = append(arguments, "--csl", bibConfig.CitationStyle)
|
||||
}
|
||||
}
|
||||
|
||||
resourcePath := strings.Join([]string{path.Dir(c.docCtx.Filename), "static", "."}, ":")
|
||||
arguments = append(arguments, "--resource-path", resourcePath)
|
||||
|
||||
renderedContent, _ := internal.ExternallyRenderContent(c.cfg, c.docCtx, src, pandocPath, arguments)
|
||||
return renderedContent, nil
|
||||
}
|
||||
|
||||
const pandocBinary = "pandoc"
|
||||
|
||||
func getPandocBinaryName() string {
|
||||
if hexec.InPath(pandocBinary) {
|
||||
return pandocBinary
|
||||
}
|
||||
return ""
|
||||
func getPandocBinaryName() (string, bool) {
|
||||
return pandocBinary, hexec.InPath(pandocBinary)
|
||||
}
|
||||
|
||||
// Supports returns whether Pandoc is installed on this computer.
|
||||
func Supports() bool {
|
||||
hasBin := getPandocBinaryName() != ""
|
||||
_, hasBin := getPandocBinaryName()
|
||||
if htesting.SupportsAll() {
|
||||
if !hasBin {
|
||||
panic("pandoc not installed")
|
||||
|
|
165
markup/pandoc/pandoc_config/pandoc.go
Normal file
165
markup/pandoc/pandoc_config/pandoc.go
Normal file
|
@ -0,0 +1,165 @@
|
|||
package pandoc_config
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Config contains configuration settings for Pandoc.
|
||||
type Config struct {
|
||||
// Input format. Use the 'Extensions' field to specify extensions thereof.
|
||||
// Only specify the bare format here. Defaults to 'markdown' if empty. Invoke
|
||||
// "pandoc --list-input-formats" to see the list of supported input formats
|
||||
// including various Markdown dialects.
|
||||
InputFormat string
|
||||
|
||||
// If true, the output format is HTML (i.e. "--to=html"). Otherwise the output
|
||||
// format is HTML5 (i.e. "--to=html5").
|
||||
UseLegacyHtml bool
|
||||
|
||||
// Equivalent to specifying "--mathjax". For compatibility, this option is
|
||||
// always true if none of the other math options are used.
|
||||
// See https://pandoc.org/MANUAL.html#math-rendering-in-html
|
||||
UseMathjax bool
|
||||
|
||||
// Equivalent to specifying "--mathml".
|
||||
// See https://pandoc.org/MANUAL.html#math-rendering-in-html
|
||||
UseMathml bool
|
||||
|
||||
// Equivalent to specifying "--webtex".
|
||||
// See https://pandoc.org/MANUAL.html#math-rendering-in-html. Uses the default
|
||||
// Webtex rendering URL.
|
||||
UseWebtex bool
|
||||
|
||||
// Equivalent to specifying "--katex".
|
||||
// See https://pandoc.org/MANUAL.html#math-rendering-in-html
|
||||
UseKatex bool
|
||||
|
||||
// List of filters to use. These translate to '--filter=' or '--lua-filter'
|
||||
// arguments to the pandoc invocation. The order of elements in `Filters`
|
||||
// is preserved when constructing the `pandoc` commandline.
|
||||
//
|
||||
// Use the prefix 'lua:' or the suffix '.lua' to indicate Lua filters.
|
||||
Filters []string
|
||||
|
||||
// List of Pandoc Markdown extensions to use. No need to include default
|
||||
// extensions. Specifying ["foo", "bar"] is equivalent to specifying
|
||||
// --from=markdown+foo+bar on the pandoc commandline.
|
||||
Extensions []string
|
||||
|
||||
// List of input format extensions to use. Specifying ["foo", "bar"] is
|
||||
// equivalent to specifying --from=markdown+foo+bar on the pandoc commandline
|
||||
// assuming InputFormat is "markdown".
|
||||
InputExtensions []string
|
||||
|
||||
// List of output format extensions to use. Specifying ["foo", "bar"] is
|
||||
// equivalent to specifying --to=html5+foo+bar on the pandoc commandline,
|
||||
// assuming UseLegacyHTML is false. Invoke "pandoc --list-extensions=html5" to
|
||||
// or "pandoc --list-extensions=html5" to see the list of extensions that can
|
||||
// be specified here.
|
||||
OutputExtensions []string
|
||||
|
||||
// Metadata. The dictionary keys and values are handled in the obvious way.
|
||||
Metadata map[string]interface{}
|
||||
|
||||
// Extra commandline options passed to the pandoc invocation. These options
|
||||
// are appended to the commandline after the format and filter options.
|
||||
// Arguments are passed in literally. Hence must have the "--" or "-" prefix
|
||||
// where applicable.
|
||||
ExtraArgs []string
|
||||
}
|
||||
|
||||
var Default = Config{
|
||||
InputFormat: "markdown",
|
||||
UseLegacyHtml: false,
|
||||
UseMathjax: true,
|
||||
}
|
||||
|
||||
func (c *Config) getInputArg() string {
|
||||
var b strings.Builder
|
||||
b.WriteString("--from=")
|
||||
if len(c.InputFormat) > 0 {
|
||||
b.WriteString(c.InputFormat)
|
||||
} else {
|
||||
b.WriteString("markdown")
|
||||
}
|
||||
|
||||
for _, extension := range c.InputExtensions {
|
||||
b.WriteString("+")
|
||||
b.WriteString(extension)
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
func (c *Config) getOutputArg() string {
|
||||
var b strings.Builder
|
||||
b.WriteString("--to=")
|
||||
if c.UseLegacyHtml {
|
||||
b.WriteString("html")
|
||||
} else {
|
||||
b.WriteString("html5")
|
||||
}
|
||||
|
||||
for _, extension := range c.OutputExtensions {
|
||||
b.WriteString("+")
|
||||
b.WriteString(extension)
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
func (c *Config) getMathRenderingArg() string {
|
||||
switch {
|
||||
case c.UseMathml:
|
||||
return "--mathml"
|
||||
case c.UseWebtex:
|
||||
return "--webtex"
|
||||
case c.UseKatex:
|
||||
return "--katex"
|
||||
default:
|
||||
return "--mathjax"
|
||||
}
|
||||
}
|
||||
|
||||
func (c *Config) getMetadataArgs() []string {
|
||||
var args []string
|
||||
for k, iv := range c.Metadata {
|
||||
var v string
|
||||
if sv, ok := iv.(string); ok {
|
||||
v = sv
|
||||
} else if sv, ok := iv.(fmt.Stringer); ok {
|
||||
v = sv.String()
|
||||
} else {
|
||||
v = fmt.Sprintf("%v", iv)
|
||||
}
|
||||
args = append(args, fmt.Sprintf("-M%s=%s", k, v))
|
||||
}
|
||||
return args
|
||||
}
|
||||
|
||||
func (c *Config) getFilterArgs() []string {
|
||||
var args []string
|
||||
for _, filterPath := range c.Filters {
|
||||
if strings.HasPrefix(filterPath, "lua:") || strings.HasSuffix(filterPath, ".lua") {
|
||||
args = append(args, fmt.Sprintf("--lua-filter=%s", strings.TrimPrefix(filterPath, "lua:")))
|
||||
} else {
|
||||
args = append(args, fmt.Sprintf("--filter=%s", filterPath))
|
||||
}
|
||||
}
|
||||
return args
|
||||
}
|
||||
|
||||
// AsPandocArguments returns a list of strings that can be used as arguments to
|
||||
// a "pandoc" invocation. All the settings contained in Config are represented
|
||||
// in the returned list of arguments.
|
||||
func (c *Config) AsPandocArguments() []string {
|
||||
args := []string{
|
||||
c.getInputArg(),
|
||||
c.getOutputArg(),
|
||||
c.getMathRenderingArg()}
|
||||
|
||||
args = append(args, c.getMetadataArgs()...)
|
||||
args = append(args, c.getFilterArgs()...)
|
||||
args = append(args, c.ExtraArgs...)
|
||||
|
||||
return args
|
||||
}
|
|
@ -296,16 +296,19 @@ type hashProvider interface {
|
|||
hash() string
|
||||
}
|
||||
|
||||
var _ resource.StaleInfo = (*StaleValue[any])(nil)
|
||||
|
||||
type StaleValue[V any] struct {
|
||||
// The value.
|
||||
Value V
|
||||
|
||||
// IsStaleFunc reports whether the value is stale.
|
||||
IsStaleFunc func() bool
|
||||
// StaleVersionFunc reports the current version of the value.
|
||||
// This always starts out at 0 and get incremented on staleness.
|
||||
StaleVersionFunc func() uint32
|
||||
}
|
||||
|
||||
func (s *StaleValue[V]) IsStale() bool {
|
||||
return s.IsStaleFunc()
|
||||
func (s *StaleValue[V]) StaleVersion() uint32 {
|
||||
return s.StaleVersionFunc()
|
||||
}
|
||||
|
||||
type AtomicStaler struct {
|
||||
|
@ -313,11 +316,11 @@ type AtomicStaler struct {
|
|||
}
|
||||
|
||||
func (s *AtomicStaler) MarkStale() {
|
||||
atomic.StoreUint32(&s.stale, 1)
|
||||
atomic.AddUint32(&s.stale, 1)
|
||||
}
|
||||
|
||||
func (s *AtomicStaler) IsStale() bool {
|
||||
return atomic.LoadUint32(&(s.stale)) > 0
|
||||
func (s *AtomicStaler) StaleVersion() uint32 {
|
||||
return atomic.LoadUint32(&(s.stale))
|
||||
}
|
||||
|
||||
// For internal use.
|
||||
|
|
|
@ -233,17 +233,27 @@ type StaleMarker interface {
|
|||
|
||||
// StaleInfo tells if a resource is marked as stale.
|
||||
type StaleInfo interface {
|
||||
IsStale() bool
|
||||
StaleVersion() uint32
|
||||
}
|
||||
|
||||
// IsStaleAny reports whether any of the os is marked as stale.
|
||||
func IsStaleAny(os ...any) bool {
|
||||
for _, o := range os {
|
||||
if s, ok := o.(StaleInfo); ok && s.IsStale() {
|
||||
return true
|
||||
// StaleVersion returns the StaleVersion for the given os,
|
||||
// or 0 if not set.
|
||||
func StaleVersion(os any) uint32 {
|
||||
if s, ok := os.(StaleInfo); ok {
|
||||
return s.StaleVersion()
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
// StaleVersionSum calculates the sum of the StaleVersionSum for the given oss.
|
||||
func StaleVersionSum(oss ...any) uint32 {
|
||||
var version uint32
|
||||
for _, o := range oss {
|
||||
if s, ok := o.(StaleInfo); ok && s.StaleVersion() > 0 {
|
||||
version += s.StaleVersion()
|
||||
}
|
||||
}
|
||||
return false
|
||||
return version
|
||||
}
|
||||
|
||||
// MarkStale will mark any of the oses as stale, if possible.
|
||||
|
|
|
@ -657,8 +657,9 @@ type resourceAdapterInner struct {
|
|||
*publishOnce
|
||||
}
|
||||
|
||||
func (r *resourceAdapterInner) IsStale() bool {
|
||||
return r.Staler.IsStale() || r.target.IsStale()
|
||||
func (r *resourceAdapterInner) StaleVersion() uint32 {
|
||||
// Both of these are incremented on change.
|
||||
return r.Staler.StaleVersion() + r.target.StaleVersion()
|
||||
}
|
||||
|
||||
type resourceTransformations struct {
|
||||
|
|
|
@ -95,8 +95,8 @@ func (ns *Namespace) Unmarshal(args ...any) (any, error) {
|
|||
|
||||
return &resources.StaleValue[any]{
|
||||
Value: v,
|
||||
IsStaleFunc: func() bool {
|
||||
return resource.IsStaleAny(r)
|
||||
StaleVersionFunc: func() uint32 {
|
||||
return resource.StaleVersion(r)
|
||||
},
|
||||
}, nil
|
||||
})
|
||||
|
@ -132,8 +132,8 @@ func (ns *Namespace) Unmarshal(args ...any) (any, error) {
|
|||
|
||||
return &resources.StaleValue[any]{
|
||||
Value: v,
|
||||
IsStaleFunc: func() bool {
|
||||
return false
|
||||
StaleVersionFunc: func() uint32 {
|
||||
return 0
|
||||
},
|
||||
}, nil
|
||||
})
|
||||
|
|
Loading…
Reference in a new issue