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                 /** Time this nick was added to the database
  44                  */
  45                 const time_t addtime;
  46
  47                 /** Constructor to initialize fields
  48                  */
  49                 Nick();
  50
  51                 /** Destructor, deallocates all elements in the entries container
  52                  */
  53                 ~Nick();
  54         };
  55 }
  56
  57 /** Sets of users in the whowas system
  58  */
  59 typedef std::map<irc::string, WhoWas::Nick*> whowas_users;
  60
  61 /** Sets of time and users in whowas list
  62  */
  63 typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
  64
  65 /** Handle /WHOWAS. These command handlers can be reloaded by the core,
  66  * and handle basic RFC1459 commands. Commands within modules work
  67  * the same way, however, they can be fully unloaded, where these
  68  * may not.
  69  */
  70 class CommandWhowas : public Command
  71 {
  72   private:
  73         /** Primary container, links nicknames tracked by WHOWAS to a list of records
  74          */
  75         whowas_users whowas;
  76
  77         /** List of nicknames in the order they were inserted into the map
  78          */
  79         whowas_users_fifo whowas_fifo;
  80
  81   public:
  82         /** Max number of WhoWas entries per user.
  83          */
  84         unsigned int GroupSize;
  85
  86         /** Max number of cumulative user-entries in WhoWas.
  87          *  When max reached and added to, push out oldest entry FIFO style.
  88          */
  89         unsigned int MaxGroups;
  90
  91         /** Max seconds a user is kept in WhoWas before being pruned.
  92          */
  93         unsigned int MaxKeep;
  94
  95         CommandWhowas(Module* parent);
  96         /** Handle command.
  97          * @param parameters The parameters to the comamnd
  98          * @param pcnt The number of parameters passed to teh command
  99          * @param user The user issuing the command
 100          * @return A value from CmdResult to indicate command success or failure.
 101          */
 102         CmdResult Handle(const std::vector<std::string>& parameters, User *user);
 103         void AddToWhoWas(User* user);
 104         std::string GetStats();
 105         void Prune();
 106         void Maintain();
 107         ~CommandWhowas();
 108 };
 109
 110 /** Used to hold WHOWAS information
 111  */
 112 class WhoWasGroup
 113 {
 114  public:
 115         /** Real host
 116          */
 117         std::string host;
 118         /** Displayed host
 119          */
 120         std::string dhost;
 121         /** Ident
 122          */
 123         std::string ident;
 124         /** Server name
 125          */
 126         std::string server;
 127         /** Fullname (GECOS)
 128          */
 129         std::string gecos;
 130         /** Signon time
 131          */
 132         time_t signon;
 133
 134         /** Initialize this WhoWasFroup with a user
 135          */
 136         WhoWasGroup(User* user);
 137 };