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;

   150

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   151

   152

	NetworkSend_uint8(p, cp->player);

   153

	NetworkSend_uint32(p, cp->cmd);

   154

	NetworkSend_uint32(p, cp->p1);

   155

	NetworkSend_uint32(p, cp->p2);

   156

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

   164

	}

   165

	NetworkSend_uint8(p, cp->callback);

   166

   167

	NetworkSend_Packet(p, MY_CLIENT);

   168

}

   169

   170

// Send a chat-packet over the network

   171

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

   172

{

   173

	//

   174

	// Packet: CLIENT_CHAT

   175

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

   176

	// Data:

   177

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

   178

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

   179

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

   180

	//    String: Message (max MAX_TEXT_MSG_LEN)

   181

	//

   182

   183

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   184

   185

	NetworkSend_uint8(p, action);

   186

	NetworkSend_uint8(p, desttype);

   187

	NetworkSend_uint8(p, dest);

   188

	NetworkSend_string(p, msg);

   189

	NetworkSend_Packet(p, MY_CLIENT);

   190

}

   191

   192

// Send an error-packet over the network

   193

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   194

{

   195

	//

   196

	// Packet: CLIENT_ERROR

   197

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

   198

	// Data:

   199

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

   200

	//

   201

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   202

   203

	NetworkSend_uint8(p, errorno);

   204

	NetworkSend_Packet(p, MY_CLIENT);

   205

}

   206

   207

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   208

{

   209

	//

   210

	// Packet: PACKET_CLIENT_SET_PASSWORD

   211

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

   212

	// Data:

   213

	//    String: Password

   214

	//

   215

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   216

   217

	NetworkSend_string(p, password);

   218

	NetworkSend_Packet(p, MY_CLIENT);

   219

}

   220

   221

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   222

{

   223

	//

   224

	// Packet: PACKET_CLIENT_SET_NAME

   225

	// Function: Gives the player a new name

   226

	// Data:

   227

	//    String: Name

   228

	//

   229

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   230

   231

	NetworkSend_string(p, name);

   232

	NetworkSend_Packet(p, MY_CLIENT);

   233

}

   234

   235

// Send an quit-packet over the network

   236

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   237

{

   238

	//

   239

	// Packet: CLIENT_QUIT

   240

	// Function: The client is quiting the game

   241

	// Data:

   242

	//    String: leave-message

   243

	//

   244

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   245

   246

	NetworkSend_string(p, leavemsg);

   247

	NetworkSend_Packet(p, MY_CLIENT);

   248

}

   249

   250

   251

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

   252

// Receiving functions

   253

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   254

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

   255

   256

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

   257

   258

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   259

{

   260

	// We try to join a server which is full

   261

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   262

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   263

   264

	return NETWORK_RECV_STATUS_SERVER_FULL;

   265

}

   266

   267

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   268

{

   269

	byte company_info_version;

   270

	int i;

   271

   272

	company_info_version = NetworkRecv_uint8(p);

   273

   274

	if (company_info_version == 1) {

   275

		byte total;

   276

		byte current;

   277

   278

		total = NetworkRecv_uint8(p);

   279

		_network_lobby_company_count = total;

   280

   281

		// There is no data at all..

   282

		if (total == 0)

   283

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   284

   285

		current = NetworkRecv_uint8(p) - 1;

   286

		if (current >= MAX_PLAYERS)

   287

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   288

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

   300

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

   301

   302

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   303

   304

		if (total == current + 1)

   305

			// This was the last one

   306

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   307

		else

   308

			return NETWORK_RECV_STATUS_OKAY;

   309

	}

   310

   311

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   312

}

   313

   314

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

   315

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

   316

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

   317

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   318

{

   319

	NetworkClientInfo *ci;

   320

	uint16 index = NetworkRecv_uint16(p);

   321

   322

	ci = NetworkFindClientInfoFromIndex(index);

   323

	if (ci != NULL) {

   324

		byte playas;

   325

		char name[NETWORK_NAME_LENGTH];

   326

   327

		playas = NetworkRecv_uint8(p);

   328

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

   329

   330

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

   331

			// Client name changed, display the change

   332

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

   333

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

   334

			// The player changed from client-player..

   335

			// Do not display that for now

   336

		}

   337

   338

		ci->client_playas = playas;

   339

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

   340

		return NETWORK_RECV_STATUS_OKAY;

   341

	}

   342

   343

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

   344

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   345

	if (ci != NULL) {

   346

		ci->client_index = index;

   347

		ci->client_playas = NetworkRecv_uint8(p);

   348

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

   349

		return NETWORK_RECV_STATUS_OKAY;

   350

	}

   351

   352

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

   353

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   354

}

   355

   356

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   357

