blob: 7fddbe822c96e2891895a33b819243a4b773fe78 [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
Martin Pantered0425c2016-06-05 06:28:55 +000014from io import BufferedWriter
Jeremy Hylton1afc1692008-06-18 20:49:58 +000015import sys
16import urllib.parse
Thomas Wouters0e3f5912006-08-11 14:57:12 +000017from wsgiref.handlers import SimpleHandler
Senthil Kumarana5e0eaf2012-07-07 14:29:58 -070018from platform import python_implementation
Thomas Wouters0e3f5912006-08-11 14:57:12 +000019
Phillip J. Ebyb6d4a8e2010-11-03 22:39:01 +000020__version__ = "0.2"
Thomas Wouters0e3f5912006-08-11 14:57:12 +000021__all__ = ['WSGIServer', 'WSGIRequestHandler', 'demo_app', 'make_server']
22
23
24server_version = "WSGIServer/" + __version__
Senthil Kumarana5e0eaf2012-07-07 14:29:58 -070025sys_version = python_implementation() + "/" + sys.version.split()[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +000026software_version = server_version + ' ' + sys_version
27
28
29class ServerHandler(SimpleHandler):
30
31 server_software = software_version
32
33 def close(self):
34 try:
35 self.request_handler.log_request(
36 self.status.split(' ',1)[0], self.bytes_sent
37 )
38 finally:
39 SimpleHandler.close(self)
40
41
42
Thomas Wouters0e3f5912006-08-11 14:57:12 +000043class WSGIServer(HTTPServer):
44
45 """BaseHTTPServer that implements the Python WSGI protocol"""
46
47 application = None
48
49 def server_bind(self):
50 """Override server_bind to store the server name."""
51 HTTPServer.server_bind(self)
52 self.setup_environ()
53
54 def setup_environ(self):
55 # Set up base environment
56 env = self.base_environ = {}
57 env['SERVER_NAME'] = self.server_name
58 env['GATEWAY_INTERFACE'] = 'CGI/1.1'
59 env['SERVER_PORT'] = str(self.server_port)
60 env['REMOTE_HOST']=''
61 env['CONTENT_LENGTH']=''
62 env['SCRIPT_NAME'] = ''
63
64 def get_app(self):
65 return self.application
66
67 def set_app(self,application):
68 self.application = application
69
70
71
Thomas Wouters0e3f5912006-08-11 14:57:12 +000072class WSGIRequestHandler(BaseHTTPRequestHandler):
73
74 server_version = "WSGIServer/" + __version__
75
76 def get_environ(self):
77 env = self.server.base_environ.copy()
78 env['SERVER_PROTOCOL'] = self.request_version
Phillip J. Ebyb6d4a8e2010-11-03 22:39:01 +000079 env['SERVER_SOFTWARE'] = self.server_version
Thomas Wouters0e3f5912006-08-11 14:57:12 +000080 env['REQUEST_METHOD'] = self.command
81 if '?' in self.path:
82 path,query = self.path.split('?',1)
83 else:
84 path,query = self.path,''
85
Martin Panter50dd1f72016-04-17 02:17:03 +000086 env['PATH_INFO'] = urllib.parse.unquote(path, 'iso-8859-1')
Thomas Wouters0e3f5912006-08-11 14:57:12 +000087 env['QUERY_STRING'] = query
88
89 host = self.address_string()
90 if host != self.client_address[0]:
91 env['REMOTE_HOST'] = host
92 env['REMOTE_ADDR'] = self.client_address[0]
93
Barry Warsaw820c1202008-06-12 04:06:45 +000094 if self.headers.get('content-type') is None:
95 env['CONTENT_TYPE'] = self.headers.get_content_type()
Thomas Wouters0e3f5912006-08-11 14:57:12 +000096 else:
Barry Warsaw820c1202008-06-12 04:06:45 +000097 env['CONTENT_TYPE'] = self.headers['content-type']
Thomas Wouters0e3f5912006-08-11 14:57:12 +000098
Barry Warsaw820c1202008-06-12 04:06:45 +000099 length = self.headers.get('content-length')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000100 if length:
101 env['CONTENT_LENGTH'] = length
102
Antoine Pitrou38a66ad2009-01-03 18:41:49 +0000103 for k, v in self.headers.items():
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000104 k=k.replace('-','_').upper(); v=v.strip()
105 if k in env:
106 continue # skip content length, type,etc.
107 if 'HTTP_'+k in env:
108 env['HTTP_'+k] += ','+v # comma-separate multiple headers
109 else:
110 env['HTTP_'+k] = v
111 return env
112
113 def get_stderr(self):
114 return sys.stderr
115
116 def handle(self):
117 """Handle a single HTTP request"""
118
Senthil Kumarane025b522014-09-17 16:29:29 +0800119 self.raw_requestline = self.rfile.readline(65537)
120 if len(self.raw_requestline) > 65536:
121 self.requestline = ''
122 self.request_version = ''
123 self.command = ''
124 self.send_error(414)
125 return
126
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000127 if not self.parse_request(): # An error code has been sent, just exit
128 return
129
Martin Pantered0425c2016-06-05 06:28:55 +0000130 # Avoid passing the raw file object wfile, which can do partial
131 # writes (Issue 24291)
132 stdout = BufferedWriter(self.wfile)
133 try:
134 handler = ServerHandler(
135 self.rfile, stdout, self.get_stderr(), self.get_environ()
136 )
137 handler.request_handler = self # backpointer for logging
138 handler.run(self.server.get_app())
139 finally:
140 stdout.detach()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000141
142
143
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000144def demo_app(environ,start_response):
Guido van Rossum6a10e022007-08-08 17:01:45 +0000145 from io import StringIO
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000146 stdout = StringIO()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000147 print("Hello world!", file=stdout)
148 print(file=stdout)
Antoine Pitrou38a66ad2009-01-03 18:41:49 +0000149 h = sorted(environ.items())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000150 for k,v in h:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000151 print(k,'=',repr(v), file=stdout)
Phillip J. Ebya01799f2010-11-03 00:46:45 +0000152 start_response("200 OK", [('Content-Type','text/plain; charset=utf-8')])
Antoine Pitrou38a66ad2009-01-03 18:41:49 +0000153 return [stdout.getvalue().encode("utf-8")]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000154
155
156def make_server(
157 host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler
158):
159 """Create a new WSGI server listening on `host` and `port` for `app`"""
160 server = server_class((host, port), handler_class)
161 server.set_app(app)
162 return server
163
164
165if __name__ == '__main__':
166 httpd = make_server('', 8000, demo_app)
167 sa = httpd.socket.getsockname()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000168 print("Serving HTTP on", sa[0], "port", sa[1], "...")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000169 import webbrowser
170 webbrowser.open('http://localhost:8000/xyz?abc')
171 httpd.handle_request() # serve one request, then exit
Georg Brandld98d6cb2013-10-14 16:52:13 +0200172 httpd.server_close()