OwlCyberSecurity - MANAGER
Edit File: iwords.pyc
� `��ac @ s� d d l m Z m Z d e f d � � YZ d e f d � � YZ d e f d � � YZ d e f d � � YZ d e f d � � YZ d d d d g Z d S( i����( t Interfacet Attributet IProtocolPluginc B s# e Z d Z e d � Z d � Z RS( sD Interface for plugins providing an interface to a Words service sH A single word describing what kind of interface this is (eg, irc or web)c C s d S( sb Retrieve a C{twisted.internet.interfaces.IServerFactory} provider @param realm: An object providing C{twisted.cred.portal.IRealm} and L{IChatService}, with which service information should be looked up. @param portal: An object providing C{twisted.cred.portal.IPortal}, through which logins should be performed. N( ( t realmt portal( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt getFactory t ( t __name__t __module__t __doc__R t nameR ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR s t IGroupc B sM e Z e d � Z d � Z d d � Z d � Z d � Z d � Z d � Z RS( s$ A short string, unique among groups.c C s d S( sL Include the given user in this group. @type user: L{IUser} N( ( t user( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt add R c C s d S( sn Remove the given user from this group. @type user: L{IUser} @type reason: C{unicode} N( ( R t reason( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt remove" R c C s d S( s� Return the number of participants in this group. @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with an C{int} representing the number of participants in this group. N( ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt size) R c C s d S( sY Broadcast the given message from the given sender to other users in group. The message is not re-transmitted to the sender. @param sender: L{IUser} @type recipient: L{IGroup} @param recipient: This is probably a wart. Maybe it will be removed in the future. For now, it should be the group object the message is being delivered to. @param message: C{dict} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with None when delivery has been attempted for all users. N( ( t sendert recipientt message( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt receive1 R c C s d S( sU Change the metadata associated with this group. @type meta: C{dict} N( ( t meta( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt setMetadataF R c C s d S( s7 Return an iterator of all users in this group. N( ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt iterusersL R N( R R R R R t NoneR R R R R ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR s t IChatClientc B sA e Z d Z e d � Z d � Z d � Z d � Z d d � Z RS( sA Interface through which IChatService interacts with clients. s[ A short string, unique among users. This will be set by the L{IChatService} at login time.c C s d S( s^ Callback notifying this user of the given message sent by the given user. This will be invoked whenever another user sends a message to a group this user is participating in, or whenever another user sends a message directly to this user. In the former case, C{recipient} will be the group to which the message was sent; in the latter, it will be the same object as the user who is receiving the message. @type sender: L{IUser} @type recipient: L{IUser} or L{IGroup} @type message: C{dict} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires when the message has been delivered, or which fails in some way. If the Deferred fails and the message was directed at a group, this user will be removed from that group. N( ( R R R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR W R c C s d S( s� Callback notifying this user that the metadata for the given group has changed. @type group: L{IGroup} @type meta: C{dict} @rtype: L{twisted.internet.defer.Deferred} N( ( t groupR ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt groupMetaUpdatel R c C s d S( s� Callback notifying this user that the given user has joined the given group. @type group: L{IGroup} @type user: L{IUser} @rtype: L{twisted.internet.defer.Deferred} N( ( R R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt userJoinedw R c C s d S( s Callback notifying this user that the given user has left the given group for the given reason. @type group: L{IGroup} @type user: L{IUser} @type reason: C{unicode} @rtype: L{twisted.internet.defer.Deferred} N( ( R R R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt userLeft� R N( R R R R R R R R R R ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR Q s t IUserc B sw e Z d Z e d � Z e d � Z e d � Z e d � Z e d � Z d � Z d � Z d � Z d � Z d � Z RS( s@ Interface through which clients interact with IChatService. s_ A reference to the Realm to which this user belongs. Set if and only if the user is logged in.s` A reference to the mind which logged in to this user. Set if and only if the user is logged in.s# A short string, unique among users.sR A POSIX timestamp indicating the time of the last message received from this user.sB A POSIX timestamp indicating this user's most recent sign on time.c C s d S( s� Invoked by the associated L{IChatService} when login occurs. @param realm: The L{IChatService} through which login is occurring. @param mind: The mind object used for cred login. N( ( R t mind( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt loggedIn� R c C s d S( s� Send the given message to the given user or group. @type recipient: Either L{IUser} or L{IGroup} @type message: C{dict} N( ( R R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt send� R c C s d S( s| Attempt to join the given group. @type group: L{IGroup} @rtype: L{twisted.internet.defer.Deferred} N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt join� R c C s d S( s� Discontinue participation in the given group. @type group: L{IGroup} @rtype: L{twisted.internet.defer.Deferred} N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt leave� R c C s d S( sZ Return an iterator of all groups of which this user is a member. N( ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt itergroups� R ( R R R R R R R t lastMessaget signOnR R! R" R# R$ ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR � s t IChatServicec B sb e Z e d � Z e d � Z e d � Z d � Z d � Z d � Z d � Z d � Z d � Z RS( s= A short string identifying this chat service (eg, a hostname)sx A boolean indicating whether L{getGroup} should implicitly create groups which are requested but which do not yet exist.sv A boolean indicating whether L{getUser} should implicitly create users which are requested but which do not yet exist.c C s d S( s� Return all groups available on this service. @rtype: C{twisted.internet.defer.Deferred} @return: A Deferred which fires with a list of C{IGroup} providers. N( ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR$ � R c C s d S( s� Retrieve the group by the given name. @type name: C{str} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with the group with the given name if one exists (or if one is created due to the setting of L{IChatService.createGroupOnRequest}, or which fails with L{twisted.words.ewords.NoSuchGroup} if no such group exists. N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt getGroup� R c C s d S( s2 Create a new group with the given name. @type name: C{str} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with the created group, or with fails with L{twisted.words.ewords.DuplicateGroup} if a group by that name exists already. N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt createGroup� R c C s d S( sE Retrieve a group by name. Unlike C{getGroup}, this will never implicitly create a group. @type name: C{str} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with the group by the given name, or which fails with L{twisted.words.ewords.NoSuchGroup}. N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt lookupGroup� R c C s d S( s� Retrieve the user by the given name. @type name: C{str} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with the user with the given name if one exists (or if one is created due to the setting of L{IChatService.createUserOnRequest}, or which fails with L{twisted.words.ewords.NoSuchUser} if no such user exists. N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt getUser� R c C s d S( s. Create a new user with the given name. @type name: C{str} @rtype: L{twisted.internet.defer.Deferred} @return: A Deferred which fires with the created user, or with fails with L{twisted.words.ewords.DuplicateUser} if a user by that name exists already. N( ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt createUser� R ( R R R R t createGroupOnRequestt createUserOnRequestR$ R( R) R* R+ R, ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyR' � s N( t zope.interfaceR R R R R R R' t __all__( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/words/iwords.pyt <module> s 8>.M