src/usermanager.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   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>
   8  *
   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.
  12  *
  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
  16  * details.
  17  *
  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/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "xline.h"
  25 #include "iohook.h"
  26
  27 namespace
  28 {
  29         class WriteCommonQuit : public User::ForEachNeighborHandler
  30         {
  31                 std::string line;
  32                 std::string operline;
  33
  34                 void Execute(LocalUser* user) CXX11_OVERRIDE
  35                 {
  36                         user->Write(user->IsOper() ? operline : line);
  37                 }
  38
  39          public:
  40                 WriteCommonQuit(User* user, const std::string& msg, const std::string& opermsg)
  41                         : line(":" + user->GetFullHost() + " QUIT :")
  42                         , operline(line)
  43                 {
  44                         line += msg;
  45                         operline += opermsg;
  46                         user->ForEachNeighbor(*this, false);
  47                 }
  48         };
  49 }
  50
  51 UserManager::UserManager()
  52         : already_sent_id(0)
  53         , unregistered_count(0)
  54 {
  55 }
  56
  57 UserManager::~UserManager()
  58 {
  59         for (user_hash::iterator i = clientlist.begin(); i != clientlist.end(); ++i)
  60         {
  61                 delete i->second;
  62         }
  63 }
  64
  65 /* add a client connection to the sockets list */
  66 void UserManager::AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
  67 {
  68         /* NOTE: Calling this one parameter constructor for User automatically
  69          * allocates a new UUID and places it in the hash_map.
  70          */
  71         LocalUser* const New = new LocalUser(socket, client, server);
  72         UserIOHandler* eh = &New->eh;
  73
  74         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New user fd: %d", socket);
  75
  76         this->unregistered_count++;
  77
  78         this->clientlist[New->nick] = New;
  79         this->AddClone(New);
  80
  81         this->local_users.push_front(New);
  82
  83         if (!SocketEngine::AddFd(eh, FD_WANT_FAST_READ | FD_WANT_EDGE_WRITE))
  84         {
  85                 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "Internal error on new connection");
  86                 this->QuitUser(New, "Internal error handling connection");
  87                 return;
  88         }
  89
  90         // If this listener has an IO hook provider set then tell it about the connection
  91         for (ListenSocket::IOHookProvList::iterator i = via->iohookprovs.begin(); i != via->iohookprovs.end(); ++i)
  92         {
  93                 ListenSocket::IOHookProvRef& iohookprovref = *i;
  94                 if (!iohookprovref)
  95                         continue;
  96
  97                 iohookprovref->OnAccept(eh, client, server);
  98                 // IOHook could have encountered a fatal error, e.g. if the TLS ClientHello was already in the queue and there was no common TLS version
  99                 if (!eh->getError().empty())
 100                 {
 101                         QuitUser(New, eh->getError());
 102                         return;
 103                 }
 104         }
 105
 106         if (this->local_users.size() > ServerInstance->Config->SoftLimit)
 107         {
 108                 ServerInstance->SNO->WriteToSnoMask('a', "Warning: softlimit value has been reached: %d clients", ServerInstance->Config->SoftLimit);
 109                 this->QuitUser(New,"No more connections allowed");
 110                 return;
 111         }
 112
 113         /*
 114          * First class check. We do this again in FullConnect after DNS is done, and NICK/USER is recieved.
 115          * See my note down there for why this is required. DO NOT REMOVE. :) -- w00t
 116          */
 117         New->SetClass();
 118
 119         /*
 120          * Check connect class settings and initialise settings into User.
 121          * This will be done again after DNS resolution. -- w00t
 122          */
 123         New->CheckClass(ServerInstance->Config->CCOnConnect);
 124         if (New->quitting)
 125                 return;
 126
 127         /*
 128          * even with bancache, we still have to keep User::exempt current.
 129          * besides that, if we get a positive bancache hit, we still won't fuck
 130          * them over if they are exempt. -- w00t
 131          */
 132         New->exempt = (ServerInstance->XLines->MatchesLine("E",New) != NULL);
 133
 134         BanCacheHit* const b = ServerInstance->BanCache.GetHit(New->GetIPString());
 135         if (b)
 136         {
 137                 if (!b->Type.empty() && !New->exempt)
 138                 {
 139                         /* user banned */
 140                         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Positive hit for " + New->GetIPString());
 141                         if (!ServerInstance->Config->XLineMessage.empty())
 142                                 New->WriteNumeric(ERR_YOUREBANNEDCREEP, ServerInstance->Config->XLineMessage);
 143                         this->QuitUser(New, b->Reason);
 144                         return;
 145                 }
 146                 else
 147                 {
 148                         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Negative hit for " + New->GetIPString());
 149                 }
 150         }
 151         else
 152         {
 153                 if (!New->exempt)
 154                 {
 155                         XLine* r = ServerInstance->XLines->MatchesLine("Z",New);
 156
 157                         if (r)
 158                         {
 159                                 r->Apply(New);
 160                                 return;
 161                         }
 162                 }
 163         }
 164
 165         if (ServerInstance->Config->RawLog)
 166                 New->WriteNotice("*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.");
 167
 168         FOREACH_MOD(OnSetUserIP, (New));
 169         if (New->quitting)
 170                 return;
 171
 172         FOREACH_MOD(OnUserInit, (New));
 173 }
 174
 175 void UserManager::QuitUser(User* user, const std::string& quitreason, const std::string* operreason)
 176 {
 177         if (user->quitting)
 178         {
 179                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Tried to quit quitting user: " + user->nick);
 180                 return;
 181         }
 182
 183         if (IS_SERVER(user))
 184         {
 185                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Tried to quit server user: " + user->nick);
 186                 return;
 187         }
 188
 189         user->quitting = true;
 190
 191         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "QuitUser: %s=%s '%s'", user->uuid.c_str(), user->nick.c_str(), quitreason.c_str());
 192         user->Write("ERROR :Closing link: (%s@%s) [%s]", user->ident.c_str(), user->host.c_str(), operreason ? operreason->c_str() : quitreason.c_str());
 193
 194         std::string reason;
 195         reason.assign(quitreason, 0, ServerInstance->Config->Limits.MaxQuit);
 196         if (!operreason)
 197                 operreason = &reason;
 198
 199         ServerInstance->GlobalCulls.AddItem(user);
 200
 201         if (user->registered == REG_ALL)
 202         {
 203                 FOREACH_MOD(OnUserQuit, (user, reason, *operreason));
 204                 WriteCommonQuit(user, reason, *operreason);
 205         }
 206         else
 207                 unregistered_count--;
 208
 209         if (IS_LOCAL(user))
 210         {
 211                 LocalUser* lu = IS_LOCAL(user);
 212                 FOREACH_MOD(OnUserDisconnect, (lu));
 213                 lu->eh.Close();
 214
 215                 if (lu->registered == REG_ALL)
 216                         ServerInstance->SNO->WriteToSnoMask('q',"Client exiting: %s (%s) [%s]", user->GetFullRealHost().c_str(), user->GetIPString().c_str(), operreason->c_str());
 217                 local_users.erase(lu);
 218         }
 219
 220         if (!clientlist.erase(user->nick))
 221                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Nick not found in clientlist, cannot remove: " + user->nick);
 222
 223         uuidlist.erase(user->uuid);
 224         user->PurgeEmptyChannels();
 225 }
 226
 227 void UserManager::AddClone(User* user)
 228 {
 229         CloneCounts& counts = clonemap[user->GetCIDRMask()];
 230         counts.global++;
 231         if (IS_LOCAL(user))
 232                 counts.local++;
 233 }
 234
 235 void UserManager::RemoveCloneCounts(User *user)
 236 {
 237         CloneMap::iterator it = clonemap.find(user->GetCIDRMask());
 238         if (it != clonemap.end())
 239         {
 240                 CloneCounts& counts = it->second;
 241                 counts.global--;
 242                 if (counts.global == 0)
 243                 {
 244                         // No more users from this IP, remove entry from the map
 245                         clonemap.erase(it);
 246                         return;
 247                 }
 248
 249                 if (IS_LOCAL(user))
 250                         counts.local--;
 251         }
 252 }
 253
 254 void UserManager::RehashCloneCounts()
 255 {
 256         clonemap.clear();
 257
 258         const user_hash& hash = ServerInstance->Users.GetUsers();
 259         for (user_hash::const_iterator i = hash.begin(); i != hash.end(); ++i)
 260         {
 261                 User* u = i->second;
 262                 AddClone(u);
 263         }
 264 }
 265
 266 const UserManager::CloneCounts& UserManager::GetCloneCounts(User* user) const
 267 {
 268         CloneMap::const_iterator it = clonemap.find(user->GetCIDRMask());
 269         if (it != clonemap.end())
 270                 return it->second;
 271         else
 272                 return zeroclonecounts;
 273 }
 274
 275 void UserManager::ServerNoticeAll(const char* text, ...)
 276 {
 277         std::string message;
 278         VAFORMAT(message, text, text);
 279         message = "NOTICE $" + ServerInstance->Config->ServerName + " :" + message;
 280
 281         for (LocalList::const_iterator i = local_users.begin(); i != local_users.end(); ++i)
 282         {
 283                 User* t = *i;
 284                 t->WriteServ(message);
 285         }
 286 }
 287
 288 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
 289  * (until this returns true, a user will block in the waiting state, waiting to connect up to the
 290  * registration timeout maximum seconds)
 291  */
 292 bool UserManager::AllModulesReportReady(LocalUser* user)
 293 {
 294         ModResult res;
 295         FIRST_MOD_RESULT(OnCheckReady, res, (user));
 296         return (res == MOD_RES_PASSTHRU);
 297 }
 298
 299 /**
 300  * This function is called once a second from the mainloop.
 301  * It is intended to do background checking on all the user structs, e.g.
 302  * stuff like ping checks, registration timeouts, etc.
 303  */
 304 void UserManager::DoBackgroundUserStuff()
 305 {
 306         /*
 307          * loop over all local users..
 308          */
 309         for (LocalList::iterator i = local_users.begin(); i != local_users.end(); )
 310         {
 311                 // It's possible that we quit the user below due to ping timeout etc. and QuitUser() removes it from the list
 312                 LocalUser* curr = *i;
 313                 ++i;
 314
 315                 if (curr->CommandFloodPenalty || curr->eh.getSendQSize())
 316                 {
 317                         unsigned int rate = curr->MyClass->GetCommandRate();
 318                         if (curr->CommandFloodPenalty > rate)
 319                                 curr->CommandFloodPenalty -= rate;
 320                         else
 321                                 curr->CommandFloodPenalty = 0;
 322                         curr->eh.OnDataReady();
 323                 }
 324
 325                 switch (curr->registered)
 326                 {
 327                         case REG_ALL:
 328                                 if (ServerInstance->Time() >= curr->nping)
 329                                 {
 330                                         // This user didn't answer the last ping, remove them
 331                                         if (!curr->lastping)
 332                                         {
 333                                                 time_t time = ServerInstance->Time() - (curr->nping - curr->MyClass->GetPingTime());
 334                                                 const std::string message = "Ping timeout: " + ConvToStr(time) + (time != 1 ? " seconds" : " second");
 335                                                 this->QuitUser(curr, message);
 336                                                 continue;
 337                                         }
 338
 339                                         curr->Write("PING :" + ServerInstance->Config->ServerName);
 340                                         curr->lastping = 0;
 341                                         curr->nping = ServerInstance->Time() + curr->MyClass->GetPingTime();
 342                                 }
 343                                 break;
 344                         case REG_NICKUSER:
 345                                 if (AllModulesReportReady(curr))
 346                                 {
 347                                         /* User has sent NICK/USER, modules are okay, DNS finished. */
 348                                         curr->FullConnect();
 349                                         continue;
 350                                 }
 351
 352                                 // If the user has been quit in OnCheckReady then we shouldn't
 353                                 // quit them again for having a registration timeout.
 354                                 if (curr->quitting)
 355                                         continue;
 356                                 break;
 357                 }
 358
 359                 if (curr->registered != REG_ALL && curr->MyClass && (ServerInstance->Time() > (curr->signon + curr->MyClass->GetRegTimeout())))
 360                 {
 361                         /*
 362                          * registration timeout -- didnt send USER/NICK/HOST
 363                          * in the time specified in their connection class.
 364                          */
 365                         this->QuitUser(curr, "Registration timeout");
 366                         continue;
 367                 }
 368         }
 369 }
 370
 371 already_sent_t UserManager::NextAlreadySentId()
 372 {
 373         if (++already_sent_id == 0)
 374         {
 375                 // Wrapped around, reset the already_sent ids of all users
 376                 already_sent_id = 1;
 377                 for (LocalList::iterator i = local_users.begin(); i != local_users.end(); ++i)
 378                 {
 379                         LocalUser* user = *i;
 380                         user->already_sent = 0;
 381                 }
 382         }
 383         return already_sent_id;
 384 }