feat: refactor storage configuration to use dedicated storage package and add new storage types

BREAKING CHANGE: remove deprecated config

config/deprecated.go

@@ -1,95 +0,0 @@
-package config
-
-import (
-	"strconv"
-
-	"github.com/krau/SaveAny-Bot/types"
-	"gorm.io/datatypes"
-)
-
-// for compatibility
-type deprecatedStorageConfig struct {
-	Alist  alistConfig  `toml:"alist" mapstructure:"alist"`
-	Local  localConfig  `toml:"local" mapstructure:"local"`
-	Webdav webdavConfig `toml:"webdav" mapstructure:"webdav"`
-}
-
-type alistConfig struct {
-	Enable   bool   `toml:"enable" mapstructure:"enable" json:"enable"`
-	URL      string `toml:"url" mapstructure:"url" json:"url"`
-	Username string `toml:"username" mapstructure:"username" json:"username"`
-	Password string `toml:"password" mapstructure:"password" json:"password"`
-	Token    string `toml:"token" mapstructure:"token" json:"token"`
-	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-	TokenExp int64  `toml:"token_exp" mapstructure:"token_exp" json:"token_exp"`
-}
-
-func (a *alistConfig) ToJSON() datatypes.JSON {
-	tokenExp := strconv.FormatInt(a.TokenExp, 10)
-	return datatypes.JSON([]byte(`{"url":"` + a.URL + `","username":"` + a.Username + `","password":"` + a.Password + `","token":"` + a.Token + `","base_path":"` + a.BasePath + `","token_exp":` + tokenExp + `}`))
-}
-
-type localConfig struct {
-	Enable   bool   `toml:"enable" mapstructure:"enable" json:"enable"`
-	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-}
-
-func (l *localConfig) ToJSON() datatypes.JSON {
-	return datatypes.JSON([]byte(`{"base_path":"` + l.BasePath + `"}`))
-}
-
-type webdavConfig struct {
-	Enable   bool   `toml:"enable" mapstructure:"enable" json:"enable"`
-	URL      string `toml:"url" mapstructure:"url" json:"url"`
-	Username string `toml:"username" mapstructure:"username" json:"username"`
-	Password string `toml:"password" mapstructure:"password" json:"password"`
-	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-}
-
-func (w *webdavConfig) ToJSON() datatypes.JSON {
-	return datatypes.JSON([]byte(`{"url":"` + w.URL + `","username":"` + w.Username + `","password":"` + w.Password + `","base_path":"` + w.BasePath + `"}`))
-}
-
-func transformDeprecatedStorageConfig() {
-	if Cfg.DeprecatedStorage.Alist.Enable {
-		alistStorage := &AlistStorageConfig{
-			NewStorageConfig: NewStorageConfig{
-				Name:   "Alist",
-				Enable: true,
-				Type:   string(types.StorageTypeAlist),
-			},
-			URL:      Cfg.DeprecatedStorage.Alist.URL,
-			Username: Cfg.DeprecatedStorage.Alist.Username,
-			Password: Cfg.DeprecatedStorage.Alist.Password,
-			Token:    Cfg.DeprecatedStorage.Alist.Token,
-			BasePath: Cfg.DeprecatedStorage.Alist.BasePath,
-			TokenExp: Cfg.DeprecatedStorage.Alist.TokenExp,
-		}
-		Cfg.Storages = append(Cfg.Storages, alistStorage)
-	}
-	if Cfg.DeprecatedStorage.Local.Enable {
-		localStorage := &LocalStorageConfig{
-			NewStorageConfig: NewStorageConfig{
-				Name:   "Local",
-				Enable: true,
-				Type:   string(types.StorageTypeLocal),
-			},
-			BasePath: Cfg.DeprecatedStorage.Local.BasePath,
-		}
-		Cfg.Storages = append(Cfg.Storages, localStorage)
-	}
-	if Cfg.DeprecatedStorage.Webdav.Enable {
-		webdavStorage := &WebdavStorageConfig{
-			NewStorageConfig: NewStorageConfig{
-				Name:   "Webdav",
-				Enable: true,
-				Type:   string(types.StorageTypeWebdav),
-			},
-			URL:      Cfg.DeprecatedStorage.Webdav.URL,
-			Username: Cfg.DeprecatedStorage.Webdav.Username,
-			Password: Cfg.DeprecatedStorage.Webdav.Password,
-			BasePath: Cfg.DeprecatedStorage.Webdav.BasePath,
-		}
-		Cfg.Storages = append(Cfg.Storages, webdavStorage)
-	}
-}

