source: ralphm-patches/pubsub_manage_affiliations.patch @ 46:5ec77d2dcdb4

wokkel/iwokkel.py

@@ -767 +767 @@
                  deleted.
         @rtype: L{defer.Deferred}
         """
+
+
+    def affiliationsGet(request):
+        """
+        Called when a affiliations retrieval request (owner) has been received.
+
+        @param request: The publish-subscribe request.
+        @type request: L{wokkel.pubsub.PubSubRequest}
+        @return: A deferred that fires with a C{dict} of affiliations with the
+            entity as key (L{JID}) and the affiliation state as value
+            (C{unicode}).  The affiliation can be C{u'owner'}, C{u'publisher'},
+            or C{u'outcast'}.
+        @rtype: L{defer.Deferred}
+
+        @note: Affiliations are always on the bare JID. An implementation of
+        this method MUST NOT return JIDs with a resource part.
+        """
+
+
+    def affiliationsSet(request):
+        """
+        Called when a affiliations modify request has been received.
+
+        @param request: The publish-subscribe request.
+        @type request: L{wokkel.pubsub.PubSubRequest}
+        @return: A deferred that fires with C{None} when the affiliation
+            changes were succesfully processed..
+        @rtype: L{defer.Deferred}
+
+        @note: Affiliations are always on the bare JID. The JIDs in
+        L{wokkel.pubsub.PubSubRequest.affiliations} are already stripped of
+        any resource.
+        """

wokkel/pubsub.py

@@ -220 +220 @@
     @ivar subscriptions: Subscriptions to be modified, as a set of
                          L{Subscription}.
     @type subscriptions: C{set}
+    @ivar affiliations: Affiliations to be modified, as a dictionary of entity
+                        (L{JID} to affiliation (C{unicode}).
+    @type affiliations: C{dict}
     """
 
     verb = None
@@ -234 +237 @@
     subscriber = None
     subscriptionIdentifier = None
     subscriptions = None
+    affiliations = None
 
     # Map request iq type and subelement name to request verb
     _requestVerbMap = {
@@ -279 +283 @@
         'purge': ['node'],
         'delete': ['node'],
         'affiliationsGet': ['nodeOrEmpty'],
-        'affiliationsSet': [],
+        'affiliationsSet': ['nodeOrEmpty', 'affiliations'],
         'subscriptionsGet': ['nodeOrEmpty'],
         'subscriptionsSet': [],
     }
@@ -526 +530 @@
             self._render_options(optionsElement)
 
 
+    def _parse_affiliations(self, verbElement):
+        self.affiliations = {}
+        for element in verbElement.elements():
+            if (element.uri == NS_PUBSUB_OWNER and
+                element.name == 'affiliation'):
+                try:
+                    entity = jid.internJID(element['jid']).userhostJID()
+                except KeyError:
+                    raise BadRequest(text='Missing jid attribute')
+
+                if entity in self.affiliations:
+                    raise BadRequest(text='Multiple affiliations for an entity')
+
+                try:
+                    affiliation = element['affiliation']
+                except KeyError:
+                    raise BadRequest(text='Missing affiliation attribute')
+
+                self.affiliations[entity] = affiliation
+
+
     def parseElement(self, element):
         """
         Parse the publish-subscribe verb and parameters out of a request.
@@ -1303 +1328 @@
 
         return message
 
+
+    def _toResponse_affiliationsGet(self, result, resource, request):
+        response = domish.Element((NS_PUBSUB_OWNER, 'pubsub'))
+        affiliations = response.addElement('affiliations')
+
+        if request.nodeIdentifier:
+            affiliations['node'] = request.nodeIdentifier
+
+        for entity, affiliation in result.iteritems():
+            item = affiliations.addElement('affiliation')
+            item['jid'] = entity.full()
+            item['affiliation'] = affiliation
+
+        return response
+
+
     # public methods
 
     def notifyPublish(self, service, nodeIdentifier, notifications):

wokkel/test/test_pubsub.py

@@ -3192 +3192 @@
 
     def test_on_affiliationsGet(self):
         """
-        Getting subscription options is not supported.
+        Getting node affiliations should have.
+        """
+
+        xml = """
+        <iq type='get' to='pubsub.example.org'
+                       from='user@example.org'>
+          <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+            <affiliations node='test'/>
+          </pubsub>
+        </iq>
+        """
+
+        def affiliationsGet(request):
+            self.assertEquals('test', request.nodeIdentifier)
+            return defer.succeed({JID('user@example.org'): 'owner'})
+
+        def cb(element):
+            self.assertEquals(u'pubsub', element.name)
+            self.assertEquals(NS_PUBSUB_OWNER, element.uri)
+            self.assertEquals(NS_PUBSUB_OWNER, element.affiliations.uri)
+            self.assertEquals(u'test', element.affiliations[u'node'])
+            children = list(element.affiliations.elements())
+            self.assertEquals(1, len(children))
+            affiliation = children[0]
+            self.assertEquals(u'affiliation', affiliation.name)
+            self.assertEquals(NS_PUBSUB_OWNER, affiliation.uri)
+            self.assertEquals(u'user@example.org', affiliation[u'jid'])
+            self.assertEquals(u'owner', affiliation[u'affiliation'])
+
+        self.resource.affiliationsGet = affiliationsGet
+        verify.verifyObject(iwokkel.IPubSubResource, self.resource)
+        d = self.handleRequest(xml)
+        d.addCallback(cb)
+        return d
+
+
+    def test_on_affiliationsGetEmptyNode(self):
+        """
+        Getting node affiliations without node should assume empty node.
         """
 
         xml = """
