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

	if (nqld->sort_list == NULL) error("Could not allocate memory for the network-game-sorting-list");

   171

	nqld->l.list_length = n;

   172

   173

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

   174

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

   175

	}

   176

   177

	/* Force resort */

   178

	nqld->l.flags &= ~VL_REBUILD;

   179

	nqld->l.flags |= VL_RESORT;

   180

}

   181

   182

static void SortNetworkGameList(network_ql_d *nqld)

   183

{

   184

	static NGameNameSortFunction * const ngame_sorter[] = {

   185

		&NGameNameSorter,

   186

		&NGameClientSorter,

   187

		&NGameAllowedSorter

   188

	};

   189

   190

	NetworkGameList *item;

   191

	uint i;

   192

   193

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

   194

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

   195

   196

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

   197

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

   198

   199

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

   200

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

   201

	 * shuffling the ->next pointers */

   202

	_network_game_list = nqld->sort_list[0];

   203

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

   204

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

   205

		item = item->next;

   206

	}

   207

	item->next = NULL;

   208

   209

	nqld->l.flags &= ~VL_RESORT;

   210

}

   211

   212

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

   213

enum NetworkGameWindowWidgets {

   214

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

   215

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

   216

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

   217

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

   218

   219

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

   220

	NGWW_CLIENTS,       ///< 'Clients' button

   221

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

   222

   223

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

   224

   225

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

   226

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

   227

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

   228

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

   229

   230

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

   231

	NGWW_ADD,           ///< 'Add server' button

   232

	NGWW_START,         ///< 'Start server' button

   233

	NGWW_CANCEL,        ///< 'Cancel' button

   234

};

   235

   236

/**

   237

 * Handler of actions done in the NetworkStartServer window

   238

 *

   239

 * @param w pointer to the Window structure

   240

 * @param e pointer to window event

   241

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

   242

 * @see     struct _network_game_window_widgets

   243

 * @see     enum NetworkGameWindowWidgets

   244

 */

   245

   246

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

   247

{

   248

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

   249

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

   250

   251

	switch (e->event) {

   252

	case WE_CREATE: // Focus input box

   253

		w->vscroll.cap = 13;

   254

		w->resize.step_height = NET_PRC__SIZE_OF_ROW;

   255

   256

		nd->field = NGWW_PLAYER;

   257

		nd->server = NULL;

   258

   259

		WP(w, network_ql_d).sort_list = NULL;

   260

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

   261

		ld->sort_type = _ng_sorting.criteria;

   262

		break;

   263

   264

	case WE_PAINT: {

   265

		const NetworkGameList *sel = nd->server;

   266

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

   267

   268

		if (ld->flags & VL_REBUILD) {

   269

			BuildNetworkGameList(&WP(w, network_ql_d));

   270

			SetVScrollCount(w, ld->list_length);

   271

		}

   272

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

   273

   274

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

   275

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

   276

		/* 'Join' button disabling conditions */

   277

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

   278

				!sel->online || // Server offline

   279

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

   280

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

   281

   282

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

   283

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

   284

				!sel->online ||

   285

				sel->info.grfconfig == NULL);

   286

   287

		SetDParam(0, 0x00);

   288

		SetDParam(1, _lan_internet_types_dropdown[_network_lan_internet]);

   289

		DrawWindowWidgets(w);

   290

   291

		/* Edit box to set player name */

   292

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

   293

   294

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

   295

   296

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

   297

		switch (ld->sort_type) {

   298

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

   299

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

   300

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

   301

		}

   302

   303

		{ // draw list of games

   304

			uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   305

			int32 n = 0;

   306

			int32 pos = w->vscroll.pos;

   307

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

   308

			const NetworkGameList *cur_item = _network_game_list;

   309

   310

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

   311

				pos--;

   312

				cur_item = cur_item->next;

   313

			}

   314

   315

			while (cur_item != NULL) {

   316

				/* show highlighted item with a different colour */

   317

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

   318

   319

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

   320

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

   321

   322

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

   323

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

   324

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

   325

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

   326

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

   327

   328

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

   329

				if (cur_item->online) {

   330

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

   331

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

   332

   333

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

   334

					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);

   335

   336

					/* draw flag according to server language */

   337

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

   338

				}

   339

   340

				cur_item = cur_item->next;

   341

				y += NET_PRC__SIZE_OF_ROW;

   342

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

   343

			}

   344

		}

   345

   346

		/* Draw the right menu */

   347

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

   348

		if (sel == NULL) {

   349

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

   350

		} else if (!sel->online) {

   351

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

   352

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

   353

   354

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

   355

		} else { // show game info

   356

			uint16 y = 100;

   357

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

   358

   359

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

   360

   361

   362

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

   363

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

   364

   365

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

   366

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

   367

   368

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

   369

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

   370

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

   371

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

   372

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   373

			y += 10;

   374

   375

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

   376

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

   377

			y += 10;

   378

   379

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

   380

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

   381

			y += 10;

   382

   383

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

   384

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

   385

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

   386

			y += 10;

   387

   388

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

   389

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

   390

			y += 10;

   391

   392

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

   393

			SetDParam(1, sel->port);

   394

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

   395

			y += 10;

   396

   397

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

   398

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

   399

			y += 10;

   400

   401

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

   402

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

   403

			y += 10;

   404

   405

			y += 2;

   406

   407

			if (!sel->info.compatible) {

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

			}

   415

   416

			y += 10;

   417

		}

   418

	} break;

   419

   420

	case WE_CLICK:

   421

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

   422

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

   423

		case NGWW_CANCEL: // Cancel button

   424

			DeleteWindowById(WC_NETWORK_WINDOW, 0);

   425

			break;

   426

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

   427

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

   428

			break;

   429

		case NGWW_NAME: // Sort by name

   430

		case NGWW_CLIENTS: // Sort by connected clients

   431

		case NGWW_INFO: // Connectivity (green dot)

   432

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

   433

			ld->flags |= VL_RESORT;

   434

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

   435

   436

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

   437

			_ng_sorting.criteria = ld->sort_type;

   438

			SetWindowDirty(w);

   439

			break;

   440

		case NGWW_MATRIX: { // Matrix to show networkgames

   441

			NetworkGameList *cur_item;

   442

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

   443

   444

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

   445

			id_v += w->vscroll.pos;

   446

   447

			cur_item = _network_game_list;

   448

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

   449

   450

			nd->server = cur_item;

   451

			SetWindowDirty(w);

   452

		} break;

   453

		case NGWW_FIND: // Find server automatically

   454

			switch (_network_lan_internet) {

   455

				case 0: NetworkUDPSearchGame(); break;

   456

				case 1: NetworkUDPQueryMasterServer(); break;

   457

			}

   458

			break;

   459

		case NGWW_ADD: { // Add a server

   460

			ShowQueryString(

   461

				BindCString(_network_default_ip),

   462

				STR_NETWORK_ENTER_IP,

   463

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

   464

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

   465

				w, CS_ALPHANUMERAL);

   466

		} break;

   467

		case NGWW_START: // Start server

   468

			ShowNetworkStartServerWindow();

   469

			break;

   470

		case NGWW_JOIN: // Join Game

   471

			if (nd->server != NULL) {

   472

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

   473

				_network_last_port = nd->server->port;

   474

				ShowNetworkLobbyWindow(nd->server);

   475

			}

   476

			break;

   477

		case NGWW_REFRESH: // Refresh

   478

			if (nd->server != NULL)

   479

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

   480

			break;

   481

		case NGWW_NEWGRF: // NewGRF Settings