config/storage/alist.go

@@ -0,0 +1,38 @@
+package storage
+
+import (
+	"fmt"
+
+	"github.com/krau/SaveAny-Bot/types"
+)
+
+type AlistStorageConfig struct {
+	BaseConfig
+	URL      string `toml:"url" mapstructure:"url" json:"url"`
+	Username string `toml:"username" mapstructure:"username" json:"username"`
+	Password string `toml:"password" mapstructure:"password" json:"password"`
+	Token    string `toml:"token" mapstructure:"token" json:"token"`
+	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
+	TokenExp int64  `toml:"token_exp" mapstructure:"token_exp" json:"token_exp"`
+}
+
+func (a *AlistStorageConfig) Validate() error {
+	if a.URL == "" {
+		return fmt.Errorf("url is required for alist storage")
+	}
+	if a.Token == "" && (a.Username == "" || a.Password == "") {
+		return fmt.Errorf("username and password or token is required for alist storage")
+	}
+	if a.BasePath == "" {
+		return fmt.Errorf("base_path is required for alist storage")
+	}
+	return nil
+}
+
+func (a *AlistStorageConfig) GetType() types.StorageType {
+	return types.StorageTypeAlist
+}
+
+func (a *AlistStorageConfig) GetName() string {
+	return a.Name
+}

config/storage/factory.go

@@ -0,0 +1,63 @@
+package storage
+
+import (
+	"fmt"
+	"reflect"
+
+	"github.com/krau/SaveAny-Bot/types"
+	"github.com/mitchellh/mapstructure"
+	"github.com/spf13/viper"
+)
+
+var storageFactories = map[types.StorageType]func(cfg *BaseConfig) (StorageConfig, error){
+	types.StorageTypeLocal:  createStorageConfig(&LocalStorageConfig{}),
+	types.StorageTypeAlist:  createStorageConfig(&AlistStorageConfig{}),
+	types.StorageTypeWebdav: createStorageConfig(&WebdavStorageConfig{}),
+	types.StorageTypeMinio:  createStorageConfig(&MinioStorageConfig{}),
+}
+
+func createStorageConfig(configType StorageConfig) func(cfg *BaseConfig) (StorageConfig, error) {
+	return func(cfg *BaseConfig) (StorageConfig, error) {
+		configValue := reflect.New(reflect.TypeOf(configType).Elem()).Interface().(StorageConfig)
+
+		reflect.ValueOf(configValue).Elem().FieldByName("BaseConfig").Set(reflect.ValueOf(*cfg))
+
+		if err := mapstructure.Decode(cfg.RawConfig, configValue); err != nil {
+			return nil, fmt.Errorf("failed to decode %s storage config: %w", cfg.Type, err)
+		}
+
+		return configValue, nil
+	}
+}
+
+func LoadStorageConfigs(v *viper.Viper) ([]StorageConfig, error) {
+	var baseConfigs []BaseConfig
+	if err := v.UnmarshalKey("storages", &baseConfigs); err != nil {
+		return nil, fmt.Errorf("failed to unmarshal storage configs: %w", err)
+	}
+
+	var configs []StorageConfig
+	for _, baseCfg := range baseConfigs {
+		if !baseCfg.Enable {
+			continue
+		}
+
+		factory, ok := storageFactories[types.StorageType(baseCfg.Type)]
+		if !ok {
+			return nil, fmt.Errorf("unsupported storage type: %s", baseCfg.Type)
+		}
+
+		cfg, err := factory(&baseCfg)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create storage config for %s: %w", baseCfg.Name, err)
+		}
+
+		if err := cfg.Validate(); err != nil {
+			return nil, fmt.Errorf("invalid storage config for %s: %w", baseCfg.Name, err)
+		}
+
+		configs = append(configs, cfg)
+	}
+
+	return configs, nil
+}

