1

#include "stdafx.h"

     3

#include "network_data.h"

     4

     5

#ifdef ENABLE_NETWORK

     6

     7

#include "table/strings.h"

     8

#include "network_client.h"

     9

#include "network_gamelist.h"

    10

#include "command.h"

    11

#include "gfx.h"

    12

#include "window.h"

    13

#include "settings.h"

    14

#include "console.h"

    15

    16

    17

// This file handles all the client-commands

    18

    19

    20

extern const char _openttd_revision[];

    21

    22

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

    23

#define MY_CLIENT DEREF_CLIENT(0)

    24

    25

static uint32 last_ack_frame;

    26

    27

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

    28

    29

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

    30

// Sending functions

    31

//   DEF_CLIENT_SEND_COMMAND has no parameters

    32

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

    33

    34

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    35

{

    36

	//

    37

	// Packet: CLIENT_COMPANY_INFO

    38

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

    39

	// Data:

    40

	//    <none>

    41

	//

    42

	Packet *p;

    43

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    44

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    45

    46

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    47

	NetworkSend_Packet(p, MY_CLIENT);

    48

}

    49

    50

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    51

{

    52

	//

    53

	// Packet: CLIENT_JOIN

    54

	// Function: Try to join the server

    55

	// Data:

    56

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

    57

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    58

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

    59

	//    uint8:  Language ID

    60

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

    61

	//

    62

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

    71

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    72

	NetworkSend_string(p, _network_unique_id);

    73

	NetworkSend_Packet(p, MY_CLIENT);

    74

}

    75

    76

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

    77

{

    78

	//

    79

	// Packet: CLIENT_PASSWORD

    80

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

    81

	// Data:

    82

	//    uint8:  NetworkPasswordType

    83

	//    String: Password

    84

	//

    85

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    86

	NetworkSend_uint8(p, type);

    87

	NetworkSend_string(p, password);

    88

	NetworkSend_Packet(p, MY_CLIENT);

    89

}

    90

    91

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    92

{

    93

	//

    94

	// Packet: CLIENT_GETMAP

    95

	// Function: Request the map from the server

    96

	// Data:

    97

	//    <none>

    98

	//

    99

   100

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   101

	NetworkSend_Packet(p, MY_CLIENT);

   102

}

   103

   104

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   105

{

   106

	//

   107

	// Packet: CLIENT_MAP_OK

   108

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

   109

	// Data:

   110

	//    <none>

   111

	//

   112

   113

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   114

	NetworkSend_Packet(p, MY_CLIENT);

   115

}

   116

   117

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   118

{

   119

	//

   120

	// Packet: CLIENT_ACK

   121

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

   122

	// Data:

   123

	//    uint32: current FrameCounter of the client

   124

	//

   125

   126

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   127

   128

	NetworkSend_uint32(p, _frame_counter);

   129

	NetworkSend_Packet(p, MY_CLIENT);

   130

}

   131

   132

// Send a command packet to the server

   133

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   134

{

   135

	//

   136

	// Packet: CLIENT_COMMAND

   137

	// Function: Send a DoCommand to the Server

   138

	// Data:

   139

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

   140

	//    uint32: CommandID (see command.h)

   141

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

   142

	//    uint32: P2

   143

	//    uint32: Tile

   144

	//    uint32: decode_params

   145

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

   146

	//    uint8:  CallBackID (see callback_table.c)

   147

	//

   148

   149

	uint i;

   150

	char *dparam_char;

   151

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   152

   153

	NetworkSend_uint8(p, cp->player);

   154

	NetworkSend_uint32(p, cp->cmd);

   155

	NetworkSend_uint32(p, cp->p1);

   156

	NetworkSend_uint32(p, cp->p2);

   157

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

   158

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

   159

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

   160

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

   161

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

   162

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

   163

		NetworkSend_uint8(p, *dparam_char);

   164

		dparam_char++;

   165

	}

   166

	NetworkSend_uint8(p, cp->callback);

   167

   168

	NetworkSend_Packet(p, MY_CLIENT);

   169

}

   170

   171

