setting.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905
  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 setting
  5. import (
  6. "net/mail"
  7. "net/url"
  8. "os"
  9. "os/exec"
  10. "path"
  11. "path/filepath"
  12. "runtime"
  13. "strconv"
  14. "strings"
  15. "time"
  16. "github.com/Unknwon/com"
  17. _ "github.com/go-macaron/cache/memcache"
  18. _ "github.com/go-macaron/cache/redis"
  19. "github.com/go-macaron/session"
  20. _ "github.com/go-macaron/session/redis"
  21. "github.com/mcuadros/go-version"
  22. log "gopkg.in/clog.v1"
  23. "gopkg.in/ini.v1"
  24. "github.com/gogits/go-libravatar"
  25. "github.com/G-Node/gogs/pkg/bindata"
  26. "github.com/G-Node/gogs/pkg/process"
  27. "github.com/G-Node/gogs/pkg/user"
  28. )
  29. type Scheme string
  30. const (
  31. SCHEME_HTTP Scheme = "http"
  32. SCHEME_HTTPS Scheme = "https"
  33. SCHEME_FCGI Scheme = "fcgi"
  34. SCHEME_UNIX_SOCKET Scheme = "unix"
  35. )
  36. type LandingPage string
  37. const (
  38. LANDING_PAGE_HOME LandingPage = "/"
  39. LANDING_PAGE_EXPLORE LandingPage = "/explore"
  40. )
  41. var (
  42. // Build information should only be set by -ldflags.
  43. BuildTime string
  44. BuildGitHash string
  45. // App settings
  46. AppVer string
  47. AppName string
  48. AppURL string
  49. AppSubURL string
  50. AppSubURLDepth int // Number of slashes
  51. AppPath string
  52. AppDataPath string
  53. // Server settings
  54. Protocol Scheme
  55. Domain string
  56. HTTPAddr string
  57. HTTPPort string
  58. LocalURL string
  59. OfflineMode bool
  60. DisableRouterLog bool
  61. CertFile, KeyFile string
  62. TLSMinVersion string
  63. StaticRootPath string
  64. EnableGzip bool
  65. LandingPageURL LandingPage
  66. UnixSocketPermission uint32
  67. HTTP struct {
  68. AccessControlAllowOrigin string
  69. }
  70. SSH struct {
  71. Disabled bool `ini:"DISABLE_SSH"`
  72. StartBuiltinServer bool `ini:"START_SSH_SERVER"`
  73. Domain string `ini:"SSH_DOMAIN"`
  74. Port int `ini:"SSH_PORT"`
  75. ListenHost string `ini:"SSH_LISTEN_HOST"`
  76. ListenPort int `ini:"SSH_LISTEN_PORT"`
  77. RootPath string `ini:"SSH_ROOT_PATH"`
  78. ServerCiphers []string `ini:"SSH_SERVER_CIPHERS"`
  79. KeyTestPath string `ini:"SSH_KEY_TEST_PATH"`
  80. KeygenPath string `ini:"SSH_KEYGEN_PATH"`
  81. MinimumKeySizeCheck bool `ini:"MINIMUM_KEY_SIZE_CHECK"`
  82. MinimumKeySizes map[string]int `ini:"-"`
  83. }
  84. // Security settings
  85. InstallLock bool
  86. SecretKey string
  87. LoginRememberDays int
  88. CookieUserName string
  89. CookieRememberName string
  90. CookieSecure bool
  91. ReverseProxyAuthUser string
  92. EnableLoginStatusCookie bool
  93. LoginStatusCookieName string
  94. // Database settings
  95. UseSQLite3 bool
  96. UseMySQL bool
  97. UsePostgreSQL bool
  98. UseMSSQL bool
  99. // Repository settings
  100. Repository struct {
  101. AnsiCharset string
  102. ForcePrivate bool
  103. MaxCreationLimit int
  104. MirrorQueueLength int
  105. PullRequestQueueLength int
  106. PreferredLicenses []string
  107. DisableHTTPGit bool `ini:"DISABLE_HTTP_GIT"`
  108. EnableLocalPathMigration bool
  109. CommitsFetchConcurrency int
  110. EnableRawFileRenderMode bool
  111. RawCaptchaMinFileSize int64
  112. CaptchaMinFileSize int64
  113. // Repository editor settings
  114. Editor struct {
  115. LineWrapExtensions []string
  116. PreviewableFileModes []string
  117. } `ini:"-"`
  118. // Repository upload settings
  119. Upload struct {
  120. Enabled bool
  121. TempPath string
  122. AllowedTypes []string `delim:"|"`
  123. FileMaxSize int64
  124. AnexFileMinSize int64
  125. MaxFiles int
  126. } `ini:"-"`
  127. }
  128. RepoRootPath string
  129. ScriptType string
  130. // Webhook settings
  131. Webhook struct {
  132. Types []string
  133. QueueLength int
  134. DeliverTimeout int
  135. SkipTLSVerify bool `ini:"SKIP_TLS_VERIFY"`
  136. PagingNum int
  137. }
  138. // Release settigns
  139. Release struct {
  140. Attachment struct {
  141. Enabled bool
  142. TempPath string
  143. AllowedTypes []string `delim:"|"`
  144. MaxSize int64
  145. MaxFiles int
  146. } `ini:"-"`
  147. }
  148. // Markdown sttings
  149. Markdown struct {
  150. EnableHardLineBreak bool
  151. CustomURLSchemes []string `ini:"CUSTOM_URL_SCHEMES"`
  152. FileExtensions []string
  153. }
  154. // Smartypants settings
  155. Smartypants struct {
  156. Enabled bool
  157. Fractions bool
  158. Dashes bool
  159. LatexDashes bool
  160. AngledQuotes bool
  161. }
  162. // Admin settings
  163. Admin struct {
  164. DisableRegularOrgCreation bool
  165. }
  166. // Picture settings
  167. AvatarUploadPath string
  168. GravatarSource string
  169. DisableGravatar bool
  170. EnableFederatedAvatar bool
  171. LibravatarService *libravatar.Libravatar
  172. // Log settings
  173. LogRootPath string
  174. LogModes []string
  175. LogConfigs []interface{}
  176. // Attachment settings
  177. AttachmentPath string
  178. AttachmentAllowedTypes string
  179. AttachmentMaxSize int64
  180. AttachmentMaxFiles int
  181. AttachmentEnabled bool
  182. // Time settings
  183. TimeFormat string
  184. // Cache settings
  185. CacheAdapter string
  186. CacheInterval int
  187. CacheConn string
  188. // Session settings
  189. SessionConfig session.Options
  190. CSRFCookieName string
  191. // Cron tasks
  192. Cron struct {
  193. UpdateMirror struct {
  194. Enabled bool
  195. RunAtStart bool
  196. Schedule string
  197. } `ini:"cron.update_mirrors"`
  198. RepoHealthCheck struct {
  199. Enabled bool
  200. RunAtStart bool
  201. Schedule string
  202. Timeout time.Duration
  203. Args []string `delim:" "`
  204. } `ini:"cron.repo_health_check"`
  205. CheckRepoStats struct {
  206. Enabled bool
  207. RunAtStart bool
  208. Schedule string
  209. } `ini:"cron.check_repo_stats"`
  210. RepoArchiveCleanup struct {
  211. Enabled bool
  212. RunAtStart bool
  213. Schedule string
  214. OlderThan time.Duration
  215. } `ini:"cron.repo_archive_cleanup"`
  216. }
  217. // Git settings
  218. Git struct {
  219. Version string `ini:"-"`
  220. DisableDiffHighlight bool
  221. MaxGitDiffLines int
  222. MaxGitDiffLineCharacters int
  223. MaxGitDiffFiles int
  224. GCArgs []string `delim:" "`
  225. Timeout struct {
  226. Migrate int
  227. Mirror int
  228. Clone int
  229. Pull int
  230. GC int `ini:"GC"`
  231. } `ini:"git.timeout"`
  232. }
  233. // Mirror settings
  234. Mirror struct {
  235. DefaultInterval int
  236. }
  237. // API settings
  238. API struct {
  239. MaxResponseItems int
  240. }
  241. // UI settings
  242. UI struct {
  243. ExplorePagingNum int
  244. IssuePagingNum int
  245. FeedMaxCommitNum int
  246. ThemeColorMetaTag string
  247. MaxDisplayFileSize int64
  248. Admin struct {
  249. UserPagingNum int
  250. RepoPagingNum int
  251. NoticePagingNum int
  252. OrgPagingNum int
  253. } `ini:"ui.admin"`
  254. User struct {
  255. RepoPagingNum int
  256. NewsFeedPagingNum int
  257. CommitsPagingNum int
  258. } `ini:"ui.user"`
  259. }
  260. // I18n settings
  261. Langs []string
  262. Names []string
  263. dateLangs map[string]string
  264. // Highlight settings are loaded in modules/template/hightlight.go
  265. // Other settings
  266. ShowFooterBranding bool
  267. ShowFooterVersion bool
  268. ShowFooterTemplateLoadTime bool
  269. SupportMiniWinService bool
  270. // Global setting objects
  271. Cfg *ini.File
  272. CustomPath string // Custom directory path
  273. CustomConf string
  274. ProdMode bool
  275. RunUser string
  276. IsWindows bool
  277. HasRobotsTxt bool
  278. )
  279. // DateLang transforms standard language locale name to corresponding value in datetime plugin.
  280. func DateLang(lang string) string {
  281. name, ok := dateLangs[lang]
  282. if ok {
  283. return name
  284. }
  285. return "en"
  286. }
  287. // execPath returns the executable path.
  288. func execPath() (string, error) {
  289. file, err := exec.LookPath(os.Args[0])
  290. if err != nil {
  291. return "", err
  292. }
  293. return filepath.Abs(file)
  294. }
  295. func init() {
  296. IsWindows = runtime.GOOS == "windows"
  297. log.New(log.CONSOLE, log.ConsoleConfig{})
  298. var err error
  299. if AppPath, err = execPath(); err != nil {
  300. log.Fatal(2, "Fail to get app path: %v\n", err)
  301. }
  302. // Note: we don't use path.Dir here because it does not handle case
  303. // which path starts with two "/" in Windows: "//psf/Home/..."
  304. AppPath = strings.Replace(AppPath, "\\", "/", -1)
  305. }
  306. // WorkDir returns absolute path of work directory.
  307. func WorkDir() (string, error) {
  308. wd := os.Getenv("GOGS_WORK_DIR")
  309. if len(wd) > 0 {
  310. return wd, nil
  311. }
  312. i := strings.LastIndex(AppPath, "/")
  313. if i == -1 {
  314. return AppPath, nil
  315. }
  316. return AppPath[:i], nil
  317. }
  318. func forcePathSeparator(path string) {
  319. if strings.Contains(path, "\\") {
  320. log.Fatal(2, "Do not use '\\' or '\\\\' in paths, instead, please use '/' in all places")
  321. }
  322. }
  323. // IsRunUserMatchCurrentUser returns false if configured run user does not match
  324. // actual user that runs the app. The first return value is the actual user name.
  325. // This check is ignored under Windows since SSH remote login is not the main
  326. // method to login on Windows.
  327. func IsRunUserMatchCurrentUser(runUser string) (string, bool) {
  328. if IsWindows {
  329. return "", true
  330. }
  331. currentUser := user.CurrentUsername()
  332. return currentUser, runUser == currentUser
  333. }
  334. // getOpenSSHVersion parses and returns string representation of OpenSSH version
  335. // returned by command "ssh -V".
  336. func getOpenSSHVersion() string {
  337. // Note: somehow version is printed to stderr
  338. _, stderr, err := process.Exec("getOpenSSHVersion", "ssh", "-V")
  339. if err != nil {
  340. log.Fatal(2, "Fail to get OpenSSH version: %v - %s", err, stderr)
  341. }
  342. // Trim unused information: https://github.com/gogits/gogs/issues/4507#issuecomment-305150441
  343. version := strings.TrimRight(strings.Fields(stderr)[0], ",1234567890")
  344. version = strings.TrimSuffix(strings.TrimPrefix(version, "OpenSSH_"), "p")
  345. return version
  346. }
  347. // NewContext initializes configuration context.
  348. // NOTE: do not print any log except error.
  349. func NewContext() {
  350. workDir, err := WorkDir()
  351. if err != nil {
  352. log.Fatal(2, "Fail to get work directory: %v", err)
  353. }
  354. Cfg, err = ini.Load(bindata.MustAsset("conf/app.ini"))
  355. if err != nil {
  356. log.Fatal(2, "Fail to parse 'conf/app.ini': %v", err)
  357. }
  358. CustomPath = os.Getenv("GOGS_CUSTOM")
  359. if len(CustomPath) == 0 {
  360. CustomPath = workDir + "/custom"
  361. }
  362. if len(CustomConf) == 0 {
  363. CustomConf = CustomPath + "/conf/app.ini"
  364. }
  365. if com.IsFile(CustomConf) {
  366. if err = Cfg.Append(CustomConf); err != nil {
  367. log.Fatal(2, "Fail to load custom conf '%s': %v", CustomConf, err)
  368. }
  369. } else {
  370. log.Warn("Custom config '%s' not found, ignore this if you're running first time", CustomConf)
  371. }
  372. Cfg.NameMapper = ini.AllCapsUnderscore
  373. homeDir, err := com.HomeDir()
  374. if err != nil {
  375. log.Fatal(2, "Fail to get home directory: %v", err)
  376. }
  377. homeDir = strings.Replace(homeDir, "\\", "/", -1)
  378. LogRootPath = Cfg.Section("log").Key("ROOT_PATH").MustString(path.Join(workDir, "log"))
  379. forcePathSeparator(LogRootPath)
  380. sec := Cfg.Section("server")
  381. AppName = Cfg.Section("").Key("APP_NAME").MustString("Gogs")
  382. AppURL = sec.Key("ROOT_URL").MustString("http://localhost:3000/")
  383. if AppURL[len(AppURL)-1] != '/' {
  384. AppURL += "/"
  385. }
  386. // Check if has app suburl.
  387. url, err := url.Parse(AppURL)
  388. if err != nil {
  389. log.Fatal(2, "Invalid ROOT_URL '%s': %s", AppURL, err)
  390. }
  391. // Suburl should start with '/' and end without '/', such as '/{subpath}'.
  392. // This value is empty if site does not have sub-url.
  393. AppSubURL = strings.TrimSuffix(url.Path, "/")
  394. AppSubURLDepth = strings.Count(AppSubURL, "/")
  395. Protocol = SCHEME_HTTP
  396. if sec.Key("PROTOCOL").String() == "https" {
  397. Protocol = SCHEME_HTTPS
  398. CertFile = sec.Key("CERT_FILE").String()
  399. KeyFile = sec.Key("KEY_FILE").String()
  400. TLSMinVersion = sec.Key("TLS_MIN_VERSION").String()
  401. } else if sec.Key("PROTOCOL").String() == "fcgi" {
  402. Protocol = SCHEME_FCGI
  403. } else if sec.Key("PROTOCOL").String() == "unix" {
  404. Protocol = SCHEME_UNIX_SOCKET
  405. UnixSocketPermissionRaw := sec.Key("UNIX_SOCKET_PERMISSION").MustString("666")
  406. UnixSocketPermissionParsed, err := strconv.ParseUint(UnixSocketPermissionRaw, 8, 32)
  407. if err != nil || UnixSocketPermissionParsed > 0777 {
  408. log.Fatal(2, "Fail to parse unixSocketPermission: %s", UnixSocketPermissionRaw)
  409. }
  410. UnixSocketPermission = uint32(UnixSocketPermissionParsed)
  411. }
  412. Domain = sec.Key("DOMAIN").MustString("localhost")
  413. HTTPAddr = sec.Key("HTTP_ADDR").MustString("0.0.0.0")
  414. HTTPPort = sec.Key("HTTP_PORT").MustString("3000")
  415. LocalURL = sec.Key("LOCAL_ROOT_URL").MustString(string(Protocol) + "://localhost:" + HTTPPort + "/")
  416. OfflineMode = sec.Key("OFFLINE_MODE").MustBool()
  417. DisableRouterLog = sec.Key("DISABLE_ROUTER_LOG").MustBool()
  418. StaticRootPath = sec.Key("STATIC_ROOT_PATH").MustString(workDir)
  419. AppDataPath = sec.Key("APP_DATA_PATH").MustString("data")
  420. EnableGzip = sec.Key("ENABLE_GZIP").MustBool()
  421. switch sec.Key("LANDING_PAGE").MustString("home") {
  422. case "explore":
  423. LandingPageURL = LANDING_PAGE_EXPLORE
  424. default:
  425. LandingPageURL = LANDING_PAGE_HOME
  426. }
  427. SSH.RootPath = path.Join(homeDir, ".ssh")
  428. SSH.ServerCiphers = sec.Key("SSH_SERVER_CIPHERS").Strings(",")
  429. SSH.KeyTestPath = os.TempDir()
  430. if err = Cfg.Section("server").MapTo(&SSH); err != nil {
  431. log.Fatal(2, "Fail to map SSH settings: %v", err)
  432. }
  433. if SSH.Disabled {
  434. SSH.StartBuiltinServer = false
  435. SSH.MinimumKeySizeCheck = false
  436. }
  437. if !SSH.Disabled && !SSH.StartBuiltinServer {
  438. if err := os.MkdirAll(SSH.RootPath, 0700); err != nil {
  439. log.Fatal(2, "Fail to create '%s': %v", SSH.RootPath, err)
  440. } else if err = os.MkdirAll(SSH.KeyTestPath, 0644); err != nil {
  441. log.Fatal(2, "Fail to create '%s': %v", SSH.KeyTestPath, err)
  442. }
  443. }
  444. // Check if server is eligible for minimum key size check when user choose to enable.
  445. // Windows server and OpenSSH version lower than 5.1 (https://github.com/gogits/gogs/issues/4507)
  446. // are forced to be disabled because the "ssh-keygen" in Windows does not print key type.
  447. if SSH.MinimumKeySizeCheck &&
  448. (IsWindows || version.Compare(getOpenSSHVersion(), "5.1", "<")) {
  449. SSH.MinimumKeySizeCheck = false
  450. log.Warn(`SSH minimum key size check is forced to be disabled because server is not eligible:
  451. 1. Windows server
  452. 2. OpenSSH version is lower than 5.1`)
  453. }
  454. if SSH.MinimumKeySizeCheck {
  455. SSH.MinimumKeySizes = map[string]int{}
  456. for _, key := range Cfg.Section("ssh.minimum_key_sizes").Keys() {
  457. if key.MustInt() != -1 {
  458. SSH.MinimumKeySizes[strings.ToLower(key.Name())] = key.MustInt()
  459. }
  460. }
  461. }
  462. sec = Cfg.Section("security")
  463. InstallLock = sec.Key("INSTALL_LOCK").MustBool()
  464. SecretKey = sec.Key("SECRET_KEY").String()
  465. LoginRememberDays = sec.Key("LOGIN_REMEMBER_DAYS").MustInt()
  466. CookieUserName = sec.Key("COOKIE_USERNAME").String()
  467. CookieRememberName = sec.Key("COOKIE_REMEMBER_NAME").String()
  468. CookieSecure = sec.Key("COOKIE_SECURE").MustBool(false)
  469. ReverseProxyAuthUser = sec.Key("REVERSE_PROXY_AUTHENTICATION_USER").MustString("X-WEBAUTH-USER")
  470. EnableLoginStatusCookie = sec.Key("ENABLE_LOGIN_STATUS_COOKIE").MustBool(false)
  471. LoginStatusCookieName = sec.Key("LOGIN_STATUS_COOKIE_NAME").MustString("login_status")
  472. sec = Cfg.Section("attachment")
  473. AttachmentPath = sec.Key("PATH").MustString(path.Join(AppDataPath, "attachments"))
  474. if !filepath.IsAbs(AttachmentPath) {
  475. AttachmentPath = path.Join(workDir, AttachmentPath)
  476. }
  477. AttachmentAllowedTypes = strings.Replace(sec.Key("ALLOWED_TYPES").MustString("image/jpeg,image/png"), "|", ",", -1)
  478. AttachmentMaxSize = sec.Key("MAX_SIZE").MustInt64(4)
  479. AttachmentMaxFiles = sec.Key("MAX_FILES").MustInt(5)
  480. AttachmentEnabled = sec.Key("ENABLED").MustBool(true)
  481. TimeFormat = map[string]string{
  482. "ANSIC": time.ANSIC,
  483. "UnixDate": time.UnixDate,
  484. "RubyDate": time.RubyDate,
  485. "RFC822": time.RFC822,
  486. "RFC822Z": time.RFC822Z,
  487. "RFC850": time.RFC850,
  488. "RFC1123": time.RFC1123,
  489. "RFC1123Z": time.RFC1123Z,
  490. "RFC3339": time.RFC3339,
  491. "RFC3339Nano": time.RFC3339Nano,
  492. "Kitchen": time.Kitchen,
  493. "Stamp": time.Stamp,
  494. "StampMilli": time.StampMilli,
  495. "StampMicro": time.StampMicro,
  496. "StampNano": time.StampNano,
  497. }[Cfg.Section("time").Key("FORMAT").MustString("RFC1123")]
  498. RunUser = Cfg.Section("").Key("RUN_USER").String()
  499. // Does not check run user when the install lock is off.
  500. if InstallLock {
  501. currentUser, match := IsRunUserMatchCurrentUser(RunUser)
  502. if !match {
  503. log.Fatal(2, "Expect user '%s' but current user is: %s", RunUser, currentUser)
  504. }
  505. }
  506. ProdMode = Cfg.Section("").Key("RUN_MODE").String() == "prod"
  507. // Determine and create root git repository path.
  508. sec = Cfg.Section("repository")
  509. RepoRootPath = sec.Key("ROOT").MustString(path.Join(homeDir, "gogs-repositories"))
  510. forcePathSeparator(RepoRootPath)
  511. if !filepath.IsAbs(RepoRootPath) {
  512. RepoRootPath = path.Join(workDir, RepoRootPath)
  513. } else {
  514. RepoRootPath = path.Clean(RepoRootPath)
  515. }
  516. ScriptType = sec.Key("SCRIPT_TYPE").MustString("bash")
  517. if err = Cfg.Section("repository").MapTo(&Repository); err != nil {
  518. log.Fatal(2, "Fail to map Repository settings: %v", err)
  519. } else if err = Cfg.Section("repository.editor").MapTo(&Repository.Editor); err != nil {
  520. log.Fatal(2, "Fail to map Repository.Editor settings: %v", err)
  521. } else if err = Cfg.Section("repository.upload").MapTo(&Repository.Upload); err != nil {
  522. log.Fatal(2, "Fail to map Repository.Upload settings: %v", err)
  523. }
  524. if !filepath.IsAbs(Repository.Upload.TempPath) {
  525. Repository.Upload.TempPath = path.Join(workDir, Repository.Upload.TempPath)
  526. }
  527. sec = Cfg.Section("picture")
  528. AvatarUploadPath = sec.Key("AVATAR_UPLOAD_PATH").MustString(path.Join(AppDataPath, "avatars"))
  529. forcePathSeparator(AvatarUploadPath)
  530. if !filepath.IsAbs(AvatarUploadPath) {
  531. AvatarUploadPath = path.Join(workDir, AvatarUploadPath)
  532. }
  533. switch source := sec.Key("GRAVATAR_SOURCE").MustString("gravatar"); source {
  534. case "duoshuo":
  535. GravatarSource = "http://gravatar.duoshuo.com/avatar/"
  536. case "gravatar":
  537. GravatarSource = "https://secure.gravatar.com/avatar/"
  538. case "libravatar":
  539. GravatarSource = "https://seccdn.libravatar.org/avatar/"
  540. default:
  541. GravatarSource = source
  542. }
  543. DisableGravatar = sec.Key("DISABLE_GRAVATAR").MustBool()
  544. EnableFederatedAvatar = sec.Key("ENABLE_FEDERATED_AVATAR").MustBool(true)
  545. if OfflineMode {
  546. DisableGravatar = true
  547. EnableFederatedAvatar = false
  548. }
  549. if DisableGravatar {
  550. EnableFederatedAvatar = false
  551. }
  552. if EnableFederatedAvatar {
  553. LibravatarService = libravatar.New()
  554. parts := strings.Split(GravatarSource, "/")
  555. if len(parts) >= 3 {
  556. if parts[0] == "https:" {
  557. LibravatarService.SetUseHTTPS(true)
  558. LibravatarService.SetSecureFallbackHost(parts[2])
  559. } else {
  560. LibravatarService.SetUseHTTPS(false)
  561. LibravatarService.SetFallbackHost(parts[2])
  562. }
  563. }
  564. }
  565. if err = Cfg.Section("http").MapTo(&HTTP); err != nil {
  566. log.Fatal(2, "Fail to map HTTP settings: %v", err)
  567. } else if err = Cfg.Section("webhook").MapTo(&Webhook); err != nil {
  568. log.Fatal(2, "Fail to map Webhook settings: %v", err)
  569. } else if err = Cfg.Section("release.attachment").MapTo(&Release.Attachment); err != nil {
  570. log.Fatal(2, "Fail to map Release.Attachment settings: %v", err)
  571. } else if err = Cfg.Section("markdown").MapTo(&Markdown); err != nil {
  572. log.Fatal(2, "Fail to map Markdown settings: %v", err)
  573. } else if err = Cfg.Section("smartypants").MapTo(&Smartypants); err != nil {
  574. log.Fatal(2, "Fail to map Smartypants settings: %v", err)
  575. } else if err = Cfg.Section("admin").MapTo(&Admin); err != nil {
  576. log.Fatal(2, "Fail to map Admin settings: %v", err)
  577. } else if err = Cfg.Section("cron").MapTo(&Cron); err != nil {
  578. log.Fatal(2, "Fail to map Cron settings: %v", err)
  579. } else if err = Cfg.Section("git").MapTo(&Git); err != nil {
  580. log.Fatal(2, "Fail to map Git settings: %v", err)
  581. } else if err = Cfg.Section("mirror").MapTo(&Mirror); err != nil {
  582. log.Fatal(2, "Fail to map Mirror settings: %v", err)
  583. } else if err = Cfg.Section("api").MapTo(&API); err != nil {
  584. log.Fatal(2, "Fail to map API settings: %v", err)
  585. } else if err = Cfg.Section("ui").MapTo(&UI); err != nil {
  586. log.Fatal(2, "Fail to map UI settings: %v", err)
  587. }
  588. if Mirror.DefaultInterval <= 0 {
  589. Mirror.DefaultInterval = 24
  590. }
  591. Langs = Cfg.Section("i18n").Key("LANGS").Strings(",")
  592. Names = Cfg.Section("i18n").Key("NAMES").Strings(",")
  593. dateLangs = Cfg.Section("i18n.datelang").KeysHash()
  594. ShowFooterBranding = Cfg.Section("other").Key("SHOW_FOOTER_BRANDING").MustBool()
  595. ShowFooterVersion = Cfg.Section("other").Key("SHOW_FOOTER_VERSION").MustBool()
  596. ShowFooterTemplateLoadTime = Cfg.Section("other").Key("SHOW_FOOTER_TEMPLATE_LOAD_TIME").MustBool()
  597. HasRobotsTxt = com.IsFile(path.Join(CustomPath, "robots.txt"))
  598. }
  599. var Service struct {
  600. ActiveCodeLives int
  601. ResetPwdCodeLives int
  602. RegisterEmailConfirm bool
  603. DisableRegistration bool
  604. ShowRegistrationButton bool
  605. RequireSignInView bool
  606. EnableNotifyMail bool
  607. EnableReverseProxyAuth bool
  608. EnableReverseProxyAutoRegister bool
  609. EnableCaptcha bool
  610. }
  611. func newService() {
  612. sec := Cfg.Section("service")
  613. Service.ActiveCodeLives = sec.Key("ACTIVE_CODE_LIVE_MINUTES").MustInt(180)
  614. Service.ResetPwdCodeLives = sec.Key("RESET_PASSWD_CODE_LIVE_MINUTES").MustInt(180)
  615. Service.DisableRegistration = sec.Key("DISABLE_REGISTRATION").MustBool()
  616. Service.ShowRegistrationButton = sec.Key("SHOW_REGISTRATION_BUTTON").MustBool(!Service.DisableRegistration)
  617. Service.RequireSignInView = sec.Key("REQUIRE_SIGNIN_VIEW").MustBool()
  618. Service.EnableReverseProxyAuth = sec.Key("ENABLE_REVERSE_PROXY_AUTHENTICATION").MustBool()
  619. Service.EnableReverseProxyAutoRegister = sec.Key("ENABLE_REVERSE_PROXY_AUTO_REGISTRATION").MustBool()
  620. Service.EnableCaptcha = sec.Key("ENABLE_CAPTCHA").MustBool()
  621. }
  622. func newLogService() {
  623. if len(BuildTime) > 0 {
  624. log.Trace("Build Time: %s", BuildTime)
  625. log.Trace("Build Git Hash: %s", BuildGitHash)
  626. }
  627. // Because we always create a console logger as primary logger before all settings are loaded,
  628. // thus if user doesn't set console logger, we should remove it after other loggers are created.
  629. hasConsole := false
  630. // Get and check log modes.
  631. LogModes = strings.Split(Cfg.Section("log").Key("MODE").MustString("console"), ",")
  632. LogConfigs = make([]interface{}, len(LogModes))
  633. levelNames := map[string]log.LEVEL{
  634. "trace": log.TRACE,
  635. "info": log.INFO,
  636. "warn": log.WARN,
  637. "error": log.ERROR,
  638. "fatal": log.FATAL,
  639. }
  640. for i, mode := range LogModes {
  641. mode = strings.ToLower(strings.TrimSpace(mode))
  642. sec, err := Cfg.GetSection("log." + mode)
  643. if err != nil {
  644. log.Fatal(2, "Unknown logger mode: %s", mode)
  645. }
  646. validLevels := []string{"trace", "info", "warn", "error", "fatal"}
  647. name := Cfg.Section("log." + mode).Key("LEVEL").Validate(func(v string) string {
  648. v = strings.ToLower(v)
  649. if com.IsSliceContainsStr(validLevels, v) {
  650. return v
  651. }
  652. return "trace"
  653. })
  654. level := levelNames[name]
  655. // Generate log configuration.
  656. switch log.MODE(mode) {
  657. case log.CONSOLE:
  658. hasConsole = true
  659. LogConfigs[i] = log.ConsoleConfig{
  660. Level: level,
  661. BufferSize: Cfg.Section("log").Key("BUFFER_LEN").MustInt64(100),
  662. }
  663. case log.FILE:
  664. logPath := path.Join(LogRootPath, "gogs.log")
  665. if err = os.MkdirAll(path.Dir(logPath), os.ModePerm); err != nil {
  666. log.Fatal(2, "Fail to create log directory '%s': %v", path.Dir(logPath), err)
  667. }
  668. LogConfigs[i] = log.FileConfig{
  669. Level: level,
  670. BufferSize: Cfg.Section("log").Key("BUFFER_LEN").MustInt64(100),
  671. Filename: logPath,
  672. FileRotationConfig: log.FileRotationConfig{
  673. Rotate: sec.Key("LOG_ROTATE").MustBool(true),
  674. Daily: sec.Key("DAILY_ROTATE").MustBool(true),
  675. MaxSize: 1 << uint(sec.Key("MAX_SIZE_SHIFT").MustInt(28)),
  676. MaxLines: sec.Key("MAX_LINES").MustInt64(1000000),
  677. MaxDays: sec.Key("MAX_DAYS").MustInt64(7),
  678. },
  679. }
  680. case log.SLACK:
  681. LogConfigs[i] = log.SlackConfig{
  682. Level: level,
  683. BufferSize: Cfg.Section("log").Key("BUFFER_LEN").MustInt64(100),
  684. URL: sec.Key("URL").String(),
  685. }
  686. }
  687. log.New(log.MODE(mode), LogConfigs[i])
  688. log.Trace("Log Mode: %s (%s)", strings.Title(mode), strings.Title(name))
  689. }
  690. // Make sure everyone gets version info printed.
  691. log.Info("%s %s", AppName, AppVer)
  692. if !hasConsole {
  693. log.Delete(log.CONSOLE)
  694. }
  695. }
  696. func newCacheService() {
  697. CacheAdapter = Cfg.Section("cache").Key("ADAPTER").In("memory", []string{"memory", "redis", "memcache"})
  698. switch CacheAdapter {
  699. case "memory":
  700. CacheInterval = Cfg.Section("cache").Key("INTERVAL").MustInt(60)
  701. case "redis", "memcache":
  702. CacheConn = strings.Trim(Cfg.Section("cache").Key("HOST").String(), "\" ")
  703. default:
  704. log.Fatal(2, "Unknown cache adapter: %s", CacheAdapter)
  705. }
  706. log.Info("Cache Service Enabled")
  707. }
  708. func newSessionService() {
  709. SessionConfig.Provider = Cfg.Section("session").Key("PROVIDER").In("memory",
  710. []string{"memory", "file", "redis", "mysql"})
  711. SessionConfig.ProviderConfig = strings.Trim(Cfg.Section("session").Key("PROVIDER_CONFIG").String(), "\" ")
  712. SessionConfig.CookieName = Cfg.Section("session").Key("COOKIE_NAME").MustString("i_like_gogits")
  713. SessionConfig.CookiePath = AppSubURL
  714. SessionConfig.Secure = Cfg.Section("session").Key("COOKIE_SECURE").MustBool()
  715. SessionConfig.Gclifetime = Cfg.Section("session").Key("GC_INTERVAL_TIME").MustInt64(3600)
  716. SessionConfig.Maxlifetime = Cfg.Section("session").Key("SESSION_LIFE_TIME").MustInt64(86400)
  717. CSRFCookieName = Cfg.Section("session").Key("CSRF_COOKIE_NAME").MustString("_csrf")
  718. log.Info("Session Service Enabled")
  719. }
  720. // Mailer represents mail service.
  721. type Mailer struct {
  722. QueueLength int
  723. Subject string
  724. Host string
  725. From string
  726. FromEmail string
  727. User, Passwd string
  728. DisableHelo bool
  729. HeloHostname string
  730. SkipVerify bool
  731. UseCertificate bool
  732. CertFile, KeyFile string
  733. UsePlainText bool
  734. }
  735. var (
  736. MailService *Mailer
  737. )
  738. func newMailService() {
  739. sec := Cfg.Section("mailer")
  740. // Check mailer setting.
  741. if !sec.Key("ENABLED").MustBool() {
  742. return
  743. }
  744. MailService = &Mailer{
  745. QueueLength: sec.Key("SEND_BUFFER_LEN").MustInt(100),
  746. Subject: sec.Key("SUBJECT").MustString(AppName),
  747. Host: sec.Key("HOST").String(),
  748. User: sec.Key("USER").String(),
  749. Passwd: sec.Key("PASSWD").String(),
  750. DisableHelo: sec.Key("DISABLE_HELO").MustBool(),
  751. HeloHostname: sec.Key("HELO_HOSTNAME").String(),
  752. SkipVerify: sec.Key("SKIP_VERIFY").MustBool(),
  753. UseCertificate: sec.Key("USE_CERTIFICATE").MustBool(),
  754. CertFile: sec.Key("CERT_FILE").String(),
  755. KeyFile: sec.Key("KEY_FILE").String(),
  756. UsePlainText: sec.Key("USE_PLAIN_TEXT").MustBool(),
  757. }
  758. MailService.From = sec.Key("FROM").MustString(MailService.User)
  759. if len(MailService.From) > 0 {
  760. parsed, err := mail.ParseAddress(MailService.From)
  761. if err != nil {
  762. log.Fatal(2, "Invalid mailer.FROM (%s): %v", MailService.From, err)
  763. }
  764. MailService.FromEmail = parsed.Address
  765. }
  766. log.Info("Mail Service Enabled")
  767. }
  768. func newRegisterMailService() {
  769. if !Cfg.Section("service").Key("REGISTER_EMAIL_CONFIRM").MustBool() {
  770. return
  771. } else if MailService == nil {
  772. log.Warn("Register Mail Service: Mail Service is not enabled")
  773. return
  774. }
  775. Service.RegisterEmailConfirm = true
  776. log.Info("Register Mail Service Enabled")
  777. }
  778. func newNotifyMailService() {
  779. if !Cfg.Section("service").Key("ENABLE_NOTIFY_MAIL").MustBool() {
  780. return
  781. } else if MailService == nil {
  782. log.Warn("Notify Mail Service: Mail Service is not enabled")
  783. return
  784. }
  785. Service.EnableNotifyMail = true
  786. log.Info("Notify Mail Service Enabled")
  787. }
  788. func NewService() {
  789. newService()
  790. }
  791. func NewServices() {
  792. newService()
  793. newLogService()
  794. newCacheService()
  795. newSessionService()
  796. newMailService()
  797. newRegisterMailService()
  798. newNotifyMailService()
  799. }