summaryrefslogtreecommitdiff
path: root/modules/caddyhttp
diff options
context:
space:
mode:
Diffstat (limited to 'modules/caddyhttp')
-rw-r--r--modules/caddyhttp/caddyhttp.go179
-rw-r--r--modules/caddyhttp/caddylog/log.go37
-rw-r--r--modules/caddyhttp/matchers.go102
-rw-r--r--modules/caddyhttp/responsewriter.go68
-rw-r--r--modules/caddyhttp/staticfiles/staticfiles.go28
5 files changed, 403 insertions, 11 deletions
diff --git a/modules/caddyhttp/caddyhttp.go b/modules/caddyhttp/caddyhttp.go
index 529c1f7..059af62 100644
--- a/modules/caddyhttp/caddyhttp.go
+++ b/modules/caddyhttp/caddyhttp.go
@@ -2,6 +2,7 @@ package caddyhttp
import (
"context"
+ "encoding/json"
"fmt"
"log"
"net"
@@ -30,23 +31,56 @@ type httpModuleConfig struct {
}
func (hc *httpModuleConfig) Run() error {
- // fmt.Printf("RUNNING: %#v\n", hc)
+ // TODO: Either prevent overlapping listeners on different servers, or combine them into one
+
+ // TODO: A way to loop requests back through, so have them start the matching over again, but keeping any mutations
for _, srv := range hc.Servers {
+ // set up the routes
+ for i, route := range srv.Routes {
+ // matchers
+ for modName, rawMsg := range route.Matchers {
+ val, err := caddy2.LoadModule("http.matchers."+modName, rawMsg)
+ if err != nil {
+ return fmt.Errorf("loading matcher module '%s': %v", modName, err)
+ }
+ srv.Routes[i].matchers = append(srv.Routes[i].matchers, val.(RouteMatcher))
+ }
+
+ // middleware
+ for j, rawMsg := range route.Apply {
+ mid, err := caddy2.LoadModuleInlineName("http.middleware", rawMsg)
+ if err != nil {
+ return fmt.Errorf("loading middleware module in position %d: %v", j, err)
+ }
+ srv.Routes[i].middleware = append(srv.Routes[i].middleware, mid.(MiddlewareHandler))
+ }
+
+ // responder
+ if route.Respond != nil {
+ resp, err := caddy2.LoadModuleInlineName("http.responders", route.Respond)
+ if err != nil {
+ return fmt.Errorf("loading responder module: %v", err)
+ }
+ srv.Routes[i].responder = resp.(Handler)
+ }
+ }
+
s := &http.Server{
ReadTimeout: time.Duration(srv.ReadTimeout),
ReadHeaderTimeout: time.Duration(srv.ReadHeaderTimeout),
+ Handler: srv,
}
for _, lnAddr := range srv.Listen {
- proto, addrs, err := parseListenAddr(lnAddr)
+ network, addrs, err := parseListenAddr(lnAddr)
if err != nil {
return fmt.Errorf("parsing listen address '%s': %v", lnAddr, err)
}
for _, addr := range addrs {
- ln, err := caddy2.Listen(proto, addr)
+ ln, err := caddy2.Listen(network, addr)
if err != nil {
- return fmt.Errorf("%s: listening on %s: %v", proto, addr, err)
+ return fmt.Errorf("%s: listening on %s: %v", network, addr, err)
}
go s.Serve(ln)
hc.servers = append(hc.servers, s)
@@ -67,10 +101,117 @@ func (hc *httpModuleConfig) Cancel() error {
return nil
}
-func parseListenAddr(a string) (proto string, addrs []string, err error) {
- proto = "tcp"
+type httpServerConfig struct {
+ Listen []string `json:"listen"`
+ ReadTimeout caddy2.Duration `json:"read_timeout"`
+ ReadHeaderTimeout caddy2.Duration `json:"read_header_timeout"`
+ HiddenFiles []string `json:"hidden_files"` // TODO:... experimenting with shared/common state
+ Routes []serverRoute `json:"routes"`
+}
+
+func (s httpServerConfig) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+ var mid []Middleware // TODO: see about using make() for performance reasons
+ var responder Handler
+ mrw := &middlewareResponseWriter{ResponseWriterWrapper: &ResponseWriterWrapper{w}}
+
+ for _, route := range s.Routes {
+ matched := len(route.matchers) == 0
+ for _, m := range route.matchers {
+ if m.Match(r) {
+ matched = true
+ break
+ }
+ }
+ if !matched {
+ continue
+ }
+ for _, m := range route.middleware {
+ mid = append(mid, func(next HandlerFunc) HandlerFunc {
+ return func(w http.ResponseWriter, r *http.Request) error {
+ return m.ServeHTTP(mrw, r, next)
+ }
+ })
+ }
+ if responder == nil {
+ responder = route.responder
+ }
+ }
+
+ // build the middleware stack, with the responder at the end
+ stack := HandlerFunc(func(w http.ResponseWriter, r *http.Request) error {
+ if responder == nil {
+ return nil
+ }
+ mrw.allowWrites = true
+ return responder.ServeHTTP(w, r)
+ })
+ for i := len(mid) - 1; i >= 0; i-- {
+ stack = mid[i](stack)
+ }
+
+ err := stack.ServeHTTP(w, r)
+ if err != nil {
+ // TODO: error handling
+ log.Printf("[ERROR] TODO: error handling: %v", err)
+ }
+}
+
+type serverRoute struct {
+ Matchers map[string]json.RawMessage `json:"match"`
+ Apply []json.RawMessage `json:"apply"`
+ Respond json.RawMessage `json:"respond"`
+
+ // decoded values
+ matchers []RouteMatcher
+ middleware []MiddlewareHandler
+ responder Handler
+}
+
+// RouteMatcher is a type that can match to a request.
+// A route matcher MUST NOT modify the request.
+type RouteMatcher interface {
+ Match(*http.Request) bool
+}
+
+// Middleware chains one Handler to the next by being passed
+// the next Handler in the chain.
+type Middleware func(HandlerFunc) HandlerFunc
+
+// MiddlewareHandler is a Handler that includes a reference
+// to the next middleware handler in the chain. Middleware
+// handlers MUST NOT call Write() or WriteHeader() on the
+// response writer; doing so will panic. See Handler godoc
+// for more information.
+type MiddlewareHandler interface {
+ ServeHTTP(http.ResponseWriter, *http.Request, Handler) error
+}
+
+// Handler is like http.Handler except ServeHTTP may return an error.
+//
+// Middleware and responder handlers both implement this method.
+// Middleware must not call Write or WriteHeader on the ResponseWriter;
+// doing so will cause a panic. Responders should write to the response
+// if there was not an error.
+//
+// If any handler encounters an error, it should be returned for proper
+// handling. Return values should be propagated down the middleware chain
+// by returning it unchanged.
+type Handler interface {
+ ServeHTTP(http.ResponseWriter, *http.Request) error
+}
+
+// HandlerFunc is a convenience type like http.HandlerFunc.
+type HandlerFunc func(http.ResponseWriter, *http.Request) error
+
+// ServeHTTP implements the Handler interface.
+func (f HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request) error {
+ return f(w, r)
+}
+
+func parseListenAddr(a string) (network string, addrs []string, err error) {
+ network = "tcp"
if idx := strings.Index(a, "/"); idx >= 0 {
- proto = strings.ToLower(strings.TrimSpace(a[:idx]))
+ network = strings.ToLower(strings.TrimSpace(a[:idx]))
a = a[idx+1:]
}
var host, port string
@@ -101,8 +242,24 @@ func parseListenAddr(a string) (proto string, addrs []string, err error) {
return
}
-type httpServerConfig struct {
- Listen []string `json:"listen"`
- ReadTimeout caddy2.Duration `json:"read_timeout"`
- ReadHeaderTimeout caddy2.Duration `json:"read_header_timeout"`
+type middlewareResponseWriter struct {
+ *ResponseWriterWrapper
+ allowWrites bool
}
+
+func (mrw middlewareResponseWriter) WriteHeader(statusCode int) {
+ if !mrw.allowWrites {
+ panic("WriteHeader: middleware cannot write to the response")
+ }
+ mrw.ResponseWriterWrapper.WriteHeader(statusCode)
+}
+
+func (mrw middlewareResponseWriter) Write(b []byte) (int, error) {
+ if !mrw.allowWrites {
+ panic("Write: middleware cannot write to the response")
+ }
+ return mrw.ResponseWriterWrapper.Write(b)
+}
+
+// Interface guards
+var _ HTTPInterfaces = middlewareResponseWriter{}
diff --git a/modules/caddyhttp/caddylog/log.go b/modules/caddyhttp/caddylog/log.go
new file mode 100644
index 0000000..5bbab2a
--- /dev/null
+++ b/modules/caddyhttp/caddylog/log.go
@@ -0,0 +1,37 @@
+package caddylog
+
+import (
+ "log"
+ "net/http"
+ "time"
+
+ "bitbucket.org/lightcodelabs/caddy2"
+ "bitbucket.org/lightcodelabs/caddy2/modules/caddyhttp"
+)
+
+func init() {
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.middleware.log",
+ New: func() (interface{}, error) { return &Log{}, nil },
+ })
+}
+
+// Log implements a simple logging middleware.
+type Log struct {
+ Filename string
+}
+
+func (l *Log) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error {
+ start := time.Now()
+
+ if err := next.ServeHTTP(w, r); err != nil {
+ return err
+ }
+
+ log.Println("latency:", time.Now().Sub(start))
+
+ return nil
+}
+
+// Interface guard
+var _ caddyhttp.MiddlewareHandler = &Log{}
diff --git a/modules/caddyhttp/matchers.go b/modules/caddyhttp/matchers.go
new file mode 100644
index 0000000..59f1838
--- /dev/null
+++ b/modules/caddyhttp/matchers.go
@@ -0,0 +1,102 @@
+package caddyhttp
+
+import (
+ "net/http"
+ "strings"
+
+ "bitbucket.org/lightcodelabs/caddy2"
+)
+
+func init() {
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.matchers.host",
+ New: func() (interface{}, error) { return matchHost{}, nil },
+ })
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.matchers.path",
+ New: func() (interface{}, error) { return matchPath{}, nil },
+ })
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.matchers.method",
+ New: func() (interface{}, error) { return matchMethod{}, nil },
+ })
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.matchers.query",
+ New: func() (interface{}, error) { return matchQuery{}, nil },
+ })
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.matchers.header",
+ New: func() (interface{}, error) { return matchHeader{}, nil },
+ })
+}
+
+// TODO: Matchers should probably support regex of some sort... performance trade-offs?
+
+type (
+ matchHost []string
+ matchPath []string
+ matchMethod []string
+ matchQuery map[string][]string
+ matchHeader map[string][]string
+)
+
+func (m matchHost) Match(r *http.Request) bool {
+ for _, host := range m {
+ if r.Host == host {
+ return true
+ }
+ }
+ return false
+}
+
+func (m matchPath) Match(r *http.Request) bool {
+ for _, path := range m {
+ if strings.HasPrefix(r.URL.Path, path) {
+ return true
+ }
+ }
+ return false
+}
+
+func (m matchMethod) Match(r *http.Request) bool {
+ for _, method := range m {
+ if r.Method == method {
+ return true
+ }
+ }
+ return false
+}
+
+func (m matchQuery) Match(r *http.Request) bool {
+ for param, vals := range m {
+ paramVal := r.URL.Query().Get(param)
+ for _, v := range vals {
+ if paramVal == v {
+ return true
+ }
+ }
+ }
+ return false
+}
+
+func (m matchHeader) Match(r *http.Request) bool {
+ for field, vals := range m {
+ fieldVals := r.Header[field]
+ for _, fieldVal := range fieldVals {
+ for _, v := range vals {
+ if fieldVal == v {
+ return true
+ }
+ }
+ }
+ }
+ return false
+}
+
+var (
+ _ RouteMatcher = matchHost{}
+ _ RouteMatcher = matchPath{}
+ _ RouteMatcher = matchMethod{}
+ _ RouteMatcher = matchQuery{}
+ _ RouteMatcher = matchHeader{}
+)
diff --git a/modules/caddyhttp/responsewriter.go b/modules/caddyhttp/responsewriter.go
new file mode 100644
index 0000000..587d9f9
--- /dev/null
+++ b/modules/caddyhttp/responsewriter.go
@@ -0,0 +1,68 @@
+package caddyhttp
+
+import (
+ "bufio"
+ "fmt"
+ "net"
+ "net/http"
+)
+
+// ResponseWriterWrapper wraps an underlying ResponseWriter and
+// promotes its Pusher/Flusher/CloseNotifier/Hijacker methods
+// as well. To use this type, embed a pointer to it within your
+// own struct type that implements the http.ResponseWriter
+// interface, then call methods on the embedded value. You can
+// make sure your type wraps correctly by asserting that it
+// implements the HTTPInterfaces interface.
+type ResponseWriterWrapper struct {
+ http.ResponseWriter
+}
+
+// Hijack implements http.Hijacker. It simply calls the underlying
+// ResponseWriter's Hijack method if there is one, or returns an error.
+func (rww *ResponseWriterWrapper) Hijack() (net.Conn, *bufio.ReadWriter, error) {
+ if hj, ok := rww.ResponseWriter.(http.Hijacker); ok {
+ return hj.Hijack()
+ }
+ return nil, nil, fmt.Errorf("not a hijacker")
+}
+
+// Flush implements http.Flusher. It simply calls the underlying
+// ResponseWriter's Flush method if there is one, or panics.
+func (rww *ResponseWriterWrapper) Flush() {
+ if f, ok := rww.ResponseWriter.(http.Flusher); ok {
+ f.Flush()
+ } else {
+ panic("not a flusher")
+ }
+}
+
+// CloseNotify implements http.CloseNotifier. It simply calls the underlying
+// ResponseWriter's CloseNotify method if there is one, or panics.
+func (rww *ResponseWriterWrapper) CloseNotify() <-chan bool {
+ if cn, ok := rww.ResponseWriter.(http.CloseNotifier); ok {
+ return cn.CloseNotify()
+ }
+ panic("not a close notifier")
+}
+
+// Push implements http.Pusher. It simply calls the underlying
+// ResponseWriter's Push method if there is one, or returns an error.
+func (rww *ResponseWriterWrapper) Push(target string, opts *http.PushOptions) error {
+ if pusher, hasPusher := rww.ResponseWriter.(http.Pusher); hasPusher {
+ return pusher.Push(target, opts)
+ }
+ return fmt.Errorf("not a pusher")
+}
+
+// HTTPInterfaces mix all the interfaces that middleware ResponseWriters need to support.
+type HTTPInterfaces interface {
+ http.ResponseWriter
+ http.Pusher
+ http.Flusher
+ http.CloseNotifier
+ http.Hijacker
+}
+
+// Interface guards
+var _ HTTPInterfaces = (*ResponseWriterWrapper)(nil)
diff --git a/modules/caddyhttp/staticfiles/staticfiles.go b/modules/caddyhttp/staticfiles/staticfiles.go
new file mode 100644
index 0000000..d1a7a7e
--- /dev/null
+++ b/modules/caddyhttp/staticfiles/staticfiles.go
@@ -0,0 +1,28 @@
+package staticfiles
+
+import (
+ "net/http"
+
+ "bitbucket.org/lightcodelabs/caddy2"
+ "bitbucket.org/lightcodelabs/caddy2/modules/caddyhttp"
+)
+
+func init() {
+ caddy2.RegisterModule(caddy2.Module{
+ Name: "http.responders.static_files",
+ New: func() (interface{}, error) { return &StaticFiles{}, nil },
+ })
+}
+
+// StaticFiles implements a static file server responder for Caddy.
+type StaticFiles struct {
+ Root string
+}
+
+func (sf StaticFiles) ServeHTTP(w http.ResponseWriter, r *http.Request) error {
+ http.FileServer(http.Dir(sf.Root)).ServeHTTP(w, r)
+ return nil
+}
+
+// Interface guard
+var _ caddyhttp.Handler = StaticFiles{}
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-27 08:00:17 +0000