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
51 SDL_COMPILE_TIME_ASSERT(game_packet_header, sizeof(game_packet_header) == 529);
52 SDL_COMPILE_TIME_ASSERT(freespace2_net_game_data, sizeof(freespace2_net_game_data) == 120);
54 SDL_COMPILE_TIME_ASSERT(game_packet_header, sizeof(game_packet_header) == 729);
55 SDL_COMPILE_TIME_ASSERT(freespace_net_game_data, sizeof(freespace_net_game_data) == 696);
57 SDL_COMPILE_TIME_ASSERT(game_list, sizeof(game_list) == 384);
58 SDL_COMPILE_TIME_ASSERT(filter_game_list_struct, sizeof(filter_game_list_struct) == 40);
65 #define GAMESOCK gamesock
67 #define GAMESOCK Unreliable_socket
69 struct sockaddr_in gtrackaddr;
71 game_list GameBuffer[MAX_GAME_BUFFERS];
72 int GameType;//d3 or fs
74 unsigned int LastTrackerUpdate;
75 unsigned int LastSentToTracker;
76 unsigned int TrackerAckdUs;
77 unsigned int TrackerGameIsRunning;
79 game_packet_header TrackerGameData;
80 game_packet_header GameListReq;
81 game_packet_header TrackAckPacket;
82 game_packet_header GameOverPacket;
85 freespace_net_game_data *FreeSpaceTrackerGameData;
87 freespace2_net_game_data *FreeSpace2TrackerGameData;
91 unsigned int LastGameOverPacket;
92 unsigned int FirstGameOverPacket;
98 static int SerializeGamePacket(const game_packet_header *gph, ubyte *data)
102 PXO_ADD_UINT(gph->len);
103 PXO_ADD_DATA(gph->game_type);
106 // FS1 needs an extra 3 bytes padding
113 PXO_ADD_DATA(gph->junk); // not used, basically just padding for compatibility
114 PXO_ADD_INT(gph->type);
115 PXO_ADD_UINT(gph->sig);
118 // these have no other data
123 // this one may or may not have extra data
124 case GNT_GAMELIST_REQ: {
125 if (gph->len > GAME_HEADER_ONLY_SIZE) {
126 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
128 filter_game_list_struct *filter = (filter_game_list_struct *)&gph->data;
130 PXO_ADD_INT(filter->rank);
131 PXO_ADD_DATA(filter->channel);
132 PXO_ADD_DATA(filter->pad); // for sizing, so gph->len will match
138 case GNT_GAMEUPDATE: {
139 pxo_net_game_data *game_data = (pxo_net_game_data *)&gph->data;
141 PXO_ADD_DATA(game_data->game_name);
142 PXO_ADD_INT(game_data->difficulty);
143 PXO_ADD_INT(game_data->type);
144 PXO_ADD_INT(game_data->state);
145 PXO_ADD_INT(game_data->max_players);
146 PXO_ADD_INT(game_data->current_num_players);
147 PXO_ADD_DATA(game_data->mission_name);
152 for (i = 0; i < MAX_FREESPACE_PLAYERS; i++) {
153 PXO_ADD_DATA(game_data->players[i]);
156 for (i = 0; i < MAX_FREESPACE_PLAYERS; i++) {
157 PXO_ADD_INT(game_data->player_rank[i]);
161 PXO_ADD_DATA(game_data->channel);
162 PXO_ADD_DATA(game_data->pad); // for sizing, so gph->len will match
167 case GNT_GAME_COUNT_REQ: {
168 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
170 filter_game_list_struct filter;
174 memcpy(filter.channel, gph->data, sizeof(filter.channel));
176 PXO_ADD_DATA(filter.channel);
178 // add in junk data (ignored on server) to make packet size match
179 PXO_ADD_INT(filter.rank);
180 PXO_ADD_DATA(filter.pad);
185 // we shouldn't be sending any other packet types
191 SDL_assert(packet_size >= (int)GAME_HEADER_ONLY_SIZE);
192 SDL_assert(packet_size == (int)gph->len);
197 static void DeserializeGamePacket(const ubyte *data, const int data_size, game_packet_header *gph)
202 memset(gph, 0, sizeof(game_packet_header));
204 // make sure we received a complete base packet
205 if (data_size < (int)GAME_HEADER_ONLY_SIZE) {
207 gph->type = 255; // invalid = 0xff
212 PXO_GET_UINT(gph->len);
213 PXO_GET_DATA(gph->game_type);
216 // FS1 has 3 bytes of padding here
222 PXO_GET_DATA(gph->junk); // not used, basically just padding for compatibility
223 PXO_GET_INT(gph->type);
224 PXO_GET_UINT(gph->sig);
226 // sanity check data size to make sure we reveived all of the expected packet
228 // (the -1 is because psnet2 pops off one byte)
229 if ((int)gph->len-1 > data_size) {
231 if ((int)gph->len > data_size) {
243 case GNT_GAMELIST_DATA: {
244 game_list *games = (game_list *)&gph->data;
246 PXO_GET_DATA(games->game_type);
248 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
249 PXO_GET_DATA(games->game_name[i]);
252 PXO_GET_DATA(games->pad); // padded bytes for alignment
254 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
255 PXO_GET_UINT(games->game_server[i]);
258 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
259 PXO_GET_USHORT(games->port[i]);
265 case GNT_GAME_COUNT_DATA: {
269 PXO_GET_INT(n_users);
271 SDL_strlcpy(channel, (char *)(data+offset), SDL_arraysize(channel));
272 offset += (strlen(channel) + 1);
274 memcpy(gph->data, &n_users, sizeof(int));
275 memcpy(gph->data+sizeof(int), channel, strlen(channel)+1);
284 //SDL_assert(offset == data_size);
288 int InitGameTrackerClient(int gametype)
290 struct sockaddr_in sockaddr;
294 LastTrackerUpdate = 0;
302 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace_net_game_data);
311 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace2_net_game_data);
319 TrackerGameData.game_type = (unsigned char)gametype; //1==freespace (GT_FREESPACE), 2==D3, 3==tuberacer, etc.
320 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.
323 FreeSpaceTrackerGameData = (freespace_net_game_data *)&TrackerGameData.data;
325 FreeSpace2TrackerGameData = (freespace2_net_game_data *)&TrackerGameData.data;
328 GameListReq.game_type = (unsigned char)gametype;
329 GameListReq.type = GNT_GAMELIST_REQ;
330 GameListReq.len = GAME_HEADER_ONLY_SIZE;
332 TrackAckPacket.game_type = (unsigned char)gametype;
333 TrackAckPacket.len = GAME_HEADER_ONLY_SIZE;
334 TrackAckPacket.type = GNT_CLIENT_ACK;
336 GameOverPacket.game_type = (unsigned char)gametype;
337 GameOverPacket.len = GAME_HEADER_ONLY_SIZE;
338 GameOverPacket.type = GNT_GAMEOVER;
341 gamesock = socket(AF_INET,SOCK_DGRAM,0);
343 if ( gamesock == (SOCKET)INVALID_SOCKET )
345 mprintf(("Unable to open a socket.\n"));
350 memset( &sockaddr, 0, sizeof(struct sockaddr_in) );
351 sockaddr.sin_family = AF_INET;
352 sockaddr.sin_addr.s_addr = INADDR_ANY;
353 sockaddr.sin_port = 0;//htons(GAMEPORT);
356 if (SOCKET_ERROR==bind(gamesock, (struct sockaddr*)&sockaddr, sizeof (sockaddr)))
358 mprintf(("Unable to bind a socket.\n"));
359 mprintf(("WSAGetLastError() returned %d.\n",WSAGetLastError()));
364 iaddr = inet_addr ( Multi_options_g.game_tracker_ip );
365 if ( iaddr == INADDR_NONE ) {
366 // first try and resolve by name
368 he = gethostbyname( Multi_options_g.game_tracker_ip );
373 // try and resolve by address
374 unsigned int n_order = inet_addr(Multi_game_tracker_ip_address);
375 he = gethostbyaddr((char*)&n_order,4,PF_INET);
383 iaddr = ((in_addr *)(he->h_addr))->s_addr;
386 // This would be a good place to resolve the IP based on a domain name
387 gtrackaddr.sin_addr.s_addr = iaddr;
388 gtrackaddr.sin_family = AF_INET;
389 gtrackaddr.sin_port = htons( GAMEPORT );
398 void IdleGameTracker()
401 struct timeval timeout;
402 ubyte packet_data[sizeof(game_packet_header)];
403 int packet_length = 0;
406 PSNET_TOP_LAYER_PROCESS();
411 if((TrackerGameIsRunning) && ((timer_get_seconds()-LastTrackerUpdate)>TRACKER_UPDATE_INTERVAL) && !SendingGameOver)
413 //Time to update the tracker again
414 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
415 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
417 LastTrackerUpdate = timer_get_seconds();
419 else if((TrackerGameIsRunning)&&(!TrackerAckdUs)&&((timer_get_milliseconds()-LastSentToTracker)>TRACKER_RESEND_TIME))
421 //We still haven't been acked by the last packet and it's time to resend.
422 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
423 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
425 LastTrackerUpdate = timer_get_seconds();
426 LastSentToTracker = timer_get_milliseconds();
431 if((timer_get_milliseconds()-LastGameOverPacket)>TRACKER_RESEND_TIME){
433 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
434 LastGameOverPacket = timer_get_milliseconds();
435 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
438 else if((timer_get_milliseconds()-FirstGameOverPacket)>NET_ACK_TIMEOUT) {
439 //Giving up, it timed out.
449 FD_SET(GAMESOCK, &read_fds);
451 if(PXO_SELECT(GAMESOCK+1,&read_fds,NULL,NULL,&timeout, PSNET_TYPE_GAME_TRACKER))
455 struct sockaddr_in fromaddr;
457 game_packet_header inpacket;
460 addrsize = sizeof(struct sockaddr_in);
462 bytesin = PXO_RECVFROM(GAMESOCK, (char *)&packet_data, sizeof(game_packet_header), 0, (struct sockaddr *)&fromaddr, &addrsize, PSNET_TYPE_GAME_TRACKER);
465 DeserializeGamePacket(packet_data, bytesin, &inpacket);
468 // subtract one from the header
473 int wserr=WSAGetLastError();
474 mprintf(("RECVFROM() failure. WSAGetLastError() returned %d\n",wserr));
478 //Check to make sure the packets ok
479 if ( (bytesin > 0) && (bytesin == (int)inpacket.len) )
481 switch(inpacket.type)
484 //The server got our packet so we can stop sending now
487 // 7/13/98 -- because of the FreeSpace iterative frame process -- set this value to 0, instead
488 // of to 2 (as it originally was) since we call SendGameOver() only once. Once we get the ack
489 // from the server, we can assume that we are done.
490 // need to mark this as 0
493 case GNT_GAMELIST_DATA:
495 //Woohoo! Game data! put it in the buffer (if one's free)
496 for(i=0;i<MAX_GAME_BUFFERS;i++)
498 if(GameBuffer[i].game_type==GT_UNUSED)
500 memcpy(&GameBuffer[i],&inpacket.data,sizeof(game_list));
501 i=MAX_GAME_BUFFERS+1;
506 case GNT_GAME_COUNT_DATA:
507 //Here, inpacket.data contains the following structure
510 // char channel[];//Null terminated
512 //You can add whatever code, or callback, etc. you need to deal with this data
514 // let the PXO screen know about this data
518 // get the user count
519 memcpy(&num_servers,inpacket.data,sizeof(int));
521 // copy the channel name
522 SDL_strlcpy(channel, inpacket.data+sizeof(int), SDL_arraysize(channel));
524 // send it to the PXO screen
525 multi_pxo_channel_count_update(channel,num_servers);
528 AckPacket(inpacket.sig);
533 void UpdateGameData(void *buffer)
542 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
550 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
560 game_list * GetGameList()
563 for(int i=0;i<MAX_GAME_BUFFERS;i++)
565 if(GameBuffer[i].game_type!=GT_UNUSED)
567 memcpy(&gl,&GameBuffer[i],sizeof(game_list));
568 GameBuffer[i].game_type = GT_UNUSED;
575 void RequestGameList()
577 ubyte packet_data[sizeof(game_packet_header)];
578 int packet_length = 0;
580 GameListReq.len = GAME_HEADER_ONLY_SIZE;
582 packet_length = SerializeGamePacket(&GameListReq, packet_data);
583 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
586 void RequestGameListWithFilter(void *filter)
588 ubyte packet_data[sizeof(game_packet_header)];
589 int packet_length = 0;
591 memcpy(&GameListReq.data,filter,sizeof(filter_game_list_struct));
592 GameListReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
594 packet_length = SerializeGamePacket(&GameListReq, packet_data);
595 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
602 TrackerGameIsRunning = 0;
603 sendto(gamesock,(const char *)&GameOverPacket,GameOverPacket.len,0,(struct sockaddr *)>rackaddr,sizeof(struct sockaddr_in));
610 ubyte packet_data[sizeof(game_packet_header)];
611 int packet_length = 0;
613 if(SendingGameOver==2)
618 if(SendingGameOver==1)
620 //Wait until it's sent.
624 if(SendingGameOver==0)
626 LastGameOverPacket = timer_get_milliseconds();
627 FirstGameOverPacket = timer_get_milliseconds();
629 TrackerGameIsRunning = 0;
631 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
632 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
640 void AckPacket(int sig)
642 ubyte packet_data[sizeof(game_packet_header)];
643 int packet_length = 0;
645 TrackAckPacket.sig = sig;
647 packet_length = SerializeGamePacket(&TrackAckPacket, packet_data);
648 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
651 void StartTrackerGame(void *buffer)
660 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
668 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
676 TrackerGameIsRunning = 1;
677 LastTrackerUpdate = 0;
681 void RequestGameCountWithFilter(void *filter)
683 game_packet_header GameCountReq;
684 ubyte packet_data[sizeof(game_packet_header)];
685 int packet_length = 0;
688 GameCountReq.game_type = GT_FREESPACE;
690 GameCountReq.game_type = GT_FREESPACE2;
692 GameCountReq.type = GNT_GAME_COUNT_REQ;
693 GameCountReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
694 memcpy(&GameCountReq.data, ((filter_game_list_struct*)filter)->channel, CHANNEL_LEN);
696 packet_length = SerializeGamePacket(&GameCountReq, packet_data);
697 PXO_SENDTO(GAMESOCK, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);