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

extern const char _openttd_revision[];

    19

    20

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

    21

#define MY_CLIENT DEREF_CLIENT(0)

    22

    23

static uint32 last_ack_frame;

    24

    25

void NetworkRecvPatchSettings(Packet *p);

    26

    27

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

    28

// Sending functions

    29

//   DEF_CLIENT_SEND_COMMAND has no parameters

    30

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

    31

    32

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    33

{

    34

	//

    35

	// Packet: CLIENT_COMPANY_INFO

    36

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

    37

	// Data:

    38

	//    <none>

    39

	//

    40

	Packet *p;

    41

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    42

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    43

    44

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    45

	NetworkSend_Packet(p, MY_CLIENT);

    46

}

    47

    48

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    49

{

    50

	//

    51

	// Packet: CLIENT_JOIN

    52

	// Function: Try to join the server

    53

	// Data:

    54

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

    55

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    56

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

    57

	//    uint8:  Language ID

    58

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

    59

	//

    60

    61

	Packet *p;

    62

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    63

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    64

    65

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    66

	NetworkSend_string(p, _openttd_revision);

    67

	NetworkSend_string(p, _network_player_name); // Player name

    68

	NetworkSend_uint8(p, _network_playas); // PlayAs

    69

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    70

	NetworkSend_string(p, _network_unique_id);

    71

	NetworkSend_Packet(p, MY_CLIENT);

    72

}

    73

    74

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

    75

{

    76

	//

    77

	// Packet: CLIENT_PASSWORD

    78

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

    79

	// Data:

    80

	//    uint8:  NetworkPasswordType

    81

	//    String: Password

    82

	//

    83

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    84

	NetworkSend_uint8(p, type);

    85

	NetworkSend_string(p, password);

    86

	NetworkSend_Packet(p, MY_CLIENT);

    87

}

    88

    89

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    90

{

    91

	//

    92

	// Packet: CLIENT_GETMAP

    93

	// Function: Request the map from the server

    94

	// Data:

    95

	//    <none>

    96

	//

    97

    98

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

    99

	NetworkSend_Packet(p, MY_CLIENT);

   100

}

   101

   102

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   103

{

   104

	//

   105

	// Packet: CLIENT_MAP_OK

   106

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

   107

	// Data:

   108

	//    <none>

   109

	//

   110

   111

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   112

	NetworkSend_Packet(p, MY_CLIENT);

   113

}

   114

   115

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   116

{

   117

	//

   118

	// Packet: CLIENT_ACK

   119

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

   120

	// Data:

   121

	//    uint32: current FrameCounter of the client

   122

	//

   123

   124

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   125

   126

	NetworkSend_uint32(p, _frame_counter);

   127

	NetworkSend_Packet(p, MY_CLIENT);

   128

}

   129

   130

// Send a command packet to the server

   131

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   132

{

   133

	//

   134

	// Packet: CLIENT_COMMAND

   135

	// Function: Send a DoCommand to the Server

   136

	// Data:

   137

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

   138

	//    uint32: CommandID (see command.h)

   139

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

   140

	//    uint32: P2

   141

	//    uint32: Tile

   142

	//    uint32: decode_params

   143

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

   144

	//    uint8:  CallBackID (see callback_table.c)

   145

	//

   146

   147

	int i;

   148

	char *dparam_char;

   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

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

   157

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

   158

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

   159

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

   160

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

   161

		NetworkSend_uint8(p, *dparam_char);

   162

		dparam_char++;

   163

	}

   164

	NetworkSend_uint8(p, cp->callback);

   165

   166

	NetworkSend_Packet(p, MY_CLIENT);

   167

}

   168

   169

// Send a chat-packet over the network

   170

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

   171

{

   172

	//

   173

	// Packet: CLIENT_CHAT

   174

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

   175

	// Data:

   176

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

   177

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

   178

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

   179

	//    String: Message (max MAX_TEXT_MSG_LEN)

   180

	//

   181

   182

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   183

   184

	NetworkSend_uint8(p, action);

   185

	NetworkSend_uint8(p, desttype);

   186

	NetworkSend_uint8(p, dest);

   187

	NetworkSend_string(p, msg);

   188

	NetworkSend_Packet(p, MY_CLIENT);

   189

}

   190

   191

// Send an error-packet over the network

   192

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   193

{

   194

	//

   195

	// Packet: CLIENT_ERROR

   196

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

   197

	// Data:

   198

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

   199

	//

   200

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   201

   202

	NetworkSend_uint8(p, errorno);

   203

	NetworkSend_Packet(p, MY_CLIENT);

   204

}

   205

   206

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   207

{

   208

	//

   209

	// Packet: PACKET_CLIENT_SET_PASSWORD

   210

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

   211

	// Data:

   212

	//    String: Password

   213

	//

   214

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   215

   216

	NetworkSend_string(p, password);

   217

	NetworkSend_Packet(p, MY_CLIENT);

   218

}

   219

   220

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   221

{

   222

	//

   223

	// Packet: PACKET_CLIENT_SET_NAME

   224

	// Function: Gives the player a new name

   225

	// Data:

   226

	//    String: Name

   227

	//

   228

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   229

   230

	NetworkSend_string(p, name);

   231

	NetworkSend_Packet(p, MY_CLIENT);

   232

}

   233

   234

// Send an quit-packet over the network

   235

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   236

{

   237

	//

   238

	// Packet: CLIENT_QUIT

   239

	// Function: The client is quiting the game

   240

	// Data:

   241

	//    String: leave-message

   242

	//

   243

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   244

   245

	NetworkSend_string(p, leavemsg);

   246

	NetworkSend_Packet(p, MY_CLIENT);

   247

}

   248

   249

   250

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

   251

