Changeset 113:cb4051e2f51a

Timestamp:

Oct 7, 2008, 11:47:13 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@83

Message:

some documentation and additions to the interface, also some more abstraction and tests

Location:

wokkel

Files:

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

wokkel/iwokkel.py

@@ -516 +516 @@
     """
     Multi-User Chat Client
-    """
-
+
+    A client interface to XEP-045 : http://xmpp.org/extensions/xep-0045.html
+
+    """
+
+    def receivedSubject(room, subject):
+        """
+        A subject is received when you join a room and when the subject is changed. This
+        method is triggered by one of those two events.
+
+        @param room: The room the subject was accepted for.
+        @type room: L{muc.Room}
+
+        @param subject: The subject of the given room.
+        @type subject: C{unicode}
+        """
+
+
+    def receivedHistory(room, user, message, history, frm=None):
+        """
+        Past messages from a chat room has been received. This occurs when you join a room.
+
+
+        """
+
+    
+    def disco(entity, type='info'):
+        """Send disco queries to a XMPP entity
+
+        @param entity: A XMPP entity to send the disco request to.
+        @type entity: C{unicode}
+
+        @param type: Optional argument to determine the type of discovery being done.
+        @type type: C{str}
+
+        """
+
+        
+
+    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 join(server, room, nick):
+        """
+        Join a multi-user chat room. 
+
+        @param server: The server the room is on.
+        @type server: C{str}
+
+        @param room: The room name.
+        @type room: C{str}
+        
+        @param nick: The nick name you want when you join the room.
+        @type nick: C{str}
+
+        """
+
+
+    def leave(room_jid):
+        """
+        Leave a multi-user chat room.
+
+        @param room_jid: The room you want the configuration form from.
+        @type room_jid: L{jid.JID}
+
+        """
+
+    def userJoinedRoom(room, user):
+        """User has joined the room.
+
+        @param room: The room the user joined.
+        @type  room: L{muc.Room}
+
+        @param user: The user that joined the room.
+        @type  user: L{muc.User}
+
+        """
+   
+
+    def groupChat(to, message, children=None):
+        """Send a groupchat message to a room.
+
+        """
+
+
+    def chat(to, message, children=None):
+        """
+
+        """
+
+
+    def password(to, password):
+        """
+        """
+    
+    def register(to, fields=[]):
+        """
+        """
+
+
+    def subject(to, subject):
+        """
+        """
+
+    def voice(to):
+        """
+        """
+
+
+    def history(to, message_list):
+        """
+        """
+
+    def ban(to, ban_jid, frm, reason=None):
+        """
+        """
+
+
+    def kick(to, kick_jid, frm, reason=None):
+        """
+        """
+

wokkel/muc.py

@@ -66 +66 @@
 
 GROUPCHAT     = MESSAGE +'[@type="groupchat"]/body'
-SUBJECT       = MESSAGE +'[@type="groupchat"]/body'
+SUBJECT       = MESSAGE +'[@type="groupchat"]/subject'
 MESSAGE_ERROR = MESSAGE +'[@type="error"]'
 
@@ -121 +121 @@
     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}
@@ -243 +245 @@
             d['from'] = h_frm
 
+class User(object):
+    """
+    A user/entity in a multi-user chat room.
+    """
+    
+    def __init__(self, nick, user_jid=None):
+        self.nick = nick
+        self.user_jid = user_jid
+        self.affiliation = 'none'
+        self.role = 'none'
+        
+        self.status = None
+        self.show   = None
+
+
 class Room(object):
     """
@@ -261 +278 @@
                
         self.roster = {}
+
+        
+
+    def addUser(self, user):
+        """
+        """
+        self.roster[user.nick.lower()] = user
+
+    def inRoster(self, user):
+        """
+        """
+
+        return self.roster.has_key(user.nick.lower())
+
+    def getUser(self, nick):
+        """
+        """
+        return self.roster.get(nick.lower())
 
         
@@ -341 +376 @@
 
     def connectionInitialized(self):
-        self.xmlstream.addObserver(PRESENCE+"/x", self._onXPresence)
+        self.xmlstream.addObserver(PRESENCE+"[not(@type) or @type='available']/x", self._onXPresence)
+        self.xmlstream.addObserver(PRESENCE+"[@type='unavailable']", self._onUnavailablePresence)
+        self.xmlstream.addObserver(PRESENCE+"[@type='error']", self._onPresenceError)
         self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)
         self.xmlstream.addObserver(SUBJECT, self._onSubject)
@@ -356 +393 @@
             del self.rooms[room_jid.full().lower()]
 
+
+    def _onUnavailablePresence(self, prs):
+        """
+        """
+        if not prs.hasAttribute('from'):
+            return
+        room_jid = jid.internJID(prs.getAttribute('from', ''))
+
+
+    def _onPresenceError(self, prs):
+        """
+        """
+        if not prs.hasAttribute('from'):
+            return
+        room_jid = jid.internJID(prs.getAttribute('from', ''))
+
+
     def _onXPresence(self, prs):
         """
         """
