-
Notifications
You must be signed in to change notification settings - Fork 0
/
util.go
271 lines (229 loc) · 7.15 KB
/
util.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
// Copyright (c) Jeevanandam M (https://github.com/jeevatkm)
// aahframework.org/ainsp source code and usage is governed by a MIT style
// license that can be found in the LICENSE file.
package ainsp
import (
"errors"
"fmt"
"go/ast"
"go/token"
"path"
"path/filepath"
"reflect"
"strings"
"aahframework.org/essentials.v0"
"aahframework.org/log.v0"
)
func validateInput(path string) error {
if ess.IsStrEmpty(path) {
return errors.New("path is required input")
}
if !ess.IsFileExists(path) {
return fmt.Errorf("path is does not exists: %s", path)
}
return nil
}
func validateAndGetPkg(pkgs map[string]*ast.Package, path string) (*packageInfo, error) {
pkgCnt := len(pkgs)
// no source code found in the directory
if pkgCnt == 0 {
return nil, nil
}
// not permitted by Go lang spec
if pkgCnt > 1 {
var names []string
for k := range pkgs {
names = append(names, k)
}
return nil, fmt.Errorf("more than one package name [%s] found in single"+
" directory: %s", strings.Join(names, ", "), path)
}
pkg := &packageInfo{}
for _, v := range pkgs {
pkg.Pkg = v
}
return pkg, nil
}
func isImportTok(decl *ast.GenDecl) bool {
return token.IMPORT == decl.Tok
}
func isTypeTok(decl *ast.GenDecl) bool {
return token.TYPE == decl.Tok
}
func stripGoPath(pkgFilePath string) string {
idx := strings.Index(pkgFilePath, "src")
return filepath.Clean(pkgFilePath[idx+4:])
}
func isPkgAliasExists(importPaths map[string]string, pkgAlias string) bool {
_, found := importPaths[pkgAlias]
return found
}
func processMethods(pkg *packageInfo, routeMethods map[string]map[string]uint8, decl ast.Decl, imports map[string]string) {
fn, ok := decl.(*ast.FuncDecl)
// Do not process if these met:
// 1. does not have receiver, it means package function/method
// 2. method is not exported
// 3. method returns result
if !ok || fn.Recv == nil || !fn.Name.IsExported() ||
fn.Type.Results != nil {
return
}
actionName := fn.Name.Name
if isInterceptorActionName(actionName) {
return
}
controllerName := getName(fn.Recv.List[0].Type)
method := &methodInfo{Name: actionName, StructName: controllerName, Parameters: []*parameterInfo{}}
// processed so set to level 2, used to display unimplemented action details
// TODO for controller check too
for k, v := range routeMethods {
if strings.HasSuffix(k, controllerName) {
if _, found := v[actionName]; found {
v[actionName] = 2
}
}
}
// processing method parameters
for _, field := range fn.Type.Params.List {
for _, fieldName := range field.Names {
te, err := parseParamFieldExpr(pkg.Name(), field.Type)
if err != nil {
log.Errorf("AST: %s, please fix the parameter '%s' on action '%s.%s'; "+
"otherwise your action may not work properly", err, fieldName.Name, controllerName, actionName)
continue
}
var importPath string
if !ess.IsStrEmpty(te.PackageName) {
var found bool
if importPath, found = imports[te.PackageName]; !found {
importPath = pkg.ImportPath
}
}
method.Parameters = append(method.Parameters, ¶meterInfo{
Name: fieldName.Name,
ImportPath: importPath,
Type: te,
})
}
}
if ty := pkg.Types[controllerName]; ty == nil {
pos := pkg.Fset.Position(decl.Pos())
filename := stripGoPath(pos.Filename)
log.Errorf("AST: Method '%s' has incorrect struct recevier '%s' on file [%s] at line #%d",
actionName, controllerName, filename, pos.Line)
} else {
ty.Methods = append(ty.Methods, method)
}
}
func isInterceptorActionName(actionName string) bool {
return (strings.HasPrefix(actionName, "Before") || strings.HasPrefix(actionName, "After") ||
strings.HasPrefix(actionName, "Panic") || strings.HasPrefix(actionName, "Finally"))
}
func getName(expr ast.Expr) string {
switch t := expr.(type) {
case *ast.Ident:
return t.Name
case *ast.SelectorExpr:
return getName(t.X)
case *ast.StarExpr:
return getName(t.X)
default:
return ""
}
}
func isBuiltInDataType(typeName string) bool {
_, found := builtInDataTypes[typeName]
return found
}
// parseStructFieldExpr method to find a direct "embedded|sub-type".
// Struct ast.Field as follows:
// Ident { "type-name" } e.g. UserController
// SelectorExpr { "package-name", "type-name" } e.g. aah.Controller
// StarExpr { "*", "package-name", "type-name"} e.g. *aah.Controller
func parseStructFieldExpr(fieldType ast.Expr) (string, string) {
for {
if starExpr, ok := fieldType.(*ast.StarExpr); ok {
fieldType = starExpr.X
continue
}
break
}
// type it's in the same package, it's an ast.Ident.
if ident, ok := fieldType.(*ast.Ident); ok {
return "", ident.Name
}
// type it's in the different package, it's an ast.SelectorExpr.
if selectorExpr, ok := fieldType.(*ast.SelectorExpr); ok {
if pkgIdent, ok := selectorExpr.X.(*ast.Ident); ok {
return pkgIdent.Name, selectorExpr.Sel.Name
}
}
return "", ""
}
func parseParamFieldExpr(pkgName string, expr ast.Expr) (*typeExpr, error) {
switch t := expr.(type) {
case *ast.Ident:
if isBuiltInDataType(t.Name) {
return &typeExpr{Expr: t.Name, IsBuiltIn: true}, nil
}
return &typeExpr{Expr: t.Name, PackageName: pkgName}, nil
case *ast.SelectorExpr:
e, err := parseParamFieldExpr(pkgName, t.X)
return &typeExpr{Expr: t.Sel.Name, PackageName: e.Expr}, err
case *ast.StarExpr:
e, err := parseParamFieldExpr(pkgName, t.X)
return &typeExpr{Expr: "*" + e.Expr, PackageName: e.PackageName, PackageIndex: e.PackageIndex + uint8(1)}, err
case *ast.ArrayType:
e, err := parseParamFieldExpr(pkgName, t.Elt)
return &typeExpr{Expr: "[]" + e.Expr, PackageName: e.PackageName, PackageIndex: e.PackageIndex + uint8(2)}, err
case *ast.Ellipsis:
e, err := parseParamFieldExpr(pkgName, t.Elt)
return &typeExpr{Expr: "[]" + e.Expr, PackageName: e.PackageName, PackageIndex: e.PackageIndex + uint8(2)}, err
case *ast.InterfaceType:
return nil, errInterfaceActionParam
case *ast.MapType:
return nil, errMapActionParam
}
return nil, errInvalidActionParam
}
func atype(v interface{}) reflect.Type {
vt := reflect.TypeOf(v)
if vt.Kind() == reflect.Ptr {
vt = vt.Elem()
}
return vt
}
func kind(t reflect.Type) reflect.Kind {
if t.Kind() == reflect.Ptr {
return t.Elem().Kind()
}
return t.Kind()
}
// targetKeyAndNamespace method creates the target registry key.
func targetKeyAndNamespace(ttyp reflect.Type) (string, string) {
namespace := ttyp.PkgPath()
if idx := strings.Index(namespace, "controllers"); idx > -1 {
namespace = namespace[idx+11:]
} else if idx := strings.Index(namespace, "websockets"); idx > -1 {
namespace = namespace[idx+10:]
}
if ess.IsStrEmpty(namespace) {
return strings.ToLower(ttyp.Name()), ""
}
namespace = strings.TrimPrefix(namespace, string(filepath.Separator))
return strings.ToLower(path.Join(namespace, ttyp.Name())), namespace
}
func createAlias(packageName, importPath string, importPaths map[string]string) {
importPath = filepath.ToSlash(importPath)
if _, found := importPaths[importPath]; !found {
cnt := 0
pkgAlias := packageName
for isPkgAliasExists(importPaths, pkgAlias) {
pkgAlias = fmt.Sprintf("%s%d", packageName, cnt)
cnt++
}
if !ess.IsStrEmpty(pkgAlias) && !ess.IsStrEmpty(importPath) {
importPaths[importPath] = pkgAlias
}
}
}