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 bytes_in(0), bytes_out(0), cmds_in(0), cmds_out(0), nping(0), CommandFloodPenalty(0),
92 exempt = quitting_sendq = false;
97 memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
98 memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
99 dhost = host = GetIPString();
104 if (ServerInstance->Users->uuidlist->find(uuid) != ServerInstance->Users->uuidlist->end())
105 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "User destructor for %s called without cull", uuid.c_str());
108 const std::string& User::MakeHost()
110 if (!this->cached_makehost.empty())
111 return this->cached_makehost;
113 // XXX: Is there really a need to cache this?
114 this->cached_makehost = ident + "@" + host;
115 return this->cached_makehost;
118 const std::string& User::MakeHostIP()
120 if (!this->cached_hostip.empty())
121 return this->cached_hostip;
123 // XXX: Is there really a need to cache this?
124 this->cached_hostip = ident + "@" + this->GetIPString();
125 return this->cached_hostip;
128 const std::string& User::GetFullHost()
130 if (!this->cached_fullhost.empty())
131 return this->cached_fullhost;
133 // XXX: Is there really a need to cache this?
134 this->cached_fullhost = nick + "!" + ident + "@" + dhost;
135 return this->cached_fullhost;
138 const std::string& User::GetFullRealHost()
140 if (!this->cached_fullrealhost.empty())
141 return this->cached_fullrealhost;
143 // XXX: Is there really a need to cache this?
144 this->cached_fullrealhost = nick + "!" + ident + "@" + host;
145 return this->cached_fullrealhost;
148 InviteList& LocalUser::GetInviteList()
150 RemoveExpiredInvites();
154 bool LocalUser::RemoveInvite(Channel* chan)
156 Invitation* inv = Invitation::Find(chan, this);
166 void LocalUser::RemoveExpiredInvites()
168 Invitation::Find(NULL, this);
171 bool User::HasModePermission(unsigned char, ModeType)
176 bool LocalUser::HasModePermission(unsigned char mode, ModeType type)
181 if (mode < 'A' || mode > ('A' + 64)) return false;
183 return ((type == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
187 * users on remote servers can completely bypass all permissions based checks.
188 * This prevents desyncs when one server has different type/class tags to another.
189 * That having been said, this does open things up to the possibility of source changes
190 * allowing remote kills, etc - but if they have access to the src, they most likely have
191 * access to the conf - so it's an end to a means either way.
193 bool User::HasPermission(const std::string&)
198 bool LocalUser::HasPermission(const std::string &command)
200 // are they even an oper at all?
206 if (oper->AllowedOperCommands.find(command) != oper->AllowedOperCommands.end())
208 else if (oper->AllowedOperCommands.find("*") != oper->AllowedOperCommands.end())
214 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
219 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
224 this->WriteNotice("You are not an oper");
228 if (oper->AllowedPrivs.find(privstr) != oper->AllowedPrivs.end())
232 else if (oper->AllowedPrivs.find("*") != oper->AllowedPrivs.end())
238 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
243 void UserIOHandler::OnDataReady()
248 if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
250 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
251 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
252 user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
255 unsigned long sendqmax = ULONG_MAX;
256 if (!user->HasPrivPermission("users/flood/increased-buffers"))
257 sendqmax = user->MyClass->GetSendqSoftMax();
258 unsigned long penaltymax = ULONG_MAX;
259 if (!user->HasPrivPermission("users/flood/no-fakelag"))
260 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
262 while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
265 line.reserve(ServerInstance->Config->Limits.MaxLine);
266 std::string::size_type qpos = 0;
267 while (qpos < recvq.length())
269 char c = recvq[qpos++];
280 if (line.length() < ServerInstance->Config->Limits.MaxLine - 2)
283 // if we got here, the recvq ran out before we found a newline
286 // just found a newline. Terminate the string, and pull it out of recvq
287 recvq = recvq.substr(qpos);
289 // TODO should this be moved to when it was inserted in recvq?
290 ServerInstance->stats->statsRecv += qpos;
291 user->bytes_in += qpos;
294 ServerInstance->Parser->ProcessBuffer(line, user);
298 if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
299 ServerInstance->Users->QuitUser(user, "Excess Flood");
302 void UserIOHandler::AddWriteBuf(const std::string &data)
304 if (user->quitting_sendq)
306 if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
307 !user->HasPrivPermission("users/flood/increased-buffers"))
309 user->quitting_sendq = true;
310 ServerInstance->GlobalCulls.AddSQItem(user);
314 // We still want to append data to the sendq of a quitting user,
315 // e.g. their ERROR message that says 'closing link'
320 void UserIOHandler::OnError(BufferedSocketError)
322 ServerInstance->Users->QuitUser(user, getError());
325 CullResult User::cull()
328 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
329 PurgeEmptyChannels();
331 if (client_sa.sa.sa_family != AF_UNSPEC)
332 ServerInstance->Users->RemoveCloneCounts(this);
334 return Extensible::cull();
337 CullResult LocalUser::cull()
339 ServerInstance->Users->local_users.erase(this);
345 CullResult FakeUser::cull()
347 // Fake users don't quit, they just get culled.
349 // Fake users are not inserted into UserManager::clientlist, they're only in the uuidlist
350 ServerInstance->Users->uuidlist->erase(uuid);
354 void User::Oper(OperInfo* info)
356 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
357 if (this->IsModeSet(opermh))
360 this->SetMode(opermh, true);
362 this->WriteServ("MODE %s :+o", this->nick.c_str());
363 FOREACH_MOD(OnOper, (this, info->name));
365 std::string opername;
366 if (info->oper_block)
367 opername = info->oper_block->getString("name");
371 LocalUser* l = IS_LOCAL(this);
372 std::string vhost = oper->getConfig("vhost");
374 l->ChangeDisplayedHost(vhost.c_str());
375 std::string opClass = oper->getConfig("class");
376 if (!opClass.empty())
377 l->SetClass(opClass);
380 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
381 nick.c_str(), ident.c_str(), host.c_str(), oper->name.c_str(), opername.c_str());
382 this->WriteNumeric(RPL_YOUAREOPER, ":You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str());
384 ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
385 ServerInstance->Users->all_opers.push_back(this);
387 // Expand permissions from config for faster lookup
391 FOREACH_MOD(OnPostOper, (this, oper->name, opername));
394 void OperInfo::init()
396 AllowedOperCommands.clear();
397 AllowedPrivs.clear();
398 AllowedUserModes.reset();
399 AllowedChanModes.reset();
400 AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
402 for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
404 ConfigTag* tag = *iter;
405 std::string mycmd, mypriv;
406 /* Process commands */
407 irc::spacesepstream CommandList(tag->getString("commands"));
408 while (CommandList.GetToken(mycmd))
410 AllowedOperCommands.insert(mycmd);
413 irc::spacesepstream PrivList(tag->getString("privs"));
414 while (PrivList.GetToken(mypriv))
416 AllowedPrivs.insert(mypriv);
419 std::string modes = tag->getString("usermodes");
420 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
424 this->AllowedUserModes.set();
426 else if (*c >= 'A' && *c < 'z')
428 this->AllowedUserModes[*c - 'A'] = true;
432 modes = tag->getString("chanmodes");
433 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
437 this->AllowedChanModes.set();
439 else if (*c >= 'A' && *c < 'z')
441 this->AllowedChanModes[*c - 'A'] = true;
453 * unset their oper type (what IS_OPER checks).
454 * note, order is important - this must come before modes as -o attempts
455 * to call UnOper. -- w00t
460 /* Remove all oper only modes from the user when the deoper - Bug #466*/
461 std::string moderemove("-");
463 for (unsigned char letter = 'A'; letter <= 'z'; letter++)
465 ModeHandler* mh = ServerInstance->Modes->FindMode(letter, MODETYPE_USER);
466 if (mh && mh->NeedsOper())
467 moderemove += letter;
471 std::vector<std::string> parameters;
472 parameters.push_back(this->nick);
473 parameters.push_back(moderemove);
475 ServerInstance->Modes->Process(parameters, this);
477 /* remove the user from the oper list. Will remove multiple entries as a safeguard against bug #404 */
478 ServerInstance->Users->all_opers.remove(this);
480 ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
481 this->SetMode(opermh, false);
485 * Check class restrictions
487 void LocalUser::CheckClass(bool clone_count)
489 ConnectClass* a = this->MyClass;
493 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
496 else if (a->type == CC_DENY)
498 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
501 else if (clone_count)
503 if ((a->GetMaxLocal()) && (ServerInstance->Users->LocalCloneCount(this) > a->GetMaxLocal()))
505 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
507 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
510 else if ((a->GetMaxGlobal()) && (ServerInstance->Users->GlobalCloneCount(this) > a->GetMaxGlobal()))
512 ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
514 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
519 this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout;
522 bool LocalUser::CheckLines(bool doZline)
524 const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
528 for (int n = 0; check[n]; ++n)
530 XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
543 void LocalUser::FullConnect()
545 ServerInstance->stats->statsConnects++;
546 this->idle_lastmsg = ServerInstance->Time();
549 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
550 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
551 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
552 * Don't remove this! -- w00t
562 this->WriteNumeric(RPL_WELCOME, ":Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str());
563 this->WriteNumeric(RPL_YOURHOSTIS, ":Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), BRANCH);
564 this->WriteNumeric(RPL_SERVERCREATED, ":This server was created %s %s", __TIME__, __DATE__);
566 const std::string& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
567 this->WriteNumeric(RPL_SERVERVERSION, "%s %s %s", ServerInstance->Config->ServerName.c_str(), BRANCH, modelist.c_str());
569 ServerInstance->ISupport.SendTo(this);
572 if (ServerInstance->Users->unregistered_count)
573 ServerInstance->Users->unregistered_count--;
575 /* Trigger MOTD and LUSERS output, give modules a chance too */
576 ModResult MOD_RESULT;
577 std::string command("LUSERS");
578 std::vector<std::string> parameters;
579 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
581 ServerInstance->Parser->CallHandler(command, parameters, this);
583 MOD_RESULT = MOD_RES_PASSTHRU;
585 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
587 ServerInstance->Parser->CallHandler(command, parameters, this);
589 if (ServerInstance->Config->RawLog)
590 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
593 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
594 * for a user that doesn't exist yet.
596 FOREACH_MOD(OnUserConnect, (this));
598 this->registered = REG_ALL;
600 FOREACH_MOD(OnPostConnect, (this));
602 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
603 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
604 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
605 ServerInstance->BanCache->AddHit(this->GetIPString(), "", "");
606 // reset the flood penalty (which could have been raised due to things like auto +x)
607 CommandFloodPenalty = 0;
610 void User::InvalidateCache()
612 /* Invalidate cache */
613 cached_fullhost.clear();
614 cached_hostip.clear();
615 cached_makehost.clear();
616 cached_fullrealhost.clear();
619 bool User::ChangeNick(const std::string& newnick, bool force)
623 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
629 ModResult MOD_RESULT;
630 FIRST_MOD_RESULT(OnUserPreNick, MOD_RESULT, (this, newnick));
632 if (MOD_RESULT == MOD_RES_DENY)
634 ServerInstance->stats->statsCollisions++;
639 if (assign(newnick) == assign(nick))
641 // case change, don't need to check Q:lines and such
642 // and, if it's identical including case, we can leave right now
649 * Don't check Q:Lines if it's a server-enforced change, just on the off-chance some fucking *moron*
650 * tries to Q:Line SIDs, also, this means we just get our way period, as it really should be.
651 * Thanks Kein for finding this. -- w00t
653 * Also don't check Q:Lines for remote nickchanges, they should have our Q:Lines anyway to enforce themselves.
656 if (IS_LOCAL(this) && !force)
658 XLine* mq = ServerInstance->XLines->MatchesLine("Q",newnick);
661 if (this->registered == REG_ALL)
663 ServerInstance->SNO->WriteGlobalSno('a', "Q-Lined nickname %s from %s: %s",
664 newnick.c_str(), GetFullRealHost().c_str(), mq->reason.c_str());
666 this->WriteNumeric(ERR_ERRONEUSNICKNAME, "%s :Invalid nickname: %s", newnick.c_str(), mq->reason.c_str());
670 if (ServerInstance->Config->RestrictBannedUsers)
672 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
674 Channel* chan = (*i)->chan;
675 if (chan->GetPrefixValue(this) < VOICE_VALUE && chan->IsBanned(this))
677 this->WriteNumeric(ERR_CANNOTSENDTOCHAN, "%s :Cannot send to channel (you're banned)", chan->name.c_str());
685 * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
686 * then we have a potential collide. Check whether someone else is camping on the nick
687 * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
688 * camper to their UID, and allow the incoming nick change.
690 * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
691 * because the nick is already (rightfully) in use. -- w00t
693 User* InUse = ServerInstance->FindNickOnly(newnick);
694 if (InUse && (InUse != this))
696 if (InUse->registered != REG_ALL)
698 /* force the camper to their UUID, and ask them to re-send a NICK. */
699 InUse->WriteTo(InUse, "NICK %s", InUse->uuid.c_str());
700 InUse->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname overruled.", InUse->nick.c_str());
702 ServerInstance->Users->clientlist->erase(InUse->nick);
703 (*(ServerInstance->Users->clientlist))[InUse->uuid] = InUse;
705 InUse->nick = InUse->uuid;
706 InUse->InvalidateCache();
707 InUse->registered &= ~REG_NICK;
711 /* No camping, tell the incoming user to stop trying to change nick ;p */
712 this->WriteNumeric(ERR_NICKNAMEINUSE, "%s :Nickname is already in use.", newnick.c_str());
718 if (this->registered == REG_ALL)
719 this->WriteCommon("NICK %s",newnick.c_str());
720 std::string oldnick = nick;
724 ServerInstance->Users->clientlist->erase(oldnick);
725 (*(ServerInstance->Users->clientlist))[newnick] = this;
727 if (registered == REG_ALL)
728 FOREACH_MOD(OnUserPostNick, (this,oldnick));
733 int LocalUser::GetServerPort()
735 switch (this->server_sa.sa.sa_family)
738 return htons(this->server_sa.in6.sin6_port);
740 return htons(this->server_sa.in4.sin_port);
745 const std::string& User::GetIPString()
748 if (cachedip.empty())
750 irc::sockets::satoap(client_sa, cachedip, port);
751 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
752 if (cachedip[0] == ':')
753 cachedip.insert(cachedip.begin(),1,'0');
759 irc::sockets::cidr_mask User::GetCIDRMask()
762 switch (client_sa.sa.sa_family)
765 range = ServerInstance->Config->c_ipv6_range;
768 range = ServerInstance->Config->c_ipv4_range;
771 return irc::sockets::cidr_mask(client_sa, range);
774 bool User::SetClientIP(const char* sip, bool recheck_eline)
777 cached_hostip.clear();
778 return irc::sockets::aptosa(sip, 0, client_sa);
781 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
784 cached_hostip.clear();
785 memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
788 bool LocalUser::SetClientIP(const char* sip, bool recheck_eline)
790 irc::sockets::sockaddrs sa;
791 if (!irc::sockets::aptosa(sip, 0, sa))
795 LocalUser::SetClientIP(sa, recheck_eline);
799 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
803 User::SetClientIP(sa);
805 this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
807 FOREACH_MOD(OnSetUserIP, (this));
811 static std::string wide_newline("\r\n");
813 void User::Write(const std::string& text)
817 void User::Write(const char *text, ...)
821 void LocalUser::Write(const std::string& text)
823 if (!ServerInstance->SE->BoundsCheckFd(&eh))
826 if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
828 // this should happen rarely or never. Crop the string at 512 and try again.
829 std::string try_again = text.substr(0, ServerInstance->Config->Limits.MaxLine - 2);
834 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
836 eh.AddWriteBuf(text);
837 eh.AddWriteBuf(wide_newline);
839 ServerInstance->stats->statsSent += text.length() + 2;
840 this->bytes_out += text.length() + 2;
846 void LocalUser::Write(const char *text, ...)
848 std::string textbuffer;
849 VAFORMAT(textbuffer, text, text);
850 this->Write(textbuffer);
853 void User::WriteServ(const std::string& text)
855 this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
859 * Same as Write(), except `text' is prefixed with `:server.name '.
861 void User::WriteServ(const char* text, ...)
863 std::string textbuffer;
864 VAFORMAT(textbuffer, text, text);
865 this->WriteServ(textbuffer);
868 void User::WriteNotice(const std::string& text)
870 this->WriteServ("NOTICE " + (this->registered == REG_ALL ? this->nick : "*") + " :" + text);
873 void User::WriteNumeric(unsigned int numeric, const char* text, ...)
875 std::string textbuffer;
876 VAFORMAT(textbuffer, text, text);
877 this->WriteNumeric(numeric, textbuffer);
880 void User::WriteNumeric(unsigned int numeric, const std::string &text)
882 ModResult MOD_RESULT;
884 FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric, text));
886 if (MOD_RESULT == MOD_RES_DENY)
889 const std::string message = InspIRCd::Format(":%s %03u %s %s", ServerInstance->Config->ServerName.c_str(),
890 numeric, !this->nick.empty() ? this->nick.c_str() : "*", text.c_str());
891 this->Write(message);
894 void User::WriteFrom(User *user, const std::string &text)
896 const std::string message = ":" + user->GetFullHost() + " " + text;
897 this->Write(message);
901 /* write text from an originating user to originating user */
903 void User::WriteFrom(User *user, const char* text, ...)
905 std::string textbuffer;
906 VAFORMAT(textbuffer, text, text);
907 this->WriteFrom(user, textbuffer);
911 /* write text to an destination user from a source user (e.g. user privmsg) */
913 void User::WriteTo(User *dest, const char *data, ...)
915 std::string textbuffer;
916 VAFORMAT(textbuffer, data, data);
917 this->WriteTo(dest, textbuffer);
920 void User::WriteTo(User *dest, const std::string &data)
922 dest->WriteFrom(this, data);
925 void User::WriteCommon(const char* text, ...)
927 if (this->registered != REG_ALL || quitting)
930 std::string textbuffer;
931 VAFORMAT(textbuffer, text, text);
932 textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
933 this->WriteCommonRaw(textbuffer, true);
936 void User::WriteCommonExcept(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, false);
947 void User::WriteCommonRaw(const std::string &line, bool include_self)
949 if (this->registered != REG_ALL || quitting)
952 LocalUser::already_sent_id++;
954 IncludeChanList include_c(chans.begin(), chans.end());
955 std::map<User*,bool> exceptions;
957 exceptions[this] = include_self;
959 FOREACH_MOD(OnBuildNeighborList, (this, include_c, exceptions));
961 for (std::map<User*,bool>::iterator i = exceptions.begin(); i != exceptions.end(); ++i)
963 LocalUser* u = IS_LOCAL(i->first);
964 if (u && !u->quitting)
966 u->already_sent = LocalUser::already_sent_id;
971 for (IncludeChanList::const_iterator v = include_c.begin(); v != include_c.end(); ++v)
973 Channel* c = (*v)->chan;
974 const UserMembList* ulist = c->GetUsers();
975 for (UserMembList::const_iterator i = ulist->begin(); i != ulist->end(); i++)
977 LocalUser* u = IS_LOCAL(i->first);
978 if (u && !u->quitting && u->already_sent != LocalUser::already_sent_id)
980 u->already_sent = LocalUser::already_sent_id;
987 void User::WriteCommonQuit(const std::string &normal_text, const std::string &oper_text)
989 if (this->registered != REG_ALL)
992 already_sent_t uniq_id = ++LocalUser::already_sent_id;
994 const std::string normalMessage = ":" + this->GetFullHost() + " QUIT :" + normal_text;
995 const std::string operMessage = ":" + this->GetFullHost() + " QUIT :" + oper_text;
997 IncludeChanList include_c(chans.begin(), chans.end());
998 std::map<User*,bool> exceptions;
1000 FOREACH_MOD(OnBuildNeighborList, (this, include_c, exceptions));
1002 for (std::map<User*,bool>::iterator i = exceptions.begin(); i != exceptions.end(); ++i)
1004 LocalUser* u = IS_LOCAL(i->first);
1005 if (u && !u->quitting)
1007 u->already_sent = uniq_id;
1009 u->Write(u->IsOper() ? operMessage : normalMessage);
1012 for (IncludeChanList::const_iterator v = include_c.begin(); v != include_c.end(); ++v)
1014 const UserMembList* ulist = (*v)->chan->GetUsers();
1015 for (UserMembList::const_iterator i = ulist->begin(); i != ulist->end(); i++)
1017 LocalUser* u = IS_LOCAL(i->first);
1018 if (u && !u->quitting && (u->already_sent != uniq_id))
1020 u->already_sent = uniq_id;
1021 u->Write(u->IsOper() ? operMessage : normalMessage);
1027 void LocalUser::SendText(const std::string& line)
1032 void RemoteUser::SendText(const std::string& line)
1034 ServerInstance->PI->PushToClient(this, line);
1037 void FakeUser::SendText(const std::string& line)
1041 void User::SendText(const char *text, ...)
1044 VAFORMAT(line, text, text);
1048 void User::SendText(const std::string& linePrefix, std::stringstream& textStream)
1052 while (textStream >> word)
1054 size_t lineLength = linePrefix.length() + line.length() + word.length() + 3; // "\s\n\r"
1055 if (lineLength > ServerInstance->Config->Limits.MaxLine)
1057 SendText(linePrefix + line);
1062 SendText(linePrefix + line);
1065 /* return 0 or 1 depending if users u and u2 share one or more common channels
1066 * (used by QUIT, NICK etc which arent channel specific notices)
1068 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
1069 * the first users channels then the second users channels within the outer loop,
1070 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
1071 * all possible iterations). However this new function instead checks against the
1072 * channel's userlist in the inner loop which is a std::map<User*,User*>
1073 * and saves us time as we already know what pointer value we are after.
1074 * Don't quote me on the maths as i am not a mathematician or computer scientist,
1075 * but i believe this algorithm is now x+(log y) maximum iterations instead.
1077 bool User::SharesChannelWith(User *other)
1079 if ((this->registered != REG_ALL) || (other->registered != REG_ALL))
1083 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1085 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
1086 * by replacing it with a map::find which *should* be more efficient
1088 if ((*i)->chan->HasUser(other))
1094 bool User::ChangeName(const std::string& gecos)
1096 if (!this->fullname.compare(gecos))
1101 ModResult MOD_RESULT;
1102 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
1103 if (MOD_RESULT == MOD_RES_DENY)
1105 FOREACH_MOD(OnChangeName, (this,gecos));
1107 this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
1112 bool User::ChangeDisplayedHost(const std::string& shost)
1119 ModResult MOD_RESULT;
1120 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1121 if (MOD_RESULT == MOD_RES_DENY)
1125 FOREACH_MOD(OnChangeHost, (this,shost));
1127 this->dhost.assign(shost, 0, 64);
1128 this->InvalidateCache();
1131 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, "%s :is now your displayed host", this->dhost.c_str());
1136 bool User::ChangeIdent(const std::string& newident)
1138 if (this->ident == newident)
1141 FOREACH_MOD(OnChangeIdent, (this,newident));
1143 this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1144 this->InvalidateCache();
1149 void User::SendAll(const char* command, const char* text, ...)
1151 std::string textbuffer;
1152 VAFORMAT(textbuffer, text, text);
1153 const std::string message = ":" + this->GetFullHost() + " " + command + " $* :" + textbuffer;
1155 for (LocalUserList::const_iterator i = ServerInstance->Users->local_users.begin(); i != ServerInstance->Users->local_users.end(); i++)
1157 if ((*i)->registered == REG_ALL)
1158 (*i)->Write(message);
1163 * Sets a user's connection class.
1164 * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1165 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1166 * then their ip will be taken as 'priority' anyway, so for example,
1167 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1169 void LocalUser::SetClass(const std::string &explicit_name)
1171 ConnectClass *found = NULL;
1173 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1175 if (!explicit_name.empty())
1177 for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1179 ConnectClass* c = *i;
1181 if (explicit_name == c->name)
1183 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1190 for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1192 ConnectClass* c = *i;
1193 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1195 ModResult MOD_RESULT;
1196 FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1197 if (MOD_RESULT == MOD_RES_DENY)
1199 if (MOD_RESULT == MOD_RES_ALLOW)
1201 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1206 if (c->type == CC_NAMED)
1209 bool regdone = (registered != REG_NONE);
1210 if (c->config->getBool("registered", regdone) != regdone)
1213 /* check if host matches.. */
1214 if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1215 !InspIRCd::MatchCIDR(this->host, c->GetHost(), NULL))
1217 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1222 * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1223 * because we should attempt to find another class if this one doesn't match us. -- w00t
1225 if (c->limit && (c->GetReferenceCount() >= c->limit))
1227 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1231 /* if it requires a port ... */
1232 int port = c->config->getInt("port");
1235 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires port (%d)", port);
1237 /* and our port doesn't match, fail. */
1238 if (this->GetServerPort() != port)
1242 if (regdone && !c->config->getString("password").empty())
1244 if (ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1246 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1251 /* we stop at the first class that meets ALL critera. */
1258 * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1266 void User::PurgeEmptyChannels()
1268 // firstly decrement the count on each channel
1269 for (UCListIter i = this->chans.begin(); i != this->chans.end(); )
1271 Channel* c = (*i)->chan;
1279 const std::string& FakeUser::GetFullHost()
1281 if (!ServerInstance->Config->HideWhoisServer.empty())
1282 return ServerInstance->Config->HideWhoisServer;
1283 return server->GetName();
1286 const std::string& FakeUser::GetFullRealHost()
1288 if (!ServerInstance->Config->HideWhoisServer.empty())
1289 return ServerInstance->Config->HideWhoisServer;
1290 return server->GetName();
1293 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1294 : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1295 pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1296 penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(0),
1297 limit(0), resolvehostnames(true)
1301 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1302 : config(tag), type(t), fakelag(parent.fakelag), name("unnamed"),
1303 registration_timeout(parent.registration_timeout), host(mask), pingtime(parent.pingtime),
1304 softsendqmax(parent.softsendqmax), hardsendqmax(parent.hardsendqmax), recvqmax(parent.recvqmax),
1305 penaltythreshold(parent.penaltythreshold), commandrate(parent.commandrate),
1306 maxlocal(parent.maxlocal), maxglobal(parent.maxglobal), maxconnwarn(parent.maxconnwarn), maxchans(parent.maxchans),
1307 limit(parent.limit), resolvehostnames(parent.resolvehostnames)
1311 void ConnectClass::Update(const ConnectClass* src)
1313 config = src->config;
1315 fakelag = src->fakelag;
1317 registration_timeout = src->registration_timeout;
1319 pingtime = src->pingtime;
1320 softsendqmax = src->softsendqmax;
1321 hardsendqmax = src->hardsendqmax;
1322 recvqmax = src->recvqmax;
1323 penaltythreshold = src->penaltythreshold;
1324 commandrate = src->commandrate;
1325 maxlocal = src->maxlocal;
1326 maxglobal = src->maxglobal;
1327 maxconnwarn = src->maxconnwarn;
1328 maxchans = src->maxchans;
1330 resolvehostnames = src->resolvehostnames;