Changeset 151:fb6eaad60bb8

Timestamp:

Aug 15, 2011, 5:39:17 PM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

Reimplement RegisterRequest? by generalizing the form handling for room config.

Location:

wokkel

Files:

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

wokkel/iwokkel.py

@@ -916 +916 @@
 
 
-    def register(roomJID, fields=[]):
+    def register(roomJID, options):
         """
         Send a request to register for a room.
@@ -923 +923 @@
         @type roomJID: L{jid.JID}
 
-        @param fields: The fields you need to register.
-        @type fields: L{list} of L{dataform.Field}
-        """
-
+        @param options: A mapping of field names to values, or C{None} to
+            cancel.
+        @type options: C{dict}
+        """
 
 

wokkel/muc.py

@@ -33 +33 @@
 NS_MUC_REGISTER = NS_MUC + '#register'
 
-NS_REQUEST = 'jabber:iq:register'
+NS_REGISTER = 'jabber:iq:register'
 
 MESSAGE = '/message'
@@ -44 +44 @@
 
 
-class ConfigureRequest(generic.Request):
-    """
-    Configure MUC room request.
-
-    http://xmpp.org/extensions/xep-0045.html#roomconfig
-
-    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
-    @type method: C{str}
-    """
+class _FormRequest(generic.Request):
+    """
+    Base class for form exchange requests.
+    """
+    requestNamespace = None
+    formNamespace = None
 
     def __init__(self, recipient, sender=None, options=None):
@@ -67 +64 @@
         element = generic.Request.toElement(self)
 
-        query = element.addElement((NS_MUC_OWNER, 'query'))
+        query = element.addElement((self.requestNamespace, 'query'))
         if self.options is None:
             # This is a request for the configuration form.
@@ -74 +71 @@
             form = data_form.Form(formType='cancel')
         else:
-            form = data_form.Form(formType='submit', formNamespace=NS_MUC_CONFIG)
+            form = data_form.Form(formType='submit',
+                                  formNamespace=self.formNamespace)
             form.makeFields(self.options)
 
@@ -84 +82 @@
 
 
-class RegisterRequest(xmlstream.IQ):
-    """
-    Register room request.
-
-    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
-    @type method: C{str}
-    """
-
-    def __init__(self, xs, method='get', fields=[]):
-        xmlstream.IQ.__init__(self, xs, method)
-        q = self.addElement((NS_REQUEST, 'query'))
-        if method == 'set':
-            # build data form
-            form_type = 'submit'
-            form = data_form.Form(form_type, formNamespace=NS_MUC_REGISTER)
-            q.addChild(form.toElement())
-
-            for f in fields:
-                # create a field
-                form.addField(f)
+class ConfigureRequest(_FormRequest):
+    """
+    Configure MUC room request.
+
+    http://xmpp.org/extensions/xep-0045.html#roomconfig
+    """
+
+    requestNamespace = NS_MUC_OWNER
+    formNamespace = NS_MUC_CONFIG
+
+
+
+class RegisterRequest(_FormRequest):
+    """
+    Register request.
+
+    http://xmpp.org/extensions/xep-0045.html#register
+    """
+
+    requestNamespace = NS_REGISTER
+    formNamespace = NS_MUC_REGISTER
 
 
@@ -1087 +1086 @@
 
 
-    def register(self, roomJID, fields=[]):
+    def register(self, roomJID, options):
         """
         Send a request to register for a room.
@@ -1094 +1093 @@
         @type roomJID: L{jid.JID}
 
-        @param fields: The fields you need to register.
-        @type fields: L{list} of L{dataform.Field}
-        """
-        iq = RegisterRequest(self.xmlstream, method='set', fields=fields)
-        iq['to'] = roomJID.userhost()
-        return iq.send()
+        @param options: A mapping of field names to values, or C{None} to
+            cancel.
+        @type options: C{dict}
+        """
+        request = RegisterRequest(recipient=roomJID, options=options)
+        return self.request(request)
 
 

wokkel/test/test_muc.py

@@ -559 +559 @@
         """
 
-        # FIXME: this doesn't really test the registration
-
         def cb(iq):
             # check for a result
             self.assertEquals('result', iq['type'], 'We did not get a result')
 
-        d = self.protocol.register(self.roomJID)
-        d.addCallback(cb)
-
-        iq = self.stub.output[-1]
-        query = "/iq/query[@xmlns='%s']" % muc.NS_REQUEST
-        self.assertTrue(xpath.matches(query, iq), 'Invalid iq register request')
+        d = self.protocol.register(self.roomJID,
+                                   {'muc#register_roomnick': 'thirdwitch'})
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+
+        query = "/iq/query[@xmlns='%s']" % muc.NS_REGISTER
+        nodes = xpath.queryForNodes(query, iq)
+        self.assertNotIdentical(None, nodes, 'Invalid registration request')
+
+        form = data_form.findForm(nodes[0], muc.NS_MUC_REGISTER)
+        self.assertNotIdentical(None, form, 'Missing registration form')
+        self.assertEquals('submit', form.formType)
+        self.assertIn('muc#register_roomnick', form.fields)
+
 
         response = toResponse(iq, 'result')