Changeset 148:75cf9e14b776 for wokkel/muc.py

Timestamp:

Aug 12, 2011, 3:57:20 PM (11 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.

File:

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

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