2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
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.
20 static char UNUSED id[] = "$Id: client.c,v 1.78 2005/03/19 18:43:48 fw Exp $";
42 #include "irc-write.h"
49 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
52 LOCAL CLIENT *This_Server, *My_Clients;
53 LOCAL char GetID_Buffer[GETID_LEN];
56 LOCAL long Count PARAMS(( CLIENT_TYPE Type ));
57 LOCAL long MyCount PARAMS(( CLIENT_TYPE Type ));
59 LOCAL CLIENT *New_Client_Struct PARAMS(( void ));
60 LOCAL void Generate_MyToken PARAMS(( CLIENT *Client ));
61 LOCAL void Adjust_Counters PARAMS(( CLIENT *Client ));
63 #ifndef Client_DestroyNow
64 GLOBAL void Client_DestroyNow PARAMS((CLIENT *Client ));
68 long Max_Users = 0, My_Max_Users = 0;
76 This_Server = New_Client_Struct( );
79 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
80 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
84 /* Client-Struktur dieses Servers */
85 This_Server->next = NULL;
86 This_Server->type = CLIENT_SERVER;
87 This_Server->conn_id = NONE;
88 This_Server->introducer = This_Server;
89 This_Server->mytoken = 1;
90 This_Server->hops = 0;
92 gethostname( This_Server->host, CLIENT_HOST_LEN );
93 h = gethostbyname( This_Server->host );
94 if( h ) strlcpy( This_Server->host, h->h_name, sizeof( This_Server->host ));
96 Client_SetID( This_Server, Conf_ServerName );
97 Client_SetInfo( This_Server, Conf_ServerInfo );
99 My_Clients = This_Server;
109 if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, false );
110 else Client_Destroy( This_Server, "Server going down.", NULL, false );
117 next = (CLIENT *)c->next;
121 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
126 Client_ThisServer( void )
129 } /* Client_ThisServer */
133 Client_NewLocal( CONN_ID Idx, char *Hostname, int Type, bool Idented )
135 /* Neuen lokalen Client erzeugen: Wrapper-Funktion fuer Client_New(). */
136 return Client_New( Idx, This_Server, NULL, Type, NULL, NULL, Hostname, NULL, 0, 0, NULL, Idented );
137 } /* Client_NewLocal */
141 Client_NewRemoteServer( CLIENT *Introducer, char *Hostname, CLIENT *TopServer, int Hops, int Token, char *Info, bool Idented )
143 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
144 return Client_New( NONE, Introducer, TopServer, CLIENT_SERVER, Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented );
145 } /* Client_NewRemoteServer */
149 Client_NewRemoteUser( CLIENT *Introducer, char *Nick, int Hops, char *User, char *Hostname, int Token, char *Modes, char *Info, bool Idented )
151 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
152 return Client_New( NONE, Introducer, NULL, CLIENT_USER, Nick, User, Hostname, Info, Hops, Token, Modes, Idented );
153 } /* Client_NewRemoteUser */
157 Client_New( CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer, int Type, char *ID, char *User, char *Hostname, char *Info, int Hops, int Token, char *Modes, bool Idented )
161 assert( Idx >= NONE );
162 assert( Introducer != NULL );
163 assert( Hostname != NULL );
165 client = New_Client_Struct( );
166 if( ! client ) return NULL;
169 client->conn_id = Idx;
170 client->introducer = Introducer;
171 client->topserver = TopServer;
173 if( ID ) Client_SetID( client, ID );
174 if( User ) Client_SetUser( client, User, Idented );
175 if( Hostname ) Client_SetHostname( client, Hostname );
176 if( Info ) Client_SetInfo( client, Info );
178 client->token = Token;
179 if( Modes ) Client_SetModes( client, Modes );
180 if( Type == CLIENT_SERVER ) Generate_MyToken( client );
182 /* ist der User away? */
183 if( strchr( client->modes, 'a' )) strlcpy( client->away, DEFAULT_AWAY_MSG, sizeof( client->away ));
186 client->next = (POINTER *)My_Clients;
189 /* Adjust counters */
190 Adjust_Counters( client );
197 Client_Destroy( CLIENT *Client, char *LogMsg, char *FwdMsg, bool SendQuit )
199 /* Client entfernen. */
202 char msg[LINE_LEN], *txt;
204 assert( Client != NULL );
206 if( LogMsg ) txt = LogMsg;
208 if( ! txt ) txt = "Reason unknown.";
210 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
211 if( Client->type == CLIENT_SERVER ) snprintf( msg, sizeof( msg ), "%s: lost server %s", This_Server->id, Client->id );
217 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
219 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
220 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
221 Client_Destroy( c, NULL, msg, false );
228 /* Wir haben den Client gefunden: entfernen */
229 if( last ) last->next = c->next;
230 else My_Clients = (CLIENT *)c->next;
232 if( c->type == CLIENT_USER )
234 if( c->conn_id != NONE )
236 /* Ein lokaler User */
237 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
241 /* Alle andere Server informieren! */
242 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
243 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
249 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
253 /* Andere Server informieren, ausser denen, die "in
254 * Richtung dem liegen", auf dem der User registriert
255 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
256 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
257 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
260 Channel_Quit( c, FwdMsg ? FwdMsg : c->id );
262 else if( c->type == CLIENT_SERVER )
264 if( c != This_Server )
266 if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
267 else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
270 /* andere Server informieren */
271 if( ! NGIRCd_SignalQuit )
273 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
274 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
279 if( c->conn_id != NONE )
281 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
282 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
286 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
287 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
295 c = (CLIENT *)c->next;
297 } /* Client_Destroy */
301 Client_DestroyNow( CLIENT *Client )
303 /* Destroy client structure immediately. This function is only
304 * intended for the connection layer to remove client structures
305 * of connections that can't be established! */
309 assert( Client != NULL );
317 /* Wir haben den Client gefunden: entfernen */
318 if( last ) last->next = c->next;
319 else My_Clients = (CLIENT *)c->next;
324 c = (CLIENT *)c->next;
326 } /* Client_DestroyNow */
330 Client_SetHostname( CLIENT *Client, char *Hostname )
332 /* Hostname eines Clients setzen */
334 assert( Client != NULL );
335 assert( Hostname != NULL );
337 strlcpy( Client->host, Hostname, sizeof( Client->host ));
338 } /* Client_SetHostname */
342 Client_SetID( CLIENT *Client, char *ID )
344 /* Hostname eines Clients setzen, Hash-Wert berechnen */
346 assert( Client != NULL );
347 assert( ID != NULL );
349 strlcpy( Client->id, ID, sizeof( Client->id ));
352 Client->hash = Hash( Client->id );
357 Client_SetUser( CLIENT *Client, char *User, bool Idented )
359 /* Username eines Clients setzen */
361 assert( Client != NULL );
362 assert( User != NULL );
364 if( Idented ) strlcpy( Client->user, User, sizeof( Client->user ));
367 Client->user[0] = '~';
368 strlcpy( Client->user + 1, User, sizeof( Client->user ) - 1 );
370 } /* Client_SetUser */
374 Client_SetInfo( CLIENT *Client, char *Info )
376 /* Hostname eines Clients setzen */
378 assert( Client != NULL );
379 assert( Info != NULL );
381 strlcpy( Client->info, Info, sizeof( Client->info ));
382 } /* Client_SetInfo */
386 Client_SetModes( CLIENT *Client, char *Modes )
388 /* Modes eines Clients setzen */
390 assert( Client != NULL );
391 assert( Modes != NULL );
393 strlcpy( Client->modes, Modes, sizeof( Client->modes ));
394 } /* Client_SetModes */
398 Client_SetFlags( CLIENT *Client, char *Flags )
400 /* Flags eines Clients setzen */
402 assert( Client != NULL );
403 assert( Flags != NULL );
405 strlcpy( Client->flags, Flags, sizeof( Client->flags ));
406 } /* Client_SetFlags */
410 Client_SetPassword( CLIENT *Client, char *Pwd )
412 /* Von einem Client geliefertes Passwort */
414 assert( Client != NULL );
415 assert( Pwd != NULL );
417 strlcpy( Client->pwd, Pwd, sizeof( Client->pwd ));
418 } /* Client_SetPassword */
422 Client_SetAway( CLIENT *Client, char *Txt )
424 /* Set AWAY reason of client */
426 assert( Client != NULL );
427 assert( Txt != NULL );
429 strlcpy( Client->away, Txt, sizeof( Client->away ));
430 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
431 } /* Client_SetAway */
435 Client_SetType( CLIENT *Client, int Type )
437 assert( Client != NULL );
439 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
440 Adjust_Counters( Client );
441 } /* Client_SetType */
445 Client_SetHops( CLIENT *Client, int Hops )
447 assert( Client != NULL );
449 } /* Client_SetHops */
453 Client_SetToken( CLIENT *Client, int Token )
455 assert( Client != NULL );
456 Client->token = Token;
457 } /* Client_SetToken */
461 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
463 assert( Client != NULL );
464 assert( Introducer != NULL );
465 Client->introducer = Introducer;
466 } /* Client_SetIntroducer */
470 Client_SetOperByMe( CLIENT *Client, bool OperByMe )
472 assert( Client != NULL );
473 Client->oper_by_me = OperByMe;
474 } /* Client_SetOperByMe */
478 Client_ModeAdd( CLIENT *Client, char Mode )
481 * If Client already alread had Mode, return false.
482 * If the Mode was newly set, return true.
487 assert( Client != NULL );
489 x[0] = Mode; x[1] = '\0';
490 if( ! strchr( Client->modes, x[0] ))
492 /* Client hat den Mode noch nicht -> setzen */
493 strlcat( Client->modes, x, sizeof( Client->modes ));
497 } /* Client_ModeAdd */
501 Client_ModeDel( CLIENT *Client, char Mode )
504 * If Mode was removed, return true.
505 * If Client did not have Mode, return false.
510 assert( Client != NULL );
512 x[0] = Mode; x[1] = '\0';
514 p = strchr( Client->modes, x[0] );
515 if( ! p ) return false;
517 /* Client has Mode -> delete */
524 } /* Client_ModeDel */
528 Client_GetFromConn( CONN_ID Idx )
530 /* return Client-Structure that belongs to the local Connection Idx gehoert.
531 * If none is found, return NULL.
541 if( c->conn_id == Idx ) return c;
542 c = (CLIENT *)c->next;
545 } /* Client_GetFromConn */
549 Client_Search( char *Nick )
551 /* return Client-Structure that has the corresponding Nick.
552 * If none is found, return NULL.
555 char search_id[CLIENT_ID_LEN], *ptr;
559 assert( Nick != NULL );
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';
566 search_hash = Hash( search_id );
571 if( c->hash == search_hash )
573 /* lt. Hash-Wert: Treffer! */
574 if( strcasecmp( c->id, search_id ) == 0 ) return c;
576 c = (CLIENT *)c->next;
579 } /* Client_Search */
583 Client_GetFromToken( CLIENT *Client, int Token )
585 /* Client-Struktur, die den entsprechenden Introducer (=Client)
586 * und das gegebene Token hat, liefern. Wird keine gefunden,
587 * so wird NULL geliefert. */
591 assert( Client != NULL );
597 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
598 c = (CLIENT *)c->next;
601 } /* Client_GetFromToken */
605 Client_Type( CLIENT *Client )
607 assert( Client != NULL );
613 Client_Conn( CLIENT *Client )
615 assert( Client != NULL );
616 return Client->conn_id;
621 Client_ID( CLIENT *Client )
623 assert( Client != NULL );
626 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
629 if( Client->id[0] ) return Client->id;
635 Client_Info( CLIENT *Client )
637 assert( Client != NULL );
643 Client_User( CLIENT *Client )
645 assert( Client != NULL );
646 if( Client->user[0] ) return Client->user;
652 Client_Hostname( CLIENT *Client )
654 assert( Client != NULL );
656 } /* Client_Hostname */
660 Client_Password( CLIENT *Client )
662 assert( Client != NULL );
664 } /* Client_Password */
668 Client_Modes( CLIENT *Client )
670 assert( Client != NULL );
671 return Client->modes;
676 Client_Flags( CLIENT *Client )
678 assert( Client != NULL );
679 return Client->flags;
684 Client_OperByMe( CLIENT *Client )
686 assert( Client != NULL );
687 return Client->oper_by_me;
688 } /* Client_OperByMe */
692 Client_Hops( CLIENT *Client )
694 assert( Client != NULL );
700 Client_Token( CLIENT *Client )
702 assert( Client != NULL );
703 return Client->token;
708 Client_MyToken( CLIENT *Client )
710 assert( Client != NULL );
711 return Client->mytoken;
712 } /* Client_MyToken */
716 Client_NextHop( CLIENT *Client )
720 assert( Client != NULL );
723 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
725 } /* Client_NextHop */
729 Client_Mask( CLIENT *Client )
731 /* Client-"ID" liefern, wie sie z.B. fuer
732 * Prefixe benoetigt wird. */
734 assert( Client != NULL );
736 if( Client->type == CLIENT_SERVER ) return Client->id;
738 snprintf( GetID_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user, Client->host );
744 Client_Introducer( CLIENT *Client )
746 assert( Client != NULL );
747 return Client->introducer;
748 } /* Client_Introducer */
752 Client_TopServer( CLIENT *Client )
754 assert( Client != NULL );
755 return Client->topserver;
756 } /* Client_TopServer */
760 Client_HasMode( CLIENT *Client, char Mode )
762 assert( Client != NULL );
763 return strchr( Client->modes, Mode ) != NULL;
764 } /* Client_HasMode */
768 Client_Away( CLIENT *Client )
770 /* AWAY-Text liefern */
772 assert( Client != NULL );
778 Client_CheckNick( CLIENT *Client, char *Nick )
780 /* Nick ueberpruefen */
782 assert( Client != NULL );
783 assert( Nick != NULL );
785 /* Nick ungueltig? */
786 if( ! Client_IsValidNick( Nick ))
788 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
792 /* Nick bereits vergeben? */
793 if( Client_Search( Nick ))
795 /* den Nick gibt es bereits */
796 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
801 } /* Client_CheckNick */
805 Client_CheckID( CLIENT *Client, char *ID )
807 /* Nick ueberpruefen */
809 char str[COMMAND_LEN];
812 assert( Client != NULL );
813 assert( Client->conn_id > NONE );
814 assert( ID != NULL );
817 if( strlen( ID ) > CLIENT_ID_LEN )
819 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
823 /* ID bereits vergeben? */
827 if( strcasecmp( c->id, ID ) == 0 )
829 /* die Server-ID gibt es bereits */
830 snprintf( str, sizeof( str ), "ID \"%s\" already registered", ID );
831 if( Client->conn_id != c->conn_id ) Log( LOG_ERR, "%s (on connection %d)!", str, c->conn_id );
832 else Log( LOG_ERR, "%s (via network)!", str );
833 Conn_Close( Client->conn_id, str, str, true);
836 c = (CLIENT *)c->next;
840 } /* Client_CheckID */
846 /* Ersten Client liefern. */
853 Client_Next( CLIENT *c )
855 /* Naechsten Client liefern. Existiert keiner,
856 * so wird NULL geliefert. */
859 return (CLIENT *)c->next;
864 Client_UserCount( void )
866 return Count( CLIENT_USER );
867 } /* Client_UserCount */
871 Client_ServiceCount( void )
873 return Count( CLIENT_SERVICE );;
874 } /* Client_ServiceCount */
878 Client_ServerCount( void )
880 return Count( CLIENT_SERVER );
881 } /* Client_ServerCount */
885 Client_MyUserCount( void )
887 return MyCount( CLIENT_USER );
888 } /* Client_MyUserCount */
892 Client_MyServiceCount( void )
894 return MyCount( CLIENT_SERVICE );
895 } /* Client_MyServiceCount */
899 Client_MyServerCount( void )
908 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
909 c = (CLIENT *)c->next;
912 } /* Client_MyServerCount */
916 Client_OperCount( void )
925 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
926 c = (CLIENT *)c->next;
929 } /* Client_OperCount */
933 Client_UnknownCount( void )
942 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
943 c = (CLIENT *)c->next;
946 } /* Client_UnknownCount */
950 Client_MaxUserCount( void )
953 } /* Client_MaxUserCount */
957 Client_MyMaxUserCount( void )
960 } /* Client_MyMaxUserCount */
964 Client_IsValidNick( char *Nick )
966 /* Ist der Nick gueltig? */
968 char *ptr, goodchars[20];
970 assert( Nick != NULL );
972 strcpy( goodchars, ";0123456789-" );
974 if( Nick[0] == '#' ) return false;
975 if( strchr( goodchars, Nick[0] )) return false;
976 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return false;
981 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return false;
982 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return false;
987 } /* Client_IsValidNick */
991 Count( CLIENT_TYPE Type )
1000 if( c->type == Type ) cnt++;
1001 c = (CLIENT *)c->next;
1008 MyCount( CLIENT_TYPE Type )
1017 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
1018 c = (CLIENT *)c->next;
1025 New_Client_Struct( void )
1027 /* Neue CLIENT-Struktur pre-initialisieren */
1031 c = (CLIENT *)malloc( sizeof( CLIENT ));
1034 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1038 memset( c, 0, sizeof ( CLIENT ));
1040 c->type = CLIENT_UNKNOWN;
1042 c->oper_by_me = false;
1052 Generate_MyToken( CLIENT *Client )
1061 if( c->mytoken == token )
1063 /* Das Token wurde bereits vergeben */
1068 else c = (CLIENT *)c->next;
1070 Client->mytoken = token;
1071 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
1072 } /* Generate_MyToken */
1076 Adjust_Counters( CLIENT *Client )
1080 assert( Client != NULL );
1082 if( Client->type != CLIENT_USER ) return;
1084 if( Client->conn_id != NONE )
1086 /* Local connection */
1087 count = Client_MyUserCount( );
1088 if( count > My_Max_Users ) My_Max_Users = count;
1090 count = Client_UserCount( );
1091 if( count > Max_Users ) Max_Users = count;
1092 } /* Adjust_Counters */