Support toml config
This commit is contained in:
Ming Deng
358
core/config/toml/toml.go
Normal file
358
core/config/toml/toml.go
Normal file
@@ -0,0 +1,358 @@
|
||||
// Copyright 2020
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package toml
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/pelletier/go-toml"
|
||||
|
||||
"github.com/astaxie/beego/core/config"
|
||||
)
|
||||
|
||||
const keySeparator = "."
|
||||
|
||||
type Config struct {
|
||||
tree *toml.Tree
|
||||
}
|
||||
|
||||
// Parse accepts filename as the parameter
|
||||
func (c *Config) Parse(filename string) (config.Configer, error) {
|
||||
ctx, err := ioutil.ReadFile(filename)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return c.ParseData(ctx)
|
||||
}
|
||||
|
||||
func (c *Config) ParseData(data []byte) (config.Configer, error) {
|
||||
t, err := toml.LoadBytes(data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &configContainer{
|
||||
t: t,
|
||||
}, nil
|
||||
|
||||
}
|
||||
|
||||
// configContainer support key looks like "a.b.c"
|
||||
type configContainer struct {
|
||||
t *toml.Tree
|
||||
}
|
||||
|
||||
// Set put key, val
|
||||
func (c *configContainer) Set(ctx context.Context, key, val string) error {
|
||||
path := strings.Split(key, keySeparator)
|
||||
sub, err := subTree(c.t, path[0:len(path)-1])
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
sub.Set(path[len(path)-1], val)
|
||||
return nil
|
||||
}
|
||||
|
||||
// String return the value.
|
||||
// return error if key not found or value is invalid type
|
||||
func (c *configContainer) String(ctx context.Context, key string) (string, error) {
|
||||
res, err := c.get(key)
|
||||
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if res == nil {
|
||||
return "", config.KeyNotFoundError
|
||||
}
|
||||
|
||||
if str, ok := res.(string); ok {
|
||||
return str, nil
|
||||
} else {
|
||||
return "", config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
|
||||
// Strings return []string
|
||||
// return error if key not found or value is invalid type
|
||||
func (c *configContainer) Strings(ctx context.Context, key string) ([]string, error) {
|
||||
val, err := c.get(key)
|
||||
|
||||
if err != nil {
|
||||
return []string{}, err
|
||||
}
|
||||
if val == nil {
|
||||
return []string{}, config.KeyNotFoundError
|
||||
}
|
||||
if arr, ok := val.([]interface{}); ok {
|
||||
res := make([]string, 0, len(arr))
|
||||
for _, ele := range arr {
|
||||
if str, ok := ele.(string); ok {
|
||||
res = append(res, str)
|
||||
} else {
|
||||
return []string{}, config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
return res, nil
|
||||
} else {
|
||||
return []string{}, config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
|
||||
// Int return int value
|
||||
// return error if key not found or value is invalid type
|
||||
func (c *configContainer) Int(ctx context.Context, key string) (int, error) {
|
||||
val, err := c.Int64(ctx, key)
|
||||
return int(val), err
|
||||
}
|
||||
|
||||
// Int64 return int64 value
|
||||
// return error if key not found or value is invalid type
|
||||
func (c *configContainer) Int64(ctx context.Context, key string) (int64, error) {
|
||||
res, err := c.get(key)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
if res == nil {
|
||||
return 0, config.KeyNotFoundError
|
||||
}
|
||||
if i, ok := res.(int); ok {
|
||||
return int64(i), nil
|
||||
} else if i64, ok := res.(int64); ok {
|
||||
return i64, nil
|
||||
} else {
|
||||
return 0, config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
|
||||
// bool return bool value
|
||||
// return error if key not found or value is invalid type
|
||||
func (c *configContainer) Bool(ctx context.Context, key string) (bool, error) {
|
||||
|
||||
res, err := c.get(key)
|
||||
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
|
||||
if res == nil {
|
||||
return false, config.KeyNotFoundError
|
||||
}
|
||||
if b, ok := res.(bool); ok {
|
||||
return b, nil
|
||||
} else {
|
||||
return false, config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
|
||||
// Float return float value
|
||||
// return error if key not found or value is invalid type
|
||||
func (c *configContainer) Float(ctx context.Context, key string) (float64, error) {
|
||||
res, err := c.get(key)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
if res == nil {
|
||||
return 0, config.KeyNotFoundError
|
||||
}
|
||||
|
||||
if f, ok := res.(float64); ok {
|
||||
return f, nil
|
||||
} else {
|
||||
return 0, config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultString return string value
|
||||
// return default value if key not found or value is invalid type
|
||||
func (c *configContainer) DefaultString(ctx context.Context, key string, defaultVal string) string {
|
||||
res, err := c.get(key)
|
||||
if err != nil {
|
||||
return defaultVal
|
||||
}
|
||||
if str, ok := res.(string); ok {
|
||||
return str
|
||||
} else {
|
||||
return defaultVal
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultStrings return []string
|
||||
// return default value if key not found or value is invalid type
|
||||
func (c *configContainer) DefaultStrings(ctx context.Context, key string, defaultVal []string) []string {
|
||||
val, err := c.get(key)
|
||||
if err != nil {
|
||||
return defaultVal
|
||||
}
|
||||
if arr, ok := val.([]interface{}); ok {
|
||||
res := make([]string, 0, len(arr))
|
||||
for _, ele := range arr {
|
||||
if str, ok := ele.(string); ok {
|
||||
res = append(res, str)
|
||||
} else {
|
||||
return defaultVal
|
||||
}
|
||||
}
|
||||
return res
|
||||
} else {
|
||||
return defaultVal
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultInt return int value
|
||||
// return default value if key not found or value is invalid type
|
||||
func (c *configContainer) DefaultInt(ctx context.Context, key string, defaultVal int) int {
|
||||
return int(c.DefaultInt64(ctx, key, int64(defaultVal)))
|
||||
}
|
||||
|
||||
// DefaultInt64 return int64 value
|
||||
// return default value if key not found or value is invalid type
|
||||
func (c *configContainer) DefaultInt64(ctx context.Context, key string, defaultVal int64) int64 {
|
||||
res, err := c.get(key)
|
||||
if err != nil {
|
||||
return defaultVal
|
||||
}
|
||||
if i, ok := res.(int); ok {
|
||||
return int64(i)
|
||||
} else if i64, ok := res.(int64); ok {
|
||||
return i64
|
||||
} else {
|
||||
return defaultVal
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultBool return bool value
|
||||
// return default value if key not found or value is invalid type
|
||||
func (c *configContainer) DefaultBool(ctx context.Context, key string, defaultVal bool) bool {
|
||||
res, err := c.get(key)
|
||||
if err != nil {
|
||||
return defaultVal
|
||||
}
|
||||
if b, ok := res.(bool); ok {
|
||||
return b
|
||||
} else {
|
||||
return defaultVal
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultFloat return float value
|
||||
// return default value if key not found or value is invalid type
|
||||
func (c *configContainer) DefaultFloat(ctx context.Context, key string, defaultVal float64) float64 {
|
||||
res, err := c.get(key)
|
||||
if err != nil {
|
||||
return defaultVal
|
||||
}
|
||||
if f, ok := res.(float64); ok {
|
||||
return f
|
||||
} else {
|
||||
return defaultVal
|
||||
}
|
||||
}
|
||||
|
||||
// DIY returns the original value
|
||||
func (c *configContainer) DIY(ctx context.Context, key string) (interface{}, error) {
|
||||
return c.get(key)
|
||||
}
|
||||
|
||||
// GetSection return error if the value is not valid toml doc
|
||||
func (c *configContainer) GetSection(ctx context.Context, section string) (map[string]string, error) {
|
||||
val, err := subTree(c.t, strings.Split(section, keySeparator))
|
||||
if err != nil {
|
||||
return map[string]string{}, err
|
||||
}
|
||||
m := val.ToMap()
|
||||
res := make(map[string]string, len(m))
|
||||
for k, v := range m {
|
||||
res[k] = config.ToString(v)
|
||||
}
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func (c *configContainer) Unmarshaler(ctx context.Context, prefix string, obj interface{}, opt ...config.DecodeOption) error {
|
||||
if len(prefix) > 0 {
|
||||
t, err := subTree(c.t, strings.Split(prefix, keySeparator))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return t.Unmarshal(obj)
|
||||
}
|
||||
return c.t.Unmarshal(obj)
|
||||
}
|
||||
|
||||
// Sub return sub configer
|
||||
// return error if key not found or the value is not a sub doc
|
||||
func (c *configContainer) Sub(ctx context.Context, key string) (config.Configer, error) {
|
||||
val, err := subTree(c.t, strings.Split(key, keySeparator))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &configContainer{
|
||||
t: val,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// OnChange do nothing
|
||||
func (c *configContainer) OnChange(ctx context.Context, key string, fn func(value string)) {
|
||||
// do nothing
|
||||
}
|
||||
|
||||
// SaveConfigFile create or override the file
|
||||
func (c *configContainer) SaveConfigFile(ctx context.Context, filename string) error {
|
||||
// Write configuration file by filename.
|
||||
f, err := os.Create(filename)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
_, err = c.t.WriteTo(f)
|
||||
return err
|
||||
}
|
||||
|
||||
func (c *configContainer) get(key string) (interface{}, error) {
|
||||
if len(key) == 0 {
|
||||
return nil, config.KeyNotFoundError
|
||||
}
|
||||
|
||||
segs := strings.Split(key, keySeparator)
|
||||
t, err := subTree(c.t, segs[0:len(segs)-1])
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return t.Get(segs[len(segs)-1]), nil
|
||||
}
|
||||
|
||||
func subTree(t *toml.Tree, path []string) (*toml.Tree, error) {
|
||||
res := t
|
||||
for i := 0; i < len(path); i++ {
|
||||
if subTree, ok := res.Get(path[i]).(*toml.Tree); ok {
|
||||
res = subTree
|
||||
} else {
|
||||
return nil, config.InvalidValueTypeError
|
||||
}
|
||||
}
|
||||
if res == nil {
|
||||
return nil, config.KeyNotFoundError
|
||||
}
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func init() {
|
||||
config.Register("toml", &Config{})
|
||||
}
|
||||
Reference in New Issue
Block a user