1

#include "stdafx.h"

     2

#include "debug.h"

     3

#include "string.h"

     4

#include "strings.h"

     5

#include "network_data.h"

     6

     7

#ifdef ENABLE_NETWORK

     8

     9

#include "table/strings.h"

    10

#include "network_client.h"

    11

#include "network_gamelist.h"

    12

#include "command.h"

    13

#include "gfx.h"

    14

#include "window.h"

    15

#include "settings.h"

    16

#include "console.h"

    17

    18

    19

// This file handles all the client-commands

    20

    21

    22

extern const char _openttd_revision[];

    23

    24

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

    25

#define MY_CLIENT DEREF_CLIENT(0)

    26

    27

static uint32 last_ack_frame;

    28

    29

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

    30

    31

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

    32

// Sending functions

    33

//   DEF_CLIENT_SEND_COMMAND has no parameters

    34

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

    35

    36

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    37

{

    38

	//

    39

	// Packet: CLIENT_COMPANY_INFO

    40

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

    41

	// Data:

    42

	//    <none>

    43

	//

    44

	Packet *p;

    45

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    46

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    47

    48

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    49

	NetworkSend_Packet(p, MY_CLIENT);

    50

}

    51

    52

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    53

{

    54

	//

    55

	// Packet: CLIENT_JOIN

    56

	// Function: Try to join the server

    57

	// Data:

    58

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

    59

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    60

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

    61

	//    uint8:  Language ID

    62

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

    63

	//

    64

    65

	Packet *p;

    66

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    67

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    68

    69

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    70

	NetworkSend_string(p, _openttd_revision);

    71

	NetworkSend_string(p, _network_player_name); // Player name

    72

	NetworkSend_uint8(p, _network_playas); // PlayAs

    73

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    74

	NetworkSend_string(p, _network_unique_id);

    75

	NetworkSend_Packet(p, MY_CLIENT);

    76

}

    77

    78

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

    79

{

    80

	//

    81

	// Packet: CLIENT_PASSWORD

    82

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

    83

	// Data:

    84

	//    uint8:  NetworkPasswordType

    85

	//    String: Password

    86

	//

    87

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    88

	NetworkSend_uint8(p, type);

    89

	NetworkSend_string(p, password);

    90

	NetworkSend_Packet(p, MY_CLIENT);

    91

}

    92

    93

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    94

{

    95

	//

    96

	// Packet: CLIENT_GETMAP

    97

	// Function: Request the map from the server

    98

	// Data:

    99

	//    <none>

   100

	//

   101

   102

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   103

	NetworkSend_Packet(p, MY_CLIENT);

   104

}

   105

   106

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   107

{

   108

	//

   109

	// Packet: CLIENT_MAP_OK

   110

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

   111

	// Data:

   112

	//    <none>

   113

	//

   114

   115

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   116

	NetworkSend_Packet(p, MY_CLIENT);

   117

}

   118

   119

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   120

{

   121

	//

   122

	// Packet: CLIENT_ACK

   123

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

   124

	// Data:

   125

	//    uint32: current FrameCounter of the client

   126

	//

   127

   128

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   129

   130

	NetworkSend_uint32(p, _frame_counter);

   131

	NetworkSend_Packet(p, MY_CLIENT);

   132

}

   133

   134

// Send a command packet to the server

   135

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   136

{

   137

	//

   138

	// Packet: CLIENT_COMMAND

   139

	// Function: Send a DoCommand to the Server

   140

	// Data:

   141

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

   142

	//    uint32: CommandID (see command.h)

   143

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

   144

	//    uint32: P2

   145

	//    uint32: Tile

   146

	//    string: text

   147

	//    uint8:  CallBackID (see callback_table.c)

   148

	//

   149

   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

	NetworkSend_string(p, cp->text);

   158

	NetworkSend_uint8(p, cp->callback);

   159

   160

	NetworkSend_Packet(p, MY_CLIENT);

   161

}

   162

   163

// Send a chat-packet over the network

   164

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

   165

