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

    30

#define BGC 5

    31

#define BTC 15

    32

    33

typedef struct network_d {

    34

	PlayerID company;        // select company in network lobby

    35

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

    36

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

    37

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

    38

} network_d;

    39

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_d));

    40

    41

typedef struct network_ql_d {

    42

	network_d n;                 // see above; general stuff

    43

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

    44

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

    45

	list_d l;                    // accompanying list-administration

    46

} network_ql_d;

    47

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_ql_d));

    48

    49

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

    50

static Listing _ng_sorting;

    51

    52

static char _edit_str_buf[150];

    53

static bool _chat_tab_completion_active;

    54

    55

static void ShowNetworkStartServerWindow(void);

    56

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    57

extern void SwitchMode(int new_mode);

    58

    59

static const StringID _connection_types_dropdown[] = {

    60

	STR_NETWORK_LAN_INTERNET,

    61

	STR_NETWORK_INTERNET_ADVERTISE,

    62

	INVALID_STRING_ID

    63

};

    64

    65

static const StringID _lan_internet_types_dropdown[] = {

    66

	STR_NETWORK_LAN,

    67

	STR_NETWORK_INTERNET,

    68

	INVALID_STRING_ID

    69

};

    70

    71

static const StringID _players_dropdown[] = {

    72

	STR_NETWORK_0_PLAYERS,

    73

	STR_NETWORK_1_PLAYERS,

    74

	STR_NETWORK_2_PLAYERS,

    75

	STR_NETWORK_3_PLAYERS,

    76

	STR_NETWORK_4_PLAYERS,

    77

	STR_NETWORK_5_PLAYERS,

    78

	STR_NETWORK_6_PLAYERS,

    79

	STR_NETWORK_7_PLAYERS,

    80

	STR_NETWORK_8_PLAYERS,

    81

	STR_NETWORK_9_PLAYERS,

    82

	STR_NETWORK_10_PLAYERS,

    83

	INVALID_STRING_ID

    84

};

    85

    86

static const StringID _language_dropdown[] = {

    87

	STR_NETWORK_LANG_ANY,

    88

	STR_NETWORK_LANG_ENGLISH,

    89

	STR_NETWORK_LANG_GERMAN,

    90

	STR_NETWORK_LANG_FRENCH,

    91

	INVALID_STRING_ID

    92

};

    93

    94

enum {

    95

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    96

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    97

	NET_PRC__SIZE_OF_ROW                = 14,

    98

};

    99

   100

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

   101

 * found on the network.

   102

 * @param unselect unselect the currently selected item */

   103

void UpdateNetworkGameWindow(bool unselect)

   104

{

   105

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

   106

}

   107

   108

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

   109

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

   110

   111

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

   112

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

   113

{

   114

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

   115

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

   116

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

   117

   118

	return _internal_sort_order ? -r : r;

   119

}

   120

   121

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

   122

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

   123

 * higher maximum is preferred. */

   124

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

   125

{

   126

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

   127

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

   128

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

   129

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

   130

   131

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

   132

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

   133

   134

	return _internal_sort_order ? -r : r;

   135

}

   136

   137

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

   138

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

   139

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

   140

{

   141

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

   142

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

   143

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

   144

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

   145

   146

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

   147

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

   148

   149

	return _internal_sort_order ? -r : r;

   150

}

   151

   152

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

   153

 * an item has been added or deleted for example

   154

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

   155

static void BuildNetworkGameList(network_ql_d *nqld)

   156

