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

#ifdef WITH_REV_HACK

    60

	#define WITH_REV

    61

	const char _openttd_revision[] = WITH_REV_HACK;

    62

#else

    63

	#if defined(WITH_REV)

    64

		extern char _openttd_revision[];

    65

	#else

    66

		const char _openttd_revision[] = "norev000";

    67

	#endif

    68

#endif

    69

	Packet *p;

    70

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    71

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    72

    73

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    74

	NetworkSend_string(p, _openttd_revision);

    75

	NetworkSend_string(p, _network_player_name); // Player name

    76

	NetworkSend_uint8(p, _network_playas); // Password

    77

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    78

	NetworkSend_string(p, _network_unique_id);

    79

	NetworkSend_Packet(p, MY_CLIENT);

    80

}

    81

    82

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

    83

{

    84

	//

    85

	// Packet: CLIENT_PASSWORD

    86

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

    87

	// Data:

    88

	//    uint8:  NetworkPasswordType

    89

	//    String: Password

    90

	//

    91

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    92

	NetworkSend_uint8(p, type);

    93

	NetworkSend_string(p, password);

    94

	NetworkSend_Packet(p, MY_CLIENT);

    95

}

    96

    97

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    98

{

    99

	//

   100

	// Packet: CLIENT_GETMAP

   101

	// Function: Request the map from the server

   102

	// Data:

   103

	//    <none>

   104

	//

   105

   106

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   107

	NetworkSend_Packet(p, MY_CLIENT);

   108

}

   109

   110

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   111

{

   112

	//

   113

	// Packet: CLIENT_MAP_OK

   114

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

   115

	// Data:

   116

	//    <none>

   117

	//

   118

   119

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   120

	NetworkSend_Packet(p, MY_CLIENT);

   121

}

   122

   123

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   124

{

   125

	//

   126

	// Packet: CLIENT_ACK

   127

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

   128

	// Data:

   129

	//    uint32: current FrameCounter of the client

   130

	//

   131

   132

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   133

   134

	NetworkSend_uint32(p, _frame_counter);

   135

	NetworkSend_Packet(p, MY_CLIENT);

   136

}

   137

   138

// Send a command packet to the server

   139

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   140

{

   141

	//

   142

	// Packet: CLIENT_COMMAND

   143

	// Function: Send a DoCommand to the Server

   144

	// Data:

   145

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

   146

	//    uint32: CommandID (see command.h)

   147

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

   148

	//    uint32: P2

   149

	//    uint32: Tile

   150

	//    uint32: decode_params

   151

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

   152

	//    uint8:  CallBackID (see callback_table.c)

   153

	//

   154

   155

	int i;

   156

	char *dparam_char;

   157

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   158

   159

	NetworkSend_uint8(p, cp->player);

   160

	NetworkSend_uint32(p, cp->cmd);

   161

	NetworkSend_uint32(p, cp->p1);

   162

	NetworkSend_uint32(p, cp->p2);

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

		NetworkSend_uint8(p, *dparam_char);

   170

		dparam_char++;

   171

	}

   172

	NetworkSend_uint8(p, cp->callback);

   173

   174

	NetworkSend_Packet(p, MY_CLIENT);

   175

}

   176

   177

// Send a chat-packet over the network

   178

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

   179

{

   180

	//

   181

	// Packet: CLIENT_CHAT

   182

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

   183

	// Data:

   184

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

   185

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

   186

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

   187

	//    String: Message (max MAX_TEXT_MSG_LEN)

   188

	//

   189

   190

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   191

   192

	NetworkSend_uint8(p, action);

   193

	NetworkSend_uint8(p, desttype);

   194

	NetworkSend_uint8(p, dest);

   195

	NetworkSend_string(p, msg);

   196

	NetworkSend_Packet(p, MY_CLIENT);

   197

}

   198

   199

// Send an error-packet over the network

   200

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   201

