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

#include "console.h"

    14

    15

    16

// This file handles all the client-commands

    17

    18

    19

extern const char _openttd_revision[];

    20

    21

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

    22

#define MY_CLIENT DEREF_CLIENT(0)

    23

    24

static uint32 last_ack_frame;

    25

    26

void NetworkRecvPatchSettings(NetworkClientState *cs, Packet *p);

    27

    28

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

    29

// Sending functions

    30

//   DEF_CLIENT_SEND_COMMAND has no parameters

    31

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

    32

    33

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    34

{

    35

	//

    36

	// Packet: CLIENT_COMPANY_INFO

    37

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

    38

	// Data:

    39

	//    <none>

    40

	//

    41

	Packet *p;

    42

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    43

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    44

    45

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    46

	NetworkSend_Packet(p, MY_CLIENT);

    47

}

    48

    49

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    50

{

    51

	//

    52

	// Packet: CLIENT_JOIN

    53

	// Function: Try to join the server

    54

	// Data:

    55

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

    56

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    57

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

    58

	//    uint8:  Language ID

    59

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

    60

	//

    61

    62

	Packet *p;

    63

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    64

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    65

    66

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    67

	NetworkSend_string(p, _openttd_revision);

    68

	NetworkSend_string(p, _network_player_name); // Player name

    69

	NetworkSend_uint8(p, _network_playas); // PlayAs

    70

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    71

	NetworkSend_string(p, _network_unique_id);

    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

	uint i;

   149

	char *dparam_char;

   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);

   157

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

   158

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

   159

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

   160

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

   161

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

   162

		NetworkSend_uint8(p, *dparam_char);

   163

		dparam_char++;

   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

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_RCON)(const char *pass, const char *command)

   251

{

   252

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   253

	NetworkSend_string(p, pass);

   254

	NetworkSend_string(p, command);

   255

	NetworkSend_Packet(p, MY_CLIENT);

   256

}

   257

   258

   259

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

   260

// Receiving functions

   261

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   262

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

   263

   264

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

   265

   266

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   267

{

   268

	// We try to join a server which is full

   269

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   270

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   271

   272

	return NETWORK_RECV_STATUS_SERVER_FULL;

   273

}

   274

   275

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   276

{

   277

	// We try to join a server where we are banned

   278

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   279

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   280

   281

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   282

}

   283

   284

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   285

{

   286

	byte company_info_version;

   287

	int i;

   288

   289

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   290

   291

	if (!MY_CLIENT->quited && company_info_version == NETWORK_COMPANY_INFO_VERSION) {

   292

		byte total;

   293

		byte current;

   294

   295

		total = NetworkRecv_uint8(MY_CLIENT, p);

   296

   297

		// There is no data at all..

   298

		if (total == 0)

   299

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   300

   301

		current = NetworkRecv_uint8(MY_CLIENT, p);

   302

		if (current >= MAX_PLAYERS)

   303

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   304

   305

		_network_lobby_company_count++;

   306

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

		_network_player_info[current].use_password = NetworkRecv_uint8(MY_CLIENT, p);

   314

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

   315

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

   316

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

   317

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

   318

   319

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

   320

   321

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   322

   323

		return NETWORK_RECV_STATUS_OKAY;

   324

	}

   325

   326

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   327

}

   328

   329

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

   330

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

   331

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

   332

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   333

