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)
38 ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
39 return (mh && modes[mh->GetId()]);
42 const char* User::FormatModes(bool showparameters)
44 static std::string data;
48 for (unsigned char n = 0; n < 64; n++)
50 ModeHandler* mh = ServerInstance->Modes->FindMode(n + 65, MODETYPE_USER);
51 if (mh && IsModeSet(mh))
53 data.push_back(n + 65);
54 if (showparameters && mh->GetNumParams(true))
56 std::string p = mh->GetUserParameter(this);
58 params.append(" ").append(p);
66 User::User(const std::string& uid, Server* srv, int type)
67 : uuid(uid), server(srv), usertype(type)
69 age = ServerInstance->Time();
73 client_sa.sa.sa_family = AF_UNSPEC;
75 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
77 // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
78 if (type != USERTYPE_SERVER)
80 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
81 throw CoreException("Duplicate UUID in User constructor: " + uuid);
85 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
86 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL), eh(this),
87 bytes_in(0), bytes_out(0), cmds_in(0), cmds_out(0), nping(0), CommandFloodPenalty(0),
90 exempt = quitting_sendq = false;
95 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
96 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
97 dhost = host = GetIPString();
104 const std::string& User::MakeHost()
106 if (!this->cached_makehost.empty())
107 return this->cached_makehost;
109 // XXX: Is there really a need to cache this?
110 this->cached_makehost = ident + "@" + host;
111 return this->cached_makehost;
114 const std::string& User::MakeHostIP()
116 if (!this->cached_hostip.empty())
117 return this->cached_hostip;
119 // XXX: Is there really a need to cache this?
120 this->cached_hostip = ident + "@" + this->GetIPString();
121 return this->cached_hostip;
124 const std::string& User::GetFullHost()
126 if (!this->cached_fullhost.empty())
127 return this->cached_fullhost;
129 // XXX: Is there really a need to cache this?
130 this->cached_fullhost = nick + "!" + ident + "@" + dhost;
131 return this->cached_fullhost;
134 const std::string& User::GetFullRealHost()
136 if (!this->cached_fullrealhost.empty())
137 return this->cached_fullrealhost;
139 // XXX: Is there really a need to cache this?
140 this->cached_fullrealhost = nick + "!" + ident + "@" + host;
141 return this->cached_fullrealhost;
144 bool User::HasModePermission(unsigned char, ModeType)
149 bool LocalUser::HasModePermission(unsigned char mode, ModeType type)
154 if (mode < 'A' || mode > ('A' + 64)) return false;
156 return ((type == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
160 * users on remote servers can completely bypass all permissions based checks.
161 * This prevents desyncs when one server has different type/class tags to another.
162 * That having been said, this does open things up to the possibility of source changes
163 * allowing remote kills, etc - but if they have access to the src, they most likely have
164 * access to the conf - so it's an end to a means either way.
166 bool User::HasPermission(const std::string&)
171 bool LocalUser::HasPermission(const std::string &command)
173 // are they even an oper at all?
179 if (oper->AllowedOperCommands.find(command) != oper->AllowedOperCommands.end())
181 else if (oper->AllowedOperCommands.find("*") != oper->AllowedOperCommands.end())
187 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
192 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
197 this->WriteNotice("You are not an oper");
201 if (oper->AllowedPrivs.find(privstr) != oper->AllowedPrivs.end())
205 else if (oper->AllowedPrivs.find("*") != oper->AllowedPrivs.end())
211 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
216 void UserIOHandler::OnDataReady()
221 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
223 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
224 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
225 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
228 unsigned long sendqmax = ULONG_MAX;
229 if (!user->HasPrivPermission("users/flood/increased-buffers"))
230 sendqmax = user->MyClass->GetSendqSoftMax();
231 unsigned long penaltymax = ULONG_MAX;
232 if (!user->HasPrivPermission("users/flood/no-fakelag"))
233 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
235 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
238 line.reserve(ServerInstance->Config->Limits.MaxLine);
239 std::string::size_type qpos = 0;
240 while (qpos < recvq.length())
242 char c = recvq[qpos++];
253 if (line.length() < ServerInstance->Config->Limits.MaxLine - 2)
256 // if we got here, the recvq ran out before we found a newline
259 // just found a newline. Terminate the string, and pull it out of recvq
260 recvq.erase(0, qpos);
262 // TODO should this be moved to when it was inserted in recvq?
263 ServerInstance->stats.Recv += qpos;
264 user->bytes_in += qpos;
267 ServerInstance->Parser.ProcessBuffer(line, user);
271 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
272 ServerInstance->Users->QuitUser(user, "Excess Flood");
275 void UserIOHandler::AddWriteBuf(const std::string &data)
277 if (user->quitting_sendq)
279 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
280 !user->HasPrivPermission("users/flood/increased-buffers"))
282 user->quitting_sendq = true;
283 ServerInstance->GlobalCulls.AddSQItem(user);
287 // We still want to append data to the sendq of a quitting user,
288 // e.g. their ERROR message that says 'closing link'
293 void UserIOHandler::OnError(BufferedSocketError)
295 ServerInstance->Users->QuitUser(user, getError());
298 CullResult User::cull()
301 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
303 if (client_sa.sa.sa_family != AF_UNSPEC)
304 ServerInstance->Users->RemoveCloneCounts(this);
306 return Extensible::cull();
309 CullResult LocalUser::cull()
315 CullResult FakeUser::cull()
317 // Fake users don't quit, they just get culled.
319 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
323 void User::Oper(OperInfo* info)
325 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
326 if (this->IsModeSet(opermh))
329 this->SetMode(opermh, true);
331 this->WriteCommand("MODE", "+o");
332 FOREACH_MOD(OnOper, (this, info->name));
334 std::string opername;
335 if (info->oper_block)
336 opername = info->oper_block->getString("name");
340 LocalUser* l = IS_LOCAL(this);
341 std::string vhost = oper->getConfig("vhost");
343 l->ChangeDisplayedHost(vhost.c_str());
344 std::string opClass = oper->getConfig("class");
345 if (!opClass.empty())
346 l->SetClass(opClass);
349 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
350 nick.c_str(), ident.c_str(), host.c_str(), oper->name.c_str(), opername.c_str());
351 this->WriteNumeric(RPL_YOUAREOPER, ":You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str());
353 ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
354 ServerInstance->Users->all_opers.push_back(this);
356 // Expand permissions from config for faster lookup
360 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
363 void OperInfo::init()
365 AllowedOperCommands.clear();
366 AllowedPrivs.clear();
367 AllowedUserModes.reset();
368 AllowedChanModes.reset();
369 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
371 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
373 ConfigTag* tag = *iter;
374 std::string mycmd, mypriv;
375 /* Process commands */
376 irc::spacesepstream CommandList(tag->getString("commands"));
377 while (CommandList.GetToken(mycmd))
379 AllowedOperCommands.insert(mycmd);
382 irc::spacesepstream PrivList(tag->getString("privs"));
383 while (PrivList.GetToken(mypriv))
385 AllowedPrivs.insert(mypriv);
388 std::string modes = tag->getString("usermodes");
389 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
393 this->AllowedUserModes.set();
395 else if (*c >= 'A' && *c <= 'z')
397 this->AllowedUserModes[*c - 'A'] = true;
401 modes = tag->getString("chanmodes");
402 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
406 this->AllowedChanModes.set();
408 else if (*c >= 'A' && *c <= 'z')
410 this->AllowedChanModes[*c - 'A'] = true;
422 * unset their oper type (what IS_OPER checks).
423 * note, order is important - this must come before modes as -o attempts
424 * to call UnOper. -- w00t
429 /* Remove all oper only modes from the user when the deoper - Bug #466*/
430 Modes::ChangeList changelist;
431 const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
432 for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
434 ModeHandler* mh = i->second;
436 changelist.push_remove(mh);
439 ServerInstance->Modes->Process(this, NULL, this, changelist);
441 // Remove the user from the oper list
442 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
444 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
445 this->SetMode(opermh, false);
449 * Check class restrictions
451 void LocalUser::CheckClass(bool clone_count)
453 ConnectClass* a = this->MyClass;
457 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
460 else if (a->type == CC_DENY)
462 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
465 else if (clone_count)
467 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
468 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
470 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
472 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
475 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
477 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
479 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
484 this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout;
487 bool LocalUser::CheckLines(bool doZline)
489 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
493 for (int n = 0; check[n]; ++n)
495 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
508 void LocalUser::FullConnect()
510 ServerInstance->stats.Connects++;
511 this->idle_lastmsg = ServerInstance->Time();
514 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
515 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
516 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
517 * Don't remove this! -- w00t
527 this->WriteNumeric(RPL_WELCOME, ":Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str());
528 this->WriteNumeric(RPL_YOURHOSTIS, ":Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH);
529 this->WriteNumeric(RPL_SERVERCREATED, ":This server was created %s %s", __TIME__, __DATE__);
531 const std::string& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
532 this->WriteNumeric(RPL_SERVERVERSION, "%s %s %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH, modelist.c_str());
534 ServerInstance->ISupport.SendTo(this);
537 if (ServerInstance->Users->unregistered_count)
538 ServerInstance->Users->unregistered_count--;
540 /* Trigger MOTD and LUSERS output, give modules a chance too */
541 ModResult MOD_RESULT;
542 std::string command("LUSERS");
543 std::vector<std::string> parameters;
544 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
546 ServerInstance->Parser.CallHandler(command, parameters, this);
548 MOD_RESULT = MOD_RES_PASSTHRU;
550 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
552 ServerInstance->Parser.CallHandler(command, parameters, this);
554 if (ServerInstance->Config->RawLog)
555 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
558 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
559 * for a user that doesn't exist yet.
561 FOREACH_MOD(OnUserConnect, (this));
563 this->registered = REG_ALL;
565 FOREACH_MOD(OnPostConnect, (this));
567 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
568 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
569 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
570 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
571 // reset the flood penalty (which could have been raised due to things like auto +x)
572 CommandFloodPenalty = 0;
575 void User::InvalidateCache()
577 /* Invalidate cache */
578 cached_fullhost.clear();
579 cached_hostip.clear();
580 cached_makehost.clear();
581 cached_fullrealhost.clear();
584 bool User::ChangeNick(const std::string& newnick, time_t newts)
588 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
592 User* const InUse = ServerInstance->FindNickOnly(newnick);
595 // case change, don't need to check campers
596 // and, if it's identical including case, we can leave right now
597 // We also don't update the nick TS if it's a case change, either
604 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
605 * then we have a potential collide. Check whether someone else is camping on the nick
606 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
607 * camper to their UID, and allow the incoming nick change.
609 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
610 * because the nick is already (rightfully) in use. -- w00t
614 if (InUse->registered != REG_ALL)
616 /* force the camper to their UUID, and ask them to re-send a NICK. */
617 InUse->WriteFrom(InUse, "NICK %s", InUse->uuid.c_str());
618 InUse->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname overruled.", InUse->nick.c_str());
620 InUse->registered &= ~REG_NICK;
621 InUse->ChangeNick(InUse->uuid);
625 /* No camping, tell the incoming user to stop trying to change nick ;p */
626 this->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname is already in use.", newnick.c_str());
631 age = newts ? newts : ServerInstance->Time();
634 if (this->registered == REG_ALL)
635 this->WriteCommon("NICK %s",newnick.c_str());
636 std::string oldnick = nick;
640 ServerInstance->Users->clientlist.erase(oldnick);
641 ServerInstance->Users->clientlist[newnick] = this;
643 if (registered == REG_ALL)
644 FOREACH_MOD(OnUserPostNick, (this,oldnick));
649 int LocalUser::GetServerPort()
651 switch (this->server_sa.sa.sa_family)
654 return htons(this->server_sa.in6.sin6_port);
656 return htons(this->server_sa.in4.sin_port);
661 const std::string& User::GetIPString()
664 if (cachedip.empty())
666 irc::sockets::satoap(client_sa, cachedip, port);
667 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
668 if (cachedip[0] == ':')
669 cachedip.insert(cachedip.begin(),1,'0');
675 irc::sockets::cidr_mask User::GetCIDRMask()
678 switch (client_sa.sa.sa_family)
681 range = ServerInstance->Config->c_ipv6_range;
684 range = ServerInstance->Config->c_ipv4_range;
687 return irc::sockets::cidr_mask(client_sa, range);
690 bool User::SetClientIP(const char* sip, bool recheck_eline)
693 cached_hostip.clear();
694 return irc::sockets::aptosa(sip, 0, client_sa);
697 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
700 cached_hostip.clear();
701 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
704 bool LocalUser::SetClientIP(const char* sip, bool recheck_eline)
706 irc::sockets::sockaddrs sa;
707 if (!irc::sockets::aptosa(sip, 0, sa))
711 LocalUser::SetClientIP(sa, recheck_eline);
715 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
719 User::SetClientIP(sa);
721 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
723 FOREACH_MOD(OnSetUserIP, (this));
727 static std::string wide_newline("\r\n");
729 void User::Write(const std::string& text)
733 void User::Write(const char *text, ...)
737 void LocalUser::Write(const std::string& text)
739 if (!SocketEngine::BoundsCheckFd(&eh))
742 if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
744 // this should happen rarely or never. Crop the string at 512 and try again.
745 std::string try_again(text, 0, ServerInstance->Config->Limits.MaxLine - 2);
750 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
752 eh.AddWriteBuf(text);
753 eh.AddWriteBuf(wide_newline);
755 ServerInstance->stats.Sent += text.length() + 2;
756 this->bytes_out += text.length() + 2;
762 void LocalUser::Write(const char *text, ...)
764 std::string textbuffer;
765 VAFORMAT(textbuffer, text, text);
766 this->Write(textbuffer);
769 void User::WriteServ(const std::string& text)
771 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
775 * Same as Write(), except `text' is prefixed with `:server.name '.
777 void User::WriteServ(const char* text, ...)
779 std::string textbuffer;
780 VAFORMAT(textbuffer, text, text);
781 this->WriteServ(textbuffer);
784 void User::WriteCommand(const char* command, const std::string& text)
786 this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
791 std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
793 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
794 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
797 for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
798 raw.append(1, ' ').append(*i);
799 raw.append(" :").append(params.back());
805 void User::WriteNumeric(unsigned int numeric, const char* text, ...)
807 std::string textbuffer;
808 VAFORMAT(textbuffer, text, text);
809 this->WriteNumeric(numeric, textbuffer);
812 void User::WriteNumeric(unsigned int numeric, const std::string &text)
814 ModResult MOD_RESULT;
816 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric, text));
818 if (MOD_RESULT == MOD_RES_DENY)
821 const std::string message = InspIRCd::Format(":%s %03u %s %s", ServerInstance->Config->ServerName.c_str(),
822 numeric, this->registered & REG_NICK ? this->nick.c_str() : "*", text.c_str());
823 this->Write(message);
826 void User::WriteFrom(User *user, const std::string &text)
828 const std::string message = ":" + user->GetFullHost() + " " + text;
829 this->Write(message);
833 /* write text from an originating user to originating user */
835 void User::WriteFrom(User *user, const char* text, ...)
837 std::string textbuffer;
838 VAFORMAT(textbuffer, text, text);
839 this->WriteFrom(user, textbuffer);
844 class WriteCommonRawHandler : public User::ForEachNeighborHandler
846 const std::string& msg;
848 void Execute(LocalUser* user) CXX11_OVERRIDE
854 WriteCommonRawHandler(const std::string& message)
861 void User::WriteCommon(const char* text, ...)
863 std::string textbuffer;
864 VAFORMAT(textbuffer, text, text);
865 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
866 this->WriteCommonRaw(textbuffer, true);
869 void User::WriteCommonRaw(const std::string &line, bool include_self)
871 WriteCommonRawHandler handler(line);
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 LocalUser::SendText(const std::string& line)
933 void RemoteUser::SendText(const std::string& line)
935 ServerInstance->PI->PushToClient(this, line);
938 void FakeUser::SendText(const std::string& line)
942 void User::SendText(const char *text, ...)
945 VAFORMAT(line, text, text);
949 void User::SendText(const std::string& linePrefix, std::stringstream& textStream)
953 while (textStream >> word)
955 size_t lineLength = linePrefix.length() + line.length() + word.length() + 3; // "\s\n\r"
956 if (lineLength > ServerInstance->Config->Limits.MaxLine)
958 SendText(linePrefix + line);
963 SendText(linePrefix + line);
966 /* return 0 or 1 depending if users u and u2 share one or more common channels
967 * (used by QUIT, NICK etc which arent channel specific notices)
969 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
970 * the first users channels then the second users channels within the outer loop,
971 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
972 * all possible iterations). However this new function instead checks against the
973 * channel's userlist in the inner loop which is a std::map<User*,User*>
974 * and saves us time as we already know what pointer value we are after.
975 * Don't quote me on the maths as i am not a mathematician or computer scientist,
976 * but i believe this algorithm is now x+(log y) maximum iterations instead.
978 bool User::SharesChannelWith(User *other)
981 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
983 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
984 * by replacing it with a map::find which *should* be more efficient
986 if ((*i)->chan->HasUser(other))
992 bool User::ChangeName(const std::string& gecos)
994 if (!this->fullname.compare(gecos))
999 ModResult MOD_RESULT;
1000 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
1001 if (MOD_RESULT == MOD_RES_DENY)
1003 FOREACH_MOD(OnChangeName, (this,gecos));
1005 this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1010 bool User::ChangeDisplayedHost(const std::string& shost)
1017 ModResult MOD_RESULT;
1018 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1019 if (MOD_RESULT == MOD_RES_DENY)
1023 FOREACH_MOD(OnChangeHost, (this,shost));
1025 this->dhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1026 this->InvalidateCache();
1029 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, "%s :is now your displayed host", this->dhost.c_str());
1034 bool User::ChangeIdent(const std::string& newident)
1036 if (this->ident == newident)
1039 FOREACH_MOD(OnChangeIdent, (this,newident));
1041 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1042 this->InvalidateCache();
1048 * Sets a user's connection class.
1049 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1050 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1051 * then their ip will be taken as 'priority' anyway, so for example,
1052 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1054 void LocalUser::SetClass(const std::string &explicit_name)
1056 ConnectClass *found = NULL;
1058 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1060 if (!explicit_name.empty())
1062 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1064 ConnectClass* c = *i;
1066 if (explicit_name == c->name)
1068 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1075 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1077 ConnectClass* c = *i;
1078 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1080 ModResult MOD_RESULT;
1081 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1082 if (MOD_RESULT == MOD_RES_DENY)
1084 if (MOD_RESULT == MOD_RES_ALLOW)
1086 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1091 if (c->type == CC_NAMED)
1094 bool regdone = (registered != REG_NONE);
1095 if (c->config->getBool("registered", regdone) != regdone)
1098 /* check if host matches.. */
1099 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1100 !InspIRCd::MatchCIDR(this->host, c->GetHost(), NULL))
1102 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1107 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1108 * because we should attempt to find another class if this one doesn't match us. -- w00t
1110 if (c->limit && (c->GetReferenceCount() >= c->limit))
1112 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1116 /* if it requires a port ... */
1117 int port = c->config->getInt("port");
1120 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires port (%d)", port);
1122 /* and our port doesn't match, fail. */
1123 if (this->GetServerPort() != port)
1127 if (regdone && !c->config->getString("password").empty())
1129 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1131 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1136 /* we stop at the first class that meets ALL critera. */
1143 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1151 void User::PurgeEmptyChannels()
1153 // firstly decrement the count on each channel
1154 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1156 Channel* c = (*i)->chan;
1164 const std::string& FakeUser::GetFullHost()
1166 if (!ServerInstance->Config->HideWhoisServer.empty())
1167 return ServerInstance->Config->HideWhoisServer;
1168 return server->GetName();
1171 const std::string& FakeUser::GetFullRealHost()
1173 if (!ServerInstance->Config->HideWhoisServer.empty())
1174 return ServerInstance->Config->HideWhoisServer;
1175 return server->GetName();
1178 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1179 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1180 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1181 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1182 limit(0), resolvehostnames(true)
1186 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1187 : config(tag), type(t), fakelag(parent.fakelag), name("unnamed"),
1188 registration_timeout(parent.registration_timeout), host(mask), pingtime(parent.pingtime),
1189 softsendqmax(parent.softsendqmax), hardsendqmax(parent.hardsendqmax), recvqmax(parent.recvqmax),
1190 penaltythreshold(parent.penaltythreshold), commandrate(parent.commandrate),
1191 maxlocal(parent.maxlocal), maxglobal(parent.maxglobal), maxconnwarn(parent.maxconnwarn), maxchans(parent.maxchans),
1192 limit(parent.limit), resolvehostnames(parent.resolvehostnames)
1196 void ConnectClass::Update(const ConnectClass* src)
1198 config = src->config;
1200 fakelag = src->fakelag;
1202 registration_timeout = src->registration_timeout;
1204 pingtime = src->pingtime;
1205 softsendqmax = src->softsendqmax;
1206 hardsendqmax = src->hardsendqmax;
1207 recvqmax = src->recvqmax;
1208 penaltythreshold = src->penaltythreshold;
1209 commandrate = src->commandrate;
1210 maxlocal = src->maxlocal;
1211 maxglobal = src->maxglobal;
1212 maxconnwarn = src->maxconnwarn;
1213 maxchans = src->maxchans;
1215 resolvehostnames = src->resolvehostnames;