ircd/m_names.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_names.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_log.h"
  89 #include "ircd_reply.h"
  90 #include "ircd_string.h"
  91 #include "msg.h"
  92 #include "numeric.h"
  93 #include "numnicks.h"
  94 #include "s_user.h"
  95 #include "send.h"
  96
  97 /* #include <assert.h> -- Now using assert in ircd_log.h */
  98 #include <string.h>
  99
 100 /*
 101  *  Sends a suitably formatted 'names' reply to 'sptr' consisting of nicks within
 102  *  'chptr', depending on 'filter'.
 103  *
 104  *  NAMES_ALL - Lists all users on channel.
 105  *  NAMES_VIS - Only list visible (-i) users. --Gte (04/06/2000).
 106  *  NAMES_DEL - Show join-delayed names list.
 107  *  NAMES_EON - When OR'd with the other two, adds an 'End of Names' numeric
 108  *              used by m_join
 109  *
 110  */
 111
 112 void do_names(struct Client* sptr, struct Channel* chptr, int filter)
 113 {
 114   int mlen;
 115   int idx;
 116   int flag;
 117   int needs_space;
 118   int len;
 119   char buf[BUFSIZE];
 120   struct Client *c2ptr;
 121   struct Membership* member;
 122
 123   assert(chptr);
 124   assert(sptr);
 125   assert((filter&NAMES_ALL) != (filter&NAMES_VIS));
 126
 127   /* Tag Pub/Secret channels accordingly. */
 128
 129   strcpy(buf, "* ");
 130   if (PubChannel(chptr))
 131     *buf = '=';
 132   else if (SecretChannel(chptr))
 133     *buf = '@';
 134
 135   len = strlen(chptr->chname);
 136   strcpy(buf + 2, chptr->chname);
 137   strcpy(buf + 2 + len, " :");
 138
 139   idx = len + 4;
 140   flag = 1;
 141   needs_space = 0;
 142
 143   if (!ShowChannel(sptr, chptr)) /* Don't list private channels unless we are on them. */
 144     return;
 145
 146   /* Iterate over all channel members, and build up the list. */
 147
 148   mlen = strlen(cli_name(&me)) + 10 + strlen(cli_name(sptr));
 149
 150   for (member = chptr->members; member; member = member->next_member)
 151   {
 152     c2ptr = member->user;
 153
 154     if (((filter&NAMES_VIS)!=0) && IsInvisible(c2ptr))
 155       continue;
 156
 157     if (IsZombie(member) && member->user != sptr)
 158       continue;
 159
 160     if (IsDelayedJoin(member) && (member->user != sptr) && !(filter & NAMES_DEL))
 161         continue;
 162
 163     if ((!IsDelayedJoin(member) || (member->user == sptr)) && (filter & NAMES_DEL))
 164         continue;
 165
 166     if (needs_space)
 167       buf[idx++] = ' ';
 168     needs_space=1;
 169     if (IsZombie(member))
 170       buf[idx++] = '!';
 171     else if (IsChanOp(member))
 172       buf[idx++] = '@';
 173     else if (HasVoice(member))
 174       buf[idx++] = '+';
 175     strcpy(buf + idx, cli_name(c2ptr));
 176     idx += strlen(cli_name(c2ptr));
 177     flag = 1;
 178     if (mlen + idx + NICKLEN + 5 > BUFSIZE)
 179       /* space, modifier, nick, \r \n \0 */
 180     {
 181       send_reply(sptr, (filter & NAMES_DEL) ? RPL_DELNAMREPLY : RPL_NAMREPLY, buf);
 182       idx = len + 4;
 183       flag = 0;
 184       needs_space=0;
 185     }
 186   }
 187   if (flag)
 188     send_reply(sptr, (filter & NAMES_DEL) ? RPL_DELNAMREPLY : RPL_NAMREPLY, buf);
 189   if (filter&NAMES_EON)
 190     send_reply(sptr, RPL_ENDOFNAMES, chptr->chname);
 191 }
 192
 193 /*
 194  * m_names - generic message handler
 195  *
 196  * parv[0] = sender prefix
 197  * parv[1] = channel
 198  */
 199
 200 int m_names(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 201 {
 202   struct Channel *chptr;
 203   struct Channel *ch2ptr;
 204   struct Client *c2ptr;
 205   struct Membership* member;
 206   char* s;
 207   char* para = parc > 1 ? parv[1] : 0;
 208   int showingdelayed = 0;
 209
 210   if (parc > 1 && !ircd_strcmp(parv[1], "-D")) {
 211     para = (parc > 2) ? parv[2] : 0;
 212     showingdelayed = NAMES_DEL;
 213     if (parc > 3 && hunt_server_cmd(sptr, CMD_NAMES, cptr, 1, "%s %s %C", 3, parc, parv))
 214       return 0;
 215   } else if (parc > 2 && hunt_server_cmd(sptr, CMD_NAMES, cptr, 1, "%s %C", 2, parc, parv))
 216     return 0;
 217
 218   if (EmptyString(para)) {
 219     send_reply(sptr, RPL_ENDOFNAMES, "*");
 220     return 0;
 221   }
 222
 223   do {
 224     s = strchr(para, ',');
 225     if (s)
 226       *s++ = '\0';
 227     /*
 228      * Special Case 1: "/names 0".
 229      * Full list as per RFC.
 230      */
 231     if ((*para == '0') || (*para == '\0'))
 232     {
 233       int idx;
 234       int mlen;
 235       int flag;
 236       struct Channel *ch3ptr;
 237       char buf[BUFSIZE];
 238
 239       mlen = strlen(cli_name(&me)) + 10 + strlen(cli_name(sptr));
 240
 241       /* List all visible channels/visible members */
 242
 243       for (ch2ptr = GlobalChannelList; ch2ptr; ch2ptr = ch2ptr->next)
 244       {
 245         if (!ShowChannel(sptr, ch2ptr))
 246           continue;                 /* Don't show secret chans. */
 247         else if (find_channel_member(sptr, ch2ptr))
 248           do_names(sptr, ch2ptr, showingdelayed|NAMES_ALL); /* Full list if we're in this chan. */
 249         else
 250           do_names(sptr, ch2ptr, showingdelayed|NAMES_VIS);
 251       }
 252
 253       /* List all remaining users on channel '*' */
 254
 255       strcpy(buf, "* * :");
 256       idx = 5;
 257       flag = 0;
 258
 259       for (c2ptr = GlobalClientList; c2ptr; c2ptr = cli_next(c2ptr))
 260       {
 261         int showflag = 0;
 262
 263         if (!IsUser(c2ptr) || (sptr != c2ptr && IsInvisible(c2ptr)))
 264           continue;
 265
 266         member = cli_user(c2ptr)->channel;
 267
 268         while (member)
 269         {
 270           ch3ptr = member->channel;
 271
 272           if (PubChannel(ch3ptr) || find_channel_member(sptr, ch3ptr))
 273             showflag = 1;
 274
 275           member = member->next_channel;
 276         }
 277
 278         if (showflag)               /* Have we already shown them? */
 279           continue;
 280
 281         strcpy(buf + idx, cli_name(c2ptr));
 282         idx += strlen(cli_name(c2ptr));
 283         buf[idx++] = ' ';
 284         flag = 1;
 285
 286         if (mlen + idx + NICKLEN + 3 > BUFSIZE)     /* space, \r\n\0 */
 287         {
 288           buf[idx-1] = '\0';
 289           send_reply(sptr, RPL_NAMREPLY, buf);
 290           strcpy(buf, "* * :");
 291           idx = 5;
 292           flag = 0;
 293         }
 294       }
 295       if (flag)
 296       {
 297         buf[idx-1] = '\0';
 298         send_reply(sptr, RPL_NAMREPLY, buf);
 299       }
 300       send_reply(sptr, RPL_ENDOFNAMES, "*");
 301     }
 302     else if ((chptr = FindChannel(para)) != NULL)
 303     {
 304       member = find_member_link(chptr, sptr);
 305       if (member)
 306       {
 307         /*
 308          *  Special Case 2: User is on this channel, requesting full names list.
 309          *  (As performed with each /join) - ** High frequency usage **
 310          */
 311         do_names(sptr, chptr, showingdelayed|NAMES_ALL|NAMES_EON);
 312       }
 313       else
 314       {
 315         /*
 316          *  Special Case 3: User isn't on this channel, show all visible users, in
 317          *  non secret channels.
 318          */
 319         do_names(sptr, chptr, showingdelayed|NAMES_VIS|NAMES_EON);
 320       }
 321     }
 322     else
 323         send_reply(sptr, RPL_ENDOFNAMES, para);
 324   } while ((para = s) != NULL);
 325
 326   return 1;
 327 }