src/network/gtrack.cpp

   1 /*
   2  * Copyright (C) Volition, Inc. 2005.  All rights reserved.
   3  *
   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
   6  * source.
   7  *
   8 */
   9
  10
  11 //Game Tracker client code
  12 /*
  13
  14   InitGameTracker(int game_type); //D3 or Freespace
  15
  16   //Call periodically so we can send our update, and make sure it is received
  17   IdleGameTracker();
  18
  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);
  23
  24
  25   //Call to signify end of game
  26
  27   RequestGameList();//Sends a GNT_GAMELIST_REQ packet to the server.
  28
  29   game_list * GetGameList();//returns a pointer to a game_list struct
  30
  31 */
  32
  33
  34 #ifdef PLAT_UNIX
  35 #include <arpa/inet.h>
  36 #include <netinet/in.h>
  37 #include <errno.h>
  38 #include <netdb.h>
  39 #endif
  40
  41 #include "pstypes.h"
  42 #include "timer.h"
  43 #include "multi.h"
  44 #include "multi_pxo.h"
  45 #include "gtrack.h"
  46 #include "ptrack.h"
  47
  48
  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);
  54
  55 //Variables
  56 // SOCKET gamesock;
  57 struct sockaddr_in      gtrackaddr;
  58
  59 game_list GameBuffer[MAX_GAME_BUFFERS];
  60 int GameType;//d3 or fs
  61
  62 unsigned int LastTrackerUpdate;
  63 unsigned int LastSentToTracker;
  64 unsigned int TrackerAckdUs;
  65 unsigned int TrackerGameIsRunning;
  66
  67 game_packet_header TrackerGameData;
  68 game_packet_header GameListReq;
  69 game_packet_header TrackAckPacket;
  70 game_packet_header GameOverPacket;
  71
  72 #ifdef MAKE_FS1
  73 freespace_net_game_data         *FreeSpaceTrackerGameData;
  74 #else
  75 freespace2_net_game_data        *FreeSpace2TrackerGameData;
  76 #endif
  77
  78 //Start New 7-9-98
  79 unsigned int LastGameOverPacket;
  80 unsigned int FirstGameOverPacket;
  81
  82 int SendingGameOver;
  83 //End New 7-9-98
  84
  85
  86 static int SerializeGamePacket(const game_packet_header *gph, ubyte *data)
  87 {
  88         int packet_size = 0;
  89
  90         PXO_ADD_UINT(gph->len);
  91         PXO_ADD_DATA(gph->game_type);
  92         PXO_ADD_DATA(gph->junk); // not used, basically just padding for compatibility
  93         PXO_ADD_INT(gph->type);
  94         PXO_ADD_UINT(gph->sig);
  95
  96         switch (gph->type) {
  97                 // these have no other data
  98                 case GNT_CLIENT_ACK:
  99                 case GNT_GAMEOVER:
 100                         break;
 101
 102                 // this one may or may not have extra data
 103                 case GNT_GAMELIST_REQ: {
 104                         if (gph->len > GAME_HEADER_ONLY_SIZE) {
 105                                 SDL_assert(gph->len == (GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct)));
 106
 107                                 filter_game_list_struct *filter = (filter_game_list_struct *)&gph->data;
 108
 109                                 PXO_ADD_INT(filter->rank);
 110                                 PXO_ADD_DATA(filter->channel);
 111                         }
 112
 113                         break;
 114                 }
 115
 116                 case GNT_GAMEUPDATE: {
 117                         freespace2_net_game_data *game_data = (freespace2_net_game_data *)&gph->data;
 118
 119                         PXO_ADD_DATA(game_data->game_name);
 120                         PXO_ADD_INT(game_data->difficulty);
 121                         PXO_ADD_INT(game_data->type);
 122                         PXO_ADD_INT(game_data->state);
 123                         PXO_ADD_INT(game_data->max_players);
 124                         PXO_ADD_INT(game_data->current_num_players);
 125                         PXO_ADD_DATA(game_data->mission_name);
 126                         PXO_ADD_DATA(game_data->channel);
 127
 128                         break;
 129                 }
 130
 131                 case GNT_GAME_COUNT_REQ: {
 132                         char channel[CHANNEL_LEN];
 133
 134                         memcpy(channel, gph->data, sizeof(channel));
 135
 136                         PXO_ADD_DATA(channel);
 137
 138                         break;
 139                 }
 140
 141                 // we shouldn't be sending any other packet types
 142                 default:
 143                         Int3();
 144                         break;
 145         }
 146
 147         SDL_assert(packet_size >= (int)GAME_HEADER_ONLY_SIZE);
 148         SDL_assert(packet_size == (int)gph->len);
 149
 150         return packet_size;
 151 }
 152
 153 static void DeserializeGamePacket(const ubyte *data, const int data_size, game_packet_header *gph)
 154 {
 155         int offset = 0;
 156         int i;
 157
 158         memset(gph, 0, sizeof(game_packet_header));
 159
 160         // make sure we received a complete base packet
 161         if (data_size < (int)GAME_HEADER_ONLY_SIZE) {
 162                 gph->len = 0;
 163                 gph->type = -1;
 164
 165                 return;
 166         }
 167
 168         PXO_GET_UINT(gph->len);
 169         PXO_GET_DATA(gph->game_type);
 170         PXO_GET_DATA(gph->junk); // not used, basically just padding for compatibility
 171         PXO_GET_INT(gph->type);
 172         PXO_GET_UINT(gph->sig);
 173
 174         // sanity check data size to make sure we reveived all of the expected packet
 175         // (not exactly sure what -1 is for, but that's how it is later)
 176         if ((int)gph->len-1 > data_size) {
 177                 gph->len = 0;
 178                 gph->type = -1;
 179
 180                 return;
 181         }
 182
 183         switch (gph->type) {
 184                 case GNT_SERVER_ACK:
 185                         break;
 186
 187                 case GNT_GAMELIST_DATA: {
 188                         game_list *games = (game_list *)&gph->data;
 189
 190                         PXO_GET_DATA(games->game_type);
 191
 192                         for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
 193                                 PXO_GET_DATA(games->game_name[i]);
 194                         }
 195
 196                         for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
 197                                 PXO_GET_UINT(games->game_server[i]);
 198                         }
 199
 200                         for (i = 0; i < MAX_GAME_LISTS_PER_PACKET; i++) {
 201                                 PXO_GET_USHORT(games->port[i]);
 202                         }
 203
 204                         break;
 205                 }
 206
 207                 case GNT_GAME_COUNT_DATA: {
 208                         int n_users = 0;
 209                         char channel[512];
 210
 211                         PXO_GET_INT(n_users);
 212
 213                         SDL_strlcpy(channel, (char *)(data+offset), SDL_arraysize(channel));
 214                         offset += strlen(channel);
 215
 216                         memcpy(gph->data, &n_users, sizeof(int));
 217                         memcpy(gph->data+sizeof(int), channel, strlen(channel));
 218
 219                         break;
 220                 }
 221
 222                 default:
 223                         break;
 224         }
 225
 226         //SDL_assert(offset == data_size);
 227 }
 228
 229
 230 int InitGameTrackerClient(int gametype)
 231 {
 232         struct sockaddr_in sockaddr;
 233         in_addr_t iaddr;
 234
 235         GameType = gametype;
 236         LastTrackerUpdate = 0;
 237         switch(gametype)
 238         {
 239         case GT_FREESPACE:
 240 #ifndef MAKE_FS1
 241                 Int3();
 242                 return 0;
 243 #else
 244                 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace_net_game_data);
 245 #endif
 246                 break;
 247
 248         case GT_FREESPACE2:
 249 #ifdef MAKE_FS1
 250                 Int3();
 251                 return 0;
 252 #else
 253                 TrackerGameData.len = GAME_HEADER_ONLY_SIZE+sizeof(freespace2_net_game_data);
 254 #endif
 255                 break;
 256
 257         default:
 258                 Int3();
 259                 return 0;
 260         }
 261         TrackerGameData.game_type = (unsigned char)gametype;    //1==freespace (GT_FREESPACE), 2==D3, 3==tuberacer, etc.
 262         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.
 263
 264 #ifdef MAKE_FS1
 265         FreeSpaceTrackerGameData = (freespace_net_game_data *)&TrackerGameData.data;
 266 #else
 267         FreeSpace2TrackerGameData = (freespace2_net_game_data *)&TrackerGameData.data;
 268 #endif
 269
 270         GameListReq.game_type = (unsigned char)gametype;
 271         GameListReq.type = GNT_GAMELIST_REQ;
 272         GameListReq.len = GAME_HEADER_ONLY_SIZE;
 273
 274         TrackAckPacket.game_type = (unsigned char)gametype;
 275         TrackAckPacket.len = GAME_HEADER_ONLY_SIZE;
 276         TrackAckPacket.type = GNT_CLIENT_ACK;
 277
 278         GameOverPacket.game_type = (unsigned char)gametype;
 279         GameOverPacket.len = GAME_HEADER_ONLY_SIZE;
 280         GameOverPacket.type = GNT_GAMEOVER;
 281
 282         // gamesock = socket(AF_INET,SOCK_DGRAM,0);
 283
 284         /*
 285         if ( gamesock == INVALID_SOCKET )
 286         {
 287                 printf("Unable to open a socket.\n");
 288                 return 0;
 289         }
 290         */
 291
 292         memset( &sockaddr, 0, sizeof(struct sockaddr_in) );
 293         sockaddr.sin_family = AF_INET;
 294         sockaddr.sin_addr.s_addr = INADDR_ANY;
 295         sockaddr.sin_port = 0;//htons(GAMEPORT);
 296
 297         /*
 298         if (SOCKET_ERROR==bind(gamesock, (struct sockaddr*)&sockaddr, sizeof (sockaddr)))
 299         {
 300                 printf("Unable to bind a socket.\n");
 301                 printf("WSAGetLastError() returned %d.\n",WSAGetLastError());
 302                 return 0;
 303         }
 304         */
 305
 306         iaddr = inet_addr ( Multi_options_g.game_tracker_ip );
 307         if ( iaddr == INADDR_NONE ) {
 308                 // first try and resolve by name
 309                 struct hostent *he;
 310                 he = gethostbyname( Multi_options_g.game_tracker_ip );
 311                 if(!he)
 312                 {
 313                         return 0;
 314                         /*
 315                         // try and resolve by address
 316                         unsigned int n_order = inet_addr(Multi_game_tracker_ip_address);
 317                         he = gethostbyaddr((char*)&n_order,4,PF_INET);
 318
 319                         if(!he){
 320                                 return 0;
 321                         }
 322                         */
 323                 }
 324
 325                 iaddr = ((in_addr *)(he->h_addr))->s_addr;
 326         }
 327
 328         // This would be a good place to resolve the IP based on a domain name
 329         gtrackaddr.sin_addr.s_addr = iaddr;
 330         gtrackaddr.sin_family = AF_INET;
 331         gtrackaddr.sin_port = htons( GAMEPORT );
 332
 333         //Start New 7-9-98
 334         SendingGameOver = 0;
 335         //End New 7-9-98
 336
 337         return 1;
 338 }
 339
 340 void IdleGameTracker()
 341 {
 342         fd_set read_fds;
 343         struct timeval timeout;
 344         ubyte packet_data[sizeof(game_packet_header)];
 345         int packet_length = 0;
 346
 347         PSNET_TOP_LAYER_PROCESS();
 348
 349         timeout.tv_sec=0;
 350         timeout.tv_usec=0;
 351         if((TrackerGameIsRunning) && ((timer_get_seconds()-LastTrackerUpdate)>TRACKER_UPDATE_INTERVAL) && !SendingGameOver)
 352         {
 353                 //Time to update the tracker again
 354                 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
 355                 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 356                 TrackerAckdUs = 0;
 357                 LastTrackerUpdate = timer_get_seconds();
 358         }
 359         else if((TrackerGameIsRunning)&&(!TrackerAckdUs)&&((timer_get_milliseconds()-LastSentToTracker)>TRACKER_RESEND_TIME))
 360         {
 361                 //We still haven't been acked by the last packet and it's time to resend.
 362                 packet_length = SerializeGamePacket(&TrackerGameData, packet_data);
 363                 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 364                 TrackerAckdUs = 0;
 365                 LastTrackerUpdate = timer_get_seconds();
 366                 LastSentToTracker = timer_get_milliseconds();
 367         }
 368
 369         //Start New 7-9-98
 370         if(SendingGameOver){
 371                 if((timer_get_milliseconds()-LastGameOverPacket)>TRACKER_RESEND_TIME){
 372                         //resend
 373                         packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
 374                         LastGameOverPacket = timer_get_milliseconds();
 375                         SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 376                 }
 377                 /*
 378                 else if((timer_get_milliseconds()-FirstGameOverPacket)>NET_ACK_TIMEOUT) {
 379                         //Giving up, it timed out.
 380                         SendingGameOver = 2;
 381                 }
 382                 */
 383         }
 384         //End New 7-9-98
 385
 386         //Check for incoming
 387
 388         FD_ZERO(&read_fds);
 389         FD_SET(Unreliable_socket, &read_fds);
 390
 391 #ifndef PLAT_UNIX
 392         if(SELECT(0,&read_fds,NULL,NULL,&timeout, PSNET_TYPE_GAME_TRACKER))
 393 #else
 394         if(SELECT(Unreliable_socket+1,&read_fds,NULL,NULL,&timeout, PSNET_TYPE_GAME_TRACKER))
 395 #endif
 396         {
 397                 unsigned int bytesin;
 398                 int addrsize;
 399                 struct sockaddr_in fromaddr;
 400
 401                 game_packet_header inpacket;
 402                 addrsize = sizeof(struct sockaddr_in);
 403
 404                 bytesin = RECVFROM(Unreliable_socket, (char *)&packet_data, sizeof(game_packet_header), 0, (struct sockaddr *)&fromaddr, &addrsize, PSNET_TYPE_GAME_TRACKER);
 405                 DeserializeGamePacket(packet_data, bytesin, &inpacket);
 406                 if((int)bytesin==-1)
 407                 {
 408                         int wserr=WSAGetLastError();
 409                         mprintf(("RECVFROM() failure. WSAGetLastError() returned %d\n",wserr));
 410
 411                 }
 412
 413                 // subtract one from the header
 414                 inpacket.len--;
 415
 416                 //Check to make sure the packets ok
 417                 if(bytesin==inpacket.len)
 418                 {
 419                         switch(inpacket.type)
 420                         {
 421                         case GNT_SERVER_ACK:
 422                                 //The server got our packet so we can stop sending now
 423                                 TrackerAckdUs = 1;
 424
 425                                 // 7/13/98 -- because of the FreeSpace iterative frame process -- set this value to 0, instead
 426                                 // of to 2 (as it originally was) since we call SendGameOver() only once.  Once we get the ack
 427                                 // from the server, we can assume that we are done.
 428                                 // need to mark this as 0
 429                                 SendingGameOver = 0;
 430                                 break;
 431                         case GNT_GAMELIST_DATA:
 432                                 int i;
 433                                 //Woohoo! Game data! put it in the buffer (if one's free)
 434                                 for(i=0;i<MAX_GAME_BUFFERS;i++)
 435                                 {
 436                                         if(GameBuffer[i].game_type==GT_UNUSED)
 437                                         {
 438                                                 memcpy(&GameBuffer[i],&inpacket.data,sizeof(game_list));
 439                                                 i=MAX_GAME_BUFFERS+1;
 440                                         }
 441                                 }
 442                                 break;
 443
 444                         case GNT_GAME_COUNT_DATA:
 445                                 //Here, inpacket.data contains the following structure
 446                                 //struct {
 447                                 //      int numusers;
 448                                 //      char channel[];//Null terminated
 449                                 //      }
 450                                 //You can add whatever code, or callback, etc. you need to deal with this data
 451
 452                                 // let the PXO screen know about this data
 453                                 int num_servers;
 454                                 char channel[512];
 455
 456                                 // get the user count
 457                                 memcpy(&num_servers,inpacket.data,sizeof(int));
 458
 459                                 // copy the channel name
 460                                 SDL_strlcpy(channel, inpacket.data+sizeof(int), SDL_arraysize(channel));
 461
 462                                 // send it to the PXO screen
 463                                 multi_pxo_channel_count_update(channel,num_servers);
 464                                 break;
 465                         }
 466                         AckPacket(inpacket.sig);
 467                 }
 468         }
 469 }
 470
 471 void UpdateGameData(void *buffer)
 472 {
 473         SendingGameOver = 0;
 474
 475         switch(GameType){
 476         case GT_FREESPACE:
 477 #ifndef MAKE_FS1
 478                 Int3();
 479 #else
 480                 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
 481 #endif
 482                 break;
 483
 484         case GT_FREESPACE2:
 485 #ifdef MAKE_FS1
 486                 Int3();
 487 #else
 488                 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
 489 #endif
 490                 break;
 491
 492         default:
 493                 Int3();
 494                 break;
 495         }
 496 }
 497
 498 game_list * GetGameList()
 499 {
 500         static game_list gl;
 501         for(int i=0;i<MAX_GAME_BUFFERS;i++)
 502         {
 503                 if(GameBuffer[i].game_type!=GT_UNUSED)
 504                 {
 505                         memcpy(&gl,&GameBuffer[i],sizeof(game_list));
 506                         GameBuffer[i].game_type = GT_UNUSED;
 507                         return &gl;
 508                 }
 509         }
 510         return NULL;
 511 }
 512
 513 void RequestGameList()
 514 {
 515         ubyte packet_data[sizeof(game_packet_header)];
 516         int packet_length = 0;
 517
 518         GameListReq.len = GAME_HEADER_ONLY_SIZE;
 519
 520         packet_length = SerializeGamePacket(&GameListReq, packet_data);
 521         SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 522 }
 523
 524 void RequestGameListWithFilter(void *filter)
 525 {
 526         ubyte packet_data[sizeof(game_packet_header)];
 527         int packet_length = 0;
 528
 529         memcpy(&GameListReq.data,filter,sizeof(filter_game_list_struct));
 530         GameListReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
 531
 532         packet_length = SerializeGamePacket(&GameListReq, packet_data);
 533         SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 534 }
 535
 536
 537 /* REPLACED BELOW
 538 void SendGameOver()
 539 {
 540         TrackerGameIsRunning = 0;
 541         sendto(gamesock,(const char *)&GameOverPacket,GameOverPacket.len,0,(struct sockaddr *)&gtrackaddr,sizeof(struct sockaddr_in));
 542 }
 543 */
 544
 545 //Start New 7-9-98
 546 int SendGameOver()
 547 {
 548         ubyte packet_data[sizeof(game_packet_header)];
 549         int packet_length = 0;
 550
 551         if(SendingGameOver==2)
 552         {
 553                 SendingGameOver = 0;
 554                 return 1;
 555         }
 556         if(SendingGameOver==1)
 557         {
 558                 //Wait until it's sent.
 559                 IdleGameTracker();
 560                 return 0;
 561         }
 562         if(SendingGameOver==0)
 563         {
 564                 LastGameOverPacket = timer_get_milliseconds();
 565                 FirstGameOverPacket = timer_get_milliseconds();
 566                 SendingGameOver = 1;
 567                 TrackerGameIsRunning = 0;
 568
 569                 packet_length = SerializeGamePacket(&GameOverPacket, packet_data);
 570                 SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 571
 572                 return 0;
 573         }
 574         return 0;
 575 }
 576 //End New 7-9-98
 577
 578 void AckPacket(int sig)
 579 {
 580         ubyte packet_data[sizeof(game_packet_header)];
 581         int packet_length = 0;
 582
 583         TrackAckPacket.sig = sig;
 584
 585         packet_length = SerializeGamePacket(&TrackAckPacket, packet_data);
 586         SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 587 }
 588
 589 void StartTrackerGame(void *buffer)
 590 {
 591         SendingGameOver = 0;
 592
 593         switch(GameType){
 594         case GT_FREESPACE:
 595 #ifndef MAKE_FS1
 596                 Int3();
 597 #else
 598                 memcpy(FreeSpaceTrackerGameData,buffer,sizeof(freespace_net_game_data));
 599 #endif
 600                 break;
 601
 602         case GT_FREESPACE2:
 603 #ifdef MAKE_FS1
 604                 Int3();
 605 #else
 606                 memcpy(FreeSpace2TrackerGameData,buffer,sizeof(freespace2_net_game_data));
 607 #endif
 608                 break;
 609
 610         default:
 611                 Int3();
 612                 break;
 613         }
 614         TrackerGameIsRunning = 1;
 615         LastTrackerUpdate = 0;
 616 }
 617
 618 //A new function
 619 void RequestGameCountWithFilter(void *filter)
 620 {
 621         game_packet_header GameCountReq;
 622         ubyte packet_data[sizeof(game_packet_header)];
 623         int packet_length = 0;
 624
 625 #ifdef MAKE_FS1
 626         GameCountReq.game_type = GT_FREESPACE;
 627 #else
 628         GameCountReq.game_type = GT_FREESPACE2;
 629 #endif
 630         GameCountReq.type = GNT_GAME_COUNT_REQ;
 631         GameCountReq.len = GAME_HEADER_ONLY_SIZE+sizeof(filter_game_list_struct);
 632         memcpy(&GameCountReq.data, ((filter_game_list_struct*)filter)->channel, sizeof(filter_game_list_struct) - 4);
 633
 634         packet_length = SerializeGamePacket(&GameCountReq, packet_data);
 635         SENDTO(Unreliable_socket, (char *)&packet_data, packet_length, 0, (struct sockaddr *)&gtrackaddr, sizeof(struct sockaddr_in), PSNET_TYPE_GAME_TRACKER);
 636 }