2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
29 bool User::IsNoticeMaskSet(unsigned char sm)
33 return (snomasks[sm-65]);
36 bool User::IsModeSet(unsigned char m) const
38 ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
39 return (mh && modes[mh->GetId()]);
42 std::string User::GetModeLetters(bool includeparams) const
44 std::string ret(1, '+');
47 for (unsigned char i = 'A'; i < 'z'; i++)
49 const ModeHandler* const mh = ServerInstance->Modes.FindMode(i, MODETYPE_USER);
50 if ((!mh) || (!IsModeSet(mh)))
53 ret.push_back(mh->GetModeChar());
54 if ((includeparams) && (mh->NeedsParam(true)))
56 const std::string val = mh->GetUserParameter(this);
58 params.append(1, ' ').append(val);
66 User::User(const std::string& uid, Server* srv, UserType type)
67 : age(ServerInstance->Time())
71 , registered(REG_NONE)
75 client_sa.sa.sa_family = AF_UNSPEC;
77 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
79 // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
80 if (type != USERTYPE_SERVER)
82 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
83 throw CoreException("Duplicate UUID in User constructor: " + uuid);
87 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
88 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL)
94 , quitting_sendq(false)
99 , CommandFloodPenalty(0)
102 signon = ServerInstance->Time();
103 // The user's default nick is their UUID
107 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
108 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
109 ChangeRealHost(GetIPString(), true);
116 const std::string& User::MakeHost()
118 if (!this->cached_makehost.empty())
119 return this->cached_makehost;
121 // XXX: Is there really a need to cache this?
122 this->cached_makehost = ident + "@" + GetRealHost();
123 return this->cached_makehost;
126 const std::string& User::MakeHostIP()
128 if (!this->cached_hostip.empty())
129 return this->cached_hostip;
131 // XXX: Is there really a need to cache this?
132 this->cached_hostip = ident + "@" + this->GetIPString();
133 return this->cached_hostip;
136 const std::string& User::GetFullHost()
138 if (!this->cached_fullhost.empty())
139 return this->cached_fullhost;
141 // XXX: Is there really a need to cache this?
142 this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
143 return this->cached_fullhost;
146 const std::string& User::GetFullRealHost()
148 if (!this->cached_fullrealhost.empty())
149 return this->cached_fullrealhost;
151 // XXX: Is there really a need to cache this?
152 this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
153 return this->cached_fullrealhost;
156 bool User::HasModePermission(const ModeHandler* mh) const
161 bool LocalUser::HasModePermission(const ModeHandler* mh) const
166 const unsigned char mode = mh->GetModeChar();
167 if (mode < 'A' || mode > ('A' + 64)) return false;
169 return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
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.
179 bool User::HasPermission(const std::string&)
184 bool LocalUser::HasPermission(const std::string &command)
186 // are they even an oper at all?
192 return oper->AllowedOperCommands.Contains(command);
195 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
200 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
205 this->WriteNotice("You are not an oper");
209 if (oper->AllowedPrivs.Contains(privstr))
213 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
218 void UserIOHandler::OnDataReady()
223 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
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());
231 unsigned long sendqmax = ULONG_MAX;
232 if (!user->HasPrivPermission("users/flood/increased-buffers"))
233 sendqmax = user->MyClass->GetSendqSoftMax();
235 unsigned long penaltymax = ULONG_MAX;
236 if (!user->HasPrivPermission("users/flood/no-fakelag"))
237 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
239 // The maximum size of an IRC message minus the terminating CR+LF.
240 const size_t maxmessage = ServerInstance->Config->Limits.MaxLine - 2;
242 line.reserve(maxmessage);
245 std::string::size_type qpos;
247 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
252 const size_t qlen = recvq.length();
255 char c = recvq[qpos++];
271 if (line.length() < maxmessage)
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
280 // just found a newline. Terminate the string, and pull it out of recvq
281 recvq.erase(0, qpos);
283 // TODO should this be moved to when it was inserted in recvq?
284 ServerInstance->stats.Recv += qpos;
285 user->bytes_in += qpos;
288 ServerInstance->Parser.ProcessBuffer(line, user);
292 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
296 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
297 ServerInstance->Users->QuitUser(user, "Excess Flood");
300 void UserIOHandler::AddWriteBuf(const std::string &data)
302 if (user->quitting_sendq)
304 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
305 !user->HasPrivPermission("users/flood/increased-buffers"))
307 user->quitting_sendq = true;
308 ServerInstance->GlobalCulls.AddSQItem(user);
312 // We still want to append data to the sendq of a quitting user,
313 // e.g. their ERROR message that says 'closing link'
318 void UserIOHandler::OnError(BufferedSocketError)
320 ServerInstance->Users->QuitUser(user, getError());
323 CullResult User::cull()
326 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
328 if (client_sa.sa.sa_family != AF_UNSPEC)
329 ServerInstance->Users->RemoveCloneCounts(this);
331 return Extensible::cull();
334 CullResult LocalUser::cull()
340 CullResult FakeUser::cull()
342 // Fake users don't quit, they just get culled.
344 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
348 void User::Oper(OperInfo* info)
350 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
351 if (this->IsModeSet(opermh))
354 this->SetMode(opermh, true);
356 this->WriteCommand("MODE", "+o");
357 FOREACH_MOD(OnOper, (this, info->name));
359 std::string opername;
360 if (info->oper_block)
361 opername = info->oper_block->getString("name");
365 LocalUser* l = IS_LOCAL(this);
366 std::string vhost = oper->getConfig("vhost");
368 l->ChangeDisplayedHost(vhost);
369 std::string opClass = oper->getConfig("class");
370 if (!opClass.empty())
371 l->SetClass(opClass);
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()));
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);
381 // Expand permissions from config for faster lookup
385 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
388 void OperInfo::init()
390 AllowedOperCommands.Clear();
391 AllowedPrivs.Clear();
392 AllowedUserModes.reset();
393 AllowedChanModes.reset();
394 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
396 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
398 ConfigTag* tag = *iter;
400 AllowedOperCommands.AddList(tag->getString("commands"));
401 AllowedPrivs.AddList(tag->getString("privs"));
403 std::string modes = tag->getString("usermodes");
404 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
408 this->AllowedUserModes.set();
410 else if (*c >= 'A' && *c <= 'z')
412 this->AllowedUserModes[*c - 'A'] = true;
416 modes = tag->getString("chanmodes");
417 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
421 this->AllowedChanModes.set();
423 else if (*c >= 'A' && *c <= 'z')
425 this->AllowedChanModes[*c - 'A'] = true;
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
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)
449 ModeHandler* mh = i->second;
451 changelist.push_remove(mh);
454 ServerInstance->Modes->Process(this, NULL, this, changelist);
456 // Remove the user from the oper list
457 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
459 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
460 this->SetMode(opermh, false);
461 FOREACH_MOD(OnPostDeoper, (this));
465 * Check class restrictions
467 void LocalUser::CheckClass(bool clone_count)
469 ConnectClass* a = this->MyClass;
473 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
476 else if (a->type == CC_DENY)
478 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
481 else if (clone_count)
483 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
484 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
486 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
488 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
491 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
493 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
495 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
500 this->nping = ServerInstance->Time() + a->GetPingTime();
503 bool LocalUser::CheckLines(bool doZline)
505 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
509 for (int n = 0; check[n]; ++n)
511 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
524 void LocalUser::FullConnect()
526 ServerInstance->stats.Connects++;
527 this->idle_lastmsg = ServerInstance->Time();
530 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
531 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
532 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
533 * Don't remove this! -- w00t
543 this->WriteNumeric(RPL_WELCOME, InspIRCd::Format("Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str()));
544 this->WriteNumeric(RPL_YOURHOSTIS, InspIRCd::Format("Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH));
545 this->WriteNumeric(RPL_SERVERCREATED, InspIRCd::TimeString(ServerInstance->startup_time, "This server was created %H:%M:%S %b %d %Y"));
547 const TR1NS::array<std::string, 3>& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
548 this->WriteNumeric(RPL_SERVERVERSION, ServerInstance->Config->ServerName, INSPIRCD_BRANCH, modelist[0], modelist[1], modelist[2]);
550 ServerInstance->ISupport.SendTo(this);
553 if (ServerInstance->Users->unregistered_count)
554 ServerInstance->Users->unregistered_count--;
556 /* Trigger MOTD and LUSERS output, give modules a chance too */
557 ModResult MOD_RESULT;
558 std::string command("LUSERS");
559 std::vector<std::string> parameters;
560 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
562 ServerInstance->Parser.CallHandler(command, parameters, this);
564 MOD_RESULT = MOD_RES_PASSTHRU;
566 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
568 ServerInstance->Parser.CallHandler(command, parameters, this);
570 if (ServerInstance->Config->RawLog)
571 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
574 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
575 * for a user that doesn't exist yet.
577 FOREACH_MOD(OnUserConnect, (this));
579 this->registered = REG_ALL;
581 FOREACH_MOD(OnPostConnect, (this));
583 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
584 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
585 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
586 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
587 // reset the flood penalty (which could have been raised due to things like auto +x)
588 CommandFloodPenalty = 0;
591 void User::InvalidateCache()
593 /* Invalidate cache */
595 cached_fullhost.clear();
596 cached_hostip.clear();
597 cached_makehost.clear();
598 cached_fullrealhost.clear();
601 bool User::ChangeNick(const std::string& newnick, time_t newts)
605 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
609 User* const InUse = ServerInstance->FindNickOnly(newnick);
612 // case change, don't need to check campers
613 // and, if it's identical including case, we can leave right now
614 // We also don't update the nick TS if it's a case change, either
621 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
622 * then we have a potential collide. Check whether someone else is camping on the nick
623 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
624 * camper to their UID, and allow the incoming nick change.
626 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
627 * because the nick is already (rightfully) in use. -- w00t
631 if (InUse->registered != REG_ALL)
633 /* force the camper to their UUID, and ask them to re-send a NICK. */
634 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
635 localuser->OverruleNick();
639 /* No camping, tell the incoming user to stop trying to change nick ;p */
640 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
645 age = newts ? newts : ServerInstance->Time();
648 if (this->registered == REG_ALL)
649 this->WriteCommon("NICK %s", newnick.c_str());
650 const std::string oldnick = nick;
654 ServerInstance->Users->clientlist.erase(oldnick);
655 ServerInstance->Users->clientlist[newnick] = this;
657 if (registered == REG_ALL)
658 FOREACH_MOD(OnUserPostNick, (this,oldnick));
663 void LocalUser::OverruleNick()
665 this->WriteFrom(this, "NICK %s", this->uuid.c_str());
666 this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
668 // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
669 this->registered &= ~REG_NICK;
670 this->ChangeNick(this->uuid);
673 int LocalUser::GetServerPort()
675 return this->server_sa.port();
678 const std::string& User::GetIPString()
680 if (cachedip.empty())
682 cachedip = client_sa.addr();
683 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
684 if (cachedip[0] == ':')
685 cachedip.insert(cachedip.begin(),1,'0');
691 const std::string& User::GetHost(bool uncloak) const
693 return uncloak ? GetRealHost() : GetDisplayedHost();
696 const std::string& User::GetDisplayedHost() const
698 return displayhost.empty() ? realhost : displayhost;
701 const std::string& User::GetRealHost() const
706 irc::sockets::cidr_mask User::GetCIDRMask()
708 unsigned char range = 0;
709 switch (client_sa.sa.sa_family)
712 range = ServerInstance->Config->c_ipv6_range;
715 range = ServerInstance->Config->c_ipv4_range;
718 return irc::sockets::cidr_mask(client_sa, range);
721 bool User::SetClientIP(const std::string& address, bool recheck_eline)
723 this->InvalidateCache();
724 return irc::sockets::aptosa(address, 0, client_sa);
727 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
729 this->InvalidateCache();
730 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
733 bool LocalUser::SetClientIP(const std::string& address, bool recheck_eline)
735 irc::sockets::sockaddrs sa;
736 if (!irc::sockets::aptosa(address, 0, sa))
740 LocalUser::SetClientIP(sa, recheck_eline);
744 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
748 User::SetClientIP(sa);
750 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
752 FOREACH_MOD(OnSetUserIP, (this));
756 static std::string wide_newline("\r\n");
758 void User::Write(const std::string& text)
762 void User::Write(const char *text, ...)
766 void LocalUser::Write(const std::string& text)
768 if (!SocketEngine::BoundsCheckFd(&eh))
771 // The maximum size of an IRC message minus the terminating CR+LF.
772 const size_t maxmessage = ServerInstance->Config->Limits.MaxLine - 2;
773 if (text.length() > maxmessage)
775 // This should happen rarely or never. Crop the string at MaxLine and try again.
776 std::string try_again(text, 0, maxmessage);
781 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
783 eh.AddWriteBuf(text);
784 eh.AddWriteBuf(wide_newline);
786 const size_t bytessent = text.length() + 2;
787 ServerInstance->stats.Sent += bytessent;
788 this->bytes_out += bytessent;
794 void LocalUser::Write(const char *text, ...)
796 std::string textbuffer;
797 VAFORMAT(textbuffer, text, text);
798 this->Write(textbuffer);
801 void User::WriteServ(const std::string& text)
803 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
807 * Same as Write(), except `text' is prefixed with `:server.name '.
809 void User::WriteServ(const char* text, ...)
811 std::string textbuffer;
812 VAFORMAT(textbuffer, text, text);
813 this->WriteServ(textbuffer);
816 void User::WriteCommand(const char* command, const std::string& text)
818 this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
823 std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
825 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
826 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
829 for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
830 raw.append(1, ' ').append(*i);
831 raw.append(" :").append(params.back());
837 void User::WriteNumeric(const Numeric::Numeric& numeric)
839 ModResult MOD_RESULT;
841 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
843 if (MOD_RESULT == MOD_RES_DENY)
846 const std::string& servername = (numeric.GetServer() ? numeric.GetServer()->GetName() : ServerInstance->Config->ServerName);
847 this->Write(BuildNumeric(servername, this, numeric.GetNumeric(), numeric.GetParams()));
850 void User::WriteFrom(User *user, const std::string &text)
852 const std::string message = ":" + user->GetFullHost() + " " + text;
853 this->Write(message);
857 /* write text from an originating user to originating user */
859 void User::WriteFrom(User *user, const char* text, ...)
861 std::string textbuffer;
862 VAFORMAT(textbuffer, text, text);
863 this->WriteFrom(user, textbuffer);
866 void User::WriteRemoteNotice(const std::string& text)
868 ServerInstance->PI->SendUserNotice(this, text);
871 void LocalUser::WriteRemoteNotice(const std::string& text)
878 class WriteCommonRawHandler : public User::ForEachNeighborHandler
880 const std::string& msg;
882 void Execute(LocalUser* user) CXX11_OVERRIDE
888 WriteCommonRawHandler(const std::string& message)
895 void User::WriteCommon(const char* text, ...)
897 std::string textbuffer;
898 VAFORMAT(textbuffer, text, text);
899 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
900 this->WriteCommonRaw(textbuffer, true);
903 void User::WriteCommonRaw(const std::string &line, bool include_self)
905 WriteCommonRawHandler handler(line);
906 ForEachNeighbor(handler, include_self);
909 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
911 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
912 // and visit all users on those channels. Because two users may share more than one common channel,
913 // we must skip users that we have already visited.
914 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
915 // The global counter is incremented every time we do something for each neighbor of a user. Then,
916 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
917 // skip the member. Otherwise, we set it to the current counter and visit the member.
919 // Ask modules to build a list of exceptions.
920 // Mods may also exclude entire channels by erasing them from include_chans.
921 IncludeChanList include_chans(chans.begin(), chans.end());
922 std::map<User*, bool> exceptions;
923 exceptions[this] = include_self;
924 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
926 // Get next id, guaranteed to differ from the already_sent field of all users
927 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
929 // Handle exceptions first
930 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
932 LocalUser* curr = IS_LOCAL(i->first);
935 // Mark as visited to ensure we won't visit again if there is a common channel
936 curr->already_sent = newid;
937 // Always treat quitting users as excluded
938 if ((i->second) && (!curr->quitting))
939 handler.Execute(curr);
943 // Now consider the real neighbors
944 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
946 Channel* chan = (*i)->chan;
947 const Channel::MemberMap& userlist = chan->GetUsers();
948 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
950 LocalUser* curr = IS_LOCAL(j->first);
951 // User not yet visited?
952 if ((curr) && (curr->already_sent != newid))
954 // Mark as visited and execute function
955 curr->already_sent = newid;
956 handler.Execute(curr);
962 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
964 WriteNumeric(numeric);
967 /* return 0 or 1 depending if users u and u2 share one or more common channels
968 * (used by QUIT, NICK etc which arent channel specific notices)
970 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
971 * the first users channels then the second users channels within the outer loop,
972 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
973 * all possible iterations). However this new function instead checks against the
974 * channel's userlist in the inner loop which is a std::map<User*,User*>
975 * and saves us time as we already know what pointer value we are after.
976 * Don't quote me on the maths as i am not a mathematician or computer scientist,
977 * but i believe this algorithm is now x+(log y) maximum iterations instead.
979 bool User::SharesChannelWith(User *other)
982 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
984 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
985 * by replacing it with a map::find which *should* be more efficient
987 if ((*i)->chan->HasUser(other))
993 bool User::ChangeName(const std::string& gecos)
995 if (!this->fullname.compare(gecos))
1000 ModResult MOD_RESULT;
1001 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
1002 if (MOD_RESULT == MOD_RES_DENY)
1004 FOREACH_MOD(OnChangeName, (this,gecos));
1006 this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1011 bool User::ChangeDisplayedHost(const std::string& shost)
1013 if (GetDisplayedHost() == shost)
1018 ModResult MOD_RESULT;
1019 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1020 if (MOD_RESULT == MOD_RES_DENY)
1024 FOREACH_MOD(OnChangeHost, (this,shost));
1026 if (realhost == shost)
1027 this->displayhost.clear();
1029 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1031 this->InvalidateCache();
1034 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1039 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1041 // If the real host is the new host and we are not resetting the
1042 // display host then we have nothing to do.
1043 const bool changehost = (realhost != host);
1044 if (!changehost && !resetdisplay)
1047 // If the displayhost is not set and we are not resetting it then
1048 // we need to copy it to the displayhost field.
1049 if (displayhost.empty() && !resetdisplay)
1050 displayhost = realhost;
1052 // If the displayhost is the new host or we are resetting it then
1053 // we clear its contents to save memory.
1054 else if (displayhost == host || resetdisplay)
1055 displayhost.clear();
1057 // If we are just resetting the display host then we don't need to
1058 // do anything else.
1063 this->InvalidateCache();
1066 bool User::ChangeIdent(const std::string& newident)
1068 if (this->ident == newident)
1071 FOREACH_MOD(OnChangeIdent, (this,newident));
1073 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1074 this->InvalidateCache();
1080 * Sets a user's connection class.
1081 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1082 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1083 * then their ip will be taken as 'priority' anyway, so for example,
1084 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1086 void LocalUser::SetClass(const std::string &explicit_name)
1088 ConnectClass *found = NULL;
1090 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1092 if (!explicit_name.empty())
1094 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1096 ConnectClass* c = *i;
1098 if (explicit_name == c->name)
1100 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1107 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1109 ConnectClass* c = *i;
1110 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1112 ModResult MOD_RESULT;
1113 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1114 if (MOD_RESULT == MOD_RES_DENY)
1116 if (MOD_RESULT == MOD_RES_ALLOW)
1118 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1123 if (c->type == CC_NAMED)
1126 bool regdone = (registered != REG_NONE);
1127 if (c->config->getBool("registered", regdone) != regdone)
1130 /* check if host matches.. */
1131 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1132 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1134 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1139 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1140 * because we should attempt to find another class if this one doesn't match us. -- w00t
1142 if (c->limit && (c->GetReferenceCount() >= c->limit))
1144 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1148 /* if it requires a port ... */
1149 if (!c->ports.empty())
1151 /* and our port doesn't match, fail. */
1152 if (!c->ports.count(this->GetServerPort()))
1154 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1159 if (regdone && !c->config->getString("password").empty())
1161 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1163 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1168 /* we stop at the first class that meets ALL critera. */
1175 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1183 void User::PurgeEmptyChannels()
1185 // firstly decrement the count on each channel
1186 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1188 Channel* c = (*i)->chan;
1196 const std::string& FakeUser::GetFullHost()
1198 if (!ServerInstance->Config->HideServer.empty())
1199 return ServerInstance->Config->HideServer;
1200 return server->GetName();
1203 const std::string& FakeUser::GetFullRealHost()
1205 if (!ServerInstance->Config->HideServer.empty())
1206 return ServerInstance->Config->HideServer;
1207 return server->GetName();
1210 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1211 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1212 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1213 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1214 limit(0), resolvehostnames(true)
1218 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1225 // Connect classes can inherit from each other but this is problematic for modules which can't use
1226 // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1227 // well as the parent class.
1228 ConfigItems* items = NULL;
1229 config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1231 const ConfigItems& parentkeys = parent.config->getItems();
1232 for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1234 // The class name and parent name are not inherited
1235 if (piter->first == "name" || piter->first == "parent")
1238 // Store the item in the config tag. If this item also
1239 // exists in the child it will be overwritten.
1240 (*items)[piter->first] = piter->second;
1243 const ConfigItems& childkeys = tag->getItems();
1244 for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1246 // This will overwrite the parent value if present.
1247 (*items)[citer->first] = citer->second;
1251 void ConnectClass::Update(const ConnectClass* src)
1253 config = src->config;
1255 fakelag = src->fakelag;
1257 registration_timeout = src->registration_timeout;
1259 pingtime = src->pingtime;
1260 softsendqmax = src->softsendqmax;
1261 hardsendqmax = src->hardsendqmax;
1262 recvqmax = src->recvqmax;
1263 penaltythreshold = src->penaltythreshold;
1264 commandrate = src->commandrate;
1265 maxlocal = src->maxlocal;
1266 maxglobal = src->maxglobal;
1267 maxconnwarn = src->maxconnwarn;
1268 maxchans = src->maxchans;
1270 resolvehostnames = src->resolvehostnames;