]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/client.c
Introduce new function IRC_WriteErrClient()
[ngircd-alex.git] / src / ngircd / client.c
index 4728c7a4672ac802d944dc599d23031f75e50d60..cf0720b9942e81631a84fc0900fb259903b8ac99 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2012 Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
  *
  * 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
@@ -41,6 +41,7 @@
 #include "hash.h"
 #include "irc-write.h"
 #include "log.h"
+#include "match.h"
 #include "messages.h"
 
 #include <exp.h>
@@ -86,7 +87,7 @@ Client_Init( void )
                exit( 1 );
        }
 
-       /* Client-Struktur dieses Servers */
+       /* Client structure for this server */
        This_Server->next = NULL;
        This_Server->type = CLIENT_SERVER;
        This_Server->conn_id = NONE;
@@ -216,7 +217,7 @@ Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
        if (Type == CLIENT_SERVER)
                Generate_MyToken(client);
 
-       if (strchr(client->modes, 'a'))
+       if (Client_HasMode(client, 'a'))
                strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
 
        client->next = (POINTER *)My_Clients;
@@ -239,9 +240,9 @@ Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool Sen
 
        assert( Client != NULL );
 
-       if( LogMsg ) txt = LogMsg;
-       else txt = FwdMsg;
-       if( ! txt ) txt = "Reason unknown.";
+       txt = LogMsg ? LogMsg : FwdMsg;
+       if (!txt)
+               txt = "Reason unknown";
 
        /* netsplit message */
        if( Client->type == CLIENT_SERVER ) {
@@ -281,10 +282,15 @@ Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool Sen
                                Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
                        else if( c->type == CLIENT_SERVER )
                        {
-                               if( c != This_Server )
-                               {
-                                       if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
-                                       else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
+                               if (c != This_Server) {
+                                       if (c->conn_id != NONE)
+                                               Log(LOG_NOTICE|LOG_snotice,
+                                                   "Server \"%s\" unregistered (connection %d): %s.",
+                                               c->id, c->conn_id, txt);
+                                       else
+                                               Log(LOG_NOTICE|LOG_snotice,
+                                                   "Server \"%s\" unregistered: %s.",
+                                                   c->id, txt);
                                }
 
                                /* inform other servers */
@@ -296,16 +302,24 @@ Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool Sen
                        }
                        else
                        {
-                               if( c->conn_id != NONE )
-                               {
-                                       if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
-                                       else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
+                               if (c->conn_id != NONE) {
+                                       if (c->id[0])
+                                               Log(LOG_NOTICE,
+                                                   "Client \"%s\" unregistered (connection %d): %s.",
+                                                   c->id, c->conn_id, txt);
+                                       else
+                                               Log(LOG_NOTICE,
+                                                   "Client unregistered (connection %d): %s.",
+                                                   c->conn_id, txt);
                                } else {
-                                       Log(LOG_WARNING, "Unregistered unknown client \"%s\": %s",
-                                                               c->id[0] ? c->id : "(No Nick)", txt );
+                                       Log(LOG_WARNING,
+                                           "Unregistered unknown client \"%s\": %s",
+                                           c->id[0] ? c->id : "(No Nick)", txt);
                                }
                        }
 
+                       if (c->cloaked)
+                               free(c->cloaked);
                        free( c );
                        break;
                }
@@ -501,7 +515,7 @@ GLOBAL bool
 Client_ModeAdd( CLIENT *Client, char Mode )
 {
        /* Set Mode.
-        * If Client already alread had Mode, return false.
+        * If Client already had Mode, return false.
         * If the Mode was newly set, return true.
         */
 
@@ -510,7 +524,7 @@ Client_ModeAdd( CLIENT *Client, char Mode )
        assert( Client != NULL );
 
        x[0] = Mode; x[1] = '\0';
-       if (!strchr( Client->modes, x[0])) {
+       if (!Client_HasMode(Client, x[0])) {
                strlcat( Client->modes, x, sizeof( Client->modes ));
                return true;
        }
@@ -545,13 +559,14 @@ Client_ModeDel( CLIENT *Client, char Mode )
 } /* Client_ModeDel */
 
 
+/**
+ * Search CLIENT structure of a given nick name.
+ *
+ * @return Pointer to CLIENT structure or NULL if not found.
+ */
 GLOBAL CLIENT *
 Client_Search( const char *Nick )
 {
-       /* return Client-Structure that has the corresponding Nick.
-        * If none is found, return NULL.
-        */
-
        char search_id[CLIENT_ID_LEN], *ptr;
        CLIENT *c = NULL;
        UINT32 search_hash;
@@ -572,7 +587,39 @@ Client_Search( const char *Nick )
                c = (CLIENT *)c->next;
        }
        return NULL;
-} /* Client_Search */
+}
+
+
+/**
+ * Search first CLIENT structure matching a given mask of a server.
+ *
+ * The order of servers is arbitrary, but this function makes sure that the
+ * local server is always returned if the mask matches it.
+ *
+ * @return Pointer to CLIENT structure or NULL if no server could be found.
+ */
+GLOBAL CLIENT *
+Client_SearchServer(const char *Mask)
+{
+       CLIENT *c;
+
+       assert(Mask != NULL);
+
+       /* First check if mask matches the local server */
+       if (MatchCaseInsensitive(Mask, Client_ID(Client_ThisServer())))
+               return Client_ThisServer();
+
+       c = My_Clients;
+       while (c) {
+               if (Client_Type(c) == CLIENT_SERVER) {
+                       /* This is a server: check if Mask matches */
+                       if (MatchCaseInsensitive(Mask, c->id))
+                               return c;
+               }
+               c = (CLIENT *)c->next;
+       }
+       return NULL;
+}
 
 
 /**
@@ -671,7 +718,6 @@ Client_OrigUser(CLIENT *Client) {
 
 #endif
 
-
 /**
  * Return the hostname of a client.
  * @param Client Pointer to client structure
@@ -682,42 +728,93 @@ Client_Hostname(CLIENT *Client)
 {
        assert (Client != NULL);
        return Client->host;
-} /* Client_Hostname */
+}
 
