mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-06-01 04:12:10 +00:00
Improve install code to avoid low-level mistakes. (#17779)
* Improve install code to avoid low-level mistakes. If a user tries to do a re-install in a Gitea database, they gets a warning and double check. When Gitea runs, it never create empty app.ini automatically. Also some small (related) refactoring: * Refactor db.InitEngine related logic make it more clean (especially for the install code) * Move some i18n strings out from setting.go to make the setting.go can be easily maintained. * Show errors in CLI code if an incorrect app.ini is used. * APP_DATA_PATH is created when installing, and checked when starting (no empty directory is created any more).
This commit is contained in:
wxiaoguang
GitHub
parent
a3517d8668
commit
042cac5fed
36 changed files with 472 additions and 177 deletions
|
|
@ -15,6 +15,7 @@ import (
|
|||
"time"
|
||||
|
||||
"code.gitea.io/gitea/models/db"
|
||||
db_install "code.gitea.io/gitea/models/db/install"
|
||||
"code.gitea.io/gitea/models/migrations"
|
||||
user_model "code.gitea.io/gitea/models/user"
|
||||
"code.gitea.io/gitea/modules/base"
|
||||
|
|
@ -161,10 +162,81 @@ func Install(ctx *context.Context) {
|
|||
ctx.HTML(http.StatusOK, tplInstall)
|
||||
}
|
||||
|
||||
func checkDatabase(ctx *context.Context, form *forms.InstallForm) bool {
|
||||
var err error
|
||||
|
||||
if (setting.Database.Type == "sqlite3") &&
|
||||
len(setting.Database.Path) == 0 {
|
||||
ctx.Data["Err_DbPath"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.err_empty_db_path"), tplInstall, form)
|
||||
return false
|
||||
}
|
||||
|
||||
// Check if the user is trying to re-install in an installed database
|
||||
db.UnsetDefaultEngine()
|
||||
defer db.UnsetDefaultEngine()
|
||||
|
||||
if err = db.InitEngine(ctx); err != nil {
|
||||
if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
|
||||
ctx.Data["Err_DbType"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "https://docs.gitea.io/en-us/install-from-binary/"), tplInstall, form)
|
||||
} else {
|
||||
ctx.Data["Err_DbSetting"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), tplInstall, form)
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
err = db_install.CheckDatabaseConnection()
|
||||
if err != nil {
|
||||
ctx.Data["Err_DbSetting"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), tplInstall, form)
|
||||
return false
|
||||
}
|
||||
|
||||
hasPostInstallationUser, err := db_install.HasPostInstallationUsers()
|
||||
if err != nil {
|
||||
ctx.Data["Err_DbSetting"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_db_table", "user", err), tplInstall, form)
|
||||
return false
|
||||
}
|
||||
dbMigrationVersion, err := db_install.GetMigrationVersion()
|
||||
if err != nil {
|
||||
ctx.Data["Err_DbSetting"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_db_table", "version", err), tplInstall, form)
|
||||
return false
|
||||
}
|
||||
|
||||
if hasPostInstallationUser && dbMigrationVersion > 0 {
|
||||
log.Error("The database is likely to have been used by Gitea before, database migration version=%d", dbMigrationVersion)
|
||||
confirmed := form.ReinstallConfirmFirst && form.ReinstallConfirmSecond && form.ReinstallConfirmThird
|
||||
if !confirmed {
|
||||
ctx.Data["Err_DbInstalledBefore"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.reinstall_error"), tplInstall, form)
|
||||
return false
|
||||
}
|
||||
|
||||
log.Info("User confirmed reinstallation of Gitea into a pre-existing database")
|
||||
}
|
||||
|
||||
if hasPostInstallationUser || dbMigrationVersion > 0 {
|
||||
log.Info("Gitea will be installed in a database with: hasPostInstallationUser=%v, dbMigrationVersion=%v", hasPostInstallationUser, dbMigrationVersion)
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// SubmitInstall response for submit install items
|
||||
func SubmitInstall(ctx *context.Context) {
|
||||
form := *web.GetForm(ctx).(*forms.InstallForm)
|
||||
var err error
|
||||
|
||||
form := *web.GetForm(ctx).(*forms.InstallForm)
|
||||
|
||||
// fix form values
|
||||
if form.AppURL != "" && form.AppURL[len(form.AppURL)-1] != '/' {
|
||||
form.AppURL += "/"
|
||||
}
|
||||
|
||||
ctx.Data["CurDbOption"] = form.DbType
|
||||
|
||||
if ctx.HasError() {
|
||||
|
|
@ -186,9 +258,9 @@ func SubmitInstall(ctx *context.Context) {
|
|||
return
|
||||
}
|
||||
|
||||
// Pass basic check, now test configuration.
|
||||
// Test database setting.
|
||||
// ---- Basic checks are passed, now test configuration.
|
||||
|
||||
// Test database setting.
|
||||
setting.Database.Type = setting.GetDBTypeByName(form.DbType)
|
||||
setting.Database.Host = form.DbHost
|
||||
setting.Database.User = form.DbUser
|
||||
|
|
@ -201,22 +273,13 @@ func SubmitInstall(ctx *context.Context) {
|
|||
setting.Database.LogSQL = !setting.IsProd
|
||||
setting.PasswordHashAlgo = form.PasswordAlgorithm
|
||||
|
||||
if (setting.Database.Type == "sqlite3") &&
|
||||
len(setting.Database.Path) == 0 {
|
||||
ctx.Data["Err_DbPath"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.err_empty_db_path"), tplInstall, &form)
|
||||
if !checkDatabase(ctx, &form) {
|
||||
return
|
||||
}
|
||||
|
||||
// Set test engine.
|
||||
if err = db.InitEngineWithMigration(ctx, migrations.Migrate); err != nil {
|
||||
if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
|
||||
ctx.Data["Err_DbType"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "https://docs.gitea.io/en-us/install-from-binary/"), tplInstall, &form)
|
||||
} else {
|
||||
ctx.Data["Err_DbSetting"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), tplInstall, &form)
|
||||
}
|
||||
// Prepare AppDataPath, it is very important for Gitea
|
||||
if err = setting.PrepareAppDataPath(); err != nil {
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_app_data_path", err), tplInstall, &form)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -299,9 +362,14 @@ func SubmitInstall(ctx *context.Context) {
|
|||
}
|
||||
}
|
||||
|
||||
if form.AppURL[len(form.AppURL)-1] != '/' {
|
||||
form.AppURL += "/"
|
||||
// Init the engine with migration
|
||||
if err = db.InitEngineWithMigration(ctx, migrations.Migrate); err != nil {
|
||||
db.UnsetDefaultEngine()
|
||||
ctx.Data["Err_DbSetting"] = true
|
||||
ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), tplInstall, &form)
|
||||
return
|
||||
}
|
||||
db.UnsetDefaultEngine()
|
||||
|
||||
// Save settings.
|
||||
cfg := ini.Empty()
|
||||
|
|
@ -344,12 +412,12 @@ func SubmitInstall(ctx *context.Context) {
|
|||
if form.LFSRootPath != "" {
|
||||
cfg.Section("server").Key("LFS_START_SERVER").SetValue("true")
|
||||
cfg.Section("server").Key("LFS_CONTENT_PATH").SetValue(form.LFSRootPath)
|
||||
var secretKey string
|
||||
if secretKey, err = generate.NewJwtSecretBase64(); err != nil {
|
||||
var lfsJwtSecret string
|
||||
if lfsJwtSecret, err = generate.NewJwtSecretBase64(); err != nil {
|
||||
ctx.RenderWithErr(ctx.Tr("install.lfs_jwt_secret_failed", err), tplInstall, &form)
|
||||
return
|
||||
}
|
||||
cfg.Section("server").Key("LFS_JWT_SECRET").SetValue(secretKey)
|
||||
cfg.Section("server").Key("LFS_JWT_SECRET").SetValue(lfsJwtSecret)
|
||||
} else {
|
||||
cfg.Section("server").Key("LFS_START_SERVER").SetValue("false")
|
||||
}
|
||||
|
|
@ -390,16 +458,30 @@ func SubmitInstall(ctx *context.Context) {
|
|||
cfg.Section("log").Key("ROUTER").SetValue("console")
|
||||
|
||||
cfg.Section("security").Key("INSTALL_LOCK").SetValue("true")
|
||||
var secretKey string
|
||||
if secretKey, err = generate.NewSecretKey(); err != nil {
|
||||
ctx.RenderWithErr(ctx.Tr("install.secret_key_failed", err), tplInstall, &form)
|
||||
|
||||
var internalToken string
|
||||
if internalToken, err = generate.NewInternalToken(); err != nil {
|
||||
ctx.RenderWithErr(ctx.Tr("install.internal_token_failed", err), tplInstall, &form)
|
||||
return
|
||||
}
|
||||
cfg.Section("security").Key("SECRET_KEY").SetValue(secretKey)
|
||||
cfg.Section("security").Key("INTERNAL_TOKEN").SetValue(internalToken)
|
||||
|
||||
// if there is already a SECRET_KEY, we should not overwrite it, otherwise the encrypted data will not be able to be decrypted
|
||||
if setting.SecretKey == "" {
|
||||
var secretKey string
|
||||
if secretKey, err = generate.NewSecretKey(); err != nil {
|
||||
ctx.RenderWithErr(ctx.Tr("install.secret_key_failed", err), tplInstall, &form)
|
||||
return
|
||||
}
|
||||
cfg.Section("security").Key("SECRET_KEY").SetValue(secretKey)
|
||||
}
|
||||
|
||||
if len(form.PasswordAlgorithm) > 0 {
|
||||
cfg.Section("security").Key("PASSWORD_HASH_ALGO").SetValue(form.PasswordAlgorithm)
|
||||
}
|
||||
|
||||
log.Info("Save settings to custom config file %s", setting.CustomConf)
|
||||
|
||||
err = os.MkdirAll(filepath.Dir(setting.CustomConf), os.ModePerm)
|
||||
if err != nil {
|
||||
ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), tplInstall, &form)
|
||||
|
|
@ -411,8 +493,10 @@ func SubmitInstall(ctx *context.Context) {
|
|||
return
|
||||
}
|
||||
|
||||
// Re-read settings
|
||||
ReloadSettings(ctx)
|
||||
// ---- All checks are passed
|
||||
|
||||
// Reload settings (and re-initialize database connection)
|
||||
reloadSettings(ctx)
|
||||
|
||||
// Create admin account
|
||||
if len(form.AdminName) > 0 {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue