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 "date.h"

    11

#include "table/strings.h"

    12

#include "functions.h"

    13

#include "network_client.h"

    14

#include "network_gamelist.h"

    15

#include "network_gui.h"

    16

#include "saveload.h"

    17

#include "command.h"

    18

#include "window.h"

    19

#include "console.h"

    20

#include "variables.h"

    21

#include "ai/ai.h"

    22

    23

    24

// This file handles all the client-commands

    25

    26

    27

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

    28

#define MY_CLIENT DEREF_CLIENT(0)

    29

    30

static uint32 last_ack_frame;

    31

    32

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

    33

// Sending functions

    34

//   DEF_CLIENT_SEND_COMMAND has no parameters

    35

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

    36

    37

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    38

{

    39

	//

    40

	// Packet: CLIENT_COMPANY_INFO

    41

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

    42

	// Data:

    43

	//    <none>

    44

	//

    45

	Packet *p;

    46

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    47

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    48

    49

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    50

	NetworkSend_Packet(p, MY_CLIENT);

    51

}

    52

    53

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    54

{

    55

	//

    56

	// Packet: CLIENT_JOIN

    57

	// Function: Try to join the server

    58

	// Data:

    59

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

    60

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    61

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

    62

	//    uint8:  Language ID

    63

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

    64

	//

    65

    66

	extern const char _openttd_revision[];

    67

	Packet *p;

    68

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    69

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    70

    71

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    72

	NetworkSend_string(p, _openttd_revision);

    73

	NetworkSend_string(p, _network_player_name); // Player name

    74

	NetworkSend_uint8(p, _network_playas); // PlayAs

    75

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    76

	NetworkSend_string(p, _network_unique_id);

    77

	NetworkSend_Packet(p, MY_CLIENT);

    78

}

    79

    80

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

    81

{

    82

	//

    83

	// Packet: CLIENT_NEWGRFS_CHECKED

    84

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

    85

	// Data:

    86

	//

    87

    88

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

    89

	NetworkSend_Packet(p, MY_CLIENT);

    90

}

    91

    92

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

    93

{

    94

	//

    95

	// Packet: CLIENT_PASSWORD

    96

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

    97

	// Data:

    98

	//    uint8:  NetworkPasswordType

    99

	//    String: Password

   100

	//

   101

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   102

	NetworkSend_uint8(p, type);

   103

	NetworkSend_string(p, password);

   104

	NetworkSend_Packet(p, MY_CLIENT);

   105

}

   106

   107

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   108

{

   109

	//

   110

	// Packet: CLIENT_GETMAP

   111

	// Function: Request the map from the server

   112

	// Data:

   113

	//    <none>

   114

	//

   115

   116

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   117

	NetworkSend_Packet(p, MY_CLIENT);

   118

}

   119

   120

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   121

{

   122

	//

   123

	// Packet: CLIENT_MAP_OK

   124

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

   125

	// Data:

   126

	//    <none>

   127

	//

   128

   129

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   130

	NetworkSend_Packet(p, MY_CLIENT);

   131

}

   132

   133

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   134

{

   135

	//

   136

	// Packet: CLIENT_ACK

   137

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

   138

	// Data:

   139

	//    uint32: current FrameCounter of the client

   140

	//

   141

   142

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   143

   144

	NetworkSend_uint32(p, _frame_counter);

   145

	NetworkSend_Packet(p, MY_CLIENT);

   146

}

   147

   148

// Send a command packet to the server

   149

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   150

{

   151

	//

   152

	// Packet: CLIENT_COMMAND

   153

	// Function: Send a DoCommand to the Server

   154

	// Data:

   155

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

   156

	//    uint32: CommandID (see command.h)

   157

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

   158

	//    uint32: P2

   159

	//    uint32: Tile

   160

	//    string: text

   161

	//    uint8:  CallBackID (see callback_table.c)

   162

	//

   163

   164

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   165

   166

	NetworkSend_uint8(p, cp->player);

   167

	NetworkSend_uint32(p, cp->cmd);

   168

	NetworkSend_uint32(p, cp->p1);

   169

	NetworkSend_uint32(p, cp->p2);

   170

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

   171

	NetworkSend_string(p, cp->text);

   172

	NetworkSend_uint8(p, cp->callback);

   173

   174

	NetworkSend_Packet(p, MY_CLIENT);

   175

}

   176

   177

// Send a chat-packet over the network

   178

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

   179

{

   180

	//

   181

	// Packet: CLIENT_CHAT

   182

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

   183

	// Data:

   184

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

   185

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

   186

	//    uint16: Destination Player

   187

	//    String: Message (max MAX_TEXT_MSG_LEN)

   188

	//

   189

   190

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   191

   192

	NetworkSend_uint8(p, action);

   193

	NetworkSend_uint8(p, type);

   194

	NetworkSend_uint16(p, dest);

   195

	NetworkSend_string(p, msg);

   196

	NetworkSend_Packet(p, MY_CLIENT);

   197

}

   198

   199

