[Feature]: Add filesystem config contentTypeCharset support (#2438)

* Update filesystem.go * Update filesystem_test.go * Update filesystem.md * fmt
gofiber · May 2, 2023 · 3c3f12b · 3c3f12b
1 parent 3a7dbd0
commit 3c3f12b
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 15 deletions.
diff --git a/docs/api/middleware/filesystem.md b/docs/api/middleware/filesystem.md
@@ -249,13 +249,13 @@ type Config struct {
     // Required. Default: nil
     Root http.FileSystem `json:"-"`
 
-	// PathPrefix defines a prefix to be added to a filepath when
-	// reading a file from the FileSystem.
-	//
-	// Use when using Go 1.16 embed.FS
-	//
-	// Optional. Default ""
-	PathPrefix string `json:"path_prefix"`
+    // PathPrefix defines a prefix to be added to a filepath when
+    // reading a file from the FileSystem.
+    //
+    // Use when using Go 1.16 embed.FS
+    //
+    // Optional. Default ""
+    PathPrefix string `json:"path_prefix"`
 
     // Enable directory browsing.
     //
@@ -277,6 +277,12 @@ type Config struct {
     //
     // Optional. Default: ""
     NotFoundFile string `json:"not_found_file"`
+
+    // The value for the Content-Type HTTP-header
+    // that is set on the file response
+    //
+    // Optional. Default: ""
+    ContentTypeCharset string `json:"content_type_charset"`
 }
 ```
 
@@ -286,9 +292,10 @@ type Config struct {
 var ConfigDefault = Config{
     Next:   nil,
     Root:   nil,
-	PathPrefix: "",
+    PathPrefix: "",
     Browse: false,
     Index:  "/index.html",
     MaxAge: 0,
+    ContentTypeCharset: "",
 }
 ```
diff --git a/middleware/filesystem/filesystem.go b/middleware/filesystem/filesystem.go
@@ -53,16 +53,23 @@ type Config struct {
 	//
 	// Optional. Default: ""
 	NotFoundFile string `json:"not_found_file"`
+
+	// The value for the Content-Type HTTP-header
+	// that is set on the file response
+	//
+	// Optional. Default: ""
+	ContentTypeCharset string `json:"content_type_charset"`
 }
 
 // ConfigDefault is the default config
 var ConfigDefault = Config{
-	Next:       nil,
-	Root:       nil,
-	PathPrefix: "",
-	Browse:     false,
-	Index:      "/index.html",
-	MaxAge:     0,
+	Next:               nil,
+	Root:               nil,
+	PathPrefix:         "",
+	Browse:             false,
+	Index:              "/index.html",
+	MaxAge:             0,
+	ContentTypeCharset: "",
 }
 
 // New creates a new middleware handler.
@@ -176,7 +183,11 @@ func New(config ...Config) fiber.Handler {
 		contentLength := int(stat.Size())
 
 		// Set Content Type header
-		c.Type(getFileExtension(stat.Name()))
+		if cfg.ContentTypeCharset == "" {
+			c.Type(getFileExtension(stat.Name()))
+		} else {
+			c.Type(getFileExtension(stat.Name()), cfg.ContentTypeCharset)
+		}
 
 		// Set Last Modified header
 		if !modTime.IsZero() {

diff --git a/middleware/filesystem/filesystem_test.go b/middleware/filesystem/filesystem_test.go
@@ -218,3 +218,17 @@ func Test_FileSystem_UsingParam_NonFile(t *testing.T) {
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, 404, resp.StatusCode)
 }
+
+func Test_FileSystem_UsingContentTypeCharset(t *testing.T) {
+	t.Parallel()
+	app := fiber.New()
+	app.Use(New(Config{
+		Root:               http.Dir("../../.github/testdata/fs/index.html"),
+		ContentTypeCharset: "UTF-8",
+	}))
+
+	resp, err := app.Test(httptest.NewRequest(fiber.MethodGet, "/", nil))
+	utils.AssertEqual(t, nil, err)
+	utils.AssertEqual(t, 200, resp.StatusCode)
+	utils.AssertEqual(t, "text/html; charset=UTF-8", resp.Header.Get("Content-Type"))
+}