network_client.cpp

Go to the documentation of this file.
00001 /* $Id: network_client.cpp 18809 2010-01-15 16:41:15Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #ifdef ENABLE_NETWORK
00013 
00014 #include "../stdafx.h"
00015 #include "../debug.h"
00016 #include "network_internal.h"
00017 #include "network_gui.h"
00018 #include "../saveload/saveload.h"
00019 #include "../command_func.h"
00020 #include "../console_func.h"
00021 #include "../fileio_func.h"
00022 #include "../3rdparty/md5/md5.h"
00023 #include "../strings_func.h"
00024 #include "../window_func.h"
00025 #include "../company_func.h"
00026 #include "../company_base.h"
00027 #include "../company_gui.h"
00028 #include "../rev.h"
00029 #include "network.h"
00030 #include "network_base.h"
00031 
00032 #include "table/strings.h"
00033 
00034 /* This file handles all the client-commands */
00035 
00036 
00037 /* So we don't make too much typos ;) */
00038 #define MY_CLIENT NetworkClientSocket::Get(0)
00039 
00040 static uint32 last_ack_frame;
00041 
00043 static uint32 _password_game_seed;
00045 static char _password_server_unique_id[NETWORK_UNIQUE_ID_LENGTH];
00046 
00048 static uint8 _network_server_max_companies;
00050 static uint8 _network_server_max_spectators;
00051 
00053 CompanyID _network_join_as;
00054 
00056 const char *_network_join_server_password = NULL;
00058 const char *_network_join_company_password = NULL;
00059 
00061 assert_compile(NETWORK_UNIQUE_ID_LENGTH == 16 * 2 + 1);
00062 
00068 static const char *GenerateCompanyPasswordHash(const char *password)
00069 {
00070   if (StrEmpty(password)) return password;
00071 
00072   char salted_password[NETWORK_UNIQUE_ID_LENGTH];
00073 
00074   memset(salted_password, 0, sizeof(salted_password));
00075   snprintf(salted_password, sizeof(salted_password), "%s", password);
00076   /* Add the game seed and the server's unique ID as the salt. */
00077   for (uint i = 0; i < NETWORK_UNIQUE_ID_LENGTH - 1; i++) salted_password[i] ^= _password_server_unique_id[i] ^ (_password_game_seed >> i);
00078 
00079   Md5 checksum;
00080   uint8 digest[16];
00081   static char hashed_password[NETWORK_UNIQUE_ID_LENGTH];
00082 
00083   /* Generate the MD5 hash */
00084   checksum.Append((const uint8*)salted_password, sizeof(salted_password) - 1);
00085   checksum.Finish(digest);
00086 
00087   for (int di = 0; di < 16; di++) sprintf(hashed_password + di * 2, "%02x", digest[di]);
00088   hashed_password[lengthof(hashed_password) - 1] = '\0';
00089 
00090   return hashed_password;
00091 }
00092 
00096 void HashCurrentCompanyPassword(const char *password)
00097 {
00098   _password_game_seed = _settings_game.game_creation.generation_seed;
00099   strecpy(_password_server_unique_id, _settings_client.network.network_id, lastof(_password_server_unique_id));
00100 
00101   const char *new_pw = GenerateCompanyPasswordHash(password);
00102   strecpy(_network_company_states[_local_company].password, new_pw, lastof(_network_company_states[_local_company].password));
00103 
00104   if (_network_server) {
00105     NetworkServerUpdateCompanyPassworded(_local_company, !StrEmpty(_network_company_states[_local_company].password));
00106   }
00107 }
00108 
00109 
00110 /***********
00111  * Sending functions
00112  *   DEF_CLIENT_SEND_COMMAND has no parameters
00113  ************/
00114 
00115 DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)
00116 {
00117   /*
00118    * Packet: CLIENT_COMPANY_INFO
00119    * Function: Request company-info (in detail)
00120    * Data:
00121    *    <none>
00122    */
00123   Packet *p;
00124   _network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;
00125   SetWindowDirty(WC_NETWORK_STATUS_WINDOW, 0);
00126 
00127   p = new Packet(PACKET_CLIENT_COMPANY_INFO);
00128   MY_CLIENT->Send_Packet(p);
00129 }
00130 
00131 DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)
00132 {
00133   /*
00134    * Packet: CLIENT_JOIN
00135    * Function: Try to join the server
00136    * Data:
00137    *    String: OpenTTD Revision (norev000 if no revision)
00138    *    String: Client Name (max NETWORK_NAME_LENGTH)
00139    *    uint8:  Play as Company id (1..MAX_COMPANIES)
00140    *    uint8:  Language ID
00141    *    String: Unique id to find the client back in server-listing
00142    */
00143 
00144   Packet *p;
00145   _network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;
00146   SetWindowDirty(WC_NETWORK_STATUS_WINDOW, 0);
00147 
00148   p = new Packet(PACKET_CLIENT_JOIN);
00149   p->Send_string(_openttd_revision);
00150   p->Send_string(_settings_client.network.client_name); // Client name
00151   p->Send_uint8 (_network_join_as);     // PlayAs
00152   p->Send_uint8 (NETLANG_ANY);          // Language
00153   p->Send_string(_settings_client.network.network_id);
00154   MY_CLIENT->Send_Packet(p);
00155 }
00156 
00157 DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)
00158 {
00159   /*
00160    * Packet: CLIENT_NEWGRFS_CHECKED
00161    * Function: Tell the server that we have the required GRFs
00162    * Data:
00163    */
00164 
00165   Packet *p = new Packet(PACKET_CLIENT_NEWGRFS_CHECKED);
00166   MY_CLIENT->Send_Packet(p);
00167 }
00168 
00169 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_PASSWORD)(NetworkPasswordType type, const char *password)
00170 {
00171   /*
00172    * Packet: CLIENT_PASSWORD
00173    * Function: Send a password to the server to authorize
00174    * Data:
00175    *    uint8:  NetworkPasswordType
00176    *    String: Password
00177    */
00178   Packet *p = new Packet(PACKET_CLIENT_PASSWORD);
00179   p->Send_uint8 (type);
00180   p->Send_string(type == NETWORK_GAME_PASSWORD ? password : GenerateCompanyPasswordHash(password));
00181   MY_CLIENT->Send_Packet(p);
00182 }
00183 
00184 DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)
00185 {
00186   /*
00187    * Packet: CLIENT_GETMAP
00188    * Function: Request the map from the server
00189    * Data:
00190    *    <none>
00191    */
00192 
00193   Packet *p = new Packet(PACKET_CLIENT_GETMAP);
00194   /* Send the OpenTTD version to the server, let it validate it too.
00195    * But only do it for stable releases because of those we are sure
00196    * that everybody has the same NewGRF version. For trunk and the
00197    * branches we make tarballs of the OpenTTDs compiled from tarball
00198    * will have the lower bits set to 0. As such they would become
00199    * incompatible, which we would like to prevent by this. */
00200   if (HasBit(_openttd_newgrf_version, 19)) p->Send_uint32(_openttd_newgrf_version);
00201   MY_CLIENT->Send_Packet(p);
00202 }
00203 
00204 DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)
00205 {
00206   /*
00207    * Packet: CLIENT_MAP_OK
00208    * Function: Tell the server that we are done receiving/loading the map
00209    * Data:
00210    *    <none>
00211    */
00212 
00213   Packet *p = new Packet(PACKET_CLIENT_MAP_OK);
00214   MY_CLIENT->Send_Packet(p);
00215 }
00216 
00217 DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)
00218 {
00219   /*
00220    * Packet: CLIENT_ACK
00221    * Function: Tell the server we are done with this frame
00222    * Data:
00223    *    uint32: current FrameCounter of the client
00224    */
00225 
00226   Packet *p = new Packet(PACKET_CLIENT_ACK);
00227 
00228   p->Send_uint32(_frame_counter);
00229   MY_CLIENT->Send_Packet(p);
00230 }
00231 
00232 /* Send a command packet to the server */
00233 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(const CommandPacket *cp)
00234 {
00235   /*
00236    * Packet: CLIENT_COMMAND
00237    * Function: Send a DoCommand to the Server
00238    * Data:
00239    *    uint8:  CompanyID (0..MAX_COMPANIES-1)
00240    *    uint32: CommandID (see command.h)
00241    *    uint32: P1 (free variables used in DoCommand)
00242    *    uint32: P2
00243    *    uint32: Tile
00244    *    string: text
00245    *    uint8:  CallBackID
00246    */
00247 
00248   Packet *p = new Packet(PACKET_CLIENT_COMMAND);
00249   MY_CLIENT->Send_Command(p, cp);
00250 
00251   MY_CLIENT->Send_Packet(p);
00252 }
00253 
00254 /* Send a chat-packet over the network */
00255 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_CHAT)(NetworkAction action, DestType type, int dest, const char *msg, int64 data)
00256 {
00257   /*
00258    * Packet: CLIENT_CHAT
00259    * Function: Send a chat-packet to the serve
00260    * Data:
00261    *    uint8:  ActionID (see network_data.h, NetworkAction)
00262    *    uint8:  Destination Type (see network_data.h, DestType);
00263    *    uint32: Destination CompanyID/Client-identifier
00264    *    String: Message (max NETWORK_CHAT_LENGTH)
00265    *    uint64: Some arbitrary number
00266    */
00267 
00268   Packet *p = new Packet(PACKET_CLIENT_CHAT);
00269 
00270   p->Send_uint8 (action);
00271   p->Send_uint8 (type);
00272   p->Send_uint32(dest);
00273   p->Send_string(msg);
00274   p->Send_uint64(data);
00275 
00276   MY_CLIENT->Send_Packet(p);
00277 }
00278 
00279 /* Send an error-packet over the network */
00280 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)
00281 {
00282   /*
00283    * Packet: CLIENT_ERROR
00284    * Function: The client made an error and is quiting the game
00285    * Data:
00286    *    uint8:  ErrorID (see network_data.h, NetworkErrorCode)
00287    */
00288   Packet *p = new Packet(PACKET_CLIENT_ERROR);
00289 
00290   p->Send_uint8(errorno);
00291   MY_CLIENT->Send_Packet(p);
00292 }
00293 
00294 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)
00295 {
00296   /*
00297    * Packet: PACKET_CLIENT_SET_PASSWORD
00298    * Function: Set the password for the clients current company
00299    * Data:
00300    *    String: Password
00301    */
00302   Packet *p = new Packet(PACKET_CLIENT_SET_PASSWORD);
00303 
00304   p->Send_string(GenerateCompanyPasswordHash(password));
00305   MY_CLIENT->Send_Packet(p);
00306 }
00307 
00308 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)
00309 {
00310   /*
00311    * Packet: PACKET_CLIENT_SET_NAME
00312    * Function: Gives the client a new name
00313    * Data:
00314    *    String: Name
00315    */
00316   Packet *p = new Packet(PACKET_CLIENT_SET_NAME);
00317 
00318   p->Send_string(name);
00319   MY_CLIENT->Send_Packet(p);
00320 }
00321 
00322 /* Send an quit-packet over the network */
00323 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)()
00324 {
00325   /*
00326    * Packet: CLIENT_QUIT
00327    * Function: The client is quiting the game
00328    * Data:
00329    */
00330   Packet *p = new Packet(PACKET_CLIENT_QUIT);
00331 
00332   MY_CLIENT->Send_Packet(p);
00333 }
00334 
00335 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_RCON)(const char *pass, const char *command)
00336 {
00337   Packet *p = new Packet(PACKET_CLIENT_RCON);
00338   p->Send_string(pass);
00339   p->Send_string(command);
00340   MY_CLIENT->Send_Packet(p);
00341 }
00342 
00343 DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_MOVE)(CompanyID company, const char *pass)
00344 {
00345   Packet *p = new Packet(PACKET_CLIENT_MOVE);
00346   p->Send_uint8(company);
00347   p->Send_string(GenerateCompanyPasswordHash(pass));
00348   MY_CLIENT->Send_Packet(p);
00349 }
00350 
00351 
00352 /***********
00353  * Receiving functions
00354  *   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p
00355  ************/
00356 
00357 extern bool SafeSaveOrLoad(const char *filename, int mode, GameMode newgm, Subdirectory subdir);
00358 extern StringID _switch_mode_errorstr;
00359 
00360 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)
00361 {
00362   /* We try to join a server which is full */
00363   _switch_mode_errorstr = STR_NETWORK_ERROR_SERVER_FULL;
00364   DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);
00365 
00366   return NETWORK_RECV_STATUS_SERVER_FULL;
00367 }
00368 
00369 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)
00370 {
00371   /* We try to join a server where we are banned */
00372   _switch_mode_errorstr = STR_NETWORK_ERROR_SERVER_BANNED;
00373   DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);
00374 
00375   return NETWORK_RECV_STATUS_SERVER_BANNED;
00376 }
00377 
00378 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)
00379 {
00380   byte company_info_version = p->Recv_uint8();
00381 
00382   if (!MY_CLIENT->HasClientQuit() && company_info_version == NETWORK_COMPANY_INFO_VERSION) {
00383     /* We have received all data... (there are no more packets coming) */
00384     if (!p->Recv_bool()) return NETWORK_RECV_STATUS_CLOSE_QUERY;
00385 
00386     CompanyID current = (Owner)p->Recv_uint8();
00387     if (current >= MAX_COMPANIES) return NETWORK_RECV_STATUS_CLOSE_QUERY;
00388 
00389     NetworkCompanyInfo *company_info = GetLobbyCompanyInfo(current);
00390     if (company_info == NULL) return NETWORK_RECV_STATUS_CLOSE_QUERY;
00391 
00392     p->Recv_string(company_info->company_name, sizeof(company_info->company_name));
00393     company_info->inaugurated_year = p->Recv_uint32();
00394     company_info->company_value    = p->Recv_uint64();
00395     company_info->money            = p->Recv_uint64();
00396     company_info->income           = p->Recv_uint64();
00397     company_info->performance      = p->Recv_uint16();
00398     company_info->use_password     = p->Recv_bool();
00399     for (int i = 0; i < NETWORK_VEHICLE_TYPES; i++)
00400       company_info->num_vehicle[i] = p->Recv_uint16();
00401     for (int i = 0; i < NETWORK_STATION_TYPES; i++)
00402       company_info->num_station[i] = p->Recv_uint16();
00403     company_info->ai               = p->Recv_bool();
00404 
00405     p->Recv_string(company_info->clients, sizeof(company_info->clients));
00406 
00407     SetWindowDirty(WC_NETWORK_WINDOW, 0);
00408 
00409     return NETWORK_RECV_STATUS_OKAY;
00410   }
00411 
00412   return NETWORK_RECV_STATUS_CLOSE_QUERY;
00413 }
00414 
00415 /* This packet contains info about the client (playas and name)
00416  *  as client we save this in NetworkClientInfo, linked via 'client_id'
00417  *  which is always an unique number on a server. */
00418 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)
00419 {
00420   NetworkClientInfo *ci;
00421   ClientID client_id = (ClientID)p->Recv_uint32();
00422   CompanyID playas = (CompanyID)p->Recv_uint8();
00423   char name[NETWORK_NAME_LENGTH];
00424 
00425   p->Recv_string(name, sizeof(name));
00426 
00427   if (MY_CLIENT->HasClientQuit()) return NETWORK_RECV_STATUS_CONN_LOST;
00428 
00429   ci = NetworkFindClientInfoFromClientID(client_id);
00430   if (ci != NULL) {
00431     if (playas == ci->client_playas && strcmp(name, ci->client_name) != 0) {
00432       /* Client name changed, display the change */
00433       NetworkTextMessage(NETWORK_ACTION_NAME_CHANGE, CC_DEFAULT, false, ci->client_name, name);
00434     } else if (playas != ci->client_playas) {
00435       /* The client changed from client-player..
00436        * Do not display that for now */
00437     }
00438 
00439     ci->client_playas = playas;
00440     strecpy(ci->client_name, name, lastof(ci->client_name));
00441 
00442     SetWindowDirty(WC_CLIENT_LIST, 0);
00443 
00444     return NETWORK_RECV_STATUS_OKAY;
00445   }
00446 
00447   /* We don't have this client_id yet, find an empty client_id, and put the data there */
00448   ci = new NetworkClientInfo(client_id);
00449   ci->client_playas = playas;
00450   if (client_id == _network_own_client_id) MY_CLIENT->SetInfo(ci);
00451 
00452   strecpy(ci->client_name, name, lastof(ci->client_name));
00453 
00454   SetWindowDirty(WC_CLIENT_LIST, 0);
00455 
00456   return NETWORK_RECV_STATUS_OKAY;
00457 }
00458 
00459 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)
00460 {
00461   NetworkErrorCode error = (NetworkErrorCode)p->Recv_uint8();
00462 
00463   switch (error) {
00464     /* We made an error in the protocol, and our connection is closed.... */
00465     case NETWORK_ERROR_NOT_AUTHORIZED:
00466     case NETWORK_ERROR_NOT_EXPECTED:
00467     case NETWORK_ERROR_COMPANY_MISMATCH:
00468       _switch_mode_errorstr = STR_NETWORK_ERROR_SERVER_ERROR;
00469       break;
00470     case NETWORK_ERROR_FULL:
00471       _switch_mode_errorstr = STR_NETWORK_ERROR_SERVER_FULL;
00472       break;
00473     case NETWORK_ERROR_WRONG_REVISION:
00474       _switch_mode_errorstr = STR_NETWORK_ERROR_WRONG_REVISION;
00475       break;
00476     case NETWORK_ERROR_WRONG_PASSWORD:
00477       _switch_mode_errorstr = STR_NETWORK_ERROR_WRONG_PASSWORD;
00478       break;
00479     case NETWORK_ERROR_KICKED:
00480       _switch_mode_errorstr = STR_NETWORK_ERROR_KICKED;
00481       break;
00482     case NETWORK_ERROR_CHEATER:
00483       _switch_mode_errorstr = STR_NETWORK_ERROR_CHEATER;
00484       break;
00485     default:
00486       _switch_mode_errorstr = STR_NETWORK_ERROR_LOSTCONNECTION;
00487   }
00488 
00489   DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);
00490 
00491   return NETWORK_RECV_STATUS_SERVER_ERROR;
00492 }
00493 
00494 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)
00495 {
00496   uint grf_count = p->Recv_uint8();
00497   NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;
00498 
00499   /* Check all GRFs */
00500   for (; grf_count > 0; grf_count--) {
00501     GRFConfig c;
00502     MY_CLIENT->Recv_GRFIdentifier(p, &c);
00503 
00504     /* Check whether we know this GRF */
00505     const GRFConfig *f = FindGRFConfig(c.grfid, c.md5sum);
00506     if (f == NULL) {
00507       /* We do not know this GRF, bail out of initialization */
00508       char buf[sizeof(c.md5sum) * 2 + 1];
00509       md5sumToString(buf, lastof(buf), c.md5sum);
00510       DEBUG(grf, 0, "NewGRF %08X not found; checksum %s", BSWAP32(c.grfid), buf);
00511       ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;
00512     }
00513   }
00514 
00515   if (ret == NETWORK_RECV_STATUS_OKAY) {
00516     /* Start receiving the map */
00517     SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();
00518   } else {
00519     /* NewGRF mismatch, bail out */
00520     _switch_mode_errorstr = STR_NETWORK_ERROR_NEWGRF_MISMATCH;
00521   }
00522   return ret;
00523 }
00524 
00525 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)
00526 {
00527   NetworkPasswordType type = (NetworkPasswordType)p->Recv_uint8();
00528 
00529   const char *password = _network_join_server_password;
00530 
00531   switch (type) {
00532     case NETWORK_COMPANY_PASSWORD:
00533       /* Initialize the password hash salting variables. */
00534       _password_game_seed = p->Recv_uint32();
00535       p->Recv_string(_password_server_unique_id, sizeof(_password_server_unique_id));
00536       if (MY_CLIENT->HasClientQuit()) return NETWORK_RECV_STATUS_MALFORMED_PACKET;
00537       password = _network_join_company_password;
00538       /* FALL THROUGH */
00539     case NETWORK_GAME_PASSWORD:
00540       if (StrEmpty(password)) {
00541         ShowNetworkNeedPassword(type);
00542       } else {
00543         SEND_COMMAND(PACKET_CLIENT_PASSWORD)(type, password);
00544       }
00545       return NETWORK_RECV_STATUS_OKAY;
00546 
00547     default: return NETWORK_RECV_STATUS_MALFORMED_PACKET;
00548   }
00549 }
00550 
00551 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)
00552 {
00553   _network_own_client_id = (ClientID)p->Recv_uint32();
00554 
00555   /* Initialize the password hash salting variables, even if they were previously. */
00556   _password_game_seed = p->Recv_uint32();
00557   p->Recv_string(_password_server_unique_id, sizeof(_password_server_unique_id));
00558 
00559   /* Start receiving the map */
00560   SEND_COMMAND(PACKET_CLIENT_GETMAP)();
00561   return NETWORK_RECV_STATUS_OKAY;
00562 }
00563 
00564 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)
00565 {
00566   _network_join_status = NETWORK_JOIN_STATUS_WAITING;
00567   _network_join_waiting = p->Recv_uint8();
00568   SetWindowDirty(WC_NETWORK_STATUS_WINDOW, 0);
00569 
00570   /* We are put on hold for receiving the map.. we need GUI for this ;) */
00571   DEBUG(net, 1, "The server is currently busy sending the map to someone else, please wait..." );
00572   DEBUG(net, 1, "There are %d clients in front of you", _network_join_waiting);
00573 
00574   return NETWORK_RECV_STATUS_OKAY;
00575 }
00576 
00577 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)
00578 {
00579   static FILE *file_pointer;
00580 
00581   byte maptype;
00582 
00583   maptype = p->Recv_uint8();
00584 
00585   if (MY_CLIENT->HasClientQuit()) return NETWORK_RECV_STATUS_CONN_LOST;
00586 
00587   /* First packet, init some stuff */
00588   if (maptype == MAP_PACKET_START) {
00589     file_pointer = FioFOpenFile("network_client.tmp", "wb", AUTOSAVE_DIR);;
00590     if (file_pointer == NULL) {
00591       _switch_mode_errorstr = STR_NETWORK_ERROR_SAVEGAMEERROR;
00592       return NETWORK_RECV_STATUS_SAVEGAME;
00593     }
00594 
00595     _frame_counter = _frame_counter_server = _frame_counter_max = p->Recv_uint32();
00596 
00597     _network_join_bytes = 0;
00598     _network_join_bytes_total = p->Recv_uint32();
00599 
00600     /* If the network connection has been closed due to loss of connection
00601      * or when _network_join_kbytes_total is 0, the join status window will
00602      * do a division by zero. When the connection is lost, we just return
00603      * that. If kbytes_total is 0, the packet must be malformed as a
00604      * savegame less than 1 kilobyte is practically impossible. */
00605     if (MY_CLIENT->HasClientQuit()) return NETWORK_RECV_STATUS_CONN_LOST;
00606     if (_network_join_bytes_total == 0) return NETWORK_RECV_STATUS_MALFORMED_PACKET;
00607 
00608     _network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;
00609     SetWindowDirty(WC_NETWORK_STATUS_WINDOW, 0);
00610 
00611     /* The first packet does not contain any more data */
00612     return NETWORK_RECV_STATUS_OKAY;
00613   }
00614 
00615   if (maptype == MAP_PACKET_NORMAL) {
00616     /* We are still receiving data, put it to the file */
00617     if (fwrite(p->buffer + p->pos, 1, p->size - p->pos, file_pointer) != (size_t)(p->size - p->pos)) {
00618       _switch_mode_errorstr = STR_NETWORK_ERROR_SAVEGAMEERROR;
00619       return NETWORK_RECV_STATUS_SAVEGAME;
00620     }
00621 
00622     _network_join_bytes = ftell(file_pointer);
00623     SetWindowDirty(WC_NETWORK_STATUS_WINDOW, 0);
00624   }
00625 
00626   /* Check if this was the last packet */
00627   if (maptype == MAP_PACKET_END) {
00628     fclose(file_pointer);
00629 
00630     _network_join_status = NETWORK_JOIN_STATUS_PROCESSING;
00631     SetWindowDirty(WC_NETWORK_STATUS_WINDOW, 0);
00632 
00633     /* The map is done downloading, load it */
00634     if (!SafeSaveOrLoad("network_client.tmp", SL_LOAD, GM_NORMAL, AUTOSAVE_DIR)) {
00635       DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);
00636       _switch_mode_errorstr = STR_NETWORK_ERROR_SAVEGAMEERROR;
00637       return NETWORK_RECV_STATUS_SAVEGAME;
00638     }
00639     /* If the savegame has successfully loaded, ALL windows have been removed,
00640      * only toolbar/statusbar and gamefield are visible */
00641 
00642     /* Say we received the map and loaded it correctly! */
00643     SEND_COMMAND(PACKET_CLIENT_MAP_OK)();
00644 
00645     /* New company/spectator (invalid company) or company we want to join is not active
00646      * Switch local company to spectator and await the server's judgement */
00647     if (_network_join_as == COMPANY_NEW_COMPANY || !Company::IsValidID(_network_join_as)) {
00648       SetLocalCompany(COMPANY_SPECTATOR);
00649 
00650       if (_network_join_as != COMPANY_SPECTATOR) {
00651         /* We have arrived and ready to start playing; send a command to make a new company;
00652          * the server will give us a client-id and let us in */
00653         _network_join_status = NETWORK_JOIN_STATUS_REGISTERING;
00654         ShowJoinStatusWindow();
00655         NetworkSend_Command(0, 0, 0, CMD_COMPANY_CTRL, NULL, NULL, _local_company);
00656       }
00657     } else {
00658       /* take control over an existing company */
00659       SetLocalCompany(_network_join_as);
00660     }
00661   }
00662 
00663   return NETWORK_RECV_STATUS_OKAY;
00664 }
00665 
00666 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FRAME)
00667 {
00668   _frame_counter_server = p->Recv_uint32();
00669   _frame_counter_max = p->Recv_uint32();
00670 #ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME
00671   /* Test if the server supports this option
00672    *  and if we are at the frame the server is */
00673   if (p->pos < p->size) {
00674     _sync_frame = _frame_counter_server;
00675     _sync_seed_1 = p->Recv_uint32();
00676 #ifdef NETWORK_SEND_DOUBLE_SEED
00677     _sync_seed_2 = p->Recv_uint32();
00678 #endif
00679   }
00680 #endif
00681   DEBUG(net, 5, "Received FRAME %d", _frame_counter_server);
00682 
00683   /* Let the server know that we received this frame correctly
00684    *  We do this only once per day, to save some bandwidth ;) */
00685   if (!_network_first_time && last_ack_frame < _frame_counter) {
00686     last_ack_frame = _frame_counter + DAY_TICKS;
00687     DEBUG(net, 4, "Sent ACK at %d", _frame_counter);
00688     SEND_COMMAND(PACKET_CLIENT_ACK)();
00689   }
00690 
00691   return NETWORK_RECV_STATUS_OKAY;
00692 }
00693 
00694 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_SYNC)
00695 {
00696   _sync_frame = p->Recv_uint32();
00697   _sync_seed_1 = p->Recv_uint32();
00698 #ifdef NETWORK_SEND_DOUBLE_SEED
00699   _sync_seed_2 = p->Recv_uint32();
00700 #endif
00701 
00702   return NETWORK_RECV_STATUS_OKAY;
00703 }
00704 
00705 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMMAND)
00706 {
00707   CommandPacket cp;
00708   const char *err = MY_CLIENT->Recv_Command(p, &cp);
00709   cp.frame    = p->Recv_uint32();
00710   cp.my_cmd   = p->Recv_bool();
00711   cp.next     = NULL;
00712 
00713   if (err != NULL) {
00714     IConsolePrintF(CC_ERROR, "WARNING: %s from server, dropping...", err);
00715     return NETWORK_RECV_STATUS_MALFORMED_PACKET;
00716   }
00717 
00718   /* The server did send us this command..
00719    *  queue it in our own queue, so we can handle it in the upcoming frame! */
00720   NetworkAddCommandQueue(cp);
00721 
00722   return NETWORK_RECV_STATUS_OKAY;
00723 }
00724 
00725 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHAT)
00726 {
00727   char name[NETWORK_NAME_LENGTH], msg[NETWORK_CHAT_LENGTH];
00728   const NetworkClientInfo *ci = NULL, *ci_to;
00729 
00730   NetworkAction action = (NetworkAction)p->Recv_uint8();
00731   ClientID client_id = (ClientID)p->Recv_uint32();
00732   bool self_send = p->Recv_bool();
00733   p->Recv_string(msg, NETWORK_CHAT_LENGTH);
00734   int64 data = p->Recv_uint64();
00735 
00736   ci_to = NetworkFindClientInfoFromClientID(client_id);
00737   if (ci_to == NULL) return NETWORK_RECV_STATUS_OKAY;
00738 
00739   /* Did we initiate the action locally? */
00740   if (self_send) {
00741     switch (action) {
00742       case NETWORK_ACTION_CHAT_CLIENT:
00743         /* For speaking to client we need the client-name */
00744         snprintf(name, sizeof(name), "%s", ci_to->client_name);
00745         ci = NetworkFindClientInfoFromClientID(_network_own_client_id);
00746         break;
00747 
00748       /* For speaking to company or giving money, we need the company-name */
00749       case NETWORK_ACTION_GIVE_MONEY:
00750         if (!Company::IsValidID(ci_to->client_playas)) return NETWORK_RECV_STATUS_OKAY;
00751         /* fallthrough */
00752       case NETWORK_ACTION_CHAT_COMPANY: {
00753         StringID str = Company::IsValidID(ci_to->client_playas) ? STR_COMPANY_NAME : STR_NETWORK_SPECTATORS;
00754         SetDParam(0, ci_to->client_playas);
00755 
00756         GetString(name, str, lastof(name));
00757         ci = NetworkFindClientInfoFromClientID(_network_own_client_id);
00758       } break;
00759 
00760       default: return NETWORK_RECV_STATUS_MALFORMED_PACKET;
00761     }
00762   } else {
00763     /* Display message from somebody else */
00764     snprintf(name, sizeof(name), "%s", ci_to->client_name);
00765     ci = ci_to;
00766   }
00767 
00768   if (ci != NULL)
00769     NetworkTextMessage(action, (ConsoleColour)GetDrawStringCompanyColour(ci->client_playas), self_send, name, msg, data);
00770   return NETWORK_RECV_STATUS_OKAY;
00771 }
00772 
00773 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR_QUIT)
00774 {
00775   ClientID client_id = (ClientID)p->Recv_uint32();
00776 
00777   NetworkClientInfo *ci = NetworkFindClientInfoFromClientID(client_id);
00778   if (ci != NULL) {
00779     NetworkTextMessage(NETWORK_ACTION_LEAVE, CC_DEFAULT, false, ci->client_name, NULL, GetNetworkErrorMsg((NetworkErrorCode)p->Recv_uint8()));
00780     delete ci;
00781   }
00782 
00783   SetWindowDirty(WC_CLIENT_LIST, 0);
00784 
00785   return NETWORK_RECV_STATUS_OKAY;
00786 }
00787 
00788 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_QUIT)
00789 {
00790   NetworkClientInfo *ci;
00791 
00792   ClientID client_id = (ClientID)p->Recv_uint32();
00793 
00794   ci = NetworkFindClientInfoFromClientID(client_id);
00795   if (ci != NULL) {
00796     NetworkTextMessage(NETWORK_ACTION_LEAVE, CC_DEFAULT, false, ci->client_name, NULL, STR_NETWORK_MESSAGE_CLIENT_LEAVING);
00797     delete ci;
00798   } else {
00799     DEBUG(net, 0, "Unknown client (%d) is leaving the game", client_id);
00800   }
00801 
00802   SetWindowDirty(WC_CLIENT_LIST, 0);
00803 
00804   /* If we come here it means we could not locate the client.. strange :s */
00805   return NETWORK_RECV_STATUS_OKAY;
00806 }
00807 
00808 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_JOIN)
00809 {
00810   ClientID client_id = (ClientID)p->Recv_uint32();
00811 
00812   NetworkClientInfo *ci = NetworkFindClientInfoFromClientID(client_id);
00813   if (ci != NULL)
00814     NetworkTextMessage(NETWORK_ACTION_JOIN, CC_DEFAULT, false, ci->client_name);
00815 
00816   SetWindowDirty(WC_CLIENT_LIST, 0);
00817 
00818   return NETWORK_RECV_STATUS_OKAY;
00819 }
00820 
00821 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_SHUTDOWN)
00822 {
00823   _switch_mode_errorstr = STR_NETWORK_MESSAGE_SERVER_SHUTDOWN;
00824 
00825   return NETWORK_RECV_STATUS_SERVER_ERROR;
00826 }
00827 
00828 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEWGAME)
00829 {
00830   /* To trottle the reconnects a bit, every clients waits
00831    *  his _local_company value before reconnecting
00832    * COMPANY_SPECTATOR is currently 255, so to avoid long wait periods
00833    *  set the max to 10. */
00834   _network_reconnect = min(_local_company + 1, 10);
00835   _switch_mode_errorstr = STR_NETWORK_MESSAGE_SERVER_REBOOT;
00836 
00837   return NETWORK_RECV_STATUS_SERVER_ERROR;
00838 }
00839 
00840 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_RCON)
00841 {
00842   char rcon_out[NETWORK_RCONCOMMAND_LENGTH];
00843 
00844   ConsoleColour colour_code = (ConsoleColour)p->Recv_uint16();
00845   p->Recv_string(rcon_out, sizeof(rcon_out));
00846 
00847   IConsolePrint(colour_code, rcon_out);
00848 
00849   return NETWORK_RECV_STATUS_OKAY;
00850 }
00851 
00852 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MOVE)
00853 {
00854   /* Nothing more in this packet... */
00855   ClientID client_id   = (ClientID)p->Recv_uint32();
00856   CompanyID company_id = (CompanyID)p->Recv_uint8();
00857 
00858   if (client_id == 0) {
00859     /* definitely an invalid client id, debug message and do nothing. */
00860     DEBUG(net, 0, "[move] received invalid client index = 0");
00861     return NETWORK_RECV_STATUS_MALFORMED_PACKET;
00862   }
00863 
00864   const NetworkClientInfo *ci = NetworkFindClientInfoFromClientID(client_id);
00865   /* Just make sure we do not try to use a client_index that does not exist */
00866   if (ci == NULL) return NETWORK_RECV_STATUS_OKAY;
00867 
00868   /* if not valid player, force spectator, else check player exists */
00869   if (!Company::IsValidID(company_id)) company_id = COMPANY_SPECTATOR;
00870 
00871   if (client_id == _network_own_client_id) {
00872     SetLocalCompany(company_id);
00873   }
00874 
00875   return NETWORK_RECV_STATUS_OKAY;
00876 }
00877 
00878 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CONFIG_UPDATE)
00879 {
00880   _network_server_max_companies = p->Recv_uint8();
00881   _network_server_max_spectators = p->Recv_uint8();
00882 
00883   return NETWORK_RECV_STATUS_OKAY;
00884 }
00885 
00886 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_UPDATE)
00887 {
00888   _network_company_passworded = p->Recv_uint16();
00889   SetWindowClassesDirty(WC_COMPANY);
00890 
00891   return NETWORK_RECV_STATUS_OKAY;
00892 }
00893 
00894 
00895 /* The layout for the receive-functions by the client */
00896 typedef NetworkRecvStatus NetworkClientPacket(Packet *p);
00897 
00898 /* This array matches PacketType. At an incoming
00899  *  packet it is matches against this array
00900  *  and that way the right function to handle that
00901  *  packet is found. */
00902 static NetworkClientPacket * const _network_client_packet[] = {
00903   RECEIVE_COMMAND(PACKET_SERVER_FULL),
00904   RECEIVE_COMMAND(PACKET_SERVER_BANNED),
00905   NULL, // PACKET_CLIENT_JOIN,
00906   RECEIVE_COMMAND(PACKET_SERVER_ERROR),
00907   NULL, // PACKET_CLIENT_COMPANY_INFO,
00908   RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO),
00909   RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO),
00910   RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD),
00911   NULL, // PACKET_CLIENT_PASSWORD,
00912   RECEIVE_COMMAND(PACKET_SERVER_WELCOME),
00913   NULL, // PACKET_CLIENT_GETMAP,
00914   RECEIVE_COMMAND(PACKET_SERVER_WAIT),
00915   RECEIVE_COMMAND(PACKET_SERVER_MAP),
00916   NULL, // PACKET_CLIENT_MAP_OK,
00917   RECEIVE_COMMAND(PACKET_SERVER_JOIN),
00918   RECEIVE_COMMAND(PACKET_SERVER_FRAME),
00919   RECEIVE_COMMAND(PACKET_SERVER_SYNC),
00920   NULL, // PACKET_CLIENT_ACK,
00921   NULL, // PACKET_CLIENT_COMMAND,
00922   RECEIVE_COMMAND(PACKET_SERVER_COMMAND),
00923   NULL, // PACKET_CLIENT_CHAT,
00924   RECEIVE_COMMAND(PACKET_SERVER_CHAT),
00925   NULL, // PACKET_CLIENT_SET_PASSWORD,
00926   NULL, // PACKET_CLIENT_SET_NAME,
00927   NULL, // PACKET_CLIENT_QUIT,
00928   NULL, // PACKET_CLIENT_ERROR,
00929   RECEIVE_COMMAND(PACKET_SERVER_QUIT),
00930   RECEIVE_COMMAND(PACKET_SERVER_ERROR_QUIT),
00931   RECEIVE_COMMAND(PACKET_SERVER_SHUTDOWN),
00932   RECEIVE_COMMAND(PACKET_SERVER_NEWGAME),
00933   RECEIVE_COMMAND(PACKET_SERVER_RCON),
00934   NULL, // PACKET_CLIENT_RCON,
00935   RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS),
00936   NULL, // PACKET_CLIENT_NEWGRFS_CHECKED,
00937   RECEIVE_COMMAND(PACKET_SERVER_MOVE),
00938   NULL, // PACKET_CLIENT_MOVE
00939   RECEIVE_COMMAND(PACKET_SERVER_COMPANY_UPDATE),
00940   RECEIVE_COMMAND(PACKET_SERVER_CONFIG_UPDATE),
00941 };
00942 
00943 /* If this fails, check the array above with network_data.h */
00944 assert_compile(lengthof(_network_client_packet) == PACKET_END);
00945 
00946 /* Is called after a client is connected to the server */
00947 void NetworkClient_Connected()
00948 {
00949   /* Set the frame-counter to 0 so nothing happens till we are ready */
00950   _frame_counter = 0;
00951   _frame_counter_server = 0;
00952   last_ack_frame = 0;
00953   /* Request the game-info */
00954   SEND_COMMAND(PACKET_CLIENT_JOIN)();
00955 }
00956 
00957 /* Reads the packets from the socket-stream, if available */
00958 NetworkRecvStatus NetworkClient_ReadPackets(NetworkClientSocket *cs)
00959 {
00960   Packet *p;
00961   NetworkRecvStatus res = NETWORK_RECV_STATUS_OKAY;
00962 
00963   while (res == NETWORK_RECV_STATUS_OKAY && (p = cs->Recv_Packet()) != NULL) {
00964     byte type = p->Recv_uint8();
00965     if (type < PACKET_END && _network_client_packet[type] != NULL && !MY_CLIENT->HasClientQuit()) {
00966       res = _network_client_packet[type](p);
00967     } else {
00968       res = NETWORK_RECV_STATUS_MALFORMED_PACKET;
00969       DEBUG(net, 0, "[client] received invalid packet type %d", type);
00970     }
00971 
00972     delete p;
00973   }
00974 
00975   return res;
00976 }
00977 
00978 void NetworkClientSendRcon(const char *password, const char *command)
00979 {
00980   SEND_COMMAND(PACKET_CLIENT_RCON)(password, command);
00981 }
00982 
00989 void NetworkClientRequestMove(CompanyID company_id, const char *pass)
00990 {
00991   SEND_COMMAND(PACKET_CLIENT_MOVE)(company_id, pass);
00992 }
00993 
00994 void NetworkUpdateClientName()
00995 {
00996   NetworkClientInfo *ci = NetworkFindClientInfoFromClientID(_network_own_client_id);
00997 
00998   if (ci == NULL) return;
00999 
01000   /* Don't change the name if it is the same as the old name */
01001   if (strcmp(ci->client_name, _settings_client.network.client_name) != 0) {
01002     if (!_network_server) {
01003       SEND_COMMAND(PACKET_CLIENT_SET_NAME)(_settings_client.network.client_name);
01004     } else {
01005       if (NetworkFindName(_settings_client.network.client_name)) {
01006         NetworkTextMessage(NETWORK_ACTION_NAME_CHANGE, CC_DEFAULT, false, ci->client_name, _settings_client.network.client_name);
01007         strecpy(ci->client_name, _settings_client.network.client_name, lastof(ci->client_name));
01008         NetworkUpdateClientInfo(CLIENT_ID_SERVER);
01009       }
01010     }
01011   }
01012 }
01013 
01014 void NetworkClientSendChat(NetworkAction action, DestType type, int dest, const char *msg, int64 data)
01015 {
01016   SEND_COMMAND(PACKET_CLIENT_CHAT)(action, type, dest, msg, data);
01017 }
01018 
01019 void NetworkClientSetPassword(const char *password)
01020 {
01021   SEND_COMMAND(PACKET_CLIENT_SET_PASSWORD)(password);
01022 }
01023 
01029 bool NetworkClientPreferTeamChat(const NetworkClientInfo *cio)
01030 {
01031   /* Only companies actually playing can speak to team. Eg spectators cannot */
01032   if (!_settings_client.gui.prefer_teamchat || !Company::IsValidID(cio->client_playas)) return false;
01033 
01034   const NetworkClientInfo *ci;
01035   FOR_ALL_CLIENT_INFOS(ci) {
01036     if (ci->client_playas == cio->client_playas && ci != cio) return true;
01037   }
01038 
01039   return false;
01040 }
01041 
01046 bool NetworkMaxCompaniesReached()
01047 {
01048   return Company::GetNumItems() >= (_network_server ? _settings_client.network.max_companies : _network_server_max_companies);
01049 }
01050 
01055 bool NetworkMaxSpectatorsReached()
01056 {
01057   return NetworkSpectatorCount() >= (_network_server ? _settings_client.network.max_spectators : _network_server_max_spectators);
01058 }
01059 
01063 void NetworkPrintClients()
01064 {
01065   NetworkClientInfo *ci;
01066   FOR_ALL_CLIENT_INFOS(ci) {
01067     IConsolePrintF(CC_INFO, "Client #%1d  name: '%s'  company: %1d  IP: %s",
01068         ci->client_id,
01069         ci->client_name,
01070         ci->client_playas + (Company::IsValidID(ci->client_playas) ? 1 : 0),
01071         GetClientIP(ci));
01072   }
01073 }
01074 
01075 #endif /* ENABLE_NETWORK */

Generated on Wed Jan 20 23:38:36 2010 for OpenTTD by  doxygen 1.5.6