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 if (!ServerInstance->Users->uuidlist.insert(std::make_pair(uuid, this)).second)
78 throw CoreException("Duplicate UUID "+std::string(uuid)+" in User constructor");
81 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
82 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL), eh(this),
83 bytes_in(0), bytes_out(0), cmds_in(0), cmds_out(0), nping(0), CommandFloodPenalty(0),
86 exempt = quitting_sendq = false;
91 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
92 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
93 dhost = host = GetIPString();
100 const std::string& User::MakeHost()
102 if (!this->cached_makehost.empty())
103 return this->cached_makehost;
105 // XXX: Is there really a need to cache this?
106 this->cached_makehost = ident + "@" + host;
107 return this->cached_makehost;
110 const std::string& User::MakeHostIP()
112 if (!this->cached_hostip.empty())
113 return this->cached_hostip;
115 // XXX: Is there really a need to cache this?
116 this->cached_hostip = ident + "@" + this->GetIPString();
117 return this->cached_hostip;
120 const std::string& User::GetFullHost()
122 if (!this->cached_fullhost.empty())
123 return this->cached_fullhost;
125 // XXX: Is there really a need to cache this?
126 this->cached_fullhost = nick + "!" + ident + "@" + dhost;
127 return this->cached_fullhost;
130 const std::string& User::GetFullRealHost()
132 if (!this->cached_fullrealhost.empty())
133 return this->cached_fullrealhost;
135 // XXX: Is there really a need to cache this?
136 this->cached_fullrealhost = nick + "!" + ident + "@" + host;
137 return this->cached_fullrealhost;
140 bool User::HasModePermission(unsigned char, ModeType)
145 bool LocalUser::HasModePermission(unsigned char mode, ModeType type)
150 if (mode < 'A' || mode > ('A' + 64)) return false;
152 return ((type == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
156 * users on remote servers can completely bypass all permissions based checks.
157 * This prevents desyncs when one server has different type/class tags to another.
158 * That having been said, this does open things up to the possibility of source changes
159 * allowing remote kills, etc - but if they have access to the src, they most likely have
160 * access to the conf - so it's an end to a means either way.
162 bool User::HasPermission(const std::string&)
167 bool LocalUser::HasPermission(const std::string &command)
169 // are they even an oper at all?
175 if (oper->AllowedOperCommands.find(command) != oper->AllowedOperCommands.end())
177 else if (oper->AllowedOperCommands.find("*") != oper->AllowedOperCommands.end())
183 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
188 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
193 this->WriteNotice("You are not an oper");
197 if (oper->AllowedPrivs.find(privstr) != oper->AllowedPrivs.end())
201 else if (oper->AllowedPrivs.find("*") != oper->AllowedPrivs.end())
207 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
212 void UserIOHandler::OnDataReady()
217 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
219 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
220 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
221 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
224 unsigned long sendqmax = ULONG_MAX;
225 if (!user->HasPrivPermission("users/flood/increased-buffers"))
226 sendqmax = user->MyClass->GetSendqSoftMax();
227 unsigned long penaltymax = ULONG_MAX;
228 if (!user->HasPrivPermission("users/flood/no-fakelag"))
229 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
231 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
234 line.reserve(ServerInstance->Config->Limits.MaxLine);
235 std::string::size_type qpos = 0;
236 while (qpos < recvq.length())
238 char c = recvq[qpos++];
249 if (line.length() < ServerInstance->Config->Limits.MaxLine - 2)
252 // if we got here, the recvq ran out before we found a newline
255 // just found a newline. Terminate the string, and pull it out of recvq
256 recvq.erase(0, qpos);
258 // TODO should this be moved to when it was inserted in recvq?
259 ServerInstance->stats.Recv += qpos;
260 user->bytes_in += qpos;
263 ServerInstance->Parser.ProcessBuffer(line, user);
267 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
268 ServerInstance->Users->QuitUser(user, "Excess Flood");
271 void UserIOHandler::AddWriteBuf(const std::string &data)
273 if (user->quitting_sendq)
275 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
276 !user->HasPrivPermission("users/flood/increased-buffers"))
278 user->quitting_sendq = true;
279 ServerInstance->GlobalCulls.AddSQItem(user);
283 // We still want to append data to the sendq of a quitting user,
284 // e.g. their ERROR message that says 'closing link'
289 void UserIOHandler::OnError(BufferedSocketError)
291 ServerInstance->Users->QuitUser(user, getError());
294 CullResult User::cull()
297 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
299 if (client_sa.sa.sa_family != AF_UNSPEC)
300 ServerInstance->Users->RemoveCloneCounts(this);
302 return Extensible::cull();
305 CullResult LocalUser::cull()
311 CullResult FakeUser::cull()
313 // Fake users don't quit, they just get culled.
315 // Fake users are not inserted into UserManager::clientlist, they're only in the uuidlist
316 // and they are removed from there by the linking mod when the server splits
320 void User::Oper(OperInfo* info)
322 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
323 if (this->IsModeSet(opermh))
326 this->SetMode(opermh, true);
328 this->WriteCommand("MODE", "+o");
329 FOREACH_MOD(OnOper, (this, info->name));
331 std::string opername;
332 if (info->oper_block)
333 opername = info->oper_block->getString("name");
337 LocalUser* l = IS_LOCAL(this);
338 std::string vhost = oper->getConfig("vhost");
340 l->ChangeDisplayedHost(vhost.c_str());
341 std::string opClass = oper->getConfig("class");
342 if (!opClass.empty())
343 l->SetClass(opClass);
346 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
347 nick.c_str(), ident.c_str(), host.c_str(), oper->name.c_str(), opername.c_str());
348 this->WriteNumeric(RPL_YOUAREOPER, ":You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str());
350 ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
351 ServerInstance->Users->all_opers.push_back(this);
353 // Expand permissions from config for faster lookup
357 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
360 void OperInfo::init()
362 AllowedOperCommands.clear();
363 AllowedPrivs.clear();
364 AllowedUserModes.reset();
365 AllowedChanModes.reset();
366 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
368 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
370 ConfigTag* tag = *iter;
371 std::string mycmd, mypriv;
372 /* Process commands */
373 irc::spacesepstream CommandList(tag->getString("commands"));
374 while (CommandList.GetToken(mycmd))
376 AllowedOperCommands.insert(mycmd);
379 irc::spacesepstream PrivList(tag->getString("privs"));
380 while (PrivList.GetToken(mypriv))
382 AllowedPrivs.insert(mypriv);
385 std::string modes = tag->getString("usermodes");
386 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
390 this->AllowedUserModes.set();
392 else if (*c >= 'A' && *c <= 'z')
394 this->AllowedUserModes[*c - 'A'] = true;
398 modes = tag->getString("chanmodes");
399 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
403 this->AllowedChanModes.set();
405 else if (*c >= 'A' && *c <= 'z')
407 this->AllowedChanModes[*c - 'A'] = true;
419 * unset their oper type (what IS_OPER checks).
420 * note, order is important - this must come before modes as -o attempts
421 * to call UnOper. -- w00t
426 /* Remove all oper only modes from the user when the deoper - Bug #466*/
427 Modes::ChangeList changelist;
428 const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
429 for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
431 ModeHandler* mh = i->second;
433 changelist.push_remove(mh);
436 ServerInstance->Modes->Process(this, NULL, this, changelist);
438 // Remove the user from the oper list
439 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
441 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
442 this->SetMode(opermh, false);
446 * Check class restrictions
448 void LocalUser::CheckClass(bool clone_count)
450 ConnectClass* a = this->MyClass;
454 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
457 else if (a->type == CC_DENY)
459 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
462 else if (clone_count)
464 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
465 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
467 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
469 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
472 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
474 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
476 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
481 this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout;
484 bool LocalUser::CheckLines(bool doZline)
486 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
490 for (int n = 0; check[n]; ++n)
492 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
505 void LocalUser::FullConnect()
507 ServerInstance->stats.Connects++;
508 this->idle_lastmsg = ServerInstance->Time();
511 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
512 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
513 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
514 * Don't remove this! -- w00t
524 this->WriteNumeric(RPL_WELCOME, ":Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str());
525 this->WriteNumeric(RPL_YOURHOSTIS, ":Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH);
526 this->WriteNumeric(RPL_SERVERCREATED, ":This server was created %s %s", __TIME__, __DATE__);
528 const std::string& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
529 this->WriteNumeric(RPL_SERVERVERSION, "%s %s %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH, modelist.c_str());
531 ServerInstance->ISupport.SendTo(this);
534 if (ServerInstance->Users->unregistered_count)
535 ServerInstance->Users->unregistered_count--;
537 /* Trigger MOTD and LUSERS output, give modules a chance too */
538 ModResult MOD_RESULT;
539 std::string command("LUSERS");
540 std::vector<std::string> parameters;
541 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
543 ServerInstance->Parser.CallHandler(command, parameters, this);
545 MOD_RESULT = MOD_RES_PASSTHRU;
547 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
549 ServerInstance->Parser.CallHandler(command, parameters, this);
551 if (ServerInstance->Config->RawLog)
552 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
555 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
556 * for a user that doesn't exist yet.
558 FOREACH_MOD(OnUserConnect, (this));
560 this->registered = REG_ALL;
562 FOREACH_MOD(OnPostConnect, (this));
564 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
565 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
566 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
567 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
568 // reset the flood penalty (which could have been raised due to things like auto +x)
569 CommandFloodPenalty = 0;
572 void User::InvalidateCache()
574 /* Invalidate cache */
575 cached_fullhost.clear();
576 cached_hostip.clear();
577 cached_makehost.clear();
578 cached_fullrealhost.clear();
581 bool User::ChangeNick(const std::string& newnick, time_t newts)
585 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
589 User* const InUse = ServerInstance->FindNickOnly(newnick);
592 // case change, don't need to check campers
593 // and, if it's identical including case, we can leave right now
594 // We also don't update the nick TS if it's a case change, either
601 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
602 * then we have a potential collide. Check whether someone else is camping on the nick
603 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
604 * camper to their UID, and allow the incoming nick change.
606 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
607 * because the nick is already (rightfully) in use. -- w00t
611 if (InUse->registered != REG_ALL)
613 /* force the camper to their UUID, and ask them to re-send a NICK. */
614 InUse->WriteFrom(InUse, "NICK %s", InUse->uuid.c_str());
615 InUse->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname overruled.", InUse->nick.c_str());
617 InUse->registered &= ~REG_NICK;
618 InUse->ChangeNick(InUse->uuid);
622 /* No camping, tell the incoming user to stop trying to change nick ;p */
623 this->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname is already in use.", newnick.c_str());
628 age = newts ? newts : ServerInstance->Time();
631 if (this->registered == REG_ALL)
632 this->WriteCommon("NICK %s",newnick.c_str());
633 std::string oldnick = nick;
637 ServerInstance->Users->clientlist.erase(oldnick);
638 ServerInstance->Users->clientlist[newnick] = this;
640 if (registered == REG_ALL)
641 FOREACH_MOD(OnUserPostNick, (this,oldnick));
646 int LocalUser::GetServerPort()
648 switch (this->server_sa.sa.sa_family)
651 return htons(this->server_sa.in6.sin6_port);
653 return htons(this->server_sa.in4.sin_port);
658 const std::string& User::GetIPString()
661 if (cachedip.empty())
663 irc::sockets::satoap(client_sa, cachedip, port);
664 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
665 if (cachedip[0] == ':')
666 cachedip.insert(cachedip.begin(),1,'0');
672 irc::sockets::cidr_mask User::GetCIDRMask()
675 switch (client_sa.sa.sa_family)
678 range = ServerInstance->Config->c_ipv6_range;
681 range = ServerInstance->Config->c_ipv4_range;
684 return irc::sockets::cidr_mask(client_sa, range);
687 bool User::SetClientIP(const char* sip, bool recheck_eline)
690 cached_hostip.clear();
691 return irc::sockets::aptosa(sip, 0, client_sa);
694 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
697 cached_hostip.clear();
698 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
701 bool LocalUser::SetClientIP(const char* sip, bool recheck_eline)
703 irc::sockets::sockaddrs sa;
704 if (!irc::sockets::aptosa(sip, 0, sa))
708 LocalUser::SetClientIP(sa, recheck_eline);
712 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
716 User::SetClientIP(sa);
718 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
720 FOREACH_MOD(OnSetUserIP, (this));
724 static std::string wide_newline("\r\n");
726 void User::Write(const std::string& text)
730 void User::Write(const char *text, ...)
734 void LocalUser::Write(const std::string& text)
736 if (!SocketEngine::BoundsCheckFd(&eh))
739 if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
741 // this should happen rarely or never. Crop the string at 512 and try again.
742 std::string try_again(text, 0, ServerInstance->Config->Limits.MaxLine - 2);
747 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
749 eh.AddWriteBuf(text);
750 eh.AddWriteBuf(wide_newline);
752 ServerInstance->stats.Sent += text.length() + 2;
753 this->bytes_out += text.length() + 2;
759 void LocalUser::Write(const char *text, ...)
761 std::string textbuffer;
762 VAFORMAT(textbuffer, text, text);
763 this->Write(textbuffer);
766 void User::WriteServ(const std::string& text)
768 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
772 * Same as Write(), except `text' is prefixed with `:server.name '.
774 void User::WriteServ(const char* text, ...)
776 std::string textbuffer;
777 VAFORMAT(textbuffer, text, text);
778 this->WriteServ(textbuffer);
781 void User::WriteCommand(const char* command, const std::string& text)
783 this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
786 void User::WriteNumeric(unsigned int numeric, const char* text, ...)
788 std::string textbuffer;
789 VAFORMAT(textbuffer, text, text);
790 this->WriteNumeric(numeric, textbuffer);
793 void User::WriteNumeric(unsigned int numeric, const std::string &text)
795 ModResult MOD_RESULT;
797 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric, text));
799 if (MOD_RESULT == MOD_RES_DENY)
802 const std::string message = InspIRCd::Format(":%s %03u %s %s", ServerInstance->Config->ServerName.c_str(),
803 numeric, this->registered & REG_NICK ? this->nick.c_str() : "*", text.c_str());
804 this->Write(message);
807 void User::WriteFrom(User *user, const std::string &text)
809 const std::string message = ":" + user->GetFullHost() + " " + text;
810 this->Write(message);
814 /* write text from an originating user to originating user */
816 void User::WriteFrom(User *user, const char* text, ...)
818 std::string textbuffer;
819 VAFORMAT(textbuffer, text, text);
820 this->WriteFrom(user, textbuffer);
825 class WriteCommonRawHandler : public User::ForEachNeighborHandler
827 const std::string& msg;
829 void Execute(LocalUser* user) CXX11_OVERRIDE
835 WriteCommonRawHandler(const std::string& message)
842 void User::WriteCommon(const char* text, ...)
844 std::string textbuffer;
845 VAFORMAT(textbuffer, text, text);
846 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
847 this->WriteCommonRaw(textbuffer, true);
850 void User::WriteCommonRaw(const std::string &line, bool include_self)
852 WriteCommonRawHandler handler(line);
853 ForEachNeighbor(handler, include_self);
856 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
858 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
859 // and visit all users on those channels. Because two users may share more than one common channel,
860 // we must skip users that we have already visited.
861 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
862 // The global counter is incremented every time we do something for each neighbor of a user. Then,
863 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
864 // skip the member. Otherwise, we set it to the current counter and visit the member.
866 // Ask modules to build a list of exceptions.
867 // Mods may also exclude entire channels by erasing them from include_chans.
868 IncludeChanList include_chans(chans.begin(), chans.end());
869 std::map<User*, bool> exceptions;
870 exceptions[this] = include_self;
871 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
873 // Get next id, guaranteed to differ from the already_sent field of all users
874 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
876 // Handle exceptions first
877 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
879 LocalUser* curr = IS_LOCAL(i->first);
882 // Mark as visited to ensure we won't visit again if there is a common channel
883 curr->already_sent = newid;
884 // Always treat quitting users as excluded
885 if ((i->second) && (!curr->quitting))
886 handler.Execute(curr);
890 // Now consider the real neighbors
891 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
893 Channel* chan = (*i)->chan;
894 const Channel::MemberMap& userlist = chan->GetUsers();
895 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
897 LocalUser* curr = IS_LOCAL(j->first);
898 // User not yet visited?
899 if ((curr) && (curr->already_sent != newid))
901 // Mark as visited and execute function
902 curr->already_sent = newid;
903 handler.Execute(curr);
909 void LocalUser::SendText(const std::string& line)
914 void RemoteUser::SendText(const std::string& line)
916 ServerInstance->PI->PushToClient(this, line);
919 void FakeUser::SendText(const std::string& line)
923 void User::SendText(const char *text, ...)
926 VAFORMAT(line, text, text);
930 void User::SendText(const std::string& linePrefix, std::stringstream& textStream)
934 while (textStream >> word)
936 size_t lineLength = linePrefix.length() + line.length() + word.length() + 3; // "\s\n\r"
937 if (lineLength > ServerInstance->Config->Limits.MaxLine)
939 SendText(linePrefix + line);
944 SendText(linePrefix + line);
947 /* return 0 or 1 depending if users u and u2 share one or more common channels
948 * (used by QUIT, NICK etc which arent channel specific notices)
950 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
951 * the first users channels then the second users channels within the outer loop,
952 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
953 * all possible iterations). However this new function instead checks against the
954 * channel's userlist in the inner loop which is a std::map<User*,User*>
955 * and saves us time as we already know what pointer value we are after.
956 * Don't quote me on the maths as i am not a mathematician or computer scientist,
957 * but i believe this algorithm is now x+(log y) maximum iterations instead.
959 bool User::SharesChannelWith(User *other)
962 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
964 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
965 * by replacing it with a map::find which *should* be more efficient
967 if ((*i)->chan->HasUser(other))
973 bool User::ChangeName(const std::string& gecos)
975 if (!this->fullname.compare(gecos))
980 ModResult MOD_RESULT;
981 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
982 if (MOD_RESULT == MOD_RES_DENY)
984 FOREACH_MOD(OnChangeName, (this,gecos));
986 this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
991 bool User::ChangeDisplayedHost(const std::string& shost)
998 ModResult MOD_RESULT;
999 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1000 if (MOD_RESULT == MOD_RES_DENY)
1004 FOREACH_MOD(OnChangeHost, (this,shost));
1006 this->dhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1007 this->InvalidateCache();
1010 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, "%s :is now your displayed host", this->dhost.c_str());
1015 bool User::ChangeIdent(const std::string& newident)
1017 if (this->ident == newident)
1020 FOREACH_MOD(OnChangeIdent, (this,newident));
1022 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1023 this->InvalidateCache();
1029 * Sets a user's connection class.
1030 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1031 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1032 * then their ip will be taken as 'priority' anyway, so for example,
1033 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1035 void LocalUser::SetClass(const std::string &explicit_name)
1037 ConnectClass *found = NULL;
1039 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1041 if (!explicit_name.empty())
1043 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1045 ConnectClass* c = *i;
1047 if (explicit_name == c->name)
1049 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1056 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1058 ConnectClass* c = *i;
1059 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1061 ModResult MOD_RESULT;
1062 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1063 if (MOD_RESULT == MOD_RES_DENY)
1065 if (MOD_RESULT == MOD_RES_ALLOW)
1067 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1072 if (c->type == CC_NAMED)
1075 bool regdone = (registered != REG_NONE);
1076 if (c->config->getBool("registered", regdone) != regdone)
1079 /* check if host matches.. */
1080 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1081 !InspIRCd::MatchCIDR(this->host, c->GetHost(), NULL))
1083 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1088 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1089 * because we should attempt to find another class if this one doesn't match us. -- w00t
1091 if (c->limit && (c->GetReferenceCount() >= c->limit))
1093 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1097 /* if it requires a port ... */
1098 int port = c->config->getInt("port");
1101 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires port (%d)", port);
1103 /* and our port doesn't match, fail. */
1104 if (this->GetServerPort() != port)
1108 if (regdone && !c->config->getString("password").empty())
1110 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1112 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1117 /* we stop at the first class that meets ALL critera. */
1124 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1132 void User::PurgeEmptyChannels()
1134 // firstly decrement the count on each channel
1135 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1137 Channel* c = (*i)->chan;
1145 const std::string& FakeUser::GetFullHost()
1147 if (!ServerInstance->Config->HideWhoisServer.empty())
1148 return ServerInstance->Config->HideWhoisServer;
1149 return server->GetName();
1152 const std::string& FakeUser::GetFullRealHost()
1154 if (!ServerInstance->Config->HideWhoisServer.empty())
1155 return ServerInstance->Config->HideWhoisServer;
1156 return server->GetName();
1159 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1160 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1161 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1162 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1163 limit(0), resolvehostnames(true)
1167 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1168 : config(tag), type(t), fakelag(parent.fakelag), name("unnamed"),
1169 registration_timeout(parent.registration_timeout), host(mask), pingtime(parent.pingtime),
1170 softsendqmax(parent.softsendqmax), hardsendqmax(parent.hardsendqmax), recvqmax(parent.recvqmax),
1171 penaltythreshold(parent.penaltythreshold), commandrate(parent.commandrate),
1172 maxlocal(parent.maxlocal), maxglobal(parent.maxglobal), maxconnwarn(parent.maxconnwarn), maxchans(parent.maxchans),
1173 limit(parent.limit), resolvehostnames(parent.resolvehostnames)
1177 void ConnectClass::Update(const ConnectClass* src)
1179 config = src->config;
1181 fakelag = src->fakelag;
1183 registration_timeout = src->registration_timeout;
1185 pingtime = src->pingtime;
1186 softsendqmax = src->softsendqmax;
1187 hardsendqmax = src->hardsendqmax;
1188 recvqmax = src->recvqmax;
1189 penaltythreshold = src->penaltythreshold;
1190 commandrate = src->commandrate;
1191 maxlocal = src->maxlocal;
1192 maxglobal = src->maxglobal;
1193 maxconnwarn = src->maxconnwarn;
1194 maxchans = src->maxchans;
1196 resolvehostnames = src->resolvehostnames;