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(),command.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 && !user->HasPrivPermission("servers/auspex"))
  69                                         user->WriteNumeric(312, "%s %s %s :%s",user->nick.c_str(),parameters[0].c_str(), ServerInstance->Config->HideWhoisServer, b);
  70                                 else
  71                                         user->WriteNumeric(312, "%s %s %s :%s",user->nick.c_str(),parameters[0].c_str(), u->server, 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         stats.assign("Whowas(MAPSETS) " +ConvToStr(whowas_size)+" ("+ConvToStr(whowas_bytes)+" bytes)");
 101         return stats;
 102 }
 103
 104 void CommandWhowas::AddToWhoWas(User* user)
 105 {
 106         /* if whowas disabled */
 107         if (ServerInstance->Config->WhoWasGroupSize == 0 || ServerInstance->Config->WhoWasMaxGroups == 0)
 108         {
 109                 return;
 110         }
 111
 112         whowas_users::iterator iter = whowas.find(irc::string(user->nick.c_str()));
 113
 114         if (iter == whowas.end())
 115         {
 116                 whowas_set* n = new whowas_set;
 117                 WhoWasGroup *a = new WhoWasGroup(user);
 118                 n->push_back(a);
 119                 whowas[user->nick.c_str()] = n;
 120                 whowas_fifo.push_back(std::make_pair(ServerInstance->Time(),user->nick.c_str()));
 121
 122                 if ((int)(whowas.size()) > ServerInstance->Config->WhoWasMaxGroups)
 123                 {
 124                         whowas_users::iterator iter2 = whowas.find(whowas_fifo[0].second);
 125                         if (iter2 != whowas.end())
 126                         {
 127                                 whowas_set* n2 = (whowas_set*)iter2->second;
 128
 129                                 if (n2->size())
 130                                 {
 131                                         while (n2->begin() != n2->end())
 132                                         {
 133                                                 WhoWasGroup *a2 = *(n2->begin());
 134                                                 delete a2;
 135                                                 n2->pop_front();
 136                                         }
 137                                 }
 138
 139                                 delete n2;
 140                                 whowas.erase(iter2);
 141                         }
 142                         whowas_fifo.pop_front();
 143                 }
 144         }
 145         else
 146         {
 147                 whowas_set* group = (whowas_set*)iter->second;
 148                 WhoWasGroup *a = new WhoWasGroup(user);
 149                 group->push_back(a);
 150
 151                 if ((int)(group->size()) > ServerInstance->Config->WhoWasGroupSize)
 152                 {
 153                         WhoWasGroup *a2 = (WhoWasGroup*)*(group->begin());
 154                         delete a2;
 155                         group->pop_front();
 156                 }
 157         }
 158 }
 159
 160 /* on rehash, refactor maps according to new conf values */
 161 void CommandWhowas::PruneWhoWas(time_t t)
 162 {
 163         /* config values */
 164         int groupsize = ServerInstance->Config->WhoWasGroupSize;
 165         int maxgroups = ServerInstance->Config->WhoWasMaxGroups;
 166         int maxkeep =   ServerInstance->Config->WhoWasMaxKeep;
 167
 168         /* first cut the list to new size (maxgroups) and also prune entries that are timed out. */
 169         whowas_users::iterator iter;
 170         int fifosize;
 171         while ((fifosize = (int)whowas_fifo.size()) > 0)
 172         {
 173                 if (fifosize > maxgroups || whowas_fifo[0].first < t - maxkeep)
 174                 {
 175                         iter = whowas.find(whowas_fifo[0].second);
 176
 177                         /* hopefully redundant integrity check, but added while debugging r6216 */
 178                         if (iter == whowas.end())
 179                         {
 180                                 /* this should never happen, if it does maps are corrupt */
 181                                 ServerInstance->Logs->Log("WHOWAS",DEFAULT, "BUG: Whowas maps got corrupted! (1)");
 182                                 return;
 183                         }
 184
 185                         whowas_set* n = (whowas_set*)iter->second;
 186
 187                         if (n->size())
 188                         {
 189                                 while (n->begin() != n->end())
 190                                 {
 191                                         WhoWasGroup *a = *(n->begin());
 192                                         delete a;
 193                                         n->pop_front();
 194                                 }
 195                         }
 196
 197                         delete n;
 198                         whowas.erase(iter);
 199                         whowas_fifo.pop_front();
 200                 }
 201                 else
 202                         break;
 203         }
 204
 205         /* Then cut the whowas sets to new size (groupsize) */
 206         fifosize = (int)whowas_fifo.size();
 207         for (int i = 0; i < fifosize; i++)
 208         {
 209                 iter = whowas.find(whowas_fifo[0].second);
 210                 /* hopefully redundant integrity check, but added while debugging r6216 */
 211                 if (iter == whowas.end())
 212                 {
 213                         /* this should never happen, if it does maps are corrupt */
 214                         ServerInstance->Logs->Log("WHOWAS",DEFAULT, "BUG: Whowas maps got corrupted! (2)");
 215                         return;
 216                 }
 217                 whowas_set* n = (whowas_set*)iter->second;
 218                 if (n->size())
 219                 {
 220                         int nickcount = n->size();
 221                         while (n->begin() != n->end() && nickcount > groupsize)
 222                         {
 223                                 WhoWasGroup *a = *(n->begin());
 224                                 delete a;
 225                                 n->pop_front();
 226                                 nickcount--;
 227                         }
 228                 }
 229         }
 230 }
 231
 232 /* call maintain once an hour to remove expired nicks */
 233 void CommandWhowas::MaintainWhoWas(time_t t)
 234 {
 235         for (whowas_users::iterator iter = whowas.begin(); iter != whowas.end(); iter++)
 236         {
 237                 whowas_set* n = (whowas_set*)iter->second;
 238                 if (n->size())
 239                 {
 240                         while ((n->begin() != n->end()) && ((*n->begin())->signon < t - ServerInstance->Config->WhoWasMaxKeep))
 241                         {
 242                                 WhoWasGroup *a = *(n->begin());
 243                                 delete a;
 244                                 n->erase(n->begin());
 245                         }
 246                 }
 247         }
 248 }
 249
 250 CommandWhowas::~CommandWhowas()
 251 {
 252         if (timer)
 253         {
 254                 ServerInstance->Timers->DelTimer(timer);
 255         }
 256
 257         whowas_users::iterator iter;
 258         int fifosize;
 259         while ((fifosize = (int)whowas_fifo.size()) > 0)
 260         {
 261                 iter = whowas.find(whowas_fifo[0].second);
 262
 263                 /* hopefully redundant integrity check, but added while debugging r6216 */
 264                 if (iter == whowas.end())
 265                 {
 266                         /* this should never happen, if it does maps are corrupt */
 267                         ServerInstance->Logs->Log("WHOWAS",DEFAULT, "BUG: Whowas maps got corrupted! (3)");
 268                         return;
 269                 }
 270
 271                 whowas_set* n = (whowas_set*)iter->second;
 272
 273                 if (n->size())
 274                 {
 275                         while (n->begin() != n->end())
 276                         {
 277                                 WhoWasGroup *a = *(n->begin());
 278                                 delete a;
 279                                 n->pop_front();
 280                         }
 281                 }
 282
 283                 delete n;
 284                 whowas.erase(iter);
 285                 whowas_fifo.pop_front();
 286         }
 287 }
 288
 289 WhoWasGroup::WhoWasGroup(User* user) : host(user->host), dhost(user->dhost), ident(user->ident),
 290         server(user->server), gecos(user->fullname), signon(user->signon)
 291 {
 292 }
 293
 294 WhoWasGroup::~WhoWasGroup()
 295 {
 296 }
 297
 298 /* every hour, run this function which removes all entries older than Config->WhoWasMaxKeep */
 299 void WhoWasMaintainTimer::Tick(time_t)
 300 {
 301         Module* whowas = ServerInstance->Modules->Find("cmd_whowas.so");
 302         if (whowas)
 303         {
 304                 WhowasRequest(whowas, whowas, WhowasRequest::WHOWAS_MAINTAIN).Send();
 305         }
 306 }
 307
 308 class ModuleWhoWas : public Module
 309 {
 310         CommandWhowas cmd;
 311  public:
 312         ModuleWhoWas() : cmd(this)
 313         {
 314                 ServerInstance->AddCommand(&cmd);
 315         }
 316
 317         const char* OnRequest(Request* request)
 318         {
 319                 WhowasRequest* req = static_cast<WhowasRequest*>(request);
 320                 switch (req->type)
 321                 {
 322                         case WhowasRequest::WHOWAS_ADD:
 323                                 cmd.AddToWhoWas(req->user);
 324                                 break;
 325                         case WhowasRequest::WHOWAS_STATS:
 326                                 req->value = cmd.GetStats();
 327                                 break;
 328                         case WhowasRequest::WHOWAS_PRUNE:
 329                                 cmd.PruneWhoWas(ServerInstance->Time());
 330                                 break;
 331                         case WhowasRequest::WHOWAS_MAINTAIN:
 332                                 cmd.MaintainWhoWas(ServerInstance->Time());
 333                                 break;
 334                 }
 335                 return NULL;
 336         }
 337
 338         Version GetVersion()
 339         {
 340                 return Version("WHOWAS Command", VF_VENDOR);
 341         }
 342 };
 343
 344 MODULE_INIT(ModuleWhoWas)