File: marshal.go

package info (click to toggle)
golang-github-azuread-microsoft-authentication-library-for-go 1.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 964 kB
  • sloc: makefile: 4
file content (346 lines) | stat: -rw-r--r-- 8,171 bytes parent folder | download | duplicates (7)
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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

package json

import (
	"bytes"
	"encoding/json"
	"fmt"
	"reflect"
	"unicode"
)

// marshalStruct takes in i, which must be a *struct or struct and marshals its content
// as JSON into buff (sometimes with writes to buff directly, sometimes via enc).
// This call is recursive for all fields of *struct or struct type.
func marshalStruct(v reflect.Value, buff *bytes.Buffer, enc *json.Encoder) error {
	if v.Kind() == reflect.Ptr {
		v = v.Elem()
	}
	// We only care about custom Marshalling a struct.
	if v.Kind() != reflect.Struct {
		return fmt.Errorf("bug: marshal() received a non *struct or struct, received type %T", v.Interface())
	}

	if hasMarshalJSON(v) {
		b, err := callMarshalJSON(v)
		if err != nil {
			return err
		}
		buff.Write(b)
		return nil
	}

	t := v.Type()

	// If it has an AdditionalFields field make sure its the right type.
	f := v.FieldByName(addField)
	if f.Kind() != reflect.Invalid {
		if f.Kind() != reflect.Map {
			return fmt.Errorf("type %T has field 'AdditionalFields' that is not a map[string]interface{}", v.Interface())
		}
		if !f.Type().AssignableTo(mapStrInterType) {
			return fmt.Errorf("type %T has field 'AdditionalFields' that is not a map[string]interface{}", v.Interface())
		}
	}

	translator, err := findFields(v)
	if err != nil {
		return err
	}

	buff.WriteByte(leftBrace)
	for x := 0; x < v.NumField(); x++ {
		field := v.Field(x)

		// We don't access private fields.
		if unicode.IsLower(rune(t.Field(x).Name[0])) {
			continue
		}

		if t.Field(x).Name == addField {
			if v.Field(x).Len() > 0 {
				if err := writeAddFields(field.Interface(), buff, enc); err != nil {
					return err
				}
				buff.WriteByte(comma)
			}
			continue
		}

		// If they have omitempty set, we don't write out the field if
		// it is the zero value.
		if hasOmitEmpty(t.Field(x).Tag.Get("json")) {
			if v.Field(x).IsZero() {
				continue
			}
		}

		// Write out the field name part.
		jsonName := translator.jsonName(t.Field(x).Name)
		buff.WriteString(fmt.Sprintf("%q:", jsonName))

		if field.Kind() == reflect.Ptr {
			field = field.Elem()
		}

		if err := marshalStructField(field, buff, enc); err != nil {
			return err
		}
	}

	buff.Truncate(buff.Len() - 1) // Remove final comma
	buff.WriteByte(rightBrace)

	return nil
}

func marshalStructField(field reflect.Value, buff *bytes.Buffer, enc *json.Encoder) error {
	// Determine if we need a trailing comma.
	defer buff.WriteByte(comma)

	switch field.Kind() {
	// If it was a *struct or struct, we need to recursively all marshal().
	case reflect.Struct:
		if field.CanAddr() {
			field = field.Addr()
		}
		return marshalStruct(field, buff, enc)
	case reflect.Map:
		return marshalMap(field, buff, enc)
	case reflect.Slice:
		return marshalSlice(field, buff, enc)
	}

	// It is just a basic type, so encode it.
	if err := enc.Encode(field.Interface()); err != nil {
		return err
	}
	buff.Truncate(buff.Len() - 1) // Remove Encode() added \n

	return nil
}

func marshalMap(v reflect.Value, buff *bytes.Buffer, enc *json.Encoder) error {
	if v.Kind() != reflect.Map {
		return fmt.Errorf("bug: marshalMap() called on %T", v.Interface())
	}
	if v.Len() == 0 {
		buff.WriteByte(leftBrace)
		buff.WriteByte(rightBrace)
		return nil
	}
	encoder := mapEncode{m: v, buff: buff, enc: enc}
	return encoder.run()
}

type mapEncode struct {
	m    reflect.Value
	buff *bytes.Buffer
	enc  *json.Encoder

	valueBaseType reflect.Type
}

// run runs our encoder state machine.
func (m *mapEncode) run() error {
	var state = m.start
	var err error
	for {
		state, err = state()
		if err != nil {
			return err
		}
		if state == nil {
			return nil
		}
	}
}

func (m *mapEncode) start() (stateFn, error) {
	if hasMarshalJSON(m.m) {
		b, err := callMarshalJSON(m.m)
		if err != nil {
			return nil, err
		}
		m.buff.Write(b)
		return nil, nil
	}

	valueBaseType := m.m.Type().Elem()
	if valueBaseType.Kind() == reflect.Ptr {
		valueBaseType = valueBaseType.Elem()
	}
	m.valueBaseType = valueBaseType

	switch valueBaseType.Kind() {
	case reflect.Ptr:
		return nil, fmt.Errorf("Marshal does not support **<type> or *<reference>")
	case reflect.Struct, reflect.Map, reflect.Slice:
		return m.encode, nil
	}

	// If the map value doesn't have a struct/map/slice, just Encode() it.
	if err := m.enc.Encode(m.m.Interface()); err != nil {
		return nil, err
	}
	m.buff.Truncate(m.buff.Len() - 1) // Remove Encode() added \n
	return nil, nil
}