-        if prs.x.uri == NS_USER:
-            self.receivedUserPresence(prs)
+        if not prs.hasAttribute('from'):
+            return
+        room_jid = jid.internJID(prs.getAttribute('from', ''))
+            
+        status = getattr(prs, 'status', None)
+        show   = getattr(prs, 'show', None)
+        
+        # grab room
+        room = self._getRoom(room_jid)
+        if room is None:
+            # not in the room yet
+            return
+
+        # check if user is in roster
+        user = room.getUser(room_jid.resource)
+        if user is None: # create a user that does not exist
+            user = User(room_jid.resource)
+            
+        
+        if room.inRoster(user):
+            # we changed status or nick 
+            muc_status = getattr(prs.x, 'status', None)
+            if muc_status:
+                code = muc_status.getAttribute('code', 0)
+            else:
+                self.userUpdatedStatus(room, user, show, status)
+        else:            
+            room.addUser(user)
+            self.userJoinedRoom(room, user)
             
 
@@ -366 +447 @@
         """
         """
+        if not msg.hasAttribute('from'):
+            # need to return an error here
+            return
+        room_jid = jid.internJID(msg.getAttribute('from', ''))
+
+        room = self._getRoom(room_jid)
+        if room is None:
+            # not in the room yet
+            return
+        user = room.getUser(room_jid.resource)
+
         delay = getattr(msg, 'delay', None)
+        body  = unicode(msg.body)
+        # grab room
         if delay is None:
-            self.receivedGroupChat(msg)
+            self.receivedGroupChat(room, user, body)
         else:
-            self.receivedHistory(msg)
+            self.receivedHistory(room, user, body, delay['stamp'], frm=delay.getAttribute('from',None))
 
 
@@ -376 +470 @@
         """
         """
-        self.receivedSubject(msg)
+        if not msg.hasAttribute('from'):
+            return
+        room_jid = jid.internJID(msg['from'])
+
+        # grab room
+        room = self._getRoom(room_jid)
+        if room is None:
+            # not in the room yet
+            return
+
+        self.receivedSubject(room_jid, unicode(msg.subject))
 
 
@@ -426 +530 @@
             d.callback(True)
 
-    def receivedUserPresence(self, prs):
+    def userJoinedRoom(self, room, user):
+        """User has joined a room
+        """
+        pass
+
+
+    def userUserUpdatedStatus(self, room, user, show, status):
         """User Presence has been received
         """
@@ -432 +542 @@
         
 
-    def receivedSubject(self, msg):
+    def receivedSubject(self, room, subject):
         """
         """
@@ -438 +548 @@
 
 
-    def receivedHistory(self, msg):
+    def receivedHistory(self, room, user, message, history, frm=None):
         """
         """
@@ -533 +643 @@
         
     def invite(self, to, reason=None, full_jid=None):
+        """
+        """
         msg = InviteMessage(to, reason=reason, full_jid=full_jid)
         self._sendMessage(msg)
@@ -547 +659 @@
         return iq.send()
 
-    def getRegisterForm(self, to):
+    def getRegisterForm(self, room):
+        """
+        """
         iq = RegisterRequest(self.xmlstream)
-        iq['to'] = to
+        iq['to'] = room.userhost()
         return iq.send()
 

wokkel/test/test_muc.py

@@ -57 +57 @@
         self.user_jid = JID('test@jabber.org/Testing')
 
+    def _createRoom(self):
+        # create a room
+        self.current_room = muc.Room(self.test_room, self.test_srv, self.test_nick)
+        self.protocol._setRoom(self.current_room)
+
+
     def test_interface(self):
         """
@@ -64 +70 @@
 
 
-    def test_presence(self):
-        """Test receiving room presence
+    def test_userJoinedRoom(self):
+        """Test receiving a user joined event.
         """
         p = muc.UserPresence()
+        p['to'] = self.user_jid.full()
+        p['from'] = self.room_jid.full()
+
+        # create a room
+        self._createRoom()
+
+        def userPresence(room, user):
+            self.failUnless(room.name==self.test_room, 'Wrong room name')
+            self.failUnless(room.inRoster(user), 'User not in roster')
+                           
         
-        def userPresence(prs):
-            self.failUnless(len(prs.children)==1, 'Not enough children')
-            self.failUnless(getattr(prs,'x',None), 'No x element')
-                   
-        
-        d, self.protocol.receivedUserPresence = calledAsync(userPresence)
+        d, self.protocol.userJoinedRoom = calledAsync(userPresence)
         self.stub.send(p)
         return d
@@ -83 +94 @@
         """
         m = muc.GroupChat('test@test.com',body='test')
-        
-        def groupChat(elem):
-            self.failUnless(elem.name=='message','Wrong stanza')
-            self.failUnless(elem['type'] == 'groupchat', 'Wrong attribute')
+        m['from'] = self.room_jid.full()
+
+        self._createRoom()
+
+        def groupChat(room, user, message):
+            self.failUnless(message=='test', "Wrong group chat message")
+            self.failUnless(room.name==self.test_room, 'Wrong room name')
                            
         
@@ -230 +244 @@
         return d
 
-        self.fail('Not Implemented')
         
 
@@ -248 +261 @@
         """
         m = muc.HistoryMessage(self.room_jid.userhost(), self.protocol._makeTimeStamp(), body='test')
-        
-        def roomHistory(h):
-            self.failUnless(getattr(h,'delay',None), 'No delay element')
+        m['from'] = self.room_jid.full()
+        
+        self._createRoom()
+
+        def roomHistory(room, user, body, stamp, frm=None):
+            self.failUnless(body=='test', "wrong message body")
+            self.failUnless(stamp, 'Does not have a history stamp')