Files
mc-gateway/internal/adminconfig/config.go
tursom f508ecc1b9
Some checks failed
Go / build (.exe, 386, windows, windows-386) (push) Has been cancelled
Go / build (.exe, amd64, windows, windows-amd64) (push) Has been cancelled
Go / build (.exe, arm64, windows, windows-arm64) (push) Has been cancelled
Go / build (386, freebsd, freebsd-386) (push) Has been cancelled
Go / build (386, linux, linux-386) (push) Has been cancelled
Go / build (386, netbsd, netbsd-386) (push) Has been cancelled
Go / build (386, openbsd, openbsd-386) (push) Has been cancelled
Go / build (386, plan9, plan9-386) (push) Has been cancelled
Go / build (amd64, darwin, darwin-amd64) (push) Has been cancelled
Go / build (amd64, dragonfly, dragonfly-amd64) (push) Has been cancelled
Go / build (amd64, freebsd, freebsd-amd64) (push) Has been cancelled
Go / build (amd64, illumos, illumos-amd64) (push) Has been cancelled
Go / build (amd64, linux, linux-amd64) (push) Has been cancelled
Go / build (amd64, netbsd, netbsd-amd64) (push) Has been cancelled
Go / build (amd64, openbsd, openbsd-amd64) (push) Has been cancelled
Go / build (amd64, plan9, plan9-amd64) (push) Has been cancelled
Go / build (amd64, solaris, solaris-amd64) (push) Has been cancelled
Go / build (arm, 6, linux, linux-armv6) (push) Has been cancelled
Go / build (arm, 7, linux, linux-armv7) (push) Has been cancelled
Go / build (arm, freebsd, freebsd-arm) (push) Has been cancelled
Go / build (arm, netbsd, netbsd-arm) (push) Has been cancelled
Go / build (arm, openbsd, openbsd-arm) (push) Has been cancelled
Go / build (arm, plan9, plan9-arm) (push) Has been cancelled
Go / build (arm64, darwin, darwin-arm64) (push) Has been cancelled
Go / build (arm64, freebsd, freebsd-arm64) (push) Has been cancelled
Go / build (arm64, linux, linux-arm64) (push) Has been cancelled
Go / build (arm64, netbsd, netbsd-arm64) (push) Has been cancelled
Go / build (arm64, openbsd, openbsd-arm64) (push) Has been cancelled
Go / build (loong64, linux, linux-loong64) (push) Has been cancelled
Go / build (mips, linux, linux-mips) (push) Has been cancelled
Go / build (mips64, linux, linux-mips64) (push) Has been cancelled
Go / build (mips64le, linux, linux-mips64le) (push) Has been cancelled
Go / build (mipsle, linux, linux-mipsle) (push) Has been cancelled
Go / build (ppc64, aix, aix-ppc64) (push) Has been cancelled
Go / build (ppc64, linux, linux-ppc64) (push) Has been cancelled
Go / build (ppc64, openbsd, openbsd-ppc64) (push) Has been cancelled
Go / build (ppc64le, linux, linux-ppc64le) (push) Has been cancelled
Go / build (riscv64, freebsd, freebsd-riscv64) (push) Has been cancelled
Go / build (riscv64, linux, linux-riscv64) (push) Has been cancelled
Go / build (riscv64, openbsd, openbsd-riscv64) (push) Has been cancelled
Go / build (s390x, linux, linux-s390x) (push) Has been cancelled
Docker Image / docker (push) Has been cancelled
Go / merge-artifacts (push) Has been cancelled
docs: 补充中文代码注释
2026-06-27 20:15:29 +08:00

145 lines
3.5 KiB
Go

