feat(serverHandler): add sort support

Author: marjune163

README.md

@@ -116,6 +116,21 @@ server [options]
     Use virtual empty directory as root directory.
     Useful to share alias directories only.
 
+--default-sort <sortBy>
+    Default sort rule for files and directories.
+    Available sort key:
+    - `n` sort by name ascending
+    - `N` sort by name descending
+    - `s` sort by size ascending
+    - `S` sort by size descending
+    - `t` sort by modify time ascending
+    - `T` sort by modify time descending
+    - `_` no sort
+    Directory sort:
+    - `/<key>` directories before files
+    - `<key>/` directories after files
+    - `<key>` directories mixed with files
+
 -I|--dir-index <file> ...
     Specify default index file for directory.
 

README.zh-CN.md

@@ -114,6 +114,21 @@ server [选项]
     使用空的虚拟目录作为根目录。
     在仅需挂载别名的情况下较实用。
 
+--default-sort <排序规则>
+    指定文件和目录的默认排序规则。
+    可用的排序key：
+    - `n` 按名称递增排序
+    - `N` 按名称递减排序
+    - `s` 按大小递增排序
+    - `S` 按大小递减排序
+    - `t` 按修改时间递增排序
+    - `T` 按修改时间递减排序
+    - `_` 不排序
+    目录顺序：
+    - `/<key>` 目录在文件之前
+    - `<key>/` 目录在文件之后
+    - `<key>` 目录与文件混合
+
 -I|--dir-index <文件> ...
     指定目录默认页面文件。
 

doc/en-US/api.md

@@ -1,17 +1,32 @@
 # Render page of specified path
 ```
-GET <path>
+GET <path>[?sort=<sortBy>]
 ```
 Should work no matter tailing “/” is present or not in path.
 
+Available sort key:
+- `n` sort by name ascending
+- `N` sort by name descending
+- `s` sort by size ascending
+- `S` sort by size descending
+- `t` sort by modify time ascending
+- `T` sort by modify time descending
+- `_` no sort
+
+Directory sort:
+- `/<key>` directories before files
+- `<key>/` directories after files
+- `<key>` directories mixed with files
+
 Example:
 ```sh
 curl http://localhost/ghfs/
+curl http://localhost/ghfs/?sort=/T
 ```
 
 # Get JSON data of specified path
 ```
-GET <path>?json
+GET <path>?json[&sort=key]
 ```
 
 Example:

doc/zh-CN/api.md

@@ -1,17 +1,32 @@
 # 为指定路径显示页面
 ```
-GET <path>
+GET <path>[?sort=sortBy]
 ```
 无论路径是否以“/”结尾，都应正常工作。
 
+可用的排序key：
+- `n` 按名称递增排序
+- `N` 按名称递减排序
+- `s` 按大小递增排序
+- `S` 按大小递减排序
+- `t` 按修改时间递增排序
+- `T` 按修改时间递减排序
+- `_` 不排序
+
+目录顺序：
+- `/<key>` 目录在文件之前
+- `<key>/` 目录在文件之后
+- `<key>` 目录与文件混合
+
 举例：
 ```sh
 curl http://localhost/ghfs/
+curl http://localhost/ghfs/?sort=/T
 ```
 
 # 获取指定路径JSON形式的数据
 ```
-GET <path>?json
+GET <path>?json[&sort=key]
 ```
 
 举例：

src/param/cli.go

