|
|
|
/*
|
|
|
|
* This file is part of OpenTTD.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @file game_info.cpp Functions to convert NetworkGameInfo to Packet and back.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "../../stdafx.h"
|
|
|
|
#include "network_game_info.h"
|
|
|
|
#include "../../core/bitmath_func.hpp"
|
|
|
|
#include "../../company_base.h"
|
|
|
|
#include "../../date_func.h"
|
|
|
|
#include "../../debug.h"
|
|
|
|
#include "../../map_func.h"
|
|
|
|
#include "../../game/game.hpp"
|
|
|
|
#include "../../game/game_info.hpp"
|
|
|
|
#include "../../settings_type.h"
|
|
|
|
#include "../../string_func.h"
|
|
|
|
#include "../../rev.h"
|
|
|
|
#include "../network_func.h"
|
|
|
|
#include "../network.h"
|
|
|
|
#include "packet.h"
|
|
|
|
|
|
|
|
#include "../../safeguards.h"
|
|
|
|
|
|
|
|
extern const uint8 _out_of_band_grf_md5[16];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* How many hex digits of the git hash to include in network revision string.
|
|
|
|
* Determined as 10 hex digits + 2 characters for -g/-u/-m prefix.
|
|
|
|
*/
|
|
|
|
static const uint GITHASH_SUFFIX_LEN = 12;
|
|
|
|
|
|
|
|
NetworkServerGameInfo _network_game_info; ///< Information about our game.
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the network version string used by this build.
|
|
|
|
* The returned string is guaranteed to be at most NETWORK_REVISON_LENGTH bytes.
|
|
|
|
*/
|
|
|
|
const char *GetNetworkRevisionString()
|
|
|
|
{
|
|
|
|
/* This will be allocated on heap and never free'd, but only once so not a "real" leak. */
|
|
|
|
static char *network_revision = nullptr;
|
|
|
|
|
|
|
|
if (!network_revision) {
|
|
|
|
/* Start by taking a chance on the full revision string. */
|
|
|
|
network_revision = stredup(_openttd_revision);
|
|
|
|
/* Ensure it's not longer than the packet buffer length. */
|
|
|
|
if (strlen(network_revision) >= NETWORK_REVISION_LENGTH - 1) network_revision[NETWORK_REVISION_LENGTH - 1] = '\0';
|
|
|
|
|
|
|
|
/* Tag names are not mangled further. */
|
|
|
|
if (_openttd_revision_tagged) {
|
|
|
|
DEBUG(net, 3, "Network revision name: %s", network_revision);
|
|
|
|
return network_revision;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Prepare a prefix of the git hash.
|
|
|
|
* Size is length + 1 for terminator, +2 for -g prefix. */
|
|
|
|
assert(_openttd_revision_modified < 3);
|
|
|
|
char githash_suffix[GITHASH_SUFFIX_LEN + 1] = "-";
|
|
|
|
githash_suffix[1] = "gum"[_openttd_revision_modified];
|
|
|
|
for (uint i = 2; i < GITHASH_SUFFIX_LEN; i++) {
|
|
|
|
githash_suffix[i] = _openttd_revision_hash[i-2];
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Where did the hash start in the original string?
|
|
|
|
* Overwrite from that position, unless that would go past end of packet buffer length. */
|
|
|
|
ptrdiff_t hashofs = strrchr(_openttd_revision, '-') - _openttd_revision;
|
|
|
|
if (hashofs + strlen(githash_suffix) + 1 > NETWORK_REVISION_LENGTH) hashofs = strlen(network_revision) - strlen(githash_suffix);
|
|
|
|
/* Replace the git hash in revision string. */
|
|
|
|
strecpy(network_revision + hashofs, githash_suffix, network_revision + NETWORK_REVISION_LENGTH);
|
|
|
|
assert(strlen(network_revision) < NETWORK_REVISION_LENGTH); // strlen does not include terminator, constant does, hence strictly less than
|
|
|
|
DEBUG(net, 3, "Network revision name: %s", network_revision);
|
|
|
|
}
|
|
|
|
|
|
|
|
return network_revision;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extract the git hash from the revision string.
|
|
|
|
* @param revstr The revision string (formatted as DATE-BRANCH-GITHASH).
|
|
|
|
* @return The git has part of the revision.
|
|
|
|
*/
|
|
|
|
static const char *ExtractNetworkRevisionHash(const char *revstr)
|
|
|
|
{
|
|
|
|
return strrchr(revstr, '-');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the given version string is compatible with our version.
|
|
|
|
* First tries to match the full string, if that fails, attempts to compare just git hashes.
|
|
|
|
* @param other the version string to compare to
|
|
|
|
*/
|
|
|
|
bool IsNetworkCompatibleVersion(const char *other, bool extended)
|
|
|
|
{
|
|
|
|
if (strncmp(GetNetworkRevisionString(), other, (extended ? NETWORK_LONG_REVISION_LENGTH : NETWORK_REVISION_LENGTH) - 1) == 0) return true;
|
|
|
|
|
|
|
|
/* If this version is tagged, then the revision string must be a complete match,
|
|
|
|
* since there is no git hash suffix in it.
|
|
|
|
* This is needed to avoid situations like "1.9.0-beta1" comparing equal to "2.0.0-beta1". */
|
|
|
|
if (_openttd_revision_tagged) return false;
|
|
|
|
|
|
|
|
const char *hash1 = ExtractNetworkRevisionHash(GetNetworkRevisionString());
|
|
|
|
const char *hash2 = ExtractNetworkRevisionHash(other);
|
|
|
|
return hash1 != nullptr && hash2 != nullptr && strncmp(hash1, hash2, GITHASH_SUFFIX_LEN) == 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if an game entry is compatible with our client.
|
|
|
|
*/
|
|
|
|
void CheckGameCompatibility(NetworkGameInfo &ngi, bool extended)
|
|
|
|
{
|
|
|
|
/* Check if we are allowed on this server based on the revision-check. */
|
|
|
|
ngi.version_compatible = IsNetworkCompatibleVersion(ngi.server_revision.c_str(), extended);
|
|
|
|
ngi.compatible = ngi.version_compatible;
|
|
|
|
|
|
|
|
/* Check if we have all the GRFs on the client-system too. */
|
|
|
|
for (const GRFConfig *c = ngi.grfconfig; c != nullptr; c = c->next) {
|
|
|
|
if (c->status == GCS_NOT_FOUND) ngi.compatible = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Fill a NetworkServerGameInfo structure with the static content, or things
|
|
|
|
* that are so static they can be updated on request from a settings change.
|
|
|
|
*/
|
|
|
|
void FillStaticNetworkServerGameInfo()
|
|
|
|
{
|
|
|
|
_network_game_info.use_password = !_settings_client.network.server_password.empty();
|
|
|
|
_network_game_info.start_date = ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1);
|
|
|
|
_network_game_info.clients_max = _settings_client.network.max_clients;
|
|
|
|
_network_game_info.companies_max = _settings_client.network.max_companies;
|
|
|
|
_network_game_info.map_width = MapSizeX();
|
|
|
|
_network_game_info.map_height = MapSizeY();
|
|
|
|
_network_game_info.landscape = _settings_game.game_creation.landscape;
|
|
|
|
_network_game_info.dedicated = _network_dedicated;
|
|
|
|
_network_game_info.grfconfig = _grfconfig;
|
|
|
|
|
|
|
|
_network_game_info.server_name = _settings_client.network.server_name;
|
|
|
|
_network_game_info.server_revision = GetNetworkRevisionString();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the NetworkServerGameInfo structure with the latest information of the server.
|
|
|
|
* @return The current NetworkServerGameInfo.
|
|
|
|
*/
|
|
|
|
const NetworkServerGameInfo *GetCurrentNetworkServerGameInfo()
|
|
|
|
{
|
|
|
|
/* These variables are updated inside _network_game_info as if they are global variables:
|
|
|
|
* - clients_on
|
|
|
|
* - invite_code
|
|
|
|
* These don't need to be updated manually here.
|
|
|
|
*/
|
|
|
|
_network_game_info.companies_on = (byte)Company::GetNumItems();
|
|
|
|
_network_game_info.spectators_on = NetworkSpectatorCount();
|
|
|
|
_network_game_info.game_date = _date;
|
|
|
|
return &_network_game_info;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function that is called for every GRFConfig that is read when receiving
|
|
|
|
* a NetworkGameInfo. Only grfid and md5sum are set, the rest is zero. This
|
|
|
|
* function must set all appropriate fields. This GRF is later appended to
|
|
|
|
* the grfconfig list of the NetworkGameInfo.
|
|
|
|
* @param config The GRF to handle.
|
|
|
|
* @param name The name of the NewGRF, empty when unknown.
|
|
|
|
*/
|
|
|
|
static void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config, std::string name)
|
|
|
|
{
|
|
|
|
/* Find the matching GRF file */
|
|
|
|
const GRFConfig *f = FindGRFConfig(config->ident.grfid, FGCM_EXACT, &config->ident.md5sum);
|
|
|
|
if (f == nullptr) {
|
|
|
|
AddGRFTextToList(config->name, name.empty() ? GetString(STR_CONFIG_ERROR_INVALID_GRF_UNKNOWN) : name);
|
|
|
|
config->status = GCS_NOT_FOUND;
|
|
|
|
} else {
|
|
|
|
config->filename = f->filename;
|
|
|
|
config->name = f->name;
|
|
|
|
config->info = f->info;
|
|
|
|
config->url = f->url;
|
|
|
|
}
|
|
|
|
SetBit(config->flags, GCF_COPY);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Serializes the NetworkGameInfo struct to the packet.
|
|
|
|
* @param p the packet to write the data to.
|
|
|
|
* @param info the NetworkGameInfo struct to serialize from.
|
|
|
|
*/
|
|
|
|
void SerializeNetworkGameInfo(Packet *p, const NetworkServerGameInfo *info, bool send_newgrf_names)
|
|
|
|
{
|
|
|
|
p->Send_uint8 (NETWORK_GAME_INFO_VERSION);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Please observe the order.
|
|
|
|
* The parts must be read in the same order as they are sent!
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Update the documentation in game_info.h on changes
|
|
|
|
* to the NetworkGameInfo wire-protocol! */
|
|
|
|
|
|
|
|
/* NETWORK_GAME_INFO_VERSION = 6 */
|
|
|
|
p->Send_uint8(send_newgrf_names ? NST_GRFID_MD5_NAME : NST_GRFID_MD5);
|
|
|
|
|
|
|
|
/* NETWORK_GAME_INFO_VERSION = 5 */
|
|
|
|
GameInfo *game_info = Game::GetInfo();
|
|
|
|
p->Send_uint32(game_info == nullptr ? -1 : (uint32)game_info->GetVersion());
|
|
|
|
p->Send_string(game_info == nullptr ? "" : game_info->GetName());
|
|
|
|
|
|
|
|
/* NETWORK_GAME_INFO_VERSION = 4 */
|
|
|
|
{
|
|
|
|
/* Only send the GRF Identification (GRF_ID and MD5 checksum) of
|
|
|
|
* the GRFs that are needed, i.e. the ones that the server has
|
|
|
|
* selected in the NewGRF GUI and not the ones that are used due
|
|
|
|
* to the fact that they are in [newgrf-static] in openttd.cfg */
|
|
|
|
const GRFConfig *c;
|
|
|
|
uint count = 0;
|
|
|
|
|
|
|
|
/* Count number of GRFs to send information about */
|
|
|
|
for (c = info->grfconfig; c != nullptr; c = c->next) {
|
|
|
|
if (!HasBit(c->flags, GCF_STATIC)) count++;
|
|
|
|
}
|
|
|
|
p->Send_uint8(std::min<uint>(count, NETWORK_MAX_GRF_COUNT)); // Send number of GRFs
|
|
|
|
|
|
|
|
/* Send actual GRF Identifications */
|
|
|
|
for (c = info->grfconfig; c != nullptr; c = c->next) {
|
|
|
|
if (HasBit(c->flags, GCF_STATIC)) continue;
|
|
|
|
|
|
|
|
SerializeGRFIdentifier(p, &c->ident);
|
|
|
|
if (send_newgrf_names) p->Send_string(c->GetName());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* NETWORK_GAME_INFO_VERSION = 3 */
|
|
|
|
p->Send_uint32(info->game_date.base());
|
|
|
|
p->Send_uint32(info->start_date.base());
|
|
|
|
|
|
|
|
/* NETWORK_GAME_INFO_VERSION = 2 */
|
|
|
|
p->Send_uint8 (info->companies_max);
|
|
|
|
p->Send_uint8 (info->companies_on);
|
|
|
|
p->Send_uint8 (info->clients_max); // Used to be max-spectators
|
|
|
|
|
|
|
|
/* NETWORK_GAME_INFO_VERSION = 1 */
|
|
|
|
p->Send_string(info->server_name);
|
|
|
|
p->Send_string(info->server_revision);
|
|
|
|
p->Send_bool (info->use_password);
|
|
|
|
p->Send_uint8 (info->clients_max);
|
|
|
|
p->Send_uint8 (info->clients_on);
|
|
|
|
p->Send_uint8 (info->spectators_on);
|
|
|
|
|
|
|
|
auto encode_map_size = [&](uint32 in) -> uint16 {
|
|
|
|
if (in < UINT16_MAX) {
|
|
|
|
return in;
|
|
|
|
} else {
|
|
|
|
return 65000 + FindFirstBit(in);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
p->Send_uint16(encode_map_size(info->map_width));
|
|
|
|
p->Send_uint16(encode_map_size(info->map_height));
|
|
|
|
p->Send_uint8 (info->landscape);
|
|
|
|
p->Send_bool (info->dedicated);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Serializes the NetworkGameInfo struct to the packet
|
|
|
|
* @param p the packet to write the data to
|
|
|
|
* @param info the NetworkGameInfo struct to serialize
|
|
|
|
*/
|
|
|
|
void SerializeNetworkGameInfoExtended(Packet *p, const NetworkServerGameInfo *info, uint16 flags, uint16 version, bool send_newgrf_names)
|
|
|
|
{
|
|
|
|
version = std::max<uint16>(version, 1); // Version 1 is the max supported
|
|
|
|
|
|
|
|
p->Send_uint8(version); // version num
|
|
|
|
|
|
|
|
p->Send_uint32(info->game_date.base());
|
|
|
|
p->Send_uint32(info->start_date.base());
|
|
|
|
p->Send_uint8 (info->companies_max);
|
|
|
|
p->Send_uint8 (info->companies_on);
|
|
|
|
p->Send_uint8 (info->clients_max); // Used to be max-spectators
|
|
|
|
p->Send_string(info->server_name);
|
|
|
|
p->Send_string(info->server_revision);
|
|
|
|
p->Send_uint8 (0); // Used to be server-lang.
|
|
|
|
p->Send_bool (info->use_password);
|
|
|
|
p->Send_uint8 (info->clients_max);
|
|
|
|
p->Send_uint8 (info->clients_on);
|
|
|
|
p->Send_uint8 (info->spectators_on);
|
|
|
|
p->Send_string(""); // Used to be map-name.
|
|
|
|
p->Send_uint32(info->map_width);
|
|
|
|
p->Send_uint32(info->map_height);
|
|
|
|
p->Send_uint8 (info->landscape);
|
|
|
|
p->Send_bool (info->dedicated);
|
|
|
|
|
|
|
|
if (version >= 1) {
|
|
|
|
GameInfo *game_info = Game::GetInfo();
|
|
|
|
p->Send_uint32(game_info == nullptr ? -1 : (uint32)game_info->GetVersion());
|
|
|
|
p->Send_string(game_info == nullptr ? "" : game_info->GetName());
|
|
|
|
|
|
|
|
p->Send_uint8(send_newgrf_names ? NST_GRFID_MD5_NAME : NST_GRFID_MD5);
|
|
|
|
}
|
|
|
|
|
|
|
|
{
|
|
|
|
/* Only send the GRF Identification (GRF_ID and MD5 checksum) of
|
|
|
|
* the GRFs that are needed, i.e. the ones that the server has
|
|
|
|
* selected in the NewGRF GUI and not the ones that are used due
|
|
|
|
* to the fact that they are in [newgrf-static] in openttd.cfg */
|
|
|
|
const GRFConfig *c;
|
|
|
|
uint count = 0;
|
|
|
|
|
|
|
|
/* Count number of GRFs to send information about */
|
|
|
|
for (c = info->grfconfig; c != nullptr; c = c->next) {
|
|
|
|
if (!HasBit(c->flags, GCF_STATIC)) count++;
|
|
|
|
}
|
|
|
|
p->Send_uint32(count); // Send number of GRFs
|
|
|
|
|
|
|
|
/* Send actual GRF Identifications */
|
|
|
|
for (c = info->grfconfig; c != nullptr; c = c->next) {
|
|
|
|
if (HasBit(c->flags, GCF_STATIC)) continue;
|
|
|
|
|
|
|
|
SerializeGRFIdentifier(p, &c->ident);
|
|
|
|
if (send_newgrf_names && version >= 1) p->Send_string(c->GetName());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deserializes the NetworkGameInfo struct from the packet.
|
|
|
|
* @param p the packet to read the data from.
|
|
|
|
* @param info the NetworkGameInfo to deserialize into.
|
|
|
|
*/
|
|
|
|
void DeserializeNetworkGameInfo(Packet *p, NetworkGameInfo *info, const GameInfoNewGRFLookupTable *newgrf_lookup_table)
|
|
|
|
{
|
|
|
|
static const Date MAX_DATE = ConvertYMDToDate(MAX_YEAR, 11, 31); // December is month 11
|
|
|
|
|
|
|
|
byte game_info_version = p->Recv_uint8();
|
|
|
|
NewGRFSerializationType newgrf_serialisation = NST_GRFID_MD5;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Please observe the order.
|
|
|
|
* The parts must be read in the same order as they are sent!
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Update the documentation in game_info.h on changes
|
|
|
|
* to the NetworkGameInfo wire-protocol! */
|
|
|
|
|
|
|
|
switch (game_info_version) {
|
|
|
|
case 6:
|
|
|
|
newgrf_serialisation = (NewGRFSerializationType)p->Recv_uint8();
|
|
|
|
if (newgrf_serialisation >= NST_END) return;
|
|
|
|
FALLTHROUGH;
|
|
|
|
|
|
|
|
case 5: {
|
|
|
|
info->gamescript_version = (int)p->Recv_uint32();
|
|
|
|
info->gamescript_name = p->Recv_string(NETWORK_NAME_LENGTH);
|
|
|
|
FALLTHROUGH;
|
|
|
|
}
|
|
|
|
|
|
|
|
case 4: {
|
|
|
|
/* Ensure that the maximum number of NewGRFs and the field in the network
|
|
|
|
* protocol are matched to eachother. If that is not the case anymore a
|
|
|
|
* check must be added to ensure the received data is still valid. */
|
|
|
|
static_assert(std::numeric_limits<uint8>::max() == NETWORK_MAX_GRF_COUNT);
|
|
|
|
uint num_grfs = p->Recv_uint8();
|
|
|
|
|
|
|
|
GRFConfig **dst = &info->grfconfig;
|
|
|
|
for (uint i = 0; i < num_grfs; i++) {
|
|
|
|
NamedGRFIdentifier grf;
|
|
|
|
switch (newgrf_serialisation) {
|
|
|
|
case NST_GRFID_MD5:
|
|
|
|
DeserializeGRFIdentifier(p, &grf.ident);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case NST_GRFID_MD5_NAME:
|
|
|
|
DeserializeGRFIdentifierWithName(p, &grf);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case NST_LOOKUP_ID: {
|
|
|
|
if (newgrf_lookup_table == nullptr) return;
|
|
|
|
auto it = newgrf_lookup_table->find(p->Recv_uint32());
|
|
|
|
if (it == newgrf_lookup_table->end()) return;
|
|
|
|
grf = it->second;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
default:
|
|
|
|
NOT_REACHED();
|
|
|
|
}
|
|
|
|
|
|
|
|
GRFConfig *c = new GRFConfig();
|
|
|
|
c->ident = grf.ident;
|
|
|
|
HandleIncomingNetworkGameInfoGRFConfig(c, grf.name);
|
|
|
|
|
|
|
|
/* Append GRFConfig to the list */
|
|
|
|
*dst = c;
|
|
|
|
dst = &c->next;
|
|
|
|
}
|
|
|
|
FALLTHROUGH;
|
|
|
|
}
|
|
|
|
|
|
|
|
case 3:
|
|
|
|
info->game_date = Clamp(p->Recv_uint32(), 0, MAX_DATE.base());
|
|
|
|
info->start_date = Clamp(p->Recv_uint32(), 0, MAX_DATE.base());
|
|
|
|
FALLTHROUGH;
|
|
|
|
|
|
|
|
case 2:
|
|
|
|
info->companies_max = p->Recv_uint8 ();
|
|
|
|
info->companies_on = p->Recv_uint8 ();
|
|
|
|
p->Recv_uint8(); // Used to contain max-spectators.
|
|
|
|
FALLTHROUGH;
|
|
|
|
|
|
|
|
case 1:
|
|
|
|
info->server_name = p->Recv_string(NETWORK_NAME_LENGTH);
|
|
|
|
info->server_revision = p->Recv_string(NETWORK_REVISION_LENGTH);
|
|
|
|
if (game_info_version < 6) p->Recv_uint8 (); // Used to contain server-lang.
|
|
|
|
info->use_password = p->Recv_bool ();
|
|
|
|
info->clients_max = p->Recv_uint8 ();
|
|
|
|
info->clients_on = p->Recv_uint8 ();
|
|
|
|
info->spectators_on = p->Recv_uint8 ();
|
|
|
|
if (game_info_version < 3) { // 16 bits dates got scrapped and are read earlier
|
|
|
|
info->game_date = p->Recv_uint16() + DAYS_TILL_ORIGINAL_BASE_YEAR;
|
|
|
|
info->start_date = p->Recv_uint16() + DAYS_TILL_ORIGINAL_BASE_YEAR;
|
|
|
|
}
|
|
|
|
if (game_info_version < 6) while (p->Recv_uint8() != 0) {} // Used to contain the map-name.
|
|
|
|
|
|
|
|
auto decode_map_size = [&](uint16 in) -> uint32 {
|
|
|
|
if (in >= 65000) {
|
|
|
|
return 1 << (in - 65000);
|
|
|
|
} else {
|
|
|
|
return in;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
info->map_width = decode_map_size(p->Recv_uint16());
|
|
|
|
info->map_height = decode_map_size(p->Recv_uint16());
|
|
|
|
|
|
|
|
info->landscape = p->Recv_uint8 ();
|
|
|
|
info->dedicated = p->Recv_bool ();
|
|
|
|
|
|
|
|
if (info->landscape >= NUM_LANDSCAPE) info->landscape = 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deserializes the NetworkGameInfo struct from the packet
|
|
|
|
* @param p the packet to read the data from
|
|
|
|
* @param info the NetworkGameInfo to deserialize into
|
|
|
|
*/
|
|
|
|
void DeserializeNetworkGameInfoExtended(Packet *p, NetworkGameInfo *info)
|
|
|
|
{
|
|
|
|
static const Date MAX_DATE = ConvertYMDToDate(MAX_YEAR, 11, 31); // December is month 11
|
|
|
|
|
|
|
|
const uint8 version = p->Recv_uint8();
|
|
|
|
if (version > SERVER_GAME_INFO_EXTENDED_MAX_VERSION) return; // Unknown version
|
|
|
|
|
|
|
|
NewGRFSerializationType newgrf_serialisation = NST_GRFID_MD5;
|
|
|
|
|
|
|
|
info->game_date = Clamp(p->Recv_uint32(), 0, MAX_DATE.base());
|
|
|
|
info->start_date = Clamp(p->Recv_uint32(), 0, MAX_DATE.base());
|
|
|
|
info->companies_max = p->Recv_uint8 ();
|
|
|
|
info->companies_on = p->Recv_uint8 ();
|
|
|
|
p->Recv_uint8(); // Used to contain max-spectators.
|
|
|
|
info->server_name = p->Recv_string(NETWORK_NAME_LENGTH);
|
|
|
|
info->server_revision = p->Recv_string(NETWORK_LONG_REVISION_LENGTH);
|
|
|
|
p->Recv_uint8 (); // Used to contain server-lang.
|
|
|
|
info->use_password = p->Recv_bool ();
|
|
|
|
info->clients_max = p->Recv_uint8 ();
|
|
|
|
info->clients_on = p->Recv_uint8 ();
|
|
|
|
info->spectators_on = p->Recv_uint8 ();
|
|
|
|
while (p->Recv_uint8() != 0) {} // Used to contain the map-name.
|
|
|
|
info->map_width = p->Recv_uint32();
|
|
|
|
info->map_height = p->Recv_uint32();
|
|
|
|
info->landscape = p->Recv_uint8 ();
|
|
|
|
if (info->landscape >= NUM_LANDSCAPE) info->landscape = 0;
|
|
|
|
info->dedicated = p->Recv_bool ();
|
|
|
|
|
|
|
|
if (version >= 1) {
|
|
|
|
info->gamescript_version = (int)p->Recv_uint32();
|
|
|
|
info->gamescript_name = p->Recv_string(NETWORK_NAME_LENGTH);
|
|
|
|
|
|
|
|
newgrf_serialisation = (NewGRFSerializationType)p->Recv_uint8();
|
|
|
|
if (newgrf_serialisation >= NST_END) return;
|
|
|
|
}
|
|
|
|
|
|
|
|
{
|
|
|
|
GRFConfig **dst = &info->grfconfig;
|
|
|
|
uint i;
|
|
|
|
uint num_grfs = p->Recv_uint32();
|
|
|
|
|
|
|
|
/* Broken/bad data. It cannot have that many NewGRFs. */
|
|
|
|
if (num_grfs > MAX_NON_STATIC_GRF_COUNT) return;
|
|
|
|
|
|
|
|
for (i = 0; i < num_grfs; i++) {
|
|
|
|
NamedGRFIdentifier grf;
|
|
|
|
switch (newgrf_serialisation) {
|
|
|
|
case NST_GRFID_MD5:
|
|
|
|
DeserializeGRFIdentifier(p, &grf.ident);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case NST_GRFID_MD5_NAME:
|
|
|
|
DeserializeGRFIdentifierWithName(p, &grf);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case NST_LOOKUP_ID: {
|
|
|
|
DEBUG(net, 0, "Unexpected NST_LOOKUP_ID in DeserializeNetworkGameInfoExtended");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
default:
|
|
|
|
NOT_REACHED();
|
|
|
|
}
|
|
|
|
|
|
|
|
GRFConfig *c = new GRFConfig();
|
|
|
|
c->ident = grf.ident;
|
|
|
|
HandleIncomingNetworkGameInfoGRFConfig(c, grf.name);
|
|
|
|
|
|
|
|
/* Append GRFConfig to the list */
|
|
|
|
*dst = c;
|
|
|
|
dst = &c->next;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Serializes the GRFIdentifier (GRF ID and MD5 checksum) to the packet
|
|
|
|
* @param p the packet to write the data to.
|
|
|
|
* @param grf the GRFIdentifier to serialize.
|
|
|
|
*/
|
|
|
|
void SerializeGRFIdentifier(Packet *p, const GRFIdentifier *grf)
|
|
|
|
{
|
|
|
|
p->Send_uint32(grf->grfid);
|
|
|
|
for (size_t j = 0; j < grf->md5sum.size(); j++) {
|
|
|
|
p->Send_uint8(grf->md5sum[j]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deserializes the GRFIdentifier (GRF ID and MD5 checksum) from the packet
|
|
|
|
* @param p the packet to read the data from.
|
|
|
|
* @param grf the GRFIdentifier to deserialize.
|
|
|
|
*/
|
|
|
|
void DeserializeGRFIdentifier(Packet *p, GRFIdentifier *grf)
|
|
|
|
{
|
|
|
|
grf->grfid = p->Recv_uint32();
|
|
|
|
for (size_t j = 0; j < grf->md5sum.size(); j++) {
|
|
|
|
grf->md5sum[j] = p->Recv_uint8();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deserializes the NamedGRFIdentifier (GRF ID, MD5 checksum and name) from the packet
|
|
|
|
* @param p the packet to read the data from.
|
|
|
|
* @param grf the NamedGRFIdentifier to deserialize.
|
|
|
|
*/
|
|
|
|
void DeserializeGRFIdentifierWithName(Packet *p, NamedGRFIdentifier *grf)
|
|
|
|
{
|
|
|
|
DeserializeGRFIdentifier(p, &grf->ident);
|
|
|
|
grf->name = p->Recv_string(NETWORK_GRF_NAME_LENGTH);
|
|
|
|
}
|