1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "console.h"

     6

#include "debug.h"

     7

#include "engine.h"

     8

#include "functions.h"

     9

#include "saveload.h"

    10

#include "string.h"

    11

#include "variables.h"

    12

#include "network_data.h"

    13

#include "network_client.h"

    14

#include "network_server.h"

    15

#include "network_udp.h"

    16

#include "command.h"

    17

#include "settings.h"

    18

#include "hal.h" /* for file list */

    19

#include "vehicle.h"

    20

#include "station.h"

    21

    22

// ** scriptfile handling ** //

    23

static FILE *_script_file;

    24

static bool _script_running;

    25

    26

// ** console command / variable defines ** //

    27

#define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[])

    28

#define DEF_CONSOLE_HOOK(function) static bool function(void)

    29

    30

    31

/* **************************** */

    32

/* variable and command hooks   */

    33

/* **************************** */

    34

    35

#ifdef ENABLE_NETWORK

    36

    37

static inline bool NetworkAvailable(void)

    38

{

    39

	if (!_network_available) {

    40

		IConsoleError("You cannot use this command because there is no network available.");

    41

		return false;

    42

	}

    43

	return true;

    44

}

    45

    46

DEF_CONSOLE_HOOK(ConHookServerOnly)

    47

{

    48

	if (!NetworkAvailable()) return false;

    49

    50

	if (!_network_server) {

    51

		IConsoleError("This command/variable is only available to a network server.");

    52

		return false;

    53

	}

    54

	return true;

    55

}

    56

    57

DEF_CONSOLE_HOOK(ConHookClientOnly)

    58

{

    59

	if (!NetworkAvailable()) return false;

    60

    61

	if (_network_server) {

    62

		IConsoleError("This command/variable is not available to a network server.");

    63

		return false;

    64

	}

    65

	return true;

    66

}

    67

    68

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    69

{

    70

	if (!NetworkAvailable()) return false;

    71

    72

	if (!_networking) {

    73

		IConsoleError("Not connected. This command/variable is only available in multiplayer.");

    74

		return false;

    75

	}

    76

	return true;

    77

}

    78

    79

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    80

{

    81

	if (_networking) {

    82

		IConsoleError("This command/variable is forbidden in multiplayer.");

    83

		return false;

    84

	}

    85

	return true;

    86

}

    87

    88

#endif /* ENABLE_NETWORK */

    89

    90

static void IConsoleHelp(const char *str)

    91

{

    92

	IConsolePrintF(_icolour_warn, "- %s", str);

    93

}

    94

    95

DEF_CONSOLE_CMD(ConResetEngines)

    96

{

    97

	if (argc == 0) {

    98

		IConsoleHelp("Reset status data of all engines. This might solve some issues with 'lost' engines. Usage: 'resetengines'");

    99

		return true;

   100

	}

   101

   102

	StartupEngines();

   103

	return true;

   104

}

   105

   106

#ifdef _DEBUG

   107

DEF_CONSOLE_CMD(ConResetTile)

   108

{

   109

	if (argc == 0) {

   110

		IConsoleHelp("Reset a tile to bare land. Usage: 'resettile <tile>'");

   111

		IConsoleHelp("Tile can be either decimal (34161) or hexadecimal (0x4a5B)");

   112

		return true;

   113

	}

   114

   115

	if (argc == 2) {

   116

		uint32 result;

   117

		if (GetArgumentInteger(&result, argv[1])) {

   118

			DoClearSquare((TileIndex)result);

   119

			return true;

   120

		}

   121

	}

   122

   123

	return false;

   124

}

   147

#endif /* _DEBUG */

   148

   149

DEF_CONSOLE_CMD(ConScrollToTile)

   150

{

   151

	if (argc == 0) {

   152

		IConsoleHelp("Center the screen on a given tile. Usage: 'scrollto <tile>'");

   153

		IConsoleHelp("Tile can be either decimal (34161) or hexadecimal (0x4a5B)");

   154

		return true;

   155

	}

   156

   157

	if (argc == 2) {

   158

		uint32 result;

   159

		if (GetArgumentInteger(&result, argv[1])) {

   160

			ScrollMainWindowToTile((TileIndex)result);

   161

			return true;

   162

		}

   163

	}

   164

   165

	return false;

   166

}

   167

   168

extern bool SafeSaveOrLoad(const char *filename, int mode, int newgm);

   169

extern void BuildFileList(void);

   170

extern void SetFiosType(const byte fiostype);

   171

   172

/* Save the map to a file */

   173

DEF_CONSOLE_CMD(ConSave)

   174

{

   175

	if (argc == 0) {

   176

		IConsoleHelp("Save the current game. Usage: 'save <filename>'");

   177

		return true;

   178

	}

   179

   180

	if (argc == 2) {

   181

		char buf[200];

   182

   183

		snprintf(buf, lengthof(buf), "%s%s%s.sav", _path.save_dir, PATHSEP, argv[1]);

   184

		IConsolePrint(_icolour_def, "Saving map...");

   185

   186

		if (SaveOrLoad(buf, SL_SAVE) != SL_OK) {

   187

			IConsolePrint(_icolour_err, "SaveMap failed");

   188

		} else

   189

			IConsolePrintF(_icolour_def, "Map sucessfully saved to %s", buf);

   190

		return true;

   191

	}

   192

   193

	return false;

   194

}

   195

   196

