1

#include "stdafx.h"

     2

#include "debug.h"

     3

#include "string.h"

     4

#include "strings.h"

     5

#include "network_data.h"

     6

     7

#ifdef ENABLE_NETWORK

     8

     9

#include "table/strings.h"

    10

#include "network_client.h"

    11

#include "network_gamelist.h"

    12

#include "command.h"

    13

#include "gfx.h"

    14

#include "window.h"

    15

#include "settings.h"

    16

#include "console.h"

    17

    18

    19

// This file handles all the client-commands

    20

    21

    22

extern const char _openttd_revision[];

    23

    24

// So we don't make too much typos ;)

    25

#define MY_CLIENT DEREF_CLIENT(0)

    26

    27

static uint32 last_ack_frame;

    28

    29

void NetworkRecvPatchSettings(NetworkClientState *cs, Packet *p);

    30

    31

// **********

    32

// Sending functions

    33

//   DEF_CLIENT_SEND_COMMAND has no parameters

    34

// **********

    35

    36

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    37

{

    38

	//

    39

	// Packet: CLIENT_COMPANY_INFO

    40

	// Function: Request company-info (in detail)

    41

	// Data:

    42

	//    <none>

    43

	//

    44

	Packet *p;

    45

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    46

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    47

    48

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    49

	NetworkSend_Packet(p, MY_CLIENT);

    50

}

    51

    52

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    53

{

    54

	//

    55

	// Packet: CLIENT_JOIN

    56

	// Function: Try to join the server

    57

	// Data:

    58

	//    String: OpenTTD Revision (norev000 if no revision)

    59

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    60

	//    uint8:  Play as Player id (1..MAX_PLAYERS)

    61

	//    uint8:  Language ID

    62

	//    String: Unique id to find the player back in server-listing

    63

	//

    64

    65

	Packet *p;

    66

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    67

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    68

    69

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    70

	NetworkSend_string(p, _openttd_revision);

    71

	NetworkSend_string(p, _network_player_name); // Player name

    72

	NetworkSend_uint8(p, _network_playas); // PlayAs

    73

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    74

	NetworkSend_string(p, _network_unique_id);

    75

	NetworkSend_Packet(p, MY_CLIENT);

    76

}

    77

    78

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_PASSWORD)(NetworkPasswordType type, const char *password)

    79

{

    80

	//

    81

	// Packet: CLIENT_PASSWORD

    82

	// Function: Send a password to the server to authorize

    83

	// Data:

    84

	//    uint8:  NetworkPasswordType

    85

	//    String: Password

    86

	//

    87

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    88

	NetworkSend_uint8(p, type);

    89

	NetworkSend_string(p, password);

    90

	NetworkSend_Packet(p, MY_CLIENT);

    91

}

    92

    93

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    94

{

    95

	//

    96

	// Packet: CLIENT_GETMAP

    97

	// Function: Request the map from the server

    98

	// Data:

    99

	//    <none>

   100

	//

   101

   102

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   103

	NetworkSend_Packet(p, MY_CLIENT);

   104

}

   105

   106

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   107

{

   108

	//

   109

	// Packet: CLIENT_MAP_OK

   110

	// Function: Tell the server that we are done receiving/loading the map

   111

	// Data:

   112

	//    <none>

   113

	//

   114

   115

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   116

	NetworkSend_Packet(p, MY_CLIENT);

   117

}

   118

   119

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   120

{

   121

	//

   122

	// Packet: CLIENT_ACK

   123

	// Function: Tell the server we are done with this frame

   124

	// Data:

   125

	//    uint32: current FrameCounter of the client

   126

	//

   127

   128

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   129

   130

	NetworkSend_uint32(p, _frame_counter);

   131

	NetworkSend_Packet(p, MY_CLIENT);

   132

}

   133

   134

// Send a command packet to the server

   135

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   136

