1

/* $Id$ */

     2

     3

/** @file network_gui.cpp Implementation of the Network related GUIs. */

     4

     5

#ifdef ENABLE_NETWORK

     6

#include "../stdafx.h"

     7

#include "../openttd.h"

     8

#include "../strings_func.h"

     9

#include "network.h"

    10

#include "../date_func.h"

    11

#include "../fios.h"

    12

#include "network_data.h"

    13

#include "network_client.h"

    14

#include "network_gui.h"

    15

#include "network_gamelist.h"

    16

#include "../gui.h"

    17

#include "../window_gui.h"

    18

#include "../textbuf_gui.h"

    19

#include "../variables.h"

    20

#include "network_server.h"

    21

#include "network_udp.h"

    22

#include "../town.h"

    23

#include "../newgrf.h"

    24

#include "../functions.h"

    25

#include "../window_func.h"

    26

#include "../core/alloc_func.hpp"

    27

#include "../string_func.h"

    28

#include "../gfx_func.h"

    29

#include "../player_func.h"

    30

#include "../settings_type.h"

    31

#include "../widgets/dropdown_func.h"

    32

#include "../querystring_gui.h"

    33

#include "../sortlist_type.h"

    34

    35

#include "table/strings.h"

    36

#include "../table/sprites.h"

    37

    38

#define BGC 5

    39

#define BTC 15

    40

    41

/* Global to remember sorting after window has been closed */

    42

static Listing _ng_sorting;

    43

    44

static bool _chat_tab_completion_active;

    45

    46

static void ShowNetworkStartServerWindow();

    47

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    48

extern void SwitchMode(int new_mode);

    49

    50

static const StringID _connection_types_dropdown[] = {

    51

	STR_NETWORK_LAN_INTERNET,

    52

	STR_NETWORK_INTERNET_ADVERTISE,

    53

	INVALID_STRING_ID

    54

};

    55

    56

static const StringID _lan_internet_types_dropdown[] = {

    57

	STR_NETWORK_LAN,

    58

	STR_NETWORK_INTERNET,

    59

	INVALID_STRING_ID

    60

};

    61

    62

static StringID _language_dropdown[NETLANG_COUNT + 1] = {STR_NULL};

    63

    64

void SortNetworkLanguages()

    65

{

    66

	/* Init the strings */

    67

	if (_language_dropdown[0] == STR_NULL) {

    68

		for (int i = 0; i < NETLANG_COUNT; i++) _language_dropdown[i] = STR_NETWORK_LANG_ANY + i;

    69

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    70

	}

    71

    72

	/* Sort the strings (we don't move 'any' and the 'invalid' one) */

    73

	qsort(&_language_dropdown[1], NETLANG_COUNT - 1, sizeof(StringID), &StringIDSorter);

    74

}

    75

    76

enum {

    77

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    78

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    79

	NET_PRC__SIZE_OF_ROW                = 14,

    80

};

    81

    82

/** Update the network new window because a new server is

    83

 * found on the network.

    84

 * @param unselect unselect the currently selected item */

    85

void UpdateNetworkGameWindow(bool unselect)

    86

{

    87

	InvalidateWindowData(WC_NETWORK_WINDOW, 0, unselect);

    88

}

    89

    90

static bool _internal_sort_order; // Used for Qsort order-flipping

    91

typedef int CDECL NGameNameSortFunction(const void*, const void*);

    92

    93

/** Qsort function to sort by name. */

    94

static int CDECL NGameNameSorter(const void *a, const void *b)

    95

{

    96

	const NetworkGameList *cmp1 = *(const NetworkGameList**)a;

    97

	const NetworkGameList *cmp2 = *(const NetworkGameList**)b;

    98

	int r = strcasecmp(cmp1->info.server_name, cmp2->info.server_name);

    99

   100

	return _internal_sort_order ? -r : r;

   101

}

   102

   103

/** Qsort function to sort by the amount of clients online on a

   104

 * server. If the two servers have the same amount, the one with the

   105

 * higher maximum is preferred. */

   106

