0d2d4147345046b87f7f3c6e46fd018749f4da36
[ngircd-alex.git] / src / ngircd / client.c
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001-2012 Alexander Barton (alex@barton.de)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * Please read the file COPYING, README and AUTHORS for more information.
10  */
11
12 #define __client_c__
13
14 #include "portab.h"
15
16 /**
17  * @file
18  * Client management.
19  */
20
21 #include "imp.h"
22 #include <assert.h>
23 #include <unistd.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <strings.h>
28 #include <netdb.h>
29
30 #include "defines.h"
31 #include "conn.h"
32
33 #include "exp.h"
34 #include "client.h"
35
36 #include <imp.h>
37 #include "ngircd.h"
38 #include "channel.h"
39 #include "conf.h"
40 #include "conn-func.h"
41 #include "hash.h"
42 #include "irc-write.h"
43 #include "log.h"
44 #include "messages.h"
45
46 #include <exp.h>
47
48 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
49
50 static CLIENT *This_Server, *My_Clients;
51
52 static WHOWAS My_Whowas[MAX_WHOWAS];
53 static int Last_Whowas = -1;
54 static long Max_Users, My_Max_Users;
55
56
57 static unsigned long Count PARAMS(( CLIENT_TYPE Type ));
58 static unsigned long MyCount PARAMS(( CLIENT_TYPE Type ));
59
60 static CLIENT *New_Client_Struct PARAMS(( void ));
61 static void Generate_MyToken PARAMS(( CLIENT *Client ));
62 static void Adjust_Counters PARAMS(( CLIENT *Client ));
63
64 static CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
65                                        CLIENT *TopServer, int Type, const char *ID,
66                                        const char *User, const char *Hostname, const char *Info,
67                                        int Hops, int Token, const char *Modes,
68                                        bool Idented));
69
70 static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
71                                         bool SendQuit));
72
73 static void cb_introduceClient PARAMS((CLIENT *Client, CLIENT *Prefix,
74                                        void *i));
75
76 GLOBAL void
77 Client_Init( void )
78 {
79         struct hostent *h;
80         
81         This_Server = New_Client_Struct( );
82         if( ! This_Server )
83         {
84                 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
85                 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
86                 exit( 1 );
87         }
88
89         /* Client-Struktur dieses Servers */
90         This_Server->next = NULL;
91         This_Server->type = CLIENT_SERVER;
92         This_Server->conn_id = NONE;
93         This_Server->introducer = This_Server;
94         This_Server->mytoken = 1;
95         This_Server->hops = 0;
96
97         gethostname( This_Server->host, CLIENT_HOST_LEN );
98         if (Conf_DNS) {
99                 h = gethostbyname( This_Server->host );
100                 if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
101         }
102         Client_SetID( This_Server, Conf_ServerName );
103         Client_SetInfo( This_Server, Conf_ServerInfo );
104
105         My_Clients = This_Server;
106         
107         memset( &My_Whowas, 0, sizeof( My_Whowas ));
108 } /* Client_Init */
109
110
111 GLOBAL void
112 Client_Exit( void )
113 {
114         CLIENT *c, *next;
115         int cnt;
116
117         if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, false );
118         else Client_Destroy( This_Server, "Server going down.", NULL, false );
119         
120         cnt = 0;
121         c = My_Clients;
122         while( c )
123         {
124                 cnt++;
125                 next = (CLIENT *)c->next;
126                 free( c );
127                 c = next;
128         }
129         if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
130 } /* Client_Exit */
131
132
133 GLOBAL CLIENT *
134 Client_ThisServer( void )
135 {
136         return This_Server;
137 } /* Client_ThisServer */
138
139
140 /**
141  * Initialize new local client; wrapper function for Init_New_Client().
142  * @return New CLIENT structure.
143  */
144 GLOBAL CLIENT *
145 Client_NewLocal(CONN_ID Idx, const char *Hostname, int Type, bool Idented)
146 {
147         return Init_New_Client(Idx, This_Server, NULL, Type, NULL, NULL,
148                 Hostname, NULL, 0, 0, NULL, Idented);
149 } /* Client_NewLocal */
150
151
152 /**
153  * Initialize new remote server; wrapper function for Init_New_Client().
154  * @return New CLIENT structure.
155  */
156 GLOBAL CLIENT *
157 Client_NewRemoteServer(CLIENT *Introducer, const char *Hostname, CLIENT *TopServer,
158  int Hops, int Token, const char *Info, bool Idented)
159 {
160         return Init_New_Client(NONE, Introducer, TopServer, CLIENT_SERVER,
161                 Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented);
162 } /* Client_NewRemoteServer */
163
164
165 /**
166  * Initialize new remote client; wrapper function for Init_New_Client().
167  * @return New CLIENT structure.
168  */
169 GLOBAL CLIENT *
170 Client_NewRemoteUser(CLIENT *Introducer, const char *Nick, int Hops, const char *User,
171  const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented)
172 {
173         return Init_New_Client(NONE, Introducer, NULL, CLIENT_USER, Nick,
174                 User, Hostname, Info, Hops, Token, Modes, Idented);
175 } /* Client_NewRemoteUser */
176
177
178 /**
179  * Initialize new client and set up the given parameters like client type,
180  * user name, host name, introducing server etc. ...
181  * @return New CLIENT structure.
182  */
183 static CLIENT *
184 Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
185   int Type, const char *ID, const char *User, const char *Hostname,
186   const char *Info, int Hops, int Token, const char *Modes, bool Idented)
187 {
188         CLIENT *client;
189
190         assert(Idx >= NONE);
191         assert(Introducer != NULL);
192
193         client = New_Client_Struct();
194         if (!client)
195                 return NULL;
196
197         client->starttime = time(NULL);
198         client->conn_id = Idx;
199         client->introducer = Introducer;
200         client->topserver = TopServer;
201         client->type = Type;
202         if (ID)
203                 Client_SetID(client, ID);
204         if (User) {
205                 Client_SetUser(client, User, Idented);
206                 Client_SetOrigUser(client, User);
207         }
208         if (Hostname)
209                 Client_SetHostname(client, Hostname);
210         if (Info)
211                 Client_SetInfo(client, Info);
212         client->hops = Hops;
213         client->token = Token;
214         if (Modes)
215                 Client_SetModes(client, Modes);
216         if (Type == CLIENT_SERVER)
217                 Generate_MyToken(client);
218
219         if (strchr(client->modes, 'a'))
220                 strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
221
222         client->next = (POINTER *)My_Clients;
223         My_Clients = client;
224
225         Adjust_Counters(client);
226
227         return client;
228 } /* Init_New_Client */
229
230
231 GLOBAL void
232 Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit )
233 {
234         /* remove a client */
235         
236         CLIENT *last, *c;
237         char msg[LINE_LEN];
238         const char *txt;
239
240         assert( Client != NULL );
241
242         if( LogMsg ) txt = LogMsg;
243         else txt = FwdMsg;
244         if( ! txt ) txt = "Reason unknown.";
245
246         /* netsplit message */
247         if( Client->type == CLIENT_SERVER ) {
248                 strlcpy(msg, This_Server->id, sizeof (msg));
249                 strlcat(msg, " ", sizeof (msg));
250                 strlcat(msg, Client->id, sizeof (msg));
251         }
252
253         last = NULL;
254         c = My_Clients;
255         while( c )
256         {
257                 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
258                 {
259                         /*
260                          * The client that is about to be removed is a server,
261                          * the client we are checking right now is a child of that
262                          * server and thus has to be removed, too.
263                          *
264                          * Call Client_Destroy() recursively with the server as the
265                          * new "object to be removed". This starts the cycle again, until
266                          * all servers that are linked via the original server have been
267                          * removed.
268                          */
269                         Client_Destroy( c, NULL, msg, false );
270                         last = NULL;
271                         c = My_Clients;
272                         continue;
273                 }
274                 if( c == Client )
275                 {
276                         /* found  the client: remove it */
277                         if( last ) last->next = c->next;
278                         else My_Clients = (CLIENT *)c->next;
279
280                         if(c->type == CLIENT_USER || c->type == CLIENT_SERVICE)
281                                 Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
282                         else if( c->type == CLIENT_SERVER )
283                         {
284                                 if( c != This_Server )
285                                 {
286                                         if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
287                                         else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
288                                 }
289
290                                 /* inform other servers */
291                                 if( ! NGIRCd_SignalQuit )
292                                 {
293                                         if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
294                                         else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
295                                 }
296                         }
297                         else
298                         {
299                                 if( c->conn_id != NONE )
300                                 {
301                                         if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
302                                         else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
303                                 } else {
304                                         Log(LOG_WARNING, "Unregistered unknown client \"%s\": %s",
305                                                                 c->id[0] ? c->id : "(No Nick)", txt );
306                                 }
307                         }
308
309                         free( c );
310                         break;
311                 }
312                 last = c;
313                 c = (CLIENT *)c->next;
314         }
315 } /* Client_Destroy */
316
317
318 /**
319  * Set client hostname.
320  *
321  * If global hostname cloaking is in effect, don't set the real hostname
322  * but the configured one.
323  *
324  * @param Client The client of which the hostname should be set.
325  * @param Hostname The new hostname.
326  */
327 GLOBAL void
328 Client_SetHostname( CLIENT *Client, const char *Hostname )
329 {
330         assert(Client != NULL);
331         assert(Hostname != NULL);
332
333         if (strlen(Conf_CloakHost)) {
334                 char cloak[GETID_LEN];
335
336                 strlcpy(cloak, Hostname, GETID_LEN);
337                 strlcat(cloak, Conf_CloakHostSalt, GETID_LEN);
338                 snprintf(cloak, GETID_LEN, Conf_CloakHost, Hash(cloak));
339
340                 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
341                         Client_ID(Client), Client->host, cloak);
342                 strlcpy(Client->host, cloak, sizeof(Client->host));
343         } else {
344                 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
345                          Client_ID(Client), Client->host, Hostname);
346                 strlcpy(Client->host, Hostname, sizeof(Client->host));
347         }
348 } /* Client_SetHostname */
349
350
351 GLOBAL void
352 Client_SetID( CLIENT *Client, const char *ID )
353 {
354         assert( Client != NULL );
355         assert( ID != NULL );
356         
357         strlcpy( Client->id, ID, sizeof( Client->id ));
358
359         if (Conf_CloakUserToNick) {
360                 strlcpy( Client->user, ID, sizeof( Client->user ));
361                 strlcpy( Client->info, ID, sizeof( Client->info ));
362         }
363
364         /* Hash */
365         Client->hash = Hash( Client->id );
366 } /* Client_SetID */
367
368
369 GLOBAL void
370 Client_SetUser( CLIENT *Client, const char *User, bool Idented )
371 {
372         /* set clients username */
373
374         assert( Client != NULL );
375         assert( User != NULL );
376
377         if (Conf_CloakUserToNick) {
378                 strlcpy(Client->user, Client->id, sizeof(Client->user));
379         } else if (Idented) {
380                 strlcpy(Client->user, User, sizeof(Client->user));
381         } else {
382                 Client->user[0] = '~';
383                 strlcpy(Client->user + 1, User, sizeof(Client->user) - 1);
384         }
385 } /* Client_SetUser */
386
387
388 /**
389  * Set "original" user name of a client.
390  * This function saves the "original" user name, the user name specified by
391  * the peer using the USER command, into the CLIENT structure. This user
392  * name may be used for authentication, for example.
393  * @param Client The client.
394  * @param User User name to set.
395  */
396 GLOBAL void
397 Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
398 {
399         assert(Client != NULL);
400         assert(User != NULL);
401
402 #if defined(PAM) && defined(IDENTAUTH)
403         strlcpy(Client->orig_user, User, sizeof(Client->orig_user));
404 #endif
405 } /* Client_SetOrigUser */
406
407
408 GLOBAL void
409 Client_SetInfo( CLIENT *Client, const char *Info )
410 {
411         /* set client hostname */
412
413         assert( Client != NULL );
414         assert( Info != NULL );
415
416         if (Conf_CloakUserToNick)
417                 strlcpy(Client->info, Client->id, sizeof(Client->info));
418         else
419                 strlcpy(Client->info, Info, sizeof(Client->info));
420 } /* Client_SetInfo */
421
422
423 GLOBAL void
424 Client_SetModes( CLIENT *Client, const char *Modes )
425 {
426         assert( Client != NULL );
427         assert( Modes != NULL );
428
429         strlcpy(Client->modes, Modes, sizeof( Client->modes ));
430 } /* Client_SetModes */
431
432
433 GLOBAL void
434 Client_SetFlags( CLIENT *Client, const char *Flags )
435 {
436         assert( Client != NULL );
437         assert( Flags != NULL );
438
439         strlcpy(Client->flags, Flags, sizeof(Client->flags));
440 } /* Client_SetFlags */
441
442
443 GLOBAL void
444 Client_SetAway( CLIENT *Client, const char *Txt )
445 {
446         /* Set AWAY reason of client */
447
448         assert( Client != NULL );
449         assert( Txt != NULL );
450
451         strlcpy( Client->away, Txt, sizeof( Client->away ));
452         LogDebug("%s \"%s\" is away: %s", Client_TypeText(Client),
453                  Client_Mask(Client), Txt);
454 } /* Client_SetAway */
455
456
457 GLOBAL void
458 Client_SetType( CLIENT *Client, int Type )
459 {
460         assert( Client != NULL );
461         Client->type = Type;
462         if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
463         Adjust_Counters( Client );
464 } /* Client_SetType */
465
466
467 GLOBAL void
468 Client_SetHops( CLIENT *Client, int Hops )
469 {
470         assert( Client != NULL );
471         Client->hops = Hops;
472 } /* Client_SetHops */
473
474
475 GLOBAL void
476 Client_SetToken( CLIENT *Client, int Token )
477 {
478         assert( Client != NULL );
479         Client->token = Token;
480 } /* Client_SetToken */
481
482
483 GLOBAL void
484 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
485 {
486         assert( Client != NULL );
487         assert( Introducer != NULL );
488         Client->introducer = Introducer;
489 } /* Client_SetIntroducer */
490
491
492 GLOBAL void
493 Client_SetOperByMe( CLIENT *Client, bool OperByMe )
494 {
495         assert( Client != NULL );
496         Client->oper_by_me = OperByMe;
497 } /* Client_SetOperByMe */
498
499
500 GLOBAL bool
501 Client_ModeAdd( CLIENT *Client, char Mode )
502 {
503         /* Set Mode.
504          * If Client already alread had Mode, return false.
505          * If the Mode was newly set, return true.
506          */
507
508         char x[2];
509
510         assert( Client != NULL );
511
512         x[0] = Mode; x[1] = '\0';
513         if (!strchr( Client->modes, x[0])) {
514                 strlcat( Client->modes, x, sizeof( Client->modes ));
515                 return true;
516         }
517         else return false;
518 } /* Client_ModeAdd */
519
520
521 GLOBAL bool
522 Client_ModeDel( CLIENT *Client, char Mode )
523 {
524         /* Delete Mode.
525          * If Mode was removed, return true.
526          * If Client did not have Mode, return false.
527          */
528
529         char x[2], *p;
530
531         assert( Client != NULL );
532
533         x[0] = Mode; x[1] = '\0';
534
535         p = strchr( Client->modes, x[0] );
536         if( ! p ) return false;
537
538         /* Client has Mode -> delete */
539         while( *p )
540         {
541                 *p = *(p + 1);
542                 p++;
543         }
544         return true;
545 } /* Client_ModeDel */
546
547
548 GLOBAL CLIENT *
549 Client_Search( const char *Nick )
550 {
551         /* return Client-Structure that has the corresponding Nick.
552          * If none is found, return NULL.
553          */
554
555         char search_id[CLIENT_ID_LEN], *ptr;
556         CLIENT *c = NULL;
557         UINT32 search_hash;
558
559         assert( Nick != NULL );
560
561         /* copy Nick and truncate hostmask if necessary */
562         strlcpy( search_id, Nick, sizeof( search_id ));
563         ptr = strchr( search_id, '!' );
564         if( ptr ) *ptr = '\0';
565
566         search_hash = Hash(search_id);
567
568         c = My_Clients;
569         while (c) {
570                 if (c->hash == search_hash && strcasecmp(c->id, search_id) == 0)
571                         return c;
572                 c = (CLIENT *)c->next;
573         }
574         return NULL;
575 } /* Client_Search */
576
577
578 /**
579  * Get client structure ("introducer") identfied by a server token.
580  * @return CLIENT structure or NULL if none could be found.
581  */
582 GLOBAL CLIENT *
583 Client_GetFromToken( CLIENT *Client, int Token )
584 {
585         CLIENT *c;
586
587         assert( Client != NULL );
588
589         if (!Token)
590                 return NULL;
591
592         c = My_Clients;
593         while (c) {
594                 if ((c->type == CLIENT_SERVER) && (c->introducer == Client) &&
595                         (c->token == Token))
596                                 return c;
597                 c = (CLIENT *)c->next;
598         }
599         return NULL;
600 } /* Client_GetFromToken */
601
602
603 GLOBAL int
604 Client_Type( CLIENT *Client )
605 {
606         assert( Client != NULL );
607         return Client->type;
608 } /* Client_Type */
609
610
611 GLOBAL CONN_ID
612 Client_Conn( CLIENT *Client )
613 {
614         assert( Client != NULL );
615         return Client->conn_id;
616 } /* Client_Conn */
617
618
619 GLOBAL char *
620 Client_ID( CLIENT *Client )
621 {
622         assert( Client != NULL );
623
624 #ifdef DEBUG
625         if(Client->type == CLIENT_USER)
626                 assert(strlen(Client->id) < Conf_MaxNickLength);
627 #endif
628                                                    
629         if( Client->id[0] ) return Client->id;
630         else return "*";
631 } /* Client_ID */
632
633
634 GLOBAL char *
635 Client_Info( CLIENT *Client )
636 {
637         assert( Client != NULL );
638         return Client->info;
639 } /* Client_Info */
640
641
642 GLOBAL char *
643 Client_User( CLIENT *Client )
644 {
645         assert( Client != NULL );
646         return Client->user[0] ? Client->user : "~";
647 } /* Client_User */
648
649
650 #ifdef PAM
651
652 /**
653  * Get the "original" user name as supplied by the USER command.
654  * The user name as given by the client is used for authentication instead
655  * of the one detected using IDENT requests.
656  * @param Client The client.
657  * @return Original user name.
658  */
659 GLOBAL char *
660 Client_OrigUser(CLIENT *Client) {
661 #ifndef IDENTAUTH
662         char *user = Client->user;
663
664         if (user[0] == '~')
665                 user++;
666         return user;
667 #else
668         return Client->orig_user;
669 #endif
670 } /* Client_OrigUser */
671
672 #endif
673
674
675 /**
676  * Return the hostname of a client.
677  * @param Client Pointer to client structure
678  * @return Pointer to client hostname
679  */
680 GLOBAL char *
681 Client_Hostname(CLIENT *Client)
682 {
683         assert (Client != NULL);
684         return Client->host;
685 } /* Client_Hostname */
686
687
688 /**
689  * Get potentially cloaked hostname of a client.
690  * If the client has not enabled cloaking, the real hostname is used.
691  * @param Client Pointer to client structure
692  * @return Pointer to client hostname
693  */
694 GLOBAL char *
695 Client_HostnameCloaked(CLIENT *Client)
696 {
697         assert(Client != NULL);
698         if (Client_HasMode(Client, 'x'))
699                 return Client_ID(Client->introducer);
700         else
701                 return Client_Hostname(Client);
702 } /* Client_HostnameCloaked */
703
704
705 GLOBAL char *
706 Client_Modes( CLIENT *Client )
707 {
708         assert( Client != NULL );
709         return Client->modes;
710 } /* Client_Modes */
711
712
713 GLOBAL char *
714 Client_Flags( CLIENT *Client )
715 {
716         assert( Client != NULL );
717         return Client->flags;
718 } /* Client_Flags */
719
720
721 GLOBAL bool
722 Client_OperByMe( CLIENT *Client )
723 {
724         assert( Client != NULL );
725         return Client->oper_by_me;
726 } /* Client_OperByMe */
727
728
729 GLOBAL int
730 Client_Hops( CLIENT *Client )
731 {
732         assert( Client != NULL );
733         return Client->hops;
734 } /* Client_Hops */
735
736
737 GLOBAL int
738 Client_Token( CLIENT *Client )
739 {
740         assert( Client != NULL );
741         return Client->token;
742 } /* Client_Token */
743
744
745 GLOBAL int
746 Client_MyToken( CLIENT *Client )
747 {
748         assert( Client != NULL );
749         return Client->mytoken;
750 } /* Client_MyToken */
751
752
753 GLOBAL CLIENT *
754 Client_NextHop( CLIENT *Client )
755 {
756         CLIENT *c;
757
758         assert( Client != NULL );
759
760         c = Client;
761         while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server ))
762                 c = c->introducer;
763
764         return c;
765 } /* Client_NextHop */
766
767
768 /**
769  * Return ID of a client: "client!user@host"
770  * This client ID is used for IRC prefixes, for example.
771  * Please note that this function uses a global static buffer, so you can't
772  * nest invocations without overwriting earlier results!
773  * @param Client Pointer to client structure
774  * @return Pointer to global buffer containing the client ID
775  */
776 GLOBAL char *
777 Client_Mask( CLIENT *Client )
778 {
779         static char Mask_Buffer[GETID_LEN];
780
781         assert (Client != NULL);
782
783         /* Servers: return name only, there is no "mask" */
784         if (Client->type == CLIENT_SERVER)
785                 return Client->id;
786
787         snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
788                  Client->id, Client->user, Client->host);
789         return Mask_Buffer;
790 } /* Client_Mask */
791
792
793 /**
794  * Return ID of a client with cloaked hostname: "client!user@server-name"
795  * This client ID is used for IRC prefixes, for example.
796  * Please note that this function uses a global static buffer, so you can't
797  * nest invocations without overwriting earlier results!
798  * If the client has not enabled cloaking, the real hostname is used.
799  * @param Client Pointer to client structure
800  * @return Pointer to global buffer containing the client ID
801  */
802 GLOBAL char *
803 Client_MaskCloaked(CLIENT *Client)
804 {
805         static char Mask_Buffer[GETID_LEN];
806         char Cloak_Buffer[GETID_LEN];
807
808         assert (Client != NULL);
809
810         /* Is the client using cloaking at all? */
811         if (!Client_HasMode(Client, 'x'))
812                 return Client_Mask(Client);
813
814         if(*Conf_CloakHostModeX) {
815                 strlcpy(Cloak_Buffer, Client->host, GETID_LEN);
816                 strlcat(Cloak_Buffer, Conf_CloakHostSalt, GETID_LEN);
817                 snprintf(Cloak_Buffer, GETID_LEN, Conf_CloakHostModeX, Hash(Cloak_Buffer));
818         } else {
819                 strncpy(Cloak_Buffer, Client_ID(Client->introducer), GETID_LEN);
820         }
821
822         snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
823                 Client->id, Client->user, Cloak_Buffer);
824
825         return Mask_Buffer;
826 } /* Client_MaskCloaked */
827
828
829 GLOBAL CLIENT *
830 Client_Introducer( CLIENT *Client )
831 {
832         assert( Client != NULL );
833         return Client->introducer;
834 } /* Client_Introducer */
835
836
837 GLOBAL CLIENT *
838 Client_TopServer( CLIENT *Client )
839 {
840         assert( Client != NULL );
841         return Client->topserver;
842 } /* Client_TopServer */
843
844
845 GLOBAL bool
846 Client_HasMode( CLIENT *Client, char Mode )
847 {
848         assert( Client != NULL );
849         return strchr( Client->modes, Mode ) != NULL;
850 } /* Client_HasMode */
851
852
853 GLOBAL char *
854 Client_Away( CLIENT *Client )
855 {
856         assert( Client != NULL );
857         return Client->away;
858 } /* Client_Away */
859
860
861 /**
862  * Make sure that a given nickname is valid.
863  *
864  * If the nickname is not valid for the given client, this function sends back
865  * the appropriate error messages.
866  *
867  * @param       Client Client that wants to change the nickname.
868  * @param       Nick New nick name.
869  * @returns     true if nickname is valid, false otherwise.
870  */
871 GLOBAL bool
872 Client_CheckNick(CLIENT *Client, char *Nick)
873 {
874         assert(Client != NULL);
875         assert(Nick != NULL);
876
877         if (!Client_IsValidNick(Nick)) {
878                 if (strlen(Nick ) >= Conf_MaxNickLength)
879                         IRC_WriteStrClient(Client, ERR_NICKNAMETOOLONG_MSG,
880                                            Client_ID(Client), Nick,
881                                            Conf_MaxNickLength - 1);
882                 else
883                         IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
884                                            Client_ID(Client), Nick);
885                 return false;
886         }
887
888         if (Client_Type(Client) != CLIENT_SERVER
889             && Client_Type(Client) != CLIENT_SERVICE) {
890                 /* Make sure that this isn't a restricted/forbidden nick name */
891                 if (Conf_NickIsBlocked(Nick)) {
892                         IRC_WriteStrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
893                                            Client_ID(Client), Nick);
894                         return false;
895                 }
896         }
897
898         /* Nickname already registered? */
899         if (Client_Search(Nick)) {
900                 IRC_WriteStrClient(Client, ERR_NICKNAMEINUSE_MSG,
901                         Client_ID(Client), Nick);
902                 return false;
903         }
904
905         return true;
906 } /* Client_CheckNick */
907
908
909 GLOBAL bool
910 Client_CheckID( CLIENT *Client, char *ID )
911 {
912         char str[COMMAND_LEN];
913         CLIENT *c;
914
915         assert( Client != NULL );
916         assert( Client->conn_id > NONE );
917         assert( ID != NULL );
918
919         /* ID too long? */
920         if (strlen(ID) > CLIENT_ID_LEN) {
921                 IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID(Client), ID);
922                 return false;
923         }
924
925         /* ID already in use? */
926         c = My_Clients;
927         while (c) {
928                 if (strcasecmp(c->id, ID) == 0) {
929                         snprintf(str, sizeof(str), "ID \"%s\" already registered", ID);
930                         if (c->conn_id != NONE)
931                                 Log(LOG_ERR, "%s (on connection %d)!", str, c->conn_id);
932                         else
933                                 Log(LOG_ERR, "%s (via network)!", str);
934                         Conn_Close(Client->conn_id, str, str, true);
935                         return false;
936                 }
937                 c = (CLIENT *)c->next;
938         }
939
940         return true;
941 } /* Client_CheckID */
942
943
944 GLOBAL CLIENT *
945 Client_First( void )
946 {
947         return My_Clients;
948 } /* Client_First */
949
950
951 GLOBAL CLIENT *
952 Client_Next( CLIENT *c )
953 {
954         assert( c != NULL );
955         return (CLIENT *)c->next;
956 } /* Client_Next */
957
958
959 GLOBAL long
960 Client_UserCount( void )
961 {
962         return Count( CLIENT_USER );
963 } /* Client_UserCount */
964
965
966 GLOBAL long
967 Client_ServiceCount( void )
968 {
969         return Count( CLIENT_SERVICE );;
970 } /* Client_ServiceCount */
971
972
973 GLOBAL long
974 Client_ServerCount( void )
975 {
976         return Count( CLIENT_SERVER );
977 } /* Client_ServerCount */
978
979
980 GLOBAL long
981 Client_MyUserCount( void )
982 {
983         return MyCount( CLIENT_USER );
984 } /* Client_MyUserCount */
985
986
987 GLOBAL long
988 Client_MyServiceCount( void )
989 {
990         return MyCount( CLIENT_SERVICE );
991 } /* Client_MyServiceCount */
992
993
994 GLOBAL unsigned long
995 Client_MyServerCount( void )
996 {
997         CLIENT *c;
998         unsigned long cnt = 0;
999
1000         c = My_Clients;
1001         while( c )
1002         {
1003                 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
1004                 c = (CLIENT *)c->next;
1005         }
1006         return cnt;
1007 } /* Client_MyServerCount */
1008
1009
1010 GLOBAL unsigned long
1011 Client_OperCount( void )
1012 {
1013         CLIENT *c;
1014         unsigned long cnt = 0;
1015
1016         c = My_Clients;
1017         while( c )
1018         {
1019                 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
1020                 c = (CLIENT *)c->next;
1021         }
1022         return cnt;
1023 } /* Client_OperCount */
1024
1025
1026 GLOBAL unsigned long
1027 Client_UnknownCount( void )
1028 {
1029         CLIENT *c;
1030         unsigned long cnt = 0;
1031
1032         c = My_Clients;
1033         while( c )
1034         {
1035                 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
1036                 c = (CLIENT *)c->next;
1037         }
1038
1039         return cnt;
1040 } /* Client_UnknownCount */
1041
1042
1043 GLOBAL long
1044 Client_MaxUserCount( void )
1045 {
1046         return Max_Users;
1047 } /* Client_MaxUserCount */
1048
1049
1050 GLOBAL long
1051 Client_MyMaxUserCount( void )
1052 {
1053         return My_Max_Users;
1054 } /* Client_MyMaxUserCount */
1055
1056
1057 /**
1058  * Check that a given nickname is valid.
1059  *
1060  * @param       Nick the nickname to check.
1061  * @returns     true if nickname is valid, false otherwise.
1062  */
1063 GLOBAL bool
1064 Client_IsValidNick(const char *Nick)
1065 {
1066         const char *ptr;
1067         static const char goodchars[] = ";0123456789-";
1068
1069         assert (Nick != NULL);
1070
1071         if (strchr(goodchars, Nick[0]))
1072                 return false;
1073         if (strlen(Nick ) >= Conf_MaxNickLength)
1074                 return false;
1075
1076         ptr = Nick;
1077         while (*ptr) {
1078                 if (*ptr < 'A' && !strchr(goodchars, *ptr ))
1079                         return false;
1080                 if (*ptr > '}')
1081                         return false;
1082                 ptr++;
1083         }
1084
1085         return true;
1086 } /* Client_IsValidNick */
1087
1088
1089 /**
1090  * Return pointer to "My_Whowas" structure.
1091  */
1092 GLOBAL WHOWAS *
1093 Client_GetWhowas( void )
1094 {
1095         return My_Whowas;
1096 } /* Client_GetWhowas */
1097
1098 /**
1099  * Return the index of the last used WHOWAS entry.
1100  */
1101 GLOBAL int
1102 Client_GetLastWhowasIndex( void )
1103 {
1104         return Last_Whowas;
1105 } /* Client_GetLastWhowasIndex */
1106
1107
1108 /**
1109  * Get the start time of this client.
1110  * The result is the start time in seconds since 1970-01-01, as reported
1111  * by the C function time(NULL).
1112  */
1113 GLOBAL time_t
1114 Client_StartTime(CLIENT *Client)
1115 {
1116         assert( Client != NULL );
1117         return Client->starttime;
1118 } /* Client_Uptime */
1119
1120
1121 /**
1122  * Reject a client when logging in.
1123  *
1124  * This function is called when a client isn't allowed to connect to this
1125  * server. Possible reasons are bad server password, bad PAM password,
1126  * or that the client is G/K-Line'd.
1127  *
1128  * After calling this function, the client isn't connected any more.
1129  *
1130  * @param Client The client to reject.
1131  * @param Reason The reason why the client has been rejected.
1132  * @param InformClient If true, send the exact reason to the client.
1133  */
1134 GLOBAL void
1135 Client_Reject(CLIENT *Client, const char *Reason, bool InformClient)
1136 {
1137         char info[COMMAND_LEN];
1138
1139         assert(Client != NULL);
1140         assert(Reason != NULL);
1141
1142         if (InformClient)
1143                 snprintf(info, sizeof(info), "Access denied: %s", Reason);
1144         else
1145                 strcpy(info, "Access denied: Bad password?");
1146
1147         Log(LOG_ERR,
1148             "User \"%s\" rejected (connection %d): %s!",
1149             Client_Mask(Client), Client_Conn(Client), Reason);
1150         Conn_Close(Client_Conn(Client), Reason, info, true);
1151 }
1152
1153
1154 /**
1155  * Introduce a new user or service client in the network.
1156  *
1157  * @param From Remote server introducing the client or NULL (local).
1158  * @param Client New client.
1159  * @param Type Type of the client (CLIENT_USER or CLIENT_SERVICE).
1160  */
1161 GLOBAL void
1162 Client_Introduce(CLIENT *From, CLIENT *Client, int Type)
1163 {
1164         /* Set client type (user or service) */
1165         Client_SetType(Client, Type);
1166
1167         if (From) {
1168                 if (Conf_NickIsService(Conf_GetServer(Client_Conn(From)),
1169                                    Client_ID(Client)))
1170                         Client_SetType(Client, CLIENT_SERVICE);
1171                 LogDebug("%s \"%s\" (+%s) registered (via %s, on %s, %d hop%s).",
1172                          Client_TypeText(Client), Client_Mask(Client),
1173                          Client_Modes(Client), Client_ID(From),
1174                          Client_ID(Client_Introducer(Client)),
1175                          Client_Hops(Client), Client_Hops(Client) > 1 ? "s": "");
1176         } else {
1177                 Log(LOG_NOTICE, "%s \"%s\" registered (connection %d).",
1178                     Client_TypeText(Client), Client_Mask(Client),
1179                     Client_Conn(Client));
1180                 Log_ServerNotice('c', "Client connecting: %s (%s@%s) [%s] - %s",
1181                                  Client_ID(Client), Client_User(Client),
1182                                  Client_Hostname(Client),
1183                                  Conn_IPA(Client_Conn(Client)),
1184                                  Client_TypeText(Client));
1185         }
1186
1187         /* Inform other servers */
1188         IRC_WriteStrServersPrefixFlag_CB(From,
1189                                 From != NULL ? From : Client_ThisServer(),
1190                                 '\0', cb_introduceClient, (void *)Client);
1191 } /* Client_Introduce */
1192
1193
1194 static unsigned long
1195 Count( CLIENT_TYPE Type )
1196 {
1197         CLIENT *c;
1198         unsigned long cnt = 0;
1199
1200         c = My_Clients;
1201         while( c )
1202         {
1203                 if( c->type == Type ) cnt++;
1204                 c = (CLIENT *)c->next;
1205         }
1206         return cnt;
1207 } /* Count */
1208
1209
1210 static unsigned long
1211 MyCount( CLIENT_TYPE Type )
1212 {
1213         CLIENT *c;
1214         unsigned long cnt = 0;
1215
1216         c = My_Clients;
1217         while( c )
1218         {
1219                 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
1220                 c = (CLIENT *)c->next;
1221         }
1222         return cnt;
1223 } /* MyCount */
1224
1225
1226 static CLIENT *
1227 New_Client_Struct( void )
1228 {
1229         /* Neue CLIENT-Struktur pre-initialisieren */
1230
1231         CLIENT *c;
1232
1233         c = (CLIENT *)malloc( sizeof( CLIENT ));
1234         if( ! c )
1235         {
1236                 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1237                 return NULL;
1238         }
1239
1240         memset( c, 0, sizeof ( CLIENT ));
1241
1242         c->type = CLIENT_UNKNOWN;
1243         c->conn_id = NONE;
1244         c->oper_by_me = false;
1245         c->hops = -1;
1246         c->token = -1;
1247         c->mytoken = -1;
1248
1249         return c;
1250 } /* New_Client */
1251
1252
1253 static void
1254 Generate_MyToken( CLIENT *Client )
1255 {
1256         CLIENT *c;
1257         int token;
1258
1259         c = My_Clients;
1260         token = 2;
1261         while( c )
1262         {
1263                 if( c->mytoken == token )
1264                 {
1265                         /* Das Token wurde bereits vergeben */
1266                         token++;
1267                         c = My_Clients;
1268                         continue;
1269                 }
1270                 else c = (CLIENT *)c->next;
1271         }
1272         Client->mytoken = token;
1273         LogDebug("Assigned token %d to server \"%s\".", token, Client->id);
1274 } /* Generate_MyToken */
1275
1276
1277 static void
1278 Adjust_Counters( CLIENT *Client )
1279 {
1280         long count;
1281
1282         assert( Client != NULL );
1283
1284         if( Client->type != CLIENT_USER ) return;
1285
1286         if( Client->conn_id != NONE )
1287         {
1288                 /* Local connection */
1289                 count = Client_MyUserCount( );
1290                 if( count > My_Max_Users ) My_Max_Users = count;
1291         }
1292         count = Client_UserCount( );
1293         if( count > Max_Users ) Max_Users = count;
1294 } /* Adjust_Counters */
1295
1296
1297 /**
1298  * Register client in My_Whowas structure for further recall by WHOWAS.
1299  * Note: Only clients that have been connected at least 30 seconds will be
1300  * registered to prevent automated IRC bots to "destroy" a nice server
1301  * history database.
1302  */
1303 GLOBAL void
1304 Client_RegisterWhowas( CLIENT *Client )
1305 {
1306         int slot;
1307         time_t now;
1308
1309         assert( Client != NULL );
1310
1311         /* Don't register WHOWAS information when "MorePrivacy" is enabled. */
1312         if (Conf_MorePrivacy)
1313                 return;
1314
1315         now = time(NULL);
1316         /* Don't register clients that were connected less than 30 seconds. */
1317         if( now - Client->starttime < 30 )
1318                 return;
1319
1320         slot = Last_Whowas + 1;
1321         if( slot >= MAX_WHOWAS || slot < 0 ) slot = 0;
1322
1323 #ifdef DEBUG
1324         Log( LOG_DEBUG, "Saving WHOWAS information to slot %d ...", slot );
1325 #endif
1326
1327         My_Whowas[slot].time = now;
1328         strlcpy( My_Whowas[slot].id, Client_ID( Client ),
1329                  sizeof( My_Whowas[slot].id ));
1330         strlcpy( My_Whowas[slot].user, Client_User( Client ),
1331                  sizeof( My_Whowas[slot].user ));
1332         strlcpy( My_Whowas[slot].host, Client_HostnameCloaked( Client ),
1333                  sizeof( My_Whowas[slot].host ));
1334         strlcpy( My_Whowas[slot].info, Client_Info( Client ),
1335                  sizeof( My_Whowas[slot].info ));
1336         strlcpy( My_Whowas[slot].server, Client_ID( Client_Introducer( Client )),
1337                  sizeof( My_Whowas[slot].server ));
1338
1339         Last_Whowas = slot;
1340 } /* Client_RegisterWhowas */
1341
1342
1343 GLOBAL const char *
1344 Client_TypeText(CLIENT *Client)
1345 {
1346         assert(Client != NULL);
1347         switch (Client_Type(Client)) {
1348                 case CLIENT_USER:
1349                         return "User";
1350                         break;
1351                 case CLIENT_SERVICE:
1352                         return "Service";
1353                         break;
1354                 case CLIENT_SERVER:
1355                         return "Server";
1356                         break;
1357                 default:
1358                         return "Client";
1359         }
1360 } /* Client_TypeText */
1361
1362
1363 /**
1364  * Destroy user or service client.
1365  */
1366 static void
1367 Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool SendQuit)
1368 {
1369         if(Client->conn_id != NONE) {
1370                 /* Local (directly connected) client */
1371                 Log(LOG_NOTICE,
1372                     "%s \"%s\" unregistered (connection %d): %s",
1373                     Client_TypeText(Client), Client_Mask(Client),
1374                     Client->conn_id, Txt);
1375                 Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
1376                                  Client_ID(Client), Client_User(Client),
1377                                  Client_Hostname(Client), Txt);
1378
1379                 if (SendQuit) {
1380                         /* Inforam all the other servers */
1381                         if (FwdMsg)
1382                                 IRC_WriteStrServersPrefix(NULL,
1383                                                 Client, "QUIT :%s", FwdMsg );
1384                         else
1385                                 IRC_WriteStrServersPrefix(NULL,
1386                                                 Client, "QUIT :");
1387                 }
1388         } else {
1389                 /* Remote client */
1390                 LogDebug("%s \"%s\" unregistered: %s",
1391                          Client_TypeText(Client), Client_Mask(Client), Txt);
1392
1393                 if(SendQuit) {
1394                         /* Inform all the other servers, but the ones in the
1395                          * direction we got the QUIT from */
1396                         if(FwdMsg)
1397                                 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1398                                                 Client, "QUIT :%s", FwdMsg );
1399                         else
1400                                 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1401                                                 Client, "QUIT :" );
1402                 }
1403         }
1404
1405         /* Unregister client from channels */
1406         Channel_Quit(Client, FwdMsg ? FwdMsg : Client->id);
1407
1408         /* Register client in My_Whowas structure */
1409         Client_RegisterWhowas(Client);
1410 } /* Destroy_UserOrService */
1411
1412
1413 /**
1414  * Introduce a new user or service client to a remote server.
1415  *
1416  * This function differentiates between RFC1459 and RFC2813 server links and
1417  * generates the appropriate commands to register the new user or service.
1418  *
1419  * @param To            The remote server to inform.
1420  * @param Prefix        Prefix for the generated commands.
1421  * @param data          CLIENT structure of the new client.
1422  */
1423 static void
1424 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
1425 {
1426         CLIENT *c = (CLIENT *)data;
1427         CONN_ID conn;
1428         char *modes, *user, *host;
1429
1430         modes = Client_Modes(c);
1431         user = Client_User(c) ? Client_User(c) : "-";
1432         host = Client_Hostname(c) ? Client_Hostname(c) : "-";
1433
1434         conn = Client_Conn(To);
1435         if (Conn_Options(conn) & CONN_RFC1459) {
1436                 /* RFC 1459 mode: separate NICK and USER commands */
1437                 Conn_WriteStr(conn, "NICK %s :%d", Client_ID(c),
1438                               Client_Hops(c) + 1);
1439                 Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
1440                               Client_ID(c), user, host,
1441                               Client_ID(Client_Introducer(c)), Client_Info(c));
1442                 if (modes[0])
1443                         Conn_WriteStr(conn, ":%s MODE %s +%s",
1444                                       Client_ID(c), Client_ID(c), modes);
1445         } else {
1446                 /* RFC 2813 mode: one combined NICK or SERVICE command */
1447                 if (Client_Type(c) == CLIENT_SERVICE
1448                     && strchr(Client_Flags(To), 'S'))
1449                         IRC_WriteStrClientPrefix(To, Prefix,
1450                                                  "SERVICE %s %d * +%s %d :%s",
1451                                                  Client_Mask(c),
1452                                                  Client_MyToken(Client_Introducer(c)),
1453                                                  Client_Modes(c), Client_Hops(c) + 1,
1454                                                  Client_Info(c));
1455                 else
1456                         IRC_WriteStrClientPrefix(To, Prefix,
1457                                                  "NICK %s %d %s %s %d +%s :%s",
1458                                                  Client_ID(c), Client_Hops(c) + 1,
1459                                                  user, host,
1460                                                  Client_MyToken(Client_Introducer(c)),
1461                                                  modes, Client_Info(c));
1462         }
1463 } /* cb_introduceClient */
1464
1465
1466 #ifdef DEBUG
1467
1468 GLOBAL void
1469 Client_DebugDump(void)
1470 {
1471         CLIENT *c;
1472
1473         Log(LOG_DEBUG, "Client status:");
1474         c = My_Clients;
1475         while (c) {
1476                 Log(LOG_DEBUG,
1477                     " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
1478                    Client_ID(c), Client_Type(c), Client_Hostname(c),
1479                    Client_User(c), Client_Conn(c), Client_StartTime(c),
1480                    Client_Flags(c));
1481                 c = (CLIENT *)c->next;
1482         }
1483 } /* Client_DumpClients */
1484
1485 #endif
1486
1487
1488 /* -eof- */