Changeset 110:ddf5580b7128 for wokkel

Timestamp:

Oct 1, 2008, 11:11:06 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@71

Message:

add some history and other things, plus some test stubs

Location:

wokkel

Files:

• muc.py (modified) (11 diffs)
• test/test_muc.py (modified) (6 diffs)

wokkel/muc.py

@@ -10 +10 @@
 U{XEP-0045<http://www.xmpp.org/extensions/xep-0045.html>}.
 """
+import datetime
 
 from zope.interface import implements
@@ -28 +29 @@
 NS_ROOMINFO = NS + '#roominfo'
 NS_CONFIG   = NS + '#roomconfig'
+NS_REQUEST  = NS + '#request'
+
+NS_DELAY    = 'urn:xmpp:delay'
 
 # ad hoc commands
@@ -59 +63 @@
 CHAT      = MESSAGE +'[@type="chat"]'
 
-GROUPCHAT    = MESSAGE +'[@type="groupchat"]'
+GROUPCHAT     = MESSAGE +'[@type="groupchat"]/body'
+SUBJECT       = MESSAGE +'[@type="groupchat"]/body'
 MESSAGE_ERROR = MESSAGE +'[@type="error"]'
 
+STATUS_CODES = { # see http://www.xmpp.org/extensions/xep-0045.html#registrar-statuscodes
+    100:
+        {'name':'fulljid',
+         'stanza':'presence',
+         
+         },
+    201: 
+        {'name':'created', 
+         'stanza': 'presence',
+         'context':'Entering a room',
+         'purpose':'Inform user that a new room has been created'
+         },    
+}
+
+STATUS_CODE_CREATED = 201
 
 
@@ -95 +115 @@
 
 
+class ConfigureRequest(xmlstream.IQ):
+    """
+    Configure MUC 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_OWNER, 'query'))
+        if method == 'set':
+            # build data form
+            form = data_form.Form('submit', formNamespace=NS_CONFIG)
+            q.addChild(form.toElement())
+            
+            for f in fields:
+                # create a field
+                form.addField(f)
+
+
+class GroupChat(domish.Element):
+    """
+    """
+    def __init__(self, to, body=None, subject=None, frm=None):
+        """To needs to be a string
+        """
+        domish.Element.__init__(self, (None, 'message'))
+        self['type'] = 'groupchat'
+        self['to']   = to 
+        if frm:
+            self['from'] = frm
+        if body:
+            self.addElement('body',None, body)
+        if subject:
+            self.addElement('subject',None, subject)
+            
+
+
 class Room(object):
     """
@@ -108 +169 @@
         self.server = server
         self.nick   = nick
-        
+        self.status = None
+
         self.entity_id = jid.internJID(name+'@'+server+'/'+nick)
                
@@ -146 +208 @@
 
 
+class PasswordPresence(BasicPresence):
+    """
+    """
+    def __init__(self, to, password):
+        BasicPresence.__init__(self, to)
+        
+        self.x.addElement('password', None, password)
+
+
+class MessageVoice(GroupChat):
+    """
+    """
+    def __init__(self, to=None, frm=None):
+        GroupChat.__init__(self, to=to, frm=frm)
+        # build data form
+        form = data_form.Form('submit', formNamespace=NS_REQUEST)
+        form.addField(data_form.Field(var='muc#role',
+                                      value='participant', 
+                                      label='Requested role'))
+        self.addChild(form.toElement())            
+
 class PresenceError(BasicPresence):
     """
@@ -169 +252 @@
     implements(IMUCClient)
 
+    rooms = {}
 
     def connectionInitialized(self):
-        self.rooms = {}
-        
+        self.xmlstream.addObserver(PRESENCE+"/x", self._onXPresence)
+        self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)
+        self.xmlstream.addObserver(SUBJECT, self._onSubject)
+        # add history
 
     def _setRoom(self, room):
@@ -180 +266 @@
         return self.rooms.get(room_jid.full().lower())
 
+
+    def _onXPresence(self, prs):
+        """
+        """
+        if prs.x.uri == NS_USER:
+            self.receivedUserPresence(prs)
+            
+
+    def _onGroupChat(self, msg):
+        """
+        """
+        self.receivedGroupChat(msg)
+
+
+
+    def _onSubject(self, msg):
+        """
+        """
+        self.receivedSubject(msg)
+
+
+    def _makeTimeStamp(self, stamp=None):
+        if stamp is None:
+            stamp = datetime.datetime.now()
+            
+        return stamp.strftime('%Y%m%dT%H:%M:%S')
 
 
@@ -193 +305 @@
             # change the state of the room
             r = self._getRoom(room_jid)
+            if r is None:
+                raise 
             r.state = 'joined'
+            
+            # grab status
+            status = getattr(prs.x,'status',None)
+            if status:
+                r.status = status.getAttribute('code', None)
+
             d.callback(r)
 
-    def userPresence(self, prs):
+    def receivedUserPresence(self, prs):
         """User Presence has been received
         """
         pass
         
+
+    def receivedSubject(self, msg):
+        """
+        """
+        pass
 
     def _cbDisco(self, iq):
         # grab query
         
-        return iq.query
+        return getattr(iq,'query', None)
         
     def disco(self, entity, type='info'):
@@ -214 +339 @@
         iq['to'] = entity
 