+/**
+ * Return the cloaked hostname of a client, if set.
+ * @param Client Pointer to the client structure.
+ * @return Pointer to the cloaked hostname or NULL if not set.
+ */
+GLOBAL char *
+Client_HostnameCloaked(CLIENT *Client)
+{
+       assert(Client != NULL);
+       return Client->cloaked;
+}
 
 /**
- * Get potentially cloaked hostname of a client.
+ * Get (potentially cloaked) hostname of a client to display it to other users.
  *
  * If the client has not enabled cloaking, the real hostname is used.
- * Please note that this function uses a global static buffer, so you can't
- * nest invocations without overwriting earlier results!
  *
  * @param Client Pointer to client structure
  * @return Pointer to client hostname
  */
 GLOBAL char *
-Client_HostnameCloaked(CLIENT *Client)
+Client_HostnameDisplayed(CLIENT *Client)
 {
-       static char Cloak_Buffer[CLIENT_HOST_LEN];
-
        assert(Client != NULL);
 
+       /* Client isn't cloaked at all, return real hostname: */
        if (!Client_HasMode(Client, 'x'))
                return Client_Hostname(Client);
 
-       /* Do simple mapping to the server ID? */
-       if (!*Conf_CloakHostModeX)
-               return Client_ID(Client->introducer);
+       /* Use an already saved cloaked hostname, if there is one */
+       if (Client->cloaked)
+               return Client->cloaked;
 
-       strlcpy(Cloak_Buffer, Client->host, CLIENT_HOST_LEN);
-       strlcat(Cloak_Buffer, Conf_CloakHostSalt, CLIENT_HOST_LEN);
+       Client_UpdateCloakedHostname(Client, NULL, NULL);
+       return Client->cloaked;
+}
 
