Benjamin Peterson | 8c703a0 | 2010-03-11 22:05:58 +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 | |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 18 | # History |
| 19 | # ------- |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 20 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 21 | # Michael McLay started this module. Steve Majewski changed the |
| 22 | # interface to SvFormContentDict and FormContentDict. The multipart |
| 23 | # parsing was inspired by code submitted by Andreas Paepcke. Guido van |
| 24 | # Rossum rewrote, reformatted and documented the module and is currently |
| 25 | # responsible for its maintenance. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 26 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 27 | |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 28 | __version__ = "2.6" |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 29 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 30 | |
| 31 | # Imports |
| 32 | # ======= |
| 33 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 34 | from io import StringIO, BytesIO, TextIOWrapper |
Serhiy Storchaka | 2e576f5 | 2017-04-24 09:05:00 +0300 | [diff] [blame] | 35 | from collections.abc import Mapping |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 36 | import sys |
| 37 | import os |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 38 | import urllib.parse |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 39 | from email.parser import FeedParser |
Senthil Kumaran | b4cbb92 | 2014-01-11 22:20:16 -0800 | [diff] [blame] | 40 | from email.message import Message |
Georg Brandl | 1f7fffb | 2010-10-15 15:57:45 +0000 | [diff] [blame] | 41 | import html |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 42 | import locale |
| 43 | import tempfile |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 44 | |
INADA Naoki | 698865d | 2018-06-19 17:28:50 +0900 | [diff] [blame^] | 45 | __all__ = ["MiniFieldStorage", "FieldStorage", "parse", "parse_multipart", |
Martin Panter | 1cd2772 | 2016-06-06 01:53:28 +0000 | [diff] [blame] | 46 | "parse_header", "test", "print_exception", "print_environ", |
Guido van Rossum | a8423a9 | 2001-03-19 13:40:44 +0000 | [diff] [blame] | 47 | "print_form", "print_directory", "print_arguments", |
INADA Naoki | 698865d | 2018-06-19 17:28:50 +0900 | [diff] [blame^] | 48 | "print_environ_usage"] |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 49 | |
| 50 | # Logging support |
| 51 | # =============== |
| 52 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 53 | logfile = "" # Filename to log to, if not empty |
| 54 | logfp = None # File object to log to, if not None |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 55 | |
| 56 | def initlog(*allargs): |
| 57 | """Write a log message, if there is a log file. |
| 58 | |
| 59 | Even though this function is called initlog(), you should always |
| 60 | use log(); log is a variable that is set either to initlog |
| 61 | (initially), to dolog (once the log file has been opened), or to |
| 62 | nolog (when logging is disabled). |
| 63 | |
| 64 | The first argument is a format string; the remaining arguments (if |
| 65 | any) are arguments to the % operator, so e.g. |
| 66 | log("%s: %s", "a", "b") |
| 67 | will write "a: b" to the log file, followed by a newline. |
| 68 | |
| 69 | If the global logfp is not None, it should be a file object to |
| 70 | which log data is written. |
| 71 | |
| 72 | If the global logfp is None, the global logfile may be a string |
| 73 | giving a filename to open, in append mode. This file should be |
| 74 | world writable!!! If the file can't be opened, logging is |
| 75 | silently disabled (since there is no safe place where we could |
| 76 | send an error message). |
| 77 | |
| 78 | """ |
Victor Stinner | d33344a | 2011-07-14 22:28:36 +0200 | [diff] [blame] | 79 | global log, logfile, logfp |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 80 | if logfile and not logfp: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 81 | try: |
| 82 | logfp = open(logfile, "a") |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 83 | except OSError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 84 | pass |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 85 | if not logfp: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 86 | log = nolog |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 87 | else: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 88 | log = dolog |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 89 | log(*allargs) |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 90 | |
| 91 | def dolog(fmt, *args): |
| 92 | """Write a log message to the log file. See initlog() for docs.""" |
| 93 | logfp.write(fmt%args + "\n") |
| 94 | |
| 95 | def nolog(*allargs): |
| 96 | """Dummy function, assigned to log when logging is disabled.""" |
| 97 | pass |
| 98 | |
Victor Stinner | d33344a | 2011-07-14 22:28:36 +0200 | [diff] [blame] | 99 | def closelog(): |
| 100 | """Close the log file.""" |
| 101 | global log, logfile, logfp |
| 102 | logfile = '' |
| 103 | if logfp: |
| 104 | logfp.close() |
| 105 | logfp = None |
| 106 | log = initlog |
| 107 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 108 | log = initlog # The current logging function |
Guido van Rossum | c204c70 | 1996-09-05 19:07:11 +0000 | [diff] [blame] | 109 | |
| 110 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 111 | # Parsing functions |
| 112 | # ================= |
| 113 | |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 114 | # Maximum input we will accept when REQUEST_METHOD is POST |
| 115 | # 0 ==> unlimited input |
| 116 | maxlen = 0 |
| 117 | |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 118 | 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] | 119 | """Parse a query in the environment or from a file (default stdin) |
| 120 | |
| 121 | Arguments, all optional: |
| 122 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 123 | fp : file pointer; default: sys.stdin.buffer |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 124 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 125 | environ : environment dictionary; default: os.environ |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 126 | |
| 127 | keep_blank_values: flag indicating whether blank values in |
Senthil Kumaran | 30e86a4 | 2010-08-09 20:01:35 +0000 | [diff] [blame] | 128 | percent-encoded forms should be treated as blank strings. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 129 | A true value indicates that blanks should be retained as |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 130 | blank strings. The default false value indicates that |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 131 | blank values are to be ignored and treated as if they were |
| 132 | not included. |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 133 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 134 | strict_parsing: flag indicating what to do with parsing errors. |
| 135 | If false (the default), errors are silently ignored. |
| 136 | If true, errors raise a ValueError exception. |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 137 | """ |
Raymond Hettinger | a144900 | 2002-05-31 23:54:44 +0000 | [diff] [blame] | 138 | if fp is None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 139 | fp = sys.stdin |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 140 | |
| 141 | # field keys and values (except for files) are returned as strings |
| 142 | # an encoding is required to decode the bytes read from self.fp |
| 143 | if hasattr(fp,'encoding'): |
| 144 | encoding = fp.encoding |
| 145 | else: |
| 146 | encoding = 'latin-1' |
| 147 | |
| 148 | # fp.read() must return bytes |
| 149 | if isinstance(fp, TextIOWrapper): |
| 150 | fp = fp.buffer |
| 151 | |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 152 | if not 'REQUEST_METHOD' in environ: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 153 | environ['REQUEST_METHOD'] = 'GET' # For testing stand-alone |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 154 | if environ['REQUEST_METHOD'] == 'POST': |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 155 | ctype, pdict = parse_header(environ['CONTENT_TYPE']) |
| 156 | if ctype == 'multipart/form-data': |
| 157 | return parse_multipart(fp, pdict) |
| 158 | elif ctype == 'application/x-www-form-urlencoded': |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 159 | clength = int(environ['CONTENT_LENGTH']) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 160 | if maxlen and clength > maxlen: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 161 | raise ValueError('Maximum content length exceeded') |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 162 | qs = fp.read(clength).decode(encoding) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 163 | else: |
| 164 | qs = '' # Unknown content-type |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 165 | if 'QUERY_STRING' in environ: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 166 | if qs: qs = qs + '&' |
| 167 | qs = qs + environ['QUERY_STRING'] |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 168 | elif sys.argv[1:]: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 169 | if qs: qs = qs + '&' |
| 170 | qs = qs + sys.argv[1] |
| 171 | environ['QUERY_STRING'] = qs # XXX Shouldn't, really |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 172 | elif 'QUERY_STRING' in environ: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 173 | qs = environ['QUERY_STRING'] |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 174 | else: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 175 | if sys.argv[1:]: |
| 176 | qs = sys.argv[1] |
| 177 | else: |
| 178 | qs = "" |
| 179 | environ['QUERY_STRING'] = qs # XXX Shouldn't, really |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 180 | return urllib.parse.parse_qs(qs, keep_blank_values, strict_parsing, |
| 181 | encoding=encoding) |
Guido van Rossum | e780877 | 1995-08-07 20:12:09 +0000 | [diff] [blame] | 182 | |
| 183 | |
Amber Brown | 545c955 | 2018-05-14 18:11:55 -0400 | [diff] [blame] | 184 | def parse_multipart(fp, pdict, encoding="utf-8", errors="replace"): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 185 | """Parse multipart input. |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 186 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 187 | Arguments: |
| 188 | fp : input file |
Johannes Gijsbers | c7fc10a | 2005-01-08 13:56:36 +0000 | [diff] [blame] | 189 | pdict: dictionary containing other parameters of content-type header |
Amber Brown | 545c955 | 2018-05-14 18:11:55 -0400 | [diff] [blame] | 190 | encoding, errors: request encoding and error handler, passed to |
| 191 | FieldStorage |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 192 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 193 | Returns a dictionary just like parse_qs(): keys are the field names, each |
Pierre Quentel | cc3fa20 | 2017-05-08 14:08:34 +0200 | [diff] [blame] | 194 | value is a list of values for that field. For non-file fields, the value |
| 195 | is a list of strings. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 196 | """ |
Pierre Quentel | cc3fa20 | 2017-05-08 14:08:34 +0200 | [diff] [blame] | 197 | # RFC 2026, Section 5.1 : The "multipart" boundary delimiters are always |
| 198 | # represented as 7bit US-ASCII. |
| 199 | boundary = pdict['boundary'].decode('ascii') |
| 200 | ctype = "multipart/form-data; boundary={}".format(boundary) |
| 201 | headers = Message() |
| 202 | headers.set_type(ctype) |
| 203 | headers['Content-Length'] = pdict['CONTENT-LENGTH'] |
Amber Brown | 545c955 | 2018-05-14 18:11:55 -0400 | [diff] [blame] | 204 | fs = FieldStorage(fp, headers=headers, encoding=encoding, errors=errors, |
Pierre Quentel | cc3fa20 | 2017-05-08 14:08:34 +0200 | [diff] [blame] | 205 | environ={'REQUEST_METHOD': 'POST'}) |
| 206 | return {k: fs.getlist(k) for k in fs} |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 207 | |
Fred Drake | 9a0a65b | 2008-12-04 19:24:50 +0000 | [diff] [blame] | 208 | def _parseparam(s): |
| 209 | while s[:1] == ';': |
| 210 | s = s[1:] |
| 211 | end = s.find(';') |
Senthil Kumaran | 1ef0c03 | 2011-10-20 01:05:44 +0800 | [diff] [blame] | 212 | while end > 0 and (s.count('"', 0, end) - s.count('\\"', 0, end)) % 2: |
Fred Drake | 9a0a65b | 2008-12-04 19:24:50 +0000 | [diff] [blame] | 213 | end = s.find(';', end + 1) |
| 214 | if end < 0: |
| 215 | end = len(s) |
| 216 | f = s[:end] |
| 217 | yield f.strip() |
| 218 | s = s[end:] |
| 219 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 220 | def parse_header(line): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 221 | """Parse a Content-type like header. |
| 222 | |
| 223 | Return the main content-type and a dictionary of options. |
| 224 | |
| 225 | """ |
Fred Drake | 9a0a65b | 2008-12-04 19:24:50 +0000 | [diff] [blame] | 226 | parts = _parseparam(';' + line) |
| 227 | key = parts.__next__() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 228 | pdict = {} |
Fred Drake | 9a0a65b | 2008-12-04 19:24:50 +0000 | [diff] [blame] | 229 | for p in parts: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 230 | i = p.find('=') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 231 | if i >= 0: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 232 | name = p[:i].strip().lower() |
| 233 | value = p[i+1:].strip() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 234 | if len(value) >= 2 and value[0] == value[-1] == '"': |
| 235 | value = value[1:-1] |
Johannes Gijsbers | 9e15dd6 | 2004-08-14 15:39:34 +0000 | [diff] [blame] | 236 | value = value.replace('\\\\', '\\').replace('\\"', '"') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 237 | pdict[name] = value |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 238 | return key, pdict |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 239 | |
| 240 | |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 241 | # Classes for field storage |
| 242 | # ========================= |
| 243 | |
| 244 | class MiniFieldStorage: |
| 245 | |
Guido van Rossum | 0147db0 | 1996-03-09 03:16:04 +0000 | [diff] [blame] | 246 | """Like FieldStorage, for use when no file uploads are possible.""" |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 247 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 248 | # Dummy attributes |
| 249 | filename = None |
| 250 | list = None |
| 251 | type = None |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 252 | file = None |
Guido van Rossum | 4032c2c | 1996-03-09 04:04:35 +0000 | [diff] [blame] | 253 | type_options = {} |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 254 | disposition = None |
| 255 | disposition_options = {} |
| 256 | headers = {} |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 257 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 258 | def __init__(self, name, value): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 259 | """Constructor from field name and value.""" |
| 260 | self.name = name |
| 261 | self.value = value |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 262 | # self.file = StringIO(value) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 263 | |
| 264 | def __repr__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 265 | """Return printable representation.""" |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 266 | return "MiniFieldStorage(%r, %r)" % (self.name, self.value) |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 267 | |
| 268 | |
| 269 | class FieldStorage: |
| 270 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 271 | """Store a sequence of fields, reading multipart/form-data. |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 272 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 273 | This class provides naming, typing, files stored on disk, and |
| 274 | more. At the top level, it is accessible like a dictionary, whose |
| 275 | keys are the field names. (Note: None can occur as a field name.) |
| 276 | The items are either a Python list (if there's multiple values) or |
| 277 | another FieldStorage or MiniFieldStorage object. If it's a single |
| 278 | object, it has the following attributes: |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 279 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 280 | name: the field name, if specified; otherwise None |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 281 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 282 | filename: the filename, if specified; otherwise None; this is the |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 283 | client side filename, *not* the file name on which it is |
| 284 | stored (that's a temporary file you don't deal with) |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 285 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 286 | value: the value as a *string*; for file uploads, this |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 287 | transparently reads the file every time you request the value |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 288 | and returns *bytes* |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 289 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 290 | file: the file(-like) object from which you can read the data *as |
| 291 | bytes* ; None if the data is stored a simple string |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 292 | |
| 293 | type: the content-type, or None if not specified |
| 294 | |
| 295 | type_options: dictionary of options specified on the content-type |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 296 | line |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 297 | |
| 298 | disposition: content-disposition, or None if not specified |
| 299 | |
| 300 | disposition_options: dictionary of corresponding options |
| 301 | |
Barry Warsaw | 596097e | 2008-06-12 02:38:51 +0000 | [diff] [blame] | 302 | headers: a dictionary(-like) object (sometimes email.message.Message or a |
Armin Rigo | 3a703b6 | 2005-09-19 09:11:04 +0000 | [diff] [blame] | 303 | subclass thereof) containing *all* headers |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 304 | |
| 305 | The class is subclassable, mostly for the purpose of overriding |
| 306 | the make_file() method, which is called internally to come up with |
| 307 | a file open for reading and writing. This makes it possible to |
| 308 | override the default choice of storing all files in a temporary |
| 309 | directory and unlinking them as soon as they have been opened. |
| 310 | |
| 311 | """ |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 312 | def __init__(self, fp=None, headers=None, outerboundary=b'', |
| 313 | environ=os.environ, keep_blank_values=0, strict_parsing=0, |
| 314 | limit=None, encoding='utf-8', errors='replace'): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 315 | """Constructor. Read multipart/* until last part. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 316 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 317 | Arguments, all optional: |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 318 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 319 | fp : file pointer; default: sys.stdin.buffer |
Guido van Rossum | b1b4f94 | 1998-05-08 19:55:51 +0000 | [diff] [blame] | 320 | (not used when the request method is GET) |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 321 | Can be : |
| 322 | 1. a TextIOWrapper object |
| 323 | 2. an object whose read() and readline() methods return bytes |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 324 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 325 | headers : header dictionary-like object; default: |
| 326 | taken from environ as per CGI spec |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 327 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 328 | outerboundary : terminating multipart boundary |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 329 | (for internal use only) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 330 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 331 | environ : environment dictionary; default: os.environ |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 332 | |
| 333 | keep_blank_values: flag indicating whether blank values in |
Senthil Kumaran | 30e86a4 | 2010-08-09 20:01:35 +0000 | [diff] [blame] | 334 | percent-encoded forms should be treated as blank strings. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 335 | A true value indicates that blanks should be retained as |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 336 | blank strings. The default false value indicates that |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 337 | blank values are to be ignored and treated as if they were |
| 338 | not included. |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 339 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 340 | strict_parsing: flag indicating what to do with parsing errors. |
| 341 | If false (the default), errors are silently ignored. |
| 342 | If true, errors raise a ValueError exception. |
Guido van Rossum | e08c04c | 1996-11-11 19:29:11 +0000 | [diff] [blame] | 343 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 344 | limit : used internally to read parts of multipart/form-data forms, |
| 345 | to exit from the reading loop when reached. It is the difference |
| 346 | between the form content-length and the number of bytes already |
| 347 | read |
| 348 | |
| 349 | encoding, errors : the encoding and error handler used to decode the |
| 350 | binary stream to strings. Must be the same as the charset defined |
| 351 | for the page sending the form (content-type : meta http-equiv or |
| 352 | header) |
| 353 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 354 | """ |
| 355 | method = 'GET' |
| 356 | self.keep_blank_values = keep_blank_values |
| 357 | self.strict_parsing = strict_parsing |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 358 | if 'REQUEST_METHOD' in environ: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 359 | method = environ['REQUEST_METHOD'].upper() |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 360 | self.qs_on_post = None |
Guido van Rossum | 0185283 | 1998-06-25 02:40:17 +0000 | [diff] [blame] | 361 | if method == 'GET' or method == 'HEAD': |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 362 | if 'QUERY_STRING' in environ: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 363 | qs = environ['QUERY_STRING'] |
| 364 | elif sys.argv[1:]: |
| 365 | qs = sys.argv[1] |
| 366 | else: |
| 367 | qs = "" |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 368 | qs = qs.encode(locale.getpreferredencoding(), 'surrogateescape') |
| 369 | fp = BytesIO(qs) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 370 | if headers is None: |
| 371 | headers = {'content-type': |
| 372 | "application/x-www-form-urlencoded"} |
| 373 | if headers is None: |
Guido van Rossum | cff311a | 1998-06-11 14:06:59 +0000 | [diff] [blame] | 374 | headers = {} |
| 375 | if method == 'POST': |
| 376 | # Set default content-type for POST to what's traditional |
| 377 | headers['content-type'] = "application/x-www-form-urlencoded" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 378 | if 'CONTENT_TYPE' in environ: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 379 | headers['content-type'] = environ['CONTENT_TYPE'] |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 380 | if 'QUERY_STRING' in environ: |
| 381 | self.qs_on_post = environ['QUERY_STRING'] |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 382 | if 'CONTENT_LENGTH' in environ: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 383 | headers['content-length'] = environ['CONTENT_LENGTH'] |
Senthil Kumaran | b4cbb92 | 2014-01-11 22:20:16 -0800 | [diff] [blame] | 384 | else: |
| 385 | if not (isinstance(headers, (Mapping, Message))): |
| 386 | raise TypeError("headers must be mapping or an instance of " |
| 387 | "email.message.Message") |
| 388 | self.headers = headers |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 389 | if fp is None: |
| 390 | self.fp = sys.stdin.buffer |
| 391 | # self.fp.read() must return bytes |
| 392 | elif isinstance(fp, TextIOWrapper): |
| 393 | self.fp = fp.buffer |
| 394 | else: |
Senthil Kumaran | b4cbb92 | 2014-01-11 22:20:16 -0800 | [diff] [blame] | 395 | if not (hasattr(fp, 'read') and hasattr(fp, 'readline')): |
| 396 | raise TypeError("fp must be file pointer") |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 397 | self.fp = fp |
| 398 | |
| 399 | self.encoding = encoding |
| 400 | self.errors = errors |
| 401 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 402 | if not isinstance(outerboundary, bytes): |
| 403 | raise TypeError('outerboundary must be bytes, not %s' |
| 404 | % type(outerboundary).__name__) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 405 | self.outerboundary = outerboundary |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 406 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 407 | self.bytes_read = 0 |
| 408 | self.limit = limit |
| 409 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 410 | # Process content-disposition header |
| 411 | cdisp, pdict = "", {} |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 412 | if 'content-disposition' in self.headers: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 413 | cdisp, pdict = parse_header(self.headers['content-disposition']) |
| 414 | self.disposition = cdisp |
| 415 | self.disposition_options = pdict |
| 416 | self.name = None |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 417 | if 'name' in pdict: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 418 | self.name = pdict['name'] |
| 419 | self.filename = None |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 420 | if 'filename' in pdict: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 421 | self.filename = pdict['filename'] |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 422 | self._binary_file = self.filename is not None |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 423 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 424 | # Process content-type header |
Barry Warsaw | 302331a | 1999-01-08 17:42:03 +0000 | [diff] [blame] | 425 | # |
| 426 | # Honor any existing content-type header. But if there is no |
| 427 | # content-type header, use some sensible defaults. Assume |
| 428 | # outerboundary is "" at the outer level, but something non-false |
| 429 | # inside a multi-part. The default for an inner part is text/plain, |
| 430 | # but for an outer part it should be urlencoded. This should catch |
| 431 | # bogus clients which erroneously forget to include a content-type |
| 432 | # header. |
| 433 | # |
| 434 | # See below for what we do if there does exist a content-type header, |
| 435 | # but it happens to be something we don't understand. |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 436 | if 'content-type' in self.headers: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 437 | ctype, pdict = parse_header(self.headers['content-type']) |
Guido van Rossum | ce900de | 1999-06-02 18:44:22 +0000 | [diff] [blame] | 438 | elif self.outerboundary or method != 'POST': |
Barry Warsaw | 302331a | 1999-01-08 17:42:03 +0000 | [diff] [blame] | 439 | ctype, pdict = "text/plain", {} |
| 440 | else: |
| 441 | ctype, pdict = 'application/x-www-form-urlencoded', {} |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 442 | self.type = ctype |
| 443 | self.type_options = pdict |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 444 | if 'boundary' in pdict: |
Amber Brown | 545c955 | 2018-05-14 18:11:55 -0400 | [diff] [blame] | 445 | self.innerboundary = pdict['boundary'].encode(self.encoding, |
| 446 | self.errors) |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 447 | else: |
| 448 | self.innerboundary = b"" |
| 449 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 450 | clen = -1 |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 451 | if 'content-length' in self.headers: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 452 | try: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 453 | clen = int(self.headers['content-length']) |
Skip Montanaro | db5d144 | 2002-03-23 05:50:17 +0000 | [diff] [blame] | 454 | except ValueError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 455 | pass |
| 456 | if maxlen and clen > maxlen: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 457 | raise ValueError('Maximum content length exceeded') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 458 | self.length = clen |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 459 | if self.limit is None and clen: |
| 460 | self.limit = clen |
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 | self.list = self.file = None |
| 463 | self.done = 0 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 464 | if ctype == 'application/x-www-form-urlencoded': |
| 465 | self.read_urlencoded() |
| 466 | elif ctype[:10] == 'multipart/': |
Guido van Rossum | f574500 | 1998-10-20 14:43:02 +0000 | [diff] [blame] | 467 | self.read_multi(environ, keep_blank_values, strict_parsing) |
Barry Warsaw | 302331a | 1999-01-08 17:42:03 +0000 | [diff] [blame] | 468 | else: |
Guido van Rossum | 60a3bd8 | 1999-06-11 18:26:09 +0000 | [diff] [blame] | 469 | self.read_single() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 470 | |
Brett Cannon | f79126f | 2013-08-23 15:15:48 -0400 | [diff] [blame] | 471 | def __del__(self): |
| 472 | try: |
| 473 | self.file.close() |
| 474 | except AttributeError: |
| 475 | pass |
| 476 | |
Berker Peksag | bf5e960 | 2015-02-06 10:21:37 +0200 | [diff] [blame] | 477 | def __enter__(self): |
| 478 | return self |
| 479 | |
| 480 | def __exit__(self, *args): |
| 481 | self.file.close() |
| 482 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 483 | def __repr__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 484 | """Return a printable representation.""" |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 485 | return "FieldStorage(%r, %r, %r)" % ( |
| 486 | self.name, self.filename, self.value) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 487 | |
Guido van Rossum | 4061cbe | 2002-09-11 18:20:34 +0000 | [diff] [blame] | 488 | def __iter__(self): |
| 489 | return iter(self.keys()) |
| 490 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 491 | def __getattr__(self, name): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 492 | if name != 'value': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 493 | raise AttributeError(name) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 494 | if self.file: |
| 495 | self.file.seek(0) |
| 496 | value = self.file.read() |
| 497 | self.file.seek(0) |
| 498 | elif self.list is not None: |
| 499 | value = self.list |
| 500 | else: |
| 501 | value = None |
| 502 | return value |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 503 | |
| 504 | def __getitem__(self, key): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 505 | """Dictionary style indexing.""" |
| 506 | if self.list is None: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 507 | raise TypeError("not indexable") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 508 | found = [] |
| 509 | for item in self.list: |
| 510 | if item.name == key: found.append(item) |
| 511 | if not found: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 512 | raise KeyError(key) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 513 | if len(found) == 1: |
| 514 | return found[0] |
| 515 | else: |
| 516 | return found |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 517 | |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 518 | def getvalue(self, key, default=None): |
| 519 | """Dictionary style get() method, including 'value' lookup.""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 520 | if key in self: |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 521 | value = self[key] |
Victor Stinner | f1c7ca9 | 2011-01-14 13:08:27 +0000 | [diff] [blame] | 522 | if isinstance(value, list): |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 523 | return [x.value for x in value] |
Moshe Zadka | a1a4b59 | 2000-08-25 21:47:56 +0000 | [diff] [blame] | 524 | else: |
| 525 | return value.value |
| 526 | else: |
| 527 | return default |
| 528 | |
Guido van Rossum | 1bfb388 | 2001-09-05 19:45:34 +0000 | [diff] [blame] | 529 | def getfirst(self, key, default=None): |
| 530 | """ Return the first value received.""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 531 | if key in self: |
Guido van Rossum | 1bfb388 | 2001-09-05 19:45:34 +0000 | [diff] [blame] | 532 | value = self[key] |
Victor Stinner | f1c7ca9 | 2011-01-14 13:08:27 +0000 | [diff] [blame] | 533 | if isinstance(value, list): |
Guido van Rossum | 1bfb388 | 2001-09-05 19:45:34 +0000 | [diff] [blame] | 534 | return value[0].value |
| 535 | else: |
| 536 | return value.value |
| 537 | else: |
| 538 | return default |
| 539 | |
| 540 | def getlist(self, key): |
| 541 | """ Return list of received values.""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 542 | if key in self: |
Guido van Rossum | 1bfb388 | 2001-09-05 19:45:34 +0000 | [diff] [blame] | 543 | value = self[key] |
Victor Stinner | f1c7ca9 | 2011-01-14 13:08:27 +0000 | [diff] [blame] | 544 | if isinstance(value, list): |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 545 | return [x.value for x in value] |
Guido van Rossum | 1bfb388 | 2001-09-05 19:45:34 +0000 | [diff] [blame] | 546 | else: |
| 547 | return [value.value] |
| 548 | else: |
| 549 | return [] |
| 550 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 551 | def keys(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 552 | """Dictionary style keys() method.""" |
| 553 | if self.list is None: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 554 | raise TypeError("not indexable") |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 555 | return list(set(item.name for item in self.list)) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 556 | |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 557 | def __contains__(self, key): |
| 558 | """Dictionary style __contains__ method.""" |
| 559 | if self.list is None: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 560 | raise TypeError("not indexable") |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 561 | return any(item.name == key for item in self.list) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 562 | |
Guido van Rossum | 88b85d4 | 1997-01-11 19:21:33 +0000 | [diff] [blame] | 563 | def __len__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 564 | """Dictionary style len(x) support.""" |
| 565 | return len(self.keys()) |
Guido van Rossum | 88b85d4 | 1997-01-11 19:21:33 +0000 | [diff] [blame] | 566 | |
Senthil Kumaran | b4cbb92 | 2014-01-11 22:20:16 -0800 | [diff] [blame] | 567 | def __bool__(self): |
| 568 | if self.list is None: |
| 569 | raise TypeError("Cannot be converted to bool.") |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 570 | return bool(self.list) |
| 571 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 572 | def read_urlencoded(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 573 | """Internal: read data in query string format.""" |
| 574 | qs = self.fp.read(self.length) |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 575 | if not isinstance(qs, bytes): |
| 576 | raise ValueError("%s should return bytes, got %s" \ |
| 577 | % (self.fp, type(qs).__name__)) |
| 578 | qs = qs.decode(self.encoding, self.errors) |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 579 | if self.qs_on_post: |
| 580 | qs += '&' + self.qs_on_post |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 581 | self.list = [] |
| 582 | query = urllib.parse.parse_qsl( |
| 583 | qs, self.keep_blank_values, self.strict_parsing, |
| 584 | encoding=self.encoding, errors=self.errors) |
| 585 | for key, value in query: |
| 586 | self.list.append(MiniFieldStorage(key, value)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 587 | self.skip_lines() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 588 | |
Guido van Rossum | 030d2ec | 1998-12-09 22:16:46 +0000 | [diff] [blame] | 589 | FieldStorageClass = None |
| 590 | |
Guido van Rossum | f574500 | 1998-10-20 14:43:02 +0000 | [diff] [blame] | 591 | def read_multi(self, environ, keep_blank_values, strict_parsing): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 592 | """Internal: read a part that is itself multipart.""" |
Guido van Rossum | 2e441f7 | 2001-07-25 21:00:19 +0000 | [diff] [blame] | 593 | ib = self.innerboundary |
| 594 | if not valid_boundary(ib): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 595 | raise ValueError('Invalid boundary in multipart form: %r' % (ib,)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 596 | self.list = [] |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 597 | if self.qs_on_post: |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 598 | query = urllib.parse.parse_qsl( |
| 599 | self.qs_on_post, self.keep_blank_values, self.strict_parsing, |
| 600 | encoding=self.encoding, errors=self.errors) |
| 601 | for key, value in query: |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 602 | self.list.append(MiniFieldStorage(key, value)) |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 603 | |
Guido van Rossum | 030d2ec | 1998-12-09 22:16:46 +0000 | [diff] [blame] | 604 | klass = self.FieldStorageClass or self.__class__ |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 605 | first_line = self.fp.readline() # bytes |
| 606 | if not isinstance(first_line, bytes): |
| 607 | raise ValueError("%s should return bytes, got %s" \ |
| 608 | % (self.fp, type(first_line).__name__)) |
| 609 | self.bytes_read += len(first_line) |
Donald Stufft | d90f8d1 | 2015-03-29 16:43:23 -0400 | [diff] [blame] | 610 | |
| 611 | # Ensure that we consume the file until we've hit our inner boundary |
| 612 | while (first_line.strip() != (b"--" + self.innerboundary) and |
| 613 | first_line): |
| 614 | first_line = self.fp.readline() |
| 615 | self.bytes_read += len(first_line) |
| 616 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 617 | while True: |
| 618 | parser = FeedParser() |
| 619 | hdr_text = b"" |
| 620 | while True: |
| 621 | data = self.fp.readline() |
| 622 | hdr_text += data |
| 623 | if not data.strip(): |
| 624 | break |
| 625 | if not hdr_text: |
| 626 | break |
| 627 | # parser takes strings, not bytes |
| 628 | self.bytes_read += len(hdr_text) |
| 629 | parser.feed(hdr_text.decode(self.encoding, self.errors)) |
| 630 | headers = parser.close() |
Victor Stinner | 6579459 | 2015-08-18 10:21:10 -0700 | [diff] [blame] | 631 | |
| 632 | # Some clients add Content-Length for part headers, ignore them |
| 633 | if 'content-length' in headers: |
| 634 | del headers['content-length'] |
| 635 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 636 | part = klass(self.fp, headers, ib, environ, keep_blank_values, |
| 637 | strict_parsing,self.limit-self.bytes_read, |
| 638 | self.encoding, self.errors) |
| 639 | self.bytes_read += part.bytes_read |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 640 | self.list.append(part) |
Florent Xicluna | 331c3fd | 2013-07-07 12:44:28 +0200 | [diff] [blame] | 641 | if part.done or self.bytes_read >= self.length > 0: |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 642 | break |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 643 | self.skip_lines() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 644 | |
| 645 | def read_single(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 646 | """Internal: read an atomic part.""" |
| 647 | if self.length >= 0: |
| 648 | self.read_binary() |
| 649 | self.skip_lines() |
| 650 | else: |
| 651 | self.read_lines() |
| 652 | self.file.seek(0) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 653 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 654 | bufsize = 8*1024 # I/O buffering size for copy to file |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 655 | |
| 656 | def read_binary(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 657 | """Internal: read binary data.""" |
Guido van Rossum | a1a6852 | 2007-08-28 03:11:34 +0000 | [diff] [blame] | 658 | self.file = self.make_file() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 659 | todo = self.length |
| 660 | if todo >= 0: |
| 661 | while todo > 0: |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 662 | data = self.fp.read(min(todo, self.bufsize)) # bytes |
| 663 | if not isinstance(data, bytes): |
| 664 | raise ValueError("%s should return bytes, got %s" |
| 665 | % (self.fp, type(data).__name__)) |
| 666 | self.bytes_read += len(data) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 667 | if not data: |
| 668 | self.done = -1 |
| 669 | break |
| 670 | self.file.write(data) |
| 671 | todo = todo - len(data) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 672 | |
| 673 | def read_lines(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 674 | """Internal: read lines until EOF or outerboundary.""" |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 675 | if self._binary_file: |
| 676 | self.file = self.__file = BytesIO() # store data as bytes for files |
| 677 | else: |
| 678 | self.file = self.__file = StringIO() # as strings for other fields |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 679 | if self.outerboundary: |
| 680 | self.read_lines_to_outerboundary() |
| 681 | else: |
| 682 | self.read_lines_to_eof() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 683 | |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 684 | def __write(self, line): |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 685 | """line is always bytes, not string""" |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 686 | if self.__file is not None: |
| 687 | if self.__file.tell() + len(line) > 1000: |
Guido van Rossum | a1a6852 | 2007-08-28 03:11:34 +0000 | [diff] [blame] | 688 | self.file = self.make_file() |
| 689 | data = self.__file.getvalue() |
| 690 | self.file.write(data) |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 691 | self.__file = None |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 692 | if self._binary_file: |
| 693 | # keep bytes |
| 694 | self.file.write(line) |
| 695 | else: |
| 696 | # decode to string |
| 697 | self.file.write(line.decode(self.encoding, self.errors)) |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 698 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 699 | def read_lines_to_eof(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 700 | """Internal: read lines until EOF.""" |
| 701 | while 1: |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 702 | line = self.fp.readline(1<<16) # bytes |
| 703 | self.bytes_read += len(line) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 704 | if not line: |
| 705 | self.done = -1 |
| 706 | break |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 707 | self.__write(line) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 708 | |
| 709 | def read_lines_to_outerboundary(self): |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 710 | """Internal: read lines until outerboundary. |
| 711 | Data is read as bytes: boundaries and line ends must be converted |
| 712 | to bytes for comparisons. |
| 713 | """ |
| 714 | next_boundary = b"--" + self.outerboundary |
| 715 | last_boundary = next_boundary + b"--" |
| 716 | delim = b"" |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 717 | last_line_lfend = True |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 718 | _read = 0 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 719 | while 1: |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 720 | if _read >= self.limit: |
| 721 | break |
| 722 | line = self.fp.readline(1<<16) # bytes |
| 723 | self.bytes_read += len(line) |
| 724 | _read += len(line) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 725 | if not line: |
| 726 | self.done = -1 |
| 727 | break |
Serhiy Storchaka | c7bfe0e | 2013-06-17 16:34:41 +0300 | [diff] [blame] | 728 | if delim == b"\r": |
| 729 | line = delim + line |
| 730 | delim = b"" |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 731 | if line.startswith(b"--") and last_line_lfend: |
| 732 | strippedline = line.rstrip() |
| 733 | if strippedline == next_boundary: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 734 | break |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 735 | if strippedline == last_boundary: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 736 | self.done = 1 |
| 737 | break |
| 738 | odelim = delim |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 739 | if line.endswith(b"\r\n"): |
| 740 | delim = b"\r\n" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 741 | line = line[:-2] |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 742 | last_line_lfend = True |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 743 | elif line.endswith(b"\n"): |
| 744 | delim = b"\n" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 745 | line = line[:-1] |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 746 | last_line_lfend = True |
Serhiy Storchaka | c7bfe0e | 2013-06-17 16:34:41 +0300 | [diff] [blame] | 747 | elif line.endswith(b"\r"): |
| 748 | # We may interrupt \r\n sequences if they span the 2**16 |
| 749 | # byte boundary |
| 750 | delim = b"\r" |
| 751 | line = line[:-1] |
| 752 | last_line_lfend = False |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 753 | else: |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 754 | delim = b"" |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 755 | last_line_lfend = False |
Guido van Rossum | 52b8c29 | 2001-06-29 13:06:06 +0000 | [diff] [blame] | 756 | self.__write(odelim + line) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 757 | |
| 758 | def skip_lines(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 759 | """Internal: skip lines until outer boundary if defined.""" |
| 760 | if not self.outerboundary or self.done: |
| 761 | return |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 762 | next_boundary = b"--" + self.outerboundary |
| 763 | last_boundary = next_boundary + b"--" |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 764 | last_line_lfend = True |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 765 | while True: |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 766 | line = self.fp.readline(1<<16) |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 767 | self.bytes_read += len(line) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 768 | if not line: |
| 769 | self.done = -1 |
| 770 | break |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 771 | if line.endswith(b"--") and last_line_lfend: |
Eric S. Raymond | 7e9b4f5 | 2001-02-09 09:59:10 +0000 | [diff] [blame] | 772 | strippedline = line.strip() |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 773 | if strippedline == next_boundary: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 774 | break |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 775 | if strippedline == last_boundary: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 776 | self.done = 1 |
| 777 | break |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 778 | last_line_lfend = line.endswith(b'\n') |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 779 | |
Guido van Rossum | a1a6852 | 2007-08-28 03:11:34 +0000 | [diff] [blame] | 780 | def make_file(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 781 | """Overridable: return a readable & writable file. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 782 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 783 | The file will be used as follows: |
| 784 | - data is written to it |
| 785 | - seek(0) |
| 786 | - data is read from it |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 787 | |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 788 | The file is opened in binary mode for files, in text mode |
| 789 | for other fields |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 790 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 791 | This version opens a temporary file for reading and writing, |
| 792 | and immediately deletes (unlinks) it. The trick (on Unix!) is |
| 793 | that the file can still be used, but it can't be opened by |
| 794 | another process, and it will automatically be deleted when it |
| 795 | is closed or when the current process terminates. |
Guido van Rossum | 4032c2c | 1996-03-09 04:04:35 +0000 | [diff] [blame] | 796 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 797 | If you want a more permanent file, you derive a class which |
| 798 | overrides this method. If you want a visible temporary file |
| 799 | that is nevertheless automatically deleted when the script |
| 800 | terminates, try defining a __del__ method in a derived class |
| 801 | which unlinks the temporary files you have created. |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 802 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 803 | """ |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 804 | if self._binary_file: |
| 805 | return tempfile.TemporaryFile("wb+") |
| 806 | else: |
| 807 | return tempfile.TemporaryFile("w+", |
| 808 | encoding=self.encoding, newline = '\n') |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 809 | |
Guido van Rossum | 243ddcd | 1996-03-07 06:33:07 +0000 | [diff] [blame] | 810 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 811 | # Test/debug code |
| 812 | # =============== |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 813 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 814 | def test(environ=os.environ): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 815 | """Robust test CGI script, usable as main program. |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 816 | |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 817 | Write minimal HTTP headers and dump all information provided to |
| 818 | the script in HTML form. |
| 819 | |
| 820 | """ |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 821 | print("Content-type: text/html") |
| 822 | print() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 823 | sys.stderr = sys.stdout |
| 824 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 825 | form = FieldStorage() # Replace with other classes to test those |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 826 | print_directory() |
| 827 | print_arguments() |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 828 | print_form(form) |
| 829 | print_environ(environ) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 830 | print_environ_usage() |
| 831 | def f(): |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 832 | exec("testing print_exception() -- <I>italics?</I>") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 833 | def g(f=f): |
| 834 | f() |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 835 | print("<H3>What follows is a test, not an actual exception:</H3>") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 836 | g() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 837 | except: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 838 | print_exception() |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 839 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 840 | print("<H1>Second try with a small maxlen...</H1>") |
Guido van Rossum | 57d51f2 | 2000-09-16 21:16:01 +0000 | [diff] [blame] | 841 | |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 842 | global maxlen |
| 843 | maxlen = 50 |
| 844 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 845 | form = FieldStorage() # Replace with other classes to test those |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 846 | print_directory() |
| 847 | print_arguments() |
Guido van Rossum | a3c6a8a | 2000-09-19 04:11:46 +0000 | [diff] [blame] | 848 | print_form(form) |
| 849 | print_environ(environ) |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 850 | except: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 851 | print_exception() |
Guido van Rossum | ad16471 | 1997-05-13 19:03:23 +0000 | [diff] [blame] | 852 | |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 853 | def print_exception(type=None, value=None, tb=None, limit=None): |
| 854 | if type is None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 855 | type, value, tb = sys.exc_info() |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 856 | import traceback |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 857 | print() |
| 858 | print("<H3>Traceback (most recent call last):</H3>") |
Guido van Rossum | f85de8a | 1996-08-20 20:22:39 +0000 | [diff] [blame] | 859 | list = traceback.format_tb(tb, limit) + \ |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 860 | traceback.format_exception_only(type, value) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 861 | print("<PRE>%s<B>%s</B></PRE>" % ( |
Georg Brandl | 1f7fffb | 2010-10-15 15:57:45 +0000 | [diff] [blame] | 862 | html.escape("".join(list[:-1])), |
| 863 | html.escape(list[-1]), |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 864 | )) |
Guido van Rossum | f15d159 | 1997-09-29 23:22:12 +0000 | [diff] [blame] | 865 | del tb |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 866 | |
Guido van Rossum | 773ab27 | 1996-07-23 03:46:24 +0000 | [diff] [blame] | 867 | def print_environ(environ=os.environ): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 868 | """Dump the shell environment as HTML.""" |
Guido van Rossum | a1a6852 | 2007-08-28 03:11:34 +0000 | [diff] [blame] | 869 | keys = sorted(environ.keys()) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 870 | print() |
| 871 | print("<H3>Shell Environment:</H3>") |
| 872 | print("<DL>") |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 873 | for key in keys: |
Georg Brandl | 1f7fffb | 2010-10-15 15:57:45 +0000 | [diff] [blame] | 874 | print("<DT>", html.escape(key), "<DD>", html.escape(environ[key])) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 875 | print("</DL>") |
| 876 | print() |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 877 | |
| 878 | def print_form(form): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 879 | """Dump the contents of a form as HTML.""" |
Guido van Rossum | a1a6852 | 2007-08-28 03:11:34 +0000 | [diff] [blame] | 880 | keys = sorted(form.keys()) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 881 | print() |
| 882 | print("<H3>Form Contents:</H3>") |
Guido van Rossum | 57d51f2 | 2000-09-16 21:16:01 +0000 | [diff] [blame] | 883 | if not keys: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 884 | print("<P>No form fields.") |
| 885 | print("<DL>") |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 886 | for key in keys: |
Georg Brandl | 1f7fffb | 2010-10-15 15:57:45 +0000 | [diff] [blame] | 887 | print("<DT>" + html.escape(key) + ":", end=' ') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 888 | value = form[key] |
Georg Brandl | 1f7fffb | 2010-10-15 15:57:45 +0000 | [diff] [blame] | 889 | print("<i>" + html.escape(repr(type(value))) + "</i>") |
| 890 | print("<DD>" + html.escape(repr(value))) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 891 | print("</DL>") |
| 892 | print() |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 893 | |
| 894 | def print_directory(): |
| 895 | """Dump the current directory as HTML.""" |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 896 | print() |
| 897 | print("<H3>Current Working Directory:</H3>") |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 898 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 899 | pwd = os.getcwd() |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 900 | except OSError as msg: |
Andrew Svetlov | 8b33dd8 | 2012-12-24 19:58:48 +0200 | [diff] [blame] | 901 | print("OSError:", html.escape(str(msg))) |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 902 | else: |
Georg Brandl | 1f7fffb | 2010-10-15 15:57:45 +0000 | [diff] [blame] | 903 | print(html.escape(pwd)) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 904 | print() |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 905 | |
Guido van Rossum | a8738a5 | 1996-03-14 21:30:28 +0000 | [diff] [blame] | 906 | def print_arguments(): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 907 | print() |
| 908 | print("<H3>Command Line Arguments:</H3>") |
| 909 | print() |
| 910 | print(sys.argv) |
| 911 | print() |
Guido van Rossum | a8738a5 | 1996-03-14 21:30:28 +0000 | [diff] [blame] | 912 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 913 | def print_environ_usage(): |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 914 | """Dump a list of environment variables used by CGI as HTML.""" |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 915 | print(""" |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 916 | <H3>These environment variables could have been set:</H3> |
| 917 | <UL> |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 918 | <LI>AUTH_TYPE |
| 919 | <LI>CONTENT_LENGTH |
| 920 | <LI>CONTENT_TYPE |
| 921 | <LI>DATE_GMT |
| 922 | <LI>DATE_LOCAL |
| 923 | <LI>DOCUMENT_NAME |
| 924 | <LI>DOCUMENT_ROOT |
| 925 | <LI>DOCUMENT_URI |
| 926 | <LI>GATEWAY_INTERFACE |
| 927 | <LI>LAST_MODIFIED |
| 928 | <LI>PATH |
| 929 | <LI>PATH_INFO |
| 930 | <LI>PATH_TRANSLATED |
| 931 | <LI>QUERY_STRING |
| 932 | <LI>REMOTE_ADDR |
| 933 | <LI>REMOTE_HOST |
| 934 | <LI>REMOTE_IDENT |
| 935 | <LI>REMOTE_USER |
| 936 | <LI>REQUEST_METHOD |
| 937 | <LI>SCRIPT_NAME |
| 938 | <LI>SERVER_NAME |
| 939 | <LI>SERVER_PORT |
| 940 | <LI>SERVER_PROTOCOL |
| 941 | <LI>SERVER_ROOT |
| 942 | <LI>SERVER_SOFTWARE |
| 943 | </UL> |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 944 | In addition, HTTP headers sent by the server may be passed in the |
| 945 | environment as well. Here are some common variable names: |
| 946 | <UL> |
| 947 | <LI>HTTP_ACCEPT |
| 948 | <LI>HTTP_CONNECTION |
| 949 | <LI>HTTP_HOST |
| 950 | <LI>HTTP_PRAGMA |
| 951 | <LI>HTTP_REFERER |
| 952 | <LI>HTTP_USER_AGENT |
| 953 | </UL> |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 954 | """) |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 955 | |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 956 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 957 | # Utilities |
| 958 | # ========= |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 959 | |
Benjamin Peterson | 4d59a78 | 2014-04-03 10:22:10 -0400 | [diff] [blame] | 960 | def valid_boundary(s): |
Guido van Rossum | 2e441f7 | 2001-07-25 21:00:19 +0000 | [diff] [blame] | 961 | import re |
Victor Stinner | 5c23b8e | 2011-01-14 13:05:21 +0000 | [diff] [blame] | 962 | if isinstance(s, bytes): |
| 963 | _vb_pattern = b"^[ -~]{0,200}[!-~]$" |
| 964 | else: |
| 965 | _vb_pattern = "^[ -~]{0,200}[!-~]$" |
Guido van Rossum | 2e441f7 | 2001-07-25 21:00:19 +0000 | [diff] [blame] | 966 | return re.match(_vb_pattern, s) |
Guido van Rossum | 9a22de1 | 1995-01-12 12:29:47 +0000 | [diff] [blame] | 967 | |
Guido van Rossum | 7275561 | 1996-03-06 07:20:06 +0000 | [diff] [blame] | 968 | # Invoke mainline |
| 969 | # =============== |
| 970 | |
| 971 | # 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] | 972 | if __name__ == '__main__': |
Guido van Rossum | 7aee384 | 1996-03-07 18:00:44 +0000 | [diff] [blame] | 973 | test() |