Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython2 / dc1688adbffffb2f57a69a030b88c49d368f73ce / . / Lib / BaseHTTPServer.py
blob: 5f2d558b689fb8010885f092d4131e16f2d09b54 [file] [log] [blame]
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]1"""HTTP server base class.
2
3Note: the class in this module doesn't implement any HTTP request; see
4SimpleHTTPServer for simple implementations of GET, HEAD and POST
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]5(including CGI scripts). It does, however, optionally implement HTTP/1.1
6persistent connections, as of version 0.3.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]7
8Contents:
9
10- BaseHTTPRequestHandler: HTTP request handler base class
11- test: test function
12
13XXX To do:
14
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]15- log requests even later (to capture byte count)
16- log user-agent header and other interesting goodies
17- send error log to separate file
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]18"""
19
20
21# See also:
22#
23# HTTP Working Group T. Berners-Lee
24# INTERNET-DRAFT R. T. Fielding
25# <draft-ietf-http-v10-spec-00.txt> H. Frystyk Nielsen
26# Expires September 8, 1995 March 8, 1995
27#
28# URL: http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-v10-spec-00.txt
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]29#
30# and
31#
32# Network Working Group R. Fielding
33# Request for Comments: 2616 et al
34# Obsoletes: 2068 June 1999
Tim Peters863ac442002-04-16 01:38:40 +0000[diff] [blame]35# Category: Standards Track
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]36#
37# URL: http://www.faqs.org/rfcs/rfc2616.html
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]38
39# Log files
40# ---------
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]41#
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]42# Here's a quote from the NCSA httpd docs about log file format.
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]43#
44# | The logfile format is as follows. Each line consists of:
45# |
46# | host rfc931 authuser [DD/Mon/YYYY:hh:mm:ss] "request" ddd bbbb
47# |
48# | host: Either the DNS name or the IP number of the remote client
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]49# | rfc931: Any information returned by identd for this person,
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]50# | - otherwise.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]51# | authuser: If user sent a userid for authentication, the user name,
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]52# | - otherwise.
53# | DD: Day
54# | Mon: Month (calendar name)
55# | YYYY: Year
56# | hh: hour (24-hour format, the machine's timezone)
57# | mm: minutes
58# | ss: seconds
59# | request: The first line of the HTTP request as sent by the client.
60# | ddd: the status code returned by the server, - if not available.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]61# | bbbb: the total number of bytes sent,
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]62# | *not including the HTTP/1.0 header*, - if not available
63# |
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]64# | You can determine the name of the file accessed through request.
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]65#
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]66# (Actually, the latter is only true if you know the server configuration
67# at the time the request was made!)
68
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]69__version__ = "0.3"
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]70
Skip Montanaroe99d5ea2001-01-20 19:54:20 +0000[diff] [blame]71__all__ = ["HTTPServer", "BaseHTTPRequestHandler"]
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]72
73import sys
74import time
75import socket # For gethostbyaddr()
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]76import mimetools
Georg Brandle152a772008-05-24 18:31:28 +0000[diff] [blame]77import SocketServer
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]78
Georg Brandl16479232008-02-23 15:02:28 +0000[diff] [blame]79# Default error message template
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]80DEFAULT_ERROR_MESSAGE = """\
81<head>
82<title>Error response</title>
83</head>
84<body>
85<h1>Error response</h1>
86<p>Error code %(code)d.
87<p>Message: %(message)s.
88<p>Error code explanation: %(code)s = %(explain)s.
89</body>
90"""
91
Georg Brandl16479232008-02-23 15:02:28 +0000[diff] [blame]92DEFAULT_ERROR_CONTENT_TYPE = "text/html"
93
Georg Brandla2aa1ac2005-06-26 21:33:14 +0000[diff] [blame]94def _quote_html(html):
95 return html.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]96
Georg Brandle152a772008-05-24 18:31:28 +0000[diff] [blame]97class HTTPServer(SocketServer.TCPServer):
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]98
Guido van Rossum18865de2000-05-09 14:54:13 +0000[diff] [blame]99 allow_reuse_address = 1 # Seems to make sense in testing environment
100
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]101 def server_bind(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]102 """Override server_bind to store the server name."""
Georg Brandle152a772008-05-24 18:31:28 +0000[diff] [blame]103 SocketServer.TCPServer.server_bind(self)
Martin v. Löwis3c120de2003-05-31 07:55:43 +0000[diff] [blame]104 host, port = self.socket.getsockname()[:2]
Peter Schneider-Kamp2d2785a2000-08-16 20:30:21 +0000[diff] [blame]105 self.server_name = socket.getfqdn(host)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]106 self.server_port = port
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]107
108
Georg Brandle152a772008-05-24 18:31:28 +0000[diff] [blame]109class BaseHTTPRequestHandler(SocketServer.StreamRequestHandler):
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]110
111 """HTTP request handler base class.
112
113 The following explanation of HTTP serves to guide you through the
114 code as well as to expose any misunderstandings I may have about
115 HTTP (so you don't need to read the code to figure out I'm wrong
116 :-).
117
118 HTTP (HyperText Transfer Protocol) is an extensible protocol on
119 top of a reliable stream transport (e.g. TCP/IP). The protocol
120 recognizes three parts to a request:
121
122 1. One line identifying the request type and path
123 2. An optional set of RFC-822-style headers
124 3. An optional data part
125
126 The headers and data are separated by a blank line.
127
128 The first line of the request has the form
129
130 <command> <path> <version>
131
132 where <command> is a (case-sensitive) keyword such as GET or POST,
133 <path> is a string containing path information for the request,
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]134 and <version> should be the string "HTTP/1.0" or "HTTP/1.1".
135 <path> is encoded using the URL encoding scheme (using %xx to signify
136 the ASCII character with hex code xx).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]137
Andrew M. Kuchling8ca202e2003-02-03 15:21:15 +0000[diff] [blame]138 The specification specifies that lines are separated by CRLF but
139 for compatibility with the widest range of clients recommends
140 servers also handle LF. Similarly, whitespace in the request line
141 is treated sensibly (allowing multiple spaces between components
142 and allowing trailing whitespace).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]143
144 Similarly, for output, lines ought to be separated by CRLF pairs
145 but most clients grok LF characters just fine.
146
147 If the first line of the request has the form
148
149 <command> <path>
150
151 (i.e. <version> is left out) then this is assumed to be an HTTP
152 0.9 request; this form has no optional headers and data part and
153 the reply consists of just the data.
154
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]155 The reply form of the HTTP 1.x protocol again has three parts:
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]156
157 1. One line giving the response code
158 2. An optional set of RFC-822-style headers
159 3. The data
160
161 Again, the headers and data are separated by a blank line.
162
163 The response code line has the form
164
165 <version> <responsecode> <responsestring>
166
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]167 where <version> is the protocol version ("HTTP/1.0" or "HTTP/1.1"),
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]168 <responsecode> is a 3-digit response code indicating success or
169 failure of the request, and <responsestring> is an optional
170 human-readable string explaining what the response code means.
171
172 This server parses the request and the headers, and then calls a
173 function specific to the request type (<command>). Specifically,
Guido van Rossumba895d81999-09-15 15:28:25 +0000[diff] [blame]174 a request SPAM will be handled by a method do_SPAM(). If no
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]175 such method exists the server sends an error response to the
176 client. If it exists, it is called with no arguments:
177
178 do_SPAM()
179
180 Note that the request name is case sensitive (i.e. SPAM and spam
181 are different requests).
182
183 The various request details are stored in instance variables:
184
185 - client_address is the client IP address in the form (host,
186 port);
187
188 - command, path and version are the broken-down request line;
189
190 - headers is an instance of mimetools.Message (or a derived
191 class) containing the header information;
192
193 - rfile is a file object open for reading positioned at the
194 start of the optional input data part;
195
196 - wfile is a file object open for writing.
197
198 IT IS IMPORTANT TO ADHERE TO THE PROTOCOL FOR WRITING!
199
200 The first thing to be written must be the response line. Then
201 follow 0 or more header lines, then a blank line, and then the
202 actual data (if any). The meaning of the header lines depends on
203 the command executed by the server; in most cases, when data is
204 returned, there should be at least one header line of the form
205
206 Content-type: <type>/<subtype>
207
208 where <type> and <subtype> should be registered MIME types,
209 e.g. "text/html" or "text/plain".
210
211 """
212
213 # The Python system version, truncated to its first component.
Eric S. Raymondb49f4a42001-02-09 05:07:04 +0000[diff] [blame]214 sys_version = "Python/" + sys.version.split()[0]
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]215
216 # The server software version. You may want to override this.
217 # The format is multiple whitespace-separated strings,
218 # where each string is of the form name[/version].
219 server_version = "BaseHTTP/" + __version__
220
Georg Brandlf899dfa2008-05-18 09:12:20 +0000[diff] [blame]221 # The default request version. This only affects responses up until
222 # the point where the request line is parsed, so it mainly decides what
223 # the client gets back when sending a malformed request line.
224 # Most web servers default to HTTP 0.9, i.e. don't send a status line.
225 default_request_version = "HTTP/0.9"
226
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]227 def parse_request(self):
228 """Parse a request (internal).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]229
Raymond Hettingerbf68c782003-06-02 14:25:43 +0000[diff] [blame]230 The request should be stored in self.raw_requestline; the results
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]231 are in self.command, self.path, self.request_version and
232 self.headers.
233
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]234 Return True for success, False for failure; on failure, an
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]235 error is sent back.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]236
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]237 """
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]238 self.command = None # set in case of error on the first line
Georg Brandlf899dfa2008-05-18 09:12:20 +0000[diff] [blame]239 self.request_version = version = self.default_request_version
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]240 self.close_connection = 1
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]241 requestline = self.raw_requestline
242 if requestline[-2:] == '\r\n':
243 requestline = requestline[:-2]
244 elif requestline[-1:] == '\n':
245 requestline = requestline[:-1]
246 self.requestline = requestline
Eric S. Raymondb49f4a42001-02-09 05:07:04 +0000[diff] [blame]247 words = requestline.split()
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]248 if len(words) == 3:
249 [command, path, version] = words
250 if version[:5] != 'HTTP/':
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]251 self.send_error(400, "Bad request version (%r)" % version)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]252 return False
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]253 try:
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]254 base_version_number = version.split('/', 1)[1]
255 version_number = base_version_number.split(".")
256 # RFC 2145 section 3.1 says there can be only one "." and
257 # - major and minor numbers MUST be treated as
258 # separate integers;
259 # - HTTP/2.4 is a lower version than HTTP/2.13, which in
260 # turn is lower than HTTP/12.3;
261 # - Leading zeros MUST be ignored by recipients.
262 if len(version_number) != 2:
263 raise ValueError
264 version_number = int(version_number[0]), int(version_number[1])
265 except (ValueError, IndexError):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]266 self.send_error(400, "Bad request version (%r)" % version)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]267 return False
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]268 if version_number >= (1, 1) and self.protocol_version >= "HTTP/1.1":
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]269 self.close_connection = 0
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]270 if version_number >= (2, 0):
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]271 self.send_error(505,
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]272 "Invalid HTTP Version (%s)" % base_version_number)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]273 return False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]274 elif len(words) == 2:
275 [command, path] = words
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]276 self.close_connection = 1
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]277 if command != 'GET':
278 self.send_error(400,
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]279 "Bad HTTP/0.9 request type (%r)" % command)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]280 return False
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]281 elif not words:
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]282 return False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]283 else:
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]284 self.send_error(400, "Bad request syntax (%r)" % requestline)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]285 return False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]286 self.command, self.path, self.request_version = command, path, version
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]287
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]288 # Examine the headers and look for a Connection directive
Raymond Hettingercffb9de2003-08-09 05:01:41 +0000[diff] [blame]289 self.headers = self.MessageClass(self.rfile, 0)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]290
291 conntype = self.headers.get('Connection', "")
292 if conntype.lower() == 'close':
293 self.close_connection = 1
294 elif (conntype.lower() == 'keep-alive' and
295 self.protocol_version >= "HTTP/1.1"):
296 self.close_connection = 0
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]297 return True
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]298
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]299 def handle_one_request(self):
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]300 """Handle a single HTTP request.
301
302 You normally don't need to override this method; see the class
303 __doc__ string for information on how to handle specific HTTP
304 commands such as GET and POST.
305
306 """
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]307 self.raw_requestline = self.rfile.readline()
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]308 if not self.raw_requestline:
309 self.close_connection = 1
310 return
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]311 if not self.parse_request(): # An error code has been sent, just exit
312 return
313 mname = 'do_' + self.command
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]314 if not hasattr(self, mname):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]315 self.send_error(501, "Unsupported method (%r)" % self.command)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]316 return
317 method = getattr(self, mname)
318 method()
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]319
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]320 def handle(self):
321 """Handle multiple requests if necessary."""
322 self.close_connection = 1
323
324 self.handle_one_request()
325 while not self.close_connection:
326 self.handle_one_request()
327
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]328 def send_error(self, code, message=None):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]329 """Send and log an error reply.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]330
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]331 Arguments are the error code, and a detailed message.
332 The detailed message defaults to the short entry matching the
333 response code.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]334
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]335 This sends an error response (so it must be called before any
336 output has been generated), logs the error, and finally sends
337 a piece of HTML explaining the error to the user.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]338
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]339 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]340
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]341 try:
342 short, long = self.responses[code]
343 except KeyError:
344 short, long = '???', '???'
Raymond Hettingerc0418602002-05-31 23:03:33 +0000[diff] [blame]345 if message is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]346 message = short
347 explain = long
348 self.log_error("code %d, message %s", code, message)
Georg Brandla2aa1ac2005-06-26 21:33:14 +0000[diff] [blame]349 # using _quote_html to prevent Cross Site Scripting attacks (see bug #1100201)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]350 content = (self.error_message_format %
Georg Brandla2aa1ac2005-06-26 21:33:14 +0000[diff] [blame]351 {'code': code, 'message': _quote_html(message), 'explain': explain})
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]352 self.send_response(code, message)
Georg Brandl16479232008-02-23 15:02:28 +0000[diff] [blame]353 self.send_header("Content-Type", self.error_content_type)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]354 self.send_header('Connection', 'close')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]355 self.end_headers()
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]356 if self.command != 'HEAD' and code >= 200 and code not in (204, 304):
357 self.wfile.write(content)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]358
359 error_message_format = DEFAULT_ERROR_MESSAGE
Georg Brandl16479232008-02-23 15:02:28 +0000[diff] [blame]360 error_content_type = DEFAULT_ERROR_CONTENT_TYPE
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]361
362 def send_response(self, code, message=None):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]363 """Send the response header and log the response code.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]364
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]365 Also send two standard headers with the server software
366 version and the current date.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]367
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]368 """
369 self.log_request(code)
370 if message is None:
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]371 if code in self.responses:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]372 message = self.responses[code][0]
373 else:
374 message = ''
375 if self.request_version != 'HTTP/0.9':
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]376 self.wfile.write("%s %d %s\r\n" %
377 (self.protocol_version, code, message))
378 # print (self.protocol_version, code, message)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]379 self.send_header('Server', self.version_string())
380 self.send_header('Date', self.date_time_string())
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]381
382 def send_header(self, keyword, value):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]383 """Send a MIME header."""
384 if self.request_version != 'HTTP/0.9':
385 self.wfile.write("%s: %s\r\n" % (keyword, value))
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]386
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]387 if keyword.lower() == 'connection':
388 if value.lower() == 'close':
389 self.close_connection = 1
390 elif value.lower() == 'keep-alive':
391 self.close_connection = 0
392
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]393 def end_headers(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]394 """Send the blank line ending the MIME headers."""
395 if self.request_version != 'HTTP/0.9':
396 self.wfile.write("\r\n")
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]397
398 def log_request(self, code='-', size='-'):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]399 """Log an accepted request.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]400
Andrew M. Kuchlingec73cd42006-03-07 16:16:07 +0000[diff] [blame]401 This is called by send_response().
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]402
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]403 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]404
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]405 self.log_message('"%s" %s %s',
406 self.requestline, str(code), str(size))
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]407
Guido van Rossum833e9612007-01-10 23:12:56 +0000[diff] [blame]408 def log_error(self, format, *args):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]409 """Log an error.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]410
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]411 This is called when a request cannot be fulfilled. By
412 default it passes the message on to log_message().
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]413
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]414 Arguments are the same as for log_message().
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]415
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]416 XXX This should go to the separate error log.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]417
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]418 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]419
Guido van Rossum833e9612007-01-10 23:12:56 +0000[diff] [blame]420 self.log_message(format, *args)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]421
422 def log_message(self, format, *args):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]423 """Log an arbitrary message.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]424
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]425 This is used by all other logging functions. Override
426 it if you have specific logging wishes.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]427
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]428 The first argument, FORMAT, is a format string for the
429 message to be logged. If the format string contains
430 any % escapes requiring parameters, they should be
431 specified as subsequent arguments (it's just like
432 printf!).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]433
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]434 The client host and current date/time are prefixed to
435 every message.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]436
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]437 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]438
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]439 sys.stderr.write("%s - - [%s] %s\n" %
440 (self.address_string(),
441 self.log_date_time_string(),
442 format%args))
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]443
444 def version_string(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]445 """Return the server software version string."""
446 return self.server_version + ' ' + self.sys_version
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]447
Georg Brandl5d076962006-02-17 13:34:16 +0000[diff] [blame]448 def date_time_string(self, timestamp=None):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]449 """Return the current date and time formatted for a message header."""
Georg Brandl5d076962006-02-17 13:34:16 +0000[diff] [blame]450 if timestamp is None:
451 timestamp = time.time()
452 year, month, day, hh, mm, ss, wd, y, z = time.gmtime(timestamp)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]453 s = "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (
454 self.weekdayname[wd],
455 day, self.monthname[month], year,
456 hh, mm, ss)
457 return s
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]458
459 def log_date_time_string(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]460 """Return the current time formatted for logging."""
461 now = time.time()
462 year, month, day, hh, mm, ss, x, y, z = time.localtime(now)
463 s = "%02d/%3s/%04d %02d:%02d:%02d" % (
464 day, self.monthname[month], year, hh, mm, ss)
465 return s
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]466
467 weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
468
469 monthname = [None,
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]470 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
471 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]472
473 def address_string(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]474 """Return the client address formatted for logging.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]475
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]476 This version looks up the full hostname using gethostbyaddr(),
477 and tries to find a name that contains at least one dot.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]478
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]479 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]480
Martin v. Löwis3c120de2003-05-31 07:55:43 +0000[diff] [blame]481 host, port = self.client_address[:2]
Peter Schneider-Kamp2d2785a2000-08-16 20:30:21 +0000[diff] [blame]482 return socket.getfqdn(host)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]483
484 # Essentially static class variables
485
486 # The version of the HTTP protocol we support.
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]487 # Set this to HTTP/1.1 to enable automatic keepalive
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]488 protocol_version = "HTTP/1.0"
489
490 # The Message-like class used to parse headers
491 MessageClass = mimetools.Message
492
493 # Table mapping response codes to messages; entries have the
494 # form {code: (shortmessage, longmessage)}.
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]495 # See RFC 2616.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]496 responses = {
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]497 100: ('Continue', 'Request received, please continue'),
498 101: ('Switching Protocols',
499 'Switching to new protocol; obey Upgrade header'),
500
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]501 200: ('OK', 'Request fulfilled, document follows'),
502 201: ('Created', 'Document created, URL follows'),
503 202: ('Accepted',
504 'Request accepted, processing continues off-line'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]505 203: ('Non-Authoritative Information', 'Request fulfilled from cache'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]506 204: ('No Content', 'Request fulfilled, nothing follows'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]507 205: ('Reset Content', 'Clear input form for further input.'),
508 206: ('Partial Content', 'Partial content follows.'),
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]509
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]510 300: ('Multiple Choices',
511 'Object has several resources -- see URI list'),
512 301: ('Moved Permanently', 'Object moved permanently -- see URI list'),
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]513 302: ('Found', 'Object moved temporarily -- see URI list'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]514 303: ('See Other', 'Object moved -- see Method and URL list'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]515 304: ('Not Modified',
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]516 'Document has not changed since given time'),
517 305: ('Use Proxy',
518 'You must use proxy specified in Location to access this '
519 'resource.'),
520 307: ('Temporary Redirect',
521 'Object moved temporarily -- see URI list'),
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]522
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]523 400: ('Bad Request',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]524 'Bad request syntax or unsupported method'),
525 401: ('Unauthorized',
526 'No permission -- see authorization schemes'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]527 402: ('Payment Required',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]528 'No payment -- see charging schemes'),
529 403: ('Forbidden',
530 'Request forbidden -- authorization will not help'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]531 404: ('Not Found', 'Nothing matches the given URI'),
532 405: ('Method Not Allowed',
533 'Specified method is invalid for this server.'),
534 406: ('Not Acceptable', 'URI not available in preferred format.'),
535 407: ('Proxy Authentication Required', 'You must authenticate with '
536 'this proxy before proceeding.'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]537 408: ('Request Timeout', 'Request timed out; try again later.'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]538 409: ('Conflict', 'Request conflict.'),
539 410: ('Gone',
540 'URI no longer exists and has been permanently removed.'),
541 411: ('Length Required', 'Client must specify Content-Length.'),
542 412: ('Precondition Failed', 'Precondition in headers is false.'),
543 413: ('Request Entity Too Large', 'Entity is too large.'),
544 414: ('Request-URI Too Long', 'URI is too long.'),
545 415: ('Unsupported Media Type', 'Entity body in unsupported format.'),
546 416: ('Requested Range Not Satisfiable',
547 'Cannot satisfy request range.'),
548 417: ('Expectation Failed',
549 'Expect condition could not be satisfied.'),
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]550
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]551 500: ('Internal Server Error', 'Server got itself in trouble'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]552 501: ('Not Implemented',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]553 'Server does not support this operation'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]554 502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]555 503: ('Service Unavailable',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]556 'The server cannot process the request due to a high load'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]557 504: ('Gateway Timeout',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]558 'The gateway server did not receive a timely response'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]559 505: ('HTTP Version Not Supported', 'Cannot fulfill request.'),
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]560 }
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]561
562
563def test(HandlerClass = BaseHTTPRequestHandler,
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]564 ServerClass = HTTPServer, protocol="HTTP/1.0"):
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]565 """Test the HTTP request handler class.
566
567 This runs an HTTP server on port 8000 (or the first command line
568 argument).
569
570 """
571
572 if sys.argv[1:]:
Eric S. Raymond5ff63d62001-02-09 05:38:46 +0000[diff] [blame]573 port = int(sys.argv[1])
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]574 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]575 port = 8000
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]576 server_address = ('', port)
577
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]578 HandlerClass.protocol_version = protocol
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]579 httpd = ServerClass(server_address, HandlerClass)
580
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000[diff] [blame]581 sa = httpd.socket.getsockname()
582 print "Serving HTTP on", sa[0], "port", sa[1], "..."
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]583 httpd.serve_forever()
584
585
586if __name__ == '__main__':
587 test()