gojekyll/pages/page.go

package pages

import (
	"bytes"
	"fmt"
	"io"
	"os"
	"path"
	"strings"
	"sync"
	"time"

	"github.com/danog/gojekyll/frontmatter"
	"github.com/danog/gojekyll/utils"
	"github.com/danog/gojekyll/version"
	"github.com/danog/liquid/evaluator"
)

// Page is a document with frontmatter.
type Page interface {
	Document
	// Render asks a page to compute its content.
	// This has the side effect of causing the content to subsequently appear in the drop.
	Render() error
	SetContent(string)
	FrontMatter() FrontMatter
	// PostDate returns the date computed from the filename or frontmatter.
	// It is an uncaught error to call this on a page that is not a Post.
	// TODO Should posts have their own interface?
	PostDate() time.Time
	IsPost() bool

	Categories() []string
	Tags() []string
}

// PageEmbed can be embedded to give defaults for the Page interface.
type PageEmbed struct {
	Path string
}

// FrontMatter is from the frontmatter package.
type FrontMatter = frontmatter.FrontMatter

// URL is in the pages.Page interface.
func (p *PageEmbed) URL() string { return p.Path }

// OutputExt is in the pages.Page interface.
func (p *PageEmbed) OutputExt() string { return path.Ext(p.Path) }

// Source is in the pages.Page interface.
func (p *PageEmbed) Source() string { return "" }

// Published is in the pages.Page interface.
func (p *PageEmbed) Published() bool { return true }

// IsStatic is in the pages.Page interface.
func (p *PageEmbed) IsStatic() bool { return false } // FIXME means different things to different callers

// Reload is in the pages.Page interface.
func (p *PageEmbed) Reload() error { return nil }

// A page is a concrete implementation of the Page interface.
type page struct {
	file
	firstLine int
	raw       []byte

	sync.RWMutex
	content      string
	contentError error
	contentOnce  sync.Once
	excerpt      interface{} // []byte or string, depending on rendering stage
	rendered     bool
}

// IsStatic is in the File interface.
func (p *page) IsStatic() bool { return false }

func makePage(filename string, f file) (*page, error) {
	raw, lineNo, err := readFrontMatter(&f)
	if err != nil {
		return nil, err
	}
	p := page{
		file:      f,
		firstLine: lineNo,
		raw:       raw,
	}
	if err := p.setPermalink(); err != nil {
		return nil, err
	}
	return &p, nil
}

func (p *page) Reload() error {
	if err := p.file.Reload(); err != nil {
		return err
	}
	// FIXME use original defaults
	raw, lineNo, err := readFrontMatter(&p.file)
	if err != nil {
		return err
	}
	p.firstLine = lineNo
	p.raw = raw
	p.reset()
	return nil
}

func (p *page) reset() {
	p.contentOnce = sync.Once{}
	p.rendered = false
}

func readFrontMatter(f *file) (b []byte, lineNo int, err error) {
	b, err = os.ReadFile(f.filename)
	if err != nil {
		return
	}
	lineNo = 1
	fm, err := frontmatter.Read(&b, &lineNo)
	if err != nil {
		return
	}
	f.fm = f.fm.Merged(fm)
	return
}

func (p *page) FrontMatter() FrontMatter {
	return p.fm
}

// Categories is in the Page interface
func (p *page) Categories() []string {
	return p.fm.SortedStringArray("categories")
}

// IsPost is in the Page interface
func (p *page) IsPost() bool {
	return p.fm["collection"] == "posts"
}

// Tags is in the Page interface
func (p *page) Tags() []string {
	return p.fm.SortedStringArray("tags")
}

// TemplateContext returns the local variables for template evaluation
func (p *page) TemplateContext() map[string]interface{} {
	env := os.Getenv("JEKYLL_ENV")
	if env == "" {
		env = "development"
	}
	return map[string]interface{}{
		"page": p,
		"site": p.site,
		"jekyll": map[string]string{
			"environment": env,
			"version":     fmt.Sprintf("%s (gojekyll)", version.Version)},
	}
}

// PostDate is part of the Page interface.
// FIXME move this back to Page interface, or re-work this entirely.
func (f *file) PostDate() time.Time {
	switch value := f.fm["date"].(type) {
	case time.Time:
		return value
	case string:
		t, err := evaluator.ParseDate(value)
		if err == nil {
			return t
		}
	}
	return f.modTime
}

// Write applies Liquid and Markdown, as appropriate.
func (p *page) Write(w io.Writer) error {
	if err := p.Render(); err != nil {
		return err
	}
	p.RLock()
	defer p.RUnlock()
	cn := p.content
	lo, ok := p.fm["layout"].(string)
	if ok && lo != "" {
		rm := p.site.RendererManager()
		b, err := rm.ApplyLayout(lo, []byte(cn), p.TemplateContext())
		if err != nil {
			return err
		}
		_, err = w.Write(b)
		return err
	}
	_, err := io.WriteString(w, cn)
	return err
}

// Content computes the page content.
func (p *page) Render() error {
	p.contentOnce.Do(func() {
		cn, ex, err := p.computeContent()
		p.Lock()
		defer p.Unlock()
		p.content = cn
		p.contentError = utils.WrapPathError(err, p.filename)
		p.excerpt = ex
		p.rendered = true
	})
	return p.contentError
}

func (p *page) SetContent(content string) {
	p.Lock()
	defer p.Unlock()
	p.content = content
	p.contentError = nil
}

func (p *page) computeContent() (cn string, ex string, err error) {
	pl := p.site.RendererManager()
	buf := new(bytes.Buffer)
	err = pl.Render(buf, p.raw, p.TemplateContext(), p.filename, p.firstLine)
	if err != nil {
		return
	}
	cn = buf.String()
	ex = cn
	pos := strings.Index(ex, p.site.Config().ExcerptSeparator)
	if pos >= 0 {
		ex = ex[:pos]
	}
	return
}

func (p *page) Excerpt() interface{} {
	if exc, ok := p.fm["excerpt"]; ok {
		return exc
	}
	p.RLock()
	defer p.RUnlock()
	if p.rendered {
		return p.excerpt
	}
	return p.extractExcerpt()
}

func (p *page) extractExcerpt() []byte {
	raw := p.raw
	pos := bytes.Index(raw, []byte(p.site.Config().ExcerptSeparator))
	if pos >= 0 {
		return raw[:pos]
	}
	return raw
}