{

   137

	//

   138

	// Packet: CLIENT_COMMAND

   139

	// Function: Send a DoCommand to the Server

   140

	// Data:

   141

	//    uint8:  PlayerID (0..MAX_PLAYERS-1)

   142

	//    uint32: CommandID (see command.h)

   143

	//    uint32: P1 (free variables used in DoCommand)

   144

	//    uint32: P2

   145

	//    uint32: Tile

   146

	//    uint32: decode_params

   147

	//      10 times the last one (lengthof(cp->dp))

   148

	//    uint8:  CallBackID (see callback_table.c)

   149

	//

   150

   151

	uint i;

   152

	char *dparam_char;

   153

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   154

   155

	NetworkSend_uint8(p, cp->player);

   156

	NetworkSend_uint32(p, cp->cmd);

   157

	NetworkSend_uint32(p, cp->p1);

   158

	NetworkSend_uint32(p, cp->p2);

   159

	NetworkSend_uint32(p, (uint32)cp->tile);

   160

	/* We are going to send them byte by byte, because dparam is misused

   161

	    for chars (if it is used), and else we have a BigEndian / LittleEndian

   162

	    problem.. we should fix the misuse of dparam... -- TrueLight */

   163

	dparam_char = (char *)&cp->dp[0];

   164

	for (i = 0; i < lengthof(cp->dp) * 4; i++) {

   165

		NetworkSend_uint8(p, *dparam_char);

   166

		dparam_char++;

   167

	}

   168

	NetworkSend_uint8(p, cp->callback);

   169

   170

	NetworkSend_Packet(p, MY_CLIENT);

   171

}

   172

   173

// Send a chat-packet over the network

   174

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_CHAT)(NetworkAction action, DestType desttype, int dest, const char *msg)

   175

{

   176

	//

   177

	// Packet: CLIENT_CHAT

   178

	// Function: Send a chat-packet to the serve

   179

	// Data:

   180

	//    uint8:  ActionID (see network_data.h, NetworkAction)

   181

	//    uint8:  Destination Type (see network_data.h, DestType);

   182

	//    uint8:  Destination Player (1..MAX_PLAYERS)

   183

	//    String: Message (max MAX_TEXT_MSG_LEN)

   184

	//

   185

   186

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   187

   188

	NetworkSend_uint8(p, action);

   189

	NetworkSend_uint8(p, desttype);

   190

	NetworkSend_uint8(p, dest);

   191

	NetworkSend_string(p, msg);

   192

	NetworkSend_Packet(p, MY_CLIENT);

   193

}

   194

   195

// Send an error-packet over the network

   196

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   197

{

   198

	//

   199

	// Packet: CLIENT_ERROR

   200

	// Function: The client made an error and is quiting the game

   201

	// Data:

   202

	//    uint8:  ErrorID (see network_data.h, NetworkErrorCode)

   203

	//

   204

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   205

   206

	NetworkSend_uint8(p, errorno);

   207

	NetworkSend_Packet(p, MY_CLIENT);

   208

}

   209

   210

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   211

{

   212

	//

   213

	// Packet: PACKET_CLIENT_SET_PASSWORD

   214

	// Function: Set the password for the clients current company

   215

	// Data:

   216

	//    String: Password

   217

	//

   218

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   219

   220

	NetworkSend_string(p, password);

   221

	NetworkSend_Packet(p, MY_CLIENT);

   222

}

   223

   224

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   225

{

   226

	//

   227

	// Packet: PACKET_CLIENT_SET_NAME

   228

	// Function: Gives the player a new name

   229

	// Data:

   230

	//    String: Name

   231

	//

   232

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   233

   234

	NetworkSend_string(p, name);

   235

	NetworkSend_Packet(p, MY_CLIENT);

   236

}

   237

   238

// Send an quit-packet over the network

   239

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   240

{

   241

	//

   242

	// Packet: CLIENT_QUIT

   243

	// Function: The client is quiting the game

   244

	// Data:

   245

	//    String: leave-message

   246

	//

   247

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   248

   249

	NetworkSend_string(p, leavemsg);

   250

	NetworkSend_Packet(p, MY_CLIENT);

   251

}

   252

   253

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_RCON)(const char *pass, const char *command)

   254

{

   255

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   256

	NetworkSend_string(p, pass);

   257

	NetworkSend_string(p, command);

   258

	NetworkSend_Packet(p, MY_CLIENT);

   259

}

   260

   261

   262

// **********

   263

// Receiving functions

   264

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   265

// **********

   266

   267

extern bool SafeSaveOrLoad(const char *filename, int mode, int newgm);

   268

   269

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   270

{

   271

	// We try to join a server which is full

   272

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   273

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   274

   275

	return NETWORK_RECV_STATUS_SERVER_FULL;

   276

}

   277

   278

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   279

