cgrates/config/generalcfg.go

/*
Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
Copyright (C) ITsysCOM GmbH

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>
*/

package config

import (
	"strings"
	"time"

	"github.com/cgrates/cgrates/utils"
)

// GeneralCfg is the general config section
type GeneralCfg struct {
	NodeID               string // Identifier for this engine instance
	Logger               string // dictates the way logs are displayed/stored
	LogLevel             int    // system wide log level, nothing higher than this will be logged
	RoundingDecimals     int    // Number of decimals to round end prices at
	DBDataEncoding       string // The encoding used to store object data in strings: <msgpack|json>
	TpExportPath         string // Path towards export folder for offline Tariff Plans
	PosterAttempts       int    // Time to wait before writing the failed posts in a single file
	DefaultReqType       string // Use this request type if not defined on top
	DefaultCategory      string // set default type of record
	DefaultTenant        string // set default tenant
	DefaultTimezone      string // default timezone for timestamps where not specified <""|UTC|Local|$IANA_TZ_DB>
	DefaultCaching       string
	CachingDelay         time.Duration // use to add delay before cache reload
	ConnectAttempts      int           // number of initial connection attempts before giving up
	Reconnects           int           // number of reconnect attempts in case of connection lost <-1 for infinite | nb>
	MaxReconnectInterval time.Duration // time to wait in between reconnect attempts
	ConnectTimeout       time.Duration // timeout for RPC connection attempts
	ReplyTimeout         time.Duration // timeout replies if not reaching back
	LockingTimeout       time.Duration // locking mechanism timeout to avoid deadlocks
	DigestSeparator      string        //
	DigestEqual          string        //
	RSRSep               string        // separator used to split RSRParser (by default is used ";")
	MaxParallelConns     int           // the maximum number of connections used by the *parallel strategy
}

// loadFromJSONCfg loads General config from JsonCfg
func (gencfg *GeneralCfg) loadFromJSONCfg(jsnGeneralCfg *GeneralJsonCfg) (err error) {
	if jsnGeneralCfg == nil {
		return nil
	}
	if jsnGeneralCfg.Node_id != nil && *jsnGeneralCfg.Node_id != "" {
		gencfg.NodeID = *jsnGeneralCfg.Node_id
	}
	if jsnGeneralCfg.Logger != nil {
		gencfg.Logger = *jsnGeneralCfg.Logger
	}
	if jsnGeneralCfg.Log_level != nil {
		gencfg.LogLevel = *jsnGeneralCfg.Log_level
	}

	if jsnGeneralCfg.Dbdata_encoding != nil {
		gencfg.DBDataEncoding = strings.TrimPrefix(*jsnGeneralCfg.Dbdata_encoding, "*")
	}
	if jsnGeneralCfg.Default_request_type != nil {
		gencfg.DefaultReqType = *jsnGeneralCfg.Default_request_type
	}
	if jsnGeneralCfg.Default_category != nil {
		gencfg.DefaultCategory = *jsnGeneralCfg.Default_category
	}
	if jsnGeneralCfg.Default_tenant != nil {
		gencfg.DefaultTenant = *jsnGeneralCfg.Default_tenant
	}
	if jsnGeneralCfg.Connect_attempts != nil {
		gencfg.ConnectAttempts = *jsnGeneralCfg.Connect_attempts
	}
	if jsnGeneralCfg.Reconnects != nil {
		gencfg.Reconnects = *jsnGeneralCfg.Reconnects
	}
	if jsnGeneralCfg.Max_reconnect_interval != nil {
		if gencfg.MaxReconnectInterval, err = utils.ParseDurationWithNanosecs(*jsnGeneralCfg.Max_reconnect_interval); err != nil {
			return err
		}
	}
	if jsnGeneralCfg.Connect_timeout != nil {
		if gencfg.ConnectTimeout, err = utils.ParseDurationWithNanosecs(*jsnGeneralCfg.Connect_timeout); err != nil {
			return err
		}
	}
	if jsnGeneralCfg.Reply_timeout != nil {
		if gencfg.ReplyTimeout, err = utils.ParseDurationWithNanosecs(*jsnGeneralCfg.Reply_timeout); err != nil {
			return err
		}
	}
	if jsnGeneralCfg.Rounding_decimals != nil {
		gencfg.RoundingDecimals = *jsnGeneralCfg.Rounding_decimals
	}
	if jsnGeneralCfg.Tpexport_dir != nil {
		gencfg.TpExportPath = *jsnGeneralCfg.Tpexport_dir
	}
	if jsnGeneralCfg.Poster_attempts != nil {
		gencfg.PosterAttempts = *jsnGeneralCfg.Poster_attempts
	}
	if jsnGeneralCfg.Default_timezone != nil {
		gencfg.DefaultTimezone = *jsnGeneralCfg.Default_timezone
	}
	if jsnGeneralCfg.Default_caching != nil {
		gencfg.DefaultCaching = *jsnGeneralCfg.Default_caching
	}
	if jsnGeneralCfg.Caching_delay != nil {
		if gencfg.CachingDelay, err = utils.ParseDurationWithNanosecs(*jsnGeneralCfg.Caching_delay); err != nil {
			return err
		}
	}
	if jsnGeneralCfg.Locking_timeout != nil {
		if gencfg.LockingTimeout, err = utils.ParseDurationWithNanosecs(*jsnGeneralCfg.Locking_timeout); err != nil {
			return err
		}
	}
	if jsnGeneralCfg.Digest_separator != nil {
		gencfg.DigestSeparator = *jsnGeneralCfg.Digest_separator
	}
	if jsnGeneralCfg.Digest_equal != nil {
		gencfg.DigestEqual = *jsnGeneralCfg.Digest_equal
	}
	if jsnGeneralCfg.Rsr_separator != nil {
		gencfg.RSRSep = *jsnGeneralCfg.Rsr_separator
	}
	if jsnGeneralCfg.Max_parallel_conns != nil {
		gencfg.MaxParallelConns = *jsnGeneralCfg.Max_parallel_conns
	}

	return nil
}

