123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257 |
- // Copyright 2017 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- package markup
-
- import (
- "bytes"
- "io"
- "net/url"
- "path"
- "path/filepath"
- "regexp"
- "strings"
- "sync"
-
- "code.gitea.io/gitea/modules/base"
- "code.gitea.io/gitea/modules/emoji"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/markup/common"
- "code.gitea.io/gitea/modules/references"
- "code.gitea.io/gitea/modules/regexplru"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/templates/vars"
- "code.gitea.io/gitea/modules/translation"
- "code.gitea.io/gitea/modules/util"
-
- "golang.org/x/net/html"
- "golang.org/x/net/html/atom"
- "mvdan.cc/xurls/v2"
- )
-
- // Issue name styles
- const (
- IssueNameStyleNumeric = "numeric"
- IssueNameStyleAlphanumeric = "alphanumeric"
- IssueNameStyleRegexp = "regexp"
- )
-
- var (
- // NOTE: All below regex matching do not perform any extra validation.
- // Thus a link is produced even if the linked entity does not exist.
- // While fast, this is also incorrect and lead to false positives.
- // TODO: fix invalid linking issue
-
- // valid chars in encoded path and parameter: [-+~_%.a-zA-Z0-9/]
-
- // sha1CurrentPattern matches string that represents a commit SHA, e.g. d8a994ef243349f321568f9e36d5c3f444b99cae
- // Although SHA1 hashes are 40 chars long, the regex matches the hash from 7 to 40 chars in length
- // so that abbreviated hash links can be used as well. This matches git and GitHub usability.
- sha1CurrentPattern = regexp.MustCompile(`(?:\s|^|\(|\[)([0-9a-f]{7,40})(?:\s|$|\)|\]|[.,](\s|$))`)
-
- // shortLinkPattern matches short but difficult to parse [[name|link|arg=test]] syntax
- shortLinkPattern = regexp.MustCompile(`\[\[(.*?)\]\](\w*)`)
-
- // anySHA1Pattern splits url containing SHA into parts
- anySHA1Pattern = regexp.MustCompile(`https?://(?:\S+/){4,5}([0-9a-f]{40})(/[-+~_%.a-zA-Z0-9/]+)?(#[-+~_%.a-zA-Z0-9]+)?`)
-
- // comparePattern matches "http://domain/org/repo/compare/COMMIT1...COMMIT2#hash"
- comparePattern = regexp.MustCompile(`https?://(?:\S+/){4,5}([0-9a-f]{7,40})(\.\.\.?)([0-9a-f]{7,40})?(#[-+~_%.a-zA-Z0-9]+)?`)
-
- validLinksPattern = regexp.MustCompile(`^[a-z][\w-]+://`)
-
- // While this email regex is definitely not perfect and I'm sure you can come up
- // with edge cases, it is still accepted by the CommonMark specification, as
- // well as the HTML5 spec:
- // http://spec.commonmark.org/0.28/#email-address
- // https://html.spec.whatwg.org/multipage/input.html#e-mail-state-(type%3Demail)
- emailRegex = regexp.MustCompile("(?:\\s|^|\\(|\\[)([a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9]{2,}(?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+)(?:\\s|$|\\)|\\]|;|,|\\?|!|\\.(\\s|$))")
-
- // blackfriday extensions create IDs like fn:user-content-footnote
- blackfridayExtRegex = regexp.MustCompile(`[^:]*:user-content-`)
-
- // EmojiShortCodeRegex find emoji by alias like :smile:
- EmojiShortCodeRegex = regexp.MustCompile(`:[-+\w]+:`)
- )
-
- // CSS class for action keywords (e.g. "closes: #1")
- const keywordClass = "issue-keyword"
-
- // IsLink reports whether link fits valid format.
- func IsLink(link []byte) bool {
- return validLinksPattern.Match(link)
- }
-
- func IsLinkStr(link string) bool {
- return validLinksPattern.MatchString(link)
- }
-
- // regexp for full links to issues/pulls
- var issueFullPattern *regexp.Regexp
-
- // Once for to prevent races
- var issueFullPatternOnce sync.Once
-
- // regexp for full links to hash comment in pull request files changed tab
- var filesChangedFullPattern *regexp.Regexp
-
- // Once for to prevent races
- var filesChangedFullPatternOnce sync.Once
-
- func getIssueFullPattern() *regexp.Regexp {
- issueFullPatternOnce.Do(func() {
- // example: https://domain/org/repo/pulls/27#hash
- issueFullPattern = regexp.MustCompile(regexp.QuoteMeta(setting.AppURL) +
- `[\w_.-]+/[\w_.-]+/(?:issues|pulls)/((?:\w{1,10}-)?[1-9][0-9]*)([\?|#](\S+)?)?\b`)
- })
- return issueFullPattern
- }
-
- func getFilesChangedFullPattern() *regexp.Regexp {
- filesChangedFullPatternOnce.Do(func() {
- // example: https://domain/org/repo/pulls/27/files#hash
- filesChangedFullPattern = regexp.MustCompile(regexp.QuoteMeta(setting.AppURL) +
- `[\w_.-]+/[\w_.-]+/pulls/((?:\w{1,10}-)?[1-9][0-9]*)/files([\?|#](\S+)?)?\b`)
- })
- return filesChangedFullPattern
- }
-
- // CustomLinkURLSchemes allows for additional schemes to be detected when parsing links within text
- func CustomLinkURLSchemes(schemes []string) {
- schemes = append(schemes, "http", "https")
- withAuth := make([]string, 0, len(schemes))
- validScheme := regexp.MustCompile(`^[a-z]+$`)
- for _, s := range schemes {
- if !validScheme.MatchString(s) {
- continue
- }
- without := false
- for _, sna := range xurls.SchemesNoAuthority {
- if s == sna {
- without = true
- break
- }
- }
- if without {
- s += ":"
- } else {
- s += "://"
- }
- withAuth = append(withAuth, s)
- }
- common.LinkRegex, _ = xurls.StrictMatchingScheme(strings.Join(withAuth, "|"))
- }
-
- // IsSameDomain checks if given url string has the same hostname as current Gitea instance
- func IsSameDomain(s string) bool {
- if strings.HasPrefix(s, "/") {
- return true
- }
- if uapp, err := url.Parse(setting.AppURL); err == nil {
- if u, err := url.Parse(s); err == nil {
- return u.Host == uapp.Host
- }
- return false
- }
- return false
- }
-
- type postProcessError struct {
- context string
- err error
- }
-
- func (p *postProcessError) Error() string {
- return "PostProcess: " + p.context + ", " + p.err.Error()
- }
-
- type processor func(ctx *RenderContext, node *html.Node)
-
- var defaultProcessors = []processor{
- fullIssuePatternProcessor,
- comparePatternProcessor,
- fullSha1PatternProcessor,
- shortLinkProcessor,
- linkProcessor,
- mentionProcessor,
- issueIndexPatternProcessor,
- commitCrossReferencePatternProcessor,
- sha1CurrentPatternProcessor,
- emailAddressProcessor,
- emojiProcessor,
- emojiShortCodeProcessor,
- }
-
- // PostProcess does the final required transformations to the passed raw HTML
- // data, and ensures its validity. Transformations include: replacing links and
- // emails with HTML links, parsing shortlinks in the format of [[Link]], like
- // MediaWiki, linking issues in the format #ID, and mentions in the format
- // @user, and others.
- func PostProcess(
- ctx *RenderContext,
- input io.Reader,
- output io.Writer,
- ) error {
- return postProcess(ctx, defaultProcessors, input, output)
- }
-
- var commitMessageProcessors = []processor{
- fullIssuePatternProcessor,
- comparePatternProcessor,
- fullSha1PatternProcessor,
- linkProcessor,
- mentionProcessor,
- issueIndexPatternProcessor,
- commitCrossReferencePatternProcessor,
- sha1CurrentPatternProcessor,
- emailAddressProcessor,
- emojiProcessor,
- emojiShortCodeProcessor,
- }
-
- // RenderCommitMessage will use the same logic as PostProcess, but will disable
- // the shortLinkProcessor and will add a defaultLinkProcessor if defaultLink is
- // set, which changes every text node into a link to the passed default link.
- func RenderCommitMessage(
- ctx *RenderContext,
- content string,
- ) (string, error) {
- procs := commitMessageProcessors
- if ctx.DefaultLink != "" {
- // we don't have to fear data races, because being
- // commitMessageProcessors of fixed len and cap, every time we append
- // something to it the slice is realloc+copied, so append always
- // generates the slice ex-novo.
- procs = append(procs, genDefaultLinkProcessor(ctx.DefaultLink))
- }
- return renderProcessString(ctx, procs, content)
- }
-
- var commitMessageSubjectProcessors = []processor{
- fullIssuePatternProcessor,
- comparePatternProcessor,
- fullSha1PatternProcessor,
- linkProcessor,
- mentionProcessor,
- issueIndexPatternProcessor,
- commitCrossReferencePatternProcessor,
- sha1CurrentPatternProcessor,
- emojiShortCodeProcessor,
- emojiProcessor,
- }
-
- var emojiProcessors = []processor{
- emojiShortCodeProcessor,
- emojiProcessor,
- }
-
- // RenderCommitMessageSubject will use the same logic as PostProcess and
- // RenderCommitMessage, but will disable the shortLinkProcessor and
- // emailAddressProcessor, will add a defaultLinkProcessor if defaultLink is set,
- // which changes every text node into a link to the passed default link.
- func RenderCommitMessageSubject(
- ctx *RenderContext,
- content string,
- ) (string, error) {
- procs := commitMessageSubjectProcessors
- if ctx.DefaultLink != "" {
- // we don't have to fear data races, because being
- // commitMessageSubjectProcessors of fixed len and cap, every time we
- // append something to it the slice is realloc+copied, so append always
- // generates the slice ex-novo.
- procs = append(procs, genDefaultLinkProcessor(ctx.DefaultLink))
- }
- return renderProcessString(ctx, procs, content)
- }
-
- // RenderIssueTitle to process title on individual issue/pull page
- func RenderIssueTitle(
- ctx *RenderContext,
- title string,
- ) (string, error) {
- return renderProcessString(ctx, []processor{
- issueIndexPatternProcessor,
- commitCrossReferencePatternProcessor,
- sha1CurrentPatternProcessor,
- emojiShortCodeProcessor,
- emojiProcessor,
- }, title)
- }
-
- func renderProcessString(ctx *RenderContext, procs []processor, content string) (string, error) {
- var buf strings.Builder
- if err := postProcess(ctx, procs, strings.NewReader(content), &buf); err != nil {
- return "", err
- }
- return buf.String(), nil
- }
-
- // RenderDescriptionHTML will use similar logic as PostProcess, but will
- // use a single special linkProcessor.
- func RenderDescriptionHTML(
- ctx *RenderContext,
- content string,
- ) (string, error) {
- return renderProcessString(ctx, []processor{
- descriptionLinkProcessor,
- emojiShortCodeProcessor,
- emojiProcessor,
- }, content)
- }
-
- // RenderEmoji for when we want to just process emoji and shortcodes
- // in various places it isn't already run through the normal markdown processor
- func RenderEmoji(
- ctx *RenderContext,
- content string,
- ) (string, error) {
- return renderProcessString(ctx, emojiProcessors, content)
- }
-
- var (
- tagCleaner = regexp.MustCompile(`<((?:/?\w+/\w+)|(?:/[\w ]+/)|(/?[hH][tT][mM][lL]\b)|(/?[hH][eE][aA][dD]\b))`)
- nulCleaner = strings.NewReplacer("\000", "")
- )
-
- func postProcess(ctx *RenderContext, procs []processor, input io.Reader, output io.Writer) error {
- defer ctx.Cancel()
- // FIXME: don't read all content to memory
- rawHTML, err := io.ReadAll(input)
- if err != nil {
- return err
- }
-
- // parse the HTML
- node, err := html.Parse(io.MultiReader(
- // prepend "<html><body>"
- strings.NewReader("<html><body>"),
- // Strip out nuls - they're always invalid
- bytes.NewReader(tagCleaner.ReplaceAll([]byte(nulCleaner.Replace(string(rawHTML))), []byte("<$1"))),
- // close the tags
- strings.NewReader("</body></html>"),
- ))
- if err != nil {
- return &postProcessError{"invalid HTML", err}
- }
-
- if node.Type == html.DocumentNode {
- node = node.FirstChild
- }
-
- visitNode(ctx, procs, node)
-
- newNodes := make([]*html.Node, 0, 5)
-
- if node.Data == "html" {
- node = node.FirstChild
- for node != nil && node.Data != "body" {
- node = node.NextSibling
- }
- }
- if node != nil {
- if node.Data == "body" {
- child := node.FirstChild
- for child != nil {
- newNodes = append(newNodes, child)
- child = child.NextSibling
- }
- } else {
- newNodes = append(newNodes, node)
- }
- }
-
- // Render everything to buf.
- for _, node := range newNodes {
- if err := html.Render(output, node); err != nil {
- return &postProcessError{"error rendering processed HTML", err}
- }
- }
- return nil
- }
-
- func visitNode(ctx *RenderContext, procs []processor, node *html.Node) {
- // Add user-content- to IDs and "#" links if they don't already have them
- for idx, attr := range node.Attr {
- val := strings.TrimPrefix(attr.Val, "#")
- notHasPrefix := !(strings.HasPrefix(val, "user-content-") || blackfridayExtRegex.MatchString(val))
-
- if attr.Key == "id" && notHasPrefix {
- node.Attr[idx].Val = "user-content-" + attr.Val
- }
-
- if attr.Key == "href" && strings.HasPrefix(attr.Val, "#") && notHasPrefix {
- node.Attr[idx].Val = "#user-content-" + val
- }
-
- if attr.Key == "class" && attr.Val == "emoji" {
- procs = nil
- }
- }
-
- // We ignore code and pre.
- switch node.Type {
- case html.TextNode:
- textNode(ctx, procs, node)
- case html.ElementNode:
- if node.Data == "img" {
- for i, attr := range node.Attr {
- if attr.Key != "src" {
- continue
- }
- if len(attr.Val) > 0 && !IsLinkStr(attr.Val) && !strings.HasPrefix(attr.Val, "data:image/") {
- attr.Val = util.URLJoin(ctx.Links.ResolveMediaLink(ctx.IsWiki), attr.Val)
- }
- attr.Val = camoHandleLink(attr.Val)
- node.Attr[i] = attr
- }
- } else if node.Data == "a" {
- // Restrict text in links to emojis
- procs = emojiProcessors
- } else if node.Data == "code" || node.Data == "pre" {
- return
- } else if node.Data == "i" {
- for _, attr := range node.Attr {
- if attr.Key != "class" {
- continue
- }
- classes := strings.Split(attr.Val, " ")
- for i, class := range classes {
- if class == "icon" {
- classes[0], classes[i] = classes[i], classes[0]
- attr.Val = strings.Join(classes, " ")
-
- // Remove all children of icons
- child := node.FirstChild
- for child != nil {
- node.RemoveChild(child)
- child = node.FirstChild
- }
- break
- }
- }
- }
- }
- for n := node.FirstChild; n != nil; n = n.NextSibling {
- visitNode(ctx, procs, n)
- }
- }
- // ignore everything else
- }
-
- // textNode runs the passed node through various processors, in order to handle
- // all kinds of special links handled by the post-processing.
- func textNode(ctx *RenderContext, procs []processor, node *html.Node) {
- for _, processor := range procs {
- processor(ctx, node)
- }
- }
-
- // createKeyword() renders a highlighted version of an action keyword
- func createKeyword(content string) *html.Node {
- span := &html.Node{
- Type: html.ElementNode,
- Data: atom.Span.String(),
- Attr: []html.Attribute{},
- }
- span.Attr = append(span.Attr, html.Attribute{Key: "class", Val: keywordClass})
-
- text := &html.Node{
- Type: html.TextNode,
- Data: content,
- }
- span.AppendChild(text)
-
- return span
- }
-
- func createEmoji(content, class, name string) *html.Node {
- span := &html.Node{
- Type: html.ElementNode,
- Data: atom.Span.String(),
- Attr: []html.Attribute{},
- }
- if class != "" {
- span.Attr = append(span.Attr, html.Attribute{Key: "class", Val: class})
- }
- if name != "" {
- span.Attr = append(span.Attr, html.Attribute{Key: "aria-label", Val: name})
- }
-
- text := &html.Node{
- Type: html.TextNode,
- Data: content,
- }
-
- span.AppendChild(text)
- return span
- }
-
- func createCustomEmoji(alias string) *html.Node {
- span := &html.Node{
- Type: html.ElementNode,
- Data: atom.Span.String(),
- Attr: []html.Attribute{},
- }
- span.Attr = append(span.Attr, html.Attribute{Key: "class", Val: "emoji"})
- span.Attr = append(span.Attr, html.Attribute{Key: "aria-label", Val: alias})
-
- img := &html.Node{
- Type: html.ElementNode,
- DataAtom: atom.Img,
- Data: "img",
- Attr: []html.Attribute{},
- }
- img.Attr = append(img.Attr, html.Attribute{Key: "alt", Val: ":" + alias + ":"})
- img.Attr = append(img.Attr, html.Attribute{Key: "src", Val: setting.StaticURLPrefix + "/assets/img/emoji/" + alias + ".png"})
-
- span.AppendChild(img)
- return span
- }
-
- func createLink(href, content, class string) *html.Node {
- a := &html.Node{
- Type: html.ElementNode,
- Data: atom.A.String(),
- Attr: []html.Attribute{{Key: "href", Val: href}},
- }
-
- if class != "" {
- a.Attr = append(a.Attr, html.Attribute{Key: "class", Val: class})
- }
-
- text := &html.Node{
- Type: html.TextNode,
- Data: content,
- }
-
- a.AppendChild(text)
- return a
- }
-
- func createCodeLink(href, content, class string) *html.Node {
- a := &html.Node{
- Type: html.ElementNode,
- Data: atom.A.String(),
- Attr: []html.Attribute{{Key: "href", Val: href}},
- }
-
- if class != "" {
- a.Attr = append(a.Attr, html.Attribute{Key: "class", Val: class})
- }
-
- text := &html.Node{
- Type: html.TextNode,
- Data: content,
- }
-
- code := &html.Node{
- Type: html.ElementNode,
- Data: atom.Code.String(),
- Attr: []html.Attribute{{Key: "class", Val: "nohighlight"}},
- }
-
- code.AppendChild(text)
- a.AppendChild(code)
- return a
- }
-
- // replaceContent takes text node, and in its content it replaces a section of
- // it with the specified newNode.
- func replaceContent(node *html.Node, i, j int, newNode *html.Node) {
- replaceContentList(node, i, j, []*html.Node{newNode})
- }
-
- // replaceContentList takes text node, and in its content it replaces a section of
- // it with the specified newNodes. An example to visualize how this can work can
- // be found here: https://play.golang.org/p/5zP8NnHZ03s
- func replaceContentList(node *html.Node, i, j int, newNodes []*html.Node) {
- // get the data before and after the match
- before := node.Data[:i]
- after := node.Data[j:]
-
- // Replace in the current node the text, so that it is only what it is
- // supposed to have.
- node.Data = before
-
- // Get the current next sibling, before which we place the replaced data,
- // and after that we place the new text node.
- nextSibling := node.NextSibling
- for _, n := range newNodes {
- node.Parent.InsertBefore(n, nextSibling)
- }
- if after != "" {
- node.Parent.InsertBefore(&html.Node{
- Type: html.TextNode,
- Data: after,
- }, nextSibling)
- }
- }
-
- func mentionProcessor(ctx *RenderContext, node *html.Node) {
- start := 0
- next := node.NextSibling
- for node != nil && node != next && start < len(node.Data) {
- // We replace only the first mention; other mentions will be addressed later
- found, loc := references.FindFirstMentionBytes([]byte(node.Data[start:]))
- if !found {
- return
- }
- loc.Start += start
- loc.End += start
- mention := node.Data[loc.Start:loc.End]
- var teams string
- teams, ok := ctx.Metas["teams"]
- // FIXME: util.URLJoin may not be necessary here:
- // - setting.AppURL is defined to have a terminal '/' so unless mention[1:]
- // is an AppSubURL link we can probably fallback to concatenation.
- // team mention should follow @orgName/teamName style
- if ok && strings.Contains(mention, "/") {
- mentionOrgAndTeam := strings.Split(mention, "/")
- if mentionOrgAndTeam[0][1:] == ctx.Metas["org"] && strings.Contains(teams, ","+strings.ToLower(mentionOrgAndTeam[1])+",") {
- replaceContent(node, loc.Start, loc.End, createLink(util.URLJoin(setting.AppURL, "org", ctx.Metas["org"], "teams", mentionOrgAndTeam[1]), mention, "mention"))
- node = node.NextSibling.NextSibling
- start = 0
- continue
- }
- start = loc.End
- continue
- }
- mentionedUsername := mention[1:]
-
- if DefaultProcessorHelper.IsUsernameMentionable != nil && DefaultProcessorHelper.IsUsernameMentionable(ctx.Ctx, mentionedUsername) {
- replaceContent(node, loc.Start, loc.End, createLink(util.URLJoin(setting.AppURL, mentionedUsername), mention, "mention"))
- node = node.NextSibling.NextSibling
- } else {
- node = node.NextSibling
- }
- start = 0
- }
- }
-
- func shortLinkProcessor(ctx *RenderContext, node *html.Node) {
- next := node.NextSibling
- for node != nil && node != next {
- m := shortLinkPattern.FindStringSubmatchIndex(node.Data)
- if m == nil {
- return
- }
-
- content := node.Data[m[2]:m[3]]
- tail := node.Data[m[4]:m[5]]
- props := make(map[string]string)
-
- // MediaWiki uses [[link|text]], while GitHub uses [[text|link]]
- // It makes page handling terrible, but we prefer GitHub syntax
- // And fall back to MediaWiki only when it is obvious from the look
- // Of text and link contents
- sl := strings.Split(content, "|")
- for _, v := range sl {
- if equalPos := strings.IndexByte(v, '='); equalPos == -1 {
- // There is no equal in this argument; this is a mandatory arg
- if props["name"] == "" {
- if IsLinkStr(v) {
- // If we clearly see it is a link, we save it so
-
- // But first we need to ensure, that if both mandatory args provided
- // look like links, we stick to GitHub syntax
- if props["link"] != "" {
- props["name"] = props["link"]
- }
-
- props["link"] = strings.TrimSpace(v)
- } else {
- props["name"] = v
- }
- } else {
- props["link"] = strings.TrimSpace(v)
- }
- } else {
- // There is an equal; optional argument.
-
- sep := strings.IndexByte(v, '=')
- key, val := v[:sep], html.UnescapeString(v[sep+1:])
-
- // When parsing HTML, x/net/html will change all quotes which are
- // not used for syntax into UTF-8 quotes. So checking val[0] won't
- // be enough, since that only checks a single byte.
- if len(val) > 1 {
- if (strings.HasPrefix(val, "“") && strings.HasSuffix(val, "”")) ||
- (strings.HasPrefix(val, "‘") && strings.HasSuffix(val, "’")) {
- const lenQuote = len("‘")
- val = val[lenQuote : len(val)-lenQuote]
- } else if (strings.HasPrefix(val, "\"") && strings.HasSuffix(val, "\"")) ||
- (strings.HasPrefix(val, "'") && strings.HasSuffix(val, "'")) {
- val = val[1 : len(val)-1]
- } else if strings.HasPrefix(val, "'") && strings.HasSuffix(val, "’") {
- const lenQuote = len("‘")
- val = val[1 : len(val)-lenQuote]
- }
- }
- props[key] = val
- }
- }
-
- var name, link string
- if props["link"] != "" {
- link = props["link"]
- } else if props["name"] != "" {
- link = props["name"]
- }
- if props["title"] != "" {
- name = props["title"]
- } else if props["name"] != "" {
- name = props["name"]
- } else {
- name = link
- }
-
- name += tail
- image := false
- switch ext := filepath.Ext(link); ext {
- // fast path: empty string, ignore
- case "":
- // leave image as false
- case ".jpg", ".jpeg", ".png", ".tif", ".tiff", ".webp", ".gif", ".bmp", ".ico", ".svg":
- image = true
- }
-
- childNode := &html.Node{}
- linkNode := &html.Node{
- FirstChild: childNode,
- LastChild: childNode,
- Type: html.ElementNode,
- Data: "a",
- DataAtom: atom.A,
- }
- childNode.Parent = linkNode
- absoluteLink := IsLinkStr(link)
- if !absoluteLink {
- if image {
- link = strings.ReplaceAll(link, " ", "+")
- } else {
- link = strings.ReplaceAll(link, " ", "-")
- }
- if !strings.Contains(link, "/") {
- link = url.PathEscape(link)
- }
- }
- if image {
- if !absoluteLink {
- link = util.URLJoin(ctx.Links.ResolveMediaLink(ctx.IsWiki), link)
- }
- title := props["title"]
- if title == "" {
- title = props["alt"]
- }
- if title == "" {
- title = path.Base(name)
- }
- alt := props["alt"]
- if alt == "" {
- alt = name
- }
-
- // make the childNode an image - if we can, we also place the alt
- childNode.Type = html.ElementNode
- childNode.Data = "img"
- childNode.DataAtom = atom.Img
- childNode.Attr = []html.Attribute{
- {Key: "src", Val: link},
- {Key: "title", Val: title},
- {Key: "alt", Val: alt},
- }
- if alt == "" {
- childNode.Attr = childNode.Attr[:2]
- }
- } else {
- if !absoluteLink {
- if ctx.IsWiki {
- link = util.URLJoin(ctx.Links.WikiLink(), link)
- } else {
- link = util.URLJoin(ctx.Links.SrcLink(), link)
- }
- }
- childNode.Type = html.TextNode
- childNode.Data = name
- }
- linkNode.Attr = []html.Attribute{{Key: "href", Val: link}}
- replaceContent(node, m[0], m[1], linkNode)
- node = node.NextSibling.NextSibling
- }
- }
-
- func fullIssuePatternProcessor(ctx *RenderContext, node *html.Node) {
- if ctx.Metas == nil {
- return
- }
- next := node.NextSibling
- for node != nil && node != next {
- m := getIssueFullPattern().FindStringSubmatchIndex(node.Data)
- if m == nil {
- return
- }
-
- mDiffView := getFilesChangedFullPattern().FindStringSubmatchIndex(node.Data)
- // leave it as it is if the link is from "Files Changed" tab in PR Diff View https://domain/org/repo/pulls/27/files
- if mDiffView != nil {
- return
- }
-
- link := node.Data[m[0]:m[1]]
- text := "#" + node.Data[m[2]:m[3]]
- // if m[4] and m[5] is not -1, then link is to a comment
- // indicate that in the text by appending (comment)
- if m[4] != -1 && m[5] != -1 {
- if locale, ok := ctx.Ctx.Value(translation.ContextKey).(translation.Locale); ok {
- text += " " + locale.Tr("repo.from_comment")
- } else {
- text += " (comment)"
- }
- }
-
- // extract repo and org name from matched link like
- // http://localhost:3000/gituser/myrepo/issues/1
- linkParts := strings.Split(link, "/")
- matchOrg := linkParts[len(linkParts)-4]
- matchRepo := linkParts[len(linkParts)-3]
-
- if matchOrg == ctx.Metas["user"] && matchRepo == ctx.Metas["repo"] {
- replaceContent(node, m[0], m[1], createLink(link, text, "ref-issue"))
- } else {
- text = matchOrg + "/" + matchRepo + text
- replaceContent(node, m[0], m[1], createLink(link, text, "ref-issue"))
- }
- node = node.NextSibling.NextSibling
- }
- }
-
- func issueIndexPatternProcessor(ctx *RenderContext, node *html.Node) {
- // FIXME: the use of "mode" is quite dirty and hacky, for example: what is a "document"? how should it be rendered?
- // The "mode" approach should be refactored to some other more clear&reliable way.
- if ctx.Metas == nil || (ctx.Metas["mode"] == "document" && !ctx.IsWiki) {
- return
- }
- var (
- found bool
- ref *references.RenderizableReference
- )
-
- next := node.NextSibling
-
- for node != nil && node != next {
- _, hasExtTrackFormat := ctx.Metas["format"]
-
- // Repos with external issue trackers might still need to reference local PRs
- // We need to concern with the first one that shows up in the text, whichever it is
- isNumericStyle := ctx.Metas["style"] == "" || ctx.Metas["style"] == IssueNameStyleNumeric
- foundNumeric, refNumeric := references.FindRenderizableReferenceNumeric(node.Data, hasExtTrackFormat && !isNumericStyle)
-
- switch ctx.Metas["style"] {
- case "", IssueNameStyleNumeric:
- found, ref = foundNumeric, refNumeric
- case IssueNameStyleAlphanumeric:
- found, ref = references.FindRenderizableReferenceAlphanumeric(node.Data)
- case IssueNameStyleRegexp:
- pattern, err := regexplru.GetCompiled(ctx.Metas["regexp"])
- if err != nil {
- return
- }
- found, ref = references.FindRenderizableReferenceRegexp(node.Data, pattern)
- }
-
- // Repos with external issue trackers might still need to reference local PRs
- // We need to concern with the first one that shows up in the text, whichever it is
- if hasExtTrackFormat && !isNumericStyle && refNumeric != nil {
- // If numeric (PR) was found, and it was BEFORE the non-numeric pattern, use that
- // Allow a free-pass when non-numeric pattern wasn't found.
- if found && (ref == nil || refNumeric.RefLocation.Start < ref.RefLocation.Start) {
- found = foundNumeric
- ref = refNumeric
- }
- }
- if !found {
- return
- }
-
- var link *html.Node
- reftext := node.Data[ref.RefLocation.Start:ref.RefLocation.End]
- if hasExtTrackFormat && !ref.IsPull {
- ctx.Metas["index"] = ref.Issue
-
- res, err := vars.Expand(ctx.Metas["format"], ctx.Metas)
- if err != nil {
- // here we could just log the error and continue the rendering
- log.Error("unable to expand template vars for ref %s, err: %v", ref.Issue, err)
- }
-
- link = createLink(res, reftext, "ref-issue ref-external-issue")
- } else {
- // Path determines the type of link that will be rendered. It's unknown at this point whether
- // the linked item is actually a PR or an issue. Luckily it's of no real consequence because
- // Gitea will redirect on click as appropriate.
- path := "issues"
- if ref.IsPull {
- path = "pulls"
- }
- if ref.Owner == "" {
- link = createLink(util.URLJoin(setting.AppURL, ctx.Metas["user"], ctx.Metas["repo"], path, ref.Issue), reftext, "ref-issue")
- } else {
- link = createLink(util.URLJoin(setting.AppURL, ref.Owner, ref.Name, path, ref.Issue), reftext, "ref-issue")
- }
- }
-
- if ref.Action == references.XRefActionNone {
- replaceContent(node, ref.RefLocation.Start, ref.RefLocation.End, link)
- node = node.NextSibling.NextSibling
- continue
- }
-
- // Decorate action keywords if actionable
- var keyword *html.Node
- if references.IsXrefActionable(ref, hasExtTrackFormat) {
- keyword = createKeyword(node.Data[ref.ActionLocation.Start:ref.ActionLocation.End])
- } else {
- keyword = &html.Node{
- Type: html.TextNode,
- Data: node.Data[ref.ActionLocation.Start:ref.ActionLocation.End],
- }
- }
- spaces := &html.Node{
- Type: html.TextNode,
- Data: node.Data[ref.ActionLocation.End:ref.RefLocation.Start],
- }
- replaceContentList(node, ref.ActionLocation.Start, ref.RefLocation.End, []*html.Node{keyword, spaces, link})
- node = node.NextSibling.NextSibling.NextSibling.NextSibling
- }
- }
-
- func commitCrossReferencePatternProcessor(ctx *RenderContext, node *html.Node) {
- next := node.NextSibling
-
- for node != nil && node != next {
- found, ref := references.FindRenderizableCommitCrossReference(node.Data)
- if !found {
- return
- }
-
- reftext := ref.Owner + "/" + ref.Name + "@" + base.ShortSha(ref.CommitSha)
- link := createLink(util.URLJoin(setting.AppSubURL, ref.Owner, ref.Name, "commit", ref.CommitSha), reftext, "commit")
-
- replaceContent(node, ref.RefLocation.Start, ref.RefLocation.End, link)
- node = node.NextSibling.NextSibling
- }
- }
-
- // fullSha1PatternProcessor renders SHA containing URLs
- func fullSha1PatternProcessor(ctx *RenderContext, node *html.Node) {
- if ctx.Metas == nil {
- return
- }
-
- next := node.NextSibling
- for node != nil && node != next {
- m := anySHA1Pattern.FindStringSubmatchIndex(node.Data)
- if m == nil {
- return
- }
-
- urlFull := node.Data[m[0]:m[1]]
- text := base.ShortSha(node.Data[m[2]:m[3]])
-
- // 3rd capture group matches a optional path
- subpath := ""
- if m[5] > 0 {
- subpath = node.Data[m[4]:m[5]]
- }
-
- // 4th capture group matches a optional url hash
- hash := ""
- if m[7] > 0 {
- hash = node.Data[m[6]:m[7]][1:]
- }
-
- start := m[0]
- end := m[1]
-
- // If url ends in '.', it's very likely that it is not part of the
- // actual url but used to finish a sentence.
- if strings.HasSuffix(urlFull, ".") {
- end--
- urlFull = urlFull[:len(urlFull)-1]
- if hash != "" {
- hash = hash[:len(hash)-1]
- } else if subpath != "" {
- subpath = subpath[:len(subpath)-1]
- }
- }
-
- if subpath != "" {
- text += subpath
- }
-
- if hash != "" {
- text += " (" + hash + ")"
- }
- replaceContent(node, start, end, createCodeLink(urlFull, text, "commit"))
- node = node.NextSibling.NextSibling
- }
- }
-
- func comparePatternProcessor(ctx *RenderContext, node *html.Node) {
- if ctx.Metas == nil {
- return
- }
-
- next := node.NextSibling
- for node != nil && node != next {
- m := comparePattern.FindStringSubmatchIndex(node.Data)
- if m == nil {
- return
- }
-
- // Ensure that every group (m[0]...m[7]) has a match
- for i := 0; i < 8; i++ {
- if m[i] == -1 {
- return
- }
- }
-
- urlFull := node.Data[m[0]:m[1]]
- text1 := base.ShortSha(node.Data[m[2]:m[3]])
- textDots := base.ShortSha(node.Data[m[4]:m[5]])
- text2 := base.ShortSha(node.Data[m[6]:m[7]])
-
- hash := ""
- if m[9] > 0 {
- hash = node.Data[m[8]:m[9]][1:]
- }
-
- start := m[0]
- end := m[1]
-
- // If url ends in '.', it's very likely that it is not part of the
- // actual url but used to finish a sentence.
- if strings.HasSuffix(urlFull, ".") {
- end--
- urlFull = urlFull[:len(urlFull)-1]
- if hash != "" {
- hash = hash[:len(hash)-1]
- } else if text2 != "" {
- text2 = text2[:len(text2)-1]
- }
- }
-
- text := text1 + textDots + text2
- if hash != "" {
- text += " (" + hash + ")"
- }
- replaceContent(node, start, end, createCodeLink(urlFull, text, "compare"))
- node = node.NextSibling.NextSibling
- }
- }
-
- // emojiShortCodeProcessor for rendering text like :smile: into emoji
- func emojiShortCodeProcessor(ctx *RenderContext, node *html.Node) {
- start := 0
- next := node.NextSibling
- for node != nil && node != next && start < len(node.Data) {
- m := EmojiShortCodeRegex.FindStringSubmatchIndex(node.Data[start:])
- if m == nil {
- return
- }
- m[0] += start
- m[1] += start
-
- start = m[1]
-
- alias := node.Data[m[0]:m[1]]
- alias = strings.ReplaceAll(alias, ":", "")
- converted := emoji.FromAlias(alias)
- if converted == nil {
- // check if this is a custom reaction
- if _, exist := setting.UI.CustomEmojisMap[alias]; exist {
- replaceContent(node, m[0], m[1], createCustomEmoji(alias))
- node = node.NextSibling.NextSibling
- start = 0
- continue
- }
- continue
- }
-
- replaceContent(node, m[0], m[1], createEmoji(converted.Emoji, "emoji", converted.Description))
- node = node.NextSibling.NextSibling
- start = 0
- }
- }
-
- // emoji processor to match emoji and add emoji class
- func emojiProcessor(ctx *RenderContext, node *html.Node) {
- start := 0
- next := node.NextSibling
- for node != nil && node != next && start < len(node.Data) {
- m := emoji.FindEmojiSubmatchIndex(node.Data[start:])
- if m == nil {
- return
- }
- m[0] += start
- m[1] += start
-
- codepoint := node.Data[m[0]:m[1]]
- start = m[1]
- val := emoji.FromCode(codepoint)
- if val != nil {
- replaceContent(node, m[0], m[1], createEmoji(codepoint, "emoji", val.Description))
- node = node.NextSibling.NextSibling
- start = 0
- }
- }
- }
-
- // sha1CurrentPatternProcessor renders SHA1 strings to corresponding links that
- // are assumed to be in the same repository.
- func sha1CurrentPatternProcessor(ctx *RenderContext, node *html.Node) {
- if ctx.Metas == nil || ctx.Metas["user"] == "" || ctx.Metas["repo"] == "" || ctx.Metas["repoPath"] == "" {
- return
- }
-
- start := 0
- next := node.NextSibling
- if ctx.ShaExistCache == nil {
- ctx.ShaExistCache = make(map[string]bool)
- }
- for node != nil && node != next && start < len(node.Data) {
- m := sha1CurrentPattern.FindStringSubmatchIndex(node.Data[start:])
- if m == nil {
- return
- }
- m[2] += start
- m[3] += start
-
- hash := node.Data[m[2]:m[3]]
- // The regex does not lie, it matches the hash pattern.
- // However, a regex cannot know if a hash actually exists or not.
- // We could assume that a SHA1 hash should probably contain alphas AND numerics
- // but that is not always the case.
- // Although unlikely, deadbeef and 1234567 are valid short forms of SHA1 hash
- // as used by git and github for linking and thus we have to do similar.
- // Because of this, we check to make sure that a matched hash is actually
- // a commit in the repository before making it a link.
-
- // check cache first
- exist, inCache := ctx.ShaExistCache[hash]
- if !inCache {
- if ctx.GitRepo == nil {
- var err error
- ctx.GitRepo, err = git.OpenRepository(ctx.Ctx, ctx.Metas["repoPath"])
- if err != nil {
- log.Error("unable to open repository: %s Error: %v", ctx.Metas["repoPath"], err)
- return
- }
- ctx.AddCancel(func() {
- ctx.GitRepo.Close()
- ctx.GitRepo = nil
- })
- }
-
- exist = ctx.GitRepo.IsObjectExist(hash)
- ctx.ShaExistCache[hash] = exist
- }
-
- if !exist {
- start = m[3]
- continue
- }
-
- link := util.URLJoin(setting.AppURL, ctx.Metas["user"], ctx.Metas["repo"], "commit", hash)
- replaceContent(node, m[2], m[3], createCodeLink(link, base.ShortSha(hash), "commit"))
- start = 0
- node = node.NextSibling.NextSibling
- }
- }
-
- // emailAddressProcessor replaces raw email addresses with a mailto: link.
- func emailAddressProcessor(ctx *RenderContext, node *html.Node) {
- next := node.NextSibling
- for node != nil && node != next {
- m := emailRegex.FindStringSubmatchIndex(node.Data)
- if m == nil {
- return
- }
-
- mail := node.Data[m[2]:m[3]]
- replaceContent(node, m[2], m[3], createLink("mailto:"+mail, mail, "mailto"))
- node = node.NextSibling.NextSibling
- }
- }
-
- // linkProcessor creates links for any HTTP or HTTPS URL not captured by
- // markdown.
- func linkProcessor(ctx *RenderContext, node *html.Node) {
- next := node.NextSibling
- for node != nil && node != next {
- m := common.LinkRegex.FindStringIndex(node.Data)
- if m == nil {
- return
- }
-
- uri := node.Data[m[0]:m[1]]
- replaceContent(node, m[0], m[1], createLink(uri, uri, "link"))
- node = node.NextSibling.NextSibling
- }
- }
-
- func genDefaultLinkProcessor(defaultLink string) processor {
- return func(ctx *RenderContext, node *html.Node) {
- ch := &html.Node{
- Parent: node,
- Type: html.TextNode,
- Data: node.Data,
- }
-
- node.Type = html.ElementNode
- node.Data = "a"
- node.DataAtom = atom.A
- node.Attr = []html.Attribute{
- {Key: "href", Val: defaultLink},
- {Key: "class", Val: "default-link muted"},
- }
- node.FirstChild, node.LastChild = ch, ch
- }
- }
-
- // descriptionLinkProcessor creates links for DescriptionHTML
- func descriptionLinkProcessor(ctx *RenderContext, node *html.Node) {
- next := node.NextSibling
- for node != nil && node != next {
- m := common.LinkRegex.FindStringIndex(node.Data)
- if m == nil {
- return
- }
-
- uri := node.Data[m[0]:m[1]]
- replaceContent(node, m[0], m[1], createDescriptionLink(uri, uri))
- node = node.NextSibling.NextSibling
- }
- }
-
- func createDescriptionLink(href, content string) *html.Node {
- textNode := &html.Node{
- Type: html.TextNode,
- Data: content,
- }
- linkNode := &html.Node{
- FirstChild: textNode,
- LastChild: textNode,
- Type: html.ElementNode,
- Data: "a",
- DataAtom: atom.A,
- Attr: []html.Attribute{
- {Key: "href", Val: href},
- {Key: "target", Val: "_blank"},
- {Key: "rel", Val: "noopener noreferrer"},
- },
- }
- textNode.Parent = linkNode
- return linkNode
- }
|