view pkg/common/attributes.go @ 5718:3d497077f888 uploadwg

Implemented direct file upload as alternative import method for WG. For testing and data corrections it is useful to be able to import waterway gauges data directly by uploading a xml file.
author Sascha Wilde <wilde@sha-bang.de>
date Thu, 18 Apr 2024 19:23:19 +0200
parents 6270951dda28
children
line wrap: on
line source

// This is Free Software under GNU Affero General Public License v >= 3.0
// without warranty, see README.md and license for details.
//
// SPDX-License-Identifier: AGPL-3.0-or-later
// License-Filename: LICENSES/AGPL-3.0.txt
//
// Copyright (C) 2018, 2019 by via donau
//   – Österreichische Wasserstraßen-Gesellschaft mbH
// Software engineering by Intevation GmbH
//
// Author(s):
//  * Sascha L. Teichmann <sascha.teichmann@intevation.de>
//  * Tom Gottfried <tom.gottfried@intevation.de>

package common

import (
	"strconv"
	"strings"
	"time"

	"gemma.intevation.de/gemma/pkg/log"
)

type (
	// Attributes is a map of optional key/value attributes
	// of a configuration.
	Attributes map[string]string

	// AttributesMarshaler is an interface to implement
	// custom marshalling for the implementing type.
	AttributesMarshaler interface {
		MarshalAttributes(Attributes) error
	}

	// AttributesUnmarshaler is and interface to implement
	// custom unmarshalling for the implementing type.
	AttributesUnmarshaler interface {
		UnmarshalAttributes(Attributes) error
	}
)

// Marshal fills src into ca.
func (ca Attributes) Marshal(src any) error {
	if ca == nil {
		return nil
	}
	var err error
	if m, ok := src.(AttributesMarshaler); ok {
		err = m.MarshalAttributes(ca)
	}
	return err
}

// Unmarshal stored ca into dst.
func (ca Attributes) Unmarshal(dst any) error {
	if ca == nil {
		return nil
	}
	var err error
	if um, ok := dst.(AttributesUnmarshaler); ok {
		err = um.UnmarshalAttributes(ca)
	}
	return err
}

// Delete removes a key and its associated value from these
// attriibutes. Return true if the key/value pair was deleted.
func (ca Attributes) Delete(key string) bool {
	if ca == nil {
		return false
	}
	if _, found := ca[key]; !found {
		return false
	}
	delete(ca, key)
	return true
}

// Get fetches a value for given key out of the configuration.
// If the key was not found the bool component of the return value
// return false.
func (ca Attributes) Get(key string) (string, bool) {
	if ca == nil {
		return "", false
	}
	value, found := ca[key]
	return value, found
}

// Set stores a key/value pair in the attributes.
// Returns true if the storing succeeded.
func (ca Attributes) Set(key, value string) bool {
	if ca == nil {
		return false
	}
	ca[key] = value
	return true
}

// Bool returns a bool value for a given key.
func (ca Attributes) Bool(key string) bool {
	s, found := ca.Get(key)
	return found && strings.ToLower(s) == "true"
}

// SetBool stores a bool value with a given key in
// this attributes.
// Returns true if the storing succeeded.
func (ca Attributes) SetBool(key string, value bool) bool {
	var v string
	if value {
		v = "true"
	} else {
		v = "false"
	}
	return ca.Set(key, v)
}

// Date returns a time.Time for a given key.
// Returns true if the key was found and the
// represents a date.
func (ca Attributes) Date(key string) (time.Time, bool) {
	s, found := ca.Get(key)
	if !found {
		return time.Time{}, false
	}
	d, err := time.Parse(DateFormat, s)
	if err != nil {
		log.Errorf("%v\n", err)
		return time.Time{}, false
	}
	return d, true
}

// SetDate stores a date with a given key in the attributes.
// Returns true if the storage succeeded.
func (ca Attributes) SetDate(key string, date time.Time) bool {
	s := date.Format(DateFormat)
	return ca.Set(key, s)
}

// Time gives a time.Time for a given key.
func (ca Attributes) Time(key string) (time.Time, bool) {
	s, found := ca.Get(key)
	if !found {
		return time.Time{}, false
	}
	t, err := time.Parse(TimeFormat, s)
	if err != nil {
		log.Errorf("%v\n", err)
		return time.Time{}, false
	}
	return t, true
}

// SetTime stores a time with a given key in the attributes.
// Returns true if the storage succeeded.
func (ca Attributes) SetTime(key string, t time.Time) bool {
	value := t.Format(TimeFormat)
	return ca.Set(key, value)

}

// Int returns an int for a given key.
// Returns true if the key was found and the value
// is an integer.
func (ca Attributes) Int(key string) (int, bool) {
	s, found := ca.Get(key)
	if !found {
		return 0, false
	}
	i, err := strconv.Atoi(s)
	if err != nil {
		log.Errorf("%v\n", err)
		return 0, false
	}
	return i, true
}

// SetInt stores an int with a given key in the attributes.
// Returns true if the storage succeeded.
func (ca Attributes) SetInt(key string, value int) bool {
	v := strconv.Itoa(value)
	return ca.Set(key, v)
}

// Float returns a float64 for a given key.
// Returns true if the key was found and the value
// is a floating point value.
func (ca Attributes) Float(key string) (float64, bool) {
	s, found := ca.Get(key)
	if !found {
		return 0, false
	}
	f, err := strconv.ParseFloat(s, 64)
	if err != nil {
		log.Errorf("%v\n", err)
		return 0, false
	}
	return f, true
}

// SetFloat stores an float64 with a given key in the attributes.
// Returns true if the storage succeeded.
func (ca Attributes) SetFloat(key string, value float64) bool {
	v := strconv.FormatFloat(value, 'e', -1, 64)
	return ca.Set(key, v)
}

// Duration returns a duration for a given key.
// Returns true if the key was found and the value
// is a duration.
func (ca Attributes) Duration(key string) (time.Duration, bool) {
	s, found := ca.Get(key)
	if !found {
		return 0, false
	}
	d, err := time.ParseDuration(s)
	if err != nil {
		log.Errorf("%v\n", err)
		return 0, false
	}
	return d, true
}

// SetDuration stores a duration with a given key in the attributes.
// Returns true if the storage succeeded.
func (ca Attributes) SetDuration(key string, value time.Duration) bool {
	v := value.String()
	return ca.Set(key, v)
}