ircd/m_list.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_list.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: m_list.c,v 1.16 2005/06/20 13:22:45 a1kmm Exp $
  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_alloc.h"
  89 #include "ircd_chattr.h"
  90 #include "ircd_features.h"
  91 #include "ircd_log.h"
  92 #include "ircd_reply.h"
  93 #include "ircd_string.h"
  94 #include "msg.h"
  95 #include "numeric.h"
  96 #include "numnicks.h"
  97 #include "s_bsd.h"
  98 #include "send.h"
  99
 100 /* #include <assert.h> -- Now using assert in ircd_log.h */
 101 #include <stdlib.h>
 102 #include <string.h>
 103
 104 #define LPARAM_ERROR    -1
 105 #define LPARAM_SUCCESS   0
 106 #define LPARAM_CHANNEL   1
 107
 108 static struct ListingArgs la_init = {
 109   2147483647,                 /* max_time */
 110   0,                          /* min_time */
 111   4294967295U,                /* max_users */
 112   0,                          /* min_users */
 113   0,                          /* flags */
 114   2147483647,                 /* max_topic_time */
 115   0,                          /* min_topic_time */
 116   0,                          /* bucket */
 117   {0}                         /* wildcard */
 118 };
 119
 120 static struct ListingArgs la_default = {
 121   2147483647,                 /* max_time */
 122   0,                          /* min_time */
 123   4294967295U,                /* max_users */
 124   0,                          /* min_users */
 125   0,                          /* flags */
 126   2147483647,                 /* max_topic_time */
 127   0,                          /* min_topic_time */
 128   0,                          /* bucket */
 129   {0}                         /* wildcard */
 130 };
 131
 132 static int
 133 show_usage(struct Client *sptr)
 134 {
 135   if (!sptr) { /* configuration file error... */
 136     log_write(LS_CONFIG, L_ERROR, 0, "Invalid default list parameter");
 137     return LPARAM_ERROR;
 138   }
 139
 140   send_reply(sptr, RPL_LISTUSAGE,
 141              "Usage: \002/QUOTE LIST\002 \037parameters\037");
 142   send_reply(sptr, RPL_LISTUSAGE,
 143              "Where \037parameters\037 is a space or comma separated "
 144              "list of one or more of:");
 145   send_reply(sptr, RPL_LISTUSAGE,
 146              " \002<\002\037max_users\037    ; Show all channels with less "
 147              "than \037max_users\037.");
 148   send_reply(sptr, RPL_LISTUSAGE,
 149              " \002>\002\037min_users\037    ; Show all channels with more "
 150              "than \037min_users\037.");
 151   send_reply(sptr, RPL_LISTUSAGE,
 152              " \002C<\002\037max_minutes\037 ; Channels that exist less "
 153              "than \037max_minutes\037.");
 154   send_reply(sptr, RPL_LISTUSAGE,
 155              " \002C>\002\037min_minutes\037 ; Channels that exist more "
 156              "than \037min_minutes\037.");
 157   send_reply(sptr, RPL_LISTUSAGE,
 158              " \002T<\002\037max_minutes\037 ; Channels with a topic last "
 159              "set less than \037max_minutes\037 ago.");
 160   send_reply(sptr, RPL_LISTUSAGE,
 161              " \002T>\002\037min_minutes\037 ; Channels with a topic last "
 162              "set more than \037min_minutes\037 ago.");
 163   send_reply(sptr, RPL_LISTUSAGE,
 164              " \037pattern\037       ; Channels with names matching "
 165              "\037pattern\037. ");
 166   send_reply(sptr, RPL_LISTUSAGE,
 167              " !\037pattern\037      ; Channels with names not "
 168              "matching \037pattern\037. ");
 169   send_reply(sptr, RPL_LISTUSAGE, "Note: Patterns may contain * and ?. "
 170              "You may only give one pattern match constraint.");
 171   if (IsAnOper(sptr))
 172     send_reply(sptr, RPL_LISTUSAGE,
 173                " \002S\002             ; Show secret channels.");
 174   send_reply(sptr, RPL_LISTUSAGE,
 175              "Example: LIST <3,>1,C<10,T>0,#a*  ; 2 users, younger than 10 "
 176              "min., topic set., starts with #a");
 177
 178   return LPARAM_ERROR; /* return error condition */
 179 }
 180
 181 static int
 182 param_parse(struct Client *sptr, const char *param, struct ListingArgs *args,
 183             int permit_chan)
 184 {
 185   int is_time = 0;
 186   char dir;
 187   unsigned int val;
 188   char *tmp1, *tmp2;
 189
 190   assert(0 != args);
 191
 192   if (!param) /* NULL param == default--no list param */
 193     return LPARAM_SUCCESS;
 194
 195   while (1) {
 196     switch (*param) {
 197     case 'T':
 198     case 't':
 199       is_time++;
 200       args->flags |= LISTARG_TOPICLIMITS;
 201       /*FALLTHROUGH*/
 202
 203     case 'C':
 204     case 'c':
 205       is_time++;
 206       param++;
 207       if (*param != '<' && *param != '>')
 208         return show_usage(sptr);
 209       /*FALLTHROUGH*/
 210
 211     case '<':
 212     case '>':
 213       dir = *(param++);
 214
 215       if (!IsDigit(*param)) /* must start with a digit */
 216         return show_usage(sptr);
 217
 218       val = strtol(param, (char **)&param, 10); /* convert it... */
 219
 220       if (*param != ',' && *param != ' ' && *param != '\0') /* check syntax */
 221         return show_usage(sptr);
 222
 223       if (is_time && val < 80000000) /* Toggle UTC/offset */
 224         val = TStime() - val * 60;
 225
 226       switch (is_time) {
 227       case 0: /* number of users on channel */
 228         if (dir == '<')
 229           args->max_users = val;
 230         else
 231           args->min_users = val;
 232         break;
 233
 234       case 1: /* channel topic */
 235         if (dir == '<')
 236           args->min_topic_time = val;
 237         else
 238           args->max_topic_time = val;
 239         break;
 240
 241       case 2: /* channel creation time */
 242         if (dir == '<')
 243           args->min_time = val;
 244         else
 245           args->max_time = val;
 246         break;
 247       }
 248       break;
 249
 250     case 'S':
 251     case 's':
 252       if (!IsAnOper(sptr) || !HasPriv(sptr, PRIV_LIST_CHAN))
 253         return show_usage(sptr);
 254
 255       args->flags |= LISTARG_SHOWSECRET;
 256       param++;
 257
 258       if (*param != ',' && *param != ' ' && *param != '\0') /* check syntax */
 259         return show_usage(sptr);
 260       break;
 261
 262     default:
 263       /* It might be a wildcard... */
 264       if (strchr(param, '*') ||
 265           strchr(param, '?'))
 266       {
 267         if (param[0] == '!')
 268         {
 269           param++;
 270           args->flags |= LISTARG_NEGATEWILDCARD;
 271         }
 272
 273         /* Only one wildcard allowed... */
 274         if (args->wildcard[0] != 0)
 275           return show_usage(sptr);
 276
 277         /* If its not going to match anything, don't bother. */
 278         if (param[0] != '*' &&
 279             param[0] != '?' &&
 280             param[0] != '#' &&
 281             param[0] != '&')
 282           return show_usage(sptr);
 283
 284         tmp1 = strchr(param, ',');
 285         tmp2 = strchr(param, ' ');
 286         if (tmp2 && (!tmp1 || (tmp2 < tmp1)))
 287           tmp1 = tmp2;
 288
 289         if (tmp1)
 290           *tmp1++ = 0;
 291
 292         ircd_strncpy(args->wildcard, param, CHANNELLEN-1);
 293         args->wildcard[CHANNELLEN-1] = 0;
 294
 295         if (tmp1 == NULL)
 296           return LPARAM_SUCCESS;
 297
 298         param = tmp1;
 299         continue;
 300       }
 301
 302       /* channel name? */
 303       if (!permit_chan || !IsChannelName(param))
 304         return show_usage(sptr);
 305
 306       return LPARAM_CHANNEL;
 307       break;
 308     }
 309
 310     if (!*param) /* hit end of string? */
 311       break;
 312
 313     param++;
 314   }
 315
 316   return LPARAM_SUCCESS;
 317 }
 318
 319 void
 320 list_set_default(void)
 321 {
 322   la_default = la_init; /* start off with a clean slate... */
 323
 324   if (param_parse(0, feature_str(FEAT_DEFAULT_LIST_PARAM), &la_default, 0) !=
 325       LPARAM_SUCCESS)
 326     la_default = la_init; /* recover from error by switching to default */
 327 }
 328
 329 /*
 330  * m_list - generic message handler
 331  *
 332  * parv[0] = sender prefix
 333  * parv[1] = channel list or user/time limit
 334  * parv[2...] = more user/time limits
 335  */
 336 int m_list(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 337 {
 338   struct Channel *chptr;
 339   char *name, *p = 0;
 340   int show_channels = 0, param;
 341   struct ListingArgs args;
 342
 343   if (cli_listing(sptr))            /* Already listing ? */
 344   {
 345     if (cli_listing(sptr))
 346     MyFree(cli_listing(sptr));
 347     cli_listing(sptr) = 0;
 348     send_reply(sptr, RPL_LISTEND);
 349     update_write(sptr);
 350     if (parc < 2 || 0 == ircd_strcmp("STOP", parv[1]))
 351       return 0;                 /* Let LIST or LIST STOP abort a listing. */
 352   }
 353
 354   if (parc < 2)                 /* No arguments given to /LIST ? */
 355     args = la_default;
 356   else {
 357     args = la_init; /* initialize argument to blank slate */
 358
 359     for (param = 1; parv[param]; param++) { /* process each parameter */
 360       switch (param_parse(sptr, parv[param], &args, parc == 2)) {
 361       case LPARAM_ERROR: /* error encountered, usage already sent, return */
 362         return 0;
 363         break;
 364
 365       case LPARAM_CHANNEL: /* show channel instead */
 366         show_channels++;
 367         break;
 368
 369       case LPARAM_SUCCESS: /* parse succeeded */
 370         break;
 371       }
 372     }
 373   }
 374
 375   send_reply(sptr, RPL_LISTSTART);
 376
 377   if (!show_channels)
 378   {
 379     if (args.max_users > args.min_users + 1 && args.max_time > args.min_time &&
 380         args.max_topic_time > args.min_topic_time)      /* Sanity check */
 381     {
 382       cli_listing(sptr) = (struct ListingArgs*) MyMalloc(sizeof(struct ListingArgs));
 383       assert(0 != cli_listing(sptr));
 384       memcpy(cli_listing(sptr), &args, sizeof(struct ListingArgs));
 385       list_next_channels(sptr);
 386       return 0;
 387     }
 388     send_reply(sptr, RPL_LISTEND);
 389     return 0;
 390   }
 391
 392   for (; (name = ircd_strtok(&p, parv[1], ",")); parv[1] = 0)
 393   {
 394     chptr = FindChannel(name);
 395     if (!chptr)
 396         continue;
 397     if (ShowChannel(sptr, chptr)
 398         || (IsAnOper(sptr) && HasPriv(sptr, PRIV_LIST_CHAN)))
 399       send_reply(sptr, RPL_LIST, chptr->chname,
 400                  chptr->users - number_of_zombies(chptr), chptr->topic);
 401   }
 402
 403   send_reply(sptr, RPL_LISTEND);
 404   return 0;
 405 }