-
Notifications
You must be signed in to change notification settings - Fork 0
/
controllerFetcher.go
395 lines (292 loc) · 8.49 KB
/
controllerFetcher.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
package fetcher
import (
"fmt"
"io/ioutil"
"log"
"os"
"path"
"path/filepath"
"strconv"
"strings"
"unicode"
"github.com/macinnir/dvc/core/lib"
)
const (
RouteArgTypeString = "string"
RouteArgTypeNumber = "int64"
// Route Tags
RouteTagAnonymous = "@anonymous"
RouteTagAnyone = "@anyone"
RouteTagBody = "@body"
RouteTagResponse = "@response"
RouteTagRoute = "@route"
)
type ControllerFetcher struct {
routeMap map[string]bool
}
func NewControllerFetcher() *ControllerFetcher {
return &ControllerFetcher{
routeMap: map[string]bool{},
}
}
func (cf *ControllerFetcher) FetchAll() (controllers []*lib.Controller, dirs []string, e error) {
controllers, dirs, e = cf.Fetch("core/api")
if e != nil {
return
}
appControllers, appDirs, e := cf.Fetch("app/api")
if e != nil {
return
}
controllers = append(controllers, appControllers...)
dirs = append(dirs, appDirs...)
return
}
func (cf *ControllerFetcher) Fetch(dir string) (controllers []*lib.Controller, dirs []string, e error) {
controllers = []*lib.Controller{}
dirs = []string{}
var files []os.FileInfo
files, e = ioutil.ReadDir(dir)
if e != nil {
log.Println("ERROR: Fetch Controllers - ", dir, e.Error())
return
}
for k := range files {
filePath := path.Join(dir, files[k].Name())
if files[k].IsDir() {
dirs = append(dirs, filePath)
var subControllers []*lib.Controller
if subControllers, _, e = cf.Fetch(filePath); e != nil {
return
}
controllers = append(controllers, subControllers...)
continue
}
// Build a controller object from the controller file
var controller *lib.Controller
if controller, e = cf.BuildControllerObjFromControllerFile(filePath); e != nil {
return
}
if controller != nil {
controllers = append(controllers, controller)
}
}
return
}
// BuildControllerObjFromControllerFile parses a file and extracts all of its @route comments
func (cf *ControllerFetcher) BuildControllerObjFromControllerFile(filePath string) (controller *lib.Controller, e error) {
pkgName := filepath.Base(filepath.Dir(filePath))
controllerName := extractControllerNameFromFileName(filePath)
if controllerName == "" {
return nil, nil
}
var src []byte
src, e = ioutil.ReadFile(filePath)
if e != nil {
log.Println("Error with ", filePath)
return
}
controller = &lib.Controller{
Name: controllerName,
Path: filePath,
Routes: []*lib.ControllerRoute{},
Package: pkgName,
}
controllerFullName := controller.Name + "Controller"
// Get the controller name
var methods []lib.Method
methods, _, controller.Description = lib.ParseStruct(src, controllerFullName, true, true, "controllers")
// Remove the name of the controller from the description
controller.Description = strings.TrimPrefix(controller.Description, controller.Name)
for k := range methods {
route := parseControllerMethod(methods[k], controller)
routeSignature := route.Method + " " + route.Path
if _, ok := cf.routeMap[routeSignature]; ok {
e = fmt.Errorf("Duplicate route signature `%s` for method `%s`.`%s`", routeSignature, controller.Name, route.Name)
return
}
route.FileName = filePath
controller.Routes = append(controller.Routes, route)
}
return
}
func parseControllerMethod(
method lib.Method,
controller *lib.Controller,
) *lib.ControllerRoute {
var e error
route := &lib.ControllerRoute{
Queries: []lib.ControllerRouteQuery{},
Params: []lib.ControllerRouteParam{},
}
isAnyone := false
for line, doc := range method.Documents {
// This is the title of the method
if line == 0 {
lineParts := strings.Split(doc, " ")
route.Name = lineParts[1]
route.Description = strings.Join(lineParts[2:], " ")
continue
}
route.IsAuth = true
// @anonymous
if len(doc) > 12 && doc[0:13] == "// "+RouteTagAnonymous {
route.IsAuth = false
continue
}
// @anyone
if len(doc) > 9 && doc[0:10] == "// "+RouteTagAnyone {
isAnyone = true
continue
}
// @body
if len(doc) > 9 && doc[0:9] == fmt.Sprintf("// %s ", RouteTagBody) {
bodyComment := strings.Split(strings.Trim(doc[9:], " "), " ")
route.BodyFormat = bodyComment[0]
if len(bodyComment) > 1 {
route.BodyType = bodyComment[1]
}
controller.HasDTOsImport = true
controller.HasResponseImport = true
route.HasBody = true
continue
}
// @response (last line)
if len(doc) > 13 && doc[0:13] == fmt.Sprintf("// %s ", RouteTagResponse) {
responseComment := strings.Split(strings.Trim(doc[13:], " "), " ")
if route.ResponseCode, e = strconv.Atoi(responseComment[0]); e != nil {
log.Fatalf("Invalid @response comment: %s at %s.%s", doc, controller.Name, route.Name)
}
if len(responseComment) > 1 {
route.ResponseFormat = responseComment[1]
}
if len(responseComment) > 2 {
route.ResponseType = responseComment[2]
}
continue
}
var e error
// @route
if len(doc) > 9 && doc[0:9] == "// "+RouteTagRoute {
if e = parseRouteString(route, doc); e != nil {
log.Fatalf("method `%s.%s`: `%s`", controller.Name, route.Name, e.Error())
}
} else {
route.Description += " " + doc[3:]
}
}
if route.IsAuth && !isAnyone {
controller.PermCount++
route.Permission = controller.Name + "_" + route.Name
}
// TODO coming back to this
// route.LineNo = method.LineNo
route.ControllerName = controller.Name
return route
}
func extractControllerNameFromFileName(path string) string {
fileName := filepath.Base(path)
// Must be aleast 14 chars (e.g. AController.go)
// fmt.Println("Extracting controller name", fileName)
if
// 14 chars
len(fileName) < 14 ||
// .go extension
fileName[len(fileName)-3:] != ".go" ||
// Uppercase first letter
!unicode.IsUpper([]rune(fileName)[0]) ||
// Not a test file
fileName[len(fileName)-8:] == "_test.go" {
return ""
}
return fileName[:len(fileName)-13]
}
func parseRouteString(route *lib.ControllerRoute, routeString string) error {
lineParts := strings.Split(routeString, " ")
if len(lineParts) < 4 {
return fmt.Errorf("invalid route comment `%s`", routeString)
}
route.Method = lineParts[2]
route.Raw = lineParts[3]
route.Path, route.Queries = extractQueriesFromRoutePath(route.Raw)
params, _ := extractParamsFromRoutePath(route.Path)
route.Params = append(route.Params, params...)
return nil
}
func extractParamsFromRoutePath(routePath string) (params []lib.ControllerRouteParam, e error) {
params = []lib.ControllerRouteParam{}
// Params
if strings.Contains(routePath, "{") {
routeParts := strings.Split(routePath, "{")
for _, p := range routeParts[1:] {
if !strings.Contains(p, "}") || !strings.Contains(p, ":") {
continue
}
param := extractParamFromString(p)
params = append(params, param)
}
}
return
}
func extractParamFromString(paramString string) (param lib.ControllerRouteParam) {
// Incase there are parts after the param, split on the closing bracket
pParts := strings.Split(paramString, "}")
paramString = pParts[0]
paramParts := strings.Split(paramString, ":")
param = lib.ControllerRouteParam{
Name: paramParts[0],
Pattern: paramParts[1],
}
param.Type = matchPatternToDataType(param.Pattern)
return
}
func matchPatternToDataType(pattern string) string {
if pattern == "[0-9]" || pattern == "[0-9]+" {
return "int64"
}
return "string"
}
func extractQueriesFromRoutePath(routePath string) (string, []lib.ControllerRouteQuery) {
queries := []lib.ControllerRouteQuery{}
if !strings.Contains(routePath, "?") {
return routePath, queries
}
subParts := strings.Split(routePath, "?")
routePath = subParts[0]
queryStrings := strings.Split(subParts[1], "&")
for _, query := range queryStrings {
if !strings.Contains(query, "=") {
continue
}
queryParts := strings.Split(query, "=")
o := lib.ControllerRouteQuery{
Name: queryParts[0],
ValueRaw: queryParts[1],
}
if strings.Contains(o.ValueRaw, ":") {
queryValueParts := strings.Split(o.ValueRaw, ":")
// Remove the starting "{"
o.VariableName = queryValueParts[0][1:]
// Remove the ending "}"
o.Pattern = strings.Join(queryValueParts[1:], ":")
o.Pattern = o.Pattern[0 : len(o.Pattern)-1]
// Check if the value isn't a constant value
if o.Pattern == "[0-9]" || o.Pattern == "[0-9]+" {
o.Type = "int64"
} else {
o.Type = "string"
}
} else {
// Try to parse the value as an int64
// e.g. param=123
o.VariableName = o.Name
if _, e := strconv.ParseInt(o.ValueRaw, 10, 64); e != nil {
o.Type = "string"
} else {
o.Type = "int64"
}
}
queries = append(queries, o)
}
return routePath, queries
}