Refactor markup render system (#32612)

This PR removes (almost) all path tricks, and introduces "renderhelper"
package.

Now we can clearly see the rendering behaviors for comment/file/wiki,
more details are in "renderhelper" tests.

Fix #31411 , fix #18592, fix #25632 and maybe more problems. (ps: fix
#32608 by the way)

routers/web/repo/commit.go

@@ -15,6 +15,7 @@ import (
 	asymkey_model "code.gitea.io/gitea/models/asymkey"
 	"code.gitea.io/gitea/models/db"
 	git_model "code.gitea.io/gitea/models/git"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	unit_model "code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
@@ -392,15 +393,8 @@ 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.NewRenderContext(ctx).
-			WithLinks(markup.Links{
-				Base:       ctx.Repo.RepoLink,
-				BranchPath: path.Join("commit", util.PathEscapeSegments(commitID)),
-			}).
-			WithMetas(ctx.Repo.Repository.ComposeMetas(ctx)).
-			WithGitRepo(ctx.Repo.GitRepo).
-			WithRepoFacade(ctx.Repo.Repository),
-			template.HTMLEscapeString(string(charset.ToUTF8WithFallback(note.Message, charset.ConvertOpts{}))))
+		rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository, renderhelper.RepoCommentOptions{CurrentRefPath: path.Join("commit", util.PathEscapeSegments(commitID))})
+		ctx.Data["NoteRendered"], err = markup.RenderCommitMessage(rctx, template.HTMLEscapeString(string(charset.ToUTF8WithFallback(note.Message, charset.ConvertOpts{}))))
 		if err != nil {
 			ctx.ServerError("RenderCommitMessage", err)
 			return

routers/web/repo/issue.go

@@ -18,12 +18,12 @@ import (
 	"code.gitea.io/gitea/models/organization"
 	access_model "code.gitea.io/gitea/models/perm/access"
 	project_model "code.gitea.io/gitea/models/project"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/base"
 	"code.gitea.io/gitea/modules/log"
-	"code.gitea.io/gitea/modules/markup"
 	"code.gitea.io/gitea/modules/markup/markdown"
 	"code.gitea.io/gitea/modules/optional"
 	api "code.gitea.io/gitea/modules/structs"
@@ -366,12 +366,8 @@ func UpdateIssueContent(ctx *context.Context) {
 		}
 	}
 
-	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)
+	rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository)
+	content, err := markdown.RenderString(rctx, issue.Content)
 	if err != nil {
 		ctx.ServerError("RenderString", err)
 		return

routers/web/repo/issue_comment.go

@@ -10,10 +10,10 @@ import (
 	"net/http"
 
 	issues_model "code.gitea.io/gitea/models/issues"
+	"code.gitea.io/gitea/models/renderhelper"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/git"
 	"code.gitea.io/gitea/modules/log"
-	"code.gitea.io/gitea/modules/markup"
 	"code.gitea.io/gitea/modules/markup/markdown"
 	repo_module "code.gitea.io/gitea/modules/repository"
 	"code.gitea.io/gitea/modules/setting"
@@ -267,12 +267,8 @@ func UpdateCommentContent(ctx *context.Context) {
 
 	var renderedContent template.HTML
 	if 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)
+		rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository)
+		renderedContent, err = markdown.RenderString(rctx, comment.Content)
 		if err != nil {
 			ctx.ServerError("RenderString", err)
 			return

routers/web/repo/issue_view.go

@@ -19,6 +19,7 @@ import (
 	access_model "code.gitea.io/gitea/models/perm/access"
 	project_model "code.gitea.io/gitea/models/project"
 	pull_model "code.gitea.io/gitea/models/pull"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
@@ -359,12 +360,8 @@ func ViewIssue(ctx *context.Context) {
 		}
 	}
 	ctx.Data["IssueWatch"] = iw
-	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)
+	rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository)
+	issue.RenderedContent, err = markdown.RenderString(rctx, issue.Content)
 	if err != nil {
 		ctx.ServerError("RenderString", err)
 		return
@@ -464,14 +461,8 @@ 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.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)
+			rctx = renderhelper.NewRenderContextRepoComment(ctx, repo)
+			comment.RenderedContent, err = markdown.RenderString(rctx, comment.Content)
 			if err != nil {
 				ctx.ServerError("RenderString", err)
 				return
@@ -546,12 +537,8 @@ func ViewIssue(ctx *context.Context) {
 				}
 			}
 		} else if comment.Type.HasContentSupport() {
-			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)
+			rctx = renderhelper.NewRenderContextRepoComment(ctx, repo)
+			comment.RenderedContent, err = markdown.RenderString(rctx, comment.Content)
 			if err != nil {
 				ctx.ServerError("RenderString", err)
 				return

routers/web/repo/milestone.go

@@ -10,8 +10,8 @@ import (
 
 	"code.gitea.io/gitea/models/db"
 	issues_model "code.gitea.io/gitea/models/issues"
+	"code.gitea.io/gitea/models/renderhelper"
 	"code.gitea.io/gitea/modules/base"
-	"code.gitea.io/gitea/modules/markup"
 	"code.gitea.io/gitea/modules/markup/markdown"
 	"code.gitea.io/gitea/modules/optional"
 	"code.gitea.io/gitea/modules/setting"
@@ -79,12 +79,8 @@ func Milestones(ctx *context.Context) {
 		}
 	}
 	for _, m := range miles {
-		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)
+		rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository)
+		m.RenderedContent, err = markdown.RenderString(rctx, m.Content)
 		if err != nil {
 			ctx.ServerError("RenderString", err)
 			return
@@ -265,12 +261,8 @@ func MilestoneIssuesAndPulls(ctx *context.Context) {
 		return
 	}
 
-	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)
+	rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository)
+	milestone.RenderedContent, err = markdown.RenderString(rctx, milestone.Content)
 	if err != nil {
 		ctx.ServerError("RenderString", err)
 		return

routers/web/repo/projects.go

@@ -13,11 +13,11 @@ import (
 	issues_model "code.gitea.io/gitea/models/issues"
 	"code.gitea.io/gitea/models/perm"
 	project_model "code.gitea.io/gitea/models/project"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unit"
 	"code.gitea.io/gitea/modules/base"
 	"code.gitea.io/gitea/modules/json"
-	"code.gitea.io/gitea/modules/markup"
 	"code.gitea.io/gitea/modules/markup/markdown"
 	"code.gitea.io/gitea/modules/optional"
 	"code.gitea.io/gitea/modules/setting"
@@ -92,12 +92,8 @@ func Projects(ctx *context.Context) {
 	}
 
 	for i := range projects {
-		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)
+		rctx := renderhelper.NewRenderContextRepoComment(ctx, repo)
+		projects[i].RenderedContent, err = markdown.RenderString(rctx, projects[i].Description)
 		if err != nil {
 			ctx.ServerError("RenderString", err)
 			return
@@ -422,12 +418,8 @@ func ViewProject(ctx *context.Context) {
 	ctx.Data["SelectLabels"] = selectLabels
 	ctx.Data["AssigneeID"] = assigneeID
 
-	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)
+	rctx := renderhelper.NewRenderContextRepoComment(ctx, ctx.Repo.Repository)
+	project.RenderedContent, err = markdown.RenderString(rctx, project.Description)
 	if err != nil {
 		ctx.ServerError("RenderString", err)
 		return

routers/web/repo/release.go

@@ -13,13 +13,13 @@ import (
 	"code.gitea.io/gitea/models"
 	"code.gitea.io/gitea/models/db"
 	git_model "code.gitea.io/gitea/models/git"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/base"
 	"code.gitea.io/gitea/modules/git"
 	"code.gitea.io/gitea/modules/log"
-	"code.gitea.io/gitea/modules/markup"
 	"code.gitea.io/gitea/modules/markup/markdown"
 	"code.gitea.io/gitea/modules/optional"
 	"code.gitea.io/gitea/modules/setting"
@@ -114,12 +114,8 @@ func getReleaseInfos(ctx *context.Context, opts *repo_model.FindReleasesOptions)
 			cacheUsers[r.PublisherID] = r.Publisher
 		}
 
-		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)
+		rctx := renderhelper.NewRenderContextRepoComment(ctx, r.Repo)
+		r.RenderedNote, err = markdown.RenderString(rctx, r.Note)
 		if err != nil {
 			return nil, err
 		}

routers/web/repo/render.go

@@ -9,6 +9,7 @@ import (
 	"net/http"
 	"path"
 
+	"code.gitea.io/gitea/models/renderhelper"
 	"code.gitea.io/gitea/modules/charset"
 	"code.gitea.io/gitea/modules/git"
 	"code.gitea.io/gitea/modules/log"
@@ -56,17 +57,12 @@ func RenderFile(ctx *context.Context) {
 		return
 	}
 
-	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),
-		}).
-		WithMetas(ctx.Repo.Repository.ComposeDocumentMetas(ctx)).
-		WithGitRepo(ctx.Repo.GitRepo).
-		WithInStandalonePage(true),
-		rd, ctx.Resp)
+	rctx := renderhelper.NewRenderContextRepoFile(ctx, ctx.Repo.Repository, renderhelper.RepoFileOptions{
+		CurrentRefPath:  ctx.Repo.BranchNameSubURL(),
+		CurrentTreePath: path.Dir(ctx.Repo.TreePath),
+	}).WithRelativePath(ctx.Repo.TreePath).WithInStandalonePage(true)
+
+	err = markup.Render(rctx, 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)

