You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

mailer.go 9.0 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Copyright 2017 The Gitea Authors. All rights reserved.
  3. // Use of this source code is governed by a MIT-style
  4. // license that can be found in the LICENSE file.
  5. package mailer
  6. import (
  7. "bytes"
  8. "context"
  9. "crypto/tls"
  10. "fmt"
  11. "io"
  12. "net"
  13. "net/smtp"
  14. "os"
  15. "os/exec"
  16. "strings"
  17. "time"
  18. "code.gitea.io/gitea/modules/base"
  19. "code.gitea.io/gitea/modules/graceful"
  20. "code.gitea.io/gitea/modules/log"
  21. "code.gitea.io/gitea/modules/process"
  22. "code.gitea.io/gitea/modules/queue"
  23. "code.gitea.io/gitea/modules/setting"
  24. "github.com/jaytaylor/html2text"
  25. "gopkg.in/gomail.v2"
  26. )
  27. // Message mail body and log info
  28. type Message struct {
  29. Info string // Message information for log purpose.
  30. FromAddress string
  31. FromDisplayName string
  32. To []string
  33. Subject string
  34. Date time.Time
  35. Body string
  36. Headers map[string][]string
  37. }
  38. // ToMessage converts a Message to gomail.Message
  39. func (m *Message) ToMessage() *gomail.Message {
  40. msg := gomail.NewMessage()
  41. msg.SetAddressHeader("From", m.FromAddress, m.FromDisplayName)
  42. msg.SetHeader("To", m.To...)
  43. for header := range m.Headers {
  44. msg.SetHeader(header, m.Headers[header]...)
  45. }
  46. if len(setting.MailService.SubjectPrefix) > 0 {
  47. msg.SetHeader("Subject", setting.MailService.SubjectPrefix+" "+m.Subject)
  48. } else {
  49. msg.SetHeader("Subject", m.Subject)
  50. }
  51. msg.SetDateHeader("Date", m.Date)
  52. msg.SetHeader("X-Auto-Response-Suppress", "All")
  53. plainBody, err := html2text.FromString(m.Body)
  54. if err != nil || setting.MailService.SendAsPlainText {
  55. if strings.Contains(base.TruncateString(m.Body, 100), "<html>") {
  56. log.Warn("Mail contains HTML but configured to send as plain text.")
  57. }
  58. msg.SetBody("text/plain", plainBody)
  59. } else {
  60. msg.SetBody("text/plain", plainBody)
  61. msg.AddAlternative("text/html", m.Body)
  62. }
  63. return msg
  64. }
  65. // SetHeader adds additional headers to a message
  66. func (m *Message) SetHeader(field string, value ...string) {
  67. m.Headers[field] = value
  68. }
  69. // NewMessageFrom creates new mail message object with custom From header.
  70. func NewMessageFrom(to []string, fromDisplayName, fromAddress, subject, body string) *Message {
  71. log.Trace("NewMessageFrom (body):\n%s", body)
  72. return &Message{
  73. FromAddress: fromAddress,
  74. FromDisplayName: fromDisplayName,
  75. To: to,
  76. Subject: subject,
  77. Date: time.Now(),
  78. Body: body,
  79. Headers: map[string][]string{},
  80. }
  81. }
  82. // NewMessage creates new mail message object with default From header.
  83. func NewMessage(to []string, subject, body string) *Message {
  84. return NewMessageFrom(to, setting.MailService.FromName, setting.MailService.FromEmail, subject, body)
  85. }
  86. type loginAuth struct {
  87. username, password string
  88. }
  89. // LoginAuth SMTP AUTH LOGIN Auth Handler
  90. func LoginAuth(username, password string) smtp.Auth {
  91. return &loginAuth{username, password}
  92. }
  93. // Start start SMTP login auth
  94. func (a *loginAuth) Start(server *smtp.ServerInfo) (string, []byte, error) {
  95. return "LOGIN", []byte{}, nil
  96. }
  97. // Next next step of SMTP login auth
  98. func (a *loginAuth) Next(fromServer []byte, more bool) ([]byte, error) {
  99. if more {
  100. switch string(fromServer) {
  101. case "Username:":
  102. return []byte(a.username), nil
  103. case "Password:":
  104. return []byte(a.password), nil
  105. default:
  106. return nil, fmt.Errorf("unknown fromServer: %s", string(fromServer))
  107. }
  108. }
  109. return nil, nil
  110. }
  111. // Sender SMTP mail sender
  112. type smtpSender struct {
  113. }
  114. // Send send email
  115. func (s *smtpSender) Send(from string, to []string, msg io.WriterTo) error {
  116. opts := setting.MailService
  117. host, port, err := net.SplitHostPort(opts.Host)
  118. if err != nil {
  119. return err
  120. }
  121. tlsconfig := &tls.Config{
  122. InsecureSkipVerify: opts.SkipVerify,
  123. ServerName: host,
  124. }
  125. if opts.UseCertificate {
  126. cert, err := tls.LoadX509KeyPair(opts.CertFile, opts.KeyFile)
  127. if err != nil {
  128. return err
  129. }
  130. tlsconfig.Certificates = []tls.Certificate{cert}
  131. }
  132. conn, err := net.Dial("tcp", net.JoinHostPort(host, port))
  133. if err != nil {
  134. return err
  135. }
  136. defer conn.Close()
  137. isSecureConn := opts.IsTLSEnabled || (strings.HasSuffix(port, "465"))
  138. // Start TLS directly if the port ends with 465 (SMTPS protocol)
  139. if isSecureConn {
  140. conn = tls.Client(conn, tlsconfig)
  141. }
  142. client, err := smtp.NewClient(conn, host)
  143. if err != nil {
  144. return fmt.Errorf("NewClient: %v", err)
  145. }
  146. if !opts.DisableHelo {
  147. hostname := opts.HeloHostname
  148. if len(hostname) == 0 {
  149. hostname, err = os.Hostname()
  150. if err != nil {
  151. return err
  152. }
  153. }
  154. if err = client.Hello(hostname); err != nil {
  155. return fmt.Errorf("Hello: %v", err)
  156. }
  157. }
  158. // If not using SMTPS, always use STARTTLS if available
  159. hasStartTLS, _ := client.Extension("STARTTLS")
  160. if !isSecureConn && hasStartTLS {
  161. if err = client.StartTLS(tlsconfig); err != nil {
  162. return fmt.Errorf("StartTLS: %v", err)
  163. }
  164. }
  165. canAuth, options := client.Extension("AUTH")
  166. if canAuth && len(opts.User) > 0 {
  167. var auth smtp.Auth
  168. if strings.Contains(options, "CRAM-MD5") {
  169. auth = smtp.CRAMMD5Auth(opts.User, opts.Passwd)
  170. } else if strings.Contains(options, "PLAIN") {
  171. auth = smtp.PlainAuth("", opts.User, opts.Passwd, host)
  172. } else if strings.Contains(options, "LOGIN") {
  173. // Patch for AUTH LOGIN
  174. auth = LoginAuth(opts.User, opts.Passwd)
  175. }
  176. if auth != nil {
  177. if err = client.Auth(auth); err != nil {
  178. return fmt.Errorf("Auth: %v", err)
  179. }
  180. }
  181. }
  182. if err = client.Mail(from); err != nil {
  183. return fmt.Errorf("Mail: %v", err)
  184. }
  185. for _, rec := range to {
  186. if err = client.Rcpt(rec); err != nil {
  187. return fmt.Errorf("Rcpt: %v", err)
  188. }
  189. }
  190. w, err := client.Data()
  191. if err != nil {
  192. return fmt.Errorf("Data: %v", err)
  193. } else if _, err = msg.WriteTo(w); err != nil {
  194. return fmt.Errorf("WriteTo: %v", err)
  195. } else if err = w.Close(); err != nil {
  196. return fmt.Errorf("Close: %v", err)
  197. }
  198. return client.Quit()
  199. }
  200. // Sender sendmail mail sender
  201. type sendmailSender struct {
  202. }
  203. // Send send email
  204. func (s *sendmailSender) Send(from string, to []string, msg io.WriterTo) error {
  205. var err error
  206. var closeError error
  207. var waitError error
  208. args := []string{"-f", from, "-i"}
  209. args = append(args, setting.MailService.SendmailArgs...)
  210. args = append(args, to...)
  211. log.Trace("Sending with: %s %v", setting.MailService.SendmailPath, args)
  212. pm := process.GetManager()
  213. desc := fmt.Sprintf("SendMail: %s %v", setting.MailService.SendmailPath, args)
  214. ctx, cancel := context.WithTimeout(graceful.GetManager().HammerContext(), setting.MailService.SendmailTimeout)
  215. defer cancel()
  216. cmd := exec.CommandContext(ctx, setting.MailService.SendmailPath, args...)
  217. pipe, err := cmd.StdinPipe()
  218. if err != nil {
  219. return err
  220. }
  221. if err = cmd.Start(); err != nil {
  222. return err
  223. }
  224. pid := pm.Add(desc, cancel)
  225. _, err = msg.WriteTo(pipe)
  226. // we MUST close the pipe or sendmail will hang waiting for more of the message
  227. // Also we should wait on our sendmail command even if something fails
  228. closeError = pipe.Close()
  229. waitError = cmd.Wait()
  230. pm.Remove(pid)
  231. if err != nil {
  232. return err
  233. } else if closeError != nil {
  234. return closeError
  235. } else {
  236. return waitError
  237. }
  238. }
  239. // Sender sendmail mail sender
  240. type dummySender struct {
  241. }
  242. // Send send email
  243. func (s *dummySender) Send(from string, to []string, msg io.WriterTo) error {
  244. buf := bytes.Buffer{}
  245. if _, err := msg.WriteTo(&buf); err != nil {
  246. return err
  247. }
  248. log.Info("Mail From: %s To: %v Body: %s", from, to, buf.String())
  249. return nil
  250. }
  251. var mailQueue queue.Queue
  252. // Sender sender for sending mail synchronously
  253. var Sender gomail.Sender
  254. // NewContext start mail queue service
  255. func NewContext() {
  256. // Need to check if mailQueue is nil because in during reinstall (user had installed
  257. // before but swithed install lock off), this function will be called again
  258. // while mail queue is already processing tasks, and produces a race condition.
  259. if setting.MailService == nil || mailQueue != nil {
  260. return
  261. }
  262. switch setting.MailService.MailerType {
  263. case "smtp":
  264. Sender = &smtpSender{}
  265. case "sendmail":
  266. Sender = &sendmailSender{}
  267. case "dummy":
  268. Sender = &dummySender{}
  269. }
  270. mailQueue = queue.CreateQueue("mail", func(data ...queue.Data) {
  271. for _, datum := range data {
  272. msg := datum.(*Message)
  273. gomailMsg := msg.ToMessage()
  274. log.Trace("New e-mail sending request %s: %s", gomailMsg.GetHeader("To"), msg.Info)
  275. if err := gomail.Send(Sender, gomailMsg); err != nil {
  276. log.Error("Failed to send emails %s: %s - %v", gomailMsg.GetHeader("To"), msg.Info, err)
  277. } else {
  278. log.Trace("E-mails sent %s: %s", gomailMsg.GetHeader("To"), msg.Info)
  279. }
  280. }
  281. }, &Message{})
  282. go graceful.GetManager().RunWithShutdownFns(mailQueue.Run)
  283. }
  284. // SendAsync send mail asynchronously
  285. func SendAsync(msg *Message) {
  286. go func() {
  287. _ = mailQueue.Push(msg)
  288. }()
  289. }
  290. // SendAsyncs send mails asynchronously
  291. func SendAsyncs(msgs []*Message) {
  292. go func() {
  293. for _, msg := range msgs {
  294. _ = mailQueue.Push(msg)
  295. }
  296. }()
  297. }