cgi.py
上传用户:gyjinxi
上传日期:2007-01-04
资源大小:159k
文件大小:47k
源码类别:

WEB邮件程序

开发平台:

Python

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