static int CDECL NGameClientSorter(const void *a, const void *b)

   107

{

   108

	const NetworkGameList *cmp1 = *(const NetworkGameList**)a;

   109

	const NetworkGameList *cmp2 = *(const NetworkGameList**)b;

   110

	/* Reverse as per default we are interested in most-clients first */

   111

	int r = cmp1->info.clients_on - cmp2->info.clients_on;

   112

   113

	if (r == 0) r = cmp1->info.clients_max - cmp2->info.clients_max;

   114

	if (r == 0) r = strcasecmp(cmp1->info.server_name, cmp2->info.server_name);

   115

   116

	return _internal_sort_order ? -r : r;

   117

}

   118

   119

/** Qsort function to sort by joinability. If both servers are the

   120

 * same, prefer the non-passworded server first. */

   121

static int CDECL NGameAllowedSorter(const void *a, const void *b)

   122

{

   123

	const NetworkGameList *cmp1 = *(const NetworkGameList**)a;

   124

	const NetworkGameList *cmp2 = *(const NetworkGameList**)b;

   125

   126

	/* The servers we do not know anything about (the ones that did not reply) should be at the bottom) */

   127

	int r = StrEmpty(cmp1->info.server_revision) - StrEmpty(cmp2->info.server_revision);

   128

   129

	/* Reverse default as we are interested in version-compatible clients first */

   130

	if (r == 0) r = cmp2->info.version_compatible - cmp1->info.version_compatible;

   131

	/* The version-compatible ones are then sorted with NewGRF compatible first, incompatible last */

   132

	if (r == 0) r = cmp2->info.compatible - cmp1->info.compatible;

   133

	/* Passworded servers should be below unpassworded servers */

   134

	if (r == 0) r = cmp1->info.use_password - cmp2->info.use_password;

   135

	/* Finally sort on the name of the server */

   136

	if (r == 0) r = strcasecmp(cmp1->info.server_name, cmp2->info.server_name);

   137

   138

	return _internal_sort_order ? -r : r;

   139

}

   140

   141

/** Enum for NetworkGameWindow, referring to _network_game_window_widgets */

   142

enum NetworkGameWindowWidgets {

   143

	NGWW_CLOSE,         ///< Close 'X' button

   144

	NGWW_CAPTION,       ///< Caption of the window

   145

	NGWW_RESIZE,        ///< Resize button

   146

   147

	NGWW_CONNECTION,    ///< Label in from of connection droplist

   148

	NGWW_CONN_BTN,      ///< 'Connection' droplist button

   149

	NGWW_PLAYER,        ///< Panel with editbox to set player name

   150

   151

	NGWW_NAME,          ///< 'Name' button

   152

	NGWW_CLIENTS,       ///< 'Clients' button

   153

	NGWW_INFO,          ///< Third button in the game list panel

   154

   155

	NGWW_MATRIX,        ///< Panel with list of games

   156

	NGWW_SCROLLBAR,     ///< Scrollbar of matrix

   157

   158

	NGWW_LASTJOINED_LABEL, ///< Label "Last joined server:"

   159

	NGWW_LASTJOINED,    ///< Info about the last joined server

   160

   161

	NGWW_DETAILS,       ///< Panel with game details

   162

	NGWW_JOIN,          ///< 'Join game' button

   163

	NGWW_REFRESH,       ///< 'Refresh server' button

   164

	NGWW_NEWGRF,        ///< 'NewGRF Settings' button

   165

   166

	NGWW_FIND,          ///< 'Find server' button

   167

	NGWW_ADD,           ///< 'Add server' button

   168

	NGWW_START,         ///< 'Start server' button

   169

	NGWW_CANCEL,        ///< 'Cancel' button

   170

};

   171

   172

typedef GUIList<NetworkGameList*> GUIGameServerList;

   173

   174

struct NetworkGameWindow : public QueryStringBaseWindow {

