wiki/backref.go

package main

import (
	"encoding/json"
	"fmt"
	"html/template"
	"os"
	"path/filepath"
	"strings"
)

type Reference struct {
	Link ParsedLink
	Name string
}

type Refs map[string][]Reference

func processBackrefs(dirname string, page Page) error {
	filename := filepath.Join(dirname, "backrefs.json")
	refs := make(Refs)

	err := loadBackrefs(filename, refs)
	if err != nil {
		return fmt.Errorf("while loading backrefs: %w", err)
	}

	err = processBackrefsForPage(page, refs)
	if err != nil {
		return fmt.Errorf("while processing backrefs for %q: %w", page.Name, err)
	}

	if err = saveBackrefs(filename, refs); err != nil {
		return fmt.Errorf("while saving backrefs: %w", err)
	}
	return nil
}

func saveBackrefs(filename string, refs Refs) error {
	f, err := os.Create(filename)
	if err != nil {
		return err
	}
	defer f.Close()

	return json.NewEncoder(f).Encode(&refs)
}

func processBackrefsForPage(page Page, refs Refs) error {
	content := page.Content

	var listItems []struct {
		Indented int
		Text     string
	}

	err := json.NewDecoder(strings.NewReader(content)).Decode(&listItems)
	if err == nil {
		pageText := ""
		for _, item := range listItems {
			pageText += strings.Repeat("  ", item.Indented) + "* " + item.Text + "\n"
		}

		content = pageText
	}

	links, err := ParseLinks(content)

	if err != nil {
		return err
	}

	for _, link := range links {
		// FIXME: this produces duplicates
		refs[link.PageName] = append(refs[link.PageName], Reference{link, page.Name})
	}

	return nil
}

func getBackrefs(fp *FilePages, p string) (map[string][]Backref, error) {
	refs := make(Refs)
	p = strings.Replace(p, " ", "_", -1)

	filename := filepath.Join(fp.dirname, "backrefs.json")
	err := loadBackrefs(filename, refs)
	if err != nil {
		return nil, err
	}

	result := make(map[string][]Backref)

	for _, ref := range refs[p] {
		title := strings.Replace(ref.Name, "_", " ", -1)
		if _, e := result[ref.Name]; !e {
			result[ref.Name] = nil
		}

		line := strings.TrimLeft(ref.Link.Line, " ")
		if line[0] == '*' && line[1] == ' ' {
			line = line[2:]
		}
		links := renderLinks(line)
		pageText := renderMarkdown2(links)

		removeBrackets := func(r rune) rune {
			if r == '[' || r == ']' || r == '*' {
				return -1
			}
			return r
		}

		result[ref.Name] = append(result[ref.Name], Backref{
			Name:     ref.Name,
			Title:    title,
			LineHTML: template.HTML(pageText),
			Line:     strings.Map(removeBrackets, ref.Link.Line),
		})
	}

	return result, nil
}

func loadBackrefs(filename string, refs Refs) error {
	f, err := os.Open(filename)
	if err != nil {
		return err
	}
	defer f.Close()
	err = json.NewDecoder(f).Decode(&refs)
	if err != nil {
		return err
	}
	return nil
}