2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2006-2009 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2008 John Brooks <john.brooks@dereferenced.net>
8 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
9 * Copyright (C) 2008 Oliver Lupton <oliverlupton@gmail.com>
10 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 bool User::IsNoticeMaskSet(unsigned char sm)
33 return (snomasks[sm-65]);
36 bool User::IsModeSet(unsigned char m) const
38 ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
39 return (mh && modes[mh->GetId()]);
42 std::string User::GetModeLetters(bool includeparams) const
44 std::string ret(1, '+');
47 for (unsigned char i = 'A'; i < 'z'; i++)
49 const ModeHandler* const mh = ServerInstance->Modes.FindMode(i, MODETYPE_USER);
50 if ((!mh) || (!IsModeSet(mh)))
53 ret.push_back(mh->GetModeChar());
54 if ((includeparams) && (mh->NeedsParam(true)))
56 const std::string val = mh->GetUserParameter(this);
58 params.append(1, ' ').append(val);
66 User::User(const std::string& uid, Server* srv, int type)
67 : age(ServerInstance->Time())
71 , registered(REG_NONE)
75 client_sa.sa.sa_family = AF_UNSPEC;
77 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
79 // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
80 if (type != USERTYPE_SERVER)
82 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
83 throw CoreException("Duplicate UUID in User constructor: " + uuid);
87 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
88 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL)
94 , quitting_sendq(false)
99 , CommandFloodPenalty(0)
102 signon = ServerInstance->Time();
103 // The user's default nick is their UUID
107 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
108 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
109 ChangeRealHost(GetIPString(), true);
116 const std::string& User::MakeHost()
118 if (!this->cached_makehost.empty())
119 return this->cached_makehost;
121 // XXX: Is there really a need to cache this?
122 this->cached_makehost = ident + "@" + GetRealHost();
123 return this->cached_makehost;
126 const std::string& User::MakeHostIP()
128 if (!this->cached_hostip.empty())
129 return this->cached_hostip;
131 // XXX: Is there really a need to cache this?
132 this->cached_hostip = ident + "@" + this->GetIPString();
133 return this->cached_hostip;
136 const std::string& User::GetFullHost()
138 if (!this->cached_fullhost.empty())
139 return this->cached_fullhost;
141 // XXX: Is there really a need to cache this?
142 this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
143 return this->cached_fullhost;
146 const std::string& User::GetFullRealHost()
148 if (!this->cached_fullrealhost.empty())
149 return this->cached_fullrealhost;
151 // XXX: Is there really a need to cache this?
152 this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
153 return this->cached_fullrealhost;
156 bool User::HasModePermission(const ModeHandler* mh) const
161 bool LocalUser::HasModePermission(const ModeHandler* mh) const
166 const unsigned char mode = mh->GetModeChar();
167 if (mode < 'A' || mode > ('A' + 64)) return false;
169 return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
173 * users on remote servers can completely bypass all permissions based checks.
174 * This prevents desyncs when one server has different type/class tags to another.
175 * That having been said, this does open things up to the possibility of source changes
176 * allowing remote kills, etc - but if they have access to the src, they most likely have
177 * access to the conf - so it's an end to a means either way.
179 bool User::HasPermission(const std::string&)
184 bool LocalUser::HasPermission(const std::string &command)
186 // are they even an oper at all?
192 if (oper->AllowedOperCommands.find(command) != oper->AllowedOperCommands.end())
194 else if (oper->AllowedOperCommands.find("*") != oper->AllowedOperCommands.end())
200 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
205 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
210 this->WriteNotice("You are not an oper");
214 if (oper->AllowedPrivs.find(privstr) != oper->AllowedPrivs.end())
218 else if (oper->AllowedPrivs.find("*") != oper->AllowedPrivs.end())
224 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
229 void UserIOHandler::OnDataReady()
234 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
236 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
237 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
238 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
241 unsigned long sendqmax = ULONG_MAX;
242 if (!user->HasPrivPermission("users/flood/increased-buffers"))
243 sendqmax = user->MyClass->GetSendqSoftMax();
244 unsigned long penaltymax = ULONG_MAX;
245 if (!user->HasPrivPermission("users/flood/no-fakelag"))
246 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
248 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
251 line.reserve(ServerInstance->Config->Limits.MaxLine);
252 std::string::size_type qpos = 0;
253 while (qpos < recvq.length())
255 char c = recvq[qpos++];
266 if (line.length() < ServerInstance->Config->Limits.MaxLine - 2)
269 // if we got here, the recvq ran out before we found a newline
272 // just found a newline. Terminate the string, and pull it out of recvq
273 recvq.erase(0, qpos);
275 // TODO should this be moved to when it was inserted in recvq?
276 ServerInstance->stats.Recv += qpos;
277 user->bytes_in += qpos;
280 ServerInstance->Parser.ProcessBuffer(line, user);
284 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
285 ServerInstance->Users->QuitUser(user, "Excess Flood");
288 void UserIOHandler::AddWriteBuf(const std::string &data)
290 if (user->quitting_sendq)
292 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
293 !user->HasPrivPermission("users/flood/increased-buffers"))
295 user->quitting_sendq = true;
296 ServerInstance->GlobalCulls.AddSQItem(user);
300 // We still want to append data to the sendq of a quitting user,
301 // e.g. their ERROR message that says 'closing link'
306 void UserIOHandler::OnError(BufferedSocketError)
308 ServerInstance->Users->QuitUser(user, getError());
311 CullResult User::cull()
314 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
316 if (client_sa.sa.sa_family != AF_UNSPEC)
317 ServerInstance->Users->RemoveCloneCounts(this);
319 return Extensible::cull();
322 CullResult LocalUser::cull()
328 CullResult FakeUser::cull()
330 // Fake users don't quit, they just get culled.
332 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
336 void User::Oper(OperInfo* info)
338 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
339 if (this->IsModeSet(opermh))
342 this->SetMode(opermh, true);
344 this->WriteCommand("MODE", "+o");
345 FOREACH_MOD(OnOper, (this, info->name));
347 std::string opername;
348 if (info->oper_block)
349 opername = info->oper_block->getString("name");
353 LocalUser* l = IS_LOCAL(this);
354 std::string vhost = oper->getConfig("vhost");
356 l->ChangeDisplayedHost(vhost);
357 std::string opClass = oper->getConfig("class");
358 if (!opClass.empty())
359 l->SetClass(opClass);
362 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
363 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
364 this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
366 ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
367 ServerInstance->Users->all_opers.push_back(this);
369 // Expand permissions from config for faster lookup
373 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
376 void OperInfo::init()
378 AllowedOperCommands.clear();
379 AllowedPrivs.clear();
380 AllowedUserModes.reset();
381 AllowedChanModes.reset();
382 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
384 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
386 ConfigTag* tag = *iter;
387 std::string mycmd, mypriv;
388 /* Process commands */
389 irc::spacesepstream CommandList(tag->getString("commands"));
390 while (CommandList.GetToken(mycmd))
392 AllowedOperCommands.insert(mycmd);
395 irc::spacesepstream PrivList(tag->getString("privs"));
396 while (PrivList.GetToken(mypriv))
398 AllowedPrivs.insert(mypriv);
401 std::string modes = tag->getString("usermodes");
402 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
406 this->AllowedUserModes.set();
408 else if (*c >= 'A' && *c <= 'z')
410 this->AllowedUserModes[*c - 'A'] = true;
414 modes = tag->getString("chanmodes");
415 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
419 this->AllowedChanModes.set();
421 else if (*c >= 'A' && *c <= 'z')
423 this->AllowedChanModes[*c - 'A'] = true;
435 * unset their oper type (what IS_OPER checks).
436 * note, order is important - this must come before modes as -o attempts
437 * to call UnOper. -- w00t
442 /* Remove all oper only modes from the user when the deoper - Bug #466*/
443 Modes::ChangeList changelist;
444 const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
445 for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
447 ModeHandler* mh = i->second;
449 changelist.push_remove(mh);
452 ServerInstance->Modes->Process(this, NULL, this, changelist);
454 // Remove the user from the oper list
455 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
457 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
458 this->SetMode(opermh, false);
462 * Check class restrictions
464 void LocalUser::CheckClass(bool clone_count)
466 ConnectClass* a = this->MyClass;
470 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
473 else if (a->type == CC_DENY)
475 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
478 else if (clone_count)
480 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
481 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
483 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
485 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
488 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
490 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
492 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
497 this->nping = ServerInstance->Time() + a->GetPingTime();
500 bool LocalUser::CheckLines(bool doZline)
502 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
506 for (int n = 0; check[n]; ++n)
508 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
521 void LocalUser::FullConnect()
523 ServerInstance->stats.Connects++;
524 this->idle_lastmsg = ServerInstance->Time();
527 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
528 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
529 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
530 * Don't remove this! -- w00t
540 this->WriteNumeric(RPL_WELCOME, InspIRCd::Format("Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str()));
541 this->WriteNumeric(RPL_YOURHOSTIS, InspIRCd::Format("Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH));
542 this->WriteNumeric(RPL_SERVERCREATED, InspIRCd::TimeString(ServerInstance->startup_time, "This server was created %H:%M:%S %b %d %Y"));
544 const TR1NS::array<std::string, 3>& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
545 this->WriteNumeric(RPL_SERVERVERSION, ServerInstance->Config->ServerName, INSPIRCD_BRANCH, modelist[0], modelist[1], modelist[2]);
547 ServerInstance->ISupport.SendTo(this);
550 if (ServerInstance->Users->unregistered_count)
551 ServerInstance->Users->unregistered_count--;
553 /* Trigger MOTD and LUSERS output, give modules a chance too */
554 ModResult MOD_RESULT;
555 std::string command("LUSERS");
556 std::vector<std::string> parameters;
557 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
559 ServerInstance->Parser.CallHandler(command, parameters, this);
561 MOD_RESULT = MOD_RES_PASSTHRU;
563 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
565 ServerInstance->Parser.CallHandler(command, parameters, this);
567 if (ServerInstance->Config->RawLog)
568 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
571 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
572 * for a user that doesn't exist yet.
574 FOREACH_MOD(OnUserConnect, (this));
576 this->registered = REG_ALL;
578 FOREACH_MOD(OnPostConnect, (this));
580 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
581 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
582 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
583 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
584 // reset the flood penalty (which could have been raised due to things like auto +x)
585 CommandFloodPenalty = 0;
588 void User::InvalidateCache()
590 /* Invalidate cache */
592 cached_fullhost.clear();
593 cached_hostip.clear();
594 cached_makehost.clear();
595 cached_fullrealhost.clear();
598 bool User::ChangeNick(const std::string& newnick, time_t newts)
602 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
606 User* const InUse = ServerInstance->FindNickOnly(newnick);
609 // case change, don't need to check campers
610 // and, if it's identical including case, we can leave right now
611 // We also don't update the nick TS if it's a case change, either
618 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
619 * then we have a potential collide. Check whether someone else is camping on the nick
620 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
621 * camper to their UID, and allow the incoming nick change.
623 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
624 * because the nick is already (rightfully) in use. -- w00t
628 if (InUse->registered != REG_ALL)
630 /* force the camper to their UUID, and ask them to re-send a NICK. */
631 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
632 localuser->OverruleNick();
636 /* No camping, tell the incoming user to stop trying to change nick ;p */
637 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
642 age = newts ? newts : ServerInstance->Time();
645 if (this->registered == REG_ALL)
646 this->WriteCommon("NICK %s",newnick.c_str());
647 std::string oldnick = nick;
651 ServerInstance->Users->clientlist.erase(oldnick);
652 ServerInstance->Users->clientlist[newnick] = this;
654 if (registered == REG_ALL)
655 FOREACH_MOD(OnUserPostNick, (this,oldnick));
660 void LocalUser::OverruleNick()
662 this->WriteFrom(this, "NICK %s", this->uuid.c_str());
663 this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
665 // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
666 this->registered &= ~REG_NICK;
667 this->ChangeNick(this->uuid);
670 int LocalUser::GetServerPort()
672 switch (this->server_sa.sa.sa_family)
675 return htons(this->server_sa.in6.sin6_port);
677 return htons(this->server_sa.in4.sin_port);
682 const std::string& User::GetIPString()
684 if (cachedip.empty())
686 cachedip = client_sa.addr();
687 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
688 if (cachedip[0] == ':')
689 cachedip.insert(cachedip.begin(),1,'0');
695 const std::string& User::GetHost(bool uncloak) const
697 return uncloak ? GetRealHost() : GetDisplayedHost();
700 const std::string& User::GetDisplayedHost() const
702 return displayhost.empty() ? realhost : displayhost;
705 const std::string& User::GetRealHost() const
710 irc::sockets::cidr_mask User::GetCIDRMask()
713 switch (client_sa.sa.sa_family)
716 range = ServerInstance->Config->c_ipv6_range;
719 range = ServerInstance->Config->c_ipv4_range;
722 return irc::sockets::cidr_mask(client_sa, range);
725 bool User::SetClientIP(const std::string& address, bool recheck_eline)
727 this->InvalidateCache();
728 return irc::sockets::aptosa(address, 0, client_sa);
731 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
734 cached_hostip.clear();
735 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
738 bool LocalUser::SetClientIP(const std::string& address, bool recheck_eline)
740 irc::sockets::sockaddrs sa;
741 if (!irc::sockets::aptosa(address, 0, sa))
745 LocalUser::SetClientIP(sa, recheck_eline);
749 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
753 User::SetClientIP(sa);
755 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
757 FOREACH_MOD(OnSetUserIP, (this));
761 static std::string wide_newline("\r\n");
763 void User::Write(const std::string& text)
767 void User::Write(const char *text, ...)
771 void LocalUser::Write(const std::string& text)
773 if (!SocketEngine::BoundsCheckFd(&eh))
776 if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
778 // this should happen rarely or never. Crop the string at 512 and try again.
779 std::string try_again(text, 0, ServerInstance->Config->Limits.MaxLine - 2);
784 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
786 eh.AddWriteBuf(text);
787 eh.AddWriteBuf(wide_newline);
789 ServerInstance->stats.Sent += text.length() + 2;
790 this->bytes_out += text.length() + 2;
796 void LocalUser::Write(const char *text, ...)
798 std::string textbuffer;
799 VAFORMAT(textbuffer, text, text);
800 this->Write(textbuffer);
803 void User::WriteServ(const std::string& text)
805 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
809 * Same as Write(), except `text' is prefixed with `:server.name '.
811 void User::WriteServ(const char* text, ...)
813 std::string textbuffer;
814 VAFORMAT(textbuffer, text, text);
815 this->WriteServ(textbuffer);
818 void User::WriteCommand(const char* command, const std::string& text)
820 this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
825 std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
827 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
828 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
831 for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
832 raw.append(1, ' ').append(*i);
833 raw.append(" :").append(params.back());
839 void User::WriteNumeric(const Numeric::Numeric& numeric)
841 ModResult MOD_RESULT;
843 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
845 if (MOD_RESULT == MOD_RES_DENY)
848 const std::string& servername = (numeric.GetServer() ? numeric.GetServer()->GetName() : ServerInstance->Config->ServerName);
849 this->Write(BuildNumeric(servername, this, numeric.GetNumeric(), numeric.GetParams()));
852 void User::WriteFrom(User *user, const std::string &text)
854 const std::string message = ":" + user->GetFullHost() + " " + text;
855 this->Write(message);
859 /* write text from an originating user to originating user */
861 void User::WriteFrom(User *user, const char* text, ...)
863 std::string textbuffer;
864 VAFORMAT(textbuffer, text, text);
865 this->WriteFrom(user, textbuffer);
868 void User::WriteRemoteNotice(const std::string& text)
870 ServerInstance->PI->SendUserNotice(this, text);
873 void LocalUser::WriteRemoteNotice(const std::string& text)
880 class WriteCommonRawHandler : public User::ForEachNeighborHandler
882 const std::string& msg;
884 void Execute(LocalUser* user) CXX11_OVERRIDE
890 WriteCommonRawHandler(const std::string& message)
897 void User::WriteCommon(const char* text, ...)
899 std::string textbuffer;
900 VAFORMAT(textbuffer, text, text);
901 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
902 this->WriteCommonRaw(textbuffer, true);
905 void User::WriteCommonRaw(const std::string &line, bool include_self)
907 WriteCommonRawHandler handler(line);
908 ForEachNeighbor(handler, include_self);
911 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
913 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
914 // and visit all users on those channels. Because two users may share more than one common channel,
915 // we must skip users that we have already visited.
916 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
917 // The global counter is incremented every time we do something for each neighbor of a user. Then,
918 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
919 // skip the member. Otherwise, we set it to the current counter and visit the member.
921 // Ask modules to build a list of exceptions.
922 // Mods may also exclude entire channels by erasing them from include_chans.
923 IncludeChanList include_chans(chans.begin(), chans.end());
924 std::map<User*, bool> exceptions;
925 exceptions[this] = include_self;
926 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
928 // Get next id, guaranteed to differ from the already_sent field of all users
929 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
931 // Handle exceptions first
932 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
934 LocalUser* curr = IS_LOCAL(i->first);
937 // Mark as visited to ensure we won't visit again if there is a common channel
938 curr->already_sent = newid;
939 // Always treat quitting users as excluded
940 if ((i->second) && (!curr->quitting))
941 handler.Execute(curr);
945 // Now consider the real neighbors
946 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
948 Channel* chan = (*i)->chan;
949 const Channel::MemberMap& userlist = chan->GetUsers();
950 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
952 LocalUser* curr = IS_LOCAL(j->first);
953 // User not yet visited?
954 if ((curr) && (curr->already_sent != newid))
956 // Mark as visited and execute function
957 curr->already_sent = newid;
958 handler.Execute(curr);
964 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
966 WriteNumeric(numeric);
969 /* return 0 or 1 depending if users u and u2 share one or more common channels
970 * (used by QUIT, NICK etc which arent channel specific notices)
972 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
973 * the first users channels then the second users channels within the outer loop,
974 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
975 * all possible iterations). However this new function instead checks against the
976 * channel's userlist in the inner loop which is a std::map<User*,User*>
977 * and saves us time as we already know what pointer value we are after.
978 * Don't quote me on the maths as i am not a mathematician or computer scientist,
979 * but i believe this algorithm is now x+(log y) maximum iterations instead.
981 bool User::SharesChannelWith(User *other)
984 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
986 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
987 * by replacing it with a map::find which *should* be more efficient
989 if ((*i)->chan->HasUser(other))
995 bool User::ChangeName(const std::string& gecos)
997 if (!this->fullname.compare(gecos))
1002 ModResult MOD_RESULT;
1003 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
1004 if (MOD_RESULT == MOD_RES_DENY)
1006 FOREACH_MOD(OnChangeName, (this,gecos));
1008 this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1013 bool User::ChangeDisplayedHost(const std::string& shost)
1015 if (GetDisplayedHost() == shost)
1020 ModResult MOD_RESULT;
1021 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1022 if (MOD_RESULT == MOD_RES_DENY)
1026 FOREACH_MOD(OnChangeHost, (this,shost));
1028 if (realhost == shost)
1029 this->displayhost.clear();
1031 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1033 this->InvalidateCache();
1036 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1041 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1043 if (displayhost == host)
1046 if (displayhost.empty() && !resetdisplay)
1047 displayhost = realhost;
1049 else if (displayhost == host || resetdisplay)
1050 displayhost.clear();
1053 this->InvalidateCache();
1056 bool User::ChangeIdent(const std::string& newident)
1058 if (this->ident == newident)
1061 FOREACH_MOD(OnChangeIdent, (this,newident));
1063 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1064 this->InvalidateCache();
1070 * Sets a user's connection class.
1071 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1072 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1073 * then their ip will be taken as 'priority' anyway, so for example,
1074 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1076 void LocalUser::SetClass(const std::string &explicit_name)
1078 ConnectClass *found = NULL;
1080 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1082 if (!explicit_name.empty())
1084 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1086 ConnectClass* c = *i;
1088 if (explicit_name == c->name)
1090 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1097 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1099 ConnectClass* c = *i;
1100 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1102 ModResult MOD_RESULT;
1103 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1104 if (MOD_RESULT == MOD_RES_DENY)
1106 if (MOD_RESULT == MOD_RES_ALLOW)
1108 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1113 if (c->type == CC_NAMED)
1116 bool regdone = (registered != REG_NONE);
1117 if (c->config->getBool("registered", regdone) != regdone)
1120 /* check if host matches.. */
1121 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1122 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1124 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1129 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1130 * because we should attempt to find another class if this one doesn't match us. -- w00t
1132 if (c->limit && (c->GetReferenceCount() >= c->limit))
1134 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1138 /* if it requires a port ... */
1139 if (!c->ports.empty())
1141 /* and our port doesn't match, fail. */
1142 if (!c->ports.count(this->GetServerPort()))
1144 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1149 if (regdone && !c->config->getString("password").empty())
1151 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1153 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1158 /* we stop at the first class that meets ALL critera. */
1165 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1173 void User::PurgeEmptyChannels()
1175 // firstly decrement the count on each channel
1176 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1178 Channel* c = (*i)->chan;
1186 const std::string& FakeUser::GetFullHost()
1188 if (!ServerInstance->Config->HideWhoisServer.empty())
1189 return ServerInstance->Config->HideWhoisServer;
1190 return server->GetName();
1193 const std::string& FakeUser::GetFullRealHost()
1195 if (!ServerInstance->Config->HideWhoisServer.empty())
1196 return ServerInstance->Config->HideWhoisServer;
1197 return server->GetName();
1200 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1201 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1202 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1203 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1204 limit(0), resolvehostnames(true)
1208 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1216 void ConnectClass::Update(const ConnectClass* src)
1218 config = src->config;
1220 fakelag = src->fakelag;
1222 registration_timeout = src->registration_timeout;
1224 pingtime = src->pingtime;
1225 softsendqmax = src->softsendqmax;
1226 hardsendqmax = src->hardsendqmax;
1227 recvqmax = src->recvqmax;
1228 penaltythreshold = src->penaltythreshold;
1229 commandrate = src->commandrate;
1230 maxlocal = src->maxlocal;
1231 maxglobal = src->maxglobal;
1232 maxconnwarn = src->maxconnwarn;
1233 maxchans = src->maxchans;
1235 resolvehostnames = src->resolvehostnames;