src/coremods/core_whowas.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   6  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "commands/cmd_whowas.h"
  25
  26 CommandWhowas::CommandWhowas( Module* parent)
  27         : Command(parent, "WHOWAS", 1)
  28         , GroupSize(0), MaxGroups(0), MaxKeep(0)
  29 {
  30         syntax = "<nick>{,<nick>}";
  31         Penalty = 2;
  32 }
  33
  34 CmdResult CommandWhowas::Handle (const std::vector<std::string>& parameters, User* user)
  35 {
  36         /* if whowas disabled in config */
  37         if (this->GroupSize == 0 || this->MaxGroups == 0)
  38         {
  39                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :This command has been disabled.", name.c_str());
  40                 return CMD_FAILURE;
  41         }
  42
  43         whowas_users::iterator i = whowas.find(assign(parameters[0]));
  44
  45         if (i == whowas.end())
  46         {
  47                 user->WriteNumeric(ERR_WASNOSUCHNICK, "%s :There was no such nickname", parameters[0].c_str());
  48         }
  49         else
  50         {
  51                 whowas_set* grp = i->second;
  52                 if (!grp->empty())
  53                 {
  54                         for (whowas_set::iterator ux = grp->begin(); ux != grp->end(); ux++)
  55                         {
  56                                 WhoWasGroup* u = *ux;
  57
  58                                 user->WriteNumeric(RPL_WHOWASUSER, "%s %s %s * :%s", parameters[0].c_str(),
  59                                         u->ident.c_str(),u->dhost.c_str(),u->gecos.c_str());
  60
  61                                 if (user->HasPrivPermission("users/auspex"))
  62                                         user->WriteNumeric(RPL_WHOWASIP, "%s :was connecting from *@%s",
  63                                                 parameters[0].c_str(), u->host.c_str());
  64
  65                                 std::string signon = InspIRCd::TimeString(u->signon);
  66                                 bool hide_server = (!ServerInstance->Config->HideWhoisServer.empty() && !user->HasPrivPermission("servers/auspex"));
  67                                 user->WriteNumeric(RPL_WHOISSERVER, "%s %s :%s", parameters[0].c_str(), (hide_server ? ServerInstance->Config->HideWhoisServer.c_str() : u->server.c_str()), signon.c_str());
  68                         }
  69                 }
  70                 else
  71                 {
  72                         user->WriteNumeric(ERR_WASNOSUCHNICK, "%s :There was no such nickname", parameters[0].c_str());
  73                 }
  74         }
  75
  76         user->WriteNumeric(RPL_ENDOFWHOWAS, "%s :End of WHOWAS", parameters[0].c_str());
  77         return CMD_SUCCESS;
  78 }
  79
  80 std::string CommandWhowas::GetStats()
  81 {
  82         int whowas_size = 0;
  83         for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
  84         {
  85                 whowas_set* n = i->second;
  86                 whowas_size += n->size();
  87         }
  88         return "Whowas entries: " + ConvToStr(whowas_size);
  89 }
  90
  91 void CommandWhowas::AddToWhoWas(User* user)
  92 {
  93         /* if whowas disabled */
  94         if (this->GroupSize == 0 || this->MaxGroups == 0)
  95         {
  96                 return;
  97         }
  98
  99         // Insert nick if it doesn't exist
 100         // 'first' will point to the newly inserted element or to the existing element with an equivalent key
 101         std::pair<whowas_users::iterator, bool> ret = whowas.insert(std::make_pair(irc::string(user->nick.c_str()), static_cast<whowas_set*>(NULL)));
 102
 103         if (ret.second) // If inserted
 104         {
 105                 // This nick is new, create a list for it and add the first record to it
 106                 whowas_set* n = new whowas_set;
 107                 n->push_back(new WhoWasGroup(user));
 108                 ret.first->second = n;
 109
 110                 // Add this nick to the fifo too
 111                 whowas_fifo.push_back(std::make_pair(ServerInstance->Time(), ret.first->first));
 112
 113                 if (whowas.size() > this->MaxGroups)
 114                 {
 115                         // Too many nicks, remove the nick which was inserted the longest time ago from both the map and the fifo
 116                         whowas_users::iterator it = whowas.find(whowas_fifo.front().second);
 117                         if (it != whowas.end())
 118                         {
 119                                 whowas_set* set = it->second;
 120                                 stdalgo::delete_all(*set);
 121
 122                                 delete set;
 123                                 whowas.erase(it);
 124                         }
 125                         whowas_fifo.pop_front();
 126                 }
 127         }
 128         else
 129         {
 130                 // We've met this nick before, add a new record to the list
 131                 whowas_set* set = ret.first->second;
 132                 set->push_back(new WhoWasGroup(user));
 133
 134                 // If there are too many records for this nick, remove the oldest (front)
 135                 if (set->size() > this->GroupSize)
 136                 {
 137                         delete set->front();
 138                         set->pop_front();
 139                 }
 140         }
 141 }
 142
 143 /* on rehash, refactor maps according to new conf values */
 144 void CommandWhowas::Prune()
 145 {
 146         time_t min = ServerInstance->Time() - this->MaxKeep;
 147
 148         /* first cut the list to new size (maxgroups) and also prune entries that are timed out. */
 149         while (!whowas_fifo.empty())
 150         {
 151                 if ((whowas_fifo.size() > this->MaxGroups) || (whowas_fifo.front().first < min))
 152                 {
 153                         whowas_users::iterator iter = whowas.find(whowas_fifo.front().second);
 154
 155                         /* hopefully redundant integrity check, but added while debugging r6216 */
 156                         if (iter == whowas.end())
 157                         {
 158                                 /* this should never happen, if it does maps are corrupt */
 159                                 ServerInstance->Logs->Log("WHOWAS", LOG_DEFAULT, "BUG: Whowas maps got corrupted! (1)");
 160                                 return;
 161                         }
 162
 163                         whowas_set* set = iter->second;
 164                         stdalgo::delete_all(*set);
 165
 166                         delete set;
 167                         whowas.erase(iter);
 168                         whowas_fifo.pop_front();
 169                 }
 170                 else
 171                         break;
 172         }
 173
 174         /* Then cut the whowas sets to new size (groupsize) */
 175         for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
 176         {
 177                 whowas_set* n = i->second;
 178                 while (n->size() > this->GroupSize)
 179                 {
 180                         delete n->front();
 181                         n->pop_front();
 182                 }
 183         }
 184 }
 185
 186 /* call maintain once an hour to remove expired nicks */
 187 void CommandWhowas::Maintain()
 188 {
 189         time_t min = ServerInstance->Time() - this->MaxKeep;
 190         for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
 191         {
 192                 whowas_set* set = i->second;
 193                 while (!set->empty() && set->front()->signon < min)
 194                 {
 195                         delete set->front();
 196                         set->pop_front();
 197                 }
 198         }
 199 }
 200
 201 CommandWhowas::~CommandWhowas()
 202 {
 203         for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
 204         {
 205                 whowas_set* set = i->second;
 206                 for (whowas_set::iterator j = set->begin(); j != set->end(); ++j)
 207                         delete *j;
 208
 209                 delete set;
 210         }
 211 }
 212
 213 WhoWasGroup::WhoWasGroup(User* user) : host(user->host), dhost(user->dhost), ident(user->ident),
 214         server(user->server->GetName()), gecos(user->fullname), signon(user->signon)
 215 {
 216 }
 217
 218 class ModuleWhoWas : public Module
 219 {
 220         CommandWhowas cmd;
 221
 222  public:
 223         ModuleWhoWas() : cmd(this)
 224         {
 225         }
 226
 227         void OnGarbageCollect()
 228         {
 229                 // Remove all entries older than MaxKeep
 230                 cmd.Maintain();
 231         }
 232
 233         void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
 234         {
 235                 cmd.AddToWhoWas(user);
 236         }
 237
 238         ModResult OnStats(char symbol, User* user, string_list &results)
 239         {
 240                 if (symbol == 'z')
 241                         results.push_back("249 "+user->nick+" :"+cmd.GetStats());
 242
 243                 return MOD_RES_PASSTHRU;
 244         }
 245
 246         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 247         {
 248                 ConfigTag* tag = ServerInstance->Config->ConfValue("whowas");
 249                 unsigned int NewGroupSize = tag->getInt("groupsize", 10, 0, 10000);
 250                 unsigned int NewMaxGroups = tag->getInt("maxgroups", 10240, 0, 1000000);
 251                 unsigned int NewMaxKeep = tag->getDuration("maxkeep", 3600, 3600);
 252
 253                 if ((NewGroupSize == cmd.GroupSize) && (NewMaxGroups == cmd.MaxGroups) && (NewMaxKeep == cmd.MaxKeep))
 254                         return;
 255
 256                 cmd.GroupSize = NewGroupSize;
 257                 cmd.MaxGroups = NewMaxGroups;
 258                 cmd.MaxKeep = NewMaxKeep;
 259                 cmd.Prune();
 260         }
 261
 262         Version GetVersion()
 263         {
 264                 return Version("WHOWAS", VF_VENDOR);
 265         }
 266 };
 267
 268 MODULE_INIT(ModuleWhoWas)