Changeset 97:f11253bd8b69

Timestamp:

Mar 7, 2011, 7:40:16 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Make sure item and subscription elements get the correct namespace.

This complements the changes in [f4aa0d507bc8] and [3fe44cf07366] for item and
subscription elements that are used in different namespaces. These changesets
set the namespace to None, which works nicely when the elements are
serialized. However, in situations where the DOM representation is passed
around (in-process communication) these elements are no longer matched by
namespace. This change makes sure the elements get the proper namespace just
before they are sent out.

Location:

wokkel

Files:

• pubsub.py (modified) (7 diffs)
• test/test_pubsub.py (modified) (5 diffs)

wokkel/pubsub.py

@@ -139 +139 @@
 
 
-    def toElement(self):
+    def toElement(self, defaultUri=None):
         """
         Return the DOM representation of this subscription.
@@ -145 +145 @@
         @rtype: L{domish.Element}
         """
-        element = domish.Element((None, 'subscription'))
+        element = domish.Element((defaultUri, 'subscription'))
         if self.nodeIdentifier:
             element['node'] = self.nodeIdentifier
@@ -359 +359 @@
         if self.items:
             for item in self.items:
+                item.uri = NS_PUBSUB
                 verbElement.addChild(item)
 
@@ -1214 +1215 @@
     def _toResponse_subscribe(self, result, resource, request):
         response = domish.Element((NS_PUBSUB, "pubsub"))
-        response.addChild(result.toElement())
+        response.addChild(result.toElement(NS_PUBSUB))
         return response
 
@@ -1222 +1223 @@
         subscriptions = response.addElement('subscriptions')
         for subscription in result:
-            subscriptions.addChild(subscription.toElement())
+            subscriptions.addChild(subscription.toElement(NS_PUBSUB))
         return response
 
@@ -1308 +1309 @@
 
         for item in result:
+            item.uri = NS_PUBSUB
             items.addChild(item)
 
@@ -1358 +1360 @@
                                                nodeIdentifier, subscriber,
                                                subscriptions)
-            message.event.items.children = items
+            for item in items:
+                item.uri = NS_PUBSUB_EVENT
+                message.event.items.addChild(item)
             self.send(message)
 

wokkel/test/test_pubsub.py

@@ -463 +463 @@
         child = children[0]
         self.assertEquals('test', child['node'])
-
-        items = []
-        for element in child.elements():
-            if element.name == 'item' and element.uri in (NS_PUBSUB, None):
-                items.append(element)
-
+        items = list(domish.generateElementsQNamed(child.children,
+                                                   'item', NS_PUBSUB))
         self.assertEquals(1, len(items))
         self.assertIdentical(item, items[0])
@@ -2218 +2214 @@
             self.assertEqual(NS_PUBSUB, element.uri)
             subscription = element.subscription
-            self.assertIn(subscription.uri, (None, NS_PUBSUB))
+            self.assertEqual(NS_PUBSUB, subscription.uri)
             self.assertEqual('test', subscription['node'])
             self.assertEqual('user@example.org/Home', subscription['jid'])
@@ -2431 +2427 @@
             subscription = children[0]
             self.assertEqual('subscription', subscription.name)
-            self.assertIn(subscription.uri, (None, NS_PUBSUB))
+            self.assertEqual(NS_PUBSUB, subscription.uri, NS_PUBSUB)
             self.assertEqual('user@example.org', subscription['jid'])
             self.assertEqual('test', subscription['node'])
@@ -2981 +2977 @@
             self.assertTrue(domish.IElement.providedBy(item))
             self.assertEqual('item', item.name)
-            self.assertIn(item.uri, (NS_PUBSUB, None))
+            self.assertEqual(NS_PUBSUB, item.uri)
             self.assertEqual('current', item['id'])
 
@@ -3061 +3057 @@
         verify.verifyObject(iwokkel.IPubSubResource, self.resource)
         return self.handleRequest(xml)
+
+
+    def test_notifyPublish(self):
+        """
+        Publish notifications are sent to the subscribers.
+        """
+        subscriber = JID('user@example.org')
+        subscriptions = [pubsub.Subscription('test', subscriber, 'subscribed')]
+        items = [pubsub.Item('current')]
+        notifications = [(subscriber, subscriptions, items)]
+        self.service.notifyPublish(JID('pubsub.example.org'), 'test',
+                                   notifications)
+        message = self.stub.output[-1]
+
+        self.assertEquals('message', message.name)
+        self.assertIdentical(None, message.uri)
+        self.assertEquals('user@example.org', message['to'])
+        self.assertEquals('pubsub.example.org', message['from'])
+        self.assertTrue(message.event)
+        self.assertEquals(NS_PUBSUB_EVENT, message.event.uri)
+        self.assertTrue(message.event.items)
+        self.assertEquals(NS_PUBSUB_EVENT, message.event.items.uri)
+        self.assertTrue(message.event.items.hasAttribute('node'))
+        self.assertEquals('test', message.event.items['node'])
+        itemElements = list(domish.generateElementsQNamed(
+            message.event.items.children, 'item', NS_PUBSUB_EVENT))
+        self.assertEquals(1, len(itemElements))
+        self.assertEquals('current', itemElements[0].getAttribute('id'))
+
+
+    def test_notifyPublishCollection(self):
+        """
+        Publish notifications are sent to the subscribers of collections.
+
+        The node the item was published to is on the C{items} element, while
+        the subscribed-to node is in the C{'Collections'} SHIM header.
+        """
+        subscriber = JID('user@example.org')
+        subscriptions = [pubsub.Subscription('', subscriber, 'subscribed')]
+        items = [pubsub.Item('current')]
+        notifications = [(subscriber, subscriptions, items)]
+        self.service.notifyPublish(JID('pubsub.example.org'), 'test',
+                                   notifications)
+        message = self.stub.output[-1]
+
+        self.assertTrue(message.event.items.hasAttribute('node'))
+        self.assertEquals('test', message.event.items['node'])
+        headers = shim.extractHeaders(message)
+        self.assertIn('Collection', headers)
+        self.assertIn('', headers['Collection'])