about summary refs log tree commit diff stats
path: root/cmd/build/build.go
blob: f165361cb73fee45aca9a59f04bc8ada8688a707 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
package main

import (
	"bytes"
	"encoding/xml"
	"fmt"
	"io"
	"io/fs"
	"log"
	"log/slog"
	"net/url"
	"os"
	"path"
	"path/filepath"
	"slices"
	"strings"
	"time"

	"website/internal/atom"
	"website/internal/config"

	"github.com/BurntSushi/toml"
	"github.com/PuerkitoBio/goquery"
	"github.com/a-h/htmlformat"
	"github.com/adrg/frontmatter"
	"github.com/antchfx/xmlquery"
	"github.com/antchfx/xpath"
	"github.com/ardanlabs/conf/v3"
	mapset "github.com/deckarep/golang-set/v2"
	cp "github.com/otiai10/copy"
	"github.com/pkg/errors"
	"github.com/yuin/goldmark"
	"github.com/yuin/goldmark/extension"
	htmlrenderer "github.com/yuin/goldmark/renderer/html"
	"golang.org/x/net/html"
)

type PostMatter struct {
	Date        time.Time `toml:"date"`
	Description string    `toml:"description"`
	Title       string    `toml:"title"`
	Taxonomies  struct {
		Tags []string `toml:"tags"`
	} `toml:"taxonomies"`
}

type Post struct {
	Input    string
	Output   string
	Basename string
	URL      string
	Content  string
	PostMatter
}

type Tags mapset.Set[string]

func getPost(filename string) (*PostMatter, *[]byte, error) {
	matter := PostMatter{}
	content, err := os.Open(filename)
	defer content.Close()
	if err != nil {
		return nil, nil, errors.WithMessagef(err, "could not open post %s", filename)
	}
	rest, err := frontmatter.MustParse(content, &matter)
	if err != nil {
		return nil, nil, errors.WithMessagef(err, "could not parse front matter of post %s", filename)
	}

	return &matter, &rest, nil
}

func readPosts(root string, inputDir string, outputDir string) ([]Post, Tags, error) {
	tags := mapset.NewSet[string]()
	posts := []Post{}
	subdir := filepath.Join(root, inputDir)
	files, err := os.ReadDir(subdir)
	if err != nil {
		return nil, nil, errors.WithMessagef(err, "could not read post directory %s", subdir)
	}
	outputReplacer := strings.NewReplacer(root, outputDir, ".md", "/index.html")
	urlReplacer := strings.NewReplacer(root, "", ".md", "/")
	markdown := goldmark.New(
		goldmark.WithRendererOptions(
			htmlrenderer.WithUnsafe(),
		),
		goldmark.WithExtensions(
			extension.GFM,
			extension.Footnote,
			extension.Typographer,
		),
	)
	for _, f := range files {
		pathFromRoot := filepath.Join(subdir, f.Name())
		if !f.IsDir() && path.Ext(pathFromRoot) == ".md" {
			output := outputReplacer.Replace(pathFromRoot)
			url := urlReplacer.Replace(pathFromRoot)
			slog.Debug("reading post", "post", pathFromRoot)
			matter, content, err := getPost(pathFromRoot)
			if err != nil {
				return nil, nil, err
			}

			for _, tag := range matter.Taxonomies.Tags {
				tags.Add(strings.ToLower(tag))
			}

			var buf bytes.Buffer
			slog.Debug("rendering markdown in post", "post", pathFromRoot)
			if err := markdown.Convert(*content, &buf); err != nil {
				return nil, nil, errors.WithMessage(err, "could not convert markdown content")
			}
			post := Post{
				Input:      pathFromRoot,
				Output:     output,
				Basename:   filepath.Base(url),
				URL:        url,
				PostMatter: *matter,
				Content:    buf.String(),
			}

			posts = append(posts, post)
		}
	}
	slices.SortFunc(posts, func(a, b Post) int {
		return b.Date.Compare(a.Date)
	})
	return posts, tags, nil
}

