install.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package routers
  5. import (
  6. "errors"
  7. "os"
  8. "os/exec"
  9. "path"
  10. "path/filepath"
  11. "strings"
  12. "github.com/Unknwon/com"
  13. "github.com/Unknwon/macaron"
  14. "github.com/go-xorm/xorm"
  15. "gopkg.in/ini.v1"
  16. "github.com/gogits/gogs/models"
  17. "github.com/gogits/gogs/models/cron"
  18. "github.com/gogits/gogs/modules/auth"
  19. "github.com/gogits/gogs/modules/base"
  20. "github.com/gogits/gogs/modules/log"
  21. "github.com/gogits/gogs/modules/mailer"
  22. "github.com/gogits/gogs/modules/middleware"
  23. "github.com/gogits/gogs/modules/setting"
  24. "github.com/gogits/gogs/modules/social"
  25. "github.com/gogits/gogs/modules/user"
  26. )
  27. const (
  28. INSTALL base.TplName = "install"
  29. )
  30. func checkRunMode() {
  31. switch setting.Cfg.Section("").Key("RUN_MODE").String() {
  32. case "prod":
  33. macaron.Env = macaron.PROD
  34. macaron.ColorLog = false
  35. setting.ProdMode = true
  36. }
  37. log.Info("Run Mode: %s", strings.Title(macaron.Env))
  38. }
  39. func NewServices() {
  40. setting.NewServices()
  41. social.NewOauthService()
  42. }
  43. // GlobalInit is for global configuration reload-able.
  44. func GlobalInit() {
  45. setting.NewConfigContext()
  46. log.Trace("Custom path: %s", setting.CustomPath)
  47. log.Trace("Log path: %s", setting.LogRootPath)
  48. mailer.NewMailerContext()
  49. models.LoadModelsConfig()
  50. NewServices()
  51. if setting.InstallLock {
  52. models.LoadRepoConfig()
  53. models.NewRepoContext()
  54. if err := models.NewEngine(); err != nil {
  55. log.Fatal(4, "Fail to initialize ORM engine: %v", err)
  56. }
  57. models.HasEngine = true
  58. cron.NewCronContext()
  59. models.InitDeliverHooks()
  60. log.NewGitLogger(path.Join(setting.LogRootPath, "http.log"))
  61. }
  62. if models.EnableSQLite3 {
  63. log.Info("SQLite3 Supported")
  64. }
  65. if models.EnableTidb {
  66. log.Info("TiDB Supported")
  67. }
  68. checkRunMode()
  69. }
  70. func InstallInit(ctx *middleware.Context) {
  71. if setting.InstallLock {
  72. ctx.Handle(404, "Install", errors.New("Installation is prohibited"))
  73. return
  74. }
  75. ctx.Data["Title"] = ctx.Tr("install.install")
  76. ctx.Data["PageIsInstall"] = true
  77. dbOpts := []string{"MySQL", "PostgreSQL"}
  78. if models.EnableSQLite3 {
  79. dbOpts = append(dbOpts, "SQLite3")
  80. }
  81. if models.EnableTidb {
  82. dbOpts = append(dbOpts, "TiDB")
  83. }
  84. ctx.Data["DbOptions"] = dbOpts
  85. }
  86. func Install(ctx *middleware.Context) {
  87. form := auth.InstallForm{}
  88. // Database settings
  89. form.DbHost = models.DbCfg.Host
  90. form.DbUser = models.DbCfg.User
  91. form.DbName = models.DbCfg.Name
  92. form.DbPath = models.DbCfg.Path
  93. ctx.Data["CurDbOption"] = "MySQL"
  94. switch models.DbCfg.Type {
  95. case "postgres":
  96. ctx.Data["CurDbOption"] = "PostgreSQL"
  97. case "sqlite3":
  98. if models.EnableSQLite3 {
  99. ctx.Data["CurDbOption"] = "SQLite3"
  100. }
  101. case "tidb":
  102. if models.EnableTidb {
  103. ctx.Data["CurDbOption"] = "TiDB"
  104. }
  105. }
  106. // Application general settings
  107. form.AppName = setting.AppName
  108. form.RepoRootPath = setting.RepoRootPath
  109. // Note(unknwon): it's hard for Windows users change a running user,
  110. // so just use current one if config says default.
  111. if setting.IsWindows && setting.RunUser == "git" {
  112. form.RunUser = user.CurrentUsername()
  113. } else {
  114. form.RunUser = setting.RunUser
  115. }
  116. form.Domain = setting.Domain
  117. form.SSHPort = setting.SSHPort
  118. form.HTTPPort = setting.HttpPort
  119. form.AppUrl = setting.AppUrl
  120. // E-mail service settings
  121. if setting.MailService != nil {
  122. form.SMTPHost = setting.MailService.Host
  123. form.SMTPFrom = setting.MailService.From
  124. form.SMTPEmail = setting.MailService.User
  125. }
  126. form.RegisterConfirm = setting.Service.RegisterEmailConfirm
  127. form.MailNotify = setting.Service.EnableNotifyMail
  128. // Server and other services settings
  129. form.OfflineMode = setting.OfflineMode
  130. form.DisableGravatar = setting.DisableGravatar
  131. form.DisableRegistration = setting.Service.DisableRegistration
  132. form.RequireSignInView = setting.Service.RequireSignInView
  133. auth.AssignForm(form, ctx.Data)
  134. ctx.HTML(200, INSTALL)
  135. }
  136. func InstallPost(ctx *middleware.Context, form auth.InstallForm) {
  137. ctx.Data["CurDbOption"] = form.DbType
  138. if ctx.HasError() {
  139. if ctx.HasValue("Err_SMTPEmail") {
  140. ctx.Data["Err_SMTP"] = true
  141. }
  142. if ctx.HasValue("Err_AdminName") ||
  143. ctx.HasValue("Err_AdminPasswd") ||
  144. ctx.HasValue("Err_AdminEmail") {
  145. ctx.Data["Err_Admin"] = true
  146. }
  147. ctx.HTML(200, INSTALL)
  148. return
  149. }
  150. if _, err := exec.LookPath("git"); err != nil {
  151. ctx.RenderWithErr(ctx.Tr("install.test_git_failed", err), INSTALL, &form)
  152. return
  153. }
  154. // Pass basic check, now test configuration.
  155. // Test database setting.
  156. dbTypes := map[string]string{"MySQL": "mysql", "PostgreSQL": "postgres", "SQLite3": "sqlite3", "TiDB": "tidb"}
  157. models.DbCfg.Type = dbTypes[form.DbType]
  158. models.DbCfg.Host = form.DbHost
  159. models.DbCfg.User = form.DbUser
  160. models.DbCfg.Passwd = form.DbPasswd
  161. models.DbCfg.Name = form.DbName
  162. models.DbCfg.SSLMode = form.SSLMode
  163. models.DbCfg.Path = form.DbPath
  164. if (models.DbCfg.Type == "sqlite3" || models.DbCfg.Type == "tidb") &&
  165. len(models.DbCfg.Path) == 0 {
  166. ctx.Data["Err_DbPath"] = true
  167. ctx.RenderWithErr(ctx.Tr("install.err_empty_db_path"), INSTALL, &form)
  168. return
  169. } else if models.DbCfg.Type == "tidb" &&
  170. strings.ContainsAny(path.Base(models.DbCfg.Path), ".-") {
  171. ctx.Data["Err_DbPath"] = true
  172. ctx.RenderWithErr(ctx.Tr("install.err_invalid_tidb_name"), INSTALL, &form)
  173. return
  174. }
  175. // Set test engine.
  176. var x *xorm.Engine
  177. if err := models.NewTestEngine(x); err != nil {
  178. if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
  179. ctx.Data["Err_DbType"] = true
  180. ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "http://gogs.io/docs/installation/install_from_binary.html"), INSTALL, &form)
  181. } else {
  182. ctx.Data["Err_DbSetting"] = true
  183. ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), INSTALL, &form)
  184. }
  185. return
  186. }
  187. // Test repository root path.
  188. if err := os.MkdirAll(form.RepoRootPath, os.ModePerm); err != nil {
  189. ctx.Data["Err_RepoRootPath"] = true
  190. ctx.RenderWithErr(ctx.Tr("install.invalid_repo_path", err), INSTALL, &form)
  191. return
  192. }
  193. // Check run user.
  194. curUser := user.CurrentUsername()
  195. if form.RunUser != curUser {
  196. ctx.Data["Err_RunUser"] = true
  197. ctx.RenderWithErr(ctx.Tr("install.run_user_not_match", form.RunUser, curUser), INSTALL, &form)
  198. return
  199. }
  200. // Check logic loophole between disable self-registration and no admin account.
  201. if form.DisableRegistration && len(form.AdminName) == 0 {
  202. ctx.Data["Err_Services"] = true
  203. ctx.Data["Err_Admin"] = true
  204. ctx.RenderWithErr(ctx.Tr("install.no_admin_and_disable_registration"), INSTALL, form)
  205. return
  206. }
  207. // Check admin password.
  208. if len(form.AdminName) > 0 && len(form.AdminPasswd) == 0 {
  209. ctx.Data["Err_Admin"] = true
  210. ctx.Data["Err_AdminPasswd"] = true
  211. ctx.RenderWithErr(ctx.Tr("install.err_empty_admin_password"), INSTALL, form)
  212. return
  213. }
  214. if form.AdminPasswd != form.AdminConfirmPasswd {
  215. ctx.Data["Err_Admin"] = true
  216. ctx.Data["Err_AdminPasswd"] = true
  217. ctx.RenderWithErr(ctx.Tr("form.password_not_match"), INSTALL, form)
  218. return
  219. }
  220. if form.AppUrl[len(form.AppUrl)-1] != '/' {
  221. form.AppUrl += "/"
  222. }
  223. // Save settings.
  224. cfg := ini.Empty()
  225. if com.IsFile(setting.CustomConf) {
  226. // Keeps custom settings if there is already something.
  227. if err := cfg.Append(setting.CustomConf); err != nil {
  228. log.Error(4, "Fail to load custom conf '%s': %v", setting.CustomConf, err)
  229. }
  230. }
  231. cfg.Section("database").Key("DB_TYPE").SetValue(models.DbCfg.Type)
  232. cfg.Section("database").Key("HOST").SetValue(models.DbCfg.Host)
  233. cfg.Section("database").Key("NAME").SetValue(models.DbCfg.Name)
  234. cfg.Section("database").Key("USER").SetValue(models.DbCfg.User)
  235. cfg.Section("database").Key("PASSWD").SetValue(models.DbCfg.Passwd)
  236. cfg.Section("database").Key("SSL_MODE").SetValue(models.DbCfg.SSLMode)
  237. cfg.Section("database").Key("PATH").SetValue(models.DbCfg.Path)
  238. cfg.Section("").Key("APP_NAME").SetValue(form.AppName)
  239. cfg.Section("repository").Key("ROOT").SetValue(form.RepoRootPath)
  240. cfg.Section("").Key("RUN_USER").SetValue(form.RunUser)
  241. cfg.Section("server").Key("DOMAIN").SetValue(form.Domain)
  242. cfg.Section("server").Key("HTTP_PORT").SetValue(form.HTTPPort)
  243. cfg.Section("server").Key("ROOT_URL").SetValue(form.AppUrl)
  244. if form.SSHPort == 0 {
  245. cfg.Section("server").Key("DISABLE_SSH").SetValue("true")
  246. } else {
  247. cfg.Section("server").Key("DISABLE_SSH").SetValue("false")
  248. cfg.Section("server").Key("SSH_PORT").SetValue(com.ToStr(form.SSHPort))
  249. }
  250. if len(strings.TrimSpace(form.SMTPHost)) > 0 {
  251. cfg.Section("mailer").Key("ENABLED").SetValue("true")
  252. cfg.Section("mailer").Key("HOST").SetValue(form.SMTPHost)
  253. cfg.Section("mailer").Key("FROM").SetValue(form.SMTPFrom)
  254. cfg.Section("mailer").Key("USER").SetValue(form.SMTPEmail)
  255. cfg.Section("mailer").Key("PASSWD").SetValue(form.SMTPPasswd)
  256. } else {
  257. cfg.Section("mailer").Key("ENABLED").SetValue("false")
  258. }
  259. cfg.Section("service").Key("REGISTER_EMAIL_CONFIRM").SetValue(com.ToStr(form.RegisterConfirm))
  260. cfg.Section("service").Key("ENABLE_NOTIFY_MAIL").SetValue(com.ToStr(form.MailNotify))
  261. cfg.Section("server").Key("OFFLINE_MODE").SetValue(com.ToStr(form.OfflineMode))
  262. cfg.Section("picture").Key("DISABLE_GRAVATAR").SetValue(com.ToStr(form.DisableGravatar))
  263. cfg.Section("service").Key("DISABLE_REGISTRATION").SetValue(com.ToStr(form.DisableRegistration))
  264. cfg.Section("service").Key("REQUIRE_SIGNIN_VIEW").SetValue(com.ToStr(form.RequireSignInView))
  265. cfg.Section("").Key("RUN_MODE").SetValue("prod")
  266. cfg.Section("session").Key("PROVIDER").SetValue("file")
  267. cfg.Section("log").Key("MODE").SetValue("file")
  268. cfg.Section("log").Key("LEVEL").SetValue("Info")
  269. cfg.Section("security").Key("INSTALL_LOCK").SetValue("true")
  270. cfg.Section("security").Key("SECRET_KEY").SetValue(base.GetRandomString(15))
  271. os.MkdirAll(filepath.Dir(setting.CustomConf), os.ModePerm)
  272. if err := cfg.SaveTo(setting.CustomConf); err != nil {
  273. ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), INSTALL, &form)
  274. return
  275. }
  276. GlobalInit()
  277. // Create admin account.
  278. if len(form.AdminName) > 0 {
  279. if err := models.CreateUser(&models.User{
  280. Name: form.AdminName,
  281. Email: form.AdminEmail,
  282. Passwd: form.AdminPasswd,
  283. IsAdmin: true,
  284. IsActive: true,
  285. }); err != nil {
  286. if !models.IsErrUserAlreadyExist(err) {
  287. setting.InstallLock = false
  288. ctx.Data["Err_AdminName"] = true
  289. ctx.Data["Err_AdminEmail"] = true
  290. ctx.RenderWithErr(ctx.Tr("install.invalid_admin_setting", err), INSTALL, &form)
  291. return
  292. }
  293. log.Info("Admin account already exist")
  294. }
  295. }
  296. log.Info("First-time run install finished!")
  297. ctx.Flash.Success(ctx.Tr("install.install_success"))
  298. ctx.Redirect(form.AppUrl + "user/login")
  299. }