]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/commands/cmd_whowas.cpp
Replace OnRehash() with ReadConfig() that is called on boot, on module load and on...
[user/henk/code/inspircd.git] / src / commands / cmd_whowas.cpp
index fd9544853c5e560f70aec924121b7bf2cd15f5a2..ea1020fbc6f798807601e97df7d199a864594bb0 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 #include "inspircd.h"
 #include "commands/cmd_whowas.h"
 
-WhoWasMaintainTimer * timer;
-
-extern "C" DllExport Command* init_command(InspIRCd* Instance)
-{
-       return new CommandWhowas(Instance);
-}
-
-CommandWhowas::CommandWhowas(InspIRCd* Instance) : Command(Instance, "WHOWAS", 0, 1, false, 2)
+CommandWhowas::CommandWhowas( Module* parent)
+       : Command(parent, "WHOWAS", 1)
+       , GroupSize(0), MaxGroups(0), MaxKeep(0)
 {
        syntax = "<nick>{,<nick>}";
-       timer = new WhoWasMaintainTimer(Instance, 3600);
-       Instance->Timers->AddTimer(timer);
+       Penalty = 2;
 }
 
-CmdResult CommandWhowas::Handle (const char* const* parameters, int, User* user)
+CmdResult CommandWhowas::Handle (const std::vector<std::string>& parameters, User* user)
 {
        /* if whowas disabled in config */
-       if (ServerInstance->Config->WhoWasGroupSize == 0 || ServerInstance->Config->WhoWasMaxGroups == 0)
+       if (this->GroupSize == 0 || this->MaxGroups == 0)
        {
-               user->WriteServ("421 %s %s :This command has been disabled.",user->nick,command.c_str());
+               user->WriteNumeric(421, "%s %s :This command has been disabled.",user->nick.c_str(),name.c_str());
                return CMD_FAILURE;
        }
 
-       whowas_users::iterator i = whowas.find(parameters[0]);
+       whowas_users::iterator i = whowas.find(assign(parameters[0]));
 
        if (i == whowas.end())
        {
-               user->WriteServ("406 %s %s :There was no such nickname",user->nick,parameters[0]);
-               user->WriteServ("369 %s %s :End of WHOWAS",user->nick,parameters[0]);
-               return CMD_FAILURE;
+               user->WriteNumeric(406, "%s %s :There was no such nickname",user->nick.c_str(),parameters[0].c_str());
        }
        else
        {
                whowas_set* grp = i->second;
-               if (grp->size())
+               if (!grp->empty())
                {
                        for (whowas_set::iterator ux = grp->begin(); ux != grp->end(); ux++)
                        {
                                WhoWasGroup* u = *ux;
-                               time_t rawtime = u->signon;
-                               tm *timeinfo;
-                               char b[MAXBUF];
-       
-                               timeinfo = localtime(&rawtime);
-                               
-                               /* XXX - 'b' could be only 25 chars long and then strlcpy() would terminate it for us too? */
-                               strlcpy(b,asctime(timeinfo),MAXBUF);
-                               b[24] = 0;
-
-                               user->WriteServ("314 %s %s %s %s * :%s",user->nick,parameters[0],u->ident,u->dhost,u->gecos);
-                               
-                               if (IS_OPER(user))
-                                       user->WriteServ("379 %s %s :was connecting from *@%s", user->nick, parameters[0], u->host);
-                               
-                               if (*ServerInstance->Config->HideWhoisServer && !IS_OPER(user))
-                                       user->WriteServ("312 %s %s %s :%s",user->nick,parameters[0], ServerInstance->Config->HideWhoisServer, b);
-                               else
-                                       user->WriteServ("312 %s %s %s :%s",user->nick,parameters[0], u->server, b);
+
+                               user->WriteNumeric(314, "%s %s %s %s * :%s",user->nick.c_str(),parameters[0].c_str(),
+                                       u->ident.c_str(),u->dhost.c_str(),u->gecos.c_str());
+
+                               if (user->HasPrivPermission("users/auspex"))
+                                       user->WriteNumeric(379, "%s %s :was connecting from *@%s",
+                                               user->nick.c_str(), parameters[0].c_str(), u->host.c_str());
+
+                               std::string signon = ServerInstance->TimeString(u->signon);
+                               bool hide_server = (!ServerInstance->Config->HideWhoisServer.empty() && !user->HasPrivPermission("servers/auspex"));
+                               user->WriteNumeric(312, "%s %s %s :%s",user->nick.c_str(), parameters[0].c_str(), (hide_server ? ServerInstance->Config->HideWhoisServer.c_str() : u->server.c_str()), signon.c_str());
                        }
                }
                else
                {
-                       user->WriteServ("406 %s %s :There was no such nickname",user->nick,parameters[0]);
-                       user->WriteServ("369 %s %s :End of WHOWAS",user->nick,parameters[0]);
-                       return CMD_FAILURE;
+                       user->WriteNumeric(406, "%s %s :There was no such nickname",user->nick.c_str(),parameters[0].c_str());
                }
        }
 
-       user->WriteServ("369 %s %s :End of WHOWAS",user->nick,parameters[0]);
+       user->WriteNumeric(369, "%s %s :End of WHOWAS",user->nick.c_str(),parameters[0].c_str());
        return CMD_SUCCESS;
 }
 
