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

    14

#include "network/network_client.h"

    15

#include "network/network_server.h"

    16

#include "network/network_udp.h"

    17

#include "command_func.h"

    18

#include "settings_func.h"

    19

#include "fios.h"

    20

#include "fileio.h"

    21

#include "screenshot.h"

    22

#include "genworld.h"

    23

#include "network/network.h"

    24

#include "strings_func.h"

    25

#include "viewport_func.h"

    26

#include "window_func.h"

    27

#include "functions.h"

    28

#include "map_func.h"

    29

#include "date_func.h"

    30

#include "vehicle_func.h"

    31

#include "string_func.h"

    32

#include "player_func.h"

    33

#include "player_base.h"

    34

#include "settings_type.h"

    35

    36

#ifdef ENABLE_NETWORK

    37

	#include "table/strings.h"

    38

#endif /* ENABLE_NETWORK */

    39

    40

// ** scriptfile handling ** //

    41

static FILE *_script_file;

    42

static bool _script_running;

    43

    44

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

    45

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

    46

#define DEF_CONSOLE_HOOK(function) static bool function()

    47

    48

    49

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

    50

/* variable and command hooks   */

    51

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

    52

    53

#ifdef ENABLE_NETWORK

    54

    55

static inline bool NetworkAvailable()

    56

{

    57

	if (!_network_available) {

    58

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

    59

		return false;

    60

	}

    61

	return true;

    62

}

    63

    64

DEF_CONSOLE_HOOK(ConHookServerOnly)

    65

{

    66

	if (!NetworkAvailable()) return false;

    67

    68

	if (!_network_server) {

    69

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

    70

		return false;

    71

	}

    72

	return true;

    73

}

    74

    75

DEF_CONSOLE_HOOK(ConHookClientOnly)

    76

{

    77

	if (!NetworkAvailable()) return false;

    78

    79

	if (_network_server) {

    80

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

    81

		return false;

    82

	}

    83

	return true;

    84

}

    85

    86

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    87

{

    88

	if (!NetworkAvailable()) return false;

    89

    90

	if (!_networking) {

    91

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

    92

		return false;

    93

	}

    94

	return true;

    95

}

    96

    97

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    98

{

    99

	if (_networking) {

   100

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

   101

		return false;

   102

	}

   103

	return true;

   104

}

   105

   106

#endif /* ENABLE_NETWORK */

   107

   108

static void IConsoleHelp(const char *str)

   109

{

   110

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

   111

}

   112

   113

DEF_CONSOLE_CMD(ConResetEngines)

   114

{

   115

	if (argc == 0) {

   116

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

   117

		return true;

   118

	}

   119

   120

	StartupEngines();

   121

	return true;

   122

}

   123

   124

#ifdef _DEBUG

   125

DEF_CONSOLE_CMD(ConResetTile)

   126

{

   127

	if (argc == 0) {

   128

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

   129

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

   130

		return true;

   131

	}

   132

   133

	if (argc == 2) {

   134

		uint32 result;

   135

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

   136

			DoClearSquare((TileIndex)result);

   137

			return true;

   138

		}

   139

	}

   140

   141

	return false;

   142

}

   143

   144

DEF_CONSOLE_CMD(ConStopAllVehicles)

   145

{

   146

	if (argc == 0) {

   147

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

   148

		return true;

   149

	}

   150

   151

	StopAllVehicles();

   152

	return true;

   153

}

   154

#endif /* _DEBUG */

   155

   156

DEF_CONSOLE_CMD(ConScrollToTile)

   157

{

   158

	if (argc == 0) {

   159

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

   160

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

   161

		return true;

   162

	}

   163

   164

	if (argc == 2) {

   165

		uint32 result;

   166

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

   167

			if (result >= MapSize()) {

   168

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

   169

				return true;

   170

			}

   171

			ScrollMainWindowToTile((TileIndex)result);

   172

			return true;

   173

		}

   174

	}

   175

   176

	return false;

   177

}

   178

   179

extern void BuildFileList();

   180

extern void SetFiosType(const byte fiostype);

   181

   182

/* Save the map to a file */

   183

DEF_CONSOLE_CMD(ConSave)

   184

{

   185

	if (argc == 0) {

   186

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

   187

		return true;

   188

	}

   189

   190

	if (argc == 2) {

   191

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

   192

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

   193

   194

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

   195

			IConsolePrint(CC_ERROR, "Saving map failed");

   196

		} else {

   197

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

   198

		}

   199

		free(filename);

   200

		return true;

   201

	}

   202

   203

	return false;

   204

}

   205

   206

/* Explicitly save the configuration */

   207

DEF_CONSOLE_CMD(ConSaveConfig)

   208

{

   209

	if (argc == 0) {

   210

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

   211

		return true;

   212

	}

   213

   214

	SaveToConfig();

   215

	IConsolePrint(CC_DEFAULT, "Saved config.");

   216

	return true;

   217

}

   218

   219

static const FiosItem* GetFiosItem(const char* file)

   220

{

   221

	int i;

   222

   223

	_saveload_mode = SLD_LOAD_GAME;

   224

	BuildFileList();

   225

   226

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

   227

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

   228

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

   229

	}

   230

   231

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

   232

		char* endptr;

   233

   234

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

   235

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

   236

	}

   237

   238

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

   239

}

   240

   241

   242

DEF_CONSOLE_CMD(ConLoad)

   243

