1

/* $Id$ */

     2

     3

/** @file console_cmds.cpp Implementation of the console hooks. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "console_internal.h"

     8

#include "debug.h"

     9

#include "engine_func.h"

    10

#include "landscape.h"

    11

#include "saveload.h"

    12

#include "variables.h"

    13

#include "network/network.h"

    14

#include "network/network_func.h"

    15

#include "command_func.h"

    16

#include "settings_func.h"

    17

#include "fios.h"

    18

#include "fileio.h"

    19

#include "screenshot.h"

    20

#include "genworld.h"

    21

#include "strings_func.h"

    22

#include "viewport_func.h"

    23

#include "window_func.h"

    24

#include "functions.h"

    25

#include "map_func.h"

    26

#include "date_func.h"

    27

#include "vehicle_func.h"

    28

#include "string_func.h"

    29

#include "player_func.h"

    30

#include "player_base.h"

    31

#include "settings_type.h"

    32

#include "gamelog.h"

    33

    34

#ifdef ENABLE_NETWORK

    35

	#include "table/strings.h"

    36

#endif /* ENABLE_NETWORK */

    37

    38

// ** scriptfile handling ** //

    39

static FILE *_script_file;

    40

static bool _script_running;

    41

    42

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

    43

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

    44

#define DEF_CONSOLE_HOOK(function) static bool function()

    45

    46

    47

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

    48

/* variable and command hooks   */

    49

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

    50

    51

#ifdef ENABLE_NETWORK

    52

    53

static inline bool NetworkAvailable()

    54

{

    55

	if (!_network_available) {

    56

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

    57

		return false;

    58

	}

    59

	return true;

    60

}

    61

    62

DEF_CONSOLE_HOOK(ConHookServerOnly)

    63

{

    64

	if (!NetworkAvailable()) return false;

    65

    66

	if (!_network_server) {

    67

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

    68

		return false;

    69

	}

    70

	return true;

    71

}

    72

    73

DEF_CONSOLE_HOOK(ConHookClientOnly)

    74

{

    75

	if (!NetworkAvailable()) return false;

    76

    77

	if (_network_server) {

    78

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

    79

		return false;

    80

	}

    81

	return true;

    82

}

    83

    84

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    85

{

    86

	if (!NetworkAvailable()) return false;

    87

    88

	if (!_networking) {

    89

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

    90

		return false;

    91

	}

    92

	return true;

    93

}

    94

    95

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    96

{

    97

	if (_networking) {

    98

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

    99

		return false;

   100

	}

   101

	return true;

   102

}

   103

   104

#endif /* ENABLE_NETWORK */

   105

   106

static void IConsoleHelp(const char *str)

   107

{

   108

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

   109

}

   110

   111

DEF_CONSOLE_CMD(ConResetEngines)

   112

{

   113

	if (argc == 0) {

   114

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

   115

		return true;

   116

	}

   117

   118

	StartupEngines();

   119

	return true;

   120

}

   121

   122

#ifdef _DEBUG

   123

DEF_CONSOLE_CMD(ConResetTile)

   124

{

   125

	if (argc == 0) {

   126

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

   127

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

   128

		return true;

   129

	}

   130

   131

	if (argc == 2) {

   132

		uint32 result;

   133

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

   134

			DoClearSquare((TileIndex)result);

   135

			return true;

   136

		}

   137

	}

   138

   139

	return false;

   140

}

   141

   142

DEF_CONSOLE_CMD(ConStopAllVehicles)

   143

{

   144

	if (argc == 0) {

   145

		IConsoleHelp("Stops all vehicles in the game. For debugging only! Use at your own risk... Usage: 'stopall'");

   146

		return true;

   147

	}

   148

   149

	StopAllVehicles();

   150

	return true;

   151

}

   152

#endif /* _DEBUG */

   153

   154

DEF_CONSOLE_CMD(ConScrollToTile)

   155

{

   156

	if (argc == 0) {

   157

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

   158

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

   159

		return true;

   160

	}

   161

   162

	if (argc == 2) {

   163

		uint32 result;

   164

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

   165

			if (result >= MapSize()) {

   166

				IConsolePrint(CC_ERROR, "Tile does not exist");

   167

				return true;

   168

			}

   169

			ScrollMainWindowToTile((TileIndex)result);

   170

			return true;

   171

		}

   172

	}

   173

   174

	return false;

   175

}

   176

   177