{

   334

	NetworkClientInfo *ci;

   335

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   336

	byte playas = NetworkRecv_uint8(MY_CLIENT, p);

   337

	char name[NETWORK_NAME_LENGTH];

   338

	char unique_id[NETWORK_NAME_LENGTH];

   339

   340

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

   341

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

   342

   343

	if (MY_CLIENT->quited)

   344

		return NETWORK_RECV_STATUS_CONN_LOST;

   345

   346

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

   347

	if (index == _network_own_client_index)

   348

		_network_playas = playas;

   349

   350

	ci = NetworkFindClientInfoFromIndex(index);

   351

	if (ci != NULL) {

   352

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

   353

			// Client name changed, display the change

   354

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

   355

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

   356

			// The player changed from client-player..

   357

			// Do not display that for now

   358

		}

   359

   360

		ci->client_playas = playas;

   361

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

   362

   363

		InvalidateWindow(WC_CLIENT_LIST, 0);

   364

   365

		return NETWORK_RECV_STATUS_OKAY;

   366

	}

   367

   368

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

   369

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   370

	if (ci != NULL) {

   371

		ci->client_index = index;

   372

		ci->client_playas = playas;

   373

   374

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

   375

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

   376

   377

		InvalidateWindow(WC_CLIENT_LIST, 0);

   378

   379

		return NETWORK_RECV_STATUS_OKAY;

   380

	}

   381

   382

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

   383

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   384

}

   385

   386

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   387

{

   388

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   389

   390

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

   391

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   392

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

   393

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   394

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   395

		// Wrong revision :(

   396

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   397

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   398

		// Wrong password

   399

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   400

	} else if (error == NETWORK_ERROR_KICKED) {

   401

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   402

	} else if (error == NETWORK_ERROR_CHEATER) {

   403

		_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   404

	}

   405

   406

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   407

   408

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   409

}

   410

   411

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   412

{

   413

	NetworkPasswordType type;

   414

	type = NetworkRecv_uint8(MY_CLIENT, p);

   415

   416

	if (type == NETWORK_GAME_PASSWORD) {

   417

		ShowNetworkNeedGamePassword();

   418

		return NETWORK_RECV_STATUS_OKAY;

   419

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   420

		ShowNetworkNeedCompanyPassword();

   421

		return NETWORK_RECV_STATUS_OKAY;

   422

	}

   423

   424

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   425

}

   426

   427

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   428

{

   429

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   430

   431

	// Start receiving the map

   432

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   433

	return NETWORK_RECV_STATUS_OKAY;

   434

}

   435

   436

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   437

{

   438

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   439

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   440

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   441

   442

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

   443

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

   444

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

   445

   446

	return NETWORK_RECV_STATUS_OKAY;

   447

}

   448

   449

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   450

{

   451

	static char filename[256];

   452

	static FILE *file_pointer;

   453

   454

	byte maptype;

   455

   456

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   457

   458

	if (MY_CLIENT->quited)

   459

		return NETWORK_RECV_STATUS_CONN_LOST;

   460

   461

	// First packet, init some stuff

   462

	if (maptype == MAP_PACKET_START) {

   463

		// The name for the temp-map

   464

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

   465

   466

		file_pointer = fopen(filename, "wb");

   467

		if (file_pointer == NULL) {

   468

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   469

			return NETWORK_RECV_STATUS_SAVEGAME;

   470

		}

   471

   472

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(MY_CLIENT, p);

   473

   474

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   475

		_network_join_kbytes = 0;

   476

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   477

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   478

   479

		// The first packet does not contain any more data

   480

		return NETWORK_RECV_STATUS_OKAY;

   481

	}

   482

   483

	if (maptype == MAP_PACKET_NORMAL) {

   484

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

   485

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

   486

   487

		_network_join_kbytes = ftell(file_pointer) / 1024;

   488

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   489

	}

   490

   491

	if (maptype == MAP_PACKET_PATCH) {

   492

		NetworkRecvPatchSettings(MY_CLIENT, p);

   493

	}

   494

   495

	// Check if this was the last packet

   496

	if (maptype == MAP_PACKET_END) {

   497

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

   498

		int i;

   499

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

   500

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

   501

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

   502

		}

   503

   504

		fclose(file_pointer);

   505

   506

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   507

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   508

   509

		// The map is done downloading, load it

   510

		// Load the map

   511

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

   512

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   513

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   514

			return NETWORK_RECV_STATUS_SAVEGAME;

   515

		}

   516

		_opt_mod_ptr = &_opt;

   517

   518

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