forked from gobuffalo/buffalo
/
middleware.go
161 lines (144 loc) · 3.84 KB
/
middleware.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
package buffalo
import (
"reflect"
"runtime"
"strings"
)
// MiddlewareFunc defines the interface for a piece of Buffalo
// Middleware.
/*
func DoSomething(next Handler) Handler {
return func(c Context) error {
// do something before calling the next handler
err := next(c)
// do something after call the handler
return err
}
}
*/
type MiddlewareFunc func(Handler) Handler
// Use the specified Middleware for the App.
// When defined on an `*App` the specified middleware will be
// inherited by any `Group` calls that are made on that on
// the App.
func (a *App) Use(mw ...MiddlewareFunc) {
a.Middleware.Use(mw...)
}
// MiddlewareStack manages the middleware stack for an App/Group.
type MiddlewareStack struct {
stack []MiddlewareFunc
skips map[string]bool
}
func (ms *MiddlewareStack) clone() *MiddlewareStack {
n := newMiddlewareStack()
for _, s := range ms.stack {
n.stack = append(n.stack, s)
}
for k, v := range ms.skips {
n.skips[k] = v
}
return n
}
// Clear wipes out the current middleware stack for the App/Group,
// any middleware previously defined will be removed leaving an empty
// middleware stack.
func (ms *MiddlewareStack) Clear() {
ms.stack = []MiddlewareFunc{}
ms.skips = map[string]bool{}
}
// Use the specified Middleware for the App.
// When defined on an `*App` the specified middleware will be
// inherited by any `Group` calls that are made on that on
// the App.
func (ms *MiddlewareStack) Use(mw ...MiddlewareFunc) {
ms.stack = append(ms.stack, mw...)
}
// Skip a specified piece of middleware the specified Handlers.
// This is useful for things like wrapping your application in an
// authorization middleare, but skipping it for things the home
// page, the login page, etc...
/*
a.Middleware.Skip(Authorization, HomeHandler, LoginHandler, RegistrationHandler)
*/
// NOTE: When skipping Resource handlers, you need to first declare your
// resource handler as a type of buffalo.Resource for the Skip function to
// properly recognize and match it.
/*
// Works:
var ur Resource
cr = &carsResource{&buffaloBaseResource{}}
g = a.Resource("/cars", cr)
g.Use(SomeMiddleware)
g.Middleware.Skip(SomeMiddleware, cr.Show)
// Doesn't Work:
cr := &carsResource{&buffaloBaseResource{}}
g = a.Resource("/cars", cr)
g.Use(SomeMiddleware)
g.Middleware.Skip(SomeMiddleware, cr.Show)
*/
func (ms *MiddlewareStack) Skip(mw MiddlewareFunc, handlers ...Handler) {
for _, h := range handlers {
key := funcKey(mw, h)
ms.skips[key] = true
}
}
// Replace a piece of middleware with another piece of middleware. Great for
// testing.
func (ms *MiddlewareStack) Replace(mw1 MiddlewareFunc, mw2 MiddlewareFunc) {
m1k := funcKey(mw1)
stack := []MiddlewareFunc{}
for _, mw := range ms.stack {
if funcKey(mw) == m1k {
stack = append(stack, mw2)
} else {
stack = append(stack, mw)
}
}
ms.stack = stack
}
func (ms *MiddlewareStack) handler(h Handler) Handler {
if len(ms.stack) > 0 {
mh := func(_ Handler) Handler {
return h
}
tstack := []MiddlewareFunc{mh}
sl := len(ms.stack) - 1
for i := sl; i >= 0; i-- {
mw := ms.stack[i]
key := funcKey(mw, h)
if !ms.skips[key] {
tstack = append(tstack, mw)
}
}
for _, mw := range tstack {
h = mw(h)
}
return h
}
return h
}
func newMiddlewareStack(mws ...MiddlewareFunc) *MiddlewareStack {
return &MiddlewareStack{
stack: mws,
skips: map[string]bool{},
}
}
func funcKey(funcs ...interface{}) string {
names := []string{}
for _, f := range funcs {
rv := reflect.ValueOf(f)
ptr := rv.Pointer()
if n, ok := keyMap[rv.Pointer()]; ok {
names = append(names, n)
// fmt.Printf("### found %+v -> %+v\n", ptr, n)
continue
}
fnc := runtime.FuncForPC(ptr)
n := fnc.Name()
// fmt.Printf("### not found %+v -> %+v\n", ptr, n)
keyMap[ptr] = n
names = append(names, n)
}
return strings.Join(names, "/")
}
var keyMap = map[uintptr]string{}