@@ -18,6 +18,7 @@ var cliCmd *goNixArgParser.Command
 func init() {
 	cliCmd = goNixArgParser.NewSimpleCommand(os.Args[0], "Simple command line based HTTP file server to share local file system")
 	options := cliCmd.Options()
+	var opt goNixArgParser.Option
 
 	// define option
 	var err error
@@ -27,6 +28,11 @@ func init() {
 	err = options.AddFlags("emptyroot", []string{"-R", "--empty-root"}, "GHFS_EMPTY_ROOT", "use virtual empty root directory")
 	serverErrHandler.CheckFatal(err)
 
+	opt = goNixArgParser.NewFlagValueOption("defaultsort", "--default-sort", "GHFS_DEFAULT_SORT", "/n", "default sort for files and directories")
+	opt.Description = "Available sort key:\n- `n` sort by name ascending\n- `N` sort by name descending\n- `s` sort by size ascending\n- `S` sort by size descending\n- `t` sort by modify time ascending\n- `T` sort by modify time descending\n- `_` no sort\nDirectory sort:\n- `/<key>` directories before files\n- `<key>/` directories after files\n- `<key>` directories mixed with files\n"
+	err = options.Add(opt)
+	serverErrHandler.CheckFatal(err)
+
 	err = options.AddFlagsValues("dirindexes", []string{"-I", "--dir-index"}, "GHFS_DIR_INDEX", nil, "default index page for directory")
 	serverErrHandler.CheckFatal(err)
 
@@ -225,6 +231,7 @@ func doParseCli() []*Param {
 		// normalize option
 		param.Root, _ = result.GetString("root")
 		param.EmptyRoot = result.HasKey("emptyroot")
+		param.DefaultSort, _ = result.GetString("defaultsort")
 		param.GlobalUpload = result.HasKey("globalupload")
 		param.GlobalMkdir = result.HasKey("globalmkdir")
 		param.GlobalDelete = result.HasKey("globaldelete")

src/param/main.go

@@ -14,8 +14,9 @@ type Param struct {
 	Root      string
 	EmptyRoot bool
 
-	DirIndexes []string
-	Aliases    map[string]string
+	DefaultSort string
+	DirIndexes  []string
+	Aliases     map[string]string
 
 	GlobalUpload bool
 	UploadUrls   []string

src/serverHandler/json.go

@@ -15,16 +15,17 @@ type jsonItem struct {
 }
 
 type jsonResponseData struct {
-	IsRoot        bool         `json:"isRoot"`
-	Path          string       `json:"path"`
-	Paths         []*pathEntry `json:"paths"`
-	SubItemPrefix string       `json:"subItemPrefix"`
-	CanUpload     bool         `json:"canUpload"`
-	CanMkdir      bool         `json:"canMkdir"`
-	CanDelete     bool         `json:"canDelete"`
-	CanArchive    bool         `json:"canArchive"`
-	CanCors       bool         `json:"canCors"`
-	NeedAuth      bool         `json:"needAuth"`
+	IsRoot             bool         `json:"isRoot"`
+	Path               string       `json:"path"`
+	Paths              []*pathEntry `json:"paths"`
+	SubItemPrefix      string       `json:"subItemPrefix"`
+	ContextQueryString string       `json:"contextQueryString"`
+	CanUpload          bool         `json:"canUpload"`
+	CanMkdir           bool         `json:"canMkdir"`
+	CanDelete          bool         `json:"canDelete"`
+	CanArchive         bool         `json:"canArchive"`
+	CanCors            bool         `json:"canCors"`
+	NeedAuth           bool         `json:"needAuth"`
 
 	Item     *jsonItem   `json:"item"`
 	SubItems []*jsonItem `json:"subItems"`
@@ -55,16 +56,17 @@ func getJsonData(data *responseData) *jsonResponseData {
 	}
 
 	return &jsonResponseData{
-		IsRoot:        data.IsRoot,
-		Path:          data.Path,
-		Paths:         data.Paths,
-		SubItemPrefix: data.SubItemPrefix,
-		CanUpload:     data.CanUpload,
-		CanMkdir:      data.CanMkdir,
-		CanDelete:     data.CanDelete,
-		CanArchive:    data.CanArchive,
-		CanCors:       data.CanCors,
-		NeedAuth:      data.NeedAuth,
+		IsRoot:             data.IsRoot,
+		Path:               data.Path,
+		Paths:              data.Paths,
+		SubItemPrefix:      data.SubItemPrefix,
+		ContextQueryString: string(data.ContextQueryString),
+		CanUpload:          data.CanUpload,
+		CanMkdir:           data.CanMkdir,
+		CanDelete:          data.CanDelete,
+		CanArchive:         data.CanArchive,
+		CanCors:            data.CanCors,
+		NeedAuth:           data.NeedAuth,
 
 		Item:     item,
 		SubItems: subItems,

src/serverHandler/main.go

@@ -12,9 +12,10 @@ import (
 )
 
 type handler struct {
-	root      string
-	emptyRoot bool
-	urlPrefix string
+	root        string
+	emptyRoot   bool
+	defaultSort string
+	urlPrefix   string
 
 	dirIndexes []string
 	aliases    aliases
@@ -142,9 +143,10 @@ func NewHandler(
 	}
 
 	h := &handler{
-		root:      root,
-		emptyRoot: emptyRoot,
-		urlPrefix: urlPrefix,
+		root:        root,
+		emptyRoot:   emptyRoot,
+		defaultSort: p.DefaultSort,
+		urlPrefix:   urlPrefix,
 
 		dirIndexes: p.DirIndexes,
 		aliases:    aliases,

src/serverHandler/page.go

@@ -16,17 +16,22 @@ func updateSubItemsHtml(data *responseData) {
 
 	for i, info := range data.SubItems {
 		name := info.Name()
-		displayName := tplutil.FormatFilename(name)
 
+		var displayName template.HTML
 		var typ template.HTML
 		var url string
 		var readableSize template.HTML
 
 		if info.IsDir() {
+			displayName = tplutil.FormatFilename(name) + "/"
 			typ = TypeDir
-			url = data.SubItemPrefix + name + "/"
-			displayName += "/"
+			if len(data.ContextQueryString) > 0 {
+				url = data.SubItemPrefix + name + "/" + string(data.ContextQueryString)
+			} else {
+				url = data.SubItemPrefix + name + "/"
+			}
 		} else {
+			displayName = tplutil.FormatFilename(name)
 			typ = TypeFile
 			url = data.SubItemPrefix + name
 			readableSize = tplutil.FormatSize(info.Size())

src/serverHandler/responseData.go

@@ -31,17 +31,19 @@ type responseData struct {
 	errors []error
 	Status int
 
-	IsRoot        bool
-	Path          string
-	Paths         []*pathEntry
-	RootRelPath   string
-	File          *os.File
-	Item          os.FileInfo
-	ItemName      string
-	SubItems      []os.FileInfo
-	AliasSubItems []os.FileInfo
-	SubItemsHtml  []*itemHtml
-	SubItemPrefix string
+	IsRoot             bool
+	Path               string
+	Paths              []*pathEntry
+	RootRelPath        string
+	File               *os.File
+	Item               os.FileInfo
+	ItemName           string
+	SubItems           []os.FileInfo
+	AliasSubItems      []os.FileInfo
+	SubItemsHtml       []*itemHtml
+	SubItemPrefix      string
+	SortState          SortState
+	ContextQueryString template.HTML
 
 	CanUpload    bool
 	CanMkdir     bool
@@ -280,6 +282,8 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 	status := http.StatusOK
 	isRoot := rawReqPath == "/"
 
+	rawQuery := r.URL.RawQuery
+
 	pathEntries := getPathEntries(rawReqPath, tailSlash)
 	var rootRelPath string
 	if len(pathEntries) > 0 {
@@ -328,14 +332,19 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 	}
 
 	subItems = h.FilterItems(subItems)
-	sortSubItems(subItems)
+	rawSortBy, sortState := sortSubItems(subItems, rawQuery, h.defaultSort)
 
 	if h.emptyRoot && status == http.StatusOK && r.RequestURI != "/" {
 		status = http.StatusNotFound
 	}
 
 	subItemPrefix := getSubItemPrefix(rawReqPath, tailSlash)
 
+	var contextQueryString template.HTML
+	if len(rawSortBy) > 0 {
+		contextQueryString = "?sort=" + template.HTML(rawSortBy)
+	}
+
 	canUpload := h.getCanUpload(item, rawReqPath, reqFsPath)
 	canMkdir := h.getCanMkdir(item, rawReqPath, reqFsPath)
 	canDelete := h.getCanDelete(item, rawReqPath, reqFsPath)
@@ -344,7 +353,6 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 	canCors := h.getCanCors(rawReqPath, reqFsPath)
 	needAuth := h.getNeedAuth(rawReqPath, reqFsPath)
 
-	rawQuery := r.URL.RawQuery
 	isUpload := false
 	isMkdir := false
 	isDelete := false
@@ -369,17 +377,19 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 		errors: errs,
 		Status: status,
 
-		IsRoot:        isRoot,
-		Path:          rawReqPath,
-		Paths:         pathEntries,
-		RootRelPath:   rootRelPath,
-		File:          file,
-		Item:          item,
-		ItemName:      itemName,
-		SubItems:      subItems,
-		AliasSubItems: aliasSubItems,
-		SubItemsHtml:  nil,
-		SubItemPrefix: subItemPrefix,
+		IsRoot:             isRoot,
+		Path:               rawReqPath,
+		Paths:              pathEntries,
+		RootRelPath:        rootRelPath,
+		File:               file,
+		Item:               item,
+		ItemName:           itemName,
+		SubItems:           subItems,
+		AliasSubItems:      aliasSubItems,
+		SubItemsHtml:       nil,
+		SubItemPrefix:      subItemPrefix,
+		SortState:          sortState,
+		ContextQueryString: contextQueryString,
 
 		CanUpload:    canUpload,
 		CanMkdir:     canMkdir,