mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-23 14:53:34 +01:00
9057100182
Extend API MarkupOptions to contain branch path. The `api.MarkupOptions{}` to have `BranchPath` which contains the current branch. The `RenderMarkup` function utilizes a struct since there are too many variables passed as arguments and that is not a good sign for readability. And `repo-editor.js` will contain a new form data which is `branch-path` which will then be utilized by `edit.tmpl` as `data-branch-path`. Closes: #4510 ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [x] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [ ] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/5781 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Nirmal Kumar R <tildezero@gmail.com> Co-committed-by: Nirmal Kumar R <tildezero@gmail.com>
104 lines
2.6 KiB
Go
104 lines
2.6 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package common
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/markup"
|
|
"code.gitea.io/gitea/modules/markup/markdown"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/util"
|
|
"code.gitea.io/gitea/services/context"
|
|
|
|
"mvdan.cc/xurls/v2"
|
|
)
|
|
|
|
type Renderer struct {
|
|
Mode, Text, URLPrefix, FilePath, BranchPath string
|
|
IsWiki bool
|
|
}
|
|
|
|
// RenderMarkup renders markup text for the /markup and /markdown endpoints
|
|
func (re *Renderer) RenderMarkup(ctx *context.Base, repo *context.Repository) {
|
|
var markupType string
|
|
relativePath := ""
|
|
|
|
if len(re.Text) == 0 {
|
|
_, _ = ctx.Write([]byte(""))
|
|
return
|
|
}
|
|
|
|
switch re.Mode {
|
|
case "markdown":
|
|
// Raw markdown
|
|
if err := markdown.RenderRaw(&markup.RenderContext{
|
|
Ctx: ctx,
|
|
Links: markup.Links{
|
|
AbsolutePrefix: true,
|
|
Base: re.URLPrefix,
|
|
},
|
|
}, strings.NewReader(re.Text), ctx.Resp); err != nil {
|
|
ctx.Error(http.StatusInternalServerError, err.Error())
|
|
}
|
|
return
|
|
case "comment":
|
|
// Comment as markdown
|
|
markupType = markdown.MarkupName
|
|
case "gfm":
|
|
// Github Flavored Markdown as document
|
|
markupType = markdown.MarkupName
|
|
case "file":
|
|
// File as document based on file extension
|
|
markupType = ""
|
|
relativePath = re.FilePath
|
|
default:
|
|
ctx.Error(http.StatusUnprocessableEntity, fmt.Sprintf("Unknown mode: %s", re.Mode))
|
|
return
|
|
}
|
|
|
|
if !strings.HasPrefix(setting.AppSubURL+"/", re.URLPrefix) {
|
|
// check if urlPrefix is already set to a URL
|
|
linkRegex, _ := xurls.StrictMatchingScheme("https?://")
|
|
m := linkRegex.FindStringIndex(re.URLPrefix)
|
|
if m == nil {
|
|
re.URLPrefix = util.URLJoin(setting.AppURL, re.URLPrefix)
|
|
}
|
|
}
|
|
|
|
meta := map[string]string{}
|
|
if repo != nil && repo.Repository != nil {
|
|
if re.Mode == "comment" {
|
|
meta = repo.Repository.ComposeMetas(ctx)
|
|
} else {
|
|
meta = repo.Repository.ComposeDocumentMetas(ctx)
|
|
}
|
|
}
|
|
if re.Mode != "comment" {
|
|
meta["mode"] = "document"
|
|
}
|
|
|
|
if err := markup.Render(&markup.RenderContext{
|
|
Ctx: ctx,
|
|
Links: markup.Links{
|
|
AbsolutePrefix: true,
|
|
Base: re.URLPrefix,
|
|
BranchPath: re.BranchPath,
|
|
},
|
|
Metas: meta,
|
|
IsWiki: re.IsWiki,
|
|
Type: markupType,
|
|
RelativePath: relativePath,
|
|
}, strings.NewReader(re.Text), ctx.Resp); err != nil {
|
|
if markup.IsErrUnsupportedRenderExtension(err) {
|
|
ctx.Error(http.StatusUnprocessableEntity, err.Error())
|
|
} else {
|
|
ctx.Error(http.StatusInternalServerError, err.Error())
|
|
}
|
|
return
|
|
}
|
|
}
|