1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../string.h"

     8

#include "../strings.h"

     9

#include "network_data.h"

    10

#include "core/tcp.h"

    11

#include "../date.h"

    12

#include "table/strings.h"

    13

#include "../functions.h"

    14

#include "network_client.h"

    15

#include "network_gamelist.h"

    16

#include "network_gui.h"

    17

#include "../saveload.h"

    18

#include "../command.h"

    19

#include "../window.h"

    20

#include "../console.h"

    21

#include "../variables.h"

    22

#include "../ai/ai.h"

    23

#include "../helpers.hpp"

    24

    25

// This file handles all the client-commands

    26

    27

    28

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

    29

#define MY_CLIENT DEREF_CLIENT(0)

    30

    31

static uint32 last_ack_frame;

    32

    33

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

    34

// Sending functions

    35

//   DEF_CLIENT_SEND_COMMAND has no parameters

    36

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

    37

    38

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    39

{

    40

	//

    41

	// Packet: CLIENT_COMPANY_INFO

    42

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

    43

	// Data:

    44

	//    <none>

    45

	//

    46

	Packet *p;

    47

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    48

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    49

    50

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    51

	NetworkSend_Packet(p, MY_CLIENT);

    52

}

    53

    54

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    55

{

    56

	//

    57

	// Packet: CLIENT_JOIN

    58

	// Function: Try to join the server

    59

	// Data:

    60

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

    61

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    62

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

    63

	//    uint8:  Language ID

    64

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

    65

	//

    66

    67

	extern const char _openttd_revision[];

    68

	Packet *p;

    69

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    70

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    71

    72

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    73

	NetworkSend_string(p, _openttd_revision);

    74

	NetworkSend_string(p, _network_player_name); // Player name

    75

	NetworkSend_uint8(p, _network_playas); // PlayAs

    76

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    77

	NetworkSend_string(p, _network_unique_id);

    78

	NetworkSend_Packet(p, MY_CLIENT);

    79

}

    80

    81

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

    82

{

    83

	//

    84

	// Packet: CLIENT_PASSWORD

    85

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

    86

	// Data:

    87

	//    uint8:  NetworkPasswordType

    88

	//    String: Password

    89

	//

    90

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    91

	NetworkSend_uint8(p, type);

    92

	NetworkSend_string(p, password);

    93

	NetworkSend_Packet(p, MY_CLIENT);

    94

}

    95

    96

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    97

{

    98

	//

    99

	// Packet: CLIENT_GETMAP

   100

	// Function: Request the map from the server

   101

	// Data:

   102

	//    <none>

   103

	//

   104

   105

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   106

	NetworkSend_Packet(p, MY_CLIENT);

   107

}

   108

   109

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   110

{

   111

	//

   112

	// Packet: CLIENT_MAP_OK

   113

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

   114

	// Data:

   115

	//    <none>

   116

	//

   117

   118

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   119

	NetworkSend_Packet(p, MY_CLIENT);

   120

}

   121

   122

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   123

{

   124

	//

   125

	// Packet: CLIENT_ACK

   126

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

   127

	// Data:

   128

	//    uint32: current FrameCounter of the client

   129

	//

   130

   131

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   132

   133

	NetworkSend_uint32(p, _frame_counter);

   134

	NetworkSend_Packet(p, MY_CLIENT);

   135

}

   136

   137

// Send a command packet to the server

   138

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   139

{

   140

	//

   141

	// Packet: CLIENT_COMMAND

   142

	// Function: Send a DoCommand to the Server

   143

	// Data:

   144

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

   145

	//    uint32: CommandID (see command.h)

   146

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

   147

	//    uint32: P2

   148

	//    uint32: Tile

   149

	//    string: text

   150

	//    uint8:  CallBackID (see callback_table.c)

   151

	//

   152

   153

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   154

   155

	NetworkSend_uint8(p, cp->player);

   156

	NetworkSend_uint32(p, cp->cmd);

   157

	NetworkSend_uint32(p, cp->p1);

   158

	NetworkSend_uint32(p, cp->p2);

   159

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

   160

	NetworkSend_string(p, cp->text);

   161

	NetworkSend_uint8(p, cp->callback);

   162

   163

	NetworkSend_Packet(p, MY_CLIENT);

   164

}

   165

   166

