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, UserType 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 return oper->AllowedOperCommands.Contains(command);
195 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
200 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
205 this->WriteNotice("You are not an oper");
209 if (oper->AllowedPrivs.Contains(privstr))
213 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
218 void UserIOHandler::OnDataReady()
223 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
225 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
226 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
227 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
231 unsigned long sendqmax = ULONG_MAX;
232 if (!user->HasPrivPermission("users/flood/increased-buffers"))
233 sendqmax = user->MyClass->GetSendqSoftMax();
235 unsigned long penaltymax = ULONG_MAX;
236 if (!user->HasPrivPermission("users/flood/no-fakelag"))
237 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
239 // The maximum size of an IRC message minus the terminating CR+LF.
240 const size_t maxmessage = ServerInstance->Config->Limits.MaxLine - 2;
242 line.reserve(maxmessage);
245 std::string::size_type qpos;
247 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
252 const size_t qlen = recvq.length();
255 char c = recvq[qpos++];
271 if (line.length() < maxmessage)
275 // if we return here, we haven't found a newline and make no modifications to recvq
276 // so we can wait for more data
280 // just found a newline. Terminate the string, and pull it out of recvq
281 recvq.erase(0, qpos);
283 // TODO should this be moved to when it was inserted in recvq?
284 ServerInstance->stats.Recv += qpos;
285 user->bytes_in += qpos;
288 ServerInstance->Parser.ProcessBuffer(line, user);
292 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
296 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
297 ServerInstance->Users->QuitUser(user, "Excess Flood");
300 void UserIOHandler::AddWriteBuf(const std::string &data)
302 if (user->quitting_sendq)
304 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
305 !user->HasPrivPermission("users/flood/increased-buffers"))
307 user->quitting_sendq = true;
308 ServerInstance->GlobalCulls.AddSQItem(user);
312 // We still want to append data to the sendq of a quitting user,
313 // e.g. their ERROR message that says 'closing link'
318 void UserIOHandler::OnError(BufferedSocketError)
320 ServerInstance->Users->QuitUser(user, getError());
323 CullResult User::cull()
326 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
328 if (client_sa.family() != AF_UNSPEC)
329 ServerInstance->Users->RemoveCloneCounts(this);
331 return Extensible::cull();
334 CullResult LocalUser::cull()
340 CullResult FakeUser::cull()
342 // Fake users don't quit, they just get culled.
344 // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
348 void User::Oper(OperInfo* info)
350 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
351 if (this->IsModeSet(opermh))
354 this->SetMode(opermh, true);
356 this->WriteCommand("MODE", "+o");
357 FOREACH_MOD(OnOper, (this, info->name));
359 std::string opername;
360 if (info->oper_block)
361 opername = info->oper_block->getString("name");
365 LocalUser* l = IS_LOCAL(this);
366 std::string vhost = oper->getConfig("vhost");
368 l->ChangeDisplayedHost(vhost);
369 std::string opClass = oper->getConfig("class");
370 if (!opClass.empty())
371 l->SetClass(opClass);
374 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
375 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
376 this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
378 ServerInstance->Users->all_opers.push_back(this);
380 // Expand permissions from config for faster lookup
384 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
387 void OperInfo::init()
389 AllowedOperCommands.Clear();
390 AllowedPrivs.Clear();
391 AllowedUserModes.reset();
392 AllowedChanModes.reset();
393 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
395 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
397 ConfigTag* tag = *iter;
399 AllowedOperCommands.AddList(tag->getString("commands"));
400 AllowedPrivs.AddList(tag->getString("privs"));
402 std::string modes = tag->getString("usermodes");
403 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
407 this->AllowedUserModes.set();
409 else if (*c >= 'A' && *c <= 'z')
411 this->AllowedUserModes[*c - 'A'] = true;
415 modes = tag->getString("chanmodes");
416 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
420 this->AllowedChanModes.set();
422 else if (*c >= 'A' && *c <= 'z')
424 this->AllowedChanModes[*c - 'A'] = true;
436 * unset their oper type (what IS_OPER checks).
437 * note, order is important - this must come before modes as -o attempts
438 * to call UnOper. -- w00t
443 /* Remove all oper only modes from the user when the deoper - Bug #466*/
444 Modes::ChangeList changelist;
445 const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
446 for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
448 ModeHandler* mh = i->second;
450 changelist.push_remove(mh);
453 ServerInstance->Modes->Process(this, NULL, this, changelist);
455 // Remove the user from the oper list
456 stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
458 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
459 this->SetMode(opermh, false);
460 FOREACH_MOD(OnPostDeoper, (this));
464 * Check class restrictions
466 void LocalUser::CheckClass(bool clone_count)
468 ConnectClass* a = this->MyClass;
472 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
475 else if (a->type == CC_DENY)
477 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
480 else if (clone_count)
482 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
483 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
485 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
487 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
490 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
492 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
494 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
499 this->nping = ServerInstance->Time() + a->GetPingTime();
502 bool LocalUser::CheckLines(bool doZline)
504 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
508 for (int n = 0; check[n]; ++n)
510 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
523 void LocalUser::FullConnect()
525 ServerInstance->stats.Connects++;
526 this->idle_lastmsg = ServerInstance->Time();
529 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
530 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
531 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
532 * Don't remove this! -- w00t
542 this->WriteNumeric(RPL_WELCOME, InspIRCd::Format("Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str()));
543 this->WriteNumeric(RPL_YOURHOSTIS, InspIRCd::Format("Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH));
544 this->WriteNumeric(RPL_SERVERCREATED, InspIRCd::TimeString(ServerInstance->startup_time, "This server was created %H:%M:%S %b %d %Y"));
546 const TR1NS::array<std::string, 3>& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
547 this->WriteNumeric(RPL_SERVERVERSION, ServerInstance->Config->ServerName, INSPIRCD_BRANCH, modelist[0], modelist[1], modelist[2]);
549 ServerInstance->ISupport.SendTo(this);
552 if (ServerInstance->Users->unregistered_count)
553 ServerInstance->Users->unregistered_count--;
555 /* Trigger MOTD and LUSERS output, give modules a chance too */
556 ModResult MOD_RESULT;
557 std::string command("LUSERS");
558 std::vector<std::string> parameters;
559 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
561 ServerInstance->Parser.CallHandler(command, parameters, this);
563 MOD_RESULT = MOD_RES_PASSTHRU;
565 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
567 ServerInstance->Parser.CallHandler(command, parameters, this);
569 if (ServerInstance->Config->RawLog)
570 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
573 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
574 * for a user that doesn't exist yet.
576 FOREACH_MOD(OnUserConnect, (this));
578 this->registered = REG_ALL;
580 FOREACH_MOD(OnPostConnect, (this));
582 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
583 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
584 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
585 ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
586 // reset the flood penalty (which could have been raised due to things like auto +x)
587 CommandFloodPenalty = 0;
590 void User::InvalidateCache()
592 /* Invalidate cache */
594 cached_fullhost.clear();
595 cached_hostip.clear();
596 cached_makehost.clear();
597 cached_fullrealhost.clear();
600 bool User::ChangeNick(const std::string& newnick, time_t newts)
604 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
608 User* const InUse = ServerInstance->FindNickOnly(newnick);
611 // case change, don't need to check campers
612 // and, if it's identical including case, we can leave right now
613 // We also don't update the nick TS if it's a case change, either
620 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
621 * then we have a potential collide. Check whether someone else is camping on the nick
622 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
623 * camper to their UID, and allow the incoming nick change.
625 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
626 * because the nick is already (rightfully) in use. -- w00t
630 if (InUse->registered != REG_ALL)
632 /* force the camper to their UUID, and ask them to re-send a NICK. */
633 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
634 localuser->OverruleNick();
638 /* No camping, tell the incoming user to stop trying to change nick ;p */
639 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
644 age = newts ? newts : ServerInstance->Time();
647 if (this->registered == REG_ALL)
648 this->WriteCommon("NICK %s", newnick.c_str());
649 const std::string oldnick = nick;
653 ServerInstance->Users->clientlist.erase(oldnick);
654 ServerInstance->Users->clientlist[newnick] = this;
656 if (registered == REG_ALL)
657 FOREACH_MOD(OnUserPostNick, (this,oldnick));
662 void LocalUser::OverruleNick()
664 this->WriteFrom(this, "NICK %s", this->uuid.c_str());
665 this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
667 // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
668 this->registered &= ~REG_NICK;
669 this->ChangeNick(this->uuid);
672 int LocalUser::GetServerPort()
674 return this->server_sa.port();
677 const std::string& User::GetIPString()
679 if (cachedip.empty())
681 cachedip = client_sa.addr();
682 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
683 if (cachedip[0] == ':')
684 cachedip.insert(cachedip.begin(),1,'0');
690 const std::string& User::GetHost(bool uncloak) const
692 return uncloak ? GetRealHost() : GetDisplayedHost();
695 const std::string& User::GetDisplayedHost() const
697 return displayhost.empty() ? realhost : displayhost;
700 const std::string& User::GetRealHost() const
705 irc::sockets::cidr_mask User::GetCIDRMask()
707 unsigned char range = 0;
708 switch (client_sa.family())
711 range = ServerInstance->Config->c_ipv6_range;
714 range = ServerInstance->Config->c_ipv4_range;
717 return irc::sockets::cidr_mask(client_sa, range);
720 bool User::SetClientIP(const std::string& address, bool recheck_eline)
722 this->InvalidateCache();
723 return irc::sockets::aptosa(address, 0, client_sa);
726 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
728 this->InvalidateCache();
729 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
732 bool LocalUser::SetClientIP(const std::string& address, bool recheck_eline)
734 irc::sockets::sockaddrs sa;
735 if (!irc::sockets::aptosa(address, 0, sa))
739 LocalUser::SetClientIP(sa, recheck_eline);
743 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
747 User::SetClientIP(sa);
749 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
751 FOREACH_MOD(OnSetUserIP, (this));
755 static std::string wide_newline("\r\n");
757 void User::Write(const std::string& text)
761 void User::Write(const char *text, ...)
765 void LocalUser::Write(const std::string& text)
767 if (!SocketEngine::BoundsCheckFd(&eh))
770 // The maximum size of an IRC message minus the terminating CR+LF.
771 const size_t maxmessage = ServerInstance->Config->Limits.MaxLine - 2;
772 if (text.length() > maxmessage)
774 // This should happen rarely or never. Crop the string at MaxLine and try again.
775 std::string try_again(text, 0, maxmessage);
780 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
782 eh.AddWriteBuf(text);
783 eh.AddWriteBuf(wide_newline);
785 const size_t bytessent = text.length() + 2;
786 ServerInstance->stats.Sent += bytessent;
787 this->bytes_out += bytessent;
793 void LocalUser::Write(const char *text, ...)
795 std::string textbuffer;
796 VAFORMAT(textbuffer, text, text);
797 this->Write(textbuffer);
800 void User::WriteServ(const std::string& text)
802 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
806 * Same as Write(), except `text' is prefixed with `:server.name '.
808 void User::WriteServ(const char* text, ...)
810 std::string textbuffer;
811 VAFORMAT(textbuffer, text, text);
812 this->WriteServ(textbuffer);
815 void User::WriteCommand(const char* command, const std::string& text)
817 this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
822 std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
824 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
825 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
828 for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
829 raw.append(1, ' ').append(*i);
830 raw.append(" :").append(params.back());
836 void User::WriteNumeric(const Numeric::Numeric& numeric)
838 ModResult MOD_RESULT;
840 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
842 if (MOD_RESULT == MOD_RES_DENY)
845 const std::string& servername = (numeric.GetServer() ? numeric.GetServer()->GetName() : ServerInstance->Config->ServerName);
846 this->Write(BuildNumeric(servername, this, numeric.GetNumeric(), numeric.GetParams()));
849 void User::WriteFrom(User *user, const std::string &text)
851 const std::string message = ":" + user->GetFullHost() + " " + text;
852 this->Write(message);
856 /* write text from an originating user to originating user */
858 void User::WriteFrom(User *user, const char* text, ...)
860 std::string textbuffer;
861 VAFORMAT(textbuffer, text, text);
862 this->WriteFrom(user, textbuffer);
865 void User::WriteRemoteNotice(const std::string& text)
867 ServerInstance->PI->SendUserNotice(this, text);
870 void LocalUser::WriteRemoteNotice(const std::string& text)
877 class WriteCommonRawHandler : public User::ForEachNeighborHandler
879 const std::string& msg;
881 void Execute(LocalUser* user) CXX11_OVERRIDE
887 WriteCommonRawHandler(const std::string& message)
894 void User::WriteCommon(const char* text, ...)
896 std::string textbuffer;
897 VAFORMAT(textbuffer, text, text);
898 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
899 this->WriteCommonRaw(textbuffer, true);
902 void User::WriteCommonRaw(const std::string &line, bool include_self)
904 WriteCommonRawHandler handler(line);
905 ForEachNeighbor(handler, include_self);
908 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
910 // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
911 // and visit all users on those channels. Because two users may share more than one common channel,
912 // we must skip users that we have already visited.
913 // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
914 // The global counter is incremented every time we do something for each neighbor of a user. Then,
915 // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
916 // skip the member. Otherwise, we set it to the current counter and visit the member.
918 // Ask modules to build a list of exceptions.
919 // Mods may also exclude entire channels by erasing them from include_chans.
920 IncludeChanList include_chans(chans.begin(), chans.end());
921 std::map<User*, bool> exceptions;
922 exceptions[this] = include_self;
923 FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
925 // Get next id, guaranteed to differ from the already_sent field of all users
926 const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
928 // Handle exceptions first
929 for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
931 LocalUser* curr = IS_LOCAL(i->first);
934 // Mark as visited to ensure we won't visit again if there is a common channel
935 curr->already_sent = newid;
936 // Always treat quitting users as excluded
937 if ((i->second) && (!curr->quitting))
938 handler.Execute(curr);
942 // Now consider the real neighbors
943 for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
945 Channel* chan = (*i)->chan;
946 const Channel::MemberMap& userlist = chan->GetUsers();
947 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
949 LocalUser* curr = IS_LOCAL(j->first);
950 // User not yet visited?
951 if ((curr) && (curr->already_sent != newid))
953 // Mark as visited and execute function
954 curr->already_sent = newid;
955 handler.Execute(curr);
961 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
963 WriteNumeric(numeric);
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)
1012 if (GetDisplayedHost() == 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 if (realhost == shost)
1026 this->displayhost.clear();
1028 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1030 this->InvalidateCache();
1033 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1038 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1040 // If the real host is the new host and we are not resetting the
1041 // display host then we have nothing to do.
1042 const bool changehost = (realhost != host);
1043 if (!changehost && !resetdisplay)
1046 // If the displayhost is not set and we are not resetting it then
1047 // we need to copy it to the displayhost field.
1048 if (displayhost.empty() && !resetdisplay)
1049 displayhost = realhost;
1051 // If the displayhost is the new host or we are resetting it then
1052 // we clear its contents to save memory.
1053 else if (displayhost == host || resetdisplay)
1054 displayhost.clear();
1056 // If we are just resetting the display host then we don't need to
1057 // do anything else.
1062 this->InvalidateCache();
1065 bool User::ChangeIdent(const std::string& newident)
1067 if (this->ident == newident)
1070 FOREACH_MOD(OnChangeIdent, (this,newident));
1072 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1073 this->InvalidateCache();
1079 * Sets a user's connection class.
1080 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1081 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1082 * then their ip will be taken as 'priority' anyway, so for example,
1083 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1085 void LocalUser::SetClass(const std::string &explicit_name)
1087 ConnectClass *found = NULL;
1089 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1091 if (!explicit_name.empty())
1093 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1095 ConnectClass* c = *i;
1097 if (explicit_name == c->name)
1099 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1106 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1108 ConnectClass* c = *i;
1109 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1111 ModResult MOD_RESULT;
1112 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1113 if (MOD_RESULT == MOD_RES_DENY)
1115 if (MOD_RESULT == MOD_RES_ALLOW)
1117 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1122 if (c->type == CC_NAMED)
1125 bool regdone = (registered != REG_NONE);
1126 if (c->config->getBool("registered", regdone) != regdone)
1129 /* check if host matches.. */
1130 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1131 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1133 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1138 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1139 * because we should attempt to find another class if this one doesn't match us. -- w00t
1141 if (c->limit && (c->GetReferenceCount() >= c->limit))
1143 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1147 /* if it requires a port ... */
1148 if (!c->ports.empty())
1150 /* and our port doesn't match, fail. */
1151 if (!c->ports.count(this->GetServerPort()))
1153 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires a different port, skipping");
1158 if (regdone && !c->config->getString("password").empty())
1160 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1162 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1167 /* we stop at the first class that meets ALL critera. */
1174 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1182 void User::PurgeEmptyChannels()
1184 // firstly decrement the count on each channel
1185 for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1187 Channel* c = (*i)->chan;
1195 const std::string& FakeUser::GetFullHost()
1197 if (!ServerInstance->Config->HideServer.empty())
1198 return ServerInstance->Config->HideServer;
1199 return server->GetName();
1202 const std::string& FakeUser::GetFullRealHost()
1204 if (!ServerInstance->Config->HideServer.empty())
1205 return ServerInstance->Config->HideServer;
1206 return server->GetName();
1209 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1210 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1211 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1212 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1213 limit(0), resolvehostnames(true)
1217 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1224 // Connect classes can inherit from each other but this is problematic for modules which can't use
1225 // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1226 // well as the parent class.
1227 ConfigItems* items = NULL;
1228 config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1230 const ConfigItems& parentkeys = parent.config->getItems();
1231 for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1233 // The class name and parent name are not inherited
1234 if (piter->first == "name" || piter->first == "parent")
1237 // Store the item in the config tag. If this item also
1238 // exists in the child it will be overwritten.
1239 (*items)[piter->first] = piter->second;
1242 const ConfigItems& childkeys = tag->getItems();
1243 for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1245 // This will overwrite the parent value if present.
1246 (*items)[citer->first] = citer->second;
1250 void ConnectClass::Update(const ConnectClass* src)
1252 config = src->config;
1254 fakelag = src->fakelag;
1256 registration_timeout = src->registration_timeout;
1258 pingtime = src->pingtime;
1259 softsendqmax = src->softsendqmax;
1260 hardsendqmax = src->hardsendqmax;
1261 recvqmax = src->recvqmax;
1262 penaltythreshold = src->penaltythreshold;
1263 commandrate = src->commandrate;
1264 maxlocal = src->maxlocal;
1265 maxglobal = src->maxglobal;
1266 maxconnwarn = src->maxconnwarn;
1267 maxchans = src->maxchans;
1269 resolvehostnames = src->resolvehostnames;