Use templates for issue e-mail subject and body

models/issue.go

@@ -1909,3 +1909,20 @@ func (issue *Issue) updateClosedNum(e Engine) (err error) {
 	}
 	return
 }
+
+// ComposeSubjectTplData composes a map of metas for properly rendering a mail subject.
+func (issue *Issue) ComposeSubjectTplData(doer *User, comment *Comment, actionType ActionType, fromMention bool) (map[string]interface{}, error) {
+	if err := issue.LoadPullRequest(); err != nil {
+		return nil, err
+	}
+	return map[string]interface{}{
+		"Issue":       issue,
+		"Comment":     comment,
+		"IsPull":      issue.IsPull,
+		"User":        issue.Repo.MustOwner().Name,
+		"Repo":        issue.Repo.FullName(),
+		"Doer":        doer.Name,
+		"Action":      actionType,
+		"FromMention": fromMention,
+	}, nil
+}

services/mailer/mail.go

@@ -9,7 +9,10 @@ import (
 	"bytes"
 	"fmt"
 	"html/template"
+	"mime"
 	"path"
+	"regexp"
+	"strings"
 
 	"code.gitea.io/gitea/models"
 	"code.gitea.io/gitea/modules/base"
@@ -28,13 +31,18 @@ const (
 	mailAuthResetPassword  base.TplName = "auth/reset_passwd"
 	mailAuthRegisterNotify base.TplName = "auth/register_notify"
 
+	mailIssueSubject base.TplName = "issue/subject"
 	mailIssueComment base.TplName = "issue/comment"
 	mailIssueMention base.TplName = "issue/mention"
 
 	mailNotifyCollaborator base.TplName = "notify/collaborator"
+
+	// There's no actual limit for subject in RFC 5322
+	mailMaxSubjectRunes = 256
 )
 
 var templates *template.Template
+var subjectRemoveSpaces = regexp.MustCompile(`[\s]+`)
 
 // InitMailRender initializes the mail renderer
 func InitMailRender(tmpls *template.Template) {
@@ -163,20 +171,35 @@ func composeTplData(subject, body, link string) map[string]interface{} {
 	return data
 }
 
-func composeIssueCommentMessage(issue *models.Issue, doer *models.User, content string, comment *models.Comment, tplName base.TplName, tos []string, info string) *Message {
+func composeIssueCommentMessage(issue *models.Issue, doer *models.User, actionType models.ActionType, fromMention bool,
+	content string, comment *models.Comment, tplBody base.TplName, tos []string, info string) *Message {
 	var subject string
-	if comment != nil {
-		subject = "Re: " + mailSubject(issue)
-	} else {
-		subject = mailSubject(issue)
-	}
 	err := issue.LoadRepo()
 	if err != nil {
 		log.Error("LoadRepo: %v", err)
 	}
+
+	var mailSubject bytes.Buffer
+	if subjectData, err := issue.ComposeSubjectTplData(doer, comment, actionType, fromMention); err == nil {
+		if err = templates.ExecuteTemplate(&mailSubject, string(mailIssueSubject), subjectData); err == nil {
+			subject = sanitizeSubject(mailSubject.String())
+		}
+	}
+	if subject == "" {
+		if err != nil {
+			log.Error("Template: %v", err)
+		}
+		// Default subject
+		if comment != nil {
+			subject = "Re: " + defaultMailSubject(issue)
+		} else {
+			subject = defaultMailSubject(issue)
+		}
+	}
+
 	body := string(markup.RenderByType(markdown.MarkupName, []byte(content), issue.Repo.HTMLURL(), issue.Repo.ComposeMetas()))
 
-	var data = make(map[string]interface{}, 10)
+	var data map[string]interface{}
 	if comment != nil {
 		data = composeTplData(subject, body, issue.HTMLURL()+"#"+comment.HashTag())
 	} else {
@@ -186,7 +209,7 @@ func composeIssueCommentMessage(issue *models.Issue, doer *models.User, content
 
 	var mailBody bytes.Buffer
 
-	if err := templates.ExecuteTemplate(&mailBody, string(tplName), data); err != nil {
+	if err := templates.ExecuteTemplate(&mailBody, string(tplBody), data); err != nil {
 		log.Error("Template: %v", err)
 	}
 
@@ -204,19 +227,28 @@ func composeIssueCommentMessage(issue *models.Issue, doer *models.User, content
 	return msg
 }
 
+func sanitizeSubject(subject string) string {
+	runes := []rune(strings.TrimSpace(subjectRemoveSpaces.ReplaceAllLiteralString(subject, " ")))
+	if len(runes) > mailMaxSubjectRunes {
+		runes = runes[:mailMaxSubjectRunes]
+	}
+	// Encode non-ASCII characters
+	return mime.QEncoding.Encode("utf-8", string(runes))
+}
+
 // SendIssueCommentMail composes and sends issue comment emails to target receivers.
-func SendIssueCommentMail(issue *models.Issue, doer *models.User, content string, comment *models.Comment, tos []string) {
+func SendIssueCommentMail(issue *models.Issue, doer *models.User, actionType models.ActionType, content string, comment *models.Comment, tos []string) {
 	if len(tos) == 0 {
 		return
 	}
 
-	SendAsync(composeIssueCommentMessage(issue, doer, content, comment, mailIssueComment, tos, "issue comment"))
+	SendAsync(composeIssueCommentMessage(issue, doer, actionType, false, content, comment, mailIssueComment, tos, "issue comment"))
 }
 
 // SendIssueMentionMail composes and sends issue mention emails to target receivers.
-func SendIssueMentionMail(issue *models.Issue, doer *models.User, content string, comment *models.Comment, tos []string) {
+func SendIssueMentionMail(issue *models.Issue, doer *models.User, actionType models.ActionType, content string, comment *models.Comment, tos []string) {
 	if len(tos) == 0 {
 		return
 	}
-	SendAsync(composeIssueCommentMessage(issue, doer, content, comment, mailIssueMention, tos, "issue mention"))
+	SendAsync(composeIssueCommentMessage(issue, doer, actionType, true, content, comment, mailIssueMention, tos, "issue mention"))
 }

services/mailer/mail_comment.go

@@ -25,20 +25,20 @@ func mailParticipantsComment(ctx models.DBContext, c *models.Comment, opType mod
 	}
 
 	if len(c.Content) > 0 {
-		if err = mailIssueCommentToParticipants(issue, c.Poster, c.Content, c, mentions); err != nil {
+		if err = mailIssueCommentToParticipants(issue, c.Poster, opType, c.Content, c, mentions); err != nil {
 			log.Error("mailIssueCommentToParticipants: %v", err)
 		}
 	}
 
 	switch opType {
 	case models.ActionCloseIssue:
 		ct := fmt.Sprintf("Closed #%d.", issue.Index)
-		if err = mailIssueCommentToParticipants(issue, c.Poster, ct, c, mentions); err != nil {
+		if err = mailIssueCommentToParticipants(issue, c.Poster, opType, ct, c, mentions); err != nil {
 			log.Error("mailIssueCommentToParticipants: %v", err)
 		}
 	case models.ActionReopenIssue:
 		ct := fmt.Sprintf("Reopened #%d.", issue.Index)
-		if err = mailIssueCommentToParticipants(issue, c.Poster, ct, c, mentions); err != nil {
+		if err = mailIssueCommentToParticipants(issue, c.Poster, opType, ct, c, mentions); err != nil {
 			log.Error("mailIssueCommentToParticipants: %v", err)
 		}
 	}

services/mailer/mail_issue.go

@@ -15,15 +15,15 @@ import (
 	"github.com/unknwon/com"
 )
 
-func mailSubject(issue *models.Issue) string {
+func defaultMailSubject(issue *models.Issue) string {
 	return fmt.Sprintf("[%s] %s (#%d)", issue.Repo.FullName(), issue.Title, issue.Index)
 }
 
 // mailIssueCommentToParticipants can be used for both new issue creation and comment.
 // This function sends two list of emails:
 // 1. Repository watchers and users who are participated in comments.
 // 2. Users who are not in 1. but get mentioned in current issue/comment.
-func mailIssueCommentToParticipants(issue *models.Issue, doer *models.User, content string, comment *models.Comment, mentions []string) error {
+func mailIssueCommentToParticipants(issue *models.Issue, doer *models.User, actionType models.ActionType, content string, comment *models.Comment, mentions []string) error {
 	if !setting.Service.EnableNotifyMail {
 		return nil
 	}
@@ -93,7 +93,7 @@ func mailIssueCommentToParticipants(issue *models.Issue, doer *models.User, cont
 	}
 
 	for _, to := range tos {
-		SendIssueCommentMail(issue, doer, content, comment, []string{to})
+		SendIssueCommentMail(issue, doer, actionType, content, comment, []string{to})
 	}
 
 	// Mail mentioned people and exclude watchers.
@@ -110,7 +110,7 @@ func mailIssueCommentToParticipants(issue *models.Issue, doer *models.User, cont
 	emails := models.GetUserEmailsByNames(tos)
 
 	for _, to := range emails {
-		SendIssueMentionMail(issue, doer, content, comment, []string{to})
+		SendIssueMentionMail(issue, doer, actionType, content, comment, []string{to})
 	}
 
 	return nil
@@ -130,7 +130,7 @@ func mailParticipants(ctx models.DBContext, issue *models.Issue, doer *models.Us
 	}
 
 	if len(issue.Content) > 0 {
-		if err = mailIssueCommentToParticipants(issue, doer, issue.Content, nil, mentions); err != nil {
+		if err = mailIssueCommentToParticipants(issue, doer, opType, issue.Content, nil, mentions); err != nil {
 			log.Error("mailIssueCommentToParticipants: %v", err)
 		}
 	}
@@ -139,18 +139,18 @@ func mailParticipants(ctx models.DBContext, issue *models.Issue, doer *models.Us
 	case models.ActionCreateIssue, models.ActionCreatePullRequest:
 		if len(issue.Content) == 0 {
 			ct := fmt.Sprintf("Created #%d.", issue.Index)
-			if err = mailIssueCommentToParticipants(issue, doer, ct, nil, mentions); err != nil {
+			if err = mailIssueCommentToParticipants(issue, doer, opType, ct, nil, mentions); err != nil {
 				log.Error("mailIssueCommentToParticipants: %v", err)
 			}
 		}
 	case models.ActionCloseIssue, models.ActionClosePullRequest:
 		ct := fmt.Sprintf("Closed #%d.", issue.Index)
-		if err = mailIssueCommentToParticipants(issue, doer, ct, nil, mentions); err != nil {
+		if err = mailIssueCommentToParticipants(issue, doer, opType, ct, nil, mentions); err != nil {
 			log.Error("mailIssueCommentToParticipants: %v", err)
 		}
 	case models.ActionReopenIssue, models.ActionReopenPullRequest:
 		ct := fmt.Sprintf("Reopened #%d.", issue.Index)
-		if err = mailIssueCommentToParticipants(issue, doer, ct, nil, mentions); err != nil {
+		if err = mailIssueCommentToParticipants(issue, doer, opType, ct, nil, mentions); err != nil {
 			log.Error("mailIssueCommentToParticipants: %v", err)
 		}
 	}

services/mailer/mail_test.go

@@ -51,13 +51,13 @@ func TestComposeIssueCommentMessage(t *testing.T) {
 	InitMailRender(email)
 
 	tos := []string{"test@gitea.com", "test2@gitea.com"}
-	msg := composeIssueCommentMessage(issue, doer, "test body", comment, mailIssueComment, tos, "issue comment")
+	msg := composeIssueCommentMessage(issue, doer, models.ActionCommentIssue, false, "test body", comment, mailIssueComment, tos, "issue comment")
 
 	subject := msg.GetHeader("Subject")
 	inreplyTo := msg.GetHeader("In-Reply-To")
 	references := msg.GetHeader("References")
 
-	assert.Equal(t, subject[0], "Re: "+mailSubject(issue), "Comment reply subject should contain Re:")
+	assert.Equal(t, subject[0], "Re: "+defaultMailSubject(issue), "Comment reply subject should contain Re:")
 	assert.Equal(t, inreplyTo[0], "<user2/repo1/issues/1@localhost>", "In-Reply-To header doesn't match")
 	assert.Equal(t, references[0], "<user2/repo1/issues/1@localhost>", "References header doesn't match")
 }
@@ -79,12 +79,12 @@ func TestComposeIssueMessage(t *testing.T) {
 	InitMailRender(email)
 
 	tos := []string{"test@gitea.com", "test2@gitea.com"}
-	msg := composeIssueCommentMessage(issue, doer, "test body", nil, mailIssueComment, tos, "issue create")
+	msg := composeIssueCommentMessage(issue, doer, models.ActionCreateIssue, false, "test body", nil, mailIssueComment, tos, "issue create")
 
 	subject := msg.GetHeader("Subject")
 	messageID := msg.GetHeader("Message-ID")
 
-	assert.Equal(t, subject[0], mailSubject(issue), "Subject not equal to issue.mailSubject()")
+	assert.Equal(t, subject[0], defaultMailSubject(issue), "Subject not equal to issue.mailSubject()")
 	assert.Nil(t, msg.GetHeader("In-Reply-To"))
 	assert.Nil(t, msg.GetHeader("References"))
 	assert.Equal(t, messageID[0], "<user2/repo1/issues/1@localhost>", "Message-ID header doesn't match")

templates/mail/issue/subject.tmpl

@@ -0,0 +1,19 @@
+[{{.Repo}}] {{.Doer}}
+{{if eq .Action 6}}
+	created issue #{{.Issue.Index}}
+{{else if eq .Action 7}}
+	created PR #{{.Issue.Index}}
+{{else if eq .Action 10}}
+	commented on #{{.Issue.Index}}
+{{else if eq .Action 12}}
+	closed issue #{{.Issue.Index}}
+{{else if eq .Action 13}}
+	reopened issue #{{.Issue.Index}}
+{{else if eq .Action 14}}
+	closed PR #{{.Issue.Index}}
+{{else if eq .Action 15}}
+	reopened PR #{{.Issue.Index}}
+{{else}}
+	commented/acted upon #{{.Issue.Index}}
+{{end}}
+- {{.Issue.Title}}