CGIHTTPServer (version 0.4)
index
/usr/local/lib/python2.4/CGIHTTPServer.py
Module Docs

CGI-savvy HTTP Server.
 
This module builds on SimpleHTTPServer by implementing GET and POST
requests to cgi-bin scripts.
 
If the os.fork() function is not present (e.g. on Windows),
os.popen2() is used as a fallback, with slightly altered semantics; if
that function is not present either (e.g. on Macintosh), only Python
scripts are supported, and they are executed by the current process.
 
In all cases, the implementation is intentionally naive -- all
requests are executed sychronously.
 
SECURITY WARNING: DON'T USE THIS CODE UNLESS YOU ARE INSIDE A FIREWALL
-- it may execute arbitrary Python code or external programs.

 
Modules
       
BaseHTTPServer
SimpleHTTPServer
os
select
sys
urllib

 
Classes
       
SimpleHTTPServer.SimpleHTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler)
CGIHTTPRequestHandler

 
class CGIHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler)
    Complete HTTP server with GET, HEAD and POST commands.
 
GET and HEAD also support running CGI scripts.
 
The POST command is *only* implemented for CGI scripts.
 
 
Method resolution order:
CGIHTTPRequestHandler
SimpleHTTPServer.SimpleHTTPRequestHandler
BaseHTTPServer.BaseHTTPRequestHandler
SocketServer.StreamRequestHandler
SocketServer.BaseRequestHandler

Methods defined here:
do_POST(self)
Serve a POST request.
 
This is only implemented for CGI scripts.
is_cgi(self)
Test whether self.path corresponds to a CGI script.
 
Return a tuple (dir, rest) if self.path requires running a
CGI script, None if not.  Note that rest begins with a
slash if it is not empty.
 
The default implementation tests whether the path
begins with one of the strings in the list
self.cgi_directories (and the next character is a '/'
or the end of the string).
is_executable(self, path)
Test whether argument path is an executable file.
is_python(self, path)
Test whether argument path is a Python script.
run_cgi(self)
Execute a CGI script.
send_head(self)
Version of send_head that support CGI scripts

Data and other attributes defined here:
cgi_directories = ['/cgi-bin', '/htbin']
have_fork = True
have_popen2 = True
have_popen3 = True
rbufsize = 0

Methods inherited from SimpleHTTPServer.SimpleHTTPRequestHandler:
copyfile(self, source, outputfile)
Copy all data between two file objects.
 
The SOURCE argument is a file object open for reading
(or anything with a read() method) and the DESTINATION
argument is a file object open for writing (or
anything with a write() method).
 
The only reason for overriding this would be to change
the block size or perhaps to replace newlines by CRLF
-- note however that this the default server uses this
to copy binary data as well.
do_GET(self)
Serve a GET request.
do_HEAD(self)
Serve a HEAD request.
guess_type(self, path)
Guess the type of a file.
 
Argument is a PATH (a filename).
 
Return value is a string of the form type/subtype,
usable for a MIME Content-type header.
 
The default implementation looks the file's extension
up in the table self.extensions_map, using application/octet-stream
as a default; however it would be permissible (if
slow) to look inside the data to make a better guess.
list_directory(self, path)
Helper to produce a directory listing (absent index.html).
 
Return value is either a file object, or None (indicating an
error).  In either case, the headers are sent, making the
interface the same as for send_head().
translate_path(self, path)
Translate a /-separated PATH to the local filename syntax.
 
Components that mean special things to the local file system
(e.g. drive or directory names) are ignored.  (XXX They should
probably be diagnosed.)

Data and other attributes inherited from SimpleHTTPServer.SimpleHTTPRequestHandler:
extensions_map = {'': 'application/octet-stream', '.a': 'application/octet-stream', '.ai': 'application/postscript', '.aif': 'audio/x-aiff', '.aifc': 'audio/x-aiff', '.aiff': 'audio/x-aiff', '.au': 'audio/basic', '.avi': 'video/x-msvideo', '.bat': 'text/plain', '.bcpio': 'application/x-bcpio', ...}
server_version = 'SimpleHTTP/0.6'

Methods inherited from BaseHTTPServer.BaseHTTPRequestHandler:
address_string(self)
Return the client address formatted for logging.
 
This version looks up the full hostname using gethostbyaddr(),
and tries to find a name that contains at least one dot.
date_time_string(self)
Return the current date and time formatted for a message header.
end_headers(self)
Send the blank line ending the MIME headers.
handle(self)
Handle multiple requests if necessary.
handle_one_request(self)
Handle a single HTTP request.
 
You normally don't need to override this method; see the class
__doc__ string for information on how to handle specific HTTP
commands such as GET and POST.
log_date_time_string(self)
Return the current time formatted for logging.
log_error(self, *args)
Log an error.
 
This is called when a request cannot be fulfilled.  By
default it passes the message on to log_message().
 
Arguments are the same as for log_message().
 
XXX This should go to the separate error log.
log_message(self, format, *args)
Log an arbitrary message.
 
This is used by all other logging functions.  Override
it if you have specific logging wishes.
 
The first argument, FORMAT, is a format string for the
message to be logged.  If the format string contains
any % escapes requiring parameters, they should be
specified as subsequent arguments (it's just like
printf!).
 
The client host and current date/time are prefixed to
every message.
log_request(self, code='-', size='-')
Log an accepted request.
 
This is called by send_reponse().
parse_request(self)
Parse a request (internal).
 
The request should be stored in self.raw_requestline; the results
are in self.command, self.path, self.request_version and
self.headers.
 
Return True for success, False for failure; on failure, an
error is sent back.
send_error(self, code, message=None)
Send and log an error reply.
 
Arguments are the error code, and a detailed message.
The detailed message defaults to the short entry matching the
response code.
 
This sends an error response (so it must be called before any
output has been generated), logs the error, and finally sends
a piece of HTML explaining the error to the user.
send_header(self, keyword, value)
Send a MIME header.
send_response(self, code, message=None)
Send the response header and log the response code.
 
Also send two standard headers with the server software
version and the current date.
version_string(self)
Return the server software version string.

Data and other attributes inherited from BaseHTTPServer.BaseHTTPRequestHandler:
MessageClass = <class mimetools.Message>
A derived class of rfc822.Message that knows about MIME headers and
contains some hooks for decoding encoded and multipart messages.
error_message_format = '<head>\n<title>Error response</title>\n</head>\n<bo...ode explanation: %(code)s = %(explain)s.\n</body>\n'
monthname = [None, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
protocol_version = 'HTTP/1.0'
responses = {100: ('Continue', 'Request received, please continue'), 101: ('Switching Protocols', 'Switching to new protocol; obey Upgrade header'), 200: ('OK', 'Request fulfilled, document follows'), 201: ('Created', 'Document created, URL follows'), 202: ('Accepted', 'Request accepted, processing continues off-line'), 203: ('Non-Authoritative Information', 'Request fulfilled from cache'), 204: ('No response', 'Request fulfilled, nothing follows'), 205: ('Reset Content', 'Clear input form for further input.'), 206: ('Partial Content', 'Partial content follows.'), 300: ('Multiple Choices', 'Object has several resources -- see URI list'), ...}
sys_version = 'Python/2.4'
weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']

Methods inherited from SocketServer.StreamRequestHandler:
finish(self)
setup(self)

Data and other attributes inherited from SocketServer.StreamRequestHandler:
wbufsize = 0

Methods inherited from SocketServer.BaseRequestHandler:
__init__(self, request, client_address, server)

 
Data
        __all__ = ['CGIHTTPRequestHandler']
__version__ = '0.4'