Changeset 130:45c3ce4fe4eb for wokkel

Timestamp:

Jun 9, 2009, 7:33:41 PM (13 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

Another round of cleanups, renames. Also removed disco support.

• Whitespace and other PEP-8 cleanups
• Naming changes to clarify and adhere to Twisted style guide.
• Removed disco method, should use DiscoClientProtocol.requestInfo
• Redid invite code, some of the parameters were actually not optional, and passwords should be sent by the service, not the client.

Location:

wokkel

Files:

• disco.py (modified) (1 diff)
• iwokkel.py (modified) (1 diff)
• muc.py (modified) (35 diffs)
• test/test_muc.py (modified) (29 diffs)

wokkel/disco.py

@@ -409 +409 @@
 
 
-class DiscoRequest(xmlstream.IQ):
-    """
-    Disco request.
-
-    @ivar namespace: Request namespace.
-    @type namespace: C{str}
-    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
-    @type method: C{str}
-    """
-
-    def __init__(self, xs, namespace=NS, method='get'):
-        xmlstream.IQ.__init__(self, xs, method)
-        self.addElement((namespace, 'query'))
-
-
-
 class DiscoHandler(XMPPHandler, IQHandlerMixin):
     """

wokkel/iwokkel.py

@@ -799 +799 @@
         """
 
-    
-    def disco(entity, type='info'):
-        """Send disco queries to a XMPP entity
-
-        @param entity: A XMPP entity to send the disco request to.
-        @type entity: C{unicode}
-
-        @param type: Optional argument to determine the type of discovery being done.
-        @type type: C{str}
-
-        """
-
-        
 
     def configure(room_jid, fields=[]):

wokkel/muc.py

@@ -18 +18 @@
 from twisted.words.xish import domish
 
-from wokkel import disco, data_form, xmppim
+from wokkel import data_form, xmppim
 from wokkel.subprotocols import XMPPHandler
 from wokkel.iwokkel import IMUCClient
 
 # Multi User Chat namespaces
-NS_MUC          = 'http://jabber.org/protocol/muc'
-NS_MUC_USER     = NS_MUC + '#user'
-NS_MUC_ADMIN    = NS_MUC + '#admin'
-NS_MUC_OWNER    = NS_MUC + '#owner'
+NS_MUC = 'http://jabber.org/protocol/muc'
+NS_MUC_USER = NS_MUC + '#user'
+NS_MUC_ADMIN = NS_MUC + '#admin'
+NS_MUC_OWNER = NS_MUC + '#owner'
 NS_MUC_ROOMINFO = NS_MUC + '#roominfo'
-NS_MUC_CONFIG   = NS_MUC + '#roomconfig'
-NS_MUC_REQUEST  = NS_MUC + '#request'
+NS_MUC_CONFIG = NS_MUC + '#roomconfig'
+NS_MUC_REQUEST = NS_MUC + '#request'
 NS_MUC_REGISTER = NS_MUC + '#register'
 
-NS_DELAY        = 'urn:xmpp:delay'
+NS_DELAY = 'urn:xmpp:delay'
 NS_JABBER_DELAY = 'jabber:x:delay'
 
-NS_REQUEST  = 'jabber:iq:register'
+NS_REQUEST = 'jabber:iq:register'
 
 # Iq get and set XPath queries
-IQ     = '/iq'
+IQ = '/iq'
 IQ_GET = IQ+'[@type="get"]'
 IQ_SET = IQ+'[@type="set"]'
 
 IQ_RESULT = IQ+'[@type="result"]'
-IQ_ERROR  = IQ+'[@type="error"]'
-
-IQ_QUERY     = IQ+'/query'
+IQ_ERROR = IQ+'[@type="error"]'
+
+IQ_QUERY = IQ+'/query'
 IQ_GET_QUERY = IQ_GET + '/query'
 IQ_SET_QUERY = IQ_SET + '/query'
 
-IQ_COMMAND   = IQ+'/command'
+IQ_COMMAND = IQ+'/command'
 
 MUC_ADMIN = IQ_QUERY+'[@xmlns="' + NS_MUC_ADMIN + '"]'
@@ -57 +57 @@
 
 
-MESSAGE  = '/message'
+MESSAGE = '/message'
 PRESENCE = '/presence'
 
 CHAT_BODY = MESSAGE +'[@type="chat"]/body'
-CHAT      = MESSAGE +'[@type="chat"]'
-
-GROUPCHAT     = MESSAGE +'[@type="groupchat"]/body'
-SUBJECT       = MESSAGE +'[@type="groupchat"]/subject'
+CHAT = MESSAGE +'[@type="chat"]'
+
+GROUPCHAT = MESSAGE +'[@type="groupchat"]/body'
+SUBJECT = MESSAGE +'[@type="groupchat"]/subject'
 MESSAGE_ERROR = MESSAGE +'[@type="error"]'
 
@@ -91 +91 @@
 
     """
-    condition    = 'modify'
+    condition = 'modify'
     mucCondition = 'jid-malformed'
 
@@ -99 +99 @@
     """
     """
-    condition    = 'auth'
+    condition = 'auth'
     mucCondition = 'not-authorized'
 
@@ -107 +107 @@
     """
     """
-    condition    = 'auth'
+    condition = 'auth'
     mucCondition = 'registration-required'
 
@@ -115 +115 @@
     """
     """
-    condition    = 'auth'
+    condition = 'auth'
     mucCondition = 'forbidden'
 
@@ -123 +123 @@
     """
     """
-    condition    = 'cancel'
+    condition = 'cancel'
     mucCondition = 'conflict'
 
@@ -131 +131 @@
     """
     """
-    condition    = 'cancel'
+    condition = 'cancel'
     mucCondition = 'not-found'
 
@@ -139 +139 @@
     """
     """
-    condition    = 'wait'
+    condition = 'wait'
     mucCondition = 'service-unavailable'
 
@@ -385 +385 @@
 
 
-class InviteMessage(PrivateChat):
-    def __init__(self, to, reason=None, full_jid=None, body=None, frm=None, password=None):
-        PrivateChat.__init__(self, to, body=body, frm=frm)
-        del self['type'] # remove type
+class InviteMessage(domish.Element):
+    def __init__(self, bareRoomJID, invitee, reason=None):
+        domish.Element.__init__(self, (None, 'message'))
+        self['to'] = unicode(bareRoomJID)
         x = self.addElement('x', NS_MUC_USER)
         invite = x.addElement('invite')
-        if full_jid:
-            invite['to'] = full_jid
+        invite['to'] = invitee
         if reason:
             invite.addElement('reason', None, reason)
-        if password:
-            invite.addElement('password', None, password)
 
 
@@ -434 +431 @@
 
     def __init__(self, maxchars=None, maxstanzas=None, seconds=None, since=None):
-        self.maxchars   = maxchars
+        self.maxchars = maxchars
         self.maxstanzas = maxstanzas
-        self.seconds    = seconds
-        self.since      = since
+        self.seconds = seconds
+        self.since = since
 
 
@@ -462 +459 @@
     """
 
-    def __init__(self, nick, user_jid=None):
+    def __init__(self, nick, entity=None):
         self.nick = nick
-        self.user_jid = user_jid
+        self.entity = entity
         self.affiliation = 'none'
         self.role = 'none'
 
         self.status = None
-        self.show   = None
+        self.show = None
 
 
@@ -479 +476 @@
 
 
-    def __init__(self, name, server, nick, state=None):
+    def __init__(self, roomIdentifier, service, nick, state=None):
         """
         Initialize the room.
 
-        @ivar name: The name of the MUC room.
-        @type name: L{unicode}
-
-        @ivar server: The server where the MUC room is located.
-        @type server: L{unicode}
+        @ivar roomIdentifier: The Room ID of the MUC room.
+        @type roomIdentifier: L{unicode}
+
+        @ivar service: The server where the MUC room is located.
+        @type service: L{unicode}
 
         @ivar nick: The nick name for the client in this room.
@@ -495 +492 @@
         @type state: L{int}
 
-        @ivar entity_id: The jid of the room. Generated from name, server, and nick.
-        @type entity_id: L{jid.JID}
-
-        """
-        self.state  = state
-        self.name   = name
-        self.server = server
-        self.nick   = nick
+        @ivar roomJID: The JID of the occupant in the room. Generated from roomIdentifier, service, and nick.
+        @type roomJID: L{jid.JID}
+
+        """
+        self.state = state
+        self.roomIdentifier = roomIdentifier
+        self.service = service
+        self.nick = nick
         self.status = 0
 
-        self.entity_id = self.entityId()
+        self.roomJID = self.refreshRoomJID()
 
         self.roster = {}
 
 
-    def entityId(self):
-        """
-        Creates the L{jid.JID} for the room. If name, server, or nick change then this method
-        should be called.
-
-        """
-        self.entity_id = jid.internJID(self.name+'@'+self.server+'/'+self.nick)
-
-        return self.entity_id
+    def refreshRoomJID(self):
+        """
+        Refreshes the Room JID.
+
+        This method should be called whenever roomIdentifier, service, or nick
+        change.
+        """
+        self.roomJID = jid.internJID(u"%s@%s/%s" % (self.roomIdentifier,
+                                                    self.service,
+                                                    self.nick))
+        return self.roomJID
 
 
@@ -666 +665 @@
 class MUCClient(XMPPHandler):
     """
-    Multi-User chat client protocol. This is a subclass of L{XMPPHandler} and implements L{IMUCCLient}.
-
+    Multi-User Chat client protocol.
+
+    This is a subclass of L{XMPPHandler} and implements L{IMUCCLient}.
+
+    @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the
+                  room. Note that a particular entity can only join a room once
+                  at a time.
+    @type _rooms: C{dict}
     """
 
     implements(IMUCClient)
 
-    rooms = {}
-
     timeout = None
 
-    _deferreds = []
+    def __init__(self):
+        XMPPHandler.__init__(self)
+
+        self._rooms = {}
+        self._deferreds = []
+
 
     def connectionInitialized(self):
@@ -694 +702 @@
 
 
-    def _setRoom(self, room):
+    def _addRoom(self, room):
         """
         Add a room to the room collection.
-        """
-        self.rooms[room.entity_id.userhost().lower()] = room
-
-
-    def _getRoom(self, room_jid):
+
+        Rooms are stored by the JID of the room itself. I.e. it uses the Room
+        ID and service parts of the Room JID.
+
+        @note: An entity can only join a particular room once.
+        """
+        bareRoomJID = room.roomJID.userhostJID()
+        self._rooms[bareRoomJID] = room
+
+
+    def _getRoom(self, roomJID):
         """
         Grab a room from the room collection.
-        """
-        return self.rooms.get(room_jid.userhost().lower())
-
-
-    def _removeRoom(self, room_jid):
+
+        This uses the Room ID and service parts of the given JID to look up
+        the L{Room} instance associated with it.
+        """
+        bareRoomJID = roomJID.userhostJID()
+        return self._rooms.get(bareRoomJID)
+
+
+    def _removeRoom(self, roomJID):
         """
         Delete a room from the room collection.
         """
-        if self.rooms.has_key(room_jid.userhost().lower()):
-            del self.rooms[room_jid.userhost().lower()]
+        bareRoomJID = roomJID.userhostJID()
+        if bareRoomJID in self._rooms:
+            del self._rooms[bareRoomJID]
 
 
@@ -777 +796 @@
 
         status = getattr(prs, 'status', None)
-        show   = getattr(prs, 'show', None)
+        show = getattr(prs, 'show', None)
 
         # grab room
@@ -819 +838 @@
             if e.uri == NS_DELAY or e.uri == NS_JABBER_DELAY:
                 delay = e
-        body  = unicode(msg.body)
+        body = unicode(msg.body)
         # grab room
         if delay is None:
@@ -856 +875 @@
         We have presence that says we joined a room.
         """
-        room_jid = jid.internJID(prs['from'])
+        roomJID = jid.internJID(prs['from'])
 
         # check for errors
@@ -863 +882 @@
         else:
             # change the state of the room
-            r = self._getRoom(room_jid)
-            if r is None:
+            room = self._getRoom(roomJID)
+            if room is None:
                 raise NotFound
-            r.state = 'joined'
+            room.state = 'joined'
 
             # grab status
-            status = getattr(prs.x,'status',None)
+            status = getattr(prs.x, 'status', None)
             if status:
-                r.status = status.getAttribute('code', None)
-
-            d.callback(r)
+                room.status = status.getAttribute('code', None)
+
+            d.callback(room)
 
 
     def _leftRoom(self, d, prs):
         """
-        We have presence that says we joined a room.
-        """
-        room_jid = jid.internJID(prs['from'])
+        We have presence that says we left a room.
+        """
+        roomJID = jid.internJID(prs['from'])
 
         # check for errors
@@ -887 +906 @@
         else:
             # change the state of the room
-            r = self._getRoom(room_jid)
-            if r is None:
+            room = self._getRoom(roomJID)
+            if room is None:
                 raise NotFound
-            self._removeRoom(room_jid)
+            self._removeRoom(roomJID)
 
             d.callback(True)
@@ -1008 +1027 @@
 
 
-    def disco(self, entity, type='info'):
-        """
-        Send disco queries to a XMPP entity.
-
-        @param entity: The server or entity where we want discovery information from.
-        @type  entity: L{jid.JID}
-
-        @param type: The optional disco type.
-        @type  type: L{unicode}
-
-        """
-
-        iq = disco.DiscoRequest(self.xmlstream, disco.NS_INFO, 'get')
-        iq['to'] = entity
-
-        return iq.send().addBoth(self._cbDisco)
-
-
     def configure(self, room_jid, fields=[]):
         """
@@ -1056 +1057 @@
 
 
-    def join(self, server, room, nick, history = None):
-        """
-        Join a MUC room by sending presence to it. Returns a defered that is called when
-        the entity is in the room or an error has occurred.
+    def join(self, service, roomIdentifier, nick, history=None):
+        """
+        Join a MUC room by sending presence to it.
 
         @param server: The server where the room is located.
         @type  server: L{unicode}
-
         @param room: The room name the entity is joining.
         @type  room: L{unicode}
-
         @param nick: The nick name for the entitity joining the room.
         @type  nick: L{unicode}
-
         @param history: The maximum number of history stanzas you would like.
 
-        """
-        r = Room(room, server, nick, state='joining')
-        self._setRoom(r)
-
-        p = BasicPresence(to=r.entity_id)
+        @return: A deferred that fires when the entity is in the room or an
+                 error has occurred.
+        """
+        room = Room(roomIdentifier, service, nick, state='joining')
+        self._addRoom(room)
+
+        p = BasicPresence(to=room.roomJID)
         if history is not None:
             p.x.addChild(history.toElement())
@@ -1083 +1082 @@
 
         # add observer for joining the room
-        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s']" % (r.entity_id.full()),
-                                          self._joinedRoom, 1, d)
+        query = PRESENCE + u"[@from='%s']" % room.roomJID
+        self.xmlstream.addOnetimeObserver(query, self._joinedRoom, 1, d)
 
         return d
 
 
