Adding upstream version 0.8.9.

Signed-off-by: Daniel Baumann <daniel@debian.org>

pkg/format/prop_key_resolver.go

@@ -0,0 +1,176 @@
+package format
+
+import (
+	"errors"
+	"fmt"
+	"reflect"
+	"sort"
+	"strings"
+
+	"github.com/nicholas-fedor/shoutrrr/pkg/types"
+)
+
+var (
+	ErrInvalidConfigKey    = errors.New("not a valid config key")
+	ErrInvalidValueForType = errors.New("invalid value for type")
+)
+
+// PropKeyResolver implements the ConfigQueryResolver interface for services that uses key tags for query props.
+type PropKeyResolver struct {
+	confValue reflect.Value
+	keyFields map[string]FieldInfo
+	keys      []string
+}
+
+// NewPropKeyResolver creates a new PropKeyResolver and initializes it using the provided config.
+func NewPropKeyResolver(config types.ServiceConfig) PropKeyResolver {
+	configNode := GetConfigFormat(config)
+	items := configNode.Items
+
+	keyFields := make(map[string]FieldInfo, len(items))
+	keys := make([]string, 0, len(items))
+
+	for _, item := range items {
+		field := *item.Field()
+		if len(field.Keys) == 0 {
+			continue // Skip fields without explicit 'key' tags
+		}
+
+		for _, key := range field.Keys {
+			key = strings.ToLower(key)
+			if key != "" {
+				keys = append(keys, key)
+				keyFields[key] = field
+			}
+		}
+	}
+
+	sort.Strings(keys)
+
+	confValue := reflect.ValueOf(config)
+	if confValue.Kind() == reflect.Ptr {
+		confValue = confValue.Elem()
+	}
+
+	return PropKeyResolver{
+		keyFields: keyFields,
+		confValue: confValue,
+		keys:      keys,
+	}
+}
+
+// QueryFields returns a list of tagged keys.
+func (pkr *PropKeyResolver) QueryFields() []string {
+	return pkr.keys
+}
+
+// Get returns the value of a config property tagged with the corresponding key.
+func (pkr *PropKeyResolver) Get(key string) (string, error) {
+	if field, found := pkr.keyFields[strings.ToLower(key)]; found {
+		return GetConfigFieldString(pkr.confValue, field)
+	}
+
+	return "", fmt.Errorf("%w: %v", ErrInvalidConfigKey, key)
+}
+
+// Set sets the value of its bound struct's property, tagged with the corresponding key.
+func (pkr *PropKeyResolver) Set(key string, value string) error {
+	return pkr.set(pkr.confValue, key, value)
+}
+
+// set sets the value of a target struct tagged with the corresponding key.
+func (pkr *PropKeyResolver) set(target reflect.Value, key string, value string) error {
+	if field, found := pkr.keyFields[strings.ToLower(key)]; found {
+		valid, err := SetConfigField(target, field, value)
+		if !valid && err == nil {
+			return ErrInvalidValueForType
+		}
+
+		return err
+	}
+
+	return fmt.Errorf("%w: %v (valid keys: %v)", ErrInvalidConfigKey, key, pkr.keys)
+}
+
+// UpdateConfigFromParams mutates the provided config, updating the values from its corresponding params.
+// If the provided config is nil, the internal config will be updated instead.
+// The error returned is the first error that occurred; subsequent errors are discarded.
+func (pkr *PropKeyResolver) UpdateConfigFromParams(
+	config types.ServiceConfig,
+	params *types.Params,
+) error {
+	var firstError error
+
+	confValue := pkr.configValueOrInternal(config)
+
+	if params != nil {
+		for key, val := range *params {
+			if err := pkr.set(confValue, key, val); err != nil && firstError == nil {
+				firstError = err
+			}
+		}
+	}
+
+	return firstError
+}
+
+// SetDefaultProps mutates the provided config, setting the tagged fields with their default values.
+// If the provided config is nil, the internal config will be updated instead.
+// The error returned is the first error that occurred; subsequent errors are discarded.
+func (pkr *PropKeyResolver) SetDefaultProps(config types.ServiceConfig) error {
+	var firstError error
+
+	confValue := pkr.configValueOrInternal(config)
+	for key, info := range pkr.keyFields {
+		if err := pkr.set(confValue, key, info.DefaultValue); err != nil && firstError == nil {
+			firstError = err
+		}
+	}
+
+	return firstError
+}
+
+// Bind creates a new instance of the PropKeyResolver with the internal config reference
+// set to the provided config. This should only be used for configs of the same type.
+func (pkr *PropKeyResolver) Bind(config types.ServiceConfig) PropKeyResolver {
+	bound := *pkr
+	bound.confValue = configValue(config)
+
+	return bound
+}
+
+// GetConfigQueryResolver returns the ConfigQueryResolver interface for the config if it implements it,
+// otherwise it creates and returns a PropKeyResolver that implements it.
+func GetConfigQueryResolver(config types.ServiceConfig) types.ConfigQueryResolver {
+	var resolver types.ConfigQueryResolver
+
+	var ok bool
+	if resolver, ok = config.(types.ConfigQueryResolver); !ok {
+		pkr := NewPropKeyResolver(config)
+		resolver = &pkr
+	}
+
+	return resolver
+}
+
+// KeyIsPrimary returns whether the key is the primary (and not an alias).
+func (pkr *PropKeyResolver) KeyIsPrimary(key string) bool {
+	return pkr.keyFields[key].Keys[0] == key
+}
+
+func (pkr *PropKeyResolver) configValueOrInternal(config types.ServiceConfig) reflect.Value {
+	if config != nil {
+		return configValue(config)
+	}
+
+	return pkr.confValue
+}
+
+func configValue(config types.ServiceConfig) reflect.Value {
+	return reflect.Indirect(reflect.ValueOf(config))
+}
+
+// IsDefault returns whether the specified key value is the default value.
+func (pkr *PropKeyResolver) IsDefault(key string, value string) bool {
+	return pkr.keyFields[key].DefaultValue == value
+}