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

    19

#include "vehicle.h"

    20

#include "station.h"

    21

#include "strings.h"

    22

#include "screenshot.h"

    23

#include "genworld.h"

    24

#include "date.h"

    25

    26

#ifdef ENABLE_NETWORK

    27

	#include "table/strings.h"

    28

	#include "network.h"

    29

#endif /*ENABLE_NETWORK*/

    30

    31

// ** scriptfile handling ** //

    32

static FILE *_script_file;

    33

static bool _script_running;

    34

    35

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

    36

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

    37

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

    38

    39

    40

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

    41

/* variable and command hooks   */

    42

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

    43

    44

#ifdef ENABLE_NETWORK

    45

    46

static inline bool NetworkAvailable(void)

    47

{

    48

	if (!_network_available) {

    49

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

    50

		return false;

    51

	}

    52

	return true;

    53

}

    54

    55

DEF_CONSOLE_HOOK(ConHookServerOnly)

    56

{

    57

	if (!NetworkAvailable()) return false;

    58

    59

	if (!_network_server) {

    60

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

    61

		return false;

    62

	}

    63

	return true;

    64

}

    65

    66

DEF_CONSOLE_HOOK(ConHookClientOnly)

    67

{

    68

	if (!NetworkAvailable()) return false;

    69

    70

	if (_network_server) {

    71

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

    72

		return false;

    73

	}

    74

	return true;

    75

}

    76

    77

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    78

{

    79

	if (!NetworkAvailable()) return false;

    80

    81

	if (!_networking) {

    82

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

    83

		return false;

    84

	}

    85

	return true;

    86

}

    87

    88

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    89

{

    90

	if (_networking) {

    91

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

    92

		return false;

    93

	}

    94

	return true;

    95

}

    96

    97

#endif /* ENABLE_NETWORK */

    98

    99

static void IConsoleHelp(const char *str)

   100

{

   101

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

   102

}

   103

   104

DEF_CONSOLE_CMD(ConResetEngines)

   105

{

   106

	if (argc == 0) {

   107

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

   108

		return true;

   109

	}

   110

   111

	StartupEngines();

   112

	return true;

   113

}

   114

   115

#ifdef _DEBUG

   116

DEF_CONSOLE_CMD(ConResetTile)

   117

{

   118

	if (argc == 0) {

   119

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

   120

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

   121

		return true;

   122

	}

   123

   124

	if (argc == 2) {

   125

		uint32 result;

   126

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

   127

			DoClearSquare((TileIndex)result);

   128

			return true;

   129

		}

   130

	}

   131

   132

	return false;

   133

}

   134

   135

DEF_CONSOLE_CMD(ConStopAllVehicles)

   136

{

   137

	Vehicle* v;

   138

	if (argc == 0) {

   139

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

   140

		return true;

   141

	}

   142

   143

	FOR_ALL_VEHICLES(v) {

   144

		if (IsValidVehicle(v)) {

   145

			/* Code ripped from CmdStartStopTrain. Can't call it, because of

   146

			 * ownership problems, so we'll duplicate some code, for now */

   147

			if (v->type == VEH_Train)

   148

				v->u.rail.days_since_order_progr = 0;

   149

			v->vehstatus |= VS_STOPPED;

   150

			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   151

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   152

		}

   153

	}

   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

			ScrollMainWindowToTile((TileIndex)result);

   170

			return true;

   171

		}

   172

	}

   173

   174

	return false;

   175

}

   176

   177

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

   178

extern void BuildFileList(void);

   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 buf[200];

   191

   192

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

   193

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

   194

   195

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

   196

			IConsolePrint(_icolour_err, "SaveMap failed");

   197

		} else {

   198

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

   199

		}

   200

		return true;

   201

	}

   202

   203

	return false;

   204

}

   205

   206

static const FiosItem* GetFiosItem(const char* file)

   207

{

   208

	int i;

   209

   210

	_saveload_mode = SLD_LOAD_GAME;

   211

	BuildFileList();

   212

   213

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

   214

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

   215

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

   216

	}

   217

   218

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

   219

		char* endptr;

   220

   221

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

   222

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

   223

	}

   224

   225

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

   226

}

   227

   228

   229

DEF_CONSOLE_CMD(ConLoad)

   230

{

   231

	const FiosItem *item;

   232

	const char *file;

   233

   234

	if (argc == 0) {

   235

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

   236

		return true;

   237

	}

   238

   239

	if (argc != 2) return false;

   240

   241

	file = argv[1];

   242

	item = GetFiosItem(file);

   243

	if (item != NULL) {

   244

		switch (item->type) {

   245

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   246

				_switch_mode = SM_LOAD;

   247

				SetFiosType(item->type);

   248

   249

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

   250

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

   251

			} break;

   252

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

   253

		}

   254

	} else {

   255

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

   256

	}

   257

   258

	FiosFreeSavegameList();

   259

	return true;

   260

}

   261

   262

   263

DEF_CONSOLE_CMD(ConRemove)

   264

