-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __CULLLIST_H__\r#define __CULLLIST_H__\r\r// include the common header files\r\r#include <string>\r#include <deque>\r#include <vector>\r#include "users.h"\r#include "channels.h"\r\rclass InspIRCd;\r\r/** The CullItem class holds a user and their quitmessage,\r * and is used internally by the CullList class to compile\r * a list of users which are to be culled when a long\r * operation (such as a netsplit) has completed.\r */\rclass CoreExport CullItem : public classbase\r{\r private:\r /** Holds a pointer to the user,\r * must be valid and can be a local or remote user.\r */\r userrec* user;\r /** Holds the quit reason to use for this user.\r */\r std::string reason;\r /** Holds the quit reason opers see, if different from users\r */\r std::string oper_reason;\r /** Silent items dont generate an snotice.\r */\r bool silent;\r public:\r /** Constrcutor.\r * Initializes the CullItem with a user pointer\r * and their quit reason\r * @param u The user to add\r * @param r The quit reason of the added user\r * @param ro The quit reason to show to opers only\r */\r CullItem(userrec* u, std::string &r, const char* ro = "");\r /** Constrcutor.\r * Initializes the CullItem with a user pointer\r * and their quit reason\r * @param u The user to add\r * @param r The quit reason of the added user\r * @param ro The quit reason to show to opers only\r */\r CullItem(userrec* u, const char* r, const char* ro = "");\r\r /** Make the quit silent a module is dealing with\r * displaying this users quit, so we shouldn't\r * send anything out.\r */\r void MakeSilent();\r\r /** Returns true if the quit for this user has been set\r * to silent.\r */\r bool IsSilent();\r\r /** Destructor\r */\r ~CullItem();\r\r /** Returns a pointer to the user\r */\r userrec* GetUser();\r /** Returns the user's quit reason\r */\r std::string& GetReason();\r /** Returns oper reason\r */\r std::string& GetOperReason();\r};\r\r/** The CullList class can be used by modules, and is used\r * by the core, to compile large lists of users in preperation\r * to quitting them all at once. This is faster than quitting\r * them within the loop, as the loops become tighter with\r * little or no comparisons within them. The CullList class\r * operates by allowing the programmer to push users onto\r * the list, each with a seperate quit reason, and then, once\r * the list is complete, call a method to flush the list,\r * quitting all the users upon it. A CullList may hold local\r * or remote users, but it may only hold each user once. If\r * you attempt to add the same user twice, then the second\r * attempt will be ignored.\r */\rclass CoreExport CullList : public classbase\r{\r private:\r /** Creator of this CullList\r */\r InspIRCd* ServerInstance;\r\r /** Holds a list of users already added for quick lookup\r */\r std::map<userrec*, userrec*> exempt;\r\r /** Holds a list of users being quit.\r * See the information for CullItem for\r * more information.\r */\r std::vector<CullItem> list;\r\r public:\r /** Constructor.\r * Clears the CullList::list and CullList::exempt\r * items.\r * @param Instance Creator of this CullList object\r */\r CullList(InspIRCd* Instance);\r\r /** Adds a user to the cull list for later\r * removal via QUIT.\r * @param user The user to add\r * @param reason The quit reason of the user being added\r * @param o_reason The quit reason to show only to opers\r */\r void AddItem(userrec* user, std::string &reason, const char* o_reason = "");\r\r /** Adds a user to the cull list for later\r * removal via QUIT.\r * @param user The user to add\r * @param reason The quit reason of the user being added\r * @param o_reason The quit reason to show only to opers\r */\r void AddItem(userrec* user, const char* reason, const char* o_reason = "");\r\r /* Turn an item into a silent item (don't send out QUIT for this user)\r */\r void MakeSilent(userrec* user);\r\r /** Applies the cull list, quitting all the users\r * on the list with their quit reasons all at once.\r * This is a very fast operation compared to\r * iterating the user list and comparing each one,\r * especially if there are multiple comparisons\r * to be done, or recursion.\r * @returns The number of users removed from IRC.\r */\r int Apply();\r};\r\r#endif\r\r
\ No newline at end of file
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#ifndef __CULLLIST_H__
+#define __CULLLIST_H__
+
+// include the common header files
+
+#include <string>
+#include <deque>
+#include <vector>
+#include "users.h"
+#include "channels.h"
+
+class InspIRCd;
+
+/** The CullItem class holds a user and their quitmessage,
+ * and is used internally by the CullList class to compile
+ * a list of users which are to be culled when a long
+ * operation (such as a netsplit) has completed.
+ */
+class CoreExport CullItem : public classbase
+{
+ private:
+ /** Holds a pointer to the user,
+ * must be valid and can be a local or remote user.
+ */
+ userrec* user;
+ /** Holds the quit reason to use for this user.
+ */
+ std::string reason;
+ /** Holds the quit reason opers see, if different from users
+ */
+ std::string oper_reason;
+ /** Silent items dont generate an snotice.
+ */
+ bool silent;
+ public:
+ /** Constrcutor.
+ * Initializes the CullItem with a user pointer
+ * and their quit reason
+ * @param u The user to add
+ * @param r The quit reason of the added user
+ * @param ro The quit reason to show to opers only
+ */
+ CullItem(userrec* u, std::string &r, const char* ro = "");
+ /** Constrcutor.
+ * Initializes the CullItem with a user pointer
+ * and their quit reason
+ * @param u The user to add
+ * @param r The quit reason of the added user
+ * @param ro The quit reason to show to opers only
+ */
+ CullItem(userrec* u, const char* r, const char* ro = "");
+
+ /** Make the quit silent a module is dealing with
+ * displaying this users quit, so we shouldn't
+ * send anything out.
+ */
+ void MakeSilent();
+
+ /** Returns true if the quit for this user has been set
+ * to silent.
+ */
+ bool IsSilent();
+
+ /** Destructor
+ */
+ ~CullItem();
+
+ /** Returns a pointer to the user
+ */
+ userrec* GetUser();
+ /** Returns the user's quit reason
+ */
+ std::string& GetReason();
+ /** Returns oper reason
+ */
+ std::string& GetOperReason();
+};
+
+/** The CullList class can be used by modules, and is used
+ * by the core, to compile large lists of users in preperation
+ * to quitting them all at once. This is faster than quitting
+ * them within the loop, as the loops become tighter with
+ * little or no comparisons within them. The CullList class
+ * operates by allowing the programmer to push users onto
+ * the list, each with a seperate quit reason, and then, once
+ * the list is complete, call a method to flush the list,
+ * quitting all the users upon it. A CullList may hold local
+ * or remote users, but it may only hold each user once. If
+ * you attempt to add the same user twice, then the second
+ * attempt will be ignored.
+ */
+class CoreExport CullList : public classbase
+{
+ private:
+ /** Creator of this CullList
+ */
+ InspIRCd* ServerInstance;
+
+ /** Holds a list of users already added for quick lookup
+ */
+ std::map<userrec*, userrec*> exempt;
+
+ /** Holds a list of users being quit.
+ * See the information for CullItem for
+ * more information.
+ */
+ std::vector<CullItem> list;
+
+ public:
+ /** Constructor.
+ * Clears the CullList::list and CullList::exempt
+ * items.
+ * @param Instance Creator of this CullList object
+ */
+ CullList(InspIRCd* Instance);
+
+ /** Adds a user to the cull list for later
+ * removal via QUIT.
+ * @param user The user to add
+ * @param reason The quit reason of the user being added
+ * @param o_reason The quit reason to show only to opers
+ */
+ void AddItem(userrec* user, std::string &reason, const char* o_reason = "");
+
+ /** Adds a user to the cull list for later
+ * removal via QUIT.
+ * @param user The user to add
+ * @param reason The quit reason of the user being added
+ * @param o_reason The quit reason to show only to opers
+ */
+ void AddItem(userrec* user, const char* reason, const char* o_reason = "");
+
+ /* Turn an item into a silent item (don't send out QUIT for this user)
+ */
+ void MakeSilent(userrec* user);
+
+ /** Applies the cull list, quitting all the users
+ * on the list with their quit reasons all at once.
+ * This is a very fast operation compared to
+ * iterating the user list and comparing each one,
+ * especially if there are multiple comparisons
+ * to be done, or recursion.
+ * @returns The number of users removed from IRC.
+ */
+ int Apply();
+};
+
+#endif
+
projects / user / henk / code / inspircd.git / blobdiff