- Totally rework static plugin

- Remove old one, now it is part of the HTTP plugin

Signed-off-by: Valery Piashchynski <[email protected]>

4 files changed, 201 insertions, 13 deletions

diff --git a/plugins/http/config/http.go b/plugins/http/config/http.go
index 8b63395f..31b10322 100644
--- a/plugins/http/config/http.go
+++ b/plugins/http/config/http.go
@@ -33,6 +33,9 @@ type HTTP struct {
 	// Uploads configures uploads configuration.
 	Uploads *Uploads `mapstructure:"uploads"`
 
+	// static configuration
+	Static *Static `mapstructure:"static"`
+
 	// Pool configures worker pool.
 	Pool *poolImpl.Config `mapstructure:"pool"`
 
@@ -100,6 +103,13 @@ func (c *HTTP) InitDefaults() error {
 		c.SSLConfig.Address = "127.0.0.1:443"
 	}
 
+	// static files
+	if c.Static != nil {
+		if c.Static.Pattern == "" {
+			c.Static.Pattern = "/static"
+		}
+	}
+
 	err := c.HTTP2Config.InitDefaults()
 	if err != nil {
 		return err
@@ -176,5 +186,13 @@ func (c *HTTP) Valid() error {
 		}
 	}
 
+	// validate static
+	if c.Static != nil {
+		err := c.Static.Valid()
+		if err != nil {
+			return errors.E(op, err)
+		}
+	}
+
 	return nil
 }
