2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
5 * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
6 * der GNU General Public License (GPL), wie von der Free Software Foundation
7 * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
8 * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
9 * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
10 * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
12 * $Id: client.c,v 1.62 2002/10/09 16:53:02 alex Exp $
14 * client.c: Management aller Clients
16 * Der Begriff "Client" ist in diesem Fall evtl. etwas verwirrend: Clients sind
17 * alle Verbindungen, die im gesamten(!) IRC-Netzwerk bekannt sind. Das sind IRC-
18 * Clients (User), andere Server und IRC-Services.
19 * Ueber welchen IRC-Server die Verbindung nun tatsaechlich in das Netzwerk her-
20 * gestellt wurde, muss der jeweiligen Struktur entnommen werden. Ist es dieser
21 * Server gewesen, so existiert eine entsprechende CONNECTION-Struktur.
49 #include "irc-write.h"
56 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
59 LOCAL CLIENT *This_Server, *My_Clients;
60 LOCAL CHAR GetID_Buffer[GETID_LEN];
63 LOCAL LONG Count PARAMS(( CLIENT_TYPE Type ));
64 LOCAL LONG MyCount PARAMS(( CLIENT_TYPE Type ));
66 LOCAL CLIENT *New_Client_Struct PARAMS(( VOID ));
67 LOCAL VOID Generate_MyToken PARAMS(( CLIENT *Client ));
75 This_Server = New_Client_Struct( );
78 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
79 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE );
83 /* Client-Struktur dieses Servers */
84 This_Server->next = NULL;
85 This_Server->type = CLIENT_SERVER;
86 This_Server->conn_id = NONE;
87 This_Server->introducer = This_Server;
88 This_Server->mytoken = 1;
89 This_Server->hops = 0;
91 gethostname( This_Server->host, CLIENT_HOST_LEN );
92 h = gethostbyname( This_Server->host );
93 if( h ) strcpy( This_Server->host, h->h_name );
95 Client_SetID( This_Server, Conf_ServerName );
96 Client_SetInfo( This_Server, Conf_ServerInfo );
98 My_Clients = This_Server;
108 if( NGIRCd_Restart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, FALSE );
109 else Client_Destroy( This_Server, "Server going down.", NULL, FALSE );
116 next = (CLIENT *)c->next;
120 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
125 Client_ThisServer( VOID )
128 } /* Client_ThisServer */
132 Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented )
134 /* Neuen lokalen Client erzeugen: Wrapper-Funktion fuer Client_New(). */
135 return Client_New( Idx, This_Server, NULL, Type, NULL, NULL, Hostname, NULL, 0, 0, NULL, Idented );
136 } /* Client_NewLocal */
140 Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented )
142 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
143 return Client_New( NONE, Introducer, TopServer, CLIENT_SERVER, Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented );
144 } /* Client_NewRemoteServer */
148 Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented )
150 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
151 return Client_New( NONE, Introducer, NULL, CLIENT_USER, Nick, User, Hostname, Info, Hops, Token, Modes, Idented );
152 } /* Client_NewRemoteUser */
156 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 )
160 assert( Idx >= NONE );
161 assert( Introducer != NULL );
162 assert( Hostname != NULL );
164 client = New_Client_Struct( );
165 if( ! client ) return NULL;
168 client->conn_id = Idx;
169 client->introducer = Introducer;
170 client->topserver = TopServer;
172 if( ID ) Client_SetID( client, ID );
173 if( User ) Client_SetUser( client, User, Idented );
174 if( Hostname ) Client_SetHostname( client, Hostname );
175 if( Info ) Client_SetInfo( client, Info );
177 client->token = Token;
178 if( Modes ) Client_SetModes( client, Modes );
179 if( Type == CLIENT_SERVER ) Generate_MyToken( client );
181 /* ist der User away? */
182 if( strchr( client->modes, 'a' )) strcpy( client->away, DEFAULT_AWAY_MSG );
185 client->next = (POINTER *)My_Clients;
193 Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit )
195 /* Client entfernen. */
198 CHAR msg[LINE_LEN], *txt;
200 assert( Client != NULL );
202 if( LogMsg ) txt = LogMsg;
204 if( ! txt ) txt = "Reason unknown.";
206 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
207 if( Client->type == CLIENT_SERVER ) sprintf( msg, "%s: lost server %s", This_Server->id, Client->id );
213 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
215 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
216 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
217 Client_Destroy( c, NULL, msg, FALSE );
224 /* Wir haben den Client gefunden: entfernen */
225 if( last ) last->next = c->next;
226 else My_Clients = (CLIENT *)c->next;
228 if( c->type == CLIENT_USER )
230 if( c->conn_id != NONE )
232 /* Ein lokaler User */
233 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
237 /* Alle andere Server informieren! */
238 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
239 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
245 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
249 /* Andere Server informieren, ausser denen, die "in
250 * Richtung dem liegen", auf dem der User registriert
251 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
252 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
253 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
256 Channel_Quit( c, FwdMsg ? FwdMsg : c->id );
258 else if( c->type == CLIENT_SERVER )
260 if( c != This_Server )
262 if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
263 else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
266 /* andere Server informieren */
269 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
270 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
275 if( c->conn_id != NONE )
277 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
278 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
282 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
283 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
291 c = (CLIENT *)c->next;
293 } /* Client_Destroy */
297 Client_SetHostname( CLIENT *Client, CHAR *Hostname )
299 /* Hostname eines Clients setzen */
301 assert( Client != NULL );
302 assert( Hostname != NULL );
304 strncpy( Client->host, Hostname, CLIENT_HOST_LEN - 1 );
305 Client->host[CLIENT_HOST_LEN - 1] = '\0';
306 } /* Client_SetHostname */
310 Client_SetID( CLIENT *Client, CHAR *ID )
312 /* Hostname eines Clients setzen, Hash-Wert berechnen */
314 assert( Client != NULL );
315 assert( ID != NULL );
317 strncpy( Client->id, ID, CLIENT_ID_LEN - 1 );
318 Client->id[CLIENT_ID_LEN - 1] = '\0';
321 Client->hash = Hash( Client->id );
326 Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
328 /* Username eines Clients setzen */
330 assert( Client != NULL );
331 assert( User != NULL );
333 if( Idented ) strncpy( Client->user, User, CLIENT_USER_LEN - 1 );
336 Client->user[0] = '~';
337 strncpy( Client->user + 1, User, CLIENT_USER_LEN - 2 );
339 Client->user[CLIENT_USER_LEN - 1] = '\0';
340 } /* Client_SetUser */
344 Client_SetInfo( CLIENT *Client, CHAR *Info )
346 /* Hostname eines Clients setzen */
348 assert( Client != NULL );
349 assert( Info != NULL );
351 strncpy( Client->info, Info, CLIENT_INFO_LEN - 1 );
352 Client->info[CLIENT_INFO_LEN - 1] = '\0';
353 } /* Client_SetInfo */
357 Client_SetModes( CLIENT *Client, CHAR *Modes )
359 /* Modes eines Clients setzen */
361 assert( Client != NULL );
362 assert( Modes != NULL );
364 strncpy( Client->modes, Modes, CLIENT_MODE_LEN - 1 );
365 Client->modes[CLIENT_MODE_LEN - 1] = '\0';
366 } /* Client_SetModes */
370 Client_SetFlags( CLIENT *Client, CHAR *Flags )
372 /* Flags eines Clients setzen */
374 assert( Client != NULL );
375 assert( Flags != NULL );
377 strncpy( Client->flags, Flags, CLIENT_FLAGS_LEN - 1 );
378 Client->modes[CLIENT_FLAGS_LEN - 1] = '\0';
379 } /* Client_SetFlags */
383 Client_SetPassword( CLIENT *Client, CHAR *Pwd )
385 /* Von einem Client geliefertes Passwort */
387 assert( Client != NULL );
388 assert( Pwd != NULL );
390 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
391 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
392 } /* Client_SetPassword */
396 Client_SetAway( CLIENT *Client, CHAR *Txt )
398 /* Von einem Client gelieferte AWAY-Nachricht */
400 assert( Client != NULL );
404 /* Client AWAY setzen */
405 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
406 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
407 Client_ModeAdd( Client, 'a' );
408 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
413 Client_ModeDel( Client, 'a' );
414 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
416 } /* Client_SetAway */
420 Client_SetType( CLIENT *Client, INT Type )
422 assert( Client != NULL );
424 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
425 } /* Client_SetType */
429 Client_SetHops( CLIENT *Client, INT Hops )
431 assert( Client != NULL );
433 } /* Client_SetHops */
437 Client_SetToken( CLIENT *Client, INT Token )
439 assert( Client != NULL );
440 Client->token = Token;
441 } /* Client_SetToken */
445 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
447 assert( Client != NULL );
448 assert( Introducer != NULL );
449 Client->introducer = Introducer;
450 } /* Client_SetIntroducer */
454 Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
456 assert( Client != NULL );
457 Client->oper_by_me = OperByMe;
458 } /* Client_SetOperByMe */
462 Client_ModeAdd( CLIENT *Client, CHAR Mode )
464 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
465 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
470 assert( Client != NULL );
472 x[0] = Mode; x[1] = '\0';
473 if( ! strchr( Client->modes, x[0] ))
475 /* Client hat den Mode noch nicht -> setzen */
476 strcat( Client->modes, x );
480 } /* Client_ModeAdd */
484 Client_ModeDel( CLIENT *Client, CHAR Mode )
486 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
487 * Mode entfernt wurde, FALSE, wenn der Client den Mode
488 * ueberhaupt nicht hatte. */
492 assert( Client != NULL );
494 x[0] = Mode; x[1] = '\0';
496 p = strchr( Client->modes, x[0] );
497 if( ! p ) return FALSE;
499 /* Client hat den Mode -> loeschen */
506 } /* Client_ModeDel */
510 Client_GetFromConn( CONN_ID Idx )
512 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
513 * liefern. Wird keine gefunden, so wird NULL geliefert. */
522 if( c->conn_id == Idx ) return c;
523 c = (CLIENT *)c->next;
526 } /* Client_GetFromConn */
530 Client_Search( CHAR *Nick )
532 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
533 * Wird keine gefunden, so wird NULL geliefert. */
535 CHAR search_id[CLIENT_ID_LEN], *ptr;
539 assert( Nick != NULL );
541 /* Nick kopieren und ggf. Host-Mask abschneiden */
542 strncpy( search_id, Nick, CLIENT_ID_LEN - 1 );
543 search_id[CLIENT_ID_LEN - 1] = '\0';
544 ptr = strchr( search_id, '!' );
545 if( ptr ) *ptr = '\0';
547 search_hash = Hash( search_id );
552 if( c->hash == search_hash )
554 /* lt. Hash-Wert: Treffer! */
555 if( strcasecmp( c->id, search_id ) == 0 ) return c;
557 c = (CLIENT *)c->next;
560 } /* Client_Search */
564 Client_GetFromToken( CLIENT *Client, INT Token )
566 /* Client-Struktur, die den entsprechenden Introducer (=Client)
567 * und das gegebene Token hat, liefern. Wird keine gefunden,
568 * so wird NULL geliefert. */
572 assert( Client != NULL );
578 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
579 c = (CLIENT *)c->next;
582 } /* Client_GetFromToken */
586 Client_Type( CLIENT *Client )
588 assert( Client != NULL );
594 Client_Conn( CLIENT *Client )
596 assert( Client != NULL );
597 return Client->conn_id;
602 Client_ID( CLIENT *Client )
604 assert( Client != NULL );
607 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
610 if( Client->id[0] ) return Client->id;
616 Client_Info( CLIENT *Client )
618 assert( Client != NULL );
624 Client_User( CLIENT *Client )
626 assert( Client != NULL );
627 if( Client->user[0] ) return Client->user;
633 Client_Hostname( CLIENT *Client )
635 assert( Client != NULL );
637 } /* Client_Hostname */
641 Client_Password( CLIENT *Client )
643 assert( Client != NULL );
645 } /* Client_Password */
649 Client_Modes( CLIENT *Client )
651 assert( Client != NULL );
652 return Client->modes;
657 Client_Flags( CLIENT *Client )
659 assert( Client != NULL );
660 return Client->flags;
665 Client_OperByMe( CLIENT *Client )
667 assert( Client != NULL );
668 return Client->oper_by_me;
669 } /* Client_OperByMe */
673 Client_Hops( CLIENT *Client )
675 assert( Client != NULL );
681 Client_Token( CLIENT *Client )
683 assert( Client != NULL );
684 return Client->token;
689 Client_MyToken( CLIENT *Client )
691 assert( Client != NULL );
692 return Client->mytoken;
693 } /* Client_MyToken */
697 Client_NextHop( CLIENT *Client )
701 assert( Client != NULL );
704 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
706 } /* Client_NextHop */
710 Client_Mask( CLIENT *Client )
712 /* Client-"ID" liefern, wie sie z.B. fuer
713 * Prefixe benoetigt wird. */
715 assert( Client != NULL );
717 if( Client->type == CLIENT_SERVER ) return Client->id;
719 snprintf( GetID_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user, Client->host );
725 Client_Introducer( CLIENT *Client )
727 assert( Client != NULL );
728 return Client->introducer;
729 } /* Client_Introducer */
733 Client_TopServer( CLIENT *Client )
735 assert( Client != NULL );
736 return Client->topserver;
737 } /* Client_TopServer */
741 Client_HasMode( CLIENT *Client, CHAR Mode )
743 assert( Client != NULL );
744 return strchr( Client->modes, Mode ) != NULL;
745 } /* Client_HasMode */
749 Client_Away( CLIENT *Client )
751 /* AWAY-Text liefern */
753 assert( Client != NULL );
759 Client_CheckNick( CLIENT *Client, CHAR *Nick )
761 /* Nick ueberpruefen */
763 assert( Client != NULL );
764 assert( Nick != NULL );
766 /* Nick ungueltig? */
767 if( ! Client_IsValidNick( Nick ))
769 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
773 /* Nick bereits vergeben? */
774 if( Client_Search( Nick ))
776 /* den Nick gibt es bereits */
777 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
782 } /* Client_CheckNick */
786 Client_CheckID( CLIENT *Client, CHAR *ID )
788 /* Nick ueberpruefen */
790 CHAR str[COMMAND_LEN];
793 assert( Client != NULL );
794 assert( Client->conn_id > NONE );
795 assert( ID != NULL );
798 if( strlen( ID ) > CLIENT_ID_LEN )
800 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
804 /* ID bereits vergeben? */
808 if( strcasecmp( c->id, ID ) == 0 )
810 /* die Server-ID gibt es bereits */
811 sprintf( str, "ID \"%s\" already registered!", ID );
812 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
813 Conn_Close( Client->conn_id, str, str, TRUE );
816 c = (CLIENT *)c->next;
820 } /* Client_CheckID */
826 /* Ersten Client liefern. */
833 Client_Next( CLIENT *c )
835 /* Naechsten Client liefern. Existiert keiner,
836 * so wird NULL geliefert. */
839 return (CLIENT *)c->next;
844 Client_UserCount( VOID )
846 return Count( CLIENT_USER );
847 } /* Client_UserCount */
851 Client_ServiceCount( VOID )
853 return Count( CLIENT_SERVICE );;
854 } /* Client_ServiceCount */
858 Client_ServerCount( VOID )
860 return Count( CLIENT_SERVER );
861 } /* Client_ServerCount */
865 Client_MyUserCount( VOID )
867 return MyCount( CLIENT_USER );
868 } /* Client_MyUserCount */
872 Client_MyServiceCount( VOID )
874 return MyCount( CLIENT_SERVICE );
875 } /* Client_MyServiceCount */
879 Client_MyServerCount( VOID )
888 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
889 c = (CLIENT *)c->next;
892 } /* Client_MyServerCount */
896 Client_OperCount( VOID )
905 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
906 c = (CLIENT *)c->next;
909 } /* Client_OperCount */
913 Client_UnknownCount( VOID )
922 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
923 c = (CLIENT *)c->next;
926 } /* Client_UnknownCount */
930 Client_IsValidNick( CHAR *Nick )
932 /* Ist der Nick gueltig? */
934 CHAR *ptr, goodchars[20];
936 assert( Nick != NULL );
938 strcpy( goodchars, ";0123456789-" );
940 if( Nick[0] == '#' ) return FALSE;
941 if( strchr( goodchars, Nick[0] )) return FALSE;
942 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
947 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
948 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
953 } /* Client_IsValidNick */
957 Count( CLIENT_TYPE Type )
966 if( c->type == Type ) cnt++;
967 c = (CLIENT *)c->next;
974 MyCount( CLIENT_TYPE Type )
983 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
984 c = (CLIENT *)c->next;
991 New_Client_Struct( VOID )
993 /* Neue CLIENT-Struktur pre-initialisieren */
997 c = malloc( sizeof( CLIENT ));
1000 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1006 c->type = CLIENT_UNKNOWN;
1008 c->introducer = NULL;
1009 c->topserver = NULL;
1010 strcpy( c->id, "" );
1011 strcpy( c->pwd, "" );
1012 strcpy( c->host, "" );
1013 strcpy( c->user, "" );
1014 strcpy( c->info, "" );
1015 strcpy( c->modes, "" );
1016 c->oper_by_me = FALSE;
1020 strcpy( c->away, "" );
1021 strcpy( c->flags, "" );
1028 Generate_MyToken( CLIENT *Client )
1037 if( c->mytoken == token )
1039 /* Das Token wurde bereits vergeben */
1044 else c = (CLIENT *)c->next;
1046 Client->mytoken = token;
1047 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
1048 } /* Generate_MyToken */