1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

#include "../stdafx.h"

     5

#include "../openttd.h"

     6

#include "../string.h"

     7

#include "../strings_func.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 "../gui.h"

    20

#include "../window_gui.h"

    21

#include "../textbuf_gui.h"

    22

#include "../gfx.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 chatquerystr_d : public querystr_d {

    36

	int dest;

    37

};

    38

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(chatquerystr_d));

    39

    40

struct network_d {

    41

	PlayerID company;        // select company in network lobby

    42

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

    43

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

    44

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

    45

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

    46

};

    47

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_d));

    48

    49

struct network_ql_d {

    50

	network_d n;                 // see above; general stuff

    51

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

    52

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

    53

	list_d l;                    // accompanying list-administration

    54

};

    55

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_ql_d));

    56

    57

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

    58

static Listing _ng_sorting;

    59

    60

static char _edit_str_buf[150];

    61

static bool _chat_tab_completion_active;

    62

    63

static void ShowNetworkStartServerWindow();

    64

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    65

extern void SwitchMode(int new_mode);

    66

    67

static const StringID _connection_types_dropdown[] = {

    68

	STR_NETWORK_LAN_INTERNET,

    69

	STR_NETWORK_INTERNET_ADVERTISE,

    70

	INVALID_STRING_ID

    71

};

    72

    73

static const StringID _lan_internet_types_dropdown[] = {

    74

	STR_NETWORK_LAN,

    75

	STR_NETWORK_INTERNET,

    76

	INVALID_STRING_ID

    77

};

    78

    79

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

    80

    81

void SortNetworkLanguages()

    82

{

    83

	/* Init the strings */

    84

	if (_language_dropdown[0] == STR_NULL) {

    85

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

    86

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    87

	}

    88

    89

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

    90

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

    91

}

    92

    93

enum {

    94

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    95

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    96

	NET_PRC__SIZE_OF_ROW                = 14,

    97

};

    98

    99

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

   100

 * found on the network.

   101

 * @param unselect unselect the currently selected item */

   102

void UpdateNetworkGameWindow(bool unselect)

   103

{

   104

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

   105

}

   106

   107

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

   108

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

   109

   110

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

   111

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

   112

{

   113

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

   114

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

   115

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

   116

   117

	return _internal_sort_order ? -r : r;

   118

}

   119

   120

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

   121

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

   122

 * higher maximum is preferred. */

   123

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

   124

{

   125

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

   126

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

   127

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

   128

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

   129

   130

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

   131

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

   132

   133

	return _internal_sort_order ? -r : r;

   134

}

   135

   136

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

   137

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

   138

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

   139

{

   140

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

   141

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

   142

   143

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

   144

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

   145

   146

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

   147

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

   148

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

   149

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

   150

	/* Passworded servers should be below unpassworded servers */

   151

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

   152

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

   153

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

   154

   155

	return _internal_sort_order ? -r : r;

   156

}

   157

   158

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

   159

 * an item has been added or deleted for example

   160

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

   161

static void BuildNetworkGameList(network_ql_d *nqld)

   162

{

   163

	NetworkGameList *ngl_temp;

   164

	uint n = 0;

   165

   166

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

   167

   168

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

   169

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

   170

	if (n == 0) return;

   171

   172

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

   173

	free(nqld->sort_list);

   174

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

   175

	nqld->l.list_length = n;

   176

   177

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

   178

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

   179

	}

   180

   181

	/* Force resort */

   182

	nqld->l.flags &= ~VL_REBUILD;

   183

	nqld->l.flags |= VL_RESORT;

   184

}

   185

   186

static void SortNetworkGameList(network_ql_d *nqld)

   187

{

   188

	static NGameNameSortFunction * const ngame_sorter[] = {

   189

		&NGameNameSorter,

   190

		&NGameClientSorter,

   191

		&NGameAllowedSorter

   192

	};

   193

   194

	NetworkGameList *item;

   195

	uint i;

   196

   197

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

   198

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

   199

   200

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

   201

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

   202

   203

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

   204

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

   205

	 * shuffling the ->next pointers */

   206

	_network_game_list = nqld->sort_list[0];

   207

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

   208

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

   209

		item = item->next;

   210

	}

   211

	item->next = NULL;

   212

   213

	nqld->l.flags &= ~VL_RESORT;

   214

}

   215

   216

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

   217

enum NetworkGameWindowWidgets {

   218

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

   219

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

   220

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

   221

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

   222

   223

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

   224

	NGWW_CLIENTS,       ///< 'Clients' button

   225

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

   226

   227

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

   228

   229

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

   230

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

   231

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

   232

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

   233

   234

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

   235

	NGWW_ADD,           ///< 'Add server' button

   236

	NGWW_START,         ///< 'Start server' button

   237

	NGWW_CANCEL,        ///< 'Cancel' button

   238

};

   239

   240

/**

   241

 * Handler of actions done in the NetworkStartServer window

   242

 *

   243

 * @param w pointer to the Window structure

   244

 * @param e pointer to window event

   245

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

   246

 * @see     struct _network_game_window_widgets

   247

 * @see     enum NetworkGameWindowWidgets

   248

 */

   249

   250

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

   251