-CmdResult CommandWhowas::HandleInternal(const unsigned int id, const std::deque<classbase*> &parameters)
-{
-       switch (id)
-       {
-               case WHOWAS_ADD:
-                       AddToWhoWas((User*)parameters[0]);
-               break;
-
-               case WHOWAS_STATS:
-                       GetStats((Extensible*)parameters[0]);
-               break;
-
-               case WHOWAS_PRUNE:
-                       PruneWhoWas(ServerInstance->Time());
-               break;
-
-               case WHOWAS_MAINTAIN:
-                       MaintainWhoWas(ServerInstance->Time());
-               break;
-
-               default:
-               break;
-       }
-       return CMD_SUCCESS;
-}
-
-void CommandWhowas::GetStats(Extensible* ext)
+std::string CommandWhowas::GetStats()
 {
        int whowas_size = 0;
        int whowas_bytes = 0;
-       whowas_users_fifo::iterator iter;
-       for (iter = whowas_fifo.begin(); iter != whowas_fifo.end(); iter++)
+       for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
        {
-               whowas_set* n = (whowas_set*)whowas.find(iter->second)->second;
-               if (n->size())
-               {
-                       whowas_size += n->size();
-                       whowas_bytes += (sizeof(whowas_set) + ( sizeof(WhoWasGroup) * n->size() ) );
-               }
+               whowas_set* n = i->second;
+               whowas_size += n->size();
+               whowas_bytes += (sizeof(whowas_set) + ( sizeof(WhoWasGroup) * n->size() ) );
        }
-       stats.assign("Whowas(MAPSETS) " +ConvToStr(whowas_size)+" ("+ConvToStr(whowas_bytes)+" bytes)");
-       ext->Extend("stats", stats.c_str());
+       return "Whowas entries: " +ConvToStr(whowas_size)+" ("+ConvToStr(whowas_bytes)+" bytes)";
 }
 
 void CommandWhowas::AddToWhoWas(User* user)
 {
        /* if whowas disabled */
-       if (ServerInstance->Config->WhoWasGroupSize == 0 || ServerInstance->Config->WhoWasMaxGroups == 0)
+       if (this->GroupSize == 0 || this->MaxGroups == 0)
        {
                return;
        }
 
-       whowas_users::iterator iter = whowas.find(user->nick);
+       // Insert nick if it doesn't exist
+       // 'first' will point to the newly inserted element or to the existing element with an equivalent key
+       std::pair<whowas_users::iterator, bool> ret = whowas.insert(std::make_pair(irc::string(user->nick.c_str()), static_cast<whowas_set*>(NULL)));
 
-       if (iter == whowas.end())
+       if (ret.second) // If inserted
        {
+               // This nick is new, create a list for it and add the first record to it
                whowas_set* n = new whowas_set;
-               WhoWasGroup *a = new WhoWasGroup(user);
-               n->push_back(a);
-               whowas[user->nick] = n;
-               whowas_fifo.push_back(std::make_pair(ServerInstance->Time(),user->nick));
+               n->push_back(new WhoWasGroup(user));
+               ret.first->second = n;
+
+               // Add this nick to the fifo too
+               whowas_fifo.push_back(std::make_pair(ServerInstance->Time(), ret.first->first));
 
-               if ((int)(whowas.size()) > ServerInstance->Config->WhoWasMaxGroups)
+               if (whowas.size() > this->MaxGroups)
                {
-                       whowas_users::iterator iter2 = whowas.find(whowas_fifo[0].second);
-                       if (iter2 != whowas.end())
+                       // Too many nicks, remove the nick which was inserted the longest time ago from both the map and the fifo
+                       whowas_users::iterator it = whowas.find(whowas_fifo.front().second);
+                       if (it != whowas.end())
                        {
-                               whowas_set* n2 = (whowas_set*)iter2->second;
-
-                               if (n2->size())
-                               {
-                                       while (n2->begin() != n2->end())
-                                       {
-                                               WhoWasGroup *a2 = *(n2->begin());
-                                               delete a2;
-                                               n2->pop_front();
-                                       }
-                               }
-
-                               delete n2;
-                               whowas.erase(iter2);
+                               whowas_set* set = it->second;
+                               for (whowas_set::iterator i = set->begin(); i != set->end(); ++i)
+                                       delete *i;
+
+                               delete set;
+                               whowas.erase(it);
                        }
                        whowas_fifo.pop_front();
                }
        }
        else
        {
-               whowas_set* group = (whowas_set*)iter->second;
-               WhoWasGroup *a = new WhoWasGroup(user);
-               group->push_back(a);
+               // We've met this nick before, add a new record to the list
+               whowas_set* set = ret.first->second;
+               set->push_back(new WhoWasGroup(user));
 
-               if ((int)(group->size()) > ServerInstance->Config->WhoWasGroupSize)
+               // If there are too many records for this nick, remove the oldest (front)
+               if (set->size() > this->GroupSize)
                {
-                       WhoWasGroup *a2 = (WhoWasGroup*)*(group->begin());
-                       delete a2;
-                       group->pop_front();
+                       delete set->front();
+                       set->pop_front();
                }
        }
 }
 
 /* on rehash, refactor maps according to new conf values */
