Vhv@fdZddlmZddlZddlmZmZddlmZddlm 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 GddejZGeGddeHZIGddejZJe dd eJ!ZKe e eefe.gdfZLe3ZMGd"d#ejeKZNGd$d%ejeKZOed &Gd'd(ZPed8d)ZQee+eGd*d+e eKZReReJZSeQjd9d,ZUeQjd:d-ZVeQjd;d.ZWeQjdd1ZZeQjd?d2Z[eQjd@d3Z\dAd4Z]Gd5d6eCZ^dBd7Z_y)CzD 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_YETrcDeZdZdZd dZd dZd d dZd ddZddZddZ y)WebSocketTransportz9 The transport that can send websocket messages. cy)z& Send a text message. N)selftexts K/home/dcms/DCMS/lib/python3.12/site-packages/twisted/web/_websocket_impl.pysendTextMessagez"WebSocketTransport.sendTextMessageAcy)z' Send a bytes message. Nr3r4datas r6sendBytesMessagez#WebSocketTransport.sendBytesMessageFr8r9cy)z0 Drop the websocket connection. Nr3)r4codes r6loseConnectionz!WebSocketTransport.loseConnectionKr8r9cy)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. Nr3r4payloads r6pingzWebSocketTransport.pingPr8r9cy)zF Attach the given L{IPushProducer} to this transport. Nr3r4producers r6attachProducerz!WebSocketTransport.attachProducer\r8r9cy)zT Detach a previously attached L{IPushProducer} from this transport. Nr3r4s r6detachProducerz!WebSocketTransport.detachProducerar8r9Nr5strreturnNoner<bytesrNrO))r?intrNrOr9rCrQrNrOrGr rNrOrNrO) __name__ __module__ __qualname____doc__r7r=r@rDrHrKr3r9r6r1r1<s%      r9r1ceZdZUdZded<y)ConnectionRejectedz A websocket connection was rejected by an HTTP response. @ivar response: The HTTP response that describes the rejection. r)responseN)rXrYrZr[__annotations__r3r9r6r]r]gs r9r]c@eZdZdZd dZd dZd dZd dZd dZddZ y)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. cy)z An underlying transport (e.g.: a TCP connection) has been established; negotiation of the websocket transport has begun. Nr3r4 transports r6negotiationStartedz$WebSocketProtocol.negotiationStartedr8r9cy)zn Negotiation is complete: a bidirectional websocket channel is now fully established. Nr3rJs r6negotiationFinishedz%WebSocketProtocol.negotiationFinishedr8r9cy)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. Nr3rBs r6 pongReceivedzWebSocketProtocol.pongReceivedr8r9cy)z< A text message was received from the peer. Nr3)r4messages r6textMessageReceivedz%WebSocketProtocol.textMessageReceivedr8r9cy)z= A bytes message was received from the peer. Nr3r;s r6bytesMessageReceivedz&WebSocketProtocol.bytesMessageReceivedr8r9cy)z4 The websocket connection was lost. Nr3r4reasons r6connectionLostz WebSocketProtocol.connectionLostr8r9N)rdr1rNrOrWrU)rkrMrNrOrPrqr%rNrO) rXrYrZr[rergrirlrnrrr3r9r6rarars%"   .   r9ra_WSPT) covariantboundceZdZdZddZy)WebSocketServerFactoryz A L{WebSocketServerFactory} is a factory for a particular kind of L{WebSocketProtocol} that implements server-side websocket listeners via L{WebSocketResource}. cy)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. Nr3)r4requests r6 buildProtocolz$WebSocketServerFactory.buildProtocolr8r9N)rzrrNrtrXrYrZr[r{r3r9r6rxrx   r9rxceZdZdZddZy)WebSocketClientFactoryz A L{WebSocketClientFactory} is a factory for a particular kind of L{WebSocketProtocol} that implements client-side websocket listeners via L{WebSocketClientEndpoint}. cy)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. Nr3)r4urls r6r{z$WebSocketClientFactory.buildProtocolr8r9N)rrMrNrtr|r3r9r6rrr}r9r)frozencleZdZUdZded< ded< eeddf d dZd dZy) 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,endpointFactoryrMrNc6t||||}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*r)clsreactorr tlsPolicyconnectTimeout bindAddressrs r6newzWebSocketClientEndpoint.news&43 Y  '<.clientBootstrap sN TXX&A"2DABF GGCHHYqvvv67 8r9c~tttjj j SN)_WebSocketWireProtocolrrCLIENTr{r)rprotocolFactoryr4sr6z1WebSocketClientEndpoint.connect..'s0. !6!67##11$((;r9NrWSConnection | Connectionrr"rNrO) rendpointForURIr' fromBytesrencodeconnectProtocolFactory forProtocol_done)r4rendpoint connectedrs`` @r6rzWebSocketClientEndpoint.connects''66 MM$((//'2 3  9 9A8H8H  ' ' 9 3 __$$3 %s$A:B?BBBBB) rr!rrMrr-rz int | Nonerz bytes | NonerNr)rzWebSocketClientFactory[_WSP]rNrt) rXrYrZr[r_ classmethodr(rrr3r9r6rrs +* H &?%@%)$( ===# = # = " = !==<%r9rcy)z, Handle a websocket protocol event. Nr3eventprotos r6 _handleEventr1r8r9ceZdZUded<ded<ded<edZd ed <edZd ed <d Zded<ddZddZ ddZ ddZ d dZ ddZ d!d"dZd#d$dZd%dZddZddZddZy )&rr_wsconn _Bootstrap _bootstraprt_wspF)initr"rdzDeferred[_WSP]rNzResponse | None_rejectResponsecP||_t|_|jyr)rdrrconnectionMadercs r6makeConnectionz%_WebSocketWireProtocol.makeConnectionGs"Z  r9c|jj||j|j|jyr)rrerrrdrJs r6rz%_WebSocketWireProtocol.connectionMadeLs* $$T*  dnn5r9c|jj||jjD]}t||yr)r receive_dataeventsr)r4r<rs r6 dataReceivedz#_WebSocketWireProtocol.dataReceivedQs: !!$'\\((* &E  % &r9c|jj||j#|jj|d|_yyr)rrrr_bodyDataFinishedrps r6rrz%_WebSocketWireProtocol.connectionLostVsA   (    +  2 26 :#'D  ,r9c|j}|J|j|jjt |yr)rdrrrr)r4r5rs r6r7z&_WebSocketWireProtocol.sendTextMessage]s5 NN}}  !!+d"345r9c|j}|J|j|jjt |yr)rdrrrr)r4r<rs r6r=z'_WebSocketWireProtocol.sendBytesMessagebs5 NN}}  !!,t"456r9c|j}|J|j|jjt |yr)rdrrrr)r4rCrs r6rDz_WebSocketWireProtocol.pinggs4 NN}}  !!$w-01r9c|j}|J|j|jjt |||j yr)rdrrrrr@)r4r?rqrs r6r@z%_WebSocketWireProtocol.loseConnectionlsC NN}}  !!/$"?@A r9cNt|jj|dy)NT)rrdregisterProducerrFs r6rHz%_WebSocketWireProtocol.attachProducerrs$..!228TBr9cJt|jjyr)rrdunregisterProducerrJs r6rKz%_WebSocketWireProtocol.detachProducerus$..!446r9c|j}|`|j|j|jjyr)rcallbackrrgr4dones r6_completeConnectionz*_WebSocketWireProtocol._completeConnectionxs0zz J dii  %%'r9c|jJ|j}|`|jt|jyr)rrerrbackr]rs r6_rejectConnectionz(_WebSocketWireProtocol._rejectConnection~s:##///zz J '(<(<=>r9)rdr"rNrOrWrPrsrLrTrU)rRr)r?rSrqrMrNrOrV)rXrYrZr_rrdrrrrrrrr7r=rDr@rHrKrrr3r9r6rr8s~'& J"u-Iz-"u-E>-'+O_+ 6 & (6 7 2  C7( ?r9rc$|jyr)rrs r6_handle_acceptConnectionrs r9ct}|jD]\}}|j||td|jd||j |_|jy)Nz1.1r)r+headers addRawHeaderr) status_coderdrr)rrhdrkvs r6_handle_rejectConnectionrs[ )C 1 A$UE,=,=r3XE r9c|jJd|jj|j|jr|jj yy)Nz7response should never be None when receiving RejectData)r_bodyDataReceivedr< body_finishedrdr@rs r6_handle_rejectDatarsX )A@A) ++EJJ7  &&(r9cN|jj|jyr)rrlr<rs r6_handle_textMessagers JJ""5::.r9cN|jj|jyr)rrnr<rs r6_handle_bytesMessagers JJ##EJJ/r9c|jj|jj|j yr)rdrrrr^rs r6 _handle_pingrs* OO%--,,U^^-=>?r9cN|jj|jyr)rrirCrs r6 _handle_pongrs JJEMM*r9c&|jJ|jjtjk7rB|jj |jj |j|jjyr) rdrstaterCLOSEDrrr^r@rs r6_handle_closeConnectionrsb ?? && & }}o444 emm001ABC OO""$r9cR|jt|jddy)Nz content-typez text/plains$websocket protocol negotiation error)setResponseCoder& setHeader)rzs r6_negotiationErrorrs# K( nl3 2r9c,eZdZdZdfd ZddZxZS)WebSocketResourcez A L{WebSocketResource} is a L{Resource} that presents a websocket listener. You can install it into any twisted web server resource hierarchy. c0t|||_y)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__factory)r4r __class__s r6rzWebSocketResource.__init__s  r9cttj}|jj }|Dcgc]\}}|D]}||f}}}} |j ||j |jj|} | Jd|jt} |j} |j j"} | Jd| Jdt%| t&| } |j j)| | j+| | j-t.Scc}}}w#t$r-}tjd||t|cYd}~Sd}~wwxYw)zv This implementation of the C{GET} HTTP method will respond to inbound websocket connections. z{request} failed with {rpe})rzrpeNz"connection not accepted by twistedzchannel transport not connectedz"connection not accepted by wsproto)rrSERVERrequestHeadersgetAllRawHeadersinitiate_upgrade_connectionpathr_logerrorrrr{rr connectionchannelrdrserverBootstrap_protocolUpgradeForWebsocketsrrgr/)r4rz handshakerawhkeyhvalsval simpleHeadersrwsprottoSendwsconr wireProtos r6 render_GETzWebSocketResource.render_GETsT !!6!67 $$5578;MMuuM$MM M .  1 1- N++G4!G#GG! 0 23$$ OO % %}???} F"FF *5/6J 55i@ ""$#N# . JJ4g3J O$W- - .s#D4D;; E1"E,&E1,E1)rz)WebSocketServerFactory[WebSocketProtocol]rNrO)rzrrNz bytes | int)rXrYrZr[rr __classcell__)rs@r6rrs r9rcy)zC The server requires no bootstrapping, so this is a no-op. Nr3)rrs r6rrr8r9)rrrAnyWSWPrNrO)rrrrrNrO)rrrrrNrO)rrrrrNrO)rrrrrNrO)rrrrrNrO)rrrrrNrO)rrrrrNrO)rrrrrNrO)rzrrNrQr)`r[ __future__rtyping dataclassesrr functoolsrrrr r zope.interfacer hyperlinkr wsprotor rrwsproto.connectionrwsproto.eventsrrrrrrrrrrrwsproto.handshakerwsproto.utilitiesrtwisted.internet.deferrtwisted.internet.interfacesrrr r!r"twisted.internet.protocolr#rtwisted.loggerr$twisted.python.failurer%twisted.web._responsesr&twisted.web.clientr'r(r)r*twisted.web.http_headersr+twisted.web.iwebr,r-twisted.web.resourcer.twisted.web.serverr/Protocolr1 Exceptionr]rartrrrxrrrrrregisterrrrrrrrrrrrr3r9r6r.ss # ($44&<<.   +1+A!*. -C)4( ( V  B B Jv->? u\:56 CTI J  x V__T2 $ V__T2 $ $M%M%M%`  Y H?WT]H? H?V !!2 3  ))//00@@++%%3 ))Xr9