X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fcommands%2Fcmd_whowas.h;h=5c2bb62ee881b056655df6c31924d4f281257400;hb=18d9adff0fd2ea811dbbf17814a4ba5e36ed2da4;hp=ccbe40493db43438aa52f2146c0b96d46150cbea;hpb=af2b10e82cd3b9cda80ae29607da78e15974f155;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h index ccbe40493..5c2bb62ee 100644 --- a/include/commands/cmd_whowas.h +++ b/include/commands/cmd_whowas.h @@ -1,125 +1,141 @@ -/* +------------------------------------+ - * | 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__ - - -// include the common header files - -#include "users.h" -#include "channels.h" -/* list of available internal commands */ -enum Internals -{ - WHOWAS_ADD = 1, - WHOWAS_STATS = 2, - WHOWAS_PRUNE = 3, - WHOWAS_MAINTAIN = 4 -}; +#pragma once -/* Forward ref for timer */ -class MaintainTimer; +#include "modules.h" /* Forward ref for typedefs */ class WhoWasGroup; -/** InspTimer that is used to maintain the whowas list, called once an hour - */ -MaintainTimer* timer; - /** A group of users related by nickname */ typedef std::deque whowas_set; +namespace WhoWas +{ + /** Everything known about one nick + */ + struct Nick + { + /** Container where each element has information about one occurrence of this nick + */ + whowas_set entries; + + /** Time this nick was added to the database + */ + const time_t addtime; + + /** Nickname whose information is stored in this class + */ + const irc::string nick; + + /** Constructor to initialize fields + */ + Nick(const irc::string& nickname); + + /** Destructor, deallocates all elements in the entries container + */ + ~Nick(); + }; +} + /** Sets of users in the whowas system */ -typedef std::map whowas_users; +typedef std::map whowas_users; /** Sets of time and users in whowas list */ typedef std::deque > whowas_users_fifo; -/** Handle /WHOWAS +/** 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 + /** Primary container, links nicknames tracked by WHOWAS to a list of records */ whowas_users whowas; - - /** Whowas container, contains a map of time_t to users tracked by WHOWAS + + /** List of nicknames in the order they were inserted into the map */ whowas_users_fifo whowas_fifo; public: - cmd_whowas(InspIRCd* Instance); - CmdResult Handle(const char** parameters, int pcnt, userrec *user); - 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(); + /** 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; + + 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 Prune(); + void Maintain(); + ~CommandWhowas(); }; /** 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 - */ - WhoWasGroup(userrec* user); - /** Destructor + /** Initialize this WhoWasFroup with a user */ - ~WhoWasGroup(); + WhoWasGroup(User* user); }; - -class MaintainTimer : public InspTimer -{ - private: - InspIRCd* ServerInstance; - public: - MaintainTimer(InspIRCd* Instance, long interval) - : InspTimer(interval, Instance->Time(), true), ServerInstance(Instance) - { - } - virtual void Tick(time_t TIME); -}; - -#endif