From 2ae45cebbf2ec839bf2280765f958eb60d1f6374 Mon Sep 17 00:00:00 2001 From: Roger Luo Date: Thu, 9 Jun 2022 19:15:08 +0800 Subject: [PATCH] Feature: Find files in repo (#15028) * Create finding files page ui in repo page * Get tree entries for find repo files. * Move find files JS to individual file. * gen swagger. * Add enry.IsVendor to exclude entries Co-authored-by: delvh Co-authored-by: wxiaoguang Co-authored-by: Lunny Xiao --- models/repo/fork.go | 1 + models/repo/main_test.go | 4 +- options/locale/locale_en-US.ini | 3 ++ routers/web/repo/find.go | 24 ++++++++++ routers/web/repo/treelist.go | 55 +++++++++++++++++++++++ routers/web/web.go | 6 +++ templates/repo/find/files.tmpl | 21 +++++++++ templates/repo/home.tmpl | 5 +++ web_src/js/features/repo-findfile.js | 67 ++++++++++++++++++++++++++++ web_src/js/index.js | 2 + web_src/js/svg.js | 2 + web_src/js/utils.js | 32 +++++++++++++ web_src/js/utils.test.js | 16 ++++++- 13 files changed, 235 insertions(+), 3 deletions(-) create mode 100644 routers/web/repo/find.go create mode 100644 routers/web/repo/treelist.go create mode 100644 templates/repo/find/files.tmpl create mode 100644 web_src/js/features/repo-findfile.js diff --git a/models/repo/fork.go b/models/repo/fork.go index 938bbae17e..b54c61c425 100644 --- a/models/repo/fork.go +++ b/models/repo/fork.go @@ -9,6 +9,7 @@ import ( "code.gitea.io/gitea/models/db" user_model "code.gitea.io/gitea/models/user" + "xorm.io/builder" ) diff --git a/models/repo/main_test.go b/models/repo/main_test.go index eb04aa8227..f6d704ca65 100644 --- a/models/repo/main_test.go +++ b/models/repo/main_test.go @@ -8,12 +8,12 @@ import ( "path/filepath" "testing" + "code.gitea.io/gitea/models/unittest" + _ "code.gitea.io/gitea/models" // register table model _ "code.gitea.io/gitea/models/perm/access" // register table model _ "code.gitea.io/gitea/models/repo" // register table model _ "code.gitea.io/gitea/models/user" // register table model - - "code.gitea.io/gitea/models/unittest" ) func TestMain(m *testing.M) { diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index 1cf35741ba..b9ba6e1136 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -2286,6 +2286,9 @@ topic.done = Done topic.count_prompt = You can not select more than 25 topics topic.format_prompt = Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long. +find_file.go_to_file = Go to file +find_file.no_matching = No matching file found + error.csv.too_large = Can't render this file because it is too large. error.csv.unexpected = Can't render this file because it contains an unexpected character in line %d and column %d. error.csv.invalid_field_count = Can't render this file because it has a wrong number of fields in line %d. diff --git a/routers/web/repo/find.go b/routers/web/repo/find.go new file mode 100644 index 0000000000..7117c00076 --- /dev/null +++ b/routers/web/repo/find.go @@ -0,0 +1,24 @@ +// Copyright 2022 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 repo + +import ( + "net/http" + + "code.gitea.io/gitea/modules/base" + "code.gitea.io/gitea/modules/context" +) + +const ( + tplFindFiles base.TplName = "repo/find/files" +) + +// FindFiles render the page to find repository files +func FindFiles(ctx *context.Context) { + path := ctx.Params("*") + ctx.Data["TreeLink"] = ctx.Repo.RepoLink + "/src/" + path + ctx.Data["DataLink"] = ctx.Repo.RepoLink + "/tree-list/" + path + ctx.HTML(http.StatusOK, tplFindFiles) +} diff --git a/routers/web/repo/treelist.go b/routers/web/repo/treelist.go new file mode 100644 index 0000000000..35ac0d507f --- /dev/null +++ b/routers/web/repo/treelist.go @@ -0,0 +1,55 @@ +// Copyright 2022 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 repo + +import ( + "net/http" + + "code.gitea.io/gitea/modules/base" + "code.gitea.io/gitea/modules/context" + "code.gitea.io/gitea/modules/git" + + "github.com/go-enry/go-enry/v2" +) + +// TreeList get all files' entries of a repository +func TreeList(ctx *context.Context) { + tree, err := ctx.Repo.Commit.SubTree("/") + if err != nil { + ctx.ServerError("Repo.Commit.SubTree", err) + return + } + + entries, err := tree.ListEntriesRecursive() + if err != nil { + ctx.ServerError("ListEntriesRecursive", err) + return + } + entries.CustomSort(base.NaturalSortLess) + + files := make([]string, 0, len(entries)) + for _, entry := range entries { + if !isExcludedEntry(entry) { + files = append(files, entry.Name()) + } + } + ctx.JSON(http.StatusOK, files) +} + +func isExcludedEntry(entry *git.TreeEntry) bool { + if entry.IsDir() { + return true + } + + if entry.IsSubModule() { + return true + } + + if enry.IsVendor(entry.Name()) { + return true + } + + return false +} diff --git a/routers/web/web.go b/routers/web/web.go index 3e837c62d0..bf4c4662af 100644 --- a/routers/web/web.go +++ b/routers/web/web.go @@ -831,6 +831,12 @@ func RegisterRoutes(m *web.Route) { m.Group("/milestone", func() { m.Get("/{id}", repo.MilestoneIssuesAndPulls) }, reqRepoIssuesOrPullsReader, context.RepoRef()) + m.Get("/find/*", repo.FindFiles) + m.Group("/tree-list", func() { + m.Get("/branch/*", context.RepoRefByType(context.RepoRefBranch), repo.TreeList) + m.Get("/tag/*", context.RepoRefByType(context.RepoRefTag), repo.TreeList) + m.Get("/commit/*", context.RepoRefByType(context.RepoRefCommit), repo.TreeList) + }) m.Get("/compare", repo.MustBeNotEmpty, reqRepoCodeReader, repo.SetEditorconfigIfExists, ignSignIn, repo.SetDiffViewStyle, repo.SetWhitespaceBehavior, repo.CompareDiff) m.Combo("/compare/*", repo.MustBeNotEmpty, reqRepoCodeReader, repo.SetEditorconfigIfExists). Get(ignSignIn, repo.SetDiffViewStyle, repo.SetWhitespaceBehavior, repo.CompareDiff). diff --git a/templates/repo/find/files.tmpl b/templates/repo/find/files.tmpl new file mode 100644 index 0000000000..3b102f9883 --- /dev/null +++ b/templates/repo/find/files.tmpl @@ -0,0 +1,21 @@ +{{template "base/head" .}} +
+ {{template "repo/header" .}} +
+
+ {{.RepoName}} + / +
+ +
+
+ + + +
+ +
+
+{{template "base/footer" .}} diff --git a/templates/repo/home.tmpl b/templates/repo/home.tmpl index c3d4d4cb22..73c6702a90 100644 --- a/templates/repo/home.tmpl +++ b/templates/repo/home.tmpl @@ -73,6 +73,11 @@ {{end}} +
+ + {{.i18n.Tr "repo.find_file.go_to_file"}} + +
{{else}}
{{EllipsisString .Repository.Name 30}}{{range $i, $v := .TreeNames}}/{{if eq $i $l}}{{EllipsisString $v 30}}{{else}}{{ $p := index $.Paths $i}}{{EllipsisString $v 30}}{{end}}{{end}}
{{end}} diff --git a/web_src/js/features/repo-findfile.js b/web_src/js/features/repo-findfile.js new file mode 100644 index 0000000000..700a7fe693 --- /dev/null +++ b/web_src/js/features/repo-findfile.js @@ -0,0 +1,67 @@ +import $ from 'jquery'; + +import {svg} from '../svg.js'; +import {strSubMatch} from '../utils.js'; +const {csrf} = window.config; + +const threshold = 50; +let files = []; +let $repoFindFileInput, $repoFindFileTableBody, $repoFindFileNoResult; + +function filterRepoFiles(filter) { + const treeLink = $repoFindFileInput.attr('data-url-tree-link'); + $repoFindFileTableBody.empty(); + + const fileRes = []; + if (filter) { + for (let i = 0; i < files.length && fileRes.length < threshold; i++) { + const subMatch = strSubMatch(files[i], filter); + if (subMatch.length > 1) { + fileRes.push(subMatch); + } + } + } else { + for (let i = 0; i < files.length && i < threshold; i++) { + fileRes.push([files[i]]); + } + } + + const tmplRow = ``; + + $repoFindFileNoResult.toggle(fileRes.length === 0); + for (const matchRes of fileRes) { + const $row = $(tmplRow); + const $a = $row.find('a'); + $a.attr('href', `${treeLink}/${matchRes.join('')}`); + const $octiconFile = $(svg('octicon-file')).addClass('mr-3'); + $a.append($octiconFile); + // if the target file path is "abc/xyz", to search "bx", then the matchRes is ['a', 'b', 'c/', 'x', 'yz'] + // the matchRes[odd] is matched and highlighted to red. + for (let j = 0; j < matchRes.length; j++) { + if (!matchRes[j]) continue; + const $span = $('').text(matchRes[j]); + if (j % 2 === 1) $span.addClass('ui text red'); + $a.append($span); + } + $repoFindFileTableBody.append($row); + } +} + +async function loadRepoFiles() { + files = await $.ajax({ + url: $repoFindFileInput.attr('data-url-data-link'), + headers: {'X-Csrf-Token': csrf} + }); + filterRepoFiles($repoFindFileInput.val()); +} + +export function initFindFileInRepo() { + $repoFindFileInput = $('#repo-file-find-input'); + if (!$repoFindFileInput.length) return; + + $repoFindFileTableBody = $('#repo-find-file-table tbody'); + $repoFindFileNoResult = $('#repo-find-file-no-result'); + $repoFindFileInput.on('input', () => filterRepoFiles($repoFindFileInput.val())); + + loadRepoFiles(); +} diff --git a/web_src/js/index.js b/web_src/js/index.js index 4343c2d965..b6a1aee779 100644 --- a/web_src/js/index.js +++ b/web_src/js/index.js @@ -21,6 +21,7 @@ import {initMarkupAnchors} from './markup/anchors.js'; import {initNotificationCount, initNotificationsTable} from './features/notification.js'; import {initRepoIssueContentHistory} from './features/repo-issue-content.js'; import {initStopwatch} from './features/stopwatch.js'; +import {initFindFileInRepo} from './features/repo-findfile.js'; import {initCommentContent, initMarkupContent} from './markup/content.js'; import {initUserAuthLinkAccountView, initUserAuthOauth2} from './features/user-auth.js'; @@ -124,6 +125,7 @@ $(document).ready(() => { initSshKeyFormParser(); initStopwatch(); initTableSort(); + initFindFileInRepo(); initAdminCommon(); initAdminEmails(); diff --git a/web_src/js/svg.js b/web_src/js/svg.js index 77aa1e7ca7..926f0a5d05 100644 --- a/web_src/js/svg.js +++ b/web_src/js/svg.js @@ -15,6 +15,7 @@ import octiconRepo from '../../public/img/svg/octicon-repo.svg'; import octiconRepoForked from '../../public/img/svg/octicon-repo-forked.svg'; import octiconRepoTemplate from '../../public/img/svg/octicon-repo-template.svg'; import octiconTriangleDown from '../../public/img/svg/octicon-triangle-down.svg'; +import octiconFile from '../../public/img/svg/octicon-file.svg'; import Vue from 'vue'; @@ -36,6 +37,7 @@ export const svgs = { 'octicon-repo-forked': octiconRepoForked, 'octicon-repo-template': octiconRepoTemplate, 'octicon-triangle-down': octiconTriangleDown, + 'octicon-file': octiconFile, }; const parser = new DOMParser(); diff --git a/web_src/js/utils.js b/web_src/js/utils.js index 86a64b8b75..67f8f1cc98 100644 --- a/web_src/js/utils.js +++ b/web_src/js/utils.js @@ -58,3 +58,35 @@ export function parseIssueHref(href) { const [_, owner, repo, type, index] = /([^/]+)\/([^/]+)\/(issues|pulls)\/([0-9]+)/.exec(path) || []; return {owner, repo, type, index}; } + +// return the sub-match result as an array: [unmatched, matched, unmatched, matched, ...] +// res[even] is unmatched, res[odd] is matched, see unit tests for examples +export function strSubMatch(full, sub) { + const res = ['']; + let i = 0, j = 0; + for (; i < sub.length && j < full.length;) { + while (j < full.length) { + if (sub[i] === full[j]) { + if (res.length % 2 !== 0) res.push(''); + res[res.length - 1] += full[j]; + j++; + i++; + } else { + if (res.length % 2 === 0) res.push(''); + res[res.length - 1] += full[j]; + j++; + break; + } + } + } + if (i !== sub.length) { + // if the sub string doesn't match the full, only return the full as unmatched. + return [full]; + } + if (j < full.length) { + // append remaining chars from full to result as unmatched + if (res.length % 2 === 0) res.push(''); + res[res.length - 1] += full.substring(j); + } + return res; +} diff --git a/web_src/js/utils.test.js b/web_src/js/utils.test.js index 3f6f921079..acf3f1ece3 100644 --- a/web_src/js/utils.test.js +++ b/web_src/js/utils.test.js @@ -1,5 +1,5 @@ import { - basename, extname, isObject, uniq, stripTags, joinPaths, parseIssueHref, + basename, extname, isObject, uniq, stripTags, joinPaths, parseIssueHref, strSubMatch, } from './utils.js'; test('basename', () => { @@ -84,3 +84,17 @@ test('parseIssueHref', () => { expect(parseIssueHref('https://example.com/sub/sub2/owner/repo/issues/1#hash')).toEqual({owner: 'owner', repo: 'repo', type: 'issues', index: '1'}); expect(parseIssueHref('')).toEqual({owner: undefined, repo: undefined, type: undefined, index: undefined}); }); + + +test('strSubMatch', () => { + expect(strSubMatch('abc', '')).toEqual(['abc']); + expect(strSubMatch('abc', 'a')).toEqual(['', 'a', 'bc']); + expect(strSubMatch('abc', 'b')).toEqual(['a', 'b', 'c']); + expect(strSubMatch('abc', 'c')).toEqual(['ab', 'c']); + expect(strSubMatch('abc', 'ac')).toEqual(['', 'a', 'b', 'c']); + expect(strSubMatch('abc', 'z')).toEqual(['abc']); + expect(strSubMatch('abc', 'az')).toEqual(['abc']); + + expect(strSubMatch('aabbcc', 'abc')).toEqual(['', 'a', 'a', 'b', 'b', 'c', 'c']); + expect(strSubMatch('the/directory', 'hedir')).toEqual(['t', 'he', '/', 'dir', 'ectory']); +});