2017-02-18 22:00:46 +00:00
|
|
|
package middleware
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
2017-12-07 22:00:56 +00:00
|
|
|
"net/http"
|
2017-02-18 22:00:46 +00:00
|
|
|
"os"
|
2017-06-05 22:01:05 +00:00
|
|
|
"path"
|
2017-02-18 22:00:46 +00:00
|
|
|
"path/filepath"
|
2017-06-05 22:01:05 +00:00
|
|
|
"strings"
|
2017-02-18 22:00:46 +00:00
|
|
|
|
|
|
|
"github.com/labstack/echo"
|
|
|
|
)
|
|
|
|
|
|
|
|
type (
|
|
|
|
// StaticConfig defines the config for Static middleware.
|
|
|
|
StaticConfig struct {
|
|
|
|
// Skipper defines a function to skip middleware.
|
|
|
|
Skipper Skipper
|
|
|
|
|
|
|
|
// Root directory from where the static content is served.
|
|
|
|
// Required.
|
2018-02-20 23:48:10 +00:00
|
|
|
Root string `yaml:"root"`
|
2017-02-18 22:00:46 +00:00
|
|
|
|
|
|
|
// Index file for serving a directory.
|
|
|
|
// Optional. Default value "index.html".
|
2018-02-20 23:48:10 +00:00
|
|
|
Index string `yaml:"index"`
|
2017-02-18 22:00:46 +00:00
|
|
|
|
|
|
|
// 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.
|
2018-02-20 23:48:10 +00:00
|
|
|
HTML5 bool `yaml:"html5"`
|
2017-02-18 22:00:46 +00:00
|
|
|
|
|
|
|
// Enable directory browsing.
|
|
|
|
// Optional. Default value false.
|
2018-02-20 23:48:10 +00:00
|
|
|
Browse bool `yaml:"browse"`
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
)
|
|
|
|
|
|
|
|
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
|
2017-06-05 22:01:05 +00:00
|
|
|
if config.Root == "" {
|
|
|
|
config.Root = "." // For security we want to restrict to CWD.
|
|
|
|
}
|
2017-02-18 22:00:46 +00:00
|
|
|
if config.Skipper == nil {
|
|
|
|
config.Skipper = DefaultStaticConfig.Skipper
|
|
|
|
}
|
|
|
|
if config.Index == "" {
|
|
|
|
config.Index = DefaultStaticConfig.Index
|
|
|
|
}
|
|
|
|
|
|
|
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
2017-12-07 22:00:56 +00:00
|
|
|
return func(c echo.Context) (err error) {
|
2017-06-05 22:01:05 +00:00
|
|
|
if config.Skipper(c) {
|
|
|
|
return next(c)
|
|
|
|
}
|
2017-02-18 22:00:46 +00:00
|
|
|
|
2017-06-05 22:01:05 +00:00
|
|
|
p := c.Request().URL.Path
|
|
|
|
if strings.HasSuffix(c.Path(), "*") { // When serving from a group, e.g. `/static*`.
|
|
|
|
p = c.Param("*")
|
|
|
|
}
|
2017-12-07 22:00:56 +00:00
|
|
|
p, err = echo.PathUnescape(p)
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
2017-06-05 22:01:05 +00:00
|
|
|
name := filepath.Join(config.Root, path.Clean("/"+p)) // "/"+ for security
|
|
|
|
|
|
|
|
fi, err := os.Stat(name)
|
2017-02-18 22:00:46 +00:00
|
|
|
if err != nil {
|
|
|
|
if os.IsNotExist(err) {
|
2017-12-07 22:00:56 +00:00
|
|
|
if err = next(c); err != nil {
|
|
|
|
if he, ok := err.(*echo.HTTPError); ok {
|
|
|
|
if config.HTML5 && he.Code == http.StatusNotFound {
|
|
|
|
return c.File(filepath.Join(config.Root, config.Index))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
}
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if fi.IsDir() {
|
2017-06-05 22:01:05 +00:00
|
|
|
index := filepath.Join(name, config.Index)
|
|
|
|
fi, err = os.Stat(index)
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
if config.Browse {
|
|
|
|
return listDir(name, c.Response())
|
|
|
|
}
|
|
|
|
if os.IsNotExist(err) {
|
|
|
|
return next(c)
|
|
|
|
}
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
2017-06-05 22:01:05 +00:00
|
|
|
|
|
|
|
return c.File(index)
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
2017-06-05 22:01:05 +00:00
|
|
|
|
2017-02-18 22:00:46 +00:00
|
|
|
return c.File(name)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-12-07 22:00:56 +00:00
|
|
|
func listDir(name string, res *echo.Response) (err error) {
|
2017-02-18 22:00:46 +00:00
|
|
|
dir, err := os.Open(name)
|
|
|
|
if err != nil {
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
dirs, err := dir.Readdir(-1)
|
|
|
|
if err != nil {
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Create a directory index
|
|
|
|
res.Header().Set(echo.HeaderContentType, echo.MIMETextHTMLCharsetUTF8)
|
|
|
|
if _, err = fmt.Fprintf(res, "<pre>\n"); err != nil {
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
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 {
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
_, err = fmt.Fprintf(res, "</pre>\n")
|
2017-12-07 22:00:56 +00:00
|
|
|
return
|
2017-02-18 22:00:46 +00:00
|
|
|
}
|