File: node.go

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.8.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,332 kB
  • sloc: sh: 61; makefile: 5
file content (390 lines) | stat: -rw-r--r-- 8,946 bytes parent folder | download
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
package format

import (
	"fmt"
	"reflect"
	"sort"
	"strconv"
	"strings"

	"github.com/nicholas-fedor/shoutrrr/pkg/types"
	"github.com/nicholas-fedor/shoutrrr/pkg/util"
)

// NodeTokenType is used to represent the type of value that a node has for syntax highlighting.
type NodeTokenType int

const (
	// UnknownToken represents all unknown/unspecified tokens.
	UnknownToken NodeTokenType = iota
	// NumberToken represents all numbers.
	NumberToken
	// StringToken represents strings and keys.
	StringToken
	// EnumToken represents enum values.
	EnumToken
	// TrueToken represent boolean true.
	TrueToken
	// FalseToken represent boolean false.
	FalseToken
	// PropToken represent a serializable struct prop.
	PropToken
	// ErrorToken represent a value that was not serializable or otherwise invalid.
	ErrorToken
	// ContainerToken is used for Array/Slice and Map tokens.
	ContainerToken
)

// Constants for number bases.
const (
	BaseDecimalLen = 10
	BaseHexLen     = 16
)

// Node is the generic config tree item.
type Node interface {
	Field() *FieldInfo
	TokenType() NodeTokenType
	Update(tv reflect.Value)
}

// ValueNode is a Node without any child items.
type ValueNode struct {
	*FieldInfo
	Value     string
	tokenType NodeTokenType
}

// Field returns the inner FieldInfo.
func (n *ValueNode) Field() *FieldInfo {
	return n.FieldInfo
}

// TokenType returns a NodeTokenType that matches the value.
func (n *ValueNode) TokenType() NodeTokenType {
	return n.tokenType
}

// Update updates the value string from the provided value.
func (n *ValueNode) Update(tv reflect.Value) {
	value, token := getValueNodeValue(tv, n.FieldInfo)
	n.Value = value
	n.tokenType = token
}

// ContainerNode is a Node with child items.
type ContainerNode struct {
	*FieldInfo
	Items        []Node
	MaxKeyLength int
}

// Field returns the inner FieldInfo.
func (n *ContainerNode) Field() *FieldInfo {
	return n.FieldInfo
}

// TokenType always returns ContainerToken for ContainerNode.
func (n *ContainerNode) TokenType() NodeTokenType {
	return ContainerToken
}

// Update updates the items to match the provided value.
func (n *ContainerNode) Update(tv reflect.Value) {
	switch n.Type.Kind() {
	case reflect.Array, reflect.Slice:
		n.updateArrayNode(tv)
	case reflect.Map:
		n.updateMapNode(tv)
	case reflect.Invalid,
		reflect.Bool,
		reflect.Int,
		reflect.Int8,
		reflect.Int16,
		reflect.Int32,
		reflect.Int64,
		reflect.Uint,
		reflect.Uint8,
		reflect.Uint16,
		reflect.Uint32,
		reflect.Uint64,
		reflect.Uintptr,
		reflect.Float32,
		reflect.Float64,
		reflect.Complex64,
		reflect.Complex128,
		reflect.Chan,
		reflect.Func,
		reflect.Interface,
		reflect.Pointer,
		reflect.String,
		reflect.Struct,
		reflect.UnsafePointer:
		// No-op for unsupported kinds
	default:
		// No-op for any remaining kinds
	}
}

func (n *ContainerNode) updateArrayNode(arrayValue reflect.Value) {
	itemCount := arrayValue.Len()
	n.Items = make([]Node, 0, itemCount)

	elemType := arrayValue.Type().Elem()

	for i := range itemCount {
		key := strconv.Itoa(i)
		val := arrayValue.Index(i)
		n.Items = append(n.Items, getValueNode(val, &FieldInfo{
			Name: key,
			Type: elemType,
		}))
	}
}

func getArrayNode(arrayValue reflect.Value, fieldInfo *FieldInfo) *ContainerNode {
	node := &ContainerNode{
		FieldInfo:    fieldInfo,
		MaxKeyLength: 0,
	}
	node.updateArrayNode(arrayValue)

	return node
}

func sortNodeItems(nodeItems []Node) {
	sort.Slice(nodeItems, func(i, j int) bool {
		return nodeItems[i].Field().Name < nodeItems[j].Field().Name
	})
}

func (n *ContainerNode) updateMapNode(mapValue reflect.Value) {
	base := n.Base
	if base == 0 {
		base = BaseDecimalLen
	}

	elemType := mapValue.Type().Elem()
	mapKeys := mapValue.MapKeys()
	nodeItems := make([]Node, len(mapKeys))
	maxKeyLength := 0

	for i, keyVal := range mapKeys {
		// The keys will always be strings
		key := keyVal.String()
		val := mapValue.MapIndex(keyVal)
		nodeItems[i] = getValueNode(val, &FieldInfo{
			Name: key,
			Type: elemType,
			Base: base,
		})
		maxKeyLength = util.Max(len(key), maxKeyLength)
	}

	sortNodeItems(nodeItems)

	n.Items = nodeItems
	n.MaxKeyLength = maxKeyLength
}

func getMapNode(mapValue reflect.Value, fieldInfo *FieldInfo) *ContainerNode {
	if mapValue.Kind() == reflect.Ptr {
		mapValue = mapValue.Elem()
	}

	node := &ContainerNode{
		FieldInfo: fieldInfo,
	}
	node.updateMapNode(mapValue)

	return node
}

