Changeset 13:b460ae320c23 for wokkel

Timestamp:

Feb 20, 2008, 3:44:44 PM (14 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@41

Message:

Add support for receiving notifications for item retraction, node deletion and purging.

Location:

wokkel

Files:

• iwokkel.py (modified) (2 diffs)
• pubsub.py (modified) (2 diffs)
• test/test_pubsub.py (modified) (4 diffs)

wokkel/iwokkel.py

@@ -138 +138 @@
     def itemsReceived(recipient, service, nodeIdentifier, items):
         """
-        Called when items have been received from a node.
+        Called when an items notification has been received for a node.
+
+        An item can be an element named C{item} or C{retract}. Respectively,
+        they signal an item being published or retracted, optionally
+        accompanied with an item identifier in the C{id} attribute.
 
         @param recipient: The entity to which the notification was sent.
@@ -148 +152 @@
         @param items: List of received items as domish elements.
         @type items: C{list} of L{domish.Element}
+        """
+
+    def deleteReceived(recipient, service, nodeIdentifier, items):
+        """
+        Called when a deletion notification has been received for a node.
+
+        @param recipient: The entity to which the notification was sent.
+        @type recipient: L{jid.JID}
+        @param service: The entity from which the notification was received.
+        @type service: L{jid.JID}
+        @param nodeIdentifier: Identifier of the node that has been deleted.
+        @type nodeIdentifier: C{unicode}
+        """
+
+    def purgeReceived(recipient, service, nodeIdentifier, items):
+        """
+        Called when a purge notification has been received for a node.
+
+        Upon receiving this notification all items associated should be
+        considered retracted.
+
+        @param recipient: The entity to which the notification was sent.
+        @type recipient: L{jid.JID}
+        @param service: The entity from which the notification was received.
+        @type service: L{jid.JID}
+        @param nodeIdentifier: Identifier of the node that has been purged.
+        @type nodeIdentifier: C{unicode}
         """
 

wokkel/pubsub.py

@@ -13 +13 @@
 from zope.interface import implements
 
-from twisted.internet import defer
+from twisted.internet import defer, reactor
 from twisted.words.protocols.jabber import jid, error, xmlstream
 from twisted.words.xish import domish
@@ -240 +240 @@
 
     def connectionInitialized(self):
-        self.xmlstream.addObserver('/message/event[@xmlns="%s"]/items' %
-                                   NS_PUBSUB_EVENT, self._onItems)
-
-    def _onItems(self, message):
+        self.xmlstream.addObserver('/message/event[@xmlns="%s"]' %
+                                   NS_PUBSUB_EVENT, self._onEvent)
+
+    def _onEvent(self, message):
         try:
             service = jid.JID(message["from"])
             recipient = jid.JID(message["to"])
-            nodeIdentifier = message.event.items["node"]
         except KeyError:
             return
 
-        items = [element for element in message.event.items.elements()
-                         if element.name == 'item']
+        for element in message.event.elements():
+            if element.uri == NS_PUBSUB_EVENT:
+                actionElement = element
+
+        if not actionElement:
+            return
+
+        eventHandler = getattr(self, "_onEvent_%s" % actionElement.name, None)
+
+        if eventHandler:
+            eventHandler(service, recipient, actionElement)
+            message.handled = True
+
+    def _onEvent_items(self, service, recipient, action):
+        nodeIdentifier = action["node"]
+
+        items = [element for element in action.elements()
+                         if element.name in ('item', 'retract')]
 
         self.itemsReceived(recipient, service, nodeIdentifier, items)
 
+    def _onEvent_delete(self, service, recipient, action):
+        nodeIdentifier = action["node"]
+        self.deleteReceived(recipient, service, nodeIdentifier)
+
+    def _onEvent_purge(self, service, recipient, action):
+        nodeIdentifier = action["node"]
+        self.purgeReceived(recipient, service, nodeIdentifier)
+
     def itemsReceived(self, recipient, service, nodeIdentifier, items):
+        pass
+
+    def deleteReceived(self, recipient, service, nodeIdentifier):
+        pass
+
+    def purgeReceived(self, recipient, service, nodeIdentifier):
         pass
 

wokkel/test/test_pubsub.py

@@ -7 +7 @@
 
 from twisted.trial import unittest
+from twisted.python import failure
+from twisted.internet import defer, reactor
 from twisted.words.xish import domish
 from twisted.words.protocols.jabber import error
@@ -21 +23 @@
 NS_PUBSUB = 'http://jabber.org/protocol/pubsub'
 NS_PUBSUB_ERRORS = 'http://jabber.org/protocol/pubsub#errors'
+NS_PUBSUB_EVENT = 'http://jabber.org/protocol/pubsub#event'
+
+def calledAsync(fn):
+    """
+    Function wrapper that fires a deferred upon calling the given function.
+    """
+    d = defer.Deferred()
+
+    def func(*args, **kwargs):
+        try:
+            result = fn(*args, **kwargs)
+        except:
+            d.errback()
+        else:
+            d.callback(result)
+
+    return d, func
+
 
 class PubSubClientTest(unittest.TestCase):
+    timeout = 2
 
     def setUp(self):
@@ -28 +49 @@
         self.protocol = pubsub.PubSubClient()
         self.protocol.xmlstream = self.stub.xmlstream
+        self.protocol.connectionInitialized()
 
     def test_unsubscribe(self):
@@ -51 +73 @@
         return d
 
+    def test_event_items(self):
+        """
+        Test receiving an items event resulting in a call to itemsReceived.
+        """
+        message = domish.Element((None, 'message'))
+        message['from'] = 'pubsub.example.org'
+        message['to'] = 'user@example.org/home'
+        event = message.addElement((NS_PUBSUB_EVENT, 'event'))
+        items = event.addElement('items')
+        items['node'] = 'test'
+        item1 = items.addElement('item')
+        item1['id'] = 'item1'
+        item2 = items.addElement('retract')
+        item2['id'] = 'item2'
+        item3 = items.addElement('item')
+        item3['id'] = 'item3'
+
+        def itemsReceived(recipient, service, nodeIdentifier, items):
+            self.assertEquals(JID('user@example.org/home'), recipient)
+            self.assertEquals(JID('pubsub.example.org'), service)
+            self.assertEquals('test', nodeIdentifier)
+            self.assertEquals([item1, item2, item3], items)
+
+        d, self.protocol.itemsReceived = calledAsync(itemsReceived)
+        self.stub.send(message)
+        return d
+
+    def test_event_delete(self):
+        """
+        Test receiving a delete event resulting in a call to deleteReceived.
+        """
+        message = domish.Element((None, 'message'))
+        message['from'] = 'pubsub.example.org'
+        message['to'] = 'user@example.org/home'
+        event = message.addElement((NS_PUBSUB_EVENT, 'event'))
+        items = event.addElement('delete')
+        items['node'] = 'test'
+
+        def deleteReceived(recipient, service, nodeIdentifier):
+            self.assertEquals(JID('user@example.org/home'), recipient)
+            self.assertEquals(JID('pubsub.example.org'), service)
+            self.assertEquals('test', nodeIdentifier)
+
+        d, self.protocol.deleteReceived = calledAsync(deleteReceived)
+        self.stub.send(message)
+        return d
+
+    def test_event_purge(self):
+        """
+        Test receiving a purge event resulting in a call to purgeReceived.
+        """
+        message = domish.Element((None, 'message'))
+        message['from'] = 'pubsub.example.org'
+        message['to'] = 'user@example.org/home'
+        event = message.addElement((NS_PUBSUB_EVENT, 'event'))
+        items = event.addElement('purge')
+        items['node'] = 'test'
+
+        def purgeReceived(recipient, service, nodeIdentifier):
+            self.assertEquals(JID('user@example.org/home'), recipient)
+            self.assertEquals(JID('pubsub.example.org'), service)
+            self.assertEquals('test', nodeIdentifier)
+
+        d, self.protocol.purgeReceived = calledAsync(purgeReceived)
+        self.stub.send(message)
+        return d
 
 class PubSubServiceTest(unittest.TestCase):