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 #include "config.h"
  83
  84 #include "client.h"
  85 #include "hash.h"
  86 #include "ircd.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 "numnicks.h"
  93 #include "opercmds.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 #include <stdlib.h>
 100
 101 /*
 102  * ms_pong - server message handler
 103  *
 104  * parv[0] = sender prefix
 105  * parv[1] = origin
 106  * parv[2] = destination
 107  */
 108 int ms_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 109 {
 110   char*          origin;
 111   char*          destination;
 112   assert(0 != cptr);
 113   assert(0 != sptr);
 114   assert(IsServer(cptr));
 115
 116   if (parc < 2 || EmptyString(parv[1])) {
 117     return protocol_violation(sptr,"No Origin on PONG");
 118   }
 119   origin      = parv[1];
 120   destination = parv[2];
 121   ClrFlag(cptr, FLAG_PINGSENT);
 122   ClrFlag(sptr, FLAG_PINGSENT);
 123   cli_lasttime(cptr) = CurrentTime;
 124
 125   if (parc > 5)
 126   {
 127     /* AsLL pong */
 128     cli_serv(cptr)->asll_rtt = atoi(militime_float(parv[3]));
 129     cli_serv(cptr)->asll_to = atoi(parv[4]);
 130     cli_serv(cptr)->asll_from = atoi(militime_float(parv[5]));
 131     return 0;
 132   }
 133
 134   if (EmptyString(destination))
 135     return 0;
 136
 137   if (*destination == '!')
 138   {
 139     /* AsLL ping reply from a non-AsLL server */
 140     cli_serv(cptr)->asll_rtt = atoi(militime_float(destination + 1));
 141   }
 142   else if (0 != ircd_strcmp(destination, cli_name(&me)))
 143   {
 144     struct Client* acptr;
 145     if ((acptr = FindClient(destination)))
 146       sendcmdto_one(sptr, CMD_PONG, acptr, "%s %s", origin, destination);
 147   }
 148   return 0;
 149 }
 150
 151 /*
 152  * mr_pong - registration message handler
 153  *
 154  * parv[0] = sender prefix
 155  * parv[1] = pong response echo
 156  * NOTE: cptr is always unregistered here
 157  */
 158 int mr_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 159 {
 160   assert(0 != cptr);
 161   assert(cptr == sptr);
 162   assert(!IsRegistered(sptr));
 163
 164   ClrFlag(cptr, FLAG_PINGSENT);
 165   cli_lasttime(cptr) = CurrentTime;
 166   /*
 167    * Check to see if this is a PONG :cookie reply from an
 168    * unregistered user.  If so, process it. -record
 169    */
 170   if (0 != cli_cookie(sptr) && COOKIE_VERIFIED != cli_cookie(sptr)) {
 171     if (parc > 1 && cli_cookie(sptr) == atol(parv[parc - 1])) {
 172       cli_cookie(sptr) = COOKIE_VERIFIED;
 173       cli_unreg(sptr) &= ~CLIREG_COOKIE; /* cookie has been returned... */
 174       if (!cli_unreg(sptr)) /* no more registration tasks... */
 175         /*
 176          * NICK and USER OK
 177          */
 178         return register_user(cptr, sptr, cli_name(sptr), cli_user(sptr)->username);
 179     }
 180     else
 181       send_reply(sptr, SND_EXPLICIT | ERR_BADPING,
 182                  ":To connect, type /QUOTE PONG %u", cli_cookie(sptr));
 183   }
 184   return 0;
 185 }
 186
 187 /*
 188  * m_pong - normal message handler
 189  *
 190  * parv[0] = sender prefix
 191  * parv[1] = origin
 192  * parv[2] = destination
 193  */
 194 int m_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 195 {
 196   assert(0 != cptr);
 197   assert(cptr == sptr);
 198   ClrFlag(cptr, FLAG_PINGSENT);
 199   cli_lasttime(cptr) = CurrentTime;
 200   return 0;
 201 }