{

   166

	//

   167

	// Packet: CLIENT_CHAT

   168

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

   169

	// Data:

   170

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

   171

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

   172

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

   173

	//    String: Message (max MAX_TEXT_MSG_LEN)

   174

	//

   175

   176

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   177

   178

	NetworkSend_uint8(p, action);

   179

	NetworkSend_uint8(p, desttype);

   180

	NetworkSend_uint8(p, dest);

   181

	NetworkSend_string(p, msg);

   182

	NetworkSend_Packet(p, MY_CLIENT);

   183

}

   184

   185

// Send an error-packet over the network

   186

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   187

{

   188

	//

   189

	// Packet: CLIENT_ERROR

   190

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

   191

	// Data:

   192

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

   193

	//

   194

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   195

   196

	NetworkSend_uint8(p, errorno);

   197

	NetworkSend_Packet(p, MY_CLIENT);

   198

}

   199

   200

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   201

{

   202

	//

   203

	// Packet: PACKET_CLIENT_SET_PASSWORD

   204

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

   205

	// Data:

   206

	//    String: Password

   207

	//

   208

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   209

   210

	NetworkSend_string(p, password);

   211

	NetworkSend_Packet(p, MY_CLIENT);

   212

}

   213

   214

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   215

{

   216

	//

   217

	// Packet: PACKET_CLIENT_SET_NAME

   218

	// Function: Gives the player a new name

   219

	// Data:

   220

	//    String: Name

   221

	//

   222

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   223

   224

	NetworkSend_string(p, name);

   225

	NetworkSend_Packet(p, MY_CLIENT);

   226

}

   227

   228

// Send an quit-packet over the network

   229

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   230

{

   231

	//

   232

	// Packet: CLIENT_QUIT

   233

	// Function: The client is quiting the game

   234

	// Data:

   235

	//    String: leave-message

   236

	//

   237

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   238

   239

	NetworkSend_string(p, leavemsg);

   240

	NetworkSend_Packet(p, MY_CLIENT);

   241

}

   242

   243

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

   244

{

   245

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   246

	NetworkSend_string(p, pass);

   247

	NetworkSend_string(p, command);

   248

	NetworkSend_Packet(p, MY_CLIENT);

   249

}

   250

   251

   252

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

   253

// Receiving functions

   254

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   255

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

   256

   257

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

   258

   259

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   260

{

   261

	// We try to join a server which is full

   262

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   263

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   264

   265

	return NETWORK_RECV_STATUS_SERVER_FULL;

   266

}

   267

   268

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   269

{

   270

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

   271

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   272

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   273

   274

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   275

}

   276

   277

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   278

{

   279

	byte company_info_version;

   280

	int i;

   281

   282

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   283

   284

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

   285

		byte total;

   286

		byte current;

   287

   288

		total = NetworkRecv_uint8(MY_CLIENT, p);

   289

   290

		// There is no data at all..

   291

		if (total == 0)

   292

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   293

   294

		current = NetworkRecv_uint8(MY_CLIENT, p);

   295

		if (current >= MAX_PLAYERS)

   296

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   297

   298

		_network_lobby_company_count++;

   299

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

   312

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

   313

   314

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   315

   316

		return NETWORK_RECV_STATUS_OKAY;

   317

	}

   318

   319

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   320

}

   321

   322

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

   323

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

   324

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

   325

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   326

{

   327

	NetworkClientInfo *ci;

   328

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   329

	byte playas = NetworkRecv_uint8(MY_CLIENT, p);

   330

	char name[NETWORK_NAME_LENGTH];

   331

	char unique_id[NETWORK_NAME_LENGTH];

   332

   333

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

   334

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

   335

   336

	if (MY_CLIENT->quited)

   337

		return NETWORK_RECV_STATUS_CONN_LOST;

   338

   339

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

   340

	if (index == _network_own_client_index)

   341

		_network_playas = playas;

   342

   343

	ci = NetworkFindClientInfoFromIndex(index);

   344

	if (ci != NULL) {

   345

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

   346

			// Client name changed, display the change

   347

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

   348

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

   349

			// The player changed from client-player..

   350

			// Do not display that for now

   351

		}

   352

   353

		ci->client_playas = playas;

   354

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

   355

   356

		InvalidateWindow(WC_CLIENT_LIST, 0);

   357

   358

		return NETWORK_RECV_STATUS_OKAY;

   359

	}

   360

   361

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

   362

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   363

	if (ci != NULL) {

   364

		ci->client_index = index;

   365

		ci->client_playas = playas;

   366

   367

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

   368

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

   369

   370

		InvalidateWindow(WC_CLIENT_LIST, 0);

   371

   372

		return NETWORK_RECV_STATUS_OKAY;

   373

	}

   374

   375

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

   376

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   377

}

   378

   379

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   380

