mirror of
https://github.com/go-gitea/gitea.git
synced 2024-09-07 11:59:30 +02:00
Fixes #26548 This PR refactors the rendering of markup links. The old code uses `strings.Replace` to change some urls while the new code uses more context to decide which link should be generated. The added tests should ensure the same output for the old and new behaviour (besides the bug). We may need to refactor the rendering a bit more to make it clear how the different helper methods render the input string. There are lots of options (resolve links / images / mentions / git hashes / emojis / ...) but you don't really know what helper uses which options. For example, we currently support images in the user description which should not be allowed I think: <details> <summary>Profile</summary> https://try.gitea.io/KN4CK3R ![grafik](https://github.com/go-gitea/gitea/assets/1666336/109ae422-496d-4200-b52e-b3a528f553e5) </details> --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
183 lines
4.7 KiB
Go
183 lines
4.7 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package markup
|
|
|
|
import (
|
|
"fmt"
|
|
"html"
|
|
"io"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/highlight"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/markup"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
"github.com/alecthomas/chroma/v2"
|
|
"github.com/alecthomas/chroma/v2/lexers"
|
|
"github.com/niklasfasching/go-org/org"
|
|
)
|
|
|
|
func init() {
|
|
markup.RegisterRenderer(Renderer{})
|
|
}
|
|
|
|
// Renderer implements markup.Renderer for orgmode
|
|
type Renderer struct{}
|
|
|
|
var _ markup.PostProcessRenderer = (*Renderer)(nil)
|
|
|
|
// Name implements markup.Renderer
|
|
func (Renderer) Name() string {
|
|
return "orgmode"
|
|
}
|
|
|
|
// NeedPostProcess implements markup.PostProcessRenderer
|
|
func (Renderer) NeedPostProcess() bool { return true }
|
|
|
|
// Extensions implements markup.Renderer
|
|
func (Renderer) Extensions() []string {
|
|
return []string{".org"}
|
|
}
|
|
|
|
// SanitizerRules implements markup.Renderer
|
|
func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule {
|
|
return []setting.MarkupSanitizerRule{}
|
|
}
|
|
|
|
// Render renders orgmode rawbytes to HTML
|
|
func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
|
|
htmlWriter := org.NewHTMLWriter()
|
|
htmlWriter.HighlightCodeBlock = func(source, lang string, inline bool, params map[string]string) string {
|
|
defer func() {
|
|
if err := recover(); err != nil {
|
|
log.Error("Panic in HighlightCodeBlock: %v\n%s", err, log.Stack(2))
|
|
panic(err)
|
|
}
|
|
}()
|
|
var w strings.Builder
|
|
if _, err := w.WriteString(`<pre>`); err != nil {
|
|
return ""
|
|
}
|
|
|
|
lexer := lexers.Get(lang)
|
|
if lexer == nil && lang == "" {
|
|
lexer = lexers.Analyse(source)
|
|
if lexer == nil {
|
|
lexer = lexers.Fallback
|
|
}
|
|
lang = strings.ToLower(lexer.Config().Name)
|
|
}
|
|
|
|
if lexer == nil {
|
|
// include language-x class as part of commonmark spec
|
|
if _, err := w.WriteString(`<code class="chroma language-` + lang + `">`); err != nil {
|
|
return ""
|
|
}
|
|
if _, err := w.WriteString(html.EscapeString(source)); err != nil {
|
|
return ""
|
|
}
|
|
} else {
|
|
// include language-x class as part of commonmark spec
|
|
if _, err := w.WriteString(`<code class="chroma language-` + lang + `">`); err != nil {
|
|
return ""
|
|
}
|
|
lexer = chroma.Coalesce(lexer)
|
|
|
|
if _, err := w.WriteString(string(highlight.CodeFromLexer(lexer, source))); err != nil {
|
|
return ""
|
|
}
|
|
}
|
|
|
|
if _, err := w.WriteString("</code></pre>"); err != nil {
|
|
return ""
|
|
}
|
|
|
|
return w.String()
|
|
}
|
|
|
|
w := &Writer{
|
|
HTMLWriter: htmlWriter,
|
|
Ctx: ctx,
|
|
}
|
|
|
|
htmlWriter.ExtendingWriter = w
|
|
|
|
res, err := org.New().Silent().Parse(input, "").Write(w)
|
|
if err != nil {
|
|
return fmt.Errorf("orgmode.Render failed: %w", err)
|
|
}
|
|
_, err = io.Copy(output, strings.NewReader(res))
|
|
return err
|
|
}
|
|
|
|
// RenderString renders orgmode string to HTML string
|
|
func RenderString(ctx *markup.RenderContext, content string) (string, error) {
|
|
var buf strings.Builder
|
|
if err := Render(ctx, strings.NewReader(content), &buf); err != nil {
|
|
return "", err
|
|
}
|
|
return buf.String(), nil
|
|
}
|
|
|
|
// Render renders orgmode string to HTML string
|
|
func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
|
|
return Render(ctx, input, output)
|
|
}
|
|
|
|
// Writer implements org.Writer
|
|
type Writer struct {
|
|
*org.HTMLWriter
|
|
Ctx *markup.RenderContext
|
|
}
|
|
|
|
const mailto = "mailto:"
|
|
|
|
func (r *Writer) resolveLink(l org.RegularLink) string {
|
|
link := html.EscapeString(l.URL)
|
|
if l.Protocol == "file" {
|
|
link = link[len("file:"):]
|
|
}
|
|
if len(link) > 0 && !markup.IsLinkStr(link) &&
|
|
link[0] != '#' && !strings.HasPrefix(link, mailto) {
|
|
base := r.Ctx.Links.Base
|
|
switch l.Kind() {
|
|
case "image", "video":
|
|
base = r.Ctx.Links.ResolveMediaLink(r.Ctx.IsWiki)
|
|
}
|
|
link = util.URLJoin(base, link)
|
|
}
|
|
return link
|
|
}
|
|
|
|
// WriteRegularLink renders images, links or videos
|
|
func (r *Writer) WriteRegularLink(l org.RegularLink) {
|
|
link := r.resolveLink(l)
|
|
|
|
// Inspired by https://github.com/niklasfasching/go-org/blob/6eb20dbda93cb88c3503f7508dc78cbbc639378f/org/html_writer.go#L406-L427
|
|
switch l.Kind() {
|
|
case "image":
|
|
if l.Description == nil {
|
|
fmt.Fprintf(r, `<img src="%s" alt="%s" />`, link, link)
|
|
} else {
|
|
imageSrc := r.resolveLink(l.Description[0].(org.RegularLink))
|
|
fmt.Fprintf(r, `<a href="%s"><img src="%s" alt="%s" /></a>`, link, imageSrc, imageSrc)
|
|
}
|
|
case "video":
|
|
if l.Description == nil {
|
|
fmt.Fprintf(r, `<video src="%s">%s</video>`, link, link)
|
|
} else {
|
|
videoSrc := r.resolveLink(l.Description[0].(org.RegularLink))
|
|
fmt.Fprintf(r, `<a href="%s"><video src="%s">%s</video></a>`, link, videoSrc, videoSrc)
|
|
}
|
|
default:
|
|
description := link
|
|
if l.Description != nil {
|
|
description = r.WriteNodesAsString(l.Description...)
|
|
}
|
|
fmt.Fprintf(r, `<a href="%s">%s</a>`, link, description)
|
|
}
|
|
}
|