`
defer test.MockVariableValue(&markup.RenderBehaviorForTesting.ForceHardLineBreak, true)()
- res, err := markdown.RenderRawString(&markup.RenderContext{Ctx: git.DefaultContext}, testcase)
+ res, err := markdown.RenderRawString(markup.NewTestRenderContext(), testcase)
assert.NoError(t, err)
assert.Equal(t, expected, res)
}
@@ -441,7 +408,7 @@ func TestRenderEmojiInLinks_Issue12331(t *testing.T) {
testcase := `[Link with emoji :moon: in text](https://gitea.io)`
expected := `Link with emoji 🌔 in text
`
- res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, testcase)
+ res, err := markdown.RenderString(markup.NewTestRenderContext(), testcase)
assert.NoError(t, err)
assert.Equal(t, template.HTML(expected), res)
}
@@ -479,7 +446,7 @@ func TestColorPreview(t *testing.T) {
}
for _, test := range positiveTests {
- res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, test.testcase)
+ res, err := markdown.RenderString(markup.NewTestRenderContext(), test.testcase)
assert.NoError(t, err, "Unexpected error in testcase: %q", test.testcase)
assert.Equal(t, template.HTML(test.expected), res, "Unexpected result in testcase %q", test.testcase)
}
@@ -498,7 +465,7 @@ func TestColorPreview(t *testing.T) {
}
for _, test := range negativeTests {
- res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, test)
+ res, err := markdown.RenderString(markup.NewTestRenderContext(), test)
assert.NoError(t, err, "Unexpected error in testcase: %q", test)
assert.NotContains(t, res, `
defer test.MockVariableValue(&markup.RenderBehaviorForTesting.ForceHardLineBreak, true)()
defer test.MockVariableValue(&markup.RenderBehaviorForTesting.DisableInternalAttributes, true)()
for i, c := range cases {
- result, err := markdown.RenderString(&markup.RenderContext{
- Ctx: context.Background(),
- Links: c.Links,
- Metas: util.Iif(c.IsWiki, map[string]string{"markupContentMode": "wiki"}, map[string]string{}),
- }, input)
+ result, err := markdown.RenderString(markup.NewTestRenderContext(c.Links, util.Iif(c.IsWiki, map[string]string{"markupContentMode": "wiki"}, map[string]string{})), input)
assert.NoError(t, err, "Unexpected error in testcase: %v", i)
assert.Equal(t, c.Expected, string(result), "Unexpected result in testcase %v", i)
}
@@ -1029,7 +992,7 @@ func TestAttention(t *testing.T) {
}
test := func(input, expected string) {
- result, err := markdown.RenderString(&markup.RenderContext{Ctx: context.Background()}, input)
+ result, err := markdown.RenderString(markup.NewTestRenderContext(), input)
assert.NoError(t, err)
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(result)))
}
@@ -1062,6 +1025,6 @@ func BenchmarkSpecializedMarkdown(b *testing.B) {
func BenchmarkMarkdownRender(b *testing.B) {
// 23202 50840 ns/op
for i := 0; i < b.N; i++ {
- _, _ = markdown.RenderString(&markup.RenderContext{Ctx: context.Background()}, "https://example.com\n- a\n- b\n")
+ _, _ = markdown.RenderString(markup.NewTestRenderContext(), "https://example.com\n- a\n- b\n")
}
}
diff --git a/modules/markup/markdown/transform_image.go b/modules/markup/markdown/transform_image.go
index b2262c1c78..c2cbffc1c1 100644
--- a/modules/markup/markdown/transform_image.go
+++ b/modules/markup/markdown/transform_image.go
@@ -21,7 +21,7 @@ func (g *ASTTransformer) transformImage(ctx *markup.RenderContext, v *ast.Image)
// Check if the destination is a real link
if len(v.Destination) > 0 && !markup.IsFullURLBytes(v.Destination) {
v.Destination = []byte(giteautil.URLJoin(
- ctx.Links.ResolveMediaLink(ctx.IsMarkupContentWiki()),
+ ctx.RenderOptions.Links.ResolveMediaLink(ctx.IsMarkupContentWiki()),
strings.TrimLeft(string(v.Destination), "/"),
))
}
diff --git a/modules/markup/orgmode/orgmode.go b/modules/markup/orgmode/orgmode.go
index c587a6ada5..cf719cf4e9 100644
--- a/modules/markup/orgmode/orgmode.go
+++ b/modules/markup/orgmode/orgmode.go
@@ -143,15 +143,15 @@ func (r *Writer) resolveLink(kind, link string) string {
kind = org.RegularLink{URL: link}.Kind()
}
- base := r.Ctx.Links.Base
+ base := r.Ctx.RenderOptions.Links.Base
if r.Ctx.IsMarkupContentWiki() {
- base = r.Ctx.Links.WikiLink()
- } else if r.Ctx.Links.HasBranchInfo() {
- base = r.Ctx.Links.SrcLink()
+ base = r.Ctx.RenderOptions.Links.WikiLink()
+ } else if r.Ctx.RenderOptions.Links.HasBranchInfo() {
+ base = r.Ctx.RenderOptions.Links.SrcLink()
}
if kind == "image" || kind == "video" {
- base = r.Ctx.Links.ResolveMediaLink(r.Ctx.IsMarkupContentWiki())
+ base = r.Ctx.RenderOptions.Links.ResolveMediaLink(r.Ctx.IsMarkupContentWiki())
}
link = util.URLJoin(base, link)
diff --git a/modules/markup/orgmode/orgmode_test.go b/modules/markup/orgmode/orgmode_test.go
index a3eefc3db3..4048ae2475 100644
--- a/modules/markup/orgmode/orgmode_test.go
+++ b/modules/markup/orgmode/orgmode_test.go
@@ -4,10 +4,10 @@
package markup
import (
+ "os"
"strings"
"testing"
- "code.gitea.io/gitea/modules/git"
"code.gitea.io/gitea/modules/markup"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/util"
@@ -15,20 +15,21 @@ import (
"github.com/stretchr/testify/assert"
)
-const AppURL = "http://localhost:3000/"
+func TestMain(m *testing.M) {
+ setting.AppURL = "http://localhost:3000/"
+ setting.IsInTesting = true
+ os.Exit(m.Run())
+}
func TestRender_StandardLinks(t *testing.T) {
- setting.AppURL = AppURL
-
test := func(input, expected string, isWiki bool) {
- buffer, err := RenderString(&markup.RenderContext{
- Ctx: git.DefaultContext,
- Links: markup.Links{
+ buffer, err := RenderString(markup.NewTestRenderContext(
+ markup.Links{
Base: "/relative-path",
BranchPath: "branch/main",
},
- Metas: map[string]string{"markupContentMode": util.Iif(isWiki, "wiki", "")},
- }, input)
+ map[string]string{"markupContentMode": util.Iif(isWiki, "wiki", "")},
+ ), input)
assert.NoError(t, err)
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
}
@@ -42,16 +43,13 @@ func TestRender_StandardLinks(t *testing.T) {
}
func TestRender_InternalLinks(t *testing.T) {
- setting.AppURL = AppURL
-
test := func(input, expected string) {
- buffer, err := RenderString(&markup.RenderContext{
- Ctx: git.DefaultContext,
- Links: markup.Links{
+ buffer, err := RenderString(markup.NewTestRenderContext(
+ markup.Links{
Base: "/relative-path",
BranchPath: "branch/main",
},
- }, input)
+ ), input)
assert.NoError(t, err)
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
}
@@ -67,15 +65,8 @@ func TestRender_InternalLinks(t *testing.T) {
}
func TestRender_Media(t *testing.T) {
- setting.AppURL = AppURL
-
test := func(input, expected string) {
- buffer, err := RenderString(&markup.RenderContext{
- Ctx: git.DefaultContext,
- Links: markup.Links{
- Base: "./relative-path",
- },
- }, input)
+ buffer, err := RenderString(markup.NewTestRenderContext(markup.Links{Base: "./relative-path"}), input)
assert.NoError(t, err)
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
}
@@ -113,12 +104,8 @@ func TestRender_Media(t *testing.T) {
}
func TestRender_Source(t *testing.T) {
- setting.AppURL = AppURL
-
test := func(input, expected string) {
- buffer, err := RenderString(&markup.RenderContext{
- Ctx: git.DefaultContext,
- }, input)
+ buffer, err := RenderString(markup.NewTestRenderContext(), input)
assert.NoError(t, err)
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
}
diff --git a/modules/markup/render.go b/modules/markup/render.go
index f05cb62626..e251f47fc9 100644
--- a/modules/markup/render.go
+++ b/modules/markup/render.go
@@ -9,6 +9,7 @@ import (
"io"
"net/url"
"strings"
+ "time"
"code.gitea.io/gitea/modules/git"
"code.gitea.io/gitea/modules/gitrepo"
@@ -42,16 +43,16 @@ var RenderBehaviorForTesting struct {
DisableInternalAttributes bool
}
-// RenderContext represents a render context
-type RenderContext struct {
- Ctx context.Context
- RelativePath string // relative path from tree root of the branch
+type RenderOptions struct {
+ // relative path from tree root of the branch
+ RelativePath string
// eg: "orgmode", "asciicast", "console"
// for file mode, it could be left as empty, and will be detected by file extension in RelativePath
MarkupType string
- Links Links // special link references for rendering, especially when there is a branch/tree path
+ // special link references for rendering, especially when there is a branch/tree path
+ Links Links
// user&repo, format&style®exp (for external issue pattern), teams&org (for mention)
// BranchNameSubURL (for iframe&asciicast)
@@ -59,27 +60,95 @@ type RenderContext struct {
// markdownLineBreakStyle (comment, document)
Metas map[string]string
- GitRepo *git.Repository
- Repo gitrepo.Repository
- ShaExistCache map[string]bool
- cancelFn func()
- SidebarTocNode ast.Node
- RenderMetaAs RenderMetaMode
- InStandalonePage bool // used by external render. the router "/org/repo/render/..." will output the rendered content in a standalone page
+ // used by external render. the router "/org/repo/render/..." will output the rendered content in a standalone page
+ InStandalonePage bool
+}
+type RenderHelper struct {
+ gitRepo *git.Repository
+ repoFacade gitrepo.Repository
+ shaExistCache map[string]bool
+ cancelFn func()
+}
+
+// RenderContext represents a render context
+type RenderContext struct {
+ ctx context.Context
+
+ SidebarTocNode ast.Node
+
+ RenderHelper RenderHelper
+ RenderOptions RenderOptions
RenderInternal internal.RenderInternal
}
+func (ctx *RenderContext) Deadline() (deadline time.Time, ok bool) {
+ return ctx.ctx.Deadline()
+}
+
+func (ctx *RenderContext) Done() <-chan struct{} {
+ return ctx.ctx.Done()
+}
+
+func (ctx *RenderContext) Err() error {
+ return ctx.ctx.Err()
+}
+
+func (ctx *RenderContext) Value(key any) any {
+ return ctx.ctx.Value(key)
+}
+
+var _ context.Context = (*RenderContext)(nil)
+
+func NewRenderContext(ctx context.Context) *RenderContext {
+ return &RenderContext{ctx: ctx}
+}
+
+func (ctx *RenderContext) WithMarkupType(typ string) *RenderContext {
+ ctx.RenderOptions.MarkupType = typ
+ return ctx
+}
+
+func (ctx *RenderContext) WithRelativePath(path string) *RenderContext {
+ ctx.RenderOptions.RelativePath = path
+ return ctx
+}
+
+func (ctx *RenderContext) WithLinks(links Links) *RenderContext {
+ ctx.RenderOptions.Links = links
+ return ctx
+}
+
+func (ctx *RenderContext) WithMetas(metas map[string]string) *RenderContext {
+ ctx.RenderOptions.Metas = metas
+ return ctx
+}
+
+func (ctx *RenderContext) WithInStandalonePage(v bool) *RenderContext {
+ ctx.RenderOptions.InStandalonePage = v
+ return ctx
+}
+
+func (ctx *RenderContext) WithGitRepo(r *git.Repository) *RenderContext {
+ ctx.RenderHelper.gitRepo = r
+ return ctx
+}
+
+func (ctx *RenderContext) WithRepoFacade(r gitrepo.Repository) *RenderContext {
+ ctx.RenderHelper.repoFacade = r
+ return ctx
+}
+
// Cancel runs any cleanup functions that have been registered for this Ctx
func (ctx *RenderContext) Cancel() {
if ctx == nil {
return
}
- ctx.ShaExistCache = map[string]bool{}
- if ctx.cancelFn == nil {
+ ctx.RenderHelper.shaExistCache = map[string]bool{}
+ if ctx.RenderHelper.cancelFn == nil {
return
}
- ctx.cancelFn()
+ ctx.RenderHelper.cancelFn()
}
// AddCancel adds the provided fn as a Cleanup for this Ctx
@@ -87,38 +156,38 @@ func (ctx *RenderContext) AddCancel(fn func()) {
if ctx == nil {
return
}
- oldCancelFn := ctx.cancelFn
+ oldCancelFn := ctx.RenderHelper.cancelFn
if oldCancelFn == nil {
- ctx.cancelFn = fn
+ ctx.RenderHelper.cancelFn = fn
return
}
- ctx.cancelFn = func() {
+ ctx.RenderHelper.cancelFn = func() {
defer oldCancelFn()
fn()
}
}
func (ctx *RenderContext) IsMarkupContentWiki() bool {
- return ctx.Metas != nil && ctx.Metas["markupContentMode"] == "wiki"
+ return ctx.RenderOptions.Metas != nil && ctx.RenderOptions.Metas["markupContentMode"] == "wiki"
}
// Render renders markup file to HTML with all specific handling stuff.
func Render(ctx *RenderContext, input io.Reader, output io.Writer) error {
- if ctx.MarkupType == "" && ctx.RelativePath != "" {
- ctx.MarkupType = DetectMarkupTypeByFileName(ctx.RelativePath)
- if ctx.MarkupType == "" {
- return util.NewInvalidArgumentErrorf("unsupported file to render: %q", ctx.RelativePath)
+ if ctx.RenderOptions.MarkupType == "" && ctx.RenderOptions.RelativePath != "" {
+ ctx.RenderOptions.MarkupType = DetectMarkupTypeByFileName(ctx.RenderOptions.RelativePath)
+ if ctx.RenderOptions.MarkupType == "" {
+ return util.NewInvalidArgumentErrorf("unsupported file to render: %q", ctx.RenderOptions.RelativePath)
}
}
- renderer := renderers[ctx.MarkupType]
+ renderer := renderers[ctx.RenderOptions.MarkupType]
if renderer == nil {
- return util.NewInvalidArgumentErrorf("unsupported markup type: %q", ctx.MarkupType)
+ return util.NewInvalidArgumentErrorf("unsupported markup type: %q", ctx.RenderOptions.MarkupType)
}
- if ctx.RelativePath != "" {
+ if ctx.RenderOptions.RelativePath != "" {
if externalRender, ok := renderer.(ExternalRenderer); ok && externalRender.DisplayInIFrame() {
- if !ctx.InStandalonePage {
+ if !ctx.RenderOptions.InStandalonePage {
// for an external "DisplayInIFrame" render, it could only output its content in a standalone page
// otherwise, a `,
setting.AppSubURL,
- url.PathEscape(ctx.Metas["user"]),
- url.PathEscape(ctx.Metas["repo"]),
- ctx.Metas["BranchNameSubURL"],
- url.PathEscape(ctx.RelativePath),
+ url.PathEscape(ctx.RenderOptions.Metas["user"]),
+ url.PathEscape(ctx.RenderOptions.Metas["repo"]),
+ ctx.RenderOptions.Metas["BranchNameSubURL"],
+ url.PathEscape(ctx.RenderOptions.RelativePath),
))
return err
}
@@ -176,7 +245,7 @@ func render(ctx *RenderContext, renderer Renderer, input io.Reader, output io.Wr
pr1, pw1, close1 := pipes()
defer close1()
- eg, _ := errgroup.WithContext(ctx.Ctx)
+ eg, _ := errgroup.WithContext(ctx)
var pw2 io.WriteCloser = util.NopCloser{Writer: finalProcessor}
if r, ok := renderer.(ExternalRenderer); !ok || !r.SanitizerDisabled() {
@@ -230,3 +299,27 @@ func Init(ph *ProcessorHelper) {
func ComposeSimpleDocumentMetas() map[string]string {
return map[string]string{"markdownLineBreakStyle": "document"}
}
+
+// NewTestRenderContext is a helper function to create a RenderContext for testing purpose
+// It accepts string (RelativePath), Links, map[string]string (Metas), gitrepo.Repository
+func NewTestRenderContext(a ...any) *RenderContext {
+ if !setting.IsInTesting {
+ panic("NewTestRenderContext should only be used in testing")
+ }
+ ctx := NewRenderContext(context.Background())
+ for _, v := range a {
+ switch v := v.(type) {
+ case string:
+ ctx = ctx.WithRelativePath(v)
+ case Links:
+ ctx = ctx.WithLinks(v)
+ case map[string]string:
+ ctx = ctx.WithMetas(v)
+ case gitrepo.Repository:
+ ctx = ctx.WithRepoFacade(v)
+ default:
+ panic(fmt.Sprintf("unknown type %T", v))
+ }
+ }
+ return ctx
+}
diff --git a/modules/templates/util_render.go b/modules/templates/util_render.go
index 5776eefced..3237de5ecb 100644
--- a/modules/templates/util_render.go
+++ b/modules/templates/util_render.go
@@ -38,10 +38,7 @@ func (ut *RenderUtils) RenderCommitMessage(msg string, metas map[string]string)
cleanMsg := template.HTMLEscapeString(msg)
// we can safely assume that it will not return any error, since there
// shouldn't be any special HTML.
- fullMessage, err := markup.RenderCommitMessage(&markup.RenderContext{
- Ctx: ut.ctx,
- Metas: metas,
- }, cleanMsg)
+ fullMessage, err := markup.RenderCommitMessage(markup.NewRenderContext(ut.ctx).WithMetas(metas), cleanMsg)
if err != nil {
log.Error("RenderCommitMessage: %v", err)
return ""
@@ -68,10 +65,7 @@ func (ut *RenderUtils) RenderCommitMessageLinkSubject(msg, urlDefault string, me
// we can safely assume that it will not return any error, since there
// shouldn't be any special HTML.
- renderedMessage, err := markup.RenderCommitMessageSubject(&markup.RenderContext{
- Ctx: ut.ctx,
- Metas: metas,
- }, urlDefault, template.HTMLEscapeString(msgLine))
+ renderedMessage, err := markup.RenderCommitMessageSubject(markup.NewRenderContext(ut.ctx).WithMetas(metas), urlDefault, template.HTMLEscapeString(msgLine))
if err != nil {
log.Error("RenderCommitMessageSubject: %v", err)
return ""
@@ -93,10 +87,7 @@ func (ut *RenderUtils) RenderCommitBody(msg string, metas map[string]string) tem
return ""
}
- renderedMessage, err := markup.RenderCommitMessage(&markup.RenderContext{
- Ctx: ut.ctx,
- Metas: metas,
- }, template.HTMLEscapeString(msgLine))
+ renderedMessage, err := markup.RenderCommitMessage(markup.NewRenderContext(ut.ctx).WithMetas(metas), template.HTMLEscapeString(msgLine))
if err != nil {
log.Error("RenderCommitMessage: %v", err)
return ""
@@ -115,10 +106,7 @@ func renderCodeBlock(htmlEscapedTextToRender template.HTML) template.HTML {
// RenderIssueTitle renders issue/pull title with defined post processors
func (ut *RenderUtils) RenderIssueTitle(text string, metas map[string]string) template.HTML {
- renderedText, err := markup.RenderIssueTitle(&markup.RenderContext{
- Ctx: ut.ctx,
- Metas: metas,
- }, template.HTMLEscapeString(text))
+ renderedText, err := markup.RenderIssueTitle(markup.NewRenderContext(ut.ctx).WithMetas(metas), template.HTMLEscapeString(text))
if err != nil {
log.Error("RenderIssueTitle: %v", err)
return ""
@@ -186,7 +174,7 @@ func (ut *RenderUtils) RenderLabel(label *issues_model.Label) template.HTML {
// RenderEmoji renders html text with emoji post processors
func (ut *RenderUtils) RenderEmoji(text string) template.HTML {
- renderedText, err := markup.RenderEmoji(&markup.RenderContext{Ctx: ut.ctx}, template.HTMLEscapeString(text))
+ renderedText, err := markup.RenderEmoji(markup.NewRenderContext(ut.ctx), template.HTMLEscapeString(text))
if err != nil {
log.Error("RenderEmoji: %v", err)
return ""
@@ -208,10 +196,7 @@ func reactionToEmoji(reaction string) template.HTML {
}
func (ut *RenderUtils) MarkdownToHtml(input string) template.HTML { //nolint:revive
- output, err := markdown.RenderString(&markup.RenderContext{
- Ctx: ut.ctx,
- Metas: markup.ComposeSimpleDocumentMetas(),
- }, input)
+ output, err := markdown.RenderString(markup.NewRenderContext(ut.ctx).WithMetas(markup.ComposeSimpleDocumentMetas()), input)
if err != nil {
log.Error("RenderString: %v", err)
}
diff --git a/routers/api/v1/misc/markup.go b/routers/api/v1/misc/markup.go
index 868ed92519..7b3633552f 100644
--- a/routers/api/v1/misc/markup.go
+++ b/routers/api/v1/misc/markup.go
@@ -99,9 +99,7 @@ func MarkdownRaw(ctx *context.APIContext) {
// "422":
// "$ref": "#/responses/validationError"
defer ctx.Req.Body.Close()
- if err := markdown.RenderRaw(&markup.RenderContext{
- Ctx: ctx,
- }, ctx.Req.Body, ctx.Resp); err != nil {
+ if err := markdown.RenderRaw(markup.NewRenderContext(ctx), ctx.Req.Body, ctx.Resp); err != nil {
ctx.InternalServerError(err)
return
}
diff --git a/routers/common/markup.go b/routers/common/markup.go
index dd6b286109..59f338c2bc 100644
--- a/routers/common/markup.go
+++ b/routers/common/markup.go
@@ -28,13 +28,12 @@ func RenderMarkup(ctx *context.Base, repo *context.Repository, mode, text, urlPa
// for example, when previewing file "/gitea/owner/repo/src/branch/features/feat-123/doc/CHANGE.md", then filePath is "doc/CHANGE.md"
// and the urlPathContext is "/gitea/owner/repo/src/branch/features/feat-123/doc"
- renderCtx := &markup.RenderContext{
- Ctx: ctx,
- Links: markup.Links{AbsolutePrefix: true},
- MarkupType: markdown.MarkupName,
- }
+ renderCtx := markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{AbsolutePrefix: true}).
+ WithMarkupType(markdown.MarkupName)
+
if urlPathContext != "" {
- renderCtx.Links.Base = fmt.Sprintf("%s%s", httplib.GuessCurrentHostURL(ctx), urlPathContext)
+ renderCtx.RenderOptions.Links.Base = fmt.Sprintf("%s%s", httplib.GuessCurrentHostURL(ctx), urlPathContext)
}
if mode == "" || mode == "markdown" {
@@ -47,15 +46,14 @@ func RenderMarkup(ctx *context.Base, repo *context.Repository, mode, text, urlPa
switch mode {
case "gfm": // legacy mode, do nothing
case "comment":
- renderCtx.Metas = map[string]string{"markdownLineBreakStyle": "comment"}
+ renderCtx = renderCtx.WithMetas(map[string]string{"markdownLineBreakStyle": "comment"})
case "wiki":
- renderCtx.Metas = map[string]string{"markdownLineBreakStyle": "document", "markupContentMode": "wiki"}
+ renderCtx = renderCtx.WithMetas(map[string]string{"markdownLineBreakStyle": "document", "markupContentMode": "wiki"})
case "file":
// render the repo file content by its extension
- renderCtx.Metas = map[string]string{"markdownLineBreakStyle": "document"}
- renderCtx.MarkupType = ""
- renderCtx.RelativePath = filePath
- renderCtx.InStandalonePage = true
+ renderCtx = renderCtx.WithMetas(map[string]string{"markdownLineBreakStyle": "document"}).
+ WithMarkupType("").
+ WithRelativePath(filePath)
default:
ctx.Error(http.StatusUnprocessableEntity, fmt.Sprintf("Unknown mode: %s", mode))
return
@@ -70,17 +68,17 @@ func RenderMarkup(ctx *context.Base, repo *context.Repository, mode, text, urlPa
refPath := strings.Join(fields[3:], "/") // it is "branch/features/feat-12/doc"
refPath = strings.TrimSuffix(refPath, "/"+fileDir) // now we get the correct branch path: "branch/features/feat-12"
- renderCtx.Links = markup.Links{AbsolutePrefix: true, Base: absoluteBasePrefix, BranchPath: refPath, TreePath: fileDir}
+ renderCtx = renderCtx.WithLinks(markup.Links{AbsolutePrefix: true, Base: absoluteBasePrefix, BranchPath: refPath, TreePath: fileDir})
}
if repo != nil && repo.Repository != nil {
- renderCtx.Repo = repo.Repository
+ renderCtx = renderCtx.WithRepoFacade(repo.Repository)
if mode == "file" {
- renderCtx.Metas = repo.Repository.ComposeDocumentMetas(ctx)
+ renderCtx = renderCtx.WithMetas(repo.Repository.ComposeDocumentMetas(ctx))
} else if mode == "wiki" {
- renderCtx.Metas = repo.Repository.ComposeWikiMetas(ctx)
+ renderCtx = renderCtx.WithMetas(repo.Repository.ComposeWikiMetas(ctx))
} else if mode == "comment" {
- renderCtx.Metas = repo.Repository.ComposeMetas(ctx)
+ renderCtx = renderCtx.WithMetas(repo.Repository.ComposeMetas(ctx))
}
}
if err := markup.Render(renderCtx, strings.NewReader(text), ctx.Resp); err != nil {
diff --git a/routers/web/feed/convert.go b/routers/web/feed/convert.go
index afc2c343a6..fad7dfdf5e 100644
--- a/routers/web/feed/convert.go
+++ b/routers/web/feed/convert.go
@@ -51,16 +51,14 @@ func toReleaseLink(ctx *context.Context, act *activities_model.Action) string {
// renderMarkdown creates a minimal markdown render context from an action.
// If rendering fails, the original markdown text is returned
func renderMarkdown(ctx *context.Context, act *activities_model.Action, content string) template.HTML {
- markdownCtx := &markup.RenderContext{
- Ctx: ctx,
- Links: markup.Links{
+ markdownCtx := markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{
Base: act.GetRepoLink(ctx),
- },
- Metas: map[string]string{ // FIXME: not right here, it should use issue to compose the metas
+ }).
+ WithMetas(map[string]string{ // FIXME: not right here, it should use issue to compose the metas
"user": act.GetRepoUserName(ctx),
"repo": act.GetRepoName(ctx),
- },
- }
+ })
markdown, err := markdown.RenderString(markdownCtx, content)
if err != nil {
return templates.SanitizeHTML(content) // old code did so: use SanitizeHTML to render in tmpl
@@ -296,14 +294,13 @@ func releasesToFeedItems(ctx *context.Context, releases []*repo_model.Release) (
}
link := &feeds.Link{Href: rel.HTMLURL()}
- content, err = markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- Repo: rel.Repo,
- Links: markup.Links{
+ content, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithRepoFacade(rel.Repo).
+ WithLinks(markup.Links{
Base: rel.Repo.Link(),
- },
- Metas: rel.Repo.ComposeMetas(ctx),
- }, rel.Note)
+ }).
+ WithMetas(rel.Repo.ComposeMetas(ctx)),
+ rel.Note)
if err != nil {
return nil, err
}
diff --git a/routers/web/feed/profile.go b/routers/web/feed/profile.go
index 6dd2d14cc6..7c4864b45e 100644
--- a/routers/web/feed/profile.go
+++ b/routers/web/feed/profile.go
@@ -41,13 +41,10 @@ func showUserFeed(ctx *context.Context, formatType string) {
return
}
- ctxUserDescription, err := markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- Links: markup.Links{
- Base: ctx.ContextUser.HTMLURL(),
- },
- Metas: markup.ComposeSimpleDocumentMetas(),
- }, ctx.ContextUser.Description)
+ ctxUserDescription, err := markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.ContextUser.HTMLURL()}).
+ WithMetas(markup.ComposeSimpleDocumentMetas()),
+ ctx.ContextUser.Description)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/org/home.go b/routers/web/org/home.go
index 18648d33cd..d0ac82b1b0 100644
--- a/routers/web/org/home.go
+++ b/routers/web/org/home.go
@@ -180,17 +180,16 @@ func prepareOrgProfileReadme(ctx *context.Context, viewRepositories bool) bool {
if bytes, err := profileReadme.GetBlobContent(setting.UI.MaxDisplayFileSize); err != nil {
log.Error("failed to GetBlobContent: %v", err)
} else {
- if profileContent, err := markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- GitRepo: profileGitRepo,
- Links: markup.Links{
+ if profileContent, err := markdown.RenderString(markup.NewRenderContext(ctx).
+ WithGitRepo(profileGitRepo).
+ WithLinks(markup.Links{
// Pass repo link to markdown render for the full link of media elements.
// The profile of default branch would be shown.
Base: profileDbRepo.Link(),
BranchPath: path.Join("branch", util.PathEscapeSegments(profileDbRepo.DefaultBranch)),
- },
- Metas: markup.ComposeSimpleDocumentMetas(),
- }, bytes); err != nil {
+ }).
+ WithMetas(markup.ComposeSimpleDocumentMetas()),
+ bytes); err != nil {
log.Error("failed to RenderString: %v", err)
} else {
ctx.Data["ProfileReadme"] = profileContent
diff --git a/routers/web/repo/commit.go b/routers/web/repo/commit.go
index d7865e18d6..87b1f9019a 100644
--- a/routers/web/repo/commit.go
+++ b/routers/web/repo/commit.go
@@ -392,16 +392,15 @@ func Diff(ctx *context.Context) {
if err == nil {
ctx.Data["NoteCommit"] = note.Commit
ctx.Data["NoteAuthor"] = user_model.ValidateCommitWithEmail(ctx, note.Commit)
- ctx.Data["NoteRendered"], err = markup.RenderCommitMessage(&markup.RenderContext{
- Links: markup.Links{
+ ctx.Data["NoteRendered"], err = markup.RenderCommitMessage(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{
Base: ctx.Repo.RepoLink,
BranchPath: path.Join("commit", util.PathEscapeSegments(commitID)),
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, template.HTMLEscapeString(string(charset.ToUTF8WithFallback(note.Message, charset.ConvertOpts{}))))
+ }).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ template.HTMLEscapeString(string(charset.ToUTF8WithFallback(note.Message, charset.ConvertOpts{}))))
if err != nil {
ctx.ServerError("RenderCommitMessage", err)
return
diff --git a/routers/web/repo/compare.go b/routers/web/repo/compare.go
index a5fdba3fde..278974bec3 100644
--- a/routers/web/repo/compare.go
+++ b/routers/web/repo/compare.go
@@ -149,7 +149,7 @@ func setCsvCompareContext(ctx *context.Context) {
return csvReader, reader, err
}
- baseReader, baseBlobCloser, err := csvReaderFromCommit(&markup.RenderContext{Ctx: ctx, RelativePath: diffFile.OldName}, baseBlob)
+ baseReader, baseBlobCloser, err := csvReaderFromCommit(markup.NewRenderContext(ctx).WithRelativePath(diffFile.OldName), baseBlob)
if baseBlobCloser != nil {
defer baseBlobCloser.Close()
}
@@ -161,7 +161,7 @@ func setCsvCompareContext(ctx *context.Context) {
return CsvDiffResult{nil, "unable to load file"}
}
- headReader, headBlobCloser, err := csvReaderFromCommit(&markup.RenderContext{Ctx: ctx, RelativePath: diffFile.Name}, headBlob)
+ headReader, headBlobCloser, err := csvReaderFromCommit(markup.NewRenderContext(ctx).WithRelativePath(diffFile.Name), headBlob)
if headBlobCloser != nil {
defer headBlobCloser.Close()
}
diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go
index d1dbdd6bff..d52dbf3939 100644
--- a/routers/web/repo/issue.go
+++ b/routers/web/repo/issue.go
@@ -366,15 +366,12 @@ func UpdateIssueContent(ctx *context.Context) {
}
}
- content, err := markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.FormString("context"), // FIXME: <- IS THIS SAFE ?
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, issue.Content)
+ content, err := markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.FormString("context")}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ issue.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/repo/issue_comment.go b/routers/web/repo/issue_comment.go
index 6f0fa938ce..33105d67ca 100644
--- a/routers/web/repo/issue_comment.go
+++ b/routers/web/repo/issue_comment.go
@@ -267,15 +267,12 @@ func UpdateCommentContent(ctx *context.Context) {
var renderedContent template.HTML
if comment.Content != "" {
- renderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.FormString("context"), // FIXME: <- IS THIS SAFE ?
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, comment.Content)
+ renderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.FormString("context")}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ comment.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/repo/issue_view.go b/routers/web/repo/issue_view.go
index 284928856f..55d36cfefa 100644
--- a/routers/web/repo/issue_view.go
+++ b/routers/web/repo/issue_view.go
@@ -359,15 +359,12 @@ func ViewIssue(ctx *context.Context) {
}
}
ctx.Data["IssueWatch"] = iw
- issue.RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, issue.Content)
+ issue.RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ issue.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
@@ -467,15 +464,14 @@ func ViewIssue(ctx *context.Context) {
comment.Issue = issue
if comment.Type == issues_model.CommentTypeComment || comment.Type == issues_model.CommentTypeReview {
- comment.RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
+ comment.RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{
Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, comment.Content)
+ }).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ comment.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
@@ -550,15 +546,12 @@ func ViewIssue(ctx *context.Context) {
}
}
} else if comment.Type.HasContentSupport() {
- comment.RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, comment.Content)
+ comment.RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ comment.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/repo/milestone.go b/routers/web/repo/milestone.go
index 5c0972188c..7361fe66bc 100644
--- a/routers/web/repo/milestone.go
+++ b/routers/web/repo/milestone.go
@@ -79,15 +79,12 @@ func Milestones(ctx *context.Context) {
}
}
for _, m := range miles {
- m.RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, m.Content)
+ m.RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ m.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
@@ -268,15 +265,12 @@ func MilestoneIssuesAndPulls(ctx *context.Context) {
return
}
- milestone.RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, milestone.Content)
+ milestone.RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ milestone.Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/repo/projects.go b/routers/web/repo/projects.go
index 664ea7eb76..cce13df3be 100644
--- a/routers/web/repo/projects.go
+++ b/routers/web/repo/projects.go
@@ -92,15 +92,12 @@ func Projects(ctx *context.Context) {
}
for i := range projects {
- projects[i].RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, projects[i].Description)
+ projects[i].RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ projects[i].Description)
if err != nil {
ctx.ServerError("RenderString", err)
return
@@ -425,15 +422,12 @@ func ViewProject(ctx *context.Context) {
ctx.Data["SelectLabels"] = selectLabels
ctx.Data["AssigneeID"] = assigneeID
- project.RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, project.Description)
+ project.RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ project.Description)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/repo/release.go b/routers/web/repo/release.go
index 566a82316f..1b5305a90d 100644
--- a/routers/web/repo/release.go
+++ b/routers/web/repo/release.go
@@ -114,15 +114,12 @@ func getReleaseInfos(ctx *context.Context, opts *repo_model.FindReleasesOptions)
cacheUsers[r.PublisherID] = r.Publisher
}
- r.RenderedNote, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- Metas: ctx.Repo.Repository.ComposeMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- Repo: ctx.Repo.Repository,
- Ctx: ctx,
- }, r.Note)
+ r.RenderedNote, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink}).
+ WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithRepoFacade(ctx.Repo.Repository),
+ r.Note)
if err != nil {
return nil, err
}
diff --git a/routers/web/repo/render.go b/routers/web/repo/render.go
index 6aba9e0ac1..c551e44f46 100644
--- a/routers/web/repo/render.go
+++ b/routers/web/repo/render.go
@@ -56,18 +56,17 @@ func RenderFile(ctx *context.Context) {
return
}
- err = markup.Render(&markup.RenderContext{
- Ctx: ctx,
- RelativePath: ctx.Repo.TreePath,
- Links: markup.Links{
+ err = markup.Render(markup.NewRenderContext(ctx).
+ WithRelativePath(ctx.Repo.TreePath).
+ WithLinks(markup.Links{
Base: ctx.Repo.RepoLink,
BranchPath: ctx.Repo.BranchNameSubURL(),
TreePath: path.Dir(ctx.Repo.TreePath),
- },
- Metas: ctx.Repo.Repository.ComposeDocumentMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- InStandalonePage: true,
- }, rd, ctx.Resp)
+ }).
+ WithMetas(ctx.Repo.Repository.ComposeDocumentMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo).
+ WithInStandalonePage(true),
+ rd, ctx.Resp)
if err != nil {
log.Error("Failed to render file %q: %v", ctx.Repo.TreePath, err)
http.Error(ctx.Resp, "Failed to render file", http.StatusInternalServerError)
diff --git a/routers/web/repo/view.go b/routers/web/repo/view.go
index 5d68ace29b..aacd7de6b1 100644
--- a/routers/web/repo/view.go
+++ b/routers/web/repo/view.go
@@ -310,18 +310,17 @@ func renderReadmeFile(ctx *context.Context, subfolder string, readmeFile *git.Tr
ctx.Data["IsMarkup"] = true
ctx.Data["MarkupType"] = markupType
- ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, &markup.RenderContext{
- Ctx: ctx,
- MarkupType: markupType,
- RelativePath: path.Join(ctx.Repo.TreePath, readmeFile.Name()), // ctx.Repo.TreePath is the directory not the Readme so we must append the Readme filename (and path).
- Links: markup.Links{
+ ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, markup.NewRenderContext(ctx).
+ WithMarkupType(markupType).
+ WithRelativePath(path.Join(ctx.Repo.TreePath, readmeFile.Name())). // ctx.Repo.TreePath is the directory not the Readme so we must append the Readme filename (and path).
+ WithLinks(markup.Links{
Base: ctx.Repo.RepoLink,
BranchPath: ctx.Repo.BranchNameSubURL(),
TreePath: path.Join(ctx.Repo.TreePath, subfolder),
- },
- Metas: ctx.Repo.Repository.ComposeDocumentMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- }, rd)
+ }).
+ WithMetas(ctx.Repo.Repository.ComposeDocumentMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo),
+ rd)
if err != nil {
log.Error("Render failed for %s in %-v: %v Falling back to rendering source", readmeFile.Name(), ctx.Repo.Repository, err)
delete(ctx.Data, "IsMarkup")
@@ -514,18 +513,17 @@ func renderFile(ctx *context.Context, entry *git.TreeEntry) {
ctx.Data["MarkupType"] = markupType
metas := ctx.Repo.Repository.ComposeDocumentMetas(ctx)
metas["BranchNameSubURL"] = ctx.Repo.BranchNameSubURL()
- ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, &markup.RenderContext{
- Ctx: ctx,
- MarkupType: markupType,
- RelativePath: ctx.Repo.TreePath,
- Links: markup.Links{
+ ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, markup.NewRenderContext(ctx).
+ WithMarkupType(markupType).
+ WithRelativePath(ctx.Repo.TreePath).
+ WithLinks(markup.Links{
Base: ctx.Repo.RepoLink,
BranchPath: ctx.Repo.BranchNameSubURL(),
TreePath: path.Dir(ctx.Repo.TreePath),
- },
- Metas: metas,
- GitRepo: ctx.Repo.GitRepo,
- }, rd)
+ }).
+ WithMetas(metas).
+ WithGitRepo(ctx.Repo.GitRepo),
+ rd)
if err != nil {
ctx.ServerError("Render", err)
return
@@ -606,18 +604,17 @@ func renderFile(ctx *context.Context, entry *git.TreeEntry) {
rd := io.MultiReader(bytes.NewReader(buf), dataRc)
ctx.Data["IsMarkup"] = true
ctx.Data["MarkupType"] = markupType
- ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, &markup.RenderContext{
- Ctx: ctx,
- MarkupType: markupType,
- RelativePath: ctx.Repo.TreePath,
- Links: markup.Links{
+ ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, markup.NewRenderContext(ctx).
+ WithMarkupType(markupType).
+ WithRelativePath(ctx.Repo.TreePath).
+ WithLinks(markup.Links{
Base: ctx.Repo.RepoLink,
BranchPath: ctx.Repo.BranchNameSubURL(),
TreePath: path.Dir(ctx.Repo.TreePath),
- },
- Metas: ctx.Repo.Repository.ComposeDocumentMetas(ctx),
- GitRepo: ctx.Repo.GitRepo,
- }, rd)
+ }).
+ WithMetas(ctx.Repo.Repository.ComposeDocumentMetas(ctx)).
+ WithGitRepo(ctx.Repo.GitRepo),
+ rd)
if err != nil {
ctx.ServerError("Render", err)
return
diff --git a/routers/web/repo/wiki.go b/routers/web/repo/wiki.go
index 2732a67e71..eda3320ff0 100644
--- a/routers/web/repo/wiki.go
+++ b/routers/web/repo/wiki.go
@@ -288,13 +288,9 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
footerContent = data
}
- rctx := &markup.RenderContext{
- Ctx: ctx,
- Metas: ctx.Repo.Repository.ComposeWikiMetas(ctx),
- Links: markup.Links{
- Base: ctx.Repo.RepoLink,
- },
- }
+ rctx := markup.NewRenderContext(ctx).
+ WithMetas(ctx.Repo.Repository.ComposeWikiMetas(ctx)).
+ WithLinks(markup.Links{Base: ctx.Repo.RepoLink})
buf := &strings.Builder{}
renderFn := func(data []byte) (escaped *charset.EscapeStatus, output string, err error) {
diff --git a/routers/web/shared/user/header.go b/routers/web/shared/user/header.go
index 9467b0986b..4cb0592b4b 100644
--- a/routers/web/shared/user/header.go
+++ b/routers/web/shared/user/header.go
@@ -49,10 +49,7 @@ func PrepareContextForProfileBigAvatar(ctx *context.Context) {
}
ctx.Data["OpenIDs"] = openIDs
if len(ctx.ContextUser.Description) != 0 {
- content, err := markdown.RenderString(&markup.RenderContext{
- Metas: markup.ComposeSimpleDocumentMetas(),
- Ctx: ctx,
- }, ctx.ContextUser.Description)
+ content, err := markdown.RenderString(markup.NewRenderContext(ctx).WithMetas(markup.ComposeSimpleDocumentMetas()), ctx.ContextUser.Description)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/user/home.go b/routers/web/user/home.go
index 2b16142f6d..0bd0371f14 100644
--- a/routers/web/user/home.go
+++ b/routers/web/user/home.go
@@ -257,14 +257,11 @@ func Milestones(ctx *context.Context) {
continue
}
- milestones[i].RenderedContent, err = markdown.RenderString(&markup.RenderContext{
- Links: markup.Links{
- Base: milestones[i].Repo.Link(),
- },
- Metas: milestones[i].Repo.ComposeMetas(ctx),
- Ctx: ctx,
- Repo: milestones[i].Repo,
- }, milestones[i].Content)
+ milestones[i].RenderedContent, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithLinks(markup.Links{Base: milestones[i].Repo.Link()}).
+ WithMetas(milestones[i].Repo.ComposeMetas(ctx)).
+ WithRepoFacade(milestones[i].Repo),
+ milestones[i].Content)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/routers/web/user/profile.go b/routers/web/user/profile.go
index 4fbfc2bd17..2c9487bbc0 100644
--- a/routers/web/user/profile.go
+++ b/routers/web/user/profile.go
@@ -246,10 +246,9 @@ func prepareUserProfileTabData(ctx *context.Context, showPrivate bool, profileDb
if bytes, err := profileReadme.GetBlobContent(setting.UI.MaxDisplayFileSize); err != nil {
log.Error("failed to GetBlobContent: %v", err)
} else {
- if profileContent, err := markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- GitRepo: profileGitRepo,
- Links: markup.Links{
+ if profileContent, err := markdown.RenderString(markup.NewRenderContext(ctx).
+ WithGitRepo(profileGitRepo).
+ WithLinks(markup.Links{
// Give the repo link to the markdown render for the full link of media element.
// the media link usually be like /[user]/[repoName]/media/branch/[branchName],
// Eg. /Tom/.profile/media/branch/main
@@ -257,8 +256,8 @@ func prepareUserProfileTabData(ctx *context.Context, showPrivate bool, profileDb
// https://docs.gitea.com/usage/profile-readme
Base: profileDbRepo.Link(),
BranchPath: path.Join("branch", util.PathEscapeSegments(profileDbRepo.DefaultBranch)),
- },
- }, bytes); err != nil {
+ }),
+ bytes); err != nil {
log.Error("failed to RenderString: %v", err)
} else {
ctx.Data["ProfileReadme"] = profileContent
diff --git a/services/context/org.go b/services/context/org.go
index 132ce19a31..bf482fa754 100644
--- a/services/context/org.go
+++ b/services/context/org.go
@@ -259,9 +259,7 @@ func HandleOrgAssignment(ctx *Context, args ...bool) {
ctx.Data["IsFollowing"] = ctx.Doer != nil && user_model.IsFollowing(ctx, ctx.Doer.ID, ctx.ContextUser.ID)
if len(ctx.ContextUser.Description) != 0 {
- content, err := markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- }, ctx.ContextUser.Description)
+ content, err := markdown.RenderString(markup.NewRenderContext(ctx), ctx.ContextUser.Description)
if err != nil {
ctx.ServerError("RenderString", err)
return
diff --git a/services/mailer/mail.go b/services/mailer/mail.go
index 23c91595b7..162e497dc0 100644
--- a/services/mailer/mail.go
+++ b/services/mailer/mail.go
@@ -219,15 +219,11 @@ func composeIssueCommentMessages(ctx *mailCommentContext, lang string, recipient
}
// This is the body of the new issue or comment, not the mail body
- body, err := markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- Repo: ctx.Issue.Repo,
- Links: markup.Links{
- AbsolutePrefix: true,
- Base: ctx.Issue.Repo.HTMLURL(),
- },
- Metas: ctx.Issue.Repo.ComposeMetas(ctx),
- }, ctx.Content)
+ body, err := markdown.RenderString(markup.NewRenderContext(ctx).
+ WithRepoFacade(ctx.Issue.Repo).
+ WithLinks(markup.Links{AbsolutePrefix: true, Base: ctx.Issue.Repo.HTMLURL()}).
+ WithMetas(ctx.Issue.Repo.ComposeMetas(ctx)),
+ ctx.Content)
if err != nil {
return nil, err
}
diff --git a/services/mailer/mail_release.go b/services/mailer/mail_release.go
index 01a8929e2d..3298c2273a 100644
--- a/services/mailer/mail_release.go
+++ b/services/mailer/mail_release.go
@@ -56,14 +56,11 @@ func mailNewRelease(ctx context.Context, lang string, tos []*user_model.User, re
locale := translation.NewLocale(lang)
var err error
- rel.RenderedNote, err = markdown.RenderString(&markup.RenderContext{
- Ctx: ctx,
- Repo: rel.Repo,
- Links: markup.Links{
- Base: rel.Repo.HTMLURL(),
- },
- Metas: rel.Repo.ComposeMetas(ctx),
- }, rel.Note)
+ rel.RenderedNote, err = markdown.RenderString(markup.NewRenderContext(ctx).
+ WithRepoFacade(rel.Repo).
+ WithLinks(markup.Links{Base: rel.Repo.HTMLURL()}).
+ WithMetas(rel.Repo.ComposeMetas(ctx)),
+ rel.Note)
if err != nil {
log.Error("markdown.RenderString(%d): %v", rel.RepoID, err)
return
diff --git a/tests/fuzz/fuzz_test.go b/tests/fuzz/fuzz_test.go
index 25a6ed8213..78d3027547 100644
--- a/tests/fuzz/fuzz_test.go
+++ b/tests/fuzz/fuzz_test.go
@@ -14,27 +14,22 @@ import (
"code.gitea.io/gitea/modules/setting"
)
-var renderContext = markup.RenderContext{
- Ctx: context.Background(),
- Links: markup.Links{
- Base: "https://example.com/go-gitea/gitea",
- },
- Metas: map[string]string{
- "user": "go-gitea",
- "repo": "gitea",
- },
+func newFuzzRenderContext() *markup.RenderContext {
+ return markup.NewRenderContext(context.Background()).
+ WithLinks(markup.Links{Base: "https://example.com/go-gitea/gitea"}).
+ WithMetas(map[string]string{"user": "go-gitea", "repo": "gitea"})
}
func FuzzMarkdownRenderRaw(f *testing.F) {
f.Fuzz(func(t *testing.T, data []byte) {
setting.AppURL = "http://localhost:3000/"
- markdown.RenderRaw(&renderContext, bytes.NewReader(data), io.Discard)
+ markdown.RenderRaw(newFuzzRenderContext(), bytes.NewReader(data), io.Discard)
})
}
func FuzzMarkupPostProcess(f *testing.F) {
f.Fuzz(func(t *testing.T, data []byte) {
setting.AppURL = "http://localhost:3000/"
- markup.PostProcess(&renderContext, bytes.NewReader(data), io.Discard)
+ markup.PostProcess(newFuzzRenderContext(), bytes.NewReader(data), io.Discard)
})
}