377a0a20f0
This PR will merge 3 Init functions on setting packages as 1 and introduce an options struct.
182 lines
5.2 KiB
Go
182 lines
5.2 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package setting
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
ini "gopkg.in/ini.v1"
|
|
)
|
|
|
|
type ConfigSection interface {
|
|
Name() string
|
|
MapTo(interface{}) error
|
|
HasKey(key string) bool
|
|
NewKey(name, value string) (*ini.Key, error)
|
|
Key(key string) *ini.Key
|
|
Keys() []*ini.Key
|
|
ChildSections() []*ini.Section
|
|
}
|
|
|
|
// ConfigProvider represents a config provider
|
|
type ConfigProvider interface {
|
|
Section(section string) ConfigSection
|
|
NewSection(name string) (ConfigSection, error)
|
|
GetSection(name string) (ConfigSection, error)
|
|
DeleteSection(name string) error
|
|
Save() error
|
|
}
|
|
|
|
type iniFileConfigProvider struct {
|
|
opts *Options
|
|
*ini.File
|
|
newFile bool // whether the file has not existed previously
|
|
}
|
|
|
|
// NewEmptyConfigProvider create a new empty config provider
|
|
func NewEmptyConfigProvider() ConfigProvider {
|
|
cp, _ := newConfigProviderFromData("")
|
|
return cp
|
|
}
|
|
|
|
// newConfigProviderFromData this function is only for testing
|
|
func newConfigProviderFromData(configContent string) (ConfigProvider, error) {
|
|
var cfg *ini.File
|
|
var err error
|
|
if configContent == "" {
|
|
cfg = ini.Empty()
|
|
} else {
|
|
cfg, err = ini.Load(strings.NewReader(configContent))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
cfg.NameMapper = ini.SnackCase
|
|
return &iniFileConfigProvider{
|
|
File: cfg,
|
|
newFile: true,
|
|
}, nil
|
|
}
|
|
|
|
type Options struct {
|
|
CustomConf string // the ini file path
|
|
AllowEmpty bool // whether not finding configuration files is allowed (only true for the tests)
|
|
ExtraConfig string
|
|
DisableLoadCommonSettings bool
|
|
}
|
|
|
|
// newConfigProviderFromFile load configuration from file.
|
|
// NOTE: do not print any log except error.
|
|
func newConfigProviderFromFile(opts *Options) (*iniFileConfigProvider, error) {
|
|
cfg := ini.Empty()
|
|
newFile := true
|
|
|
|
if opts.CustomConf != "" {
|
|
isFile, err := util.IsFile(opts.CustomConf)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to check if %s is a file. Error: %v", opts.CustomConf, err)
|
|
}
|
|
if isFile {
|
|
if err := cfg.Append(opts.CustomConf); err != nil {
|
|
return nil, fmt.Errorf("failed to load custom conf '%s': %v", opts.CustomConf, err)
|
|
}
|
|
newFile = false
|
|
}
|
|
}
|
|
|
|
if newFile && !opts.AllowEmpty {
|
|
return nil, fmt.Errorf("unable to find configuration file: %q, please ensure you are running in the correct environment or set the correct configuration file with -c", CustomConf)
|
|
}
|
|
|
|
if opts.ExtraConfig != "" {
|
|
if err := cfg.Append([]byte(opts.ExtraConfig)); err != nil {
|
|
return nil, fmt.Errorf("unable to append more config: %v", err)
|
|
}
|
|
}
|
|
|
|
cfg.NameMapper = ini.SnackCase
|
|
return &iniFileConfigProvider{
|
|
opts: opts,
|
|
File: cfg,
|
|
newFile: newFile,
|
|
}, nil
|
|
}
|
|
|
|
func (p *iniFileConfigProvider) Section(section string) ConfigSection {
|
|
return p.File.Section(section)
|
|
}
|
|
|
|
func (p *iniFileConfigProvider) NewSection(name string) (ConfigSection, error) {
|
|
return p.File.NewSection(name)
|
|
}
|
|
|
|
func (p *iniFileConfigProvider) GetSection(name string) (ConfigSection, error) {
|
|
return p.File.GetSection(name)
|
|
}
|
|
|
|
func (p *iniFileConfigProvider) DeleteSection(name string) error {
|
|
p.File.DeleteSection(name)
|
|
return nil
|
|
}
|
|
|
|
// Save save the content into file
|
|
func (p *iniFileConfigProvider) Save() error {
|
|
if p.opts.CustomConf == "" {
|
|
if !p.opts.AllowEmpty {
|
|
return fmt.Errorf("custom config path must not be empty")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
if p.newFile {
|
|
if err := os.MkdirAll(filepath.Dir(CustomConf), os.ModePerm); err != nil {
|
|
return fmt.Errorf("failed to create '%s': %v", CustomConf, err)
|
|
}
|
|
}
|
|
if err := p.SaveTo(p.opts.CustomConf); err != nil {
|
|
return fmt.Errorf("failed to save '%s': %v", p.opts.CustomConf, err)
|
|
}
|
|
|
|
// Change permissions to be more restrictive
|
|
fi, err := os.Stat(CustomConf)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to determine current conf file permissions: %v", err)
|
|
}
|
|
|
|
if fi.Mode().Perm() > 0o600 {
|
|
if err = os.Chmod(CustomConf, 0o600); err != nil {
|
|
log.Warn("Failed changing conf file permissions to -rw-------. Consider changing them manually.")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// a file is an implementation ConfigProvider and other implementations are possible, i.e. from docker, k8s, …
|
|
var _ ConfigProvider = &iniFileConfigProvider{}
|
|
|
|
func mustMapSetting(rootCfg ConfigProvider, sectionName string, setting interface{}) {
|
|
if err := rootCfg.Section(sectionName).MapTo(setting); err != nil {
|
|
log.Fatal("Failed to map %s settings: %v", sectionName, err)
|
|
}
|
|
}
|
|
|
|
func deprecatedSetting(rootCfg ConfigProvider, oldSection, oldKey, newSection, newKey, version string) {
|
|
if rootCfg.Section(oldSection).HasKey(oldKey) {
|
|
log.Error("Deprecated fallback `[%s]` `%s` present. Use `[%s]` `%s` instead. This fallback will be/has been removed in %s", oldSection, oldKey, newSection, newKey, version)
|
|
}
|
|
}
|
|
|
|
// deprecatedSettingDB add a hint that the configuration has been moved to database but still kept in app.ini
|
|
func deprecatedSettingDB(rootCfg ConfigProvider, oldSection, oldKey string) {
|
|
if rootCfg.Section(oldSection).HasKey(oldKey) {
|
|
log.Error("Deprecated `[%s]` `%s` present which has been copied to database table sys_setting", oldSection, oldKey)
|
|
}
|
|
}
|