OpenTTD
console.cpp
Go to the documentation of this file.
1 /* $Id: console.cpp 26509 2014-04-25 15:40:32Z rubidium $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "console_internal.h"
14 #include "network/network.h"
15 #include "network/network_func.h"
16 #include "network/network_admin.h"
17 #include "debug.h"
18 #include "console_func.h"
19 #include "settings_type.h"
20 
21 #include <stdarg.h>
22 
23 #include "safeguards.h"
24 
25 static const uint ICON_TOKEN_COUNT = 20;
26 
27 /* console parser */
30 
31 FILE *_iconsole_output_file;
32 
33 void IConsoleInit()
34 {
35  _iconsole_output_file = NULL;
36 #ifdef ENABLE_NETWORK /* Initialize network only variables */
39 #endif
40 
41  IConsoleGUIInit();
42 
43  IConsoleStdLibRegister();
44 }
45 
46 static void IConsoleWriteToLogFile(const char *string)
47 {
48  if (_iconsole_output_file != NULL) {
49  /* if there is an console output file ... also print it there */
50  const char *header = GetLogPrefix();
51  if ((strlen(header) != 0 && fwrite(header, strlen(header), 1, _iconsole_output_file) != 1) ||
52  fwrite(string, strlen(string), 1, _iconsole_output_file) != 1 ||
53  fwrite("\n", 1, 1, _iconsole_output_file) != 1) {
54  fclose(_iconsole_output_file);
55  _iconsole_output_file = NULL;
56  IConsolePrintF(CC_DEFAULT, "cannot write to log file");
57  }
58  }
59 }
60 
61 bool CloseConsoleLogIfActive()
62 {
63  if (_iconsole_output_file != NULL) {
64  IConsolePrintF(CC_DEFAULT, "file output complete");
65  fclose(_iconsole_output_file);
66  _iconsole_output_file = NULL;
67  return true;
68  }
69 
70  return false;
71 }
72 
73 void IConsoleFree()
74 {
75  IConsoleGUIFree();
76  CloseConsoleLogIfActive();
77 }
78 
88 void IConsolePrint(TextColour colour_code, const char *string)
89 {
90  assert(IsValidConsoleColour(colour_code));
91 
92  char *str;
93 #ifdef ENABLE_NETWORK
95  /* Redirect the string to the client */
97  return;
98  }
99 
102  return;
103  }
104 #endif
105 
106  /* Create a copy of the string, strip if of colours and invalid
107  * characters and (when applicable) assign it to the console buffer */
108  str = stredup(string);
109  str_strip_colours(str);
110  str_validate(str, str + strlen(str));
111 
112  if (_network_dedicated) {
113 #ifdef ENABLE_NETWORK
114  NetworkAdminConsole("console", str);
115 #endif /* ENABLE_NETWORK */
116  fprintf(stdout, "%s%s\n", GetLogPrefix(), str);
117  fflush(stdout);
118  IConsoleWriteToLogFile(str);
119  free(str); // free duplicated string since it's not used anymore
120  return;
121  }
122 
123  IConsoleWriteToLogFile(str);
124  IConsoleGUIPrint(colour_code, str);
125 }
126 
132 void CDECL IConsolePrintF(TextColour colour_code, const char *format, ...)
133 {
134  assert(IsValidConsoleColour(colour_code));
135 
136  va_list va;
137  char buf[ICON_MAX_STREAMSIZE];
138 
139  va_start(va, format);
140  vseprintf(buf, lastof(buf), format, va);
141  va_end(va);
142 
143  IConsolePrint(colour_code, buf);
144 }
145 
154 void IConsoleDebug(const char *dbg, const char *string)
155 {
156  if (_settings_client.gui.developer <= 1) return;
157  IConsolePrintF(CC_DEBUG, "dbg: [%s] %s", dbg, string);
158 }
159 
165 void IConsoleWarning(const char *string)
166 {
167  if (_settings_client.gui.developer == 0) return;
168  IConsolePrintF(CC_WARNING, "WARNING: %s", string);
169 }
170 
175 void IConsoleError(const char *string)
176 {
177  IConsolePrintF(CC_ERROR, "ERROR: %s", string);
178 }
179 
187 bool GetArgumentInteger(uint32 *value, const char *arg)
188 {
189  char *endptr;
190 
191  if (strcmp(arg, "on") == 0 || strcmp(arg, "true") == 0) {
192  *value = 1;
193  return true;
194  }
195  if (strcmp(arg, "off") == 0 || strcmp(arg, "false") == 0) {
196  *value = 0;
197  return true;
198  }
199 
200  *value = strtoul(arg, &endptr, 0);
201  return arg != endptr;
202 }
203 
209 template<class T>
210 void IConsoleAddSorted(T **base, T *item_new)
211 {
212  if (*base == NULL) {
213  *base = item_new;
214  return;
215  }
216 
217  T *item_before = NULL;
218  T *item = *base;
219  /* The list is alphabetically sorted, insert the new item at the correct location */
220  while (item != NULL) {
221  if (strcmp(item->name, item_new->name) > 0) break; // insert here
222 
223  item_before = item;
224  item = item->next;
225  }
226 
227  if (item_before == NULL) {
228  *base = item_new;
229  } else {
230  item_before->next = item_new;
231  }
232 
233  item_new->next = item;
234 }
235 
242 {
243  char *q = name;
244  for (const char *p = name; *p != '\0'; p++) {
245  if (*p != '_') *q++ = *p;
246  }
247  *q = '\0';
248  return name;
249 }
250 
256 void IConsoleCmdRegister(const char *name, IConsoleCmdProc *proc, IConsoleHook *hook)
257 {
258  IConsoleCmd *item_new = MallocT<IConsoleCmd>(1);
259  item_new->name = RemoveUnderscores(stredup(name));
260  item_new->next = NULL;
261  item_new->proc = proc;
262  item_new->hook = hook;
263 
264  IConsoleAddSorted(&_iconsole_cmds, item_new);
265 }
266 
273 {
274  IConsoleCmd *item;
275 
276  for (item = _iconsole_cmds; item != NULL; item = item->next) {
277  if (strcmp(item->name, name) == 0) return item;
278  }
279  return NULL;
280 }
281 
287 void IConsoleAliasRegister(const char *name, const char *cmd)
288 {
289  if (IConsoleAliasGet(name) != NULL) {
290  IConsoleError("an alias with this name already exists; insertion aborted");
291  return;
292  }
293 
294  char *new_alias = RemoveUnderscores(stredup(name));
295  char *cmd_aliased = stredup(cmd);
296  IConsoleAlias *item_new = MallocT<IConsoleAlias>(1);
297 
298  item_new->next = NULL;
299  item_new->cmdline = cmd_aliased;
300  item_new->name = new_alias;
301 
302  IConsoleAddSorted(&_iconsole_aliases, item_new);
303 }
304 
311 {
312  IConsoleAlias *item;
313 
314  for (item = _iconsole_aliases; item != NULL; item = item->next) {
315  if (strcmp(item->name, name) == 0) return item;
316  }
317 
318  return NULL;
319 }
327 static void IConsoleAliasExec(const IConsoleAlias *alias, byte tokencount, char *tokens[ICON_TOKEN_COUNT])
328 {
329  char alias_buffer[ICON_MAX_STREAMSIZE] = { '\0' };
330  char *alias_stream = alias_buffer;
331 
332  DEBUG(console, 6, "Requested command is an alias; parsing...");
333 
334  for (const char *cmdptr = alias->cmdline; *cmdptr != '\0'; cmdptr++) {
335  switch (*cmdptr) {
336  case '\'': // ' will double for ""
337  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
338  break;
339 
340  case ';': // Cmd separator; execute previous and start new command
341  IConsoleCmdExec(alias_buffer);
342 
343  alias_stream = alias_buffer;
344  *alias_stream = '\0'; // Make sure the new command is terminated.
345 
346  cmdptr++;
347  break;
348 
349  case '%': // Some or all parameters
350  cmdptr++;
351  switch (*cmdptr) {
352  case '+': { // All parameters separated: "[param 1]" "[param 2]"
353  for (uint i = 0; i != tokencount; i++) {
354  if (i != 0) alias_stream = strecpy(alias_stream, " ", lastof(alias_buffer));
355  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
356  alias_stream = strecpy(alias_stream, tokens[i], lastof(alias_buffer));
357  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
358  }
359  break;
360  }
361 
362  case '!': { // Merge the parameters to one: "[param 1] [param 2] [param 3...]"
363  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
364  for (uint i = 0; i != tokencount; i++) {
365  if (i != 0) alias_stream = strecpy(alias_stream, " ", lastof(alias_buffer));
366  alias_stream = strecpy(alias_stream, tokens[i], lastof(alias_buffer));
367  }
368  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
369  break;
370  }
371 
372  default: { // One specific parameter: %A = [param 1] %B = [param 2] ...
373  int param = *cmdptr - 'A';
374 
375  if (param < 0 || param >= tokencount) {
376  IConsoleError("too many or wrong amount of parameters passed to alias, aborting");
377  IConsolePrintF(CC_WARNING, "Usage of alias '%s': %s", alias->name, alias->cmdline);
378  return;
379  }
380 
381  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
382  alias_stream = strecpy(alias_stream, tokens[param], lastof(alias_buffer));
383  alias_stream = strecpy(alias_stream, "\"", lastof(alias_buffer));
384  break;
385  }
386  }
387  break;
388 
389  default:
390  *alias_stream++ = *cmdptr;
391  *alias_stream = '\0';
392  break;
393  }
394 
395  if (alias_stream >= lastof(alias_buffer) - 1) {
396  IConsoleError("Requested alias execution would overflow execution buffer");
397  return;
398  }
399  }
400 
401  IConsoleCmdExec(alias_buffer);
402 }
403 
409 void IConsoleCmdExec(const char *cmdstr)
410 {
411  const char *cmdptr;
412  char *tokens[ICON_TOKEN_COUNT], tokenstream[ICON_MAX_STREAMSIZE];
413  uint t_index, tstream_i;
414 
415  bool longtoken = false;
416  bool foundtoken = false;
417 
418  if (cmdstr[0] == '#') return; // comments
419 
420  for (cmdptr = cmdstr; *cmdptr != '\0'; cmdptr++) {
421  if (!IsValidChar(*cmdptr, CS_ALPHANUMERAL)) {
422  IConsoleError("command contains malformed characters, aborting");
423  IConsolePrintF(CC_ERROR, "ERROR: command was: '%s'", cmdstr);
424  return;
425  }
426  }
427 
428  DEBUG(console, 4, "Executing cmdline: '%s'", cmdstr);
429 
430  memset(&tokens, 0, sizeof(tokens));
431  memset(&tokenstream, 0, sizeof(tokenstream));
432 
433  /* 1. Split up commandline into tokens, separated by spaces, commands
434  * enclosed in "" are taken as one token. We can only go as far as the amount
435  * of characters in our stream or the max amount of tokens we can handle */
436  for (cmdptr = cmdstr, t_index = 0, tstream_i = 0; *cmdptr != '\0'; cmdptr++) {
437  if (t_index >= lengthof(tokens) || tstream_i >= lengthof(tokenstream)) break;
438 
439  switch (*cmdptr) {
440  case ' ': // Token separator
441  if (!foundtoken) break;
442 
443  if (longtoken) {
444  tokenstream[tstream_i] = *cmdptr;
445  } else {
446  tokenstream[tstream_i] = '\0';
447  foundtoken = false;
448  }
449 
450  tstream_i++;
451  break;
452  case '"': // Tokens enclosed in "" are one token
453  longtoken = !longtoken;
454  if (!foundtoken) {
455  tokens[t_index++] = &tokenstream[tstream_i];
456  foundtoken = true;
457  }
458  break;
459  case '\\': // Escape character for ""
460  if (cmdptr[1] == '"' && tstream_i + 1 < lengthof(tokenstream)) {
461  tokenstream[tstream_i++] = *++cmdptr;
462  break;
463  }
464  /* FALL THROUGH */
465  default: // Normal character
466  tokenstream[tstream_i++] = *cmdptr;
467 
468  if (!foundtoken) {
469  tokens[t_index++] = &tokenstream[tstream_i - 1];
470  foundtoken = true;
471  }
472  break;
473  }
474  }
475 
476  for (uint i = 0; tokens[i] != NULL; i++) {
477  DEBUG(console, 8, "Token %d is: '%s'", i, tokens[i]);
478  }
479 
480  if (StrEmpty(tokens[0])) return; // don't execute empty commands
481  /* 2. Determine type of command (cmd or alias) and execute
482  * First try commands, then aliases. Execute
483  * the found action taking into account its hooking code
484  */
485  RemoveUnderscores(tokens[0]);
486  IConsoleCmd *cmd = IConsoleCmdGet(tokens[0]);
487  if (cmd != NULL) {
488  ConsoleHookResult chr = (cmd->hook == NULL ? CHR_ALLOW : cmd->hook(true));
489  switch (chr) {
490  case CHR_ALLOW:
491  if (!cmd->proc(t_index, tokens)) { // index started with 0
492  cmd->proc(0, NULL); // if command failed, give help
493  }
494  return;
495 
496  case CHR_DISALLOW: return;
497  case CHR_HIDE: break;
498  }
499  }
500 
501  t_index--;
502  IConsoleAlias *alias = IConsoleAliasGet(tokens[0]);
503  if (alias != NULL) {
504  IConsoleAliasExec(alias, t_index, &tokens[1]);
505  return;
506  }
507 
508  IConsoleError("command not found");
509 }