BlueGit

timfa bluegit

Files

bluegit / internal / markdown / markdown.go

markdown.go

markdown.go 13.0 KiB Download Raw
1// Package markdown zet een beperkte Markdown-tekst om naar HTML.
2// Ruwe HTML uit het bestand wordt geëscaped.
3package markdown
4
5import (
6 "fmt"
7 "html"
8 "net/url"
9 "strconv"
10 "strings"
11)
12
13// Tasks maakt takenlijsten klikbaar. Een leeg Post-adres of CanToggle onwaar
14// laat een vast vinkje zien. Count is een tekst met twee %d: af, totaal.
15// Het volgnummer is de volgorde in het document, dezelfde als SetTask.
16type Tasks struct {
17 Post string
18 CSRF string
19 Kind string
20 ID string
21 CanToggle bool
22 Count string
23 Toggle string
24}
25
26// Render maakt HTML. Relatieve links krijgen linkBase ervoor, plus rev.
27// repoPath is /owner/repo. Dan worden #12 en !5 links naar dat issue of die merge request.
28func Render(src, linkBase, rev, repoPath string) string {
29 return RenderTasks(src, linkBase, rev, repoPath, Tasks{})
30}
31
32// RenderTasks is Render plus aanvinkbare taken.
33func RenderTasks(src, linkBase, rev, repoPath string, tasks Tasks) string {
34 lines := strings.Split(strings.ReplaceAll(src, "\r\n", "\n"), "\n")
35 hits := indexTasks(lines)
36 var b strings.Builder
37 for i := 0; i < len(lines); {
38 line := lines[i]
39 trim := strings.TrimSpace(line)
40 if trim == "" {
41 i++
42 continue
43 }
44 if strings.HasPrefix(trim, "```") {
45 var body []string
46 i++
47 for i < len(lines) && !strings.HasPrefix(strings.TrimSpace(lines[i]), "```") {
48 body = append(body, lines[i])
49 i++
50 }
51 if i < len(lines) {
52 i++
53 }
54 b.WriteString("<pre><code>")
55 b.WriteString(html.EscapeString(strings.Join(body, "\n")))
56 b.WriteString("</code></pre>\n")
57 continue
58 }
59 if isTableStart(lines, i) {
60 b.WriteString(table(lines, &i, linkBase, rev, repoPath))
61 continue
62 }
63 if strings.HasPrefix(trim, "#") {
64 n := 0
65 for n < len(trim) && trim[n] == '#' && n < 6 {
66 n++
67 }
68 if n > 0 && (n == len(trim) || trim[n] == ' ') {
69 h := strconv.Itoa(n)
70 b.WriteString("<h" + h + ">")
71 b.WriteString(inline(strings.TrimSpace(trim[n:]), linkBase, rev, repoPath))
72 b.WriteString("</h" + h + ">\n")
73 i++
74 continue
75 }
76 }
77 if isList(trim) {
78 type row struct {
79 text string
80 task bool
81 checked bool
82 index int
83 }
84 var rows []row
85 done, total := 0, 0
86 for i < len(lines) && isList(strings.TrimSpace(lines[i])) {
87 item := strings.TrimSpace(lines[i])
88 item = strings.TrimPrefix(item, "- ")
89 item = strings.TrimPrefix(item, "* ")
90 if hit, ok := hits[i]; ok && len(item) >= 3 {
91 item = strings.TrimSpace(item[3:])
92 rows = append(rows, row{text: item, task: true, checked: hit.checked, index: hit.index})
93 total++
94 if hit.checked {
95 done++
96 }
97 } else {
98 rows = append(rows, row{text: item})
99 }
100 i++
101 }
102 if total > 0 {
103 b.WriteString(`<p class="taskcount">`)
104 b.WriteString(html.EscapeString(fmt.Sprintf(taskCountFmt(tasks.Count), done, total)))
105 b.WriteString("</p>\n<ul class=\"tasks\">\n")
106 } else {
107 b.WriteString("<ul>\n")
108 }
109 for _, row := range rows {
110 b.WriteString("<li>")
111 if row.task {
112 b.WriteString(taskBox(row.checked, row.index, tasks))
113 }
114 b.WriteString(inline(row.text, linkBase, rev, repoPath))
115 b.WriteString("</li>\n")
116 }
117 b.WriteString("</ul>\n")
118 continue
119 }
120 var para []string
121 for i < len(lines) && strings.TrimSpace(lines[i]) != "" && !strings.HasPrefix(strings.TrimSpace(lines[i]), "```") && !strings.HasPrefix(strings.TrimSpace(lines[i]), "#") && !isList(strings.TrimSpace(lines[i])) && !isTableStart(lines, i) {
122 para = append(para, strings.TrimSpace(lines[i]))
123 i++
124 }
125 b.WriteString("<p>")
126 b.WriteString(inline(strings.Join(para, " "), linkBase, rev, repoPath))
127 b.WriteString("</p>\n")
128 }
129 return b.String()
130}
131
132func isList(trim string) bool {
133 return strings.HasPrefix(trim, "- ") || strings.HasPrefix(trim, "* ")
134}
135
136type taskHit struct {
137 index int
138 checked bool
139}
140
141// SetTask zet het vinkje met dit volgnummer. ok is onwaar als dat nummer er niet is.
142func SetTask(src string, index int, checked bool) (string, bool) {
143 if index < 0 {
144 return src, false
145 }
146 lines := strings.Split(strings.ReplaceAll(src, "\r\n", "\n"), "\n")
147 hits := indexTasks(lines)
148 for i, hit := range hits {
149 if hit.index != index {
150 continue
151 }
152 lines[i] = rewriteTask(lines[i], checked)
153 return strings.Join(lines, "\n"), true
154 }
155 return src, false
156}
157
158// indexTasks loopt dezelfde blokken als Render, zodat een hek of een tabel geen taak is.
159func indexTasks(lines []string) map[int]taskHit {
160 out := map[int]taskHit{}
161 n := 0
162 for i := 0; i < len(lines); {
163 trim := strings.TrimSpace(lines[i])
164 if trim == "" {
165 i++
166 continue
167 }
168 if strings.HasPrefix(trim, "```") {
169 i++
170 for i < len(lines) && !strings.HasPrefix(strings.TrimSpace(lines[i]), "```") {
171 i++
172 }
173 if i < len(lines) {
174 i++
175 }
176 continue
177 }
178 if isTableStart(lines, i) {
179 i += 2
180 for i < len(lines) && strings.Contains(lines[i], "|") && strings.TrimSpace(lines[i]) != "" {
181 i++
182 }
183 continue
184 }
185 if strings.HasPrefix(trim, "#") {
186 h := 0
187 for h < len(trim) && trim[h] == '#' && h < 6 {
188 h++
189 }
190 if h > 0 && (h == len(trim) || trim[h] == ' ') {
191 i++
192 continue
193 }
194 }
195 if isList(trim) {
196 for i < len(lines) && isList(strings.TrimSpace(lines[i])) {
197 if checked, ok := taskMarker(lines[i]); ok {
198 out[i] = taskHit{index: n, checked: checked}
199 n++
200 }
201 i++
202 }
203 continue
204 }
205 for i < len(lines) && strings.TrimSpace(lines[i]) != "" && !strings.HasPrefix(strings.TrimSpace(lines[i]), "```") && !strings.HasPrefix(strings.TrimSpace(lines[i]), "#") && !isList(strings.TrimSpace(lines[i])) && !isTableStart(lines, i) {
206 i++
207 }
208 }
209 return out
210}
211
212func taskMarker(line string) (checked bool, ok bool) {
213 trim := strings.TrimSpace(line)
214 switch {
215 case strings.HasPrefix(trim, "- "):
216 trim = trim[2:]
217 case strings.HasPrefix(trim, "* "):
218 trim = trim[2:]
219 default:
220 return false, false
221 }
222 if strings.HasPrefix(trim, "[ ]") && markerEnd(trim) {
223 return false, true
224 }
225 if (strings.HasPrefix(trim, "[x]") || strings.HasPrefix(trim, "[X]")) && markerEnd(trim) {
226 return true, true
227 }
228 return false, false
229}
230
231func markerEnd(trim string) bool {
232 return len(trim) == 3 || (len(trim) > 3 && trim[3] == ' ')
233}
234
235func rewriteTask(line string, checked bool) string {
236 repl := "[ ]"
237 if checked {
238 repl = "[x]"
239 }
240 for _, marker := range []string{"[ ]", "[x]", "[X]"} {
241 if i := strings.Index(line, marker); i >= 0 {
242 return line[:i] + repl + line[i+3:]
243 }
244 }
245 return line
246}
247
248func taskCountFmt(s string) string {
249 if strings.Count(s, "%d") >= 2 {
250 return s
251 }
252 return "%d of %d tasks completed"
253}
254
255func taskBox(checked bool, index int, tasks Tasks) string {
256 if tasks.CanToggle && tasks.Post != "" {
257 val := "1"
258 pressed := "false"
259 class := "taskbox"
260 mark := ""
261 if checked {
262 val = "0"
263 pressed = "true"
264 class = "taskbox on"
265 mark = "&#10003;"
266 }
267 label := tasks.Toggle
268 if label == "" {
269 label = "Toggle task"
270 }
271 var b strings.Builder
272 b.WriteString(`<form class="taskform" method="post" action="`)
273 b.WriteString(html.EscapeString(tasks.Post))
274 b.WriteString(`">`)
275 writeHidden(&b, "csrf", tasks.CSRF)
276 writeHidden(&b, "kind", tasks.Kind)
277 writeHidden(&b, "id", tasks.ID)
278 writeHidden(&b, "index", strconv.Itoa(index))
279 writeHidden(&b, "checked", val)
280 b.WriteString(`<button type="submit" class="`)
281 b.WriteString(class)
282 b.WriteString(`" aria-pressed="`)
283 b.WriteString(pressed)
284 b.WriteString(`" aria-label="`)
285 b.WriteString(html.EscapeString(label))
286 b.WriteString(`">`)
287 b.WriteString(mark)
288 b.WriteString(`</button></form>`)
289 return b.String()
290 }
291 if checked {
292 return `<input class="tasktick" type="checkbox" disabled checked> `
293 }
294 return `<input class="tasktick" type="checkbox" disabled> `
295}
296
297func writeHidden(b *strings.Builder, name, value string) {
298 b.WriteString(`<input type="hidden" name="`)
299 b.WriteString(html.EscapeString(name))
300 b.WriteString(`" value="`)
301 b.WriteString(html.EscapeString(value))
302 b.WriteString(`">`)
303}
304
305func isTableStart(lines []string, i int) bool {
306 if i+1 >= len(lines) || !strings.Contains(lines[i], "|") {
307 return false
308 }
309 return isRule(lines[i+1])
310}
311
312func isRule(line string) bool {
313 cells := splitRow(line)
314 if len(cells) == 0 {
315 return false
316 }
317 for _, c := range cells {
318 c = strings.TrimSpace(c)
319 if c == "" {
320 return false
321 }
322 for _, r := range c {
323 if r != '-' && r != ':' && r != ' ' {
324 return false
325 }
326 }
327 if !strings.Contains(c, "-") {
328 return false
329 }
330 }
331 return true
332}
333
334func splitRow(line string) []string {
335 line = strings.TrimSpace(line)
336 line = strings.Trim(line, "|")
337 if strings.TrimSpace(line) == "" {
338 return nil
339 }
340 parts := strings.Split(line, "|")
341 for i := range parts {
342 parts[i] = strings.TrimSpace(parts[i])
343 }
344 return parts
345}
346
347func table(lines []string, i *int, linkBase, rev, repoPath string) string {
348 head := splitRow(lines[*i])
349 *i += 2
350 var rows [][]string
351 for *i < len(lines) && strings.Contains(lines[*i], "|") && strings.TrimSpace(lines[*i]) != "" {
352 rows = append(rows, splitRow(lines[*i]))
353 *i++
354 }
355 var b strings.Builder
356 b.WriteString("<table class=\"md\">\n<thead><tr>")
357 for _, c := range head {
358 b.WriteString("<th>")
359 b.WriteString(inline(c, linkBase, rev, repoPath))
360 b.WriteString("</th>")
361 }
362 b.WriteString("</tr></thead>\n<tbody>\n")
363 for _, row := range rows {
364 b.WriteString("<tr>")
365 for _, c := range row {
366 b.WriteString("<td>")
367 b.WriteString(inline(c, linkBase, rev, repoPath))
368 b.WriteString("</td>")
369 }
370 b.WriteString("</tr>\n")
371 }
372 b.WriteString("</tbody></table>\n")
373 return b.String()
374}
375
376func inline(s, linkBase, rev, repoPath string) string {
377 var b strings.Builder
378 anchors := 0
379 for i := 0; i < len(s); {
380 if s[i] == '`' {
381 if j := strings.IndexByte(s[i+1:], '`'); j >= 0 {
382 b.WriteString("<code>")
383 b.WriteString(html.EscapeString(s[i+1 : i+1+j]))
384 b.WriteString("</code>")
385 i += j + 2
386 continue
387 }
388 }
389 if strings.HasPrefix(s[i:], "**") {
390 if j := strings.Index(s[i+2:], "**"); j >= 0 {
391 b.WriteString("<strong>")
392 b.WriteString(inline(s[i+2:i+2+j], linkBase, rev, repoPath))
393 b.WriteString("</strong>")
394 i += j + 4
395 continue
396 }
397 }
398 if s[i] == '*' {
399 if j := strings.IndexByte(s[i+1:], '*'); j > 0 {
400 b.WriteString("<em>")
401 b.WriteString(inline(s[i+1:i+1+j], linkBase, rev, repoPath))
402 b.WriteString("</em>")
403 i += j + 2
404 continue
405 }
406 }
407 if s[i] == '!' && i+1 < len(s) && s[i+1] == '[' {
408 if text, dest, n, ok := bracketLink(s, i+1); ok {
409 src, title := splitTitle(dest)
410 b.WriteString(imageTag(src, plainText(text), title, "", "", linkBase, rev, repoPath))
411 i += n + 1
412 continue
413 }
414 }
415 if s[i] == '[' {
416 if text, dest, n, ok := bracketLink(s, i); ok {
417 href, _ := splitTitle(dest)
418 b.WriteString(`<a href="`)
419 b.WriteString(html.EscapeString(resolveLink(href, linkBase, rev)))
420 b.WriteString(`">`)
421 b.WriteString(inline(text, linkBase, rev, repoPath))
422 b.WriteString("</a>")
423 i += n
424 continue
425 }
426 }
427 if s[i] == '<' {
428 if out, n, ok := htmlTag(s[i:], linkBase, rev, repoPath, &anchors); ok {
429 b.WriteString(out)
430 i += n
431 continue
432 }
433 }
434 if s[i] == 'h' && (i == 0 || !isIdent(s[i-1]) && s[i-1] != '/' && s[i-1] != '"' && s[i-1] != '\'') {
435 if out, n, ok := bareImage(s[i:], linkBase, rev, repoPath); ok {
436 b.WriteString(out)
437 i += n
438 continue
439 }
440 }
441 if href, label, n, ok := refLink(s, i, repoPath); ok {
442 b.WriteString(`<a href="`)
443 b.WriteString(html.EscapeString(href))
444 b.WriteString(`">`)
445 b.WriteString(html.EscapeString(label))
446 b.WriteString("</a>")
447 i += n
448 continue
449 }
450 b.WriteString(html.EscapeString(s[i : i+1]))
451 i++
452 }
453 for ; anchors > 0; anchors-- {
454 b.WriteString("</a>")
455 }
456 return b.String()
457}
458
459func refLink(s string, i int, repoPath string) (href, label string, n int, ok bool) {
460 if repoPath == "" || i >= len(s) {
461 return "", "", 0, false
462 }
463 if s[i] != '#' && s[i] != '!' {
464 return "", "", 0, false
465 }
466 if i > 0 && isIdent(s[i-1]) {
467 return "", "", 0, false
468 }
469 j := i + 1
470 if j >= len(s) || s[j] < '0' || s[j] > '9' {
471 return "", "", 0, false
472 }
473 for j < len(s) && s[j] >= '0' && s[j] <= '9' {
474 j++
475 }
476 if j < len(s) && isIdent(s[j]) {
477 return "", "", 0, false
478 }
479 kind := "issues"
480 if s[i] == '!' {
481 kind = "merge-requests"
482 }
483 base := strings.Trim(repoPath, "/")
484 return "/" + base + "/-/" + kind + "/" + s[i+1:j], s[i:j], j - i, true
485}
486
487func isIdent(c byte) bool {
488 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_'
489}
490
491func resolveLink(href, linkBase, rev string) string {
492 href = strings.TrimSpace(href)
493 lower := strings.ToLower(href)
494 if strings.HasPrefix(lower, "https://") || strings.HasPrefix(lower, "http://") || strings.HasPrefix(lower, "mailto:") {
495 return href
496 }
497 if strings.HasPrefix(href, "#") || strings.HasPrefix(href, "//") {
498 return href
499 }
500 if hasScheme(lower) {
501 // javascript:, data:, vbscript: en andere schema's worden geen link.
502 return "#"
503 }
504 if root, dir, ok := splitBlobBase(linkBase); ok {
505 p, frag := cleanRepoPathFrag(dir, href)
506 out := root + p
507 if rev != "" {
508 out += "?rev=" + url.QueryEscape(rev)
509 }
510 return out + frag
511 }
512 href = strings.TrimPrefix(href, "./")
513 out := linkBase + href
514 if rev != "" {
515 out += "?rev=" + url.QueryEscape(rev)
516 }
517 return out
518}