conf.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  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 base
  5. import (
  6. "fmt"
  7. "os"
  8. "os/exec"
  9. "path"
  10. "path/filepath"
  11. "regexp"
  12. "strings"
  13. "github.com/Unknwon/com"
  14. "github.com/Unknwon/goconfig"
  15. qlog "github.com/qiniu/log"
  16. "github.com/gogits/cache"
  17. "github.com/gogits/session"
  18. "github.com/gogits/gogs/modules/auth/ldap"
  19. "github.com/gogits/gogs/modules/log"
  20. )
  21. // Mailer represents mail service.
  22. type Mailer struct {
  23. Name string
  24. Host string
  25. User, Passwd string
  26. }
  27. type OauthInfo struct {
  28. ClientId, ClientSecret string
  29. Scopes string
  30. AuthUrl, TokenUrl string
  31. }
  32. // Oauther represents oauth service.
  33. type Oauther struct {
  34. GitHub, Google, Tencent,
  35. Twitter, Weibo bool
  36. OauthInfos map[string]*OauthInfo
  37. }
  38. var (
  39. AppVer string
  40. AppName string
  41. AppLogo string
  42. AppUrl string
  43. OfflineMode bool
  44. DisableRouterLog bool
  45. ProdMode bool
  46. Domain string
  47. SecretKey string
  48. RunUser string
  49. RepoRootPath string
  50. ScriptType string
  51. InstallLock bool
  52. LogInRememberDays int
  53. CookieUserName string
  54. CookieRememberName string
  55. Cfg *goconfig.ConfigFile
  56. MailService *Mailer
  57. OauthService *Oauther
  58. LogMode string
  59. LogConfig string
  60. Cache cache.Cache
  61. CacheAdapter string
  62. CacheConfig string
  63. SessionProvider string
  64. SessionConfig *session.Config
  65. SessionManager *session.Manager
  66. PictureService string
  67. DisableGravatar bool
  68. EnableRedis bool
  69. EnableMemcache bool
  70. )
  71. var Service struct {
  72. RegisterEmailConfirm bool
  73. DisableRegistration bool
  74. RequireSignInView bool
  75. EnableCacheAvatar bool
  76. NotifyMail bool
  77. ActiveCodeLives int
  78. ResetPwdCodeLives int
  79. LdapAuth bool
  80. }
  81. // ExecDir returns absolute path execution(binary) path.
  82. func ExecDir() (string, error) {
  83. file, err := exec.LookPath(os.Args[0])
  84. if err != nil {
  85. return "", err
  86. }
  87. p, err := filepath.Abs(file)
  88. if err != nil {
  89. return "", err
  90. }
  91. return path.Dir(strings.Replace(p, "\\", "/", -1)), nil
  92. }
  93. var logLevels = map[string]string{
  94. "Trace": "0",
  95. "Debug": "1",
  96. "Info": "2",
  97. "Warn": "3",
  98. "Error": "4",
  99. "Critical": "5",
  100. }
  101. func newService() {
  102. Service.ActiveCodeLives = Cfg.MustInt("service", "ACTIVE_CODE_LIVE_MINUTES", 180)
  103. Service.ResetPwdCodeLives = Cfg.MustInt("service", "RESET_PASSWD_CODE_LIVE_MINUTES", 180)
  104. Service.DisableRegistration = Cfg.MustBool("service", "DISABLE_REGISTRATION", false)
  105. Service.RequireSignInView = Cfg.MustBool("service", "REQUIRE_SIGNIN_VIEW", false)
  106. Service.EnableCacheAvatar = Cfg.MustBool("service", "ENABLE_CACHE_AVATAR", false)
  107. }
  108. func newLogService() {
  109. // Get and check log mode.
  110. LogMode = Cfg.MustValue("log", "MODE", "console")
  111. modeSec := "log." + LogMode
  112. if _, err := Cfg.GetSection(modeSec); err != nil {
  113. qlog.Fatalf("Unknown log mode: %s\n", LogMode)
  114. }
  115. // Log level.
  116. levelName := Cfg.MustValue("log."+LogMode, "LEVEL", "Trace")
  117. level, ok := logLevels[levelName]
  118. if !ok {
  119. qlog.Fatalf("Unknown log level: %s\n", levelName)
  120. }
  121. // Generate log configuration.
  122. switch LogMode {
  123. case "console":
  124. LogConfig = fmt.Sprintf(`{"level":%s}`, level)
  125. case "file":
  126. logPath := Cfg.MustValue(modeSec, "FILE_NAME", "log/gogs.log")
  127. os.MkdirAll(path.Dir(logPath), os.ModePerm)
  128. LogConfig = fmt.Sprintf(
  129. `{"level":%s,"filename":"%s","rotate":%v,"maxlines":%d,"maxsize":%d,"daily":%v,"maxdays":%d}`, level,
  130. logPath,
  131. Cfg.MustBool(modeSec, "LOG_ROTATE", true),
  132. Cfg.MustInt(modeSec, "MAX_LINES", 1000000),
  133. 1<<uint(Cfg.MustInt(modeSec, "MAX_SIZE_SHIFT", 28)),
  134. Cfg.MustBool(modeSec, "DAILY_ROTATE", true),
  135. Cfg.MustInt(modeSec, "MAX_DAYS", 7))
  136. case "conn":
  137. LogConfig = fmt.Sprintf(`{"level":"%s","reconnectOnMsg":%v,"reconnect":%v,"net":"%s","addr":"%s"}`, level,
  138. Cfg.MustBool(modeSec, "RECONNECT_ON_MSG", false),
  139. Cfg.MustBool(modeSec, "RECONNECT", false),
  140. Cfg.MustValue(modeSec, "PROTOCOL", "tcp"),
  141. Cfg.MustValue(modeSec, "ADDR", ":7020"))
  142. case "smtp":
  143. LogConfig = fmt.Sprintf(`{"level":"%s","username":"%s","password":"%s","host":"%s","sendTos":"%s","subject":"%s"}`, level,
  144. Cfg.MustValue(modeSec, "USER", "example@example.com"),
  145. Cfg.MustValue(modeSec, "PASSWD", "******"),
  146. Cfg.MustValue(modeSec, "HOST", "127.0.0.1:25"),
  147. Cfg.MustValue(modeSec, "RECEIVERS", "[]"),
  148. Cfg.MustValue(modeSec, "SUBJECT", "Diagnostic message from serve"))
  149. case "database":
  150. LogConfig = fmt.Sprintf(`{"level":"%s","driver":"%s","conn":"%s"}`, level,
  151. Cfg.MustValue(modeSec, "Driver"),
  152. Cfg.MustValue(modeSec, "CONN"))
  153. }
  154. log.Info("%s %s", AppName, AppVer)
  155. log.NewLogger(Cfg.MustInt64("log", "BUFFER_LEN", 10000), LogMode, LogConfig)
  156. log.Info("Log Mode: %s(%s)", strings.Title(LogMode), levelName)
  157. }
  158. func newLdapService() {
  159. Service.LdapAuth = Cfg.MustBool("security", "LDAP_AUTH", false)
  160. if !Service.LdapAuth {
  161. return
  162. }
  163. nbsrc := 0
  164. for _, v := range Cfg.GetSectionList() {
  165. if matched, _ := regexp.MatchString("(?i)^LDAPSOURCE.*", v); matched {
  166. ldapname := Cfg.MustValue(v, "name", v)
  167. ldaphost := Cfg.MustValue(v, "host")
  168. ldapport := Cfg.MustInt(v, "port", 389)
  169. ldapbasedn := Cfg.MustValue(v, "basedn", "dc=*,dc=*")
  170. ldapattribute := Cfg.MustValue(v, "attribute", "mail")
  171. ldapfilter := Cfg.MustValue(v, "filter", "(*)")
  172. ldapmsadsaformat := Cfg.MustValue(v, "MSADSAFORMAT", "%s")
  173. ldap.AddSource(ldapname, ldaphost, ldapport, ldapbasedn, ldapattribute, ldapfilter, ldapmsadsaformat)
  174. nbsrc++
  175. log.Debug("%s added as LDAP source", ldapname)
  176. }
  177. }
  178. if nbsrc == 0 {
  179. log.Warn("No valide LDAP found, LDAP Authentication NOT enabled")
  180. Service.LdapAuth = false
  181. return
  182. }
  183. log.Info("LDAP Authentication Enabled")
  184. }
  185. func newCacheService() {
  186. CacheAdapter = Cfg.MustValue("cache", "ADAPTER", "memory")
  187. if EnableRedis {
  188. log.Info("Redis Enabled")
  189. }
  190. if EnableMemcache {
  191. log.Info("Memcache Enabled")
  192. }
  193. switch CacheAdapter {
  194. case "memory":
  195. CacheConfig = fmt.Sprintf(`{"interval":%d}`, Cfg.MustInt("cache", "INTERVAL", 60))
  196. case "redis", "memcache":
  197. CacheConfig = fmt.Sprintf(`{"conn":"%s"}`, Cfg.MustValue("cache", "HOST"))
  198. default:
  199. qlog.Fatalf("Unknown cache adapter: %s\n", CacheAdapter)
  200. }
  201. var err error
  202. Cache, err = cache.NewCache(CacheAdapter, CacheConfig)
  203. if err != nil {
  204. qlog.Fatalf("Init cache system failed, adapter: %s, config: %s, %v\n",
  205. CacheAdapter, CacheConfig, err)
  206. }
  207. log.Info("Cache Service Enabled")
  208. }
  209. func newSessionService() {
  210. SessionProvider = Cfg.MustValue("session", "PROVIDER", "memory")
  211. SessionConfig = new(session.Config)
  212. SessionConfig.ProviderConfig = Cfg.MustValue("session", "PROVIDER_CONFIG")
  213. SessionConfig.CookieName = Cfg.MustValue("session", "COOKIE_NAME", "i_like_gogits")
  214. SessionConfig.CookieSecure = Cfg.MustBool("session", "COOKIE_SECURE")
  215. SessionConfig.EnableSetCookie = Cfg.MustBool("session", "ENABLE_SET_COOKIE", true)
  216. SessionConfig.GcIntervalTime = Cfg.MustInt64("session", "GC_INTERVAL_TIME", 86400)
  217. SessionConfig.SessionLifeTime = Cfg.MustInt64("session", "SESSION_LIFE_TIME", 86400)
  218. SessionConfig.SessionIDHashFunc = Cfg.MustValue("session", "SESSION_ID_HASHFUNC", "sha1")
  219. SessionConfig.SessionIDHashKey = Cfg.MustValue("session", "SESSION_ID_HASHKEY")
  220. if SessionProvider == "file" {
  221. os.MkdirAll(path.Dir(SessionConfig.ProviderConfig), os.ModePerm)
  222. }
  223. var err error
  224. SessionManager, err = session.NewManager(SessionProvider, *SessionConfig)
  225. if err != nil {
  226. qlog.Fatalf("Init session system failed, provider: %s, %v\n",
  227. SessionProvider, err)
  228. }
  229. log.Info("Session Service Enabled")
  230. }
  231. func newMailService() {
  232. // Check mailer setting.
  233. if !Cfg.MustBool("mailer", "ENABLED") {
  234. return
  235. }
  236. MailService = &Mailer{
  237. Name: Cfg.MustValue("mailer", "NAME", AppName),
  238. Host: Cfg.MustValue("mailer", "HOST"),
  239. User: Cfg.MustValue("mailer", "USER"),
  240. Passwd: Cfg.MustValue("mailer", "PASSWD"),
  241. }
  242. log.Info("Mail Service Enabled")
  243. }
  244. func newRegisterMailService() {
  245. if !Cfg.MustBool("service", "REGISTER_EMAIL_CONFIRM") {
  246. return
  247. } else if MailService == nil {
  248. log.Warn("Register Mail Service: Mail Service is not enabled")
  249. return
  250. }
  251. Service.RegisterEmailConfirm = true
  252. log.Info("Register Mail Service Enabled")
  253. }
  254. func newNotifyMailService() {
  255. if !Cfg.MustBool("service", "ENABLE_NOTIFY_MAIL") {
  256. return
  257. } else if MailService == nil {
  258. log.Warn("Notify Mail Service: Mail Service is not enabled")
  259. return
  260. }
  261. Service.NotifyMail = true
  262. log.Info("Notify Mail Service Enabled")
  263. }
  264. func NewConfigContext() {
  265. workDir, err := ExecDir()
  266. if err != nil {
  267. qlog.Fatalf("Fail to get work directory: %s\n", err)
  268. }
  269. cfgPath := filepath.Join(workDir, "conf/app.ini")
  270. Cfg, err = goconfig.LoadConfigFile(cfgPath)
  271. if err != nil {
  272. qlog.Fatalf("Cannot load config file(%s): %v\n", cfgPath, err)
  273. }
  274. Cfg.BlockMode = false
  275. cfgPaths := []string{os.Getenv("GOGS_CONFIG"), filepath.Join(workDir, "custom/conf/app.ini")}
  276. for _, cfgPath := range cfgPaths {
  277. if com.IsFile(cfgPath) {
  278. if err = Cfg.AppendFiles(cfgPath); err != nil {
  279. qlog.Fatalf("Cannot load config file(%s): %v\n", cfgPath, err)
  280. }
  281. }
  282. }
  283. AppName = Cfg.MustValue("", "APP_NAME", "Gogs: Go Git Service")
  284. AppLogo = Cfg.MustValue("", "APP_LOGO", "img/favicon.png")
  285. AppUrl = Cfg.MustValue("server", "ROOT_URL")
  286. Domain = Cfg.MustValue("server", "DOMAIN")
  287. OfflineMode = Cfg.MustBool("server", "OFFLINE_MODE", false)
  288. DisableRouterLog = Cfg.MustBool("server", "DISABLE_ROUTER_LOG", false)
  289. SecretKey = Cfg.MustValue("security", "SECRET_KEY")
  290. InstallLock = Cfg.MustBool("security", "INSTALL_LOCK", false)
  291. RunUser = Cfg.MustValue("", "RUN_USER")
  292. curUser := os.Getenv("USER")
  293. if len(curUser) == 0 {
  294. curUser = os.Getenv("USERNAME")
  295. }
  296. // Does not check run user when the install lock is off.
  297. if InstallLock && RunUser != curUser {
  298. qlog.Fatalf("Expect user(%s) but current user is: %s\n", RunUser, curUser)
  299. }
  300. LogInRememberDays = Cfg.MustInt("security", "LOGIN_REMEMBER_DAYS")
  301. CookieUserName = Cfg.MustValue("security", "COOKIE_USERNAME")
  302. CookieRememberName = Cfg.MustValue("security", "COOKIE_REMEMBER_NAME")
  303. PictureService = Cfg.MustValue("picture", "SERVICE")
  304. DisableGravatar = Cfg.MustBool("picture", "DISABLE_GRAVATAR", false)
  305. // Determine and create root git reposiroty path.
  306. homeDir, err := com.HomeDir()
  307. if err != nil {
  308. qlog.Fatalf("Fail to get home directory): %v\n", err)
  309. }
  310. RepoRootPath = Cfg.MustValue("repository", "ROOT", filepath.Join(homeDir, "gogs-repositories"))
  311. if err = os.MkdirAll(RepoRootPath, os.ModePerm); err != nil {
  312. qlog.Fatalf("Fail to create RepoRootPath(%s): %v\n", RepoRootPath, err)
  313. }
  314. ScriptType = Cfg.MustValue("repository", "SCRIPT_TYPE", "bash")
  315. }
  316. func NewBaseServices() {
  317. newService()
  318. newLogService()
  319. newLdapService()
  320. newCacheService()
  321. newSessionService()
  322. newMailService()
  323. newRegisterMailService()
  324. newNotifyMailService()
  325. }