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.57 2002/06/01 14:36:43 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 LOCAL CLIENT *This_Server, *My_Clients;
57 LOCAL CHAR GetID_Buffer[CLIENT_ID_LEN];
60 LOCAL INT Count PARAMS(( CLIENT_TYPE Type ));
61 LOCAL INT MyCount PARAMS(( CLIENT_TYPE Type ));
63 LOCAL CLIENT *New_Client_Struct PARAMS(( VOID ));
64 LOCAL VOID Generate_MyToken PARAMS(( CLIENT *Client ));
72 This_Server = New_Client_Struct( );
75 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
76 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE );
80 /* Client-Struktur dieses Servers */
81 This_Server->next = NULL;
82 This_Server->type = CLIENT_SERVER;
83 This_Server->conn_id = NONE;
84 This_Server->introducer = This_Server;
85 This_Server->mytoken = 1;
86 This_Server->hops = 0;
88 gethostname( This_Server->host, CLIENT_HOST_LEN );
89 h = gethostbyname( This_Server->host );
90 if( h ) strcpy( This_Server->host, h->h_name );
92 Client_SetID( This_Server, Conf_ServerName );
93 Client_SetInfo( This_Server, Conf_ServerInfo );
95 My_Clients = This_Server;
105 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' )) strcpy( client->away, DEFAULT_AWAY_MSG );
181 client->next = (POINTER *)My_Clients;
189 Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit )
191 /* Client entfernen. */
194 CHAR msg[LINE_LEN], *txt;
196 assert( Client != NULL );
198 if( LogMsg ) txt = LogMsg;
200 if( ! txt ) txt = "Reason unknown.";
202 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
203 if( Client->type == CLIENT_SERVER ) sprintf( msg, "%s: lost server %s", This_Server->id, Client->id );
209 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
211 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
212 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
213 Client_Destroy( c, NULL, msg, FALSE );
220 /* Wir haben den Client gefunden: entfernen */
221 if( last ) last->next = c->next;
222 else My_Clients = (CLIENT *)c->next;
224 if( c->type == CLIENT_USER )
226 if( c->conn_id != NONE )
228 /* Ein lokaler User */
229 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
233 /* Alle andere Server informieren! */
234 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
235 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
241 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
245 /* Andere Server informieren, ausser denen, die "in
246 * Richtung dem liegen", auf dem der User registriert
247 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
248 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
249 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
252 Channel_Quit( c, FwdMsg ? FwdMsg : c->id );
254 else if( c->type == CLIENT_SERVER )
256 if( c != This_Server )
258 if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
259 else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
262 /* andere Server informieren */
265 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
266 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
271 if( c->conn_id != NONE )
273 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
274 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
278 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
279 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
287 c = (CLIENT *)c->next;
289 } /* Client_Destroy */
293 Client_SetHostname( CLIENT *Client, CHAR *Hostname )
295 /* Hostname eines Clients setzen */
297 assert( Client != NULL );
298 assert( Hostname != NULL );
300 strncpy( Client->host, Hostname, CLIENT_HOST_LEN - 1 );
301 Client->host[CLIENT_HOST_LEN - 1] = '\0';
302 } /* Client_SetHostname */
306 Client_SetID( CLIENT *Client, CHAR *ID )
308 /* Hostname eines Clients setzen, Hash-Wert berechnen */
310 assert( Client != NULL );
311 assert( ID != NULL );
313 strncpy( Client->id, ID, CLIENT_ID_LEN - 1 );
314 Client->id[CLIENT_ID_LEN - 1] = '\0';
317 Client->hash = Hash( Client->id );
322 Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
324 /* Username eines Clients setzen */
326 assert( Client != NULL );
327 assert( User != NULL );
329 if( Idented ) strncpy( Client->user, User, CLIENT_USER_LEN - 1 );
332 Client->user[0] = '~';
333 strncpy( Client->user + 1, User, CLIENT_USER_LEN - 2 );
335 Client->user[CLIENT_USER_LEN - 1] = '\0';
336 } /* Client_SetUser */
340 Client_SetInfo( CLIENT *Client, CHAR *Info )
342 /* Hostname eines Clients setzen */
344 assert( Client != NULL );
345 assert( Info != NULL );
347 strncpy( Client->info, Info, CLIENT_INFO_LEN - 1 );
348 Client->info[CLIENT_INFO_LEN - 1] = '\0';
349 } /* Client_SetInfo */
353 Client_SetModes( CLIENT *Client, CHAR *Modes )
355 /* Hostname eines Clients setzen */
357 assert( Client != NULL );
358 assert( Modes != NULL );
360 strncpy( Client->modes, Modes, CLIENT_MODE_LEN - 1 );
361 Client->modes[CLIENT_MODE_LEN - 1] = '\0';
362 } /* Client_SetModes */
366 Client_SetPassword( CLIENT *Client, CHAR *Pwd )
368 /* Von einem Client geliefertes Passwort */
370 assert( Client != NULL );
371 assert( Pwd != NULL );
373 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
374 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
375 } /* Client_SetPassword */
379 Client_SetAway( CLIENT *Client, CHAR *Txt )
381 /* Von einem Client gelieferte AWAY-Nachricht */
383 assert( Client != NULL );
387 /* Client AWAY setzen */
388 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
389 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
390 Client_ModeAdd( Client, 'a' );
391 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
396 Client_ModeDel( Client, 'a' );
397 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
399 } /* Client_SetAway */
403 Client_SetType( CLIENT *Client, INT Type )
405 assert( Client != NULL );
407 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
408 } /* Client_SetType */
412 Client_SetHops( CLIENT *Client, INT Hops )
414 assert( Client != NULL );
416 } /* Client_SetHops */
420 Client_SetToken( CLIENT *Client, INT Token )
422 assert( Client != NULL );
423 Client->token = Token;
424 } /* Client_SetToken */
428 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
430 assert( Client != NULL );
431 assert( Introducer != NULL );
432 Client->introducer = Introducer;
433 } /* Client_SetIntroducer */
437 Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
439 assert( Client != NULL );
440 Client->oper_by_me = OperByMe;
441 } /* Client_SetOperByMe */
445 Client_ModeAdd( CLIENT *Client, CHAR Mode )
447 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
448 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
453 assert( Client != NULL );
455 x[0] = Mode; x[1] = '\0';
456 if( ! strchr( Client->modes, x[0] ))
458 /* Client hat den Mode noch nicht -> setzen */
459 strcat( Client->modes, x );
463 } /* Client_ModeAdd */
467 Client_ModeDel( CLIENT *Client, CHAR Mode )
469 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
470 * Mode entfernt wurde, FALSE, wenn der Client den Mode
471 * ueberhaupt nicht hatte. */
475 assert( Client != NULL );
477 x[0] = Mode; x[1] = '\0';
479 p = strchr( Client->modes, x[0] );
480 if( ! p ) return FALSE;
482 /* Client hat den Mode -> loeschen */
489 } /* Client_ModeDel */
493 Client_GetFromConn( CONN_ID Idx )
495 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
496 * liefern. Wird keine gefunden, so wird NULL geliefert. */
505 if( c->conn_id == Idx ) return c;
506 c = (CLIENT *)c->next;
509 } /* Client_GetFromConn */
513 Client_Search( CHAR *Nick )
515 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
516 * Wird keine gefunden, so wird NULL geliefert. */
518 CHAR search_id[CLIENT_ID_LEN], *ptr;
522 assert( Nick != NULL );
524 /* Nick kopieren und ggf. Host-Mask abschneiden */
525 strncpy( search_id, Nick, CLIENT_ID_LEN - 1 );
526 search_id[CLIENT_ID_LEN - 1] = '\0';
527 ptr = strchr( search_id, '!' );
528 if( ptr ) *ptr = '\0';
530 search_hash = Hash( search_id );
535 if( c->hash == search_hash )
537 /* lt. Hash-Wert: Treffer! */
538 if( strcasecmp( c->id, search_id ) == 0 ) return c;
540 c = (CLIENT *)c->next;
543 } /* Client_Search */
547 Client_GetFromToken( CLIENT *Client, INT Token )
549 /* Client-Struktur, die den entsprechenden Introducer (=Client)
550 * und das gegebene Token hat, liefern. Wird keine gefunden,
551 * so wird NULL geliefert. */
555 assert( Client != NULL );
561 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
562 c = (CLIENT *)c->next;
565 } /* Client_GetFromToken */
569 Client_Type( CLIENT *Client )
571 assert( Client != NULL );
577 Client_Conn( CLIENT *Client )
579 assert( Client != NULL );
580 return Client->conn_id;
585 Client_ID( CLIENT *Client )
587 assert( Client != NULL );
590 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
593 if( Client->id[0] ) return Client->id;
599 Client_Info( CLIENT *Client )
601 assert( Client != NULL );
607 Client_User( CLIENT *Client )
609 assert( Client != NULL );
610 if( Client->user[0] ) return Client->user;
616 Client_Hostname( CLIENT *Client )
618 assert( Client != NULL );
620 } /* Client_Hostname */
624 Client_Password( CLIENT *Client )
626 assert( Client != NULL );
628 } /* Client_Password */
632 Client_Modes( CLIENT *Client )
634 assert( Client != NULL );
635 return Client->modes;
640 Client_OperByMe( CLIENT *Client )
642 assert( Client != NULL );
643 return Client->oper_by_me;
644 } /* Client_OperByMe */
648 Client_Hops( CLIENT *Client )
650 assert( Client != NULL );
656 Client_Token( CLIENT *Client )
658 assert( Client != NULL );
659 return Client->token;
664 Client_MyToken( CLIENT *Client )
666 assert( Client != NULL );
667 return Client->mytoken;
668 } /* Client_MyToken */
672 Client_NextHop( CLIENT *Client )
676 assert( Client != NULL );
679 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
681 } /* Client_NextHop */
685 Client_Mask( CLIENT *Client )
687 /* Client-"ID" liefern, wie sie z.B. fuer
688 * Prefixe benoetigt wird. */
690 assert( Client != NULL );
692 if( Client->type == CLIENT_SERVER ) return Client->id;
694 sprintf( GetID_Buffer, "%s!%s@%s", Client->id, Client->user, Client->host );
700 Client_Introducer( CLIENT *Client )
702 assert( Client != NULL );
703 return Client->introducer;
704 } /* Client_Introducer */
708 Client_TopServer( CLIENT *Client )
710 assert( Client != NULL );
711 return Client->topserver;
712 } /* Client_TopServer */
716 Client_HasMode( CLIENT *Client, CHAR Mode )
718 assert( Client != NULL );
719 return strchr( Client->modes, Mode ) != NULL;
720 } /* Client_HasMode */
724 Client_Away( CLIENT *Client )
726 /* AWAY-Text liefern */
728 assert( Client != NULL );
734 Client_CheckNick( CLIENT *Client, CHAR *Nick )
736 /* Nick ueberpruefen */
738 assert( Client != NULL );
739 assert( Nick != NULL );
741 /* Nick ungueltig? */
742 if( ! Client_IsValidNick( Nick ))
744 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
748 /* Nick bereits vergeben? */
749 if( Client_Search( Nick ))
751 /* den Nick gibt es bereits */
752 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
757 } /* Client_CheckNick */
761 Client_CheckID( CLIENT *Client, CHAR *ID )
763 /* Nick ueberpruefen */
765 CHAR str[COMMAND_LEN];
768 assert( Client != NULL );
769 assert( Client->conn_id > NONE );
770 assert( ID != NULL );
773 if( strlen( ID ) > CLIENT_ID_LEN )
775 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
779 /* ID bereits vergeben? */
783 if( strcasecmp( c->id, ID ) == 0 )
785 /* die Server-ID gibt es bereits */
786 sprintf( str, "ID \"%s\" already registered!", ID );
787 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
788 Conn_Close( Client->conn_id, str, str, TRUE );
791 c = (CLIENT *)c->next;
795 } /* Client_CheckID */
801 /* Ersten Client liefern. */
808 Client_Next( CLIENT *c )
810 /* Naechsten Client liefern. Existiert keiner,
811 * so wird NULL geliefert. */
814 return (CLIENT *)c->next;
819 Client_UserCount( VOID )
821 return Count( CLIENT_USER );
822 } /* Client_UserCount */
826 Client_ServiceCount( VOID )
828 return Count( CLIENT_SERVICE );;
829 } /* Client_ServiceCount */
833 Client_ServerCount( VOID )
835 return Count( CLIENT_SERVER );
836 } /* Client_ServerCount */
840 Client_MyUserCount( VOID )
842 return MyCount( CLIENT_USER );
843 } /* Client_MyUserCount */
847 Client_MyServiceCount( VOID )
849 return MyCount( CLIENT_SERVICE );
850 } /* Client_MyServiceCount */
854 Client_MyServerCount( VOID )
863 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
864 c = (CLIENT *)c->next;
867 } /* Client_MyServerCount */
871 Client_OperCount( VOID )
880 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
881 c = (CLIENT *)c->next;
884 } /* Client_OperCount */
888 Client_UnknownCount( VOID )
897 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
898 c = (CLIENT *)c->next;
901 } /* Client_UnknownCount */
905 Client_IsValidNick( CHAR *Nick )
907 /* Ist der Nick gueltig? */
909 CHAR *ptr, goodchars[20];
911 assert( Nick != NULL );
913 strcpy( goodchars, ";0123456789-" );
915 if( Nick[0] == '#' ) return FALSE;
916 if( strchr( goodchars, Nick[0] )) return FALSE;
917 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
922 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
923 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
928 } /* Client_IsValidNick */
932 Count( CLIENT_TYPE Type )
941 if( c->type == Type ) cnt++;
942 c = (CLIENT *)c->next;
949 MyCount( CLIENT_TYPE Type )
958 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
959 c = (CLIENT *)c->next;
966 New_Client_Struct( VOID )
968 /* Neue CLIENT-Struktur pre-initialisieren */
972 c = malloc( sizeof( CLIENT ));
975 Log( LOG_EMERG, "Can't allocate memory!" );
981 c->type = CLIENT_UNKNOWN;
983 c->introducer = NULL;
986 strcpy( c->pwd, "" );
987 strcpy( c->host, "" );
988 strcpy( c->user, "" );
989 strcpy( c->info, "" );
990 strcpy( c->modes, "" );
991 c->oper_by_me = FALSE;
995 strcpy( c->away, "" );
1002 Generate_MyToken( CLIENT *Client )
1011 if( c->mytoken == token )
1013 /* Das Token wurde bereits vergeben */
1018 else c = (CLIENT *)c->next;
1020 Client->mytoken = token;
1021 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
1022 } /* Generate_MyToken */