* 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).
"syscall"
"code.gitea.io/gitea/models/db"
+ "code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/util"
}
func initDB(ctx context.Context) error {
- return initDBDisableConsole(ctx, false)
-}
-
-func initDBDisableConsole(ctx context.Context, disableConsole bool) error {
- setting.NewContext()
+ setting.LoadFromExisting()
setting.InitDBConfig()
- setting.NewXORMLogService(disableConsole)
+ setting.NewXORMLogService(false)
+
+ if setting.Database.Type == "" {
+ log.Fatal(`Database settings are missing from the configuration file: %q.
+Ensure you are running in the correct environment or set the correct configuration file with -c.
+If this is the intended configuration file complete the [database] section.`, setting.CustomConf)
+ }
if err := db.InitEngine(ctx); err != nil {
- return fmt.Errorf("models.SetEngine: %v", err)
+ return fmt.Errorf("unable to initialise the database using the configuration in %q. Error: %v", setting.CustomConf, err)
}
return nil
}
log.Info("Custom path: %s", setting.CustomPath)
log.Info("Log path: %s", setting.LogRootPath)
log.Info("Configuration file: %s", setting.CustomConf)
- setting.InitDBConfig()
if !setting.Database.UseMySQL {
fmt.Println("This command can only be used with a MySQL database")
golog.SetPrefix("")
golog.SetOutput(log.NewLoggerAsWriter("INFO", log.GetLogger(log.DEFAULT)))
- setting.NewContext()
+ setting.LoadFromExisting()
setting.InitDBConfig()
setting.EnableXORMLog = ctx.Bool("debug")
fatal("Deleting default logger failed. Can not write to stdout: %v", err)
}
}
- setting.NewContext()
+ setting.LoadFromExisting()
+
// make sure we are logging to the console no matter what the configuration tells us do to
if _, err := setting.Cfg.Section("log").NewKey("MODE", "console"); err != nil {
fatal("Setting logging mode to console failed: %v", err)
log.Info("Custom path: %s", setting.CustomPath)
log.Info("Log path: %s", setting.LogRootPath)
log.Info("Configuration file: %s", setting.CustomConf)
- setting.InitDBConfig()
var (
serviceType structs.GitServiceType
log.DelNamedLogger(log.DEFAULT)
// Read configuration file
- setting.NewContext()
+ setting.LoadAllowEmpty()
pats, err := getPatterns(c.Args())
if err != nil {
ctx, cancel := installSignals()
defer cancel()
- setting.NewContext()
+ setting.LoadFromExisting()
if err := argsSet(c, "title"); err != nil {
return err
log.Info("Custom path: %s", setting.CustomPath)
log.Info("Log path: %s", setting.LogRootPath)
log.Info("Configuration file: %s", setting.CustomConf)
- setting.InitDBConfig()
if err := db.InitEngineWithMigration(context.Background(), migrations.Migrate); err != nil {
log.Fatal("Failed to initialize ORM engine: %v", err)
log.Info("Custom path: %s", setting.CustomPath)
log.Info("Log path: %s", setting.LogRootPath)
log.Info("Configuration file: %s", setting.CustomConf)
- setting.InitDBConfig()
if err := db.InitEngineWithMigration(context.Background(), migrations.Migrate); err != nil {
log.Fatal("Failed to initialize ORM engine: %v", err)
ctx, cancel := installSignals()
defer cancel()
- setting.NewContext()
+ setting.LoadFromExisting()
statusCode, errStr := private.RestoreRepo(
ctx,
} else {
_ = log.NewLogger(1000, "console", "console", `{"level":"fatal","stacktracelevel":"NONE","stderr":true}`)
}
- setting.NewContext()
+ setting.LoadFromExisting()
if debug {
setting.RunMode = "dev"
}
}
c := install.Routes()
err := listen(c, false)
+ if err != nil {
+ log.Critical("Unable to open listener for installer. Is Gitea already running?")
+ graceful.GetManager().DoGracefulShutdown()
+ }
select {
case <-graceful.GetManager().IsShutdown():
<-graceful.GetManager().Done()
log.Info("Global init")
// Perform global initialization
- routers.GlobalInit(graceful.GetManager().HammerContext())
+ setting.LoadFromExisting()
+ routers.GlobalInitInstalled(graceful.GetManager().HammerContext())
+
+ // We check that AppDataPath exists here (it should have been created during installation)
+ // We can't check it in `GlobalInitInstalled`, because some integration tests
+ // use cmd -> GlobalInitInstalled, but the AppDataPath doesn't exist during those tests.
+ if _, err := os.Stat(setting.AppDataPath); err != nil {
+ log.Fatal("Can not find APP_DATA_PATH '%s'", setting.AppDataPath)
+ }
// Override the provided port number within the configuration
if ctx.IsSet("port") {
destination = setting.CustomConf
}
if destination != setting.CustomConf || changed {
+ log.Info("Settings saved to: %q", destination)
err = cfg.SaveTo(destination)
if err != nil {
return err
log.Fatal(err)
}
setting.SetCustomPathAndConf("", "", "")
- setting.NewContext()
+ setting.LoadAllowEmpty()
setting.RepoRootPath, err = os.MkdirTemp(os.TempDir(), "repos")
if err != nil {
}
setting.SetCustomPathAndConf("", "", "")
- setting.NewContext()
- util.RemoveAll(models.LocalCopyPath())
+ setting.LoadForTest()
+ _ = util.RemoveAll(models.LocalCopyPath())
git.CheckLFSVersion()
setting.InitDBConfig()
if err := storage.Init(); err != nil {
}
defer db.Close()
}
- routers.GlobalInit(graceful.GetManager().HammerContext())
+
+ routers.GlobalInitInstalled(graceful.GetManager().HammerContext())
}
func prepareTestEnv(t testing.TB, skip ...int) func() {
assert.NoError(t, util.RemoveAll(setting.RepoRootPath))
assert.NoError(t, util.CopyDir(path.Join(filepath.Dir(setting.AppPath), "integrations/gitea-repositories-meta"), setting.RepoRootPath))
+
return deferFn
}
setting.CustomConf = giteaConf
}
- setting.NewContext()
+ setting.LoadForTest()
assert.True(t, len(setting.RepoRootPath) != 0)
assert.NoError(t, util.RemoveAll(setting.RepoRootPath))
import (
"context"
"database/sql"
- "errors"
"fmt"
"io"
"reflect"
}
}
-// NewEngine returns a new xorm engine from the configuration
-func NewEngine() (*xorm.Engine, error) {
+// newXORMEngine returns a new XORM engine from the configuration
+func newXORMEngine() (*xorm.Engine, error) {
connStr, err := setting.DBConnStr()
if err != nil {
return nil, err
return x.StoreEngine("InnoDB").Sync2(tables...)
}
-// InitEngine sets the xorm.Engine
-func InitEngine(ctx context.Context) (err error) {
- x, err = NewEngine()
+// InitEngine initializes the xorm.Engine and sets it as db.DefaultContext
+func InitEngine(ctx context.Context) error {
+ xormEngine, err := newXORMEngine()
if err != nil {
- return fmt.Errorf("Failed to connect to database: %v", err)
+ return fmt.Errorf("failed to connect to database: %v", err)
}
- x.SetMapper(names.GonicMapper{})
+ xormEngine.SetMapper(names.GonicMapper{})
// WARNING: for serv command, MUST remove the output to os.stdout,
// so use log file to instead print to stdout.
- x.SetLogger(NewXORMLogger(setting.Database.LogSQL))
- x.ShowSQL(setting.Database.LogSQL)
- x.SetMaxOpenConns(setting.Database.MaxOpenConns)
- x.SetMaxIdleConns(setting.Database.MaxIdleConns)
- x.SetConnMaxLifetime(setting.Database.ConnMaxLifetime)
+ xormEngine.SetLogger(NewXORMLogger(setting.Database.LogSQL))
+ xormEngine.ShowSQL(setting.Database.LogSQL)
+ xormEngine.SetMaxOpenConns(setting.Database.MaxOpenConns)
+ xormEngine.SetMaxIdleConns(setting.Database.MaxIdleConns)
+ xormEngine.SetConnMaxLifetime(setting.Database.ConnMaxLifetime)
+ xormEngine.SetDefaultContext(ctx)
+
+ SetDefaultEngine(ctx, xormEngine)
+ return nil
+}
+// SetDefaultEngine sets the default engine for db
+func SetDefaultEngine(ctx context.Context, eng *xorm.Engine) {
+ x = eng
DefaultContext = &Context{
Context: ctx,
e: x,
}
- x.SetDefaultContext(ctx)
- return nil
}
-// SetEngine is used by unit test code
-func SetEngine(eng *xorm.Engine) {
- x = eng
- DefaultContext = &Context{
- Context: context.Background(),
- e: x,
+// UnsetDefaultEngine closes and unsets the default engine
+// We hope the SetDefaultEngine and UnsetDefaultEngine can be paired, but it's impossible now,
+// there are many calls to InitEngine -> SetDefaultEngine directly to overwrite the `x` and DefaultContext without close
+// Global database engine related functions are all racy and there is no graceful close right now.
+func UnsetDefaultEngine() {
+ if x != nil {
+ _ = x.Close()
+ x = nil
}
+ DefaultContext = nil
}
-// InitEngineWithMigration initializes a new xorm.Engine
+// InitEngineWithMigration initializes a new xorm.Engine and sets it as the db.DefaultContext
// This function must never call .Sync2() if the provided migration function fails.
// When called from the "doctor" command, the migration function is a version check
// that prevents the doctor from fixing anything in the database if the migration level
return beans, nil
}
-// Ping tests if database is alive
-func Ping() error {
- if x != nil {
- return x.Ping()
- }
- return errors.New("database not configured")
-}
-
// DumpDatabase dumps all data from database according the special database SQL syntax to file system.
func DumpDatabase(filePath, dbType string) error {
var tbs []*schemas.Table
_, err = x.Select("MAX(id)").Table(beanOrTableName).Get(&maxID)
return
}
-
-// FindByMaxID filled results as the condition from database
-func FindByMaxID(maxID int64, limit int, results interface{}) error {
- return x.Where("id <= ?", maxID).
- OrderBy("id DESC").
- Limit(limit).
- Find(results)
-}
--- /dev/null
+// 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
+}
package migrations
import (
+ "context"
"database/sql"
"fmt"
"os"
}
setting.SetCustomPathAndConf("", "", "")
- setting.NewContext()
+ setting.LoadForTest()
git.CheckLFSVersion()
setting.InitDBConfig()
setting.NewLogServices(true)
return err
}
-// newEngine sets the xorm.Engine
-func newEngine() (*xorm.Engine, error) {
- x, err := db.NewEngine()
- if err != nil {
- return x, fmt.Errorf("Failed to connect to database: %v", err)
+func newXORMEngine() (*xorm.Engine, error) {
+ if err := db.InitEngine(context.Background()); err != nil {
+ return nil, err
}
-
- x.SetMapper(names.GonicMapper{})
- // WARNING: for serv command, MUST remove the output to os.stdout,
- // so use log file to instead print to stdout.
- x.SetLogger(db.NewXORMLogger(setting.Database.LogSQL))
- x.ShowSQL(setting.Database.LogSQL)
- x.SetMaxOpenConns(setting.Database.MaxOpenConns)
- x.SetMaxIdleConns(setting.Database.MaxIdleConns)
- x.SetConnMaxLifetime(setting.Database.ConnMaxLifetime)
+ x := unittest.GetXORMEngine()
return x, nil
}
return nil, deferFn
}
- x, err := newEngine()
+ x, err := newXORMEngine()
assert.NoError(t, err)
if x != nil {
oldDefer := deferFn
func init() {
setting.SetCustomPathAndConf("", "", "")
- setting.NewContext()
+ setting.LoadForTest()
}
func Test_SSHParsePublicKey(t *testing.T) {
var fixtures *testfixtures.Loader
-func getXORMEngine(engine ...*xorm.Engine) (x *xorm.Engine) {
+// GetXORMEngine gets the XORM engine
+func GetXORMEngine(engine ...*xorm.Engine) (x *xorm.Engine) {
if len(engine) == 1 {
return engine[0]
}
// InitFixtures initialize test fixtures for a test database
func InitFixtures(opts FixturesOptions, engine ...*xorm.Engine) (err error) {
- e := getXORMEngine(engine...)
+ e := GetXORMEngine(engine...)
var testfiles func(*testfixtures.Loader) error
if opts.Dir != "" {
testfiles = testfixtures.Directory(opts.Dir)
// LoadFixtures load fixtures for a test database
func LoadFixtures(engine ...*xorm.Engine) error {
- e := getXORMEngine(engine...)
+ e := GetXORMEngine(engine...)
var err error
// Database transaction conflicts could occur and result in ROLLBACK
// As a simple workaround, we just retry 20 times.
package unittest
import (
+ "context"
"fmt"
"net/url"
"os"
return err
}
x.SetMapper(names.GonicMapper{})
- db.SetEngine(x)
+ db.SetDefaultEngine(context.Background(), x)
if err = db.SyncAllTables(); err != nil {
return err
}
func initDBDisableConsole(ctx context.Context, disableConsole bool) error {
- setting.NewContext()
+ setting.LoadFromExisting()
setting.InitDBConfig()
setting.NewXORMLogService(disableConsole)
return err
}
- setting.NewContext()
+ setting.LoadFromExisting()
configurationFiles := []configurationFile{
{"Configuration File Path", setting.CustomConf, false, true, false},
"code.gitea.io/gitea/modules/httplib"
"code.gitea.io/gitea/modules/json"
+ "code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
)
func newRequest(ctx context.Context, url, method string) *httplib.Request {
+ if setting.InternalToken == "" {
+ log.Fatal(`The INTERNAL_TOKEN setting is missing from the configuration file: %q.
+Ensure you are running in the correct environment or set the correct configuration file with -c.`, setting.CustomConf)
+ }
return httplib.NewRequest(url, method).
SetContext(ctx).
- Header("Authorization",
- fmt.Sprintf("Bearer %s", setting.InternalToken))
+ Header("Authorization", fmt.Sprintf("Bearer %s", setting.InternalToken))
}
// Response internal request response
})
if setting.Protocol == setting.UnixSocket {
req.SetTransport(&http.Transport{
- Dial: func(_, _ string) (net.Conn, error) {
- return net.Dial("unix", setting.HTTPAddr)
- },
DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
var d net.Dialer
return d.DialContext(ctx, "unix", setting.HTTPAddr)
--- /dev/null
+// 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
+}
--- /dev/null
+// 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
+}
}
}
-// NewContext initializes configuration context.
+// LoadFromExisting initializes setting options from an existing config file (app.ini)
+func LoadFromExisting() {
+ loadFromConf(false)
+}
+
+// LoadAllowEmpty initializes setting options, it's also fine that if the config file (app.ini) doesn't exist
+func LoadAllowEmpty() {
+ loadFromConf(true)
+}
+
+// LoadForTest initializes setting options for tests
+func LoadForTest() {
+ loadFromConf(true)
+ if err := PrepareAppDataPath(); err != nil {
+ log.Fatal("Can not prepare APP_DATA_PATH: %v", err)
+ }
+}
+
+// loadFromConf initializes configuration context.
// NOTE: do not print any log except error.
-func NewContext() {
+func loadFromConf(allowEmpty bool) {
Cfg = ini.Empty()
if WritePIDFile && len(PIDFile) > 0 {
if err := Cfg.Append(CustomConf); err != nil {
log.Fatal("Failed to load custom conf '%s': %v", CustomConf, err)
}
- } else {
- log.Warn("Custom config '%s' not found, ignore this if you're running first time", CustomConf)
- }
+ } else if !allowEmpty {
+ log.Fatal("Unable to find configuration file: %q.\nEnsure you are running in the correct environment or set the correct configuration file with -c.", CustomConf)
+ } // else: no config file, a config file might be created at CustomConf later (might not)
+
Cfg.NameMapper = ini.SnackCase
homeDir, err := com.HomeDir()
StaticRootPath = sec.Key("STATIC_ROOT_PATH").MustString(StaticRootPath)
StaticCacheTime = sec.Key("STATIC_CACHE_TIME").MustDuration(6 * time.Hour)
AppDataPath = sec.Key("APP_DATA_PATH").MustString(path.Join(AppWorkPath, "data"))
- if _, err = os.Stat(AppDataPath); err != nil {
- // 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.
- err = os.MkdirAll(AppDataPath, os.ModePerm)
- if err != nil {
- log.Fatal("Failed to create the directory for app data path '%s'", AppDataPath)
- }
- }
+
EnableGzip = sec.Key("ENABLE_GZIP").MustBool()
EnablePprof = sec.Key("ENABLE_PPROF").MustBool(false)
PprofDataPath = sec.Key("PPROF_DATA_PATH").MustString(path.Join(AppWorkPath, "data/tmp/pprof"))
SuccessfulTokensCacheSize = sec.Key("SUCCESSFUL_TOKENS_CACHE_SIZE").MustInt(20)
InternalToken = loadInternalToken(sec)
+ if InstallLock && InternalToken == "" {
+ // if Gitea has been installed but the InternalToken hasn't been generated (upgrade from an old release), we should generate
+ generateSaveInternalToken()
+ }
cfgdata := sec.Key("PASSWORD_COMPLEXITY").Strings(",")
if len(cfgdata) == 0 {
Langs = Cfg.Section("i18n").Key("LANGS").Strings(",")
if len(Langs) == 0 {
- Langs = []string{
- "en-US", "zh-CN", "zh-HK", "zh-TW", "de-DE", "fr-FR", "nl-NL", "lv-LV",
- "ru-RU", "uk-UA", "ja-JP", "es-ES", "pt-BR", "pt-PT", "pl-PL", "bg-BG",
- "it-IT", "fi-FI", "tr-TR", "cs-CZ", "sr-SP", "sv-SE", "ko-KR", "el-GR",
- "fa-IR", "hu-HU", "id-ID", "ml-IN"}
+ Langs = defaultI18nLangs()
}
Names = Cfg.Section("i18n").Key("NAMES").Strings(",")
if len(Names) == 0 {
- Names = []string{"English", "简体中文", "繁體中文（香港）", "繁體中文（台灣）", "Deutsch",
- "français", "Nederlands", "latviešu", "русский", "Українська", "日本語",
- "español", "português do Brasil", "Português de Portugal", "polski", "български",
- "italiano", "suomi", "Türkçe", "čeština", "српски", "svenska", "한국어", "ελληνικά",
- "فارسی", "magyar nyelv", "bahasa Indonesia", "മലയാളം"}
+ Names = defaultI18nNames()
}
ShowFooterBranding = Cfg.Section("other").Key("SHOW_FOOTER_BRANDING").MustBool(false)
func loadInternalToken(sec *ini.Section) string {
uri := sec.Key("INTERNAL_TOKEN_URI").String()
- if len(uri) == 0 {
- return loadOrGenerateInternalToken(sec)
+ if uri == "" {
+ return sec.Key("INTERNAL_TOKEN").String()
}
tempURI, err := url.Parse(uri)
if err != nil {
return ""
}
-func loadOrGenerateInternalToken(sec *ini.Section) string {
- var err error
- token := sec.Key("INTERNAL_TOKEN").String()
- if len(token) == 0 {
- token, err = generate.NewInternalToken()
- if err != nil {
- log.Fatal("Error generate internal token: %v", err)
- }
-
- // Save secret
- CreateOrAppendToCustomConf(func(cfg *ini.File) {
- cfg.Section("security").Key("INTERNAL_TOKEN").SetValue(token)
- })
+// generateSaveInternalToken generates and saves the internal token to app.ini
+func generateSaveInternalToken() {
+ token, err := generate.NewInternalToken()
+ if err != nil {
+ log.Fatal("Error generate internal token: %v", err)
}
- return token
+
+ InternalToken = token
+ CreateOrAppendToCustomConf(func(cfg *ini.File) {
+ cfg.Section("security").Key("INTERNAL_TOKEN").SetValue(token)
+ })
}
// MakeAbsoluteAssetURL returns the absolute asset url prefix without a trailing slash
callback(cfg)
+ log.Info("Settings saved to: %q", CustomConf)
+
if err := os.MkdirAll(filepath.Dir(CustomConf), os.ModePerm); err != nil {
log.Fatal("failed to create '%s': %v", CustomConf, err)
return
charset = Charset
path = Path
sqlite_helper = File path for the SQLite3 database.<br>Enter an absolute path if you run Gitea as a service.
+reinstall_error = You are trying to install into an existing Gitea database
+reinstall_confirm_message = Re-installing with an existing Gitea database can cause multiple problems. In most cases, you should use your existing "app.ini" to run Gitea. If you know what you are doing, confirm the following:
+reinstall_confirm_check_1 = The data encrypted by the SECRET_KEY in app.ini may be lost: users may not be able to log in with 2FA/OTP & mirrors may not function correctly. By checking this box you confirm that the current app.ini file contains the correct the SECRET_KEY.
+reinstall_confirm_check_2 = The repositories and settings may need to be re-synchronized. By checking this box you confirm that you will resynchronize the hooks for the repositories and authorized_keys file manually. You confirm that you will ensure that repository and mirror settings are correct.
+reinstall_confirm_check_3 = You confirm that you are absolutely sure that this Gitea is running with the correct app.ini location and that you are sure that you have have to re-install. You confirm that you acknowledge the above risks.
err_empty_db_path = The SQLite3 database path cannot be empty.
no_admin_and_disable_registration = You cannot disable user self-registration without creating an administrator account.
err_empty_admin_password = The administrator password cannot be empty.
test_git_failed = Could not test 'git' command: %v
sqlite3_not_available = This Gitea version does not support SQLite3. Please download the official binary version from %s (not the 'gobuild' version).
invalid_db_setting = The database settings are invalid: %v
+invalid_db_table = The database table '%s' is invalid: %v
invalid_repo_path = The repository root path is invalid: %v
+invalid_app_data_path = The app data path is invalid: %v
run_user_not_match = The 'run as' username is not the current username: %s -> %s
+internal_token_failed = Failed to generate internal token: %v
+secret_key_failed = Failed to generate secret key: %v
save_config_failed = Failed to save configuration: %v
invalid_admin_setting = Administrator account setting is invalid: %v
install_success = Welcome! Thank you for choosing Gitea. Have fun and take care!
return nil
}
-// GlobalInit is for global configuration reload-able.
-func GlobalInit(ctx context.Context) {
- setting.NewContext()
+// GlobalInitInstalled is for global installed configuration.
+func GlobalInitInstalled(ctx context.Context) {
if !setting.InstallLock {
log.Fatal("Gitea is not installed")
}
"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"
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() {
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
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
}
}
}
- 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()
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")
}
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)
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 {
// PreloadSettings preloads the configuration to check if we need to run install
func PreloadSettings(ctx context.Context) bool {
- setting.NewContext()
+ setting.LoadAllowEmpty()
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.LogRootPath)
log.Info("Configuration file: %s", setting.CustomConf)
- log.Info("Preparing to run install page")
+ log.Info("Prepare to run install page")
translation.InitLocales()
if setting.EnableSQLite3 {
- log.Info("SQLite3 Supported")
+ log.Info("SQLite3 is supported")
}
setting.InitDBConfig()
setting.NewServicesForInstall()
return !setting.InstallLock
}
-// ReloadSettings rereads the settings and starts up the database
-func ReloadSettings(ctx context.Context) {
- setting.NewContext()
+// reloadSettings reloads the existing settings and starts up the database
+func reloadSettings(ctx context.Context) {
+ setting.LoadFromExisting()
setting.InitDBConfig()
if setting.InstallLock {
if err := common.InitDBEngine(ctx); err == nil {
AdminPasswd string `binding:"OmitEmpty;MaxSize(255)" locale:"install.admin_password"`
AdminConfirmPasswd string
AdminEmail string `binding:"OmitEmpty;MinSize(3);MaxSize(254);Include(@)" locale:"install.admin_email"`
+
+ // ReinstallConfirmFirst we can not use 1/2/3 or A/B/C here, there is a framework bug, can not parse "reinstall_confirm_1" or "reinstall_confirm_a"
+ ReinstallConfirmFirst bool
+ ReinstallConfirmSecond bool
+ ReinstallConfirmThird bool
}
// Validate validates the fields
copy_error: '{{.i18n.Tr "copy_error"}}',
}
};
+ {{/* in case some pages don't render the pageData, we make sure it is an object to prevent null access */}}
+ window.config.pageData = window.config.pageData || {};
</script>
<link rel="icon" href="{{AssetUrlPrefix}}/img/logo.svg" type="image/svg+xml">
<link rel="alternate icon" href="{{AssetUrlPrefix}}/img/favicon.png" type="image/png">
</div>
</div>
+ {{if .Err_DbInstalledBefore}}
+ <div>
+ <p class="reinstall-message">{{.i18n.Tr "install.reinstall_confirm_message"}}</p>
+ <div class="reinstall-confirm">
+ <div class="ui checkbox">
+ <label>{{.i18n.Tr "install.reinstall_confirm_check_1"}}</label>
+ <input name="reinstall_confirm_first" type="checkbox">
+ </div>
+ </div>
+ <div class="reinstall-confirm">
+ <div class="ui checkbox">
+ <label>{{.i18n.Tr "install.reinstall_confirm_check_2"}}</label>
+ <input name="reinstall_confirm_second" type="checkbox">
+ </div>
+ </div>
+ <div class="reinstall-confirm">
+ <div class="ui checkbox">
+ <label>{{.i18n.Tr "install.reinstall_confirm_check_3"}}</label>
+ <input name="reinstall_confirm_third" type="checkbox">
+ </div>
+ </div>
+ </div>
+ {{end}}
+
<!-- General Settings -->
<h4 class="ui dividing header">{{.i18n.Tr "install.general_title"}}</h4>
<div class="inline required field {{if .Err_AppName}}error{{end}}">
form {
@input-padding: 320px !important;
- label {
+ .inline.field label {
text-align: right;
width: @input-padding;
}
margin-left: @input-padding+15px;
}
- &.optional .title {
- margin-left: 38%;
+ &.optional {
+ .title {
+ margin-left: 38%;
+ }
+ .checkbox {
+ margin-left: 40% !important;
+ label {
+ width: auto !important;
+ }
+ }
}
}
}
.ui {
- .checkbox {
- margin-left: 40% !important;
-
- label {
- width: auto !important;
- }
+ .reinstall-message {
+ width: 70%;
+ margin: 20px auto;
+ color: red;
+ text-align: left;
+ font-weight: bold;
+ }
+ .reinstall-confirm {
+ width: 70%;
+ text-align: left;
+ margin: 10px auto;
}
}
}
projects / gitea.git / commitdiff