mitmproxy/netlib/wsgi.py

from __future__ import (absolute_import, print_function, division)
from io import BytesIO
import urllib
import time
import traceback

import six

from . import http, tcp


class ClientConn(object):

    def __init__(self, address):
        self.address = tcp.Address.wrap(address)


class Flow(object):

    def __init__(self, address, request):
        self.client_conn = ClientConn(address)
        self.request = request


class Request(object):

    def __init__(self, scheme, method, path, headers, body):
        self.scheme, self.method, self.path = scheme, method, path
        self.headers, self.body = headers, body


def date_time_string():
    """Return the current date and time formatted for a message header."""
    WEEKS = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
    MONTHS = [
        None,
        'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
        'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
    ]
    now = time.time()
    year, month, day, hh, mm, ss, wd, y_, z_ = time.gmtime(now)
    s = "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (
        WEEKS[wd],
        day, MONTHS[month], year,
        hh, mm, ss
    )
    return s


class WSGIAdaptor(object):

    def __init__(self, app, domain, port, sversion):
        self.app, self.domain, self.port, self.sversion = app, domain, port, sversion

    def make_environ(self, flow, errsoc, **extra):
        if '?' in flow.request.path:
            path_info, query = flow.request.path.split('?', 1)
        else:
            path_info = flow.request.path
            query = ''
        environ = {
            'wsgi.version': (1, 0),
            'wsgi.url_scheme': flow.request.scheme,
            'wsgi.input': BytesIO(flow.request.body or b""),
            'wsgi.errors': errsoc,
            'wsgi.multithread': True,
            'wsgi.multiprocess': False,
            'wsgi.run_once': False,
            'SERVER_SOFTWARE': self.sversion,
            'REQUEST_METHOD': flow.request.method,
            'SCRIPT_NAME': '',
            'PATH_INFO': urllib.unquote(path_info),
            'QUERY_STRING': query,
            'CONTENT_TYPE': flow.request.headers.get('Content-Type', ''),
            'CONTENT_LENGTH': flow.request.headers.get('Content-Length', ''),
            'SERVER_NAME': self.domain,
            'SERVER_PORT': str(self.port),
            # FIXME: We need to pick up the protocol read from the request.
            'SERVER_PROTOCOL': "HTTP/1.1",
        }
        environ.update(extra)
        if flow.client_conn.address:
            environ["REMOTE_ADDR"], environ[
                "REMOTE_PORT"] = flow.client_conn.address()

        for key, value in flow.request.headers.items():
            key = 'HTTP_' + key.upper().replace('-', '_')
            if key not in ('HTTP_CONTENT_TYPE', 'HTTP_CONTENT_LENGTH'):
                environ[key] = value
        return environ

    def error_page(self, soc, headers_sent, s):
        """
            Make a best-effort attempt to write an error page. If headers are
            already sent, we just bung the error into the page.
        """
        c = b"""
            <html>
                <h1>Internal Server Error</h1>
                <pre>%s"</pre>
            </html>
        """.strip() % s
        if not headers_sent:
            soc.write(b"HTTP/1.1 500 Internal Server Error\r\n")
            soc.write(b"Content-Type: text/html\r\n")
            soc.write(b"Content-Length: %s\r\n" % len(c))
            soc.write(b"\r\n")
        soc.write(c)

    def serve(self, request, soc, **env):
        state = dict(
            response_started=False,
            headers_sent=False,
            status=None,
            headers=None
        )

        def write(data):
            if not state["headers_sent"]:
                soc.write(b"HTTP/1.1 %s\r\n" % state["status"])
                headers = state["headers"]
                if 'server' not in headers:
                    headers["Server"] = self.sversion
                if 'date' not in headers:
                    headers["Date"] = date_time_string()
                soc.write(bytes(headers))
                soc.write(b"\r\n")
                state["headers_sent"] = True
            if data:
                soc.write(data)
            soc.flush()

        def start_response(status, headers, exc_info=None):
            if exc_info:
                try:
                    if state["headers_sent"]:
                        six.reraise(*exc_info)
                finally:
                    exc_info = None
            elif state["status"]:
                raise AssertionError('Response already started')
            state["status"] = status
            state["headers"] = http.Headers(headers)
            return write

        errs = BytesIO()
        try:
            dataiter = self.app(
                self.make_environ(request, errs, **env), start_response
            )
            for i in dataiter:
                write(i)
            if not state["headers_sent"]:
                write(b"")
        except Exception as e:
            try:
                s = traceback.format_exc()
                errs.write(s)
                self.error_page(soc, state["headers_sent"], s)
            except Exception:    # pragma: no cover
                pass
        return errs.getvalue()