// Send a chat-packet over the network

   172

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

   173

{

   174

	//

   175

	// Packet: CLIENT_CHAT

   176

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

   177

	// Data:

   178

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

   179

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

   180

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

   181

	//    String: Message (max MAX_TEXT_MSG_LEN)

   182

	//

   183

   184

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   185

   186

	NetworkSend_uint8(p, action);

   187

	NetworkSend_uint8(p, desttype);

   188

	NetworkSend_uint8(p, dest);

   189

	NetworkSend_string(p, msg);

   190

	NetworkSend_Packet(p, MY_CLIENT);

   191

}

   192

   193

// Send an error-packet over the network

   194

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   195

{

   196

	//

   197

	// Packet: CLIENT_ERROR

   198

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

   199

	// Data:

   200

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

   201

	//

   202

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   203

   204

	NetworkSend_uint8(p, errorno);

   205

	NetworkSend_Packet(p, MY_CLIENT);

   206

}

   207

   208

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   209

{

   210

	//

   211

	// Packet: PACKET_CLIENT_SET_PASSWORD

   212

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

   213

	// Data:

   214

	//    String: Password

   215

	//

   216

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   217

   218

	NetworkSend_string(p, password);

   219

	NetworkSend_Packet(p, MY_CLIENT);

   220

}

   221

   222

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   223

{

   224

	//

   225

	// Packet: PACKET_CLIENT_SET_NAME

   226

	// Function: Gives the player a new name

   227

	// Data:

   228

	//    String: Name

   229

	//

   230

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   231

   232

	NetworkSend_string(p, name);

   233

	NetworkSend_Packet(p, MY_CLIENT);

   234

}

   235

   236

// Send an quit-packet over the network

   237

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   238

{

   239

	//

   240

	// Packet: CLIENT_QUIT

   241

	// Function: The client is quiting the game

   242

	// Data:

   243

	//    String: leave-message

   244

	//

   245

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   246

   247

	NetworkSend_string(p, leavemsg);

   248

	NetworkSend_Packet(p, MY_CLIENT);

   249

}

   250

   251

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

   252

{

   253

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   254

	NetworkSend_string(p, pass);

   255

	NetworkSend_string(p, command);

   256

	NetworkSend_Packet(p, MY_CLIENT);

   257

}

   258

   259

   260

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

   261

// Receiving functions

   262

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   263

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

   264

   265

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

   266

   267

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   268

{

   269

	// We try to join a server which is full

   270

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   271

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   272

   273

	return NETWORK_RECV_STATUS_SERVER_FULL;

   274

}

   275

   276

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   277

{

   278

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

   279

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   280

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   281

   282

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   283

}

   284

   285

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   286

{

   287

	byte company_info_version;

   288

	int i;

   289

   290

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   291

   292

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

   293

		byte total;

   294

		byte current;

   295

   296

		total = NetworkRecv_uint8(MY_CLIENT, p);

   297

   298

		// There is no data at all..

   299

		if (total == 0)

   300

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   301

   302

		current = NetworkRecv_uint8(MY_CLIENT, p);

   303

		if (current >= MAX_PLAYERS)

   304

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   305

   306

		_network_lobby_company_count++;

   307

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

   320

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

   321

   322

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   323

   324

		return NETWORK_RECV_STATUS_OKAY;

   325

	}

   326

   327

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   328

}

   329

   330

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

   331

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

   332

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

   333

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   334

