2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/Network/multi_kick.cpp $
16 * Revision 1.4 2002/06/09 04:41:23 relnev
17 * added copyright header
19 * Revision 1.3 2002/05/27 00:40:47 theoddone33
20 * Fix net_addr vs net_addr_t
22 * Revision 1.2 2002/05/07 03:16:47 theoddone33
23 * The Great Newline Fix
25 * Revision 1.1.1.1 2002/05/03 03:28:10 root
29 * 8 10/13/99 3:51p Jefff
30 * fixed unnumbered XSTRs
32 * 7 3/10/99 6:50p Dave
33 * Changed the way we buffer packets for all clients. Optimized turret
34 * fired packets. Did some weapon firing optimizations.
36 * 6 3/09/99 6:24p Dave
37 * More work on object update revamping. Identified several sources of
38 * unnecessary bandwidth.
40 * 5 11/19/98 8:03a Dave
41 * Full support for D3-style reliable sockets. Revamped packet lag/loss
42 * system, made it receiver side and at the lowest possible level.
44 * 4 11/17/98 11:12a Dave
45 * Removed player identification by address. Now assign explicit id #'s.
47 * 3 11/05/98 5:55p Dave
48 * Big pass at reducing #includes
50 * 2 10/07/98 10:53a Dave
53 * 1 10/07/98 10:50a Dave
55 * 16 9/15/98 7:24p Dave
56 * Minor UI changes. Localized bunch of new text.
58 * 15 9/11/98 5:53p Dave
59 * Final revisions to kick system changes.
61 * 14 9/11/98 5:08p Dave
62 * More tweaks to kick notification system.
64 * 13 9/11/98 4:14p Dave
65 * Fixed file checksumming of < file_size. Put in more verbose kicking and
66 * PXO stats store reporting.
68 * 12 6/13/98 9:32p Mike
69 * Kill last character in file which caused "Find in Files" to report the
70 * file as "not a text file."
72 * 11 6/13/98 6:01p Hoffoss
73 * Externalized all new (or forgot to be added) strings to all the code.
75 * 10 4/23/98 6:18p Dave
76 * Store ETS values between respawns. Put kick feature in the text
77 * messaging system. Fixed text messaging system so that it doesn't
78 * process or trigger ship controls. Other UI fixes.
80 * 9 4/04/98 4:22p Dave
81 * First rev of UDP reliable sockets is done. Seems to work well if not
84 * 8 4/03/98 1:03a Dave
85 * First pass at unreliable guaranteed delivery packets.
87 * 7 4/01/98 11:19p Dave
88 * Put in auto-loading of xferred pilot pic files. Grey out background
89 * behind pinfo popup. Put a chatbox message in when players are kicked.
90 * Moved mission title down in briefing. Other ui fixes.
92 * 6 3/30/98 6:27p Dave
93 * Put in a more official set of multiplayer options, including a system
94 * for distributing netplayer and netgame settings.
96 * 5 3/24/98 5:00p Dave
97 * Fixed several ui bugs. Put in pre and post voice stream playback sound
98 * fx. Put in error specific popups for clients getting dropped from games
99 * through actions other than their own.
101 * 4 3/18/98 5:52p Dave
102 * Put in netgame password popup. Numerous ui changes. Laid groundwork for
103 * streamed multi_voice data.
105 * 3 3/17/98 5:29p Dave
106 * Minor bug fixes in player select menu. Solidified mp joining process.
107 * Made furball mode support ingame joiners and dropped players correctly.
109 * 2 3/15/98 4:17p Dave
110 * Fixed oberver hud problems. Put in handy netplayer macros. Reduced size
111 * of network orientation matrices.
113 * 1 2/12/98 4:38p Dave
114 * Multiplayer kick functionality
119 #include "multi_kick.h"
120 #include "multimsgs.h"
121 #include "multiutil.h"
122 #include "freespace.h"
126 // ----------------------------------------------------------------------------------
130 #define MULTI_KICK_RESPONSE_TIME 4000 // if someone who has been kicked has not responded in this time, disconnect him hard
132 #define MAX_BAN_SLOTS 30
133 net_addr_t Multi_kick_ban_slots[MAX_BAN_SLOTS]; // banned addresses
134 int Multi_kick_num_ban_slots; // the # of banned addresses
136 // ----------------------------------------------------------------------------------
137 // KICK FORWARD DECLARATIONS
140 // send a player kick packet
141 void send_player_kick_packet(int player_index, int ban = 1, int reason = KICK_REASON_NORM);
143 // process a player kick packet
144 void process_player_kick_packet(ubyte *data, header *hinfo);
146 // add a net address to the banned list
147 void multi_kick_add_ban(net_addr_t *addr);
149 // can the given player perform a kick
150 int multi_kick_can_kick(net_player *player);
153 // ----------------------------------------------------------------------------------
157 // initialize all kicking details (ban lists, etc). it is safe to call this function at any time
158 void multi_kick_init()
160 // blast all the ban slots
161 memset(Multi_kick_ban_slots,0,sizeof(net_addr_t)*MAX_BAN_SLOTS);
162 Multi_kick_num_ban_slots = 0;
165 // process all kick details (disconnecting players who have been kicked but haven't closed their socket)
166 void multi_kick_process()
170 // if i'm not the server, don't do anything
171 if(!(Net_player->flags & NETINFO_FLAG_AM_MASTER)){
175 // disconnect any kicked players who have timed out on leaving
176 for(idx=0;idx<MAX_PLAYERS;idx++){
177 if(MULTI_CONNECTED(Net_players[idx]) && (Net_players[idx].s_info.kick_timestamp != -1) && timestamp_elapsed(Net_players[idx].s_info.kick_timestamp) ){
178 delete_player(idx, Net_players[idx].s_info.kick_reason);
183 // attempt to kick a player. return success or fail
184 void multi_kick_player(int player_index, int ban, int reason)
186 // only the standalone should be able to kick the host of the game
187 if(!(Game_mode & GM_STANDALONE_SERVER) && ((Net_players[player_index].flags & NETINFO_FLAG_GAME_HOST) || (Net_players[player_index].flags & NETINFO_FLAG_AM_MASTER))){
188 nprintf(("Network","Cannot kick the host or server of a game!\n"));
190 // if we're the master, then delete the guy
191 if(Net_player->flags & NETINFO_FLAG_AM_MASTER){
192 // if we're supposed to ban him, add his address to the banned list
194 multi_kick_add_ban(&Net_players[player_index].p_info.addr);
197 // mark him as having been kicked
198 Net_players[player_index].flags |= NETINFO_FLAG_KICKED;
200 // set his kick timestamp and send him a leave game packet
201 Net_players[player_index].s_info.kick_timestamp = timestamp(MULTI_KICK_RESPONSE_TIME);
202 Net_players[player_index].s_info.kick_reason = reason;
203 send_leave_game_packet(Net_players[player_index].player_id, reason, &Net_players[player_index]);
205 // tell everyone else that he was kicked
206 send_leave_game_packet(Net_players[player_index].player_id, reason);
208 // wait until he either shuts his connection down or he times out)
209 // add the string to the chatbox and the hud (always safe - if it is not inited, nothing bad will happen)
212 sprintf(str, XSTR("<kicking %s ...>", 1501), Net_players[player_index].player->callsign);
213 multi_display_chat_msg(str, player_index, 0);
215 // otherwise, we should send the packet indicating that this guy should be kicked
217 send_player_kick_packet(player_index, ban, reason);
222 // is this net address currently kicked and banded
223 int multi_kick_is_banned(net_addr_t *addr)
227 // traverse the banned list
228 for(idx=0;idx<Multi_kick_num_ban_slots;idx++){
229 // if we found a duplicate
230 if(psnet_same(&Multi_kick_ban_slots[idx],addr)){
239 // debug console function called to determine which player to kick
240 void multi_dcf_kick()
244 // get the callsign of the player to kick
245 dc_get_arg(ARG_STRING);
247 if(strlen(Dc_arg) == 0){
248 dc_printf("Invalid player callsign!\n");
253 for(idx=0;idx<MAX_PLAYERS;idx++){
254 if(MULTI_CONNECTED(Net_players[idx]) && (stricmp(Net_players[idx].player->callsign,Dc_arg)==0)){
260 // if we didn't find the player, notify of the results
261 if(player_num == -1){
262 dc_printf("Could not find player %s to kick!",Dc_arg);
264 // if we found the guy, then try and kick him
266 multi_kick_player(player_num);
270 // fill in the passed string with the appropriate "kicked" string
271 void multi_kick_get_text(net_player *pl, int reason, char *str)
274 if((pl == NULL) || (pl->player == NULL)){
275 strcpy(str, NOX(""));
279 case KICK_REASON_BAD_XFER:
280 sprintf(str, XSTR("<%s was kicked because of mission file xfer failure>", 1003), pl->player->callsign);
282 case KICK_REASON_CANT_XFER:
283 sprintf(str, XSTR("<%s was kicked for not having builtin mission %s>", 1004), pl->player->callsign, Game_current_mission_filename);
285 case KICK_REASON_INGAME_ENDED:
286 sprintf(str, XSTR("<%s was kicked for ingame joining an ended game>",1005), pl->player->callsign);
289 sprintf(str, XSTR("<%s was kicked>",687), pl->player->callsign);
295 // ----------------------------------------------------------------------------------
296 // KICK FORWARD DEFINITIONS
299 // add a net address to the banned list
300 void multi_kick_add_ban(net_addr_t *addr)
302 // if we still have any slots left
303 if(Multi_kick_num_ban_slots < (MAX_BAN_SLOTS - 1)){
304 memcpy(&Multi_kick_ban_slots[Multi_kick_num_ban_slots++],addr,sizeof(net_addr_t));
309 // ----------------------------------------------------------------------------------
310 // KICK PACKET HANDLERS
313 // send a player kick packet
314 void send_player_kick_packet(int player_index, int ban, int reason)
316 ubyte data[MAX_PACKET_SIZE];
319 BUILD_HEADER(KICK_PLAYER);
321 // add the address of the player to be kicked
322 ADD_DATA(Net_players[player_index].player_id);
324 // indicate if he should be banned
328 // send the request to the server
329 multi_io_send_reliable(Net_player, data, packet_size);
332 // process a player kick packet
333 void process_player_kick_packet(ubyte *data, header *hinfo)
335 int player_num,from_player,ban,reason;
337 int offset = HEADER_LENGTH;
339 // get the address of the guy who is to be kicked
343 player_num = find_player_id(player_id);
346 // only the server should ever receive a request to kick a guy
347 Assert(Net_player->flags & NETINFO_FLAG_AM_MASTER);
349 // determine who sent the packet
350 from_player = find_player_id(hinfo->id);
352 // check to see if this guy is allowed to make such a request
353 if((from_player == -1) || !multi_kick_can_kick(&Net_players[from_player]) ){
354 nprintf(("Network","Received a kick request from an invalid player!!\n"));
356 // otherwise, process the request fully
358 // make sure we have a valid player to kick
359 if(player_num == -1){
360 nprintf(("Network","Received request to kick an unknown player!\n"));
362 // will handle all the rest of the details
363 multi_kick_player(player_num,ban,reason);
368 // can the given player perform a kick
369 int multi_kick_can_kick(net_player *player)
371 // only host or server can kick
372 if((player->flags & NETINFO_FLAG_AM_MASTER) || (player->flags & NETINFO_FLAG_GAME_HOST)){
376 // this guy cannot kick