{

   202

	//

   203

	// Packet: CLIENT_ERROR

   204

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

   205

	// Data:

   206

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

   207

	//

   208

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   209

   210

	NetworkSend_uint8(p, errorno);

   211

	NetworkSend_Packet(p, MY_CLIENT);

   212

}

   213

   214

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   215

{

   216

	//

   217

	// Packet: PACKET_CLIENT_SET_PASSWORD

   218

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

   219

	// Data:

   220

	//    String: Password

   221

	//

   222

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   223

   224

	NetworkSend_string(p, password);

   225

	NetworkSend_Packet(p, MY_CLIENT);

   226

}

   227

   228

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   229

{

   230

	//

   231

	// Packet: PACKET_CLIENT_SET_NAME

   232

	// Function: Gives the player a new name

   233

	// Data:

   234

	//    String: Name

   235

	//

   236

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   237

   238

	NetworkSend_string(p, name);

   239

	NetworkSend_Packet(p, MY_CLIENT);

   240

}

   241

   242

// Send an quit-packet over the network

   243

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   244

{

   245

	//

   246

	// Packet: CLIENT_QUIT

   247

	// Function: The client is quiting the game

   248

	// Data:

   249

	//    String: leave-message

   250

	//

   251

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   252

   253

	NetworkSend_string(p, leavemsg);

   254

	NetworkSend_Packet(p, MY_CLIENT);

   255

}

   256

   257

   258

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

   259

// Receiving functions

   260

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   261

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

   262

   263

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

   264

   265

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   266

{

   267

	// We try to join a server which is full

   268

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   269

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   270

   271

	return NETWORK_RECV_STATUS_SERVER_FULL;

   272

}

   273

   274

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   275

{

   276

	byte company_info_version;

   277

	int i;

   278

   279

	company_info_version = NetworkRecv_uint8(p);

   280

   281

	if (company_info_version == 1) {

   282

		byte total;

   283

		byte current;

   284

   285

		total = NetworkRecv_uint8(p);

   286

		_network_lobby_company_count = total;

   287

   288

		// There is no data at all..

   289

		if (total == 0)

   290

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   291

   292

		current = NetworkRecv_uint8(p) - 1;

   293

		if (current >= MAX_PLAYERS)

   294

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   295

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

   307

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

   308

   309

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   310

   311

		if (total == current + 1)

   312

			// This was the last one

   313

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   314

		else

   315

			return NETWORK_RECV_STATUS_OKAY;

   316

	}

   317

   318

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   319

}

   320

   321

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

   322

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

   323

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

   324

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   325

{

   326

	NetworkClientInfo *ci;

   327

	uint16 index = NetworkRecv_uint16(p);

   328

   329

	ci = NetworkFindClientInfoFromIndex(index);

   330

	if (ci != NULL) {

   331

		byte playas;

   332

		char name[NETWORK_NAME_LENGTH];

   333

   334

		playas = NetworkRecv_uint8(p);

   335

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

   336

   337

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

   338

			// Client name changed, display the change

   339

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

   340

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

   341

			// The player changed from client-player..

   342

			// Do not display that for now

   343

		}

   344

   345

		ci->client_playas = playas;

   346

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

   347

		return NETWORK_RECV_STATUS_OKAY;

   348

	}

   349

   350

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

   351

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   352

	if (ci != NULL) {

   353

		ci->client_index = index;

   354

		ci->client_playas = NetworkRecv_uint8(p);

   355

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

   356

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

   357

		return NETWORK_RECV_STATUS_OKAY;

   358

	}

   359

   360

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

   361

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   362

}

   363

   364

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   365

{

   366

	NetworkErrorCode error = NetworkRecv_uint8(p);

   367

   368

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

   369

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   370

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

   371

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   372

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   373

		// Wrong revision :(

   374

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   375

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   376

		// Wrong password

   377

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   378

	} else if (error == NETWORK_ERROR_KICKED) {

   379

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   380

	}

   381

   382

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   383

   384

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   385

}

   386

   387

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   388

