X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcommands%2Fcmd_whowas.h;h=5c2bb62ee881b056655df6c31924d4f281257400;hb=18d9adff0fd2ea811dbbf17814a4ba5e36ed2da4;hp=09269a5f1e244d2bc3089e12871092ce235392cc;hpb=65923c4d397ce3655473b2d25db5acc90aa78075;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h index 09269a5f1..5c2bb62ee 100644 --- a/include/commands/cmd_whowas.h +++ b/include/commands/cmd_whowas.h @@ -1,38 +1,141 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2006 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 +#pragma once + +#include "modules.h" -#include -#include -#include -#include -#include -#include -#include "users.h" -#include "channels.h" +/* Forward ref for typedefs */ +class WhoWasGroup; + +/** A group of users related by nickname + */ +typedef std::deque whowas_set; -class cmd_whowas : public command_t +namespace WhoWas { - public: - cmd_whowas () : command_t("WHOWAS",0,1) { } - void Handle(char **parameters, int pcnt, userrec *user); + /** 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; + +/** Sets of time and users in whowas list + */ +typedef std::deque > whowas_users_fifo; + +/** 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 CommandWhowas : public Command +{ + private: + /** 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 + */ + whowas_users_fifo whowas_fifo; + + public: + /** 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(); }; -#endif +/** Used to hold WHOWAS information + */ +class WhoWasGroup +{ + public: + /** Real host + */ + std::string host; + /** Displayed host + */ + std::string dhost; + /** Ident + */ + std::string ident; + /** Server name + */ + std::string server; + /** Fullname (GECOS) + */ + std::string gecos; + /** Signon time + */ + time_t signon; + + /** Initialize this WhoWasFroup with a user + */ + WhoWasGroup(User* user); +};