-       snprintf(Cloak_Buffer, CLIENT_HOST_LEN, Conf_CloakHostModeX,
-                Hash(Cloak_Buffer));
+/**
+ * Update (and generate, if necessary) the cloaked hostname of a client.
+ *
+ * The newly set cloaked hostname is announced in the network using METADATA
+ * commands to peers that support this feature.
+ *
+ * @param Client The client of which the cloaked hostname should be updated.
+ * @param Origin The originator of the hostname change, or NULL if this server.
+ * @param Hostname The new cloaked hostname, or NULL if it should be generated.
+ */
+GLOBAL void
+Client_UpdateCloakedHostname(CLIENT *Client, CLIENT *Origin,
+                            const char *Hostname)
+{
+       char Cloak_Buffer[CLIENT_HOST_LEN];
 
-       return Cloak_Buffer;
-} /* Client_HostnameCloaked */
+       assert(Client != NULL);
+       if (!Origin)
+               Origin = Client_ThisServer();
 
+       if (!Client->cloaked) {
+               Client->cloaked = malloc(CLIENT_HOST_LEN);
+               if (!Client->cloaked)
+                       return;
+       }
+
+       if (!Hostname) {
+               /* Generate new cloaked hostname */
+               if (*Conf_CloakHostModeX) {
+                       strlcpy(Cloak_Buffer, Client->host,
+                               sizeof(Cloak_Buffer));
+                       strlcat(Cloak_Buffer, Conf_CloakHostSalt,
+                               sizeof(Cloak_Buffer));
+                       snprintf(Client->cloaked, CLIENT_HOST_LEN,
+                                Conf_CloakHostModeX, Hash(Cloak_Buffer));
+               } else
+                       strlcpy(Client->cloaked, Client_ID(Client->introducer),
+                               CLIENT_HOST_LEN);
+       } else
+               strlcpy(Client->cloaked, Hostname, CLIENT_HOST_LEN);
+       LogDebug("Cloaked hostname of \"%s\" updated to \"%s\"",
+                Client_ID(Client), Client->cloaked);
+
+       /* Inform other servers in the network */
+       IRC_WriteStrServersPrefixFlag(Client_NextHop(Origin), Origin, 'M',
+                                     "METADATA %s cloakhost :%s",
+                                     Client_ID(Client), Client->cloaked);
+}
 
 GLOBAL char *
 Client_Modes( CLIENT *Client )
@@ -830,7 +927,7 @@ Client_MaskCloaked(CLIENT *Client)
                return Client_Mask(Client);
 
        snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user,
-                Client_HostnameCloaked(Client));
+                Client_HostnameDisplayed(Client));
 
        return Mask_Buffer;
 } /* Client_MaskCloaked */
@@ -860,6 +957,14 @@ Client_HasMode( CLIENT *Client, char Mode )
 } /* Client_HasMode */
 
 
+GLOBAL bool
+Client_HasFlag( CLIENT *Client, char Flag )
+{
+       assert( Client != NULL );
+       return strchr( Client->flags, Flag ) != NULL;
+} /* Client_HasFlag */
+
+
 GLOBAL char *
 Client_Away( CLIENT *Client )
 {
@@ -875,7 +980,7 @@ Client_Away( CLIENT *Client )
  * the appropriate error messages.
  *
  * @param      Client Client that wants to change the nickname.
- * @param      Nick New nick name.
+ * @param      Nick New nickname.
  * @returns    true if nickname is valid, false otherwise.
  */
 GLOBAL bool
@@ -886,20 +991,20 @@ Client_CheckNick(CLIENT *Client, char *Nick)
 
        if (!Client_IsValidNick(Nick)) {
                if (strlen(Nick ) >= Conf_MaxNickLength)
-                       IRC_WriteStrClient(Client, ERR_NICKNAMETOOLONG_MSG,
+                       IRC_WriteErrClient(Client, ERR_NICKNAMETOOLONG_MSG,
                                           Client_ID(Client), Nick,
                                           Conf_MaxNickLength - 1);
                else
-                       IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
+                       IRC_WriteErrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
                                           Client_ID(Client), Nick);
                return false;
        }
 
        if (Client_Type(Client) != CLIENT_SERVER
            && Client_Type(Client) != CLIENT_SERVICE) {
-               /* Make sure that this isn't a restricted/forbidden nick name */
+               /* Make sure that this isn't a restricted/forbidden nickname */
                if (Conf_NickIsBlocked(Nick)) {
-                       IRC_WriteStrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
+                       IRC_WriteErrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
                                           Client_ID(Client), Nick);
                        return false;
                }
@@ -907,7 +1012,7 @@ Client_CheckNick(CLIENT *Client, char *Nick)
 
        /* Nickname already registered? */
        if (Client_Search(Nick)) {
-               IRC_WriteStrClient(Client, ERR_NICKNAMEINUSE_MSG,
+               IRC_WriteErrClient(Client, ERR_NICKNAMEINUSE_MSG,
                        Client_ID(Client), Nick);
                return false;
        }
@@ -928,7 +1033,8 @@ Client_CheckID( CLIENT *Client, char *ID )
 
        /* ID too long? */
        if (strlen(ID) > CLIENT_ID_LEN) {
-               IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID(Client), ID);
+               IRC_WriteErrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
+                                  Client_ID(Client), ID);
                return false;
        }
 
