1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

#include "../stdafx.h"

     5

#include "../openttd.h"

     6

#include "../string.h"

     7

#include "../strings.h"

     8

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

     9

#include "network.h"

    10

#include "../date.h"

    11

    12

#include "../fios.h"

    13

#include "table/strings.h"

    14

#include "../functions.h"

    15

#include "network_data.h"

    16

#include "network_client.h"

    17

#include "network_gui.h"

    18

#include "network_gamelist.h"

    19

#include "../window.h"

    20

#include "../gui.h"

    21

#include "../gfx.h"

    22

#include "../command.h"

    23

#include "../variables.h"

    24

#include "network_server.h"

    25

#include "network_udp.h"

    26

#include "../settings.h"

    27

#include "../string.h"

    28

#include "../town.h"

    29

#include "../newgrf.h"

    30

#include "../helpers.hpp"

    31

    32

#define BGC 5

    33

#define BTC 15

    34

    35

struct network_d {

    36

	PlayerID company;        // select company in network lobby

    37

	byte field;              // select text-field in start-server and game-listing

    38

	byte widget_id;          ///< The widget that has the pop-up input menu

    39

	NetworkGameList *server; // selected server in lobby and game-listing

    40

	FiosItem *map;           // selected map in start-server

    41

};

    42

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_d));

    43

    44

struct network_ql_d {

    45

	network_d n;                 // see above; general stuff

    46

	querystr_d q;                // text-input in start-server and game-listing

    47

	NetworkGameList **sort_list; // list of games (sorted)

    48

	list_d l;                    // accompanying list-administration

    49

};

    50

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_ql_d));

    51

    52

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

    53

static Listing _ng_sorting;

    54

    55

static char _edit_str_buf[150];

    56

static bool _chat_tab_completion_active;

    57

    58

static void ShowNetworkStartServerWindow();

    59

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    60

extern void SwitchMode(int new_mode);

    61

    62

static const StringID _connection_types_dropdown[] = {

    63

	STR_NETWORK_LAN_INTERNET,

    64

	STR_NETWORK_INTERNET_ADVERTISE,

    65

	INVALID_STRING_ID

    66

};

    67

    68

static const StringID _lan_internet_types_dropdown[] = {

    69

	STR_NETWORK_LAN,

    70

	STR_NETWORK_INTERNET,

    71

	INVALID_STRING_ID

    72

};

    73

    74

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

    75

    76

void SortNetworkLanguages()

    77

{

    78

	/* Init the strings */

    79

	if (_language_dropdown[0] == STR_NULL) {

    80

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

    81

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    82

	}

    83

    84

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

    85

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

    86

}

    87

    88

enum {

    89

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    90

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    91

	NET_PRC__SIZE_OF_ROW                = 14,

    92

};

    93

    94

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

    95

 * found on the network.

    96

 * @param unselect unselect the currently selected item */

    97

void UpdateNetworkGameWindow(bool unselect)

    98

{

    99

	SendWindowMessage(WC_NETWORK_WINDOW, 0, unselect, 0, 0);

   100

}

   101

   102

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

   103

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

   104

   105

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

   106

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

   107

{

   108

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

   109

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

   110

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

   111

   112

	return _internal_sort_order ? -r : r;

   113

}

   114

   115

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

   116

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

   117

 * higher maximum is preferred. */

   118

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

   119

{

   120

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

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

   128

	return _internal_sort_order ? -r : r;

   129

}

   130

   131

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

   132

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

   133

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

   134

{

   135

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

   136

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

   137

   138

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

   139

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

   140

   141

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

   142

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

   143

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

   144

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

   145

	/* Passworded servers should be below unpassworded servers */

   146

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

   147

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

   148

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

   149

   150

	return _internal_sort_order ? -r : r;

   151

}

   152

   153

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

   154

 * an item has been added or deleted for example

   155

 * @param ngl list_d struct that contains all necessary information for sorting */

   156

static void BuildNetworkGameList(network_ql_d *nqld)

   157

{

   158

	NetworkGameList *ngl_temp;

   159

	uint n = 0;

   160

   161

	if (!(nqld->l.flags & VL_REBUILD)) return;

   162

   163

	/* Count the number of games in the list */

   164

	for (ngl_temp = _network_game_list; ngl_temp != NULL; ngl_temp = ngl_temp->next) n++;

   165

	if (n == 0) return;

   166

   167

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

   168

	free(nqld->sort_list);

   169

	nqld->sort_list = MallocT<NetworkGameList*>(n);

   170

	nqld->l.list_length = n;

   171

   172

	for (n = 0, ngl_temp = _network_game_list; ngl_temp != NULL; ngl_temp = ngl_temp->next) {

   173

		nqld->sort_list[n++] = ngl_temp;

   174

	}

   175

   176

	/* Force resort */

   177

	nqld->l.flags &= ~VL_REBUILD;

   178

	nqld->l.flags |= VL_RESORT;

   179

}

   180

   181

static void SortNetworkGameList(network_ql_d *nqld)

   182

{

   183

	static NGameNameSortFunction * const ngame_sorter[] = {

   184

		&NGameNameSorter,

   185

		&NGameClientSorter,

   186

		&NGameAllowedSorter

   187

	};

   188

   189

	NetworkGameList *item;

   190

	uint i;

   191

   192

	if (!(nqld->l.flags & VL_RESORT)) return;

   193

	if (nqld->l.list_length == 0) return;

   194

   195

	_internal_sort_order = !!(nqld->l.flags & VL_DESC);

   196

	qsort(nqld->sort_list, nqld->l.list_length, sizeof(nqld->sort_list[0]), ngame_sorter[nqld->l.sort_type]);

   197

   198

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

   199

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

   200

	 * shuffling the ->next pointers */

   201

	_network_game_list = nqld->sort_list[0];

   202

	for (item = _network_game_list, i = 1; i != nqld->l.list_length; i++) {

   203

		item->next = nqld->sort_list[i];

   204

		item = item->next;

   205

	}

   206

	item->next = NULL;

   207

   208

	nqld->l.flags &= ~VL_RESORT;

   209

}

   210

   211

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

   212

enum NetworkGameWindowWidgets {

   213

	NGWW_CLOSE    = 0,  ///< Close 'X' button

   214

	NGWW_CONN_TXT = 4,  ///< 'Connection' droplist

   215

	NGWW_CONN_BTN = 5,  ///< 'Connection' droplist button

   216

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

   217

   218

	NGWW_NAME     = 7,  ///< 'Name' button

   219

	NGWW_CLIENTS,       ///< 'Clients' button

   220

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

   221

   222

	NGWW_MATRIX   = 10, ///< Panel with list of games

   223

   224

	NGWW_DETAILS  = 12, ///< Panel with game details

   225

	NGWW_JOIN     = 13, ///< 'Join game' button

   226

	NGWW_REFRESH  = 14, ///< 'Refresh server' button

   227

	NGWW_NEWGRF   = 15, ///< 'NewGRF Settings' button

   228

   229

	NGWW_FIND     = 16, ///< 'Find server' button

   230

	NGWW_ADD,           ///< 'Add server' button

   231

	NGWW_START,         ///< 'Start server' button

   232

	NGWW_CANCEL,        ///< 'Cancel' button

   233

};

   234

   235

/**

   236

 * Handler of actions done in the NetworkStartServer window

   237

 *

   238

 * @param w pointer to the Window structure

   239

 * @param e pointer to window event

   240

 * @note    Uses network_ql_d (network_d, querystr_d and list_d) WP macro

   241

 * @see     struct _network_game_window_widgets

   242

 * @see     enum NetworkGameWindowWidgets

   243

 */

   244

   245