minor cleanups 2014-08-16 13:53:07 +00:00			`from __future__ import (absolute_import, print_function, division)`
python3++ 2015-09-20 16:12:55 +00:00			`from io import BytesIO`
ODict improvements - Setting values now tries to preserve the existing order, rather than just appending to the end. - __repr__ now returns a repr of the tuple list. The old repr becomes a .format() method. This is clearer, makes troubleshooting easier, and doesn't assume all data in ODicts are header-like 2015-04-14 22:28:17 +00:00			`import urllib`
			`import time`
			`import traceback`
python3++ 2015-09-20 16:12:55 +00:00
			`import six`

headers: adjust everything 2015-09-05 16:15:47 +00:00			`from . import http, tcp`
Import wsgi. 2012-06-18 22:42:25 +00:00
Adapt WSGI, convert test suite to nose. 2012-06-19 02:23:22 +00:00
fix code smell 2015-04-09 00:09:33 +00:00			`class ClientConn(object):`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00
Adapt WSGI, convert test suite to nose. 2012-06-19 02:23:22 +00:00			`def __init__(self, address):`
adjust netlib.wsgi to reflect changes in mitmproxys flow format 2014-02-05 20:34:14 +00:00			`self.address = tcp.Address.wrap(address)`


fix code smell 2015-04-09 00:09:33 +00:00			`class Flow(object):`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00
adapt netlib.wsgi to changes in mitmproxy/mitmproxy#341 2014-09-03 15:15:50 +00:00			`def __init__(self, address, request):`
			`self.client_conn = ClientConn(address)`
			`self.request = request`
Adapt WSGI, convert test suite to nose. 2012-06-19 02:23:22 +00:00

fix code smell 2015-04-09 00:09:33 +00:00			`class Request(object):`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00
rename content -> body 2015-07-19 16:17:30 +00:00			`def __init__(self, scheme, method, path, headers, body):`
Adapt WSGI, convert test suite to nose. 2012-06-19 02:23:22 +00:00			`self.scheme, self.method, self.path = scheme, method, path`
rename content -> body 2015-07-19 16:17:30 +00:00			`self.headers, self.body = headers, body`
Adapt WSGI, convert test suite to nose. 2012-06-19 02:23:22 +00:00

Import wsgi. 2012-06-18 22:42:25 +00:00			`def date_time_string():`
			`"""Return the current date and time formatted for a message header."""`
			`WEEKS = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']`
ODict improvements - Setting values now tries to preserve the existing order, rather than just appending to the end. - __repr__ now returns a repr of the tuple list. The old repr becomes a .format() method. This is clearer, makes troubleshooting easier, and doesn't assume all data in ODicts are header-like 2015-04-14 22:28:17 +00:00			`MONTHS = [`
			`None,`
			`'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',`
			`'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'`
			`]`
Import wsgi. 2012-06-18 22:42:25 +00:00			`now = time.time()`
mark unused variables and arguments 2015-06-18 13:32:52 +00:00			`year, month, day, hh, mm, ss, wd, y_, z_ = time.gmtime(now)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`s = "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (`
ODict improvements - Setting values now tries to preserve the existing order, rather than just appending to the end. - __repr__ now returns a repr of the tuple list. The old repr becomes a .format() method. This is clearer, makes troubleshooting easier, and doesn't assume all data in ODicts are header-like 2015-04-14 22:28:17 +00:00			`WEEKS[wd],`
			`day, MONTHS[month], year,`
			`hh, mm, ss`
			`)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`return s`


fix code smell 2015-04-09 00:09:33 +00:00			`class WSGIAdaptor(object):`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00
Import wsgi. 2012-06-18 22:42:25 +00:00			`def __init__(self, app, domain, port, sversion):`
			`self.app, self.domain, self.port, self.sversion = app, domain, port, sversion`

adapt netlib.wsgi to changes in mitmproxy/mitmproxy#341 2014-09-03 15:15:50 +00:00			`def make_environ(self, flow, errsoc, **extra):`
			`if '?' in flow.request.path:`
			`path_info, query = flow.request.path.split('?', 1)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`else:`
adapt netlib.wsgi to changes in mitmproxy/mitmproxy#341 2014-09-03 15:15:50 +00:00			`path_info = flow.request.path`
Import wsgi. 2012-06-18 22:42:25 +00:00			`query = ''`
			`environ = {`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00			`'wsgi.version': (1, 0),`
			`'wsgi.url_scheme': flow.request.scheme,`
python3++ 2015-09-20 16:12:55 +00:00			`'wsgi.input': BytesIO(flow.request.body or b""),`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00			`'wsgi.errors': errsoc,`
			`'wsgi.multithread': True,`
			`'wsgi.multiprocess': False,`
			`'wsgi.run_once': False,`
			`'SERVER_SOFTWARE': self.sversion,`
			`'REQUEST_METHOD': flow.request.method,`
			`'SCRIPT_NAME': '',`
			`'PATH_INFO': urllib.unquote(path_info),`
			`'QUERY_STRING': query,`
headers: adjust everything 2015-09-05 16:15:47 +00:00			`'CONTENT_TYPE': flow.request.headers.get('Content-Type', ''),`
			`'CONTENT_LENGTH': flow.request.headers.get('Content-Length', ''),`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00			`'SERVER_NAME': self.domain,`
			`'SERVER_PORT': str(self.port),`
Import wsgi. 2012-06-18 22:42:25 +00:00			`# FIXME: We need to pick up the protocol read from the request.`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00			`'SERVER_PROTOCOL': "HTTP/1.1",`
Import wsgi. 2012-06-18 22:42:25 +00:00			`}`
Make it possible to pass custom environment variables into wsgi apps. 2014-01-04 21:57:50 +00:00			`environ.update(extra)`
adapt netlib.wsgi to changes in mitmproxy/mitmproxy#341 2014-09-03 15:15:50 +00:00			`if flow.client_conn.address:`
Adjust pep8 parameters, reformat 2015-05-30 00:02:58 +00:00			`environ["REMOTE_ADDR"], environ[`
			`"REMOTE_PORT"] = flow.client_conn.address()`
Import wsgi. 2012-06-18 22:42:25 +00:00
adapt netlib.wsgi to changes in mitmproxy/mitmproxy#341 2014-09-03 15:15:50 +00:00			`for key, value in flow.request.headers.items():`
Import wsgi. 2012-06-18 22:42:25 +00:00			`key = 'HTTP_' + key.upper().replace('-', '_')`
			`if key not in ('HTTP_CONTENT_TYPE', 'HTTP_CONTENT_LENGTH'):`
			`environ[key] = value`
			`return environ`

			`def error_page(self, soc, headers_sent, s):`
			`"""`
			`Make a best-effort attempt to write an error page. If headers are`
			`already sent, we just bung the error into the page.`
			`"""`
python3++ 2015-09-20 16:12:55 +00:00			`c = b"""`
Import wsgi. 2012-06-18 22:42:25 +00:00			`<html>`
			`<h1>Internal Server Error</h1>`
			`<pre>%s"</pre>`
			`</html>`