func layout(filename string, config config.Config, pageTitle string) (*goquery.Document, error) {
	html, err := os.Open(filename)
	if err != nil {
		return nil, err
	}
	defer html.Close()
	css, err := os.ReadFile("templates/style.css")
	if err != nil {
		return nil, err
	}
	doc, err := goquery.NewDocumentFromReader(html)
	if err != nil {
		return nil, err
	}
	doc.Find("html").SetAttr("lang", config.DefaultLanguage)
	doc.Find("head > link[rel=alternate]").SetAttr("title", config.Title)
	doc.Find(".title").SetText(config.Title)
	doc.Find("title").Add(".p-name").SetText(pageTitle)
	doc.Find("head > style").SetHtml("\n" + string(css))
	nav := doc.Find("nav")
	navLink := doc.Find("nav a")
	nav.Empty()
	for _, link := range config.Menus["main"] {
		nav.AppendSelection(navLink.Clone().SetAttr("href", link.URL).SetText(link.Name))
	}
	return doc, nil
}

func renderHTML(doc *goquery.Document) io.Reader {
	r, w := io.Pipe()

	// TODO: return errors to main thread
	go func() {
		w.Write([]byte("<!doctype html>\n"))
		err := htmlformat.Nodes(w, []*html.Node{doc.Children().Get(0)})
		if err != nil {
			slog.Error("error rendering html", "error", err)
			w.CloseWithError(err)
			return
		}
		defer w.Close()
	}()
	return r
}

func renderPost(post Post, config config.Config) (r io.Reader, err error) {
	doc, err := layout("templates/post.html", config, post.PostMatter.Title)
	if err != nil {
		return nil, err
	}
	doc.Find(".title").AddClass("p-author h-card").SetAttr("rel", "author")
	doc.Find(".h-entry .dt-published").
		SetAttr("datetime", post.PostMatter.Date.UTC().Format(time.RFC3339)).
		SetText(
			post.PostMatter.Date.Format("2006-01-02"),
		)
	doc.Find(".h-entry .e-content").SetHtml(post.Content)
	categories := doc.Find(".h-entry .p-categories")
	tpl := categories.Find(".p-category").ParentsUntilSelection(categories)
	tpl.Remove()
	for _, tag := range post.Taxonomies.Tags {
		cat := tpl.Clone()
		cat.Find(".p-category").SetAttr("href", fmt.Sprintf("/tags/%s/", tag)).SetText("#" + tag)
		categories.AppendSelection(cat)
	}

	return renderHTML(doc), nil
}

func renderTags(tags Tags, config config.Config) (io.Reader, error) {
	doc, err := layout("templates/tags.html", config, config.Title)
	if err != nil {
		return nil, err
	}
	tagList := doc.Find(".tags")
	tpl := doc.Find(".h-feed")
	tpl.Remove()
	for _, tag := range mapset.Sorted(tags) {
		li := tpl.Clone()
		li.Find("a").SetAttr("href", fmt.Sprintf("/tags/%s/", tag)).SetText("#" + tag)
		tagList.AppendSelection(li)
	}
	return renderHTML(doc), nil
}

func renderListPage(tag string, config config.Config, posts []Post) (io.Reader, error) {
	var title string
	if len(tag) > 0 {
		title = tag
	} else {
		title = config.Title
	}
	doc, err := layout("templates/list.html", config, title)
	if err != nil {
		return nil, err
	}
	feed := doc.Find(".h-feed")
	tpl := feed.Find(".h-entry")
	tpl.Remove()

	doc.Find(".title").AddClass("p-author h-card").SetAttr("rel", "author")
	if tag == "" {
		doc.Find(".filter").Remove()
	} else {
		doc.Find(".filter").Find("h3").SetText("#" + tag)
	}

	for _, post := range posts {
		entry := tpl.Clone()
		entry.Find(".p-name").SetText(post.Title).SetAttr("href", post.URL)
		entry.Find(".dt-published").
			SetAttr("datetime", post.PostMatter.Date.UTC().Format(time.RFC3339)).
			SetText(post.PostMatter.Date.Format("2006-01-02"))
		feed.AppendSelection(entry)
	}

	return renderHTML(doc), nil
}

