feat(serverHandler): separate simple and download param

BREAKING CHANGE

Before:

`GET /dir?download` shows simple page.

`GET /dir?downloadfile` shows simple page, and add download param to files.

`GET /file?download` download a file instead of displaying its content.

`GET /file?downloadfile` download a file instead of displaying its content.

After:

`GET /dir?simple` shows simple page.

`GET /dir?download` add download param to files.

`GET /dir?simpledownload` shows simple page, and add download param to files.

`GET /file?download` download a file instead of displaying its content.

Author: marjune163

doc/en-US/api.md

@@ -37,29 +37,31 @@ Example:
 curl -H 'Accept: application/json' 'http://localhost/ghfs/'
 ```
 
-# Render page for downloading
+# Render page in simple mode
 ```
-GET <path>?download[&sort=key]
-GET <path>?downloadfile[&sort=key]
+GET <path>?simple[&sort=key]
 ```
-Similar to regular page rendering, but hide path list,
-sortable list header,
-and parent directory link.
+Similar to regular page rendering, but
+hide path list, sortable list header, and parent directory link.
 It's convenient for tools like "wget" to download files recursively.
 
 Example:
 ```shell
 wget --recursive -nc -nH -np 'http://localhost/dir/?download'
 ```
 
-Option `downloadfile` makes file links downloadable instead of displaying content.
+# Add download param to file
+```
+GET <path>?download[&sort=key]
+```
+Add download parameter to file links in the page, which
+make them downloadable instead of displaying content.
 
 # Download a file
 Notify user agent download a file rather than displaying its content,
 by outputting `Content-Disposition` header.
 ```
 GET <path/to/file>?download
-GET <path/to/file>?downloadfile
 ```
 
 Example:

doc/zh-CN/api.md

@@ -37,10 +37,9 @@ Accept: application/json
 curl -H 'Accept: application/json' 'http://localhost/ghfs/'
 ```
 
-# 显示用于下载的页面
+# 显示精简页面
 ```
-GET <path>?download[&sort=key]
-GET <path>?downloadfile[&sort=key]
+GET <path>?simple[&sort=key]
 ```
 类似于常规显示的页面，但隐藏路径列表、可排序的表头和上级目录链接。
 这为“wget”之类的工具递归下载提供了方便。
@@ -50,13 +49,16 @@ GET <path>?downloadfile[&sort=key]
 wget --recursive -nc -nH -np 'http://localhost/dir/?download'
 ```
 
-选项`downloadfile`使文件链接可被下载，而不是显示其内容。
+# 为文件添加下载参数
+```
+GET <path>?download[&sort=key]
+```
+为页面中的文件链接添加下载参数，使其可被下载，而不是显示其内容。
 
 # 下载文件
 通过输出`Content-Disposition`头，通知用户代理下载文件而不是显示其内容。
 ```
 GET <path/to/file>?download
