U W[(@sdZddlmZmZddlZddlmZddlmZm Z ddl m Z m Z m Z ddlmZmZmZmZmZddlmZmZdd lmZdd lmZmZdd lmZmZdd lm Z dd l!m"Z"ddl#m$Z$m%Z%ddl&m'Z'm(Z(m)Z)m*Z*ddl+m,Z,ddl-m.Z.ddl-m/Z/m0Z0ddl-m1Z1m2Z2ddl-m3Z3ddl-m4Z4ddl-m5Z5ddl-m6Z6ddl-m7Z7ddl-m8Z8ddl-m9Z9ddl-m:Z:ddl-m;Z;ddl-mZ>dd l-m?Z?dd!l-m@Z@dd"l-mAZAd#ZBd$ZCGd%d&d&eDZEGd'd(d(eEZFGd)d*d*eDZGGd+d,d,eDZHeGd-d.d.ZIGd/d0d0eDZJGd1d2d2e ZKeeKGd3d4d4ZLGd5d6d6e/ZMee%eGd7d8d8e.e jNZOed?d?e8e jQZSe This is a translucent reference to a remote message. cCs||_||_dS)zT Initialize with a L{RemoteReference} and the name of this message. N)objname)rCrGrHr9r9r:r@szRemoteMethod.__init__cCst|j|jf|Sr>)rrGrHrCotherr9r9r:__cmp__szRemoteMethod.__cmp__cCst|j|jfSr>)hashrGrHrCr9r9r:__hash__szRemoteMethod.__hash__cOs(|jjd|jj|jj|jd||S)z8 Asynchronously invoke a remote method. utf-8)rGbroker _sendMessage perspectiveluidrHencode)rCargskwr9r9r:__call__s  zRemoteMethod.__call__N)r5r6r7r8r@rKrNrXr9r9r9r:rFs rFc@s eZdZdS)PBConnectionLostN)r5r6r7r9r9r9r:rYsrYc@seZdZdZddZdS) IPerspectivea per*spec*tive, n. : The relationship of aspects of a subject to each other and to a whole: 'a perspective of history'; 'a need to view the problem in the proper perspective'. This is a Perspective Broker-specific wrapper for an avatar. That is to say, a PB-published view on to the business logic for the system's concept of a 'user'. The concept of attached/detached is no longer implemented by the framework. The realm is expected to implement such semantics if needed. cCsdS)a This method is called when a network message is received. @arg broker: The Perspective Broker. @type message: str @arg message: The name of the method called by the other end. @type args: list in jelly format @arg args: The arguments that were passed by the other end. It is recommend that you use the `unserialize' method of the broker to decode this. @type kwargs: dict in jelly format @arg kwargs: The keyword arguments that were passed by the other end. It is recommended that you use the `unserialize' method of the broker to decode this. @rtype: A jelly list. @return: It is recommended that you use the `serialize' method of the broker on whatever object you need to return to generate the return value. Nr9)rQmessagerVkwargsr9r9r:perspectiveMessageReceivedsz'IPerspective.perspectiveMessageReceivedNr5r6r7r8r]r9r9r9r:rZsrZc@seZdZdZddZdS)Avatara A default IPerspective implementor. This class is intended to be subclassed, and a realm should return an instance of such a subclass when IPerspective is requested of it. A peer requesting a perspective will receive only a L{RemoteReference} to a pb.Avatar. When a method is called on that L{RemoteReference}, it will translate to a method on the remote perspective named 'perspective_methodname'. (For more information on invoking methods on other objects, see L{flavors.ViewPoint}.) c Csr|||}|||}t|d|}z|||}Wn*tk r^td|||fYnX||||||S)ai This method is called when a network message is received. This will call:: self.perspective_%(message)s(*broker.unserialize(args), **broker.unserialize(kw)) to handle the method; subclasses of Avatar are expected to implement methods using this naming convention. zperspective_%sz%s didn't accept %s and %s) unserializegetattr TypeErrorrmsg serialize)rCrQr[rVrWmethodstater9r9r:r]s  z!Avatar.perspectiveMessageReceivedNr^r9r9r9r:r_sr_c@seZdZdZdddZdS)AsReferenceablez6 A reference directed towards another object. remotecCst||d|_dS)NZMessageReceived)raremoteMessageReceived)rCobjectZ messageTyper9r9r:r@szAsReferenceable.__init__N)rhrEr9r9r9r:rgsrgc@sheZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdS)RemoteReferencea] A translucent reference to a remote object. I may be a reference to a L{flavors.ViewPoint}, a L{flavors.Referenceable}, or an L{IPerspective} implementer (e.g., pb.Avatar). From the client's perspective, it is not possible to tell which except by convention. I am a "translucent" reference because although no additional bookkeeping overhead is given to the application programmer for manipulating a reference, return values are asynchronous. See also L{twisted.internet.defer}. @ivar broker: The broker I am obtained through. @type broker: L{Broker} cCs"||_||_||_||_g|_dS)z(internal) Initialize me with a broker and a locally-unique ID. The ID is unique only to the particular Perspective Broker instance. N)rTrQ doRefCountrSdisconnectCallbacks)rCrSrQrTrlr9r9r:r@s zRemoteReference.__init__cCs8t|s t|j|t|jdkr4|j|jdS)z Register a callback to be called if our broker gets disconnected. @param callback: a callable which will be called with one argument, this instance. N)callableAssertionErrorrmappendlenrQnotifyOnDisconnect _disconnectedrCcallbackr9r9r:rs*s  z"RemoteReference.notifyOnDisconnectcCs$|j||js |j|jdS)zu Remove a callback that was registered with notifyOnDisconnect. @param callback: a callable N)rmremoverQdontNotifyOnDisconnectrtrur9r9r:rx7s z&RemoteReference.dontNotifyOnDisconnectcCs|jD] }||qd|_dS)zN Called if we are disconnected and have callbacks registered. N)rmrur9r9r:rtBs  zRemoteReference._disconnectedcCs,|jr$|j|jkstdd|jfSdSdS)zc If I am being sent back to where I came from, serialize as a local backreference. z6Can't send references to brokers other than their own.slocal)s unpersistablezReferences cannot be serializedN)invokerrQrprT)rCZjellierr9r9r:jellyForKs zRemoteReference.jellyForcCs||jj|j|dd|S)Nrn)r@ryunserializingPerspective)rCZ unjellierZ unjellyListr9r9r: unjellyForVszRemoteReference.unjellyForcOs.t|ts|d}|jd|j|j|||S)a Asynchronously invoke a remote method. @type _name: L{str} @param _name: the name of the remote method to invoke @param args: arguments to serialize for the remote function @param kw: keyword arguments to serialize for the remote function. @rtype: L{twisted.internet.defer.Deferred} @returns: a Deferred which will be fired when the result of this remote call is received. utf8rO) isinstancebytesrUrQrRrSrT)rC_namerVrWr9r9r: callRemote[s  zRemoteReference.callRemotecCs t||S)zX @param key: The key. @return: A L{RemoteMethod} for this key. )rF)rCkeyr9r9r: remoteMethodqszRemoteReference.remoteMethodcCs0t|tr$|j|jkr$t|j|jSt|j|S)zM @param other: another L{RemoteReference} to compare me to. )r~rkrQrrTrIr9r9r:rKzs  zRemoteReference.__cmp__cCs|jS)z Hash me. )rTrMr9r9r:rNszRemoteReference.__hash__cCs|jr|j|jdS)zD Do distributed reference counting on finalization. N)rlrQ sendDecRefrTrMr9r9r:__del__szRemoteReference.__del__N)r5r6r7r8r@rsrxrtrzr|rrrKrNrr9r9r9r:rks       rkrhc@s2eZdZdZd ddZddZddZd d ZdS) Localz3 (internal) A reference to a local object. NcCs||_||_d|_dS)z Initialize. rnN)rjrSrefcount)rCrjrSr9r9r:r@szLocal.__init__cCsd|j|jfS)Nz)rjrrMr9r9r:__repr__szLocal.__repr__cCs|jd|_|jS)zi Increment the reference count. @return: the reference count after incrementing rnrrMr9r9r:increfs z Local.increfcCs|jd|_|jS)zi Decrement the reference count. @return: the reference count after decrementing rnrrMr9r9r:decrefs z Local.decref)N)r5r6r7r8r@rrrr9r9r9r:rs   rc@seZdZdZdZddZdS)CopyableFailurez} A L{flavors.RemoteCopy} and L{flavors.Copyable} version of L{twisted.python.failure.Failure} for serialization. rcCs~|j}d|d<g|d<g|d<t|j|d<t|jtrH|j|d<nt|j d|d<|j rr| |d<nd |d<|S) z Collect state related to the exception which occurred, discarding state which cannot reasonably be serialized. NtbZframesstackrDtyperP tracebackzTraceback unavailable ) __dict__copystrrDr~rrr ZqualrUunsafeTracebacksZ getTraceback)rCrfr9r9r:getStateToCopys   zCopyableFailure.getStateToCopyN)r5r6r7r8rrr9r9r9r:rsrc@s*eZdZdZd ddZddZeZeZdS) CopiedFailurea A L{CopiedFailure} is a L{pb.RemoteCopy} of a L{failure.Failure} transferred via PB. @ivar type: The full import path of the exception class which was raised on the remote end. @type type: C{str} @ivar value: A str() representation of the remote value. @type value: L{CopiedFailure} or C{str} @ivar traceback: The remote traceback. @type traceback: C{str} NrdefaultcCsT|dkrtj}|j}t|ts(|d}|d||d|j|ddS)NrPzTraceback from remote host -- z:  )rZlogfilerr~rdecodewriterD)rCfileZelideFrameworkCodeZdetailZ failureTyper9r9r:printTracebacks   zCopiedFailure.printTracebackcCs|t|j|j|jS)a Throw the original exception into the given generator, preserving traceback information if available. In the case of a L{CopiedFailure} where the exception type is a string, a L{pb.RemoteError} is thrown instead. @return: The next value yielded from the generator. @raise StopIteration: If there are no more values in the generator. @raise RemoteError: The wrapped remote exception. )throwr=rrDr)rCgr9r9r:throwExceptionIntoGenerators z)CopiedFailure.throwExceptionIntoGenerator)Nrr)r5r6r7r8rrZprintBriefTracebackZprintDetailedTracebackr9r9r9r:rs   rcCstt|j}||_|Sr>)rrrr)failrfr9r9r:failure2Copyable s rc@seZdZdZdZdZdZdefddZddZ d d Z d d Z d dZ ddZ ddZddZddZddZddZdZddZddZdd Zd!d"Zd#d$Zd%d&Zd'Zd(d)Zd*d+Zd,d-Zd^d.d/Zd0d1Zd2d3Z d4d5Z!d6d7Z"d_d8d9Z#d`d:d;Z$dd?Z&d@dAZ'dBdCZ(dDdEZ)dFdGZ*dHdIZ+dJdKZ,dLdMZ-dNdOZ.dPdQZ/dRdSZ0dTdUZ1dVdWZ2dXdYZ3dZd[Z4d\d]Z5dS)aBrokerz$ I am a broker for objects. NrncCsrtj||d|_g|_g|_g|_i|_||_g|_ d|_ d|_ d|_ i|_ i|_i|_i|_i|_i|_dSNr)rBananar@ disconnected disconnectsfailuresconnects localObjectssecurity pageProducerscurrentRequestIDcurrentLocalIDr{luidsremotelyCachedObjectsremotelyCachedLUIDslocallyCachedObjectswaitingForAnswers _localCleanup)rCisClientrr9r9r:r@s" zBroker.__init__cCsRtt|jdddD]&}|j|}||s|j|=q|jsN|jdS)zM Called when the consumer attached to me runs out of buffer. rnN)r rrrZ sendNextPageZ stillPaging transportZunregisterProducer)rCZpageridxpagerr9r9r:resumeProducingAs  zBroker.resumeProducingcCsdSr>r9rMr9r9r:pauseProducingOszBroker.pauseProducingcCsdSr>r9rMr9r9r: stopProducingTszBroker.stopProducingcCs,|j|t|jdkr(|j|ddS)Nrnr)rrqrrrZregisterProducer)rCrr9r9r:registerPageProducerYs zBroker.registerPageProducercCsjt|tr^|d}t|ts&|d}d|}t||d}|rP||ddqf|d|ntddS)z: Evaluate an expression as it's received. rr}zproto_%sNrnsdidNotUnderstandzNon-list expression received.)r~listrrrasendCallr3)rCsexpcommandZ methodNamerer9r9r:expressionReceived_s    zBroker.expressionReceivedcCs ||jkrtd|j|fdS)z Protocol message: (version version-number) Check to make sure that both ends of the protocol are speaking the same version dialect. @param vnum: The version number. zVersion Incompatibility: %s %sN)versionr3)rCZvnumr9r9r: proto_versionts zBroker.proto_versioncGs||dS)z Utility method to send an expression to the other side of the connection. @param exp: The expression. N)Z sendEncoded)rCZexpr9r9r:rszBroker.sendCallcCstd|dS)a  Respond to stock 'C{didNotUnderstand}' message. Log the command that was not understood and continue. (Note: this will probably be changed to close the connection or raise an exception in the future.) @param command: The command to log. zDidn't understand command: %rN)rrc)rCrr9r9r:proto_didNotUnderstands zBroker.proto_didNotUnderstandcCsP|d|j|jD]$}z |WqtYqXqd|_|j|dS)zF Initialize. Called after Banana negotiation is done. sversionN)rrrrdeferrfactoryclientConnectionMaderCnotifierr9r9r:connectionReadys  zBroker.connectionReadycCs6|jD]$}z |WqtYqXqd|_dSr>)rrrrr9r9r:connectionFaileds   zBroker.connectionFailedcCsd|_d|_|jrP|jD]2}z|tt|Wqt YqXq|j D]>}|j }|j }z| |t|||WqZt YqZXqZ|jddD]$}z |Wqt YqXqd|_d|_d|_d|_d|_ d|_d|_d|_dS)zg The connection was lost. @param reason: message to put in L{failure.Failure} rnN)rrrvalueserrbackrFailurerYrrrrjrSstoppedObservingr+rZ localSecurityZremoteSecurityrrr)rCreasondlobj cacheablerSrr9r9r:connectionLosts8 zBroker.connectionLostcCst|s t|j|dS)zQ @param notifier: callback to call when the Broker disconnects. N)rorprrqrr9r9r:rss zBroker.notifyOnDisconnectcCst|s t|j|dS)zT @param notifier: callback to call if the Broker fails to connect. N)rorprrqrr9r9r: notifyOnFails zBroker.notifyOnFailcCsHt|s t|jdkr8z |WqDtYqDXn |j|dS)zN @param notifier: callback to call when the Broker connects. N)rorprrerrrqrr9r9r:notifyOnConnects   zBroker.notifyOnConnectcCs*z|j|Wntk r$YnXdS)zY @param notifier: callback to remove from list of disconnect callbacks. N)rrw ValueErrorrr9r9r:rxszBroker.dontNotifyOnDisconnectcCs2t|tr|d}|j|}|dkr,dS|jS)z Get a local object for a locally unique ID. @return: An object previously stored with L{registerReference} or L{None} if there is no object which corresponds to the given identifier. r}N)r~r rUrgetrj)rCrTZlobr9r9r:localObjectForIDs    zBroker.localObjectForIDrcCs|dk s t|}|j|}|dkrt|jtkrf|jd|_|jdkr^|j t dt d| }t ||j|<||j|<n|j| |S)z Store a persistent reference to a local object and map its id() to a generated, session-unique ID. @param object: a local object @return: the generated ID Nrnz.Maximum PB reference count exceeded. Goodbye.z$Maximum PB reference count exceeded.)rpprocessUniqueIDrrrrrMAX_BROKER_REFSmaxBrokerRefsViolationsrloseConnectionr< newLocalIDrr)rCrjpuidrTr9r9r:registerReferences      zBroker.registerReferencecCs2t|tr|d}|dk s tt||j|<dS)z Store a special (string) ID for this object. This is how you specify a 'base' set of objects that the remote protocol can connect to. @param name: An ID. @param object: The object. r}N)r~r rUrprr)rCrHrjr9r9r:setNameForLocal6s   zBroker.setNameForLocalcCs"t|tr|d}td||dS)a Returns an object from the remote name mapping. Note that this does not check the validity of the name, only creates a translucent reference for it. @param name: The name to look up. @return: An object which maps to the name. r}Nr)r~r rUrk)rCrHr9r9r: remoteForNameGs  zBroker.remoteForNamecCs2|}|j|}|dk r.|r.|j||S)a @param instance: The instance to look up. @param incref: Flag to specify whether to increment the reference. @return: An ID that says what this instance is cached as remotely, or L{None} if it's not. N)rrrrr)rCinstancerrrTr9r9r:cachedRemotelyAsWs   zBroker.cachedRemotelyAscCs |j|jS)zk @param luid: The LUID to look up. @return: An instance which is cached remotely. )rrj)rCrTr9r9r:remotelyCachedForLUIDhszBroker.remotelyCachedForLUIDcCsn|}|}t|jtkrN|jd|_|jdkrF|jtdtd||j |<t ||j |j|<|S)z3 XXX @return: A new LUID. rnrz*Maximum PB cache count exceeded. Goodbye.z Maximum PB cache count exceeded.) rrrrrrrrrr<rrserializingPerspective)rCrrrTr9r9r: cacheRemotelyqs    zBroker.cacheRemotelycCs||j|<dS)zL(internal) Store a non-filled-out cached instance locally. NrrCZcidrr9r9r: cacheLocallyszBroker.cacheLocallycCs|j|}|Sr>rrr9r9r:cachedLocallyAss zBroker.cachedLocallyAscCs|t|tjr0|j|jdd||||dd|S||_||_||_||_zt ||j d|WSd|_d|_d|_d|_XdS)a Jelly an object according to the remote security rules for this broker. @param object: The object to jelly. @param perspective: The perspective. @param method: The method. @param args: Arguments. @param kw: Keyword arguments. cSs|Sr>r9)xr9r9r:rOz"Broker.serialize..)rSrerVrW)ZcallbackKeywordsN) r~rDeferred addCallbacksrdrZ jellyMethodZ jellyArgsZjellyKwrr)rCrjrSrerVrWr9r9r:rds& zBroker.serializecCs(||_zt||jd|WSd|_XdS)z Unjelly an sexp according to the local security rules for this broker. @param sexp: The object to unjelly. @param perspective: The perspective. N)r{rr)rCrrSr9r9r:r`szBroker.unserializecCs|jd|_|jS)z3 @return: A newly generated LUID. rn)rrMr9r9r:rs zBroker.newLocalIDcCs|jd|_|jS)z9 @return: A newly generated request ID. rn)rrMr9r9r: newRequestIDs zBroker.newRequestIDc Cs d}d}d} d|kr"|d}|d=d|kr8|d}|d=d|kr^|sH|rPtd|d} |d=|jrltdz$|j|||d} |j|||d} WnttYSX|} | rt } | |j | <|s|rt d| ||nd} ||d | ||| | | | S) NrnZ pbcallbackZ pberrbackZpbanswerz*You can't specify a no-answer requirement.zCalling Stale Broker)rSrez&warning! using deprecated "pbcallback"smessage)rprr;rdrrrrrrrrrcrr)rCprefixrSobjectIDr[rVrWZpbcZpbeanswerRequirednetArgsnetKw requestIDZrvalr9r9r:rRs<  zBroker._sendMessagec Cs||j||||||dSr>) _recvMessagerrCrrr[rrrr9r9r: proto_messageszBroker.proto_messagec Cs||j||||||dSr>)rrrr9r9r:proto_cachemessageszBroker.proto_cachemessagec Cst|ts|d}z,||}|dkr.td|||||} Wntk r} z>|rt| tsn|j| jr|| | |n| t | |W5d} ~ XYnv|rt j dddt } | | |t Yn@X|rt| tjr|f} | j|j|j| | dn || |dS)a Received a message-send. Look up message based on object, unserialize the arguments, and invoke it with args, and send an 'answer' or 'error' response. @param findObjMethod: A callable which takes C{objectID} as argument. @param requestID: The requiest ID. @param objectID: The object ID. @param message: The message. @param answerRequired: @param netArgs: Arguments. @param netKw: Keyword arguments. r}NzInvalid Object ID)Peer will receive following PB traceback:T)ZisError)Z callbackArgsZ errbackArgs)r~rrr<rir'risClassAllowed __class__ _sendErrorrrrcrrrr _sendAnswer_sendFailureOrError) rCZ findObjMethodrrr[rrrrj netResulterrVr9r9r:rs4     zBroker._recvMessagecCs|d||dS)z (internal) Send an answer to a previously sent message. @param netResult: The answer. @param requestID: The request ID. sanswerNr)rCrrr9r9r:r<szBroker._sendAnswercCs&|j|}|j|=|||dS)z (internal) Got an answer to a previously sent message. Look up the appropriate callback and call it. @param requestID: The request ID. @param netResult: The answer. N)rrvr`)rCrrrr9r9r: proto_answerFs zBroker.proto_answercCs,|tdkr|||n |||dS)z Call L{_sendError} or L{_sendFailure}, depending on whether C{fail} represents an L{Error} subclass or not. @param fail: The failure. @param requestID: The request ID. N)Zcheckr< _sendFailurerrCrrr9r9r:rTszBroker._sendFailureOrErrorcCs$tdt||||dS)zz Log error and then send it. @param fail: The failure. @param requestID: The request ID. rN)rrcrrr r9r9r:rbs  zBroker._sendFailurecCstt|tjrHt|jts(|j|jjr0|j}nt|tsHt ||j j }t|tr\|j j |_ | d|| |dS)z (internal) Send an error for a previously sent message. @param fail: The failure. @param requestID: The request ID. serrorN)r~rrrDr'rrrrrrrrrdr r9r9r:rns     zBroker._sendErrorcCs&|j|}|j|=|||dS)z} (internal) Deal with an error. @param requestID: The request ID. @param fail: The failure. N)rrr`)rCrrrr9r9r: proto_errors zBroker.proto_errorcCs|d|dS)z^ (internal) Send a DECREF directive. @param objectID: The object ID. sdecrefNrrCrr9r9r:rszBroker.sendDecRefcCsbt|tr|d}|j|}|dkr^|j|j}|j|=|j|=|j |dddS)z (internal) Decrement the reference count of an object. If the reference count is zero, it will free the reference to this object. @param objectID: The object ID. r}rcSsdSr>r9r9r9r9r:rrOz%Broker.proto_decref..N) r~r rUrrrjrrrpop)rCrrefsrr9r9r: proto_decrefs  zBroker.proto_decrefcCs|d|dS)z_ (internal) Send a DECACHE directive. @param objectID: The object ID. sdecacheNrr r9r9r: decCacheRefszBroker.decCacheRefcCs|j|}|dkr~|j|}|j}|j}z||t|||WntYnX|}|j |=|j|=| d|dS)z (internal) Decrement the reference count of a cached object. If the reference count is zero, free the reference, then send an 'uncached' directive. @param objectID: The object ID. rsuncacheN) rrrjrSrr+rrrrr)rCrr rrrSrr9r9r: proto_decaches  zBroker.proto_decachecCs|j|}d|_|j|=dS)zx (internal) Tell the client it is now OK to uncache an object. @param objectID: The object ID. N)rrQ)rCrrGr9r9r: proto_uncaches zBroker.proto_uncache)r)NNNN)N)6r5r6r7r8rusernamerrr@rrrrrrrrrrrrrsrrrxrrrrrrrrrrrdr`rrrRrrrrrrrrr rrrrrr9r9r9r:rsd'   (      (   "4     rcCs>t}|||}t}|||||}|S)z Respond to a challenge. This is useful for challenge/response authentication. @param challenge: A challenge. @param password: A password. @return: The password hashed twice. )rupdatedigest) challengepasswordmZhashedPasswordZdoubleHashedPasswordr9r9r:responds    rcCs>d}ttddD]}|ttdd}qt|}|S)z% @return: Some random data. rOAZ)r randomZ randrangechrZrandintrr)Zcraprr9r9r:rs  rc@seZdZdZeZdZdefddZddZ ddZ d d Z d d Z dddZ ddZddZddZddZddZddZd ddZdS)!PBClientFactoryz Client factory for PB brokers. As with all client factories, use with reactor.connectTCP/SSL/etc.. getPerspective and getRootObject can be called either before or after the connect. FcCs||_||_|dS)aE @param unsafeTracebacks: if set, tracebacks for exceptions will be sent over the wire. @type unsafeTracebacks: C{bool} @param security: security options used by the broker, default to C{globalSecurity}. @type security: L{twisted.spread.jelly.SecurityOptions} N)rr_reset)rCrrr9r9r:r@ s zPBClientFactory.__init__cCs|jd|jd}||_|S)zP Build the broker instance, passing the security options to it. Trr)rrr)rCaddrpr9r9r: buildProtocolszPBClientFactory.buildProtocolcCsg|_d|_d|_dSr>)rootObjectRequests_broker_rootrMr9r9r:r $szPBClientFactory._resetcCs&|j}||D]}||qdSr>)r%r r)rCrZ deferredsrr9r9r:_failAll*szPBClientFactory._failAllcCs||dSr>)r()rC connectorrr9r9r:clientConnectionFailed1sz&PBClientFactory.clientConnectionFailedrcCs |rd|_d|_n ||dS)zJ Reconnecting subclasses should call with reconnecting=1. N)r&r'r()rCr)rZ reconnectingr9r9r:clientConnectionLost5sz$PBClientFactory.clientConnectionLostcCs8||_|d|_|j}g|_|D]}||jq"dS)Nroot)r&rr'r%rv)rCrQZdsrr9r9r:rBs  z$PBClientFactory.clientConnectionMadecCs2|jr|jjst|jSt}|j||S)ze Get root object of remote PB server. @return: Deferred of the root object. )r&rrZsucceedr'rr%rq)rCrr9r9r: getRootObjectKs   zPBClientFactory.getRootObjectcCs|jr|jjdS)z If the factory is connected, close the connection. Note that if you set up the factory to reconnect, you will need to implement extra logic to prevent automatic reconnection after this is called. N)r&rrrMr9r9r: disconnectXszPBClientFactory.disconnectcCs|d||j||S)Nlogin)r addCallback _cbResponse)rCr,rrclientr9r9r:_cbSendUsernameds  zPBClientFactory._cbSendUsernamecCs|\}}|dt|||S)Nr)rr)rCZ challengesrr2rZ challengerr9r9r:r1iszPBClientFactory._cbResponsecCs |d|S)ab Attempt an anonymous login on the given remote root object. @type root: L{RemoteReference} @param root: The object on which to attempt the login, most likely returned by a call to L{PBClientFactory.getRootObject}. @param client: A jellyable object which will be used as the I{mind} parameter for the login attempt. @rtype: L{Deferred} @return: A L{Deferred} which will be called back with a L{RemoteReference} to an avatar when anonymous login succeeds, or which will errback if anonymous login fails. ZloginAnonymous)r)rCr,r2r9r9r:_cbLoginAnonymousnsz!PBClientFactory._cbLoginAnonymousNcCs<|}t|r"||j|n||j|j|j||S)a Login and get perspective from remote PB server. Currently the following credentials are supported:: L{twisted.cred.credentials.IUsernamePassword} L{twisted.cred.credentials.IAnonymous} @rtype: L{Deferred} @return: A L{Deferred} which will be called back with a L{RemoteReference} for the avatar logged in to, or which will errback if login fails. )r-r providedByr0r4r3rr)rCZ credentialsr2rr9r9r:r/s zPBClientFactory.login)r)N)r5r6r7r8rrrrr@r$r r(r*r+rr-r.r3r1r4r/r9r9r9r:rs      rc@s6eZdZdZdZeZdefddZddZ ddZ d S) PBServerFactorya Server factory for perspective broker. Login is done using a Portal object, whose realm is expected to return avatars implementing IPerspective. The credential checkers in the portal should accept IUsernameHashedPassword or IUsernameMD5Password. Alternatively, any object providing or adaptable to L{IPBRoot} can be used instead of a portal to provide the root object of the PB server. FcCst||_||_||_dS)a @param root: factory providing the root Referenceable used by the broker. @type root: object providing or adaptable to L{IPBRoot}. @param unsafeTracebacks: if set, tracebacks for exceptions will be sent over the wire. @type unsafeTracebacks: C{bool} @param security: security options used by the broker, default to C{globalSecurity}. @type security: L{twisted.spread.jelly.SecurityOptions} N)r#r,rr)rCr,rrr9r9r:r@s zPBServerFactory.__init__cCs.|jd|jd}||_|d|j||S)zT Return a Broker attached to the factory (as the service provider). Fr!r,)rrrrr, rootObject)rCr"protor9r9r:r$szPBServerFactory.buildProtocolcCsdSr>r9)rCrr9r9r:rsz$PBServerFactory.clientConnectionMadeN) r5r6r7r8rrrrr@r$rr9r9r9r:r6s   r6c@s eZdZdZddZddZdS)IUsernameMD5Passwordab I encapsulate a username and a hashed password. This credential is used for username/password over PB. CredentialCheckers which check this kind of credential must store the passwords in plaintext form or as a MD5 digest. @type username: C{str} or C{Deferred} @ivar username: The username associated with these credentials. cCsdS)a Validate these credentials against the correct password. @type password: C{str} @param password: The correct, plaintext password against which to check. @rtype: C{bool} or L{Deferred} @return: C{True} if the credentials represented by this object match the given password, C{False} if they do not, or a L{Deferred} which will be called back with one of these values. Nr9rr9r9r: checkPasswordsz"IUsernameMD5Password.checkPasswordcCsdS)a Validate these credentials against the correct MD5 digest of the password. @type password: C{str} @param password: The correct MD5 digest of a password against which to check. @rtype: C{bool} or L{Deferred} @return: C{True} if the credentials represented by this object match the given digest, C{False} if they do not, or a L{Deferred} which will be called back with one of these values. Nr9r:r9r9r:checkMD5Passwordsz%IUsernameMD5Password.checkMD5PasswordN)r5r6r7r8r;r<r9r9r9r:r9s r9c@s eZdZdZddZddZdS) _PortalRootz/ Root object, used to login to portal. cCs ||_dSr>)portal)rCr>r9r9r:r@sz_PortalRoot.__init__cCs t|j|Sr>)_PortalWrapperr>)rCrQr9r9r:r7sz_PortalRoot.rootObjectN)r5r6r7r8r@r7r9r9r9r:r=sr=c@seZdZdZddZdS)_JellyableAvatarMixinzk Helper class for code which deals with avatars which PB must be capable of sending to a peer. csT|\}}t|st|d}|}gfdd}||jj|<|j||S)z Ensure that the avatar to be returned to the client is jellyable and set up disconnection notification to call the realm's logout object. rScs sdSd}d=|dSrr9)fnZlogoutr9r: maybeLogouts z3_JellyableAvatarMixin._cbLogin..maybeLogout)rr5rgrrQrrs)rCresultZ interfaceZavatarrrCr9rBr:_cbLogins      z_JellyableAvatarMixin._cbLoginN)r5r6r7r8rEr9r9r9r:r@ sr@c@s(eZdZdZddZddZddZdS) r?z= Root Referenceable object, used to login to portal. cCs||_||_dSr>)r>rQ)rCr>rQr9r9r:r@1sz_PortalWrapper.__init__cCst}|t|j|j||fS)z[ Start of username/password login. @param username: The username. )r_PortalAuthChallengerr>rQ)rCrcr9r9r: remote_login6sz_PortalWrapper.remote_logincCs"|jt|t}||j|S)aU Attempt an anonymous login. @param mind: An object to use as the mind parameter to the portal login call (possibly None). @rtype: L{Deferred} @return: A Deferred which will be called back with an avatar when login succeeds or which will be errbacked if login fails somehow. )r>r/rrZr0rE)rCmindrr9r9r:remote_loginAnonymous@s  z$_PortalWrapper.remote_loginAnonymousN)r5r6r7r8r@rHrJr9r9r9r:r?,s r?c@s0eZdZdZddZddZddZdd Zd S) rFz5 Called with response to password challenge. cCs||_||_||_||_dSr>)r>rQrr)rCr>rQrrr9r9r:r@Vsz_PortalAuthChallenger.__init__cCs&||_|j||t}||j|Sr>)responser>r/rZr0rE)rCrKrIrr9r9r:remote_respond]s z$_PortalAuthChallenger.remote_respondcCs|t|S)z L{IUsernameHashedPassword} @param password: The password. @return: L{_PortalAuthChallenger.checkMD5Password} )r<rr)rCrr9r9r:r;dsz#_PortalAuthChallenger.checkPasswordcCs.t}||||j|}|j|kS)z L{IUsernameMD5Password} @param md5Password: @rtype: L{bool} @return: L{True} if password matches. )rrrrrK)rCZ md5PasswordZmdZcorrectr9r9r:r<ns   z&_PortalAuthChallenger.checkMD5PasswordN)r5r6r7r8r@rLr;r<r9r9r9r:rFQs  rFr#rr r!r"r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2rportno)r)cr8Z __future__rrrZhashlibrZzope.interfacerrZtwisted.pythonrrr Ztwisted.python.compatr r rr r rZtwisted.internetrrZtwisted.cred.portalrZtwisted.cred.credentialsrrrrZtwisted.persistedrZtwisted.python.componentsrZtwisted.spread.interfacesrrZtwisted.spread.jellyrrrrZtwisted.spreadrZtwisted.spread.flavorsrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2rrMr?r3r;r<r=rFrYrZr_rgZ EphemeralrkrrrrrrrrrZ ClientFactoryrZ ServerFactoryr6r9r=r@r?rF__all__r9r9r9r:s                      *)  (+  R 3, !%-