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);
130 PXO_ADD_DATA(game_data->pad); // for sizing, so gph->len will match
135 case GNT_GAME_COUNT_REQ: {
136 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
138 filter_game_list_struct filter;
142 memcpy(filter.channel, gph->data, sizeof(filter.channel));
144 PXO_ADD_DATA(filter.channel);
146 // add in junk data (ignored on server) to make packet size match
147 PXO_ADD_INT(filter.rank);
148 PXO_ADD_DATA(filter.pad);
153 // we shouldn't be sending any other packet types
159 SDL_assert(packet_size >= (int)GAME_HEADER_ONLY_SIZE);
160 SDL_assert(packet_size == (int)gph->len);
165 static void DeserializeGamePacket(const ubyte *data, const int data_size, game_packet_header *gph)
170 memset(gph, 0, sizeof(game_packet_header));
172 // make sure we received a complete base packet
173 if (data_size < (int)GAME_HEADER_ONLY_SIZE) {
175 gph->type = 255; // invalid = 0xff
180 PXO_GET_UINT(gph->len);
181 PXO_GET_DATA(gph->game_type);
182 PXO_GET_DATA(gph->junk); // not used, basically just padding for compatibility
183 PXO_GET_INT(gph->type);
184 PXO_GET_UINT(gph->sig);
186 // sanity check data size to make sure we reveived all of the expected packet
187 // (not exactly sure what -1 is for, but that's how it is later)
188 if ((int)gph->len-1 > data_size) {
199 case GNT_GAMELIST_DATA: {
200 game_list *games = (game_list *)&gph->data;
202 PXO_GET_DATA(games->game_type);
204 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
205 PXO_GET_DATA(games->game_name[i]);
208 PXO_GET_DATA(games->pad); // padded bytes for alignment
210 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
211 PXO_GET_UINT(games->game_server[i]);
214 for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
215 PXO_GET_USHORT(games->port[i]);
221 case GNT_GAME_COUNT_DATA: {
225 PXO_GET_INT(n_users);
227 SDL_strlcpy(channel, (char *)(data+offset), SDL_arraysize(channel));
228 offset += (strlen(channel) + 1);
230 memcpy(gph->data, &n_users, sizeof(int));
231 memcpy(gph->data+sizeof(int), channel, strlen(channel)+1);
240 //SDL_assert(offset == data_size);
244 int InitGameTrackerClient(int gametype)
246 struct sockaddr_in sockaddr;
250 LastTrackerUpdate = 0;
258 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace_net_game_data);
267 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace2_net_game_data);
275 TrackerGameData.game_type = (unsigned char)gametype; //1==freespace (GT_FREESPACE), 2==D3, 3==tuberacer, etc.
276 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.
279 FreeSpaceTrackerGameData = (freespace_net_game_data *)&TrackerGameData.data;
281 FreeSpace2TrackerGameData = (freespace2_net_game_data *)&TrackerGameData.data;
284 GameListReq.game_type = (unsigned char)gametype;
285 GameListReq.type = GNT_GAMELIST_REQ;
286 GameListReq.len = GAME_HEADER_ONLY_SIZE;
288 TrackAckPacket.game_type = (unsigned char)gametype;
289 TrackAckPacket.len = GAME_HEADER_ONLY_SIZE;
290 TrackAckPacket.type = GNT_CLIENT_ACK;
292 GameOverPacket.game_type = (unsigned char)gametype;
293 GameOverPacket.len = GAME_HEADER_ONLY_SIZE;
294 GameOverPacket.type = GNT_GAMEOVER;
296 // gamesock = socket(AF_INET,SOCK_DGRAM,0);
299 if ( gamesock == INVALID_SOCKET )
301 printf("Unable to open a socket.\n");
306 memset( &sockaddr, 0, sizeof(struct sockaddr_in) );
307 sockaddr.sin_family = AF_INET;
308 sockaddr.sin_addr.s_addr = INADDR_ANY;
309 sockaddr.sin_port = 0;//htons(GAMEPORT);
312 if (SOCKET_ERROR==bind(gamesock, (struct sockaddr*)&sockaddr, sizeof (sockaddr)))
314 printf("Unable to bind a socket.\n");
315 printf("WSAGetLastError() returned %d.\n",WSAGetLastError());
320 iaddr = inet_addr ( Multi_options_g.game_tracker_ip );
321 if ( iaddr == INADDR_NONE ) {
322 // first try and resolve by name
324 he = gethostbyname( Multi_options_g.game_tracker_ip );
329 // try and resolve by address
330 unsigned int n_order = inet_addr(Multi_game_tracker_ip_address);
331 he = gethostbyaddr((char*)&n_order,4,PF_INET);
339 iaddr = ((in_addr *)(he->h_addr))->s_addr;
342 // This would be a good place to resolve the IP based on a domain name
343 gtrackaddr.sin_addr.s_addr = iaddr;
344 gtrackaddr.sin_family = AF_INET;
345 gtrackaddr.sin_port = htons( GAMEPORT );
354 void IdleGameTracker()
357 struct timeval timeout;
358 ubyte packet_data[sizeof(game_packet_header)];
359 int packet_length = 0;
361 PSNET_TOP_LAYER_PROCESS();
365 if((TrackerGameIsRunning) && ((timer_get_seconds()-LastTrackerUpdate)>TRACKER_UPDATE_INTERVAL) && !SendingGameOver)
367 //Time to update the tracker again
368 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
369 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
371 LastTrackerUpdate = timer_get_seconds();
373 else if((TrackerGameIsRunning)&&(!TrackerAckdUs)&&((timer_get_milliseconds()-LastSentToTracker)>TRACKER_RESEND_TIME))
375 //We still haven't been acked by the last packet and it's time to resend.
376 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
377 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
379 LastTrackerUpdate = timer_get_seconds();
380 LastSentToTracker = timer_get_milliseconds();
385 if((timer_get_milliseconds()-LastGameOverPacket)>TRACKER_RESEND_TIME){
387 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
388 LastGameOverPacket = timer_get_milliseconds();
389 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
392 else if((timer_get_milliseconds()-FirstGameOverPacket)>NET_ACK_TIMEOUT) {
393 //Giving up, it timed out.
403 FD_SET(Unreliable_socket, &read_fds);
405 if(SELECT(Unreliable_socket+1,&read_fds,NULL,NULL,&timeout, PSNET_TYPE_GAME_TRACKER))
407 unsigned int bytesin;
409 struct sockaddr_in fromaddr;
411 game_packet_header inpacket;
412 addrsize = sizeof(struct sockaddr_in);
414 bytesin = RECVFROM(Unreliable_socket, (char *)&packet_data, sizeof(game_packet_header), 0, (struct sockaddr *)&fromaddr, &addrsize, PSNET_TYPE_GAME_TRACKER);
415 DeserializeGamePacket(packet_data, bytesin, &inpacket);
418 int wserr=WSAGetLastError();
419 mprintf(("RECVFROM() failure. WSAGetLastError() returned %d\n",wserr));
423 // subtract one from the header
426 //Check to make sure the packets ok
427 if(bytesin==inpacket.len)
429 switch(inpacket.type)
432 //The server got our packet so we can stop sending now
435 // 7/13/98 -- because of the FreeSpace iterative frame process -- set this value to 0, instead
436 // of to 2 (as it originally was) since we call SendGameOver() only once. Once we get the ack
437 // from the server, we can assume that we are done.
438 // need to mark this as 0
441 case GNT_GAMELIST_DATA:
443 //Woohoo! Game data! put it in the buffer (if one's free)
444 for(i=0;i<MAX_GAME_BUFFERS;i++)
446 if(GameBuffer[i].game_type==GT_UNUSED)
448 memcpy(&GameBuffer[i],&inpacket.data,sizeof(game_list));
449 i=MAX_GAME_BUFFERS+1;
454 case GNT_GAME_COUNT_DATA:
455 //Here, inpacket.data contains the following structure
458 // char channel[];//Null terminated
460 //You can add whatever code, or callback, etc. you need to deal with this data
462 // let the PXO screen know about this data
466 // get the user count
467 memcpy(&num_servers,inpacket.data,sizeof(int));
469 // copy the channel name
470 SDL_strlcpy(channel, inpacket.data+sizeof(int), SDL_arraysize(channel));
472 // send it to the PXO screen
473 multi_pxo_channel_count_update(channel,num_servers);
476 AckPacket(inpacket.sig);
481 void UpdateGameData(void *buffer)
490 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
498 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
508 game_list * GetGameList()
511 for(int i=0;i<MAX_GAME_BUFFERS;i++)
513 if(GameBuffer[i].game_type!=GT_UNUSED)
515 memcpy(&gl,&GameBuffer[i],sizeof(game_list));
516 GameBuffer[i].game_type = GT_UNUSED;
523 void RequestGameList()
525 ubyte packet_data[sizeof(game_packet_header)];
526 int packet_length = 0;
528 GameListReq.len = GAME_HEADER_ONLY_SIZE;
530 packet_length = SerializeGamePacket(&GameListReq, packet_data);
531 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
534 void RequestGameListWithFilter(void *filter)
536 ubyte packet_data[sizeof(game_packet_header)];
537 int packet_length = 0;
539 memcpy(&GameListReq.data,filter,sizeof(filter_game_list_struct));
540 GameListReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
542 packet_length = SerializeGamePacket(&GameListReq, packet_data);
543 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
550 TrackerGameIsRunning = 0;
551 sendto(gamesock,(const char *)&GameOverPacket,GameOverPacket.len,0,(struct sockaddr *)>rackaddr,sizeof(struct sockaddr_in));
558 ubyte packet_data[sizeof(game_packet_header)];
559 int packet_length = 0;
561 if(SendingGameOver==2)
566 if(SendingGameOver==1)
568 //Wait until it's sent.
572 if(SendingGameOver==0)
574 LastGameOverPacket = timer_get_milliseconds();
575 FirstGameOverPacket = timer_get_milliseconds();
577 TrackerGameIsRunning = 0;
579 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
580 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
588 void AckPacket(int sig)
590 ubyte packet_data[sizeof(game_packet_header)];
591 int packet_length = 0;
593 TrackAckPacket.sig = sig;
595 packet_length = SerializeGamePacket(&TrackAckPacket, packet_data);
596 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
599 void StartTrackerGame(void *buffer)
608 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
616 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
624 TrackerGameIsRunning = 1;
625 LastTrackerUpdate = 0;
629 void RequestGameCountWithFilter(void *filter)
631 game_packet_header GameCountReq;
632 ubyte packet_data[sizeof(game_packet_header)];
633 int packet_length = 0;
636 GameCountReq.game_type = GT_FREESPACE;
638 GameCountReq.game_type = GT_FREESPACE2;
640 GameCountReq.type = GNT_GAME_COUNT_REQ;
641 GameCountReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
642 memcpy(&GameCountReq.data, ((filter_game_list_struct*)filter)->channel, CHANNEL_LEN);
644 packet_length = SerializeGamePacket(&GameCountReq, packet_data);
645 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)>rackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);