src/ngircd/client.c

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