Changeset 83:81daaca3d75f for wokkel/pubsub.py

Timestamp:

Jan 5, 2010, 2:55:40 PM (13 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Add support for subscription options in subscribe requests

Fixes #63.

File:

• wokkel/pubsub.py (modified) (10 diffs)

wokkel/pubsub.py

@@ -229 +229 @@
     _parameters = {
         'publish': ['node', 'items'],
-        'subscribe': ['nodeOrEmpty', 'jid'],
+        'subscribe': ['nodeOrEmpty', 'jid', 'optionsWithSubscribe'],
         'unsubscribe': ['nodeOrEmpty', 'jid'],
         'optionsGet': ['nodeOrEmpty', 'jid'],
@@ -373 +373 @@
                 form = data_form.findForm(element, NS_PUBSUB_NODE_CONFIG)
                 if form:
-                    if form.formType == 'submit':
-                        self.options = form
-                    else:
+                    if form.formType != 'submit':
                         raise BadRequest(text=u"Unexpected form type '%s'" %
                                               form.formType)
@@ -381 +379 @@
                     form = data_form.Form('submit',
                                           formNamespace=NS_PUBSUB_NODE_CONFIG)
-                    self.options = form
+                self.options = form
 
 
@@ -452 +450 @@
 
 
+
+    def _render_options(self, verbElement):
+        verbElement.addChild(self.options.toElement())
+
+
+    def _parse_optionsWithSubscribe(self, verbElement):
+        for element in verbElement.parent.elements():
+            if element.name == 'options' and element.uri == NS_PUBSUB:
+                form = data_form.findForm(element,
+                                          NS_PUBSUB_SUBSCRIBE_OPTIONS)
+                if form:
+                    if form.formType != 'submit':
+                        raise BadRequest(text=u"Unexpected form type '%s'" %
+                                              form.formType)
+                else:
+                    form = data_form.Form('submit',
+                                          formNamespace=NS_PUBSUB_SUBSCRIBE_OPTIONS)
+                self.options = form
+
+
+    def _render_optionsWithSubscribe(self, verbElement):
+        if self.options:
+            optionsElement = verbElement.parent.addElement('options')
+            self._render_options(optionsElement)
+
+
     def parseElement(self, element):
         """
@@ -458 +482 @@
         generic.Stanza.parseElement(self, element)
 
+        verbs = []
+        children = []
         for child in element.pubsub.elements():
             key = (self.stanzaType, child.uri, child.name)
@@ -464 +490 @@
             except KeyError:
                 continue
+
+            verbs.append(verb)
+            children.append(child)
+
+        if not verbs:
+            raise NotImplementedError()
+
+        if len(verbs) > 1:
+            if 'optionsSet' in verbs and 'subscribe' in verbs:
+                self.verb = 'subscribe'
+                child = children[verbs.index('subscribe')]
             else:
-                self.verb = verb
-                break
-
-        if not self.verb:
-            raise NotImplementedError()
-
-        for parameter in self._parameters[verb]:
+                raise NotImplementedError()
+        else:
+            self.verb = verbs[0]
+
+        for parameter in self._parameters[self.verb]:
             getattr(self, '_parse_%s' % parameter)(child)
+
 
 
@@ -687 +723 @@
 
 
-    def subscribe(self, service, nodeIdentifier, subscriber, sender=None):
+    def subscribe(self, service, nodeIdentifier, subscriber,
+                        options=None, sender=None):
         """
         Subscribe to a publish subscribe node.
@@ -698 +735 @@
                            will get notifications of new published items.
         @type subscriber: L{JID}
+        @param options: Subscription options.
+        @type options: C{dict}.
         """
         request = PubSubRequest('subscribe')
@@ -704 +743 @@
         request.subscriber = subscriber
         request.sender = sender
+
+        if options:
+            form = data_form.Form(formType='submit',
+                                  formNamespace=NS_PUBSUB_SUBSCRIBE_OPTIONS)
+            form.makeFields(options)
+            request.options = form
 
         def cb(iq):
@@ -788 +833 @@
         d = request.send(self.xmlstream)
         d.addCallback(cb)
+        return d
+
+
+    def getOptions(self, service, nodeIdentifier, subscriber, sender=None):
+        """
+        Get subscription options.
+
+        @param service: The publish subscribe service that keeps the node.
+        @type service: L{JID}
+
+        @param nodeIdentifier: The identifier of the node.
+        @type nodeIdentifier: C{unicode}
+
+        @param subscriber: The entity subscribed to the node.
+        @type subscriber: L{JID}
+
+        @rtype: L{data_form.Form}
+        """
+        request = PubSubRequest('optionsGet')
+        request.recipient = service
+        request.nodeIdentifier = nodeIdentifier
+        request.subscriber = subscriber
+        request.sender = sender
+
+        def cb(iq):
+            form = data_form.findForm(iq.pubsub.options,
+                                      NS_PUBSUB_SUBSCRIBE_OPTIONS)
+            form.typeCheck()
+            return form
+
+        d = request.send(self.xmlstream)
+        d.addCallback(cb)
+        return d
+
+
+    def setOptions(self, service, nodeIdentifier, subscriber,
+                         options, sender=None):
+        """
+        Set subscription options.
+
+        @param service: The publish subscribe service that keeps the node.
+        @type service: L{JID}
+
+        @param nodeIdentifier: The identifier of the node.
+        @type nodeIdentifier: C{unicode}
+
+        @param subscriber: The entity subscribed to the node.
+        @type subscriber: L{JID}
+
+        @param options: Subscription options.
+        @type options: C{dict}.
+        """
+        request = PubSubRequest('optionsSet')
+        request.recipient = service
+        request.nodeIdentifier = nodeIdentifier
+        request.subscriber = subscriber
+        request.sender = sender
+
+        form = data_form.Form(formType='submit',
+                              formNamespace=NS_PUBSUB_SUBSCRIBE_OPTIONS)
+        form.makeFields(options)
+        request.options = form
+
+        d = request.send(self.xmlstream)
         return d