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

#include "ai/ai.h"

    34

    35

#ifdef ENABLE_NETWORK

    36

	#include "table/strings.h"

    37

#endif /* ENABLE_NETWORK */

    38

    39

// ** scriptfile handling ** //

    40

static FILE *_script_file;

    41

static bool _script_running;

    42

    43

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

    44

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

    45

#define DEF_CONSOLE_HOOK(function) static bool function()

    46

    47

    48

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

    49

/* variable and command hooks   */

    50

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

    51

    52

#ifdef ENABLE_NETWORK

    53

    54

static inline bool NetworkAvailable()

    55

{

    56

	if (!_network_available) {

    57

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

    58

		return false;

    59

	}

    60

	return true;

    61

}

    62

    63

DEF_CONSOLE_HOOK(ConHookServerOnly)

    64

{

    65

	if (!NetworkAvailable()) return false;

    66

    67

	if (!_network_server) {

    68

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

    69

		return false;

    70

	}

    71

	return true;

    72

}

    73

    74

DEF_CONSOLE_HOOK(ConHookClientOnly)

    75

{

    76

	if (!NetworkAvailable()) return false;

    77

    78

	if (_network_server) {

    79

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

    80

		return false;

    81

	}

    82

	return true;

    83

}

    84

    85

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    86

{

    87

	if (!NetworkAvailable()) return false;

    88

    89

	if (!_networking) {

    90

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

    91

		return false;

    92

	}

    93

	return true;

    94

}

    95

    96

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    97

{

    98

	if (_networking) {

    99

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

   100

		return false;

   101

	}

   102

	return true;

   103

}

   104

   105

#endif /* ENABLE_NETWORK */

   106

   107

static void IConsoleHelp(const char *str)

   108

{

   109

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

   110

}

   111

   112

DEF_CONSOLE_CMD(ConResetEngines)

   113

{

   114

	if (argc == 0) {

   115

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

   116

		return true;

   117

	}

   118

   119

	StartupEngines();

   120

	return true;

   121

}

   122

   123

#ifdef _DEBUG

   124

DEF_CONSOLE_CMD(ConResetTile)

   125

{

   126

	if (argc == 0) {

   127

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

   128

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

   129

		return true;

   130

	}

   131

   132

	if (argc == 2) {

   133

		uint32 result;

   134

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

   135

			DoClearSquare((TileIndex)result);

   136

			return true;

   137

		}

   138

	}

   139

   140

	return false;

   141

}

   142

   143

DEF_CONSOLE_CMD(ConStopAllVehicles)

   144

{

   145

	if (argc == 0) {

   146

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

   147

		return true;

   148

	}

   149

   150

	StopAllVehicles();

   151

	return true;

   152

}

   153

#endif /* _DEBUG */

   154

   155

DEF_CONSOLE_CMD(ConScrollToTile)

   156

{

   157

	if (argc == 0) {

   158

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

   159

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

   160

		return true;

   161

	}

   162

   163

	if (argc == 2) {

   164

		uint32 result;

   165

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

   166

			if (result >= MapSize()) {

   167

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

   168

				return true;

   169

			}

   170

			ScrollMainWindowToTile((TileIndex)result);

   171

			return true;

   172

		}

   173

	}

   174

   175

	return false;

   176

}

   177

   178

extern void BuildFileList();

   179

extern void SetFiosType(const byte fiostype);

   180

   181

/* Save the map to a file */

   182

DEF_CONSOLE_CMD(ConSave)

   183

{

   184

	if (argc == 0) {

   185

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

   186

		return true;

   187

	}

   188

   189

	if (argc == 2) {

   190

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

   191

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

   192

   193

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

   194

			IConsolePrint(CC_ERROR, "Saving map failed");

   195

		} else {

   196

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

   197

		}

   198

		free(filename);

   199

		return true;

   200

	}

   201

   202

	return false;

   203

}

   204

   205

/* Explicitly save the configuration */

   206

DEF_CONSOLE_CMD(ConSaveConfig)

   207

{

   208

	if (argc == 0) {

   209

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

   210

		return true;

   211

	}

   212

   213

	SaveToConfig();

   214

	IConsolePrint(CC_DEFAULT, "Saved config.");

   215

	return true;

   216

}

   217

   218

static const FiosItem* GetFiosItem(const char* file)

   219

{

   220

	_saveload_mode = SLD_LOAD_GAME;

   221

	BuildFileList();

   222

   223

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

   224

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

   225

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

   226

	}

   227

   228

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

   229

	char *endptr;

   230

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

   231

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

   232

   233

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

   234

}

   235

   236

   237

DEF_CONSOLE_CMD(ConLoad)

   238

{

   239

	if (argc == 0) {

   240

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

   241

		return true;

   242

	}

   243

   244

	if (argc != 2) return false;

   245

   246

	const char *file = argv[1];

   247

	const FiosItem *item = GetFiosItem(file);

   248

	if (item != NULL) {

   249

		switch (item->type) {

   250

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   251

				_switch_mode = SM_LOAD;

   252

				SetFiosType(item->type);

   253

   254

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

   255

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

   256

			} break;

   257

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

   258

		}

   259

	} else {

   260

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

   261

	}

   262

   263

	FiosFreeSavegameList();

   264

	return true;

   265

}

   266

   267

   268

