include/commands/cmd_whowas.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #pragma once
  23
  24 #include "modules.h"
  25
  26 /* Forward ref for typedefs */
  27 class WhoWasGroup;
  28
  29 /** A group of users related by nickname
  30  */
  31 typedef std::deque<WhoWasGroup*> whowas_set;
  32
  33 namespace WhoWas
  34 {
  35         /** Everything known about one nick
  36          */
  37         struct Nick
  38         {
  39                 /** Container where each element has information about one occurrence of this nick
  40                  */
  41                 whowas_set entries;
  42
  43                 /** Destructor, deallocates all elements in the entries container
  44                  */
  45                 ~Nick();
  46         };
  47 }
  48
  49 /** Sets of users in the whowas system
  50  */
  51 typedef std::map<irc::string, WhoWas::Nick*> whowas_users;
  52
  53 /** Sets of time and users in whowas list
  54  */
  55 typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
  56
  57 /** Handle /WHOWAS. These command handlers can be reloaded by the core,
  58  * and handle basic RFC1459 commands. Commands within modules work
  59  * the same way, however, they can be fully unloaded, where these
  60  * may not.
  61  */
  62 class CommandWhowas : public Command
  63 {
  64   private:
  65         /** Primary container, links nicknames tracked by WHOWAS to a list of records
  66          */
  67         whowas_users whowas;
  68
  69         /** List of nicknames in the order they were inserted into the map
  70          */
  71         whowas_users_fifo whowas_fifo;
  72
  73   public:
  74         /** Max number of WhoWas entries per user.
  75          */
  76         unsigned int GroupSize;
  77
  78         /** Max number of cumulative user-entries in WhoWas.
  79          *  When max reached and added to, push out oldest entry FIFO style.
  80          */
  81         unsigned int MaxGroups;
  82
  83         /** Max seconds a user is kept in WhoWas before being pruned.
  84          */
  85         unsigned int MaxKeep;
  86
  87         CommandWhowas(Module* parent);
  88         /** Handle command.
  89          * @param parameters The parameters to the comamnd
  90          * @param pcnt The number of parameters passed to teh command
  91          * @param user The user issuing the command
  92          * @return A value from CmdResult to indicate command success or failure.
  93          */
  94         CmdResult Handle(const std::vector<std::string>& parameters, User *user);
  95         void AddToWhoWas(User* user);
  96         std::string GetStats();
  97         void Prune();
  98         void Maintain();
  99         ~CommandWhowas();
 100 };
 101
 102 /** Used to hold WHOWAS information
 103  */
 104 class WhoWasGroup
 105 {
 106  public:
 107         /** Real host
 108          */
 109         std::string host;
 110         /** Displayed host
 111          */
 112         std::string dhost;
 113         /** Ident
 114          */
 115         std::string ident;
 116         /** Server name
 117          */
 118         std::string server;
 119         /** Fullname (GECOS)
 120          */
 121         std::string gecos;
 122         /** Signon time
 123          */
 124         time_t signon;
 125
 126         /** Initialize this WhoWasFroup with a user
 127          */
 128         WhoWasGroup(User* user);
 129 };