config/storage/local.go

@@ -0,0 +1,27 @@
+package storage
+
+import (
+	"fmt"
+
+	"github.com/krau/SaveAny-Bot/types"
+)
+
+type LocalStorageConfig struct {
+	BaseConfig
+	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
+}
+
+func (l *LocalStorageConfig) Validate() error {
+	if l.BasePath == "" {
+		return fmt.Errorf("path is required for local storage")
+	}
+	return nil
+}
+
+func (l *LocalStorageConfig) GetType() types.StorageType {
+	return types.StorageTypeLocal
+}
+
+func (l *LocalStorageConfig) GetName() string {
+	return l.Name
+}

config/storage/minio.go

@@ -0,0 +1,41 @@
+package storage
+
+import (
+	"fmt"
+
+	"github.com/krau/SaveAny-Bot/types"
+)
+
+type MinioStorageConfig struct {
+	BaseConfig
+	Endpoint        string `toml:"endpoint" mapstructure:"endpoint" json:"endpoint"`
+	AccessKeyID     string `toml:"access_key_id" mapstructure:"access_key_id" json:"access_key_id"`
+	SecretAccessKey string `toml:"secret_access_key" mapstructure:"secret_access_key" json:"secret_access_key"`
+	BucketName      string `toml:"bucket_name" mapstructure:"bucket_name" json:"bucket_name"`
+	UseSSL          bool   `toml:"use_ssl" mapstructure:"use_ssl" json:"use_ssl"`
+	BasePath        string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
+}
+
+func (m *MinioStorageConfig) Validate() error {
+	if m.Endpoint == "" {
+		return fmt.Errorf("endpoint is required for minio storage")
+	}
+	if m.AccessKeyID == "" || m.SecretAccessKey == "" {
+		return fmt.Errorf("access_key_id and secret_access_key are required for minio storage")
+	}
+	if m.BucketName == "" {
+		return fmt.Errorf("bucket_name is required for minio storage")
+	}
+	if m.BasePath == "" {
+		return fmt.Errorf("base_path is required for minio storage")
+	}
+	return nil
+}
+
+func (m *MinioStorageConfig) GetType() types.StorageType {
+	return types.StorageTypeMinio
+}
+
+func (m *MinioStorageConfig) GetName() string {
+	return m.Name
+}

config/storage/types.go

@@ -0,0 +1,16 @@
+package storage
+
+import "github.com/krau/SaveAny-Bot/types"
+
+type StorageConfig interface {
+	Validate() error
+	GetType() types.StorageType
+	GetName() string
+}
+
+type BaseConfig struct {
+	Name      string         `toml:"name" mapstructure:"name" json:"name"`
+	Type      string         `toml:"type" mapstructure:"type" json:"type"`
+	Enable    bool           `toml:"enable" mapstructure:"enable" json:"enable"`
+	RawConfig map[string]any `toml:"-" mapstructure:",remain"`
+}

config/storage/webdav.go

@@ -0,0 +1,36 @@
+package storage
+
+import (
+	"fmt"
+
+	"github.com/krau/SaveAny-Bot/types"
+)
+
+type WebdavStorageConfig struct {
+	BaseConfig
+	URL      string `toml:"url" mapstructure:"url" json:"url"`
+	Username string `toml:"username" mapstructure:"username" json:"username"`
+	Password string `toml:"password" mapstructure:"password" json:"password"`
+	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
+}
+
+func (w *WebdavStorageConfig) Validate() error {
+	if w.URL == "" {
+		return fmt.Errorf("url is required for webdav storage")
+	}
+	if w.Username == "" || w.Password == "" {
+		return fmt.Errorf("username and password is required for webdav storage")
+	}
+	if w.BasePath == "" {
+		return fmt.Errorf("base_path is required for webdav storage")
+	}
+	return nil
+}
+
+func (w *WebdavStorageConfig) GetType() types.StorageType {
+	return types.StorageTypeWebdav
+}
+
+func (w *WebdavStorageConfig) GetName() string {
+	return w.Name
+}

