1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "debug.h"

     5

#include "string.h"

     6

#include "strings.h"

     7

#include "network_data.h"

     8

     9

#ifdef ENABLE_NETWORK

    10

    11

#include "table/strings.h"

    12

#include "functions.h"

    13

#include "network_client.h"

    14

#include "network_gamelist.h"

    15

#include "saveload.h"

    16

#include "command.h"

    17

#include "gfx.h"

    18

#include "window.h"

    19

#include "settings.h"

    20

#include "console.h"

    21

#include "variables.h"

    22

    23

    24

// This file handles all the client-commands

    25

    26

    27

extern const char _openttd_revision[];

    28

    29

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

    30

#define MY_CLIENT DEREF_CLIENT(0)

    31

    32

static uint32 last_ack_frame;

    33

    34

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

    35

    36

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

    37

// Sending functions

    38

//   DEF_CLIENT_SEND_COMMAND has no parameters

    39

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

    40

    41

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    42

{

    43

	//

    44

	// Packet: CLIENT_COMPANY_INFO

    45

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

    46

	// Data:

    47

	//    <none>

    48

	//

    49

	Packet *p;

    50

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    51

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    52

    53

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    54

	NetworkSend_Packet(p, MY_CLIENT);

    55

}

    56

    57

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    58

{

    59

	//

    60

	// Packet: CLIENT_JOIN

    61

	// Function: Try to join the server

    62

	// Data:

    63

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

    64

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    65

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

    66

	//    uint8:  Language ID

    67

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

    68

	//

    69

    70

	Packet *p;

    71

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    72

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    73

    74

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    75

	NetworkSend_string(p, _openttd_revision);

    76

	NetworkSend_string(p, _network_player_name); // Player name

    77

	NetworkSend_uint8(p, _network_playas); // PlayAs

    78

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    79

	NetworkSend_string(p, _network_unique_id);

    80

	NetworkSend_Packet(p, MY_CLIENT);

    81

}

    82

    83

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

    84

{

    85

	//

    86

	// Packet: CLIENT_PASSWORD

    87

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

    88

	// Data:

    89

	//    uint8:  NetworkPasswordType

    90

	//    String: Password

    91

	//

    92

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    93

	NetworkSend_uint8(p, type);

    94

	NetworkSend_string(p, password);

    95

	NetworkSend_Packet(p, MY_CLIENT);

    96

}

    97

    98

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    99

{

   100

	//

   101

	// Packet: CLIENT_GETMAP

   102

	// Function: Request the map from the server

   103

	// Data:

   104

	//    <none>

   105

	//

   106

   107

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   108

	NetworkSend_Packet(p, MY_CLIENT);

   109

}

   110

   111

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   112

{

   113

	//

   114

	// Packet: CLIENT_MAP_OK

   115

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

   116

	// Data:

   117

	//    <none>

   118

	//

   119

   120

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   121

	NetworkSend_Packet(p, MY_CLIENT);

   122

}

   123

   124

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   125

{

   126

	//

   127

	// Packet: CLIENT_ACK

   128

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

   129

	// Data:

   130

	//    uint32: current FrameCounter of the client

   131

	//

   132

   133

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   134

   135

	NetworkSend_uint32(p, _frame_counter);

   136

	NetworkSend_Packet(p, MY_CLIENT);

   137

}

   138

   139

// Send a command packet to the server

   140

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   141

{

   142

	//

   143

	// Packet: CLIENT_COMMAND

   144

	// Function: Send a DoCommand to the Server

   145

	// Data:

   146

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

   147

	//    uint32: CommandID (see command.h)

   148

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

   149

	//    uint32: P2

   150

	//    uint32: Tile

   151

	//    string: text

   152

	//    uint8:  CallBackID (see callback_table.c)

   153

	//

   154

   155

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   156

   157

	NetworkSend_uint8(p, cp->player);

   158

	NetworkSend_uint32(p, cp->cmd);

   159

	NetworkSend_uint32(p, cp->p1);

   160

	NetworkSend_uint32(p, cp->p2);

   161

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

   162

	NetworkSend_string(p, cp->text);

   163

	NetworkSend_uint8(p, cp->callback);

   164

   165

	NetworkSend_Packet(p, MY_CLIENT);

   166

}

   167

   168