routers/web/repo/view.go

@@ -31,6 +31,7 @@ import (
 	git_model "code.gitea.io/gitea/models/git"
 	issue_model "code.gitea.io/gitea/models/issues"
 	access_model "code.gitea.io/gitea/models/perm/access"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	unit_model "code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
@@ -310,17 +311,14 @@ 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.NewRenderContext(ctx).
+		rctx := renderhelper.NewRenderContextRepoFile(ctx, ctx.Repo.Repository, renderhelper.RepoFileOptions{
+			CurrentRefPath:  ctx.Repo.BranchNameSubURL(),
+			CurrentTreePath: path.Join(ctx.Repo.TreePath, subfolder),
+		}).
 			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),
-			}).
-			WithMetas(ctx.Repo.Repository.ComposeDocumentMetas(ctx)).
-			WithGitRepo(ctx.Repo.GitRepo),
-			rd)
+			WithRelativePath(path.Join(ctx.Repo.TreePath, subfolder, readmeFile.Name())) // ctx.Repo.TreePath is the directory not the Readme so we must append the Readme filename (and path).
+
+		ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, rctx, 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")
@@ -513,17 +511,15 @@ 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.NewRenderContext(ctx).
+			rctx := renderhelper.NewRenderContextRepoFile(ctx, ctx.Repo.Repository, renderhelper.RepoFileOptions{
+				CurrentRefPath:  ctx.Repo.BranchNameSubURL(),
+				CurrentTreePath: path.Dir(ctx.Repo.TreePath),
+			}).
 				WithMarkupType(markupType).
 				WithRelativePath(ctx.Repo.TreePath).
