OpenTTD-patches/console_cmds.c

716 lines
20 KiB
C

/* -------------------- dont cross this line --------------------- */
#include "stdafx.h"
#include "ttd.h"
#include "console.h"
#include "engine.h"
#include "functions.h"
#include "variables.h"
#include "network_data.h"
#include "network_client.h"
#include "network_server.h"
#include "command.h"
// ** scriptfile handling ** //
static FILE * _script_file;
static bool _script_running;
// ** console command / variable defines ** //
#define DEF_CONSOLE_CMD(yyyy) static _iconsole_var * yyyy(byte argc, char* argv[], byte argt[])
#define DEF_CONSOLE_CMD_HOOK(yyyy) static bool yyyy(_iconsole_cmd * hookcmd)
#define DEF_CONSOLE_VAR_HOOK(yyyy) static bool yyyy(_iconsole_var * hookvar)
// ** supporting functions ** //
static uint32 GetArgumentInteger(const char* arg)
{
uint32 result;
sscanf(arg, "%u", &result);
if (result == 0 && arg[0] == '0' && arg[1] == 'x')
sscanf(arg, "%x", &result);
return result;
}
/* **************************** */
/* variable and command hooks */
/* **************************** */
#ifdef ENABLE_NETWORK
DEF_CONSOLE_CMD_HOOK(ConCmdHookNoNetwork)
{
if (_networking) {
IConsoleError("This command is forbidden in multiplayer.");
return false;
}
return true;
}
DEF_CONSOLE_VAR_HOOK(ConVarHookNoNetClient)
{
if (!_network_server) {
IConsoleError("This variable only makes sense for a network server.");
return false;
}
return true;
}
DEF_CONSOLE_CMD_HOOK(ConCmdHookNoNetClient)
{
if (!_networking || !_network_server) {
IConsoleError("This command is only available for a network server.");
return false;
}
return true;
}
DEF_CONSOLE_CMD_HOOK(ConCmdHookNoNetServer)
{
if (!_networking || _network_server) {
IConsoleError("You can not use this command for you are a network-server.");
return false;
}
return true;
}
DEF_CONSOLE_CMD_HOOK(ConCmdHookNeedNetwork)
{
if (!_networking) {
IConsoleError("Not connected. Multiplayer only command.");
return false;
}
return true;
}
#endif /* ENABLE_NETWORK */
/* **************************** */
/* reset commands */
/* **************************** */
DEF_CONSOLE_CMD(ConResetEngines)
{
StartupEngines();
return 0;
}
#ifdef _DEBUG
DEF_CONSOLE_CMD(ConResetTile)
{
if (argc == 2) {
TileIndex tile = (TileIndex)GetArgumentInteger(argv[1]);
DoClearSquare(tile);
}
return 0;
}
#endif
DEF_CONSOLE_CMD(ConScrollToTile)
{
if (argc == 2) {
TileIndex tile = (TileIndex)GetArgumentInteger(argv[1]);
ScrollMainWindowToTile(tile);
}
return 0;
}
// ********************************* //
// * Network Core Console Commands * //
// ********************************* //
#ifdef ENABLE_NETWORK
DEF_CONSOLE_CMD(ConStatus)
{
const char *status;
int lag;
const ClientState *cs;
const NetworkClientInfo *ci;
FOR_ALL_CLIENTS(cs) {
lag = NetworkCalculateLag(cs);
ci = DEREF_CLIENT_INFO(cs);
switch (cs->status) {
case STATUS_INACTIVE:
status = "inactive";
break;
case STATUS_AUTH:
status = "authorized";
break;
case STATUS_MAP:
status = "loading map";
break;
case STATUS_DONE_MAP:
status = "done map";
break;
case STATUS_PRE_ACTIVE:
status = "ready";
break;
case STATUS_ACTIVE:
status = "active";
break;
default:
status = "unknown";
break;
}
IConsolePrintF(8, "Client #%d/%s status: %s frame-lag: %d play-as: %d",
cs->index, ci->client_name, status, lag, ci->client_playas);
}
return NULL;
}
DEF_CONSOLE_CMD(ConKick)
{
NetworkClientInfo *ci;
if (argc == 2) {
uint32 index = atoi(argv[1]);
if (index == NETWORK_SERVER_INDEX) {
IConsolePrint(_iconsole_color_default, "Silly boy, you can not kick yourself!");
return NULL;
}
if (index == 0) {
IConsoleError("Invalid Client-ID");
return NULL;
}
ci = NetworkFindClientInfoFromIndex(index);
if (ci != NULL) {
SEND_COMMAND(PACKET_SERVER_ERROR)(NetworkFindClientStateFromIndex(index), NETWORK_ERROR_KICKED);
return NULL;
} else {
IConsoleError("Client-ID not found");
return NULL;
}
}
IConsolePrint(_iconsole_color_default, "Unknown usage. Usage: kick <client-id>. For client-ids, see 'clients'.");
return NULL;
}
DEF_CONSOLE_CMD(ConNetworkClients)
{
NetworkClientInfo *ci;
for (ci = _network_client_info; ci != &_network_client_info[MAX_CLIENT_INFO]; ci++) {
if (ci->client_index != NETWORK_EMPTY_INDEX) {
IConsolePrintF(8,"Client #%d name: %s play-as: %d", ci->client_index, ci->client_name, ci->client_playas);
}
}
return NULL;
}
DEF_CONSOLE_CMD(ConNetworkConnect)
{
char* ip;
const byte *port = NULL;
const byte *player = NULL;
uint16 rport;
if (argc<2) return NULL;
if (_networking) {
// We are in network-mode, first close it!
NetworkDisconnect();
}
ip = argv[1];
rport = NETWORK_DEFAULT_PORT;
ParseConnectionString(&player, &port, ip);
IConsolePrintF(_iconsole_color_default, "Connecting to %s...", ip);
if (player != NULL) {
_network_playas = atoi(player);
IConsolePrintF(_iconsole_color_default, " player-no: %s", player);
}
if (port != NULL) {
rport = atoi(port);
IConsolePrintF(_iconsole_color_default, " port: %s", port);
}
NetworkClientConnectGame(ip, rport);
return NULL;
}
#endif /* ENABLE_NETWORK */
/* ******************************** */
/* script file console commands */
/* ******************************** */
DEF_CONSOLE_CMD(ConExec)
{
char cmd[1024];
bool doerror;
if (argc<2) return NULL;
doerror = true;
_script_file = fopen(argv[1], "r");
if (_script_file == NULL) {
if (argc>2) if (atoi(argv[2])==0) doerror=false;
if (doerror) IConsoleError("script file not found");
return NULL;
}
_script_running = true;
fgets(cmd, sizeof(cmd), _script_file);
while (!feof(_script_file) && _script_running) {
strtok(cmd, "\r\n");
IConsoleCmdExec(cmd);
fgets(cmd, sizeof(cmd), _script_file);
}
_script_running = false;
fclose(_script_file);
return NULL;
}
DEF_CONSOLE_CMD(ConReturn)
{
_script_running = false;
return NULL;
}
/* **************************** */
/* default console commands */
/* **************************** */
DEF_CONSOLE_CMD(ConScript)
{
extern FILE* _iconsole_output_file;
if (_iconsole_output_file != NULL) {
IConsolePrintF(_iconsole_color_default, "file output complete");
fclose(_iconsole_output_file);
} else {
if (argc < 2) return NULL;
IConsolePrintF(_iconsole_color_default, "file output started to: %s",
argv[1]);
_iconsole_output_file = fopen(argv[1], "ab");
if (_iconsole_output_file == NULL) IConsoleError("could not open file");
}
return NULL;
}
DEF_CONSOLE_CMD(ConEcho)
{
if (argc < 2) return NULL;
IConsolePrint(_iconsole_color_default, argv[1]);
return NULL;
}
DEF_CONSOLE_CMD(ConEchoC)
{
if (argc < 3) return NULL;
IConsolePrint(atoi(argv[1]), argv[2]);
return NULL;
}
extern void SwitchMode(int new_mode);
DEF_CONSOLE_CMD(ConNewGame)
{
_docommand_recursive = 0;
_random_seeds[0][0] = Random();
_random_seeds[0][1] = InteractiveRandom();
SwitchMode(SM_NEWGAME);
return NULL;
}
DEF_CONSOLE_CMD(ConPrintF)
{
if (argc < 3) return NULL;
IConsolePrintF(_iconsole_color_default, argv[1] , argv[2], argv[3], argv[4], argv[5], argv[6], argv[7], argv[8], argv[9], argv[10], argv[11], argv[12], argv[13], argv[14], argv[15], argv[16], argv[17], argv[18], argv[19]); /* XXX ugh... */
return NULL;
}
DEF_CONSOLE_CMD(ConPrintFC)
{
if (argc < 3) return NULL;
IConsolePrintF(atoi(argv[1]), argv[2] , argv[3], argv[4], argv[5], argv[6], argv[7], argv[8], argv[9], argv[10], argv[11], argv[12], argv[13], argv[14], argv[15], argv[16], argv[17], argv[18], argv[19]); /* XXX ugh... */
return NULL;
}
DEF_CONSOLE_CMD(ConScreenShot)
{
if (argc < 2) {
_make_screenshot = 1;
} else {
if (strcmp(argv[1], "big") == 0)
_make_screenshot=2;
if (strcmp(argv[1], "no_con") == 0) {
IConsoleClose();
_make_screenshot = 1;
}
}
return NULL;
}
DEF_CONSOLE_CMD(ConInfoVar)
{
if (argc < 2) return NULL;
if (argt[1] != ICONSOLE_VAR_REFERENCE) {
IConsoleError("first argument has to be a variable reference");
} else {
_iconsole_var* item;
item = (_iconsole_var*)argv[1];
IConsolePrintF(_iconsole_color_default, "var_name: %s", item->name);
IConsolePrintF(_iconsole_color_default, "var_type: %i", item->type);
IConsolePrintF(_iconsole_color_default, "var_addr: %i", item->data.addr);
if (item->_malloc)
IConsolePrintF(_iconsole_color_default, "var_malloc: internal");
else
IConsolePrintF(_iconsole_color_default, "var_malloc: external");
if (item->hook_access) IConsoleWarning("var_access hooked");
if (item->hook_before_change) IConsoleWarning("var_before_change hooked");
if (item->hook_after_change) IConsoleWarning("var_after_change hooked");
}
return NULL;
}
DEF_CONSOLE_CMD(ConInfoCmd)
{
if (argc < 2) return NULL;
if (argt[1] != ICONSOLE_VAR_UNKNOWN) {
IConsoleError("first argument has to be a command name");
} else {
_iconsole_cmd* item;
item = IConsoleCmdGet(argv[1]);
if (item == NULL) {
IConsoleError("the given command was not found");
return NULL;
}
IConsolePrintF(_iconsole_color_default, "cmd_name: %s", item->name);
IConsolePrintF(_iconsole_color_default, "cmd_addr: %i", item->addr);
if (item->hook_access) IConsoleWarning("cmd_access hooked");
if (item->hook_before_exec) IConsoleWarning("cmd_before_exec hooked");
if (item->hook_after_exec) IConsoleWarning("cmd_after_exec hooked");
}
return NULL;
}
DEF_CONSOLE_CMD(ConDebugLevel)
{
if (argc < 2) return NULL;
SetDebugString(argv[1]);
return NULL;
}
DEF_CONSOLE_CMD(ConExit)
{
_exit_game = true;
return NULL;
}
DEF_CONSOLE_CMD(ConHelp)
{
IConsolePrint(13, " -- console help -- ");
IConsolePrint( 1, " variables: [command to list them: list_vars]");
IConsolePrint( 1, " temp_string = \"my little \"");
IConsolePrint( 1, "");
IConsolePrint( 1, " commands: [command to list them: list_cmds]");
IConsolePrint( 1, " [command] [\"string argument with spaces\"] [argument 2] ...");
IConsolePrint( 1, " printf \"%s world\" temp_string");
IConsolePrint( 1, "");
IConsolePrint( 1, " command/variable returning a value into an variable:");
IConsolePrint( 1, " temp_uint16 << random");
IConsolePrint( 1, " temp_uint16 << temp_uint16_2");
IConsolePrint( 1, "");
return NULL;
}
DEF_CONSOLE_CMD(ConRandom)
{
_iconsole_var* result;
result = IConsoleVarAlloc(ICONSOLE_VAR_UINT16);
IConsoleVarSetValue(result, rand());
return result;
}
DEF_CONSOLE_CMD(ConListCommands)
{
const _iconsole_cmd* item;
size_t l = 0;
if (argv[1] != NULL) l = strlen(argv[1]);
for (item = _iconsole_cmds; item != NULL; item = item->_next)
if (argv[1] == NULL || strncmp(item->name, argv[1], l) == 0)
IConsolePrintF(_iconsole_color_default, "%s", item->name);
return NULL;
}
DEF_CONSOLE_CMD(ConListVariables)
{
const _iconsole_var* item;
size_t l = 0;
if (argv[1] != NULL) l = strlen(argv[1]);
for (item = _iconsole_vars; item != NULL; item = item->_next)
if (argv[1] == NULL || strncmp(item->name, argv[1], l) == 0)
IConsolePrintF(_iconsole_color_default, "%s", item->name);
return NULL;
}
DEF_CONSOLE_CMD(ConListDumpVariables)
{
const _iconsole_var* item;
size_t l = 0;
if (argv[1] != NULL) l = strlen(argv[1]);
for (item = _iconsole_vars; item != NULL; item = item->_next)
if (argv[1] == NULL || strncmp(item->name, argv[1], l) == 0)
IConsoleVarDump(item, NULL);
return NULL;
}
#ifdef ENABLE_NETWORK
DEF_CONSOLE_CMD(ConSay)
{
if (argc == 2) {
if (!_network_server)
SEND_COMMAND(PACKET_CLIENT_CHAT)(NETWORK_ACTION_CHAT, DESTTYPE_BROADCAST, 0 /* param does not matter */, argv[1]);
else
NetworkServer_HandleChat(NETWORK_ACTION_CHAT, DESTTYPE_BROADCAST, 0, argv[1], NETWORK_SERVER_INDEX);
} else
IConsolePrint(_iconsole_color_default, "Unknown usage. Usage: say \"<msg>\"");
return NULL;
}
DEF_CONSOLE_CMD(ConSayPlayer)
{
if (argc == 3) {
if (atoi(argv[1]) < 1 || atoi(argv[1]) > MAX_PLAYERS) {
IConsolePrintF(_iconsole_color_default, "Unknown player. Player range is between 1 and %d.", MAX_PLAYERS);
return NULL;
}
if (!_network_server)
SEND_COMMAND(PACKET_CLIENT_CHAT)(NETWORK_ACTION_CHAT_PLAYER, DESTTYPE_PLAYER, atoi(argv[1]), argv[2]);
else
NetworkServer_HandleChat(NETWORK_ACTION_CHAT_PLAYER, DESTTYPE_PLAYER, atoi(argv[1]), argv[2], NETWORK_SERVER_INDEX);
} else
IConsolePrint(_iconsole_color_default, "Unknown usage. Usage: say_player <playerno> \"<msg>\"");
return NULL;
}
DEF_CONSOLE_CMD(ConSayClient)
{
if (argc == 3) {
if (!_network_server)
SEND_COMMAND(PACKET_CLIENT_CHAT)(NETWORK_ACTION_CHAT_CLIENT, DESTTYPE_CLIENT, atoi(argv[1]), argv[2]);
else
NetworkServer_HandleChat(NETWORK_ACTION_CHAT_CLIENT, DESTTYPE_CLIENT, atoi(argv[1]), argv[2], NETWORK_SERVER_INDEX);
} else
IConsolePrint(_iconsole_color_default, "Unknown usage. Usage: say_client <clientno> \"<msg>\"");
return NULL;
}
DEF_CONSOLE_CMD(ConSetServerName) {
if (argc == 2) {
strncpy(_network_server_name, argv[1], 40);
IConsolePrintF(_iconsole_color_default, "Server-name changed to '%s'", _network_server_name);
ttd_strlcpy(_network_game_info.server_name, _network_server_name, 40);
} else if (argc == 1) {
IConsolePrintF(_iconsole_color_default, "Current server-name is '%s'", _network_server_name);
IConsolePrint(_iconsole_color_default, " Usage: setservername \"<GameName>\".");
} else {
IConsolePrint(_iconsole_color_default, "Unknow usage. Usage: setservername \"<ServerName>\".");
}
return NULL;
}
DEF_CONSOLE_CMD(ConClientName) {
NetworkClientInfo *ci;
ci = NetworkFindClientInfoFromIndex(_network_own_client_index);
if (argc == 2 && ci != NULL) {
if (!_network_server)
SEND_COMMAND(PACKET_CLIENT_SET_NAME)(argv[1]);
else {
if (NetworkFindName(argv[1])) {
NetworkTextMessage(NETWORK_ACTION_NAME_CHANGE, 1, ci->client_name, argv[1]);
ttd_strlcpy(ci->client_name, argv[1], 40);
NetworkUpdateClientInfo(NETWORK_SERVER_INDEX);
}
}
} else {
IConsolePrint(_iconsole_color_default, "With 'name' you can change your network-player name.");
IConsolePrint(_iconsole_color_default, " Usage: name \"<name>\".");
}
return NULL;
}
DEF_CONSOLE_CMD(ConProtect) {
// Protect a company with a password
if (_local_player >= MAX_PLAYERS) {
IConsolePrintF(_iconsole_color_default, "You have to own a company to make use of this command.");
return NULL;
}
if (argc == 2) {
if (strncmp(argv[1], "*", 20) == 0) {
_network_player_info[_local_player].password[0] = '\0';
} else {
strncpy(_network_player_info[_local_player].password, argv[1], 20);
}
if (!_network_server)
SEND_COMMAND(PACKET_CLIENT_SET_PASSWORD)(_network_player_info[_local_player].password);
IConsolePrintF(_iconsole_color_default, "Company protected with '%s'", _network_player_info[_local_player].password);
} else {
IConsolePrint(_iconsole_color_default, "Protect sets a password on the company, so no-one without the correct password can join.");
IConsolePrint(_iconsole_color_default, " Usage: protect \"<password>\". Use * as <password> to set no password.");
}
return NULL;
}
DEF_CONSOLE_CMD(ConSetPassword) {
if (argc == 2) {
// Change server password
if (strncmp(argv[1], "*", 20) == 0) {
_network_game_info.server_password[0] = '\0';
_network_game_info.use_password = 0;
} else {
strncpy(_network_game_info.server_password, argv[1], 20);
_network_game_info.use_password = 1;
}
IConsolePrintF(_iconsole_color_default, "Game-password changed to '%s'", _network_game_info.server_password);
} else if (argc == 1) {
IConsolePrintF(_iconsole_color_default, "Current game-password is set to '%s'", _network_game_info.server_password);
IConsolePrint(_iconsole_color_default, " Usage: setpassword \"<password>\". Use * as <password> to set no password.");
} else {
IConsolePrint(_iconsole_color_default, "Unknow usage. Usage: setpassword \"<password>\". Use * as <password> to set no password.");
}
return 0;
}
#endif /* ENABLE_NETWORK */
#ifdef _DEBUG
/* ****************************************** */
/* debug commands and variables */
/* ****************************************** */
void IConsoleDebugLibRegister()
{
// stdlib
extern bool _stdlib_con_developer; /* XXX extern in .c */
IConsoleVarRegister("con_developer", &_stdlib_con_developer, ICONSOLE_VAR_BOOLEAN);
IConsoleVarMemRegister("temp_bool", ICONSOLE_VAR_BOOLEAN);
IConsoleVarMemRegister("temp_int16", ICONSOLE_VAR_INT16);
IConsoleVarMemRegister("temp_int32", ICONSOLE_VAR_INT32);
IConsoleVarMemRegister("temp_pointer", ICONSOLE_VAR_POINTER);
IConsoleVarMemRegister("temp_uint16", ICONSOLE_VAR_UINT16);
IConsoleVarMemRegister("temp_uint16_2", ICONSOLE_VAR_UINT16);
IConsoleVarMemRegister("temp_uint32", ICONSOLE_VAR_UINT32);
IConsoleVarMemRegister("temp_string", ICONSOLE_VAR_STRING);
IConsoleVarMemRegister("temp_string2", ICONSOLE_VAR_STRING);
IConsoleCmdRegister("resettile", ConResetTile);
}
#endif
/* ****************************************** */
/* console command and variable registration */
/* ****************************************** */
void IConsoleStdLibRegister(void)
{
// stdlib
extern byte _stdlib_developer; /* XXX extern in .c */
#ifdef _DEBUG
IConsoleDebugLibRegister();
#endif
// functions [please add them alphabetically]
#ifdef ENABLE_NETWORK
IConsoleCmdRegister("connect", ConNetworkConnect);
IConsoleCmdHook("connect", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetServer);
IConsoleCmdRegister("clients", ConNetworkClients);
#endif /* ENABLE_NETWORK */
IConsoleCmdRegister("debug_level", ConDebugLevel);
IConsoleCmdRegister("dump_vars", ConListDumpVariables);
IConsoleCmdRegister("echo", ConEcho);
IConsoleCmdRegister("echoc", ConEchoC);
IConsoleCmdRegister("exec", ConExec);
IConsoleCmdRegister("exit", ConExit);
IConsoleCmdRegister("help", ConHelp);
IConsoleCmdRegister("info_cmd", ConInfoCmd);
IConsoleCmdRegister("info_var", ConInfoVar);
IConsoleCmdRegister("list_cmds", ConListCommands);
IConsoleCmdRegister("list_vars", ConListVariables);
#ifdef ENABLE_NETWORK
IConsoleCmdRegister("kick", ConKick);
IConsoleCmdHook("kick", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetClient);
IConsoleCmdRegister("protect", ConProtect);
IConsoleCmdRegister("name", ConClientName);
#endif
IConsoleCmdRegister("newgame", ConNewGame);
IConsoleCmdRegister("printf", ConPrintF);
IConsoleCmdRegister("printfc", ConPrintFC);
IConsoleCmdRegister("quit", ConExit);
IConsoleCmdRegister("random", ConRandom);
IConsoleCmdRegister("resetengines", ConResetEngines);
#ifdef ENABLE_NETWORK
IConsoleCmdHook("resetengines", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetwork);
#endif /* ENABLE_NETWORK */
IConsoleCmdRegister("return", ConReturn);
#ifdef ENABLE_NETWORK
IConsoleCmdRegister("say", ConSay);
IConsoleCmdHook("say", ICONSOLE_HOOK_ACCESS, ConCmdHookNeedNetwork);
IConsoleCmdRegister("say_player", ConSayPlayer);
IConsoleCmdHook("say_player", ICONSOLE_HOOK_ACCESS, ConCmdHookNeedNetwork);
IConsoleCmdRegister("say_client", ConSayClient);
IConsoleCmdHook("say_client", ICONSOLE_HOOK_ACCESS, ConCmdHookNeedNetwork);
#endif /* ENABLE_NETWORK */
IConsoleCmdRegister("screenshot", ConScreenShot);
IConsoleCmdRegister("script", ConScript);
IConsoleCmdRegister("scrollto", ConScrollToTile);
#ifdef ENABLE_NETWORK
IConsoleCmdRegister("setservername", ConSetServerName);
IConsoleCmdHook("setservername", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetClient);
IConsoleCmdRegister("setpassword", ConSetPassword);
IConsoleCmdHook("setpassword", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetClient);
IConsoleCmdRegister("status", ConStatus);
IConsoleCmdHook("status", ICONSOLE_HOOK_ACCESS, ConCmdHookNoNetClient);
#endif /* ENABLE_NETWORK */
// variables [please add them alphabeticaly]
IConsoleVarRegister("developer", &_stdlib_developer, ICONSOLE_VAR_BYTE);
#ifdef ENABLE_NETWORK
IConsoleVarRegister("net_frame_freq", &_network_frame_freq, ICONSOLE_VAR_UINT8);
IConsoleVarHook("*net_frame_freq", ICONSOLE_HOOK_ACCESS, ConVarHookNoNetClient);
IConsoleVarRegister("net_sync_freq", &_network_sync_freq, ICONSOLE_VAR_UINT16);
IConsoleVarHook("*net_sync_freq", ICONSOLE_HOOK_ACCESS, ConVarHookNoNetClient);
#endif /* ENABLE_NETWORK */
}
/* -------------------- don't cross this line --------------------- */