// Send a chat-packet over the network

   167

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

   168

{

   169

	//

   170

	// Packet: CLIENT_CHAT

   171

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

   172

	// Data:

   173

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

   174

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

   175

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

   176

	//    String: Message (max MAX_TEXT_MSG_LEN)

   177

	//

   178

   179

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   180

   181

	NetworkSend_uint8(p, action);

   182

	NetworkSend_uint8(p, type);

   183

	NetworkSend_uint8(p, dest);

   184

	NetworkSend_string(p, msg);

   185

	NetworkSend_Packet(p, MY_CLIENT);

   186

}

   187

   188

// Send an error-packet over the network

   189

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   190

{

   191

	//

   192

	// Packet: CLIENT_ERROR

   193

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

   194

	// Data:

   195

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

   196

	//

   197

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   198

   199

	NetworkSend_uint8(p, errorno);

   200

	NetworkSend_Packet(p, MY_CLIENT);

   201

}

   202

   203

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   204

{

   205

	//

   206

	// Packet: PACKET_CLIENT_SET_PASSWORD

   207

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

   208

	// Data:

   209

	//    String: Password

   210

	//

   211

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   212

   213

	NetworkSend_string(p, password);

   214

	NetworkSend_Packet(p, MY_CLIENT);

   215

}

   216

   217

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   218

{

   219

	//

   220

	// Packet: PACKET_CLIENT_SET_NAME

   221

	// Function: Gives the player a new name

   222

	// Data:

   223

	//    String: Name

   224

	//

   225

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   226

   227

	NetworkSend_string(p, name);

   228

	NetworkSend_Packet(p, MY_CLIENT);

   229

}

   230

   231

// Send an quit-packet over the network

   232

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   233

{

   234

	//

   235

	// Packet: CLIENT_QUIT

   236

	// Function: The client is quiting the game

   237

	// Data:

   238

	//    String: leave-message

   239

	//

   240

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   241

   242

	NetworkSend_string(p, leavemsg);

   243

	NetworkSend_Packet(p, MY_CLIENT);

   244

}

   245

   246

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

   247

{

   248

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   249

	NetworkSend_string(p, pass);

   250

	NetworkSend_string(p, command);

   251

	NetworkSend_Packet(p, MY_CLIENT);

   252

}

   253

   254

   255

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

   256

// Receiving functions

   257

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   258

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

   259

   260

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

   261

   262

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   263

{

   264

	// We try to join a server which is full

   265

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   266

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   267

   268

	return NETWORK_RECV_STATUS_SERVER_FULL;

   269

}

   270

   271

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   272

{

   273

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

   274

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   275

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   276

   277

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   278

}

   279

   280

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   281

{

   282

	byte company_info_version;

   283

	int i;

   284

   285

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   286

   287

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

   288

		byte total;

   289

		PlayerID current;

   290

   291

		total = NetworkRecv_uint8(MY_CLIENT, p);

   292

   293

		// There is no data at all..

   294

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   295

   296

		current = (Owner)NetworkRecv_uint8(MY_CLIENT, p);

   297

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   298

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

   311

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

   312

   313

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   314

   315

		return NETWORK_RECV_STATUS_OKAY;

   316

	}

   317

   318

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   319

}

   320

   321

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

   322

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

   323

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

   324

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   325

