a j[@sddlmZddlZddlZddlZddlZddlmZddl m Z m Z m Z m Z mZddlmZddlmZmZddlmZmZmZdd lmZdd lmZdd lmZmZmZdd l m!Z!m"Z"dd l#m$Z$m%Z%ddl&m'Z'ddl m(Z(m)Z)m*Z*ddl+m,Z,m-Z-m.Z.m/Z/m0Z0ddl1m2Z2ddl3m4Z4gdZ5Gddde2Z6dddddddde!ddddddddddddddd d!d"d#d$d!d%d!d&d d!d'd'd'd'd(d)d*d+d,dd-d.d/Z7dQd!d!d,dd0d1d2Z8zVdd3l9m:Z:dd4l;m,Z<e:j=e:j=e:j>e:j>d5Z?dd6dd6d5Z@d7d8d9d,d:d;dd=ZAYn0dRd7d8d!d?d@dAdBZCd:d9dCdDdEdFZDddddGd7d8d9d!d d!d,d:dHdIdJZEe dKZFe dLe dMeFfdNZGGdOdPdPZHdS)S) annotationsN)Sequence)AnyCallableLiteralTypeVarcast)ClientProtocol)Headers HeadersLike)InvalidProxyMessageInvalidProxyStatus ProxyError)ClientExtensionFactory) enable_client_permessage_deflate)build_authorization_basic build_hostvalidate_subprotocols) USER_AGENTResponse) CONNECTINGEvent) StreamReader) LoggerLikeOrigin Subprotocol)Proxy WebSocketURI get_proxy parse_proxy parse_uri) Connection)Deadline)connect unix_connectClientConnectionc seZdZdZddddddddddd d d fd d Zdedfdddd dddZdd dfdd Zd dfdd ZZ S)r'a1 :mod:`threading` implementation of a WebSocket client connection. :class:`ClientConnection` provides :meth:`recv` and :meth:`send` methods for receiving and sending messages. It supports iteration to receive messages:: for message in websocket: process(message) The iterator exits normally when the connection is closed with close code 1000 (OK) or 1001 (going away) or without a close code. It raises a :exc:`~websockets.exceptions.ConnectionClosedError` when the connection is closed with any other code. The ``ping_interval``, ``ping_timeout``, ``close_timeout``, and ``max_queue`` arguments have the same meaning as in :func:`connect`. Args: socket: Socket connected to a WebSocket server. protocol: Sans-I/O connection.   ping_interval ping_timeout close_timeout max_queue socket.socketr float | None*int | None | tuple[int | None, int | None]None)socketprotocolr,r-r.r/returncs*|t|_tj||||||ddS)Nr+) threadingr response_rcvdsuper__init__)selfr4r5r,r-r.r/ __class__r>r? handshakeKs  ,  zClientConnection.handshaker)eventr6cs:|jdur*t|tsJ||_|jn t|dS)z. Process one incoming event. N)response isinstancerr8setr9 process_event)r;rNr<r>r?rRgs   zClientConnection.process_event)r6cs*ztW|jn |j0dS)zI Read incoming data from the socket and process events. N)r9 recv_eventsr8rQ)r;r<r>r?rSus zClientConnection.recv_events) __name__ __module__ __qualname____doc__r:rrMrRrS __classcell__r>r>r<r?r's"r'deflateTr)r(ir*)socksslserver_hostnameorigin extensions subprotocols compressionrBrCproxy proxy_sslproxy_server_hostname open_timeoutr,r-r.max_sizer/loggercreate_connectionstrzsocket.socket | Nonezssl_module.SSLContext | NonerAz Origin | Nonez'Sequence[ClientExtensionFactory] | NonezSequence[Subprotocol] | Noner@zstr | Literal[True] | Noner1z int | Noner2zLoggerLike | Noneztype[ClientConnection] | Noner)urirZr[r\r]r^r_r`rBrCrarbrcrdr,r-r.rer/rfrgkwargsr6cKsL|dur&d|vr&|d}tdtt|}|jsD|durDtd|dd}|dd}|r|durz|durztdn|dur|durtd |durt||d krt|}n|durtd ||rd} |durd} | d urt |} t | }|durt }z|dur|rPt t j t j}|||dusDJ||n| durt| }|jdd dkrt||||ddd}nX|jdddkr|jdkr| durtdt|||f| | | d|}ntdn*|d|t j|j|jffi|}|d|s6|t jt jd |jr|durPt}|dur`|j}||| dur|j ||d}nt!|||d}t"t j |}|dt#||||||d}|||||||d}Wn(t$y|dur|%Yn0z|&|| |Wn(t$y>|'|j()Yn0|*|S)a Connect to the WebSocket server at ``uri``. This function returns a :class:`ClientConnection` instance, which you can use to send and receive messages. :func:`connect` may be used as a context manager:: from websockets.sync.client import connect with connect(...) as websocket: ... The connection is closed automatically when exiting the context. Args: uri: URI of the WebSocket server. sock: Preexisting TCP socket. ``sock`` overrides the host and port from ``uri``. You may call :func:`socket.create_connection` to create a suitable TCP socket. ssl: Configuration for enabling TLS on the connection. server_hostname: Host name for the TLS handshake. ``server_hostname`` overrides the host name from ``uri``. origin: Value of the ``Origin`` header, for servers that require it. extensions: List of supported extensions, in order in which they should be negotiated and run. subprotocols: List of supported subprotocols, in order of decreasing preference. compression: The "permessage-deflate" extension is enabled by default. Set ``compression`` to :obj:`None` to disable it. See the :doc:`compression guide <../../topics/compression>` for details. additional_headers (HeadersLike | None): Arbitrary HTTP headers to add to the handshake request. user_agent_header: Value of the ``User-Agent`` request header. It defaults to ``"Python/x.y.z websockets/X.Y"``. Setting it to :obj:`None` removes the header. proxy: If a proxy is configured, it is used by default. Set ``proxy`` to :obj:`None` to disable the proxy or to the address of a proxy to override the system configuration. See the :doc:`proxy docs <../../topics/proxies>` for details. proxy_ssl: Configuration for enabling TLS on the proxy connection. proxy_server_hostname: Host name for the TLS handshake with the proxy. ``proxy_server_hostname`` overrides the host name from ``proxy``. open_timeout: Timeout for opening the connection in seconds. :obj:`None` disables the timeout. ping_interval: Interval between keepalive pings in seconds. :obj:`None` disables keepalive. ping_timeout: Timeout for keepalive pings in seconds. :obj:`None` disables timeouts. close_timeout: Timeout for closing the connection in seconds. :obj:`None` disables the timeout. max_size: Maximum size of incoming messages in bytes. :obj:`None` disables the limit. max_queue: High-water mark of the buffer where frames are received. It defaults to 16 frames. The low-water mark defaults to ``max_queue // 4``. You may pass a ``(high, low)`` tuple to set the high-water and low-water marks. If you want to disable flow control entirely, you may set it to ``None``, although that's a bad idea. logger: Logger for this client. It defaults to ``logging.getLogger("websockets.client")``. See the :doc:`logging guide <../../topics/logging>` for details. create_connection: Factory for the :class:`ClientConnection` managing the connection. Set it to a wrapper or a subclass to customize connection handling. Any other keyword arguments are passed to :func:`~socket.create_connection`. Raises: InvalidURI: If ``uri`` isn't a valid WebSocket URI. OSError: If the TCP connection fails. InvalidHandshake: If the opening handshake fails. TimeoutError: If the opening handshake times out. N ssl_contextzssl_context was renamed to sslz-ssl argument is incompatible with a ws:// URIunixFpathzmissing path argumentz(path and sock arguments are incompatiblerYzunsupported compression: Tsockssource_address)Z local_addrhttphttpsz8proxy_ssl argument is incompatible with an http:// proxyrCr[r\zunsupported proxyrDr\)r]r^r_rerfr+)+popwarningswarnDeprecationWarningr!secure ValueErrorrrrr$r'r4AF_UNIX SOCK_STREAM settimeoutrDr%r schemeconnect_socks_proxyconnect_http_proxyAssertionErrorrIrghostport setsockopt IPPROTO_TCP TCP_NODELAY ssl_modulecreate_default_context wrap_socket SSLSSLSocketrr ExceptioncloserMZ close_socketZrecv_events_threadjoinZstart_keepalive)rirZr[r\r]r^r_r`rBrCrarbrcrdr,r-r.rer/rfrgrjws_urirlrmdeadlineZ proxy_parsedZsock_2r5 connectionr>r>r?r%sn                      r%)rmrirjr6cKsD|dur.|ddur*|ddur*d}nd}tf|d|d|S)a Connect to a WebSocket server listening on a Unix socket. This function accepts the same keyword arguments as :func:`connect`. It's only available on Unix. It's mainly useful for debugging servers listening on Unix sockets. Args: path: File system path to the Unix socket. uri: URI of the WebSocket server. ``uri`` defaults to ``ws://localhost/`` or, when a ``ssl`` is provided, to ``wss://localhost/``. Nr[rkzws://localhost/zwss://localhost/T)rirlrm)getr%)rmrirjr>r>r?r&s r&) ProxyType)r)Zsocks5hZsocks5Zsocks4aZsocks4Frrr$r0)rarrrjr6c Kstt|j|j|j|j|jt|j}|d| z|j |j|jfi|WSt t t j fylYn.ty}ztd|WYd}~n d}~00dS)z0Connect via a SOCKS proxy and return the socket.rDz failed to connect to SOCKS proxyN) SocksProxySOCKS_PROXY_TYPESrrrusernamepasswordSOCKS_PROXY_RDNSrIrDr%OSErrorrLr4rr)rarrrjZ socks_proxyexcr>r>r?rsrcKs tddS)Nz-python-socks is required to use a SOCKS proxy) ImportError)rarrrjr>r>r?rsbytes)rarrCr6cCst|j|j|jdd}t}t|j|j|j|d<|durB||d<|jdurl|jdusZJt|j|j|d<d|d| S)NT)Zalways_include_portHostrEzProxy-AuthorizationzCONNECT z HTTP/1.1 ) rrrrzr rrrencode serialize)rarrCrrGr>r>r?prepare_connect_requests rr)rZrr6c Cs@t}tj|j|j|jdd}zz>|||d}|rL| |n| t |q$Wnt y}z`t |jtsJ|j}d|jkrdkrnn|WYd}~W|dSt|WYd}~nRd}~0tjytdYn0ty }ztd|WYd}~n d}~00W|dn |d0dS)NF)Z include_bodyii,z(timed out while connecting to HTTP proxyz0did not receive a valid HTTP response from proxy)rrparseZ read_lineZ read_exactZ read_to_eofr~rDrecvZ feed_dataZfeed_eofnext StopIterationrPvalue status_coderr4rLrr )rZrreaderparserdatarrOr>r>r?read_connect_responses>    rrt)rarrrCr[r\rjr6cKs|d|tj|j|jffi|}|jdkrx|durDt}|durR|j}| ||j ||d}| d| t |||zt ||Wnty|Yn0|S)NrDrsru)rIrDr4rgrrrrrr~rsendallrrrr)rarrrCr[r\rjrZr>r>r?rs"    rTF.)boundc@s|eZdZdZdZddddddd d Zd d d dddZdddddZdddddZdddddZ dd dddZ dS) rzr Socket-like object providing TLS-in-TLS. Only methods that are used by websockets are implemented. iNr0zssl_module.SSLContextrAr3)rZrkr\r6cCsBt|_t|_||_|j|j|j|d|_||jjdS)Nru) r MemoryBIOincomingoutgoing ssl_socketwrap_bio ssl_objectrun_io do_handshake)r;rZrkr\r>r>r?r:Es  zSSLSSLSocket.__init__zCallable[..., T]rr)funcargsr6cGsd}d}z ||}Wn.tjy,d}YntjyBd}Yn0|j}|r^|j||r|j|j}|r|j |q|j q|rq|S)NFT) rSSLWantReadErrorSSLWantWriteErrorrreadrrr recv_bufsizerwrite write_eof)r;rrZ want_readZ want_writeresultrr>r>r?rUs(     zSSLSSLSocket.run_iointr)buflenr6cCs.z||jj|WStjy(YdS0dS)N)rrrr SSLEOFError)r;rr>r>r?rsszSSLSSLSocket.recv)rr6cCs||jj|SN)rrr)r;rr>r>r?sendyszSSLSSLSocket.sendc Csd}t|b}|d8}t|}||krB||||d7}q"Wdn1sV0YWdn1st0YdS)NrB) memoryviewrlenr)r;rcountview byte_viewamountr>r>r?r|s zSSLSSLSocket.sendallrh)namer6cCs t|j|Sr)getattrr)r;rr>r>r? __getattr__szSSLSSLSocket.__getattr__)N) rTrUrVrWrr:rrrrrr>r>r>r?r;s r)NN)N)I __future__rr4r[rr7rwcollections.abcrtypingrrrrrclientr Zdatastructuresr r exceptionsr rrZextensions.baserZextensions.permessage_deflaterrGrrrZhttp11rrr5rrstreamsrrrrrirrrr r!rr#utilsr$__all__r'r%r&Z python_socksrZpython_socks.syncrZSOCKS5ZSOCKS4rrrrrrrrrrr>r>r>r?s        i>    ' &