Guido van Rossum | 5191463 | 2000-10-03 13:51:09 +0000 | [diff] [blame] | 1 | #! /usr/local/bin/python |
Guido van Rossum | 1c9daa8 | 1995-09-18 21:52:37 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 467d723 | 2001-02-13 13:13:33 +0000 | [diff] [blame] | 3 | # NOTE: the above "/usr/local/bin/python" is NOT a mistake. It is |
| 4 | # intentionally NOT "/usr/bin/env python". On many systems |
| 5 | # (e.g. Solaris), /usr/local/bin is not in $PATH as passed to CGI |
| 6 | # scripts, and /usr/local/bin is the default directory where Python is |
| 7 | # installed, so /usr/bin/env would be unable to find python. Granted, |
| 8 | # binary installations by Linux vendors often install Python in |
| 9 | # /usr/bin. So let those vendors patch cgi.py to match their choice |
| 10 | # of installation. |
| 11 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 12 | """Support module for CGI (Common Gateway Interface) scripts. |
Guido van Rossum | 1c9daa8 | 1995-09-18 21:52:37 +0000 | [diff] [blame] | 13 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 14 | This module defines a number of utilities for use by CGI scripts |
| 15 | written in Python. |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 16 | """ |
| 17 | |
Jeremy Hylton | c253d9a | 2000-08-03 20:57:44 +0000 | [diff] [blame] | 18 | # XXX Perhaps there should be a slimmed version that doesn't contain |
| 19 | # all those backwards compatible and debugging classes and functions? |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 20 | |
| 21 | # History |
| 22 | # ------- |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 23 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 24 | # Michael McLay started this module. Steve Majewski changed the |
| 25 | # interface to SvFormContentDict and FormContentDict. The multipart |
| 26 | # parsing was inspired by code submitted by Andreas Paepcke. Guido van |
| 27 | # Rossum rewrote, reformatted and documented the module and is currently |
| 28 | # responsible for its maintenance. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 29 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 30 | |
Barry Warsaw | 7fed217 | 2000-11-06 18:46:09 +0000 | [diff] [blame] | 31 | __version__ = "2.5" |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 32 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 33 | |
| 34 | # Imports |
| 35 | # ======= |
| 36 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 37 | import sys |
| 38 | import os |
Guido van Rossum | a5e9fb6 | 1997-08-12 18:18:13 +0000 | [diff] [blame] | 39 | import urllib |
Guido van Rossum | a5e9fb6 | 1997-08-12 18:18:13 +0000 | [diff] [blame] | 40 | import mimetools |
| 41 | import rfc822 |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 42 | import UserDict |
Guido van Rossum | a5e9fb6 | 1997-08-12 18:18:13 +0000 | [diff] [blame] | 43 | from StringIO import StringIO |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 44 | |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 45 | __all__ = ["MiniFieldStorage","FieldStorage","FormContentDict", |
| 46 | "SvFormContentDict","InterpFormContentDict","FormContent"] |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 47 | |
| 48 | # Logging support |
| 49 | # =============== |
| 50 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 51 | logfile = "" # Filename to log to, if not empty |
| 52 | logfp = None # File object to log to, if not None |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 53 | |
| 54 | def initlog(*allargs): |
| 55 | """Write a log message, if there is a log file. |
| 56 | |
| 57 | Even though this function is called initlog(), you should always |
| 58 | use log(); log is a variable that is set either to initlog |
| 59 | (initially), to dolog (once the log file has been opened), or to |
| 60 | nolog (when logging is disabled). |
| 61 | |
| 62 | The first argument is a format string; the remaining arguments (if |
| 63 | any) are arguments to the % operator, so e.g. |
| 64 | log("%s: %s", "a", "b") |
| 65 | will write "a: b" to the log file, followed by a newline. |
| 66 | |
| 67 | If the global logfp is not None, it should be a file object to |
| 68 | which log data is written. |
| 69 | |
| 70 | If the global logfp is None, the global logfile may be a string |
| 71 | giving a filename to open, in append mode. This file should be |
| 72 | world writable!!! If the file can't be opened, logging is |
| 73 | silently disabled (since there is no safe place where we could |
| 74 | send an error message). |
| 75 | |
| 76 | """ |
| 77 | global logfp, log |
| 78 | if logfile and not logfp: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 79 | try: |
| 80 | logfp = open(logfile, "a") |
| 81 | except IOError: |
| 82 | pass |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 83 | if not logfp: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 84 | log = nolog |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 85 | else: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 86 | log = dolog |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 87 | apply(log, allargs) |
| 88 | |
| 89 | def dolog(fmt, *args): |
| 90 | """Write a log message to the log file. See initlog() for docs.""" |
| 91 | logfp.write(fmt%args + "\n") |
| 92 | |
| 93 | def nolog(*allargs): |
| 94 | """Dummy function, assigned to log when logging is disabled.""" |
| 95 | pass |
| 96 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 97 | log = initlog # The current logging function |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 98 | |
| 99 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 100 | # Parsing functions |
| 101 | # ================= |
| 102 | |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 103 | # Maximum input we will accept when REQUEST_METHOD is POST |
| 104 | # 0 ==> unlimited input |
| 105 | maxlen = 0 |
| 106 | |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 107 | def parse(fp=None, environ=os.environ, keep_blank_values=0, strict_parsing=0): |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 108 | """Parse a query in the environment or from a file (default stdin) |
| 109 | |
| 110 | Arguments, all optional: |
| 111 | |
| 112 | fp : file pointer; default: sys.stdin |
| 113 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 114 | environ : environment dictionary; default: os.environ |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 115 | |
| 116 | keep_blank_values: flag indicating whether blank values in |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 117 | URL encoded forms should be treated as blank strings. |
| 118 | A true value indicates that blanks should be retained as |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 119 | blank strings. The default false value indicates that |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 120 | blank values are to be ignored and treated as if they were |
| 121 | not included. |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 122 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 123 | strict_parsing: flag indicating what to do with parsing errors. |
| 124 | If false (the default), errors are silently ignored. |
| 125 | If true, errors raise a ValueError exception. |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 126 | """ |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 127 | if not fp: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 128 | fp = sys.stdin |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 129 | if not environ.has_key('REQUEST_METHOD'): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 130 | environ['REQUEST_METHOD'] = 'GET' # For testing stand-alone |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 131 | if environ['REQUEST_METHOD'] == 'POST': |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 132 | ctype, pdict = parse_header(environ['CONTENT_TYPE']) |
| 133 | if ctype == 'multipart/form-data': |
| 134 | return parse_multipart(fp, pdict) |
| 135 | elif ctype == 'application/x-www-form-urlencoded': |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 136 | clength = int(environ['CONTENT_LENGTH']) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 137 | if maxlen and clength > maxlen: |
| 138 | raise ValueError, 'Maximum content length exceeded' |
| 139 | qs = fp.read(clength) |
| 140 | else: |
| 141 | qs = '' # Unknown content-type |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 142 | if environ.has_key('QUERY_STRING'): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 143 | if qs: qs = qs + '&' |
| 144 | qs = qs + environ['QUERY_STRING'] |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 145 | elif sys.argv[1:]: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 146 | if qs: qs = qs + '&' |
| 147 | qs = qs + sys.argv[1] |
| 148 | environ['QUERY_STRING'] = qs # XXX Shouldn't, really |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 149 | elif environ.has_key('QUERY_STRING'): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 150 | qs = environ['QUERY_STRING'] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 151 | else: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 152 | if sys.argv[1:]: |
| 153 | qs = sys.argv[1] |
| 154 | else: |
| 155 | qs = "" |
| 156 | environ['QUERY_STRING'] = qs # XXX Shouldn't, really |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 157 | return parse_qs(qs, keep_blank_values, strict_parsing) |
Guido van Rossum | e780877 | 1995-08-07 20:12:09 +0000 | [diff] [blame] | 158 | |
| 159 | |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 160 | def parse_qs(qs, keep_blank_values=0, strict_parsing=0): |
| 161 | """Parse a query given as a string argument. |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 162 | |
| 163 | Arguments: |
| 164 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 165 | qs: URL-encoded query string to be parsed |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 166 | |
| 167 | keep_blank_values: flag indicating whether blank values in |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 168 | URL encoded queries should be treated as blank strings. |
| 169 | A true value indicates that blanks should be retained as |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 170 | blank strings. The default false value indicates that |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 171 | blank values are to be ignored and treated as if they were |
| 172 | not included. |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 173 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 174 | strict_parsing: flag indicating what to do with parsing errors. |
| 175 | If false (the default), errors are silently ignored. |
| 176 | If true, errors raise a ValueError exception. |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 177 | """ |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 178 | dict = {} |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 179 | for name, value in parse_qsl(qs, keep_blank_values, strict_parsing): |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 180 | if dict.has_key(name): |
| 181 | dict[name].append(value) |
| 182 | else: |
| 183 | dict[name] = [value] |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 184 | return dict |
| 185 | |
| 186 | def parse_qsl(qs, keep_blank_values=0, strict_parsing=0): |
| 187 | """Parse a query given as a string argument. |
| 188 | |
Jeremy Hylton | afde7e2 | 2000-09-15 20:06:57 +0000 | [diff] [blame] | 189 | Arguments: |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 190 | |
Jeremy Hylton | afde7e2 | 2000-09-15 20:06:57 +0000 | [diff] [blame] | 191 | qs: URL-encoded query string to be parsed |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 192 | |
Jeremy Hylton | afde7e2 | 2000-09-15 20:06:57 +0000 | [diff] [blame] | 193 | keep_blank_values: flag indicating whether blank values in |
| 194 | URL encoded queries should be treated as blank strings. A |
| 195 | true value indicates that blanks should be retained as blank |
| 196 | strings. The default false value indicates that blank values |
| 197 | are to be ignored and treated as if they were not included. |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 198 | |
Jeremy Hylton | afde7e2 | 2000-09-15 20:06:57 +0000 | [diff] [blame] | 199 | strict_parsing: flag indicating what to do with parsing errors. If |
| 200 | false (the default), errors are silently ignored. If true, |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 201 | errors raise a ValueError exception. |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 202 | |
Jeremy Hylton | afde7e2 | 2000-09-15 20:06:57 +0000 | [diff] [blame] | 203 | Returns a list, as G-d intended. |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 204 | """ |
Jeremy Hylton | afde7e2 | 2000-09-15 20:06:57 +0000 | [diff] [blame] | 205 | pairs = [s2 for s1 in qs.split('&') for s2 in s1.split(';')] |
| 206 | r = [] |
| 207 | for name_value in pairs: |
| 208 | nv = name_value.split('=', 1) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 209 | if len(nv) != 2: |
| 210 | if strict_parsing: |
| 211 | raise ValueError, "bad query field: %s" % `name_value` |
| 212 | continue |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 213 | if len(nv[1]) or keep_blank_values: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 214 | name = urllib.unquote(nv[0].replace('+', ' ')) |
| 215 | value = urllib.unquote(nv[1].replace('+', ' ')) |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 216 | r.append((name, value)) |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 217 | |
| 218 | return r |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 219 | |
| 220 | |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 221 | def parse_multipart(fp, pdict): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 222 | """Parse multipart input. |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 223 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 224 | Arguments: |
| 225 | fp : input file |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 226 | pdict: dictionary containing other parameters of conten-type header |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 227 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 228 | Returns a dictionary just like parse_qs(): keys are the field names, each |
| 229 | value is a list of values for that field. This is easy to use but not |
| 230 | much good if you are expecting megabytes to be uploaded -- in that case, |
| 231 | use the FieldStorage class instead which is much more flexible. Note |
| 232 | that content-type is the raw, unparsed contents of the content-type |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 233 | header. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 234 | |
| 235 | XXX This does not parse nested multipart parts -- use FieldStorage for |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 236 | that. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 237 | |
| 238 | XXX This should really be subsumed by FieldStorage altogether -- no |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 239 | point in having two implementations of the same parsing algorithm. |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 240 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 241 | """ |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 242 | if pdict.has_key('boundary'): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 243 | boundary = pdict['boundary'] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 244 | else: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 245 | boundary = "" |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 246 | nextpart = "--" + boundary |
| 247 | lastpart = "--" + boundary + "--" |
| 248 | partdict = {} |
| 249 | terminator = "" |
| 250 | |
| 251 | while terminator != lastpart: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 252 | bytes = -1 |
| 253 | data = None |
| 254 | if terminator: |
| 255 | # At start of next part. Read headers first. |
| 256 | headers = mimetools.Message(fp) |
| 257 | clength = headers.getheader('content-length') |
| 258 | if clength: |
| 259 | try: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 260 | bytes = int(clength) |
| 261 | except ValueError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 262 | pass |
| 263 | if bytes > 0: |
| 264 | if maxlen and bytes > maxlen: |
| 265 | raise ValueError, 'Maximum content length exceeded' |
| 266 | data = fp.read(bytes) |
| 267 | else: |
| 268 | data = "" |
| 269 | # Read lines until end of part. |
| 270 | lines = [] |
| 271 | while 1: |
| 272 | line = fp.readline() |
| 273 | if not line: |
| 274 | terminator = lastpart # End outer loop |
| 275 | break |
| 276 | if line[:2] == "--": |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 277 | terminator = line.strip() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 278 | if terminator in (nextpart, lastpart): |
| 279 | break |
| 280 | lines.append(line) |
| 281 | # Done with part. |
| 282 | if data is None: |
| 283 | continue |
| 284 | if bytes < 0: |
| 285 | if lines: |
| 286 | # Strip final line terminator |
| 287 | line = lines[-1] |
| 288 | if line[-2:] == "\r\n": |
| 289 | line = line[:-2] |
| 290 | elif line[-1:] == "\n": |
| 291 | line = line[:-1] |
| 292 | lines[-1] = line |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 293 | data = "".join(lines) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 294 | line = headers['content-disposition'] |
| 295 | if not line: |
| 296 | continue |
| 297 | key, params = parse_header(line) |
| 298 | if key != 'form-data': |
| 299 | continue |
| 300 | if params.has_key('name'): |
| 301 | name = params['name'] |
| 302 | else: |
| 303 | continue |
| 304 | if partdict.has_key(name): |
| 305 | partdict[name].append(data) |
| 306 | else: |
| 307 | partdict[name] = [data] |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 308 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 309 | return partdict |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 310 | |
| 311 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 312 | def parse_header(line): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 313 | """Parse a Content-type like header. |
| 314 | |
| 315 | Return the main content-type and a dictionary of options. |
| 316 | |
| 317 | """ |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 318 | plist = map(lambda x: x.strip(), line.split(';')) |
| 319 | key = plist[0].lower() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 320 | del plist[0] |
| 321 | pdict = {} |
| 322 | for p in plist: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 323 | i = p.find('=') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 324 | if i >= 0: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 325 | name = p[:i].strip().lower() |
| 326 | value = p[i+1:].strip() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 327 | if len(value) >= 2 and value[0] == value[-1] == '"': |
| 328 | value = value[1:-1] |
| 329 | pdict[name] = value |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 330 | return key, pdict |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 331 | |
| 332 | |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 333 | # Classes for field storage |
| 334 | # ========================= |
| 335 | |
| 336 | class MiniFieldStorage: |
| 337 | |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 338 | """Like FieldStorage, for use when no file uploads are possible.""" |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 339 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 340 | # Dummy attributes |
| 341 | filename = None |
| 342 | list = None |
| 343 | type = None |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 344 | file = None |
Guido van Rossum | 4032c2c | 1996-03-09 04:04:35 +0000 | [diff] [blame] | 345 | type_options = {} |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 346 | disposition = None |
| 347 | disposition_options = {} |
| 348 | headers = {} |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 349 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 350 | def __init__(self, name, value): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 351 | """Constructor from field name and value.""" |
| 352 | self.name = name |
| 353 | self.value = value |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 354 | # self.file = StringIO(value) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 355 | |
| 356 | def __repr__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 357 | """Return printable representation.""" |
| 358 | return "MiniFieldStorage(%s, %s)" % (`self.name`, `self.value`) |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 359 | |
| 360 | |
| 361 | class FieldStorage: |
| 362 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 363 | """Store a sequence of fields, reading multipart/form-data. |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 364 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 365 | This class provides naming, typing, files stored on disk, and |
| 366 | more. At the top level, it is accessible like a dictionary, whose |
| 367 | keys are the field names. (Note: None can occur as a field name.) |
| 368 | The items are either a Python list (if there's multiple values) or |
| 369 | another FieldStorage or MiniFieldStorage object. If it's a single |
| 370 | object, it has the following attributes: |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 371 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 372 | name: the field name, if specified; otherwise None |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 373 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 374 | filename: the filename, if specified; otherwise None; this is the |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 375 | client side filename, *not* the file name on which it is |
| 376 | stored (that's a temporary file you don't deal with) |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 377 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 378 | value: the value as a *string*; for file uploads, this |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 379 | transparently reads the file every time you request the value |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 380 | |
| 381 | file: the file(-like) object from which you can read the data; |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 382 | None if the data is stored a simple string |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 383 | |
| 384 | type: the content-type, or None if not specified |
| 385 | |
| 386 | type_options: dictionary of options specified on the content-type |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 387 | line |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 388 | |
| 389 | disposition: content-disposition, or None if not specified |
| 390 | |
| 391 | disposition_options: dictionary of corresponding options |
| 392 | |
| 393 | headers: a dictionary(-like) object (sometimes rfc822.Message or a |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 394 | subclass thereof) containing *all* headers |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 395 | |
| 396 | The class is subclassable, mostly for the purpose of overriding |
| 397 | the make_file() method, which is called internally to come up with |
| 398 | a file open for reading and writing. This makes it possible to |
| 399 | override the default choice of storing all files in a temporary |
| 400 | directory and unlinking them as soon as they have been opened. |
| 401 | |
| 402 | """ |
| 403 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 404 | def __init__(self, fp=None, headers=None, outerboundary="", |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 405 | environ=os.environ, keep_blank_values=0, strict_parsing=0): |
| 406 | """Constructor. Read multipart/* until last part. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 407 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 408 | Arguments, all optional: |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 409 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 410 | fp : file pointer; default: sys.stdin |
Guido van Rossum | b1b4f94 | 1998-05-08 19:55:51 +0000 | [diff] [blame] | 411 | (not used when the request method is GET) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 412 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 413 | headers : header dictionary-like object; default: |
| 414 | taken from environ as per CGI spec |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 415 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 416 | outerboundary : terminating multipart boundary |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 417 | (for internal use only) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 418 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 419 | environ : environment dictionary; default: os.environ |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 420 | |
| 421 | keep_blank_values: flag indicating whether blank values in |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 422 | URL encoded forms should be treated as blank strings. |
| 423 | A true value indicates that blanks should be retained as |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 424 | blank strings. The default false value indicates that |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 425 | blank values are to be ignored and treated as if they were |
| 426 | not included. |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 427 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 428 | strict_parsing: flag indicating what to do with parsing errors. |
| 429 | If false (the default), errors are silently ignored. |
| 430 | If true, errors raise a ValueError exception. |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 431 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 432 | """ |
| 433 | method = 'GET' |
| 434 | self.keep_blank_values = keep_blank_values |
| 435 | self.strict_parsing = strict_parsing |
| 436 | if environ.has_key('REQUEST_METHOD'): |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 437 | method = environ['REQUEST_METHOD'].upper() |
Guido van Rossum | 0185283 | 1998-06-25 02:40:17 +0000 | [diff] [blame] | 438 | if method == 'GET' or method == 'HEAD': |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 439 | if environ.has_key('QUERY_STRING'): |
| 440 | qs = environ['QUERY_STRING'] |
| 441 | elif sys.argv[1:]: |
| 442 | qs = sys.argv[1] |
| 443 | else: |
| 444 | qs = "" |
| 445 | fp = StringIO(qs) |
| 446 | if headers is None: |
| 447 | headers = {'content-type': |
| 448 | "application/x-www-form-urlencoded"} |
| 449 | if headers is None: |
Guido van Rossum | cff311a | 1998-06-11 14:06:59 +0000 | [diff] [blame] | 450 | headers = {} |
| 451 | if method == 'POST': |
| 452 | # Set default content-type for POST to what's traditional |
| 453 | headers['content-type'] = "application/x-www-form-urlencoded" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 454 | if environ.has_key('CONTENT_TYPE'): |
| 455 | headers['content-type'] = environ['CONTENT_TYPE'] |
| 456 | if environ.has_key('CONTENT_LENGTH'): |
| 457 | headers['content-length'] = environ['CONTENT_LENGTH'] |
| 458 | self.fp = fp or sys.stdin |
| 459 | self.headers = headers |
| 460 | self.outerboundary = outerboundary |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 461 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 462 | # Process content-disposition header |
| 463 | cdisp, pdict = "", {} |
| 464 | if self.headers.has_key('content-disposition'): |
| 465 | cdisp, pdict = parse_header(self.headers['content-disposition']) |
| 466 | self.disposition = cdisp |
| 467 | self.disposition_options = pdict |
| 468 | self.name = None |
| 469 | if pdict.has_key('name'): |
| 470 | self.name = pdict['name'] |
| 471 | self.filename = None |
| 472 | if pdict.has_key('filename'): |
| 473 | self.filename = pdict['filename'] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 474 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 475 | # Process content-type header |
Barry Warsaw | 302331a | 1999-01-08 17:42:03 +0000 | [diff] [blame] | 476 | # |
| 477 | # Honor any existing content-type header. But if there is no |
| 478 | # content-type header, use some sensible defaults. Assume |
| 479 | # outerboundary is "" at the outer level, but something non-false |
| 480 | # inside a multi-part. The default for an inner part is text/plain, |
| 481 | # but for an outer part it should be urlencoded. This should catch |
| 482 | # bogus clients which erroneously forget to include a content-type |
| 483 | # header. |
| 484 | # |
| 485 | # See below for what we do if there does exist a content-type header, |
| 486 | # but it happens to be something we don't understand. |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 487 | if self.headers.has_key('content-type'): |
| 488 | ctype, pdict = parse_header(self.headers['content-type']) |
Guido van Rossum | ce900de | 1999-06-02 18:44:22 +0000 | [diff] [blame] | 489 | elif self.outerboundary or method != 'POST': |
Barry Warsaw | 302331a | 1999-01-08 17:42:03 +0000 | [diff] [blame] | 490 | ctype, pdict = "text/plain", {} |
| 491 | else: |
| 492 | ctype, pdict = 'application/x-www-form-urlencoded', {} |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 493 | self.type = ctype |
| 494 | self.type_options = pdict |
| 495 | self.innerboundary = "" |
| 496 | if pdict.has_key('boundary'): |
| 497 | self.innerboundary = pdict['boundary'] |
| 498 | clen = -1 |
| 499 | if self.headers.has_key('content-length'): |
| 500 | try: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 501 | clen = int(self.headers['content-length']) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 502 | except: |
| 503 | pass |
| 504 | if maxlen and clen > maxlen: |
| 505 | raise ValueError, 'Maximum content length exceeded' |
| 506 | self.length = clen |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 507 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 508 | self.list = self.file = None |
| 509 | self.done = 0 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 510 | if ctype == 'application/x-www-form-urlencoded': |
| 511 | self.read_urlencoded() |
| 512 | elif ctype[:10] == 'multipart/': |
Guido van Rossum | f574500 | 1998-10-20 14:43:02 +0000 | [diff] [blame] | 513 | self.read_multi(environ, keep_blank_values, strict_parsing) |
Barry Warsaw | 302331a | 1999-01-08 17:42:03 +0000 | [diff] [blame] | 514 | else: |
Guido van Rossum | 60a3bd8 | 1999-06-11 18:26:09 +0000 | [diff] [blame] | 515 | self.read_single() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 516 | |
| 517 | def __repr__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 518 | """Return a printable representation.""" |
| 519 | return "FieldStorage(%s, %s, %s)" % ( |
| 520 | `self.name`, `self.filename`, `self.value`) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 521 | |
| 522 | def __getattr__(self, name): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 523 | if name != 'value': |
| 524 | raise AttributeError, name |
| 525 | if self.file: |
| 526 | self.file.seek(0) |
| 527 | value = self.file.read() |
| 528 | self.file.seek(0) |
| 529 | elif self.list is not None: |
| 530 | value = self.list |
| 531 | else: |
| 532 | value = None |
| 533 | return value |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 534 | |
| 535 | def __getitem__(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 536 | """Dictionary style indexing.""" |
| 537 | if self.list is None: |
| 538 | raise TypeError, "not indexable" |
| 539 | found = [] |
| 540 | for item in self.list: |
| 541 | if item.name == key: found.append(item) |
| 542 | if not found: |
| 543 | raise KeyError, key |
| 544 | if len(found) == 1: |
| 545 | return found[0] |
| 546 | else: |
| 547 | return found |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 548 | |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 549 | def getvalue(self, key, default=None): |
| 550 | """Dictionary style get() method, including 'value' lookup.""" |
| 551 | if self.has_key(key): |
| 552 | value = self[key] |
| 553 | if type(value) is type([]): |
| 554 | return map(lambda v: v.value, value) |
| 555 | else: |
| 556 | return value.value |
| 557 | else: |
| 558 | return default |
| 559 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 560 | def keys(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 561 | """Dictionary style keys() method.""" |
| 562 | if self.list is None: |
| 563 | raise TypeError, "not indexable" |
| 564 | keys = [] |
| 565 | for item in self.list: |
| 566 | if item.name not in keys: keys.append(item.name) |
| 567 | return keys |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 568 | |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 569 | def has_key(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 570 | """Dictionary style has_key() method.""" |
| 571 | if self.list is None: |
| 572 | raise TypeError, "not indexable" |
| 573 | for item in self.list: |
| 574 | if item.name == key: return 1 |
| 575 | return 0 |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 576 | |
Guido van Rossum | 88b85d4 | 1997-01-11 19:21:33 +0000 | [diff] [blame] | 577 | def __len__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 578 | """Dictionary style len(x) support.""" |
| 579 | return len(self.keys()) |
Guido van Rossum | 88b85d4 | 1997-01-11 19:21:33 +0000 | [diff] [blame] | 580 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 581 | def read_urlencoded(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 582 | """Internal: read data in query string format.""" |
| 583 | qs = self.fp.read(self.length) |
Guido van Rossum | 1946f0d | 1999-06-04 17:54:39 +0000 | [diff] [blame] | 584 | self.list = list = [] |
| 585 | for key, value in parse_qsl(qs, self.keep_blank_values, |
| 586 | self.strict_parsing): |
| 587 | list.append(MiniFieldStorage(key, value)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 588 | self.skip_lines() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 589 | |
Guido van Rossum | 030d2ec | 1998-12-09 22:16:46 +0000 | [diff] [blame] | 590 | FieldStorageClass = None |
| 591 | |
Guido van Rossum | f574500 | 1998-10-20 14:43:02 +0000 | [diff] [blame] | 592 | def read_multi(self, environ, keep_blank_values, strict_parsing): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 593 | """Internal: read a part that is itself multipart.""" |
| 594 | self.list = [] |
Guido van Rossum | 030d2ec | 1998-12-09 22:16:46 +0000 | [diff] [blame] | 595 | klass = self.FieldStorageClass or self.__class__ |
| 596 | part = klass(self.fp, {}, self.innerboundary, |
| 597 | environ, keep_blank_values, strict_parsing) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 598 | # Throw first part away |
| 599 | while not part.done: |
| 600 | headers = rfc822.Message(self.fp) |
Guido van Rossum | 030d2ec | 1998-12-09 22:16:46 +0000 | [diff] [blame] | 601 | part = klass(self.fp, headers, self.innerboundary, |
| 602 | environ, keep_blank_values, strict_parsing) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 603 | self.list.append(part) |
| 604 | self.skip_lines() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 605 | |
| 606 | def read_single(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 607 | """Internal: read an atomic part.""" |
| 608 | if self.length >= 0: |
| 609 | self.read_binary() |
| 610 | self.skip_lines() |
| 611 | else: |
| 612 | self.read_lines() |
| 613 | self.file.seek(0) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 614 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 615 | bufsize = 8*1024 # I/O buffering size for copy to file |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 616 | |
| 617 | def read_binary(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 618 | """Internal: read binary data.""" |
| 619 | self.file = self.make_file('b') |
| 620 | todo = self.length |
| 621 | if todo >= 0: |
| 622 | while todo > 0: |
| 623 | data = self.fp.read(min(todo, self.bufsize)) |
| 624 | if not data: |
| 625 | self.done = -1 |
| 626 | break |
| 627 | self.file.write(data) |
| 628 | todo = todo - len(data) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 629 | |
| 630 | def read_lines(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 631 | """Internal: read lines until EOF or outerboundary.""" |
| 632 | self.file = self.make_file('') |
| 633 | if self.outerboundary: |
| 634 | self.read_lines_to_outerboundary() |
| 635 | else: |
| 636 | self.read_lines_to_eof() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 637 | |
| 638 | def read_lines_to_eof(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 639 | """Internal: read lines until EOF.""" |
| 640 | while 1: |
| 641 | line = self.fp.readline() |
| 642 | if not line: |
| 643 | self.done = -1 |
| 644 | break |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 645 | self.file.write(line) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 646 | |
| 647 | def read_lines_to_outerboundary(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 648 | """Internal: read lines until outerboundary.""" |
| 649 | next = "--" + self.outerboundary |
| 650 | last = next + "--" |
| 651 | delim = "" |
| 652 | while 1: |
| 653 | line = self.fp.readline() |
| 654 | if not line: |
| 655 | self.done = -1 |
| 656 | break |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 657 | if line[:2] == "--": |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 658 | strippedline = line.strip() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 659 | if strippedline == next: |
| 660 | break |
| 661 | if strippedline == last: |
| 662 | self.done = 1 |
| 663 | break |
| 664 | odelim = delim |
| 665 | if line[-2:] == "\r\n": |
| 666 | delim = "\r\n" |
| 667 | line = line[:-2] |
| 668 | elif line[-1] == "\n": |
| 669 | delim = "\n" |
| 670 | line = line[:-1] |
| 671 | else: |
| 672 | delim = "" |
| 673 | self.file.write(odelim + line) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 674 | |
| 675 | def skip_lines(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 676 | """Internal: skip lines until outer boundary if defined.""" |
| 677 | if not self.outerboundary or self.done: |
| 678 | return |
| 679 | next = "--" + self.outerboundary |
| 680 | last = next + "--" |
| 681 | while 1: |
| 682 | line = self.fp.readline() |
| 683 | if not line: |
| 684 | self.done = -1 |
| 685 | break |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 686 | if line[:2] == "--": |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 687 | strippedline = line.strip() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 688 | if strippedline == next: |
| 689 | break |
| 690 | if strippedline == last: |
| 691 | self.done = 1 |
| 692 | break |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 693 | |
Guido van Rossum | a5e9fb6 | 1997-08-12 18:18:13 +0000 | [diff] [blame] | 694 | def make_file(self, binary=None): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 695 | """Overridable: return a readable & writable file. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 696 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 697 | The file will be used as follows: |
| 698 | - data is written to it |
| 699 | - seek(0) |
| 700 | - data is read from it |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 701 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 702 | The 'binary' argument is unused -- the file is always opened |
| 703 | in binary mode. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 704 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 705 | This version opens a temporary file for reading and writing, |
| 706 | and immediately deletes (unlinks) it. The trick (on Unix!) is |
| 707 | that the file can still be used, but it can't be opened by |
| 708 | another process, and it will automatically be deleted when it |
| 709 | is closed or when the current process terminates. |
Guido van Rossum | 4032c2c | 1996-03-09 04:04:35 +0000 | [diff] [blame] | 710 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 711 | If you want a more permanent file, you derive a class which |
| 712 | overrides this method. If you want a visible temporary file |
| 713 | that is nevertheless automatically deleted when the script |
| 714 | terminates, try defining a __del__ method in a derived class |
| 715 | which unlinks the temporary files you have created. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 716 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 717 | """ |
| 718 | import tempfile |
| 719 | return tempfile.TemporaryFile("w+b") |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 720 | |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 721 | |
| 722 | |
Guido van Rossum | 4032c2c | 1996-03-09 04:04:35 +0000 | [diff] [blame] | 723 | # Backwards Compatibility Classes |
| 724 | # =============================== |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 725 | |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 726 | class FormContentDict(UserDict.UserDict): |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 727 | """Form content as dictionary with a list of values per field. |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 728 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 729 | form = FormContentDict() |
| 730 | |
| 731 | form[key] -> [value, value, ...] |
| 732 | form.has_key(key) -> Boolean |
| 733 | form.keys() -> [key, key, ...] |
| 734 | form.values() -> [[val, val, ...], [val, val, ...], ...] |
| 735 | form.items() -> [(key, [val, val, ...]), (key, [val, val, ...]), ...] |
| 736 | form.dict == {key: [val, val, ...], ...} |
| 737 | |
| 738 | """ |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 739 | def __init__(self, environ=os.environ): |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 740 | self.dict = self.data = parse(environ=environ) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 741 | self.query_string = environ['QUERY_STRING'] |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 742 | |
| 743 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 744 | class SvFormContentDict(FormContentDict): |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 745 | """Form content as dictionary expecting a single value per field. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 746 | |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 747 | If you only expect a single value for each field, then form[key] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 748 | will return that single value. It will raise an IndexError if |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 749 | that expectation is not true. If you expect a field to have |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 750 | possible multiple values, than you can use form.getlist(key) to |
| 751 | get all of the values. values() and items() are a compromise: |
| 752 | they return single strings where there is a single value, and |
| 753 | lists of strings otherwise. |
| 754 | |
| 755 | """ |
| 756 | def __getitem__(self, key): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 757 | if len(self.dict[key]) > 1: |
| 758 | raise IndexError, 'expecting a single value' |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 759 | return self.dict[key][0] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 760 | def getlist(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 761 | return self.dict[key] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 762 | def values(self): |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 763 | result = [] |
| 764 | for value in self.dict.values(): |
| 765 | if len(value) == 1: |
| 766 | result.append(value[0]) |
| 767 | else: result.append(value) |
| 768 | return result |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 769 | def items(self): |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 770 | result = [] |
| 771 | for key, value in self.dict.items(): |
| 772 | if len(value) == 1: |
| 773 | result.append((key, value[0])) |
| 774 | else: result.append((key, value)) |
| 775 | return result |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 776 | |
| 777 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 778 | class InterpFormContentDict(SvFormContentDict): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 779 | """This class is present for backwards compatibility only.""" |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 780 | def __getitem__(self, key): |
| 781 | v = SvFormContentDict.__getitem__(self, key) |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 782 | if v[0] in '0123456789+-.': |
| 783 | try: return int(v) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 784 | except ValueError: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 785 | try: return float(v) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 786 | except ValueError: pass |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 787 | return v.strip() |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 788 | def values(self): |
| 789 | result = [] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 790 | for key in self.keys(): |
| 791 | try: |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 792 | result.append(self[key]) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 793 | except IndexError: |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 794 | result.append(self.dict[key]) |
| 795 | return result |
| 796 | def items(self): |
| 797 | result = [] |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 798 | for key in self.keys(): |
| 799 | try: |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 800 | result.append((key, self[key])) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 801 | except IndexError: |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 802 | result.append((key, self.dict[key])) |
| 803 | return result |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 804 | |
| 805 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 806 | class FormContent(FormContentDict): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 807 | """This class is present for backwards compatibility only.""" |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 808 | def values(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 809 | if self.dict.has_key(key) :return self.dict[key] |
| 810 | else: return None |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 811 | def indexed_value(self, key, location): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 812 | if self.dict.has_key(key): |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 813 | if len(self.dict[key]) > location: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 814 | return self.dict[key][location] |
| 815 | else: return None |
| 816 | else: return None |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 817 | def value(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 818 | if self.dict.has_key(key): return self.dict[key][0] |
| 819 | else: return None |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 820 | def length(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 821 | return len(self.dict[key]) |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 822 | def stripped(self, key): |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 823 | if self.dict.has_key(key): return self.dict[key][0].strip() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 824 | else: return None |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 825 | def pars(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 826 | return self.dict |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 827 | |
| 828 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 829 | # Test/debug code |
| 830 | # =============== |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 831 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 832 | def test(environ=os.environ): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 833 | """Robust test CGI script, usable as main program. |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 834 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 835 | Write minimal HTTP headers and dump all information provided to |
| 836 | the script in HTML form. |
| 837 | |
| 838 | """ |
| 839 | import traceback |
| 840 | print "Content-type: text/html" |
| 841 | print |
| 842 | sys.stderr = sys.stdout |
| 843 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 844 | form = FieldStorage() # Replace with other classes to test those |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 845 | print_directory() |
| 846 | print_arguments() |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 847 | print_form(form) |
| 848 | print_environ(environ) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 849 | print_environ_usage() |
| 850 | def f(): |
| 851 | exec "testing print_exception() -- <I>italics?</I>" |
| 852 | def g(f=f): |
| 853 | f() |
| 854 | print "<H3>What follows is a test, not an actual exception:</H3>" |
| 855 | g() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 856 | except: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 857 | print_exception() |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 858 | |
Guido van Rossum | 57d51f2 | 2000-09-16 21:16:01 +0000 | [diff] [blame] | 859 | print "<H1>Second try with a small maxlen...</H1>" |
| 860 | |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 861 | global maxlen |
| 862 | maxlen = 50 |
| 863 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 864 | form = FieldStorage() # Replace with other classes to test those |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 865 | print_directory() |
| 866 | print_arguments() |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 867 | print_form(form) |
| 868 | print_environ(environ) |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 869 | except: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 870 | print_exception() |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 871 | |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 872 | def print_exception(type=None, value=None, tb=None, limit=None): |
| 873 | if type is None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 874 | type, value, tb = sys.exc_info() |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 875 | import traceback |
| 876 | print |
Guido van Rossum | 7dd0696 | 2000-12-27 19:12:58 +0000 | [diff] [blame] | 877 | print "<H3>Traceback (most recent call last):</H3>" |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 878 | list = traceback.format_tb(tb, limit) + \ |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 879 | traceback.format_exception_only(type, value) |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 880 | print "<PRE>%s<B>%s</B></PRE>" % ( |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 881 | escape("".join(list[:-1])), |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 882 | escape(list[-1]), |
| 883 | ) |
Guido van Rossum | f15d159 | 1997-09-29 23:22:12 +0000 | [diff] [blame] | 884 | del tb |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 885 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 886 | def print_environ(environ=os.environ): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 887 | """Dump the shell environment as HTML.""" |
| 888 | keys = environ.keys() |
| 889 | keys.sort() |
| 890 | print |
Guido van Rossum | 503e50b | 1996-05-28 22:57:20 +0000 | [diff] [blame] | 891 | print "<H3>Shell Environment:</H3>" |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 892 | print "<DL>" |
| 893 | for key in keys: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 894 | print "<DT>", escape(key), "<DD>", escape(environ[key]) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 895 | print "</DL>" |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 896 | print |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 897 | |
| 898 | def print_form(form): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 899 | """Dump the contents of a form as HTML.""" |
| 900 | keys = form.keys() |
| 901 | keys.sort() |
| 902 | print |
Guido van Rossum | 503e50b | 1996-05-28 22:57:20 +0000 | [diff] [blame] | 903 | print "<H3>Form Contents:</H3>" |
Guido van Rossum | 57d51f2 | 2000-09-16 21:16:01 +0000 | [diff] [blame] | 904 | if not keys: |
| 905 | print "<P>No form fields." |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 906 | print "<DL>" |
| 907 | for key in keys: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 908 | print "<DT>" + escape(key) + ":", |
| 909 | value = form[key] |
| 910 | print "<i>" + escape(`type(value)`) + "</i>" |
| 911 | print "<DD>" + escape(`value`) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 912 | print "</DL>" |
| 913 | print |
| 914 | |
| 915 | def print_directory(): |
| 916 | """Dump the current directory as HTML.""" |
| 917 | print |
| 918 | print "<H3>Current Working Directory:</H3>" |
| 919 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 920 | pwd = os.getcwd() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 921 | except os.error, msg: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 922 | print "os.error:", escape(str(msg)) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 923 | else: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 924 | print escape(pwd) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 925 | print |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 926 | |
Guido van Rossum | a8738a5 | 1996-03-14 21:30:28 +0000 | [diff] [blame] | 927 | def print_arguments(): |
| 928 | print |
Guido van Rossum | 503e50b | 1996-05-28 22:57:20 +0000 | [diff] [blame] | 929 | print "<H3>Command Line Arguments:</H3>" |
Guido van Rossum | a8738a5 | 1996-03-14 21:30:28 +0000 | [diff] [blame] | 930 | print |
| 931 | print sys.argv |
| 932 | print |
| 933 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 934 | def print_environ_usage(): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 935 | """Dump a list of environment variables used by CGI as HTML.""" |
| 936 | print """ |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 937 | <H3>These environment variables could have been set:</H3> |
| 938 | <UL> |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 939 | <LI>AUTH_TYPE |
| 940 | <LI>CONTENT_LENGTH |
| 941 | <LI>CONTENT_TYPE |
| 942 | <LI>DATE_GMT |
| 943 | <LI>DATE_LOCAL |
| 944 | <LI>DOCUMENT_NAME |
| 945 | <LI>DOCUMENT_ROOT |
| 946 | <LI>DOCUMENT_URI |
| 947 | <LI>GATEWAY_INTERFACE |
| 948 | <LI>LAST_MODIFIED |
| 949 | <LI>PATH |
| 950 | <LI>PATH_INFO |
| 951 | <LI>PATH_TRANSLATED |
| 952 | <LI>QUERY_STRING |
| 953 | <LI>REMOTE_ADDR |
| 954 | <LI>REMOTE_HOST |
| 955 | <LI>REMOTE_IDENT |
| 956 | <LI>REMOTE_USER |
| 957 | <LI>REQUEST_METHOD |
| 958 | <LI>SCRIPT_NAME |
| 959 | <LI>SERVER_NAME |
| 960 | <LI>SERVER_PORT |
| 961 | <LI>SERVER_PROTOCOL |
| 962 | <LI>SERVER_ROOT |
| 963 | <LI>SERVER_SOFTWARE |
| 964 | </UL> |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 965 | In addition, HTTP headers sent by the server may be passed in the |
| 966 | environment as well. Here are some common variable names: |
| 967 | <UL> |
| 968 | <LI>HTTP_ACCEPT |
| 969 | <LI>HTTP_CONNECTION |
| 970 | <LI>HTTP_HOST |
| 971 | <LI>HTTP_PRAGMA |
| 972 | <LI>HTTP_REFERER |
| 973 | <LI>HTTP_USER_AGENT |
| 974 | </UL> |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 975 | """ |
| 976 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 977 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 978 | # Utilities |
| 979 | # ========= |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 980 | |
Guido van Rossum | 64c6620 | 1997-07-19 20:11:53 +0000 | [diff] [blame] | 981 | def escape(s, quote=None): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 982 | """Replace special characters '&', '<' and '>' by SGML entities.""" |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 983 | s = s.replace("&", "&") # Must be done first! |
| 984 | s = s.replace("<", "<") |
| 985 | s = s.replace(">", ">") |
Guido van Rossum | 64c6620 | 1997-07-19 20:11:53 +0000 | [diff] [blame] | 986 | if quote: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 987 | s = s.replace('"', """) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 988 | return s |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 989 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 990 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 991 | # Invoke mainline |
| 992 | # =============== |
| 993 | |
| 994 | # Call test() when this file is run as a script (not imported as a module) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 995 | if __name__ == '__main__': |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 996 | test() |