]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/users.cpp
Add default empty openssl compiler flags.
[user/henk/code/inspircd.git] / src / users.cpp
1 /*
2  * InspIRCd -- Internet Relay Chat Daemon
3  *
4  *   Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
5  *   Copyright (C) 2018 systocrat <systocrat@outlook.com>
6  *   Copyright (C) 2018 Dylan Frank <b00mx0r@aureus.pw>
7  *   Copyright (C) 2013, 2016-2020 Sadie Powell <sadie@witchery.services>
8  *   Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
9  *   Copyright (C) 2013 ChrisTX <xpipe@hotmail.de>
10  *   Copyright (C) 2013 Adam <Adam@anope.org>
11  *   Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
12  *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
13  *   Copyright (C) 2012 DjSlash <djslash@djslash.org>
14  *   Copyright (C) 2011 jackmcbarn <jackmcbarn@inspircd.org>
15  *   Copyright (C) 2009-2011 Daniel De Graaf <danieldg@inspircd.org>
16  *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
17  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
18  *   Copyright (C) 2008 John Brooks <special@inspircd.org>
19  *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
20  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
21  *   Copyright (C) 2006-2009 Craig Edwards <brain@inspircd.org>
22  *
23  * This file is part of InspIRCd.  InspIRCd is free software: you can
24  * redistribute it and/or modify it under the terms of the GNU General Public
25  * License as published by the Free Software Foundation, version 2.
26  *
27  * This program is distributed in the hope that it will be useful, but WITHOUT
28  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
29  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
30  * details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
34  */
35
36
37 #include "inspircd.h"
38 #include "xline.h"
39
40 ClientProtocol::MessageList LocalUser::sendmsglist;
41
42 bool User::IsNoticeMaskSet(unsigned char sm)
43 {
44         if (!isalpha(sm))
45                 return false;
46         return (snomasks[sm-65]);
47 }
48
49 bool User::IsModeSet(unsigned char m) const
50 {
51         ModeHandler* mh = ServerInstance->Modes->FindMode(m, MODETYPE_USER);
52         return (mh && modes[mh->GetId()]);
53 }
54
55 std::string User::GetModeLetters(bool includeparams) const
56 {
57         std::string ret(1, '+');
58         std::string params;
59
60         for (unsigned char i = 'A'; i <= 'z'; i++)
61         {
62                 const ModeHandler* const mh = ServerInstance->Modes.FindMode(i, MODETYPE_USER);
63                 if ((!mh) || (!IsModeSet(mh)))
64                         continue;
65
66                 ret.push_back(mh->GetModeChar());
67                 if ((includeparams) && (mh->NeedsParam(true)))
68                 {
69                         const std::string val = mh->GetUserParameter(this);
70                         if (!val.empty())
71                                 params.append(1, ' ').append(val);
72                 }
73         }
74
75         ret += params;
76         return ret;
77 }
78
79 User::User(const std::string& uid, Server* srv, UserType type)
80         : age(ServerInstance->Time())
81         , signon(0)
82         , uuid(uid)
83         , server(srv)
84         , registered(REG_NONE)
85         , quitting(false)
86         , usertype(type)
87 {
88         client_sa.sa.sa_family = AF_UNSPEC;
89
90         ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
91
92         if (srv->IsULine())
93                 ServerInstance->Users.all_ulines.push_back(this);
94
95         // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
96         if (type != USERTYPE_SERVER)
97         {
98                 if (!ServerInstance->Users.uuidlist.insert(std::make_pair(uuid, this)).second)
99                         throw CoreException("Duplicate UUID in User constructor: " + uuid);
100         }
101 }
102
103 LocalUser::LocalUser(int myfd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* servaddr)
104         : User(ServerInstance->UIDGen.GetUID(), ServerInstance->FakeClient->server, USERTYPE_LOCAL)
105         , eh(this)
106         , serializer(NULL)
107         , bytes_in(0)
108         , bytes_out(0)
109         , cmds_in(0)
110         , cmds_out(0)
111         , quitting_sendq(false)
112         , lastping(true)
113         , exempt(false)
114         , nextping(0)
115         , idle_lastmsg(0)
116         , CommandFloodPenalty(0)
117         , already_sent(0)
118 {
119         signon = ServerInstance->Time();
120         // The user's default nick is their UUID
121         nick = uuid;
122         ident = uuid;
123         eh.SetFd(myfd);
124         memcpy(&client_sa, client, sizeof(irc::sockets::sockaddrs));
125         memcpy(&server_sa, servaddr, sizeof(irc::sockets::sockaddrs));
126         ChangeRealHost(GetIPString(), true);
127 }
128
129 LocalUser::LocalUser(int myfd, const std::string& uid, Serializable::Data& data)
130         : User(uid, ServerInstance->FakeClient->server, USERTYPE_LOCAL)
131         , eh(this)
132         , already_sent(0)
133 {
134         eh.SetFd(myfd);
135         Deserialize(data);
136 }
137
138 User::~User()
139 {
140 }
141
142 const std::string& User::MakeHost()
143 {
144         if (!this->cached_makehost.empty())
145                 return this->cached_makehost;
146
147         this->cached_makehost = ident + "@" + GetRealHost();
148         return this->cached_makehost;
149 }
150
151 const std::string& User::MakeHostIP()
152 {
153         if (!this->cached_hostip.empty())
154                 return this->cached_hostip;
155
156         this->cached_hostip = ident + "@" + this->GetIPString();
157         return this->cached_hostip;
158 }
159
160 const std::string& User::GetFullHost()
161 {
162         if (!this->cached_fullhost.empty())
163                 return this->cached_fullhost;
164
165         this->cached_fullhost = nick + "!" + ident + "@" + GetDisplayedHost();
166         return this->cached_fullhost;
167 }
168
169 const std::string& User::GetFullRealHost()
170 {
171         if (!this->cached_fullrealhost.empty())
172                 return this->cached_fullrealhost;
173
174         this->cached_fullrealhost = nick + "!" + ident + "@" + GetRealHost();
175         return this->cached_fullrealhost;
176 }
177
178 bool User::HasModePermission(const ModeHandler* mh) const
179 {
180         return true;
181 }
182
183 bool LocalUser::HasModePermission(const ModeHandler* mh) const
184 {
185         if (!this->IsOper())
186                 return false;
187
188         const unsigned char mode = mh->GetModeChar();
189         if (!ModeParser::IsModeChar(mode))
190                 return false;
191
192         return ((mh->GetModeType() == MODETYPE_USER ? oper->AllowedUserModes : oper->AllowedChanModes))[(mode - 'A')];
193
194 }
195 /*
196  * users on remote servers can completely bypass all permissions based checks.
197  * This prevents desyncs when one server has different type/class tags to another.
198  * That having been said, this does open things up to the possibility of source changes
199  * allowing remote kills, etc - but if they have access to the src, they most likely have
200  * access to the conf - so it's an end to a means either way.
201  */
202 bool User::HasCommandPermission(const std::string&)
203 {
204         return true;
205 }
206
207 bool LocalUser::HasCommandPermission(const std::string& command)
208 {
209         // are they even an oper at all?
210         if (!this->IsOper())
211         {
212                 return false;
213         }
214
215         return oper->AllowedOperCommands.Contains(command);
216 }
217
218 bool User::HasPrivPermission(const std::string& privstr)
219 {
220         return true;
221 }
222
223 bool LocalUser::HasPrivPermission(const std::string& privstr)
224 {
225         if (!this->IsOper())
226                 return false;
227
228         return oper->AllowedPrivs.Contains(privstr);
229 }
230
231 bool User::HasSnomaskPermission(char chr) const
232 {
233         return true;
234 }
235
236 bool LocalUser::HasSnomaskPermission(char chr) const
237 {
238         if (!this->IsOper() || !ModeParser::IsModeChar(chr))
239                 return false;
240
241         return this->oper->AllowedSnomasks[chr - 'A'];
242 }
243
244 void UserIOHandler::OnDataReady()
245 {
246         if (user->quitting)
247                 return;
248
249         if (recvq.length() > user->MyClass->GetRecvqMax() && !user->HasPrivPermission("users/flood/increased-buffers"))
250         {
251                 ServerInstance->Users->QuitUser(user, "RecvQ exceeded");
252                 ServerInstance->SNO->WriteToSnoMask('a', "User %s RecvQ of %lu exceeds connect class maximum of %lu",
253                         user->nick.c_str(), (unsigned long)recvq.length(), user->MyClass->GetRecvqMax());
254                 return;
255         }
256
257         unsigned long sendqmax = ULONG_MAX;
258         if (!user->HasPrivPermission("users/flood/increased-buffers"))
259                 sendqmax = user->MyClass->GetSendqSoftMax();
260
261         unsigned long penaltymax = ULONG_MAX;
262         if (!user->HasPrivPermission("users/flood/no-fakelag"))
263                 penaltymax = user->MyClass->GetPenaltyThreshold() * 1000;
264
265         // The cleaned message sent by the user or empty if not found yet.
266         std::string line;
267
268         // The position of the most \n character or npos if not found yet.
269         std::string::size_type eolpos;
270
271         // The position within the recvq of the current character.
272         std::string::size_type qpos;
273
274         while (user->CommandFloodPenalty < penaltymax && getSendQSize() < sendqmax)
275         {
276                 // Check the newly received data for an EOL.
277                 eolpos = recvq.find('\n', checked_until);
278                 if (eolpos == std::string::npos)
279                 {
280                         checked_until = recvq.length();
281                         return;
282                 }
283
284                 // We've found a line! Clean it up and move it to the line buffer.
285                 line.reserve(eolpos);
286                 for (qpos = 0; qpos < eolpos; ++qpos)
287                 {
288                         char c = recvq[qpos];
289                         switch (c)
290                         {
291                                 case '\0':
292                                         c = ' ';
293                                         break;
294                                 case '\r':
295                                         continue;
296                         }
297
298                         line.push_back(c);
299                 }
300
301                 // just found a newline. Terminate the string, and pull it out of recvq
302                 recvq.erase(0, eolpos + 1);
303                 checked_until = 0;
304
305                 // TODO should this be moved to when it was inserted in recvq?
306                 ServerInstance->stats.Recv += qpos;
307                 user->bytes_in += qpos;
308                 user->cmds_in++;
309
310                 ServerInstance->Parser.ProcessBuffer(user, line);
311                 if (user->quitting)
312                         return;
313
314                 // clear() does not reclaim memory associated with the string, so our .reserve() call is safe
315                 line.clear();
316         }
317
318         if (user->CommandFloodPenalty >= penaltymax && !user->MyClass->fakelag)
319                 ServerInstance->Users->QuitUser(user, "Excess Flood");
320 }
321
322 void UserIOHandler::AddWriteBuf(const std::string &data)
323 {
324         if (user->quitting_sendq)
325                 return;
326         if (!user->quitting && getSendQSize() + data.length() > user->MyClass->GetSendqHardMax() &&
327                 !user->HasPrivPermission("users/flood/increased-buffers"))
328         {
329                 user->quitting_sendq = true;
330                 ServerInstance->GlobalCulls.AddSQItem(user);
331                 return;
332         }
333
334         // We still want to append data to the sendq of a quitting user,
335         // e.g. their ERROR message that says 'closing link'
336
337         WriteData(data);
338 }
339
340 void UserIOHandler::SwapInternals(UserIOHandler& other)
341 {
342         StreamSocket::SwapInternals(other);
343         std::swap(checked_until, other.checked_until);
344 }
345
346 bool UserIOHandler::OnSetEndPoint(const irc::sockets::sockaddrs& server, const irc::sockets::sockaddrs& client)
347 {
348         memcpy(&user->server_sa, &server, sizeof(irc::sockets::sockaddrs));
349         user->SetClientIP(client);
350         return !user->quitting;
351 }
352
353 void UserIOHandler::OnError(BufferedSocketError sockerr)
354 {
355         ModResult res;
356         FIRST_MOD_RESULT(OnConnectionFail, res, (user, sockerr));
357         if (res != MOD_RES_ALLOW)
358                 ServerInstance->Users->QuitUser(user, getError());
359 }
360
361 CullResult User::cull()
362 {
363         if (!quitting)
364                 ServerInstance->Users->QuitUser(this, "Culled without QuitUser");
365
366         if (client_sa.family() != AF_UNSPEC)
367                 ServerInstance->Users->RemoveCloneCounts(this);
368
369         if (server->IsULine())
370                 stdalgo::erase(ServerInstance->Users->all_ulines, this);
371
372         return Extensible::cull();
373 }
374
375 CullResult LocalUser::cull()
376 {
377         eh.cull();
378         return User::cull();
379 }
380
381 CullResult FakeUser::cull()
382 {
383         // Fake users don't quit, they just get culled.
384         quitting = true;
385         // Fake users are not inserted into UserManager::clientlist or uuidlist, so we don't need to modify those here
386         return User::cull();
387 }
388
389 void User::Oper(OperInfo* info)
390 {
391         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
392         if (opermh)
393         {
394                 if (this->IsModeSet(opermh))
395                         this->UnOper();
396                 this->SetMode(opermh, true);
397         }
398         this->oper = info;
399
400         LocalUser* localuser = IS_LOCAL(this);
401         if (localuser)
402         {
403                 Modes::ChangeList changelist;
404                 changelist.push_add(opermh);
405                 ClientProtocol::Events::Mode modemsg(ServerInstance->FakeClient, NULL, localuser, changelist);
406                 localuser->Send(modemsg);
407         }
408
409         FOREACH_MOD(OnOper, (this, info->name));
410
411         std::string opername;
412         if (info->oper_block)
413                 opername = info->oper_block->getString("name");
414
415         ServerInstance->SNO->WriteToSnoMask('o', "%s (%s@%s) is now a server operator of type %s (using oper '%s')",
416                 nick.c_str(), ident.c_str(), GetRealHost().c_str(), oper->name.c_str(), opername.c_str());
417         this->WriteNumeric(RPL_YOUAREOPER, InspIRCd::Format("You are now %s %s", strchr("aeiouAEIOU", oper->name[0]) ? "an" : "a", oper->name.c_str()));
418
419         ServerInstance->Users->all_opers.push_back(this);
420
421         // Expand permissions from config for faster lookup
422         if (localuser)
423                 oper->init();
424
425         FOREACH_MOD(OnPostOper, (this, oper->name, opername));
426 }
427
428 namespace
429 {
430         bool ParseModeList(std::bitset<64>& modeset, ConfigTag* tag, const std::string& field)
431         {
432                 std::string modes;
433                 bool hasmodes = tag->readString(field, modes);
434                 for (std::string::const_iterator iter = modes.begin(); iter != modes.end(); ++iter)
435                 {
436                         const char& chr = *iter;
437                         if (chr == '*')
438                                 modeset.set();
439                         else if (ModeParser::IsModeChar(chr))
440                                 modeset.set(chr - 'A');
441                         else
442                                 ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "'%c' is not a valid value for <class:%s>, ignoring...", chr, field.c_str());
443                 }
444                 return hasmodes;
445         }
446 }
447
448 void OperInfo::init()
449 {
450         AllowedOperCommands.Clear();
451         AllowedPrivs.Clear();
452         AllowedUserModes.reset();
453         AllowedChanModes.reset();
454         AllowedSnomasks.reset();
455         AllowedUserModes['o' - 'A'] = true; // Call me paranoid if you want.
456
457         bool defaultsnomasks = true;
458         for(std::vector<reference<ConfigTag> >::iterator iter = class_blocks.begin(); iter != class_blocks.end(); ++iter)
459         {
460                 ConfigTag* tag = *iter;
461
462                 AllowedOperCommands.AddList(tag->getString("commands"));
463                 AllowedPrivs.AddList(tag->getString("privs"));
464
465                 ParseModeList(AllowedChanModes, tag, "chanmodes");
466                 ParseModeList(AllowedUserModes, tag, "usermodes");
467                 if (ParseModeList(AllowedSnomasks, tag, "snomasks"))
468                         defaultsnomasks = false;
469         }
470
471         // Compatibility for older configs that don't have the snomasks field.
472         // TODO: remove this before v4 is released.
473         if (defaultsnomasks)
474                 AllowedSnomasks.set();
475 }
476
477 void User::UnOper()
478 {
479         if (!this->IsOper())
480                 return;
481
482         /*
483          * unset their oper type (what IS_OPER checks).
484          * note, order is important - this must come before modes as -o attempts
485          * to call UnOper. -- w00t
486          */
487         oper = NULL;
488
489         // Remove the user from the oper list
490         stdalgo::vector::swaperase(ServerInstance->Users->all_opers, this);
491
492         // If the user is quitting we shouldn't remove any modes as it results in
493         // mode messages being broadcast across the network.
494         if (quitting)
495                 return;
496
497         /* Remove all oper only modes from the user when the deoper - Bug #466*/
498         Modes::ChangeList changelist;
499         const ModeParser::ModeHandlerMap& usermodes = ServerInstance->Modes->GetModes(MODETYPE_USER);
500         for (ModeParser::ModeHandlerMap::const_iterator i = usermodes.begin(); i != usermodes.end(); ++i)
501         {
502                 ModeHandler* mh = i->second;
503                 if (mh->NeedsOper())
504                         changelist.push_remove(mh);
505         }
506
507         ServerInstance->Modes->Process(this, NULL, this, changelist);
508
509         ModeHandler* opermh = ServerInstance->Modes->FindMode('o', MODETYPE_USER);
510         if (opermh)
511                 this->SetMode(opermh, false);
512         FOREACH_MOD(OnPostDeoper, (this));
513 }
514
515 /*
516  * Check class restrictions
517  */
518 void LocalUser::CheckClass(bool clone_count)
519 {
520         ConnectClass* a = this->MyClass;
521
522         if (!a)
523         {
524                 ServerInstance->Users->QuitUser(this, "Access denied by configuration");
525                 return;
526         }
527         else if (a->type == CC_DENY)
528         {
529                 ServerInstance->Users->QuitUser(this, a->config->getString("reason", "Unauthorised connection", 1));
530                 return;
531         }
532         else if (clone_count)
533         {
534                 const UserManager::CloneCounts& clonecounts = ServerInstance->Users->GetCloneCounts(this);
535                 if ((a->GetMaxLocal()) && (clonecounts.local > a->GetMaxLocal()))
536                 {
537                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (local)");
538                         if (a->maxconnwarn)
539                         {
540                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum local connections for the %s class (%ld) exceeded by %s",
541                                         a->name.c_str(), a->GetMaxLocal(), this->GetIPString().c_str());
542                         }
543                         return;
544                 }
545                 else if ((a->GetMaxGlobal()) && (clonecounts.global > a->GetMaxGlobal()))
546                 {
547                         ServerInstance->Users->QuitUser(this, "No more connections allowed from your host via this connect class (global)");
548                         if (a->maxconnwarn)
549                         {
550                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: maximum global connections for the %s class (%ld) exceeded by %s",
551                                 a->name.c_str(), a->GetMaxGlobal(), this->GetIPString().c_str());
552                         }
553                         return;
554                 }
555         }
556
557         this->nextping = ServerInstance->Time() + a->GetPingTime();
558 }
559
560 bool LocalUser::CheckLines(bool doZline)
561 {
562         const char* check[] = { "G" , "K", (doZline) ? "Z" : NULL, NULL };
563
564         if (!this->exempt)
565         {
566                 for (int n = 0; check[n]; ++n)
567                 {
568                         XLine *r = ServerInstance->XLines->MatchesLine(check[n], this);
569
570                         if (r)
571                         {
572                                 r->Apply(this);
573                                 return true;
574                         }
575                 }
576         }
577
578         return false;
579 }
580
581 void LocalUser::FullConnect()
582 {
583         ServerInstance->stats.Connects++;
584         this->idle_lastmsg = ServerInstance->Time();
585
586         /*
587          * You may be thinking "wtf, we checked this in User::AddClient!" - and yes, we did, BUT.
588          * At the time AddClient is called, we don't have a resolved host, by here we probably do - which
589          * may put the user into a totally separate class with different restrictions! so we *must* check again.
590          * Don't remove this! -- w00t
591          */
592         MyClass = NULL;
593         SetClass();
594         CheckClass();
595         CheckLines();
596
597         if (quitting)
598                 return;
599
600         /*
601          * We don't set REG_ALL until triggering OnUserConnect, so some module events don't spew out stuff
602          * for a user that doesn't exist yet.
603          */
604         FOREACH_MOD(OnUserConnect, (this));
605
606         /* Now registered */
607         if (ServerInstance->Users->unregistered_count)
608                 ServerInstance->Users->unregistered_count--;
609         this->registered = REG_ALL;
610
611         FOREACH_MOD(OnPostConnect, (this));
612
613         ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d (class %s): %s (%s) [%s]",
614                 this->server_sa.port(), this->MyClass->name.c_str(), GetFullRealHost().c_str(), this->GetIPString().c_str(), this->GetRealName().c_str());
615         ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding NEGATIVE hit for " + this->GetIPString());
616         ServerInstance->BanCache.AddHit(this->GetIPString(), "", "");
617         // reset the flood penalty (which could have been raised due to things like auto +x)
618         CommandFloodPenalty = 0;
619 }
620
621 void User::InvalidateCache()
622 {
623         /* Invalidate cache */
624         cachedip.clear();
625         cached_fullhost.clear();
626         cached_hostip.clear();
627         cached_makehost.clear();
628         cached_fullrealhost.clear();
629 }
630
631 bool User::ChangeNick(const std::string& newnick, time_t newts)
632 {
633         if (quitting)
634         {
635                 ServerInstance->Logs->Log("USERS", LOG_DEFAULT, "ERROR: Attempted to change nick of a quitting user: " + this->nick);
636                 return false;
637         }
638
639         User* const InUse = ServerInstance->FindNickOnly(newnick);
640         if (InUse == this)
641         {
642                 // case change, don't need to check campers
643                 // and, if it's identical including case, we can leave right now
644                 // We also don't update the nick TS if it's a case change, either
645                 if (newnick == nick)
646                         return true;
647         }
648         else
649         {
650                 /*
651                  * Uh oh.. if the nickname is in use, and it's not in use by the person using it (doh) --
652                  * then we have a potential collide. Check whether someone else is camping on the nick
653                  * (i.e. connect -> send NICK, don't send USER.) If they are camping, force-change the
654                  * camper to their UID, and allow the incoming nick change.
655                  *
656                  * If the guy using the nick is already using it, tell the incoming nick change to gtfo,
657                  * because the nick is already (rightfully) in use. -- w00t
658                  */
659                 if (InUse)
660                 {
661                         if (InUse->registered != REG_ALL)
662                         {
663                                 /* force the camper to their UUID, and ask them to re-send a NICK. */
664                                 LocalUser* const localuser = static_cast<LocalUser*>(InUse);
665                                 localuser->OverruleNick();
666                         }
667                         else
668                         {
669                                 /* No camping, tell the incoming user  to stop trying to change nick ;p */
670                                 this->WriteNumeric(ERR_NICKNAMEINUSE, newnick, "Nickname is already in use.");
671                                 return false;
672                         }
673                 }
674
675                 age = newts ? newts : ServerInstance->Time();
676         }
677
678         if (this->registered == REG_ALL)
679         {
680                 ClientProtocol::Messages::Nick nickmsg(this, newnick);
681                 ClientProtocol::Event nickevent(ServerInstance->GetRFCEvents().nick, nickmsg);
682                 this->WriteCommonRaw(nickevent, true);
683         }
684         const std::string oldnick = nick;
685         nick = newnick;
686
687         InvalidateCache();
688         ServerInstance->Users->clientlist.erase(oldnick);
689         ServerInstance->Users->clientlist[newnick] = this;
690
691         if (registered == REG_ALL)
692                 FOREACH_MOD(OnUserPostNick, (this,oldnick));
693
694         return true;
695 }
696
697 void LocalUser::OverruleNick()
698 {
699         {
700                 ClientProtocol::Messages::Nick nickmsg(this, this->uuid);
701                 this->Send(ServerInstance->GetRFCEvents().nick, nickmsg);
702         }
703         this->WriteNumeric(ERR_NICKNAMEINUSE, this->nick, "Nickname overruled.");
704
705         // Clear the bit before calling ChangeNick() to make it NOT run the OnUserPostNick() hook
706         this->registered &= ~REG_NICK;
707         this->ChangeNick(this->uuid);
708 }
709
710 const std::string& User::GetIPString()
711 {
712         if (cachedip.empty())
713         {
714                 cachedip = client_sa.addr();
715                 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
716                 if (cachedip[0] == ':')
717                         cachedip.insert(cachedip.begin(),1,'0');
718         }
719
720         return cachedip;
721 }
722
723 const std::string& User::GetHost(bool uncloak) const
724 {
725         return uncloak ? GetRealHost() : GetDisplayedHost();
726 }
727
728 const std::string& User::GetDisplayedHost() const
729 {
730         return displayhost.empty() ? realhost : displayhost;
731 }
732
733 const std::string& User::GetRealHost() const
734 {
735         return realhost;
736 }
737
738 const std::string& User::GetRealName() const
739 {
740         return realname;
741 }
742
743 irc::sockets::cidr_mask User::GetCIDRMask()
744 {
745         unsigned char range = 0;
746         switch (client_sa.family())
747         {
748                 case AF_INET6:
749                         range = ServerInstance->Config->c_ipv6_range;
750                         break;
751                 case AF_INET:
752                         range = ServerInstance->Config->c_ipv4_range;
753                         break;
754         }
755         return irc::sockets::cidr_mask(client_sa, range);
756 }
757
758 bool User::SetClientIP(const std::string& address)
759 {
760         irc::sockets::sockaddrs sa;
761         if (!irc::sockets::aptosa(address, client_sa.port(), sa))
762                 return false;
763
764         User::SetClientIP(sa);
765         return true;
766 }
767
768 void User::SetClientIP(const irc::sockets::sockaddrs& sa)
769 {
770         const std::string oldip(GetIPString());
771         memcpy(&client_sa, &sa, sizeof(irc::sockets::sockaddrs));
772         this->InvalidateCache();
773
774         // If the users hostname was their IP then update it.
775         if (GetRealHost() == oldip)
776                 ChangeRealHost(GetIPString(), false);
777         if (GetDisplayedHost() == oldip)
778                 ChangeDisplayedHost(GetIPString());
779 }
780
781 bool LocalUser::SetClientIP(const std::string& address)
782 {
783         irc::sockets::sockaddrs sa;
784         if (!irc::sockets::aptosa(address, client_sa.port(), sa))
785                 return false;
786
787         LocalUser::SetClientIP(sa);
788         return true;
789 }
790
791 void LocalUser::SetClientIP(const irc::sockets::sockaddrs& sa)
792 {
793         if (sa == client_sa)
794                 return;
795
796         ServerInstance->Users->RemoveCloneCounts(this);
797         User::SetClientIP(sa);
798         ServerInstance->Users->AddClone(this);
799
800         // Recheck the connect class.
801         this->MyClass = NULL;
802         this->SetClass();
803         this->CheckClass();
804
805         if (!quitting)
806                 FOREACH_MOD(OnSetUserIP, (this));
807 }
808
809 void LocalUser::Write(const ClientProtocol::SerializedMessage& text)
810 {
811         if (!SocketEngine::BoundsCheckFd(&eh))
812                 return;
813
814         if (ServerInstance->Config->RawLog)
815         {
816                 if (text.empty())
817                         return;
818
819                 std::string::size_type nlpos = text.find_first_of("\r\n", 0, 2);
820                 if (nlpos == std::string::npos)
821                         nlpos = text.length(); // TODO is this ok, test it
822
823                 ServerInstance->Logs->Log("USEROUTPUT", LOG_RAWIO, "C[%s] O %.*s", uuid.c_str(), (int) nlpos, text.c_str());
824         }
825
826         eh.AddWriteBuf(text);
827
828         const size_t bytessent = text.length() + 2;
829         ServerInstance->stats.Sent += bytessent;
830         this->bytes_out += bytessent;
831         this->cmds_out++;
832 }
833
834 void LocalUser::Send(ClientProtocol::Event& protoev)
835 {
836         if (!serializer)
837         {
838                 ServerInstance->Logs->Log("USERS", LOG_DEBUG, "BUG: LocalUser::Send() called on %s who does not have a serializer!",
839                         GetFullRealHost().c_str());
840                 return;
841         }
842
843         // In the most common case a static LocalUser field, sendmsglist, is passed to the event to be
844         // populated. The list is cleared before returning.
845         // To handle re-enters, if sendmsglist is non-empty upon entering the method then a temporary
846         // list is used instead of the static one.
847         if (sendmsglist.empty())
848         {
849                 Send(protoev, sendmsglist);
850                 sendmsglist.clear();
851         }
852         else
853         {
854                 ClientProtocol::MessageList msglist;
855                 Send(protoev, msglist);
856         }
857 }
858
859 void LocalUser::Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist)
860 {
861         // Modules can personalize the messages sent per user for the event
862         protoev.GetMessagesForUser(this, msglist);
863         for (ClientProtocol::MessageList::const_iterator i = msglist.begin(); i != msglist.end(); ++i)
864         {
865                 ClientProtocol::Message& curr = **i;
866                 ModResult res;
867                 FIRST_MOD_RESULT(OnUserWrite, res, (this, curr));
868                 if (res != MOD_RES_DENY)
869                         Write(serializer->SerializeForUser(this, curr));
870         }
871 }
872
873 void User::WriteNumeric(const Numeric::Numeric& numeric)
874 {
875         LocalUser* const localuser = IS_LOCAL(this);
876         if (!localuser)
877                 return;
878
879         ModResult MOD_RESULT;
880
881         FIRST_MOD_RESULT(OnNumeric, MOD_RESULT, (this, numeric));
882
883         if (MOD_RESULT == MOD_RES_DENY)
884                 return;
885
886         ClientProtocol::Messages::Numeric numericmsg(numeric, localuser);
887         localuser->Send(ServerInstance->GetRFCEvents().numeric, numericmsg);
888 }
889
890 void User::WriteRemoteNotice(const std::string& text)
891 {
892         ServerInstance->PI->SendMessage(this, text, MSG_NOTICE);
893 }
894
895 void LocalUser::WriteRemoteNotice(const std::string& text)
896 {
897         WriteNotice(text);
898 }
899
900 namespace
901 {
902         class WriteCommonRawHandler : public User::ForEachNeighborHandler
903         {
904                 ClientProtocol::Event& ev;
905
906                 void Execute(LocalUser* user) CXX11_OVERRIDE
907                 {
908                         user->Send(ev);
909                 }
910
911          public:
912                 WriteCommonRawHandler(ClientProtocol::Event& protoev)
913                         : ev(protoev)
914                 {
915                 }
916         };
917 }
918
919 void User::WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self)
920 {
921         WriteCommonRawHandler handler(protoev);
922         ForEachNeighbor(handler, include_self);
923 }
924
925 void User::ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self)
926 {
927         // The basic logic for visiting the neighbors of a user is to iterate the channel list of the user
928         // and visit all users on those channels. Because two users may share more than one common channel,
929         // we must skip users that we have already visited.
930         // To do this, we make use of a global counter and an integral 'already_sent' field in LocalUser.
931         // The global counter is incremented every time we do something for each neighbor of a user. Then,
932         // before visiting a member we examine user->already_sent. If it's equal to the current counter, we
933         // skip the member. Otherwise, we set it to the current counter and visit the member.
934
935         // Ask modules to build a list of exceptions.
936         // Mods may also exclude entire channels by erasing them from include_chans.
937         IncludeChanList include_chans(chans.begin(), chans.end());
938         std::map<User*, bool> exceptions;
939         exceptions[this] = include_self;
940         FOREACH_MOD(OnBuildNeighborList, (this, include_chans, exceptions));
941
942         // Get next id, guaranteed to differ from the already_sent field of all users
943         const already_sent_t newid = ServerInstance->Users.NextAlreadySentId();
944
945         // Handle exceptions first
946         for (std::map<User*, bool>::const_iterator i = exceptions.begin(); i != exceptions.end(); ++i)
947         {
948                 LocalUser* curr = IS_LOCAL(i->first);
949                 if (curr)
950                 {
951                         // Mark as visited to ensure we won't visit again if there is a common channel
952                         curr->already_sent = newid;
953                         // Always treat quitting users as excluded
954                         if ((i->second) && (!curr->quitting))
955                                 handler.Execute(curr);
956                 }
957         }
958
959         // Now consider the real neighbors
960         for (IncludeChanList::const_iterator i = include_chans.begin(); i != include_chans.end(); ++i)
961         {
962                 Channel* chan = (*i)->chan;
963                 const Channel::MemberMap& userlist = chan->GetUsers();
964                 for (Channel::MemberMap::const_iterator j = userlist.begin(); j != userlist.end(); ++j)
965                 {
966                         LocalUser* curr = IS_LOCAL(j->first);
967                         // User not yet visited?
968                         if ((curr) && (curr->already_sent != newid))
969                         {
970                                 // Mark as visited and execute function
971                                 curr->already_sent = newid;
972                                 handler.Execute(curr);
973                         }
974                 }
975         }
976 }
977
978 void User::WriteRemoteNumeric(const Numeric::Numeric& numeric)
979 {
980         WriteNumeric(numeric);
981 }
982
983 /* return 0 or 1 depending if users u and u2 share one or more common channels
984  * (used by QUIT, NICK etc which arent channel specific notices)
985  *
986  * The old algorithm in 1.0 for this was relatively inefficient, iterating over
987  * the first users channels then the second users channels within the outer loop,
988  * therefore it was a maximum of x*y iterations (upon returning 0 and checking
989  * all possible iterations). However this new function instead checks against the
990  * channel's userlist in the inner loop which is a std::map<User*,User*>
991  * and saves us time as we already know what pointer value we are after.
992  * Don't quote me on the maths as i am not a mathematician or computer scientist,
993  * but i believe this algorithm is now x+(log y) maximum iterations instead.
994  */
995 bool User::SharesChannelWith(User *other)
996 {
997         /* Outer loop */
998         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); ++i)
999         {
1000                 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
1001                  * by replacing it with a map::find which *should* be more efficient
1002                  */
1003                 if ((*i)->chan->HasUser(other))
1004                         return true;
1005         }
1006         return false;
1007 }
1008
1009 bool User::ChangeRealName(const std::string& real)
1010 {
1011         if (!this->realname.compare(real))
1012                 return true;
1013
1014         if (IS_LOCAL(this))
1015         {
1016                 ModResult MOD_RESULT;
1017                 FIRST_MOD_RESULT(OnPreChangeRealName, MOD_RESULT, (IS_LOCAL(this), real));
1018                 if (MOD_RESULT == MOD_RES_DENY)
1019                         return false;
1020         }
1021         FOREACH_MOD(OnChangeRealName, (this, real));
1022         this->realname.assign(real, 0, ServerInstance->Config->Limits.MaxReal);
1023
1024         return true;
1025 }
1026
1027 bool User::ChangeDisplayedHost(const std::string& shost)
1028 {
1029         if (GetDisplayedHost() == shost)
1030                 return true;
1031
1032         LocalUser* luser = IS_LOCAL(this);
1033         if (luser)
1034         {
1035                 ModResult MOD_RESULT;
1036                 FIRST_MOD_RESULT(OnPreChangeHost, MOD_RESULT, (luser, shost));
1037                 if (MOD_RESULT == MOD_RES_DENY)
1038                         return false;
1039         }
1040
1041         FOREACH_MOD(OnChangeHost, (this,shost));
1042
1043         if (realhost == shost)
1044                 this->displayhost.clear();
1045         else
1046                 this->displayhost.assign(shost, 0, ServerInstance->Config->Limits.MaxHost);
1047
1048         this->InvalidateCache();
1049
1050         if (IS_LOCAL(this) && this->registered != REG_NONE)
1051                 this->WriteNumeric(RPL_YOURDISPLAYEDHOST, this->GetDisplayedHost(), "is now your displayed host");
1052
1053         return true;
1054 }
1055
1056 void User::ChangeRealHost(const std::string& host, bool resetdisplay)
1057 {
1058         // If the real host is the new host and we are not resetting the
1059         // display host then we have nothing to do.
1060         const bool changehost = (realhost != host);
1061         if (!changehost && !resetdisplay)
1062                 return;
1063
1064         // If the displayhost is not set and we are not resetting it then
1065         // we need to copy it to the displayhost field.
1066         if (displayhost.empty() && !resetdisplay)
1067                 displayhost = realhost;
1068
1069         // If the displayhost is the new host or we are resetting it then
1070         // we clear its contents to save memory.
1071         else if (displayhost == host || resetdisplay)
1072                 displayhost.clear();
1073
1074         // If we are just resetting the display host then we don't need to
1075         // do anything else.
1076         if (!changehost)
1077                 return;
1078
1079         // Don't call the OnChangeRealHost event when initialising a user.
1080         if (!realhost.empty())
1081                 FOREACH_MOD(OnChangeRealHost, (this, host));
1082
1083         realhost = host;
1084         this->InvalidateCache();
1085 }
1086
1087 bool User::ChangeIdent(const std::string& newident)
1088 {
1089         if (this->ident == newident)
1090                 return true;
1091
1092         FOREACH_MOD(OnChangeIdent, (this,newident));
1093
1094         this->ident.assign(newident, 0, ServerInstance->Config->Limits.IdentMax);
1095         this->InvalidateCache();
1096
1097         return true;
1098 }
1099
1100 /*
1101  * Sets a user's connection class.
1102  * If the class name is provided, it will be used. Otherwise, the class will be guessed using host/ip/ident/etc.
1103  * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1104  * then their ip will be taken as 'priority' anyway, so for example,
1105  * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1106  */
1107 void LocalUser::SetClass(const std::string &explicit_name)
1108 {
1109         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Setting connect class for %s (%s) ...",
1110                 this->uuid.c_str(), this->GetFullRealHost().c_str());
1111
1112         ConnectClass *found = NULL;
1113         if (!explicit_name.empty())
1114         {
1115                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1116                 {
1117                         ConnectClass* c = *i;
1118
1119                         if (explicit_name == c->name)
1120                         {
1121                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Connect class explicitly set to %s",
1122                                         explicit_name.c_str());
1123                                 found = c;
1124                         }
1125                 }
1126         }
1127         else
1128         {
1129                 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
1130                 {
1131                         ConnectClass* c = *i;
1132                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Checking the %s connect class ...",
1133                                         c->GetName().c_str());
1134
1135                         ModResult MOD_RESULT;
1136                         FIRST_MOD_RESULT(OnSetConnectClass, MOD_RESULT, (this,c));
1137                         if (MOD_RESULT == MOD_RES_DENY)
1138                                 continue;
1139
1140                         if (MOD_RESULT == MOD_RES_ALLOW)
1141                         {
1142                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class was explicitly chosen by a module",
1143                                         c->GetName().c_str());
1144                                 found = c;
1145                                 break;
1146                         }
1147
1148                         if (c->type == CC_NAMED)
1149                         {
1150                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as neither <connect:allow> nor <connect:deny> are set",
1151                                                 c->GetName().c_str());
1152                                 continue;
1153                         }
1154
1155                         bool regdone = (registered != REG_NONE);
1156                         if (c->config->getBool("registered", regdone) != regdone)
1157                         {
1158                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it requires that the user is %s",
1159                                                 c->GetName().c_str(), regdone ? "not fully connected" : "fully connected");
1160                                 continue;
1161                         }
1162
1163                         /* check if host matches.. */
1164                         if (!InspIRCd::MatchCIDR(this->GetIPString(), c->GetHost(), NULL) &&
1165                                 !InspIRCd::MatchCIDR(this->GetRealHost(), c->GetHost(), NULL))
1166                         {
1167                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as neither the host (%s) nor the IP (%s) matches %s",
1168                                         c->GetName().c_str(), this->GetRealHost().c_str(), this->GetIPString().c_str(), c->GetHost().c_str());
1169                                 continue;
1170                         }
1171
1172                         /*
1173                          * deny change if change will take class over the limit check it HERE, not after we found a matching class,
1174                          * because we should attempt to find another class if this one doesn't match us. -- w00t
1175                          */
1176                         if (c->limit && (c->GetReferenceCount() >= c->limit))
1177                         {
1178                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it has reached its user limit (%lu)",
1179                                                 c->GetName().c_str(), c->limit);
1180                                 continue;
1181                         }
1182
1183                         /* if it requires a port and our port doesn't match, fail */
1184                         if (!c->ports.empty() && !c->ports.count(this->server_sa.port()))
1185                         {
1186                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as the connection port (%d) is not any of %s",
1187                                         c->GetName().c_str(), this->server_sa.port(), stdalgo::string::join(c->ports).c_str());
1188                                 continue;
1189                         }
1190
1191                         if (regdone && !c->password.empty() && !ServerInstance->PassCompare(this, c->password, password, c->passwordhash))
1192                         {
1193                                 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as requires a password and %s",
1194                                         c->GetName().c_str(), password.empty() ? "one was not provided" : "the provided password was incorrect");
1195                                 continue;
1196                         }
1197
1198                         /* we stop at the first class that meets ALL critera. */
1199                         ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is suitable for %s (%s)",
1200                                 c->GetName().c_str(), this->uuid.c_str(), this->GetFullRealHost().c_str());
1201                         found = c;
1202                         break;
1203                 }
1204         }
1205
1206         /*
1207          * Okay, assuming we found a class that matches.. switch us into that class, keeping refcounts up to date.
1208          */
1209         if (found)
1210         {
1211                 MyClass = found;
1212         }
1213 }
1214
1215 void User::PurgeEmptyChannels()
1216 {
1217         // firstly decrement the count on each channel
1218         for (User::ChanList::iterator i = this->chans.begin(); i != this->chans.end(); )
1219         {
1220                 Channel* c = (*i)->chan;
1221                 ++i;
1222                 c->DelUser(this);
1223         }
1224 }
1225
1226 void User::WriteNotice(const std::string& text)
1227 {
1228         LocalUser* const localuser = IS_LOCAL(this);
1229         if (!localuser)
1230                 return;
1231
1232         ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, localuser, text, MSG_NOTICE);
1233         localuser->Send(ServerInstance->GetRFCEvents().privmsg, msg);
1234 }
1235
1236 const std::string& FakeUser::GetFullHost()
1237 {
1238         if (!ServerInstance->Config->HideServer.empty())
1239                 return ServerInstance->Config->HideServer;
1240         return server->GetName();
1241 }
1242
1243 const std::string& FakeUser::GetFullRealHost()
1244 {
1245         if (!ServerInstance->Config->HideServer.empty())
1246                 return ServerInstance->Config->HideServer;
1247         return server->GetName();
1248 }
1249
1250 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask)
1251         : config(tag)
1252         , type(t)
1253         , fakelag(true)
1254         , name("unnamed")
1255         , registration_timeout(0)
1256         , host(mask)
1257         , pingtime(0)
1258         , softsendqmax(0)
1259         , hardsendqmax(0)
1260         , recvqmax(0)
1261         , penaltythreshold(0)
1262         , commandrate(0)
1263         , maxlocal(0)
1264         , maxglobal(0)
1265         , maxconnwarn(true)
1266         , maxchans(0)
1267         , limit(0)
1268         , resolvehostnames(true)
1269 {
1270 }
1271
1272 ConnectClass::ConnectClass(ConfigTag* tag, char t, const std::string& mask, const ConnectClass& parent)
1273 {
1274         Update(&parent);
1275         name = "unnamed";
1276         type = t;
1277         host = mask;
1278
1279         // Connect classes can inherit from each other but this is problematic for modules which can't use
1280         // ConnectClass::Update so we build a hybrid tag containing all of the values set on this class as
1281         // well as the parent class.
1282         ConfigItems* items = NULL;
1283         config = ConfigTag::create(tag->tag, tag->src_name, tag->src_line, items);
1284
1285         const ConfigItems& parentkeys = parent.config->getItems();
1286         for (ConfigItems::const_iterator piter = parentkeys.begin(); piter != parentkeys.end(); ++piter)
1287         {
1288                 // The class name and parent name are not inherited
1289                 if (stdalgo::string::equalsci(piter->first, "name") || stdalgo::string::equalsci(piter->first, "parent"))
1290                         continue;
1291
1292                 // Store the item in the config tag. If this item also
1293                 // exists in the child it will be overwritten.
1294                 (*items)[piter->first] = piter->second;
1295         }
1296
1297         const ConfigItems& childkeys = tag->getItems();
1298         for (ConfigItems::const_iterator citer = childkeys.begin(); citer != childkeys.end(); ++citer)
1299         {
1300                 // This will overwrite the parent value if present.
1301                 (*items)[citer->first] = citer->second;
1302         }
1303 }
1304
1305 void ConnectClass::Update(const ConnectClass* src)
1306 {
1307         config = src->config;
1308         type = src->type;
1309         fakelag = src->fakelag;
1310         name = src->name;
1311         registration_timeout = src->registration_timeout;
1312         host = src->host;
1313         pingtime = src->pingtime;
1314         softsendqmax = src->softsendqmax;
1315         hardsendqmax = src->hardsendqmax;
1316         recvqmax = src->recvqmax;
1317         penaltythreshold = src->penaltythreshold;
1318         commandrate = src->commandrate;
1319         maxlocal = src->maxlocal;
1320         maxglobal = src->maxglobal;
1321         maxconnwarn = src->maxconnwarn;
1322         maxchans = src->maxchans;
1323         limit = src->limit;
1324         resolvehostnames = src->resolvehostnames;
1325         ports = src->ports;
1326         password = src->password;
1327         passwordhash = src->passwordhash;
1328 }