
    Vh!                         d dl mZmZ  G d de      Z G d de      Z G d de      Z G d d	e      Z G d
 de      Zg dZy)    )	Attribute	Interfacec                   &    e Zd ZdZ ed      Zd Zy)IProtocolPluginz?Interface for plugins providing an interface to a Words servicezHA single word describing what kind of interface this is (eg, irc or web)c                      y)ab  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 )realmportals     D/home/dcms/DCMS/lib/python3.12/site-packages/twisted/words/iwords.py
getFactoryzIProtocolPlugin.getFactory           N)__name__
__module____qualname____doc__r   namer   r   r   r   r   r      s    IRDr   r   c                   B    e Zd Z ed      Zd Zd	dZd Zd Zd Z	d Z
y)
IGroupz$A short string, unique among groups.c                      y)zLInclude the given user in this group.

        @type user: L{IUser}
        Nr   )users    r   addz
IGroup.add   r   r   Nc                      y)znRemove the given user from this group.

        @type user: L{IUser}
        @type reason: C{unicode}
        Nr   )r   reasons     r   removezIGroup.remove#   r   r   c                       y)zReturn 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.
        Nr   r   r   r   sizezIGroup.size*   r   r   c                      y)aY  
        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.
        Nr   sender	recipientmessages      r   receivezIGroup.receive2   r   r   c                      y)zUChange the metadata associated with this group.

        @type meta: C{dict}
        Nr   )metas    r   setMetadatazIGroup.setMetadataG   r   r   c                       y)z.Return an iterator of all users in this group.Nr   r   r   r   	iteruserszIGroup.iterusersM   r   r   N)r   r   r   r   r   r   r   r   r#   r&   r(   r   r   r   r   r      s+    ;<D*=r   r   c                   :    e Zd ZdZ ed      Zd Zd Zd ZddZ	y)	IChatClientz<Interface through which IChatService interacts with clients.z[A short string, unique among users.  This will be set by the L{IChatService} at login time.c                      y)a^  
        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.
        Nr   r   s      r   r#   zIChatClient.receiveX   r   r   c                      y)z
        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}
        Nr   )groupr%   s     r   groupMetaUpdatezIChatClient.groupMetaUpdatem   r   r   c                      y)z
        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}
        Nr   )r.   r   s     r   
userJoinedzIChatClient.userJoinedx   r   r   Nc                      y)a  
        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}
        Nr   )r.   r   r   s      r   userLeftzIChatClient.userLeft   r   r   r)   )
r   r   r   r   r   r   r#   r/   r1   r3   r   r   r   r+   r+   Q   s&    FeD*		
r   r+   c                   ~    e Zd 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y)IUserz;Interface through which clients interact with IChatService.z_A reference to the Realm to which this user belongs.  Set if and only if the user is logged in.z`A reference to the mind which logged in to this user.  Set if and only if the user is logged in.z#A short string, unique among users.zRA POSIX timestamp indicating the time of the last message received from this user.zBA POSIX timestamp indicating this user's most recent sign on time.c                      y)zInvoked 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.
        Nr   )r	   minds     r   loggedInzIUser.loggedIn   r   r   c                      y)zSend the given message to the given user or group.

        @type recipient: Either L{IUser} or L{IGroup}
        @type message: C{dict}
        Nr   )r!   r"   s     r   sendz
IUser.send   r   r   c                      y)z|Attempt to join the given group.

        @type group: L{IGroup}
        @rtype: L{twisted.internet.defer.Deferred}
        Nr   r.   s    r   joinz
IUser.join   r   r   c                      y)zDiscontinue participation in the given group.

        @type group: L{IGroup}
        @rtype: L{twisted.internet.defer.Deferred}
        Nr   r<   s    r   leavezIUser.leave   r   r   c                       y)zZ
        Return an iterator of all groups of which this user is a
        member.
        Nr   r   r   r   
itergroupszIUser.itergroups   r   r   N)r   r   r   r   r   r	   r7   r   lastMessagesignOnr8   r:   r=   r?   rA   r   r   r   r5   r5      sc    EiE jD :;D\K LFr   r5   c                   `    e Zd Z ed      Z ed      Z ed      Zd Zd Zd Z	d Z
d Zd	 Zy
)IChatServicez=A short string identifying this chat service (eg, a hostname)zxA boolean indicating whether L{getGroup} should implicitly create groups which are requested but which do not yet exist.zvA boolean indicating whether L{getUser} should implicitly create users which are requested but which do not yet exist.c                       y)zReturn all groups available on this service.

        @rtype: C{twisted.internet.defer.Deferred}
        @return: A Deferred which fires with a list of C{IGroup} providers.
        Nr   r   r   r   rA   zIChatService.itergroups   r   r   c                      y)a  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.
        Nr   r   s    r   getGroupzIChatService.getGroup   r   r   c                      y)a2  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.
        Nr   rH   s    r   createGroupzIChatService.createGroup   r   r   c                      y)aE  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}.
        Nr   rH   s    r   lookupGroupzIChatService.lookupGroup   r   r   c                      y)a  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.
        Nr   rH   s    r   getUserzIChatService.getUser   r   r   c                      y)a.  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.
        Nr   rH   s    r   
createUserzIChatService.createUser  r   r   N)r   r   r   r   r   createGroupOnRequestcreateUserOnRequestrA   rI   rK   rM   rO   rQ   r   r   r   rE   rE      sO    TUD$	H
 $	G

	

	r   rE   )r   r+   r5   rE   N)	zope.interfacer   r   r   r   r+   r5   rE   __all__r   r   r   <module>rV      sS   
 0i $4=Y 4=n<) <~2I 2jL9 L^r   