Changeset 153:bf4b940f3547 for wokkel/muc.py

Timestamp:

Sep 2, 2011, 9:56:49 AM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

Improve UserPresence? parsing, clean up MUCClient, approach full test coverage.

• Parse muc#user item elements from incoming presence.
• Properly interpret status codes in muc#user extension; there can be more than one and they should be used as integers.
• Give observers of responses to joins, leaves and nick changes a lower priority than the general presence observers inherited from PresenceProtocol?. This ensures that the Room/User? administration in MUCClient is processed before the deferred for these actions fire.
• Use roomJID to create Room instances, instead of the separate roomIdentifier and server arguments. Also store this roomJID on the Room.
• Change prototype for receivedSubject to include user argument.
• Make several callback functions nested functions within the methods that use them, instead of method on the class itself.

File:

• wokkel/muc.py (modified) (13 diffs)

wokkel/muc.py

@@ -356 +356 @@
     """
 
-    statusCode = None
+    affiliation = None
+    role = None
+    entity = None
+    nick = None
+
+    statusCodes = None
 
     childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}
 
     def _childParser_mucUser(self, element):
+        statusCodes = set()
+
         for child in element.elements():
             if child.uri != NS_MUC_USER:
                 continue
+
             elif child.name == 'status':
-                self.statusCode = child.getAttribute('code')
-            # TODO: item, destroy
-
+                try:
+                    statusCode = int(child.getAttribute('code'))
+                except (TypeError, ValueError):
+                    continue
+
+                statusCodes.add(statusCode)
+
+            elif child.name == 'item':
+                if child.hasAttribute('jid'):
+                    self.entity = jid.JID(child['jid'])
+
+                self.nick = child.getAttribute('nick')
+                self.affiliation = child.getAttribute('affiliation')
+                self.role = child.getAttribute('role')
+
+                for reason in child.elements(NS_MUC_ADMIN, 'reason'):
+                    self.reason = unicode(reason)
+
+            # TODO: destroy
+
+        if statusCodes:
+            self.statusCodes = statusCodes
 
 
@@ -496 +523 @@
         query = "/presence[@from='%s' or (@from='%s' and @type='error')]" % (
                 stanza.recipient.full(), stanza.recipient.userhost())
-        self.xmlstream.addOnetimeObserver(query, onResponse, priority=1)
+        self.xmlstream.addOnetimeObserver(query, onResponse, priority=-1)
         self.xmlstream.send(stanza.toElement())
         return d
@@ -1041 +1068 @@
     a client.
 
-    @ivar roomIdentifier: The Room ID of the MUC room.
-    @type roomIdentifier: C{unicode}
-
-    @ivar service: The server where the MUC room is located.
-    @type service: C{unicode}
+    @ivar roomJID: The Room JID of the MUC room.
+    @type roomJID: L{JID}
 
     @ivar nick: The nick name for the client in this room.
@@ -1054 +1078 @@
 
     @ivar occupantJID: The JID of the occupant in the room. Generated from
-        roomIdentifier, service, and nick.
+        roomJID and nick.
     @type occupantJID: L{jid.JID}
     """
 
 
-    def __init__(self, roomIdentifier, service, nick, state=None):
+    def __init__(self, roomJID, nick, state=None):
         """
         Initialize the room.
         """
-        self.roomIdentifier = roomIdentifier
-        self.service = service
+        self.roomJID = roomJID
         self.setNick(nick)
         self.state = state
@@ -1074 +1097 @@
 
     def setNick(self, nick):
-        self.occupantJID = jid.internJID(u"%s@%s/%s" % (self.roomIdentifier,
-                                                        self.service,
-                                                        nick))
+        self.occupantJID = jid.internJID(u"%s/%s" % (self.roomJID, nick))
         self.nick = nick
 
@@ -1168 +1189 @@
 
 
-    def _removeRoom(self, occupantJID):
+    def _removeRoom(self, roomJID):
         """
         Delete a room from the room collection.
         """
-        roomJID = occupantJID.userhostJID()
         if roomJID in self._rooms:
             del self._rooms[roomJID]
 
 
-    def unavailableReceived(self, presence):
-        """
-        Unavailable presence was received.
-
-        If this was received from a MUC room occupant JID, that occupant has
-        left the room.
-        """
-
-        occupantJID = presence.sender
-
-        if occupantJID:
-            self._userLeavesRoom(occupantJID)
-
-
-    def errorReceived(self, presence):
-        """
-        Error presence was received.
-
-        If this was received from a MUC room occupant JID, we conclude the
-        occupant has left the room.
-        """
-        occupantJID = presence.sender
-
-        if occupantJID:
-            self._userLeavesRoom(occupantJID)
-
-
-    def _userLeavesRoom(self, occupantJID):
+    def _getRoomUser(self, stanza):
+        """
+        Lookup the room and user associated with the stanza's sender.
+        """
+        occupantJID = stanza.sender
+
+        if not occupantJID:
+            return None, None
+
         # when a user leaves a room we need to update it
         room = self._getRoom(occupantJID.userhostJID())
         if room is None:
             # not in the room yet
+            return None, None
+
+        # Check if user is in roster
+        nick = occupantJID.resource
+        user = room.getUser(nick)
+
+        return room, user
+
+
+    def unavailableReceived(self, presence):
+        """
+        Unavailable presence was received.
+
+        If this was received from a MUC room occupant JID, that occupant has
+        left the room.
+        """
+
+        room, user = self._getRoomUser(presence)
+
+        if room is None or user is None:
             return
-        # check if user is in roster
-        user = room.getUser(occupantJID.resource)
+
+        room.removeUser(user)
+        self.userLeftRoom(room, user)
+
+
+    def availableReceived(self, presence):
+        """
+        Available presence was received.
+        """
+
+        room, user = self._getRoomUser(presence)
+
+        if room is None:
+            return
+
         if user is None:
