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.53 2002/03/27 20:52:58 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.
47 #include "irc-write.h"
54 LOCAL CLIENT *This_Server, *My_Clients;
55 LOCAL CHAR GetID_Buffer[CLIENT_ID_LEN];
58 LOCAL INT Count( CLIENT_TYPE Type );
59 LOCAL INT MyCount( CLIENT_TYPE Type );
61 LOCAL CLIENT *New_Client_Struct( VOID );
62 LOCAL VOID Generate_MyToken( CLIENT *Client );
65 GLOBAL VOID Client_Init( VOID )
69 This_Server = New_Client_Struct( );
72 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
73 Log( LOG_ALERT, PACKAGE" exiting due to fatal errors!" );
77 /* Client-Struktur dieses Servers */
78 This_Server->next = NULL;
79 This_Server->type = CLIENT_SERVER;
80 This_Server->conn_id = NONE;
81 This_Server->introducer = This_Server;
82 This_Server->mytoken = 1;
83 This_Server->hops = 0;
85 gethostname( This_Server->host, CLIENT_HOST_LEN );
86 h = gethostbyname( This_Server->host );
87 if( h ) strcpy( This_Server->host, h->h_name );
89 Client_SetID( This_Server, Conf_ServerName );
90 Client_SetInfo( This_Server, Conf_ServerInfo );
92 My_Clients = This_Server;
96 GLOBAL VOID Client_Exit( VOID )
101 Client_Destroy( This_Server, "Server going down.", NULL, FALSE );
108 next = (CLIENT *)c->next;
112 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
116 GLOBAL CLIENT *Client_ThisServer( VOID )
119 } /* Client_ThisServer */
122 GLOBAL CLIENT *Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented )
124 /* Neuen lokalen Client erzeugen: Wrapper-Funktion fuer Client_New(). */
125 return Client_New( Idx, This_Server, NULL, Type, NULL, NULL, Hostname, NULL, 0, 0, NULL, Idented );
126 } /* Client_NewLocal */
129 GLOBAL CLIENT *Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented )
131 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
132 return Client_New( NONE, Introducer, TopServer, CLIENT_SERVER, Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented );
133 } /* Client_NewRemoteServer */
136 GLOBAL CLIENT *Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented )
138 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
139 return Client_New( NONE, Introducer, NULL, CLIENT_USER, Nick, User, Hostname, Info, Hops, Token, Modes, Idented );
140 } /* Client_NewRemoteUser */
143 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 )
147 assert( Idx >= NONE );
148 assert( Introducer != NULL );
149 assert( Hostname != NULL );
151 client = New_Client_Struct( );
152 if( ! client ) return NULL;
155 client->conn_id = Idx;
156 client->introducer = Introducer;
157 client->topserver = TopServer;
159 if( ID ) Client_SetID( client, ID );
160 if( User ) Client_SetUser( client, User, Idented );
161 if( Hostname ) Client_SetHostname( client, Hostname );
162 if( Info ) Client_SetInfo( client, Info );
164 client->token = Token;
165 if( Modes ) Client_SetModes( client, Modes );
166 if( Type == CLIENT_SERVER ) Generate_MyToken( client );
168 /* ist der User away? */
169 if( strchr( client->modes, 'a' )) strcpy( client->away, DEFAULT_AWAY_MSG );
172 client->next = (POINTER *)My_Clients;
179 GLOBAL VOID Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit )
181 /* Client entfernen. */
184 CHAR msg[LINE_LEN], *txt;
186 assert( Client != NULL );
188 if( LogMsg ) txt = LogMsg;
190 if( ! txt ) txt = "Reason unknown.";
192 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
193 if( Client->type == CLIENT_SERVER ) sprintf( msg, "%s: lost server %s", This_Server->id, Client->id );
199 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
201 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
202 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
203 Client_Destroy( c, NULL, msg, FALSE );
210 /* Wir haben den Client gefunden: entfernen */
211 if( last ) last->next = c->next;
212 else My_Clients = (CLIENT *)c->next;
214 if( c->type == CLIENT_USER )
216 if( c->conn_id != NONE )
218 /* Ein lokaler User */
219 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
223 /* Alle andere Server informieren! */
224 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
225 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
231 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
235 /* Andere Server informieren, ausser denen, die "in
236 * Richtung dem liegen", auf dem der User registriert
237 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
238 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
239 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
242 Channel_RemoveClient( c, FwdMsg ? FwdMsg : c->id );
244 else if( c->type == CLIENT_SERVER )
246 if( c != This_Server )
248 if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
249 else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
252 /* andere Server informieren */
255 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
256 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
261 if( c->conn_id != NONE )
263 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
264 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
268 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
269 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
277 c = (CLIENT *)c->next;
279 } /* Client_Destroy */
282 GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname )
284 /* Hostname eines Clients setzen */
286 assert( Client != NULL );
287 assert( Hostname != NULL );
289 strncpy( Client->host, Hostname, CLIENT_HOST_LEN - 1 );
290 Client->host[CLIENT_HOST_LEN - 1] = '\0';
291 } /* Client_SetHostname */
294 GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *ID )
296 /* Hostname eines Clients setzen, Hash-Wert berechnen */
298 assert( Client != NULL );
299 assert( ID != NULL );
301 strncpy( Client->id, ID, CLIENT_ID_LEN - 1 );
302 Client->id[CLIENT_ID_LEN - 1] = '\0';
305 Client->hash = Hash( Client->id );
309 GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
311 /* Username eines Clients setzen */
313 assert( Client != NULL );
314 assert( User != NULL );
316 if( Idented ) strncpy( Client->user, User, CLIENT_USER_LEN - 1 );
319 Client->user[0] = '~';
320 strncpy( Client->user + 1, User, CLIENT_USER_LEN - 2 );
322 Client->user[CLIENT_USER_LEN - 1] = '\0';
323 } /* Client_SetUser */
326 GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info )
328 /* Hostname eines Clients setzen */
330 assert( Client != NULL );
331 assert( Info != NULL );
333 strncpy( Client->info, Info, CLIENT_INFO_LEN - 1 );
334 Client->info[CLIENT_INFO_LEN - 1] = '\0';
335 } /* Client_SetInfo */
338 GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes )
340 /* Hostname eines Clients setzen */
342 assert( Client != NULL );
343 assert( Modes != NULL );
345 strncpy( Client->modes, Modes, CLIENT_MODE_LEN - 1 );
346 Client->modes[CLIENT_MODE_LEN - 1] = '\0';
347 } /* Client_SetModes */
350 GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd )
352 /* Von einem Client geliefertes Passwort */
354 assert( Client != NULL );
355 assert( Pwd != NULL );
357 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
358 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
359 } /* Client_SetPassword */
362 GLOBAL VOID Client_SetAway( CLIENT *Client, CHAR *Txt )
364 /* Von einem Client gelieferte AWAY-Nachricht */
366 assert( Client != NULL );
370 /* Client AWAY setzen */
371 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
372 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
373 Client_ModeAdd( Client, 'a' );
374 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
379 Client_ModeDel( Client, 'a' );
380 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
382 } /* Client_SetAway */
385 GLOBAL VOID Client_SetType( CLIENT *Client, INT Type )
387 assert( Client != NULL );
389 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
390 } /* Client_SetType */
393 GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops )
395 assert( Client != NULL );
397 } /* Client_SetHops */
400 GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token )
402 assert( Client != NULL );
403 Client->token = Token;
404 } /* Client_SetToken */
407 GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
409 assert( Client != NULL );
410 assert( Introducer != NULL );
411 Client->introducer = Introducer;
412 } /* Client_SetIntroducer */
415 GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
417 assert( Client != NULL );
418 Client->oper_by_me = OperByMe;
419 } /* Client_SetOperByMe */
422 GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode )
424 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
425 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
430 assert( Client != NULL );
432 x[0] = Mode; x[1] = '\0';
433 if( ! strchr( Client->modes, x[0] ))
435 /* Client hat den Mode noch nicht -> setzen */
436 strcat( Client->modes, x );
440 } /* Client_ModeAdd */
443 GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode )
445 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
446 * Mode entfernt wurde, FALSE, wenn der Client den Mode
447 * ueberhaupt nicht hatte. */
451 assert( Client != NULL );
453 x[0] = Mode; x[1] = '\0';
455 p = strchr( Client->modes, x[0] );
456 if( ! p ) return FALSE;
458 /* Client hat den Mode -> loeschen */
465 } /* Client_ModeDel */
468 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx )
470 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
471 * liefern. Wird keine gefunden, so wird NULL geliefert. */
480 if( c->conn_id == Idx ) return c;
481 c = (CLIENT *)c->next;
484 } /* Client_GetFromConn */
487 GLOBAL CLIENT *Client_Search( CHAR *Nick )
489 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
490 * Wird keine gefunden, so wird NULL geliefert. */
492 CHAR search_id[CLIENT_ID_LEN], *ptr;
496 assert( Nick != NULL );
498 /* Nick kopieren und ggf. Host-Mask abschneiden */
499 strncpy( search_id, Nick, CLIENT_ID_LEN - 1 );
500 search_id[CLIENT_ID_LEN - 1] = '\0';
501 ptr = strchr( search_id, '!' );
502 if( ptr ) *ptr = '\0';
504 search_hash = Hash( search_id );
509 if( c->hash == search_hash )
511 /* lt. Hash-Wert: Treffer! */
512 if( strcasecmp( c->id, search_id ) == 0 ) return c;
514 c = (CLIENT *)c->next;
517 } /* Client_Search */
520 GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token )
522 /* Client-Struktur, die den entsprechenden Introducer (=Client)
523 * und das gegebene Token hat, liefern. Wird keine gefunden,
524 * so wird NULL geliefert. */
528 assert( Client != NULL );
534 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
535 c = (CLIENT *)c->next;
538 } /* Client_GetFromToken */
541 GLOBAL INT Client_Type( CLIENT *Client )
543 assert( Client != NULL );
548 GLOBAL CONN_ID Client_Conn( CLIENT *Client )
550 assert( Client != NULL );
551 return Client->conn_id;
555 GLOBAL CHAR *Client_ID( CLIENT *Client )
557 assert( Client != NULL );
560 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
563 if( Client->id[0] ) return Client->id;
568 GLOBAL CHAR *Client_Info( CLIENT *Client )
570 assert( Client != NULL );
575 GLOBAL CHAR *Client_User( CLIENT *Client )
577 assert( Client != NULL );
578 if( Client->user[0] ) return Client->user;
583 GLOBAL CHAR *Client_Hostname( CLIENT *Client )
585 assert( Client != NULL );
587 } /* Client_Hostname */
590 GLOBAL CHAR *Client_Password( CLIENT *Client )
592 assert( Client != NULL );
594 } /* Client_Password */
597 GLOBAL CHAR *Client_Modes( CLIENT *Client )
599 assert( Client != NULL );
600 return Client->modes;
604 GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client )
606 assert( Client != NULL );
607 return Client->oper_by_me;
608 } /* Client_OperByMe */
611 GLOBAL INT Client_Hops( CLIENT *Client )
613 assert( Client != NULL );
618 GLOBAL INT Client_Token( CLIENT *Client )
620 assert( Client != NULL );
621 return Client->token;
625 GLOBAL INT Client_MyToken( CLIENT *Client )
627 assert( Client != NULL );
628 return Client->mytoken;
629 } /* Client_MyToken */
632 GLOBAL CLIENT *Client_NextHop( CLIENT *Client )
636 assert( Client != NULL );
639 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
641 } /* Client_NextHop */
644 GLOBAL CHAR *Client_Mask( CLIENT *Client )
646 /* Client-"ID" liefern, wie sie z.B. fuer
647 * Prefixe benoetigt wird. */
649 assert( Client != NULL );
651 if( Client->type == CLIENT_SERVER ) return Client->id;
653 sprintf( GetID_Buffer, "%s!%s@%s", Client->id, Client->user, Client->host );
658 GLOBAL CLIENT *Client_Introducer( CLIENT *Client )
660 assert( Client != NULL );
661 return Client->introducer;
662 } /* Client_Introducer */
665 GLOBAL CLIENT *Client_TopServer( CLIENT *Client )
667 assert( Client != NULL );
668 return Client->topserver;
669 } /* Client_TopServer */
672 GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode )
674 assert( Client != NULL );
675 return strchr( Client->modes, Mode ) != NULL;
676 } /* Client_HasMode */
679 GLOBAL CHAR *Client_Away( CLIENT *Client )
681 /* AWAY-Text liefern */
683 assert( Client != NULL );
688 GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick )
690 /* Nick ueberpruefen */
692 assert( Client != NULL );
693 assert( Nick != NULL );
695 /* Nick ungueltig? */
696 if( ! Client_IsValidNick( Nick ))
698 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
702 /* Nick bereits vergeben? */
703 if( Client_Search( Nick ))
705 /* den Nick gibt es bereits */
706 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
711 } /* Client_CheckNick */
714 GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID )
716 /* Nick ueberpruefen */
718 CHAR str[COMMAND_LEN];
721 assert( Client != NULL );
722 assert( Client->conn_id > NONE );
723 assert( ID != NULL );
726 if( strlen( ID ) > CLIENT_ID_LEN )
728 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
732 /* ID bereits vergeben? */
736 if( strcasecmp( c->id, ID ) == 0 )
738 /* die Server-ID gibt es bereits */
739 sprintf( str, "ID \"%s\" already registered!", ID );
740 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
741 Conn_Close( Client->conn_id, str, str, TRUE );
744 c = (CLIENT *)c->next;
748 } /* Client_CheckID */
751 GLOBAL CLIENT *Client_First( VOID )
753 /* Ersten Client liefern. */
759 GLOBAL CLIENT *Client_Next( CLIENT *c )
761 /* Naechsten Client liefern. Existiert keiner,
762 * so wird NULL geliefert. */
765 return (CLIENT *)c->next;
769 GLOBAL INT Client_UserCount( VOID )
771 return Count( CLIENT_USER );
772 } /* Client_UserCount */
775 GLOBAL INT Client_ServiceCount( VOID )
777 return Count( CLIENT_SERVICE );;
778 } /* Client_ServiceCount */
781 GLOBAL INT Client_ServerCount( VOID )
783 return Count( CLIENT_SERVER );
784 } /* Client_ServerCount */
787 GLOBAL INT Client_MyUserCount( VOID )
789 return MyCount( CLIENT_USER );
790 } /* Client_MyUserCount */
793 GLOBAL INT Client_MyServiceCount( VOID )
795 return MyCount( CLIENT_SERVICE );
796 } /* Client_MyServiceCount */
799 GLOBAL INT Client_MyServerCount( VOID )
801 return MyCount( CLIENT_SERVER );
802 } /* Client_MyServerCount */
805 GLOBAL INT Client_OperCount( VOID )
814 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
815 c = (CLIENT *)c->next;
818 } /* Client_OperCount */
821 GLOBAL INT Client_UnknownCount( VOID )
830 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
831 c = (CLIENT *)c->next;
834 } /* Client_UnknownCount */
837 GLOBAL BOOLEAN Client_IsValidNick( CHAR *Nick )
839 /* Ist der Nick gueltig? */
841 CHAR *ptr, goodchars[] = ";0123456789-";
843 assert( Nick != NULL );
845 if( Nick[0] == '#' ) return FALSE;
846 if( strchr( goodchars, Nick[0] )) return FALSE;
847 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
852 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
853 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
858 } /* Client_IsValidNick */
861 LOCAL INT Count( CLIENT_TYPE Type )
870 if( c && ( c->type == Type )) cnt++;
871 c = (CLIENT *)c->next;
877 LOCAL INT MyCount( CLIENT_TYPE Type )
886 if( c && ( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
887 c = (CLIENT *)c->next;
893 LOCAL CLIENT *New_Client_Struct( VOID )
895 /* Neue CLIENT-Struktur pre-initialisieren */
899 c = malloc( sizeof( CLIENT ));
902 Log( LOG_EMERG, "Can't allocate memory!" );
908 c->type = CLIENT_UNKNOWN;
910 c->introducer = NULL;
913 strcpy( c->pwd, "" );
914 strcpy( c->host, "" );
915 strcpy( c->user, "" );
916 strcpy( c->info, "" );
917 strcpy( c->modes, "" );
918 c->oper_by_me = FALSE;
922 strcpy( c->away, "" );
928 LOCAL VOID Generate_MyToken( CLIENT *Client )
937 if( c->mytoken == token )
939 /* Das Token wurde bereits vergeben */
944 else c = (CLIENT *)c->next;
946 Client->mytoken = token;
947 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
948 } /* Generate_MyToken */