H0llyW00dzZ/fiber
H0llyW00dzZ/fiber
1
0
Fork 0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-22 09:12:59 +00:00
Code Releases Activity

🧳 add maxAge to filesystem mw

Browse Source
This commit is contained in:
Fenny 2020-10-27 08:12:37 +01:00
parent e32cad80c8
commit 726600f577
2 changed files with 41 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
middleware/filesystem/README.md
View File

@ -34,9 +34,10 @@ app.Use(filesystem.New(filesystem.Config{
// Or extend your config for customization
app.Use(filesystem.New(filesystem.Config{
Root: http.Dir("./assets"),
Index: "index.html",
Browse: true,
NotFoundFile: "404.html"
Index: "index.html",
NotFoundFile: "404.html",
MaxAge: 3600,
}))
```
@ -179,22 +180,28 @@ type Config struct {
// to a collection of files and directories.
//
// Required. Default: nil
Root http.FileSystem
// Index file for serving a directory.
//
// Optional. Default: "index.html"
Index string
Root http.FileSystem `json:"-"`
// Enable directory browsing.
//
// Optional. Default: false
Browse bool
Browse bool `json:"browse"`
// Index file for serving a directory.
//
// Optional. Default: "index.html"
Index string `json:"index"`
// The value for the Cache-Control HTTP-header
// that is set on the file response. MaxAge is defined in seconds.
//
// Optional. Default value 0.
MaxAge int `json:"max_age"`
// File to return if path is not found. Useful for SPA's.
//
// Optional. Default: ""
NotFoundFile string
NotFoundFile string `json:"not_found_file"`
}
```
@ -203,7 +210,8 @@ type Config struct {
var ConfigDefault = Config{
Next: nil,
Root: nil,
Index: "/index.html",
Browse: false,
Index: "/index.html",
MaxAge: 0,
}
```

31
middleware/filesystem/filesystem.go
View File

@ -3,6 +3,7 @@ package filesystem
import (
"net/http"
"os"
"strconv"
"strings"
"sync"
@ -20,30 +21,38 @@ type Config struct {
// to a collection of files and directories.
//
// Required. Default: nil
Root http.FileSystem
// Index file for serving a directory.
//
// Optional. Default: "index.html"
Index string
Root http.FileSystem `json:"-"`
// Enable directory browsing.
//
// Optional. Default: false
Browse bool
Browse bool `json:"browse"`
// Index file for serving a directory.
//
// Optional. Default: "index.html"
Index string `json:"index"`
// The value for the Cache-Control HTTP-header
// that is set on the file response. MaxAge is defined in seconds.
//
// Optional. Default value 0.
MaxAge int `json:"max_age"`
maxAgeStr string
// File to return if path is not found. Useful for SPA's.
//
// Optional. Default: ""
NotFoundFile string
NotFoundFile string `json:"not_found_file"`
}
// ConfigDefault is the default config
var ConfigDefault = Config{
Next: nil,
Root: nil,
Index: "/index.html",
Browse: false,
Index: "/index.html",
MaxAge: 0,
}
// New creates a new middleware handler
@ -73,6 +82,7 @@ func New(config ...Config) fiber.Handler {
var once sync.Once
var prefix string
var cacheControlStr = "public, max-age=" + strconv.Itoa(cfg.MaxAge)
// Return new handler
return func(c *fiber.Ctx) (err error) {
@ -153,6 +163,9 @@ func New(config ...Config) fiber.Handler {
}
if method == fiber.MethodGet {
if cfg.MaxAge > 0 {
c.Set(fiber.HeaderCacheControl, cacheControlStr)
}
c.Response().SetBodyStream(file, contentLength)
return nil
}