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

	//

    57

    58

#if defined(WITH_REV)

    59

		extern char _openttd_revision[];

    60

#else

    61

		const char _openttd_revision[] = "norev000";

    62

#endif

    63

	Packet *p;

    64

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    65

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    66

    67

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    68

	NetworkSend_string(p, _openttd_revision);

    69

	NetworkSend_string(p, _network_player_name); // Player name

    70

	NetworkSend_uint8(p, _network_playas); // Password

    71

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    72

	NetworkSend_Packet(p, MY_CLIENT);

    73

}

    74

    75

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

    76

{

    77

	//

    78

	// Packet: CLIENT_PASSWORD

    79

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

    80

	// Data:

    81

	//    uint8:  NetworkPasswordType

    82

	//    String: Password

    83

	//

    84

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    85

	NetworkSend_uint8(p, type);

    86

	NetworkSend_string(p, password);

    87

	NetworkSend_Packet(p, MY_CLIENT);

    88

}

    89

    90

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    91

{

    92

	//

    93

	// Packet: CLIENT_GETMAP

    94

	// Function: Request the map from the server

    95

	// Data:

    96

	//    <none>

    97

	//

    98

    99

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   100

	NetworkSend_Packet(p, MY_CLIENT);

   101

}

   102

   103

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   104

{

   105

	//

   106

	// Packet: CLIENT_MAP_OK

   107

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

   108

	// Data:

   109

	//    <none>

   110

	//

   111

   112

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   113

	NetworkSend_Packet(p, MY_CLIENT);

   114

}

   115

   116

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   117

{

   118

	//

   119

	// Packet: CLIENT_ACK

   120

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

   121

	// Data:

   122

	//    uint32: current FrameCounter of the client

   123

	//

   124

   125

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   126

   127

	NetworkSend_uint32(p, _frame_counter);

   128

	NetworkSend_Packet(p, MY_CLIENT);

   129

}

   130

   131

// Send a command packet to the server

   132

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   133

{

   134

	//

   135

	// Packet: CLIENT_COMMAND

   136

	// Function: Send a DoCommand to the Server

   137

	// Data:

   138

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

   139

	//    uint32: CommandID (see command.h)

   140

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

   141

	//    uint32: P2

   142

	//    uint32: Tile

   143

	//    uint32: decode_params

   144

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

   145

	//    uint8:  CallBackID (see callback_table.c)

   146

	//

   147

   148

	int i;

   149

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   150

   151

	NetworkSend_uint8(p, cp->player);

   152

	NetworkSend_uint32(p, cp->cmd);

   153

	NetworkSend_uint32(p, cp->p1);

   154

	NetworkSend_uint32(p, cp->p2);

   155

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

   156

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

   157

		NetworkSend_uint32(p, cp->dp[i]);

   158

	}

   159

	NetworkSend_uint8(p, cp->callback);

   160

   161

	NetworkSend_Packet(p, MY_CLIENT);

   162

}

   163

   164

// Send a chat-packet over the network

   165

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

   166

{

   167

	//

   168

	// Packet: CLIENT_CHAT

   169

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

   170

	// Data:

   171

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

   172

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

   173

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

   174

	//    String: Message (max MAX_TEXT_MSG_LEN)

   175

	//

   176

   177

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   178

   179

	NetworkSend_uint8(p, action);

   180

	NetworkSend_uint8(p, desttype);

   181

	NetworkSend_uint8(p, dest);

   182

	NetworkSend_string(p, msg);

   183

	NetworkSend_Packet(p, MY_CLIENT);

   184

}

   185

   186

// Send an error-packet over the network

   187

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   188

{

   189

	//

   190

	// Packet: CLIENT_ERROR

   191

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

   192

	// Data:

   193

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

   194

	//

   195

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   196

   197

	NetworkSend_uint8(p, errorno);

   198

	NetworkSend_Packet(p, MY_CLIENT);

   199

}

   200

   201

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   202

