HEX

File: //lib/python3/dist-packages/twisted/web/__pycache__/_newclient.cpython-310.pyc
o

�bO��@s�dZddlZddlmZddlmZmZmZmZm	Z	ddl
mZddlm
Z
mZddlmZddlmZdd	lmZdd
lmZddlmZddlmZdd
lmZddlmZmZm Z m!Z!m"Z"m#Z#ddl$m%Z%ddl&m'Z'm(Z(m)Z)dZ*dZ+dZ,dZ-e�Z.Gdd�de/�Z0Gdd�de/�Z1Gdd�de/�Z2Gdd�de2�Z3Gdd�de/�Z4Gdd �d e4�Z5Gd!d"�d"e4�Z6Gd#d$�d$e/�Z7Gd%d&�d&e/�Z8Gd'd(�d(e/�Z9Gd)d*�d*e4�Z:Gd+d,�d,e:�Z;Gd-d.�d.e/�Z<d/d0�Z=Gd1d2�d2e�Z>Gd3d4�d4e>�Z?e�@d5eA��Bd6�f�ZCd7d8�ZDe�@d9�ZEd:d;�ZFee(�Gd<d=�d=��ZGGd>d?�d?�ZHd@dA�ZIee(�ZJee)�GdBdC�dC��ZKee
�GdDdE�dE��ZLee�GdFdG�dG��ZMGdHdI�dIe�ZNdS)Ja�
An U{HTTP 1.1<http://www.w3.org/Protocols/rfc2616/rfc2616.html>} client.

The way to use the functionality provided by this module is to:

  - Connect a L{HTTP11ClientProtocol} to an HTTP server
  - Create a L{Request} with the appropriate data
  - Pass the request to L{HTTP11ClientProtocol.request}
  - The returned Deferred will fire with a L{Response} object
  - Create a L{IProtocol} provider which can handle the response body
  - Connect it to the response with L{Response.deliverBody}
  - When the protocol's C{connectionLost} method is called, the response is
    complete.  See L{Response.deliverBody} for details.

Various other classes in this module support this usage:

  - HTTPParser is the basic HTTP parser.  It can handle the parts of HTTP which
    are symmetric between requests and responses.

  - HTTPClientParser extends HTTPParser to handle response-specific parts of
    HTTP.  One instance is created for each request to parse the corresponding
    response.
�N)�implementer)�CancelledError�Deferred�fail�
maybeDeferred�succeed)�ConnectionDone)�	IConsumer�
IPushProducer)�Protocol)�Logger)�LineReceiver)�
networkString)�proxyForInterface)�Failure)�fullyQualifiedName)�
NO_CONTENT�NOT_MODIFIED�PotentialDataLoss�_ChunkedTransferDecoder�	_DataLoss�_IdentityTransferDecoder)�Headers)�UNKNOWN_LENGTH�IClientRequest�	IResponse�STATUS�HEADER�BODY�DONEc@�eZdZdZdS)�
BadHeadersz@
    Headers passed to L{Request} were in some way invalid.
    N��__name__�
__module__�__qualname__�__doc__�r'r'�8/usr/lib/python3/dist-packages/twisted/web/_newclient.pyr!D�r!c@r )�ExcessWritezx
    The body L{IBodyProducer} for a request tried to write data after
    indicating it had finished writing data.
    Nr"r'r'r'r(r*Jr)r*c@�eZdZdZdd�ZdS)�
ParseErrorzh
    Some received data could not be parsed.

    @ivar data: The string which could not be parsed.
    cCst�|||�||_dS�N)�	Exception�__init__�data)�self�reasonr0r'r'r(r/Xs
zParseError.__init__N�r#r$r%r&r/r'r'r'r(r,Qsr,c@r )�BadResponseVersionz=
    The version string in a status line was unparsable.
    Nr"r'r'r'r(r4]r)r4c@r+)�_WrapperExceptiona,
    L{_WrapperException} is the base exception type for exceptions which
    include one or more other exceptions as the low-level causes.

    @ivar reasons: A L{list} of one or more L{Failure} instances encountered
        during an HTTP request.  See subclass documentation for more details.
    cCst�||�||_dSr-)r.r/�reasons)r1r6r'r'r(r/l�
z_WrapperException.__init__Nr3r'r'r'r(r5csr5c@r )�RequestGenerationFailedz�
    There was an error while creating the bytes which make up a request.

    @ivar reasons: A C{list} of one or more L{Failure} instances giving the
        reasons the request generation was considered to have failed.
    Nr"r'r'r'r(r8qr)r8c@r )�RequestTransmissionFailedz�
    There was an error while sending the bytes which make up a request.

    @ivar reasons: A C{list} of one or more L{Failure} instances giving the
        reasons the request transmission was considered to have failed.
    Nr"r'r'r'r(r9zr)r9c@r )�ConnectionAbortedzD
    The connection was explicitly aborted by application code.
    Nr"r'r'r'r(r:�r)r:c@r )�WrongBodyLengthz�
    An L{IBodyProducer} declared the number of bytes it was going to
    produce (via its C{length} attribute) and then produced a different number
    of bytes.
    Nr"r'r'r'r(r;�r)r;c@r )�ResponseDonez�
    L{ResponseDone} may be passed to L{IProtocol.connectionLost} on the
    protocol passed to L{Response.deliverBody} and indicates that the entire
    response has been delivered.
    Nr"r'r'r'r(r<�r)r<c@seZdZdZddd�ZdS)�ResponseFaileda�
    L{ResponseFailed} indicates that all of the response to a request was not
    received for some reason.

    @ivar reasons: A C{list} of one or more L{Failure} instances giving the
        reasons the response was considered to have failed.

    @ivar response: If specified, the L{Response} received from the server (and
        in particular the status code and the headers).
    NcCst�||�||_dSr-)r5r/�response)r1r6r>r'r'r(r/�r7zResponseFailed.__init__r-r3r'r'r'r(r=�sr=c@r )�ResponseNeverReceivedzU
    A L{ResponseFailed} that knows no response bytes at all have been received.
    Nr"r'r'r'r(r?�r)r?c@r )�RequestNotSentaF
    L{RequestNotSent} indicates that an attempt was made to issue a request but
    for reasons unrelated to the details of the request itself, the request
    could not be sent.  For example, this may indicate that an attempt was made
    to send a request using a protocol which is no longer connected to a
    server.
    Nr"r'r'r'r(r@�r)r@cCs4z|�WdStytjdt|�d�YdSw)z�
    Call C{function}.  If it raises an exception, log it with a minimal
    description of the source.

    @return: L{None}
    z Unexpected exception from {name}��nameN)�
