123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189 |
- // 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
- }
-
- func (r *Writer) resolveLink(kind, link string) string {
- link = strings.TrimPrefix(link, "file:")
- if !strings.HasPrefix(link, "#") && // not a URL fragment
- !markup.IsFullURLString(link) {
- 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()
- }
-
- base := r.Ctx.Links.Base
- if r.Ctx.IsWiki {
- base = r.Ctx.Links.WikiLink()
- } else if r.Ctx.Links.HasBranchInfo() {
- base = r.Ctx.Links.SrcLink()
- }
-
- if kind == "image" || kind == "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.Kind(), l.URL)
-
- // 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.Kind(), org.String(l.Description...))
- _, _ = 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.Kind(), org.String(l.Description...))
- _, _ = 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)
- }
- }
|