@@ -3204 +3242 @@
         </iq>
         """
 
-        def cb(result):
-            self.assertEquals('feature-not-implemented', result.condition)
-            self.assertEquals('unsupported', result.appCondition.name)
-            self.assertEquals(NS_PUBSUB_ERRORS, result.appCondition.uri)
-            self.assertEquals('modify-affiliations',
-                              result.appCondition['feature'])
-
+        def affiliationsGet(request):
+            self.assertIdentical('', request.nodeIdentifier)
+            return defer.succeed({})
+
+        def cb(element):
+            self.assertFalse(element.affiliations.hasAttribute(u'node'))
+
+        self.resource.affiliationsGet = affiliationsGet
+        verify.verifyObject(iwokkel.IPubSubResource, self.resource)
         d = self.handleRequest(xml)
-        self.assertFailure(d, error.StanzaError)
         d.addCallback(cb)
         return d
 
 
     def test_on_affiliationsSet(self):
         """
-        Setting subscription options is not supported.
+        Setting node affiliations has the affiliations to be modified.
         """
 
         xml = """
         <iq type='set' to='pubsub.example.org'
                        from='user@example.org'>
           <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
-            <affiliations/>
+            <affiliations node='test'>
+              <affiliation jid='other@example.org' affiliation='publisher'/>
+            </affiliations>
           </pubsub>
         </iq>
         """
 
+        def affiliationsSet(request):
+            self.assertEquals(u'test', request.nodeIdentifier)
+            otherJID = JID(u'other@example.org')
+            self.assertIn(otherJID, request.affiliations)
+            self.assertEquals(u'publisher', request.affiliations[otherJID])
+
+        self.resource.affiliationsSet = affiliationsSet
+        return self.handleRequest(xml)
+
+
+    def test_on_affiliationsSetBareJID(self):
+        """
+        Affiliations are always on the bare JID.
+        """
+
+        xml = """
+        <iq type='set' to='pubsub.example.org'
+                       from='user@example.org'>
+          <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+            <affiliations node='test'>
+              <affiliation jid='other@example.org/Home'
+                           affiliation='publisher'/>
+            </affiliations>
+          </pubsub>
+        </iq>
+        """
+
+        def affiliationsSet(request):
+            otherJID = JID(u'other@example.org')
+            self.assertIn(otherJID, request.affiliations)
+
+        self.resource.affiliationsSet = affiliationsSet
+        return self.handleRequest(xml)
+
+
+    def test_on_affiliationsSetMultipleForSameEntity(self):
+        """
+        Setting node affiliations can only have one item per entity.
+        """
+
+        xml = """
+        <iq type='set' to='pubsub.example.org'
+                       from='user@example.org'>
+          <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+            <affiliations node='test'>
+              <affiliation jid='other@example.org' affiliation='publisher'/>
+              <affiliation jid='other@example.org' affiliation='owner'/>
+            </affiliations>
+          </pubsub>
+        </iq>
+        """
+
         def cb(result):
-            self.assertEquals('feature-not-implemented', result.condition)
-            self.assertEquals('unsupported', result.appCondition.name)
-            self.assertEquals(NS_PUBSUB_ERRORS, result.appCondition.uri)
-            self.assertEquals('modify-affiliations',
-                              result.appCondition['feature'])
+            self.assertEquals('bad-request', result.condition)
 
         d = self.handleRequest(xml)
         self.assertFailure(d, error.StanzaError)
@@ -3914 +4003 @@
         self.assertFailure(d, error.StanzaError)
         d.addCallback(cb)
         return d
+
+
+    def test_affiliationsGet(self):
+        """
+        Non-overridden owner affiliations get yields unsupported error.
+        """
+
+        def cb(result):
+            self.assertEquals('feature-not-implemented', result.condition)
+            self.assertEquals('unsupported', result.appCondition.name)
+            self.assertEquals(NS_PUBSUB_ERRORS, result.appCondition.uri)
+            self.assertEquals('modify-affiliations',
+                              result.appCondition['feature'])
+
+        d = self.resource.affiliationsGet(pubsub.PubSubRequest())
+        self.assertFailure(d, error.StanzaError)
+        d.addCallback(cb)
+        return d
+
+
+    def test_affiliationsSet(self):
+        """
+        Non-overridden owner affiliations set yields unsupported error.
+        """
+
+        def cb(result):
+            self.assertEquals('feature-not-implemented', result.condition)
+            self.assertEquals('unsupported', result.appCondition.name)
+            self.assertEquals(NS_PUBSUB_ERRORS, result.appCondition.uri)
+            self.assertEquals('modify-affiliations',
+                              result.appCondition['feature'])
+
+        d = self.resource.affiliationsGet(pubsub.PubSubRequest())
+        self.assertFailure(d, error.StanzaError)
+        d.addCallback(cb)
+        return d