1

/* $Id$ */

     2

     3

/** @file console_cmds.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "console.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

#include "ai/ai.h"

    36

#include "ai/ai_factory.hpp"

    37

    38

#ifdef ENABLE_NETWORK

    39

	#include "table/strings.h"

    40

#endif /* ENABLE_NETWORK */

    41

    42

// ** scriptfile handling ** //

    43

static FILE *_script_file;

    44

static bool _script_running;

    45

    46

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

    47

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

    48

#define DEF_CONSOLE_HOOK(function) static bool function()

    49

    50

    51

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

    52

/* variable and command hooks   */

    53

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

    54

    55

#ifdef ENABLE_NETWORK

    56

    57

static inline bool NetworkAvailable()

    58

{

    59

	if (!_network_available) {

    60

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

    61

		return false;

    62

	}

    63

	return true;

    64

}

    65

    66

DEF_CONSOLE_HOOK(ConHookServerOnly)

    67

{

    68

	if (!NetworkAvailable()) return false;

    69

    70

	if (!_network_server) {

    71

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

    72

		return false;

    73

	}

    74

	return true;

    75

}

    76

    77

DEF_CONSOLE_HOOK(ConHookClientOnly)

    78

{

    79

	if (!NetworkAvailable()) return false;

    80

    81

	if (_network_server) {

    82

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

    83

		return false;

    84

	}

    85

	return true;

    86

}

    87

    88

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    89

{

    90

	if (!NetworkAvailable()) return false;

    91

    92

	if (!_networking) {

    93

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

    94

		return false;

    95

	}

    96

	return true;

    97

}

    98

    99

DEF_CONSOLE_HOOK(ConHookNoNetwork)

   100

{

   101

	if (_networking) {

   102

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

   103

		return false;

   104

	}

   105

	return true;

   106

}

   107

   108

#endif /* ENABLE_NETWORK */

   109

   110

static void IConsoleHelp(const char *str)

   111

{

   112

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

   113

}

   114

   115

DEF_CONSOLE_CMD(ConResetEngines)

   116

{

   117

	if (argc == 0) {

   118

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

   119

		return true;

   120

	}

   121

   122

	StartupEngines();

   123

	return true;

   124

}

   125

   126

#ifdef _DEBUG

   127

DEF_CONSOLE_CMD(ConResetTile)

   128

{

   129

	if (argc == 0) {

   130

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

   131

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

   132

		return true;

   133

	}

   134

   135

	if (argc == 2) {

   136

		uint32 result;

   137

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

   138

			DoClearSquare((TileIndex)result);

   139

			return true;

   140

		}

   141

	}

   142

   143

	return false;

   144

}

   145

   146

DEF_CONSOLE_CMD(ConStopAllVehicles)

   147

{

   148

	if (argc == 0) {

   149

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

   150

		return true;

   151

	}

   152

   153

	StopAllVehicles();

   154

	return true;

   155

}

   156

#endif /* _DEBUG */

   157

   158

DEF_CONSOLE_CMD(ConScrollToTile)

   159

{

   160

	if (argc == 0) {

   161

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

   162

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

   163

		return true;

   164

	}

   165

   166

	if (argc == 2) {

   167

		uint32 result;

   168

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

   169

			if (result >= MapSize()) {

   170

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

   171

				return true;

   172

			}

   173

			ScrollMainWindowToTile((TileIndex)result);

   174

			return true;

   175

		}

   176

	}

   177

   178

	return false;

   179

}

   180

   181

extern void BuildFileList();

   182

extern void SetFiosType(const byte fiostype);

   183

   184

/* Save the map to a file */

   185

DEF_CONSOLE_CMD(ConSave)

   186

{

   187

	if (argc == 0) {

   188

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

   189

		return true;

   190

	}

   191

   192

	if (argc == 2) {

   193

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

   194

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

   195

   196

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

   197

			IConsolePrint(_icolour_err, "Saving map failed");

   198

		} else {

   199

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

   200

		}

   201

		free(filename);

   202

		return true;

   203

	}

   204

   205

	return false;

   206

}

   207

   208

/* Explicitly save the configuration */

   209

DEF_CONSOLE_CMD(ConSaveConfig)

   210

{

   211

	if (argc == 0) {

   212

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

   213

		return true;

   214

	}

   215

   216

	SaveToConfig();

   217

	IConsolePrint(_icolour_def, "Saved config.");

   218

	return true;

   219

}

   220

   221

static const FiosItem* GetFiosItem(const char* file)

   222

{

   223

	int i;

   224

   225

	_saveload_mode = SLD_LOAD_GAME;

   226

	BuildFileList();

   227

   228

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

   229

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

   230

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

   231

	}

   232

   233

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

   234

		char* endptr;

   235

   236

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

   237

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

   238

	}

   239

   240

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

   241

}

   242

   243

   244

DEF_CONSOLE_CMD(ConLoad)

   245