   175

	byte field;                  ///< selected text-field

   176

	NetworkGameList *server;     ///< selected server

   177

	GUIGameServerList servers;   ///< list with game servers.

   178

   179

	NetworkGameWindow(const WindowDesc *desc) : QueryStringBaseWindow(desc)

   180

	{

   181

		ttd_strlcpy(this->edit_str_buf, _network_player_name, lengthof(this->edit_str_buf));

   182

		this->afilter = CS_ALPHANUMERAL;

   183

		InitializeTextBuffer(&this->text, this->edit_str_buf, lengthof(this->edit_str_buf), 120);

   184

   185

		UpdateNetworkGameWindow(true);

   186

   187

		this->vscroll.cap = 11;

   188

		this->resize.step_height = NET_PRC__SIZE_OF_ROW;

   189

   190

		this->field = NGWW_PLAYER;

   191

		this->server = NULL;

   192

   193

		this->servers.flags = VL_REBUILD | (_ng_sorting.order ? VL_DESC : VL_NONE);

   194

		this->servers.sort_type = _ng_sorting.criteria;

   195

   196

		this->FindWindowPlacementAndResize(desc);

   197

	}

   198

   199

	~NetworkGameWindow()

   200

	{

   201

	}

   202

   203

	/**

   204

	 * (Re)build the network game list as its amount has changed because

   205

	 * an item has been added or deleted for example

   206

	 */

   207

	void BuildNetworkGameList()

   208

	{

   209

		if (!(this->servers.flags & VL_REBUILD)) return;

   210

   211

		/* Create temporary array of games to use for listing */

   212

		this->servers.Clear();

   213

   214

		for (NetworkGameList *ngl = _network_game_list; ngl != NULL; ngl = ngl->next) {

   215

			*this->servers.Append() = ngl;

   216

		}

   217

   218

		this->servers.Compact();

   219

   220

		/* Force resort */

   221

		this->servers.flags &= ~VL_REBUILD;

   222

		this->servers.flags |= VL_RESORT;

   223

	}

   224

   225

	void SortNetworkGameList()

   226

	{

   227

		static NGameNameSortFunction * const ngame_sorter[] = {

   228

			&NGameNameSorter,

   229

			&NGameClientSorter,

   230

			&NGameAllowedSorter

   231

		};

   232

   233

		NetworkGameList *item;

   234

		uint i;

   235

   236

		if (!(this->servers.flags & VL_RESORT)) return;

   237

		if (this->servers.Length() == 0) return;

   238

   239

		_internal_sort_order = !!(this->servers.flags & VL_DESC);

   240

		qsort(this->servers.Begin(), this->servers.Length(), sizeof(*this->servers.Begin()), ngame_sorter[this->servers.sort_type]);

   241

   242

		/* After sorting ngl->sort_list contains the sorted items. Put these back

   243

		 * into the original list. Basically nothing has changed, we are only

   244

		 * shuffling the ->next pointers */

   245

		_network_game_list = this->servers[0];

   246

		for (item = _network_game_list, i = 1; i != this->servers.Length(); i++) {

   247

			item->next = this->servers[i];

   248

			item = item->next;

   249

		}

   250

		item->next = NULL;

   251

   252

		this->servers.flags &= ~VL_RESORT;

   253

	}

   254

   255

	/**

   256

	 * Draw a single server line.

   257

	 * @param cur_item  the server to draw.

   258

	 * @param y         from where to draw?

   259

	 * @param highlight does the line need to be highlighted?

   260

	 */

   261

	void DrawServerLine(const NetworkGameList *cur_item, uint y, bool highlight)

   262

