/usr/lib/python3/dist-packages/twisted/web/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/web/__pycache__/http.cpython-310.pyc (96675B)
o
pj @ s d Z g dZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl m
Z
ddlmZmZmZmZ ddlmZmZmZ ddlmZmZm Z m Z ddl m Z dd l m!Z!m"Z"m#Z# dd
l$m%Z% dd l&m'Z' dd l(m)Z) dd
l*m+Z+ ddl,m-Z-m.Z. ddl/m0Z0 ddl1m2Z2m3Z3m4Z4 ddl5m6Z6 ddl7m8Z8 ddl9m:Z: ddl;m
Z>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZPmQZQmRZRmSZSmTZTmUZUmVZVmWZWmXZXmYZYmZZZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZambZbmcZcmdZdmeZemfZfmgZg ddlhmiZimjZj ddlkmlZlmmZmmnZn z
ddlompZp dZqW n ery, dZqY nw dZsdZtd Zue`Zvg d Zwg d Zxd d ewD Zyd!d exD Zzd"d# Z{d$d% Zdkd&d'Z|dld(d)Z}dld*d+Z~d,d- Zd.d/ Zd0d1 Zd2ed3efd4d5Zd2ed3efd6d7Zd8ed3eeef fd9d:Zd;d< ZG d=d> d>eZG d?d@ d@ZG dAdB dBe-jZdCZe ZdDdE ZedFZe e"jeG dGdH dHZG dIdJ dJeZG dKdL dLeZG dMdN dNeZG dOdP dPZdQZdRZ G dSdT dTZe e"jG dUdV dVZe e"je"je"jG dWdX dXe-je.jZdYdZ Ze eld[d\ Ze e"jG d]d^ d^ZG d_d` d`e6endaZe eldbdc ZG ddde dee6e)dfZdgdh ZG didj dje#jZdS )ma
HyperText Transfer Protocol implementation.
This is the basic server-side protocol implementation used by the Twisted
Web server. It can parse HTTP 1.0 requests and supports many HTTP 1.1
features as well. Additionally, some functionality implemented here is
also useful for HTTP clients (such as the chunked encoding parser).
@var CACHED: A marker value to be returned from cache-related request methods
to indicate to the caller that a cached response will be usable and no
response body should be generated.
@var FOUND: An HTTP response code indicating a temporary redirect.
@var NOT_MODIFIED: An HTTP response code indicating that a requested
pre-condition (for example, the condition represented by an
I{If-Modified-Since} header is present in the request) has succeeded. This
indicates a response body cached by the client can be used.
@var PRECONDITION_FAILED: An HTTP response code indicating that a requested
pre-condition (for example, the condition represented by an I{If-None-Match}
header is present in the request) has failed. This should typically
indicate that the server has not taken the requested action.
@var maxChunkSizeLineLength: Maximum allowable length of the CRLF-terminated
line that indicates the size of a chunk and the extensions associated with
it, as in the HTTP 1.1 chunked I{Transfer-Encoding} (RFC 7230 section 4.1).
This limits how much data may be buffered when decoding the line.
)= SWITCHINGOKCREATEDACCEPTED NON_AUTHORITATIVE_INFORMATION
NO_CONTENT
RESET_CONTENTPARTIAL_CONTENT MULTI_STATUSMULTIPLE_CHOICEMOVED_PERMANENTLYFOUND SEE_OTHER NOT_MODIFIED USE_PROXYTEMPORARY_REDIRECTPERMANENT_REDIRECT BAD_REQUEST UNAUTHORIZEDPAYMENT_REQUIRED FORBIDDEN NOT_FOUND NOT_ALLOWEDNOT_ACCEPTABLEPROXY_AUTH_REQUIREDREQUEST_TIMEOUTCONFLICTGONELENGTH_REQUIREDPRECONDITION_FAILEDREQUEST_ENTITY_TOO_LARGEREQUEST_URI_TOO_LONGUNSUPPORTED_MEDIA_TYPE REQUESTED_RANGE_NOT_SATISFIABLEEXPECTATION_FAILEDINTERNAL_SERVER_ERRORNOT_IMPLEMENTED BAD_GATEWAYSERVICE_UNAVAILABLEGATEWAY_TIMEOUTHTTP_VERSION_NOT_SUPPORTEDINSUFFICIENT_STORAGE_SPACE NOT_EXTENDED RESPONSESCACHEDurlparseparse_qsdatetimeToStringdatetimeToLogStringtimegmstringToDatetimetoChunk fromChunkparseContentRangeStringTransport
HTTPClient
NO_BODY_CODESRequestPotentialDataLoss HTTPChannel HTTPFactory N)BytesIO)AnyStrCallableOptionalTuple)ParseResultBytesunquote_to_bytesr. ) Attribute Interface implementerprovider)Version)address
interfacesprotocol) _PullToPush)Deferred) IProtocol)Logger)basicpolicies)log) _PY37PLUS nativeString
networkString)proxyForInterface)
deprecated)Failure),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 r r r r r r r r" r r, r
r' r r r r! r )Headers_sanitizeLinearWhitespace)IAccessLogFormatterINonQueuedRequestFactoryIRequest) H2ConnectionTF< zHTTP/1.1zMagic constant returned by http.Request methods to set cache
validation headers when the request is conditional and the value fails
the condition.)MonTueWedThuFriSatSun)
NJanFebMarAprMayJunJulAugSepOctNovDecc C g | ]}| qS lower.0namerv rv 2/usr/lib/python3/dist-packages/twisted/web/http.py
r} c C s g | ]}|o | qS rv rw ry rv rv r| r} s c C s8 t | d\}}|d}dd | D }||fS )Ncharmapc S s i | ]
\}}|| d qS )r encoderz xyrv rv r|
z _parseHeader..)cgi parse_headerdecoder items)linekeypdictrv rv r| _parseHeader s
r c C st t | tr tdt| \}}}}}}t |tr1|d}|d}|d}|d}|d}t||||||S )a
Parse an URL into six components.
This is similar to C{urlparse.urlparse}, but rejects C{str} input
and always produces C{bytes} output.
@type url: C{bytes}
@raise TypeError: The given url was a C{str} string instead of a
C{bytes}.
@return: The scheme, net location, path, params, query string, and fragment
of the URL - all as C{bytes}.
@rtype: C{ParseResultBytes}
z url must be bytes, not unicodeascii)
isinstancestr TypeError _urlparser rD )urlschemenetlocpathparamsqueryfragmentrv rv r| r. s
r. c C s i }dd | dD }|D ]>}z
| dd\}}W n ty& |r$ Y qw |s+|rLt|dd}t|dd}||v rG|| | q|g||< q|S )zn
Like C{cgi.parse_qs}, but with support for parsing byte strings on Python 3.
@type qs: C{bytes}
c S s g | ] }| d D ]}|q qS ) ;)split)rz s1s2rv rv r| r} s z parse_qs.. & = + )r
ValueErrorunquotereplaceappend)qskeep_blank_valuesstrict_parsingdr itemkvrv rv r| r/
s$
r/ c C sR | dkrt } t | \ }}}}}}}}} tdt| |t| ||||f }
|
S )zT
Convert seconds since epoch to HTTP datetime string.
@rtype: C{bytes}
Nz#%s, %02d %3s %4d %02d:%02d:%02d GMT)timegmtimerW weekdayname monthname msSinceEpochyearmonthdayhhmmsswdr zsrv rv r| r0 # s r0 c C sH | dkrt } t | \ }}}}}}}}} d|t| ||||f }
|
S )zQ
Convert seconds since epoch to log datetime string.
@rtype: C{str}
Nz#[%02d/%3s/%4d:%02d:%02d:%02d +0000])r r r r rv rv r| r1 3 s r1 c C s d}| |k r
t d|f d| krdksJ J d| | t|| }td|D ] }|tj| }q,|dkrCt| rC|d }|| d }|d | } | d | }
|
d | } | S ) z?
Convert time tuple in GMT to seconds since epoch, GMT
i z Years prior to %d not supportedr im ra )r calendarleapdaysrangemdaysisleap) r r r hourminutesecondEPOCHdaysihoursminutessecondsrv rv r| r2 G s r2 c
C s~ t | }|d dd tvr#ztd| W S ty" Y nw t|}|dks/|dkrF|d rF|d }|d }|d }|d }nR|dksN|dkr{|d d d
kr{|d d \}}}|d }t |}|d k rr|d }n&|d
k rz|d }n t|dkr|d }|d }|d }|d }ntd| t |}t t
| }t |}t t |d\}}} t t
|||||| S )zt
Convert an HTTP date string (one of three formats) to seconds since epoch.
@type dateString: C{bytes}
r> s Sun, r r -E i d il zUnknown datetime format %r:)rV r rx weekdayname_lowerr3 r lenisdigitfindintmonthname_lowerindexmapr2 )
dateStringpartspartlenr r r r r minsecrv rv r| r3 [ sB
"
r3 c C s t t| dd| dfS )z
Convert string to a chunk.
@type data: C{bytes}
@returns: a tuple of C{bytes} representing the chunked encoding of data
r
)rW r datarv rv r| r4 s r4 breturnc C s | D ] }|dvr dS q| dkS )z
Is the string case-insensitively hexidecimal?
It must be composed of one or more characters in the ranges a-f, A-F
and 0-9.
s 0123456789abcdefABCDEFF rv )r crv rv r| _ishexdigits s
r c C s t | st| t| dS )z
Decode a hexadecimal integer.
Unlike L{int(b, 16)}, this raises L{ValueError} when the integer has
a prefix like C{b'0x'}, C{b'+'}, or C{b'-'}, which is desirable when
parsing network protocols.
)r r r )r rv rv r| _hexint s
r r c C sf | dd\}}t|}|dk rtd|f |||d dkr%td|d| ||d d fS )aA
Convert chunk to string.
Note that this function is not specification compliant: it doesn't handle
chunk extensions.
@type data: C{bytes}
@return: tuple of (result, remaining) - both C{bytes}.
@raise ValueError: If the given data is not a correctly formatted chunked
byte string.
r r r> z!Chunk length must be >= 0, not %dr zchunk must end with CRLFN)r r r )r prefixrestlengthrv rv r| r5 s r5 c C sf | \}}| dkrtd|d\}}tt|d\}}|dkr*d}nt|}|||fS )z
Parse a content-range header into (start, end, realLength).
realLength might be None if real length is not known ('*').
bytesz#a range of type %r is not supported/r *N)stripr rx r r r )headerkindotherstartend
realLengthstartendrv rv r| r6 s
r6 c @ st e Zd ZdZedZedZdd Zdd Zdd Z d
d Z
d d
Z de de
fddZde de
fddZdd ZdS ))_IDeprecatedHTTPChannelToRequestInterfacez=
The interface L{HTTPChannel} expects of L{Request}.
zLA L{http_headers.Headers} instance giving all received HTTP request headers.zPA L{http_headers.Headers} instance holding all HTTP response headers to be sent.c C dS )z
The underlying connection has been lost.
@param reason: A failure instance indicating the reason why
the connection was lost.
@type reason: L{twisted.python.failure.Failure}
Nrv )reasonrv rv r| connectionLost z8_IDeprecatedHTTPChannelToRequestInterface.connectionLostc C r )a
Called when L{HTTPChannel} has determined the length, if any,
of the incoming request's body.
@param length: The length of the request's body.
@type length: L{int} if the request declares its body's length
and L{None} if it does not.
Nrv r rv rv r| gotLength r z3_IDeprecatedHTTPChannelToRequestInterface.gotLengthc C r )z
Deliver a received chunk of body data to the request. Note
this does not imply chunked transfer encoding.
@param data: The received chunk.
@type data: L{bytes}
Nrv r rv rv r| handleContentChunk r z<_IDeprecatedHTTPChannelToRequestInterface.handleContentChunkc C r )zF
Parse the request's cookies out of received headers.
Nrv rv rv rv r| parseCookies r z6_IDeprecatedHTTPChannelToRequestInterface.parseCookiesc C r )a
Called when the entire request, including its body, has been
received.
@param command: The request's HTTP command.
@type command: L{bytes}
@param path: The request's path. Note: this is actually what
RFC7320 calls the URI.
@type path: L{bytes}
@param version: The request's HTTP version.
@type version: L{bytes}
Nrv )commandr versionrv rv r| requestReceived r z9_IDeprecatedHTTPChannelToRequestInterface.requestReceivedr r c C r )a
Determines if two requests are the same object.
@param other: Another object whose identity will be compared
to this instance's.
@return: L{True} when the two are the same object and L{False}
when not.
Nrv r rv rv r| __eq__ r z0_IDeprecatedHTTPChannelToRequestInterface.__eq__c C r )a
Determines if two requests are not the same object.
@param other: Another object whose identity will be compared
to this instance's.
@return: L{True} when the two are not the same object and
L{False} when they are.
Nrv r rv rv r| __ne__+ r z0_IDeprecatedHTTPChannelToRequestInterface.__ne__c C r )z{
Generate a hash value for the request.
@return: The request's hash value.
@rtype: L{int}
Nrv rv rv rv r| __hash__6 r z2_IDeprecatedHTTPChannelToRequestInterface.__hash__N)__name__
__module__ __qualname____doc__rF requestHeadersresponseHeadersr r r r r objectboolr
r r rv rv rv r| r s
r c @ ( e Zd ZdZdd Zdd Zdd ZdS ) r7 zo
I am a BytesIO wrapper that conforms for the transport API. I support
the `writeSequence' method.
c C s t | _d S N)r? r selfrv rv r| __init__E zStringTransport.__init__c C s | j d| d S )Nr )r writejoin)r seqrv rv r|
writeSequenceH s z StringTransport.writeSequencec C s t | jd |S )Nr )getattr__dict__)r attrrv rv r| __getattr__K zStringTransport.__getattr__N)r
r r r r r r" rv rv rv r| r7 ? s
r7 c @ s e Zd ZdZdZdZdZdZdd Zdd Z d d
Z
d d Z d
d Z dd Z
dd Zdd Zdd Zdd Zdd Zdd Zd d ZdS ) r8 a@
A client for HTTP 1.0.
Notes:
You probably want to send a 'Host' header with the name of the site you're
connecting to, in order to not break name based virtual hosting.
@ivar length: The length of the request body in bytes.
@type length: C{int}
@ivar firstLine: Are we waiting for the first header line?
@type firstLine: C{bool}
@ivar __buffer: The buffer that stores the response to the HTTP request.
@type __buffer: A C{BytesIO} object.
@ivar _header: Part or all of an HTTP request header.
@type _header: C{bytes}
NTr c C s | j |d|dg d S )Nr s HTTP/1.0
transportr )r r r rv rv r| sendCommandi s zHTTPClient.sendCommandc C s> t |ts tt|}t|}t|}| j|d|dg d S )N : r )r r rW r r\ r% r )r r{ value santizedName
santizedValuerv rv r|
sendHeaderl s
zHTTPClient.sendHeaderc C s | j d d S )Nr r% r r rv rv r|
endHeaderst r# zHTTPClient.endHeadersc C sB | dd\}}| }| || | dkr t|| _dS dS )z
Given a complete HTTP header, extract the field name and value and
process the header.
@param header: a complete HTTP request header of the form
'field-name: value'.
@type header: C{bytes}
:r content-lengthN)r lstrip handleHeaderrx r r )r r r valrv rv r|
extractHeaderw s zHTTPClient.extractHeaderc C s | j r/d| _ |dd}|d }|d }z|d }W n ty% d}Y nw | ||| dS |sJ| jdkr<| | j t | _| | dS |
dsT|
dr\| j| | _dS | jrj| | j || _dS || _dS ) z
Parse the status line and headers for an HTTP request.
@param line: Part of an HTTP request header. Request bodies are parsed
in L{HTTPClient.rawDataReceived}.
@type line: C{bytes}
FNr r> r r r ) firstLiner
IndexError handleStatus_headerr3 r? _HTTPClient__bufferhandleEndHeaders
setRawMode
startswith)r r lr statusmessagerv rv r| lineReceived s2
zHTTPClient.lineReceivedc C s | d S r )handleResponseEnd)r r rv rv r| r r zHTTPClient.connectionLostc C s, | j dur| j }d| _ | | dS dS )z~
The response has been completely received.
This callback may be invoked more than once per request.
N)r9 getvaluehandleResponse)r r rv rv r| rA s
z HTTPClient.handleResponseEndc C s | j | d S r )r9 r r r rv rv r| handleResponsePart r# z HTTPClient.handleResponsePartc C d S r rv r rv rv r| connectionMade s zHTTPClient.connectionMadec C r )z
Called when the status-line is received.
@param version: e.g. 'HTTP/1.0'
@param status: e.g. '200'
@type status: C{bytes}
@param message: e.g. 'OK'
Nrv )r r r> r? rv rv r| r7 r zHTTPClient.handleStatusc C r )z9
Called every time a header is received.
Nrv )r r r2 rv rv r| r1 r zHTTPClient.handleHeaderc C r )z=
Called when all headers have been received.
Nrv r rv rv r| r: r zHTTPClient.handleEndHeadersc C sn | j d ur |d | j || j d }}| j t|8 _ nd}| | | j dkr5| | | d S d S )Nr r> )r r rE rA setLineMode)r r r rv rv r| rawDataReceived s
zHTTPClient.rawDataReceived)r
r r r r r5 r9 r8 r& r+ r- r3 r@ r rA rE rG r7 r1 r: rI rv rv rv r| r8 O s& )
r8 ) i0 c C s | dur | dk r t S t S )zS
Get a writeable file-like object to which request content can be written.
Ni )r? tempfile
TemporaryFiler rv rv r| _getContentFile s rM s ^\[?(?P.*?)\]?(:\d+)?$c @ s e Zd ZdZdZdZeZee Z dZ
dZ dZ dZ
dZdZdZdZdZdZdZdZdZe Zefdd Zd
d Ze e d d
dddd Z dd Z dd Z dd Z!dd Z"de#fddZ$d d Z%d d Z&d d! Z'd"d# Z(d$d% Z)d&d' Z*d(d) Z+d*d+ Z, dYd,d-Z-dZd.d/Z.d0d1 Z/d2d3 Z0d4d5 Z1d6d7 Z2d8d9 Z3d:d; Z4dd?Z6e e d d@dAddBdCdDdE Z7dFdG Z8dHdI Z9dJdK Z:dLdM Z;dNdO ZdTe?de@fdUdVZAdWdX ZBdS )\r: a
A HTTP request.
Subclasses should override the process() method to determine how
the request will be processed.
@ivar method: The HTTP method that was used, e.g. C{b'GET'}.
@type method: L{bytes}
@ivar uri: The full encoded URI which was requested (including query
arguments), e.g. C{b'/a/b%20/c?q=v'}.
@type uri: L{bytes}
@ivar path: The encoded path of the request URI (not including query
arguments), e.g. C{b'/a/b%20/c'}.
@type path: L{bytes}
@ivar args: A mapping of decoded query argument names as L{bytes} to
corresponding query argument values as L{list}s of L{bytes}.
For example, for a URI with C{foo=bar&foo=baz&quux=spam}
as its query part C{args} will be C{{b'foo': [b'bar', b'baz'],
b'quux': [b'spam']}}.
@type args: L{dict} of L{bytes} to L{list} of L{bytes}
@ivar content: A file-like object giving the request body. This may be
a file on disk, an L{io.BytesIO}, or some other type. The
implementation is free to decide on a per-request basis.
@type content: L{typing.BinaryIO}
@ivar cookies: The cookies that will be sent in the response.
@type cookies: L{list} of L{bytes}
@type requestHeaders: L{http_headers.Headers}
@ivar requestHeaders: All received HTTP request headers.
@type responseHeaders: L{http_headers.Headers}
@ivar responseHeaders: All HTTP response headers to be sent.
@ivar notifications: A L{list} of L{Deferred}s which are waiting for
notification that the response to this request has been finished
(successfully or with an error). Don't use this attribute directly,
instead use the L{Request.notifyFinish} method.
@ivar _disconnected: A flag which is C{False} until the connection over
which this request was received is closed and which is C{True} after
that.
@type _disconnected: L{bool}
@ivar _log: A logger instance for request related messages.
@type _log: L{twisted.logger.Logger}
Nr> s (no method yet)s (no clientproto yet)s (no uri yet)Fc C s` g | _ || _| j | _| j | _t | _i | _t | _ g | _
| jj | _ |t u r+d}|| _
dS )z
@param channel: the channel we're connected to.
@param queued: (deprecated) are we in the request queue, or can we
start writing to the transport?
FN)
notificationschannelgetPeerclientgetHosthostr[ r received_cookiesr cookiesr% _QUEUED_SENTINELqueued)r rO rW rv rv r| r @ s
zRequest.__init__c C s | j r| jdttd| j | | j| | `| j dur6z| j
W n t y3 Y nw | ` | j D ]}|
d q9g | _ dS )zP
Called when have finished responding and are no longer queued.
z"Producer was not unregistered for N)producer_logfailurerZ RuntimeErroruriunregisterProducerrO requestDonecontentcloseOSErrorrN callback)r r rv rv r| _cleanupZ s$
zRequest._cleanupTwistedr r c C r )a'
Notify the object that it is no longer queued.
We start writing whatever data we have to the transport, etc.
This method is not intended for users.
In 16.3 this method was changed to become a no-op, as L{Request}
objects are now never queued.
Nrv r rv rv r| noLongerQueueds s zRequest.noLongerQueuedc C s t || _dS )a0
Called when HTTP channel got length of content in this request.
This method is not intended for users.
@param length: The length of the request body, as indicated by the
request headers. L{None} if the request headers do not indicate a
length.
N)rM r` )r r rv rv r| r s
zRequest.gotLengthc
C sr | j d}|du r dS |D ](}|r6|dD ] }| }z|dd\}}|| j|< W q ty5 Y qw qdS )zW
Parse cookie headers.
This method is not intended for users.
s cookieNr r r )r
getRawHeadersr r0 rT r )r
cookieheaders cookietxtcookr r rv rv r| r s zRequest.parseCookiesc C | j | dS )zX
Write a chunk of data.
This method is not intended for users.
N)r` r rD rv rv r| r s zRequest.handleContentChunkc
C s | j }| j dd i | _||| _| _|| _| jdd}t|dkr+| j| _ n |\| _ }t
|d| _| j}| j d}|durG|d }| jdkr|r|rd} t
|\}
} || d< |
d krl|t
| j d nY|
| krz3tr~tj| j | d
d d } nt| j | } tr| jd
d | D n
| jdd | D W n! ty }
z| j t|
tttfrW Y d}
~
dS d}
~
ww | j dd | dS )a
Called by channel when all data has been received.
This method is not intended for users.
@type command: C{bytes}
@param command: The HTTP verb of this request. This has the case
supplied by the client (eg, it maybe "get" rather than "GET").
@type path: C{bytes}
@param path: The URI of this request.
@type version: C{bytes}
@param version: The HTTP version of this request.
r> ?r s content-typeNs POSTs multipart/form-datazCONTENT-LENGTHs! application/x-www-form-urlencodedutf8surrogateescape)encodingerrorsc S s0 i | ]\}}t |tr|d dd |D qS )
iso-8859-1c S s& g | ]}t |tr|d dn|qS )rm rn r r r )rz r rv rv r| r} s z6Request.requestReceived...rr r rv rv r| r s z+Request.requestReceived..c S s i | ]
\}}| d |qS )rq r r rv rv r| r r ) r` tellseekargsmethodr] clientprotor r r r/ r rg r updatereadrU r parse_multipartr ExceptionrO !_respondToBadRequestAndDisconnectr r r KeyErrorprocess)r r r r clengthr argstringru ctypemfdr r cgiArgserv rv r| r sb
zRequest.requestReceivedr c C s, d | jjt| t| jt| jt| jS )z
Return a string description of the request including such information
as the request method and request URI.
@return: A string loosely describing this L{Request} object.
@rtype: L{str}
z.<{} at 0x{:x} method={} uri={} clientproto={}>)format __class__r
idrV rv r] rw r rv rv r| __repr__
s zRequest.__repr__c C r )zY
Override in subclasses.
This method is not intended for users.
Nrv r rv rv r| r~ s zRequest.processc C s6 | j r td|| j f || _|| _ | j|| dS )z&
Register a producer.
zAregistering producer %s before previous one (%s) was unregisteredN)rY r streamingProducerrO registerProducerr rY streamingrv rv r| r $ s zRequest.registerProducerc C s | j d| _dS )z*
Unregister the producer.
N)rO r^ rY r rv rv r| r^ 2 s
zRequest.unregisterProducerc C s | j |}|dur|d S dS )a
Get an HTTP request header.
@type key: C{bytes} or C{str}
@param key: The name of the header to get the value of.
@rtype: C{bytes} or C{str} or L{None}
@return: The value of the specified header, or L{None} if that header
was not present in the request. The string type of the result
matches the type of C{key}.
Nr )r rg )r r r( rv rv r| getHeader; s zRequest.getHeaderc C s | j |S )a.
Get a cookie that was sent from the network.
@type key: C{bytes}
@param key: The name of the cookie to get.
@rtype: C{bytes} or C{None}
@returns: The value of the specified cookie, or L{None} if that cookie
was not present in the request.
)rT get)r r rv rv r| getCookieK s zRequest.getCookiec C s | j t | j d S )a
Notify when the response to this request has finished.
@note: There are some caveats around the reliability of the delivery of
this notification.
1. If this L{Request}'s channel is paused, the notification
will not be delivered. This can happen in one of two ways;
either you can call C{request.transport.pauseProducing}
yourself, or,
2. In order to deliver this notification promptly when a client
disconnects, the reactor must continue reading from the
transport, so that it can tell when the underlying network
connection has gone away. Twisted Web will only keep
reading up until a finite (small) maximum buffer size before
it gives up and pauses the transport itself. If this
occurs, you will not discover that the connection has gone
away until a timeout fires or until the application attempts
to send some data via L{Request.write}.
3. It is theoretically impossible to distinguish between
successfully I{sending} a response and the peer successfully
I{receiving} it. There are several networking edge cases
where the L{Deferred}s returned by C{notifyFinish} will
indicate success, but the data will never be received.
There are also edge cases where the connection will appear
to fail, but in reality the response was delivered. As a
result, the information provided by the result of the
L{Deferred}s returned by this method should be treated as a
guess; do not make critical decisions in your applications
based upon it.
@rtype: L{Deferred}
@return: A L{Deferred} which will be triggered when the request is
finished -- with a L{None} value if the request finishes
successfully or with an error if the request is interrupted by an
error (for example, the client closing the connection prematurely).
r )rN r rO r rv rv r| notifyFinishX s (
zRequest.notifyFinishc C s | j rtd| jrtjddd dS | js| d | jr$| jd t | jdr7| jj
dur7| jj
| d | _| j sC|
dS dS )
zV
Indicate that all response data has been written to this L{Request}.
zqRequest.finish called on a request after its connection was lost; use Request.notifyFinish to keep track of this.z%Warning! request.finish called twice.r )
stacklevelNr s 0
factoryr )
_disconnectedr\ finishedwarningswarnstartedWritingr chunkedrO hasattrr rT rW rd r rv rv r| finish s"
zRequest.finishc
C s | j rtd| jr dS | jsd| _| j}d| jf }| j}g }|dkr>| jddu r>| j dkr>| jt
vr>| d d| _ | j
dur[| jd rP| jd
n | jd t| j
g | jduri| jd | jg | j D ]\}}|D ] }| ||f qtqn| jD ] } | d | f q| j|||| | j dkrd
d | _dS | jt
v rdd | _dS | jt| | _|r| j r| jt | dS | j| dS dS )z
Write some data as a result of an HTTP request. The first
time this is called, it writes out response data.
@type data: C{bytes}
@param data: Some bytes to be sent as part of the response body.
zBRequest.write called on a request after Request.finish was called.Nr s %d HTTP/1.1r/ HEAD)s Transfer-Encoding chunkeds
last-modifiedzPWarning: last-modified specified both in header list and lastModified attribute.s ETags
Set-Cookiec S rF r rv r rv rv r| r z Request.write..c S rF r rv r rv rv r| r r ) r r\ r r rw code code_messager rg rv r9 r r lastModified hasHeaderrZ info
setRawHeadersr0 etaggetAllRawHeadersrU rO writeHeadersr
sentLengthr r r4 )
r r r r r headersr{ valuesr( cookierv rv r| r s^
z
Request.writec C s dd } dd } | | |d | | | }
|dur$|
d | | | }
|dur2|
d | | | }
|dur@|
d | | | }
|durN|
d
| | | }
|dur\|
d | | | }
|rb|
d }
| rh|
d
}
|
r| |
}
|
dvr|tdt|
|
d|
7 }
| j|
dS )a
Set an outgoing HTTP cookie.
In general, you should consider using sessions instead of cookies, see
L{twisted.web.server.Request.getSession} and the
L{twisted.web.server.Session} class for details.
@param k: cookie name
@type k: L{bytes} or L{str}
@param v: cookie value
@type v: L{bytes} or L{str}
@param expires: cookie expire attribute value in
"Wdy, DD Mon YYYY HH:MM:SS GMT" format
@type expires: L{bytes} or L{str}
@param domain: cookie domain
@type domain: L{bytes} or L{str}
@param path: cookie path
@type path: L{bytes} or L{str}
@param max_age: cookie expiration in seconds from reception
@type max_age: L{bytes} or L{str}
@param comment: cookie comment
@type comment: L{bytes} or L{str}
@param secure: direct browser to send the cookie on encrypted
connections only
@type secure: L{bool}
@param httpOnly: direct browser not to expose cookies through channels
other than HTTP (and HTTPS) requests
@type httpOnly: L{bool}
@param sameSite: One of L{None} (default), C{'lax'} or C{'strict'}.
Direct browsers not to send this cookie on cross-origin requests.
Please see:
U{https://tools.ietf.org/html/draft-west-first-party-cookies-07}
@type sameSite: L{None}, L{bytes} or L{str}
@raise ValueError: If the value for C{sameSite} is not supported.
c S s$ | du r| S t | tr
| S | dS )z
Ensure that C{val} is bytes, encoding using UTF-8 if
needed.
@param val: L{bytes} or L{str}
@return: L{bytes}
Nrm )r r r r2 rv rv r| _ensureBytes) s
z'Request.addCookie.._ensureBytesc S s t | ddS )z
Replace linear whitespace (C{\r}, C{\n}, C{\r\n}) and
semicolons C{;} in C{val} with a single space.
@param val: L{bytes}
@return: L{bytes}
r r )r\ r r rv rv r| _sanitize; s z$Request.addCookie.._sanitizer Ns
; Expires=s ; Domain=s ; Path=s
; Max-Age=s
; Comment=s ; Secures
; HttpOnly)s laxs strictz Invalid value for sameSite: s ; SameSite=)rx r reprrU r )r r r expiresdomainr max_agecommentsecurehttpOnlysameSiter r r rv rv r| addCookie s. ;
zRequest.addCookiec C sJ t |ts td|| _|r t |tstd|| _dS t|d| _dS )zi
Set the HTTP response code.
@type code: L{int}
@type message: L{bytes}
z&HTTP response code must be int or longz*HTTP response status message must be bytess Unknown StatusN)r r r r r r r, r )r r r? rv rv r| setResponseCode[ s
zRequest.setResponseCodec C s | j ||g dS )a
Set an HTTP response header. Overrides any previously set values for
this header.
@type name: L{bytes} or L{str}
@param name: The name of the header for which to set the value.
@type value: L{bytes} or L{str}
@param value: The value to set for the named header. A L{str} will be
UTF-8 encoded, which may not interoperable with other
implementations. Avoid passing non-ASCII characters if possible.
N)r r )r r{ r( rv rv r| setHeaderl s
zRequest.setHeaderc C s | t | d| dS )a-
Utility function that does a redirect.
Set the response code to L{FOUND} and the I{Location} header to the
given URL.
The request should have C{finish()} called after this.
@param url: I{Location} header value.
@type url: L{bytes} or L{str}
s locationN)r r r )r r rv rv r| redirect{ s
zRequest.redirectc C s t t|}| jr| j|k r|| _| d}|r>|ddd }zt|}W n
ty1 Y dS w || jkr>| t t
S dS )a
Set the C{Last-Modified} time for the response to this request.
If I am called more than once, I ignore attempts to set
Last-Modified earlier, only replacing the Last-Modified time
if it is to a later value.
If I am a conditional request, I may modify my response code
to L{NOT_MODIFIED} if appropriate for the time given.
@param when: The last time the resource being returned was
modified, in seconds since the epoch.
@type when: number
@return: If I am a I{If-Modified-Since} conditional request and
the time given is not newer than the condition, I return
L{http.CACHED} to indicate that you should write no
body. Otherwise, I return a false value.
s if-modified-sincer r r> N) r mathceilr r r r3 r r r r- )r when
modifiedSince firstPartrv rv r| setLastModified s
zRequest.setLastModifiedc C sP |r|| _ | d}|r&| }||v sd|v r&| | jdv r!tp"t tS dS )a
Set an C{entity tag} for the outgoing response.
That's "entity tag" as in the HTTP/1.1 C{ETag} header, "used
for comparing two or more entities from the same requested
resource."
If I am a conditional request, I may modify my response code
to L{NOT_MODIFIED} or L{PRECONDITION_FAILED}, if appropriate
for the tag given.
@param etag: The entity tag for the resource being returned.
@type etag: string
@return: If I am a C{If-None-Match} conditional request and
the tag matches one in the request, I return
L{http.CACHED} to indicate that you should write
no body. Otherwise, I return a false value.
s
if-none-match *)r s GETN)r r r r rv r r r- )r r tagsrv rv r| setETag s
zRequest.setETagc C s, i }| j D ] \}}|d || < q|S )a
Return dictionary mapping the names of all received headers to the last
value received for each.
Since this method does not return all header information,
C{self.requestHeaders.getAllRawHeaders()} may be preferred.
r )r r rx )r r r r rv rv r|
getAllHeaders s zRequest.getAllHeadersc C s< | d}|durt|}|dur|dS t| jS )z
Get the hostname that the HTTP client passed in to the request.
@see: L{IRequest.getRequestHostname}
@returns: the requested hostname
@rtype: C{bytes}
hostNrS )r _hostHeaderExpressionmatchgrouprW rR rS )r rS r rv rv r| getRequestHostname s
zRequest.getRequestHostnamec C | j S )a
Get my originally requesting transport's host.
Don't rely on the 'transport' attribute, since Request objects may be
copied remotely. For information on this method's return value, see
L{twisted.internet.tcp.Port}.
rS r rv rv r| rR s zRequest.getHostc C sV || _ | r
d}nd}||kr|}nd||f }| jd|g td||| _dS )a
Change the host and port the request thinks it's using.
This method is useful for working with reverse HTTP proxies (e.g.
both Squid and Apache's mod_proxy can do this), when the address
the HTTP client is using is different than the one we're listening on.
For example, Apache may be listening on https://www.example.com/, and
then forwarding requests to http://localhost:8080/, but we don't want
HTML produced by Twisted to say b'http://localhost:8080/', they should
say b'https://www.example.com/', so we do::
request.setHost(b'www.example.com', 443, ssl=1)
@type host: C{bytes}
@param host: The value to which to change the host header.
@type ssl: C{bool}
@param ssl: A flag which, if C{True}, indicates that the request is
considered secure (if C{True}, L{isSecure} will return C{True}).
i P s %b:%dr TCPN) _forceSSLisSecurer r rK IPv4AddressrS )r rS portssldefault
hostHeaderrv rv r| setHost s zRequest.setHost r getClientAddress) replacementc C s t | jtjtjfr| jjS dS )z
Return the IP address of the client who submitted this request.
This method is B{deprecated}. Use L{getClientAddress} instead.
@returns: the client IP address
@rtype: C{str}
N)r rQ rK r IPv6AddressrS r rv rv r| getClientIP s
zRequest.getClientIPc C r )a~
Return the address of the client who submitted this request.
This may not be a network address (e.g., a server listening on
a UNIX domain socket will cause this to return
L{UNIXAddress}). Callers must check the type of the returned
address.
@since: 18.4
@return: the client's address.
@rtype: L{IAddress}
)rQ r rv rv r| r ) s zRequest.getClientAddressc C s* | j rdS t| dd}|du rdS | S )a
Return L{True} if this request is using a secure transport.
Normally this method returns L{True} if this request's L{HTTPChannel}
instance is using a transport that implements
L{interfaces.ISSLTransport}.
This will also return L{True} if L{Request.setHost} has been called
with C{ssl=True}.
@returns: L{True} if this request is secure
@rtype: C{bool}
TrO NF)r r r )r rO rv rv r| r 9 s zRequest.isSecurec C s z1| d}|sd | _| _W d S | \}}| dkr t t|}|dd\| _| _W d S tj tfyD d | _| _Y d S t
yY | j d d | _| _Y d S w )Ns
Authorizationr s basicr. r rX )
r userpasswordr rx r base64 b64decodebinasciiError
BaseExceptionrZ r[ )r authhbasupwrv rv r|
_authorizeN s
zRequest._authorizec C * z| j W S ty
Y nw | | j S )z
Return the HTTP user sent with this request, if any.
If no user was supplied, return the empty string.
@returns: the HTTP user, if any
@rtype: C{bytes}
)r r r r rv rv r| getUser` zRequest.getUserc C r )z
Return the HTTP password sent with this request, if any.
If no password was supplied, return the empty string.
@returns: the HTTP password, if any
@rtype: C{bytes}
)r r r r rv rv r| getPasswordp r zRequest.getPasswordc C s@ d| _ d| _| jdur| j | jD ]}|| qg | _dS )z
There is no longer a connection for this request to respond over.
Clean up anything which can't be useful anymore.
TN)r rO r` ra rN errback)r r r rv rv r| r s
zRequest.connectionLostc C | j dur | j dS dS )zL
Pass the loseConnection through to the underlying channel.
N)rO loseConnectionr rv rv r| r s
zRequest.loseConnectionr c C s t |tr | |u S tS )a
Determines if two requests are the same object.
@param other: Another object whose identity will be compared
to this instance's.
@return: L{True} when the two are the same object and L{False}
when not.
@rtype: L{bool}
)r r: NotImplemented)r r rv rv r| r
s
zRequest.__eq__c C s t | S )z
A C{Request} is hashable so that it can be used as a mapping key.
@return: A C{int} based on the instance's identity.
)r r rv rv r| r zRequest.__hash__)NNNNNNFNr )r> )Cr
r r r rY r r r r, r rv rw r] r r r r r ru r r` r r rQ rZ rV r rd rY rJ rf r r r r r r r~ r r^ r r r r r r r r r r r r r rR r r r r r r r r r r r r
r rv rv rv r| r: s 4
`
+ R
m%!
"
r: c @ e Zd ZdZdS ) _DataLossa;
L{_DataLoss} indicates that not all of a message body was received. This
is only one of several possible exceptions which may indicate that data
was lost. Because of this, it should not be checked for by
specifically; any unexpected exception should be treated as having
caused data loss.
Nr
r r r rv rv rv r| r r c @ r )r; a
L{PotentialDataLoss} may be raised by a transfer encoding decoder's
C{noMoreData} method to indicate that it cannot be determined if the
entire response body has been delivered. This only occurs when making
requests to HTTP servers which do not set I{Content-Length} or a
I{Transfer-Encoding} in the response because in this case the end of the
response is indicated by the connection being closed, an event which may
also be due to a transient network problem or other error.
Nr rv rv rv r| r; r r; c @ r )_MalformedChunkedDataErrora
C{_ChunkedTransferDecoder} raises L{_MalformedChunkedDataError} from its
C{dataReceived} method when it encounters malformed data. This exception
indicates a client-side error. If this exception is raised, the connection
should be dropped with a 400 error.
Nr rv rv rv r| r r r c @ r ) _IdentityTransferDecoderaZ
Protocol for accumulating bytes up to a specified length. This handles the
case where no I{Transfer-Encoding} is specified.
@ivar contentLength: Counter keeping track of how many more bytes there are
to receive.
@ivar dataCallback: A one-argument callable which will be invoked each
time application data is received.
@ivar finishCallback: A one-argument callable which will be invoked when
the terminal chunk is received. It will be invoked with all bytes
which were delivered to this protocol which came after the terminal
chunk.
c C s || _ || _|| _d S r )
contentLength dataCallbackfinishCallback)r r r r rv rv r| r s
z!_IdentityTransferDecoder.__init__c C s | j du r td| jdu r| | dS t|| jk r,| jt|8 _| | dS | j}| j }| j}d | _ | _d| _||d| |||d dS )a;
Interpret the next chunk of bytes received. Either deliver them to the
data callback or invoke the finish callback if enough bytes have been
received.
@raise RuntimeError: If the finish callback has already been invoked
during a previous call to this methood.
Nz;_IdentityTransferDecoder cannot decode data after finishingr> )r r\ r r r )r r r r r rv rv r| dataReceived s
z%_IdentityTransferDecoder.dataReceivedc C s> | j }d | _| _ | jdu r|d t | jdkr t dS )ap
All data which will be delivered to this decoder has been. Check to
make sure as much data as was expected has been received.
@raise PotentialDataLoss: If the content length is unknown.
@raise _DataLoss: If the content length is known and fewer than that
many bytes have been delivered.
@return: L{None}
Nr r> )r r r r; r )r r rv rv r|
noMoreData s
z#_IdentityTransferDecoder.noMoreDataN)r
r r r r r r rv rv rv r| r s
r i s !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~c @ s e Zd ZdZdZdeegdf deegdf ddfddZdefd d
Z defd d Z
defd
dZ defddZ defddZ
deddfddZdddZdS )_ChunkedTransferDecodera
Protocol for decoding I{chunked} Transfer-Encoding, as defined by RFC 7230,
section 4.1. This protocol can interpret the contents of a request or
response body which uses the I{chunked} Transfer-Encoding. It cannot
interpret any of the rest of the HTTP protocol.
It may make sense for _ChunkedTransferDecoder to be an actual IProtocol
implementation. Currently, the only user of this class will only ever
call dataReceived on it. However, it might be an improvement if the
user could connect this to a transport and deliver connection lost
notification. This way, `dataCallback` becomes `self.transport.write`
and perhaps `finishCallback` becomes `self.transport.loseConnection()`
(although I'm not sure where the extra data goes in that case). This
could also allow this object to indicate to the receiver of data that
the stream was not completely received, an error case which should be
noticed. -exarkun
@ivar dataCallback: A one-argument callable which will be invoked each
time application data is received. This callback is not reentrant.
@ivar finishCallback: A one-argument callable which will be invoked when
the terminal chunk is received. It will be invoked with all bytes
which were delivered to this protocol which came after the terminal
chunk.
@ivar length: Counter keeping track of how many more bytes in a chunk there
are to receive.
@ivar state: One of C{'CHUNK_LENGTH'}, C{'CRLF'}, C{'TRAILER'},
C{'BODY'}, or C{'FINISHED'}. For C{'CHUNK_LENGTH'}, data for the
chunk length line is currently being read. For C{'CRLF'}, the CR LF
pair which follows each chunk is being read. For C{'TRAILER'}, the CR
LF pair which follows the terminal 0-length chunk is currently being
read. For C{'BODY'}, the contents of a chunk are being read. For
C{'FINISHED'}, the last chunk has been completely read and no more
input is valid.
@ivar _buffer: Accumulated received data for the current state. At each
state transition this is truncated at the front so that index 0 is
where the next state shall begin.
@ivar _start: While in the C{'CHUNK_LENGTH'} state, tracks the index into
the buffer at which search for CRLF should resume. Resuming the search
at this position avoids doing quadratic work if the chunk length line
arrives over many calls to C{dataReceived}.
Not used in any other state.
CHUNK_LENGTHr Nr r c C s || _ || _t | _d| _d S )Nr> )r r bytearray_buffer_start)r r r rv rv r| r z s
z _ChunkedTransferDecoder.__init__c C s | j d| j}|tks|dkr t| j tkr tdt|dkr,t| j d | _dS | j dd|}|dkr:|}| j d| }zt|}W n tyR tdw | j |d | }|rn| d t
d
krntd |d |dkrvd
| _ nd| _ || _ | j d|d = d| _dS )ak
Read the chunk size line, ignoring any extensions.
@returns: C{True} once the line has been read and removed from
C{self._buffer}. C{False} when more data is required.
@raises _MalformedChunkedDataError: when the chunk size cannot be
decoded or the length of the line exceeds L{maxChunkSizeLineLength}.
r r z,Chunk size line exceeds maximum of {} bytes.r Fr r> z Chunk-size must be an integer.Nr z(Invalid characters in chunk extensions: .TRAILERBODYr T)
r r r maxChunkSizeLineLengthr r r r r translate_chunkExtCharsstater )r eolIndexendOfLengthIndex rawLengthr extrv rv r| _dataReceived_CHUNK_LENGTH s@
z2_ChunkedTransferDecoder._dataReceived_CHUNK_LENGTHc C s< t | jdk r dS | jdstdd| _| jdd= dS )a;
Await the carriage return and line feed characters that are the end of
chunk marker that follow the chunk data.
@returns: C{True} when the CRLF have been read, otherwise C{False}.
@raises _MalformedChunkedDataError: when anything other than CRLF are
received.
r Fr Chunk did not end with CRLFr r> T)r r r< r r r rv rv r| _dataReceived_CRLF s
z*_ChunkedTransferDecoder._dataReceived_CRLFc C s\ t | jdk r dS | jdstdt| jdd }| jdd= d| _| | dS )a
Await the carriage return and line feed characters that follow the
terminal zero-length chunk. Then invoke C{finishCallback} and switch to
state C{'FINISHED'}.
@returns: C{False}, as there is either insufficient data to continue,
or no data remains.
@raises _MalformedChunkedDataError: when anything other than CRLF is
received.
r Fr r NFINISHED)r r r< r
memoryviewtobytesr r rD rv rv r| _dataReceived_TRAILER s
z-_ChunkedTransferDecoder._dataReceived_TRAILERc C s t | j| jkr%t| jd| j }| jd| j= d| _| | dS t| j}| jt |8 _| jdd= | | dS )z
Deliver any available chunk data to the C{dataCallback}. When all the
remaining data for the chunk arrives, switch to state C{'CRLF'}.
@returns: C{True} to continue processing of any buffered data.
NCRLFT)r r r r r r r r )r chunkrv rv r| _dataReceived_BODY s
z*_ChunkedTransferDecoder._dataReceived_BODYc C s t d)z
Once C{finishCallback} has been invoked receipt of additional data
raises L{RuntimeError} because it represents a programming error in
the caller.
zJ_ChunkedTransferDecoder.dataReceived called after last chunk was processed)r\ r rv rv r| _dataReceived_FINISHED s z._ChunkedTransferDecoder._dataReceived_FINISHEDr c C sH | j |7 _ d}|r | j r"t| d| j }|r | j sdS dS dS dS )zu
Interpret data from a request or response body which uses the
I{chunked} Transfer-Encoding.
T_dataReceived_N)r r r )r r goOnrv rv r| r s
z$_ChunkedTransferDecoder.dataReceivedc C s | j dkr
td| j f dS )zj
Verify that all data has been received. If it has not been, raise
L{_DataLoss}.
r
zRChunked decoder in %r state, still expecting more data to get to 'FINISHED' state.N)r r r rv rv r| r
s
z"_ChunkedTransferDecoder.noMoreData)r N)r
r r r r rA r r r r
r r r r r r rv rv rv r| r F s" 1
5
r c @ s8 e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd S )
_NoPushProducerz
A no-op version of L{interfaces.IPushProducer}, used to abstract over the
possibility that a L{HTTPChannel} transport does not provide
L{IPushProducer}.
c C r )z
Pause producing data.
Tells a producer that it has produced too much data to process for
the time being, and to stop until resumeProducing() is called.
Nrv r rv rv r| pauseProducing! r z _NoPushProducer.pauseProducingc C r )z
Resume producing data.
This tells a producer to re-add itself to the main loop and produce
more data for its consumer.
Nrv r rv rv r| resumeProducing) r z _NoPushProducer.resumeProducingc C r )z
Register to receive data from a producer.
@param producer: The producer to register.
@param streaming: Whether this is a streaming producer or not.
Nrv r rv rv r| r 1 r z _NoPushProducer.registerProducerc C r )zM
Stop consuming data from a producer, without disconnecting.
Nrv r rv rv r| r^ 9 r z"_NoPushProducer.unregisterProducerc C r )z)
IProducer.stopProducing
Nrv r rv rv r|
stopProducing> r z _NoPushProducer.stopProducingN) r
r r r r r r r^ r rv rv rv r| r s r c @ sD e Zd ZdZdZdZdZdZdZdZ dZ
dZ e Z
dZdZdZdZdZd ZdZdZe Zd
d Zd d
Zdd Zdd Zdd Z dd Z dd Z de ddfddZ 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- Z)d.d/ Z*d0d1 Z+d2d3 Z,d4d5 Z-d6d7 Z.d8d9 Z/d:d; Z0dd? Z2d@dA Z3dBdC Z4dS )Dr< a
A receiver for HTTP requests.
The L{HTTPChannel} provides L{interfaces.ITransport} and
L{interfaces.IConsumer} to the L{Request} objects it creates. It also
implements L{interfaces.IPushProducer} to C{self.transport}, allowing the
transport to pause it.
@ivar MAX_LENGTH: Maximum length for initial request line and each line
from the header.
@ivar _transferDecoder: L{None} or a decoder instance if the request body
uses the I{chunked} Transfer-Encoding.
@type _transferDecoder: L{_ChunkedTransferDecoder}
@ivar maxHeaders: Maximum number of headers allowed per request.
@type maxHeaders: C{int}
@ivar totalHeadersSize: Maximum bytes for request line plus all headers
from the request.
@type totalHeadersSize: C{int}
@ivar _receivedHeaderSize: Bytes received so far for the header.
@type _receivedHeaderSize: C{int}
@ivar _handlingRequest: Whether a request is currently being processed.
@type _handlingRequest: L{bool}
@ivar _dataBuffer: Any data that has been received from the connection
while processing an outstanding request.
@type _dataBuffer: L{list} of L{bytes}
@ivar _networkProducer: Either the transport, if it provides
L{interfaces.IPushProducer}, or a null implementation of
L{interfaces.IPushProducer}. Used to attempt to prevent the transport
from producing excess data when we're responding to a request.
@type _networkProducer: L{interfaces.IPushProducer}
@ivar _requestProducer: If the L{Request} object or anything it calls
registers itself as an L{interfaces.IProducer}, it will be stored here.
This is used to create a producing pipeline: pause/resume producing
methods will be propagated from the C{transport}, through the
L{HTTPChannel} instance, to the c{_requestProducer}.
The reason we proxy through the producing methods rather than the old
behaviour (where we literally just set the L{Request} object as the
producer on the transport) is because we want to be able to exert
backpressure on the client to prevent it from sending in arbitrarily
many requests without ever reading responses. Essentially, if the
client never reads our responses we will eventually stop reading its
requests.
@type _requestProducer: L{interfaces.IPushProducer}
@ivar _requestProducerStreaming: A boolean that tracks whether the producer
on the L{Request} side of this channel has registered itself as a
L{interfaces.IPushProducer} or an L{interfaces.IPullProducer}.
@type _requestProducerStreaming: L{bool} or L{None}
@ivar _waitingForTransport: A boolean that tracks whether the transport has
asked us to stop producing. This is used to keep track of what we're
waiting for: if the transport has asked us to stop producing then we
don't want to unpause the transport until it asks us to produce again.
@type _waitingForTransport: L{bool}
@ivar abortTimeout: The number of seconds to wait after we attempt to shut
the transport down cleanly to give up and forcibly terminate it. This
is only used when we time a connection out, to prevent errors causing
the FD to get leaked. If this is L{None}, we will wait forever.
@type abortTimeout: L{int}
@ivar _abortingCall: The L{twisted.internet.base.DelayedCall} that will be
used to forcibly close the transport if it doesn't close cleanly.
@type _abortingCall: L{twisted.internet.base.DelayedCall}
@ivar _optimisticEagerReadSize: When a resource takes a long time to answer
a request (via L{twisted.web.server.NOT_DONE_YET}, hopefully one day by
a L{Deferred}), we would like to be able to let that resource know
about the underlying transport disappearing as promptly as possible,
via L{Request.notifyFinish}, and therefore via
C{self.requests[...].connectionLost()} on this L{HTTPChannel}.
However, in order to simplify application logic, we implement
head-of-line blocking, and do not relay pipelined requests to the
application until the previous request has been answered. This means
that said application cannot dispose of any entity-body that comes in
from those subsequent requests, which may be arbitrarily large, and it
may need to be buffered in memory.
To implement this tradeoff between prompt notification when possible
(in the most frequent case of non-pipelined requests) and correct
behavior when not (say, if a client sends a very long-running GET
request followed by a PUT request with a very large body) we will
continue reading pipelined requests into C{self._dataBuffer} up to a
given limit.
C{_optimisticEagerReadSize} is the number of bytes we will accept from
the client and buffer before pausing the transport.
This behavior has been in place since Twisted 17.9.0 .
@type _optimisticEagerReadSize: L{int}
i i @ r> r r NFc C s g | _ d| _g | _d | _d S NF)requests_handlingRequest _dataBuffer_transferDecoderr rv rv r| r s
zHTTPChannel.__init__c C s0 | | j t| jt | _| j| d d S )NT)
setTimeouttimeOutrL
IPushProducerr% r _networkProducerr r rv rv r| rG s
zHTTPChannel.connectionMadec C s | | jt|7 _| j| jkr| dS | jr| js)dd | _| _dS |s5| jdkr5d| _dS t
| j rA| | }n | | t| j }| j
| d| _| }t|dkrc| dS |\}}}z|d W n ty} | Y dS w || _|| _|| _dS |d kr| jr| | j}|sdS d | _| | jdkr| dS | dS |d d
v r| jd |d
7 _dS | jr| | j || _dS ) zp
Called for each line from request until the end of headers when
it enters binary mode.
Nc W rF r rv )ru rv rv r| r r z*HTTPChannel.lineReceived..r r r> r r r r ) resetTimeout_receivedHeaderSizer totalHeadersSizer| _HTTPChannel__first_line
persistentr r@ r^
providedByrequestFactoryr r r r UnicodeDecodeError_command_path_version_HTTPChannel__headerheaderReceivedallHeadersReceivedr allContentReceivedr; r0 )r r requestr r r okrv rv r| r@ s\
zHTTPChannel.lineReceivedc C s | j | | d S r )r r r4 rD rv rv r| _finishRequestBody s z HTTPChannel._finishRequestBodyc s fdd}|dkr0| s| S zt|}W n ty# | Y S w t| jd j j}n$|dkrR| dkrGd}t jd j j}n
| dkrOd S | S d S j dur\| S | _
| _ d S )
z
If the provided header is C{content-length} or
C{transfer-encoding}, choose the appropriate decoder if any.
Returns L{True} if the request can proceed and L{False} if not.
c s d _dS r )r| r rv r rv r| fail( s z5HTTPChannel._maybeChooseTransferDecoder..failr/ r s transfer-encodingr Ns identityT) r r r r r r r7 rx r r r )r r r r8 r newTransferDecoderrv r r| _maybeChooseTransferDecoder s6
z'HTTPChannel._maybeChooseTransferDecoderc C s z
| dd\}}W n ty | Y dS w |r#|dd r)| dS | }|d}| ||s:dS | jd j}| |}|durO|
| n| ||g | j d7 _ | j | j
kri| dS dS )af
Do pre-processing (for content-length) and store this header away.
Enforce the per-request header limit.
@type line: C{bytes}
@param line: A line from the header section of a request, excluding the
line delimiter.
@return: A flag indicating whether the header was valid.
@rtype: L{bool}
r. r Fr Nr% T)r r r| isspacerx r r: r r rg r r _receivedHeaderCount
maxHeaders)r r r r
reqHeadersr rv rv r| r2 O s.
zHTTPChannel.headerReceivedc C sx | j }| j}| j}d| _d| _d| _d| _d | _| ` | `| `| jr'| d | _
d| _ | | j
d }|||| d S )Nr> r Tr )r. r/ r0 r r< r' r) r r" r!
_savedTimeOutr r; r r )r r r r reqrv rv r| r4 y s
z HTTPChannel.allContentReceivedr r c C st | j r | j| ttt| j| jkr | js | j dS |
z | j | W dS t
y9 | Y dS w )a
This is called when this HTTP/1.1 parser is in raw mode rather than
line mode.
It may be in raw mode for one of two reasons:
1. All the headers of a request have been received and this
L{HTTPChannel} is currently receiving its body.
2. The full content of a request has been received and is currently
being processed asynchronously, and this L{HTTPChannel} is
buffering the data of all subsequent requests to be parsed
later.
In the second state, the data will be played back later.
@note: This isn't really a public API, and should be invoked only by
L{LineReceiver}'s line parsing logic. If you wish to drive an
L{HTTPChannel} from a custom data source, call C{dataReceived} on
it directly.
@see: L{LineReceive.rawDataReceived}
N)r r r sumr r _optimisticEagerReadSize_waitingForTransportr$ r r& r r r r| rD rv rv r| rI s
zHTTPChannel.rawDataReceivedc C sp | j d }| | || j| _|| j |jd}|r2|d dkr4| jdkr6|
d S d S d S d S )Nr s expectr> s 100-continuer ) r r checkPersistencer0 r* r r r rg rx _send100Continue)r r@ expectContinuerv rv r| r3 s
z HTTPChannel.allHeadersReceivedc C sZ |j d}|rdd |d dD }ng }|dkr+d|v r)|jddg dS d S dS )
a
Check if the channel should close or not.
@param request: The request most recently received over this channel
against which checks will be made to determine if this connection
can remain open after a matching response is returned.
@type version: C{bytes}
@param version: The version of the request.
@rtype: C{bool}
@return: A flag which, if C{True}, indicates that this connection may
remain open to receive another request; if C{False}, the connection
must be closed in order to indicate the completion of the response
to C{request}.
s
connectionc S ru rv rw )rz trv rv r| r} r~ z0HTTPChannel.checkPersistence..r> r r s closeFT)r rg r r r )r r5 r
connectiontokensrv rv r| rD s
z HTTPChannel.checkPersistencec C st || j d kr t| j d= | js| j | jr4d| _| jr$| | j d | j
}g | _
| | dS | dS )zC
Called by first request in queue when it is done.
r> Fr N)
r r rC r$ r r* r r? r! r r rH r )r r5 r rv rv r| r_ s
zHTTPChannel.requestDonec C sB | j jdt| j d | jd ur| | j| j| _| d S )NzTiming out client: {peer}peer)
rZ r r r% rP abortTimeout callLaterforceAbortClient
_abortingCallr r rv rv r| timeoutConnection
s
z HTTPChannel.timeoutConnectionc C s. | j jdt| j d d| _| j dS )a
Called if C{abortTimeout} seconds have passed since the timeout fired,
and the connection still hasn't gone away. This can really only happen
on extremely bad connections or when clients are maliciously attempting
to keep connections open.
z"Forcibly timing out client: {peer}rJ N)rZ r r r% rP rO abortConnectionr rv rv r| rN
s
z HTTPChannel.forceAbortClientc C sB | d | jD ]}|| q| jd ur | j d | _d S d S r )r! r r rO cancel)r r r5 rv rv r| r ,
s
zHTTPChannel.connectionLostc C s t | jddur dS dS )a#
Return L{True} if this channel is using a secure transport.
Normally this method returns L{True} if this instance is using a
transport that implements L{interfaces.ISSLTransport}.
@returns: L{True} if this request is secure
@rtype: C{bool}
NTF)rL
ISSLTransportr% r rv rv r| r 6
s
zHTTPChannel.isSecurec
C sp t }|D ]
\}}||| q|d | d | d }|g} | dd | D | d | j| dS )a
Called by L{Request} objects to write a complete set of HTTP headers to
a transport.
@param version: The HTTP version in use.
@type version: L{bytes}
@param code: The HTTP status code to write.
@type code: L{bytes}
@param reason: The HTTP reason phrase to write.
@type reason: L{bytes}
@param headers: The headers to write to the transport.
@type headers: L{twisted.web.http_headers.Headers}
r r c s s. | ]\}}|D ] }|d | d V qqdS )r' r Nrv )rz r{ r r( rv rv r| [
s z+HTTPChannel.writeHeaders..N)r[ addRawHeaderextendr r r% r )
r r r r r sanitizedHeadersr{ r( responseLineheaderSequencerv rv r| r D
s
zHTTPChannel.writeHeadersc C rk )z
Called by L{Request} objects to write response data.
@param data: The data chunk to write to the stream.
@type data: L{bytes}
@return: L{None}
Nr, rD rv rv r| r c
zHTTPChannel.writec C rk )z
Write a list of strings to the HTTP response.
@param iovec: A list of byte strings to write to the stream.
@type iovec: L{list} of L{bytes}
@return: L{None}
Nr$ )r iovecrv rv r| r n
rZ zHTTPChannel.writeSequencec C
| j S )zg
Get the remote address of this connection.
@return: An L{IAddress} provider.
)r% rP r rv rv r| rP y
zHTTPChannel.getPeerc C r\ )zf
Get the local address of this connection.
@return: An L{IAddress} provider.
)r% rR r rv rv r| rR
r] zHTTPChannel.getHostc C s | j | j S )z
Closes the connection. Will write any data that is pending to be sent
on the network, but if this response has not yet been written to the
network will not write anything.
@return: L{None}
)r$ r^ r% r r rv rv r| r
s
zHTTPChannel.loseConnectionc C sJ | j durtd|| j f |st|| }|| _ || _|s#| dS dS )a
Register to receive data from a producer.
This sets self to be a consumer for a producer. When this object runs
out of data (as when a send(2) call on a socket succeeds in moving the
last data from a userspace buffer into a kernelspace buffer), it will
ask the producer to resumeProducing().
For L{IPullProducer} providers, C{resumeProducing} will be called once
each time data is required.
For L{IPushProducer} providers, C{pauseProducing} will be called
whenever the write buffer fills up and C{resumeProducing} will only be
called when it empties.
@type producer: L{IProducer} provider
@param producer: The L{IProducer} that will be producing data.
@type streaming: L{bool}
@param streaming: C{True} if C{producer} provides L{IPushProducer},
C{False} if C{producer} provides L{IPullProducer}.
@raise RuntimeError: If a producer is already registered.
@return: L{None}
NzHCannot register producer %s, because producer %s was never unregistered.)_requestProducerr\ rN _requestProducerStreamingstartStreamingr rv rv r| r
s
z HTTPChannel.registerProducerc C s. | j du rdS | js| j d| _ d| _dS )zg
Stop consuming data from a producer, without disconnecting.
@return: L{None}
N)r^ r_
stopStreamingr rv rv r| r^
s
z HTTPChannel.unregisterProducerc C r )a&
Stop producing data.
The HTTPChannel doesn't *actually* implement this, beacuse the
assumption is that it will only be called just before C{loseConnection}
is called. There's nothing sensible we can do other than call
C{loseConnection} anyway.
N)r^ r r rv rv r| r
s
zHTTPChannel.stopProducingc C 2 d| _ | jdur
| j | js| j dS dS )a"
Pause producing data.
This will be called by the transport when the send buffers have been
filled up. We want to simultaneously pause the producing L{Request}
object and also pause our transport.
The logic behind pausing the transport is specifically to avoid issues
like https://twistedmatrix.com/trac/ticket/8868. In this case, our
inability to send does not prevent us handling more requests, which
means we increasingly queue up more responses in our send buffer
without end. The easiest way to handle this is to ensure that if we are
unable to send our responses, we will not read further data from the
connection until the client pulls some data out. This is a bit of a
blunt instrument, but it's ok.
Note that this potentially interacts with timeout handling in a
positive way. Once the transport is paused the client may run into a
timeout which will cause us to tear the connection down. That's a good
thing!
TN)rC r^ r r r$ r rv rv r| r
s
zHTTPChannel.pauseProducingc C rb )a!
Resume producing data.
This will be called by the transport when the send buffer has dropped
enough to actually send more data. When this happens we can unpause any
outstanding L{Request} producers we have, and also unpause our
transport.
FN)rC r^ r r r$ r rv rv r| r
s
zHTTPChannel.resumeProducingc C s | j d dS )z}
Sends a 100 Continue response, used to signal to clients that further
processing will be performed.
s HTTP/1.1 100 Continue
Nr, r rv rv r| rE s z HTTPChannel._send100Continuec C s | j d | dS )a&
This is a quick and dirty way of responding to bad requests.
As described by HTTP standard we should be patient and accept the
whole request from the client before sending a polite bad request
response, even in the case when clients send tons of data.
s HTTP/1.1 400 Bad Request
N)r% r r r rv rv r| r| s z-HTTPChannel._respondToBadRequestAndDisconnect)5r
r r r r= r( rL r r* r1 r) _HTTPChannel__contentr: r, r? r< r' r^ r_ rC rO rB rQ rZ r rG r@ r7 r: r2 r4 r rI r3 rD r_ rP rN r r r r r rP rR r r r^ r r r rE r| rv rv rv r| r< D s` hI/* ++
* # r< c C sx t | ts
| d} t| }t |ts|d}|dr#|dd }|dr6|dd ddd dS |dd S )
z
Return a string like python repr, but always escaped as if surrounding
quotes were double quotes.
@param s: The string to escape.
@type s: L{bytes} or L{str}
@return: An escaped string.
@rtype: L{str}
r r r N'r "z\"z\')r r r r r r r< r )r rrv rv r| _escape" s
rg c C s | }t|tjtjtfr|j}nd}t|dpd}t|dp$d}dt t|| t|j
t|j t|j |j
|jp>d||d }|S )zm
@return: A combined log formatted log line for the given request.
@see: L{IAccessLogFormatter}
-s referers
user-agentzk"%(ip)s" - - %(timestamp)s "%(method)s %(uri)s %(protocol)s" %(code)d %(length)s "%(referrer)s" "%(agent)s"r ) ip timestamprv r] rM r r referreragent)r r rK r r _XForwardedForAddressrS rg r dictrv r] rw r r )rj r5
clientAddrri rk rl r rv rv r| combinedLogFormatter: s. rp c @ s e Zd ZdZdd ZdS )rm z
L{IAddress} which represents the client IP to log for a request, as gleaned
from an X-Forwarded-For header.
@ivar host: An IP address or C{b"-"}.
@type host: L{bytes}
@see: L{proxiedLogFormatter}
c C s
|| _ d S r r r rS rv rv r| r h s
z _XForwardedForAddress.__init__N)r
r r r r rv rv rv r| rm \ s
rm c @ s< e Zd ZdZdd Zedd Zedd Zedd Zd
S ) _XForwardedForRequestz
Add a layer on top of another request that only uses the value of an
X-Forwarded-For header as the result of C{getClientAddress}.
c C s, | j jddgd dd }t|S )a8
The client address (the first address) in the value of the
I{X-Forwarded-For header}. If the header is not present, the IP is
considered to be C{b"-"}.
@return: L{_XForwardedForAddress} which wraps the client address as
expected by L{combinedLogFormatter}.
s x-forwarded-forrh r> ,)_requestr rg r r rm rq rv rv r| r r s
z&_XForwardedForRequest.getClientAddressc C | j jS )zX
@return: The protocol version in the request.
@rtype: L{bytes}
)rt rw r rv rv r| rw r z!_XForwardedForRequest.clientprotoc C ru )zT
@return: The response code for the request.
@rtype: L{int}
)rt r r rv rv r| r r z_XForwardedForRequest.codec C ru )z`
@return: The number of bytes sent in the response body.
@rtype: L{int}
)rt r r rv rv r| r r z _XForwardedForRequest.sentLengthN) r
r r r r propertyrw r r rv rv rv r| rr l s
rr rt c C s t | t|S )z
@return: A combined log formatted log line for the given request but use
the value of the I{X-Forwarded-For} header as the value for the client
IP address.
@see: L{IAccessLogFormatter}
)rp rr )rj r5 rv rv r| proxiedLogFormatter s rw c @ s e Zd ZdZdZeZdZdZdZ dZ
e dd Z e j
dd Z e dd Zej
dd Ze d d
Zej
d d
Ze d d
Zej
dd
Ze dd Zej
dd Zdd ZdS )_GenericHTTPChannelProtocola
A proxy object that wraps one of the HTTP protocol objects, and switches
between them depending on TLS negotiated protocol.
@ivar _negotiatedProtocol: The protocol negotiated with ALPN or NPN, if
any.
@type _negotiatedProtocol: Either a bytestring containing the ALPN token
for the negotiated protocol, or L{None} if no protocol has yet been
negotiated.
@ivar _channel: The object capable of behaving like a L{HTTPChannel} that
is backing this object. By default this is a L{HTTPChannel}, but if a
HTTP protocol upgrade takes place this may be a different channel
object. Must implement L{IProtocol}.
@type _channel: L{HTTPChannel}
@ivar _requestFactory: A callable to use to build L{IRequest} objects.
@type _requestFactory: L{IRequest}
@ivar _site: A reference to the creating L{twisted.web.server.Site} object.
@type _site: L{twisted.web.server.Site}
@ivar _factory: A reference to the creating L{HTTPFactory} object.
@type _factory: L{HTTPFactory}
@ivar _timeOut: A timeout value to pass to the backing channel.
@type _timeOut: L{int} or L{None}
@ivar _callLater: A value for the C{callLater} callback.
@type _callLater: L{callable}
Nc C ru )z=
@see: L{_genericHTTPChannelProtocolFactory}
)_channelr r rv rv r| r z#_GenericHTTPChannelProtocol.factoryc C s || _ || j_d S r )_factoryry r r r( rv rv r| r s c C ru )z
A callable to use to build L{IRequest} objects.
Retries the object from the current backing channel.
)ry r, r rv rv r| r, z*_GenericHTTPChannelProtocol.requestFactoryc C || _ || j_dS )a
A callable to use to build L{IRequest} objects.
Sets the object on the backing channel and also stores the value for
propagation to any new channel.
@param value: The new callable to use.
@type value: A L{callable} returning L{IRequest}
N)_requestFactoryry r, r| rv rv r| r, c C ru )z
A reference to the creating L{twisted.web.server.Site} object.
Returns the site object from the backing channel.
)ry siter rv rv r| r r} z _GenericHTTPChannelProtocol.sitec C r~ )a;
A reference to the creating L{twisted.web.server.Site} object.
Sets the object on the backing channel and also stores the value for
propagation to any new channel.
@param value: The L{twisted.web.server.Site} object to set.
@type value: L{twisted.web.server.Site}
N)_sitery r r| rv rv r| r r c C ru )z;
The idle timeout for the backing channel.
)ry r" r rv rv r| r"
rz z#_GenericHTTPChannelProtocol.timeOutc C r~ )a
The idle timeout for the backing channel.
Sets the idle timeout on both the backing channel and stores it for
propagation to any new backing channel.
@param value: The timeout to set.
@type value: L{int} or L{float}
N)_timeOutry r" r| rv rv r| r" r c C ru )z
A value for the C{callLater} callback. This callback is used by the
L{twisted.protocols.policies.TimeoutMixin} to handle timeouts.
)ry rM r rv rv r| rM r z%_GenericHTTPChannelProtocol.callLaterc C r~ )z
Sets the value for the C{callLater} callback. This callback is used by
the L{twisted.protocols.policies.TimeoutMixin} to handle timeouts.
@param value: The new callback to use.
@type value: L{callable}
N)
_callLaterry rM r| rv rv r| rM ' s c C s | j du rpz| jjj}W n ty d}Y nw |du r d}|dkrets(td| jj}| | j d | jj}t
| _| j | j_ | j
| j_| j| j_| j| j_| j| j_| j| || jd n|dksmJ d|| _ | j|S )zi
An override of L{IProtocol.dataReceived} that checks what protocol we're
using.
Ns http/1.1s h2z"Negotiated HTTP/2 without support.Tz Unsupported protocol negotiated)_negotiatedProtocolry r% negotiatedProtocolAttributeError
H2_ENABLEDr r$ r^ r! r` r r, r r r{ r r r" r rM makeConnectionr r )r r r networkProducerr% rv rv r| r 3 s8
z(_GenericHTTPChannelProtocol.dataReceived)r
r r r r r: r r{ r r r rv r setterr, r r" rM r rv rv rv r| rx s:
rx ry c C s
t t S )zK
Returns an appropriately initialized _GenericHTTPChannelProtocol.
)rx r< r rv rv r| "_genericHTTPChannelProtocolFactoryg s
r c @ s^ e Zd ZdZeZdZeZdeddfddZ dd Z
dd Z d d
Z d d Z
d
d Zdd ZdS )r= a
Factory for HTTP server.
@ivar _logDateTime: A cached datetime string for log messages, updated by
C{_logDateTimeCall}.
@type _logDateTime: C{str}
@ivar _logDateTimeCall: A delayed call for the next update to the cached
log datetime string.
@type _logDateTimeCall: L{IDelayedCall} provided
@ivar _logFormatter: See the C{logFormatter} parameter to L{__init__}
@ivar _nativeize: A flag that indicates whether the log file being written
to wants native strings (C{True}) or bytes (C{False}). This is only to
support writing to L{twisted.python.log} which, unfortunately, works
with native strings.
@ivar reactor: An L{IReactorTime} provider used to manage connection
timeouts and compute logging timestamps.
Nc C sX |sddl m} || _|durtj|}|| _|| _|du r!t}|| _d| _ d| _
dS )a
@param logPath: File path to which access log messages will be written
or C{None} to disable logging.
@type logPath: L{str} or L{bytes}
@param timeout: The initial value of L{timeOut}, which defines the idle
connection timeout in seconds, or C{None} to disable the idle
timeout.
@type timeout: L{float}
@param logFormatter: An object to format requests into log lines for
the access log. L{combinedLogFormatter} when C{None} is passed.
@type logFormatter: L{IAccessLogFormatter} provider
@param reactor: An L{IReactorTime} provider used to manage connection
timeouts and compute logging timestamps. Defaults to the global
reactor.
r> )reactorN) twisted.internetr osr abspathlogPathr" rp
_logFormatter _logDateTime_logDateTimeCall)r r timeout logFormatterr rv rv r| r s
zHTTPFactory.__init__c C s& t | j | _| jd| j| _dS )zY
Update log datetime periodically, so we aren't always recalculating it.
r N)r1 r r r rM _updateLogDateTimer r rv rv r| r s z HTTPFactory._updateLogDateTimec C s$ t j| |}| jj|_| j|_|S r )rM
ServerFactory
buildProtocolr rM r" )r addrprv rv r| r s
zHTTPFactory.buildProtocolc C s6 | j du r | | jr| | j| _dS tj| _dS )z6
Set up request logging if necessary.
N)r r r _openLogFilelogFilerT logfiler rv rv r| startFactory s
zHTTPFactory.startFactoryc C sT t | dr| jtjkr| j | `| jd ur&| j r(| j d | _d S d S d S )Nr )r r rT r ra r activerR r rv rv r| stopFactory s
zHTTPFactory.stopFactoryc C s t |dd}|S )zP
Override in subclasses, e.g. to use L{twisted.python.logfile}.
abr )open)r r frv rv r| r s zHTTPFactory._openLogFilec C sF z| j }W n
ty Y dS w | | j|d }||d dS )z
Write a line representing C{request} to the access log file.
@param request: The request object about which to log.
@type request: L{Request}
rm N)r r r r r r )r r5 r r rv rv r| rT s
zHTTPFactory.log)r
r r r r rM r _REQUEST_TIMEOUTr" r r r r r r rT rv rv rv r| r= n s
%
r= )r> r> r )r __all__r r r r r r rerK r r ior? typingr@ rA rB rC urllib.parserD rE r r. r zope.interfacerF rG rH rI incrementalrJ r rK rL rM "twisted.internet._producer_helpersrN twisted.internet.deferrO twisted.internet.interfacesrP twisted.loggerrQ twisted.protocolsrR rS twisted.pythonrT twisted.python.compatrU rV rW twisted.python.componentsrX twisted.python.deprecaterY twisted.python.failurerZ twisted.web._responsesr 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 r r r r r r r" r r, r
r' r r r r! r twisted.web.http_headersr[ r\ twisted.web.iwebr] r^ r_ twisted.web._http2r` r ImportErrorr protocol_versionr- responsesr r r r r r/ r0 r1 r2 r3 r4 r r r r r r5 r6 r r7 LineReceiverr8 r9 r rV rM compiler IConsumerr: r{ r r; r r r r r r# r
ITransport TimeoutMixinr< rg rp IAddressrm rr rw rx r r r= rv rv rv r| s A .
7
_
@
J
T* b
!0
@