// =========================================================
-// Generic program common command code, reworked by Samual
-// Last updated: December 28th, 2011
+// Generic program common command code, written by Samual
+// Last updated: February 19th, 2012
// =========================================================
-#define NUM_MARKUPS 41
-float markup_init;
-string markup_from[NUM_MARKUPS];
-string markup_to[NUM_MARKUPS];
-void GameCommand_MarkupInit()
+// used by generic commands for better help/usage information
+string GetProgramCommandPrefix(void)
{
- float i;
- if (markup_init)
- return;
- markup_init = 1;
- i = 0;
- markup_from[i] = "&alien"; markup_to[i] = "\x12"; ++i;
- markup_from[i] = "&:-)"; markup_to[i] = "\x13"; ++i;
- markup_from[i] = "&:-("; markup_to[i] = "\x14"; ++i;
- markup_from[i] = "&x-P"; markup_to[i] = "\x15"; ++i;
- markup_from[i] = "&:-/"; markup_to[i] = "\x16"; ++i;
- markup_from[i] = "&:-D"; markup_to[i] = "\x17"; ++i;
- markup_from[i] = "&<<"; markup_to[i] = "\x18"; ++i;
- markup_from[i] = "&>>"; markup_to[i] = "\x19"; ++i;
- markup_from[i] = "&dot"; markup_to[i] = "\x1a"; ++i;
- markup_from[i] = "&^_"; markup_to[i] = "\x1b"; ++i;
- markup_from[i] = "&ysplat"; markup_to[i] = "\x1c"; ++i;
- markup_from[i] = "&-]"; markup_to[i] = "\x1d"; ++i;
- markup_from[i] = "&--"; markup_to[i] = "\x1e"; ++i;
- markup_from[i] = "&[-"; markup_to[i] = "\x1f"; ++i;
- markup_from[i] = "&s<"; markup_to[i] = "\x2c"; ++i;
- markup_from[i] = "&s>"; markup_to[i] = "\x2e"; ++i;
- markup_from[i] = "&<-"; markup_to[i] = "\x7f"; ++i;
- markup_from[i] = "&[="; markup_to[i] = "\x80"; ++i;
- markup_from[i] = "&=="; markup_to[i] = "\x81"; ++i;
- markup_from[i] = "&=]"; markup_to[i] = "\x82"; ++i;
- markup_from[i] = "&r!"; markup_to[i] = "\x84"; ++i;
- markup_from[i] = "&|o|"; markup_to[i] = "\x85"; ++i;
- markup_from[i] = "&|u|"; markup_to[i] = "\x86"; ++i;
- markup_from[i] = "&|i|"; markup_to[i] = "\x87"; ++i;
- markup_from[i] = "&|c|"; markup_to[i] = "\x88"; ++i;
- markup_from[i] = "&[c]"; markup_to[i] = "\x89"; ++i;
- markup_from[i] = "&[n]"; markup_to[i] = "\x8a"; ++i;
- markup_from[i] = "&[]"; markup_to[i] = "\x8b"; ++i;
- markup_from[i] = "&r?"; markup_to[i] = "\x8c"; ++i;
- markup_from[i] = "&|>"; markup_to[i] = "\x8d"; ++i;
- markup_from[i] = "&splat0"; markup_to[i] = "\x8e"; ++i;
- markup_from[i] = "&splat1"; markup_to[i] = "\x8f"; ++i;
- markup_from[i] = "&[["; markup_to[i] = "\x90"; ++i;
- markup_from[i] = "&]]"; markup_to[i] = "\x91"; ++i;
- markup_from[i] = "&splat2"; markup_to[i] = "\x9a"; ++i;
- markup_from[i] = "&)("; markup_to[i] = "\x9b"; ++i;
- markup_from[i] = "&splat3"; markup_to[i] = "\x9c"; ++i;
- markup_from[i] = "&(."; markup_to[i] = "\x9d"; ++i;
- markup_from[i] = "&.."; markup_to[i] = "\x9e"; ++i;
- markup_from[i] = "&.)"; markup_to[i] = "\x9f"; ++i;
- markup_from[i] = "&<|"; markup_to[i] = "\xff"; ++i;
+ #ifdef SVQC
+ return "sv_cmd";
+ #endif
+ #ifdef CSQC
+ return "cl_cmd";
+ #endif
+ #ifdef MENUQC
+ return "menu_cmd";
+ #endif
}
-string GameCommand_Markup(string s2)
+// used by curl command
+void Curl_URI_Get_Callback(float id, float status, string data)
{
- float red, ccase, i, j;
- string s, s3;
+ float i;
+ float do_exec;
+ string do_cvar;
+ i = id - URI_GET_CURL;
+ do_exec = curl_uri_get_exec[i];
+ do_cvar = curl_uri_get_cvar[i];
+ if(status != 0)
+ {
+ print(sprintf(_("error: status is %d\n"), status));
+ if(do_cvar)
+ strunzone(do_cvar);
+ return;
+ }
+ if(do_exec)
+ localcmd(data);
+ if(do_cvar)
+ {
+ cvar_set(do_cvar, data);
+ strunzone(do_cvar);
+ }
+ if(!do_exec && !do_cvar)
+ print(data);
+}
- GameCommand_MarkupInit();
- s = "";
+// =======================
+// Command Sub-Functions
+// =======================
- red = 0;
- ccase = 0;
- for(i = 0; i < strlen(s2); ++i)
+void GenericCommand_addtolist(float request, float argc)
+{
+ switch(request)
{
- for(j = 0; j < NUM_MARKUPS; ++j)
+ case CMD_REQUEST_COMMAND:
{
- s3 = substring(s2, i, strlen(markup_from[j]));
- if (s3 == markup_from[j])
+ float i;
+
+ if(argc >= 2)
{
- s = strcat(s, markup_to[j]);
- i += strlen(markup_from[j]) - 1;
- break;
+ string original_cvar = argv(1);
+ string tmp_string = argv(2);
+
+ if(cvar_string(original_cvar) == "") // cvar was empty
+ {
+ cvar_set(original_cvar, tmp_string);
+ }
+ else // add it to the end of the list if the list doesn't already have it
+ {
+ argc = tokenizebyseparator(cvar_string(original_cvar), " ");
+
+ for(i = 0; i < argc; ++i)
+ if(argv(i) == tmp_string)
+ return; // already in list
+
+ cvar_set(original_cvar, strcat(tmp_string, " ", cvar_string(original_cvar)));
+ }
+ return;
}
}
+
+ default:
+ print("Incorrect parameters for ^2addtolist^7\n");
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " addtolist variable value"));
+ print(" Where 'variable' is what to add 'value' to.\n");
+ print("See also: ^2removefromlist^7\n");
+ return;
+ }
+ }
+}
- if(j == NUM_MARKUPS)
+void GenericCommand_curl(float request, float argc)
+{
+ switch(request)
+ {
+ case CMD_REQUEST_COMMAND:
{
- if(substring(s2, i, 2) == "&&")
+ float do_exec;
+ string do_cvar;
+ float key;
+ float i, j;
+ string url;
+ float buf;
+ float r;
+
+ do_exec = FALSE;
+ do_cvar = string_null;
+ key = -1;
+
+ for(i = 1; i+1 < argc; ++i)
{
- s = strcat(s, strconv(ccase, red, red, "&"));
- ++i;
+ if(argv(i) == "--cvar" && i+2 < argc)
+ {
+ ++i;
+ do_cvar = strzone(argv(i));
+ continue;
+ }
+ if(argv(i) == "--exec")
+ {
+ do_exec = TRUE;
+ continue;
+ }
+ if(argv(i) == "--key" && i+2 < argc)
+ {
+ ++i;
+ key = stof(argv(i));
+ continue;
+ }
+ break;
}
- else if(substring(s2, i, 2) == "&d")
+
+ // now, argv(i) is the URL
+ // following args may be POST parameters
+ url = argv(i);
+ ++i;
+ buf = buf_create();
+ j = 0;
+ for(; i+1 < argc; i += 2)
+ bufstr_set(buf, ++j, sprintf("%s=%s", uri_escape(argv(i)), uri_escape(argv(i+1))));
+ if(i < argc)
+ bufstr_set(buf, ++j, sprintf("submit=%s", uri_escape(argv(i))));
+
+ if(j == 0) // no args: GET
+ r = crypto_uri_postbuf(url, URI_GET_CURL + curl_uri_get_pos, string_null, string_null, -1, key);
+ else // with args: POST
+ r = crypto_uri_postbuf(url, URI_GET_CURL + curl_uri_get_pos, "application/x-www-form-urlencoded", "&", buf, key);
+
+ if(r)
{
- red = 2;
- ccase = 0;
- ++i;
+ curl_uri_get_exec[curl_uri_get_pos] = do_exec;
+ curl_uri_get_cvar[curl_uri_get_pos] = do_cvar;
+ curl_uri_get_pos = mod(curl_uri_get_pos + 1, URI_GET_CURL_END - URI_GET_CURL + 1);
}
- else if(substring(s2, i, 2) == "&a")
+ else
+ print(_("error creating curl handle\n"));
+
+ buf_del(buf);
+
+ return;
+ }
+
+ default:
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " curl [--key N] [--cvar] [--exec] URL [postargs...]"));
+ return;
+ }
+ }
+}
+
+void GenericCommand_dumpcommands(float request)
+{
+ switch(request)
+ {
+ case CMD_REQUEST_COMMAND:
+ {
+ float fh;
+ string filename = strcat(GetProgramCommandPrefix(), "_dump.txt");
+ fh = fopen(filename, FILE_WRITE);
+
+ if(fh >= 0)
{
- red = 2;
- ccase = 2;
- ++i;
+ #ifdef SVQC
+ CMD_Write("dump of server console commands:\n");
+ GameCommand_macro_write_aliases(fh);
+
+ CMD_Write("\ndump of networked client only commands:\n");
+ ClientCommand_macro_write_aliases(fh);
+
+ CMD_Write("\ndump of common commands:\n");
+ CommonCommand_macro_write_aliases(fh);
+
+ CMD_Write("\ndump of ban commands:\n");
+ BanCommand_macro_write_aliases(fh);
+ #endif
+
+ #ifdef CSQC
+ CMD_Write("dump of client commands:\n");
+ LocalCommand_macro_write_aliases(fh);
+ #endif
+
+ CMD_Write("\ndump of generic commands:\n");
+ GenericCommand_macro_write_aliases(fh);
+
+ print("Completed dump of aliases in ^2data/data/", GetProgramCommandPrefix(), "_dump.txt^7.\n");
+
+ fclose(fh);
}
- else if(substring(s2, i, 2) == "&n")
+ else
{
- red = 0;
- ccase = 0;
- ++i;
+ print("^1Error: ^7Could not dump to file!\n");
}
- else
- s = strcat(s, strconv(ccase, red, red, substring(s2, i, 1)));
+ return;
+ }
+
+ default:
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpcommands"));
+ print(" No arguments required.\n");
+ return;
}
}
-
- return s;
}
-void GenericCommand_addtolist(float request)
+void GenericCommand_maplist(float request, float argc)
{
switch(request)
{
case CMD_REQUEST_COMMAND:
{
- if(argc >= 2)
+ string tmp_string;
+ float i;
+
+ switch(argv(1))
{
- s = argv(1);
- s2 = argv(2);
- if(cvar_string(s) == "")
- cvar_set(s, s2);
- else
+ case "add": // appends new maps to the maplist
{
- n = tokenizebyseparator(cvar_string(s), " ");
- for(i = 0; i < n; ++i)
- if(argv(i) == s2)
- return; // already in list
- cvar_set(s, strcat(s2, " ", cvar_string(s)));
+ if(argc == 3)
+ {
+ if (!fexists(strcat("maps/", argv(2), ".bsp")))
+ {
+ print("maplist: ERROR: ", argv(2), " does not exist!\n");
+ break;
+ }
+
+ if(cvar_string("g_maplist") == "")
+ cvar_set("g_maplist", argv(2));
+ else
+ cvar_set("g_maplist", strcat(argv(2), " ", cvar_string("g_maplist")));
+
+ return;
+ }
+ break; // go to usage
+ }
+
+ case "cleanup": // scans maplist and only adds back the ones which are really usable
+ {
+ MapInfo_Enumerate();
+ MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
+ argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
+
+ tmp_string = "";
+ for(i = 0; i < argc; ++i)
+ if(MapInfo_CheckMap(argv(i)))
+ tmp_string = strcat(tmp_string, " ", argv(i));
+
+ tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
+ cvar_set("g_maplist", tmp_string);
+
+ return;
+ }
+
+ case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
+ {
+ if(argc == 3)
+ {
+ argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
+
+ tmp_string = "";
+ for(i = 0; i < argc; ++i)
+ if(argv(i) != argv(2))
+ tmp_string = strcat(tmp_string, " ", argv(i));
+
+ tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
+ cvar_set("g_maplist", tmp_string);
+
+ return;
+ }
+ break; // go to usage
}
+
+ case "shuffle": // randomly shuffle the maplist
+ {
+ cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
+ return;
+ }
+
+ default: break;
+ }
+ }
+
+ default:
+ print("Incorrect parameters for ^2maplist^7\n");
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist action [map]"));
+ print(" Where 'action' is the command to complete,\n");
+ print(" and 'map' is what it acts upon (if required).\n");
+ print(" Full list of commands here: \"add, cleanup, remove, shuffle.\"\n");
+ return;
+ }
+ }
+}
+
+void GenericCommand_nextframe(float request, float arguments, string command)
+{
+ switch(request)
+ {
+ case CMD_REQUEST_COMMAND:
+ {
+ queue_to_execute_next_frame(substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
+ return;
+ }
+
+ default:
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " nextframe command..."));
+ print(" Where command will be executed next frame of this VM\n");
+ return;
+ }
+ }
+}
+
+void GenericCommand_removefromlist(float request, float argc)
+{
+ switch(request)
+ {
+ case CMD_REQUEST_COMMAND:
+ {
+ if(argc == 3)
+ {
+ float i;
+ string original_cvar = argv(1);
+ string removal = argv(2);
+ string tmp_string;
+
+ argc = tokenizebyseparator(cvar_string(original_cvar), " ");
+
+ tmp_string = "";
+ for(i = 0; i < argc; ++i)
+ if(argv(i) != removal)
+ tmp_string = strcat(tmp_string, " ", argv(i));
+
+ tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
+ cvar_set(original_cvar, tmp_string);
+
+ return;
}
+ }
+
+ default:
+ print("Incorrect parameters for ^2removefromlist^7\n");
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " removefromlist variable value"));
+ print(" Where 'variable' is what cvar to remove 'value' from.\n");
+ print("See also: ^2addtolist^7\n");
+ return;
+ }
+ }
+}
+
+void GenericCommand_settemp(float request, float argc)
+{
+ switch(request)
+ {
+ case CMD_REQUEST_COMMAND:
+ {
+ if(argc >= 3)
+ {
+ if(cvar_settemp(argv(1), argv(2)))
+ dprint("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n");
+ else
+ dprint("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
+
+ return;
+ }
+ }
+
+ default:
+ print("Incorrect parameters for ^2settemp^7\n");
+ case CMD_REQUEST_USAGE:
+ {
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp \"cvar\" \"arguments\"\n"));
+ print(" Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
+ print("See also: ^2settemp_restore^7\n");
+ return;
+ }
+ }
+}
+
+void GenericCommand_settemp_restore(float request, float argc)
+{
+ switch(request)
+ {
+ case CMD_REQUEST_COMMAND:
+ {
+ float i = cvar_settemp_restore();
+
+ if(i)
+ dprint("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
+ else
+ dprint("Nothing to restore.\n");
+
return;
}
default:
case CMD_REQUEST_USAGE:
{
- print("\nUsage:^3 sv_cmd \n");
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp_restore\n"));
print(" No arguments required.\n");
+ print("See also: ^2settemp^7\n");
return;
}
}
default:
case CMD_REQUEST_USAGE:
{
- print("\nUsage:^3 sv_cmd \n");
+ print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " "));
print(" No arguments required.\n");
return;
}
// Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
#define GENERIC_COMMANDS(request,arguments,command) \
- GENERIC_COMMAND("addtolist", GenericCommand_addtolist(request, arguments), "") \
- GENERIC_COMMAND("", GenericCommand_(request, arguments), "") \
+ GENERIC_COMMAND("addtolist", GenericCommand_addtolist(request, arguments), "Add a string to a cvar") \
+ GENERIC_COMMAND("curl", GenericCommand_curl(request, arguments), "Queries an URL") \
+ GENERIC_COMMAND("dumpcommands", GenericCommand_dumpcommands(request), "Dump all commands on the program to *_cmd_dump.txt") \
+ GENERIC_COMMAND("maplist", GenericCommand_maplist(request, arguments), "Automatic control of maplist") \
+ GENERIC_COMMAND("nextframe", GenericCommand_nextframe(request, arguments, command), "Execute the given command next frame of this VM") \
+ GENERIC_COMMAND("removefromlist", GenericCommand_removefromlist(request, arguments), "Remove a string from a cvar") \
+ GENERIC_COMMAND("rpn", GenericCommand_rpn(request, arguments, command), "RPN calculator") \
+ GENERIC_COMMAND("settemp", GenericCommand_settemp(request, arguments), "Temporarily set a value to a cvar which is restored later") \
+ GENERIC_COMMAND("settemp_restore", GenericCommand_settemp_restore(request, arguments), "Restore all cvars set by settemp command") \
/* nothing */
void GenericCommand_macro_help()
return FALSE;
}
+
+void GenericCommand_macro_write_aliases(float fh)
+{
+ #define GENERIC_COMMAND(name,function,description) \
+ { CMD_Write_Alias("qc_cmd_svmenu", name, description); }
+
+ GENERIC_COMMANDS(0, 0, "")
+ #undef GENERIC_COMMAND
+
+ return;
+}
// ===========================================
float GenericCommand(string command)
{
float argc = tokenize_console(command);
+ float n, j, f, i;
+ string s, s2, c;
+ vector rgb;
// Guide for working with argc arguments by example:
// argc: 1 - 2 - 3 - 4
// argv: 0 - 1 - 2 - 3
// cmd vote - master - login - password
- if(argv(0) == "help")
+ if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
{
- print(" maplist add map\n");
- print(" maplist remove map\n");
- print(" maplist shuffle\n");
- print(" maplist cleanup\n");
- print(" maplist maplist\n");
- print(" maplist lsmaps\n");
- print(" maplist lsnewmaps\n");
- print(" addtolist variable addedvalue\n");
- print(" settemp cvar value\n");
- print(" settemp_restore\n");
- return TRUE;
- }
-
- if(argv(0) == "maplist")
- {
- if(argv(1) == "add" && argc == 3)
- {
- if (!fexists(strcat("maps/", argv(2), ".bsp")))
- {
- print("maplist: ERROR: ", argv(2), " does not exist!\n");
- return TRUE;
- }
- if(cvar_string("g_maplist") == "")
- cvar_set("g_maplist", argv(2));
- else
- cvar_set("g_maplist", strcat(argv(2), " ", cvar_string("g_maplist")));
- return TRUE;
- }
- else if(argv(1) == "remove" && argc == 3)
- {
- s = argv(2);
- n = tokenizebyseparator(cvar_string("g_maplist"), " ");
- s2 = "";
- for(i = 0; i < n; ++i)
- if(argv(i) != s)
- s2 = strcat(s2, " ", argv(i));
- s2 = substring(s2, 1, strlen(s2) - 1);
- cvar_set("g_maplist", s2);
- return TRUE;
- }
- else if(argv(1) == "shuffle" && argc == 2)
- {
- cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
- return TRUE;
- }
- else if(argv(1) == "cleanup")
- {
- MapInfo_Enumerate();
- MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
- n = tokenizebyseparator(cvar_string("g_maplist"), " ");
- s2 = "";
- for(i = 0; i < n; ++i)
- if(MapInfo_CheckMap(argv(i)))
- s2 = strcat(s2, " ", argv(i));
- s2 = substring(s2, 1, strlen(s2) - 1);
- cvar_set("g_maplist", s2);
- return TRUE;
- }
+ return TRUE; // handled by one of the above GenericCommand_* functions
}
else if(argc >= 3 && argv(0) == "red")
{
s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
- localcmd(strcat(argv(1), " ", GameCommand_Markup(s)));
+ localcmd(strcat(argv(1), " ", GenericCommand_markup(s)));
return TRUE;
}
else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)
return TRUE;
}
- else if(argv(0) == "addtolist") {
- if(argc >= 2)
- {
- s = argv(1);
- s2 = argv(2);
- if(cvar_string(s) == "")
- cvar_set(s, s2);
- else {
- n = tokenizebyseparator(cvar_string(s), " ");
- for(i = 0; i < n; ++i)
- if(argv(i) == s2)
- return TRUE; // already in list
- cvar_set(s, strcat(s2, " ", cvar_string(s)));
- }
- }
- return TRUE;
- }
-#ifdef MENUQC
- } else if(argv(0) == "cp") {
- if(argc >= 2)
- {
- s = argv(1);
- for(i = 2; i < argc; ++i)
- s = strcat(s, " ", argv(i));
- centerprint(unescape(s));
- }
- return TRUE;
-#endif
- }
- else if(argv(0) == "settemp") {
- cvar_settemp(argv(1), argv(2));
- return TRUE;
- }
- else if(argv(0) == "settemp_restore") {
- cvar_settemp_restore();
- return TRUE;
- }
return FALSE;
}
projects / xonotic / xonotic-data.pk3dir.git / blobdiff