Changeset 40:2bcb10fb4da4 for wokkel/component.py

Timestamp:

Oct 18, 2008, 12:18:02 PM (14 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

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

Message:

Track changes to Twisted branch for the XMPP router.

File:

• wokkel/component.py (modified) (11 diffs)

wokkel/component.py

@@ -134 +134 @@
     """
     Authenticator for accepting components.
-    """
+
+    @ivar secret: The shared used to authorized incoming component connections.
+    @type secret: C{str}.
+    """
+
     namespace = NS_COMPONENT_ACCEPT
 
@@ -143 +147 @@
 
     def associateWithStream(self, xs):
+        """
+        Associate the authenticator with a stream.
+
+        This sets the stream's version to 0.0, because the XEP-0114 component
+        protocol was not designed for XMPP 1.0.
+        """
         xs.version = (0, 0)
         xmlstream.ListenAuthenticator.associateWithStream(self, xs)
@@ -148 +158 @@
 
     def streamStarted(self, rootElement):
+        """
+        Called by the stream when it has started.
+
+        This examines the default namespace of the incoming stream and whether
+        there is a requested hostname for the component. Then it generates a
+        stream identifier, sends a response header and adds an observer for
+        the first incoming element, triggering L{onElement}.
+        """
+
         xmlstream.ListenAuthenticator.streamStarted(self, rootElement)
+
+        # Compatibility fix
+        if not self.xmlstream.sid:
+            from twisted.python import randbytes
+            self.xmlstream.sid = randbytes.secureRandom(8).encode('hex')
 
         if rootElement.defaultUri != self.namespace:
@@ -156 +180 @@
 
         # self.xmlstream.thisEntity is set to the address the component
-        # wants to assume. This should probably be checked.
+        # wants to assume.
         if not self.xmlstream.thisEntity:
             exc = error.StreamError('improper-addressing')
@@ -162 +186 @@
             return
 
-        self.xmlstream.sid = 'random' # FIXME
-
         self.xmlstream.sendHeader()
         self.xmlstream.addOnetimeObserver('/*', self.onElement)
@@ -169 +191 @@
 
     def onElement(self, element):
+        """
+        Called on incoming XML Stanzas.
+
+        The very first element received should be a request for handshake.
+        Otherwise, the stream is dropped with a 'not-authorized' error. If a
+        handshake request was received, the hash is extracted and passed to
+        L{onHandshake}.
+        """
         if (element.uri, element.name) == (self.namespace, 'handshake'):
             self.onHandshake(unicode(element))
         else:
-            exc = error.streamError('not-authorized')
+            exc = error.StreamError('not-authorized')
             self.xmlstream.sendStreamError(exc)
 
 
     def onHandshake(self, handshake):
+        """
+        Called upon receiving the handshake request.
+
+        This checks that the given hash in C{handshake} is equal to a
+        calculated hash, responding with a handshake reply or a stream error.
+        If the handshake was ok, the stream is authorized, and  XML Stanzas may
+        be exchanged.
+        """
         calculatedHash = xmlstream.hashPassword(self.xmlstream.sid, self.secret)
         if handshake != calculatedHash:
@@ -188 +226 @@
 
 
-class RouterService(service.Service):
-    """
-    XMPP Server's Router Service.
-
-    This service connects the different components of the XMPP service and
-    routes messages between them based on the given routing table.
+class Router(object):
+    """
+    XMPP Server's Router.
+
+    A router connects the different components of the XMPP service and routes
+    messages between them based on the given routing table.
 
     Connected components are trusted to have correct addressing in the
@@ -251 +289 @@
         @type stanza: L{domish.Element}.
         """
-        if not list(stanza.elements()):
-            return
-
         destination = JID(stanza['to'])
 
@@ -265 +300 @@
 
 
-class ComponentServer(service.Service):
-    """
-    XMPP Component Server service.
-
-    This service accepts XMPP external component connections and makes
+class XMPPComponentServerFactory(xmlstream.XmlStreamServerFactory):
+    """
+    XMPP Component Server factory.
+
+    This factory accepts XMPP external component connections and makes
     the router service route traffic for a component's bound domain
     to that component.
@@ -276 +311 @@
     logTraffic = False
 
-    def __init__(self, router, port=5347, secret='secret'):
+    def __init__(self, router, secret='secret'):
         self.router = router
-        self.port = port
         self.secret = secret
 
@@ -284 +318 @@
             return ListenComponentAuthenticator(self.secret)
 
-        self.factory = xmlstream.XmlStreamServerFactory(authenticatorFactory)
-        self.factory.addBootstrap(xmlstream.STREAM_CONNECTED_EVENT,
-                                  self.makeConnection)
-        self.factory.addBootstrap(xmlstream.STREAM_AUTHD_EVENT,
-                                  self.connectionInitialized)
+        xmlstream.XmlStreamServerFactory.__init__(self, authenticatorFactory)
+        self.addBootstrap(xmlstream.STREAM_CONNECTED_EVENT,
+                          self.makeConnection)
+        self.addBootstrap(xmlstream.STREAM_AUTHD_EVENT,
+                          self.connectionInitialized)
 
         self.serial = 0
-
-
-    def startService(self):
-        service.Service.startService(self)
-        reactor.listenTCP(self.port, self.factory)