123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324 |
- // Copyright 2016 The Gogs Authors. All rights reserved.
- // Copyright 2019 The Gitea 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 (
- "bytes"
- "fmt"
- "html/template"
- "mime"
- "path"
- "regexp"
- "strings"
- texttmpl "text/template"
-
- "code.gitea.io/gitea/models"
- "code.gitea.io/gitea/modules/base"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/markup"
- "code.gitea.io/gitea/modules/markup/markdown"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/timeutil"
-
- "gopkg.in/gomail.v2"
- )
-
- const (
- mailAuthActivate base.TplName = "auth/activate"
- mailAuthActivateEmail base.TplName = "auth/activate_email"
- mailAuthResetPassword base.TplName = "auth/reset_passwd"
- mailAuthRegisterNotify base.TplName = "auth/register_notify"
-
- mailNotifyCollaborator base.TplName = "notify/collaborator"
-
- // There's no actual limit for subject in RFC 5322
- mailMaxSubjectRunes = 256
- )
-
- var (
- bodyTemplates *template.Template
- subjectTemplates *texttmpl.Template
- subjectRemoveSpaces = regexp.MustCompile(`[\s]+`)
- )
-
- // InitMailRender initializes the mail renderer
- func InitMailRender(subjectTpl *texttmpl.Template, bodyTpl *template.Template) {
- subjectTemplates = subjectTpl
- bodyTemplates = bodyTpl
- }
-
- // SendTestMail sends a test mail
- func SendTestMail(email string) error {
- return gomail.Send(Sender, NewMessage([]string{email}, "Gitea Test Email!", "Gitea Test Email!").Message)
- }
-
- // SendUserMail sends a mail to the user
- func SendUserMail(language string, u *models.User, tpl base.TplName, code, subject, info string) {
- data := map[string]interface{}{
- "DisplayName": u.DisplayName(),
- "ActiveCodeLives": timeutil.MinutesToFriendly(setting.Service.ActiveCodeLives, language),
- "ResetPwdCodeLives": timeutil.MinutesToFriendly(setting.Service.ResetPwdCodeLives, language),
- "Code": code,
- }
-
- var content bytes.Buffer
-
- if err := bodyTemplates.ExecuteTemplate(&content, string(tpl), data); err != nil {
- log.Error("Template: %v", err)
- return
- }
-
- msg := NewMessage([]string{u.Email}, subject, content.String())
- msg.Info = fmt.Sprintf("UID: %d, %s", u.ID, info)
-
- SendAsync(msg)
- }
-
- // Locale represents an interface to translation
- type Locale interface {
- Language() string
- Tr(string, ...interface{}) string
- }
-
- // SendActivateAccountMail sends an activation mail to the user (new user registration)
- func SendActivateAccountMail(locale Locale, u *models.User) {
- SendUserMail(locale.Language(), u, mailAuthActivate, u.GenerateActivateCode(), locale.Tr("mail.activate_account"), "activate account")
- }
-
- // SendResetPasswordMail sends a password reset mail to the user
- func SendResetPasswordMail(locale Locale, u *models.User) {
- SendUserMail(locale.Language(), u, mailAuthResetPassword, u.GenerateActivateCode(), locale.Tr("mail.reset_password"), "recover account")
- }
-
- // SendActivateEmailMail sends confirmation email to confirm new email address
- func SendActivateEmailMail(locale Locale, u *models.User, email *models.EmailAddress) {
- data := map[string]interface{}{
- "DisplayName": u.DisplayName(),
- "ActiveCodeLives": timeutil.MinutesToFriendly(setting.Service.ActiveCodeLives, locale.Language()),
- "Code": u.GenerateEmailActivateCode(email.Email),
- "Email": email.Email,
- }
-
- var content bytes.Buffer
-
- if err := bodyTemplates.ExecuteTemplate(&content, string(mailAuthActivateEmail), data); err != nil {
- log.Error("Template: %v", err)
- return
- }
-
- msg := NewMessage([]string{email.Email}, locale.Tr("mail.activate_email"), content.String())
- msg.Info = fmt.Sprintf("UID: %d, activate email", u.ID)
-
- SendAsync(msg)
- }
-
- // SendRegisterNotifyMail triggers a notify e-mail by admin created a account.
- func SendRegisterNotifyMail(locale Locale, u *models.User) {
- if setting.MailService == nil {
- log.Warn("SendRegisterNotifyMail is being invoked but mail service hasn't been initialized")
- return
- }
-
- data := map[string]interface{}{
- "DisplayName": u.DisplayName(),
- "Username": u.Name,
- }
-
- var content bytes.Buffer
-
- if err := bodyTemplates.ExecuteTemplate(&content, string(mailAuthRegisterNotify), data); err != nil {
- log.Error("Template: %v", err)
- return
- }
-
- msg := NewMessage([]string{u.Email}, locale.Tr("mail.register_notify"), content.String())
- msg.Info = fmt.Sprintf("UID: %d, registration notify", u.ID)
-
- SendAsync(msg)
- }
-
- // SendCollaboratorMail sends mail notification to new collaborator.
- func SendCollaboratorMail(u, doer *models.User, repo *models.Repository) {
- repoName := path.Join(repo.Owner.Name, repo.Name)
- subject := fmt.Sprintf("%s added you to %s", doer.DisplayName(), repoName)
-
- data := map[string]interface{}{
- "Subject": subject,
- "RepoName": repoName,
- "Link": repo.HTMLURL(),
- }
-
- var content bytes.Buffer
-
- if err := bodyTemplates.ExecuteTemplate(&content, string(mailNotifyCollaborator), data); err != nil {
- log.Error("Template: %v", err)
- return
- }
-
- msg := NewMessage([]string{u.Email}, subject, content.String())
- msg.Info = fmt.Sprintf("UID: %d, add collaborator", u.ID)
-
- SendAsync(msg)
- }
-
- func composeIssueCommentMessage(issue *models.Issue, doer *models.User, actionType models.ActionType, fromMention bool,
- content string, comment *models.Comment, tos []string, info string) *Message {
-
- if err := issue.LoadPullRequest(); err != nil {
- log.Error("LoadPullRequest: %v", err)
- return nil
- }
-
- var (
- subject string
- link string
- prefix string
- // Fall back subject for bad templates, make sure subject is never empty
- fallback string
- )
-
- commentType := models.CommentTypeComment
- if comment != nil {
- prefix = "Re: "
- commentType = comment.Type
- link = issue.HTMLURL() + "#" + comment.HashTag()
- } else {
- link = issue.HTMLURL()
- }
-
- fallback = prefix + fallbackMailSubject(issue)
-
- // This is the body of the new issue or comment, not the mail body
- body := string(markup.RenderByType(markdown.MarkupName, []byte(content), issue.Repo.HTMLURL(), issue.Repo.ComposeMetas()))
-
- actType, actName, tplName := actionToTemplate(issue, actionType, commentType)
-
- mailMeta := map[string]interface{}{
- "FallbackSubject": fallback,
- "Body": body,
- "Link": link,
- "Issue": issue,
- "Comment": comment,
- "IsPull": issue.IsPull,
- "User": issue.Repo.MustOwner(),
- "Repo": issue.Repo.FullName(),
- "Doer": doer,
- "IsMention": fromMention,
- "SubjectPrefix": prefix,
- "ActionType": actType,
- "ActionName": actName,
- }
-
- var mailSubject bytes.Buffer
- if err := subjectTemplates.ExecuteTemplate(&mailSubject, string(tplName), mailMeta); err == nil {
- subject = sanitizeSubject(mailSubject.String())
- } else {
- log.Error("ExecuteTemplate [%s]: %v", string(tplName)+"/subject", err)
- }
-
- if subject == "" {
- subject = fallback
- }
- mailMeta["Subject"] = subject
-
- var mailBody bytes.Buffer
-
- if err := bodyTemplates.ExecuteTemplate(&mailBody, string(tplName), mailMeta); err != nil {
- log.Error("ExecuteTemplate [%s]: %v", string(tplName)+"/body", err)
- }
-
- msg := NewMessageFrom(tos, doer.DisplayName(), setting.MailService.FromEmail, subject, mailBody.String())
- msg.Info = fmt.Sprintf("Subject: %s, %s", subject, info)
-
- // Set Message-ID on first message so replies know what to reference
- if comment == nil {
- msg.SetHeader("Message-ID", "<"+issue.ReplyReference()+">")
- } else {
- msg.SetHeader("In-Reply-To", "<"+issue.ReplyReference()+">")
- msg.SetHeader("References", "<"+issue.ReplyReference()+">")
- }
-
- 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, actionType models.ActionType, content string, comment *models.Comment, tos []string) {
- if len(tos) == 0 {
- return
- }
-
- SendAsync(composeIssueCommentMessage(issue, doer, actionType, false, content, comment, tos, "issue comment"))
- }
-
- // SendIssueMentionMail composes and sends issue mention emails to target receivers.
- 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, actionType, true, content, comment, tos, "issue mention"))
- }
-
- // actionToTemplate returns the type and name of the action facing the user
- // (slightly different from models.ActionType) and the name of the template to use (based on availability)
- func actionToTemplate(issue *models.Issue, actionType models.ActionType, commentType models.CommentType) (typeName, name, template string) {
- if issue.IsPull {
- typeName = "pull"
- } else {
- typeName = "issue"
- }
- switch actionType {
- case models.ActionCreateIssue, models.ActionCreatePullRequest:
- name = "new"
- case models.ActionCommentIssue:
- name = "comment"
- case models.ActionCloseIssue, models.ActionClosePullRequest:
- name = "close"
- case models.ActionReopenIssue, models.ActionReopenPullRequest:
- name = "reopen"
- case models.ActionMergePullRequest:
- name = "merge"
- default:
- switch commentType {
- case models.CommentTypeReview:
- name = "review"
- case models.CommentTypeCode:
- name = "code"
- case models.CommentTypeAssignees:
- name = "assigned"
- default:
- name = "default"
- }
- }
-
- template = typeName + "/" + name
- ok := bodyTemplates.Lookup(template) != nil
- if !ok && typeName != "issue" {
- template = "issue/" + name
- ok = bodyTemplates.Lookup(template) != nil
- }
- if !ok {
- template = typeName + "/default"
- ok = bodyTemplates.Lookup(template) != nil
- }
- if !ok {
- template = "issue/default"
- }
- return
- }
-
- // SendIssueAssignedMail composes and sends issue assigned email
- func SendIssueAssignedMail(issue *models.Issue, doer *models.User, content string, comment *models.Comment, tos []string) {
- SendAsync(composeIssueCommentMessage(issue, doer, models.ActionType(0), false, content, comment, tos, "issue assigned"))
- }
|