1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132 |
- // Copyright 2017 The Gitea Authors. All rights reserved.
- // Use of this source code is governed by a MIT-style
- // license that can be found in the LICENSE file.
-
- 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/setting"
- "code.gitea.io/gitea/modules/util"
-
- "github.com/unknwon/com"
- "golang.org/x/net/html"
- "golang.org/x/net/html/atom"
- "mvdan.cc/xurls/v2"
- )
-
- // Issue name styles
- const (
- IssueNameStyleNumeric = "numeric"
- IssueNameStyleAlphanumeric = "alphanumeric"
- )
-
- 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
-
- // 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 useability.
- 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 allows to split url containing SHA into parts
- anySHA1Pattern = regexp.MustCompile(`https?://(?:\S+/){4}([0-9a-f]{40})(/[^#\s]+)?(#\S+)?`)
-
- 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 isLink(link)
- }
-
- // 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
-
- func getIssueFullPattern() *regexp.Regexp {
- issueFullPatternOnce.Do(func() {
- issueFullPattern = regexp.MustCompile(regexp.QuoteMeta(setting.AppURL) +
- `\w+/\w+/(?:issues|pulls)/((?:\w{1,10}-)?[1-9][0-9]*)([\?|#](\S+)?)?\b`)
- })
- return issueFullPattern
- }
-
- // 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,
- fullSha1PatternProcessor,
- shortLinkProcessor,
- linkProcessor,
- mentionProcessor,
- issueIndexPatternProcessor,
- 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,
- fullSha1PatternProcessor,
- linkProcessor,
- mentionProcessor,
- issueIndexPatternProcessor,
- 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) {
- var 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,
- fullSha1PatternProcessor,
- linkProcessor,
- mentionProcessor,
- issueIndexPatternProcessor,
- 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) {
- var 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,
- 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(
- content string,
- ) (string, error) {
- return renderProcessString(&RenderContext{}, emojiProcessors, content)
- }
-
- var tagCleaner = regexp.MustCompile(`<((?:/?\w+/\w+)|(?:/[\w ]+/)|(/?[hH][tT][mM][lL]\b)|(/?[hH][eE][aA][dD]\b))`)
- var 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
- }
-
- res := bytes.NewBuffer(make([]byte, 0, len(rawHTML)+50))
- // prepend "<html><body>"
- _, _ = res.WriteString("<html><body>")
-
- // Strip out nuls - they're always invalid
- _, _ = res.Write(tagCleaner.ReplaceAll([]byte(nulCleaner.Replace(string(rawHTML))), []byte("<$1")))
-
- // close the tags
- _, _ = res.WriteString("</body></html>")
-
- // parse the HTML
- node, err := html.Parse(res)
- if err != nil {
- return &postProcessError{"invalid HTML", err}
- }
-
- if node.Type == html.DocumentNode {
- node = node.FirstChild
- }
-
- visitNode(ctx, procs, node, true)
-
- 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 {
- err = html.Render(output, node)
- if err != nil {
- return &postProcessError{"error rendering processed HTML", err}
- }
- }
- return nil
- }
-
- func visitNode(ctx *RenderContext, procs []processor, node *html.Node, visitText bool) {
- // Add user-content- to IDs if they don't already have them
- for idx, attr := range node.Attr {
- if attr.Key == "id" && !(strings.HasPrefix(attr.Val, "user-content-") || blackfridayExtRegex.MatchString(attr.Val)) {
- node.Attr[idx].Val = "user-content-" + attr.Val
- }
-
- if attr.Key == "class" && attr.Val == "emoji" {
- visitText = false
- }
- }
-
- // We ignore code, pre and already generated links.
- switch node.Type {
- case html.TextNode:
- if visitText {
- 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/") {
- prefix := ctx.URLPrefix
- if ctx.IsWiki {
- prefix = util.URLJoin(prefix, "wiki", "raw")
- }
- prefix = strings.Replace(prefix, "/src/", "/media/", 1)
-
- attr.Val = util.URLJoin(prefix, attr.Val)
- }
- node.Attr[i] = attr
- }
- } else if node.Data == "a" {
- visitText = false
- } 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, visitText)
- }
- }
- // 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
- }
- replaceContent(node, loc.Start, loc.End, createLink(util.URLJoin(setting.AppURL, mention[1:]), mention, "mention"))
- node = node.NextSibling.NextSibling
- start = 0
- }
- }
-
- func shortLinkProcessor(ctx *RenderContext, node *html.Node) {
- shortLinkProcessorFull(ctx, node, false)
- }
-
- func shortLinkProcessorFull(ctx *RenderContext, node *html.Node, noLink bool) {
- 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)
- }
- }
- urlPrefix := ctx.URLPrefix
- if image {
- if !absoluteLink {
- if IsSameDomain(urlPrefix) {
- urlPrefix = strings.Replace(urlPrefix, "/src/", "/raw/", 1)
- }
- if ctx.IsWiki {
- link = util.URLJoin("wiki", "raw", link)
- }
- link = util.URLJoin(urlPrefix, 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("wiki", link)
- }
- link = util.URLJoin(urlPrefix, link)
- }
- childNode.Type = html.TextNode
- childNode.Data = name
- }
- if noLink {
- linkNode = childNode
- } else {
- 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
- }
- link := node.Data[m[0]:m[1]]
- id := "#" + node.Data[m[2]:m[3]]
-
- // 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"] {
- // TODO if m[4]:m[5] is not nil, then link is to a comment,
- // and we should indicate that in the text somehow
- replaceContent(node, m[0], m[1], createLink(link, id, "ref-issue"))
- } else {
- orgRepoID := matchOrg + "/" + matchRepo + id
- replaceContent(node, m[0], m[1], createLink(link, orgRepoID, "ref-issue"))
- }
- node = node.NextSibling.NextSibling
- }
- }
-
- func issueIndexPatternProcessor(ctx *RenderContext, node *html.Node) {
- if ctx.Metas == nil {
- return
- }
- var (
- found bool
- ref *references.RenderizableReference
- )
-
- next := node.NextSibling
- for node != nil && node != next {
- _, exttrack := ctx.Metas["format"]
- alphanum := ctx.Metas["style"] == IssueNameStyleAlphanumeric
-
- // 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
- found, ref = references.FindRenderizableReferenceNumeric(node.Data, exttrack && alphanum)
- if exttrack && alphanum {
- if found2, ref2 := references.FindRenderizableReferenceAlphanumeric(node.Data); found2 {
- if !found || ref2.RefLocation.Start < ref.RefLocation.Start {
- found = true
- ref = ref2
- }
- }
- }
- if !found {
- return
- }
-
- var link *html.Node
- reftext := node.Data[ref.RefLocation.Start:ref.RefLocation.End]
- if exttrack && !ref.IsPull {
- ctx.Metas["index"] = ref.Issue
- link = createLink(com.Expand(ctx.Metas["format"], ctx.Metas), 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, exttrack, alphanum) {
- 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
- }
- }
-
- // 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
- }
- }
-
- // 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.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
- }
-
- replaceContent(node, m[2], m[3],
- createCodeLink(util.URLJoin(setting.AppURL, ctx.Metas["user"], ctx.Metas["repo"], "commit", hash), 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"},
- }
- 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
- }
|