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"

    25

    26

// This file handles all the client-commands

    27

    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

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

    35

// Sending functions

    36

//   DEF_CLIENT_SEND_COMMAND has no parameters

    37

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

    38

    39

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    40

{

    41

	//

    42

	// Packet: CLIENT_COMPANY_INFO

    43

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

    44

	// Data:

    45

	//    <none>

    46

	//

    47

	Packet *p;

    48

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    49

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    50

    51

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    52

	MY_CLIENT->Send_Packet(p);

    53

}

    54

    55

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    56

{

    57

	//

    58

	// Packet: CLIENT_JOIN

    59

	// Function: Try to join the server

    60

	// Data:

    61

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

    62

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    63

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

    64

	//    uint8:  Language ID

    65

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

    66

	//

    67

    68

	extern const char _openttd_revision[];

    69

	Packet *p;

    70

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    71

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    72

    73

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    74

	p->Send_string(_openttd_revision);

    75

	p->Send_string(_network_player_name); // Player name

    76

	p->Send_uint8 (_network_playas);      // PlayAs

    77

	p->Send_uint8 (NETLANG_ANY);          // Language

    78

	p->Send_string(_network_unique_id);

    79

	MY_CLIENT->Send_Packet(p);

    80

}

    81

    82

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

    83

{

    84

	//

    85

	// Packet: CLIENT_NEWGRFS_CHECKED

    86

	// Function: Tell the server that we have the required GRFs

    87

	// Data:

    88

	//

    89

    90

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

    91

	MY_CLIENT->Send_Packet(p);

    92

}

    93

    94

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

    95

{

    96

	//

    97

	// Packet: CLIENT_PASSWORD

    98

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

    99

	// Data:

   100

	//    uint8:  NetworkPasswordType

   101

	//    String: Password

   102

	//

   103

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   104

	p->Send_uint8 (type);

   105

	p->Send_string(password);

   106

	MY_CLIENT->Send_Packet(p);

   107

}

   108

   109

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   110

{

   111

	//

   112

	// Packet: CLIENT_GETMAP

   113

	// Function: Request the map from the server

   114

	// Data:

   115

	//    <none>

   116

	//

   117

   118

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   119

	MY_CLIENT->Send_Packet(p);

   120

}

   121

   122

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   123

{

   124

	//

   125

	// Packet: CLIENT_MAP_OK

   126

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

   127

	// Data:

   128

	//    <none>

   129

	//

   130

   131

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   132

	MY_CLIENT->Send_Packet(p);

   133

}

   134

   135

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   136

{

   137

	//

   138

	// Packet: CLIENT_ACK

   139

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

   140

	// Data:

   141

	//    uint32: current FrameCounter of the client

   142

	//

   143

   144

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   145

   146

	p->Send_uint32(_frame_counter);

   147

	MY_CLIENT->Send_Packet(p);

   148

}

   149

   150

// Send a command packet to the server

   151

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   152

{

   153

	//

   154

	// Packet: CLIENT_COMMAND

   155

	// Function: Send a DoCommand to the Server

   156

	// Data:

   157

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

   158

	//    uint32: CommandID (see command.h)

   159

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

   160

	//    uint32: P2

   161

	//    uint32: Tile

   162

	//    string: text

   163

	//    uint8:  CallBackID (see callback_table.c)

   164

	//

   165

   166

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   167

   168

	p->Send_uint8 (cp->player);

   169

	p->Send_uint32(cp->cmd);

   170

	p->Send_uint32(cp->p1);

   171

	p->Send_uint32(cp->p2);

   172

	p->Send_uint32((uint32)cp->tile);

   173

	p->Send_string(cp->text);

   174

	p->Send_uint8 (cp->callback);

   175

   176

	MY_CLIENT->Send_Packet(p);

   177

}

   178

   179

// Send a chat-packet over the network

   180

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

   181

{

   182

	//

   183

	// Packet: CLIENT_CHAT

   184

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

   185

	// Data:

   186

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

   187

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

   188

	//    uint16: Destination Player

   189

	//    String: Message (max MAX_TEXT_MSG_LEN)

   190

	//

   191

   192

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   193

   194

	p->Send_uint8 (action);

   195

	p->Send_uint8 (type);

   196

	p->Send_uint16(dest);

   197

	p->Send_string(msg);

   198

	MY_CLIENT->Send_Packet(p);

   199

}

   200

   201