// Receiving functions

   252

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   253

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

   254

   255

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

   256

   257

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   258

{

   259

	// We try to join a server which is full

   260

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   261

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   262

   263

	return NETWORK_RECV_STATUS_SERVER_FULL;

   264

}

   265

   266

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   267

{

   268

	byte company_info_version;

   269

	int i;

   270

   271

	company_info_version = NetworkRecv_uint8(p);

   272

   273

	if (company_info_version == 1) {

   274

		byte total;

   275

		byte current;

   276

   277

		total = NetworkRecv_uint8(p);

   278

   279

		// There is no data at all..

   280

		if (total == 0)

   281

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   282

   283

		current = NetworkRecv_uint8(p);

   284

		if (current >= MAX_PLAYERS)

   285

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   286

   287

		_network_lobby_company_count++;

   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

		return NETWORK_RECV_STATUS_OKAY;

   305

	}

   306

   307

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   308

}

   309

   310

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

   311

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

   312

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

   313

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   314

{

   315

	NetworkClientInfo *ci;

   316

	uint16 index = NetworkRecv_uint16(p);

   317

	byte playas = NetworkRecv_uint8(p);

   318

	char name[NETWORK_NAME_LENGTH];

   319

	char unique_id[NETWORK_NAME_LENGTH];

   320

   321

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

   322

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

   323

   324

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

   325

	if (index == _network_own_client_index)

   326

		_network_playas = playas;

   327

   328

	ci = NetworkFindClientInfoFromIndex(index);

   329

	if (ci != NULL) {

   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, false, 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

   341

		InvalidateWindow(WC_CLIENT_LIST, 0);

   342

   343

		return NETWORK_RECV_STATUS_OKAY;

   344

	}

   345

   346

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

   347

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   348

	if (ci != NULL) {

   349

		ci->client_index = index;

   350

		ci->client_playas = playas;

   351

   352

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

   353

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

   354

   355

		InvalidateWindow(WC_CLIENT_LIST, 0);

   356

   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;

   382

	}

   383

   384

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   385

   386

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   387

}

   388

   389

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   390

{

   391

	NetworkPasswordType type;

   392

	type = NetworkRecv_uint8(p);

   393

   394

	if (type == NETWORK_GAME_PASSWORD) {

   395

		ShowNetworkNeedGamePassword();

   396

		return NETWORK_RECV_STATUS_OKAY;

   397

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   398

		ShowNetworkNeedCompanyPassword();

   399

		return NETWORK_RECV_STATUS_OKAY;

   400

	}

   401

   402

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   403

}

   404

   405

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   406

{

   407

	_network_own_client_index = NetworkRecv_uint16(p);

   408

   409

	// Start receiving the map

   410

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   411

	return NETWORK_RECV_STATUS_OKAY;

   412

}

   413

   414

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   415

{

   416

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   417

	_network_join_waiting = NetworkRecv_uint8(p);

   418

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   419

   420

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

   421

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

   422

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

   423

   424

	return NETWORK_RECV_STATUS_OKAY;

   425

}

   426

   427

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   428

{

   429

	static char filename[256];

   430

	static FILE *file_pointer;

   431

   432

	byte maptype;

   433

   434

	maptype = NetworkRecv_uint8(p);

   435

   436

	// First packet, init some stuff

   437

	if (maptype == MAP_PACKET_START) {

   438

		// The name for the temp-map

   439

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

   440

   441

		file_pointer = fopen(filename, "wb");

   442

		if (file_pointer == NULL) {

   443

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   444

			return NETWORK_RECV_STATUS_SAVEGAME;

   445

		}

   446

   447

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(p);

   448

   449

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   450

		_network_join_kbytes = 0;

   451

		_network_join_kbytes_total = NetworkRecv_uint32(p) / 1024;

   452

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   453

   454

		// The first packet does not contain any more data

   455

		return NETWORK_RECV_STATUS_OKAY;

   456

	}

   457

   458

	if (maptype == MAP_PACKET_NORMAL) {

   459

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

   460

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

   461

   462

		_network_join_kbytes = ftell(file_pointer) / 1024;

   463

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   464

	}

   465

   466

	if (maptype == MAP_PACKET_PATCH) {

   467

		NetworkRecvPatchSettings(p);

   468

	}

   469

   470

	// Check if this was the last packet

   471

	if (maptype == MAP_PACKET_END) {

   472

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

   473

		int i;

   474

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

   475

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

   476

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

   477

		}

   478

   479

		fclose(file_pointer);

   480

   481

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   482

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   483

   484

		// The map is done downloading, load it

   485

		// Load the map

   486

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

   487

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   488

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   489

			return NETWORK_RECV_STATUS_SAVEGAME;

   490

		}

   491

		_opt_mod_ptr = &_opt;

   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

				DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   503

			} else {

   504

				// send a command to make a new player

   505

				_local_player = 0;

   506

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

   507

				_local_player = OWNER_SPECTATOR;

   508

			}

   509

		} else {

   510

			// take control over an existing company

   511

			_local_player = _network_playas - 1;

   512

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   513

		}

   514

	}

   515

   516

	return NETWORK_RECV_STATUS_OKAY;

   517

}

   518

   519

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FRAME)

   520

{

   521

	_frame_counter_server = NetworkRecv_uint32(p);

   522

	_frame_counter_max = NetworkRecv_uint32(p);

   523

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   524

	// Test if the server supports this option