aboutsummaryrefslogtreecommitdiffhomepage
path: root/hugolib/site.go
diff options
context:
space:
mode:
Diffstat (limited to 'hugolib/site.go')
-rw-r--r--hugolib/site.go362
1 files changed, 362 insertions, 0 deletions
diff --git a/hugolib/site.go b/hugolib/site.go
new file mode 100644
index 000000000..210bde7e2
--- /dev/null
+++ b/hugolib/site.go
@@ -0,0 +1,362 @@
+// Copyright © 2013 Steve Francia <[email protected]>.
+//
+// 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"
+ "fmt"
+ "github.com/spf13/nitro"
+ "html/template"
+ "io/ioutil"
+ "os"
+ "path/filepath"
+ "strings"
+ "time"
+ //"sync"
+)
+
+type Site struct {
+ c 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
+}
+
+func (s *Site) getFromIndex(kind string, name string) Pages {
+ return s.Indexes[kind][name]
+}
+
+func NewSite(config *Config) *Site {
+ return &Site{c: *config, timer: nitro.Initalize()}
+}
+
+func (site *Site) Build() {
+ site.Process()
+ site.Render()
+ site.Write()
+}
+
+func (site *Site) Analyze() {
+ site.Process()
+ site.checkDescriptions()
+}
+
+func (site *Site) Process() {
+ site.initialize()
+ site.prepTemplates()
+ site.timer.Step("initialize & template prep")
+ site.CreatePages()
+ site.timer.Step("import pages")
+ site.BuildSiteMeta()
+ site.timer.Step("build indexes")
+}
+
+func (site *Site) Render() {
+ site.RenderIndexes()
+ site.timer.Step("render and write indexes")
+ site.RenderLists()
+ site.timer.Step("render and write lists")
+ site.RenderPages()
+ site.timer.Step("render pages")
+ site.ProcessShortcodes()
+ site.timer.Step("render shortcodes")
+ site.RenderHomePage()
+ site.timer.Step("render and write homepage")
+}
+
+func (site *Site) Write() {
+ site.WritePages()
+ site.timer.Step("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)
+
+ walker := func(path string, fi os.FileInfo, err error) error {
+ if err != nil {
+ PrintErr("Walker: ", err)
+ return nil
+ }
+
+ if !fi.IsDir() {
+ filetext, err := ioutil.ReadFile(path)
+ if err != nil {
+ return err
+ }
+ text := string(filetext)
+ name := path[len(s.c.GetAbsPath(s.c.LayoutDir))+1:]
+ t := templates.New(name)
+ template.Must(t.Parse(text))
+ }
+ return nil
+ }
+
+ filepath.Walk(s.c.GetAbsPath(s.c.LayoutDir), walker)
+
+ s.Tmpl = templates
+}
+
+func (s *Site) initialize() {
+ site := s
+
+ s.checkDirectories()
+
+ walker := func(path string, fi os.FileInfo, err error) error {
+ if err != nil {
+ PrintErr("Walker: ", err)
+ return nil
+ }
+
+ if fi.IsDir() {
+ site.Directories = append(site.Directories, path)
+ return nil
+ } else {
+ site.Files = append(site.Files, path)
+ return nil
+ }
+ return nil
+ }
+
+ filepath.Walk(s.c.GetAbsPath(s.c.SourceDir), walker)
+
+ s.Info = SiteInfo{BaseUrl: template.URL(s.c.BaseUrl)}
+
+ s.Shortcodes = make(map[string]ShortcodeFunc)
+}
+
+func (s *Site) checkDirectories() {
+ if b, _ := dirExists(s.c.GetAbsPath(s.c.LayoutDir)); !b {
+ FatalErr("No layout directory found, expecting to find it at " + s.c.GetAbsPath(s.c.LayoutDir))
+ }
+ if b, _ := dirExists(s.c.GetAbsPath(s.c.SourceDir)); !b {
+ FatalErr("No source directory found, expecting to find it at " + s.c.GetAbsPath(s.c.SourceDir))
+ }
+ mkdirIf(s.c.GetAbsPath(s.c.PublishDir))
+}
+
+func (s *Site) ProcessShortcodes() {
+ for i, _ := range s.Pages {
+ var bb bytes.Buffer
+ bb.WriteString(ShortcodesHandle(s.Pages[i].RenderedContent.String(), s.Pages[i], s.Tmpl))
+ s.Pages[i].RenderedContent = &bb
+ }
+}
+
+func (s *Site) CreatePages() {
+ for _, fileName := range s.Files {
+ page := NewPage(fileName)
+ page.Site = s.Info
+ page.Tmpl = s.Tmpl
+ if s.c.BuildDrafts || !page.Draft {
+ s.Pages = append(s.Pages, page)
+ }
+ }
+
+ s.Pages.Sort()
+}
+
+func (s *Site) BuildSiteMeta() {
+ s.Indexes = make(IndexList)
+ s.Sections = make(Index)
+
+ for _, plural := range s.c.Indexes {
+ s.Indexes[plural] = make(Index)
+ for i, p := range s.Pages {
+ vals := p.GetParam(plural)
+
+ if vals != nil {
+ for _, idx := range vals.([]string) {
+ s.Indexes[plural].Add(idx, s.Pages[i])
+ }
+ }
+ }
+ for k, _ := range s.Indexes[plural] {
+ s.Indexes[plural][k].Sort()
+ }
+ }
+
+ for i, p := range s.Pages {
+ sect := p.GetSection()
+ s.Sections.Add(sect, s.Pages[i])
+ }
+
+ for k, _ := range s.Sections {
+ s.Sections[k].Sort()
+ }
+
+ s.Info.Indexes = s.Indexes.BuildOrderedIndexList()
+
+ s.Info.LastChange = s.Pages[0].Date
+}
+
+func (s *Site) RenderPages() {
+ for i, _ := range s.Pages {
+ s.Pages[i].RenderedContent = s.RenderThing(s.Pages[i], s.Pages[i].Layout())
+ }
+}
+
+func (s *Site) WritePages() {
+ for _, p := range s.Pages {
+ s.WritePublic(p.Section, p.OutFile, p.RenderedContent.Bytes())
+ }
+}
+
+func (s *Site) RenderIndexes() {
+ for singular, plural := range s.c.Indexes {
+ for k, o := range s.Indexes[plural] {
+ n := s.NewNode()
+ n.Title = strings.Title(k)
+ url := Urlize(plural + "/" + k)
+ n.Url = url + ".html"
+ n.Permalink = template.HTML(MakePermalink(string(n.Site.BaseUrl), string(n.Url)))
+ 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 := s.RenderThing(n, layout)
+ s.WritePublic(plural, k+".html", x.Bytes())
+
+ if a := s.Tmpl.Lookup("rss.xml"); a != nil {
+ // XML Feed
+ y := s.NewXMLBuffer()
+ n.Url = Urlize(plural + "/" + k + ".xml")
+ s.Tmpl.ExecuteTemplate(y, "rss.xml", n)
+ s.WritePublic(plural, k+".xml", y.Bytes())
+ }
+ }
+ }
+}
+
+func (s *Site) RenderLists() {
+ 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+"/index.xml")))
+ n.Date = data[0].Date
+ n.Data["Pages"] = data
+ layout := "indexes/" + section + ".html"
+
+ x := s.RenderThing(n, layout)
+ s.WritePublic(section, "index.html", x.Bytes())
+
+ if a := s.Tmpl.Lookup("rss.xml"); a != nil {
+ // XML Feed
+ n.Url = Urlize(section + "/index.xml")
+ y := s.NewXMLBuffer()
+ s.Tmpl.ExecuteTemplate(y, "rss.xml", n)
+ s.WritePublic(section, "index.xml", y.Bytes())
+ }
+ }
+}
+
+func (s *Site) RenderHomePage() {
+ n := s.NewNode()
+ n.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))
+ n.Date = s.Pages[0].Date
+ if len(s.Pages) < 9 {
+ n.Data["Pages"] = s.Pages
+ } else {
+ n.Data["Pages"] = s.Pages[:9]
+ }
+ x := s.RenderThing(n, "index.html")
+ s.WritePublic("", "index.html", x.Bytes())
+
+ if a := s.Tmpl.Lookup("rss.xml"); a != nil {
+ // XML Feed
+ n.Url = Urlize("index.xml")
+ y := s.NewXMLBuffer()
+ s.Tmpl.ExecuteTemplate(y, "rss.xml", n)
+ s.WritePublic("", "index.xml", y.Bytes())
+ }
+}
+
+func (s *Site) Stats() {
+ fmt.Printf("%d pages created \n", len(s.Pages))
+ for _, pl := range s.c.Indexes {
+ fmt.Printf("%d %s 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 {
+ buffer := new(bytes.Buffer)
+ s.Tmpl.ExecuteTemplate(buffer, layout, d)
+ return buffer
+}
+
+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, filename string, content []byte) {
+ AbsPath := ""
+ if path != "" {
+ // TODO double check the following line.. calling GetAbsPath 2x seems wrong
+ mkdirIf(s.c.GetAbsPath(filepath.Join(s.c.GetAbsPath(s.c.PublishDir), path)))
+ AbsPath = filepath.Join(s.c.GetAbsPath(s.c.PublishDir), path, filename)
+ } else {
+ AbsPath = filepath.Join(s.c.GetAbsPath(s.c.PublishDir), filename)
+ }
+
+ file, _ := os.Create(AbsPath)
+ defer file.Close()
+
+ file.Write(content)
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 17:22:08 +0000