2017-09-21 13:20:14 +08:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-28 02:20:29 +08:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-09-21 13:20:14 +08:00
|
|
|
|
|
|
|
package markup
|
|
|
|
|
|
|
|
import (
|
2019-10-31 09:06:25 +08:00
|
|
|
"fmt"
|
|
|
|
"html"
|
2021-04-20 06:25:08 +08:00
|
|
|
"io"
|
2020-10-01 23:22:34 +08:00
|
|
|
"strings"
|
2019-10-31 09:06:25 +08:00
|
|
|
|
2021-06-24 04:45:47 +08:00
|
|
|
"code.gitea.io/gitea/modules/highlight"
|
2021-09-24 21:29:32 +08:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
2017-09-21 13:20:14 +08:00
|
|
|
"code.gitea.io/gitea/modules/markup"
|
2021-06-24 05:09:51 +08:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2019-10-31 09:06:25 +08:00
|
|
|
"code.gitea.io/gitea/modules/util"
|
2017-09-21 13:20:14 +08:00
|
|
|
|
2022-09-26 13:50:03 +08:00
|
|
|
"github.com/alecthomas/chroma/v2"
|
|
|
|
"github.com/alecthomas/chroma/v2/lexers"
|
2019-10-31 09:06:25 +08:00
|
|
|
"github.com/niklasfasching/go-org/org"
|
2017-09-21 13:20:14 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
func init() {
|
2021-04-20 06:25:08 +08:00
|
|
|
markup.RegisterRenderer(Renderer{})
|
2017-09-21 13:20:14 +08:00
|
|
|
}
|
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
// Renderer implements markup.Renderer for orgmode
|
2022-01-21 01:46:10 +08:00
|
|
|
type Renderer struct{}
|
2017-09-21 13:20:14 +08:00
|
|
|
|
2022-06-16 11:33:23 +08:00
|
|
|
var _ markup.PostProcessRenderer = (*Renderer)(nil)
|
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
// Name implements markup.Renderer
|
|
|
|
func (Renderer) Name() string {
|
2017-09-21 13:20:14 +08:00
|
|
|
return "orgmode"
|
|
|
|
}
|
|
|
|
|
2022-06-16 11:33:23 +08:00
|
|
|
// NeedPostProcess implements markup.PostProcessRenderer
|
2021-04-20 06:25:08 +08:00
|
|
|
func (Renderer) NeedPostProcess() bool { return true }
|
2021-04-13 15:06:31 +08:00
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
// Extensions implements markup.Renderer
|
|
|
|
func (Renderer) Extensions() []string {
|
2017-09-21 13:20:14 +08:00
|
|
|
return []string{".org"}
|
|
|
|
}
|
|
|
|
|
2021-06-24 05:09:51 +08:00
|
|
|
// SanitizerRules implements markup.Renderer
|
|
|
|
func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule {
|
|
|
|
return []setting.MarkupSanitizerRule{}
|
|
|
|
}
|
|
|
|
|
2017-09-21 13:20:14 +08:00
|
|
|
// Render renders orgmode rawbytes to HTML
|
2021-04-20 06:25:08 +08:00
|
|
|
func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
|
2019-10-31 09:06:25 +08:00
|
|
|
htmlWriter := org.NewHTMLWriter()
|
2023-07-14 11:00:31 +08:00
|
|
|
htmlWriter.HighlightCodeBlock = func(source, lang string, inline bool, params map[string]string) string {
|
2021-09-24 21:29:32 +08:00
|
|
|
defer func() {
|
|
|
|
if err := recover(); err != nil {
|
|
|
|
log.Error("Panic in HighlightCodeBlock: %v\n%s", err, log.Stack(2))
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
}()
|
2021-06-24 04:45:47 +08:00
|
|
|
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
|
2022-06-20 18:02:49 +08:00
|
|
|
if _, err := w.WriteString(`<code class="chroma language-` + lang + `">`); err != nil {
|
2021-06-24 04:45:47 +08:00
|
|
|
return ""
|
|
|
|
}
|
|
|
|
if _, err := w.WriteString(html.EscapeString(source)); err != nil {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
// include language-x class as part of commonmark spec
|
2022-06-20 18:02:49 +08:00
|
|
|
if _, err := w.WriteString(`<code class="chroma language-` + lang + `">`); err != nil {
|
2021-06-24 04:45:47 +08:00
|
|
|
return ""
|
|
|
|
}
|
|
|
|
lexer = chroma.Coalesce(lexer)
|
|
|
|
|
2023-12-17 22:38:54 +08:00
|
|
|
if _, err := w.WriteString(string(highlight.CodeFromLexer(lexer, source))); err != nil {
|
2021-06-24 04:45:47 +08:00
|
|
|
return ""
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if _, err := w.WriteString("</code></pre>"); err != nil {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
return w.String()
|
|
|
|
}
|
2019-10-31 09:06:25 +08:00
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
w := &Writer{
|
2019-10-31 09:06:25 +08:00
|
|
|
HTMLWriter: htmlWriter,
|
2024-01-15 16:49:24 +08:00
|
|
|
Ctx: ctx,
|
2019-10-31 09:06:25 +08:00
|
|
|
}
|
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
htmlWriter.ExtendingWriter = w
|
2019-10-31 09:06:25 +08:00
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
res, err := org.New().Silent().Parse(input, "").Write(w)
|
2019-10-31 09:06:25 +08:00
|
|
|
if err != nil {
|
2022-10-25 03:29:17 +08:00
|
|
|
return fmt.Errorf("orgmode.Render failed: %w", err)
|
2017-09-21 13:20:14 +08:00
|
|
|
}
|
2021-04-20 06:25:08 +08:00
|
|
|
_, err = io.Copy(output, strings.NewReader(res))
|
|
|
|
return err
|
2017-09-21 13:20:14 +08:00
|
|
|
}
|
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
// 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
|
2017-09-21 13:20:14 +08:00
|
|
|
}
|
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
// 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)
|
2017-09-21 13:20:14 +08:00
|
|
|
}
|
2019-10-31 09:06:25 +08:00
|
|
|
|
2021-04-20 06:25:08 +08:00
|
|
|
// Writer implements org.Writer
|
|
|
|
type Writer struct {
|
2019-10-31 09:06:25 +08:00
|
|
|
*org.HTMLWriter
|
2024-01-15 16:49:24 +08:00
|
|
|
Ctx *markup.RenderContext
|
2019-10-31 09:06:25 +08:00
|
|
|
}
|
|
|
|
|
2024-02-07 16:32:31 +08:00
|
|
|
func (r *Writer) resolveLink(kind, link string) string {
|
|
|
|
link = strings.TrimPrefix(link, "file:")
|
|
|
|
if !strings.HasPrefix(link, "#") && // not a URL fragment
|
|
|
|
!markup.IsLinkStr(link) && // not an absolute URL
|
|
|
|
!strings.HasPrefix(link, "mailto:") {
|
|
|
|
if kind == "regular" {
|
|
|
|
// orgmode reports the link kind as "regular" for "[[ImageLink.svg][The Image Desc]]"
|
|
|
|
// so we need to try to guess the link kind again here
|
|
|
|
kind = org.RegularLink{URL: link}.Kind()
|
|
|
|
}
|
2024-01-15 16:49:24 +08:00
|
|
|
base := r.Ctx.Links.Base
|
2024-02-07 16:32:31 +08:00
|
|
|
if kind == "image" || kind == "video" {
|
2024-01-15 16:49:24 +08:00
|
|
|
base = r.Ctx.Links.ResolveMediaLink(r.Ctx.IsWiki)
|
2019-10-31 09:06:25 +08:00
|
|
|
}
|
2024-01-15 16:49:24 +08:00
|
|
|
link = util.URLJoin(base, link)
|
2019-10-31 09:06:25 +08:00
|
|
|
}
|
2024-01-15 16:49:24 +08:00
|
|
|
return link
|
|
|
|
}
|
|
|
|
|
|
|
|
// WriteRegularLink renders images, links or videos
|
|
|
|
func (r *Writer) WriteRegularLink(l org.RegularLink) {
|
2024-02-07 16:32:31 +08:00
|
|
|
link := r.resolveLink(l.Kind(), l.URL)
|
2019-10-31 09:06:25 +08:00
|
|
|
|
2023-09-13 13:44:59 +08:00
|
|
|
// Inspired by https://github.com/niklasfasching/go-org/blob/6eb20dbda93cb88c3503f7508dc78cbbc639378f/org/html_writer.go#L406-L427
|
2019-10-31 09:06:25 +08:00
|
|
|
switch l.Kind() {
|
|
|
|
case "image":
|
2023-09-13 13:44:59 +08:00
|
|
|
if l.Description == nil {
|
2024-02-07 16:32:31 +08:00
|
|
|
_, _ = fmt.Fprintf(r, `<img src="%s" alt="%s" />`, link, link)
|
2023-09-13 13:44:59 +08:00
|
|
|
} else {
|
2024-02-07 16:32:31 +08:00
|
|
|
imageSrc := r.resolveLink(l.Kind(), org.String(l.Description...))
|
|
|
|
_, _ = fmt.Fprintf(r, `<a href="%s"><img src="%s" alt="%s" /></a>`, link, imageSrc, imageSrc)
|
2023-09-13 13:44:59 +08:00
|
|
|
}
|
2019-10-31 09:06:25 +08:00
|
|
|
case "video":
|
2023-09-13 13:44:59 +08:00
|
|
|
if l.Description == nil {
|
2024-02-07 16:32:31 +08:00
|
|
|
_, _ = fmt.Fprintf(r, `<video src="%s">%s</video>`, link, link)
|
2023-09-13 13:44:59 +08:00
|
|
|
} else {
|
2024-02-07 16:32:31 +08:00
|
|
|
videoSrc := r.resolveLink(l.Kind(), org.String(l.Description...))
|
|
|
|
_, _ = fmt.Fprintf(r, `<a href="%s"><video src="%s">%s</video></a>`, link, videoSrc, videoSrc)
|
2023-09-13 13:44:59 +08:00
|
|
|
}
|
2019-10-31 09:06:25 +08:00
|
|
|
default:
|
2024-01-15 16:49:24 +08:00
|
|
|
description := link
|
2023-09-13 13:44:59 +08:00
|
|
|
if l.Description != nil {
|
|
|
|
description = r.WriteNodesAsString(l.Description...)
|
|
|
|
}
|
2024-02-07 16:32:31 +08:00
|
|
|
_, _ = fmt.Fprintf(r, `<a href="%s">%s</a>`, link, description)
|
2019-10-31 09:06:25 +08:00
|
|
|
}
|
|
|
|
}
|