// Send a chat-packet over the network

   169

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

   170

{

   171

	//

   172

	// Packet: CLIENT_CHAT

   173

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

   174

	// Data:

   175

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

   176

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

   177

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

   178

	//    String: Message (max MAX_TEXT_MSG_LEN)

   179

	//

   180

   181

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   182

   183

	NetworkSend_uint8(p, action);

   184

	NetworkSend_uint8(p, desttype);

   185

	NetworkSend_uint8(p, dest);

   186

	NetworkSend_string(p, msg);

   187

	NetworkSend_Packet(p, MY_CLIENT);

   188

}

   189

   190

// Send an error-packet over the network

   191

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   192

{

   193

	//

   194

	// Packet: CLIENT_ERROR

   195

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

   196

	// Data:

   197

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

   198

	//

   199

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   200

   201

	NetworkSend_uint8(p, errorno);

   202

	NetworkSend_Packet(p, MY_CLIENT);

   203

}

   204

   205

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   206

{

   207

	//

   208

	// Packet: PACKET_CLIENT_SET_PASSWORD

   209

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

   210

	// Data:

   211

	//    String: Password

   212

	//

   213

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   214

   215

	NetworkSend_string(p, password);

   216

	NetworkSend_Packet(p, MY_CLIENT);

   217

}

   218

   219

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   220

{

   221

	//

   222

	// Packet: PACKET_CLIENT_SET_NAME

   223

	// Function: Gives the player a new name

   224

	// Data:

   225

	//    String: Name

   226

	//

   227

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   228

   229

	NetworkSend_string(p, name);

   230

	NetworkSend_Packet(p, MY_CLIENT);

   231

}

   232

   233

// Send an quit-packet over the network

   234

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   235

{

   236

	//

   237

	// Packet: CLIENT_QUIT

   238

	// Function: The client is quiting the game

   239

	// Data:

   240

	//    String: leave-message

   241

	//

   242

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   243

   244

	NetworkSend_string(p, leavemsg);

   245

	NetworkSend_Packet(p, MY_CLIENT);

   246

}

   247

   248

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

   249

{

   250

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   251

	NetworkSend_string(p, pass);

   252

	NetworkSend_string(p, command);

   253

	NetworkSend_Packet(p, MY_CLIENT);

   254

}

   255

   256

   257

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

   258

// Receiving functions

   259

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   260

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

   261

   262

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

   263

   264

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   265

{

   266

	// We try to join a server which is full

   267

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   268

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   269

   270

	return NETWORK_RECV_STATUS_SERVER_FULL;

   271

}

   272

   273

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   274

{

   275

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

   276

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   277

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   278

   279

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   280

}

   281

   282

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   283

{

   284

	byte company_info_version;

   285

	int i;

   286

   287

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   288

   289

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

   290

		byte total;

   291

		byte current;

   292

   293

		total = NetworkRecv_uint8(MY_CLIENT, p);

   294

   295

		// There is no data at all..

   296

		if (total == 0)

   297

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   298

   299

		current = NetworkRecv_uint8(MY_CLIENT, p);

   300

		if (current >= MAX_PLAYERS)

   301

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   302

   303

		_network_lobby_company_count++;

   304

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

   317

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

   318

   319

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   320

   321

		return NETWORK_RECV_STATUS_OKAY;

   322

	}

   323

   324

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   325

}

   326

   327

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

   328

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

   329

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

   330

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   331

