Changeset 111:a51e5d87ded8 for wokkel

Timestamp:

Oct 3, 2008, 8:50:37 PM (14 years ago)

Author:

Christopher Zorn <tofu@…>

Branch:

wokkel-muc-client-support-24

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/branches/wokkel-muc-client-support-24@72

Message:

add leave room, register for a room and other things for re #24, still need admin and owner stuff, more tests and more docs

Location:

wokkel

Files:

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

wokkel/muc.py

@@ -30 +30 @@
 NS_CONFIG   = NS + '#roomconfig'
 NS_REQUEST  = NS + '#request'
+NS_REGISTER = NS + '#register'
 
 NS_DELAY    = 'urn:xmpp:delay'
+NS_REQUEST  = 'jabber:iq:register'
 
 # ad hoc commands
@@ -138 +140 @@
 
 
+class RegisterRequest(xmlstream.IQ):
+    """
+    Register room 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, 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_REGISTER)
+            q.addChild(form.toElement())        
+            
+            for f in fields:
+                # create a field
+                form.addField(f)
+
 class GroupChat(domish.Element):
     """
@@ -177 +202 @@
         
 
-class BasicPresence(xmppim.Presence):
+class BasicPresence(xmppim.AvailablePresence):
     """
     This behaves like an object providing L{domish.IElement}.
@@ -183 +208 @@
     """
 
-    def __init__(self, to=None, type=None):
-        xmppim.Presence.__init__(self, to, type)
-        
+    def __init__(self, to=None, show=None, statuses=None):
+        xmppim.AvailablePresence.__init__(self, to=to, show=show, statuses=statuses)
         # add muc elements
         x = self.addElement('x', NS)
@@ -229 +253 @@
         self.addChild(form.toElement())            
 
-class PresenceError(BasicPresence):
+class PresenceError(xmppim.Presence):
     """
     This behaves like an object providing L{domish.IElement}.
@@ -236 +260 @@
 
     def __init__(self, error, to=None, frm=None):
-        BasicPresence.__init__(self, to, type='error')
+        xmppim.Presence.__init__(self, to, type='error')
         if frm:
             self['from'] = frm
@@ -266 +290 @@
         return self.rooms.get(room_jid.full().lower())
 
+    def _removeRoom(self, room_jid):
+        if self.rooms.has_key(room_jid.full().lower()):
+            del self.rooms[room_jid.full().lower()]
 
     def _onXPresence(self, prs):
@@ -306 +333 @@
             r = self._getRoom(room_jid)
             if r is None:
-                raise 
+                raise Exception, 'Room Not Found' 
             r.state = 'joined'
             
@@ -316 +343 @@
             d.callback(r)
 
+
+    def _leftRoom(self, d, prs):
+        """We have presence that says we joined a room.
+        """
+        room_jid = jid.internJID(prs['from'])
+        
+        # check for errors
+        if prs.hasAttribute('type') and prs['type'] == 'error':            
+            d.errback(prs)
+        else:    
+            # change the state of the room
+            r = self._getRoom(room_jid)
+            if r is None:
+                raise Exception, 'Room Not Found' 
+            self._removeRoom(room_jid)
+            
+            d.callback(True)
+
     def receivedUserPresence(self, prs):
         """User Presence has been received
@@ -342 +387 @@
         
 
-    def configure(self, room_jid, **kwargs):
+    def configure(self, room_jid, fields=[]):
         """Configure a room
         """
-        request = ConfigureRequest(self.xmlstream, method='set', **kwargs)
+        request = ConfigureRequest(self.xmlstream, method='set', fields=fields)
         request['to'] = room_jid
         
@@ -374 +419 @@
     
 
+    
+    def leave(self, room_jid):
+        """
+        """
+        d = defer.Deferred()
+
+        self._getRoom(room_jid)
+ 
+        p = xmppim.UnavailablePresence(to=r.entity_id)
+        # p['from'] = self.jid.full()
+        self.xmlstream.send(p)
+
+        # add observer for joining the room
+        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s' and type='unavailable']" % (r.entity_id.full()), 
+                                          self._leftRoom, 1, d)
+
+        return d
+    
+
+    
+
     def groupChat(self, to, message, children=None):
         """Send a groupchat message
@@ -386 +452 @@
 
     
+    def register(self, to, fields=[]):
+        iq = RegisterRequest(self.xmlstream, method='set', fields=fields)
+        iq['to'] = to
+        return iq.send()
+
+    def getRegisterForm(self, to):
+        iq = RegisterRequest(self.xmlstream)
+        iq['to'] = to
+        return iq.send()
+
     def subject(self, to, subject):
         """

wokkel/test/test_muc.py

@@ -227 +227 @@
         
     def test_privateMessage(self):
+        
         self.fail('Not Implemented')
 
     def test_register(self):
-        self.fail('Not Implemented')
+        """Test client registering with a room. http://xmpp.org/extensions/xep-0045.html#register
+
+        """
+        
+        def cb(iq):
+            # check for a result
+            self.failUnless(iq['type']=='result', 'We did not get a result')
+        
+        d = self.protocol.register(self.room_jid.userhost())
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        
+        self.failUnless(xpath.matches("/iq/query[@xmlns='%s']" % (muc.NS_REQUEST), iq), 'Invalid iq register request')
+        
+        response = toResponse(iq, 'result')
+        self.stub.send(response)
+        return d
 
     def test_voice(self):
-        
+        """
+        """
         self.protocol.voice(self.room_jid.userhost())
 
         m = self.stub.output[-1]
-        self.failUnless(m.name=='message', "Need to be message stanza")
-        self.failUnless(getattr(m, 'x', None), 'No muc x element')
-
+        
         self.failUnless(xpath.matches("/message/x[@type='submit']/field/value[text()='%s']" % (muc.NS_REQUEST,), m), 'Invalid voice message stanza')
 
 
     def test_roomConfigure(self):
-
-        self.fail('Not Implemented')
-        
-
+        """
+        """
+
+        def cb(iq):
+            self.failUnless(iq['type']=='result', 'Not a result')
+            
+
+        fields = []
+
+        fields.append(data_form.Field(label='Natural-Language Room Name',
+                                      var='muc#roomconfig_roomname',
+                                      value=self.test_room))
+        
+        d = self.protocol.configure(self.room_jid.userhost(), fields)
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        self.failUnless(xpath.matches("/iq/query[@xmlns='%s']/x"% (muc.NS_OWNER,), iq), 'Bad configure request')
+        
+        response = toResponse(iq, 'result')
+        self.stub.send(response)
+        return d
+
+