BaseException�
_moduleLog�failurer)�functionr'r'r(�_callAppFunction�s��rGc@s\eZdZdZdZhd�Zdd�Zdd�Zdd	�Zd
d�Z	dd
�Z
dd�Zdd�Zdd�Z
dS)�
HTTPParsera
    L{HTTPParser} handles the parsing side of HTTP processing. With a suitable
    subclass, it can parse either the client side or the server side of the
    connection.

    @ivar headers: All of the non-connection control message headers yet
        received.

    @ivar state: State indicator for the response parsing state machine.  One
        of C{STATUS}, C{HEADER}, C{BODY}, C{DONE}.

    @ivar _partialHeader: L{None} or a C{list} of the lines of a multiline
        header while that header is being received.
    �
>�te�upgrade�trailers�
keep-alive�proxy-connection�
connection�content-length�transfer-encodingcCs t�|_t�|_t|_d|_dSr-)r�headers�connHeadersr�state�_partialHeader�r1r'r'r(�connectionMade�s
zHTTPParser.connectionMadecCs*|jtkr	td��||_t|_|��dS)z�
        Switch to body parsing mode - interpret any more bytes delivered as
        part of the message body and deliver them to the given decoder.
        zalready in body modeN)rTr�RuntimeError�bodyDecoder�
setRawMode)r1�decoderr'r'r(�switchToBodyModes

zHTTPParser.switchToBodyModecCs�|dd�dkr|dd�}|jtkr|�|�t|_dS|jtkr]|r*|ddvrU|jdurGd�|j�}|�dd�\}}|��}|�||�|sO|�	�dS|g|_dS|j�
|�dSdS)	z2
        Handle one line from a response.
        ���N�
rs 	��:�)rTr�statusReceivedrrU�join�split�strip�headerReceived�allHeadersReceived�append)r1�line�headerrB�valuer'r'r(�lineReceived
s"




�zHTTPParser.lineReceivedcC�|j�|�dS)zM
        Pass data from the message body to the body decoder object.
        N)rY�dataReceived�r1r0r'r'r(�rawDataReceived*szHTTPParser.rawDataReceivedcCs
||jvS)a�
        Return C{True} if the given lower-cased name is the name of a
        connection control header (rather than an entity header).

        According to RFC 2616, section 14.10, the tokens in the Connection
        header are probably relevant here.  However, I am not sure what the
        practical consequences of either implementing or ignoring that are.
        So I leave it unimplemented for the time being.
        )�CONNECTION_CONTROL_HEADERS�r1rBr'r'r(�isConnectionControlHeader0s

z$HTTPParser.isConnectionControlHeadercC�dS)a
        Callback invoked whenever the first line of a new message is received.
        Override this.

        @param status: The first line of an HTTP request or response message
            without trailing I{CR LF}.
        @type status: C{bytes}
        Nr')r1�statusr'r'r(rb<�zHTTPParser.statusReceivedcCs0|��}|�|�r
|j}n|j}|�||�dS)z<
        Store the given header in C{self.headers}.
        N)�lowerrsrSrR�addRawHeader)r1rBrkrRr'r'r(rfFs

zHTTPParser.headerReceivedcCs|�d�dS)z�
        Callback invoked after the last header is passed to C{headerReceived}.
        Override this to change to the C{BODY} or C{DONE} state.
        N)r\rVr'r'r(rgQszHTTPParser.allHeadersReceivedN)r#r$r%r&�	delimiterrqrWr\rlrprsrbrfrgr'r'r'r(rH�s$
rHc@sjeZdZdZeehZdeiZdZ	e
�Zdd�Zdd�Z
dd	�Zd
d�Zdd
�Zdd�Zdd�Zdd�ZdS)�HTTPClientParseraL
    An HTTP parser which only handles HTTP responses.

    @ivar request: The request with which the expected response is associated.
    @type request: L{Request}

    @ivar NO_BODY_CODES: A C{set} of response codes which B{MUST NOT} have a
        body.

    @ivar finisher: A callable to invoke when this response is fully parsed.

    @ivar _responseDeferred: A L{Deferred} which will be called back with the
        response when all headers in the response have been received.
        Thereafter, L{None}.

    @ivar _everReceivedData: C{True} if any bytes have been received.
    schunkedNcCs||_||_t�|_d|_dS)NF)�request�finisherr�_responseDeferred�_everReceivedData)r1r{r|r'r'r(r/us
zHTTPClientParser.__init__cCsd|_t�||�dS)zM
        Override so that we know if any response has been received.
        TN)r~rHrnror'r'r(rn{szHTTPClientParser.dataReceivedc
Cs~z|�d�\}}|�d�\}}t|�t|�}}Wnty,}ztt|�|��d}~ww|dks5|dkr:td|��|||fS)z�
        Parse version strings of the form Protocol '/' Major '.' Minor. E.g.
        b'HTTP/1.1'.  Returns (protocol, major, minor).  Will raise ValueError
        on bad syntax.
        �/�.Nrzversion may not be negative)rd�int�
ValueErrorr4�str)r1�
strversion�proto�	strnumber�major�minor�er'r'r(�parseVersion�s��

zHTTPClientParser.parseVersioncCs�|�dd�}t|�dkr|\}}d}nt|�dkr|\}}}ntd|��zt|�}Wnty6td|��wt�|�|�|||j|j	|j
�|_dS)z�
        Parse the status line into its components and create a response object
        to keep track of this response's state.
        � �r_�zwrong number of partsznon-integer status codeN)rd�lenr,r�r��Response�
_constructr�rR�	transportr{r>)r1ru�parts�version�	codeBytes�phrase�
statusCoder'r'r(rb�s(

�
�zHTTPClientParser.statusReceivedcCst|_|�|�dS)a�
        Called to indicate that an entire response has been received.  No more
        bytes will be interpreted by this L{HTTPClientParser}.  Extra bytes are
        passed up and the state of this L{HTTPClientParser} is set to I{DONE}.

        @param rest: A C{bytes} giving any extra bytes delivered to this
            L{HTTPClientParser} which are not part of the response being
            parsed.
        N)rrTr|�r1�restr'r'r(�	_finished�s
zHTTPClientParser._finishedcCs$|jjdkr|dkrdSt�||�S)z�
        Content-Length in the response to a HEAD request is an entity header,
        not a connection control header.
        �HEADrPF)r{�methodrHrsrrr'r'r(rs�sz*HTTPClientParser.isConnectionControlHeadercsVd|jjkrdkr nn|jjd|jjd�|��|`dS|jj|jvs-|jjdkr>d|j_|�	|�
��|j��nb|j�
d�}|rP|j|d��}n6|j�
d	�}|dur]d�nt|�d
krnt|d���|j_ntd���dkr�|�	|�
��d}n�fdd
�}|dur�|j��n|j��|�||jj|j	��|j�|j�|`dS)zn
        Figure out how long the response body is going to be by examining
        headers and stuff.
        �d��z#Ignoring unexpected {code} response)�codeNr�rrQrPraz4Too many Content-Length headers; response is invalidcst�||�Sr-)r)�x�y��
contentLengthr'r(�<lambda>s�z5HTTPClientParser.allHeadersReceived.<locals>.<lambda>)r>r��_log�inforW�
NO_BODY_CODESr{r��lengthr��clearLineBuffer�_bodyDataFinishedrS�
getRawHeaders�_transferDecodersrwr�r�r�r��pauseProducingr\�_bodyDataReceivedr}�callback)r1�transferEncodingHeaders�transferDecoder�contentLengthHeadersr'r�r(rg�sN��
�

�
�	z#HTTPClientParser.allHeadersReceivedc	Cs�|jdurSz=z|j��Wn'ty|j�t��Yn ty4|j�tt|t�g|j���Ynw|j��WdSWdSWdStyR|j	�
d�YdSw|jtkro|j
r^t}nt}|j�t||g���|`dSdS)N�)rY�
noMoreDatarr>r�rrr=rCr�rErTrr~r?r}�errback)r1r2�exceptionClassr'r'r(�connectionLosts0
����
�zHTTPClientParser.connectionLost)r#r$r%r&rrr�rr�rYrr�r/rnr�rbr�rsrgr�r'r'r'r(rzYs� 
	Wrzs	\A[%s]+\Z)�!�#�$�%�&�'�*�+�-r��^�_�`�|�~s0-9sA-Zsa-zcC�t�|�r|Std|����)a

    An HTTP method is an HTTP token, which consists of any visible
    ASCII character that is not a delimiter (i.e. one of
    C{"(),/:;<=>?@[\]{}}.)

    @param method: the method to check
    @type method: L{bytes}

    @return: the method if it is valid
    @rtype: L{bytes}

    @raise ValueError: if the method is not valid

    @see: U{https://tools.ietf.org/html/rfc7230#section-3.1.1},
        U{https://tools.ietf.org/html/rfc7230#section-3.2.6},
        U{https://tools.ietf.org/html/rfc5234#appendix-B.1}
    zInvalid method )�
_VALID_METHOD�matchr�)r�r'r'r(�_ensureValidMethodX�
r�s\A[\x21-\x7e]+\ZcCr�)a
    A valid URI cannot contain control characters (i.e., characters
    between 0-32, inclusive and 127) or non-ASCII characters (i.e.,
    characters with values between 128-255, inclusive).

    @param uri: the URI to check
    @type uri: L{bytes}

    @return: the URI if it is valid
    @rtype: L{bytes}

    @raise ValueError: if the URI is not valid

    @see: U{https://tools.ietf.org/html/rfc3986#section-3.3},
        U{https://tools.ietf.org/html/rfc3986#appendix-A},
        U{https://tools.ietf.org/html/rfc5234#appendix-B.1}
    zInvalid URI )�
_VALID_URIr�r�)�urir'r'r(�_ensureValidURIrr�r�c@sleZdZdZe�Zddd�Ze	ddd��Ze	dd	��Z
d
d�Zdd
�Zdd�Z
dd�Zdd�Zdd�ZdS)�Requesta�
    A L{Request} instance describes an HTTP request to be sent to an HTTP
    server.

    @ivar method: See L{__init__}.
    @ivar uri: See L{__init__}.
    @ivar headers: See L{__init__}.
    @ivar bodyProducer: See L{__init__}.
    @ivar persistent: See L{__init__}.

    @ivar _parsedURI: Parsed I{URI} for the request, or L{None}.
    @type _parsedURI: L{twisted.web.client.URI} or L{None}
    FcCs0t|�|_t|�|_||_||_||_d|_dS)at
        @param method: The HTTP method for this request, ex: b'GET', b'HEAD',
            b'POST', etc.
        @type method: L{bytes}

        @param uri: The relative URI of the resource to request.  For example,
            C{b'/foo/bar?baz=quux'}.
        @type uri: L{bytes}

        @param headers: Headers to be sent to the server.  It is important to
            note that this object does not create any implicit headers.  So it
            is up to the HTTP Client to add required headers such as 'Host'.
        @type headers: L{twisted.web.http_headers.Headers}

        @param bodyProducer: L{None} or an L{IBodyProducer} provider which
            produces the content body to send to the remote HTTP server.

        @param persistent: Set to C{True} when you use HTTP persistent
            connection, defaults to C{False}.
        @type persistent: L{bool}
        N)r�r�r�r�rR�bodyProducer�
persistent�
_parsedURI)r1r�r�rRr�r�r'r'r(r/�s


zRequest.__init__NcCs||||||�}||_|S)aS
        Private constructor.

        @param method: See L{__init__}.
        @param uri: See L{__init__}.
        @param headers: See L{__init__}.
        @param bodyProducer: See L{__init__}.
        @param persistent: See L{__init__}.
        @param parsedURI: See L{Request._parsedURI}.

        @return: L{Request} instance.
        )r�)�clsr�r�rRr�r��	parsedURIr{r'r'r(r��szRequest._constructcCst|jddd���S)z{
        The absolute URI of the request as C{bytes}, or L{None} if the
        absolute URI cannot be determined.
        �toBytescS�dSr-r'r'r'r'r(r��rvz%Request.absoluteURI.<locals>.<lambda>)�getattrr�rVr'r'r(�absoluteURI�szRequest.absoluteURIcs�|j�dd�}t|�dkrtd��g}|�d�t|j�t|j	�dg��|j
s,|�d�|dur5|�|�|j��D]\�}|��fdd	�|D��q:|�d
�|�
|�dS)Nshostr'raz Exactly one Host header requiredr�s
HTTP/1.1
sConnection: close
csg|]
}�d|d�qS)s: �
r')�.0�vrAr'r(�
<listcomp>�sz)Request._writeHeaders.<locals>.<listcomp>r�)rRr�r�r!rhrcr�r�r�r�r��getAllRawHeaders�extend�
writeSequence)r1r��TEorCL�hosts�requestLines�valuesr'rAr(�
_writeHeaders�s(���	


zRequest._writeHeaderscsX|��d�t�����|jd�|j���}�fdd�}��fdd�}|�||�|S)z�
        Write this request to the given transport using chunked
        transfer-encoding to frame the body.

        @param transport: See L{writeTo}.
        @return: See L{writeTo}.
        sTransfer-Encoding: chunked
