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.60 2002/09/03 18:54:31 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 /* Modes 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_SetFlags( CLIENT *Client, CHAR *Flags )
369 /* Flags eines Clients setzen */
371 assert( Client != NULL );
372 assert( Flags != NULL );
374 strncpy( Client->flags, Flags, CLIENT_FLAGS_LEN - 1 );
375 Client->modes[CLIENT_FLAGS_LEN - 1] = '\0';
376 } /* Client_SetFlags */
380 Client_SetPassword( CLIENT *Client, CHAR *Pwd )
382 /* Von einem Client geliefertes Passwort */
384 assert( Client != NULL );
385 assert( Pwd != NULL );
387 strncpy( Client->pwd, Pwd, CLIENT_PASS_LEN - 1 );
388 Client->pwd[CLIENT_PASS_LEN - 1] = '\0';
389 } /* Client_SetPassword */
393 Client_SetAway( CLIENT *Client, CHAR *Txt )
395 /* Von einem Client gelieferte AWAY-Nachricht */
397 assert( Client != NULL );
401 /* Client AWAY setzen */
402 strncpy( Client->away, Txt, CLIENT_AWAY_LEN - 1 );
403 Client->away[CLIENT_AWAY_LEN - 1] = '\0';
404 Client_ModeAdd( Client, 'a' );
405 Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
410 Client_ModeDel( Client, 'a' );
411 Log( LOG_DEBUG, "User \"%s\" is no longer away.", Client_Mask( Client ));
413 } /* Client_SetAway */
417 Client_SetType( CLIENT *Client, INT Type )
419 assert( Client != NULL );
421 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
422 } /* Client_SetType */
426 Client_SetHops( CLIENT *Client, INT Hops )
428 assert( Client != NULL );
430 } /* Client_SetHops */
434 Client_SetToken( CLIENT *Client, INT Token )
436 assert( Client != NULL );
437 Client->token = Token;
438 } /* Client_SetToken */
442 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
444 assert( Client != NULL );
445 assert( Introducer != NULL );
446 Client->introducer = Introducer;
447 } /* Client_SetIntroducer */
451 Client_SetOperByMe( CLIENT *Client, BOOLEAN OperByMe )
453 assert( Client != NULL );
454 Client->oper_by_me = OperByMe;
455 } /* Client_SetOperByMe */
459 Client_ModeAdd( CLIENT *Client, CHAR Mode )
461 /* Mode soll gesetzt werden. TRUE wird geliefert, wenn der
462 * Mode neu gesetzt wurde, FALSE, wenn der Client den Mode
467 assert( Client != NULL );
469 x[0] = Mode; x[1] = '\0';
470 if( ! strchr( Client->modes, x[0] ))
472 /* Client hat den Mode noch nicht -> setzen */
473 strcat( Client->modes, x );
477 } /* Client_ModeAdd */
481 Client_ModeDel( CLIENT *Client, CHAR Mode )
483 /* Mode soll geloescht werden. TRUE wird geliefert, wenn der
484 * Mode entfernt wurde, FALSE, wenn der Client den Mode
485 * ueberhaupt nicht hatte. */
489 assert( Client != NULL );
491 x[0] = Mode; x[1] = '\0';
493 p = strchr( Client->modes, x[0] );
494 if( ! p ) return FALSE;
496 /* Client hat den Mode -> loeschen */
503 } /* Client_ModeDel */
507 Client_GetFromConn( CONN_ID Idx )
509 /* Client-Struktur, die zur lokalen Verbindung Idx gehoert,
510 * liefern. Wird keine gefunden, so wird NULL geliefert. */
519 if( c->conn_id == Idx ) return c;
520 c = (CLIENT *)c->next;
523 } /* Client_GetFromConn */
527 Client_Search( CHAR *Nick )
529 /* Client-Struktur, die den entsprechenden Nick hat, liefern.
530 * Wird keine gefunden, so wird NULL geliefert. */
532 CHAR search_id[CLIENT_ID_LEN], *ptr;
536 assert( Nick != NULL );
538 /* Nick kopieren und ggf. Host-Mask abschneiden */
539 strncpy( search_id, Nick, CLIENT_ID_LEN - 1 );
540 search_id[CLIENT_ID_LEN - 1] = '\0';
541 ptr = strchr( search_id, '!' );
542 if( ptr ) *ptr = '\0';
544 search_hash = Hash( search_id );
549 if( c->hash == search_hash )
551 /* lt. Hash-Wert: Treffer! */
552 if( strcasecmp( c->id, search_id ) == 0 ) return c;
554 c = (CLIENT *)c->next;
557 } /* Client_Search */
561 Client_GetFromToken( CLIENT *Client, INT Token )
563 /* Client-Struktur, die den entsprechenden Introducer (=Client)
564 * und das gegebene Token hat, liefern. Wird keine gefunden,
565 * so wird NULL geliefert. */
569 assert( Client != NULL );
575 if(( c->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c->token == Token )) return c;
576 c = (CLIENT *)c->next;
579 } /* Client_GetFromToken */
583 Client_Type( CLIENT *Client )
585 assert( Client != NULL );
591 Client_Conn( CLIENT *Client )
593 assert( Client != NULL );
594 return Client->conn_id;
599 Client_ID( CLIENT *Client )
601 assert( Client != NULL );
604 if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
607 if( Client->id[0] ) return Client->id;
613 Client_Info( CLIENT *Client )
615 assert( Client != NULL );
621 Client_User( CLIENT *Client )
623 assert( Client != NULL );
624 if( Client->user[0] ) return Client->user;
630 Client_Hostname( CLIENT *Client )
632 assert( Client != NULL );
634 } /* Client_Hostname */
638 Client_Password( CLIENT *Client )
640 assert( Client != NULL );
642 } /* Client_Password */
646 Client_Modes( CLIENT *Client )
648 assert( Client != NULL );
649 return Client->modes;
654 Client_Flags( CLIENT *Client )
656 assert( Client != NULL );
657 return Client->flags;
662 Client_OperByMe( CLIENT *Client )
664 assert( Client != NULL );
665 return Client->oper_by_me;
666 } /* Client_OperByMe */
670 Client_Hops( CLIENT *Client )
672 assert( Client != NULL );
678 Client_Token( CLIENT *Client )
680 assert( Client != NULL );
681 return Client->token;
686 Client_MyToken( CLIENT *Client )
688 assert( Client != NULL );
689 return Client->mytoken;
690 } /* Client_MyToken */
694 Client_NextHop( CLIENT *Client )
698 assert( Client != NULL );
701 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
703 } /* Client_NextHop */
707 Client_Mask( CLIENT *Client )
709 /* Client-"ID" liefern, wie sie z.B. fuer
710 * Prefixe benoetigt wird. */
712 assert( Client != NULL );
714 if( Client->type == CLIENT_SERVER ) return Client->id;
716 sprintf( GetID_Buffer, "%s!%s@%s", Client->id, Client->user, Client->host );
722 Client_Introducer( CLIENT *Client )
724 assert( Client != NULL );
725 return Client->introducer;
726 } /* Client_Introducer */
730 Client_TopServer( CLIENT *Client )
732 assert( Client != NULL );
733 return Client->topserver;
734 } /* Client_TopServer */
738 Client_HasMode( CLIENT *Client, CHAR Mode )
740 assert( Client != NULL );
741 return strchr( Client->modes, Mode ) != NULL;
742 } /* Client_HasMode */
746 Client_Away( CLIENT *Client )
748 /* AWAY-Text liefern */
750 assert( Client != NULL );
756 Client_CheckNick( CLIENT *Client, CHAR *Nick )
758 /* Nick ueberpruefen */
760 assert( Client != NULL );
761 assert( Nick != NULL );
763 /* Nick ungueltig? */
764 if( ! Client_IsValidNick( Nick ))
766 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
770 /* Nick bereits vergeben? */
771 if( Client_Search( Nick ))
773 /* den Nick gibt es bereits */
774 IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
779 } /* Client_CheckNick */
783 Client_CheckID( CLIENT *Client, CHAR *ID )
785 /* Nick ueberpruefen */
787 CHAR str[COMMAND_LEN];
790 assert( Client != NULL );
791 assert( Client->conn_id > NONE );
792 assert( ID != NULL );
795 if( strlen( ID ) > CLIENT_ID_LEN )
797 IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), ID );
801 /* ID bereits vergeben? */
805 if( strcasecmp( c->id, ID ) == 0 )
807 /* die Server-ID gibt es bereits */
808 sprintf( str, "ID \"%s\" already registered!", ID );
809 Log( LOG_ERR, "%s (on connection %d)", str, Client->conn_id );
810 Conn_Close( Client->conn_id, str, str, TRUE );
813 c = (CLIENT *)c->next;
817 } /* Client_CheckID */
823 /* Ersten Client liefern. */
830 Client_Next( CLIENT *c )
832 /* Naechsten Client liefern. Existiert keiner,
833 * so wird NULL geliefert. */
836 return (CLIENT *)c->next;
841 Client_UserCount( VOID )
843 return Count( CLIENT_USER );
844 } /* Client_UserCount */
848 Client_ServiceCount( VOID )
850 return Count( CLIENT_SERVICE );;
851 } /* Client_ServiceCount */
855 Client_ServerCount( VOID )
857 return Count( CLIENT_SERVER );
858 } /* Client_ServerCount */
862 Client_MyUserCount( VOID )
864 return MyCount( CLIENT_USER );
865 } /* Client_MyUserCount */
869 Client_MyServiceCount( VOID )
871 return MyCount( CLIENT_SERVICE );
872 } /* Client_MyServiceCount */
876 Client_MyServerCount( VOID )
885 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
886 c = (CLIENT *)c->next;
889 } /* Client_MyServerCount */
893 Client_OperCount( VOID )
902 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
903 c = (CLIENT *)c->next;
906 } /* Client_OperCount */
910 Client_UnknownCount( VOID )
919 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
920 c = (CLIENT *)c->next;
923 } /* Client_UnknownCount */
927 Client_IsValidNick( CHAR *Nick )
929 /* Ist der Nick gueltig? */
931 CHAR *ptr, goodchars[20];
933 assert( Nick != NULL );
935 strcpy( goodchars, ";0123456789-" );
937 if( Nick[0] == '#' ) return FALSE;
938 if( strchr( goodchars, Nick[0] )) return FALSE;
939 if( strlen( Nick ) >= CLIENT_NICK_LEN ) return FALSE;
944 if(( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
945 if(( *ptr > '}' ) && ( ! strchr( goodchars, *ptr ))) return FALSE;
950 } /* Client_IsValidNick */
954 Count( CLIENT_TYPE Type )
963 if( c->type == Type ) cnt++;
964 c = (CLIENT *)c->next;
971 MyCount( CLIENT_TYPE Type )
980 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
981 c = (CLIENT *)c->next;
988 New_Client_Struct( VOID )
990 /* Neue CLIENT-Struktur pre-initialisieren */
994 c = malloc( sizeof( CLIENT ));
997 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1003 c->type = CLIENT_UNKNOWN;
1005 c->introducer = NULL;
1006 c->topserver = NULL;
1007 strcpy( c->id, "" );
1008 strcpy( c->pwd, "" );
1009 strcpy( c->host, "" );
1010 strcpy( c->user, "" );
1011 strcpy( c->info, "" );
1012 strcpy( c->modes, "" );
1013 c->oper_by_me = FALSE;
1017 strcpy( c->away, "" );
1018 strcpy( c->flags, "" );
1025 Generate_MyToken( CLIENT *Client )
1034 if( c->mytoken == token )
1036 /* Das Token wurde bereits vergeben */
1041 else c = (CLIENT *)c->next;
1043 Client->mytoken = token;
1044 Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
1045 } /* Generate_MyToken */