U c6{iv@@sPdZddlmZddlZddlmZmZddlmZddlm Z m Z m Z m Z ddl mZddlmZdd lmZmZmZdd lmZdd lmZmZmZmZmZmZmZmZm Z!m"Z"dd l#m$Z$dd l%m&Z&ddl'm(Z(ddl)m*Z*m+Z+m,Z,m-Z-m.Z.ddl/m0Z1ddl2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9m:Z:m;Z;mZ>ddl?m@Z@mAZAddlBmCZCddlDmEZEm Z GdddejFZGeGdddeHZIGdddejFZJe dd eJd!ZKe e eefe.gdfZLe3ZMGd"d#d#ejFeKZNGd$d%d%ejFeKZOed d&Gd'd(d(ZPed)d*d+d,d-d.ZQee+eGd/d0d0e eKZReReJZSeQjTd1d*d+d,d2d3ZUeQjTd4d*d+d,d5d6ZVeQjTd7d*d+d,d8d9ZWeQjTd:d*d+d,d;d<ZXeQjTd=d*d+d,d>d?ZYeQjTd@d*d+d,dAdBZZeQjTdCd*d+d,dDdEZ[eQjTdFd*d+d,dGdHZ\dIdJdKdLdMZ]GdNdOdOeCZ^dPdQd+dRdSdTZ_dS)UzD Private implementation module for public L{twisted.web.websocket}. ) annotationsN) dataclassfield)singledispatch)CallableGenericTypeVarUnion) implementer)URL) ConnectionConnectionType WSConnection)ConnectionState) AcceptConnection BytesMessageCloseConnectionEventPingPongRejectConnection RejectDataRequest TextMessage) H11Handshake)RemoteProtocolError)Deferred) IConsumer IProtocol IPushProducer IReactorTCP ITransport)Factory)Logger)Failure) BAD_REQUEST)URIBrowserLikePolicyForHTTPSResponse_StandardEndpointFactory)Headers)IAgentEndpointFactoryIPolicyForHTTPS)Resource) NOT_DONE_YETrc@sreZdZdZdddddZdddd d Zdd dd ddZddddddZdddddZddddZ dS)WebSocketTransportz9 The transport that can send websocket messages. strNonetextreturncCsdS)z& Send a text message. N)selfr3r5r5?/tmp/pip-unpacked-wheel-hfbvu0bz/twisted/web/_websocket_impl.pysendTextMessageAsz"WebSocketTransport.sendTextMessagebytesdatar4cCsdS)z' Send a bytes message. Nr5r6r;r5r5r7sendBytesMessageFsz#WebSocketTransport.sendBytesMessageint)coder4cCsdS)z0 Drop the websocket connection. Nr5)r6r@r5r5r7loseConnectionKsz!WebSocketTransport.loseConnectionpayloadr4cCsdS)a Send a websocket Ping request to measure latency. @note: Per U{Mozilla's documentation }, multiple 'ping' requests may be coalesced into a single 'pong', and unsolicited 'pong' requests must be ignored, so we do not return a L{deferred } here; pongs are delivered separately. Nr5r6rDr5r5r7pingPszWebSocketTransport.pingrproducerr4cCsdS)zF Attach the given L{IPushProducer} to this transport. Nr5r6rHr5r5r7attachProducer\sz!WebSocketTransport.attachProducerr4cCsdS)zT Detach a previously attached L{IPushProducer} from this transport. Nr5r6r5r5r7detachProducerasz!WebSocketTransport.detachProducerN)r>)rB) __name__ __module__ __qualname____doc__r8r=rArFrJrMr5r5r5r7r/<s r/c@seZdZUdZded<dS)ConnectionRejectedz A websocket connection was rejected by an HTTP response. @ivar response: The HTTP response that describes the rejection. r(responseN)rNrOrPrQ__annotations__r5r5r5r7rRgs rRc@sneZdZdZdddddZdddd Zd dd d d ZdddddZd ddddZdddddZ dS)WebSocketProtocolac An object that conforms to L{WebSocketProtocol} can receive all the events from a websocket connection. @note: While this is I{sort of} like a L{byte-stream protocol }, the interface is distinct in a few ways; in particular, we have discrete C{negotiationStarted} and C{negotiationFinished} methods, representing those events in the websocket handshaking process, and no C{connectionMade}; similarly, since websockets can natively support both text and bytes messages, rather than fragmentable segments of a byte stream, we have C{textMessageReceived} and C{bytesMessageReceived} but no C{dataReceived}. Finally, this is a L{typing.Protocol} and not a L{zope.interface.Interface}, since it does not predate the L{typing} module. r/r1 transportr4cCsdS)z An underlying transport (e.g.: a TCP connection) has been established; negotiation of the websocket transport has begun. Nr5r6rWr5r5r7negotiationStartedsz$WebSocketProtocol.negotiationStartedrKcCsdS)zn Negotiation is complete: a bidirectional websocket channel is now fully established. Nr5rLr5r5r7negotiationFinishedsz%WebSocketProtocol.negotiationFinishedr9rCcCsdS)a A Pong message was received. @note: Per U{the standard }:: A Pong frame sent in response to a Ping frame must have identical "Application data" as found in the message body of the Ping frame being replied to. If an endpoint receives a Ping frame and has not yet sent Pong frame(s) in response to previous Ping frame(s), the endpoint MAY elect to send a Pong frame for only the most recently processed Ping frame. Given that some Pong frames may be dropped, this event should only be used in concert with the transport's L{.ping } method for its intended purpose, to measure latency and connection durability, not to transport application data. Nr5rEr5r5r7 pongReceivedszWebSocketProtocol.pongReceivedr0)messager4cCsdS)z< A text message was received from the peer. Nr5)r6r\r5r5r7textMessageReceivedsz%WebSocketProtocol.textMessageReceivedr:cCsdS)z= A bytes message was received from the peer. Nr5r<r5r5r7bytesMessageReceivedsz&WebSocketProtocol.bytesMessageReceivedr$reasonr4cCsdS)z4 The websocket connection was lost. Nr5r6r`r5r5r7connectionLostsz WebSocketProtocol.connectionLostN) rNrOrPrQrYrZr[r]r^rbr5r5r5r7rUrsrU_WSPT) covariantboundc@s eZdZdZdddddZdS)WebSocketServerFactoryz A L{WebSocketServerFactory} is a factory for a particular kind of L{WebSocketProtocol} that implements server-side websocket listeners via L{WebSocketResource}. rrcrequestr4cCsdS)a/ To conform to L{WebSocketServerFactory}, you must implement a C{buildProtocol} method which takes a L{Request } and returns a L{WebSocketProtocol}. @return: a L{WebSocketProtocol} that will handle the inbound connection. Nr5)r6rhr5r5r7 buildProtocolsz$WebSocketServerFactory.buildProtocolNrNrOrPrQrir5r5r5r7rfsrfc@s eZdZdZdddddZdS)WebSocketClientFactoryz A L{WebSocketClientFactory} is a factory for a particular kind of L{WebSocketProtocol} that implements client-side websocket listeners via L{WebSocketClientEndpoint}. r0rc)urlr4cCsdS)a# To conform to L{WebSocketServerFactory}, you must implement a C{buildProtocol} method which takes a string representing an URL and returns a L{WebSocketProtocol}. @return: a L{WebSocketProtocol} that will handle the outgoing connection. Nr5)r6rlr5r5r7risz$WebSocketClientFactory.buildProtocolNrjr5r5r5r7rksrk)frozenc @sXeZdZUdZded<ded<eeddfdddd d dd d d ZdddddZdS)WebSocketClientEndpointz A L{WebSocketClientEndpoint} describes an URL to connect to and a way of connecting to that URL, that can connect a L{WebSocketClientFactory} to that URL. r+endpointFactoryr0rlNr r,z int | Nonez bytes | None)reactorrl tlsPolicyconnectTimeout bindAddressr4cCst||||}t||S)a) Construct a L{WebSocketClientEndpoint} from a reactor and a URL. @param reactor: The reactor to use for the TCP connection. @param url: a string describing an URL where a websocket server lives. @param tlsPolicy: The TLS policy to use for HTTPS connections. @param connectTimeout: The number of seconds for the TCP-level connection timeout. @param bindAddress: The bind address to use for the TCP client connections. @return: the newly constructed endpoint. )r)rn)clsrprlrqrrrsror5r5r7newszWebSocketClientEndpoint.newzWebSocketClientFactory[_WSP]rc)protocolFactoryr4cs^jtjd}ddddfdd |tfdd Id H}|j Id HS) ae Make an outgoing connection to this L{WebSocketClientEndpoint}'s HTTPS connection. @param protocolFactory: The constructor for the protocol. @return: A coroutine (that yields L{Deferred}s) that completes with the connected L{WebSocketProtocol} once the websocket connection is established. zutf-8WSConnection | Connectionr!r1wsctr4cs<tj}t|jdddd}||t|j|dS)N)schemehostport) r ZfromTextrlr0replacewritesend WSRequestr})ryrzhtargetrLr5r7clientBootstrap s z8WebSocketClientEndpoint.connect..clientBootstrapcstttjjSN)_WebSocketWireProtocolrr ZCLIENTrirlr5rrvr6r5r7's z1WebSocketClientEndpoint.connect..N) roZendpointForURIr&Z fromBytesrlencodeconnectProtocolFactoryZ forProtocol_done)r6rvZendpoint connectedr5rr7rs  zWebSocketClientEndpoint.connect) rNrOrPrQrT classmethodr'rurr5r5r5r7rns rnrAnyWSWPr1)eventprotor4cCsdS)z, Handle a websocket protocol event. Nr5rrr5r5r7 _handleEvent1src@seZdZUded<ded<ded<eddZd ed <eddZd ed <d Zded<d ddddZddddZ dddddZ dddddZ ddd d!d"Z dddd#d$Z d9ddd&d'd(Zd:d+ddd,d-d.Zd/dd0d1d2Zddd3d4Zddd5d6Zddd7d8Zd S);rrw_wsconn _Bootstrap _bootstraprc_wspF)initr!rWzDeferred[_WSP]rNzResponse | None_rejectResponser1rVcCs||_t|_|dSr)rWrrconnectionMaderXr5r5r7makeConnectionGsz%_WebSocketWireProtocol.makeConnectionrKcCs |j|||j|jdSr)rrYrrrWrLr5r5r7rLs z%_WebSocketWireProtocol.connectionMader9r:cCs*|j||jD]}t||qdSr)rZ receive_dataeventsr)r6r;rr5r5r7 dataReceivedQs z#_WebSocketWireProtocol.dataReceivedr$r_cCs,|j||jdk r(|j|d|_dSr)rrbrZ_bodyDataFinishedrar5r5r7rbVs   z%_WebSocketWireProtocol.connectionLostr0r2cCs,|j}|dk st||jt|dSr)rWAssertionErrorrrrr)r6r3rzr5r5r7r8]s z&_WebSocketWireProtocol.sendTextMessagecCs,|j}|dk st||jt|dSr)rWrrrrr)r6r;rzr5r5r7r=bs z'_WebSocketWireProtocol.sendBytesMessagerBrCcCs,|j}|dk st||jt|dSr)rWrrrrr)r6rDrzr5r5r7rFgs z_WebSocketWireProtocol.pingr>r{r?)r@r`r4cCs6|j}|dk st||jt|||dSr)rWrrrrrrA)r6r@r`rzr5r5r7rAls z%_WebSocketWireProtocol.loseConnectionrrGcCst|j|ddS)NT)rrWZregisterProducerrIr5r5r7rJrsz%_WebSocketWireProtocol.attachProducercCst|jdSr)rrWZunregisterProducerrLr5r5r7rMusz%_WebSocketWireProtocol.detachProducercCs$|j}|`||j|jdSr)rcallbackrrZr6doner5r5r7_completeConnectionxs z*_WebSocketWireProtocol._completeConnectioncCs,|jdk st|j}|`|t|jdSr)rrrZerrbackrRrr5r5r7_rejectConnection~sz(_WebSocketWireProtocol._rejectConnection)rB)r>r{)rNrOrPrTrrWrrrrrrbr8r=rFrArJrMrrr5r5r5r7r8s$  rrcCs |dSr)rrr5r5r7_handle_acceptConnectionsrrcCsDt}|jD]\}}|||q td|jd||j|_|dS)Nz1.1r{)r*headersZ addRawHeaderr( status_coderWrr)rrhdrkvr5r5r7_handle_rejectConnections rrcCs4|jdk std|j|j|jr0|jdS)Nz7response should never be None when receiving RejectData)rrZ_bodyDataReceivedr;Z body_finishedrWrArr5r5r7_handle_rejectDatasrrcCs|j|jdSr)rr]r;rr5r5r7_handle_textMessagesrrcCs|j|jdSr)rr^r;rr5r5r7_handle_bytesMessagesrrcCs|j|j|dSr)rWrrrrSrr5r5r7 _handle_pingsrrcCs|j|jdSr)rr[rDrr5r5r7 _handle_pongsrrcCsB|jdk st|jjtjkr4|j|j||j dSr) rWrrstaterZCLOSEDrrrSrArr5r5r7_handle_closeConnectionsrrr9rgcCs|t|dddS)Nz content-typez text/plains$websocket protocol negotiation error)ZsetResponseCoder%Z setHeader)rhr5r5r7_negotiationErrors  rcs8eZdZdZdddfdd Zddd d d ZZS) WebSocketResourcez A L{WebSocketResource} is a L{Resource} that presents a websocket listener. You can install it into any twisted web server resource hierarchy. z)WebSocketServerFactory[WebSocketProtocol]r1)factoryr4cst||_dS)a# Create a L{WebSocketResource} that will respond to incoming connections with the given L{WebSocketServerFactory}. @param factory: The factory that will be used to respond to inbound websocket connections on appropriately formatted GET requests. N)super__init__r)r6r __class__r5r7rs zWebSocketResource.__init__rz bytes | intrgc Csttj}|j}dd|D}z|||jWn>tk rr}z tj d||dt |WYSd}~XYnX|j |}|dk st d|t}|j}|jj} | dk st d|dk st dt|t|} |j| | ||tS) zv This implementation of the C{GET} HTTP method will respond to inbound websocket connections. cSs"g|]\}}|D] }||fqqSr5r5).0hkeyZhvalsvalr5r5r7 sz0WebSocketResource.render_GET..z{request} failed with {rpe})rhrpeNz"connection not accepted by twistedzchannel transport not connectedz"connection not accepted by wsproto)rr ZSERVERZrequestHeadersZgetAllRawHeadersZinitiate_upgrade_connectionpathr_logerrorrrrirrr connectionZchannelrWrserverBootstrapZ_protocolUpgradeForWebsocketsrrZr.) r6rhZ handshakerawZ simpleHeadersrZwsprotZtoSendZwsconrzZ wireProtor5r5r7 render_GETs(       zWebSocketResource.render_GET)rNrOrPrQrr __classcell__r5r5rr7rs rrwr!rxcCsdS)zC The server requires no bootstrapping, so this is a no-op. Nr5)ryrzr5r5r7rsr)`rQ __future__rtypingZ dataclassesrr functoolsrrrrr Zzope.interfacer Z hyperlinkr Zwsprotor r rZwsproto.connectionrZwsproto.eventsrrrrrrrrrrrZwsproto.handshakerZwsproto.utilitiesrZtwisted.internet.deferrZtwisted.internet.interfacesrrrr r!Ztwisted.internet.protocolr"rZtwisted.loggerr#Ztwisted.python.failurer$Ztwisted.web._responsesr%Ztwisted.web.clientr&r'r(r)Ztwisted.web.http_headersr*Ztwisted.web.iwebr+r,Ztwisted.web.resourcer-Ztwisted.web.serverr.Protocolr/ ExceptionrRrUrcrrrfrkrnrrrregisterrrrrrrrrrrrr5r5r5r7sv     0         + EPK ,