feat(serverHandler): allow specify filename for download or archive

Author: marjune163

doc/en-US/api.md

@@ -50,18 +50,18 @@ Example:
 wget --recursive -nc -nH -np 'http://localhost/dir/?download'
 ```
 
-# Add download param to file
+# Add download param to files
 ```
 GET <path>?download[&sort=key]
 ```
-Add download parameter to file links in the page, which
-make them downloadable instead of displaying content.
+Add download parameter to file links in directory list page, which
+makes 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>?download[=filename]
 ```
 
 Example:
@@ -72,12 +72,12 @@ curl 'http://localhost/ghfs/file?download'
 # Get contents of specified path as archive file
 Only work when "archive" is enabled.
 ```
-GET <path>?tar
-GET <path>?tgz
-GET <path>?zip
-POST <path>?tar
-POST <path>?tgz
-POST <path>?zip
+GET <path>?tar[=filename]
+GET <path>?tgz[=filename]
+GET <path>?zip[=filename]
+POST <path>?tar[=filename]
+POST <path>?tgz[=filename]
+POST <path>?zip[=filename]
 ```
 
 Example:

doc/zh-CN/api.md

@@ -55,10 +55,10 @@ GET <path>?download[&sort=key]
 ```
 为页面中的文件链接添加下载参数，使其可被下载，而不是显示其内容。
 
-# 下载文件
+# 下载单个文件
 通过输出`Content-Disposition`头，通知用户代理下载文件而不是显示其内容。
 ```
-GET <path/to/file>?download
+GET <path/to/file>?download[=filename]
 ```
 
 举例：
@@ -69,12 +69,12 @@ curl 'http://localhost/ghfs/file?download'
 # 以打包文件形式获取指定路径下的内容
 仅在“archive”选项启用时有效。
 ```