{

   389

	NetworkPasswordType type;

   390

	type = NetworkRecv_uint8(p);

   391

   392

	if (type == NETWORK_GAME_PASSWORD) {

   393

		ShowNetworkNeedGamePassword();

   394

		return NETWORK_RECV_STATUS_OKAY;

   395

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   396

		ShowNetworkNeedCompanyPassword();

   397

		return NETWORK_RECV_STATUS_OKAY;

   398

	}

   399

   400

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   401

}

   402

   403

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   404

{

   405

	_network_own_client_index = NetworkRecv_uint16(p);

   406

   407

	// Start receiving the map

   408

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   409

	return NETWORK_RECV_STATUS_OKAY;

   410

}

   411

   412

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   413

{

   414

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   415

	_network_join_waiting = NetworkRecv_uint8(p);

   416

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   417

   418

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

   419

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

   420

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

   421

   422

	return NETWORK_RECV_STATUS_OKAY;

   423

}

   424

   425

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   426

{

   427

	static char filename[256];

   428

	static FILE *file_pointer;

   429

   430

	byte maptype;

   431

   432

	maptype = NetworkRecv_uint8(p);

   433

   434

	// First packet, init some stuff

   435

	if (maptype == MAP_PACKET_START) {

   436

		// The name for the temp-map

   437

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

   438

   439

		file_pointer = fopen(filename, "wb");

   440

		if (file_pointer == NULL) {

   441

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   442

			return NETWORK_RECV_STATUS_SAVEGAME;

   443

		}

   444

   445

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(p);

   446

   447

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   448

		_network_join_kbytes = 0;

   449

		_network_join_kbytes_total = NetworkRecv_uint32(p) / 1024;

   450

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   451

   452

		// The first packet does not contain any more data

   453

		return NETWORK_RECV_STATUS_OKAY;

   454

	}

   455

   456

	if (maptype == MAP_PACKET_NORMAL) {

   457

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

   458

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

   459

   460

		_network_join_kbytes = ftell(file_pointer) / 1024;

   461

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   462

	}

   463

   464

	if (maptype == MAP_PACKET_PATCH) {

   465

		NetworkRecvPatchSettings(p);

   466

	}

   467

   468

	// Check if this was the last packet

   469

	if (maptype == MAP_PACKET_END) {

   470

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

   471

		int i;

   472

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

   473

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

   474

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

   475

		}

   476

   477

		fclose(file_pointer);

   478

   479

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   480

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   481

   482

		// The map is done downloading, load it

   483

		// Load the map

   484

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

   485

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   486

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   487

			return NETWORK_RECV_STATUS_SAVEGAME;

   488

		}

   489

		_opt_mod_ptr = &_opt;

   490

   491

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   492

   493

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

   494

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   495

   496

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

   497

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

   498

   499

			if (_network_playas == OWNER_SPECTATOR) {

   500

				// The client wants to be a spectator..

   501

				_local_player = OWNER_SPECTATOR;

   502

			} else {

   503

				// send a command to make a new player

   504

				_local_player = 0;

   505

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

   506

				_local_player = OWNER_SPECTATOR;

   507

			}

   508

		} else {

   509

			// take control over an existing company

   510

			_local_player = _network_playas - 1;

   511

		}

   512

   513

		// Remeber the player

   514

		if (_local_player != OWNER_SPECTATOR)

   515

			_network_playas = _local_player + 1;

   516

		else

   517

			_network_playas = OWNER_SPECTATOR;

   518

	}

   519

   520

	return NETWORK_RECV_STATUS_OKAY;

   521

}

   522

   523

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FRAME)

   524

{

   525

	_frame_counter_server = NetworkRecv_uint32(p);

   526

	_frame_counter_max = NetworkRecv_uint32(p);

   527

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME