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 CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
66 CLIENT *TopServer, int Type, const char *ID,
67 const char *User, const char *Hostname, const char *Info,
68 int Hops, int Token, const char *Modes,
71 static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
74 static void cb_introduceClient PARAMS((CLIENT *Client, CLIENT *Prefix,
82 This_Server = New_Client_Struct( );
85 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
86 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
90 /* Client structure for this server */
91 This_Server->next = NULL;
92 This_Server->type = CLIENT_SERVER;
93 This_Server->conn_id = NONE;
94 This_Server->introducer = This_Server;
95 This_Server->mytoken = 1;
96 This_Server->hops = 0;
98 gethostname( This_Server->host, CLIENT_HOST_LEN );
100 h = gethostbyname( This_Server->host );
101 if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
103 Client_SetID( This_Server, Conf_ServerName );
104 Client_SetInfo( This_Server, Conf_ServerInfo );
106 My_Clients = This_Server;
108 memset( &My_Whowas, 0, sizeof( My_Whowas ));
118 if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, false );
119 else Client_Destroy( This_Server, "Server going down.", NULL, false );
126 next = (CLIENT *)c->next;
130 if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
135 Client_ThisServer( void )
138 } /* Client_ThisServer */
142 * Initialize new local client; wrapper function for Init_New_Client().
143 * @return New CLIENT structure.
146 Client_NewLocal(CONN_ID Idx, const char *Hostname, int Type, bool Idented)
148 return Init_New_Client(Idx, This_Server, NULL, Type, NULL, NULL,
149 Hostname, NULL, 0, 0, NULL, Idented);
150 } /* Client_NewLocal */
154 * Initialize new remote server; wrapper function for Init_New_Client().
155 * @return New CLIENT structure.
158 Client_NewRemoteServer(CLIENT *Introducer, const char *Hostname, CLIENT *TopServer,
159 int Hops, int Token, const char *Info, bool Idented)
161 return Init_New_Client(NONE, Introducer, TopServer, CLIENT_SERVER,
162 Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented);
163 } /* Client_NewRemoteServer */
167 * Initialize new remote client; wrapper function for Init_New_Client().
168 * @return New CLIENT structure.
171 Client_NewRemoteUser(CLIENT *Introducer, const char *Nick, int Hops, const char *User,
172 const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented)
174 return Init_New_Client(NONE, Introducer, NULL, CLIENT_USER, Nick,
175 User, Hostname, Info, Hops, Token, Modes, Idented);
176 } /* Client_NewRemoteUser */
180 * Initialize new client and set up the given parameters like client type,
181 * user name, host name, introducing server etc. ...
182 * @return New CLIENT structure.
185 Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
186 int Type, const char *ID, const char *User, const char *Hostname,
187 const char *Info, int Hops, int Token, const char *Modes, bool Idented)
192 assert(Introducer != NULL);
194 client = New_Client_Struct();
198 client->starttime = time(NULL);
199 client->conn_id = Idx;
200 client->introducer = Introducer;
201 client->topserver = TopServer;
204 Client_SetID(client, ID);
206 Client_SetUser(client, User, Idented);
207 Client_SetOrigUser(client, User);
210 Client_SetHostname(client, Hostname);
212 Client_SetInfo(client, Info);
214 client->token = Token;
216 Client_SetModes(client, Modes);
217 if (Type == CLIENT_SERVER)
218 Generate_MyToken(client);
220 if (Client_HasMode(client, 'a'))
221 strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
223 client->next = (POINTER *)My_Clients;
226 Adjust_Counters(client);
229 } /* Init_New_Client */
233 Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit )
235 /* remove a client */
241 assert( Client != NULL );
243 txt = LogMsg ? LogMsg : FwdMsg;
245 txt = "Reason unknown";
247 /* netsplit message */
248 if( Client->type == CLIENT_SERVER ) {
249 strlcpy(msg, This_Server->id, sizeof (msg));
250 strlcat(msg, " ", sizeof (msg));
251 strlcat(msg, Client->id, sizeof (msg));
258 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
261 * The client that is about to be removed is a server,
262 * the client we are checking right now is a child of that
263 * server and thus has to be removed, too.
265 * Call Client_Destroy() recursively with the server as the
266 * new "object to be removed". This starts the cycle again, until
267 * all servers that are linked via the original server have been
270 Client_Destroy( c, NULL, msg, false );
277 /* found the client: remove it */
278 if( last ) last->next = c->next;
279 else My_Clients = (CLIENT *)c->next;
281 if(c->type == CLIENT_USER || c->type == CLIENT_SERVICE)
282 Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
283 else if( c->type == CLIENT_SERVER )
285 if (c != This_Server) {
286 if (c->conn_id != NONE)
287 Log(LOG_NOTICE|LOG_snotice,
288 "Server \"%s\" unregistered (connection %d): %s.",
289 c->id, c->conn_id, txt);
291 Log(LOG_NOTICE|LOG_snotice,
292 "Server \"%s\" unregistered: %s.",
296 /* inform other servers */
297 if( ! NGIRCd_SignalQuit )
299 if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
300 else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
305 if (c->conn_id != NONE) {
308 "Client \"%s\" unregistered (connection %d): %s.",
309 c->id, c->conn_id, txt);
312 "Client unregistered (connection %d): %s.",
316 "Unregistered unknown client \"%s\": %s",
317 c->id[0] ? c->id : "(No Nick)", txt);
327 c = (CLIENT *)c->next;
329 } /* Client_Destroy */
333 * Set client hostname.
335 * If global hostname cloaking is in effect, don't set the real hostname
336 * but the configured one.
338 * @param Client The client of which the hostname should be set.
339 * @param Hostname The new hostname.
342 Client_SetHostname( CLIENT *Client, const char *Hostname )
344 assert(Client != NULL);
345 assert(Hostname != NULL);
347 if (strlen(Conf_CloakHost)) {
348 char cloak[GETID_LEN];
350 strlcpy(cloak, Hostname, GETID_LEN);
351 strlcat(cloak, Conf_CloakHostSalt, GETID_LEN);
352 snprintf(cloak, GETID_LEN, Conf_CloakHost, Hash(cloak));
354 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
355 Client_ID(Client), Client->host, cloak);
356 strlcpy(Client->host, cloak, sizeof(Client->host));
358 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
359 Client_ID(Client), Client->host, Hostname);
360 strlcpy(Client->host, Hostname, sizeof(Client->host));
362 } /* Client_SetHostname */
366 Client_SetID( CLIENT *Client, const char *ID )
368 assert( Client != NULL );
369 assert( ID != NULL );
371 strlcpy( Client->id, ID, sizeof( Client->id ));
373 if (Conf_CloakUserToNick) {
374 strlcpy( Client->user, ID, sizeof( Client->user ));
375 strlcpy( Client->info, ID, sizeof( Client->info ));
379 Client->hash = Hash( Client->id );
384 Client_SetUser( CLIENT *Client, const char *User, bool Idented )
386 /* set clients username */
388 assert( Client != NULL );
389 assert( User != NULL );
391 if (Conf_CloakUserToNick) {
392 strlcpy(Client->user, Client->id, sizeof(Client->user));
393 } else if (Idented) {
394 strlcpy(Client->user, User, sizeof(Client->user));
396 Client->user[0] = '~';
397 strlcpy(Client->user + 1, User, sizeof(Client->user) - 1);
399 } /* Client_SetUser */
403 * Set "original" user name of a client.
404 * This function saves the "original" user name, the user name specified by
405 * the peer using the USER command, into the CLIENT structure. This user
406 * name may be used for authentication, for example.
407 * @param Client The client.
408 * @param User User name to set.
411 Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
413 assert(Client != NULL);
414 assert(User != NULL);
416 #if defined(PAM) && defined(IDENTAUTH)
417 strlcpy(Client->orig_user, User, sizeof(Client->orig_user));
419 } /* Client_SetOrigUser */
423 Client_SetInfo( CLIENT *Client, const char *Info )
425 /* set client hostname */
427 assert( Client != NULL );
428 assert( Info != NULL );
430 if (Conf_CloakUserToNick)
431 strlcpy(Client->info, Client->id, sizeof(Client->info));
433 strlcpy(Client->info, Info, sizeof(Client->info));
434 } /* Client_SetInfo */
438 Client_SetModes( CLIENT *Client, const char *Modes )
440 assert( Client != NULL );
441 assert( Modes != NULL );
443 strlcpy(Client->modes, Modes, sizeof( Client->modes ));
444 } /* Client_SetModes */
448 Client_SetFlags( CLIENT *Client, const char *Flags )
450 assert( Client != NULL );
451 assert( Flags != NULL );
453 strlcpy(Client->flags, Flags, sizeof(Client->flags));
454 } /* Client_SetFlags */
458 Client_SetAway( CLIENT *Client, const char *Txt )
460 /* Set AWAY reason of client */
462 assert( Client != NULL );
463 assert( Txt != NULL );
465 strlcpy( Client->away, Txt, sizeof( Client->away ));
466 LogDebug("%s \"%s\" is away: %s", Client_TypeText(Client),
467 Client_Mask(Client), Txt);
468 } /* Client_SetAway */
472 Client_SetType( CLIENT *Client, int Type )
474 assert( Client != NULL );
476 if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
477 Adjust_Counters( Client );
478 } /* Client_SetType */
482 Client_SetHops( CLIENT *Client, int Hops )
484 assert( Client != NULL );
486 } /* Client_SetHops */
490 Client_SetToken( CLIENT *Client, int Token )
492 assert( Client != NULL );
493 Client->token = Token;
494 } /* Client_SetToken */
498 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
500 assert( Client != NULL );
501 assert( Introducer != NULL );
502 Client->introducer = Introducer;
503 } /* Client_SetIntroducer */
507 Client_SetOperByMe( CLIENT *Client, bool OperByMe )
509 assert( Client != NULL );
510 Client->oper_by_me = OperByMe;
511 } /* Client_SetOperByMe */
515 Client_ModeAdd( CLIENT *Client, char Mode )
518 * If Client already had Mode, return false.
519 * If the Mode was newly set, return true.
524 assert( Client != NULL );
526 x[0] = Mode; x[1] = '\0';
527 if (!Client_HasMode(Client, x[0])) {
528 strlcat( Client->modes, x, sizeof( Client->modes ));
532 } /* Client_ModeAdd */
536 Client_ModeDel( CLIENT *Client, char Mode )
539 * If Mode was removed, return true.
540 * If Client did not have Mode, return false.
545 assert( Client != NULL );
547 x[0] = Mode; x[1] = '\0';
549 p = strchr( Client->modes, x[0] );
550 if( ! p ) return false;
552 /* Client has Mode -> delete */
559 } /* Client_ModeDel */
563 * Search CLIENT structure of a given nick name.
565 * @return Pointer to CLIENT structure or NULL if not found.
568 Client_Search( const char *Nick )
570 char search_id[CLIENT_ID_LEN], *ptr;
574 assert( Nick != NULL );
576 /* copy Nick and truncate hostmask if necessary */
577 strlcpy( search_id, Nick, sizeof( search_id ));
578 ptr = strchr( search_id, '!' );
579 if( ptr ) *ptr = '\0';
581 search_hash = Hash(search_id);
585 if (c->hash == search_hash && strcasecmp(c->id, search_id) == 0)
587 c = (CLIENT *)c->next;
594 * Search first CLIENT structure matching a given mask of a server.
596 * The order of servers is arbitrary, but this function makes sure that the
597 * local server is always returned if the mask matches it.
599 * @return Pointer to CLIENT structure or NULL if no server could be found.
602 Client_SearchServer(const char *Mask)
606 assert(Mask != NULL);
608 /* First check if mask matches the local server */
609 if (MatchCaseInsensitive(Mask, Client_ID(Client_ThisServer())))
610 return Client_ThisServer();
614 if (Client_Type(c) == CLIENT_SERVER) {
615 /* This is a server: check if Mask matches */
616 if (MatchCaseInsensitive(Mask, c->id))
619 c = (CLIENT *)c->next;
626 * Get client structure ("introducer") identfied by a server token.
627 * @return CLIENT structure or NULL if none could be found.
630 Client_GetFromToken( CLIENT *Client, int Token )
634 assert( Client != NULL );
641 if ((c->type == CLIENT_SERVER) && (c->introducer == Client) &&
644 c = (CLIENT *)c->next;
647 } /* Client_GetFromToken */
651 Client_Type( CLIENT *Client )
653 assert( Client != NULL );
659 Client_Conn( CLIENT *Client )
661 assert( Client != NULL );
662 return Client->conn_id;
667 Client_ID( CLIENT *Client )
669 assert( Client != NULL );
672 if(Client->type == CLIENT_USER)
673 assert(strlen(Client->id) < Conf_MaxNickLength);
676 if( Client->id[0] ) return Client->id;
682 Client_Info( CLIENT *Client )
684 assert( Client != NULL );
690 Client_User( CLIENT *Client )
692 assert( Client != NULL );
693 return Client->user[0] ? Client->user : "~";
700 * Get the "original" user name as supplied by the USER command.
701 * The user name as given by the client is used for authentication instead
702 * of the one detected using IDENT requests.
703 * @param Client The client.
704 * @return Original user name.
707 Client_OrigUser(CLIENT *Client) {
709 char *user = Client->user;
715 return Client->orig_user;
717 } /* Client_OrigUser */
722 * Return the hostname of a client.
723 * @param Client Pointer to client structure
724 * @return Pointer to client hostname
727 Client_Hostname(CLIENT *Client)
729 assert (Client != NULL);
734 * Return the cloaked hostname of a client, if set.
735 * @param Client Pointer to the client structure.
736 * @return Pointer to the cloaked hostname or NULL if not set.
739 Client_HostnameCloaked(CLIENT *Client)
741 assert(Client != NULL);
742 return Client->cloaked;
746 * Get (potentially cloaked) hostname of a client to display it to other users.
748 * If the client has not enabled cloaking, the real hostname is used.
750 * @param Client Pointer to client structure
751 * @return Pointer to client hostname
754 Client_HostnameDisplayed(CLIENT *Client)
756 assert(Client != NULL);
758 /* Client isn't cloaked at all, return real hostname: */
759 if (!Client_HasMode(Client, 'x'))
760 return Client_Hostname(Client);
762 /* Use an already saved cloaked hostname, if there is one */
764 return Client->cloaked;
766 Client_UpdateCloakedHostname(Client, NULL, NULL);
767 return Client->cloaked;
771 * Update (and generate, if necessary) the cloaked hostname of a client.
773 * The newly set cloaked hostname is announced in the network using METADATA
774 * commands to peers that support this feature.
776 * @param Client The client of which the cloaked hostname should be updated.
777 * @param Origin The originator of the hostname change, or NULL if this server.
778 * @param Hostname The new cloaked hostname, or NULL if it should be generated.
781 Client_UpdateCloakedHostname(CLIENT *Client, CLIENT *Origin,
782 const char *Hostname)
784 char Cloak_Buffer[CLIENT_HOST_LEN];
786 assert(Client != NULL);
788 Origin = Client_ThisServer();
790 if (!Client->cloaked) {
791 Client->cloaked = malloc(CLIENT_HOST_LEN);
792 if (!Client->cloaked)
797 /* Generate new cloaked hostname */
798 if (*Conf_CloakHostModeX) {
799 strlcpy(Cloak_Buffer, Client->host,
800 sizeof(Cloak_Buffer));
801 strlcat(Cloak_Buffer, Conf_CloakHostSalt,
802 sizeof(Cloak_Buffer));
803 snprintf(Client->cloaked, CLIENT_HOST_LEN,
804 Conf_CloakHostModeX, Hash(Cloak_Buffer));
806 strlcpy(Client->cloaked, Client_ID(Client->introducer),
809 strlcpy(Client->cloaked, Hostname, CLIENT_HOST_LEN);
810 LogDebug("Cloaked hostname of \"%s\" updated to \"%s\"",
811 Client_ID(Client), Client->cloaked);
813 /* Inform other servers in the network */
814 IRC_WriteStrServersPrefixFlag(Client_NextHop(Origin), Origin, 'M',
815 "METADATA %s cloakhost :%s",
816 Client_ID(Client), Client->cloaked);
820 Client_Modes( CLIENT *Client )
822 assert( Client != NULL );
823 return Client->modes;
828 Client_Flags( CLIENT *Client )
830 assert( Client != NULL );
831 return Client->flags;
836 Client_OperByMe( CLIENT *Client )
838 assert( Client != NULL );
839 return Client->oper_by_me;
840 } /* Client_OperByMe */
844 Client_Hops( CLIENT *Client )
846 assert( Client != NULL );
852 Client_Token( CLIENT *Client )
854 assert( Client != NULL );
855 return Client->token;
860 Client_MyToken( CLIENT *Client )
862 assert( Client != NULL );
863 return Client->mytoken;
864 } /* Client_MyToken */
868 Client_NextHop( CLIENT *Client )
872 assert( Client != NULL );
875 while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server ))
879 } /* Client_NextHop */
883 * Return ID of a client: "client!user@host"
884 * This client ID is used for IRC prefixes, for example.
885 * Please note that this function uses a global static buffer, so you can't
886 * nest invocations without overwriting earlier results!
887 * @param Client Pointer to client structure
888 * @return Pointer to global buffer containing the client ID
891 Client_Mask( CLIENT *Client )
893 static char Mask_Buffer[GETID_LEN];
895 assert (Client != NULL);
897 /* Servers: return name only, there is no "mask" */
898 if (Client->type == CLIENT_SERVER)
901 snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
902 Client->id, Client->user, Client->host);
908 * Return ID of a client with cloaked hostname: "client!user@server-name"
910 * This client ID is used for IRC prefixes, for example.
911 * Please note that this function uses a global static buffer, so you can't
912 * nest invocations without overwriting earlier results!
913 * If the client has not enabled cloaking, the real hostname is used.
915 * @param Client Pointer to client structure
916 * @return Pointer to global buffer containing the client ID
919 Client_MaskCloaked(CLIENT *Client)
921 static char Mask_Buffer[GETID_LEN];
923 assert (Client != NULL);
925 /* Is the client using cloaking at all? */
926 if (!Client_HasMode(Client, 'x'))
927 return Client_Mask(Client);
929 snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user,
930 Client_HostnameDisplayed(Client));
933 } /* Client_MaskCloaked */
937 Client_Introducer( CLIENT *Client )
939 assert( Client != NULL );
940 return Client->introducer;
941 } /* Client_Introducer */
945 Client_TopServer( CLIENT *Client )
947 assert( Client != NULL );
948 return Client->topserver;
949 } /* Client_TopServer */
953 Client_HasMode( CLIENT *Client, char Mode )
955 assert( Client != NULL );
956 return strchr( Client->modes, Mode ) != NULL;
957 } /* Client_HasMode */
961 Client_HasFlag( CLIENT *Client, char Flag )
963 assert( Client != NULL );
964 return strchr( Client->flags, Flag ) != NULL;
965 } /* Client_HasFlag */
969 Client_Away( CLIENT *Client )
971 assert( Client != NULL );
977 * Make sure that a given nickname is valid.
979 * If the nickname is not valid for the given client, this function sends back
980 * the appropriate error messages.
982 * @param Client Client that wants to change the nickname.
983 * @param Nick New nickname.
984 * @returns true if nickname is valid, false otherwise.
987 Client_CheckNick(CLIENT *Client, char *Nick)
989 assert(Client != NULL);
990 assert(Nick != NULL);
992 if (!Client_IsValidNick(Nick)) {
993 if (strlen(Nick ) >= Conf_MaxNickLength)
994 IRC_WriteErrClient(Client, ERR_NICKNAMETOOLONG_MSG,
995 Client_ID(Client), Nick,
996 Conf_MaxNickLength - 1);
998 IRC_WriteErrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
999 Client_ID(Client), Nick);
1003 if (Client_Type(Client) != CLIENT_SERVER
1004 && Client_Type(Client) != CLIENT_SERVICE) {
1005 /* Make sure that this isn't a restricted/forbidden nickname */
1006 if (Conf_NickIsBlocked(Nick)) {
1007 IRC_WriteErrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
1008 Client_ID(Client), Nick);
1013 /* Nickname already registered? */
1014 if (Client_Search(Nick)) {
1015 IRC_WriteErrClient(Client, ERR_NICKNAMEINUSE_MSG,
1016 Client_ID(Client), Nick);
1021 } /* Client_CheckNick */
1025 Client_CheckID( CLIENT *Client, char *ID )
1027 char str[COMMAND_LEN];
1030 assert( Client != NULL );
1031 assert( Client->conn_id > NONE );
1032 assert( ID != NULL );
1035 if (strlen(ID) > CLIENT_ID_LEN) {
1036 IRC_WriteErrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
1037 Client_ID(Client), ID);
1041 /* ID already in use? */
1044 if (strcasecmp(c->id, ID) == 0) {
1045 snprintf(str, sizeof(str), "ID \"%s\" already registered", ID);
1046 if (c->conn_id != NONE)
1047 Log(LOG_ERR, "%s (on connection %d)!", str, c->conn_id);
1049 Log(LOG_ERR, "%s (via network)!", str);
1050 Conn_Close(Client->conn_id, str, str, true);
1053 c = (CLIENT *)c->next;
1057 } /* Client_CheckID */
1061 Client_First( void )
1064 } /* Client_First */
1068 Client_Next( CLIENT *c )
1070 assert( c != NULL );
1071 return (CLIENT *)c->next;
1076 Client_UserCount( void )
1078 return Count( CLIENT_USER );
1079 } /* Client_UserCount */
1083 Client_ServiceCount( void )
1085 return Count( CLIENT_SERVICE );;
1086 } /* Client_ServiceCount */
1090 Client_ServerCount( void )
1092 return Count( CLIENT_SERVER );
1093 } /* Client_ServerCount */
1097 Client_MyUserCount( void )
1099 return MyCount( CLIENT_USER );
1100 } /* Client_MyUserCount */
1104 Client_MyServiceCount( void )
1106 return MyCount( CLIENT_SERVICE );
1107 } /* Client_MyServiceCount */
1110 GLOBAL unsigned long
1111 Client_MyServerCount( void )
1114 unsigned long cnt = 0;
1119 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
1120 c = (CLIENT *)c->next;
1123 } /* Client_MyServerCount */
1126 GLOBAL unsigned long
1127 Client_OperCount( void )
1130 unsigned long cnt = 0;
1135 if (c && c->type == CLIENT_USER && Client_HasMode(c, 'o' ))
1137 c = (CLIENT *)c->next;
1140 } /* Client_OperCount */
1143 GLOBAL unsigned long
1144 Client_UnknownCount( void )
1147 unsigned long cnt = 0;
1152 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
1153 c = (CLIENT *)c->next;
1157 } /* Client_UnknownCount */
1161 Client_MaxUserCount( void )
1164 } /* Client_MaxUserCount */
1168 Client_MyMaxUserCount( void )
1170 return My_Max_Users;
1171 } /* Client_MyMaxUserCount */
1175 * Check that a given nickname is valid.
1177 * @param Nick the nickname to check.
1178 * @returns true if nickname is valid, false otherwise.
1181 Client_IsValidNick(const char *Nick)
1184 static const char goodchars[] = ";0123456789-";
1186 assert (Nick != NULL);
1188 if (strchr(goodchars, Nick[0]))
1190 if (strlen(Nick ) >= Conf_MaxNickLength)
1195 if (*ptr < 'A' && !strchr(goodchars, *ptr ))
1203 } /* Client_IsValidNick */
1207 * Return pointer to "My_Whowas" structure.
1210 Client_GetWhowas( void )
1213 } /* Client_GetWhowas */
1216 * Return the index of the last used WHOWAS entry.
1219 Client_GetLastWhowasIndex( void )
1222 } /* Client_GetLastWhowasIndex */
1226 * Get the start time of this client.
1227 * The result is the start time in seconds since 1970-01-01, as reported
1228 * by the C function time(NULL).
1231 Client_StartTime(CLIENT *Client)
1233 assert( Client != NULL );
1234 return Client->starttime;
1235 } /* Client_Uptime */
1239 * Reject a client when logging in.
1241 * This function is called when a client isn't allowed to connect to this
1242 * server. Possible reasons are bad server password, bad PAM password,
1243 * or that the client is G/K-Line'd.
1245 * After calling this function, the client isn't connected any more.
1247 * @param Client The client to reject.
1248 * @param Reason The reason why the client has been rejected.
1249 * @param InformClient If true, send the exact reason to the client.
1252 Client_Reject(CLIENT *Client, const char *Reason, bool InformClient)
1254 char info[COMMAND_LEN];
1256 assert(Client != NULL);
1257 assert(Reason != NULL);
1260 snprintf(info, sizeof(info), "Access denied: %s", Reason);
1262 strcpy(info, "Access denied: Bad password?");
1265 "User \"%s\" rejected (connection %d): %s!",
1266 Client_Mask(Client), Client_Conn(Client), Reason);
1267 Conn_Close(Client_Conn(Client), Reason, info, true);
1272 * Introduce a new user or service client in the network.
1274 * @param From Remote server introducing the client or NULL (local).
1275 * @param Client New client.
1276 * @param Type Type of the client (CLIENT_USER or CLIENT_SERVICE).
1279 Client_Introduce(CLIENT *From, CLIENT *Client, int Type)
1281 /* Set client type (user or service) */
1282 Client_SetType(Client, Type);
1285 if (Conf_NickIsService(Conf_GetServer(Client_Conn(From)),
1287 Client_SetType(Client, CLIENT_SERVICE);
1288 LogDebug("%s \"%s\" (+%s) registered (via %s, on %s, %d hop%s).",
1289 Client_TypeText(Client), Client_Mask(Client),
1290 Client_Modes(Client), Client_ID(From),
1291 Client_ID(Client_Introducer(Client)),
1292 Client_Hops(Client), Client_Hops(Client) > 1 ? "s": "");
1294 Log(LOG_NOTICE, "%s \"%s\" registered (connection %d).",
1295 Client_TypeText(Client), Client_Mask(Client),
1296 Client_Conn(Client));
1297 Log_ServerNotice('c', "Client connecting: %s (%s@%s) [%s] - %s",
1298 Client_ID(Client), Client_User(Client),
1299 Client_Hostname(Client),
1300 Conn_IPA(Client_Conn(Client)),
1301 Client_TypeText(Client));
1304 /* Inform other servers */
1305 IRC_WriteStrServersPrefixFlag_CB(From,
1306 From != NULL ? From : Client_ThisServer(),
1307 '\0', cb_introduceClient, (void *)Client);
1308 } /* Client_Introduce */
1311 static unsigned long
1312 Count( CLIENT_TYPE Type )
1315 unsigned long cnt = 0;
1320 if( c->type == Type ) cnt++;
1321 c = (CLIENT *)c->next;
1327 static unsigned long
1328 MyCount( CLIENT_TYPE Type )
1331 unsigned long cnt = 0;
1336 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
1337 c = (CLIENT *)c->next;
1344 New_Client_Struct( void )
1348 c = (CLIENT *)malloc( sizeof( CLIENT ));
1351 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1355 memset( c, 0, sizeof ( CLIENT ));
1357 c->type = CLIENT_UNKNOWN;
1359 c->oper_by_me = false;
1369 Generate_MyToken( CLIENT *Client )
1378 if( c->mytoken == token )
1380 /* The token is already in use */
1385 else c = (CLIENT *)c->next;
1387 Client->mytoken = token;
1388 LogDebug("Assigned token %d to server \"%s\".", token, Client->id);
1389 } /* Generate_MyToken */
1393 Adjust_Counters( CLIENT *Client )
1397 assert( Client != NULL );
1399 if( Client->type != CLIENT_USER ) return;
1401 if( Client->conn_id != NONE )
1403 /* Local connection */
1404 count = Client_MyUserCount( );
1405 if( count > My_Max_Users ) My_Max_Users = count;
1407 count = Client_UserCount( );
1408 if( count > Max_Users ) Max_Users = count;
1409 } /* Adjust_Counters */
1413 * Register client in My_Whowas structure for further recall by WHOWAS.
1414 * Note: Only clients that have been connected at least 30 seconds will be
1415 * registered to prevent automated IRC bots to "destroy" a nice server
1419 Client_RegisterWhowas( CLIENT *Client )
1424 assert( Client != NULL );
1426 /* Don't register WHOWAS information when "MorePrivacy" is enabled. */
1427 if (Conf_MorePrivacy)
1431 /* Don't register clients that were connected less than 30 seconds. */
1432 if( now - Client->starttime < 30 )
1435 slot = Last_Whowas + 1;
1436 if( slot >= MAX_WHOWAS || slot < 0 ) slot = 0;
1439 Log( LOG_DEBUG, "Saving WHOWAS information to slot %d ...", slot );
1442 My_Whowas[slot].time = now;
1443 strlcpy( My_Whowas[slot].id, Client_ID( Client ),
1444 sizeof( My_Whowas[slot].id ));
1445 strlcpy( My_Whowas[slot].user, Client_User( Client ),
1446 sizeof( My_Whowas[slot].user ));
1447 strlcpy( My_Whowas[slot].host, Client_HostnameDisplayed( Client ),
1448 sizeof( My_Whowas[slot].host ));
1449 strlcpy( My_Whowas[slot].info, Client_Info( Client ),
1450 sizeof( My_Whowas[slot].info ));
1451 strlcpy( My_Whowas[slot].server, Client_ID( Client_Introducer( Client )),
1452 sizeof( My_Whowas[slot].server ));
1455 } /* Client_RegisterWhowas */
1459 Client_TypeText(CLIENT *Client)
1461 assert(Client != NULL);
1462 switch (Client_Type(Client)) {
1466 case CLIENT_SERVICE:
1475 } /* Client_TypeText */
1479 * Destroy user or service client.
1482 Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool SendQuit)
1484 if(Client->conn_id != NONE) {
1485 /* Local (directly connected) client */
1487 "%s \"%s\" unregistered (connection %d): %s.",
1488 Client_TypeText(Client), Client_Mask(Client),
1489 Client->conn_id, Txt);
1490 Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
1491 Client_ID(Client), Client_User(Client),
1492 Client_Hostname(Client), Txt);
1495 /* Inforam all the other servers */
1497 IRC_WriteStrServersPrefix(NULL,
1498 Client, "QUIT :%s", FwdMsg );
1500 IRC_WriteStrServersPrefix(NULL,
1505 LogDebug("%s \"%s\" unregistered: %s.",
1506 Client_TypeText(Client), Client_Mask(Client), Txt);
1509 /* Inform all the other servers, but the ones in the
1510 * direction we got the QUIT from */
1512 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1513 Client, "QUIT :%s", FwdMsg );
1515 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1520 /* Unregister client from channels */
1521 Channel_Quit(Client, FwdMsg ? FwdMsg : Client->id);
1523 /* Register client in My_Whowas structure */
1524 Client_RegisterWhowas(Client);
1525 } /* Destroy_UserOrService */
1529 * Introduce a new user or service client to a remote server.
1531 * @param To The remote server to inform.
1532 * @param Prefix Prefix for the generated commands.
1533 * @param data CLIENT structure of the new client.
1536 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
1538 CLIENT *c = (CLIENT *)data;
1540 (void)Client_Announce(To, Prefix, c);
1542 } /* cb_introduceClient */
1546 * Announce an user or service to a server.
1548 * This function differentiates between RFC1459 and RFC2813 server links and
1549 * generates the appropriate commands to register the user or service.
1551 * @param Client Server
1552 * @param Prefix Prefix for the generated commands
1553 * @param User User to announce
1556 Client_Announce(CLIENT * Client, CLIENT * Prefix, CLIENT * User)
1559 char *modes, *user, *host;
1561 modes = Client_Modes(User);
1562 user = Client_User(User) ? Client_User(User) : "-";
1563 host = Client_Hostname(User) ? Client_Hostname(User) : "-";
1565 conn = Client_Conn(Client);
1566 if (Conn_Options(conn) & CONN_RFC1459) {
1567 /* RFC 1459 mode: separate NICK and USER commands */
1568 if (! Conn_WriteStr(conn, "NICK %s :%d",
1569 Client_ID(User), Client_Hops(User) + 1))
1570 return DISCONNECTED;
1571 if (! Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
1572 Client_ID(User), user, host,
1573 Client_ID(Client_Introducer(User)),
1575 return DISCONNECTED;
1577 if (! Conn_WriteStr(conn, ":%s MODE %s +%s",
1578 Client_ID(User), Client_ID(User),
1580 return DISCONNECTED;
1583 /* RFC 2813 mode: one combined NICK or SERVICE command */
1584 if (Client_Type(User) == CLIENT_SERVICE
1585 && Client_HasFlag(Client, 'S')) {
1586 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1587 "SERVICE %s %d * +%s %d :%s",
1589 Client_MyToken(Client_Introducer(User)),
1590 modes, Client_Hops(User) + 1,
1592 return DISCONNECTED;
1594 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1595 "NICK %s %d %s %s %d +%s :%s",
1596 Client_ID(User), Client_Hops(User) + 1,
1598 Client_MyToken(Client_Introducer(User)),
1599 modes, Client_Info(User)))
1600 return DISCONNECTED;
1604 if (Client_HasFlag(Client, 'M')) {
1605 /* Synchronize metadata */
1606 if (Client_HostnameCloaked(User)) {
1607 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1608 "METADATA %s cloakhost :%s",
1610 Client_HostnameCloaked(User)))
1611 return DISCONNECTED;
1614 if (Conn_GetCertFp(Client_Conn(User))) {
1615 if (!IRC_WriteStrClientPrefix(Client, Prefix,
1616 "METADATA %s certfp :%s",
1618 Conn_GetCertFp(Client_Conn(User))))
1619 return DISCONNECTED;
1624 } /* Client_Announce */
1630 Client_DebugDump(void)
1634 Log(LOG_DEBUG, "Client status:");
1638 " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
1639 Client_ID(c), Client_Type(c), Client_Hostname(c),
1640 Client_User(c), Client_Conn(c), Client_StartTime(c),
1642 c = (CLIENT *)c->next;
1644 } /* Client_DumpClients */