4728c7a4672ac802d944dc599d23031f75e50d60
[ngircd-alex.git] / src / ngircd / client.c
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001-2012 Alexander Barton (alex@barton.de)
4  *
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.
10  */
11
12 #define __client_c__
13
14 #include "portab.h"
15
16 /**
17  * @file
18  * Client management.
19  */
20
21 #include "imp.h"
22 #include <assert.h>
23 #include <unistd.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <strings.h>
28 #include <netdb.h>
29
30 #include "defines.h"
31 #include "conn.h"
32
33 #include "exp.h"
34 #include "client.h"
35
36 #include <imp.h>
37 #include "ngircd.h"
38 #include "channel.h"
39 #include "conf.h"
40 #include "conn-func.h"
41 #include "hash.h"
42 #include "irc-write.h"
43 #include "log.h"
44 #include "messages.h"
45
46 #include <exp.h>
47
48 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
49
50 static CLIENT *This_Server, *My_Clients;
51
52 static WHOWAS My_Whowas[MAX_WHOWAS];
53 static int Last_Whowas = -1;
54 static long Max_Users, My_Max_Users;
55
56
57 static unsigned long Count PARAMS(( CLIENT_TYPE Type ));
58 static unsigned long MyCount PARAMS(( CLIENT_TYPE Type ));
59
60 static CLIENT *New_Client_Struct PARAMS(( void ));
61 static void Generate_MyToken PARAMS(( CLIENT *Client ));
62 static void Adjust_Counters PARAMS(( CLIENT *Client ));
63
64 static CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
65                                        CLIENT *TopServer, int Type, const char *ID,
66                                        const char *User, const char *Hostname, const char *Info,
67                                        int Hops, int Token, const char *Modes,
68                                        bool Idented));
69
70 static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
71                                         bool SendQuit));
72
73 static void cb_introduceClient PARAMS((CLIENT *Client, CLIENT *Prefix,
74                                        void *i));
75
76 GLOBAL void
77 Client_Init( void )
78 {
79         struct hostent *h;
80         
81         This_Server = New_Client_Struct( );
82         if( ! This_Server )
83         {
84                 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
85                 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
86                 exit( 1 );
87         }
88
89         /* Client-Struktur dieses Servers */
90         This_Server->next = NULL;
91         This_Server->type = CLIENT_SERVER;
92         This_Server->conn_id = NONE;
93         This_Server->introducer = This_Server;
94         This_Server->mytoken = 1;
95         This_Server->hops = 0;
96
97         gethostname( This_Server->host, CLIENT_HOST_LEN );
98         if (Conf_DNS) {
99                 h = gethostbyname( This_Server->host );
100                 if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
101         }
102         Client_SetID( This_Server, Conf_ServerName );
103         Client_SetInfo( This_Server, Conf_ServerInfo );
104
105         My_Clients = This_Server;
106         
107         memset( &My_Whowas, 0, sizeof( My_Whowas ));
108 } /* Client_Init */
109
110
111 GLOBAL void
112 Client_Exit( void )
113 {
114         CLIENT *c, *next;
115         int cnt;
116
117         if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, false );
118         else Client_Destroy( This_Server, "Server going down.", NULL, false );
119         
120         cnt = 0;
121         c = My_Clients;
122         while( c )
123         {
124                 cnt++;
125                 next = (CLIENT *)c->next;
126                 free( c );
127                 c = next;
128         }
129         if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
130 } /* Client_Exit */
131
132
133 GLOBAL CLIENT *
134 Client_ThisServer( void )
135 {
136         return This_Server;
137 } /* Client_ThisServer */
138
139
140 /**
141  * Initialize new local client; wrapper function for Init_New_Client().
142  * @return New CLIENT structure.
143  */
144 GLOBAL CLIENT *
145 Client_NewLocal(CONN_ID Idx, const char *Hostname, int Type, bool Idented)
146 {
147         return Init_New_Client(Idx, This_Server, NULL, Type, NULL, NULL,
148                 Hostname, NULL, 0, 0, NULL, Idented);
149 } /* Client_NewLocal */
150
151
152 /**
153  * Initialize new remote server; wrapper function for Init_New_Client().
154  * @return New CLIENT structure.
155  */
156 GLOBAL CLIENT *
157 Client_NewRemoteServer(CLIENT *Introducer, const char *Hostname, CLIENT *TopServer,
158  int Hops, int Token, const char *Info, bool Idented)
159 {
160         return Init_New_Client(NONE, Introducer, TopServer, CLIENT_SERVER,
161                 Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented);
162 } /* Client_NewRemoteServer */
163
164
165 /**
166  * Initialize new remote client; wrapper function for Init_New_Client().
167  * @return New CLIENT structure.
168  */
169 GLOBAL CLIENT *
170 Client_NewRemoteUser(CLIENT *Introducer, const char *Nick, int Hops, const char *User,
171  const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented)
172 {
173         return Init_New_Client(NONE, Introducer, NULL, CLIENT_USER, Nick,
174                 User, Hostname, Info, Hops, Token, Modes, Idented);
175 } /* Client_NewRemoteUser */
176
177
178 /**
179  * Initialize new client and set up the given parameters like client type,
180  * user name, host name, introducing server etc. ...
181  * @return New CLIENT structure.
182  */
183 static CLIENT *
184 Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
185   int Type, const char *ID, const char *User, const char *Hostname,
186   const char *Info, int Hops, int Token, const char *Modes, bool Idented)
187 {
188         CLIENT *client;
189
190         assert(Idx >= NONE);
191         assert(Introducer != NULL);
192
193         client = New_Client_Struct();
194         if (!client)
195                 return NULL;
196
197         client->starttime = time(NULL);
198         client->conn_id = Idx;
199         client->introducer = Introducer;
200         client->topserver = TopServer;
201         client->type = Type;
202         if (ID)
203                 Client_SetID(client, ID);
204         if (User) {
205                 Client_SetUser(client, User, Idented);
206                 Client_SetOrigUser(client, User);
207         }
208         if (Hostname)
209                 Client_SetHostname(client, Hostname);
210         if (Info)
211                 Client_SetInfo(client, Info);
212         client->hops = Hops;
213         client->token = Token;
214         if (Modes)
215                 Client_SetModes(client, Modes);
216         if (Type == CLIENT_SERVER)
217                 Generate_MyToken(client);
218
219         if (strchr(client->modes, 'a'))
220                 strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
221
222         client->next = (POINTER *)My_Clients;
223         My_Clients = client;
224
225         Adjust_Counters(client);
226
227         return client;
228 } /* Init_New_Client */
229
230
231 GLOBAL void
232 Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit )
233 {
234         /* remove a client */
235         
236         CLIENT *last, *c;
237         char msg[LINE_LEN];
238         const char *txt;
239
240         assert( Client != NULL );
241
242         if( LogMsg ) txt = LogMsg;
243         else txt = FwdMsg;
244         if( ! txt ) txt = "Reason unknown.";
245
246         /* netsplit message */
247         if( Client->type == CLIENT_SERVER ) {
248                 strlcpy(msg, This_Server->id, sizeof (msg));
249                 strlcat(msg, " ", sizeof (msg));
250                 strlcat(msg, Client->id, sizeof (msg));
251         }
252
253         last = NULL;
254         c = My_Clients;
255         while( c )
256         {
257                 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
258                 {
259                         /*
260                          * The client that is about to be removed is a server,
261                          * the client we are checking right now is a child of that
262                          * server and thus has to be removed, too.
263                          *
264                          * Call Client_Destroy() recursively with the server as the
265                          * new "object to be removed". This starts the cycle again, until
266                          * all servers that are linked via the original server have been
267                          * removed.
268                          */
269                         Client_Destroy( c, NULL, msg, false );
270                         last = NULL;
271                         c = My_Clients;
272                         continue;
273                 }
274                 if( c == Client )
275                 {
276                         /* found  the client: remove it */
277                         if( last ) last->next = c->next;
278                         else My_Clients = (CLIENT *)c->next;
279
280                         if(c->type == CLIENT_USER || c->type == CLIENT_SERVICE)
281                                 Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
282                         else if( c->type == CLIENT_SERVER )
283                         {
284                                 if( c != This_Server )
285                                 {
286                                         if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
287                                         else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
288                                 }
289
290                                 /* inform other servers */
291                                 if( ! NGIRCd_SignalQuit )
292                                 {
293                                         if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
294                                         else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
295                                 }
296                         }
297                         else
298                         {
299                                 if( c->conn_id != NONE )
300                                 {
301                                         if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
302                                         else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
303                                 } else {
304                                         Log(LOG_WARNING, "Unregistered unknown client \"%s\": %s",
305                                                                 c->id[0] ? c->id : "(No Nick)", txt );
306                                 }
307                         }
308
309                         free( c );
310                         break;
311                 }
312                 last = c;
313                 c = (CLIENT *)c->next;
314         }
315 } /* Client_Destroy */
316
317
318 /**
319  * Set client hostname.
320  *
321  * If global hostname cloaking is in effect, don't set the real hostname
322  * but the configured one.
323  *
324  * @param Client The client of which the hostname should be set.
325  * @param Hostname The new hostname.
326  */
327 GLOBAL void
328 Client_SetHostname( CLIENT *Client, const char *Hostname )
329 {
330         assert(Client != NULL);
331         assert(Hostname != NULL);
332
333         if (strlen(Conf_CloakHost)) {
334                 char cloak[GETID_LEN];
335
336                 strlcpy(cloak, Hostname, GETID_LEN);
337                 strlcat(cloak, Conf_CloakHostSalt, GETID_LEN);
338                 snprintf(cloak, GETID_LEN, Conf_CloakHost, Hash(cloak));
339
340                 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
341                         Client_ID(Client), Client->host, cloak);
342                 strlcpy(Client->host, cloak, sizeof(Client->host));
343         } else {
344                 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
345                          Client_ID(Client), Client->host, Hostname);
346                 strlcpy(Client->host, Hostname, sizeof(Client->host));
347         }
348 } /* Client_SetHostname */
349
350
351 GLOBAL void
352 Client_SetID( CLIENT *Client, const char *ID )
353 {
354         assert( Client != NULL );
355         assert( ID != NULL );
356         
357         strlcpy( Client->id, ID, sizeof( Client->id ));
358
359         if (Conf_CloakUserToNick) {
360                 strlcpy( Client->user, ID, sizeof( Client->user ));
361                 strlcpy( Client->info, ID, sizeof( Client->info ));
362         }
363
364         /* Hash */
365         Client->hash = Hash( Client->id );
366 } /* Client_SetID */
367
368
369 GLOBAL void
370 Client_SetUser( CLIENT *Client, const char *User, bool Idented )
371 {
372         /* set clients username */
373
374         assert( Client != NULL );
375         assert( User != NULL );
376
377         if (Conf_CloakUserToNick) {
378                 strlcpy(Client->user, Client->id, sizeof(Client->user));
379         } else if (Idented) {
380                 strlcpy(Client->user, User, sizeof(Client->user));
381         } else {
382                 Client->user[0] = '~';
383                 strlcpy(Client->user + 1, User, sizeof(Client->user) - 1);
384         }
385 } /* Client_SetUser */
386
387
388 /**
389  * Set "original" user name of a client.
390  * This function saves the "original" user name, the user name specified by
391  * the peer using the USER command, into the CLIENT structure. This user
392  * name may be used for authentication, for example.
393  * @param Client The client.
394  * @param User User name to set.
395  */
396 GLOBAL void
397 Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
398 {
399         assert(Client != NULL);
400         assert(User != NULL);
401
402 #if defined(PAM) && defined(IDENTAUTH)
403         strlcpy(Client->orig_user, User, sizeof(Client->orig_user));
404 #endif
405 } /* Client_SetOrigUser */
406
407
408 GLOBAL void
409 Client_SetInfo( CLIENT *Client, const char *Info )
410 {
411         /* set client hostname */
412
413         assert( Client != NULL );
414         assert( Info != NULL );
415
416         if (Conf_CloakUserToNick)
417                 strlcpy(Client->info, Client->id, sizeof(Client->info));
418         else
419                 strlcpy(Client->info, Info, sizeof(Client->info));
420 } /* Client_SetInfo */
421
422
423 GLOBAL void
424 Client_SetModes( CLIENT *Client, const char *Modes )
425 {
426         assert( Client != NULL );
427         assert( Modes != NULL );
428
429         strlcpy(Client->modes, Modes, sizeof( Client->modes ));
430 } /* Client_SetModes */
431
432
433 GLOBAL void
434 Client_SetFlags( CLIENT *Client, const char *Flags )
435 {
436         assert( Client != NULL );
437         assert( Flags != NULL );
438
439         strlcpy(Client->flags, Flags, sizeof(Client->flags));
440 } /* Client_SetFlags */
441
442
443 GLOBAL void
444 Client_SetAway( CLIENT *Client, const char *Txt )
445 {
446         /* Set AWAY reason of client */
447
448         assert( Client != NULL );
449         assert( Txt != NULL );
450
451         strlcpy( Client->away, Txt, sizeof( Client->away ));
452         LogDebug("%s \"%s\" is away: %s", Client_TypeText(Client),
453                  Client_Mask(Client), Txt);
454 } /* Client_SetAway */
455
456
457 GLOBAL void
458 Client_SetType( CLIENT *Client, int Type )
459 {
460         assert( Client != NULL );
461         Client->type = Type;
462         if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
463         Adjust_Counters( Client );
464 } /* Client_SetType */
465
466
467 GLOBAL void
468 Client_SetHops( CLIENT *Client, int Hops )
469 {
470         assert( Client != NULL );
471         Client->hops = Hops;
472 } /* Client_SetHops */
473
474
475 GLOBAL void
476 Client_SetToken( CLIENT *Client, int Token )
477 {
478         assert( Client != NULL );
479         Client->token = Token;
480 } /* Client_SetToken */
481
482
483 GLOBAL void
484 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
485 {
486         assert( Client != NULL );
487         assert( Introducer != NULL );
488         Client->introducer = Introducer;
489 } /* Client_SetIntroducer */
490
491
492 GLOBAL void
493 Client_SetOperByMe( CLIENT *Client, bool OperByMe )
494 {
495         assert( Client != NULL );
496         Client->oper_by_me = OperByMe;
497 } /* Client_SetOperByMe */
498
499
500 GLOBAL bool
501 Client_ModeAdd( CLIENT *Client, char Mode )
502 {
503         /* Set Mode.
504          * If Client already alread had Mode, return false.
505          * If the Mode was newly set, return true.
506          */
507
508         char x[2];
509
510         assert( Client != NULL );
511
512         x[0] = Mode; x[1] = '\0';
513         if (!strchr( Client->modes, x[0])) {
514                 strlcat( Client->modes, x, sizeof( Client->modes ));
515                 return true;
516         }
517         else return false;
518 } /* Client_ModeAdd */
519
520
521 GLOBAL bool
522 Client_ModeDel( CLIENT *Client, char Mode )
523 {
524         /* Delete Mode.
525          * If Mode was removed, return true.
526          * If Client did not have Mode, return false.
527          */
528
529         char x[2], *p;
530
531         assert( Client != NULL );
532
533         x[0] = Mode; x[1] = '\0';
534
535         p = strchr( Client->modes, x[0] );
536         if( ! p ) return false;
537
538         /* Client has Mode -> delete */
539         while( *p )
540         {
541                 *p = *(p + 1);
542                 p++;
543         }
544         return true;
545 } /* Client_ModeDel */
546
547
548 GLOBAL CLIENT *
549 Client_Search( const char *Nick )
550 {
551         /* return Client-Structure that has the corresponding Nick.
552          * If none is found, return NULL.
553          */
554
555         char search_id[CLIENT_ID_LEN], *ptr;
556         CLIENT *c = NULL;
557         UINT32 search_hash;
558
559         assert( Nick != NULL );
560
561         /* copy Nick and truncate hostmask if necessary */
562         strlcpy( search_id, Nick, sizeof( search_id ));
563         ptr = strchr( search_id, '!' );
564         if( ptr ) *ptr = '\0';
565
566         search_hash = Hash(search_id);
567
568         c = My_Clients;
569         while (c) {
570                 if (c->hash == search_hash && strcasecmp(c->id, search_id) == 0)
571                         return c;
572                 c = (CLIENT *)c->next;
573         }
574         return NULL;
575 } /* Client_Search */
576
577
578 /**
579  * Get client structure ("introducer") identfied by a server token.
580  * @return CLIENT structure or NULL if none could be found.
581  */
582 GLOBAL CLIENT *
583 Client_GetFromToken( CLIENT *Client, int Token )
584 {
585         CLIENT *c;
586
587         assert( Client != NULL );
588
589         if (!Token)
590                 return NULL;
591
592         c = My_Clients;
593         while (c) {
594                 if ((c->type == CLIENT_SERVER) && (c->introducer == Client) &&
595                         (c->token == Token))
596                                 return c;
597                 c = (CLIENT *)c->next;
598         }
599         return NULL;
600 } /* Client_GetFromToken */
601
602
603 GLOBAL int
604 Client_Type( CLIENT *Client )
605 {
606         assert( Client != NULL );
607         return Client->type;
608 } /* Client_Type */
609
610
611 GLOBAL CONN_ID
612 Client_Conn( CLIENT *Client )
613 {
614         assert( Client != NULL );
615         return Client->conn_id;
616 } /* Client_Conn */
617
618
619 GLOBAL char *
620 Client_ID( CLIENT *Client )
621 {
622         assert( Client != NULL );
623
624 #ifdef DEBUG
625         if(Client->type == CLIENT_USER)
626                 assert(strlen(Client->id) < Conf_MaxNickLength);
627 #endif
628                                                    
629         if( Client->id[0] ) return Client->id;
630         else return "*";
631 } /* Client_ID */
632
633
634 GLOBAL char *
635 Client_Info( CLIENT *Client )
636 {
637         assert( Client != NULL );
638         return Client->info;
639 } /* Client_Info */
640
641
642 GLOBAL char *
643 Client_User( CLIENT *Client )
644 {
645         assert( Client != NULL );
646         return Client->user[0] ? Client->user : "~";
647 } /* Client_User */
648
649
650 #ifdef PAM
651
652 /**
653  * Get the "original" user name as supplied by the USER command.
654  * The user name as given by the client is used for authentication instead
655  * of the one detected using IDENT requests.
656  * @param Client The client.
657  * @return Original user name.
658  */
659 GLOBAL char *
660 Client_OrigUser(CLIENT *Client) {
661 #ifndef IDENTAUTH
662         char *user = Client->user;
663
664         if (user[0] == '~')
665                 user++;
666         return user;
667 #else
668         return Client->orig_user;
669 #endif
670 } /* Client_OrigUser */
671
672 #endif
673
674
675 /**
676  * Return the hostname of a client.
677  * @param Client Pointer to client structure
678  * @return Pointer to client hostname
679  */
680 GLOBAL char *
681 Client_Hostname(CLIENT *Client)
682 {
683         assert (Client != NULL);
684         return Client->host;
685 } /* Client_Hostname */
686
687
688 /**
689  * Get potentially cloaked hostname of a client.
690  *
691  * If the client has not enabled cloaking, the real hostname is used.
692  * Please note that this function uses a global static buffer, so you can't
693  * nest invocations without overwriting earlier results!
694  *
695  * @param Client Pointer to client structure
696  * @return Pointer to client hostname
697  */
698 GLOBAL char *
699 Client_HostnameCloaked(CLIENT *Client)
700 {
701         static char Cloak_Buffer[CLIENT_HOST_LEN];
702
703         assert(Client != NULL);
704
705         if (!Client_HasMode(Client, 'x'))
706                 return Client_Hostname(Client);
707
708         /* Do simple mapping to the server ID? */
709         if (!*Conf_CloakHostModeX)
710                 return Client_ID(Client->introducer);
711
712         strlcpy(Cloak_Buffer, Client->host, CLIENT_HOST_LEN);
713         strlcat(Cloak_Buffer, Conf_CloakHostSalt, CLIENT_HOST_LEN);
714
715         snprintf(Cloak_Buffer, CLIENT_HOST_LEN, Conf_CloakHostModeX,
716                  Hash(Cloak_Buffer));
717
718         return Cloak_Buffer;
719 } /* Client_HostnameCloaked */
720
721
722 GLOBAL char *
723 Client_Modes( CLIENT *Client )
724 {
725         assert( Client != NULL );
726         return Client->modes;
727 } /* Client_Modes */
728
729
730 GLOBAL char *
731 Client_Flags( CLIENT *Client )
732 {
733         assert( Client != NULL );
734         return Client->flags;
735 } /* Client_Flags */
736
737
738 GLOBAL bool
739 Client_OperByMe( CLIENT *Client )
740 {
741         assert( Client != NULL );
742         return Client->oper_by_me;
743 } /* Client_OperByMe */
744
745
746 GLOBAL int
747 Client_Hops( CLIENT *Client )
748 {
749         assert( Client != NULL );
750         return Client->hops;
751 } /* Client_Hops */
752
753
754 GLOBAL int
755 Client_Token( CLIENT *Client )
756 {
757         assert( Client != NULL );
758         return Client->token;
759 } /* Client_Token */
760
761
762 GLOBAL int
763 Client_MyToken( CLIENT *Client )
764 {
765         assert( Client != NULL );
766         return Client->mytoken;
767 } /* Client_MyToken */
768
769
770 GLOBAL CLIENT *
771 Client_NextHop( CLIENT *Client )
772 {
773         CLIENT *c;
774
775         assert( Client != NULL );
776
777         c = Client;
778         while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server ))
779                 c = c->introducer;
780
781         return c;
782 } /* Client_NextHop */
783
784
785 /**
786  * Return ID of a client: "client!user@host"
787  * This client ID is used for IRC prefixes, for example.
788  * Please note that this function uses a global static buffer, so you can't
789  * nest invocations without overwriting earlier results!
790  * @param Client Pointer to client structure
791  * @return Pointer to global buffer containing the client ID
792  */
793 GLOBAL char *
794 Client_Mask( CLIENT *Client )
795 {
796         static char Mask_Buffer[GETID_LEN];
797
798         assert (Client != NULL);
799
800         /* Servers: return name only, there is no "mask" */
801         if (Client->type == CLIENT_SERVER)
802                 return Client->id;
803
804         snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
805                  Client->id, Client->user, Client->host);
806         return Mask_Buffer;
807 } /* Client_Mask */
808
809
810 /**
811  * Return ID of a client with cloaked hostname: "client!user@server-name"
812  *
813  * This client ID is used for IRC prefixes, for example.
814  * Please note that this function uses a global static buffer, so you can't
815  * nest invocations without overwriting earlier results!
816  * If the client has not enabled cloaking, the real hostname is used.
817  *
818  * @param Client Pointer to client structure
819  * @return Pointer to global buffer containing the client ID
820  */
821 GLOBAL char *
822 Client_MaskCloaked(CLIENT *Client)
823 {
824         static char Mask_Buffer[GETID_LEN];
825
826         assert (Client != NULL);
827
828         /* Is the client using cloaking at all? */
829         if (!Client_HasMode(Client, 'x'))
830                 return Client_Mask(Client);
831
832         snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user,
833                  Client_HostnameCloaked(Client));
834
835         return Mask_Buffer;
836 } /* Client_MaskCloaked */
837
838
839 GLOBAL CLIENT *
840 Client_Introducer( CLIENT *Client )
841 {
842         assert( Client != NULL );
843         return Client->introducer;
844 } /* Client_Introducer */
845
846
847 GLOBAL CLIENT *
848 Client_TopServer( CLIENT *Client )
849 {
850         assert( Client != NULL );
851         return Client->topserver;
852 } /* Client_TopServer */
853
854
855 GLOBAL bool
856 Client_HasMode( CLIENT *Client, char Mode )
857 {
858         assert( Client != NULL );
859         return strchr( Client->modes, Mode ) != NULL;
860 } /* Client_HasMode */
861
862
863 GLOBAL char *
864 Client_Away( CLIENT *Client )
865 {
866         assert( Client != NULL );
867         return Client->away;
868 } /* Client_Away */
869
870
871 /**
872  * Make sure that a given nickname is valid.
873  *
874  * If the nickname is not valid for the given client, this function sends back
875  * the appropriate error messages.
876  *
877  * @param       Client Client that wants to change the nickname.
878  * @param       Nick New nick name.
879  * @returns     true if nickname is valid, false otherwise.
880  */
881 GLOBAL bool
882 Client_CheckNick(CLIENT *Client, char *Nick)
883 {
884         assert(Client != NULL);
885         assert(Nick != NULL);
886
887         if (!Client_IsValidNick(Nick)) {
888                 if (strlen(Nick ) >= Conf_MaxNickLength)
889                         IRC_WriteStrClient(Client, ERR_NICKNAMETOOLONG_MSG,
890                                            Client_ID(Client), Nick,
891                                            Conf_MaxNickLength - 1);
892                 else
893                         IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
894                                            Client_ID(Client), Nick);
895                 return false;
896         }
897
898         if (Client_Type(Client) != CLIENT_SERVER
899             && Client_Type(Client) != CLIENT_SERVICE) {
900                 /* Make sure that this isn't a restricted/forbidden nick name */
901                 if (Conf_NickIsBlocked(Nick)) {
902                         IRC_WriteStrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
903                                            Client_ID(Client), Nick);
904                         return false;
905                 }
906         }
907
908         /* Nickname already registered? */
909         if (Client_Search(Nick)) {
910                 IRC_WriteStrClient(Client, ERR_NICKNAMEINUSE_MSG,
911                         Client_ID(Client), Nick);
912                 return false;
913         }
914
915         return true;
916 } /* Client_CheckNick */
917
918
919 GLOBAL bool
920 Client_CheckID( CLIENT *Client, char *ID )
921 {
922         char str[COMMAND_LEN];
923         CLIENT *c;
924
925         assert( Client != NULL );
926         assert( Client->conn_id > NONE );
927         assert( ID != NULL );
928
929         /* ID too long? */
930         if (strlen(ID) > CLIENT_ID_LEN) {
931                 IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID(Client), ID);
932                 return false;
933         }
934
935         /* ID already in use? */
936         c = My_Clients;
937         while (c) {
938                 if (strcasecmp(c->id, ID) == 0) {
939                         snprintf(str, sizeof(str), "ID \"%s\" already registered", ID);
940                         if (c->conn_id != NONE)
941                                 Log(LOG_ERR, "%s (on connection %d)!", str, c->conn_id);
942                         else
943                                 Log(LOG_ERR, "%s (via network)!", str);
944                         Conn_Close(Client->conn_id, str, str, true);
945                         return false;
946                 }
947                 c = (CLIENT *)c->next;
948         }
949
950         return true;
951 } /* Client_CheckID */
952
953
954 GLOBAL CLIENT *
955 Client_First( void )
956 {
957         return My_Clients;
958 } /* Client_First */
959
960
961 GLOBAL CLIENT *
962 Client_Next( CLIENT *c )
963 {
964         assert( c != NULL );
965         return (CLIENT *)c->next;
966 } /* Client_Next */
967
968
969 GLOBAL long
970 Client_UserCount( void )
971 {
972         return Count( CLIENT_USER );
973 } /* Client_UserCount */
974
975
976 GLOBAL long
977 Client_ServiceCount( void )
978 {
979         return Count( CLIENT_SERVICE );;
980 } /* Client_ServiceCount */
981
982
983 GLOBAL long
984 Client_ServerCount( void )
985 {
986         return Count( CLIENT_SERVER );
987 } /* Client_ServerCount */
988
989
990 GLOBAL long
991 Client_MyUserCount( void )
992 {
993         return MyCount( CLIENT_USER );
994 } /* Client_MyUserCount */
995
996
997 GLOBAL long
998 Client_MyServiceCount( void )
999 {
1000         return MyCount( CLIENT_SERVICE );
1001 } /* Client_MyServiceCount */
1002
1003
1004 GLOBAL unsigned long
1005 Client_MyServerCount( void )
1006 {
1007         CLIENT *c;
1008         unsigned long cnt = 0;
1009
1010         c = My_Clients;
1011         while( c )
1012         {
1013                 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
1014                 c = (CLIENT *)c->next;
1015         }
1016         return cnt;
1017 } /* Client_MyServerCount */
1018
1019
1020 GLOBAL unsigned long
1021 Client_OperCount( void )
1022 {
1023         CLIENT *c;
1024         unsigned long cnt = 0;
1025
1026         c = My_Clients;
1027         while( c )
1028         {
1029                 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
1030                 c = (CLIENT *)c->next;
1031         }
1032         return cnt;
1033 } /* Client_OperCount */
1034
1035
1036 GLOBAL unsigned long
1037 Client_UnknownCount( void )
1038 {
1039         CLIENT *c;
1040         unsigned long cnt = 0;
1041
1042         c = My_Clients;
1043         while( c )
1044         {
1045                 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
1046                 c = (CLIENT *)c->next;
1047         }
1048
1049         return cnt;
1050 } /* Client_UnknownCount */
1051
1052
1053 GLOBAL long
1054 Client_MaxUserCount( void )
1055 {
1056         return Max_Users;
1057 } /* Client_MaxUserCount */
1058
1059
1060 GLOBAL long
1061 Client_MyMaxUserCount( void )
1062 {
1063         return My_Max_Users;
1064 } /* Client_MyMaxUserCount */
1065
1066
1067 /**
1068  * Check that a given nickname is valid.
1069  *
1070  * @param       Nick the nickname to check.
1071  * @returns     true if nickname is valid, false otherwise.
1072  */
1073 GLOBAL bool
1074 Client_IsValidNick(const char *Nick)
1075 {
1076         const char *ptr;
1077         static const char goodchars[] = ";0123456789-";
1078
1079         assert (Nick != NULL);
1080
1081         if (strchr(goodchars, Nick[0]))
1082                 return false;
1083         if (strlen(Nick ) >= Conf_MaxNickLength)
1084                 return false;
1085
1086         ptr = Nick;
1087         while (*ptr) {
1088                 if (*ptr < 'A' && !strchr(goodchars, *ptr ))
1089                         return false;
1090                 if (*ptr > '}')
1091                         return false;
1092                 ptr++;
1093         }
1094
1095         return true;
1096 } /* Client_IsValidNick */
1097
1098
1099 /**
1100  * Return pointer to "My_Whowas" structure.
1101  */
1102 GLOBAL WHOWAS *
1103 Client_GetWhowas( void )
1104 {
1105         return My_Whowas;
1106 } /* Client_GetWhowas */
1107
1108 /**
1109  * Return the index of the last used WHOWAS entry.
1110  */
1111 GLOBAL int
1112 Client_GetLastWhowasIndex( void )
1113 {
1114         return Last_Whowas;
1115 } /* Client_GetLastWhowasIndex */
1116
1117
1118 /**
1119  * Get the start time of this client.
1120  * The result is the start time in seconds since 1970-01-01, as reported
1121  * by the C function time(NULL).
1122  */
1123 GLOBAL time_t
1124 Client_StartTime(CLIENT *Client)
1125 {
1126         assert( Client != NULL );
1127         return Client->starttime;
1128 } /* Client_Uptime */
1129
1130
1131 /**
1132  * Reject a client when logging in.
1133  *
1134  * This function is called when a client isn't allowed to connect to this
1135  * server. Possible reasons are bad server password, bad PAM password,
1136  * or that the client is G/K-Line'd.
1137  *
1138  * After calling this function, the client isn't connected any more.
1139  *
1140  * @param Client The client to reject.
1141  * @param Reason The reason why the client has been rejected.
1142  * @param InformClient If true, send the exact reason to the client.
1143  */
1144 GLOBAL void
1145 Client_Reject(CLIENT *Client, const char *Reason, bool InformClient)
1146 {
1147         char info[COMMAND_LEN];
1148
1149         assert(Client != NULL);
1150         assert(Reason != NULL);
1151
1152         if (InformClient)
1153                 snprintf(info, sizeof(info), "Access denied: %s", Reason);
1154         else
1155                 strcpy(info, "Access denied: Bad password?");
1156
1157         Log(LOG_ERR,
1158             "User \"%s\" rejected (connection %d): %s!",
1159             Client_Mask(Client), Client_Conn(Client), Reason);
1160         Conn_Close(Client_Conn(Client), Reason, info, true);
1161 }
1162
1163
1164 /**
1165  * Introduce a new user or service client in the network.
1166  *
1167  * @param From Remote server introducing the client or NULL (local).
1168  * @param Client New client.
1169  * @param Type Type of the client (CLIENT_USER or CLIENT_SERVICE).
1170  */
1171 GLOBAL void
1172 Client_Introduce(CLIENT *From, CLIENT *Client, int Type)
1173 {
1174         /* Set client type (user or service) */
1175         Client_SetType(Client, Type);
1176
1177         if (From) {
1178                 if (Conf_NickIsService(Conf_GetServer(Client_Conn(From)),
1179                                    Client_ID(Client)))
1180                         Client_SetType(Client, CLIENT_SERVICE);
1181                 LogDebug("%s \"%s\" (+%s) registered (via %s, on %s, %d hop%s).",
1182                          Client_TypeText(Client), Client_Mask(Client),
1183                          Client_Modes(Client), Client_ID(From),
1184                          Client_ID(Client_Introducer(Client)),
1185                          Client_Hops(Client), Client_Hops(Client) > 1 ? "s": "");
1186         } else {
1187                 Log(LOG_NOTICE, "%s \"%s\" registered (connection %d).",
1188                     Client_TypeText(Client), Client_Mask(Client),
1189                     Client_Conn(Client));
1190                 Log_ServerNotice('c', "Client connecting: %s (%s@%s) [%s] - %s",
1191                                  Client_ID(Client), Client_User(Client),
1192                                  Client_Hostname(Client),
1193                                  Conn_IPA(Client_Conn(Client)),
1194                                  Client_TypeText(Client));
1195         }
1196
1197         /* Inform other servers */
1198         IRC_WriteStrServersPrefixFlag_CB(From,
1199                                 From != NULL ? From : Client_ThisServer(),
1200                                 '\0', cb_introduceClient, (void *)Client);
1201 } /* Client_Introduce */
1202
1203
1204 static unsigned long
1205 Count( CLIENT_TYPE Type )
1206 {
1207         CLIENT *c;
1208         unsigned long cnt = 0;
1209
1210         c = My_Clients;
1211         while( c )
1212         {
1213                 if( c->type == Type ) cnt++;
1214                 c = (CLIENT *)c->next;
1215         }
1216         return cnt;
1217 } /* Count */
1218
1219
1220 static unsigned long
1221 MyCount( CLIENT_TYPE Type )
1222 {
1223         CLIENT *c;
1224         unsigned long cnt = 0;
1225
1226         c = My_Clients;
1227         while( c )
1228         {
1229                 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
1230                 c = (CLIENT *)c->next;
1231         }
1232         return cnt;
1233 } /* MyCount */
1234
1235
1236 static CLIENT *
1237 New_Client_Struct( void )
1238 {
1239         /* Neue CLIENT-Struktur pre-initialisieren */
1240
1241         CLIENT *c;
1242
1243         c = (CLIENT *)malloc( sizeof( CLIENT ));
1244         if( ! c )
1245         {
1246                 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1247                 return NULL;
1248         }
1249
1250         memset( c, 0, sizeof ( CLIENT ));
1251
1252         c->type = CLIENT_UNKNOWN;
1253         c->conn_id = NONE;
1254         c->oper_by_me = false;
1255         c->hops = -1;
1256         c->token = -1;
1257         c->mytoken = -1;
1258
1259         return c;
1260 } /* New_Client */
1261
1262
1263 static void
1264 Generate_MyToken( CLIENT *Client )
1265 {
1266         CLIENT *c;
1267         int token;
1268
1269         c = My_Clients;
1270         token = 2;
1271         while( c )
1272         {
1273                 if( c->mytoken == token )
1274                 {
1275                         /* Das Token wurde bereits vergeben */
1276                         token++;
1277                         c = My_Clients;
1278                         continue;
1279                 }
1280                 else c = (CLIENT *)c->next;
1281         }
1282         Client->mytoken = token;
1283         LogDebug("Assigned token %d to server \"%s\".", token, Client->id);
1284 } /* Generate_MyToken */
1285
1286
1287 static void
1288 Adjust_Counters( CLIENT *Client )
1289 {
1290         long count;
1291
1292         assert( Client != NULL );
1293
1294         if( Client->type != CLIENT_USER ) return;
1295
1296         if( Client->conn_id != NONE )
1297         {
1298                 /* Local connection */
1299                 count = Client_MyUserCount( );
1300                 if( count > My_Max_Users ) My_Max_Users = count;
1301         }
1302         count = Client_UserCount( );
1303         if( count > Max_Users ) Max_Users = count;
1304 } /* Adjust_Counters */
1305
1306
1307 /**
1308  * Register client in My_Whowas structure for further recall by WHOWAS.
1309  * Note: Only clients that have been connected at least 30 seconds will be
1310  * registered to prevent automated IRC bots to "destroy" a nice server
1311  * history database.
1312  */
1313 GLOBAL void
1314 Client_RegisterWhowas( CLIENT *Client )
1315 {
1316         int slot;
1317         time_t now;
1318
1319         assert( Client != NULL );
1320
1321         /* Don't register WHOWAS information when "MorePrivacy" is enabled. */
1322         if (Conf_MorePrivacy)
1323                 return;
1324
1325         now = time(NULL);
1326         /* Don't register clients that were connected less than 30 seconds. */
1327         if( now - Client->starttime < 30 )
1328                 return;
1329
1330         slot = Last_Whowas + 1;
1331         if( slot >= MAX_WHOWAS || slot < 0 ) slot = 0;
1332
1333 #ifdef DEBUG
1334         Log( LOG_DEBUG, "Saving WHOWAS information to slot %d ...", slot );
1335 #endif
1336
1337         My_Whowas[slot].time = now;
1338         strlcpy( My_Whowas[slot].id, Client_ID( Client ),
1339                  sizeof( My_Whowas[slot].id ));
1340         strlcpy( My_Whowas[slot].user, Client_User( Client ),
1341                  sizeof( My_Whowas[slot].user ));
1342         strlcpy( My_Whowas[slot].host, Client_HostnameCloaked( Client ),
1343                  sizeof( My_Whowas[slot].host ));
1344         strlcpy( My_Whowas[slot].info, Client_Info( Client ),
1345                  sizeof( My_Whowas[slot].info ));
1346         strlcpy( My_Whowas[slot].server, Client_ID( Client_Introducer( Client )),
1347                  sizeof( My_Whowas[slot].server ));
1348
1349         Last_Whowas = slot;
1350 } /* Client_RegisterWhowas */
1351
1352
1353 GLOBAL const char *
1354 Client_TypeText(CLIENT *Client)
1355 {
1356         assert(Client != NULL);
1357         switch (Client_Type(Client)) {
1358                 case CLIENT_USER:
1359                         return "User";
1360                         break;
1361                 case CLIENT_SERVICE:
1362                         return "Service";
1363                         break;
1364                 case CLIENT_SERVER:
1365                         return "Server";
1366                         break;
1367                 default:
1368                         return "Client";
1369         }
1370 } /* Client_TypeText */
1371
1372
1373 /**
1374  * Destroy user or service client.
1375  */
1376 static void
1377 Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool SendQuit)
1378 {
1379         if(Client->conn_id != NONE) {
1380                 /* Local (directly connected) client */
1381                 Log(LOG_NOTICE,
1382                     "%s \"%s\" unregistered (connection %d): %s",
1383                     Client_TypeText(Client), Client_Mask(Client),
1384                     Client->conn_id, Txt);
1385                 Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
1386                                  Client_ID(Client), Client_User(Client),
1387                                  Client_Hostname(Client), Txt);
1388
1389                 if (SendQuit) {
1390                         /* Inforam all the other servers */
1391                         if (FwdMsg)
1392                                 IRC_WriteStrServersPrefix(NULL,
1393                                                 Client, "QUIT :%s", FwdMsg );
1394                         else
1395                                 IRC_WriteStrServersPrefix(NULL,
1396                                                 Client, "QUIT :");
1397                 }
1398         } else {
1399                 /* Remote client */
1400                 LogDebug("%s \"%s\" unregistered: %s",
1401                          Client_TypeText(Client), Client_Mask(Client), Txt);
1402
1403                 if(SendQuit) {
1404                         /* Inform all the other servers, but the ones in the
1405                          * direction we got the QUIT from */
1406                         if(FwdMsg)
1407                                 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1408                                                 Client, "QUIT :%s", FwdMsg );
1409                         else
1410                                 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1411                                                 Client, "QUIT :" );
1412                 }
1413         }
1414
1415         /* Unregister client from channels */
1416         Channel_Quit(Client, FwdMsg ? FwdMsg : Client->id);
1417
1418         /* Register client in My_Whowas structure */
1419         Client_RegisterWhowas(Client);
1420 } /* Destroy_UserOrService */
1421
1422
1423 /**
1424  * Introduce a new user or service client to a remote server.
1425  *
1426  * This function differentiates between RFC1459 and RFC2813 server links and
1427  * generates the appropriate commands to register the new user or service.
1428  *
1429  * @param To            The remote server to inform.
1430  * @param Prefix        Prefix for the generated commands.
1431  * @param data          CLIENT structure of the new client.
1432  */
1433 static void
1434 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
1435 {
1436         CLIENT *c = (CLIENT *)data;
1437         CONN_ID conn;
1438         char *modes, *user, *host;
1439
1440         modes = Client_Modes(c);
1441         user = Client_User(c) ? Client_User(c) : "-";
1442         host = Client_Hostname(c) ? Client_Hostname(c) : "-";
1443
1444         conn = Client_Conn(To);
1445         if (Conn_Options(conn) & CONN_RFC1459) {
1446                 /* RFC 1459 mode: separate NICK and USER commands */
1447                 Conn_WriteStr(conn, "NICK %s :%d", Client_ID(c),
1448                               Client_Hops(c) + 1);
1449                 Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
1450                               Client_ID(c), user, host,
1451                               Client_ID(Client_Introducer(c)), Client_Info(c));
1452                 if (modes[0])
1453                         Conn_WriteStr(conn, ":%s MODE %s +%s",
1454                                       Client_ID(c), Client_ID(c), modes);
1455         } else {
1456                 /* RFC 2813 mode: one combined NICK or SERVICE command */
1457                 if (Client_Type(c) == CLIENT_SERVICE
1458                     && strchr(Client_Flags(To), 'S'))
1459                         IRC_WriteStrClientPrefix(To, Prefix,
1460                                                  "SERVICE %s %d * +%s %d :%s",
1461                                                  Client_Mask(c),
1462                                                  Client_MyToken(Client_Introducer(c)),
1463                                                  Client_Modes(c), Client_Hops(c) + 1,
1464                                                  Client_Info(c));
1465                 else
1466                         IRC_WriteStrClientPrefix(To, Prefix,
1467                                                  "NICK %s %d %s %s %d +%s :%s",
1468                                                  Client_ID(c), Client_Hops(c) + 1,
1469                                                  user, host,
1470                                                  Client_MyToken(Client_Introducer(c)),
1471                                                  modes, Client_Info(c));
1472         }
1473 } /* cb_introduceClient */
1474
1475
1476 #ifdef DEBUG
1477
1478 GLOBAL void
1479 Client_DebugDump(void)
1480 {
1481         CLIENT *c;
1482
1483         Log(LOG_DEBUG, "Client status:");
1484         c = My_Clients;
1485         while (c) {
1486                 Log(LOG_DEBUG,
1487                     " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
1488                    Client_ID(c), Client_Type(c), Client_Hostname(c),
1489                    Client_User(c), Client_Conn(c), Client_StartTime(c),
1490                    Client_Flags(c));
1491                 c = (CLIENT *)c->next;
1492         }
1493 } /* Client_DumpClients */
1494
1495 #endif
1496
1497
1498 /* -eof- */