1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 #include "socketengine.h"
19 #include "commands/cmd_whowas.h"
21 static unsigned long already_sent[MAX_DESCRIPTORS] = {0};
23 /* XXX: Used for speeding up WriteCommon operations */
24 unsigned long uniq_id = 0;
26 std::string User::ProcessNoticeMasks(const char *sm)
28 bool adding = true, oldadding = false;
43 for (unsigned char d = 'A'; d <= 'z'; d++)
45 if (ServerInstance->SNO->IsEnabled(d))
47 if ((!IsNoticeMaskSet(d) && adding) || (IsNoticeMaskSet(d) && !adding))
49 if ((oldadding != adding) || (!output.length()))
50 output += (adding ? '+' : '-');
52 this->SetNoticeMask(d, adding);
61 if ((*c >= 'A') && (*c <= 'z') && (ServerInstance->SNO->IsEnabled(*c)))
63 if ((!IsNoticeMaskSet(*c) && adding) || (IsNoticeMaskSet(*c) && !adding))
65 if ((oldadding != adding) || (!output.length()))
66 output += (adding ? '+' : '-');
68 this->SetNoticeMask(*c, adding);
83 void User::StartDNSLookup()
88 const char* ip = this->GetIPString();
90 /* Special case for 4in6 (Have i mentioned i HATE 4in6?) */
91 if (!strncmp(ip, "0::ffff:", 8))
92 res_reverse = new UserResolver(this->ServerInstance, this, ip + 8, DNS_QUERY_PTR4, cached);
94 res_reverse = new UserResolver(this->ServerInstance, this, ip, this->GetProtocolFamily() == AF_INET ? DNS_QUERY_PTR4 : DNS_QUERY_PTR6, cached);
96 this->ServerInstance->AddResolver(res_reverse, cached);
98 catch (CoreException& e)
100 ServerInstance->Log(DEBUG,"Error in resolver: %s",e.GetReason());
104 bool User::IsNoticeMaskSet(unsigned char sm)
106 return (snomasks[sm-65]);
109 void User::SetNoticeMask(unsigned char sm, bool value)
111 snomasks[sm-65] = value;
114 const char* User::FormatNoticeMasks()
116 static char data[MAXBUF];
119 for (int n = 0; n < 64; n++)
122 data[offset++] = n+65;
131 bool User::IsModeSet(unsigned char m)
133 return (modes[m-65]);
136 void User::SetMode(unsigned char m, bool value)
141 const char* User::FormatModes()
143 static char data[MAXBUF];
145 for (int n = 0; n < 64; n++)
148 data[offset++] = n+65;
154 void User::DecrementModes()
156 ServerInstance->Log(DEBUG,"DecrementModes()");
157 for (unsigned char n = 'A'; n <= 'z'; n++)
161 ServerInstance->Log(DEBUG,"DecrementModes() found mode %c", n);
162 ModeHandler* mh = ServerInstance->Modes->FindMode(n, MODETYPE_USER);
165 ServerInstance->Log(DEBUG,"Found handler %c and call ChangeCount", n);
172 User::User(InspIRCd* Instance, const std::string &uid) : ServerInstance(Instance)
174 *password = *nick = *ident = *host = *dhost = *fullname = *awaymsg = *oper = *uuid = 0;
175 server = (char*)Instance->FindServerNamePtr(Instance->Config->ServerName);
176 reset_due = ServerInstance->Time();
177 age = ServerInstance->Time(true);
178 lines_in = lastping = signon = idle_lastmsg = nping = registered = 0;
179 ChannelCount = timeout = flood = bytes_in = bytes_out = cmds_in = cmds_out = 0;
180 muted = exempt = haspassed = dns_done = false;
185 res_forward = res_reverse = NULL;
190 memset(modes,0,sizeof(modes));
191 memset(snomasks,0,sizeof(snomasks));
192 /* Invalidate cache */
193 operquit = cached_fullhost = cached_hostip = cached_makehost = cached_fullrealhost = NULL;
196 strlcpy(uuid, Instance->GetUID().c_str(), UUID_LENGTH);
198 strlcpy(uuid, uid.c_str(), UUID_LENGTH);
200 ServerInstance->Log(DEBUG,"New UUID for user: %s (%s)", uuid, uid.empty() ? "allocated new" : "used remote");
202 user_hash::iterator finduuid = Instance->uuidlist->find(uuid);
203 if (finduuid == Instance->uuidlist->end())
204 (*Instance->uuidlist)[uuid] = this;
206 throw CoreException("Duplicate UUID "+std::string(uuid)+" in User constructor");
209 void User::RemoveCloneCounts()
211 clonemap::iterator x = ServerInstance->local_clones.find(this->GetIPString());
212 if (x != ServerInstance->local_clones.end())
217 ServerInstance->local_clones.erase(x);
221 clonemap::iterator y = ServerInstance->global_clones.find(this->GetIPString());
222 if (y != ServerInstance->global_clones.end())
227 ServerInstance->global_clones.erase(y);
234 this->InvalidateCache();
235 this->DecrementModes();
240 this->RemoveCloneCounts();
242 if (this->GetProtocolFamily() == AF_INET)
244 delete (sockaddr_in*)ip;
246 #ifdef SUPPORT_IP6LINKS
249 delete (sockaddr_in6*)ip;
254 ServerInstance->uuidlist->erase(uuid);
257 char* User::MakeHost()
259 if (this->cached_makehost)
260 return this->cached_makehost;
263 /* This is much faster than snprintf */
265 for(char* n = ident; *n; n++)
268 for(char* n = host; *n; n++)
272 this->cached_makehost = strdup(nhost);
274 return this->cached_makehost;
277 char* User::MakeHostIP()
279 if (this->cached_hostip)
280 return this->cached_hostip;
283 /* This is much faster than snprintf */
285 for(char* n = ident; *n; n++)
288 for(const char* n = this->GetIPString(); *n; n++)
292 this->cached_hostip = strdup(ihost);
294 return this->cached_hostip;
297 void User::CloseSocket()
299 ServerInstance->SE->Shutdown(this, 2);
300 ServerInstance->SE->Close(this);
303 char* User::GetFullHost()
305 if (this->cached_fullhost)
306 return this->cached_fullhost;
310 for(char* n = nick; *n; n++)
313 for(char* n = ident; *n; n++)
316 for(char* n = dhost; *n; n++)
320 this->cached_fullhost = strdup(result);
322 return this->cached_fullhost;
325 char* User::MakeWildHost()
327 static char nresult[MAXBUF];
329 *t++ = '*'; *t++ = '!';
330 *t++ = '*'; *t++ = '@';
331 for(char* n = dhost; *n; n++)
337 int User::ReadData(void* buffer, size_t size)
342 return read(this->fd, buffer, size);
344 return recv(this->fd, (char*)buffer, size, 0);
352 char* User::GetFullRealHost()
354 if (this->cached_fullrealhost)
355 return this->cached_fullrealhost;
357 char fresult[MAXBUF];
359 for(char* n = nick; *n; n++)
362 for(char* n = ident; *n; n++)
365 for(char* n = host; *n; n++)
369 this->cached_fullrealhost = strdup(fresult);
371 return this->cached_fullrealhost;
374 bool User::IsInvited(const irc::string &channel)
376 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
386 InvitedList* User::GetInviteList()
391 void User::InviteTo(const irc::string &channel)
393 invites.push_back(channel);
396 void User::RemoveInvite(const irc::string &channel)
398 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
408 bool User::HasPermission(const std::string &command)
415 * users on remote servers can completely bypass all permissions based checks.
416 * This prevents desyncs when one server has different type/class tags to another.
417 * That having been said, this does open things up to the possibility of source changes
418 * allowing remote kills, etc - but if they have access to the src, they most likely have
419 * access to the conf - so it's an end to a means either way.
424 // are they even an oper at all?
430 // check their opertype exists (!). This won't affect local users, of course.
431 opertype_t::iterator iter_opertype = ServerInstance->Config->opertypes.find(this->oper);
432 if (iter_opertype == ServerInstance->Config->opertypes.end())
437 /* XXX all this strtok/strdup stuff is a bit ick and horrid -- w00t */
438 char* Classes = strdup(iter_opertype->second);
439 char* myclass = strtok_r(Classes," ",&savept);
442 operclass_t::iterator iter_operclass = ServerInstance->Config->operclass.find(myclass);
443 if (iter_operclass != ServerInstance->Config->operclass.end())
445 char* CommandList = strdup(iter_operclass->second);
446 mycmd = strtok_r(CommandList," ",&savept2);
449 if ((!strcasecmp(mycmd,command.c_str())) || (*mycmd == '*'))
455 mycmd = strtok_r(NULL," ",&savept2);
459 myclass = strtok_r(NULL," ",&savept);
466 /** NOTE: We cannot pass a const reference to this method.
467 * The string is changed by the workings of the method,
468 * so that if we pass const ref, we end up copying it to
469 * something we can change anyway. Makes sense to just let
470 * the compiler do that copy for us.
472 bool User::AddBuffer(std::string a)
476 std::string::size_type i = a.rfind('\r');
478 while (i != std::string::npos)
487 if (recvq.length() > (unsigned)this->recvqmax)
489 this->SetWriteError("RecvQ exceeded");
490 ServerInstance->WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
499 ServerInstance->Log(DEBUG,"Exception in User::AddBuffer()");
504 bool User::BufferIsReady()
506 return (recvq.find('\n') != std::string::npos);
509 void User::ClearBuffer()
514 std::string User::GetBuffer()
521 /* Strip any leading \r or \n off the string.
522 * Usually there are only one or two of these,
523 * so its is computationally cheap to do.
525 std::string::iterator t = recvq.begin();
526 while (t != recvq.end() && (*t == '\r' || *t == '\n'))
532 for (std::string::iterator x = recvq.begin(); x != recvq.end(); x++)
534 /* Find the first complete line, return it as the
535 * result, and leave the recvq as whats left
539 std::string ret = std::string(recvq.begin(), x);
540 recvq.erase(recvq.begin(), x + 1);
549 ServerInstance->Log(DEBUG,"Exception in User::GetBuffer()");
554 void User::AddWriteBuf(const std::string &data)
556 if (*this->GetWriteError())
559 if (sendq.length() + data.length() > (unsigned)this->sendqmax)
562 * Fix by brain - Set the error text BEFORE calling writeopers, because
563 * if we dont it'll recursively call here over and over again trying
564 * to repeatedly add the text to the sendq!
566 this->SetWriteError("SendQ exceeded");
567 ServerInstance->WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
573 if (data.length() > MAXBUF - 2) /* MAXBUF has a value of 514, to account for line terminators */
574 sendq.append(data.substr(0,MAXBUF - 4)).append("\r\n"); /* MAXBUF-4 = 510 */
580 this->SetWriteError("SendQ exceeded");
581 ServerInstance->WriteOpers("*** User %s SendQ got an exception",this->nick);
585 // send AS MUCH OF THE USERS SENDQ as we are able to (might not be all of it)
586 void User::FlushWriteBuf()
590 if ((this->fd == FD_MAGIC_NUMBER) || (*this->GetWriteError()))
594 if ((sendq.length()) && (this->fd != FD_MAGIC_NUMBER))
596 int old_sendq_length = sendq.length();
597 int n_sent = ServerInstance->SE->Send(this, this->sendq.data(), this->sendq.length(), 0);
603 /* The socket buffer is full. This isnt fatal,
606 this->ServerInstance->SE->WantWrite(this);
610 /* Fatal error, set write error and bail
612 this->SetWriteError(errno ? strerror(errno) : "EOF from client");
618 /* advance the queue */
620 this->sendq = this->sendq.substr(n_sent);
621 /* update the user's stats counters */
622 this->bytes_out += n_sent;
624 if (n_sent != old_sendq_length)
625 this->ServerInstance->SE->WantWrite(this);
632 ServerInstance->Log(DEBUG,"Exception in User::FlushWriteBuf()");
635 if (this->sendq.empty())
637 FOREACH_MOD(I_OnBufferFlushed,OnBufferFlushed(this));
641 void User::SetWriteError(const std::string &error)
645 // don't try to set the error twice, its already set take the first string.
646 if (this->WriteError.empty())
647 this->WriteError = error;
652 ServerInstance->Log(DEBUG,"Exception in User::SetWriteError()");
656 const char* User::GetWriteError()
658 return this->WriteError.c_str();
661 void User::Oper(const std::string &opertype)
665 this->modes[UM_OPERATOR] = 1;
666 this->WriteServ("MODE %s :+o", this->nick);
667 FOREACH_MOD(I_OnOper, OnOper(this, opertype));
668 ServerInstance->Log(DEFAULT,"OPER: %s!%s@%s opered as type: %s", this->nick, this->ident, this->host, opertype.c_str());
669 strlcpy(this->oper, opertype.c_str(), NICKMAX - 1);
670 ServerInstance->all_opers.push_back(this);
671 FOREACH_MOD(I_OnPostOper,OnPostOper(this, opertype));
676 ServerInstance->Log(DEBUG,"Exception in User::Oper()");
686 // unset their oper type (what IS_OPER checks), and remove +o
688 this->modes[UM_OPERATOR] = 0;
690 // remove the user from the oper list. Will remove multiple entries as a safeguard against bug #404
691 ServerInstance->all_opers.remove(this);
697 ServerInstance->Log(DEBUG,"Exception in User::UnOper()");
701 void User::QuitUser(InspIRCd* Instance, User *user, const std::string &quitreason, const char* operreason)
703 user->Write("ERROR :Closing link (%s@%s) [%s]", user->ident, user->host, operreason);
705 Instance->GlobalCulls.AddItem(user, quitreason.c_str(), operreason);
708 /* adds or updates an entry in the whowas list */
709 void User::AddToWhoWas()
711 Command* whowas_command = ServerInstance->Parser->GetHandler("WHOWAS");
714 std::deque<classbase*> params;
715 params.push_back(this);
716 whowas_command->HandleInternal(WHOWAS_ADD, params);
720 /* add a client connection to the sockets list */
721 void User::AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip)
723 /* NOTE: Calling this one parameter constructor for User automatically
724 * allocates a new UUID and places it in the hash_map.
729 New = new User(Instance);
733 Instance->Log(DEFAULT,"*** WTF *** Duplicated UUID! -- Crack smoking monkies have been unleashed.");
734 Instance->WriteOpers("*** WARNING *** Duplicate UUID allocated!");
740 Instance->unregistered_count++;
744 if (socketfamily == AF_INET6)
745 inet_ntop(AF_INET6, &((const sockaddr_in6*)ip)->sin6_addr, ipaddr, sizeof(ipaddr));
748 inet_ntop(AF_INET, &((const sockaddr_in*)ip)->sin_addr, ipaddr, sizeof(ipaddr));
750 (*(Instance->clientlist))[New->uuid] = New;
753 /* The users default nick is their UUID */
754 strlcpy(New->nick, New->uuid, NICKMAX - 1);
756 New->server = Instance->FindServerNamePtr(Instance->Config->ServerName);
757 /* We don't need range checking here, we KNOW 'unknown\0' will fit into the ident field. */
758 strcpy(New->ident, "unknown");
760 New->registered = REG_NONE;
761 New->signon = Instance->Time() + Instance->Config->dns_timeout;
764 New->SetSockAddr(socketfamily, ipaddr, port);
766 /* Smarter than your average bear^H^H^H^Hset of strlcpys. */
767 for (const char* temp = New->GetIPString(); *temp && j < 64; temp++, j++)
768 New->dhost[j] = New->host[j] = *temp;
769 New->dhost[j] = New->host[j] = 0;
771 Instance->AddLocalClone(New);
772 Instance->AddGlobalClone(New);
775 * First class check. We do this again in FullConnect after DNS is done, and NICK/USER is recieved.
776 * See my note down there for why this is required. DO NOT REMOVE. :) -- w00t
778 ConnectClass* i = New->GetClass();
782 User::QuitUser(Instance, New, "Access denied by configuration");
787 * Check connect class settings and initialise settings into User.
788 * This will be done again after DNS resolution. -- w00t
792 Instance->local_users.push_back(New);
794 if ((Instance->local_users.size() > Instance->Config->SoftLimit) || (Instance->local_users.size() >= MAXCLIENTS))
796 Instance->WriteOpers("*** Warning: softlimit value has been reached: %d clients", Instance->Config->SoftLimit);
797 User::QuitUser(Instance, New,"No more connections allowed");
803 * this is done as a safety check to keep the file descriptors within range of fd_ref_table.
804 * its a pretty big but for the moment valid assumption:
805 * file descriptors are handed out starting at 0, and are recycled as theyre freed.
806 * therefore if there is ever an fd over 65535, 65536 clients must be connected to the
807 * irc server at once (or the irc server otherwise initiating this many connections, files etc)
808 * which for the time being is a physical impossibility (even the largest networks dont have more
809 * than about 10,000 users on ONE server!)
812 if ((unsigned int)socket >= MAX_DESCRIPTORS)
814 User::QuitUser(Instance, New, "Server is full");
819 New->exempt = (Instance->XLines->matches_exception(New) != NULL);
822 ZLine* r = Instance->XLines->matches_zline(ipaddr);
826 if (*Instance->Config->MoronBanner)
827 New->WriteServ("NOTICE %s :*** %s", New->nick, Instance->Config->MoronBanner);
828 snprintf(reason,MAXBUF,"Z-Lined: %s",r->reason);
829 User::QuitUser(Instance, New, reason);
836 if (!Instance->SE->AddFd(New))
838 User::QuitUser(Instance, New, "Internal error handling connection");
842 /* NOTE: even if dns lookups are *off*, we still need to display this.
843 * BOPM and other stuff requires it.
845 New->WriteServ("NOTICE Auth :*** Looking up your hostname...");
848 unsigned long User::GlobalCloneCount()
850 clonemap::iterator x = ServerInstance->global_clones.find(this->GetIPString());
851 if (x != ServerInstance->global_clones.end())
857 unsigned long User::LocalCloneCount()
859 clonemap::iterator x = ServerInstance->local_clones.find(this->GetIPString());
860 if (x != ServerInstance->local_clones.end())
867 * Check class restrictions
869 void User::CheckClass(const std::string &explicit_class)
871 ConnectClass* a = this->GetClass(explicit_class);
873 if ((!a) || (a->GetType() == CC_DENY))
875 User::QuitUser(ServerInstance, this, "Unauthorised connection");
878 else if ((a->GetMaxLocal()) && (this->LocalCloneCount() > a->GetMaxLocal()))
880 User::QuitUser(ServerInstance, this, "No more connections allowed from your host via this connect class (local)");
881 ServerInstance->WriteOpers("*** WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString());
884 else if ((a->GetMaxGlobal()) && (this->GlobalCloneCount() > a->GetMaxGlobal()))
886 User::QuitUser(ServerInstance, this, "No more connections allowed from your host via this connect class (global)");
887 ServerInstance->WriteOpers("*** WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString());
891 this->pingmax = a->GetPingTime();
892 this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout;
893 this->timeout = ServerInstance->Time() + a->GetRegTimeout();
894 this->flood = a->GetFlood();
895 this->threshold = a->GetThreshold();
896 this->sendqmax = a->GetSendqMax();
897 this->recvqmax = a->GetRecvqMax();
898 this->MaxChans = a->GetMaxChans();
901 void User::FullConnect()
903 ServerInstance->stats->statsConnects++;
904 this->idle_lastmsg = ServerInstance->Time();
907 * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
908 * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
909 * may put the user into a totally seperate class with different restrictions! so we *must* check again.
910 * Don't remove this! -- w00t
914 /* Check the password, if one is required by the user's connect class.
915 * This CANNOT be in CheckClass(), because that is called prior to PASS as well!
917 if ((!this->GetClass()->GetPass().empty()) && (!this->haspassed))
919 User::QuitUser(ServerInstance, this, "Invalid password");
925 GLine* r = ServerInstance->XLines->matches_gline(this);
931 if (*ServerInstance->Config->MoronBanner)
932 this->WriteServ("NOTICE %s :*** %s", this->nick, ServerInstance->Config->MoronBanner);
933 snprintf(reason,MAXBUF,"G-Lined: %s",r->reason);
934 User::QuitUser(ServerInstance, this, reason);
938 KLine* n = ServerInstance->XLines->matches_kline(this);
944 if (*ServerInstance->Config->MoronBanner)
945 this->WriteServ("NOTICE %s :*** %s", this, ServerInstance->Config->MoronBanner);
946 snprintf(reason,MAXBUF,"K-Lined: %s",n->reason);
947 User::QuitUser(ServerInstance, this, reason);
952 this->WriteServ("NOTICE Auth :Welcome to \002%s\002!",ServerInstance->Config->Network);
953 this->WriteServ("001 %s :Welcome to the %s IRC Network %s!%s@%s",this->nick, ServerInstance->Config->Network, this->nick, this->ident, this->host);
954 this->WriteServ("002 %s :Your host is %s, running version %s",this->nick,ServerInstance->Config->ServerName,VERSION);
955 this->WriteServ("003 %s :This server was created %s %s", this->nick, __TIME__, __DATE__);
956 this->WriteServ("004 %s %s %s %s %s %s", this->nick, ServerInstance->Config->ServerName, VERSION, ServerInstance->Modes->UserModeList().c_str(), ServerInstance->Modes->ChannelModeList().c_str(), ServerInstance->Modes->ParaModeList().c_str());
958 ServerInstance->Config->Send005(this);
960 this->WriteServ("042 %s %s :your unique ID", this->nick, this->uuid);
966 if (ServerInstance->unregistered_count)
967 ServerInstance->unregistered_count--;
969 /* Trigger LUSERS output, give modules a chance too */
971 FOREACH_RESULT(I_OnPreCommand, OnPreCommand("LUSERS", NULL, 0, this, true, "LUSERS"));
973 ServerInstance->CallCommandHandler("LUSERS", NULL, 0, this);
976 * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
977 * for a user that doesn't exist yet.
979 FOREACH_MOD(I_OnUserConnect,OnUserConnect(this));
981 this->registered = REG_ALL;
983 FOREACH_MOD(I_OnPostConnect,OnPostConnect(this));
985 ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d: %s!%s@%s [%s] [%s]", this->GetPort(), this->nick, this->ident, this->host, this->GetIPString(), this->fullname);
988 /** User::UpdateNick()
989 * re-allocates a nick in the user_hash after they change nicknames,
990 * returns a pointer to the new user as it may have moved
992 User* User::UpdateNickHash(const char* New)
996 //user_hash::iterator newnick;
997 user_hash::iterator oldnick = ServerInstance->clientlist->find(this->nick);
999 if (!strcasecmp(this->nick,New))
1000 return oldnick->second;
1002 if (oldnick == ServerInstance->clientlist->end())
1003 return NULL; /* doesnt exist */
1005 User* olduser = oldnick->second;
1006 (*(ServerInstance->clientlist))[New] = olduser;
1007 ServerInstance->clientlist->erase(oldnick);
1013 ServerInstance->Log(DEBUG,"Exception in User::UpdateNickHash()");
1018 void User::InvalidateCache()
1020 /* Invalidate cache */
1021 if (cached_fullhost)
1022 free(cached_fullhost);
1024 free(cached_hostip);
1025 if (cached_makehost)
1026 free(cached_makehost);
1027 if (cached_fullrealhost)
1028 free(cached_fullrealhost);
1029 cached_fullhost = cached_hostip = cached_makehost = cached_fullrealhost = NULL;
1032 bool User::ForceNickChange(const char* newnick)
1038 this->InvalidateCache();
1040 FOREACH_RESULT(I_OnUserPreNick,OnUserPreNick(this, newnick));
1044 ServerInstance->stats->statsCollisions++;
1048 if (ServerInstance->XLines->matches_qline(newnick))
1050 ServerInstance->stats->statsCollisions++;
1054 if (this->registered == REG_ALL)
1056 std::deque<classbase*> dummy;
1057 Command* nickhandler = ServerInstance->Parser->GetHandler("NICK");
1060 nickhandler->HandleInternal(1, dummy);
1061 bool result = (ServerInstance->Parser->CallHandler("NICK", &newnick, 1, this) == CMD_SUCCESS);
1062 nickhandler->HandleInternal(0, dummy);
1071 ServerInstance->Log(DEBUG,"Exception in User::ForceNickChange()");
1076 void User::SetSockAddr(int protocol_family, const char* ip, int port)
1078 switch (protocol_family)
1080 #ifdef SUPPORT_IP6LINKS
1083 sockaddr_in6* sin = new sockaddr_in6;
1084 sin->sin6_family = AF_INET6;
1085 sin->sin6_port = port;
1086 inet_pton(AF_INET6, ip, &sin->sin6_addr);
1087 this->ip = (sockaddr*)sin;
1093 sockaddr_in* sin = new sockaddr_in;
1094 sin->sin_family = AF_INET;
1095 sin->sin_port = port;
1096 inet_pton(AF_INET, ip, &sin->sin_addr);
1097 this->ip = (sockaddr*)sin;
1101 ServerInstance->Log(DEBUG,"Uh oh, I dont know protocol %d to be set on '%s'!", protocol_family, this->nick);
1108 if (this->ip == NULL)
1111 switch (this->GetProtocolFamily())
1113 #ifdef SUPPORT_IP6LINKS
1116 sockaddr_in6* sin = (sockaddr_in6*)this->ip;
1117 return sin->sin6_port;
1123 sockaddr_in* sin = (sockaddr_in*)this->ip;
1124 return sin->sin_port;
1133 int User::GetProtocolFamily()
1135 if (this->ip == NULL)
1138 sockaddr_in* sin = (sockaddr_in*)this->ip;
1139 return sin->sin_family;
1142 const char* User::GetIPString()
1144 static char buf[1024];
1146 if (this->ip == NULL)
1149 switch (this->GetProtocolFamily())
1151 #ifdef SUPPORT_IP6LINKS
1154 static char temp[1024];
1156 sockaddr_in6* sin = (sockaddr_in6*)this->ip;
1157 inet_ntop(sin->sin6_family, &sin->sin6_addr, buf, sizeof(buf));
1158 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
1161 strlcpy(&temp[1], buf, sizeof(temp) - 1);
1171 sockaddr_in* sin = (sockaddr_in*)this->ip;
1172 inet_ntop(sin->sin_family, &sin->sin_addr, buf, sizeof(buf));
1182 const char* User::GetIPString(char* buf)
1184 if (this->ip == NULL)
1190 switch (this->GetProtocolFamily())
1192 #ifdef SUPPORT_IP6LINKS
1195 static char temp[1024];
1197 sockaddr_in6* sin = (sockaddr_in6*)this->ip;
1198 inet_ntop(sin->sin6_family, &sin->sin6_addr, buf, sizeof(buf));
1199 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
1202 strlcpy(&temp[1], buf, sizeof(temp) - 1);
1204 strlcpy(buf, temp, sizeof(temp));
1212 sockaddr_in* sin = (sockaddr_in*)this->ip;
1213 inet_ntop(sin->sin_family, &sin->sin_addr, buf, sizeof(buf));
1224 /** NOTE: We cannot pass a const reference to this method.
1225 * The string is changed by the workings of the method,
1226 * so that if we pass const ref, we end up copying it to
1227 * something we can change anyway. Makes sense to just let
1228 * the compiler do that copy for us.
1230 void User::Write(std::string text)
1232 if (!ServerInstance->SE->BoundsCheckFd(this))
1237 /* ServerInstance->Log(DEBUG,"C[%d] O %s", this->GetFd(), text.c_str());
1238 * WARNING: The above debug line is VERY loud, do NOT
1239 * enable it till we have a good way of filtering it
1240 * out of the logs (e.g. 1.2 would be good).
1242 text.append("\r\n");
1246 ServerInstance->Log(DEBUG,"Exception in User::Write() std::string::append");
1250 if (ServerInstance->Config->GetIOHook(this->GetPort()))
1254 /* XXX: The lack of buffering here is NOT a bug, modules implementing this interface have to
1255 * implement their own buffering mechanisms
1257 ServerInstance->Config->GetIOHook(this->GetPort())->OnRawSocketWrite(this->fd, text.data(), text.length());
1259 catch (CoreException& modexcept)
1261 ServerInstance->Log(DEBUG, "%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason());
1266 this->AddWriteBuf(text);
1268 ServerInstance->stats->statsSent += text.length();
1269 this->ServerInstance->SE->WantWrite(this);
1274 void User::Write(const char *text, ...)
1277 char textbuffer[MAXBUF];
1279 va_start(argsPtr, text);
1280 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1283 this->Write(std::string(textbuffer));
1286 void User::WriteServ(const std::string& text)
1288 char textbuffer[MAXBUF];
1290 snprintf(textbuffer,MAXBUF,":%s %s",ServerInstance->Config->ServerName,text.c_str());
1291 this->Write(std::string(textbuffer));
1295 * Same as Write(), except `text' is prefixed with `:server.name '.
1297 void User::WriteServ(const char* text, ...)
1300 char textbuffer[MAXBUF];
1302 va_start(argsPtr, text);
1303 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1306 this->WriteServ(std::string(textbuffer));
1310 void User::WriteFrom(User *user, const std::string &text)
1314 snprintf(tb,MAXBUF,":%s %s",user->GetFullHost(),text.c_str());
1316 this->Write(std::string(tb));
1320 /* write text from an originating user to originating user */
1322 void User::WriteFrom(User *user, const char* text, ...)
1325 char textbuffer[MAXBUF];
1327 va_start(argsPtr, text);
1328 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1331 this->WriteFrom(user, std::string(textbuffer));
1335 /* write text to an destination user from a source user (e.g. user privmsg) */
1337 void User::WriteTo(User *dest, const char *data, ...)
1339 char textbuffer[MAXBUF];
1342 va_start(argsPtr, data);
1343 vsnprintf(textbuffer, MAXBUF, data, argsPtr);
1346 this->WriteTo(dest, std::string(textbuffer));
1349 void User::WriteTo(User *dest, const std::string &data)
1351 dest->WriteFrom(this, data);
1355 void User::WriteCommon(const char* text, ...)
1357 char textbuffer[MAXBUF];
1360 if (this->registered != REG_ALL)
1363 va_start(argsPtr, text);
1364 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1367 this->WriteCommon(std::string(textbuffer));
1370 void User::WriteCommon(const std::string &text)
1374 bool sent_to_at_least_one = false;
1377 if (this->registered != REG_ALL)
1382 /* We dont want to be doing this n times, just once */
1383 snprintf(tb,MAXBUF,":%s %s",this->GetFullHost(),text.c_str());
1384 std::string out = tb;
1386 for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++)
1388 CUList* ulist = v->first->GetUsers();
1389 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
1391 if ((IS_LOCAL(i->first)) && (already_sent[i->first->fd] != uniq_id))
1393 already_sent[i->first->fd] = uniq_id;
1394 i->first->Write(out);
1395 sent_to_at_least_one = true;
1401 * if the user was not in any channels, no users will receive the text. Make sure the user
1402 * receives their OWN message for WriteCommon
1404 if (!sent_to_at_least_one)
1406 this->Write(std::string(tb));
1412 ServerInstance->Log(DEBUG,"Exception in User::WriteCommon()");
1417 /* write a formatted string to all users who share at least one common
1418 * channel, NOT including the source user e.g. for use in QUIT
1421 void User::WriteCommonExcept(const char* text, ...)
1423 char textbuffer[MAXBUF];
1426 va_start(argsPtr, text);
1427 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1430 this->WriteCommonExcept(std::string(textbuffer));
1433 void User::WriteCommonQuit(const std::string &normal_text, const std::string &oper_text)
1438 if (this->registered != REG_ALL)
1442 snprintf(tb1,MAXBUF,":%s QUIT :%s",this->GetFullHost(),normal_text.c_str());
1443 snprintf(tb2,MAXBUF,":%s QUIT :%s",this->GetFullHost(),oper_text.c_str());
1444 std::string out1 = tb1;
1445 std::string out2 = tb2;
1447 for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++)
1449 CUList *ulist = v->first->GetUsers();
1450 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
1452 if (this != i->first)
1454 if ((IS_LOCAL(i->first)) && (already_sent[i->first->fd] != uniq_id))
1456 already_sent[i->first->fd] = uniq_id;
1457 i->first->Write(IS_OPER(i->first) ? out2 : out1);
1464 void User::WriteCommonExcept(const std::string &text)
1469 if (this->registered != REG_ALL)
1473 snprintf(tb1,MAXBUF,":%s %s",this->GetFullHost(),text.c_str());
1476 for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++)
1478 CUList *ulist = v->first->GetUsers();
1479 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
1481 if (this != i->first)
1483 if ((IS_LOCAL(i->first)) && (already_sent[i->first->fd] != uniq_id))
1485 already_sent[i->first->fd] = uniq_id;
1486 i->first->Write(out1);
1494 void User::WriteWallOps(const std::string &text)
1496 if (!IS_OPER(this) && IS_LOCAL(this))
1499 std::string wallop("WALLOPS :");
1500 wallop.append(text);
1502 for (std::vector<User*>::const_iterator i = ServerInstance->local_users.begin(); i != ServerInstance->local_users.end(); i++)
1505 if (t->IsModeSet('w'))
1506 this->WriteTo(t,wallop);
1510 void User::WriteWallOps(const char* text, ...)
1512 char textbuffer[MAXBUF];
1515 va_start(argsPtr, text);
1516 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1519 this->WriteWallOps(std::string(textbuffer));
1522 /* return 0 or 1 depending if users u and u2 share one or more common channels
1523 * (used by QUIT, NICK etc which arent channel specific notices)
1525 * The old algorithm in 1.0 for this was relatively inefficient, iterating over
1526 * the first users channels then the second users channels within the outer loop,
1527 * therefore it was a maximum of x*y iterations (upon returning 0 and checking
1528 * all possible iterations). However this new function instead checks against the
1529 * channel's userlist in the inner loop which is a std::map<User*,User*>
1530 * and saves us time as we already know what pointer value we are after.
1531 * Don't quote me on the maths as i am not a mathematician or computer scientist,
1532 * but i believe this algorithm is now x+(log y) maximum iterations instead.
1534 bool User::SharesChannelWith(User *other)
1536 if ((!other) || (this->registered != REG_ALL) || (other->registered != REG_ALL))
1540 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1542 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
1543 * by replacing it with a map::find which *should* be more efficient
1545 if (i->first->HasUser(other))
1551 bool User::ChangeName(const char* gecos)
1553 if (!strcmp(gecos, this->fullname))
1559 FOREACH_RESULT(I_OnChangeLocalUserGECOS,OnChangeLocalUserGECOS(this,gecos));
1562 FOREACH_MOD(I_OnChangeName,OnChangeName(this,gecos));
1564 strlcpy(this->fullname,gecos,MAXGECOS+1);
1569 bool User::ChangeDisplayedHost(const char* host)
1571 if (!strcmp(host, this->dhost))
1577 FOREACH_RESULT(I_OnChangeLocalUserHost,OnChangeLocalUserHost(this,host));
1580 FOREACH_MOD(I_OnChangeHost,OnChangeHost(this,host));
1582 if (this->ServerInstance->Config->CycleHosts)
1583 this->WriteCommonExcept("QUIT :Changing hosts");
1585 /* Fix by Om: User::dhost is 65 long, this was truncating some long hosts */
1586 strlcpy(this->dhost,host,64);
1588 this->InvalidateCache();
1590 if (this->ServerInstance->Config->CycleHosts)
1592 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1594 i->first->WriteAllExceptSender(this, false, 0, "JOIN %s", i->first->name);
1595 std::string n = this->ServerInstance->Modes->ModeString(this, i->first);
1597 i->first->WriteAllExceptSender(this, true, 0, "MODE %s +%s", i->first->name, n.c_str());
1602 this->WriteServ("396 %s %s :is now your displayed host",this->nick,this->dhost);
1607 bool User::ChangeIdent(const char* newident)
1609 if (!strcmp(newident, this->ident))
1612 if (this->ServerInstance->Config->CycleHosts)
1613 this->WriteCommonExcept("%s","QUIT :Changing ident");
1615 strlcpy(this->ident, newident, IDENTMAX+2);
1617 this->InvalidateCache();
1619 if (this->ServerInstance->Config->CycleHosts)
1621 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1623 i->first->WriteAllExceptSender(this, false, 0, "JOIN %s", i->first->name);
1624 std::string n = this->ServerInstance->Modes->ModeString(this, i->first);
1626 i->first->WriteAllExceptSender(this, true, 0, "MODE %s +%s", i->first->name, n.c_str());
1633 void User::SendAll(const char* command, char* text, ...)
1635 char textbuffer[MAXBUF];
1636 char formatbuffer[MAXBUF];
1639 va_start(argsPtr, text);
1640 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1643 snprintf(formatbuffer,MAXBUF,":%s %s $* :%s", this->GetFullHost(), command, textbuffer);
1644 std::string fmt = formatbuffer;
1646 for (std::vector<User*>::const_iterator i = ServerInstance->local_users.begin(); i != ServerInstance->local_users.end(); i++)
1653 std::string User::ChannelList(User* source)
1658 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1660 /* If the target is the same as the sender, let them see all their channels.
1661 * If the channel is NOT private/secret OR the user shares a common channel
1662 * If the user is an oper, and the <options:operspywhois> option is set.
1664 if ((source == this) || (IS_OPER(source) && ServerInstance->Config->OperSpyWhois) || (((!i->first->IsModeSet('p')) && (!i->first->IsModeSet('s'))) || (i->first->HasUser(source))))
1666 list.append(i->first->GetPrefixChar(this)).append(i->first->name).append(" ");
1673 ServerInstance->Log(DEBUG,"Exception in User::ChannelList()");
1678 void User::SplitChanList(User* dest, const std::string &cl)
1681 std::ostringstream prefix;
1682 std::string::size_type start, pos, length;
1686 prefix << this->nick << " " << dest->nick << " :";
1687 line = prefix.str();
1688 int namelen = strlen(ServerInstance->Config->ServerName) + 6;
1690 for (start = 0; (pos = cl.find(' ', start)) != std::string::npos; start = pos+1)
1692 length = (pos == std::string::npos) ? cl.length() : pos;
1694 if (line.length() + namelen + length - start > 510)
1696 ServerInstance->SendWhoisLine(this, dest, 319, "%s", line.c_str());
1697 line = prefix.str();
1700 if(pos == std::string::npos)
1702 line.append(cl.substr(start, length - start));
1707 line.append(cl.substr(start, length - start + 1));
1713 ServerInstance->SendWhoisLine(this, dest, 319, "%s", line.c_str());
1719 ServerInstance->Log(DEBUG,"Exception in User::SplitChanList()");
1723 unsigned int User::GetMaxChans()
1725 return this->MaxChans;
1728 /* looks up a users password for their connection class (<ALLOW>/<DENY> tags)
1729 * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1730 * then their ip will be taken as 'priority' anyway, so for example,
1731 * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1733 ConnectClass* User::GetClass(const std::string &explicit_name)
1735 if (!explicit_name.empty())
1737 for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1739 if (explicit_name == i->GetName())
1745 for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1747 if (((match(this->GetIPString(),i->GetHost().c_str(),true)) || (match(this->host,i->GetHost().c_str()))))
1751 if (this->GetPort() == i->GetPort())
1764 void User::PurgeEmptyChannels()
1766 std::vector<Channel*> to_delete;
1768 // firstly decrement the count on each channel
1769 for (UCListIter f = this->chans.begin(); f != this->chans.end(); f++)
1771 f->first->RemoveAllPrefixes(this);
1772 if (f->first->DelUser(this) == 0)
1774 /* No users left in here, mark it for deletion */
1777 to_delete.push_back(f->first);
1781 ServerInstance->Log(DEBUG,"Exception in User::PurgeEmptyChannels to_delete.push_back()");
1786 for (std::vector<Channel*>::iterator n = to_delete.begin(); n != to_delete.end(); n++)
1788 Channel* thischan = *n;
1789 chan_hash::iterator i2 = ServerInstance->chanlist->find(thischan->name);
1790 if (i2 != ServerInstance->chanlist->end())
1792 FOREACH_MOD(I_OnChannelDelete,OnChannelDelete(i2->second));
1794 ServerInstance->chanlist->erase(i2);
1795 this->chans.erase(*n);
1802 void User::ShowMOTD()
1804 if (!ServerInstance->Config->MOTD.size())
1806 this->WriteServ("422 %s :Message of the day file is missing.",this->nick);
1809 this->WriteServ("375 %s :%s message of the day", this->nick, ServerInstance->Config->ServerName);
1811 for (file_cache::iterator i = ServerInstance->Config->MOTD.begin(); i != ServerInstance->Config->MOTD.end(); i++)
1812 this->WriteServ("372 %s :- %s",this->nick,i->c_str());
1814 this->WriteServ("376 %s :End of message of the day.", this->nick);
1817 void User::ShowRULES()
1819 if (!ServerInstance->Config->RULES.size())
1821 this->WriteServ("434 %s :RULES File is missing",this->nick);
1825 this->WriteServ("308 %s :- %s Server Rules -",this->nick,ServerInstance->Config->ServerName);
1827 for (file_cache::iterator i = ServerInstance->Config->RULES.begin(); i != ServerInstance->Config->RULES.end(); i++)
1828 this->WriteServ("232 %s :- %s",this->nick,i->c_str());
1830 this->WriteServ("309 %s :End of RULES command.",this->nick);
1833 void User::HandleEvent(EventType et, int errornum)
1835 /* WARNING: May delete this user! */
1836 int thisfd = this->GetFd();
1843 ServerInstance->ProcessUser(this);
1846 this->FlushWriteBuf();
1849 /** This should be safe, but dont DARE do anything after it -- Brain */
1850 this->SetWriteError(errornum ? strerror(errornum) : "EOF from client");
1856 ServerInstance->Log(DEBUG,"Exception in User::HandleEvent intercepted");
1859 /* If the user has raised an error whilst being processed, quit them now we're safe to */
1860 if ((ServerInstance->SE->GetRef(thisfd) == this))
1862 if (!WriteError.empty())
1864 User::QuitUser(ServerInstance, this, GetWriteError());
1869 void User::SetOperQuit(const std::string &oquit)
1874 operquit = strdup(oquit.c_str());
1877 const char* User::GetOperQuit()
1879 return operquit ? operquit : "";
1890 bool VisData::VisibleTo(User* user)