func (m *mapEncode) encode() (stateFn, error) {
	m.buff.WriteByte(leftBrace)

	iter := m.m.MapRange()
	for iter.Next() {
		// Write the key.
		k := iter.Key()
		m.buff.WriteString(fmt.Sprintf("%q:", k.String()))

		v := iter.Value()
		switch m.valueBaseType.Kind() {
		case reflect.Struct:
			if v.CanAddr() {
				v = v.Addr()
			}
			if err := marshalStruct(v, m.buff, m.enc); err != nil {
				return nil, err
			}
		case reflect.Map:
			if err := marshalMap(v, m.buff, m.enc); err != nil {
				return nil, err
			}
		case reflect.Slice:
			if err := marshalSlice(v, m.buff, m.enc); err != nil {
				return nil, err
			}
		default:
			panic(fmt.Sprintf("critical bug: mapEncode.encode() called with value base type: %v", m.valueBaseType.Kind()))
		}
		m.buff.WriteByte(comma)
	}
	m.buff.Truncate(m.buff.Len() - 1) // Remove final comma
	m.buff.WriteByte(rightBrace)

	return nil, nil
}

func marshalSlice(v reflect.Value, buff *bytes.Buffer, enc *json.Encoder) error {
	if v.Kind() != reflect.Slice {
		return fmt.Errorf("bug: marshalSlice() called on %T", v.Interface())
	}
	if v.Len() == 0 {
		buff.WriteByte(leftParen)
		buff.WriteByte(rightParen)
		return nil
	}
	encoder := sliceEncode{s: v, buff: buff, enc: enc}
	return encoder.run()
}

type sliceEncode struct {
	s    reflect.Value
	buff *bytes.Buffer
	enc  *json.Encoder

	valueBaseType reflect.Type
}

// run runs our encoder state machine.
func (s *sliceEncode) run() error {
	var state = s.start
	var err error
	for {
		state, err = state()
		if err != nil {
			return err
		}
		if state == nil {
			return nil
		}
	}
}

func (s *sliceEncode) start() (stateFn, error) {
	if hasMarshalJSON(s.s) {
		b, err := callMarshalJSON(s.s)
		if err != nil {
			return nil, err
		}
		s.buff.Write(b)
		return nil, nil
	}

	valueBaseType := s.s.Type().Elem()
	if valueBaseType.Kind() == reflect.Ptr {
		valueBaseType = valueBaseType.Elem()
	}
	s.valueBaseType = valueBaseType

	switch valueBaseType.Kind() {
	case reflect.Ptr:
		return nil, fmt.Errorf("Marshal does not support **<type> or *<reference>")
	case reflect.Struct, reflect.Map, reflect.Slice:
		return s.encode, nil
	}

	// If the map value doesn't have a struct/map/slice, just Encode() it.
	if err := s.enc.Encode(s.s.Interface()); err != nil {
		return nil, err
	}
	s.buff.Truncate(s.buff.Len() - 1) // Remove Encode added \n

	return nil, nil
}

func (s *sliceEncode) encode() (stateFn, error) {
	s.buff.WriteByte(leftParen)
	for i := 0; i < s.s.Len(); i++ {
		v := s.s.Index(i)
		switch s.valueBaseType.Kind() {
		case reflect.Struct:
			if v.CanAddr() {
				v = v.Addr()
			}
			if err := marshalStruct(v, s.buff, s.enc); err != nil {
				return nil, err
			}
		case reflect.Map:
			if err := marshalMap(v, s.buff, s.enc); err != nil {
				return nil, err
			}
		case reflect.Slice:
			if err := marshalSlice(v, s.buff, s.enc); err != nil {
				return nil, err
			}
		default:
			panic(fmt.Sprintf("critical bug: mapEncode.encode() called with value base type: %v", s.valueBaseType.Kind()))
		}
		s.buff.WriteByte(comma)
	}
	s.buff.Truncate(s.buff.Len() - 1) // Remove final comma
	s.buff.WriteByte(rightParen)
	return nil, nil
}

// writeAddFields writes the AdditionalFields struct field out to JSON as field
// values. i must be a map[string]interface{} or this will panic.
func writeAddFields(i interface{}, buff *bytes.Buffer, enc *json.Encoder) error {
	m := i.(map[string]interface{})

	x := 0
	for k, v := range m {
		buff.WriteString(fmt.Sprintf("%q:", k))
		if err := enc.Encode(v); err != nil {
			return err
		}
		buff.Truncate(buff.Len() - 1) // Remove Encode() added \n

		if x+1 != len(m) {
			buff.WriteByte(comma)
		}
		x++
	}
	return nil
}