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