static const FiosItem* GetFiosItem(const char* file)

   197

{

   198

	int i;

   199

   200

	_saveload_mode = SLD_LOAD_GAME;

   201

	BuildFileList();

   202

   203

	for (i = 0; i < _fios_num; i++) {

   204

		if (strcmp(file, _fios_list[i].name) == 0) break;

   205

		if (strcmp(file, _fios_list[i].title) == 0) break;

   206

	}

   207

   208

	if (i == _fios_num) { /* If no name matches, try to parse it as number */

   209

		char* endptr;

   210

   211

		i = strtol(file, &endptr, 10);

   212

		if (file == endptr || *endptr != '\0') i = -1;

   213

	}

   214

   215

	return IS_INT_INSIDE(i, 0, _fios_num) ? &_fios_list[i] : NULL;

   216

}

   217

   218

   219

DEF_CONSOLE_CMD(ConLoad)

   220

{

   221

	const FiosItem *item;

   222

	const char *file;

   223

   224

	if (argc == 0) {

   225

		IConsoleHelp("Load a game by name or index. Usage: 'load <file | number>'");

   226

		return true;

   227

	}

   228

   229

	if (argc != 2) return false;

   230

   231

	file = argv[1];

   232

	item = GetFiosItem(file);

   233

	if (item != NULL) {

   234

		switch (item->type) {

   235

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   236

				_switch_mode = SM_LOAD;

   237

				SetFiosType(item->type);

   238

   239

				ttd_strlcpy(_file_to_saveload.name, FiosBrowseTo(item), sizeof(_file_to_saveload.name));

   240

				ttd_strlcpy(_file_to_saveload.title, item->title, sizeof(_file_to_saveload.title));

   241

			} break;

   242

			default: IConsolePrintF(_icolour_err, "%s: Not a savegame.", file);

   243

		}

   244

	} else

   245

		IConsolePrintF(_icolour_err, "%s: No such file or directory.", file);

   246

   247

	FiosFreeSavegameList();

   248

	return true;

   249

}

   250

   251

   252

DEF_CONSOLE_CMD(ConRemove)

   253

{

   254

	const FiosItem* item;

   255

	const char* file;

   256

   257

	if (argc == 0) {

   258

		IConsoleHelp("Remove a savegame by name or index. Usage: 'rm <file | number>'");

   259

		return true;

   260

	}

   261

   262

	if (argc != 2) return false;

   263

   264

	file = argv[1];

   265

	item = GetFiosItem(file);

   266

	if (item != NULL) {

   267

		if (!FiosDelete(item->name))

   268

			IConsolePrintF(_icolour_err, "%s: Failed to delete file", file);

   269

	} else

   270

		IConsolePrintF(_icolour_err, "%s: No such file or directory.", file);

   271

   272

	FiosFreeSavegameList();

   273

	return true;

   274

}

   275

   276

   277

/* List all the files in the current dir via console */

   278

DEF_CONSOLE_CMD(ConListFiles)

   279

{

   280

	int i;

   281

   282

	if (argc == 0) {

   283

		IConsoleHelp("List all loadable savegames and directories in the current dir via console. Usage: 'ls | dir'");

   284

		return true;

   285

	}

   286

   287

	BuildFileList();

   288

   289

	for (i = 0; i < _fios_num; i++) {

   290

		const FiosItem *item = &_fios_list[i];

   291

		IConsolePrintF(_icolour_def, "%d) %s", i, item->title);

   292

	}

   293

   294

	FiosFreeSavegameList();

   295

	return true;

   296

}

   297

   298

/* Change the dir via console */

   299

DEF_CONSOLE_CMD(ConChangeDirectory)

   300

{

   301

	const FiosItem *item;

   302

	const char *file;

   303

   304

	if (argc == 0) {

   305

		IConsoleHelp("Change the dir via console. Usage: 'cd <directory | number>'");

   306

		return true;

   307

	}

   308

   309

	if (argc != 2) return false;

   310

   311

	file = argv[1];

   312

	item = GetFiosItem(file);

   313

	if (item != NULL) {

   314

		switch (item->type) {

   315

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   316

				FiosBrowseTo(item);

   317

				break;

   318

			default: IConsolePrintF(_icolour_err, "%s: Not a directory.", file);

   319

		}

   320

	} else

   321

		IConsolePrintF(_icolour_err, "%s: No such file or directory.", file);

   322

   323

	FiosFreeSavegameList();

   324

	return true;

   325

}

   326

   327

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   328

{

   329

	const char *path;

   330

   331

	if (argc == 0) {

   332

		IConsoleHelp("Print out the current working directory. Usage: 'pwd'");

   333

		return true;

   334

	}

   335

   336

	// XXX - Workaround for broken file handling

   337

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   338

	FiosFreeSavegameList();

   339

   340

	FiosGetDescText(&path, NULL);

   341

	IConsolePrint(_icolour_def, path);

   342

	return true;

   343

}

   344

   345