func getNode(fieldVal reflect.Value, fieldInfo *FieldInfo) Node {
	switch fieldInfo.Type.Kind() {
	case reflect.Array, reflect.Slice:
		return getArrayNode(fieldVal, fieldInfo)
	case reflect.Map:
		return getMapNode(fieldVal, fieldInfo)
	case reflect.Invalid,
		reflect.Bool,
		reflect.Int,
		reflect.Int8,
		reflect.Int16,
		reflect.Int32,
		reflect.Int64,
		reflect.Uint,
		reflect.Uint8,
		reflect.Uint16,
		reflect.Uint32,
		reflect.Uint64,
		reflect.Uintptr,
		reflect.Float32,
		reflect.Float64,
		reflect.Complex64,
		reflect.Complex128,
		reflect.Chan,
		reflect.Func,
		reflect.Interface,
		reflect.Pointer,
		reflect.String,
		reflect.Struct,
		reflect.UnsafePointer:
		return getValueNode(fieldVal, fieldInfo)
	default:
		return getValueNode(fieldVal, fieldInfo)
	}
}

func getRootNode(value any) *ContainerNode {
	structValue := reflect.ValueOf(value)
	if structValue.Kind() == reflect.Ptr {
		structValue = structValue.Elem()
	}

	structType := structValue.Type()

	enums := map[string]types.EnumFormatter{}
	if enummer, isEnummer := value.(types.Enummer); isEnummer {
		enums = enummer.Enums()
	}

	infoFields := getStructFieldInfo(structType, enums)
	nodeItems := make([]Node, 0, len(infoFields))
	maxKeyLength := 0

	for _, fieldInfo := range infoFields {
		fieldValue := structValue.FieldByName(fieldInfo.Name)
		if !fieldValue.IsValid() {
			fieldValue = reflect.Zero(fieldInfo.Type)
		}

		nodeItems = append(nodeItems, getNode(fieldValue, &fieldInfo))
		maxKeyLength = util.Max(len(fieldInfo.Name), maxKeyLength)
	}

	sortNodeItems(nodeItems)

	return &ContainerNode{
		FieldInfo:    &FieldInfo{Type: structType},
		Items:        nodeItems,
		MaxKeyLength: maxKeyLength,
	}
}

func getValueNode(fieldVal reflect.Value, fieldInfo *FieldInfo) *ValueNode {
	value, tokenType := getValueNodeValue(fieldVal, fieldInfo)

	return &ValueNode{
		FieldInfo: fieldInfo,
		Value:     value,
		tokenType: tokenType,
	}
}

func getValueNodeValue(fieldValue reflect.Value, fieldInfo *FieldInfo) (string, NodeTokenType) {
	kind := fieldValue.Kind()

	base := fieldInfo.Base
	if base == 0 {
		base = BaseDecimalLen
	}

	if fieldInfo.IsEnum() {
		return fieldInfo.EnumFormatter.Print(int(fieldValue.Int())), EnumToken
	}

	switch kind {
	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
		val := strconv.FormatUint(fieldValue.Uint(), base)
		if base == BaseHexLen {
			val = "0x" + val
		}

		return val, NumberToken
	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
		return strconv.FormatInt(fieldValue.Int(), base), NumberToken
	case reflect.String:
		return fieldValue.String(), StringToken
	case reflect.Bool:
		val := fieldValue.Bool()
		if val {
			return PrintBool(val), TrueToken
		}

		return PrintBool(val), FalseToken
	case reflect.Array, reflect.Slice, reflect.Map:
		return getContainerValueString(fieldValue, fieldInfo), UnknownToken
	case reflect.Ptr, reflect.Struct:
		if val, err := GetConfigPropString(fieldValue); err == nil {
			return val, PropToken
		}

		return "<ERR>", ErrorToken
	case reflect.Invalid,
		reflect.Uintptr,
		reflect.Float32,
		reflect.Float64,
		reflect.Complex64,
		reflect.Complex128,
		reflect.Chan,
		reflect.Func,
		reflect.Interface,
		reflect.UnsafePointer:
		return fmt.Sprintf("<?%s>", kind.String()), UnknownToken
	default:
		return fmt.Sprintf("<?%s>", kind.String()), UnknownToken
	}
}

func getContainerValueString(fieldValue reflect.Value, fieldInfo *FieldInfo) string {
	itemSeparator := fieldInfo.ItemSeparator
	sliceLength := fieldValue.Len()

	var mapKeys []reflect.Value
	if fieldInfo.Type.Kind() == reflect.Map {
		mapKeys = fieldValue.MapKeys()
		sort.Slice(mapKeys, func(a, b int) bool {
			return mapKeys[a].String() < mapKeys[b].String()
		})
	}

	stringBuilder := strings.Builder{}

	var itemFieldInfo *FieldInfo

	for i := range sliceLength {
		var itemValue reflect.Value

		if i > 0 {
			stringBuilder.WriteRune(itemSeparator)
		}

		if mapKeys != nil {
			mapKey := mapKeys[i]
			stringBuilder.WriteString(mapKey.String())
			stringBuilder.WriteRune(':')

			itemValue = fieldValue.MapIndex(mapKey)
		} else {
			itemValue = fieldValue.Index(i)
		}

		if i == 0 {
			itemFieldInfo = &FieldInfo{
				Type: itemValue.Type(),
				// Inherit the base from the container
				Base: fieldInfo.Base,
			}

			if itemFieldInfo.Base == 0 {
				itemFieldInfo.Base = BaseDecimalLen
			}
		}

		strVal, _ := getValueNodeValue(itemValue, itemFieldInfo)
		stringBuilder.WriteString(strVal)
	}

	return stringBuilder.String()
}