func renderHomepage(config config.Config, posts []Post) (io.Reader, error) {
	_, index, err := getPost("content/_index.md")
	if err != nil {
		return nil, err
	}
	doc, err := layout("templates/homepage.html", config, config.Title)
	if err != nil {
		return nil, err
	}
	doc.Find("body").AddClass("h-card")
	doc.Find(".title").AddClass("p-name u-url")
	var buf bytes.Buffer

	md := goldmark.New(goldmark.WithRendererOptions(htmlrenderer.WithUnsafe()))
	if err := md.Convert(*index, &buf); err != nil {
		return nil, err
	}
	doc.Find("#content").SetHtml(buf.String())

	feed := doc.Find(".h-feed")
	tpl := feed.Find(".h-entry")
	tpl.Remove()

	for _, post := range posts[0:3] {
		entry := tpl.Clone()
		entry.Find(".p-name").SetText(post.Title)
		entry.Find(".u-url").SetAttr("href", post.URL)
		entry.
			Find(".dt-published").
			SetAttr("datetime", post.PostMatter.Date.UTC().Format(time.RFC3339)).
			SetText(post.PostMatter.Date.Format("2006-01-02"))

		feed.AppendSelection(entry)
	}
	doc.Find(".u-email").
		SetAttr("href", fmt.Sprintf("mailto:%s", config.Email)).
		SetText(config.Email)

	elsewhere := doc.Find(".elsewhere")
	linkRelMe := elsewhere.Find(".u-url[rel=me]").ParentsUntil("ul")
	linkRelMe.Remove()

	for _, link := range config.Menus["me"] {
		el := linkRelMe.Clone()
		el.Find("a").SetAttr("href", link.URL).SetText(link.Name)
		elsewhere.AppendSelection(el)
	}

	return renderHTML(doc), nil
}

func render404(config config.Config) (io.Reader, error) {
	doc, err := layout("templates/404.html", config, "404 Not Found")
	if err != nil {
		return nil, err
	}
	return renderHTML(doc), nil
}

func renderFeed(title string, config config.Config, posts []Post, specific string) (io.Reader, error) {
	reader, err := os.Open("templates/feed.xml")
	if err != nil {
		return nil, err
	}
	defer reader.Close()
	doc, err := xmlquery.Parse(reader)
	feed := doc.SelectElement("feed")
	feed.SelectElement("title").FirstChild.Data = title
	feed.SelectElement("link").SetAttr("href", config.BaseURL.String())
	feed.SelectElement("id").FirstChild.Data = atom.MakeTagURI(config, specific)
	datetime, err := posts[0].Date.UTC().MarshalText()
	feed.SelectElement("updated").FirstChild.Data = string(datetime)
	tpl := feed.SelectElement("entry")
	xmlquery.RemoveFromTree(tpl)

	for _, post := range posts {
		fullURL, err := url.JoinPath(config.BaseURL.String(), post.URL)
		if err != nil {
			return nil, err
		}
		text, err := xml.MarshalIndent(&atom.FeedEntry{
			Title:   post.Title,
			Link:    atom.MakeLink(fullURL),
			Id:      atom.MakeTagURI(config, post.Basename),
			Updated: post.Date.UTC(),
			Summary: post.Description,
			Author:  config.Title,
			Content: atom.FeedContent{
				Content: post.Content,
				Type:    "html",
			},
		}, "  ", "    ")
		if err != nil {
			return nil, err
		}
		entry, err := xmlquery.ParseWithOptions(strings.NewReader(string(text)), xmlquery.ParserOptions{
			Decoder: &xmlquery.DecoderOptions{
				Strict:    false,
				AutoClose: xml.HTMLAutoClose,
				Entity:    xml.HTMLEntity,
			},
		})
		if err != nil {
			return nil, err
		}
		xmlquery.AddChild(feed, entry.SelectElement("entry"))
	}

	return strings.NewReader(doc.OutputXML(true)), nil
}