-				WithLinks(markup.Links{
-					Base:       ctx.Repo.RepoLink,
-					BranchPath: ctx.Repo.BranchNameSubURL(),
-					TreePath:   path.Dir(ctx.Repo.TreePath),
-				}).
-				WithMetas(metas).
-				WithGitRepo(ctx.Repo.GitRepo),
-				rd)
+				WithMetas(metas)
+
+			ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, rctx, rd)
 			if err != nil {
 				ctx.ServerError("Render", err)
 				return
@@ -604,17 +600,15 @@ 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.NewRenderContext(ctx).
+
+			rctx := renderhelper.NewRenderContextRepoFile(ctx, ctx.Repo.Repository, renderhelper.RepoFileOptions{
+				CurrentRefPath:  ctx.Repo.BranchNameSubURL(),
+				CurrentTreePath: path.Dir(ctx.Repo.TreePath),
+			}).
 				WithMarkupType(markupType).
-				WithRelativePath(ctx.Repo.TreePath).
-				WithLinks(markup.Links{
-					Base:       ctx.Repo.RepoLink,
-					BranchPath: ctx.Repo.BranchNameSubURL(),
-					TreePath:   path.Dir(ctx.Repo.TreePath),
-				}).
-				WithMetas(ctx.Repo.Repository.ComposeDocumentMetas(ctx)).
-				WithGitRepo(ctx.Repo.GitRepo),
-				rd)
+				WithRelativePath(ctx.Repo.TreePath)
+
+			ctx.Data["EscapeStatus"], ctx.Data["FileContent"], err = markupRender(ctx, rctx, rd)
 			if err != nil {
 				ctx.ServerError("Render", err)
 				return

routers/web/repo/wiki.go

@@ -14,6 +14,7 @@ import (
 	"strings"
 
 	git_model "code.gitea.io/gitea/models/git"
+	"code.gitea.io/gitea/models/renderhelper"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unit"
 	"code.gitea.io/gitea/modules/base"
@@ -288,11 +289,9 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
 		footerContent = data
 	}
 
-	rctx := markup.NewRenderContext(ctx).
-		WithMetas(ctx.Repo.Repository.ComposeWikiMetas(ctx)).
-		WithLinks(markup.Links{Base: ctx.Repo.RepoLink})
-	buf := &strings.Builder{}
+	rctx := renderhelper.NewRenderContextRepoWiki(ctx, ctx.Repo.Repository)
 
+	buf := &strings.Builder{}
 	renderFn := func(data []byte) (escaped *charset.EscapeStatus, output string, err error) {
 		markupRd, markupWr := io.Pipe()
 		defer markupWr.Close()