feat(middleware/return): render page by StatusPage midware

Author: marjune163

README.md

@@ -41,11 +41,10 @@ This means it is impossible to use legacy Go version to compile binaries for leg
     Use `$0` to represent the whole match in `match`.
     use `$1` - `$9` to represent sub matches in `match`.
 
---return <separator><match><separator><status-code>[<separator><fs-path>]
+--return <separator><match><separator><status-code>
     When request URL (in the form of "/request/path?param=value")
     is matched by `match`, return the status code `status-code`
     immediately and stop processing.
-    Optional response page content is specified by `fs-path`.
 
 --status-page <separator><status-code><separator><fs-path>
     When response status is `status-code`, respond with the file content from `fs-path`.
@@ -57,6 +56,7 @@ This means it is impossible to use legacy Go version to compile binaries for leg
 - `--redirect` executed if URL matched, and stop processing.
 - `--proxy` executed if URL matched, and stop processing.
 - `--return` executed if URL matched, and stop processing.
+- `--status-page` executed if status code matched, and stop processing.
 
 ## Examples
 

README.zh-CN.md

@@ -41,10 +41,9 @@ Extra HTTP File Server基于Go HTTP File Server，附带额外功能。
     使用`$0`表示`match`的完整匹配。
     使用`$1`-`$9`来表示`match`中的子匹配。
 
---return <分隔符><match><分隔符><status-code>[<分隔符><fs-path>]
+--return <分隔符><match><分隔符><status-code>
     当请求的URL（“/request/path?param=value”的形式）匹配正则表达式`match`时，
     立即返回状态码`status-code`并停止处理。
-    可选的`fs-path`用于指定返回页面的内容。
 
 --status-page <分隔符><status-code><分隔符><fs-path>
     当响应状态码为`status-code`时，用文件`fs-path`的内容来响应。
@@ -56,6 +55,7 @@ Extra HTTP File Server基于Go HTTP File Server，附带额外功能。
 - 如果URL匹配，执行`--redirect`并停止处理。
 - 如果URL匹配，执行`--proxy`并停止处理。
 - 如果URL匹配，执行`--return`并停止处理。
+- 如果状态码匹配，执行`--status-page`并停止处理。
 
 ## 举例
 

src/middleware/main.go

