1

#include "stdafx.h"

     2

#include "network_data.h"

     3

     4

#ifdef ENABLE_NETWORK

     5

     6

#include "table/strings.h"

     7

#include "network_client.h"

     8

#include "network_gamelist.h"

     9

#include "command.h"

    10

#include "gfx.h"

    11

#include "window.h"

    12

#include "settings.h"

    13

    14

    15

// This file handles all the client-commands

    16

    17

    18

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

    19

#define MY_CLIENT DEREF_CLIENT(0)

    20

    21

static uint32 last_ack_frame;

    22

    23

void NetworkRecvPatchSettings(Packet *p);

    24

    25

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

    26

// Sending functions

    27

//   DEF_CLIENT_SEND_COMMAND has no parameters

    28

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

    29

    30

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    31

{

    32

	//

    33

	// Packet: CLIENT_COMPANY_INFO

    34

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

    35

	// Data:

    36

	//    <none>

    37

	//

    38

	Packet *p;

    39

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    40

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    41

    42

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    43

	NetworkSend_Packet(p, MY_CLIENT);

    44

}

    45

    46

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    47

{

    48

	//

    49

	// Packet: CLIENT_JOIN

    50

	// Function: Try to join the server

    51

	// Data:

    52

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

    53

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    54

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

    55

	//    uint8:  Language ID

    56

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

    57

	//

    58

    59

	Packet *p;

    60

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    61

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    62

    63

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    64

	NetworkSend_string(p, _openttd_revision);

    65

	NetworkSend_string(p, _network_player_name); // Player name

    66

	NetworkSend_uint8(p, _network_playas); // Password

    67

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    68

	NetworkSend_string(p, _network_unique_id);

    69

	NetworkSend_Packet(p, MY_CLIENT);

    70

}

    71

    72

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

    73

{

    74

	//

    75

	// Packet: CLIENT_PASSWORD

    76

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

    77

	// Data:

    78

	//    uint8:  NetworkPasswordType

    79

	//    String: Password

    80

	//

    81

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    82

	NetworkSend_uint8(p, type);

    83

	NetworkSend_string(p, password);

    84

	NetworkSend_Packet(p, MY_CLIENT);

    85

}

    86

    87

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    88

{

    89

	//

    90

	// Packet: CLIENT_GETMAP

    91

	// Function: Request the map from the server

    92

	// Data:

    93

	//    <none>

    94

	//

    95

    96

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

    97

	NetworkSend_Packet(p, MY_CLIENT);

    98

}

    99

   100

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   101

{

   102

	//

   103

	// Packet: CLIENT_MAP_OK

   104

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

   105

	// Data:

   106

	//    <none>

   107

	//

   108

   109

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   110

	NetworkSend_Packet(p, MY_CLIENT);

   111

}

   112

   113

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   114

{

   115

	//

   116

	// Packet: CLIENT_ACK

   117

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

   118

	// Data:

   119

	//    uint32: current FrameCounter of the client

   120

	//

   121

   122

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   123

   124

	NetworkSend_uint32(p, _frame_counter);

   125

	NetworkSend_Packet(p, MY_CLIENT);

   126

}

   127

   128

// Send a command packet to the server

   129

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   130

{

   131

	//

   132

	// Packet: CLIENT_COMMAND

   133

	// Function: Send a DoCommand to the Server

   134

	// Data:

   135

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

   136

	//    uint32: CommandID (see command.h)

   137

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

   138

	//    uint32: P2

   139

	//    uint32: Tile

   140

	//    uint32: decode_params

   141

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

   142

	//    uint8:  CallBackID (see callback_table.c)

   143

	//

   144

   145

	int i;

   146

	char *dparam_char;

   147

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   148

   149

	NetworkSend_uint8(p, cp->player);

   150

	NetworkSend_uint32(p, cp->cmd);

   151

	NetworkSend_uint32(p, cp->p1);

   152

	NetworkSend_uint32(p, cp->p2);

   153

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

   154

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

   155

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

   156

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

   157

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

   158

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

   159

		NetworkSend_uint8(p, *dparam_char);

   160

		dparam_char++;

   161

	}

   162

	NetworkSend_uint8(p, cp->callback);

   163

   164

	NetworkSend_Packet(p, MY_CLIENT);

   165

}

   166

   167

// Send a chat-packet over the network

   168

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

   169