{

   381

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   382

   383

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

   384

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   385

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

   386

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   387

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   388

		// Wrong revision :(

   389

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   390

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   391

		// Wrong password

   392

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   393

	} else if (error == NETWORK_ERROR_KICKED) {

   394

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   395

	} else if (error == NETWORK_ERROR_CHEATER) {

   396

		_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   397

	}

   398

   399

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   400

   401

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   402

}

   403

   404

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   405

{

   406

	NetworkPasswordType type;

   407

	type = NetworkRecv_uint8(MY_CLIENT, p);

   408

   409

	if (type == NETWORK_GAME_PASSWORD) {

   410

		ShowNetworkNeedGamePassword();

   411

		return NETWORK_RECV_STATUS_OKAY;

   412

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   413

		ShowNetworkNeedCompanyPassword();

   414

		return NETWORK_RECV_STATUS_OKAY;

   415

	}

   416

   417

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   418

}

   419

   420

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   421

{

   422

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   423

   424

	// Start receiving the map

   425

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   426

	return NETWORK_RECV_STATUS_OKAY;

   427

}

   428

   429

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   430

{

   431

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   432

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   433

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   434

   435

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

   436

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

   437

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

   438

   439

	return NETWORK_RECV_STATUS_OKAY;

   440

}

   441

   442

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   443

{

   444

	static char filename[256];

   445

	static FILE *file_pointer;

   446

   447

	byte maptype;

   448

   449

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   450

   451

	if (MY_CLIENT->quited)

   452

		return NETWORK_RECV_STATUS_CONN_LOST;

   453

   454

	// First packet, init some stuff

   455

	if (maptype == MAP_PACKET_START) {

   456

		// The name for the temp-map

   457

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

   458

   459

		file_pointer = fopen(filename, "wb");

   460

		if (file_pointer == NULL) {

   461

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   462

			return NETWORK_RECV_STATUS_SAVEGAME;

   463

		}

   464

   465

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

   466

   467

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   468

		_network_join_kbytes = 0;

   469

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   470

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   471

   472

		// The first packet does not contain any more data

   473

		return NETWORK_RECV_STATUS_OKAY;

   474

	}

   475

   476

	if (maptype == MAP_PACKET_NORMAL) {

   477

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

   478

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

   479

   480

		_network_join_kbytes = ftell(file_pointer) / 1024;

   481

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   482

	}

   483

   484

	if (maptype == MAP_PACKET_PATCH) {

   485

		NetworkRecvPatchSettings(MY_CLIENT, p);

   486

	}

   487

   488

	// Check if this was the last packet

   489

	if (maptype == MAP_PACKET_END) {

   490

		fclose(file_pointer);

   491

   492

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   493

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   494

   495

		// The map is done downloading, load it

   496

		// Load the map

   497

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

   498

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   499

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   500

			return NETWORK_RECV_STATUS_SAVEGAME;

   501

		}

   502

   503

		_opt_ptr = &_opt; // during a network game you are always in-game

   504

   505

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

   506

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   507

   508

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

   509

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

   510

   511

			if (_network_playas == OWNER_SPECTATOR) {

   512

				// The client wants to be a spectator..

   513

				_local_player = OWNER_SPECTATOR;

   514

				DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   515

			} else {

   516

				/* We have arrived and ready to start playing; send a command to make a new player;

   517

				 * the server will give us a client-id and let us in */

   518

				_local_player = 0;