Fix lint and move some methods to base context from context

Author: lunny

modules/context/base.go

@@ -7,6 +7,7 @@ package context
 import (
 	"net/http"
 	"net/url"
+	"path"
 	"strconv"
 	"strings"
 	"time"
@@ -18,12 +19,14 @@ import (
 	chi "github.com/go-chi/chi/v5"
 )
 
+// BaseContext represents a general context for some simple routes
 type BaseContext struct {
 	Resp ResponseWriter
 	Req  *http.Request
 	Data map[string]interface{}
 }
 
+// NewBaseContext creates a new base context
 func NewBaseContext(resp http.ResponseWriter, req *http.Request, data map[string]interface{}) *BaseContext {
 	return &BaseContext{
 		Resp: NewResponse(resp),
@@ -144,6 +147,25 @@ func (ctx *BaseContext) QueryOptionalBool(key string, defaults ...util.OptionalB
 	return (*Forms)(ctx.Req).MustOptionalBool(key, defaults...)
 }
 
+// Error returned an error to web browser
+func (ctx *BaseContext) Error(status int, contents ...string) {
+	var v = http.StatusText(status)
+	if len(contents) > 0 {
+		v = contents[0]
+	}
+	http.Error(ctx.Resp, v, status)
+}
+
+// Redirect redirect the request
+func (ctx *BaseContext) Redirect(location string, status ...int) {
+	code := http.StatusFound
+	if len(status) == 1 {
+		code = status[0]
+	}
+
+	http.Redirect(ctx.Resp, ctx.Req, location, code)
+}
+
 // JSON render content as JSON
 func (ctx *BaseContext) JSON(status int, content interface{}) {
 	ctx.Resp.Header().Set("Content-Type", "application/json;charset=utf-8")
@@ -163,3 +185,21 @@ func (ctx *BaseContext) PlainText(status int, bs []byte) {
 		ctx.Status(500)
 	}
 }
+
+// ServeFile serves given file to response.
+func (ctx *BaseContext) ServeFile(file string, names ...string) {
+	var name string
+	if len(names) > 0 {
+		name = names[0]
+	} else {
+		name = path.Base(file)
+	}
+	ctx.Resp.Header().Set("Content-Description", "File Transfer")
+	ctx.Resp.Header().Set("Content-Type", "application/octet-stream")
+	ctx.Resp.Header().Set("Content-Disposition", "attachment; filename="+name)
+	ctx.Resp.Header().Set("Content-Transfer-Encoding", "binary")
+	ctx.Resp.Header().Set("Expires", "0")
+	ctx.Resp.Header().Set("Cache-Control", "must-revalidate")
+	ctx.Resp.Header().Set("Pragma", "public")
+	http.ServeFile(ctx.Resp, ctx.Req, file)
+}

modules/context/context.go

@@ -317,7 +317,8 @@ func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interfa
 	http.ServeContent(ctx.Resp, ctx.Req, name, modtime, r)
 }
 
-// PlainText render content as plain text
+// PlainText render content as plain text, this will override basecontext's method
+// because we need a beautiful failed page
 func (ctx *Context) PlainText(status int, bs []byte) {
 	ctx.Resp.WriteHeader(status)
 	ctx.Resp.Header().Set("Content-Type", "text/plain;charset=utf-8")
@@ -326,24 +327,6 @@ func (ctx *Context) PlainText(status int, bs []byte) {
 	}
 }
 
-// ServeFile serves given file to response.
-func (ctx *Context) ServeFile(file string, names ...string) {
-	var name string
-	if len(names) > 0 {
-		name = names[0]
-	} else {
-		name = path.Base(file)
-	}
-	ctx.Resp.Header().Set("Content-Description", "File Transfer")
-	ctx.Resp.Header().Set("Content-Type", "application/octet-stream")
-	ctx.Resp.Header().Set("Content-Disposition", "attachment; filename="+name)
-	ctx.Resp.Header().Set("Content-Transfer-Encoding", "binary")
-	ctx.Resp.Header().Set("Expires", "0")
-	ctx.Resp.Header().Set("Cache-Control", "must-revalidate")
-	ctx.Resp.Header().Set("Pragma", "public")
-	http.ServeFile(ctx.Resp, ctx.Req, file)
-}
-
 // ServeStream serves file via io stream
 func (ctx *Context) ServeStream(rd io.Reader, name string) {
 	ctx.Resp.Header().Set("Content-Description", "File Transfer")
@@ -359,25 +342,6 @@ func (ctx *Context) ServeStream(rd io.Reader, name string) {
 	}
 }
 
-// Error returned an error to web browser
-func (ctx *Context) Error(status int, contents ...string) {
-	var v = http.StatusText(status)
-	if len(contents) > 0 {
-		v = contents[0]
-	}
-	http.Error(ctx.Resp, v, status)
-}
-
-// Redirect redirect the request
-func (ctx *Context) Redirect(location string, status ...int) {
-	code := http.StatusFound
-	if len(status) == 1 {
-		code = status[0]
-	}
-
-	http.Redirect(ctx.Resp, ctx.Req, location, code)
-}
-
 // SetCookie convenience function to set most cookies consistently
 // CSRF and a few others are the exception here
 func (ctx *Context) SetCookie(name, value string, expiry int) {