{

   252

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

   253

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

   254

   255

	switch (e->event) {

   256

	case WE_CREATE: // Focus input box

   257

		w->vscroll.cap = 13;

   258

		w->resize.step_height = NET_PRC__SIZE_OF_ROW;

   259

   260

		nd->field = NGWW_PLAYER;

   261

		nd->server = NULL;

   262

   263

		WP(w, network_ql_d).sort_list = NULL;

   264

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

   265

		ld->sort_type = _ng_sorting.criteria;

   266

		break;

   267

   268

	case WE_PAINT: {

   269

		const NetworkGameList *sel = nd->server;

   270

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

   271

   272

		if (ld->flags & VL_REBUILD) {

   273

			BuildNetworkGameList(&WP(w, network_ql_d));

   274

			SetVScrollCount(w, ld->list_length);

   275

		}

   276

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

   277

   278

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

   279

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

   280

		/* 'Join' button disabling conditions */

   281

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

   282

				!sel->online || // Server offline

   283

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

   284

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

   285

   286

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

   287

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

   288

				!sel->online ||

   289

				sel->info.grfconfig == NULL);

   290

   291

		SetDParam(0, 0x00);

   292

		SetDParam(1, _lan_internet_types_dropdown[_network_lan_internet]);

   293

		DrawWindowWidgets(w);

   294

   295

		/* Edit box to set player name */

   296

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

   297

   298

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

   299

   300

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

   301

		switch (ld->sort_type) {

   302

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

   303

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

   304

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

   305

		}

   306

   307

		{ // draw list of games

   308

			uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   309

			int32 n = 0;

   310

			int32 pos = w->vscroll.pos;

   311

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

   312

			const NetworkGameList *cur_item = _network_game_list;

   313

   314

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

   315

				pos--;

   316

				cur_item = cur_item->next;

   317

			}

   318

   319

			while (cur_item != NULL) {

   320

				/* show highlighted item with a different colour */

   321

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

   322

   323

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

   324

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

   325

   326

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

   327

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

   328

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

   329

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

   330

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

   331

   332

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

   333

				if (cur_item->online) {

   334

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

   335

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

   336

   337

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

   338

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

   339

   340

					/* draw flag according to server language */

   341

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

   342

				}

   343

   344

				cur_item = cur_item->next;

   345

				y += NET_PRC__SIZE_OF_ROW;

   346

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

   347

			}

   348

		}

   349

   350

		/* Draw the right menu */

   351

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

   352

		if (sel == NULL) {

   353

			DrawStringCentered(w->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(w->widget[NGWW_DETAILS].left + 115, 68, STR_ORANGE, TC_FROMSTRING); // game name

   357

   358

			DrawStringCentered(w->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 = w->widget[NGWW_DETAILS].left + 5;

   362

   363

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

   364

   365

   366

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

   367

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

   368

   369

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

   370

			DrawStringCenteredTruncated(w->widget[NGWW_DETAILS].left, w->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(w->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(w->widget[NGWW_DETAILS].left + 115, y, STR_NETWORK_SERVER_FULL, TC_FROMSTRING); // server full

   416

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

   417

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

   418

			}

   419

   420

			y += 10;

   421

		}

   422

	} break;

   423

   424

	case WE_CLICK:

   425

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

   426

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

   427

		case NGWW_CANCEL: // Cancel button

   428

			DeleteWindowById(WC_NETWORK_WINDOW, 0);

   429

			break;

   430

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

   431

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

   432

			break;

   433

		case NGWW_NAME: // Sort by name

   434

		case NGWW_CLIENTS: // Sort by connected clients

   435

		case NGWW_INFO: // Connectivity (green dot)

   436

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

   437

			ld->flags |= VL_RESORT;

   438

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

   439

   440

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

   441

			_ng_sorting.criteria = ld->sort_type;

   442

			SetWindowDirty(w);

   443

			break;

   444

		case NGWW_MATRIX: { // Matrix to show networkgames

   445

			NetworkGameList *cur_item;

   446

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

   447

   448

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

   449

			id_v += w->vscroll.pos;

   450

   451

			cur_item = _network_game_list;

   452

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

   453

   454

			nd->server = cur_item;

   455

			SetWindowDirty(w);

   456

		} break;

   457

		case NGWW_FIND: // Find server automatically

   458

			switch (_network_lan_internet) {

   459

				case 0: NetworkUDPSearchGame(); break;

   460

				case 1: NetworkUDPQueryMasterServer(); break;

   461

			}

   462

			break;

   463

		case NGWW_ADD: { // Add a server

   464

			ShowQueryString(

   465

				BindCString(_network_default_ip),

   466

				STR_NETWORK_ENTER_IP,

   467

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

   468

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

   469

				w, CS_ALPHANUMERAL);

   470

		} break;

   471

		case NGWW_START: // Start server

   472

			ShowNetworkStartServerWindow();

   473

			break;

   474

		case NGWW_JOIN: // Join Game

   475

			if (nd->server != NULL) {

   476

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

   477

				_network_last_port = nd->server->port;

   478

				ShowNetworkLobbyWindow(nd->server);

   479

			}

   480

			break;

   481

		case NGWW_REFRESH: // Refresh