Tc����dSr-��unregisterProducer��ignored)�encoderr'r(�
cbProduced��z7Request._writeToBodyProducerChunked.<locals>.cbProducedcs������|Sr-)�_allowNoMoreWritesr���err�r�r�r'r(�
ebProduced�sz7Request._writeToBodyProducerChunked.<locals>.ebProduced)r��ChunkedEncoder�registerProducerr��startProducing�addCallbacks)r1r��dr�r�r'r�r(�_writeToBodyProducerChunked�s	z#Request._writeToBodyProducerChunkedcs|���td�jjf��t�}t�j�|�����jd��j�������fdd�}||��}�fdd�}|�|�|S)z�
        Write this request to the given transport using content-length to frame
        the body.

        @param transport: See L{writeTo}.
        @return: See L{writeTo}.
        zContent-Length: %d
Tcsf�fdd�}t|��dg����fdd�}���fdd�}����fdd�}|�|�|�||��S)	Ncr�r-)�cancel��ign)�finishedProducingr'r(�cancelConsuming,r�zSRequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.cancelConsumingcs@�dgkrd�d<��|�dS�jjd|t���dd�dS)Nrarz>Buggy state machine in {request}/[{state}]: ebConsuming called)rEr{rT)r�r�rE�reprr�)r1rT�ultimater'r(�ebConsuming7s

�zORequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.ebConsumingcsN�dgkr%d�d<z���Wnty���YdSw��d�dSdS)Nr�r)�_noMoreWritesExpectedrCr�r�)�result)r�rTr�r'r(�cbProducingNs
��zORequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.cbProducingcs<�dgkrd�d<�����|�dS�jjd|d�dS)Nr�rzProducer is buggy)rE)r�r�r�rEr�)r�r1rTr�r'r(�ebProducingcs

zORequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.ebProducing)r�
addErrbackr�)�	consuming�	producingr�r�rr)r�r�r1)rTr�r(�combine(s
z:Request._writeToBodyProducerContentLength.<locals>.combinecs���|Sr-r�)�passthrough�r�r'r(�f{sz4Request._writeToBodyProducerContentLength.<locals>.f)	r�rr�r�r�LengthEnforcingConsumerr�r��addBoth)r1r��finishedConsumingrr�rr')r�r�r1r�r(�!_writeToBodyProducerContentLengths�	�
Q
z)Request._writeToBodyProducerContentLengthcCs|�|d�td�S)z�
        Write this request to the given transport using content-length to frame
        the (empty) body.

        @param transport: See L{writeTo}.
        @return: See L{writeTo}.
        sContent-Length: 0
N)r�r�r1r�r'r'r(�_writeToEmptyBodyContentLength�sz&Request._writeToEmptyBodyContentLengthcCsR|jdur|jdvr|�|�dS|�|d�dS|jjtur$|�|�S|�|�S)a 
        Format this L{Request} as an HTTP/1.1 request and write it to the given
        transport.  If bodyProducer is not None, it will be associated with an
        L{IConsumer}.

        @param transport: The transport to which to write.
        @type transport: L{twisted.internet.interfaces.ITransport} provider

        @return: A L{Deferred} which fires with L{None} when the request has
            been completely written to the transport or with a L{Failure} if
            there is any problem generating the request bytes.
        N)sPUTsPOST)r�r�rr�r�rr�rr
r'r'r(�writeTo�s



zRequest.writeTocCst|jj�dS)aR
        Stop writing this request to the transport.  This can only be called
        after C{writeTo} and before the L{Deferred} returned by C{writeTo}
        fires.  It should cancel any asynchronous task started by C{writeTo}.
        The L{Deferred} returned by C{writeTo} need not be fired if this method
        is called.
        N)rGr��
stopProducingrVr'r'r(�stopWriting�s
zRequest.stopWriting)F)FN)r#r$r%r&rr�r/�classmethodr��propertyr�r�r�rrrrr'r'r'r(r��s
�
zr�c@s0eZdZdZdd�Zdd�Zdd�Zdd	�Zd
S)r	a�
    An L{IConsumer} proxy which enforces an exact length requirement on the
    total data written to it.

    @ivar _length: The number of bytes remaining to be written.

    @ivar _producer: The L{IBodyProducer} which is writing to this
        consumer.

    @ivar _consumer: The consumer to which at most C{_length} bytes will be
        forwarded.

    @ivar _finished: A L{Deferred} which will be fired with a L{Failure} if too
        many bytes are written to this consumer.
    cCs|j|_||_||_||_dSr-)r��_length�	_producer�	_consumerr�)r1�producer�consumer�finishedr'r'r(r/�s
z LengthEnforcingConsumer.__init__cC�
d|_dS�z�
        Indicate that no additional writes are allowed.  Attempts to write
        after calling this method will be met with an exception.
        N)r�rVr'r'r(r���
z*LengthEnforcingConsumer._allowNoMoreWritescCsr|jdur
|j��t��t|�|jkr%|jt|�8_|j�|�dSt|jj�|j�	t
d��|��dS)z�
        Write C{bytes} to the underlying consumer unless
        C{_noMoreWritesExpected} has been called or there are/have been too
        many bytes.
        Nztoo many bytes written)r�rrr*r�rr�writerGr�r;r��r1�bytesr'r'r(r�s

zLengthEnforcingConsumer.writecCs(|jdur|��|jrtd��dSdS)z�
        Called to indicate no more bytes will be written to this consumer.
        Check to see that the correct number have been written.

        @raise WrongBodyLength: If not enough bytes have been written.
        Nztoo few bytes written)r�r�rr;rVr'r'r(r��s
�z-LengthEnforcingConsumer._noMoreWritesExpectedN)r#r$r%r&r/r�rr�r'r'r'r(r	�sr	cs�fdd�}|j|_|S)a}
    Given a I{dispatch} name and a function, return a function which can be
    used as a method and which, when called, will call another method defined
    on the instance and return the result.  The other method which is called is
    determined by the value of the C{_state} attribute of the instance.

    @param name: A string which is used to construct the name of the subsidiary
        method to invoke.  The subsidiary method is named like C{'_%s_%s' %
        (name, _state)}.

    @param template: A function object which is used to give the returned
        function a docstring.

    @return: The dispatcher function.
    csJt|d�d|jd�}|durt|�d��d|j����||i|��S)N�_z has no z method in state )r��_staterX)r1�args�kwargs�funcrAr'r(�
dispatchersz*makeStatefulDispatcher.<locals>.dispatcher)r&)rB�templater%r'rAr(�makeStatefulDispatcher�sr'c@s�eZdZdZeZdZdZdd�Ze	dd��Z
dd	�Zd
d�Ze
de�Zd
d�Zdd�Zdd�Zdd�Zdd�Ze
de�Zdd�Zdd�Zdd�Zdd�Zd+d d!�Ze
d"e�Zd+d#d$�Zd+d%d&�Zd'd(�Zd)d*�ZdS),r�a
    A L{Response} instance describes an HTTP response received from an HTTP
    server.

    L{Response} should not be subclassed or instantiated.

    @ivar _transport: See L{__init__}.

    @ivar _bodyProtocol: The L{IProtocol} provider to which the body is
        delivered.  L{None} before one has been registered with
        C{deliverBody}.

    @ivar _bodyBuffer: A C{list} of the strings passed to C{bodyDataReceived}
        before C{deliverBody} is called.  L{None} afterwards.

    @ivar _state: Indicates what state this L{Response} instance is in,
        particularly with respect to delivering bytes from the response body
        to an application-supplied protocol object.  This may be one of
        C{'INITIAL'}, C{'CONNECTED'}, C{'DEFERRED_CLOSE'}, or C{'FINISHED'},
        with the following meanings:

          - INITIAL: This is the state L{Response} objects start in.  No
            protocol has yet been provided and the underlying transport may
            still have bytes to deliver to it.

          - DEFERRED_CLOSE: If the underlying transport indicates all bytes
            have been delivered but no application-provided protocol is yet
            available, the L{Response} moves to this state.  Data is
            buffered and waiting for a protocol to be delivered to.

          - CONNECTED: If a protocol is provided when the state is INITIAL,
            the L{Response} moves to this state.  Any buffered data is
            delivered and any data which arrives from the transport
            subsequently is given directly to the protocol.

          - FINISHED: If a protocol is provided in the DEFERRED_CLOSE state,
            the L{Response} moves to this state after delivering all
            buffered data to the protocol.  Otherwise, if the L{Response} is
            in the CONNECTED state, if the transport indicates there is no
            more data, the L{Response} moves to this state.  Nothing else
            can happen once the L{Response} is in this state.
    @type _state: C{str}
    NFcCs:||_||_||_||_||_g|_d|_d|_d|_dS)a�
        @param version: HTTP version components protocol, major, minor. E.g.
            C{(b'HTTP', 1, 1)} to mean C{b'HTTP/1.1'}.

        @param code: HTTP status code.
        @type code: L{int}

        @param phrase: HTTP reason phrase, intended to give a short description
            of the HTTP status code.

        @param headers: HTTP response headers.
        @type headers: L{twisted.web.http_headers.Headers}

        @param _transport: The transport which is delivering this response.
        �INITIALN)	r�r�r�rR�
_transport�_bodyBufferr!r{�previousResponse)r1r�r�r�rRr)r'r'r(r/Ss
zResponse.__init__cCst|||||�}t|�|_|S)aM
        Private constructor.

        @param version: See L{__init__}.
        @param code: See L{__init__}.
        @param phrase: See L{__init__}.
        @param headers: See L{__init__}.
        @param _transport: See L{__init__}.
        @param request: See L{IResponse.request}.

        @return: L{Response} instance.
        )r��_ClientRequestProxyr{)r�r�r�r�rRr)r{r>r'r'r(r�ms
zResponse._constructcC�
||_dSr-)r+)r1r+r'r'r(�setPreviousResponse�
zResponse.setPreviousResponsecCrt)zi
        Dispatch the given L{IProtocol} depending of the current state of the
        response.
        Nr'�r1�protocolr'r'r(�deliverBody�rvzResponse.deliverBodyr2cCsD|�|j�||_|jD]}|j�|�qd|_d|_|j��dS)z�
        Deliver any buffered data to C{protocol} and prepare to deliver any
        future data to it.  Move to the C{'CONNECTED'} state.
        N�	CONNECTED)�makeConnectionr)�
