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.70 2002/12/26 17:04:54 alex Exp $";
41 #include "irc-write.h"
48 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
51 LOCAL CLIENT *This_Server, *My_Clients;
52 LOCAL CHAR GetID_Buffer[GETID_LEN];
55 LOCAL LONG Count PARAMS(( CLIENT_TYPE Type ));
56 LOCAL LONG MyCount PARAMS(( CLIENT_TYPE Type ));
58 LOCAL CLIENT *New_Client_Struct PARAMS(( VOID ));
59 LOCAL VOID Generate_MyToken PARAMS(( CLIENT *Client ));
60 LOCAL VOID Adjust_Counters PARAMS(( CLIENT *Client ));
63 LONG Max_Users = 0, My_Max_Users = 0;
71 This_Server = New_Client_Struct( );
74 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
75 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE );
79 /* Client-Struktur dieses Servers */
80 This_Server->next = NULL;
81 This_Server->type = CLIENT_SERVER;
82 This_Server->conn_id = NONE;
83 This_Server->introducer = This_Server;
84 This_Server->mytoken = 1;
85 This_Server->hops = 0;
87 gethostname( This_Server->host, CLIENT_HOST_LEN );
88 h = gethostbyname( This_Server->host );
89 if( h ) strlcpy( This_Server->host, h->h_name, sizeof( This_Server->host ));
91 Client_SetID( This_Server, Conf_ServerName );
92 Client_SetInfo( This_Server, Conf_ServerInfo );
94 My_Clients = This_Server;
104 if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, FALSE );
105 else Client_Destroy( This_Server, "Server going down.", NULL, FALSE );
112 next = (CLIENT *)c->next;
116 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
121 Client_ThisServer( VOID )
124 } /* Client_ThisServer */
128 Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented )
130 /* Neuen lokalen Client erzeugen: Wrapper-Funktion fuer Client_New(). */
131 return Client_New( Idx, This_Server, NULL, Type, NULL, NULL, Hostname, NULL, 0, 0, NULL, Idented );
132 } /* Client_NewLocal */
136 Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented )
138 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
139 return Client_New( NONE, Introducer, TopServer, CLIENT_SERVER, Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented );
140 } /* Client_NewRemoteServer */
144 Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented )
146 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
147 return Client_New( NONE, Introducer, NULL, CLIENT_USER, Nick, User, Hostname, Info, Hops, Token, Modes, Idented );
148 } /* Client_NewRemoteUser */
152 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, BOOLEAN Idented )
156 assert( Idx >= NONE );
157 assert( Introducer != NULL );
158 assert( Hostname != NULL );
160 client = New_Client_Struct( );
161 if( ! client ) return NULL;
164 client->conn_id = Idx;
165 client->introducer = Introducer;
166 client->topserver = TopServer;
168 if( ID ) Client_SetID( client, ID );
169 if( User ) Client_SetUser( client, User, Idented );
170 if( Hostname ) Client_SetHostname( client, Hostname );
171 if( Info ) Client_SetInfo( client, Info );
173 client->token = Token;
174 if( Modes ) Client_SetModes( client, Modes );
175 if( Type == CLIENT_SERVER ) Generate_MyToken( client );
177 /* ist der User away? */
178 if( strchr( client->modes, 'a' )) strlcpy( client->away, DEFAULT_AWAY_MSG, sizeof( client->away ));
181 client->next = (POINTER *)My_Clients;
184 /* Adjust counters */
185 Adjust_Counters( client );
192 Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit )
194 /* Client entfernen. */
197 CHAR msg[LINE_LEN], *txt;
199 assert( Client != NULL );
201 if( LogMsg ) txt = LogMsg;
203 if( ! txt ) txt = "Reason unknown.";
205 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
206 if( Client->type == CLIENT_SERVER ) sprintf( msg, "%s: lost server %s", This_Server->id, Client->id );
212 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
214 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
215 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
216 Client_Destroy( c, NULL, msg, FALSE );
223 /* Wir haben den Client gefunden: entfernen */
224 if( last ) last->next = c->next;
225 else My_Clients = (CLIENT *)c->next;
227 if( c->type == CLIENT_USER )
229 if( c->conn_id != NONE )
231 /* Ein lokaler User */
232 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
236 /* Alle andere Server informieren! */
237 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
238 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
244 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
248 /* Andere Server informieren, ausser denen, die "in
249 * Richtung dem liegen", auf dem der User registriert
250 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
251 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
252 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
255 Channel_Quit( c, FwdMsg ? FwdMsg : c->id );
257 else if( c->type == CLIENT_SERVER )
259 if( c != This_Server )
261 if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
262 else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
265 /* andere Server informieren */
266 if( ! NGIRCd_SignalQuit )
268 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
269 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
274 if( c->conn_id != NONE )
276 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
277 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
281 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
282 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
290 c = (CLIENT *)c->next;
292 } /* Client_Destroy */
296 Client_SetHostname( CLIENT *Client, CHAR *Hostname )
298 /* Hostname eines Clients setzen */
300 assert( Client != NULL );
301 assert( Hostname != NULL );
303 strlcpy( Client->host, Hostname, sizeof( Client->host ));
304 } /* Client_SetHostname */
308 Client_SetID( CLIENT *Client, CHAR *ID )
310 /* Hostname eines Clients setzen, Hash-Wert berechnen */
312 assert( Client != NULL );
313 assert( ID != NULL );
315 strlcpy( Client->id, ID, sizeof( Client->id ));
318 Client->hash = Hash( Client->id );
323 Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
325 /* Username eines Clients setzen */
327 assert( Client != NULL );
328 assert( User != NULL );
330 if( Idented ) strlcpy( Client->user, User, sizeof( Client->user ));
333 Client->user[0] = '~';
334 strlcpy( Client->user + 1, User, sizeof( Client->user ) - 1 );
336 } /* Client_SetUser */
340 Client_SetInfo( CLIENT *Client, CHAR *Info )
342 /* Hostname eines Clients setzen */
344 assert( Client != NULL );
345 assert( Info != NULL );
347 strlcpy( Client->info, Info, sizeof( Client->info ));
348 } /* Client_SetInfo */
352 Client_SetModes( CLIENT *Client, CHAR *Modes )
354 /* Modes eines Clients setzen */
356 assert( Client != NULL );
357 assert( Modes != NULL );
359 strlcpy( Client->modes, Modes, sizeof( Client->modes ));
360 } /* Client_SetModes */
364 Client_SetFlags( CLIENT *Client, CHAR *Flags )
366 /* Flags eines Clients setzen */
368 assert( Client != NULL );
369 assert( Flags != NULL );
371 strlcpy( Client->flags, Flags, sizeof( Client->flags ));
372 } /* Client_SetFlags */
376 Client_SetPassword( CLIENT *Client, CHAR *Pwd )
378 /* Von einem Client geliefertes Passwort */
380 assert( Client != NULL );
381 assert( Pwd != NULL );
383 strlcpy( Client->pwd, Pwd, sizeof( Client->pwd ));
384 } /* Client_SetPassword */
388 Client_SetAway( CLIENT *Client, CHAR *Txt )
390 /* Von einem Client gelieferte AWAY-Nachricht */
392 assert( Client != NULL );
396 /* Client AWAY setzen */
397 strlcpy( Client->away, Txt, sizeof( Client->away ));
398 Client_ModeAdd( Client, 'a' );
399 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
404 Client_ModeDel( Client, 'a' );
405 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
407 } /* Client_SetAway */
411 Client_SetType( CLIENT *Client, INT Type )
413 assert( Client != NULL );
415 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
416 Adjust_Counters( Client );
417 } /* Client_SetType */
421 Client_SetHops( CLIENT *Client, INT Hops )
423 assert( Client != NULL );
425 } /* Client_SetHops */
429 Client_SetToken( CLIENT *Client, INT Token )
431 assert( Client != NULL );
432 Client->token = Token;
433 } /* Client_SetToken */
437 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
439 assert( Client != NULL );
440 assert( Introducer != NULL );
441 Client->introducer = Introducer;
442 } /* Client_SetIntroducer */
446 Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
448 assert( Client != NULL );
449 Client->oper_by_me = OperByMe;
450 } /* Client_SetOperByMe */
454 Client_ModeAdd( CLIENT *Client, CHAR Mode )
456 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
457 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
462 assert( Client != NULL );
464 x[0] = Mode; x[1] = '\0';
465 if( ! strchr( Client->modes, x[0] ))
467 /* Client hat den Mode noch nicht -> setzen */
468 strlcat( Client->modes, x, sizeof( Client->modes ));
472 } /* Client_ModeAdd */
476 Client_ModeDel( CLIENT *Client, CHAR Mode )
478 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
479 * Mode entfernt wurde, FALSE, wenn der Client den Mode
480 * ueberhaupt nicht hatte. */
484 assert( Client != NULL );
486 x[0] = Mode; x[1] = '\0';
488 p = strchr( Client->modes, x[0] );
489 if( ! p ) return FALSE;
491 /* Client hat den Mode -> loeschen */
498 } /* Client_ModeDel */
502 Client_GetFromConn( CONN_ID Idx )
504 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
505 * liefern. Wird keine gefunden, so wird NULL geliefert. */
514 if( c->conn_id == Idx ) return c;
515 c = (CLIENT *)c->next;
518 } /* Client_GetFromConn */
522 Client_Search( CHAR *Nick )
524 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
525 * Wird keine gefunden, so wird NULL geliefert. */
527 CHAR search_id[CLIENT_ID_LEN], *ptr;
531 assert( Nick != NULL );
533 /* Nick kopieren und ggf. Host-Mask abschneiden */
534 strlcpy( search_id, Nick, sizeof( search_id ));
535 ptr = strchr( search_id, '!' );
536 if( ptr ) *ptr = '\0';
538 search_hash = Hash( search_id );
543 if( c->hash == search_hash )
545 /* lt. Hash-Wert: Treffer! */
546 if( strcasecmp( c->id, search_id ) == 0 ) return c;
548 c = (CLIENT *)c->next;
551 } /* Client_Search */
555 Client_GetFromToken( CLIENT *Client, INT Token )
557 /* Client-Struktur, die den entsprechenden Introducer (=Client)
558 * und das gegebene Token hat, liefern. Wird keine gefunden,
559 * so wird NULL geliefert. */
563 assert( Client != NULL );
569 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
570 c = (CLIENT *)c->next;
573 } /* Client_GetFromToken */
577 Client_Type( CLIENT *Client )
579 assert( Client != NULL );
585 Client_Conn( CLIENT *Client )
587 assert( Client != NULL );
588 return Client->conn_id;
593 Client_ID( CLIENT *Client )
595 assert( Client != NULL );
598 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
601 if( Client->id[0] ) return Client->id;
607 Client_Info( CLIENT *Client )
609 assert( Client != NULL );
615 Client_User( CLIENT *Client )
617 assert( Client != NULL );
618 if( Client->user[0] ) return Client->user;
624 Client_Hostname( CLIENT *Client )
626 assert( Client != NULL );
628 } /* Client_Hostname */
632 Client_Password( CLIENT *Client )
634 assert( Client != NULL );
636 } /* Client_Password */
640 Client_Modes( CLIENT *Client )
642 assert( Client != NULL );
643 return Client->modes;
648 Client_Flags( CLIENT *Client )
650 assert( Client != NULL );
651 return Client->flags;
656 Client_OperByMe( CLIENT *Client )
658 assert( Client != NULL );
659 return Client->oper_by_me;
660 } /* Client_OperByMe */
664 Client_Hops( CLIENT *Client )
666 assert( Client != NULL );
672 Client_Token( CLIENT *Client )
674 assert( Client != NULL );
675 return Client->token;
680 Client_MyToken( CLIENT *Client )
682 assert( Client != NULL );
683 return Client->mytoken;
684 } /* Client_MyToken */
688 Client_NextHop( CLIENT *Client )
692 assert( Client != NULL );
695 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
697 } /* Client_NextHop */
701 Client_Mask( CLIENT *Client )
703 /* Client-"ID" liefern, wie sie z.B. fuer
704 * Prefixe benoetigt wird. */
706 assert( Client != NULL );
708 if( Client->type == CLIENT_SERVER ) return Client->id;
710 snprintf( GetID_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user, Client->host );
716 Client_Introducer( CLIENT *Client )
718 assert( Client != NULL );
719 return Client->introducer;
720 } /* Client_Introducer */
724 Client_TopServer( CLIENT *Client )
726 assert( Client != NULL );
727 return Client->topserver;
728 } /* Client_TopServer */
732 Client_HasMode( CLIENT *Client, CHAR Mode )
734 assert( Client != NULL );
735 return strchr( Client->modes, Mode ) != NULL;
736 } /* Client_HasMode */
740 Client_Away( CLIENT *Client )
742 /* AWAY-Text liefern */
744 assert( Client != NULL );
750 Client_CheckNick( CLIENT *Client, CHAR *Nick )
752 /* Nick ueberpruefen */
754 assert( Client != NULL );
755 assert( Nick != NULL );
757 /* Nick ungueltig? */
758 if( ! Client_IsValidNick( Nick ))
760 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
764 /* Nick bereits vergeben? */
765 if( Client_Search( Nick ))
767 /* den Nick gibt es bereits */
768 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
773 } /* Client_CheckNick */
777 Client_CheckID( CLIENT *Client, CHAR *ID )
779 /* Nick ueberpruefen */
781 CHAR str[COMMAND_LEN];
784 assert( Client != NULL );
785 assert( Client->conn_id > NONE );
786 assert( ID != NULL );
789 if( strlen( ID ) > CLIENT_ID_LEN )
791 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
795 /* ID bereits vergeben? */
799 if( strcasecmp( c->id, ID ) == 0 )
801 /* die Server-ID gibt es bereits */
802 sprintf( str, "ID \"%s\" already registered", ID );
803 if( Client->conn_id != c->conn_id ) Log( LOG_ERR, "%s (on connection %d)!", str, c->conn_id );
804 else Log( LOG_ERR, "%s (via network)!", str );
805 Conn_Close( Client->conn_id, str, str, TRUE );
808 c = (CLIENT *)c->next;
812 } /* Client_CheckID */
818 /* Ersten Client liefern. */
825 Client_Next( CLIENT *c )
827 /* Naechsten Client liefern. Existiert keiner,
828 * so wird NULL geliefert. */
831 return (CLIENT *)c->next;
836 Client_UserCount( VOID )
838 return Count( CLIENT_USER );
839 } /* Client_UserCount */
843 Client_ServiceCount( VOID )
845 return Count( CLIENT_SERVICE );;
846 } /* Client_ServiceCount */
850 Client_ServerCount( VOID )
852 return Count( CLIENT_SERVER );
853 } /* Client_ServerCount */
857 Client_MyUserCount( VOID )
859 return MyCount( CLIENT_USER );
860 } /* Client_MyUserCount */
864 Client_MyServiceCount( VOID )
866 return MyCount( CLIENT_SERVICE );
867 } /* Client_MyServiceCount */
871 Client_MyServerCount( VOID )
880 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
881 c = (CLIENT *)c->next;
884 } /* Client_MyServerCount */
888 Client_OperCount( VOID )
897 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
898 c = (CLIENT *)c->next;
901 } /* Client_OperCount */
905 Client_UnknownCount( VOID )
914 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
915 c = (CLIENT *)c->next;
918 } /* Client_UnknownCount */
922 Client_MaxUserCount( VOID )
925 } /* Client_MaxUserCount */
929 Client_MyMaxUserCount( VOID )
932 } /* Client_MyMaxUserCount */
936 Client_IsValidNick( CHAR *Nick )
938 /* Ist der Nick gueltig? */
940 CHAR *ptr, goodchars[20];
942 assert( Nick != NULL );
944 strcpy( goodchars, ";0123456789-" );
946 if( Nick[0] == '#' ) return FALSE;
947 if( strchr( goodchars, Nick[0] )) return FALSE;
948 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
953 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
954 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
959 } /* Client_IsValidNick */
963 Count( CLIENT_TYPE Type )
972 if( c->type == Type ) cnt++;
973 c = (CLIENT *)c->next;
980 MyCount( CLIENT_TYPE Type )
989 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
990 c = (CLIENT *)c->next;
997 New_Client_Struct( VOID )
999 /* Neue CLIENT-Struktur pre-initialisieren */
1003 c = malloc( sizeof( CLIENT ));
1006 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1012 c->type = CLIENT_UNKNOWN;
1014 c->introducer = NULL;
1015 c->topserver = NULL;
1016 strcpy( c->id, "" );
1017 strcpy( c->pwd, "" );
1018 strcpy( c->host, "" );
1019 strcpy( c->user, "" );
1020 strcpy( c->info, "" );
1021 strcpy( c->modes, "" );
1022 c->oper_by_me = FALSE;
1026 strcpy( c->away, "" );
1027 strcpy( c->flags, "" );
1034 Generate_MyToken( CLIENT *Client )
1043 if( c->mytoken == token )
1045 /* Das Token wurde bereits vergeben */
1050 else c = (CLIENT *)c->next;
1052 Client->mytoken = token;
1053 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
1054 } /* Generate_MyToken */
1058 Adjust_Counters( CLIENT *Client )
1062 assert( Client != NULL );
1064 if( Client->type != CLIENT_USER ) return;
1066 if( Client->conn_id != NONE )
1068 /* Local connection */
1069 count = Client_MyUserCount( );
1070 if( count > My_Max_Users ) My_Max_Users = count;
1072 count = Client_UserCount( );
1073 if( count > Max_Users ) Max_Users = count;
1074 } /* Adjust_Counters */