Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython2 / 1647923bbf2a0257eefe5f4bbc44bd11e0d63659 / . / Lib / BaseHTTPServer.py
blob: 97d800cb390b5ab914f2e13274833e4b80403214 [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
77import SocketServer
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
97class HTTPServer(SocketServer.TCPServer):
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."""
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
109class BaseHTTPRequestHandler(SocketServer.StreamRequestHandler):
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
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]221 def parse_request(self):
222 """Parse a request (internal).
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]223
Raymond Hettingerbf68c782003-06-02 14:25:43 +0000[diff] [blame]224 The request should be stored in self.raw_requestline; the results
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]225 are in self.command, self.path, self.request_version and
226 self.headers.
227
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]228 Return True for success, False for failure; on failure, an
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]229 error is sent back.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]230
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]231 """
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]232 self.command = None # set in case of error on the first line
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]233 self.request_version = version = "HTTP/0.9" # Default
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]234 self.close_connection = 1
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]235 requestline = self.raw_requestline
236 if requestline[-2:] == '\r\n':
237 requestline = requestline[:-2]
238 elif requestline[-1:] == '\n':
239 requestline = requestline[:-1]
240 self.requestline = requestline
Eric S. Raymondb49f4a42001-02-09 05:07:04 +0000[diff] [blame]241 words = requestline.split()
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]242 if len(words) == 3:
243 [command, path, version] = words
244 if version[:5] != 'HTTP/':
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]245 self.send_error(400, "Bad request version (%r)" % version)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]246 return False
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]247 try:
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]248 base_version_number = version.split('/', 1)[1]
249 version_number = base_version_number.split(".")
250 # RFC 2145 section 3.1 says there can be only one "." and
251 # - major and minor numbers MUST be treated as
252 # separate integers;
253 # - HTTP/2.4 is a lower version than HTTP/2.13, which in
254 # turn is lower than HTTP/12.3;
255 # - Leading zeros MUST be ignored by recipients.
256 if len(version_number) != 2:
257 raise ValueError
258 version_number = int(version_number[0]), int(version_number[1])
259 except (ValueError, IndexError):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]260 self.send_error(400, "Bad request version (%r)" % version)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]261 return False
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]262 if version_number >= (1, 1) and self.protocol_version >= "HTTP/1.1":
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]263 self.close_connection = 0
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]264 if version_number >= (2, 0):
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]265 self.send_error(505,
Andrew M. Kuchling2de97d32003-02-03 19:11:18 +0000[diff] [blame]266 "Invalid HTTP Version (%s)" % base_version_number)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]267 return False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]268 elif len(words) == 2:
269 [command, path] = words
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]270 self.close_connection = 1
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]271 if command != 'GET':
272 self.send_error(400,
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]273 "Bad HTTP/0.9 request type (%r)" % command)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]274 return False
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]275 elif not words:
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]276 return False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]277 else:
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]278 self.send_error(400, "Bad request syntax (%r)" % requestline)
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]279 return False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]280 self.command, self.path, self.request_version = command, path, version
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]281
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]282 # Examine the headers and look for a Connection directive
Raymond Hettingercffb9de2003-08-09 05:01:41 +0000[diff] [blame]283 self.headers = self.MessageClass(self.rfile, 0)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]284
285 conntype = self.headers.get('Connection', "")
286 if conntype.lower() == 'close':
287 self.close_connection = 1
288 elif (conntype.lower() == 'keep-alive' and
289 self.protocol_version >= "HTTP/1.1"):
290 self.close_connection = 0
Tim Petersbc0e9102002-04-04 22:55:58 +0000[diff] [blame]291 return True
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]292
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]293 def handle_one_request(self):
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]294 """Handle a single HTTP request.
295
296 You normally don't need to override this method; see the class
297 __doc__ string for information on how to handle specific HTTP
298 commands such as GET and POST.
299
300 """
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]301 self.raw_requestline = self.rfile.readline()
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]302 if not self.raw_requestline:
303 self.close_connection = 1
304 return
Guido van Rossumd65b5391999-10-26 13:01:36 +0000[diff] [blame]305 if not self.parse_request(): # An error code has been sent, just exit
306 return
307 mname = 'do_' + self.command
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]308 if not hasattr(self, mname):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000[diff] [blame]309 self.send_error(501, "Unsupported method (%r)" % self.command)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]310 return
311 method = getattr(self, mname)
312 method()
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]313
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]314 def handle(self):
315 """Handle multiple requests if necessary."""
316 self.close_connection = 1
317
318 self.handle_one_request()
319 while not self.close_connection:
320 self.handle_one_request()
321
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]322 def send_error(self, code, message=None):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]323 """Send and log an error reply.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]324
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]325 Arguments are the error code, and a detailed message.
326 The detailed message defaults to the short entry matching the
327 response code.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]328
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]329 This sends an error response (so it must be called before any
330 output has been generated), logs the error, and finally sends
331 a piece of HTML explaining the error to the user.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]332
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]333 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]334
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]335 try:
336 short, long = self.responses[code]
337 except KeyError:
338 short, long = '???', '???'
Raymond Hettingerc0418602002-05-31 23:03:33 +0000[diff] [blame]339 if message is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]340 message = short
341 explain = long
342 self.log_error("code %d, message %s", code, message)
Georg Brandla2aa1ac2005-06-26 21:33:14 +0000[diff] [blame]343 # using _quote_html to prevent Cross Site Scripting attacks (see bug #1100201)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]344 content = (self.error_message_format %
Georg Brandla2aa1ac2005-06-26 21:33:14 +0000[diff] [blame]345 {'code': code, 'message': _quote_html(message), 'explain': explain})
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]346 self.send_response(code, message)
Georg Brandl16479232008-02-23 15:02:28 +0000[diff] [blame^]347 self.send_header("Content-Type", self.error_content_type)
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]348 self.send_header('Connection', 'close')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]349 self.end_headers()
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]350 if self.command != 'HEAD' and code >= 200 and code not in (204, 304):
351 self.wfile.write(content)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]352
353 error_message_format = DEFAULT_ERROR_MESSAGE
Georg Brandl16479232008-02-23 15:02:28 +0000[diff] [blame^]354 error_content_type = DEFAULT_ERROR_CONTENT_TYPE
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]355
356 def send_response(self, code, message=None):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]357 """Send the response header and log the response code.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]358
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]359 Also send two standard headers with the server software
360 version and the current date.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]361
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]362 """
363 self.log_request(code)
364 if message is None:
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]365 if code in self.responses:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]366 message = self.responses[code][0]
367 else:
368 message = ''
369 if self.request_version != 'HTTP/0.9':
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]370 self.wfile.write("%s %d %s\r\n" %
371 (self.protocol_version, code, message))
372 # print (self.protocol_version, code, message)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]373 self.send_header('Server', self.version_string())
374 self.send_header('Date', self.date_time_string())
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]375
376 def send_header(self, keyword, value):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]377 """Send a MIME header."""
378 if self.request_version != 'HTTP/0.9':
379 self.wfile.write("%s: %s\r\n" % (keyword, value))
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]380
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]381 if keyword.lower() == 'connection':
382 if value.lower() == 'close':
383 self.close_connection = 1
384 elif value.lower() == 'keep-alive':
385 self.close_connection = 0
386
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]387 def end_headers(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]388 """Send the blank line ending the MIME headers."""
389 if self.request_version != 'HTTP/0.9':
390 self.wfile.write("\r\n")
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]391
392 def log_request(self, code='-', size='-'):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]393 """Log an accepted request.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]394
Andrew M. Kuchlingec73cd42006-03-07 16:16:07 +0000[diff] [blame]395 This is called by send_response().
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]396
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]397 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]398
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]399 self.log_message('"%s" %s %s',
400 self.requestline, str(code), str(size))
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]401
Guido van Rossum833e9612007-01-10 23:12:56 +0000[diff] [blame]402 def log_error(self, format, *args):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]403 """Log an error.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]404
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]405 This is called when a request cannot be fulfilled. By
406 default it passes the message on to log_message().
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]407
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]408 Arguments are the same as for log_message().
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]409
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]410 XXX This should go to the separate error log.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]411
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]412 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]413
Guido van Rossum833e9612007-01-10 23:12:56 +0000[diff] [blame]414 self.log_message(format, *args)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]415
416 def log_message(self, format, *args):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]417 """Log an arbitrary message.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]418
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]419 This is used by all other logging functions. Override
420 it if you have specific logging wishes.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]421
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]422 The first argument, FORMAT, is a format string for the
423 message to be logged. If the format string contains
424 any % escapes requiring parameters, they should be
425 specified as subsequent arguments (it's just like
426 printf!).
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 client host and current date/time are prefixed to
429 every message.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]430
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]431 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]432
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]433 sys.stderr.write("%s - - [%s] %s\n" %
434 (self.address_string(),
435 self.log_date_time_string(),
436 format%args))
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]437
438 def version_string(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]439 """Return the server software version string."""
440 return self.server_version + ' ' + self.sys_version
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]441
Georg Brandl5d076962006-02-17 13:34:16 +0000[diff] [blame]442 def date_time_string(self, timestamp=None):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]443 """Return the current date and time formatted for a message header."""
Georg Brandl5d076962006-02-17 13:34:16 +0000[diff] [blame]444 if timestamp is None:
445 timestamp = time.time()
446 year, month, day, hh, mm, ss, wd, y, z = time.gmtime(timestamp)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]447 s = "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (
448 self.weekdayname[wd],
449 day, self.monthname[month], year,
450 hh, mm, ss)
451 return s
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]452
453 def log_date_time_string(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]454 """Return the current time formatted for logging."""
455 now = time.time()
456 year, month, day, hh, mm, ss, x, y, z = time.localtime(now)
457 s = "%02d/%3s/%04d %02d:%02d:%02d" % (
458 day, self.monthname[month], year, hh, mm, ss)
459 return s
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]460
461 weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
462
463 monthname = [None,
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]464 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
465 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]466
467 def address_string(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]468 """Return the client address formatted for logging.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]469
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]470 This version looks up the full hostname using gethostbyaddr(),
471 and tries to find a name that contains at least one dot.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]472
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]473 """
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]474
Martin v. Löwis3c120de2003-05-31 07:55:43 +0000[diff] [blame]475 host, port = self.client_address[:2]
Peter Schneider-Kamp2d2785a2000-08-16 20:30:21 +0000[diff] [blame]476 return socket.getfqdn(host)
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]477
478 # Essentially static class variables
479
480 # The version of the HTTP protocol we support.
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]481 # Set this to HTTP/1.1 to enable automatic keepalive
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]482 protocol_version = "HTTP/1.0"
483
484 # The Message-like class used to parse headers
485 MessageClass = mimetools.Message
486
487 # Table mapping response codes to messages; entries have the
488 # form {code: (shortmessage, longmessage)}.
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]489 # See RFC 2616.
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]490 responses = {
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]491 100: ('Continue', 'Request received, please continue'),
492 101: ('Switching Protocols',
493 'Switching to new protocol; obey Upgrade header'),
494
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]495 200: ('OK', 'Request fulfilled, document follows'),
496 201: ('Created', 'Document created, URL follows'),
497 202: ('Accepted',
498 'Request accepted, processing continues off-line'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]499 203: ('Non-Authoritative Information', 'Request fulfilled from cache'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]500 204: ('No Content', 'Request fulfilled, nothing follows'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]501 205: ('Reset Content', 'Clear input form for further input.'),
502 206: ('Partial Content', 'Partial content follows.'),
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]503
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]504 300: ('Multiple Choices',
505 'Object has several resources -- see URI list'),
506 301: ('Moved Permanently', 'Object moved permanently -- see URI list'),
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]507 302: ('Found', 'Object moved temporarily -- see URI list'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]508 303: ('See Other', 'Object moved -- see Method and URL list'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]509 304: ('Not Modified',
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]510 'Document has not changed since given time'),
511 305: ('Use Proxy',
512 'You must use proxy specified in Location to access this '
513 'resource.'),
514 307: ('Temporary Redirect',
515 'Object moved temporarily -- see URI list'),
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]516
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]517 400: ('Bad Request',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]518 'Bad request syntax or unsupported method'),
519 401: ('Unauthorized',
520 'No permission -- see authorization schemes'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]521 402: ('Payment Required',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]522 'No payment -- see charging schemes'),
523 403: ('Forbidden',
524 'Request forbidden -- authorization will not help'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]525 404: ('Not Found', 'Nothing matches the given URI'),
526 405: ('Method Not Allowed',
527 'Specified method is invalid for this server.'),
528 406: ('Not Acceptable', 'URI not available in preferred format.'),
529 407: ('Proxy Authentication Required', 'You must authenticate with '
530 'this proxy before proceeding.'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]531 408: ('Request Timeout', 'Request timed out; try again later.'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]532 409: ('Conflict', 'Request conflict.'),
533 410: ('Gone',
534 'URI no longer exists and has been permanently removed.'),
535 411: ('Length Required', 'Client must specify Content-Length.'),
536 412: ('Precondition Failed', 'Precondition in headers is false.'),
537 413: ('Request Entity Too Large', 'Entity is too large.'),
538 414: ('Request-URI Too Long', 'URI is too long.'),
539 415: ('Unsupported Media Type', 'Entity body in unsupported format.'),
540 416: ('Requested Range Not Satisfiable',
541 'Cannot satisfy request range.'),
542 417: ('Expectation Failed',
543 'Expect condition could not be satisfied.'),
Tim Peters11cf6052001-01-14 21:54:20 +0000[diff] [blame]544
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]545 500: ('Internal Server Error', 'Server got itself in trouble'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]546 501: ('Not Implemented',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]547 'Server does not support this operation'),
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]548 502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]549 503: ('Service Unavailable',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]550 'The server cannot process the request due to a high load'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]551 504: ('Gateway Timeout',
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]552 'The gateway server did not receive a timely response'),
Georg Brandl6aab16e2006-02-17 19:17:25 +0000[diff] [blame]553 505: ('HTTP Version Not Supported', 'Cannot fulfill request.'),
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]554 }
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]555
556
557def test(HandlerClass = BaseHTTPRequestHandler,
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]558 ServerClass = HTTPServer, protocol="HTTP/1.0"):
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]559 """Test the HTTP request handler class.
560
561 This runs an HTTP server on port 8000 (or the first command line
562 argument).
563
564 """
565
566 if sys.argv[1:]:
Eric S. Raymond5ff63d62001-02-09 05:38:46 +0000[diff] [blame]567 port = int(sys.argv[1])
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]568 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000[diff] [blame]569 port = 8000
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]570 server_address = ('', port)
571
Martin v. Löwis587c98c2002-03-17 18:37:22 +0000[diff] [blame]572 HandlerClass.protocol_version = protocol
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]573 httpd = ServerClass(server_address, HandlerClass)
574
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000[diff] [blame]575 sa = httpd.socket.getsockname()
576 print "Serving HTTP on", sa[0], "port", sa[1], "..."
Guido van Rossume7e578f1995-08-04 04:00:20 +0000[diff] [blame]577 httpd.serve_forever()
578
579
580if __name__ == '__main__':
581 test()