ircd/m_pong.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_pong.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 "client.h"
  91 #include "hash.h"
  92 #include "ircd.h"
  93 #include "ircd_reply.h"
  94 #include "ircd_string.h"
  95 #include "msg.h"
  96 #include "numeric.h"
  97 #include "numnicks.h"
  98 #include "s_user.h"
  99 #include "send.h"
 100
 101 #include <assert.h>
 102 #include <string.h>
 103 #include <stdlib.h>
 104
 105 /*
 106  * ms_pong - server message handler template
 107  *
 108  * parv[0] = sender prefix
 109  * parv[1] = origin
 110  * parv[2] = destination
 111  */
 112 int ms_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 113 {
 114   char*          origin;
 115   char*          destination;
 116   assert(0 != cptr);
 117   assert(0 != sptr);
 118   assert(IsServer(cptr));
 119
 120   if (parc < 2 || EmptyString(parv[1])) {
 121     return protocol_violation(sptr,"No Origin on PONG");
 122   }
 123   origin      = parv[1];
 124   destination = parv[2];
 125   cli_flags(cptr) &= ~FLAGS_PINGSENT;
 126   cli_flags(sptr) &= ~FLAGS_PINGSENT;
 127   cli_lasttime(cptr) = CurrentTime;
 128
 129   if (!EmptyString(destination) && 0 != ircd_strcmp(destination, cli_name(&me))) {
 130     struct Client* acptr;
 131     if ((acptr = FindClient(destination))) {
 132       sendcmdto_one(sptr, CMD_PONG, acptr, "%s %s", origin, destination);
 133     }
 134   }
 135   return 0;
 136 }
 137
 138 /*
 139  * mr_pong - registration message handler
 140  *
 141  * parv[0] = sender prefix
 142  * parv[1] = pong response echo
 143  * NOTE: cptr is always unregistered here
 144  */
 145 int mr_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 146 {
 147   assert(0 != cptr);
 148   assert(cptr == sptr);
 149   assert(!IsRegistered(sptr));
 150
 151   cli_flags(cptr) &= ~FLAGS_PINGSENT;
 152   cli_lasttime(cptr) = CurrentTime;
 153   /*
 154    * Check to see if this is a PONG :cookie reply from an
 155    * unregistered user.  If so, process it. -record
 156    */
 157   if (0 != cli_cookie(sptr) && COOKIE_VERIFIED != cli_cookie(sptr)) {
 158     if (parc > 1 && cli_cookie(sptr) == atol(parv[parc - 1])) {
 159       cli_cookie(sptr) = COOKIE_VERIFIED;
 160       if (cli_user(sptr) && *(cli_user(sptr))->host && (cli_name(sptr))[0])
 161         /*
 162          * NICK and USER OK
 163          */
 164         return register_user(cptr, sptr, cli_name(sptr), cli_user(sptr)->username, 0);
 165     }
 166     else
 167       send_reply(sptr, SND_EXPLICIT | ERR_BADPING,
 168                  ":To connect, type /QUOTE PONG %u", cli_cookie(sptr));
 169   }
 170   return 0;
 171 }
 172
 173 /*
 174  * m_pong - normal message handler
 175  *
 176  * parv[0] = sender prefix
 177  * parv[1] = origin
 178  * parv[2] = destination
 179  */
 180 int m_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 181 {
 182   assert(0 != cptr);
 183   assert(cptr == sptr);
 184   cli_flags(cptr) &= ~FLAGS_PINGSENT;
 185   cli_lasttime(cptr) = CurrentTime;
 186   return 0;
 187 }
 188
 189
 190 #if 0
 191 /*
 192  * m_pong
 193  *
 194  * parv[0] = sender prefix
 195  * parv[1] = origin
 196  * parv[2] = destination
 197  */
 198 int m_pong(struct Client *cptr, struct Client *sptr, int parc, char *parv[])
 199 {
 200   struct Client *acptr;
 201   char *origin, *destination;
 202
 203   if (MyUser(sptr))
 204     return 0;
 205
 206   /* Check to see if this is a PONG :cookie reply from an
 207    * unregistered user.  If so, process it. -record       */
 208
 209   if ((!IsRegistered(sptr)) && (sptr->cookie != 0) &&
 210       (sptr->cookie != COOKIE_VERIFIED) && (parc > 1))
 211   {
 212     if (atol(parv[parc - 1]) == (long)sptr->cookie)
 213     {
 214       sptr->cookie = COOKIE_VERIFIED;
 215       if (sptr->user && *sptr->user->host && sptr->name[0])        /* NICK and
 216                                                                    USER OK */
 217         return register_user(cptr, sptr, sptr->name, sptr->user->username); /* XXX DEAD */
 218     }
 219     else
 220       sendto_one(sptr, ":%s %d %s :To connect, type /QUOTE PONG %u", /* XXX DEAD */
 221           me.name, ERR_BADPING, sptr->name, sptr->cookie);
 222
 223     return 0;
 224   }
 225
 226   if (parc < 2 || *parv[1] == '\0')
 227   {
 228     sendto_one(sptr, err_str(ERR_NOORIGIN), me.name, parv[0]); /* XXX DEAD */
 229     return 0;
 230   }
 231
 232   origin = parv[1];
 233   destination = parv[2];
 234   cptr->flags &= ~FLAGS_PINGSENT;
 235   sptr->flags &= ~FLAGS_PINGSENT;
 236
 237   if (!EmptyString(destination) && 0 != ircd_strcmp(destination, me.name))
 238   {
 239     if ((acptr = FindClient(destination)))
 240       sendto_one(acptr, ":%s PONG %s %s", parv[0], origin, destination); /* XXX DEAD */
 241     else
 242     {
 243       sendto_one(sptr, err_str(ERR_NOSUCHSERVER), /* XXX DEAD */
 244           me.name, parv[0], destination);
 245       return 0;
 246     }
 247   }
 248 #ifdef        DEBUGMODE
 249   else
 250     Debug((DEBUG_NOTICE, "PONG: %s %s",
 251         origin, destination ? destination : "*"));
 252 #endif
 253   return 0;
 254 }
 255 #endif /* 0 */