-
Notifications
You must be signed in to change notification settings - Fork 554
/
property_encoder.go
376 lines (345 loc) · 8.62 KB
/
property_encoder.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
package helpers
import (
"fmt"
"reflect"
"sort"
"strconv"
"strings"
"github.com/anchore/syft/internal/log"
)
// FieldName return a flag to indicate this is a valid field and a name to use
type FieldName func(field reflect.StructField) (string, bool)
// OptionalTag given a tag name, will return the defined tag or fall back to lower camel case field name
func OptionalTag(tag string) FieldName {
return func(f reflect.StructField) (string, bool) {
if n, ok := f.Tag.Lookup(tag); ok {
return n, true
}
return lowerFirst(f.Name), true
}
}
// TrimOmitempty trims `,omitempty` from the name
func TrimOmitempty(fn FieldName) FieldName {
return func(f reflect.StructField) (string, bool) {
if v, ok := fn(f); ok {
return strings.TrimSuffix(v, ",omitempty"), true
}
return "", false
}
}
// RequiredTag based on the given tag, only use a field if present
func RequiredTag(tag string) FieldName {
return func(f reflect.StructField) (string, bool) {
if n, ok := f.Tag.Lookup(tag); ok {
return n, true
}
return "", false
}
}
var (
// OptionalJSONTag uses field names defined in json tags, if available
OptionalJSONTag = TrimOmitempty(OptionalTag("json"))
)
// lowerFirst converts the first character of the string to lower case
func lowerFirst(s string) string {
return strings.ToLower(s[0:1]) + s[1:]
}
// Encode recursively encodes the object's properties as an ordered set of NameValue pairs
func Encode(obj interface{}, prefix string, fn FieldName) map[string]string {
if obj == nil {
return nil
}
props := map[string]string{}
encode(props, reflect.ValueOf(obj), prefix, fn)
return props
}
// NameValue a simple type to store stringified name/value pairs
type NameValue struct {
Name string
Value string
}
// Sorted returns a sorted set of NameValue pairs
func Sorted(values map[string]string) (out []NameValue) {
var keys []string
for k := range values {
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
out = append(out, NameValue{
Name: k,
Value: values[k],
})
}
return
}
func encode(out map[string]string, value reflect.Value, prefix string, fn FieldName) {
if !value.IsValid() || value.Type() == nil {
return
}
typ := value.Type()
switch typ.Kind() {
case reflect.Ptr:
if value.IsNil() {
return
}
value = value.Elem()
encode(out, value, prefix, fn)
case reflect.String:
v := value.String()
if v != "" {
out[prefix] = v
}
case reflect.Bool:
v := value.Bool()
out[prefix] = strconv.FormatBool(v)
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
v := value.Int()
out[prefix] = strconv.FormatInt(v, 10)
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
v := value.Uint()
out[prefix] = strconv.FormatUint(v, 10)
case reflect.Float32, reflect.Float64:
v := value.Float()
out[prefix] = fmt.Sprintf("%f", v)
case reflect.Array, reflect.Slice:
for idx := 0; idx < value.Len(); idx++ {
encode(out, value.Index(idx), fmt.Sprintf("%s:%d", prefix, idx), fn)
}
case reflect.Struct:
for i := 0; i < typ.NumField(); i++ {
pv := value.Field(i)
f := typ.Field(i)
name, ok := fieldName(f, prefix, fn)
if !ok {
continue
}
encode(out, pv, name, fn)
}
case reflect.Map:
// currently only map[string]string is really supported
for _, key := range value.MapKeys() {
encode(out, value.MapIndex(key), fmt.Sprintf("%s:%v", prefix, key.Interface()), fn)
}
default:
log.Warnf("skipping encoding of unsupported property: %s", prefix)
}
}
// fieldName gets the name of the field using the provided FieldName function
func fieldName(f reflect.StructField, prefix string, fn FieldName) (string, bool) {
name, ok := fn(f)
if !ok {
return "", false
}
if name == "" {
return prefix, true
}
if prefix != "" {
name = fmt.Sprintf("%s:%s", prefix, name)
}
return name, true
}
// Decode based on the given type, applies all values to hydrate a new instance
func Decode(typ reflect.Type, values map[string]string, prefix string, fn FieldName) interface{} {
isPtr := false
for typ.Kind() == reflect.Ptr {
typ = typ.Elem()
isPtr = true
}
isSlice := false
if typ.Kind() == reflect.Slice {
typ = reflect.PtrTo(typ)
isSlice = true
}
v := reflect.New(typ)
decode(values, v, prefix, fn)
switch {
case isSlice && isPtr:
return v.Elem().Interface()
case isSlice:
return PtrToStruct(v.Elem().Interface())
case isPtr:
return v.Interface()
}
return v.Elem().Interface()
}
// DecodeInto decodes all values to hydrate the given object instance
func DecodeInto(obj interface{}, values map[string]string, prefix string, fn FieldName) {
value := reflect.ValueOf(obj)
for value.Type().Kind() == reflect.Ptr {
value = value.Elem()
}
decode(values, value, prefix, fn)
}
//nolint:funlen,gocognit,gocyclo
func decode(vals map[string]string, value reflect.Value, prefix string, fn FieldName) bool {
if !value.IsValid() || value.Type() == nil {
return false
}
typ := value.Type()
incoming, valid := vals[prefix]
switch typ.Kind() {
case reflect.Ptr:
t := typ.Elem()
v := value
if v.IsNil() {
v = reflect.New(t)
}
if decode(vals, v.Elem(), prefix, fn) && value.CanSet() {
o := v.Interface()
log.Infof("%v", o)
value.Set(v)
} else {
return false
}
case reflect.String:
if valid {
value.SetString(incoming)
} else {
return false
}
case reflect.Bool:
if !valid {
return false
}
if b, err := strconv.ParseBool(incoming); err == nil {
value.SetBool(b)
} else {
return false
}
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
if !valid {
return false
}
if i, err := strconv.ParseInt(incoming, 10, 64); err == nil {
value.SetInt(i)
} else {
return false
}
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
if !valid {
return false
}
if i, err := strconv.ParseUint(incoming, 10, 64); err == nil {
value.SetUint(i)
} else {
return false
}
case reflect.Float32, reflect.Float64:
if !valid {
return false
}
if i, err := strconv.ParseFloat(incoming, 64); err == nil {
value.SetFloat(i)
} else {
return false
}
case reflect.Array, reflect.Slice:
values := false
t := typ.Elem()
slice := reflect.MakeSlice(typ, 0, 0)
for idx := 0; ; idx++ {
// test for index
str := fmt.Sprintf("%s:%d", prefix, idx)
// create new placeholder and decode values
newType := t
if t.Kind() == reflect.Ptr {
newType = t.Elem()
}
v := reflect.New(newType)
if decode(vals, v.Elem(), str, fn) {
// append to slice
if t.Kind() != reflect.Ptr {
v = v.Elem()
}
slice = reflect.Append(slice, v)
values = true
} else {
break
}
}
if values {
value.Set(slice)
} else {
return false
}
case reflect.Map:
values := false
keyType := typ.Key()
valueType := typ.Elem()
outMap := reflect.MakeMap(typ)
str := fmt.Sprintf("%s:", prefix)
keyVals := map[string]string{}
// iterate through all keys to find those prefixed with a reference to this map
// NOTE: this will not work for nested maps
for key := range vals {
// test for map prefix
if strings.HasPrefix(key, str) {
keyVals[key] = strings.TrimPrefix(key, str)
// create new placeholder and decode key
newKeyType := keyType
if keyType.Kind() == reflect.Ptr {
newKeyType = keyType.Elem()
}
k := reflect.New(newKeyType)
if !decode(keyVals, k.Elem(), key, fn) {
log.Debugf("unable to decode key for: %s", key)
continue
}
if keyType.Kind() != reflect.Ptr {
k = k.Elem()
}
// create new placeholder and decode value
newValueType := valueType
if valueType.Kind() == reflect.Ptr {
newValueType = valueType.Elem()
}
v := reflect.New(newValueType)
if decode(vals, v.Elem(), key, fn) {
if valueType.Kind() != reflect.Ptr {
v = v.Elem()
}
// set in map
outMap.SetMapIndex(k, v)
values = true
}
}
}
if values {
value.Set(outMap)
} else {
return false
}
case reflect.Struct:
values := false
for i := 0; i < typ.NumField(); i++ {
f := typ.Field(i)
v := value.Field(i)
name, ok := fieldName(f, prefix, fn)
if !ok {
continue
}
if decode(vals, v, name, fn) {
values = true
}
}
return values
default:
log.Warnf("unable to set field: %s", prefix)
return false
}
return true
}
func PtrToStruct(ptr interface{}) interface{} {
v := reflect.ValueOf(ptr)
if v.IsZero() && v.Type().Kind() != reflect.Struct {
return nil
}
switch v.Type().Kind() {
case reflect.Ptr:
return PtrToStruct(v.Elem().Interface())
case reflect.Interface:
return PtrToStruct(v.Elem().Interface())
}
return v.Interface()
}