	{

   263

		/* show highlighted item with a different colour */

   264

		if (highlight) GfxFillRect(this->widget[NGWW_NAME].left + 1, y - 2, this->widget[NGWW_INFO].right - 1, y + 9, 10);

   265

   266

		SetDParamStr(0, cur_item->info.server_name);

   267

		DrawStringTruncated(this->widget[NGWW_NAME].left + 5, y, STR_02BD, TC_BLACK, this->widget[NGWW_NAME].right - this->widget[NGWW_NAME].left - 5);

   268

   269

		SetDParam(0, cur_item->info.clients_on);

   270

		SetDParam(1, cur_item->info.clients_max);

   271

		SetDParam(2, cur_item->info.companies_on);

   272

		SetDParam(3, cur_item->info.companies_max);

   273

		DrawStringCentered(this->widget[NGWW_CLIENTS].left + 39, y, STR_NETWORK_GENERAL_ONLINE, TC_GOLD);

   274

   275

		/* only draw icons if the server is online */

   276

		if (cur_item->online) {

   277

			/* draw a lock if the server is password protected */

   278

			if (cur_item->info.use_password) DrawSprite(SPR_LOCK, PAL_NONE, this->widget[NGWW_INFO].left + 5, y - 1);

   279

   280

			/* draw red or green icon, depending on compatibility with server */

   281

			DrawSprite(SPR_BLOT, (cur_item->info.compatible ? PALETTE_TO_GREEN : (cur_item->info.version_compatible ? PALETTE_TO_YELLOW : PALETTE_TO_RED)), this->widget[NGWW_INFO].left + 15, y);

   282

   283

			/* draw flag according to server language */

   284

			DrawSprite(SPR_FLAGS_BASE + cur_item->info.server_lang, PAL_NONE, this->widget[NGWW_INFO].left + 25, y);

   285

		}

   286

	}

   287

   288

	virtual void OnPaint()

   289

	{

   290

		const NetworkGameList *sel = this->server;

   291

		const SortButtonState arrow = (this->servers.flags & VL_DESC) ? SBS_DOWN : SBS_UP;

   292

   293

		if (this->servers.flags & VL_REBUILD) {

   294

			this->BuildNetworkGameList();

   295

			SetVScrollCount(this, this->servers.Length());

   296

		}

   297

		if (this->servers.flags & VL_RESORT) this->SortNetworkGameList();

   298

   299

		/* 'Refresh' button invisible if no server selected */

   300

		this->SetWidgetDisabledState(NGWW_REFRESH, sel == NULL);

   301

		/* 'Join' button disabling conditions */

   302

		this->SetWidgetDisabledState(NGWW_JOIN, sel == NULL || // no Selected Server

   303

				!sel->online || // Server offline

   304

				sel->info.clients_on >= sel->info.clients_max || // Server full

   305

				!sel->info.compatible); // Revision mismatch

   306

   307

		/* 'NewGRF Settings' button invisible if no NewGRF is used */

   308

		this->SetWidgetHiddenState(NGWW_NEWGRF, sel == NULL ||

   309

				!sel->online ||

   310

				sel->info.grfconfig == NULL);

   311

   312

		SetDParam(0, 0x00);

   313

		SetDParam(1, _lan_internet_types_dropdown[_network_lan_internet]);

   314

		this->DrawWidgets();

   315

   316

		/* Edit box to set player name */

   317

		this->DrawEditBox(NGWW_PLAYER);

   318

   319

		DrawString(this->widget[NGWW_PLAYER].left - 100, 23, STR_NETWORK_PLAYER_NAME, TC_GOLD);

   320

   321

		/* Sort based on widgets: name, clients, compatibility */

   322

		switch (this->servers.sort_type) {

   323

			case NGWW_NAME    - NGWW_NAME: this->DrawSortButtonState(NGWW_NAME,    arrow); break;

   324

			case NGWW_CLIENTS - NGWW_NAME: this->DrawSortButtonState(NGWW_CLIENTS, arrow); break;

   325

			case NGWW_INFO    - NGWW_NAME: this->DrawSortButtonState(NGWW_INFO,    arrow); break;

   326

		}

   327

   328

		uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   329

		int32 n = 0;

   330

		int32 pos = this->vscroll.pos;

   331

		const NetworkGameList *cur_item = _network_game_list;

   332

   333

		while (pos > 0 && cur_item != NULL) {

   334

			pos--;

   335

			cur_item = cur_item->next;

   336

		}

   337

   338

		while (cur_item != NULL) {

   339

			this->DrawServerLine(cur_item, y, cur_item == sel);

   340

   341

			cur_item = cur_item->next;

   342

			y += NET_PRC__SIZE_OF_ROW;

   343

			if (++n == this->vscroll.cap) break; // max number of games in the window

   344

		}

   345

   346

		const NetworkGameList *last_joined = NetworkGameListAddItem(inet_addr(_network_last_host), _network_last_port);

   347

		/* Draw the last joined server, if any */

   348

		if (last_joined != NULL) this->DrawServerLine(last_joined, y = this->widget[NGWW_LASTJOINED].top + 3, last_joined == sel);

   349

   350

		/* Draw the right menu */

   351

		GfxFillRect(this->widget[NGWW_DETAILS].left + 1, 43, this->widget[NGWW_DETAILS].right - 1, 92, 157);

   352

		if (sel == NULL) {

   353

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 58, STR_NETWORK_GAME_INFO, TC_FROMSTRING);

   354

		} else if (!sel->online) {

   355

			SetDParamStr(0, sel->info.server_name);

   356

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 68, STR_ORANGE, TC_FROMSTRING); // game name

