ircd/m_endburst.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_end_of_burst.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 "send.h"
  99
 100 #include <assert.h>
 101
 102 /*
 103  * ms_end_of_burst - server message handler
 104  * - Added Xorath 6-14-96, rewritten by Run 24-7-96
 105  * - and fixed by record and Kev 8/1/96
 106  * - and really fixed by Run 15/8/96 :p
 107  * This the last message in a net.burst.
 108  * It clears a flag for the server sending the burst.
 109  *
 110  * parv[0] - sender prefix
 111  */
 112 int ms_end_of_burst(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 113 {
 114   assert(0 != cptr);
 115   assert(0 != sptr);
 116   if (!IsServer(sptr))
 117     return 0;
 118
 119   sendto_opmask_butone(0, SNO_NETWORK, "Completed net.burst from %C.", sptr);
 120   sendcmdto_serv_butone(sptr, CMD_END_OF_BURST, cptr, "");
 121   ClearBurst(sptr);
 122   SetBurstAck(sptr);
 123   if (MyConnect(sptr))
 124     sendcmdto_one(&me, CMD_END_OF_BURST_ACK, sptr, "");
 125
 126   return 0;
 127 }
 128
 129 /*
 130  * ms_end_of_burst_ack - server message handler
 131  *
 132  * This the acknowledge message of the `END_OF_BURST' message.
 133  * It clears a flag for the server receiving the burst.
 134  *
 135  * parv[0] - sender prefix
 136  */
 137 int ms_end_of_burst_ack(struct Client *cptr, struct Client *sptr, int parc, char **parv)
 138 {
 139   if (!IsServer(sptr))
 140     return 0;
 141
 142   sendto_opmask_butone(0, SNO_NETWORK, "%C acknowledged end of net.burst.",
 143                        sptr);
 144   sendcmdto_serv_butone(sptr, CMD_END_OF_BURST_ACK, cptr, "");
 145   ClearBurstAck(sptr);
 146
 147   return 0;
 148 }
 149
 150
 151 #if 0
 152 /*
 153  * m_end_of_burst  - Added Xorath 6-14-96, rewritten by Run 24-7-96
 154  *                 - and fixed by record and Kev 8/1/96
 155  *                 - and really fixed by Run 15/8/96 :p
 156  * This the last message in a net.burst.
 157  * It clears a flag for the server sending the burst.
 158  *
 159  * parv[0] - sender prefix
 160  */
 161 int m_end_of_burst(struct Client *cptr, struct Client *sptr, int parc, char **parv)
 162 {
 163   if (!IsServer(sptr))
 164     return 0;
 165
 166   sendto_op_mask(SNO_NETWORK, "Completed net.burst from %s.", sptr->name); /* XXX DEAD */
 167   sendto_serv_butone(cptr, "%s EB", NumServ(sptr)); /* XXX DEAD */
 168   ClearBurst(sptr);
 169   SetBurstAck(sptr);
 170   if (MyConnect(sptr))
 171     sendto_one(sptr, "%s EA", NumServ(&me)); /* XXX DEAD */
 172
 173   return 0;
 174 }
 175 /*
 176  * m_end_of_burst_ack
 177  *
 178  * This the acknowledge message of the `END_OF_BURST' message.
 179  * It clears a flag for the server receiving the burst.
 180  *
 181  * parv[0] - sender prefix
 182  */
 183 int m_end_of_burst_ack(struct Client *cptr, struct Client *sptr, int parc, char **parv)
 184 {
 185   if (!IsServer(sptr))
 186     return 0;
 187
 188   sendto_op_mask(SNO_NETWORK, "%s acknowledged end of net.burst.", sptr->name); /* XXX DEAD */
 189   sendto_serv_butone(cptr, "%s EA", NumServ(sptr)); /* XXX DEAD */
 190   ClearBurstAck(sptr);
 191
 192   return 0;
 193 }
 194
 195 #endif /* 0 */
 196