Changeset 148:75cf9e14b776

Timestamp:

Aug 12, 2011, 3:57:20 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

Redo room configuration.

• The underlying request object now derives from generic.Request.
• MUCClient.getConfiguration now returns a wokkel.data_form.Form.
• MUCClient.configure now takes a simple dictionary of values.

Location:

wokkel

Files:

• iwokkel.py (modified) (1 diff)
• muc.py (modified) (3 diffs)
• test/test_muc.py (modified) (3 diffs)

wokkel/iwokkel.py

@@ -798 +798 @@
 
 
-    def configure(room_jid, fields=[]):
-        """Configure a room. When a user has administration privledges they can configure 
-        a room. 
-
-        @param room_jid: A XMPP entity for the room.
-        @type room_jid: L{jid.JID}
-
-        @param fields: A list of fields to change or add to the room's configuration.
-        @type fields: C{list}
-
-        """
-
-    def getConfigureForm(room_jid):
-        """
-        In order to know the fields to change in a room you will need to get the form.
-        
-        @param room_jid: The room you want the configuration form from.
-        @type room_jid: L{jid.JID}
-
-        """
+    def configure(roomJID, options):
+        """
+        Configure a room.
+
+        @param roomJID: The room to configure.
+        @type roomJID: L{jid.JID}
+
+        @param options: A mapping of field names to values, or C{None} to cancel.
+        @type options: C{dict}
+        """
+
+
+    def getConfiguration(roomJID):
+        """
+        Grab the configuration from the room.
+
+        This sends an iq request to the room.
+
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @return: A deferred that fires with the room's configuration form as
+            a L{data_form.Form} or C{None} if there are no configuration
+            options available.
+        """
+
 
     def join(server, room, nick):

wokkel/muc.py

@@ -44 +44 @@
 
 
-class ConfigureRequest(xmlstream.IQ):
+class ConfigureRequest(generic.Request):
     """
     Configure MUC room request.
@@ -54 +54 @@
     """
 
-    def __init__(self, xs, method='get', fields=[]):
-        xmlstream.IQ.__init__(self, xs, method)
-        q = self.addElement((NS_MUC_OWNER, 'query'))
-        if method == 'set':
-            # build data form
-            form = data_form.Form('submit', formNamespace=NS_MUC_CONFIG)
-            q.addChild(form.toElement())
-
-            for f in fields:
-                # create a field
-                form.addField(f)
+    def __init__(self, recipient, sender=None, options=None):
+        if options is None:
+            stanzaType = 'get'
+        else:
+            stanzaType = 'set'
+
+        generic.Request.__init__(self, recipient, sender, stanzaType)
+        self.options = options
+
+
+    def toElement(self):
+        element = generic.Request.toElement(self)
+
+        query = element.addElement((NS_MUC_OWNER, 'query'))
+        if self.options is None:
+            # This is a request for the configuration form.
+            form = None
+        elif not self.options:
+            form = data_form.Form(formType='cancel')
+        else:
+            form = data_form.Form(formType='submit', formNamespace=NS_MUC_CONFIG)
+            form.makeFields(self.options)
+
+        if form:
+            query.addChild(form.toElement())
+
+        return element
 
 
@@ -826 +842 @@
 
 
-    def configure(self, roomJID, fields=[]):
+    def configure(self, roomJID, options):
         """
         Configure a room.
 
+        @param roomJID: The room to configure.
+        @type roomJID: L{jid.JID}
+
+        @param options: A mapping of field names to values, or C{None} to cancel.
+        @type options: C{dict}
+        """
+        if not options:
+            options = False
+        request = ConfigureRequest(recipient=roomJID, options=options)
+        return self.request(request)
+
+
+    def getConfiguration(self, roomJID):
+        """
+        Grab the configuration from the room.
+
+        This sends an iq request to the room.
+
         @param roomJID: The bare JID of the room.
         @type roomJID: L{jid.JID}
 
-        @param fields: The fields we want to modify.
-        @type fields: A L{list} or L{dataform.Field}
-        """
-        request = ConfigureRequest(self.xmlstream, method='set', fields=fields)
-        request['to'] = roomJID
-
-        return request.send()
-
-
-    def getConfigureForm(self, roomJID):
-        """
-        Grab the configuration form from the room.
-
-        This sends an iq request to the room.
-
-        @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
-        """
-        request = ConfigureRequest(self.xmlstream)
-        request['to'] = roomJID
-        return request.send()
+        @return: A deferred that fires with the room's configuration form as
+            a L{data_form.Form} or C{None} if there are no configuration
+            options available.
+        """
+        def cb(response):
+            form = data_form.findForm(response.query, NS_MUC_CONFIG)
+            return form
+
+        request = ConfigureRequest(recipient=roomJID, options=None)
+        d = self.request(request)
+        d.addCallback(cb)
+        return d
 
 

wokkel/test/test_muc.py

@@ -20 +20 @@
 from wokkel import data_form, iwokkel, muc
 from wokkel.generic import parseXml
-from wokkel.test.helpers import XmlStreamStub, TestableStreamManager
+from wokkel.test.helpers import TestableStreamManager
 
 
@@ -590 +590 @@
 
 
-    def test_roomConfigure(self):
+    def test_configure(self):
         """
         Default configure and changing the room name.
@@ -598 +598 @@
             self.assertEquals('result', iq['type'], 'Not a result')
 
-
-        fields = []
-
-        fields.append(data_form.Field(label='Natural-Language Room Name',
-                                      var='muc#roomconfig_roomname',
-                                      value=self.roomIdentifier))
-
-        d = self.protocol.configure(self.roomJID, fields)
-        d.addCallback(cb)
-
-        iq = self.stub.output[-1]
-        query = "/iq/query[@xmlns='%s']/x"% muc.NS_MUC_OWNER
-        self.assertTrue(xpath.matches(query, iq), 'Bad configure request')
+        values = {'muc#roomconfig_roomname': self.roomIdentifier}
+
+        d = self.protocol.configure(self.roomJID, values)
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+
+        self.assertEquals('set', iq.getAttribute('type'))
+        self.assertEquals(self.roomJID.full(), iq.getAttribute('to'))
+
+        query = "/iq/query[@xmlns='%s']" % (muc.NS_MUC_OWNER)
+        nodes = xpath.queryForNodes(query, iq)
+        self.assertNotIdentical(None, nodes, 'Bad configure request')
+
+        form = data_form.findForm(nodes[0], muc.NS_MUC_CONFIG)
+        self.assertNotIdentical(None, form, 'Missing configuration form')
+        self.assertEquals('submit', form.formType)
 
         response = toResponse(iq, 'result')
         self.stub.send(response)
+        return d
+
+
+    def test_configureCancel(self):
+        """
+        Cancelling room configuration should send a cancel form.
+        """
+
+        d = self.protocol.configure(self.roomJID, None)
+
+        iq = self.stub.output[-1]
+
+        query = "/iq/query[@xmlns='%s']" % (muc.NS_MUC_OWNER)
+        nodes = xpath.queryForNodes(query, iq)
+
+        form = data_form.findForm(nodes[0], muc.NS_MUC_CONFIG)
+        self.assertNotIdentical(None, form, 'Missing configuration form')
+        self.assertEquals('cancel', form.formType)
+
+        response = toResponse(iq, 'result')
+        self.stub.send(response)
+        return d
+
+
+    def test_getConfiguration(self):
+        """
+        The response of a configure form request should extract the form.
+        """
+
+        def cb(form):
+            self.assertEquals('form', form.formType)
+
+        d = self.protocol.getConfiguration(self.roomJID)
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+
+        query = "/iq/query[@xmlns='%s']" % (muc.NS_MUC_OWNER)
+        nodes = xpath.queryForNodes(query, iq)
+        self.assertNotIdentical(None, nodes, 'Missing query element')
+
+        self.assertRaises(StopIteration, nodes[0].elements().next)
+
+        xml = u"""
+            <iq from='%s' id='%s' to='%s' type='result'>
+              <query xmlns='http://jabber.org/protocol/muc#owner'>
+                <x xmlns='jabber:x:data' type='form'>
+                  <field type='hidden'
+                         var='FORM_TYPE'>
+                    <value>http://jabber.org/protocol/muc#roomconfig</value>
+                  </field>
+                  <field label='Natural-Language Room Name'
+                         type='text-single'
+                         var='muc#roomconfig_roomname'/>
+                </x>
+              </query>
+            </iq>
+        """ % (self.roomJID, iq['id'], self.userJID)
+        self.stub.send(parseXml(xml))
+
+        return d
+
+
+    def test_getConfigurationNoOptions(self):
+        """
+        The response of a configure form request should extract the form.
+        """
+
+        def cb(form):
+            self.assertIdentical(None, form)
+
+        d = self.protocol.getConfiguration(self.roomJID)
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+
+        xml = u"""
+            <iq from='%s' id='%s' to='%s' type='result'>
+              <query xmlns='http://jabber.org/protocol/muc#owner'/>
+            </iq>
+        """ % (self.roomJID, iq['id'], self.userJID)
+        self.stub.send(parseXml(xml))
+
         return d