{

   203

	//

   204

	// Packet: PACKET_CLIENT_SET_PASSWORD

   205

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

   206

	// Data:

   207

	//    String: Password

   208

	//

   209

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   210

   211

	NetworkSend_string(p, password);

   212

	NetworkSend_Packet(p, MY_CLIENT);

   213

}

   214

   215

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   216

{

   217

	//

   218

	// Packet: PACKET_CLIENT_SET_NAME

   219

	// Function: Gives the player a new name

   220

	// Data:

   221

	//    String: Name

   222

	//

   223

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   224

   225

	NetworkSend_string(p, name);

   226

	NetworkSend_Packet(p, MY_CLIENT);

   227

}

   228

   229

// Send an quit-packet over the network

   230

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   231

{

   232

	//

   233

	// Packet: CLIENT_QUIT

   234

	// Function: The client is quiting the game

   235

	// Data:

   236

	//    String: leave-message

   237

	//

   238

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   239

   240

	NetworkSend_string(p, leavemsg);

   241

	NetworkSend_Packet(p, MY_CLIENT);

   242

}

   243

   244

   245

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

   246

// Receiving functions

   247

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   248

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

   249

   250

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

   251

   252

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   253

{

   254

	// We try to join a server which is full

   255

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   256

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   257

   258

	return NETWORK_RECV_STATUS_SERVER_FULL;

   259

}

   260

   261

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   262

{

   263

	byte company_info_version;

   264

	int i;

   265

   266

	company_info_version = NetworkRecv_uint8(p);

   267

   268

	if (company_info_version == 1) {

   269

		byte total;

   270

		byte current;

   271

   272

		total = NetworkRecv_uint8(p);

   273

		_network_lobby_company_count = total;

   274

   275

		// There is no data at all..

   276

		if (total == 0)

   277

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   278

   279

		current = NetworkRecv_uint8(p) - 1;

   280

		if (current >= MAX_PLAYERS)

   281

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   282

   283

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

   284

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

   285

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

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

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

   293

   294

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

   295

   296

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   297

   298

		if (total == current + 1)

   299

			// This was the last one

   300

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   301

		else

   302

			return NETWORK_RECV_STATUS_OKAY;

   303

	}

   304

   305

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   306

}

   307

   308

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

   309

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

   310

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

   311

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   312

{

   313

	NetworkClientInfo *ci;

   314

	uint16 index = NetworkRecv_uint16(p);

   315

   316

	ci = NetworkFindClientInfoFromIndex(index);

   317

	if (ci != NULL) {

   318

		byte playas;

   319

		char name[NETWORK_NAME_LENGTH];

   320

   321

		playas = NetworkRecv_uint8(p);

   322

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

   323

   324

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

   325

			// Client name changed, display the change

   326

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

   327

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

   328

			// The player changed from client-player..

   329

			// Do not display that for now

   330

		}

   331

   332

		ci->client_playas = playas;

   333

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

   334

		return NETWORK_RECV_STATUS_OKAY;

   335

	}

   336

   337

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

   338

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   339

	if (ci != NULL) {

   340

		ci->client_index = index;

   341

		ci->client_playas = NetworkRecv_uint8(p);

   342

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

   343

		return NETWORK_RECV_STATUS_OKAY;

   344

	}

   345

   346

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

   347

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   348

}

   349

   350

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   351

{

   352

	NetworkErrorCode error = NetworkRecv_uint8(p);

   353

   354

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

   355

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   356

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

   357

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   358

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   359

		// Wrong revision :(

   360

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   361

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   362

		// Wrong password

   363

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   364

	} else if (error == NETWORK_ERROR_KICKED) {

   365

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   366

	}

   367

   368

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   369

   370

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   371

}

   372

   373

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   374

{

   375

	NetworkPasswordType type;

   376

	type = NetworkRecv_uint8(p);

   377

   378

	if (type == NETWORK_GAME_PASSWORD) {

   379

		ShowNetworkNeedGamePassword();

   380

		return NETWORK_RECV_STATUS_OKAY;

   381

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   382

		ShowNetworkNeedCompanyPassword();

   383

		return NETWORK_RECV_STATUS_OKAY;

   384

	}

   385

   386

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   387

}

   388

   389

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   390

