home *** CD-ROM | disk | FTP | other *** search
/ linuxmafia.com 2016 / linuxmafia.com.tar / linuxmafia.com / pub / palmos / pippy-0.6beta-src.tar.gz / pippy-0.6beta-src.tar / pippy-0.6beta-src / src / Lib / cgi.py < prev    next >
Text File  |  2000-12-21  |  48KB  |  1,386 lines
  1. #! /usr/local/bin/python
  2.  
  3. """Support module for CGI (Common Gateway Interface) scripts.
  4.  
  5. This module defines a number of utilities for use by CGI scripts
  6. written in Python.
  7.  
  8.  
  9. Introduction
  10. ------------
  11.  
  12. A CGI script is invoked by an HTTP server, usually to process user
  13. input submitted through an HTML <FORM> or <ISINPUT> element.
  14.  
  15. Most often, CGI scripts live in the server's special cgi-bin
  16. directory.  The HTTP server places all sorts of information about the
  17. request (such as the client's hostname, the requested URL, the query
  18. string, and lots of other goodies) in the script's shell environment,
  19. executes the script, and sends the script's output back to the client.
  20.  
  21. The script's input is connected to the client too, and sometimes the
  22. form data is read this way; at other times the form data is passed via
  23. the "query string" part of the URL.  This module (cgi.py) is intended
  24. to take care of the different cases and provide a simpler interface to
  25. the Python script.  It also provides a number of utilities that help
  26. in debugging scripts, and the latest addition is support for file
  27. uploads from a form (if your browser supports it -- Grail 0.3 and
  28. Netscape 2.0 do).
  29.  
  30. The output of a CGI script should consist of two sections, separated
  31. by a blank line.  The first section contains a number of headers,
  32. telling the client what kind of data is following.  Python code to
  33. generate a minimal header section looks like this:
  34.  
  35.         print "Content-type: text/html" # HTML is following
  36.         print                           # blank line, end of headers
  37.  
  38. The second section is usually HTML, which allows the client software
  39. to display nicely formatted text with header, in-line images, etc.
  40. Here's Python code that prints a simple piece of HTML:
  41.  
  42.         print "<TITLE>CGI script output</TITLE>"
  43.         print "<H1>This is my first CGI script</H1>"
  44.         print "Hello, world!"
  45.  
  46. It may not be fully legal HTML according to the letter of the
  47. standard, but any browser will understand it.
  48.  
  49.  
  50. Using the cgi module
  51. --------------------
  52.  
  53. Begin by writing "import cgi".  Don't use "from cgi import *" -- the
  54. module defines all sorts of names for its own use or for backward 
  55. compatibility that you don't want in your namespace.
  56.  
  57. It's best to use the FieldStorage class.  The other classes define in this 
  58. module are provided mostly for backward compatibility.  Instantiate it 
  59. exactly once, without arguments.  This reads the form contents from 
  60. standard input or the environment (depending on the value of various 
  61. environment variables set according to the CGI standard).  Since it may 
  62. consume standard input, it should be instantiated only once.
  63.  
  64. The FieldStorage instance can be accessed as if it were a Python 
  65. dictionary.  For instance, the following code (which assumes that the 
  66. Content-type header and blank line have already been printed) checks that 
  67. the fields "name" and "addr" are both set to a non-empty string:
  68.  
  69.         form = cgi.FieldStorage()
  70.         form_ok = 0
  71.         if form.has_key("name") and form.has_key("addr"):
  72.                 if form["name"].value != "" and form["addr"].value != "":
  73.                         form_ok = 1
  74.         if not form_ok:
  75.                 print "<H1>Error</H1>"
  76.                 print "Please fill in the name and addr fields."
  77.                 return
  78.         ...further form processing here...
  79.  
  80. Here the fields, accessed through form[key], are themselves instances
  81. of FieldStorage (or MiniFieldStorage, depending on the form encoding).
  82.  
  83. If the submitted form data contains more than one field with the same
  84. name, the object retrieved by form[key] is not a (Mini)FieldStorage
  85. instance but a list of such instances.  If you are expecting this
  86. possibility (i.e., when your HTML form comtains multiple fields with
  87. the same name), use the type() function to determine whether you have
  88. a single instance or a list of instances.  For example, here's code
  89. that concatenates any number of username fields, separated by commas:
  90.  
  91.         username = form["username"]
  92.         if type(username) is type([]):
  93.                 # Multiple username fields specified
  94.                 usernames = ""
  95.                 for item in username:
  96.                         if usernames:
  97.                                 # Next item -- insert comma
  98.                                 usernames = usernames + "," + item.value
  99.                         else:
  100.                                 # First item -- don't insert comma
  101.                                 usernames = item.value
  102.         else:
  103.                 # Single username field specified
  104.                 usernames = username.value
  105.  
  106. If a field represents an uploaded file, the value attribute reads the 
  107. entire file in memory as a string.  This may not be what you want.  You can 
  108. test for an uploaded file by testing either the filename attribute or the 
  109. file attribute.  You can then read the data at leasure from the file 
  110. attribute:
  111.  
  112.         fileitem = form["userfile"]
  113.         if fileitem.file:
  114.                 # It's an uploaded file; count lines
  115.                 linecount = 0
  116.                 while 1:
  117.                         line = fileitem.file.readline()
  118.                         if not line: break
  119.                         linecount = linecount + 1
  120.  
  121. The file upload draft standard entertains the possibility of uploading
  122. multiple files from one field (using a recursive multipart/*
  123. encoding).  When this occurs, the item will be a dictionary-like
  124. FieldStorage item.  This can be determined by testing its type
  125. attribute, which should have the value "multipart/form-data" (or
  126. perhaps another string beginning with "multipart/").  It this case, it
  127. can be iterated over recursively just like the top-level form object.
  128.  
  129. When a form is submitted in the "old" format (as the query string or as a 
  130. single data part of type application/x-www-form-urlencoded), the items 
  131. will actually be instances of the class MiniFieldStorage.  In this case,
  132. the list, file and filename attributes are always None.
  133.  
  134.  
  135. Old classes
  136. -----------
  137.  
  138. These classes, present in earlier versions of the cgi module, are still 
  139. supported for backward compatibility.  New applications should use the
  140. FieldStorage class.
  141.  
  142. SvFormContentDict: single value form content as dictionary; assumes each 
  143. field name occurs in the form only once.
  144.  
  145. FormContentDict: multiple value form content as dictionary (the form
  146. items are lists of values).  Useful if your form contains multiple
  147. fields with the same name.
  148.  
  149. Other classes (FormContent, InterpFormContentDict) are present for
  150. backwards compatibility with really old applications only.  If you still 
  151. use these and would be inconvenienced when they disappeared from a next 
  152. version of this module, drop me a note.
  153.  
  154.  
  155. Functions
  156. ---------
  157.  
  158. These are useful if you want more control, or if you want to employ
  159. some of the algorithms implemented in this module in other
  160. circumstances.
  161.  
  162. parse(fp, [environ, [keep_blank_values, [strict_parsing]]]): parse a
  163. form into a Python dictionary.
  164.  
  165. parse_qs(qs, [keep_blank_values, [strict_parsing]]): parse a query
  166. string (data of type application/x-www-form-urlencoded).  Data are
  167. returned as a dictionary.  The dictionary keys are the unique query
  168. variable names and the values are lists of vales for each name.
  169.  
  170. parse_qsl(qs, [keep_blank_values, [strict_parsing]]): parse a query
  171. string (data of type application/x-www-form-urlencoded).  Data are
  172. returned as a list of (name, value) pairs.
  173.  
  174. parse_multipart(fp, pdict): parse input of type multipart/form-data (for 
  175. file uploads).
  176.  
  177. parse_header(string): parse a header like Content-type into a main
  178. value and a dictionary of parameters.
  179.  
  180. test(): complete test program.
  181.  
  182. print_environ(): format the shell environment in HTML.
  183.  
  184. print_form(form): format a form in HTML.
  185.  
  186. print_environ_usage(): print a list of useful environment variables in
  187. HTML.
  188.  
  189. escape(): convert the characters "&", "<" and ">" to HTML-safe
  190. sequences.  Use this if you need to display text that might contain
  191. such characters in HTML.  To translate URLs for inclusion in the HREF
  192. attribute of an <A> tag, use urllib.quote().
  193.  
  194. log(fmt, ...): write a line to a log file; see docs for initlog().
  195.  
  196.  
  197. Caring about security
  198. ---------------------
  199.  
  200. There's one important rule: if you invoke an external program (e.g.
  201. via the os.system() or os.popen() functions), make very sure you don't
  202. pass arbitrary strings received from the client to the shell.  This is
  203. a well-known security hole whereby clever hackers anywhere on the web
  204. can exploit a gullible CGI script to invoke arbitrary shell commands.
  205. Even parts of the URL or field names cannot be trusted, since the
  206. request doesn't have to come from your form!
  207.  
  208. To be on the safe side, if you must pass a string gotten from a form
  209. to a shell command, you should make sure the string contains only
  210. alphanumeric characters, dashes, underscores, and periods.
  211.  
  212.  
  213. Installing your CGI script on a Unix system
  214. -------------------------------------------
  215.  
  216. Read the documentation for your HTTP server and check with your local
  217. system administrator to find the directory where CGI scripts should be
  218. installed; usually this is in a directory cgi-bin in the server tree.
  219.  
  220. Make sure that your script is readable and executable by "others"; the
  221. Unix file mode should be 755 (use "chmod 755 filename").  Make sure
  222. that the first line of the script contains #! starting in column 1
  223. followed by the pathname of the Python interpreter, for instance:
  224.  
  225.         #! /usr/local/bin/python
  226.  
  227. Make sure the Python interpreter exists and is executable by "others".
  228.  
  229. Note that it's probably not a good idea to use #! /usr/bin/env python
  230. here, since the Python interpreter may not be on the default path
  231. given to CGI scripts!!!
  232.  
  233. Make sure that any files your script needs to read or write are
  234. readable or writable, respectively, by "others" -- their mode should
  235. be 644 for readable and 666 for writable.  This is because, for
  236. security reasons, the HTTP server executes your script as user
  237. "nobody", without any special privileges.  It can only read (write,
  238. execute) files that everybody can read (write, execute).  The current
  239. directory at execution time is also different (it is usually the
  240. server's cgi-bin directory) and the set of environment variables is
  241. also different from what you get at login.  in particular, don't count
  242. on the shell's search path for executables ($PATH) or the Python
  243. module search path ($PYTHONPATH) to be set to anything interesting.
  244.  
  245. If you need to load modules from a directory which is not on Python's
  246. default module search path, you can change the path in your script,
  247. before importing other modules, e.g.:
  248.  
  249.         import sys
  250.         sys.path.insert(0, "/usr/home/joe/lib/python")
  251.         sys.path.insert(0, "/usr/local/lib/python")
  252.  
  253. This way, the directory inserted last will be searched first!
  254.  
  255. Instructions for non-Unix systems will vary; check your HTTP server's
  256. documentation (it will usually have a section on CGI scripts).
  257.  
  258.  
  259. Testing your CGI script
  260. -----------------------
  261.  
  262. Unfortunately, a CGI script will generally not run when you try it
  263. from the command line, and a script that works perfectly from the
  264. command line may fail mysteriously when run from the server.  There's
  265. one reason why you should still test your script from the command
  266. line: if it contains a syntax error, the python interpreter won't
  267. execute it at all, and the HTTP server will most likely send a cryptic
  268. error to the client.
  269.  
  270. Assuming your script has no syntax errors, yet it does not work, you
  271. have no choice but to read the next section:
  272.  
  273.  
  274. Debugging CGI scripts
  275. ---------------------
  276.  
  277. First of all, check for trivial installation errors -- reading the
  278. section above on installing your CGI script carefully can save you a
  279. lot of time.  If you wonder whether you have understood the
  280. installation procedure correctly, try installing a copy of this module
  281. file (cgi.py) as a CGI script.  When invoked as a script, the file
  282. will dump its environment and the contents of the form in HTML form.
  283. Give it the right mode etc, and send it a request.  If it's installed
  284. in the standard cgi-bin directory, it should be possible to send it a
  285. request by entering a URL into your browser of the form:
  286.  
  287.         http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home
  288.  
  289. If this gives an error of type 404, the server cannot find the script
  290. -- perhaps you need to install it in a different directory.  If it
  291. gives another error (e.g.  500), there's an installation problem that
  292. you should fix before trying to go any further.  If you get a nicely
  293. formatted listing of the environment and form content (in this
  294. example, the fields should be listed as "addr" with value "At Home"
  295. and "name" with value "Joe Blow"), the cgi.py script has been
  296. installed correctly.  If you follow the same procedure for your own
  297. script, you should now be able to debug it.
  298.  
  299. The next step could be to call the cgi module's test() function from
  300. your script: replace its main code with the single statement
  301.  
  302.         cgi.test()
  303.         
  304. This should produce the same results as those gotten from installing
  305. the cgi.py file itself.
  306.  
  307. When an ordinary Python script raises an unhandled exception (e.g.,
  308. because of a typo in a module name, a file that can't be opened,
  309. etc.), the Python interpreter prints a nice traceback and exits.
  310. While the Python interpreter will still do this when your CGI script
  311. raises an exception, most likely the traceback will end up in one of
  312. the HTTP server's log file, or be discarded altogether.
  313.  
  314. Fortunately, once you have managed to get your script to execute
  315. *some* code, it is easy to catch exceptions and cause a traceback to
  316. be printed.  The test() function below in this module is an example.
  317. Here are the rules:
  318.  
  319.         1. Import the traceback module (before entering the
  320.            try-except!)
  321.         
  322.         2. Make sure you finish printing the headers and the blank
  323.            line early
  324.         
  325.         3. Assign sys.stderr to sys.stdout
  326.         
  327.         3. Wrap all remaining code in a try-except statement
  328.         
  329.         4. In the except clause, call traceback.print_exc()
  330.  
  331. For example:
  332.  
  333.         import sys
  334.         import traceback
  335.         print "Content-type: text/html"
  336.         print
  337.         sys.stderr = sys.stdout
  338.         try:
  339.                 ...your code here...
  340.         except:
  341.                 print "\n\n<PRE>"
  342.                 traceback.print_exc()
  343.  
  344. Notes: The assignment to sys.stderr is needed because the traceback
  345. prints to sys.stderr.  The print "\n\n<PRE>" statement is necessary to
  346. disable the word wrapping in HTML.
  347.  
  348. If you suspect that there may be a problem in importing the traceback
  349. module, you can use an even more robust approach (which only uses
  350. built-in modules):
  351.  
  352.         import sys
  353.         sys.stderr = sys.stdout
  354.         print "Content-type: text/plain"
  355.         print
  356.         ...your code here...
  357.  
  358. This relies on the Python interpreter to print the traceback.  The
  359. content type of the output is set to plain text, which disables all
  360. HTML processing.  If your script works, the raw HTML will be displayed
  361. by your client.  If it raises an exception, most likely after the
  362. first two lines have been printed, a traceback will be displayed.
  363. Because no HTML interpretation is going on, the traceback will
  364. readable.
  365.  
  366. When all else fails, you may want to insert calls to log() to your
  367. program or even to a copy of the cgi.py file.  Note that this requires
  368. you to set cgi.logfile to the name of a world-writable file before the
  369. first call to log() is made!
  370.  
  371. Good luck!
  372.  
  373.  
  374. Common problems and solutions
  375. -----------------------------
  376.  
  377. - Most HTTP servers buffer the output from CGI scripts until the
  378. script is completed.  This means that it is not possible to display a
  379. progress report on the client's display while the script is running.
  380.  
  381. - Check the installation instructions above.
  382.  
  383. - Check the HTTP server's log files.  ("tail -f logfile" in a separate
  384. window may be useful!)
  385.  
  386. - Always check a script for syntax errors first, by doing something
  387. like "python script.py".
  388.  
  389. - When using any of the debugging techniques, don't forget to add
  390. "import sys" to the top of the script.
  391.  
  392. - When invoking external programs, make sure they can be found.
  393. Usually, this means using absolute path names -- $PATH is usually not
  394. set to a very useful value in a CGI script.
  395.  
  396. - When reading or writing external files, make sure they can be read
  397. or written by every user on the system.
  398.  
  399. - Don't try to give a CGI script a set-uid mode.  This doesn't work on
  400. most systems, and is a security liability as well.
  401.  
  402. """
  403.  
  404. # XXX The module is getting pretty heavy with all those docstrings.
  405. # Perhaps there should be a slimmed version that doesn't contain all those 
  406. # backwards compatible and debugging classes and functions?
  407.  
  408. # History
  409. # -------
  410. # 
  411. # Michael McLay started this module.  Steve Majewski changed the
  412. # interface to SvFormContentDict and FormContentDict.  The multipart
  413. # parsing was inspired by code submitted by Andreas Paepcke.  Guido van
  414. # Rossum rewrote, reformatted and documented the module and is currently
  415. # responsible for its maintenance.
  416. # 
  417.  
  418. __version__ = "2.2"
  419.  
  420.  
  421. # Imports
  422. # =======
  423.  
  424. import string
  425. import sys
  426. import os
  427. import urllib
  428. import mimetools
  429. import rfc822
  430. from StringIO import StringIO
  431.  
  432.  
  433. # Logging support
  434. # ===============
  435.  
  436. logfile = ""            # Filename to log to, if not empty
  437. logfp = None            # File object to log to, if not None
  438.  
  439. def initlog(*allargs):
  440.     """Write a log message, if there is a log file.
  441.  
  442.     Even though this function is called initlog(), you should always
  443.     use log(); log is a variable that is set either to initlog
  444.     (initially), to dolog (once the log file has been opened), or to
  445.     nolog (when logging is disabled).
  446.  
  447.     The first argument is a format string; the remaining arguments (if
  448.     any) are arguments to the % operator, so e.g.
  449.         log("%s: %s", "a", "b")
  450.     will write "a: b" to the log file, followed by a newline.
  451.  
  452.     If the global logfp is not None, it should be a file object to
  453.     which log data is written.
  454.  
  455.     If the global logfp is None, the global logfile may be a string
  456.     giving a filename to open, in append mode.  This file should be
  457.     world writable!!!  If the file can't be opened, logging is
  458.     silently disabled (since there is no safe place where we could
  459.     send an error message).
  460.  
  461.     """
  462.     global logfp, log
  463.     if logfile and not logfp:
  464.         try:
  465.             logfp = open(logfile, "a")
  466.         except IOError:
  467.             pass
  468.     if not logfp:
  469.         log = nolog
  470.     else:
  471.         log = dolog
  472.     apply(log, allargs)
  473.  
  474. def dolog(fmt, *args):
  475.     """Write a log message to the log file.  See initlog() for docs."""
  476.     logfp.write(fmt%args + "\n")
  477.  
  478. def nolog(*allargs):
  479.     """Dummy function, assigned to log when logging is disabled."""
  480.     pass
  481.  
  482. log = initlog           # The current logging function
  483.  
  484.  
  485. # Parsing functions
  486. # =================
  487.  
  488. # Maximum input we will accept when REQUEST_METHOD is POST
  489. # 0 ==> unlimited input
  490. maxlen = 0
  491.  
  492. def parse(fp=None, environ=os.environ, keep_blank_values=0, strict_parsing=0):
  493.     """Parse a query in the environment or from a file (default stdin)
  494.  
  495.         Arguments, all optional:
  496.  
  497.         fp              : file pointer; default: sys.stdin
  498.  
  499.         environ         : environment dictionary; default: os.environ
  500.  
  501.         keep_blank_values: flag indicating whether blank values in
  502.             URL encoded forms should be treated as blank strings.  
  503.             A true value inicates that blanks should be retained as 
  504.             blank strings.  The default false value indicates that
  505.             blank values are to be ignored and treated as if they were
  506.             not included.
  507.  
  508.         strict_parsing: flag indicating what to do with parsing errors.
  509.             If false (the default), errors are silently ignored.
  510.             If true, errors raise a ValueError exception.
  511.     """
  512.     if not fp:
  513.         fp = sys.stdin
  514.     if not environ.has_key('REQUEST_METHOD'):
  515.         environ['REQUEST_METHOD'] = 'GET'       # For testing stand-alone
  516.     if environ['REQUEST_METHOD'] == 'POST':
  517.         ctype, pdict = parse_header(environ['CONTENT_TYPE'])
  518.         if ctype == 'multipart/form-data':
  519.             return parse_multipart(fp, pdict)
  520.         elif ctype == 'application/x-www-form-urlencoded':
  521.             clength = string.atoi(environ['CONTENT_LENGTH'])
  522.             if maxlen and clength > maxlen:
  523.                 raise ValueError, 'Maximum content length exceeded'
  524.             qs = fp.read(clength)
  525.         else:
  526.             qs = ''                     # Unknown content-type
  527.         if environ.has_key('QUERY_STRING'): 
  528.             if qs: qs = qs + '&'
  529.             qs = qs + environ['QUERY_STRING']
  530.         elif sys.argv[1:]: 
  531.             if qs: qs = qs + '&'
  532.             qs = qs + sys.argv[1]
  533.         environ['QUERY_STRING'] = qs    # XXX Shouldn't, really
  534.     elif environ.has_key('QUERY_STRING'):
  535.         qs = environ['QUERY_STRING']
  536.     else:
  537.         if sys.argv[1:]:
  538.             qs = sys.argv[1]
  539.         else:
  540.             qs = ""
  541.         environ['QUERY_STRING'] = qs    # XXX Shouldn't, really
  542.     return parse_qs(qs, keep_blank_values, strict_parsing)
  543.  
  544.  
  545. def parse_qs(qs, keep_blank_values=0, strict_parsing=0):
  546.     """Parse a query given as a string argument.
  547.  
  548.         Arguments:
  549.  
  550.         qs: URL-encoded query string to be parsed
  551.  
  552.         keep_blank_values: flag indicating whether blank values in
  553.             URL encoded queries should be treated as blank strings.  
  554.             A true value inicates that blanks should be retained as 
  555.             blank strings.  The default false value indicates that
  556.             blank values are to be ignored and treated as if they were
  557.             not included.
  558.  
  559.         strict_parsing: flag indicating what to do with parsing errors.
  560.             If false (the default), errors are silently ignored.
  561.             If true, errors raise a ValueError exception.
  562.     """
  563.     dict = {}
  564.     for name, value in parse_qsl(qs, keep_blank_values, strict_parsing):
  565.         if len(value) or keep_blank_values:
  566.             if dict.has_key(name):
  567.                 dict[name].append(value)
  568.             else:
  569.                 dict[name] = [value]
  570.     return dict
  571.  
  572. def parse_qsl(qs, keep_blank_values=0, strict_parsing=0):
  573.     """Parse a query given as a string argument.
  574.  
  575.         Arguments:
  576.  
  577.         qs: URL-encoded query string to be parsed
  578.  
  579.         keep_blank_values: flag indicating whether blank values in
  580.             URL encoded queries should be treated as blank strings.  
  581.             A true value inicates that blanks should be retained as 
  582.             blank strings.  The default false value indicates that
  583.             blank values are to be ignored and treated as if they were
  584.             not included.
  585.  
  586.         strict_parsing: flag indicating what to do with parsing errors.
  587.             If false (the default), errors are silently ignored.
  588.             If true, errors raise a ValueError exception.
  589.  
  590.        Returns a list, as God intended.
  591.     """
  592.     name_value_pairs = string.splitfields(qs, '&')
  593.     r=[]
  594.     for name_value in name_value_pairs:
  595.         nv = string.splitfields(name_value, '=')
  596.         if len(nv) != 2:
  597.             if strict_parsing:
  598.                 raise ValueError, "bad query field: %s" % `name_value`
  599.             continue
  600.         name = urllib.unquote(string.replace(nv[0], '+', ' '))
  601.         value = urllib.unquote(string.replace(nv[1], '+', ' '))
  602.         r.append((name, value))
  603.  
  604.     return r
  605.  
  606.  
  607. def parse_multipart(fp, pdict):
  608.     """Parse multipart input.
  609.  
  610.     Arguments:
  611.     fp   : input file
  612.     pdict: dictionary containing other parameters of conten-type header
  613.  
  614.     Returns a dictionary just like parse_qs(): keys are the field names, each 
  615.     value is a list of values for that field.  This is easy to use but not 
  616.     much good if you are expecting megabytes to be uploaded -- in that case, 
  617.     use the FieldStorage class instead which is much more flexible.  Note 
  618.     that content-type is the raw, unparsed contents of the content-type 
  619.     header.
  620.     
  621.     XXX This does not parse nested multipart parts -- use FieldStorage for 
  622.     that.
  623.     
  624.     XXX This should really be subsumed by FieldStorage altogether -- no 
  625.     point in having two implementations of the same parsing algorithm.
  626.  
  627.     """
  628.     if pdict.has_key('boundary'):
  629.         boundary = pdict['boundary']
  630.     else:
  631.         boundary = ""
  632.     nextpart = "--" + boundary
  633.     lastpart = "--" + boundary + "--"
  634.     partdict = {}
  635.     terminator = ""
  636.  
  637.     while terminator != lastpart:
  638.         bytes = -1
  639.         data = None
  640.         if terminator:
  641.             # At start of next part.  Read headers first.
  642.             headers = mimetools.Message(fp)
  643.             clength = headers.getheader('content-length')
  644.             if clength:
  645.                 try:
  646.                     bytes = string.atoi(clength)
  647.                 except string.atoi_error:
  648.                     pass
  649.             if bytes > 0:
  650.                 if maxlen and bytes > maxlen:
  651.                     raise ValueError, 'Maximum content length exceeded'
  652.                 data = fp.read(bytes)
  653.             else:
  654.                 data = ""
  655.         # Read lines until end of part.
  656.         lines = []
  657.         while 1:
  658.             line = fp.readline()
  659.             if not line:
  660.                 terminator = lastpart # End outer loop
  661.                 break
  662.             if line[:2] == "--":
  663.                 terminator = string.strip(line)
  664.                 if terminator in (nextpart, lastpart):
  665.                     break
  666.             lines.append(line)
  667.         # Done with part.
  668.         if data is None:
  669.             continue
  670.         if bytes < 0:
  671.             if lines:
  672.                 # Strip final line terminator
  673.                 line = lines[-1]
  674.                 if line[-2:] == "\r\n":
  675.                     line = line[:-2]
  676.                 elif line[-1:] == "\n":
  677.                     line = line[:-1]
  678.                 lines[-1] = line
  679.                 data = string.joinfields(lines, "")
  680.         line = headers['content-disposition']
  681.         if not line:
  682.             continue
  683.         key, params = parse_header(line)
  684.         if key != 'form-data':
  685.             continue
  686.         if params.has_key('name'):
  687.             name = params['name']
  688.         else:
  689.             continue
  690.         if partdict.has_key(name):
  691.             partdict[name].append(data)
  692.         else:
  693.             partdict[name] = [data]
  694.  
  695.     return partdict
  696.  
  697.  
  698. def parse_header(line):
  699.     """Parse a Content-type like header.
  700.  
  701.     Return the main content-type and a dictionary of options.
  702.  
  703.     """
  704.     plist = map(string.strip, string.splitfields(line, ';'))
  705.     key = string.lower(plist[0])
  706.     del plist[0]
  707.     pdict = {}
  708.     for p in plist:
  709.         i = string.find(p, '=')
  710.         if i >= 0:
  711.             name = string.lower(string.strip(p[:i]))
  712.             value = string.strip(p[i+1:])
  713.             if len(value) >= 2 and value[0] == value[-1] == '"':
  714.                 value = value[1:-1]
  715.             pdict[name] = value
  716.     return key, pdict
  717.  
  718.  
  719. # Classes for field storage
  720. # =========================
  721.  
  722. class MiniFieldStorage:
  723.  
  724.     """Like FieldStorage, for use when no file uploads are possible."""
  725.  
  726.     # Dummy attributes
  727.     filename = None
  728.     list = None
  729.     type = None
  730.     file = None
  731.     type_options = {}
  732.     disposition = None
  733.     disposition_options = {}
  734.     headers = {}
  735.  
  736.     def __init__(self, name, value):
  737.         """Constructor from field name and value."""
  738.         self.name = name
  739.         self.value = value
  740.         # self.file = StringIO(value)
  741.  
  742.     def __repr__(self):
  743.         """Return printable representation."""
  744.         return "MiniFieldStorage(%s, %s)" % (`self.name`, `self.value`)
  745.  
  746.  
  747. class FieldStorage:
  748.  
  749.     """Store a sequence of fields, reading multipart/form-data.
  750.  
  751.     This class provides naming, typing, files stored on disk, and
  752.     more.  At the top level, it is accessible like a dictionary, whose
  753.     keys are the field names.  (Note: None can occur as a field name.)
  754.     The items are either a Python list (if there's multiple values) or
  755.     another FieldStorage or MiniFieldStorage object.  If it's a single
  756.     object, it has the following attributes:
  757.  
  758.     name: the field name, if specified; otherwise None
  759.  
  760.     filename: the filename, if specified; otherwise None; this is the
  761.         client side filename, *not* the file name on which it is
  762.         stored (that's a temporary file you don't deal with)
  763.  
  764.     value: the value as a *string*; for file uploads, this
  765.         transparently reads the file every time you request the value
  766.  
  767.     file: the file(-like) object from which you can read the data;
  768.         None if the data is stored a simple string
  769.  
  770.     type: the content-type, or None if not specified
  771.  
  772.     type_options: dictionary of options specified on the content-type
  773.         line
  774.  
  775.     disposition: content-disposition, or None if not specified
  776.  
  777.     disposition_options: dictionary of corresponding options
  778.  
  779.     headers: a dictionary(-like) object (sometimes rfc822.Message or a
  780.         subclass thereof) containing *all* headers
  781.  
  782.     The class is subclassable, mostly for the purpose of overriding
  783.     the make_file() method, which is called internally to come up with
  784.     a file open for reading and writing.  This makes it possible to
  785.     override the default choice of storing all files in a temporary
  786.     directory and unlinking them as soon as they have been opened.
  787.  
  788.     """
  789.  
  790.     def __init__(self, fp=None, headers=None, outerboundary="",
  791.                  environ=os.environ, keep_blank_values=0, strict_parsing=0):
  792.         """Constructor.  Read multipart/* until last part.
  793.  
  794.         Arguments, all optional:
  795.  
  796.         fp              : file pointer; default: sys.stdin
  797.             (not used when the request method is GET)
  798.  
  799.         headers         : header dictionary-like object; default:
  800.             taken from environ as per CGI spec
  801.  
  802.         outerboundary   : terminating multipart boundary
  803.             (for internal use only)
  804.  
  805.         environ         : environment dictionary; default: os.environ
  806.  
  807.         keep_blank_values: flag indicating whether blank values in
  808.             URL encoded forms should be treated as blank strings.  
  809.             A true value inicates that blanks should be retained as 
  810.             blank strings.  The default false value indicates that
  811.             blank values are to be ignored and treated as if they were
  812.             not included.
  813.  
  814.         strict_parsing: flag indicating what to do with parsing errors.
  815.             If false (the default), errors are silently ignored.
  816.             If true, errors raise a ValueError exception.
  817.  
  818.         """
  819.         method = 'GET'
  820.         self.keep_blank_values = keep_blank_values
  821.         self.strict_parsing = strict_parsing
  822.         if environ.has_key('REQUEST_METHOD'):
  823.             method = string.upper(environ['REQUEST_METHOD'])
  824.         if method == 'GET' or method == 'HEAD':
  825.             if environ.has_key('QUERY_STRING'):
  826.                 qs = environ['QUERY_STRING']
  827.             elif sys.argv[1:]:
  828.                 qs = sys.argv[1]
  829.             else:
  830.                 qs = ""
  831.             fp = StringIO(qs)
  832.             if headers is None:
  833.                 headers = {'content-type':
  834.                            "application/x-www-form-urlencoded"}
  835.         if headers is None:
  836.             headers = {}
  837.             if method == 'POST':
  838.                 # Set default content-type for POST to what's traditional
  839.                 headers['content-type'] = "application/x-www-form-urlencoded"
  840.             if environ.has_key('CONTENT_TYPE'):
  841.                 headers['content-type'] = environ['CONTENT_TYPE']
  842.             if environ.has_key('CONTENT_LENGTH'):
  843.                 headers['content-length'] = environ['CONTENT_LENGTH']
  844.         self.fp = fp or sys.stdin
  845.         self.headers = headers
  846.         self.outerboundary = outerboundary
  847.  
  848.         # Process content-disposition header
  849.         cdisp, pdict = "", {}
  850.         if self.headers.has_key('content-disposition'):
  851.             cdisp, pdict = parse_header(self.headers['content-disposition'])
  852.         self.disposition = cdisp
  853.         self.disposition_options = pdict
  854.         self.name = None
  855.         if pdict.has_key('name'):
  856.             self.name = pdict['name']
  857.         self.filename = None
  858.         if pdict.has_key('filename'):
  859.             self.filename = pdict['filename']
  860.  
  861.         # Process content-type header
  862.         #
  863.         # Honor any existing content-type header.  But if there is no
  864.         # content-type header, use some sensible defaults.  Assume
  865.         # outerboundary is "" at the outer level, but something non-false
  866.         # inside a multi-part.  The default for an inner part is text/plain,
  867.         # but for an outer part it should be urlencoded.  This should catch
  868.         # bogus clients which erroneously forget to include a content-type
  869.         # header.
  870.         #
  871.         # See below for what we do if there does exist a content-type header,
  872.         # but it happens to be something we don't understand.
  873.         if self.headers.has_key('content-type'):
  874.             ctype, pdict = parse_header(self.headers['content-type'])
  875.         elif self.outerboundary or method != 'POST':
  876.             ctype, pdict = "text/plain", {}
  877.         else:
  878.             ctype, pdict = 'application/x-www-form-urlencoded', {}
  879.         self.type = ctype
  880.         self.type_options = pdict
  881.         self.innerboundary = ""
  882.         if pdict.has_key('boundary'):
  883.             self.innerboundary = pdict['boundary']
  884.         clen = -1
  885.         if self.headers.has_key('content-length'):
  886.             try:
  887.                 clen = string.atoi(self.headers['content-length'])
  888.             except:
  889.                 pass
  890.             if maxlen and clen > maxlen:
  891.                 raise ValueError, 'Maximum content length exceeded'
  892.         self.length = clen
  893.  
  894.         self.list = self.file = None
  895.         self.done = 0
  896.         self.lines = []
  897.         if ctype == 'application/x-www-form-urlencoded':
  898.             self.read_urlencoded()
  899.         elif ctype[:10] == 'multipart/':
  900.             self.read_multi(environ, keep_blank_values, strict_parsing)
  901.         else:
  902.             self.read_single()
  903.  
  904.     def __repr__(self):
  905.         """Return a printable representation."""
  906.         return "FieldStorage(%s, %s, %s)" % (
  907.                 `self.name`, `self.filename`, `self.value`)
  908.  
  909.     def __getattr__(self, name):
  910.         if name != 'value':
  911.             raise AttributeError, name
  912.         if self.file:
  913.             self.file.seek(0)
  914.             value = self.file.read()
  915.             self.file.seek(0)
  916.         elif self.list is not None:
  917.             value = self.list
  918.         else:
  919.             value = None
  920.         return value
  921.  
  922.     def __getitem__(self, key):
  923.         """Dictionary style indexing."""
  924.         if self.list is None:
  925.             raise TypeError, "not indexable"
  926.         found = []
  927.         for item in self.list:
  928.             if item.name == key: found.append(item)
  929.         if not found:
  930.             raise KeyError, key
  931.         if len(found) == 1:
  932.             return found[0]
  933.         else:
  934.             return found
  935.  
  936.     def keys(self):
  937.         """Dictionary style keys() method."""
  938.         if self.list is None:
  939.             raise TypeError, "not indexable"
  940.         keys = []
  941.         for item in self.list:
  942.             if item.name not in keys: keys.append(item.name)
  943.         return keys
  944.  
  945.     def has_key(self, key):
  946.         """Dictionary style has_key() method."""
  947.         if self.list is None:
  948.             raise TypeError, "not indexable"
  949.         for item in self.list:
  950.             if item.name == key: return 1
  951.         return 0
  952.  
  953.     def __len__(self):
  954.         """Dictionary style len(x) support."""
  955.         return len(self.keys())
  956.  
  957.     def read_urlencoded(self):
  958.         """Internal: read data in query string format."""
  959.         qs = self.fp.read(self.length)
  960.         self.list = list = []
  961.         for key, value in parse_qsl(qs, self.keep_blank_values,
  962.                                     self.strict_parsing):
  963.             list.append(MiniFieldStorage(key, value))
  964.         self.skip_lines()
  965.  
  966.     FieldStorageClass = None
  967.  
  968.     def read_multi(self, environ, keep_blank_values, strict_parsing):
  969.         """Internal: read a part that is itself multipart."""
  970.         self.list = []
  971.         klass = self.FieldStorageClass or self.__class__
  972.         part = klass(self.fp, {}, self.innerboundary,
  973.                      environ, keep_blank_values, strict_parsing)
  974.         # Throw first part away
  975.         while not part.done:
  976.             headers = rfc822.Message(self.fp)
  977.             part = klass(self.fp, headers, self.innerboundary,
  978.                          environ, keep_blank_values, strict_parsing)
  979.             self.list.append(part)
  980.         self.skip_lines()
  981.  
  982.     def read_single(self):
  983.         """Internal: read an atomic part."""
  984.         if self.length >= 0:
  985.             self.read_binary()
  986.             self.skip_lines()
  987.         else:
  988.             self.read_lines()
  989.         self.file.seek(0)
  990.  
  991.     bufsize = 8*1024            # I/O buffering size for copy to file
  992.  
  993.     def read_binary(self):
  994.         """Internal: read binary data."""
  995.         self.file = self.make_file('b')
  996.         todo = self.length
  997.         if todo >= 0:
  998.             while todo > 0:
  999.                 data = self.fp.read(min(todo, self.bufsize))
  1000.                 if not data:
  1001.                     self.done = -1
  1002.                     break
  1003.                 self.file.write(data)
  1004.                 todo = todo - len(data)
  1005.  
  1006.     def read_lines(self):
  1007.         """Internal: read lines until EOF or outerboundary."""
  1008.         self.file = self.make_file('')
  1009.         if self.outerboundary:
  1010.             self.read_lines_to_outerboundary()
  1011.         else:
  1012.             self.read_lines_to_eof()
  1013.  
  1014.     def read_lines_to_eof(self):
  1015.         """Internal: read lines until EOF."""
  1016.         while 1:
  1017.             line = self.fp.readline()
  1018.             if not line:
  1019.                 self.done = -1
  1020.                 break
  1021.             self.lines.append(line)
  1022.             self.file.write(line)
  1023.  
  1024.     def read_lines_to_outerboundary(self):
  1025.         """Internal: read lines until outerboundary."""
  1026.         next = "--" + self.outerboundary
  1027.         last = next + "--"
  1028.         delim = ""
  1029.         while 1:
  1030.             line = self.fp.readline()
  1031.             if not line:
  1032.                 self.done = -1
  1033.                 break
  1034.             self.lines.append(line)
  1035.             if line[:2] == "--":
  1036.                 strippedline = string.strip(line)
  1037.                 if strippedline == next:
  1038.                     break
  1039.                 if strippedline == last:
  1040.                     self.done = 1
  1041.                     break
  1042.             odelim = delim
  1043.             if line[-2:] == "\r\n":
  1044.                 delim = "\r\n"
  1045.                 line = line[:-2]
  1046.             elif line[-1] == "\n":
  1047.                 delim = "\n"
  1048.                 line = line[:-1]
  1049.             else:
  1050.                 delim = ""
  1051.             self.file.write(odelim + line)
  1052.  
  1053.     def skip_lines(self):
  1054.         """Internal: skip lines until outer boundary if defined."""
  1055.         if not self.outerboundary or self.done:
  1056.             return
  1057.         next = "--" + self.outerboundary
  1058.         last = next + "--"
  1059.         while 1:
  1060.             line = self.fp.readline()
  1061.             if not line:
  1062.                 self.done = -1
  1063.                 break
  1064.             self.lines.append(line)
  1065.             if line[:2] == "--":
  1066.                 strippedline = string.strip(line)
  1067.                 if strippedline == next:
  1068.                     break
  1069.                 if strippedline == last:
  1070.                     self.done = 1
  1071.                     break
  1072.  
  1073.     def make_file(self, binary=None):
  1074.         """Overridable: return a readable & writable file.
  1075.  
  1076.         The file will be used as follows:
  1077.         - data is written to it
  1078.         - seek(0)
  1079.         - data is read from it
  1080.  
  1081.         The 'binary' argument is unused -- the file is always opened
  1082.         in binary mode.
  1083.  
  1084.         This version opens a temporary file for reading and writing,
  1085.         and immediately deletes (unlinks) it.  The trick (on Unix!) is
  1086.         that the file can still be used, but it can't be opened by
  1087.         another process, and it will automatically be deleted when it
  1088.         is closed or when the current process terminates.
  1089.  
  1090.         If you want a more permanent file, you derive a class which
  1091.         overrides this method.  If you want a visible temporary file
  1092.         that is nevertheless automatically deleted when the script
  1093.         terminates, try defining a __del__ method in a derived class
  1094.         which unlinks the temporary files you have created.
  1095.  
  1096.         """
  1097.         import tempfile
  1098.         return tempfile.TemporaryFile("w+b")
  1099.         
  1100.  
  1101.  
  1102. # Backwards Compatibility Classes
  1103. # ===============================
  1104.  
  1105. class FormContentDict:
  1106.     """Basic (multiple values per field) form content as dictionary.
  1107.  
  1108.     form = FormContentDict()
  1109.  
  1110.     form[key] -> [value, value, ...]
  1111.     form.has_key(key) -> Boolean
  1112.     form.keys() -> [key, key, ...]
  1113.     form.values() -> [[val, val, ...], [val, val, ...], ...]
  1114.     form.items() ->  [(key, [val, val, ...]), (key, [val, val, ...]), ...]
  1115.     form.dict == {key: [val, val, ...], ...}
  1116.  
  1117.     """
  1118.     def __init__(self, environ=os.environ):
  1119.         self.dict = parse(environ=environ)
  1120.         self.query_string = environ['QUERY_STRING']
  1121.     def __getitem__(self,key):
  1122.         return self.dict[key]
  1123.     def keys(self):
  1124.         return self.dict.keys()
  1125.     def has_key(self, key):
  1126.         return self.dict.has_key(key)
  1127.     def values(self):
  1128.         return self.dict.values()
  1129.     def items(self):
  1130.         return self.dict.items() 
  1131.     def __len__( self ):
  1132.         return len(self.dict)
  1133.  
  1134.  
  1135. class SvFormContentDict(FormContentDict):
  1136.     """Strict single-value expecting form content as dictionary.
  1137.  
  1138.     IF you only expect a single value for each field, then form[key]
  1139.     will return that single value.  It will raise an IndexError if
  1140.     that expectation is not true.  IF you expect a field to have
  1141.     possible multiple values, than you can use form.getlist(key) to
  1142.     get all of the values.  values() and items() are a compromise:
  1143.     they return single strings where there is a single value, and
  1144.     lists of strings otherwise.
  1145.  
  1146.     """
  1147.     def __getitem__(self, key):
  1148.         if len(self.dict[key]) > 1: 
  1149.             raise IndexError, 'expecting a single value' 
  1150.         return self.dict[key][0]
  1151.     def getlist(self, key):
  1152.         return self.dict[key]
  1153.     def values(self):
  1154.         lis = []
  1155.         for each in self.dict.values(): 
  1156.             if len( each ) == 1 : 
  1157.                 lis.append(each[0])
  1158.             else: lis.append(each)
  1159.         return lis
  1160.     def items(self):
  1161.         lis = []
  1162.         for key,value in self.dict.items():
  1163.             if len(value) == 1 :
  1164.                 lis.append((key, value[0]))
  1165.             else:       lis.append((key, value))
  1166.         return lis
  1167.  
  1168.  
  1169. class InterpFormContentDict(SvFormContentDict):
  1170.     """This class is present for backwards compatibility only.""" 
  1171.     def __getitem__( self, key ):
  1172.         v = SvFormContentDict.__getitem__( self, key )
  1173.         if v[0] in string.digits+'+-.' : 
  1174.             try:  return  string.atoi( v ) 
  1175.             except ValueError:
  1176.                 try:    return string.atof( v )
  1177.                 except ValueError: pass
  1178.         return string.strip(v)
  1179.     def values( self ):
  1180.         lis = [] 
  1181.         for key in self.keys():
  1182.             try:
  1183.                 lis.append( self[key] )
  1184.             except IndexError:
  1185.                 lis.append( self.dict[key] )
  1186.         return lis
  1187.     def items( self ):
  1188.         lis = [] 
  1189.         for key in self.keys():
  1190.             try:
  1191.                 lis.append( (key, self[key]) )
  1192.             except IndexError:
  1193.                 lis.append( (key, self.dict[key]) )
  1194.         return lis
  1195.  
  1196.  
  1197. class FormContent(FormContentDict):
  1198.     """This class is present for backwards compatibility only.""" 
  1199.     def values(self, key):
  1200.         if self.dict.has_key(key) :return self.dict[key]
  1201.         else: return None
  1202.     def indexed_value(self, key, location):
  1203.         if self.dict.has_key(key):
  1204.             if len (self.dict[key]) > location:
  1205.                 return self.dict[key][location]
  1206.             else: return None
  1207.         else: return None
  1208.     def value(self, key):
  1209.         if self.dict.has_key(key): return self.dict[key][0]
  1210.         else: return None
  1211.     def length(self, key):
  1212.         return len(self.dict[key])
  1213.     def stripped(self, key):
  1214.         if self.dict.has_key(key): return string.strip(self.dict[key][0])
  1215.         else: return None
  1216.     def pars(self):
  1217.         return self.dict
  1218.  
  1219.  
  1220. # Test/debug code
  1221. # ===============
  1222.  
  1223. def test(environ=os.environ):
  1224.     """Robust test CGI script, usable as main program.
  1225.  
  1226.     Write minimal HTTP headers and dump all information provided to
  1227.     the script in HTML form.
  1228.  
  1229.     """
  1230.     import traceback
  1231.     print "Content-type: text/html"
  1232.     print
  1233.     sys.stderr = sys.stdout
  1234.     try:
  1235.         form = FieldStorage()   # Replace with other classes to test those
  1236.         print_form(form)
  1237.         print_environ(environ)
  1238.         print_directory()
  1239.         print_arguments()
  1240.         print_environ_usage()
  1241.         def f():
  1242.             exec "testing print_exception() -- <I>italics?</I>"
  1243.         def g(f=f):
  1244.             f()
  1245.         print "<H3>What follows is a test, not an actual exception:</H3>"
  1246.         g()
  1247.     except:
  1248.         print_exception()
  1249.  
  1250.     # Second try with a small maxlen...
  1251.     global maxlen
  1252.     maxlen = 50
  1253.     try:
  1254.         form = FieldStorage()   # Replace with other classes to test those
  1255.         print_form(form)
  1256.         print_environ(environ)
  1257.         print_directory()
  1258.         print_arguments()
  1259.         print_environ_usage()
  1260.     except:
  1261.         print_exception()
  1262.  
  1263. def print_exception(type=None, value=None, tb=None, limit=None):
  1264.     if type is None:
  1265.         type, value, tb = sys.exc_info()
  1266.     import traceback
  1267.     print
  1268.     print "<H3>Traceback (innermost last):</H3>"
  1269.     list = traceback.format_tb(tb, limit) + \
  1270.            traceback.format_exception_only(type, value)
  1271.     print "<PRE>%s<B>%s</B></PRE>" % (
  1272.         escape(string.join(list[:-1], "")),
  1273.         escape(list[-1]),
  1274.         )
  1275.     del tb
  1276.  
  1277. def print_environ(environ=os.environ):
  1278.     """Dump the shell environment as HTML."""
  1279.     keys = environ.keys()
  1280.     keys.sort()
  1281.     print
  1282.     print "<H3>Shell Environment:</H3>"
  1283.     print "<DL>"
  1284.     for key in keys:
  1285.         print "<DT>", escape(key), "<DD>", escape(environ[key])
  1286.     print "</DL>" 
  1287.     print
  1288.  
  1289. def print_form(form):
  1290.     """Dump the contents of a form as HTML."""
  1291.     keys = form.keys()
  1292.     keys.sort()
  1293.     print
  1294.     print "<H3>Form Contents:</H3>"
  1295.     print "<DL>"
  1296.     for key in keys:
  1297.         print "<DT>" + escape(key) + ":",
  1298.         value = form[key]
  1299.         print "<i>" + escape(`type(value)`) + "</i>"
  1300.         print "<DD>" + escape(`value`)
  1301.     print "</DL>"
  1302.     print
  1303.  
  1304. def print_directory():
  1305.     """Dump the current directory as HTML."""
  1306.     print
  1307.     print "<H3>Current Working Directory:</H3>"
  1308.     try:
  1309.         pwd = os.getcwd()
  1310.     except os.error, msg:
  1311.         print "os.error:", escape(str(msg))
  1312.     else:
  1313.         print escape(pwd)
  1314.     print
  1315.  
  1316. def print_arguments():
  1317.     print
  1318.     print "<H3>Command Line Arguments:</H3>"
  1319.     print
  1320.     print sys.argv
  1321.     print
  1322.  
  1323. def print_environ_usage():
  1324.     """Dump a list of environment variables used by CGI as HTML."""
  1325.     print """
  1326. <H3>These environment variables could have been set:</H3>
  1327. <UL>
  1328. <LI>AUTH_TYPE
  1329. <LI>CONTENT_LENGTH
  1330. <LI>CONTENT_TYPE
  1331. <LI>DATE_GMT
  1332. <LI>DATE_LOCAL
  1333. <LI>DOCUMENT_NAME
  1334. <LI>DOCUMENT_ROOT
  1335. <LI>DOCUMENT_URI
  1336. <LI>GATEWAY_INTERFACE
  1337. <LI>LAST_MODIFIED
  1338. <LI>PATH
  1339. <LI>PATH_INFO
  1340. <LI>PATH_TRANSLATED
  1341. <LI>QUERY_STRING
  1342. <LI>REMOTE_ADDR
  1343. <LI>REMOTE_HOST
  1344. <LI>REMOTE_IDENT
  1345. <LI>REMOTE_USER
  1346. <LI>REQUEST_METHOD
  1347. <LI>SCRIPT_NAME
  1348. <LI>SERVER_NAME
  1349. <LI>SERVER_PORT
  1350. <LI>SERVER_PROTOCOL
  1351. <LI>SERVER_ROOT
  1352. <LI>SERVER_SOFTWARE
  1353. </UL>
  1354. In addition, HTTP headers sent by the server may be passed in the
  1355. environment as well.  Here are some common variable names:
  1356. <UL>
  1357. <LI>HTTP_ACCEPT
  1358. <LI>HTTP_CONNECTION
  1359. <LI>HTTP_HOST
  1360. <LI>HTTP_PRAGMA
  1361. <LI>HTTP_REFERER
  1362. <LI>HTTP_USER_AGENT
  1363. </UL>
  1364. """
  1365.  
  1366.  
  1367. # Utilities
  1368. # =========
  1369.  
  1370. def escape(s, quote=None):
  1371.     """Replace special characters '&', '<' and '>' by SGML entities."""
  1372.     s = string.replace(s, "&", "&") # Must be done first!
  1373.     s = string.replace(s, "<", "<")
  1374.     s = string.replace(s, ">", ">",)
  1375.     if quote:
  1376.         s = string.replace(s, '"', """)
  1377.     return s
  1378.  
  1379.  
  1380. # Invoke mainline
  1381. # ===============
  1382.  
  1383. # Call test() when this file is run as a script (not imported as a module)
  1384. if __name__ == '__main__': 
  1385.     test()
  1386.