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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
|
package format
import (
"errors"
"fmt"
"math"
"reflect"
"strconv"
"strings"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
"github.com/nicholas-fedor/shoutrrr/pkg/util"
)
// Constants for map parsing and type sizes.
const (
KeyValuePairSize = 2 // Number of elements in a key:value pair
Int32BitSize = 32 // Bit size for 32-bit integers
Int64BitSize = 64 // Bit size for 64-bit integers
)
// Errors defined as static variables for better error handling.
var (
ErrInvalidEnumValue = errors.New("not a valid enum value")
ErrInvalidBoolValue = errors.New("accepted values are 1, true, yes or 0, false, no")
ErrUnsupportedFieldKey = errors.New("field key format is not supported")
ErrInvalidFieldValue = errors.New("invalid field value format")
ErrUnsupportedField = errors.New("field format is not supported")
ErrInvalidFieldCount = errors.New("invalid field value count")
ErrInvalidFieldKind = errors.New("invalid field kind")
ErrUnsupportedMapValue = errors.New("map value format is not supported")
ErrInvalidFieldValueData = errors.New("invalid field value")
ErrFailedToSetEnumValue = errors.New("failed to set enum value")
ErrUnexpectedUintKind = errors.New("unexpected uint kind")
ErrUnexpectedIntKind = errors.New("unexpected int kind")
ErrParseIntFailed = errors.New("failed to parse integer")
ErrParseUintFailed = errors.New("failed to parse unsigned integer")
)
// GetServiceConfig extracts the inner config from a service.
func GetServiceConfig(service types.Service) types.ServiceConfig {
serviceValue := reflect.Indirect(reflect.ValueOf(service))
configField, ok := serviceValue.Type().FieldByName("Config")
if !ok {
panic("service does not have a Config field")
}
configRef := serviceValue.FieldByIndex(configField.Index)
if configRef.IsNil() {
configType := configField.Type
if configType.Kind() == reflect.Ptr {
configType = configType.Elem()
}
newConfig := reflect.New(configType).Interface()
if config, ok := newConfig.(types.ServiceConfig); ok {
return config
}
panic("failed to create new config instance")
}
if config, ok := configRef.Interface().(types.ServiceConfig); ok {
return config
}
panic("config reference is not a ServiceConfig")
}
// ColorFormatTree generates a color-highlighted string representation of a node tree.
func ColorFormatTree(rootNode *ContainerNode, withValues bool) string {
return ConsoleTreeRenderer{WithValues: withValues}.RenderTree(rootNode, "")
}
// GetServiceConfigFormat retrieves type and field information from a service's config.
func GetServiceConfigFormat(service types.Service) *ContainerNode {
return GetConfigFormat(GetServiceConfig(service))
}
// GetConfigFormat retrieves type and field information from a ServiceConfig.
func GetConfigFormat(config types.ServiceConfig) *ContainerNode {
return getRootNode(config)
}
// SetConfigField updates a config field with a deserialized value from a string.
func SetConfigField(config reflect.Value, field FieldInfo, inputValue string) (bool, error) {
configField := config.FieldByName(field.Name)
if field.EnumFormatter != nil {
return setEnumField(configField, field, inputValue)
}
switch field.Type.Kind() {
case reflect.String:
configField.SetString(inputValue)
return true, nil
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
return setIntField(configField, field, inputValue)
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
return setUintField(configField, field, inputValue)
case reflect.Bool:
return setBoolField(configField, inputValue)
case reflect.Map:
return setMapField(configField, field, inputValue)
case reflect.Struct:
return setStructField(configField, field, inputValue)
case reflect.Slice, reflect.Array:
return setSliceOrArrayField(configField, field, inputValue)
case reflect.Invalid,
reflect.Uintptr,
reflect.Float32,
reflect.Float64,
reflect.Complex64,
reflect.Complex128,
reflect.Chan,
reflect.Func,
reflect.Interface,
reflect.Pointer,
reflect.UnsafePointer:
return false, fmt.Errorf("%w: %v", ErrInvalidFieldKind, field.Type.Kind())
default:
return false, fmt.Errorf("%w: %v", ErrInvalidFieldKind, field.Type.Kind())
}
}
// setIntField handles integer field setting.
func setIntField(configField reflect.Value, field FieldInfo, inputValue string) (bool, error) {
number, base := util.StripNumberPrefix(inputValue)
value, err := strconv.ParseInt(number, base, field.Type.Bits())
if err != nil {
return false, fmt.Errorf("%w: %w", ErrParseIntFailed, err)
}
configField.SetInt(value)
return true, nil
}
// setUintField handles unsigned integer field setting.
func setUintField(configField reflect.Value, field FieldInfo, inputValue string) (bool, error) {
number, base := util.StripNumberPrefix(inputValue)
value, err := strconv.ParseUint(number, base, field.Type.Bits())
if err != nil {
return false, fmt.Errorf("%w: %w", ErrParseUintFailed, err)
}
configField.SetUint(value)
return true, nil
}
// setBoolField handles boolean field setting.
func setBoolField(configField reflect.Value, inputValue string) (bool, error) {
value, ok := ParseBool(inputValue, false)
if !ok {
return false, ErrInvalidBoolValue
}
configField.SetBool(value)
return true, nil
}
// setMapField handles map field setting.
func setMapField(configField reflect.Value, field FieldInfo, inputValue string) (bool, error) {
if field.Type.Key().Kind() != reflect.String {
return false, ErrUnsupportedFieldKey
}
mapValue := reflect.MakeMap(field.Type)
pairs := strings.Split(inputValue, ",")
for _, pair := range pairs {
elems := strings.Split(pair, ":")
if len(elems) != KeyValuePairSize {
return false, ErrInvalidFieldValue
}
key, valueRaw := elems[0], elems[1]
value, err := getMapValue(field.Type.Elem(), valueRaw)
if err != nil {
return false, err
}
mapValue.SetMapIndex(reflect.ValueOf(key), value)
}
configField.Set(mapValue)
return true, nil
}
// setStructField handles struct field setting.
func setStructField(configField reflect.Value, field FieldInfo, inputValue string) (bool, error) {
valuePtr, err := GetConfigPropFromString(field.Type, inputValue)
if err != nil {
return false, err
}
configField.Set(valuePtr.Elem())
return true, nil
}
// setSliceOrArrayField handles slice or array field setting.
func setSliceOrArrayField(
configField reflect.Value,
field FieldInfo,
inputValue string,
) (bool, error) {
elemType := field.Type.Elem()
elemKind := elemType.Kind()
if elemKind == reflect.Ptr {
elemKind = elemType.Elem().Kind()
}
if elemKind != reflect.Struct && elemKind != reflect.String {
return false, ErrUnsupportedField
}
values := strings.Split(inputValue, string(field.ItemSeparator))
if field.Type.Kind() == reflect.Array && len(values) != field.Type.Len() {
return false, fmt.Errorf("%w: needs to be %d", ErrInvalidFieldCount, field.Type.Len())
}
return setSliceOrArrayValues(configField, field, elemType, values)
}
// setSliceOrArrayValues sets the actual values for slice or array fields.
func setSliceOrArrayValues(
configField reflect.Value,
field FieldInfo,
elemType reflect.Type,
values []string,
) (bool, error) {
isPtrSlice := elemType.Kind() == reflect.Ptr
baseType := elemType
if isPtrSlice {
baseType = elemType.Elem()
}
if baseType.Kind() == reflect.Struct {
slice := reflect.MakeSlice(reflect.SliceOf(elemType), 0, len(values))
for _, v := range values {
propPtr, err := GetConfigPropFromString(baseType, v)
if err != nil {
return false, err
}
if isPtrSlice {
slice = reflect.Append(slice, propPtr)
} else {
slice = reflect.Append(slice, propPtr.Elem())
}
}
configField.Set(slice)
return true, nil
}
// Handle string slice/array
value := reflect.ValueOf(values)
if field.Type.Kind() == reflect.Array {
arr := reflect.Indirect(reflect.New(field.Type))
reflect.Copy(arr, value)
configField.Set(arr)
} else {
configField.Set(value)
}
return true, nil
}
// setEnumField handles enum field setting.
func setEnumField(configField reflect.Value, field FieldInfo, inputValue string) (bool, error) {
value := field.EnumFormatter.Parse(inputValue)
if value == EnumInvalid {
return false, fmt.Errorf(
"%w: accepted values are %v",
ErrInvalidEnumValue,
field.EnumFormatter.Names(),
)
}
configField.SetInt(int64(value))
if actual := int(configField.Int()); actual != value {
return false, fmt.Errorf(
"%w: expected %d, got %d (canSet: %v)",
ErrFailedToSetEnumValue,
value,
actual,
configField.CanSet(),
)
}
return true, nil
}
// getMapValue converts a raw string to a map value based on type.
func getMapValue(valueType reflect.Type, valueRaw string) (reflect.Value, error) {
switch valueType.Kind() {
case reflect.String:
return reflect.ValueOf(valueRaw), nil
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
return getMapUintValue(valueRaw, valueType)
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
return getMapIntValue(valueRaw, valueType)
case reflect.Invalid,
reflect.Bool,
reflect.Uintptr,
reflect.Float32,
reflect.Float64,
reflect.Complex64,
reflect.Complex128,
reflect.Array,
reflect.Chan,
reflect.Func,
reflect.Interface,
reflect.Map,
reflect.Pointer,
reflect.Slice,
reflect.Struct,
reflect.UnsafePointer:
return reflect.Value{}, ErrUnsupportedMapValue
default:
return reflect.Value{}, ErrUnsupportedMapValue
}
}
// getMapUintValue converts a string to an unsigned integer map value.
func getMapUintValue(valueRaw string, valueType reflect.Type) (reflect.Value, error) {
number, base := util.StripNumberPrefix(valueRaw)
numValue, err := strconv.ParseUint(number, base, valueType.Bits())
if err != nil {
return reflect.Value{}, fmt.Errorf("%w: %w", ErrParseUintFailed, err)
}
switch valueType.Kind() {
case reflect.Uint:
return reflect.ValueOf(uint(numValue)), nil
case reflect.Uint8:
if numValue > math.MaxUint8 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds uint8 range",
ErrParseUintFailed,
numValue,
)
}
return reflect.ValueOf(uint8(numValue)), nil
case reflect.Uint16:
if numValue > math.MaxUint16 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds uint16 range",
ErrParseUintFailed,
numValue,
)
}
return reflect.ValueOf(uint16(numValue)), nil
case reflect.Uint32:
if numValue > math.MaxUint32 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds uint32 range",
ErrParseUintFailed,
numValue,
)
}
return reflect.ValueOf(uint32(numValue)), nil
case reflect.Uint64:
return reflect.ValueOf(numValue), nil
case reflect.Invalid,
reflect.Bool,
reflect.Int,
reflect.Int8,
reflect.Int16,
reflect.Int32,
reflect.Int64,
reflect.Uintptr,
reflect.Float32,
reflect.Float64,
reflect.Complex64,
reflect.Complex128,
reflect.Array,
reflect.Chan,
reflect.Func,
reflect.Interface,
reflect.Map,
reflect.Pointer,
reflect.Slice,
reflect.String,
reflect.Struct,
reflect.UnsafePointer:
return reflect.Value{}, ErrUnexpectedUintKind
default:
return reflect.Value{}, ErrUnexpectedUintKind
}
}
// getMapIntValue converts a string to a signed integer map value.
func getMapIntValue(valueRaw string, valueType reflect.Type) (reflect.Value, error) {
number, base := util.StripNumberPrefix(valueRaw)
numValue, err := strconv.ParseInt(number, base, valueType.Bits())
if err != nil {
return reflect.Value{}, fmt.Errorf("%w: %w", ErrParseIntFailed, err)
}
switch valueType.Kind() {
case reflect.Int:
bits := valueType.Bits()
if bits == Int32BitSize {
if numValue < math.MinInt32 || numValue > math.MaxInt32 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds int%d range",
ErrParseIntFailed,
numValue,
bits,
)
}
}
return reflect.ValueOf(int(numValue)), nil
case reflect.Int8:
if numValue < math.MinInt8 || numValue > math.MaxInt8 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds int8 range",
ErrParseIntFailed,
numValue,
)
}
return reflect.ValueOf(int8(numValue)), nil
case reflect.Int16:
if numValue < math.MinInt16 || numValue > math.MaxInt16 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds int16 range",
ErrParseIntFailed,
numValue,
)
}
return reflect.ValueOf(int16(numValue)), nil
case reflect.Int32:
if numValue < math.MinInt32 || numValue > math.MaxInt32 {
return reflect.Value{}, fmt.Errorf(
"%w: value %d exceeds int32 range",
ErrParseIntFailed,
numValue,
)
}
return reflect.ValueOf(int32(numValue)), nil
case reflect.Int64:
return reflect.ValueOf(numValue), nil
case reflect.Invalid,
reflect.Bool,
reflect.Uint,
reflect.Uint8,
reflect.Uint16,
reflect.Uint32,
reflect.Uint64,
reflect.Uintptr,
reflect.Float32,
reflect.Float64,
reflect.Complex64,
reflect.Complex128,
reflect.Array,
reflect.Chan,
reflect.Func,
reflect.Interface,
reflect.Map,
reflect.Pointer,
reflect.Slice,
reflect.String,
reflect.Struct,
reflect.UnsafePointer:
return reflect.Value{}, ErrUnexpectedIntKind
default:
return reflect.Value{}, ErrUnexpectedIntKind
}
}
// GetConfigFieldString converts a config field value to its string representation.
func GetConfigFieldString(config reflect.Value, field FieldInfo) (string, error) {
configField := config.FieldByName(field.Name)
if field.IsEnum() {
return field.EnumFormatter.Print(int(configField.Int())), nil
}
strVal, token := getValueNodeValue(configField, &field)
if token == ErrorToken {
return "", ErrInvalidFieldValueData
}
return strVal, nil
}
|