// Send an error-packet over the network

   202

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   203

{

   204

	//

   205

	// Packet: CLIENT_ERROR

   206

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

   207

	// Data:

   208

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

   209

	//

   210

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   211

   212

	p->Send_uint8(errorno);

   213

	MY_CLIENT->Send_Packet(p);

   214

}

   215

   216

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   217

{

   218

	//

   219

	// Packet: PACKET_CLIENT_SET_PASSWORD

   220

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

   221

	// Data:

   222

	//    String: Password

   223

	//

   224

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   225

   226

	p->Send_string(password);

   227

	MY_CLIENT->Send_Packet(p);

   228

}

   229

   230

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   231

{

   232

	//

   233

	// Packet: PACKET_CLIENT_SET_NAME

   234

	// Function: Gives the player a new name

   235

	// Data:

   236

	//    String: Name

   237

	//

   238

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   239

   240

	p->Send_string(name);

   241

	MY_CLIENT->Send_Packet(p);

   242

}

   243

   244

// Send an quit-packet over the network

   245

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   246

{

   247

	//

   248

	// Packet: CLIENT_QUIT

   249

	// Function: The client is quiting the game

   250

	// Data:

   251

	//    String: leave-message

   252

	//

   253

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   254

   255

	p->Send_string(leavemsg);

   256

	MY_CLIENT->Send_Packet(p);

   257

}

   258

   259

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

   260

{

   261

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   262

	p->Send_string(pass);

   263

	p->Send_string(command);

   264

	MY_CLIENT->Send_Packet(p);

   265

}

   266

   267

   268

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

   269

// Receiving functions

   270

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   271

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

   272

   274

   275

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   276

{

   277

	// We try to join a server which is full

   278

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   279

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   280

   281

	return NETWORK_RECV_STATUS_SERVER_FULL;

   282

}

   283

   284

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   285

{

   286

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

   287

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   288

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   289

   290

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   291

}

   292

   293

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   294

{

   295

	byte company_info_version;

   296

	int i;

   297

   298

	company_info_version = p->Recv_uint8();

   299

   300

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

   301

		byte total;

   302

		PlayerID current;

   303

   304

		total = p->Recv_uint8();

   305

   306

		// There is no data at all..

   307

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   308

   309

		current = (Owner)p->Recv_uint8();

   310

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   311

   312

		p->Recv_string(_network_player_info[current].company_name, sizeof(_network_player_info[current].company_name));

   313

		_network_player_info[current].inaugurated_year = p->Recv_uint32();

   314

		_network_player_info[current].company_value    = p->Recv_uint64();

   315

		_network_player_info[current].money            = p->Recv_uint64();

   316

		_network_player_info[current].income           = p->Recv_uint64();

   317

		_network_player_info[current].performance      = p->Recv_uint16();

   318

		_network_player_info[current].use_password     = p->Recv_bool();

   319

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

   320

			_network_player_info[current].num_vehicle[i] = p->Recv_uint16();

   321

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

   322

			_network_player_info[current].num_station[i] = p->Recv_uint16();

   323

   324

		p->Recv_string(_network_player_info[current].players, sizeof(_network_player_info[current].players));

   325

   326

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   327

   328

		return NETWORK_RECV_STATUS_OKAY;

   329

	}

   330

   331

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   332

}

   333

   334

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

   335

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

   336

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

   337

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   338

