ec42f725fa0d51ecc9b986d1fbcfdc81f8f080a1
[ircu2.10.12-pk.git] / 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 "channel.h"
91 #include "client.h"
92 #include "hash.h"
93 #include "ircd.h"
94 #include "ircd_reply.h"
95 #include "ircd_string.h"
96 #include "msg.h"
97 #include "numeric.h"
98 #include "numnicks.h"
99 #include "send.h"
100
101 #include <assert.h>
102
103 /*
104  * ms_end_of_burst - server message handler
105  * - Added Xorath 6-14-96, rewritten by Run 24-7-96
106  * - and fixed by record and Kev 8/1/96
107  * - and really fixed by Run 15/8/96 :p
108  * This the last message in a net.burst.
109  * It clears a flag for the server sending the burst.
110  *
111  * As of 10.11, to fix a bug in the way BURST is processed, it also
112  * makes sure empty channels are deleted
113  *
114  * parv[0] - sender prefix
115  */
116 int ms_end_of_burst(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
117 {
118   struct Channel *chan, *next_chan;
119
120   assert(0 != cptr);
121   assert(0 != sptr);
122   if (!IsServer(sptr))
123     return 0;
124
125   sendto_opmask_butone(0, SNO_NETWORK, "Completed net.burst from %C.", sptr);
126   sendcmdto_serv_butone(sptr, CMD_END_OF_BURST, cptr, "");
127   ClearBurst(sptr);
128   SetBurstAck(sptr);
129   if (MyConnect(sptr))
130     sendcmdto_one(&me, CMD_END_OF_BURST_ACK, sptr, "");
131
132   /* Count through channels... */
133   for (chan = GlobalChannelList; chan; chan = next_chan) {
134     next_chan = chan->next;
135
136     if (!chan->members) { /* empty channel */
137       if (!(chan->mode.mode & MODE_BURSTADDED))
138         sendto_opmask_butone(0, SNO_OLDSNO, "Empty channel %H not added by "
139                              "BURST!", chan);
140
141       sub1_from_channel(chan); /* ok, nuke channel now */
142     }
143
144     chan->mode.mode &= ~MODE_BURSTADDED;
145   }
146
147   return 0;
148 }
149
150 /*
151  * ms_end_of_burst_ack - server message handler
152  *
153  * This the acknowledge message of the `END_OF_BURST' message.
154  * It clears a flag for the server receiving the burst.
155  *
156  * parv[0] - sender prefix
157  */
158 int ms_end_of_burst_ack(struct Client *cptr, struct Client *sptr, int parc, char **parv)
159 {
160   if (!IsServer(sptr))
161     return 0;
162
163   sendto_opmask_butone(0, SNO_NETWORK, "%C acknowledged end of net.burst.",
164                        sptr);
165   sendcmdto_serv_butone(sptr, CMD_END_OF_BURST_ACK, cptr, "");
166   ClearBurstAck(sptr);
167
168   return 0;
169 }
170
171
172 #if 0
173 /*
174  * m_end_of_burst  - Added Xorath 6-14-96, rewritten by Run 24-7-96
175  *                 - and fixed by record and Kev 8/1/96
176  *                 - and really fixed by Run 15/8/96 :p
177  * This the last message in a net.burst.
178  * It clears a flag for the server sending the burst.
179  *
180  * parv[0] - sender prefix
181  */
182 int m_end_of_burst(struct Client *cptr, struct Client *sptr, int parc, char **parv)
183 {
184   if (!IsServer(sptr))
185     return 0;
186
187   sendto_op_mask(SNO_NETWORK, "Completed net.burst from %s.", sptr->name); /* XXX DEAD */
188   sendto_serv_butone(cptr, "%s EB", NumServ(sptr)); /* XXX DEAD */
189   ClearBurst(sptr);
190   SetBurstAck(sptr);
191   if (MyConnect(sptr))
192     sendto_one(sptr, "%s EA", NumServ(&me)); /* XXX DEAD */
193
194   return 0;
195 }
196 /*
197  * m_end_of_burst_ack
198  *
199  * This the acknowledge message of the `END_OF_BURST' message.
200  * It clears a flag for the server receiving the burst.
201  *
202  * parv[0] - sender prefix
203  */
204 int m_end_of_burst_ack(struct Client *cptr, struct Client *sptr, int parc, char **parv)
205 {
206   if (!IsServer(sptr))
207     return 0;
208
209   sendto_op_mask(SNO_NETWORK, "%s acknowledged end of net.burst.", sptr->name); /* XXX DEAD */
210   sendto_serv_butone(cptr, "%s EA", NumServ(sptr)); /* XXX DEAD */
211   ClearBurstAck(sptr);
212
213   return 0;
214 }
215
216 #endif /* 0 */
217