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).forgejo
parent
a3517d8668
commit
042cac5fed
@ -0,0 +1,65 @@
|
||||
// Copyright 2021 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package install
|
||||
|
||||
import (
|
||||
"code.gitea.io/gitea/models/db"
|
||||
"code.gitea.io/gitea/modules/setting"
|
||||
|
||||
"xorm.io/xorm"
|
||||
)
|
||||
|
||||
func getXORMEngine() *xorm.Engine {
|
||||
return db.DefaultContext.(*db.Context).Engine().(*xorm.Engine)
|
||||
}
|
||||
|
||||
// CheckDatabaseConnection checks the database connection
|
||||
func CheckDatabaseConnection() error {
|
||||
e := db.GetEngine(db.DefaultContext)
|
||||
_, err := e.Exec("SELECT 1")
|
||||
return err
|
||||
}
|
||||
|
||||
// GetMigrationVersion gets the database migration version
|
||||
func GetMigrationVersion() (int64, error) {
|
||||
var installedDbVersion int64
|
||||
x := getXORMEngine()
|
||||
exist, err := x.IsTableExist("version")
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
if !exist {
|
||||
return 0, nil
|
||||
}
|
||||
_, err = x.Table("version").Cols("version").Get(&installedDbVersion)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
return installedDbVersion, nil
|
||||
}
|
||||
|
||||
// HasPostInstallationUsers checks whether there are users after installation
|
||||
func HasPostInstallationUsers() (bool, error) {
|
||||
x := getXORMEngine()
|
||||
exist, err := x.IsTableExist("user")
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
if !exist {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
// if there are 2 or more users in database, we consider there are users created after installation
|
||||
threshold := 2
|
||||
if !setting.IsProd {
|
||||
// to debug easily, with non-prod RUN_MODE, we only check the count to 1
|
||||
threshold = 1
|
||||
}
|
||||
res, err := x.Table("user").Cols("id").Limit(threshold).Query()
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return len(res) >= threshold, nil
|
||||
}
|
@ -0,0 +1,40 @@
|
||||
// Copyright 2021 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package setting
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// PrepareAppDataPath creates app data directory if necessary
|
||||
func PrepareAppDataPath() error {
|
||||
// FIXME: There are too many calls to MkdirAll in old code. It is incorrect.
|
||||
// For example, if someDir=/mnt/vol1/gitea-home/data, if the mount point /mnt/vol1 is not mounted when Gitea runs,
|
||||
// then gitea will make new empty directories in /mnt/vol1, all are stored in the root filesystem.
|
||||
// The correct behavior should be: creating parent directories is end users' duty. We only create sub-directories in existing parent directories.
|
||||
// For quickstart, the parent directories should be created automatically for first startup (eg: a flag or a check of INSTALL_LOCK).
|
||||
// Now we can take the first step to do correctly (using Mkdir) in other packages, and prepare the AppDataPath here, then make a refactor in future.
|
||||
|
||||
st, err := os.Stat(AppDataPath)
|
||||
|
||||
if os.IsNotExist(err) {
|
||||
err = os.MkdirAll(AppDataPath, os.ModePerm)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to create the APP_DATA_PATH directory: %q, Error: %v", AppDataPath, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to use APP_DATA_PATH %q. Error: %v", AppDataPath, err)
|
||||
}
|
||||
|
||||
if !st.IsDir() /* also works for symlink */ {
|
||||
return fmt.Errorf("the APP_DATA_PATH %q is not a directory (or symlink to a directory) and can't be used", AppDataPath)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
@ -0,0 +1,51 @@
|
||||
// Copyright 2021 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package setting
|
||||
|
||||
// defaultI18nLangNames must be a slice, we need the order
|
||||
var defaultI18nLangNames = []string{
|
||||
"en-US", "English",
|
||||
"zh-CN", "简体中文",
|
||||
"zh-HK", "繁體中文(香港)",
|
||||
"zh-TW", "繁體中文(台灣)",
|
||||
"de-DE", "Deutsch",
|
||||
"fr-FR", "français",
|
||||
"nl-NL", "Nederlands",
|
||||
"lv-LV", "latviešu",
|
||||
"ru-RU", "русский",
|
||||
"uk-UA", "Українська",
|
||||
"ja-JP", "日本語",
|
||||
"es-ES", "español",
|
||||
"pt-BR", "português do Brasil",
|
||||
"pt-PT", "Português de Portugal",
|
||||
"pl-PL", "polski",
|
||||
"bg-BG", "български",
|
||||
"it-IT", "italiano",
|
||||
"fi-FI", "suomi",
|
||||
"tr-TR", "Türkçe",
|
||||
"cs-CZ", "čeština",
|
||||
"sr-SP", "српски",
|
||||
"sv-SE", "svenska",
|
||||
"ko-KR", "한국어",
|
||||
"el-GR", "ελληνικά",
|
||||
"fa-IR", "فارسی",
|
||||
"hu-HU", "magyar nyelv",
|
||||
"id-ID", "bahasa Indonesia",
|
||||
"ml-IN", "മലയാളം",
|
||||
}
|
||||
|
||||
func defaultI18nLangs() (res []string) {
|
||||
for i := 0; i < len(defaultI18nLangNames); i += 2 {
|
||||
res = append(res, defaultI18nLangNames[i])
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func defaultI18nNames() (res []string) {
|
||||
for i := 0; i < len(defaultI18nLangNames); i += 2 {
|
||||
res = append(res, defaultI18nLangNames[i+1])
|
||||
}
|
||||
return
|
||||
}
|
Loading…
Reference in New Issue