|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187 |
- ###############################################################################
- #
- # The MIT License (MIT)
- #
- # Copyright (c) typedef int GmbH
- #
- # Permission is hereby granted, free of charge, to any person obtaining a copy
- # of this software and associated documentation files (the "Software"), to deal
- # in the Software without restriction, including without limitation the rights
- # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- # copies of the Software, and to permit persons to whom the Software is
- # furnished to do so, subject to the following conditions:
- #
- # The above copyright notice and this permission notice shall be included in
- # all copies or substantial portions of the Software.
- #
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- # THE SOFTWARE.
- #
- ###############################################################################
-
- from autobahn.util import public
-
- from urllib import parse as urlparse
- # The Python urlparse module currently does not contain the ws/wss
- # schemes, so we add those dynamically (which is a hack of course).
- #
- # Important: if you change this stuff (you shouldn't), make sure
- # _all_ our unit tests for WS URLs succeed
- #
- wsschemes = ["ws", "wss"]
- urlparse.uses_relative.extend(wsschemes)
- urlparse.uses_netloc.extend(wsschemes)
- urlparse.uses_params.extend(wsschemes)
- urlparse.uses_query.extend(wsschemes)
- urlparse.uses_fragment.extend(wsschemes)
-
- __all__ = (
- "create_url",
- "parse_url",
- )
-
-
- @public
- def create_url(hostname, port=None, isSecure=False, path=None, params=None):
- """
- Create a WebSocket URL from components.
-
- :param hostname: WebSocket server hostname (for TCP/IP sockets) or
- filesystem path (for Unix domain sockets).
- :type hostname: str
-
- :param port: For TCP/IP sockets, WebSocket service port or ``None`` (to select default
- ports ``80`` or ``443`` depending on ``isSecure``. When ``hostname=="unix"``,
- this defines the path to the Unix domain socket instead of a TCP/IP network socket.
- :type port: int or str
-
- :param isSecure: Set ``True`` for secure WebSocket (``wss`` scheme).
- :type isSecure: bool
-
- :param path: WebSocket URL path of addressed resource (will be
- properly URL escaped). Ignored for RawSocket.
- :type path: str
-
- :param params: A dictionary of key-values to construct the query
- component of the addressed WebSocket resource (will be properly URL
- escaped). Ignored for RawSocket.
- :type params: dict
-
- :returns: Constructed WebSocket URL.
- :rtype: str
- """
- # assert type(hostname) == str
- assert type(isSecure) == bool
-
- if hostname == 'unix':
- netloc = "unix:%s" % port
- else:
- assert port is None or (type(port) == int and port in range(0, 65535))
-
- if port is not None:
- netloc = "%s:%d" % (hostname, port)
- else:
- if isSecure:
- netloc = "%s:443" % hostname
- else:
- netloc = "%s:80" % hostname
-
- if isSecure:
- scheme = "wss"
- else:
- scheme = "ws"
-
- if path is not None:
- ppath = urlparse.quote(path)
- else:
- ppath = "/"
-
- if params is not None:
- query = urlparse.urlencode(params)
- else:
- query = None
-
- return urlparse.urlunparse((scheme, netloc, ppath, None, query, None))
-
-
- @public
- def parse_url(url):
- """
- Parses as WebSocket URL into it's components and returns a tuple:
-
- - ``isSecure`` is a flag which is ``True`` for ``wss`` URLs.
- - ``host`` is the hostname or IP from the URL.
-
- and for TCP/IP sockets:
-
- - ``tcp_port`` is the port from the URL or standard port derived from
- scheme (``rs`` => ``80``, ``rss`` => ``443``).
-
- or for Unix domain sockets:
-
- - ``uds_path`` is the path on the local host filesystem.
-
- :param url: A valid WebSocket URL, i.e. ``ws://localhost:9000`` for TCP/IP sockets or
- ``ws://unix:/tmp/file.sock`` for Unix domain sockets (UDS).
- :type url: str
-
- :returns: A 6-tuple ``(isSecure, host, tcp_port, resource, path, params)`` (TCP/IP) or
- ``(isSecure, host, uds_path, resource, path, params)`` (UDS).
- :rtype: tuple
- """
- parsed = urlparse.urlparse(url)
-
- if parsed.scheme not in ["ws", "wss"]:
- raise ValueError("invalid WebSocket URL: protocol scheme '{}' is not for WebSocket".format(parsed.scheme))
-
- if not parsed.hostname or parsed.hostname == "":
- raise ValueError("invalid WebSocket URL: missing hostname")
-
- if parsed.fragment is not None and parsed.fragment != "":
- raise ValueError("invalid WebSocket URL: non-empty fragment '%s" % parsed.fragment)
-
- if parsed.path is not None and parsed.path != "":
- ppath = parsed.path
- path = urlparse.unquote(ppath)
- else:
- ppath = "/"
- path = ppath
-
- if parsed.query is not None and parsed.query != "":
- resource = ppath + "?" + parsed.query
- params = urlparse.parse_qs(parsed.query)
- else:
- resource = ppath
- params = {}
-
- if parsed.hostname == "unix":
- # Unix domain sockets sockets
-
- # ws://unix:/tmp/file.sock => unix:/tmp/file.sock => /tmp/file.sock
- fp = parsed.netloc + parsed.path
- uds_path = fp.split(':')[1]
-
- # note: we don't interpret "path" in any further way: it needs to be
- # a path on the local host with a listening Unix domain sockets at the other end ..
- return parsed.scheme == "wss", parsed.hostname, uds_path, resource, path, params
-
- else:
- # TCP/IP sockets
-
- if parsed.port is None or parsed.port == "":
- if parsed.scheme == "ws":
- tcp_port = 80
- else:
- tcp_port = 443
- else:
- tcp_port = int(parsed.port)
-
- if tcp_port < 1 or tcp_port > 65535:
- raise ValueError("invalid port {}".format(tcp_port))
-
- return parsed.scheme == "wss", parsed.hostname, tcp_port, resource, path, params
|