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);
119 const std::string& User::MakeHost()
121 if (!this->cached_makehost.empty())
122 return this->cached_makehost;
124 // XXX: Is there really a need to cache this?
125 this->cached_makehost = ident + "@" + GetRealHost();
126 return this->cached_makehost;
129 const std::string& User::MakeHostIP()
131 if (!this->cached_hostip.empty())
132 return this->cached_hostip;
134 // XXX: Is there really a need to cache this?
135 this->cached_hostip = ident + "@" + this->GetIPString();
136 return this->cached_hostip;
139 const std::string& User::GetFullHost()
141 if (!this->cached_fullhost.empty())
142 return this->cached_fullhost;
144 // XXX: Is there really a need to cache this?
145 this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
146 return this->cached_fullhost;
149 const std::string& User::GetFullRealHost()
151 if (!this->cached_fullrealhost.empty())
152 return this->cached_fullrealhost;
154 // XXX: Is there really a need to cache this?
155 this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
156 return this->cached_fullrealhost;
159 bool User::HasModePermission(const ModeHandler* mh) const
164 bool LocalUser::HasModePermission(const ModeHandler* mh) const
169 const unsigned char mode = mh->GetModeChar();
170 if (mode < 'A' || mode > ('A' + 64)) return false;
172 return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
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.
182 bool User::HasPermission(const std::string&)
187 bool LocalUser::HasPermission(const std::string &command)
189 // are they even an oper at all?
195 return oper->AllowedOperCommands.Contains(command);
198 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
203 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
208 this->WriteNotice("You are not an oper");
212 if (oper->AllowedPrivs.Contains(privstr))
216 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
221 void UserIOHandler::OnDataReady()
226 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
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());
234 unsigned long sendqmax = ULONG_MAX;
235 if (!user->HasPrivPermission("users/flood/increased-buffers"))
236 sendqmax = user->MyClass->GetSendqSoftMax();
238 unsigned long penaltymax = ULONG_MAX;
239 if (!user->HasPrivPermission("users/flood/no-fakelag"))
240 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
242 // The cleaned message sent by the user or empty if not found yet.
245 // The position of the most \n character or npos if not found yet.
246 std::string::size_type eolpos;
248 // The position within the recvq of the current character.
249 std::string::size_type qpos;
251 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
253 // Check the newly received data for an EOL.
254 eolpos = recvq.find('\n', checked_until);
255 if (eolpos == std::string::npos)
257 checked_until = recvq.length();
261 // We've found a line! Clean it up and move it to the line buffer.
262 line.reserve(eolpos);
263 for (qpos = 0; qpos < eolpos; ++qpos)
265 char c = recvq[qpos];
278 // just found a newline. Terminate the string, and pull it out of recvq
279 recvq.erase(0, eolpos + 1);
282 // TODO should this be moved to when it was inserted in recvq?
283 ServerInstance->stats.Recv += qpos;
284 user->bytes_in += qpos;
287 ServerInstance->Parser.ProcessBuffer(user, line);
291 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
295 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
296 ServerInstance->Users->QuitUser(user, "Excess Flood");
299 void UserIOHandler::AddWriteBuf(const std::string &data)
301 if (user->quitting_sendq)
303 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
304 !user->HasPrivPermission("users/flood/increased-buffers"))
306 user->quitting_sendq = true;
307 ServerInstance->GlobalCulls.AddSQItem(user);
311 // We still want to append data to the sendq of a quitting user,
312 // e.g. their ERROR message that says 'closing link'
317 bool UserIOHandler::OnSetEndPoint(const irc::sockets::sockaddrs& server, const irc::sockets::sockaddrs& client)
319 memcpy(&user->server_sa, &server, sizeof(irc::sockets::sockaddrs));
320 user->SetClientIP(client);
321 return !user->quitting;
324 void UserIOHandler::OnError(BufferedSocketError)
326 ServerInstance->Users->QuitUser(user, getError());
329 CullResult User::cull()
332 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
334 if (client_sa.family() != AF_UNSPEC)
335 ServerInstance->Users->RemoveCloneCounts(this);
337 return Extensible::cull();
340 CullResult LocalUser::cull()
346 CullResult FakeUser::cull()
348 // Fake users don't quit, they just get culled.
350 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
354 void User::Oper(OperInfo* info)
356 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
359 if (this->IsModeSet(opermh))
361 this->SetMode(opermh, true);
365 LocalUser* localuser = IS_LOCAL(this);
368 Modes::ChangeList changelist;
369 changelist.push_add(opermh);
370 ClientProtocol::Events::Mode modemsg(ServerInstance->FakeClient, NULL, localuser, changelist);
371 localuser->Send(modemsg);
374 FOREACH_MOD(OnOper, (this, info->name));
376 std::string opername;
377 if (info->oper_block)
378 opername = info->oper_block->getString("name");
380 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
381 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
382 this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
384 ServerInstance->Users->all_opers.push_back(this);
386 // Expand permissions from config for faster lookup
390 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
393 void OperInfo::init()
395 AllowedOperCommands.Clear();
396 AllowedPrivs.Clear();
397 AllowedUserModes.reset();
398 AllowedChanModes.reset();
399 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
401 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
403 ConfigTag* tag = *iter;
405 AllowedOperCommands.AddList(tag->getString("commands"));
406 AllowedPrivs.AddList(tag->getString("privs"));
408 std::string modes = tag->getString("usermodes");
409 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
413 this->AllowedUserModes.set();
415 else if (*c >= 'A' && *c <= 'z')
417 this->AllowedUserModes[*c - 'A'] = true;
421 modes = tag->getString("chanmodes");
422 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
426 this->AllowedChanModes.set();
428 else if (*c >= 'A' && *c <= 'z')
430 this->AllowedChanModes[*c - 'A'] = true;
442 * unset their oper type (what IS_OPER checks).
443 * note, order is important - this must come before modes as -o attempts
444 * to call UnOper. -- w00t
449 /* Remove all oper only modes from the user when the deoper - Bug #466*/
450 Modes::ChangeList changelist;
451 const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
452 for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
454 ModeHandler* mh = i->second;
456 changelist.push_remove(mh);
459 ServerInstance->Modes->Process(this, NULL, this, changelist);
461 // Remove the user from the oper list
462 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
464 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
466 this->SetMode(opermh, false);
467 FOREACH_MOD(OnPostDeoper, (this));
471 * Check class restrictions
473 void LocalUser::CheckClass(bool clone_count)
475 ConnectClass* a = this->MyClass;
479 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
482 else if (a->type == CC_DENY)
484 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
487 else if (clone_count)
489 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
490 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
492 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
494 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
497 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
499 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
501 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
506 this->nextping = ServerInstance->Time() + a->GetPingTime();
509 bool LocalUser::CheckLines(bool doZline)
511 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
515 for (int n = 0; check[n]; ++n)
517 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
530 void LocalUser::FullConnect()
532 ServerInstance->stats.Connects++;
533 this->idle_lastmsg = ServerInstance->Time();
536 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
537 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
538 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
539 * Don't remove this! -- w00t
550 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
551 * for a user that doesn't exist yet.
553 FOREACH_MOD(OnUserConnect, (this));
556 if (ServerInstance->Users->unregistered_count)
557 ServerInstance->Users->unregistered_count--;
558 this->registered = REG_ALL;
560 FOREACH_MOD(OnPostConnect, (this));
562 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
563 this->server_sa.port(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->GetRealName().c_str());
564 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
565 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
566 // reset the flood penalty (which could have been raised due to things like auto +x)
567 CommandFloodPenalty = 0;
570 void User::InvalidateCache()
572 /* Invalidate cache */
574 cached_fullhost.clear();
575 cached_hostip.clear();
576 cached_makehost.clear();
577 cached_fullrealhost.clear();
580 bool User::ChangeNick(const std::string& newnick, time_t newts)
584 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
588 User* const InUse = ServerInstance->FindNickOnly(newnick);
591 // case change, don't need to check campers
592 // and, if it's identical including case, we can leave right now
593 // We also don't update the nick TS if it's a case change, either
600 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
601 * then we have a potential collide. Check whether someone else is camping on the nick
602 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
603 * camper to their UID, and allow the incoming nick change.
605 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
606 * because the nick is already (rightfully) in use. -- w00t
610 if (InUse->registered != REG_ALL)
612 /* force the camper to their UUID, and ask them to re-send a NICK. */
613 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
614 localuser->OverruleNick();
618 /* No camping, tell the incoming user to stop trying to change nick ;p */
619 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
624 age = newts ? newts : ServerInstance->Time();
627 if (this->registered == REG_ALL)
629 ClientProtocol::Messages::Nick nickmsg(this, newnick);
630 ClientProtocol::Event nickevent(ServerInstance->GetRFCEvents().nick, nickmsg);
631 this->WriteCommonRaw(nickevent, true);
633 const std::string oldnick = nick;
637 ServerInstance->Users->clientlist.erase(oldnick);
638 ServerInstance->Users->clientlist[newnick] = this;
640 if (registered == REG_ALL)
641 FOREACH_MOD(OnUserPostNick, (this,oldnick));
646 void LocalUser::OverruleNick()
649 ClientProtocol::Messages::Nick nickmsg(this, this->uuid);
650 this->Send(ServerInstance->GetRFCEvents().nick, nickmsg);
652 this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
654 // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
655 this->registered &= ~REG_NICK;
656 this->ChangeNick(this->uuid);
659 const std::string& User::GetIPString()
661 if (cachedip.empty())
663 cachedip = client_sa.addr();
664 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
665 if (cachedip[0] == ':')
666 cachedip.insert(cachedip.begin(),1,'0');
672 const std::string& User::GetHost(bool uncloak) const
674 return uncloak ? GetRealHost() : GetDisplayedHost();
677 const std::string& User::GetDisplayedHost() const
679 return displayhost.empty() ? realhost : displayhost;
682 const std::string& User::GetRealHost() const
687 const std::string& User::GetRealName() const
692 irc::sockets::cidr_mask User::GetCIDRMask()
694 unsigned char range = 0;
695 switch (client_sa.family())
698 range = ServerInstance->Config->c_ipv6_range;
701 range = ServerInstance->Config->c_ipv4_range;
704 return irc::sockets::cidr_mask(client_sa, range);
707 bool User::SetClientIP(const std::string& address)
709 irc::sockets::sockaddrs sa;
710 if (!irc::sockets::aptosa(address, client_sa.port(), sa))
713 User::SetClientIP(sa);
717 void User::SetClientIP(const irc::sockets::sockaddrs& sa)
719 const std::string oldip(GetIPString());
720 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
721 this->InvalidateCache();
723 // If the users hostname was their IP then update it.
724 if (GetRealHost() == oldip)
725 ChangeRealHost(GetIPString(), false);
726 if (GetDisplayedHost() == oldip)
727 ChangeDisplayedHost(GetIPString());
730 bool LocalUser::SetClientIP(const std::string& address)
732 irc::sockets::sockaddrs sa;
733 if (!irc::sockets::aptosa(address, client_sa.port(), sa))
736 LocalUser::SetClientIP(sa);
740 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa)
745 ServerInstance->Users->RemoveCloneCounts(this);
747 User::SetClientIP(sa);
749 FOREACH_MOD(OnSetUserIP, (this));
751 ServerInstance->Users->AddClone(this);
753 // Recheck the connect class.
754 this->MyClass = NULL;
759 void LocalUser::Write(const ClientProtocol::SerializedMessage& text)
761 if (!SocketEngine::BoundsCheckFd(&eh))
764 if (ServerInstance->Config->RawLog)
769 std::string::size_type nlpos = text.find_first_of("\r\n", 0, 2);
770 if (nlpos == std::string::npos)
771 nlpos = text.length(); // TODO is this ok, test it
773 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %.*s", uuid.c_str(), (int) nlpos, text.c_str());
776 eh.AddWriteBuf(text);
778 const size_t bytessent = text.length() + 2;
779 ServerInstance->stats.Sent += bytessent;
780 this->bytes_out += bytessent;
784 void LocalUser::Send(ClientProtocol::Event& protoev)
788 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "BUG: LocalUser::Send() called on %s who does not have a serializer!",
789 GetFullRealHost().c_str());
793 // In the most common case a static LocalUser field, sendmsglist, is passed to the event to be
794 // populated. The list is cleared before returning.
795 // To handle re-enters, if sendmsglist is non-empty upon entering the method then a temporary
796 // list is used instead of the static one.
797 if (sendmsglist.empty())
799 Send(protoev, sendmsglist);
804 ClientProtocol::MessageList msglist;
805 Send(protoev, msglist);
809 void LocalUser::Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist)
811 // Modules can personalize the messages sent per user for the event
812 protoev.GetMessagesForUser(this, msglist);
813 for (ClientProtocol::MessageList::const_iterator i = msglist.begin(); i != msglist.end(); ++i)
815 ClientProtocol::Message& curr = **i;
817 FIRST_MOD_RESULT(OnUserWrite, res, (this, curr));
818 if (res != MOD_RES_DENY)
819 Write(serializer->SerializeForUser(this, curr));
823 void User::WriteNumeric(const Numeric::Numeric& numeric)
825 LocalUser* const localuser = IS_LOCAL(this);
829 ModResult MOD_RESULT;
831 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
833 if (MOD_RESULT == MOD_RES_DENY)
836 ClientProtocol::Messages::Numeric numericmsg(numeric, localuser);
837 localuser->Send(ServerInstance->GetRFCEvents().numeric, numericmsg);
840 void User::WriteRemoteNotice(const std::string& text)
842 ServerInstance->PI->SendUserNotice(this, text);
845 void LocalUser::WriteRemoteNotice(const std::string& text)
852 class WriteCommonRawHandler : public User::ForEachNeighborHandler
854 ClientProtocol::Event& ev;
856 void Execute(LocalUser* user) CXX11_OVERRIDE
862 WriteCommonRawHandler(ClientProtocol::Event& protoev)
869 void User::WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self)
871 WriteCommonRawHandler handler(protoev);
872 ForEachNeighbor(handler, include_self);
875 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
877 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
878 // and visit all users on those channels. Because two users may share more than one common channel,
879 // we must skip users that we have already visited.
880 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
881 // The global counter is incremented every time we do something for each neighbor of a user. Then,
882 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
883 // skip the member. Otherwise, we set it to the current counter and visit the member.
885 // Ask modules to build a list of exceptions.
886 // Mods may also exclude entire channels by erasing them from include_chans.
887 IncludeChanList include_chans(chans.begin(), chans.end());
888 std::map<User*, bool> exceptions;
889 exceptions[this] = include_self;
890 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
892 // Get next id, guaranteed to differ from the already_sent field of all users
893 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
895 // Handle exceptions first
896 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
898 LocalUser* curr = IS_LOCAL(i->first);
901 // Mark as visited to ensure we won't visit again if there is a common channel
902 curr->already_sent = newid;
903 // Always treat quitting users as excluded
904 if ((i->second) && (!curr->quitting))
905 handler.Execute(curr);
909 // Now consider the real neighbors
910 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
912 Channel* chan = (*i)->chan;
913 const Channel::MemberMap& userlist = chan->GetUsers();
914 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
916 LocalUser* curr = IS_LOCAL(j->first);
917 // User not yet visited?
918 if ((curr) && (curr->already_sent != newid))
920 // Mark as visited and execute function
921 curr->already_sent = newid;
922 handler.Execute(curr);
928 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
930 WriteNumeric(numeric);
933 /* return 0 or 1 depending if users u and u2 share one or more common channels
934 * (used by QUIT, NICK etc which arent channel specific notices)
936 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
937 * the first users channels then the second users channels within the outer loop,
938 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
939 * all possible iterations). However this new function instead checks against the
940 * channel's userlist in the inner loop which is a std::map<User*,User*>
941 * and saves us time as we already know what pointer value we are after.
942 * Don't quote me on the maths as i am not a mathematician or computer scientist,
943 * but i believe this algorithm is now x+(log y) maximum iterations instead.
945 bool User::SharesChannelWith(User *other)
948 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
950 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
951 * by replacing it with a map::find which *should* be more efficient
953 if ((*i)->chan->HasUser(other))
959 bool User::ChangeRealName(const std::string& real)
961 if (!this->realname.compare(real))
966 ModResult MOD_RESULT;
967 FIRST_MOD_RESULT(OnPreChangeRealName, MOD_RESULT, (IS_LOCAL(this), real));
968 if (MOD_RESULT == MOD_RES_DENY)
970 FOREACH_MOD(OnChangeRealName, (this, real));
972 this->realname.assign(real, 0, ServerInstance->Config->Limits.MaxReal);
977 bool User::ChangeDisplayedHost(const std::string& shost)
979 if (GetDisplayedHost() == shost)
982 LocalUser* luser = IS_LOCAL(this);
985 ModResult MOD_RESULT;
986 FIRST_MOD_RESULT(OnPreChangeHost, MOD_RESULT, (luser, shost));
987 if (MOD_RESULT == MOD_RES_DENY)
991 FOREACH_MOD(OnChangeHost, (this,shost));
993 if (realhost == shost)
994 this->displayhost.clear();
996 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
998 this->InvalidateCache();
1000 if (IS_LOCAL(this) && this->registered != REG_NONE)
1001 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1006 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1008 // If the real host is the new host and we are not resetting the
1009 // display host then we have nothing to do.
1010 const bool changehost = (realhost != host);
1011 if (!changehost && !resetdisplay)
1014 // If the displayhost is not set and we are not resetting it then
1015 // we need to copy it to the displayhost field.
1016 if (displayhost.empty() && !resetdisplay)
1017 displayhost = realhost;
1019 // If the displayhost is the new host or we are resetting it then
1020 // we clear its contents to save memory.
1021 else if (displayhost == host || resetdisplay)
1022 displayhost.clear();
1024 // If we are just resetting the display host then we don't need to
1025 // do anything else.
1030 this->InvalidateCache();
1033 bool User::ChangeIdent(const std::string& newident)
1035 if (this->ident == newident)
1038 FOREACH_MOD(OnChangeIdent, (this,newident));
1040 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1041 this->InvalidateCache();
1047 * Sets a user's connection class.
1048 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1049 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1050 * then their ip will be taken as 'priority' anyway, so for example,
1051 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1053 void LocalUser::SetClass(const std::string &explicit_name)
1055 ConnectClass *found = NULL;
1057 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1059 if (!explicit_name.empty())
1061 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1063 ConnectClass* c = *i;
1065 if (explicit_name == c->name)
1067 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1074 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1076 ConnectClass* c = *i;
1077 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1079 ModResult MOD_RESULT;
1080 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1081 if (MOD_RESULT == MOD_RES_DENY)
1083 if (MOD_RESULT == MOD_RES_ALLOW)
1085 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1090 if (c->type == CC_NAMED)
1093 bool regdone = (registered != REG_NONE);
1094 if (c->config->getBool("registered", regdone) != regdone)
1097 /* check if host matches.. */
1098 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1099 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1101 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1106 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1107 * because we should attempt to find another class if this one doesn't match us. -- w00t
1109 if (c->limit && (c->GetReferenceCount() >= c->limit))
1111 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1115 /* if it requires a port ... */
1116 if (!c->ports.empty())
1118 /* and our port doesn't match, fail. */
1119 if (!c->ports.count(this->server_sa.port()))
1121 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1126 if (regdone && !c->config->getString("password").empty())
1128 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1130 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1135 /* we stop at the first class that meets ALL critera. */
1142 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1150 void User::PurgeEmptyChannels()
1152 // firstly decrement the count on each channel
1153 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1155 Channel* c = (*i)->chan;
1161 void User::WriteNotice(const std::string& text)
1163 LocalUser* const localuser = IS_LOCAL(this);
1167 ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, localuser, text, MSG_NOTICE);
1168 localuser->Send(ServerInstance->GetRFCEvents().privmsg, msg);
1171 const std::string& FakeUser::GetFullHost()
1173 if (!ServerInstance->Config->HideServer.empty())
1174 return ServerInstance->Config->HideServer;
1175 return server->GetName();
1178 const std::string& FakeUser::GetFullRealHost()
1180 if (!ServerInstance->Config->HideServer.empty())
1181 return ServerInstance->Config->HideServer;
1182 return server->GetName();
1185 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1186 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1187 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1188 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1189 limit(0), resolvehostnames(true)
1193 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1200 // Connect classes can inherit from each other but this is problematic for modules which can't use
1201 // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1202 // well as the parent class.
1203 ConfigItems* items = NULL;
1204 config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1206 const ConfigItems& parentkeys = parent.config->getItems();
1207 for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1209 // The class name and parent name are not inherited
1210 if (stdalgo::string::equalsci(piter->first, "name") || stdalgo::string::equalsci(piter->first, "parent"))
1213 // Store the item in the config tag. If this item also
1214 // exists in the child it will be overwritten.
1215 (*items)[piter->first] = piter->second;
1218 const ConfigItems& childkeys = tag->getItems();
1219 for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1221 // This will overwrite the parent value if present.
1222 (*items)[citer->first] = citer->second;
1226 void ConnectClass::Update(const ConnectClass* src)
1228 config = src->config;
1230 fakelag = src->fakelag;
1232 registration_timeout = src->registration_timeout;
1234 pingtime = src->pingtime;
1235 softsendqmax = src->softsendqmax;
1236 hardsendqmax = src->hardsendqmax;
1237 recvqmax = src->recvqmax;
1238 penaltythreshold = src->penaltythreshold;
1239 commandrate = src->commandrate;
1240 maxlocal = src->maxlocal;
1241 maxglobal = src->maxglobal;
1242 maxconnwarn = src->maxconnwarn;
1243 maxchans = src->maxchans;
1245 resolvehostnames = src->resolvehostnames;