fix(imap): advertise and clean up IDLE capability (#343)
Co-authored-by: cheek <cheek@cheek-omenbyhpgaminglaptop16n0xxx.omen.lan> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
cd2c879cfd
commit
68dc2f0f47
@ -20,7 +20,14 @@ func Stop() {
|
|||||||
|
|
||||||
// StarTLS 启动TLS端口监听,不加密的代码就懒得写了
|
// StarTLS 启动TLS端口监听,不加密的代码就懒得写了
|
||||||
func StarTLS() {
|
func StarTLS() {
|
||||||
|
instanceTLS = newIMAPServer()
|
||||||
|
log.Infof("IMAP With TLS Server Start On Port :993")
|
||||||
|
if err := instanceTLS.ListenAndServeTLS(":993"); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newIMAPServer() *imapserver.Server {
|
||||||
crt, err := tls.LoadX509KeyPair(config.Instance.SSLPublicKeyPath, config.Instance.SSLPrivateKeyPath)
|
crt, err := tls.LoadX509KeyPair(config.Instance.SSLPublicKeyPath, config.Instance.SSLPrivateKeyPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
@ -37,6 +44,7 @@ func StarTLS() {
|
|||||||
},
|
},
|
||||||
Caps: imap.CapSet{
|
Caps: imap.CapSet{
|
||||||
imap.CapIMAP4rev1: {},
|
imap.CapIMAP4rev1: {},
|
||||||
|
imap.CapIdle: {},
|
||||||
},
|
},
|
||||||
TLSConfig: tlsConfig,
|
TLSConfig: tlsConfig,
|
||||||
InsecureAuth: false,
|
InsecureAuth: false,
|
||||||
@ -46,9 +54,5 @@ func StarTLS() {
|
|||||||
option.DebugWriter = os.Stdout
|
option.DebugWriter = os.Stdout
|
||||||
}
|
}
|
||||||
|
|
||||||
instanceTLS = imapserver.New(option)
|
return imapserver.New(option)
|
||||||
log.Infof("IMAP With TLS Server Start On Port :993")
|
|
||||||
if err := instanceTLS.ListenAndServeTLS(":993"); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,27 +1,55 @@
|
|||||||
package imap_server
|
package imap_server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bufio"
|
||||||
"crypto/tls"
|
"crypto/tls"
|
||||||
"github.com/Jinnrry/pmail/config"
|
"github.com/Jinnrry/pmail/config"
|
||||||
"github.com/Jinnrry/pmail/db"
|
"github.com/Jinnrry/pmail/db"
|
||||||
"github.com/Jinnrry/pmail/models"
|
"github.com/Jinnrry/pmail/models"
|
||||||
"github.com/Jinnrry/pmail/utils/array"
|
"github.com/Jinnrry/pmail/utils/array"
|
||||||
|
pcontext "github.com/Jinnrry/pmail/utils/context"
|
||||||
|
"github.com/Jinnrry/pmail/utils/password"
|
||||||
"github.com/emersion/go-imap/v2"
|
"github.com/emersion/go-imap/v2"
|
||||||
"github.com/emersion/go-imap/v2/imapclient"
|
"github.com/emersion/go-imap/v2/imapclient"
|
||||||
"github.com/emersion/go-message/charset"
|
"github.com/emersion/go-message/charset"
|
||||||
"mime"
|
"mime"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
var clientUnLogin *imapclient.Client
|
var clientUnLogin *imapclient.Client
|
||||||
var clientLogin *imapclient.Client
|
var clientLogin *imapclient.Client
|
||||||
|
var imapTestAddr string
|
||||||
|
|
||||||
func TestMain(m *testing.M) {
|
func TestMain(m *testing.M) {
|
||||||
|
wd, err := os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
config.ROOT_PATH = filepath.Clean(filepath.Join(wd, "../..")) + string(os.PathSeparator)
|
||||||
config.Init()
|
config.Init()
|
||||||
db.Init("")
|
if err := db.Init(""); err != nil {
|
||||||
go StarTLS()
|
panic(err)
|
||||||
time.Sleep(2 * time.Second)
|
}
|
||||||
|
seedIMAPTestData()
|
||||||
|
crt, err := tls.LoadX509KeyPair(config.Instance.SSLPublicKeyPath, config.Instance.SSLPrivateKeyPath)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
ln, err := tls.Listen("tcp", "127.0.0.1:0", &tls.Config{Certificates: []tls.Certificate{crt}})
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
imapTestAddr = ln.Addr().String()
|
||||||
|
instanceTLS = newIMAPServer()
|
||||||
|
go func() {
|
||||||
|
if err := instanceTLS.Serve(ln); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
options := &imapclient.Options{
|
options := &imapclient.Options{
|
||||||
WordDecoder: &mime.WordDecoder{CharsetReader: charset.Reader},
|
WordDecoder: &mime.WordDecoder{CharsetReader: charset.Reader},
|
||||||
@ -30,13 +58,12 @@ func TestMain(m *testing.M) {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
var err error
|
clientUnLogin, err = imapclient.DialTLS(imapTestAddr, options)
|
||||||
clientUnLogin, err = imapclient.DialTLS("127.0.0.1:993", options)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
clientLogin, err = imapclient.DialTLS("127.0.0.1:993", options)
|
clientLogin, err = imapclient.DialTLS(imapTestAddr, options)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
@ -46,7 +73,49 @@ func TestMain(m *testing.M) {
|
|||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
m.Run()
|
code := m.Run()
|
||||||
|
clientUnLogin.Close()
|
||||||
|
clientLogin.Close()
|
||||||
|
Stop()
|
||||||
|
os.Exit(code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func seedIMAPTestData() {
|
||||||
|
var user models.User
|
||||||
|
_, err := db.Instance.Table(&models.User{}).Where("account=?", "testCase").Get(&user)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
if user.ID == 0 {
|
||||||
|
user = models.User{Account: "testCase", Name: "testCase", Password: password.Encode("testCase")}
|
||||||
|
if _, err = db.Instance.Insert(&user); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var num int
|
||||||
|
_, err = db.Instance.Table(&models.UserEmail{}).Where("user_id=?", user.ID).Select("count(1)").Get(&num)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
if num > 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
statuses := []int8{3}
|
||||||
|
for i := 0; i < 10; i++ {
|
||||||
|
statuses = append(statuses, 0)
|
||||||
|
}
|
||||||
|
for _, status := range statuses {
|
||||||
|
email := models.Email{Subject: "test", Status: status}
|
||||||
|
if _, err = db.Instance.Insert(&email); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
ue := models.UserEmail{UserID: user.ID, EmailID: email.Id, Status: status}
|
||||||
|
if _, err = db.Instance.Insert(&ue); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCapability(t *testing.T) {
|
func TestCapability(t *testing.T) {
|
||||||
@ -59,6 +128,14 @@ func TestCapability(t *testing.T) {
|
|||||||
t.Error("Capability Error")
|
t.Error("Capability Error")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
res, err = clientLogin.Capability().Wait()
|
||||||
|
if err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
if _, ok := res["IDLE"]; !ok {
|
||||||
|
t.Error("IDLE Capability Error")
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLogin(t *testing.T) {
|
func TestLogin(t *testing.T) {
|
||||||
@ -445,7 +522,153 @@ func TestNoop(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
func TestIDLE(t *testing.T) {
|
func TestIDLE(t *testing.T) {
|
||||||
|
conn, err := tls.Dial("tcp", imapTestAddr, &tls.Config{InsecureSkipVerify: true})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer conn.Close()
|
||||||
|
|
||||||
|
reader := bufio.NewReader(conn)
|
||||||
|
line, err := reader.ReadString('\n')
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(line, "OK") {
|
||||||
|
t.Fatalf("unexpected greeting: %s", line)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err = conn.Write([]byte("a001 LOGIN testCase testCase\r\n")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if line, err = readTaggedLine(reader, "a001"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(line, "OK") {
|
||||||
|
t.Fatalf("unexpected LOGIN response: %s", line)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err = conn.Write([]byte("a002 SELECT INBOX\r\n")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if line, err = readTaggedLine(reader, "a002"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(line, "OK") {
|
||||||
|
t.Fatalf("unexpected SELECT response: %s", line)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err = conn.Write([]byte("a003 IDLE\r\n")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
line, err = reader.ReadString('\n')
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(line, "+") || !strings.Contains(strings.ToLower(line), "idling") {
|
||||||
|
t.Fatalf("unexpected IDLE continuation: %s", line)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err = conn.Write([]byte("DONE\r\n")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if line, err = readTaggedLine(reader, "a003"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(line, "OK") {
|
||||||
|
t.Fatalf("unexpected DONE response: %s", line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdleNotice(t *testing.T) {
|
||||||
|
updates := make(chan uint32, 1)
|
||||||
|
options := &imapclient.Options{
|
||||||
|
WordDecoder: &mime.WordDecoder{CharsetReader: charset.Reader},
|
||||||
|
TLSConfig: &tls.Config{
|
||||||
|
InsecureSkipVerify: true,
|
||||||
|
},
|
||||||
|
UnilateralDataHandler: &imapclient.UnilateralDataHandler{
|
||||||
|
Mailbox: func(data *imapclient.UnilateralDataMailbox) {
|
||||||
|
if data.NumMessages != nil {
|
||||||
|
updates <- *data.NumMessages
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
client, err := imapclient.DialTLS(imapTestAddr, options)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer client.Close()
|
||||||
|
|
||||||
|
if err = client.Login("testCase", "testCase").Wait(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
selected, err := client.Select("INBOX", &imap.SelectOptions{}).Wait()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
idleCmd, err := client.Idle()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var user models.User
|
||||||
|
_, err = db.Instance.Table(&models.User{}).Where("account=?", "testCase").Get(&user)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if user.ID == 0 {
|
||||||
|
t.Fatal("test user not found")
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := &pcontext.Context{UserID: user.ID}
|
||||||
|
if err = IdleNotice(ctx, user.ID, &models.Email{Id: 1}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case numMessages := <-updates:
|
||||||
|
if numMessages != selected.NumMessages {
|
||||||
|
t.Fatalf("unexpected IDLE EXISTS update: got %d, want %d", numMessages, selected.NumMessages)
|
||||||
|
}
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("timeout waiting for IDLE update")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err = idleCmd.Close(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err = idleCmd.Wait(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
waitIdleConnectionsDeleted(t, user.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func readTaggedLine(reader *bufio.Reader, tag string) (string, error) {
|
||||||
|
for {
|
||||||
|
line, err := reader.ReadString('\n')
|
||||||
|
if err != nil {
|
||||||
|
return line, err
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(line, tag+" ") {
|
||||||
|
return line, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func waitIdleConnectionsDeleted(t *testing.T, userId int) {
|
||||||
|
t.Helper()
|
||||||
|
deadline := time.Now().Add(2 * time.Second)
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
if _, ok := userConnects.Load(userId); !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
time.Sleep(10 * time.Millisecond)
|
||||||
|
}
|
||||||
|
t.Fatal("idle connections were not cleaned up")
|
||||||
}
|
}
|
||||||
func TestUnselect(t *testing.T) {
|
func TestUnselect(t *testing.T) {
|
||||||
|
|
||||||
|
|||||||
@ -2,35 +2,54 @@ package imap_server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/Jinnrry/pmail/models"
|
"github.com/Jinnrry/pmail/models"
|
||||||
|
"github.com/Jinnrry/pmail/services/group"
|
||||||
"github.com/Jinnrry/pmail/utils/context"
|
"github.com/Jinnrry/pmail/utils/context"
|
||||||
"github.com/emersion/go-imap/v2/imapserver"
|
"github.com/emersion/go-imap/v2/imapserver"
|
||||||
"github.com/spf13/cast"
|
"github.com/spf13/cast"
|
||||||
"sync"
|
"sync"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
type idleConnection struct {
|
||||||
|
writer *imapserver.UpdateWriter
|
||||||
|
mailbox string
|
||||||
|
}
|
||||||
|
|
||||||
|
type idleConnections struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
writers map[string]idleConnection
|
||||||
|
}
|
||||||
|
|
||||||
var userConnects sync.Map
|
var userConnects sync.Map
|
||||||
|
var userConnectsMu sync.Mutex
|
||||||
|
|
||||||
func (s *serverSession) Idle(w *imapserver.UpdateWriter, stop <-chan struct{}) error {
|
func (s *serverSession) Idle(w *imapserver.UpdateWriter, stop <-chan struct{}) error {
|
||||||
connects, ok := userConnects.Load(s.ctx.UserID)
|
userId := s.ctx.UserID
|
||||||
logId := cast.ToString(s.ctx.GetValue(context.LogID))
|
logId := cast.ToString(s.ctx.GetValue(context.LogID))
|
||||||
|
|
||||||
|
userConnectsMu.Lock()
|
||||||
|
connectsAny, ok := userConnects.Load(userId)
|
||||||
if !ok {
|
if !ok {
|
||||||
|
connectsAny = &idleConnections{writers: map[string]idleConnection{}}
|
||||||
connects = map[string]*imapserver.UpdateWriter{
|
userConnects.Store(userId, connectsAny)
|
||||||
logId: w,
|
|
||||||
}
|
|
||||||
userConnects.Store(s.ctx.UserID, connects)
|
|
||||||
} else {
|
|
||||||
connects := connects.(map[string]*imapserver.UpdateWriter)
|
|
||||||
if _, ok := connects[logId]; !ok {
|
|
||||||
connects[logId] = w
|
|
||||||
userConnects.Store(s.ctx.UserID, connects)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
connects := connectsAny.(*idleConnections)
|
||||||
|
|
||||||
|
connects.mu.Lock()
|
||||||
|
connects.writers[logId] = idleConnection{writer: w, mailbox: s.currentMailbox}
|
||||||
|
connects.mu.Unlock()
|
||||||
|
userConnectsMu.Unlock()
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
<-stop
|
<-stop
|
||||||
userConnects.Delete(logId)
|
|
||||||
|
userConnectsMu.Lock()
|
||||||
|
connects.mu.Lock()
|
||||||
|
delete(connects.writers, logId)
|
||||||
|
if len(connects.writers) == 0 {
|
||||||
|
userConnects.Delete(userId)
|
||||||
|
}
|
||||||
|
connects.mu.Unlock()
|
||||||
|
userConnectsMu.Unlock()
|
||||||
}()
|
}()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@ -41,12 +60,34 @@ func IdleNotice(ctx *context.Context, userId int, email *models.Email) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
connects, ok := userConnects.Load(userId)
|
userConnectsMu.Lock()
|
||||||
if ok {
|
connectsAny, ok := userConnects.Load(userId)
|
||||||
connects := connects.(map[string]*imapserver.UpdateWriter)
|
if !ok {
|
||||||
for _, connect := range connects {
|
userConnectsMu.Unlock()
|
||||||
connect.WriteNumMessages(1)
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
connects := connectsAny.(*idleConnections)
|
||||||
|
connects.mu.Lock()
|
||||||
|
idleConnects := make([]idleConnection, 0, len(connects.writers))
|
||||||
|
for _, connect := range connects.writers {
|
||||||
|
idleConnects = append(idleConnects, connect)
|
||||||
|
}
|
||||||
|
connects.mu.Unlock()
|
||||||
|
userConnectsMu.Unlock()
|
||||||
|
|
||||||
|
for _, connect := range idleConnects {
|
||||||
|
connect.writer.WriteNumMessages(idleNumMessages(ctx, userId, connect.mailbox))
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func idleNumMessages(ctx *context.Context, userId int, mailbox string) uint32 {
|
||||||
|
if mailbox == "" {
|
||||||
|
mailbox = "INBOX"
|
||||||
|
}
|
||||||
|
noticeCtx := *ctx
|
||||||
|
noticeCtx.UserID = userId
|
||||||
|
_, data := group.GetGroupStatus(¬iceCtx, mailbox, []string{"MESSAGES"})
|
||||||
|
return cast.ToUint32(data["MESSAGES"])
|
||||||
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user