gitroast/modules/setting/setting.go

745 lines
22 KiB
Go
Raw Normal View History

2014-04-10 18:20:58 +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.
2014-05-26 00:11:25 +00:00
package setting
2014-04-10 18:20:58 +00:00
import (
"fmt"
"net/url"
2014-04-10 18:20:58 +00:00
"os"
"os/exec"
"path"
"path/filepath"
2014-09-16 17:34:09 +00:00
"runtime"
2014-04-10 18:20:58 +00:00
"strings"
"time"
2014-04-10 18:20:58 +00:00
"github.com/Unknwon/com"
2015-11-21 22:21:22 +00:00
_ "github.com/go-macaron/cache/memcache"
_ "github.com/go-macaron/cache/redis"
2015-10-16 01:28:12 +00:00
"github.com/go-macaron/session"
2015-11-21 22:21:22 +00:00
_ "github.com/go-macaron/session/redis"
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
"github.com/strk/go-libravatar"
2016-08-07 18:01:47 +00:00
"gopkg.in/ini.v1"
2014-04-10 18:20:58 +00:00
2015-03-18 10:37:44 +00:00
"github.com/gogits/gogs/modules/bindata"
2014-04-10 18:20:58 +00:00
"github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/user"
2014-04-10 18:20:58 +00:00
)
2014-05-26 00:11:25 +00:00
type Scheme string
2014-04-13 22:12:07 +00:00
2014-05-26 00:11:25 +00:00
const (
HTTP Scheme = "http"
HTTPS Scheme = "https"
2014-11-04 01:46:53 +00:00
FCGI Scheme = "fcgi"
2014-05-26 00:11:25 +00:00
)
2014-04-10 18:20:58 +00:00
2014-11-24 23:47:59 +00:00
type LandingPage string
const (
LANDING_PAGE_HOME LandingPage = "/"
LANDING_PAGE_EXPLORE LandingPage = "/explore"
)
2014-04-10 18:20:58 +00:00
var (
// Build information
2015-11-03 17:16:43 +00:00
BuildTime string
BuildGitHash string
// App settings
AppVer string
AppName string
AppUrl string
AppSubUrl string
AppSubUrlDepth int // Number of slashes
AppPath string
2016-03-10 01:53:42 +00:00
AppDataPath string
2014-05-26 00:11:25 +00:00
// Server settings
2014-05-26 00:11:25 +00:00
Protocol Scheme
Domain string
HttpAddr, HttpPort string
2015-12-17 07:28:47 +00:00
LocalURL string
2014-05-26 00:11:25 +00:00
OfflineMode bool
DisableRouterLog bool
CertFile, KeyFile string
StaticRootPath string
2014-07-26 04:24:27 +00:00
EnableGzip bool
2014-11-24 23:47:59 +00:00
LandingPageUrl LandingPage
2014-05-26 00:11:25 +00:00
SSH struct {
Disabled bool `ini:"DISABLE_SSH"`
StartBuiltinServer bool `ini:"START_SSH_SERVER"`
Domain string `ini:"SSH_DOMAIN"`
Port int `ini:"SSH_PORT"`
ListenPort int `ini:"SSH_LISTEN_PORT"`
RootPath string `ini:"SSH_ROOT_PATH"`
KeyTestPath string `ini:"SSH_KEY_TEST_PATH"`
KeygenPath string `ini:"SSH_KEYGEN_PATH"`
MinimumKeySizeCheck bool `ini:"-"`
MinimumKeySizes map[string]int `ini:"-"`
}
// Security settings
2014-06-24 17:55:47 +00:00
InstallLock bool
SecretKey string
LogInRememberDays int
CookieUserName string
CookieRememberName string
ReverseProxyAuthUser string
2014-04-10 18:20:58 +00:00
// Database settings
2015-02-12 02:58:37 +00:00
UseSQLite3 bool
UseMySQL bool
UsePostgreSQL bool
2015-09-12 19:31:36 +00:00
UseTiDB bool
2015-02-12 02:58:37 +00:00
// Webhook settings
Webhook struct {
2015-07-25 13:32:04 +00:00
QueueLength int
2015-02-11 17:04:01 +00:00
DeliverTimeout int
SkipTLSVerify bool
2015-08-26 16:30:06 +00:00
Types []string
2015-08-27 15:06:14 +00:00
PagingNum int
}
2014-06-08 08:45:34 +00:00
// Repository settings
Repository struct {
2015-10-25 08:26:26 +00:00
AnsiCharset string
ForcePrivate bool
2015-12-10 17:37:53 +00:00
MaxCreationLimit int
PullRequestQueueLength int
}
2015-07-24 18:52:25 +00:00
RepoRootPath string
ScriptType string
// UI settings
2016-07-23 16:23:54 +00:00
UI struct {
ExplorePagingNum int
IssuePagingNum int
FeedMaxCommitNum int
ThemeColorMetaTag string
MaxDisplayFileSize int64
Admin struct {
UserPagingNum int
RepoPagingNum int
NoticePagingNum int
OrgPagingNum int
} `ini:"ui.admin"`
User struct {
RepoPagingNum int
} `ini:"ui.user"`
}
2014-04-10 18:20:58 +00:00
// Markdown sttings
Markdown struct {
EnableHardLineBreak bool
2016-01-14 06:20:03 +00:00
CustomURLSchemes []string `ini:"CUSTOM_URL_SCHEMES"`
}
// Picture settings
2016-08-07 18:01:47 +00:00
AvatarUploadPath string
GravatarSource string
DisableGravatar bool
EnableFederatedAvatar bool
LibravatarService *libravatar.Libravatar
2014-05-26 00:11:25 +00:00
// Log settings
2014-05-28 05:53:06 +00:00
LogRootPath string
LogModes []string
LogConfigs []string
2014-04-10 18:20:58 +00:00
// Attachment settings
2014-07-23 19:15:47 +00:00
AttachmentPath string
AttachmentAllowedTypes string
2014-07-24 13:19:59 +00:00
AttachmentMaxSize int64
AttachmentMaxFiles int
2014-07-24 13:51:40 +00:00
AttachmentEnabled bool
2014-07-23 19:15:47 +00:00
// Time settings
TimeFormat string
// Cache settings
CacheAdapter string
CacheInternal int
CacheConn string
2014-04-10 18:20:58 +00:00
// Session settings
SessionConfig session.Options
CSRFCookieName = "_csrf"
2014-04-10 18:20:58 +00:00
// Cron tasks
2015-08-17 18:19:29 +00:00
Cron struct {
UpdateMirror struct {
Enabled bool
RunAtStart bool
Schedule string
} `ini:"cron.update_mirrors"`
RepoHealthCheck struct {
Enabled bool
RunAtStart bool
Schedule string
2015-12-09 16:38:12 +00:00
Timeout time.Duration
2015-08-17 18:19:29 +00:00
Args []string `delim:" "`
} `ini:"cron.repo_health_check"`
CheckRepoStats struct {
Enabled bool
RunAtStart bool
Schedule string
} `ini:"cron.check_repo_stats"`
2015-01-02 12:14:43 +00:00
}
2014-09-17 18:22:51 +00:00
// Git settings
Git struct {
DisableDiffHighlight bool
MaxGitDiffLines int
MaxGitDiffLineCharacters int
MaxGitDiffFiles int
2016-08-10 00:24:32 +00:00
GCArgs []string `delim:" "`
Timeout struct {
Migrate int
Mirror int
Clone int
Pull int
2016-08-10 00:24:32 +00:00
GC int `ini:"GC"`
} `ini:"git.timeout"`
}
// API settings
API struct {
MaxResponseItems int
}
// I18n settings
2014-09-17 18:22:51 +00:00
Langs, Names []string
2015-08-05 07:24:26 +00:00
dateLangs map[string]string
2014-09-17 18:22:51 +00:00
// Highlight settings are loaded in modules/template/hightlight.go
// Other settings
2015-12-18 10:49:28 +00:00
ShowFooterBranding bool
ShowFooterVersion bool
SupportMiniWinService bool
// Global setting objects
2014-12-31 10:37:29 +00:00
Cfg *ini.File
CustomPath string // Custom directory path
CustomConf string
2014-07-26 04:24:27 +00:00
ProdMode bool
RunUser string
2014-09-16 17:34:09 +00:00
IsWindows bool
2014-09-21 23:39:10 +00:00
HasRobotsTxt bool
2014-04-10 18:20:58 +00:00
)
2015-08-05 07:24:26 +00:00
func DateLang(lang string) string {
name, ok := dateLangs[lang]
if ok {
return name
}
return "en"
}
// execPath returns the executable path.
func execPath() (string, error) {
2014-05-26 00:11:25 +00:00
file, err := exec.LookPath(os.Args[0])
if err != nil {
return "", err
}
return filepath.Abs(file)
}
func init() {
IsWindows = runtime.GOOS == "windows"
log.NewLogger(0, "console", `{"level": 0}`)
var err error
if AppPath, err = execPath(); err != nil {
log.Fatal(4, "fail to get app path: %v\n", err)
2014-05-26 00:11:25 +00:00
}
// Note: we don't use path.Dir here because it does not handle case
// which path starts with two "/" in Windows: "//psf/Home/..."
AppPath = strings.Replace(AppPath, "\\", "/", -1)
2014-06-10 23:11:53 +00:00
}
// WorkDir returns absolute path of work directory.
func WorkDir() (string, error) {
wd := os.Getenv("GOGS_WORK_DIR")
if len(wd) > 0 {
return wd, nil
}
i := strings.LastIndex(AppPath, "/")
if i == -1 {
return AppPath, nil
}
return AppPath[:i], nil
2014-05-26 00:11:25 +00:00
}
func forcePathSeparator(path string) {
if strings.Contains(path, "\\") {
2015-03-18 10:37:44 +00:00
log.Fatal(4, "Do not use '\\' or '\\\\' in paths, instead, please use '/' in all places")
}
}
2016-08-10 00:41:18 +00:00
// IsRunUserMatchCurrentUser returns false if configured run user does not match
// actual user that runs the app. The first return value is the actual user name.
// This check is ignored under Windows since SSH remote login is not the main
// method to login on Windows.
func IsRunUserMatchCurrentUser(runUser string) (string, bool) {
if IsWindows {
return "", true
}
currentUser := user.CurrentUsername()
return currentUser, runUser == currentUser
}
2015-09-17 03:08:46 +00:00
// NewContext initializes configuration context.
2014-05-26 00:57:01 +00:00
// NOTE: do not print any log except error.
2015-09-17 03:08:46 +00:00
func NewContext() {
2014-05-26 00:11:25 +00:00
workDir, err := WorkDir()
if err != nil {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Fail to get work directory: %v", err)
2014-05-26 00:11:25 +00:00
}
2015-03-18 10:37:44 +00:00
Cfg, err = ini.Load(bindata.MustAsset("conf/app.ini"))
2014-05-26 00:11:25 +00:00
if err != nil {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Fail to parse 'conf/app.ini': %v", err)
2014-05-26 00:11:25 +00:00
}
CustomPath = os.Getenv("GOGS_CUSTOM")
if len(CustomPath) == 0 {
2015-08-02 03:52:48 +00:00
CustomPath = workDir + "/custom"
2014-05-26 00:11:25 +00:00
}
if len(CustomConf) == 0 {
2015-08-02 03:52:48 +00:00
CustomConf = CustomPath + "/conf/app.ini"
}
if com.IsFile(CustomConf) {
if err = Cfg.Append(CustomConf); err != nil {
log.Fatal(4, "Fail to load custom conf '%s': %v", CustomConf, err)
2014-05-26 00:11:25 +00:00
}
} else {
2015-12-20 02:43:32 +00:00
log.Warn("Custom config '%s' not found, ignore this if you're running first time", CustomConf)
2014-05-26 00:11:25 +00:00
}
2015-01-02 12:14:43 +00:00
Cfg.NameMapper = ini.AllCapsUnderscore
2014-05-26 00:11:25 +00:00
2015-12-20 02:43:32 +00:00
homeDir, err := com.HomeDir()
if err != nil {
log.Fatal(4, "Fail to get home directory: %v", err)
}
homeDir = strings.Replace(homeDir, "\\", "/", -1)
2014-12-31 10:37:29 +00:00
LogRootPath = Cfg.Section("log").Key("ROOT_PATH").MustString(path.Join(workDir, "log"))
forcePathSeparator(LogRootPath)
2014-12-31 10:37:29 +00:00
sec := Cfg.Section("server")
AppName = Cfg.Section("").Key("APP_NAME").MustString("Gogs: Go Git Service")
AppUrl = sec.Key("ROOT_URL").MustString("http://localhost:3000/")
2014-08-25 01:45:39 +00:00
if AppUrl[len(AppUrl)-1] != '/' {
AppUrl += "/"
}
2014-05-26 00:11:25 +00:00
2014-09-20 00:11:34 +00:00
// Check if has app suburl.
url, err := url.Parse(AppUrl)
if err != nil {
2015-12-20 02:43:32 +00:00
log.Fatal(4, "Invalid ROOT_URL '%s': %s", AppUrl, err)
}
// Suburl should start with '/' and end without '/', such as '/{subpath}'.
// This value is empty if site does not have sub-url.
2014-09-20 00:11:34 +00:00
AppSubUrl = strings.TrimSuffix(url.Path, "/")
AppSubUrlDepth = strings.Count(AppSubUrl, "/")
2014-05-26 00:11:25 +00:00
Protocol = HTTP
2014-12-31 10:37:29 +00:00
if sec.Key("PROTOCOL").String() == "https" {
2014-05-26 00:11:25 +00:00
Protocol = HTTPS
2014-12-31 10:37:29 +00:00
CertFile = sec.Key("CERT_FILE").String()
KeyFile = sec.Key("KEY_FILE").String()
} else if sec.Key("PROTOCOL").String() == "fcgi" {
2014-11-04 01:46:53 +00:00
Protocol = FCGI
}
2014-12-31 10:37:29 +00:00
Domain = sec.Key("DOMAIN").MustString("localhost")
HttpAddr = sec.Key("HTTP_ADDR").MustString("0.0.0.0")
HttpPort = sec.Key("HTTP_PORT").MustString("3000")
LocalURL = sec.Key("LOCAL_ROOT_URL").MustString(string(Protocol) + "://localhost:" + HttpPort + "/")
2014-12-31 10:37:29 +00:00
OfflineMode = sec.Key("OFFLINE_MODE").MustBool()
DisableRouterLog = sec.Key("DISABLE_ROUTER_LOG").MustBool()
StaticRootPath = sec.Key("STATIC_ROOT_PATH").MustString(workDir)
2016-03-10 01:53:42 +00:00
AppDataPath = sec.Key("APP_DATA_PATH").MustString("data")
2014-12-31 10:37:29 +00:00
EnableGzip = sec.Key("ENABLE_GZIP").MustBool()
switch sec.Key("LANDING_PAGE").MustString("home") {
2014-11-24 23:47:59 +00:00
case "explore":
LandingPageUrl = LANDING_PAGE_EXPLORE
default:
LandingPageUrl = LANDING_PAGE_HOME
}
SSH.RootPath = path.Join(homeDir, ".ssh")
SSH.KeyTestPath = os.TempDir()
if err = Cfg.Section("server").MapTo(&SSH); err != nil {
log.Fatal(4, "Fail to map SSH settings: %v", err)
}
// When disable SSH, start builtin server value is ignored.
if SSH.Disabled {
SSH.StartBuiltinServer = false
}
if !SSH.Disabled && !SSH.StartBuiltinServer {
if err := os.MkdirAll(SSH.RootPath, 0700); err != nil {
log.Fatal(4, "Fail to create '%s': %v", SSH.RootPath, err)
} else if err = os.MkdirAll(SSH.KeyTestPath, 0644); err != nil {
log.Fatal(4, "Fail to create '%s': %v", SSH.KeyTestPath, err)
}
}
SSH.MinimumKeySizeCheck = sec.Key("MINIMUM_KEY_SIZE_CHECK").MustBool()
SSH.MinimumKeySizes = map[string]int{}
minimumKeySizes := Cfg.Section("ssh.minimum_key_sizes").Keys()
for _, key := range minimumKeySizes {
if key.MustInt() != -1 {
SSH.MinimumKeySizes[strings.ToLower(key.Name())] = key.MustInt()
}
}
2014-12-31 10:37:29 +00:00
sec = Cfg.Section("security")
InstallLock = sec.Key("INSTALL_LOCK").MustBool()
SecretKey = sec.Key("SECRET_KEY").String()
LogInRememberDays = sec.Key("LOGIN_REMEMBER_DAYS").MustInt()
CookieUserName = sec.Key("COOKIE_USERNAME").String()
CookieRememberName = sec.Key("COOKIE_REMEMBER_NAME").String()
ReverseProxyAuthUser = sec.Key("REVERSE_PROXY_AUTHENTICATION_USER").MustString("X-WEBAUTH-USER")
sec = Cfg.Section("attachment")
AttachmentPath = sec.Key("PATH").MustString(path.Join(AppDataPath, "attachments"))
if !filepath.IsAbs(AttachmentPath) {
AttachmentPath = path.Join(workDir, AttachmentPath)
}
2015-08-11 15:24:40 +00:00
AttachmentAllowedTypes = strings.Replace(sec.Key("ALLOWED_TYPES").MustString("image/jpeg,image/png"), "|", ",", -1)
2015-09-02 20:18:09 +00:00
AttachmentMaxSize = sec.Key("MAX_SIZE").MustInt64(4)
2015-08-11 15:24:40 +00:00
AttachmentMaxFiles = sec.Key("MAX_FILES").MustInt(5)
2014-12-31 10:37:29 +00:00
AttachmentEnabled = sec.Key("ENABLE").MustBool(true)
2014-07-23 19:15:47 +00:00
2014-08-01 04:24:29 +00:00
TimeFormat = map[string]string{
"ANSIC": time.ANSIC,
"UnixDate": time.UnixDate,
"RubyDate": time.RubyDate,
"RFC822": time.RFC822,
"RFC822Z": time.RFC822Z,
"RFC850": time.RFC850,
"RFC1123": time.RFC1123,
"RFC1123Z": time.RFC1123Z,
"RFC3339": time.RFC3339,
"RFC3339Nano": time.RFC3339Nano,
"Kitchen": time.Kitchen,
"Stamp": time.Stamp,
"StampMilli": time.StampMilli,
"StampMicro": time.StampMicro,
"StampNano": time.StampNano,
2014-12-31 10:37:29 +00:00
}[Cfg.Section("time").Key("FORMAT").MustString("RFC1123")]
2014-12-31 10:37:29 +00:00
RunUser = Cfg.Section("").Key("RUN_USER").String()
2014-05-26 00:11:25 +00:00
// Does not check run user when the install lock is off.
2016-08-10 00:41:18 +00:00
if InstallLock {
currentUser, match := IsRunUserMatchCurrentUser(RunUser)
if !match {
log.Fatal(4, "Expect user '%s' but current user is: %s", RunUser, currentUser)
}
2014-05-26 00:11:25 +00:00
}
2014-12-07 01:22:48 +00:00
// Determine and create root git repository path.
2014-12-31 10:37:29 +00:00
sec = Cfg.Section("repository")
RepoRootPath = sec.Key("ROOT").MustString(path.Join(homeDir, "gogs-repositories"))
forcePathSeparator(RepoRootPath)
2014-06-24 06:28:47 +00:00
if !filepath.IsAbs(RepoRootPath) {
RepoRootPath = path.Join(workDir, RepoRootPath)
2014-06-24 06:28:47 +00:00
} else {
RepoRootPath = path.Clean(RepoRootPath)
2014-06-24 06:28:47 +00:00
}
2014-12-31 10:37:29 +00:00
ScriptType = sec.Key("SCRIPT_TYPE").MustString("bash")
2015-12-10 17:37:53 +00:00
if err = Cfg.Section("repository").MapTo(&Repository); err != nil {
log.Fatal(4, "Fail to map Repository settings: %v", err)
}
2014-05-26 00:11:25 +00:00
2014-12-31 10:37:29 +00:00
sec = Cfg.Section("picture")
AvatarUploadPath = sec.Key("AVATAR_UPLOAD_PATH").MustString(path.Join(AppDataPath, "avatars"))
forcePathSeparator(AvatarUploadPath)
if !filepath.IsAbs(AvatarUploadPath) {
AvatarUploadPath = path.Join(workDir, AvatarUploadPath)
}
2015-08-10 00:44:43 +00:00
switch source := sec.Key("GRAVATAR_SOURCE").MustString("gravatar"); source {
2014-11-17 01:27:04 +00:00
case "duoshuo":
GravatarSource = "http://gravatar.duoshuo.com/avatar/"
2015-08-10 00:44:43 +00:00
case "gravatar":
2016-01-29 05:06:17 +00:00
GravatarSource = "https://secure.gravatar.com/avatar/"
2015-08-10 00:44:43 +00:00
default:
GravatarSource = source
2014-11-17 01:27:04 +00:00
}
2014-12-31 10:37:29 +00:00
DisableGravatar = sec.Key("DISABLE_GRAVATAR").MustBool()
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
EnableFederatedAvatar = sec.Key("ENABLE_FEDERATED_AVATAR").MustBool()
if OfflineMode {
DisableGravatar = true
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
EnableFederatedAvatar = false
}
2016-08-07 18:01:47 +00:00
if DisableGravatar {
EnableFederatedAvatar = false
}
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
2016-08-07 18:01:47 +00:00
if EnableFederatedAvatar {
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
LibravatarService = libravatar.New()
parts := strings.Split(GravatarSource, "/")
if len(parts) >= 3 {
if parts[0] == "https:" {
LibravatarService.SetUseHTTPS(true)
LibravatarService.SetSecureFallbackHost(parts[2])
} else {
LibravatarService.SetUseHTTPS(false)
LibravatarService.SetFallbackHost(parts[2])
}
}
}
2014-07-26 04:24:27 +00:00
2016-07-23 16:23:54 +00:00
if err = Cfg.Section("ui").MapTo(&UI); err != nil {
log.Fatal(4, "Fail to map UI settings: %v", err)
} else if err = Cfg.Section("markdown").MapTo(&Markdown); err != nil {
log.Fatal(4, "Fail to map Markdown settings: %v", err)
} else if err = Cfg.Section("cron").MapTo(&Cron); err != nil {
2015-08-17 18:19:29 +00:00
log.Fatal(4, "Fail to map Cron settings: %v", err)
} else if err = Cfg.Section("git").MapTo(&Git); err != nil {
log.Fatal(4, "Fail to map Git settings: %v", err)
} else if err = Cfg.Section("api").MapTo(&API); err != nil {
log.Fatal(4, "Fail to map API settings: %v", err)
2015-01-02 12:14:43 +00:00
}
2014-12-31 10:37:29 +00:00
Langs = Cfg.Section("i18n").Key("LANGS").Strings(",")
Names = Cfg.Section("i18n").Key("NAMES").Strings(",")
2015-08-05 07:24:26 +00:00
dateLangs = Cfg.Section("i18n.datelang").KeysHash()
2014-09-21 23:39:10 +00:00
ShowFooterBranding = Cfg.Section("other").Key("SHOW_FOOTER_BRANDING").MustBool()
ShowFooterVersion = Cfg.Section("other").Key("SHOW_FOOTER_VERSION").MustBool()
2014-09-21 23:39:10 +00:00
HasRobotsTxt = com.IsFile(path.Join(CustomPath, "robots.txt"))
2014-05-26 00:11:25 +00:00
}
2014-04-10 18:20:58 +00:00
var Service struct {
ActiveCodeLives int
ResetPwdCodeLives int
2014-12-05 22:54:57 +00:00
RegisterEmailConfirm bool
DisableRegistration bool
ShowRegistrationButton bool
2014-12-05 22:54:57 +00:00
RequireSignInView bool
EnableNotifyMail bool
EnableReverseProxyAuth bool
EnableReverseProxyAutoRegister bool
EnableCaptcha bool
2014-04-10 18:20:58 +00:00
}
2014-05-26 00:11:25 +00:00
func newService() {
sec := Cfg.Section("service")
Service.ActiveCodeLives = sec.Key("ACTIVE_CODE_LIVE_MINUTES").MustInt(180)
Service.ResetPwdCodeLives = sec.Key("RESET_PASSWD_CODE_LIVE_MINUTES").MustInt(180)
Service.DisableRegistration = sec.Key("DISABLE_REGISTRATION").MustBool()
Service.ShowRegistrationButton = sec.Key("SHOW_REGISTRATION_BUTTON").MustBool(!Service.DisableRegistration)
Service.RequireSignInView = sec.Key("REQUIRE_SIGNIN_VIEW").MustBool()
Service.EnableReverseProxyAuth = sec.Key("ENABLE_REVERSE_PROXY_AUTHENTICATION").MustBool()
Service.EnableReverseProxyAutoRegister = sec.Key("ENABLE_REVERSE_PROXY_AUTO_REGISTRATION").MustBool()
Service.EnableCaptcha = sec.Key("ENABLE_CAPTCHA").MustBool()
2014-04-10 18:20:58 +00:00
}
var logLevels = map[string]string{
"Trace": "0",
"Debug": "1",
"Info": "2",
"Warn": "3",
"Error": "4",
"Critical": "5",
}
func newLogService() {
log.Info("%s %s", AppName, AppVer)
2014-04-10 18:20:58 +00:00
2015-11-03 17:16:43 +00:00
if len(BuildTime) > 0 {
log.Info("Build Time: %s", BuildTime)
log.Info("Build Git Hash: %s", BuildGitHash)
}
// Get and check log mode.
2014-12-31 10:37:29 +00:00
LogModes = strings.Split(Cfg.Section("log").Key("MODE").MustString("console"), ",")
LogConfigs = make([]string, len(LogModes))
for i, mode := range LogModes {
mode = strings.TrimSpace(mode)
2014-12-31 10:37:29 +00:00
sec, err := Cfg.GetSection("log." + mode)
if err != nil {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Unknown log mode: %s", mode)
}
validLevels := []string{"Trace", "Debug", "Info", "Warn", "Error", "Critical"}
// Log level.
levelName := Cfg.Section("log."+mode).Key("LEVEL").In(
Cfg.Section("log").Key("LEVEL").In("Trace", validLevels),
validLevels)
level, ok := logLevels[levelName]
if !ok {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Unknown log level: %s", levelName)
}
// Generate log configuration.
switch mode {
case "console":
LogConfigs[i] = fmt.Sprintf(`{"level":%s}`, level)
case "file":
2014-12-31 10:37:29 +00:00
logPath := sec.Key("FILE_NAME").MustString(path.Join(LogRootPath, "gogs.log"))
2015-12-08 06:11:40 +00:00
if err = os.MkdirAll(path.Dir(logPath), os.ModePerm); err != nil {
panic(err.Error())
}
LogConfigs[i] = fmt.Sprintf(
`{"level":%s,"filename":"%s","rotate":%v,"maxlines":%d,"maxsize":%d,"daily":%v,"maxdays":%d}`, level,
logPath,
2014-12-31 10:37:29 +00:00
sec.Key("LOG_ROTATE").MustBool(true),
sec.Key("MAX_LINES").MustInt(1000000),
1<<uint(sec.Key("MAX_SIZE_SHIFT").MustInt(28)),
sec.Key("DAILY_ROTATE").MustBool(true),
sec.Key("MAX_DAYS").MustInt(7))
case "conn":
2014-06-20 04:25:23 +00:00
LogConfigs[i] = fmt.Sprintf(`{"level":%s,"reconnectOnMsg":%v,"reconnect":%v,"net":"%s","addr":"%s"}`, level,
2014-12-31 10:37:29 +00:00
sec.Key("RECONNECT_ON_MSG").MustBool(),
sec.Key("RECONNECT").MustBool(),
sec.Key("PROTOCOL").In("tcp", []string{"tcp", "unix", "udp"}),
sec.Key("ADDR").MustString(":7020"))
case "smtp":
2014-06-20 04:25:23 +00:00
LogConfigs[i] = fmt.Sprintf(`{"level":%s,"username":"%s","password":"%s","host":"%s","sendTos":"%s","subject":"%s"}`, level,
2014-12-31 10:37:29 +00:00
sec.Key("USER").MustString("example@example.com"),
sec.Key("PASSWD").MustString("******"),
sec.Key("HOST").MustString("127.0.0.1:25"),
sec.Key("RECEIVERS").MustString("[]"),
sec.Key("SUBJECT").MustString("Diagnostic message from serve"))
case "database":
2014-06-20 04:25:23 +00:00
LogConfigs[i] = fmt.Sprintf(`{"level":%s,"driver":"%s","conn":"%s"}`, level,
2014-12-31 10:37:29 +00:00
sec.Key("DRIVER").String(),
sec.Key("CONN").String())
}
2014-12-31 10:37:29 +00:00
log.NewLogger(Cfg.Section("log").Key("BUFFER_LEN").MustInt64(10000), mode, LogConfigs[i])
log.Info("Log Mode: %s(%s)", strings.Title(mode), levelName)
2014-04-10 18:20:58 +00:00
}
}
func newCacheService() {
2014-12-31 10:37:29 +00:00
CacheAdapter = Cfg.Section("cache").Key("ADAPTER").In("memory", []string{"memory", "redis", "memcache"})
2014-04-10 18:20:58 +00:00
switch CacheAdapter {
case "memory":
2014-12-31 10:37:29 +00:00
CacheInternal = Cfg.Section("cache").Key("INTERVAL").MustInt(60)
2014-04-10 18:20:58 +00:00
case "redis", "memcache":
2014-12-31 10:37:29 +00:00
CacheConn = strings.Trim(Cfg.Section("cache").Key("HOST").String(), "\" ")
2014-04-10 18:20:58 +00:00
default:
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Unknown cache adapter: %s", CacheAdapter)
2014-04-10 18:20:58 +00:00
}
log.Info("Cache Service Enabled")
}
func newSessionService() {
2014-12-31 10:37:29 +00:00
SessionConfig.Provider = Cfg.Section("session").Key("PROVIDER").In("memory",
2014-05-19 02:05:35 +00:00
[]string{"memory", "file", "redis", "mysql"})
2014-12-31 10:37:29 +00:00
SessionConfig.ProviderConfig = strings.Trim(Cfg.Section("session").Key("PROVIDER_CONFIG").String(), "\" ")
SessionConfig.CookieName = Cfg.Section("session").Key("COOKIE_NAME").MustString("i_like_gogits")
2014-09-21 16:22:50 +00:00
SessionConfig.CookiePath = AppSubUrl
2014-12-31 10:37:29 +00:00
SessionConfig.Secure = Cfg.Section("session").Key("COOKIE_SECURE").MustBool()
SessionConfig.Gclifetime = Cfg.Section("session").Key("GC_INTERVAL_TIME").MustInt64(86400)
SessionConfig.Maxlifetime = Cfg.Section("session").Key("SESSION_LIFE_TIME").MustInt64(86400)
2014-04-10 18:20:58 +00:00
log.Info("Session Service Enabled")
}
2014-05-26 00:11:25 +00:00
// Mailer represents mail service.
type Mailer struct {
QueueLength int
Name string
Host string
From string
User, Passwd string
DisableHelo bool
HeloHostname string
SkipVerify bool
UseCertificate bool
CertFile, KeyFile string
EnableHTMLAlternative bool
2014-05-26 00:11:25 +00:00
}
var (
2015-09-17 20:11:44 +00:00
MailService *Mailer
2014-05-26 00:11:25 +00:00
)
2014-04-10 18:20:58 +00:00
func newMailService() {
2014-12-31 10:37:29 +00:00
sec := Cfg.Section("mailer")
2014-04-10 18:20:58 +00:00
// Check mailer setting.
2014-12-31 10:37:29 +00:00
if !sec.Key("ENABLED").MustBool() {
2014-04-10 18:20:58 +00:00
return
}
MailService = &Mailer{
QueueLength: sec.Key("SEND_BUFFER_LEN").MustInt(100),
Name: sec.Key("NAME").MustString(AppName),
Host: sec.Key("HOST").String(),
User: sec.Key("USER").String(),
Passwd: sec.Key("PASSWD").String(),
DisableHelo: sec.Key("DISABLE_HELO").MustBool(),
HeloHostname: sec.Key("HELO_HOSTNAME").String(),
SkipVerify: sec.Key("SKIP_VERIFY").MustBool(),
UseCertificate: sec.Key("USE_CERTIFICATE").MustBool(),
CertFile: sec.Key("CERT_FILE").String(),
KeyFile: sec.Key("KEY_FILE").String(),
EnableHTMLAlternative: sec.Key("ENABLE_HTML_ALTERNATIVE").MustBool(),
2014-04-10 18:20:58 +00:00
}
2014-12-31 10:37:29 +00:00
MailService.From = sec.Key("FROM").MustString(MailService.User)
2014-04-10 18:20:58 +00:00
log.Info("Mail Service Enabled")
}
func newRegisterMailService() {
2014-12-31 10:37:29 +00:00
if !Cfg.Section("service").Key("REGISTER_EMAIL_CONFIRM").MustBool() {
2014-04-10 18:20:58 +00:00
return
} else if MailService == nil {
log.Warn("Register Mail Service: Mail Service is not enabled")
return
}
Service.RegisterEmailConfirm = true
log.Info("Register Mail Service Enabled")
}
func newNotifyMailService() {
2014-12-31 10:37:29 +00:00
if !Cfg.Section("service").Key("ENABLE_NOTIFY_MAIL").MustBool() {
2014-04-10 18:20:58 +00:00
return
} else if MailService == nil {
log.Warn("Notify Mail Service: Mail Service is not enabled")
return
}
2014-06-21 04:51:41 +00:00
Service.EnableNotifyMail = true
2014-04-10 18:20:58 +00:00
log.Info("Notify Mail Service Enabled")
}
2014-06-08 08:45:34 +00:00
func newWebhookService() {
sec := Cfg.Section("webhook")
2015-07-25 13:32:04 +00:00
Webhook.QueueLength = sec.Key("QUEUE_LENGTH").MustInt(1000)
Webhook.DeliverTimeout = sec.Key("DELIVER_TIMEOUT").MustInt(5)
2015-02-11 17:04:01 +00:00
Webhook.SkipTLSVerify = sec.Key("SKIP_TLS_VERIFY").MustBool()
2015-08-26 16:30:06 +00:00
Webhook.Types = []string{"gogs", "slack"}
2015-08-27 15:06:14 +00:00
Webhook.PagingNum = sec.Key("PAGING_NUM").MustInt(10)
2014-06-08 08:45:34 +00:00
}
2014-05-26 00:11:25 +00:00
func NewServices() {
2014-04-10 18:20:58 +00:00
newService()
newLogService()
newCacheService()
newSessionService()
newMailService()
newRegisterMailService()
newNotifyMailService()
2014-06-08 08:45:34 +00:00
newWebhookService()
2014-04-10 18:20:58 +00:00
}