-    def _changeUserStatus(self, r, room_jid, status, show):
-        # change the user status in a room.
+    def _changeUserStatus(self, room, roomJID, status, show):
+        """
+        Change the user status in a room.
+        """
 
         # check if user is in roster
-        user = r.getUser(room_jid.resource)
+        user = room.getUser(roomJID.resource)
         if user is None: # create a user that does not exist
-            user = User(room_jid.resource)
+            user = User(roomJID.resource)
 
         if status is not None:
-            user.status = str(status)
+            user.status = unicode(status)
         if show is not None:
-            user.show   = str(show)
+            user.show = unicode(show)
 
         return user
 
 
-    def _changed(self, d, room_jid, prs):
+    def _changed(self, d, roomJID, prs):
         """
         Callback for changing the nick and status.
@@ -1111 +1112 @@
 
         status = getattr(prs, 'status', None)
-        show   = getattr(prs, 'show', None)
-
-        r = self._getRoom(room_jid)
-
-        user = self._changeUserStatus(r, room_jid, status, show)
-
-        d.callback(r)
-
-
-    def nick(self, room_jid, new_nick):
+        show = getattr(prs, 'show', None)
+
+        room = self._getRoom(roomJID)
+
+        user = self._changeUserStatus(room, roomJID, status, show)
+
+        d.callback(room)
+
+
+    def nick(self, bareRoomJID, new_nick):
         """
         Change an entities nick name in a MUC room.
