Changeset 103:e17a30fe7144

Timestamp:

Aug 3, 2011, 9:49:23 AM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Reimplement _DiscoRequest as generic.Request.

Author: ralphm, Goffi.
Fixes: #73.

Location:

wokkel

Files:

• disco.py (modified) (8 diffs)
• generic.py (modified) (3 diffs)
• test/test_disco.py (modified) (7 diffs)

wokkel/disco.py

@@ -15 +15 @@
 from twisted.words.xish import domish
 
-from wokkel import data_form
-from wokkel.compat import IQ
+from wokkel import data_form, generic
 from wokkel.iwokkel import IDisco
 from wokkel.subprotocols import IQHandlerMixin, XMPPHandler
@@ -347 +346 @@
 
 
-class _DiscoRequest(IQ):
-    """
-    Element representing an XMPP service discovery request.
-    """
-
-    def __init__(self, xs, namespace, nodeIdentifier=''):
-        """
-        Initialize the request.
-
-        @param xs: XML Stream the request should go out on.
-        @type xs: L{xmlstream.XmlStream}
-        @param namespace: Request namespace.
-        @type namespace: C{str}
-        @param nodeIdentifier: Node to request info from.
-        @type nodeIdentifier: C{unicode}
-        """
-        IQ.__init__(self, xs, "get")
-        query = self.addElement((namespace, 'query'))
-        if nodeIdentifier:
-            query['node'] = nodeIdentifier
+class _DiscoRequest(generic.Request):
+    """
+    A Service Discovery request.
+
+    @ivar verb: Type of request: C{'info'} or C{'items'}.
+    @type verb: C{str}
+    @ivar nodeIdentifier: Optional node to request info for.
+    @type nodeIdentifier: C{unicode}
+    """
+
+    verb = None
+    nodeIdentifier = ''
+
+    _requestVerbMap = {
+            NS_DISCO_INFO: 'info',
+            NS_DISCO_ITEMS: 'items',
+            }
+
+    _verbRequestMap = dict(((v, k) for k, v in _requestVerbMap.iteritems()))
+
+    def __init__(self, verb=None, nodeIdentifier='',
+                       recipient=None, sender=None):
+        generic.Request.__init__(self, recipient=recipient, sender=sender,
+                                       stanzaType='get')
+        self.verb = verb
+        self.nodeIdentifier = nodeIdentifier
+
+
+    def parseElement(self, element):
+        generic.Request.parseElement(self, element)
+
+        verbElement = None
+        for child in element.elements():
+            if child.name == 'query' and child.uri in self._requestVerbMap:
+                self.verb = self._requestVerbMap[child.uri]
+                verbElement = child
+
+        if verbElement:
+            self.nodeIdentifier = verbElement.getAttribute('node', '')
+
+
+    def toElement(self):
+        element = generic.Request.toElement(self)
+
+        childURI = self._verbRequestMap[self.verb]
+        query = element.addElement((childURI, 'query'))
+
+        if self.nodeIdentifier:
+            query['node'] = self.nodeIdentifier
+
+        return element
 
 
@@ -389 +419 @@
         """
 
-        request = _DiscoRequest(self.xmlstream, NS_DISCO_INFO, nodeIdentifier)
-        if sender is not None:
-            request['from'] = unicode(sender)
-
-        d = request.send(entity.full())
+        request = _DiscoRequest('info', nodeIdentifier)
+        request.sender = sender
+        request.recipient = entity
+
+        d = self.request(request)
         d.addCallback(lambda iq: DiscoInfo.fromElement(iq.query))
         return d
@@ -412 +442 @@
         """
 
-        request = _DiscoRequest(self.xmlstream, NS_DISCO_ITEMS, nodeIdentifier)
-        if sender is not None:
-            request['from'] = unicode(sender)
-
-        d = request.send(entity.full())
+        request = _DiscoRequest('items', nodeIdentifier)
+        request.sender = sender
+        request.recipient = entity
+
+        d = self.request(request)
         d.addCallback(lambda iq: DiscoItems.fromElement(iq.query))
         return d
@@ -446 +476 @@
         @type iq: L{Element<twisted.words.xish.domish.Element>}
         """
-        requestor = jid.internJID(iq["from"])
-        target = jid.internJID(iq["to"])
-        nodeIdentifier = iq.query.getAttribute("node", '')
+        request = _DiscoRequest.fromElement(iq)
 
         def toResponse(info):
-            if nodeIdentifier and not info:
+            if request.nodeIdentifier and not info:
                 raise error.StanzaError('item-not-found')
             else:
                 response = DiscoInfo()
-                response.nodeIdentifier = nodeIdentifier
+                response.nodeIdentifier = request.nodeIdentifier
 
                 for item in info:
@@ -462 +490 @@
             return response.toElement()
 
-        d = self.info(requestor, target, nodeIdentifier)
+        d = self.info(request.sender, request.recipient,
+                      request.nodeIdentifier)
         d.addCallback(toResponse)
         return d
@@ -474 +503 @@
         @type iq: L{Element<twisted.words.xish.domish.Element>}
         """
