�
Ϫ�f� � �| � d Z ddlmZ ddlZddlZddlZddlZddlmZ ddl m
Z
ddl m Z ddl
mZmZmZ ddlmZmZmZ dd lmZ dd
lmZ dd lmZm Z m Z dd l m Z dd
l m!Z! ddl"m#Z#m$Z$ ddl%m&Z&m'Z' ddl(m)Z) ddl*m+Z+m,Z, ddl-m.Z. ddl/m0Z0m1Z1 ddl2m3Z3 ddl4m5Z5m6Z6 ddl7m8Z8m9Z9 ddl:m;Z; ddl<m=Z=m>Z>m?Z?m@Z@mAZAmBZB erddlCmDZE ddlFmGZH ddlImJZK neLZKeLZHeLZEd � Z G d � d e5j� � ZN G d � d � ZOd!� ZPd^d"�ZQdd#l7mRZRmSZSmJZJmTZTmUZUmVZVmWZWmXZXmYZYmZZZm[Z[ dd$l\m]Z] dd%l^m_Z_ dd&l`maZambZbmcZc d'� Ze G d(� d)� Zf eeA� G d*� d+� � Zg e0 ed,d-dd� e1ef ed,d-dd� eg�.� j� d/� d0 efj� efj� � eeA� G d1� d2� � Zk ee&� G d3� d4� � Zl eeA� G d5� d6� � Zm ee@� G d7� d8� � Zn G d9� d:e j� � Zp G d;� d<� Zq G d=� d>� Zr G d?� d@� Zs ee?� G dA� dB� � Zt ee>� G dC� dDes� � Zu ee>� G dE� dFes� � Zv G dG� dHeK� Zwe G dI� dJeE� � Zx G dK� dLeH� Zy ee>� G dM� dN� � Zz G dO� dP e.eB� � Z{ G dQ� dR e.e'� � Z| ee>� G dS� dT� � Z} e;� j� Z e�g dU�� Z� ee>� G dV� dW� � Z� G dX� dYe�� Z� G dZ� d[e �j � Z�d_d\�Z�g d]�Z�y# ed$ r dZ_Y �� w xY w)`z
HTTP client.
� )� annotationsN)� dataclass)�wraps)� CookieJar)�
TYPE_CHECKING�Iterable�Optional)� urldefrag�urljoin�
urlunparse)� implementer)�Version)�defer�protocol�task)�
isIPv6Address)�Deferred)�HostnameEndpoint�
wrapClientTLS)�IOpenSSLContextFactory� IProtocol)�Logger)� nativeString�
networkString)�proxyForInterface)�deprecatedModuleAttribute�getDeprecationWarningString)�Failure)�error�http)�_ensureValidMethod�_ensureValidURI)�Headers)�UNKNOWN_LENGTH�IAgent�IAgentEndpointFactory�
IBodyProducer�IPolicyForHTTPS� IResponse)� EmailMessage)� HTTPResponse)�Requestc �Z � t t d� | D � � � }|j d� S )Nc 3 �> K � | ] }|j d � �� � y�w)�charmapN)�decode)�.0�ps �4/usr/lib/python3/dist-packages/twisted/web/client.py� <genexpr>z urlunparse.<locals>.<genexpr>B s � �� � B�q�q�x�x� � 2� B�s � r/ )� _urlunparse�tuple�encode)�parts�results r3 r r A s& � �
�� B�E� B�B�
C�F� �=�=�� #�#� c � � e Zd ZdZy)�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: r3 r< r< F s � �r: r< c �> � e Zd ZdZd� Zedd�� Zd� Zed� � Z y)�URIzd
A URI object.
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-21}
c � � || _ || _ |j d� | _ || _ || _ || _ || _ || _ y)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) �scheme�netloc�strip�host�port�path�params�query�fragment) �selfrE rF rH rI rJ rK rL rM s r3 �__init__z URI.__init__U sE � �6 �� � �� ��J�J�u�%�� ��� ��� � �� ���
� ��
r: Nc
�
� |j � }t j |� \ }}}}}}|�
|dk( rd}nd}d|v r"|j dd� \ } }
t |
� }
n||}
} | ||| |
||||� S # t
$ r ||}
} Y � w xY w)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.
� https� �P � :� )rG r �urlparse�rsplit�int�
ValueError) �cls�uri� defaultPortrE rF rJ rK rL rM rH rI s r3 � fromBytesz
URI.fromBytesy s� � � �i�i�k��8<�
�
�c�8J�5����f�e�X� � ���!� !� � � � �6�>� � � �t�Q�/�J�D�$�
1��4�y�� ��$�D��6�6�4��t�V�U�H�M�M�� �
1� #�[�d��
1�s � A2 �2
B�Bc � � t | j | j | j | j | j
| j f� 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 rE rF rJ rK rL rM �rN s r3 �toBytesz URI.toBytes� s@ � � �� � �� � �� � �� � ��
�
��
�
�
�
�
r: c �r � t dd| j | j | j df� }|dk( rd}|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}
r: � /)r rJ rK rL )rN rJ s r3 �
originFormzURI.originForm� s8 � � �3��T�Y�Y�� � �T�Z�Z��M�N�� �3�;��D�� r: �N)
r= r> r? r@ rO � classmethodr] r` �propertyrc rA r: r3 rC rC N s= � �� "!�H � N� � N�B
�$ �� �r: rC c �t � t | � \ } }t t | |� � \ }}t |d|xs |z � 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{urllib.parse.urljoin()}
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22#section-7.1.2}
� #)r
r )�base�url�baseFrag�urlFrags r3 �_urljoinrm � s= � �. �t�_�N�D�(� �W�T�3� /�0�L�C�� �3��� 3�8�4� 5�5r: c � � t j t | j � � � } || g|��i |��}ddlm} |j dk( rKddlm} |�|j � }|j t |j � |j ||� |S |j 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}
r ��reactorrQ )�ssl)rC r] r" rG �twisted.internetrp rE rq �ClientContextFactory�
connectSSLr rH rI �
connectTCP) rj �factoryFactory�contextFactory�args�kwargsr[ �factoryrp rq s r3 �_makeGetterFactoryr{ � s� � � �-�-��� � � �4�
5�C� �S�2�4�2�6�2�G�(�
�z�z�X� �(� � !� � 5� 5� 7�N����<����1�3�8�8�W�n�U� �N� ���<����1�3�8�8�W�E� �Nr: ) �HTTP11ClientProtocol�PotentialDataLossr, �RequestGenerationFailed�RequestNotSent�RequestTransmissionFailed�Response� ResponseDone�ResponseFailed�ResponseNeverReceived�_WrapperException)�SchemeNotSupported)�SSL)�CertificateOptions�optionsForClientTLS�
platformTrustc �8 � t �t | � d� � }|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}
c � � t d� �)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 unavailable)�NotImplementedError)�a�kws r3 �raiseNotImplementedz(_requireSSL.<locals>.raiseNotImplemented' s � � &�&?�@� @r: )r� r )� decorateer� s r3 � _requireSSLr� s0 � � �{� �y� �
A�
�
A� #�"� �r: c �& � e Zd ZdZd� Zed� � Zy)�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 �H � t t j t � �� S )z�
Return a L{CertificateOptions}.
@param hostname: ignored
@param port: ignored
@return: A new CertificateOptions instance.
@rtype: L{CertificateOptions}
)�method� trustRoot)r� r� �
SSLv23_METHODr� �rN �hostnamerI s r3 �_getCertificateOptionsz.WebClientContextFactory._getCertificateOptionsC s � � "��):�):�m�o�V�Vr: c �B � | j ||� j � 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� s r3 r� z"WebClientContextFactory.getContextP s � � �*�*�8�T�:�E�E�G�Gr: N)r= r> r? r@ r� r� r� rA r: r3 r� r� 8 s# � �� W� �
H� �
Hr: r� c �( � e Zd ZdZdd�Zed� � Zy)�BrowserLikePolicyForHTTPSz1
SSL connection creator for web clients.
Nc � � || _ y rd )�
_trustRoot)rN r� s r3 rO z"BrowserLikePolicyForHTTPS.__init__d s � �#��r: c �N � t |j d� | j �� S )a
Create a L{client connection creator
<twisted.internet.interfaces.IOpenSSLClientConnectionCreator>} for a
given network location.
@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� r0 r� r� s r3 �creatorForNetlocz*BrowserLikePolicyForHTTPS.creatorForNetlocg s � �$ #�8�?�?�7�#;�t���W�Wr: rd )r= r> r? r@ rO r� r� rA r: r3 r� r� ^ s" � ��$� �X� �Xr: r� �Twisted� )� replacementz; rU c � � e Zd ZdZdd�Zd� Zy)�HostnameCachingHTTPSPolicya�
IPolicyForHTTPS that wraps a L{IPolicyForHTTPS} and caches the created
L{IOpenSSLClientConnectionCreator}.
This policy will cache up to C{cacheSize}
L{client connection creators <twisted.internet.interfaces.
IOpenSSLClientConnectionCreator>} for reuse in subsequent requests to
the same hostname.
@ivar _policyForHTTPS: See C{policyforHTTPS} parameter of L{__init__}.
@ivar _cache: A cache associating hostnames to their
L{client connection creators <twisted.internet.interfaces.
IOpenSSLClientConnectionCreator>}.
@type _cache: L{collections.OrderedDict}
@ivar _cacheSize: See C{cacheSize} parameter of L{__init__}.
@since: Twisted 19.2.0
c �R � || _ t j � | _ || _ y)z�
@param policyforHTTPS: The IPolicyForHTTPS to wrap.
@type policyforHTTPS: L{IPolicyForHTTPS}
@param cacheSize: The maximum size of the hostname cache.
@type cacheSize: L{int}
N)�_policyForHTTPS� collections� OrderedDict�_cache�
_cacheSize)rN �policyforHTTPS� cacheSizes r3 rO z#HostnameCachingHTTPSPolicy.__init__� s# � � .�� �!�-�-�/�� �#��r: c �P � |j d� } | j j |� }|| j |< t
| j � | j kD r | j j d�� |S # t $ r | j j ||� }Y �vw xY w)a<
Create a L{client connection creator
<twisted.internet.interfaces.IOpenSSLClientConnectionCreator>} for a
given network location and cache it for future use.
@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>}
r� F)�last) r0 r� �pop�KeyErrorr� r� �lenr� �popitem)rN r� rI rH �creators r3 r� z+HostnameCachingHTTPSPolicy.creatorForNetloc� s� � �" ���w�'�� L��k�k�o�o�d�+�G� $�� � �D�� �t�{�{� �d�o�o� -� �K�K� � �U� � +���� � L��*�*�;�;�H�d�K�G� L�s �A= �=%B%�$B%N)� �r= r> r? r@ rO r� rA r: r3 r� r� � s � ��*
$�r: r� c � � e Zd ZdZd� Zd� Zy)�_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 � � || _ y)z�
Initialize a L{_ContextFactoryWithContext} with a context.
@param context: An SSL context.
@type context: L{OpenSSL.SSL.Context}
N��_context)rN �contexts r3 rO z#_ContextFactoryWithContext.__init__� s � � ��
r: c � � | j S )z�
Return the context created by
L{_DeprecatedToCurrentPolicyForHTTPS._webContextFactory}.
@return: A context.
@rtype: L{OpenSSL.SSL.Context}
r� r_ s r3 r� z%_ContextFactoryWithContext.getContext� s � � �}�}� r: N)r= r> r? r@ rO r� rA r: r3 r� r� � s � �� � r: r� c � � e Zd ZdZd� Zd� Zy)�"_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 � � || _ y)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)rN �webContextFactorys r3 rO z+_DeprecatedToCurrentPolicyForHTTPS.__init__� s � � #4�� r: c �P � | j 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� )rN r� rI r� s r3 r� z3_DeprecatedToCurrentPolicyForHTTPS.creatorForNetloc� s' � � �)�)�4�4�X�t�D��)�'�2�2r: Nr� rA r: r3 r� r� � s � �� 4�3r: r� c �@ � e Zd ZdZedfd�Zd� Zd� Zd� Zd� Z d� Z
d � Z y
) �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 �n � || _ |j | _ || _ | j |� | _ y rd )�
_inputFile� cooperate�
_cooperate� _readSize�_determineLength�length)rN � inputFile�
cooperator�readSizes r3 rO zFileBodyProducer.__init__& s/ � �#���$�.�.���!����+�+�I�6�� r: c �� � |j }|j } |� } |dt j
� |� } ||t j � ||z
S # t $ r t cY S w xY w)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 )�seek�tell�AttributeErrorr$ �os�SEEK_END�SEEK_SET)rN �fObjr� r� �originalPosition�ends r3 r� z!FileBodyProducer._determineLength, sj � � "��9�9�D��9�9�D� �6�� �Q�� � � ��f�� �
�r�{�{�+��%�%�%��
� "�!� !� "�s �A �A-�,A-c � � | j j � | j j � y# t j
$ r Y yw xY w)z�
Permanently stop writing bytes from the file to the consumer by
stopping the underlying L{CooperativeTask}.
N)r� �close�_task�stopr � TaskFinishedr_ s r3 �
stopProducingz FileBodyProducer.stopProducing= s? � �
��� � � � � �J�J�O�O� ��� � � � � �s �7 �A
� A
c � � � � j � j |� � � _ � j j � }� fd�}|j d� |� |S )aZ
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. If this L{Deferred} is cancelled before it is
fired, stop reading and writing bytes.
@param consumer: Any L{IConsumer} provider
c � �� | j t j � r$�j � t j � S | j t j
� r t j � S | S rd )�checkr �CancelledErrorr� r � TaskStoppedr )�reasonrN s �r3 � maybeStoppedz5FileBodyProducer.startProducing.<locals>.maybeStoppedT s] �� ��|�|�E� 0� 0�1��"�"�$� �>�>�#� #�
� � �d� .� .�/��
�>�>�#� #� �
r: c � � y rd rA )�ignoreds r3 �<lambda>z1FileBodyProducer.startProducing.<locals>.<lambda>_ � � r: )r� �
_writeloopr� �whenDone� addCallbacks)rN �consumer�dr� s ` r3 �startProducingz FileBodyProducer.startProducingH sK �� � �_�_�T�_�_�X�%>�?��
� �J�J� � � !�� $�
���+�\�:��r: c # � K � | j j | j � }|s| j j � y|j |� d�� �X�w)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)r� �readr� r� �write)rN r� �bytess r3 r� zFileBodyProducer._writeloopb sO � �� �
��O�O�(�(�� � �8�E�����%�%�'�� �N�N�5� !��J�
�s �AA c �8 � | j j � y)z�
Temporarily suspend copying bytes from the input file to the consumer
by pausing the L{CooperativeTask} which drives that activity.
N)r� �pauser_ s r3 �pauseProducingz FileBodyProducer.pauseProducingo s � �
�
�
���r: c �8 � | j j � y)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)r� �resumer_ s r3 �resumeProducingz FileBodyProducer.resumeProducingv s � �
�
�
���r: N) r= r> r? r@ r rO r� r� r� r� r� r� rA r: r3 r� r� s1 � ��* .2�E� 7� &�" ��4 �� r: r� c �$ � e Zd ZdZd� Zdd�Zd� Zy)�_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 � � || _ || _ y rd )�_quiescentCallback� _metadata)rN �quiescentCallback�metadatas r3 rO z _HTTP11ClientFactory.__init__� s � �"3�� �!��r: c �N � dj | j | j � S )Nz _HTTP11ClientFactory({}, {}))�formatr r r_ s r3 �__repr__z _HTTP11ClientFactory.__repr__� s$ � �-�4�4� � #� #�T�^�^�
�
r: c �, � t | j � S rd )r| r )rN �addrs r3 �
buildProtocolz"_HTTP11ClientFactory.buildProtocol� s � �#�D�$;�$;�<�<r: N)�return�str)r= r> r? r@ rO r r rA r: r3 r r s � �
�"�
�
=r: r c �" � e Zd ZdZd� Zd� Zd� Zy)� _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 � � || _ || _ y rd )�_clientProtocol�_newConnection)rN �clientProtocol�
newConnections r3 rO z&_RetryingHTTP11ClientProtocol.__init__� s � � -�� � +��r: c �� � |dvryt |t t t f� syt |t � r2|j
D ]# }|j
t j � s�# y |�yy)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}
)� GET� HEADs OPTIONSs DELETEs TRACEFT) �
isinstancer r� r� r� �reasonsr� r r� )rN r� � exception� bodyProducer�aFailures r3 � _shouldRetryz*_RetryingHTTP11ClientProtocol._shouldRetry� so � � �K� K��� �
� 6�8M� N�
� � �i�!2� 3� %� -� -�
!���>�>�%�"6�"6�7� �
!� � #��r: c �n � �� � j j �� }�� fd�}|j |� |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 � �� �j �j | j �j � r"�j � j �fd�� S | S )Nc �& �� | j �� S rd )�request)�
connectionr! s �r3 r� zG_RetryingHTTP11ClientProtocol.request.<locals>.failed.<locals>.<lambda>� s �� �z�'9�'9�'�'B� r: )r r� �valuer r � addCallback)r� r! rN s ��r3 �failedz5_RetryingHTTP11ClientProtocol.request.<locals>.failed� sI �� �� � �� � �� � �w�?S�?S�T��*�*�,�8�8�B�� � �
r: )r r! �
addErrback)rN r! r� r% s `` r3 r! z%_RetryingHTTP11ClientProtocol.request� s3 �� �
� � � (� (�� 1�� �
� � �V� ��r: N)r= r> r? r@ rO r r! rA r: r3 r r � s � ��,��8r: r c �T � e Zd ZdZeZdZdZdZ e � Z
d d�Z d� Z d� Z
d� Zd � Zd
� Zy )
�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
� �� Tc �< � || _ || _ i | _ i | _ y rd )�_reactor�
persistent� _connections� _timeouts)rN rp r- s r3 rO zHTTPConnectionPool.__init__ s � � ��
�$��� �����r: c �h � ��� � j j �� }|r�|j d� }� j | j � � j |= |j
dk( r4� j r��� fd�}t ||� }t j |� S |r��� j ��� 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 �( �� �j �� � S rd )r )�endpoint�keyrN s ���r3 r� z2HTTPConnectionPool.getConnection.<locals>.<lambda>* s �� �D�,?�,?��X�,N� r: ) r. �getr� r/ �cancel�state�retryAutomaticallyr r �succeedr )rN r4 r3 � connectionsr" r s ``` r3 �
getConnectionz HTTPConnectionPool.getConnection s� �� �, �'�'�+�+�C�0� ��$� � ��+�J� �N�N�:� &� -� -� /����z�*�� � �;�.��*�*�$N�M�!>�"�M�"�J� �}�}�Z�0�0� � �"�"�3��1�1r: c �j � �� �� fd�}� j |t |� � }|j |� S )zv
Create a new connection.
This implements the new connection code path for L{getConnection}.
c �* �� �j �| � y rd )�_putConnection)r r4 rN s ��r3 r z<HTTPConnectionPool._newConnection.<locals>.quiescentCallback9 s �� � � � ��X� .r: )�_factory�repr�connect)rN r4 r3 r rz s `` r3 r z!HTTPConnectionPool._newConnection2 s0 �� � /� �-�-� 1�4��>�B��� � ��(�(r: c � � |j j � | j | j |� | j |= y)zG
Remove a connection from the cache and disconnect it.
N)� transport�loseConnectionr. �remover/ )rN r4 r" s r3 �_removeConnectionz$HTTPConnectionPool._removeConnection? s; � � � � �+�+�-� ���#� �%�%�j�1� �N�N�:� &r: c �D � |j dk7 r t d� �| j
j
|g � }t |� | j k( rU|j d� }|j j � | j | j � | j |= |j |� | j j! | j" | j$ ||� }|| j |< y# t $ r | j j d� Y yw xY w)z�
Return a persistent connection to the pool. This will be called by
L{HTTP11ClientProtocol} when the connection becomes quiescent.
r1 z5BUG: Non-quiescent protocol added to connection pool.Nr )r7 � RuntimeError�
BaseException�_log�failurer. �
setdefaultr� �maxPersistentPerHostr� rC rD r/ r6 �appendr, � callLater�cachedConnectionTimeoutrF )rN r4 r" r: �dropped�cids r3 r> z!HTTPConnectionPool._putConnectionG s � �
� � �{� *�
�"�K�� � �'�'�2�2�3��;� � �{� �t� 8� 8� 8�!�o�o�a�(�G� � � � ,� ,� .� �N�N�7� #� *� *� ,����w�'����:�&��m�m�%�%� � (� (�$�*@�*@�#�z�
�� &)����z�"�� !�
�� � �!�!�K��
�
�s � C8 �8$D � D c �T � g }| j j � D ]( }|D ]! }|j |j � � �# �* i | _ | j j � D ] }|j � � i | _ t
j |� j d� � 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 � � y rd rA )�igns r3 r� z;HTTPConnectionPool.closeCachedConnections.<locals>.<lambda>r r� r: ) r. �valuesrN �abortr/ r6 r �
gatherResultsr$ )rN �results� protocolsr2 �dcs r3 �closeCachedConnectionsz)HTTPConnectionPool.closeCachedConnectionsc s� � � �� �*�*�1�1�3� *�I� �
*�����q�w�w�y�)�
*� *� ����.�.�'�'�)� �B� �I�I�K� �����"�"�7�+�7�7�8H�I�Ir: N)T)r= r> r? r@ r r? rM rP r8 r rJ rO r; r rF r> r\ rA r: r3 r( r( � sH � �$�L $�H� �� !�� �� �8�D� � $2�L )�'�)�8Jr: r( c �" � e Zd ZdZd� Zd� Zd� Zy)�
_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 �< � |� t |d� }|| _ || _ y �NF)r( r, �_pool)rN rp �pools r3 rO z_AgentBase.__init__ s! � � �<�%�g�u�5�D� ��
���
r: c �X � t t |� � rd|z dz }||fdv r|S d||fz 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.
� [� ]�)� httprS )rQ rR s %b:%d)r r )rN rE rH rI s r3 �_computeHostValuez _AgentBase._computeHostValue� s@ � �
� �d�+� ,��$�;��%�D� �D�>� =� =��K��4��,�&�&r: c �� � ������ t �t � st d��dt �� � d�� �t �� ���
t � ��j
d� sQ�j � ��j d� j �j �j �j � � � j j ||� }������ fd�} |j | � |S )zk
Issue a new request, given the endpoint and the path sent as part of
the request.
zmethod=z is z, but must be bytess hostc
� �� | j t j �����j j ��� � S )N)r- � parsedURI)r! r, �
_constructra r- )�protor �headersr� rk � requestPathrN s ������r3 � cbConnectedz4_AgentBase._requestWithEndpoint.<locals>.cbConnected� s> �� ��=�=��"�"�� �� � #�z�z� 4� 4� '�
� �
r: )r r� � TypeError�typer! r# � hasHeader�copy� addRawHeaderrh rE rH rI ra r; r$ )
rN r4 r3 r� rk rn r ro r� rp s
` ````` r3 �_requestWithEndpointz _AgentBase._requestWithEndpoint� s� �� � �&�%�(��g�f�Z�t�D��L�>�AT� U�V� V�#�F�+�� �?� �i�G�� � ��)� �l�l�n�G� � � ���&�&� �$�$�i�n�n�i�n�n��
�
�J�J� $� $�S�(� 3��
�
�
�
�
�k�"��r: N)r= r> r? r@ rO rh rv rA r: r3 r^ r^ u s � ��� '�'r: r^ c � � e Zd ZdZd� Zd� Zy)�_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 �< � || _ || _ || _ || _ y)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)r, r� �_connectTimeout� _bindAddress)rN rp rw �connectTimeout� bindAddresss r3 rO z!_StandardEndpointFactory.__init__� s# � �" ��
� -�� � -�� � '��r: c � � i }| j �| j |d< | j |d< t |j � }t | j ||j fi |��}|j dk( r|S |j dk( r<| j j |j |j � }t ||� S t d|j ��� �# t $ r t dj
|�� � �w xY w)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}
�timeoutr} zdThe host of the provided URI ({uri.host!r}) contains non-ASCII octets, it should be ASCII decodable.�r[ rg rQ zUnsupported scheme: )rz r{ r rH �UnicodeDecodeErrorrY r r r, rI rE r� r� r r� )rN r[ ry rH r3 �connectionCreators r3 �endpointForURIz'_StandardEndpointFactory.endpointForURI� s� � � �� � � � +� $� 4� 4�F�9� � $� 1� 1��}� � � ����)�D� $�D�M�M�4����L�V�L�� �:�:�� ��O�
�Z�Z�8�
#� $� 4� 4� E� E����#�(�(�!� � !�!2�H�=� =�$�';�C�J�J�>�%J�K� K��% "� � �!� �&�S�&�/� �
� �s �C �%C>N)r= r> r? r@ rO r� rA r: r3 rx rx � s � � �(�,#Lr: rx c �P � e Zd ZdZ e� dddfd�Zedd�� Zd� Zd� Z d d�Z
y)
�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 �� � t j |� s3t j t |� dz dt
�� t
|� }t ||||� }| j |||� y)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) r( �
providedBy�warnings�warnr@ �DeprecationWarningr� rx �_init)rN rp rw r| r} rb �endpointFactorys r3 rO zAgent.__init__ sk � �D �)�)�.�9� �M�M��^�$�6�6� �+�
� @�� O�N�2� �^�^�[�
��
�
�
�7�O�T�2r: c �N � | j | � }|j |||� |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� )rZ rp r� rb �agents r3 �usingEndpointFactoryzAgent.usingEndpointFactoryD s' � �, � � �C� ��
� � �G�_�d�3�� r: c �@ � t j | ||� || _ y)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)r^ rO �_endpointFactory)rN rp r� rb s r3 r� z Agent._init^ s � �( ���D�'�4�0� /�� r: c �8 � | j 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� )rN r[ s r3 � _getEndpointzAgent._getEndpointu s � � �$�$�3�3�C�8�8r: c �b � t |j � � }t j |� } | j |� }|j |j |j f}| j |||||||j � S # t
$ r t
j t � � cY S w xY w)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}
)r" rG rC r] r� r� r �failr rE rH rI rv rc )rN r� r[ rn r rk r3 r4 s r3 r! z
Agent.request� s� � � �c�i�i�k�*���M�M�#�&� � )��(�(��3�H� � � �� � �� � �@���(�(� � � � � � � � � �
�
�� "� )��:�:�g�i�(� (� )�s �B �&B.�-B.rd �NN) r= r> r? r@ r� rO re r� r� r� r! rA r: r3 r� r� sA � �
� 1�2���
�
/3�b �� ��20�. 9�
r: r� c � � e Zd ZdZdd�Zdd�Zy)�
ProxyAgentz�
An HTTP agent able to cross HTTP proxies.
@ivar _proxyEndpoint: The endpoint used to connect to the proxy.
@since: 11.1
Nc �P � |�ddl m} t j | ||� || _ y )Nr ro )rr rp r^ rO �_proxyEndpoint)rN r3 rp rb s r3 rO zProxyAgent.__init__� s$ � � �?� 0����D�'�4�0� &��r: c � � t |j � � }d| j f}| j || j |t j |� |||� S )z?
Issue a new request via the configured proxy.
z
http-proxy)r" rG r� rv rC r] )rN r� r[ rn r r4 s r3 r! zProxyAgent.request� s_ � � �c�i�i�k�*�� �T� 0� 0�1��
�(�(� � � � � � �M�M�#� � � � �
�
r: r� )r= r> r? r@ rO r! rA r: r3 r� r� � s � ��'�
r: r� c �n � e Zd ZU dZded< ded< ded< ded< dd�Zd � Zd
� Zd � Zdd
�Z d� Z
d� Z d� Z y )�_FakeStdlibRequestau
A fake L{urllib.request.Request} object for L{cookiejar} to work with.
@see: U{urllib.request.Request
<https://docs.python.org/3/library/urllib.request.html#urllib.request.Request>}
@ivar uri: Request URI.
@ivar headers: Request headers.
@ivar type: The scheme of the URI.
@ivar host: The host[:port] of the URI.
@since: 11.1
r
r[ rr rH r# �_twistedHeadersc � � t |� | _ t � | _ t j |� }t |j � | _ t |j � | _ |j |j fdvr+| xj dt |j � z z
c_ t |j � | _ d| _ y)zK
Create a fake request.
@param uri: Request URI.
rf �:FN)
r r[ r# r� rC r] rE rr rH rI r
�origin_req_host� unverifiable)rN r[ �_uris r3 rO z_FakeStdlibRequest.__init__� s� � � ��$��� &�y�� ��}�}�S�!�� ����-�� � ����+�� � �K�K���� #�+K� K� �I�I��s�4�9�9�~�-� -�I� +�D�I�I� 6�� � !��r: c �J � | j j t |� � S rd )r� rs r )rN �headers r3 �
has_headerz _FakeStdlibRequest.has_header� s � ��#�#�-�-�m�F�.C�D�Dr: c �` � | j j t |� t |� � y rd )r� ru r )rN �namer# s r3 �add_unredirected_headerz*_FakeStdlibRequest.add_unredirected_header� s" � � � � �)�)�-��*=�}�U�?S�Tr: c � � | j S rd r� r_ s r3 � get_full_urlz _FakeStdlibRequest.get_full_url� s � ��x�x�r: Nc � � | j j t |� |� }|� |D �cg c]
}t |� �� }}|d S y c c}w )Nr )r� �
getRawHeadersr r )rN r� �defaultrn �xs r3 �
get_headerz _FakeStdlibRequest.get_header� sN � ��&�&�4�4�]�4�5H�'�R�� � �07�8�1�|�A��8�G�8��1�:� ��� 9s �Ac � � | j S rd )rH r_ s r3 �get_hostz_FakeStdlibRequest.get_host � � ��y�y�r: c � � | j S rd )rr r_ s r3 �get_typez_FakeStdlibRequest.get_type r� r: c � � yr` rA r_ s r3 �is_unverifiablez"_FakeStdlibRequest.is_unverifiable s � �r: )r[ r� r �Nonerd )
r= r> r? r@ �__annotations__rO r� r� r� r� r� r� r� rA r: r3 r� r� � sH � ��"
�H�
�I�
�I� � �"�(E�U�����r: r� c � � e Zd ZU ded< dd�Zy)�_FakeUrllibResponseInfor) �responsec � � | j j j t |� |� }|D �cg c]
}t |� �� }}|S c c}w rd )r� rn r� r r )rN r� r� rn r� �hs r3 �get_allz _FakeUrllibResponseInfo.get_all sD � ��-�-�'�'�5�5�m�D�6I�7�S��&-� .��\�!�_� .�� .����
/s �A
N)r� r
r� r� r z list[str])r= r> r? r� r� rA r: r3 r� r� s
� ���r: r� c �, � e Zd ZU dZded< dd�Zdd�Zy) �_FakeStdlibResponsez�
A fake L{urllib.response.Response} object for L{http.cookiejar} to work
with.
@ivar response: Underlying Twisted Web response.
@since: 11.1
r) r� c � � || _ y rd )r� �rN r� s r3 rO z _FakeStdlibResponse.__init__" s � � ��
r: c �0 � t | j � }|S rd )r� r� )rN r9 s r3 �infoz_FakeStdlibResponse.info% s � �(�� � �7���
r: N)r� r) r r� )r � _InfoType)r= r> r? r@ r� rO r� rA r: r3 r� r� s � �� ��!�r: r� c �b � e Zd ZU dZded< ded< d
d�Z d d d�Z d
d �Zy)� CookieAgenta
L{CookieAgent} extends the basic L{Agent} to add RFC-compliant handling of
HTTP cookies. Cookies are written to and extracted from a L{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.
@ivar _agent: Underlying Twisted Web agent to issue requests through.
@ivar cookieJar: Initialized cookie jar to read cookies from and store
cookies to.
@since: 11.1
r% �_agentr � cookieJarc � � || _ || _ y rd )r� r� )rN r� r� s r3 rO zCookieAgent.__init__? s � ��� �"��r: Nc �z � |�|n t � }t |� }|j d� sZ| j j |� |j dd� }|�+|j
� }|j dt |� � | j j ||||� 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}
Ns cookie�Cookie)
r# r� rs r� �add_cookie_headerr� rt ru r r� r! r$ �_extractCookies)rN r� r[ rn r �
actualHeaders� lastRequest� cookieHeaders r3 r! zCookieAgent.requestC s� � �& $+�#6��G�I�
�(��-� � �&�&�y�1� �N�N� ,� ,�[� 9�&�1�1�(�D�A�L��'� -� 2� 2� 4�
� �*�*�9�m�L�6Q�R��{�{�"�"� �C� � �
�
�+�d�*�*�K�
8� 9r: c �P � | j j t |� |� |S )a
Extract response cookies and store them in the cookie jar.
@param response: the Twisted Web response that we are processing.
@param request: A L{_FakeStdlibRequest} wrapping our Twisted request,
for L{CookieJar} to extract cookies from.
)r� �extract_cookiesr� )rN r� r! s r3 r� zCookieAgent._extractCookiese s# � �
���&�&�':�8�'D�g�N��r: )r� r% r� r r r� r� )
r� r� r[ r� rn zOptional[Headers]r zOptional[IBodyProducer]r zDeferred[IResponse])r� r) r! r� r r) )r= r> r? r@ r� rO r! r� rA r: r3 r� r� * st � ��
�N���#� &*�04� 9�� 9� � 9� #� 9�
.� 9�
�
9�D �!� �,>� � � r: r� c � � e Zd ZdZd� Zd� Zy)� GzipDecoderz�
A wrapper for a L{Response} instance which handles gzip'ed body.
@ivar original: The original L{Response} object.
@since: 11.1
c �( � || _ t | _ y rd )�originalr$ r� r� s r3 rO zGzipDecoder.__init__} s � � ��
�$�� r: c �b � | j j t || j � � y)zf
Override C{deliverBody} to wrap the given C{protocol} with
L{_GzipProtocol}.
N)r� � deliverBody�
_GzipProtocol)rN r s r3 r� zGzipDecoder.deliverBody� s! � �
�
�
�!�!�-��$�-�-�"H�Ir: N)r= r> r? r@ rO r� rA r: r3 r� r� t s � ��%�Jr: r� c �" � e Zd ZdZd� Zd� Zd� Zy)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 �v � || _ || _ t j dt j z � | _ y )N� )r� � _response�zlib�
decompressobj� MAX_WBITS�_zlibDecompress)rN r r� s r3 rO z_GzipProtocol.__init__� s, � � ��
�!��� #� 1� 1�"�t�~�~�2E� F�� r: c �� � | j j |� }|r | j j |� yy# t j $ r t t � g| j � �w xY w)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)rN �data�rawDatas r3 r� z_GzipProtocol.dataReceived� sc � �
>��*�*�5�5�d�;�G� � �M�M� &� &�w� /� �� �z�z� >� �'�)��d�n�n�=� =� >�s �< �3A/c � � | j j � }|r| j j |� | j j |� y# t j $ r! t |t � g| j � �w xY w)zr
Forward the connection lost event, flushing remaining data from the
decompressor if any.
N)
r� �flushr� r r� r r� r� r� �connectionLost)rN r� r� s r3 r� z _GzipProtocol.connectionLost� st � �
F��*�*�0�0�2�G� � �M�M� &� &�w� /� �
�
�$�$�V�,�� �z�z� F� �&�'�)�!4�d�n�n�E� E� F�s �A �4B N�r= r> r? r@ rO r� r� rA r: r3 r� r� � s � �
�G�
0� -r: r� c �$ � e Zd ZdZd� Zdd�Zd� Zy)�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 the I{Content-Encoding} header indicates a supported encoding.
For example::
agent = ContentDecoderAgent(Agent(reactor),
[(b'gzip', GzipDecoder)])
@param agent: The agent to wrap
@type agent: L{IAgent}
@param decoders: A sequence of (name, decoder) objects. The name
declares which encoding the decoder supports. The decoder must accept
an L{IResponse} and return an L{IResponse} when called. The order
determines how the decoders are advertised to the server. Names must
be unique.not be duplicated.
@type decoders: sequence of (L{bytes}, L{callable}) tuples
@since: 11.1
@see: L{GzipDecoder}
c � � || _ t |� | _ dj |D �cg c] }|d �� c}� | _ y c c}w )N� ,r )r� �dict� _decoders�join�
_supported)rN r� �decoders�decoders r3 rO z ContentDecoderAgent.__init__� s6 � ��� � �h� ��� �)�)�x�$H�G�W�Q�Z�$H�I����$Hs � A Nc �� � |� t � }n|j � }|j d| j � | j j ||||� }|j
| j � S )zv
Send a client request which declares supporting compressed content.
@see: L{Agent.request}.
s accept-encoding)r# rt ru r� r� r! r$ �_handleResponse�rN r� r[ rn r �deferreds r3 r! zContentDecoderAgent.request� sa � � �?� �i�G� �l�l�n�G�� � � /�� � �A��;�;�&�&�v�s�G�\�J���#�#�D�$8�$8�9�9r: c �� � |j j dg � }dj |� j d� }|rY|j � j � }| j j |� }|� ||� }n|j |� n|r�Y|r.|j j ddj |� g� |S |j j d� |S )zX
Check if the response is encoded, and wrap it to handle decompression.
s content-encodingr� ) rn r� r� �splitr� rG r� r5 rN �
setRawHeaders� removeHeader)rN r� �contentEncodingHeadersr� r� s r3 r� z#ContentDecoderAgent._handleResponse� s� � � "*�!1�!1�!?�!?�@S�UW�!X� �!%���+A�!B�!H�!H��!N� �$�)�-�-�/�5�5�7�D��n�n�(�(��.�G��"�"�8�,�� '�-�-�d�3�� %� "� � � � *� *�#�d�i�i�0F�&G�%H�
�
��
� � � )� )�*=� >��r: r� )r= r> r? r@ rO r! r� rA r: r3 r� r� � s � ��6J�
:� r: r� )s
Authorizations Cookies Cookie2s Proxy-Authorizations WWW-Authenticatec � � e Zd ZdZej
ej ej ej gZ ej gZ d d d�Z d
d�Z
d� Zd� Zd� Zy) �
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
c � � || _ || _ |D �ch c]
}t |� �� }}|j t � || _ y c c}w rd )r� �_redirectLimit�_canonicalHeaderName�update�_defaultSensitiveHeaders�_sensitiveHeaderNames)rN r� �
redirectLimit�sensitiveHeaderNames�each� sensitives r3 rO zRedirectAgent.__init__- sI � � �� � +���<P�Q�D�)�$�/�Q� �Q����1�2�%.��"�� Rs �ANc �| � | j j ||||� }|j | j |||d� S )zb
Send a client request following HTTP redirects.
@see: L{Agent.request}.
r )r� r! r$ r� r� s r3 r! zRedirectAgent.request9 s> � � �;�;�&�&�v�s�G�\�J���#�#�D�$8�$8�&�#�w�PQ�R�Rr: c � � 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}.
)rm )rN �
requestURI�locations r3 �_resolveLocationz RedirectAgent._resolveLocationB s � � �
�H�-�-r: c � �� || j k\ r8t j �j d|�� }t t |� g�� ��j j dg � }|s7t j �j d|� }t t |� g�� �| j ||d � }|r�t j |� } t j |� }
| j |
j k( xr4 | j |
j k( xr | j |
j k( } | s;t |j! � D � �
ci c] \ } }
| | j" vr| |
�� c}
} � }| j$ j' |||� }�fd�}|j) |� |j) | j* ||||dz � S c c}
} w )z�
Handle a redirect response, checking the number of redirects already
followed, and extracting the location header fields.
s Infinite redirection detected�r s locations No location header fieldr c �* �� | j �� | S rd )�setPreviousResponse)� newResponser� s �r3 �_chainResponsez5RedirectAgent._handleRedirect.<locals>._chainResponset s �� � � +� +�H� 5� � r: rU )r r �InfiniteRedirection�coder� r rn r� �RedirectWithNoLocationr rC r] rE rH rI r# �getAllRawHeadersr
r� r! r$ r� )rN r� r� r[ rn �
redirectCount�err�locationHeadersr rk �parsedLocation�
sameOrigin�rawName�rawValuer� r s ` r3 �_handleRedirectz RedirectAgent._handleRedirectQ s� �� �
�D� /� /� /��+�+��
�
� ?�#��C� !�'�#�,� ��:� :�"�*�*�8�8��b�I�� ��.�.��
�
� :�C��C� !�'�#�,� ��:� :��(�(��o�a�.@�A�� ��
�
�c�*�I� �]�]�8� 4�N��!�!�^�%:�%:�:� <� �^�^�~�':�':�:�<� �^�^�~�':�':�:�
�
�!� 29�1I�1I�1K�� -�G�X�"�$�*D�*D�D� ��)���� �;�;�&�&�v�x��A�� � � � �^�,��#�#� � � �&�#�w�
��8I�
�
��s �G
c �0 � |j | j v rP|dvr7t j |j |�� }t t |� g|� �| j
|||||� S |j | j v r| j
|d|||� S |S )zY
Handle the response, making another request if it indicates a redirect.
)r r r r )r �_redirectResponsesr � PageRedirectr� r r% �_seeOtherResponses)rN r� r� r[ rn r r s r3 r� z RedirectAgent._handleResponse} s� � � �=�=�D� 3� 3� 3�� .�.��(�(�� � ��E��$�g�c�l�^�X�>�>��'�'��&�#�w�
�V� V�
�]�]�d� 5� 5�
5��'�'��&�#�w�
�V� V��r: )r� rA )r� r% r rX r zIterable[bytes]r� )r= r> r? r@ r �MOVED_PERMANENTLY�FOUND�TEMPORARY_REDIRECT�PERMANENT_REDIRECTr' � SEE_OTHERr) rO r! r r% r� rA r: r3 r r s� � ��6
� � � �
�
� � � � � � � �� �.�.�)��
�02�
/��
/� �
/� .�
/�S�
.� *
�X r: r c � � e Zd ZdZej
gZej ej ej ej gZ y)�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) r= r> r? r@ r r, r' r* r+ r. r- r) rA r: r3 r0 r0 � s@ � � � �1�1�2�� � � � �
�
� ��� � � � �r: r0 c �" � e Zd ZdZd� Zd� Zd� Zy)�_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 �< � || _ || _ || _ g | _ y)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� �status�message�
dataBuffer)rN r4 r5 r� s r3 rO z_ReadBodyProtocol.__init__� s � � !��
� �� � �� � ��r: c �: � | j j |� y)z?
Accumulate some more bytes from the response.
N)r6 rN )rN r� s r3 r� z _ReadBodyProtocol.dataReceived� s � �
��� � �t�$r: c � � |j t � r5| j j dj | j
� � y|j t � rT| j j t | j | j dj | j
� � � y| j j |� y)z�
Deliver the accumulated response bytes to the waiting L{Deferred}, if
the response body has been completely received without error.
r: N) r� r� r� �callbackr� r6 r} �errbackr< r4 r5 )rN r� s r3 r� z _ReadBodyProtocol.connectionLost� s� � �
�<�<� � %� �M�M� "� "�3�8�8�D�O�O�#<� =�
�\�\�+�
,� �M�M� !� !�$��K�K�� � �s�x�x����/H��
�
�M�M� !� !�&� )r: Nr� rA r: r3 r2 r2 � s � � � � %� *r: r2 c � ��� d�fd� }t j |� }t | j | j |� ��fd��| j �� �j �# �� � t j dt d�� |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 �( �� �� }|� |� yy)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}.
NrA )r� rW �getAborts �r3 r6 zreadBody.<locals>.cancel� s �� � �
�� � � �G� r: c �2 �� t � j dd � S )N�abortConnection)�getattrrC )r s �r3 r= zreadBody.<locals>.getAbort� s �� ��x�)�)�+<�d�C�Cr: zLUsing readBody with a transport that does not have an abortConnection methodr) )r� r� )r� �defer.Deferred[bytes]r r� )
r r r2 r �phraser� rC r� r� r� )r� r6 r� r= r s @@r3 �readBodyrC � su �� � � %�~�~�f� 5�A� �� � �����C�H�D�
����"����%�(�*�*<��
�
�
%�'��
�
�Hr: )r� r� r0 r� r� r� r( r< r� rC r r~ r� r� r� r� r� rC rd )r� r) r rA )�r@ �
__future__r r� r� r� r� � dataclassesr � functoolsr �http.cookiejarr �typingr r r � urllib.parser
r r r5 �zope.interfacer
� incrementalr rr r r r �twisted.internet.abstractr �twisted.internet.deferr �twisted.internet.endpointsr r �twisted.internet.interfacesr r �twisted.loggerr �twisted.python.compatr r �twisted.python.componentsr �twisted.python.deprecater r �twisted.python.failurer � twisted.webr r �twisted.web._newclientr! r" �twisted.web.http_headersr# �twisted.web.iwebr$ r% r& r' r( r) �
email.messager* r� � http.clientr+ �
_ResponseBase�urllib.requestr, � _RequestBase�object�Errorr< rC rm r{ r| r} r~ r r� r� r� r� r� r� �twisted.web.errorr� �OpenSSLr� �twisted.internet.sslr� r� r� � ImportErrorr� r� r� r� r> r= r� r� r� r� �Factoryr r r( r^ rx r� r� r� r� r� r� r� r� r� �_canonicalNameCapsr � frozensetr r r0 �Protocolr2 rC �__all__rA r: r3 �<module>ri s� ��
� #� � � � � !� � $� 4� 4� F� F� &� � 2� 2� 3� +� F� I� !� =� 7�� +� #� F� ,�� � �7�9�6��L��M��I�$�
�5�;�;� �o� o�d6�8�D � � � � 1� ��� � �>#H� #H�L
�_� �X� X� �X�: � �I�r�1�a� � � �� �2�q�!�$�-�� �e�D�k�!� �
�&�&��$�$� �
�_� �=� =� �=�@
�
#�$� � � %� �:
�_� �$3� $3� �$3�N
�]��l � l � �l �^=�8�+�+� =�4=� =�@YJ� YJ�xB� B�J
�
"�#�GL� GL� $�GL�T
�V��T
�J� T
� �T
�n
�V��$
�� $
� �$
�ND� � D�N ��i� � ���-� �(
�V��F� F� �F�RJ�#�I�.� J�*)-�%�i�0� )-�X
�V��D� D� �D�N �y�3�3� �$�� � �
�V��~� ~� �~�B�}� �.3*��)�)� 3*�l)
�X ���k/ � �
�C��s � L0 �0L;�:L; |