2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Dennis Friis <peavey@inspircd.org>
6 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
7 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
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/>.
29 class WriteCommonQuit : public User::ForEachNeighborHandler
31 ClientProtocol::Messages::Quit quitmsg;
32 ClientProtocol::Event quitevent;
33 ClientProtocol::Messages::Quit operquitmsg;
34 ClientProtocol::Event operquitevent;
36 void Execute(LocalUser* user) CXX11_OVERRIDE
38 user->Send(user->IsOper() ? operquitevent : quitevent);
42 WriteCommonQuit(User* user, const std::string& msg, const std::string& opermsg)
44 , quitevent(ServerInstance->GetRFCEvents().quit, quitmsg)
45 , operquitmsg(user, opermsg)
46 , operquitevent(ServerInstance->GetRFCEvents().quit, operquitmsg)
48 user->ForEachNeighbor(*this, false);
52 void CheckPingTimeout(LocalUser* user)
54 // Check if it is time to ping the user yet.
55 if (ServerInstance->Time() < user->nextping)
58 // This user didn't answer the last ping, remove them.
62 FIRST_MOD_RESULT(OnConnectionFail, res, (user, I_ERR_TIMEOUT));
63 if (res == MOD_RES_ALLOW)
65 // A module is preventing this user from being timed out.
67 user->nextping = ServerInstance->Time() + user->MyClass->GetPingTime();
71 time_t secs = ServerInstance->Time() - (user->nextping - user->MyClass->GetPingTime());
72 const std::string message = "Ping timeout: " + ConvToStr(secs) + (secs != 1 ? " seconds" : " second");
73 ServerInstance->Users.QuitUser(user, message);
77 // Send a ping to the client.
78 ClientProtocol::Messages::Ping ping;
79 user->Send(ServerInstance->GetRFCEvents().ping, ping);
81 user->nextping = ServerInstance->Time() + user->MyClass->GetPingTime();
84 void CheckRegistrationTimeout(LocalUser* user)
86 if (user->GetClass() && (ServerInstance->Time() > (user->signon + user->GetClass()->GetRegTimeout())))
88 // Either the user did not send NICK/USER or a module blocked registration in
89 // OnCheckReady until the client timed out.
90 ServerInstance->Users.QuitUser(user, "Registration timeout");
94 void CheckModulesReady(LocalUser* user)
97 FIRST_MOD_RESULT(OnCheckReady, res, (user));
98 if (res == MOD_RES_PASSTHRU)
100 // User has sent NICK/USER and modules are ready.
105 // If the user has been quit in OnCheckReady then we shouldn't quit
106 // them again for having a registration timeout.
108 CheckRegistrationTimeout(user);
112 UserManager::UserManager()
114 , unregistered_count(0)
119 UserManager::~UserManager()
121 for (user_hash::iterator i = clientlist.begin(); i != clientlist.end(); ++i)
127 void UserManager::AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
129 // User constructor allocates a new UUID for the user and inserts it into the uuidlist
130 LocalUser* const New = new LocalUser(socket, client, server);
131 UserIOHandler* eh = &New->eh;
133 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New user fd: %d", socket);
135 this->unregistered_count++;
136 this->clientlist[New->nick] = New;
138 this->local_users.push_front(New);
139 FOREACH_MOD(OnUserInit, (New));
141 if (!SocketEngine::AddFd(eh, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE))
143 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "Internal error on new connection");
144 this->QuitUser(New, "Internal error handling connection");
148 // If this listener has an IO hook provider set then tell it about the connection
149 for (ListenSocket::IOHookProvList::iterator i = via->iohookprovs.begin(); i != via->iohookprovs.end(); ++i)
151 ListenSocket::IOHookProvRef& iohookprovref = *i;
154 if (!iohookprovref.GetProvider().empty())
156 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "Non-existent I/O hook '%s' in <bind:%s> tag at %s",
157 iohookprovref.GetProvider().c_str(),
158 i == via->iohookprovs.begin() ? "hook" : "ssl",
159 via->bind_tag->getTagLocation().c_str());
160 this->QuitUser(New, "Internal error handling connection");
166 iohookprovref->OnAccept(eh, client, server);
168 // IOHook could have encountered a fatal error, e.g. if the TLS ClientHello
169 // was already in the queue and there was no common TLS version.
170 if (!eh->getError().empty())
172 QuitUser(New, eh->getError());
177 if (this->local_users.size() > ServerInstance->Config->SoftLimit)
179 ServerInstance->SNO->WriteToSnoMask('a', "Warning: softlimit value has been reached: %d clients", ServerInstance->Config->SoftLimit);
180 this->QuitUser(New,"No more connections allowed");
184 // First class check. We do this again in LocalUser::FullConnect() after DNS is done, and NICK/USER is received.
186 // If the user doesn't have an acceptable connect class CheckClass() quits them
187 New->CheckClass(ServerInstance->Config->CCOnConnect);
192 * even with bancache, we still have to keep User::exempt current.
193 * besides that, if we get a positive bancache hit, we still won't fuck
194 * them over if they are exempt. -- w00t
196 New->exempt = (ServerInstance->XLines->MatchesLine("E",New) != NULL);
198 BanCacheHit* const b = ServerInstance->BanCache.GetHit(New->GetIPString());
201 if (!b->Type.empty() && !New->exempt)
204 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Positive hit for " + New->GetIPString());
205 if (!ServerInstance->Config->XLineMessage.empty())
206 New->WriteNumeric(ERR_YOUREBANNEDCREEP, ServerInstance->Config->XLineMessage);
208 if (ServerInstance->Config->HideBans)
209 this->QuitUser(New, b->Type + "-lined", &b->Reason);
211 this->QuitUser(New, b->Reason);
216 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Negative hit for " + New->GetIPString());
223 XLine* r = ServerInstance->XLines->MatchesLine("Z",New);
233 if (ServerInstance->Config->RawLog)
234 New->WriteNotice("*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.");
236 FOREACH_MOD(OnSetUserIP, (New));
238 FOREACH_MOD(OnUserPostInit, (New));
241 void UserManager::QuitUser(User* user, const std::string& quitmessage, const std::string* operquitmessage)
245 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Tried to quit quitting user: " + user->nick);
251 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Tried to quit server user: " + user->nick);
255 std::string quitmsg(quitmessage);
256 std::string operquitmsg;
258 operquitmsg.assign(*operquitmessage);
260 LocalUser* const localuser = IS_LOCAL(user);
263 ModResult MOD_RESULT;
264 FIRST_MOD_RESULT(OnUserPreQuit, MOD_RESULT, (localuser, quitmsg, operquitmsg));
265 if (MOD_RESULT == MOD_RES_DENY)
269 if (quitmsg.length() > ServerInstance->Config->Limits.MaxQuit)
270 quitmsg.erase(ServerInstance->Config->Limits.MaxQuit + 1);
272 if (operquitmsg.empty())
273 operquitmsg.assign(quitmsg);
274 else if (operquitmsg.length() > ServerInstance->Config->Limits.MaxQuit)
275 operquitmsg.erase(ServerInstance->Config->Limits.MaxQuit + 1);
277 user->quitting = true;
278 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "QuitUser: %s=%s '%s'", user->uuid.c_str(), user->nick.c_str(), quitmessage.c_str());
281 ClientProtocol::Messages::Error errormsg(InspIRCd::Format("Closing link: (%s@%s) [%s]", user->ident.c_str(), user->GetRealHost().c_str(), operquitmsg.c_str()));
282 localuser->Send(ServerInstance->GetRFCEvents().error, errormsg);
285 ServerInstance->GlobalCulls.AddItem(user);
287 if (user->registered == REG_ALL)
289 FOREACH_MOD(OnUserQuit, (user, quitmsg, operquitmsg));
290 WriteCommonQuit(user, quitmsg, operquitmsg);
293 unregistered_count--;
297 LocalUser* lu = IS_LOCAL(user);
298 FOREACH_MOD(OnUserDisconnect, (lu));
301 if (lu->registered == REG_ALL)
302 ServerInstance->SNO->WriteToSnoMask('q',"Client exiting: %s (%s) [%s]", user->GetFullRealHost().c_str(), user->GetIPString().c_str(), operquitmsg.c_str());
303 local_users.erase(lu);
306 if (!clientlist.erase(user->nick))
307 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Nick not found in clientlist, cannot remove: " + user->nick);
309 uuidlist.erase(user->uuid);
310 user->PurgeEmptyChannels();
314 void UserManager::AddClone(User* user)
316 CloneCounts& counts = clonemap[user->GetCIDRMask()];
322 void UserManager::RemoveCloneCounts(User *user)
324 CloneMap::iterator it = clonemap.find(user->GetCIDRMask());
325 if (it != clonemap.end())
327 CloneCounts& counts = it->second;
329 if (counts.global == 0)
331 // No more users from this IP, remove entry from the map
341 void UserManager::RehashCloneCounts()
345 const user_hash& hash = ServerInstance->Users.GetUsers();
346 for (user_hash::const_iterator i = hash.begin(); i != hash.end(); ++i)
353 const UserManager::CloneCounts& UserManager::GetCloneCounts(User* user) const
355 CloneMap::const_iterator it = clonemap.find(user->GetCIDRMask());
356 if (it != clonemap.end())
359 return zeroclonecounts;
362 void UserManager::ServerNoticeAll(const char* text, ...)
365 VAFORMAT(message, text, text);
366 ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, ServerInstance->Config->ServerName, message, MSG_NOTICE);
367 ClientProtocol::Event msgevent(ServerInstance->GetRFCEvents().privmsg, msg);
369 for (LocalList::const_iterator i = local_users.begin(); i != local_users.end(); ++i)
371 LocalUser* user = *i;
372 user->Send(msgevent);
377 * This function is called once a second from the mainloop.
378 * It is intended to do background checking on all the users, e.g. do
379 * ping checks, registration timeouts, etc.
381 void UserManager::DoBackgroundUserStuff()
383 for (LocalList::iterator i = local_users.begin(); i != local_users.end(); )
385 // It's possible that we quit the user below due to ping timeout etc. and QuitUser() removes it from the list
386 LocalUser* curr = *i;
389 if (curr->CommandFloodPenalty || curr->eh.getSendQSize())
391 unsigned int rate = curr->MyClass->GetCommandRate();
392 if (curr->CommandFloodPenalty > rate)
393 curr->CommandFloodPenalty -= rate;
395 curr->CommandFloodPenalty = 0;
396 curr->eh.OnDataReady();
399 switch (curr->registered)
402 CheckPingTimeout(curr);
406 CheckModulesReady(curr);
410 CheckRegistrationTimeout(curr);
416 already_sent_t UserManager::NextAlreadySentId()
418 if (++already_sent_id == 0)
420 // Wrapped around, reset the already_sent ids of all users
422 for (LocalList::iterator i = local_users.begin(); i != local_users.end(); ++i)
424 LocalUser* user = *i;
425 user->already_sent = 0;
428 return already_sent_id;