Merge 91ffb2d720 into dafadf0028

routers/web/repo/blame.go

@@ -46,6 +46,11 @@ func RefBlame(ctx *context.Context) {
 		return
 	}
 
+	// ctx.Data["RepoPreferences"] = ctx.Session.Get("repoPreferences")
+	ctx.Data["RepoPreferences"] = &preferencesForm{
+		ShowFileViewTreeSidebar: true,
+	}
+
 	branchLink := ctx.Repo.RepoLink + "/src/" + ctx.Repo.BranchNameSubURL()
 	treeLink := branchLink
 	rawLink := ctx.Repo.RepoLink + "/raw/" + ctx.Repo.BranchNameSubURL()

routers/web/repo/file.go

@@ -0,0 +1,45 @@
+// Copyright 2014 The Gogs Authors. All rights reserved.
+// Copyright 2018 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package repo
+
+import (
+	"net/http"
+
+	"code.gitea.io/gitea/models/unit"
+	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/services/context"
+	files_service "code.gitea.io/gitea/services/repository/files"
+)
+
+// canReadFiles returns true if repository is readable and user has proper access level.
+func canReadFiles(r *context.Repository) bool {
+	return r.Permission.CanRead(unit.TypeCode)
+}
+
+// GetContents Get the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
+func GetContents(ctx *context.Context) {
+	if !canReadFiles(ctx.Repo) {
+		ctx.NotFound("Invalid FilePath", nil)
+		return
+	}
+
+	treePath := ctx.PathParam("*")
+	ref := ctx.FormTrim("ref")
+
+	if fileList, err := files_service.GetContentsOrList(ctx, ctx.Repo.Repository, treePath, ref); err != nil {
+		if git.IsErrNotExist(err) {
+			ctx.NotFound("GetContentsOrList", err)
+			return
+		}
+		ctx.ServerError("Repo.GitRepo.GetCommit", err)
+	} else {
+		ctx.JSON(http.StatusOK, fileList)
+	}
+}
+
+// GetContentsList Get the metadata of all the entries of the root dir
+func GetContentsList(ctx *context.Context) {
+	GetContents(ctx)
+}

routers/web/repo/repo.go

@@ -20,6 +20,7 @@ import (
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/cache"
 	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/json"
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/optional"
 	repo_module "code.gitea.io/gitea/modules/repository"
@@ -757,3 +758,20 @@ func PrepareBranchList(ctx *context.Context) {
 	}
 	ctx.Data["Branches"] = brs
 }
+
+type preferencesForm struct {
+	ShowFileViewTreeSidebar bool `json:"show_file_view_tree_sidebar"`
+}
+
+func UpdatePreferences(ctx *context.Context) {
+	form := &preferencesForm{}
+	if err := json.NewDecoder(ctx.Req.Body).Decode(&form); err != nil {
+		ctx.ServerError("DecodePreferencesForm", err)
+		return
+	}
+	// if err := ctx.Session.Set("repoPreferences", form); err != nil {
+	// 	ctx.ServerError("Session.Set", err)
+	// 	return
+	// }
+	ctx.JSONOK()
+}

routers/web/repo/tree.go

@@ -8,7 +8,9 @@ import (
 
 	"code.gitea.io/gitea/modules/base"
 	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/gitrepo"
 	"code.gitea.io/gitea/services/context"
+	files_service "code.gitea.io/gitea/services/repository/files"
 
 	"github.com/go-enry/go-enry/v2"
 )
@@ -52,3 +54,29 @@ func isExcludedEntry(entry *git.TreeEntry) bool {
 
 	return false
 }
+
+func Tree(ctx *context.Context) {
+	dir := ctx.PathParam("*")
+	ref := ctx.FormTrim("ref")
+	recursive := ctx.FormBool("recursive")
+
+	gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, ctx.Repo.Repository)
+	if err != nil {
+		ctx.ServerError("RepositoryFromContextOrOpen", err)
+		return
+	}
+	defer closer.Close()
+
+	refName := gitRepo.UnstableGuessRefByShortName(ref)
+	var results []*files_service.TreeEntry
+	if !recursive {
+		results, err = files_service.GetTreeList(ctx, ctx.Repo.Repository, dir, refName, false)
+	} else {
+		results, err = files_service.GetTreeInformation(ctx, ctx.Repo.Repository, dir, refName)
+	}
+	if err != nil {
+		ctx.ServerError("GetTreeInformation", err)
+		return
+	}
+	ctx.JSON(http.StatusOK, results)
+}

routers/web/repo/view_home.go

@@ -305,6 +305,11 @@ func Home(ctx *context.Context) {
 		return
 	}
 
+	// ctx.Data["RepoPreferences"] = ctx.Session.Get("repoPreferences")
+	ctx.Data["RepoPreferences"] = &preferencesForm{
+		ShowFileViewTreeSidebar: true,
+	}
+
 	title := ctx.Repo.Repository.Owner.Name + "/" + ctx.Repo.Repository.Name
 	if len(ctx.Repo.Repository.Description) > 0 {
 		title += ": " + ctx.Repo.Repository.Description

routers/web/web.go

@@ -986,6 +986,7 @@ func registerRoutes(m *web.Router) {
 		m.Get("/migrate", repo.Migrate)
 		m.Post("/migrate", web.Bind(forms.MigrateRepoForm{}), repo.MigratePost)
 		m.Get("/search", repo.SearchRepo)
+		m.Put("/preferences", repo.UpdatePreferences)
 	}, reqSignIn)
 	// end "/repo": create, migrate, search
 