{

   246

	const FiosItem *item;

   247

	const char *file;

   248

   249

	if (argc == 0) {

   250

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

   251

		return true;

   252

	}

   253

   254

	if (argc != 2) return false;

   255

   256

	file = argv[1];

   257

	item = GetFiosItem(file);

   258

	if (item != NULL) {

   259

		switch (item->type) {

   260

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   261

				_switch_mode = SM_LOAD;

   262

				SetFiosType(item->type);

   263

   264

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

   265

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

   266

			} break;

   267

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

   268

		}

   269

	} else {

   270

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

   271

	}

   272

   273

	FiosFreeSavegameList();

   274

	return true;

   275

}

   276

   277

   278

DEF_CONSOLE_CMD(ConRemove)

   279

{

   280

	const FiosItem* item;

   281

	const char* file;

   282

   283

	if (argc == 0) {

   284

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

   285

		return true;

   286

	}

   287

   288

	if (argc != 2) return false;

   289

   290

	file = argv[1];

   291

	item = GetFiosItem(file);

   292

	if (item != NULL) {

   293

		if (!FiosDelete(item->name))

   294

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

   295

	} else {

   296

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

   297

	}

   298

   299

	FiosFreeSavegameList();

   300

	return true;

   301

}

   302

   303

   304

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

   305

DEF_CONSOLE_CMD(ConListFiles)

   306

{

   307

	int i;

   308

   309

	if (argc == 0) {

   310

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

   311

		return true;

   312

	}

   313

   314

	BuildFileList();

   315

   316

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

   317

		const FiosItem *item = &_fios_list[i];

   318

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

   319

	}

   320

   321

	FiosFreeSavegameList();

   322

	return true;

   323

}

   324

   325

/* Change the dir via console */

   326

DEF_CONSOLE_CMD(ConChangeDirectory)

   327

{

   328

	const FiosItem *item;

   329

	const char *file;

   330

   331

	if (argc == 0) {

   332

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

   333

		return true;

   334

	}

   335

   336

	if (argc != 2) return false;

   337

   338

	file = argv[1];

   339

	item = GetFiosItem(file);

   340

	if (item != NULL) {

   341

		switch (item->type) {

   342

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   343

				FiosBrowseTo(item);

   344

				break;

   345

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

   346

		}

   347

	} else {

   348

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

   349

	}

   350

   351

	FiosFreeSavegameList();

   352

	return true;

   353

}

   354

   355

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   356

{

   357

	const char *path;

   358

   359

	if (argc == 0) {

   360

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

   361

		return true;

   362

	}

   363

   364

	// XXX - Workaround for broken file handling

   365

	FiosGetSavegameList(SLD_LOAD_GAME);

   366

	FiosFreeSavegameList();

   367

   368

	FiosGetDescText(&path, NULL);

   369

	IConsolePrint(_icolour_def, path);

   370

	return true;

   371

}

   372

   373

DEF_CONSOLE_CMD(ConClearBuffer)

   374

{

   375

	if (argc == 0) {

   376

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

   377

		return true;

   378

	}

   379

   380

	IConsoleClearBuffer();

   381

	InvalidateWindow(WC_CONSOLE, 0);

   382

	return true;

   383

}

   384

   385

   386

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

   387

// * Network Core Console Commands * //

   388

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

   389

#ifdef ENABLE_NETWORK

   390

   391

DEF_CONSOLE_CMD(ConBan)

   392

{

   393

	NetworkClientInfo *ci;

   394

	const char *banip = NULL;

   395

	uint32 index;

   396

   397

	if (argc == 0) {

   398

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

   399

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

   400

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

   401

		return true;

   402

	}

   403

   404

	if (argc != 2) return false;

   405

   406

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

   407

		index = atoi(argv[1]);

   408

		ci = NetworkFindClientInfoFromIndex(index);

   409

	} else { // banning IP

   410

		ci = NetworkFindClientInfoFromIP(argv[1]);

   411

		if (ci == NULL) {

   412

			banip = argv[1];

   413

			index = (uint32)-1;

   414

		} else {

   415

			index = ci->client_index;

   416

		}

   417

	}

   418

   419

	if (index == NETWORK_SERVER_INDEX) {

   420

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

   421

		return true;

   422

	}

   423

   424

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

   425

		IConsoleError("Invalid client");

   426

		return true;

   427

	}

   428

   429

	if (ci != NULL) {

   430

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

   431

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

   432

		IConsolePrint(_icolour_def, "Client banned");

   433

	} else {

   434

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

   435

	}

   436

   437

	/* Add user to ban-list */

   438

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

   439

		if (_network_ban_list[index] == NULL) {

   440

			_network_ban_list[index] = strdup(banip);

   441

			break;

   442

		}

   443

	}

   444

   445

	return true;

   446

}

   447

   448

DEF_CONSOLE_CMD(ConUnBan)

   449

{

   450

	uint i, index;

   451

   452

	if (argc == 0) {

   453

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

   454

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

   455

		return true;

   456

	}

   457

   458

	if (argc != 2) return false;

   459

   460

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

   461

	index--;

   462

   463

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

   464

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

   465

   466

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

   467

			free(_network_ban_list[i]);

   468

			_network_ban_list[i] = NULL;

   469

			IConsolePrint(_icolour_def, "IP unbanned.");

   470

			return true;

   471

		}

   472

	}

   473

   474

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

   475

	return true;

   476

}

   477

   478

DEF_CONSOLE_CMD(ConBanList)

   479

{

   480

	uint i;

   481

   482

	if (argc == 0) {