diff --git a/models/renderhelper/repo_file_test.go b/models/renderhelper/repo_file_test.go
index 40027ec76f..959648b660 100644
--- a/models/renderhelper/repo_file_test.go
+++ b/models/renderhelper/repo_file_test.go
@@ -12,6 +12,8 @@ import (
"code.gitea.io/gitea/modules/markup"
"code.gitea.io/gitea/modules/markup/markdown"
+ _ "code.gitea.io/gitea/modules/markup/orgmode"
+
"github.com/stretchr/testify/assert"
)
@@ -81,3 +83,40 @@ func TestRepoFile(t *testing.T) {
`, rendered)
})
}
+
+func TestRepoFileOrgMode(t *testing.T) {
+ unittest.PrepareTestEnv(t)
+ repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
+
+ t.Run("Links", func(t *testing.T) {
+ rctx := NewRenderContextRepoFile(context.Background(), repo1, RepoFileOptions{
+ CurrentRefPath: "/commit/1234",
+ CurrentTreePath: "my-dir",
+ }).WithRelativePath("my-dir/a.org")
+
+ rendered, err := markup.RenderString(rctx, `
+[[https://google.com/]]
+[[ImageLink.svg][The Image Desc]]
+`)
+ assert.NoError(t, err)
+ assert.Equal(t, `
+https://google.com/
+The Image Desc
+`, rendered)
+ })
+
+ t.Run("CodeHighlight", func(t *testing.T) {
+ rctx := NewRenderContextRepoFile(context.Background(), repo1, RepoFileOptions{}).WithRelativePath("my-dir/a.org")
+
+ rendered, err := markup.RenderString(rctx, `
+#+begin_src c
+int a = 1;
+#+end_src
+`)
+ assert.NoError(t, err)
+ assert.Equal(t, `
+`, rendered)
+ })
+}
diff --git a/modules/markup/orgmode/orgmode.go b/modules/markup/orgmode/orgmode.go
index 31257351ae..c6cc334000 100644
--- a/modules/markup/orgmode/orgmode.go
+++ b/modules/markup/orgmode/orgmode.go
@@ -6,10 +6,12 @@ package markup
import (
"fmt"
"html"
+ "html/template"
"io"
"strings"
"code.gitea.io/gitea/modules/highlight"
+ "code.gitea.io/gitea/modules/htmlutil"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/markup"
"code.gitea.io/gitea/modules/setting"
@@ -20,33 +22,36 @@ import (
)
func init() {
- markup.RegisterRenderer(Renderer{})
+ markup.RegisterRenderer(renderer{})
}
// Renderer implements markup.Renderer for orgmode
-type Renderer struct{}
+type renderer struct{}
-var _ markup.PostProcessRenderer = (*Renderer)(nil)
+var (
+ _ markup.Renderer = (*renderer)(nil)
+ _ markup.PostProcessRenderer = (*renderer)(nil)
+)
// Name implements markup.Renderer
-func (Renderer) Name() string {
+func (renderer) Name() string {
return "orgmode"
}
// NeedPostProcess implements markup.PostProcessRenderer
-func (Renderer) NeedPostProcess() bool { return true }
+func (renderer) NeedPostProcess() bool { return true }
// Extensions implements markup.Renderer
-func (Renderer) Extensions() []string {
+func (renderer) Extensions() []string {
return []string{".org"}
}
// SanitizerRules implements markup.Renderer
-func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule {
+func (renderer) SanitizerRules() []setting.MarkupSanitizerRule {
return []setting.MarkupSanitizerRule{}
}
-// Render renders orgmode rawbytes to HTML
+// Render renders orgmode raw bytes 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 {
@@ -56,10 +61,7 @@ func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
panic(err)
}
}()
- var w strings.Builder
- if _, err := w.WriteString(``); err != nil {
- return ""
- }
+ w := &strings.Builder{}
lexer := lexers.Get(lang)
if lexer == nil && lang == "" {
@@ -70,26 +72,20 @@ func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
lang = strings.ToLower(lexer.Config().Name)
}
+ // include language-x class as part of commonmark spec
+ if err := ctx.RenderInternal.FormatWithSafeAttrs(w, ``, lang); err != nil {
+ return ""
+ }
if lexer == nil {
- // include language-x class as part of commonmark spec
- if _, err := w.WriteString(``); 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(``); err != nil {
- return ""
- }
lexer = chroma.Coalesce(lexer)
-
if _, err := w.WriteString(string(highlight.CodeFromLexer(lexer, source))); err != nil {
return ""
}
}
-
if _, err := w.WriteString("
"); err != nil {
return ""
}
@@ -97,11 +93,7 @@ func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
return w.String()
}
- w := &Writer{
- HTMLWriter: htmlWriter,
- Ctx: ctx,
- }
-
+ w := &orgWriter{rctx: ctx, HTMLWriter: htmlWriter}
htmlWriter.ExtendingWriter = w
res, err := org.New().Silent().Parse(input, "").Write(w)
@@ -122,17 +114,18 @@ func RenderString(ctx *markup.RenderContext, content string) (string, error) {
}
// Render renders orgmode string to HTML string
-func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
+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 {
+type orgWriter struct {
*org.HTMLWriter
- Ctx *markup.RenderContext
+ rctx *markup.RenderContext
}
-func (r *Writer) resolveLink(kind, link string) string {
+var _ org.Writer = (*orgWriter)(nil)
+
+func (r *orgWriter) resolveLink(kind, link string) string {
link = strings.TrimPrefix(link, "file:")
if !strings.HasPrefix(link, "#") && // not a URL fragment
!markup.IsFullURLString(link) {
@@ -142,39 +135,42 @@ func (r *Writer) resolveLink(kind, link string) string {
kind = org.RegularLink{URL: link}.Kind()
}
if kind == "image" || kind == "video" {
- link = r.Ctx.RenderHelper.ResolveLink(link, markup.LinkTypeMedia)
+ link = r.rctx.RenderHelper.ResolveLink(link, markup.LinkTypeMedia)
} else {
- link = r.Ctx.RenderHelper.ResolveLink(link, markup.LinkTypeDefault)
+ link = r.rctx.RenderHelper.ResolveLink(link, markup.LinkTypeDefault)
}
}
return link
}
// WriteRegularLink renders images, links or videos
-func (r *Writer) WriteRegularLink(l org.RegularLink) {
+func (r *orgWriter) WriteRegularLink(l org.RegularLink) {
link := r.resolveLink(l.Kind(), l.URL)
+ printHTML := func(html string, a ...any) {
+ _, _ = fmt.Fprint(r, htmlutil.HTMLFormat(html, a...))
+ }
// 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, `
`, link, link)
+ printHTML(``, link, link)
} else {
imageSrc := r.resolveLink(l.Kind(), org.String(l.Description...))
- _, _ = fmt.Fprintf(r, ``, link, imageSrc, imageSrc)
+ printHTML(``, link, imageSrc, imageSrc)
}
case "video":
if l.Description == nil {
- _, _ = fmt.Fprintf(r, ``, link, link)
+ printHTML(``, link, link)
} else {
videoSrc := r.resolveLink(l.Kind(), org.String(l.Description...))
- _, _ = fmt.Fprintf(r, ``, link, videoSrc, videoSrc)
+ printHTML(``, link, videoSrc, videoSrc)
}
default:
- description := link
+ var description any = link
if l.Description != nil {
- description = r.WriteNodesAsString(l.Description...)
+ description = template.HTML(r.WriteNodesAsString(l.Description...)) // orgmode HTMLWriter outputs HTML content
}
- _, _ = fmt.Fprintf(r, `%s`, link, description)
+ printHTML(`%s`, link, description)
}
}
diff --git a/modules/markup/orgmode/orgmode_test.go b/modules/markup/orgmode/orgmode_test.go
index d30df3b188..e3cc05b4f0 100644
--- a/modules/markup/orgmode/orgmode_test.go
+++ b/modules/markup/orgmode/orgmode_test.go
@@ -58,15 +58,15 @@ func TestRender_Media(t *testing.T) {
}
test("[[file:../../.images/src/02/train.jpg]]",
- `
`)
+ `
`)
test("[[file:train.jpg]]",
- `
`)
+ `
`)
// With description.
test("[[https://example.com][https://example.com/example.svg]]",
- `
`)
+ `
`)
test("[[https://example.com][pre https://example.com/example.svg post]]",
- `pre post
`)
+ `pre post
`)
test("[[https://example.com][https://example.com/example.mp4]]",
`
`)
test("[[https://example.com][pre https://example.com/example.mp4 post]]",
@@ -74,19 +74,19 @@ func TestRender_Media(t *testing.T) {
// Without description.
test("[[https://example.com/example.svg]]",
- `
`)
+ `
`)
test("[[https://example.com/example.mp4]]",
``)
// test [[LINK][DESCRIPTION]] syntax with "file:" prefix
test(`[[https://example.com/][file:https://example.com/foo%20bar.svg]]`,
- `
`)
+ `
`)
test(`[[file:https://example.com/foo%20bar.svg][Goto Image]]`,
`Goto Image
`)
test(`[[file:https://example.com/link][https://example.com/image.jpg]]`,
- `
`)
+ `
`)
test(`[[file:https://example.com/link][file:https://example.com/image.jpg]]`,
- `
`)
+ `
`)
}
func TestRender_Source(t *testing.T) {