config/storage_factory.go

@@ -1,104 +0,0 @@
-package config
-
-import (
-	"fmt"
-
-	"github.com/krau/SaveAny-Bot/types"
-	"github.com/mitchellh/mapstructure"
-	"github.com/spf13/viper"
-)
-
-type StorageConfig interface {
-	Validate() error
-	GetType() types.StorageType
-	GetName() string
-}
-
-// Base storage config
-type NewStorageConfig struct {
-	Name      string         `toml:"name" mapstructure:"name" json:"name"`
-	Type      string         `toml:"type" mapstructure:"type" json:"type"`
-	Enable    bool           `toml:"enable" mapstructure:"enable" json:"enable"`
-	RawConfig map[string]any `toml:"-" mapstructure:",remain"`
-}
-
-var storageFactories = map[types.StorageType]func(cfg *NewStorageConfig) (StorageConfig, error){
-	types.StorageTypeLocal:  newLocalStorageConfig,
-	types.StorageTypeAlist:  newAlistStorageConfig,
-	types.StorageTypeWebdav: newWebdavStorageConfig,
-	types.StorageTypeMinio:  newMinioStorageConfig,
-}
-
-func LoadStorageConfigs(v *viper.Viper) ([]StorageConfig, error) {
-	var baseConfigs []NewStorageConfig
-	if err := v.UnmarshalKey("storages", &baseConfigs); err != nil {
-		return nil, fmt.Errorf("failed to unmarshal storage configs: %w", err)
-	}
-
-	var configs []StorageConfig
-	for _, baseCfg := range baseConfigs {
-		if !baseCfg.Enable {
-			continue
-		}
-
-		factory, ok := storageFactories[types.StorageType(baseCfg.Type)]
-		if !ok {
-			return nil, fmt.Errorf("unsupported storage type: %s", baseCfg.Type)
-		}
-
-		cfg, err := factory(&baseCfg)
-		if err != nil {
-			return nil, fmt.Errorf("failed to create storage config for %s: %w", baseCfg.Name, err)
-		}
-
-		if err := cfg.Validate(); err != nil {
-			return nil, fmt.Errorf("invalid storage config for %s: %w", baseCfg.Name, err)
-		}
-
-		configs = append(configs, cfg)
-	}
-
-	return configs, nil
-}
-
-func newLocalStorageConfig(cfg *NewStorageConfig) (StorageConfig, error) {
-	var localCfg LocalStorageConfig
-	localCfg.NewStorageConfig = *cfg
-
-	if err := mapstructure.Decode(cfg.RawConfig, &localCfg); err != nil {
-		return nil, fmt.Errorf("failed to decode local storage config: %w", err)
-	}
-
-	return &localCfg, nil
-}
-
-func newAlistStorageConfig(cfg *NewStorageConfig) (StorageConfig, error) {
-	var alistCfg AlistStorageConfig
-	alistCfg.NewStorageConfig = *cfg
-
-	if err := mapstructure.Decode(cfg.RawConfig, &alistCfg); err != nil {
-		return nil, fmt.Errorf("failed to decode alist storage config: %w", err)
-	}
-
-	return &alistCfg, nil
-}
-
-func newWebdavStorageConfig(cfg *NewStorageConfig) (StorageConfig, error) {
-	var webdavCfg WebdavStorageConfig
-	webdavCfg.NewStorageConfig = *cfg
-
-	if err := mapstructure.Decode(cfg.RawConfig, &webdavCfg); err != nil {
-		return nil, fmt.Errorf("failed to decode webdav storage config: %w", err)
-	}
-
-	return &webdavCfg, nil
-}
-
-func newMinioStorageConfig(cfg *NewStorageConfig) (StorageConfig, error) {
-	var minioCfg MinioStorageConfig
-	minioCfg.NewStorageConfig = *cfg
-	if err := mapstructure.Decode(cfg.RawConfig, &minioCfg); err != nil {
-		return nil, fmt.Errorf("failed to decode minio storage config: %w", err)
-	}
-	return &minioCfg, nil
-}