-        return iq.send().addCallback(self._cbDisco)
-        
+        return iq.send().addBoth(self._cbDisco)
+        
+
+    def configure(self, room_jid, **kwargs):
+        """Configure a room
+        """
+        request = ConfigureRequest(self.xmlstream, method='set', **kwargs)
+        request['to'] = room_jid
+        
+        return request.send()
+
+    def getConfigureForm(self, room_jid):
+        request = ConfigureRequest(self.xmlstream)
+        request['to'] = room_jid
+        return request.send()
+
 
     def join(self, server, room, nick):
@@ -235 +374 @@
     
 
+    def groupChat(self, to, message, children=None):
+        """Send a groupchat message
+        """
+        msg = GroupChat(to, body=message)
+
+        if children:
+            for c in children:
+                msg.addChild(c)
+        
+        self.xmlstream.send(msg)
+
+    
+    def subject(self, to, subject):
+        """
+        """
+        msg = GroupChat(to, subject=subject)
+        self.xmlstream.send(msg)
+
+    def voice(self, to):
+        """
+        """
+        msg = MessageVoice(to=to)
+        self.xmlstream.send(msg)
+
+
+    def history(self, to, message_list):
+        """
+        """
+        
+        for m in message_list:
+            m['type'] = 'groupchat'
+            mto = m['to']
+            frm = m.getAttribute('from', None)
+            m['to'] = to
+
+            d = m.addElement('delay', NS_DELAY)
+            d['stamp'] = self._makeTimeStamp()
+            d['from'] = mto 
+
+            self.xmlstream.send(m)
+

wokkel/test/test_muc.py

@@ -49 +49 @@
         self.protocol.xmlstream = self.stub.xmlstream
         self.protocol.connectionInitialized()
-
+        self.test_room = 'test'
+        self.test_srv  = 'conference.example.org'
+        self.test_nick = 'Nick'
+
+        self.room_jid = JID(self.test_room+'@'+self.test_srv+'/'+self.test_nick)
 
     def test_interface(self):
@@ -120 +124 @@
         """Test joining a room
         """
-        test_room = 'test'
-        test_srv  = 'conference.example.org'
-        test_nick = 'Nick'
+        
 
         def cb(room):
-            self.assertEquals(test_room, room.name)
-
-        d = self.protocol.join(test_srv, test_room, test_nick)
+            self.assertEquals(self.test_room, room.name)
+
+        d = self.protocol.join(self.test_srv, self.test_room, self.test_nick)
         d.addCallback(cb)
 
@@ -135 +137 @@
 
         # send back user presence, they joined        
-        response = muc.UserPresence(frm=test_room+'@'+test_srv+'/'+test_nick)
+        response = muc.UserPresence(frm=self.test_room+'@'+self.test_srv+'/'+self.test_nick)
         self.stub.send(response)
         return d
@@ -143 +145 @@
         """Test joining a room and getting an error
         """
-        test_room = 'test'
-        test_srv  = 'conference.example.org'
-        test_nick = 'Nick'
 
         def cb(error):
@@ -152 +151 @@
             
             
-        d = self.protocol.join(test_srv, test_room, test_nick)
+        d = self.protocol.join(self.test_srv, self.test_room, self.test_nick)
         d.addBoth(cb)
 
@@ -163 +162 @@
                                                         'forbidden'
                                                         ),
-                                     frm=test_room+'@'+test_srv+'/'+test_nick)
+                                     frm=self.room_jid.full())
         self.stub.send(response)
         return d        
 
+    def test_partRoom(self):
+        self.fail('Not Implemented')
+        
+
+    def test_ban(self):
+        
+        self.fail('Not Implemented')
+
+    def test_kick(self):
+        self.fail('Not Implemented')
+        
+
+    def test_password(self):
+        """Test sending a password via presence to a password protected room.
+        """
+        
+        
+        self.fail('Not Implemented')
+
+    def test_history(self):
+        
+        self.fail('Not Implemented')
+
+
+    def test_oneToOneChat(self):
+        """Test converting a one to one chat
+        """
+        archive = []
+        thread = "e0ffe42b28561960c6b12b944a092794b9683a38"
+        # create messages
+        msg = domish.Element((None, 'message'))
+        msg['to'] = 'testing@example.com'
+        msg['type'] = 'chat'
+        msg.addElement('body', None, 'test')
+        msg.addElement('thread', None, thread)
+
+        archive.append(msg)
+
+        msg = domish.Element((None, 'message'))
+        msg['to'] = 'testing2@example.com'
+        msg['type'] = 'chat'
+        msg.addElement('body', None, 'yo')
+        msg.addElement('thread', None, thread)
+
+        archive.append(msg)
+
+        self.protocol.history(self.room_jid.userhost(), archive)
+
+
+        while len(self.stub.output)>0:
+            m = self.stub.output.pop()
+            # check for delay element
+            self.failUnless(m.name=='message', 'Wrong stanza')
+            self.failUnless(xpath.matches("/message/delay", m), 'Invalid history stanza')
+        
+
+    def test_invite(self):
+        self.fail('Not Implemented')
+
+        
+    def test_privateMessage(self):
+        self.fail('Not Implemented')
+
+    def test_register(self):
+        self.fail('Not Implemented')
+
+    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):
 
-        test_room = 'test'
-        test_srv  = 'conference.example.org'
-        test_nick = 'Nick'        
-
-        self.fail('Not Implemented')
-        
-
+        self.fail('Not Implemented')
+        
+