-        requestor = jid.internJID(iq["from"])
-        target = jid.internJID(iq["to"])
-        nodeIdentifier = iq.query.getAttribute("node", '')
+        request = _DiscoRequest.fromElement(iq)
 
         def toResponse(items):
             response = DiscoItems()
-            response.nodeIdentifier = nodeIdentifier
+            response.nodeIdentifier = request.nodeIdentifier
 
             for item in items:
@@ -487 +514 @@
             return response.toElement()
 
-        d = self.items(requestor, target, nodeIdentifier)
+        d = self.items(request.sender, request.recipient,
+                       request.nodeIdentifier)
         d.addCallback(toResponse)
         return d

wokkel/generic.py

@@ -21 +21 @@
     from wokkel.compat import BootstrapMixin
 
-from wokkel import disco
 from wokkel.iwokkel import IDisco
 from wokkel.subprotocols import XMPPHandler
@@ -121 +120 @@
 
         if not node:
+            from wokkel import disco
             info.add(disco.DiscoFeature(NS_VERSION))
 
@@ -175 +175 @@
     """
 
+    recipient = None
+    sender = None
     stanzaKind = None
     stanzaID = None

wokkel/test/test_disco.py

@@ -478 +478 @@
         """
         self.stub = XmlStreamStub()
+        self.patch(XMPPHandler, 'request', self.request)
         self.protocol = disco.DiscoClientProtocol()
-        self.protocol.xmlstream = self.stub.xmlstream
-        self.protocol.connectionInitialized()
+
+
+    def request(self, request):
+        element = request.toElement()
+        self.stub.xmlstream.send(element)
+        return defer.Deferred()
 
 
@@ -512 +517 @@
         element[u'jid'] = u"test2.example.org"
 
-        self.stub.send(response)
+        d.callback(response)
         return d
 
@@ -528 +533 @@
         response = toResponse(iq, u'result')
         response.addElement((NS_DISCO_ITEMS, u'query'))
-        self.stub.send(response)
-
+
+        d.callback(response)
         return d
 
@@ -567 +572 @@
         element[u'var'] = u'http://jabber.org/protocol/muc'
 
-        self.stub.send(response)
+        d.callback(response)
         return d
 
@@ -576 +581 @@
         """
         d = self.protocol.requestInfo(JID(u'example.org'),
-                                       sender=JID(u'test.example.org'))
+                                      sender=JID(u'test.example.org'))
 
         iq = self.stub.output[-1]
@@ -583 +588 @@
         response = toResponse(iq, u'result')
         response.addElement((NS_DISCO_INFO, u'query'))
-        self.stub.send(response)
-
+
+        d.callback(response)
         return d
 
@@ -677 +682 @@
 
 
+    def test_onDiscoInfoWithNoFromAttribute(self):
+        """
+        Disco info request without a from attribute has requestor None.
+        """
+        xml = """<iq to='example.com'
+                     type='get'>
+                   <query xmlns='%s'/>
+                 </iq>""" % NS_DISCO_INFO
+
+        def info(requestor, target, nodeIdentifier):
+            self.assertEqual(None, requestor)
+
+            return defer.succeed([
+                disco.DiscoIdentity('dummy', 'generic', 'Generic Dummy Entity'),
+                disco.DiscoFeature('jabber:iq:version')
+            ])
+
+        self.service.info = info
+        d = self.handleRequest(xml)
+        return d
+
+
+    def test_onDiscoInfoWithNoToAttribute(self):
+        """
+        Disco info request without a to attribute has target None.
+        """
+        xml = """<iq from='test@example.com'
+                     type='get'>
+                   <query xmlns='%s'/>
+                 </iq>""" % NS_DISCO_INFO
+
+        def info(requestor, target, nodeIdentifier):
+            self.assertEqual(JID('test@example.com'), requestor)
+
+            return defer.succeed([
+                disco.DiscoIdentity('dummy', 'generic', 'Generic Dummy Entity'),
+                disco.DiscoFeature('jabber:iq:version')
+            ])
+
+        self.service.info = info
+        d = self.handleRequest(xml)
+        return d
+
+
     def test_onDiscoInfoWithNode(self):
         """