]> arthur.barton.de Git - ngircd.git/blobdiff - src/ngircd/client.c
add const qualifier to pointers where possible
[ngircd.git] / src / ngircd / client.c
index ec3c6ce7c44d78e1c0b9c0b8336ef91915db5acc..076a0cb425f17c976be9b92e0e38649b9f688ab0 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2005 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2008 Alexander Barton (alex@barton.de)
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,8 +17,6 @@
 
 #include "portab.h"
 
-static char UNUSED id[] = "$Id: client.c,v 1.92 2006/10/06 19:57:56 fw Exp $";
-
 #include "imp.h"
 #include <assert.h>
 #include <unistd.h>
@@ -55,25 +53,24 @@ static char GetID_Buffer[GETID_LEN];
 
 static WHOWAS My_Whowas[MAX_WHOWAS];
 static int Last_Whowas = -1;
+static long Max_Users, My_Max_Users;
 
 
-static long Count PARAMS(( CLIENT_TYPE Type ));
-static long MyCount PARAMS(( CLIENT_TYPE Type ));
+static unsigned long Count PARAMS(( CLIENT_TYPE Type ));
+static unsigned long MyCount PARAMS(( CLIENT_TYPE Type ));
 
 static CLIENT *New_Client_Struct PARAMS(( void ));
 static void Generate_MyToken PARAMS(( CLIENT *Client ));
 static void Adjust_Counters PARAMS(( CLIENT *Client ));
 
 static CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
- CLIENT *TopServer, int Type, char *ID, char *User, char *Hostname,
- char *Info, int Hops, int Token, char *Modes, bool Idented));
-
-#ifndef Client_DestroyNow
-GLOBAL void Client_DestroyNow PARAMS((CLIENT *Client ));
-#endif
-
+                                      CLIENT *TopServer, int Type, const char *ID,
+                                      const char *User, const char *Hostname, const char *Info,
+                                      int Hops, int Token, const char *Modes,
+                                      bool Idented));
 
-long Max_Users = 0, My_Max_Users = 0;
+static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
+                                       bool SendQuit));
 
 
 GLOBAL void
@@ -98,9 +95,10 @@ Client_Init( void )
        This_Server->hops = 0;
 
        gethostname( This_Server->host, CLIENT_HOST_LEN );
-       h = gethostbyname( This_Server->host );
-       if( h ) strlcpy( This_Server->host, h->h_name, sizeof( This_Server->host ));
-
+       if (!Conf_NoDNS) {
+               h = gethostbyname( This_Server->host );
+               if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
+       }
        Client_SetID( This_Server, Conf_ServerName );
        Client_SetInfo( This_Server, Conf_ServerInfo );
 
@@ -144,7 +142,7 @@ Client_ThisServer( void )
  * @return New CLIENT structure.
  */
 GLOBAL CLIENT *