func renderFeedStyles() (io.Reader, error) {
	reader, err := os.Open("templates/feed-styles.xsl")
	if err != nil {
		return nil, err
	}
	defer reader.Close()
	nsMap := map[string]string{
		"xsl":   "http://www.w3.org/1999/XSL/Transform",
		"atom":  "http://www.w3.org/2005/Atom",
		"xhtml": "http://www.w3.org/1999/xhtml",
	}
	doc, err := xmlquery.Parse(reader)
	expr, err := xpath.CompileWithNS("//xhtml:style", nsMap)
	if err != nil {
		return nil, err
	}
	style := xmlquery.QuerySelector(doc, expr)
	css, err := os.ReadFile("templates/style.css")
	if err != nil {
		return nil, err
	}
	xmlquery.AddChild(style, &xmlquery.Node{
		Type: xmlquery.TextNode,
		Data: string(css),
	})
	return strings.NewReader(doc.OutputXML(true)), nil
}

func mkdirp(dirs ...string) error {
	return os.MkdirAll(path.Join(dirs...), 0755)
}

func outputToFile(output io.Reader, filename ...string) error {
	file, err := os.OpenFile(path.Join(filename...), os.O_WRONLY|os.O_CREATE, 0644)
	if err != nil {
		return errors.WithMessage(err, "could not open output file")
	}
	defer file.Close()

	if _, err := file.ReadFrom(output); err != nil {
		return errors.WithMessage(err, "could not write output file")
	}
	return nil
}

func build(outDir string, config config.Config) error {
	privateDir := path.Join(outDir, "private")
	if err := mkdirp(privateDir); err != nil {
		return errors.Errorf("could not create private directory: %w", err)
	}
	publicDir := path.Join(outDir, "public")
	if err := mkdirp(publicDir); err != nil {
		return errors.Errorf("could not create public directory: %w", err)
	}

	err := cp.Copy("static", publicDir, cp.Options{
		PreserveTimes:     true,
		PermissionControl: cp.AddPermission(0755),
	})
	if err != nil {
		log.Panic(errors.Errorf("could not copy static files: %v", err))
	}

	if err := mkdirp(publicDir, "post"); err != nil {
		return errors.WithMessage(err, "could not create post output directory")
	}
	slog.Debug("reading posts")
	posts, tags, err := readPosts("content", "post", publicDir)
	if err != nil {
		return err
	}

	for _, post := range posts {
		if err := mkdirp(publicDir, "post", post.Basename); err != nil {
			return errors.WithMessage(err, "could not create directory for post")
		}
		slog.Debug("rendering post", "post", post.Basename)
		output, err := renderPost(post, config)
		if err != nil {
			return errors.WithMessagef(err, "could not render post %s", post.Input)
		}
		if err := outputToFile(output, post.Output); err != nil {
			return err
		}
	}

	if err := mkdirp(publicDir, "tags"); err != nil {
		return errors.WithMessage(err, "could not create directory for tags")
	}
	slog.Debug("rendering tags list")
	output, err := renderTags(tags, config)
	if err != nil {
		return errors.WithMessage(err, "could not render tags")
	}
	if err := outputToFile(output, publicDir, "tags", "index.html"); err != nil {
		return err
	}

	for _, tag := range tags.ToSlice() {
		matchingPosts := []Post{}
		for _, post := range posts {
			if slices.Contains(post.Taxonomies.Tags, tag) {
				matchingPosts = append(matchingPosts, post)
			}
		}
		if err := mkdirp(publicDir, "tags", tag); err != nil {
			return errors.WithMessage(err, "could not create directory")
		}
		slog.Debug("rendering tags page", "tag", tag)
		output, err := renderListPage(tag, config, matchingPosts)
		if err != nil {
			return errors.WithMessage(err, "could not render tag page")
		}
		if err := outputToFile(output, publicDir, "tags", tag, "index.html"); err != nil {
			return err
		}

		slog.Debug("rendering tags feed", "tag", tag)
		output, err = renderFeed(fmt.Sprintf("%s - %s", config.Title, tag), config, matchingPosts, tag)
		if err != nil {
			return errors.WithMessage(err, "could not render tag feed page")
		}
		if err := outputToFile(output, publicDir, "tags", tag, "atom.xml"); err != nil {
			return err
		}
	}

	slog.Debug("rendering list page")
	listPage, err := renderListPage("", config, posts)
	if err != nil {
		return errors.WithMessage(err, "could not render list page")
	}
	if err := outputToFile(listPage, publicDir, "post", "index.html"); err != nil {
		return err
	}

	slog.Debug("rendering feed")
	feed, err := renderFeed(config.Title, config, posts, "feed")
	if err != nil {
		return errors.WithMessage(err, "could not render feed")
	}
	if err := outputToFile(feed, publicDir, "atom.xml"); err != nil {
		return err
	}

	slog.Debug("rendering feed styles")
	feedStyles, err := renderFeedStyles()
	if err != nil {
		return errors.WithMessage(err, "could not render feed styles")
	}
	if err := outputToFile(feedStyles, publicDir, "feed-styles.xsl"); err != nil {
		return err
	}

	slog.Debug("rendering homepage")
	homePage, err := renderHomepage(config, posts)
	if err != nil {
		return errors.WithMessage(err, "could not render homepage")
	}
	if err := outputToFile(homePage, publicDir, "index.html"); err != nil {
		return err
	}

	slog.Debug("rendering 404 page")
	notFound, err := render404(config)
	if err != nil {
		return errors.WithMessage(err, "could not render 404 page")
	}
	if err := outputToFile(notFound, privateDir, "404.html"); err != nil {
		return err
	}

	return nil
}

