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::OnError(BufferedSocketError)
 319 {
 320         ServerInstance->Users->QuitUser(user, getError());
 321 }
 322
 323 CullResult User::cull()
 324 {
 325         if (!quitting)
 326                 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
 327
 328         if (client_sa.sa.sa_family != AF_UNSPEC)
 329                 ServerInstance->Users->RemoveCloneCounts(this);
 330
 331         return Extensible::cull();
 332 }
 333
 334 CullResult LocalUser::cull()
 335 {
 336         eh.cull();
 337         return User::cull();
 338 }
 339
 340 CullResult FakeUser::cull()
 341 {
 342         // Fake users don't quit, they just get culled.
 343         quitting = true;
 344         // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
 345         return User::cull();
 346 }
 347
 348 void User::Oper(OperInfo* info)
 349 {
 350         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
 351         if (this->IsModeSet(opermh))
 352                 this->UnOper();
 353
 354         this->SetMode(opermh, true);
 355         this->oper = info;
 356         this->WriteCommand("MODE", "+o");
 357         FOREACH_MOD(OnOper, (this, info->name));
 358
 359         std::string opername;
 360         if (info->oper_block)
 361                 opername = info->oper_block->getString("name");
 362
 363         if (IS_LOCAL(this))
 364         {
 365                 LocalUser* l = IS_LOCAL(this);
 366                 std::string vhost = oper->getConfig("vhost");
 367                 if (!vhost.empty())
 368                         l->ChangeDisplayedHost(vhost);
 369                 std::string opClass = oper->getConfig("class");
 370                 if (!opClass.empty())
 371                         l->SetClass(opClass);
 372         }
 373
 374         ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
 375                 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
 376         this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
 377
 378         ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
 379         ServerInstance->Users->all_opers.push_back(this);
 380
 381         // Expand permissions from config for faster lookup
 382         if (IS_LOCAL(this))
 383                 oper->init();
 384
 385         FOREACH_MOD(OnPostOper, (this, oper->name, opername));
 386 }
 387
 388 void OperInfo::init()
 389 {
 390         AllowedOperCommands.Clear();
 391         AllowedPrivs.Clear();
 392         AllowedUserModes.reset();
 393         AllowedChanModes.reset();
 394         AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
 395
 396         for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
 397         {
 398                 ConfigTag* tag = *iter;
 399
 400                 AllowedOperCommands.AddList(tag->getString("commands"));
 401                 AllowedPrivs.AddList(tag->getString("privs"));
 402
 403                 std::string modes = tag->getString("usermodes");
 404                 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
 405                 {
 406                         if (*c == '*')
 407                         {
 408                                 this->AllowedUserModes.set();
 409                         }
 410                         else if (*c >= 'A' && *c <= 'z')
 411                         {
 412                                 this->AllowedUserModes[*c - 'A'] = true;
 413                         }
 414                 }
 415
 416                 modes = tag->getString("chanmodes");
 417                 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
 418                 {
 419                         if (*c == '*')
 420                         {
 421                                 this->AllowedChanModes.set();
 422                         }
 423                         else if (*c >= 'A' && *c <= 'z')
 424                         {
 425                                 this->AllowedChanModes[*c - 'A'] = true;
 426                         }
 427                 }
 428         }
 429 }
 430
 431 void User::UnOper()
 432 {
 433         if (!this->IsOper())
 434                 return;
 435
 436         /*
 437          * unset their oper type (what IS_OPER checks).
 438          * note, order is important - this must come before modes as -o attempts
 439          * to call UnOper. -- w00t
 440          */
 441         oper = NULL;
 442
 443
 444         /* Remove all oper only modes from the user when the deoper - Bug #466*/
 445         Modes::ChangeList changelist;
 446         const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
 447         for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
 448         {
 449                 ModeHandler* mh = i->second;
 450                 if (mh->NeedsOper())
 451                         changelist.push_remove(mh);
 452         }
 453
 454         ServerInstance->Modes->Process(this, NULL, this, changelist);
 455
 456         // Remove the user from the oper list
 457         stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
 458
 459         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
 460         this->SetMode(opermh, false);
 461 }
 462
 463 /*
 464  * Check class restrictions
 465  */
 466 void LocalUser::CheckClass(bool clone_count)
 467 {
 468         ConnectClass* a = this->MyClass;
 469
 470         if (!a)
 471         {
 472                 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
 473                 return;
 474         }
 475         else if (a->type == CC_DENY)
 476         {
 477                 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
 478                 return;
 479         }
 480         else if (clone_count)
 481         {
 482                 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
 483                 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
 484                 {
 485                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
 486                         if (a->maxconnwarn)
 487                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
 488                         return;
 489                 }
 490                 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
 491                 {
 492                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
 493                         if (a->maxconnwarn)
 494                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
 495                         return;
 496                 }
 497         }
 498
 499         this->nping = ServerInstance->Time() + a->GetPingTime();
 500 }
 501
 502 bool LocalUser::CheckLines(bool doZline)
 503 {
 504         const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
 505
 506         if (!this->exempt)
 507         {
 508                 for (int n = 0; check[n]; ++n)
 509                 {
 510                         XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
 511
 512                         if (r)
 513                         {
 514                                 r->Apply(this);
 515                                 return true;
 516                         }
 517                 }
 518         }
 519
 520         return false;
 521 }
 522
 523 void LocalUser::FullConnect()
 524 {
 525         ServerInstance->stats.Connects++;
 526         this->idle_lastmsg = ServerInstance->Time();
 527
 528         /*
 529          * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
 530          * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
 531          * may put the user into a totally seperate class with different restrictions! so we *must* check again.
 532          * Don't remove this! -- w00t
 533          */
 534         MyClass = NULL;
 535         SetClass();
 536         CheckClass();
 537         CheckLines();
 538
 539         if (quitting)
 540                 return;
 541
 542         this->WriteNumeric(RPL_WELCOME, InspIRCd::Format("Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str()));
 543         this->WriteNumeric(RPL_YOURHOSTIS, InspIRCd::Format("Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH));
 544         this->WriteNumeric(RPL_SERVERCREATED, InspIRCd::TimeString(ServerInstance->startup_time, "This server was created %H:%M:%S %b %d %Y"));
 545
 546         const TR1NS::array<std::string, 3>& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
 547         this->WriteNumeric(RPL_SERVERVERSION, ServerInstance->Config->ServerName, INSPIRCD_BRANCH, modelist[0], modelist[1], modelist[2]);
 548
 549         ServerInstance->ISupport.SendTo(this);
 550
 551         /* Now registered */
 552         if (ServerInstance->Users->unregistered_count)
 553                 ServerInstance->Users->unregistered_count--;
 554
 555         /* Trigger MOTD and LUSERS output, give modules a chance too */
 556         ModResult MOD_RESULT;
 557         std::string command("LUSERS");
 558         std::vector<std::string> parameters;
 559         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
 560         if (!MOD_RESULT)
 561                 ServerInstance->Parser.CallHandler(command, parameters, this);
 562
 563         MOD_RESULT = MOD_RES_PASSTHRU;
 564         command = "MOTD";
 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         if (ServerInstance->Config->RawLog)
 570                 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
 571
 572         /*
 573          * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
 574          * for a user that doesn't exist yet.
 575          */
 576         FOREACH_MOD(OnUserConnect, (this));
 577
 578         this->registered = REG_ALL;
 579
 580         FOREACH_MOD(OnPostConnect, (this));
 581
 582         ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
 583                 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
 584         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
 585         ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
 586         // reset the flood penalty (which could have been raised due to things like auto +x)
 587         CommandFloodPenalty = 0;
 588 }
 589
 590 void User::InvalidateCache()
 591 {
 592         /* Invalidate cache */
 593         cachedip.clear();
 594         cached_fullhost.clear();
 595         cached_hostip.clear();
 596         cached_makehost.clear();
 597         cached_fullrealhost.clear();
 598 }
 599
 600 bool User::ChangeNick(const std::string& newnick, time_t newts)
 601 {
 602         if (quitting)
 603         {
 604                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
 605                 return false;
 606         }
 607
 608         User* const InUse = ServerInstance->FindNickOnly(newnick);
 609         if (InUse == this)
 610         {
 611                 // case change, don't need to check campers
 612                 // and, if it's identical including case, we can leave right now
 613                 // We also don't update the nick TS if it's a case change, either
 614                 if (newnick == nick)
 615                         return true;
 616         }
 617         else
 618         {
 619                 /*
 620                  * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
 621                  * then we have a potential collide. Check whether someone else is camping on the nick
 622                  * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
 623                  * camper to their UID, and allow the incoming nick change.
 624                  *
 625                  * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
 626                  * because the nick is already (rightfully) in use. -- w00t
 627                  */
 628                 if (InUse)
 629                 {
 630                         if (InUse->registered != REG_ALL)
 631                         {
 632                                 /* force the camper to their UUID, and ask them to re-send a NICK. */
 633                                 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
 634                                 localuser->OverruleNick();
 635                         }
 636                         else
 637                         {
 638                                 /* No camping, tell the incoming user  to stop trying to change nick ;p */
 639                                 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
 640                                 return false;
 641                         }
 642                 }
 643
 644                 age = newts ? newts : ServerInstance->Time();
 645         }
 646
 647         if (this->registered == REG_ALL)
 648                 this->WriteCommon("NICK %s",newnick.c_str());
 649         std::string oldnick = nick;
 650         nick = newnick;
 651
 652         InvalidateCache();
 653         ServerInstance->Users->clientlist.erase(oldnick);
 654         ServerInstance->Users->clientlist[newnick] = this;
 655
 656         if (registered == REG_ALL)
 657                 FOREACH_MOD(OnUserPostNick, (this,oldnick));
 658
 659         return true;
 660 }
 661
 662 void LocalUser::OverruleNick()
 663 {
 664         this->WriteFrom(this, "NICK %s", this->uuid.c_str());
 665         this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
 666
 667         // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
 668         this->registered &= ~REG_NICK;
 669         this->ChangeNick(this->uuid);
 670 }
 671
 672 int LocalUser::GetServerPort()
 673 {
 674         return this->server_sa.port();
 675 }
 676
 677 const std::string& User::GetIPString()
 678 {
 679         if (cachedip.empty())
 680         {
 681                 cachedip = client_sa.addr();
 682                 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
 683                 if (cachedip[0] == ':')
 684                         cachedip.insert(cachedip.begin(),1,'0');
 685         }
 686
 687         return cachedip;
 688 }
 689
 690 const std::string& User::GetHost(bool uncloak) const
 691 {
 692         return uncloak ? GetRealHost() : GetDisplayedHost();
 693 }
 694
 695 const std::string& User::GetDisplayedHost() const
 696 {
 697         return displayhost.empty() ? realhost : displayhost;
 698 }
 699
 700 const std::string& User::GetRealHost() const
 701 {
 702         return realhost;
 703 }
 704
 705 irc::sockets::cidr_mask User::GetCIDRMask()
 706 {
 707         unsigned char range = 0;
 708         switch (client_sa.sa.sa_family)
 709         {
 710                 case AF_INET6:
 711                         range = ServerInstance->Config->c_ipv6_range;
 712                         break;
 713                 case AF_INET:
 714                         range = ServerInstance->Config->c_ipv4_range;
 715                         break;
 716         }
 717         return irc::sockets::cidr_mask(client_sa, range);
 718 }
 719
 720 bool User::SetClientIP(const std::string& address, bool recheck_eline)
 721 {
 722         this->InvalidateCache();
 723         return irc::sockets::aptosa(address, 0, client_sa);
 724 }
 725
 726 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
 727 {
 728         this->InvalidateCache();
 729         memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
 730 }
 731
 732 bool LocalUser::SetClientIP(const std::string& address, bool recheck_eline)
 733 {
 734         irc::sockets::sockaddrs sa;
 735         if (!irc::sockets::aptosa(address, 0, sa))
 736                 // Invalid
 737                 return false;
 738
 739         LocalUser::SetClientIP(sa, recheck_eline);
 740         return true;
 741 }
 742
 743 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
 744 {
 745         if (sa != client_sa)
 746         {
 747                 User::SetClientIP(sa);
 748                 if (recheck_eline)
 749                         this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
 750
 751                 FOREACH_MOD(OnSetUserIP, (this));
 752         }
 753 }
 754
 755 static std::string wide_newline("\r\n");
 756
 757 void User::Write(const std::string& text)
 758 {
 759 }
 760
 761 void User::Write(const char *text, ...)
 762 {
 763 }
 764
 765 void LocalUser::Write(const std::string& text)
 766 {
 767         if (!SocketEngine::BoundsCheckFd(&eh))
 768                 return;
 769
 770         if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
 771         {
 772                 // this should happen rarely or never. Crop the string at 512 and try again.
 773                 std::string try_again(text, 0, ServerInstance->Config->Limits.MaxLine - 2);
 774                 Write(try_again);
 775                 return;
 776         }
 777
 778         ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
 779
 780         eh.AddWriteBuf(text);
 781         eh.AddWriteBuf(wide_newline);
 782
 783         ServerInstance->stats.Sent += text.length() + 2;
 784         this->bytes_out += text.length() + 2;
 785         this->cmds_out++;
 786 }
 787
 788 /** Write()
 789  */
 790 void LocalUser::Write(const char *text, ...)
 791 {
 792         std::string textbuffer;
 793         VAFORMAT(textbuffer, text, text);
 794         this->Write(textbuffer);
 795 }
 796
 797 void User::WriteServ(const std::string& text)
 798 {
 799         this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
 800 }
 801
 802 /** WriteServ()
 803  *  Same as Write(), except `text' is prefixed with `:server.name '.
 804  */
 805 void User::WriteServ(const char* text, ...)
 806 {
 807         std::string textbuffer;
 808         VAFORMAT(textbuffer, text, text);
 809         this->WriteServ(textbuffer);
 810 }
 811
 812 void User::WriteCommand(const char* command, const std::string& text)
 813 {
 814         this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
 815 }
 816
 817 namespace
 818 {
 819         std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
 820         {
 821                 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
 822                 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
 823                 if (!params.empty())
 824                 {
 825                         for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
 826                                 raw.append(1, ' ').append(*i);
 827                         raw.append(" :").append(params.back());
 828                 }
 829                 return raw;
 830         }
 831 }
 832
 833 void User::WriteNumeric(const Numeric::Numeric& numeric)
 834 {
 835         ModResult MOD_RESULT;
 836
 837         FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
 838
 839         if (MOD_RESULT == MOD_RES_DENY)
 840                 return;
 841
 842         const std::string& servername = (numeric.GetServer() ? numeric.GetServer()->GetName() : ServerInstance->Config->ServerName);
 843         this->Write(BuildNumeric(servername, this, numeric.GetNumeric(), numeric.GetParams()));
 844 }
 845
 846 void User::WriteFrom(User *user, const std::string &text)
 847 {
 848         const std::string message = ":" + user->GetFullHost() + " " + text;
 849         this->Write(message);
 850 }
 851
 852
 853 /* write text from an originating user to originating user */
 854
 855 void User::WriteFrom(User *user, const char* text, ...)
 856 {
 857         std::string textbuffer;
 858         VAFORMAT(textbuffer, text, text);
 859         this->WriteFrom(user, textbuffer);
 860 }
 861
 862 void User::WriteRemoteNotice(const std::string& text)
 863 {
 864         ServerInstance->PI->SendUserNotice(this, text);
 865 }
 866
 867 void LocalUser::WriteRemoteNotice(const std::string& text)
 868 {
 869         WriteNotice(text);
 870 }
 871
 872 namespace
 873 {
 874         class WriteCommonRawHandler : public User::ForEachNeighborHandler
 875         {
 876                 const std::string& msg;
 877
 878                 void Execute(LocalUser* user) CXX11_OVERRIDE
 879                 {
 880                         user->Write(msg);
 881                 }
 882
 883          public:
 884                 WriteCommonRawHandler(const std::string& message)
 885                         : msg(message)
 886                 {
 887                 }
 888         };
 889 }
 890
 891 void User::WriteCommon(const char* text, ...)
 892 {
 893         std::string textbuffer;
 894         VAFORMAT(textbuffer, text, text);
 895         textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
 896         this->WriteCommonRaw(textbuffer, true);
 897 }
 898
 899 void User::WriteCommonRaw(const std::string &line, bool include_self)
 900 {
 901         WriteCommonRawHandler handler(line);
 902         ForEachNeighbor(handler, include_self);
 903 }
 904
 905 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
 906 {
 907         // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
 908         // and visit all users on those channels. Because two users may share more than one common channel,
 909         // we must skip users that we have already visited.
 910         // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
 911         // The global counter is incremented every time we do something for each neighbor of a user. Then,
 912         // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
 913         // skip the member. Otherwise, we set it to the current counter and visit the member.
 914
 915         // Ask modules to build a list of exceptions.
 916         // Mods may also exclude entire channels by erasing them from include_chans.
 917         IncludeChanList include_chans(chans.begin(), chans.end());
 918         std::map<User*, bool> exceptions;
 919         exceptions[this] = include_self;
 920         FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
 921
 922         // Get next id, guaranteed to differ from the already_sent field of all users
 923         const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
 924
 925         // Handle exceptions first
 926         for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
 927         {
 928                 LocalUser* curr = IS_LOCAL(i->first);
 929                 if (curr)
 930                 {
 931                         // Mark as visited to ensure we won't visit again if there is a common channel
 932                         curr->already_sent = newid;
 933                         // Always treat quitting users as excluded
 934                         if ((i->second) && (!curr->quitting))
 935                                 handler.Execute(curr);
 936                 }
 937         }
 938
 939         // Now consider the real neighbors
 940         for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
 941         {
 942                 Channel* chan = (*i)->chan;
 943                 const Channel::MemberMap& userlist = chan->GetUsers();
 944                 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
 945                 {
 946                         LocalUser* curr = IS_LOCAL(j->first);
 947                         // User not yet visited?
 948                         if ((curr) && (curr->already_sent != newid))
 949                         {
 950                                 // Mark as visited and execute function
 951                                 curr->already_sent = newid;
 952                                 handler.Execute(curr);
 953                         }
 954                 }
 955         }
 956 }
 957
 958 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
 959 {
 960         WriteNumeric(numeric);
 961 }
 962
 963 /* return 0 or 1 depending if users u and u2 share one or more common channels
 964  * (used by QUIT, NICK etc which arent channel specific notices)
 965  *
 966  * The old algorithm in 1.0 for this was relatively inefficient, iterating over
 967  * the first users channels then the second users channels within the outer loop,
 968  * therefore it was a maximum of x*y iterations (upon returning 0 and checking
 969  * all possible iterations). However this new function instead checks against the
 970  * channel's userlist in the inner loop which is a std::map<User*,User*>
 971  * and saves us time as we already know what pointer value we are after.
 972  * Don't quote me on the maths as i am not a mathematician or computer scientist,
 973  * but i believe this algorithm is now x+(log y) maximum iterations instead.
 974  */
 975 bool User::SharesChannelWith(User *other)
 976 {
 977         /* Outer loop */
 978         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
 979         {
 980                 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
 981                  * by replacing it with a map::find which *should* be more efficient
 982                  */
 983                 if ((*i)->chan->HasUser(other))
 984                         return true;
 985         }
 986         return false;
 987 }
 988
 989 bool User::ChangeName(const std::string& gecos)
 990 {
 991         if (!this->fullname.compare(gecos))
 992                 return true;
 993
 994         if (IS_LOCAL(this))
 995         {
 996                 ModResult MOD_RESULT;
 997                 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
 998                 if (MOD_RESULT == MOD_RES_DENY)
 999                         return false;
1000                 FOREACH_MOD(OnChangeName, (this,gecos));
1001         }
1002         this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1003
1004         return true;
1005 }
1006
1007 bool User::ChangeDisplayedHost(const std::string& shost)
1008 {
1009         if (GetDisplayedHost() == shost)
1010                 return true;
1011
1012         if (IS_LOCAL(this))
1013         {
1014                 ModResult MOD_RESULT;
1015                 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1016                 if (MOD_RESULT == MOD_RES_DENY)
1017                         return false;
1018         }
1019
1020         FOREACH_MOD(OnChangeHost, (this,shost));
1021
1022         if (realhost == shost)
1023                 this->displayhost.clear();
1024         else
1025                 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1026
1027         this->InvalidateCache();
1028
1029         if (IS_LOCAL(this))
1030                 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1031
1032         return true;
1033 }
1034
1035 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1036 {
1037         // If the real host is the new host and we are not resetting the
1038         // display host then we have nothing to do.
1039         const bool changehost = (realhost != host);
1040         if (!changehost && !resetdisplay)
1041                 return;
1042
1043         // If the displayhost is not set and we are not resetting it then
1044         // we need to copy it to the displayhost field.
1045         if (displayhost.empty() && !resetdisplay)
1046                 displayhost = realhost;
1047
1048         // If the displayhost is the new host or we are resetting it then
1049         // we clear its contents to save memory.
1050         else if (displayhost == host || resetdisplay)
1051                 displayhost.clear();
1052
1053         // If we are just resetting the display host then we don't need to
1054         // do anything else.
1055         if (!changehost)
1056                 return;
1057
1058         realhost = host;
1059         this->InvalidateCache();
1060 }
1061
1062 bool User::ChangeIdent(const std::string& newident)
1063 {
1064         if (this->ident == newident)
1065                 return true;
1066
1067         FOREACH_MOD(OnChangeIdent, (this,newident));
1068
1069         this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1070         this->InvalidateCache();
1071
1072         return true;
1073 }
1074
1075 /*
1076  * Sets a user's connection class.
1077  * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1078  * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1079  * then their ip will be taken as 'priority' anyway, so for example,
1080  * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1081  */
1082 void LocalUser::SetClass(const std::string &explicit_name)
1083 {
1084         ConnectClass *found = NULL;
1085
1086         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1087
1088         if (!explicit_name.empty())
1089         {
1090                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1091                 {
1092                         ConnectClass* c = *i;
1093
1094                         if (explicit_name == c->name)
1095                         {
1096                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1097                                 found = c;
1098                         }
1099                 }
1100         }
1101         else
1102         {
1103                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1104                 {
1105                         ConnectClass* c = *i;
1106                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1107
1108                         ModResult MOD_RESULT;
1109                         FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1110                         if (MOD_RESULT == MOD_RES_DENY)
1111                                 continue;
1112                         if (MOD_RESULT == MOD_RES_ALLOW)
1113                         {
1114                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1115                                 found = c;
1116                                 break;
1117                         }
1118
1119                         if (c->type == CC_NAMED)
1120                                 continue;
1121
1122                         bool regdone = (registered != REG_NONE);
1123                         if (c->config->getBool("registered", regdone) != regdone)
1124                                 continue;
1125
1126                         /* check if host matches.. */
1127                         if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1128                             !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1129                         {
1130                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1131                                 continue;
1132                         }
1133
1134                         /*
1135                          * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1136                          * because we should attempt to find another class if this one doesn't match us. -- w00t
1137                          */
1138                         if (c->limit && (c->GetReferenceCount() >= c->limit))
1139                         {
1140                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1141                                 continue;
1142                         }
1143
1144                         /* if it requires a port ... */
1145                         if (!c->ports.empty())
1146                         {
1147                                 /* and our port doesn't match, fail. */
1148                                 if (!c->ports.count(this->GetServerPort()))
1149                                 {
1150                                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1151                                         continue;
1152                                 }
1153                         }
1154
1155                         if (regdone && !c->config->getString("password").empty())
1156                         {
1157                                 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1158                                 {
1159                                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1160                                         continue;
1161                                 }
1162                         }
1163
1164                         /* we stop at the first class that meets ALL critera. */
1165                         found = c;
1166                         break;
1167                 }
1168         }
1169
1170         /*
1171          * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1172          */
1173         if (found)
1174         {
1175                 MyClass = found;
1176         }
1177 }
1178
1179 void User::PurgeEmptyChannels()
1180 {
1181         // firstly decrement the count on each channel
1182         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1183         {
1184                 Channel* c = (*i)->chan;
1185                 ++i;
1186                 c->DelUser(this);
1187         }
1188
1189         this->UnOper();
1190 }
1191
1192 const std::string& FakeUser::GetFullHost()
1193 {
1194         if (!ServerInstance->Config->HideServer.empty())
1195                 return ServerInstance->Config->HideServer;
1196         return server->GetName();
1197 }
1198
1199 const std::string& FakeUser::GetFullRealHost()
1200 {
1201         if (!ServerInstance->Config->HideServer.empty())
1202                 return ServerInstance->Config->HideServer;
1203         return server->GetName();
1204 }
1205
1206 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1207         : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1208         pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1209         penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1210         limit(0), resolvehostnames(true)
1211 {
1212 }
1213
1214 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1215 {
1216         Update(&parent);
1217         name = "unnamed";
1218         type = t;
1219         host = mask;
1220
1221         // Connect classes can inherit from each other but this is problematic for modules which can't use
1222         // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1223         // well as the parent class.
1224         ConfigItems* items = NULL;
1225         config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1226
1227         const ConfigItems& parentkeys = parent.config->getItems();
1228         for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1229         {
1230                 // The class name and parent name are not inherited
1231                 if (piter->first == "name" || piter->first == "parent")
1232                         continue;
1233
1234                 // Store the item in the config tag. If this item also
1235                 // exists in the child it will be overwritten.
1236                 (*items)[piter->first] = piter->second;
1237         }
1238
1239         const ConfigItems& childkeys = tag->getItems();
1240         for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1241         {
1242                 // This will overwrite the parent value if present.
1243                 (*items)[citer->first] = citer->second;
1244         }
1245 }
1246
1247 void ConnectClass::Update(const ConnectClass* src)
1248 {
1249         config = src->config;
1250         type = src->type;
1251         fakelag = src->fakelag;
1252         name = src->name;
1253         registration_timeout = src->registration_timeout;
1254         host = src->host;
1255         pingtime = src->pingtime;
1256         softsendqmax = src->softsendqmax;
1257         hardsendqmax = src->hardsendqmax;
1258         recvqmax = src->recvqmax;
1259         penaltythreshold = src->penaltythreshold;
1260         commandrate = src->commandrate;
1261         maxlocal = src->maxlocal;
1262         maxglobal = src->maxglobal;
1263         maxconnwarn = src->maxconnwarn;
1264         maxchans = src->maxchans;
1265         limit = src->limit;
1266         resolvehostnames = src->resolvehostnames;
1267         ports = src->ports;
1268 }