2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
24 #include "commands/cmd_whowas.h"
26 CommandWhowas::CommandWhowas( Module* parent)
27 : Command(parent, "WHOWAS", 1)
29 syntax = "<nick>{,<nick>}";
33 CmdResult CommandWhowas::Handle (const std::vector<std::string>& parameters, User* user)
35 /* if whowas disabled in config */
36 if (!manager.IsEnabled())
38 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :This command has been disabled.", name.c_str());
42 const WhoWas::Nick* const nick = manager.FindNick(parameters[0]);
45 user->WriteNumeric(ERR_WASNOSUCHNICK, "%s :There was no such nickname", parameters[0].c_str());
49 const WhoWas::Nick::List& list = nick->entries;
52 for (WhoWas::Nick::List::const_iterator i = list.begin(); i != list.end(); ++i)
54 WhoWas::Entry* u = *i;
56 user->WriteNumeric(RPL_WHOWASUSER, "%s %s %s * :%s", parameters[0].c_str(),
57 u->ident.c_str(),u->dhost.c_str(),u->gecos.c_str());
59 if (user->HasPrivPermission("users/auspex"))
60 user->WriteNumeric(RPL_WHOWASIP, "%s :was connecting from *@%s",
61 parameters[0].c_str(), u->host.c_str());
63 std::string signon = InspIRCd::TimeString(u->signon);
64 bool hide_server = (!ServerInstance->Config->HideWhoisServer.empty() && !user->HasPrivPermission("servers/auspex"));
65 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());
70 user->WriteNumeric(RPL_ENDOFWHOWAS, "%s :End of WHOWAS", parameters[0].c_str());
74 WhoWas::Manager::Manager()
75 : GroupSize(0), MaxGroups(0), MaxKeep(0)
79 const WhoWas::Nick* WhoWas::Manager::FindNick(const std::string& nickname) const
81 whowas_users::const_iterator it = whowas.find(nickname);
82 if (it == whowas.end())
85 const Nick* nick = it->second;
86 if (nick->entries.empty())
91 WhoWas::Manager::Stats WhoWas::Manager::GetStats() const
93 size_t entrycount = 0;
94 for (whowas_users::const_iterator i = whowas.begin(); i != whowas.end(); ++i)
96 WhoWas::Nick::List& list = i->second->entries;
97 entrycount += list.size();
101 stats.entrycount = entrycount;
105 void WhoWas::Manager::Add(User* user)
110 // Insert nick if it doesn't exist
111 // 'first' will point to the newly inserted element or to the existing element with an equivalent key
112 std::pair<whowas_users::iterator, bool> ret = whowas.insert(std::make_pair(user->nick, static_cast<WhoWas::Nick*>(NULL)));
114 if (ret.second) // If inserted
116 // This nick is new, create a list for it and add the first record to it
117 WhoWas::Nick* nick = new WhoWas::Nick(ret.first->first);
118 nick->entries.push_back(new Entry(user));
119 ret.first->second = nick;
121 // Add this nick to the fifo too
122 whowas_fifo.push_back(nick);
124 if (whowas.size() > this->MaxGroups)
126 // Too many nicks, remove the nick which was inserted the longest time ago from both the map and the fifo
127 nick = whowas_fifo.front();
128 whowas_fifo.pop_front();
129 whowas.erase(nick->nick);
135 // We've met this nick before, add a new record to the list
136 WhoWas::Nick::List& list = ret.first->second->entries;
137 list.push_back(new Entry(user));
139 // If there are too many records for this nick, remove the oldest (front)
140 if (list.size() > this->GroupSize)
148 /* on rehash, refactor maps according to new conf values */
149 void WhoWas::Manager::Prune()
151 time_t min = ServerInstance->Time() - this->MaxKeep;
153 /* first cut the list to new size (maxgroups) and also prune entries that are timed out. */
154 while (!whowas_fifo.empty())
156 WhoWas::Nick* nick = whowas_fifo.front();
157 if ((whowas_fifo.size() > this->MaxGroups) || (nick->addtime < min))
159 /* hopefully redundant integrity check, but added while debugging r6216 */
160 if (!whowas.erase(nick->nick))
162 /* this should never happen, if it does maps are corrupt */
163 ServerInstance->Logs->Log("WHOWAS", LOG_DEFAULT, "BUG: Whowas maps got corrupted! (1)");
167 whowas_fifo.pop_front();
174 /* Then cut the whowas sets to new size (groupsize) */
175 for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
177 WhoWas::Nick::List& list = i->second->entries;
178 while (list.size() > this->GroupSize)
186 /* call maintain once an hour to remove expired nicks */
187 void WhoWas::Manager::Maintain()
189 time_t min = ServerInstance->Time() - this->MaxKeep;
190 for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
192 WhoWas::Nick::List& list = i->second->entries;
193 while (!list.empty() && list.front()->signon < min)
201 WhoWas::Manager::~Manager()
203 for (whowas_users::iterator i = whowas.begin(); i != whowas.end(); ++i)
205 WhoWas::Nick* nick = i->second;
210 bool WhoWas::Manager::IsEnabled() const
212 return ((GroupSize != 0) && (MaxGroups != 0));
215 void WhoWas::Manager::UpdateConfig(unsigned int NewGroupSize, unsigned int NewMaxGroups, unsigned int NewMaxKeep)
217 if ((NewGroupSize == GroupSize) && (NewMaxGroups == MaxGroups) && (NewMaxKeep == MaxKeep))
220 GroupSize = NewGroupSize;
221 MaxGroups = NewMaxGroups;
222 MaxKeep = NewMaxKeep;
226 WhoWas::Entry::Entry(User* user)
230 , server(user->server->GetName())
231 , gecos(user->fullname)
232 , signon(user->signon)
236 WhoWas::Nick::Nick(const std::string& nickname)
237 : addtime(ServerInstance->Time())
242 WhoWas::Nick::~Nick()
244 stdalgo::delete_all(entries);
247 class ModuleWhoWas : public Module
252 ModuleWhoWas() : cmd(this)
256 void OnGarbageCollect()
258 // Remove all entries older than MaxKeep
259 cmd.manager.Maintain();
262 void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
264 cmd.manager.Add(user);
267 ModResult OnStats(char symbol, User* user, string_list &results)
270 results.push_back("249 "+user->nick+" :Whowas entries: "+ConvToStr(cmd.manager.GetStats().entrycount));
272 return MOD_RES_PASSTHRU;
275 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
277 ConfigTag* tag = ServerInstance->Config->ConfValue("whowas");
278 unsigned int NewGroupSize = tag->getInt("groupsize", 10, 0, 10000);
279 unsigned int NewMaxGroups = tag->getInt("maxgroups", 10240, 0, 1000000);
280 unsigned int NewMaxKeep = tag->getDuration("maxkeep", 3600, 3600);
282 cmd.manager.UpdateConfig(NewGroupSize, NewMaxGroups, NewMaxKeep);
287 return Version("WHOWAS", VF_VENDOR);
291 MODULE_INIT(ModuleWhoWas)