diff --git a/plugins/http/config/static.go b/plugins/http/config/static.go
new file mode 100644
index 00000000..416169d2
--- /dev/null
+++ b/plugins/http/config/static.go
@@ -0,0 +1,51 @@
+package config
+
+import (
+	"os"
+
+	"github.com/spiral/errors"
+)
+
+// Static describes file location and controls access to them.
+type Static struct {
+	// Dir contains name of directory to control access to.
+	Dir string
+
+	// HTTP pattern, where to serve static files
+	// for example - `/static`, `/my-files/static`, etc
+	// Default - /static
+	Pattern string
+
+	// forbid specifies list of file extensions which are forbidden for access.
+	// example: .php, .exe, .bat, .htaccess and etc.
+	Forbid []string
+
+	// Allow specifies list of file extensions which are allowed for access.
+	// example: .php, .exe, .bat, .htaccess and etc.
+	Allow []string
+
+	// Request headers to add to every static.
+	Request map[string]string
+
+	// Response headers to add to every static.
+	Response map[string]string
+}
+
+// Valid returns nil if config is valid.
+func (c *Static) Valid() error {
+	const op = errors.Op("static_plugin_valid")
+	st, err := os.Stat(c.Dir)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return errors.E(op, errors.Errorf("root directory '%s' does not exists", c.Dir))
+		}
+
+		return err
+	}
+
+	if !st.IsDir() {
+		return errors.E(op, errors.Errorf("invalid root directory '%s'", c.Dir))
+	}
+
+	return nil
+}
diff --git a/plugins/http/plugin.go b/plugins/http/plugin.go
index 01bd243f..dcfb7ddb 100644
--- a/plugins/http/plugin.go
+++ b/plugins/http/plugin.go
@@ -59,7 +59,9 @@ type Plugin struct {
 	// stdlog passed to the http/https/fcgi servers to log their internal messages
 	stdLog *log.Logger
 
+	// http configuration
 	cfg *httpConfig.HTTP `mapstructure:"http"`
+
 	// middlewares to chain
 	mdwr middleware
 
@@ -138,7 +140,7 @@ func (s *Plugin) Serve() chan error {
 	return errCh
 }
 
-func (s *Plugin) serve(errCh chan error) {
+func (s *Plugin) serve(errCh chan error) { //nolint:gocognit
 	var err error
 	const op = errors.Op("http_plugin_serve")
 	s.pool, err = s.server.NewWorkerPool(context.Background(), pool.Config{
@@ -167,11 +169,37 @@ func (s *Plugin) serve(errCh chan error) {
 
 	s.handler.AddListener(s.logCallback)
 
+	// Create new HTTP Multiplexer
+	mux := http.NewServeMux()
+
+	// if we have static, handler here, create a fileserver
+	if s.cfg.Static != nil {
+		h := http.FileServer(StaticFilesHandler(s.cfg.Static))
+		// Static files handler
+		mux.HandleFunc(s.cfg.Static.Pattern, func(w http.ResponseWriter, r *http.Request) {
+			if s.cfg.Static.Request != nil {
+				for k, v := range s.cfg.Static.Request {
+					r.Header.Add(k, v)
+				}
+			}
+
+			if s.cfg.Static.Response != nil {
+				for k, v := range s.cfg.Static.Response {
+					w.Header().Set(k, v)
+				}
+			}
+
+			h.ServeHTTP(w, r)
+		})
+	}
+
+	mux.HandleFunc("/", s.ServeHTTP)
+
 	if s.cfg.EnableHTTP() {
 		if s.cfg.EnableH2C() {
-			s.http = &http.Server{Handler: h2c.NewHandler(s, &http2.Server{}), ErrorLog: s.stdLog}
+			s.http = &http.Server{Handler: h2c.NewHandler(mux, &http2.Server{}), ErrorLog: s.stdLog}
 		} else {
-			s.http = &http.Server{Handler: s, ErrorLog: s.stdLog}
+			s.http = &http.Server{Handler: mux, ErrorLog: s.stdLog}
 		}
 	}
 
@@ -195,7 +223,7 @@ func (s *Plugin) serve(errCh chan error) {
 	}
 
 	if s.cfg.EnableFCGI() {
-		s.fcgi = &http.Server{Handler: s, ErrorLog: s.stdLog}
+		s.fcgi = &http.Server{Handler: mux, ErrorLog: s.stdLog}
 	}
 
 	// start http, https and fcgi servers if requested in the config
@@ -216,9 +244,11 @@ func (s *Plugin) serveHTTP(errCh chan error) {
 	if s.http == nil {
 		return
 	}
-
 	const op = errors.Op("http_plugin_serve_http")
-	applyMiddlewares(s.http, s.mdwr, s.cfg.Middleware, s.log)
+
+	if len(s.mdwr) > 0 {
+		applyMiddlewares(s.http, s.mdwr, s.cfg.Middleware, s.log)
+	}
 	l, err := utils.CreateListener(s.cfg.Address)
 	if err != nil {
 		errCh <- errors.E(op, err)
@@ -236,9 +266,10 @@ func (s *Plugin) serveHTTPS(errCh chan error) {
 	if s.https == nil {
 		return
 	}
-
 	const op = errors.Op("http_plugin_serve_https")
-	applyMiddlewares(s.https, s.mdwr, s.cfg.Middleware, s.log)
+	if len(s.mdwr) > 0 {
+		applyMiddlewares(s.https, s.mdwr, s.cfg.Middleware, s.log)
+	}
 	l, err := utils.CreateListener(s.cfg.SSLConfig.Address)
 	if err != nil {
 		errCh <- errors.E(op, err)
@@ -262,9 +293,12 @@ func (s *Plugin) serveFCGI(errCh chan error) {
 	if s.fcgi == nil {
 		return
 	}
-
 	const op = errors.Op("http_plugin_serve_fcgi")
-	applyMiddlewares(s.fcgi, s.mdwr, s.cfg.Middleware, s.log)
+
+	if len(s.mdwr) > 0 {
+		applyMiddlewares(s.https, s.mdwr, s.cfg.Middleware, s.log)
+	}
+
 	l, err := utils.CreateListener(s.cfg.FCGIConfig.Address)
 	if err != nil {
 		errCh <- errors.E(op, err)
@@ -607,9 +641,6 @@ func (s *Plugin) tlsAddr(host string, forcePort bool) string {
 }
 
 func applyMiddlewares(server *http.Server, middlewares map[string]Middleware, order []string, log logger.Logger) {
-	if len(middlewares) == 0 {
-		return
-	}
 	for i := 0; i < len(order); i++ {
 		if mdwr, ok := middlewares[order[i]]; ok {
 			server.Handler = mdwr.Middleware(server.Handler)
diff --git a/plugins/http/static.go b/plugins/http/static.go
new file mode 100644
index 00000000..be977fb3
--- /dev/null
+++ b/plugins/http/static.go
@@ -0,0 +1,88 @@
+package http
+
+import (
+	"io/fs"
+	"net/http"
+	"path/filepath"
+	"strings"
+
+	httpConfig "github.com/spiral/roadrunner/v2/plugins/http/config"
+)
+
+type ExtensionFilter struct {
+	allowed   map[string]struct{}
+	forbidden map[string]struct{}
+}
+
+func NewExtensionFilter(allow, forbid []string) *ExtensionFilter {
+	ef := &ExtensionFilter{
+		allowed:   make(map[string]struct{}, len(allow)),
+		forbidden: make(map[string]struct{}, len(forbid)),
+	}
+
+	for i := 0; i < len(forbid); i++ {
+		// skip empty lines
+		if forbid[i] == "" {
+			continue
+		}
+		ef.forbidden[forbid[i]] = struct{}{}
+	}
+
+	for i := 0; i < len(allow); i++ {
+		// skip empty lines
+		if allow[i] == "" {
+			continue
+		}
+		ef.allowed[allow[i]] = struct{}{}
+	}
+
+	// check if any forbidden items presented in the allowed
+	// if presented, delete such items from allowed
+	for k := range ef.allowed {
+		if _, ok := ef.forbidden[k]; ok {
+			delete(ef.allowed, k)
+		}
+	}
+
+	return ef
+}
+
+type FileSystem struct {
+	ef *ExtensionFilter
+	// embedded
+	http.FileSystem
+}
+
+// Open wrapper around http.FileSystem Open method, name here is the name of the
+func (f FileSystem) Open(name string) (http.File, error) {
+	file, err := f.FileSystem.Open(name)
+	if err != nil {
+		return nil, err
+	}
+
+	fstat, err := file.Stat()
+	if err != nil {
+		return nil, fs.ErrNotExist
+	}
+
+	if fstat.IsDir() {
+		return nil, fs.ErrPermission
+	}
+
+	ext := strings.ToLower(filepath.Ext(fstat.Name()))
+	if _, ok := f.ef.forbidden[ext]; ok {
+		return nil, fs.ErrPermission
+	}
+
+	// if file extension is allowed, append it to the FileInfo slice
+	if _, ok := f.ef.allowed[ext]; ok {
+		return file, nil
+	}
+
+	return nil, fs.ErrNotExist
+}
+
+// StaticFilesHandler is a constructor for the http.FileSystem
+func StaticFilesHandler(config *httpConfig.Static) http.FileSystem {
+	return FileSystem{NewExtensionFilter(config.Allow, config.Forbid), http.Dir(config.Dir)}
+}