{

   265

	const FiosItem* item;

   266

	const char* file;

   267

   268

	if (argc == 0) {

   269

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

   270

		return true;

   271

	}

   272

   273

	if (argc != 2) return false;

   274

   275

	file = argv[1];

   276

	item = GetFiosItem(file);

   277

	if (item != NULL) {

   278

		if (!FiosDelete(item->name))

   279

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

   280

	} else {

   281

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

   282

	}

   283

   284

	FiosFreeSavegameList();

   285

	return true;

   286

}

   287

   288

   289

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

   290

DEF_CONSOLE_CMD(ConListFiles)

   291

{

   292

	int i;

   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 (i = 0; i < _fios_num; i++) {

   302

		const FiosItem *item = &_fios_list[i];

   303

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

   304

	}

   305

   306

	FiosFreeSavegameList();

   307

	return true;

   308

}

   309

   310

/* Change the dir via console */

   311

DEF_CONSOLE_CMD(ConChangeDirectory)

   312

{

   313

	const FiosItem *item;

   314

	const char *file;

   315

   316

	if (argc == 0) {

   317

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

   318

		return true;

   319

	}

   320

   321

	if (argc != 2) return false;

   322

   323

	file = argv[1];

   324

	item = GetFiosItem(file);

   325

	if (item != NULL) {

   326

		switch (item->type) {

   327

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   328

				FiosBrowseTo(item);

   329

				break;

   330

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

   331

		}

   332

	} else {

   333

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

   334

	}

   335

   336

	FiosFreeSavegameList();

   337

	return true;

   338

}

   339

   340

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   341

{

   342

	const char *path;

   343

   344

	if (argc == 0) {

   345

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

   346

		return true;

   347

	}

   348

   349

	// XXX - Workaround for broken file handling

   350

	FiosGetSavegameList(SLD_LOAD_GAME);

   351

	FiosFreeSavegameList();

   352

   353

	FiosGetDescText(&path, NULL);

   354

	IConsolePrint(_icolour_def, path);

   355

	return true;

   356

}

   357

   358

DEF_CONSOLE_CMD(ConClearBuffer)

   359

{

   360

	if (argc == 0) {

   361

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

   362

		return true;

   363

	}

   364

   365

	IConsoleClearBuffer();

   366

	InvalidateWindow(WC_CONSOLE, 0);

   367

	return true;

   368

}

   369

   370

   371

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

   372

// * Network Core Console Commands * //

   373

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

   374

#ifdef ENABLE_NETWORK

   375

   376

DEF_CONSOLE_CMD(ConBan)

   377

{

   378

	NetworkClientInfo *ci;

   379

	const char *banip = NULL;

   380

	uint32 index;

   381

   382

	if (argc == 0) {

   383

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

   384

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

   385

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

   386

		return true;

   387

	}

   388

   389

	if (argc != 2) return false;

   390

   391

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

   392

		index = atoi(argv[1]);

   393

		ci = NetworkFindClientInfoFromIndex(index);

   394

	} else { // banning IP

   395

		ci = NetworkFindClientInfoFromIP(argv[1]);

   396

		if (ci == NULL) {

   397

			banip = argv[1];

   398

			index = (uint32)-1;

   399

		} else {

   400

			index = ci->client_index;

   401

		}

   402

	}

   403

   404

	if (index == NETWORK_SERVER_INDEX) {

   405

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

   406

		return true;

   407

	}

   408

   409

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

   410

		IConsoleError("Invalid client");

   411

		return true;

   412

	}

   413

   414

	if (ci != NULL) {

   415

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

   416

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

   417

		IConsolePrint(_icolour_def, "Client banned");

   418

	} else {

   419

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

   420

	}

   421

   422

	/* Add user to ban-list */

   423

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

   424

		if (_network_ban_list[index] == NULL) {

   425

			_network_ban_list[index] = strdup(banip);

   426

			break;

   427

		}

   428

	}

   429

   430

	return true;

   431

}

   432

   433

DEF_CONSOLE_CMD(ConUnBan)

   434

{

   435

	uint i, index;

   436

   437

	if (argc == 0) {

   438

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

   439

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

   440

		return true;

   441

	}

   442

   443

	if (argc != 2) return false;

   444

   445

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

   446

	index--;

   447

   448

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

   449

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

   450

   451

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

   452

			free(_network_ban_list[i]);

   453

			_network_ban_list[i] = NULL;

   454

			IConsolePrint(_icolour_def, "IP unbanned.");

   455

			return true;

   456

		}

   457

	}

   458

   459

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

   460

	return true;

   461

}

   462

   463

DEF_CONSOLE_CMD(ConBanList)

   464

{

   465

	uint i;

   466

   467

	if (argc == 0) {

   468

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

   469

		return true;

   470

	}

   471

   472

	IConsolePrint(_icolour_def, "Banlist: ");

   473

   474

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

   475

		if (_network_ban_list[i] != NULL)

   476

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

   477

	}

   478

   479

	return true;

   480

}

   481

   482

DEF_CONSOLE_CMD(ConPauseGame)