@@ -1126 +1127 @@
         See: http://xmpp.org/extensions/xep-0045.html#changenick
 
-        @param room_jid: The room jabber/xmpp entity id for the requested configuration form.
-        @type  room_jid: L{jid.JID}
+        @param bareRoomJID: The JID of the room, i.e. without a resource.
+        @type bareRoomJID: L{jid.JID}
 
         @param new_nick: The nick name for the entitity joining the room.
-        @type  new_nick: L{unicode}
-
-        """
-
-
-        r = self._getRoom(room_jid)
-        if r is None:
+        @type new_nick: L{unicode}
+
+        """
+
+
+        room = self._getRoom(bareRoomJID)
+        if room is None:
             raise NotFound
-        r.nick = new_nick # change the nick
-        # create presence
-        # make sure we call the method to generate the new entity xmpp id
-        p = BasicPresence(to=r.entityId())
+
+        # Change the nickname
+        room.nick = new_nick
+        room.refreshRoomJID()
+
+        # Create presence
+        p = BasicPresence(to=room.roomJID)
         d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
 
-        # add observer for joining the room
-        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s']" % (r.entity_id.full()),
-                                          self._changed, 1, d, room_jid)
+        # Add observer for joining the room
+        query = PRESENCE+"[@from='%s']" % (room.roomJID.full())
+        self.xmlstream.addOnetimeObserver(query, self._changed, 1, d, bareRoomJID)
 
         return d
 
 
-    def leave(self, room_jid):
+    def leave(self, roomJID):
         """
         Leave a MUC room.
@@ -1157 +1161 @@
         See: http://xmpp.org/extensions/xep-0045.html#exit
 
-        @param room_jid: The room entity id you want to exit.
-        @type  room_jid: L{jid.JID}
-
-        """
-        r = self._getRoom(room_jid)
-
-        p = xmppim.UnavailablePresence(to=r.entity_id)
+        @param roomJID: The Room JID of the room to leave.
+        @type roomJID: L{jid.JID}
+
+        """
+        room = self._getRoom(roomJID)
+
+        p = xmppim.UnavailablePresence(to=room.roomJID)
 
         d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
         # add observer for joining the room
-        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s' and @type='unavailable']" % (r.entity_id.full()),
-                                          self._leftRoom, 1, d)
+        query = PRESENCE + u"[@from='%s' and @type='unavailable']" % (room.roomJID)
+        self.xmlstream.addOnetimeObserver(query, self._leftRoom, 1, d)
 
         return d
 
 
-    def status(self, room_jid, show=None, status=None):
+    def status(self, roomJID, show=None, status=None):
         """
         Change user status.
@@ -1179 +1183 @@
         See: http://xmpp.org/extensions/xep-0045.html#changepres
 
-        @param room_jid: The room jabber/xmpp entity id for the requested configuration form.
-        @type  room_jid: L{jid.JID}
+        @param roomJID: The room jabber/xmpp entity id for the requested configuration form.
+        @type  roomJID: L{jid.JID}
 
         @param show: The availability of the entity. Common values are xa, available, etc
@@ -1189 +1193 @@
 
         """
-        r = self._getRoom(room_jid)
-        if r is None:
+        room = self._getRoom(roomJID)
+        if room is None:
             raise NotFound
 
-        p = BasicPresence(to=r.entityId())
+        p = BasicPresence(to=room.roomJID)
         if status is not None:
             p.addElement('status', None, status)
@@ -1203 +1207 @@
 
         # add observer for joining the room
-        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s']" % (r.entity_id.full()),
-                                          self._changed, 1, d, room_jid)
+        query = PRESENCE + u"[@from='%s']" % room.roomJID
+        self.xmlstream.addOnetimeObserver(query, self._changed, 1, d, roomJID)
 
         return d
@@ -1210 +1214 @@
 
     def _sendMessage(self, msg, children=None):
-        # send a message
+        """
+        Send a message.
+        """
         if children:
-            for c in children:
-                msg.addChild(c)
+            for child in children:
+                msg.addChild(child)
 
         self.xmlstream.send(msg)
@@ -1243 +1249 @@
 
 
-    def invite(self, room_jid, reason=None, full_jid=None):
+    def invite(self, bareRoomJID, reason=None, invitee=None):
         """
         Invite a xmpp entity to a MUC room.
@@ -1249 +1255 @@
         See: http://xmpp.org/extensions/xep-0045.html#invite
 
-        @param room_jid: The room entity id.
-        @type  room_jid: L{jid.JID}
-
+        @param bareRoomJID: The bare JID of the room.
+        @type bareRoomJID: L{jid.JID}
         @param reason: The reason for the invite.
-        @type  reason: L{unicode}
-
-        @param full_jid: The xmpp user's entity id.
-        @type  full_jid: L{jid.JID}
-
-        """
-        msg = InviteMessage(room_jid, reason=reason, full_jid=full_jid)
+        @type reason: L{unicode}
+        @param invitee: The entity that is being invited.
+        @type invitee: L{jid.JID}
+
+        """
+        msg = InviteMessage(bareRoomJID, reason=reason, invitee=invitee)
         self._sendMessage(msg)
 
@@ -1317 +1321 @@
 
 
-    def _setAffiliationList(self, affiliation, room_jid, iq):
+    def _setAffiliationList(self, iq, affiliation, roomJID):
         # set a rooms affiliation list
-        r = self._getRoom(room_jid)
-        if r is not None:
+        room = self._getRoom(roomJID)
+        if room is not None:
             affiliation_list = []
-            setattr(r, affiliation, [])
+            setattr(room, affiliation, [])
 
             for item in iq.query.elements():
-                nick   = item.getAttribute('nick', None)
+                nick = item.getAttribute('nick', None)
                 entity = item.getAttribute('jid', None)
-                u      = None
+                role = item.getAttribute('role', None)
+                user = None
                 if nick is None and entity is None:
                     raise Exception, 'bad attributes in item list'
                 if nick is not None:
-                    u = r.getUser(nick)
-                if u is None:
-                    u = User(nick, user_jid=jid.internJID(entity))
-                    u.affiliation = 'member'
-
-                affiliation_list.append(u)
-
-            setattr(r, affiliation, affiliation_list)
-        return r
-
-
-    def getMemberList(self, room_jid):
-        """
-        Get a member list from a room.
-
-        @param room_jid: The room jabber/xmpp entity id for the requested member list.
-        @type  room_jid: L{jid.JID}
-
-        """
-        d = self._getAffiliationList(room_jid, 'member')
-        d.addCallback(self._setAffiliationList, 'members', room_jid)
+                    user = room.getUser(nick)
+                if user is None:
+                    user = User(nick, entity=jid.internJID(entity))
+                    user.affiliation = 'member'
+                if role is not None:
+                    user.role = role
+
+                affiliation_list.append(user)
+
+            setattr(room, affiliation, affiliation_list)
+        return room
+
+
+    def getMemberList(self, bareRoomJID):
+        """
+        Get the member list of a room.
+
+        @param bareRoomJID: The bare JID of the room.
+        @type  bareRoomJID: L{jid.JID}
+
+        """
+        d = self._getAffiliationList(bareRoomJID, 'member')
+        d.addCallback(self._setAffiliationList, 'members', bareRoomJID)
         return d
 
 
-    def getAdminList(self, room_jid):
-        """
-        Get an admin list from a room.
-
-        @param room_jid: The room jabber/xmpp entity id for the requested member list.
-        @type  room_jid: L{jid.JID}
-
-        """
-        d = self._getAffiliationList(room_jid, 'admin')
-        d.addCallback(self._setAffiliationList, 'members', room_jid)
+    def getAdminList(self, bareRoomJID):
+        """
+        Get the admin list of a room.
+
+        @param bareRoomJID: The bare JID of the room.
+        @type  bareRoomJID: L{jid.JID}
+
+        """
+        d = self._getAffiliationList(bareRoomJID, 'admin')
+        d.addCallback(self._setAffiliationList, 'admin', bareRoomJID)
         return d
 
 
-    def getBanList(self, room_jid):
+    def getBanList(self, bareRoomJID):
         """
         Get an outcast list from a room.
 
-        @param room_jid: The room jabber/xmpp entity id for the requested member list.
-        @type  room_jid: L{jid.JID}
-
-        """
-        d = self._getAffiliationList(room_jid, 'outcast')
-        d.addCallback(self._setAffiliationList, 'members', room_jid)
+        @param bareRoomJID: The bare JID of the room.
+        @type  bareRoomJID: L{jid.JID}
+
+        """
+        d = self._getAffiliationList(bareRoomJID, 'outcast')
+        d.addCallback(self._setAffiliationList, 'outcast', bareRoomJID)
         return d
 
 
-    def getOwnerList(self, room_jid):
+    def getOwnerList(self, bareRoomJID):
         """
         Get an owner list from a room.
 
-        @param room_jid: The room jabber/xmpp entity id for the requested member list.
-        @type  room_jid: L{jid.JID}
-
-        """
-        d = self._getAffiliationList(room_jid, 'owner')
-        d.addCallback(self._setAffiliationList, 'members', room_jid)
+        @param bareRoomJID: The room jabber/xmpp entity id for the requested member list.
+        @type  bareRoomJID: L{jid.JID}
+
+        """
+        d = self._getAffiliationList(bareRoomJID, 'owner')
+        d.addCallback(self._setAffiliationList, 'owner', bareRoomJID)
         return d
 
@@ -1423 +1430 @@
 
         iq = OwnerRequest(self.xmlstream, method='set')
-        d  = iq.query.addElement('destroy')
+        d = iq.query.addElement('destroy')
         d['jid'] = room_jid.userhost()
         if reason is not None:

wokkel/test/test_muc.py

@@ -18 +18 @@
 from twisted.words.protocols.jabber.xmlstream import toResponse
 
