mirror of
https://github.com/labstack/echo.git
synced 2025-04-27 12:32:09 +02:00
Removed static middleware in favor of Echo#Static
Signed-off-by: Vishal Rana <vr@labstack.com>
This commit is contained in:
parent
a739d9a0d9
commit
c978ff6431
@ -1,145 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"path"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/labstack/echo"
|
|
||||||
)
|
|
||||||
|
|
||||||
type (
|
|
||||||
// StaticConfig defines the config for Static middleware.
|
|
||||||
StaticConfig struct {
|
|
||||||
// Skipper defines a function to skip middleware.
|
|
||||||
Skipper Skipper
|
|
||||||
|
|
||||||
// Prefix to strip from the request URL path. Typically used with `Echo#Group`.
|
|
||||||
// Optional. Default value "".
|
|
||||||
Prefix string `json:"root"`
|
|
||||||
|
|
||||||
// Root directory from where the static content is served.
|
|
||||||
// Required.
|
|
||||||
Root string `json:"root"`
|
|
||||||
|
|
||||||
// Index file for serving a directory.
|
|
||||||
// Optional. Default value "index.html".
|
|
||||||
Index string `json:"index"`
|
|
||||||
|
|
||||||
// Enable HTML5 mode by forwarding all not-found requests to root so that
|
|
||||||
// SPA (single-page application) can handle the routing.
|
|
||||||
// Optional. Default value false.
|
|
||||||
HTML5 bool `json:"html5"`
|
|
||||||
|
|
||||||
// Enable directory browsing.
|
|
||||||
// Optional. Default value false.
|
|
||||||
Browse bool `json:"browse"`
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// DefaultStaticConfig is the default Static middleware config.
|
|
||||||
DefaultStaticConfig = StaticConfig{
|
|
||||||
Skipper: defaultSkipper,
|
|
||||||
Index: "index.html",
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
// Static returns a Static middleware to serves static content from the provided
|
|
||||||
// root directory.
|
|
||||||
func Static(root string) echo.MiddlewareFunc {
|
|
||||||
c := DefaultStaticConfig
|
|
||||||
c.Root = root
|
|
||||||
return StaticWithConfig(c)
|
|
||||||
}
|
|
||||||
|
|
||||||
// StaticWithConfig returns a Static middleware with config.
|
|
||||||
// See `Static()`.
|
|
||||||
func StaticWithConfig(config StaticConfig) echo.MiddlewareFunc {
|
|
||||||
// Defaults
|
|
||||||
if config.Skipper == nil {
|
|
||||||
config.Skipper = DefaultStaticConfig.Skipper
|
|
||||||
}
|
|
||||||
if config.Index == "" {
|
|
||||||
config.Index = DefaultStaticConfig.Index
|
|
||||||
}
|
|
||||||
|
|
||||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
||||||
return func(c echo.Context) error {
|
|
||||||
if config.Skipper(c) {
|
|
||||||
return next(c)
|
|
||||||
}
|
|
||||||
|
|
||||||
fs := http.Dir(config.Root)
|
|
||||||
p := strings.TrimPrefix(c.Request().URL.Path, config.Prefix)
|
|
||||||
file := path.Clean(p)
|
|
||||||
f, err := fs.Open(file)
|
|
||||||
if err != nil {
|
|
||||||
// HTML5 mode
|
|
||||||
err = next(c)
|
|
||||||
if he, ok := err.(*echo.HTTPError); ok {
|
|
||||||
if config.HTML5 && he.Code == http.StatusNotFound {
|
|
||||||
file = ""
|
|
||||||
f, err = fs.Open(file)
|
|
||||||
} else {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
defer f.Close()
|
|
||||||
fi, err := f.Stat()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if fi.IsDir() {
|
|
||||||
/* NOTE:
|
|
||||||
Not checking the Last-Modified header as it caches the response `304` when
|
|
||||||
changing different directories for the same path.
|
|
||||||
*/
|
|
||||||
d := f
|
|
||||||
|
|
||||||
// Index file
|
|
||||||
file = path.Join(file, config.Index)
|
|
||||||
f, err = fs.Open(file)
|
|
||||||
if err == nil {
|
|
||||||
// Index file
|
|
||||||
if fi, err = f.Stat(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
} else if err != nil && config.Browse {
|
|
||||||
dirs, err := d.Readdir(-1)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create a directory index
|
|
||||||
res := c.Response()
|
|
||||||
res.Header().Set(echo.HeaderContentType, echo.MIMETextHTMLCharsetUTF8)
|
|
||||||
if _, err = fmt.Fprintf(res, "<pre>\n"); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
for _, d := range dirs {
|
|
||||||
name := d.Name()
|
|
||||||
color := "#212121"
|
|
||||||
if d.IsDir() {
|
|
||||||
color = "#e91e63"
|
|
||||||
name += "/"
|
|
||||||
}
|
|
||||||
if _, err = fmt.Fprintf(res, "<a href=\"%s\" style=\"color: %s;\">%s</a>\n", name, color, name); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_, err = fmt.Fprintf(res, "</pre>\n")
|
|
||||||
return err
|
|
||||||
} else {
|
|
||||||
return next(c)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return c.ServeContent(f, fi.Name(), fi.ModTime())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,67 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/labstack/echo"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestStatic(t *testing.T) {
|
|
||||||
e := echo.New()
|
|
||||||
req, _ := http.NewRequest(echo.GET, "/", nil)
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
c := e.NewContext(req, rec)
|
|
||||||
h := Static("../_fixture")(func(c echo.Context) error {
|
|
||||||
return echo.ErrNotFound
|
|
||||||
})
|
|
||||||
|
|
||||||
// Directory
|
|
||||||
if assert.NoError(t, h(c)) {
|
|
||||||
assert.Contains(t, rec.Body.String(), "Echo")
|
|
||||||
}
|
|
||||||
|
|
||||||
// HTML5 mode
|
|
||||||
req, _ = http.NewRequest(echo.GET, "/client", nil)
|
|
||||||
rec = httptest.NewRecorder()
|
|
||||||
c = e.NewContext(req, rec)
|
|
||||||
static := StaticWithConfig(StaticConfig{
|
|
||||||
Root: "../_fixture",
|
|
||||||
HTML5: true,
|
|
||||||
})
|
|
||||||
h = static(func(c echo.Context) error {
|
|
||||||
return echo.ErrNotFound
|
|
||||||
})
|
|
||||||
if assert.NoError(t, h(c)) {
|
|
||||||
assert.Equal(t, http.StatusOK, rec.Code)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Browse
|
|
||||||
req, _ = http.NewRequest(echo.GET, "/", nil)
|
|
||||||
rec = httptest.NewRecorder()
|
|
||||||
c = e.NewContext(req, rec)
|
|
||||||
static = StaticWithConfig(StaticConfig{
|
|
||||||
Root: "../_fixture/images",
|
|
||||||
Browse: true,
|
|
||||||
})
|
|
||||||
h = static(func(c echo.Context) error {
|
|
||||||
return echo.ErrNotFound
|
|
||||||
})
|
|
||||||
if assert.NoError(t, h(c)) {
|
|
||||||
assert.Contains(t, rec.Body.String(), "walle")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Not found
|
|
||||||
req, _ = http.NewRequest(echo.GET, "/not-found", nil)
|
|
||||||
rec = httptest.NewRecorder()
|
|
||||||
c = e.NewContext(req, rec)
|
|
||||||
static = StaticWithConfig(StaticConfig{
|
|
||||||
Root: "../_fixture/images",
|
|
||||||
})
|
|
||||||
h = static(func(c echo.Context) error {
|
|
||||||
return echo.ErrNotFound
|
|
||||||
})
|
|
||||||
assert.Error(t, h(c))
|
|
||||||
}
|
|
Loading…
x
Reference in New Issue
Block a user