{

   326

	NetworkClientInfo *ci;

   327

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   328

	PlayerID playas = (Owner)NetworkRecv_uint8(MY_CLIENT, p);

   329

	char name[NETWORK_NAME_LENGTH];

   330

	char unique_id[NETWORK_NAME_LENGTH];

   331

   332

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

   333

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

   334

   335

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   336

   337

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

   338

	if (index == _network_own_client_index) _network_playas = playas;

   339

   340

	ci = NetworkFindClientInfoFromIndex(index);

   341

	if (ci != NULL) {

   342

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

   343

			// Client name changed, display the change

   344

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

   345

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

   346

			// The player changed from client-player..

   347

			// Do not display that for now

   348

		}

   349

   350

		ci->client_playas = playas;

   351

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

   352

   353

		InvalidateWindow(WC_CLIENT_LIST, 0);

   354

   355

		return NETWORK_RECV_STATUS_OKAY;

   356

	}

   357

   358

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

   359

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   360

	if (ci != NULL) {

   361

		ci->client_index = index;

   362

		ci->client_playas = playas;

   363

   364

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

   365

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

   366

   367

		InvalidateWindow(WC_CLIENT_LIST, 0);

   368

   369

		return NETWORK_RECV_STATUS_OKAY;

   370

	}

   371

   372

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

   373

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   374

}

   375

   376

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   377

{

   378

	NetworkErrorCode error = (NetworkErrorCode)NetworkRecv_uint8(MY_CLIENT, p);

   379

   380

	switch (error) {

   381

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

   382

		case NETWORK_ERROR_NOT_AUTHORIZED:

   383

		case NETWORK_ERROR_NOT_EXPECTED:

   384

		case NETWORK_ERROR_PLAYER_MISMATCH:

   385

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   386

			break;

   387

		case NETWORK_ERROR_FULL:

   388

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   389

			break;

   390

		case NETWORK_ERROR_WRONG_REVISION:

   391

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   392

			break;

   393

		case NETWORK_ERROR_WRONG_PASSWORD:

   394

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   395

			break;

   396

		case NETWORK_ERROR_KICKED:

   397

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   398

			break;

   399

		case NETWORK_ERROR_CHEATER:

   400

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   401

			break;

   402

		default:

   403

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   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 = (NetworkPasswordType)NetworkRecv_uint8(MY_CLIENT, p);

   414

   415

	switch (type) {

   416

		case NETWORK_GAME_PASSWORD:

   417

		case NETWORK_COMPANY_PASSWORD:

   418

			ShowNetworkNeedPassword(type);

   419

			return NETWORK_RECV_STATUS_OKAY;

   420

   421

		default: return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   422

	}

   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, "The server is currently busy sending the map to someone else, please wait..." );

   442

	DEBUG(net, 1, "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->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   457

   458

	// First packet, init some stuff

   459

	if (maptype == MAP_PACKET_START) {

   460

		// The name for the temp-map

   461

		snprintf(filename, lengthof(filename), "%s%snetwork_client.tmp",  _paths.autosave_dir, PATHSEP);

   462

   463

		file_pointer = fopen(filename, "wb");

   464

		if (file_pointer == NULL) {

   465

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   466

			return NETWORK_RECV_STATUS_SAVEGAME;

   467

		}

   468

   469

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

   470

   471

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   472

		_network_join_kbytes = 0;

   473

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   474

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   475

   476

		// The first packet does not contain any more data

   477

		return NETWORK_RECV_STATUS_OKAY;

   478

	}

   479

   480

	if (maptype == MAP_PACKET_NORMAL) {

   481

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

   482

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

   483

   484

		_network_join_kbytes = ftell(file_pointer) / 1024;

   485

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   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

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

   497

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   498

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   499

			return NETWORK_RECV_STATUS_SAVEGAME;

   500

		}

   501

		/* If the savegame has successfully loaded, ALL windows have been removed,

   502

		 * only toolbar/statusbar and gamefield are visible */

   503

   504

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

   505

   506

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

   507

		SEND_COMMAND(PACKET_CLIENT_MAP_OK)();

   508

   509

		/* New company/spectator (invalid player) or company we want to join is not active

   510

		 * Switch local player to spectator and await the server's judgement */

   511

		if (_network_playas == PLAYER_NEW_COMPANY || !IsValidPlayer(_network_playas) ||

   512

				!GetPlayer(_network_playas)->is_active) {

   513