mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
599e6672f7
Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
648 lines
15 KiB
Go
648 lines
15 KiB
Go
// Copyright © 2013 Steve Francia <spf@spf13.com>.
|
|
//
|
|
// Licensed under the Simple Public 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://opensource.org/licenses/Simple-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 (
|
|
"bitbucket.org/pkg/inflect"
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
"github.com/spf13/nitro"
|
|
"html/template"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
var DefaultTimer = nitro.Initalize()
|
|
|
|
type Site struct {
|
|
Config Config
|
|
Pages Pages
|
|
Tmpl *template.Template
|
|
Indexes IndexList
|
|
Files []string
|
|
Directories []string
|
|
Sections Index
|
|
Info SiteInfo
|
|
Shortcodes map[string]ShortcodeFunc
|
|
timer *nitro.B
|
|
}
|
|
|
|
type SiteInfo struct {
|
|
BaseUrl template.URL
|
|
Indexes OrderedIndexList
|
|
Recent *Pages
|
|
LastChange time.Time
|
|
Title string
|
|
Config *Config
|
|
}
|
|
|
|
func (s *Site) getFromIndex(kind string, name string) Pages {
|
|
return s.Indexes[kind][name]
|
|
}
|
|
|
|
func (s *Site) timerStep(step string) {
|
|
if s.timer == nil {
|
|
s.timer = DefaultTimer
|
|
}
|
|
s.timer.Step(step)
|
|
}
|
|
|
|
func (site *Site) Build() (err error) {
|
|
if err = site.Process(); err != nil {
|
|
return
|
|
}
|
|
if err = site.Render(); err != nil {
|
|
fmt.Printf("Error rendering site: %s\n", err)
|
|
fmt.Printf("Available templates:")
|
|
for _, template := range site.Tmpl.Templates() {
|
|
fmt.Printf("\t%s\n", template.Name())
|
|
}
|
|
return
|
|
}
|
|
site.Write()
|
|
return nil
|
|
}
|
|
|
|
func (site *Site) Analyze() {
|
|
site.Process()
|
|
site.checkDescriptions()
|
|
}
|
|
|
|
func (site *Site) Process() (err error) {
|
|
site.initialize()
|
|
site.prepTemplates()
|
|
site.timerStep("initialize & template prep")
|
|
site.CreatePages()
|
|
site.setupPrevNext()
|
|
site.timerStep("import pages")
|
|
if err = site.BuildSiteMeta(); err != nil {
|
|
return
|
|
}
|
|
site.timerStep("build indexes")
|
|
return
|
|
}
|
|
|
|
func (site *Site) Render() (err error) {
|
|
site.RenderAliases()
|
|
site.timerStep("render and write aliases")
|
|
site.ProcessShortcodes()
|
|
site.timerStep("render shortcodes")
|
|
site.AbsUrlify()
|
|
site.timerStep("absolute URLify")
|
|
if err = site.RenderIndexes(); err != nil {
|
|
return
|
|
}
|
|
if err = site.RenderIndexesIndexes(); err != nil {
|
|
return
|
|
}
|
|
site.timerStep("render and write indexes")
|
|
if err = site.RenderLists(); err != nil {
|
|
return
|
|
}
|
|
site.timerStep("render and write lists")
|
|
if err = site.RenderPages(); err != nil {
|
|
return
|
|
}
|
|
site.timerStep("render pages")
|
|
site.RenderHomePage()
|
|
site.timerStep("render and write homepage")
|
|
return
|
|
}
|
|
|
|
func (site *Site) Write() {
|
|
site.WritePages()
|
|
site.timerStep("write pages")
|
|
}
|
|
|
|
func (site *Site) checkDescriptions() {
|
|
for _, p := range site.Pages {
|
|
if len(p.Description) < 60 {
|
|
fmt.Print(p.FileName + " ")
|
|
}
|
|
}
|
|
}
|
|
|
|
func (s *Site) prepTemplates() {
|
|
var templates = template.New("")
|
|
|
|
funcMap := template.FuncMap{
|
|
"urlize": Urlize,
|
|
"gt": Gt,
|
|
"isset": IsSet,
|
|
"echoParam": ReturnWhenSet,
|
|
}
|
|
|
|
templates.Funcs(funcMap)
|
|
|
|
s.Tmpl = templates
|
|
s.primeTemplates()
|
|
s.loadTemplates()
|
|
}
|
|
|
|
func (s *Site) loadTemplates() {
|
|
walker := func(path string, fi os.FileInfo, err error) error {
|
|
if err != nil {
|
|
PrintErr("Walker: ", err)
|
|
return nil
|
|
}
|
|
|
|
if !fi.IsDir() {
|
|
if ignoreDotFile(path) {
|
|
return nil
|
|
}
|
|
filetext, err := ioutil.ReadFile(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
text := string(filetext)
|
|
t := s.Tmpl.New(s.generateTemplateNameFrom(path))
|
|
template.Must(t.Parse(text))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
filepath.Walk(s.absLayoutDir(), walker)
|
|
}
|
|
|
|
func (s *Site) generateTemplateNameFrom(path string) (name string) {
|
|
name = filepath.ToSlash(path[len(s.absLayoutDir())+1:])
|
|
return
|
|
}
|
|
|
|
func (s *Site) primeTemplates() {
|
|
alias := "<!DOCTYPE html>\n <html>\n <head>\n <link rel=\"canonical\" href=\"{{ .Permalink }}\"/>\n <meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />\n <meta http-equiv=\"refresh\" content=\"0;url={{ .Permalink }}\" />\n </head>\n </html>"
|
|
alias_xhtml := "<!DOCTYPE html>\n <html xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <link rel=\"canonical\" href=\"{{ .Permalink }}\"/>\n <meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />\n <meta http-equiv=\"refresh\" content=\"0;url={{ .Permalink }}\" />\n </head>\n </html>"
|
|
|
|
t := s.Tmpl.New("alias")
|
|
template.Must(t.Parse(alias))
|
|
|
|
t = s.Tmpl.New("alias-xhtml")
|
|
template.Must(t.Parse(alias_xhtml))
|
|
}
|
|
|
|
func (s *Site) initialize() {
|
|
site := s
|
|
|
|
s.checkDirectories()
|
|
|
|
staticDir := s.Config.GetAbsPath(s.Config.StaticDir+"/")
|
|
|
|
walker := func(path string, fi os.FileInfo, err error) error {
|
|
if err != nil {
|
|
PrintErr("Walker: ", err)
|
|
return nil
|
|
}
|
|
|
|
if fi.IsDir() {
|
|
if (path == staticDir) {
|
|
return filepath.SkipDir
|
|
}
|
|
site.Directories = append(site.Directories, path)
|
|
return nil
|
|
} else {
|
|
if ignoreDotFile(path) {
|
|
return nil
|
|
}
|
|
site.Files = append(site.Files, path)
|
|
return nil
|
|
}
|
|
}
|
|
|
|
filepath.Walk(s.absContentDir(), walker)
|
|
s.Info = SiteInfo{
|
|
BaseUrl: template.URL(s.Config.BaseUrl),
|
|
Title: s.Config.Title,
|
|
Recent: &s.Pages,
|
|
Config: &s.Config,
|
|
}
|
|
|
|
s.Shortcodes = make(map[string]ShortcodeFunc)
|
|
}
|
|
|
|
func ignoreDotFile(path string) bool {
|
|
return filepath.Base(path)[0] == '.'
|
|
}
|
|
|
|
func (s *Site) absLayoutDir() string {
|
|
return s.Config.GetAbsPath(s.Config.LayoutDir)
|
|
}
|
|
|
|
func (s *Site) absContentDir() string {
|
|
return s.Config.GetAbsPath(s.Config.ContentDir)
|
|
}
|
|
|
|
func (s *Site) absPublishDir() string {
|
|
return s.Config.GetAbsPath(s.Config.PublishDir)
|
|
}
|
|
|
|
func (s *Site) checkDirectories() {
|
|
if b, _ := dirExists(s.absLayoutDir()); !b {
|
|
FatalErr("No layout directory found, expecting to find it at " + s.absLayoutDir())
|
|
}
|
|
if b, _ := dirExists(s.absContentDir()); !b {
|
|
FatalErr("No source directory found, expecting to find it at " + s.absContentDir())
|
|
}
|
|
mkdirIf(s.absPublishDir())
|
|
}
|
|
|
|
func (s *Site) ProcessShortcodes() {
|
|
for i, _ := range s.Pages {
|
|
s.Pages[i].Content = template.HTML(ShortcodesHandle(string(s.Pages[i].Content), s.Pages[i], s.Tmpl))
|
|
}
|
|
}
|
|
|
|
func (s *Site) AbsUrlify() {
|
|
baseWithoutTrailingSlash := strings.TrimRight(s.Config.BaseUrl, "/")
|
|
baseWithSlash := baseWithoutTrailingSlash + "/"
|
|
for i, _ := range s.Pages {
|
|
content := string(s.Pages[i].Content)
|
|
content = strings.Replace(content, " src=\"/", " src=\""+baseWithSlash, -1)
|
|
content = strings.Replace(content, " src='/", " src='"+baseWithSlash, -1)
|
|
content = strings.Replace(content, " href='/", " href='"+baseWithSlash, -1)
|
|
content = strings.Replace(content, " href=\"/", " href=\""+baseWithSlash, -1)
|
|
content = strings.Replace(content, baseWithoutTrailingSlash+"//", baseWithSlash, -1)
|
|
s.Pages[i].Content = template.HTML(content)
|
|
}
|
|
}
|
|
|
|
func (s *Site) CreatePages() {
|
|
for _, fileName := range s.Files {
|
|
page := NewPage(fileName)
|
|
page.Site = s.Info
|
|
page.Tmpl = s.Tmpl
|
|
_ = s.setUrlPath(page)
|
|
page.Initalize()
|
|
s.setOutFile(page)
|
|
if s.Config.BuildDrafts || !page.Draft {
|
|
s.Pages = append(s.Pages, page)
|
|
}
|
|
}
|
|
|
|
s.Pages.Sort()
|
|
}
|
|
|
|
func (s *Site) setupPrevNext() {
|
|
for i, _ := range s.Pages {
|
|
if i < len(s.Pages)-1 {
|
|
s.Pages[i].Next = s.Pages[i+1]
|
|
}
|
|
|
|
if i > 0 {
|
|
s.Pages[i].Prev = s.Pages[i-1]
|
|
}
|
|
}
|
|
}
|
|
|
|
func (s *Site) setUrlPath(p *Page) error {
|
|
y := strings.TrimPrefix(p.FileName, s.Config.GetAbsPath(s.Config.ContentDir))
|
|
x := strings.Split(y, string(os.PathSeparator))
|
|
|
|
if len(x) <= 1 {
|
|
return errors.New("Zero length page name")
|
|
}
|
|
|
|
p.Section = strings.Trim(x[1], "/\\")
|
|
p.Path = strings.Trim(strings.Join(x[:len(x)-1], string(os.PathSeparator)), "/\\")
|
|
return nil
|
|
}
|
|
|
|
// If Url is provided it is assumed to be the complete relative path
|
|
// and will override everything
|
|
// Otherwise path + slug is used if provided
|
|
// Lastly path + filename is used if provided
|
|
func (s *Site) setOutFile(p *Page) {
|
|
// Always use Url if it's specified
|
|
if len(strings.TrimSpace(p.Url)) > 2 {
|
|
p.OutFile = strings.TrimSpace(p.Url)
|
|
return
|
|
}
|
|
|
|
var outfile string
|
|
if len(strings.TrimSpace(p.Slug)) > 0 {
|
|
// Use Slug if provided
|
|
if s.Config.UglyUrls {
|
|
outfile = strings.TrimSpace(p.Slug) + "." + p.Extension
|
|
} else {
|
|
outfile = filepath.Join(strings.TrimSpace(p.Slug), "index."+p.Extension)
|
|
}
|
|
} else {
|
|
// Fall back to filename
|
|
_, t := filepath.Split(p.FileName)
|
|
if s.Config.UglyUrls {
|
|
outfile = replaceExtension(strings.TrimSpace(t), p.Extension)
|
|
} else {
|
|
file, _ := fileExt(strings.TrimSpace(t))
|
|
outfile = filepath.Join(file, "index."+p.Extension)
|
|
}
|
|
}
|
|
|
|
p.OutFile = p.Path + string(os.PathSeparator) + strings.TrimSpace(outfile)
|
|
}
|
|
|
|
func (s *Site) BuildSiteMeta() (err error) {
|
|
s.Indexes = make(IndexList)
|
|
s.Sections = make(Index)
|
|
|
|
for _, plural := range s.Config.Indexes {
|
|
s.Indexes[plural] = make(Index)
|
|
for i, p := range s.Pages {
|
|
vals := p.GetParam(plural)
|
|
|
|
if vals != nil {
|
|
v, ok := vals.([]string)
|
|
if ok {
|
|
for _, idx := range v {
|
|
s.Indexes[plural].Add(idx, s.Pages[i])
|
|
}
|
|
} else {
|
|
PrintErr("Invalid " + plural + " in " + p.File.FileName)
|
|
}
|
|
}
|
|
}
|
|
for k, _ := range s.Indexes[plural] {
|
|
s.Indexes[plural][k].Sort()
|
|
}
|
|
}
|
|
|
|
for i, p := range s.Pages {
|
|
s.Sections.Add(p.Section, s.Pages[i])
|
|
}
|
|
|
|
for k, _ := range s.Sections {
|
|
s.Sections[k].Sort()
|
|
}
|
|
|
|
s.Info.Indexes = s.Indexes.BuildOrderedIndexList()
|
|
|
|
if len(s.Pages) == 0 {
|
|
return
|
|
}
|
|
s.Info.LastChange = s.Pages[0].Date
|
|
|
|
// populate pages with site metadata
|
|
for _, p := range s.Pages {
|
|
p.Site = s.Info
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
func (s *Site) possibleIndexes() (indexes []string) {
|
|
for _, p := range s.Pages {
|
|
for k, _ := range p.Params {
|
|
if !inStringArray(indexes, k) {
|
|
indexes = append(indexes, k)
|
|
}
|
|
}
|
|
}
|
|
return
|
|
}
|
|
|
|
func inStringArray(arr []string, el string) bool {
|
|
for _, v := range arr {
|
|
if v == el {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (s *Site) RenderAliases() error {
|
|
for i, p := range s.Pages {
|
|
for _, a := range p.Aliases {
|
|
t := "alias";
|
|
if strings.HasSuffix(a, ".xhtml") {
|
|
t = "alias-xhtml"
|
|
}
|
|
content, err := s.RenderThing(s.Pages[i], t)
|
|
if strings.HasSuffix(a, "/") {
|
|
a = a + "index.html"
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
s.WritePublic(a, content.Bytes())
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Site) RenderPages() error {
|
|
for i, _ := range s.Pages {
|
|
content, err := s.RenderThing(s.Pages[i], s.Pages[i].Layout())
|
|
if err != nil {
|
|
var err2 error
|
|
content, err2 = s.RenderThing(s.Pages[i], "_default/single.html")
|
|
if err2 != nil {
|
|
return err
|
|
}
|
|
}
|
|
s.Pages[i].RenderedContent = content
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Site) WritePages() {
|
|
for _, p := range s.Pages {
|
|
s.WritePublic(p.OutFile, p.RenderedContent.Bytes())
|
|
}
|
|
}
|
|
|
|
func (s *Site) RenderIndexes() error {
|
|
for singular, plural := range s.Config.Indexes {
|
|
for k, o := range s.Indexes[plural] {
|
|
n := s.NewNode()
|
|
n.Title = strings.Title(k)
|
|
url := Urlize(plural + "/" + k)
|
|
plink := url
|
|
if s.Config.UglyUrls {
|
|
n.Url = url + ".html"
|
|
plink = n.Url
|
|
} else {
|
|
n.Url = url + "/index.html"
|
|
}
|
|
n.Permalink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string(plink)))
|
|
n.RSSlink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string(url+".xml")))
|
|
n.Date = o[0].Date
|
|
n.Data[singular] = o
|
|
n.Data["Pages"] = o
|
|
layout := "indexes/" + singular + ".html"
|
|
x, err := s.RenderThing(n, layout)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
var base string
|
|
if s.Config.UglyUrls {
|
|
base = plural + "/" + k
|
|
} else {
|
|
base = plural + "/" + k + "/" + "index"
|
|
}
|
|
|
|
s.WritePublic(base+".html", x.Bytes())
|
|
|
|
if a := s.Tmpl.Lookup("rss.xml"); a != nil {
|
|
// XML Feed
|
|
y := s.NewXMLBuffer()
|
|
if s.Config.UglyUrls {
|
|
n.Url = Urlize(plural + "/" + k + ".xml")
|
|
} else {
|
|
n.Url = Urlize(plural + "/" + k + "/" + "index.xml")
|
|
}
|
|
n.Permalink = template.HTML(string(n.Site.BaseUrl) + n.Url)
|
|
s.Tmpl.ExecuteTemplate(y, "rss.xml", n)
|
|
s.WritePublic(base+".xml", y.Bytes())
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Site) RenderIndexesIndexes() (err error) {
|
|
layout := "indexes/indexes.html"
|
|
if s.Tmpl.Lookup(layout) != nil {
|
|
for singular, plural := range s.Config.Indexes {
|
|
n := s.NewNode()
|
|
n.Title = strings.Title(plural)
|
|
url := Urlize(plural)
|
|
n.Url = url + "/index.html"
|
|
n.Permalink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string(n.Url)))
|
|
n.Data["Singular"] = singular
|
|
n.Data["Plural"] = plural
|
|
n.Data["Index"] = s.Indexes[plural]
|
|
n.Data["OrderedIndex"] = s.Info.Indexes[plural]
|
|
|
|
x, err := s.RenderThing(n, layout)
|
|
s.WritePublic(plural+"/index.html", x.Bytes())
|
|
return err
|
|
}
|
|
}
|
|
return
|
|
}
|
|
|
|
func (s *Site) RenderLists() error {
|
|
for section, data := range s.Sections {
|
|
n := s.NewNode()
|
|
n.Title = strings.Title(inflect.Pluralize(section))
|
|
n.Url = Urlize(section + "/" + "index.html")
|
|
n.Permalink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string(n.Url)))
|
|
n.RSSlink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string(section+".xml")))
|
|
n.Date = data[0].Date
|
|
n.Data["Pages"] = data
|
|
layout := "indexes/" + section + ".html"
|
|
|
|
x, err := s.RenderThing(n, layout)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
s.WritePublic(section+"/index.html", x.Bytes())
|
|
|
|
if a := s.Tmpl.Lookup("rss.xml"); a != nil {
|
|
// XML Feed
|
|
if s.Config.UglyUrls {
|
|
n.Url = Urlize(section + ".xml")
|
|
} else {
|
|
n.Url = Urlize(section + "/" + "index.xml")
|
|
}
|
|
n.Permalink = template.HTML(string(n.Site.BaseUrl) + n.Url)
|
|
y := s.NewXMLBuffer()
|
|
s.Tmpl.ExecuteTemplate(y, "rss.xml", n)
|
|
s.WritePublic(section+"/index.xml", y.Bytes())
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Site) RenderHomePage() error {
|
|
n := s.NewNode()
|
|
n.Title = n.Site.Title
|
|
n.Url = Urlize(string(n.Site.BaseUrl))
|
|
n.RSSlink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string("index.xml")))
|
|
n.Permalink = template.HTML(string(n.Site.BaseUrl))
|
|
if len(s.Pages) > 0 {
|
|
n.Date = s.Pages[0].Date
|
|
if len(s.Pages) < 9 {
|
|
n.Data["Pages"] = s.Pages
|
|
} else {
|
|
n.Data["Pages"] = s.Pages[:9]
|
|
}
|
|
}
|
|
x, err := s.RenderThing(n, "index.html")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
s.WritePublic("index.html", x.Bytes())
|
|
|
|
if a := s.Tmpl.Lookup("rss.xml"); a != nil {
|
|
// XML Feed
|
|
n.Url = Urlize("index.xml")
|
|
n.Title = "Recent Content"
|
|
n.Permalink = template.HTML(string(n.Site.BaseUrl) + "index.xml")
|
|
y := s.NewXMLBuffer()
|
|
s.Tmpl.ExecuteTemplate(y, "rss.xml", n)
|
|
s.WritePublic("index.xml", y.Bytes())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Site) Stats() {
|
|
fmt.Printf("%d pages created \n", len(s.Pages))
|
|
for _, pl := range s.Config.Indexes {
|
|
fmt.Printf("%d %s index created\n", len(s.Indexes[pl]), pl)
|
|
}
|
|
}
|
|
|
|
func (s *Site) NewNode() Node {
|
|
var y Node
|
|
y.Data = make(map[string]interface{})
|
|
y.Site = s.Info
|
|
|
|
return y
|
|
}
|
|
|
|
func (s *Site) RenderThing(d interface{}, layout string) (*bytes.Buffer, error) {
|
|
buffer := new(bytes.Buffer)
|
|
err := s.Tmpl.ExecuteTemplate(buffer, layout, d)
|
|
return buffer, err
|
|
}
|
|
|
|
func (s *Site) NewXMLBuffer() *bytes.Buffer {
|
|
header := "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>\n"
|
|
return bytes.NewBufferString(header)
|
|
}
|
|
|
|
func (s *Site) WritePublic(path string, content []byte) {
|
|
|
|
if s.Config.Verbose {
|
|
fmt.Println(path)
|
|
}
|
|
|
|
path, filename := filepath.Split(path)
|
|
|
|
path = filepath.FromSlash(s.Config.GetAbsPath(filepath.Join(s.Config.PublishDir, path)))
|
|
err := mkdirIf(path)
|
|
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
}
|
|
|
|
file, _ := os.Create(filepath.Join(path, filename))
|
|
defer file.Close()
|
|
|
|
file.Write(content)
|
|
}
|