mirror of
https://gitea.com/gitea/tea.git
synced 2026-10-26 11:01:25 +01:00
115 lines
3.4 KiB
Go
115 lines
3.4 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package terminal
|
|
|
|
import (
|
|
"html"
|
|
"regexp"
|
|
"strings"
|
|
"sync"
|
|
"unicode/utf8"
|
|
|
|
"charm.land/glamour/v2"
|
|
"charm.land/glamour/v2/styles"
|
|
)
|
|
|
|
// MarkdownEnabled resolves the markdown preference: raw never renders, and auto renders on TTY stdout.
|
|
func MarkdownEnabled(preference string, outTTY bool) bool {
|
|
return outTTY && preference != "raw"
|
|
}
|
|
|
|
// glamourLinks matches the OSC 8 hyperlinks that glamour writes for markdown links.
|
|
var glamourLinks = regexp.MustCompile("\x1b\\]8;[^\x07\x1b]*(?:\x07|\x1b\\\\)")
|
|
|
|
// glamourSequences matches the escape sequences glamour writes itself: colors and OSC 8 hyperlinks.
|
|
var glamourSequences = regexp.MustCompile("\x1b\\[[0-9;]*m|\x1b\\]8;[^\x07\x1b]*(?:\x07|\x1b\\\\)")
|
|
|
|
// stripControls removes every control character from rendered output except newlines and the
|
|
// sequences glamour writes, which markdown cannot smuggle in after the input was sanitized.
|
|
func stripControls(text string) string {
|
|
var b strings.Builder
|
|
for i := 0; i < len(text); {
|
|
if loc := glamourSequences.FindStringIndex(text[i:]); loc != nil && loc[0] == 0 {
|
|
b.WriteString(text[i : i+loc[1]])
|
|
i += loc[1]
|
|
continue
|
|
}
|
|
r, size := utf8.DecodeRuneInString(text[i:])
|
|
if r == '\n' || r == '\t' || !(r < 0x20 || r == 0x7f || (r >= 0x80 && r < 0xa0)) {
|
|
b.WriteString(text[i : i+size])
|
|
}
|
|
i += size
|
|
}
|
|
return b.String()
|
|
}
|
|
|
|
// renderers caches a glamour renderer per width and color, as building one parses its style each
|
|
// time; the lock also serializes rendering.
|
|
var renderers = struct {
|
|
sync.Mutex
|
|
byKey map[[2]int]*glamour.TermRenderer
|
|
}{byKey: map[[2]int]*glamour.TermRenderer{}}
|
|
|
|
func markdownRenderer(width int, color bool) (*glamour.TermRenderer, error) {
|
|
key := [2]int{width, 0}
|
|
if color {
|
|
key[1] = 1
|
|
}
|
|
if renderer := renderers.byKey[key]; renderer != nil {
|
|
return renderer, nil
|
|
}
|
|
style := styles.NoTTYStyleConfig
|
|
if color {
|
|
style = styles.DarkStyleConfig
|
|
// The terminal's own text color keeps body text readable on light backgrounds too.
|
|
style.Document.Color = nil
|
|
}
|
|
renderer, err := glamour.NewTermRenderer(glamour.WithStyles(style), glamour.WithWordWrap(width), glamour.WithPreservedNewLines())
|
|
if err == nil {
|
|
renderers.byKey[key] = renderer
|
|
}
|
|
return renderer, err
|
|
}
|
|
|
|
// Markdown renders sanitized markdown for d: wrapped to its width (80 when unknown), colored or plain,
|
|
// with links only when d allows them. It keeps line breaks like Gitea does, and returns the sanitized
|
|
// text unrendered if rendering fails.
|
|
func Markdown(text string, d Display) string {
|
|
// Markdown decodes character references such as  into the characters they name, so decode
|
|
// them (to a fixed point, for &#27;) before sanitizing instead of after.
|
|
for range 4 {
|
|
decoded := html.UnescapeString(text)
|
|
if decoded == text {
|
|
break
|
|
}
|
|
text = decoded
|
|
}
|
|
text = SafeText(text)
|
|
width := d.Width
|
|
if width <= 0 {
|
|
width = 80
|
|
}
|
|
renderers.Lock()
|
|
renderer, err := markdownRenderer(width, d.Color)
|
|
if err != nil {
|
|
renderers.Unlock()
|
|
return text
|
|
}
|
|
rendered, err := renderer.Render(text)
|
|
renderers.Unlock()
|
|
if err != nil {
|
|
return text
|
|
}
|
|
rendered = stripControls(rendered)
|
|
if !d.Links {
|
|
rendered = glamourLinks.ReplaceAllString(rendered, "")
|
|
}
|
|
// glamour pads every line to the full width.
|
|
lines := strings.Split(rendered, "\n")
|
|
for i, line := range lines {
|
|
lines[i] = strings.TrimRight(line, " ")
|
|
}
|
|
return strings.Trim(strings.Join(lines, "\n"), "\n")
|
|
}
|