BlueGit

timfa bluegit

Files

bluegit / internal / server / help.go

help.go

help.go 3.7 KiB Download Raw
1package server
2
3import (
4 "html/template"
5 "io/fs"
6 "net/http"
7 "regexp"
8 "strings"
9
10 "gitlab.com/Timfa/bluegit/docs"
11 "gitlab.com/Timfa/bluegit/internal/i18n"
12 "gitlab.com/Timfa/bluegit/internal/markdown"
13)
14
15// helpDocs is de volgorde in /help. Een vertaling heet <naam>.<taal>.md
16// (bv. runner.en.md); het origineel is Nederlands.
17var helpDocs = []struct{ Slug, File string }{
18 {"runners", "runner"},
19 {"agents", "agents"},
20 {"ci", "CI"},
21 {"beheer", "BEHEER"},
22 {"ingress", "INGRESS"},
23 {"auth", "AUTH"},
24 {"aur", "AUR"},
25 {"migratie", "MIGRATIE"},
26 {"architecture", "ARCHITECTURE"},
27}
28
29// HelpDoc is één pagina in de lijst of op het scherm.
30type HelpDoc struct {
31 Slug string
32 Title string
33 Summary string
34 HTML template.HTML
35 Fallback bool // niet beschikbaar in de gekozen taal
36 On bool
37}
38
39var mdLink = regexp.MustCompile(`\[([^\]]+)\]\([^)]*\)`)
40
41var helpLink = regexp.MustCompile(`href="/help/([A-Za-z0-9_-]+)\.md(#[^"]*)?"`)
42
43// helpSource: eerst de gekozen taal, dan Engels (behalve voor NL), dan het origineel.
44func helpSource(file string, lang i18n.Lang) (string, bool) {
45 var try []string
46 if lang != i18n.NL {
47 try = append(try, file+"."+string(lang)+".md")
48 if lang != i18n.EN {
49 try = append(try, file+".en.md")
50 }
51 }
52 try = append(try, file+".md")
53 for i, name := range try {
54 b, err := fs.ReadFile(docs.FS, name)
55 if err != nil {
56 continue
57 }
58 exact := (i == 0 && lang != i18n.NL) || (lang == i18n.NL)
59 return string(b), !exact
60 }
61 return "", false
62}
63
64func helpSlugFor(file string) string {
65 for _, d := range helpDocs {
66 if strings.EqualFold(d.File, file) {
67 return d.Slug
68 }
69 }
70 return strings.ToLower(file)
71}
72
73func helpMeta(src string) (title, summary string) {
74 var para []string
75 for _, line := range strings.Split(src, "\n") {
76 t := strings.TrimSpace(line)
77 if title == "" {
78 if strings.HasPrefix(t, "# ") {
79 title = strings.TrimSpace(t[2:])
80 }
81 continue
82 }
83 if t == "" || strings.HasPrefix(t, "#") || strings.HasPrefix(t, "```") || strings.HasPrefix(t, "|") {
84 if len(para) > 0 {
85 break
86 }
87 continue
88 }
89 para = append(para, t)
90 }
91 summary = mdLink.ReplaceAllString(strings.Join(para, " "), "$1")
92 summary = strings.ReplaceAll(strings.ReplaceAll(summary, "`", ""), "**", "")
93 if r := []rune(summary); len(r) > 160 {
94 summary = string(r[:157]) + "…"
95 }
96 return
97}
98
99// renderHelp maakt HTML en zet links naar andere docs om naar /help/<slug>.
100func renderHelp(src string) template.HTML {
101 out := markdown.Render(src, "/help/", "", "")
102 out = helpLink.ReplaceAllStringFunc(out, func(m string) string {
103 sub := helpLink.FindStringSubmatch(m)
104 return `href="/help/` + helpSlugFor(sub[1]) + sub[2] + `"`
105 })
106 return template.HTML(out)
107}
108
109func helpList(lang i18n.Lang, current string) []HelpDoc {
110 var out []HelpDoc
111 for _, d := range helpDocs {
112 src, fb := helpSource(d.File, lang)
113 if src == "" {
114 continue
115 }
116 t, sum := helpMeta(src)
117 out = append(out, HelpDoc{Slug: d.Slug, Title: t, Summary: sum, Fallback: fb, On: d.Slug == current})
118 }
119 return out
120}
121
122func (s *Server) helpIndex(w http.ResponseWriter, r *http.Request) {
123 v := s.view(w, r, "title.help")
124 v.Page = "help"
125 v.Help = true
126 v.HelpDocs = helpList(s.langOf(r), "")
127 s.render(w, "help", v)
128}
129
130func (s *Server) helpPage(w http.ResponseWriter, r *http.Request) {
131 lang := s.langOf(r)
132 slug := strings.ToLower(r.PathValue("doc"))
133 for _, d := range helpDocs {
134 if d.Slug != slug {
135 continue
136 }
137 src, fb := helpSource(d.File, lang)
138 if src == "" {
139 break
140 }
141 t, _ := helpMeta(src)
142 v := s.view(w, r, t)
143 v.Page = "help"
144 v.Help = true
145 v.HelpDocs = helpList(lang, slug)
146 v.HelpDoc = &HelpDoc{Slug: slug, Title: t, HTML: renderHelp(src), Fallback: fb}
147 s.render(w, "help", v)
148 return
149 }
150 http.NotFound(w, r)
151}