forgejo/routers/install.go

387 lines
12 KiB
Go
Raw Normal View History

2014-03-25 08:51:42 +00:00
// Copyright 2014 The Gogs 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 routers
2014-03-28 11:26:22 +00:00
import (
"errors"
"os"
2014-04-08 19:27:35 +00:00
"os/exec"
2014-05-26 00:11:25 +00:00
"path"
"path/filepath"
"strings"
2014-07-26 04:24:27 +00:00
"github.com/Unknwon/com"
2014-04-18 13:35:09 +00:00
"github.com/go-xorm/xorm"
"gopkg.in/ini.v1"
2015-10-16 01:28:12 +00:00
"gopkg.in/macaron.v1"
2014-03-28 11:26:22 +00:00
2015-12-15 22:25:45 +00:00
"github.com/gogits/git-module"
2015-11-26 22:33:45 +00:00
2014-03-28 11:26:22 +00:00
"github.com/gogits/gogs/models"
2014-03-28 22:40:31 +00:00
"github.com/gogits/gogs/modules/auth"
2014-03-28 11:26:22 +00:00
"github.com/gogits/gogs/modules/base"
2016-03-11 16:56:52 +00:00
"github.com/gogits/gogs/modules/context"
"github.com/gogits/gogs/modules/cron"
"github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/mailer"
2016-02-20 22:10:05 +00:00
"github.com/gogits/gogs/modules/markdown"
2014-05-26 00:11:25 +00:00
"github.com/gogits/gogs/modules/setting"
"github.com/gogits/gogs/modules/ssh"
"github.com/gogits/gogs/modules/template/highlight"
"github.com/gogits/gogs/modules/user"
2014-03-28 11:26:22 +00:00
)
const (
INSTALL base.TplName = "install"
)
func checkRunMode() {
2014-12-31 10:37:29 +00:00
switch setting.Cfg.Section("").Key("RUN_MODE").String() {
case "prod":
2014-07-26 04:24:27 +00:00
macaron.Env = macaron.PROD
2015-07-15 18:47:51 +00:00
macaron.ColorLog = false
2014-05-26 00:11:25 +00:00
setting.ProdMode = true
2015-12-09 01:06:12 +00:00
default:
git.Debug = true
}
2014-07-26 04:24:27 +00:00
log.Info("Run Mode: %s", strings.Title(macaron.Env))
}
2014-04-13 22:12:07 +00:00
func NewServices() {
2014-05-26 00:11:25 +00:00
setting.NewServices()
mailer.NewContext()
2014-04-13 22:12:07 +00:00
}
// GlobalInit is for global configuration reload-able.
func GlobalInit() {
2015-09-17 03:08:46 +00:00
setting.NewContext()
highlight.NewContext()
2014-05-26 00:57:01 +00:00
log.Trace("Custom path: %s", setting.CustomPath)
2014-05-30 10:34:24 +00:00
log.Trace("Log path: %s", setting.LogRootPath)
2015-09-17 03:08:46 +00:00
models.LoadConfigs()
2014-04-20 02:13:22 +00:00
NewServices()
2014-03-30 14:47:08 +00:00
2014-05-26 00:11:25 +00:00
if setting.InstallLock {
models.LoadRepoConfig()
models.NewRepoContext()
2014-03-30 14:47:08 +00:00
if err := models.NewEngine(); err != nil {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Fail to initialize ORM engine: %v", err)
2014-03-30 14:47:08 +00:00
}
models.HasEngine = true
2015-09-17 03:08:46 +00:00
cron.NewContext()
2015-07-25 13:32:04 +00:00
models.InitDeliverHooks()
models.InitTestPullRequests()
2014-06-20 05:14:54 +00:00
log.NewGitLogger(path.Join(setting.LogRootPath, "http.log"))
}
2014-05-30 23:19:30 +00:00
if models.EnableSQLite3 {
2015-08-02 04:36:35 +00:00
log.Info("SQLite3 Supported")
2014-05-30 23:19:30 +00:00
}
if models.EnableTidb {
log.Info("TiDB Supported")
}
2015-12-18 10:49:28 +00:00
if setting.SupportMiniWinService {
log.Info("Builtin Windows Service Supported")
}
checkRunMode()
if setting.SSH.StartBuiltinServer {
ssh.Listen(setting.SSH.ListenPort)
log.Info("SSH server started on :%v", setting.SSH.ListenPort)
}
2016-01-27 20:48:57 +00:00
// Build Sanitizer
2016-02-20 22:10:05 +00:00
markdown.BuildSanitizer()
}
2016-03-11 16:56:52 +00:00
func InstallInit(ctx *context.Context) {
2014-05-26 00:11:25 +00:00
if setting.InstallLock {
ctx.Handle(404, "Install", errors.New("Installation is prohibited"))
2014-03-28 11:26:22 +00:00
return
}
2014-03-25 08:51:42 +00:00
ctx.Data["Title"] = ctx.Tr("install.install")
2014-03-28 11:26:22 +00:00
ctx.Data["PageIsInstall"] = true
dbOpts := []string{"MySQL", "PostgreSQL"}
if models.EnableSQLite3 {
dbOpts = append(dbOpts, "SQLite3")
}
if models.EnableTidb {
dbOpts = append(dbOpts, "TiDB")
}
ctx.Data["DbOptions"] = dbOpts
}
2016-03-11 16:56:52 +00:00
func Install(ctx *context.Context) {
form := auth.InstallForm{}
2015-07-09 05:17:48 +00:00
// Database settings
form.DbHost = models.DbCfg.Host
form.DbUser = models.DbCfg.User
form.DbName = models.DbCfg.Name
form.DbPath = models.DbCfg.Path
2015-09-12 01:00:12 +00:00
ctx.Data["CurDbOption"] = "MySQL"
switch models.DbCfg.Type {
case "postgres":
ctx.Data["CurDbOption"] = "PostgreSQL"
case "sqlite3":
if models.EnableSQLite3 {
2015-09-12 19:31:36 +00:00
ctx.Data["CurDbOption"] = "SQLite3"
}
case "tidb":
if models.EnableTidb {
ctx.Data["CurDbOption"] = "TiDB"
2015-09-12 01:00:12 +00:00
}
2015-07-09 05:17:48 +00:00
}
// Application general settings
form.AppName = setting.AppName
form.RepoRootPath = setting.RepoRootPath
// Note(unknwon): it's hard for Windows users change a running user,
// so just use current one if config says default.
if setting.IsWindows && setting.RunUser == "git" {
form.RunUser = user.CurrentUsername()
} else {
form.RunUser = setting.RunUser
2014-04-10 18:37:43 +00:00
}
form.Domain = setting.Domain
form.SSHPort = setting.SSH.Port
form.HTTPPort = setting.HttpPort
form.AppUrl = setting.AppUrl
2016-02-12 14:19:45 +00:00
form.LogRootPath = setting.LogRootPath
2015-07-09 05:17:48 +00:00
// E-mail service settings
if setting.MailService != nil {
form.SMTPHost = setting.MailService.Host
2015-07-09 08:10:31 +00:00
form.SMTPFrom = setting.MailService.From
2015-07-09 05:17:48 +00:00
form.SMTPEmail = setting.MailService.User
2014-04-27 04:34:48 +00:00
}
2015-07-09 05:17:48 +00:00
form.RegisterConfirm = setting.Service.RegisterEmailConfirm
form.MailNotify = setting.Service.EnableNotifyMail
// Server and other services settings
form.OfflineMode = setting.OfflineMode
form.DisableGravatar = setting.DisableGravatar
Add support for federated avatars (#3320) * Add support for federated avatars Fixes #3105 Removes avatar fetching duplication code Adds an "Enable Federated Avatar" checkbox in user settings (defaults to unchecked) Moves avatar settings all in the same form, making local and remote avatars mutually exclusive Renames UploadAvatarForm to AvatarForm as it's not anymore only for uploading * Run gofmt on all modified files * Move Avatar form in its own page * Add go-libravatar dependency to vendor/ dir Hopefully helps with accepting the contribution. See also #3214 * Revert "Add go-libravatar dependency to vendor/ dir" This reverts commit a8cb93ae640bbb90f7d25012fc257bda9fae9b82. * Make federated avatar setting a global configuration Removes the per-user setting * Move avatar handling back to base tool, disable federated avatar in offline mode * Format, handle error * Properly set fallback host * Use unsupported github.com mirror for importing go-libravatar * Remove comment showing life exists outside of github.com ... pity, but contribution would not be accepted otherwise * Use Combo for Get and Post methods over /avatar * FEDERATED_AVATAR -> ENABLE_FEDERATED_AVATAR * Fix persistance of federated avatar lookup checkbox at install time * Federated Avatars -> Enable Federated Avatars * Use len(string) == 0 instead of string == "" * Move import line where it belong See https://github.com/Unknwon/go-code-convention/blob/master/en-US/import_packages.md Pity the import url is still the unofficial one, but oh well... * Save a line (and waste much more expensive time) * Remove redundant parens * Remove an empty line * Remove empty lines * Reorder lines to make diff smaller * Remove another newline Unknwon review got me start a fight against newlines * Move DISABLE_GRAVATAR and ENABLE_FEDERATED_AVATAR after OFFLINE_MODE On re-reading the diff I figured what Unknwon meant here: https://github.com/gogits/gogs/pull/3320/files#r73741106 * Remove newlines that weren't there before my intervention
2016-08-07 17:27:38 +00:00
form.EnableFederatedAvatar = setting.EnableFederatedAvatar
2015-07-09 05:17:48 +00:00
form.DisableRegistration = setting.Service.DisableRegistration
2015-09-13 16:14:32 +00:00
form.EnableCaptcha = setting.Service.EnableCaptcha
2015-07-09 05:17:48 +00:00
form.RequireSignInView = setting.Service.RequireSignInView
2014-04-27 04:34:48 +00:00
2014-04-10 18:37:43 +00:00
auth.AssignForm(form, ctx.Data)
ctx.HTML(200, INSTALL)
2014-04-10 18:37:43 +00:00
}
2016-03-11 16:56:52 +00:00
func InstallPost(ctx *context.Context, form auth.InstallForm) {
ctx.Data["CurDbOption"] = form.DbType
2014-04-27 04:34:48 +00:00
if ctx.HasError() {
2015-07-08 11:47:56 +00:00
if ctx.HasValue("Err_SMTPEmail") {
ctx.Data["Err_SMTP"] = true
}
if ctx.HasValue("Err_AdminName") ||
ctx.HasValue("Err_AdminPasswd") ||
ctx.HasValue("Err_AdminEmail") {
ctx.Data["Err_Admin"] = true
}
ctx.HTML(200, INSTALL)
return
}
2014-04-08 19:27:35 +00:00
if _, err := exec.LookPath("git"); err != nil {
ctx.RenderWithErr(ctx.Tr("install.test_git_failed", err), INSTALL, &form)
2014-04-08 19:27:35 +00:00
return
}
// Pass basic check, now test configuration.
// Test database setting.
dbTypes := map[string]string{"MySQL": "mysql", "PostgreSQL": "postgres", "SQLite3": "sqlite3", "TiDB": "tidb"}
models.DbCfg.Type = dbTypes[form.DbType]
models.DbCfg.Host = form.DbHost
models.DbCfg.User = form.DbUser
models.DbCfg.Passwd = form.DbPasswd
models.DbCfg.Name = form.DbName
models.DbCfg.SSLMode = form.SSLMode
models.DbCfg.Path = form.DbPath
2015-09-12 19:31:36 +00:00
if (models.DbCfg.Type == "sqlite3" || models.DbCfg.Type == "tidb") &&
len(models.DbCfg.Path) == 0 {
ctx.Data["Err_DbPath"] = true
ctx.RenderWithErr(ctx.Tr("install.err_empty_db_path"), INSTALL, &form)
return
} else if models.DbCfg.Type == "tidb" &&
strings.ContainsAny(path.Base(models.DbCfg.Path), ".-") {
2015-07-08 11:47:56 +00:00
ctx.Data["Err_DbPath"] = true
2015-09-12 19:31:36 +00:00
ctx.RenderWithErr(ctx.Tr("install.err_invalid_tidb_name"), INSTALL, &form)
2015-07-08 11:47:56 +00:00
return
}
2014-03-30 15:09:59 +00:00
// Set test engine.
2014-03-30 14:47:08 +00:00
var x *xorm.Engine
if err := models.NewTestEngine(x); err != nil {
2014-03-30 15:09:59 +00:00
if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
2015-07-08 11:47:56 +00:00
ctx.Data["Err_DbType"] = true
ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "https://gogs.io/docs/installation/install_from_binary.html"), INSTALL, &form)
2014-03-30 13:39:44 +00:00
} else {
2015-07-08 11:47:56 +00:00
ctx.Data["Err_DbSetting"] = true
ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), INSTALL, &form)
2014-03-30 13:39:44 +00:00
}
return
}
// Test repository root path.
form.RepoRootPath = strings.Replace(form.RepoRootPath, "\\", "/", -1)
if err := os.MkdirAll(form.RepoRootPath, os.ModePerm); err != nil {
2014-09-14 23:22:52 +00:00
ctx.Data["Err_RepoRootPath"] = true
ctx.RenderWithErr(ctx.Tr("install.invalid_repo_path", err), INSTALL, &form)
return
}
2016-02-12 14:19:45 +00:00
// Test log root path.
form.LogRootPath = strings.Replace(form.LogRootPath, "\\", "/", -1)
if err := os.MkdirAll(form.LogRootPath, os.ModePerm); err != nil {
ctx.Data["Err_LogRootPath"] = true
ctx.RenderWithErr(ctx.Tr("install.invalid_log_root_path", err), INSTALL, &form)
return
}
2014-03-30 15:58:21 +00:00
// Check run user.
curUser := user.CurrentUsername()
2014-03-30 15:58:21 +00:00
if form.RunUser != curUser {
2014-09-14 23:22:52 +00:00
ctx.Data["Err_RunUser"] = true
ctx.RenderWithErr(ctx.Tr("install.run_user_not_match", form.RunUser, curUser), INSTALL, &form)
return
}
2015-09-12 19:31:36 +00:00
// Check logic loophole between disable self-registration and no admin account.
if form.DisableRegistration && len(form.AdminName) == 0 {
ctx.Data["Err_Services"] = true
ctx.Data["Err_Admin"] = true
ctx.RenderWithErr(ctx.Tr("install.no_admin_and_disable_registration"), INSTALL, form)
return
}
// Check admin password.
2015-09-12 19:31:36 +00:00
if len(form.AdminName) > 0 && len(form.AdminPasswd) == 0 {
ctx.Data["Err_Admin"] = true
ctx.Data["Err_AdminPasswd"] = true
ctx.RenderWithErr(ctx.Tr("install.err_empty_admin_password"), INSTALL, form)
return
}
if form.AdminPasswd != form.AdminConfirmPasswd {
2015-08-02 04:36:35 +00:00
ctx.Data["Err_Admin"] = true
2014-09-14 23:22:52 +00:00
ctx.Data["Err_AdminPasswd"] = true
ctx.RenderWithErr(ctx.Tr("form.password_not_match"), INSTALL, form)
2014-03-30 15:58:21 +00:00
return
}
if form.AppUrl[len(form.AppUrl)-1] != '/' {
form.AppUrl += "/"
}
// Save settings.
cfg := ini.Empty()
if com.IsFile(setting.CustomConf) {
// Keeps custom settings if there is already something.
if err := cfg.Append(setting.CustomConf); err != nil {
log.Error(4, "Fail to load custom conf '%s': %v", setting.CustomConf, err)
}
}
cfg.Section("database").Key("DB_TYPE").SetValue(models.DbCfg.Type)
cfg.Section("database").Key("HOST").SetValue(models.DbCfg.Host)
cfg.Section("database").Key("NAME").SetValue(models.DbCfg.Name)
cfg.Section("database").Key("USER").SetValue(models.DbCfg.User)
cfg.Section("database").Key("PASSWD").SetValue(models.DbCfg.Passwd)
cfg.Section("database").Key("SSL_MODE").SetValue(models.DbCfg.SSLMode)
cfg.Section("database").Key("PATH").SetValue(models.DbCfg.Path)
2015-07-09 05:17:48 +00:00
cfg.Section("").Key("APP_NAME").SetValue(form.AppName)
cfg.Section("repository").Key("ROOT").SetValue(form.RepoRootPath)
cfg.Section("").Key("RUN_USER").SetValue(form.RunUser)
cfg.Section("server").Key("DOMAIN").SetValue(form.Domain)
cfg.Section("server").Key("HTTP_PORT").SetValue(form.HTTPPort)
cfg.Section("server").Key("ROOT_URL").SetValue(form.AppUrl)
if form.SSHPort == 0 {
cfg.Section("server").Key("DISABLE_SSH").SetValue("true")
} else {
cfg.Section("server").Key("DISABLE_SSH").SetValue("false")
cfg.Section("server").Key("SSH_PORT").SetValue(com.ToStr(form.SSHPort))
}
if len(strings.TrimSpace(form.SMTPHost)) > 0 {
cfg.Section("mailer").Key("ENABLED").SetValue("true")
cfg.Section("mailer").Key("HOST").SetValue(form.SMTPHost)
2015-07-09 08:10:31 +00:00
cfg.Section("mailer").Key("FROM").SetValue(form.SMTPFrom)
cfg.Section("mailer").Key("USER").SetValue(form.SMTPEmail)
cfg.Section("mailer").Key("PASSWD").SetValue(form.SMTPPasswd)
2015-07-09 05:17:48 +00:00
} else {
cfg.Section("mailer").Key("ENABLED").SetValue("false")
}
2015-07-09 05:17:48 +00:00
cfg.Section("service").Key("REGISTER_EMAIL_CONFIRM").SetValue(com.ToStr(form.RegisterConfirm))
cfg.Section("service").Key("ENABLE_NOTIFY_MAIL").SetValue(com.ToStr(form.MailNotify))
cfg.Section("server").Key("OFFLINE_MODE").SetValue(com.ToStr(form.OfflineMode))
cfg.Section("picture").Key("DISABLE_GRAVATAR").SetValue(com.ToStr(form.DisableGravatar))
Add support for federated avatars (#3320) * Add support for federated avatars Fixes #3105 Removes avatar fetching duplication code Adds an "Enable Federated Avatar" checkbox in user settings (defaults to unchecked) Moves avatar settings all in the same form, making local and remote avatars mutually exclusive Renames UploadAvatarForm to AvatarForm as it's not anymore only for uploading * Run gofmt on all modified files * Move Avatar form in its own page * Add go-libravatar dependency to vendor/ dir Hopefully helps with accepting the contribution. See also #3214 * Revert "Add go-libravatar dependency to vendor/ dir" This reverts commit a8cb93ae640bbb90f7d25012fc257bda9fae9b82. * Make federated avatar setting a global configuration Removes the per-user setting * Move avatar handling back to base tool, disable federated avatar in offline mode * Format, handle error * Properly set fallback host * Use unsupported github.com mirror for importing go-libravatar * Remove comment showing life exists outside of github.com ... pity, but contribution would not be accepted otherwise * Use Combo for Get and Post methods over /avatar * FEDERATED_AVATAR -> ENABLE_FEDERATED_AVATAR * Fix persistance of federated avatar lookup checkbox at install time * Federated Avatars -> Enable Federated Avatars * Use len(string) == 0 instead of string == "" * Move import line where it belong See https://github.com/Unknwon/go-code-convention/blob/master/en-US/import_packages.md Pity the import url is still the unofficial one, but oh well... * Save a line (and waste much more expensive time) * Remove redundant parens * Remove an empty line * Remove empty lines * Reorder lines to make diff smaller * Remove another newline Unknwon review got me start a fight against newlines * Move DISABLE_GRAVATAR and ENABLE_FEDERATED_AVATAR after OFFLINE_MODE On re-reading the diff I figured what Unknwon meant here: https://github.com/gogits/gogs/pull/3320/files#r73741106 * Remove newlines that weren't there before my intervention
2016-08-07 17:27:38 +00:00
cfg.Section("picture").Key("ENABLE_FEDERATED_AVATAR").SetValue(com.ToStr(form.EnableFederatedAvatar))
2015-07-09 05:17:48 +00:00
cfg.Section("service").Key("DISABLE_REGISTRATION").SetValue(com.ToStr(form.DisableRegistration))
2015-09-13 16:14:32 +00:00
cfg.Section("service").Key("ENABLE_CAPTCHA").SetValue(com.ToStr(form.EnableCaptcha))
2015-07-09 05:17:48 +00:00
cfg.Section("service").Key("REQUIRE_SIGNIN_VIEW").SetValue(com.ToStr(form.RequireSignInView))
cfg.Section("").Key("RUN_MODE").SetValue("prod")
2014-03-30 15:58:21 +00:00
cfg.Section("session").Key("PROVIDER").SetValue("file")
2014-12-21 03:51:16 +00:00
cfg.Section("log").Key("MODE").SetValue("file")
cfg.Section("log").Key("LEVEL").SetValue("Info")
2016-02-12 14:19:45 +00:00
cfg.Section("log").Key("ROOT_PATH").SetValue(form.LogRootPath)
2014-08-27 08:39:36 +00:00
cfg.Section("security").Key("INSTALL_LOCK").SetValue("true")
cfg.Section("security").Key("SECRET_KEY").SetValue(base.GetRandomString(15))
os.MkdirAll(filepath.Dir(setting.CustomConf), os.ModePerm)
if err := cfg.SaveTo(setting.CustomConf); err != nil {
ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), INSTALL, &form)
return
}
GlobalInit()
// Create admin account
2015-07-08 11:47:56 +00:00
if len(form.AdminName) > 0 {
u := &models.User{
2015-07-08 11:47:56 +00:00
Name: form.AdminName,
Email: form.AdminEmail,
Passwd: form.AdminPasswd,
IsAdmin: true,
IsActive: true,
}
if err := models.CreateUser(u); err != nil {
2015-07-08 11:47:56 +00:00
if !models.IsErrUserAlreadyExist(err) {
setting.InstallLock = false
ctx.Data["Err_AdminName"] = true
ctx.Data["Err_AdminEmail"] = true
ctx.RenderWithErr(ctx.Tr("install.invalid_admin_setting", err), INSTALL, &form)
return
}
log.Info("Admin account already exist")
u, _ = models.GetUserByName(u.Name)
2014-03-30 15:09:59 +00:00
}
// Auto-login for admin
2016-07-23 17:08:22 +00:00
ctx.Session.Set("uid", u.ID)
ctx.Session.Set("uname", u.Name)
2014-03-30 15:09:59 +00:00
}
log.Info("First-time run install finished!")
ctx.Flash.Success(ctx.Tr("install.install_success"))
ctx.Redirect(form.AppUrl + "user/login")
2014-03-25 08:51:42 +00:00
}