DEF_CONSOLE_CMD(ConRemove)

   269

{

   270

	if (argc == 0) {

   271

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

   272

		return true;

   273

	}

   274

   275

	if (argc != 2) return false;

   276

   277

	const char *file = argv[1];

   278

	const FiosItem *item = GetFiosItem(file);

   279

	if (item != NULL) {

   280

		if (!FiosDelete(item->name))

   281

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

   282

	} else {

   283

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

   284

	}

   285

   286

	FiosFreeSavegameList();

   287

	return true;

   288

}

   289

   290

   291

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

   292

DEF_CONSOLE_CMD(ConListFiles)

   293

{

   294

	if (argc == 0) {

   295

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

   296

		return true;

   297

	}

   298

   299

	BuildFileList();

   300

   301

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

   302

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

   303

	}

   304

   305

	FiosFreeSavegameList();

   306

	return true;

   307

}

   308

   309

/* Change the dir via console */

   310

DEF_CONSOLE_CMD(ConChangeDirectory)

   311

{

   312

	if (argc == 0) {

   313

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

   314

		return true;

   315

	}

   316

   317

	if (argc != 2) return false;

   318

   319

	const char *file = argv[1];

   320

	const FiosItem *item = GetFiosItem(file);

   321

	if (item != NULL) {

   322

		switch (item->type) {

   323

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   324

				FiosBrowseTo(item);

   325

				break;

   326

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

   327

		}

   328

	} else {

   329

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

   330

	}

   331

   332

	FiosFreeSavegameList();

   333

	return true;

   334

}

   335

   336

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   337

{

   338

	const char *path;

   339

   340

	if (argc == 0) {

   341

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

   342

		return true;

   343

	}

   344

   345

	// XXX - Workaround for broken file handling

   346

	FiosGetSavegameList(SLD_LOAD_GAME);

   347

	FiosFreeSavegameList();

   348

   349

	FiosGetDescText(&path, NULL);

   350

	IConsolePrint(CC_DEFAULT, path);

   351

	return true;

   352

}

   353

   354

DEF_CONSOLE_CMD(ConClearBuffer)

   355

{

   356

	if (argc == 0) {

   357

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

   358

		return true;

   359

	}

   360

   361

	IConsoleClearBuffer();

   362

	InvalidateWindow(WC_CONSOLE, 0);

   363

	return true;

   364

}

   365

   366

   367

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

   368

// * Network Core Console Commands * //

   369

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

   370

#ifdef ENABLE_NETWORK

   371

   372

DEF_CONSOLE_CMD(ConBan)

   373

{

   374

	NetworkClientInfo *ci;

   375

	const char *banip = NULL;

   376

	uint32 index;

   377

   378

	if (argc == 0) {

   379

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

   380

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

   381

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

   382

		return true;

   383

	}

   384

   385

	if (argc != 2) return false;

   386

   387

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

   388

		index = atoi(argv[1]);

   389

		ci = NetworkFindClientInfoFromIndex(index);

   390

	} else { // banning IP

   391

		ci = NetworkFindClientInfoFromIP(argv[1]);

   392

		if (ci == NULL) {

   393

			banip = argv[1];

   394

			index = (uint32)-1;

   395

		} else {

   396

			index = ci->client_index;

   397

		}

   398

	}

   399

   400

	if (index == NETWORK_SERVER_INDEX) {

   401

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

   402

		return true;

   403

	}

   404

   405

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

   406

		IConsoleError("Invalid client");

   407

		return true;

   408

	}

   409

   410

	if (ci != NULL) {

   411

		banip = GetPlayerIP(ci);

   412

		NetworkServerSendError(index, NETWORK_ERROR_KICKED);

   413

		IConsolePrint(CC_DEFAULT, "Client banned");

   414

	} else {

   415

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

   416

	}

   417

   418

	/* Add user to ban-list */

   419

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

   420

		if (_network_ban_list[index] == NULL) {

   421

			_network_ban_list[index] = strdup(banip);

   422

			break;

   423

		}

   424

	}

   425

   426

	return true;

   427

}

   428

   429

DEF_CONSOLE_CMD(ConUnBan)

   430

{

   431

	uint i, index;

   432

   433

	if (argc == 0) {

   434

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

   435

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

   436

		return true;

   437

	}

   438

   439

	if (argc != 2) return false;

   440

   441

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

   442

	index--;

   443

   444

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

   445

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

   446

   447

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

   448

			free(_network_ban_list[i]);

   449

			_network_ban_list[i] = NULL;

   450

			IConsolePrint(CC_DEFAULT, "IP unbanned.");

   451

			return true;

   452

		}

   453

	}

   454

   455

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

   456

	return true;

   457

}

   458

   459

DEF_CONSOLE_CMD(ConBanList)

   460

{

   461

	uint i;

   462

   463

	if (argc == 0) {

   464

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

   465

		return true;

   466

	}

   467

   468

	IConsolePrint(CC_DEFAULT, "Banlist: ");

   469

   470

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

   471

		if (_network_ban_list[i] != NULL)

   472

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

   473

	}

   474

   475

	return true;

   476

}

   477

   478

DEF_CONSOLE_CMD(ConPauseGame)

   479

{

   480

	if (argc == 0) {

   481

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