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