src/commands/cmd_whowas.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "commands/cmd_whowas.h"
  16
  17 WhoWasMaintainTimer * timer;
  18
  19 CommandWhowas::CommandWhowas( Module* parent) : Command(parent, "WHOWAS", 1)
  20 {
  21         syntax = "<nick>{,<nick>}";
  22         Penalty = 2;
  23         timer = new WhoWasMaintainTimer(3600);
  24         ServerInstance->Timers->AddTimer(timer);
  25 }
  26
  27 CmdResult CommandWhowas::Handle (const std::vector<std::string>& parameters, User* user)
  28 {
  29         /* if whowas disabled in config */
  30         if (ServerInstance->Config->WhoWasGroupSize == 0 || ServerInstance->Config->WhoWasMaxGroups == 0)
  31         {
  32                 user->WriteNumeric(421, "%s %s :This command has been disabled.",user->nick.c_str(),name.c_str());
  33                 return CMD_FAILURE;
  34         }
  35
  36         whowas_users::iterator i = whowas.find(assign(parameters[0]));
  37
  38         if (i == whowas.end())
  39         {
  40                 user->WriteNumeric(406, "%s %s :There was no such nickname",user->nick.c_str(),parameters[0].c_str());
  41                 user->WriteNumeric(369, "%s %s :End of WHOWAS",user->nick.c_str(),parameters[0].c_str());
  42                 return CMD_FAILURE;
  43         }
  44         else
  45         {
  46                 whowas_set* grp = i->second;
  47                 if (grp->size())
  48                 {
  49                         for (whowas_set::iterator ux = grp->begin(); ux != grp->end(); ux++)
  50                         {
  51                                 WhoWasGroup* u = *ux;
  52                                 time_t rawtime = u->signon;
  53                                 tm *timeinfo;
  54                                 char b[25];
  55
  56                                 timeinfo = localtime(&rawtime);
  57
  58                                 strncpy(b,asctime(timeinfo),24);
  59                                 b[24] = 0;
  60
  61                                 user->WriteNumeric(314, "%s %s %s %s * :%s",user->nick.c_str(),parameters[0].c_str(),
  62                                         u->ident.c_str(),u->dhost.c_str(),u->gecos.c_str());
  63
  64                                 if (user->HasPrivPermission("users/auspex"))
  65                                         user->WriteNumeric(379, "%s %s :was connecting from *@%s",
  66                                                 user->nick.c_str(), parameters[0].c_str(), u->host.c_str());
  67
  68                                 if (!ServerInstance->Config->HideWhoisServer.empty() && !user->HasPrivPermission("servers/auspex"))
  69                                         user->WriteNumeric(312, "%s %s %s :%s",user->nick.c_str(),parameters[0].c_str(), ServerInstance->Config->HideWhoisServer.c_str(), b);
  70                                 else
  71                                         user->WriteNumeric(312, "%s %s %s :%s",user->nick.c_str(),parameters[0].c_str(), u->server.c_str(), b);
  72                         }
  73                 }
  74                 else
  75                 {
  76                         user->WriteNumeric(406, "%s %s :There was no such nickname",user->nick.c_str(),parameters[0].c_str());
  77                         user->WriteNumeric(369, "%s %s :End of WHOWAS",user->nick.c_str(),parameters[0].c_str());
  78                         return CMD_FAILURE;
  79                 }
  80         }
  81
  82         user->WriteNumeric(369, "%s %s :End of WHOWAS",user->nick.c_str(),parameters[0].c_str());
  83         return CMD_SUCCESS;
  84 }
  85
  86 std::string CommandWhowas::GetStats()
  87 {
  88         int whowas_size = 0;
  89         int whowas_bytes = 0;
  90         whowas_users_fifo::iterator iter;
  91         for (iter = whowas_fifo.begin(); iter != whowas_fifo.end(); iter++)
  92         {
  93                 whowas_set* n = (whowas_set*)whowas.find(iter->second)->second;
  94                 if (n->size())
  95                 {
  96                         whowas_size += n->size();
  97                         whowas_bytes += (sizeof(whowas_set) + ( sizeof(WhoWasGroup) * n->size() ) );
  98                 }
  99         }
 100         return "Whowas entries: " +ConvToStr(whowas_size)+" ("+ConvToStr(whowas_bytes)+" bytes)";
 101 }
 102
 103 void CommandWhowas::AddToWhoWas(User* user)
 104 {
 105         /* if whowas disabled */
 106         if (ServerInstance->Config->WhoWasGroupSize == 0 || ServerInstance->Config->WhoWasMaxGroups == 0)
 107         {
 108                 return;
 109         }
 110
 111         whowas_users::iterator iter = whowas.find(irc::string(user->nick.c_str()));
 112
 113         if (iter == whowas.end())
 114         {
 115                 whowas_set* n = new whowas_set;
 116                 WhoWasGroup *a = new WhoWasGroup(user);
 117                 n->push_back(a);
 118                 whowas[user->nick.c_str()] = n;
 119                 whowas_fifo.push_back(std::make_pair(ServerInstance->Time(),user->nick.c_str()));
 120
 121                 if ((int)(whowas.size()) > ServerInstance->Config->WhoWasMaxGroups)
 122                 {
 123                         whowas_users::iterator iter2 = whowas.find(whowas_fifo[0].second);
 124                         if (iter2 != whowas.end())
 125                         {
 126                                 whowas_set* n2 = (whowas_set*)iter2->second;
 127
 128                                 if (n2->size())
 129                                 {
 130                                         while (n2->begin() != n2->end())
 131                                         {
 132                                                 WhoWasGroup *a2 = *(n2->begin());
 133                                                 delete a2;
 134                                                 n2->pop_front();
 135                                         }
 136                                 }
 137
 138                                 delete n2;
 139                                 whowas.erase(iter2);
 140                         }
 141                         whowas_fifo.pop_front();
 142                 }
 143         }
 144         else
 145         {
 146                 whowas_set* group = (whowas_set*)iter->second;
 147                 WhoWasGroup *a = new WhoWasGroup(user);
 148                 group->push_back(a);
 149
 150                 if ((int)(group->size()) > ServerInstance->Config->WhoWasGroupSize)
 151                 {
 152                         WhoWasGroup *a2 = (WhoWasGroup*)*(group->begin());
 153                         delete a2;
 154                         group->pop_front();
 155                 }
 156         }
 157 }
 158
 159 /* on rehash, refactor maps according to new conf values */
 160 void CommandWhowas::PruneWhoWas(time_t t)
 161 {
 162         /* config values */
 163         int groupsize = ServerInstance->Config->WhoWasGroupSize;
 164         int maxgroups = ServerInstance->Config->WhoWasMaxGroups;
 165         int maxkeep =   ServerInstance->Config->WhoWasMaxKeep;
 166
 167         /* first cut the list to new size (maxgroups) and also prune entries that are timed out. */
 168         whowas_users::iterator iter;
 169         int fifosize;
 170         while ((fifosize = (int)whowas_fifo.size()) > 0)
 171         {
 172                 if (fifosize > maxgroups || whowas_fifo[0].first < t - maxkeep)
 173                 {
 174                         iter = whowas.find(whowas_fifo[0].second);
 175
 176                         /* hopefully redundant integrity check, but added while debugging r6216 */
 177                         if (iter == whowas.end())
 178                         {
 179                                 /* this should never happen, if it does maps are corrupt */
 180                                 ServerInstance->Logs->Log("WHOWAS",DEFAULT, "BUG: Whowas maps got corrupted! (1)");
 181                                 return;
 182                         }
 183
 184                         whowas_set* n = (whowas_set*)iter->second;
 185
 186                         if (n->size())
 187                         {
 188                                 while (n->begin() != n->end())
 189                                 {
 190                                         WhoWasGroup *a = *(n->begin());
 191                                         delete a;
 192                                         n->pop_front();
 193                                 }
 194                         }
 195
 196                         delete n;
 197                         whowas.erase(iter);
 198                         whowas_fifo.pop_front();
 199                 }
 200                 else
 201                         break;
 202         }
 203
 204         /* Then cut the whowas sets to new size (groupsize) */
 205         fifosize = (int)whowas_fifo.size();
 206         for (int i = 0; i < fifosize; i++)
 207         {
 208                 iter = whowas.find(whowas_fifo[0].second);
 209                 /* hopefully redundant integrity check, but added while debugging r6216 */
 210                 if (iter == whowas.end())
 211                 {
 212                         /* this should never happen, if it does maps are corrupt */
 213                         ServerInstance->Logs->Log("WHOWAS",DEFAULT, "BUG: Whowas maps got corrupted! (2)");
 214                         return;
 215                 }
 216                 whowas_set* n = (whowas_set*)iter->second;
 217                 if (n->size())
 218                 {
 219                         int nickcount = n->size();
 220                         while (n->begin() != n->end() && nickcount > groupsize)
 221                         {
 222                                 WhoWasGroup *a = *(n->begin());
 223                                 delete a;
 224                                 n->pop_front();
 225                                 nickcount--;
 226                         }
 227                 }
 228         }
 229 }
 230
 231 /* call maintain once an hour to remove expired nicks */
 232 void CommandWhowas::MaintainWhoWas(time_t t)
 233 {
 234         for (whowas_users::iterator iter = whowas.begin(); iter != whowas.end(); iter++)
 235         {
 236                 whowas_set* n = (whowas_set*)iter->second;
 237                 if (n->size())
 238                 {
 239                         while ((n->begin() != n->end()) && ((*n->begin())->signon < t - ServerInstance->Config->WhoWasMaxKeep))
 240                         {
 241                                 WhoWasGroup *a = *(n->begin());
 242                                 delete a;
 243                                 n->erase(n->begin());
 244                         }
 245                 }
 246         }
 247 }
 248
 249 CommandWhowas::~CommandWhowas()
 250 {
 251         if (timer)
 252         {
 253                 ServerInstance->Timers->DelTimer(timer);
 254         }
 255
 256         whowas_users::iterator iter;
 257         int fifosize;
 258         while ((fifosize = (int)whowas_fifo.size()) > 0)
 259         {
 260                 iter = whowas.find(whowas_fifo[0].second);
 261
 262                 /* hopefully redundant integrity check, but added while debugging r6216 */
 263                 if (iter == whowas.end())
 264                 {
 265                         /* this should never happen, if it does maps are corrupt */
 266                         ServerInstance->Logs->Log("WHOWAS",DEFAULT, "BUG: Whowas maps got corrupted! (3)");
 267                         return;
 268                 }
 269
 270                 whowas_set* n = (whowas_set*)iter->second;
 271
 272                 if (n->size())
 273                 {
 274                         while (n->begin() != n->end())
 275                         {
 276                                 WhoWasGroup *a = *(n->begin());
 277                                 delete a;
 278                                 n->pop_front();
 279                         }
 280                 }
 281
 282                 delete n;
 283                 whowas.erase(iter);
 284                 whowas_fifo.pop_front();
 285         }
 286 }
 287
 288 WhoWasGroup::WhoWasGroup(User* user) : host(user->host), dhost(user->dhost), ident(user->ident),
 289         server(user->server), gecos(user->fullname), signon(user->signon)
 290 {
 291 }
 292
 293 WhoWasGroup::~WhoWasGroup()
 294 {
 295 }
 296
 297 /* every hour, run this function which removes all entries older than Config->WhoWasMaxKeep */
 298 void WhoWasMaintainTimer::Tick(time_t)
 299 {
 300         Module* whowas = ServerInstance->Modules->Find("cmd_whowas.so");
 301         if (whowas)
 302         {
 303                 WhowasRequest(whowas, whowas, WhowasRequest::WHOWAS_MAINTAIN).Send();
 304         }
 305 }
 306
 307 class ModuleWhoWas : public Module
 308 {
 309         CommandWhowas cmd;
 310  public:
 311         ModuleWhoWas() : cmd(this)
 312         {
 313                 ServerInstance->AddCommand(&cmd);
 314         }
 315
 316         void OnRequest(Request& request)
 317         {
 318                 WhowasRequest& req = static_cast<WhowasRequest&>(request);
 319                 switch (req.type)
 320                 {
 321                         case WhowasRequest::WHOWAS_ADD:
 322                                 cmd.AddToWhoWas(req.user);
 323                                 break;
 324                         case WhowasRequest::WHOWAS_STATS:
 325                                 req.value = cmd.GetStats();
 326                                 break;
 327                         case WhowasRequest::WHOWAS_PRUNE:
 328                                 cmd.PruneWhoWas(ServerInstance->Time());
 329                                 break;
 330                         case WhowasRequest::WHOWAS_MAINTAIN:
 331                                 cmd.MaintainWhoWas(ServerInstance->Time());
 332                                 break;
 333                 }
 334         }
 335
 336         Version GetVersion()
 337         {
 338                 return Version("WHOWAS Command", VF_VENDOR);
 339         }
 340 };
 341
 342 MODULE_INIT(ModuleWhoWas)