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.50 2002/03/12 23:43:56 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 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
192 if( Client->type == CLIENT_SERVER ) sprintf( msg, "%s: lost server %s", This_Server->id, Client->id );
198 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
200 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
201 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
202 Client_Destroy( c, NULL, msg, FALSE );
209 /* Wir haben den Client gefunden: entfernen */
210 if( last ) last->next = c->next;
211 else My_Clients = c->next;
213 if( c->type == CLIENT_USER )
215 if( c->conn_id != NONE )
217 /* Ein lokaler User */
218 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
222 /* Alle andere Server informieren! */
223 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
224 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
230 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
234 /* Andere Server informieren, ausser denen, die "in
235 * Richtung dem liegen", auf dem der User registriert
236 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
237 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
238 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
241 Channel_RemoveClient( c, FwdMsg ? FwdMsg : c->id );
243 else if( c->type == CLIENT_SERVER )
245 if( c != This_Server )
247 if( c->conn_id != NONE ) Log( LOG_NOTICE, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
248 else Log( LOG_NOTICE, "Server \"%s\" unregistered: %s", c->id, txt );
251 /* andere Server informieren */
254 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
255 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
260 if( c->conn_id != NONE )
262 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
263 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
267 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
268 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
278 } /* Client_Destroy */
281 GLOBAL VOID Client_SetHostname( CLIENT *Client, CHAR *Hostname )
283 /* Hostname eines Clients setzen */
285 assert( Client != NULL );
286 assert( Hostname != NULL );
288 strncpy( Client->host, Hostname, CLIENT_HOST_LEN - 1 );
289 Client->host[CLIENT_HOST_LEN - 1] = '\0';
290 } /* Client_SetHostname */
293 GLOBAL VOID Client_SetID( CLIENT *Client, CHAR *ID )
295 /* Hostname eines Clients setzen */
297 assert( Client != NULL );
298 assert( ID != NULL );
300 strncpy( Client->id, ID, CLIENT_ID_LEN - 1 );
301 Client->id[CLIENT_ID_LEN - 1] = '\0';
305 GLOBAL VOID Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
307 /* Username eines Clients setzen */
309 assert( Client != NULL );
310 assert( User != NULL );
312 if( Idented ) strncpy( Client->user, User, CLIENT_USER_LEN - 1 );
315 Client->user[0] = '~';
316 strncpy( Client->user + 1, User, CLIENT_USER_LEN - 2 );
318 Client->user[CLIENT_USER_LEN - 1] = '\0';
319 } /* Client_SetUser */
322 GLOBAL VOID Client_SetInfo( CLIENT *Client, CHAR *Info )
324 /* Hostname eines Clients setzen */
326 assert( Client != NULL );
327 assert( Info != NULL );
329 strncpy( Client->info, Info, CLIENT_INFO_LEN - 1 );
330 Client->info[CLIENT_INFO_LEN - 1] = '\0';
331 } /* Client_SetInfo */
334 GLOBAL VOID Client_SetModes( CLIENT *Client, CHAR *Modes )
336 /* Hostname eines Clients setzen */
338 assert( Client != NULL );
339 assert( Modes != NULL );
341 strncpy( Client->modes, Modes, CLIENT_MODE_LEN - 1 );
342 Client->modes[CLIENT_MODE_LEN - 1] = '\0';
343 } /* Client_SetModes */
346 GLOBAL VOID Client_SetPassword( CLIENT *Client, CHAR *Pwd )
348 /* Von einem Client geliefertes Passwort */
350 assert( Client != NULL );
351 assert( Pwd != NULL );
353 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
354 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
355 } /* Client_SetPassword */
358 GLOBAL VOID Client_SetAway( CLIENT *Client, CHAR *Txt )
360 /* Von einem Client gelieferte AWAY-Nachricht */
362 assert( Client != NULL );
366 /* Client AWAY setzen */
367 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
368 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
369 Client_ModeAdd( Client, 'a' );
370 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
375 Client_ModeDel( Client, 'a' );
376 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
378 } /* Client_SetAway */
381 GLOBAL VOID Client_SetType( CLIENT *Client, INT Type )
383 assert( Client != NULL );
385 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
386 } /* Client_SetType */
389 GLOBAL VOID Client_SetHops( CLIENT *Client, INT Hops )
391 assert( Client != NULL );
393 } /* Client_SetHops */
396 GLOBAL VOID Client_SetToken( CLIENT *Client, INT Token )
398 assert( Client != NULL );
399 Client->token = Token;
400 } /* Client_SetToken */
403 GLOBAL VOID Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
405 assert( Client != NULL );
406 assert( Introducer != NULL );
407 Client->introducer = Introducer;
408 } /* Client_SetIntroducer */
411 GLOBAL VOID Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
413 assert( Client != NULL );
414 Client->oper_by_me = OperByMe;
415 } /* Client_SetOperByMe */
418 GLOBAL BOOLEAN Client_ModeAdd( CLIENT *Client, CHAR Mode )
420 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
421 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
426 assert( Client != NULL );
428 x[0] = Mode; x[1] = '\0';
429 if( ! strchr( Client->modes, x[0] ))
431 /* Client hat den Mode noch nicht -> setzen */
432 strcat( Client->modes, x );
436 } /* Client_ModeAdd */
439 GLOBAL BOOLEAN Client_ModeDel( CLIENT *Client, CHAR Mode )
441 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
442 * Mode entfernt wurde, FALSE, wenn der Client den Mode
443 * ueberhaupt nicht hatte. */
447 assert( Client != NULL );
449 x[0] = Mode; x[1] = '\0';
451 p = strchr( Client->modes, x[0] );
452 if( ! p ) return FALSE;
454 /* Client hat den Mode -> loeschen */
461 } /* Client_ModeDel */
464 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx )
466 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
467 * liefern. Wird keine gefunden, so wird NULL geliefert. */
476 if( c->conn_id == Idx ) return c;
480 } /* Client_GetFromConn */
483 GLOBAL CLIENT *Client_GetFromID( CHAR *Nick )
485 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
486 * Wird keine gefunden, so wird NULL geliefert. */
488 CHAR n[CLIENT_ID_LEN], *ptr;
491 assert( Nick != NULL );
493 /* Nick kopieren und ggf. Host-Mask abschneiden */
494 strncpy( n, Nick, CLIENT_ID_LEN - 1 );
495 n[CLIENT_ID_LEN - 1] = '\0';
496 ptr = strchr( n, '!' );
497 if( ptr ) *ptr = '\0';
502 if( strcasecmp( c->id, n ) == 0 ) return c;
506 } /* Client_GetFromID */
509 GLOBAL CLIENT *Client_GetFromToken( CLIENT *Client, INT Token )
511 /* Client-Struktur, die den entsprechenden Introducer (=Client)
512 * und das gegebene Token hat, liefern. Wird keine gefunden,
513 * so wird NULL geliefert. */
517 assert( Client != NULL );
523 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
527 } /* Client_GetFromToken */
530 GLOBAL INT Client_Type( CLIENT *Client )
532 assert( Client != NULL );
537 GLOBAL CONN_ID Client_Conn( CLIENT *Client )
539 assert( Client != NULL );
540 return Client->conn_id;
544 GLOBAL CHAR *Client_ID( CLIENT *Client )
546 assert( Client != NULL );
549 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
552 if( Client->id[0] ) return Client->id;
557 GLOBAL CHAR *Client_Info( CLIENT *Client )
559 assert( Client != NULL );
564 GLOBAL CHAR *Client_User( CLIENT *Client )
566 assert( Client != NULL );
567 if( Client->user ) return Client->user;
572 GLOBAL CHAR *Client_Hostname( CLIENT *Client )
574 assert( Client != NULL );
576 } /* Client_Hostname */
579 GLOBAL CHAR *Client_Password( CLIENT *Client )
581 assert( Client != NULL );
583 } /* Client_Password */
586 GLOBAL CHAR *Client_Modes( CLIENT *Client )
588 assert( Client != NULL );
589 return Client->modes;
593 GLOBAL BOOLEAN Client_OperByMe( CLIENT *Client )
595 assert( Client != NULL );
596 return Client->oper_by_me;
597 } /* Client_OperByMe */
600 GLOBAL INT Client_Hops( CLIENT *Client )
602 assert( Client != NULL );
607 GLOBAL INT Client_Token( CLIENT *Client )
609 assert( Client != NULL );
610 return Client->token;
614 GLOBAL INT Client_MyToken( CLIENT *Client )
616 assert( Client != NULL );
617 return Client->mytoken;
618 } /* Client_MyToken */
621 GLOBAL CLIENT *Client_NextHop( CLIENT *Client )
625 assert( Client != NULL );
628 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
630 } /* Client_NextHop */
633 GLOBAL CHAR *Client_Mask( CLIENT *Client )
635 /* Client-"ID" liefern, wie sie z.B. fuer
636 * Prefixe benoetigt wird. */
638 assert( Client != NULL );
640 if( Client->type == CLIENT_SERVER ) return Client->id;
642 sprintf( GetID_Buffer, "%s!%s@%s", Client->id, Client->user, Client->host );
647 GLOBAL CLIENT *Client_Introducer( CLIENT *Client )
649 assert( Client != NULL );
650 return Client->introducer;
651 } /* Client_Introducer */
654 GLOBAL CLIENT *Client_TopServer( CLIENT *Client )
656 assert( Client != NULL );
657 return Client->topserver;
658 } /* Client_TopServer */
661 GLOBAL BOOLEAN Client_HasMode( CLIENT *Client, CHAR Mode )
663 assert( Client != NULL );
664 return strchr( Client->modes, Mode ) != NULL;
665 } /* Client_HasMode */
668 GLOBAL CHAR *Client_Away( CLIENT *Client )
670 /* AWAY-Text liefern */
672 assert( Client != NULL );
677 GLOBAL BOOLEAN Client_CheckNick( CLIENT *Client, CHAR *Nick )
679 /* Nick ueberpruefen */
683 assert( Client != NULL );
684 assert( Nick != NULL );
686 /* Nick ungueltig? */
687 if( ! Client_IsValidNick( Nick ))
689 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
693 /* Nick bereits vergeben? */
697 if( strcasecmp( c->id, Nick ) == 0 )
699 /* den Nick gibt es bereits */
700 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
707 } /* Client_CheckNick */
710 GLOBAL BOOLEAN Client_CheckID( CLIENT *Client, CHAR *ID )
712 /* Nick ueberpruefen */
714 CHAR str[COMMAND_LEN];
717 assert( Client != NULL );
718 assert( Client->conn_id > NONE );
719 assert( ID != NULL );
722 if( strlen( ID ) > CLIENT_ID_LEN )
724 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
728 /* ID bereits vergeben? */
732 if( strcasecmp( c->id, ID ) == 0 )
734 /* die Server-ID gibt es bereits */
735 sprintf( str, "ID \"%s\" already registered!", ID );
736 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
737 Conn_Close( Client->conn_id, str, str, TRUE );
744 } /* Client_CheckID */
747 GLOBAL CLIENT *Client_Search( CHAR *ID )
749 /* Client suchen, auf den ID passt */
753 assert( ID != NULL );
758 if( strcasecmp( c->id, ID ) == 0 ) return c;
763 } /* Client_Search */
766 GLOBAL CLIENT *Client_First( VOID )
768 /* Ersten Client liefern. */
774 GLOBAL CLIENT *Client_Next( CLIENT *c )
776 /* Naechsten Client liefern. Existiert keiner,
777 * so wird NULL geliefert. */
784 GLOBAL INT Client_UserCount( VOID )
786 return Count( CLIENT_USER );
787 } /* Client_UserCount */
790 GLOBAL INT Client_ServiceCount( VOID )
792 return Count( CLIENT_SERVICE );;
793 } /* Client_ServiceCount */
796 GLOBAL INT Client_ServerCount( VOID )
798 return Count( CLIENT_SERVER );
799 } /* Client_ServerCount */
802 GLOBAL INT Client_MyUserCount( VOID )
804 return MyCount( CLIENT_USER );
805 } /* Client_MyUserCount */
808 GLOBAL INT Client_MyServiceCount( VOID )
810 return MyCount( CLIENT_SERVICE );
811 } /* Client_MyServiceCount */
814 GLOBAL INT Client_MyServerCount( VOID )
816 return MyCount( CLIENT_SERVER );
817 } /* Client_MyServerCount */
820 GLOBAL INT Client_OperCount( VOID )
829 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
833 } /* Client_OperCount */
836 GLOBAL INT Client_UnknownCount( VOID )
845 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
849 } /* Client_UnknownCount */
852 GLOBAL BOOLEAN Client_IsValidNick( CHAR *Nick )
854 /* Ist der Nick gueltig? */
856 CHAR *ptr, goodchars[] = ";0123456789-";
858 assert( Nick != NULL );
860 if( Nick[0] == '#' ) return FALSE;
861 if( strchr( goodchars, Nick[0] )) return FALSE;
862 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
867 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
868 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
873 } /* Client_IsValidNick */
876 LOCAL INT Count( CLIENT_TYPE Type )
885 if( c && ( c->type == Type )) cnt++;
892 LOCAL INT MyCount( CLIENT_TYPE Type )
901 if( c && ( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
908 LOCAL CLIENT *New_Client_Struct( VOID )
910 /* Neue CLIENT-Struktur pre-initialisieren */
914 c = malloc( sizeof( CLIENT ));
917 Log( LOG_EMERG, "Can't allocate memory!" );
922 c->type = CLIENT_UNKNOWN;
924 c->introducer = NULL;
927 strcpy( c->pwd, "" );
928 strcpy( c->host, "" );
929 strcpy( c->user, "" );
930 strcpy( c->info, "" );
931 strcpy( c->modes, "" );
932 c->oper_by_me = FALSE;
936 strcpy( c->away, "" );
942 LOCAL VOID Generate_MyToken( CLIENT *Client )
951 if( c->mytoken == token )
953 /* Das Token wurde bereits vergeben */
960 Client->mytoken = token;
961 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
962 } /* Generate_MyToken */