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.48 2002/03/12 14:37:52 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.
46 #include "irc-write.h"
53 LOCAL CLIENT *This_Server, *My_Clients;
54 LOCAL CHAR GetID_Buffer[CLIENT_ID_LEN];
57 LOCAL INT Count( CLIENT_TYPE Type );
58 LOCAL INT MyCount( CLIENT_TYPE Type );
60 LOCAL CLIENT *New_Client_Struct( VOID );
61 LOCAL VOID Generate_MyToken( CLIENT *Client );
64 GLOBAL VOID Client_Init( VOID )
68 This_Server = New_Client_Struct( );
71 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
72 Log( LOG_ALERT, PACKAGE" exiting due to fatal errors!" );
76 /* Client-Struktur dieses Servers */
77 This_Server->next = NULL;
78 This_Server->type = CLIENT_SERVER;
79 This_Server->conn_id = NONE;
80 This_Server->introducer = This_Server;
81 This_Server->mytoken = 1;
82 This_Server->hops = 0;
84 gethostname( This_Server->host, CLIENT_HOST_LEN );
85 h = gethostbyname( This_Server->host );
86 if( h ) strcpy( This_Server->host, h->h_name );
88 strcpy( This_Server->id, Conf_ServerName );
89 strcpy( This_Server->info, Conf_ServerInfo );
91 My_Clients = This_Server;
95 GLOBAL VOID Client_Exit( VOID )
100 Client_Destroy( This_Server, "Server going down.", NULL, FALSE );
111 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
115 GLOBAL CLIENT *Client_ThisServer( VOID )
118 } /* Client_ThisServer */
121 GLOBAL CLIENT *Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented )
123 /* Neuen lokalen Client erzeugen: Wrapper-Funktion fuer Client_New(). */
124 return Client_New( Idx, This_Server, NULL, Type, NULL, NULL, Hostname, NULL, 0, 0, NULL, Idented );
125 } /* Client_NewLocal */
128 GLOBAL CLIENT *Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented )
130 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
131 return Client_New( NONE, Introducer, TopServer, CLIENT_SERVER, Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented );
132 } /* Client_NewRemoteServer */
135 GLOBAL CLIENT *Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented )
137 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
138 return Client_New( NONE, Introducer, NULL, CLIENT_USER, Nick, User, Hostname, Info, Hops, Token, Modes, Idented );
139 } /* Client_NewRemoteUser */
142 GLOBAL CLIENT *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 )
146 assert( Idx >= NONE );
147 assert( Introducer != NULL );
148 assert( Hostname != NULL );
150 client = New_Client_Struct( );
151 if( ! client ) return NULL;
154 client->conn_id = Idx;
155 client->introducer = Introducer;
156 client->topserver = TopServer;
158 if( ID ) Client_SetID( client, ID );
159 if( User ) Client_SetUser( client, User, Idented );
160 if( Hostname ) Client_SetHostname( client, Hostname );
161 if( Info ) Client_SetInfo( client, Info );
163 client->token = Token;
164 if( Modes ) Client_SetModes( client, Modes );
165 if( Type == CLIENT_SERVER ) Generate_MyToken( client );
167 /* ist der User away? */
168 if( strchr( client->modes, 'a' )) strcpy( client->away, DEFAULT_AWAY_MSG );
171 client->next = My_Clients;
178 GLOBAL VOID Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit )
180 /* Client entfernen. */
183 CHAR msg[LINE_LEN], *txt;
185 assert( Client != NULL );
187 if( LogMsg ) txt = LogMsg;
189 if( ! txt ) txt = "Reason unknown.";
191 if( Client->type == CLIENT_SERVER )
193 /* Netz-Split-Nachricht vorbereiten */
194 sprintf( msg, "%s | %s", Client_ID( Client ), Client_ID( Client_TopServer( Client ) ? Client_TopServer( Client ) : Client_ThisServer( )));
201 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
203 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
204 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
205 Client_Destroy( c, NULL, msg, FALSE );
212 /* Wir haben den Client gefunden: entfernen */
213 if( last ) last->next = c->next;
214 else My_Clients = c->next;
216 if( c->type == CLIENT_USER )
218 if( c->conn_id != NONE )
220 /* Ein lokaler User */
221 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
225 /* Alle andere Server informieren! */
226 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
227 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
233 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
237 /* Andere Server informieren, ausser denen, die "in
238 * Richtung dem liegen", auf dem der User registriert
239 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
240 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
241 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
244 Channel_RemoveClient( c, FwdMsg ? FwdMsg : c->id );
246 else if( c->type == CLIENT_SERVER )
248 if( c != This_Server )
250 if( c->conn_id != NONE ) Log( LOG_NOTICE, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
251 else Log( LOG_NOTICE, "Server \"%s\" unregistered: %s", c->id, txt );
254 /* andere Server informieren */
257 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
258 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
263 if( c->conn_id != NONE )
265 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
266 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
270 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
271 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
281 } /* Client_Destroy */
284 GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname )
286 /* Hostname eines Clients setzen */
288 assert( Client != NULL );
289 assert( Hostname != NULL );
291 strncpy( Client->host, Hostname, CLIENT_HOST_LEN - 1 );
292 Client->host[CLIENT_HOST_LEN - 1] = '\0';
293 } /* Client_SetHostname */
296 GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *ID )
298 /* Hostname eines Clients setzen */
300 assert( Client != NULL );
301 assert( ID != NULL );
303 strncpy( Client->id, ID, CLIENT_ID_LEN - 1 );
304 Client->id[CLIENT_ID_LEN - 1] = '\0';
308 GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
310 /* Username eines Clients setzen */
312 assert( Client != NULL );
313 assert( User != NULL );
315 if( Idented ) strncpy( Client->user, User, CLIENT_USER_LEN - 1 );
318 Client->user[0] = '~';
319 strncpy( Client->user + 1, User, CLIENT_USER_LEN - 2 );
321 Client->user[CLIENT_USER_LEN - 1] = '\0';
322 } /* Client_SetUser */
325 GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info )
327 /* Hostname eines Clients setzen */
329 assert( Client != NULL );
330 assert( Info != NULL );
332 strncpy( Client->info, Info, CLIENT_INFO_LEN - 1 );
333 Client->info[CLIENT_INFO_LEN - 1] = '\0';
334 } /* Client_SetInfo */
337 GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes )
339 /* Hostname eines Clients setzen */
341 assert( Client != NULL );
342 assert( Modes != NULL );
344 strncpy( Client->modes, Modes, CLIENT_MODE_LEN - 1 );
345 Client->modes[CLIENT_MODE_LEN - 1] = '\0';
346 } /* Client_SetModes */
349 GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd )
351 /* Von einem Client geliefertes Passwort */
353 assert( Client != NULL );
354 assert( Pwd != NULL );
356 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
357 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
358 } /* Client_SetPassword */
361 GLOBAL VOID Client_SetAway( CLIENT *Client, CHAR *Txt )
363 /* Von einem Client gelieferte AWAY-Nachricht */
365 assert( Client != NULL );
369 /* Client AWAY setzen */
370 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
371 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
372 Client_ModeAdd( Client, 'a' );
373 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
378 Client_ModeDel( Client, 'a' );
379 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
381 } /* Client_SetAway */
384 GLOBAL VOID Client_SetType( CLIENT *Client, INT Type )
386 assert( Client != NULL );
388 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
389 } /* Client_SetType */
392 GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops )
394 assert( Client != NULL );
396 } /* Client_SetHops */
399 GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token )
401 assert( Client != NULL );
402 Client->token = Token;
403 } /* Client_SetToken */
406 GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
408 assert( Client != NULL );
409 assert( Introducer != NULL );
410 Client->introducer = Introducer;
411 } /* Client_SetIntroducer */
414 GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
416 assert( Client != NULL );
417 Client->oper_by_me = OperByMe;
418 } /* Client_SetOperByMe */
421 GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode )
423 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
424 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
429 assert( Client != NULL );
431 x[0] = Mode; x[1] = '\0';
432 if( ! strchr( Client->modes, x[0] ))
434 /* Client hat den Mode noch nicht -> setzen */
435 strcat( Client->modes, x );
439 } /* Client_ModeAdd */
442 GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode )
444 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
445 * Mode entfernt wurde, FALSE, wenn der Client den Mode
446 * ueberhaupt nicht hatte. */
450 assert( Client != NULL );
452 x[0] = Mode; x[1] = '\0';
454 p = strchr( Client->modes, x[0] );
455 if( ! p ) return FALSE;
457 /* Client hat den Mode -> loeschen */
464 } /* Client_ModeDel */
467 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx )
469 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
470 * liefern. Wird keine gefunden, so wird NULL geliefert. */
479 if( c->conn_id == Idx ) return c;
483 } /* Client_GetFromConn */
486 GLOBAL CLIENT *Client_GetFromID( CHAR *Nick )
488 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
489 * Wird keine gefunden, so wird NULL geliefert. */
491 CHAR n[CLIENT_ID_LEN], *ptr;
494 assert( Nick != NULL );
496 /* Nick kopieren und ggf. Host-Mask abschneiden */
497 strncpy( n, Nick, CLIENT_ID_LEN - 1 );
498 n[CLIENT_ID_LEN - 1] = '\0';
499 ptr = strchr( n, '!' );
500 if( ptr ) *ptr = '\0';
505 if( strcasecmp( c->id, n ) == 0 ) return c;
509 } /* Client_GetFromID */
512 GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token )
514 /* Client-Struktur, die den entsprechenden Introducer (=Client)
515 * und das gegebene Token hat, liefern. Wird keine gefunden,
516 * so wird NULL geliefert. */
520 assert( Client != NULL );
526 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
530 } /* Client_GetFromToken */
533 GLOBAL INT Client_Type( CLIENT *Client )
535 assert( Client != NULL );
540 GLOBAL CONN_ID Client_Conn( CLIENT *Client )
542 assert( Client != NULL );
543 return Client->conn_id;
547 GLOBAL CHAR *Client_ID( CLIENT *Client )
549 assert( Client != NULL );
552 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
555 if( Client->id[0] ) return Client->id;
560 GLOBAL CHAR *Client_Info( CLIENT *Client )
562 assert( Client != NULL );
567 GLOBAL CHAR *Client_User( CLIENT *Client )
569 assert( Client != NULL );
570 if( Client->user ) return Client->user;
575 GLOBAL CHAR *Client_Hostname( CLIENT *Client )
577 assert( Client != NULL );
579 } /* Client_Hostname */
582 GLOBAL CHAR *Client_Password( CLIENT *Client )
584 assert( Client != NULL );
586 } /* Client_Password */
589 GLOBAL CHAR *Client_Modes( CLIENT *Client )
591 assert( Client != NULL );
592 return Client->modes;
596 GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client )
598 assert( Client != NULL );
599 return Client->oper_by_me;
600 } /* Client_OperByMe */
603 GLOBAL INT Client_Hops( CLIENT *Client )
605 assert( Client != NULL );
610 GLOBAL INT Client_Token( CLIENT *Client )
612 assert( Client != NULL );
613 return Client->token;
617 GLOBAL INT Client_MyToken( CLIENT *Client )
619 assert( Client != NULL );
620 return Client->mytoken;
621 } /* Client_MyToken */
624 GLOBAL CLIENT *Client_NextHop( CLIENT *Client )
628 assert( Client != NULL );
631 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
633 } /* Client_NextHop */
636 GLOBAL CHAR *Client_Mask( CLIENT *Client )
638 /* Client-"ID" liefern, wie sie z.B. fuer
639 * Prefixe benoetigt wird. */
641 assert( Client != NULL );
643 if( Client->type == CLIENT_SERVER ) return Client->id;
645 sprintf( GetID_Buffer, "%s!%s@%s", Client->id, Client->user, Client->host );
650 GLOBAL CLIENT *Client_Introducer( CLIENT *Client )
652 assert( Client != NULL );
653 return Client->introducer;
654 } /* Client_Introducer */
657 GLOBAL CLIENT *Client_TopServer( CLIENT *Client )
659 assert( Client != NULL );
660 return Client->topserver;
661 } /* Client_TopServer */
664 GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode )
666 assert( Client != NULL );
667 return strchr( Client->modes, Mode ) != NULL;
668 } /* Client_HasMode */
671 GLOBAL CHAR *Client_Away( CLIENT *Client )
673 /* AWAY-Text liefern */
675 assert( Client != NULL );
680 GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick )
682 /* Nick ueberpruefen */
686 assert( Client != NULL );
687 assert( Nick != NULL );
689 /* Nick ungueltig? */
690 if( ! Client_IsValidNick( Nick ))
692 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
696 /* Nick bereits vergeben? */
700 if( strcasecmp( c->id, Nick ) == 0 )
702 /* den Nick gibt es bereits */
703 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
710 } /* Client_CheckNick */
713 GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID )
715 /* Nick ueberpruefen */
717 CHAR str[COMMAND_LEN];
720 assert( Client != NULL );
721 assert( Client->conn_id > NONE );
722 assert( ID != NULL );
725 if( strlen( ID ) > CLIENT_ID_LEN )
727 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
731 /* ID bereits vergeben? */
735 if( strcasecmp( c->id, ID ) == 0 )
737 /* die Server-ID gibt es bereits */
738 sprintf( str, "ID \"%s\" already registered!", ID );
739 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
740 Conn_Close( Client->conn_id, str, str, TRUE );
747 } /* Client_CheckID */
750 GLOBAL CLIENT *Client_Search( CHAR *ID )
752 /* Client suchen, auf den ID passt */
756 assert( ID != NULL );
761 if( strcasecmp( c->id, ID ) == 0 ) return c;
766 } /* Client_Search */
769 GLOBAL CLIENT *Client_First( VOID )
771 /* Ersten Client liefern. */
777 GLOBAL CLIENT *Client_Next( CLIENT *c )
779 /* Naechsten Client liefern. Existiert keiner,
780 * so wird NULL geliefert. */
787 GLOBAL INT Client_UserCount( VOID )
789 return Count( CLIENT_USER );
790 } /* Client_UserCount */
793 GLOBAL INT Client_ServiceCount( VOID )
795 return Count( CLIENT_SERVICE );;
796 } /* Client_ServiceCount */
799 GLOBAL INT Client_ServerCount( VOID )
801 return Count( CLIENT_SERVER );
802 } /* Client_ServerCount */
805 GLOBAL INT Client_MyUserCount( VOID )
807 return MyCount( CLIENT_USER );
808 } /* Client_MyUserCount */
811 GLOBAL INT Client_MyServiceCount( VOID )
813 return MyCount( CLIENT_SERVICE );
814 } /* Client_MyServiceCount */
817 GLOBAL INT Client_MyServerCount( VOID )
819 return MyCount( CLIENT_SERVER );
820 } /* Client_MyServerCount */
823 GLOBAL INT Client_OperCount( VOID )
832 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
836 } /* Client_OperCount */
839 GLOBAL INT Client_UnknownCount( VOID )
848 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
852 } /* Client_UnknownCount */
855 GLOBAL BOOLEAN Client_IsValidNick( CHAR *Nick )
857 /* Ist der Nick gueltig? */
859 CHAR *ptr, goodchars[] = ";0123456789-";
861 assert( Nick != NULL );
863 if( Nick[0] == '#' ) return FALSE;
864 if( strchr( goodchars, Nick[0] )) return FALSE;
865 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
870 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
871 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
876 } /* Client_IsValidNick */
879 LOCAL INT Count( CLIENT_TYPE Type )
888 if( c && ( c->type == Type )) cnt++;
895 LOCAL INT MyCount( CLIENT_TYPE Type )
904 if( c && ( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
911 LOCAL CLIENT *New_Client_Struct( VOID )
913 /* Neue CLIENT-Struktur pre-initialisieren */
917 c = malloc( sizeof( CLIENT ));
920 Log( LOG_EMERG, "Can't allocate memory!" );
925 c->type = CLIENT_UNKNOWN;
927 c->introducer = NULL;
930 strcpy( c->pwd, "" );
931 strcpy( c->host, "" );
932 strcpy( c->user, "" );
933 strcpy( c->info, "" );
934 strcpy( c->modes, "" );
935 c->oper_by_me = FALSE;
939 strcpy( c->away, "" );
945 LOCAL VOID Generate_MyToken( CLIENT *Client )
954 if( c->mytoken == token )
956 /* Das Token wurde bereits vergeben */
963 Client->mytoken = token;
964 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
965 } /* Generate_MyToken */