Merge migadu/condstore: add ID, CONDSTORE, QRESYNC, SORT, ENABLE extensions

Incorporates server-side support from upstream PR emersion#690:
- ID (RFC 2971): SessionID interface, handleID command
- CONDSTORE (RFC 7162): HIGHESTMODSEQ, UNCHANGEDSINCE, MODSEQ in FETCH/STORE/SEARCH/SELECT
- QRESYNC (RFC 7162): QRESYNC SELECT params, VANISHED responses, VanishedWriter
- SORT (RFC 5256): SessionSort interface, ESORT support
- ENABLE: patched to accept CONDSTORE/QRESYNC

Author: qasim-nylas

capability.go

@@ -130,7 +130,13 @@ func (set CapSet) Has(c Cap) bool {
 	if c == CapLiteralMinus && set.has(CapLiteralPlus) {
 		return true
 	}
-	if c == CapCondStore && set.has(CapQResync) {
+
+	// IMAP4rev2 implies QRESYNC, which in turn implies CONDSTORE.
+	isQResync := set.has(CapQResync) || set.has(CapIMAP4rev2)
+	if c == CapQResync && isQResync {
+		return true
+	}
+	if c == CapCondStore && isQResync {
 		return true
 	}
 	if c == CapUTF8Accept && set.has(CapUTF8Only) {

fetch.go

@@ -21,6 +21,7 @@ type FetchOptions struct {
 	ModSeq            bool                          // requires CONDSTORE
 
 	ChangedSince uint64 // requires CONDSTORE
+	Vanished     bool   // requires QRESYNC, only valid for UID FETCH
 }
 
 // FetchItemBodyStructure contains FETCH options for the body structure.

go.mod

@@ -5,4 +5,5 @@ go 1.18
 require (
 	github.com/emersion/go-message v0.18.2
 	github.com/emersion/go-sasl v0.0.0-20241020182733-b788ff22d5a6
+	golang.org/x/text v0.14.0
 )

go.sum

@@ -27,6 +27,7 @@ golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=

id.go

@@ -12,4 +12,8 @@ type IDData struct {
 	Command     string
 	Arguments   string
 	Environment string
+
+	// Raw contains all raw key-value pairs. Standard keys are also present
+	// in this map. Keys are case-insensitive and are normalized to lowercase.
+	Raw map[string]string
 }

imapclient/client.go

@@ -154,16 +154,15 @@ type Client struct {
 	decCh  chan struct{}
 	decErr error
 
-	mutex        sync.Mutex
-	state        imap.ConnState
-	caps         imap.CapSet
-	enabled      imap.CapSet
-	pendingCapCh chan struct{}
-	mailbox      *SelectedMailbox
-	cmdTag       uint64
-	pendingCmds  []command
-	contReqs     []continuationRequest
-	closed       bool
+	mutex       sync.Mutex
+	state       imap.ConnState
+	caps        imap.CapSet
+	enabled     imap.CapSet
+	mailbox     *SelectedMailbox
+	cmdTag      uint64
+	pendingCmds []command
+	contReqs    []continuationRequest
+	closed      bool
 }
 
 // New creates a new IMAP client.
@@ -319,58 +318,35 @@ func (c *Client) Caps() imap.CapSet {
 
 	c.mutex.Lock()
 	caps := c.caps
-	capCh := c.pendingCapCh
 	c.mutex.Unlock()
 
 	if caps != nil {
 		return caps
 	}
 
-	if capCh == nil {
-		capCmd := c.Capability()
-		capCh := make(chan struct{})
-		go func() {
-			capCmd.Wait()
-			close(capCh)
-		}()
-		c.mutex.Lock()
-		c.pendingCapCh = capCh
-		c.mutex.Unlock()
-	}
-
-	timer := time.NewTimer(respReadTimeout)
-	defer timer.Stop()
-	select {
-	case <-timer.C:
+	capCmd := c.Capability()
+	caps, err := capCmd.Wait()
+	if err != nil {
 		return nil
-	case <-capCh:
-		// ok
 	}
-
-	// TODO: this is racy if caps are reset before we get the reply
-	c.mutex.Lock()
-	defer c.mutex.Unlock()
-	return c.caps
+	return caps
 }
 
 func (c *Client) setCaps(caps imap.CapSet) {
 	// If the capabilities are being reset, request the updated capabilities
 	// from the server
-	var capCh chan struct{}
 	if caps == nil {
-		capCh = make(chan struct{})
-
 		// We need to send the CAPABILITY command in a separate goroutine:
 		// setCaps might be called with Client.encMutex locked
 		go func() {
 			c.Capability().Wait()
-			close(capCh)
 		}()
 	}
 
 	c.mutex.Lock()
 	c.caps = caps
-	c.pendingCapCh = capCh
+	quotedUTF8 := c.caps.Has(imap.CapIMAP4rev2) || c.enabled.Has(imap.CapUTF8Accept)
+	c.dec.QuotedUTF8 = quotedUTF8
 	c.mutex.Unlock()
 }
 
@@ -986,6 +962,11 @@ func (c *Client) readResponseData(typ string) error {
 		return c.handleFetch(num)
 	case "EXPUNGE":
 		return c.handleExpunge(num)
+	case "VANISHED":
+		if !c.dec.ExpectSP() {
+			return c.dec.Err()
+		}
+		return c.handleVanished()
 	case "SEARCH":
 		return c.handleSearch()
 	case "ESEARCH":
@@ -1026,6 +1007,28 @@ func (c *Client) readResponseData(typ string) error {
 	return nil
 }
 
+func (c *Client) handleVanished() error {
+	var data imap.VanishedData
+	isParen := c.dec.Special('(')
+	if isParen {
+		var tag string
+		if !c.dec.ExpectAtom(&tag) || !c.dec.ExpectSpecial(')') {
+			return c.dec.Err()
+		}
+		data.Earlier = strings.ToUpper(tag) == "EARLIER"
+	}
+
+	if !c.dec.ExpectSP() || !c.dec.ExpectUIDSet(&data.UIDs) {
+		return c.dec.Err()
+	}
+
+	if handler := c.options.unilateralDataHandler().Vanished; handler != nil {
+		handler(&data)
+	}
+
+	return nil
+}
+
 // WaitGreeting waits for the server's initial greeting.
 func (c *Client) WaitGreeting() error {
 	select {
@@ -1202,6 +1205,9 @@ type UnilateralDataHandler struct {
 	Mailbox func(data *UnilateralDataMailbox)
 	Fetch   func(msg *FetchMessageData)
 
+	// requires ENABLE QRESYNC
+	Vanished func(data *imap.VanishedData)
+
 	// Requires ENABLE METADATA or ENABLE SERVER-METADATA.
 	Metadata func(mailbox string, entries []string)
 

imapclient/client_test.go

@@ -102,6 +102,8 @@ func newMemClientServerPair(t *testing.T) (net.Conn, io.Closer) {
 		Caps: imap.CapSet{
 			imap.CapIMAP4rev1: {},
 			imap.CapIMAP4rev2: {},
+			imap.CapCondStore: {},
+			imap.CapQResync:   {},
 		},
 	})
 
@@ -184,6 +186,15 @@ func newClientServerPairWithOptions(t *testing.T, initialState imap.ConnState, o
 		}
 	}
 
+	// Enable CONDSTORE for Dovecot tests (required for CONDSTORE features)
+	if useDovecot && initialState >= imap.ConnStateAuthenticated {
+		if client.Caps().Has(imap.CapCondStore) {
+			if _, err := client.Enable(imap.CapCondStore).Wait(); err != nil {
+				t.Logf("Failed to enable CONDSTORE: %v", err)
+			}
+		}
+	}
+
 	// Turn on debug logs after we're done initializing the test
 	debugWriter.Swap(os.Stderr)