ircd/m_stats.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_stats.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_stats.c 1844 2007-11-17 14:21:02Z entrope $
  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 "client.h"
  85 #include "ircd.h"
  86 #include "ircd_features.h"
  87 #include "ircd_log.h"
  88 #include "ircd_reply.h"
  89 #include "ircd_string.h"
  90 #include "msg.h"
  91 #include "numeric.h"
  92 #include "s_stats.h"
  93 #include "s_user.h"
  94 #include "send.h"
  95 #include "struct.h"
  96
  97 /* #include <assert.h> -- Now using assert in ircd_log.h */
  98 #include <stdlib.h>
  99 #include <string.h>
 100
 101 /*
 102  * m_stats - generic message handler
 103  *
 104  *    parv[0] = sender prefix
 105  *    parv[1] = statistics selector
 106  *    parv[2] = target server (current server defaulted, if omitted)
 107  * And 'stats l' and 'stats' L:
 108  *    parv[3] = server mask ("*" default, if omitted)
 109  * Or for stats p,P:
 110  *    parv[3] = port mask (returns p-lines when its port is matched by this)
 111  * Or for stats k,K,i and I:
 112  *    parv[3] = [user@]host.name (returns which K/I-lines match this)
 113  *           or [user@]host.mask (returns which K/I-lines are mmatched by this)
 114  *              (defaults to old reply if omitted, when local or Oper)
 115  *              A remote mask (something containing wildcards) is only
 116  *              allowed for IRC Operators.
 117  */
 118 int
 119 m_stats(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 120 {
 121   const struct StatDesc *sd;
 122   char *param;
 123
 124   /* If we didn't find a descriptor, send them help */
 125   if ((parc < 2) || !(sd = stats_find(parv[1])))
 126       parv[1] = "*", sd = stats_find("*");
 127
 128   assert(sd != 0);
 129
 130   /* Check whether the client can issue this command.  If source is
 131    * not privileged (server or an operator), then the STAT_FLAG_OPERONLY
 132    * flag must not be set, and if the STAT_FLAG_OPERFEAT flag is set,
 133    * then the feature given by sd->sd_control must be off.
 134    *
 135    * This checks cptr rather than sptr so that a local oper may send
 136    * /stats queries to other servers.
 137    */
 138   if (!IsPrivileged(cptr) &&
 139       ((sd->sd_flags & STAT_FLAG_OPERONLY) ||
 140        ((sd->sd_flags & STAT_FLAG_OPERFEAT) && feature_bool(sd->sd_control))))
 141     return send_reply(sptr, ERR_NOPRIVILEGES);
 142
 143   /* Check for extra parameter */
 144   if ((sd->sd_flags & STAT_FLAG_VARPARAM) && parc > 3 && !EmptyString(parv[3]))
 145     param = parv[3];
 146   else
 147     param = NULL;
 148
 149   /* Ok, track down who's supposed to get this... */
 150   if (hunt_server_cmd(sptr, CMD_STATS, cptr, feature_int(FEAT_HIS_REMOTE),
 151                       param ? "%s %C :%s" : "%s :%C", 2, parc, parv) !=
 152       HUNTED_ISME)
 153     return 0; /* Someone else--cool :) */
 154
 155   /* Check if they are a local user */
 156   if ((sd->sd_flags & STAT_FLAG_LOCONLY) && !MyUser(sptr))
 157     return send_reply(sptr, ERR_NOPRIVILEGES);
 158
 159   assert(sd->sd_func != 0);
 160
 161   /* Ok, dispatch the stats function */
 162   (*sd->sd_func)(sptr, sd, param);
 163
 164   /* Done sending them the stats */
 165   return send_reply(sptr, RPL_ENDOFSTATS, parv[1]);
 166 }