-void CommandWhowas::PruneWhoWas(time_t t)
+void CommandWhowas::Prune()
 {
-       /* config values */
-       int groupsize = ServerInstance->Config->WhoWasGroupSize;
-       int maxgroups = ServerInstance->Config->WhoWasMaxGroups;
-       int maxkeep =   ServerInstance->Config->WhoWasMaxKeep;
+       time_t min = ServerInstance->Time() - this->MaxKeep;
 
        /* first cut the list to new size (maxgroups) and also prune entries that are timed out. */
-       whowas_users::iterator iter;
-       int fifosize;
-       while ((fifosize = (int)whowas_fifo.size()) > 0)
+       while (!whowas_fifo.empty())
        {
-               if (fifosize > maxgroups || whowas_fifo[0].first < t - maxkeep)
+               if ((whowas_fifo.size() > this->MaxGroups) || (whowas_fifo.front().first < min))
                {
-                       iter = whowas.find(whowas_fifo[0].second);
+                       whowas_users::iterator iter = whowas.find(whowas_fifo.front().second);
 
                        /* hopefully redundant integrity check, but added while debugging r6216 */
                        if (iter == whowas.end())
                        {
                                /* this should never happen, if it does maps are corrupt */
-                               ServerInstance->Log(DEFAULT, "BUG: Whowas maps got corrupted! (1)");
+                               ServerInstance->Logs->Log("WHOWAS", LOG_DEFAULT, "BUG: Whowas maps got corrupted! (1)");
                                return;
                        }
 
-                       whowas_set* n = (whowas_set*)iter->second;
-
-                       if (n->size())
-                       {
-                               while (n->begin() != n->end())
-                               {
-                                       WhoWasGroup *a = *(n->begin());
-                                       delete a;
-                                       n->pop_front();
-                               }
-                       }
+                       whowas_set* set = iter->second;
+                       for (whowas_set::iterator i = set->begin(); i != set->end(); ++i)
+                               delete *i;
 
-                       delete n;
+                       delete set;
                        whowas.erase(iter);
                        whowas_fifo.pop_front();
                }
@@ -232,117 +176,102 @@ void CommandWhowas::PruneWhoWas(time_t t)
        }
 
        /* Then cut the whowas sets to new size (groupsize) */
-       fifosize = (int)whowas_fifo.size();
-       for (int i = 0; i < fifosize; i++)
+       for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
        {
-               iter = whowas.find(whowas_fifo[0].second);
-               /* hopefully redundant integrity check, but added while debugging r6216 */
-               if (iter == whowas.end())
+               whowas_set* n = i->second;
+               while (n->size() > this->GroupSize)
                {
-                       /* this should never happen, if it does maps are corrupt */
-                       ServerInstance->Log(DEFAULT, "BUG: Whowas maps got corrupted! (2)");
-                       return;
-               }
-               whowas_set* n = (whowas_set*)iter->second;
-               if (n->size())
-               {
-                       int nickcount = n->size();
-                       while (n->begin() != n->end() && nickcount > groupsize)
-                       {
-                               WhoWasGroup *a = *(n->begin());
-                               delete a;
-                               n->pop_front();
-                               nickcount--;
-                       }
+                       delete n->front();
+                       n->pop_front();
                }
        }
 }
 
 /* call maintain once an hour to remove expired nicks */