{

   157

	NetworkGameList *ngl_temp;

   158

	uint n = 0;

   159

   160

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

   161

   162

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

   163

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

   164

	if (n == 0) return;

   165

   166

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

   167

	free(nqld->sort_list);

   168

	nqld->sort_list = malloc(n * sizeof(nqld->sort_list[0]));

   169

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

   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

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

   212

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

   213

{

   214

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

   215

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

   216

   217

	switch (e->event) {

   218

	case WE_CREATE: /* Focus input box */

   219

		nd->field = 3;

   220

		nd->server = NULL;

   221

   222

		WP(w, network_ql_d).sort_list = NULL;

   223

		ld->flags = VL_REBUILD | (_ng_sorting.order << (VL_DESC - 1));

   224

		ld->sort_type = _ng_sorting.criteria;

   225

		break;

   226

   227

	case WE_PAINT: {

   228

		const NetworkGameList *sel = nd->server;

   229

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

   230

   231

		if (ld->flags & VL_REBUILD) {

   232

			BuildNetworkGameList(&WP(w, network_ql_d));

   233

			SetVScrollCount(w, ld->list_length);

   234

		}

   235

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

   236

   237

		SetWindowWidgetDisabledState(w, 17, sel == NULL);

   238

		/* Join Button disabling conditions */

   239

		SetWindowWidgetDisabledState(w, 16, sel == NULL || // no Selected Server

   240

				!sel->online || // Server offline

   241

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

   242

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

   243

   244

		SetDParam(0, 0x00);

   245

		SetDParam(7, _lan_internet_types_dropdown[_network_lan_internet]);

   246

		DrawWindowWidgets(w);

   247

   248

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

   249

   250

		DrawString(9, 23, STR_NETWORK_CONNECTION, 2);

   251

		DrawString(210, 23, STR_NETWORK_PLAYER_NAME, 2);

   252

   253

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

   254

		switch (ld->sort_type) {

   255

			case 6 - 6: DoDrawString(arrow, w->widget[6].right - 10, 42, 0x10); break;

   256

			case 7 - 6: DoDrawString(arrow, w->widget[7].right - 10, 42, 0x10); break;

   257

			case 8 - 6: DoDrawString(arrow, w->widget[8].right - 10, 42, 0x10); break;

   258

		}

   259

   260

		{ // draw list of games

   261

			uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   262

			int32 n = 0;

   263

			int32 pos = w->vscroll.pos;

   264

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

   265

			const NetworkGameList *cur_item = _network_game_list;

   266

   267

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

   268

				pos--;

   269

				cur_item = cur_item->next;

   270

			}

   271

   272

			while (cur_item != NULL) {

   273

				// show highlighted item with a different colour

   274

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

   275

   276

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

   277

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

   278

   279

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

   280

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

   281

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

   282

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

   283

				DrawStringCentered(210, y, STR_NETWORK_GENERAL_ONLINE, 2);

   284

   285

				// only draw icons if the server is online

   286

				if (cur_item->online) {

   287

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

   288

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

   289

   290

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

   291

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

   292

   293

					// draw flag according to server language

   294

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

   295

				}

   296

   297

				cur_item = cur_item->next;

   298

				y += NET_PRC__SIZE_OF_ROW;

   299

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

   300

			}

   301

		}

   302

   303

		/* Draw the right menu */

   304

		GfxFillRect(311, 43, 539, 92, 157);

   305

		if (sel == NULL) {

   306

			DrawStringCentered(425, 58, STR_NETWORK_GAME_INFO, 0);

   307

		} else if (!sel->online) {

   308

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

   309

			DrawStringCentered(425, 68, STR_ORANGE, 0); // game name

   310

   311

			DrawStringCentered(425, 132, STR_NETWORK_SERVER_OFFLINE, 0); // server offline

   312

		} else { // show game info

   313

			uint16 y = 100;

   314

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

   315

   316

			DrawStringCentered(425, 48, STR_NETWORK_GAME_INFO, 0);

   317

   318

   319

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

   320

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

   321

   322

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

   323

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

   324

   325

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

   326

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

   327

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

   328

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

   329

			DrawString(x, y, STR_NETWORK_CLIENTS, 2);

   330

			y += 10;

   331

   332

			SetDParam(0, _language_dropdown[sel->info.server_lang]);

   333

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

   334

			y += 10;

   335

   336

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

   337

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

   338

			y += 10;

   339

   340

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

   341

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

   342

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

   343

			y += 10;

   344

   345

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

   346

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

   347

			y += 10;

   348

   349

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

   350

			SetDParam(1, sel->port);

   351

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

   352

			y += 10;

   353

   354

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

   355

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

   356

			y += 10;

   357

   358

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

   359

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

   360

			y += 10;

   361

   362

			y += 2;

   363

   364

			if (!sel->info.compatible) {

   365

				DrawStringCentered(425, y, STR_NETWORK_VERSION_MISMATCH, 0); // server mismatch

   366

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

   367

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

   368

				DrawStringCentered(425, y, STR_NETWORK_SERVER_FULL, 0); // server full

   369

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

   370

				DrawStringCentered(425, y, STR_NETWORK_PASSWORD, 0); // password warning

   371

			}

   372

   373

			y += 10;

   374

		}

   375

	}	break;

   376

   377

	case WE_CLICK:

   378

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

   379

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

   380

		case 0: case 14: /* Close 'X' | Cancel button */

   381

			DeleteWindowById(WC_NETWORK_WINDOW, 0);

   382

			break;

   383

		case 4: case 5:

   384

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

   385

			break;

   386

		case 6: /* Sort by name */

   387

		case 7: /* Sort by connected clients */

   388

		case 8: /* Connectivity (green dot) */

   389

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

   390

			ld->flags |= VL_RESORT;

   391

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

   392

   393

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

   394

			_ng_sorting.criteria = ld->sort_type;

   395

			SetWindowDirty(w);

   396

			break;

   397

		case 9: { /* Matrix to show networkgames */

   398

			NetworkGameList *cur_item;

   399

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

   400

   401

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

   402

			id_v += w->vscroll.pos;

   403

   404

			cur_item = _network_game_list;

   405

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

   406

   407

			nd->server = cur_item;

   408

			SetWindowDirty(w);

   409

		} break;

   410

		case 11: /* Find server automatically */

   411

			switch (_network_lan_internet) {

   412

				case 0: NetworkUDPSearchGame(); break;

   413

				case 1: NetworkUDPQueryMasterServer(); break;

   414

			}

   415

			break;

   416

		case 12: { // Add a server

   417

				ShowQueryString(

   418

				BindCString(_network_default_ip),

   419

				STR_NETWORK_ENTER_IP,

   420

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

   421

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

   422

				w->window_class,

   423

				w->window_number, CS_ALPHANUMERAL);

   424

		} break;

   425

		case 13: /* Start server */

   426

			ShowNetworkStartServerWindow();

   427

			break;

   428

		case 16: /* Join Game */

   429

			if (nd->server != NULL) {

   430

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

   431

				_network_last_port = nd->server->port;

   432

				ShowNetworkLobbyWindow(nd->server);

   433

			}

   434

			break;

   435

		case 17: // Refresh

   436

			if (nd->server != NULL)

   437

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

   438

			break;

   439

   440

	}	break;

   441

   442

	case WE_DROPDOWN_SELECT: /* we have selected a dropdown item in the list */

   443

		switch (e->we.dropdown.button) {

   444

			case 5:

   445

				_network_lan_internet = e->we.dropdown.index;

   446

				break;

   447

		}

   448

   449

		SetWindowDirty(w);

   450

		break;

   451

   452

	case WE_MOUSELOOP:

   453

		if (nd->field == 3) HandleEditBox(w, &WP(w, network_ql_d).q, 3);

   454

		break;

   455

   456

	case WE_MESSAGE:

   457

		if (e->we.message.msg != 0) nd->server = NULL;

   458

		ld->flags |= VL_REBUILD;

   459

		SetWindowDirty(w);

   460

		break;

   461

   462

	case WE_KEYPRESS:

   463

		if (nd->field != 3) {

   464

			if (nd->server != NULL) {

   465

				if (e->we.keypress.keycode == WKC_DELETE) { /* Press 'delete' to remove servers */

   466

					NetworkGameListRemoveItem(nd->server);

   467

					NetworkRebuildHostList();

   468

					nd->server = NULL;

   469

				}

   470

			}

   471

			break;

   472

		}

   473

   474

		if (HandleEditBoxKey(w, &WP(w, network_ql_d).q, 3, e) == 1) break; // enter pressed

   475

   476

		// The name is only allowed when it starts with a letter!

   477

		if (_edit_str_buf[0] != '\0' && _edit_str_buf[0] != ' ') {

   478

			ttd_strlcpy(_network_player_name, _edit_str_buf, lengthof(_network_player_name));

   479

		} else {

   480

			ttd_strlcpy(_network_player_name, "Player", lengthof(_network_player_name));

   481

		}