feat(net/ghttp): skip binary contentType when parseBody (#4200)

net/ghttp/ghttp_request_param.go

@@ -10,6 +10,7 @@ import (
 	"bytes"
 	"fmt"
 	"io"
+	"mime"
 	"mime/multipart"
 	"net/http"
 	"reflect"
@@ -233,22 +234,46 @@ func (r *Request) parseBody() {
 	if r.ContentLength == 0 {
 		return
 	}
+	// If it's a multipart request, it does not parse the body content.
+	contentType := r.Header.Get("Content-Type")
+	if gstr.Contains(contentType, "multipart/") {
+		return
+	}
+
+	// Skip binary content types, which should not be parsed.
+	if r.isBinaryContentType(contentType) {
+		return
+	}
+
 	if body := r.GetBody(); len(body) > 0 {
 		// Trim space/new line characters.
 		body = bytes.TrimSpace(body)
-		// JSON format checks.
-		if body[0] == '{' && body[len(body)-1] == '}' {
+
+		// json/xml content type checks.
+		if gstr.Contains(contentType, "/json") {
 			_ = json.UnmarshalUseNumber(body, &r.bodyMap)
+			return
 		}
-		// XML format checks.
-		if len(body) > 5 && bytes.EqualFold(body[:5], xmlHeaderBytes) {
+		if gstr.Contains(contentType, "/xml") {
 			r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
+			return
 		}
-		if body[0] == '<' && body[len(body)-1] == '>' {
-			r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
+		// Auto decoding body content.
+		if r.Server.config.AutoDecodingBody {
+			// JSON format checks.
+			if body[0] == '{' && body[len(body)-1] == '}' {
+				_ = json.UnmarshalUseNumber(body, &r.bodyMap)
+			}
+			// XML format checks.
+			if len(body) > 5 && bytes.EqualFold(body[:5], xmlHeaderBytes) {
+				r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
+			}
+			if body[0] == '<' && body[len(body)-1] == '>' {
+				r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
+			}
 		}
 		// Default parameters decoding.
-		if contentType := r.Header.Get("Content-Type"); (contentType == "" || !gstr.Contains(contentType, "multipart/")) && r.bodyMap == nil {
+		if r.bodyMap == nil {
 			r.bodyMap, _ = gstr.Parse(r.GetBodyString())
 		}
 	}
@@ -383,3 +408,42 @@ func (r *Request) GetMultipartFiles(name string) []*multipart.FileHeader {
 	}
 	return nil
 }
+
+// isBinaryContentType check the content type is binary or not.
+func (r *Request) isBinaryContentType(contentType string) bool {
+	// parseMediaType
+	mimeType, _, err := mime.ParseMediaType(contentType)
+	// If the content type is invalid, it's treated as binary.
+	if err != nil {
+		return true
+	}
+
+	// Lowercase the MIME type for easier comparison
+	mimeType = strings.ToLower(mimeType)
+
+	// if the MIME type is text, then it's definitely not binary
+	if strings.HasPrefix(mimeType, "text/") {
+		return false
+	}
+
+	// defined non-binary MIME types
+	nonBinaryTypes := map[string]struct{}{
+		"application/json":                  {},
+		"application/xml":                   {},
+		"application/x-www-form-urlencoded": {},
+		"application/javascript":            {},
+		"application/xhtml+xml":             {},
+	}
+	if _, ok := nonBinaryTypes[mimeType]; ok {
+		return false
+	}
+
+	// if the MIME type is JSON or XML, it's definitely not binary
+	if strings.HasSuffix(mimeType, "+json") || strings.HasSuffix(mimeType, "+xml") {
+		return false
+	}
+
+	// otherwise, it's binary
+	// (this includes application/octet-stream、image/*、video/*、audio/*)
+	return true
+}

net/ghttp/ghttp_request_param_file.go

@@ -19,15 +19,9 @@ import (
 	"github.com/gogf/gf/v2/internal/json"
 	"github.com/gogf/gf/v2/os/gfile"
 	"github.com/gogf/gf/v2/os/gtime"
-	"github.com/gogf/gf/v2/util/gconv"
 	"github.com/gogf/gf/v2/util/grand"
 )
 
-// init initializes the type converters for *UploadFile.
-func init() {
-	_ = gconv.RegisterTypeConverterFunc(stringToUploadFile)
-}
-
 // UploadFile wraps the multipart uploading file with more and convenient features.
 type UploadFile struct {
 	*multipart.FileHeader `json:"-"`
@@ -42,18 +36,13 @@ func (f UploadFile) MarshalJSON() ([]byte, error) {
 // UploadFiles is an array type of *UploadFile.
 type UploadFiles []*UploadFile
 
-// stringToUploadFile is a custom type converter for converting string to *ghttp.UploadFile.
-func stringToUploadFile(in string) (*UploadFile, error) {
-	return &UploadFile{}, nil
-}
-
 // Save saves the single uploading file to directory path and returns the saved file name.
 //
 // The parameter `dirPath` should be a directory path, or it returns error.
 //
 // Note that it will OVERWRITE the target file if there's already a same name file exist.
 func (f *UploadFile) Save(dirPath string, randomlyRename ...bool) (filename string, err error) {
-	if f == nil || f.FileHeader == nil {
+	if f == nil {
 		return "", gerror.NewCode(
 			gcode.CodeMissingParameter,
 			"file is empty, maybe you retrieve it from invalid field name or form enctype",

net/ghttp/ghttp_server_config.go

@@ -205,7 +205,7 @@ type ServerConfig struct {
 	// Logging.
 	// ======================================================================================================
 
-	Logger           *glog.Logger `json:"logger"`           // Logger specifies the logger for server.
+	Logger           *glog.Logger `json:"logger"`           // Logger directly specifies the logger for server.
 	LogPath          string       `json:"logPath"`          // LogPath specifies the directory for storing logging files.
 	LogLevel         string       `json:"logLevel"`         // LogLevel specifies the logging level for logger.
 	LogStdout        bool         `json:"logStdout"`        // LogStdout specifies whether printing logging content to stdout.
@@ -267,6 +267,9 @@ type ServerConfig struct {
 
 	// DumpRouterMap specifies whether automatically dumps router map when server starts.
 	DumpRouterMap bool `json:"dumpRouterMap"`
+
+	// AutoDecodingBody specifies whether automatically decodes request body using common encoding types: json/xml.
+	AutoDecodingBody bool `json:"auto_decoding_body"`
 }
 
 // NewConfig creates and returns a ServerConfig object with default configurations.
@@ -313,6 +316,7 @@ func NewConfig() ServerConfig {
 		Graceful:                false,
 		GracefulTimeout:         2, // seconds
 		GracefulShutdownTimeout: 5, // seconds
+		AutoDecodingBody:        true,
 	}
 }
 

net/ghttp/ghttp_z_unit_issue_test.go

@@ -19,7 +19,6 @@ import (
 	"github.com/gogf/gf/v2/net/ghttp"
 	"github.com/gogf/gf/v2/test/gtest"
 	"github.com/gogf/gf/v2/text/gstr"
-	"github.com/gogf/gf/v2/util/gmeta"
 	"github.com/gogf/gf/v2/util/gtag"
 	"github.com/gogf/gf/v2/util/guid"
 )
@@ -727,30 +726,3 @@ func Test_Issue4093(t *testing.T) {
 		t.Assert(client.PostContent(ctx, "/test"), `{"page":1,"pageSize":10,"pagination":true,"name":"john","number":1}`)
 	})
 }
-
-// https://github.com/gogf/gf/issues/4193
-func Test_Issue4193(t *testing.T) {
-	type Req struct {
-		gmeta.Meta `method:"post" mime:"multipart/form-data"`
-		File       ghttp.UploadFile `v:"required" type:"file"`
-	}
-	type Res struct{}
-	s := g.Server(guid.S())
-	s.BindMiddlewareDefault(ghttp.MiddlewareHandlerResponse)
-	s.BindHandler("/upload/single", func(ctx context.Context, req *Req) (res *Res, err error) {
-		return
-	})
-	s.SetDumpRouterMap(false)
-	s.Start()
-	defer s.Shutdown()
-	time.Sleep(100 * time.Millisecond)
-	// normal name
-	gtest.C(t, func(t *gtest.T) {
-		client := g.Client()
-		client.SetPrefix(fmt.Sprintf("http://127.0.0.1:%d", s.GetListenedPort()))
-		content := client.PostContent(ctx, "/upload/single", g.Map{
-			"file": "",
-		})
-		t.Assert(content, "{\"code\":51,\"message\":\"The File field is required\",\"data\":null}")
-	})
-}