{

   332

	NetworkClientInfo *ci;

   333

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   334

	byte playas = NetworkRecv_uint8(MY_CLIENT, p);

   335

	char name[NETWORK_NAME_LENGTH];

   336

	char unique_id[NETWORK_NAME_LENGTH];

   337

   338

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

   339

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

   340

   341

	if (MY_CLIENT->quited)

   342

		return NETWORK_RECV_STATUS_CONN_LOST;

   343

   344

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

   345

	if (index == _network_own_client_index)

   346

		_network_playas = playas;

   347

   348

	ci = NetworkFindClientInfoFromIndex(index);

   349

	if (ci != NULL) {

   350

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

   351

			// Client name changed, display the change

   352

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

   353

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

   354

			// The player changed from client-player..

   355

			// Do not display that for now

   356

		}

   357

   358

		ci->client_playas = playas;

   359

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

   360

   361

		InvalidateWindow(WC_CLIENT_LIST, 0);

   362

   363

		return NETWORK_RECV_STATUS_OKAY;

   364

	}

   365

   366

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

   367

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   368

	if (ci != NULL) {

   369

		ci->client_index = index;

   370

		ci->client_playas = playas;

   371

   372

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

   373

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

   374

   375

		InvalidateWindow(WC_CLIENT_LIST, 0);

   376

   377

		return NETWORK_RECV_STATUS_OKAY;

   378

	}

   379

   380

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

   381

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   382

}

   383

   384

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   385

{

   386

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   387

   388

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

   389

			error == NETWORK_ERROR_PLAYER_MISMATCH) {

   390

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

   391

		_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   392

	} else if (error == NETWORK_ERROR_WRONG_REVISION) {

   393

		// Wrong revision :(

   394

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   395

	} else if (error == NETWORK_ERROR_WRONG_PASSWORD) {

   396

		// Wrong password

   397

		_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   398

	} else if (error == NETWORK_ERROR_KICKED) {

   399

		_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   400

	} else if (error == NETWORK_ERROR_CHEATER) {

   401

		_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   402

	}

   403

   404

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   405

   406

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   407

}

   408

   409

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   410

{

   411

	NetworkPasswordType type;

   412

	type = NetworkRecv_uint8(MY_CLIENT, p);

   413

   414

	if (type == NETWORK_GAME_PASSWORD) {

   415

		ShowNetworkNeedGamePassword();

   416

		return NETWORK_RECV_STATUS_OKAY;

   417

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   418

		ShowNetworkNeedCompanyPassword();

   419

		return NETWORK_RECV_STATUS_OKAY;

   420

	}

   421

   422

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   423

}

   424

   425

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   426

{

   427

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   428

   429

	// Start receiving the map

   430

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   431

	return NETWORK_RECV_STATUS_OKAY;

   432

}

   433

   434

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   435

{

   436

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   437

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   438

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   439

   440

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

   441

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

   442

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

   443

   444

	return NETWORK_RECV_STATUS_OKAY;

   445

}

   446

   447

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   448

{

   449

	static char filename[256];

   450

	static FILE *file_pointer;

   451

   452

	byte maptype;

   453

   454

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   455

   456

	if (MY_CLIENT->quited)

   457

		return NETWORK_RECV_STATUS_CONN_LOST;

   458

   459

	// First packet, init some stuff

   460

	if (maptype == MAP_PACKET_START) {

   461

		// The name for the temp-map

   462

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

   463

   464

		file_pointer = fopen(filename, "wb");

   465

		if (file_pointer == NULL) {

   466

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   467

			return NETWORK_RECV_STATUS_SAVEGAME;

   468

		}

   469

   470

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

   471

   472

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   473

		_network_join_kbytes = 0;

   474

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   475

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   476

   477

		// The first packet does not contain any more data

   478

		return NETWORK_RECV_STATUS_OKAY;

   479

	}

   480

   481

	if (maptype == MAP_PACKET_NORMAL) {

   482

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

   483

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

   484

   485

		_network_join_kbytes = ftell(file_pointer) / 1024;

   486

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   487

	}

   488

   489

	if (maptype == MAP_PACKET_PATCH) {

   490

		NetworkRecvPatchSettings(MY_CLIENT, p);

   491

	}

   492

   493

	// Check if this was the last packet

   494

	if (maptype == MAP_PACKET_END) {

   495

		fclose(file_pointer);

   496

   497

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   498

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   499

   500

		// The map is done downloading, load it

   501

		// Load the map

   502

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

   503

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   504

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   505

			return NETWORK_RECV_STATUS_SAVEGAME;

   506

		}

   507

   508

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

   509

   510

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

   511

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   512

   513

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

   514

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

   515

   516

			if (_network_playas == OWNER_SPECTATOR) {

   517

				// The client wants to be a spectator..

   518

				_local_player = OWNER_SPECTATOR;