2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
5 * Copyright (C) 2018 systocrat <systocrat@outlook.com>
6 * Copyright (C) 2018 Dylan Frank <b00mx0r@aureus.pw>
7 * Copyright (C) 2013, 2016-2020 Sadie Powell <sadie@witchery.services>
8 * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
9 * Copyright (C) 2013 ChrisTX <xpipe@hotmail.de>
10 * Copyright (C) 2013 Adam <Adam@anope.org>
11 * Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
12 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
13 * Copyright (C) 2012 DjSlash <djslash@djslash.org>
14 * Copyright (C) 2011 jackmcbarn <jackmcbarn@inspircd.org>
15 * Copyright (C) 2009-2011 Daniel De Graaf <danieldg@inspircd.org>
16 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
17 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
18 * Copyright (C) 2008 John Brooks <special@inspircd.org>
19 * Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
20 * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
21 * Copyright (C) 2006-2009 Craig Edwards <brain@inspircd.org>
23 * This file is part of InspIRCd. InspIRCd is free software: you can
24 * redistribute it and/or modify it under the terms of the GNU General Public
25 * License as published by the Free Software Foundation, version 2.
27 * This program is distributed in the hope that it will be useful, but WITHOUT
28 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
29 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
40 ClientProtocol::MessageList LocalUser::sendmsglist;
42 bool User::IsNoticeMaskSet(unsigned char sm)
46 return (snomasks[sm-65]);
49 bool User::IsModeSet(unsigned char m) const
51 ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
52 return (mh && modes[mh->GetId()]);
55 std::string User::GetModeLetters(bool includeparams) const
57 std::string ret(1, '+');
60 for (unsigned char i = 'A'; i <= 'z'; i++)
62 const ModeHandler* const mh = ServerInstance->Modes.FindMode(i, MODETYPE_USER);
63 if ((!mh) || (!IsModeSet(mh)))
66 ret.push_back(mh->GetModeChar());
67 if ((includeparams) && (mh->NeedsParam(true)))
69 const std::string val = mh->GetUserParameter(this);
71 params.append(1, ' ').append(val);
79 User::User(const std::string& uid, Server* srv, UserType type)
80 : age(ServerInstance->Time())
84 , registered(REG_NONE)
88 client_sa.sa.sa_family = AF_UNSPEC;
90 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
93 ServerInstance->Users.all_ulines.push_back(this);
95 // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
96 if (type != USERTYPE_SERVER)
98 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
99 throw CoreException("Duplicate UUID in User constructor: " + uuid);
103 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
104 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL)
111 , quitting_sendq(false)
116 , CommandFloodPenalty(0)
119 signon = ServerInstance->Time();
120 // The user's default nick is their UUID
124 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
125 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
126 ChangeRealHost(GetIPString(), true);
129 LocalUser::LocalUser(int myfd, const std::string& uid, Serializable::Data& data)
130 : User(uid, ServerInstance->FakeClient->server, USERTYPE_LOCAL)
142 const std::string& User::MakeHost()
144 if (!this->cached_makehost.empty())
145 return this->cached_makehost;
147 this->cached_makehost = ident + "@" + GetRealHost();
148 return this->cached_makehost;
151 const std::string& User::MakeHostIP()
153 if (!this->cached_hostip.empty())
154 return this->cached_hostip;
156 this->cached_hostip = ident + "@" + this->GetIPString();
157 return this->cached_hostip;
160 const std::string& User::GetFullHost()
162 if (!this->cached_fullhost.empty())
163 return this->cached_fullhost;
165 this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
166 return this->cached_fullhost;
169 const std::string& User::GetFullRealHost()
171 if (!this->cached_fullrealhost.empty())
172 return this->cached_fullrealhost;
174 this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
175 return this->cached_fullrealhost;
178 bool User::HasModePermission(const ModeHandler* mh) const
183 bool LocalUser::HasModePermission(const ModeHandler* mh) const
188 const unsigned char mode = mh->GetModeChar();
189 if (!ModeParser::IsModeChar(mode))
192 return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
196 * users on remote servers can completely bypass all permissions based checks.
197 * This prevents desyncs when one server has different type/class tags to another.
198 * That having been said, this does open things up to the possibility of source changes
199 * allowing remote kills, etc - but if they have access to the src, they most likely have
200 * access to the conf - so it's an end to a means either way.
202 bool User::HasCommandPermission(const std::string&)
207 bool LocalUser::HasCommandPermission(const std::string& command)
209 // are they even an oper at all?
215 return oper->AllowedOperCommands.Contains(command);
218 bool User::HasPrivPermission(const std::string& privstr)
223 bool LocalUser::HasPrivPermission(const std::string& privstr)
228 return oper->AllowedPrivs.Contains(privstr);
231 bool User::HasSnomaskPermission(char chr) const
236 bool LocalUser::HasSnomaskPermission(char chr) const
238 if (!this->IsOper() || !ModeParser::IsModeChar(chr))
241 return this->oper->AllowedSnomasks[chr - 'A'];
244 void UserIOHandler::OnDataReady()
249 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
251 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
252 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
253 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
257 unsigned long sendqmax = ULONG_MAX;
258 if (!user->HasPrivPermission("users/flood/increased-buffers"))
259 sendqmax = user->MyClass->GetSendqSoftMax();
261 unsigned long penaltymax = ULONG_MAX;
262 if (!user->HasPrivPermission("users/flood/no-fakelag"))
263 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
265 // The cleaned message sent by the user or empty if not found yet.
268 // The position of the most \n character or npos if not found yet.
269 std::string::size_type eolpos;
271 // The position within the recvq of the current character.
272 std::string::size_type qpos;
274 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
276 // Check the newly received data for an EOL.
277 eolpos = recvq.find('\n', checked_until);
278 if (eolpos == std::string::npos)
280 checked_until = recvq.length();
284 // We've found a line! Clean it up and move it to the line buffer.
285 line.reserve(eolpos);
286 for (qpos = 0; qpos < eolpos; ++qpos)
288 char c = recvq[qpos];
301 // just found a newline. Terminate the string, and pull it out of recvq
302 recvq.erase(0, eolpos + 1);
305 // TODO should this be moved to when it was inserted in recvq?
306 ServerInstance->stats.Recv += qpos;
307 user->bytes_in += qpos;
310 ServerInstance->Parser.ProcessBuffer(user, line);
314 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
318 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
319 ServerInstance->Users->QuitUser(user, "Excess Flood");
322 void UserIOHandler::AddWriteBuf(const std::string &data)
324 if (user->quitting_sendq)
326 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
327 !user->HasPrivPermission("users/flood/increased-buffers"))
329 user->quitting_sendq = true;
330 ServerInstance->GlobalCulls.AddSQItem(user);
334 // We still want to append data to the sendq of a quitting user,
335 // e.g. their ERROR message that says 'closing link'
340 void UserIOHandler::SwapInternals(UserIOHandler& other)
342 StreamSocket::SwapInternals(other);
343 std::swap(checked_until, other.checked_until);
346 bool UserIOHandler::OnSetEndPoint(const irc::sockets::sockaddrs& server, const irc::sockets::sockaddrs& client)
348 memcpy(&user->server_sa, &server, sizeof(irc::sockets::sockaddrs));
349 user->SetClientIP(client);
350 return !user->quitting;
353 void UserIOHandler::OnError(BufferedSocketError sockerr)
356 FIRST_MOD_RESULT(OnConnectionFail, res, (user, sockerr));
357 if (res != MOD_RES_ALLOW)
358 ServerInstance->Users->QuitUser(user, getError());
361 CullResult User::cull()
364 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
366 if (client_sa.family() != AF_UNSPEC)
367 ServerInstance->Users->RemoveCloneCounts(this);
369 if (server->IsULine())
370 stdalgo::erase(ServerInstance->Users->all_ulines, this);
372 return Extensible::cull();
375 CullResult LocalUser::cull()
381 CullResult FakeUser::cull()
383 // Fake users don't quit, they just get culled.
385 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
389 void User::Oper(OperInfo* info)
391 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
394 if (this->IsModeSet(opermh))
396 this->SetMode(opermh, true);
400 LocalUser* localuser = IS_LOCAL(this);
403 Modes::ChangeList changelist;
404 changelist.push_add(opermh);
405 ClientProtocol::Events::Mode modemsg(ServerInstance->FakeClient, NULL, localuser, changelist);
406 localuser->Send(modemsg);
409 FOREACH_MOD(OnOper, (this, info->name));
411 std::string opername;
412 if (info->oper_block)
413 opername = info->oper_block->getString("name");
415 ServerInstance->SNO->WriteToSnoMask('o', "%s (%s@%s) is now a server operator of type %s (using oper '%s')",
416 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
417 this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
419 ServerInstance->Users->all_opers.push_back(this);
421 // Expand permissions from config for faster lookup
425 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
428 void OperInfo::init()
430 AllowedOperCommands.Clear();
431 AllowedPrivs.Clear();
432 AllowedUserModes.reset();
433 AllowedChanModes.reset();
434 AllowedSnomasks.reset();
435 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
437 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
439 ConfigTag* tag = *iter;
441 AllowedOperCommands.AddList(tag->getString("commands"));
442 AllowedPrivs.AddList(tag->getString("privs"));
444 const std::string umodes = tag->getString("usermodes");
445 for (std::string::const_iterator c = umodes.begin(); c != umodes.end(); ++c)
447 const char& chr = *c;
449 this->AllowedUserModes.set();
450 else if (ModeParser::IsModeChar(chr))
451 this->AllowedUserModes[chr - 'A'] = true;
454 const std::string cmodes = tag->getString("chanmodes");
455 for (std::string::const_iterator c = cmodes.begin(); c != cmodes.end(); ++c)
457 const char& chr = *c;
459 this->AllowedChanModes.set();
460 else if (ModeParser::IsModeChar(chr))
461 this->AllowedChanModes[chr - 'A'] = true;
464 const std::string snomasks = tag->getString("snomasks", "*");
465 for (std::string::const_iterator c = snomasks.begin(); c != snomasks.end(); ++c)
467 const char& chr = *c;
469 this->AllowedSnomasks.set();
470 else if (ModeParser::IsModeChar(chr))
471 this->AllowedSnomasks[chr - 'A'] = true;
482 * unset their oper type (what IS_OPER checks).
483 * note, order is important - this must come before modes as -o attempts
484 * to call UnOper. -- w00t
488 // Remove the user from the oper list
489 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
491 // If the user is quitting we shouldn't remove any modes as it results in
492 // mode messages being broadcast across the network.
496 /* Remove all oper only modes from the user when the deoper - Bug #466*/
497 Modes::ChangeList changelist;
498 const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
499 for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
501 ModeHandler* mh = i->second;
503 changelist.push_remove(mh);
506 ServerInstance->Modes->Process(this, NULL, this, changelist);
508 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
510 this->SetMode(opermh, false);
511 FOREACH_MOD(OnPostDeoper, (this));
515 * Check class restrictions
517 void LocalUser::CheckClass(bool clone_count)
519 ConnectClass* a = this->MyClass;
523 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
526 else if (a->type == CC_DENY)
528 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection", 1));
531 else if (clone_count)
533 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
534 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
536 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
539 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum local connections for the %s class (%ld) exceeded by %s",
540 a->name.c_str(), a->GetMaxLocal(), this->GetIPString().c_str());
544 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
546 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
549 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum global connections for the %s class (%ld) exceeded by %s",
550 a->name.c_str(), a->GetMaxGlobal(), this->GetIPString().c_str());
556 this->nextping = ServerInstance->Time() + a->GetPingTime();
559 bool LocalUser::CheckLines(bool doZline)
561 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
565 for (int n = 0; check[n]; ++n)
567 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
580 void LocalUser::FullConnect()
582 ServerInstance->stats.Connects++;
583 this->idle_lastmsg = ServerInstance->Time();
586 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
587 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
588 * may put the user into a totally separate class with different restrictions! so we *must* check again.
589 * Don't remove this! -- w00t
600 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
601 * for a user that doesn't exist yet.
603 FOREACH_MOD(OnUserConnect, (this));
606 if (ServerInstance->Users->unregistered_count)
607 ServerInstance->Users->unregistered_count--;
608 this->registered = REG_ALL;
610 FOREACH_MOD(OnPostConnect, (this));
612 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
613 this->server_sa.port(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->GetRealName().c_str());
614 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
615 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
616 // reset the flood penalty (which could have been raised due to things like auto +x)
617 CommandFloodPenalty = 0;
620 void User::InvalidateCache()
622 /* Invalidate cache */
624 cached_fullhost.clear();
625 cached_hostip.clear();
626 cached_makehost.clear();
627 cached_fullrealhost.clear();
630 bool User::ChangeNick(const std::string& newnick, time_t newts)
634 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
638 User* const InUse = ServerInstance->FindNickOnly(newnick);
641 // case change, don't need to check campers
642 // and, if it's identical including case, we can leave right now
643 // We also don't update the nick TS if it's a case change, either
650 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
651 * then we have a potential collide. Check whether someone else is camping on the nick
652 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
653 * camper to their UID, and allow the incoming nick change.
655 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
656 * because the nick is already (rightfully) in use. -- w00t
660 if (InUse->registered != REG_ALL)
662 /* force the camper to their UUID, and ask them to re-send a NICK. */
663 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
664 localuser->OverruleNick();
668 /* No camping, tell the incoming user to stop trying to change nick ;p */
669 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
674 age = newts ? newts : ServerInstance->Time();
677 if (this->registered == REG_ALL)
679 ClientProtocol::Messages::Nick nickmsg(this, newnick);
680 ClientProtocol::Event nickevent(ServerInstance->GetRFCEvents().nick, nickmsg);
681 this->WriteCommonRaw(nickevent, true);
683 const std::string oldnick = nick;
687 ServerInstance->Users->clientlist.erase(oldnick);
688 ServerInstance->Users->clientlist[newnick] = this;
690 if (registered == REG_ALL)
691 FOREACH_MOD(OnUserPostNick, (this,oldnick));
696 void LocalUser::OverruleNick()
699 ClientProtocol::Messages::Nick nickmsg(this, this->uuid);
700 this->Send(ServerInstance->GetRFCEvents().nick, nickmsg);
702 this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
704 // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
705 this->registered &= ~REG_NICK;
706 this->ChangeNick(this->uuid);
709 const std::string& User::GetIPString()
711 if (cachedip.empty())
713 cachedip = client_sa.addr();
714 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
715 if (cachedip[0] == ':')
716 cachedip.insert(cachedip.begin(),1,'0');
722 const std::string& User::GetHost(bool uncloak) const
724 return uncloak ? GetRealHost() : GetDisplayedHost();
727 const std::string& User::GetDisplayedHost() const
729 return displayhost.empty() ? realhost : displayhost;
732 const std::string& User::GetRealHost() const
737 const std::string& User::GetRealName() const
742 irc::sockets::cidr_mask User::GetCIDRMask()
744 unsigned char range = 0;
745 switch (client_sa.family())
748 range = ServerInstance->Config->c_ipv6_range;
751 range = ServerInstance->Config->c_ipv4_range;
754 return irc::sockets::cidr_mask(client_sa, range);
757 bool User::SetClientIP(const std::string& address)
759 irc::sockets::sockaddrs sa;
760 if (!irc::sockets::aptosa(address, client_sa.port(), sa))
763 User::SetClientIP(sa);
767 void User::SetClientIP(const irc::sockets::sockaddrs& sa)
769 const std::string oldip(GetIPString());
770 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
771 this->InvalidateCache();
773 // If the users hostname was their IP then update it.
774 if (GetRealHost() == oldip)
775 ChangeRealHost(GetIPString(), false);
776 if (GetDisplayedHost() == oldip)
777 ChangeDisplayedHost(GetIPString());
780 bool LocalUser::SetClientIP(const std::string& address)
782 irc::sockets::sockaddrs sa;
783 if (!irc::sockets::aptosa(address, client_sa.port(), sa))
786 LocalUser::SetClientIP(sa);
790 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa)
795 ServerInstance->Users->RemoveCloneCounts(this);
796 User::SetClientIP(sa);
797 ServerInstance->Users->AddClone(this);
799 // Recheck the connect class.
800 this->MyClass = NULL;
805 FOREACH_MOD(OnSetUserIP, (this));
808 void LocalUser::Write(const ClientProtocol::SerializedMessage& text)
810 if (!SocketEngine::BoundsCheckFd(&eh))
813 if (ServerInstance->Config->RawLog)
818 std::string::size_type nlpos = text.find_first_of("\r\n", 0, 2);
819 if (nlpos == std::string::npos)
820 nlpos = text.length(); // TODO is this ok, test it
822 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %.*s", uuid.c_str(), (int) nlpos, text.c_str());
825 eh.AddWriteBuf(text);
827 const size_t bytessent = text.length() + 2;
828 ServerInstance->stats.Sent += bytessent;
829 this->bytes_out += bytessent;
833 void LocalUser::Send(ClientProtocol::Event& protoev)
837 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "BUG: LocalUser::Send() called on %s who does not have a serializer!",
838 GetFullRealHost().c_str());
842 // In the most common case a static LocalUser field, sendmsglist, is passed to the event to be
843 // populated. The list is cleared before returning.
844 // To handle re-enters, if sendmsglist is non-empty upon entering the method then a temporary
845 // list is used instead of the static one.
846 if (sendmsglist.empty())
848 Send(protoev, sendmsglist);
853 ClientProtocol::MessageList msglist;
854 Send(protoev, msglist);
858 void LocalUser::Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist)
860 // Modules can personalize the messages sent per user for the event
861 protoev.GetMessagesForUser(this, msglist);
862 for (ClientProtocol::MessageList::const_iterator i = msglist.begin(); i != msglist.end(); ++i)
864 ClientProtocol::Message& curr = **i;
866 FIRST_MOD_RESULT(OnUserWrite, res, (this, curr));
867 if (res != MOD_RES_DENY)
868 Write(serializer->SerializeForUser(this, curr));
872 void User::WriteNumeric(const Numeric::Numeric& numeric)
874 LocalUser* const localuser = IS_LOCAL(this);
878 ModResult MOD_RESULT;
880 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
882 if (MOD_RESULT == MOD_RES_DENY)
885 ClientProtocol::Messages::Numeric numericmsg(numeric, localuser);
886 localuser->Send(ServerInstance->GetRFCEvents().numeric, numericmsg);
889 void User::WriteRemoteNotice(const std::string& text)
891 ServerInstance->PI->SendMessage(this, text, MSG_NOTICE);
894 void LocalUser::WriteRemoteNotice(const std::string& text)
901 class WriteCommonRawHandler : public User::ForEachNeighborHandler
903 ClientProtocol::Event& ev;
905 void Execute(LocalUser* user) CXX11_OVERRIDE
911 WriteCommonRawHandler(ClientProtocol::Event& protoev)
918 void User::WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self)
920 WriteCommonRawHandler handler(protoev);
921 ForEachNeighbor(handler, include_self);
924 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
926 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
927 // and visit all users on those channels. Because two users may share more than one common channel,
928 // we must skip users that we have already visited.
929 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
930 // The global counter is incremented every time we do something for each neighbor of a user. Then,
931 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
932 // skip the member. Otherwise, we set it to the current counter and visit the member.
934 // Ask modules to build a list of exceptions.
935 // Mods may also exclude entire channels by erasing them from include_chans.
936 IncludeChanList include_chans(chans.begin(), chans.end());
937 std::map<User*, bool> exceptions;
938 exceptions[this] = include_self;
939 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
941 // Get next id, guaranteed to differ from the already_sent field of all users
942 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
944 // Handle exceptions first
945 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
947 LocalUser* curr = IS_LOCAL(i->first);
950 // Mark as visited to ensure we won't visit again if there is a common channel
951 curr->already_sent = newid;
952 // Always treat quitting users as excluded
953 if ((i->second) && (!curr->quitting))
954 handler.Execute(curr);
958 // Now consider the real neighbors
959 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
961 Channel* chan = (*i)->chan;
962 const Channel::MemberMap& userlist = chan->GetUsers();
963 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
965 LocalUser* curr = IS_LOCAL(j->first);
966 // User not yet visited?
967 if ((curr) && (curr->already_sent != newid))
969 // Mark as visited and execute function
970 curr->already_sent = newid;
971 handler.Execute(curr);
977 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
979 WriteNumeric(numeric);
982 /* return 0 or 1 depending if users u and u2 share one or more common channels
983 * (used by QUIT, NICK etc which arent channel specific notices)
985 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
986 * the first users channels then the second users channels within the outer loop,
987 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
988 * all possible iterations). However this new function instead checks against the
989 * channel's userlist in the inner loop which is a std::map<User*,User*>
990 * and saves us time as we already know what pointer value we are after.
991 * Don't quote me on the maths as i am not a mathematician or computer scientist,
992 * but i believe this algorithm is now x+(log y) maximum iterations instead.
994 bool User::SharesChannelWith(User *other)
997 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
999 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
1000 * by replacing it with a map::find which *should* be more efficient
1002 if ((*i)->chan->HasUser(other))
1008 bool User::ChangeRealName(const std::string& real)
1010 if (!this->realname.compare(real))
1015 ModResult MOD_RESULT;
1016 FIRST_MOD_RESULT(OnPreChangeRealName, MOD_RESULT, (IS_LOCAL(this), real));
1017 if (MOD_RESULT == MOD_RES_DENY)
1020 FOREACH_MOD(OnChangeRealName, (this, real));
1021 this->realname.assign(real, 0, ServerInstance->Config->Limits.MaxReal);
1026 bool User::ChangeDisplayedHost(const std::string& shost)
1028 if (GetDisplayedHost() == shost)
1031 LocalUser* luser = IS_LOCAL(this);
1034 ModResult MOD_RESULT;
1035 FIRST_MOD_RESULT(OnPreChangeHost, MOD_RESULT, (luser, shost));
1036 if (MOD_RESULT == MOD_RES_DENY)
1040 FOREACH_MOD(OnChangeHost, (this,shost));
1042 if (realhost == shost)
1043 this->displayhost.clear();
1045 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1047 this->InvalidateCache();
1049 if (IS_LOCAL(this) && this->registered != REG_NONE)
1050 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1055 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1057 // If the real host is the new host and we are not resetting the
1058 // display host then we have nothing to do.
1059 const bool changehost = (realhost != host);
1060 if (!changehost && !resetdisplay)
1063 // If the displayhost is not set and we are not resetting it then
1064 // we need to copy it to the displayhost field.
1065 if (displayhost.empty() && !resetdisplay)
1066 displayhost = realhost;
1068 // If the displayhost is the new host or we are resetting it then
1069 // we clear its contents to save memory.
1070 else if (displayhost == host || resetdisplay)
1071 displayhost.clear();
1073 // If we are just resetting the display host then we don't need to
1074 // do anything else.
1078 FOREACH_MOD(OnChangeHost, (this, host));
1080 this->InvalidateCache();
1083 bool User::ChangeIdent(const std::string& newident)
1085 if (this->ident == newident)
1088 FOREACH_MOD(OnChangeIdent, (this,newident));
1090 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1091 this->InvalidateCache();
1097 * Sets a user's connection class.
1098 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1099 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1100 * then their ip will be taken as 'priority' anyway, so for example,
1101 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1103 void LocalUser::SetClass(const std::string &explicit_name)
1105 ConnectClass *found = NULL;
1107 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1109 if (!explicit_name.empty())
1111 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1113 ConnectClass* c = *i;
1115 if (explicit_name == c->name)
1117 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1124 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1126 ConnectClass* c = *i;
1127 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1129 ModResult MOD_RESULT;
1130 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1131 if (MOD_RESULT == MOD_RES_DENY)
1133 if (MOD_RESULT == MOD_RES_ALLOW)
1135 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1140 if (c->type == CC_NAMED)
1143 bool regdone = (registered != REG_NONE);
1144 if (c->config->getBool("registered", regdone) != regdone)
1147 /* check if host matches.. */
1148 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1149 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1151 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1156 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1157 * because we should attempt to find another class if this one doesn't match us. -- w00t
1159 if (c->limit && (c->GetReferenceCount() >= c->limit))
1161 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1165 /* if it requires a port ... */
1166 if (!c->ports.empty())
1168 /* and our port doesn't match, fail. */
1169 if (!c->ports.count(this->server_sa.port()))
1171 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1176 if (regdone && !c->password.empty())
1178 if (!ServerInstance->PassCompare(this, c->password, password, c->passwordhash))
1180 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1185 /* we stop at the first class that meets ALL critera. */
1192 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1200 void User::PurgeEmptyChannels()
1202 // firstly decrement the count on each channel
1203 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1205 Channel* c = (*i)->chan;
1211 void User::WriteNotice(const std::string& text)
1213 LocalUser* const localuser = IS_LOCAL(this);
1217 ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, localuser, text, MSG_NOTICE);
1218 localuser->Send(ServerInstance->GetRFCEvents().privmsg, msg);
1221 const std::string& FakeUser::GetFullHost()
1223 if (!ServerInstance->Config->HideServer.empty())
1224 return ServerInstance->Config->HideServer;
1225 return server->GetName();
1228 const std::string& FakeUser::GetFullRealHost()
1230 if (!ServerInstance->Config->HideServer.empty())
1231 return ServerInstance->Config->HideServer;
1232 return server->GetName();
1235 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1240 , registration_timeout(0)
1246 , penaltythreshold(0)
1253 , resolvehostnames(true)
1257 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1264 // Connect classes can inherit from each other but this is problematic for modules which can't use
1265 // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1266 // well as the parent class.
1267 ConfigItems* items = NULL;
1268 config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1270 const ConfigItems& parentkeys = parent.config->getItems();
1271 for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1273 // The class name and parent name are not inherited
1274 if (stdalgo::string::equalsci(piter->first, "name") || stdalgo::string::equalsci(piter->first, "parent"))
1277 // Store the item in the config tag. If this item also
1278 // exists in the child it will be overwritten.
1279 (*items)[piter->first] = piter->second;
1282 const ConfigItems& childkeys = tag->getItems();
1283 for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1285 // This will overwrite the parent value if present.
1286 (*items)[citer->first] = citer->second;
1290 void ConnectClass::Update(const ConnectClass* src)
1292 config = src->config;
1294 fakelag = src->fakelag;
1296 registration_timeout = src->registration_timeout;
1298 pingtime = src->pingtime;
1299 softsendqmax = src->softsendqmax;
1300 hardsendqmax = src->hardsendqmax;
1301 recvqmax = src->recvqmax;
1302 penaltythreshold = src->penaltythreshold;
1303 commandrate = src->commandrate;
1304 maxlocal = src->maxlocal;
1305 maxglobal = src->maxglobal;
1306 maxconnwarn = src->maxconnwarn;
1307 maxchans = src->maxchans;
1309 resolvehostnames = src->resolvehostnames;
1311 password = src->password;
1312 passwordhash = src->passwordhash;