Skip to content

Commit 726ea72

Browse files
wxiaoguangwxiaoguang
committed
fix
1 parent 1ef2eb5 commit 726ea72

File tree

16 files changed

+342
-7
lines changed

16 files changed

+342
-7
lines changed

‎modules/indexer/code/search.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ func writeStrings(buf *bytes.Buffer, strs ...string) error {
7070
return nil
7171
}
7272

73-
func HighlightSearchResultCode(filename string, lineNums []int, code string) []ResultLine {
73+
func HighlightSearchResultCode(filename, language string, lineNums []int, code string) []ResultLine {
7474
// we should highlight the whole code block first, otherwise it doesn't work well with multiple line highlighting
75-
hl, _ := highlight.Code(filename, "", code)
75+
hl, _ := highlight.Code(filename, language, code)
7676
highlightedLines := strings.Split(string(hl), "\n")
7777

7878
// The lineNums outputted by highlight.Code might not match the original lineNums, because "highlight" removes the last `\n`
@@ -122,7 +122,7 @@ func searchResult(result *internal.SearchResult, startIndex, endIndex int) (*Res
122122
UpdatedUnix: result.UpdatedUnix,
123123
Language: result.Language,
124124
Color: result.Color,
125-
Lines: HighlightSearchResultCode(result.Filename, lineNums, formattedLinesBuffer.String()),
125+
Lines: HighlightSearchResultCode(result.Filename, result.Language, lineNums, formattedLinesBuffer.String()),
126126
}, nil
127127
}
128128

‎modules/markup/html.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ type processor func(ctx *RenderContext, node *html.Node)
171171
var defaultProcessors = []processor{
172172
fullIssuePatternProcessor,
173173
comparePatternProcessor,
174+
codePreviewPatternProcessor,
174175
fullHashPatternProcessor,
175176
shortLinkProcessor,
176177
linkProcessor,

‎modules/markup/html_codepreview.go‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// Copyright 2024 The Gitea Authors. All rights reserved.
2+
// SPDX-License-Identifier: MIT
3+
4+
package markup
5+
6+
import (
7+
"html/template"
8+
"net/url"
9+
"regexp"
10+
"strconv"
11+
"strings"
12+
13+
"code.gitea.io/gitea/modules/httplib"
14+
15+
"golang.org/x/net/html"
16+
)
17+
18+
// codePreviewPattern matches "http://domain/.../{owner}/{repo}/src/commit/{commit}/{filepath}#L10-L20"
19+
var codePreviewPattern = regexp.MustCompile(`https?://\S+/([^\s/]+)/([^\s/]+)/src/commit/([0-9a-f]{7,64})(/\S+)#(L\d+(-L\d+)?)`)
20+
21+
type RenderCodePreviewOptions struct {
22+
FullURL string
23+
OwnerName string
24+
RepoName string
25+
CommitID string
26+
FilePath string
27+
28+
LineStart, LineStop int
29+
}
30+
31+
func renderCodeBlock(ctx *RenderContext, node *html.Node) (urlPosStart, urlPosStop int, htm template.HTML, err error) {
32+
m := codePreviewPattern.FindStringSubmatchIndex(node.Data)
33+
if m == nil {
34+
return 0, 0, "", nil
35+
}
36+
37+
opts := RenderCodePreviewOptions{
38+
FullURL: node.Data[m[0]:m[1]],
39+
OwnerName: node.Data[m[2]:m[3]],
40+
RepoName: node.Data[m[4]:m[5]],
41+
CommitID: node.Data[m[6]:m[7]],
42+
FilePath: node.Data[m[8]:m[9]],
43+
}
44+
if !httplib.IsCurrentGiteaSiteURL(opts.FullURL) {
45+
return 0, 0, "", nil
46+
}
47+
u, err := url.Parse(opts.FilePath)
48+
if err != nil {
49+
return 0, 0, "", err
50+
}
51+
opts.FilePath = strings.TrimPrefix(u.Path, "/")
52+
53+
lineStartStr, lineStopStr, _ := strings.Cut(node.Data[m[10]:m[11]], "-")
54+
lineStart, _ := strconv.Atoi(strings.TrimPrefix(lineStartStr, "L"))
55+
lineStop, _ := strconv.Atoi(strings.TrimPrefix(lineStopStr, "L"))
56+
opts.LineStart, opts.LineStop = lineStart, lineStop
57+
h, err := DefaultProcessorHelper.RenderRepoFileCodePreview(ctx.Ctx, opts)
58+
return m[0], m[1], h, err
59+
}
60+
61+
func codePreviewPatternProcessor(ctx *RenderContext, node *html.Node) {
62+
for node != nil {
63+
urlPosStart, urlPosEnd, h, err := renderCodeBlock(ctx, node)
64+
if err != nil || h == "" {
65+
node = node.NextSibling
66+
continue
67+
}
68+
next := node.NextSibling
69+
nodeText := node.Data
70+
node.Data = nodeText[:urlPosStart]
71+
node.Parent.InsertBefore(&html.Node{Type: html.RawNode, Data: string(h)}, next)
72+
node.Parent.InsertBefore(&html.Node{Type: html.TextNode, Data: nodeText[urlPosEnd:]}, next)
73+
node = next
74+
}
75+
}

‎modules/markup/html_codepreview_test.go‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Copyright 2024 The Gitea Authors. All rights reserved.
2+
// SPDX-License-Identifier: MIT
3+
4+
package markup_test
5+
6+
import (
7+
"context"
8+
"html/template"
9+
"strings"
10+
"testing"
11+
12+
"code.gitea.io/gitea/modules/git"
13+
"code.gitea.io/gitea/modules/markup"
14+
15+
"github.com/stretchr/testify/assert"
16+
)
17+
18+
func TestRenderCodePreview(t *testing.T) {
19+
markup.Init(&markup.ProcessorHelper{
20+
RenderRepoFileCodePreview: func(ctx context.Context, opts markup.RenderCodePreviewOptions) (template.HTML, error) {
21+
return "<div>code preview</div>", nil
22+
},
23+
})
24+
test := func(input, expected string) {
25+
buffer, err := markup.RenderString(&markup.RenderContext{
26+
Ctx: git.DefaultContext,
27+
Type: "markdown",
28+
}, input)
29+
assert.NoError(t, err)
30+
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
31+
}
32+
test("http://localhost:3000/owner/repo/src/commit/0123456789/foo/bar.md#L10-L20", "<p><div>code preview</div></p>")
33+
test("http://other/owner/repo/src/commit/0123456789/foo/bar.md#L10-L20", `<p><a href="http://other/owner/repo/src/commit/0123456789/foo/bar.md#L10-L20" rel="nofollow">http://other/owner/repo/src/commit/0123456789/foo/bar.md#L10-L20</a></p>`)
34+
}

‎modules/markup/renderer.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import (
88
"context"
99
"errors"
1010
"fmt"
11+
"html/template"
1112
"io"
1213
"net/url"
1314
"path/filepath"
@@ -33,6 +34,8 @@ type ProcessorHelper struct {
3334
IsUsernameMentionable func(ctx context.Context, username string) bool
3435

3536
ElementDir string // the direction of the elements, eg: "ltr", "rtl", "auto", default to no direction attribute
37+
38+
RenderRepoFileCodePreview func(ctx context.Context, options RenderCodePreviewOptions) (template.HTML, error)
3639
}
3740

3841
var DefaultProcessorHelper ProcessorHelper

‎modules/markup/sanitizer.go‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,13 @@ func createDefaultPolicy() *bluemonday.Policy {
5858
policy := bluemonday.UGCPolicy()
5959

6060
// For JS code copy and Mermaid loading state
61-
policy.AllowAttrs("class").Matching(regexp.MustCompile(`^code-block( is-loading)?$`)).OnElements("pre")
61+
policy.AllowAttrs("class").Matching(regexp.MustCompile(`^code-block( is-loading)?$`)).Globally()
62+
63+
// For code preview
64+
policy.AllowAttrs("class").Matching(regexp.MustCompile(`^code-preview-[-\w]+$`)).Globally()
65+
policy.AllowAttrs("class").Matching(regexp.MustCompile(`^lines-num$`)).Globally()
66+
policy.AllowAttrs("class").Matching(regexp.MustCompile(`^lines-code chroma$`)).Globally()
67+
policy.AllowAttrs("data-line-number").OnElements("span")
6268

6369
// For color preview
6470
policy.AllowAttrs("class").Matching(regexp.MustCompile(`^color-preview$`)).OnElements("span")

‎routers/web/repo/search.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func Search(ctx *context.Context) {
8181
// UpdatedUnix: not supported yet
8282
// Language: not supported yet
8383
// Color: not supported yet
84-
Lines: code_indexer.HighlightSearchResultCode(r.Filename, r.LineNumbers, strings.Join(r.LineCodes, "\n")),
84+
Lines: code_indexer.HighlightSearchResultCode(r.Filename, "", r.LineNumbers, strings.Join(r.LineCodes, "\n")),
8585
})
8686
}
8787
}

‎services/contexttest/context_tests.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ func MockContext(t *testing.T, reqPath string, opts ...MockContextOption) (*cont
6363
base.Locale = &translation.MockLocale{}
6464

6565
ctx := context.NewWebContext(base, opt.Render, nil)
66+
ctx.AppendContextValue(context.WebContextKey, ctx)
6667
ctx.PageData = map[string]any{}
6768
ctx.Data["PageStartTime"] = time.Now()
6869
chiCtx := chi.NewRouteContext()

‎services/markup/main_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ import (
1111

1212
func TestMain(m *testing.M) {
1313
unittest.MainTest(m, &unittest.TestOptions{
14-
FixtureFiles: []string{"user.yml"},
14+
FixtureFiles: []string{"user.yml", "repository.yml", "access.yml", "repo_unit.yml"},
1515
})
1616
}

‎services/markup/processorhelper.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import (
1414
func ProcessorHelper() *markup.ProcessorHelper {
1515
return &markup.ProcessorHelper{
1616
ElementDir: "auto", // set dir="auto" for necessary (eg: <p>, <h?>, etc) tags
17+
18+
RenderRepoFileCodePreview: renderRepoFileCodePreview,
1719
IsUsernameMentionable: func(ctx context.Context, username string) bool {
1820
mentionedUser, err := user.GetUserByName(ctx, username)
1921
if err != nil {

0 commit comments

Comments
 (0)