forked from naoina/kocha
-
Notifications
You must be signed in to change notification settings - Fork 0
/
router.go
521 lines (481 loc) · 14.4 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
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
package kocha
import (
"fmt"
"go/ast"
"go/build"
"go/parser"
"go/token"
"net/http"
"net/url"
"os"
"path"
"path/filepath"
"reflect"
"regexp"
"strconv"
"strings"
"github.com/naoina/kocha-urlrouter"
_ "github.com/naoina/kocha-urlrouter/doublearray"
"github.com/naoina/kocha/util"
)
var (
controllerMethods = map[string]bool{
"Get": true,
"Post": true,
"Put": true,
"Delete": true,
"Head": true,
"Patch": true,
}
typeValidateParsers = map[string]TypeValidateParser{
"string": &StringTypeValidateParser{regexp.MustCompile(`\A[\w-]+\z`)},
"int": &IntTypeValidateParser{regexp.MustCompile(`\A\d+\z`)},
"*url.URL": &URLTypeValidateParser{regexp.MustCompile(`\A[\w-/.]+\z`)},
}
)
type RouteTable []*Route
func (rt RouteTable) buildRouter() (*router, error) {
for _, route := range rt {
route.normalize()
}
for _, route := range rt {
if err := route.validateControllerType(); err != nil {
return nil, err
}
if route.MethodTypes == nil {
if err := route.buildMethodTypes(); err != nil {
return nil, err
}
}
}
router, err := newRouter(rt)
if err != nil {
return nil, err
}
for _, route := range rt {
info := router.reverse[route.Name]
route.paramNames = info.paramNames
}
for _, route := range rt {
for _, validator := range []func() error{
route.validateTypeValidateParser,
route.validateControllerMethodSignature,
route.validateRouteParameters,
route.validateControllerArgumentParameters,
} {
if err := validator(); err != nil {
return nil, err
}
}
}
return router, nil
}
// router represents a router of kocha.
type router struct {
forward forwardRouter
reverse reverseRouter
routeTable RouteTable
}
// newRouter returns a new router.
func newRouter(rt RouteTable) (*router, error) {
router := &router{routeTable: rt}
if err := router.buildForward(); err != nil {
return nil, err
}
if err := router.buildReverse(); err != nil {
return nil, err
}
return router, nil
}
func (router *router) dispatch(req *http.Request) (controller *reflect.Value, method *reflect.Value, args []reflect.Value) {
methodName := strings.Title(strings.ToLower(req.Method))
path := util.NormPath(req.URL.Path)
data, params := router.forward.Lookup(path)
if data == nil {
return nil, nil, nil
}
route := data.(*Route)
return route.dispatch(methodName, params)
}
// buildForward builds forward router.
func (router *router) buildForward() error {
records := make([]urlrouter.Record, len(router.routeTable))
for i, route := range router.routeTable {
records[i] = urlrouter.NewRecord(route.Path, route)
}
router.forward = urlrouter.NewURLRouter("doublearray")
if err := router.forward.Build(records); err != nil {
return err
}
return nil
}
// buildReverse builds reverse router.
func (router *router) buildReverse() error {
router.reverse = make(reverseRouter)
for _, route := range router.routeTable {
paramNames := urlrouter.ParamNames(route.Path)
names := make([]string, len(paramNames))
for i := 0; i < len(paramNames); i++ {
names[i] = paramNames[i][1:] // truncate the meta character.
}
router.reverse[route.Name] = &routeInfo{
route: route,
rawParamNames: paramNames,
paramNames: names,
}
}
return nil
}
type forwardRouter urlrouter.URLRouter
type reverseRouter map[string]*routeInfo
// Route represents a route.
type Route struct {
Name string
Path string
Controller interface{}
MethodTypes methodTypes
paramNames []string
}
func (route *Route) dispatch(methodName string, params []urlrouter.Param) (controller *reflect.Value, method *reflect.Value, args []reflect.Value) {
methodArgs := route.MethodTypes[methodName]
if methodArgs == nil {
return nil, nil, nil
}
for _, param := range params {
t := methodArgs[param.Name]
validateParser := typeValidateParsers[t]
arg, err := validateParser.Parse(param.Value)
if err != nil {
return nil, nil, nil
}
if !validateParser.Validate(arg) {
return nil, nil, nil
}
args = append(args, reflect.ValueOf(arg))
}
t := reflect.TypeOf(route.Controller)
c := reflect.New(t)
m := c.MethodByName(methodName)
return &c, &m, args
}
func (route *Route) normalize() {
v := reflect.ValueOf(route.Controller)
for v.Kind() == reflect.Ptr {
v = v.Elem()
}
if v.IsValid() {
route.Controller = v.Interface()
} else {
route.Controller = nil
}
}
func (route *Route) buildMethodTypes() error {
controller := reflect.TypeOf(route.Controller)
cname := controller.Name()
pkgPath := controller.PkgPath()
pkgDir, err := findPkgDir(pkgPath)
if err != nil {
return err
}
if pkgDir == "" {
return fmt.Errorf("%v: package not found", pkgPath)
}
pkgInfo, err := util.ImportDir(pkgDir, 0)
if err != nil {
return err
}
astFiles := make([]*ast.File, len(pkgInfo.GoFiles))
for i, goFilePath := range pkgInfo.GoFiles {
if astFiles[i], err = parser.ParseFile(token.NewFileSet(), filepath.Join(pkgInfo.Dir, goFilePath), nil, 0); err != nil {
return err
}
}
route.MethodTypes = make(map[string]map[string]string)
for _, file := range astFiles {
for _, d := range file.Decls {
ast.Inspect(d, func(node ast.Node) bool {
fdecl, ok := node.(*ast.FuncDecl)
if !ok || fdecl.Recv == nil {
return false
}
var recv string
switch t := fdecl.Recv.List[0].Type.(type) {
case *ast.StarExpr:
recv = t.X.(*ast.Ident).Name
case *ast.Ident:
recv = t.Name
}
if recv != cname {
return false
}
methodName := fdecl.Name.Name
if _, ok := controllerMethods[methodName]; !ok {
return false
}
route.MethodTypes[methodName] = make(map[string]string)
for _, v := range fdecl.Type.Params.List {
typeName := astTypeName(v.Type)
for _, name := range v.Names {
route.MethodTypes[methodName][name.Name] = typeName
}
}
return false
})
}
}
return nil
}
func (route *Route) validateRouteParameters() error {
var errors []string
paramNames := make(map[string]bool)
for _, name := range route.paramNames {
paramNames[name] = true
}
for methodName, args := range route.MethodTypes {
var defNames []string
for name := range args {
if !paramNames[name] {
defNames = append(defNames, name)
}
}
if length := len(defNames); length > 0 {
var format string
switch {
case length == 1:
format = "argument `%v` is defined in `%v.%v`, but route parameter is not defined"
case length > 1:
format = "arguments `%v` are defined in `%v.%v`, but route parameters are not defined"
}
controllerName := reflect.TypeOf(route.Controller).Name()
names := strings.Join(defNames, "`, `")
errors = append(errors, fmt.Sprintf(format, names, controllerName, methodName))
}
}
if len(errors) > 0 {
return fmt.Errorf(strings.Join(errors, "\n"+strings.Repeat(" ", len("panic: "))))
}
return nil
}
func (route *Route) validateControllerArgumentParameters() error {
argNames := make(map[string]bool)
for _, args := range route.MethodTypes {
for name := range args {
argNames[name] = true
}
}
var defNames []string
for _, name := range route.paramNames {
if !argNames[name] {
defNames = append(defNames, name)
}
}
if len(defNames) > 0 {
var format string
switch {
case len(defNames) == 1:
format = "route parameter `%v` is defined in route `%v`, but argument is not defined in %v of `%v`"
case len(defNames) > 1:
format = "route parameters `%v` are defined in route `%v`, but arguments are not defined in %v of `%v`"
}
names := strings.Join(defNames, "`, `")
var methNames []string
for name := range route.MethodTypes {
methNames = append(methNames, name)
}
methName := strings.Join(methNames, "/")
controllerName := reflect.TypeOf(route.Controller).Name()
return fmt.Errorf(format, names, route.Name, methName, controllerName)
}
return nil
}
func (route *Route) validateTypeValidateParser() error {
var errors []string
for _, args := range route.MethodTypes {
for _, t := range args {
if typeValidateParsers[t] == nil {
errors = append(errors, fmt.Sprintf("TypeValidateParser of %#v is not set", t))
}
}
}
if len(errors) > 0 {
return fmt.Errorf(strings.Join(errors, "\n"+strings.Repeat(" ", len("panic: "))))
}
return nil
}
func (route *Route) validateControllerMethodSignature() error {
var errors []string
controller := reflect.TypeOf(route.Controller)
for methodName, _ := range route.MethodTypes {
meth, found := reflect.PtrTo(controller).MethodByName(methodName)
if !found {
return fmt.Errorf("BUG: method `%v` is not found in `%v.%v`", methodName, path.Base(controller.PkgPath()), controller.Name())
}
if num := meth.Type.NumOut(); num != 1 {
errors = append(errors, fmt.Sprintf("by %v.%v.%v, number of return value must be 1, but %v", path.Base(controller.PkgPath()), controller.Name(), meth.Name, num))
continue
}
resultType := reflect.TypeOf((*Result)(nil)).Elem()
if rtype := meth.Type.Out(0); !rtype.Implements(resultType) {
errors = append(errors, fmt.Sprintf("by %v.%v.%v, type of return value must be `%v`, but `%v`", path.Base(controller.PkgPath()), controller.Name(), meth.Name, resultType, rtype))
}
}
if len(errors) > 0 {
return fmt.Errorf(strings.Join(errors, "\n"+strings.Repeat(" ", len("panic: "))))
}
return nil
}
func (route *Route) validateControllerType() error {
c := reflect.ValueOf(route.Controller)
if c.Kind() != reflect.Struct || !c.FieldByName("Controller").IsValid() {
return fmt.Errorf(`Controller of route "%s" must be any type of embedded %T or that pointer, but %T`, route.Name, Controller{}, route.Controller)
}
switch cc := c.FieldByName("Controller").Interface().(type) {
case Controller:
case *Controller:
default:
return fmt.Errorf("Controller field must be struct of %T or that pointer, but %T", Controller{}, cc)
}
return nil
}
type methodTypes map[string]map[string]string
func (mt methodTypes) GoString() string {
return util.GoString(map[string]map[string]string(mt))
}
type routeInfo struct {
route *Route
rawParamNames []string
paramNames []string
}
// Reverse returns path of route by name and any params.
func Reverse(name string, v ...interface{}) string {
info := appConfig.router.reverse[name]
if info == nil {
types := make([]string, len(v))
for i, value := range v {
types[i] = reflect.TypeOf(value).Name()
}
panic(fmt.Errorf("no match route found: %v (%v)", name, strings.Join(types, ", ")))
}
return info.reverse(v...)
}
func (ri *routeInfo) reverse(v ...interface{}) string {
route := ri.route
switch vlen, nlen := len(v), len(ri.paramNames); {
case vlen < nlen:
panic(fmt.Errorf("too few arguments: %v (controller is %v)", route.Name, reflect.TypeOf(route.Controller).Name()))
case vlen > nlen:
panic(fmt.Errorf("too many arguments: %v (controller is %v)", route.Name, reflect.TypeOf(route.Controller).Name()))
case vlen+nlen == 0:
return route.Path
}
var arg map[string]string
for _, arg = range route.MethodTypes {
break
}
for i := 0; i < len(v); i++ {
t := arg[ri.paramNames[i]]
validateParser := typeValidateParsers[t]
if !validateParser.Validate(v[i]) {
panic(fmt.Errorf("parameter type mismatch: %v (controller is %v)", route.Name, reflect.TypeOf(route.Controller).Name()))
}
}
var oldnew []string
for i := 0; i < len(v); i++ {
oldnew = append(oldnew, ri.rawParamNames[i], fmt.Sprint(v[i]))
}
replacer := strings.NewReplacer(oldnew...)
path := replacer.Replace(route.Path)
return util.NormPath(path)
}
// TypeValidateParser is an interface of validator and parser for any type value.
type TypeValidateParser interface {
// Validate returns whether the valid value as any type.
Validate(v interface{}) bool
// Parse returns value that parses v as any type.
Parse(v string) (value interface{}, err error)
}
// SetTypeValidateParser sets the TypeValidateParser by given type name.
func SetTypeValidateParser(name string, validateParser TypeValidateParser) {
typeValidateParsers[name] = validateParser
}
// SetTypeValidateParserByValue sets the TypeValidateParser by type of v.
func SetTypeValidateParserByValue(v interface{}, validateParser TypeValidateParser) {
SetTypeValidateParser(reflect.TypeOf(v).String(), validateParser)
}
// StringTypeValidateParser represents a TypeValidateParser for string.
type StringTypeValidateParser struct {
stringRegexp *regexp.Regexp
}
// Validate returns whether the valid value as string of path parameter.
func (validateParser *StringTypeValidateParser) Validate(v interface{}) bool {
if s, ok := v.(string); ok {
return validateParser.stringRegexp.MatchString(s)
}
return false
}
// Parse returns value that parses v as string type.
func (validateParser *StringTypeValidateParser) Parse(v string) (value interface{}, err error) {
return v, nil
}
// IntTypeValidateParser represents a TypeValidateParser for int.
type IntTypeValidateParser struct {
intRegexp *regexp.Regexp
}
// Validate returns whether the valid value as int of path parameter.
func (validateParser *IntTypeValidateParser) Validate(v interface{}) bool {
if i, ok := v.(int); ok {
return validateParser.intRegexp.MatchString(fmt.Sprint(i))
}
return false
}
// Parse returns value that parses v as int type.
func (validateParser *IntTypeValidateParser) Parse(v string) (value interface{}, err error) {
return strconv.Atoi(v)
}
// URLTypeValidateParser represents a TypeValidateParser for url.URL.
type URLTypeValidateParser struct {
urlRegexp *regexp.Regexp
}
// Validate returns whether the valid value as url.URL of path parameter.
func (validateParser *URLTypeValidateParser) Validate(v interface{}) bool {
var s string
switch t := v.(type) {
case string:
s = t
case *url.URL:
s = t.Path
default:
return false
}
return validateParser.urlRegexp.MatchString(s)
}
// Parse returns value that parses v as url.URL type.
func (validateParser *URLTypeValidateParser) Parse(v string) (value interface{}, err error) {
return url.Parse(v)
}
func findPkgDir(pkgPath string) (string, error) {
var pkgDir string
for _, srcDir := range build.Default.SrcDirs() {
path, err := filepath.Abs(filepath.Join(srcDir, pkgPath))
if err != nil {
return "", err
}
if _, err := os.Stat(path); err == nil {
pkgDir = path
break
}
}
return pkgDir, nil
}
func astTypeName(expr ast.Expr) string {
switch t := expr.(type) {
case *ast.Ident:
return t.Name
case *ast.SelectorExpr:
return fmt.Sprintf("%v.%v", t.X.(*ast.Ident).Name, t.Sel.Name)
case *ast.StarExpr:
return fmt.Sprintf("*%s", astTypeName(t.X))
default:
panic(fmt.Errorf("sorry, unexpected argument type `%T` found. please report this issue.", t))
}
}