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

    11

    12

#include "../fios.h"

    13

#include "table/strings.h"

    14

#include "network_data.h"

    15

#include "network_client.h"

    16

#include "network_gui.h"

    17

#include "network_gamelist.h"

    18

#include "../gui.h"

    19

#include "../window_gui.h"

    20

#include "../textbuf_gui.h"

    21

#include "../variables.h"

    22

#include "network_server.h"

    23

#include "network_udp.h"

    24

#include "../string.h"

    25

#include "../town.h"

    26

#include "../newgrf.h"

    27

#include "../functions.h"

    28

#include "../window_func.h"

    29

    30

#define BGC 5

    31

#define BTC 15

    32

    33

struct chatquerystr_d : public querystr_d {

    34

	int dest;

    35

};

    36

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(chatquerystr_d));

    37

    38

struct network_d {

    39

	PlayerID company;        // select company in network lobby

    40

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

    41

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

    42

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

    43

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

    44

};

    45

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_d));

    46

    47

struct network_ql_d {

    48

	network_d n;                 // see above; general stuff

    49

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

    50

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

    51

	list_d l;                    // accompanying list-administration

    52

};

    53

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_ql_d));

    54

    55

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

    56

static Listing _ng_sorting;

    57

    58

static char _edit_str_buf[150];

    59

static bool _chat_tab_completion_active;

    60

    61

static void ShowNetworkStartServerWindow();

    62

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    63

extern void SwitchMode(int new_mode);

    64

    65

static const StringID _connection_types_dropdown[] = {

    66

	STR_NETWORK_LAN_INTERNET,

    67

	STR_NETWORK_INTERNET_ADVERTISE,

    68

	INVALID_STRING_ID

    69

};

    70

    71

static const StringID _lan_internet_types_dropdown[] = {

    72

	STR_NETWORK_LAN,

    73

	STR_NETWORK_INTERNET,

    74

	INVALID_STRING_ID

    75

};

    76

    77

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

    78

    79

void SortNetworkLanguages()

    80

{

    81

	/* Init the strings */

    82

	if (_language_dropdown[0] == STR_NULL) {

    83

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

    84

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    85

	}

    86

    87

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

    88

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

    89

}

    90

    91

enum {

    92

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    93

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    94

	NET_PRC__SIZE_OF_ROW                = 14,

    95

};

    96

    97

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

    98

 * found on the network.

    99

 * @param unselect unselect the currently selected item */

   100

void UpdateNetworkGameWindow(bool unselect)

   101

{

   102

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

   103

}

   104

   105

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

   106

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

   107

   108

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

   109

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

   110

{

   111

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

   112

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

   113

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

   114

   115

	return _internal_sort_order ? -r : r;

   116

}

   117

   118

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

   119

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

   120

 * higher maximum is preferred. */

   121

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

   122

{

   123

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

   124

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

   125

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

   126

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

   127

   128

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

   129

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

   130

   131

	return _internal_sort_order ? -r : r;

   132

}

   133

   134

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

   135

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

   136

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

   137

{

   138

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

   139

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

   140

   141

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

   142

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

   143

   144

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

   145

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

   146

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

   147

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

   148

	/* Passworded servers should be below unpassworded servers */

   149

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

   150

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

   151

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

   152

   153

	return _internal_sort_order ? -r : r;

   154

}

   155

   156

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

   157

 * an item has been added or deleted for example

   158

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

   159

static void BuildNetworkGameList(network_ql_d *nqld)

   160

{

   161

	NetworkGameList *ngl_temp;

   162

	uint n = 0;

   163

   164

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

   165

   166

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

   167

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

   168

	if (n == 0) return;

   169

   170

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

   171

	free(nqld->sort_list);

   172

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

   173

	nqld->l.list_length = n;

   174

   175

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

   176

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

   177

	}

   178

   179

	/* Force resort */

   180

	nqld->l.flags &= ~VL_REBUILD;

   181

	nqld->l.flags |= VL_RESORT;

   182

}

   183

   184

static void SortNetworkGameList(network_ql_d *nqld)

   185

{

   186

	static NGameNameSortFunction * const ngame_sorter[] = {

   187

		&NGameNameSorter,

   188

		&NGameClientSorter,

   189

		&NGameAllowedSorter

   190

	};

   191

   192

	NetworkGameList *item;

   193

	uint i;

   194

   195

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

   196

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

   197

   198

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

   199

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

   200

   201

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

   202

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

   203

	 * shuffling the ->next pointers */

   204

	_network_game_list = nqld->sort_list[0];

   205

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

   206

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

   207

		item = item->next;

   208

	}

   209

	item->next = NULL;

   210

   211

	nqld->l.flags &= ~VL_RESORT;

   212

}

   213

   214

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

   215

enum NetworkGameWindowWidgets {

   216

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

   217

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

   218

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

   219

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

   220

   221

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

   222

	NGWW_CLIENTS,       ///< 'Clients' button

   223

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

   224

   225

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

   226

   227

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

   228

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

   229

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

   230

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

   231

   232

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

   233

	NGWW_ADD,           ///< 'Add server' button

   234

	NGWW_START,         ///< 'Start server' button

   235

	NGWW_CANCEL,        ///< 'Cancel' button

   236

};

   237

   238

/**

   239

 * Handler of actions done in the NetworkStartServer window

   240

 *

   241

 * @param w pointer to the Window structure

   242

 * @param e pointer to window event

   243

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

   244

 * @see     struct _network_game_window_widgets

   245

 * @see     enum NetworkGameWindowWidgets

   246

 */

   247

   248

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

   249

