conf: overhaul email settings (#5940)

Author: unknwon

CHANGELOG.md

@@ -22,6 +22,7 @@ All notable changes to Gogs are documented in this file.
 - Configuration option `[server] LANDING_PAGE` is deprecated and will end support in 0.13.0, please start using `[server] LANDING_URL`.
 - Configuration option `[database] DB_TYPE` is deprecated and will end support in 0.13.0, please start using `[database] TYPE`.
 - Configuration option `[database] PASSWD` is deprecated and will end support in 0.13.0, please start using `[database] PASSWORD`.
+- Configuration section `[mailer]` is deprecated and will end support in 0.13.0, please start using `[email]`.
 
 ### Fixed
 

Makefile

@@ -71,11 +71,8 @@ less: public/css/gogs.css
 public/css/gogs.css: $(LESS_FILES)
 	@type lessc >/dev/null 2>&1 && lessc --source-map "public/less/gogs.less" $@ || echo "lessc command not found or failed"
 
-clean:
-	go clean -i ./...
-
-clean-mac: clean
-	find . -name ".DS_Store" -print0 | xargs -0 rm
+clean-mac:
+	find . -name "*.DS_Store" -type f -delete
 
 test:
 	go test -cover -race ./...

conf/app.ini

@@ -179,6 +179,40 @@ ENABLE_LOGIN_STATUS_COOKIE = false
 ; The cookie name to store user login status.
 LOGIN_STATUS_COOKIE_NAME = login_status
 
+[email]
+; Whether to enable the email service.
+ENABLED = false
+; The prefix prepended to the subject line.
+SUBJECT_PREFIX = `[%(BRAND_NAME)s] `
+; The SMTP server with its port, e.g. smtp.mailgun.org:587, smtp.gmail.com:587, smtp.qq.com:465
+; If the port ends is "465", SMTPS will be used. Using STARTTLS on port 587 is recommended per RFC 6409.
+; If the server supports STARTTLS it will always be used.
+HOST = smtp.mailgun.org:587
+; The email from address (RFC 5322). This can be just an email address, or the `"Name" <[email protected]>` format.
+FROM = [email protected]
+; The login user.
+USER = [email protected]
+; The login password.
+PASSWORD =
+
+; Whether to disable HELO operation when the hostname is different.
+DISABLE_HELO =
+; The custom hostname for HELO operation, default is from system.
+HELO_HOSTNAME =
+
+; Whether to skip verifying the certificate of the server. Only use this for self-signed certificates.
+SKIP_VERIFY = false
+; Whether to use client certificates.
+USE_CERTIFICATE = false
+CERT_FILE = custom/email/cert.pem
+KEY_FILE = custom/email/key.pem
+
+; Whether to use "text/plain" as content format.
+USE_PLAIN_TEXT = false
+; Whether to attach a plaintext alternative to the MIME message while sending HTML emails.
+; It is used to support older mail clients and make spam filters happier.
+ADD_PLAIN_TEXT_ALT = false
+
 ; Attachment settings for releases
 [release.attachment]
 ; Whether attachments are enabled. Defaults to `true`
@@ -246,37 +280,6 @@ SKIP_TLS_VERIFY = false
 ; Number of history information in each page
 PAGING_NUM = 10
 
-[mailer]
-ENABLED = false
-; Buffer length of channel, keep it as it is if you don't know what it is.
-SEND_BUFFER_LEN = 100
-; Prefix prepended to the subject line
-SUBJECT_PREFIX = `[%(BRAND_NAME)s] `
-; Mail server
-; Gmail: smtp.gmail.com:587
-; QQ: smtp.qq.com:465
-; Note, if the port ends with "465", SMTPS will be used. Using STARTTLS on port 587 is recommended per RFC 6409. If the server supports STARTTLS it will always be used.
-HOST =
-; Disable HELO operation when hostname are different.
-DISABLE_HELO =
-; Custom hostname for HELO operation, default is from system.
-HELO_HOSTNAME =
-; Do not verify the certificate of the server. Only use this for self-signed certificates
-SKIP_VERIFY =
-; Use client certificate
-USE_CERTIFICATE = false
-CERT_FILE = custom/mailer/cert.pem
-KEY_FILE = custom/mailer/key.pem
-; Mail from address, RFC 5322. This can be just an email address, or the `"Name" <[email protected]>` format
-FROM =
-; Mailer user name and password
-USER =
-PASSWD =
-; Use text/plain as format of content
-USE_PLAIN_TEXT = false
-; If sending html emails, then also attach a plaintext alternative to the MIME message, to support older mail clients and make spam filters happier.
-ADD_PLAIN_TEXT_ALT = false
-
 [cache]
 ; Either "memory", "redis", or "memcache", default is "memory"
 ADAPTER = memory

conf/locale/locale_en-US.ini

@@ -1252,6 +1252,24 @@ config.security.reverse_proxy_auth_user = Reverse proxy authentication header
 config.security.enable_login_status_cookie = Enable login status cookie
 config.security.login_status_cookie_name = Login status cookie
 
+config.email_config = Email configuration
+config.email.enabled = Enabled
+config.email.subject_prefix = Subject prefix
+config.email.host = Host
+config.email.from = From
+config.email.user = User
+config.email.disable_helo = Disable HELO
+config.email.helo_hostname = HELO hostname
+config.email.skip_verify = Skip certificate verify
+config.email.use_certificate = Use custom certificate
+config.email.cert_file = Certificate file
+config.email.key_file = Key file
+config.email.use_plain_text = Use plain text
+config.email.add_plain_text_alt = Add plain text alternative
+config.email.send_test_mail = Send test email
+config.email.test_mail_failed = Failed to send test email to '%s': %v
+config.email.test_mail_sent = Test email has been sent to '%s'.
+
 config.log_file_root_path = Log File Root Path
 
 config.http_config = HTTP Configuration
@@ -1273,16 +1291,6 @@ config.queue_length = Queue Length
 config.deliver_timeout = Deliver Timeout
 config.skip_tls_verify = Skip TLS Verify
 
-config.mailer_config = Mailer Configuration
-config.mailer_enabled = Enabled
-config.mailer_disable_helo = Disable HELO
-config.mailer_subject_prefix = Subject Prefix
-config.mailer_host = Host
-config.mailer_user = User
-config.send_test_mail = Send Test Email
-config.test_mail_failed = Failed to send test email to '%s': %v
-config.test_mail_sent = Test email has been sent to '%s'.
-
 config.oauth_config = OAuth Configuration
 config.oauth_enabled = Enabled
 

internal/assets/conf/conf_gen.go

@@ -23,8 +23,8 @@ import (
 	"github.com/G-Node/gogs/internal/conf"
 	"github.com/G-Node/gogs/internal/db"
 	"github.com/G-Node/gogs/internal/db/errors"
+	"github.com/G-Node/gogs/internal/email"
 	"github.com/G-Node/gogs/internal/httplib"
-	"github.com/G-Node/gogs/internal/mailer"
 	"github.com/G-Node/gogs/internal/template"
 )
 
@@ -199,7 +199,7 @@ func runHookPostReceive(c *cli.Context) error {
 	// Post-receive hook does more than just gather Git information,
 	// so we need to setup additional services for email notifications.
 	conf.NewPostReceiveHookServices()
-	mailer.NewContext()
+	email.NewContext()
 
 	isWiki := strings.Contains(os.Getenv(db.ENV_REPO_CUSTOM_HOOKS_PATH), ".wiki.git/")
 

internal/assets/templates/templates_gen.go

@@ -208,6 +208,30 @@ func Init(customConf string) error {
 		}
 	}
 
+	// **************************
+	// ----- Email settings -----
+	// **************************
+
+	if err = File.Section("email").MapTo(&Email); err != nil {
+		return errors.Wrap(err, "mapping [email] section")
+	}
+	// LEGACY [0.13]: In case there are values with old section name.
+	if err = File.Section("mailer").MapTo(&Email); err != nil {
+		return errors.Wrap(err, "mapping [mailer] section")
+	}
+
+	if Email.Enabled {
+		if Email.From == "" {
+			Email.From = Email.User
+		}
+
+		parsed, err := mail.ParseAddress(Email.From)
+		if err != nil {
+			return errors.Wrapf(err, "parse mail address %q", Email.From)
+		}
+		Email.FromEmail = parsed.Address
+	}
+
 	handleDeprecated()
 
 	// TODO
@@ -720,71 +744,10 @@ func newSessionService() {
 	log.Trace("Session service is enabled")
 }
 
-// Mailer represents mail service.
-type Mailer struct {
-	QueueLength       int
-	SubjectPrefix     string
-	Host              string
-	From              string
-	FromEmail         string
-	User, Passwd      string
-	DisableHelo       bool
-	HeloHostname      string
-	SkipVerify        bool
-	UseCertificate    bool
-	CertFile, KeyFile string
-	UsePlainText      bool
-	AddPlainTextAlt   bool
-}
-
-var (
-	MailService *Mailer
-)
-
-// newMailService initializes mail service options from configuration.
-// No non-error log will be printed in hook mode.
-func newMailService() {
-	sec := File.Section("mailer")
-	if !sec.Key("ENABLED").MustBool() {
-		return
-	}
-
-	MailService = &Mailer{
-		QueueLength:     sec.Key("SEND_BUFFER_LEN").MustInt(100),
-		SubjectPrefix:   sec.Key("SUBJECT_PREFIX").MustString("[" + App.BrandName + "] "),
-		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(),
-		UsePlainText:    sec.Key("USE_PLAIN_TEXT").MustBool(),
-		AddPlainTextAlt: sec.Key("ADD_PLAIN_TEXT_ALT").MustBool(),
-	}
-	MailService.From = sec.Key("FROM").MustString(MailService.User)
-
-	if len(MailService.From) > 0 {
-		parsed, err := mail.ParseAddress(MailService.From)
-		if err != nil {
-			log.Fatal("Failed to parse value %q for '[mailer] FROM': %v", MailService.From, err)
-			return
-		}
-		MailService.FromEmail = parsed.Address
-	}
-
-	if HookMode {
-		return
-	}
-	log.Trace("Mail service is enabled")
-}
-
 func newRegisterMailService() {
 	if !File.Section("service").Key("REGISTER_EMAIL_CONFIRM").MustBool() {
 		return
-	} else if MailService == nil {
+	} else if !Email.Enabled {
 		log.Warn("Email confirmation is not enabled due to the mail service is not available")
 		return
 	}
@@ -797,7 +760,7 @@ func newRegisterMailService() {
 func newNotifyMailService() {
 	if !File.Section("service").Key("ENABLE_NOTIFY_MAIL").MustBool() {
 		return
-	} else if MailService == nil {
+	} else if !Email.Enabled {
 		log.Warn("Email notification is not enabled due to the mail service is not available")
 		return
 	}
@@ -817,7 +780,6 @@ func NewServices() {
 	newService()
 	newCacheService()
 	newSessionService()
-	newMailService()
 	newRegisterMailService()
 	newNotifyMailService()
 }
@@ -830,6 +792,5 @@ var HookMode bool
 func NewPostReceiveHookServices() {
 	HookMode = true
 	newService()
-	newMailService()
 	newNotifyMailService()
 }

internal/cmd/hook.go

@@ -159,6 +159,33 @@ var (
 		EnableLoginStatusCookie        bool
 		LoginStatusCookieName          string
 	}
+
+	// Email settings
+	Email struct {
+		Enabled       bool
+		SubjectPrefix string
+		Host          string
+		From          string
+		User          string
+		Password      string
+
+		DisableHELO  bool   `ini:"DISABLE_HELO"`
+		HELOHostname string `ini:"HELO_HOSTNAME"`
+
+		SkipVerify     bool
+		UseCertificate bool
+		CertFile       string
+		KeyFile        string
+
+		UsePlainText    bool
+		AddPlainTextAlt bool
+
+		// Derived from other static values
+		FromEmail string `ini:"-"` // Parsed email address of From without person's name.
+
+		// Deprecated: Use Password instead, will be removed in 0.13.
+		Passwd string
+	}
 )
 
 // handleDeprecated transfers deprecated values to the new ones when set.
@@ -185,4 +212,9 @@ func handleDeprecated() {
 		Database.Password = Database.Passwd
 		Database.Passwd = ""
 	}
+
+	if Email.Passwd != "" {
+		Email.Password = Email.Passwd
+		Email.Passwd = ""
+	}
 }

internal/conf/conf.go

@@ -11,7 +11,7 @@ import (
 	log "unknwon.dev/clog/v2"
 
 	"github.com/G-Node/gogs/internal/conf"
-	"github.com/G-Node/gogs/internal/mailer"
+	"github.com/G-Node/gogs/internal/email"
 	"github.com/G-Node/gogs/internal/markup"
 )
 
@@ -44,7 +44,7 @@ func (this mailerUser) GenerateEmailActivateCode(email string) string {
 	return this.user.GenerateEmailActivateCode(email)
 }
 
-func NewMailerUser(u *User) mailer.User {
+func NewMailerUser(u *User) email.User {
 	return mailerUser{u}
 }
 
@@ -65,7 +65,7 @@ func (this mailerRepo) ComposeMetas() map[string]string {
 	return this.repo.ComposeMetas()
 }
 
-func NewMailerRepo(repo *Repository) mailer.Repository {
+func NewMailerRepo(repo *Repository) email.Repository {
 	return mailerRepo{repo}
 }
 
@@ -86,7 +86,7 @@ func (this mailerIssue) HTMLURL() string {
 	return this.issue.HTMLURL()
 }
 
-func NewMailerIssue(issue *Issue) mailer.Issue {
+func NewMailerIssue(issue *Issue) email.Issue {
 	return mailerIssue{issue}
 }
 
@@ -148,7 +148,7 @@ func mailIssueCommentToParticipants(issue *Issue, doer *User, mentions []string)
 			names = append(names, issue.Assignee.Name)
 		}
 	}
-	mailer.SendIssueCommentMail(NewMailerIssue(issue), NewMailerRepo(issue.Repo), NewMailerUser(doer), tos)
+	email.SendIssueCommentMail(NewMailerIssue(issue), NewMailerRepo(issue.Repo), NewMailerUser(doer), tos)
 
 	// Mail mentioned people and exclude watchers.
 	names = append(names, doer.Name)
@@ -160,7 +160,7 @@ func mailIssueCommentToParticipants(issue *Issue, doer *User, mentions []string)
 
 		tos = append(tos, mentions[i])
 	}
-	mailer.SendIssueMentionMail(NewMailerIssue(issue), NewMailerRepo(issue.Repo), NewMailerUser(doer), GetUserEmailsByNames(tos))
+	email.SendIssueMentionMail(NewMailerIssue(issue), NewMailerRepo(issue.Repo), NewMailerUser(doer), GetUserEmailsByNames(tos))
 	return nil
 }