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 #if 0
  85 /*
  86  * No need to include handlers.h here the signatures must match
  87  * and we don't need to force a rebuild of all the handlers everytime
  88  * we add a new one to the list. --Bleep
  89  */
  90 #include "handlers.h"
  91 #endif /* 0 */
  92 #include "channel.h"
  93 #include "client.h"
  94 #include "hash.h"
  95 #include "ircd.h"
  96 #include "ircd_policy.h"
  97 #include "ircd_reply.h"
  98 #include "ircd_string.h"
  99 #include "match.h"
 100 #include "msg.h"
 101 #include "numeric.h"
 102 #include "numnicks.h"
 103 #include "s_user.h"
 104 #include "send.h"
 105 #include "whocmds.h"
 106
 107 #include <assert.h>
 108 #include <string.h>
 109
 110 /*
 111  * 2000-07-01: Isomer
 112  *  * Rewritten to make this understandable
 113  *  * You can nolonger /whois unregistered clients.
 114  *
 115  *
 116  * General rules:
 117  *  /whois nick always shows the nick.
 118  *  /whois wild* shows the nick if:
 119  *   * they aren't +i and aren't on any channels.
 120  *   * they are on a common channel.
 121  *   * they aren't +i and are on a public channel. (not +p and not +s)
 122  *   * they aren't +i and are on a private channel. (+p but not +s)
 123  *  Or to look at it another way (I think):
 124  *   * +i users are only shown if your on a common channel.
 125  *   * users on +s channels only aren't shown.
 126  *
 127  *  whois doesn't show what channels a +k client is on, for the reason that
 128  *  /whois X or /whois W floods a user off the server. :)
 129  *
 130  * nb: if the code and this comment disagree, the codes right and I screwed
 131  *     up.
 132  */
 133
 134 /*
 135  * Send whois information for acptr to sptr
 136  */
 137 static void do_whois(struct Client* sptr, struct Client *acptr)
 138 {
 139   struct Client *a2cptr=0;
 140   struct Channel *chptr=0;
 141   int mlen;
 142   int len;
 143   static char buf[512];
 144
 145   const struct User* user = cli_user(acptr);
 146   const char* name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);
 147   a2cptr = user->server;
 148   assert(user);
 149   send_reply(sptr, RPL_WHOISUSER, name, user->username, user->host,
 150                    cli_info(acptr));
 151
 152   /* Display the channels this user is on. */
 153   if (!IsChannelService(acptr))
 154   {
 155     struct Membership* chan;
 156     mlen = strlen(cli_name(&me)) + strlen(cli_name(sptr)) + 12 + strlen(name);
 157     len = 0;
 158     *buf = '\0';
 159     for (chan = user->channel; chan; chan = chan->next_channel)
 160     {
 161        chptr = chan->channel;
 162
 163        if (!ShowChannel(sptr, chptr))
 164           continue;
 165
 166        if (acptr != sptr && IsZombie(chan))
 167           continue;
 168
 169        if (len+strlen(chptr->chname) + mlen > BUFSIZE - 5)
 170        {
 171           send_reply(sptr, SND_EXPLICIT | RPL_WHOISCHANNELS, "%s :%s", name, buf);
 172           *buf = '\0';
 173           len = 0;
 174        }
 175        if (IsDeaf(acptr))
 176          *(buf + len++) = '-';
 177        if (is_chan_op(acptr, chptr))
 178          *(buf + len++) = '@';
 179        else if (has_voice(acptr, chptr))
 180          *(buf + len++) = '+';
 181        else if (IsZombie(chan))
 182          *(buf + len++) = '!';
 183        if (len)
 184           *(buf + len) = '\0';
 185        strcpy(buf + len, chptr->chname);
 186        len += strlen(chptr->chname);
 187        strcat(buf + len, " ");
 188        len++;
 189      }
 190      if (buf[0] != '\0')
 191         send_reply(sptr, RPL_WHOISCHANNELS, name, buf);
 192   }
 193
 194 #ifdef HEAD_IN_SAND_WHOIS_SERVERNAME
 195   if (!IsOper(sptr) || sptr == a2cptr)
 196     send_reply(sptr, RPL_WHOISSERVER, name, "*.undernet.org",
 197                "The Undernet Underworld");
 198   else
 199 #endif
 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 (IsAnOper(acptr) && (HasPriv(acptr, PRIV_DISPLAY) ||
 209                             HasPriv(sptr, PRIV_SEE_OPERS)))
 210        send_reply(sptr, RPL_WHOISOPERATOR, name);
 211
 212     /* Hint: if your looking to add more flags to a user, eg +h, here's
 213      *       probably a good place to add them :)
 214      */
 215
 216     if (MyConnect(acptr))
 217        send_reply(sptr, RPL_WHOISIDLE, name, CurrentTime - user->last,
 218                   cli_firsttime(acptr));
 219   }
 220 }
 221
 222 /*
 223  * Search and return as many people as matched by the wild 'nick'.
 224  * returns the number of people found (or, obviously, 0, if none where
 225  * found).
 226  */
 227 static int do_wilds(struct Client* sptr,char *nick,int count)
 228 {
 229   struct Client *acptr; /* Current client we're concidering */
 230   struct User *user;    /* the user portion of the client */
 231   char *name;           /* the name of this client */
 232   struct Membership* chan;
 233   int invis;            /* does +i apply? */
 234   int member;           /* Is this user on any channels? */
 235   int showperson;       /* Should we show this person? */
 236   int found = 0 ;       /* How many were found? */
 237
 238   /* Ech! This is hidious! */
 239   for (acptr = GlobalClientList; (acptr = next_client(acptr, nick));
 240       acptr = cli_next(acptr))
 241   {
 242     if (!IsRegistered(acptr))
 243       continue;
 244
 245     if (IsServer(acptr))
 246       continue;
 247     /*
 248      * I'm always last :-) and acptr->next == 0!!
 249      *
 250      * Isomer: Does this strike anyone else as being a horrible hidious
 251      *         hack?
 252      */
 253     if (IsMe(acptr)) {
 254       assert(!cli_next(acptr));
 255       break;
 256     }
 257
 258     /*
 259      * 'Rules' established for sending a WHOIS reply:
 260      *
 261      * - if wildcards are being used dont send a reply if
 262      *   the querier isnt any common channels and the
 263      *   client in question is invisible.
 264      *
 265      * - only send replies about common or public channels
 266      *   the target user(s) are on;
 267      */
 268     user = cli_user(acptr);
 269     name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);
 270     assert(user);
 271
 272     invis = (acptr != sptr) && IsInvisible(acptr);
 273     member = (user && user->channel) ? 1 : 0;
 274     showperson = !invis && !member;
 275
 276     /* Should we show this person now? */
 277     if (showperson) {
 278         found++;
 279         do_whois(sptr,acptr);
 280         if (count+found>MAX_WHOIS_LINES)
 281           return found;
 282         continue;
 283     }
 284
 285     /* Step through the channels this user is on */
 286     for (chan = user->channel; chan; chan = chan->next_channel)
 287     {
 288       struct Channel *chptr = chan->channel;
 289
 290       /* If this is a public channel, show the person */
 291       if (!invis && PubChannel(chptr)) {
 292         showperson = 1;
 293         break;
 294       }
 295
 296       /* if this channel is +p and not +s, show them */
 297       if (!invis && HiddenChannel(chptr) && !SecretChannel(chptr)) {
 298           showperson = 1;
 299           break;
 300       }
 301
 302       member = find_channel_member(sptr, chptr) ? 1 : 0;
 303       if (invis && !member)
 304         continue;
 305
 306       /* If sptr isn't really on this channel, skip it */
 307       if (IsZombie(chan))
 308         continue;
 309
 310       /* Is this a common channel? */
 311       if (member) {
 312         showperson = 1;
 313         break;
 314       }
 315     } /* of for (chan in channels) */
 316
 317     /* Don't show this person */
 318     if (!showperson)
 319       continue;
 320
 321     do_whois(sptr,acptr);
 322     found++;
 323     if (count+found>MAX_WHOIS_LINES)
 324        return found;
 325   } /* of global client list */
 326
 327   return found;
 328 }
 329
 330 /*
 331  * m_whois - generic message handler
 332  *
 333  * parv[0] = sender prefix
 334  * parv[1] = nickname masklist
 335  *
 336  * or
 337  *
 338  * parv[1] = target server, or a nickname representing a server to target.
 339  * parv[2] = nickname masklist
 340  */
 341 int m_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 342 {
 343   char*           nick;
 344   char*           tmp;
 345   char*           p = 0;
 346   int             found = 0;
 347   int             total = 0;
 348
 349   if (parc < 2)
 350   {
 351     send_reply(sptr, ERR_NONICKNAMEGIVEN);
 352     return 0;
 353   }
 354
 355   if (parc > 2)
 356   {
 357     struct Client *acptr;
 358     /* For convenience: Accept a nickname as first parameter, by replacing
 359      * it with the correct servername - as is needed by hunt_server().
 360      * This is the secret behind the /whois nick nick trick.
 361      */
 362     acptr = FindUser(parv[1]);
 363     if (acptr)
 364       parv[1] = cli_name(cli_user(acptr)->server);
 365     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
 366         HUNTED_ISME)
 367       return 0;
 368     parv[1] = parv[2];
 369   }
 370
 371   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
 372   {
 373     int wilds;
 374
 375     found = 0;
 376
 377     collapse(nick);
 378
 379     wilds = (strchr(nick, '?') || strchr(nick, '*'));
 380     if (!wilds) {
 381       struct Client *acptr = 0;
 382       /* No wildcards */
 383       acptr = FindUser(nick);
 384       if (acptr && !IsServer(acptr)) {
 385         do_whois(sptr,acptr);
 386         found = 1;
 387       }
 388     }
 389     else /* wilds */
 390         found=do_wilds(sptr,nick,total);
 391
 392     if (!found)
 393       send_reply(sptr, ERR_NOSUCHNICK, nick);
 394     total+=found;
 395     if (total >= MAX_WHOIS_LINES) {
 396       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
 397       break;
 398     }
 399     if (p)
 400       p[-1] = ',';
 401   } /* of tokenised parm[1] */
 402   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
 403
 404   return 0;
 405 }
 406
 407 /*
 408  * ms_whois - server message handler
 409  *
 410  * parv[0] = sender prefix
 411  * parv[1] = nickname masklist
 412  *
 413  * or
 414  *
 415  * parv[1] = target server, or a nickname representing a server to target.
 416  * parv[2] = nickname masklist
 417  */
 418 int ms_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 419 {
 420   char*           nick;
 421   char*           tmp;
 422   char*           p = 0;
 423   int             found = 0;
 424   int             total = 0;
 425
 426   if (parc < 2)
 427   {
 428     send_reply(sptr, ERR_NONICKNAMEGIVEN);
 429     return 0;
 430   }
 431
 432   if (parc > 2)
 433   {
 434     struct Client *acptr;
 435     /* For convenience: Accept a nickname as first parameter, by replacing
 436      * it with the correct servername - as is needed by hunt_server().
 437      * This is the secret behind the /whois nick nick trick.
 438      */
 439     acptr = FindUser(parv[1]);
 440     if (acptr)
 441       parv[1] = cli_name(cli_user(acptr)->server);
 442     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
 443         HUNTED_ISME)
 444       return 0;
 445     parv[1] = parv[2];
 446   }
 447
 448   total = 0;
 449
 450   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
 451   {
 452     struct Client *acptr = 0;
 453
 454     found = 0;
 455
 456     collapse(nick);
 457
 458
 459     acptr = FindUser(nick);
 460     if (acptr && !IsServer(acptr)) {
 461       found++;
 462       do_whois(sptr,acptr);
 463     }
 464
 465     if (!found)
 466       send_reply(sptr, ERR_NOSUCHNICK, nick);
 467
 468     total+=found;
 469
 470     if (total >= MAX_WHOIS_LINES) {
 471       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
 472       break;
 473     }
 474
 475     if (p)
 476       p[-1] = ',';
 477   } /* of tokenised parm[1] */
 478   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
 479
 480   return 0;
 481 }