{

   244

	const FiosItem *item;

   245

	const char *file;

   246

   247

	if (argc == 0) {

   248

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

   249

		return true;

   250

	}

   251

   252

	if (argc != 2) return false;

   253

   254

	file = argv[1];

   255

	item = GetFiosItem(file);

   256

	if (item != NULL) {

   257

		switch (item->type) {

   258

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   259

				_switch_mode = SM_LOAD;

   260

				SetFiosType(item->type);

   261

   262

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

   263

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

   264

			} break;

   265

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

   266

		}

   267

	} else {

   268

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

   269

	}

   270

   271

	FiosFreeSavegameList();

   272

	return true;

   273

}

   274

   275

   276

DEF_CONSOLE_CMD(ConRemove)

   277

{

   278

	const FiosItem* item;

   279

	const char* file;

   280

   281

	if (argc == 0) {

   282

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

   283

		return true;

   284

	}

   285

   286

	if (argc != 2) return false;

   287

   288

	file = argv[1];

   289

	item = GetFiosItem(file);

   290

	if (item != NULL) {

   291

		if (!FiosDelete(item->name))

   292

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

   293

	} else {

   294

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

   295

	}

   296

   297

	FiosFreeSavegameList();

   298

	return true;

   299

}

   300

   301

   302

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

   303

DEF_CONSOLE_CMD(ConListFiles)

   304

{

   305

	int i;

   306

   307

	if (argc == 0) {

   308

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

   309

		return true;

   310

	}

   311

   312

	BuildFileList();

   313

   314

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

   315

		const FiosItem *item = &_fios_list[i];

   316

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

   317

	}

   318

   319

	FiosFreeSavegameList();

   320

	return true;

   321

}

   322

   323

/* Change the dir via console */

   324

DEF_CONSOLE_CMD(ConChangeDirectory)

   325

{

   326

	const FiosItem *item;

   327

	const char *file;

   328

   329

	if (argc == 0) {

   330

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

   331

		return true;

   332

	}

   333

   334

	if (argc != 2) return false;

   335

   336

	file = argv[1];

   337

	item = GetFiosItem(file);

   338

	if (item != NULL) {

   339

		switch (item->type) {

   340

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   341

				FiosBrowseTo(item);

   342

				break;

   343

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

   344

		}

   345

	} else {

   346

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

   347

	}

   348

   349

	FiosFreeSavegameList();

   350

	return true;

   351

}

   352

   353

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   354

{

   355

	const char *path;

   356

   357

	if (argc == 0) {

   358

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

   359

		return true;

   360

	}

   361

   362

	// XXX - Workaround for broken file handling

   363

	FiosGetSavegameList(SLD_LOAD_GAME);

   364

	FiosFreeSavegameList();

   365

   366

	FiosGetDescText(&path, NULL);

   367

	IConsolePrint(CC_DEFAULT, path);

   368

	return true;

   369

}

   370

   371

DEF_CONSOLE_CMD(ConClearBuffer)

   372

{

   373

	if (argc == 0) {

   374

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

   375

		return true;

   376

	}

   377

   378

	IConsoleClearBuffer();

   379

	InvalidateWindow(WC_CONSOLE, 0);

   380

	return true;

   381

}

   382

   383

   384

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

   385

// * Network Core Console Commands * //

   386

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

   387

#ifdef ENABLE_NETWORK

   388

   389

DEF_CONSOLE_CMD(ConBan)

   390

{

   391

	NetworkClientInfo *ci;

   392

	const char *banip = NULL;

   393

	uint32 index;

   394

   395

	if (argc == 0) {

   396

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

   397

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

   398

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

   399

		return true;

   400

	}

   401

   402

	if (argc != 2) return false;

   403

   404

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

   405

		index = atoi(argv[1]);

   406

		ci = NetworkFindClientInfoFromIndex(index);

   407

	} else { // banning IP

   408

		ci = NetworkFindClientInfoFromIP(argv[1]);

   409

		if (ci == NULL) {

   410

			banip = argv[1];

   411

			index = (uint32)-1;

   412

		} else {

   413

			index = ci->client_index;

   414

		}

   415

	}

   416

   417

	if (index == NETWORK_SERVER_INDEX) {

   418

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

   419

		return true;

   420

	}

   421

   422

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

   423

		IConsoleError("Invalid client");

   424

		return true;

   425

	}

   426

   427

	if (ci != NULL) {

   428

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

   429

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

   430

		IConsolePrint(CC_DEFAULT, "Client banned");

   431

	} else {

   432

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

   433

	}

   434

   435

	/* Add user to ban-list */

   436

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

   437

		if (_network_ban_list[index] == NULL) {

   438

			_network_ban_list[index] = strdup(banip);

   439

			break;

   440

		}

   441

	}

   442

   443

	return true;

   444

}

   445

   446

DEF_CONSOLE_CMD(ConUnBan)

   447

{

   448

	uint i, index;

   449

   450

	if (argc == 0) {

   451

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

   452

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

   453

		return true;

   454

	}

   455

   456

	if (argc != 2) return false;

   457

   458

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

   459

	index--;

   460

   461

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

   462

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

   463

   464

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

   465

			free(_network_ban_list[i]);

   466

			_network_ban_list[i] = NULL;

   467

			IConsolePrint(CC_DEFAULT, "IP unbanned.");

   468

			return true;

   469

		}

   470

	}

   471

   472

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

   473

	return true;

   474

}

   475

   476

DEF_CONSOLE_CMD(ConBanList)

   477

{

   478

	uint i;

   479

   480

	if (argc == 0) {

   481

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