{

   358

	NetworkErrorCode error = NetworkRecv_uint8(p);

   359

   360

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

   361

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   362

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

   363

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   364

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   365

		// Wrong revision :(

   366

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   367

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   368

		// Wrong password

   369

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   370

	} else if (error == NETWORK_ERROR_KICKED) {

   371

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   372

	}

   373

   374

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   375

   376

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   377

}

   378

   379

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   380

{

   381

	NetworkPasswordType type;

   382

	type = NetworkRecv_uint8(p);

   383

   384

	if (type == NETWORK_GAME_PASSWORD) {

   385

		ShowNetworkNeedGamePassword();

   386

		return NETWORK_RECV_STATUS_OKAY;

   387

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   388

		ShowNetworkNeedCompanyPassword();

   389

		return NETWORK_RECV_STATUS_OKAY;

   390

	}

   391

   392

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   393

}

   394

   395

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   396

{

   397

	_network_own_client_index = NetworkRecv_uint16(p);

   398

   399

	// Start receiving the map

   400

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   401

	return NETWORK_RECV_STATUS_OKAY;

   402

}

   403

   404

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   405

{

   406

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   407

	_network_join_waiting = NetworkRecv_uint8(p);

   408

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   409

   410

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

   411

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

   412

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

   413

   414

	return NETWORK_RECV_STATUS_OKAY;

   415

}

   416

   417

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   418

{

   419

	static char filename[256];

   420

	static FILE *file_pointer;

   421

   422

	byte maptype;

   423

   424

	maptype = NetworkRecv_uint8(p);

   425

   426

	// First packet, init some stuff

   427

	if (maptype == MAP_PACKET_START) {

   428

		// The name for the temp-map

   429

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

   430

   431

		file_pointer = fopen(filename, "wb");

   432

		if (file_pointer == NULL) {

   433

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   434

			return NETWORK_RECV_STATUS_SAVEGAME;

   435

		}

   436

   437

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(p);

   438

   439

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   440

		_network_join_kbytes = 0;

   441

		_network_join_kbytes_total = NetworkRecv_uint32(p) / 1024;

   442

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   443

   444

		// The first packet does not contain any more data

   445

		return NETWORK_RECV_STATUS_OKAY;

   446

	}

   447

   448

	if (maptype == MAP_PACKET_NORMAL) {

   449

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

   450

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

   451

   452

		_network_join_kbytes = ftell(file_pointer) / 1024;

   453

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   454

	}

   455

   456

	if (maptype == MAP_PACKET_PATCH) {

   457

		NetworkRecvPatchSettings(p);

   458

	}

   459

   460

	// Check if this was the last packet

   461

	if (maptype == MAP_PACKET_END) {

   462

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

   463

		int i;

   464

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

   465

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

   466

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

   467

		}

   468

   469

		fclose(file_pointer);

   470

   471

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   472

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   473

   474

		// The map is done downloading, load it

   475

		// Load the map

   476

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

   477

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   478

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   479

			return NETWORK_RECV_STATUS_SAVEGAME;

   480

		}

   481

		_opt_mod_ptr = &_opt;

   482

   483

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   484

   485

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

   486

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   487

   488

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

   489

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

   490

   491

			if (_network_playas == OWNER_SPECTATOR) {

   492

				// The client wants to be a spectator..

   493

				_local_player = OWNER_SPECTATOR;

   494

			} else {

   495

				// send a command to make a new player

   496

				_local_player = 0;

   497

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

   498

				_local_player = OWNER_SPECTATOR;

   499

			}

   500

		} else {

   501

			// take control over an existing company

   502

			_local_player = _network_playas - 1;

   503

		}

   504

   505

		// Remeber the player

   506

		if (_local_player != OWNER_SPECTATOR)

   507

			_network_playas = _local_player + 1;

   508

		else

   509

			_network_playas = OWNER_SPECTATOR;

   510

	}

   511

   512

	return NETWORK_RECV_STATUS_OKAY;

   513

}

   514

   515

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FRAME)

   516

{

   517

	_frame_counter_server = NetworkRecv_uint32(p);

   518

	_frame_counter_max = NetworkRecv_uint32(p);

   519

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   520

	// Test if the server supports this option

   521

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

   522

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

   523

		_sync_frame = _frame_counter_server;

   524

		_sync_seed_1 = NetworkRecv_uint32(p);

   525

#ifdef NETWORK_SEND_DOUBLE_SEED

   526

		_sync_seed_2 = NetworkRecv_uint32(p);

   527

#endif

   528

	}