static void NetworkGameWindowWndProc(Window *w, WindowEvent *e)

   246

{

   247

	network_d *nd = &WP(w, network_ql_d).n;

   248

	list_d *ld = &WP(w, network_ql_d).l;

   249

   250

	switch (e->event) {

   251

	case WE_CREATE: // Focus input box

   252

		w->vscroll.cap = 13;

   253

		w->resize.step_height = NET_PRC__SIZE_OF_ROW;

   254

   255

		nd->field = NGWW_PLAYER;

   256

		nd->server = NULL;

   257

   258

		WP(w, network_ql_d).sort_list = NULL;

   259

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

   260

		ld->sort_type = _ng_sorting.criteria;

   261

		break;

   262

   263

	case WE_PAINT: {

   264

		const NetworkGameList *sel = nd->server;

   265

		const char *arrow = (ld->flags & VL_DESC) ? DOWNARROW : UPARROW;

   266

   267

		if (ld->flags & VL_REBUILD) {

   268

			BuildNetworkGameList(&WP(w, network_ql_d));

   269

			SetVScrollCount(w, ld->list_length);

   270

		}

   271

		if (ld->flags & VL_RESORT) SortNetworkGameList(&WP(w, network_ql_d));

   272

   273

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

   274

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

   275

		/* 'Join' button disabling conditions */

   276

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

   277

				!sel->online || // Server offline

   278

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

   279

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

   280

   281

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

   282

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

   283

				!sel->online ||

   284

				sel->info.grfconfig == NULL);

   285

   286

		SetDParam(0, 0x00);

   287

		SetDParam(1, _lan_internet_types_dropdown[_network_lan_internet]);

   288

		DrawWindowWidgets(w);

   289

   290

		/* Edit box to set player name */

   291

		DrawEditBox(w, &WP(w, network_ql_d).q, NGWW_PLAYER);

   292

   293

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

   294

   295

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

   296

		switch (ld->sort_type) {

   297

			case NGWW_NAME    - NGWW_NAME: DoDrawString(arrow, w->widget[NGWW_NAME].right    - 10, 42, TC_BLACK); break;

   298

			case NGWW_CLIENTS - NGWW_NAME: DoDrawString(arrow, w->widget[NGWW_CLIENTS].right - 10, 42, TC_BLACK); break;

   299

			case NGWW_INFO    - NGWW_NAME: DoDrawString(arrow, w->widget[NGWW_INFO].right    - 10, 42, TC_BLACK); break;

   300

		}

   301

   302

		{ // draw list of games

   303

			uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   304

			int32 n = 0;

   305

			int32 pos = w->vscroll.pos;

   306

			uint max_name_width = w->widget[NGWW_NAME].right - w->widget[NGWW_NAME].left - 5;

   307

			const NetworkGameList *cur_item = _network_game_list;

   308

   309

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

   310

				pos--;

   311

				cur_item = cur_item->next;

   312

			}

   313

   314

			while (cur_item != NULL) {

   315

				/* show highlighted item with a different colour */

   316

				if (cur_item == sel) GfxFillRect(w->widget[NGWW_NAME].left + 1, y - 2, w->widget[NGWW_INFO].right - 1, y + 9, 10);

   317

   318

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

   319

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

   320

   321

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

   322

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

   323

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

   324

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

   325

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

   326

   327

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

   328

				if (cur_item->online) {

   329

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

   330

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

   331

   332

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

   333

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

   334

   335

					/* draw flag according to server language */

   336

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

   337

				}

   338

   339

				cur_item = cur_item->next;

   340

				y += NET_PRC__SIZE_OF_ROW;

   341

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

   342

			}

   343

		}

   344

   345

		/* Draw the right menu */

   346

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

   347

		if (sel == NULL) {

   348

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

   349

		} else if (!sel->online) {

   350

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

   351

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

   352

   353

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

   354

		} else { // show game info

   355

			uint16 y = 100;

   356

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

   357

   358

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

   359

   360

   361

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

   362

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

   363

   364

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

   365

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

   366

   367

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

   368

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

   369

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

   370

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

   371

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   372

			y += 10;

   373

   374

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

   375

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

   376

			y += 10;

   377

   378

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

   379

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

   380

			y += 10;

   381

   382

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

   383

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

   384

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

   385

			y += 10;

   386

   387

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

   388

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

   389

			y += 10;

   390

   391

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

   392

			SetDParam(1, sel->port);

   393

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

   394

			y += 10;

   395

   396

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

   397

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

   398

			y += 10;

   399

   400

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

   401

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

   402

			y += 10;

   403

   404

			y += 2;

   405

   406

			if (!sel->info.compatible) {

   407

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

   408

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

   409

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

   410

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

   411

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

   412

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

   413

			}

   414

   415

			y += 10;

   416

		}

   417

	} break;

   418

   419

	case WE_CLICK:

   420

		nd->field = e->we.click.widget;

   421

		switch (e->we.click.widget) {

   422

		case NGWW_CANCEL: // Cancel button

   423

			DeleteWindowById(WC_NETWORK_WINDOW, 0);

   424

			break;

   425

		case NGWW_CONN_TXT: case NGWW_CONN_BTN: // 'Connection' droplist

   426

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

   427

			break;

   428

		case NGWW_NAME: // Sort by name

   429

		case NGWW_CLIENTS: // Sort by connected clients

   430

		case NGWW_INFO: // Connectivity (green dot)

   431

			if (ld->sort_type == e->we.click.widget - NGWW_NAME) ld->flags ^= VL_DESC;

   432

			ld->flags |= VL_RESORT;

   433

			ld->sort_type = e->we.click.widget - NGWW_NAME;

   434

   435

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

   436

			_ng_sorting.criteria = ld->sort_type;

   437

			SetWindowDirty(w);

   438

			break;

   439

		case NGWW_MATRIX: { // Matrix to show networkgames

   440

			NetworkGameList *cur_item;

   441

			uint32 id_v = (e->we.click.pt.y - NET_PRC__OFFSET_TOP_WIDGET) / NET_PRC__SIZE_OF_ROW;

   442

   443

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

   444

			id_v += w->vscroll.pos;

   445

   446

			cur_item = _network_game_list;

   447

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

   448

   449

			nd->server = cur_item;

   450

			SetWindowDirty(w);

   451

		} break;

   452

		case NGWW_FIND: // Find server automatically

   453

			switch (_network_lan_internet) {

   454

				case 0: NetworkUDPSearchGame(); break;

   455

				case 1: NetworkUDPQueryMasterServer(); break;

   456

			}

   457

			break;

   458

		case NGWW_ADD: { // Add a server

   459

			ShowQueryString(

   460

				BindCString(_network_default_ip),

   461

				STR_NETWORK_ENTER_IP,

   462

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

   463

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

   464

				w, CS_ALPHANUMERAL);

   465

		} break;

   466

		case NGWW_START: // Start server

   467

			ShowNetworkStartServerWindow();

   468

			break;

   469

		case NGWW_JOIN: // Join Game

   470

			if (nd->server != NULL) {

   471

				snprintf(_network_last_host, sizeof(_network_last_host), "%s", inet_ntoa(*(struct in_addr *)&nd->server->ip));

   472

				_network_last_port = nd->server->port;

   473

				ShowNetworkLobbyWindow(nd->server);

   474

			}

   475

			break;

   476

		case NGWW_REFRESH: // Refresh

   477

			if (nd->server != NULL)

   478

				NetworkUDPQueryServer(nd->server->info.hostname, nd->server->port);

   479

			break;

   480

		case NGWW_NEWGRF: // NewGRF Settings

   481

			if (nd->server != NULL) ShowNewGRFSettings(false, false, false, &nd->server->info.grfconfig);