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 "hal.h" /* for file list */

    19

#include "vehicle.h"

    20

#include "station.h"

    21

    22

// ** scriptfile handling ** //

    23

static FILE *_script_file;

    24

static bool _script_running;

    25

    26

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

    27

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

    28

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

    29

    30

    31

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

    32

/* variable and command hooks   */

    33

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

    34

    35

#ifdef ENABLE_NETWORK

    36

    37

static inline bool NetworkAvailable(void)

    38

{

    39

	if (!_network_available) {

    40

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

    41

		return false;

    42

	}

    43

	return true;

    44

}

    45

    46

DEF_CONSOLE_HOOK(ConHookServerOnly)

    47

{

    48

	if (!NetworkAvailable()) return false;

    49

    50

	if (!_network_server) {

    51

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

    52

		return false;

    53

	}

    54

	return true;

    55

}

    56

    57

DEF_CONSOLE_HOOK(ConHookClientOnly)

    58

{

    59

	if (!NetworkAvailable()) return false;

    60

    61

	if (_network_server) {

    62

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

    63

		return false;

    64

	}

    65

	return true;

    66

}

    67

    68

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    69

{

    70

	if (!NetworkAvailable()) return false;

    71

    72

	if (!_networking) {

    73

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

    74

		return false;

    75

	}

    76

	return true;

    77

}

    78

    79

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    80

{

    81

	if (_networking) {

    82

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

    83

		return false;

    84

	}

    85

	return true;

    86

}

    87

    88

#endif /* ENABLE_NETWORK */

    89

    90

static void IConsoleHelp(const char *str)

    91

{

    92

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

    93

}

    94

    95

DEF_CONSOLE_CMD(ConResetSlots)

    96

{

    97

	Vehicle *v;

    98

	RoadStop *rs;

    99

	if (argc == 0) {

   100

		IConsoleHelp("Resets all slots in the game. For debugging only. Usage: 'clearslots'");

   101

		return true;

   102

	}

   103

   104

	FOR_ALL_VEHICLES(v) {

   105

		if (IsValidVehicle(v)) {

   106

			if (v->type == VEH_Road)

   107

				ClearSlot(v);

   108

		}

   109

	}

   110

   111

	FOR_ALL_ROADSTOPS(rs) {

   112

		int i;

   113

		for (i = 0; i < NUM_SLOTS; i++) rs->slot[i] = INVALID_VEHICLE;

   114

	}

   115

   116

	return true;

   117

}

   118

   119

DEF_CONSOLE_CMD(ConStopAllVehicles)

   120

{

   121

	Vehicle* v;

   122

	if (argc == 0) {

   123

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

   124

		return true;

   125

	}

   126

   127

	FOR_ALL_VEHICLES(v) {

   128

		if (IsValidVehicle(v)) {

   129

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

   130

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

   131

			if (v->type == VEH_Train)

   132

				v->u.rail.days_since_order_progr = 0;

   133

			v->vehstatus |= VS_STOPPED;

   134

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

   135

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   136

		}

   137

	}

   138

	return true;

   139

}

   140

   141

DEF_CONSOLE_CMD(ConResetEngines)

   142

{

   143

	if (argc == 0) {

   144

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

   145

		return true;

   146

	}

   147

   148

	StartupEngines();

   149

	return true;

   150

}

   151

   152

#ifdef _DEBUG

   153

DEF_CONSOLE_CMD(ConResetTile)

   154

{

   155

	if (argc == 0) {

   156

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

   157

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

   158

		return true;

   159

	}

   160

   161

	if (argc == 2) {

   162

		uint32 result;

   163

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

   164

			DoClearSquare((TileIndex)result);

   165

			return true;

   166

		}

   167

	}

   168

   169

	return false;

   170

}

   171

#endif /* _DEBUG */

   172

   173

DEF_CONSOLE_CMD(ConScrollToTile)

   174

{

   175

	if (argc == 0) {

   176

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

   177

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

   178

		return true;

   179

	}

   180

   181

	if (argc == 2) {

   182

		uint32 result;

   183

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

   184

			ScrollMainWindowToTile((TileIndex)result);

   185

			return true;

   186

		}

   187

	}

   188

   189

	return false;

   190

}

   191

   192

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

   193

extern void BuildFileList(void);

   194

extern void SetFiosType(const byte fiostype);

   195

   196

/* Save the map to a file */

   197

DEF_CONSOLE_CMD(ConSave)

   198

{

   199

	if (argc == 0) {

   200

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

   201

		return true;

   202

	}

   203

   204

	if (argc == 2) {

   205

		char buf[200];

   206

   207

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

   208

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

   209

   210

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

   211

			IConsolePrint(_icolour_err, "SaveMap failed");

   212

		} else

   213

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

   214

		return true;

   215

	}

   216

   217

	return false;

   218

}

   219

   220

static const FiosItem* GetFiosItem(const char* file)

   221

{

   222

	int i;

   223

   224

	_saveload_mode = SLD_LOAD_GAME;

   225

	BuildFileList();

   226

   227

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

   228

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

   229

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

   230

	}

   231

   232

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

   233

		char* endptr;

   234

   235

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

   236

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

   237

	}

   238

   239

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

   240

}

   241

   242

   243

