Remove ProtocolInterface::PushToClient()

[user/henk/code/inspircd.git] / include / channels.h

diff --git a/include/channels.h b/include/channels.h
index 628f34f9f995a46bb6dee2b81092f77cbf4c9957..0a131ddb35eca048542de758537c2a835819bbdb 100644 (file)
--- a/include/channels.h
+++ b/include/channels.h
@@ -34,8 +34,14 @@
  * This class represents a channel, and contains its name, modes, topic, topic set time,
  * etc, and an instance of the BanList type.
  */
-class CoreExport Channel : public Extensible, public InviteBase<Channel>
+class CoreExport Channel : public Extensible
 {
+ public:
+       /** A map of Memberships on a channel keyed by User pointers
+        */
+       typedef std::map<User*, insp::aligned_storage<Membership> > MemberMap;
+
+ private:
        /** Set default modes for the channel on creation
         */
        void SetDefaultModes();
@@ -51,9 +57,9 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
         * This function does not remove the channel from User::chanlist.
         * Since the parameter is an iterator to the target, the complexity
         * of this function is constant.
-        * @param membiter The UserMembIter to remove, must be valid
+        * @param membiter The MemberMap iterator to remove, must be valid
         */
-       void DelUser(const UserMembIter& membiter);
+       void DelUser(const MemberMap::iterator& membiter);
 
  public:
        /** Creates a channel record and initialises it with default values
@@ -84,7 +90,7 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
 
        /** User list.
         */
-       UserMembList userlist;
+       MemberMap userlist;
 
        /** Channel topic.
         * If this is an empty string, no channel topic is set.
@@ -166,7 +172,7 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
         *
         * @return This function returns pointer to a map of User pointers (CUList*).
         */
-       const UserMembList* GetUsers() const { return &userlist; }
+       const MemberMap& GetUsers() const { return userlist; }
 
        /** Returns true if the user given is on the given channel.
         * @param user The user to look for
@@ -178,18 +184,30 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
 
        /** Make src kick user from this channel with the given reason.
         * @param src The source of the kick
-        * @param user The user being kicked (must be on this channel)
+        * @param victimiter Iterator to the user being kicked, must be valid
+        * @param reason The reason for the kick
+        */
+       void KickUser(User* src, const MemberMap::iterator& victimiter, const std::string& reason);
+
+       /** Make src kick user from this channel with the given reason.
+        * @param src The source of the kick
+        * @param user The user being kicked
         * @param reason The reason for the kick
-        * @param srcmemb The membership of the user who does the kick, can be NULL
         */
-       void KickUser(User* src, User* user, const std::string& reason, Membership* srcmemb = NULL);
+       void KickUser(User* src, User* user, const std::string& reason)
+       {
+               MemberMap::iterator it = userlist.find(user);
+               if (it != userlist.end())
+                       KickUser(src, it, reason);
+       }
 
        /** Part a user from this channel with the given reason.
         * If the reason field is NULL, no reason will be sent.
         * @param user The user who is parting (must be on this channel)
         * @param reason The part reason
+        * @return True if the user was on the channel and left, false if they weren't and nothing happened
         */
-       void PartUser(User *user, std::string &reason);
+       bool PartUser(User* user, std::string& reason);
 
        /** Join a local user to a channel, with or without permission checks. May be a channel that doesn't exist yet.
         * @param user The user to join to the channel.
@@ -207,8 +225,9 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
         * @param privs Priviliges (prefix mode letters) to give to this user, may be NULL
         * @param bursting True if this join is the result of a netburst (passed to modules in the OnUserJoin hook)
         * @param created_by_local True if this channel was just created by a local user (passed to modules in the OnUserJoin hook)
+        * @return A newly created Membership object, or NULL if the user was already inside the channel or if the user is a server user
         */
-       void ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false);
+       Membership* ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false);
 
        /** Write to a channel, from a user, using va_args for text
         * @param user User whos details to prefix the line with
@@ -287,11 +306,6 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
         */
        const char* ChanModes(bool showkey);
 
-       /** Spool the NAMES list for this channel to the given user
-        * @param user The user to spool the NAMES list to
-        */
-       void UserList(User *user);
-
        /** Get the value of a users prefix on this channel.
         * @param user The user to look up
         * @return The module or core-defined value of the users prefix.
@@ -318,6 +332,11 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
        /** Get the status of an "action" type extban
         */
        ModResult GetExtBanStatus(User *u, char type);
+
+       /** Write a NOTICE to all local users on the channel
+        * @param text Text to send
+        */
+       void WriteNotice(const std::string& text);
 };
 
 inline bool Channel::HasUser(User* user)