X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcommands%2Fcmd_whowas.h;h=2447024a1e9d1fa08d782a87ba7c10fd512410c6;hb=8cb20e354533fbec24aafd4e61ff6fa69b434aa2;hp=5109ab54a3cab207a04bf6714d2b2ae2b3114550;hpb=069a2ef21425007d092342c8c11ec28da2f410d7;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h index 5109ab54a..2447024a1 100644 --- a/include/commands/cmd_whowas.h +++ b/include/commands/cmd_whowas.h @@ -1,60 +1,189 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006 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 __CMD_WHOWAS_H__ -#define __CMD_WHOWAS_H__ + +#pragma once + #include "modules.h" -struct WhowasRequest : public Request +namespace WhoWas { - /* list of available internal commands */ - enum Internals + /** One entry for a nick. There may be multiple entries for a nick. + */ + struct Entry { - WHOWAS_ADD = 1, - WHOWAS_STATS = 2, - WHOWAS_PRUNE = 3, - WHOWAS_MAINTAIN = 4 - }; + /** Real host + */ + const std::string host; - const Internals type; - std::string value; - User* user; + /** Displayed host + */ + const std::string dhost; - WhowasRequest(Module* src, Module* whowas, Internals Type) : Request(src, whowas, "WHOWAS"), type(Type) - {} -}; + /** Ident + */ + const std::string ident; -/* Forward ref for timer */ -class WhoWasMaintainTimer; + /** Server name + */ + const std::string server; -/* Forward ref for typedefs */ -class WhoWasGroup; + /** Real name + */ + const std::string real; -/** Timer that is used to maintain the whowas list, called once an hour - */ -extern WhoWasMaintainTimer* timer; + /** Signon time + */ + const time_t signon; -/** A group of users related by nickname - */ -typedef std::deque whowas_set; + /** Initialize this Entry with a user + */ + Entry(User* user); + }; -/** Sets of users in the whowas system - */ -typedef std::map whowas_users; + /** Everything known about one nick + */ + struct Nick : public insp::intrusive_list_node + { + /** A group of users related by nickname + */ + typedef std::deque List; -/** Sets of time and users in whowas list - */ -typedef std::deque > whowas_users_fifo; + /** Container where each element has information about one occurrence of this nick + */ + List entries; + + /** Time this nick was added to the database + */ + const time_t addtime; + + /** Nickname whose information is stored in this class + */ + const std::string nick; + + /** Constructor to initialize fields + */ + Nick(const std::string& nickname); + + /** Destructor, deallocates all elements in the entries container + */ + ~Nick(); + }; + + class Manager + { + public: + struct Stats + { + /** Number of currently existing WhoWas::Entry objects + */ + size_t entrycount; + }; + + /** Add a user to the whowas database. Called when a user quits. + * @param user The user to add to the database + */ + void Add(User* user); + + /** Retrieves statistics about the whowas database + * @return Whowas statistics as a WhoWas::Manager::Stats struct + */ + Stats GetStats() const; + + /** Expires old entries + */ + void Maintain(); + + /** Updates the current configuration which may result in the database being pruned if the + * new values are lower than the current ones. + * @param NewGroupSize Maximum number of nicks allowed in the database. In case there are this many nicks + * in the database and one more is added, the oldest one is removed (FIFO). + * @param NewMaxGroups Maximum number of entries per nick + * @param NewMaxKeep Seconds how long each nick should be kept + */ + void UpdateConfig(unsigned int NewGroupSize, unsigned int NewMaxGroups, unsigned int NewMaxKeep); + + /** Retrieves all data known about a given nick + * @param nick Nickname to find, case insensitive (IRC casemapping) + * @return A pointer to a WhoWas::Nick if the nick was found, NULL otherwise + */ + const Nick* FindNick(const std::string& nick) const; + + /** Returns true if WHOWAS is enabled according to the current configuration + * @return True if WHOWAS is enabled according to the configuration, false if WHOWAS is disabled + */ + bool IsEnabled() const; + + /** Constructor + */ + Manager(); + + /** Destructor + */ + ~Manager(); + + private: + /** Order in which the users were added into the map, used to remove oldest nick + */ + typedef insp::intrusive_list_tail FIFO; + + /** Sets of users in the whowas system + */ + typedef TR1NS::unordered_map whowas_users; + + /** Primary container, links nicknames tracked by WHOWAS to a list of records + */ + whowas_users whowas; + + /** List of nicknames in the order they were inserted into the map + */ + FIFO whowas_fifo; + + /** Max number of WhoWas entries per user. + */ + unsigned int GroupSize; + + /** Max number of cumulative user-entries in WhoWas. + * When max reached and added to, push out oldest entry FIFO style. + */ + unsigned int MaxGroups; + + /** Max seconds a user is kept in WhoWas before being pruned. + */ + unsigned int MaxKeep; + + /** Shrink all data structures to honor the current settings + */ + void Prune(); + + /** Remove a nick (and all entries belonging to it) from the database + * @param it Iterator to the nick to purge + */ + void PurgeNick(whowas_users::iterator it); + + /** Remove a nick (and all entries belonging to it) from the database + * @param nick Nick to purge + */ + void PurgeNick(WhoWas::Nick* nick); + }; +} /** Handle /WHOWAS. These command handlers can be reloaded by the core, * and handle basic RFC1459 commands. Commands within modules work @@ -63,77 +192,16 @@ typedef std::deque > whowas_users_fifo; */ class CommandWhowas : public Command { - private: - /** Whowas container, contains a map of vectors of users tracked by WHOWAS - */ - whowas_users whowas; - - /** Whowas container, contains a map of time_t to users tracked by WHOWAS - */ - whowas_users_fifo whowas_fifo; - - /* String holding stats so it can be collected + public: + /** Manager handling all whowas database related tasks */ - std::string stats; + WhoWas::Manager manager; - public: CommandWhowas(Module* parent); /** Handle command. * @param parameters The parameters to the comamnd - * @param pcnt The number of parameters passed to teh command * @param user The user issuing the command * @return A value from CmdResult to indicate command success or failure. */ - CmdResult Handle(const std::vector& parameters, User *user); - void AddToWhoWas(User* user); - std::string GetStats(); - void PruneWhoWas(time_t t); - void MaintainWhoWas(time_t t); - ~CommandWhowas(); + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE; }; - -/** Used to hold WHOWAS information - */ -class WhoWasGroup : public classbase -{ - public: - /** Real host - */ - std::string host; - /** Displayed host - */ - std::string dhost; - /** Ident - */ - std::string ident; - /** Server name - */ - const char* server; - /** Fullname (GECOS) - */ - std::string gecos; - /** Signon time - */ - time_t signon; - - /** Initialize this WhoQasFroup with a user - */ - WhoWasGroup(User* user); - /** Destructor - */ - ~WhoWasGroup(); -}; - -class WhoWasMaintainTimer : public Timer -{ - private: - InspIRCd* ServerInstance; - public: - WhoWasMaintainTimer(InspIRCd* Instance, long interval) - : Timer(interval, Instance->Time(), true), ServerInstance(Instance) - { - } - virtual void Tick(time_t TIME); -}; - -#endif