-
Notifications
You must be signed in to change notification settings - Fork 6
/
makross.go
608 lines (542 loc) · 19.9 KB
/
makross.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
// Package makross is a high productive and modular web framework in Golang.
package makross
import (
"context"
"io"
"net/http"
"path"
"sort"
"strings"
"sync"
"time"
"github.com/insionng/makross/libraries/ini.v1"
)
type (
// Handler is the function for handling HTTP requests.
Handler func(*Context) error
// Makross manages routes and dispatches HTTP requests to the handlers of the matching routes.
Makross struct {
RouteGroup
pool sync.Pool
routes []*Route
namedRoutes map[string]*Route
stores map[string]routeStore
data map[string]interface{} // data items managed by Key , Value
QueuesMap *sync.Map //map[string]*prior.PriorityQueue
FiltersMap *sync.Map //map[string][]byte // Global Filters
maxParams int
notFound []Handler
notFoundHandlers []Handler
binder Binder
renderer Renderer
Server *http.Server
}
// routeStore stores route paths and the corresponding handlers.
routeStore interface {
Add(key string, data interface{}) int
Get(key string, pvalues []string) (data interface{}, pnames []string)
String() string
}
// Renderer is the interface that wraps the Render function.
Renderer interface {
Render(io.Writer, string, *Context) error
}
)
// Export HTTP methods
const (
CONNECT = "CONNECT"
DELETE = "DELETE"
GET = "GET"
HEAD = "HEAD"
OPTIONS = "OPTIONS"
PATCH = "PATCH"
POST = "POST"
PUT = "PUT"
TRACE = "TRACE"
)
var (
// Methods lists all supported HTTP methods by Makross.
Methods = []string{
CONNECT,
DELETE,
GET,
HEAD,
OPTIONS,
PATCH,
POST,
PUT,
TRACE,
}
// FlashNow applies to current request.
FlashNow bool
// Configuration convention object.
cfg *ini.File
)
// MIME types
const (
MIMEApplicationJSON = "application/json"
MIMEApplicationJSONCharsetUTF8 = MIMEApplicationJSON + "; " + charsetUTF8
MIMEApplicationJavaScript = "application/javascript"
MIMEApplicationJavaScriptCharsetUTF8 = MIMEApplicationJavaScript + "; " + charsetUTF8
MIMEApplicationXML = "application/xml"
MIMEApplicationXMLCharsetUTF8 = MIMEApplicationXML + "; " + charsetUTF8
MIMETextXML = "text/xml"
MIMETextXMLCharsetUTF8 = MIMETextXML + "; " + charsetUTF8
MIMEApplicationForm = "application/x-www-form-urlencoded"
MIMEApplicationProtobuf = "application/protobuf"
MIMEApplicationMsgpack = "application/msgpack"
MIMETextHTML = "text/html"
MIMETextHTMLCharsetUTF8 = MIMETextHTML + "; " + charsetUTF8
MIMETextPlain = "text/plain"
MIMETextPlainCharsetUTF8 = MIMETextPlain + "; " + charsetUTF8
MIMEMultipartForm = "multipart/form-data"
MIMEOctetStream = "application/octet-stream"
)
const (
charsetUTF8 = "charset=utf-8"
)
// Headers
const (
HeaderAccept = "Accept"
HeaderAcceptEncoding = "Accept-Encoding"
HeaderAllow = "Allow"
HeaderAuthorization = "Authorization"
HeaderContentDisposition = "Content-Disposition"
HeaderContentEncoding = "Content-Encoding"
HeaderContentLength = "Content-Length"
HeaderContentType = "Content-Type"
HeaderCookie = "Cookie"
HeaderSetCookie = "Set-Cookie"
HeaderIfModifiedSince = "If-Modified-Since"
HeaderLastModified = "Last-Modified"
HeaderLocation = "Location"
HeaderUpgrade = "Upgrade"
HeaderVary = "Vary"
HeaderWWWAuthenticate = "WWW-Authenticate"
HeaderXForwardedFor = "X-Forwarded-For"
HeaderXForwardedProto = "X-Forwarded-Proto"
HeaderXForwardedProtocol = "X-Forwarded-Protocol"
HeaderXForwardedSsl = "X-Forwarded-Ssl"
HeaderXUrlScheme = "X-Url-Scheme"
HeaderXHTTPMethodOverride = "X-HTTP-Method-Override"
HeaderXRealIP = "X-Real-IP"
HeaderXRequestID = "X-Request-ID"
HeaderServer = "Server"
HeaderOrigin = "Origin"
// Access control
HeaderAccessControlRequestMethod = "Access-Control-Request-Method"
HeaderAccessControlRequestHeaders = "Access-Control-Request-Headers"
HeaderAccessControlAllowOrigin = "Access-Control-Allow-Origin"
HeaderAccessControlAllowMethods = "Access-Control-Allow-Methods"
HeaderAccessControlAllowHeaders = "Access-Control-Allow-Headers"
HeaderAccessControlAllowCredentials = "Access-Control-Allow-Credentials"
HeaderAccessControlExposeHeaders = "Access-Control-Expose-Headers"
HeaderAccessControlMaxAge = "Access-Control-Max-Age"
// Security
HeaderStrictTransportSecurity = "Strict-Transport-Security"
HeaderXContentTypeOptions = "X-Content-Type-Options"
HeaderXXSSProtection = "X-XSS-Protection"
HeaderXFrameOptions = "X-Frame-Options"
HeaderContentSecurityPolicy = "Content-Security-Policy"
HeaderXCSRFToken = "X-CSRF-Token"
)
// Status
// HTTP status codes as registered with IANA.
// See: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
const (
StatusContinue = 100 // RFC 7231, 6.2.1
StatusSwitchingProtocols = 101 // RFC 7231, 6.2.2
StatusProcessing = 102 // RFC 2518, 10.1
StatusOK = 200 // RFC 7231, 6.3.1
StatusCreated = 201 // RFC 7231, 6.3.2
StatusAccepted = 202 // RFC 7231, 6.3.3
StatusNonAuthoritativeInfo = 203 // RFC 7231, 6.3.4
StatusNoContent = 204 // RFC 7231, 6.3.5
StatusResetContent = 205 // RFC 7231, 6.3.6
StatusPartialContent = 206 // RFC 7233, 4.1
StatusMultiStatus = 207 // RFC 4918, 11.1
StatusAlreadyReported = 208 // RFC 5842, 7.1
StatusIMUsed = 226 // RFC 3229, 10.4.1
StatusMultipleChoices = 300 // RFC 7231, 6.4.1
StatusMovedPermanently = 301 // RFC 7231, 6.4.2
StatusFound = 302 // RFC 7231, 6.4.3
StatusSeeOther = 303 // RFC 7231, 6.4.4
StatusNotModified = 304 // RFC 7232, 4.1
StatusUseProxy = 305 // RFC 7231, 6.4.5
_ = 306 // RFC 7231, 6.4.6 (Unused)
StatusTemporaryRedirect = 307 // RFC 7231, 6.4.7
StatusPermanentRedirect = 308 // RFC 7538, 3
StatusBadRequest = 400 // RFC 7231, 6.5.1
StatusUnauthorized = 401 // RFC 7235, 3.1
StatusPaymentRequired = 402 // RFC 7231, 6.5.2
StatusForbidden = 403 // RFC 7231, 6.5.3
StatusNotFound = 404 // RFC 7231, 6.5.4
StatusMethodNotAllowed = 405 // RFC 7231, 6.5.5
StatusNotAcceptable = 406 // RFC 7231, 6.5.6
StatusProxyAuthRequired = 407 // RFC 7235, 3.2
StatusRequestTimeout = 408 // RFC 7231, 6.5.7
StatusConflict = 409 // RFC 7231, 6.5.8
StatusGone = 410 // RFC 7231, 6.5.9
StatusLengthRequired = 411 // RFC 7231, 6.5.10
StatusPreconditionFailed = 412 // RFC 7232, 4.2
StatusRequestEntityTooLarge = 413 // RFC 7231, 6.5.11
StatusRequestURITooLong = 414 // RFC 7231, 6.5.12
StatusUnsupportedMediaType = 415 // RFC 7231, 6.5.13
StatusRequestedRangeNotSatisfiable = 416 // RFC 7233, 4.4
StatusExpectationFailed = 417 // RFC 7231, 6.5.14
StatusTeapot = 418 // RFC 7168, 2.3.3
StatusUnprocessableEntity = 422 // RFC 4918, 11.2
StatusLocked = 423 // RFC 4918, 11.3
StatusFailedDependency = 424 // RFC 4918, 11.4
StatusUpgradeRequired = 426 // RFC 7231, 6.5.15
StatusPreconditionRequired = 428 // RFC 6585, 3
StatusTooManyRequests = 429 // RFC 6585, 4
StatusRequestHeaderFieldsTooLarge = 431 // RFC 6585, 5
StatusUnavailableForLegalReasons = 451 // RFC 7725, 3
StatusInternalServerError = 500 // RFC 7231, 6.6.1
StatusNotImplemented = 501 // RFC 7231, 6.6.2
StatusBadGateway = 502 // RFC 7231, 6.6.3
StatusServiceUnavailable = 503 // RFC 7231, 6.6.4
StatusGatewayTimeout = 504 // RFC 7231, 6.6.5
StatusHTTPVersionNotSupported = 505 // RFC 7231, 6.6.6
StatusVariantAlsoNegotiates = 506 // RFC 2295, 8.1
StatusInsufficientStorage = 507 // RFC 4918, 11.5
StatusLoopDetected = 508 // RFC 5842, 7.2
StatusNotExtended = 510 // RFC 2774, 7
StatusNetworkAuthenticationRequired = 511 // RFC 6585, 6
)
var statusText = map[int]string{
StatusContinue: "Continue",
StatusSwitchingProtocols: "Switching Protocols",
StatusProcessing: "Processing",
StatusOK: "OK",
StatusCreated: "Created",
StatusAccepted: "Accepted",
StatusNonAuthoritativeInfo: "Non-Authoritative Information",
StatusNoContent: "No Content",
StatusResetContent: "Reset Content",
StatusPartialContent: "Partial Content",
StatusMultiStatus: "Multi-Status",
StatusAlreadyReported: "Already Reported",
StatusIMUsed: "IM Used",
StatusMultipleChoices: "Multiple Choices",
StatusMovedPermanently: "Moved Permanently",
StatusFound: "Found",
StatusSeeOther: "See Other",
StatusNotModified: "Not Modified",
StatusUseProxy: "Use Proxy",
StatusTemporaryRedirect: "Temporary Redirect",
StatusPermanentRedirect: "Permanent Redirect",
StatusBadRequest: "Bad Request",
StatusUnauthorized: "Unauthorized",
StatusPaymentRequired: "Payment Required",
StatusForbidden: "Forbidden",
StatusNotFound: "Not Found",
StatusMethodNotAllowed: "Method Not Allowed",
StatusNotAcceptable: "Not Acceptable",
StatusProxyAuthRequired: "Proxy Authentication Required",
StatusRequestTimeout: "Request Timeout",
StatusConflict: "Conflict",
StatusGone: "Gone",
StatusLengthRequired: "Length Required",
StatusPreconditionFailed: "Precondition Failed",
StatusRequestEntityTooLarge: "Request Entity Too Large",
StatusRequestURITooLong: "Request URI Too Long",
StatusUnsupportedMediaType: "Unsupported Media Type",
StatusRequestedRangeNotSatisfiable: "Requested Range Not Satisfiable",
StatusExpectationFailed: "Expectation Failed",
StatusTeapot: "I'm a teapot",
StatusUnprocessableEntity: "Unprocessable Entity",
StatusLocked: "Locked",
StatusFailedDependency: "Failed Dependency",
StatusUpgradeRequired: "Upgrade Required",
StatusPreconditionRequired: "Precondition Required",
StatusTooManyRequests: "Too Many Requests",
StatusRequestHeaderFieldsTooLarge: "Request Header Fields Too Large",
StatusUnavailableForLegalReasons: "Unavailable For Legal Reasons",
StatusInternalServerError: "Internal Server Error",
StatusNotImplemented: "Not Implemented",
StatusBadGateway: "Bad Gateway",
StatusServiceUnavailable: "Service Unavailable",
StatusGatewayTimeout: "Gateway Timeout",
StatusHTTPVersionNotSupported: "HTTP Version Not Supported",
StatusVariantAlsoNegotiates: "Variant Also Negotiates",
StatusInsufficientStorage: "Insufficient Storage",
StatusLoopDetected: "Loop Detected",
StatusNotExtended: "Not Extended",
StatusNetworkAuthenticationRequired: "Network Authentication Required",
}
// StatusText returns a text for the HTTP status code. It returns the empty
// string if the code is unknown.
func StatusText(code int) string {
return statusText[code]
}
// New creates a new Makross object.
func New() (m *Makross) {
m = &Makross{
Server: new(http.Server),
namedRoutes: make(map[string]*Route),
stores: make(map[string]routeStore),
QueuesMap: new(sync.Map),
FiltersMap: new(sync.Map),
}
m.Server.Handler = m
m.RouteGroup = *newRouteGroup("", m, make([]Handler, 0))
m.NotFound(MethodNotAllowedHandler, NotFoundHandler)
m.SetBinder(&DefaultBinder{})
m.pool.New = func() interface{} {
return m.NewContext(nil, nil)
}
return m
}
// NewContext returns a Context instance.
func (m *Makross) NewContext(r *http.Request, w http.ResponseWriter, handlers ...Handler) *Context {
c := &Context{
Request: r,
Response: NewResponse(w, m),
makross: m,
pvalues: make([]string, m.maxParams),
handlers: handlers,
}
c.Reset(w, r)
return c
}
// AcquireContext returns an empty `Context` instance from the pool.
// You must return the context by calling `ReleaseContext()`.
func (m *Makross) AcquireContext() *Context {
if ctx, okay := m.pool.Get().(*Context); okay {
return ctx
}
panic("Not Standard Makross Context")
}
// ReleaseContext returns the `Context` instance back to the pool.
// You must call it after `AcquireContext()`.
func (m *Makross) ReleaseContext(c *Context) {
m.pool.Put(c)
}
// ServeHTTP handles the HTTP request.
// It is required by http.Handler
func (m *Makross) ServeHTTP(res http.ResponseWriter, req *http.Request) {
c := m.AcquireContext()
c.Reset(res, req)
c.Response.Header().Set("Server", "Makross")
c.handlers, c.pnames = m.find(req.Method, req.URL.Path, c.pvalues)
if err := c.Next(); err != nil {
m.HandleError(c, err)
}
m.ReleaseContext(c)
}
// Shutdown 优雅停止HTTP服务 不超过特定时长
func (m *Makross) Shutdown(times ...int64) error {
var n time.Duration
if len(times) > 0 {
n = time.Duration(times[0])
} else {
n = 3
}
// shut down gracefully, but wait no longer than n seconds before halting
ctx, _ := context.WithTimeout(context.Background(), n*time.Second)
m.DoActionHook("MakrossShutdown")
return m.Server.Shutdown(ctx)
}
// Close 立即关闭HTTP服务
func (m *Makross) Close() error {
m.DoActionHook("MakrossClose")
return m.Server.Close()
}
// Route returns the named route.
// Nil is returned if the named route cannot be found.
func (m *Makross) Route(name string) *Route {
return m.namedRoutes[name]
}
// Routes returns all routes managed by the makross.
func (m *Makross) Routes() []*Route {
return m.routes
}
// Use appends the specified handlers to the makross and shares them with all routes.
func (r *Makross) Use(handlers ...Handler) {
r.RouteGroup.Use(handlers...)
r.notFoundHandlers = combineHandlers(r.handlers, r.notFound)
}
// SetRenderer registers an HTML template renderer. It's invoked by `Context#Render()`.
func (m *Makross) SetRenderer(r Renderer) {
m.renderer = r
}
// SetBinder registers a custom binder. It's invoked by `Context#Bind()`.
func (m *Makross) SetBinder(b Binder) {
m.binder = b
}
// Binder returns the binder instance.
func (m *Makross) Binder() Binder {
return m.binder
}
func (m *Makross) Pull(key string) interface{} {
return m.data[key]
}
func (m *Makross) Push(key string, value interface{}) {
if m.data == nil {
m.data = make(map[string]interface{})
}
m.data[key] = value
}
func (m *Makross) PullStore() map[string]interface{} {
return m.data
}
func (m *Makross) PushStore(data map[string]interface{}) {
if m.data == nil {
m.data = make(map[string]interface{})
}
for k, v := range data {
m.data[k] = v
}
}
// Static registers a new route with path prefix to serve static files from the
// provided root directory.
func (m *Makross) Static(prefix, root string) {
if prefix == "/" {
prefix = prefix + "*"
} else if len(prefix) > 1 {
if prefix[:1] != "/" {
prefix = prefix + "/*"
} else {
prefix = prefix + "*"
}
}
m.Get(prefix, func(c *Context) error {
return c.ServeFile(path.Join(root, c.Parameter(0)))
})
}
// File registers a new route with path to serve a static file.
func (m *Makross) File(path, file string) {
m.Get(path, func(c *Context) error {
return c.ServeFile(file)
})
}
// NotFound specifies the handlers that should be invoked when the makross cannot find any route matching a request.
// Note that the handlers registered via Use will be invoked first in this case.
func (r *Makross) NotFound(handlers ...Handler) {
r.notFound = handlers
r.notFoundHandlers = combineHandlers(r.handlers, r.notFound)
}
// HandleError is the error handler for handling any unhandled errors.
/*
func (r *Makross) HandleError(c *Context, err error) {
if httpError, okay := err.(HTTPError); okay {
http.Error(c.Response, httpError.Error(), httpError.StatusCode())
} else {
if e, o := err.(error); o {
http.Error(c.Response, e.Error(), StatusInternalServerError)
}
}
}
*/
// NewHTTPError creates a new HTTPError instance.
func (m *Makross) NewHTTPError(status int, message ...interface{}) *HTTPError {
return NewHTTPError(status, message...)
}
// HandleError is the error handler for handling any unhandled errors.
func (m *Makross) HandleError(c *Context, err interface{}) {
status := StatusInternalServerError
msg := StatusText(status)
if httpError, okay := err.(*HTTPError); okay {
status = httpError.Status
msg = httpError.Message
} else if iError, okay := err.(error); okay {
msg = iError.Error()
}
if c.Request != nil && c.Request.Method == HEAD {
c.NoContent(status)
} else {
c.String(msg, status)
}
}
func (r *Makross) addRoute(route *Route, handlers []Handler) {
path := route.group.prefix + route.path
r.routes = append(r.routes, route)
store := r.stores[route.method]
if store == nil {
store = newStore()
r.stores[route.method] = store
}
// an asterisk at the end matches any number of characters
if strings.HasSuffix(path, "*") {
path = path[:len(path)-1] + "<:.*>"
}
if n := store.Add(path, handlers); n > r.maxParams {
r.maxParams = n
}
}
func (m *Makross) find(method, path string, pvalues []string) (handlers []Handler, pnames []string) {
var hs interface{}
if store := m.stores[method]; store != nil {
hs, pnames = store.Get(path, pvalues)
}
if hs != nil {
return hs.([]Handler), pnames
}
return m.notFoundHandlers, pnames
}
func (r *Makross) findAllowedMethods(path string) map[string]bool {
methods := make(map[string]bool)
pvalues := make([]string, r.maxParams)
for m, store := range r.stores {
if handlers, _ := store.Get(path, pvalues); handlers != nil {
methods[m] = true
}
}
return methods
}
// NotFoundHandler returns a 404 HTTP error indicating a request has no matching route.
func NotFoundHandler(*Context) error {
return NewHTTPError(StatusNotFound)
}
// MethodNotAllowedHandler handles the situation when a request has matching route without matching HTTP method.
// In this case, the handler will respond with an Allow HTTP header listing the allowed HTTP methods.
// Otherwise, the handler will do nothing and let the next handler (usually a NotFoundHandler) to handle the problem.
func MethodNotAllowedHandler(c *Context) error {
methods := c.Makross().findAllowedMethods(c.Request.URL.Path)
if len(methods) == 0 {
return nil
}
methods["OPTIONS"] = true
ms := make([]string, len(methods))
i := 0
for method := range methods {
ms[i] = method
i++
}
sort.Strings(ms)
c.Response.Header().Set("Allow", strings.Join(ms, ", "))
if c.Request.Method != "OPTIONS" {
c.Response.WriteHeader(StatusMethodNotAllowed)
}
c.Abort()
return nil
}
// HTTPHandlerFunc adapts a http.HandlerFunc into a makross.Handler.
func HTTPHandlerFunc(h http.HandlerFunc) Handler {
return func(c *Context) error {
h(c.Response, c.Request)
return nil
}
}
// HTTPHandler adapts a http.Handler into a makross.Handler.
func HTTPHandler(h http.Handler) Handler {
return func(c *Context) error {
h.ServeHTTP(c.Response, c.Request)
return nil
}
}
// SetConfig sets data sources for configuration.
func SetConfig(source interface{}, others ...interface{}) (_ *ini.File, err error) {
cfg, err = ini.Load(source, others...)
return Config(), err
}
// Config returns configuration convention object.
// It returns an empty object if there is no one available.
func Config() *ini.File {
if cfg == nil {
return ini.Empty()
}
return cfg
}