// internal/adminconfig/config.go 在 SQLite 中保存服务级运行态配置,并用类型化方法包装 JSON 选项。
package adminconfig
import (
"errors"
"fmt"
"path"
"strconv"
"strings"
"time"
)
const (
DefaultDBPath = "mc-gateway.sqlite3"
DefaultTCPAdminPort = 25565
DefaultAdminPath = "/admin/"
DefaultAdminAPIPrefix = "/admin/api"
DefaultSessionTTL = 8 * time.Hour
EnvDB = "MC_GATEWAY_DB"
EnvTCPAdminPort = "MC_GATEWAY_TCP_ADMIN_PORT"
EnvPath = "MC_GATEWAY_ADMIN_PATH"
EnvAPIPrefix = "MC_GATEWAY_ADMIN_API_PREFIX"
EnvInitialPassword = "MC_GATEWAY_ADMIN_PASSWORD"
)
type Config struct {
DBPath string
TCPAdminPort int
AdminPath string
AdminAPIPrefix string
SessionTTL time.Duration
}
func Default() Config {
return Config{
DBPath: DefaultDBPath,
TCPAdminPort: DefaultTCPAdminPort,
AdminPath: DefaultAdminPath,
AdminAPIPrefix: DefaultAdminAPIPrefix,
SessionTTL: DefaultSessionTTL,
}
}
func Parse(getenv func(string) string) (Config, error) {
cfg := Default()
if dbPath := strings.TrimSpace(getenv(EnvDB)); dbPath != "" {
cfg.DBPath = dbPath
}
port, err := parseOptionalPort(getenv(EnvTCPAdminPort), DefaultTCPAdminPort, EnvTCPAdminPort)
if err != nil {
return Config{}, err
}
cfg.TCPAdminPort = port
adminPath, err := normalizeAdminPath(getenv(EnvPath))
if err != nil {
return Config{}, err
}
cfg.AdminPath = adminPath
apiPrefix, err := normalizeAdminAPIPrefix(getenv(EnvAPIPrefix))
if err != nil {
return Config{}, err
}
cfg.AdminAPIPrefix = apiPrefix
if err := validateAdminPaths(cfg.AdminPath, cfg.AdminAPIPrefix); err != nil {
return Config{}, err
}
return cfg, nil
}
func parseOptionalPort(value string, fallback int, name string) (int, error) {
value = strings.TrimSpace(value)
if value == "" {
return fallback, nil
}
port, err := strconv.Atoi(value)
if err != nil || port < 1 || port > 65535 {
return 0, fmt.Errorf("%s must be an integer from 1 to 65535", name)
}
return port, nil
}
func normalizeAdminPath(value string) (string, error) {
value = strings.TrimSpace(value)
if value == "" {
value = DefaultAdminPath
}
if !strings.HasPrefix(value, "/") {
return "", fmt.Errorf("%s must start with /", EnvPath)
}
cleaned := path.Clean(value)
if cleaned == "." {
cleaned = "/"
}
if !strings.HasPrefix(cleaned, "/") {
cleaned = "/" + cleaned
}
if !strings.HasSuffix(cleaned, "/") {
cleaned += "/"
}
return cleaned, nil
}
func normalizeAdminAPIPrefix(value string) (string, error) {
value = strings.TrimSpace(value)
if value == "" {
value = DefaultAdminAPIPrefix
}
if !strings.HasPrefix(value, "/") {
return "", fmt.Errorf("%s must start with /", EnvAPIPrefix)
}
cleaned := path.Clean(value)
if cleaned == "." || cleaned == "/" {
return "", fmt.Errorf("%s must not be /", EnvAPIPrefix)
}
if !strings.HasPrefix(cleaned, "/") {
cleaned = "/" + cleaned
}
return strings.TrimRight(cleaned, "/"), nil
}
func validateAdminPaths(adminPath, apiPrefix string) error {
adminRoot := strings.TrimRight(adminPath, "/")
if apiPrefix == adminRoot {
return errors.New("admin API prefix cannot equal admin page path")
}
for _, asset := range []string{"app.css", "config.js", "js"} {
assetPath := strings.TrimRight(adminPath, "/") + "/" + asset
if apiPrefix == assetPath || strings.HasPrefix(apiPrefix+"/", assetPath+"/") {
return errors.New("admin API prefix cannot be under static asset path")
}
}
return nil
}