comments in main.hs, updated modules.svg

1 files changed, 68 insertions, 30 deletions

diff --git a/Presence/main.hs b/Presence/main.hs
index 8c2371f4..cfc7154c 100644
--- a/Presence/main.hs
+++ b/Presence/main.hs
@@ -57,6 +57,74 @@ import Network.Socket (Family(AF_INET,AF_INET6))
 import           Holumbus.Data.MultiMap as MM (MultiMap)
 import qualified Holumbus.Data.MultiMap as MM
 
+{- PresenceState
+ -
+ - This is the global state for the xmpp daemon.
+ - It is not directly accessed outside of this module.
+ -}
+data PresenceState = PresenceState 
+    { hostname :: Peer -- ByteString, TODO: remove this, its always LocalHost now
+
+    -- currentTTY  -  a string such as "tty7" which is kept up to date as console
+    --                switches occur. 
+    , currentTTY    :: TVar ByteString
+
+    -- activeUsers - a is a set of triples representing data in /var/run/utmp
+    --               it is kept up to date by an inotify watch on that file.
+    , activeUsers   :: TVar (Set (UserName, Tty, ProcessID))
+
+    -- subscriberMap  - the idea was to allow subscribing to a particular user only.
+    --                  When that user becomes present, an announcement would be sent
+    --                  on the channel associated with him.  This functionality is currently
+    --                  unused and may be removed soon if it's decided its unneccessary.
+    , subscriberMap :: TVar (Map JID (RefCount,TChan Presence)) -- UNUSED as yet
+
+    -- localSubscriber  - a channel and reference count where all presence events are
+    --                    announced. 
+    , localSubscriber :: TMVar (RefCount,TChan Presence) -- TODO: rename this, its not just locals
+                                                         -- ... or make a seperate channel for remotes
+
+    -- rosterChannel   - a channel and reference count where all roster change events are
+    --                   announced
+    , rosterChannel :: TMVar (RefCount,TChan RosterEvent)
+
+
+    -- remoteUsers     - a cache of remote users considered to be online.  These are sent to a client
+    --                   on connect so that it can populate it's notion of online users.
+    , remoteUsers :: TVar (Map Peer (RefCount,TVar (MultiMap JabberUser (JabberResource,JabberShow))))
+
+    -- outGoingConnections  - a set of channels that may be used to send messages to remote peers.
+    , outGoingConnections :: TVar (Map Peer (TChan OutBoundMessage, ThreadId)) 
+    }
+
+
+
+
+{- newPresenceState
+ -
+ - This is a smart constructor for the global state.
+ - This is currently used only from Main.start and PresenceState
+ - records are not created by any means other than this constructor.
+ -}
+newPresenceState hostname = atomically $ do
+    tty  <- newTVar ""
+    us   <- newTVar (Set.empty)
+    subs <- newTVar (Map.empty)
+    locals_greedy <- newEmptyTMVar
+    rchan <- newEmptyTMVar
+    remotes <- newTVar (Map.empty)
+    server_connections <- newServerConnections
+    return $ PresenceState hostname tty us subs locals_greedy rchan remotes server_connections
+
+
+data ClientSession = ClientSession {
+    localhost :: Peer, -- ByteString,
+    unix_uid :: (IORef (Maybe (UserID,L.ByteString))),
+    unix_resource :: (IORef (Maybe L.ByteString)),
+    chans :: TVar [RefCountedChan],
+    presence_state :: PresenceState
+}
+
 type RefCount = Int
 
 type JabberResource = L.ByteString
@@ -70,18 +138,6 @@ splitResource (JID (Just n) p r  ) = Just (JabberUser n p, r)
 
 unsplitResource (JabberUser n p) r = JID (Just n) p r
 
-data PresenceState = PresenceState 
-    { hostname :: Peer -- ByteString, TODO: remove this, its always LocalHost now
-    , currentTTY    :: TVar ByteString
-    , activeUsers   :: TVar (Set (UserName, Tty, ProcessID))
-    , subscriberMap :: TVar (Map JID (RefCount,TChan Presence)) -- UNUSED as yet
-    , localSubscriber :: TMVar (RefCount,TChan Presence) -- TODO: rename this, its not just locals
-                                                         -- ... or make a seperate channel for remotes
-    , rosterChannel :: TMVar (RefCount,TChan RosterEvent)
-    , remoteUsers :: TVar (Map Peer (RefCount,TVar (MultiMap JabberUser (JabberResource,JabberShow))))
-    , outGoingConnections :: TVar (Map Peer (TChan OutBoundMessage, ThreadId)) 
-    }
-
 
 rosterPush msg state = do
         let rchan = rosterChannel state
@@ -102,14 +158,6 @@ getJabberUserForId muid =
                         )
                    muid
 
-data ClientSession = ClientSession {
-    localhost :: Peer, -- ByteString,
-    unix_uid :: (IORef (Maybe (UserID,L.ByteString))),
-    unix_resource :: (IORef (Maybe L.ByteString)),
-    chans :: TVar [RefCountedChan],
-    presence_state :: PresenceState
-}
-
 cmpJID newitem jid = do
     -- putStrLn $ "Comparing "<++>bshow jid
     olditem <- parseHostNameJID jid
@@ -513,16 +561,6 @@ update_presence locals_greedy subscribers state getStatus =
         sendPresence chan jid status
       putStrLn $ bshow jid <++> " " <++> bshow status
 
-newPresenceState hostname = atomically $ do
-    tty  <- newTVar ""
-    us   <- newTVar (Set.empty)
-    subs <- newTVar (Map.empty)
-    locals_greedy <- newEmptyTMVar
-    rchan <- newEmptyTMVar
-    remotes <- newTVar (Map.empty)
-    server_connections <- newServerConnections
-    return $ PresenceState hostname tty us subs locals_greedy rchan remotes server_connections
-
 sendProbes state jid = do
     L.putStrLn $ "sending probes for " <++> bshow jid
     withJust (name jid) $ \user -> do