home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2006 January / Gamestar_80_2006-01_dvd.iso / Dema / Civilization4 / data1.cab / Civ4DemoComponent / Assets / Python / System / BaseHTTPServer.pyc (.txt) < prev    next >
Encoding:
Python Compiled Bytecode  |  2005-11-09  |  20.1 KB  |  495 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.4)
  3.  
  4. """HTTP server base class.
  5.  
  6. Note: the class in this module doesn't implement any HTTP request; see
  7. SimpleHTTPServer for simple implementations of GET, HEAD and POST
  8. (including CGI scripts).  It does, however, optionally implement HTTP/1.1
  9. persistent connections, as of version 0.3.
  10.  
  11. Contents:
  12.  
  13. - BaseHTTPRequestHandler: HTTP request handler base class
  14. - test: test function
  15.  
  16. XXX To do:
  17.  
  18. - log requests even later (to capture byte count)
  19. - log user-agent header and other interesting goodies
  20. - send error log to separate file
  21. """
  22. __version__ = '0.3'
  23. __all__ = [
  24.     'HTTPServer',
  25.     'BaseHTTPRequestHandler']
  26. import sys
  27. import time
  28. import socket
  29. import mimetools
  30. import SocketServer
  31. DEFAULT_ERROR_MESSAGE = '<head>\n<title>Error response</title>\n</head>\n<body>\n<h1>Error response</h1>\n<p>Error code %(code)d.\n<p>Message: %(message)s.\n<p>Error code explanation: %(code)s = %(explain)s.\n</body>\n'
  32.  
  33. class HTTPServer(SocketServer.TCPServer):
  34.     allow_reuse_address = 1
  35.     
  36.     def server_bind(self):
  37.         '''Override server_bind to store the server name.'''
  38.         SocketServer.TCPServer.server_bind(self)
  39.         (host, port) = self.socket.getsockname()[:2]
  40.         self.server_name = socket.getfqdn(host)
  41.         self.server_port = port
  42.  
  43.  
  44.  
  45. class BaseHTTPRequestHandler(SocketServer.StreamRequestHandler):
  46.     '''HTTP request handler base class.
  47.  
  48.     The following explanation of HTTP serves to guide you through the
  49.     code as well as to expose any misunderstandings I may have about
  50.     HTTP (so you don\'t need to read the code to figure out I\'m wrong
  51.     :-).
  52.  
  53.     HTTP (HyperText Transfer Protocol) is an extensible protocol on
  54.     top of a reliable stream transport (e.g. TCP/IP).  The protocol
  55.     recognizes three parts to a request:
  56.  
  57.     1. One line identifying the request type and path
  58.     2. An optional set of RFC-822-style headers
  59.     3. An optional data part
  60.  
  61.     The headers and data are separated by a blank line.
  62.  
  63.     The first line of the request has the form
  64.  
  65.     <command> <path> <version>
  66.  
  67.     where <command> is a (case-sensitive) keyword such as GET or POST,
  68.     <path> is a string containing path information for the request,
  69.     and <version> should be the string "HTTP/1.0" or "HTTP/1.1".
  70.     <path> is encoded using the URL encoding scheme (using %xx to signify
  71.     the ASCII character with hex code xx).
  72.  
  73.     The specification specifies that lines are separated by CRLF but
  74.     for compatibility with the widest range of clients recommends
  75.     servers also handle LF.  Similarly, whitespace in the request line
  76.     is treated sensibly (allowing multiple spaces between components
  77.     and allowing trailing whitespace).
  78.  
  79.     Similarly, for output, lines ought to be separated by CRLF pairs
  80.     but most clients grok LF characters just fine.
  81.  
  82.     If the first line of the request has the form
  83.  
  84.     <command> <path>
  85.  
  86.     (i.e. <version> is left out) then this is assumed to be an HTTP
  87.     0.9 request; this form has no optional headers and data part and
  88.     the reply consists of just the data.
  89.  
  90.     The reply form of the HTTP 1.x protocol again has three parts:
  91.  
  92.     1. One line giving the response code
  93.     2. An optional set of RFC-822-style headers
  94.     3. The data
  95.  
  96.     Again, the headers and data are separated by a blank line.
  97.  
  98.     The response code line has the form
  99.  
  100.     <version> <responsecode> <responsestring>
  101.  
  102.     where <version> is the protocol version ("HTTP/1.0" or "HTTP/1.1"),
  103.     <responsecode> is a 3-digit response code indicating success or
  104.     failure of the request, and <responsestring> is an optional
  105.     human-readable string explaining what the response code means.
  106.  
  107.     This server parses the request and the headers, and then calls a
  108.     function specific to the request type (<command>).  Specifically,
  109.     a request SPAM will be handled by a method do_SPAM().  If no
  110.     such method exists the server sends an error response to the
  111.     client.  If it exists, it is called with no arguments:
  112.  
  113.     do_SPAM()
  114.  
  115.     Note that the request name is case sensitive (i.e. SPAM and spam
  116.     are different requests).
  117.  
  118.     The various request details are stored in instance variables:
  119.  
  120.     - client_address is the client IP address in the form (host,
  121.     port);
  122.  
  123.     - command, path and version are the broken-down request line;
  124.  
  125.     - headers is an instance of mimetools.Message (or a derived
  126.     class) containing the header information;
  127.  
  128.     - rfile is a file object open for reading positioned at the
  129.     start of the optional input data part;
  130.  
  131.     - wfile is a file object open for writing.
  132.  
  133.     IT IS IMPORTANT TO ADHERE TO THE PROTOCOL FOR WRITING!
  134.  
  135.     The first thing to be written must be the response line.  Then
  136.     follow 0 or more header lines, then a blank line, and then the
  137.     actual data (if any).  The meaning of the header lines depends on
  138.     the command executed by the server; in most cases, when data is
  139.     returned, there should be at least one header line of the form
  140.  
  141.     Content-type: <type>/<subtype>
  142.  
  143.     where <type> and <subtype> should be registered MIME types,
  144.     e.g. "text/html" or "text/plain".
  145.  
  146.     '''
  147.     sys_version = 'Python/' + sys.version.split()[0]
  148.     server_version = 'BaseHTTP/' + __version__
  149.     
  150.     def parse_request(self):
  151.         '''Parse a request (internal).
  152.  
  153.         The request should be stored in self.raw_requestline; the results
  154.         are in self.command, self.path, self.request_version and
  155.         self.headers.
  156.  
  157.         Return True for success, False for failure; on failure, an
  158.         error is sent back.
  159.  
  160.         '''
  161.         self.command = None
  162.         self.request_version = version = 'HTTP/0.9'
  163.         self.close_connection = 1
  164.         requestline = self.raw_requestline
  165.         if requestline[-2:] == '\r\n':
  166.             requestline = requestline[:-2]
  167.         elif requestline[-1:] == '\n':
  168.             requestline = requestline[:-1]
  169.         
  170.         self.requestline = requestline
  171.         words = requestline.split()
  172.         if len(words) == 3:
  173.             (command, path, version) = words
  174.             if version[:5] != 'HTTP/':
  175.                 self.send_error(400, 'Bad request version (%r)' % version)
  176.                 return False
  177.             
  178.             
  179.             try:
  180.                 base_version_number = version.split('/', 1)[1]
  181.                 version_number = base_version_number.split('.')
  182.                 if len(version_number) != 2:
  183.                     raise ValueError
  184.                 
  185.                 version_number = (int(version_number[0]), int(version_number[1]))
  186.             except (ValueError, IndexError):
  187.                 self.send_error(400, 'Bad request version (%r)' % version)
  188.                 return False
  189.  
  190.             if version_number >= (1, 1) and self.protocol_version >= 'HTTP/1.1':
  191.                 self.close_connection = 0
  192.             
  193.             if version_number >= (2, 0):
  194.                 self.send_error(505, 'Invalid HTTP Version (%s)' % base_version_number)
  195.                 return False
  196.             
  197.         elif len(words) == 2:
  198.             (command, path) = words
  199.             self.close_connection = 1
  200.             if command != 'GET':
  201.                 self.send_error(400, 'Bad HTTP/0.9 request type (%r)' % command)
  202.                 return False
  203.             
  204.         elif not words:
  205.             return False
  206.         else:
  207.             self.send_error(400, 'Bad request syntax (%r)' % requestline)
  208.             return False
  209.         self.command = command
  210.         self.path = path
  211.         self.request_version = version
  212.         self.headers = self.MessageClass(self.rfile, 0)
  213.         conntype = self.headers.get('Connection', '')
  214.         if conntype.lower() == 'close':
  215.             self.close_connection = 1
  216.         elif conntype.lower() == 'keep-alive' and self.protocol_version >= 'HTTP/1.1':
  217.             self.close_connection = 0
  218.         
  219.         return True
  220.  
  221.     
  222.     def handle_one_request(self):
  223.         """Handle a single HTTP request.
  224.  
  225.         You normally don't need to override this method; see the class
  226.         __doc__ string for information on how to handle specific HTTP
  227.         commands such as GET and POST.
  228.  
  229.         """
  230.         self.raw_requestline = self.rfile.readline()
  231.         if not self.raw_requestline:
  232.             self.close_connection = 1
  233.             return None
  234.         
  235.         if not self.parse_request():
  236.             return None
  237.         
  238.         mname = 'do_' + self.command
  239.         if not hasattr(self, mname):
  240.             self.send_error(501, 'Unsupported method (%r)' % self.command)
  241.             return None
  242.         
  243.         method = getattr(self, mname)
  244.         method()
  245.  
  246.     
  247.     def handle(self):
  248.         '''Handle multiple requests if necessary.'''
  249.         self.close_connection = 1
  250.         self.handle_one_request()
  251.         while not self.close_connection:
  252.             self.handle_one_request()
  253.  
  254.     
  255.     def send_error(self, code, message = None):
  256.         '''Send and log an error reply.
  257.  
  258.         Arguments are the error code, and a detailed message.
  259.         The detailed message defaults to the short entry matching the
  260.         response code.
  261.  
  262.         This sends an error response (so it must be called before any
  263.         output has been generated), logs the error, and finally sends
  264.         a piece of HTML explaining the error to the user.
  265.  
  266.         '''
  267.         
  268.         try:
  269.             (short, long) = self.responses[code]
  270.         except KeyError:
  271.             (short, long) = ('???', '???')
  272.  
  273.         if message is None:
  274.             message = short
  275.         
  276.         explain = long
  277.         self.log_error('code %d, message %s', code, message)
  278.         content = self.error_message_format % {
  279.             'code': code,
  280.             'message': message,
  281.             'explain': explain }
  282.         self.send_response(code, message)
  283.         self.send_header('Content-Type', 'text/html')
  284.         self.send_header('Connection', 'close')
  285.         self.end_headers()
  286.         if self.command != 'HEAD' and code >= 200 and code not in (204, 304):
  287.             self.wfile.write(content)
  288.         
  289.  
  290.     error_message_format = DEFAULT_ERROR_MESSAGE
  291.     
  292.     def send_response(self, code, message = None):
  293.         '''Send the response header and log the response code.
  294.  
  295.         Also send two standard headers with the server software
  296.         version and the current date.
  297.  
  298.         '''
  299.         self.log_request(code)
  300.         if message is None:
  301.             if code in self.responses:
  302.                 message = self.responses[code][0]
  303.             else:
  304.                 message = ''
  305.         
  306.         if self.request_version != 'HTTP/0.9':
  307.             self.wfile.write('%s %d %s\r\n' % (self.protocol_version, code, message))
  308.         
  309.         self.send_header('Server', self.version_string())
  310.         self.send_header('Date', self.date_time_string())
  311.  
  312.     
  313.     def send_header(self, keyword, value):
  314.         '''Send a MIME header.'''
  315.         if self.request_version != 'HTTP/0.9':
  316.             self.wfile.write('%s: %s\r\n' % (keyword, value))
  317.         
  318.         if keyword.lower() == 'connection':
  319.             if value.lower() == 'close':
  320.                 self.close_connection = 1
  321.             elif value.lower() == 'keep-alive':
  322.                 self.close_connection = 0
  323.             
  324.         
  325.  
  326.     
  327.     def end_headers(self):
  328.         '''Send the blank line ending the MIME headers.'''
  329.         if self.request_version != 'HTTP/0.9':
  330.             self.wfile.write('\r\n')
  331.         
  332.  
  333.     
  334.     def log_request(self, code = '-', size = '-'):
  335.         '''Log an accepted request.
  336.  
  337.         This is called by send_reponse().
  338.  
  339.         '''
  340.         self.log_message('"%s" %s %s', self.requestline, str(code), str(size))
  341.  
  342.     
  343.     def log_error(self, *args):
  344.         '''Log an error.
  345.  
  346.         This is called when a request cannot be fulfilled.  By
  347.         default it passes the message on to log_message().
  348.  
  349.         Arguments are the same as for log_message().
  350.  
  351.         XXX This should go to the separate error log.
  352.  
  353.         '''
  354.         self.log_message(*args)
  355.  
  356.     
  357.     def log_message(self, format, *args):
  358.         """Log an arbitrary message.
  359.  
  360.         This is used by all other logging functions.  Override
  361.         it if you have specific logging wishes.
  362.  
  363.         The first argument, FORMAT, is a format string for the
  364.         message to be logged.  If the format string contains
  365.         any % escapes requiring parameters, they should be
  366.         specified as subsequent arguments (it's just like
  367.         printf!).
  368.  
  369.         The client host and current date/time are prefixed to
  370.         every message.
  371.  
  372.         """
  373.         sys.stderr.write('%s - - [%s] %s\n' % (self.address_string(), self.log_date_time_string(), format % args))
  374.  
  375.     
  376.     def version_string(self):
  377.         '''Return the server software version string.'''
  378.         return self.server_version + ' ' + self.sys_version
  379.  
  380.     
  381.     def date_time_string(self):
  382.         '''Return the current date and time formatted for a message header.'''
  383.         now = time.time()
  384.         (year, month, day, hh, mm, ss, wd, y, z) = time.gmtime(now)
  385.         s = '%s, %02d %3s %4d %02d:%02d:%02d GMT' % (self.weekdayname[wd], day, self.monthname[month], year, hh, mm, ss)
  386.         return s
  387.  
  388.     
  389.     def log_date_time_string(self):
  390.         '''Return the current time formatted for logging.'''
  391.         now = time.time()
  392.         (year, month, day, hh, mm, ss, x, y, z) = time.localtime(now)
  393.         s = '%02d/%3s/%04d %02d:%02d:%02d' % (day, self.monthname[month], year, hh, mm, ss)
  394.         return s
  395.  
  396.     weekdayname = [
  397.         'Mon',
  398.         'Tue',
  399.         'Wed',
  400.         'Thu',
  401.         'Fri',
  402.         'Sat',
  403.         'Sun']
  404.     monthname = [
  405.         None,
  406.         'Jan',
  407.         'Feb',
  408.         'Mar',
  409.         'Apr',
  410.         'May',
  411.         'Jun',
  412.         'Jul',
  413.         'Aug',
  414.         'Sep',
  415.         'Oct',
  416.         'Nov',
  417.         'Dec']
  418.     
  419.     def address_string(self):
  420.         '''Return the client address formatted for logging.
  421.  
  422.         This version looks up the full hostname using gethostbyaddr(),
  423.         and tries to find a name that contains at least one dot.
  424.  
  425.         '''
  426.         (host, port) = self.client_address[:2]
  427.         return socket.getfqdn(host)
  428.  
  429.     protocol_version = 'HTTP/1.0'
  430.     MessageClass = mimetools.Message
  431.     responses = {
  432.         100: ('Continue', 'Request received, please continue'),
  433.         101: ('Switching Protocols', 'Switching to new protocol; obey Upgrade header'),
  434.         200: ('OK', 'Request fulfilled, document follows'),
  435.         201: ('Created', 'Document created, URL follows'),
  436.         202: ('Accepted', 'Request accepted, processing continues off-line'),
  437.         203: ('Non-Authoritative Information', 'Request fulfilled from cache'),
  438.         204: ('No response', 'Request fulfilled, nothing follows'),
  439.         205: ('Reset Content', 'Clear input form for further input.'),
  440.         206: ('Partial Content', 'Partial content follows.'),
  441.         300: ('Multiple Choices', 'Object has several resources -- see URI list'),
  442.         301: ('Moved Permanently', 'Object moved permanently -- see URI list'),
  443.         302: ('Found', 'Object moved temporarily -- see URI list'),
  444.         303: ('See Other', 'Object moved -- see Method and URL list'),
  445.         304: ('Not modified', 'Document has not changed since given time'),
  446.         305: ('Use Proxy', 'You must use proxy specified in Location to access this resource.'),
  447.         307: ('Temporary Redirect', 'Object moved temporarily -- see URI list'),
  448.         400: ('Bad request', 'Bad request syntax or unsupported method'),
  449.         401: ('Unauthorized', 'No permission -- see authorization schemes'),
  450.         402: ('Payment required', 'No payment -- see charging schemes'),
  451.         403: ('Forbidden', 'Request forbidden -- authorization will not help'),
  452.         404: ('Not Found', 'Nothing matches the given URI'),
  453.         405: ('Method Not Allowed', 'Specified method is invalid for this server.'),
  454.         406: ('Not Acceptable', 'URI not available in preferred format.'),
  455.         407: ('Proxy Authentication Required', 'You must authenticate with this proxy before proceeding.'),
  456.         408: ('Request Time-out', 'Request timed out; try again later.'),
  457.         409: ('Conflict', 'Request conflict.'),
  458.         410: ('Gone', 'URI no longer exists and has been permanently removed.'),
  459.         411: ('Length Required', 'Client must specify Content-Length.'),
  460.         412: ('Precondition Failed', 'Precondition in headers is false.'),
  461.         413: ('Request Entity Too Large', 'Entity is too large.'),
  462.         414: ('Request-URI Too Long', 'URI is too long.'),
  463.         415: ('Unsupported Media Type', 'Entity body in unsupported format.'),
  464.         416: ('Requested Range Not Satisfiable', 'Cannot satisfy request range.'),
  465.         417: ('Expectation Failed', 'Expect condition could not be satisfied.'),
  466.         500: ('Internal error', 'Server got itself in trouble'),
  467.         501: ('Not Implemented', 'Server does not support this operation'),
  468.         502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),
  469.         503: ('Service temporarily overloaded', 'The server cannot process the request due to a high load'),
  470.         504: ('Gateway timeout', 'The gateway server did not receive a timely response'),
  471.         505: ('HTTP Version not supported', 'Cannot fulfill request.') }
  472.  
  473.  
  474. def test(HandlerClass = BaseHTTPRequestHandler, ServerClass = HTTPServer, protocol = 'HTTP/1.0'):
  475.     '''Test the HTTP request handler class.
  476.  
  477.     This runs an HTTP server on port 8000 (or the first command line
  478.     argument).
  479.  
  480.     '''
  481.     if sys.argv[1:]:
  482.         port = int(sys.argv[1])
  483.     else:
  484.         port = 8000
  485.     server_address = ('', port)
  486.     HandlerClass.protocol_version = protocol
  487.     httpd = ServerClass(server_address, HandlerClass)
  488.     sa = httpd.socket.getsockname()
  489.     print 'Serving HTTP on', sa[0], 'port', sa[1], '...'
  490.     httpd.serve_forever()
  491.  
  492. if __name__ == '__main__':
  493.     test()
  494.  
  495.