source: ralphm-patches/roster_server.patch

Add server side support for the roster protocol.

 * Implements roster get by calling `getRoster` and using the returned
   `Roster` to send back the roster.

TODO:
 * Add support for roster sets?

diff --git a/wokkel/test/test_xmppim.py b/wokkel/test/test_xmppim.py
--- a/wokkel/test/test_xmppim.py
+++ b/wokkel/test/test_xmppim.py
@@ -1339,6 +1339,85 @@
 
 
 
+class RosterServerProtocolTest(unittest.TestCase, TestableRequestHandlerMixin):
+    """
+    Tests for L{xmppim.RosterServerProtocol}.
+    """
+
+    def setUp(self):
+        self.stub = XmlStreamStub()
+        self.service = xmppim.RosterServerProtocol()
+        self.service.makeConnection(self.stub.xmlstream)
+        self.service.connectionInitialized()
+
+
+    def test_getRosterReceived(self):
+        """
+        A roster get request should trigger getRoster with the request.
+        """
+        xml = """
+          <iq type='get' from='user@example.org/Home'>
+            <query xmlns='jabber:iq:roster'/>
+          </iq>
+        """
+
+        def getRosterReceived(request):
+            self.assertEqual(JID('user@example.org/Home'), request.sender)
+            item = xmppim.RosterItem(JID('other@example.org'), True, False,
+                                 'The User')
+            roster = xmppim.Roster({item.entity: item})
+            return defer.succeed(roster)
+
+        def cb(element):
+            self.assertEquals('query', element.name)
+            self.assertEquals(NS_ROSTER, element.uri)
+            itemElements = list(domish.generateElementsQNamed(
+                element.children, 'item', NS_ROSTER))
+            self.assertEqual(1, len(itemElements))
+            item = itemElements[0]
+            self.assertEquals(u'other@example.org', item.getAttribute('jid'))
+            self.assertEquals(u'to', item.getAttribute('subscription'))
+            self.assertEquals(u'The User', item.getAttribute('name'))
+
+        self.service.getRosterReceived = getRosterReceived
+        d = self.handleRequest(xml)
+        d.addCallback(cb)
+        return d
+
+
+    def test_getRosterReceivedNotOverridden(self):
+        """
+        If getRoster is not overridden, return feature-not-implemented.
+        """
+        xml = """
+          <iq type='get' from='user@example.org/Home'>
+            <query xmlns='jabber:iq:roster'/>
+          </iq>
+        """
+
+        d = self.handleRequest(xml)
+        self.assertFailure(d, NotImplementedError)
+        return d
+
+
+    def test_setRosterReceived(self):
+        """
+        Roster set is not yet supported.
+        """
+        xml = """
+          <iq type='set' from='user@example.org/Home'>
+            <query xmlns='jabber:iq:roster'>
+              <item jid='other@example.org' name='Other User'/>
+            </query>
+          </iq>
+        """
+
+        d = self.handleRequest(xml)
+        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
@@ -26,6 +26,7 @@
 NS_ROSTER = 'jabber:iq:roster'
 
 XPATH_ROSTER_SET = "/iq[@type='set']/query[@xmlns='%s']" % NS_ROSTER
+XPATH_ROSTER_GET = "/iq[@type='get']/query[@xmlns='%s']" % NS_ROSTER
 
 
 
@@ -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):
+    """
+    XMPP subprotocol handler for the roster, server side.
+    """
+
+    iqHandlers = {
+            XPATH_ROSTER_GET: '_onRosterGet',
+            # XPATH_ROSTER_SET: '_onRosterSet',
+            }
+
+    def connectionInitialized(self):
+        self.xmlstream.addObserver(XPATH_ROSTER_GET, self.handleRequest)
+        self.xmlstream.addObserver(XPATH_ROSTER_SET, self.handleRequest)
+
+
+    def _onRosterGet(self, iq):
+        request = RosterRequest.fromElement(iq)
+
+        def toResponse(roster):
+            return roster.toElement()
+
+        d = self.getRosterReceived(request)
+        d.addCallback(toResponse)
+        return d
+
+
+    def getRosterReceived(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.