1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __CULLLIST_H__
15 #define __CULLLIST_H__
17 // include the common header files
27 /** The CullItem class holds a user and their quitmessage,
28 * and is used internally by the CullList class to compile
29 * a list of users which are to be culled when a long
30 * operation (such as a netsplit) has completed.
32 class CoreExport CullItem : public classbase
35 /** Holds a pointer to the user,
36 * must be valid and can be a local or remote user.
39 /** Holds the quit reason to use for this user.
42 /** Holds the quit reason opers see, if different from users
44 std::string oper_reason;
45 /** Silent items dont generate an snotice.
50 * Initializes the CullItem with a user pointer
51 * and their quit reason
52 * @param u The user to add
53 * @param r The quit reason of the added user
54 * @param ro The quit reason to show to opers only
56 CullItem(User* u, std::string &r, const char* ro = "");
58 * Initializes the CullItem with a user pointer
59 * and their quit reason
60 * @param u The user to add
61 * @param r The quit reason of the added user
62 * @param ro The quit reason to show to opers only
64 CullItem(User* u, const char* r, const char* ro = "");
66 /** Make the quit silent a module is dealing with
67 * displaying this users quit, so we shouldn't
72 /** Returns true if the quit for this user has been set
81 /** Returns a pointer to the user
84 /** Returns the user's quit reason
86 std::string& GetReason();
87 /** Returns oper reason
89 std::string& GetOperReason();
92 /** The CullList class can be used by modules, and is used
93 * by the core, to compile large lists of users in preperation
94 * to quitting them all at once. This is faster than quitting
95 * them within the loop, as the loops become tighter with
96 * little or no comparisons within them. The CullList class
97 * operates by allowing the programmer to push users onto
98 * the list, each with a seperate quit reason, and then, once
99 * the list is complete, call a method to flush the list,
100 * quitting all the users upon it. A CullList may hold local
101 * or remote users, but it may only hold each user once. If
102 * you attempt to add the same user twice, then the second
103 * attempt will be ignored.
105 class CoreExport CullList : public classbase
108 /** Creator of this CullList
110 InspIRCd* ServerInstance;
112 /** Holds a list of users already added for quick lookup
114 std::map<User*, User*> exempt;
116 /** Holds a list of users being quit.
117 * See the information for CullItem for
120 std::vector<CullItem> list;
124 * Clears the CullList::list and CullList::exempt
126 * @param Instance Creator of this CullList object
128 CullList(InspIRCd* Instance);
130 /** Adds a user to the cull list for later
132 * @param user The user to add
133 * @param reason The quit reason of the user being added
134 * @param o_reason The quit reason to show only to opers
136 void AddItem(User* user, std::string &reason, const char* o_reason = "");
138 /** Adds a user to the cull list for later
140 * @param user The user to add
141 * @param reason The quit reason of the user being added
142 * @param o_reason The quit reason to show only to opers
144 void AddItem(User* user, const char* reason, const char* o_reason = "");
146 /* Turn an item into a silent item (don't send out QUIT for this user)
148 void MakeSilent(User* user);
150 /** Applies the cull list, quitting all the users
151 * on the list with their quit reasons all at once.
152 * This is a very fast operation compared to
153 * iterating the user list and comparing each one,
154 * especially if there are multiple comparisons
155 * to be done, or recursion.
156 * @returns The number of users removed from IRC.