]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/users.cpp
Make User::WriteRemoteNumeric() virtual, implement it in SpanningTree::RemoteUser
[user/henk/code/inspircd.git] / src / users.cpp
1 /*
2  * InspIRCd -- Internet Relay Chat Daemon
3  *
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>
11  *
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.
15  *
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
19  * details.
20  *
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/>.
23  */
24
25
26 #include "inspircd.h"
27 #include "xline.h"
28
29 bool User::IsNoticeMaskSet(unsigned char sm)
30 {
31         if (!isalpha(sm))
32                 return false;
33         return (snomasks[sm-65]);
34 }
35
36 bool User::IsModeSet(unsigned char m)
37 {
38         ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
39         return (mh && modes[mh->GetId()]);
40 }
41
42 const char* User::FormatModes(bool showparameters)
43 {
44         static std::string data;
45         std::string params;
46         data.clear();
47
48         for (unsigned char n = 0; n < 64; n++)
49         {
50                 ModeHandler* mh = ServerInstance->Modes->FindMode(n + 65, MODETYPE_USER);
51                 if (mh && IsModeSet(mh))
52                 {
53                         data.push_back(n + 65);
54                         if (showparameters && mh->GetNumParams(true))
55                         {
56                                 std::string p = mh->GetUserParameter(this);
57                                 if (p.length())
58                                         params.append(" ").append(p);
59                         }
60                 }
61         }
62         data += params;
63         return data.c_str();
64 }
65
66 User::User(const std::string& uid, Server* srv, int type)
67         : uuid(uid), server(srv), usertype(type)
68 {
69         age = ServerInstance->Time();
70         signon = 0;
71         registered = 0;
72         quitting = false;
73         client_sa.sa.sa_family = AF_UNSPEC;
74
75         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
76
77         // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
78         if (type != USERTYPE_SERVER)
79         {
80                 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
81                         throw CoreException("Duplicate UUID in User constructor: " + uuid);
82         }
83 }
84
85 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
86         : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL), eh(this),
87         bytes_in(0), bytes_out(0), cmds_in(0), cmds_out(0), nping(0), CommandFloodPenalty(0),
88         already_sent(0)
89 {
90         exempt = quitting_sendq = false;
91         idle_lastmsg = 0;
92         ident = "unknown";
93         lastping = 0;
94         eh.SetFd(myfd);
95         memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
96         memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
97         dhost = host = GetIPString();
98 }
99
100 User::~User()
101 {
102 }
103
104 const std::string& User::MakeHost()
105 {
106         if (!this->cached_makehost.empty())
107                 return this->cached_makehost;
108
109         // XXX: Is there really a need to cache this?
110         this->cached_makehost = ident + "@" + host;
111         return this->cached_makehost;
112 }
113
114 const std::string& User::MakeHostIP()
115 {
116         if (!this->cached_hostip.empty())
117                 return this->cached_hostip;
118
119         // XXX: Is there really a need to cache this?
120         this->cached_hostip = ident + "@" + this->GetIPString();
121         return this->cached_hostip;
122 }
123
124 const std::string& User::GetFullHost()
125 {
126         if (!this->cached_fullhost.empty())
127                 return this->cached_fullhost;
128
129         // XXX: Is there really a need to cache this?
130         this->cached_fullhost = nick + "!" + ident + "@" + dhost;
131         return this->cached_fullhost;
132 }
133
134 const std::string& User::GetFullRealHost()
135 {
136         if (!this->cached_fullrealhost.empty())
137                 return this->cached_fullrealhost;
138
139         // XXX: Is there really a need to cache this?
140         this->cached_fullrealhost = nick + "!" + ident + "@" + host;
141         return this->cached_fullrealhost;
142 }
143
144 bool User::HasModePermission(unsigned char, ModeType)
145 {
146         return true;
147 }
148
149 bool LocalUser::HasModePermission(unsigned char mode, ModeType type)
150 {
151         if (!this->IsOper())
152                 return false;
153
154         if (mode < 'A' || mode > ('A' + 64)) return false;
155
156         return ((type == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
157
158 }
159 /*
160  * users on remote servers can completely bypass all permissions based checks.
161  * This prevents desyncs when one server has different type/class tags to another.
162  * That having been said, this does open things up to the possibility of source changes
163  * allowing remote kills, etc - but if they have access to the src, they most likely have
164  * access to the conf - so it's an end to a means either way.
165  */
166 bool User::HasPermission(const std::string&)
167 {
168         return true;
169 }
170
171 bool LocalUser::HasPermission(const std::string &command)
172 {
173         // are they even an oper at all?
174         if (!this->IsOper())
175         {
176                 return false;
177         }
178
179         if (oper->AllowedOperCommands.find(command) != oper->AllowedOperCommands.end())
180                 return true;
181         else if (oper->AllowedOperCommands.find("*") != oper->AllowedOperCommands.end())
182                 return true;
183
184         return false;
185 }
186
187 bool User::HasPrivPermission(const std::string &privstr, bool noisy)
188 {
189         return true;
190 }
191
192 bool LocalUser::HasPrivPermission(const std::string &privstr, bool noisy)
193 {
194         if (!this->IsOper())
195         {
196                 if (noisy)
197                         this->WriteNotice("You are not an oper");
198                 return false;
199         }
200
201         if (oper->AllowedPrivs.find(privstr) != oper->AllowedPrivs.end())
202         {
203                 return true;
204         }
205         else if (oper->AllowedPrivs.find("*") != oper->AllowedPrivs.end())
206         {
207                 return true;
208         }
209
210         if (noisy)
211                 this->WriteNotice("Oper type " + oper->name + " does not have access to priv " + privstr);
212
213         return false;
214 }
215
216 void UserIOHandler::OnDataReady()
217 {
218         if (user->quitting)
219                 return;
220
221         if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
222         {
223                 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
224                 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
225                         user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
226                 return;
227         }
228         unsigned long sendqmax = ULONG_MAX;
229         if (!user->HasPrivPermission("users/flood/increased-buffers"))
230                 sendqmax = user->MyClass->GetSendqSoftMax();
231         unsigned long penaltymax = ULONG_MAX;
232         if (!user->HasPrivPermission("users/flood/no-fakelag"))
233                 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
234
235         while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
236         {
237                 std::string line;
238                 line.reserve(ServerInstance->Config->Limits.MaxLine);
239                 std::string::size_type qpos = 0;
240                 while (qpos < recvq.length())
241                 {
242                         char c = recvq[qpos++];
243                         switch (c)
244                         {
245                         case '\0':
246                                 c = ' ';
247                                 break;
248                         case '\r':
249                                 continue;
250                         case '\n':
251                                 goto eol_found;
252                         }
253                         if (line.length() < ServerInstance->Config->Limits.MaxLine - 2)
254                                 line.push_back(c);
255                 }
256                 // if we got here, the recvq ran out before we found a newline
257                 return;
258 eol_found:
259                 // just found a newline. Terminate the string, and pull it out of recvq
260                 recvq.erase(0, qpos);
261
262                 // TODO should this be moved to when it was inserted in recvq?
263                 ServerInstance->stats.Recv += qpos;
264                 user->bytes_in += qpos;
265                 user->cmds_in++;
266
267                 ServerInstance->Parser.ProcessBuffer(line, user);
268                 if (user->quitting)
269                         return;
270         }
271         if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
272                 ServerInstance->Users->QuitUser(user, "Excess Flood");
273 }
274
275 void UserIOHandler::AddWriteBuf(const std::string &data)
276 {
277         if (user->quitting_sendq)
278                 return;
279         if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
280                 !user->HasPrivPermission("users/flood/increased-buffers"))
281         {
282                 user->quitting_sendq = true;
283                 ServerInstance->GlobalCulls.AddSQItem(user);
284                 return;
285         }
286
287         // We still want to append data to the sendq of a quitting user,
288         // e.g. their ERROR message that says 'closing link'
289
290         WriteData(data);
291 }
292
293 void UserIOHandler::OnError(BufferedSocketError)
294 {
295         ServerInstance->Users->QuitUser(user, getError());
296 }
297
298 CullResult User::cull()
299 {
300         if (!quitting)
301                 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
302
303         if (client_sa.sa.sa_family != AF_UNSPEC)
304                 ServerInstance->Users->RemoveCloneCounts(this);
305
306         return Extensible::cull();
307 }
308
309 CullResult LocalUser::cull()
310 {
311         eh.cull();
312         return User::cull();
313 }
314
315 CullResult FakeUser::cull()
316 {
317         // Fake users don't quit, they just get culled.
318         quitting = true;
319         // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
320         return User::cull();
321 }
322
323 void User::Oper(OperInfo* info)
324 {
325         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
326         if (this->IsModeSet(opermh))
327                 this->UnOper();
328
329         this->SetMode(opermh, true);
330         this->oper = info;
331         this->WriteCommand("MODE", "+o");
332         FOREACH_MOD(OnOper, (this, info->name));
333
334         std::string opername;
335         if (info->oper_block)
336                 opername = info->oper_block->getString("name");
337
338         if (IS_LOCAL(this))
339         {
340                 LocalUser* l = IS_LOCAL(this);
341                 std::string vhost = oper->getConfig("vhost");
342                 if (!vhost.empty())
343                         l->ChangeDisplayedHost(vhost);
344                 std::string opClass = oper->getConfig("class");
345                 if (!opClass.empty())
346                         l->SetClass(opClass);
347         }
348
349         ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s (using oper '%s')",
350                 nick.c_str(), ident.c_str(), host.c_str(), oper->name.c_str(), opername.c_str());
351         this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
352
353         ServerInstance->Logs->Log("OPER", LOG_DEFAULT, "%s opered as type: %s", GetFullRealHost().c_str(), oper->name.c_str());
354         ServerInstance->Users->all_opers.push_back(this);
355
356         // Expand permissions from config for faster lookup
357         if (IS_LOCAL(this))
358                 oper->init();
359
360         FOREACH_MOD(OnPostOper, (this, oper->name, opername));
361 }
362
363 void OperInfo::init()
364 {
365         AllowedOperCommands.clear();
366         AllowedPrivs.clear();
367         AllowedUserModes.reset();
368         AllowedChanModes.reset();
369         AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
370
371         for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
372         {
373                 ConfigTag* tag = *iter;
374                 std::string mycmd, mypriv;
375                 /* Process commands */
376                 irc::spacesepstream CommandList(tag->getString("commands"));
377                 while (CommandList.GetToken(mycmd))
378                 {
379                         AllowedOperCommands.insert(mycmd);
380                 }
381
382                 irc::spacesepstream PrivList(tag->getString("privs"));
383                 while (PrivList.GetToken(mypriv))
384                 {
385                         AllowedPrivs.insert(mypriv);
386                 }
387
388                 std::string modes = tag->getString("usermodes");
389                 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
390                 {
391                         if (*c == '*')
392                         {
393                                 this->AllowedUserModes.set();
394                         }
395                         else if (*c >= 'A' && *c <= 'z')
396                         {
397                                 this->AllowedUserModes[*c - 'A'] = true;
398                         }
399                 }
400
401                 modes = tag->getString("chanmodes");
402                 for (std::string::const_iterator c = modes.begin(); c != modes.end(); ++c)
403                 {
404                         if (*c == '*')
405                         {
406                                 this->AllowedChanModes.set();
407                         }
408                         else if (*c >= 'A' && *c <= 'z')
409                         {
410                                 this->AllowedChanModes[*c - 'A'] = true;
411                         }
412                 }
413         }
414 }
415
416 void User::UnOper()
417 {
418         if (!this->IsOper())
419                 return;
420
421         /*
422          * unset their oper type (what IS_OPER checks).
423          * note, order is important - this must come before modes as -o attempts
424          * to call UnOper. -- w00t
425          */
426         oper = NULL;
427
428
429         /* Remove all oper only modes from the user when the deoper - Bug #466*/
430         Modes::ChangeList changelist;
431         const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
432         for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
433         {
434                 ModeHandler* mh = i->second;
435                 if (mh->NeedsOper())
436                         changelist.push_remove(mh);
437         }
438
439         ServerInstance->Modes->Process(this, NULL, this, changelist);
440
441         // Remove the user from the oper list
442         stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
443
444         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
445         this->SetMode(opermh, false);
446 }
447
448 /*
449  * Check class restrictions
450  */
451 void LocalUser::CheckClass(bool clone_count)
452 {
453         ConnectClass* a = this->MyClass;
454
455         if (!a)
456         {
457                 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
458                 return;
459         }
460         else if (a->type == CC_DENY)
461         {
462                 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection"));
463                 return;
464         }
465         else if (clone_count)
466         {
467                 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
468                 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
469                 {
470                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
471                         if (a->maxconnwarn)
472                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString().c_str());
473                         return;
474                 }
475                 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
476                 {
477                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
478                         if (a->maxconnwarn)
479                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString().c_str());
480                         return;
481                 }
482         }
483
484         this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout;
485 }
486
487 bool LocalUser::CheckLines(bool doZline)
488 {
489         const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
490
491         if (!this->exempt)
492         {
493                 for (int n = 0; check[n]; ++n)
494                 {
495                         XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
496
497                         if (r)
498                         {
499                                 r->Apply(this);
500                                 return true;
501                         }
502                 }
503         }
504
505         return false;
506 }
507
508 void LocalUser::FullConnect()
509 {
510         ServerInstance->stats.Connects++;
511         this->idle_lastmsg = ServerInstance->Time();
512
513         /*
514          * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
515          * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
516          * may put the user into a totally seperate class with different restrictions! so we *must* check again.
517          * Don't remove this! -- w00t
518          */
519         MyClass = NULL;
520         SetClass();
521         CheckClass();
522         CheckLines();
523
524         if (quitting)
525                 return;
526
527         this->WriteNumeric(RPL_WELCOME, InspIRCd::Format("Welcome to the %s IRC Network %s", ServerInstance->Config->Network.c_str(), GetFullRealHost().c_str()));
528         this->WriteNumeric(RPL_YOURHOSTIS, InspIRCd::Format("Your host is %s, running version %s", ServerInstance->Config->ServerName.c_str(), INSPIRCD_BRANCH));
529         this->WriteNumeric(RPL_SERVERCREATED, InspIRCd::Format("This server was created %s %s", __TIME__, __DATE__));
530
531         const std::string& modelist = ServerInstance->Modes->GetModeListFor004Numeric();
532         this->WriteNumeric(RPL_SERVERVERSION, ServerInstance->Config->ServerName, INSPIRCD_BRANCH, modelist);
533
534         ServerInstance->ISupport.SendTo(this);
535
536         /* Now registered */
537         if (ServerInstance->Users->unregistered_count)
538                 ServerInstance->Users->unregistered_count--;
539
540         /* Trigger MOTD and LUSERS output, give modules a chance too */
541         ModResult MOD_RESULT;
542         std::string command("LUSERS");
543         std::vector<std::string> parameters;
544         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
545         if (!MOD_RESULT)
546                 ServerInstance->Parser.CallHandler(command, parameters, this);
547
548         MOD_RESULT = MOD_RES_PASSTHRU;
549         command = "MOTD";
550         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, parameters, this, true, command));
551         if (!MOD_RESULT)
552                 ServerInstance->Parser.CallHandler(command, parameters, this);
553
554         if (ServerInstance->Config->RawLog)
555                 WriteServ("PRIVMSG %s :*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.", nick.c_str());
556
557         /*
558          * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
559          * for a user that doesn't exist yet.
560          */
561         FOREACH_MOD(OnUserConnect, (this));
562
563         this->registered = REG_ALL;
564
565         FOREACH_MOD(OnPostConnect, (this));
566
567         ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
568                 this->GetServerPort(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->fullname.c_str());
569         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
570         ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
571         // reset the flood penalty (which could have been raised due to things like auto +x)
572         CommandFloodPenalty = 0;
573 }
574
575 void User::InvalidateCache()
576 {
577         /* Invalidate cache */
578         cached_fullhost.clear();
579         cached_hostip.clear();
580         cached_makehost.clear();
581         cached_fullrealhost.clear();
582 }
583
584 bool User::ChangeNick(const std::string& newnick, time_t newts)
585 {
586         if (quitting)
587         {
588                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
589                 return false;
590         }
591
592         User* const InUse = ServerInstance->FindNickOnly(newnick);
593         if (InUse == this)
594         {
595                 // case change, don't need to check campers
596                 // and, if it's identical including case, we can leave right now
597                 // We also don't update the nick TS if it's a case change, either
598                 if (newnick == nick)
599                         return true;
600         }
601         else
602         {
603                 /*
604                  * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
605                  * then we have a potential collide. Check whether someone else is camping on the nick
606                  * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
607                  * camper to their UID, and allow the incoming nick change.
608                  *
609                  * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
610                  * because the nick is already (rightfully) in use. -- w00t
611                  */
612                 if (InUse)
613                 {
614                         if (InUse->registered != REG_ALL)
615                         {
616                                 /* force the camper to their UUID, and ask them to re-send a NICK. */
617                                 InUse->WriteFrom(InUse, "NICK %s", InUse->uuid.c_str());
618                                 InUse->WriteNumeric(ERR_NICKNAMEINUSE, InUse->nick, "Nickname overruled.");
619
620                                 InUse->registered &= ~REG_NICK;
621                                 InUse->ChangeNick(InUse->uuid);
622                         }
623                         else
624                         {
625                                 /* No camping, tell the incoming user  to stop trying to change nick ;p */
626                                 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
627                                 return false;
628                         }
629                 }
630
631                 age = newts ? newts : ServerInstance->Time();
632         }
633
634         if (this->registered == REG_ALL)
635                 this->WriteCommon("NICK %s",newnick.c_str());
636         std::string oldnick = nick;
637         nick = newnick;
638
639         InvalidateCache();
640         ServerInstance->Users->clientlist.erase(oldnick);
641         ServerInstance->Users->clientlist[newnick] = this;
642
643         if (registered == REG_ALL)
644                 FOREACH_MOD(OnUserPostNick, (this,oldnick));
645
646         return true;
647 }
648
649 int LocalUser::GetServerPort()
650 {
651         switch (this->server_sa.sa.sa_family)
652         {
653                 case AF_INET6:
654                         return htons(this->server_sa.in6.sin6_port);
655                 case AF_INET:
656                         return htons(this->server_sa.in4.sin_port);
657         }
658         return 0;
659 }
660
661 const std::string& User::GetIPString()
662 {
663         int port;
664         if (cachedip.empty())
665         {
666                 irc::sockets::satoap(client_sa, cachedip, port);
667                 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
668                 if (cachedip[0] == ':')
669                         cachedip.insert(cachedip.begin(),1,'0');
670         }
671
672         return cachedip;
673 }
674
675 irc::sockets::cidr_mask User::GetCIDRMask()
676 {
677         int range = 0;
678         switch (client_sa.sa.sa_family)
679         {
680                 case AF_INET6:
681                         range = ServerInstance->Config->c_ipv6_range;
682                         break;
683                 case AF_INET:
684                         range = ServerInstance->Config->c_ipv4_range;
685                         break;
686         }
687         return irc::sockets::cidr_mask(client_sa, range);
688 }
689
690 bool User::SetClientIP(const char* sip, bool recheck_eline)
691 {
692         cachedip.clear();
693         cached_hostip.clear();
694         return irc::sockets::aptosa(sip, 0, client_sa);
695 }
696
697 void User::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
698 {
699         cachedip.clear();
700         cached_hostip.clear();
701         memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
702 }
703
704 bool LocalUser::SetClientIP(const char* sip, bool recheck_eline)
705 {
706         irc::sockets::sockaddrs sa;
707         if (!irc::sockets::aptosa(sip, 0, sa))
708                 // Invalid
709                 return false;
710
711         LocalUser::SetClientIP(sa, recheck_eline);
712         return true;
713 }
714
715 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline)
716 {
717         if (sa != client_sa)
718         {
719                 User::SetClientIP(sa);
720                 if (recheck_eline)
721                         this->exempt = (ServerInstance->XLines->MatchesLine("E", this) != NULL);
722
723                 FOREACH_MOD(OnSetUserIP, (this));
724         }
725 }
726
727 static std::string wide_newline("\r\n");
728
729 void User::Write(const std::string& text)
730 {
731 }
732
733 void User::Write(const char *text, ...)
734 {
735 }
736
737 void LocalUser::Write(const std::string& text)
738 {
739         if (!SocketEngine::BoundsCheckFd(&eh))
740                 return;
741
742         if (text.length() > ServerInstance->Config->Limits.MaxLine - 2)
743         {
744                 // this should happen rarely or never. Crop the string at 512 and try again.
745                 std::string try_again(text, 0, ServerInstance->Config->Limits.MaxLine - 2);
746                 Write(try_again);
747                 return;
748         }
749
750         ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %s", uuid.c_str(), text.c_str());
751
752         eh.AddWriteBuf(text);
753         eh.AddWriteBuf(wide_newline);
754
755         ServerInstance->stats.Sent += text.length() + 2;
756         this->bytes_out += text.length() + 2;
757         this->cmds_out++;
758 }
759
760 /** Write()
761  */
762 void LocalUser::Write(const char *text, ...)
763 {
764         std::string textbuffer;
765         VAFORMAT(textbuffer, text, text);
766         this->Write(textbuffer);
767 }
768
769 void User::WriteServ(const std::string& text)
770 {
771         this->Write(":%s %s",ServerInstance->Config->ServerName.c_str(),text.c_str());
772 }
773
774 /** WriteServ()
775  *  Same as Write(), except `text' is prefixed with `:server.name '.
776  */
777 void User::WriteServ(const char* text, ...)
778 {
779         std::string textbuffer;
780         VAFORMAT(textbuffer, text, text);
781         this->WriteServ(textbuffer);
782 }
783
784 void User::WriteCommand(const char* command, const std::string& text)
785 {
786         this->WriteServ(command + (this->registered & REG_NICK ? " " + this->nick : " *") + " " + text);
787 }
788
789 namespace
790 {
791         std::string BuildNumeric(const std::string& source, User* targetuser, unsigned int num, const std::vector<std::string>& params)
792         {
793                 const char* const target = (targetuser->registered & REG_NICK ? targetuser->nick.c_str() : "*");
794                 std::string raw = InspIRCd::Format(":%s %03u %s", source.c_str(), num, target);
795                 if (!params.empty())
796                 {
797                         for (std::vector<std::string>::const_iterator i = params.begin(); i != params.end()-1; ++i)
798                                 raw.append(1, ' ').append(*i);
799                         raw.append(" :").append(params.back());
800                 }
801                 return raw;
802         }
803 }
804
805 void User::WriteNumeric(const Numeric::Numeric& numeric)
806 {
807         ModResult MOD_RESULT;
808
809         FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
810
811         if (MOD_RESULT == MOD_RES_DENY)
812                 return;
813
814         const std::string& servername = (numeric.GetServer() ? numeric.GetServer()->GetName() : ServerInstance->Config->ServerName);
815         this->Write(BuildNumeric(servername, this, numeric.GetNumeric(), numeric.GetParams()));
816 }
817
818 void User::WriteFrom(User *user, const std::string &text)
819 {
820         const std::string message = ":" + user->GetFullHost() + " " + text;
821         this->Write(message);
822 }
823
824
825 /* write text from an originating user to originating user */
826
827 void User::WriteFrom(User *user, const char* text, ...)
828 {
829         std::string textbuffer;
830         VAFORMAT(textbuffer, text, text);
831         this->WriteFrom(user, textbuffer);
832 }
833
834 void User::WriteRemoteNotice(const std::string& text)
835 {
836         ServerInstance->PI->SendUserNotice(this, text);
837 }
838
839 void LocalUser::WriteRemoteNotice(const std::string& text)
840 {
841         WriteNotice(text);
842 }
843
844 namespace
845 {
846         class WriteCommonRawHandler : public User::ForEachNeighborHandler
847         {
848                 const std::string& msg;
849
850                 void Execute(LocalUser* user) CXX11_OVERRIDE
851                 {
852                         user->Write(msg);
853                 }
854
855          public:
856                 WriteCommonRawHandler(const std::string& message)
857                         : msg(message)
858                 {
859                 }
860         };
861 }
862
863 void User::WriteCommon(const char* text, ...)
864 {
865         std::string textbuffer;
866         VAFORMAT(textbuffer, text, text);
867         textbuffer = ":" + this->GetFullHost() + " " + textbuffer;
868         this->WriteCommonRaw(textbuffer, true);
869 }
870
871 void User::WriteCommonRaw(const std::string &line, bool include_self)
872 {
873         WriteCommonRawHandler handler(line);
874         ForEachNeighbor(handler, include_self);
875 }
876
877 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
878 {
879         // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
880         // and visit all users on those channels. Because two users may share more than one common channel,
881         // we must skip users that we have already visited.
882         // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
883         // The global counter is incremented every time we do something for each neighbor of a user. Then,
884         // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
885         // skip the member. Otherwise, we set it to the current counter and visit the member.
886
887         // Ask modules to build a list of exceptions.
888         // Mods may also exclude entire channels by erasing them from include_chans.
889         IncludeChanList include_chans(chans.begin(), chans.end());
890         std::map<User*, bool> exceptions;
891         exceptions[this] = include_self;
892         FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
893
894         // Get next id, guaranteed to differ from the already_sent field of all users
895         const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
896
897         // Handle exceptions first
898         for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
899         {
900                 LocalUser* curr = IS_LOCAL(i->first);
901                 if (curr)
902                 {
903                         // Mark as visited to ensure we won't visit again if there is a common channel
904                         curr->already_sent = newid;
905                         // Always treat quitting users as excluded
906                         if ((i->second) && (!curr->quitting))
907                                 handler.Execute(curr);
908                 }
909         }
910
911         // Now consider the real neighbors
912         for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
913         {
914                 Channel* chan = (*i)->chan;
915                 const Channel::MemberMap& userlist = chan->GetUsers();
916                 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
917                 {
918                         LocalUser* curr = IS_LOCAL(j->first);
919                         // User not yet visited?
920                         if ((curr) && (curr->already_sent != newid))
921                         {
922                                 // Mark as visited and execute function
923                                 curr->already_sent = newid;
924                                 handler.Execute(curr);
925                         }
926                 }
927         }
928 }
929
930 void LocalUser::SendText(const std::string& line)
931 {
932         Write(line);
933 }
934
935 void RemoteUser::SendText(const std::string& line)
936 {
937         ServerInstance->PI->PushToClient(this, line);
938 }
939
940 void FakeUser::SendText(const std::string& line)
941 {
942 }
943
944 void User::SendText(const char *text, ...)
945 {
946         std::string line;
947         VAFORMAT(line, text, text);
948         SendText(line);
949 }
950
951 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
952 {
953         WriteNumeric(numeric);
954 }
955
956 /* return 0 or 1 depending if users u and u2 share one or more common channels
957  * (used by QUIT, NICK etc which arent channel specific notices)
958  *
959  * The old algorithm in 1.0 for this was relatively inefficient, iterating over
960  * the first users channels then the second users channels within the outer loop,
961  * therefore it was a maximum of x*y iterations (upon returning 0 and checking
962  * all possible iterations). However this new function instead checks against the
963  * channel's userlist in the inner loop which is a std::map<User*,User*>
964  * and saves us time as we already know what pointer value we are after.
965  * Don't quote me on the maths as i am not a mathematician or computer scientist,
966  * but i believe this algorithm is now x+(log y) maximum iterations instead.
967  */
968 bool User::SharesChannelWith(User *other)
969 {
970         /* Outer loop */
971         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
972         {
973                 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
974                  * by replacing it with a map::find which *should* be more efficient
975                  */
976                 if ((*i)->chan->HasUser(other))
977                         return true;
978         }
979         return false;
980 }
981
982 bool User::ChangeName(const std::string& gecos)
983 {
984         if (!this->fullname.compare(gecos))
985                 return true;
986
987         if (IS_LOCAL(this))
988         {
989                 ModResult MOD_RESULT;
990                 FIRST_MOD_RESULT(OnChangeLocalUserGECOS, MOD_RESULT, (IS_LOCAL(this),gecos));
991                 if (MOD_RESULT == MOD_RES_DENY)
992                         return false;
993                 FOREACH_MOD(OnChangeName, (this,gecos));
994         }
995         this->fullname.assign(gecos, 0, ServerInstance->Config->Limits.MaxGecos);
996
997         return true;
998 }
999
1000 bool User::ChangeDisplayedHost(const std::string& shost)
1001 {
1002         if (dhost == shost)
1003                 return true;
1004
1005         if (IS_LOCAL(this))
1006         {
1007                 ModResult MOD_RESULT;
1008                 FIRST_MOD_RESULT(OnChangeLocalUserHost, MOD_RESULT, (IS_LOCAL(this),shost));
1009                 if (MOD_RESULT == MOD_RES_DENY)
1010                         return false;
1011         }
1012
1013         FOREACH_MOD(OnChangeHost, (this,shost));
1014
1015         this->dhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1016         this->InvalidateCache();
1017
1018         if (IS_LOCAL(this))
1019                 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->dhost, "is now your displayed host");
1020
1021         return true;
1022 }
1023
1024 bool User::ChangeIdent(const std::string& newident)
1025 {
1026         if (this->ident == newident)
1027                 return true;
1028
1029         FOREACH_MOD(OnChangeIdent, (this,newident));
1030
1031         this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1032         this->InvalidateCache();
1033
1034         return true;
1035 }
1036
1037 /*
1038  * Sets a user's connection class.
1039  * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1040  * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1041  * then their ip will be taken as 'priority' anyway, so for example,
1042  * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1043  */
1044 void LocalUser::SetClass(const std::string &explicit_name)
1045 {
1046         ConnectClass *found = NULL;
1047
1048         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for UID %s", this->uuid.c_str());
1049
1050         if (!explicit_name.empty())
1051         {
1052                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1053                 {
1054                         ConnectClass* c = *i;
1055
1056                         if (explicit_name == c->name)
1057                         {
1058                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Explicitly set to %s", explicit_name.c_str());
1059                                 found = c;
1060                         }
1061                 }
1062         }
1063         else
1064         {
1065                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1066                 {
1067                         ConnectClass* c = *i;
1068                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking %s", c->GetName().c_str());
1069
1070                         ModResult MOD_RESULT;
1071                         FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1072                         if (MOD_RESULT == MOD_RES_DENY)
1073                                 continue;
1074                         if (MOD_RESULT == MOD_RES_ALLOW)
1075                         {
1076                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class forced by module to %s", c->GetName().c_str());
1077                                 found = c;
1078                                 break;
1079                         }
1080
1081                         if (c->type == CC_NAMED)
1082                                 continue;
1083
1084                         bool regdone = (registered != REG_NONE);
1085                         if (c->config->getBool("registered", regdone) != regdone)
1086                                 continue;
1087
1088                         /* check if host matches.. */
1089                         if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1090                             !InspIRCd::MatchCIDR(this->host, c->GetHost(), NULL))
1091                         {
1092                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "No host match (for %s)", c->GetHost().c_str());
1093                                 continue;
1094                         }
1095
1096                         /*
1097                          * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1098                          * because we should attempt to find another class if this one doesn't match us. -- w00t
1099                          */
1100                         if (c->limit && (c->GetReferenceCount() >= c->limit))
1101                         {
1102                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "OOPS: Connect class limit (%lu) hit, denying", c->limit);
1103                                 continue;
1104                         }
1105
1106                         /* if it requires a port ... */
1107                         int port = c->config->getInt("port");
1108                         if (port)
1109                         {
1110                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Requires port (%d)", port);
1111
1112                                 /* and our port doesn't match, fail. */
1113                                 if (this->GetServerPort() != port)
1114                                         continue;
1115                         }
1116
1117                         if (regdone && !c->config->getString("password").empty())
1118                         {
1119                                 if (!ServerInstance->PassCompare(this, c->config->getString("password"), password, c->config->getString("hash")))
1120                                 {
1121                                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Bad password, skipping");
1122                                         continue;
1123                                 }
1124                         }
1125
1126                         /* we stop at the first class that meets ALL critera. */
1127                         found = c;
1128                         break;
1129                 }
1130         }
1131
1132         /*
1133          * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1134          */
1135         if (found)
1136         {
1137                 MyClass = found;
1138         }
1139 }
1140
1141 void User::PurgeEmptyChannels()
1142 {
1143         // firstly decrement the count on each channel
1144         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1145         {
1146                 Channel* c = (*i)->chan;
1147                 ++i;
1148                 c->DelUser(this);
1149         }
1150
1151         this->UnOper();
1152 }
1153
1154 const std::string& FakeUser::GetFullHost()
1155 {
1156         if (!ServerInstance->Config->HideWhoisServer.empty())
1157                 return ServerInstance->Config->HideWhoisServer;
1158         return server->GetName();
1159 }
1160
1161 const std::string& FakeUser::GetFullRealHost()
1162 {
1163         if (!ServerInstance->Config->HideWhoisServer.empty())
1164                 return ServerInstance->Config->HideWhoisServer;
1165         return server->GetName();
1166 }
1167
1168 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1169         : config(tag), type(t), fakelag(true), name("unnamed"), registration_timeout(0), host(mask),
1170         pingtime(0), softsendqmax(0), hardsendqmax(0), recvqmax(0),
1171         penaltythreshold(0), commandrate(0), maxlocal(0), maxglobal(0), maxconnwarn(true), maxchans(ServerInstance->Config->MaxChans),
1172         limit(0), resolvehostnames(true)
1173 {
1174 }
1175
1176 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1177         : config(tag), type(t), fakelag(parent.fakelag), name("unnamed"),
1178         registration_timeout(parent.registration_timeout), host(mask), pingtime(parent.pingtime),
1179         softsendqmax(parent.softsendqmax), hardsendqmax(parent.hardsendqmax), recvqmax(parent.recvqmax),
1180         penaltythreshold(parent.penaltythreshold), commandrate(parent.commandrate),
1181         maxlocal(parent.maxlocal), maxglobal(parent.maxglobal), maxconnwarn(parent.maxconnwarn), maxchans(parent.maxchans),
1182         limit(parent.limit), resolvehostnames(parent.resolvehostnames)
1183 {
1184 }
1185
1186 void ConnectClass::Update(const ConnectClass* src)
1187 {
1188         config = src->config;
1189         type = src->type;
1190         fakelag = src->fakelag;
1191         name = src->name;
1192         registration_timeout = src->registration_timeout;
1193         host = src->host;
1194         pingtime = src->pingtime;
1195         softsendqmax = src->softsendqmax;
1196         hardsendqmax = src->hardsendqmax;
1197         recvqmax = src->recvqmax;
1198         penaltythreshold = src->penaltythreshold;
1199         commandrate = src->commandrate;
1200         maxlocal = src->maxlocal;
1201         maxglobal = src->maxglobal;
1202         maxconnwarn = src->maxconnwarn;
1203         maxchans = src->maxchans;
1204         limit = src->limit;
1205         resolvehostnames = src->resolvehostnames;
1206 }