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
25 /** The CullItem class holds a user and their quitmessage,
26 * and is used internally by the CullList class to compile
27 * a list of users which are to be culled when a long
28 * operation (such as a netsplit) has completed.
30 class CoreExport CullItem : public classbase
33 /** Holds a pointer to the user,
34 * must be valid and can be a local or remote user.
37 /** Holds the quit reason to use for this user.
40 /** Holds the quit reason opers see, if different from users
42 std::string oper_reason;
43 /** Silent items dont generate an snotice.
48 * Initializes the CullItem with a user pointer
49 * and their quit reason
50 * @param u The user to add
51 * @param r The quit reason of the added user
52 * @param ro The quit reason to show to opers only
54 CullItem(User* u, std::string &r, const char* ro = "");
56 * Initializes the CullItem with a user pointer
57 * and their quit reason
58 * @param u The user to add
59 * @param r The quit reason of the added user
60 * @param ro The quit reason to show to opers only
62 CullItem(User* u, const char* r, const char* ro = "");
64 /** Make the quit silent a module is dealing with
65 * displaying this users quit, so we shouldn't
70 /** Returns true if the quit for this user has been set
79 /** Returns a pointer to the user
82 /** Returns the user's quit reason
84 std::string& GetReason();
85 /** Returns oper reason
87 std::string& GetOperReason();
90 /** The CullList class can be used by modules, and is used
91 * by the core, to compile large lists of users in preperation
92 * to quitting them all at once. This is faster than quitting
93 * them within the loop, as the loops become tighter with
94 * little or no comparisons within them. The CullList class
95 * operates by allowing the programmer to push users onto
96 * the list, each with a seperate quit reason, and then, once
97 * the list is complete, call a method to flush the list,
98 * quitting all the users upon it. A CullList may hold local
99 * or remote users, but it may only hold each user once. If
100 * you attempt to add the same user twice, then the second
101 * attempt will be ignored.
103 class CoreExport CullList : public classbase
106 /** Creator of this CullList
108 InspIRCd* ServerInstance;
110 /** Holds a list of users already added for quick lookup
112 std::map<User*, User*> exempt;
114 /** Holds a list of users being quit.
115 * See the information for CullItem for
118 std::vector<CullItem> list;
122 * Clears the CullList::list and CullList::exempt
124 * @param Instance Creator of this CullList object
126 CullList(InspIRCd* Instance);
128 /** Adds a user to the cull list for later
130 * @param user The user to add
131 * @param reason The quit reason of the user being added
132 * @param o_reason The quit reason to show only to opers
134 void AddItem(User* user, std::string &reason, const char* o_reason = "");
136 /** Adds a user to the cull list for later
138 * @param user The user to add
139 * @param reason The quit reason of the user being added
140 * @param o_reason The quit reason to show only to opers
142 void AddItem(User* user, const char* reason, const char* o_reason = "");
144 /* Turn an item into a silent item (don't send out QUIT for this user)
146 void MakeSilent(User* user);
148 /** Applies the cull list, quitting all the users
149 * on the list with their quit reasons all at once.
150 * This is a very fast operation compared to
151 * iterating the user list and comparing each one,
152 * especially if there are multiple comparisons
153 * to be done, or recursion.
154 * @returns The number of users removed from IRC.