YfΌ @ sO d Z d Z d d l m Z m Z m Z d d l m Z d d l Z d d l Z d d l
Z d d l m
Z
d d l m Z d d l m Z d d l Z d d l Z d d l Z d d
d d d
d d d d d d d d d g Z d a d a d d Z d d Z d d Z d d Z e a d a d e j d d d d Z d d d! d Z d d d" d
Z! d# d Z" d$ d% Z# d& d Z$ Gd' d d Z% Gd( d
d
Z& e j d) d* Z' d d d d d+ d Z( e j d, d Z) d- d Z* d. d Z+ d/ d Z, d0 d Z- d d1 d Z. d2 d3 Z/ e0 d4 k rKe' d S)5zSupport module for CGI (Common Gateway Interface) scripts.
This module defines a number of utilities for use by CGI scripts
written in Python.
z2.6 )StringIOBytesIO
TextIOWrapper)MappingN)
FeedParser)Message)warnMiniFieldStorage FieldStorageparseparse_qs parse_qslparse_multipart parse_headerprint_exception
print_environ
print_formprint_directoryprint_argumentsprint_environ_usageescape c G sX t r5 t r5 y t t d a Wn t k
r4 Yn Xt sD t a n t a t | d S)a Write a log message, if there is a log file.
Even though this function is called initlog(), you should always
use log(); log is a variable that is set either to initlog
(initially), to dolog (once the log file has been opened), or to
nolog (when logging is disabled).
The first argument is a format string; the remaining arguments (if
any) are arguments to the % operator, so e.g.
log("%s: %s", "a", "b")
will write "a: b" to the log file, followed by a newline.
If the global logfp is not None, it should be a file object to
which log data is written.
If the global logfp is None, the global logfile may be a string
giving a filename to open, in append mode. This file should be
world writable!!! If the file can't be opened, logging is
silently disabled (since there is no safe place where we could
send an error message).
aN)logfilelogfpopenOSErrornologlogdolog)allargs r! (/opt/alt/python35/lib64/python3.5/cgi.pyinitlog: s
r# c G s t j | | d d S)z=Write a log message to the log file. See initlog() for docs.
N)r write)Zfmtargsr! r! r" r ] s r c G s d S)z9Dummy function, assigned to log when logging is disabled.Nr! )r r! r! r" r a s r c C s& d a t r t j d a t a d S)zClose the log file.r N)r r closer# r r! r! r! r" closeloge s
r( c C s | d k r t j } t | d r0 | j } n d } t | t rN | j } d | k rd d | d <| d d k rlt | d \ } } | d k r t | | S| d k r t | d
} t
r | t
k r t d | j | j
| } n d } d
| k r+| r| d } | | d
} n4 t j d d r_| rN| d } | t j d } | | d
<nL d
| k r| d
} n3 t j d d rt j d } n d } | | d
<t j j | | | d | S)a' Parse a query in the environment or from a file (default stdin)
Arguments, all optional:
fp : file pointer; default: sys.stdin.buffer
environ : environment dictionary; default: os.environ
keep_blank_values: flag indicating whether blank values in
percent-encoded forms should be treated as blank strings.
A true value indicates that blanks should be retained as
blank strings. The default false value indicates that
blank values are to be ignored and treated as if they were
not included.
strict_parsing: flag indicating what to do with parsing errors.
If false (the default), errors are silently ignored.
If true, errors raise a ValueError exception.
Nencodingzlatin-1REQUEST_METHODGETPOST CONTENT_TYPEzmultipart/form-dataz!application/x-www-form-urlencodedCONTENT_LENGTHz Maximum content length exceededr QUERY_STRING& )sysstdinhasattrr)
isinstancer bufferr r intmaxlen
ValueErrorreaddecodeargvurllibr r ) fpenvironkeep_blank_valuesstrict_parsingr) ctypepdictclengthqsr! r! r" r x sH
c C s& t d t d t j j | | | S)z)Parse a query given as a string argument.z=cgi.parse_qs is deprecated, use urllib.parse.parse_qs instead )r DeprecationWarningr= r r )rE r@ rA r! r! r" r s
c C s& t d t d t j j | | | S)z)Parse a query given as a string argument.z?cgi.parse_qsl is deprecated, use urllib.parse.parse_qsl insteadrF )r rG r= r r
)rE r@ rA r! r! r" r
s
c C s d d l } d } d | k r( | d } t | sG t d | f d | } d | d } i } d } x!| | k rd } d } | r| j j | }
|
j d } | r y t | } Wn t k
r Yn X| d k rt r| t k rt d | j | } n d } g } xX | j }
|
s<| } P|
j
d rj|
j } | | | f k rjP| j |
q#W| d k rqn | d k r| r| d }
|
d d d k r|
d d }
n& |
d d d k r|
d d }
|
| d <d j
| } |
d
}
|
s!qn t |
\ } } | d k rBqn d | k rn | d } n qn | | k r~| | j | qn | g | | <qn W| S)a Parse multipart input.
Arguments:
fp : input file
pdict: dictionary containing other parameters of content-type header
Returns a dictionary just like parse_qs(): keys are the field names, each
value is a list of values for that field. This is easy to use but not
much good if you are expecting megabytes to be uploaded -- in that case,
use the FieldStorage class instead which is much more flexible. Note
that content-type is the raw, unparsed contents of the content-type
header.
XXX This does not parse nested multipart parts -- use FieldStorage for
that.
XXX This should really be subsumed by FieldStorage altogether -- no
point in having two implementations of the same parsing algorithm.
Also, FieldStorage protects itself better against certain DoS attacks
by limiting the size of the data read in one chunk. The API here
does not support that kind of protection. This also affects parse()
since it can call parse_multipart().
r N boundaryz&Invalid boundary in multipart form: %rs --r1 zcontent-lengthz Maximum content length exceededrF s
s
zcontent-dispositionz form-datanamerK rL rK rK rK )Z http.clientvalid_boundaryr9 ZclientZ
parse_headersgetr7 r8 r: readline
startswithrstripappendjoinr )r> rC ZhttprI ZnextpartZlastpartZpartdict
terminatorbytesdataheadersrD lineslinekeyZparamsrJ r! r! r" r s|
c c s x | d d d k r | d d } | j d } xR | d k r | j d d | | j d d | d r | j d | d } q; W| d k r t | } | d | } | j V| | d } q Wd S)Nr1 ;r "z\"rF )findcountlenstrip)sendfr! r! r" _parseparam- s ; rd c C s t d | } | j } i } x | D] } | j d } | d k r) | d | j j } | | d d j } t | d k r | d | d k o d k n r | d d } | j d d j d
d } | | | <q) W| | f S)
zfParse a Content-type like header.
Return the main content-type and a dictionary of options.
r[ =r Nr1 rF r\ z\\\z\"rK rK )rd __next__r] r` lowerr_ replace)rY partsrZ rC pirJ valuer! r! r" r 9 s
6 c @ s^ e Z d Z d Z d Z d Z d Z d Z i Z d Z i Z
i Z d d Z d d Z
d S)r z=Like FieldStorage, for use when no file uploads are possible.Nc C s | | _ | | _ d S)z&Constructor from field name and value.N)rJ rm )selfrJ rm r! r! r" __init___ s zMiniFieldStorage.__init__c C s d | j | j f S)z Return printable representation.zMiniFieldStorage(%r, %r))rJ rm )rn r! r! r" __repr__e s zMiniFieldStorage.__repr__)__name__
__module__ __qualname____doc__filenamelisttypefile type_options dispositiondisposition_optionsrW ro rp r! r! r! r" r Q s c @ sr e Z d Z d Z d d d e j d d d d d d d Z d d
Z d d Z d
d Z d d Z
d d Z d d Z d d Z
d d d Z d d d Z d d Z d d Z d d Z d! d" Z d# d$ Z d% d& Z d Z d' d( Z d) d* Z d; Z d- d. Z d/ d0 Z d1 d2 Z d3 d4 Z d5 d6 Z d7 d8 Z d9 d: Z d S)<r
a Store a sequence of fields, reading multipart/form-data.
This class provides naming, typing, files stored on disk, and
more. At the top level, it is accessible like a dictionary, whose
keys are the field names. (Note: None can occur as a field name.)
The items are either a Python list (if there's multiple values) or
another FieldStorage or MiniFieldStorage object. If it's a single
object, it has the following attributes:
name: the field name, if specified; otherwise None
filename: the filename, if specified; otherwise None; this is the
client side filename, *not* the file name on which it is
stored (that's a temporary file you don't deal with)
value: the value as a *string*; for file uploads, this
transparently reads the file every time you request the value
and returns *bytes*
file: the file(-like) object from which you can read the data *as
bytes* ; None if the data is stored a simple string
type: the content-type, or None if not specified
type_options: dictionary of options specified on the content-type
line
disposition: content-disposition, or None if not specified
disposition_options: dictionary of corresponding options
headers: a dictionary(-like) object (sometimes email.message.Message or a
subclass thereof) containing *all* headers
The class is subclassable, mostly for the purpose of overriding
the make_file() method, which is called internally to come up with
a file open for reading and writing. This makes it possible to
override the default choice of storing all files in a temporary
directory and unlinking them as soon as they have been opened.
NrH r zutf-8ri c
C sh d }
| | _ | | _ d | k r4 | d j }
d | _ |
d k sU |
d k r d | k rn | d } n) t j d d r t j d } n d } | j t j d } t | } | d k r d d
i } | d k rKi } |
d k r d
| d <d | k r| d | d <d | k r.| d | _ d
| k rl| d
| d <n! t
| t t f slt
d | | _ | d k rt j j | _ nQ t
| t r| j | _ n3 t | d ot | d st
d | | _ | | _ | | _ t
| t s t
d t | j | | _ d | _ | | _ d i } }
d | j k rnt | j d \ } }
| | _ |
| _ d | _ d |
k r|
d | _ d | _ d |
k r|
d | _ | j d k | _! d | j k rt | j d \ } }
n2 | j s|
d k r&d i } }
n
d
i } }
| | _ |
| _" d |
k rm|
d j | j | _# n d | _# d } d | j k ry t$ | j d } Wn t% k
rYn Xt& r| t& k rt% d | | _' | j d k r| r| | _ d | _( | _) d | _* | d
k r.| j+ n6 | d d d k rZ| j, | | | n
| j- d S) a Constructor. Read multipart/* until last part.
Arguments, all optional:
fp : file pointer; default: sys.stdin.buffer
(not used when the request method is GET)
Can be :
1. a TextIOWrapper object
2. an object whose read() and readline() methods return bytes
headers : header dictionary-like object; default:
taken from environ as per CGI spec
outerboundary : terminating multipart boundary
(for internal use only)
environ : environment dictionary; default: os.environ
keep_blank_values: flag indicating whether blank values in
percent-encoded forms should be treated as blank strings.
A true value indicates that blanks should be retained as
blank strings. The default false value indicates that
blank values are to be ignored and treated as if they were
not included.
strict_parsing: flag indicating what to do with parsing errors.
If false (the default), errors are silently ignored.
If true, errors raise a ValueError exception.
limit : used internally to read parts of multipart/form-data forms,
to exit from the reading loop when reached. It is the difference
between the form content-length and the number of bytes already
read
encoding, errors : the encoding and error handler used to decode the
binary stream to strings. Must be the same as the charset defined
for the page sending the form (content-type : meta http-equiv or
header)
r+ r* NZHEADr/ r1 r surrogateescapez content-typez!application/x-www-form-urlencodedr, r- r. zcontent-lengthz?headers must be mapping or an instance of email.message.Messager: rO zfp must be file pointerz#outerboundary must be bytes, not %sr zcontent-dispositionrJ ru z
text/plainrI rH z Maximum content length exceeded
z
multipart/rK ).r@ rA upper
qs_on_postr2 r< encodelocalegetpreferredencodingr r5 r r TypeErrorrW r3 r6 r> r r4 r) errorsrU rw rq
outerboundary
bytes_readlimitr rz r{ rJ ru _binary_filery
innerboundaryr7 r9 r8 lengthrv rx doneread_urlencoded
read_multi read_single)rn r> rW r r? r@ rA r r) r methodrE ZcdisprC rB Zclenr! r! r" ro s +
zFieldStorage.__init__c C s* y | j j Wn t k
r% Yn Xd S)N)rx r' AttributeError)rn r! r! r" __del__3 s
zFieldStorage.__del__c C s | S)Nr! )rn r! r! r" __enter__9 s zFieldStorage.__enter__c G s | j j d S)N)rx r' )rn r& r! r! r" __exit__< s zFieldStorage.__exit__c C s d | j | j | j f S)z"Return a printable representation.zFieldStorage(%r, %r, %r))rJ ru rm )rn r! r! r" rp ? s zFieldStorage.__repr__c C s t | j S)N)iterkeys)rn r! r! r" __iter__D s zFieldStorage.__iter__c C sx | d k r t | | j rS | j j d | j j } | j j d n! | j d k rn | j } n d } | S)Nrm r )r rx seekr: rv )rn rJ rm r! r! r" __getattr__G s zFieldStorage.__getattr__c C s | j d k r t d g } x- | j D]" } | j | k r+ | j | q+ W| sc t | t | d k r} | d S| Sd S)zDictionary style indexing.Nz
not indexabler1 r )rv r rJ rR KeyErrorr_ )rn rZ founditemr! r! r" __getitem__T s zFieldStorage.__getitem__c C sH | | k r@ | | } t | t r6 d d | D S| j Sn | Sd S)z8Dictionary style get() method, including 'value' lookup.c S s g | ] } | j q Sr! )rm ).0xr! r! r"
<listcomp>g s z)FieldStorage.getvalue.<locals>.<listcomp>N)r5 rv rm )rn rZ defaultrm r! r! r" getvalueb s
zFieldStorage.getvaluec C sB | | k r: | | } t | t r0 | d j S| j Sn | Sd S)z! Return the first value received.r N)r5 rv rm )rn rZ r rm r! r! r" getfirstm s
zFieldStorage.getfirstc C sK | | k rC | | } t | t r6 d d | D S| j g Sn g Sd S)z Return list of received values.c S s g | ] } | j q Sr! )rm )r r r! r! r" r } s z(FieldStorage.getlist.<locals>.<listcomp>N)r5 rv rm )rn rZ rm r! r! r" getlistx s
zFieldStorage.getlistc C s; | j d k r t d t t d d | j D S)z Dictionary style keys() method.Nz
not indexablec s s | ] } | j Vq d S)N)rJ )r r r! r! r" <genexpr> s z$FieldStorage.keys.<locals>.<genexpr>)rv r set)rn r! r! r" r s zFieldStorage.keysc s; | j d k r t d t f d d | j D S)z%Dictionary style __contains__ method.Nz
not indexablec 3 s | ] } | j k Vq d S)N)rJ )r r )rZ r! r" r s z,FieldStorage.__contains__.<locals>.<genexpr>)rv r any)rn rZ r! )rZ r" __contains__ s zFieldStorage.__contains__c C s t | j S)z Dictionary style len(x) support.)r_ r )rn r! r! r" __len__ s zFieldStorage.__len__c C s( | j d k r t d t | j S)Nz Cannot be converted to bool.)rv r bool)rn r! r! r" __bool__ s zFieldStorage.__bool__c C s | j j | j } t | t sF t d | j t | j f | j | j | j
} | j rx | d | j 7} g | _ t
j j | | j | j d | j d | j
} x- | D]% \ } } | j j t | | q W| j d S)z+Internal: read data in query string format.z %s should return bytes, got %sr0 r) r N)r> r: r r5 rU r9 rw rq r; r) r r rv r= r r
r@ rA rR r
skip_lines)rn rE queryrZ rm r! r! r" r s z FieldStorage.read_urlencodedc
C s~ | j } t | s( t d | f g | _ | j r t j j | j | j | j d | j
d | j } x- | D]% \ } } | j j t
| | qt W| j p | j } | j j } t | t s t d | j t | j f | j t | 7_ xG | j d | j k rM| rM| j j } | j t | 7_ qWx t }
d } x* | j j } | | 7} | j scPqcW| sP| j t | 7_ |
j | j | j
| j |
j }
d |
k r|
d =| | j |
| | | | | j | j | j
| j } | j | j 7_ | j j | | j sk| j | j k ofd k n rQPqQW| j d S)
z/Internal: read a part that is itself multipart.z&Invalid boundary in multipart form: %rr) r z %s should return bytes, got %ss --rH zcontent-lengthr N)!r rM r9 rv r r= r r
r@ rA r) r rR r FieldStorageClass __class__r> rO r5 rU rw rq r r_ r` r Zfeedr; r' r r r r )rn r? r@ rA Zibr rZ rm klassZ
first_lineparserZhdr_textrV rW partr! r! r" r sV
+zFieldStorage.read_multic C sD | j d k r& | j | j n
| j | j j d d S)z Internal: read an atomic part.r N)r read_binaryr
read_linesrx r )rn r! r! r" r s
zFieldStorage.read_single i c C s | j | _ | j } | d k r x | d k r | j j t | | j } t | t s t d | j t
| j f | j t
| 7_ | s d | _ P| j j | | t
| } q' Wd S)zInternal: read binary data.r z %s should return bytes, got %sr1 NrK ) make_filerx r r> r: minbufsizer5 rU r9 rw rq r r_ r r% )rn ZtodorV r! r! r" r s zFieldStorage.read_binaryc C sV | j r t | _ | _ n t | _ | _ | j rH | j n
| j d S)z0Internal: read lines until EOF or outerboundary.N)r r rx _FieldStorage__filer r read_lines_to_outerboundaryread_lines_to_eof)rn r! r! r" r s
zFieldStorage.read_linesc C s | j d k re | j j t | d k re | j | _ | j j } | j j | d | _ | j r | j j | n" | j j | j | j | j
d S)z line is always bytes, not stringNi ) r tellr_ r rx r r% r r; r) r )rn rY rV r! r! r" Z__write s zFieldStorage.__writec C sO xH | j j d } | j t | 7_ | s: d | _ P| j | q Wd S)z Internal: read lines until EOF.r1 Ni rK )r> rO r r_ r _FieldStorage__write)rn rY r! r! r" r s z FieldStorage.read_lines_to_eofc C s d | j } | d } d } d } d } xh| | j k r< P| j j d
} | j t | 7_ | t | 7} | s d | _ P| d k r | | } d } | j d r | r | j } | | k r P| | k r d | _ P| } | j d rd } | d d } d } nh | j d rEd } | d d } d } n: | j d rsd } | d d } d } n d } d } | j
| | q, Wd S)zInternal: read lines until outerboundary.
Data is read as bytes: boundaries and line ends must be converted
to bytes for comparisons.
s --rH Tr r1 r s
s
NrF s
Fi rK rL rK rK ) r r r> rO r r_ r rP rQ endswithr ) rn
next_boundary
last_boundaryZdelimlast_line_lfendZ_readrY strippedlineZodelimr! r! r" r ! sP
z(FieldStorage.read_lines_to_outerboundaryc C s | j s | j r d Sd | j } | d } d } x | j j d } | j t | 7_ | sn d | _ P| j d r | r | j } | | k r P| | k r d | _ P| j d } q7 Wd S) z5Internal: skip lines until outer boundary if defined.Ns --Tr1 r s
i rK )r r r> rO r r_ r r` )rn r r r rY r r! r! r" r R s&
zFieldStorage.skip_linesc C s6 | j r t j d St j d d | j d d Sd S)a Overridable: return a readable & writable file.
The file will be used as follows:
- data is written to it
- seek(0)
- data is read from it
The file is opened in binary mode for files, in text mode
for other fields
This version opens a temporary file for reading and writing,
and immediately deletes (unlinks) it. The trick (on Unix!) is
that the file can still be used, but it can't be opened by
another process, and it will automatically be deleted when it
is closed or when the current process terminates.
If you want a more permanent file, you derive a class which
overrides this method. If you want a visible temporary file
that is nevertheless automatically deleted when the script
terminates, try defining a __del__ method in a derived class
which unlinks the temporary files you have created.
zwb+zw+r) newliner$ N)r tempfileZ
TemporaryFiler) )rn r! r! r" r h s
zFieldStorage.make_filei )!rq rr rs rt osr? ro r r r rp r r r r r r r r r r r r r r r r r r r r r r r! r! r! r" r
j s< *
6
1 c C s t d t t j t _ yb t } t t t | t | t d d } | d d } t d | Wn t
Yn Xt d d a y/ t } t t t | t | Wn t
Yn Xd S)
zRobust test CGI script, usable as main program.
Write minimal HTTP headers and dump all information provided to
the script in HTML form.
zContent-type: text/htmlc S s t d d S)Nz,testing print_exception() -- <I>italics?</I>)execr! r! r! r" rc s ztest.<locals>.fc S s | d S)Nr! )rc r! r! r" g s ztest.<locals>.gz9<H3>What follows is a test, not an actual exception:</H3>z*<H1>Second try with a small maxlen...</H1>2 N) printr2 stdoutstderrr
r r r r r r r8 )r? formrc r r! r! r" test s4
r c C s | d k r! t j \ } } } d d l } t t d | j | | | j | | } t d t j d j | d d t j | d f ~ d S)Nr z+<H3>Traceback (most recent call last):</H3>z<PRE>%s<B>%s</B></PRE>r r1 rK rK ) r2 exc_info tracebackr format_tbformat_exception_onlyhtmlr rS )rw rm tbr r rv r! r! r" r s
c C s| t | j } t t d t d x7 | D]/ } t d t j | d t j | | q4 Wt d t d S)z#Dump the shell environment as HTML.z<H3>Shell Environment:</H3>z<DL>z<DT>z<DD>z</DL>N)sortedr r r r )r? r rZ r! r! r" r s
-
c C s t | j } t t d | s3 t d t d x} | D]u } t d t j | d d d | | } t d t j t t | d t d
t j t | qD Wt d t d S)
z$Dump the contents of a form as HTML.z<H3>Form Contents:</H3>z<P>No form fields.z<DL>z<DT>:rb z<i>z</i>z<DD>z</DL>N)r r r r r reprrw )r r rZ rm r! r! r" r s
!
'!
c C s t t d y t j } WnA t k
rd } z! t d t j t | WYd d } ~ Xn Xt t j | t d S)z#Dump the current directory as HTML.z#<H3>Current Working Directory:</H3>zOSError:N)r r getcwdr r r str)pwdmsgr! r! r" r s
/c C s0 t t d t t t j t d S)Nz <H3>Command Line Arguments:</H3>)r r2 r< r! r! r! r" r s
c C s t d d S)z9Dump a list of environment variables used by CGI as HTML.a
<H3>These environment variables could have been set:</H3>
<UL>
<LI>AUTH_TYPE
<LI>CONTENT_LENGTH
<LI>CONTENT_TYPE
<LI>DATE_GMT
<LI>DATE_LOCAL
<LI>DOCUMENT_NAME
<LI>DOCUMENT_ROOT
<LI>DOCUMENT_URI
<LI>GATEWAY_INTERFACE
<LI>LAST_MODIFIED
<LI>PATH
<LI>PATH_INFO
<LI>PATH_TRANSLATED
<LI>QUERY_STRING
<LI>REMOTE_ADDR
<LI>REMOTE_HOST
<LI>REMOTE_IDENT
<LI>REMOTE_USER
<LI>REQUEST_METHOD
<LI>SCRIPT_NAME
<LI>SERVER_NAME
<LI>SERVER_PORT
<LI>SERVER_PROTOCOL
<LI>SERVER_ROOT
<LI>SERVER_SOFTWARE
</UL>
In addition, HTTP headers sent by the server may be passed in the
environment as well. Here are some common variable names:
<UL>
<LI>HTTP_ACCEPT
<LI>HTTP_CONNECTION
<LI>HTTP_HOST
<LI>HTTP_PRAGMA
<LI>HTTP_REFERER
<LI>HTTP_USER_AGENT
</UL>
N)r r! r! r! r" r s 'c C se t d t d d | j d d } | j d d } | j d d } | ra | j d
d } | S) zDeprecated API.z1cgi.escape is deprecated, use html.escape instead
stacklevelrF r0 z&<z<>z>r\ z")r rG ri )ra Zquoter! r! r" r s
c C s: d d l } t | t r$ d } n d } | j | | S)Nr s ^[ -~]{0,200}[!-~]$z^[ -~]{0,200}[!-~]$)rer5 rU match)ra r Z _vb_patternr! r! r" rM ( s
rM __main__)1rt __version__ior r r collectionsr r2 r Z urllib.parser= Z email.parserr Z
email.messager warningsr r r r __all__r r r# r r r( r r8 r? r r r
r rd r r r
r r r r r r r r rM rq r! r! r! r" <module> s\ # E d "' /