ircd/m_whois.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_whois.c
   3  * Copyright (C) 1990 Jarkko Oikarinen and
   4  *                    University of Oulu, Computing Center
   5  *
   6  * See file AUTHORS in IRC package for additional names of
   7  * the programmers.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 1, or (at your option)
  12  * any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  * $Id$
  24  */
  25
  26 /*
  27  * m_functions execute protocol messages on this server:
  28  *
  29  *    cptr    is always NON-NULL, pointing to a *LOCAL* client
  30  *            structure (with an open socket connected!). This
  31  *            identifies the physical socket where the message
  32  *            originated (or which caused the m_function to be
  33  *            executed--some m_functions may call others...).
  34  *
  35  *    sptr    is the source of the message, defined by the
  36  *            prefix part of the message if present. If not
  37  *            or prefix not found, then sptr==cptr.
  38  *
  39  *            (!IsServer(cptr)) => (cptr == sptr), because
  40  *            prefixes are taken *only* from servers...
  41  *
  42  *            (IsServer(cptr))
  43  *                    (sptr == cptr) => the message didn't
  44  *                    have the prefix.
  45  *
  46  *                    (sptr != cptr && IsServer(sptr) means
  47  *                    the prefix specified servername. (?)
  48  *
  49  *                    (sptr != cptr && !IsServer(sptr) means
  50  *                    that message originated from a remote
  51  *                    user (not local).
  52  *
  53  *            combining
  54  *
  55  *            (!IsServer(sptr)) means that, sptr can safely
  56  *            taken as defining the target structure of the
  57  *            message in this server.
  58  *
  59  *    *Always* true (if 'parse' and others are working correct):
  60  *
  61  *    1)      sptr->from == cptr  (note: cptr->from == cptr)
  62  *
  63  *    2)      MyConnect(sptr) <=> sptr == cptr (e.g. sptr
  64  *            *cannot* be a local connection, unless it's
  65  *            actually cptr!). [MyConnect(x) should probably
  66  *            be defined as (x == x->from) --msa ]
  67  *
  68  *    parc    number of variable parameter strings (if zero,
  69  *            parv is allowed to be NULL)
  70  *
  71  *    parv    a NULL terminated list of parameter pointers,
  72  *
  73  *                    parv[0], sender (prefix string), if not present
  74  *                            this points to an empty string.
  75  *                    parv[1]...parv[parc-1]
  76  *                            pointers to additional parameters
  77  *                    parv[parc] == NULL, *always*
  78  *
  79  *            note:   it is guaranteed that parv[0]..parv[parc-1] are all
  80  *                    non-NULL pointers.
  81  */
  82 #include "config.h"
  83
  84 #include "channel.h"
  85 #include "client.h"
  86 #include "hash.h"
  87 #include "ircd.h"
  88 #include "ircd_features.h"
  89 #include "ircd_log.h"
  90 #include "ircd_reply.h"
  91 #include "ircd_string.h"
  92 #include "match.h"
  93 #include "msg.h"
  94 #include "numeric.h"
  95 #include "numnicks.h"
  96 #include "s_user.h"
  97 #include "send.h"
  98 #include "whocmds.h"
  99
 100 /* #include <assert.h> -- Now using assert in ircd_log.h */
 101 #include <string.h>
 102
 103 /*
 104  * 2000-07-01: Isomer
 105  *  * Rewritten to make this understandable
 106  *  * You can no longer /whois unregistered clients.
 107  *
 108  *
 109  * General rules:
 110  *  /whois nick always shows the nick.
 111  *  /whois wild* shows the nick if:
 112  *   * they aren't +i and aren't on any channels.
 113  *   * they are on a common channel.
 114  *   * they aren't +i and are on a public channel. (not +p and not +s)
 115  *   * they aren't +i and are on a private channel. (+p but not +s)
 116  *  Or to look at it another way (I think):
 117  *   * +i users are only shown if your on a common channel.
 118  *   * users on +s channels only aren't shown.
 119  *
 120  *  whois doesn't show what channels a +k client is on, for the reason that
 121  *  /whois X or /whois W floods a user off the server. :)
 122  *
 123  * nb: if the code and this comment disagree, the codes right and I screwed
 124  *     up.
 125  */
 126
 127 /*
 128  * Send whois information for acptr to sptr
 129  */
 130 static void do_whois(struct Client* sptr, struct Client *acptr, int parc)
 131 {
 132   struct Client *a2cptr=0;
 133   struct Channel *chptr=0;
 134   int mlen;
 135   int len;
 136   static char buf[512];
 137
 138   const struct User* user = cli_user(acptr);
 139   const char* name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);
 140   a2cptr = feature_bool(FEAT_HIS_WHOIS_SERVERNAME) && !IsAnOper(sptr)
 141       && sptr != acptr ? &his : user->server;
 142   assert(user);
 143   send_reply(sptr, RPL_WHOISUSER, name, user->username, user->host,
 144                    cli_info(acptr));
 145
 146   /* Display the channels this user is on. */
 147   if (!IsChannelService(acptr))
 148   {
 149     struct Membership* chan;
 150     mlen = strlen(cli_name(&me)) + strlen(cli_name(sptr)) + 12 + strlen(name);
 151     len = 0;
 152     *buf = '\0';
 153     for (chan = user->channel; chan; chan = chan->next_channel)
 154     {
 155        chptr = chan->channel;
 156
 157        if (!ShowChannel(sptr, chptr)
 158            && !(IsOper(sptr) && IsLocalChannel(chptr->chname)))
 159           continue;
 160
 161        if (acptr != sptr && IsZombie(chan))
 162           continue;
 163
 164        /* Don't show local channels when HIS is defined, unless it's a
 165         * remote WHOIS --ULtimaTe_
 166         */
 167        if (IsLocalChannel(chptr->chname) && (acptr != sptr) && (parc == 2)
 168            && feature_bool(FEAT_HIS_WHOIS_LOCALCHAN) && !IsAnOper(sptr))
 169           continue;
 170
 171        if (len+strlen(chptr->chname) + mlen > BUFSIZE - 5)
 172        {
 173           send_reply(sptr, SND_EXPLICIT | RPL_WHOISCHANNELS, "%s :%s", name, buf);
 174           *buf = '\0';
 175           len = 0;
 176        }
 177        if (IsDeaf(acptr))
 178          *(buf + len++) = '-';
 179        if (!ShowChannel(sptr, chptr))
 180          *(buf + len++) = '*';
 181        if (IsDelayedJoin(chan) && (sptr != acptr))
 182          *(buf + len++) = '<';
 183        else if (IsChanOp(chan))
 184          *(buf + len++) = '@';
 185        else if (HasVoice(chan))
 186          *(buf + len++) = '+';
 187        else if (IsZombie(chan))
 188          *(buf + len++) = '!';
 189        if (len)
 190           *(buf + len) = '\0';
 191        strcpy(buf + len, chptr->chname);
 192        len += strlen(chptr->chname);
 193        strcat(buf + len, " ");
 194        len++;
 195      }
 196      if (buf[0] != '\0')
 197         send_reply(sptr, RPL_WHOISCHANNELS, name, buf);
 198   }
 199
 200   send_reply(sptr, RPL_WHOISSERVER, name, cli_name(a2cptr),
 201              cli_info(a2cptr));
 202
 203   if (user)
 204   {
 205     if (user->away)
 206        send_reply(sptr, RPL_AWAY, name, user->away);
 207
 208     if (SeeOper(sptr,acptr))
 209        send_reply(sptr, RPL_WHOISOPERATOR, name);
 210
 211     if (IsAccount(acptr))
 212       send_reply(sptr, RPL_WHOISACCOUNT, name, user->account);
 213
 214     if (HasHiddenHost(acptr) && (IsAnOper(sptr) || acptr == sptr))
 215       send_reply(sptr, RPL_WHOISACTUALLY, name, user->username,
 216                  user->realhost, ircd_ntoa(&cli_ip(acptr)));
 217
 218     /* Hint: if your looking to add more flags to a user, eg +h, here's
 219      *       probably a good place to add them :)
 220      */
 221
 222     if (MyConnect(acptr) && (!feature_bool(FEAT_HIS_WHOIS_IDLETIME) ||
 223                              (sptr == acptr || IsAnOper(sptr) || parc >= 3)))
 224        send_reply(sptr, RPL_WHOISIDLE, name, CurrentTime - user->last,
 225                   cli_firsttime(acptr));
 226   }
 227 }
 228
 229 /*
 230  * Search and return as many people as matched by the wild 'nick'.
 231  * returns the number of people found (or, obviously, 0, if none where
 232  * found).
 233  */
 234 static int do_wilds(struct Client* sptr, char *nick, int count, int parc)
 235 {
 236   struct Client *acptr; /* Current client we're considering */
 237   struct User *user;    /* the user portion of the client */
 238   const char *name;     /* the name of this client */
 239   struct Membership* chan;
 240   int invis;            /* does +i apply? */
 241   int member;           /* Is this user on any channels? */
 242   int showperson;       /* Should we show this person? */
 243   int found = 0 ;       /* How many were found? */
 244
 245   /* Ech! This is hideous! */
 246   for (acptr = GlobalClientList; (acptr = next_client(acptr, nick));
 247       acptr = cli_next(acptr))
 248   {
 249     if (!IsRegistered(acptr))
 250       continue;
 251
 252     if (IsServer(acptr))
 253       continue;
 254     /*
 255      * I'm always last :-) and acptr->next == 0!!
 256      *
 257      * Isomer: Does this strike anyone else as being a horrible hideous
 258      *         hack?
 259      */
 260     if (IsMe(acptr)) {
 261       assert(!cli_next(acptr));
 262       break;
 263     }
 264
 265     /*
 266      * 'Rules' established for sending a WHOIS reply:
 267      *
 268      * - if wildcards are being used don't send a reply if
 269      *   the querier isn't any common channels and the
 270      *   client in question is invisible.
 271      *
 272      * - only send replies about common or public channels
 273      *   the target user(s) are on;
 274      */
 275     user = cli_user(acptr);
 276     name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);
 277     assert(user);
 278
 279     invis = (acptr != sptr) && IsInvisible(acptr);
 280     member = (user && user->channel) ? 1 : 0;
 281     showperson = !invis && !member;
 282
 283     /* Should we show this person now? */
 284     if (showperson) {
 285         found++;
 286         do_whois(sptr, acptr, parc);
 287         if (count+found>MAX_WHOIS_LINES)
 288           return found;
 289         continue;
 290     }
 291
 292     /* Step through the channels this user is on */
 293     for (chan = user->channel; chan; chan = chan->next_channel)
 294     {
 295       struct Channel *chptr = chan->channel;
 296
 297       /* If this is a public channel, show the person */
 298       if (!invis && PubChannel(chptr)) {
 299         showperson = 1;
 300         break;
 301       }
 302
 303       /* if this channel is +p and not +s, show them */
 304       if (!invis && HiddenChannel(chptr) && !SecretChannel(chptr)) {
 305           showperson = 1;
 306           break;
 307       }
 308
 309       member = find_channel_member(sptr, chptr) ? 1 : 0;
 310       if (invis && !member)
 311         continue;
 312
 313       /* If sptr isn't really on this channel, skip it */
 314       if (IsZombie(chan))
 315         continue;
 316
 317       /* Is this a common channel? */
 318       if (member) {
 319         showperson = 1;
 320         break;
 321       }
 322     } /* of for (chan in channels) */
 323
 324     /* Don't show this person */
 325     if (!showperson)
 326       continue;
 327
 328     do_whois(sptr, acptr, parc);
 329     found++;
 330     if (count+found>MAX_WHOIS_LINES)
 331        return found;
 332   } /* of global client list */
 333
 334   return found;
 335 }
 336
 337 /*
 338  * m_whois - generic message handler
 339  *
 340  * parv[0] = sender prefix
 341  * parv[1] = nickname masklist
 342  *
 343  * or
 344  *
 345  * parv[1] = target server, or a nickname representing a server to target.
 346  * parv[2] = nickname masklist
 347  */
 348 int m_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 349 {
 350   char*           nick;
 351   char*           tmp;
 352   char*           p = 0;
 353   int             found = 0;
 354   int             total = 0;
 355   int             wildscount = 0;
 356
 357   if (parc < 2)
 358   {
 359     send_reply(sptr, ERR_NONICKNAMEGIVEN);
 360     return 0;
 361   }
 362
 363   if (parc > 2)
 364   {
 365     /* For convenience: Accept a nickname as first parameter, by replacing
 366      * it with the correct servername - as is needed by hunt_server().
 367      * This is the secret behind the /whois nick nick trick.
 368      */
 369     if (feature_int(FEAT_HIS_REMOTE))
 370     {
 371       /* If remote queries are disabled, then use the *second* parameter of
 372        * of whois, so /whois nick nick still works.
 373        */
 374       if (!IsAnOper(sptr))
 375       {
 376         if (!FindUser(parv[2]))
 377         {
 378           send_reply(sptr, ERR_NOSUCHNICK, parv[2]);
 379           send_reply(sptr, RPL_ENDOFWHOIS, parv[2]);
 380           return 0;
 381         }
 382         parv[1] = parv[2];
 383       }
 384     }
 385
 386     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
 387        HUNTED_ISME)
 388     return 0;
 389
 390     parv[1] = parv[2];
 391   }
 392
 393   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
 394   {
 395     int wilds;
 396
 397     found = 0;
 398
 399     collapse(nick);
 400
 401     wilds = (strchr(nick, '?') || strchr(nick, '*'));
 402     if (!wilds) {
 403       struct Client *acptr = 0;
 404       /* No wildcards */
 405       acptr = FindUser(nick);
 406       if (acptr && !IsServer(acptr)) {
 407         do_whois(sptr, acptr, parc);
 408         found = 1;
 409       }
 410     }
 411     else /* wilds */
 412     {
 413       if (++wildscount > 3) {
 414         send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
 415         break;
 416       }
 417       found=do_wilds(sptr, nick, total, parc);
 418     }
 419
 420     if (!found)
 421       send_reply(sptr, ERR_NOSUCHNICK, nick);
 422     total+=found;
 423     if (total >= MAX_WHOIS_LINES) {
 424       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
 425       break;
 426     }
 427     if (p)
 428       p[-1] = ',';
 429   } /* of tokenised parm[1] */
 430   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
 431
 432   return 0;
 433 }
 434
 435 /*
 436  * ms_whois - server message handler
 437  *
 438  * parv[0] = sender prefix
 439  * parv[1] = nickname masklist
 440  *
 441  * or
 442  *
 443  * parv[1] = target server, or a nickname representing a server to target.
 444  * parv[2] = nickname masklist
 445  */
 446 int ms_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 447 {
 448   char*           nick;
 449   char*           tmp;
 450   char*           p = 0;
 451   int             found = 0;
 452   int             total = 0;
 453
 454   if (parc < 2)
 455   {
 456     send_reply(sptr, ERR_NONICKNAMEGIVEN);
 457     return 0;
 458   }
 459
 460   if (parc > 2)
 461   {
 462     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
 463         HUNTED_ISME)
 464       return 0;
 465     parv[1] = parv[2];
 466   }
 467
 468   total = 0;
 469
 470   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
 471   {
 472     struct Client *acptr = 0;
 473
 474     found = 0;
 475
 476     collapse(nick);
 477
 478
 479     acptr = FindUser(nick);
 480     if (acptr && !IsServer(acptr)) {
 481       found++;
 482       do_whois(sptr, acptr, parc);
 483     }
 484
 485     if (!found)
 486       send_reply(sptr, ERR_NOSUCHNICK, nick);
 487
 488     total+=found;
 489
 490     if (total >= MAX_WHOIS_LINES) {
 491       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
 492       break;
 493     }
 494
 495     if (p)
 496       p[-1] = ',';
 497   } /* of tokenised parm[1] */
 498   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
 499
 500   return 0;
 501 }
 502