Yf0Q @ s d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l Z d d l
Z
d d l Z d d l Z d d Z d d Z d d d Z Gd d
d
e j Z d d Z d
Z Gd d d e j Z i Z e
j d Z e
j d Z Gd d d e Z Gd d d e Z d d Z Gd d d e Z! Gd d d e j" e Z# Gd d d e Z$ Gd d d e Z% d d Z& d d! Z' Gd" d# d# e Z( d$ d% Z) d S)&a RPC Implementation, originally written for the Python Idle IDE
For security reasons, GvR requested that Idle's Python execution server process
connect to the Idle process, which listens for the connection. Since Idle has
only one client per server, this was not a limitation.
+---------------------------------+ +-------------+
| socketserver.BaseRequestHandler | | SocketIO |
+---------------------------------+ +-------------+
^ | register() |
| | unregister()|
| +-------------+
| ^ ^
| | |
| + -------------------+ |
| | |
+-------------------------+ +-----------------+
| RPCHandler | | RPCClient |
| [attribute of RPCServer]| | |
+-------------------------+ +-----------------+
The RPCServer handler class is expected to provide register/unregister methods.
RPCHandler inherits the mix-in class SocketIO, which provides these methods.
See the Idle run.main() docstring for further information on how this was
accomplished in Idle.
Nc C s t j | } | S)N)marshalloads)msco r 0/opt/alt/python35/lib64/python3.5/idlelib/rpc.py
unpickle_code/ s r c C s t j | } t | f f S)N)r dumpsr )r r r r r pickle_code4 s r
c C s2 t j } t | | } | j | | j S)N)ioBytesIO CodePicklerdumpgetvalue)objZprotocolfpr r r r 9 s
r c @ s/ e Z d Z e j e i Z e j e j d S)r
N) __name__
__module__ __qualname__typesCodeTyper
dispatch_tableupdatecopyregr r r r r
? s r
i z 127.0.0.1c @ sO e Z d Z d d d Z d d Z d d Z d d Z d
d Z d S) RPCServerNc C s, | d k r t } t j j | | | d S)N)
RPCHandler socketserver TCPServer__init__)selfaddrZ handlerclassr r r r H s zRPCServer.__init__c C s d S)z@Override TCPServer method, no bind() phase for connecting entityNr )r! r r r server_bindM s zRPCServer.server_bindc C s | j j | j d S)zOverride TCPServer method, connect() instead of listen()
Due to the reversed connection, self.server_address is actually the
address of the Idle Client to which we are connecting.
N)socketZconnectserver_address)r! r r r server_activateQ s zRPCServer.server_activatec C s | j | j f S)z:Override TCPServer method, return already connected socket)r$ r% )r! r r r get_requestZ s zRPCServer.get_requestc C s y Wn t k
r Yn t j } t d d d d | t d d | t d t j j d | t d | d | t d t | d | t j d | t d d | t d d d | t
j d
Yn Xd S) zOverride TCPServer method
Error message goes to __stderr__. No error message if exiting
normally or socket raised EOF. Other exceptions not handled in
server code will cause os._exit.
-( filezUnhandled server exception!z
Thread: %szClient Address: z Request: z#
*** Unrecoverable, server exiting!r N)
SystemExitsys
__stderr__print threadingcurrent_threadnamerepr traceback print_excos_exit)r! requestZclient_addressZerfr r r handle_error^ s
zRPCServer.handle_error)r r r r r# r& r' r9 r r r r r F s
r c @ sr e Z d Z d Z d d d d Z d d Z d d Z d d
Z d d Z d
d Z d d Z
d d Z d d Z d d Z
d d Z d d Z d d Z d d Z d d Z d! d" Z d# d$ Z d% d& Z d' d( Z d) d* Z d+ Z d, Z d Z d- d. Z d/ d0 Z d1 d2 Z d3 d4 Z d5 d6 Z d7 d8 Z d9 d: Z! d S);SocketIOr Nc C s^ t j | _ | d k r$ | | _ | | _ | d k r? t } | | _ i | _ i | _ d S)N) r0 r1
sockthread debuggingsock objecttableobjtable responsescvars)r! r= r? r< r r r r s zSocketIO.__init__c C s, | j } d | _ | d k r( | j d S)N)r= close)r! r= r r r rB s zSocketIO.closec C s t j d d S)z!override for specific exit actionr N)r6 r7 )r! r r r exithook s zSocketIO.exithookc G si | j s
d S| j d t t j j } x" | D] } | d t | } q4 Wt | d t j d S)N r+ ) r< locationstrr0 r1 r2 r/ r- r. )r! argssar r r debug s
zSocketIO.debugc C s | | j | <d S)N)r? )r! oidobjectr r r register s zSocketIO.registerc C s' y | j | =Wn t k
r" Yn Xd S)N)r? KeyError)r! rK r r r
unregister s
zSocketIO.unregisterc C s' | j d | y | \ } \ } } } } Wn t k
rD d SYn X| | j k re d d | f f S| j | } | d k r i } t | | d | f S| d k r i }
t | |
d |
f St | | s d d | f f St | | } y~ | d k r6| | | } t | t r,t | } d | f S| d
k rbt
j | | | | f f d Sd d | f SWn t k
r Yn t
k
r Yn t k
r Yns t k
r}
z d
|
f SWYd d }
~
XnE d } t | | | | f d t j t j d t j d SYn Xd S)Nz
localcall:ERRORBad request formatzUnknown object id: %r __methods__OK__attributes__zUnsupported method name: %rCALLQUEUEQUEUEDz Unsupported message type: %sCALLEXCzU*** Internal Error: rpc.py:SocketIO.localcall()
Object: %s
Method: %s
Args: %s
r+ EXCEPTION)rP rQ )rW N)rY N)rJ TypeErrorr? _getmethods_getattributeshasattrgetattr
isinstance RemoteObject remoteref
request_queueZputr, KeyboardInterruptOSError Exceptionr/ r- r. r4 r5 )r! seqr8 howrK
methodnamerG kwargsr methods
attributesmethodZretZexmsgr r r localcall sT
zSocketIO.localcallc C s8 | j d | | | j | | | | } | j | S)Nzremotecall:asynccall: )rJ asynccall asyncreturn)r! rK rh rG ri rf r r r
remotecall s zSocketIO.remotecallc C s8 | j d | | | j | | | | } | j | S)Nzremotequeue:asyncqueue: )rJ
asyncqueuerp )r! rK rh rG ri rf r r r remotequeue s zSocketIO.remotequeuec C s d | | | | f f } | j } t j | j k rR t j } | | j | <| j d | | | | | | j | | f | S)NrU z
asynccall:%d:)newseqr0 r1 r; ConditionrA rJ
putmessage)r! rK rh rG ri r8 rf cvarr r r ro s
zSocketIO.asynccallc C s d | | | | f f } | j } t j | j k rR t j } | | j | <| j d | | | | | | j | | f | S)NrV zasyncqueue:%d:)rt r0 r1 r; ru rA rJ rv )r! rK rh rG ri r8 rf rw r r r rr s
zSocketIO.asyncqueuec C sG | j d | | j | d d } | j d | | | j | S)Nz#asyncreturn:%d:call getresponse(): waitg?zasyncreturn:%d:response: )rJ getresponsedecoderesponse)r! rf responser r r rp s zSocketIO.asyncreturnc C s | \ } } | d k r | S| d k r, d S| d k rI | j d d S| d k rp | j d | j d S| d k r | j d | t | | d k r | j d
| | t | | d S) NrS rW rY zdecoderesponse: EXCEPTIONEOFzdecoderesponse: EOFrP z decoderesponse: Internal ERROR:rX z decoderesponse: Call Exception:)rJ decode_interrupthook RuntimeError SystemError)r! r{ rg whatr r r rz s&
zSocketIO.decoderesponsec C s
t d S) N)EOFError)r! r r r r} s z SocketIO.decode_interrupthookc C sD y | j d d d d Wn# t k
r? | j d d SYn Xd S)zListen on socket until I/O not ready or EOF
pollresponse() will loop looking for seq number None, which
never comes, and exit on EOFError.
myseqNrx g?zmainloop:return)ry r rJ )r! r r r mainloop s
zSocketIO.mainloopc C sO | j | | } | d k rK | \ } } | d k rK | | j | f } | S)NrS ) _getresponse_proxify)r! r rx r{ rg r r r r ry s zSocketIO.getresponsec C sH t | t r t | | j St | t rD t t | j | S| S)N)r_ RemoteProxyRPCProxyrK listmapr )r! r r r r r ' s
zSocketIO._proxifyc C s | j d | t j | j k rQ x | j | | } | d k r( | Sq( Wn} | j | } | j x | | j k r | j qk W| j | } | j d | | f | j | =| j | =| j | Sd S)Nz_getresponse:myseq:z-_getresponse:%s: thread woke up: response: %s)
rJ r0 r1 r; pollresponserA acquirer@ rx release)r! r rx r{ rw r r r r / s"
zSocketIO._getresponsec C s | j d | _ } | S)N )nextseq)r! rf r r r rt E s zSocketIO.newseqc C s | j d | d y t | } Wn4 t j k
r[ t d t | d t j Yn Xt j d t
| | } x t
| d k r yD t j g | j g g \ } } } | j j
| d t } Wn$ t t f k
r t d Yn X| | d } q{ Wd S)Nzputmessage:%d:r zCannot pickle:r+ z<izsocket no longer exists)rJ r pickleZ
PicklingErrorr/ r3 r- r. structZpacklenselectr= sendBUFSIZEAttributeErrorrZ rd )r! messagerH rwxnr r r rv I s $ zSocketIO.putmessage c C s | j t | j | j k r t j | j j g g g | \ } } } t | d k re d Sy | j j t } Wn t k
r t
Yn Xt | d k r t
| j | 7_ | j | j S)Nr ) _stage0r buffbufneedr r= filenoZrecvr rd r _stage1)r! rx r r r rH r r r
pollpacket] s
-
zSocketIO.pollpacketc C ss | j d k ro t | j d k ro | j d d } | j d d | _ t j d | d | _ d | _ d S)Nr r z<i )bufstater r r Zunpackr )r! rH r r r r m s
$zSocketIO._stage0c C sp | j d k rl t | j | j k rl | j d | j } | j | j d | _ d | _ d | _ | Sd S)Nr r r )r r r r )r! packetr r r r t s ' zSocketIO._stage1c C s | j | } | d k r d Sy t j | } Wnm t j k
r t d d t j t d t | d t j t j d t j t d d t j Yn X| S)Nz-----------------------r+ zcannot unpickle packet:)
r r r ZUnpicklingErrorr/ r- r. r3 r4 print_stack)r! rx r r r r r pollmessage| s zSocketIO.pollmessagec
C s xy t j d } Wn t j k
r- Yn, X| \ } } | d | f f } | j | y# | j | } | d k r{ d SWn5 t k
r | j d SYn t k
r d SYn X| \ } } | d } | j d | | f | d k r[| j d | | j
| | } | j d | | f | d k rI| j | | f q | d k r q q | | k rk| S| j j | d } | d k r | j | | j
| <| j | j q q Wd S)
aR Handle messages received on the socket.
Some messages received may be asynchronous 'call' or 'queue' requests,
and some may be responses for other threads.
'call' requests are passed to self.localcall() with the expectation of
immediate execution, during which time the socket is not serviced.
'queue' requests are used for tasks (which may block or hang) to be
processed in a different thread. These requests are fed into
request_queue by self.localcall(). Responses to queued requests are
taken from response_queue and sent across the link with the associated
sequence numbers. Messages in the queues are (sequence_number,
request/response) tuples and code using this module removing messages
from the request_queue is responsible for returning the correct
sequence number in the response_queue.
pollresponse() will loop until a response message with the myseq
sequence number is received, and will save other responses in
self.responses and notify the owning thread.
r rS Nzpollresponse:%d:myseq:%srU rV z pollresponse:%d:localcall:call:z%pollresponse:%d:localcall:response:%s)rU rV )response_queuegetqueueZEmptyrv r r
handle_EOFr rJ rn rA r r@ notifyr )
r! r rx Zqmsgrf r{ r Zresqrg cvr r r r sL
zSocketIO.pollresponsec C sq | j | j d xI | j D]> } | j | } | j d | j | <| j | j q! W| j d S)z+action taken upon link being closed by peerr r| N)r| N)EOFhookrJ rA r r@ r r rC )r! keyr r r r r s
zSocketIO.handle_EOFc C s d S)zBClasses using rpc client/server can override to augment EOF actionNr )r! r r r r s zSocketIO.EOFhook)"r r r r r rB rC rJ rM rO rn rq rs ro rr rp rz r} r ry r r rt rv r r r r r r r r r r r r r r r: } s> .
I
r: c @ s e Z d Z d S)r` N)r r r r r r r r` s r` c C s t | } | t | <t | S)N)idr> r )r rK r r r ra s
ra c @ s e Z d Z d d Z d S)r c C s
| | _ d S)N)rK )r! rK r r r r s zRemoteProxy.__init__N)r r r r r r r r r s r c @ s@ e Z d Z d Z d Z d d Z d d Z d d Z d S)
r Fz#Sc C s6 | | _ t j | | t j j | | | | d S)N)Zcurrent_handlerr: r r BaseRequestHandler)r! r= r" Zsvrr r r r s zRPCHandler.__init__c C s | j d S)z(handle() method required by socketserverN)r )r! r r r handle s zRPCHandler.handlec C s
t | | S)N)r )r! rK r r r get_remote_proxy s zRPCHandler.get_remote_proxyN)r r r r< rE r r r r r r r r s
r c @ sR e Z d Z d Z d Z d Z e j e j d d Z d d Z
d d Z d
S) RPCClientFz#Cr c C s9 t j | | | _ | j j | | j j d d S)Nr )r$ listening_sockZbindZlisten)r! addressZfamilytyper r r r s zRPCClient.__init__c C sw | j j \ } } | j r4 t d | d t j | d t k rW t j | | n t d | d t j t d S)Nz ****** Connection request from r+ r z** Invalid host: )
r acceptr< r/ r- r. LOCALHOSTr: r rd )r! Z working_sockr r r r r s zRPCClient.acceptc C s
t | | S)N)r )r! rK r r r r s zRPCClient.get_remote_proxyN) r r r r< rE r r$ ZAF_INETZ SOCK_STREAMr r r r r r r r s
r c @ sL e Z d Z d Z d Z d d Z d d Z d d Z d d Z d S)
r Nc C s | | _ | | _ d S)N)sockiorK )r! r rK r r r r # s zRPCProxy.__init__c C s | j d k r | j | j j | rA t | j | j | S| j d k rZ | j | | j k r | j j | j d | f i } | St | d S)N__getattribute__)
_RPCProxy__methods_RPCProxy__getmethodsr MethodProxyr rK _RPCProxy__attributes_RPCProxy__getattributesrq r )r! r2 valuer r r __getattr__' s
zRPCProxy.__getattr__c C s% | j j | j d f i | _ d S)NrT )r rq rK r )r! r r r Z__getattributes5 s zRPCProxy.__getattributesc C s% | j j | j d f i | _ d S)NrR )r rq rK r )r! r r r Z __getmethods9 s zRPCProxy.__getmethods) r r r r r r r r r r r r r r s r c C sp x9 t | D]+ } t | | } t | r
d | | <q
Wt | t rl x | j D] } t | | qU Wd S)Nr )dirr^ callabler_ r __bases__r[ )r rj r2 attrsuperr r r r[ = s r[ c C s@ x9 t | D]+ } t | | } t | s
d | | <q
Wd S)Nr )r r^ r )r rk r2 r r r r r\ H s r\ c @ s( e Z d Z d d Z d d Z d S)r c C s | | _ | | _ | | _ d S)N)r rK r2 )r! r rK r2 r r r r P s zMethodProxy.__init__c O s% | j j | j | j | | } | S)N)r rq rK r2 )r! rG ri r r r r __call__U s !zMethodProxy.__call__N)r r r r r r r r r r N s r c C s | d k r d Sd t _ t | } y t j j | WnL t k
r d } | j | d } | j | d } t j j | Yn Xt j j d | t _ d S)z9Override standard display hook to use non-locale encodingNasciibackslashreplacestrictr( ) builtins_r3 r- stdoutwriteUnicodeEncodeErrorencodedecode)r textencodingbytesr r r displayhook] s
r )*__doc__r- r6 r r$ r r r r r0 r r4 r r r r r r
r ZPicklerr
r r r r r> ZQueuerb r rL r: r` ra r r r r r r[ r\ r r r r r r <module> sJ
2 j