{

   170

	//

   171

	// Packet: CLIENT_CHAT

   172

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

   173

	// Data:

   174

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

   175

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

   176

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

   177

	//    String: Message (max MAX_TEXT_MSG_LEN)

   178

	//

   179

   180

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   181

   182

	NetworkSend_uint8(p, action);

   183

	NetworkSend_uint8(p, desttype);

   184

	NetworkSend_uint8(p, dest);

   185

	NetworkSend_string(p, msg);

   186

	NetworkSend_Packet(p, MY_CLIENT);

   187

}

   188

   189

// Send an error-packet over the network

   190

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   191

{

   192

	//

   193

	// Packet: CLIENT_ERROR

   194

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

   195

	// Data:

   196

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

   197

	//

   198

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   199

   200

	NetworkSend_uint8(p, errorno);

   201

	NetworkSend_Packet(p, MY_CLIENT);

   202

}

   203

   204

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   205

{

   206

	//

   207

	// Packet: PACKET_CLIENT_SET_PASSWORD

   208

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

   209

	// Data:

   210

	//    String: Password

   211

	//

   212

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   213

   214

	NetworkSend_string(p, password);

   215

	NetworkSend_Packet(p, MY_CLIENT);

   216

}

   217

   218

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   219

{

   220

	//

   221

	// Packet: PACKET_CLIENT_SET_NAME

   222

	// Function: Gives the player a new name

   223

	// Data:

   224

	//    String: Name

   225

	//

   226

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   227

   228

	NetworkSend_string(p, name);

   229

	NetworkSend_Packet(p, MY_CLIENT);

   230

}

   231

   232

// Send an quit-packet over the network

   233

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   234

{

   235

	//

   236

	// Packet: CLIENT_QUIT

   237

	// Function: The client is quiting the game

   238

	// Data:

   239

	//    String: leave-message

   240

	//

   241

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   242

   243

	NetworkSend_string(p, leavemsg);

   244

	NetworkSend_Packet(p, MY_CLIENT);

   245

}

   246

   247

   248

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

   249

// Receiving functions

   250

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   251

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

   252

   253

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

   254

   255

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   256

{

   257

	// We try to join a server which is full

   258

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   259

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   260

   261

	return NETWORK_RECV_STATUS_SERVER_FULL;

   262

}

   263

   264

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   265

{

   266

	byte company_info_version;

   267

	int i;

   268

   269

	company_info_version = NetworkRecv_uint8(p);

   270

   271

	if (company_info_version == 1) {

   272

		byte total;

   273

		byte current;

   274

   275

		total = NetworkRecv_uint8(p);

   276

		_network_lobby_company_count = total;

   277

   278

		// There is no data at all..

   279

		if (total == 0)

   280

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   281

   282

		current = NetworkRecv_uint8(p) - 1;

   283

		if (current >= MAX_PLAYERS)

   284

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   285

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

   297

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

   298

   299

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   300

   301

		if (total == current + 1)

   302

			// This was the last one

   303

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   304

		else

   305

			return NETWORK_RECV_STATUS_OKAY;

   306

	}

   307

   308

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   309

}

   310

   311

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

   312

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

   313

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

   314

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   315

{

   316

	NetworkClientInfo *ci;

   317

	uint16 index = NetworkRecv_uint16(p);

   318

   319

	ci = NetworkFindClientInfoFromIndex(index);

   320

	if (ci != NULL) {

   321

		byte playas;

   322

		char name[NETWORK_NAME_LENGTH];

   323

   324

		playas = NetworkRecv_uint8(p);

   325

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

   326

   327

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

   328

			// Client name changed, display the change

   329

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

   330

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

   331

			// The player changed from client-player..

   332

			// Do not display that for now

   333

		}

   334

   335

		ci->client_playas = playas;

   336

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

   337

		return NETWORK_RECV_STATUS_OKAY;

   338

	}

   339

   340

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

   341

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   342

	if (ci != NULL) {

   343

		ci->client_index = index;

   344

		ci->client_playas = NetworkRecv_uint8(p);

   345

		NetworkRecv_string(p, ci->client_name, sizeof(ci->client_name));

   346

		NetworkRecv_string(p, ci->unique_id, sizeof(ci->unique_id));

   347

		return NETWORK_RECV_STATUS_OKAY;

   348

	}

   349

   350

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

   351

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   352

}

   353

   354

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   355

{

   356

	NetworkErrorCode error = NetworkRecv_uint8(p);

   357

   358

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

   359

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   360

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

   361

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   362

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   363

		// Wrong revision :(

   364

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   365

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   366

		// Wrong password

   367

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   368

	} else if (error == NETWORK_ERROR_KICKED) {

   369

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   370

	}

   371

   372

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   373

   374

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   375

}

   376

   377

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   378

