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.59 2002/06/10 21:09:39 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 if( NGIRCd_Restart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, FALSE );
106 else Client_Destroy( This_Server, "Server going down.", NULL, FALSE );
113 next = (CLIENT *)c->next;
117 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
122 Client_ThisServer( VOID )
125 } /* Client_ThisServer */
129 Client_NewLocal( CONN_ID Idx, CHAR *Hostname, INT Type, BOOLEAN Idented )
131 /* Neuen lokalen Client erzeugen: Wrapper-Funktion fuer Client_New(). */
132 return Client_New( Idx, This_Server, NULL, Type, NULL, NULL, Hostname, NULL, 0, 0, NULL, Idented );
133 } /* Client_NewLocal */
137 Client_NewRemoteServer( CLIENT *Introducer, CHAR *Hostname, CLIENT *TopServer, INT Hops, INT Token, CHAR *Info, BOOLEAN Idented )
139 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
140 return Client_New( NONE, Introducer, TopServer, CLIENT_SERVER, Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented );
141 } /* Client_NewRemoteServer */
145 Client_NewRemoteUser( CLIENT *Introducer, CHAR *Nick, INT Hops, CHAR *User, CHAR *Hostname, INT Token, CHAR *Modes, CHAR *Info, BOOLEAN Idented )
147 /* Neuen Remote-Client erzeugen: Wrapper-Funktion fuer Client_New (). */
148 return Client_New( NONE, Introducer, NULL, CLIENT_USER, Nick, User, Hostname, Info, Hops, Token, Modes, Idented );
149 } /* Client_NewRemoteUser */
153 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 )
157 assert( Idx >= NONE );
158 assert( Introducer != NULL );
159 assert( Hostname != NULL );
161 client = New_Client_Struct( );
162 if( ! client ) return NULL;
165 client->conn_id = Idx;
166 client->introducer = Introducer;
167 client->topserver = TopServer;
169 if( ID ) Client_SetID( client, ID );
170 if( User ) Client_SetUser( client, User, Idented );
171 if( Hostname ) Client_SetHostname( client, Hostname );
172 if( Info ) Client_SetInfo( client, Info );
174 client->token = Token;
175 if( Modes ) Client_SetModes( client, Modes );
176 if( Type == CLIENT_SERVER ) Generate_MyToken( client );
178 /* ist der User away? */
179 if( strchr( client->modes, 'a' )) strcpy( client->away, DEFAULT_AWAY_MSG );
182 client->next = (POINTER *)My_Clients;
190 Client_Destroy( CLIENT *Client, CHAR *LogMsg, CHAR *FwdMsg, BOOLEAN SendQuit )
192 /* Client entfernen. */
195 CHAR msg[LINE_LEN], *txt;
197 assert( Client != NULL );
199 if( LogMsg ) txt = LogMsg;
201 if( ! txt ) txt = "Reason unknown.";
203 /* Netz-Split-Nachricht vorbereiten (noch nicht optimal) */
204 if( Client->type == CLIENT_SERVER ) sprintf( msg, "%s: lost server %s", This_Server->id, Client->id );
210 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
212 /* der Client, der geloescht wird ist ein Server. Der Client, den wir gerade
213 * pruefen, ist ein Child von diesem und muss daher auch entfernt werden */
214 Client_Destroy( c, NULL, msg, FALSE );
221 /* Wir haben den Client gefunden: entfernen */
222 if( last ) last->next = c->next;
223 else My_Clients = (CLIENT *)c->next;
225 if( c->type == CLIENT_USER )
227 if( c->conn_id != NONE )
229 /* Ein lokaler User */
230 Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
234 /* Alle andere Server informieren! */
235 if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
236 else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
242 Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
246 /* Andere Server informieren, ausser denen, die "in
247 * Richtung dem liegen", auf dem der User registriert
248 * ist. Von denen haben wir das QUIT ja wohl bekommen. */
249 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
250 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
253 Channel_Quit( c, FwdMsg ? FwdMsg : c->id );
255 else if( c->type == CLIENT_SERVER )
257 if( c != This_Server )
259 if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
260 else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
263 /* andere Server informieren */
266 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
267 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
272 if( c->conn_id != NONE )
274 if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
275 else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
279 if( c->id[0] ) Log( LOG_WARNING, "Unregistered unknown client \"%s\": %s", c->id, txt );
280 else Log( LOG_WARNING, "Unregistered unknown client: %s", c->id, txt );
288 c = (CLIENT *)c->next;
290 } /* Client_Destroy */
294 Client_SetHostname( CLIENT *Client, CHAR *Hostname )
296 /* Hostname eines Clients setzen */
298 assert( Client != NULL );
299 assert( Hostname != NULL );
301 strncpy( Client->host, Hostname, CLIENT_HOST_LEN - 1 );
302 Client->host[CLIENT_HOST_LEN - 1] = '\0';
303 } /* Client_SetHostname */
307 Client_SetID( CLIENT *Client, CHAR *ID )
309 /* Hostname eines Clients setzen, Hash-Wert berechnen */
311 assert( Client != NULL );
312 assert( ID != NULL );
314 strncpy( Client->id, ID, CLIENT_ID_LEN - 1 );
315 Client->id[CLIENT_ID_LEN - 1] = '\0';
318 Client->hash = Hash( Client->id );
323 Client_SetUser( CLIENT *Client, CHAR *User, BOOLEAN Idented )
325 /* Username eines Clients setzen */
327 assert( Client != NULL );
328 assert( User != NULL );
330 if( Idented ) strncpy( Client->user, User, CLIENT_USER_LEN - 1 );
333 Client->user[0] = '~';
334 strncpy( Client->user + 1, User, CLIENT_USER_LEN - 2 );
336 Client->user[CLIENT_USER_LEN - 1] = '\0';
337 } /* Client_SetUser */
341 Client_SetInfo( CLIENT *Client, CHAR *Info )
343 /* Hostname eines Clients setzen */
345 assert( Client != NULL );
346 assert( Info != NULL );
348 strncpy( Client->info, Info, CLIENT_INFO_LEN - 1 );
349 Client->info[CLIENT_INFO_LEN - 1] = '\0';
350 } /* Client_SetInfo */
354 Client_SetModes( CLIENT *Client, CHAR *Modes )
356 /* Hostname eines Clients setzen */
358 assert( Client != NULL );
359 assert( Modes != NULL );
361 strncpy( Client->modes, Modes, CLIENT_MODE_LEN - 1 );
362 Client->modes[CLIENT_MODE_LEN - 1] = '\0';
363 } /* Client_SetModes */
367 Client_SetPassword( CLIENT *Client, CHAR *Pwd )
369 /* Von einem Client geliefertes Passwort */
371 assert( Client != NULL );
372 assert( Pwd != NULL );
374 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
375 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
376 } /* Client_SetPassword */
380 Client_SetAway( CLIENT *Client, CHAR *Txt )
382 /* Von einem Client gelieferte AWAY-Nachricht */
384 assert( Client != NULL );
388 /* Client AWAY setzen */
389 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
390 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
391 Client_ModeAdd( Client, 'a' );
392 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
397 Client_ModeDel( Client, 'a' );
398 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
400 } /* Client_SetAway */
404 Client_SetType( CLIENT *Client, INT Type )
406 assert( Client != NULL );
408 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
409 } /* Client_SetType */
413 Client_SetHops( CLIENT *Client, INT Hops )
415 assert( Client != NULL );
417 } /* Client_SetHops */
421 Client_SetToken( CLIENT *Client, INT Token )
423 assert( Client != NULL );
424 Client->token = Token;
425 } /* Client_SetToken */
429 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
431 assert( Client != NULL );
432 assert( Introducer != NULL );
433 Client->introducer = Introducer;
434 } /* Client_SetIntroducer */
438 Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
440 assert( Client != NULL );
441 Client->oper_by_me = OperByMe;
442 } /* Client_SetOperByMe */
446 Client_ModeAdd( CLIENT *Client, CHAR Mode )
448 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
449 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
454 assert( Client != NULL );
456 x[0] = Mode; x[1] = '\0';
457 if( ! strchr( Client->modes, x[0] ))
459 /* Client hat den Mode noch nicht -> setzen */
460 strcat( Client->modes, x );
464 } /* Client_ModeAdd */
468 Client_ModeDel( CLIENT *Client, CHAR Mode )
470 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
471 * Mode entfernt wurde, FALSE, wenn der Client den Mode
472 * ueberhaupt nicht hatte. */
476 assert( Client != NULL );
478 x[0] = Mode; x[1] = '\0';
480 p = strchr( Client->modes, x[0] );
481 if( ! p ) return FALSE;
483 /* Client hat den Mode -> loeschen */
490 } /* Client_ModeDel */
494 Client_GetFromConn( CONN_ID Idx )
496 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
497 * liefern. Wird keine gefunden, so wird NULL geliefert. */
506 if( c->conn_id == Idx ) return c;
507 c = (CLIENT *)c->next;
510 } /* Client_GetFromConn */
514 Client_Search( CHAR *Nick )
516 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
517 * Wird keine gefunden, so wird NULL geliefert. */
519 CHAR search_id[CLIENT_ID_LEN], *ptr;
523 assert( Nick != NULL );
525 /* Nick kopieren und ggf. Host-Mask abschneiden */
526 strncpy( search_id, Nick, CLIENT_ID_LEN - 1 );
527 search_id[CLIENT_ID_LEN - 1] = '\0';
528 ptr = strchr( search_id, '!' );
529 if( ptr ) *ptr = '\0';
531 search_hash = Hash( search_id );
536 if( c->hash == search_hash )
538 /* lt. Hash-Wert: Treffer! */
539 if( strcasecmp( c->id, search_id ) == 0 ) return c;
541 c = (CLIENT *)c->next;
544 } /* Client_Search */
548 Client_GetFromToken( CLIENT *Client, INT Token )
550 /* Client-Struktur, die den entsprechenden Introducer (=Client)
551 * und das gegebene Token hat, liefern. Wird keine gefunden,
552 * so wird NULL geliefert. */
556 assert( Client != NULL );
562 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
563 c = (CLIENT *)c->next;
566 } /* Client_GetFromToken */
570 Client_Type( CLIENT *Client )
572 assert( Client != NULL );
578 Client_Conn( CLIENT *Client )
580 assert( Client != NULL );
581 return Client->conn_id;
586 Client_ID( CLIENT *Client )
588 assert( Client != NULL );
591 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
594 if( Client->id[0] ) return Client->id;
600 Client_Info( CLIENT *Client )
602 assert( Client != NULL );
608 Client_User( CLIENT *Client )
610 assert( Client != NULL );
611 if( Client->user[0] ) return Client->user;
617 Client_Hostname( CLIENT *Client )
619 assert( Client != NULL );
621 } /* Client_Hostname */
625 Client_Password( CLIENT *Client )
627 assert( Client != NULL );
629 } /* Client_Password */
633 Client_Modes( CLIENT *Client )
635 assert( Client != NULL );
636 return Client->modes;
641 Client_OperByMe( CLIENT *Client )
643 assert( Client != NULL );
644 return Client->oper_by_me;
645 } /* Client_OperByMe */
649 Client_Hops( CLIENT *Client )
651 assert( Client != NULL );
657 Client_Token( CLIENT *Client )
659 assert( Client != NULL );
660 return Client->token;
665 Client_MyToken( CLIENT *Client )
667 assert( Client != NULL );
668 return Client->mytoken;
669 } /* Client_MyToken */
673 Client_NextHop( CLIENT *Client )
677 assert( Client != NULL );
680 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
682 } /* Client_NextHop */
686 Client_Mask( CLIENT *Client )
688 /* Client-"ID" liefern, wie sie z.B. fuer
689 * Prefixe benoetigt wird. */
691 assert( Client != NULL );
693 if( Client->type == CLIENT_SERVER ) return Client->id;
695 sprintf( GetID_Buffer, "%s!%s@%s", Client->id, Client->user, Client->host );
701 Client_Introducer( CLIENT *Client )
703 assert( Client != NULL );
704 return Client->introducer;
705 } /* Client_Introducer */
709 Client_TopServer( CLIENT *Client )
711 assert( Client != NULL );
712 return Client->topserver;
713 } /* Client_TopServer */
717 Client_HasMode( CLIENT *Client, CHAR Mode )
719 assert( Client != NULL );
720 return strchr( Client->modes, Mode ) != NULL;
721 } /* Client_HasMode */
725 Client_Away( CLIENT *Client )
727 /* AWAY-Text liefern */
729 assert( Client != NULL );
735 Client_CheckNick( CLIENT *Client, CHAR *Nick )
737 /* Nick ueberpruefen */
739 assert( Client != NULL );
740 assert( Nick != NULL );
742 /* Nick ungueltig? */
743 if( ! Client_IsValidNick( Nick ))
745 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
749 /* Nick bereits vergeben? */
750 if( Client_Search( Nick ))
752 /* den Nick gibt es bereits */
753 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
758 } /* Client_CheckNick */
762 Client_CheckID( CLIENT *Client, CHAR *ID )
764 /* Nick ueberpruefen */
766 CHAR str[COMMAND_LEN];
769 assert( Client != NULL );
770 assert( Client->conn_id > NONE );
771 assert( ID != NULL );
774 if( strlen( ID ) > CLIENT_ID_LEN )
776 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
780 /* ID bereits vergeben? */
784 if( strcasecmp( c->id, ID ) == 0 )
786 /* die Server-ID gibt es bereits */
787 sprintf( str, "ID \"%s\" already registered!", ID );
788 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
789 Conn_Close( Client->conn_id, str, str, TRUE );
792 c = (CLIENT *)c->next;
796 } /* Client_CheckID */
802 /* Ersten Client liefern. */
809 Client_Next( CLIENT *c )
811 /* Naechsten Client liefern. Existiert keiner,
812 * so wird NULL geliefert. */
815 return (CLIENT *)c->next;
820 Client_UserCount( VOID )
822 return Count( CLIENT_USER );
823 } /* Client_UserCount */
827 Client_ServiceCount( VOID )
829 return Count( CLIENT_SERVICE );;
830 } /* Client_ServiceCount */
834 Client_ServerCount( VOID )
836 return Count( CLIENT_SERVER );
837 } /* Client_ServerCount */
841 Client_MyUserCount( VOID )
843 return MyCount( CLIENT_USER );
844 } /* Client_MyUserCount */
848 Client_MyServiceCount( VOID )
850 return MyCount( CLIENT_SERVICE );
851 } /* Client_MyServiceCount */
855 Client_MyServerCount( VOID )
864 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
865 c = (CLIENT *)c->next;
868 } /* Client_MyServerCount */
872 Client_OperCount( VOID )
881 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
882 c = (CLIENT *)c->next;
885 } /* Client_OperCount */
889 Client_UnknownCount( VOID )
898 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
899 c = (CLIENT *)c->next;
902 } /* Client_UnknownCount */
906 Client_IsValidNick( CHAR *Nick )
908 /* Ist der Nick gueltig? */
910 CHAR *ptr, goodchars[20];
912 assert( Nick != NULL );
914 strcpy( goodchars, ";0123456789-" );
916 if( Nick[0] == '#' ) return FALSE;
917 if( strchr( goodchars, Nick[0] )) return FALSE;
918 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
923 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
924 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
929 } /* Client_IsValidNick */
933 Count( CLIENT_TYPE Type )
942 if( c->type == Type ) cnt++;
943 c = (CLIENT *)c->next;
950 MyCount( CLIENT_TYPE Type )
959 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
960 c = (CLIENT *)c->next;
967 New_Client_Struct( VOID )
969 /* Neue CLIENT-Struktur pre-initialisieren */
973 c = malloc( sizeof( CLIENT ));
976 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
982 c->type = CLIENT_UNKNOWN;
984 c->introducer = NULL;
987 strcpy( c->pwd, "" );
988 strcpy( c->host, "" );
989 strcpy( c->user, "" );
990 strcpy( c->info, "" );
991 strcpy( c->modes, "" );
992 c->oper_by_me = FALSE;
996 strcpy( c->away, "" );
1003 Generate_MyToken( CLIENT *Client )
1012 if( c->mytoken == token )
1014 /* Das Token wurde bereits vergeben */
1019 else c = (CLIENT *)c->next;
1021 Client->mytoken = token;
1022 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
1023 } /* Generate_MyToken */