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

    21

// ** scriptfile handling ** //

    22

static FILE *_script_file;

    23

static bool _script_running;

    24

    25

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

    26

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

    27

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

    28

    29

    30

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

    31

/* variable and command hooks   */

    32

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

    33

    34

#ifdef ENABLE_NETWORK

    35

    36

static inline bool NetworkAvailable(void)

    37

{

    38

	if (!_network_available) {

    39

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

    40

		return false;

    41

	}

    42

	return true;

    43

}

    44

    45

DEF_CONSOLE_HOOK(ConHookServerOnly)

    46

{

    47

	if (!NetworkAvailable()) return false;

    48

    49

	if (!_network_server) {

    50

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

    51

		return false;

    52

	}

    53

	return true;

    54

}

    55

    56

DEF_CONSOLE_HOOK(ConHookClientOnly)

    57

{

    58

	if (!NetworkAvailable()) return false;

    59

    60

	if (_network_server) {

    61

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

    62

		return false;

    63

	}

    64

	return true;

    65

}

    66

    67

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    68

{

    69

	if (!NetworkAvailable()) return false;

    70

    71

	if (!_networking) {

    72

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

    73

		return false;

    74

	}

    75

	return true;

    76

}

    77

    78

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    79

{

    80

	if (_networking) {

    81

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

    82

		return false;

    83

	}

    84

	return true;

    85

}

    86

    87

#endif /* ENABLE_NETWORK */

    88

    89

static void IConsoleHelp(const char *str)

    90

{

    91

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

    92

}

    93

    94

DEF_CONSOLE_CMD(ConStopAllVehicles)

    95

{

    96

	Vehicle* v;

    97

	if (argc == 0) {

    98

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

    99

		return true;

   100

	}

   101

   102

	FOR_ALL_VEHICLES(v) {

   103

		if (IsValidVehicle(v)) {

   104

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

   105

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

   106

			if (v->type == VEH_Train)

   107

				v->u.rail.days_since_order_progr = 0;

   108

			v->vehstatus |= VS_STOPPED;

   109

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

   110

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   111

		}

   112

	}

   113

	return true;

   114

}

   115

   116

DEF_CONSOLE_CMD(ConResetEngines)

   117

{

   118

	if (argc == 0) {

   119

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

   120

		return true;

   121

	}

   122

   123

	StartupEngines();

   124

	return true;

   125

}

   126

   127

#ifdef _DEBUG

   128

DEF_CONSOLE_CMD(ConResetTile)

   129

{

   130

	if (argc == 0) {

   131

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

   132

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

   133

		return true;

   134

	}

   135

   136

	if (argc == 2) {

   137

		uint32 result;

   138

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

   139

			DoClearSquare((TileIndex)result);

   140

			return true;

   141

		}

   142

	}

   143

   144

	return false;

   145

}

   146

#endif /* _DEBUG */

   147

   148

DEF_CONSOLE_CMD(ConScrollToTile)

   149

{

   150

	if (argc == 0) {

   151

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

   152

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

   153

		return true;

   154

	}

   155

   156

	if (argc == 2) {

   157

		uint32 result;

   158

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

   159

			ScrollMainWindowToTile((TileIndex)result);

   160

			return true;

   161

		}

   162

	}

   163

   164

	return false;

   165

}

   166

   167

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

   168

extern void BuildFileList(void);

   169

extern void SetFiosType(const byte fiostype);

   170

   171

/* Save the map to a file */

   172

DEF_CONSOLE_CMD(ConSave)

   173

{

   174

	if (argc == 0) {

   175

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

   176

		return true;

   177

	}

   178

   179

	if (argc == 2) {

   180

		char buf[200];

   181

   182

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

   183

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

   184

   185

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

   186

			IConsolePrint(_icolour_err, "SaveMap failed");

   187

		} else

   188

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

   189

		return true;

   190

	}

   191

   192

	return false;

   193

}

   194

   195

static const FiosItem* GetFiosItem(const char* file)

   196

{

   197

	int i;

   198

   199

	_saveload_mode = SLD_LOAD_GAME;

   200

	BuildFileList();

   201

   202

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

   203

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

   204

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

   205

	}

   206

   207

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

   208

		char* endptr;

   209

   210

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

   211

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

   212

	}

   213

   214

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

   215

}

   216

   217

   218

DEF_CONSOLE_CMD(ConLoad)

   219

{

   220

	const FiosItem *item;

   221

	const char *file;

   222

   223

	if (argc == 0) {

   224

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

   225

		return true;

   226

	}

   227

   228

	if (argc != 2) return false;

   229

   230

	file = argv[1];

   231

	item = GetFiosItem(file);

   232

	if (item != NULL) {

   233

		switch (item->type) {

   234

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   235

				_switch_mode = SM_LOAD;

   236

				SetFiosType(item->type);

   237

   238

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

   239

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

   240

			} break;

   241

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

   242

		}

   243

	} else

   244

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

   245

   246

	FiosFreeSavegameList();

   247

	return true;

   248

}

   249

   250

   251

DEF_CONSOLE_CMD(ConRemove)

   252

{

   253

	const FiosItem* item;

   254

	const char* file;

   255

   256

	if (argc == 0) {

   257

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

   258

		return true;

   259

	}

   260

   261

	if (argc != 2) return false;

   262

   263

	file = argv[1];

   264

	item = GetFiosItem(file);

   265

	if (item != NULL) {

   266

		if (!FiosDelete(item->name))

   267

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

   268

	} else

   269

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

   270

   271

	FiosFreeSavegameList();

   272

	return true;

   273

}

   274

   275

   276

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

   277