{

   339

	NetworkClientInfo *ci;

   340

	uint16 index = p->Recv_uint16();

   341

	PlayerID playas = (Owner)p->Recv_uint8();

   342

	char name[NETWORK_NAME_LENGTH];

   343

	char unique_id[NETWORK_NAME_LENGTH];

   344

   345

	p->Recv_string(name, sizeof(name));

   346

	p->Recv_string(unique_id, sizeof(unique_id));

   347

   348

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   349

   350

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

   351

	if (index == _network_own_client_index) _network_playas = playas;

   352

   353

	ci = NetworkFindClientInfoFromIndex(index);

   354

	if (ci != NULL) {

   355

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

   356

			// Client name changed, display the change

   357

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

   358

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

   359

			// The player changed from client-player..

   360

			// Do not display that for now

   361

		}

   362

   363

		ci->client_playas = playas;

   364

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

   365

   366

		InvalidateWindow(WC_CLIENT_LIST, 0);

   367

   368

		return NETWORK_RECV_STATUS_OKAY;

   369

	}

   370

   371

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

   372

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   373

	if (ci != NULL) {

   374

		ci->client_index = index;

   375

		ci->client_playas = playas;

   376

   377

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

   378

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

   379

   380

		InvalidateWindow(WC_CLIENT_LIST, 0);

   381

   382

		return NETWORK_RECV_STATUS_OKAY;

   383

	}

   384

   385

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

   386

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   387

}

   388

   389

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   390

{

   391

	NetworkErrorCode error = (NetworkErrorCode)p->Recv_uint8();

   392

   393

	switch (error) {

   394

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

   395

		case NETWORK_ERROR_NOT_AUTHORIZED:

   396

		case NETWORK_ERROR_NOT_EXPECTED:

   397

		case NETWORK_ERROR_PLAYER_MISMATCH:

   398

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   399

			break;

   400

		case NETWORK_ERROR_FULL:

   401

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   402

			break;

   403

		case NETWORK_ERROR_WRONG_REVISION:

   404

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   405

			break;

   406

		case NETWORK_ERROR_WRONG_PASSWORD:

   407

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   408

			break;

   409

		case NETWORK_ERROR_KICKED:

   410

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   411

			break;

   412

		case NETWORK_ERROR_CHEATER:

   413

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   414

			break;

   415

		default:

   416

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   417

	}

   418

   419

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   420

   421

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   422

}

   423

   424

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   425

{

   426

	uint grf_count = p->Recv_uint8();

   427

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   428

   429

	/* Check all GRFs */

   430

	for (; grf_count > 0; grf_count--) {

   431

		GRFConfig c;

   432

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   433

   434

		/* Check whether we know this GRF */

   435

		const GRFConfig *f = FindGRFConfig(c.grfid, c.md5sum);

   436

		if (f == NULL) {

   437

			/* We do not know this GRF, bail out of initialization */

   438

			char buf[sizeof(c.md5sum) * 2 + 1];

   439

			md5sumToString(buf, lastof(buf), c.md5sum);

   440

			DEBUG(grf, 0, "NewGRF %08X not found; checksum %s", BSWAP32(c.grfid), buf);

   441

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   442

		}

   443

	}

   444

   445

	if (ret == NETWORK_RECV_STATUS_OKAY) {

   446

		/* Start receiving the map */

   447

		SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();

   448

	} else {

   449

		/* NewGRF mismatch, bail out */

   450

		_switch_mode_errorstr = STR_NETWORK_ERR_NEWGRF_MISMATCH;

   451

	}

   452

	return ret;

   453

}

   454

   455

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   456

{

   457

	NetworkPasswordType type = (NetworkPasswordType)p->Recv_uint8();

   458

   459

	switch (type) {

   460

		case NETWORK_GAME_PASSWORD:

   461

		case NETWORK_COMPANY_PASSWORD:

   462

			ShowNetworkNeedPassword(type);

   463

			return NETWORK_RECV_STATUS_OKAY;

   464

   465

		default: return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   466

	}

   467

}

   468

   469

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   470

{

   471

	_network_own_client_index = p->Recv_uint16();

   472

   473

	// Start receiving the map

   474

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   475

	return NETWORK_RECV_STATUS_OKAY;

   476

}

   477

   478

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   479

{

   480

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   481

	_network_join_waiting = p->Recv_uint8();

   482

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   483

   484

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

   485

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

   486

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

   487

   488

	return NETWORK_RECV_STATUS_OKAY;

   489

}

   490

   491

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   492

{

   493

	static FILE *file_pointer;

   494

   495

	byte maptype;

   496

   497

	maptype = p->Recv_uint8();

   498

   499

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   500

   501

	// First packet, init some stuff

   502

	if (maptype == MAP_PACKET_START) {

   504

		if (file_pointer == NULL) {

   505

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   506

			return NETWORK_RECV_STATUS_SAVEGAME;

   507