{

   280

	// We try to join a server where we are banned

   281

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   282

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   283

   284

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   285

}

   286

   287

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   288

{

   289

	byte company_info_version;

   290

	int i;

   291

   292

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   293

   294

	if (!MY_CLIENT->quited && company_info_version == NETWORK_COMPANY_INFO_VERSION) {

   295

		byte total;

   296

		byte current;

   297

   298

		total = NetworkRecv_uint8(MY_CLIENT, p);

   299

   300

		// There is no data at all..

   301

		if (total == 0)

   302

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   303

   304

		current = NetworkRecv_uint8(MY_CLIENT, p);

   305

		if (current >= MAX_PLAYERS)

   306

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   307

   308

		_network_lobby_company_count++;

   309

   310

		NetworkRecv_string(MY_CLIENT, p, _network_player_info[current].company_name, sizeof(_network_player_info[current].company_name));

   311

		_network_player_info[current].inaugurated_year = NetworkRecv_uint8(MY_CLIENT, p);

   312

		_network_player_info[current].company_value = NetworkRecv_uint64(MY_CLIENT, p);

   313

		_network_player_info[current].money = NetworkRecv_uint64(MY_CLIENT, p);

   314

		_network_player_info[current].income = NetworkRecv_uint64(MY_CLIENT, p);

   315

		_network_player_info[current].performance = NetworkRecv_uint16(MY_CLIENT, p);

   316

		_network_player_info[current].use_password = NetworkRecv_uint8(MY_CLIENT, p);

   317

		for (i = 0; i < NETWORK_VEHICLE_TYPES; i++)

   318

			_network_player_info[current].num_vehicle[i] = NetworkRecv_uint16(MY_CLIENT, p);

   319

		for (i = 0; i < NETWORK_STATION_TYPES; i++)

   320

			_network_player_info[current].num_station[i] = NetworkRecv_uint16(MY_CLIENT, p);

   321

   322

		NetworkRecv_string(MY_CLIENT, p, _network_player_info[current].players, sizeof(_network_player_info[current].players));

   323

   324

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   325

   326

		return NETWORK_RECV_STATUS_OKAY;

   327

	}

   328

   329

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   330

}

   331

   332

// This packet contains info about the client (playas and name)

   333

//  as client we save this in NetworkClientInfo, linked via 'index'

   334

//  which is always an unique number on a server.

   335

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   336

{

   337

	NetworkClientInfo *ci;

   338

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   339

	byte playas = NetworkRecv_uint8(MY_CLIENT, p);

   340

	char name[NETWORK_NAME_LENGTH];

   341

	char unique_id[NETWORK_NAME_LENGTH];

   342

   343

	NetworkRecv_string(MY_CLIENT, p, name, sizeof(name));

   344

	NetworkRecv_string(MY_CLIENT, p, unique_id, sizeof(unique_id));

   345

   346

	if (MY_CLIENT->quited)

   347

		return NETWORK_RECV_STATUS_CONN_LOST;

   348

   349

	/* Do we receive a change of data? Most likely we changed playas */

   350

	if (index == _network_own_client_index)

   351

		_network_playas = playas;

   352

   353

	ci = NetworkFindClientInfoFromIndex(index);

   354

	if (ci != NULL) {

   355

		if (playas == ci->client_playas && strcmp(name, ci->client_name) != 0) {

   356

			// Client name changed, display the change

   357

			NetworkTextMessage(NETWORK_ACTION_NAME_CHANGE, 1, false, ci->client_name, name);

   358

		} else if (playas != ci->client_playas) {

   359

			// The player changed from client-player..

   360

			// Do not display that for now

   361

		}

   362

   363

		ci->client_playas = playas;

   364

		ttd_strlcpy(ci->client_name, name, sizeof(ci->client_name));

   365

   366

		InvalidateWindow(WC_CLIENT_LIST, 0);

   367

   368

		return NETWORK_RECV_STATUS_OKAY;

   369

	}

   370

   371

	// We don't have this index yet, find an empty index, and put the data there

   372

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   373

	if (ci != NULL) {

   374

		ci->client_index = index;

   375

		ci->client_playas = playas;

   376

   377

		ttd_strlcpy(ci->client_name, name, sizeof(ci->client_name));

   378

		ttd_strlcpy(ci->unique_id, unique_id, sizeof(ci->unique_id));

   379

   380

		InvalidateWindow(WC_CLIENT_LIST, 0);

   381

   382

		return NETWORK_RECV_STATUS_OKAY;

   383

	}

   384

   385

	// Here the program should never ever come.....

   386

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   387

}

   388

   389

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   390

