-/* +------------------------------------+\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
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2013, 2017 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2011 jackmcbarn <jackmcbarn@inspircd.org>
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2005, 2010 Craig Edwards <brain@inspircd.org>
+ *
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#pragma once
+
+/**
+ * The CullList class is used to delete objects at the end of the main loop to
+ * avoid problems with references to deleted pointers if an object were deleted
+ * during execution.
+ */
+class CoreExport CullList
+{
+ std::vector<classbase*> list;
+ std::vector<LocalUser*> SQlist;
+
+ public:
+ /** Adds an item to the cull list
+ */
+ void AddItem(classbase* item) { list.push_back(item); }
+ void AddSQItem(LocalUser* item) { SQlist.push_back(item); }
+
+ /** Applies the cull list (deletes the contents)
+ */
+ void Apply();
+};
+
+/** Represents an action which is executable by an action list */
+class CoreExport ActionBase : public classbase
+{
+ public:
+ /** Executes this action. */
+ virtual void Call() = 0;
+};
+
+class CoreExport ActionList
+{
+ std::vector<ActionBase*> list;
+
+ public:
+ /** Adds an item to the list
+ */
+ void AddAction(ActionBase* item) { list.push_back(item); }
+
+ /** Runs the items
+ */
+ void Run();
+
+};
projects / user / henk / code / inspircd.git / blobdiff