@@ -1156,11 +1157,15 @@ func registerRoutes(m *web.Router) {
 
 	m.Group("/{username}/{reponame}", func() {
 		m.Get("/find/*", repo.FindFiles)
-		m.Group("/tree-list", func() {
+		m.Group("/tree-list", func() { // for find files
 			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.Group("/tree", func() {
+			m.Get("", repo.Tree)
+			m.Get("/*", repo.Tree)
+		})
 		m.Get("/compare", repo.MustBeNotEmpty, repo.SetEditorconfigIfExists, repo.SetDiffViewStyle, repo.SetWhitespaceBehavior, repo.CompareDiff)
 		m.Combo("/compare/*", repo.MustBeNotEmpty, repo.SetEditorconfigIfExists).
 			Get(repo.SetDiffViewStyle, repo.SetWhitespaceBehavior, repo.CompareDiff).

services/repository/files/tree.go

@@ -7,9 +7,13 @@ import (
 	"context"
 	"fmt"
 	"net/url"
+	"path"
+	"sort"
+	"strings"
 
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/gitrepo"
 	"code.gitea.io/gitea/modules/setting"
 	api "code.gitea.io/gitea/modules/structs"
 	"code.gitea.io/gitea/modules/util"
@@ -118,3 +122,370 @@ func GetTreeBySHA(ctx context.Context, repo *repo_model.Repository, gitRepo *git
 	}
 	return tree, nil
 }
+
+type TreeEntry struct {
+	Name     string       `json:"name"`
+	IsFile   bool         `json:"isFile"`
+	Path     string       `json:"path"`
+	Children []*TreeEntry `json:"children, omitempty"`
+}
+
+/*
+Example 1: (path: /)
+
+	GET /repo/name/tree/
+
+	resp:
+	[{
+	    "name": "d1",
+	    "isFile": false,
+	    "path": "d1"
+	},{
+	    "name": "d2",
+	    "isFile": false,
+	    "path": "d2"
+	},{
+	    "name": "d3",
+	    "isFile": false,
+	    "path": "d3"
+	},{
+	    "name": "f1",
+	    "isFile": true,
+	    "path": "f1"
+	},]
+
+Example 2: (path: d3)
+
+	GET /repo/name/tree/d3
+	resp:
+	[{
+	    "name": "d3d1",
+	    "isFile": false,
+	    "path": "d3/d3d1"
+	}]
+
+Example 3: (path: d3/d3d1)
+
+	GET /repo/name/tree/d3/d3d1
+	resp:
+	[{
+	    "name": "d3d1f1",
+	    "isFile": true,
+	    "path": "d3/d3d1/d3d1f1"
+	},{
+	    "name": "d3d1f1",
+	    "isFile": true,
+	    "path": "d3/d3d1/d3d1f2"
+	}]
+*/
+func GetTreeList(ctx context.Context, repo *repo_model.Repository, treePath string, ref git.RefName, recursive bool) ([]*TreeEntry, error) {
+	if repo.IsEmpty {
+		return nil, nil
+	}
+	if ref == "" {
+		ref = git.RefNameFromBranch(repo.DefaultBranch)
+	}
+
+	// Check that the path given in opts.treePath is valid (not a git path)
+	cleanTreePath := CleanUploadFileName(treePath)
+	if cleanTreePath == "" && treePath != "" {
+		return nil, ErrFilenameInvalid{
+			Path: treePath,
+		}
+	}
+	treePath = cleanTreePath
+
+	gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo)
+	if err != nil {
+		return nil, err
+	}
+	defer closer.Close()
+
+	// Get the commit object for the ref
+	commit, err := gitRepo.GetCommit(ref.String())
+	if err != nil {
+		return nil, err
+	}
+
+	entry, err := commit.GetTreeEntryByPath(treePath)
+	if err != nil {
+		return nil, err
+	}
+
+	// If the entry is a file, we return a FileContentResponse object
+	if entry.Type() != "tree" {
+		return nil, fmt.Errorf("%s is not a tree", treePath)
+	}
+
+	gitTree, err := commit.SubTree(treePath)
+	if err != nil {
+		return nil, err
+	}
+	var entries git.Entries
+	if recursive {
+		entries, err = gitTree.ListEntriesRecursiveFast()
+	} else {
+		entries, err = gitTree.ListEntries()
+	}
+	if err != nil {
+		return nil, err
+	}
+
+	var treeList []*TreeEntry
+	mapTree := make(map[string][]*TreeEntry)
+	for _, e := range entries {
+		subTreePath := path.Join(treePath, e.Name())
+
+		if strings.Contains(e.Name(), "/") {
+			mapTree[path.Dir(e.Name())] = append(mapTree[path.Dir(e.Name())], &TreeEntry{
+				Name:   path.Base(e.Name()),
+				IsFile: e.Mode() != git.EntryModeTree,
+				Path:   subTreePath,
+			})
+		} else {
+			treeList = append(treeList, &TreeEntry{
+				Name:   e.Name(),
+				IsFile: e.Mode() != git.EntryModeTree,
+				Path:   subTreePath,
+			})
+		}
+	}
+
+	for _, tree := range treeList {
+		if !tree.IsFile {
+			tree.Children = mapTree[tree.Path]
+			sortTreeEntries(tree.Children)
+		}
+	}
+
+	sortTreeEntries(treeList)
+
+	return treeList, nil
+}
+
+// GetTreeInformation returns the first level directories and files and all the trees of the path to treePath.
+// If treePath is a directory, list all subdirectories and files of treePath.
+/*
+Example 1: (path: /)
+    GET /repo/name/tree/?recursive=true
+    resp:
+    [{
+        "name": "d1",
+        "isFile": false,
+        "path": "d1"
+    },{
+        "name": "d2",
+        "isFile": false,
+        "path": "d2"
+    },{
+        "name": "d3",
+        "isFile": false,
+        "path": "d3"
+    },{
+        "name": "f1",
+        "isFile": true,
+        "path": "f1"
+    },]
+
+Example 2: (path: d3)
+    GET /repo/name/tree/d3?recursive=true
+    resp:
+    [{
+        "name": "d1",
+        "isFile": false,
+        "path": "d1"
+    },{
+        "name": "d2",
+        "isFile": false,
+        "path": "d2"
+    },{
+        "name": "d3",
+        "isFile": false,
+        "path": "d3",
+        "children": [{
+            "name": "d3d1",
+            "isFile": false,
+            "path": "d3/d3d1"
+        }]
+    },{
+        "name": "f1",
+        "isFile": true,
+        "path": "f1"
+    },]
+
+Example 3: (path: d3/d3d1)
+    GET /repo/name/tree/d3/d3d1?recursive=true
+    resp:
+    [{
+        "name": "d1",
+        "isFile": false,
+        "path": "d1"
+    },{
+        "name": "d2",
+        "isFile": false,
+        "path": "d2"
+    },{
+        "name": "d3",
+        "isFile": false,
+        "path": "d3",
+        "children": [{
+            "name": "d3d1",
+            "isFile": false,
+            "path": "d3/d3d1",
+            "children": [{
+                "name": "d3d1f1",
+                "isFile": true,
+                "path": "d3/d3d1/d3d1f1"
+            },{
+                "name": "d3d1f1",
+                "isFile": true,
+                "path": "d3/d3d1/d3d1f2"
+            }]
+        }]
+    },{
+        "name": "f1",
+        "isFile": true,
+        "path": "f1"
+    },]
+
+Example 4: (path: d2/d2f1)
+    GET /repo/name/tree/d2/d2f1?recursive=true
+    resp:
+    [{
+        "name": "d1",
+        "isFile": false,
+        "path": "d1"
+    },{
+        "name": "d2",
+        "isFile": false,
+        "path": "d2",
+        "children": [{
+            "name": "d2f1",
+            "isFile": true,
+            "path": "d2/d2f1"
+        }]
+    },{
+        "name": "d3",
+        "isFile": false,
+        "path": "d3"
+    },{
+        "name": "f1",
+        "isFile": true,
+        "path": "f1"
+    },]
+*/
+func GetTreeInformation(ctx context.Context, repo *repo_model.Repository, treePath string, ref git.RefName) ([]*TreeEntry, error) {
+	if repo.IsEmpty {
+		return nil, nil
+	}
+	if ref == "" {
+		ref = git.RefNameFromBranch(repo.DefaultBranch)
+	}
+
+	// Check that the path given in opts.treePath is valid (not a git path)
+	cleanTreePath := CleanUploadFileName(treePath)
+	if cleanTreePath == "" && treePath != "" {
+		return nil, ErrFilenameInvalid{
+			Path: treePath,
+		}
+	}
+	treePath = cleanTreePath
+
+	gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo)
+	if err != nil {
+		return nil, err
+	}
+	defer closer.Close()
+
+	// Get the commit object for the ref
+	commit, err := gitRepo.GetCommit(ref.String())
+	if err != nil {
+		return nil, err
+	}
+
+	// get root entries
+	rootEntry, err := commit.GetTreeEntryByPath("")
+	if err != nil {
+		return nil, err
+	}
+	rootEntries, err := rootEntry.Tree().ListEntries()
+	if err != nil {
+		return nil, err
+	}
+
+	var treeList []*TreeEntry
+	var parentEntry *TreeEntry
+	fields := strings.SplitN(treePath, "/", 2)
+	for _, rootEntry := range rootEntries {
+		treeEntry := &TreeEntry{
+			Name:   rootEntry.Name(),
+			IsFile: rootEntry.Mode() != git.EntryModeTree,
+			Path:   rootEntry.Name(),
+		}
+		treeList = append(treeList, treeEntry)
+		if fields[0] == rootEntry.Name() {
+			parentEntry = treeEntry
+		}
+	}
+
+	if treePath == "" || parentEntry == nil {
+		return treeList, nil
+	}
+
+	listEntry, err := commit.GetTreeEntryByPath(treePath)
+	if err != nil {
+		return nil, err
+	}
+
+	dir := treePath
+	// list current entry or parent entry if it's a file's children
+	// If the entry is a file, we return a FileContentResponse object
+	if listEntry.IsRegular() {
+		dir = path.Dir(treePath)
+		if dir == "" {
+			return treeList, nil
+		}
+		fields = fields[:len(fields)-1]
+		listEntry, err = commit.GetTreeEntryByPath(dir)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	for i := 1; i < len(fields); i++ {
+		parentEntry.Children = []*TreeEntry{
+			{
+				Name:   fields[i],
+				IsFile: false,
+				Path:   path.Join(fields[:i+1]...),
+			},
+		}
+		parentEntry = parentEntry.Children[0]
+	}
+
+	entries, err := listEntry.Tree().ListEntries()
+	if err != nil {
+		return nil, err
+	}
+
+	for _, entry := range entries {
+		parentEntry.Children = append(parentEntry.Children, &TreeEntry{
+			Name:   entry.Name(),
+			IsFile: entry.Mode() != git.EntryModeTree,
+			Path:   path.Join(dir, entry.Name()),
+		})
+	}
+	sortTreeEntries(treeList)
+	sortTreeEntries(parentEntry.Children)
+	return treeList, nil
+}
+
+// sortTreeEntries list directory first and with alpha sequence
+func sortTreeEntries(entries []*TreeEntry) {
+	sort.Slice(entries, func(i, j int) bool {
+		if entries[i].IsFile != entries[j].IsFile {
+			return !entries[i].IsFile
+		}
+		return entries[i].Name < entries[j].Name
+	})
+}

services/repository/files/tree_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/models/unittest"
+	"code.gitea.io/gitea/modules/git"
 	api "code.gitea.io/gitea/modules/structs"
 	"code.gitea.io/gitea/services/contexttest"
 
@@ -50,3 +51,128 @@ func TestGetTreeBySHA(t *testing.T) {
 
 	assert.EqualValues(t, expectedTree, tree)
 }
+
+func Test_GetTreeList(t *testing.T) {
+	unittest.PrepareTestEnv(t)
+	ctx1, _ := contexttest.MockContext(t, "user2/repo1")
+	contexttest.LoadRepo(t, ctx1, 1)
+	contexttest.LoadRepoCommit(t, ctx1)
+	contexttest.LoadUser(t, ctx1, 2)
+	contexttest.LoadGitRepo(t, ctx1)
+	defer ctx1.Repo.GitRepo.Close()
+
+	refName := git.RefNameFromBranch(ctx1.Repo.Repository.DefaultBranch)
+
+	treeList, err := GetTreeList(ctx1, ctx1.Repo.Repository, "", refName, true)
+	assert.NoError(t, err)
+	assert.Len(t, treeList, 1)
+	assert.EqualValues(t, "README.md", treeList[0].Name)
+	assert.EqualValues(t, "README.md", treeList[0].Path)
+	assert.True(t, treeList[0].IsFile)
+	assert.Empty(t, treeList[0].Children)
+
+	ctx2, _ := contexttest.MockContext(t, "org3/repo3")
+	contexttest.LoadRepo(t, ctx2, 3)
+	contexttest.LoadRepoCommit(t, ctx2)
+	contexttest.LoadUser(t, ctx2, 2)
+	contexttest.LoadGitRepo(t, ctx2)
+	defer ctx2.Repo.GitRepo.Close()
+
+	refName = git.RefNameFromBranch(ctx2.Repo.Repository.DefaultBranch)
+
+	treeList, err = GetTreeList(ctx2, ctx2.Repo.Repository, "", refName, true)
+	assert.NoError(t, err)
+	assert.Len(t, treeList, 2)
+	assert.EqualValues(t, "README.md", treeList[0].Name)
+	assert.EqualValues(t, "README.md", treeList[0].Path)
+	assert.True(t, treeList[0].IsFile)
+	assert.Empty(t, treeList[0].Children)
+
+	assert.EqualValues(t, "doc", treeList[1].Name)
+	assert.EqualValues(t, "doc", treeList[1].Path)
+	assert.False(t, treeList[1].IsFile)
+	assert.Len(t, treeList[1].Children, 1)
+
+	assert.EqualValues(t, "doc.md", treeList[1].Children[0].Name)
+	assert.EqualValues(t, "doc/doc.md", treeList[1].Children[0].Path)
+	assert.True(t, treeList[1].Children[0].IsFile)
+	assert.Empty(t, treeList[1].Children[0].Children)
+}
+
+func Test_GetTreeInformation(t *testing.T) {
+	unittest.PrepareTestEnv(t)
+	ctx1, _ := contexttest.MockContext(t, "user2/repo1")
+	contexttest.LoadRepo(t, ctx1, 1)
+	contexttest.LoadRepoCommit(t, ctx1)
+	contexttest.LoadUser(t, ctx1, 2)
+	contexttest.LoadGitRepo(t, ctx1)
+	defer ctx1.Repo.GitRepo.Close()
+
+	refName := git.RefNameFromBranch(ctx1.Repo.Repository.DefaultBranch)
+
+	treeList, err := GetTreeInformation(ctx1, ctx1.Repo.Repository, "", refName)
+	assert.NoError(t, err)
+	assert.Len(t, treeList, 1)
+	assert.EqualValues(t, "README.md", treeList[0].Name)
+	assert.EqualValues(t, "README.md", treeList[0].Path)
+	assert.True(t, treeList[0].IsFile)
+	assert.Empty(t, treeList[0].Children)
+
+	ctx2, _ := contexttest.MockContext(t, "org3/repo3")
+	contexttest.LoadRepo(t, ctx2, 3)
+	contexttest.LoadRepoCommit(t, ctx2)
+	contexttest.LoadUser(t, ctx2, 2)
+	contexttest.LoadGitRepo(t, ctx2)
+	defer ctx2.Repo.GitRepo.Close()
+
+	refName = git.RefNameFromBranch(ctx2.Repo.Repository.DefaultBranch)
+
+	treeList, err = GetTreeInformation(ctx2, ctx2.Repo.Repository, "", refName)
+	assert.NoError(t, err)
+	assert.Len(t, treeList, 2)
+	assert.EqualValues(t, "README.md", treeList[0].Name)
+	assert.EqualValues(t, "README.md", treeList[0].Path)
+	assert.True(t, treeList[0].IsFile)
+	assert.Empty(t, treeList[0].Children)
+
+	assert.EqualValues(t, "doc", treeList[1].Name)
+	assert.EqualValues(t, "doc", treeList[1].Path)
+	assert.False(t, treeList[1].IsFile)
+	assert.Len(t, treeList[1].Children, 0)
+
+	treeList, err = GetTreeInformation(ctx2, ctx2.Repo.Repository, "doc", refName)
+	assert.NoError(t, err)
+	assert.Len(t, treeList, 2)
+	assert.EqualValues(t, "README.md", treeList[0].Name)
+	assert.EqualValues(t, "README.md", treeList[0].Path)
+	assert.True(t, treeList[0].IsFile)
+	assert.Empty(t, treeList[0].Children)
+
+	assert.EqualValues(t, "doc", treeList[1].Name)
+	assert.EqualValues(t, "doc", treeList[1].Path)
+	assert.False(t, treeList[1].IsFile)
+	assert.Len(t, treeList[1].Children, 1)
+
+	assert.EqualValues(t, "doc.md", treeList[1].Children[0].Name)
+	assert.EqualValues(t, "doc/doc.md", treeList[1].Children[0].Path)
+	assert.True(t, treeList[1].Children[0].IsFile)
+	assert.Empty(t, treeList[1].Children[0].Children)
+
+	treeList, err = GetTreeInformation(ctx2, ctx2.Repo.Repository, "doc/doc.md", refName)
+	assert.NoError(t, err)
+	assert.Len(t, treeList, 2)
+	assert.EqualValues(t, "README.md", treeList[0].Name)
+	assert.EqualValues(t, "README.md", treeList[0].Path)
+	assert.True(t, treeList[0].IsFile)
+	assert.Empty(t, treeList[0].Children)
+
+	assert.EqualValues(t, "doc", treeList[1].Name)
+	assert.EqualValues(t, "doc", treeList[1].Path)
+	assert.False(t, treeList[1].IsFile)
+	assert.Len(t, treeList[1].Children, 1)
+
+	assert.EqualValues(t, "doc.md", treeList[1].Children[0].Name)
+	assert.EqualValues(t, "doc/doc.md", treeList[1].Children[0].Path)
+	assert.True(t, treeList[1].Children[0].IsFile)
+	assert.Empty(t, treeList[1].Children[0].Children)
+}

templates/repo/home.tmpl

@@ -1,4 +1,11 @@
 {{template "base/head" .}}
+{{$treeNamesLen := len .TreeNames}}
+{{$isTreePathRoot := eq $treeNamesLen 0}}
+{{$showSidebar := and $isTreePathRoot (not .HideRepoInfo) (not .IsBlame)}}
+{{$hasTreeSidebar := not $isTreePathRoot}}
+{{$showTreeSidebar := .RepoPreferences.ShowFileViewTreeSidebar}}
+{{$hideTreeSidebar := not $showTreeSidebar}}
+{{$hasAndShowTreeSidebar := and $hasTreeSidebar $showTreeSidebar}}
 <div role="main" aria-label="{{.Title}}" class="page-content repository file list {{if .IsBlame}}blame{{end}}">
 	{{template "repo/header" .}}
 	<div class="ui container {{if .IsBlame}}fluid padded{{end}}">
@@ -16,14 +23,20 @@
 
 		{{template "repo/code/recently_pushed_new_branches" .}}
 
-		{{$treeNamesLen := len .TreeNames}}
-		{{$isTreePathRoot := eq $treeNamesLen 0}}
-		{{$showSidebar := and $isTreePathRoot (not .HideRepoInfo) (not .IsBlame)}}
-		<div class="{{Iif $showSidebar "repo-grid-filelist-sidebar" "repo-grid-filelist-only"}}">
+		<div class="{{Iif $showSidebar "repo-grid-filelist-sidebar" (Iif $showTreeSidebar "repo-grid-tree-sidebar" "repo-grid-filelist-only")}}">
+			{{if $hasTreeSidebar}}
+				<div class="repo-view-file-tree-sidebar not-mobile {{if $hideTreeSidebar}}tw-hidden{{end}}">{{template "repo/view_file_tree_sidebar" .}}</div>
+			{{end}}
+
 			<div class="repo-home-filelist">
 				{{template "repo/sub_menu" .}}
 				<div class="repo-button-row">
 					<div class="repo-button-row-left">
+						{{if $hasTreeSidebar}}
+							<button class="show-tree-sidebar-button ui compact basic button icon not-mobile {{if $showTreeSidebar}}tw-hidden{{end}}" title="{{ctx.Locale.Tr "repo.diff.show_file_tree"}}">
+								{{svg "octicon-sidebar-collapse" 20 "icon"}}
+							</button>
+						{{end}}
 						{{$branchDropdownCurrentRefType := "branch"}}
 						{{$branchDropdownCurrentRefShortName := .BranchName}}
 						{{if .IsViewTag}}
@@ -40,6 +53,7 @@
 							"RefLinkTemplate" "{RepoLink}/src/{RefType}/{RefShortName}/{TreePath}"
 							"AllowCreateNewRef" .CanCreateBranch
 							"ShowViewAllRefsEntry" true
+							"ContainerClasses" (Iif $hasAndShowTreeSidebar "tw-hidden" "")
 						}}
 						{{if and .CanCompareOrPull .IsViewBranch (not .Repository.IsArchived)}}
 							{{$cmpBranch := ""}}
@@ -48,7 +62,7 @@
 							{{end}}
 							{{$cmpBranch = print $cmpBranch (.BranchName|PathEscapeSegments)}}
 							{{$compareLink := printf "%s/compare/%s...%s" .BaseRepo.Link (.BaseRepo.DefaultBranch|PathEscapeSegments) $cmpBranch}}
-							<a id="new-pull-request" role="button" class="ui compact basic button" href="{{$compareLink}}"
+							<a id="new-pull-request" role="button" class="ui compact basic button {{if $hasAndShowTreeSidebar}}tw-hidden{{end}}" href="{{$compareLink}}"
 								data-tooltip-content="{{if .PullRequestCtx.Allowed}}{{ctx.Locale.Tr "repo.pulls.compare_changes"}}{{else}}{{ctx.Locale.Tr "action.compare_branch"}}{{end}}">
 								{{svg "octicon-git-pull-request"}}
 							</a>
@@ -60,7 +74,7 @@
 						{{end}}
 
 						{{if and .CanWriteCode .IsViewBranch (not .Repository.IsMirror) (not .Repository.IsArchived) (not .IsViewFile)}}
-							<button class="ui dropdown basic compact jump button"{{if not .Repository.CanEnableEditor}} disabled{{end}}>
+							<button class="add-file-dropdown ui dropdown basic compact jump button {{if $hasAndShowTreeSidebar}}tw-hidden{{end}}"{{if not .Repository.CanEnableEditor}} disabled{{end}}>
 								{{ctx.Locale.Tr "repo.editor.add_file"}}
 								{{svg "octicon-triangle-down" 14 "dropdown icon"}}
 								<div class="menu">

templates/repo/view_file_tree_sidebar.tmpl

@@ -0,0 +1,63 @@
+<div class="view-file-tree-sidebar-top">
+	<div class="sidebar-header">
+		<button class="hide-tree-sidebar-button ui compact basic button icon" title="{{ctx.Locale.Tr "repo.diff.hide_file_tree"}}">
+			{{svg "octicon-sidebar-expand" 20 "icon"}}
+		</button>
+		<b> Files</b>
+	</div>
+	<div class="sidebar-ref">
+		{{$branchDropdownCurrentRefType := "branch"}}
+		{{$branchDropdownCurrentRefShortName := .BranchName}}
+		{{if .IsViewTag}}
+			{{$branchDropdownCurrentRefType = "tag"}}
+			{{$branchDropdownCurrentRefShortName = .TagName}}
+		{{end}}
+		{{template "repo/branch_dropdown" dict
+			"Repository" .Repository
+			"ShowTabBranches" true
+			"ShowTabTags" true
+			"CurrentRefType" $branchDropdownCurrentRefType
+			"CurrentRefShortName" $branchDropdownCurrentRefShortName
+			"CurrentTreePath" .TreePath
+			"RefLinkTemplate" "{RepoLink}/src/{RefType}/{RefShortName}/{TreePath}"
+			"AllowCreateNewRef" .CanCreateBranch
+			"ShowViewAllRefsEntry" true
+		}}
+
+		{{if and .CanCompareOrPull .IsViewBranch (not .Repository.IsArchived)}}
+			{{$cmpBranch := ""}}
+			{{if ne .Repository.ID .BaseRepo.ID}}
+				{{$cmpBranch = printf "%s/%s:" (.Repository.OwnerName|PathEscape) (.Repository.Name|PathEscape)}}
+			{{end}}
+			{{$cmpBranch = print $cmpBranch (.BranchName|PathEscapeSegments)}}
+			{{$compareLink := printf "%s/compare/%s...%s" .BaseRepo.Link (.BaseRepo.DefaultBranch|PathEscapeSegments) $cmpBranch}}
+			<a role="button" class="ui compact basic button" href="{{$compareLink}}"
+				data-tooltip-content="{{if .PullRequestCtx.Allowed}}{{ctx.Locale.Tr "repo.pulls.compare_changes"}}{{else}}{{ctx.Locale.Tr "action.compare_branch"}}{{end}}">
+				{{svg "octicon-git-pull-request"}}
+			</a>
+		{{end}}
+
+		{{if and .CanWriteCode .IsViewBranch (not .Repository.IsMirror) (not .Repository.IsArchived) (not .IsViewFile)}}
+			<button class="ui dropdown basic compact jump button"{{if not .Repository.CanEnableEditor}} disabled{{end}}>
+				{{ctx.Locale.Tr "repo.editor.add_file"}}
+				{{svg "octicon-triangle-down" 14 "dropdown icon"}}
+				<div class="menu">
+					<a class="item" href="{{.RepoLink}}/_new/{{.BranchName | PathEscapeSegments}}/{{.TreePath | PathEscapeSegments}}">
+						{{ctx.Locale.Tr "repo.editor.new_file"}}
+					</a>
+					{{if .RepositoryUploadEnabled}}
+					<a class="item" href="{{.RepoLink}}/_upload/{{.BranchName | PathEscapeSegments}}/{{.TreePath | PathEscapeSegments}}">
+						{{ctx.Locale.Tr "repo.editor.upload_file"}}
+					</a>
+					{{end}}
+					<a class="item" href="{{.RepoLink}}/_diffpatch/{{.BranchName | PathEscapeSegments}}/{{.TreePath | PathEscapeSegments}}">
+						{{ctx.Locale.Tr "repo.editor.patch"}}
+					</a>
+				</div>
+			</button>
+		{{end}}
+	</div>
+</div>
+<div class="view-file-tree-sidebar-bottom">
+	<div id="view-file-tree" class="is-loading" data-api-base-url="{{.RepoLink}}" data-tree-path="{{$.TreePath}}"></div>
+</div>

web_src/css/repo/home.css

@@ -50,6 +50,53 @@
   }
 }
 
+.repo-grid-tree-sidebar {
+  display: grid;
+  grid-template-columns: 300px auto;
+  grid-template-rows: auto auto 1fr;
+}
+
+.repo-grid-tree-sidebar .repo-home-filelist {
+  min-width: 0;
+  grid-column: 2;
+  grid-row: 1 / 4;
+}
+
+#view-file-tree.is-loading {
+  aspect-ratio: 5.415; /* the size is about 790 x 145 */
+}
+
+.repo-grid-tree-sidebar .repo-view-file-tree-sidebar {
+  display: flex;
+  flex-direction: column;
+  gap: 0.25em;
+}
+
+.repo-grid-tree-sidebar .view-file-tree-sidebar-top {
+  display: flex;
+  flex-direction: column;
+  gap: 0.25em;
+}
+
+.repo-grid-tree-sidebar .view-file-tree-sidebar-top .button {
+  padding: 6px 10px !important;
+  height: 30px;
+  flex-shrink: 0;
+  margin: 0;
+}
+
+.repo-grid-tree-sidebar .view-file-tree-sidebar-top .sidebar-ref {
+  display: flex;
+  gap: 0.25em;
+}
+
+@media (max-width: 767.98px) {
+  .repo-grid-tree-sidebar {
+    grid-template-columns: auto;
+    grid-template-rows: auto auto auto;
+  }
+}
+
 .language-stats {
   display: flex;
   gap: 2px;

web_src/js/components/ViewFileTree.vue

@@ -0,0 +1,26 @@
+<script lang="ts" setup>
+import ViewFileTreeItem from './ViewFileTreeItem.vue';
+
+defineProps<{
+  files: any,
+  selectedItem: any,
+  loadChildren: any,
+  loadContent: any;
+}>();
+</script>
+
+<template>
+  <div class="view-file-tree-items">
+    <!-- only render the tree if we're visible. in many cases this is something that doesn't change very often -->
+    <ViewFileTreeItem v-for="item in files" :key="item.name" :item="item" :selected-item="selectedItem" :load-content="loadContent" :load-children="loadChildren"/>
+  </div>
+</template>
+
+<style scoped>
+.view-file-tree-items {
+  display: flex;
+  flex-direction: column;
+  gap: 1px;
+  margin-right: .5rem;
+}
+</style>

web_src/js/components/ViewFileTreeItem.vue

@@ -0,0 +1,120 @@
+<script lang="ts" setup>
+import {SvgIcon} from '../svg.ts';
+import {ref} from 'vue';
+
+type Item = {
+  name: string;
+  path: string;
+  htmlUrl: string;
+  isFile: boolean;
+  children?: Item[];
+};
+
+const props = defineProps<{
+  item: Item,
+  loadContent: any;
+  loadChildren: any;
+  selectedItem?: any;
+}>();
+
+const isLoading = ref(false);
+const children = ref(props.item.children);
+const collapsed = ref(!props.item.children);
+
+const doLoadChildren = async () => {
+  collapsed.value = !collapsed.value;
+  if (!collapsed.value && props.loadChildren) {
+    isLoading.value = true;
+    const _children = await props.loadChildren(props.item);
+    children.value = _children;
+    isLoading.value = false;
+  }
+};
+
+const doLoadDirContent = () => {
+  doLoadChildren();
+  props.loadContent(props.item);
+};
+
+const doLoadFileContent = () => {
+  props.loadContent(props.item);
+};
+</script>
+
+<template>
+  <!--title instead of tooltip above as the tooltip needs too much work with the current methods, i.e. not being loaded or staying open for "too long"-->
+  <div
+    v-if="item.isFile" class="item-file"
+    :class="{'selected': selectedItem.value === item.path}"
+    :title="item.name"
+    @click.stop="doLoadFileContent"
+  >
+    <!-- file -->
+    <SvgIcon name="octicon-file"/>
+    <span class="gt-ellipsis tw-flex-1">{{ item.name }}</span>
+  </div>
+  <div
+    v-else class="item-directory"
+    :class="{'selected': selectedItem.value === item.path}"
+    :title="item.name"
+    @click.stop="doLoadDirContent"
+  >
+    <!-- directory -->
+    <SvgIcon v-if="isLoading" name="octicon-sync" class="job-status-rotate"/>
+    <SvgIcon v-else :name="collapsed ? 'octicon-chevron-right' : 'octicon-chevron-down'" @click.stop="doLoadChildren"/>
+    <SvgIcon class="text primary" :name="collapsed ? 'octicon-file-directory-fill' : 'octicon-file-directory-open-fill'"/>
+    <span class="gt-ellipsis">{{ item.name }}</span>
+  </div>
+
+  <div v-if="children?.length" v-show="!collapsed" class="sub-items">
+    <ViewFileTreeItem v-for="childItem in children" :key="childItem.name" :item="childItem" :selected-item="selectedItem" :load-content="loadContent" :load-children="loadChildren"/>
+  </div>
+</template>
+<style scoped>
+a, a:hover {
+  text-decoration: none;
+  color: var(--color-text);
+}
+
+.sub-items {
+  display: flex;
+  flex-direction: column;
+  gap: 1px;
+  margin-left: 13px;
+  border-left: 1px solid var(--color-secondary);
+}
+
+.sub-items .item-file {
+  padding-left: 18px;
+}
+
+.item-directory.selected, .item-file.selected {
+  color: var(--color-text);
+  background: var(--color-active);
+  border-radius: 4px;
+}
+
+.item-file.viewed {
+  color: var(--color-text-light-3);
+}
+
+.item-directory {
+  user-select: none;
+}
+
+.item-file,
+.item-directory {
+  display: flex;
+  align-items: center;
+  gap: 0.25em;
+  padding: 6px;
+}
+
+.item-file:hover,
+.item-directory:hover {
+  color: var(--color-text);
+  background: var(--color-hover);
+  border-radius: 4px;
+  cursor: pointer;
+}
+</style>

web_src/js/features/repo-view-file-tree-sidebar.ts

@@ -0,0 +1,77 @@
+import {createApp, ref} from 'vue';
+import {toggleElem} from '../utils/dom.ts';
+import {GET, PUT} from '../modules/fetch.ts';
+import ViewFileTree from '../components/ViewFileTree.vue';
+
+async function toggleSidebar(visibility) {
+  const sidebarEl = document.querySelector('.repo-view-file-tree-sidebar');
+  const showBtnEl = document.querySelector('.show-tree-sidebar-button');
+  const refSelectorEl = document.querySelector('.repo-home-filelist .js-branch-tag-selector');
+  const newPrBtnEl = document.querySelector('.repo-home-filelist #new-pull-request');
+  const addFileEl = document.querySelector('.repo-home-filelist .add-file-dropdown');
+  const containerClassList = sidebarEl.parentElement.classList;
+  containerClassList.toggle('repo-grid-tree-sidebar', visibility);
+  containerClassList.toggle('repo-grid-filelist-only', !visibility);
+  toggleElem(sidebarEl, visibility);
+  toggleElem(showBtnEl, !visibility);
+  toggleElem(refSelectorEl, !visibility);
+  toggleElem(newPrBtnEl, !visibility);
+  if (addFileEl) {
+    toggleElem(addFileEl, !visibility);
+  }
+
+  // save to session
+  await PUT('/repo/preferences', {
+    data: {
+      show_file_view_tree_sidebar: visibility,
+    },
+  });
+}
+
+async function loadChildren(item, recursive?: boolean) {
+  const el = document.querySelector('#view-file-tree');
+  const apiBaseUrl = el.getAttribute('data-api-base-url');
+  const response = await GET(`${apiBaseUrl}/tree/${item ? item.path : ''}?recursive=${recursive ?? false}`);
+  const json = await response.json();
+  if (json instanceof Array) {
+    return json.map((i) => ({
+      name: i.name,
+      isFile: i.isFile,
+      htmlUrl: i.html_url,
+      path: i.path,
+      children: i.children,
+    }));
+  }
+  return null;
+}
+
+async function loadContent(item) {
+  document.querySelector('.repo-home-filelist').innerHTML = `load content of ${item.path}`;
+}
+
+export async function initViewFileTreeSidebar() {
+  const sidebarElement = document.querySelector('.repo-view-file-tree-sidebar');
+  if (!sidebarElement) return;
+
+  document.querySelector('.show-tree-sidebar-button').addEventListener('click', () => {
+    toggleSidebar(true);
+  });
+
+  document.querySelector('.hide-tree-sidebar-button').addEventListener('click', () => {
+    toggleSidebar(false);
+  });
+
+  const fileTree = document.querySelector('#view-file-tree');
+  const treePath = fileTree.getAttribute('data-tree-path');
+  const selectedItem = ref(treePath);
+
+  const files = await loadChildren({path: treePath}, true);
+
+  fileTree.classList.remove('is-loading');
+  const fileTreeView = createApp(ViewFileTree, {files, selectedItem, loadChildren, loadContent: (item) => {
+    window.history.pushState(null, null, item.htmlUrl);
+    selectedItem.value = item.path;
+    loadContent(item);
+  }});
+  fileTreeView.mount(fileTree);
+}

web_src/js/index.ts

@@ -33,6 +33,7 @@ import {
 } from './features/repo-issue.ts';
 import {initRepoEllipsisButton, initCommitStatuses} from './features/repo-commit.ts';
 import {initRepoTopicBar} from './features/repo-home.ts';
+import {initViewFileTreeSidebar} from './features/repo-view-file-tree-sidebar.ts';
 import {initAdminCommon} from './features/admin/common.ts';
 import {initRepoTemplateSearch} from './features/repo-template.ts';
 import {initRepoCodeView} from './features/repo-code.ts';
@@ -195,6 +196,7 @@ onDomReady(() => {
     initRepoReleaseNew,
     initRepoTemplateSearch,
     initRepoTopicBar,
+    initViewFileTreeSidebar,
     initRepoWikiForm,
     initRepository,
     initRepositoryActionView,