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);
52 SDL_COMPILE_TIME_ASSERT(freespace2_net_game_data, sizeof(freespace2_net_game_data) == 120);
54 SDL_COMPILE_TIME_ASSERT(freespace_net_game_data, sizeof(freespace_net_game_data) == 696);
56 SDL_COMPILE_TIME_ASSERT(game_list, sizeof(game_list) == 384);
57 SDL_COMPILE_TIME_ASSERT(filter_game_list_struct, sizeof(filter_game_list_struct) == 40);
63 struct sockaddr_in gtrackaddr;
65 game_list GameBuffer[MAX_GAME_BUFFERS];
66 int GameType;//d3 or fs
68 unsigned int LastTrackerUpdate;
69 unsigned int LastSentToTracker;
70 unsigned int TrackerAckdUs;
71 unsigned int TrackerGameIsRunning;
73 game_packet_header TrackerGameData;
74 game_packet_header GameListReq;
75 game_packet_header TrackAckPacket;
76 game_packet_header GameOverPacket;
79 freespace_net_game_data *FreeSpaceTrackerGameData;
81 freespace2_net_game_data *FreeSpace2TrackerGameData;
85 unsigned int LastGameOverPacket;
86 unsigned int FirstGameOverPacket;
92 static int SerializeGamePacket(const game_packet_header *gph, ubyte *data)
96 PXO_ADD_UINT(gph->len);
97 PXO_ADD_DATA(gph->game_type);
98 PXO_ADD_DATA(gph->junk); // not used, basically just padding for compatibility
99 PXO_ADD_INT(gph->type);
100 PXO_ADD_UINT(gph->sig);
103 // these have no other data
108 // this one may or may not have extra data
109 case GNT_GAMELIST_REQ: {
110 if (gph->len > GAME_HEADER_ONLY_SIZE) {
111 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
113 filter_game_list_struct *filter = (filter_game_list_struct *)&gph->data;
115 PXO_ADD_INT(filter->rank);
116 PXO_ADD_DATA(filter->channel);
117 PXO_ADD_DATA(filter->pad); // for sizing, so gph->len will match
123 case GNT_GAMEUPDATE: {
124 pxo_net_game_data *game_data = (pxo_net_game_data *)&gph->data;
126 PXO_ADD_DATA(game_data->game_name);
127 PXO_ADD_INT(game_data->difficulty);
128 PXO_ADD_INT(game_data->type);
129 PXO_ADD_INT(game_data->state);
130 PXO_ADD_INT(game_data->max_players);
131 PXO_ADD_INT(game_data->current_num_players);
132 PXO_ADD_DATA(game_data->mission_name);
137 for (i = 0; i < MAX_FREESPACE_PLAYERS; i++) {
138 PXO_ADD_DATA(game_data->players[i]);
141 for (i = 0; i < MAX_FREESPACE_PLAYERS; i++) {
142 PXO_ADD_INT(game_data->player_rank[i]);
146 PXO_ADD_DATA(game_data->channel);
149 PXO_ADD_DATA(game_data->pad); // for sizing, so gph->len will match
155 case GNT_GAME_COUNT_REQ: {
156 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
158 filter_game_list_struct filter;
162 memcpy(filter.channel, gph->data, sizeof(filter.channel));
164 PXO_ADD_DATA(filter.channel);
166 // add in junk data (ignored on server) to make packet size match
167 PXO_ADD_INT(filter.rank);
168 PXO_ADD_DATA(filter.pad);
173 // we shouldn't be sending any other packet types
179 SDL_assert(packet_size >= (int)GAME_HEADER_ONLY_SIZE);
180 SDL_assert(packet_size == (int)gph->len);
185 static void DeserializeGamePacket(const ubyte *data, const int data_size, game_packet_header *gph)
190 memset(gph, 0, sizeof(game_packet_header));
192 // make sure we received a complete base packet
193 if (data_size < (int)GAME_HEADER_ONLY_SIZE) {
195 gph->type = 255; // invalid = 0xff
200 PXO_GET_UINT(gph->len);
201 PXO_GET_DATA(gph->game_type);
202 PXO_GET_DATA(gph->junk); // not used, basically just padding for compatibility
203 PXO_GET_INT(gph->type);
204 PXO_GET_UINT(gph->sig);
206 // sanity check data size to make sure we reveived all of the expected packet
207 // (not exactly sure what -1 is for, but that's how it is later)
208 if ((int)gph->len-1 > data_size) {
219 case GNT_GAMELIST_DATA: {
220 game_list *games = (game_list *)&gph->data;
222 PXO_GET_DATA(games->game_type);
224 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
225 PXO_GET_DATA(games->game_name[i]);
228 PXO_GET_DATA(games->pad); // padded bytes for alignment
230 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
231 PXO_GET_UINT(games->game_server[i]);
234 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
235 PXO_GET_USHORT(games->port[i]);
241 case GNT_GAME_COUNT_DATA: {
245 PXO_GET_INT(n_users);
247 SDL_strlcpy(channel, (char *)(data+offset), SDL_arraysize(channel));
248 offset += (strlen(channel) + 1);
250 memcpy(gph->data, &n_users, sizeof(int));
251 memcpy(gph->data+sizeof(int), channel, strlen(channel)+1);
260 //SDL_assert(offset == data_size);
264 int InitGameTrackerClient(int gametype)
266 struct sockaddr_in sockaddr;
270 LastTrackerUpdate = 0;
278 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace_net_game_data);
287 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace2_net_game_data);
295 TrackerGameData.game_type = (unsigned char)gametype; //1==freespace (GT_FREESPACE), 2==D3, 3==tuberacer, etc.
296 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.
299 FreeSpaceTrackerGameData = (freespace_net_game_data *)&TrackerGameData.data;
301 FreeSpace2TrackerGameData = (freespace2_net_game_data *)&TrackerGameData.data;
304 GameListReq.game_type = (unsigned char)gametype;
305 GameListReq.type = GNT_GAMELIST_REQ;
306 GameListReq.len = GAME_HEADER_ONLY_SIZE;
308 TrackAckPacket.game_type = (unsigned char)gametype;
309 TrackAckPacket.len = GAME_HEADER_ONLY_SIZE;
310 TrackAckPacket.type = GNT_CLIENT_ACK;
312 GameOverPacket.game_type = (unsigned char)gametype;
313 GameOverPacket.len = GAME_HEADER_ONLY_SIZE;
314 GameOverPacket.type = GNT_GAMEOVER;
316 // gamesock = socket(AF_INET,SOCK_DGRAM,0);
319 if ( gamesock == INVALID_SOCKET )
321 printf("Unable to open a socket.\n");
326 memset( &sockaddr, 0, sizeof(struct sockaddr_in) );
327 sockaddr.sin_family = AF_INET;
328 sockaddr.sin_addr.s_addr = INADDR_ANY;
329 sockaddr.sin_port = 0;//htons(GAMEPORT);
332 if (SOCKET_ERROR==bind(gamesock, (struct sockaddr*)&sockaddr, sizeof (sockaddr)))
334 printf("Unable to bind a socket.\n");
335 printf("WSAGetLastError() returned %d.\n",WSAGetLastError());
340 iaddr = inet_addr ( Multi_options_g.game_tracker_ip );
341 if ( iaddr == INADDR_NONE ) {
342 // first try and resolve by name
344 he = gethostbyname( Multi_options_g.game_tracker_ip );
349 // try and resolve by address
350 unsigned int n_order = inet_addr(Multi_game_tracker_ip_address);
351 he = gethostbyaddr((char*)&n_order,4,PF_INET);
359 iaddr = ((in_addr *)(he->h_addr))->s_addr;
362 // This would be a good place to resolve the IP based on a domain name
363 gtrackaddr.sin_addr.s_addr = iaddr;
364 gtrackaddr.sin_family = AF_INET;
365 gtrackaddr.sin_port = htons( GAMEPORT );
374 void IdleGameTracker()
377 struct timeval timeout;
378 ubyte packet_data[sizeof(game_packet_header)];
379 int packet_length = 0;
381 PSNET_TOP_LAYER_PROCESS();
385 if((TrackerGameIsRunning) && ((timer_get_seconds()-LastTrackerUpdate)>TRACKER_UPDATE_INTERVAL) && !SendingGameOver)
387 //Time to update the tracker again
388 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
389 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
391 LastTrackerUpdate = timer_get_seconds();
393 else if((TrackerGameIsRunning)&&(!TrackerAckdUs)&&((timer_get_milliseconds()-LastSentToTracker)>TRACKER_RESEND_TIME))
395 //We still haven't been acked by the last packet and it's time to resend.
396 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
397 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
399 LastTrackerUpdate = timer_get_seconds();
400 LastSentToTracker = timer_get_milliseconds();
405 if((timer_get_milliseconds()-LastGameOverPacket)>TRACKER_RESEND_TIME){
407 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
408 LastGameOverPacket = timer_get_milliseconds();
409 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
412 else if((timer_get_milliseconds()-FirstGameOverPacket)>NET_ACK_TIMEOUT) {
413 //Giving up, it timed out.
423 FD_SET(Unreliable_socket, &read_fds);
425 if(SELECT(Unreliable_socket+1,&read_fds,NULL,NULL,&timeout, PSNET_TYPE_GAME_TRACKER))
429 struct sockaddr_in fromaddr;
431 game_packet_header inpacket;
434 addrsize = sizeof(struct sockaddr_in);
436 bytesin = RECVFROM(Unreliable_socket, (char *)&packet_data, sizeof(game_packet_header), 0, (struct sockaddr *)&fromaddr, &addrsize, PSNET_TYPE_GAME_TRACKER);
439 DeserializeGamePacket(packet_data, bytesin, &inpacket);
441 // subtract one from the header
445 int wserr=WSAGetLastError();
446 mprintf(("RECVFROM() failure. WSAGetLastError() returned %d\n",wserr));
450 //Check to make sure the packets ok
451 if ( (bytesin > 0) && (bytesin == (int)inpacket.len) )
453 switch(inpacket.type)
456 //The server got our packet so we can stop sending now
459 // 7/13/98 -- because of the FreeSpace iterative frame process -- set this value to 0, instead
460 // of to 2 (as it originally was) since we call SendGameOver() only once. Once we get the ack
461 // from the server, we can assume that we are done.
462 // need to mark this as 0
465 case GNT_GAMELIST_DATA:
467 //Woohoo! Game data! put it in the buffer (if one's free)
468 for(i=0;i<MAX_GAME_BUFFERS;i++)
470 if(GameBuffer[i].game_type==GT_UNUSED)
472 memcpy(&GameBuffer[i],&inpacket.data,sizeof(game_list));
473 i=MAX_GAME_BUFFERS+1;
478 case GNT_GAME_COUNT_DATA:
479 //Here, inpacket.data contains the following structure
482 // char channel[];//Null terminated
484 //You can add whatever code, or callback, etc. you need to deal with this data
486 // let the PXO screen know about this data
490 // get the user count
491 memcpy(&num_servers,inpacket.data,sizeof(int));
493 // copy the channel name
494 SDL_strlcpy(channel, inpacket.data+sizeof(int), SDL_arraysize(channel));
496 // send it to the PXO screen
497 multi_pxo_channel_count_update(channel,num_servers);
500 AckPacket(inpacket.sig);
505 void UpdateGameData(void *buffer)
514 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
522 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
532 game_list * GetGameList()
535 for(int i=0;i<MAX_GAME_BUFFERS;i++)
537 if(GameBuffer[i].game_type!=GT_UNUSED)
539 memcpy(&gl,&GameBuffer[i],sizeof(game_list));
540 GameBuffer[i].game_type = GT_UNUSED;
547 void RequestGameList()
549 ubyte packet_data[sizeof(game_packet_header)];
550 int packet_length = 0;
552 GameListReq.len = GAME_HEADER_ONLY_SIZE;
554 packet_length = SerializeGamePacket(&GameListReq, packet_data);
555 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
558 void RequestGameListWithFilter(void *filter)
560 ubyte packet_data[sizeof(game_packet_header)];
561 int packet_length = 0;
563 memcpy(&GameListReq.data,filter,sizeof(filter_game_list_struct));
564 GameListReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
566 packet_length = SerializeGamePacket(&GameListReq, packet_data);
567 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
574 TrackerGameIsRunning = 0;
575 sendto(gamesock,(const char *)&GameOverPacket,GameOverPacket.len,0,(struct sockaddr *)>rackaddr,sizeof(struct sockaddr_in));
582 ubyte packet_data[sizeof(game_packet_header)];
583 int packet_length = 0;
585 if(SendingGameOver==2)
590 if(SendingGameOver==1)
592 //Wait until it's sent.
596 if(SendingGameOver==0)
598 LastGameOverPacket = timer_get_milliseconds();
599 FirstGameOverPacket = timer_get_milliseconds();
601 TrackerGameIsRunning = 0;
603 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
604 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
612 void AckPacket(int sig)
614 ubyte packet_data[sizeof(game_packet_header)];
615 int packet_length = 0;
617 TrackAckPacket.sig = sig;
619 packet_length = SerializeGamePacket(&TrackAckPacket, packet_data);
620 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
623 void StartTrackerGame(void *buffer)
632 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
640 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
648 TrackerGameIsRunning = 1;
649 LastTrackerUpdate = 0;
653 void RequestGameCountWithFilter(void *filter)
655 game_packet_header GameCountReq;
656 ubyte packet_data[sizeof(game_packet_header)];
657 int packet_length = 0;
660 GameCountReq.game_type = GT_FREESPACE;
662 GameCountReq.game_type = GT_FREESPACE2;
664 GameCountReq.type = GNT_GAME_COUNT_REQ;
665 GameCountReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
666 memcpy(&GameCountReq.data, ((filter_game_list_struct*)filter)->channel, CHANNEL_LEN);
668 packet_length = SerializeGamePacket(&GameCountReq, packet_data);
669 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);