ircd/m_userip.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_userip.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_userip.c,v 1.15 2005/04/22 01:39:08 klmitch 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 "client.h"
  85 #include "ircd_reply.h"
  86 #include "ircd_string.h"
  87 #include "ircd_features.h"
  88 #include "ircd_log.h"
  89 #include "msgq.h"
  90 #include "numeric.h"
  91 #include "s_user.h"
  92 #include "struct.h"
  93
  94 /* #include <assert.h> -- Now using assert in ircd_log.h */
  95
  96 static void userip_formatter(struct Client* cptr, struct Client *sptr, struct MsgBuf* mb)
  97 {
  98   /* !!FIXME!! */
  99   assert(IsUser(cptr));
 100   msgq_append(0, mb, "%s%s=%c%s@%s", cli_name(cptr),
 101               SeeOper(sptr,cptr) ? "*" : "",
 102               cli_user(cptr)->away ? '-' : '+', cli_user(cptr)->username,
 103               /* Do not *EVER* change this to give opers the real IP.
 104                * Too many scripts rely on this data and can inadvertently
 105                * publish the user's real IP, thus breaking the security
 106                * of +x.  If an oper wants the real IP, he should go to
 107                * /whois to get it.
 108                */
 109               (HasHiddenHost(cptr) || HasSetHost(cptr)) && !IsAnOper(sptr) ?
 110               feature_str(FEAT_HIDDEN_IP) :
 111               ircd_ntoa(&cli_ip(cptr)));
 112 }
 113
 114 /*
 115  * m_userip - generic message handler
 116  */
 117 int m_userip(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 118 {
 119   assert(0 != cptr);
 120   assert(cptr == sptr);
 121
 122   if (parc < 2)
 123     return need_more_params(sptr, "USERIP");
 124   send_user_info(sptr, parv[1], RPL_USERIP, userip_formatter);
 125   return 0;
 126 }