@@ -1026,7 +1132,8 @@ Client_OperCount( void )
        c = My_Clients;
        while( c )
        {
-               if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
+               if (c && c->type == CLIENT_USER && Client_HasMode(c, 'o' ))
+                       cnt++;
                c = (CLIENT *)c->next;
        }
        return cnt;
@@ -1236,8 +1343,6 @@ MyCount( CLIENT_TYPE Type )
 static CLIENT *
 New_Client_Struct( void )
 {
-       /* Neue CLIENT-Struktur pre-initialisieren */
-
        CLIENT *c;
 
        c = (CLIENT *)malloc( sizeof( CLIENT ));
@@ -1272,7 +1377,7 @@ Generate_MyToken( CLIENT *Client )
        {
                if( c->mytoken == token )
                {
-                       /* Das Token wurde bereits vergeben */
+                       /* The token is already in use */
                        token++;
                        c = My_Clients;
                        continue;
@@ -1339,7 +1444,7 @@ Client_RegisterWhowas( CLIENT *Client )
                 sizeof( My_Whowas[slot].id ));
        strlcpy( My_Whowas[slot].user, Client_User( Client ),
                 sizeof( My_Whowas[slot].user ));
-       strlcpy( My_Whowas[slot].host, Client_HostnameCloaked( Client ),
+       strlcpy( My_Whowas[slot].host, Client_HostnameDisplayed( Client ),
                 sizeof( My_Whowas[slot].host ));
        strlcpy( My_Whowas[slot].info, Client_Info( Client ),
                 sizeof( My_Whowas[slot].info ));
@@ -1379,7 +1484,7 @@ Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool
        if(Client->conn_id != NONE) {
                /* Local (directly connected) client */
                Log(LOG_NOTICE,
-                   "%s \"%s\" unregistered (connection %d): %s",
+                   "%s \"%s\" unregistered (connection %d): %s.",
                    Client_TypeText(Client), Client_Mask(Client),
                    Client->conn_id, Txt);
                Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
@@ -1397,7 +1502,7 @@ Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool
                }
        } else {
                /* Remote client */
-               LogDebug("%s \"%s\" unregistered: %s",
+               LogDebug("%s \"%s\" unregistered: %s.",
                         Client_TypeText(Client), Client_Mask(Client), Txt);
 
                if(SendQuit) {
@@ -1423,9 +1528,6 @@ Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool
 /**
  * Introduce a new user or service client to a remote server.
  *
- * This function differentiates between RFC1459 and RFC2813 server links and
- * generates the appropriate commands to register the new user or service.
- *
  * @param To           The remote server to inform.
  * @param Prefix       Prefix for the generated commands.
  * @param data         CLIENT structure of the new client.
@@ -1434,43 +1536,92 @@ static void
 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
 {
        CLIENT *c = (CLIENT *)data;
+
+       (void)Client_Announce(To, Prefix, c);
+
+} /* cb_introduceClient */
+
+
+/**
+ * Announce an user or service to a server.
+ *
+ * This function differentiates between RFC1459 and RFC2813 server links and
+ * generates the appropriate commands to register the user or service.
+ *
+ * @param Client       Server
+ * @param Prefix       Prefix for the generated commands
+ * @param User         User to announce
+ */
+GLOBAL bool
+Client_Announce(CLIENT * Client, CLIENT * Prefix, CLIENT * User)
+{
        CONN_ID conn;
        char *modes, *user, *host;
 
-       modes = Client_Modes(c);
-       user = Client_User(c) ? Client_User(c) : "-";
-       host = Client_Hostname(c) ? Client_Hostname(c) : "-";
+       modes = Client_Modes(User);
+       user = Client_User(User) ? Client_User(User) : "-";
+       host = Client_Hostname(User) ? Client_Hostname(User) : "-";
 
-       conn = Client_Conn(To);
+       conn = Client_Conn(Client);
        if (Conn_Options(conn) & CONN_RFC1459) {
                /* RFC 1459 mode: separate NICK and USER commands */
-               Conn_WriteStr(conn, "NICK %s :%d", Client_ID(c),
-                             Client_Hops(c) + 1);
-               Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
-                             Client_ID(c), user, host,
-                             Client_ID(Client_Introducer(c)), Client_Info(c));
-               if (modes[0])
-                       Conn_WriteStr(conn, ":%s MODE %s +%s",
-                                     Client_ID(c), Client_ID(c), modes);
+               if (! Conn_WriteStr(conn, "NICK %s :%d",
+                                   Client_ID(User), Client_Hops(User) + 1))
+                       return DISCONNECTED;
+               if (! Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
+                                    Client_ID(User), user, host,
+                                    Client_ID(Client_Introducer(User)),
+                                    Client_Info(User)))
+                       return DISCONNECTED;
+               if (modes[0]) {
+                       if (! Conn_WriteStr(conn, ":%s MODE %s +%s",
+                                    Client_ID(User), Client_ID(User),
+                                    modes))
+                               return DISCONNECTED;
+               }
        } else {
                /* RFC 2813 mode: one combined NICK or SERVICE command */
-               if (Client_Type(c) == CLIENT_SERVICE
-                   && strchr(Client_Flags(To), 'S'))
-                       IRC_WriteStrClientPrefix(To, Prefix,
-                                                "SERVICE %s %d * +%s %d :%s",
-                                                Client_Mask(c),
-                                                Client_MyToken(Client_Introducer(c)),
-                                                Client_Modes(c), Client_Hops(c) + 1,
-                                                Client_Info(c));
-               else
-                       IRC_WriteStrClientPrefix(To, Prefix,
-                                                "NICK %s %d %s %s %d +%s :%s",
-                                                Client_ID(c), Client_Hops(c) + 1,
-                                                user, host,
-                                                Client_MyToken(Client_Introducer(c)),
-                                                modes, Client_Info(c));
+               if (Client_Type(User) == CLIENT_SERVICE
+                   && Client_HasFlag(Client, 'S')) {
+                       if (!IRC_WriteStrClientPrefix(Client, Prefix,
+                                       "SERVICE %s %d * +%s %d :%s",
+                                       Client_Mask(User),
+                                       Client_MyToken(Client_Introducer(User)),
+                                       modes, Client_Hops(User) + 1,
+                                       Client_Info(User)))
+                               return DISCONNECTED;
+               } else {
+                       if (!IRC_WriteStrClientPrefix(Client, Prefix,
+                                       "NICK %s %d %s %s %d +%s :%s",
+                                       Client_ID(User), Client_Hops(User) + 1,
+                                       user, host,
+                                       Client_MyToken(Client_Introducer(User)),
+                                       modes, Client_Info(User)))
+                               return DISCONNECTED;
+               }
        }
-} /* cb_introduceClient */
+
+       if (Client_HasFlag(Client, 'M')) {
+               /* Synchronize metadata */
+               if (Client_HostnameCloaked(User)) {
+                       if (!IRC_WriteStrClientPrefix(Client, Prefix,
+                                       "METADATA %s cloakhost :%s",
+                                       Client_ID(User),
+                                       Client_HostnameCloaked(User)))
+                               return DISCONNECTED;
+               }
+
+               if (Conn_GetCertFp(Client_Conn(User))) {
+                       if (!IRC_WriteStrClientPrefix(Client, Prefix,
+                                       "METADATA %s certfp :%s",
+                                       Client_ID(User),
+                                       Conn_GetCertFp(Client_Conn(User))))
+                               return DISCONNECTED;
+               }
+       }
+
+       return CONNECTED;
+} /* Client_Announce */
 
 
 #ifdef DEBUG