X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcull_list.h;h=ac64dced284341805081c6e78c0b33927a1af9d3;hb=a3e0768758ca68429a29d9c78ce672f2d938c6e7;hp=8901c5ea4248be3f33bb013f34248e2c924c2bf1;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/cull_list.h b/include/cull_list.h index 8901c5ea4..ac64dced2 100644 --- a/include/cull_list.h +++ b/include/cull_list.h @@ -1,135 +1,59 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2005, 2007 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * 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 . */ -#ifndef __CULLLIST_H__ -#define __CULLLIST_H__ - -// include the common header files -#include -#include -#include -#include "users.h" -#include "channels.h" +#pragma once -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. +/** + * 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 CullItem : public classbase +class CoreExport CullList { - 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 - */ - CullItem(userrec* u, std::string &r, const char* ro = ""); - CullItem(userrec* u, const char* r, const char* ro = ""); + std::vector list; + std::vector SQlist; - void MakeSilent(); - bool IsSilent(); - - ~CullItem(); + public: + /** Adds an item to the cull list + */ + void AddItem(classbase* item) { list.push_back(item); } + void AddSQItem(LocalUser* item) { SQlist.push_back(item); } - /** Returns a pointer to the user - */ - userrec* GetUser(); - /** Returns the user's quit reason - */ - std::string& GetReason(); - /** Returns oper reason + /** Applies the cull list (deletes the contents) */ - std::string& GetOperReason(); + void Apply(); }; -/** 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 +class CoreExport ActionList { - 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; + 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 - */ - void AddItem(userrec* user, std::string &reason, const char* o_reason = ""); - void AddItem(userrec* user, const char* reason, const char* o_reason = ""); + /** Adds an item to the list + */ + void AddAction(HandlerBase0* item) { list.push_back(item); } - /* Turn an item into a silent item + /** Runs the items */ - void MakeSilent(userrec* user); + void Run(); - /** 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