]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/users.cpp
Jesus, look who's the commit whore today. More header updates, and removal of namespa...
[user/henk/code/inspircd.git] / src / users.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
6  * See: http://www.inspircd.org/wiki/index.php/Credits
7  *
8  * This program is free but copyrighted software; see
9  *            the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 #include "configreader.h"
15 #include "channels.h"
16 #include "users.h"
17 #include "inspircd.h"
18 #include <stdarg.h>
19 #include "socketengine.h"
20 #include "wildcard.h"
21 #include "xline.h"
22 #include "cull_list.h"
23
24 static unsigned long already_sent[MAX_DESCRIPTORS] = {0};
25
26 /* XXX: Used for speeding up WriteCommon operations */
27 unsigned long uniq_id = 0;
28
29 bool InitTypes(ServerConfig* conf, const char* tag)
30 {
31         if (conf->opertypes.size())
32         {
33                 conf->GetInstance()->Log(DEBUG,"Currently %d items to clear",conf->opertypes.size());
34                 for (opertype_t::iterator n = conf->opertypes.begin(); n != conf->opertypes.end(); n++)
35                 {
36                         conf->GetInstance()->Log(DEBUG,"Clear item");
37                         if (n->second)
38                                 delete[] n->second;
39                 }
40         }
41         
42         conf->opertypes.clear();
43         return true;
44 }
45
46 bool InitClasses(ServerConfig* conf, const char* tag)
47 {
48         if (conf->operclass.size())
49         {
50                 for (operclass_t::iterator n = conf->operclass.begin(); n != conf->operclass.end(); n++)
51                 {
52                         if (n->second)
53                                 delete[] n->second;
54                 }
55         }
56         
57         conf->operclass.clear();
58         return true;
59 }
60
61 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
62 {
63         const char* TypeName = values[0].GetString();
64         const char* Classes = values[1].GetString();
65         
66         conf->opertypes[TypeName] = strdup(Classes);
67         conf->GetInstance()->Log(DEBUG,"Read oper TYPE '%s' with classes '%s'",TypeName,Classes);
68         return true;
69 }
70
71 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
72 {
73         const char* ClassName = values[0].GetString();
74         const char* CommandList = values[1].GetString();
75         
76         conf->operclass[ClassName] = strdup(CommandList);
77         conf->GetInstance()->Log(DEBUG,"Read oper CLASS '%s' with commands '%s'",ClassName,CommandList);
78         return true;
79 }
80
81 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag)
82 {
83         return true;
84 }
85
86 std::string userrec::ProcessNoticeMasks(const char *sm)
87 {
88         bool adding = true, oldadding = false;
89         const char *c = sm;
90         std::string output;
91
92         ServerInstance->Log(DEBUG,"Process notice masks");
93
94         while (c && *c)
95         {
96                 ServerInstance->Log(DEBUG,"Process notice mask %c",*c);
97                 
98                 switch (*c)
99                 {
100                         case '+':
101                                 adding = true;
102                         break;
103                         case '-':
104                                 adding = false;
105                         break;
106                         case '*':
107                                 for (unsigned char d = 'A'; d <= 'z'; d++)
108                                 {
109                                         if (ServerInstance->SNO->IsEnabled(d))
110                                         {
111                                                 if ((!IsNoticeMaskSet(d) && adding) || (IsNoticeMaskSet(d) && !adding))
112                                                 {
113                                                         if ((oldadding != adding) || (!output.length()))
114                                                                 output += (adding ? '+' : '-');
115
116                                                         this->SetNoticeMask(d, adding);
117
118                                                         output += d;
119                                                 }
120                                         }
121                                         oldadding = adding;
122                                 }
123                         break;
124                         default:
125                                 if ((*c >= 'A') && (*c <= 'z') && (ServerInstance->SNO->IsEnabled(*c)))
126                                 {
127                                         if ((!IsNoticeMaskSet(*c) && adding) || (IsNoticeMaskSet(*c) && !adding))
128                                         {
129                                                 if ((oldadding != adding) || (!output.length()))
130                                                         output += (adding ? '+' : '-');
131
132                                                 this->SetNoticeMask(*c, adding);
133
134                                                 output += *c;
135                                         }
136                                 }
137                                 oldadding = adding;
138                         break;
139                 }
140
141                 *c++;
142         }
143
144         return output;
145 }
146
147 void userrec::StartDNSLookup()
148 {
149         ServerInstance->Log(DEBUG,"Commencing reverse lookup");
150         try
151         {
152                 ServerInstance->Log(DEBUG,"Passing instance: %08x",this->ServerInstance);
153                 res_reverse = new UserResolver(this->ServerInstance, this, this->GetIPString(), DNS_QUERY_REVERSE);
154                 this->ServerInstance->AddResolver(res_reverse);
155         }
156         catch (ModuleException& e)
157         {
158                 ServerInstance->Log(DEBUG,"Error in resolver: %s",e.GetReason());
159         }
160 }
161
162 UserResolver::UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt) :
163         Resolver(Instance, to_resolve, qt), bound_user(user)
164 {
165         this->fwd = (qt == DNS_QUERY_A || qt == DNS_QUERY_AAAA);
166         this->bound_fd = user->GetFd();
167 }
168
169 void UserResolver::OnLookupComplete(const std::string &result)
170 {
171         if ((!this->fwd) && (ServerInstance->SE->GetRef(this->bound_fd) == this->bound_user))
172         {
173                 ServerInstance->Log(DEBUG,"Commencing forward lookup");
174                 this->bound_user->stored_host = result;
175                 try
176                 {
177                         /* Check we didnt time out */
178                         if (this->bound_user->registered != REG_ALL)
179                         {
180 #ifdef IPV6
181                                 const char *ip = this->bound_user->GetIPString();
182                                 bound_user->res_forward = new UserResolver(this->ServerInstance, this->bound_user, result, (strstr(ip,"0::ffff:") == ip ? DNS_QUERY_A : DNS_QUERY_AAAA));
183 #else
184                                 bound_user->res_forward = new UserResolver(this->ServerInstance, this->bound_user, result, DNS_QUERY_A);
185 #endif
186                                 this->ServerInstance->AddResolver(bound_user->res_forward);
187                         }
188                 }
189                 catch (ModuleException& e)
190                 {
191                         ServerInstance->Log(DEBUG,"Error in resolver: %s",e.GetReason());
192                 }
193         }
194         else if ((this->fwd) && (ServerInstance->SE->GetRef(this->bound_fd) == this->bound_user))
195         {
196                 /* Both lookups completed */
197                 std::string result2 = "0::ffff:";
198                 result2.append(result);
199                 if (this->bound_user->GetIPString() == result || this->bound_user->GetIPString() == result2)
200                 {
201                         std::string hostname = this->bound_user->stored_host;
202                         if (hostname.length() < 65)
203                         {
204                                 /* Check we didnt time out */
205                                 if (this->bound_user->registered != REG_ALL)
206                                 {
207                                         /* Hostnames starting with : are not a good thing (tm) */
208                                         if (*(hostname.c_str()) == ':')
209                                                 hostname = "0" + hostname;
210
211                                         this->bound_user->WriteServ("NOTICE Auth :*** Found your hostname (%s)", hostname.c_str());
212                                         this->bound_user->dns_done = true;
213                                         strlcpy(this->bound_user->dhost, hostname.c_str(),64);
214                                         strlcpy(this->bound_user->host, hostname.c_str(),64);
215                                 }
216                         }
217                         else
218                         {
219                                 this->bound_user->WriteServ("NOTICE Auth :*** Your hostname is longer than the maximum of 64 characters, using your IP address (%s) instead.", this->bound_user->GetIPString());
220                         }
221                 }
222                 else
223                 {
224                         this->bound_user->WriteServ("NOTICE Auth :*** Your hostname does not match up with your IP address. Sorry, using your IP address (%s) instead.", this->bound_user->GetIPString());
225                 }
226         }
227 }
228
229 void UserResolver::OnError(ResolverError e, const std::string &errormessage)
230 {
231         if (ServerInstance->SE->GetRef(this->bound_fd) == this->bound_user)
232         {
233                 /* Error message here */
234                 this->bound_user->WriteServ("NOTICE Auth :*** Could not resolve your hostname, using your IP address (%s) instead.", this->bound_user->GetIPString());
235                 this->bound_user->dns_done = true;
236         }
237 }
238
239
240 bool userrec::IsNoticeMaskSet(unsigned char sm)
241 {
242         return (snomasks[sm-65]);
243 }
244
245 void userrec::SetNoticeMask(unsigned char sm, bool value)
246 {
247         snomasks[sm-65] = value;
248 }
249
250 const char* userrec::FormatNoticeMasks()
251 {
252         static char data[MAXBUF];
253         int offset = 0;
254
255         for (int n = 0; n < 64; n++)
256         {
257                 if (snomasks[n])
258                         data[offset++] = n+65;
259         }
260
261         data[offset] = 0;
262         return data;
263 }
264
265
266
267 bool userrec::IsModeSet(unsigned char m)
268 {
269         return (modes[m-65]);
270 }
271
272 void userrec::SetMode(unsigned char m, bool value)
273 {
274         modes[m-65] = value;
275 }
276
277 const char* userrec::FormatModes()
278 {
279         static char data[MAXBUF];
280         int offset = 0;
281         for (int n = 0; n < 64; n++)
282         {
283                 if (modes[n])
284                         data[offset++] = n+65;
285         }
286         data[offset] = 0;
287         return data;
288 }
289
290 userrec::userrec(InspIRCd* Instance) : ServerInstance(Instance)
291 {
292         ServerInstance->Log(DEBUG,"userrec::userrec(): Instance: %08x",ServerInstance);
293         // the PROPER way to do it, AVOID bzero at *ALL* costs
294         *password = *nick = *ident = *host = *dhost = *fullname = *awaymsg = *oper = 0;
295         server = (char*)Instance->FindServerNamePtr(Instance->Config->ServerName);
296         reset_due = ServerInstance->Time();
297         age = ServerInstance->Time(true);
298         lines_in = lastping = signon = idle_lastmsg = nping = registered = 0;
299         ChannelCount = timeout = flood = bytes_in = bytes_out = cmds_in = cmds_out = 0;
300         exempt = haspassed = dns_done = false;
301         fd = -1;
302         recvq = "";
303         sendq = "";
304         WriteError = "";
305         res_forward = res_reverse = NULL;
306         ip = NULL;
307         chans.clear();
308         invites.clear();
309         memset(modes,0,sizeof(modes));
310         memset(snomasks,0,sizeof(snomasks));
311 }
312
313 userrec::~userrec()
314 {
315         if (ip)
316         {
317                 clonemap::iterator x = ServerInstance->local_clones.find(this->GetIPString());
318                 if (x != ServerInstance->local_clones.end())
319                 {
320                         x->second--;
321                         if (!x->second)
322                         {
323                                 ServerInstance->local_clones.erase(x);
324                         }
325                 }
326         
327                 clonemap::iterator y = ServerInstance->global_clones.find(this->GetIPString());
328                 if (y != ServerInstance->global_clones.end())
329                 {
330                         y->second--;
331                         if (!y->second)
332                         {
333                                 ServerInstance->global_clones.erase(y);
334                         }
335                 }
336
337                 if (this->GetProtocolFamily() == AF_INET)
338                 {
339                         delete (sockaddr_in*)ip;
340                 }
341 #ifdef SUPPORT_IP6LINKS
342                 else
343                 {
344                         delete (sockaddr_in6*)ip;
345                 }
346 #endif
347         }
348 }
349
350 char* userrec::MakeHost()
351 {
352         static char nhost[MAXBUF];
353         /* This is much faster than snprintf */
354         char* t = nhost;
355         for(char* n = ident; *n; n++)
356                 *t++ = *n;
357         *t++ = '@';
358         for(char* n = host; *n; n++)
359                 *t++ = *n;
360         *t = 0;
361         return nhost;
362 }
363
364 char* userrec::MakeHostIP()
365 {
366         static char ihost[MAXBUF];
367         /* This is much faster than snprintf */
368         char* t = ihost;
369         for(char* n = ident; *n; n++)
370                 *t++ = *n;
371         *t++ = '@';
372         for(const char* n = this->GetIPString(); *n; n++)
373                 *t++ = *n;
374         *t = 0;
375         return ihost;
376 }
377
378 void userrec::CloseSocket()
379 {
380         shutdown(this->fd,2);
381         close(this->fd);
382 }
383  
384 char* userrec::GetFullHost()
385 {
386         static char result[MAXBUF];
387         char* t = result;
388         for(char* n = nick; *n; n++)
389                 *t++ = *n;
390         *t++ = '!';
391         for(char* n = ident; *n; n++)
392                 *t++ = *n;
393         *t++ = '@';
394         for(char* n = dhost; *n; n++)
395                 *t++ = *n;
396         *t = 0;
397         return result;
398 }
399
400 char* userrec::MakeWildHost()
401 {
402         static char nresult[MAXBUF];
403         char* t = nresult;
404         *t++ = '*';     *t++ = '!';
405         *t++ = '*';     *t++ = '@';
406         for(char* n = dhost; *n; n++)
407                 *t++ = *n;
408         *t = 0;
409         return nresult;
410 }
411
412 int userrec::ReadData(void* buffer, size_t size)
413 {
414         if (IS_LOCAL(this))
415         {
416                 return read(this->fd, buffer, size);
417         }
418         else
419                 return 0;
420 }
421
422
423 char* userrec::GetFullRealHost()
424 {
425         static char fresult[MAXBUF];
426         char* t = fresult;
427         for(char* n = nick; *n; n++)
428                 *t++ = *n;
429         *t++ = '!';
430         for(char* n = ident; *n; n++)
431                 *t++ = *n;
432         *t++ = '@';
433         for(char* n = host; *n; n++)
434                 *t++ = *n;
435         *t = 0;
436         return fresult;
437 }
438
439 bool userrec::IsInvited(const irc::string &channel)
440 {
441         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
442         {
443                 if (channel == *i)
444                 {
445                         return true;
446                 }
447         }
448         return false;
449 }
450
451 InvitedList* userrec::GetInviteList()
452 {
453         return &invites;
454 }
455
456 void userrec::InviteTo(const irc::string &channel)
457 {
458         invites.push_back(channel);
459 }
460
461 void userrec::RemoveInvite(const irc::string &channel)
462 {
463         ServerInstance->Log(DEBUG,"Removing invites");
464         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
465         {
466                 if (channel == *i)
467                 {
468                         invites.erase(i);
469                         return;
470                 }
471         }
472 }
473
474 bool userrec::HasPermission(const std::string &command)
475 {
476         char* mycmd;
477         char* savept;
478         char* savept2;
479         
480         /*
481          * users on remote servers can completely bypass all permissions based checks.
482          * This prevents desyncs when one server has different type/class tags to another.
483          * That having been said, this does open things up to the possibility of source changes
484          * allowing remote kills, etc - but if they have access to the src, they most likely have
485          * access to the conf - so it's an end to a means either way.
486          */
487         if (!IS_LOCAL(this))
488                 return true;
489         
490         // are they even an oper at all?
491         if (*this->oper)
492         {
493                 opertype_t::iterator iter_opertype = ServerInstance->Config->opertypes.find(this->oper);
494                 if (iter_opertype != ServerInstance->Config->opertypes.end())
495                 {
496                         char* Classes = strdup(iter_opertype->second);
497                         char* myclass = strtok_r(Classes," ",&savept);
498                         while (myclass)
499                         {
500                                 operclass_t::iterator iter_operclass = ServerInstance->Config->operclass.find(myclass);
501                                 if (iter_operclass != ServerInstance->Config->operclass.end())
502                                 {
503                                         char* CommandList = strdup(iter_operclass->second);
504                                         mycmd = strtok_r(CommandList," ",&savept2);
505                                         while (mycmd)
506                                         {
507                                                 if ((!strcasecmp(mycmd,command.c_str())) || (*mycmd == '*'))
508                                                 {
509                                                         free(Classes);
510                                                         free(CommandList);
511                                                         return true;
512                                                 }
513                                                 mycmd = strtok_r(NULL," ",&savept2);
514                                         }
515                                         free(CommandList);
516                                 }
517                                 myclass = strtok_r(NULL," ",&savept);
518                         }
519                         free(Classes);
520                 }
521         }
522         return false;
523 }
524
525 /** NOTE: We cannot pass a const reference to this method.
526  * The string is changed by the workings of the method,
527  * so that if we pass const ref, we end up copying it to
528  * something we can change anyway. Makes sense to just let
529  * the compiler do that copy for us.
530  */
531 bool userrec::AddBuffer(std::string a)
532 {
533         try
534         {
535                 std::string::size_type i = a.rfind('\r');
536         
537                 while (i != std::string::npos)
538                 {
539                         a.erase(i, 1);
540                         i = a.rfind('\r');
541                 }
542
543                 if (a.length())
544                         recvq.append(a);
545                 
546                 if (recvq.length() > (unsigned)this->recvqmax)
547                 {
548                         this->SetWriteError("RecvQ exceeded");
549                         ServerInstance->WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
550                         return false;
551                 }
552         
553                 return true;
554         }
555
556         catch (...)
557         {
558                 ServerInstance->Log(DEBUG,"Exception in userrec::AddBuffer()");
559                 return false;
560         }
561 }
562
563 bool userrec::BufferIsReady()
564 {
565         return (recvq.find('\n') != std::string::npos);
566 }
567
568 void userrec::ClearBuffer()
569 {
570         recvq = "";
571 }
572
573 std::string userrec::GetBuffer()
574 {
575         try
576         {
577                 if (!recvq.length())
578                         return "";
579         
580                 /* Strip any leading \r or \n off the string.
581                  * Usually there are only one or two of these,
582                  * so its is computationally cheap to do.
583                  */
584                 while ((*recvq.begin() == '\r') || (*recvq.begin() == '\n'))
585                         recvq.erase(recvq.begin());
586         
587                 for (std::string::iterator x = recvq.begin(); x != recvq.end(); x++)
588                 {
589                         /* Find the first complete line, return it as the
590                          * result, and leave the recvq as whats left
591                          */
592                         if (*x == '\n')
593                         {
594                                 std::string ret = std::string(recvq.begin(), x);
595                                 recvq.erase(recvq.begin(), x + 1);
596                                 return ret;
597                         }
598                 }
599                 return "";
600         }
601
602         catch (...)
603         {
604                 ServerInstance->Log(DEBUG,"Exception in userrec::GetBuffer()");
605                 return "";
606         }
607 }
608
609 void userrec::AddWriteBuf(const std::string &data)
610 {
611         if (*this->GetWriteError())
612                 return;
613         
614         if (sendq.length() + data.length() > (unsigned)this->sendqmax)
615         {
616                 /*
617                  * Fix by brain - Set the error text BEFORE calling writeopers, because
618                  * if we dont it'll recursively  call here over and over again trying
619                  * to repeatedly add the text to the sendq!
620                  */
621                 this->SetWriteError("SendQ exceeded");
622                 ServerInstance->WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
623                 return;
624         }
625
626         try 
627         {
628                 if (data.length() > 512)
629                         sendq.append(data.substr(0,510)).append("\r\n");
630                 else
631                         sendq.append(data);
632         }
633         catch (...)
634         {
635                 this->SetWriteError("SendQ exceeded");
636                 ServerInstance->WriteOpers("*** User %s SendQ got an exception",this->nick);
637         }
638 }
639
640 // send AS MUCH OF THE USERS SENDQ as we are able to (might not be all of it)
641 void userrec::FlushWriteBuf()
642 {
643         try
644         {
645                 if ((this->fd == FD_MAGIC_NUMBER) || (*this->GetWriteError()))
646                 {
647                         sendq = "";
648                 }
649                 if ((sendq.length()) && (this->fd != FD_MAGIC_NUMBER))
650                 {
651                         int old_sendq_length = sendq.length();
652                         int n_sent = write(this->fd, this->sendq.data(), this->sendq.length());
653                         if (n_sent == -1)
654                         {
655                                 if (errno == EAGAIN)
656                                 {
657                                         /* The socket buffer is full. This isnt fatal,
658                                          * try again later.
659                                          */
660                                         ServerInstance->Log(DEBUG,"EAGAIN, want write");
661                                         this->ServerInstance->SE->WantWrite(this);
662                                 }
663                                 else
664                                 {
665                                         /* Fatal error, set write error and bail
666                                          */
667                                         this->SetWriteError(strerror(errno));
668                                         return;
669                                 }
670                         }
671                         else
672                         {
673                                 /* advance the queue */
674                                 if (n_sent)
675                                         this->sendq = this->sendq.substr(n_sent);
676                                 /* update the user's stats counters */
677                                 this->bytes_out += n_sent;
678                                 this->cmds_out++;
679                                 if (n_sent != old_sendq_length)
680                                 {
681                                         ServerInstance->Log(DEBUG,"Not all written, want write");
682                                         this->ServerInstance->SE->WantWrite(this);
683                                 }
684                         }
685                 }
686         }
687
688         catch (...)
689         {
690                 ServerInstance->Log(DEBUG,"Exception in userrec::FlushWriteBuf()");
691         }
692 }
693
694 void userrec::SetWriteError(const std::string &error)
695 {
696         try
697         {
698                 // don't try to set the error twice, its already set take the first string.
699                 if (this->WriteError.empty())
700                 {
701                         ServerInstance->Log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
702                         this->WriteError = error;
703                 }
704         }
705
706         catch (...)
707         {
708                 ServerInstance->Log(DEBUG,"Exception in userrec::SetWriteError()");
709         }
710 }
711
712 const char* userrec::GetWriteError()
713 {
714         return this->WriteError.c_str();
715 }
716
717 void userrec::Oper(const std::string &opertype)
718 {
719         try
720         {
721                 this->modes[UM_OPERATOR] = 1;
722                 this->WriteServ("MODE %s :+o", this->nick);
723                 FOREACH_MOD(I_OnOper, OnOper(this, opertype));
724                 ServerInstance->Log(DEFAULT,"OPER: %s!%s@%s opered as type: %s", this->nick, this->ident, this->host, opertype.c_str());
725                 strlcpy(this->oper, opertype.c_str(), NICKMAX - 1);
726                 ServerInstance->all_opers.push_back(this);
727                 FOREACH_MOD(I_OnPostOper,OnPostOper(this, opertype));
728         }
729
730         catch (...)
731         {
732                 ServerInstance->Log(DEBUG,"Exception in userrec::Oper()");
733         }
734 }
735
736 void userrec::UnOper()
737 {
738         try
739         {
740                 if (*this->oper)
741                 {
742                         *this->oper = 0;
743                         this->modes[UM_OPERATOR] = 0;
744                         for (std::vector<userrec*>::iterator a = ServerInstance->all_opers.begin(); a < ServerInstance->all_opers.end(); a++)
745                         {
746                                 if (*a == this)
747                                 {
748                                         ServerInstance->Log(DEBUG,"Oper removed from optimization list");
749                                         ServerInstance->all_opers.erase(a);
750                                         return;
751                                 }
752                         }
753                 }
754         }
755
756         catch (...)
757         {
758                 ServerInstance->Log(DEBUG,"Exception in userrec::UnOper()");
759         }
760 }
761
762 void userrec::QuitUser(InspIRCd* Instance, userrec *user, const std::string &quitreason)
763 {
764         user_hash::iterator iter = Instance->clientlist.find(user->nick);
765         std::string reason = quitreason;
766
767         if (reason.length() > MAXQUIT - 1)
768                 reason.resize(MAXQUIT - 1);
769         
770         if (IS_LOCAL(user))
771         {
772                 user->Write("ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,reason.c_str());
773                 if ((!user->sendq.empty()) && (!(*user->GetWriteError())))
774                         user->FlushWriteBuf();
775         }
776
777         if (user->registered == REG_ALL)
778         {
779                 user->PurgeEmptyChannels();
780                 user->WriteCommonExcept("QUIT :%s",reason.c_str());
781                 FOREACH_MOD_I(Instance,I_OnUserQuit,OnUserQuit(user,reason));
782         }
783
784         FOREACH_MOD_I(Instance,I_OnUserDisconnect,OnUserDisconnect(user));
785
786         if (IS_LOCAL(user))
787         {
788                 if (Instance->Config->GetIOHook(user->GetPort()))
789                 {
790                         try
791                         {
792                                 Instance->Config->GetIOHook(user->GetPort())->OnRawSocketClose(user->fd);
793                         }
794                         catch (ModuleException& modexcept)
795                         {
796                                 Instance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason());
797                         }
798                 }
799                 
800                 Instance->SE->DelFd(user);
801                 user->CloseSocket();
802         }
803
804         /*
805          * this must come before the ServerInstance->SNO->WriteToSnoMaskso that it doesnt try to fill their buffer with anything
806          * if they were an oper with +sn +qQ.
807          */
808         if (user->registered == REG_ALL)
809         {
810                 if (IS_LOCAL(user))
811                         Instance->SNO->WriteToSnoMask('q',"Client exiting: %s!%s@%s [%s]",user->nick,user->ident,user->host,reason.c_str());
812                 else
813                         Instance->SNO->WriteToSnoMask('Q',"Client exiting on server %s: %s!%s@%s [%s]",user->server,user->nick,user->ident,user->host,reason.c_str());
814                 user->AddToWhoWas();
815         }
816
817         if (iter != Instance->clientlist.end())
818         {
819                 Instance->Log(DEBUG,"deleting user hash value %lx",(unsigned long)user);
820                 if (IS_LOCAL(user))
821                 {
822                         if (find(Instance->local_users.begin(),Instance->local_users.end(),user) != Instance->local_users.end())
823                                 Instance->local_users.erase(find(Instance->local_users.begin(),Instance->local_users.end(),user));
824                 }
825                 Instance->clientlist.erase(iter);
826                 DELETE(user);
827         }
828 }
829
830 namespace irc
831 {
832         namespace whowas
833         {
834
835                 WhoWasGroup::WhoWasGroup(userrec* user) : host(NULL), dhost(NULL), ident(NULL), server(NULL), gecos(NULL), signon(user->signon)
836                 {
837                         this->host = strdup(user->host);
838                         this->dhost = strdup(user->dhost);
839                         this->ident = strdup(user->ident);
840                         this->server = user->server;
841                         this->gecos = strdup(user->fullname);
842                 }
843
844                 WhoWasGroup::~WhoWasGroup()
845                 {
846                         if (host)
847                                 free(host);
848                         if (dhost)
849                                 free(dhost);
850                         if (ident)
851                                 free(ident);
852                         if (gecos)
853                                 free(gecos);
854                 }
855
856                 /* every hour, run this function which removes all entries older than Config->WhoWasMaxKeep */
857                 void MaintainWhoWas(InspIRCd* ServerInstance, time_t t)
858                 {
859                         for (whowas_users::iterator iter = ServerInstance->whowas.begin(); iter != ServerInstance->whowas.end(); iter++)
860                         {
861                                 whowas_set* n = (whowas_set*)iter->second;
862                                 if (n->size())
863                                 {
864                                         while ((n->begin() != n->end()) && ((*n->begin())->signon < t - ServerInstance->Config->WhoWasMaxKeep))
865                                         {
866                                                 WhoWasGroup *a = *(n->begin());
867                                                 DELETE(a);
868                                                 n->erase(n->begin());
869                                         }
870                                 }
871                         }
872                 }
873                 /* on rehash, refactor maps according to new conf values */
874                 void PruneWhoWas(InspIRCd* ServerInstance, time_t t)
875                 {
876                         /* config values */
877                         int groupsize = ServerInstance->Config->WhoWasGroupSize;
878                         int maxgroups = ServerInstance->Config->WhoWasMaxGroups;
879                         int maxkeep =   ServerInstance->Config->WhoWasMaxKeep;
880
881                         int groupcount = ServerInstance->whowas.size();
882                         /* iterate whowas_fifo oldest first */
883                         whowas_users_fifo::iterator iter, safeiter;
884                         for (iter = ServerInstance->whowas_fifo.begin(); iter != ServerInstance->whowas_fifo.end(); iter++)
885                         {
886                                 /** prune all groups that has expired due to new maxkeep time and
887                                  *  also any group number higher than new maxgroups. The oldest are
888                                  *  removed first due to iteration over whowas_fifo 
889                                  */
890                                 if (groupcount > maxgroups || iter->first < t - maxkeep)
891                                 {
892                                         whowas_set* n = (whowas_set*)ServerInstance->whowas.find(iter->second)->second;
893                                         if (n->size())
894                                         {
895                                                 while (n->begin() != n->end())
896                                                 {
897                                                         WhoWasGroup *a = *(n->begin());
898                                                         DELETE(a);
899                                                         n->erase(n->begin());
900                                                 }
901                                         }
902                                         ServerInstance->whowas.erase(iter->second);
903                                         /* use a safe iter copy for erase and set the orig iter old valid ref by decrementing it */
904                                         safeiter = iter;
905                                         --iter;
906                                         ServerInstance->whowas_fifo.erase(safeiter);
907                                 }
908                                 else {
909                                         /* also trim individual groupsizes in case groupsize should have been lowered */
910                                         whowas_set* n = (whowas_set*)ServerInstance->whowas.find(iter->second)->second;
911                                         if (n->size())
912                                         {
913                                                 int nickcount = n->size();
914                                                 while (n->begin() != n->end() && nickcount > groupsize)
915                                                 {
916                                                         WhoWasGroup *a = *(n->begin());
917                                                         DELETE(a);
918                                                         n->erase(n->begin());
919                                                         nickcount--;
920                                                 }
921                                         }
922                                 }
923                                 groupcount--;
924                         }
925                 }
926         };
927 };
928
929 /* adds or updates an entry in the whowas list */
930 void userrec::AddToWhoWas()
931 {
932         /* if whowas disabled */
933         if (ServerInstance->Config->WhoWasGroupSize == 0 || ServerInstance->Config->WhoWasMaxGroups == 0)
934         {
935                 return;
936         }
937
938         irc::whowas::whowas_users::iterator iter = ServerInstance->whowas.find(this->nick);
939
940         ServerInstance->Log(DEBUG,"Add to whowas lists");
941
942         if (iter == ServerInstance->whowas.end())
943         {
944                 ServerInstance->Log(DEBUG,"Adding new whowas set for %s",this->nick);
945                 irc::whowas::whowas_set* n = new irc::whowas::whowas_set;
946                 irc::whowas::WhoWasGroup *a = new irc::whowas::WhoWasGroup(this);
947                 n->push_back(a);
948                 ServerInstance->whowas[this->nick] = n;
949                 ServerInstance->whowas_fifo[ServerInstance->Time()] = this->nick;
950                 if ((int)(ServerInstance->whowas.size()) > ServerInstance->Config->WhoWasMaxGroups)
951                 {
952                         ServerInstance->Log(DEBUG,"Maxgroups of %d reached deleting oldest group '%s'",ServerInstance->Config->WhoWasMaxGroups, ServerInstance->whowas_fifo.begin()->second.c_str());
953                         ServerInstance->whowas.erase(ServerInstance->whowas_fifo.begin()->second);
954                         ServerInstance->whowas_fifo.erase(ServerInstance->whowas_fifo.begin());
955                 }
956         }
957         else
958         {
959                 irc::whowas::whowas_set* group = (irc::whowas::whowas_set*)iter->second;
960
961                 ServerInstance->Log(DEBUG,"Using existing whowas group for %s",this->nick);
962
963                 if ((int)(group->size()) >= ServerInstance->Config->WhoWasGroupSize)
964                 {
965                         ServerInstance->Log(DEBUG,"Trimming existing group '%s' to %d entries",this->nick, ServerInstance->Config->WhoWasGroupSize);
966                         irc::whowas::WhoWasGroup *a = (irc::whowas::WhoWasGroup*)*(group->begin());
967                         DELETE(a);
968                         group->pop_front();
969                 }
970
971                 irc::whowas::WhoWasGroup *a = new irc::whowas::WhoWasGroup(this);
972                 group->push_back(a);
973         }
974 }
975
976 /* add a client connection to the sockets list */
977 void userrec::AddClient(InspIRCd* Instance, int socket, int port, bool iscached, insp_inaddr ip)
978 {
979         std::string tempnick = ConvToStr(socket) + "-unknown";
980         user_hash::iterator iter = Instance->clientlist.find(tempnick);
981         const char *ipaddr = insp_ntoa(ip);
982         userrec* New;
983         int j = 0;
984
985         /*
986          * fix by brain.
987          * as these nicknames are 'RFC impossible', we can be sure nobody is going to be
988          * using one as a registered connection. As they are per fd, we can also safely assume
989          * that we wont have collisions. Therefore, if the nick exists in the list, its only
990          * used by a dead socket, erase the iterator so that the new client may reclaim it.
991          * this was probably the cause of 'server ignores me when i hammer it with reconnects'
992          * issue in earlier alphas/betas
993          */
994         if (iter != Instance->clientlist.end())
995         {
996                 userrec* goner = iter->second;
997                 DELETE(goner);
998                 Instance->clientlist.erase(iter);
999         }
1000
1001         Instance->Log(DEBUG,"AddClient: %d %d %s",socket,port,ipaddr);
1002
1003         New = new userrec(Instance);
1004         Instance->clientlist[tempnick] = New;
1005         New->fd = socket;
1006         strlcpy(New->nick,tempnick.c_str(),NICKMAX-1);
1007
1008         New->server = Instance->FindServerNamePtr(Instance->Config->ServerName);
1009         /* We don't need range checking here, we KNOW 'unknown\0' will fit into the ident field. */
1010         strcpy(New->ident, "unknown");
1011
1012         New->registered = REG_NONE;
1013         New->signon = Instance->Time() + Instance->Config->dns_timeout;
1014         New->lastping = 1;
1015
1016         New->SetSockAddr(AF_FAMILY, ipaddr, port);
1017
1018         /* Smarter than your average bear^H^H^H^Hset of strlcpys. */
1019         for (const char* temp = New->GetIPString(); *temp && j < 64; temp++, j++)
1020                 New->dhost[j] = New->host[j] = *temp;
1021         New->dhost[j] = New->host[j] = 0;
1022
1023         Instance->AddLocalClone(New);
1024         Instance->AddGlobalClone(New);
1025
1026         // set the registration timeout for this user
1027         unsigned long class_regtimeout = 90;
1028         int class_flood = 0;
1029         long class_threshold = 5;
1030         long class_sqmax = 262144;      // 256kb
1031         long class_rqmax = 4096;        // 4k
1032
1033         for (ClassVector::iterator i = Instance->Config->Classes.begin(); i != Instance->Config->Classes.end(); i++)
1034         {
1035                 if ((i->type == CC_ALLOW) && (match(ipaddr,i->host.c_str(),true)))
1036                 {
1037                         class_regtimeout = (unsigned long)i->registration_timeout;
1038                         class_flood = i->flood;
1039                         New->pingmax = i->pingtime;
1040                         class_threshold = i->threshold;
1041                         class_sqmax = i->sendqmax;
1042                         class_rqmax = i->recvqmax;
1043                         break;
1044                 }
1045         }
1046
1047         New->nping = Instance->Time() + New->pingmax + Instance->Config->dns_timeout;
1048         New->timeout = Instance->Time() + class_regtimeout;
1049         New->flood = class_flood;
1050         New->threshold = class_threshold;
1051         New->sendqmax = class_sqmax;
1052         New->recvqmax = class_rqmax;
1053
1054         Instance->local_users.push_back(New);
1055
1056         if ((Instance->local_users.size() > Instance->Config->SoftLimit) || (Instance->local_users.size() >= MAXCLIENTS))
1057         {
1058                 Instance->WriteOpers("*** Warning: softlimit value has been reached: %d clients", Instance->Config->SoftLimit);
1059                 userrec::QuitUser(Instance, New,"No more connections allowed");
1060                 return;
1061         }
1062
1063         /*
1064          * XXX -
1065          * this is done as a safety check to keep the file descriptors within range of fd_ref_table.
1066          * its a pretty big but for the moment valid assumption:
1067          * file descriptors are handed out starting at 0, and are recycled as theyre freed.
1068          * therefore if there is ever an fd over 65535, 65536 clients must be connected to the
1069          * irc server at once (or the irc server otherwise initiating this many connections, files etc)
1070          * which for the time being is a physical impossibility (even the largest networks dont have more
1071          * than about 10,000 users on ONE server!)
1072          */
1073         if ((unsigned int)socket >= MAX_DESCRIPTORS)
1074         {
1075                 userrec::QuitUser(Instance, New, "Server is full");
1076                 return;
1077         }
1078
1079         New->exempt = (Instance->XLines->matches_exception(New) != NULL);
1080         if (!New->exempt)
1081         {
1082                 ZLine* r = Instance->XLines->matches_zline(ipaddr);
1083                 if (r)
1084                 {
1085                         char reason[MAXBUF];
1086                         snprintf(reason,MAXBUF,"Z-Lined: %s",r->reason);
1087                         userrec::QuitUser(Instance, New, reason);
1088                         return;
1089                 }
1090         }
1091
1092         if (socket > -1)
1093         {
1094                 if (!Instance->SE->AddFd(New))
1095                 {
1096                         userrec::QuitUser(Instance, New, "Internal error handling connection");
1097                         return;
1098                 }
1099         }
1100
1101         /* NOTE: even if dns lookups are *off*, we still need to display this.
1102          * BOPM and other stuff requires it.
1103          */
1104         New->WriteServ("NOTICE Auth :*** Looking up your hostname...");
1105 }
1106
1107 long userrec::GlobalCloneCount()
1108 {
1109         clonemap::iterator x = ServerInstance->global_clones.find(this->GetIPString());
1110         if (x != ServerInstance->global_clones.end())
1111                 return x->second;
1112         else
1113                 return 0;
1114 }
1115
1116 long userrec::LocalCloneCount()
1117 {
1118         clonemap::iterator x = ServerInstance->local_clones.find(this->GetIPString());
1119         if (x != ServerInstance->local_clones.end())
1120                 return x->second;
1121         else
1122                 return 0;
1123 }
1124
1125 void userrec::FullConnect(CullList* Goners)
1126 {
1127         ServerInstance->stats->statsConnects++;
1128         this->idle_lastmsg = ServerInstance->Time();
1129
1130         ConnectClass a = this->GetClass();
1131
1132         if (a.type == CC_DENY)
1133         {
1134                 Goners->AddItem(this,"Unauthorised connection");
1135                 return;
1136         }
1137         
1138         if ((*(a.pass.c_str())) && (!this->haspassed))
1139         {
1140                 Goners->AddItem(this,"Invalid password");
1141                 return;
1142         }
1143         
1144         if (this->LocalCloneCount() > a.maxlocal)
1145         {
1146                 Goners->AddItem(this, "No more connections allowed from your host via this connect class (local)");
1147                 ServerInstance->WriteOpers("*** WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a.maxlocal, this->GetIPString());
1148                 return;
1149         }
1150         else if (this->GlobalCloneCount() > a.maxglobal)
1151         {
1152                 Goners->AddItem(this, "No more connections allowed from your host via this connect class (global)");
1153                 ServerInstance->WriteOpers("*** WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s",a.maxglobal, this->GetIPString());
1154                 return;
1155         }
1156
1157         if (!this->exempt)
1158         {
1159                 GLine* r = ServerInstance->XLines->matches_gline(this);
1160                 
1161                 if (r)
1162                 {
1163                         char reason[MAXBUF];
1164                         snprintf(reason,MAXBUF,"G-Lined: %s",r->reason);
1165                         Goners->AddItem(this, reason);
1166                         return;
1167                 }
1168                 
1169                 KLine* n = ServerInstance->XLines->matches_kline(this);
1170                 
1171                 if (n)
1172                 {
1173                         char reason[MAXBUF];
1174                         snprintf(reason,MAXBUF,"K-Lined: %s",n->reason);
1175                         Goners->AddItem(this, reason);
1176                         return;
1177                 }
1178         }
1179
1180
1181         this->WriteServ("NOTICE Auth :Welcome to \002%s\002!",ServerInstance->Config->Network);
1182         this->WriteServ("001 %s :Welcome to the %s IRC Network %s!%s@%s",this->nick, ServerInstance->Config->Network, this->nick, this->ident, this->host);
1183         this->WriteServ("002 %s :Your host is %s, running version %s",this->nick,ServerInstance->Config->ServerName,VERSION);
1184         this->WriteServ("003 %s :This server was created %s %s", this->nick, __TIME__, __DATE__);
1185         this->WriteServ("004 %s %s %s %s %s %s", this->nick, ServerInstance->Config->ServerName, VERSION, ServerInstance->Modes->UserModeList().c_str(), ServerInstance->Modes->ChannelModeList().c_str(), ServerInstance->Modes->ParaModeList().c_str());
1186
1187         ServerInstance->Config->Send005(this);
1188
1189         this->ShowMOTD();
1190
1191         /*
1192          * fix 3 by brain, move registered = 7 below these so that spurious modes and host
1193          * changes dont go out onto the network and produce 'fake direction'.
1194          */
1195         FOREACH_MOD(I_OnUserConnect,OnUserConnect(this));
1196
1197         this->registered = REG_ALL;
1198
1199         FOREACH_MOD(I_OnPostConnect,OnPostConnect(this));
1200
1201         ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d: %s!%s@%s [%s]", this->GetPort(), this->nick, this->ident, this->host, this->GetIPString());
1202 }
1203
1204 /** userrec::UpdateNick()
1205  * re-allocates a nick in the user_hash after they change nicknames,
1206  * returns a pointer to the new user as it may have moved
1207  */
1208 userrec* userrec::UpdateNickHash(const char* New)
1209 {
1210         try
1211         {
1212                 //user_hash::iterator newnick;
1213                 user_hash::iterator oldnick = ServerInstance->clientlist.find(this->nick);
1214
1215                 if (!strcasecmp(this->nick,New))
1216                         return oldnick->second;
1217
1218                 if (oldnick == ServerInstance->clientlist.end())
1219                         return NULL; /* doesnt exist */
1220
1221                 userrec* olduser = oldnick->second;
1222                 ServerInstance->clientlist[New] = olduser;
1223                 ServerInstance->clientlist.erase(oldnick);
1224                 return ServerInstance->clientlist[New];
1225         }
1226
1227         catch (...)
1228         {
1229                 ServerInstance->Log(DEBUG,"Exception in userrec::UpdateNickHash()");
1230                 return NULL;
1231         }
1232 }
1233
1234 bool userrec::ForceNickChange(const char* newnick)
1235 {
1236         try
1237         {
1238                 int MOD_RESULT = 0;
1239         
1240                 FOREACH_RESULT(I_OnUserPreNick,OnUserPreNick(this, newnick));
1241
1242                 if (MOD_RESULT)
1243                 {
1244                         ServerInstance->stats->statsCollisions++;
1245                         return false;
1246                 }
1247         
1248                 if (ServerInstance->XLines->matches_qline(newnick))
1249                 {
1250                         ServerInstance->stats->statsCollisions++;
1251                         return false;
1252                 }
1253
1254                 if (this->registered == REG_ALL)
1255                 {
1256                         const char* pars[1];
1257                         pars[0] = newnick;
1258                         std::string cmd = "NICK";
1259                         return (ServerInstance->Parser->CallHandler(cmd, pars, 1, this) == CMD_SUCCESS);
1260                 }
1261                 return false;
1262         }
1263
1264         catch (...)
1265         {
1266                 ServerInstance->Log(DEBUG,"Exception in userrec::ForceNickChange()");
1267                 return false;
1268         }
1269 }
1270
1271 void userrec::SetSockAddr(int protocol_family, const char* ip, int port)
1272 {
1273         switch (protocol_family)
1274         {
1275 #ifdef SUPPORT_IP6LINKS
1276                 case AF_INET6:
1277                 {
1278                         ServerInstance->Log(DEBUG,"Set inet6 protocol address");
1279                         sockaddr_in6* sin = new sockaddr_in6;
1280                         sin->sin6_family = AF_INET6;
1281                         sin->sin6_port = port;
1282                         inet_pton(AF_INET6, ip, &sin->sin6_addr);
1283                         this->ip = (sockaddr*)sin;
1284                 }
1285                 break;
1286 #endif
1287                 case AF_INET:
1288                 {
1289                         ServerInstance->Log(DEBUG,"Set inet4 protocol address");
1290                         sockaddr_in* sin = new sockaddr_in;
1291                         sin->sin_family = AF_INET;
1292                         sin->sin_port = port;
1293                         inet_pton(AF_INET, ip, &sin->sin_addr);
1294                         this->ip = (sockaddr*)sin;
1295                 }
1296                 break;
1297                 default:
1298                         ServerInstance->Log(DEBUG,"Ut oh, I dont know protocol %d to be set on '%s'!", protocol_family, this->nick);
1299                 break;
1300         }
1301 }
1302
1303 int userrec::GetPort()
1304 {
1305         if (this->ip == NULL)
1306                 return 0;
1307
1308         switch (this->GetProtocolFamily())
1309         {
1310 #ifdef SUPPORT_IP6LINKS
1311                 case AF_INET6:
1312                 {
1313                         sockaddr_in6* sin = (sockaddr_in6*)this->ip;
1314                         return sin->sin6_port;
1315                 }
1316                 break;
1317 #endif
1318                 case AF_INET:
1319                 {
1320                         sockaddr_in* sin = (sockaddr_in*)this->ip;
1321                         return sin->sin_port;
1322                 }
1323                 break;
1324                 default:
1325                 break;
1326         }
1327         return 0;
1328 }
1329
1330 int userrec::GetProtocolFamily()
1331 {
1332         if (this->ip == NULL)
1333                 return 0;
1334
1335         sockaddr_in* sin = (sockaddr_in*)this->ip;
1336         return sin->sin_family;
1337 }
1338
1339 const char* userrec::GetIPString()
1340 {
1341         static char buf[1024];
1342
1343         if (this->ip == NULL)
1344                 return "";
1345
1346         switch (this->GetProtocolFamily())
1347         {
1348 #ifdef SUPPORT_IP6LINKS
1349                 case AF_INET6:
1350                 {
1351                         static char temp[1024];
1352                 
1353                         sockaddr_in6* sin = (sockaddr_in6*)this->ip;
1354                         inet_ntop(sin->sin6_family, &sin->sin6_addr, buf, sizeof(buf));
1355                         /* IP addresses starting with a : on irc are a Bad Thing (tm) */
1356                         if (*buf == ':')
1357                         {
1358                                 strlcpy(&temp[1], buf, sizeof(temp) - 1);
1359                                 *temp = '0';
1360                                 return temp;
1361                         }
1362                         return buf;
1363                 }
1364                 break;
1365 #endif
1366                 case AF_INET:
1367                 {
1368                         sockaddr_in* sin = (sockaddr_in*)this->ip;
1369                         inet_ntop(sin->sin_family, &sin->sin_addr, buf, sizeof(buf));
1370                         return buf;
1371                 }
1372                 break;
1373                 default:
1374                 break;
1375         }
1376         return "";
1377 }
1378
1379 const char* userrec::GetIPString(char* buf)
1380 {
1381         if (this->ip == NULL)
1382         {
1383                 *buf = 0;
1384                 return buf;
1385         }
1386
1387         switch (this->GetProtocolFamily())
1388         {
1389 #ifdef SUPPORT_IP6LINKS
1390                 case AF_INET6:
1391                 {
1392                         static char temp[1024];
1393                 
1394                         sockaddr_in6* sin = (sockaddr_in6*)this->ip;
1395                         inet_ntop(sin->sin6_family, &sin->sin6_addr, buf, sizeof(buf));
1396                         /* IP addresses starting with a : on irc are a Bad Thing (tm) */
1397                         if (*buf == ':')
1398                         {
1399                                 strlcpy(&temp[1], buf, sizeof(temp) - 1);
1400                                 *temp = '0';
1401                                 strlcpy(buf, temp, sizeof(temp));
1402                         }
1403                         return buf;
1404                 }
1405                 break;
1406 #endif
1407                 case AF_INET:
1408                 {
1409                         sockaddr_in* sin = (sockaddr_in*)this->ip;
1410                         inet_ntop(sin->sin_family, &sin->sin_addr, buf, sizeof(buf));
1411                         return buf;
1412                 }
1413                 break;
1414
1415                 default:
1416                 break;
1417         }
1418         return "";
1419 }
1420
1421 /** NOTE: We cannot pass a const reference to this method.
1422  * The string is changed by the workings of the method,
1423  * so that if we pass const ref, we end up copying it to
1424  * something we can change anyway. Makes sense to just let
1425  * the compiler do that copy for us.
1426  */
1427 void userrec::Write(std::string text)
1428 {
1429         if ((this->fd < 0) || (this->fd > MAX_DESCRIPTORS))
1430                 return;
1431
1432         try
1433         {
1434                 text.append("\r\n");
1435         }
1436         catch (...)
1437         {
1438                 ServerInstance->Log(DEBUG,"Exception in userrec::Write() std::string::append");
1439                 return;
1440         }
1441
1442         if (ServerInstance->Config->GetIOHook(this->GetPort()))
1443         {
1444                 try
1445                 {
1446                         ServerInstance->Config->GetIOHook(this->GetPort())->OnRawSocketWrite(this->fd, text.data(), text.length());
1447                 }
1448                 catch (ModuleException& modexcept)
1449                 {
1450                         ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason());
1451                 }
1452         }
1453         else
1454         {
1455                 this->AddWriteBuf(text);
1456         }
1457         ServerInstance->stats->statsSent += text.length();
1458         this->ServerInstance->SE->WantWrite(this);
1459 }
1460
1461 /** Write()
1462  */
1463 void userrec::Write(const char *text, ...)
1464 {
1465         va_list argsPtr;
1466         char textbuffer[MAXBUF];
1467
1468         va_start(argsPtr, text);
1469         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1470         va_end(argsPtr);
1471
1472         this->Write(std::string(textbuffer));
1473 }
1474
1475 void userrec::WriteServ(const std::string& text)
1476 {
1477         char textbuffer[MAXBUF];
1478
1479         snprintf(textbuffer,MAXBUF,":%s %s",ServerInstance->Config->ServerName,text.c_str());
1480         this->Write(std::string(textbuffer));
1481 }
1482
1483 /** WriteServ()
1484  *  Same as Write(), except `text' is prefixed with `:server.name '.
1485  */
1486 void userrec::WriteServ(const char* text, ...)
1487 {
1488         va_list argsPtr;
1489         char textbuffer[MAXBUF];
1490
1491         va_start(argsPtr, text);
1492         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1493         va_end(argsPtr);
1494
1495         this->WriteServ(std::string(textbuffer));
1496 }
1497
1498
1499 void userrec::WriteFrom(userrec *user, const std::string &text)
1500 {
1501         char tb[MAXBUF];
1502
1503         snprintf(tb,MAXBUF,":%s %s",user->GetFullHost(),text.c_str());
1504         
1505         this->Write(std::string(tb));
1506 }
1507
1508
1509 /* write text from an originating user to originating user */
1510
1511 void userrec::WriteFrom(userrec *user, const char* text, ...)
1512 {
1513         va_list argsPtr;
1514         char textbuffer[MAXBUF];
1515
1516         va_start(argsPtr, text);
1517         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1518         va_end(argsPtr);
1519
1520         this->WriteFrom(user, std::string(textbuffer));
1521 }
1522
1523
1524 /* write text to an destination user from a source user (e.g. user privmsg) */
1525
1526 void userrec::WriteTo(userrec *dest, const char *data, ...)
1527 {
1528         char textbuffer[MAXBUF];
1529         va_list argsPtr;
1530
1531         va_start(argsPtr, data);
1532         vsnprintf(textbuffer, MAXBUF, data, argsPtr);
1533         va_end(argsPtr);
1534
1535         this->WriteTo(dest, std::string(textbuffer));
1536 }
1537
1538 void userrec::WriteTo(userrec *dest, const std::string &data)
1539 {
1540         dest->WriteFrom(this, data);
1541 }
1542
1543
1544 void userrec::WriteCommon(const char* text, ...)
1545 {
1546         char textbuffer[MAXBUF];
1547         va_list argsPtr;
1548
1549         if (this->registered != REG_ALL)
1550                 return;
1551
1552         va_start(argsPtr, text);
1553         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1554         va_end(argsPtr);
1555
1556         this->WriteCommon(std::string(textbuffer));
1557 }
1558
1559 void userrec::WriteCommon(const std::string &text)
1560 {
1561         try
1562         {
1563                 bool sent_to_at_least_one = false;
1564         
1565                 if (this->registered != REG_ALL)
1566                         return;
1567         
1568                 uniq_id++;
1569         
1570                 for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++)
1571                 {
1572                         CUList* ulist = v->first->GetUsers();
1573                         for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
1574                         {
1575                                 if ((IS_LOCAL(i->second)) && (already_sent[i->second->fd] != uniq_id))
1576                                 {
1577                                         already_sent[i->second->fd] = uniq_id;
1578                                         i->second->WriteFrom(this, std::string(text));
1579                                         sent_to_at_least_one = true;
1580                                 }
1581                         }
1582                 }
1583         
1584                 /*
1585                  * if the user was not in any channels, no users will receive the text. Make sure the user
1586                  * receives their OWN message for WriteCommon
1587                  */
1588                 if (!sent_to_at_least_one)
1589                 {
1590                         this->WriteFrom(this,std::string(text));
1591                 }
1592         }
1593
1594         catch (...)
1595         {
1596                 ServerInstance->Log(DEBUG,"Exception in userrec::WriteCommon()");
1597         }
1598 }
1599
1600
1601 /* write a formatted string to all users who share at least one common
1602  * channel, NOT including the source user e.g. for use in QUIT
1603  */
1604
1605 void userrec::WriteCommonExcept(const char* text, ...)
1606 {
1607         char textbuffer[MAXBUF];
1608         va_list argsPtr;
1609
1610         va_start(argsPtr, text);
1611         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1612         va_end(argsPtr);
1613
1614         this->WriteCommonExcept(std::string(textbuffer));
1615 }
1616
1617 void userrec::WriteCommonExcept(const std::string &text)
1618 {
1619         bool quit_munge = false;
1620         char oper_quit[MAXBUF];
1621         char textbuffer[MAXBUF];
1622
1623         strlcpy(textbuffer, text.c_str(), MAXBUF);
1624
1625         if (this->registered != REG_ALL)
1626                 return;
1627
1628         uniq_id++;
1629
1630         /* TODO: We need some form of WriteCommonExcept that will send two lines, one line to
1631          * opers and the other line to non-opers, then all this hidebans and hidesplits gunk
1632          * can go byebye.
1633          */
1634         if (ServerInstance->Config->HideSplits)
1635         {
1636                 char* check = textbuffer + 6;
1637
1638                 if (!strncasecmp(textbuffer, "QUIT :",6))
1639                 {
1640                         std::stringstream split(check);
1641                         std::string server_one;
1642                         std::string server_two;
1643
1644                         split >> server_one;
1645                         split >> server_two;
1646
1647                         if ((ServerInstance->FindServerName(server_one)) && (ServerInstance->FindServerName(server_two)))
1648                         {
1649                                 strlcpy(oper_quit,textbuffer,MAXQUIT);
1650                                 strlcpy(check,"*.net *.split",MAXQUIT);
1651                                 quit_munge = true;
1652                         }
1653                 }
1654         }
1655
1656         if ((ServerInstance->Config->HideBans) && (!quit_munge))
1657         {
1658                 if ((!strncasecmp(textbuffer, "QUIT :G-Lined:",14)) || (!strncasecmp(textbuffer, "QUIT :K-Lined:",14))
1659                 || (!strncasecmp(textbuffer, "QUIT :Q-Lined:",14)) || (!strncasecmp(textbuffer, "QUIT :Z-Lined:",14)))
1660                 {
1661                         char* check = textbuffer + 13;
1662                         strlcpy(oper_quit,textbuffer,MAXQUIT);
1663                         *check = 0;  // We don't need to strlcpy, we just chop it from the :
1664                         quit_munge = true;
1665                 }
1666         }
1667
1668         for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++)
1669         {
1670                 CUList *ulist = v->first->GetUsers();
1671                 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
1672                 {
1673                         if (this != i->second)
1674                         {
1675                                 if ((IS_LOCAL(i->second)) && (already_sent[i->second->fd] != uniq_id))
1676                                 {
1677                                         already_sent[i->second->fd] = uniq_id;
1678                                         if (quit_munge)
1679                                                 i->second->WriteFrom(this, *i->second->oper ? std::string(oper_quit) : std::string(textbuffer));
1680                                         else
1681                                                 i->second->WriteFrom(this, std::string(textbuffer));
1682                                 }
1683                         }
1684                 }
1685         }
1686
1687 }
1688
1689 void userrec::WriteWallOps(const std::string &text)
1690 {
1691         /* Does nothing if theyre not opered */
1692         if ((!*this->oper) && (IS_LOCAL(this)))
1693                 return;
1694
1695         std::string wallop = "WALLOPS :";
1696
1697         try
1698         {
1699                 wallop.append(text);
1700         }
1701         catch (...)
1702         {
1703                 ServerInstance->Log(DEBUG,"Exception in userrec::Write() std::string::append");
1704                 return;
1705         }
1706
1707         for (std::vector<userrec*>::const_iterator i = ServerInstance->local_users.begin(); i != ServerInstance->local_users.end(); i++)
1708         {
1709                 userrec* t = *i;
1710                 if ((IS_LOCAL(t)) && (t->modes[UM_WALLOPS]))
1711                         this->WriteTo(t,wallop);
1712         }
1713 }
1714
1715 void userrec::WriteWallOps(const char* text, ...)
1716 {       
1717         char textbuffer[MAXBUF];
1718         va_list argsPtr;
1719
1720         va_start(argsPtr, text);
1721         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1722         va_end(argsPtr);                
1723                                         
1724         this->WriteWallOps(std::string(textbuffer));
1725 }                                      
1726
1727 /* return 0 or 1 depending if users u and u2 share one or more common channels
1728  * (used by QUIT, NICK etc which arent channel specific notices)
1729  *
1730  * The old algorithm in 1.0 for this was relatively inefficient, iterating over
1731  * the first users channels then the second users channels within the outer loop,
1732  * therefore it was a maximum of x*y iterations (upon returning 0 and checking
1733  * all possible iterations). However this new function instead checks against the
1734  * channel's userlist in the inner loop which is a std::map<userrec*,userrec*>
1735  * and saves us time as we already know what pointer value we are after.
1736  * Don't quote me on the maths as i am not a mathematician or computer scientist,
1737  * but i believe this algorithm is now x+(log y) maximum iterations instead.
1738  */
1739 bool userrec::SharesChannelWith(userrec *other)
1740 {
1741         if ((!other) || (this->registered != REG_ALL) || (other->registered != REG_ALL))
1742                 return false;
1743
1744         /* Outer loop */
1745         for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1746         {
1747                 /* Eliminate the inner loop (which used to be ~equal in size to the outer loop)
1748                  * by replacing it with a map::find which *should* be more efficient
1749                  */
1750                 if (i->first->HasUser(other))
1751                         return true;
1752         }
1753         return false;
1754 }
1755
1756 bool userrec::ChangeName(const char* gecos)
1757 {
1758         if (!strcmp(gecos, this->fullname))
1759                 return true;
1760
1761         if (IS_LOCAL(this))
1762         {
1763                 int MOD_RESULT = 0;
1764                 FOREACH_RESULT(I_OnChangeLocalUserGECOS,OnChangeLocalUserGECOS(this,gecos));
1765                 if (MOD_RESULT)
1766                         return false;
1767                 FOREACH_MOD(I_OnChangeName,OnChangeName(this,gecos));
1768         }
1769         strlcpy(this->fullname,gecos,MAXGECOS+1);
1770         return true;
1771 }
1772
1773 bool userrec::ChangeDisplayedHost(const char* host)
1774 {
1775         if (!strcmp(host, this->dhost))
1776                 return true;
1777
1778         if (IS_LOCAL(this))
1779         {
1780                 int MOD_RESULT = 0;
1781                 FOREACH_RESULT(I_OnChangeLocalUserHost,OnChangeLocalUserHost(this,host));
1782                 if (MOD_RESULT)
1783                         return false;
1784                 FOREACH_MOD(I_OnChangeHost,OnChangeHost(this,host));
1785         }
1786         if (this->ServerInstance->Config->CycleHosts)
1787                 this->WriteCommonExcept("QUIT :Changing hosts");
1788
1789         /* Fix by Om: userrec::dhost is 65 long, this was truncating some long hosts */
1790         strlcpy(this->dhost,host,64);
1791
1792         if (this->ServerInstance->Config->CycleHosts)
1793         {
1794                 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1795                 {
1796                         i->first->WriteAllExceptSender(this, false, 0, "JOIN %s", i->first->name);
1797                         std::string n = this->ServerInstance->Modes->ModeString(this, i->first);
1798                         if (n.length() > 0)
1799                                 i->first->WriteAllExceptSender(this, true, 0, "MODE %s +%s", i->first->name, n.c_str());
1800                 }
1801         }
1802
1803         if (IS_LOCAL(this))
1804                 this->WriteServ("396 %s %s :is now your hidden host",this->nick,this->dhost);
1805
1806         return true;
1807 }
1808
1809 bool userrec::ChangeIdent(const char* newident)
1810 {
1811         if (!strcmp(newident, this->ident))
1812                 return true;
1813
1814         if (this->ServerInstance->Config->CycleHosts)
1815                 this->WriteCommonExcept("%s","QUIT :Changing ident");
1816
1817         strlcpy(this->ident, newident, IDENTMAX+2);
1818
1819         if (this->ServerInstance->Config->CycleHosts)
1820         {
1821                 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1822                 {
1823                         i->first->WriteAllExceptSender(this, false, 0, "JOIN %s", i->first->name);
1824                         std::string n = this->ServerInstance->Modes->ModeString(this, i->first);
1825                         if (n.length() > 0)
1826                                 i->first->WriteAllExceptSender(this, true, 0, "MODE %s +%s", i->first->name, n.c_str());
1827                 }
1828         }
1829
1830         return true;
1831 }
1832
1833 void userrec::NoticeAll(char* text, ...)
1834 {
1835         char textbuffer[MAXBUF];
1836         char formatbuffer[MAXBUF];
1837         va_list argsPtr;
1838
1839         va_start(argsPtr, text);
1840         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
1841         va_end(argsPtr);
1842
1843         snprintf(formatbuffer,MAXBUF,"NOTICE $* :%s",textbuffer);
1844
1845         for (std::vector<userrec*>::const_iterator i = ServerInstance->local_users.begin(); i != ServerInstance->local_users.end(); i++)
1846         {
1847                 userrec* t = *i;
1848                 t->WriteFrom(this, std::string(formatbuffer));
1849         }
1850 }
1851
1852
1853 std::string userrec::ChannelList(userrec* source)
1854 {
1855         try
1856         {
1857                 std::string list;
1858                 for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++)
1859                 {
1860                         /* If the target is the same as the sender, let them see all their channels.
1861                          * If the channel is NOT private/secret OR the user shares a common channel
1862                          * If the user is an oper, and the <options:operspywhois> option is set.
1863                          */
1864                         if ((source == this) || (*source->oper && ServerInstance->Config->OperSpyWhois) || (((!i->first->modes[CM_PRIVATE]) && (!i->first->modes[CM_SECRET])) || (i->first->HasUser(source))))
1865                         {
1866                                 list.append(i->first->GetPrefixChar(this)).append(i->first->name).append(" ");
1867                         }
1868                 }
1869                 return list;
1870         }
1871         catch (...)
1872         {
1873                 ServerInstance->Log(DEBUG,"Exception in userrec::ChannelList()");
1874                 return "";
1875         }
1876 }
1877
1878 void userrec::SplitChanList(userrec* dest, const std::string &cl)
1879 {
1880         std::string line;
1881         std::ostringstream prefix;
1882         std::string::size_type start, pos, length;
1883
1884         try
1885         {
1886                 prefix << this->nick << " " << dest->nick << " :";
1887                 line = prefix.str();
1888                 int namelen = strlen(ServerInstance->Config->ServerName) + 6;
1889         
1890                 for (start = 0; (pos = cl.find(' ', start)) != std::string::npos; start = pos+1)
1891                 {
1892                         length = (pos == std::string::npos) ? cl.length() : pos;
1893         
1894                         if (line.length() + namelen + length - start > 510)
1895                         {
1896                                 ServerInstance->SendWhoisLine(this, dest, 319, "%s", line.c_str());
1897                                 line = prefix.str();
1898                         }
1899         
1900                         if(pos == std::string::npos)
1901                         {
1902                                 line.append(cl.substr(start, length - start));
1903                                 break;
1904                         }
1905                         else
1906                         {
1907                                 line.append(cl.substr(start, length - start + 1));
1908                         }
1909                 }
1910         
1911                 if (line.length())
1912                 {
1913                         ServerInstance->SendWhoisLine(this, dest, 319, "%s", line.c_str());
1914                 }
1915         }
1916
1917         catch (...)
1918         {
1919                 ServerInstance->Log(DEBUG,"Exception in userrec::SplitChanList()");
1920         }
1921 }
1922
1923
1924 /* looks up a users password for their connection class (<ALLOW>/<DENY> tags)
1925  * NOTE: If the <ALLOW> or <DENY> tag specifies an ip, and this user resolves,
1926  * then their ip will be taken as 'priority' anyway, so for example,
1927  * <connect allow="127.0.0.1"> will match joe!bloggs@localhost
1928  */
1929 ConnectClass& userrec::GetClass()
1930 {
1931         for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
1932         {
1933                 if ((match(this->GetIPString(),i->host.c_str(),true)) || (match(this->host,i->host.c_str())))
1934                         return *i;
1935         }
1936
1937         return *(ServerInstance->Config->Classes.begin());
1938 }
1939
1940 void userrec::PurgeEmptyChannels()
1941 {
1942         std::vector<chanrec*> to_delete;
1943
1944         // firstly decrement the count on each channel
1945         for (UCListIter f = this->chans.begin(); f != this->chans.end(); f++)
1946         {
1947                 f->first->RemoveAllPrefixes(this);
1948                 if (f->first->DelUser(this) == 0)
1949                 {
1950                         /* No users left in here, mark it for deletion */
1951                         try
1952                         {
1953                                 to_delete.push_back(f->first);
1954                         }
1955                         catch (...)
1956                         {
1957                                 ServerInstance->Log(DEBUG,"Exception in userrec::PurgeEmptyChannels to_delete.push_back()");
1958                         }
1959                 }
1960         }
1961
1962         for (std::vector<chanrec*>::iterator n = to_delete.begin(); n != to_delete.end(); n++)
1963         {
1964                 chanrec* thischan = *n;
1965                 chan_hash::iterator i2 = ServerInstance->chanlist.find(thischan->name);
1966                 if (i2 != ServerInstance->chanlist.end())
1967                 {
1968                         FOREACH_MOD(I_OnChannelDelete,OnChannelDelete(i2->second));
1969                         DELETE(i2->second);
1970                         ServerInstance->chanlist.erase(i2);
1971                 }
1972         }
1973
1974         this->UnOper();
1975 }
1976
1977 void userrec::ShowMOTD()
1978 {
1979         if (!ServerInstance->Config->MOTD.size())
1980         {
1981                 this->WriteServ("422 %s :Message of the day file is missing.",this->nick);
1982                 return;
1983         }
1984         this->WriteServ("375 %s :%s message of the day", this->nick, ServerInstance->Config->ServerName);
1985
1986         for (file_cache::iterator i = ServerInstance->Config->MOTD.begin(); i != ServerInstance->Config->MOTD.end(); i++)
1987                 this->WriteServ("372 %s :- %s",this->nick,i->c_str());
1988
1989         this->WriteServ("376 %s :End of message of the day.", this->nick);
1990 }
1991
1992 void userrec::ShowRULES()
1993 {
1994         if (!ServerInstance->Config->RULES.size())
1995         {
1996                 this->WriteServ("NOTICE %s :Rules file is missing.",this->nick);
1997                 return;
1998         }
1999         this->WriteServ("NOTICE %s :%s rules",this->nick,ServerInstance->Config->ServerName);
2000
2001         for (file_cache::iterator i = ServerInstance->Config->RULES.begin(); i != ServerInstance->Config->RULES.end(); i++)
2002                 this->WriteServ("NOTICE %s :%s",this->nick,i->c_str());
2003
2004         this->WriteServ("NOTICE %s :End of %s rules.",this->nick,ServerInstance->Config->ServerName);
2005 }
2006
2007 void userrec::HandleEvent(EventType et, int errornum)
2008 {
2009         /* WARNING: May delete this user! */
2010         try
2011         {
2012                 switch (et)
2013                 {
2014                         case EVENT_READ:
2015                                 ServerInstance->ProcessUser(this);
2016
2017                         break;
2018                         case EVENT_WRITE:
2019                                 this->FlushWriteBuf();
2020                         break;
2021                         case EVENT_ERROR:
2022                                 /** This should be safe, but dont DARE do anything after it -- Brain */
2023                                 this->SetWriteError(errornum ? strerror(errornum) : "EOF from client");
2024                         break;
2025                 }
2026         }
2027         catch (...)
2028         {
2029                 ServerInstance->Log(DEBUG,"Exception in userrec::HandleEvent intercepted");
2030         }
2031
2032         /* If the user has raised an error whilst being processed, quit them now we're safe to */
2033         if (!WriteError.empty())
2034         {
2035                 userrec::QuitUser(ServerInstance, this, GetWriteError());
2036         }
2037 }
2038