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