// Send an error-packet over the network

   200

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   201

{

   202

	//

   203

	// Packet: CLIENT_ERROR

   204

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

   205

	// Data:

   206

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

   207

	//

   208

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   209

   210

	NetworkSend_uint8(p, errorno);

   211

	NetworkSend_Packet(p, MY_CLIENT);

   212

}

   213

   214

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   215

{

   216

	//

   217

	// Packet: PACKET_CLIENT_SET_PASSWORD

   218

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

   219

	// Data:

   220

	//    String: Password

   221

	//

   222

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   223

   224

	NetworkSend_string(p, password);

   225

	NetworkSend_Packet(p, MY_CLIENT);

   226

}

   227

   228

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   229

{

   230

	//

   231

	// Packet: PACKET_CLIENT_SET_NAME

   232

	// Function: Gives the player a new name

   233

	// Data:

   234

	//    String: Name

   235

	//

   236

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   237

   238

	NetworkSend_string(p, name);

   239

	NetworkSend_Packet(p, MY_CLIENT);

   240

}

   241

   242

// Send an quit-packet over the network

   243

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   244

{

   245

	//

   246

	// Packet: CLIENT_QUIT

   247

	// Function: The client is quiting the game

   248

	// Data:

   249

	//    String: leave-message

   250

	//

   251

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   252

   253

	NetworkSend_string(p, leavemsg);

   254

	NetworkSend_Packet(p, MY_CLIENT);

   255

}

   256

   257

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

   258

{

   259

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   260

	NetworkSend_string(p, pass);

   261

	NetworkSend_string(p, command);

   262

	NetworkSend_Packet(p, MY_CLIENT);

   263

}

   264

   265

   266

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

   267

// Receiving functions

   268

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   269

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

   270

   271

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

   272

   273

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   274

{

   275

	// We try to join a server which is full

   276

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   277

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   278

   279

	return NETWORK_RECV_STATUS_SERVER_FULL;

   280

}

   281

   282

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   283

{

   284

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

   285

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   286

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   287

   288

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   289

}

   290

   291

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   292

{

   293

	byte company_info_version;

   294

	int i;

   295

   296

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   297

   298

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

   299

		byte total;

   300

		byte current;

   301

   302

		total = NetworkRecv_uint8(MY_CLIENT, p);

   303

   304

		// There is no data at all..

   305

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   306

   307

		current = NetworkRecv_uint8(MY_CLIENT, p);

   308

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   309

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

   322

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

   323

   324

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   325

   326

		return NETWORK_RECV_STATUS_OKAY;

   327

	}

   328

   329

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   330

}

   331

   332

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

   333

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

   334

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

   335

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   336

{

   337

	NetworkClientInfo *ci;

   338

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   339

	PlayerID playas = NetworkRecv_uint8(MY_CLIENT, p);

   340

	char name[NETWORK_NAME_LENGTH];

   341

	char unique_id[NETWORK_NAME_LENGTH];

   342

   343

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

   344

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

   345

   346

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   347

   348

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

   349

	if (index == _network_own_client_index) _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, "%s", 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

	switch (error) {

   392

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

   393

		case NETWORK_ERROR_NOT_AUTHORIZED:

   394

		case NETWORK_ERROR_NOT_EXPECTED:

   395

		case NETWORK_ERROR_PLAYER_MISMATCH:

   396

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   397

			break;

   398

		case NETWORK_ERROR_FULL:

   399

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   400

			break;

   401

		case NETWORK_ERROR_WRONG_REVISION:

   402

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   403

			break;

   404

		case NETWORK_ERROR_WRONG_PASSWORD:

   405

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   406

			break;

   407

		case NETWORK_ERROR_KICKED:

   408

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   409

			break;

   410

		case NETWORK_ERROR_CHEATER:

   411

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   412

			break;

   413

		default:

   414

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   415

	}

   416

   417

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   418

   419

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   420

}

   421

   422

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   423

{

   424

	uint grf_count = NetworkRecv_uint8(MY_CLIENT, p);

   425

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   426

   427

	/* Check all GRFs */

   428

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

   429

		GRFConfig c;

   430

		const GRFConfig *f;

   431

   432

		NetworkRecv_GRFIdentifier(MY_CLIENT, p, &c);

   433

   434

		/* Check whether we know this GRF */

   435

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

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

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

   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)("[NET] The server is currently busy sending the map to someone else.. please hold..." );

   486

	DEBUG(net, 1)("[NET]  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 char filename[256];

   494

	static FILE *file_pointer;

   495

   496

	byte maptype;

   497

   498

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   499

   500

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   501

   502

	// First packet, init some stuff

   503

	if (maptype == MAP_PACKET_START) {

   504

		// The name for the temp-map

   505

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

   506

   507

		file_pointer = fopen(filename, "wb");

   508

		if (file_pointer == NULL) {

   509

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   510

			return NETWORK_RECV_STATUS_SAVEGAME;

   511

		}