notify MUA on closing connection

3 files changed, 31 insertions, 3 deletions

diff --git a/changes/feature_send_bye b/changes/feature_send_bye
new file mode 100644
index 0000000..5bc3e60
--- /dev/null
+++ b/changes/feature_send_bye
@@ -0,0 +1 @@
+- Send a BYE command to all open connections, so that the MUA is notified when the server is shutted down.
diff --git a/src/leap/mail/imap/server.py b/src/leap/mail/imap/server.py
index abe16be..3e10171 100644
--- a/src/leap/mail/imap/server.py
+++ b/src/leap/mail/imap/server.py
@@ -80,6 +80,20 @@ class LEAPIMAPServer(imap4.IMAP4Server):
         log.msg('rcv (%s): %s' % (self.state, msg))
         imap4.IMAP4Server.lineReceived(self, line)
 
+    def close_server_connection(self):
+        """
+        Send a BYE command so that the MUA at least knows that we're closing
+        the connection.
+        """
+        self.sendLine(
+            '* BYE LEAP IMAP Proxy is shutting down; '
+            'so long and thanks for all the fish')
+        self.transport.loseConnection()
+        if self.mbox:
+            self.mbox.removeListener(self)
+            self.mbox = None
+        self.state = 'unauth'
+
     def authenticateLogin(self, username, password):
         """
         Lookup the account with the given parameters, and deny
diff --git a/src/leap/mail/imap/service/imap.py b/src/leap/mail/imap/service/imap.py
index 3a6b7b8..b3282d4 100644
--- a/src/leap/mail/imap/service/imap.py
+++ b/src/leap/mail/imap/service/imap.py
@@ -21,6 +21,8 @@ IMAP service initialization
 import logging
 import os
 
+from collections import defaultdict
+
 from twisted.internet import reactor
 from twisted.internet.error import CannotListenError
 from twisted.internet.protocol import ServerFactory
@@ -70,6 +72,7 @@ class LeapIMAPFactory(ServerFactory):
     Factory for a IMAP4 server with soledad remote sync and gpg-decryption
     capabilities.
     """
+    protocol = LEAPIMAPServer
 
     def __init__(self, uuid, userid, soledad):
         """
@@ -91,6 +94,7 @@ class LeapIMAPFactory(ServerFactory):
         theAccount = IMAPAccount(uuid, soledad)
         self.theAccount = theAccount
 
+        self._connections = defaultdict()
         # XXX how to pass the store along?
 
     def buildProtocol(self, addr):
@@ -100,15 +104,25 @@ class LeapIMAPFactory(ServerFactory):
         :param addr: remote ip address
         :type addr:  str
         """
-        # XXX addr not used??!
-        imapProtocol = LEAPIMAPServer(
+        # TODO should reject anything from addr != localhost,
+        # just in case.
+        log.msg("Building protocol for connection %s" % addr)
+        imapProtocol = self.protocol(
             uuid=self._uuid,
             userid=self._userid,
             soledad=self._soledad)
         imapProtocol.theAccount = self.theAccount
         imapProtocol.factory = self
+
+        self._connections[addr] = imapProtocol
         return imapProtocol
 
+    def stopFactory(self):
+        # say bye!
+        for conn, proto in self._connections.items():
+            log.msg("Closing connections for %s" % conn)
+            proto.close_server_connection()
+
     def doStop(self):
         """
         Stops imap service (fetcher, factory and port).
@@ -157,7 +171,6 @@ def run_service(store, **kwargs):
         logger.error("Error launching IMAP service: %r" % (exc,))
     else:
         # all good.
-        # (the caller has still to call fetcher.start_loop)
 
         if DO_MANHOLE:
             # TODO get pass from env var.too.