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 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;
47 * Initializes the CullItem with a user pointer
48 * and their quit reason
49 * @param u The user to add
50 * @param r The quit reason of the added user
52 CullItem(userrec* u, std::string &r, const char* ro = "");
53 CullItem(userrec* u, const char* r, const char* ro = "");
57 /** Returns a pointer to the user
60 /** Returns the user's quit reason
62 std::string& GetReason();
63 /** Returns oper reason
65 std::string& GetOperReason();
68 /** The CullList class can be used by modules, and is used
69 * by the core, to compile large lists of users in preperation
70 * to quitting them all at once. This is faster than quitting
71 * them within the loop, as the loops become tighter with
72 * little or no comparisons within them. The CullList class
73 * operates by allowing the programmer to push users onto
74 * the list, each with a seperate quit reason, and then, once
75 * the list is complete, call a method to flush the list,
76 * quitting all the users upon it. A CullList may hold local
77 * or remote users, but it may only hold each user once. If
78 * you attempt to add the same user twice, then the second
79 * attempt will be ignored.
81 class CullList : public classbase
84 /** Creator of this CullList
86 InspIRCd* ServerInstance;
88 /** Holds a list of users already added for quick lookup
90 std::map<userrec*, userrec*> exempt;
92 /** Holds a list of users being quit.
93 * See the information for CullItem for
96 std::vector<CullItem> list;
100 * Clears the CullList::list and CullList::exempt
102 * @param Instance Creator of this CullList object
104 CullList(InspIRCd* Instance);
106 /** Adds a user to the cull list for later
108 * @param user The user to add
109 * @param reason The quit reason of the user being added
111 void AddItem(userrec* user, std::string &reason, const char* o_reason = "");
112 void AddItem(userrec* user, const char* reason, const char* o_reason = "");
114 /** Applies the cull list, quitting all the users
115 * on the list with their quit reasons all at once.
116 * This is a very fast operation compared to
117 * iterating the user list and comparing each one,
118 * especially if there are multiple comparisons
119 * to be done, or recursion.
120 * @returns The number of users removed from IRC.