File: //lib/python3/dist-packages/twisted/web/__pycache__/client.cpython-38.pyc
U
s�@g ) � @ s> d Z ddlmZmZ ddlZddlZddlZzddlmZm Z m
Z
W n8 e k
r| ddl m Z m
Z
ddl mZ
dd� ZY nX dd lmZ dd
lmZ dd lmZ dd lmZmZ dd
lmZmZmZmZ ddlm Z m Z m Z ddl m Z ddl!m"Z" ddl#m$Z$ ddl%m&Z&m'Z'm(Z(m)Z) ddl*m+Z+ ddl,m-Z-m.Z. ddl/m0Z0m1Z1 ddl2m3Z3 ddl4m5Z5 ddl#m6Z6 ddl7m8Z8m9Z9m:Z:m;Z;m<Z<m=Z= ddl>m?Z? ddl@mAZA dd lBmCZCmDZD G d d � d e6jE�ZFG d d � d e$jG�ZHG d!d"� d"eH�ZIG d#d$� d$e'jJ�ZKG d%d&� d&eK�ZLG d'd(� d(eM�ZNd)d*� ZOdxd+d,�ZPd-ZQd.d/� ZReR� e e"d0d1d2d�eQ�dyd3d4��ZSe e"d0d1d2d�eQ�dzd5d6��ZTdd7lUmVZV dd8lBmWZWmXZXmYZYmZZZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZa zdd9lbmcZc W n e k
�r� dZcY nX dd:ldmeZemfZfmgZg d;d<� ZhG d=d>� d>eM�Ziee<�G d?d@� d@eM��Zje e"d0dAdd�e eie"d0dAdd�ejdB��kdC�dD eijleijm� ee.�G dEdF� dFeM��Znee<�G dGdH� dHeM��Zoee;�G dIdJ� dJeM��ZpG dKdL� dLe'jq�ZrG dMdN� dNeM�ZsG dOdP� dPeM�ZtG dQdR� dReM�Zuee:�G dSdT� dTeM��Zvee9�G dUdV� dVeu��Zwee9�G dWdX� dXeu��ZxG dYdZ� dZeM�ZyG d[d\� d\eM�Zzee9�G d]d^� d^eM��Z{G d_d`� d`e5e=��Z|G dadb� dbe5e-��Z}ee9�G dcdd� ddeM��Z~e?� jZ�e�dedfdgdhdig�Z�ee9�G djdk� dkeM��Z�G dldm� dme��Z�G dndo� doe'j��Z�dpdq� Z�dVdmddd^d6d4d`d$dPd&d"d d dXdqdkdrdsdtdudvdwd(gZ�dS ){z
HTTP client.
� )�division�absolute_importN)�
urlunparse�urljoin� urldefrag)r r )r c C s t tdd� | D ���}|�d�S )Nc S s g | ]}|� d ��qS )�charmap)�decode)�.0�p� r �4/usr/lib/python3/dist-packages/twisted/web/client.py�
<listcomp> s z urlunparse.<locals>.<listcomp>r )� _urlunparse�tuple�encode)�parts�resultr r r r s r )� implementer)�Iterable)�wraps)�_PY3�
networkString)� nativeString�
intToBytes�unicode�
itervalues)�
deprecated�deprecatedModuleAttribute�getDeprecationWarningString)�Failure)�Version)�http)�defer�protocol�task�reactor)�
isIPv6Address)� IProtocol�IOpenSSLContextFactory)�HostnameEndpoint�
wrapClientTLS)�InsensitiveDict)�proxyForInterface)�error)�UNKNOWN_LENGTH�IAgent�IAgentEndpointFactory�
IBodyProducer�IPolicyForHTTPS� IResponse)�Headers)�Logger)�_ensureValidURI�_ensureValidMethodc @ s e Zd ZdZdS )�PartialDownloadErrorz�
Page was only partially downloaded, we got disconnected in middle.
@ivar response: All of the response body which was downloaded.
N)�__name__�
__module__� __qualname__�__doc__r r r r r8 ? s r8 c @ s� e Zd ZdZdZdZdZdZed�Z dd� Z
dd� Z d d
� Z d d � Z
d
d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd S )!�HTTPPageGettera�
Gets a resource via HTTP, then quits.
Typically used with L{HTTPClientFactory}. Note that this class does not, by
itself, do anything with the response. If you want to download a resource
into a file, use L{HTTPPageDownloader} instead.
@ivar _completelyDone: A boolean indicating whether any further requests are
necessary after this one completes in order to provide a result to
C{self.factory.deferred}. If it is C{False}, then a redirect is going
to be followed. Otherwise, this protocol's connection is the last one
before firing the result Deferred. This is used to make sure the result
Deferred is only fired after the connection is cleaned up.
r T)� hosts
user-agent� cookies content-lengthc C s� t t| jdd��}| �|t| jj�� | jjdkrX| jjdkrX| jjd t | jj� }n:| jjdkr�| jjdkr�| jjd t | jj� }n| jj}| �
d| jj � d |�� | �
d
| jj
� t| jd d �}|d k r�| �
d t t|��� g }| jj �� D ]:\}}|�� | jk�r| �
||� |�� d
kr�|�|� q�| jj�� D ] \}}|�|d | � �q<|�rr| �
dd�|�� | �� i | _ |d k �r�| j�|� d S )N�method� GET� http�P � :� https� s Hostr> s
User-Agent�postdata� Content-Lengthr? � =� Cookies ; )r7 �getattr�factoryZ sendCommandr6 �path�scheme�port�hostr Z
sendHeader�headers�get�agent�len�items�lower�_specialHeaders�append�cookies�joinZ
endHeaders� transport�write) �selfr@ rP �dataZ
cookieData�key�value�cookieZcookvalr r r �connectionMadea s4
z HTTPPageGetter.connectionMadec C s$ |� � }| j�|g �}|�|� dS )a(
Called every time a header is received. Stores the header information
as key-value pairs in the C{headers} attribute.
@type key: C{str}
@param key: An HTTP header field name.
@type value: C{str}
@param value: An HTTP header field value.
N)rV rQ �
setdefaultrX )r] r_ r` �lr r r � handleHeader� s zHTTPPageGetter.handleHeaderc C s* ||| | _ | _| _| j�|||� dS )aJ
Handle the HTTP status line.
@param version: The HTTP version.
@type version: L{bytes}
@param status: The HTTP status code, an integer represented as a
bytestring.
@type status: L{bytes}
@param message: The HTTP status message.
@type message: L{bytes}
N)�version�status�messagerL � gotStatus�r] rf rg rh r r r � handleStatus� s zHTTPPageGetter.handleStatusc C s0 | j �| j� t| dt| j� | j�}|� d S )NZ
handleStatus_)rL �
gotHeadersrQ rK r rg �handleStatusDefault)r] �mr r r �handleEndHeaders� s
�z HTTPPageGetter.handleEndHeadersc C s d S �Nr �r] r r r �handleStatus_200� s z HTTPPageGetter.handleStatus_200c C s | � � S rp �rr rq r r r �<lambda>� � zHTTPPageGetter.<lambda>c C s | � � S rp rs rq r r r rt � ru c C s
d| _ d S �N� )�failedrq r r r rm � s z"HTTPPageGetter.handleStatusDefaultc C s, | j �d�}|s | �� d S |d }| jr�| j jd7 _| jj| jjkr�tj| j d|d�}| j�
t |�� d| _ | j
�� d S d| _| j�|� | jjdkr�dd lm} |�� }t�t| jj�| jj| j|� n t�t| jj�| jj| j� n(| �� | j�
t tj| j | j |d��� d| _ | j
�� d S )
N� locationr rw � Infinite redirection detected��locationTFrE ��ssl) rQ rR rm �followRedirectrL �_redirectCount�
redirectLimitr- �InfiniteRedirectionrg �noPager � quietLossr[ �loseConnection�_completelyDone�setURLrN �twisted.internetr~ �ClientContextFactoryr% �
connectSSLr rP rO �
connectTCP� PageRedirectrh )r] rd �url�errr~ �contextFactoryr r r �handleStatus_301� sV �
�� ���z HTTPPageGetter.handleStatus_301c C s | j r| �� n| �� d S rp )�
afterFoundGet�handleStatus_303r� rq r r r �handleStatus_302� s
z HTTPPageGetter.handleStatus_302c C s d| j _| �� d S )NrA )rL r@ r� rq r r r r� � s z HTTPPageGetter.handleStatus_303c C s8 | j s tj�| |� | j�|� | jr4| jj�d� dS )z�
When the connection used to issue the HTTP request is closed, notify the
factory if we have not already, so it can produce a result.
N) r� r! �
HTTPClient�connectionLostrL r� r� �_disconnectedDeferred�callback�r] �reasonr r r r� � s
z HTTPPageGetter.connectionLostc C s� | j r
d S | jr.| j�tt�| j| j|��� | jj dkrH| j�
d� n>| j d krz| j dkrz| j�tt | j| j|��� n | j�
|� | j
�� d S )N� HEADru r )r� rx rL r� r r- �Errorrg rh r@ �page�lengthr8 r[ r� �r] �responser r r �handleResponse� s( ��� � z HTTPPageGetter.handleResponsec C s6 d| _ | j�� | j�t�d| jj| jjf �� d S )NTz'Getting %s took longer than %s seconds.) r� r[ �abortConnectionrL r� r" � TimeoutErrorr� �timeoutrq r r r r� s
zHTTPPageGetter.timeoutN)r9 r: r; r< r� r rx r� �setrW rb re rk ro rr ZhandleStatus_201ZhandleStatus_202rm r� r� r� r� r� r� r r r r r= G s, � (r= c @ s2 e Zd ZdZd dd�Zdd� Zdd� Zdd � Zd
S ) �HTTPPageDownloaderr c C s t �| � d| _| j�|� d S rv )r= rr �transmittingPagerL � pageStart�r] �partialContentr r r rr s
z#HTTPPageDownloader.handleStatus_200c C s | j dd� d S )Nrw )r� rs rq r r r �handleStatus_206 s z#HTTPPageDownloader.handleStatus_206c C s | j r| j�|� d S rp )r� rL �pagePart�r] r^ r r r �handleResponsePart s z%HTTPPageDownloader.handleResponsePartc C sj | j r"d| _| j�tt| j��� | jr8| j�� d| _| jrf| j�tt �
| j| j d ��� | j �
� d S �Nr )r� r� rL r� r r8 rg �pageEndrx r- r� rh r[ r� rq r r r �handleResponseEnd s* ��
���z$HTTPPageDownloader.handleResponseEndN)r )r9 r: r; r� rr r� r� r� r r r r r�
s
r� c @ s� e Zd ZdZeZdZdZdZdZ dZ
d d
d �Z d d
� Z dd� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � ZdS )!�HTTPClientFactorya Download a given URL.
@type deferred: Deferred
@ivar deferred: A Deferred that will fire when the content has
been retrieved. Once this is fired, the ivars `status', `version',
and `message' will be set.
@type status: bytes
@ivar status: The status of the response.
@type version: bytes
@ivar version: The version of the response.
@type message: bytes
@ivar message: The text message returned with the status.
@type response_headers: dict
@ivar response_headers: The headers that were specified in the
response from the server.
@type method: bytes
@ivar method: The HTTP method to use in the request. This should be one of
OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, or CONNECT (case
matters). Other values may be specified if the server being contacted
supports them.
@type redirectLimit: int
@ivar redirectLimit: The maximum number of HTTP redirects that can occur
before it is assumed that the redirection is endless.
@type afterFoundGet: C{bool}
@ivar afterFoundGet: Deviate from the HTTP 1.1 RFC by handling redirects
the same way as most web browsers; if the request method is POST and a
302 status is encountered, the redirect is followed with a GET method
@type _redirectCount: int
@ivar _redirectCount: The current number of HTTP redirects encountered.
@ivar _disconnectedDeferred: A L{Deferred} which only fires after the last
connection associated with the request (redirects may cause multiple
connections to be required) has closed. The result Deferred will only
fire after this Deferred, so that callers can be assured that there are
no more event sources in the reactor once they get the result.
Nru rA � Twisted PageGetterr T� Fc C s� || _ | | _d| _|| _|| _|
| _|d kr0i }|| _|d k rJt|�| _nt� | _|d k r~| j� dt
t |��� | j� dd� || _ t
|�| _| �|� d| _t�� | _t�� | _| j�| j� d | _d S )Nr rH s
connections closerw )r r� r� r� rS r� rY r+ rQ rc r rT rG r7 r@ r� �waitingr" �Deferredr� �deferred�addBoth�_waitForDisconnect�response_headers) r] r� r@ rG rQ rS r� rY r r� r� r r r �__init__d s2
�
zHTTPClientFactory.__init__c s | j �� fdd�� | j S )z�
Chain onto the _disconnectedDeferred, preserving C{passthrough}, so that
the result is only available after the associated connection has been
closed.
c s � S rp r �Zignored�� passthroughr r rt � ru z6HTTPClientFactory._waitForDisconnect.<locals>.<lambda>)r� � addCallback)r] r� r r� r r� � s z$HTTPClientFactory._waitForDisconnectc C s d| j j| jf S )Nz<%s: %s>)� __class__r9 r� rq r r r �__repr__� s zHTTPClientFactory.__repr__c C sL t |�� � || _t�|�}|jr@|jr@|j| _|j| _|j| _|j| _ d S rp )
r6 �stripr� �URI� fromBytesrN rP rO �
originFormrM )r] r� �urir r r r� � s
zHTTPClientFactory.setURLc C sH t j�| |�}| j|_| j|_| jrDt�| j|j�}| j� | j
|� |S rp ) r# �
ClientFactory�
buildProtocolr r� r� r% � callLaterr� r� �_cancelTimeout)r] �addrr
� timeoutCallr r r r� � s z HTTPClientFactory.buildProtocolc C s |� � r|�� |S rp )Zactive�cancel)r] r r� r r r r� � s z HTTPClientFactory._cancelTimeoutc C sd || _ d|kr`|d D ]H}d|kr|�d�}|d }|�� |�dd�\}}|�� | j|�� < qdS )z�
Parse the response HTTP headers.
@param headers: The response HTTP headers.
@type headers: L{dict}
s
set-cookierI � ;r rw N)r� �split�lstriprY )r] rQ ra Z cookpartsZcook�k�vr r r rl � s
z HTTPClientFactory.gotHeadersc C s ||| | _ | _| _dS )aR
Set the status of the request on us.
@param version: The HTTP version.
@type version: L{bytes}
@param status: The HTTP status code, an integer represented as a
bytestring.
@type status: L{bytes}
@param message: The HTTP status message.
@type message: L{bytes}
N)rf rg rh rj r r r ri � s zHTTPClientFactory.gotStatusc C s | j rd| _ | j�|� d S r� )r� r� r� )r] r� r r r r� � s zHTTPClientFactory.pagec C s | j rd| _ | j�|� d S r� )r� r� �errbackr� r r r r� � s zHTTPClientFactory.noPagec C s( | j r$d| _ | j�d� | j�|� dS )z�
When a connection attempt fails, the request cannot be issued. If no
result has yet been provided to the result Deferred, provide the
connection failure reason as an error result.
r N)r� r� r� r� r� )r] �_r� r r r �clientConnectionFailed� s z(HTTPClientFactory.clientConnectionFailed) rA NNr� r NTr� F)r9 r: r; r< r= r# r� rN rP rO rM r� r� r� r� r� r� rl ri r� r� r� r r r r r� . s2 - �
$
r� c
@ sX e Zd ZdZeZdZe� Zdd d
�Z d d � Z
d
d� Z dd� Z dd� Z
dd� Zdd� ZdS )�HTTPDownloaderz
Download to a file.
NrA � Twisted clientFr Tr� c
C s� d| _ t|ttf�rl|| _d | _|rrtj�| j�rrtj� | j�}
|
rr|
| _ |d krVi }dt
|
� d |d< n|| _t j | ||||||| |
| | d� d S )Nr s bytes=� -s range) r@ rG rQ rS r� rY r r� r� )
�requestedPartial�
isinstance�strr �fileName�file�osrM �exists�getsizer r� r� )r] r� Z
fileOrNamer@ rG rQ rS ZsupportPartialr� rY r r� r� Z
fileLengthr r r r� � s2 �zHTTPDownloader.__init__c C sT t �| |� | jrP|�dd �}|s,d| _d S t�|d �\}}}|| jkrPd| _d S )Ns
content-ranger )r� rl r� rR r! ZparseContentRange)r] rQ Z contentRange�start�endZ
realLengthr r r rl s
zHTTPDownloader.gotHeadersc C s. |r t | jd�}|�dd� n t | jd�}|S )Nzrb+r � �wb)�openr� �seek)r] r� r� r r r �openFile s
zHTTPDownloader.openFilec C sV |r| j std��| jrRz| js,| �|�| _W n" tk
rP | j�t� � Y nX dS )z�Called on page download start.
@param partialContent: tells us if the download is partial download we requested.
z?we shouldn't get partial content response if we didn't want it!N) r� �
ValueErrorr� r� r� �IOErrorr� r� r r� r r r r� s
zHTTPDownloader.pageStartc C sH | j s
d S z| j �|� W n( tk
rB d | _ | j�t� � Y nX d S rp )r� r\ r� r� r� r r� r r r r� + s zHTTPDownloader.pagePartc C sJ | j rFd| _ | jr:z| j�� W n | j�d� Y nX | j�|� dS )zk
Close the storage file and errback the waiting L{Deferred} with the
given reason.
r z!Error closing HTTPDownloader fileN)r� r� �close�_log�failurer� r� r� r r r r� 6 s zHTTPDownloader.noPagec C sV d| _ | jsd S z| j�� W n$ tk
rB | j�t� � Y d S X | j�| j� d S r� ) r� r� r� r� r� r� r r� r` rq r r r r� E s zHTTPDownloader.pageEnd)
rA NNr� Fr NTr� F)r9 r: r; r< r� r# r` r5 r� r� rl r� r� r� r� r� r r r r r� � s* �
r� c @ s: e Zd ZdZdd� Zed dd��Zdd� Zed d
� �Z dS ) r� zd
A URI object.
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-21}
c C s: || _ || _|�d�| _|| _|| _|| _|| _|| _dS )a�
@type scheme: L{bytes}
@param scheme: URI scheme specifier.
@type netloc: L{bytes}
@param netloc: Network location component.
@type host: L{bytes}
@param host: Host name. For IPv6 address literals the brackets are
stripped.
@type port: L{int}
@param port: Port number.
@type path: L{bytes}
@param path: Hierarchical path.
@type params: L{bytes}
@param params: Parameters for last path segment.
@type query: L{bytes}
@param query: Query string.
@type fragment: L{bytes}
@param fragment: Fragment identifier.
s []N) rN �netlocr� rP rO rM �params�query�fragment) r] rN r� rP rO rM r� r� r� r r r r� X s z URI.__init__Nc C s� |� � }t�|�\}}}}}}|dkr8|dkr4d}nd}d|kr~|�dd�\} }
z t|
�}
W q� tk
rz || } }
Y q�X n
|| } }
| ||| |
||||�S )aN
Parse the given URI into a L{URI}.
@type uri: C{bytes}
@param uri: URI to parse.
@type defaultPort: C{int} or L{None}
@param defaultPort: An alternate value to use as the port if the URI
does not include one.
@rtype: L{URI}
@return: Parsed URI instance.
NrE rF rC rD rw )r� r! �urlparse�rsplit�intr� ) �clsr� Z defaultPortrN r� rM r� r� r� rP rO r r r r� ~ s
z
URI.fromBytesc C s t | j| j| j| j| j| jf�S )z�
Assemble the individual parts of the I{URI} into a fully formed I{URI}.
@rtype: C{bytes}
@return: A fully formed I{URI}.
)r rN r� rM r� r� r� rq r r r �toBytes� s
��z URI.toBytesc C s* t dd| j| j| jdf�}|dkr&d}|S )a!
The absolute I{URI} path including I{URI} parameters, query string and
fragment identifier.
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-21#section-5.3}
@return: The absolute path in original form.
@rtype: L{bytes}
ru � /)r rM r� r� )r] rM r r r r� � s
�zURI.originForm)N)
r9 r: r; r< r� � classmethodr� r� �propertyr� r r r r r� R s & " r� c C s0 t | �\} }t t| |��\}}t|d|p*| �S )a�
Construct a full ("absolute") URL by combining a "base URL" with another
URL. Informally, this uses components of the base URL, in particular the
addressing scheme, the network location and (part of) the path, to provide
missing components in the relative URL.
Additionally, the fragment identifier is preserved according to the HTTP
1.1 bis draft.
@type base: C{bytes}
@param base: Base URL.
@type url: C{bytes}
@param url: URL to combine with C{base}.
@return: An absolute URL resulting from the combination of C{base} and
C{url}.
@see: L{urlparse.urljoin}
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22#section-7.1.2}
� #)r r )�baser� ZbaseFragZurlFragr r r �_urljoin� s r� c O s| t �t| �� ��}|| f|�|�}|jdkrbddlm} |dkrH|�� }t� t
|j �|j ||� nt�
t
|j �|j |� |S )a�
Create and connect an HTTP page getting factory.
Any additional positional or keyword arguments are used when calling
C{factoryFactory}.
@param factoryFactory: Factory factory that is called with C{url}, C{args}
and C{kwargs} to produce the getter
@param contextFactory: Context factory to use when creating a secure
connection, defaulting to L{None}
@return: The factory created by C{factoryFactory}
rE r r} N)r� r� r6 r� rN r� r~ r� r% r� r rP rO r� )r� �factoryFactoryr� �args�kwargsr� rL r~ r r r �_makeGetterFactory� s
�r� z:https://pypi.org/project/treq/ or twisted.web.client.Agentc
C sP t tttfD ]>} ttdddd�t| tdddd�td��d�d | j | j
� q dS ) zl
Mark the protocols and factories associated with L{getPage} and
L{downloadPage} as deprecated.
�Twisted� � r �Z replacement�; rw N) r= r� r� r� r r r �_GETPAGE_REPLACEMENT_TEXTr� r: r9 )�klassr r r �_deprecateGetPageClasses� s& � ����r r� r r c O s t | tf|�d|i|��jS )z�
Download a web page as a string.
Download a page. Return a deferred, which will callback with a
page (as a string) or errback with a description of the error.
See L{HTTPClientFactory} to see what extra arguments can be passed.
r� )r� r� r� )r� r� r� r� r r r �getPage s ����r c s( � fdd�}t | |f|�d|i|��jS )z�
Download a web page to a file.
@param file: path to file on filesystem, or file-like object.
See HTTPDownloader to see what extra args can be passed.
c s t | � f|�|�S rp )r� )r� �a�kw�r� r r rt 2 ru z downloadPage.<locals>.<lambda>r� )r� r� )r� r� r� r� r� r� r r
r � downloadPage( s
����r )�SchemeNotSupported) �HTTP11ClientProtocol�PotentialDataLoss�Request�RequestGenerationFailed�RequestNotSent�RequestTransmissionFailed�Response� ResponseDone�ResponseFailed�ResponseNeverReceived�_WrapperException)�SSL)�CertificateOptions�
platformTrust�optionsForClientTLSc C s t dkr t| �dd� �}|S | S )a}
The decorated method requires pyOpenSSL to be present, or it raises
L{NotImplementedError}.
@param decoratee: A function which requires pyOpenSSL.
@type decoratee: L{callable}
@return: A function which raises L{NotImplementedError} if pyOpenSSL is not
installed; otherwise, if it is installed, simply return C{decoratee}.
@rtype: L{callable}
Nc _ s t d��dS )z�
pyOpenSSL is not available.
@param a: The positional arguments for C{decoratee}.
@param kw: The keyword arguments for C{decoratee}.
@raise NotImplementedError: Always.
zSSL support unavailableN)�NotImplementedError)r r r r r �raiseNotImplementedf s z(_requireSSL.<locals>.raiseNotImplemented)r r )Z decorateer r r r � _requireSSLY s
r c @ s$ e Zd ZdZdd� Zedd� �ZdS )�WebClientContextFactorya�
This class is deprecated. Please simply use L{Agent} as-is, or if you want
to customize something, use L{BrowserLikePolicyForHTTPS}.
A L{WebClientContextFactory} is an HTTPS policy which totally ignores the
hostname and port. It performs basic certificate verification, however the
lack of validation of service identity (e.g. hostname validation) means it
is still vulnerable to man-in-the-middle attacks. Don't use it any more.
c C s t tjt� d�S )z�
Return a L{CertificateOptions}.
@param hostname: ignored
@param port: ignored
@return: A new CertificateOptions instance.
@rtype: L{CertificateOptions}
)r@ � trustRoot)r r Z
SSLv23_METHODr �r] �hostnamerO r r r �_getCertificateOptions� s �z.WebClientContextFactory._getCertificateOptionsc C s | � ||��� S )z�
Return an L{OpenSSL.SSL.Context}.
@param hostname: ignored
@param port: ignored
@return: A new SSL context.
@rtype: L{OpenSSL.SSL.Context}
)r# �
getContextr! r r r r$ � s z"WebClientContextFactory.getContextN)r9 r: r; r< r# r r$ r r r r r w s
r c @ s& e Zd ZdZddd�Zedd� �ZdS )�BrowserLikePolicyForHTTPSz1
SSL connection creator for web clients.
Nc C s
|| _ d S rp )�
_trustRoot)r] r r r r r� � s z"BrowserLikePolicyForHTTPS.__init__c C s t |�d�| jd�S )a�
Create a L{client connection creator
<twisted.internet.interfaces.IOpenSSLClientConnectionCreator>} for a
given network location.
@param tls: The TLS protocol to create a connection for.
@type tls: L{twisted.protocols.tls.TLSMemoryBIOProtocol}
@param hostname: The hostname part of the URI.
@type hostname: L{bytes}
@param port: The port part of the URI.
@type port: L{int}
@return: a connection creator with appropriate verification
restrictions set
@rtype: L{client connection creator
<twisted.internet.interfaces.IOpenSSLClientConnectionCreator>}
�ascii)r )r r r& r! r r r �creatorForNetloc� s
�z*BrowserLikePolicyForHTTPS.creatorForNetloc)N)r9 r: r; r< r� r r( r r r r r% � s
r% � r r rw c @ s e Zd ZdZdd� Zdd� ZdS )�_ContextFactoryWithContextz�
A L{_ContextFactoryWithContext} is like a
L{twisted.internet.ssl.ContextFactory} with a pre-created context.
@ivar _context: A Context.
@type _context: L{OpenSSL.SSL.Context}
c C s
|| _ dS )z�
Initialize a L{_ContextFactoryWithContext} with a context.
@param context: An SSL context.
@type context: L{OpenSSL.SSL.Context}
N�Z_context)r] �contextr r r r� � s z#_ContextFactoryWithContext.__init__c C s | j S )z�
Return the context created by
L{_DeprecatedToCurrentPolicyForHTTPS._webContextFactory}.
@return: A context.
@rtype context: L{OpenSSL.SSL.Context}
r+ rq r r r r$ � s z%_ContextFactoryWithContext.getContextN)r9 r: r; r< r� r$ r r r r r* � s
r* c @ s e Zd ZdZdd� Zdd� ZdS )�"_DeprecatedToCurrentPolicyForHTTPSa+
Adapt a web context factory to a normal context factory.
@ivar _webContextFactory: An object providing a getContext method with
C{hostname} and C{port} arguments.
@type _webContextFactory: L{WebClientContextFactory} (or object with a
similar C{getContext} method).
c C s
|| _ dS )a>
Wrap a web context factory in an L{IPolicyForHTTPS}.
@param webContextFactory: An object providing a getContext method with
C{hostname} and C{port} arguments.
@type webContextFactory: L{WebClientContextFactory} (or object with a
similar C{getContext} method).
N)�_webContextFactory)r] ZwebContextFactoryr r r r� � s z+_DeprecatedToCurrentPolicyForHTTPS.__init__c C s | j �||�}t|�S )a�
Called the wrapped web context factory's C{getContext} method with a
hostname and port number and return the resulting context object.
@param hostname: The hostname part of the URI.
@type hostname: L{bytes}
@param port: The port part of the URI.
@type port: L{int}
@return: A context factory.
@rtype: L{IOpenSSLContextFactory}
)r. r$ r* )r] r" rO r, r r r r( s z3_DeprecatedToCurrentPolicyForHTTPS.creatorForNetlocN)r9 r: r; r< r� r( r r r r r- � s r- c @ sN e Zd ZdZedfdd�Zdd� Zdd� Zd d
� Zd d � Z d
d� Z
dd� Z dS )�FileBodyProducera
L{FileBodyProducer} produces bytes from an input file object incrementally
and writes them to a consumer.
Since file-like objects cannot be read from in an event-driven manner,
L{FileBodyProducer} uses a L{Cooperator} instance to schedule reads from
the file. This process is also paused and resumed based on notifications
from the L{IConsumer} provider being written to.
The file is closed after it has been read, or if the producer is stopped
early.
@ivar _inputFile: Any file-like object, bytes read from which will be
written to a consumer.
@ivar _cooperate: A method like L{Cooperator.cooperate} which is used to
schedule all reads.
@ivar _readSize: The number of bytes to read from C{_inputFile} at a time.
i c C s$ || _ |j| _|| _| �|�| _d S rp )�
_inputFileZ cooperate�
_cooperate� _readSize�_determineLengthr� )r] Z inputFileZ
cooperatorZreadSizer r r r� 0 s zFileBodyProducer.__init__c C sV z|j }|j}W n tk
r( t Y S X |� }|dtj� |� }||tj� || S )z�
Determine how many bytes can be read out of C{fObj} (assuming it is not
modified from this point on). If the determination cannot be made,
return C{UNKNOWN_LENGTH}.
r )r� �tell�AttributeErrorr. r� �SEEK_END�SEEK_SET)r] ZfObjr� r4 ZoriginalPositionr� r r r r3 7 s
z!FileBodyProducer._determineLengthc C s | j �� | j�� dS )z�
Permanently stop writing bytes from the file to the consumer by
stopping the underlying L{CooperativeTask}.
N)r0 r� �_task�stoprq r r r �
stopProducingI s
z FileBodyProducer.stopProducingc C s8 | � | �|��| _| j�� }dd� }|�dd� |� |S )z�
Start a cooperative task which will read bytes from the input file and
write them to C{consumer}. Return a L{Deferred} which fires after all
bytes have been written.
@param consumer: Any L{IConsumer} provider
c S s | � tj� t�� S rp )Ztrapr$ Z TaskStoppedr" r� �r� r r r � maybeStopped\ s z5FileBodyProducer.startProducing.<locals>.maybeStoppedc S s d S rp r r� r r r rt a ru z1FileBodyProducer.startProducing.<locals>.<lambda>)r1 �
_writeloopr8 ZwhenDoneZ addCallbacks)r] �consumer�dr< r r r �startProducingR s
z FileBodyProducer.startProducingc c s4 | j �| j�}|s | j �� q0|�|� dV q dS )z�
Return an iterator which reads one chunk of bytes from the input file
and writes them to the consumer for each time it is iterated.
N)r0 �readr2 r� r\ )r] r> �bytesr r r r= e s
zFileBodyProducer._writeloopc C s | j �� dS )z�
Temporarily suspend copying bytes from the input file to the consumer
by pausing the L{CooperativeTask} which drives that activity.
N)r8 �pauserq r r r �pauseProducings s z FileBodyProducer.pauseProducingc C s | j �� dS )z�
Undo the effects of a previous C{pauseProducing} and resume copying
bytes to the consumer by resuming the L{CooperativeTask} which drives
the write activity.
N)r8 Zresumerq r r r �resumeProducing{ s z FileBodyProducer.resumeProducingN) r9 r: r; r< r$ r� r3 r: r@ r= rD rE r r r r r/ s r/ c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �_HTTP11ClientFactoryaa
A factory for L{HTTP11ClientProtocol}, used by L{HTTPConnectionPool}.
@ivar _quiescentCallback: The quiescent callback to be passed to protocol
instances, used to return them to the connection pool.
@ivar _metadata: Metadata about the low-level connection details,
used to make the repr more useful.
@since: 11.1
c C s || _ || _d S rp )�_quiescentCallback� _metadata)r] �quiescentCallbackZmetadatar r r r� � s z _HTTP11ClientFactory.__init__c C s d� | j| j�S )Nz _HTTP11ClientFactory({}, {}))�formatrG rH rq r r r r� � s �z _HTTP11ClientFactory.__repr__c C s
t | j�S rp )r
rG )r] r� r r r r� � s z"_HTTP11ClientFactory.buildProtocolN)r9 r: r; r< r� r� r� r r r r rF � s rF c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) � _RetryingHTTP11ClientProtocolz�
A wrapper for L{HTTP11ClientProtocol} that automatically retries requests.
@ivar _clientProtocol: The underlying L{HTTP11ClientProtocol}.
@ivar _newConnection: A callable that creates a new connection for a
retry.
c C s || _ || _d S rp )�_clientProtocol�_newConnection)r] ZclientProtocol�
newConnectionr r r r� � s z&_RetryingHTTP11ClientProtocol.__init__c C sX |dkr dS t |tttf�s dS t |t�rH|jD ]}|�tj�r0 dS q0|dk rTdS dS )a�
Indicate whether request should be retried.
Only returns C{True} if method is idempotent, no response was
received, the reason for the failed request was not due to
user-requested cancellation, and no body was sent. The latter
requirement may be relaxed in the future, and PUT added to approved
method list.
@param method: The method of the request.
@type method: L{bytes}
)rA r� s OPTIONSs DELETEs TRACEFNT) r� r r r r Zreasons�checkr" ZCancelledError)r] r@ Z exception� bodyProducerZaFailurer r r � _shouldRetry� s
�
z*_RetryingHTTP11ClientProtocol._shouldRetryc s( �j �� �}� �fdd�}|�|� |S )z�
Do a request, and retry once (with a new connection) if it fails in
a retryable manner.
@param request: A L{Request} instance that will be requested using the
wrapped protocol.
c s2 �� � j| j� j�r*��� �� fdd��S | S d S )Nc s
| � � �S rp ��request)�
connectionrR r r rt � ru zG_RetryingHTTP11ClientProtocol.request.<locals>.failed.<locals>.<lambda>)rQ r@ r` rP rM r� r; �rS r] r r rx � s �
�z5_RetryingHTTP11ClientProtocol.request.<locals>.failed)rL rS Z
addErrback)r] rS r? rx r rU r rS � s
z%_RetryingHTTP11ClientProtocol.requestN)r9 r: r; r< r� rQ rS r r r r rK � s rK c @ sX e Zd ZdZeZdZdZdZe � Z
ddd�Z dd� Z d d
� Z
d d � Zd
d� Zdd� ZdS )�HTTPConnectionPoolaU
A pool of persistent HTTP connections.
Features:
- Cached connections will eventually time out.
- Limits on maximum number of persistent connections.
Connections are stored using keys, which should be chosen such that any
connections stored under a given key can be used interchangeably.
Failed requests done using previously cached connections will be retried
once if they use an idempotent method (e.g. GET), in case the HTTP server
timed them out.
@ivar persistent: Boolean indicating whether connections should be
persistent. Connections are persistent by default.
@ivar maxPersistentPerHost: The maximum number of cached persistent
connections for a C{host:port} destination.
@type maxPersistentPerHost: C{int}
@ivar cachedConnectionTimeout: Number of seconds a cached persistent
connection will stay open before disconnecting.
@ivar retryAutomatically: C{boolean} indicating whether idempotent
requests should be retried once if no response was received.
@ivar _factory: The factory used to connect to the proxy.
@ivar _connections: Map (scheme, host, port) to lists of
L{HTTP11ClientProtocol} instances.
@ivar _timeouts: Map L{HTTP11ClientProtocol} instances to a
C{IDelayedCall} instance of their timeout.
@since: 12.1
r� �� Tc C s || _ || _i | _i | _d S rp )�_reactor�
persistent� _connections� _timeouts)r] r% rY r r r r� s zHTTPConnectionPool.__init__c sr �j ���}|rf|�d�}�j| �� �j|= |jdkr �jrZ� ��fdd�}t||�}t� |�S q ��
�� �S )a
Supply a connection, newly created or retrieved from the pool, to be
used for one HTTP request.
The connection will remain out of the pool (not available to be
returned from future calls to this method) until one HTTP request has
been completed over it.
Afterwards, if the connection is still open, it will automatically be
added to the pool.
@param key: A unique key identifying connections that can be used
interchangeably.
@param endpoint: An endpoint that can be used to open a new connection
if no cached connection is available.
@return: A C{Deferred} that will fire with a L{HTTP11ClientProtocol}
(or a wrapper) that can be used to send a single HTTP request.
r � QUIESCENTc s �� �� �S rp )rM r ��endpointr_ r] r r rt 3 ru z2HTTPConnectionPool.getConnection.<locals>.<lambda>) rZ rR �popr[ r� �state�retryAutomaticallyrK r" ZsucceedrM )r] r_ r^ � connectionsrT rN r r] r �
getConnection s
� z HTTPConnectionPool.getConnectionc s( � �fdd�}�� |t|��}|�|�S )zv
Create a new connection.
This implements the new connection code path for L{getConnection}.
c s �� � | � d S rp )�_putConnection�r# �r_ r] r r rI A s z<HTTPConnectionPool._newConnection.<locals>.quiescentCallback)�_factory�reprZconnect)r] r_ r^ rI rL r rf r rM ; s z!HTTPConnectionPool._newConnectionc C s& |j �� | j| �|� | j|= dS )zG
Remove a connection from the cache and disconnect it.
N)r[ r� rZ �remover[ )r] r_ rT r r r �_removeConnectionG s
z$HTTPConnectionPool._removeConnectionc C s� |j dkr4z td��W n | j�d� Y nX dS | j�|g �}t|�| jkrz|�d�}|j �
� | j | � � | j |= |�
|� | j�| j| j||�}|| j |< dS )z�
Return a persistent connection to the pool. This will be called by
L{HTTP11ClientProtocol} when the connection becomes quiescent.
r\ z5BUG: Non-quiescent protocol added to connection pool.Nr )r` � RuntimeErrorr� r� rZ rc rT �maxPersistentPerHostr_ r[ r� r[ r� rX rX r� �cachedConnectionTimeoutrj )r] r_ rT rb ZdroppedZcidr r r rd P s.
��
�z!HTTPConnectionPool._putConnectionc C sd g }t | j�D ] }|D ]}|�|�� � qqi | _t | j�D ] }|�� q<i | _t�|��dd� �S )z�
Close all persistent connections and remove them from the pool.
@return: L{defer.Deferred} that fires when all connections have been
closed.
c S s d S rp r )Zignr r r rt z ru z;HTTPConnectionPool.closeCachedConnections.<locals>.<lambda>) r rZ rX �abortr[ r� r" Z
gatherResultsr� )r] ZresultsZ protocolsr
Zdcr r r �closeCachedConnectionsk s
z)HTTPConnectionPool.closeCachedConnectionsN)T)r9 r: r; r< rF rg rl rm ra r5 r� r� rc rM rj rd ro r r r r rV � s &
& rV c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �
_AgentBasea
Base class offering common facilities for L{Agent}-type classes.
@ivar _reactor: The C{IReactorTime} implementation which will be used by
the pool, and perhaps by subclasses as well.
@ivar _pool: The L{HTTPConnectionPool} used to manage HTTP connections.
c C s" |d krt |d�}|| _|| _d S �NF)rV rX �_pool)r] r% �poolr r r r� � s
z_AgentBase.__init__c C s8 t t|��rd| d }||fdkr(|S |d t|� S )z�
Compute the string to use for the value of the I{Host} header, based on
the given scheme, host name, and port number.
� [� ]�)rB rC )rE rF rD )r& r r )r] rN rP rO r r r �_computeHostValue� s
z _AgentBase._computeHostValuec
sv t ����dkrt� ���d�sD��� ���d���j�j�j�� �j �
||�}� �����fdd�} |� | � |S )zk
Issue a new request, given the endpoint and the path sent as part of
the request.
Nr> c
s | � tj���� �jj�d��S )N)rY � parsedURI)rS r Z
_constructrr rY )�proto�rP rQ r@ rx � requestPathr] r r � cbConnected� s ��z4_AgentBase._requestWithEndpoint.<locals>.cbConnected) r7 r4 � hasHeader�copy� addRawHeaderrw rN rP rO rr rc r� )
r] r_ r^ r@ rx rQ rP r{ r? r| r rz r �_requestWithEndpoint� s
��
z _AgentBase._requestWithEndpointN)r9 r: r; r< r� rw r� r r r r rp ~ s rp c @ s e Zd ZdZdd� Zdd� ZdS )�_StandardEndpointFactorya�
Standard HTTP endpoint destinations - TCP for HTTP, TCP+TLS for HTTPS.
@ivar _policyForHTTPS: A web context factory which will be used to create
SSL context objects for any SSL connections the agent needs to make.
@ivar _connectTimeout: If not L{None}, the timeout passed to
L{HostnameEndpoint} for specifying the connection timeout.
@ivar _bindAddress: If not L{None}, the address passed to
L{HostnameEndpoint} for specifying the local address to bind to.
c C s || _ || _|| _|| _dS )a�
@param reactor: A provider to use to create endpoints.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param contextFactory: A factory for TLS contexts, to control the
verification parameters of OpenSSL.
@type contextFactory: L{IPolicyForHTTPS}.
@param connectTimeout: The amount of time that this L{Agent} will wait
for the peer to accept a connection.
@type connectTimeout: L{float} or L{None}
@param bindAddress: The local address for client sockets to bind to.
@type bindAddress: L{bytes} or L{None}
N)rX �_policyForHTTPS�_connectTimeout� _bindAddress)r] r% r� �connectTimeout� bindAddressr r r r� � s z!_StandardEndpointFactory.__init__c C s� i }| j dk r| j |d< | j|d< zt|j�}W n$ tk
rT tdj|d���Y nX t| j||j f|�}|j
dkrx|S |j
dkr�| j � |j|j �}t
||�S td|j
f ��dS ) z�
Connect directly over TCP for C{b'http'} scheme, and TLS for
C{b'https'}.
@param uri: L{URI} to connect to.
@return: Endpoint to connect to.
@rtype: L{IStreamClientEndpoint}
Nr� r� zdThe host of the provided URI ({uri.host!r}) contains non-ASCII octets, it should be ASCII decodable.�r� rB rE zUnsupported scheme: %r)r� r� r rP �UnicodeDecodeErrorr� rJ r) rX rO rN r� r( r* r )r] r� r� rP r^ ZconnectionCreatorr r r �endpointForURI� s&
�
�
z'_StandardEndpointFactory.endpointForURIN)r9 r: r; r< r� r� r r r r r� � s r� c @ sL e Zd ZdZe� dddfdd�Zed
dd��Zdd� Zd d
� Z dd d �Z
dS )�Agenta+
L{Agent} is a very basic HTTP client. It supports I{HTTP} and I{HTTPS}
scheme URIs.
@ivar _pool: An L{HTTPConnectionPool} instance.
@ivar _endpointFactory: The L{IAgentEndpointFactory} which will
be used to create endpoints for outgoing connections.
@since: 9.0
Nc C sJ t �|�s*tjt|�d dtd� t|�}t||||�}| �|||� dS )a
Create an L{Agent}.
@param reactor: A reactor for this L{Agent} to place outgoing
connections.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param contextFactory: A factory for TLS contexts, to control the
verification parameters of OpenSSL. The default is to use a
L{BrowserLikePolicyForHTTPS}, so unless you have special
requirements you can leave this as-is.
@type contextFactory: L{IPolicyForHTTPS}.
@param connectTimeout: The amount of time that this L{Agent} will wait
for the peer to accept a connection.
@type connectTimeout: L{float}
@param bindAddress: The local address for client sockets to bind to.
@type bindAddress: L{bytes}
@param pool: An L{HTTPConnectionPool} instance, or L{None}, in which
case a non-persistent L{HTTPConnectionPool} instance will be
created.
@type pool: L{HTTPConnectionPool}
z� was passed as the HTTPS policy for an Agent, but it does not provide IPolicyForHTTPS. Since Twisted 14.0, you must pass a provider of IPolicyForHTTPS.r� )�
stacklevel�categoryN) r2 Z
providedBy�warnings�warnrh �DeprecationWarningr- r� �_init)r] r% r� r� r� rs �endpointFactoryr r r r� s
� � �zAgent.__init__c C s | � | �}|�|||� |S )a�
Create a new L{Agent} that will use the endpoint factory to figure
out how to connect to the server.
@param reactor: A reactor for this L{Agent} to place outgoing
connections.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param endpointFactory: Used to construct endpoints which the
HTTP client will connect with.
@type endpointFactory: an L{IAgentEndpointFactory} provider.
@param pool: An L{HTTPConnectionPool} instance, or L{None}, in which
case a non-persistent L{HTTPConnectionPool} instance will be
created.
@type pool: L{HTTPConnectionPool}
@return: A new L{Agent}.
)�__new__r� )r� r% r� rs rS r r r �usingEndpointFactory: s
zAgent.usingEndpointFactoryc C s t �| ||� || _dS )a�
Initialize a new L{Agent}.
@param reactor: A reactor for this L{Agent} to place outgoing
connections.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param endpointFactory: Used to construct endpoints which the
HTTP client will connect with.
@type endpointFactory: an L{IAgentEndpointFactory} provider.
@param pool: An L{HTTPConnectionPool} instance, or L{None}, in which
case a non-persistent L{HTTPConnectionPool} instance will be
created.
@type pool: L{HTTPConnectionPool}
@return: A new L{Agent}.
N)rp r� �_endpointFactory)r] r% r� rs r r r r� U s z Agent._initc C s | j �|�S )z�
Get an endpoint for the given URI, using C{self._endpointFactory}.
@param uri: The URI of the request.
@type uri: L{URI}
@return: An endpoint which can be used to connect to given address.
)r� r� )r] r� r r r � _getEndpointm s zAgent._getEndpointc C sn t |�� �}t�|�}z| �|�}W n tk
rD t�t� � Y S X |j |j
|j f}| � |||||||j
�S )a)
Issue a request to the server indicated by the given C{uri}.
An existing connection from the connection pool may be used or a new
one may be created.
I{HTTP} and I{HTTPS} schemes are supported in C{uri}.
@see: L{twisted.web.iweb.IAgent.request}
)r6 r� r� r� r� r r" Zfailr rN rP rO r� r� )r] r@ r� rQ rP rx r^ r_ r r r rS y s
�z
Agent.request)N)NN) r9 r: r; r< r% r� r� r� r� r� rS r r r r r� s
�
, r� c @ s$ e Zd ZdZddd�Zddd�ZdS ) �
ProxyAgentz�
An HTTP agent able to cross HTTP proxies.
@ivar _proxyEndpoint: The endpoint used to connect to the proxy.
@since: 11.1
Nc C s, |d krddl m} t�| ||� || _d S )Nr )r% )r� r% rp r� �_proxyEndpoint)r] r^ r% rs r r r r� � s zProxyAgent.__init__c C s4 t |�� �}d| jf}| �|| j|t�|�|||�S )z?
Issue a new request via the configured proxy.
z
http-proxy)r6 r� r� r� r� r� )r] r@ r� rQ rP r_ r r r rS � s
�zProxyAgent.request)NN)NN)r9 r: r; r< r� rS r r r r r� � s
r� c @ sR e Zd ZdZdd� Zdd� Zdd� Zdd � Zdd d �Zd
d� Z dd� Z
dd� Z d
S )�_FakeUrllib2Requesta�
A fake C{urllib2.Request} object for C{cookielib} to work with.
@see: U{http://docs.python.org/library/urllib2.html#request-objects}
@type uri: native L{str}
@ivar uri: Request URI.
@type headers: L{twisted.web.http_headers.Headers}
@ivar headers: Request headers.
@type type: native L{str}
@ivar type: The scheme of the URI.
@type host: native L{str}
@ivar host: The host[:port] of the URI.
@since: 11.1
c C sz t |�| _t� | _t�|�}t |j�| _t |j�| _|j|j fdkr\| jdt
|j � 7 _t rvt |j�| _ dd� | _
dS )zn
Create a fake Urllib2 request.
@param uri: Request URI.
@type uri: L{bytes}
rv �:c S s dS rq r )r� r r r rt � ru z._FakeUrllib2Request.__init__.<locals>.<lambda>N)r r� r4 rQ r� r� rN �typerP rO r� r Zorigin_req_hostZ unverifiable)r] r� Z_urir r r r� � s
z _FakeUrllib2Request.__init__c C s | j �t|��S rp )rQ r} r )r] �headerr r r �
has_header� s z _FakeUrllib2Request.has_headerc C s | j �t|�t|�� d S rp )rQ r r )r] �namer` r r r �add_unredirected_header� s z+_FakeUrllib2Request.add_unredirected_headerc C s | j S rp r� rq r r r � get_full_url� s z _FakeUrllib2Request.get_full_urlNc C s4 | j �t|�|�}|d k r0dd� |D �}|d S d S )Nc S s g | ] }t |��qS r �r �r �xr r r r
� s z2_FakeUrllib2Request.get_header.<locals>.<listcomp>r )rQ �
getRawHeadersr )r] r� �defaultrQ r r r �
get_header� s
z _FakeUrllib2Request.get_headerc C s | j S rp )rP rq r r r �get_host� s z _FakeUrllib2Request.get_hostc C s | j S rp )r� rq r r r �get_type� s z _FakeUrllib2Request.get_typec C s dS rq r rq r r r �is_unverifiable� s z#_FakeUrllib2Request.is_unverifiable)N) r9 r: r; r< r� r� r� r� r� r� r� r� r r r r r� � s
r� c @ s e Zd ZdZdd� Zdd� ZdS )�_FakeUrllib2Responsez�
A fake C{urllib2.Response} object for C{cookielib} to work with.
@type response: C{twisted.web.iweb.IResponse}
@ivar response: Underlying Twisted Web response.
@since: 11.1
c C s
|| _ d S rp �r� r� r r r r� s z _FakeUrllib2Response.__init__c s G � fdd�dt �}|� S )Nc s$ e Zd Z� fdd�Z� fdd�ZdS )z(_FakeUrllib2Response.info.<locals>._Metac s � j j�|g �}|S rp )r� rQ r� )�zelfr� rQ rq r r �
getheaders s z3_FakeUrllib2Response.info.<locals>._Meta.getheadersc s& � j j�t|�|�}dd� |D �}|S )Nc S s g | ] }t |��qS r r� r� r r r r
s zD_FakeUrllib2Response.info.<locals>._Meta.get_all.<locals>.<listcomp>)r� rQ r� r )r� r� r� rQ �hrq r r �get_all s �z0_FakeUrllib2Response.info.<locals>._Meta.get_allN)r9 r: r; r� r� r rq r r �_Meta s r� )�object)r] r� r rq r �info s z_FakeUrllib2Response.infoN)r9 r: r; r< r� r� r r r r r� s r� c @ s* e Zd ZdZdd� Zd dd�Zdd� ZdS )
� CookieAgentaj
L{CookieAgent} extends the basic L{Agent} to add RFC-compliant
handling of HTTP cookies. Cookies are written to and extracted
from a C{cookielib.CookieJar} instance.
The same cookie jar instance will be used for any requests through this
agent, mutating it whenever a I{Set-Cookie} header appears in a response.
@type _agent: L{twisted.web.client.Agent}
@ivar _agent: Underlying Twisted Web agent to issue requests through.
@type cookieJar: C{cookielib.CookieJar}
@ivar cookieJar: Initialized cookie jar to read cookies from and store
cookies to.
@since: 11.1
c C s || _ || _d S rp )�_agent� cookieJar)r] rS r� r r r r� 2 s zCookieAgent.__init__Nc C s| |dkrt � }t|�}|�d�sX| j�|� |�dd�}|dk rX|�� }|�dt|�� | j �
||||�}|� | j |� |S )a�
Issue a new request to the wrapped L{Agent}.
Send a I{Cookie} header if a cookie for C{uri} is stored in
L{CookieAgent.cookieJar}. Cookies are automatically extracted and
stored from requests.
If a C{'cookie'} header appears in C{headers} it will override the
automatic cookie header obtained from the cookie jar.
@see: L{Agent.request}
Nr? ZCookie)
r4 r� r} r� Zadd_cookie_headerr� r~ r r r� rS r� �_extractCookies)r] r@ r� rQ rP Z lastRequestZ cookieHeaderr? r r r rS 7 s
zCookieAgent.requestc C s t |�}| j�||� |S )z�
Extract response cookies and store them in the cookie jar.
@type response: L{twisted.web.iweb.IResponse}
@param response: Twisted Web response.
@param request: A urllib2 compatible request object.
)r� r� Zextract_cookies)r] r� rS Zrespr r r r� U s zCookieAgent._extractCookies)NN)r9 r: r; r< r� rS r� r r r r r� s
r� c @ s e Zd ZdZdd� Zdd� ZdS )� GzipDecoderz�
A wrapper for a L{Response} instance which handles gzip'ed body.
@ivar original: The original L{Response} object.
@since: 11.1
c C s || _ t| _d S rp )�originalr. r� r� r r r r� m s zGzipDecoder.__init__c C s | j �t|| j �� dS )zf
Override C{deliverBody} to wrap the given C{protocol} with
L{_GzipProtocol}.
N)r� � deliverBody�
_GzipProtocol)r] r# r r r r� r s zGzipDecoder.deliverBodyN)r9 r: r; r< r� r� r r r r r� d s r� c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) r� a0
A L{Protocol} implementation which wraps another one, transparently
decompressing received data.
@ivar _zlibDecompress: A zlib decompress object used to decompress the data
stream.
@ivar _response: A reference to the original response, in case of errors.
@since: 11.1
c C s" || _ || _t�dtj �| _d S )Nr )r� � _response�zlibZ
decompressobjZ MAX_WBITS�_zlibDecompress)r] r# r� r r r r� � s z_GzipProtocol.__init__c C sL z| j �|�}W n& tjk
r6 tt� g| j��Y nX |rH| j�|� dS )zz
Decompress C{data} with the zlib decompressor, forwarding the raw data
to the original protocol.
N) r� �
decompressr� r- r r r� r� � dataReceived)r] r^ �rawDatar r r r� � s z_GzipProtocol.dataReceivedc C sX z| j �� }W n( tjk
r6 t|t� g| j��Y nX |rH| j�|� | j� |� dS )zr
Forward the connection lost event, flushing remaining data from the
decompressor if any.
N)
r� �flushr� r- r r r� r� r� r� )r] r� r� r r r r� � s z _GzipProtocol.connectionLostN�r9 r: r; r< r� r� r� r r r r r� { s
r� c @ s* e Zd ZdZdd� Zd dd�Zdd� ZdS )
�ContentDecoderAgenta^
An L{Agent} wrapper to handle encoded content.
It takes care of declaring the support for content in the
I{Accept-Encoding} header, and automatically decompresses the received data
if it's effectively using compression.
@param decoders: A list or tuple of (name, decoder) objects. The name
declares which decoding the decoder supports, and the decoder must
return a response object when called/instantiated. For example,
C{(('gzip', GzipDecoder))}. The order determines how the decoders are
going to be advertized to the server.
@since: 11.1
c C s* || _ t|�| _d�dd� |D ��| _d S )N� ,c S s g | ] }|d �qS )r r )r �decoderr r r r
� s z0ContentDecoderAgent.__init__.<locals>.<listcomp>)r� �dict� _decodersrZ �
_supported)r] rS Zdecodersr r r r� � s
z ContentDecoderAgent.__init__Nc C sD |dkrt � }n|�� }|�d| j� | j�||||�}|�| j�S )zv
Send a client request which declares supporting compressed content.
@see: L{Agent.request}.
Ns accept-encoding)r4 r~ r r� r� rS r� �_handleResponse�r] r@ r� rQ rP r� r r r rS � s zContentDecoderAgent.requestc C s� |j �dg �}d�|��d�}|rZ|�� �� }| j�|�}|dk rL||�}q |�|� qZq |rv|j � dd�|�g� n |j �
d� |S )zX
Check if the response is encoded, and wrap it to handle decompression.
s content-encodingr� N) rQ r� rZ r� r_ r� r� rR rX Z
setRawHeadersZ removeHeader)r] r� ZcontentEncodingHeadersr� r� r r r r� � s& �
� z#ContentDecoderAgent._handleResponse)NN)r9 r: r; r< r� rS r� r r r r r� � s
r� s
AuthorizationrJ s Cookie2s Proxy-Authorizations WWW-Authenticatec @ sb e Zd ZdZejejejgZej gZ
de e e
e d�dd�Zddd �Zd
d � Zd d
� Zdd� ZdS )�
RedirectAgenta
An L{Agent} wrapper which handles HTTP redirects.
The implementation is rather strict: 301 and 302 behaves like 307, not
redirecting automatically on methods different from I{GET} and I{HEAD}.
See L{BrowserLikeRedirectAgent} for a redirecting Agent that behaves more
like a web browser.
@param redirectLimit: The maximum number of times the agent is allowed to
follow redirects before failing with a L{error.InfiniteRedirection}.
@param sensitiveHeaderNames: An iterable of C{bytes} enumerating the names
of headers that must not be transmitted when redirecting to a different
origins. These will be consulted in addition to the protocol-specified
set of headers that contain sensitive information.
@cvar _redirectResponses: A L{list} of HTTP status codes to be redirected
for I{GET} and I{HEAD} methods.
@cvar _seeOtherResponses: A L{list} of HTTP status codes to be redirected
for any method and the method altered to I{GET}.
@since: 11.1
r� r )rS r� �sensitiveHeaderNamesc C s. || _ || _dd� |D �}|�t� || _d S )Nc S s h | ] }t |��qS r )�_canonicalHeaderName)r Zeachr r r � <setcomp> s z)RedirectAgent.__init__.<locals>.<setcomp>)r� �_redirectLimit�update�_defaultSensitiveHeaders�_sensitiveHeaderNames)r] rS r� r� Z sensitiver r r r� s
zRedirectAgent.__init__Nc C s& | j �||||�}|�| j|||d�S )zb
Send a client request following HTTP redirects.
@see: L{Agent.request}.
r )r� rS r� r� r� r r r rS # s �zRedirectAgent.requestc C s
t ||�S )a2
Resolve the redirect location against the request I{URI}.
@type requestURI: C{bytes}
@param requestURI: The request I{URI}.
@type location: C{bytes}
@param location: The redirect location.
@rtype: C{bytes}
@return: Final resolved I{URI}.
)r� )r] Z
requestURIr| r r r �_resolveLocation. s
z RedirectAgent._resolveLocationc s |�j kr,tj� jd|d�}tt|�g� ��� j�dg �}|s^t�� jd|�}tt|�g� ���� ||d �}|r�t
� |�} t
� |�}
| j |
j ko�| j
|
j
ko�| j|
jk} | s�t�fdd�|�� D ��}�j�|||�} � fdd �}
| �|
� | ��j||||d
�S ) z�
Handle a redirect response, checking the number of redirects already
followed, and extracting the location header fields.
rz r{ ry s No location header fieldr c s i | ]\}}|� j kr||�qS r )r� )r ZrawNameZrawValuerq r r �
<dictcomp>Y s
� z1RedirectAgent._handleRedirect.<locals>.<dictcomp>c s | � � � | S rp )ZsetPreviousResponse)Z newResponser� r r �_chainResponse` s
z5RedirectAgent._handleRedirect.<locals>._chainResponserw )r� r- r� �coder r rQ r� ZRedirectWithNoLocationr� r� r� rN rP rO r4 ZgetAllRawHeadersr� rS r� r� )r] r� r@ r� rQ �
redirectCountr� ZlocationHeadersr| rx ZparsedLocationZ
sameOriginr� r� r )r� r] r �_handleRedirect> sP
� �
�
�
��
�z RedirectAgent._handleRedirectc C sh |j | jkrF|dkr4tj|j |d�}tt|�g|��| �|||||�S |j | jkrd| �|d|||�S |S )zY
Handle the response, making another request if it indicates a redirect.
)rA r� r{ rA )r� �_redirectResponsesr- r� r r r� �_seeOtherResponses)r] r� r@ r� rQ r� r� r r r r� h s � �z RedirectAgent._handleResponse)r� r )NN)r9 r: r; r< r! �MOVED_PERMANENTLY�FOUND�TEMPORARY_REDIRECTr� � SEE_OTHERr� r/ r� r rB r� rS r� r� r� r r r r r� � s � ��
*r� c @ s( e Zd ZdZejgZejejej gZ
dS )�BrowserLikeRedirectAgentaO
An L{Agent} wrapper which handles HTTP redirects in the same fashion as web
browsers.
Unlike L{RedirectAgent}, the implementation is more relaxed: 301 and 302
behave like 303, redirecting automatically on any method and altering the
redirect request to a I{GET}.
@see: L{RedirectAgent}
@since: 13.1
N) r9 r: r; r< r! r� r� r� r� r� r� r r r r r� y s r� c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �_ReadBodyProtocolak
Protocol that collects data sent to it.
This is a helper for L{IResponse.deliverBody}, which collects the body and
fires a deferred with it.
@ivar deferred: See L{__init__}.
@ivar status: See L{__init__}.
@ivar message: See L{__init__}.
@ivar dataBuffer: list of byte-strings received
@type dataBuffer: L{list} of L{bytes}
c C s || _ || _|| _g | _dS )a#
@param status: Status of L{IResponse}
@ivar status: L{int}
@param message: Message of L{IResponse}
@type message: L{bytes}
@param deferred: deferred to fire when response is complete
@type deferred: L{Deferred} firing with L{bytes}
N)r� rg rh �
dataBuffer)r] rg rh r� r r r r� � s z_ReadBodyProtocol.__init__c C s | j �|� dS )z?
Accumulate some more bytes from the response.
N)r� rX r� r r r r� � s z _ReadBodyProtocol.dataReceivedc C s\ |� t�r | j�d�| j�� n8|� t�rL| j�t| j | j
d�| j��� n | j�|� dS )z�
Deliver the accumulated response bytes to the waiting L{Deferred}, if
the response body has been completely received without error.
ru N) rO r r� r� rZ r� r r� r8 rg rh r� r r r r� � s
��z _ReadBodyProtocol.connectionLostNr� r r r r r� � s r� c sd � fdd�}t �|�}t| j| j|���fdd�� | ��� �jdk r`� � dkr`tjdt dd� |S ) a�
Get the body of an L{IResponse} and return it as a byte string.
This is a helper function for clients that don't want to incrementally
receive the body of an HTTP response.
@param response: The HTTP response for which the body will be read.
@type response: L{IResponse} provider
@return: A L{Deferred} which will fire with the body of the response.
Cancelling it will close the connection to the server immediately.
c s � � }|dk r|� dS )z�
Cancel a L{readBody} call, close the connection to the HTTP server
immediately, if it is still open.
@param deferred: The cancelled L{defer.Deferred}.
Nr )r� rn )�getAbortr r r� � s zreadBody.<locals>.cancelc s t � jdd �S )Nr� )rK r[ r re r r r� � s zreadBody.<locals>.getAbortNzLUsing readBody with a transport that does not have an abortConnection methodr� )r� r� )
r" r� r� r� �phraser� r[ r� r� r� )r� r� r? r )r� r# r �readBody� s
�r� r r r r r r )N)N)N)�r< Z
__future__r r r� r� r� r� r r r � ImportErrorZ urllib.parser Zzope.interfacer �typingr � functoolsr Ztwisted.python.compatr r r r r r Ztwisted.python.deprecater r r Ztwisted.python.failurer Z incrementalr Z twisted.webr! r� r" r# r$ r% Ztwisted.internet.abstractr& Ztwisted.internet.interfacesr' r( Ztwisted.internet.endpointsr) r* Ztwisted.python.utilr+ Ztwisted.python.componentsr, r- Ztwisted.web.iwebr. r/ r0 r1 r2 r3 Ztwisted.web.http_headersr4 Ztwisted.loggerr5 Ztwisted.web._newclientr6 r7 r� r8 r� r= r� r� r� r� r� r� r� r� r r r r Ztwisted.web.errorr r
r r r r r r r r r r ZOpenSSLr Ztwisted.internet.sslr r r r r r% r� r: r9 r* r- r/ ZFactoryrF rK rV rp r� r� r� r� r� r� r� r� r� Z_canonicalNameCapsr� � frozensetr� r� r� ZProtocolr� r� �__all__r r r r �<module> s G! 8mp
� � 4
+" ���� (kA ;F #M D/>�� 7+