-            return
+            nick = presence.sender.resource
+            user = User(nick, presence.entity)
+
+        # Update user status
+        user.status = presence.status
+        user.show = presence.show
+
         if room.inRoster(user):
-            room.removeUser(user)
-            self.userLeftRoom(room, user)
-
-
-    def availableReceived(self, presence):
-        """
-        Available presence was received.
-        """
-
-        occupantJID = presence.sender
-
-        if not occupantJID:
-            return
-
-        # grab room
-        room = self._getRoom(occupantJID.userhostJID())
-        if room is None:
-            # not in the room yet
-            return
-
-        user = self._changeUserStatus(room, occupantJID, presence.status,
-                                      presence.show)
-
-        if room.inRoster(user):
-            # we changed status or nick
-            if presence.statusCode:
-                room.status = presence.statusCode # XXX
-            else:
-                self.userUpdatedStatus(room, user, presence.show,
-                                       presence.status)
+            self.userUpdatedStatus(room, user, presence.show, presence.status)
         else:
             room.addUser(user)
@@ -1257 +1268 @@
         L{receivedGroupChat}, L{receivedHistory} or L{receivedHistory}.
         """
-        occupantJID = message.sender
-        if not occupantJID:
+        room, user = self._getRoomUser(message)
+
+        if room is None:
             return
-
-        roomJID = occupantJID.userhostJID()
-
-        room = self._getRoom(roomJID)
-        if room is None:
-            # not in the room yet
-            return
-
-        if occupantJID.resource:
-            user = room.getUser(occupantJID.resource)
-        else:
-            # This message is from the room itself.
-            user = None
 
         if message.subject:
@@ -1282 +1281 @@
 
 
-    def _joinedRoom(self, presence):
-        """
-        We have presence that says we joined a room.
-        """
-        roomJID = presence.sender.userhostJID()
-
-        # change the state of the room
-        room = self._getRoom(roomJID)
-        room.state = 'joined'
-
-        # grab status
-        if presence.statusCode:
-            room.status = presence.statusCode
-
-        return room
-
-
-    def _leftRoom(self, presence):
-        """
-        We have presence that says we left a room.
-        """
-        occupantJID = presence.sender
-
-        # change the state of the room
-        self._removeRoom(occupantJID)
-
-        return True
-
-
     def userJoinedRoom(self, room, user):
         """
@@ -1353 +1323 @@
 
 
-    def receivedSubject(self, room, subject):
-        """
+    def receivedSubject(self, room, user, subject):
+        """
+        A (new) room subject has been received.
+
         This method will need to be modified inorder for clients to
         do something when this event occurs.
@@ -1401 +1373 @@
     def join(self, roomJID, nick, historyOptions=None,
                    password=None):
-        room = Room(roomJID.user, roomJID.host, nick, state='joining')
+        """
+        Join a MUC room by sending presence to it.
+
+        @param roomJID: The JID of the room the entity is joining.
+        @type roomJID: L{jid.JID}
+
+        @param nick: The nick name for the entitity joining the room.
+        @type nick: C{unicode}
+
+        @param historyOptions: Options for conversation history sent by the
+            room upon joining.
+        @type historyOptions: L{HistoryOptions}
+
+        @param password: Optional password for the room.
+        @type password: C{unicode}
+
+        @return: A deferred that fires with the room when the entity is in the
+            room, or with a failure if an error has occurred.
+        """
+        def cb(presence):
+            """
+            We have presence that says we joined a room.
+            """
+            room.state = 'joined'
+            return room
+
+        def eb(failure):
+            self._removeRoom(roomJID)
+            return failure
+
+        room = Room(roomJID, nick, state='joining')
         self._addRoom(room)
 
         d = MUCClientProtocol.join(self, roomJID, nick, historyOptions,
                                          password)
-        d.addCallback(self._joinedRoom)
+        d.addCallbacks(cb, eb)
         return d
-
-
-    def _changeUserStatus(self, room, occupantJID, status, show):
-        """
-        Change the user status in a room.
-        """
-
-        # check if user is in roster
-        user = room.getUser(occupantJID.resource)
-        if user is None: # create a user that does not exist
-            user = User(occupantJID.resource)
-
-        if status is not None:
-            user.status = unicode(status)
-        if show is not None:
-            user.show = unicode(show)
-
-        return user
-
-
-    def _changed(self, presence, occupantJID):
-        """
-        Callback for changing the nick and status.
-        """
-        room = self._getRoom(occupantJID.userhostJID())
-        self._changeUserStatus(room, occupantJID, presence.status, presence.show)
-
-        return room
 
 
@@ -1450 +1424 @@
         @type nick: C{unicode}
         """
+        def cb(presence):
+            # Presence confirmation, change the nickname.
+            room.setNick(nick)
+            return room
+
         room = self._getRoom(roomJID)
 
-        # Change the nickname
-        room.setNick(nick)
-
         d = MUCClientProtocol.nick(self, roomJID, nick)
-        d.addCallback(self._changed, room.occupantJID)
+        d.addCallback(cb)
         return d
 
@@ -1469 +1445 @@
         @type roomJID: L{jid.JID}
         """
+        def cb(presence):
+            self._removeRoom(roomJID)
+
         d = MUCClientProtocol.leave(self, roomJID)
-        d.addCallback(self._leftRoom)
+        d.addCallback(cb)
         return d
 
@@ -1492 +1471 @@
         room = self._getRoom(roomJID)
         d = MUCClientProtocol.status(self, roomJID, show, status)
-        d.addCallback(self._changed, room.occupantJID)
+        d.addCallback(lambda _: room)
         return d