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