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

		rs->slot[0] = rs->slot[1] = INVALID_VEHICLE;

   113

	}

   114

   115

	return true;

   116

}

   117

   118

DEF_CONSOLE_CMD(ConStopAllVehicles)

   119

{

   120

	Vehicle* v;

   121

	if (argc == 0) {

   122

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

   123

		return true;

   124

	}

   125

   126

	FOR_ALL_VEHICLES(v) {

   127

		if (IsValidVehicle(v)) {

   128

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

   129

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

   130

			if (v->type == VEH_Train)

   131

				v->u.rail.days_since_order_progr = 0;

   132

			v->vehstatus |= VS_STOPPED;

   133

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

   134

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   135

		}

   136

	}

   137

	return true;

   138

}

   139

   140

DEF_CONSOLE_CMD(ConResetEngines)

   141

{

   142

	if (argc == 0) {

   143

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

   144

		return true;

   145

	}

   146

   147

	StartupEngines();

   148

	return true;

   149

}

   150

   151

#ifdef _DEBUG

   152

DEF_CONSOLE_CMD(ConResetTile)

   153

{

   154

	if (argc == 0) {

   155

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

   156

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

   157

		return true;

   158

	}

   159

   160

	if (argc == 2) {

   161

		uint32 result;

   162

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

   163

			DoClearSquare((TileIndex)result);

   164

			return true;

   165

		}

   166

	}

   167

   168

	return false;

   169

}

   170

#endif /* _DEBUG */

   171

   172

DEF_CONSOLE_CMD(ConScrollToTile)

   173

{

   174

	if (argc == 0) {

   175

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

   176

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

   177

		return true;

   178

	}

   179

   180

	if (argc == 2) {

   181

		uint32 result;

   182

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

   183

			ScrollMainWindowToTile((TileIndex)result);

   184

			return true;

   185

		}

   186

	}

   187

   188

	return false;

   189

}

   190

   191

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

   192

extern void BuildFileList(void);

   193

extern void SetFiosType(const byte fiostype);

   194

   195

/* Save the map to a file */

   196

DEF_CONSOLE_CMD(ConSave)

   197

{

   198

	if (argc == 0) {

   199

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

   200

		return true;

   201

	}

   202

   203

	if (argc == 2) {

   204

		char buf[200];

   205

   206

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

   207

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

   208

   209

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

   210

			IConsolePrint(_icolour_err, "SaveMap failed");

   211

		} else

   212

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

   213

		return true;

   214

	}

   215

   216

	return false;

   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 IS_INT_INSIDE(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(_icolour_err, "%s: Not a savegame.", file);

   266

		}

   267

	} else

   268

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

   269

   270

	FiosFreeSavegameList();

   271

	return true;

   272

}

   273

   274

   275

DEF_CONSOLE_CMD(ConRemove)

   276

{

   277

	const FiosItem* item;

   278

	const char* file;

   279

   280

	if (argc == 0) {

   281

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

   282

		return true;

   283

	}

   284

   285

	if (argc != 2) return false;

   286

   287

	file = argv[1];

   288

	item = GetFiosItem(file);

   289

	if (item != NULL) {

   290

		if (!FiosDelete(item->name))

   291

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

   292

	} else

   293

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

   294

   295

	FiosFreeSavegameList();

   296

	return true;

   297

}

   298

   299

   300

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

   301

DEF_CONSOLE_CMD(ConListFiles)

   302

{

   303

	int i;

   304

   305

	if (argc == 0) {

   306

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

   307

		return true;

   308

	}

   309

   310

	BuildFileList();

   311

   312

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

   313

		const FiosItem *item = &_fios_list[i];

   314

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

   315

	}

   316

   317

	FiosFreeSavegameList();

   318

	return true;

   319

}

   320

   321

/* Change the dir via console */

   322

DEF_CONSOLE_CMD(ConChangeDirectory)

   323

{

   324

	const FiosItem *item;

   325

	const char *file;

   326

   327

	if (argc == 0) {

   328

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

   329

		return true;

   330

	}

   331

   332

	if (argc != 2) return false;

   333

   334

	file = argv[1];

   335

	item = GetFiosItem(file);

   336

	if (item != NULL) {

   337

		switch (item->type) {

   338

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   339

				FiosBrowseTo(item);

   340

				break;

   341

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

   342

		}

   343

	} else

   344

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

   345

   346

	FiosFreeSavegameList();

   347

	return true;

   348

}

   349

   350

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   351

{

   352

	const char *path;

   353

   354

	if (argc == 0) {

   355

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

   356

		return true;

   357

	}

   358

   359

	// XXX - Workaround for broken file handling

   360

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   361

	FiosFreeSavegameList();

   362

   363

	FiosGetDescText(&path, NULL);

   364

	IConsolePrint(_icolour_def, path);

   365

	return true;

   366

}

   367

   368

DEF_CONSOLE_CMD(ConClearBuffer)

   369

{

   370

	if (argc == 0) {

   371

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

   372

		return true;

   373

	}

   374

   375

	IConsoleClearBuffer();

   376

	InvalidateWindow(WC_CONSOLE, 0);

   377

	return true;

   378

}

   379

   380

   381

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

   382

// * Network Core Console Commands * //

   383

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

   384

#ifdef ENABLE_NETWORK

   385

   386

DEF_CONSOLE_CMD(ConBan)

   387

{

   388

	NetworkClientInfo *ci;

   389

	const char *banip = NULL;

   390

	uint32 index;

   391

   392

	if (argc == 0) {

   393

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

   394

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

   395

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

   396

		return true;

   397

	}

   398

   399

	if (argc != 2) return false;

   400

   401

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

   402

		index = atoi(argv[1]);

   403

		ci = NetworkFindClientInfoFromIndex(index);

   404

	} else { // banning IP

   405

		ci = NetworkFindClientInfoFromIP(argv[1]);

   406

		if (ci == NULL) {

   407

			banip = argv[1];

   408

			index = (uint32)-1;

   409

		} else {

   410

			index = ci->client_index;

   411

		}

   412

	}

   413

   414

	if (index == NETWORK_SERVER_INDEX) {

   415

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

   416

		return true;

   417

	}

   418

   419

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

   420

		IConsoleError("Invalid client");

   421

		return true;

   422

	}

   423

   424

	if (ci != NULL) {

   425

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

   426

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

   427

		IConsolePrint(_icolour_def, "Client banned");

   428

	} else

   429

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

   430

   431

	/* Add user to ban-list */

   432

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

   433

		if (_network_ban_list[index] == NULL) {

   434

			_network_ban_list[index] = strdup(banip);

   435

			break;

   436

		}

   437

	}

   438

   439

	return true;

   440

}

   441

   442

DEF_CONSOLE_CMD(ConUnBan)

   443

{

   444

	uint i, index;

   445

   446

	if (argc == 0) {

   447

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

   448

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

   449

		return true;

   450

	}

   451

   452

	if (argc != 2) return false;

   453

   454

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

   455

	index--;

   456

   457

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

   458

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

   459

   460

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

   461

			free(_network_ban_list[i]);

   462

			_network_ban_list[i] = NULL;

   463

			IConsolePrint(_icolour_def, "IP unbanned.");

   464

			return true;

   465

		}

   466

	}

   467

   468

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

   469

	return true;

   470

}

   471

   472

DEF_CONSOLE_CMD(ConBanList)

   473

{

   474

	uint i;

   475

   476

	if (argc == 0) {

   477

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

   478

		return true;

   479

	}

   480

   481

	IConsolePrint(_icolour_def, "Banlist: ");

   482

   483

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