DEF_CONSOLE_CMD(ConLoad)

   244

{

   245

	const FiosItem *item;

   246

	const char *file;

   247

   248

	if (argc == 0) {

   249

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

   250

		return true;

   251

	}

   252

   253

	if (argc != 2) return false;

   254

   255

	file = argv[1];

   256

	item = GetFiosItem(file);

   257

	if (item != NULL) {

   258

		switch (item->type) {

   259

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   260

				_switch_mode = SM_LOAD;

   261

				SetFiosType(item->type);

   262

   263

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

   264

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

   265

			} break;

   266

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

   267

		}

   268

	} else

   269

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

   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(_icolour_err, "%s: Failed to delete file", file);

   293

	} else

   294

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

   295

   296

	FiosFreeSavegameList();

   297

	return true;

   298

}

   299

   300

   301

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

   302

DEF_CONSOLE_CMD(ConListFiles)

   303

{

   304

	int i;

   305

   306

	if (argc == 0) {

   307

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

   308

		return true;

   309

	}

   310

   311

	BuildFileList();

   312

   313

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

   314

		const FiosItem *item = &_fios_list[i];

   315

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

   316

	}

   317

   318

	FiosFreeSavegameList();

   319

	return true;

   320

}

   321

   322

/* Change the dir via console */

   323

DEF_CONSOLE_CMD(ConChangeDirectory)

   324

{

   325

	const FiosItem *item;

   326

	const char *file;

   327

   328

	if (argc == 0) {

   329

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

   330

		return true;

   331

	}

   332

   333

	if (argc != 2) return false;

   334

   335

	file = argv[1];

   336

	item = GetFiosItem(file);

   337

	if (item != NULL) {

   338

		switch (item->type) {

   339

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   340

				FiosBrowseTo(item);

   341

				break;

   342

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

   343

		}

   344

	} else

   345

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

   346

   347

	FiosFreeSavegameList();

   348

	return true;

   349

}

   350

   351

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   352

{

   353

	const char *path;

   354

   355

	if (argc == 0) {

   356

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

   357

		return true;

   358

	}

   359

   360

	// XXX - Workaround for broken file handling

   361

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   362

	FiosFreeSavegameList();

   363

   364

	FiosGetDescText(&path, NULL);

   365

	IConsolePrint(_icolour_def, path);

   366

	return true;

   367

}

   368

   369

DEF_CONSOLE_CMD(ConClearBuffer)

   370

{

   371

	if (argc == 0) {

   372

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

   373

		return true;

   374

	}

   375

   376

	IConsoleClearBuffer();

   377

	InvalidateWindow(WC_CONSOLE, 0);

   378

	return true;

   379

}

   380

   381

   382

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

   383

// * Network Core Console Commands * //

   384

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

   385

#ifdef ENABLE_NETWORK

   386

   387

DEF_CONSOLE_CMD(ConBan)

   388

{

   389

	NetworkClientInfo *ci;

   390

	const char *banip = NULL;

   391

	uint32 index;

   392

   393

	if (argc == 0) {

   394

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

   395

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

   396

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

   397

		return true;

   398

	}

   399

   400

	if (argc != 2) return false;

   401

   402

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

   403

		index = atoi(argv[1]);

   404

		ci = NetworkFindClientInfoFromIndex(index);

   405

	} else { // banning IP

   406

		ci = NetworkFindClientInfoFromIP(argv[1]);

   407

		if (ci == NULL) {

   408

			banip = argv[1];

   409

			index = (uint32)-1;

   410

		} else {

   411

			index = ci->client_index;

   412

		}

   413

	}

   414

   415

	if (index == NETWORK_SERVER_INDEX) {

   416

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

   417

		return true;

   418

	}

   419

   420

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

   421

		IConsoleError("Invalid client");

   422

		return true;

   423

	}

   424

   425

	if (ci != NULL) {

   426

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

   427

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

   428

		IConsolePrint(_icolour_def, "Client banned");

   429

	} else

   430

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

   431

   432

	/* Add user to ban-list */

   433

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

   434

		if (_network_ban_list[index] == NULL) {

   435

			_network_ban_list[index] = strdup(banip);

   436

			break;

   437

		}

   438

	}

   439

   440

	return true;

   441

}

   442

   443

DEF_CONSOLE_CMD(ConUnBan)

   444

{

   445

	uint i, index;

   446

   447

	if (argc == 0) {

   448

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

   449

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

   450

		return true;

   451

	}

   452

   453

	if (argc != 2) return false;

   454

   455

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

   456

	index--;

   457

   458

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

   459

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

   460

   461

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

   462

			free(_network_ban_list[i]);

   463

			_network_ban_list[i] = NULL;

   464

			IConsolePrint(_icolour_def, "IP unbanned.");

   465

			return true;

   466

		}

   467

	}

   468

   469

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

   470

	return true;

   471

}

   472

   473

DEF_CONSOLE_CMD(ConBanList)

   474

{

   475

	uint i;

   476

   477

	if (argc == 0) {

   478

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

   479

		return true;

   480

	}

   481

   482

	IConsolePrint(_icolour_def, "Banlist: ");

   483