conf: overhaul email settings (#5940)

2 files changed, 0 insertions, 478 deletions

diff --git a/internal/mailer/mail.go b/internal/mailer/mail.go
deleted file mode 100644
index 835f1905..00000000
--- a/internal/mailer/mail.go
+++ /dev/null
@@ -1,228 +0,0 @@
-// Copyright 2016 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.
-
-package mailer
-
-import (
-	"fmt"
-	"html/template"
-	"path/filepath"
-	"sync"
-	"time"
-
-	"gopkg.in/gomail.v2"
-	"gopkg.in/macaron.v1"
-	log "unknwon.dev/clog/v2"
-
-	"gogs.io/gogs/internal/assets/templates"
-	"gogs.io/gogs/internal/conf"
-	"gogs.io/gogs/internal/markup"
-)
-
-const (
-	MAIL_AUTH_ACTIVATE        = "auth/activate"
-	MAIL_AUTH_ACTIVATE_EMAIL  = "auth/activate_email"
-	MAIL_AUTH_RESET_PASSWORD  = "auth/reset_passwd"
-	MAIL_AUTH_REGISTER_NOTIFY = "auth/register_notify"
-
-	MAIL_ISSUE_COMMENT = "issue/comment"
-	MAIL_ISSUE_MENTION = "issue/mention"
-
-	MAIL_NOTIFY_COLLABORATOR = "notify/collaborator"
-)
-
-var (
-	tplRender     *macaron.TplRender
-	tplRenderOnce sync.Once
-)
-
-// render renders a mail template with given data.
-func render(tpl string, data map[string]interface{}) (string, error) {
-	tplRenderOnce.Do(func() {
-		opt := &macaron.RenderOptions{
-			Directory:         filepath.Join(conf.WorkDir(), "templates", "mail"),
-			AppendDirectories: []string{filepath.Join(conf.CustomDir(), "templates", "mail")},
-			Extensions:        []string{".tmpl", ".html"},
-			Funcs: []template.FuncMap{map[string]interface{}{
-				"AppName": func() string {
-					return conf.App.BrandName
-				},
-				"AppURL": func() string {
-					return conf.Server.ExternalURL
-				},
-				"Year": func() int {
-					return time.Now().Year()
-				},
-				"Str2HTML": func(raw string) template.HTML {
-					return template.HTML(markup.Sanitize(raw))
-				},
-			}},
-		}
-		if !conf.Server.LoadAssetsFromDisk {
-			opt.TemplateFileSystem = templates.NewTemplateFileSystem("mail", opt.AppendDirectories[0])
-		}
-
-		ts := macaron.NewTemplateSet()
-		ts.Set(macaron.DEFAULT_TPL_SET_NAME, opt)
-		tplRender = &macaron.TplRender{
-			TemplateSet: ts,
-			Opt:         opt,
-		}
-	})
-
-	return tplRender.HTMLString(tpl, data)
-}
-
-func SendTestMail(email string) error {
-	return gomail.Send(&Sender{}, NewMessage([]string{email}, "Gogs Test Email", "Hello 👋, greeting from Gogs!").Message)
-}
-
-/*
-	Setup interfaces of used methods in mail to avoid cycle import.
-*/
-
-type User interface {
-	ID() int64
-	DisplayName() string
-	Email() string
-	GenerateActivateCode() string
-	GenerateEmailActivateCode(string) string
-}
-
-type Repository interface {
-	FullName() string
-	HTMLURL() string
-	ComposeMetas() map[string]string
-}
-
-type Issue interface {
-	MailSubject() string
-	Content() string
-	HTMLURL() string
-}
-
-func SendUserMail(c *macaron.Context, u User, tpl, code, subject, info string) {
-	data := map[string]interface{}{
-		"Username":          u.DisplayName(),
-		"ActiveCodeLives":   conf.Service.ActiveCodeLives / 60,
-		"ResetPwdCodeLives": conf.Service.ResetPwdCodeLives / 60,
-		"Code":              code,
-	}
-	body, err := render(tpl, data)
-	if err != nil {
-		log.Error("render: %v", err)
-		return
-	}
-
-	msg := NewMessage([]string{u.Email()}, subject, body)
-	msg.Info = fmt.Sprintf("UID: %d, %s", u.ID(), info)
-
-	Send(msg)
-}
-
-func SendActivateAccountMail(c *macaron.Context, u User) {
-	SendUserMail(c, u, MAIL_AUTH_ACTIVATE, u.GenerateActivateCode(), c.Tr("mail.activate_account"), "activate account")
-}
-
-func SendResetPasswordMail(c *macaron.Context, u User) {
-	SendUserMail(c, u, MAIL_AUTH_RESET_PASSWORD, u.GenerateActivateCode(), c.Tr("mail.reset_password"), "reset password")
-}
-
-// SendActivateAccountMail sends confirmation email.
-func SendActivateEmailMail(c *macaron.Context, u User, email string) {
-	data := map[string]interface{}{
-		"Username":        u.DisplayName(),
-		"ActiveCodeLives": conf.Service.ActiveCodeLives / 60,
-		"Code":            u.GenerateEmailActivateCode(email),
-		"Email":           email,
-	}
-	body, err := render(MAIL_AUTH_ACTIVATE_EMAIL, data)
-	if err != nil {
-		log.Error("HTMLString: %v", err)
-		return
-	}
-
-	msg := NewMessage([]string{email}, c.Tr("mail.activate_email"), body)
-	msg.Info = fmt.Sprintf("UID: %d, activate email", u.ID())
-
-	Send(msg)
-}
-
-// SendRegisterNotifyMail triggers a notify e-mail by admin created a account.
-func SendRegisterNotifyMail(c *macaron.Context, u User) {
-	data := map[string]interface{}{
-		"Username": u.DisplayName(),
-	}
-	body, err := render(MAIL_AUTH_REGISTER_NOTIFY, data)
-	if err != nil {
-		log.Error("HTMLString: %v", err)
-		return
-	}
-
-	msg := NewMessage([]string{u.Email()}, c.Tr("mail.register_notify"), body)
-	msg.Info = fmt.Sprintf("UID: %d, registration notify", u.ID())
-
-	Send(msg)
-}
-
-// SendCollaboratorMail sends mail notification to new collaborator.
-func SendCollaboratorMail(u, doer User, repo Repository) {
-	subject := fmt.Sprintf("%s added you to %s", doer.DisplayName(), repo.FullName())
-
-	data := map[string]interface{}{
-		"Subject":  subject,
-		"RepoName": repo.FullName(),
-		"Link":     repo.HTMLURL(),
-	}
-	body, err := render(MAIL_NOTIFY_COLLABORATOR, data)
-	if err != nil {
-		log.Error("HTMLString: %v", err)
-		return
-	}
-
-	msg := NewMessage([]string{u.Email()}, subject, body)
-	msg.Info = fmt.Sprintf("UID: %d, add collaborator", u.ID())
-
-	Send(msg)
-}
-
-func composeTplData(subject, body, link string) map[string]interface{} {
-	data := make(map[string]interface{}, 10)
-	data["Subject"] = subject
-	data["Body"] = body
-	data["Link"] = link
-	return data
-}
-
-func composeIssueMessage(issue Issue, repo Repository, doer User, tplName string, tos []string, info string) *Message {
-	subject := issue.MailSubject()
-	body := string(markup.Markdown([]byte(issue.Content()), repo.HTMLURL(), repo.ComposeMetas()))
-	data := composeTplData(subject, body, issue.HTMLURL())
-	data["Doer"] = doer
-	content, err := render(tplName, data)
-	if err != nil {
-		log.Error("HTMLString (%s): %v", tplName, err)
-	}
-	from := gomail.NewMessage().FormatAddress(conf.MailService.FromEmail, doer.DisplayName())
-	msg := NewMessageFrom(tos, from, subject, content)
-	msg.Info = fmt.Sprintf("Subject: %s, %s", subject, info)
-	return msg
-}
-
-// SendIssueCommentMail composes and sends issue comment emails to target receivers.
-func SendIssueCommentMail(issue Issue, repo Repository, doer User, tos []string) {
-	if len(tos) == 0 {
-		return
-	}
-
-	Send(composeIssueMessage(issue, repo, doer, MAIL_ISSUE_COMMENT, tos, "issue comment"))
-}
-
-// SendIssueMentionMail composes and sends issue mention emails to target receivers.
-func SendIssueMentionMail(issue Issue, repo Repository, doer User, tos []string) {
-	if len(tos) == 0 {
-		return
-	}
-	Send(composeIssueMessage(issue, repo, doer, MAIL_ISSUE_MENTION, tos, "issue mention"))
-}
diff --git a/internal/mailer/mailer.go b/internal/mailer/mailer.go
deleted file mode 100644
index 8a54bd41..00000000
--- a/internal/mailer/mailer.go
+++ /dev/null
@@ -1,250 +0,0 @@
-// 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.
-
-package mailer
-
-import (
-	"crypto/tls"
-	"fmt"
-	"io"
-	"net"
-	"net/smtp"
-	"os"
-	"strings"
-	"time"
-
-	"github.com/jaytaylor/html2text"
-	"gopkg.in/gomail.v2"
-	log "unknwon.dev/clog/v2"
-
-	"gogs.io/gogs/internal/conf"
-)
-
-type Message struct {
-	Info string // Message information for log purpose.
-	*gomail.Message
-	confirmChan chan struct{}
-}
-
-// NewMessageFrom creates new mail message object with custom From header.
-func NewMessageFrom(to []string, from, subject, htmlBody string) *Message {
-	log.Trace("NewMessageFrom (htmlBody):\n%s", htmlBody)
-
-	msg := gomail.NewMessage()
-	msg.SetHeader("From", from)
-	msg.SetHeader("To", to...)
-	msg.SetHeader("Subject", conf.MailService.SubjectPrefix+subject)
-	msg.SetDateHeader("Date", time.Now())
-
-	contentType := "text/html"
-	body := htmlBody
-	switchedToPlaintext := false
-	if conf.MailService.UsePlainText || conf.MailService.AddPlainTextAlt {
-		plainBody, err := html2text.FromString(htmlBody)
-		if err != nil {
-			log.Error("html2text.FromString: %v", err)
-		} else {
-			contentType = "text/plain"
-			body = plainBody
-			switchedToPlaintext = true
-		}
-	}
-	msg.SetBody(contentType, body)
-	if switchedToPlaintext && conf.MailService.AddPlainTextAlt && !conf.MailService.UsePlainText {
-		// The AddAlternative method name is confusing - adding html as an "alternative" will actually cause mail
-		// clients to show it as first priority, and the text "main body" is the 2nd priority fallback.
-		// See: https://godoc.org/gopkg.in/gomail.v2#Message.AddAlternative
-		msg.AddAlternative("text/html", htmlBody)
-	}
-	return &Message{
-		Message:     msg,
-		confirmChan: make(chan struct{}),
-	}
-}
-
-// NewMessage creates new mail message object with default From header.
-func NewMessage(to []string, subject, body string) *Message {
-	return NewMessageFrom(to, conf.MailService.From, subject, body)
-}
-
-type loginAuth struct {
-	username, password string
-}
-
-// SMTP AUTH LOGIN Auth Handler
-func LoginAuth(username, password string) smtp.Auth {
-	return &loginAuth{username, password}
-}
-
-func (a *loginAuth) Start(server *smtp.ServerInfo) (string, []byte, error) {
-	return "LOGIN", []byte{}, nil
-}
-
-func (a *loginAuth) Next(fromServer []byte, more bool) ([]byte, error) {
-	if more {
-		switch string(fromServer) {
-		case "Username:":
-			return []byte(a.username), nil
-		case "Password:":
-			return []byte(a.password), nil
-		default:
-			return nil, fmt.Errorf("unknwon fromServer: %s", string(fromServer))
-		}
-	}
-	return nil, nil
-}
-
-type Sender struct {
-}
-
-func (s *Sender) Send(from string, to []string, msg io.WriterTo) error {
-	opts := conf.MailService
-
-	host, port, err := net.SplitHostPort(opts.Host)
-	if err != nil {
-		return err
-	}
-
-	tlsconfig := &tls.Config{
-		InsecureSkipVerify: opts.SkipVerify,
-		ServerName:         host,
-	}
-
-	if opts.UseCertificate {
-		cert, err := tls.LoadX509KeyPair(opts.CertFile, opts.KeyFile)
-		if err != nil {
-			return err
-		}
-		tlsconfig.Certificates = []tls.Certificate{cert}
-	}
-
-	conn, err := net.Dial("tcp", net.JoinHostPort(host, port))
-	if err != nil {
-		return err
-	}
-	defer conn.Close()
-
-	isSecureConn := false
-	// Start TLS directly if the port ends with 465 (SMTPS protocol)
-	if strings.HasSuffix(port, "465") {
-		conn = tls.Client(conn, tlsconfig)
-		isSecureConn = true
-	}
-
-	client, err := smtp.NewClient(conn, host)
-	if err != nil {
-		return fmt.Errorf("NewClient: %v", err)
-	}
-
-	if !opts.DisableHelo {
-		hostname := opts.HeloHostname
-		if len(hostname) == 0 {
-			hostname, err = os.Hostname()
-			if err != nil {
-				return err
-			}
-		}
-
-		if err = client.Hello(hostname); err != nil {
-			return fmt.Errorf("Hello: %v", err)
-		}
-	}
-
-	// If not using SMTPS, alway use STARTTLS if available
-	hasStartTLS, _ := client.Extension("STARTTLS")
-	if !isSecureConn && hasStartTLS {
-		if err = client.StartTLS(tlsconfig); err != nil {
-			return fmt.Errorf("StartTLS: %v", err)
-		}
-	}
-
-	canAuth, options := client.Extension("AUTH")
-	if canAuth && len(opts.User) > 0 {
-		var auth smtp.Auth
-
-		if strings.Contains(options, "CRAM-MD5") {
-			auth = smtp.CRAMMD5Auth(opts.User, opts.Passwd)
-		} else if strings.Contains(options, "PLAIN") {
-			auth = smtp.PlainAuth("", opts.User, opts.Passwd, host)
-		} else if strings.Contains(options, "LOGIN") {
-			// Patch for AUTH LOGIN
-			auth = LoginAuth(opts.User, opts.Passwd)
-		}
-
-		if auth != nil {
-			if err = client.Auth(auth); err != nil {
-				return fmt.Errorf("Auth: %v", err)
-			}
-		}
-	}
-
-	if err = client.Mail(from); err != nil {
-		return fmt.Errorf("Mail: %v", err)
-	}
-
-	for _, rec := range to {
-		if err = client.Rcpt(rec); err != nil {
-			return fmt.Errorf("Rcpt: %v", err)
-		}
-	}
-
-	w, err := client.Data()
-	if err != nil {
-		return fmt.Errorf("Data: %v", err)
-	} else if _, err = msg.WriteTo(w); err != nil {
-		return fmt.Errorf("WriteTo: %v", err)
-	} else if err = w.Close(); err != nil {
-		return fmt.Errorf("Close: %v", err)
-	}
-
-	return client.Quit()
-}
-
-func processMailQueue() {
-	sender := &Sender{}
-
-	for {
-		select {
-		case msg := <-mailQueue:
-			log.Trace("New e-mail sending request %s: %s", msg.GetHeader("To"), msg.Info)
-			if err := gomail.Send(sender, msg.Message); err != nil {
-				log.Error("Failed to send emails %s: %s - %v", msg.GetHeader("To"), msg.Info, err)
-			} else {
-				log.Trace("E-mails sent %s: %s", msg.GetHeader("To"), msg.Info)
-			}
-			msg.confirmChan <- struct{}{}
-		}
-	}
-}
-
-var mailQueue chan *Message
-
-// NewContext initializes settings for mailer.
-func NewContext() {
-	// Need to check if mailQueue is nil because in during reinstall (user had installed
-	// before but swithed install lock off), this function will be called again
-	// while mail queue is already processing tasks, and produces a race condition.
-	if conf.MailService == nil || mailQueue != nil {
-		return
-	}
-
-	mailQueue = make(chan *Message, conf.MailService.QueueLength)
-	go processMailQueue()
-}
-
-// Send puts new message object into mail queue.
-// It returns without confirmation (mail processed asynchronously) in normal cases,
-// but waits/blocks under hook mode to make sure mail has been sent.
-func Send(msg *Message) {
-	mailQueue <- msg
-
-	if conf.HookMode {
-		<-msg.confirmChan
-		return
-	}
-
-	go func() {
-		<-msg.confirmChan
-	}()
-}