Changeset 72:727b4d29c48e in ralphm-patches for roster_server.patch

Timestamp:

Jan 27, 2013, 10:40:32 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Major reworking of avatars, session manager and stanza handlers.

File:

• roster_server.patch (modified) (6 diffs)

roster_server.patch

@@ -1 +1 @@
 Add server side support for the roster protocol.
 
- * Implements roster get by calling `getRoster` and using the returned `list`
-   of `RosterItem`s to send back the roster.
+ * Implements roster get by calling `getRoster` and using the returned
+   `Roster` to send back the roster.
 
 TODO:
- * Add more docstrings.
- * Use `dict` instead of `list` as return value of `getRoster`.
  * Add support for roster sets?
 
@@ -12 +10 @@
 --- a/wokkel/test/test_xmppim.py
 +++ b/wokkel/test/test_xmppim.py
-@@ -1330,3 +1330,81 @@
-         d = self.handleRequest(xml)
-         d.addCallback(cb)
-         return d
-+
-+
-+
+@@ -1339,6 +1339,85 @@
+ 
+ 
+ 
 +class RosterServerProtocolTest(unittest.TestCase, TestableRequestHandlerMixin):
 +    """
@@ -45 +40 @@
 +            item = xmppim.RosterItem(JID('other@example.org'), True, False,
 +                                 'The User')
-+            return defer.succeed([item])
++            roster = xmppim.Roster({item.entity: item})
++            return defer.succeed(roster)
 +
 +        def cb(element):
@@ -94 +90 @@
 +        self.assertFailure(d, NotImplementedError)
 +        return d
++
++
++
+ class MessageTest(unittest.TestCase):
+     """
+     Tests for L{xmppim.Message}.
 diff --git a/wokkel/xmppim.py b/wokkel/xmppim.py
 --- a/wokkel/xmppim.py
 +++ b/wokkel/xmppim.py
-@@ -25,6 +25,7 @@
+@@ -26,6 +26,7 @@
  NS_ROSTER = 'jabber:iq:roster'
  
@@ -105 +107 @@
  
  
-@@ -1063,3 +1064,40 @@
-         """
-         Called when a message stanza was received.
-         """
-+
-+
-+
+@@ -739,9 +740,9 @@
+ 
+ 
+     @classmethod
+-    def fromElement(Class, element):
++    def fromElement(cls, element):
+         entity = JID(element['jid'])
+-        item = Class(entity)
++        item = cls(entity)
+         subscription = element.getAttribute('subscription')
+         if subscription == 'remove':
+             item.remove = True
+@@ -780,21 +781,26 @@
+     version = None
+     rosterSet = False
+ 
++
+     def parseRequest(self, element):
+-        self.version = element.getAttribute('ver')
+-
+-        for child in element.elements(NS_ROSTER, 'item'):
+-            self.item = RosterItem.fromElement(child)
++        roster = Roster.fromElement(element)
++        self.version = roster.version
++        for item in roster.itervalues():
++            self.item = item
+             break
++        return roster
+ 
+ 
+     def toElement(self):
+         element = Request.toElement(self)
+-        query = element.addElement((NS_ROSTER, 'query'))
+-        if self.version is not None:
+-            query['ver'] = self.version
++
++        roster = Roster()
++        roster.version = self.version
+         if self.item:
+-            query.addChild(self.item.toElement(rosterSet=self.rosterSet))
++            roster[self.item.entity] = self.item
++
++        element.addChild(roster.toElement(rosterSet=self.rosterSet))
++
+         return element
+ 
+ 
+@@ -812,7 +818,7 @@
+ 
+ class Roster(dict):
+     """
+-    In-memory roster container.
++    Roster container.
+ 
+     This provides a roster as a mapping from L{JID} to L{RosterItem}. If
+     roster versioning is used, the C{version} attribute holds the version
+@@ -825,6 +831,28 @@
+     version = None
+ 
+ 
++    @classmethod
++    def fromElement(cls, element):
++        roster = cls()
++        roster.version = element.getAttribute('ver')
++        for element in element.elements(NS_ROSTER, 'item'):
++            item = RosterItem.fromElement(element)
++            roster[item.entity] = item
++        return roster
++
++
++    def toElement(self, rosterSet=False):
++        element = domish.Element((NS_ROSTER, 'query'))
++
++        if self.version:
++            element['ver'] = self.version
++
++        for item in self.itervalues():
++            element.addChild(item.toElement(rosterSet))
++
++        return element
++
++
+ 
+ class RosterClientProtocol(XMPPHandler, IQHandlerMixin):
+     """
+@@ -898,12 +926,7 @@
+ 
+         def processRoster(result):
+             if result.query is not None:
+-                roster = Roster()
+-                roster.version = result.query.getAttribute('ver')
+-                for element in result.query.elements(NS_ROSTER, 'item'):
+-                    item = RosterItem.fromElement(element)
+-                    roster[item.entity] = item
+-                return roster
++                return Roster.fromElement(result.query)
+             else:
+                 return None
+ 
+@@ -1002,6 +1025,43 @@
+ 
+ 
+ 
 +class RosterServerProtocol(XMPPHandler, IQHandlerMixin):
 +    """
@@ -127 +225 @@
 +
 +
-+    def _toRosterReply(self, roster, request):
-+        response = domish.Element((NS_ROSTER, 'query'))
-+
-+        for item in roster:
-+            response.addChild(item.toElement())
-+
-+        return response
-+
-+
 +    def _onRosterGet(self, iq):
-+        request = Stanza.fromElement(iq)
++        request = RosterRequest.fromElement(iq)
++
++        def toResponse(roster):
++            return roster.toElement()
 +
 +        d = self.getRoster(request)
-+        d.addCallback(self._toRosterReply, request)
++        d.addCallback(toResponse)
 +        return d
 +
 +
 +    def getRoster(self, request):
++        """
++        Called when the roster is requested.
++
++        @returns: Deferred that fires with a L{Roster}.
++        @rtype: L{defer.Deferred}
++        """
 +        raise NotImplementedError()
++
++
++
+ class Message(Stanza):
+     """
+     A message stanza.