mirror of https://github.com/go-gitea/gitea
Refactor path & config system (#25330)
# The problem
There were many "path tricks":
* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
* The "serv" process started by OpenSSH server
* The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling
# The solution
* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.
The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default
The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default
## ⚠️ BREAKING
If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.
----
Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503
Replace #23301
Replace #22754
And maybe more
pull/25407/head^2
wxiaoguang
1 year ago
committed by
GitHub
parent
1454f9dafc
commit
2cdf260f42
@ -0,0 +1,191 @@ |
||||
// Copyright 2023 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package setting |
||||
|
||||
import ( |
||||
"errors" |
||||
"os" |
||||
"os/exec" |
||||
"path/filepath" |
||||
"strings" |
||||
|
||||
"code.gitea.io/gitea/modules/log" |
||||
) |
||||
|
||||
var ( |
||||
// AppPath represents the path to the gitea binary
|
||||
AppPath string |
||||
|
||||
// AppWorkPath is the "working directory" of Gitea. It maps to the environment variable GITEA_WORK_DIR.
|
||||
// If that is not set it is the default set here by the linker or failing that the directory of AppPath.
|
||||
// It is used as the base path for several other paths.
|
||||
AppWorkPath string |
||||
CustomPath string // Custom directory path. Env: GITEA_CUSTOM
|
||||
CustomConf string |
||||
|
||||
appWorkPathBuiltin string |
||||
customPathBuiltin string |
||||
customConfBuiltin string |
||||
|
||||
AppWorkPathMismatch bool |
||||
) |
||||
|
||||
func getAppPath() (string, error) { |
||||
var appPath string |
||||
var err error |
||||
if IsWindows && filepath.IsAbs(os.Args[0]) { |
||||
appPath = filepath.Clean(os.Args[0]) |
||||
} else { |
||||
appPath, err = exec.LookPath(os.Args[0]) |
||||
} |
||||
if err != nil { |
||||
if !errors.Is(err, exec.ErrDot) { |
||||
return "", err |
||||
} |
||||
appPath, err = filepath.Abs(os.Args[0]) |
||||
} |
||||
if err != nil { |
||||
return "", err |
||||
} |
||||
appPath, err = filepath.Abs(appPath) |
||||
if err != nil { |
||||
return "", err |
||||
} |
||||
// Note: (legacy code) we don't use path.Dir here because it does not handle case which path starts with two "/" in Windows: "//psf/Home/..."
|
||||
return strings.ReplaceAll(appPath, "\\", "/"), err |
||||
} |
||||
|
||||
func init() { |
||||
var err error |
||||
if AppPath, err = getAppPath(); err != nil { |
||||
log.Fatal("Failed to get app path: %v", err) |
||||
} |
||||
|
||||
if AppWorkPath == "" { |
||||
AppWorkPath = filepath.Dir(AppPath) |
||||
} |
||||
|
||||
appWorkPathBuiltin = AppWorkPath |
||||
customPathBuiltin = CustomPath |
||||
customConfBuiltin = CustomConf |
||||
} |
||||
|
||||
type ArgWorkPathAndCustomConf struct { |
||||
WorkPath string |
||||
CustomPath string |
||||
CustomConf string |
||||
} |
||||
|
||||
type stringWithDefault struct { |
||||
Value string |
||||
IsSet bool |
||||
} |
||||
|
||||
func (s *stringWithDefault) Set(v string) { |
||||
s.Value = v |
||||
s.IsSet = true |
||||
} |
||||
|
||||
// InitWorkPathAndCommonConfig will set AppWorkPath, CustomPath and CustomConf, init default config provider by CustomConf and load common settings,
|
||||
func InitWorkPathAndCommonConfig(getEnvFn func(name string) string, args ArgWorkPathAndCustomConf) { |
||||
tryAbsPath := func(paths ...string) string { |
||||
s := paths[len(paths)-1] |
||||
for i := len(paths) - 2; i >= 0; i-- { |
||||
if filepath.IsAbs(s) { |
||||
break |
||||
} |
||||
s = filepath.Join(paths[i], s) |
||||
} |
||||
return s |
||||
} |
||||
|
||||
var err error |
||||
tmpWorkPath := stringWithDefault{Value: appWorkPathBuiltin} |
||||
if tmpWorkPath.Value == "" { |
||||
tmpWorkPath.Value = filepath.Dir(AppPath) |
||||
} |
||||
tmpCustomPath := stringWithDefault{Value: customPathBuiltin} |
||||
if tmpCustomPath.Value == "" { |
||||
tmpCustomPath.Value = "custom" |
||||
} |
||||
tmpCustomConf := stringWithDefault{Value: customConfBuiltin} |
||||
if tmpCustomConf.Value == "" { |
||||
tmpCustomConf.Value = "conf/app.ini" |
||||
} |
||||
|
||||
readFromEnv := func() { |
||||
envWorkPath := getEnvFn("GITEA_WORK_DIR") |
||||
if envWorkPath != "" { |
||||
tmpWorkPath.Set(envWorkPath) |
||||
if !filepath.IsAbs(tmpWorkPath.Value) { |
||||
log.Fatal("GITEA_WORK_DIR (work path) must be absolute path") |
||||
} |
||||
} |
||||
|
||||
envCustomPath := getEnvFn("GITEA_CUSTOM") |
||||
if envCustomPath != "" { |
||||
tmpCustomPath.Set(envCustomPath) |
||||
if !filepath.IsAbs(tmpCustomPath.Value) { |
||||
log.Fatal("GITEA_CUSTOM (custom path) must be absolute path") |
||||
} |
||||
} |
||||
} |
||||
|
||||
readFromArgs := func() { |
||||
if args.WorkPath != "" { |
||||
tmpWorkPath.Set(args.WorkPath) |
||||
if !filepath.IsAbs(tmpWorkPath.Value) { |
||||
log.Fatal("--work-path must be absolute path") |
||||
} |
||||
} |
||||
if args.CustomPath != "" { |
||||
tmpCustomPath.Set(args.CustomPath) // if it is not abs, it will be based on work-path, it shouldn't happen
|
||||
if !filepath.IsAbs(tmpCustomPath.Value) { |
||||
log.Error("--custom-path must be absolute path") |
||||
} |
||||
} |
||||
if args.CustomConf != "" { |
||||
tmpCustomConf.Set(args.CustomConf) |
||||
if !filepath.IsAbs(tmpCustomConf.Value) { |
||||
// the config path can be relative to the real current working path
|
||||
if tmpCustomConf.Value, err = filepath.Abs(tmpCustomConf.Value); err != nil { |
||||
log.Fatal("Failed to get absolute path of config %q: %v", tmpCustomConf.Value, err) |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
readFromEnv() |
||||
readFromArgs() |
||||
|
||||
if !tmpCustomConf.IsSet { |
||||
tmpCustomConf.Set(tryAbsPath(tmpWorkPath.Value, tmpCustomPath.Value, tmpCustomConf.Value)) |
||||
} |
||||
|
||||
// only read the config but do not load/init anything more, because the AppWorkPath and CustomPath are not ready
|
||||
InitCfgProvider(tmpCustomConf.Value) |
||||
configWorkPath := ConfigSectionKeyString(CfgProvider.Section(""), "WORK_PATH") |
||||
if configWorkPath != "" { |
||||
if !filepath.IsAbs(configWorkPath) { |
||||
log.Fatal("WORK_PATH in %q must be absolute path", configWorkPath) |
||||
} |
||||
configWorkPath = filepath.Clean(configWorkPath) |
||||
if tmpWorkPath.Value != "" && (getEnvFn("GITEA_WORK_DIR") != "" || args.WorkPath != "") { |
||||
fi1, err1 := os.Stat(tmpWorkPath.Value) |
||||
fi2, err2 := os.Stat(configWorkPath) |
||||
if err1 != nil || err2 != nil || !os.SameFile(fi1, fi2) { |
||||
AppWorkPathMismatch = true |
||||
} |
||||
} |
||||
tmpWorkPath.Set(configWorkPath) |
||||
} |
||||
|
||||
tmpCustomPath.Set(tryAbsPath(tmpWorkPath.Value, tmpCustomPath.Value)) |
||||
|
||||
AppWorkPath = tmpWorkPath.Value |
||||
CustomPath = tmpCustomPath.Value |
||||
CustomConf = tmpCustomConf.Value |
||||
|
||||
LoadCommonSettings() |
||||
} |
||||
@ -0,0 +1,151 @@ |
||||
// Copyright 2023 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package setting |
||||
|
||||
import ( |
||||
"os" |
||||
"path/filepath" |
||||
"testing" |
||||
|
||||
"github.com/stretchr/testify/assert" |
||||
) |
||||
|
||||
type envVars map[string]string |
||||
|
||||
func (e envVars) Getenv(key string) string { |
||||
return e[key] |
||||
} |
||||
|
||||
func TestInitWorkPathAndCommonConfig(t *testing.T) { |
||||
testInit := func(defaultWorkPath, defaultCustomPath, defaultCustomConf string) { |
||||
AppWorkPathMismatch = false |
||||
AppWorkPath = defaultWorkPath |
||||
appWorkPathBuiltin = defaultWorkPath |
||||
CustomPath = defaultCustomPath |
||||
customPathBuiltin = defaultCustomPath |
||||
CustomConf = defaultCustomConf |
||||
customConfBuiltin = defaultCustomConf |
||||
} |
||||
|
||||
fp := filepath.Join |
||||
|
||||
tmpDir := t.TempDir() |
||||
dirFoo := fp(tmpDir, "foo") |
||||
dirBar := fp(tmpDir, "bar") |
||||
dirXxx := fp(tmpDir, "xxx") |
||||
dirYyy := fp(tmpDir, "yyy") |
||||
|
||||
t.Run("Default", func(t *testing.T) { |
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, fp(dirFoo, "custom"), CustomPath) |
||||
assert.Equal(t, fp(dirFoo, "custom/conf/app.ini"), CustomConf) |
||||
}) |
||||
|
||||
t.Run("WorkDir(env)", func(t *testing.T) { |
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirBar}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirBar, AppWorkPath) |
||||
assert.Equal(t, fp(dirBar, "custom"), CustomPath) |
||||
assert.Equal(t, fp(dirBar, "custom/conf/app.ini"), CustomConf) |
||||
}) |
||||
|
||||
t.Run("WorkDir(env,arg)", func(t *testing.T) { |
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirBar}.Getenv, ArgWorkPathAndCustomConf{WorkPath: dirXxx}) |
||||
assert.Equal(t, dirXxx, AppWorkPath) |
||||
assert.Equal(t, fp(dirXxx, "custom"), CustomPath) |
||||
assert.Equal(t, fp(dirXxx, "custom/conf/app.ini"), CustomConf) |
||||
}) |
||||
|
||||
t.Run("CustomPath(env)", func(t *testing.T) { |
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_CUSTOM": fp(dirBar, "custom1")}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, fp(dirBar, "custom1"), CustomPath) |
||||
assert.Equal(t, fp(dirBar, "custom1/conf/app.ini"), CustomConf) |
||||
}) |
||||
|
||||
t.Run("CustomPath(env,arg)", func(t *testing.T) { |
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_CUSTOM": fp(dirBar, "custom1")}.Getenv, ArgWorkPathAndCustomConf{CustomPath: "custom2"}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, fp(dirFoo, "custom2"), CustomPath) |
||||
assert.Equal(t, fp(dirFoo, "custom2/conf/app.ini"), CustomConf) |
||||
}) |
||||
|
||||
t.Run("CustomConf", func(t *testing.T) { |
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: "app1.ini"}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
cwd, _ := os.Getwd() |
||||
assert.Equal(t, fp(cwd, "app1.ini"), CustomConf) |
||||
|
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: fp(dirBar, "app1.ini")}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, fp(dirBar, "app1.ini"), CustomConf) |
||||
}) |
||||
|
||||
t.Run("CustomConfOverrideWorkPath", func(t *testing.T) { |
||||
iniWorkPath := fp(tmpDir, "app-workpath.ini") |
||||
_ = os.WriteFile(iniWorkPath, []byte("WORK_PATH="+dirXxx), 0o644) |
||||
|
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: iniWorkPath}) |
||||
assert.Equal(t, dirXxx, AppWorkPath) |
||||
assert.Equal(t, fp(dirXxx, "custom"), CustomPath) |
||||
assert.Equal(t, iniWorkPath, CustomConf) |
||||
assert.False(t, AppWorkPathMismatch) |
||||
|
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirBar}.Getenv, ArgWorkPathAndCustomConf{CustomConf: iniWorkPath}) |
||||
assert.Equal(t, dirXxx, AppWorkPath) |
||||
assert.Equal(t, fp(dirXxx, "custom"), CustomPath) |
||||
assert.Equal(t, iniWorkPath, CustomConf) |
||||
assert.True(t, AppWorkPathMismatch) |
||||
|
||||
testInit(dirFoo, "", "") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{WorkPath: dirBar, CustomConf: iniWorkPath}) |
||||
assert.Equal(t, dirXxx, AppWorkPath) |
||||
assert.Equal(t, fp(dirXxx, "custom"), CustomPath) |
||||
assert.Equal(t, iniWorkPath, CustomConf) |
||||
assert.True(t, AppWorkPathMismatch) |
||||
}) |
||||
|
||||
t.Run("Builtin", func(t *testing.T) { |
||||
testInit(dirFoo, dirBar, dirXxx) |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, dirBar, CustomPath) |
||||
assert.Equal(t, dirXxx, CustomConf) |
||||
|
||||
testInit(dirFoo, "custom1", "cfg.ini") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, fp(dirFoo, "custom1"), CustomPath) |
||||
assert.Equal(t, fp(dirFoo, "custom1/cfg.ini"), CustomConf) |
||||
|
||||
testInit(dirFoo, "custom1", "cfg.ini") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirYyy}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirYyy, AppWorkPath) |
||||
assert.Equal(t, fp(dirYyy, "custom1"), CustomPath) |
||||
assert.Equal(t, fp(dirYyy, "custom1/cfg.ini"), CustomConf) |
||||
|
||||
testInit(dirFoo, "custom1", "cfg.ini") |
||||
InitWorkPathAndCommonConfig(envVars{"GITEA_CUSTOM": dirYyy}.Getenv, ArgWorkPathAndCustomConf{}) |
||||
assert.Equal(t, dirFoo, AppWorkPath) |
||||
assert.Equal(t, dirYyy, CustomPath) |
||||
assert.Equal(t, fp(dirYyy, "cfg.ini"), CustomConf) |
||||
|
||||
iniWorkPath := fp(tmpDir, "app-workpath.ini") |
||||
_ = os.WriteFile(iniWorkPath, []byte("WORK_PATH="+dirXxx), 0o644) |
||||
testInit(dirFoo, "custom1", "cfg.ini") |
||||
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: iniWorkPath}) |
||||
assert.Equal(t, dirXxx, AppWorkPath) |
||||
assert.Equal(t, fp(dirXxx, "custom1"), CustomPath) |
||||
assert.Equal(t, iniWorkPath, CustomConf) |
||||
}) |
||||
} |
||||
@ -1,51 +0,0 @@ |
||||
// Copyright 2021 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package install |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"code.gitea.io/gitea/modules/log" |
||||
"code.gitea.io/gitea/modules/setting" |
||||
"code.gitea.io/gitea/modules/svg" |
||||
"code.gitea.io/gitea/modules/translation" |
||||
"code.gitea.io/gitea/routers/common" |
||||
) |
||||
|
||||
// PreloadSettings preloads the configuration to check if we need to run install
|
||||
func PreloadSettings(ctx context.Context) bool { |
||||
setting.Init(&setting.Options{ |
||||
AllowEmpty: true, |
||||
}) |
||||
if !setting.InstallLock { |
||||
log.Info("AppPath: %s", setting.AppPath) |
||||
log.Info("AppWorkPath: %s", setting.AppWorkPath) |
||||
log.Info("Custom path: %s", setting.CustomPath) |
||||
log.Info("Log path: %s", setting.Log.RootPath) |
||||
log.Info("Configuration file: %s", setting.CustomConf) |
||||
log.Info("Prepare to run install page") |
||||
translation.InitLocales(ctx) |
||||
if setting.EnableSQLite3 { |
||||
log.Info("SQLite3 is supported") |
||||
} |
||||
|
||||
setting.LoadSettingsForInstall() |
||||
_ = svg.Init() |
||||
} |
||||
|
||||
return !setting.InstallLock |
||||
} |
||||
|
||||
// reloadSettings reloads the existing settings and starts up the database
|
||||
func reloadSettings(ctx context.Context) { |
||||
setting.Init(&setting.Options{}) |
||||
setting.LoadDBSetting() |
||||
if setting.InstallLock { |
||||
if err := common.InitDBEngine(ctx); err == nil { |
||||
log.Info("ORM engine initialization successful!") |
||||
} else { |
||||
log.Fatal("ORM engine initialization failed: %v", err) |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue