X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcull_list.h;h=d29b7b267c21a9fcc5629bbb58222e0f214f8480;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=b2742e3905d8ee18c42439b3cc2d252bbd2f543d;hpb=bab14f0dd2345c9d7dcbc47c918563709e1ac094;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/cull_list.h b/include/cull_list.h index b2742e390..d29b7b267 100644 --- a/include/cull_list.h +++ b/include/cull_list.h @@ -1 +1,69 @@ -/* +------------------------------------+ * | 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 #include #include #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 exempt; /** Holds a list of users being quit. * See the information for CullItem for * more information. */ std::vector 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 \ No newline at end of file +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2013, 2017 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2011 jackmcbarn + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2005, 2010 Craig Edwards + * + * 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 . + */ + + +#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 list; + std::vector 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 list; + + public: + /** Adds an item to the list + */ + void AddAction(ActionBase* item) { list.push_back(item); } + + /** Runs the items + */ + void Run(); + +};