@@ -12,6 +12,18 @@ var errInvalidParamValue = errors.New("invalid param value")
 var errParamCountNotMatch = errors.New("base-param count is not equal to param count")
 
 func ParamToMiddlewares(baseParam *baseParam.Param, param *param.Param) (preMids, postMids []middleware.Middleware, errs []error) {
+	var statusPageMids []middleware.Middleware
+
+	// status pages
+	for i := range param.StatusPages {
+		mid, err := getStatusPageMiddleware(param.StatusPages[i])
+		errs = serverError.AppendError(errs, err)
+		if mid != nil {
+			statusPageMids = append(statusPageMids, mid)
+			postMids = append(postMids, mid)
+		}
+	}
+
 	// rewrites
 	for i := range param.Rewrites {
 		mid, err := getRewriteMiddleware(param.Rewrites[i])
@@ -41,22 +53,13 @@ func ParamToMiddlewares(baseParam *baseParam.Param, param *param.Param) (preMids
 
 	// returns
 	for i := range param.Returns {
-		mid, err := getReturnStatusMiddleware(param.Returns[i])
+		mid, err := getReturnStatusMiddleware(param.Returns[i], statusPageMids)
 		errs = serverError.AppendError(errs, err)
 		if mid != nil {
 			preMids = append(preMids, mid)
 		}
 	}
 
-	// status pages
-	for i := range param.StatusPages {
-		mid, err := getStatusPageMiddleware(param.StatusPages[i])
-		errs = serverError.AppendError(errs, err)
-		if mid != nil {
-			postMids = append(postMids, mid)
-		}
-	}
-
 	return
 }
 

src/middleware/return.go

@@ -1,20 +1,16 @@
 package middleware
 
 import (
-	"io"
-	"mjpclab.dev/ehfs/src/util"
 	"mjpclab.dev/ghfs/src/middleware"
 	"net/http"
-	"os"
 	"regexp"
 	"strconv"
 )
 
-func getReturnStatusMiddleware(arg [3]string) (middleware.Middleware, error) {
+func getReturnStatusMiddleware(arg [2]string, statusPageMids []middleware.Middleware) (middleware.Middleware, error) {
 	var err error
 	var reMatch *regexp.Regexp
 	var code int
-	var filename string
 
 	reMatch, err = regexp.Compile(arg[0])
 	if err != nil {
@@ -24,7 +20,6 @@ func getReturnStatusMiddleware(arg [3]string) (middleware.Middleware, error) {
 	if err != nil {
 		return nil, err
 	}
-	filename = arg[2]
 
 	return func(w http.ResponseWriter, r *http.Request, context *middleware.Context) (result middleware.ProcessResult) {
 		requestURI := r.URL.RequestURI() // request uri without prefix path
@@ -33,23 +28,11 @@ func getReturnStatusMiddleware(arg [3]string) (middleware.Middleware, error) {
 		}
 
 		result = middleware.Processed
-
 		w.WriteHeader(code)
-
-		if len(filename) > 0 {
-			file, err := os.Open(filename)
-			if err != nil {
-				util.LogError(context.Logger, err)
-				return
-			}
-
-			_, err = io.Copy(w, file)
-			if err != nil {
-				util.LogError(context.Logger, err)
-			}
-			err = file.Close()
-			if err != nil {
-				util.LogError(context.Logger, err)
+		context.Status = code
+		for i := range statusPageMids {
+			if statusPageMids[i](w, r, context) != middleware.GoNext {
+				break
 			}
 		}
 		return

src/middleware/return_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestReturnStatus(t *testing.T) {
-	mid, err := getReturnStatusMiddleware([3]string{`/doc`, "404", "/tmp/asdf"})
+	mid, err := getReturnStatusMiddleware([2]string{`/doc`, "404"}, nil)
 	if err != nil {
 		t.FailNow()
 	}

src/param/cli.go

@@ -57,12 +57,8 @@ func CmdResultsToParams(results []*goNixArgParser.ParseResult) (params []*Param,
 		param.Proxies = baseParam.SplitAllKeyValue(proxies)
 
 		// returns
-		strReturns, _ := result.GetStrings("returns")
-		returns := baseParam.SplitAllKeyValues(strReturns)
-		param.Returns = make([][3]string, len(returns))
-		for i := range returns {
-			copy(param.Returns[i][:], returns[i])
-		}
+		returns, _ := result.GetStrings("returns")
+		param.Returns = baseParam.SplitAllKeyValue(returns)
 
 		// status pages
 		statusPages, _ := result.GetStrings("statuspages")

src/param/main.go

@@ -12,8 +12,8 @@ type Param struct {
 	Redirects [][3]string
 	// value: [match, replace]
 	Proxies [][2]string
-	// value: [match, code, file?]
-	Returns [][3]string
+	// value: [match, code]
+	Returns [][2]string
 
 	// value: [code, file]
 	StatusPages [][2]string
@@ -38,20 +38,4 @@ func (param *Param) normalize() {
 		redirects = append(redirects, param.Redirects[i])
 	}
 	param.Redirects = redirects
-
-	// returns
-	returns := make([][3]string, 0, len(param.Returns))
-	for i := range param.Returns {
-		if len(param.Returns[i][0]) == 0 || len(param.Returns[i][1]) == 0 {
-			continue
-		}
-		code, err := strconv.Atoi(param.Returns[i][1])
-		if err != nil {
-			continue
-		}
-		param.Returns[i][1] = strconv.Itoa(code)
-
-		returns = append(returns, param.Returns[i])
-	}
-	param.Returns = returns
 }