2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 * Please read the file COPYING, README and AUTHORS for more information.
40 #include "conn-func.h"
42 #include "irc-write.h"
49 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
51 static CLIENT *This_Server, *My_Clients;
53 static WHOWAS My_Whowas[MAX_WHOWAS];
54 static int Last_Whowas = -1;
55 static long Max_Users, My_Max_Users;
58 static unsigned long Count PARAMS(( CLIENT_TYPE Type ));
59 static unsigned long MyCount PARAMS(( CLIENT_TYPE Type ));
61 static CLIENT *New_Client_Struct PARAMS(( void ));
62 static void Generate_MyToken PARAMS(( CLIENT *Client ));
63 static void Adjust_Counters PARAMS(( CLIENT *Client ));
65 static void Free_Client PARAMS(( CLIENT **Client ));
67 static CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
68 CLIENT *TopServer, int Type, const char *ID,
69 const char *User, const char *Hostname, const char *Info,
70 int Hops, int Token, const char *Modes,
73 static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
76 static void cb_introduceClient PARAMS((CLIENT *Client, CLIENT *Prefix,
84 This_Server = New_Client_Struct( );
87 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
88 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
92 /* Client structure for this server */
93 This_Server->next = NULL;
94 This_Server->type = CLIENT_SERVER;
95 This_Server->conn_id = NONE;
96 This_Server->introducer = This_Server;
97 This_Server->mytoken = 1;
98 This_Server->hops = 0;
100 gethostname( This_Server->host, CLIENT_HOST_LEN );
102 h = gethostbyname( This_Server->host );
103 if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
105 Client_SetID( This_Server, Conf_ServerName );
106 Client_SetInfo( This_Server, Conf_ServerInfo );
108 My_Clients = This_Server;
110 memset( &My_Whowas, 0, sizeof( My_Whowas ));
120 if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, false );
121 else Client_Destroy( This_Server, "Server going down.", NULL, false );
127 next = (CLIENT *)c->next;
132 Log(LOG_INFO, "Freed %d client structure%s.",
133 cnt, cnt == 1 ? "" : "s");
138 Client_ThisServer( void )
141 } /* Client_ThisServer */
145 * Initialize new local client; wrapper function for Init_New_Client().
146 * @return New CLIENT structure.
149 Client_NewLocal(CONN_ID Idx, const char *Hostname, int Type, bool Idented)
151 return Init_New_Client(Idx, This_Server, NULL, Type, NULL, NULL,
152 Hostname, NULL, 0, 0, NULL, Idented);
153 } /* Client_NewLocal */
157 * Initialize new remote server; wrapper function for Init_New_Client().
158 * @return New CLIENT structure.
161 Client_NewRemoteServer(CLIENT *Introducer, const char *Hostname, CLIENT *TopServer,
162 int Hops, int Token, const char *Info, bool Idented)
164 return Init_New_Client(NONE, Introducer, TopServer, CLIENT_SERVER,
165 Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented);
166 } /* Client_NewRemoteServer */
170 * Initialize new remote client; wrapper function for Init_New_Client().
171 * @return New CLIENT structure.
174 Client_NewRemoteUser(CLIENT *Introducer, const char *Nick, int Hops, const char *User,
175 const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented)
177 return Init_New_Client(NONE, Introducer, NULL, CLIENT_USER, Nick,
178 User, Hostname, Info, Hops, Token, Modes, Idented);
179 } /* Client_NewRemoteUser */
183 * Initialize new client and set up the given parameters like client type,
184 * user name, host name, introducing server etc. ...
185 * @return New CLIENT structure.
188 Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
189 int Type, const char *ID, const char *User, const char *Hostname,
190 const char *Info, int Hops, int Token, const char *Modes, bool Idented)
195 assert(Introducer != NULL);
197 client = New_Client_Struct();
201 client->starttime = time(NULL);
202 client->conn_id = Idx;
203 client->introducer = Introducer;
204 client->topserver = TopServer;
207 Client_SetID(client, ID);
209 Client_SetUser(client, User, Idented);
210 Client_SetOrigUser(client, User);
213 Client_SetHostname(client, Hostname);
215 Client_SetInfo(client, Info);
217 client->token = Token;
219 Client_SetModes(client, Modes);
220 if (Type == CLIENT_SERVER)
221 Generate_MyToken(client);
223 if (Client_HasMode(client, 'a'))
224 strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
226 client->next = (POINTER *)My_Clients;
229 Adjust_Counters(client);
232 } /* Init_New_Client */
236 Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit )
238 /* remove a client */
244 assert( Client != NULL );
246 txt = LogMsg ? LogMsg : FwdMsg;
248 txt = "Reason unknown";
250 /* netsplit message */
251 if( Client->type == CLIENT_SERVER ) {
252 strlcpy(msg, This_Server->id, sizeof (msg));
253 strlcat(msg, " ", sizeof (msg));
254 strlcat(msg, Client->id, sizeof (msg));
261 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
264 * The client that is about to be removed is a server,
265 * the client we are checking right now is a child of that
266 * server and thus has to be removed, too.
268 * Call Client_Destroy() recursively with the server as the
269 * new "object to be removed". This starts the cycle again, until
270 * all servers that are linked via the original server have been
273 Client_Destroy( c, NULL, msg, false );
280 /* found the client: remove it */
281 if( last ) last->next = c->next;
282 else My_Clients = (CLIENT *)c->next;
284 if(c->type == CLIENT_USER || c->type == CLIENT_SERVICE)
285 Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
286 else if( c->type == CLIENT_SERVER )
288 if (c != This_Server) {
289 if (c->conn_id != NONE)
290 Log(LOG_NOTICE|LOG_snotice,
291 "Server \"%s\" unregistered (connection %d): %s.",
292 c->id, c->conn_id, txt);
294 Log(LOG_NOTICE|LOG_snotice,
295 "Server \"%s\" unregistered: %s.",
299 /* inform other servers */
300 if( ! NGIRCd_SignalQuit )
302 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
303 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
308 if (c->conn_id != NONE) {
311 "Client \"%s\" unregistered (connection %d): %s.",
312 c->id, c->conn_id, txt);
315 "Client unregistered (connection %d): %s.",
319 "Unregistered unknown client \"%s\": %s",
320 c->id[0] ? c->id : "(No Nick)", txt);
328 c = (CLIENT *)c->next;
330 } /* Client_Destroy */
334 * Set client hostname.
336 * If global hostname cloaking is in effect, don't set the real hostname
337 * but the configured one.
339 * @param Client The client of which the hostname should be set.
340 * @param Hostname The new hostname.
343 Client_SetHostname( CLIENT *Client, const char *Hostname )
345 assert(Client != NULL);
346 assert(Hostname != NULL);
348 if (strlen(Conf_CloakHost)) {
349 char cloak[GETID_LEN];
351 strlcpy(cloak, Hostname, GETID_LEN);
352 strlcat(cloak, Conf_CloakHostSalt, GETID_LEN);
353 snprintf(cloak, GETID_LEN, Conf_CloakHost, Hash(cloak));
355 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
356 Client_ID(Client), Client->host, cloak);
357 strlcpy(Client->host, cloak, sizeof(Client->host));
359 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
360 Client_ID(Client), Client->host, Hostname);
361 strlcpy(Client->host, Hostname, sizeof(Client->host));
363 } /* Client_SetHostname */
367 * Set IP address to display for a client.
369 * @param Client The client.
370 * @param IPAText Textual representation of the IP address or NULL to unset.
373 Client_SetIPAText(CLIENT *Client, const char *IPAText)
375 assert(Client != NULL);
377 if (Client->ipa_text)
378 free(Client->ipa_text);
381 Client->ipa_text = strndup(IPAText, CLIENT_HOST_LEN - 1);
383 Client->ipa_text = NULL;
388 Client_SetID( CLIENT *Client, const char *ID )
390 assert( Client != NULL );
391 assert( ID != NULL );
393 strlcpy( Client->id, ID, sizeof( Client->id ));
395 if (Conf_CloakUserToNick) {
396 strlcpy( Client->user, ID, sizeof( Client->user ));
397 strlcpy( Client->info, ID, sizeof( Client->info ));
401 Client->hash = Hash( Client->id );
406 Client_SetUser( CLIENT *Client, const char *User, bool Idented )
408 /* set clients username */
410 assert( Client != NULL );
411 assert( User != NULL );
413 if (Conf_CloakUserToNick) {
414 strlcpy(Client->user, Client->id, sizeof(Client->user));
415 } else if (Idented) {
416 strlcpy(Client->user, User, sizeof(Client->user));
418 Client->user[0] = '~';
419 strlcpy(Client->user + 1, User, sizeof(Client->user) - 1);
421 } /* Client_SetUser */
425 * Set "original" user name of a client.
426 * This function saves the "original" user name, the user name specified by
427 * the peer using the USER command, into the CLIENT structure. This user
428 * name may be used for authentication, for example.
429 * @param Client The client.
430 * @param User User name to set.
433 Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
435 assert(Client != NULL);
436 assert(User != NULL);
438 #if defined(PAM) && defined(IDENTAUTH)
439 strlcpy(Client->orig_user, User, sizeof(Client->orig_user));
441 } /* Client_SetOrigUser */
445 Client_SetInfo( CLIENT *Client, const char *Info )
447 /* set client hostname */
449 assert( Client != NULL );
450 assert( Info != NULL );
452 if (Conf_CloakUserToNick)
453 strlcpy(Client->info, Client->id, sizeof(Client->info));
455 strlcpy(Client->info, Info, sizeof(Client->info));
456 } /* Client_SetInfo */
460 Client_SetModes( CLIENT *Client, const char *Modes )
462 assert( Client != NULL );
463 assert( Modes != NULL );
465 strlcpy(Client->modes, Modes, sizeof( Client->modes ));
466 } /* Client_SetModes */
470 Client_SetFlags( CLIENT *Client, const char *Flags )
472 assert( Client != NULL );
473 assert( Flags != NULL );
475 strlcpy(Client->flags, Flags, sizeof(Client->flags));
476 } /* Client_SetFlags */
480 Client_SetAccountName(CLIENT *Client, const char *AccountName)
482 assert(Client != NULL);
484 if (Client->account_name)
485 free(Client->account_name);
488 Client->account_name = strndup(AccountName,
489 CLIENT_NICK_LEN - 1);
491 Client->account_name = NULL;
496 Client_SetAway( CLIENT *Client, const char *Txt )
498 /* Set AWAY reason of client */
500 assert( Client != NULL );
501 assert( Txt != NULL );
503 strlcpy( Client->away, Txt, sizeof( Client->away ));
504 LogDebug("%s \"%s\" is away: %s", Client_TypeText(Client),
505 Client_Mask(Client), Txt);
506 } /* Client_SetAway */
510 Client_SetType( CLIENT *Client, int Type )
512 assert( Client != NULL );
514 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
515 Adjust_Counters( Client );
516 } /* Client_SetType */
520 Client_SetHops( CLIENT *Client, int Hops )
522 assert( Client != NULL );
524 } /* Client_SetHops */
528 Client_SetToken( CLIENT *Client, int Token )
530 assert( Client != NULL );
531 Client->token = Token;
532 } /* Client_SetToken */
536 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
538 assert( Client != NULL );
539 assert( Introducer != NULL );
540 Client->introducer = Introducer;
541 } /* Client_SetIntroducer */
545 Client_SetOperByMe( CLIENT *Client, bool OperByMe )
547 assert( Client != NULL );
548 Client->oper_by_me = OperByMe;
549 } /* Client_SetOperByMe */
553 Client_ModeAdd( CLIENT *Client, char Mode )
556 * If Client already had Mode, return false.
557 * If the Mode was newly set, return true.
562 assert( Client != NULL );
564 x[0] = Mode; x[1] = '\0';
565 if (!Client_HasMode(Client, x[0])) {
566 strlcat( Client->modes, x, sizeof( Client->modes ));
570 } /* Client_ModeAdd */
574 Client_ModeDel( CLIENT *Client, char Mode )
577 * If Mode was removed, return true.
578 * If Client did not have Mode, return false.
583 assert( Client != NULL );
585 x[0] = Mode; x[1] = '\0';
587 p = strchr( Client->modes, x[0] );
588 if( ! p ) return false;
590 /* Client has Mode -> delete */
597 } /* Client_ModeDel */
601 * Search CLIENT structure of a given nick name.
603 * @return Pointer to CLIENT structure or NULL if not found.
606 Client_Search( const char *Nick )
608 char search_id[CLIENT_ID_LEN], *ptr;
612 assert( Nick != NULL );
614 /* copy Nick and truncate hostmask if necessary */
615 strlcpy( search_id, Nick, sizeof( search_id ));
616 ptr = strchr( search_id, '!' );
617 if( ptr ) *ptr = '\0';
619 search_hash = Hash(search_id);
623 if (c->hash == search_hash && strcasecmp(c->id, search_id) == 0)
625 c = (CLIENT *)c->next;
632 * Search first CLIENT structure matching a given mask of a server.
634 * The order of servers is arbitrary, but this function makes sure that the
635 * local server is always returned if the mask matches it.
637 * @return Pointer to CLIENT structure or NULL if no server could be found.
640 Client_SearchServer(const char *Mask)
644 assert(Mask != NULL);
646 /* First check if mask matches the local server */
647 if (MatchCaseInsensitive(Mask, Client_ID(Client_ThisServer())))
648 return Client_ThisServer();
652 if (Client_Type(c) == CLIENT_SERVER) {
653 /* This is a server: check if Mask matches */
654 if (MatchCaseInsensitive(Mask, c->id))
657 c = (CLIENT *)c->next;
664 * Get client structure ("introducer") identfied by a server token.
665 * @return CLIENT structure or NULL if none could be found.
668 Client_GetFromToken( CLIENT *Client, int Token )
672 assert( Client != NULL );
679 if ((c->type == CLIENT_SERVER) && (c->introducer == Client) &&
682 c = (CLIENT *)c->next;
685 } /* Client_GetFromToken */
689 Client_Type( CLIENT *Client )
691 assert( Client != NULL );
697 Client_Conn( CLIENT *Client )
699 assert( Client != NULL );
700 return Client->conn_id;
705 Client_ID( CLIENT *Client )
707 assert( Client != NULL );
710 if(Client->type == CLIENT_USER)
711 assert(strlen(Client->id) < Conf_MaxNickLength);
714 if( Client->id[0] ) return Client->id;
720 Client_Info( CLIENT *Client )
722 assert( Client != NULL );
728 Client_User( CLIENT *Client )
730 assert( Client != NULL );
731 return Client->user[0] ? Client->user : "~";
738 * Get the "original" user name as supplied by the USER command.
739 * The user name as given by the client is used for authentication instead
740 * of the one detected using IDENT requests.
741 * @param Client The client.
742 * @return Original user name.
745 Client_OrigUser(CLIENT *Client) {
747 char *user = Client->user;
753 return Client->orig_user;
755 } /* Client_OrigUser */
760 * Return the hostname of a client.
761 * @param Client Pointer to client structure
762 * @return Pointer to client hostname
765 Client_Hostname(CLIENT *Client)
767 assert (Client != NULL);
772 * Return the cloaked hostname of a client, if set.
773 * @param Client Pointer to the client structure.
774 * @return Pointer to the cloaked hostname or NULL if not set.
777 Client_HostnameCloaked(CLIENT *Client)
779 assert(Client != NULL);
780 return Client->cloaked;
784 * Get (potentially cloaked) hostname of a client to display it to other users.
786 * If the client has not enabled cloaking, the real hostname is used.
788 * @param Client Pointer to client structure
789 * @return Pointer to client hostname
792 Client_HostnameDisplayed(CLIENT *Client)
794 assert(Client != NULL);
796 /* Client isn't cloaked at all, return real hostname: */
797 if (!Client_HasMode(Client, 'x'))
798 return Client_Hostname(Client);
800 /* Use an already saved cloaked hostname, if there is one */
802 return Client->cloaked;
804 Client_UpdateCloakedHostname(Client, NULL, NULL);
805 return Client->cloaked;
809 Client_IPAText(CLIENT *Client)
811 assert(Client != NULL);
813 /* Not a local client? */
814 if (Client_Conn(Client) <= NONE)
817 if (!Client->ipa_text)
818 return Conn_GetIPAInfo(Client_Conn(Client));
820 return Client->ipa_text;
824 * Update (and generate, if necessary) the cloaked hostname of a client.
826 * The newly set cloaked hostname is announced in the network using METADATA
827 * commands to peers that support this feature.
829 * @param Client The client of which the cloaked hostname should be updated.
830 * @param Origin The originator of the hostname change, or NULL if this server.
831 * @param Hostname The new cloaked hostname, or NULL if it should be generated.
834 Client_UpdateCloakedHostname(CLIENT *Client, CLIENT *Origin,
835 const char *Hostname)
837 char Cloak_Buffer[CLIENT_HOST_LEN];
839 assert(Client != NULL);
841 Origin = Client_ThisServer();
843 if (!Client->cloaked) {
844 Client->cloaked = malloc(CLIENT_HOST_LEN);
845 if (!Client->cloaked)
850 /* Generate new cloaked hostname */
851 if (*Conf_CloakHostModeX) {
852 strlcpy(Cloak_Buffer, Client->host,
853 sizeof(Cloak_Buffer));
854 strlcat(Cloak_Buffer, Conf_CloakHostSalt,
855 sizeof(Cloak_Buffer));
856 snprintf(Client->cloaked, CLIENT_HOST_LEN,
857 Conf_CloakHostModeX, Hash(Cloak_Buffer));
859 strlcpy(Client->cloaked, Client_ID(Client->introducer),
862 strlcpy(Client->cloaked, Hostname, CLIENT_HOST_LEN);
863 LogDebug("Cloaked hostname of \"%s\" updated to \"%s\"",
864 Client_ID(Client), Client->cloaked);
866 /* Inform other servers in the network */
867 IRC_WriteStrServersPrefixFlag(Client_NextHop(Origin), Origin, 'M',
868 "METADATA %s cloakhost :%s",
869 Client_ID(Client), Client->cloaked);
873 Client_Modes( CLIENT *Client )
875 assert( Client != NULL );
876 return Client->modes;
881 Client_Flags( CLIENT *Client )
883 assert( Client != NULL );
884 return Client->flags;
889 Client_OperByMe( CLIENT *Client )
891 assert( Client != NULL );
892 return Client->oper_by_me;
893 } /* Client_OperByMe */
897 Client_Hops( CLIENT *Client )
899 assert( Client != NULL );
905 Client_Token( CLIENT *Client )
907 assert( Client != NULL );
908 return Client->token;
913 Client_MyToken( CLIENT *Client )
915 assert( Client != NULL );
916 return Client->mytoken;
917 } /* Client_MyToken */
921 Client_NextHop( CLIENT *Client )
925 assert( Client != NULL );
928 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server ))
932 } /* Client_NextHop */
936 * Return ID of a client: "client!user@host"
937 * This client ID is used for IRC prefixes, for example.
938 * Please note that this function uses a global static buffer, so you can't
939 * nest invocations without overwriting earlier results!
940 * @param Client Pointer to client structure
941 * @return Pointer to global buffer containing the client ID
944 Client_Mask( CLIENT *Client )
946 static char Mask_Buffer[GETID_LEN];
948 assert (Client != NULL);
950 /* Servers: return name only, there is no "mask" */
951 if (Client->type == CLIENT_SERVER)
954 snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
955 Client->id, Client->user, Client->host);
961 * Return ID of a client with cloaked hostname: "client!user@server-name"
963 * This client ID is used for IRC prefixes, for example.
964 * Please note that this function uses a global static buffer, so you can't
965 * nest invocations without overwriting earlier results!
966 * If the client has not enabled cloaking, the real hostname is used.
968 * @param Client Pointer to client structure
969 * @return Pointer to global buffer containing the client ID
972 Client_MaskCloaked(CLIENT *Client)
974 static char Mask_Buffer[GETID_LEN];
976 assert (Client != NULL);
978 /* Is the client using cloaking at all? */
979 if (!Client_HasMode(Client, 'x'))
980 return Client_Mask(Client);
982 snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user,
983 Client_HostnameDisplayed(Client));
986 } /* Client_MaskCloaked */
990 Client_Introducer( CLIENT *Client )
992 assert( Client != NULL );
993 return Client->introducer;
994 } /* Client_Introducer */
998 Client_TopServer( CLIENT *Client )
1000 assert( Client != NULL );
1001 return Client->topserver;
1002 } /* Client_TopServer */
1006 Client_HasMode( CLIENT *Client, char Mode )
1008 assert( Client != NULL );
1009 return strchr( Client->modes, Mode ) != NULL;
1010 } /* Client_HasMode */
1014 Client_HasFlag( CLIENT *Client, char Flag )
1016 assert( Client != NULL );
1017 return strchr( Client->flags, Flag ) != NULL;
1018 } /* Client_HasFlag */
1022 Client_Away( CLIENT *Client )
1024 assert( Client != NULL );
1025 return Client->away;
1030 Client_AccountName(CLIENT *Client)
1032 assert(Client != NULL);
1033 return Client->account_name;
1038 * Make sure that a given nickname is valid.
1040 * If the nickname is not valid for the given client, this function sends back
1041 * the appropriate error messages.
1043 * @param Client Client that wants to change the nickname.
1044 * @param Nick New nickname.
1045 * @returns true if nickname is valid, false otherwise.
1048 Client_CheckNick(CLIENT *Client, char *Nick)
1050 assert(Client != NULL);
1051 assert(Nick != NULL);
1053 if (!Client_IsValidNick(Nick)) {
1054 if (strlen(Nick ) >= Conf_MaxNickLength)
1055 IRC_WriteErrClient(Client, ERR_NICKNAMETOOLONG_MSG,
1056 Client_ID(Client), Nick,
1057 Conf_MaxNickLength - 1);
1059 IRC_WriteErrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
1060 Client_ID(Client), Nick);
1064 if (Client_Type(Client) != CLIENT_SERVER
1065 && Client_Type(Client) != CLIENT_SERVICE) {
1066 /* Make sure that this isn't a restricted/forbidden nickname */
1067 if (Conf_NickIsBlocked(Nick)) {
1068 IRC_WriteErrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
1069 Client_ID(Client), Nick);
1074 /* Nickname already registered? */
1075 if (Client_Search(Nick)) {
1076 IRC_WriteErrClient(Client, ERR_NICKNAMEINUSE_MSG,
1077 Client_ID(Client), Nick);
1082 } /* Client_CheckNick */
1086 Client_CheckID( CLIENT *Client, char *ID )
1088 char str[COMMAND_LEN];
1091 assert( Client != NULL );
1092 assert( Client->conn_id > NONE );
1093 assert( ID != NULL );
1096 if (strlen(ID) > CLIENT_ID_LEN) {
1097 IRC_WriteErrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
1098 Client_ID(Client), ID);
1102 /* ID already in use? */
1105 if (strcasecmp(c->id, ID) == 0) {
1106 snprintf(str, sizeof(str), "ID \"%s\" already registered", ID);
1107 if (c->conn_id != NONE)
1108 Log(LOG_ERR, "%s (on connection %d)!", str, c->conn_id);
1110 Log(LOG_ERR, "%s (via network)!", str);
1111 Conn_Close(Client->conn_id, str, str, true);
1114 c = (CLIENT *)c->next;
1118 } /* Client_CheckID */
1122 Client_First( void )
1125 } /* Client_First */
1129 Client_Next( CLIENT *c )
1131 assert( c != NULL );
1132 return (CLIENT *)c->next;
1137 Client_UserCount( void )
1139 return Count( CLIENT_USER );
1140 } /* Client_UserCount */
1144 Client_ServiceCount( void )
1146 return Count( CLIENT_SERVICE );;
1147 } /* Client_ServiceCount */
1151 Client_ServerCount( void )
1153 return Count( CLIENT_SERVER );
1154 } /* Client_ServerCount */
1158 Client_MyUserCount( void )
1160 return MyCount( CLIENT_USER );
1161 } /* Client_MyUserCount */
1165 Client_MyServiceCount( void )
1167 return MyCount( CLIENT_SERVICE );
1168 } /* Client_MyServiceCount */
1171 GLOBAL unsigned long
1172 Client_MyServerCount( void )
1175 unsigned long cnt = 0;
1180 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
1181 c = (CLIENT *)c->next;
1184 } /* Client_MyServerCount */
1187 GLOBAL unsigned long
1188 Client_OperCount( void )
1191 unsigned long cnt = 0;
1196 if (c && c->type == CLIENT_USER && Client_HasMode(c, 'o' ))
1198 c = (CLIENT *)c->next;
1201 } /* Client_OperCount */
1204 GLOBAL unsigned long
1205 Client_UnknownCount( void )
1208 unsigned long cnt = 0;
1213 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
1214 c = (CLIENT *)c->next;
1218 } /* Client_UnknownCount */
1222 Client_MaxUserCount( void )
1225 } /* Client_MaxUserCount */
1229 Client_MyMaxUserCount( void )
1231 return My_Max_Users;
1232 } /* Client_MyMaxUserCount */
1236 * Check that a given nickname is valid.
1238 * @param Nick the nickname to check.
1239 * @returns true if nickname is valid, false otherwise.
1242 Client_IsValidNick(const char *Nick)
1245 static const char goodchars[] = ";0123456789-";
1247 assert (Nick != NULL);
1249 if (strchr(goodchars, Nick[0]))
1251 if (strlen(Nick ) >= Conf_MaxNickLength)
1256 if (*ptr < 'A' && !strchr(goodchars, *ptr ))
1264 } /* Client_IsValidNick */
1268 * Return pointer to "My_Whowas" structure.
1271 Client_GetWhowas( void )
1274 } /* Client_GetWhowas */
1277 * Return the index of the last used WHOWAS entry.
1280 Client_GetLastWhowasIndex( void )
1283 } /* Client_GetLastWhowasIndex */
1287 * Get the start time of this client.
1288 * The result is the start time in seconds since 1970-01-01, as reported
1289 * by the C function time(NULL).
1292 Client_StartTime(CLIENT *Client)
1294 assert( Client != NULL );
1295 return Client->starttime;
1296 } /* Client_Uptime */
1300 * Reject a client when logging in.
1302 * This function is called when a client isn't allowed to connect to this
1303 * server. Possible reasons are bad server password, bad PAM password,
1304 * or that the client is G/K-Line'd.
1306 * After calling this function, the client isn't connected any more.
1308 * @param Client The client to reject.
1309 * @param Reason The reason why the client has been rejected.
1310 * @param InformClient If true, send the exact reason to the client.
1313 Client_Reject(CLIENT *Client, const char *Reason, bool InformClient)
1315 char info[COMMAND_LEN];
1317 assert(Client != NULL);
1318 assert(Reason != NULL);
1321 snprintf(info, sizeof(info), "Access denied: %s", Reason);
1323 strcpy(info, "Access denied: Bad password?");
1326 "User \"%s\" rejected (connection %d): %s!",
1327 Client_Mask(Client), Client_Conn(Client), Reason);
1328 Conn_Close(Client_Conn(Client), Reason, info, true);
1333 * Introduce a new user or service client in the network.
1335 * @param From Remote server introducing the client or NULL (local).
1336 * @param Client New client.
1337 * @param Type Type of the client (CLIENT_USER or CLIENT_SERVICE).
1340 Client_Introduce(CLIENT *From, CLIENT *Client, int Type)
1342 /* Set client type (user or service) */
1343 Client_SetType(Client, Type);
1346 if (Conf_NickIsService(Conf_GetServer(Client_Conn(From)),
1348 Client_SetType(Client, CLIENT_SERVICE);
1349 LogDebug("%s \"%s\" (+%s) registered (via %s, on %s, %d hop%s).",
1350 Client_TypeText(Client), Client_Mask(Client),
1351 Client_Modes(Client), Client_ID(From),
1352 Client_ID(Client_Introducer(Client)),
1353 Client_Hops(Client), Client_Hops(Client) > 1 ? "s": "");
1355 Log(LOG_NOTICE, "%s \"%s\" registered (connection %d).",
1356 Client_TypeText(Client), Client_Mask(Client),
1357 Client_Conn(Client));
1358 Log_ServerNotice('c', "Client connecting: %s (%s@%s) [%s] - %s",
1359 Client_ID(Client), Client_User(Client),
1360 Client_Hostname(Client),
1361 Conn_IPA(Client_Conn(Client)),
1362 Client_TypeText(Client));
1365 /* Inform other servers */
1366 IRC_WriteStrServersPrefixFlag_CB(From,
1367 From != NULL ? From : Client_ThisServer(),
1368 '\0', cb_introduceClient, (void *)Client);
1369 } /* Client_Introduce */
1372 static unsigned long
1373 Count( CLIENT_TYPE Type )
1376 unsigned long cnt = 0;
1381 if( c->type == Type ) cnt++;
1382 c = (CLIENT *)c->next;
1388 static unsigned long
1389 MyCount( CLIENT_TYPE Type )
1392 unsigned long cnt = 0;
1397 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
1398 c = (CLIENT *)c->next;
1405 * Allocate and initialize new CLIENT strcuture.
1407 * @return Pointer to CLIENT structure or NULL on error.
1410 New_Client_Struct( void )
1414 c = (CLIENT *)malloc( sizeof( CLIENT ));
1417 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1421 memset( c, 0, sizeof ( CLIENT ));
1423 c->type = CLIENT_UNKNOWN;
1425 c->oper_by_me = false;
1434 * Free a CLIENT structure and its member variables.
1437 Free_Client(CLIENT **Client)
1439 assert(Client != NULL);
1440 assert(*Client != NULL);
1442 if ((*Client)->account_name)
1443 free((*Client)->account_name);
1444 if ((*Client)->cloaked)
1445 free((*Client)->cloaked);
1446 if ((*Client)->ipa_text)
1447 free((*Client)->ipa_text);
1454 Generate_MyToken( CLIENT *Client )
1463 if( c->mytoken == token )
1465 /* The token is already in use */
1470 else c = (CLIENT *)c->next;
1472 Client->mytoken = token;
1473 LogDebug("Assigned token %d to server \"%s\".", token, Client->id);
1474 } /* Generate_MyToken */
1478 Adjust_Counters( CLIENT *Client )
1482 assert( Client != NULL );
1484 if( Client->type != CLIENT_USER ) return;
1486 if( Client->conn_id != NONE )
1488 /* Local connection */
1489 count = Client_MyUserCount( );
1490 if( count > My_Max_Users ) My_Max_Users = count;
1492 count = Client_UserCount( );
1493 if( count > Max_Users ) Max_Users = count;
1494 } /* Adjust_Counters */
1498 * Register client in My_Whowas structure for further recall by WHOWAS.
1499 * Note: Only clients that have been connected at least 30 seconds will be
1500 * registered to prevent automated IRC bots to "destroy" a nice server
1504 Client_RegisterWhowas( CLIENT *Client )
1509 assert( Client != NULL );
1511 /* Don't register WHOWAS information when "MorePrivacy" is enabled. */
1512 if (Conf_MorePrivacy)
1516 /* Don't register clients that were connected less than 30 seconds. */
1517 if( now - Client->starttime < 30 )
1520 slot = Last_Whowas + 1;
1521 if( slot >= MAX_WHOWAS || slot < 0 ) slot = 0;
1524 Log( LOG_DEBUG, "Saving WHOWAS information to slot %d ...", slot );
1527 My_Whowas[slot].time = now;
1528 strlcpy( My_Whowas[slot].id, Client_ID( Client ),
1529 sizeof( My_Whowas[slot].id ));
1530 strlcpy( My_Whowas[slot].user, Client_User( Client ),
1531 sizeof( My_Whowas[slot].user ));
1532 strlcpy( My_Whowas[slot].host, Client_HostnameDisplayed( Client ),
1533 sizeof( My_Whowas[slot].host ));
1534 strlcpy( My_Whowas[slot].info, Client_Info( Client ),
1535 sizeof( My_Whowas[slot].info ));
1536 strlcpy( My_Whowas[slot].server, Client_ID( Client_Introducer( Client )),
1537 sizeof( My_Whowas[slot].server ));
1540 } /* Client_RegisterWhowas */
1544 Client_TypeText(CLIENT *Client)
1546 assert(Client != NULL);
1547 switch (Client_Type(Client)) {
1551 case CLIENT_SERVICE:
1560 } /* Client_TypeText */
1564 * Destroy user or service client.
1567 Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool SendQuit)
1569 if(Client->conn_id != NONE) {
1570 /* Local (directly connected) client */
1572 "%s \"%s\" unregistered (connection %d): %s.",
1573 Client_TypeText(Client), Client_Mask(Client),
1574 Client->conn_id, Txt);
1575 Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
1576 Client_ID(Client), Client_User(Client),
1577 Client_Hostname(Client), Txt);
1580 /* Inforam all the other servers */
1582 IRC_WriteStrServersPrefix(NULL,
1583 Client, "QUIT :%s", FwdMsg );
1585 IRC_WriteStrServersPrefix(NULL,
1590 LogDebug("%s \"%s\" unregistered: %s.",
1591 Client_TypeText(Client), Client_Mask(Client), Txt);
1594 /* Inform all the other servers, but the ones in the
1595 * direction we got the QUIT from */
1597 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1598 Client, "QUIT :%s", FwdMsg );
1600 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1605 /* Unregister client from channels */
1606 Channel_Quit(Client, FwdMsg ? FwdMsg : Client->id);
1608 /* Register client in My_Whowas structure */
1609 Client_RegisterWhowas(Client);
1610 } /* Destroy_UserOrService */
1614 * Introduce a new user or service client to a remote server.
1616 * @param To The remote server to inform.
1617 * @param Prefix Prefix for the generated commands.
1618 * @param data CLIENT structure of the new client.
1621 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
1623 CLIENT *c = (CLIENT *)data;
1625 (void)Client_Announce(To, Prefix, c);
1627 } /* cb_introduceClient */
1631 * Announce an user or service to a server.
1633 * This function differentiates between RFC1459 and RFC2813 server links and
1634 * generates the appropriate commands to register the user or service.
1636 * @param Client Server
1637 * @param Prefix Prefix for the generated commands
1638 * @param User User to announce
1641 Client_Announce(CLIENT * Client, CLIENT * Prefix, CLIENT * User)
1644 char *modes, *user, *host;
1646 modes = Client_Modes(User);
1647 user = Client_User(User) ? Client_User(User) : "-";
1648 host = Client_Hostname(User) ? Client_Hostname(User) : "-";
1650 conn = Client_Conn(Client);
1651 if (Conn_Options(conn) & CONN_RFC1459) {
1652 /* RFC 1459 mode: separate NICK and USER commands */
1653 if (! Conn_WriteStr(conn, "NICK %s :%d",
1654 Client_ID(User), Client_Hops(User) + 1))
1655 return DISCONNECTED;
1656 if (! Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
1657 Client_ID(User), user, host,
1658 Client_ID(Client_Introducer(User)),
1660 return DISCONNECTED;
1662 if (! Conn_WriteStr(conn, ":%s MODE %s +%s",
1663 Client_ID(User), Client_ID(User),
1665 return DISCONNECTED;
1668 /* RFC 2813 mode: one combined NICK or SERVICE command */
1669 if (Client_Type(User) == CLIENT_SERVICE
1670 && Client_HasFlag(Client, 'S')) {
1671 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1672 "SERVICE %s %d * +%s %d :%s",
1674 Client_MyToken(Client_Introducer(User)),
1675 modes, Client_Hops(User) + 1,
1677 return DISCONNECTED;
1679 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1680 "NICK %s %d %s %s %d +%s :%s",
1681 Client_ID(User), Client_Hops(User) + 1,
1683 Client_MyToken(Client_Introducer(User)),
1684 modes, Client_Info(User)))
1685 return DISCONNECTED;
1689 if (Client_HasFlag(Client, 'M')) {
1690 /* Synchronize metadata */
1691 if (Client_HostnameCloaked(User)) {
1692 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1693 "METADATA %s cloakhost :%s",
1695 Client_HostnameCloaked(User)))
1696 return DISCONNECTED;
1699 if (Client_AccountName(User)) {
1700 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1701 "METADATA %s accountname :%s",
1703 Client_AccountName(User)))
1704 return DISCONNECTED;
1707 if (Conn_GetCertFp(Client_Conn(User))) {
1708 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1709 "METADATA %s certfp :%s",
1711 Conn_GetCertFp(Client_Conn(User))))
1712 return DISCONNECTED;
1717 } /* Client_Announce */
1723 Client_DebugDump(void)
1727 Log(LOG_DEBUG, "Client status:");
1731 " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
1732 Client_ID(c), Client_Type(c), Client_Hostname(c),
1733 Client_User(c), Client_Conn(c), Client_StartTime(c),
1735 c = (CLIENT *)c->next;
1737 } /* Client_DumpClients */