   357

   358

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 132, STR_NETWORK_SERVER_OFFLINE, TC_FROMSTRING); // server offline

   359

		} else { // show game info

   360

			uint16 y = 100;

   361

			const uint16 x = this->widget[NGWW_DETAILS].left + 5;

   362

   363

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 48, STR_NETWORK_GAME_INFO, TC_FROMSTRING);

   364

   365

   366

			SetDParamStr(0, sel->info.server_name);

   367

			DrawStringCenteredTruncated(this->widget[NGWW_DETAILS].left, this->widget[NGWW_DETAILS].right, 62, STR_ORANGE, TC_BLACK); // game name

   368

   369

			SetDParamStr(0, sel->info.map_name);

   370

			DrawStringCenteredTruncated(this->widget[NGWW_DETAILS].left, this->widget[NGWW_DETAILS].right, 74, STR_02BD, TC_BLACK); // map name

   371

   372

			SetDParam(0, sel->info.clients_on);

   373

			SetDParam(1, sel->info.clients_max);

   374

			SetDParam(2, sel->info.companies_on);

   375

			SetDParam(3, sel->info.companies_max);

   376

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   377

			y += 10;

   378

   379

			SetDParam(0, STR_NETWORK_LANG_ANY + sel->info.server_lang);

   380

			DrawString(x, y, STR_NETWORK_LANGUAGE, TC_GOLD); // server language

   381

			y += 10;

   382

   383

			SetDParam(0, STR_TEMPERATE_LANDSCAPE + sel->info.map_set);

   384

			DrawString(x, y, STR_NETWORK_TILESET, TC_GOLD); // tileset

   385

			y += 10;

   386

   387

			SetDParam(0, sel->info.map_width);

   388

			SetDParam(1, sel->info.map_height);

   389

			DrawString(x, y, STR_NETWORK_MAP_SIZE, TC_GOLD); // map size

   390

			y += 10;

   391

   392

			SetDParamStr(0, sel->info.server_revision);

   393

			DrawString(x, y, STR_NETWORK_SERVER_VERSION, TC_GOLD); // server version

   394

			y += 10;

   395

   396

			SetDParamStr(0, sel->info.hostname);

   397

			SetDParam(1, sel->port);

   398

			DrawString(x, y, STR_NETWORK_SERVER_ADDRESS, TC_GOLD); // server address

   399

			y += 10;

   400

   401

			SetDParam(0, sel->info.start_date);

   402

			DrawString(x, y, STR_NETWORK_START_DATE, TC_GOLD); // start date

   403

			y += 10;

   404

   405

			SetDParam(0, sel->info.game_date);

   406

			DrawString(x, y, STR_NETWORK_CURRENT_DATE, TC_GOLD); // current date

   407

			y += 10;

   408

   409

			y += 2;

   410

   411

			if (!sel->info.compatible) {

   412

				DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, y, sel->info.version_compatible ? STR_NETWORK_GRF_MISMATCH : STR_NETWORK_VERSION_MISMATCH, TC_FROMSTRING); // server mismatch

   413

			} else if (sel->info.clients_on == sel->info.clients_max) {

   414

				/* Show: server full, when clients_on == clients_max */

   415

				DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, y, STR_NETWORK_SERVER_FULL, TC_FROMSTRING); // server full

   416

			} else if (sel->info.use_password) {

   417

				DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, y, STR_NETWORK_PASSWORD, TC_FROMSTRING); // password warning

   418

			}

   419

   420

			y += 10;

   421

		}

   422

	}

   423

   424

	virtual void OnClick(Point pt, int widget)

   425

	{

   426

		this->field = widget;

   427

		switch (widget) {

   428

			case NGWW_PLAYER:

   429

				ShowOnScreenKeyboard(this, NGWW_PLAYER, 0, 0);

   430

				break;

   431

   432

			case NGWW_CANCEL: // Cancel button

   433

				DeleteWindowById(WC_NETWORK_WINDOW, 0);

   434

				break;

   435

   436

			case NGWW_CONN_BTN: // 'Connection' droplist

   437

				ShowDropDownMenu(this, _lan_internet_types_dropdown, _network_lan_internet, NGWW_CONN_BTN, 0, 0); // do it for widget NSSW_CONN_BTN

   438

				break;

   439

   440

			case NGWW_NAME: // Sort by name

   441

			case NGWW_CLIENTS: // Sort by connected clients

   442

			case NGWW_INFO: // Connectivity (green dot)

   443

				if (this->servers.sort_type == widget - NGWW_NAME) this->servers.flags ^= VL_DESC;

   444

				this->servers.flags |= VL_RESORT;

   445

				this->servers.sort_type = widget - NGWW_NAME;

   446

   447

				_ng_sorting.order = !!(this->servers.flags & VL_DESC);

   448

				_ng_sorting.criteria = this->servers.sort_type;

   449

				this->SetDirty();

   450

				break;

   451

   452

			case NGWW_MATRIX: { // Matrix to show networkgames

   453

				NetworkGameList *cur_item;

   454

				uint32 id_v = (pt.y - NET_PRC__OFFSET_TOP_WIDGET) / NET_PRC__SIZE_OF_ROW;

   455

   456

				if (id_v >= this->vscroll.cap) return; // click out of bounds

   457

				id_v += this->vscroll.pos;

   458

   459

				cur_item = _network_game_list;

   460

				for (; id_v > 0 && cur_item != NULL; id_v--) cur_item = cur_item->next;

   461

   462

				this->server = cur_item;

   463

				this->SetDirty();

   464

			} break;

   465

   466

			case NGWW_LASTJOINED: {

   467

				NetworkGameList *last_joined = NetworkGameListAddItem(inet_addr(_network_last_host), _network_last_port);

   468

				if (last_joined != NULL) {

   469

					this->server = last_joined;

   470

					this->SetDirty();

   471

				}

   472

			} break;

   473

   474

			case NGWW_FIND: // Find server automatically

   475

				switch (_network_lan_internet) {

   476

					case 0: NetworkUDPSearchGame(); break;

   477

					case 1: NetworkUDPQueryMasterServer(); break;

   478

				}

   479

				break;

   480

   481

			case NGWW_ADD: // Add a server

   482

				ShowQueryString(

   483

					BindCString(_network_default_ip),

   484

					STR_NETWORK_ENTER_IP,

   485

					31 | 0x1000,  // maximum number of characters OR

   486

					250, // characters up to this width pixels, whichever is satisfied first

   487

					this, CS_ALPHANUMERAL);