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_reply.h"
  88 #include "ircd_string.h"
  89 #include "msg.h"
  90 #include "numeric.h"
  91 #include "numnicks.h"
  92 #include "s_user.h"
  93 #include "send.h"
  94
  95 #include <assert.h>
  96 #include <string.h>
  97 #include <stdlib.h>
  98
  99 /*
 100  * ms_pong - server message handler template
 101  *
 102  * parv[0] = sender prefix
 103  * parv[1] = origin
 104  * parv[2] = destination
 105  */
 106 int ms_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 107 {
 108   char*          origin;
 109   char*          destination;
 110   assert(0 != cptr);
 111   assert(0 != sptr);
 112   assert(IsServer(cptr));
 113
 114   if (parc < 2 || EmptyString(parv[1])) {
 115     return protocol_violation(sptr,"No Origin on PONG");
 116   }
 117   origin      = parv[1];
 118   destination = parv[2];
 119   cli_flags(cptr) &= ~FLAGS_PINGSENT;
 120   cli_flags(sptr) &= ~FLAGS_PINGSENT;
 121   cli_lasttime(cptr) = CurrentTime;
 122
 123   if (!EmptyString(destination) && 0 != ircd_strcmp(destination, cli_name(&me))) {
 124     struct Client* acptr;
 125     if ((acptr = FindClient(destination))) {
 126       sendcmdto_one(sptr, CMD_PONG, acptr, "%s %s", origin, destination);
 127     }
 128   }
 129   return 0;
 130 }
 131
 132 /*
 133  * mr_pong - registration message handler
 134  *
 135  * parv[0] = sender prefix
 136  * parv[1] = pong response echo
 137  * NOTE: cptr is always unregistered here
 138  */
 139 int mr_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 140 {
 141   assert(0 != cptr);
 142   assert(cptr == sptr);
 143   assert(!IsRegistered(sptr));
 144
 145   cli_flags(cptr) &= ~FLAGS_PINGSENT;
 146   cli_lasttime(cptr) = CurrentTime;
 147   /*
 148    * Check to see if this is a PONG :cookie reply from an
 149    * unregistered user.  If so, process it. -record
 150    */
 151   if (0 != cli_cookie(sptr) && COOKIE_VERIFIED != cli_cookie(sptr)) {
 152     if (parc > 1 && cli_cookie(sptr) == atol(parv[parc - 1])) {
 153       cli_cookie(sptr) = COOKIE_VERIFIED;
 154       if (cli_user(sptr) && *(cli_user(sptr))->host && (cli_name(sptr))[0])
 155         /*
 156          * NICK and USER OK
 157          */
 158         return register_user(cptr, sptr, cli_name(sptr), cli_user(sptr)->username);
 159     }
 160     else
 161       send_reply(sptr, SND_EXPLICIT | ERR_BADPING,
 162                  ":To connect, type /QUOTE PONG %u", cli_cookie(sptr));
 163   }
 164   return 0;
 165 }
 166
 167 /*
 168  * m_pong - normal message handler
 169  *
 170  * parv[0] = sender prefix
 171  * parv[1] = origin
 172  * parv[2] = destination
 173  */
 174 int m_pong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 175 {
 176   assert(0 != cptr);
 177   assert(cptr == sptr);
 178   cli_flags(cptr) &= ~FLAGS_PINGSENT;
 179   cli_lasttime(cptr) = CurrentTime;
 180   return 0;
 181 }