← Back
Editing: _newclient.cpython-38.pyc
U s�@g� � @ s� d Z ddlmZmZ eZddlZddlmZ ddl m Z ddl m Z ddl mZ ddlmZ dd lmZmZ dd lmZ dd lmZmZmZmZ dd lmZ dd l m Z ddl m Z ddl m!Z!m"Z"m#Z# ddl$m%Z% ddl&m'Z'm(Z( ddl&m)Z)m*Z* ddl&m+Z+m,Z, ddl-m.Z. dZ/dZ0dZ1dZ2e.� Z3G dd� de4�Z5G dd � d e4�Z6G d d � d e4�Z7G d d � d e7�Z8G d!d"� d"e4�Z9G d#d$� d$e9�Z:G d%d&� d&e9�Z;G d'd(� d(e4�Z<G d)d*� d*e4�Z=G d+d,� d,e4�Z>G d-d.� d.e9�Z?G d/d0� d0e?�Z@G d1d2� d2e4�ZAd3d4� ZBG d5d6� d6e �ZCG d7d8� d8eC�ZDe�Ed9eF� �Gd:�f �ZHd;d<� ZIe�Ed=�ZJd>d?� ZKee#�G d@dA� dA��ZLG dBdC� dC�ZMdDdE� ZNe e#�ZOee"�G dFdG� dG��ZPee�G dHdI� dI��ZQee�G dJdK� dK��ZRG dLdM� dMe �ZSdS )Na� 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. � )�division�absolute_importN)� implementer)� networkString)�proxyForInterface)�fullyQualifiedName)�Failure)� IConsumer� IPushProducer)�ConnectionDone)�Deferred�succeed�fail� maybeDeferred)�CancelledError)�Protocol)� LineReceiver)�UNKNOWN_LENGTH� IResponse�IClientRequest)�Headers)� NO_CONTENT� NOT_MODIFIED)� _DataLoss�PotentialDataLoss)�_IdentityTransferDecoder�_ChunkedTransferDecoder)�Logger�STATUS�HEADER�BODY�DONEc @ s e Zd ZdZdS )� 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" = s r" c @ s e Zd ZdZdS )� 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* D s r* c @ s e Zd ZdZdd� ZdS )� ParseErrorzh Some received data could not be parsed. @ivar data: The string which could not be parsed. c C s t �| ||� || _d S �N)� Exception�__init__�data)�self�reasonr/ r( r( r) r. Q s zParseError.__init__N�r$ r% r& r' r. r( r( r( r) r+ K s r+ c @ s e Zd ZdZdS )�BadResponseVersionz= The version string in a status line was unparsable. Nr# r( r( r( r) r3 W s r3 c @ s e Zd ZdZdd� ZdS )�_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. c C s t �| |� || _d S r, )r- r. �reasons)r0 r5 r( r( r) r. f s z_WrapperException.__init__Nr2 r( r( r( r) r4 ^ s r4 c @ s e Zd ZdZdS )�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) r6 l s r6 c @ s e Zd ZdZdS )�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) r7 v s r7 c @ s e Zd ZdZdS )�ConnectionAbortedzD The connection was explicitly aborted by application code. Nr# r( r( r( r) r8 � s r8 c @ s e Zd ZdZdS )�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) r9 � s r9 c @ s e Zd ZdZdS )� 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: � s r: c @ s e Zd ZdZddd�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). Nc C s t �| |� || _d S r, )r4 r. �response)r0 r5 r< r( r( r) r. � s zResponseFailed.__init__)Nr2 r( r( r( r) r; � s r; c @ s e Zd ZdZdS )�ResponseNeverReceivedzU A L{ResponseFailed} that knows no response bytes at all have been received. Nr# r( r( r( r) r= � s r= c @ s e Zd ZdZdS )�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> � s r> c C s. z | � W n t jdt| �d� Y nX dS )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)� _moduleLog�failurer )Zfunctionr( r( r) �_callAppFunction� s �rC c @ sl e Zd ZdZdZeddddddd d g�Zd d � Zd d� Zdd� Z dd� Z dd� Z dd� Z dd� Z dd� ZdS ) � 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. � � content-length� connections keep-alives tes trailers� transfer-encodings upgrades proxy-connectionc C s t � | _t � | _t| _d | _d S r, )r �headers� connHeadersr �state�_partialHeader�r0 r( r( r) �connectionMade� s zHTTPParser.connectionMadec C s* | j tkrtd��|| _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)rK r � RuntimeError� bodyDecoderZ setRawMode)r0 �decoderr( r( r) �switchToBodyMode s zHTTPParser.switchToBodyModec C s� |dd� dkr |dd� }| j tkr8| �|� t| _ nx| j tkr�|rR|d dkr�| jdk r�d�| j�}|�dd�\}}|�� }| �||� |s�| � � q�|g| _n | j� |� dS ) z2 Handle one line from a response. ���N� r s � � :� ) rK r �statusReceivedr rL �join�split�strip�headerReceived�allHeadersReceived�append)r0 �line�headerr@ �valuer( r( r) � lineReceived s zHTTPParser.lineReceivedc C s | j �|� dS )zM Pass data from the message body to the body decoder object. N)rP � dataReceived�r0 r/ r( r( r) �rawDataReceived, s zHTTPParser.rawDataReceivedc C s || j kS )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�r0 r@ r( r( r) �isConnectionControlHeader3 s z$HTTPParser.isConnectionControlHeaderc C s 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( )r0 �statusr( r( r) rX @ s zHTTPParser.statusReceivedc C s0 |� � }| �|�r| j}n| j}|�||� dS )z< Store the given header in C{self.headers}. N)�lowerrh rJ rI Z addRawHeader)r0 r@ ra rI r( r( r) r\ K s zHTTPParser.headerReceivedc C s | � 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)rR rM r( r( r) r] W s z HTTPParser.allHeadersReceivedN)r$ r% r& r' Z delimiter�setrf rN rR rb re rh rX r\ r] r( r( r( r) rD � s( $ � rD c @ sn e Zd ZdZeeeg�ZdeiZ dZ e � Z dd� Z dd� Zdd � Zd d � Zd d � 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. s chunkedNc C s || _ || _t� | _d| _d S )NF)�request�finisherr �_responseDeferred�_everReceivedData)r0 rm rn r( r( r) r. { s zHTTPClientParser.__init__c C s d| _ t�| |� dS )zM Override so that we know if any response has been received. TN)rp rD rc rd r( r( r) rc � s z HTTPClientParser.dataReceivedc C s� z2|� d�\}}|� d�\}}t|�t|� }}W n0 tk rb } ztt|�|��W 5 d}~X Y nX |dk st|dk r~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. � /� .Nr zversion may not be negative)rZ �int� ValueErrorr3 �str)r0 Z strversion�protoZ strnumber�major�minor�er( r( r) � parseVersion� s �z HTTPClientParser.parseVersionc C s� |� dd�}t|�dkr&|\}}d}n"t|�dkr>|\}}}n td|��z t|�}W n tk rr td|��Y nX t�| �|�||| 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. � � rU � zwrong number of partsznon-integer status codeN) rZ �lenr+ rs rt �Response� _constructrz rI � transportrm r< )r0 ri �parts�versionZ codeBytes�phraseZ statusCoder( r( r) rX � s& �z HTTPClientParser.statusReceivedc C s t | _| �|� 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)r! rK rn �r0 �restr( r( r) � _finished� s zHTTPClientParser._finishedc C s$ | j jdkr|dkrdS t�| |�S )z� Content-Length in the response to a HEAD request is an entity header, not a connection control header. � HEADrF F)rm �methodrD rh rg r( r( r) rh � s z*HTTPClientParser.isConnectionControlHeaderc sZ d| j j krdk r@n n$| jjd| j jd� | �� | ` dS | j j| jksZ| jjdkr|d| j _| � | � � � | j � � n�| j � d�}|r�| j|d �� }nn| j � d �}|dkr�d� n*t|�d kr�t|d �� � | j _ntd ��� dk�r| � | � � � d}n � fd d �}|dk�r$| j � � n | j�� | �|| j j| 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� r rH rF rW z4Too many Content-Length headers; response is invalidc s t � | |�S r, )r )�x�y�Z contentLengthr( r) �<lambda> s �z5HTTPClientParser.allHeadersReceived.<locals>.<lambda>)r< r� �_log�inforN � NO_BODY_CODESrm r� �lengthr� ZclearLineBuffer�_bodyDataFinishedrJ � getRawHeaders�_transferDecodersrj r~ rs rt r� �pauseProducingrR �_bodyDataReceivedro �callback)r0 ZtransferEncodingHeadersZtransferDecoderZcontentLengthHeadersr( r� r) r] � sR � � �� � z#HTTPClientParser.allHeadersReceivedc C s� | j d k r�zpz| j �� W nR tk r< | j�t� � Y n< tk rl | j�tt|t� g| j��� Y n X | j�� W q� | j� d� Y q�X n4| j t kr�| j r�t}nt }| j�t||g��� | `d S )N� )rP Z noMoreDatar r< r� r r r; r� rB rK r! rp r= ro �errback)r0 r1 ZexceptionClassr( r( r) �connectionLost+ s* �� z HTTPClientParser.connectionLost)r$ r% r& r' rk r r r� r r� rP r r� r. rc rz rX r� rh r] r� r( r( r( r) rl ` s �! Vrl s \A[%s]+\Z)� !� #� $� %� &� '� *� +� -rr � ^� _� `� |� ~s 0-9s A-Zs a-zc C s t �| �r| S td�| ���dS )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 {!r}N)� _VALID_METHOD�matchrt �format)r� r( r( r) �_ensureValidMethodX s r� s \A[\x21-\x7e]+\Zc C s t �| �r| S td�| ���dS )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 {!r}N)� _VALID_URIr� rt r� )�urir( r( r) �_ensureValidURIt s r� c @ sj e Zd ZdZe� Zddd�Zeddd��Ze dd � �Z d d � Z d d � Z dd� 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} Fc C s0 t |�| _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� rI � bodyProducer� persistent� _parsedURI)r0 r� r� rI r� r� r( r( r) r. � s zRequest.__init__Nc C s | |||||�}||_ |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� rI r� r� Z parsedURIrm r( r( r) r� � s zRequest._constructc C s t | jddd� �� S )z{ The absolute URI of the request as C{bytes}, or L{None} if the absolute URI cannot be determined. ZtoBytesc S s d S r, r( r( r( r( r) r� � rU z%Request.absoluteURI.<locals>.<lambda>)�getattrr� rM r( r( r) � absoluteURI� s zRequest.absoluteURIc s� | j �dd�}t|�dkr"td��g }|�d�t| j�t| j �dg�� | j sX|�d� |d k rj|�|� | j � � D ] \� }|� � fdd �|D �� qt|�d � |� |� d S ) Ns hostr( rW z Exactly one Host header requiredr{ s HTTP/1.1 s Connection: close c s g | ]}� d | d �qS )s : � r( )�.0�vr? r( r) � <listcomp>� s z)Request._writeHeaders.<locals>.<listcomp>r� )rI r� r~ r" r^ rY r� r� r� r� r� ZgetAllRawHeaders�extend� writeSequence)r0 r� ZTEorCLZhostsZ requestLines�valuesr( r? r) � _writeHeaders� s( ��� zRequest._writeHeadersc sX | � �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}. s Transfer-Encoding: chunked Tc s � � � d S r, ��unregisterProducer�Zignored)�encoderr( r) � cbProduced s z7Request._writeToBodyProducerChunked.<locals>.cbProducedc s � � � ��� | S r, )�_allowNoMoreWritesr� ��err�r� r� r( r) � ebProduced s z7Request._writeToBodyProducerChunked.<locals>.ebProduced)r� �ChunkedEncoder�registerProducerr� �startProducing� addCallbacks)r0 r� �dr� r� r( r� r) �_writeToBodyProducerChunked� s z#Request._writeToBodyProducerChunkedc s| �� �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 Tc sf �fdd�}t |��d g� �� �fdd�}�� �fdd�}��� �fdd�}| �|� |�||� �S ) Nc s � � � d S r, )�cancel�Zign)�finishedProducingr( r) �cancelConsuming/ s zSRequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.cancelConsumingc s> �d gkr d�d< �� | � n � jjd| t� ��d d� d S )NrW r z>Buggy state machine in {request}/[{state}]: ebConsuming called)rB rm rK )r� r� rB �reprr� )r0 rK �ultimater( r) � ebConsuming9 s �zORequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.ebConsumingc sB �d gkr>d�d< z � � � W n ��� Y n X ��d � d S )Nr| r )�_noMoreWritesExpectedr� r� )�result)r� rK r� r( r) � cbProducingP s zORequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.cbProducingc s: �d gkr&d�d< � � � ��| � n�jjd| d� d S )Nr} r zProducer is buggy)rB )r� r� r� rB r� )r� r0 rK r� r( r) � ebProducinge s zORequest._writeToBodyProducerContentLength.<locals>.combine.<locals>.ebProducing)r Z addErrbackr� )Z consumingZ producingr� r� r� r� )r� r� r0 )rK r� r) �combine+ s z:Request._writeToBodyProducerContentLength.<locals>.combinec s � � � | S r, r� )Z passthrough�r� r( r) �f| s z4Request._writeToBodyProducerContentLength.<locals>.f) r� r r� r� r �LengthEnforcingConsumerr� r� ZaddBoth)r0 r� ZfinishedConsumingr� r� r� r( )r� r� r0 r� r) �!_writeToBodyProducerContentLength s& �� � P z)Request._writeToBodyProducerContentLengthc C s | � |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}. s Content-Length: 0 N)r� r �r0 r� r( r( r) � _writeToEmptyBodyContentLength� s z&Request._writeToEmptyBodyContentLengthc C sR | j dkr.| jdkr | �|� qN| �|d� n | j jtkrD| �|�S | �|�S dS )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)s PUTs POST)r� r� r� r� r� r r� r� r� r( r( r) �writeTo� s zRequest.writeToc C s t | 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)rC r� � stopProducingrM r( r( r) � stopWriting� s zRequest.stopWriting)F)FN)r$ r% r& r' r r� r. � classmethodr� �propertyr� r� r� r� r� r� r� r( r( r( r) r� � s � w r� c @ s0 e Zd ZdZdd� 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. c C s |j | _|| _|| _|| _d S r, )r� �_length� _producer� _consumerr� )r0 �producerZconsumerZfinishedr( r( r) r. � s z LengthEnforcingConsumer.__init__c C s 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� rM r( r( r) r� � s z*LengthEnforcingConsumer._allowNoMoreWritesc C sp | j dkr| j�� t� �t|�| jkrH| jt|�8 _| j�|� n$t| 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� r� r� r* r~ r� r� �writerC r� r9 r� �r0 �bytesr( r( r) r� � s z LengthEnforcingConsumer.writec C s$ | j dk r | �� | jr td��dS )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� r� r9 rM r( r( r) r� � s z-LengthEnforcingConsumer._noMoreWritesExpectedN)r$ r% r& r' r. r� r� r� r( r( r( r) r� � s r� c s � 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. c s@ t | d� d | j d �}|d kr6td| � | jf ��|||�S )N�_z %r has no %s method in state %s)r� �_staterO )r0 �args�kwargs�funcr? r( r) � dispatcher s �z*makeStatefulDispatcher.<locals>.dispatcher)r' )r@ �templater� r( r? r) �makeStatefulDispatcher s r� c @ s� e Zd ZdZeZdZdZdd� Ze dd� �Z dd � Z d d � Z e d e �Z d d� Zdd� Zdd� Zdd� Zdd� Ze de�Zdd� Zdd� Zd d � Zd d � 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} NFc C s: || _ || _|| _|| _|| _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. ZINITIALN) r� r� r� rI � _transport� _bodyBufferr� rm �previousResponse)r0 r� r� r� rI r� r( r( r) r. [ s zResponse.__init__c C s t |||||�}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 �_ClientRequestProxyrm )r� r� r� r� rI r� rm r< r( r( r) r� v s zResponse._constructc C s || _ d S r, )r� )r0 r� r( r( r) �setPreviousResponse� s z Response.setPreviousResponsec C s dS )zi Dispatch the given L{IProtocol} depending of the current state of the response. Nr( �r0 �protocolr( r( r) � deliverBody� s zResponse.deliverBodyr c C sD |� | 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. NZ CONNECTED)�makeConnectionr� � _bodyProtocolr� rc r� �resumeProducing�r0 r� r/ r( r( r) �_deliverBody_INITIAL� s z Response._deliverBody_INITIALc C s t d| jf ��dS )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 againN)rO r r� r( r( r) �_deliverBody_CONNECTED� s ��z Response._deliverBody_CONNECTEDc C s> |� | j� | jD ]}|�|� qd| _|�| j� d| _dS )z� Deliver any buffered data to C{protocol} and then disconnect the protocol. Move to the C{'FINISHED'} state. N�FINISHED)r r� r� rc r� �_reasonr� r r( r( r) �_deliverBody_DEFERRED_CLOSE� s z$Response._deliverBody_DEFERRED_CLOSEc C s t d��dS )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.N�rO r� r( r( r) �_deliverBody_FINISHED� s �z Response._deliverBody_FINISHEDc C s dS )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( rd r( r( r) r� � s zResponse._bodyDataReceivedZbodyDataReceivedc C s | j �|� dS )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� r^ rd r( r( r) �_bodyDataReceived_INITIAL� s z"Response._bodyDataReceived_INITIALc C s | j �|� dS )zk Deliver any data received to the protocol to which this L{Response} is connected. N)r rc rd r( r( r) �_bodyDataReceived_CONNECTED� s z$Response._bodyDataReceived_CONNECTEDc C s t d��dS )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 _bodyDataFinishedNr rd r( r( r) � _bodyDataReceived_DEFERRED_CLOSE� s z)Response._bodyDataReceived_DEFERRED_CLOSEc C s t d��dS )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 disconnectedNr rd r( r( r) �_bodyDataReceived_FINISHED� s z#Response._bodyDataReceived_FINISHEDc C s dS )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( �r0 r1 r( r( r) r� � s zResponse._bodyDataFinishedZbodyDataFinishedc C s$ d| _ |dkrttd��}|| _dS )z} Move to the C{'DEFERRED_CLOSE'} state to wait for a protocol to which to deliver the response body. ZDEFERRED_CLOSEN� Response body fully received)r� r r: r r r( r( r) �_bodyDataFinished_INITIAL s z"Response._bodyDataFinished_INITIALc C s0 |dkrt td��}| j�|� d| _d| _dS )zN Disconnect the protocol and move to the C{'FINISHED'} state. Nr r )r r: r r� r� r r( r( r) �_bodyDataFinished_CONNECTED s z$Response._bodyDataFinished_CONNECTEDc C s t d��dS )�� 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 onceNr rM r( r( r) � _bodyDataFinished_DEFERRED_CLOSE s z)Response._bodyDataFinished_DEFERRED_CLOSEc C s t d��dS )r z3Cannot finish body data after protocol disconnectedNr rM r( r( r) �_bodyDataFinished_FINISHED' s z#Response._bodyDataFinished_FINISHED)N)N)N) r$ r% r& r' r r� r Z _bodyFinishedr. r� r� r� r r� r r r r r� r r r r r� r r r r r( r( r( r) r ( s< , � � r c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd S ) r� z� Helper object which exposes L{IConsumer} on top of L{HTTP11ClientProtocol} for streaming request bodies to the server. c C s || _ d S r, r� r� r( r( r) r. 8 s zChunkedEncoder.__init__c C s d| _ dS r� r� rM r( r( r) r� < s z!ChunkedEncoder._allowNoMoreWritesc C s | j �||� dS )zE Register the given producer with C{self.transport}. N)r� r� )r0 r� Z streamingr( r( r) r� D s z ChunkedEncoder.registerProducerc C s2 | j dkrt� �| 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� r r~ rd r( r( r) r� K s �zChunkedEncoder.writec C s | � d� | j�� | �� dS )zT Indicate that the request body is complete and finish the request. rU N)r� r� r� r� rM r( r( r) r� X s z!ChunkedEncoder.unregisterProducerN) r$ r% r& r' r. r� r� r� r� r( r( r( r) r� 1 s r� c @ sD e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zd d � 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. Fc C s || _ d S r, �r� )r0 r� r( r( r) r. t s z TransportProxyProducer.__init__c C s d| _ dS )z� Stop forwarding calls of L{twisted.internet.interfaces.IPushProducer} methods to the underlying L{twisted.internet.interfaces.IPushProducer} provider. Nr rM r( r( r) � stopProxyingx s z#TransportProxyProducer.stopProxyingc C s | j dk r| j �� dS )zl Proxy the stoppage to the underlying producer, unless this proxy has been stopped. N)r� r� rM r( r( r) r� � s z$TransportProxyProducer.stopProducingc C s | j dk r| j �� dS )zn Proxy the resumption to the underlying producer, unless this proxy has been stopped. N)r� r rM r( r( r) r � s z&TransportProxyProducer.resumeProducingc C s | j dk r| j �� dS )zi Proxy the pause to the underlying producer, unless this proxy has been stopped. N)r� r� rM r( r( r) r� � s z%TransportProxyProducer.pauseProducingc C s | j dk r| j �� dS )z� Proxy the request to lose the connection to the underlying producer, unless this proxy has been stopped. N)r� �loseConnectionrM r( r( r) r � s z%TransportProxyProducer.loseConnectionN) r$ r% r& r' Z disconnectingr. r r� r r� r r( r( r( r) r b s r c @ s� e Zd ZdZdZdZdZdZdZdZ e � Z dd� fdd�Z e dd � �Zd d � Zd d � Zede�Zdd� ZeZdd� Zdd� Zdd� Zdd� Zede�Zdd� Zd d � Zd d � Zd d!� Zd"d#� Z d$d%� Z d&d'� Z dS )(�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. � QUIESCENTNc C s d S r, r( )�cr( r( r) r� � rU z HTTP11ClientProtocol.<lambda>c C s || _ g | _d S r, )�_quiescentCallback�_abortDeferreds)r0 ZquiescentCallbackr( r( r) r. � s z HTTP11ClientProtocol.__init__c C s | j S r, �r� rM r( r( r) rK � s zHTTP11ClientProtocol.statec s� �j dkrtt� �S d�_ 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}. r � TRANSMITTINGc s2 �j dkr� �� n�j�� ��tt� �� d S )N)r! �%TRANSMITTING_AFTER_RECEIVING_RESPONSE)r� r� r� �abortConnection�_disconnectParserr r r� �Z_requestDeferredr0 r( r) � cancelRequest s z3HTTP11ClientProtocol.request.<locals>.cancelRequestc s" � j dkr d� _ � j�� j� d S )Nr! �WAITING)r� ro � chainDeferred�_finishedRequestr� rM r( r) �cbRequestWritten# s z6HTTP11ClientProtocol.request.<locals>.cbRequestWrittenc sJ � j dkr2d� _ � j�� � j�tt| g��� n� jjd| � j d� d S )Nr! ZGENERATION_FAILEDzJError writing request, but not in valid state to finalize request: {state})rB rK ) r� r� r# r) r� r r6 r� rB r� rM r( r) �ebRequestWriting( s ��z6HTTP11ClientProtocol.request.<locals>.ebRequestWriting)r� r r> r r� r� r r) �_currentRequestr �_transportProxyrl �_finishResponse�_parserr ro r� )r0 rm r& r* r+ r( r% r) rm � s z HTTP11ClientProtocol.requestc C s dS )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) r. ; s z$HTTP11ClientProtocol._finishResponseZfinishResponsec C s� | j dkrd| _ nd| _ | j�| j� | jd kr4d S td�}| jj�dd�}d|ksf| j dksf| jj sv| � t |�� nF| j � � z| �| � W n" | j�d� | j �� Y nX | �|� d S ) Nr' r r" z synthetic!rG r( s closer� )r� ro r( r) r/ r rJ r� r, r� �_giveUpr r� r r r� rB r r$ )r0 r� r1 rJ r( r( r) �_finishResponse_WAITINGG s& � z,HTTP11ClientProtocol._finishResponse_WAITINGc C sF | j dk rB| j }d| _ d| _d| _d| _| j�� d| _|�|� dS )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)r/ r, r) ro r- r r� )r0 r1 �parserr( r( r) r$ u s z&HTTP11ClientProtocol._disconnectParserc C s | 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� r r$ r r( r( r) r0 � s z HTTP11ClientProtocol._giveUpc C s. z| j �|� W n | �t� � Y nX dS )z4 Handle some stuff from some place. N)r/ rc r0 r r� r( r( r) rc � s z!HTTP11ClientProtocol.dataReceivedc C s dS )zh The underlying transport went away. If appropriate, notify the parser object. Nr( r r( r( r) r� � s z#HTTP11ClientProtocol.connectionLostr� c C s d| _ dS )z{ Nothing is currently happening. Move to the C{'CONNECTION_LOST'} state but otherwise do nothing. �CONNECTION_LOSTNr r r( r( r) �_connectionLost_QUIESCENT� s z.HTTP11ClientProtocol._connectionLost_QUIESCENTc C s d| _ dS )z� The connection was in an inconsistent state. Move to the C{'CONNECTION_LOST'} state but otherwise do nothing. r3 Nr r r( r( r) �!_connectionLost_GENERATION_FAILED� s z6HTTP11ClientProtocol._connectionLost_GENERATION_FAILEDc C s. 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. r3 N)r� r) r� r r7 r, r� r r( r( r) � _connectionLost_TRANSMITTING� s �z1HTTP11ClientProtocol._connectionLost_TRANSMITTINGc C s d| _ dS )z9 Move to the C{'CONNECTION_LOST'} state. r3 Nr r r( r( r) �5_connectionLost_TRANSMITTING_AFTER_RECEIVING_RESPONSE� s zJHTTP11ClientProtocol._connectionLost_TRANSMITTING_AFTER_RECEIVING_RESPONSEc C s | � |� 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. r3 N)r$ r� r r( r( r) �_connectionLost_WAITING� s z,HTTP11ClientProtocol._connectionLost_WAITINGc C s6 | � tt� �� d| _| jD ]}|�d� q g | _dS )z� Disconnect the response parser with a L{ConnectionAborted} failure, and move to the C{'CONNECTION_LOST'} state. r3 N)r$ r r8 r� r r� )r0 r1 r� r( r( r) �_connectionLost_ABORTING� s z-HTTP11ClientProtocol._connectionLost_ABORTINGc C s8 | j dkrtd�S | j�� d| _ t� }| j�|� |S )zw Close the connection and cause all outstanding L{request} L{Deferred}s to fire with an error. r3 NZABORTING)r� r r� r r r r^ )r0 r� r( r( r) �abort� s zHTTP11ClientProtocol.abort) r$ r% r& r' r� r/ r) r, r- ro r r� r. r� rK rm r. r� r1 Z _finishResponse_TRANSMITTINGr$ r0 rc r� r4 r5 r6 r7 r8 r9 r: r( r( r( r) r � s8 < E + r )Tr' Z __future__r r �typeZ __metaclass__�reZzope.interfacer Ztwisted.python.compatr Ztwisted.python.componentsr Ztwisted.python.reflectr Ztwisted.python.failurer Ztwisted.internet.interfacesr r Ztwisted.internet.errorr Ztwisted.internet.deferr r r r r Ztwisted.internet.protocolr Ztwisted.protocols.basicr Ztwisted.web.iwebr r r Ztwisted.web.http_headersr Ztwisted.web.httpr r r r r r Ztwisted.loggerr r r r r! rA r- r" r* r+ r3 r4 r6 r7 r8 r9 r: r; r= r> rC rD rl �compiler� rY r� r� r� r� r� r� r� r� r r� r r r( r( r( r) �<module> s� i��� 0J 0C
Save File
Cancel