feat: add option --force-dir-slash

Use this option to force redirect directory list page without "/"
suffix in the URL to the URL with the suffix.

Author: marjune163

README.md

@@ -116,6 +116,10 @@ ghfs [options]
     Could be useful if server is behind a reverse proxy and
     received the request without proxying path stripped.
 
+-/|--force-dir-slash [<status-code>=301]
+    If a directory list page is requested without tailing "/" in the URL,
+    redirect to the URL with the suffix.
+
 --default-sort <sortBy>
     Default sort rule for files and directories.
     Available sort key:

README.zh-CN.md

@@ -114,6 +114,9 @@ ghfs [选项]
     在指定的URL子路径下提供服务。
     如果服务器在反向代理之后，且收到的请求并未去除代理路径前缀，可能较有用。
 
+-/|--force-dir-slash [<状态码>=301]
+    如果在请求目录列表页时URL没有以“/”结尾，重定向到带有该结尾的URL。
+
 --default-sort <排序规则>
     指定文件和目录的默认排序规则。
     可用的排序key：

src/param/cli.go

@@ -30,6 +30,9 @@ func init() {
 	err = options.AddFlagValues("prefixurls", "--prefix", "", nil, "serve files under URL path instead of /")
 	serverErrHandler.CheckFatal(err)
 
+	err = options.AddFlagsValue("forcedirslash", []string{"-/", "--force-dir-slash"}, "GHFS_FORCE_DIR_SLASH", "", "auto redirect directory with \"/\" suffix")
+	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- `e` sort by type(suffix) ascending\n- `E` sort by type(suffix) 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)
@@ -293,6 +296,12 @@ func doParseCli() []*Param {
 		prefixurls, _ := result.GetStrings("prefixurls")
 		param.PrefixUrls = normalizeUrlPaths(prefixurls)
 
+		// force dir slash
+		if result.HasKey("forcedirslash") {
+			forceDirSlash, _ := result.GetString("forcedirslash")
+			param.ForceDirSlash = normalizeRedirectCode(forceDirSlash)
+		}
+
 		// dir indexes
 		dirIndexes, _ := result.GetStrings("dirindexes")
 		param.DirIndexes = normalizeFilenames(dirIndexes)

src/param/main.go

@@ -15,7 +15,8 @@ type Param struct {
 	Root      string
 	EmptyRoot bool
 
-	PrefixUrls []string
+	PrefixUrls    []string
+	ForceDirSlash int
 
 	DefaultSort string
 	DirIndexes  []string

src/param/strUtil.go

@@ -3,6 +3,7 @@ package param
 import (
 	"../util"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"unicode/utf8"
 )
@@ -295,3 +296,11 @@ func normalizeHttpsPort(httpsPort string, ListensTLS []string) (string, bool) {
 
 	return "", false
 }
+
+func normalizeRedirectCode(input string) int {
+	code, _ := strconv.Atoi(input)
+	if code <= 300 || code > 399 {
+		return 301
+	}
+	return code
+}

src/serverHandler/handler.go

@@ -21,13 +21,14 @@ type pathStrings struct {
 }
 
 type handler struct {
-	root        string
-	emptyRoot   bool
-	globalHsts  bool
-	globalHttps bool
-	httpsPort   string // with prefix ":"
-	defaultSort string
-	aliasPrefix string
+	root          string
+	emptyRoot     bool
+	forceDirSlash int
+	globalHsts    bool
+	globalHttps   bool
+	httpsPort     string // with prefix ":"
+	defaultSort   string
+	aliasPrefix   string
 
 	dirIndexes []string
 	aliases    aliases
@@ -129,6 +130,11 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	if data.NeedDirSlashRedirect {
+		h.redirectWithSlashSuffix(w, r, data.prefixReqPath)
+		return
+	}
+
 	header(w, data.Headers)
 
 	if data.CanCors {
@@ -194,14 +200,15 @@ func newHandler(
 	}
 
 	h := &handler{
-		root:        root,
-		emptyRoot:   emptyRoot,
-		globalHsts:  p.GlobalHsts,
-		globalHttps: p.GlobalHttps,
-		httpsPort:   p.HttpsPort,
-		defaultSort: p.DefaultSort,
-		aliasPrefix: aliasPrefix,
-		aliases:     aliases,
+		root:          root,
+		emptyRoot:     emptyRoot,
+		forceDirSlash: p.ForceDirSlash,
+		globalHsts:    p.GlobalHsts,
+		globalHttps:   p.GlobalHttps,
+		httpsPort:     p.HttpsPort,
+		defaultSort:   p.DefaultSort,
+		aliasPrefix:   aliasPrefix,
+		aliases:       aliases,
 
 		dirIndexes: p.DirIndexes,
 

src/serverHandler/redirect.go

@@ -0,0 +1,12 @@
+package serverHandler
+
+import "net/http"
+
+func (h *handler) redirectWithSlashSuffix(w http.ResponseWriter, r *http.Request, pathWithoutSlashSuffix string) {
+	target := pathWithoutSlashSuffix + "/"
+	if len(r.URL.RawQuery) > 0 {
+		target += "?" + r.URL.RawQuery
+	}
+
+	http.Redirect(w, r, target, h.forceDirSlash)
+}

src/serverHandler/responseData.go

@@ -25,6 +25,7 @@ type itemHtml struct {
 }
 
 type responseData struct {
+	prefixReqPath  string
 	rawReqPath     string
 	handlerReqPath string
 
@@ -68,6 +69,8 @@ type responseData struct {
 	SortState     SortState
 	Context       *pathContext
 
+	NeedDirSlashRedirect bool
+
 	Lang  string
 	Trans *i18n.Translation
 }
@@ -191,9 +194,9 @@ func (h *handler) mergeAlias(
 	return subItems, aliasSubItems, errs
 }
 
-func getCurrDirRelPath(reqPath, rawReqPath string) string {
-	if len(reqPath) == 1 && len(rawReqPath) > 1 && rawReqPath[len(rawReqPath)-1] != '/' {
-		return "./" + path.Base(rawReqPath) + "/"
+func getCurrDirRelPath(reqPath, prefixReqPath string) string {
+	if len(reqPath) == 1 && len(prefixReqPath) > 1 && prefixReqPath[len(prefixReqPath)-1] != '/' {
+		return "./" + path.Base(prefixReqPath) + "/"
 	} else {
 		return "./"
 	}
@@ -291,6 +294,7 @@ func dereferenceSymbolLinks(reqFsPath string, subItems []os.FileInfo) (errs []er
 func (h *handler) getResponseData(r *http.Request) *responseData {
 	var errs []error
 
+	prefixReqPath := r.URL.RawPath
 	rawReqPath := r.URL.Path
 	tailSlash := rawReqPath[len(rawReqPath)-1] == '/'
 
@@ -334,7 +338,7 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 	status := http.StatusOK
 	isRoot := rawReqPath == "/"
 
-	currDirRelPath := getCurrDirRelPath(rawReqPath, r.URL.RawPath)
+	currDirRelPath := getCurrDirRelPath(rawReqPath, prefixReqPath)
 	pathEntries := getPathEntries(currDirRelPath, rawReqPath, tailSlash)
 	var rootRelPath string
 	if len(pathEntries) > 0 {
@@ -349,7 +353,9 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 		status = getStatusByErr(_statErr)
 	}
 
-	indexFile, indexItem, _statIdxErr := h.statIndexFile(rawReqPath, reqFsPath, item, authSuccess)
+	needDirSlashRedirect := h.forceDirSlash > 0 && prefixReqPath[len(prefixReqPath)-1] != '/' && !shouldServeAsContent(file, item)
+
+	indexFile, indexItem, _statIdxErr := h.statIndexFile(rawReqPath, reqFsPath, item, authSuccess && !needDirSlashRedirect)
 	if _statIdxErr != nil {
 		errs = append(errs, _statIdxErr)
 		status = getStatusByErr(_statIdxErr)
@@ -367,13 +373,13 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 
 	itemName := getItemName(item, r)
 
-	subItems, _readdirErr := readdir(file, item, authSuccess && !isMutate && allowAccess && needResponseBody(r.Method))
+	subItems, _readdirErr := readdir(file, item, authSuccess && !isMutate && !needDirSlashRedirect && allowAccess && needResponseBody(r.Method))
 	if _readdirErr != nil {
 		errs = append(errs, _readdirErr)
 		status = http.StatusInternalServerError
 	}
 
-	subItems, aliasSubItems, _mergeErrs := h.mergeAlias(rawReqPath, item, subItems, authSuccess && allowAccess)
+	subItems, aliasSubItems, _mergeErrs := h.mergeAlias(rawReqPath, item, subItems, authSuccess && !needDirSlashRedirect && allowAccess)
 	if len(_mergeErrs) > 0 {
 		errs = append(errs, _mergeErrs...)
 		status = http.StatusInternalServerError
@@ -407,6 +413,7 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 	}
 
 	return &responseData{
+		prefixReqPath:  prefixReqPath,
 		rawReqPath:     rawReqPath,
 		handlerReqPath: reqPath,
 
@@ -449,5 +456,7 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 		SubItemPrefix: subItemPrefix,
 		SortState:     sortState,
 		Context:       context,
+
+		NeedDirSlashRedirect: needDirSlashRedirect,
 	}
 }

test/case/011.upload.bash

@@ -6,7 +6,7 @@ cleanup() {
 
 source "$root"/lib.bash
 
-"$ghfs" -l 3003 -r "$fs"/uploaded --upload /1 --upload-dir "$fs"/uploaded/2 --mkdir /2 2>/dev/null &
+"$ghfs" -l 3003 -r "$fs"/uploaded --upload /1 --upload-dir "$fs"/uploaded/2 --mkdir /2 -E '' &
 sleep 0.05 # wait server ready
 cleanup
 

test/case/012.alias.upload.bash

@@ -7,7 +7,7 @@ cleanup() {
 
 source "$root"/lib.bash
 
-"$ghfs" -l 3003 -r "$fs"/vhost1 --alias :/my/upload:"$fs"/uploaded/2 --upload / --mkdir / &> /dev/null &
+"$ghfs" -l 3003 -r "$fs"/vhost1 --alias :/my/upload:"$fs"/uploaded/2 --upload / --mkdir / -E '' &
 sleep 0.05 # wait server ready
 cleanup