-GET <path/to/file>?downloadfile
 ```
 
 举例：

src/serverHandler/page.go

@@ -20,7 +20,7 @@ func updateSubItemsHtml(data *responseData) {
 	data.SubItemsHtml = make([]itemHtml, length)
 
 	dirSuffix := "/" + data.Context.QueryString()
-	fileSuffix := data.Context.FileQueryString()
+	fileSuffix := data.Context.SubFileQueryString()
 
 	for i, info := range data.SubItems {
 		name := info.Name()

src/serverHandler/pathContext.go

@@ -1,20 +1,22 @@
 package serverHandler
 
 type pathContext struct {
-	download     bool
-	downloadfile bool
-	sort         *string // keep different for param is not specified or is empty
-	defaultSort  string
+	simple      bool
+	download    bool
+	sort        *string // keep different for param is not specified or is empty
+	defaultSort string
 }
 
 func (ctx pathContext) QueryString() string {
-	// ?downloadfile&sort=x/&
-	buffer := make([]byte, 1, 22)
+	// ?simpledownload&sort=x/&
+	buffer := make([]byte, 1, 24)
 	buffer[0] = '?' // 1 byte
 
 	switch {
-	case ctx.downloadfile:
-		buffer = append(buffer, []byte("downloadfile&")...) // 13 bytes
+	case ctx.simple && ctx.download:
+		buffer = append(buffer, []byte("simpledownload&")...) // 15 bytes
+	case ctx.simple:
+		buffer = append(buffer, []byte("simple&")...) // 7 bytes
 	case ctx.download:
 		buffer = append(buffer, []byte("download&")...) // 9 bytes
 	}
@@ -35,9 +37,9 @@ func (ctx pathContext) QueryStringOfSort(sort string) string {
 	return copiedCtx.QueryString()
 }
 
-func (ctx pathContext) FileQueryString() string {
-	if ctx.downloadfile {
-		return "?downloadfile"
+func (ctx pathContext) SubFileQueryString() string {
+	if ctx.download {
+		return "?download"
 	}
 
 	return ""

src/serverHandler/pathContext_test.go

@@ -7,7 +7,6 @@ import (
 func TestPathContext(t *testing.T) {
 	var result string
 	var sort string
-	var download bool
 
 	result = (&pathContext{}).QueryString()
 	if result != "" {
@@ -38,29 +37,47 @@ func TestPathContext(t *testing.T) {
 		t.Error(result)
 	}
 
-	download = false
-	result = (&pathContext{download: download}).QueryString()
+	result = (&pathContext{simple: false}).QueryString()
 	if result != "" {
 		t.Error(result)
 	}
 
-	download = false
+	result = (&pathContext{simple: true}).QueryString()
+	if result != "?simple" {
+		t.Error(result)
+	}
+
+	result = (&pathContext{download: true}).QueryString()
+	if result != "?download" {
+		t.Error(result)
+	}
+
+	result = (&pathContext{simple: true, download: true}).QueryString()
+	if result != "?simpledownload" {
+		t.Error(result)
+	}
+
 	sort = "/n"
-	result = (&pathContext{download: download, sort: &sort}).QueryString()
+	result = (&pathContext{simple: false, sort: &sort}).QueryString()
 	if result != "?sort=/n" {
 		t.Error(result)
 	}
 
-	download = true
-	result = (&pathContext{download: download}).QueryString()
-	if result != "?download" {
+	sort = "/n"
+	result = (&pathContext{simple: true, sort: &sort}).QueryString()
+	if result != "?simple&sort=/n" {
 		t.Error(result)
 	}
 
-	download = true
 	sort = "/n"
-	result = (&pathContext{download: download, sort: &sort}).QueryString()
+	result = (&pathContext{download: true, sort: &sort}).QueryString()
 	if result != "?download&sort=/n" {
 		t.Error(result)
 	}
+
+	sort = "/n"
+	result = (&pathContext{simple: true, download: true, sort: &sort}).QueryString()
+	if result != "?simpledownload&sort=/n" {
+		t.Error(result)
+	}
 }

src/serverHandler/sessionData.go

@@ -86,8 +86,8 @@ type sessionContext struct {
 type responseData struct {
 	AuthUserName string
 
-	IsDownload     bool
-	IsDownloadFile bool
+	IsSimple   bool
+	IsDownload bool
 
 	CanIndex     bool
 	CanUpload    bool
@@ -368,16 +368,18 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 
 	headers := h.getHeaders(vhostReqPath, fsPath, authSuccess)
 
+	isSimple := false
 	isDownload := false
-	isDownloadFile := false
 	isUpload := false
 	isMkdir := false
 	isDelete := false
 	isMutate := false
 	switch {
-	case strings.HasPrefix(rawQuery, "downloadfile"):
+	case strings.HasPrefix(rawQuery, "simpledownload"):
+		isSimple = true
 		isDownload = true
-		isDownloadFile = true
+	case strings.HasPrefix(rawQuery, "simple"):
+		isSimple = true
 	case strings.HasPrefix(rawQuery, "download"):
 		isDownload = true
 	case strings.HasPrefix(rawQuery, "upload") && r.Method == http.MethodPost:
@@ -537,8 +539,8 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 	data = &responseData{
 		AuthUserName: authUserName,
 
-		IsDownload:     isDownload,
-		IsDownloadFile: isDownloadFile,
+		IsSimple:   isSimple,
+		IsDownload: isDownload,
 
 		CanIndex:     canIndex,
 		CanUpload:    canUpload,
@@ -564,10 +566,10 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 		SubItemPrefix: subItemPrefix,
 		SortState:     sortState,
 		Context: pathContext{
-			download:     isDownload,
-			downloadfile: isDownloadFile,
-			sort:         rawSortBy,
-			defaultSort:  h.defaultSort,
+			simple:      isSimple,
+			download:    isDownload,
+			sort:        rawSortBy,
+			defaultSort: h.defaultSort,
 		},
 	}
 	return

src/tpl/defaultTheme/frontend/index.html

@@ -12,9 +12,9 @@
 </head>
 <body class="{{if .IsRoot}}root-dir{{else}}sub-dir{{end}}">
 {{$contextQueryString := .Context.QueryString}}
-{{$isDownload := .IsDownload}}
+{{$isSimple := .IsSimple}}
 {{$SubItemPrefix := .SubItemPrefix}}
-{{if not $isDownload}}
+{{if not $isSimple}}
 <ol class="path-list" translate="no">
 	{{range .Paths}}
 	<li><a href="{{.Path}}{{$contextQueryString}}">{{fmtFilename .Name}}</a></li>
@@ -98,7 +98,7 @@
 </div>
 {{end}}
 <ul class="item-list{{if .HasDeletable}} has-deletable{{end}}">
-	{{if not $isDownload}}
+	{{if not $isSimple}}
 	<li class="header">{{$dirSort := .SortState.DirSort}}{{$sortKey := .SortState.Key}}
 		<span class="detail">
 		<a class="field dir" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextDirSort}}">{{.Trans.ListDirLabel}}{{if eq $dirSort -1}}&uarr;{{else if eq $dirSort 1}}&darr;{{end}}</a>
@@ -123,7 +123,7 @@
 			<span class="field size">{{.DisplaySize}}</span>
 			<span class="field time">{{.DisplayTime}}</span>
 		</a>
-		{{if and (not $isDownload) .DeleteUrl}}<form class="delete" method="post" action="{{$SubItemPrefix}}?delete" onsubmit="return confirmDelete(this)"><input type="hidden" name="name" value="{{.DeleteUrl}}"/><input type="hidden" name="contextquerystring" value="{{$contextQueryString}}"/><button type="submit">x</button></form>{{end}}
+		{{if and (not $isSimple) .DeleteUrl}}<form class="delete" method="post" action="{{$SubItemPrefix}}?delete" onsubmit="return confirmDelete(this)"><input type="hidden" name="name" value="{{.DeleteUrl}}"/><input type="hidden" name="contextquerystring" value="{{$contextQueryString}}"/><button type="submit">x</button></form>{{end}}
 	</li>
 	{{end}}
 </ul>