2 * $Logfile: /Freespace2/code/Network/multi_kick.cpp $
8 * Revision 1.1 2002/05/03 03:28:10 root
12 * 8 10/13/99 3:51p Jefff
13 * fixed unnumbered XSTRs
15 * 7 3/10/99 6:50p Dave
16 * Changed the way we buffer packets for all clients. Optimized turret
17 * fired packets. Did some weapon firing optimizations.
19 * 6 3/09/99 6:24p Dave
20 * More work on object update revamping. Identified several sources of
21 * unnecessary bandwidth.
23 * 5 11/19/98 8:03a Dave
24 * Full support for D3-style reliable sockets. Revamped packet lag/loss
25 * system, made it receiver side and at the lowest possible level.
27 * 4 11/17/98 11:12a Dave
28 * Removed player identification by address. Now assign explicit id #'s.
30 * 3 11/05/98 5:55p Dave
31 * Big pass at reducing #includes
33 * 2 10/07/98 10:53a Dave
36 * 1 10/07/98 10:50a Dave
38 * 16 9/15/98 7:24p Dave
39 * Minor UI changes. Localized bunch of new text.
41 * 15 9/11/98 5:53p Dave
42 * Final revisions to kick system changes.
44 * 14 9/11/98 5:08p Dave
45 * More tweaks to kick notification system.
47 * 13 9/11/98 4:14p Dave
48 * Fixed file checksumming of < file_size. Put in more verbose kicking and
49 * PXO stats store reporting.
51 * 12 6/13/98 9:32p Mike
52 * Kill last character in file which caused "Find in Files" to report the
53 * file as "not a text file."
55 * 11 6/13/98 6:01p Hoffoss
56 * Externalized all new (or forgot to be added) strings to all the code.
58 * 10 4/23/98 6:18p Dave
59 * Store ETS values between respawns. Put kick feature in the text
60 * messaging system. Fixed text messaging system so that it doesn't
61 * process or trigger ship controls. Other UI fixes.
63 * 9 4/04/98 4:22p Dave
64 * First rev of UDP reliable sockets is done. Seems to work well if not
67 * 8 4/03/98 1:03a Dave
68 * First pass at unreliable guaranteed delivery packets.
70 * 7 4/01/98 11:19p Dave
71 * Put in auto-loading of xferred pilot pic files. Grey out background
72 * behind pinfo popup. Put a chatbox message in when players are kicked.
73 * Moved mission title down in briefing. Other ui fixes.
75 * 6 3/30/98 6:27p Dave
76 * Put in a more official set of multiplayer options, including a system
77 * for distributing netplayer and netgame settings.
79 * 5 3/24/98 5:00p Dave
80 * Fixed several ui bugs. Put in pre and post voice stream playback sound
81 * fx. Put in error specific popups for clients getting dropped from games
82 * through actions other than their own.
84 * 4 3/18/98 5:52p Dave
85 * Put in netgame password popup. Numerous ui changes. Laid groundwork for
86 * streamed multi_voice data.
88 * 3 3/17/98 5:29p Dave
89 * Minor bug fixes in player select menu. Solidified mp joining process.
90 * Made furball mode support ingame joiners and dropped players correctly.
92 * 2 3/15/98 4:17p Dave
93 * Fixed oberver hud problems. Put in handy netplayer macros. Reduced size
94 * of network orientation matrices.
96 * 1 2/12/98 4:38p Dave
97 * Multiplayer kick functionality
102 #include "multi_kick.h"
103 #include "multimsgs.h"
104 #include "multiutil.h"
105 #include "freespace.h"
109 // ----------------------------------------------------------------------------------
113 #define MULTI_KICK_RESPONSE_TIME 4000 // if someone who has been kicked has not responded in this time, disconnect him hard
115 #define MAX_BAN_SLOTS 30
116 net_addr Multi_kick_ban_slots[MAX_BAN_SLOTS]; // banned addresses
117 int Multi_kick_num_ban_slots; // the # of banned addresses
119 // ----------------------------------------------------------------------------------
120 // KICK FORWARD DECLARATIONS
123 // send a player kick packet
124 void send_player_kick_packet(int player_index, int ban = 1, int reason = KICK_REASON_NORM);
126 // process a player kick packet
127 void process_player_kick_packet(ubyte *data, header *hinfo);
129 // add a net address to the banned list
130 void multi_kick_add_ban(net_addr *addr);
132 // can the given player perform a kick
133 int multi_kick_can_kick(net_player *player);
136 // ----------------------------------------------------------------------------------
140 // initialize all kicking details (ban lists, etc). it is safe to call this function at any time
141 void multi_kick_init()
143 // blast all the ban slots
144 memset(Multi_kick_ban_slots,0,sizeof(net_addr)*MAX_BAN_SLOTS);
145 Multi_kick_num_ban_slots = 0;
148 // process all kick details (disconnecting players who have been kicked but haven't closed their socket)
149 void multi_kick_process()
153 // if i'm not the server, don't do anything
154 if(!(Net_player->flags & NETINFO_FLAG_AM_MASTER)){
158 // disconnect any kicked players who have timed out on leaving
159 for(idx=0;idx<MAX_PLAYERS;idx++){
160 if(MULTI_CONNECTED(Net_players[idx]) && (Net_players[idx].s_info.kick_timestamp != -1) && timestamp_elapsed(Net_players[idx].s_info.kick_timestamp) ){
161 delete_player(idx, Net_players[idx].s_info.kick_reason);
166 // attempt to kick a player. return success or fail
167 void multi_kick_player(int player_index, int ban, int reason)
169 // only the standalone should be able to kick the host of the game
170 if(!(Game_mode & GM_STANDALONE_SERVER) && ((Net_players[player_index].flags & NETINFO_FLAG_GAME_HOST) || (Net_players[player_index].flags & NETINFO_FLAG_AM_MASTER))){
171 nprintf(("Network","Cannot kick the host or server of a game!\n"));
173 // if we're the master, then delete the guy
174 if(Net_player->flags & NETINFO_FLAG_AM_MASTER){
175 // if we're supposed to ban him, add his address to the banned list
177 multi_kick_add_ban(&Net_players[player_index].p_info.addr);
180 // mark him as having been kicked
181 Net_players[player_index].flags |= NETINFO_FLAG_KICKED;
183 // set his kick timestamp and send him a leave game packet
184 Net_players[player_index].s_info.kick_timestamp = timestamp(MULTI_KICK_RESPONSE_TIME);
185 Net_players[player_index].s_info.kick_reason = reason;
186 send_leave_game_packet(Net_players[player_index].player_id, reason, &Net_players[player_index]);
188 // tell everyone else that he was kicked
189 send_leave_game_packet(Net_players[player_index].player_id, reason);
191 // wait until he either shuts his connection down or he times out)
192 // add the string to the chatbox and the hud (always safe - if it is not inited, nothing bad will happen)
195 sprintf(str, XSTR("<kicking %s ...>", 1501), Net_players[player_index].player->callsign);
196 multi_display_chat_msg(str, player_index, 0);
198 // otherwise, we should send the packet indicating that this guy should be kicked
200 send_player_kick_packet(player_index, ban, reason);
205 // is this net address currently kicked and banded
206 int multi_kick_is_banned(net_addr *addr)
210 // traverse the banned list
211 for(idx=0;idx<Multi_kick_num_ban_slots;idx++){
212 // if we found a duplicate
213 if(psnet_same(&Multi_kick_ban_slots[idx],addr)){
222 // debug console function called to determine which player to kick
223 void multi_dcf_kick()
227 // get the callsign of the player to kick
228 dc_get_arg(ARG_STRING);
230 if(strlen(Dc_arg) == 0){
231 dc_printf("Invalid player callsign!\n");
236 for(idx=0;idx<MAX_PLAYERS;idx++){
237 if(MULTI_CONNECTED(Net_players[idx]) && (stricmp(Net_players[idx].player->callsign,Dc_arg)==0)){
243 // if we didn't find the player, notify of the results
244 if(player_num == -1){
245 dc_printf("Could not find player %s to kick!",Dc_arg);
247 // if we found the guy, then try and kick him
249 multi_kick_player(player_num);
253 // fill in the passed string with the appropriate "kicked" string
254 void multi_kick_get_text(net_player *pl, int reason, char *str)
257 if((pl == NULL) || (pl->player == NULL)){
258 strcpy(str, NOX(""));
262 case KICK_REASON_BAD_XFER:
263 sprintf(str, XSTR("<%s was kicked because of mission file xfer failure>", 1003), pl->player->callsign);
265 case KICK_REASON_CANT_XFER:
266 sprintf(str, XSTR("<%s was kicked for not having builtin mission %s>", 1004), pl->player->callsign, Game_current_mission_filename);
268 case KICK_REASON_INGAME_ENDED:
269 sprintf(str, XSTR("<%s was kicked for ingame joining an ended game>",1005), pl->player->callsign);
272 sprintf(str, XSTR("<%s was kicked>",687), pl->player->callsign);
278 // ----------------------------------------------------------------------------------
279 // KICK FORWARD DEFINITIONS
282 // add a net address to the banned list
283 void multi_kick_add_ban(net_addr *addr)
285 // if we still have any slots left
286 if(Multi_kick_num_ban_slots < (MAX_BAN_SLOTS - 1)){
287 memcpy(&Multi_kick_ban_slots[Multi_kick_num_ban_slots++],addr,sizeof(net_addr));
292 // ----------------------------------------------------------------------------------
293 // KICK PACKET HANDLERS
296 // send a player kick packet
297 void send_player_kick_packet(int player_index, int ban, int reason)
299 ubyte data[MAX_PACKET_SIZE];
302 BUILD_HEADER(KICK_PLAYER);
304 // add the address of the player to be kicked
305 ADD_DATA(Net_players[player_index].player_id);
307 // indicate if he should be banned
311 // send the request to the server
312 multi_io_send_reliable(Net_player, data, packet_size);
315 // process a player kick packet
316 void process_player_kick_packet(ubyte *data, header *hinfo)
318 int player_num,from_player,ban,reason;
320 int offset = HEADER_LENGTH;
322 // get the address of the guy who is to be kicked
326 player_num = find_player_id(player_id);
329 // only the server should ever receive a request to kick a guy
330 Assert(Net_player->flags & NETINFO_FLAG_AM_MASTER);
332 // determine who sent the packet
333 from_player = find_player_id(hinfo->id);
335 // check to see if this guy is allowed to make such a request
336 if((from_player == -1) || !multi_kick_can_kick(&Net_players[from_player]) ){
337 nprintf(("Network","Received a kick request from an invalid player!!\n"));
339 // otherwise, process the request fully
341 // make sure we have a valid player to kick
342 if(player_num == -1){
343 nprintf(("Network","Received request to kick an unknown player!\n"));
345 // will handle all the rest of the details
346 multi_kick_player(player_num,ban,reason);
351 // can the given player perform a kick
352 int multi_kick_can_kick(net_player *player)
354 // only host or server can kick
355 if((player->flags & NETINFO_FLAG_AM_MASTER) || (player->flags & NETINFO_FLAG_GAME_HOST)){
359 // this guy cannot kick