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