DEF_CONSOLE_CMD(ConListFiles)

   278

{

   279

	int i;

   280

   281

	if (argc == 0) {

   282

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

   283

		return true;

   284

	}

   285

   286

	BuildFileList();

   287

   288

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

   289

		const FiosItem *item = &_fios_list[i];

   290

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

   291

	}

   292

   293

	FiosFreeSavegameList();

   294

	return true;

   295

}

   296

   297

/* Change the dir via console */

   298

DEF_CONSOLE_CMD(ConChangeDirectory)

   299

{

   300

	const FiosItem *item;

   301

	const char *file;

   302

   303

	if (argc == 0) {

   304

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

   305

		return true;

   306

	}

   307

   308

	if (argc != 2) return false;

   309

   310

	file = argv[1];

   311

	item = GetFiosItem(file);

   312

	if (item != NULL) {

   313

		switch (item->type) {

   314

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   315

				FiosBrowseTo(item);

   316

				break;

   317

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

   318

		}

   319

	} else

   320

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

   321

   322

	FiosFreeSavegameList();

   323

	return true;

   324

}

   325

   326

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   327

{

   328

	const char *path;

   329

   330

	if (argc == 0) {

   331

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

   332

		return true;

   333

	}

   334

   335

	// XXX - Workaround for broken file handling

   336

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   337

	FiosFreeSavegameList();

   338

   339

	FiosGetDescText(&path, NULL);

   340

	IConsolePrint(_icolour_def, path);

   341

	return true;

   342

}

   343

   344

DEF_CONSOLE_CMD(ConClearBuffer)

   345

{

   346

	if (argc == 0) {

   347

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

   348

		return true;

   349

	}

   350

   351

	IConsoleClearBuffer();

   352

	InvalidateWindow(WC_CONSOLE, 0);

   353

	return true;

   354

}

   355

   356

   357

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

   358

// * Network Core Console Commands * //

   359

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

   360

#ifdef ENABLE_NETWORK

   361

   362

DEF_CONSOLE_CMD(ConBan)

   363

{

   364

	NetworkClientInfo *ci;

   365

	uint32 index;

   366

   367

	if (argc == 0) {

   368

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

   369

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

   370

		return true;

   371

	}

   372

   373

	if (argc != 2) return false;

   374

   375

	index = atoi(argv[1]);

   376

   377

	if (index == NETWORK_SERVER_INDEX) {

   378

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

   379

		return true;

   380

	}

   381

	if (index == 0) {

   382

		IConsoleError("Invalid Client-ID");

   383

		return true;

   384

	}

   385

   386

	ci = NetworkFindClientInfoFromIndex(index);

   387

   388

	if (ci != NULL) {

   389

		uint i;

   390

		/* Add user to ban-list */

   391

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

   392

			if (_network_ban_list[i] == NULL || _network_ban_list[i][0] == '\0') {

   393

				_network_ban_list[i] = strdup(inet_ntoa(*(struct in_addr *)&ci->client_ip));

   394

				break;

   395

			}

   396

		}

   397

   398

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

   399

	} else

   400

		IConsoleError("Client-ID not found");

   401

   402

	return true;

   403

}

   404

   405

DEF_CONSOLE_CMD(ConUnBan)

   406

{

   407

	uint i, index;

   408

   409

	if (argc == 0) {

   410

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

   411

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

   412

		return true;

   413

	}

   414

   415

	if (argc != 2) return false;

   416

   418

	index--;

   419

   420

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

   421

		if (_network_ban_list[i] == NULL || _network_ban_list[i][0] == '\0')

   422

			continue;

   423

   424

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

   425

			_network_ban_list[i][0] = '\0';

   426

			IConsolePrint(_icolour_def, "IP unbanned.");

   427

			return true;

   428

		}

   429

	}

   430

   431

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

   432

	return true;

   433

}

   434

   435

DEF_CONSOLE_CMD(ConBanList)

   436

{

   437

	uint i;

   438

   439

	if (argc == 0) {

   440

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

   441

		return true;

   442

	}

   443

   444

	IConsolePrint(_icolour_def, "Banlist: ");

   445

   446

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

   447

		if (_network_ban_list[i] == NULL || _network_ban_list[i][0] == '\0')

   448

			continue;

   449

   450

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

   451

	}

   452

   453

	return true;

   454

}

   455

   456

DEF_CONSOLE_CMD(ConPauseGame)

   457

{

   458

	if (argc == 0) {

   459

		IConsoleHelp("Pause a network game. Usage: 'pause'");

   460

		return true;

   461

	}

   462

   463

	if (_pause == 0) {

   464

		DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   465

		IConsolePrint(_icolour_def, "Game paused.");

   466

	} else

   467

		IConsolePrint(_icolour_def, "Game is already paused.");

   468

   469

	return true;

   470

}

   471

   472

DEF_CONSOLE_CMD(ConUnPauseGame)

   473

{

   474

	if (argc == 0) {

   475

		IConsoleHelp("Unpause a network game. Usage: 'unpause'");

   476

		return true;

   477

	}

   478

   479

	if (_pause != 0) {

   480

		DoCommandP(0, 0, 0, NULL, CMD_PAUSE);

   481

		IConsolePrint(_icolour_def, "Game unpaused.");

   482

	} else

   483

		IConsolePrint(_icolour_def, "Game is already unpaused.");