config/storages.go

@@ -1,140 +0,0 @@
-package config
-
-import (
-	"fmt"
-
-	"github.com/krau/SaveAny-Bot/types"
-)
-
-func (c *Config) GetStoragesByType(storageType types.StorageType) []StorageConfig {
-	var storages []StorageConfig
-	for _, storage := range c.Storages {
-		if storage.GetType() == storageType {
-			storages = append(storages, storage)
-		}
-	}
-	return storages
-}
-
-func (c *Config) GetStorageByName(name string) StorageConfig {
-	for _, storage := range c.Storages {
-		if storage.GetName() == name {
-			return storage
-		}
-	}
-	return nil
-}
-
-type LocalStorageConfig struct {
-	NewStorageConfig
-	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-}
-
-func (l *LocalStorageConfig) Validate() error {
-	if l.BasePath == "" {
-		return fmt.Errorf("path is required for local storage")
-	}
-	return nil
-}
-
-func (l *LocalStorageConfig) GetType() types.StorageType {
-	return types.StorageTypeLocal
-}
-
-func (l *LocalStorageConfig) GetName() string {
-	return l.Name
-}
-
-type AlistStorageConfig struct {
-	NewStorageConfig
-	URL      string `toml:"url" mapstructure:"url" json:"url"`
-	Username string `toml:"username" mapstructure:"username" json:"username"`
-	Password string `toml:"password" mapstructure:"password" json:"password"`
-	Token    string `toml:"token" mapstructure:"token" json:"token"`
-	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-	TokenExp int64  `toml:"token_exp" mapstructure:"token_exp" json:"token_exp"`
-}
-
-func (a *AlistStorageConfig) Validate() error {
-	if a.URL == "" {
-		return fmt.Errorf("url is required for alist storage")
-	}
-	if a.Token == "" && (a.Username == "" || a.Password == "") {
-		return fmt.Errorf("username and password or token is required for alist storage")
-	}
-	if a.BasePath == "" {
-		return fmt.Errorf("base_path is required for alist storage")
-	}
-	return nil
-}
-
-func (a *AlistStorageConfig) GetType() types.StorageType {
-	return types.StorageTypeAlist
-}
-
-func (a *AlistStorageConfig) GetName() string {
-	return a.Name
-}
-
-type WebdavStorageConfig struct {
-	NewStorageConfig
-	URL      string `toml:"url" mapstructure:"url" json:"url"`
-	Username string `toml:"username" mapstructure:"username" json:"username"`
-	Password string `toml:"password" mapstructure:"password" json:"password"`
-	BasePath string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-}
-
-func (w *WebdavStorageConfig) Validate() error {
-	if w.URL == "" {
-		return fmt.Errorf("url is required for webdav storage")
-	}
-	if w.Username == "" || w.Password == "" {
-		return fmt.Errorf("username and password is required for webdav storage")
-	}
-	if w.BasePath == "" {
-		return fmt.Errorf("base_path is required for webdav storage")
-	}
-	return nil
-}
-
-func (w *WebdavStorageConfig) GetType() types.StorageType {
-	return types.StorageTypeWebdav
-}
-
-func (w *WebdavStorageConfig) GetName() string {
-	return w.Name
-}
-
-type MinioStorageConfig struct {
-	NewStorageConfig
-	Endpoint        string `toml:"endpoint" mapstructure:"endpoint" json:"endpoint"`
-	AccessKeyID     string `toml:"access_key_id" mapstructure:"access_key_id" json:"access_key_id"`
-	SecretAccessKey string `toml:"secret_access_key" mapstructure:"secret_access_key" json:"secret_access_key"`
-	BucketName      string `toml:"bucket_name" mapstructure:"bucket_name" json:"bucket_name"`
-	UseSSL          bool   `toml:"use_ssl" mapstructure:"use_ssl" json:"use_ssl"`
-	BasePath        string `toml:"base_path" mapstructure:"base_path" json:"base_path"`
-}
-
-func (m *MinioStorageConfig) Validate() error {
-	if m.Endpoint == "" {
-		return fmt.Errorf("endpoint is required for minio storage")
-	}
-	if m.AccessKeyID == "" || m.SecretAccessKey == "" {
-		return fmt.Errorf("access_key_id and secret_access_key are required for minio storage")
-	}
-	if m.BucketName == "" {
-		return fmt.Errorf("bucket_name is required for minio storage")
-	}
-	if m.BasePath == "" {
-		return fmt.Errorf("base_path is required for minio storage")
-	}
-	return nil
-}
-
-func (m *MinioStorageConfig) GetType() types.StorageType {
-	return types.StorageTypeMinio
-}
-
-func (m *MinioStorageConfig) GetName() string {
-	return m.Name
-}