-GET <path>?tar
-GET <path>?tgz
-GET <path>?zip
-POST <path>?tar
-POST <path>?tgz
-POST <path>?zip
+GET <path>?tar[=filename]
+GET <path>?tgz[=filename]
+GET <path>?zip[=filename]
+POST <path>?tar[=filename]
+POST <path>?tgz[=filename]
+POST <path>?zip[=filename]
 ```
 
 举例：

src/serverHandler/archive.go

@@ -142,21 +142,10 @@ func (h *aliasHandler) archiveFiles(
 	session *sessionContext,
 	data *responseData,
 	selections []string,
-	fileSuffix string,
 	contentType string,
 	cbWriteFile archiveCallback,
 ) {
-	var itemName string
-	_, hasAlias := h.aliases.byUrlPath(session.vhostReqPath)
-	if hasAlias {
-		itemName = path.Base(session.vhostReqPath)
-	}
-	if len(itemName) == 0 || itemName == "/" {
-		itemName = data.ItemName
-	}
-
-	targetFilename := itemName + fileSuffix
-	writeArchiveHeader(w, contentType, targetFilename)
+	writeArchiveHeader(w, contentType, session.outFileName)
 
 	if !NeedResponseBody(r.Method) {
 		return
@@ -170,7 +159,7 @@ func (h *aliasHandler) archiveFiles(
 		data.Item != nil, // not empty root
 		selections,
 		func(f *os.File, fInfo os.FileInfo, relPath string) error {
-			h.logArchive(targetFilename, relPath, r)
+			h.logArchive(session.outFileName, relPath, r)
 			err := cbWriteFile(f, fInfo, relPath)
 			h.logError(err)
 			return err

src/serverHandler/archiveTar.go

@@ -77,8 +77,7 @@ func (h *aliasHandler) tar(w http.ResponseWriter, r *http.Request, session *sess
 		session,
 		data,
 		selections,
-		".tar",
-		"application/octet-stream",
+		"application/x-tar",
 		func(f *os.File, fInfo os.FileInfo, relPath string) error {
 			return writeTar(tw, f, fInfo, relPath)
 		},
@@ -120,8 +119,7 @@ func (h *aliasHandler) tgz(w http.ResponseWriter, r *http.Request, session *sess
 		session,
 		data,
 		selections,
-		".tar.gz",
-		"application/octet-stream",
+		"application/gzip",
 		func(f *os.File, fInfo os.FileInfo, relPath string) error {
 			return writeTar(tw, f, fInfo, relPath)
 		},

src/serverHandler/archiveZip.go

@@ -61,7 +61,6 @@ func (h *aliasHandler) zip(w http.ResponseWriter, r *http.Request, session *sess
 		session,
 		data,
 		selections,
-		".zip",
 		"application/zip",
 		func(f *os.File, fInfo os.FileInfo, relPath string) error {
 			return writeZip(zipWriter, f, fInfo, relPath)

src/serverHandler/auth.go

@@ -55,24 +55,18 @@ func (h *aliasHandler) verifyAuth(r *http.Request, vhostReqPath, reqFsPath strin
 }
 
 func (h *aliasHandler) extractNoAuthUrl(r *http.Request, session *sessionContext, data *responseData) string {
-	if session.query.Has(authQueryParam) {
-		returnUrl := session.query.Get(authQueryParam)
-
-		if len(returnUrl) > 0 {
-			url, err := url.QueryUnescape(returnUrl)
-			if err == nil {
-				returnUrl = url
-			}
-		}
-
-		if len(returnUrl) > 0 {
+	returnUrl, hasReturnUrl := getQueryValue(session.query, authQueryParam)
+	if hasReturnUrl && len(returnUrl) > 0 {
+		var err error
+		returnUrl, err = url.QueryUnescape(returnUrl)
+		if err == nil {
 			return returnUrl
 		}
 	}
 
-	referrer := r.Header.Get("Referer")
-	if len(referrer) > 0 {
-		return referrer
+	returnUrl = r.Header.Get("Referer")
+	if len(returnUrl) > 0 {
+		return returnUrl
 	}
 
 	return session.prefixReqPath + data.Context.QueryString()

src/serverHandler/content.go

@@ -10,7 +10,7 @@ func (h *aliasHandler) content(w http.ResponseWriter, r *http.Request, session *
 	header.Set("Vary", session.vary)
 	header.Set("X-Content-Type-Options", "nosniff")
 	if data.IsDownload {
-		filename := url.PathEscape(data.ItemName)
+		filename := url.PathEscape(session.outFileName)
 		header.Set("Content-Disposition", "attachment; filename="+filename+"; filename*=UTF-8''"+filename)
 	}
 

src/serverHandler/sessionData.go

@@ -84,6 +84,8 @@ type sessionContext struct {
 
 	query url.Values
 
+	outFileName string
+
 	errors []error
 }
 
@@ -110,7 +112,6 @@ type responseData struct {
 	RootRelPath string
 
 	Item          os.FileInfo
-	ItemName      string
 	SubItems      []os.FileInfo
 	AliasSubItems []os.FileInfo
 	SubItemsHtml  []itemHtml
@@ -267,7 +268,12 @@ func getSubItemPrefix(currDirRelPath, rawRequestPath string, tailSlash bool) str
 	}
 }
 
-func getItemName(info os.FileInfo, r *http.Request) (itemName string) {
+func getItemName(info os.FileInfo, r *http.Request, prefixReqPath string) (itemName string) {
+	itemName = path.Base(prefixReqPath)
+	if len(itemName) > 0 && itemName != "/" {
+		return
+	}
+
 	if info != nil {
 		itemName = info.Name()
 	}
@@ -359,10 +365,7 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 	fsPath := filepath.Clean(h.dir + reqPath)
 
 	query := r.URL.Query()
-	queryPrefix := r.URL.RawQuery
-	if querySepIndex := strings.IndexByte(queryPrefix, '&'); querySepIndex >= 0 {
-		queryPrefix = queryPrefix[:querySepIndex]
-	}
+	queryPrefix := getQueryPrefix(r.URL.RawQuery)
 
 	status := http.StatusOK
 
@@ -376,39 +379,6 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 
 	headers := h.getHeaders(vhostReqPath, fsPath, authSuccess)
 
-	isUpload := false
-	isMkdir := false
-	isDelete := false
-	isMutate := false
-	switch queryPrefix {
-	case "upload":
-		isUpload = true
-		isMutate = true
-	case "mkdir":
-		isMkdir = true
-		isMutate = true
-	case "delete":
-		isDelete = true
-		isMutate = true
-	}
-
-	isArchive := false
-	var arFmt archiveFormat
-	switch queryPrefix {
-	case "tar":
-		isArchive = true
-		arFmt = tarFmt
-	case "tgz":
-		isArchive = true
-		arFmt = tgzFmt
-	case "zip":
-		isArchive = true
-		arFmt = zipFmt
-	}
-
-	isSimple := query.Has("simple")
-	isDownload := query.Has("download")
-
 	accepts := acceptHeaders.ParseAccepts(r.Header.Get("Accept"))
 	acceptIndex, _, _ := accepts.GetPreferredValue(acceptContentTypes)
 	wantJson := acceptIndex == acceptJsonIndex
@@ -463,7 +433,60 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 
 	canIndex = canIndex && allowAccess
 
-	itemName := getItemName(item, r)
+	itemName := getItemName(item, r, prefixReqPath)
+
+	var outFileName string
+
+	isUpload := false
+	isMkdir := false
+	isDelete := false
+	isMutate := false
+	switch queryPrefix {
+	case "upload":
+		isUpload = true
+		isMutate = true
+	case "mkdir":
+		isMkdir = true
+		isMutate = true
+	case "delete":
+		isDelete = true
+		isMutate = true
+	}
+
+	isArchive := false
+	var arFmt archiveFormat
+	switch queryPrefix {
+	case "tar":
+		isArchive = true
+		arFmt = tarFmt
+		outFileName = ".tar"
+	case "tgz":
+		isArchive = true
+		arFmt = tgzFmt
+		outFileName = ".tar.tz"
+	case "zip":
+		isArchive = true
+		arFmt = zipFmt
+		outFileName = ".zip"
+	}
+	if isArchive {
+		arName, _ := getQueryValue(query, queryPrefix)
+		if len(arName) > 0 {
+			outFileName = arName
+		} else {
+			outFileName = itemName + outFileName
+		}
+	}
+
+	_, isSimple := query["simple"]
+	dlName, isDownload := getQueryValue(query, "download")
+	if isDownload {
+		if len(dlName) > 0 {
+			outFileName = dlName
+		} else {
+			outFileName = itemName
+		}
+	}
 
 	subItems, _readdirErr := readdir(file, item, canIndex && !isMutate && !isArchive && NeedResponseBody(r.Method))
 	if _readdirErr != nil {
@@ -536,6 +559,8 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 		isArchive:     isArchive,
 		archiveFormat: arFmt,
 
+		outFileName: outFileName,
+
 		file: file,
 
 		query: query,
@@ -565,7 +590,6 @@ func (h *aliasHandler) getSessionData(r *http.Request) (session *sessionContext,
 		RootRelPath: rootRelPath,
 
 		Item:          item,
-		ItemName:      itemName,
 		SubItems:      subItems,
 		AliasSubItems: aliasSubItems,
 		SubItemsHtml:  nil,

src/serverHandler/util.go

@@ -4,12 +4,40 @@ import (
 	"mjpclab.dev/ghfs/src/user"
 	"mjpclab.dev/ghfs/src/util"
 	"net/http"
+	"net/url"
 	"os"
 	"path"
 	"regexp"
 	"strings"
 )
 
+func getQueryPrefix(rawQuery string) (queryPrefix string) {
+	if len(rawQuery) == 0 {
+		return
+	}
+
+	queryPrefix = rawQuery
+
+	var querySepIndex int
+	if querySepIndex = strings.IndexByte(queryPrefix, '&'); querySepIndex >= 0 {
+		queryPrefix = queryPrefix[:querySepIndex]
+	}
+	if querySepIndex = strings.IndexByte(queryPrefix, '='); querySepIndex >= 0 {
+		queryPrefix = queryPrefix[:querySepIndex]
+	}
+
+	return
+}
+
+func getQueryValue(urlValues url.Values, key string) (value string, ok bool) {
+	var values []string
+	values, ok = urlValues[key]
+	if len(values) > 0 {
+		value = values[len(values)-1]
+	}
+	return
+}
+
 func pathUsernamesToPathUids(users *user.List, pathsUsernames [][]string) pathIntsList {
 	list := make(pathIntsList, 0, len(pathsUsernames))
 	for _, pathUsernames := range pathsUsernames {