gitea/modules/markup/console/console.go

// Copyright 2022 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package console

import (
	"bytes"
	"io"
	"unicode/utf8"

	"code.gitea.io/gitea/modules/markup"
	"code.gitea.io/gitea/modules/setting"
	"code.gitea.io/gitea/modules/typesniffer"
	"code.gitea.io/gitea/modules/util"

	trend "github.com/buildkite/terminal-to-html/v3"
)

func init() {
	markup.RegisterRenderer(Renderer{})
}

// Renderer implements markup.Renderer
type Renderer struct{}

var _ markup.RendererContentDetector = (*Renderer)(nil)

// Name implements markup.Renderer
func (Renderer) Name() string {
	return "console"
}

// Extensions implements markup.Renderer
func (Renderer) Extensions() []string {
	return []string{".sh-session"}
}

// SanitizerRules implements markup.Renderer
func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule {
	return []setting.MarkupSanitizerRule{
		{Element: "span", AllowAttr: "class", Regexp: `^term-((fg[ix]?|bg)\d+|container)$`},
	}
}

// CanRender implements markup.RendererContentDetector
func (Renderer) CanRender(filename string, sniffedType typesniffer.SniffedType, prefetchBuf []byte) bool {
	if !sniffedType.IsTextPlain() {
		return false
	}

	s := util.UnsafeBytesToString(prefetchBuf)
	rs := []rune(s)
	cnt := 0
	firstErrPos := -1
	isCtrlSep := func(p int) bool {
		return p < len(rs) && (rs[p] == ';' || rs[p] == 'm')
	}
	for i, c := range rs {
		if c == 0 {
			return false
		}
		if c == '\x1b' {
			match := i+1 < len(rs) && rs[i+1] == '['
			if match && (isCtrlSep(i+2) || isCtrlSep(i+3) || isCtrlSep(i+4) || isCtrlSep(i+5)) {
				cnt++
			}
		}
		if c == utf8.RuneError && firstErrPos == -1 {
			firstErrPos = i
		}
	}
	if firstErrPos != -1 && firstErrPos != len(rs)-1 {
		return false
	}
	return cnt >= 2 // only render it as console output if there are at least two escape sequences
}

// Render renders terminal colors to HTML with all specific handling stuff.
func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
	buf, err := io.ReadAll(input)
	if err != nil {
		return err
	}
	buf = []byte(trend.Render(buf))
	buf = bytes.ReplaceAll(buf, []byte("\n"), []byte(`<br>`))
	_, err = output.Write(buf)
	return err
}