{

   391

	_network_own_client_index = NetworkRecv_uint16(p);

   392

   393

	// Start receiving the map

   394

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   395

	return NETWORK_RECV_STATUS_OKAY;

   396

}

   397

   398

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   399

{

   400

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   401

	_network_join_waiting = NetworkRecv_uint8(p);

   402

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   403

   404

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

   405

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

   406

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

   407

   408

	return NETWORK_RECV_STATUS_OKAY;

   409

}

   410

   411

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   412

{

   413

	static char filename[256];

   414

	static FILE *file_pointer;

   415

   416

	byte maptype;

   417

   418

	maptype = NetworkRecv_uint8(p);

   419

   420

	// First packet, init some stuff

   421

	if (maptype == MAP_PACKET_START) {

   422

		// The name for the temp-map

   423

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

   424

   425

		file_pointer = fopen(filename, "wb");

   426

		if (file_pointer == NULL) {

   427

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   428

			return NETWORK_RECV_STATUS_SAVEGAME;

   429

		}

   430

   431

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(p);

   432

   433

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   434

		_network_join_kbytes = 0;

   435

		_network_join_kbytes_total = NetworkRecv_uint32(p) / 1024;

   436

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   437

   438

		// The first packet does not contain any more data

   439

		return NETWORK_RECV_STATUS_OKAY;

   440

	}

   441

   442

	if (maptype == MAP_PACKET_NORMAL) {

   443

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

   444

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

   445

   446

		_network_join_kbytes = ftell(file_pointer) / 1024;

   447

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   448

	}

   449

   450

	if (maptype == MAP_PACKET_PATCH) {

   451

		NetworkRecvPatchSettings(p);

   452

	}

   453

   454

	// Check if this was the last packet

   455

	if (maptype == MAP_PACKET_END) {

   456

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

   457

		int i;

   458

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

   459

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

   460

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

   461

		}

   462

   463

		fclose(file_pointer);

   464

   465

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   466

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   467

   468

		// The map is done downloading, load it

   469

		// Load the map

   470

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

   471

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   472

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   473

			return NETWORK_RECV_STATUS_SAVEGAME;

   474

		}

   475

		_opt_mod_ptr = &_opt;

   476

   477

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   478

   479

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

   480

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   481

   482

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

   483

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

   484

   485

			if (_network_playas == OWNER_SPECTATOR) {

   486

				// The client wants to be a spectator..

   487

				_local_player = OWNER_SPECTATOR;

   488

			} else {

   489

				// send a command to make a new player

   490

				_local_player = 0;

   491

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

   492

				_local_player = OWNER_SPECTATOR;

   493

			}

   494

		} else {

   495

			// take control over an existing company

   496

			_local_player = _network_playas - 1;

   497

		}

   498

   499

		// Remeber the player

   500

		if (_local_player != OWNER_SPECTATOR)

   501

			_network_playas = _local_player + 1;

   502

		else

   503

			_network_playas = OWNER_SPECTATOR;

   504

	}

   505

   506

	return NETWORK_RECV_STATUS_OKAY;

   507

}

   508

   509

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FRAME)

   510

{

   511

	_frame_counter_server = NetworkRecv_uint32(p);

   512

	_frame_counter_max = NetworkRecv_uint32(p);

   513

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   514

	// Test if the server supports this option

   515

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

   516

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

   517

		_sync_frame = _frame_counter_server;

   518

		_sync_seed_1 = NetworkRecv_uint32(p);

   519

#ifdef NETWORK_SEND_DOUBLE_SEED

   520

		_sync_seed_2 = NetworkRecv_uint32(p);

   521

#endif

   522

	}

   523

#endif

   524

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

   525

   526

	// Let the server know that we received this frame correctly

   527

	//  We do this only once per day, to save some bandwidth ;)

   528

	if (!_network_first_time && last_ack_frame < _frame_counter) {

   529

		last_ack_frame = _frame_counter + DAY_TICKS;

   530

		DEBUG(net,6)("[NET] Sent ACK at %d", _frame_counter);