Changeset 162:8bffd58d7b6d

Timestamp:

Jan 8, 2012, 9:26:06 AM (9 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Expose locked state of a room on join response with room created status.

When the presence in response to a join includes the room created status code
(201), the client should configure the room before it can be used. To enable
this, the locked state of the room is now exposed through the Room.locked
attribute.

Also, update example MUC client to deal with newly created, locked rooms.

Files:

• doc/examples/muc_client.tac (modified) (2 diffs)
• wokkel/muc.py (modified) (4 diffs)
• wokkel/test/test_muc.py (modified) (2 diffs)

doc/examples/muc_client.tac

@@ -16 +16 @@
 
 from twisted.application import service
+from twisted.python import log
 from twisted.words.protocols.jabber.jid import JID
 from wokkel.client import XMPPClient
@@ -42 +43 @@
         """
         Once authorized, join the room.
+
+        If the join action causes a new room to be created, the room will be
+        locked until configured. Here we will just accept the default
+        configuration by submitting an empty form using L{configure}, which
+        usually results in a public non-persistent room.
+
+        Alternatively, you would use L{getConfiguration} to retrieve the
+        configuration form, and then submit the filled in form with the
+        required settings using L{configure}, possibly after presenting it to
+        an end-user.
         """
+        def joinedRoom(room):
+            if room.locked:
+                # Just accept the default configuration. 
+                return self.configure(room.roomJID, {})
+
         MUCClient.connectionInitialized(self)
-        self.join(self.roomJID, self.nick)
+
+        d = self.join(self.roomJID, self.nick)
+        d.addCallback(joinedRoom)
+        d.addCallback(lambda _: log.msg("Joined room"))
+        d.addErrback(log.err, "Join failed")
+
 
     def receivedGroupChat(self, room, user, message):

wokkel/muc.py

@@ -1134 +1134 @@
     @type nick: C{unicode}
 
-    @ivar state: The status code of the room.
-    @type state: L{int}
-
     @ivar occupantJID: The JID of the occupant in the room. Generated from
         roomJID and nick.
     @type occupantJID: L{jid.JID}
-    """
-
-
-    def __init__(self, roomJID, nick, state=None):
+
+    @ivar locked: Flag signalling a locked room. A locked room first needs
+        to be configured before it can be used. See
+        L{MUCClientProtocol.getConfiguration} and
+        L{MUCClientProtocol.configure}.
+    @type locked: C{bool}
+    """
+
+    locked = False
+
+    def __init__(self, roomJID, nick):
         """
         Initialize the room.
@@ -1149 +1153 @@
         self.roomJID = roomJID
         self.setNick(nick)
-        self.state = state
-
-        self.status = 0
-
         self.roster = {}
 
@@ -1456 +1456 @@
             We have presence that says we joined a room.
             """
-            room.state = 'joined'
+            if STATUS_CODE.ROOM_CREATED in presence.mucStatuses:
+                room.locked = True
+
             return room
 
@@ -1463 +1465 @@
             return failure
 
-        room = Room(roomJID, nick, state='joining')
+        room = Room(roomJID, nick)
         self._addRoom(room)
 

wokkel/test/test_muc.py

@@ -1664 +1664 @@
         def cb(room):
             self.assertEqual(self.roomJID, room.roomJID)
-            self.assertTrue('joined', room.state)
+            self.assertFalse(room.locked)
 
         d = self.protocol.join(self.roomJID, self.nick)
@@ -1681 +1681 @@
 
 
+    def test_joinLocked(self):
+        """
+        A new room is locked by default.
+        """
+
+        def cb(room):
+            self.assertTrue(room.locked, "Room is not marked as locked")
+
+        d = self.protocol.join(self.roomJID, self.nick)
+        d.addCallback(cb)
+
+        # send back user presence, they joined
+        xml = """
+            <presence from='%s@%s/%s'>
+              <x xmlns='http://jabber.org/protocol/muc#user'>
+                <item affiliation='owner' role='moderator'/>
+                <status code="110"/>
+                <status code="201"/>
+              </x>
+            </presence>
+        """ % (self.roomIdentifier, self.service, self.nick)
+        self.stub.send(parseXml(xml))
+        return d
+
+
     def test_joinForbidden(self):
         """