forked from gazebo-web/gz-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
router.go
262 lines (228 loc) · 8.04 KB
/
router.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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
package gz
import (
"encoding/json"
"fmt"
"net/http"
"regexp"
"sort"
"strings"
"github.com/codegangsta/negroni"
"github.com/gazebo-web/gz-go/v9/monitoring"
"github.com/gorilla/mux"
)
// NewRouter just creates a new Gorilla/mux router
func NewRouter() *mux.Router {
// We need to set StrictSlash to "false" (default) to avoid getting
// routes redirected automatically.
return mux.NewRouter().StrictSlash(false)
}
// RouterConfigurer is used to configure a mux.Router with declared routes
// and middlewares. It also adds support for default global OPTIONS handler
// based on the route declarations.
type RouterConfigurer struct {
// Embedded type mux.Router
// See https://golang.org/doc/effective_go.html#embedding
*mux.Router
// An optional list of middlewares to be injected between the common
// middlewares and the final route handler.
customHandlers []negroni.Handler
corsMap map[string]int
// sortedREs keeps a sorted list of registered routes in corsMap.
// It allows us to iterate the corsMap in 'order'.
sortedREs []string
// declared Routes
routes *Routes
// private field to keep a reference to JWT middlewares
authOptMiddleware negroni.HandlerFunc
authReqMiddleware negroni.HandlerFunc
// monitoring provides a middleware to keep track of server request metrics.
monitoring monitoring.Provider
}
// NewRouterConfigurer creates a new RouterConfigurer, used to
// configure a mux.Router with routes declarations.
func NewRouterConfigurer(r *mux.Router, monitoring monitoring.Provider) *RouterConfigurer {
rc := &RouterConfigurer{
Router: r,
corsMap: make(map[string]int, 0),
monitoring: monitoring,
}
return rc
}
// SetCustomHandlers - allows to set a list of optional middlewares
// that will be injected between the common middlewares and the final route handler.
func (rc *RouterConfigurer) SetCustomHandlers(handlers ...negroni.Handler) *RouterConfigurer {
rc.customHandlers = handlers
return rc
}
// SetAuthHandlers - set the JWT handlers to be used by the router for secure and unsecure
// routes.
func (rc *RouterConfigurer) SetAuthHandlers(optionalJWT, requiredJWT negroni.HandlerFunc) *RouterConfigurer {
rc.authOptMiddleware = optionalJWT
rc.authReqMiddleware = requiredJWT
return rc
}
// ConfigureRouter - given an array of Route declarations,
// this method confifures the router to handle them.
// This is the main method to invoke with a RouterConfigurer.
//
// It supports an optional pathPrefix used to differentiate API versions (eg. "/2.0/").
func (rc *RouterConfigurer) ConfigureRouter(pathPrefix string, routes Routes) *RouterConfigurer {
// Store the route declarations in the router.
rc.routes = &routes
for routeIndex, route := range routes {
// Process unsecure routes
for _, method := range route.Methods {
for _, formatHandler := range method.Handlers {
rc.registerRouteHandler(routeIndex, method.Type, false, formatHandler)
rc.registerRouteInOptionsHandler(pathPrefix, routeIndex, formatHandler)
}
}
// Process secure routes
for _, method := range route.SecureMethods {
for _, formatHandler := range method.Handlers {
rc.registerRouteHandler(routeIndex, method.Type, true, formatHandler)
rc.registerRouteInOptionsHandler(pathPrefix, routeIndex, formatHandler)
}
}
}
// Sorting corsMap is needed to correctly resolve OPTION requests
// that need to match a regex.
rc.sortedREs = getSortedREs(rc.corsMap)
return rc
}
// ///////////////////////////////////////////////
// Internal method that registers the route (with its format)
// into the router's corsMap, for later use by the OPTIONS handler.
func (rc *RouterConfigurer) registerRouteInOptionsHandler(pathPrefix string,
routeIndex int, formatHandler FormatHandler) {
route := (*rc.routes)[routeIndex]
// Setup a helper regex for "{_text_}" URL parameters.
re := regexp.MustCompile("{[^}]+?}")
namedVarRE := regexp.MustCompile("{[^}]+:[^{]+}")
// Register the route in the corsMap. Used by the global OPTIONS handler
uriPath := route.URI + formatHandler.Extension
prefixedURIPath := strings.Replace(pathPrefix+uriPath, "//", "/", -1)
// Store route information for the global OPTIONS handler
newStr := strings.Replace(prefixedURIPath, ".", "\\.", -1)
reString := namedVarRE.ReplaceAllString(newStr, ".+")
reString = re.ReplaceAllString(reString, "[^/]+")
rc.corsMap[reString] = routeIndex
rc.
Methods("OPTIONS").
Path(uriPath).
Name(route.Name + formatHandler.Extension).
Handler(http.HandlerFunc(rc.globalOptionsHandler))
}
// Helper function that registers the given route handler AND
// automatically creates and registers an HTTP OPTIONS method handler on the route.
//
// formatHandler is the given most route handler.
func (rc *RouterConfigurer) registerRouteHandler(routeIndex int, methodType string,
secure bool, formatHandler FormatHandler) {
handler := formatHandler.Handler
// TODO move to top chain middlewares
// Configure auth middleware
var authMiddleware negroni.HandlerFunc
if !secure {
authMiddleware = rc.authOptMiddleware
} else {
authMiddleware = rc.authReqMiddleware
}
routeName := (*rc.routes)[routeIndex].Name
recovery := negroni.NewRecovery()
// PrintStack is set to false to avoid sending stacktrace to client.
recovery.PrintStack = false
// Configure middleware chain
middlewares := negroni.New()
// Add monitoring middleware if monitoring provider is present.
// It must be the first middleware in the chain
if rc.monitoring != nil {
middlewares = middlewares.With(rc.monitoring.Middleware())
}
// Add default middlewares
middlewares = middlewares.With(
recovery,
negroni.HandlerFunc(requireDBMiddleware),
negroni.HandlerFunc(addCORSheadersMiddleware),
authMiddleware,
negroni.HandlerFunc(newGaEventTracking(routeName)),
)
// Inject custom handlers just before the final handler
middlewares = middlewares.With(rc.customHandlers...)
middlewares.Use(negroni.Wrap(http.Handler(handler)))
// Last, wrap everything with a Logger middleware
handler = logger(middlewares, routeName)
uriPath := (*rc.routes)[routeIndex].URI + formatHandler.Extension
// Create the route handler.
rc.
Methods(methodType).
Path(uriPath).
Name(routeName + formatHandler.Extension).
Handler(handler)
}
// globalOptionsHandler is an OPTIONS method handler that will return
// documentation of a route based on its Route definition.
func (rc *RouterConfigurer) globalOptionsHandler(w http.ResponseWriter, r *http.Request) {
index := 0
ok := false
// Find the matching URL
for _, key := range rc.sortedREs {
// Make sure the regular expression matches the complete URL path
if regexp.MustCompile(key).FindString(r.URL.Path) == r.URL.Path {
ok = true
index = rc.corsMap[key]
break
}
}
route := (*rc.routes)[index]
if ok {
if output, e := json.Marshal(route); e != nil {
err := NewErrorMessageWithBase(ErrorMarshalJSON, e)
reportJSONError(w, r, *err)
} else {
// Find all the route supported HTTP Methods
allow := make([]string, 0)
for _, m := range route.Methods {
allow = append(allow, m.Type)
}
for _, m := range route.SecureMethods {
allow = append(allow, m.Type)
}
w.Header().Set("Allow", strings.Join(allow[:], ","))
w.Header().Set("Content-Type", "application/json")
addCORSheaders(w)
fmt.Fprintln(w, string(output))
}
return
}
// Return error if a URL did not match
err := ErrorMessage(ErrorNameNotFound)
reportJSONError(w, r, err)
}
// ///////////////////////////////////////////////
// sortRE is an internal []string wrapper type used to sort by
// the number of "[^/]+" string occurrences found in a regex (ie. count).
// If the same count is found then the larger string will take precedence.
type sortRE []string
func (s sortRE) Len() int {
return len(s)
}
func (s sortRE) Swap(i, j int) {
s[i], s[j] = s[j], s[i]
}
func (s sortRE) Less(i, j int) bool {
ci := strings.Count(s[i], "[^/]+")
cj := strings.Count(s[j], "[^/]+")
if ci == cj {
return len(s[i]) > len(s[j])
}
return ci < cj
}
func getSortedREs(m map[string]int) []string {
var keys []string
for k := range m {
keys = append(keys, k)
}
sort.Sort(sortRE(keys))
return keys
}