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/>.
28 #include "socketengine.h"
32 already_sent_t LocalUser::already_sent_id = 0;
34 bool User::IsNoticeMaskSet(unsigned char sm)
38 return (snomasks[sm-65]);
41 bool User::IsModeSet(unsigned char m)
48 const char* User::FormatModes(bool showparameters)
50 static std::string data;
54 for (unsigned char n = 0; n < 64; n++)
58 data.push_back(n + 65);
59 ModeHandler* mh = ServerInstance->Modes->FindMode(n + 65, MODETYPE_USER);
60 if (showparameters && mh && mh->GetNumParams(true))
62 std::string p = mh->GetUserParameter(this);
64 params.append(" ").append(p);
72 User::User(const std::string& uid, Server* srv, int type)
73 : uuid(uid), server(srv), usertype(type)
75 age = ServerInstance->Time();
79 client_sa.sa.sa_family = AF_UNSPEC;
81 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
83 if (!ServerInstance->Users->uuidlist->insert(std::make_pair(uuid, this)).second)
84 throw CoreException("Duplicate UUID "+std::string(uuid)+" in User constructor");
87 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
88 : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL), eh(this),
89 localuseriter(ServerInstance->Users->local_users.end()),
90 bytes_in(0), bytes_out(0), cmds_in(0), cmds_out(0), nping(0), CommandFloodPenalty(0),
93 exempt = quitting_sendq = false;
98 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
99 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
100 dhost = host = GetIPString();
105 if (ServerInstance->Users->uuidlist->find(uuid) != ServerInstance->Users->uuidlist->end())
106 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "User destructor for %s called without cull", uuid.c_str());
109 const std::string& User::MakeHost()
111 if (!this->cached_makehost.empty())
112 return this->cached_makehost;
114 // XXX: Is there really a need to cache this?
115 this->cached_makehost = ident + "@" + host;
116 return this->cached_makehost;
119 const std::string& User::MakeHostIP()
121 if (!this->cached_hostip.empty())
122 return this->cached_hostip;
124 // XXX: Is there really a need to cache this?
125 this->cached_hostip = ident + "@" + this->GetIPString();
126 return this->cached_hostip;
129 const std::string& User::GetFullHost()
131 if (!this->cached_fullhost.empty())
132 return this->cached_fullhost;
134 // XXX: Is there really a need to cache this?
135 this->cached_fullhost = nick + "!" + ident + "@" + dhost;
136 return this->cached_fullhost;
139 const std::string& User::GetFullRealHost()
141 if (!this->cached_fullrealhost.empty())
142 return this->cached_fullrealhost;
144 // XXX: Is there really a need to cache this?
145 this->cached_fullrealhost = nick + "!" + ident + "@" + host;
146 return this->cached_fullrealhost;
149 InviteList& LocalUser::GetInviteList()
151 RemoveExpiredInvites();
155 bool LocalUser::RemoveInvite(Channel* chan)
157 Invitation* inv = Invitation::Find(chan, this);
167 void LocalUser::RemoveExpiredInvites()
169 Invitation::Find(NULL, this);
172 bool User::HasModePermission(unsigned char, ModeType)
177 bool LocalUser::HasModePermission(unsigned char mode, ModeType type)
182 if (mode < 'A' || mode > ('A' + 64)) return false;
184 return ((type == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
188 * users on remote servers can completely bypass all permissions based checks.
189 * This prevents desyncs when one server has different type/class tags to another.
190 * That having been said, this does open things up to the possibility of source changes
191 * allowing remote kills, etc - but if they have access to the src, they most likely have
192 * access to the conf - so it's an end to a means either way.
194 bool User::HasPermission(const std::string&)
199 bool LocalUser::HasPermission(const std::string &command)
201 // are they even an oper at all?
207 if (oper->AllowedOperCommands.find(command) != oper->AllowedOperCommands.end())
209 else if (oper->AllowedOperCommands.find("*") != oper->AllowedOperCommands.end())
215 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
220 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
225 this->WriteNotice("You are not an oper");
229 if (oper->AllowedPrivs.find(privstr) != oper->AllowedPrivs.end())
233 else if (oper->AllowedPrivs.find("*") != oper->AllowedPrivs.end())
239 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
244 void UserIOHandler::OnDataReady()
249 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
251 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
252 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
253 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
256 unsigned long sendqmax = ULONG_MAX;
257 if (!user->HasPrivPermission("users/flood/increased-buffers"))
258 sendqmax = user->MyClass->GetSendqSoftMax();
259 unsigned long penaltymax = ULONG_MAX;
260 if (!user->HasPrivPermission("users/flood/no-fakelag"))
261 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
263 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
266 line.reserve(ServerInstance->Config->Limits.MaxLine);
267 std::string::size_type qpos = 0;
268 while (qpos < recvq.length())
270 char c = recvq[qpos++];
281 if (line.length() < ServerInstance->Config->Limits.MaxLine - 2)
284 // if we got here, the recvq ran out before we found a newline
287 // just found a newline. Terminate the string, and pull it out of recvq
288 recvq = recvq.substr(qpos);
290 // TODO should this be moved to when it was inserted in recvq?
291 ServerInstance->stats->statsRecv += qpos;
292 user->bytes_in += qpos;
295 ServerInstance->Parser->ProcessBuffer(line, user);
299 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
300 ServerInstance->Users->QuitUser(user, "Excess Flood");
303 void UserIOHandler::AddWriteBuf(const std::string &data)
305 if (user->quitting_sendq)
307 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
308 !user->HasPrivPermission("users/flood/increased-buffers"))
310 user->quitting_sendq = true;
311 ServerInstance->GlobalCulls.AddSQItem(user);
315 // We still want to append data to the sendq of a quitting user,
316 // e.g. their ERROR message that says 'closing link'
321 void UserIOHandler::OnError(BufferedSocketError)
323 ServerInstance->Users->QuitUser(user, getError());
326 CullResult User::cull()
329 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
330 PurgeEmptyChannels();
332 if (client_sa.sa.sa_family != AF_UNSPEC)
333 ServerInstance->Users->RemoveCloneCounts(this);
335 return Extensible::cull();
338 CullResult LocalUser::cull()
340 // The iterator is initialized to local_users.end() in the constructor. It is
341 // overwritten in UserManager::AddUser() with the real iterator so this check
342 // is only a precaution currently.
343 if (localuseriter != ServerInstance->Users->local_users.end())
345 ServerInstance->Users->local_count--;
346 ServerInstance->Users->local_users.erase(localuseriter);
349 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: LocalUserIter does not point to a valid entry for " + this->nick);
356 CullResult FakeUser::cull()
358 // Fake users don't quit, they just get culled.
360 // Fake users are not inserted into UserManager::clientlist, they're only in the uuidlist
361 ServerInstance->Users->uuidlist->erase(uuid);
365 void User::Oper(OperInfo* info)
367 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
368 if (this->IsModeSet(opermh))
371 this->SetMode(opermh, true);
373 this->WriteServ("MODE %s :+o", this->nick.c_str());
374 FOREACH_MOD(OnOper, (this, info->name));
376 std::string opername;
377 if (info->oper_block)
378 opername = info->oper_block->getString("name");
382 LocalUser* l = IS_LOCAL(this);
383 std::string vhost = oper->getConfig("vhost");
385 l->ChangeDisplayedHost(vhost.c_str());
386 std::string opClass = oper->getConfig("class");
387 if (!opClass.empty())
388 l->SetClass(opClass);
391 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
392 nick.c_str(), ident.c_str(), host.c_str(), oper->name.c_str(), opername.c_str());
393 this->WriteNumeric(RPL_YOUAREOPER, ":You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str());
395 ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
396 ServerInstance->Users->all_opers.push_back(this);
398 // Expand permissions from config for faster lookup
402 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
405 void OperInfo::init()
407 AllowedOperCommands.clear();
408 AllowedPrivs.clear();
409 AllowedUserModes.reset();
410 AllowedChanModes.reset();
411 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
413 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
415 ConfigTag* tag = *iter;
416 std::string mycmd, mypriv;
417 /* Process commands */
418 irc::spacesepstream CommandList(tag->getString("commands"));
419 while (CommandList.GetToken(mycmd))
421 AllowedOperCommands.insert(mycmd);
424 irc::spacesepstream PrivList(tag->getString("privs"));
425 while (PrivList.GetToken(mypriv))
427 AllowedPrivs.insert(mypriv);
430 std::string modes = tag->getString("usermodes");
431 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
435 this->AllowedUserModes.set();
437 else if (*c >= 'A' && *c < 'z')
439 this->AllowedUserModes[*c - 'A'] = true;
443 modes = tag->getString("chanmodes");
444 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
448 this->AllowedChanModes.set();
450 else if (*c >= 'A' && *c < 'z')
452 this->AllowedChanModes[*c - 'A'] = true;
464 * unset their oper type (what IS_OPER checks).
465 * note, order is important - this must come before modes as -o attempts
466 * to call UnOper. -- w00t
471 /* Remove all oper only modes from the user when the deoper - Bug #466*/
472 std::string moderemove("-");
474 for (unsigned char letter = 'A'; letter <= 'z'; letter++)
476 ModeHandler* mh = ServerInstance->Modes->FindMode(letter, MODETYPE_USER);
477 if (mh && mh->NeedsOper())
478 moderemove += letter;
482 std::vector<std::string> parameters;
483 parameters.push_back(this->nick);
484 parameters.push_back(moderemove);
486 ServerInstance->Modes->Process(parameters, this);
488 /* remove the user from the oper list. Will remove multiple entries as a safeguard against bug #404 */
489 ServerInstance->Users->all_opers.remove(this);
491 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
492 this->SetMode(opermh, false);
496 * Check class restrictions
498 void LocalUser::CheckClass(bool clone_count)
500 ConnectClass* a = this->MyClass;
504 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
507 else if (a->type == CC_DENY)
509 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
512 else if (clone_count)
514 if ((a->GetMaxLocal()) && (ServerInstance->Users->LocalCloneCount(this) > a->GetMaxLocal()))
516 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
518 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
521 else if ((a->GetMaxGlobal()) && (ServerInstance->Users->GlobalCloneCount(this) > a->GetMaxGlobal()))
523 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
525 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
530 this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout;
533 bool LocalUser::CheckLines(bool doZline)
535 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
539 for (int n = 0; check[n]; ++n)
541 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
554 void LocalUser::FullConnect()
556 ServerInstance->stats->statsConnects++;
557 this->idle_lastmsg = ServerInstance->Time();
560 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
561 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
562 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
563 * Don't remove this! -- w00t
573 this->WriteNumeric(RPL_WELCOME, ":Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str());
574 this->WriteNumeric(RPL_YOURHOSTIS, ":Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), BRANCH);
575 this->WriteNumeric(RPL_SERVERCREATED, ":This server was created %s %s", __TIME__, __DATE__);
577 const std::string& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
578 this->WriteNumeric(RPL_SERVERVERSION, "%s %s %s", ServerInstance->Config->ServerName.c_str(), BRANCH, modelist.c_str());
580 ServerInstance->ISupport.SendTo(this);
583 if (ServerInstance->Users->unregistered_count)
584 ServerInstance->Users->unregistered_count--;
586 /* Trigger MOTD and LUSERS output, give modules a chance too */
587 ModResult MOD_RESULT;
588 std::string command("LUSERS");
589 std::vector<std::string> parameters;
590 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
592 ServerInstance->Parser->CallHandler(command, parameters, this);
594 MOD_RESULT = MOD_RES_PASSTHRU;
596 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
598 ServerInstance->Parser->CallHandler(command, parameters, this);
600 if (ServerInstance->Config->RawLog)
601 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
604 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
605 * for a user that doesn't exist yet.
607 FOREACH_MOD(OnUserConnect, (this));
609 this->registered = REG_ALL;
611 FOREACH_MOD(OnPostConnect, (this));
613 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
614 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
615 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
616 ServerInstance->BanCache->AddHit(this->GetIPString(), "", "");
617 // reset the flood penalty (which could have been raised due to things like auto +x)
618 CommandFloodPenalty = 0;
621 void User::InvalidateCache()
623 /* Invalidate cache */
624 cached_fullhost.clear();
625 cached_hostip.clear();
626 cached_makehost.clear();
627 cached_fullrealhost.clear();
630 bool User::ChangeNick(const std::string& newnick, bool force)
634 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
640 ModResult MOD_RESULT;
641 FIRST_MOD_RESULT(OnUserPreNick, MOD_RESULT, (this, newnick));
643 if (MOD_RESULT == MOD_RES_DENY)
645 ServerInstance->stats->statsCollisions++;
650 if (assign(newnick) == assign(nick))
652 // case change, don't need to check Q:lines and such
653 // and, if it's identical including case, we can leave right now
660 * Don't check Q:Lines if it's a server-enforced change, just on the off-chance some fucking *moron*
661 * tries to Q:Line SIDs, also, this means we just get our way period, as it really should be.
662 * Thanks Kein for finding this. -- w00t
664 * Also don't check Q:Lines for remote nickchanges, they should have our Q:Lines anyway to enforce themselves.
667 if (IS_LOCAL(this) && !force)
669 XLine* mq = ServerInstance->XLines->MatchesLine("Q",newnick);
672 if (this->registered == REG_ALL)
674 ServerInstance->SNO->WriteGlobalSno('a', "Q-Lined nickname %s from %s: %s",
675 newnick.c_str(), GetFullRealHost().c_str(), mq->reason.c_str());
677 this->WriteNumeric(ERR_ERRONEUSNICKNAME, "%s :Invalid nickname: %s", newnick.c_str(), mq->reason.c_str());
681 if (ServerInstance->Config->RestrictBannedUsers)
683 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
686 if (chan->GetPrefixValue(this) < VOICE_VALUE && chan->IsBanned(this))
688 this->WriteNumeric(ERR_CANNOTSENDTOCHAN, "%s :Cannot send to channel (you're banned)", chan->name.c_str());
696 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
697 * then we have a potential collide. Check whether someone else is camping on the nick
698 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
699 * camper to their UID, and allow the incoming nick change.
701 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
702 * because the nick is already (rightfully) in use. -- w00t
704 User* InUse = ServerInstance->FindNickOnly(newnick);
705 if (InUse && (InUse != this))
707 if (InUse->registered != REG_ALL)
709 /* force the camper to their UUID, and ask them to re-send a NICK. */
710 InUse->WriteTo(InUse, "NICK %s", InUse->uuid.c_str());
711 InUse->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname overruled.", InUse->nick.c_str());
713 ServerInstance->Users->clientlist->erase(InUse->nick);
714 (*(ServerInstance->Users->clientlist))[InUse->uuid] = InUse;
716 InUse->nick = InUse->uuid;
717 InUse->InvalidateCache();
718 InUse->registered &= ~REG_NICK;
722 /* No camping, tell the incoming user to stop trying to change nick ;p */
723 this->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname is already in use.", newnick.c_str());
729 if (this->registered == REG_ALL)
730 this->WriteCommon("NICK %s",newnick.c_str());
731 std::string oldnick = nick;
735 ServerInstance->Users->clientlist->erase(oldnick);
736 (*(ServerInstance->Users->clientlist))[newnick] = this;
738 if (registered == REG_ALL)
739 FOREACH_MOD(OnUserPostNick, (this,oldnick));
744 int LocalUser::GetServerPort()
746 switch (this->server_sa.sa.sa_family)
749 return htons(this->server_sa.in6.sin6_port);
751 return htons(this->server_sa.in4.sin_port);
756 const std::string& User::GetIPString()
759 if (cachedip.empty())
761 irc::sockets::satoap(client_sa, cachedip, port);
762 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
763 if (cachedip[0] == ':')
764 cachedip.insert(cachedip.begin(),1,'0');
770 irc::sockets::cidr_mask User::GetCIDRMask()
773 switch (client_sa.sa.sa_family)
776 range = ServerInstance->Config->c_ipv6_range;
779 range = ServerInstance->Config->c_ipv4_range;
782 return irc::sockets::cidr_mask(client_sa, range);
785 bool User::SetClientIP(const char* sip, bool recheck_eline)
788 cached_hostip.clear();
789 return irc::sockets::aptosa(sip, 0, client_sa);
792 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
795 cached_hostip.clear();
796 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
799 bool LocalUser::SetClientIP(const char* sip, bool recheck_eline)
801 irc::sockets::sockaddrs sa;
802 if (!irc::sockets::aptosa(sip, 0, sa))
806 LocalUser::SetClientIP(sa, recheck_eline);
810 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
814 User::SetClientIP(sa);
816 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
818 FOREACH_MOD(OnSetUserIP, (this));
822 static std::string wide_newline("\r\n");
824 void User::Write(const std::string& text)
828 void User::Write(const char *text, ...)
832 void LocalUser::Write(const std::string& text)
834 if (!ServerInstance->SE->BoundsCheckFd(&eh))
837 if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
839 // this should happen rarely or never. Crop the string at 512 and try again.
840 std::string try_again = text.substr(0, ServerInstance->Config->Limits.MaxLine - 2);
845 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
847 eh.AddWriteBuf(text);
848 eh.AddWriteBuf(wide_newline);
850 ServerInstance->stats->statsSent += text.length() + 2;
851 this->bytes_out += text.length() + 2;
857 void LocalUser::Write(const char *text, ...)
859 std::string textbuffer;
860 VAFORMAT(textbuffer, text, text);
861 this->Write(textbuffer);
864 void User::WriteServ(const std::string& text)
866 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
870 * Same as Write(), except `text' is prefixed with `:server.name '.
872 void User::WriteServ(const char* text, ...)
874 std::string textbuffer;
875 VAFORMAT(textbuffer, text, text);
876 this->WriteServ(textbuffer);
879 void User::WriteNotice(const std::string& text)
881 this->WriteServ("NOTICE " + (this->registered == REG_ALL ? this->nick : "*") + " :" + text);
884 void User::WriteNumeric(unsigned int numeric, const char* text, ...)
886 std::string textbuffer;
887 VAFORMAT(textbuffer, text, text);
888 this->WriteNumeric(numeric, textbuffer);
891 void User::WriteNumeric(unsigned int numeric, const std::string &text)
893 ModResult MOD_RESULT;
895 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric, text));
897 if (MOD_RESULT == MOD_RES_DENY)
900 const std::string message = InspIRCd::Format(":%s %03u %s %s", ServerInstance->Config->ServerName.c_str(),
901 numeric, !this->nick.empty() ? this->nick.c_str() : "*", text.c_str());
902 this->Write(message);
905 void User::WriteFrom(User *user, const std::string &text)
907 const std::string message = ":" + user->GetFullHost() + " " + text;
908 this->Write(message);
912 /* write text from an originating user to originating user */
914 void User::WriteFrom(User *user, const char* text, ...)
916 std::string textbuffer;
917 VAFORMAT(textbuffer, text, text);
918 this->WriteFrom(user, textbuffer);
922 /* write text to an destination user from a source user (e.g. user privmsg) */
924 void User::WriteTo(User *dest, const char *data, ...)
926 std::string textbuffer;
927 VAFORMAT(textbuffer, data, data);
928 this->WriteTo(dest, textbuffer);
931 void User::WriteTo(User *dest, const std::string &data)
933 dest->WriteFrom(this, data);
936 void User::WriteCommon(const char* text, ...)
938 if (this->registered != REG_ALL || quitting)
941 std::string textbuffer;
942 VAFORMAT(textbuffer, text, text);
943 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
944 this->WriteCommonRaw(textbuffer, true);
947 void User::WriteCommonExcept(const char* text, ...)
949 if (this->registered != REG_ALL || quitting)
952 std::string textbuffer;
953 VAFORMAT(textbuffer, text, text);
954 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
955 this->WriteCommonRaw(textbuffer, false);
958 void User::WriteCommonRaw(const std::string &line, bool include_self)
960 if (this->registered != REG_ALL || quitting)
963 LocalUser::already_sent_id++;
965 UserChanList include_c(chans);
966 std::map<User*,bool> exceptions;
968 exceptions[this] = include_self;
970 FOREACH_MOD(OnBuildNeighborList, (this, include_c, exceptions));
972 for (std::map<User*,bool>::iterator i = exceptions.begin(); i != exceptions.end(); ++i)
974 LocalUser* u = IS_LOCAL(i->first);
975 if (u && !u->quitting)
977 u->already_sent = LocalUser::already_sent_id;
982 for (UCListIter v = include_c.begin(); v != include_c.end(); ++v)
985 const UserMembList* ulist = c->GetUsers();
986 for (UserMembList::const_iterator i = ulist->begin(); i != ulist->end(); i++)
988 LocalUser* u = IS_LOCAL(i->first);
989 if (u && !u->quitting && u->already_sent != LocalUser::already_sent_id)
991 u->already_sent = LocalUser::already_sent_id;
998 void User::WriteCommonQuit(const std::string &normal_text, const std::string &oper_text)
1000 if (this->registered != REG_ALL)
1003 already_sent_t uniq_id = ++LocalUser::already_sent_id;
1005 const std::string normalMessage = ":" + this->GetFullHost() + " QUIT :" + normal_text;
1006 const std::string operMessage = ":" + this->GetFullHost() + " QUIT :" + oper_text;
1008 UserChanList include_c(chans);
1009 std::map<User*,bool> exceptions;
1011 FOREACH_MOD(OnBuildNeighborList, (this, include_c, exceptions));
1013 for (std::map<User*,bool>::iterator i = exceptions.begin(); i != exceptions.end(); ++i)
1015 LocalUser* u = IS_LOCAL(i->first);
1016 if (u && !u->quitting)
1018 u->already_sent = uniq_id;
1020 u->Write(u->IsOper() ? operMessage : normalMessage);
1023 for (UCListIter v = include_c.begin(); v != include_c.end(); ++v)
1025 const UserMembList* ulist = (*v)->GetUsers();
1026 for (UserMembList::const_iterator i = ulist->begin(); i != ulist->end(); i++)
1028 LocalUser* u = IS_LOCAL(i->first);
1029 if (u && !u->quitting && (u->already_sent != uniq_id))
1031 u->already_sent = uniq_id;
1032 u->Write(u->IsOper() ? operMessage : normalMessage);
1038 void LocalUser::SendText(const std::string& line)
1043 void RemoteUser::SendText(const std::string& line)
1045 ServerInstance->PI->PushToClient(this, line);
1048 void FakeUser::SendText(const std::string& line)
1052 void User::SendText(const char *text, ...)
1055 VAFORMAT(line, text, text);
1059 void User::SendText(const std::string& linePrefix, std::stringstream& textStream)
1063 while (textStream >> word)
1065 size_t lineLength = linePrefix.length() + line.length() + word.length() + 3; // "\s\n\r"
1066 if (lineLength > ServerInstance->Config->Limits.MaxLine)
1068 SendText(linePrefix + line);
1073 SendText(linePrefix + line);
1076 /* return 0 or 1 depending if users u and u2 share one or more common channels
1077 * (used by QUIT, NICK etc which arent channel specific notices)
1079 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
1080 * the first users channels then the second users channels within the outer loop,
1081 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
1082 * all possible iterations). However this new function instead checks against the
1083 * channel's userlist in the inner loop which is a std::map<User*,User*>
1084 * and saves us time as we already know what pointer value we are after.
1085 * Don't quote me on the maths as i am not a mathematician or computer scientist,
1086 * but i believe this algorithm is now x+(log y) maximum iterations instead.
1088 bool User::SharesChannelWith(User *other)
1090 if ((this->registered != REG_ALL) || (other->registered != REG_ALL))
1094 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1096 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
1097 * by replacing it with a map::find which *should* be more efficient
1099 if ((*i)->HasUser(other))
1105 bool User::ChangeName(const std::string& gecos)
1107 if (!this->fullname.compare(gecos))
1112 ModResult MOD_RESULT;
1113 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
1114 if (MOD_RESULT == MOD_RES_DENY)
1116 FOREACH_MOD(OnChangeName, (this,gecos));
1118 this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1123 bool User::ChangeDisplayedHost(const std::string& shost)
1130 ModResult MOD_RESULT;
1131 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1132 if (MOD_RESULT == MOD_RES_DENY)
1136 FOREACH_MOD(OnChangeHost, (this,shost));
1138 this->dhost.assign(shost, 0, 64);
1139 this->InvalidateCache();
1142 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, "%s :is now your displayed host", this->dhost.c_str());
1147 bool User::ChangeIdent(const std::string& newident)
1149 if (this->ident == newident)
1152 FOREACH_MOD(OnChangeIdent, (this,newident));
1154 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1155 this->InvalidateCache();
1160 void User::SendAll(const char* command, const char* text, ...)
1162 std::string textbuffer;
1163 VAFORMAT(textbuffer, text, text);
1164 const std::string message = ":" + this->GetFullHost() + " " + command + " $* :" + textbuffer;
1166 for (LocalUserList::const_iterator i = ServerInstance->Users->local_users.begin(); i != ServerInstance->Users->local_users.end(); i++)
1168 if ((*i)->registered == REG_ALL)
1169 (*i)->Write(message);
1174 * Sets a user's connection class.
1175 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1176 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1177 * then their ip will be taken as 'priority' anyway, so for example,
1178 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1180 void LocalUser::SetClass(const std::string &explicit_name)
1182 ConnectClass *found = NULL;
1184 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1186 if (!explicit_name.empty())
1188 for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1190 ConnectClass* c = *i;
1192 if (explicit_name == c->name)
1194 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1201 for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1203 ConnectClass* c = *i;
1204 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1206 ModResult MOD_RESULT;
1207 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1208 if (MOD_RESULT == MOD_RES_DENY)
1210 if (MOD_RESULT == MOD_RES_ALLOW)
1212 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1217 if (c->type == CC_NAMED)
1220 bool regdone = (registered != REG_NONE);
1221 if (c->config->getBool("registered", regdone) != regdone)
1224 /* check if host matches.. */
1225 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1226 !InspIRCd::MatchCIDR(this->host, c->GetHost(), NULL))
1228 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1233 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1234 * because we should attempt to find another class if this one doesn't match us. -- w00t
1236 if (c->limit && (c->GetReferenceCount() >= c->limit))
1238 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1242 /* if it requires a port ... */
1243 int port = c->config->getInt("port");
1246 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires port (%d)", port);
1248 /* and our port doesn't match, fail. */
1249 if (this->GetServerPort() != port)
1253 if (regdone && !c->config->getString("password").empty())
1255 if (ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1257 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1262 /* we stop at the first class that meets ALL critera. */
1269 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1277 void User::PurgeEmptyChannels()
1279 // firstly decrement the count on each channel
1280 for (UCListIter f = this->chans.begin(); f != this->chans.end(); f++)
1289 const std::string& FakeUser::GetFullHost()
1291 if (!ServerInstance->Config->HideWhoisServer.empty())
1292 return ServerInstance->Config->HideWhoisServer;
1293 return server->GetName();
1296 const std::string& FakeUser::GetFullRealHost()
1298 if (!ServerInstance->Config->HideWhoisServer.empty())
1299 return ServerInstance->Config->HideWhoisServer;
1300 return server->GetName();
1303 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1304 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1305 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1306 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(0),
1307 limit(0), resolvehostnames(true)
1311 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1312 : config(tag), type(t), fakelag(parent.fakelag), name("unnamed"),
1313 registration_timeout(parent.registration_timeout), host(mask), pingtime(parent.pingtime),
1314 softsendqmax(parent.softsendqmax), hardsendqmax(parent.hardsendqmax), recvqmax(parent.recvqmax),
1315 penaltythreshold(parent.penaltythreshold), commandrate(parent.commandrate),
1316 maxlocal(parent.maxlocal), maxglobal(parent.maxglobal), maxconnwarn(parent.maxconnwarn), maxchans(parent.maxchans),
1317 limit(parent.limit), resolvehostnames(parent.resolvehostnames)
1321 void ConnectClass::Update(const ConnectClass* src)
1323 config = src->config;
1325 fakelag = src->fakelag;
1327 registration_timeout = src->registration_timeout;
1329 pingtime = src->pingtime;
1330 softsendqmax = src->softsendqmax;
1331 hardsendqmax = src->hardsendqmax;
1332 recvqmax = src->recvqmax;
1333 penaltythreshold = src->penaltythreshold;
1334 commandrate = src->commandrate;
1335 maxlocal = src->maxlocal;
1336 maxglobal = src->maxglobal;
1337 maxconnwarn = src->maxconnwarn;
1338 maxchans = src->maxchans;
1340 resolvehostnames = src->resolvehostnames;