+NS_MUC_ADMIN = 'http://jabber.org/protocol/muc#admin'
 
 def calledAsync(fn):
@@ -55 +56 @@
 
     def _createRoom(self):
-        """A helper method to create a test room.
+        """
+        A helper method to create a test room.
         """
         # create a room
         self.current_room = muc.Room(self.test_room, self.test_srv, self.test_nick)
-        self.protocol._setRoom(self.current_room)
+        self.protocol._addRoom(self.current_room)
 
 
@@ -70 +72 @@
 
     def test_userJoinedRoom(self):
-        """The client receives presence from an entity joining the room.
+        """
+        The client receives presence from an entity joining the room.
 
         This tests the class L{muc.UserPresence} and the userJoinedRoom event method.
@@ -85 +88 @@
 
         def userPresence(room, user):
-            self.failUnless(room.name==self.test_room, 'Wrong room name')
+            self.failUnless(room.roomIdentifier==self.test_room, 'Wrong room name')
             self.failUnless(room.inRoster(user), 'User not in roster')
 
@@ -95 +98 @@
 
     def test_groupChat(self):
-        """The client receives a groupchat message from an entity in the room.
+        """
+        The client receives a groupchat message from an entity in the room.
         """
         m = muc.GroupChat('test@test.com',body='test')
@@ -104 +108 @@
         def groupChat(room, user, message):
             self.failUnless(message=='test', "Wrong group chat message")
-            self.failUnless(room.name==self.test_room, 'Wrong room name')
+            self.failUnless(room.roomIdentifier==self.test_room, 'Wrong room name')
 
 
@@ -112 +116 @@
 
 
-    def test_discoServerSupport(self):
-        """Disco support from client to server.
-        """
-        test_srv = 'shakespeare.lit'
-
-        def cb(query):
-            # check namespace
-            self.failUnless(query.uri==disco.NS_INFO, 'Wrong namespace')
-
-
-        d = self.protocol.disco(test_srv)
-        d.addCallback(cb)
-
-        iq = self.stub.output[-1]
-
-        # send back a response
-        response = toResponse(iq, 'result')
-        response.addElement('query', disco.NS_INFO)
-        # need to add information to response
-        response.query.addChild(disco.DiscoFeature(muc.NS_MUC))
-        response.query.addChild(disco.DiscoIdentity(category='conference',
-                                                    name='Macbeth Chat Service',
-                                                    type='text'))
-
-        self.stub.send(response)
-        return d
-
-
     def test_joinRoom(self):
-        """Joining a room
+        """
+        Joining a room
         """
 
         def cb(room):
-            self.assertEquals(self.test_room, room.name)
+            self.assertEquals(self.test_room, room.roomIdentifier)
 
         d = self.protocol.join(self.test_srv, self.test_room, self.test_nick)
@@ -161 +138 @@
 
     def test_joinRoomForbidden(self):
-        """Client joining a room and getting a forbidden error.
+        """
+        Client joining a room and getting a forbidden error.
         """
 
@@ -187 +165 @@
 
     def test_joinRoomBadJid(self):
-        """Client joining a room and getting a forbidden error.
+        """
+        Client joining a room and getting a forbidden error.
         """
 
@@ -213 +192 @@
 
     def test_partRoom(self):
-        """Client leaves a room
+        """
+        Client leaves a room
         """
         def cb(left):
@@ -219 +199 @@
 
 
+        self._createRoom()
         d = self.protocol.leave(self.room_jid)
         d.addCallback(cb)
@@ -235 +216 @@
 
     def test_userPartsRoom(self):
-        """An entity leaves the room, a presence of type unavailable is received by the client.
+        """
+        An entity leaves the room, a presence of type unavailable is received by the client.
         """
 
@@ -251 +233 @@
 
         def userPresence(room, user):
-            self.failUnless(room.name==self.test_room, 'Wrong room name')
+            self.failUnless(room.roomIdentifier==self.test_room, 'Wrong room name')
             self.failUnless(room.inRoster(user)==False, 'User in roster')
 
@@ -260 +242 @@
 
     def test_ban(self):
-        """Ban an entity in a room.
+        """
+        Ban an entity in a room.
         """
         banned = JID('ban@jabber.org/TroubleMakger')
@@ -282 +265 @@
 
     def test_kick(self):
-        """Kick an entity from a room.
+        """
+        Kick an entity from a room.
         """
         kicked = JID('kick@jabber.org/TroubleMakger')
@@ -304 +288 @@
 
     def test_password(self):
-        """Sending a password via presence to a password protected room.
+        """
+        Sending a password via presence to a password protected room.
         """
 
