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