{

   250

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

   251

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

   252

   253

	switch (e->event) {

   254

	case WE_CREATE: // Focus input box

   255

		w->vscroll.cap = 13;

   256

		w->resize.step_height = NET_PRC__SIZE_OF_ROW;

   257

   258

		nd->field = NGWW_PLAYER;

   259

		nd->server = NULL;

   260

   261

		WP(w, network_ql_d).sort_list = NULL;

   262

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

   263

		ld->sort_type = _ng_sorting.criteria;

   264

		break;

   265

   266

	case WE_PAINT: {

   267

		const NetworkGameList *sel = nd->server;

   268

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

   269

   270

		if (ld->flags & VL_REBUILD) {

   271

			BuildNetworkGameList(&WP(w, network_ql_d));

   272

			SetVScrollCount(w, ld->list_length);

   273

		}

   274

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

   275

   276

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

   277

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

   278

		/* 'Join' button disabling conditions */

   279

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

   280

				!sel->online || // Server offline

   281

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

   282

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

   283

   284

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

   285

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

   286

				!sel->online ||

   287

				sel->info.grfconfig == NULL);

   288

   289

		SetDParam(0, 0x00);

   290

		SetDParam(1, _lan_internet_types_dropdown[_network_lan_internet]);

   291

		DrawWindowWidgets(w);

   292

   293

		/* Edit box to set player name */

   294

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

   295

   296

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

   297

   298

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

   299

		switch (ld->sort_type) {

   300

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

   301

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

   302

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

   303

		}

   304

   305

		{ // draw list of games

   306

			uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   307

			int32 n = 0;

   308

			int32 pos = w->vscroll.pos;

   309

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

   310

			const NetworkGameList *cur_item = _network_game_list;

   311

   312

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

   313

				pos--;

   314

				cur_item = cur_item->next;

   315

			}

   316

   317

			while (cur_item != NULL) {

   318

				/* show highlighted item with a different colour */

   319

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

   320

   321

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

   322

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

   323

   324

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

   325

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

   326

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

   327

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

   328

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

   329

   330

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

   331

				if (cur_item->online) {

   332

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

   333

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

   334

   335

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

   336

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

   337

   338

					/* draw flag according to server language */

   339

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

   340

				}

   341

   342

				cur_item = cur_item->next;

   343

				y += NET_PRC__SIZE_OF_ROW;

   344

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

   345

			}

   346

		}

   347

   348

		/* Draw the right menu */

   349

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

   350

		if (sel == NULL) {

   351

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

   352

		} else if (!sel->online) {

   353

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

   354

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

   355

   356

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

   357

		} else { // show game info

   358

			uint16 y = 100;

   359

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

   360

   361

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

   362

   363

   364

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

   365

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

   366

   367

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

   368

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

   369

   370

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

   371

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

   372

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

   373

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

   374

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   375

			y += 10;

   376

   377

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

   378

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

   379

			y += 10;

   380

   381

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

   382

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

   383

			y += 10;

   384

   385

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

   386

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

   387

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

   388

			y += 10;

   389

   390

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

   391

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

   392

			y += 10;

   393

   394

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

   395

			SetDParam(1, sel->port);

   396

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

   397

			y += 10;

   398

   399

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

   400

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

   401

			y += 10;

   402

   403

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

   404

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

   405

			y += 10;

   406

   407

			y += 2;

   408

   409

			if (!sel->info.compatible) {

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

			}

   417

   418

			y += 10;

   419

		}

   420

	} break;

   421

   422

	case WE_CLICK:

   423

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

   424

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

   425

		case NGWW_CANCEL: // Cancel button

   426

			DeleteWindowById(WC_NETWORK_WINDOW, 0);

   427

			break;

   428

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

   429

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

   430

			break;

   431

		case NGWW_NAME: // Sort by name

   432

		case NGWW_CLIENTS: // Sort by connected clients

   433

		case NGWW_INFO: // Connectivity (green dot)

   434

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

   435

			ld->flags |= VL_RESORT;

   436

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

   437

   438

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

   439

			_ng_sorting.criteria = ld->sort_type;

   440

			SetWindowDirty(w);

   441

			break;

   442

		case NGWW_MATRIX: { // Matrix to show networkgames

   443

			NetworkGameList *cur_item;

   444

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

   445

   446

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

   447

			id_v += w->vscroll.pos;

   448

   449

			cur_item = _network_game_list;

   450

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

   451

   452

			nd->server = cur_item;

   453

			SetWindowDirty(w);

   454

		} break;

   455

		case NGWW_FIND: // Find server automatically

   456

			switch (_network_lan_internet) {

   457

				case 0: NetworkUDPSearchGame(); break;

   458

				case 1: NetworkUDPQueryMasterServer(); break;

   459

			}

   460

			break;

   461

		case NGWW_ADD: { // Add a server

   462

			ShowQueryString(

   463

				BindCString(_network_default_ip),

   464

				STR_NETWORK_ENTER_IP,

   465

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

   466

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

   467

				w, CS_ALPHANUMERAL);

   468

		} break;

   469

		case NGWW_START: // Start server

   470

			ShowNetworkStartServerWindow();

   471

			break;

   472

		case NGWW_JOIN: // Join Game

   473

			if (nd->server != NULL) {

   474

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

   475

				_network_last_port = nd->server->port;

   476

				ShowNetworkLobbyWindow(nd->server);

   477

			}

   478

			break;

   479

		case NGWW_REFRESH: // Refresh

   480

			if (nd->server != NULL)

   481

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