{

   379

	NetworkPasswordType type;

   380

	type = NetworkRecv_uint8(p);

   381

   382

	if (type == NETWORK_GAME_PASSWORD) {

   383

		ShowNetworkNeedGamePassword();

   384

		return NETWORK_RECV_STATUS_OKAY;

   385

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   386

		ShowNetworkNeedCompanyPassword();

   387

		return NETWORK_RECV_STATUS_OKAY;

   388

	}

   389

   390

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   391

}

   392

   393

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   394

{

   395

	_network_own_client_index = NetworkRecv_uint16(p);

   396

   397

	// Start receiving the map

   398

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   399

	return NETWORK_RECV_STATUS_OKAY;

   400

}

   401

   402

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   403

{

   404

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   405

	_network_join_waiting = NetworkRecv_uint8(p);

   406

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   407

   408

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

   409

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

   410

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

   411

   412

	return NETWORK_RECV_STATUS_OKAY;

   413

}

   414

   415

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   416

{

   417

	static char filename[256];

   418

	static FILE *file_pointer;

   419

   420

	byte maptype;

   421

   422

	maptype = NetworkRecv_uint8(p);

   423

   424

	// First packet, init some stuff

   425

	if (maptype == MAP_PACKET_START) {

   426

		// The name for the temp-map

   427

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

   428

   429

		file_pointer = fopen(filename, "wb");

   430

		if (file_pointer == NULL) {

   431

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   432

			return NETWORK_RECV_STATUS_SAVEGAME;

   433

		}

   434

   435

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(p);

   436

   437

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   438

		_network_join_kbytes = 0;

   439

		_network_join_kbytes_total = NetworkRecv_uint32(p) / 1024;

   440

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   441

   442

		// The first packet does not contain any more data

   443

		return NETWORK_RECV_STATUS_OKAY;

   444

	}

   445

   446

	if (maptype == MAP_PACKET_NORMAL) {

   447

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

   448

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

   449

   450

		_network_join_kbytes = ftell(file_pointer) / 1024;

   451

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   452

	}

   453

   454

	if (maptype == MAP_PACKET_PATCH) {

   455

		NetworkRecvPatchSettings(p);

   456

	}

   457

   458

	// Check if this was the last packet

   459

	if (maptype == MAP_PACKET_END) {

   460

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

   461

		int i;

   462

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

   463

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

   464

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

   465

		}

   466

   467

		fclose(file_pointer);

   468

   469

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   470

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   471

   472

		// The map is done downloading, load it

   473

		// Load the map

   474

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

   475

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   476

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   477

			return NETWORK_RECV_STATUS_SAVEGAME;

   478

		}

   479

		_opt_mod_ptr = &_opt;

   480

   481

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   482

   483

		// Say we received the map and loaded it correctly!

   484

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   485

   486

		if (_network_playas == 0 || _network_playas > MAX_PLAYERS ||

   487

				!DEREF_PLAYER(_network_playas - 1)->is_active) {

   488

   489

			if (_network_playas == OWNER_SPECTATOR) {

   490

				// The client wants to be a spectator..

   491

				_local_player = OWNER_SPECTATOR;

   492

			} else {

   493

				// send a command to make a new player

   494

				_local_player = 0;

   495

				NetworkSend_Command(0, 0, 0, CMD_PLAYER_CTRL, NULL);

   496

				_local_player = OWNER_SPECTATOR;

   497

			}

   498

		} else {

   499

			// take control over an existing company

   500

			_local_player = _network_playas - 1;

   501

		}

   502

   503

		// Remeber the player

   504

		if (_local_player != OWNER_SPECTATOR)

   505

			_network_playas = _local_player + 1;

   506

		else

   507

			_network_playas = OWNER_SPECTATOR;

   508

	}

   509

   510

	return NETWORK_RECV_STATUS_OKAY;

   511

}

   512

   513

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FRAME)

   514

{

   515

	_frame_counter_server = NetworkRecv_uint32(p);

   516

	_frame_counter_max = NetworkRecv_uint32(p);

   517

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   518

	// Test if the server supports this option

   519

	//  and if we are at the frame the server is

   520

	if (p->pos < p->size) {

   521

		_sync_frame = _frame_counter_server;

   522

		_sync_seed_1 = NetworkRecv_uint32(p);

   523

#ifdef NETWORK_SEND_DOUBLE_SEED

   524

		_sync_seed_2 = NetworkRecv_uint32(p);

   525

#endif

   526

	}

   527

#endif

   528

	DEBUG(net, 7)("[NET] Received FRAME %d",_frame_counter_server);