mirror of
https://github.com/go-gitea/gitea
synced 2024-08-19 05:40:43 +02:00
closes #13585 fixes #9067 fixes #2386 ref #6226 ref #6219 fixes #745 This PR adds support to process incoming emails to perform actions. Currently I added handling of replies and unsubscribing from issues/pulls. In contrast to #13585 the IMAP IDLE command is used instead of polling which results (in my opinion 😉) in cleaner code. Procedure: - When sending an issue/pull reply email, a token is generated which is present in the Reply-To and References header. - IMAP IDLE waits until a new email arrives - The token tells which action should be performed A possible signature and/or reply gets stripped from the content. I added a new service to the drone pipeline to test the receiving of incoming mails. If we keep this in, we may test our outgoing emails too in future. Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
376 lines
8.6 KiB
Go
376 lines
8.6 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package incoming
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"fmt"
|
|
net_mail "net/mail"
|
|
"regexp"
|
|
"strings"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/process"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/services/mailer/token"
|
|
|
|
"github.com/dimiro1/reply"
|
|
"github.com/emersion/go-imap"
|
|
"github.com/emersion/go-imap/client"
|
|
"github.com/jhillyerd/enmime"
|
|
)
|
|
|
|
var (
|
|
addressTokenRegex *regexp.Regexp
|
|
referenceTokenRegex *regexp.Regexp
|
|
)
|
|
|
|
func Init(ctx context.Context) error {
|
|
if !setting.IncomingEmail.Enabled {
|
|
return nil
|
|
}
|
|
|
|
var err error
|
|
addressTokenRegex, err = regexp.Compile(
|
|
fmt.Sprintf(
|
|
`\A%s\z`,
|
|
strings.Replace(regexp.QuoteMeta(setting.IncomingEmail.ReplyToAddress), regexp.QuoteMeta(setting.IncomingEmail.TokenPlaceholder), "(.+)", 1),
|
|
),
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
referenceTokenRegex, err = regexp.Compile(fmt.Sprintf(`\Areply-(.+)@%s\z`, regexp.QuoteMeta(setting.Domain)))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
go func() {
|
|
ctx, _, finished := process.GetManager().AddTypedContext(ctx, "Incoming Email", process.SystemProcessType, true)
|
|
defer finished()
|
|
|
|
// This background job processes incoming emails. It uses the IMAP IDLE command to get notified about incoming emails.
|
|
// The following loop restarts the processing logic after errors until ctx indicates to stop.
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
default:
|
|
if err := processIncomingEmails(ctx); err != nil {
|
|
log.Error("Error while processing incoming emails: %v", err)
|
|
}
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-time.NewTimer(10 * time.Second).C:
|
|
}
|
|
}
|
|
}
|
|
}()
|
|
|
|
return nil
|
|
}
|
|
|
|
// processIncomingEmails is the "main" method with the wait/process loop
|
|
func processIncomingEmails(ctx context.Context) error {
|
|
server := fmt.Sprintf("%s:%d", setting.IncomingEmail.Host, setting.IncomingEmail.Port)
|
|
|
|
var c *client.Client
|
|
var err error
|
|
if setting.IncomingEmail.UseTLS {
|
|
c, err = client.DialTLS(server, &tls.Config{InsecureSkipVerify: setting.IncomingEmail.SkipTLSVerify})
|
|
} else {
|
|
c, err = client.Dial(server)
|
|
}
|
|
if err != nil {
|
|
return fmt.Errorf("could not connect to server '%s': %w", server, err)
|
|
}
|
|
|
|
if err := c.Login(setting.IncomingEmail.Username, setting.IncomingEmail.Password); err != nil {
|
|
return fmt.Errorf("could not login: %w", err)
|
|
}
|
|
defer func() {
|
|
if err := c.Logout(); err != nil {
|
|
log.Error("Logout from incoming email server failed: %v", err)
|
|
}
|
|
}()
|
|
|
|
if _, err := c.Select(setting.IncomingEmail.Mailbox, false); err != nil {
|
|
return fmt.Errorf("selecting box '%s' failed: %w", setting.IncomingEmail.Mailbox, err)
|
|
}
|
|
|
|
// The following loop processes messages. If there are no messages available, IMAP IDLE is used to wait for new messages.
|
|
// This process is repeated until an IMAP error occurs or ctx indicates to stop.
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return nil
|
|
default:
|
|
if err := processMessages(ctx, c); err != nil {
|
|
return fmt.Errorf("could not process messages: %w", err)
|
|
}
|
|
if err := waitForUpdates(ctx, c); err != nil {
|
|
return fmt.Errorf("wait for updates failed: %w", err)
|
|
}
|
|
select {
|
|
case <-ctx.Done():
|
|
return nil
|
|
case <-time.NewTimer(time.Second).C:
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// waitForUpdates uses IMAP IDLE to wait for new emails
|
|
func waitForUpdates(ctx context.Context, c *client.Client) error {
|
|
updates := make(chan client.Update, 1)
|
|
|
|
c.Updates = updates
|
|
defer func() {
|
|
c.Updates = nil
|
|
}()
|
|
|
|
errs := make(chan error, 1)
|
|
stop := make(chan struct{})
|
|
go func() {
|
|
errs <- c.Idle(stop, nil)
|
|
}()
|
|
|
|
stopped := false
|
|
for {
|
|
select {
|
|
case update := <-updates:
|
|
switch update.(type) {
|
|
case *client.MailboxUpdate:
|
|
if !stopped {
|
|
close(stop)
|
|
stopped = true
|
|
}
|
|
default:
|
|
}
|
|
case err := <-errs:
|
|
if err != nil {
|
|
return fmt.Errorf("imap idle failed: %w", err)
|
|
}
|
|
return nil
|
|
case <-ctx.Done():
|
|
return nil
|
|
}
|
|
}
|
|
}
|
|
|
|
// processMessages searches unread mails and processes them.
|
|
func processMessages(ctx context.Context, c *client.Client) error {
|
|
criteria := imap.NewSearchCriteria()
|
|
criteria.WithoutFlags = []string{imap.SeenFlag}
|
|
criteria.Smaller = setting.IncomingEmail.MaximumMessageSize
|
|
ids, err := c.Search(criteria)
|
|
if err != nil {
|
|
return fmt.Errorf("imap search failed: %w", err)
|
|
}
|
|
|
|
if len(ids) == 0 {
|
|
return nil
|
|
}
|
|
|
|
seqset := new(imap.SeqSet)
|
|
seqset.AddNum(ids...)
|
|
messages := make(chan *imap.Message, 10)
|
|
|
|
section := &imap.BodySectionName{}
|
|
|
|
errs := make(chan error, 1)
|
|
go func() {
|
|
errs <- c.Fetch(
|
|
seqset,
|
|
[]imap.FetchItem{section.FetchItem()},
|
|
messages,
|
|
)
|
|
}()
|
|
|
|
handledSet := new(imap.SeqSet)
|
|
loop:
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
break loop
|
|
case msg, ok := <-messages:
|
|
if !ok {
|
|
if setting.IncomingEmail.DeleteHandledMessage && !handledSet.Empty() {
|
|
if err := c.Store(
|
|
handledSet,
|
|
imap.FormatFlagsOp(imap.AddFlags, true),
|
|
[]interface{}{imap.DeletedFlag},
|
|
nil,
|
|
); err != nil {
|
|
return fmt.Errorf("imap store failed: %w", err)
|
|
}
|
|
|
|
if err := c.Expunge(nil); err != nil {
|
|
return fmt.Errorf("imap expunge failed: %w", err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
err := func() error {
|
|
r := msg.GetBody(section)
|
|
if r == nil {
|
|
return fmt.Errorf("could not get body from message: %w", err)
|
|
}
|
|
|
|
env, err := enmime.ReadEnvelope(r)
|
|
if err != nil {
|
|
return fmt.Errorf("could not read envelope: %w", err)
|
|
}
|
|
|
|
if isAutomaticReply(env) {
|
|
log.Debug("Skipping automatic email reply")
|
|
return nil
|
|
}
|
|
|
|
t := searchTokenInHeaders(env)
|
|
if t == "" {
|
|
log.Debug("Incoming email token not found in headers")
|
|
return nil
|
|
}
|
|
|
|
handlerType, user, payload, err := token.ExtractToken(ctx, t)
|
|
if err != nil {
|
|
if _, ok := err.(*token.ErrToken); ok {
|
|
log.Info("Invalid incoming email token: %v", err)
|
|
return nil
|
|
}
|
|
return err
|
|
}
|
|
|
|
handler, ok := handlers[handlerType]
|
|
if !ok {
|
|
return fmt.Errorf("unexpected handler type: %v", handlerType)
|
|
}
|
|
|
|
content := getContentFromMailReader(env)
|
|
|
|
if err := handler.Handle(ctx, content, user, payload); err != nil {
|
|
return fmt.Errorf("could not handle message: %w", err)
|
|
}
|
|
|
|
handledSet.AddNum(msg.SeqNum)
|
|
|
|
return nil
|
|
}()
|
|
if err != nil {
|
|
log.Error("Error while processing incoming email[%v]: %v", msg.Uid, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
if err := <-errs; err != nil {
|
|
return fmt.Errorf("imap fetch failed: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// isAutomaticReply tests if the headers indicate an automatic reply
|
|
func isAutomaticReply(env *enmime.Envelope) bool {
|
|
autoSubmitted := env.GetHeader("Auto-Submitted")
|
|
if autoSubmitted != "" && autoSubmitted != "no" {
|
|
return true
|
|
}
|
|
autoReply := env.GetHeader("X-Autoreply")
|
|
if autoReply == "yes" {
|
|
return true
|
|
}
|
|
autoRespond := env.GetHeader("X-Autorespond")
|
|
return autoRespond != ""
|
|
}
|
|
|
|
// searchTokenInHeaders looks for the token in To, Delivered-To and References
|
|
func searchTokenInHeaders(env *enmime.Envelope) string {
|
|
if addressTokenRegex != nil {
|
|
to, _ := env.AddressList("To")
|
|
|
|
token := searchTokenInAddresses(to)
|
|
if token != "" {
|
|
return token
|
|
}
|
|
|
|
deliveredTo, _ := env.AddressList("Delivered-To")
|
|
|
|
token = searchTokenInAddresses(deliveredTo)
|
|
if token != "" {
|
|
return token
|
|
}
|
|
}
|
|
|
|
references := env.GetHeader("References")
|
|
for {
|
|
begin := strings.IndexByte(references, '<')
|
|
if begin == -1 {
|
|
break
|
|
}
|
|
begin++
|
|
|
|
end := strings.IndexByte(references, '>')
|
|
if end == -1 || begin > end {
|
|
break
|
|
}
|
|
|
|
match := referenceTokenRegex.FindStringSubmatch(references[begin:end])
|
|
if len(match) == 2 {
|
|
return match[1]
|
|
}
|
|
|
|
references = references[end+1:]
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
// searchTokenInAddresses looks for the token in an address
|
|
func searchTokenInAddresses(addresses []*net_mail.Address) string {
|
|
for _, address := range addresses {
|
|
match := addressTokenRegex.FindStringSubmatch(address.Address)
|
|
if len(match) != 2 {
|
|
continue
|
|
}
|
|
|
|
return match[1]
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
type MailContent struct {
|
|
Content string
|
|
Attachments []*Attachment
|
|
}
|
|
|
|
type Attachment struct {
|
|
Name string
|
|
Content []byte
|
|
}
|
|
|
|
// getContentFromMailReader grabs the plain content and the attachments from the mail.
|
|
// A potential reply/signature gets stripped from the content.
|
|
func getContentFromMailReader(env *enmime.Envelope) *MailContent {
|
|
attachments := make([]*Attachment, 0, len(env.Attachments))
|
|
for _, attachment := range env.Attachments {
|
|
attachments = append(attachments, &Attachment{
|
|
Name: attachment.FileName,
|
|
Content: attachment.Content,
|
|
})
|
|
}
|
|
|
|
return &MailContent{
|
|
Content: reply.FromText(env.Text),
|
|
Attachments: attachments,
|
|
}
|
|
}
|