add new api GetDirInfos to display basic directory info

Author: Lei Da

modules/structs/repo_tree.go

@@ -5,12 +5,14 @@ package structs
 
 // GitEntry represents a git tree
 type GitEntry struct {
-	Path string `json:"path"`
-	Mode string `json:"mode"`
-	Type string `json:"type"`
-	Size int64  `json:"size"`
-	SHA  string `json:"sha"`
-	URL  string `json:"url"`
+	Path      string `json:"path"`
+	Mode      string `json:"mode"`
+	Type      string `json:"type"`
+	Size      int64  `json:"size"`
+	SHA       string `json:"sha"`
+	URL       string `json:"url"`
+	CommitMsg string `json:"commit_msg"`
+	IsLfs     bool   `json:"is_lfs"`
 }
 
 // GitTreeResponse returns a git tree

routers/api/v1/api.go

@@ -1234,6 +1234,7 @@ func Routes() *web.Route {
 					})
 					m.Get("/refs", repo.GetGitAllRefs)
 					m.Get("/refs/*", repo.GetGitRefs)
+					m.Get("/dir", repo.GetDirInfos)
 					m.Get("/trees/{sha}", repo.GetTree)
 					m.Get("/blobs/{sha}", repo.GetBlob)
 					m.Get("/tags/{sha}", repo.GetAnnotatedTag)

routers/api/v1/repo/tree.go

@@ -4,12 +4,81 @@
 package repo
 
 import (
+	"fmt"
 	"net/http"
 
+	"code.gitea.io/gitea/modules/base"
 	"code.gitea.io/gitea/modules/context"
+	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/lfs"
+	"code.gitea.io/gitea/modules/structs"
 	files_service "code.gitea.io/gitea/services/repository/files"
 )
 
+func GetDirInfos(ctx *context.APIContext) {
+	var err error
+	branch := ctx.Req.URL.Query().Get("branch")
+	if len(branch) == 0 {
+		branch = "main"
+	}
+	ctx.Repo.Commit, err = ctx.Repo.GitRepo.GetBranchCommit(branch)
+	if err != nil {
+		ctx.JSON(http.StatusInternalServerError, "failed to get branch commit, error: "+err.Error())
+		return
+	}
+	path := ctx.Req.URL.Query().Get("path")
+	entries, err := getDirectoryEntries(ctx, path)
+	if err != nil {
+		ctx.JSON(http.StatusInternalServerError, "failed to get directry entries, error: "+err.Error())
+		return
+	}
+	ctx.JSON(http.StatusOK, entries)
+}
+
+func getDirectoryEntries(ctx *context.APIContext, folder string) ([]structs.GitEntry, error) {
+	tree, err := ctx.Repo.Commit.SubTree(folder)
+	if err != nil {
+		return nil, fmt.Errorf("failed to exec SubTree, cause:%w", err)
+	}
+
+	allEntries, err := tree.ListEntries()
+	if err != nil {
+		return nil, fmt.Errorf("failed to exec ListEntries, cause:%w", err)
+	}
+	allEntries.CustomSort(base.NaturalSortLess)
+
+	var commits []git.CommitInfo
+	commits, _, err = allEntries.GetCommitsInfo(ctx, ctx.Repo.Commit, folder)
+	if err != nil {
+		return nil, fmt.Errorf("failed to exec GetCommitsInfo, cause:%w", err)
+	}
+	var ges = make([]structs.GitEntry, 0, len(commits))
+	for _, c := range commits {
+
+		e := structs.GitEntry{
+			Path:      c.Entry.Name(),
+			Mode:      c.Entry.Mode().String(),
+			Type:      c.Entry.Type(),
+			Size:      c.Entry.Size(),
+			SHA:       c.Commit.ID.String(),
+			URL:       "",
+			CommitMsg: c.Commit.CommitMessage,
+		}
+		//lfs pointer size is less than 1024
+		if c.Entry.Size() <= 1024 {
+			content, _ := c.Entry.Blob().GetBlobContent(1024)
+			p, _ := lfs.ReadPointerFromBuffer([]byte(content))
+			if p.IsValid() {
+				e.Size = p.Size
+				e.IsLfs = true
+			}
+		}
+		ges = append(ges, e)
+	}
+
+	return ges, nil
+}
+
 // GetTree get the tree of a repository.
 func GetTree(ctx *context.APIContext) {
 	// swagger:operation GET /repos/{owner}/{repo}/git/trees/{sha} repository GetTree