config/viper.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/krau/SaveAny-Bot/config/storage"
 	"github.com/spf13/viper"
 )
 
@@ -17,13 +18,11 @@ type Config struct {
 
 	Users []userConfig `toml:"users" mapstructure:"users" json:"users"`
 
-	Temp     tempConfig      `toml:"temp" mapstructure:"temp"`
-	Log      logConfig       `toml:"log" mapstructure:"log"`
-	DB       dbConfig        `toml:"db" mapstructure:"db"`
-	Telegram telegramConfig  `toml:"telegram" mapstructure:"telegram"`
-	Storages []StorageConfig `toml:"-" mapstructure:"-" json:"storages"`
-	// Deprecated
-	DeprecatedStorage deprecatedStorageConfig `toml:"storage" mapstructure:"storage"`
+	Temp     tempConfig              `toml:"temp" mapstructure:"temp"`
+	Log      logConfig               `toml:"log" mapstructure:"log"`
+	DB       dbConfig                `toml:"db" mapstructure:"db"`
+	Telegram telegramConfig          `toml:"telegram" mapstructure:"telegram"`
+	Storages []storage.StorageConfig `toml:"-" mapstructure:"-" json:"storages"`
 }
 
 type tempConfig struct {
@@ -58,6 +57,15 @@ type proxyConfig struct {
 
 var Cfg *Config
 
+func (c Config) GetStorageByName(name string) storage.StorageConfig {
+	for _, storage := range c.Storages {
+		if storage.GetName() == name {
+			return storage
+		}
+	}
+	return nil
+}
+
 func Init() error {
 	viper.SetConfigName("config")
 	viper.AddConfigPath(".")
@@ -102,38 +110,12 @@ func Init() error {
 		os.Exit(1)
 	}
 
-	if Cfg.Telegram.Admins != nil {
-		fmt.Println("警告: 你正在使用旧版 Telegram 管理员配置, 该配置下的用户将可用所有存储.\ntelegram.admins 未来版本将会被废弃, 请参考新的配置文件模板, 使用 users 配置替代.")
-		for _, admin := range Cfg.Telegram.Admins {
-			found := false
-			for _, user := range Cfg.Users {
-				if user.ID == admin {
-					found = true
-					break
-				}
-			}
-			if found {
-				continue
-			}
-			Cfg.Users = append(Cfg.Users, userConfig{
-				ID:        admin,
-				Storages:  []string{},
-				Blacklist: true,
-			})
-		}
-	}
-
-	storagesConfig, err := LoadStorageConfigs(viper.GetViper())
+	storagesConfig, err := storage.LoadStorageConfigs(viper.GetViper())
 	if err != nil {
 		return fmt.Errorf("error loading storage configs: %w", err)
 	}
 	Cfg.Storages = storagesConfig
 
-	if Cfg.DeprecatedStorage != (deprecatedStorageConfig{}) {
-		fmt.Println("\n警告: 你正在使用旧版存储配置, 未来版本将会被废弃.\n请参考新的配置文件模板.")
-		transformDeprecatedStorageConfig()
-	}
-
 	storageNames := make(map[string]struct{})
 	for _, storage := range Cfg.Storages {
 		if _, ok := storageNames[storage.GetName()]; ok {