aboutsummaryrefslogtreecommitdiff
path: root/hswg/main.go
blob: 65557c543beb8855fabaa7febc15234d3b96c2a1 (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
// Program hswg is a static website generator employing libasciidoc with added
// support for two-line/underlined titles, and postprocessing "wiki" InterLinks.
package main

import (
	"bytes"
	"encoding/binary"
	"encoding/xml"
	"fmt"
	"html/template"
	"io"
	"io/ioutil"
	"log"
	"os"
	"os/signal"
	"path/filepath"
	"regexp"
	"sort"
	"strings"
	"sync"
	"syscall"
	"time"

	"github.com/bytesparadise/libasciidoc/pkg/configuration"
	"github.com/bytesparadise/libasciidoc/pkg/parser"
	"github.com/bytesparadise/libasciidoc/pkg/renderer"
	"github.com/bytesparadise/libasciidoc/pkg/renderer/sgml/html5"
	"github.com/bytesparadise/libasciidoc/pkg/types"
	"github.com/bytesparadise/libasciidoc/pkg/validator"
)

// Metadata contains select metadata about a rendered document.
type Metadata struct {
	types.Metadata

	// Note that this includes entries from the front-matter
	// (see parser.ApplySubstitutions <- parser.ParseDocument).
	Attributes types.Attributes
}

// IsDraft returns whether the document is marked as a draft, and should not
// be linked anywhere else.
func (m *Metadata) IsDraft() bool { return m.Attributes.Has("draft") }

// Attr is a shortcut for retrieving document attributes by name.
func (m *Metadata) Attr(name string) string {
	return m.Attributes.GetAsStringWithDefault(name, "")
}

// AttrList is similar to Attr, but splits the result at commas,
// and trims whitespace around array elements.
func (m *Metadata) AttrList(name string) []string {
	if !m.Attributes.Has(name) {
		return nil
	}

	res := strings.Split(m.Attr(name), ",")
	for i := range res {
		res[i] = strings.TrimSpace(res[i])
	}
	return res
}

// Render converts an io.Reader with an AsciiDoc document to HTML. So long as
// the file could be read at all, it will always return a non-empty document.
func Render(r io.Reader, config configuration.Configuration) (
	html *bytes.Buffer, meta Metadata, err error) {
	html = bytes.NewBuffer(nil)

	var input []byte
	if input, err = ioutil.ReadAll(r); err != nil {
		return
	}

	pr, pw := io.Pipe()
	go func() {
		defer pw.Close()
		ConvertTitles(pw, input)
	}()

	// io.Copy(os.Stdout, pr)
	// return

	var doc types.Document
	if doc, err = parser.ParseDocument(pr, config); err == nil {
		problems, verr := validator.Validate(&doc)
		if verr != nil {
			fmt.Fprintln(os.Stderr, verr)
		}
		for _, problem := range problems {
			fmt.Fprintln(os.Stderr, problem.Message)
		}
		ctx := renderer.NewContext(doc, config)
		meta.Metadata, err = html5.Render(ctx, doc, html)
	}
	if err != nil {
		// Fallback: output all the text sanitized for direct inclusion.
		html.Reset()

		_, _ = html.WriteString("<pre>")
		for _, line := range bytes.Split(input, []byte{'\n'}) {
			_ = xml.EscapeText(html, line)
			_, _ = html.WriteString("\n")
		}
		_, _ = html.WriteString("</pre>")
	}
	meta.Attributes = doc.Attributes
	return
}

// Entry contains all context information about a single page.
type Entry struct {
	Metadata                        // metadata
	PathSource      string          // path to source AsciiDoc
	PathDestination string          // path to destination HTML
	mtime           time.Time       // modification time
	raw             []byte          // raw inner document
	Content         template.HTML   // inner document with expanded LinkWords
	backlinks       map[string]bool // what documents link back here
	Backlinks       []template.HTML
}

// Published returns the date when the entry was published, or nil if unknown.
func (e *Entry) Published() *time.Time {
	if d, ok, err := e.Attributes.GetAsString("date"); !ok || err != nil {
		return nil
	} else if t, err := time.Parse(time.RFC3339, d); err == nil {
		return &t
	} else if t, err := time.Parse("2006-01-02", d); err == nil {
		return &t
	} else {
		log.Printf("%s: date: %s\n", e.PathSource, err)
		return nil
	}
}

var (
	globs = []string{"*.adoc", "*.asciidoc"}
	extRE = regexp.MustCompile(`\.[^/.]*$`)
)

func pathToName(path string) string {
	return stripExtension(filepath.Base(path))
}

func stripExtension(path string) string {
	return extRE.ReplaceAllString(path, "")
}

func resultPath(path string) string {
	if m := extRE.FindStringIndex(path); m != nil {
		return path[:m[0]] + ".html"
	}
	return path + ".html"
}

func makeLink(m *map[string]*Entry, name string) string {
	e := (*m)[name]
	return fmt.Sprintf("<a href='%s'>%s</a>",
		filepath.Clean(e.PathDestination), name)
}

var linkWordRE = regexp.MustCompile(`\b\p{Lu}\p{L}*\b`)

func expand(m *map[string]*Entry, name string, chunk []byte) []byte {
	return linkWordRE.ReplaceAllFunc(chunk, func(match []byte) []byte {
		if link, ok := (*m)[string(match)]; ok && string(match) != name &&
			!link.IsDraft() {
			link.backlinks[name] = true
			return []byte(makeLink(m, string(match)))
		}
		return match
	})
}

var tagRE = regexp.MustCompile(`<[^<>]+>`)

func renderEntry(name string, e *Entry) error {
	f, err := os.Open(e.PathSource)
	if err != nil {
		return err
	}

	if i, err := f.Stat(); err != nil {
		return err
	} else {
		e.mtime = i.ModTime()
	}

	var html *bytes.Buffer
	if html, e.Metadata, err = Render(f, configuration.NewConfiguration(
		configuration.WithFilename(e.PathSource),
		configuration.WithLastUpdated(e.mtime),
	)); err != nil {
		return err
	}

	// Every page needs to have a title.
	if e.Title == "" {
		e.Title = name
	}

	e.raw = html.Bytes()
	return nil
}

func makeEntry(path string) *Entry {
	return &Entry{
		PathSource:      path,
		PathDestination: resultPath(path),
	}
}

// loadEntries creates a map from document names to their page entries.
func loadEntries(dirname string) (map[string]*Entry, error) {
	entries := map[string]*Entry{}
	for _, glob := range globs {
		matches, err := filepath.Glob(filepath.Join(dirname, glob))
		if err != nil {
			return nil, fmt.Errorf("%s: %s", dirname, err)
		}
		for _, path := range matches {
			name := pathToName(path)
			if conflict, ok := entries[name]; ok {
				return nil, fmt.Errorf("%s: conflicts with %s",
					name, conflict.PathSource)
			}
			entries[name] = makeEntry(path)
		}
	}
	return entries, nil
}

func writeEntry(e *Entry, t *template.Template,
	entries *map[string]*Entry) error {
	f, err := os.Create(e.PathDestination)
	if err != nil {
		return err
	}

	backlinks := []string{}
	for name := range e.backlinks {
		backlinks = append(backlinks, name)
	}
	sort.Strings(backlinks)
	for _, name := range backlinks {
		e.Backlinks =
			append(e.Backlinks, template.HTML(makeLink(entries, name)))
	}

	return t.Execute(f, e)
}

func writeIndex(path string, t *template.Template,
	entries *map[string]*Entry) error {
	// Reorder entries reversely, primarily by date, secondarily by filename.
	ordered := []*Entry{}
	for _, e := range *entries {
		ordered = append(ordered, e)
	}

	sort.Slice(ordered, func(i, j int) bool {
		a, b := ordered[i], ordered[j]
		p1, p2 := a.Published(), b.Published()
		if p1 == nil && p2 != nil {
			return true
		}
		if p1 == nil && p2 == nil {
			return a.PathSource > b.PathSource
		}
		if p2 == nil {
			return false
		}
		if p1.Equal(*p2) {
			return a.PathSource > b.PathSource
		}
		return p2.Before(*p1)
	})

	f, err := os.Create(path)
	if err != nil {
		return err
	}

	// TODO(p): Splitting content to categories would be nice. Or tags.
	return t.Execute(f, ordered)
}

func finalizeEntries(entries *map[string]*Entry, t *template.Template,
	indexPath string, indexT *template.Template) {
	// The initial render of a large amount of entries is resource-intensive.
	var wg sync.WaitGroup
	for name, e := range *entries {
		e.backlinks = map[string]bool{}
		if e.raw != nil {
			continue
		}

		wg.Add(1)
		go func(name string, e *Entry) {
			defer wg.Done()
			if err := renderEntry(name, e); err != nil {
				log.Printf("%s: %s\n", name, err)
			}
		}(name, e)
	}

	wg.Wait()

	for name, e := range *entries {
		// Expand LinkWords anywhere between <tags>.
		// We want something like the inverse of Regexp.ReplaceAllStringFunc.
		raw, last, expanded := e.raw, 0, bytes.NewBuffer(nil)
		for _, where := range tagRE.FindAllIndex(raw, -1) {
			_, _ = expanded.Write(expand(entries, name, raw[last:where[0]]))
			_, _ = expanded.Write(raw[where[0]:where[1]])
			last = where[1]
		}
		_, _ = expanded.Write(expand(entries, name, raw[last:]))
		e.Content = template.HTML(expanded.String())
	}
	for name, e := range *entries {
		// Don't overwrite failed renders.
		if e.raw == nil {
			continue
		}
		if err := writeEntry(e, t, entries); err != nil {
			log.Printf("%s: %s\n", name, err)
		}
	}
	if err := writeIndex(indexPath, indexT, entries); err != nil {
		log.Printf("%s: %s\n", indexPath, err)
	}
}

type watchEvent struct {
	path    string // the path of the target
	present bool   // if not, the file has been removed
}

func dispatchEvents(dirname string, r io.Reader, ch chan<- *watchEvent) error {
	var e syscall.InotifyEvent
	for {
		// FIXME(p): This has to respect the machine's endianness.
		// Perhaps use the unsafe package.
		err := binary.Read(r, binary.LittleEndian, &e)
		if err == io.EOF {
			return nil
		}
		if err != nil {
			return err
		}

		base := make([]byte, e.Len)
		if e.Len != 0 {
			if n, err := r.Read(base); err != nil {
				return err
			} else if n < int(e.Len) {
				return fmt.Errorf("short read")
			}
		}

		switch {
		case e.Mask&syscall.IN_IGNORED != 0:
			return fmt.Errorf("watch removed by kernel")
		case e.Mask&syscall.IN_Q_OVERFLOW != 0:
			log.Println("inotify: queue overflowed")
			ch <- nil
			continue
		case e.Len == 0:
			continue
		}

		basename, interesting := string(base[:bytes.IndexByte(base, 0)]), false
		for _, glob := range globs {
			if matches, _ := filepath.Match(glob, basename); matches {
				interesting = true
			}
		}
		if !interesting {
			continue
		}

		event := &watchEvent{path: filepath.Join(dirname, basename)}
		if e.Mask&syscall.IN_MODIFY != 0 || e.Mask&syscall.IN_MOVED_TO != 0 ||
			e.Mask&syscall.IN_CLOSE_WRITE != 0 {
			event.present = true
			ch <- event
		}
		if e.Mask&syscall.IN_DELETE != 0 || e.Mask&syscall.IN_MOVED_FROM != 0 {
			event.present = false
			ch <- event
		}
	}
}

func watchDirectory(dirname string) (<-chan *watchEvent, error) {
	inotifyFD, err := syscall.InotifyInit1(0)
	if err != nil {
		return nil, err
	}

	// We're ignoring IN_CREATE, as it doesn't seem to be useful,
	// and we're leaving out IN_MODIFY since VIM always triggers IN_CLOSE_WRITE,
	// saving us from having to coalesce plentiful similar events.
	_, err = syscall.InotifyAddWatch(inotifyFD, dirname, syscall.IN_ONLYDIR|
		syscall.IN_MOVE|syscall.IN_DELETE|syscall.IN_CLOSE_WRITE)
	if err != nil {
		return nil, err
	}

	inotifyFile := os.NewFile(uintptr(inotifyFD), "inotify")
	buf := make([]byte, syscall.SizeofInotifyEvent+syscall.PathMax+1)
	ch := make(chan *watchEvent)
	go func() {
		// Trigger an initial rendering run.
		ch <- nil

		defer close(ch)
		for {
			n, err := inotifyFile.Read(buf)
			if err != nil {
				log.Println(err)
				return
			}
			err = dispatchEvents(dirname, bytes.NewReader(buf[:n]), ch)
			if err != nil {
				log.Printf("inotify: %s\n", err)
				return
			}
		}
	}()
	return ch, nil
}

var funcs = template.FuncMap{
	"contains": func(needle string, haystack []string) bool {
		for _, el := range haystack {
			if el == needle {
				return true
			}
		}
		return false
	},
}

func singleFile() {
	html, meta, err := Render(os.Stdin, configuration.NewConfiguration())
	if err != nil {
		log.Println(err)
	} else if meta.Title != "" {
		_, _ = os.Stdout.WriteString("<h1>")
		_ = xml.EscapeText(os.Stdout, []byte(meta.Title))
		_, _ = os.Stdout.WriteString("</h1>\n")
	}
	_, _ = io.Copy(os.Stdout, html)
}

func main() {
	if len(os.Args) < 2 {
		singleFile()
		return
	}
	if len(os.Args) != 4 {
		log.Fatalf("usage: %s TEMPLATE INDEX DIRECTORY\n", os.Args[0])
	}

	argTemplate, argIndex, argDirectory := os.Args[1], os.Args[2], os.Args[3]

	// Read a template for entries.
	header, err := ioutil.ReadFile(argTemplate)
	if err != nil {
		log.Fatalln(err)
	}
	tmplEntry, err := template.New("entry").Funcs(funcs).Parse(string(header))
	if err != nil {
		log.Fatalln(err)
	}

	// Read a template for the index from the standard input.
	index, err := ioutil.ReadAll(os.Stdin)
	if err != nil {
		log.Fatalln(err)
	}
	tmplIndex, err := template.New("index").Funcs(funcs).Parse(string(index))
	if err != nil {
		log.Fatalln(err)
	}

	// Re-render as needed, avoid having to trigger anything manually.
	var entries map[string]*Entry
	directoryWatch, err := watchDirectory(argDirectory)
	if err != nil {
		log.Fatalln(err)
	}

	signals := make(chan os.Signal)
	signal.Notify(signals, syscall.SIGINT, syscall.SIGHUP, syscall.SIGTERM)
	for {
		select {
		case <-signals:
			os.Exit(0)
		case event, ok := <-directoryWatch:
			if !ok {
				os.Exit(1)
			}

			if event == nil {
				log.Println("reloading all files")
				if entries, err = loadEntries(argDirectory); err != nil {
					log.Println(err)
				}
			} else if event.present {
				log.Printf("updating %s\n", event.path)
				entries[pathToName(event.path)] = makeEntry(event.path)
			} else {
				log.Printf("removing %s\n", event.path)
				delete(entries, pathToName(event.path))
				os.Remove(resultPath(event.path))
			}

			finalizeEntries(&entries, tmplEntry, argIndex, tmplIndex)
			log.Println("done")
		}
	}
}