{

   391

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   392

   393

	if (error == NETWORK_ERROR_NOT_AUTHORIZED || error == NETWORK_ERROR_NOT_EXPECTED ||

   394

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   395

		// We made an error in the protocol, and our connection is closed.... :(

   396

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   397

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   398

		// Wrong revision :(

   399

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   400

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   401

		// Wrong password

   402

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   403

	} else if (error == NETWORK_ERROR_KICKED) {

   404

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   405

	} else if (error == NETWORK_ERROR_CHEATER) {

   406

		_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   407

	}

   408

   409

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   410

   411

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   412

}

   413

   414

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   415

{

   416

	NetworkPasswordType type;

   417

	type = NetworkRecv_uint8(MY_CLIENT, p);

   418

   419

	if (type == NETWORK_GAME_PASSWORD) {

   420

		ShowNetworkNeedGamePassword();

   421

		return NETWORK_RECV_STATUS_OKAY;

   422

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   423

		ShowNetworkNeedCompanyPassword();

   424

		return NETWORK_RECV_STATUS_OKAY;

   425

	}

   426

   427

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   428

}

   429

   430

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   431

{

   432

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   433

   434

	// Start receiving the map

   435

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   436

	return NETWORK_RECV_STATUS_OKAY;

   437

}

   438

   439

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   440

{

   441

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   442

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   443

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   444

   445

	// We are put on hold for receiving the map.. we need GUI for this ;)

   446

	DEBUG(net, 1)("[NET] The server is currently busy sending the map to someone else.. please hold..." );

   447

	DEBUG(net, 1)("[NET]  There are %d clients in front of you", _network_join_waiting);

   448

   449

	return NETWORK_RECV_STATUS_OKAY;

   450

}

   451

   452

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   453

{

   454

	static char filename[256];

   455

	static FILE *file_pointer;

   456

   457

	byte maptype;

   458

   459

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   460

   461

	if (MY_CLIENT->quited)

   462

		return NETWORK_RECV_STATUS_CONN_LOST;

   463

   464

	// First packet, init some stuff

   465

	if (maptype == MAP_PACKET_START) {

   466

		// The name for the temp-map

   467

		sprintf(filename, "%s%snetwork_client.tmp",  _path.autosave_dir, PATHSEP);

   468

   469

		file_pointer = fopen(filename, "wb");

   470

		if (file_pointer == NULL) {

   471

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   472

			return NETWORK_RECV_STATUS_SAVEGAME;

   473

		}

   474

   475

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(MY_CLIENT, p);

   476

   477

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   478

		_network_join_kbytes = 0;

   479

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   480

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   481

   482

		// The first packet does not contain any more data

   483

		return NETWORK_RECV_STATUS_OKAY;

   484

	}

   485

   486

	if (maptype == MAP_PACKET_NORMAL) {

   487

		// We are still receiving data, put it to the file

   488

		fwrite(p->buffer + p->pos, 1, p->size - p->pos, file_pointer);

   489

   490

		_network_join_kbytes = ftell(file_pointer) / 1024;

   491

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   492

	}

   493

   494

	if (maptype == MAP_PACKET_PATCH) {

   495

		NetworkRecvPatchSettings(MY_CLIENT, p);

   496

	}

   497

   498

	// Check if this was the last packet

   499

	if (maptype == MAP_PACKET_END) {

   500

		// We also get, very nice, the player_seeds in this packet

   501

		int i;

   502

		for (i = 0; i < MAX_PLAYERS; i++) {

   503

			_player_seeds[i][0] = NetworkRecv_uint32(MY_CLIENT, p);

   504

			_player_seeds[i][1] = NetworkRecv_uint32(MY_CLIENT, p);

   505

		}

   506

   507

		fclose(file_pointer);

   508

   509

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   510

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   511

   512

		// The map is done downloading, load it

   513

		// Load the map

   514

		if (!SafeSaveOrLoad(filename, SL_LOAD, GM_NORMAL)) {

   515

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   516

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   517

			return NETWORK_RECV_STATUS_SAVEGAME;

   518

		}