python3++ 2015-09-20 16:12:55 +00:00			`""".strip() % s`
Import wsgi. 2012-06-18 22:42:25 +00:00			`if not headers_sent:`
python3++ 2015-09-20 16:12:55 +00:00			`soc.write(b"HTTP/1.1 500 Internal Server Error\r\n")`
			`soc.write(b"Content-Type: text/html\r\n")`
			`soc.write(b"Content-Length: %s\r\n" % len(c))`
			`soc.write(b"\r\n")`
Import wsgi. 2012-06-18 22:42:25 +00:00			`soc.write(c)`

Make it possible to pass custom environment variables into wsgi apps. 2014-01-04 21:57:50 +00:00			`def serve(self, request, soc, **env):`
Import wsgi. 2012-06-18 22:42:25 +00:00			`state = dict(`
cleanup code with autopep8 run the following command: $ autopep8 -i -r -a -a . 2015-05-27 09:18:54 +00:00			`response_started=False,`
			`headers_sent=False,`
			`status=None,`
			`headers=None`
Import wsgi. 2012-06-18 22:42:25 +00:00			`)`
ODict improvements - Setting values now tries to preserve the existing order, rather than just appending to the end. - __repr__ now returns a repr of the tuple list. The old repr becomes a .format() method. This is clearer, makes troubleshooting easier, and doesn't assume all data in ODicts are header-like 2015-04-14 22:28:17 +00:00
Import wsgi. 2012-06-18 22:42:25 +00:00			`def write(data):`
			`if not state["headers_sent"]:`
python3++ 2015-09-20 16:12:55 +00:00			`soc.write(b"HTTP/1.1 %s\r\n" % state["status"])`
headers: adjust everything 2015-09-05 16:15:47 +00:00			`headers = state["headers"]`
			`if 'server' not in headers:`
			`headers["Server"] = self.sversion`
			`if 'date' not in headers:`
			`headers["Date"] = date_time_string()`
python3++ 2015-09-20 16:12:55 +00:00			`soc.write(bytes(headers))`
			`soc.write(b"\r\n")`
Import wsgi. 2012-06-18 22:42:25 +00:00			`state["headers_sent"] = True`
Hunt down a tricky WSGI socket hang. 2012-06-26 02:49:23 +00:00			`if data:`
			`soc.write(data)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`soc.flush()`

			`def start_response(status, headers, exc_info=None):`
			`if exc_info:`
			`try:`
			`if state["headers_sent"]:`
python3++ 2015-09-20 16:12:55 +00:00			`six.reraise(*exc_info)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`finally:`
			`exc_info = None`
			`elif state["status"]:`
			`raise AssertionError('Response already started')`
			`state["status"] = status`
headers: adjust everything 2015-09-05 16:15:47 +00:00			`state["headers"] = http.Headers(headers)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`return write`

python3++ 2015-09-20 16:12:55 +00:00			`errs = BytesIO()`
Import wsgi. 2012-06-18 22:42:25 +00:00			`try:`
ODict improvements - Setting values now tries to preserve the existing order, rather than just appending to the end. - __repr__ now returns a repr of the tuple list. The old repr becomes a .format() method. This is clearer, makes troubleshooting easier, and doesn't assume all data in ODicts are header-like 2015-04-14 22:28:17 +00:00			`dataiter = self.app(`
			`self.make_environ(request, errs, **env), start_response`
			`)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`for i in dataiter:`
			`write(i)`
			`if not state["headers_sent"]:`
python3++ 2015-09-20 16:12:55 +00:00			`write(b"")`
headers: adjust everything 2015-09-05 16:15:47 +00:00			`except Exception as e:`
Import wsgi. 2012-06-18 22:42:25 +00:00			`try:`
			`s = traceback.format_exc()`
Signal errors back to caller in WSGI .serve() 2012-07-10 19:16:45 +00:00			`errs.write(s)`
Import wsgi. 2012-06-18 22:42:25 +00:00			`self.error_page(soc, state["headers_sent"], s)`
More accurate description of an HTTP read error, make pyflakes happy. 2013-02-23 22:08:43 +00:00			`except Exception: # pragma: no cover`
			`pass`
Import wsgi. 2012-06-18 22:42:25 +00:00			`return errs.getvalue()`