_bodyProtocolr*rnr!�resumeProducing�r1r1r0r'r'r(�_deliverBody_INITIAL�s
zResponse._deliverBody_INITIALcCstd|jf��)z�
        It is invalid to attempt to deliver data to a protocol when it is
        already being delivered to another protocol.
        z:Response already has protocol %r, cannot deliverBody again)rXr5r0r'r'r(�_deliverBody_CONNECTED�s
��zResponse._deliverBody_CONNECTEDcCs>|�|j�|jD]}|�|�q	d|_|�|j�d|_dS)z�
        Deliver any buffered data to C{protocol} and then disconnect the
        protocol.  Move to the C{'FINISHED'} state.
        N�FINISHED)r4r)r*rnr��_reasonr!r7r'r'r(�_deliverBody_DEFERRED_CLOSE�s


z$Response._deliverBody_DEFERRED_CLOSEcC�td��)z�
        It is invalid to attempt to deliver data to a protocol after the
        response body has been delivered to another protocol.
        z2Response already finished, cannot deliverBody now.�rXr0r'r'r(�_deliverBody_FINISHED��zResponse._deliverBody_FINISHEDcCrt)z�
        Called by HTTPClientParser with chunks of data from the response body.
        They will be buffered or delivered to the protocol passed to
        deliverBody.
        Nr'ror'r'r(r��rvzResponse._bodyDataReceived�bodyDataReceivedcCrm)a
        Buffer any data received for later delivery to a protocol passed to
        C{deliverBody}.

        Little or no data should be buffered by this method, since the
        transport has been paused and will not be resumed until a protocol
        is supplied.
        N)r*rhror'r'r(�_bodyDataReceived_INITIAL�s	z"Response._bodyDataReceived_INITIALcCrm)zk
        Deliver any data received to the protocol to which this L{Response}
        is connected.
        N)r5rnror'r'r(�_bodyDataReceived_CONNECTED�sz$Response._bodyDataReceived_CONNECTEDcCr=)z�
        It is invalid for data to be delivered after it has been indicated
        that the response body has been completely delivered.
        z0Cannot receive body data after _bodyDataFinishedr>ror'r'r(� _bodyDataReceived_DEFERRED_CLOSE�r@z)Response._bodyDataReceived_DEFERRED_CLOSEcCr=)zz
        It is invalid for data to be delivered after the response body has
        been delivered to a protocol.
        z4Cannot receive body data after protocol disconnectedr>ror'r'r(�_bodyDataReceived_FINISHED�r@z#Response._bodyDataReceived_FINISHEDcCrt)z�
        Called by HTTPClientParser when no more body data is available.  If the
        optional reason is supplied, this indicates a problem or potential
        problem receiving all of the response body.
        Nr'�r1r2r'r'r(r��rvzResponse._bodyDataFinished�bodyDataFinishedcCs$d|_|dur
ttd��}||_dS)z}
        Move to the C{'DEFERRED_CLOSE'} state to wait for a protocol to
        which to deliver the response body.
        �DEFERRED_CLOSEN�Response body fully received)r!rr<r;rFr'r'r(�_bodyDataFinished_INITIAL�s
z"Response._bodyDataFinished_INITIALcCs0|dur
ttd��}|j�|�d|_d|_dS)zN
        Disconnect the protocol and move to the C{'FINISHED'} state.
        NrIr:)rr<r5r�r!rFr'r'r(�_bodyDataFinished_CONNECTED�s

z$Response._bodyDataFinished_CONNECTEDcCr=)��
        It is invalid to attempt to notify the L{Response} of the end of the
        response body data more than once.
        z&Cannot finish body data more than oncer>rVr'r'r(� _bodyDataFinished_DEFERRED_CLOSEr@z)Response._bodyDataFinished_DEFERRED_CLOSEcCr=)rLz3Cannot finish body data after protocol disconnectedr>rVr'r'r(�_bodyDataFinished_FINISHEDr@z#Response._bodyDataFinished_FINISHEDr-)r#r$r%r&rr�r5�
_bodyFinishedr/rr�r.r2r'r8r9r<r?r�rBrCrDrEr�rJrKrMrNr'r'r'r(r� s6,









r�c@s8eZdZdZdd�Zdd�Zdd�Zdd	�Zd
d�ZdS)
r�z�
    Helper object which exposes L{IConsumer} on top of L{HTTP11ClientProtocol}
    for streaming request bodies to the server.
    cCr-r-rr
r'r'r(r/r/zChunkedEncoder.__init__cCrrrrVr'r'r(r� rz!ChunkedEncoder._allowNoMoreWritescCs|j�||�dS)zE
        Register the given producer with C{self.transport}.
        N)r�r�)r1r�	streamingr'r'r(r�'szChunkedEncoder.registerProducercCs2|jdurt��|j�tdt|��|df�dS)z�
        Write the given request body bytes to the transport using chunked
        encoding.

        @type data: C{bytes}
        Nz%x
r�)r�r*r�rr�ror'r'r(r-s

�zChunkedEncoder.writecCs |�d�|j��|��dS)zT
        Indicate that the request body is complete and finish the request.
        r_N)rr�r�r�rVr'r'r(r�:s

z!ChunkedEncoder.unregisterProducerN)	r#r$r%r&r/r�r�rr�r'r'r'r(r�s
r�c@sDeZdZdZdZdd�Zdd�Zdd�Zd	d
�Zdd�Z	d
d�Z
dS)�TransportProxyProducera'
    An L{twisted.internet.interfaces.IPushProducer} implementation which
    wraps another such thing and proxies calls to it until it is told to stop.

    @ivar _producer: The wrapped L{twisted.internet.interfaces.IPushProducer}
    provider or L{None} after this proxy has been stopped.
    FcCr-r-�r)r1rr'r'r(r/Ur/zTransportProxyProducer.__init__cCr)z�
        Stop forwarding calls of L{twisted.internet.interfaces.IPushProducer}
        methods to the underlying L{twisted.internet.interfaces.IPushProducer}
        provider.
        NrRrVr'r'r(�stopProxyingXs
z#TransportProxyProducer.stopProxyingcC�|jdur|j��dSdS)zl
        Proxy the stoppage to the underlying producer, unless this proxy has
        been stopped.
        N)rrrVr'r'r(r`�
�z$TransportProxyProducer.stopProducingcCrT)zn
        Proxy the resumption to the underlying producer, unless this proxy has
        been stopped.
        N)rr6rVr'r'r(r6hrUz&TransportProxyProducer.resumeProducingcCrT)zi
        Proxy the pause to the underlying producer, unless this proxy has been
        stopped.
        N)rr�rVr'r'r(r�prUz%TransportProxyProducer.pauseProducingcCrT)z�
        Proxy the request to lose the connection to the underlying producer,
        unless this proxy has been stopped.
        N)r�loseConnectionrVr'r'r(rVxrUz%TransportProxyProducer.loseConnectionN)r#r$r%r&�
disconnectingr/rSrr6r�rVr'r'r'r(rQCsrQc@s�eZdZdZdZdZdZdZdZdZ	e
�Zdd�fdd�Ze
dd	��Zd
d�Zdd
�Zede�Zdd�ZeZdd�Zdd�Zdd�Zdd�Zede�Zdd�Zdd�Zdd�Zd d!�Zd"d#�Zd$d%�Zd&d'�ZdS)(�HTTP11ClientProtocola(
    L{HTTP11ClientProtocol} is an implementation of the HTTP 1.1 client
    protocol.  It supports as few features as possible.

    @ivar _parser: After a request is issued, the L{HTTPClientParser} to
        which received data making up the response to that request is
        delivered.

    @ivar _finishedRequest: After a request is issued, the L{Deferred} which
        will fire when a L{Response} object corresponding to that request is
        available.  This allows L{HTTP11ClientProtocol} to fail the request
        if there is a connection or parsing problem.

    @ivar _currentRequest: After a request is issued, the L{Request}
        instance used to make that request.  This allows
        L{HTTP11ClientProtocol} to stop request generation if necessary (for
        example, if the connection is lost).

    @ivar _transportProxy: After a request is issued, the
        L{TransportProxyProducer} to which C{_parser} is connected.  This
        allows C{_parser} to pause and resume the transport in a way which
        L{HTTP11ClientProtocol} can exert some control over.

    @ivar _responseDeferred: After a request is issued, the L{Deferred} from
        C{_parser} which will fire with a L{Response} when one has been
        received.  This is eventually chained with C{_finishedRequest}, but
        only in certain cases to avoid double firing that Deferred.

    @ivar _state: Indicates what state this L{HTTP11ClientProtocol} instance
        is in with respect to transmission of a request and reception of a
        response.  This may be one of the following strings:

          - QUIESCENT: This is the state L{HTTP11ClientProtocol} instances
            start in.  Nothing is happening: no request is being sent and no
            response is being received or expected.

          - TRANSMITTING: When a request is made (via L{request}), the
            instance moves to this state.  L{Request.writeTo} has been used
            to start to send a request but it has not yet finished.

          - TRANSMITTING_AFTER_RECEIVING_RESPONSE: The server has returned a
            complete response but the request has not yet been fully sent
            yet.  The instance will remain in this state until the request
            is fully sent.

          - GENERATION_FAILED: There was an error while the request.  The
            request was not fully sent to the network.

          - WAITING: The request was fully sent to the network.  The
            instance is now waiting for the response to be fully received.

          - ABORTING: Application code has requested that the HTTP connection
            be aborted.

          - CONNECTION_LOST: The connection has been lost.
    @type _state: C{str}

    @ivar _abortDeferreds: A list of C{Deferred} instances that will fire when
        the connection is lost.
    �	QUIESCENTNcCr�r-r')�cr'r'r(r��rvzHTTP11ClientProtocol.<lambda>cCs||_g|_dSr-)�_quiescentCallback�_abortDeferreds)r1�quiescentCallbackr'r'r(r/�s
zHTTP11ClientProtocol.__init__cCs|jSr-�r!rVr'r'r(rT�szHTTP11ClientProtocol.statecs��jdkr
tt��Sd�_t|j�j����fdd�}t|��_|�_t	�j��_
t|�j��_
�j
��j
��j
j�_�fdd�}�fdd�}��||��jS)	a�
        Issue C{request} over C{self.transport} and return a L{Deferred} which
        will fire with a L{Response} instance or an error.

        @param request: The object defining the parameters of the request to
           issue.
        @type request: L{Request}

        @rtype: L{Deferred}
        @return: The deferred may errback with L{RequestGenerationFailed} if
            the request was not fully written to the transport due to a local
            error.  It may errback with L{RequestTransmissionFailed} if it was
            not fully written to the transport due to a network error.  It may
            errback with L{ResponseFailed} if the request was sent (not
            necessarily received) but some or all of the response was lost.  It
            may errback with L{RequestNotSent} if it is not possible to send
            any more requests using this L{HTTP11ClientProtocol}.
        rY�TRANSMITTINGcs4�jdvr���dS�j����tt���dS)N)r_�%TRANSMITTING_AFTER_RECEIVING_RESPONSE)r!r�r��abortConnection�_disconnectParserrrr���_requestDeferredr1r'r(�
cancelRequest�s

z3HTTP11ClientProtocol.request.<locals>.cancelRequestcs&�jdkrd�_�j��j�dSdS)Nr_�WAITING)r!r}�
chainDeferred�_finishedRequestr�rVr'r(�cbRequestWritten�s
�z6HTTP11ClientProtocol.request.<locals>.cbRequestWrittencsL�jdkrd�_�j���j�tt|g���dS�jjd|�jd�dS)Nr_�GENERATION_FAILEDzJError writing request, but not in valid state to finalize request: {state})rErT)	r!r�rarhr�rr8r�rEr�rVr'r(�ebRequestWritings


�z6HTTP11ClientProtocol.request.<locals>.ebRequestWriting)r!rr@rrr�rrh�_currentRequestrQ�_transportProxyrz�_finishResponse�_parserr4r}r�)r1r{rerirkr'rcr(r{�s


	

zHTTP11ClientProtocol.requestcCrt)a!
        Called by an L{HTTPClientParser} to indicate that it has parsed a
        complete response.

        @param rest: A C{bytes} giving any trailing bytes which were given to
            the L{HTTPClientParser} which were not part of the response it
            was parsing.
        Nr'r�r'r'r(rnrvz$HTTP11ClientProtocol._finishResponse�finishResponsecCs�|jdkr	d|_n
d|_|j�|j�|jdurdStd�}|jj�dd�}d|vs3|jdks3|jj	s<|�
t|��dS|j�
�z|�|�Wnty\|j�d�|j��Ynw|�|�dS)	NrfrYr`z
synthetic!rOr'scloser�)r!r}rgrhrorrSr�rlr��_giveUprr�r6r[rCr�rErVrb)r1r�r2rSr'r'r(�_finishResponse_WAITINGs*


�
�z,HTTP11ClientProtocol._finishResponse_WAITINGcCsJ|jdur#|j}d|_d|_d|_d|_|j��d|_|�|�dSdS)z�
        If there is still a parser, call its C{connectionLost} method with the
        given reason.  If there is not, do nothing.

        @type reason: L{Failure}
        N)rorlrhr}rmrSr�)r1r2�parserr'r'r(rbMs

�z&HTTP11ClientProtocol._disconnectParsercCs|j��|�|�dS)z�
        Lose the underlying connection and disconnect the parser with the given
        L{Failure}.

        Use this method instead of calling the transport's loseConnection
        method directly otherwise random things will break.
        N)r�rVrbrFr'r'r(rqcs
zHTTP11ClientProtocol._giveUpcCs4z	|j�|�WdSty|�t��YdSw)z4
        Handle some stuff from some place.
        N)rornrCrqrrr'r'r(rnns
�z!HTTP11ClientProtocol.dataReceivedcCrt)zh
        The underlying transport went away.  If appropriate, notify the parser
        object.
        Nr'rFr'r'r(r�wrvz#HTTP11ClientProtocol.connectionLostr�cC�
d|_dS)z{
        Nothing is currently happening.  Move to the C{'CONNECTION_LOST'}
        state but otherwise do nothing.
        �CONNECTION_LOSTNr^rFr'r'r(�_connectionLost_QUIESCENTrz.HTTP11ClientProtocol._connectionLost_QUIESCENTcCrt)z�
        The connection was in an inconsistent state.  Move to the
        C{'CONNECTION_LOST'} state but otherwise do nothing.
        ruNr^rFr'r'r(�!_connectionLost_GENERATION_FAILED�rz6HTTP11ClientProtocol._connectionLost_GENERATION_FAILEDcCs.d|_|j�tt|g���|`|j��dS)z�
        Fail the L{Deferred} for the current request, notify the request
        object that it does not need to continue transmitting itself, and
        move to the C{'CONNECTION_LOST'} state.
        ruN)r!rhr�rr9rlrrFr'r'r(�_connectionLost_TRANSMITTING�sz1HTTP11ClientProtocol._connectionLost_TRANSMITTINGcCrt)z9
        Move to the C{'CONNECTION_LOST'} state.
        ruNr^rFr'r'r(�5_connectionLost_TRANSMITTING_AFTER_RECEIVING_RESPONSE�s
zJHTTP11ClientProtocol._connectionLost_TRANSMITTING_AFTER_RECEIVING_RESPONSEcCs|�|�d|_dS)a
        Disconnect the response parser so that it can propagate the event as
        necessary (for example, to call an application protocol's
        C{connectionLost} method, or to fail a request L{Deferred}) and move
        to the C{'CONNECTION_LOST'} state.
        ruN)rbr!rFr'r'r(�_connectionLost_WAITING�s

z,HTTP11ClientProtocol._connectionLost_WAITINGcCs6|�tt���d|_|jD]}|�d�qg|_dS)z�
        Disconnect the response parser with a L{ConnectionAborted} failure, and
        move to the C{'CONNECTION_LOST'} state.
        ruN)rbrr:r!r\r�)r1r2r�r'r'r(�_connectionLost_ABORTING�s


z-HTTP11ClientProtocol._connectionLost_ABORTINGcCs8|jdkr	td�S|j��d|_t�}|j�|�|S)zw
        Close the connection and cause all outstanding L{request} L{Deferred}s
        to fire with an error.
        ruN�ABORTING)r!rr�rVrr\rh)r1r�r'r'r(�abort�s

zHTTP11ClientProtocol.abort)r#r$r%r&r!rorhrlrmr}rr�r/rrTr{rnr'rr�_finishResponse_TRANSMITTINGrbrqrnr�rvrwrxryrzr{r}r'r'r'r(rX�s:=
C

-	


rX)Or&�re�zope.interfacer�twisted.internet.deferrrrrr�twisted.internet.errorr�twisted.internet.interfacesr	r
�twisted.internet.protocolr�twisted.loggerr�twisted.protocols.basicr
�twisted.python.compatr�twisted.python.componentsr�twisted.python.failurer�twisted.python.reflectr�twisted.web.httprrrrrr�twisted.web.http_headersr�twisted.web.iwebrrrrrrrrDr.r!r*r,r4r5r8r9r:r;r<r=r?r@rGrHrz�compilerrcr�r�r�r�r�r	r'r,r�r�rQrXr'r'r'r(�<module>s� 		
c����
/Gv,=