DEF_CONSOLE_CMD(ConClearBuffer)

   346

{

   347

	if (argc == 0) {

   348

		IConsoleHelp("Clear the console buffer. Usage: 'clear'");

   349

		return true;

   350

	}

   351

   352

	IConsoleClearBuffer();

   353

	InvalidateWindow(WC_CONSOLE, 0);

   354

	return true;

   355

}

   356

   357

   358

// ********************************* //

   359

// * Network Core Console Commands * //

   360

// ********************************* //

   361

#ifdef ENABLE_NETWORK

   362

   363

DEF_CONSOLE_CMD(ConBan)

   364

{

   365

	NetworkClientInfo *ci;

   366

	const char *banip = NULL;

   367

	uint32 index;

   368

   369

	if (argc == 0) {

   370

		IConsoleHelp("Ban a player from a network game. Usage: 'ban <ip | client-id>'");

   371

		IConsoleHelp("For client-id's, see the command 'clients'");

   372

		IConsoleHelp("If the client is no longer online, you can still ban his/her IP");

   373

		return true;

   374

	}

   375

   376

	if (argc != 2) return false;

   377

   378

	if (strchr(argv[1], '.') == NULL) { // banning with ID

   379

		index = atoi(argv[1]);

   380

		ci = NetworkFindClientInfoFromIndex(index);

   381

	} else { // banning IP

   382

		ci = NetworkFindClientInfoFromIP(argv[1]);

   383

		if (ci == NULL) {

   384

			banip = argv[1];

   385

			index = (uint32)-1;

   386

		} else {

   387

			index = ci->client_index;

   388

		}

   389

	}

   390

   391

	if (index == NETWORK_SERVER_INDEX) {

   392

		IConsoleError("Silly boy, you can not ban yourself!");

   393

		return true;

   394

	}

   395

   396

	if (index == 0 || (ci == NULL && index != (uint32)-1)) {

   397

		IConsoleError("Invalid client");

   398

		return true;

   399

	}

   400

   401

	if (ci != NULL) {

   402

		banip = inet_ntoa(*(struct in_addr *)&ci->client_ip);

   403

		SEND_COMMAND(PACKET_SERVER_ERROR)(NetworkFindClientStateFromIndex(index), NETWORK_ERROR_KICKED);

   404

		IConsolePrint(_icolour_def, "Client banned");

   405

	} else

   406

		IConsolePrint(_icolour_def, "Client not online, banned IP");

   407

   408

	/* Add user to ban-list */

   409

	for (index = 0; index < lengthof(_network_ban_list); index++) {

   410

		if (_network_ban_list[index] == NULL) {

   411

			_network_ban_list[index] = strdup(banip);

   412

			break;

   413

		}

   414

	}

   415

   416

	return true;

   417

}

   418

   419

DEF_CONSOLE_CMD(ConUnBan)

   420

{

   421

	uint i, index;

   422

   423

	if (argc == 0) {

   424

		IConsoleHelp("Unban a player from a network game. Usage: 'unban <ip | client-id>'");

   425

		IConsoleHelp("For a list of banned IP's, see the command 'banlist'");

   426

		return true;

   427

	}

   428

   429

	if (argc != 2) return false;

   430

   431

	index = (strchr(argv[1], '.') == NULL) ? atoi(argv[1]) : 0;

   432

	index--;

   433

   434

	for (i = 0; i < lengthof(_network_ban_list); i++) {

   435

		if (_network_ban_list[i] == NULL) continue;

   436

   437

		if (strncmp(_network_ban_list[i], argv[1], strlen(_network_ban_list[i])) == 0 || index == i) {

   438

			free(_network_ban_list[i]);

   439

			_network_ban_list[i] = NULL;

   440

			IConsolePrint(_icolour_def, "IP unbanned.");

   441

			return true;

   442

		}

   443

	}

   444

   445

	IConsolePrint(_icolour_def, "IP not in ban-list.");

   446

	return true;

   447

}

   448

   449

DEF_CONSOLE_CMD(ConBanList)

   450

{

   451

	uint i;

   452

   453

	if (argc == 0) {

   454

		IConsoleHelp("List the IP's of banned clients: Usage 'banlist'");

   455

		return true;

   456

	}

   457

   458

	IConsolePrint(_icolour_def, "Banlist: ");

   459

   460

	for (i = 0; i < lengthof(_network_ban_list); i++) {

   461

		if (_network_ban_list[i] != NULL)

   462

			IConsolePrintF(_icolour_def, "  %d) %s", i + 1, _network_ban_list[i]);

   463

	}

   464

   465

	return true;

   466

}

   467

   468

DEF_CONSOLE_CMD(ConPauseGame)

   469

{

   470

	if (argc == 0) {

   471

		IConsoleHelp("Pause a network game. Usage: 'pause'");

   472

		return true;

   473

	}

   474

   475

	if (_pause == 0) {

   476

		DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   477

		IConsolePrint(_icolour_def, "Game paused.");

   478

	} else

   479

		IConsolePrint(_icolour_def, "Game is already paused.");

   480

   481

	return true;

   482

}

   483