2 * Copyright (C) Volition, Inc. 2005. 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 the
11 //Game Tracker client code
14 InitGameTracker(int game_type); //D3 or Freespace
16 //Call periodically so we can send our update, and make sure it is received
19 StartTrackerGame(void *buffer) //Call with a freespace_net_game_data or d3_net_game_data structure
20 //Call with a freespace_net_game_data or d3_net_game_data structure
21 //Updates our memory so when it is time, we send the latest game data
22 UpdateGameData(gamedata);
25 //Call to signify end of game
27 RequestGameList();//Sends a GNT_GAMELIST_REQ packet to the server.
29 game_list * GetGameList();//returns a pointer to a game_list struct
35 #include <arpa/inet.h>
36 #include <netinet/in.h>
44 #include "multi_pxo.h"
49 // check structs for size compatibility
50 SDL_COMPILE_TIME_ASSERT(game_packet_header, sizeof(game_packet_header) == 529);
51 SDL_COMPILE_TIME_ASSERT(freespace2_net_game_data, sizeof(freespace2_net_game_data) == 120);
52 SDL_COMPILE_TIME_ASSERT(game_list, sizeof(game_list) == 384);
53 SDL_COMPILE_TIME_ASSERT(filter_game_list_struct, sizeof(filter_game_list_struct) == 40);
59 struct sockaddr_in gtrackaddr;
61 game_list GameBuffer[MAX_GAME_BUFFERS];
62 int GameType;//d3 or fs
64 unsigned int LastTrackerUpdate;
65 unsigned int LastSentToTracker;
66 unsigned int TrackerAckdUs;
67 unsigned int TrackerGameIsRunning;
69 game_packet_header TrackerGameData;
70 game_packet_header GameListReq;
71 game_packet_header TrackAckPacket;
72 game_packet_header GameOverPacket;
75 freespace_net_game_data *FreeSpaceTrackerGameData;
77 freespace2_net_game_data *FreeSpace2TrackerGameData;
81 unsigned int LastGameOverPacket;
82 unsigned int FirstGameOverPacket;
88 static int SerializeGamePacket(const game_packet_header *gph, ubyte *data)
92 PXO_ADD_UINT(gph->len);
93 PXO_ADD_DATA(gph->game_type);
94 PXO_ADD_DATA(gph->junk); // not used, basically just padding for compatibility
95 PXO_ADD_INT(gph->type);
96 PXO_ADD_UINT(gph->sig);
99 // these have no other data
104 // this one may or may not have extra data
105 case GNT_GAMELIST_REQ: {
106 if (gph->len > GAME_HEADER_ONLY_SIZE) {
107 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
109 filter_game_list_struct *filter = (filter_game_list_struct *)&gph->data;
111 PXO_ADD_INT(filter->rank);
112 PXO_ADD_DATA(filter->channel);
113 PXO_ADD_DATA(filter->pad); // for sizing, so gph->len will match
119 case GNT_GAMEUPDATE: {
120 freespace2_net_game_data *game_data = (freespace2_net_game_data *)&gph->data;
122 PXO_ADD_DATA(game_data->game_name);
123 PXO_ADD_INT(game_data->difficulty);
124 PXO_ADD_INT(game_data->type);
125 PXO_ADD_INT(game_data->state);
126 PXO_ADD_INT(game_data->max_players);
127 PXO_ADD_INT(game_data->current_num_players);
128 PXO_ADD_DATA(game_data->mission_name);
129 PXO_ADD_DATA(game_data->channel);
134 case GNT_GAME_COUNT_REQ: {
135 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
137 filter_game_list_struct filter;
141 memcpy(filter.channel, gph->data, sizeof(filter.channel));
143 PXO_ADD_DATA(filter.channel);
145 // add in junk data (ignored on server) to make packet size match
146 PXO_ADD_INT(filter.rank);
147 PXO_ADD_DATA(filter.pad);
152 // we shouldn't be sending any other packet types
158 SDL_assert(packet_size >= (int)GAME_HEADER_ONLY_SIZE);
159 SDL_assert(packet_size == (int)gph->len);
164 static void DeserializeGamePacket(const ubyte *data, const int data_size, game_packet_header *gph)
169 memset(gph, 0, sizeof(game_packet_header));
171 // make sure we received a complete base packet
172 if (data_size < (int)GAME_HEADER_ONLY_SIZE) {
174 gph->type = 255; // invalid = 0xff
179 PXO_GET_UINT(gph->len);
180 PXO_GET_DATA(gph->game_type);
181 PXO_GET_DATA(gph->junk); // not used, basically just padding for compatibility
182 PXO_GET_INT(gph->type);
183 PXO_GET_UINT(gph->sig);
185 // sanity check data size to make sure we reveived all of the expected packet
186 // (not exactly sure what -1 is for, but that's how it is later)
187 if ((int)gph->len-1 > data_size) {
198 case GNT_GAMELIST_DATA: {
199 game_list *games = (game_list *)&gph->data;
201 PXO_GET_DATA(games->game_type);
203 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
204 PXO_GET_DATA(games->game_name[i]);
207 PXO_GET_DATA(games->pad); // padded bytes for alignment
209 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
210 PXO_GET_UINT(games->game_server[i]);
213 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
214 PXO_GET_USHORT(games->port[i]);
220 case GNT_GAME_COUNT_DATA: {
224 PXO_GET_INT(n_users);
226 SDL_strlcpy(channel, (char *)(data+offset), SDL_arraysize(channel));
227 offset += (strlen(channel) + 1);
229 memcpy(gph->data, &n_users, sizeof(int));
230 memcpy(gph->data+sizeof(int), channel, strlen(channel)+1);
239 //SDL_assert(offset == data_size);
243 int InitGameTrackerClient(int gametype)
245 struct sockaddr_in sockaddr;
249 LastTrackerUpdate = 0;
257 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace_net_game_data);
266 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace2_net_game_data);
274 TrackerGameData.game_type = (unsigned char)gametype; //1==freespace (GT_FREESPACE), 2==D3, 3==tuberacer, etc.
275 TrackerGameData.type = GNT_GAMEUPDATE; //Used to specify what to do ie. Add a new net game (GNT_GAMESTARTED), remove a net game (game over), etc.
278 FreeSpaceTrackerGameData = (freespace_net_game_data *)&TrackerGameData.data;
280 FreeSpace2TrackerGameData = (freespace2_net_game_data *)&TrackerGameData.data;
283 GameListReq.game_type = (unsigned char)gametype;
284 GameListReq.type = GNT_GAMELIST_REQ;
285 GameListReq.len = GAME_HEADER_ONLY_SIZE;
287 TrackAckPacket.game_type = (unsigned char)gametype;
288 TrackAckPacket.len = GAME_HEADER_ONLY_SIZE;
289 TrackAckPacket.type = GNT_CLIENT_ACK;
291 GameOverPacket.game_type = (unsigned char)gametype;
292 GameOverPacket.len = GAME_HEADER_ONLY_SIZE;
293 GameOverPacket.type = GNT_GAMEOVER;
295 // gamesock = socket(AF_INET,SOCK_DGRAM,0);
298 if ( gamesock == INVALID_SOCKET )
300 printf("Unable to open a socket.\n");
305 memset( &sockaddr, 0, sizeof(struct sockaddr_in) );
306 sockaddr.sin_family = AF_INET;
307 sockaddr.sin_addr.s_addr = INADDR_ANY;
308 sockaddr.sin_port = 0;//htons(GAMEPORT);
311 if (SOCKET_ERROR==bind(gamesock, (struct sockaddr*)&sockaddr, sizeof (sockaddr)))
313 printf("Unable to bind a socket.\n");
314 printf("WSAGetLastError() returned %d.\n",WSAGetLastError());
319 iaddr = inet_addr ( Multi_options_g.game_tracker_ip );
320 if ( iaddr == INADDR_NONE ) {
321 // first try and resolve by name
323 he = gethostbyname( Multi_options_g.game_tracker_ip );
328 // try and resolve by address
329 unsigned int n_order = inet_addr(Multi_game_tracker_ip_address);
330 he = gethostbyaddr((char*)&n_order,4,PF_INET);
338 iaddr = ((in_addr *)(he->h_addr))->s_addr;
341 // This would be a good place to resolve the IP based on a domain name
342 gtrackaddr.sin_addr.s_addr = iaddr;
343 gtrackaddr.sin_family = AF_INET;
344 gtrackaddr.sin_port = htons( GAMEPORT );
353 void IdleGameTracker()
356 struct timeval timeout;
357 ubyte packet_data[sizeof(game_packet_header)];
358 int packet_length = 0;
360 PSNET_TOP_LAYER_PROCESS();
364 if((TrackerGameIsRunning) && ((timer_get_seconds()-LastTrackerUpdate)>TRACKER_UPDATE_INTERVAL) && !SendingGameOver)
366 //Time to update the tracker again
367 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
368 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
370 LastTrackerUpdate = timer_get_seconds();
372 else if((TrackerGameIsRunning)&&(!TrackerAckdUs)&&((timer_get_milliseconds()-LastSentToTracker)>TRACKER_RESEND_TIME))
374 //We still haven't been acked by the last packet and it's time to resend.
375 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
376 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
378 LastTrackerUpdate = timer_get_seconds();
379 LastSentToTracker = timer_get_milliseconds();
384 if((timer_get_milliseconds()-LastGameOverPacket)>TRACKER_RESEND_TIME){
386 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
387 LastGameOverPacket = timer_get_milliseconds();
388 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
391 else if((timer_get_milliseconds()-FirstGameOverPacket)>NET_ACK_TIMEOUT) {
392 //Giving up, it timed out.
402 FD_SET(Unreliable_socket, &read_fds);
404 if(SELECT(Unreliable_socket+1,&read_fds,NULL,NULL,&timeout, PSNET_TYPE_GAME_TRACKER))
406 unsigned int bytesin;
408 struct sockaddr_in fromaddr;
410 game_packet_header inpacket;
411 addrsize = sizeof(struct sockaddr_in);
413 bytesin = RECVFROM(Unreliable_socket, (char *)&packet_data, sizeof(game_packet_header), 0, (struct sockaddr *)&fromaddr, &addrsize, PSNET_TYPE_GAME_TRACKER);
414 DeserializeGamePacket(packet_data, bytesin, &inpacket);
417 int wserr=WSAGetLastError();
418 mprintf(("RECVFROM() failure. WSAGetLastError() returned %d\n",wserr));
422 // subtract one from the header
425 //Check to make sure the packets ok
426 if(bytesin==inpacket.len)
428 switch(inpacket.type)
431 //The server got our packet so we can stop sending now
434 // 7/13/98 -- because of the FreeSpace iterative frame process -- set this value to 0, instead
435 // of to 2 (as it originally was) since we call SendGameOver() only once. Once we get the ack
436 // from the server, we can assume that we are done.
437 // need to mark this as 0
440 case GNT_GAMELIST_DATA:
442 //Woohoo! Game data! put it in the buffer (if one's free)
443 for(i=0;i<MAX_GAME_BUFFERS;i++)
445 if(GameBuffer[i].game_type==GT_UNUSED)
447 memcpy(&GameBuffer[i],&inpacket.data,sizeof(game_list));
448 i=MAX_GAME_BUFFERS+1;
453 case GNT_GAME_COUNT_DATA:
454 //Here, inpacket.data contains the following structure
457 // char channel[];//Null terminated
459 //You can add whatever code, or callback, etc. you need to deal with this data
461 // let the PXO screen know about this data
465 // get the user count
466 memcpy(&num_servers,inpacket.data,sizeof(int));
468 // copy the channel name
469 SDL_strlcpy(channel, inpacket.data+sizeof(int), SDL_arraysize(channel));
471 // send it to the PXO screen
472 multi_pxo_channel_count_update(channel,num_servers);
475 AckPacket(inpacket.sig);
480 void UpdateGameData(void *buffer)
489 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
497 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
507 game_list * GetGameList()
510 for(int i=0;i<MAX_GAME_BUFFERS;i++)
512 if(GameBuffer[i].game_type!=GT_UNUSED)
514 memcpy(&gl,&GameBuffer[i],sizeof(game_list));
515 GameBuffer[i].game_type = GT_UNUSED;
522 void RequestGameList()
524 ubyte packet_data[sizeof(game_packet_header)];
525 int packet_length = 0;
527 GameListReq.len = GAME_HEADER_ONLY_SIZE;
529 packet_length = SerializeGamePacket(&GameListReq, packet_data);
530 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
533 void RequestGameListWithFilter(void *filter)
535 ubyte packet_data[sizeof(game_packet_header)];
536 int packet_length = 0;
538 memcpy(&GameListReq.data,filter,sizeof(filter_game_list_struct));
539 GameListReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
541 packet_length = SerializeGamePacket(&GameListReq, packet_data);
542 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
549 TrackerGameIsRunning = 0;
550 sendto(gamesock,(const char *)&GameOverPacket,GameOverPacket.len,0,(struct sockaddr *)>rackaddr,sizeof(struct sockaddr_in));
557 ubyte packet_data[sizeof(game_packet_header)];
558 int packet_length = 0;
560 if(SendingGameOver==2)
565 if(SendingGameOver==1)
567 //Wait until it's sent.
571 if(SendingGameOver==0)
573 LastGameOverPacket = timer_get_milliseconds();
574 FirstGameOverPacket = timer_get_milliseconds();
576 TrackerGameIsRunning = 0;
578 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
579 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
587 void AckPacket(int sig)
589 ubyte packet_data[sizeof(game_packet_header)];
590 int packet_length = 0;
592 TrackAckPacket.sig = sig;
594 packet_length = SerializeGamePacket(&TrackAckPacket, packet_data);
595 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
598 void StartTrackerGame(void *buffer)
607 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
615 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
623 TrackerGameIsRunning = 1;
624 LastTrackerUpdate = 0;
628 void RequestGameCountWithFilter(void *filter)
630 game_packet_header GameCountReq;
631 ubyte packet_data[sizeof(game_packet_header)];
632 int packet_length = 0;
635 GameCountReq.game_type = GT_FREESPACE;
637 GameCountReq.game_type = GT_FREESPACE2;
639 GameCountReq.type = GNT_GAME_COUNT_REQ;
640 GameCountReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
641 memcpy(&GameCountReq.data, ((filter_game_list_struct*)filter)->channel, CHANNEL_LEN);
643 packet_length = SerializeGamePacket(&GameCountReq, packet_data);
644 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);