-void CommandWhowas::MaintainWhoWas(time_t t)
+void CommandWhowas::Maintain()
 {
-       for (whowas_users::iterator iter = whowas.begin(); iter != whowas.end(); iter++)
+       time_t min = ServerInstance->Time() - this->MaxKeep;
+       for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
        {
-               whowas_set* n = (whowas_set*)iter->second;
-               if (n->size())
+               whowas_set* set = i->second;
+               while (!set->empty() && set->front()->signon < min)
                {
-                       while ((n->begin() != n->end()) && ((*n->begin())->signon < t - ServerInstance->Config->WhoWasMaxKeep))
-                       {
-                               WhoWasGroup *a = *(n->begin());
-                               delete a;
-                               n->erase(n->begin());
-                       }
+                       delete set->front();
+                       set->pop_front();
                }
        }
 }
 
 CommandWhowas::~CommandWhowas()
 {
-       if (timer)
+       for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
        {
-               ServerInstance->Timers->DelTimer(timer);
+               whowas_set* set = i->second;
+               for (whowas_set::iterator j = set->begin(); j != set->end(); ++j)
+                       delete *j;
+
+               delete set;
        }
+}
 
-       whowas_users::iterator iter;
-       int fifosize;
-       while ((fifosize = (int)whowas_fifo.size()) > 0)
+WhoWasGroup::WhoWasGroup(User* user) : host(user->host), dhost(user->dhost), ident(user->ident),
+       server(user->server), gecos(user->fullname), signon(user->signon)
+{
+}
+
+class ModuleWhoWas : public Module
+{
+       CommandWhowas cmd;
+
+ public:
+       ModuleWhoWas() : cmd(this)
        {
-               iter = whowas.find(whowas_fifo[0].second);
+       }
 
-               /* hopefully redundant integrity check, but added while debugging r6216 */
-               if (iter == whowas.end())
-               {
-                       /* this should never happen, if it does maps are corrupt */
-                       ServerInstance->Log(DEFAULT, "BUG: Whowas maps got corrupted! (3)");
-                       return;
-               }
+       void init()
+       {
+               ServerInstance->Modules->AddService(cmd);
+       }
 
-               whowas_set* n = (whowas_set*)iter->second;
+       void OnGarbageCollect()
+       {
+               // Remove all entries older than MaxKeep
+               cmd.Maintain();
+       }
 
-               if (n->size())
-               {
-                       while (n->begin() != n->end())
-                       {
-                               WhoWasGroup *a = *(n->begin());
-                               delete a;
-                               n->pop_front();
-                       }
-               }
+       void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
+       {
+               cmd.AddToWhoWas(user);
+       }
+
+       ModResult OnStats(char symbol, User* user, string_list &results)
+       {
+               if (symbol == 'z')
+                       results.push_back(ServerInstance->Config->ServerName+" 249 "+user->nick+" :"+cmd.GetStats());
 
-               delete n;
-               whowas.erase(iter);
-               whowas_fifo.pop_front();
+               return MOD_RES_PASSTHRU;
        }
-}
 
-WhoWasGroup::WhoWasGroup(User* user) : host(NULL), dhost(NULL), ident(NULL), server(NULL), gecos(NULL), signon(user->signon)
-{
-       this->host = strdup(user->host);
-       this->dhost = strdup(user->dhost);
-       this->ident = strdup(user->ident);
-       this->server = user->server;
-       this->gecos = strdup(user->fullname);
-}
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("whowas");
+               unsigned int NewGroupSize = tag->getInt("groupsize", 10, 0, 10000);
+               unsigned int NewMaxGroups = tag->getInt("maxgroups", 10240, 0, 1000000);
+               unsigned int NewMaxKeep = tag->getDuration("maxkeep", 3600, 3600);
 
-WhoWasGroup::~WhoWasGroup()
-{
-       if (host)
-               free(host);
-       if (dhost)
-               free(dhost);
-       if (ident)
-               free(ident);
-       if (gecos)
-               free(gecos);
-}
+               if ((NewGroupSize == cmd.GroupSize) && (NewMaxGroups == cmd.MaxGroups) && (NewMaxKeep == cmd.MaxKeep))
+                       return;
 
-/* every hour, run this function which removes all entries older than Config->WhoWasMaxKeep */
-void WhoWasMaintainTimer::Tick(time_t)
-{
-       Command* whowas_command = ServerInstance->Parser->GetHandler("WHOWAS");
-       if (whowas_command)
+               cmd.GroupSize = NewGroupSize;
+               cmd.MaxGroups = NewMaxGroups;
+               cmd.MaxKeep = NewMaxKeep;
+               cmd.Prune();
+       }
+
+       Version GetVersion()
        {
-               std::deque<classbase*> params;
-               whowas_command->HandleInternal(WHOWAS_MAINTAIN, params);
+               return Version("WHOWAS", VF_VENDOR);
        }
-}
+};
+
+MODULE_INIT(ModuleWhoWas)