type IOConfig struct {
	Source      string `conf:"default:.,short:s"`
	Destination string `conf:"default:website,short:d"`
	BaseURL     config.URL
}

func main() {
	if os.Getenv("DEBUG") != "" {
		slog.SetLogLoggerLevel(slog.LevelDebug)
	}
	slog.Debug("starting build process")

	ioConfig := IOConfig{}
	if help, err := conf.Parse("", &ioConfig); err != nil {
		if errors.Is(err, conf.ErrHelpWanted) {
			fmt.Println(help)
			os.Exit(1)
		}
		log.Panicf("parsing I/O configuration: %v", err)
	}

	if ioConfig.Source != "." {
		err := os.Chdir(ioConfig.Source)
		if err != nil {
			log.Panic("could not change to source directory")
		}
	}

	config, err := config.GetConfig()
	if err != nil {
		log.Panic(errors.Errorf("could not get config: %v", err))
	}

	if ioConfig.BaseURL.URL != nil {
		config.BaseURL.URL, err = url.Parse(ioConfig.BaseURL.String())
		if err != nil {
			log.Panic(errors.Errorf("highly unlikely: %v", err))
		}
	}

	err = os.RemoveAll(ioConfig.Destination)
	if err != nil {
		log.Panic(errors.Errorf("could not remove public directory: %v", err))
	}

	if err := build(ioConfig.Destination, *config); err != nil {
		switch cause := errors.Cause(err).(type) {
		case *fs.PathError:
			slog.Info("pathError")
			slog.Error(fmt.Sprintf("%s", err))
		case toml.ParseError:
			slog.Info("parseError")
			slog.Error(fmt.Sprintf("%s", err))
		default:
			slog.Info("other")
			slog.Error(fmt.Sprintf("cause:%+v", errors.Cause(cause)))
			slog.Error(fmt.Sprintf("%+v", cause))
		}
		os.Exit(1)
	}

	slog.Debug("done")
}