From 3ac2079f2761a80930fc235a27742c7c86c2eba0 Mon Sep 17 00:00:00 2001
From: Philipp Balzarek <p.balzarek@googlemail.com>
Date: Sat, 1 Jun 2013 17:45:33 +0200
Subject: [PATCH] add Finished state to ConnectionState

---
 source/Network/Xmpp/Stream.hs | 37 ++++++++++++++++++++---------------
 source/Network/Xmpp/Tls.hs    |  7 +++++--
 source/Network/Xmpp/Types.hs  |  1 +
 3 files changed, 27 insertions(+), 18 deletions(-)

diff --git a/source/Network/Xmpp/Stream.hs b/source/Network/Xmpp/Stream.hs
index 6bc9832..a3df8ea 100644
--- a/source/Network/Xmpp/Stream.hs
+++ b/source/Network/Xmpp/Stream.hs
@@ -122,11 +122,12 @@ startStream = runErrorT $ do
     -- state of the stream.
     let expectedTo = case ( streamConnectionState st
                           , toJid $ streamConfiguration st) of
-          (Plain  , (Just (jid, True)))  -> Just jid
-          (Plain  , _                 )  -> Nothing
-          (Secured, (Just (jid, _   )))  -> Just jid
-          (Secured, Nothing           )  -> Nothing
-          (Closed , _                 )  -> Nothing
+          (Plain    , (Just (jid, True)))  -> Just jid
+          (Plain    , _                 )  -> Nothing
+          (Secured  , (Just (jid, _   )))  -> Just jid
+          (Secured  , Nothing           )  -> Nothing
+          (Closed   , _                 )  -> Nothing
+          (Finished , _                 )  -> Nothing
     case streamAddress st of
         Nothing -> do
             lift $ lift $ errorM "Pontarius.XMPP" "Server sent no hostname."
@@ -338,6 +339,7 @@ closeStreams' = do
         threadDelay 3000000 -- TODO: Configurable value
         void ((Ex.try cc) :: IO (Either Ex.SomeException ()))
         return ()
+    put xmppNoStream{ streamConnectionState = Finished }
     collectElems []
   where
     -- Pulls elements from the stream until the stream ends, or an error is
@@ -470,18 +472,21 @@ catchPush p = ExL.catch
          _ -> ExL.throwIO e
     )
 
+zeroHandle :: StreamHandle
+zeroHandle = StreamHandle { streamSend = \_ -> return False
+                          , streamReceive = \_ -> do
+                                 errorM "Pontarius.XMPP"
+                                        "xmppNoStream: Stream is closed."
+                                 ExL.throwIO XmppOtherFailure
+                          , streamFlush = return ()
+                          , streamClose = return ()
+                          }
+
 -- Stream state used when there is no connection.
 xmppNoStream :: StreamState
 xmppNoStream = StreamState {
       streamConnectionState = Closed
-    , streamHandle = StreamHandle { streamSend = \_ -> return False
-                                  , streamReceive = \_ -> do
-                                                            errorM "Pontarius.XMPP" "xmppNoStream: No stream on receive."
-                                                            ExL.throwIO $
-                                                              XmppOtherFailure
-                                  , streamFlush = return ()
-                                  , streamClose = return ()
-                                  }
+    , streamHandle = zeroHandle
     , streamEventSource = zeroSource
     , streamFeatures = StreamFeatures Nothing [] []
     , streamAddress = Nothing
@@ -705,14 +710,14 @@ srvLookup realm resolvSeed = ErrorT $ do
             rest <- orderSublist sublist''
             return $ ((priority, weight, port, domain):rest)
 
--- Closes the connection and updates the XmppConMonad Stream state.
--- killStream :: Stream -> IO (Either ExL.SomeException ())
+-- | Close the connection and updates the XmppConMonad Stream state. Does
+-- not send the stream end tag.
 killStream :: Stream -> IO (Either XmppFailure ())
 killStream = withStream $ do
     cc <- gets (streamClose . streamHandle)
     err <- wrapIOException cc
     -- (ExL.try cc :: IO (Either ExL.SomeException ()))
-    put xmppNoStream
+    put xmppNoStream{ streamConnectionState = Finished }
     return err
 
 -- Sends an IQ request and waits for the response. If the response ID does not
diff --git a/source/Network/Xmpp/Tls.hs b/source/Network/Xmpp/Tls.hs
index f3b8a4e..e477eff 100644
--- a/source/Network/Xmpp/Tls.hs
+++ b/source/Network/Xmpp/Tls.hs
@@ -51,10 +51,13 @@ tls con = Ex.handle (return . Left . TlsError)
     case sState of
         Plain -> return ()
         Closed -> do
-            liftIO $ errorM "Pontarius.Xmpp" "startTls: The stream is closed."
+            liftIO $ errorM "Pontarius.Xmpp.Tls" "The stream is closed."
+            throwError XmppNoStream
+        Finished -> do
+            liftIO $ errorM "Pontarius.Xmpp.Tls" "The stream is finished."
             throwError XmppNoStream
         Secured -> do
-            liftIO $ errorM "Pontarius.Xmpp" "startTls: The stream is already secured."
+            liftIO $ errorM "Pontarius.Xmpp.Tls" "The stream is already secured."
             throwError TlsStreamSecured
     features <- lift $ gets streamFeatures
     case (tlsBehaviour conf, streamTls features) of
diff --git a/source/Network/Xmpp/Types.hs b/source/Network/Xmpp/Types.hs
index 4817d0e..f33166c 100644
--- a/source/Network/Xmpp/Types.hs
+++ b/source/Network/Xmpp/Types.hs
@@ -803,6 +803,7 @@ data ConnectionState
     = Closed  -- ^ No stream has been established
     | Plain   -- ^ Stream established, but not secured via TLS
     | Secured -- ^ Stream established and secured via TLS
+    | Finished -- ^ Stream is closed
       deriving (Show, Eq, Typeable)
 
 -- | Defines operations for sending, receiving, flushing, and closing on a