src/ngircd/client.c

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