U n5{i%@sdZddlmZddlmZddlmZmZddlm Z ddl m Z ddl m Z ddlmZmZGd d d ZGd d d ZGd ddZGddde jZdS)zyInstance Messenger base classes for protocol support. You will find these useful if you're adding a new protocol to IM. )Type)error)ProtocolconnectionDone)styles)FailureprefixedMethods)OFFLINE OfflineErrorc@sPeZdZddZddZddZddZd d Zed d d Z ed ddZ dS) AbstractGroupcCs||_||_dSN)nameaccount)selfrrr@/tmp/pip-unpacked-wheel-mnhg7r0q/twisted/words/im/basesupport.py__init__szAbstractGroup.__init__cCs t|dS)zfinds group commands these commands are methods on me that start with imgroup_; they are called with no arguments Zimgroup_rrrrrgetGroupCommandsszAbstractGroup.getGroupCommandscCs t|dS)a(finds group commands these commands are methods on me that start with imgroup_; they are called with a user present within this room as an argument you may want to override this in your group in order to filter for appropriate commands on the given user Z imtarget_r)rtargetrrrgetTargetCommands#s zAbstractGroup.getTargetCommandscCs |jjs t|jj|jdSr )rclientr Z joinGrouprrrrrjoin.szAbstractGroup.joincCs |jjs t|jj|jdSr )rrr Z leaveGrouprrrrrleave3szAbstractGroup.leavereturncCsd|jd|jdS)N< >) __class__rrrrr__repr__8szAbstractGroup.__repr__cCs|jd|jjSN@rr accountNamerrrr__str__;szAbstractGroup.__str__N) __name__ __module__ __qualname__rrrrrstrr!r&rrrrr s r c@s@eZdZddZddZddZeddd Zedd d Zd S) AbstractPersoncCs||_||_t|_dSr )rrr status)rrZ baseAccountrrrr@szAbstractPerson.__init__cCs t|dS)zfinds person commands these commands are methods on me that start with imperson_; they are called with no arguments Z imperson_rrrrrgetPersonCommandsEsz AbstractPerson.getPersonCommandscCsdS)z# Returns a string. z--rrrrr getIdleTimeMszAbstractPerson.getIdleTimercCsd|jd|jd|jdS)Nrr/r)r rr,rrrrr!SszAbstractPerson.__repr__cCs|jd|jjSr"r$rrrrr&VszAbstractPerson.__str__N) r'r(r)rr-r.r*r!r&rrrrr+?s r+c@sNeZdZUdZdZeeed<ddZddZ e fe ddd d Z d d Z dS) AbstractClientMixinzDesigned to be mixed in to a Protocol implementing class. Inherit from me first. @ivar _logonDeferred: Fired when I am done logging in. N _protoBasecCs:|jjD]}t|tr||j_q$q||_||_||_dSr )r __bases__ issubclassrr1rchatZ_logonDeferred)rrchatuiZ logonDeferredbaserrrrds  zAbstractClientMixin.__init__cCs|j|dSr )r1connectionMaderrrrr7osz"AbstractClientMixin.connectionMade)reasonrcCs$|j||||j||Sr )r _clientLostunregisterAsAccountClientr1connectionLostrr8rrrr;rsz"AbstractClientMixin.connectionLostcCs|j|dS)z*Tell the chat UI that I have `signed off'.N)r4ZunregisterAccountClientrrrrr:wsz-AbstractClientMixin.unregisterAsAccountClient)r'r(r)__doc__r1rr__annotations__rr7rrr;r:rrrrr0Zs  r0c@seZdZdZdZdZdZeZe Z dZ ddZ ddZ d d Zd d Zd dZddZddZddZddZddZddZedddZdS)AbstractAccountaBase class for Accounts. I am the start of an implementation of L{IAccount}, I implement L{isOnline} and most of L{logOn}, though you'll need to implement L{_startLogOn} in a subclass. @cvar _groupFactory: A Callable that will return a L{IGroup} appropriate for this account type. @cvar _personFactory: A Callable that will return a L{IPerson} appropriate for this account type. @type _isConnecting: boolean @ivar _isConnecting: Whether I am in the process of establishing a connection to the server. @type _isOnline: boolean @ivar _isOnline: Whether I am currently on-line with the server. @ivar accountName: @ivar autoLogin: @ivar username: @ivar password: @ivar host: @ivar port: rNcCs4||_||_||_||_||_||_i|_i|_dSr )r% autoLoginusernamepasswordhostport_groups_persons)rr%rArBrCrDrErrrrszAbstractAccount.__init__cCs$dD]}t||st||iqdS)N)rFrG)hasattrsetattr)rkrrrupgrateToVersion2s z!AbstractAccount.upgrateToVersion2c Cs:tj|}dD]$}z ||=Wqtk r2YqXq|S)N)r _isOnline _isConnecting)r Versioned __getstate__KeyError)rstaterJrrrrOs  zAbstractAccount.__getstate__cCs|jSr )rLrrrrisOnlineszAbstractAccount.isOnlinecCsR|jsD|jsDd|_||}||j||j||j|St ddS)a=Log on to this account. Takes care to not start a connection if a connection is already in progress. You will need to implement L{_startLogOn} for this to work, and it would be a good idea to override L{_loginFailed} too. @returntype: Deferred L{interfaces.IClient} zConnection in progressN) rMrL _startLogOnZ addCallback _cb_logOnZregisterAccountClientZ addErrback _loginFailedrZ ConnectError)rr5drrrlogOns     zAbstractAccount.logOncCs.|j|}|dkr*|||}||j|<|S)zkGroup factory. @param name: Name of the group on this account. @type name: string N)rFget _groupFactory)rrgrouprrrgetGroups    zAbstractAccount.getGroupcCs.|j|}|dkr*|||}||j|<|S)zmPerson factory. @param name: Name of the person on this account. @type name: string N)rGrY_personFactory)rrZpersonrrr getPersons    zAbstractAccount.getPersoncCs tdS)z{Start the sign on process. Factored out of L{logOn}. @returntype: Deferred L{interfaces.IClient} N)NotImplementedError)rr5rrrrTszAbstractAccount._startLogOncCsd|_d|_||_|S)NrrS)rMrLr)rrrrrrUszAbstractAccount._cb_logOncCsd|_d|_|S)zErrorback for L{logOn}. @type reason: Failure @returns: I{reason}, for further processing in the callback chain. @returntype: Failure r)rMrLr<rrrrVszAbstractAccount._loginFailedcCsd|_d|_d|_|S)Nr)rrMrL)rrr8rrrr9szAbstractAccount._clientLostrcCsd|j|j|j|j|jS)Nz<{}: {} ({}@{}:{})>)formatr r%rBrDrErrrrr! szAbstractAccount.__repr__)r'r(r)r=rLrMrr rZr+r]ZpersistanceVersionrrKrOrRrXr\r^rTrUrVr9r*r!rrrrr?|s&      r?N)r=typingrZtwisted.internetrZtwisted.internet.protocolrrZtwisted.persistedrZtwisted.python.failurerZtwisted.python.reflectr Ztwisted.words.im.localsr r r r+r0rNr?rrrrs     )"