feat: obj list api

server/controllers/fslist.go

@@ -0,0 +1,99 @@
+package controllers
+
+import (
+	"github.com/alist-org/alist/v3/internal/db"
+	"github.com/alist-org/alist/v3/internal/fs"
+	"github.com/alist-org/alist/v3/internal/model"
+	"github.com/alist-org/alist/v3/pkg/utils"
+	"github.com/alist-org/alist/v3/server/common"
+	"github.com/gin-gonic/gin"
+	"time"
+)
+
+type ListReq struct {
+	common.PageReq
+	Path     string `json:"path" form:"path"`
+	Password string `json:"password" form:"password"`
+}
+
+type ObjResp struct {
+	Name     string    `json:"name"`
+	Size     int64     `json:"size"`
+	IsDir    bool      `json:"is_dir"`
+	Modified time.Time `json:"modified"`
+}
+
+type ListResp struct {
+	Content []ObjResp `json:"content"`
+	Total   int64     `json:"total"`
+}
+
+func List(c *gin.Context) {
+	var req ListReq
+	if err := c.ShouldBind(&req); err != nil {
+		common.ErrorResp(c, err, 400)
+		return
+	}
+	req.Validate()
+	user := c.MustGet("user").(*model.User)
+	meta, _ := db.GetNearestMeta(req.Path)
+	c.Set("meta", meta)
+	if !canAccess(user, meta, req.Path, req.Password) {
+		common.ErrorStrResp(c, "password is incorrect", 401)
+		return
+	}
+	objs, err := fs.List(c, req.Path)
+	if err != nil {
+		common.ErrorResp(c, err, 500, true)
+		return
+	}
+	total, objs := pagination(objs, &req.PageReq)
+	common.SuccessResp(c, ListResp{
+		Content: toObjResp(objs),
+		Total:   int64(total),
+	})
+}
+
+func canAccess(user *model.User, meta *model.Meta, path string, password string) bool {
+	// if is not guest, can access
+	if user.IsAdmin() || user.IgnorePassword {
+		return true
+	}
+	// if meta is nil or password is empty, can access
+	if meta == nil || meta.Password == "" {
+		return true
+	}
+	// if meta doesn't apply to sub_folder, can access
+	if !utils.PathEqual(meta.Path, path) && !meta.SubFolder {
+		return true
+	}
+	// validate password
+	return meta.Password == password
+}
+
+func pagination(objs []model.Obj, req *common.PageReq) (int, []model.Obj) {
+	pageIndex, pageSize := req.PageIndex, req.PageSize
+	total := len(objs)
+	start := (pageIndex - 1) * pageSize
+	if start > total {
+		return total, []model.Obj{}
+	}
+	end := start + pageSize
+	if end > total {
+		end = total
+	}
+	return total, objs[start:end]
+}
+
+func toObjResp(objs []model.Obj) []ObjResp {
+	var resp []ObjResp
+	for _, obj := range objs {
+		resp = append(resp, ObjResp{
+			Name:     obj.GetName(),
+			Size:     obj.GetSize(),
+			IsDir:    obj.IsDir(),
+			Modified: obj.ModTime(),
+		})
+	}
+	return resp
+}