// Copyright 2024 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT package markup import ( "context" "fmt" "io" "net/url" "strings" "time" "code.gitea.io/gitea/modules/markup/internal" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/util" "github.com/yuin/goldmark/ast" "golang.org/x/sync/errgroup" ) type RenderMetaMode string const ( RenderMetaAsDetails RenderMetaMode = "details" // default RenderMetaAsNone RenderMetaMode = "none" RenderMetaAsTable RenderMetaMode = "table" ) var RenderBehaviorForTesting struct { // Gitea will emit some additional attributes for various purposes, these attributes don't affect rendering. // But there are too many hard-coded test cases, to avoid changing all of them again and again, we can disable emitting these internal attributes. DisableAdditionalAttributes bool } type RenderOptions struct { UseAbsoluteLink bool // 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 // user&repo, format&style®exp (for external issue pattern), teams&org (for mention) // BranchNameSubURL (for iframe&asciicast) // markupAllowShortIssuePattern // markdownLineBreakStyle (comment, document) Metas map[string]string // used by external render. the router "/org/repo/render/..." will output the rendered content in a standalone page InStandalonePage bool } // 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, RenderHelper: &SimpleRenderHelper{}} } 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) 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) WithUseAbsoluteLink(v bool) *RenderContext { ctx.RenderOptions.UseAbsoluteLink = v return ctx } func (ctx *RenderContext) WithHelper(helper RenderHelper) *RenderContext { ctx.RenderHelper = helper return ctx } // Render renders markup file to HTML with all specific handling stuff. func Render(ctx *RenderContext, input io.Reader, output io.Writer) error { 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.RenderOptions.MarkupType] if renderer == nil { return util.NewInvalidArgumentErrorf("unsupported markup type: %q", ctx.RenderOptions.MarkupType) } if ctx.RenderOptions.RelativePath != "" { if externalRender, ok := renderer.(ExternalRenderer); ok && externalRender.DisplayInIFrame() { 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.RenderOptions.Metas["user"]), url.PathEscape(ctx.RenderOptions.Metas["repo"]), ctx.RenderOptions.Metas["BranchNameSubURL"], url.PathEscape(ctx.RenderOptions.RelativePath), )) return err } func pipes() (io.ReadCloser, io.WriteCloser, func()) { pr, pw := io.Pipe() return pr, pw, func() { _ = pr.Close() _ = pw.Close() } } func render(ctx *RenderContext, renderer Renderer, input io.Reader, output io.Writer) error { if ctx.RenderHelper != nil { defer ctx.RenderHelper.CleanUp() } finalProcessor := ctx.RenderInternal.Init(output) defer finalProcessor.Close() // input -> (pw1=pr1) -> renderer -> (pw2=pr2) -> SanitizeReader -> finalProcessor -> output // no sanitizer: input -> (pw1=pr1) -> renderer -> pw2(finalProcessor) -> output pr1, pw1, close1 := pipes() defer close1() eg, _ := errgroup.WithContext(ctx) var pw2 io.WriteCloser = util.NopCloser{Writer: finalProcessor} if r, ok := renderer.(ExternalRenderer); !ok || !r.SanitizerDisabled() { var pr2 io.ReadCloser var close2 func() pr2, pw2, close2 = pipes() defer close2() eg.Go(func() error { defer pr2.Close() return SanitizeReader(pr2, renderer.Name(), finalProcessor) }) } eg.Go(func() (err error) { if r, ok := renderer.(PostProcessRenderer); ok && r.NeedPostProcess() { err = PostProcessDefault(ctx, pr1, pw2) } else { _, err = io.Copy(pw2, pr1) } _, _ = pr1.Close(), pw2.Close() return err }) if err := renderer.Render(ctx, input, pw1); err != nil { return err } _ = pw1.Close() return eg.Wait() } // Init initializes the render global variables func Init(renderHelpFuncs *RenderHelperFuncs) { DefaultRenderHelperFuncs = renderHelpFuncs if len(setting.Markdown.CustomURLSchemes) > 0 { CustomLinkURLSchemes(setting.Markdown.CustomURLSchemes) } // since setting maybe changed extensions, this will reload all renderer extensions mapping extRenderers = make(map[string]Renderer) for _, renderer := range renderers { for _, ext := range renderer.Extensions() { extRenderers[strings.ToLower(ext)] = renderer } } } func ComposeSimpleDocumentMetas() map[string]string { return map[string]string{"markdownLineBreakStyle": "document"} } type TestRenderHelper struct { ctx *RenderContext BaseLink string } func (r *TestRenderHelper) CleanUp() {} func (r *TestRenderHelper) IsCommitIDExisting(commitID string) bool { return strings.HasPrefix(commitID, "65f1bf2") //|| strings.HasPrefix(commitID, "88fc37a") } func (r *TestRenderHelper) ResolveLink(link string, likeType LinkType) string { return r.ctx.ResolveLinkRelative(r.BaseLink, "", link) } var _ RenderHelper = (*TestRenderHelper)(nil) // NewTestRenderContext is a helper function to create a RenderContext for testing purpose // It accepts string (BaseLink), map[string]string (Metas) func NewTestRenderContext(baseLinkOrMetas ...any) *RenderContext { if !setting.IsInTesting { panic("NewTestRenderContext should only be used in testing") } helper := &TestRenderHelper{} ctx := NewRenderContext(context.Background()).WithHelper(helper) helper.ctx = ctx for _, v := range baseLinkOrMetas { switch v := v.(type) { case string: helper.BaseLink = v case map[string]string: ctx = ctx.WithMetas(v) default: panic(fmt.Sprintf("unknown type %T", v)) } } return ctx }