Fix Host parsing when circuits.web.Server is bound to a UNIX Socket (#…

…165)
circuits · Jun 21, 2016 · 50b562f · spaceone · Jun 21, 2016 · spaceone
1 parent a0db5ba
commit 50b562f
Show file tree

Hide file tree

Showing 7 changed files with 92 additions and 49 deletions.
diff --git a/circuits/web/http.py b/circuits/web/http.py
@@ -6,6 +6,7 @@
 
 
 from io import BytesIO
+from socket import socket
 
 try:
     from urllib.parse import quote
@@ -22,6 +23,7 @@
 
 from . import wrappers
 from .url import parse_url
+from .utils import is_unix_socket
 from .exceptions import HTTPException
 from .events import request, response, stream
 from .parsers import HttpParser, BAD_FIRST_LINE
@@ -39,7 +41,6 @@
 
 
 class HTTP(BaseComponent):
-
     """HTTP Protocol Component
 
     Implements the HTTP server protocol and parses and processes incoming
@@ -65,15 +66,7 @@ def __init__(self, server, encoding=HTTP_ENCODING, channel=channel):
         self._server = server
         self._encoding = encoding
 
-        url = "{0:s}://{1:s}{2:s}".format(
-            (server.secure and "https") or "http",
-            server.host or "0.0.0.0",
-            ":{0:d}".format(server.port or 80)
-            if server.port not in (80, 443)
-            else ""
-        )
-        self.uri = parse_url(url)
-
+        self._uri = None
         self._clients = {}
         self._buffers = {}
 
@@ -93,10 +86,31 @@ def scheme(self):
 
     @property
     def base(self):
-        if not hasattr(self, "uri"):
+        if getattr(self, "uri", None) is None:
             return
         return self.uri.utf8().rstrip(b"/").decode(self._encoding)
 
+    @property
+    def uri(self):
+        if getattr(self, "_uri", None) is None:
+            return
+        return self._uri
+
+    @handler("ready", priority=1.0)
+    def _on_ready(self, server, bind):
+        if is_unix_socket(server.host):
+            url = server.host
+        else:
+            url = "{0:s}://{1:s}{2:s}".format(
+                (server.secure and "https") or "http",
+                server.host or "0.0.0.0",
+                ":{0:d}".format(server.port or 80)
+                if server.port not in (80, 443)
+                else ""
+            )
+
+        self._uri = parse_url(url)
+
     @handler("stream")  # noqa
     def _on_stream(self, res, data):
         sock = res.request.sock
@@ -440,6 +454,9 @@ def _on_exception(self, *args, **kwargs):
             req, res = fevent.value.parent.event.args[:2]
         elif len(fevent.args[2:]) == 4:
             req, res = fevent.args[2:]
+        elif len(fevent.args) == 2 and isinstance(fevent.args[0], socket):
+            req = wrappers.Request(fevent.args[0], server=self._server)
+            res = wrappers.Response(req, self._encoding, 500)
         else:
             return
 

diff --git a/circuits/web/url.py b/circuits/web/url.py
@@ -213,7 +213,8 @@ def abspath(self):
 
     def lower(self):
         '''Lowercase the hostname'''
-        self._host = self._host.lower()
+        if self._host is not None:
+            self._host = self._host.lower()
         return self
 
     def sanitize(self):

diff --git a/circuits/web/utils.py b/circuits/web/utils.py
@@ -4,8 +4,10 @@
 """
 
 import re
+import os
 import zlib
 import time
+import stat
 import struct
 from math import sqrt
 from io import TextIOWrapper
@@ -29,6 +31,15 @@
 image_map_pattern = re.compile("^[0-9]+,[0-9]+$")
 
 
+def is_unix_socket(path):
+    if not os.path.exists(path):
+        return False
+
+    mode = os.stat(path).st_mode
+
+    return stat.S_ISSOCK(mode)
+
+
 def average(xs):
     return sum(xs) * 1.0 / len(xs)
 

diff --git a/circuits/web/wrappers.py b/circuits/web/wrappers.py
@@ -13,24 +13,28 @@
 except ImportError:
     from http.cookies import SimpleCookie  # NOQA
 
+try:
+    from email.utils import formatdate
+    formatdate = partial(formatdate, usegmt=True)
+except ImportError:
+    from rfc822 import formatdate as HTTPDate  # NOQA
+
+
+from circuits.six import binary_type
+from circuits.net.sockets import BUFSIZE
+
+
 from .url import parse_url
 from .headers import Headers
-from ..six import binary_type
 from .errors import httperror
-from circuits.net.sockets import BUFSIZE
 from .constants import HTTP_STATUS_CODES, SERVER_VERSION
 
+
 try:
     unicode
 except NameError:
     unicode = str
 
