blob: af82f953c5329923bfd212f41f418add5af8b992 [file] [log] [blame]
Phillip J. Ebya01799f2010-11-03 00:46:45 +00001"""BaseHTTPServer that implements the Python WSGI protocol (PEP 3333)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002
3This is both an example of how WSGI can be implemented, and a basis for running
4simple web applications on a local machine, such as might be done when testing
5or debugging an application. It has not been reviewed for security issues,
6however, and we strongly recommend that you use a "real" web server for
7production use.
8
9For example usage, see the 'if __name__=="__main__"' block at the end of the
10module. See also the BaseHTTPServer module docs for other API information.
11"""
12
Georg Brandl24420152008-05-26 16:32:26 +000013from http.server import BaseHTTPRequestHandler, HTTPServer
Jeremy Hylton1afc1692008-06-18 20:49:58 +000014import sys
15import urllib.parse
Thomas Wouters0e3f5912006-08-11 14:57:12 +000016from wsgiref.handlers import SimpleHandler
17
Phillip J. Ebyb6d4a8e2010-11-03 22:39:01 +000018__version__ = "0.2"
Thomas Wouters0e3f5912006-08-11 14:57:12 +000019__all__ = ['WSGIServer', 'WSGIRequestHandler', 'demo_app', 'make_server']
20
21
22server_version = "WSGIServer/" + __version__
23sys_version = "Python/" + sys.version.split()[0]
24software_version = server_version + ' ' + sys_version
25
26
27class ServerHandler(SimpleHandler):
28
29 server_software = software_version
30
31 def close(self):
32 try:
33 self.request_handler.log_request(
34 self.status.split(' ',1)[0], self.bytes_sent
35 )
36 finally:
37 SimpleHandler.close(self)
38
39
40
Thomas Wouters0e3f5912006-08-11 14:57:12 +000041class WSGIServer(HTTPServer):
42
43 """BaseHTTPServer that implements the Python WSGI protocol"""
44
45 application = None
46
47 def server_bind(self):
48 """Override server_bind to store the server name."""
49 HTTPServer.server_bind(self)
50 self.setup_environ()
51
52 def setup_environ(self):
53 # Set up base environment
54 env = self.base_environ = {}
55 env['SERVER_NAME'] = self.server_name
56 env['GATEWAY_INTERFACE'] = 'CGI/1.1'
57 env['SERVER_PORT'] = str(self.server_port)
58 env['REMOTE_HOST']=''
59 env['CONTENT_LENGTH']=''
60 env['SCRIPT_NAME'] = ''
61
62 def get_app(self):
63 return self.application
64
65 def set_app(self,application):
66 self.application = application
67
68
69
Thomas Wouters0e3f5912006-08-11 14:57:12 +000070class WSGIRequestHandler(BaseHTTPRequestHandler):
71
72 server_version = "WSGIServer/" + __version__
73
74 def get_environ(self):
75 env = self.server.base_environ.copy()
76 env['SERVER_PROTOCOL'] = self.request_version
Phillip J. Ebyb6d4a8e2010-11-03 22:39:01 +000077 env['SERVER_SOFTWARE'] = self.server_version
Thomas Wouters0e3f5912006-08-11 14:57:12 +000078 env['REQUEST_METHOD'] = self.command
79 if '?' in self.path:
80 path,query = self.path.split('?',1)
81 else:
82 path,query = self.path,''
83
Phillip J. Ebyb6d4a8e2010-11-03 22:39:01 +000084 env['PATH_INFO'] = urllib.parse.unquote_to_bytes(path).decode('iso-8859-1')
Thomas Wouters0e3f5912006-08-11 14:57:12 +000085 env['QUERY_STRING'] = query
86
87 host = self.address_string()
88 if host != self.client_address[0]:
89 env['REMOTE_HOST'] = host
90 env['REMOTE_ADDR'] = self.client_address[0]
91
Barry Warsaw820c1202008-06-12 04:06:45 +000092 if self.headers.get('content-type') is None:
93 env['CONTENT_TYPE'] = self.headers.get_content_type()
Thomas Wouters0e3f5912006-08-11 14:57:12 +000094 else:
Barry Warsaw820c1202008-06-12 04:06:45 +000095 env['CONTENT_TYPE'] = self.headers['content-type']
Thomas Wouters0e3f5912006-08-11 14:57:12 +000096
Barry Warsaw820c1202008-06-12 04:06:45 +000097 length = self.headers.get('content-length')
Thomas Wouters0e3f5912006-08-11 14:57:12 +000098 if length:
99 env['CONTENT_LENGTH'] = length
100
Antoine Pitrou38a66ad2009-01-03 18:41:49 +0000101 for k, v in self.headers.items():
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000102 k=k.replace('-','_').upper(); v=v.strip()
103 if k in env:
104 continue # skip content length, type,etc.
105 if 'HTTP_'+k in env:
106 env['HTTP_'+k] += ','+v # comma-separate multiple headers
107 else:
108 env['HTTP_'+k] = v
109 return env
110
111 def get_stderr(self):
112 return sys.stderr
113
114 def handle(self):
115 """Handle a single HTTP request"""
116
117 self.raw_requestline = self.rfile.readline()
118 if not self.parse_request(): # An error code has been sent, just exit
119 return
120
121 handler = ServerHandler(
122 self.rfile, self.wfile, self.get_stderr(), self.get_environ()
123 )
124 handler.request_handler = self # backpointer for logging
125 handler.run(self.server.get_app())
126
127
128
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129def demo_app(environ,start_response):
Guido van Rossum6a10e022007-08-08 17:01:45 +0000130 from io import StringIO
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000131 stdout = StringIO()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000132 print("Hello world!", file=stdout)
133 print(file=stdout)
Antoine Pitrou38a66ad2009-01-03 18:41:49 +0000134 h = sorted(environ.items())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000135 for k,v in h:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000136 print(k,'=',repr(v), file=stdout)
Phillip J. Ebya01799f2010-11-03 00:46:45 +0000137 start_response("200 OK", [('Content-Type','text/plain; charset=utf-8')])
Antoine Pitrou38a66ad2009-01-03 18:41:49 +0000138 return [stdout.getvalue().encode("utf-8")]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000139
140
141def make_server(
142 host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler
143):
144 """Create a new WSGI server listening on `host` and `port` for `app`"""
145 server = server_class((host, port), handler_class)
146 server.set_app(app)
147 return server
148
149
150if __name__ == '__main__':
151 httpd = make_server('', 8000, demo_app)
152 sa = httpd.socket.getsockname()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000153 print("Serving HTTP on", sa[0], "port", sa[1], "...")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000154 import webbrowser
155 webbrowser.open('http://localhost:8000/xyz?abc')
156 httpd.handle_request() # serve one request, then exit