// AsMapInterface returns the config as a map[string]any
func (gencfg *GeneralCfg) AsMapInterface() (initialMP map[string]any) {
	initialMP = map[string]any{
		utils.NodeIDCfg:               gencfg.NodeID,
		utils.LoggerCfg:               gencfg.Logger,
		utils.LogLevelCfg:             gencfg.LogLevel,
		utils.RoundingDecimalsCfg:     gencfg.RoundingDecimals,
		utils.DBDataEncodingCfg:       utils.Meta + gencfg.DBDataEncoding,
		utils.TpExportPathCfg:         gencfg.TpExportPath,
		utils.PosterAttemptsCfg:       gencfg.PosterAttempts,
		utils.DefaultReqTypeCfg:       gencfg.DefaultReqType,
		utils.DefaultCategoryCfg:      gencfg.DefaultCategory,
		utils.DefaultTenantCfg:        gencfg.DefaultTenant,
		utils.DefaultTimezoneCfg:      gencfg.DefaultTimezone,
		utils.DefaultCachingCfg:       gencfg.DefaultCaching,
		utils.CachingDlayCfg:          "0",
		utils.ConnectAttemptsCfg:      gencfg.ConnectAttempts,
		utils.ReconnectsCfg:           gencfg.Reconnects,
		utils.MaxReconnectIntervalCfg: "0",
		utils.DigestSeparatorCfg:      gencfg.DigestSeparator,
		utils.DigestEqualCfg:          gencfg.DigestEqual,
		utils.RSRSepCfg:               gencfg.RSRSep,
		utils.MaxParallelConnsCfg:     gencfg.MaxParallelConns,
		utils.LockingTimeoutCfg:       "0",
		utils.ConnectTimeoutCfg:       "0",
		utils.ReplyTimeoutCfg:         "0",
	}

	if gencfg.MaxReconnectInterval != 0 {
		initialMP[utils.MaxReconnectIntervalCfg] = gencfg.MaxReconnectInterval.String()
	}

	if gencfg.LockingTimeout != 0 {
		initialMP[utils.LockingTimeoutCfg] = gencfg.LockingTimeout.String()
	}

	if gencfg.ConnectTimeout != 0 {
		initialMP[utils.ConnectTimeoutCfg] = gencfg.ConnectTimeout.String()
	}

	if gencfg.ReplyTimeout != 0 {
		initialMP[utils.ReplyTimeoutCfg] = gencfg.ReplyTimeout.String()
	}

	if gencfg.CachingDelay != 0 {
		initialMP[utils.CachingDlayCfg] = gencfg.CachingDelay.String()
	}
	return
}

// Clone returns a deep copy of GeneralCfg
func (gencfg GeneralCfg) Clone() *GeneralCfg {
	return &GeneralCfg{
		NodeID:               gencfg.NodeID,
		Logger:               gencfg.Logger,
		LogLevel:             gencfg.LogLevel,
		RoundingDecimals:     gencfg.RoundingDecimals,
		DBDataEncoding:       gencfg.DBDataEncoding,
		TpExportPath:         gencfg.TpExportPath,
		PosterAttempts:       gencfg.PosterAttempts,
		DefaultReqType:       gencfg.DefaultReqType,
		DefaultCategory:      gencfg.DefaultCategory,
		DefaultTenant:        gencfg.DefaultTenant,
		DefaultTimezone:      gencfg.DefaultTimezone,
		DefaultCaching:       gencfg.DefaultCaching,
		ConnectAttempts:      gencfg.ConnectAttempts,
		Reconnects:           gencfg.Reconnects,
		MaxReconnectInterval: gencfg.MaxReconnectInterval,
		ConnectTimeout:       gencfg.ConnectTimeout,
		ReplyTimeout:         gencfg.ReplyTimeout,
		LockingTimeout:       gencfg.LockingTimeout,
		DigestSeparator:      gencfg.DigestSeparator,
		DigestEqual:          gencfg.DigestEqual,
		RSRSep:               gencfg.RSRSep,
		MaxParallelConns:     gencfg.MaxParallelConns,
	}
}