-try:
-    from email.utils import formatdate
-    formatdate = partial(formatdate, usegmt=True)
-except ImportError:
-    from rfc822 import formatdate as HTTPDate  # NOQA
-
 
 def file_generator(input, chunkSize=BUFSIZE):
     chunk = input.read(chunkSize)
@@ -176,11 +180,12 @@ def __init__(self, sock, method="GET", scheme="http", path="/",
 
         if sock is not None:
             name = sock.getpeername()
-            if name is not None:
-                self.remote = Host(*name)
-            else:
-                name = sock.getsockname()
-                self.remote = Host(name, "", name)
+            try:
+                ip, port = name
+                name = None
+            except ValueError:  # AF_UNIX
+                ip, port = None, None
+            self.remote = Host(ip, port, name)
 
         cookie = self.headers.get("Cookie")
         if cookie is not None:
@@ -209,8 +214,11 @@ def __init__(self, sock, method="GET", scheme="http", path="/",
         base = "{0:s}://{1:s}{2:s}/".format(
             self.scheme,
             self.host,
-            ":{0:d}".format(self.port) if self.port not in (80, 443) else ""
+            ":{0:d}".format(self.port)
+            if self.port not in (80, 443)
+            else ""
         )
+
         self.base = parse_url(base)
 
         url = "{0:s}{1:s}{2:s}".format(

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -10,6 +10,7 @@ wheel
 # Running Tests
 tox
 pytest
+uhttplib
 coveralls
 pytest-cov
 

diff --git a/tests/web/test_disps.py b/tests/web/test_disps.py
@@ -1,22 +1,18 @@
 #!/usr/bin/env python
 
-from circuits.core.manager import Manager
-from circuits.core.handlers import handler
-from circuits.core.components import BaseComponent
 
+from circuits.core.handlers import handler
 from circuits.web import BaseServer, Controller
+from circuits.core.components import BaseComponent
 from circuits.web.dispatchers.dispatcher import Dispatcher
 
+
 from .helpers import urlopen, urljoin
 
 
 class PrefixingDispatcher(BaseComponent):
-
     """Forward to another Dispatcher based on the channel."""
 
-    def __init__(self, channel):
-        super(PrefixingDispatcher, self).__init__(channel=channel)
-
     @handler("request", priority=1.0)
     def _on_request(self, event, request, response):
         path = request.path.strip("/")
@@ -49,24 +45,20 @@ def index(self):
         return "Hello from site 2!"
 
 
-def test_disps():
-
-    manager = Manager()
-
-    server1 = BaseServer(0, channel="site1")
-    server1.register(manager)
-    PrefixingDispatcher(channel="site1").register(server1)
-    Dispatcher(channel="site1").register(server1)
+def test_disps(manager, watcher):
+    server1 = BaseServer(0, channel="site1").register(manager)
+    PrefixingDispatcher(channel="site1").register(manager)
+    Dispatcher(channel="site1").register(manager)
     Root1().register(manager)
+    assert watcher.wait("ready", channel=server1.channel)
 
-    server2 = BaseServer(("localhost", 0), channel="site2")
-    server2.register(manager)
-    PrefixingDispatcher(channel="site2").register(server2)
-    Dispatcher(channel="site2").register(server2)
+    server2 = BaseServer(("localhost", 0), channel="site2").register(manager)
+    PrefixingDispatcher(channel="site2").register(manager)
+    Dispatcher(channel="site2").register(manager)
     Root2().register(manager)
+    assert watcher.wait("ready", channel=server2.channel)
 
     DummyRoot().register(manager)
-    manager.start()
 
     f = urlopen(server1.http.base, timeout=3)
     s = f.read()

diff --git a/tests/web/test_servers.py b/tests/web/test_servers.py
@@ -56,8 +56,9 @@ def index(self):
 
 class MakeQuiet(Component):
 
-    @handler("ready", channel="*", priority=1.0)
-    def _on_ready(self, event, *args):
+    channel = "web"
+
+    def ready(self, event, *args):
         event.stop()
 
 
@@ -140,12 +141,24 @@ def test_unixserver(manager, watcher, tmpfile):
 
     server = Server(tmpfile).register(manager)
     MakeQuiet().register(server)
-    watcher.wait("ready")
+    assert watcher.wait("ready")
 
     Root().register(server)
 
     assert path.basename(server.host) == "test.sock"
 
+    try:
+        from uhttplib import UnixHTTPConnection
+
+        client = UnixHTTPConnection(server.http.base)
+        client.request("GET", "/")
+        response = client.getresponse()
+        s = response.read()
+
+        assert s == b"Hello World!"
+    except ImportError:
+        pass
+
     server.unregister()
     watcher.wait("unregistered")