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 ClientProtocol::MessageList LocalUser::sendmsglist;
31 bool User::IsNoticeMaskSet(unsigned char sm)
35 return (snomasks[sm-65]);
38 bool User::IsModeSet(unsigned char m) const
40 ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
41 return (mh && modes[mh->GetId()]);
44 std::string User::GetModeLetters(bool includeparams) const
46 std::string ret(1, '+');
49 for (unsigned char i = 'A'; i <= 'z'; i++)
51 const ModeHandler* const mh = ServerInstance->Modes.FindMode(i, MODETYPE_USER);
52 if ((!mh) || (!IsModeSet(mh)))
55 ret.push_back(mh->GetModeChar());
56 if ((includeparams) && (mh->NeedsParam(true)))
58 const std::string val = mh->GetUserParameter(this);
60 params.append(1, ' ').append(val);
68 User::User(const std::string& uid, Server* srv, UserType type)
69 : age(ServerInstance->Time())
73 , registered(REG_NONE)
77 client_sa.sa.sa_family = AF_UNSPEC;
79 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
81 // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
82 if (type != USERTYPE_SERVER)
84 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
85 throw CoreException("Duplicate UUID in User constructor: " + uuid);
89 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
90 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL)
97 , quitting_sendq(false)
102 , CommandFloodPenalty(0)
105 signon = ServerInstance->Time();
106 // The user's default nick is their UUID
110 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
111 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
112 ChangeRealHost(GetIPString(), true);
115 LocalUser::LocalUser(int myfd, const std::string& uid, Serializable::Data& data)
116 : User(uid, ServerInstance->FakeClient->server, USERTYPE_LOCAL)
128 const std::string& User::MakeHost()
130 if (!this->cached_makehost.empty())
131 return this->cached_makehost;
133 this->cached_makehost = ident + "@" + GetRealHost();
134 return this->cached_makehost;
137 const std::string& User::MakeHostIP()
139 if (!this->cached_hostip.empty())
140 return this->cached_hostip;
142 this->cached_hostip = ident + "@" + this->GetIPString();
143 return this->cached_hostip;
146 const std::string& User::GetFullHost()
148 if (!this->cached_fullhost.empty())
149 return this->cached_fullhost;
151 this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
152 return this->cached_fullhost;
155 const std::string& User::GetFullRealHost()
157 if (!this->cached_fullrealhost.empty())
158 return this->cached_fullrealhost;
160 this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
161 return this->cached_fullrealhost;
164 bool User::HasModePermission(const ModeHandler* mh) const
169 bool LocalUser::HasModePermission(const ModeHandler* mh) const
174 const unsigned char mode = mh->GetModeChar();
175 if (!ModeParser::IsModeChar(mode))
178 return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
182 * users on remote servers can completely bypass all permissions based checks.
183 * This prevents desyncs when one server has different type/class tags to another.
184 * That having been said, this does open things up to the possibility of source changes
185 * allowing remote kills, etc - but if they have access to the src, they most likely have
186 * access to the conf - so it's an end to a means either way.
188 bool User::HasCommandPermission(const std::string&)
193 bool LocalUser::HasCommandPermission(const std::string& command)
195 // are they even an oper at all?
201 return oper->AllowedOperCommands.Contains(command);
204 bool User::HasPrivPermission(const std::string& privstr)
209 bool LocalUser::HasPrivPermission(const std::string& privstr)
214 return oper->AllowedPrivs.Contains(privstr);
217 void UserIOHandler::OnDataReady()
222 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
224 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
225 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
226 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
230 unsigned long sendqmax = ULONG_MAX;
231 if (!user->HasPrivPermission("users/flood/increased-buffers"))
232 sendqmax = user->MyClass->GetSendqSoftMax();
234 unsigned long penaltymax = ULONG_MAX;
235 if (!user->HasPrivPermission("users/flood/no-fakelag"))
236 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
238 // The cleaned message sent by the user or empty if not found yet.
241 // The position of the most \n character or npos if not found yet.
242 std::string::size_type eolpos;
244 // The position within the recvq of the current character.
245 std::string::size_type qpos;
247 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
249 // Check the newly received data for an EOL.
250 eolpos = recvq.find('\n', checked_until);
251 if (eolpos == std::string::npos)
253 checked_until = recvq.length();
257 // We've found a line! Clean it up and move it to the line buffer.
258 line.reserve(eolpos);
259 for (qpos = 0; qpos < eolpos; ++qpos)
261 char c = recvq[qpos];
274 // just found a newline. Terminate the string, and pull it out of recvq
275 recvq.erase(0, eolpos + 1);
278 // TODO should this be moved to when it was inserted in recvq?
279 ServerInstance->stats.Recv += qpos;
280 user->bytes_in += qpos;
283 ServerInstance->Parser.ProcessBuffer(user, line);
287 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
291 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
292 ServerInstance->Users->QuitUser(user, "Excess Flood");
295 void UserIOHandler::AddWriteBuf(const std::string &data)
297 if (user->quitting_sendq)
299 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
300 !user->HasPrivPermission("users/flood/increased-buffers"))
302 user->quitting_sendq = true;
303 ServerInstance->GlobalCulls.AddSQItem(user);
307 // We still want to append data to the sendq of a quitting user,
308 // e.g. their ERROR message that says 'closing link'
313 void UserIOHandler::SwapInternals(UserIOHandler& other)
315 StreamSocket::SwapInternals(other);
316 std::swap(checked_until, other.checked_until);
319 bool UserIOHandler::OnSetEndPoint(const irc::sockets::sockaddrs& server, const irc::sockets::sockaddrs& client)
321 memcpy(&user->server_sa, &server, sizeof(irc::sockets::sockaddrs));
322 user->SetClientIP(client);
323 return !user->quitting;
326 void UserIOHandler::OnError(BufferedSocketError sockerr)
329 FIRST_MOD_RESULT(OnConnectionFail, res, (user, sockerr));
330 if (res != MOD_RES_ALLOW)
331 ServerInstance->Users->QuitUser(user, getError());
334 CullResult User::cull()
337 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
339 if (client_sa.family() != AF_UNSPEC)
340 ServerInstance->Users->RemoveCloneCounts(this);
342 return Extensible::cull();
345 CullResult LocalUser::cull()
351 CullResult FakeUser::cull()
353 // Fake users don't quit, they just get culled.
355 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
359 void User::Oper(OperInfo* info)
361 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
364 if (this->IsModeSet(opermh))
366 this->SetMode(opermh, true);
370 LocalUser* localuser = IS_LOCAL(this);
373 Modes::ChangeList changelist;
374 changelist.push_add(opermh);
375 ClientProtocol::Events::Mode modemsg(ServerInstance->FakeClient, NULL, localuser, changelist);
376 localuser->Send(modemsg);
379 FOREACH_MOD(OnOper, (this, info->name));
381 std::string opername;
382 if (info->oper_block)
383 opername = info->oper_block->getString("name");
385 ServerInstance->SNO->WriteToSnoMask('o', "%s (%s@%s) is now a server operator of type %s (using oper '%s')",
386 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
387 this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
389 ServerInstance->Users->all_opers.push_back(this);
391 // Expand permissions from config for faster lookup
395 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
398 void OperInfo::init()
400 AllowedOperCommands.Clear();
401 AllowedPrivs.Clear();
402 AllowedUserModes.reset();
403 AllowedChanModes.reset();
404 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
406 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
408 ConfigTag* tag = *iter;
410 AllowedOperCommands.AddList(tag->getString("commands"));
411 AllowedPrivs.AddList(tag->getString("privs"));
413 std::string modes = tag->getString("usermodes");
414 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
418 this->AllowedUserModes.set();
420 else if (*c >= 'A' && *c <= 'z')
422 this->AllowedUserModes[*c - 'A'] = true;
426 modes = tag->getString("chanmodes");
427 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
431 this->AllowedChanModes.set();
433 else if (*c >= 'A' && *c <= 'z')
435 this->AllowedChanModes[*c - 'A'] = true;
447 * unset their oper type (what IS_OPER checks).
448 * note, order is important - this must come before modes as -o attempts
449 * to call UnOper. -- w00t
453 // Remove the user from the oper list
454 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
456 // If the user is quitting we shouldn't remove any modes as it results in
457 // mode messages being broadcast across the network.
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)
466 ModeHandler* mh = i->second;
468 changelist.push_remove(mh);
471 ServerInstance->Modes->Process(this, NULL, this, changelist);
473 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
475 this->SetMode(opermh, false);
476 FOREACH_MOD(OnPostDeoper, (this));
480 * Check class restrictions
482 void LocalUser::CheckClass(bool clone_count)
484 ConnectClass* a = this->MyClass;
488 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
491 else if (a->type == CC_DENY)
493 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
496 else if (clone_count)
498 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
499 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
501 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
504 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum local connections for the %s class (%ld) exceeded by %s",
505 a->name.c_str(), a->GetMaxLocal(), this->GetIPString().c_str());
509 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
511 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
514 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum global connections for the %s class (%ld) exceeded by %s",
515 a->name.c_str(), a->GetMaxGlobal(), this->GetIPString().c_str());
521 this->nextping = ServerInstance->Time() + a->GetPingTime();
524 bool LocalUser::CheckLines(bool doZline)
526 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
530 for (int n = 0; check[n]; ++n)
532 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
545 void LocalUser::FullConnect()
547 ServerInstance->stats.Connects++;
548 this->idle_lastmsg = ServerInstance->Time();
551 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
552 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
553 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
554 * Don't remove this! -- w00t
565 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
566 * for a user that doesn't exist yet.
568 FOREACH_MOD(OnUserConnect, (this));
571 if (ServerInstance->Users->unregistered_count)
572 ServerInstance->Users->unregistered_count--;
573 this->registered = REG_ALL;
575 FOREACH_MOD(OnPostConnect, (this));
577 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
578 this->server_sa.port(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->GetRealName().c_str());
579 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
580 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
581 // reset the flood penalty (which could have been raised due to things like auto +x)
582 CommandFloodPenalty = 0;
585 void User::InvalidateCache()
587 /* Invalidate cache */
589 cached_fullhost.clear();
590 cached_hostip.clear();
591 cached_makehost.clear();
592 cached_fullrealhost.clear();
595 bool User::ChangeNick(const std::string& newnick, time_t newts)
599 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
603 User* const InUse = ServerInstance->FindNickOnly(newnick);
606 // case change, don't need to check campers
607 // and, if it's identical including case, we can leave right now
608 // We also don't update the nick TS if it's a case change, either
615 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
616 * then we have a potential collide. Check whether someone else is camping on the nick
617 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
618 * camper to their UID, and allow the incoming nick change.
620 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
621 * because the nick is already (rightfully) in use. -- w00t
625 if (InUse->registered != REG_ALL)
627 /* force the camper to their UUID, and ask them to re-send a NICK. */
628 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
629 localuser->OverruleNick();
633 /* No camping, tell the incoming user to stop trying to change nick ;p */
634 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
639 age = newts ? newts : ServerInstance->Time();
642 if (this->registered == REG_ALL)
644 ClientProtocol::Messages::Nick nickmsg(this, newnick);
645 ClientProtocol::Event nickevent(ServerInstance->GetRFCEvents().nick, nickmsg);
646 this->WriteCommonRaw(nickevent, true);
648 const std::string oldnick = nick;
652 ServerInstance->Users->clientlist.erase(oldnick);
653 ServerInstance->Users->clientlist[newnick] = this;
655 if (registered == REG_ALL)
656 FOREACH_MOD(OnUserPostNick, (this,oldnick));
661 void LocalUser::OverruleNick()
664 ClientProtocol::Messages::Nick nickmsg(this, this->uuid);
665 this->Send(ServerInstance->GetRFCEvents().nick, nickmsg);
667 this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
669 // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
670 this->registered &= ~REG_NICK;
671 this->ChangeNick(this->uuid);
674 const std::string& User::GetIPString()
676 if (cachedip.empty())
678 cachedip = client_sa.addr();
679 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
680 if (cachedip[0] == ':')
681 cachedip.insert(cachedip.begin(),1,'0');
687 const std::string& User::GetHost(bool uncloak) const
689 return uncloak ? GetRealHost() : GetDisplayedHost();
692 const std::string& User::GetDisplayedHost() const
694 return displayhost.empty() ? realhost : displayhost;
697 const std::string& User::GetRealHost() const
702 const std::string& User::GetRealName() const
707 irc::sockets::cidr_mask User::GetCIDRMask()
709 unsigned char range = 0;
710 switch (client_sa.family())
713 range = ServerInstance->Config->c_ipv6_range;
716 range = ServerInstance->Config->c_ipv4_range;
719 return irc::sockets::cidr_mask(client_sa, range);
722 bool User::SetClientIP(const std::string& address)
724 irc::sockets::sockaddrs sa;
725 if (!irc::sockets::aptosa(address, client_sa.port(), sa))
728 User::SetClientIP(sa);
732 void User::SetClientIP(const irc::sockets::sockaddrs& sa)
734 const std::string oldip(GetIPString());
735 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
736 this->InvalidateCache();
738 // If the users hostname was their IP then update it.
739 if (GetRealHost() == oldip)
740 ChangeRealHost(GetIPString(), false);
741 if (GetDisplayedHost() == oldip)
742 ChangeDisplayedHost(GetIPString());
745 bool LocalUser::SetClientIP(const std::string& address)
747 irc::sockets::sockaddrs sa;
748 if (!irc::sockets::aptosa(address, client_sa.port(), sa))
751 LocalUser::SetClientIP(sa);
755 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa)
760 ServerInstance->Users->RemoveCloneCounts(this);
761 User::SetClientIP(sa);
762 ServerInstance->Users->AddClone(this);
764 // Recheck the connect class.
765 this->MyClass = NULL;
770 FOREACH_MOD(OnSetUserIP, (this));
773 void LocalUser::Write(const ClientProtocol::SerializedMessage& text)
775 if (!SocketEngine::BoundsCheckFd(&eh))
778 if (ServerInstance->Config->RawLog)
783 std::string::size_type nlpos = text.find_first_of("\r\n", 0, 2);
784 if (nlpos == std::string::npos)
785 nlpos = text.length(); // TODO is this ok, test it
787 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %.*s", uuid.c_str(), (int) nlpos, text.c_str());
790 eh.AddWriteBuf(text);
792 const size_t bytessent = text.length() + 2;
793 ServerInstance->stats.Sent += bytessent;
794 this->bytes_out += bytessent;
798 void LocalUser::Send(ClientProtocol::Event& protoev)
802 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "BUG: LocalUser::Send() called on %s who does not have a serializer!",
803 GetFullRealHost().c_str());
807 // In the most common case a static LocalUser field, sendmsglist, is passed to the event to be
808 // populated. The list is cleared before returning.
809 // To handle re-enters, if sendmsglist is non-empty upon entering the method then a temporary
810 // list is used instead of the static one.
811 if (sendmsglist.empty())
813 Send(protoev, sendmsglist);
818 ClientProtocol::MessageList msglist;
819 Send(protoev, msglist);
823 void LocalUser::Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist)
825 // Modules can personalize the messages sent per user for the event
826 protoev.GetMessagesForUser(this, msglist);
827 for (ClientProtocol::MessageList::const_iterator i = msglist.begin(); i != msglist.end(); ++i)
829 ClientProtocol::Message& curr = **i;
831 FIRST_MOD_RESULT(OnUserWrite, res, (this, curr));
832 if (res != MOD_RES_DENY)
833 Write(serializer->SerializeForUser(this, curr));
837 void User::WriteNumeric(const Numeric::Numeric& numeric)
839 LocalUser* const localuser = IS_LOCAL(this);
843 ModResult MOD_RESULT;
845 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
847 if (MOD_RESULT == MOD_RES_DENY)
850 ClientProtocol::Messages::Numeric numericmsg(numeric, localuser);
851 localuser->Send(ServerInstance->GetRFCEvents().numeric, numericmsg);
854 void User::WriteRemoteNotice(const std::string& text)
856 ServerInstance->PI->SendMessage(this, text, MSG_NOTICE);
859 void LocalUser::WriteRemoteNotice(const std::string& text)
866 class WriteCommonRawHandler : public User::ForEachNeighborHandler
868 ClientProtocol::Event& ev;
870 void Execute(LocalUser* user) CXX11_OVERRIDE
876 WriteCommonRawHandler(ClientProtocol::Event& protoev)
883 void User::WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self)
885 WriteCommonRawHandler handler(protoev);
886 ForEachNeighbor(handler, include_self);
889 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
891 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
892 // and visit all users on those channels. Because two users may share more than one common channel,
893 // we must skip users that we have already visited.
894 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
895 // The global counter is incremented every time we do something for each neighbor of a user. Then,
896 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
897 // skip the member. Otherwise, we set it to the current counter and visit the member.
899 // Ask modules to build a list of exceptions.
900 // Mods may also exclude entire channels by erasing them from include_chans.
901 IncludeChanList include_chans(chans.begin(), chans.end());
902 std::map<User*, bool> exceptions;
903 exceptions[this] = include_self;
904 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
906 // Get next id, guaranteed to differ from the already_sent field of all users
907 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
909 // Handle exceptions first
910 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
912 LocalUser* curr = IS_LOCAL(i->first);
915 // Mark as visited to ensure we won't visit again if there is a common channel
916 curr->already_sent = newid;
917 // Always treat quitting users as excluded
918 if ((i->second) && (!curr->quitting))
919 handler.Execute(curr);
923 // Now consider the real neighbors
924 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
926 Channel* chan = (*i)->chan;
927 const Channel::MemberMap& userlist = chan->GetUsers();
928 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
930 LocalUser* curr = IS_LOCAL(j->first);
931 // User not yet visited?
932 if ((curr) && (curr->already_sent != newid))
934 // Mark as visited and execute function
935 curr->already_sent = newid;
936 handler.Execute(curr);
942 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
944 WriteNumeric(numeric);
947 /* return 0 or 1 depending if users u and u2 share one or more common channels
948 * (used by QUIT, NICK etc which arent channel specific notices)
950 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
951 * the first users channels then the second users channels within the outer loop,
952 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
953 * all possible iterations). However this new function instead checks against the
954 * channel's userlist in the inner loop which is a std::map<User*,User*>
955 * and saves us time as we already know what pointer value we are after.
956 * Don't quote me on the maths as i am not a mathematician or computer scientist,
957 * but i believe this algorithm is now x+(log y) maximum iterations instead.
959 bool User::SharesChannelWith(User *other)
962 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
964 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
965 * by replacing it with a map::find which *should* be more efficient
967 if ((*i)->chan->HasUser(other))
973 bool User::ChangeRealName(const std::string& real)
975 if (!this->realname.compare(real))
980 ModResult MOD_RESULT;
981 FIRST_MOD_RESULT(OnPreChangeRealName, MOD_RESULT, (IS_LOCAL(this), real));
982 if (MOD_RESULT == MOD_RES_DENY)
984 FOREACH_MOD(OnChangeRealName, (this, real));
986 this->realname.assign(real, 0, ServerInstance->Config->Limits.MaxReal);
991 bool User::ChangeDisplayedHost(const std::string& shost)
993 if (GetDisplayedHost() == shost)
996 LocalUser* luser = IS_LOCAL(this);
999 ModResult MOD_RESULT;
1000 FIRST_MOD_RESULT(OnPreChangeHost, MOD_RESULT, (luser, shost));
1001 if (MOD_RESULT == MOD_RES_DENY)
1005 FOREACH_MOD(OnChangeHost, (this,shost));
1007 if (realhost == shost)
1008 this->displayhost.clear();
1010 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1012 this->InvalidateCache();
1014 if (IS_LOCAL(this) && this->registered != REG_NONE)
1015 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1020 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1022 // If the real host is the new host and we are not resetting the
1023 // display host then we have nothing to do.
1024 const bool changehost = (realhost != host);
1025 if (!changehost && !resetdisplay)
1028 // If the displayhost is not set and we are not resetting it then
1029 // we need to copy it to the displayhost field.
1030 if (displayhost.empty() && !resetdisplay)
1031 displayhost = realhost;
1033 // If the displayhost is the new host or we are resetting it then
1034 // we clear its contents to save memory.
1035 else if (displayhost == host || resetdisplay)
1036 displayhost.clear();
1038 // If we are just resetting the display host then we don't need to
1039 // do anything else.
1044 this->InvalidateCache();
1047 bool User::ChangeIdent(const std::string& newident)
1049 if (this->ident == newident)
1052 FOREACH_MOD(OnChangeIdent, (this,newident));
1054 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1055 this->InvalidateCache();
1061 * Sets a user's connection class.
1062 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1063 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1064 * then their ip will be taken as 'priority' anyway, so for example,
1065 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1067 void LocalUser::SetClass(const std::string &explicit_name)
1069 ConnectClass *found = NULL;
1071 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1073 if (!explicit_name.empty())
1075 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1077 ConnectClass* c = *i;
1079 if (explicit_name == c->name)
1081 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1088 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1090 ConnectClass* c = *i;
1091 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1093 ModResult MOD_RESULT;
1094 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1095 if (MOD_RESULT == MOD_RES_DENY)
1097 if (MOD_RESULT == MOD_RES_ALLOW)
1099 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1104 if (c->type == CC_NAMED)
1107 bool regdone = (registered != REG_NONE);
1108 if (c->config->getBool("registered", regdone) != regdone)
1111 /* check if host matches.. */
1112 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1113 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1115 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1120 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1121 * because we should attempt to find another class if this one doesn't match us. -- w00t
1123 if (c->limit && (c->GetReferenceCount() >= c->limit))
1125 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1129 /* if it requires a port ... */
1130 if (!c->ports.empty())
1132 /* and our port doesn't match, fail. */
1133 if (!c->ports.count(this->server_sa.port()))
1135 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1140 if (regdone && !c->config->getString("password").empty())
1142 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1144 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1149 /* we stop at the first class that meets ALL critera. */
1156 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1164 void User::PurgeEmptyChannels()
1166 // firstly decrement the count on each channel
1167 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1169 Channel* c = (*i)->chan;
1175 void User::WriteNotice(const std::string& text)
1177 LocalUser* const localuser = IS_LOCAL(this);
1181 ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, localuser, text, MSG_NOTICE);
1182 localuser->Send(ServerInstance->GetRFCEvents().privmsg, msg);
1185 const std::string& FakeUser::GetFullHost()
1187 if (!ServerInstance->Config->HideServer.empty())
1188 return ServerInstance->Config->HideServer;
1189 return server->GetName();
1192 const std::string& FakeUser::GetFullRealHost()
1194 if (!ServerInstance->Config->HideServer.empty())
1195 return ServerInstance->Config->HideServer;
1196 return server->GetName();
1199 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1204 , registration_timeout(0)
1210 , penaltythreshold(0)
1217 , resolvehostnames(true)
1221 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1228 // Connect classes can inherit from each other but this is problematic for modules which can't use
1229 // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1230 // well as the parent class.
1231 ConfigItems* items = NULL;
1232 config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1234 const ConfigItems& parentkeys = parent.config->getItems();
1235 for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1237 // The class name and parent name are not inherited
1238 if (stdalgo::string::equalsci(piter->first, "name") || stdalgo::string::equalsci(piter->first, "parent"))
1241 // Store the item in the config tag. If this item also
1242 // exists in the child it will be overwritten.
1243 (*items)[piter->first] = piter->second;
1246 const ConfigItems& childkeys = tag->getItems();
1247 for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1249 // This will overwrite the parent value if present.
1250 (*items)[citer->first] = citer->second;
1254 void ConnectClass::Update(const ConnectClass* src)
1256 config = src->config;
1258 fakelag = src->fakelag;
1260 registration_timeout = src->registration_timeout;
1262 pingtime = src->pingtime;
1263 softsendqmax = src->softsendqmax;
1264 hardsendqmax = src->hardsendqmax;
1265 recvqmax = src->recvqmax;
1266 penaltythreshold = src->penaltythreshold;
1267 commandrate = src->commandrate;
1268 maxlocal = src->maxlocal;
1269 maxglobal = src->maxglobal;
1270 maxconnwarn = src->maxconnwarn;
1271 maxchans = src->maxchans;
1273 resolvehostnames = src->resolvehostnames;