-Client_NewLocal(CONN_ID Idx, char *Hostname, int Type, bool Idented)
+Client_NewLocal(CONN_ID Idx, const char *Hostname, int Type, bool Idented)
 {
        return Init_New_Client(Idx, This_Server, NULL, Type, NULL, NULL,
                Hostname, NULL, 0, 0, NULL, Idented);
@@ -156,8 +154,8 @@ Client_NewLocal(CONN_ID Idx, char *Hostname, int Type, bool Idented)
  * @return New CLIENT structure.
  */
 GLOBAL CLIENT *
-Client_NewRemoteServer(CLIENT *Introducer, char *Hostname, CLIENT *TopServer,
- int Hops, int Token, char *Info, bool Idented)
+Client_NewRemoteServer(CLIENT *Introducer, const char *Hostname, CLIENT *TopServer,
+ int Hops, int Token, const char *Info, bool Idented)
 {
        return Init_New_Client(NONE, Introducer, TopServer, CLIENT_SERVER,
                Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented);
@@ -169,8 +167,8 @@ Client_NewRemoteServer(CLIENT *Introducer, char *Hostname, CLIENT *TopServer,
  * @return New CLIENT structure.
  */
 GLOBAL CLIENT *
-Client_NewRemoteUser(CLIENT *Introducer, char *Nick, int Hops, char *User,
- char *Hostname, int Token, char *Modes, char *Info, bool Idented)
+Client_NewRemoteUser(CLIENT *Introducer, const char *Nick, int Hops, const char *User,
+ const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented)
 {
        return Init_New_Client(NONE, Introducer, NULL, CLIENT_USER, Nick,
                User, Hostname, Info, Hops, Token, Modes, Idented);
@@ -184,8 +182,8 @@ Client_NewRemoteUser(CLIENT *Introducer, char *Nick, int Hops, char *User,
  */
 static CLIENT *
 Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
- int Type, char *ID, char *User, char *Hostname, char *Info, int Hops,
- int Token, char *Modes, bool Idented)
+ int Type, const char *ID, const char *User, const char *Hostname, const char *Info, int Hops,
+ int Token, const char *Modes, bool Idented)
 {
        CLIENT *client;
 
@@ -211,8 +209,8 @@ Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
        if( Modes ) Client_SetModes( client, Modes );
        if( Type == CLIENT_SERVER ) Generate_MyToken( client );
 
-       /* ist der User away? */
-       if( strchr( client->modes, 'a' )) strlcpy( client->away, DEFAULT_AWAY_MSG, sizeof( client->away ));
+       if( strchr( client->modes, 'a' ))
+               strlcpy( client->away, DEFAULT_AWAY_MSG, sizeof( client->away ));
 
        /* Verketten */
        client->next = (POINTER *)My_Clients;
@@ -226,12 +224,13 @@ Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
 
 
 GLOBAL void
-Client_Destroy( CLIENT *Client, char *LogMsg, char *FwdMsg, bool SendQuit )
+Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit )
 {
        /* Client entfernen. */
        
        CLIENT *last, *c;
-       char msg[LINE_LEN], *txt;
+       char msg[LINE_LEN];
+       const char *txt;
 
        assert( Client != NULL );
 
@@ -265,41 +264,8 @@ Client_Destroy( CLIENT *Client, char *LogMsg, char *FwdMsg, bool SendQuit )
                        if( last ) last->next = c->next;
                        else My_Clients = (CLIENT *)c->next;
 
-                       if( c->type == CLIENT_USER )
-                       {
-                               if( c->conn_id != NONE )
-                               {
-                                       /* Ein lokaler User */
-                                       Log( LOG_NOTICE, "User \"%s\" unregistered (connection %d): %s", Client_Mask( c ), c->conn_id, txt );
-
-                                       if( SendQuit )
-                                       {
-                                               /* Alle andere Server informieren! */
-                                               if( FwdMsg ) IRC_WriteStrServersPrefix( NULL, c, "QUIT :%s", FwdMsg );
-                                               else IRC_WriteStrServersPrefix( NULL, c, "QUIT :" );
-                                       }
-                               }
-                               else
-                               {
-                                       /* Remote User */
-                                       Log( LOG_DEBUG, "User \"%s\" unregistered: %s", Client_Mask( c ), txt );
-
-                                       if( SendQuit )
-                                       {
-                                               /* Andere Server informieren, ausser denen, die "in
-                                                * Richtung dem liegen", auf dem der User registriert
-                                                * ist. Von denen haben wir das QUIT ja wohl bekommen. */
-                                               if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :%s", FwdMsg );
-                                               else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "QUIT :" );
-                                       }
-                               }
-
-                               /* Unregister client from channels */
-                               Channel_Quit( c, FwdMsg ? FwdMsg : c->id );
-                               
-                               /* Register client in My_Whowas structure */
-                               Client_RegisterWhowas( c );
-                       }
+                       if(c->type == CLIENT_USER || c->type == CLIENT_SERVICE)
+                               Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
                        else if( c->type == CLIENT_SERVER )
                        {
                                if( c != This_Server )
@@ -337,48 +303,19 @@ Client_Destroy( CLIENT *Client, char *LogMsg, char *FwdMsg, bool SendQuit )
 
 
 GLOBAL void
-Client_DestroyNow( CLIENT *Client )
-{
-       /* Destroy client structure immediately. This function is only
-        * intended for the connection layer to remove client structures
-        * of connections that can't be established! */
-
-       CLIENT *last, *c;
-
-       assert( Client != NULL );
-
-       last = NULL;
-       c = My_Clients;
-       while( c )
-       {
-               if( c == Client )
-               {
-                       /* Wir haben den Client gefunden: entfernen */
-                       if( last ) last->next = c->next;
-                       else My_Clients = (CLIENT *)c->next;
-                       free( c );
-                       break;
-               }
-               last = c;
-               c = (CLIENT *)c->next;
-       }
-} /* Client_DestroyNow */
-
-
-GLOBAL void
-Client_SetHostname( CLIENT *Client, char *Hostname )
+Client_SetHostname( CLIENT *Client, const char *Hostname )
 {
        /* Hostname eines Clients setzen */
-       
+
        assert( Client != NULL );
        assert( Hostname != NULL );
-       
+
        strlcpy( Client->host, Hostname, sizeof( Client->host ));
 } /* Client_SetHostname */
 
 
 GLOBAL void
-Client_SetID( CLIENT *Client, char *ID )
+Client_SetID( CLIENT *Client, const char *ID )
 {
        /* Hostname eines Clients setzen, Hash-Wert berechnen */
 
@@ -393,13 +330,13 @@ Client_SetID( CLIENT *Client, char *ID )
 
 
 GLOBAL void
-Client_SetUser( CLIENT *Client, char *User, bool Idented )
+Client_SetUser( CLIENT *Client, const char *User, bool Idented )
 {
        /* Username eines Clients setzen */
 
        assert( Client != NULL );
        assert( User != NULL );
-       
+
        if( Idented ) strlcpy( Client->user, User, sizeof( Client->user ));
        else
        {
@@ -410,19 +347,19 @@ Client_SetUser( CLIENT *Client, char *User, bool Idented )
 
 
 GLOBAL void
-Client_SetInfo( CLIENT *Client, char *Info )
+Client_SetInfo( CLIENT *Client, const char *Info )
 {
        /* Hostname eines Clients setzen */
 
        assert( Client != NULL );
        assert( Info != NULL );
-       
+
        strlcpy( Client->info, Info, sizeof( Client->info ));
 } /* Client_SetInfo */
 
 
 GLOBAL void
-Client_SetModes( CLIENT *Client, char *Modes )
+Client_SetModes( CLIENT *Client, const char *Modes )
 {
        /* Modes eines Clients setzen */
 
@@ -434,7 +371,7 @@ Client_SetModes( CLIENT *Client, char *Modes )
 
 
 GLOBAL void
-Client_SetFlags( CLIENT *Client, char *Flags )
+Client_SetFlags( CLIENT *Client, const char *Flags )
 {
        /* Flags eines Clients setzen */
 
@@ -446,19 +383,19 @@ Client_SetFlags( CLIENT *Client, char *Flags )
 
 
 GLOBAL void
-Client_SetPassword( CLIENT *Client, char *Pwd )
+Client_SetPassword( CLIENT *Client, const char *Pwd )
 {
        /* Von einem Client geliefertes Passwort */
 
        assert( Client != NULL );
        assert( Pwd != NULL );
-       
+
        strlcpy( Client->pwd, Pwd, sizeof( Client->pwd ));
 } /* Client_SetPassword */
 
 
 GLOBAL void
-Client_SetAway( CLIENT *Client, char *Txt )
+Client_SetAway( CLIENT *Client, const char *Txt )
 {
        /* Set AWAY reason of client */
 
@@ -466,7 +403,8 @@ Client_SetAway( CLIENT *Client, char *Txt )
        assert( Txt != NULL );
 
        strlcpy( Client->away, Txt, sizeof( Client->away ));
-       Log( LOG_DEBUG, "User \"%s\" is away: %s", Client_Mask( Client ), Txt );
+       LogDebug("%s \"%s\" is away: %s", Client_TypeText(Client),
+                Client_Mask(Client), Txt);
 } /* Client_SetAway */
 
 
@@ -522,7 +460,7 @@ Client_ModeAdd( CLIENT *Client, char Mode )
         */
 
        char x[2];
-       
+
        assert( Client != NULL );
 
        x[0] = Mode; x[1] = '\0';
@@ -564,7 +502,7 @@ Client_ModeDel( CLIENT *Client, char Mode )
 
 
 GLOBAL CLIENT *
-Client_Search( char *Nick )
+Client_Search( const char *Nick )
 {
        /* return Client-Structure that has the corresponding Nick.
         * If none is found, return NULL.
@@ -641,7 +579,8 @@ Client_ID( CLIENT *Client )
        assert( Client != NULL );
 
 #ifdef DEBUG
-       if( Client->type == CLIENT_USER ) assert( strlen( Client->id ) < CLIENT_NICK_LEN );
+       if(Client->type == CLIENT_USER)
+               assert(strlen(Client->id) < Conf_MaxNickLength);
 #endif
                                                   
        if( Client->id[0] ) return Client->id;
@@ -661,8 +600,7 @@ GLOBAL char *
 Client_User( CLIENT *Client )
 {
        assert( Client != NULL );
-       if( Client->user[0] ) return Client->user;
-       else return "~";
+       return Client->user[0] ? Client->user : "~";
 } /* Client_User */
 
 
@@ -734,11 +672,13 @@ GLOBAL CLIENT *
 Client_NextHop( CLIENT *Client )
 {
        CLIENT *c;
-       
+
        assert( Client != NULL );
 
        c = Client;
-       while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server )) c = c->introducer;
+       while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server ))
+               c = c->introducer;
+
        return c;
 } /* Client_NextHop */
 
@@ -750,7 +690,7 @@ Client_Mask( CLIENT *Client )
         * Prefixe benoetigt wird. */
 
        assert( Client != NULL );
-       
+
        if( Client->type == CLIENT_SERVER ) return Client->id;
 
        snprintf( GetID_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user, Client->host );
@@ -795,12 +735,9 @@ Client_Away( CLIENT *Client )
 GLOBAL bool
 Client_CheckNick( CLIENT *Client, char *Nick )
 {
-       /* Nick ueberpruefen */
-
        assert( Client != NULL );
        assert( Nick != NULL );
-       
-       /* Nick ungueltig? */
+
        if( ! Client_IsValidNick( Nick ))
        {
                IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
@@ -913,13 +850,12 @@ Client_MyServiceCount( void )
 } /* Client_MyServiceCount */
 
 
-GLOBAL long
+GLOBAL unsigned long
 Client_MyServerCount( void )
 {
        CLIENT *c;
-       long cnt;
+       unsigned long cnt = 0;
 
-       cnt = 0;
        c = My_Clients;
        while( c )
        {
@@ -930,13 +866,12 @@ Client_MyServerCount( void )
 } /* Client_MyServerCount */
 
 
-GLOBAL long
+GLOBAL unsigned long
 Client_OperCount( void )
 {
        CLIENT *c;
-       long cnt;
+       unsigned long cnt = 0;
 
-       cnt = 0;
        c = My_Clients;
        while( c )
        {
@@ -947,19 +882,19 @@ Client_OperCount( void )
 } /* Client_OperCount */
 
 
-GLOBAL long
+GLOBAL unsigned long
 Client_UnknownCount( void )
 {
        CLIENT *c;
-       long cnt;
+       unsigned long cnt = 0;
 
-       cnt = 0;
        c = My_Clients;
        while( c )
        {
                if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
                c = (CLIENT *)c->next;
        }
+
        return cnt;
 } /* Client_UnknownCount */
 
@@ -988,7 +923,7 @@ Client_IsValidNick( const char *Nick )
 
        if( Nick[0] == '#' ) return false;
        if( strchr( goodchars, Nick[0] )) return false;
-       if( strlen( Nick ) >= CLIENT_NICK_LEN ) return false;
+       if( strlen( Nick ) >= Conf_MaxNickLength) return false;
 
        ptr = Nick;
        while( *ptr )
@@ -1034,13 +969,12 @@ Client_StartTime(CLIENT *Client)
 } /* Client_Uptime */
 
 
-static long
+static unsigned long
 Count( CLIENT_TYPE Type )
 {
        CLIENT *c;
-       long cnt;
+       unsigned long cnt = 0;
 
-       cnt = 0;
        c = My_Clients;
        while( c )
        {
@@ -1051,13 +985,12 @@ Count( CLIENT_TYPE Type )
 } /* Count */
 
 
-static long
+static unsigned long
 MyCount( CLIENT_TYPE Type )
 {
        CLIENT *c;
-       long cnt;
+       unsigned long cnt = 0;
 
-       cnt = 0;
        c = My_Clients;
        while( c )
        {
@@ -1072,9 +1005,9 @@ static CLIENT *
 New_Client_Struct( void )
 {
        /* Neue CLIENT-Struktur pre-initialisieren */
-       
+
        CLIENT *c;
-       
+
        c = (CLIENT *)malloc( sizeof( CLIENT ));
        if( ! c )
        {
@@ -1115,7 +1048,7 @@ Generate_MyToken( CLIENT *Client )
                else c = (CLIENT *)c->next;
        }
        Client->mytoken = token;
-       Log( LOG_DEBUG, "Assigned token %d to server \"%s\".", token, Client->id );
+       LogDebug("Assigned token %d to server \"%s\".", token, Client->id);
 } /* Generate_MyToken */
 
 
@@ -1127,7 +1060,7 @@ Adjust_Counters( CLIENT *Client )
        assert( Client != NULL );
 
        if( Client->type != CLIENT_USER ) return;
-       
+
        if( Client->conn_id != NONE )
        {
                /* Local connection */
@@ -1150,7 +1083,7 @@ Client_RegisterWhowas( CLIENT *Client )
 {
        int slot;
        time_t now;
-       
+
        assert( Client != NULL );
 
        now = time(NULL);
@@ -1164,7 +1097,7 @@ Client_RegisterWhowas( CLIENT *Client )
 #ifdef DEBUG
        Log( LOG_DEBUG, "Saving WHOWAS information to slot %d ...", slot );
 #endif
-       
+
        My_Whowas[slot].time = now;
        strlcpy( My_Whowas[slot].id, Client_ID( Client ),
                 sizeof( My_Whowas[slot].id ));
@@ -1176,9 +1109,76 @@ Client_RegisterWhowas( CLIENT *Client )
                 sizeof( My_Whowas[slot].info ));
        strlcpy( My_Whowas[slot].server, Client_ID( Client_Introducer( Client )),
                 sizeof( My_Whowas[slot].server ));
-       
+
        Last_Whowas = slot;
 } /* Client_RegisterWhowas */
 
 
+GLOBAL char *
+Client_TypeText(CLIENT *Client)
+{
+       assert(Client != NULL);
+       switch (Client_Type(Client)) {
+               case CLIENT_USER:
+                       return "User";
+                       break;
+               case CLIENT_SERVICE:
+                       return "Service";
+                       break;
+               case CLIENT_SERVER:
+                       return "Server";
+                       break;
+               default:
+                       return "Client";
+       }
+} /* Client_TypeText */
+
+
+/**
+ * Destroy user or service client.
+ */
+static void
+Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool SendQuit)
+{
+       if(Client->conn_id != NONE) {
+               /* Local (directly connected) client */
+               Log(LOG_NOTICE,
+                   "%s \"%s\" unregistered (connection %d): %s",
+                   Client_TypeText(Client), Client_Mask(Client),
+                   Client->conn_id, Txt);
+
+               if (SendQuit) {
+                       /* Inforam all the other servers */
+                       if (FwdMsg)
+                               IRC_WriteStrServersPrefix(NULL,
+                                               Client, "QUIT :%s", FwdMsg );
+                       else
+                               IRC_WriteStrServersPrefix(NULL,
+                                               Client, "QUIT :");
+               }
+       } else {
+               /* Remote client */
+               LogDebug("%s \"%s\" unregistered: %s",
+                        Client_TypeText(Client), Client_Mask(Client), Txt);
+
+               if(SendQuit) {
+                       /* Inform all the other servers, but the ones in the
+                        * direction we got the QUIT from */
+                       if(FwdMsg)
+                               IRC_WriteStrServersPrefix(Client_NextHop(Client),
+                                               Client, "QUIT :%s", FwdMsg );
+                       else
+                               IRC_WriteStrServersPrefix(Client_NextHop(Client),
+                                               Client, "QUIT :" );
+               }
+       }
+
+       /* Unregister client from channels */
+       Channel_Quit(Client, FwdMsg ? FwdMsg : Client->id);
+
+       /* Register client in My_Whowas structure */
+       Client_RegisterWhowas(Client);
+} /* Destroy_UserOrService */
+
+
 /* -eof- */