X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcommands%2Fcmd_whowas.h;h=a17785c2268f7ff1582445cd2a7ea674f58fe469;hb=713fa43b98b5f4de918253f6fc735cd8542e25e3;hp=58aa14bfd9c95a789235076cc9d521b4dee2d8b3;hpb=f2acdbc3820f0f4f5ef76a0a64e73d2a320df91f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h index 58aa14bfd..a17785c22 100644 --- a/include/commands/cmd_whowas.h +++ b/include/commands/cmd_whowas.h @@ -1,144 +1,197 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2007 ChatSpike-Dev. - * E-mail: - * - * + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006 Craig Edwards * - * Written by Craig Edwards, Craig McLure, and others. - * 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 the common header files +#include "modules.h" -#include "users.h" -#include "channels.h" +/* Forward ref for typedefs */ +class WhoWasGroup; -/* list of available internal commands */ -enum Internals +namespace WhoWas { - WHOWAS_ADD = 1, - WHOWAS_STATS = 2, - WHOWAS_PRUNE = 3, - WHOWAS_MAINTAIN = 4 -}; + /** Everything known about one nick + */ + struct Nick : public intrusive_list_node + { + /** A group of users related by nickname + */ + typedef std::deque List; -/* Forward ref for timer */ -class WhoWasMaintainTimer; + /** Container where each element has information about one occurrence of this nick + */ + List entries; -/* Forward ref for typedefs */ -class WhoWasGroup; + /** Time this nick was added to the database + */ + const time_t addtime; -/** InspTimer that is used to maintain the whowas list, called once an hour - */ -extern WhoWasMaintainTimer* timer; + /** Nickname whose information is stored in this class + */ + const std::string nick; -/** A group of users related by nickname - */ -typedef std::deque whowas_set; + /** Constructor to initialize fields + */ + Nick(const std::string& nickname); -/** Sets of users in the whowas system - */ -typedef std::map whowas_users; + /** Destructor, deallocates all elements in the entries container + */ + ~Nick(); + }; -/** Sets of time and users in whowas list - */ -typedef std::deque > whowas_users_fifo; + class Manager + { + public: + struct Stats + { + /** Number of currently existing WhoWasGroup 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 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(); + }; +} /** Handle /WHOWAS. These command handlers can be reloaded by the core, * and handle basic RFC1459 commands. Commands within modules work * the same way, however, they can be fully unloaded, where these * may not. */ -class cmd_whowas : public command_t +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 - */ - std::string stats; - public: - cmd_whowas(InspIRCd* Instance); - /** 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. + /** Manager handling all whowas database related tasks */ - CmdResult Handle(const char** parameters, int pcnt, userrec *user); + WhoWas::Manager manager; + + 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 HandleInternal(const unsigned int id, const std::deque ¶meters); - void AddToWhoWas(userrec* user); - void GetStats(Extensible* ext); - void PruneWhoWas(time_t t); - void MaintainWhoWas(time_t t); - virtual ~cmd_whowas(); + CmdResult Handle(const std::vector& parameters, User *user); }; /** Used to hold WHOWAS information */ -class WhoWasGroup : public classbase +class WhoWasGroup { public: /** Real host */ - char* host; + std::string host; /** Displayed host */ - char* dhost; + std::string dhost; /** Ident */ - char* ident; + std::string ident; /** Server name */ - const char* server; + std::string server; /** Fullname (GECOS) */ - char* gecos; + std::string gecos; /** Signon time */ time_t signon; - /** Initialize this WhoQasFroup with a user + /** Initialize this WhoWasFroup with a user */ - WhoWasGroup(userrec* user); - /** Destructor - */ - ~WhoWasGroup(); + WhoWasGroup(User* user); }; - -class WhoWasMaintainTimer : public InspTimer -{ - private: - InspIRCd* ServerInstance; - public: - WhoWasMaintainTimer(InspIRCd* Instance, long interval) - : InspTimer(interval, Instance->Time(), true), ServerInstance(Instance) - { - } - virtual void Tick(time_t TIME); -}; - -#endif