src/users.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006-2009 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2008 John Brooks <john.brooks@dereferenced.net>
   8  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   9  *   Copyright (C) 2008 Oliver Lupton <oliverlupton@gmail.com>
  10  *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
  11  *
  12  * This file is part of InspIRCd.  InspIRCd is free software: you can
  13  * redistribute it and/or modify it under the terms of the GNU General Public
  14  * License as published by the Free Software Foundation, version 2.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25
  26 #include "inspircd.h"
  27 #include "xline.h"
  28
  29 bool User::IsNoticeMaskSet(unsigned char sm)
  30 {
  31         if (!isalpha(sm))
  32                 return false;
  33         return (snomasks[sm-65]);
  34 }
  35
  36 bool User::IsModeSet(unsigned char m) const
  37 {
  38         ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
  39         return (mh && modes[mh->GetId()]);
  40 }
  41
  42 std::string User::GetModeLetters(bool includeparams) const
  43 {
  44         std::string ret(1, '+');
  45         std::string params;
  46
  47         for (unsigned char i = 'A'; i < 'z'; i++)
  48         {
  49                 const ModeHandler* const mh = ServerInstance->Modes.FindMode(i, MODETYPE_USER);
  50                 if ((!mh) || (!IsModeSet(mh)))
  51                         continue;
  52
  53                 ret.push_back(mh->GetModeChar());
  54                 if ((includeparams) && (mh->NeedsParam(true)))
  55                 {
  56                         const std::string val = mh->GetUserParameter(this);
  57                         if (!val.empty())
  58                                 params.append(1, ' ').append(val);
  59                 }
  60         }
  61
  62         ret += params;
  63         return ret;
  64 }
  65
  66 User::User(const std::string& uid, Server* srv, UserType type)
  67         : age(ServerInstance->Time())
  68         , signon(0)
  69         , uuid(uid)
  70         , server(srv)
  71         , registered(REG_NONE)
  72         , quitting(false)
  73         , usertype(type)
  74 {
  75         client_sa.sa.sa_family = AF_UNSPEC;
  76
  77         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
  78
  79         // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
  80         if (type != USERTYPE_SERVER)
  81         {
  82                 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
  83                         throw CoreException("Duplicate UUID in User constructor: " + uuid);
  84         }
  85 }
  86
  87 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
  88         : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL)
  89         , eh(this)
  90         , bytes_in(0)
  91         , bytes_out(0)
  92         , cmds_in(0)
  93         , cmds_out(0)
  94         , quitting_sendq(false)
  95         , lastping(true)
  96         , exempt(false)
  97         , nping(0)
  98         , idle_lastmsg(0)
  99         , CommandFloodPenalty(0)
 100         , already_sent(0)
 101 {
 102         signon = ServerInstance->Time();
 103         // The user's default nick is their UUID
 104         nick = uuid;
 105         ident = "unknown";
 106         eh.SetFd(myfd);
 107         memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
 108         memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
 109         ChangeRealHost(GetIPString(), true);
 110 }
 111
 112 User::~User()
 113 {
 114 }
 115
 116 const std::string& User::MakeHost()
 117 {
 118         if (!this->cached_makehost.empty())
 119                 return this->cached_makehost;
 120
 121         // XXX: Is there really a need to cache this?
 122         this->cached_makehost = ident + "@" + GetRealHost();
 123         return this->cached_makehost;
 124 }
 125
 126 const std::string& User::MakeHostIP()
 127 {
 128         if (!this->cached_hostip.empty())
 129                 return this->cached_hostip;
 130
 131         // XXX: Is there really a need to cache this?
 132         this->cached_hostip = ident + "@" + this->GetIPString();
 133         return this->cached_hostip;
 134 }
 135
 136 const std::string& User::GetFullHost()
 137 {
 138         if (!this->cached_fullhost.empty())
 139                 return this->cached_fullhost;
 140
 141         // XXX: Is there really a need to cache this?
 142         this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
 143         return this->cached_fullhost;
 144 }
 145
 146 const std::string& User::GetFullRealHost()
 147 {
 148         if (!this->cached_fullrealhost.empty())
 149                 return this->cached_fullrealhost;
 150
 151         // XXX: Is there really a need to cache this?
 152         this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
 153         return this->cached_fullrealhost;
 154 }
 155
 156 bool User::HasModePermission(const ModeHandler* mh) const
 157 {
 158         return true;
 159 }
 160
 161 bool LocalUser::HasModePermission(const ModeHandler* mh) const
 162 {
 163         if (!this->IsOper())
 164                 return false;
 165
 166         const unsigned char mode = mh->GetModeChar();
 167         if (mode < 'A' || mode > ('A' + 64)) return false;
 168
 169         return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
 170
 171 }
 172 /*
 173  * users on remote servers can completely bypass all permissions based checks.
 174  * This prevents desyncs when one server has different type/class tags to another.
 175  * That having been said, this does open things up to the possibility of source changes
 176  * allowing remote kills, etc - but if they have access to the src, they most likely have
 177  * access to the conf - so it's an end to a means either way.
 178  */
 179 bool User::HasPermission(const std::string&)
 180 {
 181         return true;
 182 }
 183
 184 bool LocalUser::HasPermission(const std::string &command)
 185 {
 186         // are they even an oper at all?
 187         if (!this->IsOper())
 188         {
 189                 return false;
 190         }
 191
 192         return oper->AllowedOperCommands.Contains(command);
 193 }
 194
 195 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
 196 {
 197         return true;
 198 }
 199
 200 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
 201 {
 202         if (!this->IsOper())
 203         {
 204                 if (noisy)
 205                         this->WriteNotice("You are not an oper");
 206                 return false;
 207         }
 208
 209         if (oper->AllowedPrivs.Contains(privstr))
 210                 return true;
 211
 212         if (noisy)
 213                 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
 214
 215         return false;
 216 }
 217
 218 void UserIOHandler::OnDataReady()
 219 {
 220         if (user->quitting)
 221                 return;
 222
 223         if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
 224         {
 225                 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
 226                 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
 227                         user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
 228                 return;
 229         }
 230
 231         unsigned long sendqmax = ULONG_MAX;
 232         if (!user->HasPrivPermission("users/flood/increased-buffers"))
 233                 sendqmax = user->MyClass->GetSendqSoftMax();
 234
 235         unsigned long penaltymax = ULONG_MAX;
 236         if (!user->HasPrivPermission("users/flood/no-fakelag"))
 237                 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
 238
 239         // The maximum size of an IRC message minus the terminating CR+LF.
 240         const size_t maxmessage = ServerInstance->Config->Limits.MaxLine - 2;
 241         std::string line;
 242         line.reserve(maxmessage);
 243
 244         bool eol_found;
 245         std::string::size_type qpos;
 246
 247         while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
 248         {
 249                 qpos = 0;
 250                 eol_found = false;
 251
 252                 const size_t qlen = recvq.length();
 253                 while (qpos < qlen)
 254                 {
 255                         char c = recvq[qpos++];
 256                         switch (c)
 257                         {
 258                                 case '\0':
 259                                         c = ' ';
 260                                         break;
 261                                 case '\r':
 262                                         continue;
 263                                 case '\n':
 264                                         eol_found = true;
 265                                         break;
 266                         }
 267
 268                         if (eol_found)
 269                                 break;
 270
 271                         if (line.length() < maxmessage)
 272                                 line.push_back(c);
 273                 }
 274
 275                 // if we return here, we haven't found a newline and make no modifications to recvq
 276                 // so we can wait for more data
 277                 if (!eol_found)
 278                         return;
 279
 280                 // just found a newline. Terminate the string, and pull it out of recvq
 281                 recvq.erase(0, qpos);
 282
 283                 // TODO should this be moved to when it was inserted in recvq?
 284                 ServerInstance->stats.Recv += qpos;
 285                 user->bytes_in += qpos;
 286                 user->cmds_in++;
 287
 288                 ServerInstance->Parser.ProcessBuffer(line, user);
 289                 if (user->quitting)
 290                         return;
 291
 292                 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
 293                 line.clear();
 294         }
 295
 296         if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
 297                 ServerInstance->Users->QuitUser(user, "Excess Flood");
 298 }
 299
 300 void UserIOHandler::AddWriteBuf(const std::string &data)
 301 {
 302         if (user->quitting_sendq)
 303                 return;
 304         if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
 305                 !user->HasPrivPermission("users/flood/increased-buffers"))
 306         {
 307                 user->quitting_sendq = true;
 308                 ServerInstance->GlobalCulls.AddSQItem(user);
 309                 return;
 310         }
 311
 312         // We still want to append data to the sendq of a quitting user,
 313         // e.g. their ERROR message that says 'closing link'
 314
 315         WriteData(data);
 316 }
 317
 318 void UserIOHandler::OnSetEndPoint(const irc::sockets::sockaddrs& server, const irc::sockets::sockaddrs& client)
 319 {
 320         memcpy(&user->server_sa, &server, sizeof(irc::sockets::sockaddrs));
 321         user->SetClientIP(client);
 322 }
 323
 324 void UserIOHandler::OnError(BufferedSocketError)
 325 {
 326         ServerInstance->Users->QuitUser(user, getError());
 327 }
 328
 329 CullResult User::cull()
 330 {
 331         if (!quitting)
 332                 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
 333
 334         if (client_sa.family() != AF_UNSPEC)
 335                 ServerInstance->Users->RemoveCloneCounts(this);
 336
 337         return Extensible::cull();
 338 }
 339
 340 CullResult LocalUser::cull()
 341 {
 342         eh.cull();
 343         return User::cull();
 344 }
 345
 346 CullResult FakeUser::cull()
 347 {
 348         // Fake users don't quit, they just get culled.
 349         quitting = true;
 350         // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
 351         return User::cull();
 352 }
 353
 354 void User::Oper(OperInfo* info)
 355 {
 356         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
 357         if (this->IsModeSet(opermh))
 358                 this->UnOper();
 359
 360         this->SetMode(opermh, true);
 361         this->oper = info;
 362         this->WriteCommand("MODE", "+o");
 363         FOREACH_MOD(OnOper, (this, info->name));
 364
 365         std::string opername;
 366         if (info->oper_block)
 367                 opername = info->oper_block->getString("name");
 368
 369         if (IS_LOCAL(this))
 370         {
 371                 LocalUser* l = IS_LOCAL(this);
 372                 std::string vhost = oper->getConfig("vhost");
 373                 if (!vhost.empty())
 374                         l->ChangeDisplayedHost(vhost);
 375                 std::string opClass = oper->getConfig("class");
 376                 if (!opClass.empty())
 377                         l->SetClass(opClass);
 378         }
 379
 380         ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
 381                 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
 382         this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
 383
 384         ServerInstance->Users->all_opers.push_back(this);
 385
 386         // Expand permissions from config for faster lookup
 387         if (IS_LOCAL(this))
 388                 oper->init();
 389
 390         FOREACH_MOD(OnPostOper, (this, oper->name, opername));
 391 }
 392
 393 void OperInfo::init()
 394 {
 395         AllowedOperCommands.Clear();
 396         AllowedPrivs.Clear();
 397         AllowedUserModes.reset();
 398         AllowedChanModes.reset();
 399         AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
 400
 401         for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
 402         {
 403                 ConfigTag* tag = *iter;
 404
 405                 AllowedOperCommands.AddList(tag->getString("commands"));
 406                 AllowedPrivs.AddList(tag->getString("privs"));
 407
 408                 std::string modes = tag->getString("usermodes");
 409                 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
 410                 {
 411                         if (*c == '*')
 412                         {
 413                                 this->AllowedUserModes.set();
 414                         }
 415                         else if (*c >= 'A' && *c <= 'z')
 416                         {
 417                                 this->AllowedUserModes[*c - 'A'] = true;
 418                         }
 419                 }
 420
 421                 modes = tag->getString("chanmodes");
 422                 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
 423                 {
 424                         if (*c == '*')
 425                         {
 426                                 this->AllowedChanModes.set();
 427                         }
 428                         else if (*c >= 'A' && *c <= 'z')
 429                         {
 430                                 this->AllowedChanModes[*c - 'A'] = true;
 431                         }
 432                 }
 433         }
 434 }
 435
 436 void User::UnOper()
 437 {
 438         if (!this->IsOper())
 439                 return;
 440
 441         /*
 442          * unset their oper type (what IS_OPER checks).
 443          * note, order is important - this must come before modes as -o attempts
 444          * to call UnOper. -- w00t
 445          */
 446         oper = NULL;
 447
 448
 449         /* Remove all oper only modes from the user when the deoper - Bug #466*/
 450         Modes::ChangeList changelist;
 451         const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
 452         for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
 453         {
 454                 ModeHandler* mh = i->second;
 455                 if (mh->NeedsOper())
 456                         changelist.push_remove(mh);
 457         }
 458
 459         ServerInstance->Modes->Process(this, NULL, this, changelist);
 460
 461         // Remove the user from the oper list
 462         stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
 463
 464         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
 465         this->SetMode(opermh, false);
 466         FOREACH_MOD(OnPostDeoper, (this));
 467 }
 468
 469 /*
 470  * Check class restrictions
 471  */
 472 void LocalUser::CheckClass(bool clone_count)
 473 {
 474         ConnectClass* a = this->MyClass;
 475
 476         if (!a)
 477         {
 478                 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
 479                 return;
 480         }
 481         else if (a->type == CC_DENY)
 482         {
 483                 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
 484                 return;
 485         }
 486         else if (clone_count)
 487         {
 488                 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
 489                 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
 490                 {
 491                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
 492                         if (a->maxconnwarn)
 493                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
 494                         return;
 495                 }
 496                 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
 497                 {
 498                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
 499                         if (a->maxconnwarn)
 500                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
 501                         return;
 502                 }
 503         }
 504
 505         this->nping = ServerInstance->Time() + a->GetPingTime();
 506 }
 507
 508 bool LocalUser::CheckLines(bool doZline)
 509 {
 510         const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
 511
 512         if (!this->exempt)
 513         {
 514                 for (int n = 0; check[n]; ++n)
 515                 {
 516                         XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
 517
 518                         if (r)
 519                         {
 520                                 r->Apply(this);
 521                                 return true;
 522                         }
 523                 }
 524         }
 525
 526         return false;
 527 }
 528
 529 void LocalUser::FullConnect()
 530 {
 531         ServerInstance->stats.Connects++;
 532         this->idle_lastmsg = ServerInstance->Time();
 533
 534         /*
 535          * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
 536          * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
 537          * may put the user into a totally seperate class with different restrictions! so we *must* check again.
 538          * Don't remove this! -- w00t
 539          */
 540         MyClass = NULL;
 541         SetClass();
 542         CheckClass();
 543         CheckLines();
 544
 545         if (quitting)
 546                 return;
 547
 548         this->WriteNumeric(RPL_WELCOME, InspIRCd::Format("Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str()));
 549         this->WriteNumeric(RPL_YOURHOSTIS, InspIRCd::Format("Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH));
 550         this->WriteNumeric(RPL_SERVERCREATED, InspIRCd::TimeString(ServerInstance->startup_time, "This server was created %H:%M:%S %b %d %Y"));
 551
 552         const TR1NS::array<std::string, 3>& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
 553         this->WriteNumeric(RPL_SERVERVERSION, ServerInstance->Config->ServerName, INSPIRCD_BRANCH, modelist[0], modelist[1], modelist[2]);
 554
 555         ServerInstance->ISupport.SendTo(this);
 556
 557         /* Now registered */
 558         if (ServerInstance->Users->unregistered_count)
 559                 ServerInstance->Users->unregistered_count--;
 560
 561         /* Trigger MOTD and LUSERS output, give modules a chance too */
 562         ModResult MOD_RESULT;
 563         std::string command("LUSERS");
 564         std::vector<std::string> parameters;
 565         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
 566         if (!MOD_RESULT)
 567                 ServerInstance->Parser.CallHandler(command, parameters, this);
 568
 569         MOD_RESULT = MOD_RES_PASSTHRU;
 570         command = "MOTD";
 571         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
 572         if (!MOD_RESULT)
 573                 ServerInstance->Parser.CallHandler(command, parameters, this);
 574
 575         if (ServerInstance->Config->RawLog)
 576                 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
 577
 578         /*
 579          * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
 580          * for a user that doesn't exist yet.
 581          */
 582         FOREACH_MOD(OnUserConnect, (this));
 583
 584         this->registered = REG_ALL;
 585
 586         FOREACH_MOD(OnPostConnect, (this));
 587
 588         ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
 589                 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
 590         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
 591         ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
 592         // reset the flood penalty (which could have been raised due to things like auto +x)
 593         CommandFloodPenalty = 0;
 594 }
 595
 596 void User::InvalidateCache()
 597 {
 598         /* Invalidate cache */
 599         cachedip.clear();
 600         cached_fullhost.clear();
 601         cached_hostip.clear();
 602         cached_makehost.clear();
 603         cached_fullrealhost.clear();
 604 }
 605
 606 bool User::ChangeNick(const std::string& newnick, time_t newts)
 607 {
 608         if (quitting)
 609         {
 610                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
 611                 return false;
 612         }
 613
 614         User* const InUse = ServerInstance->FindNickOnly(newnick);
 615         if (InUse == this)
 616         {
 617                 // case change, don't need to check campers
 618                 // and, if it's identical including case, we can leave right now
 619                 // We also don't update the nick TS if it's a case change, either
 620                 if (newnick == nick)
 621                         return true;
 622         }
 623         else
 624         {
 625                 /*
 626                  * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
 627                  * then we have a potential collide. Check whether someone else is camping on the nick
 628                  * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
 629                  * camper to their UID, and allow the incoming nick change.
 630                  *
 631                  * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
 632                  * because the nick is already (rightfully) in use. -- w00t
 633                  */
 634                 if (InUse)
 635                 {
 636                         if (InUse->registered != REG_ALL)
 637                         {
 638                                 /* force the camper to their UUID, and ask them to re-send a NICK. */
 639                                 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
 640                                 localuser->OverruleNick();
 641                         }
 642                         else
 643                         {
 644                                 /* No camping, tell the incoming user  to stop trying to change nick ;p */
 645                                 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
 646                                 return false;
 647                         }
 648                 }
 649
 650                 age = newts ? newts : ServerInstance->Time();
 651         }
 652
 653         if (this->registered == REG_ALL)
 654                 this->WriteCommon("NICK %s", newnick.c_str());
 655         const std::string oldnick = nick;
 656         nick = newnick;
 657
 658         InvalidateCache();
 659         ServerInstance->Users->clientlist.erase(oldnick);
 660         ServerInstance->Users->clientlist[newnick] = this;
 661
 662         if (registered == REG_ALL)
 663                 FOREACH_MOD(OnUserPostNick, (this,oldnick));
 664
 665         return true;
 666 }
 667
 668 void LocalUser::OverruleNick()
 669 {
 670         this->WriteFrom(this, "NICK %s", this->uuid.c_str());
 671         this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
 672
 673         // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
 674         this->registered &= ~REG_NICK;
 675         this->ChangeNick(this->uuid);
 676 }
 677
 678 int LocalUser::GetServerPort()
 679 {
 680         return this->server_sa.port();
 681 }
 682
 683 const std::string& User::GetIPString()
 684 {
 685         if (cachedip.empty())
 686         {
 687                 cachedip = client_sa.addr();
 688                 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
 689                 if (cachedip[0] == ':')
 690                         cachedip.insert(cachedip.begin(),1,'0');
 691         }
 692
 693         return cachedip;
 694 }
 695
 696 const std::string& User::GetHost(bool uncloak) const
 697 {
 698         return uncloak ? GetRealHost() : GetDisplayedHost();
 699 }
 700
 701 const std::string& User::GetDisplayedHost() const
 702 {
 703         return displayhost.empty() ? realhost : displayhost;
 704 }
 705
 706 const std::string& User::GetRealHost() const
 707 {
 708         return realhost;
 709 }
 710
 711 irc::sockets::cidr_mask User::GetCIDRMask()
 712 {
 713         unsigned char range = 0;
 714         switch (client_sa.family())
 715         {
 716                 case AF_INET6:
 717                         range = ServerInstance->Config->c_ipv6_range;
 718                         break;
 719                 case AF_INET:
 720                         range = ServerInstance->Config->c_ipv4_range;
 721                         break;
 722         }
 723         return irc::sockets::cidr_mask(client_sa, range);
 724 }
 725
 726 bool User::SetClientIP(const std::string& address, bool recheck_eline)
 727 {
 728         this->InvalidateCache();
 729         return irc::sockets::aptosa(address, 0, client_sa);
 730 }
 731
 732 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
 733 {
 734         this->InvalidateCache();
 735         memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
 736 }
 737
 738 bool LocalUser::SetClientIP(const std::string& address, bool recheck_eline)
 739 {
 740         irc::sockets::sockaddrs sa;
 741         if (!irc::sockets::aptosa(address, 0, sa))
 742                 // Invalid
 743                 return false;
 744
 745         LocalUser::SetClientIP(sa, recheck_eline);
 746         return true;
 747 }
 748
 749 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
 750 {
 751         if (sa != client_sa)
 752         {
 753                 User::SetClientIP(sa);
 754                 if (recheck_eline)
 755                         this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
 756
 757                 FOREACH_MOD(OnSetUserIP, (this));
 758         }
 759 }
 760
 761 static std::string wide_newline("\r\n");
 762
 763 void User::Write(const std::string& text)
 764 {
 765 }
 766
 767 void User::Write(const char *text, ...)
 768 {
 769 }
 770
 771 void LocalUser::Write(const std::string& text)
 772 {
 773         if (!SocketEngine::BoundsCheckFd(&eh))
 774                 return;
 775
 776         // The maximum size of an IRC message minus the terminating CR+LF.
 777         const size_t maxmessage = ServerInstance->Config->Limits.MaxLine - 2;
 778         if (text.length() > maxmessage)
 779         {
 780                 // This should happen rarely or never. Crop the string at MaxLine and try again.
 781                 std::string try_again(text, 0, maxmessage);
 782                 Write(try_again);
 783                 return;
 784         }
 785
 786         ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
 787
 788         eh.AddWriteBuf(text);
 789         eh.AddWriteBuf(wide_newline);
 790
 791         const size_t bytessent = text.length() + 2;
 792         ServerInstance->stats.Sent += bytessent;
 793         this->bytes_out += bytessent;
 794         this->cmds_out++;
 795 }
 796
 797 /** Write()
 798  */
 799 void LocalUser::Write(const char *text, ...)
 800 {
 801         std::string textbuffer;
 802         VAFORMAT(textbuffer, text, text);
 803         this->Write(textbuffer);
 804 }
 805
 806 void User::WriteServ(const std::string& text)
 807 {
 808         this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
 809 }
 810
 811 /** WriteServ()
 812  *  Same as Write(), except `text' is prefixed with `:server.name '.
 813  */
 814 void User::WriteServ(const char* text, ...)
 815 {
 816         std::string textbuffer;
 817         VAFORMAT(textbuffer, text, text);
 818         this->WriteServ(textbuffer);
 819 }
 820
 821 void User::WriteCommand(const char* command, const std::string& text)
 822 {
 823         this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
 824 }
 825
 826 namespace
 827 {
 828         std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
 829         {
 830                 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
 831                 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
 832                 if (!params.empty())
 833                 {
 834                         for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
 835                                 raw.append(1, ' ').append(*i);
 836                         raw.append(" :").append(params.back());
 837                 }
 838                 return raw;
 839         }
 840 }
 841
 842 void User::WriteNumeric(const Numeric::Numeric& numeric)
 843 {
 844         ModResult MOD_RESULT;
 845
 846         FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
 847
 848         if (MOD_RESULT == MOD_RES_DENY)
 849                 return;
 850
 851         const std::string& servername = (numeric.GetServer() ? numeric.GetServer()->GetName() : ServerInstance->Config->ServerName);
 852         this->Write(BuildNumeric(servername, this, numeric.GetNumeric(), numeric.GetParams()));
 853 }
 854
 855 void User::WriteFrom(User *user, const std::string &text)
 856 {
 857         const std::string message = ":" + user->GetFullHost() + " " + text;
 858         this->Write(message);
 859 }
 860
 861
 862 /* write text from an originating user to originating user */
 863
 864 void User::WriteFrom(User *user, const char* text, ...)
 865 {
 866         std::string textbuffer;
 867         VAFORMAT(textbuffer, text, text);
 868         this->WriteFrom(user, textbuffer);
 869 }
 870
 871 void User::WriteRemoteNotice(const std::string& text)
 872 {
 873         ServerInstance->PI->SendUserNotice(this, text);
 874 }
 875
 876 void LocalUser::WriteRemoteNotice(const std::string& text)
 877 {
 878         WriteNotice(text);
 879 }
 880
 881 namespace
 882 {
 883         class WriteCommonRawHandler : public User::ForEachNeighborHandler
 884         {
 885                 const std::string& msg;
 886
 887                 void Execute(LocalUser* user) CXX11_OVERRIDE
 888                 {
 889                         user->Write(msg);
 890                 }
 891
 892          public:
 893                 WriteCommonRawHandler(const std::string& message)
 894                         : msg(message)
 895                 {
 896                 }
 897         };
 898 }
 899
 900 void User::WriteCommon(const char* text, ...)
 901 {
 902         std::string textbuffer;
 903         VAFORMAT(textbuffer, text, text);
 904         textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
 905         this->WriteCommonRaw(textbuffer, true);
 906 }
 907
 908 void User::WriteCommonRaw(const std::string &line, bool include_self)
 909 {
 910         WriteCommonRawHandler handler(line);
 911         ForEachNeighbor(handler, include_self);
 912 }
 913
 914 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
 915 {
 916         // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
 917         // and visit all users on those channels. Because two users may share more than one common channel,
 918         // we must skip users that we have already visited.
 919         // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
 920         // The global counter is incremented every time we do something for each neighbor of a user. Then,
 921         // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
 922         // skip the member. Otherwise, we set it to the current counter and visit the member.
 923
 924         // Ask modules to build a list of exceptions.
 925         // Mods may also exclude entire channels by erasing them from include_chans.
 926         IncludeChanList include_chans(chans.begin(), chans.end());
 927         std::map<User*, bool> exceptions;
 928         exceptions[this] = include_self;
 929         FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
 930
 931         // Get next id, guaranteed to differ from the already_sent field of all users
 932         const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
 933
 934         // Handle exceptions first
 935         for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
 936         {
 937                 LocalUser* curr = IS_LOCAL(i->first);
 938                 if (curr)
 939                 {
 940                         // Mark as visited to ensure we won't visit again if there is a common channel
 941                         curr->already_sent = newid;
 942                         // Always treat quitting users as excluded
 943                         if ((i->second) && (!curr->quitting))
 944                                 handler.Execute(curr);
 945                 }
 946         }
 947
 948         // Now consider the real neighbors
 949         for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
 950         {
 951                 Channel* chan = (*i)->chan;
 952                 const Channel::MemberMap& userlist = chan->GetUsers();
 953                 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
 954                 {
 955                         LocalUser* curr = IS_LOCAL(j->first);
 956                         // User not yet visited?
 957                         if ((curr) && (curr->already_sent != newid))
 958                         {
 959                                 // Mark as visited and execute function
 960                                 curr->already_sent = newid;
 961                                 handler.Execute(curr);
 962                         }
 963                 }
 964         }
 965 }
 966
 967 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
 968 {
 969         WriteNumeric(numeric);
 970 }
 971
 972 /* return 0 or 1 depending if users u and u2 share one or more common channels
 973  * (used by QUIT, NICK etc which arent channel specific notices)
 974  *
 975  * The old algorithm in 1.0 for this was relatively inefficient, iterating over
 976  * the first users channels then the second users channels within the outer loop,
 977  * therefore it was a maximum of x*y iterations (upon returning 0 and checking
 978  * all possible iterations). However this new function instead checks against the
 979  * channel's userlist in the inner loop which is a std::map<User*,User*>
 980  * and saves us time as we already know what pointer value we are after.
 981  * Don't quote me on the maths as i am not a mathematician or computer scientist,
 982  * but i believe this algorithm is now x+(log y) maximum iterations instead.
 983  */
 984 bool User::SharesChannelWith(User *other)
 985 {
 986         /* Outer loop */
 987         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
 988         {
 989                 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
 990                  * by replacing it with a map::find which *should* be more efficient
 991                  */
 992                 if ((*i)->chan->HasUser(other))
 993                         return true;
 994         }
 995         return false;
 996 }
 997
 998 bool User::ChangeName(const std::string& gecos)
 999 {
1000         if (!this->fullname.compare(gecos))
1001                 return true;
1002
1003         if (IS_LOCAL(this))
1004         {
1005                 ModResult MOD_RESULT;
1006                 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
1007                 if (MOD_RESULT == MOD_RES_DENY)
1008                         return false;
1009                 FOREACH_MOD(OnChangeName, (this,gecos));
1010         }
1011         this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1012
1013         return true;
1014 }
1015
1016 bool User::ChangeDisplayedHost(const std::string& shost)
1017 {
1018         if (GetDisplayedHost() == shost)
1019                 return true;
1020
1021         if (IS_LOCAL(this))
1022         {
1023                 ModResult MOD_RESULT;
1024                 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1025                 if (MOD_RESULT == MOD_RES_DENY)
1026                         return false;
1027         }
1028
1029         FOREACH_MOD(OnChangeHost, (this,shost));
1030
1031         if (realhost == shost)
1032                 this->displayhost.clear();
1033         else
1034                 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1035
1036         this->InvalidateCache();
1037
1038         if (IS_LOCAL(this))
1039                 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1040
1041         return true;
1042 }
1043
1044 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1045 {
1046         // If the real host is the new host and we are not resetting the
1047         // display host then we have nothing to do.
1048         const bool changehost = (realhost != host);
1049         if (!changehost && !resetdisplay)
1050                 return;
1051
1052         // If the displayhost is not set and we are not resetting it then
1053         // we need to copy it to the displayhost field.
1054         if (displayhost.empty() && !resetdisplay)
1055                 displayhost = realhost;
1056
1057         // If the displayhost is the new host or we are resetting it then
1058         // we clear its contents to save memory.
1059         else if (displayhost == host || resetdisplay)
1060                 displayhost.clear();
1061
1062         // If we are just resetting the display host then we don't need to
1063         // do anything else.
1064         if (!changehost)
1065                 return;
1066
1067         realhost = host;
1068         this->InvalidateCache();
1069 }
1070
1071 bool User::ChangeIdent(const std::string& newident)
1072 {
1073         if (this->ident == newident)
1074                 return true;
1075
1076         FOREACH_MOD(OnChangeIdent, (this,newident));
1077
1078         this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1079         this->InvalidateCache();
1080
1081         return true;
1082 }
1083
1084 /*
1085  * Sets a user's connection class.
1086  * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1087  * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1088  * then their ip will be taken as 'priority' anyway, so for example,
1089  * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1090  */
1091 void LocalUser::SetClass(const std::string &explicit_name)
1092 {
1093         ConnectClass *found = NULL;
1094
1095         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1096
1097         if (!explicit_name.empty())
1098         {
1099                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1100                 {
1101                         ConnectClass* c = *i;
1102
1103                         if (explicit_name == c->name)
1104                         {
1105                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1106                                 found = c;
1107                         }
1108                 }
1109         }
1110         else
1111         {
1112                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1113                 {
1114                         ConnectClass* c = *i;
1115                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1116
1117                         ModResult MOD_RESULT;
1118                         FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1119                         if (MOD_RESULT == MOD_RES_DENY)
1120                                 continue;
1121                         if (MOD_RESULT == MOD_RES_ALLOW)
1122                         {
1123                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1124                                 found = c;
1125                                 break;
1126                         }
1127
1128                         if (c->type == CC_NAMED)
1129                                 continue;
1130
1131                         bool regdone = (registered != REG_NONE);
1132                         if (c->config->getBool("registered", regdone) != regdone)
1133                                 continue;
1134
1135                         /* check if host matches.. */
1136                         if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1137                             !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1138                         {
1139                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1140                                 continue;
1141                         }
1142
1143                         /*
1144                          * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1145                          * because we should attempt to find another class if this one doesn't match us. -- w00t
1146                          */
1147                         if (c->limit && (c->GetReferenceCount() >= c->limit))
1148                         {
1149                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1150                                 continue;
1151                         }
1152
1153                         /* if it requires a port ... */
1154                         if (!c->ports.empty())
1155                         {
1156                                 /* and our port doesn't match, fail. */
1157                                 if (!c->ports.count(this->GetServerPort()))
1158                                 {
1159                                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1160                                         continue;
1161                                 }
1162                         }
1163
1164                         if (regdone && !c->config->getString("password").empty())
1165                         {
1166                                 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1167                                 {
1168                                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1169                                         continue;
1170                                 }
1171                         }
1172
1173                         /* we stop at the first class that meets ALL critera. */
1174                         found = c;
1175                         break;
1176                 }
1177         }
1178
1179         /*
1180          * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1181          */
1182         if (found)
1183         {
1184                 MyClass = found;
1185         }
1186 }
1187
1188 void User::PurgeEmptyChannels()
1189 {
1190         // firstly decrement the count on each channel
1191         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1192         {
1193                 Channel* c = (*i)->chan;
1194                 ++i;
1195                 c->DelUser(this);
1196         }
1197
1198         this->UnOper();
1199 }
1200
1201 const std::string& FakeUser::GetFullHost()
1202 {
1203         if (!ServerInstance->Config->HideServer.empty())
1204                 return ServerInstance->Config->HideServer;
1205         return server->GetName();
1206 }
1207
1208 const std::string& FakeUser::GetFullRealHost()
1209 {
1210         if (!ServerInstance->Config->HideServer.empty())
1211                 return ServerInstance->Config->HideServer;
1212         return server->GetName();
1213 }
1214
1215 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1216         : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1217         pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1218         penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1219         limit(0), resolvehostnames(true)
1220 {
1221 }
1222
1223 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1224 {
1225         Update(&parent);
1226         name = "unnamed";
1227         type = t;
1228         host = mask;
1229
1230         // Connect classes can inherit from each other but this is problematic for modules which can't use
1231         // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1232         // well as the parent class.
1233         ConfigItems* items = NULL;
1234         config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1235
1236         const ConfigItems& parentkeys = parent.config->getItems();
1237         for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1238         {
1239                 // The class name and parent name are not inherited
1240                 if (stdalgo::string::equalsci(piter->first, "name") || stdalgo::string::equalsci(piter->first, "parent"))
1241                         continue;
1242
1243                 // Store the item in the config tag. If this item also
1244                 // exists in the child it will be overwritten.
1245                 (*items)[piter->first] = piter->second;
1246         }
1247
1248         const ConfigItems& childkeys = tag->getItems();
1249         for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1250         {
1251                 // This will overwrite the parent value if present.
1252                 (*items)[citer->first] = citer->second;
1253         }
1254 }
1255
1256 void ConnectClass::Update(const ConnectClass* src)
1257 {
1258         config = src->config;
1259         type = src->type;
1260         fakelag = src->fakelag;
1261         name = src->name;
1262         registration_timeout = src->registration_timeout;
1263         host = src->host;
1264         pingtime = src->pingtime;
1265         softsendqmax = src->softsendqmax;
1266         hardsendqmax = src->hardsendqmax;
1267         recvqmax = src->recvqmax;
1268         penaltythreshold = src->penaltythreshold;
1269         commandrate = src->commandrate;
1270         maxlocal = src->maxlocal;
1271         maxglobal = src->maxglobal;
1272         maxconnwarn = src->maxconnwarn;
1273         maxchans = src->maxchans;
1274         limit = src->limit;
1275         resolvehostnames = src->resolvehostnames;
1276         ports = src->ports;
1277 }