extern void BuildFileList();

   178

extern void SetFiosType(const byte fiostype);

   179

   180

/* Save the map to a file */

   181

DEF_CONSOLE_CMD(ConSave)

   182

{

   183

	if (argc == 0) {

   184

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

   185

		return true;

   186

	}

   187

   188

	if (argc == 2) {

   189

		char *filename = str_fmt("%s.sav", argv[1]);

   190

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

   191

   192

		if (SaveOrLoad(filename, SL_SAVE, SAVE_DIR) != SL_OK) {

   193

			IConsolePrint(CC_ERROR, "Saving map failed");

   194

		} else {

   195

			IConsolePrintF(CC_DEFAULT, "Map sucessfully saved to %s", filename);

   196

		}

   197

		free(filename);

   198

		return true;

   199

	}

   200

   201

	return false;

   202

}

   203

   204

/* Explicitly save the configuration */

   205

DEF_CONSOLE_CMD(ConSaveConfig)

   206

{

   207

	if (argc == 0) {

   208

		IConsoleHelp("Saves the current config, typically to 'openttd.cfg'.");

   209

		return true;

   210

	}

   211

   212

	SaveToConfig();

   213

	IConsolePrint(CC_DEFAULT, "Saved config.");

   214

	return true;

   215

}

   216

   217

static const FiosItem* GetFiosItem(const char* file)

   218

{

   219

	_saveload_mode = SLD_LOAD_GAME;

   220

	BuildFileList();

   221

   222

	for (const FiosItem *item = _fios_items.Begin(); item != _fios_items.End(); item++) {

   223

		if (strcmp(file, item->name) == 0) return item;

   224

		if (strcmp(file, item->title) == 0) return item;

   225

	}

   226

   227

	/* If no name matches, try to parse it as number */

   228

	char *endptr;

   229

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

   230

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

   231

   232

	return IsInsideMM(i, 0, _fios_items.Length()) ? _fios_items.Get(i) : NULL;

   233

}

   234

   235

   236

DEF_CONSOLE_CMD(ConLoad)

   237

{

   238

	if (argc == 0) {

   239

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

   240

		return true;

   241

	}

   242

   243

	if (argc != 2) return false;

   244

   245

	const char *file = argv[1];

   246

	const FiosItem *item = GetFiosItem(file);

   247

	if (item != NULL) {

   248

		switch (item->type) {

   249

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   250

				_switch_mode = SM_LOAD;

   251

				SetFiosType(item->type);

   252

   253

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

   254

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

   255

			} break;

   256

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

   257

		}

   258

	} else {

   259

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

   260

	}

   261

   262

	FiosFreeSavegameList();

   263

	return true;

   264

}

   265

   266

   267

DEF_CONSOLE_CMD(ConRemove)

   268

{

   269

	if (argc == 0) {

   270

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

   271

		return true;

   272

	}

   273

   274

	if (argc != 2) return false;

   275

   276

	const char *file = argv[1];

   277

	const FiosItem *item = GetFiosItem(file);

   278

	if (item != NULL) {

   279

		if (!FiosDelete(item->name))

   280

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

   281

	} else {

   282

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

   283

	}

   284

   285

	FiosFreeSavegameList();

   286

	return true;

   287

}

   288

   289

   290

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

   291

DEF_CONSOLE_CMD(ConListFiles)

   292

{

   293

	if (argc == 0) {

   294

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

   295

		return true;

   296

	}

   297

   298

	BuildFileList();

   299

   300

	for (uint i = 0; i < _fios_items.Length(); i++) {

   301

		IConsolePrintF(CC_DEFAULT, "%d) %s", i, _fios_items[i].title);

   302

	}

   303

   304

	FiosFreeSavegameList();

   305

	return true;

   306

}

   307

   308

/* Change the dir via console */

   309

DEF_CONSOLE_CMD(ConChangeDirectory)

   310