@@ -315 +300 @@
 
     def test_history(self):
-        """Receiving history on room join.
+        """
+        Receiving history on room join.
         """
         m = muc.HistoryMessage(self.room_jid.userhost(), self.protocol._makeTimeStamp(), body='test')
@@ -333 +319 @@
 
     def test_oneToOneChat(self):
-        """Converting a one to one chat to a multi-user chat.
+        """
+        Converting a one to one chat to a multi-user chat.
         """
         archive = []
@@ -365 +352 @@
 
     def test_invite(self):
-        """Invite a user to a room
-        """
-        other_jid = 'test@jabber.org'
-
-        self.protocol.invite(other_jid, 'This is a test')
+        """
+        Invite a user to a room
+        """
+        bareRoomJID = self.room_jid.userhostJID()
+        invitee = JID('test@jabber.org')
+
+        self.protocol.invite(bareRoomJID, 'This is a test', invitee)
 
         msg = self.stub.output[-1]
 
-        self.failUnless(xpath.matches("/message[@to='%s']/x/invite/reason" % (other_jid,), msg), 'Wrong message type')
+        query = u"/message[@to='%s']/x/invite/reason" % bareRoomJID
+        self.failUnless(xpath.matches(query, msg), 'Wrong message type')
 
 
     def test_privateMessage(self):
-        """Send private messages to muc entities.
+        """
+        Send private messages to muc entities.
         """
         other_nick = self.room_jid.userhost()+'/OtherNick'
@@ -389 +380 @@
 
     def test_register(self):
-        """Client registering with a room. http://xmpp.org/extensions/xep-0045.html#register
+        """
+        Client registering with a room. http://xmpp.org/extensions/xep-0045.html#register
 
         """
@@ -410 +402 @@
 
     def test_voice(self):
-        """ Client requesting voice for a room.
+        """
+        Client requesting voice for a room.
         """
         self.protocol.voice(self.room_jid.userhost())
@@ -420 +413 @@
 
     def test_roomConfigure(self):
-        """ Default configure and changing the room name.
+        """
+        Default configure and changing the room name.
         """
 
@@ -445 +439 @@
 
     def test_roomDestroy(self):
-        """ Destroy a room.
+        """
+        Destroy a room.
         """
 
@@ -463 +458 @@
 
     def test_nickChange(self):
-        """Send a nick change to the server.
+        """
+        Send a nick change to the server.
         """
         test_nick = 'newNick'
@@ -470 +466 @@
 
         def cb(room):
-            self.assertEquals(self.test_room, room.name)
+            self.assertEquals(self.test_room, room.roomIdentifier)
             self.assertEquals(test_nick, room.nick)
 
@@ -488 +484 @@
 
     def test_grantVoice(self):
-        """Test granting voice to a user.
+        """
+        Test granting voice to a user.
 
         """
@@ -511 +508 @@
 
     def test_changeStatus(self):
-        """Change status
+        """
+        Change status
         """
         self._createRoom()
@@ -519 +517 @@
 
         def cb(room):
-            self.assertEquals(self.test_room, room.name)
+            self.assertEquals(self.test_room, room.roomIdentifier)
             u = room.getUser(self.room_jid.resource)
             self.failUnless(u is not None, 'User not found')
@@ -539 +537 @@
         self.stub.send(response)
         return d
+
+
+    def test_getMemberList(self):
+        def cb(room):
+            members = room.members
+            self.assertEqual(1, len(members))
+            user = members[0]
+            self.assertEquals(JID(u'hag66@shakespeare.lit'), user.entity)
+            self.assertEquals(u'thirdwitch', user.nick)
+            self.assertEquals(u'participant', user.role)
+
+        self._createRoom()
+        bareRoomJID = self.room_jid.userhostJID()
+        d = self.protocol.getMemberList(bareRoomJID)
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        query = iq.query
+        self.assertNotIdentical(None, query)
+        self.assertEquals(NS_MUC_ADMIN, query.uri)
+
+        response = toResponse(iq, 'result')
+        query = response.addElement((NS_MUC_ADMIN, 'query'))
+        item = query.addElement('item')
+        item['affiliation'] ='member'
+        item['jid'] = 'hag66@shakespeare.lit'
+        item['nick'] = 'thirdwitch'
+        item['role'] = 'participant'
+        self.stub.send(response)
+
+        return d
+
+