{

   335

	NetworkClientInfo *ci;

   336

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   337

	byte playas = NetworkRecv_uint8(MY_CLIENT, p);

   338

	char name[NETWORK_NAME_LENGTH];

   339

	char unique_id[NETWORK_NAME_LENGTH];

   340

   341

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

   342

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

   343

   344

	if (MY_CLIENT->quited)

   345

		return NETWORK_RECV_STATUS_CONN_LOST;

   346

   347

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

   348

	if (index == _network_own_client_index)

   349

		_network_playas = playas;

   350

   351

	ci = NetworkFindClientInfoFromIndex(index);

   352

	if (ci != NULL) {

   353

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

   354

			// Client name changed, display the change

   355

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

   356

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

   357

			// The player changed from client-player..

   358

			// Do not display that for now

   359

		}

   360

   361

		ci->client_playas = playas;

   362

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

   363

   364

		InvalidateWindow(WC_CLIENT_LIST, 0);

   365

   366

		return NETWORK_RECV_STATUS_OKAY;

   367

	}

   368

   369

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

   370

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   371

	if (ci != NULL) {

   372

		ci->client_index = index;

   373

		ci->client_playas = playas;

   374

   375

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

   376

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

   377

   378

		InvalidateWindow(WC_CLIENT_LIST, 0);

   379

   380

		return NETWORK_RECV_STATUS_OKAY;

   381

	}

   382

   383

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

   384

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   385

}

   386

   387

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   388

{

   389

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   390

   391

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

   392

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   393

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

   394

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   395

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   396

		// Wrong revision :(

   397

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   398

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   399

		// Wrong password

   400

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   401

	} else if (error == NETWORK_ERROR_KICKED) {

   402

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   403

	} else if (error == NETWORK_ERROR_CHEATER) {

   404

		_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   405

	}

   406

   407

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   408

   409

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   410

}

   411

   412

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   413

{

   414

	NetworkPasswordType type;

   415

	type = NetworkRecv_uint8(MY_CLIENT, p);

   416

   417

	if (type == NETWORK_GAME_PASSWORD) {

   418

		ShowNetworkNeedGamePassword();

   419

		return NETWORK_RECV_STATUS_OKAY;

   420

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   421

		ShowNetworkNeedCompanyPassword();

   422

		return NETWORK_RECV_STATUS_OKAY;

   423

	}

   424

   425

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   426

}

   427

   428

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   429

{

   430

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   431

   432

	// Start receiving the map

   433

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   434

	return NETWORK_RECV_STATUS_OKAY;

   435

}

   436

   437

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   438

{

   439

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   440

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   441

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   442

   443

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

   444

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

   445

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

   446

   447

	return NETWORK_RECV_STATUS_OKAY;

   448

}

   449

   450

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   451

{

   452

	static char filename[256];

   453

	static FILE *file_pointer;

   454

   455

	byte maptype;

   456

   457

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   458

   459

	if (MY_CLIENT->quited)

   460

		return NETWORK_RECV_STATUS_CONN_LOST;

   461

   462

	// First packet, init some stuff

   463

	if (maptype == MAP_PACKET_START) {

   464

		// The name for the temp-map

   465

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

   466

   467

		file_pointer = fopen(filename, "wb");

   468

		if (file_pointer == NULL) {

   469

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   470

			return NETWORK_RECV_STATUS_SAVEGAME;

   471

		}

   472

   473

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

   474

   475

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   476

		_network_join_kbytes = 0;

   477

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   478

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   479

   480

		// The first packet does not contain any more data

   481

		return NETWORK_RECV_STATUS_OKAY;

   482

	}

   483

   484

	if (maptype == MAP_PACKET_NORMAL) {

   485

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

   486

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

   487

   488

		_network_join_kbytes = ftell(file_pointer) / 1024;

   489

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   490

	}

   491

   492

	if (maptype == MAP_PACKET_PATCH) {

   493

		NetworkRecvPatchSettings(MY_CLIENT, p);

   494

	}

   495

   496

	// Check if this was the last packet

   497

	if (maptype == MAP_PACKET_END) {

   498

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

   499

		int i;

   500

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

   501

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

   502

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

   503

		}

   504

   505

		fclose(file_pointer);

   506

   507

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   508

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   509

   510

		// The map is done downloading, load it

   511

		// Load the map

   512

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

   513

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   514

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   515

			return NETWORK_RECV_STATUS_SAVEGAME;

   516

		}

   517

		_opt_mod_ptr = &_opt;

   518