{

   311

	if (argc == 0) {

   312

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

   313

		return true;

   314

	}

   315

   316

	if (argc != 2) return false;

   317

   318

	const char *file = argv[1];

   319

	const FiosItem *item = GetFiosItem(file);

   320

	if (item != NULL) {

   321

		switch (item->type) {

   322

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   323

				FiosBrowseTo(item);

   324

				break;

   325

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

   326

		}

   327

	} else {

   328

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

   329

	}

   330

   331

	FiosFreeSavegameList();

   332

	return true;

   333

}

   334

   335

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   336

{

   337

	const char *path;

   338

   339

	if (argc == 0) {

   340

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

   341

		return true;

   342

	}

   343

   344

	// XXX - Workaround for broken file handling

   345

	FiosGetSavegameList(SLD_LOAD_GAME);

   346

	FiosFreeSavegameList();

   347

   348

	FiosGetDescText(&path, NULL);

   349

	IConsolePrint(CC_DEFAULT, path);

   350

	return true;

   351

}

   352

   353

DEF_CONSOLE_CMD(ConClearBuffer)

   354

{

   355

	if (argc == 0) {

   356

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

   357

		return true;

   358

	}

   359

   360

	IConsoleClearBuffer();

   361

	InvalidateWindow(WC_CONSOLE, 0);

   362

	return true;

   363

}

   364

   365

   366

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

   367

// * Network Core Console Commands * //

   368

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

   369

#ifdef ENABLE_NETWORK

   370

   371

DEF_CONSOLE_CMD(ConBan)

   372

{

   373

	NetworkClientInfo *ci;

   374

	const char *banip = NULL;

   375

	uint32 index;

   376

   377

	if (argc == 0) {

   378

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

   379

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

   380

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

   381

		return true;

   382

	}

   383

   384

	if (argc != 2) return false;

   385

   386

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

   387

		index = atoi(argv[1]);

   388

		ci = NetworkFindClientInfoFromIndex(index);

   389

	} else { // banning IP

   390

		ci = NetworkFindClientInfoFromIP(argv[1]);

   391

		if (ci == NULL) {

   392

			banip = argv[1];

   393

			index = (uint32)-1;

   394

		} else {

   395

			index = ci->client_index;

   396

		}

   397

	}

   398

   399

	if (index == NETWORK_SERVER_INDEX) {

   400

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

   401

		return true;

   402

	}

   403

   404

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

   405

		IConsoleError("Invalid client");

   406

		return true;

   407

	}

   408

   409

	if (ci != NULL) {

   410

		IConsolePrint(CC_DEFAULT, "Client banned");

   411

		banip = GetPlayerIP(ci);

   412

		NetworkServerSendError(index, NETWORK_ERROR_KICKED);

   413

	} else {

   414

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

   415

	}

   416

   417

	/* Add user to ban-list */

   418

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

   419

		if (_network_ban_list[index] == NULL) {

   420

			_network_ban_list[index] = strdup(banip);

   421

			break;

   422

		}

   423

	}

   424

   425

	return true;

   426

}

   427

   428

DEF_CONSOLE_CMD(ConUnBan)

   429

{

   430

	uint i, index;

   431

   432

	if (argc == 0) {

   433

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

   434

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

   435

		return true;

   436

	}

   437

   438

	if (argc != 2) return false;

   439

   440

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

   441

	index--;

   442

   443

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

   444

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

   445

   446

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

   447

			free(_network_ban_list[i]);

   448

			_network_ban_list[i] = NULL;

   449

			IConsolePrint(CC_DEFAULT, "IP unbanned.");

   450

			return true;

   451

		}

   452

	}

   453

   454

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

   455

	return true;

   456

}

   457

   458

DEF_CONSOLE_CMD(ConBanList)

   459

{

   460

	uint i;

   461

   462

	if (argc == 0) {

   463

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

   464

		return true;

   465

	}

   466

   467

	IConsolePrint(CC_DEFAULT, "Banlist: ");

   468

   469

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

   470

		if (_network_ban_list[i] != NULL)

   471

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

   472

	}

   473

   474

	return true;

   475

}

   476

   477

DEF_CONSOLE_CMD(ConPauseGame)

   478

{

   479

	if (argc == 0) {

   480

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

   481

		return true;