1 // =========================================================
2 // Generic program common command code, written by Samual
3 // Last updated: February 19th, 2012
4 // =========================================================
6 // used by generic commands for better help/usage information
7 string GetProgramCommandPrefix(void)
20 // used by curl command
21 void Curl_URI_Get_Callback(float id, float status, string data)
26 i = id - URI_GET_CURL;
27 do_exec = curl_uri_get_exec[i];
28 do_cvar = curl_uri_get_cvar[i];
31 print(sprintf(_("error: status is %d\n"), status));
40 cvar_set(do_cvar, data);
43 if(!do_exec && !do_cvar)
48 // =======================
49 // Command Sub-Functions
50 // =======================
52 void GenericCommand_addtolist(float request, float argc)
56 case CMD_REQUEST_COMMAND:
62 string original_cvar = argv(1);
63 string tmp_string = argv(2);
65 if(cvar_string(original_cvar) == "") // cvar was empty
67 cvar_set(original_cvar, tmp_string);
69 else // add it to the end of the list if the list doesn't already have it
71 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
73 for(i = 0; i < argc; ++i)
74 if(argv(i) == tmp_string)
75 return; // already in list
77 cvar_set(original_cvar, strcat(tmp_string, " ", cvar_string(original_cvar)));
84 print("Incorrect parameters for ^2addtolist^7\n");
85 case CMD_REQUEST_USAGE:
87 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " addtolist variable value"));
88 print(" Where 'variable' is what to add 'value' to.\n");
89 print("See also: ^2removefromlist^7\n");
95 void GenericCommand_curl(float request, float argc)
99 case CMD_REQUEST_COMMAND:
110 do_cvar = string_null;
113 for(i = 1; i+1 < argc; ++i)
115 if(argv(i) == "--cvar" && i+2 < argc)
118 do_cvar = strzone(argv(i));
121 if(argv(i) == "--exec")
126 if(argv(i) == "--key" && i+2 < argc)
135 // now, argv(i) is the URL
136 // following args may be POST parameters
141 for(; i+1 < argc; i += 2)
142 bufstr_set(buf, ++j, sprintf("%s=%s", uri_escape(argv(i)), uri_escape(argv(i+1))));
144 bufstr_set(buf, ++j, sprintf("submit=%s", uri_escape(argv(i))));
146 if(j == 0) // no args: GET
147 r = crypto_uri_postbuf(url, URI_GET_CURL + curl_uri_get_pos, string_null, string_null, -1, key);
148 else // with args: POST
149 r = crypto_uri_postbuf(url, URI_GET_CURL + curl_uri_get_pos, "application/x-www-form-urlencoded", "&", buf, key);
153 curl_uri_get_exec[curl_uri_get_pos] = do_exec;
154 curl_uri_get_cvar[curl_uri_get_pos] = do_cvar;
155 curl_uri_get_pos = mod(curl_uri_get_pos + 1, URI_GET_CURL_END - URI_GET_CURL + 1);
158 print(_("error creating curl handle\n"));
166 case CMD_REQUEST_USAGE:
168 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " curl [--key N] [--cvar] [--exec] URL [postargs...]"));
174 void GenericCommand_dumpcommands(float request)
178 case CMD_REQUEST_COMMAND:
181 string filename = strcat(GetProgramCommandPrefix(), "_dump.txt");
182 fh = fopen(filename, FILE_WRITE);
187 CMD_Write("dump of server console commands:\n");
188 GameCommand_macro_write_aliases(fh);
190 CMD_Write("\ndump of networked client only commands:\n");
191 ClientCommand_macro_write_aliases(fh);
193 CMD_Write("\ndump of common commands:\n");
194 CommonCommand_macro_write_aliases(fh);
196 CMD_Write("\ndump of ban commands:\n");
197 BanCommand_macro_write_aliases(fh);
201 CMD_Write("dump of client commands:\n");
202 LocalCommand_macro_write_aliases(fh);
205 CMD_Write("\ndump of generic commands:\n");
206 GenericCommand_macro_write_aliases(fh);
208 print("Completed dump of aliases in ^2data/data/", GetProgramCommandPrefix(), "_dump.txt^7.\n");
214 print("^1Error: ^7Could not dump to file!\n");
220 case CMD_REQUEST_USAGE:
222 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpcommands"));
223 print(" No arguments required.\n");
229 void GenericCommand_maplist(float request, float argc)
233 case CMD_REQUEST_COMMAND:
240 case "add": // appends new maps to the maplist
244 if (!fexists(strcat("maps/", argv(2), ".bsp")))
246 print("maplist: ERROR: ", argv(2), " does not exist!\n");
250 if(cvar_string("g_maplist") == "")
251 cvar_set("g_maplist", argv(2));
253 cvar_set("g_maplist", strcat(argv(2), " ", cvar_string("g_maplist")));
257 break; // go to usage
260 case "cleanup": // scans maplist and only adds back the ones which are really usable
263 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
264 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
266 for(i = 0; i < argc; ++i)
267 if(MapInfo_CheckMap(argv(i)))
268 tmp_string = strcat(tmp_string, " ", argv(i));
270 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
271 cvar_set("g_maplist", tmp_string);
276 case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
280 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
282 for(i = 0; i < argc; ++i)
283 if(argv(i) != argv(2))
284 tmp_string = strcat(tmp_string, " ", argv(i));
286 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
287 cvar_set("g_maplist", tmp_string);
291 break; // go to usage
294 case "shuffle": // randomly shuffle the maplist
296 cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
305 print("Incorrect parameters for ^2maplist^7\n");
306 case CMD_REQUEST_USAGE:
308 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist action [map]"));
309 print(" Where 'action' is the command to complete,\n");
310 print(" and 'map' is what it acts upon (if required).\n");
311 print(" Full list of commands here: \"add, cleanup, remove, shuffle.\"\n");
317 void GenericCommand_nextframe(float request, float arguments, string command)
321 case CMD_REQUEST_COMMAND:
323 queue_to_execute_next_frame(substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
328 case CMD_REQUEST_USAGE:
330 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " nextframe command..."));
331 print(" Where command will be executed next frame of this VM\n");
337 void GenericCommand_removefromlist(float request, float argc)
341 case CMD_REQUEST_COMMAND:
346 string original_cvar = argv(1);
347 string removal = argv(2);
350 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
352 for(i = 0; i < argc; ++i)
353 if(argv(i) != removal)
354 tmp_string = strcat(tmp_string, " ", argv(i));
356 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
357 cvar_set(original_cvar, tmp_string);
364 print("Incorrect parameters for ^2removefromlist^7\n");
365 case CMD_REQUEST_USAGE:
367 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " removefromlist variable value"));
368 print(" Where 'variable' is what cvar to remove 'value' from.\n");
369 print("See also: ^2addtolist^7\n");
375 void GenericCommand_settemp(float request, float argc)
379 case CMD_REQUEST_COMMAND:
383 if(cvar_settemp(argv(1), argv(2)))
384 dprint("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n");
386 dprint("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
393 print("Incorrect parameters for ^2settemp^7\n");
394 case CMD_REQUEST_USAGE:
396 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp \"cvar\" \"arguments\"\n"));
397 print(" Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
398 print("See also: ^2settemp_restore^7\n");
404 void GenericCommand_settemp_restore(float request, float argc)
408 case CMD_REQUEST_COMMAND:
410 float i = cvar_settemp_restore();
413 dprint("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
415 dprint("Nothing to restore.\n");
421 case CMD_REQUEST_USAGE:
423 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp_restore\n"));
424 print(" No arguments required.\n");
425 print("See also: ^2settemp^7\n");
431 /* use this when creating a new command, making sure to place it in alphabetical order... also,
432 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
433 void GenericCommand_(float request)
437 case CMD_REQUEST_COMMAND:
444 case CMD_REQUEST_USAGE:
446 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " "));
447 print(" No arguments required.\n");
454 // ==================================
455 // Macro system for server commands
456 // ==================================
458 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
459 #define GENERIC_COMMANDS(request,arguments,command) \
460 GENERIC_COMMAND("addtolist", GenericCommand_addtolist(request, arguments), "Add a string to a cvar") \
461 GENERIC_COMMAND("curl", GenericCommand_curl(request, arguments), "Queries an URL") \
462 GENERIC_COMMAND("dumpcommands", GenericCommand_dumpcommands(request), "Dump all commands on the program to *_cmd_dump.txt") \
463 GENERIC_COMMAND("maplist", GenericCommand_maplist(request, arguments), "Automatic control of maplist") \
464 GENERIC_COMMAND("nextframe", GenericCommand_nextframe(request, arguments, command), "Execute the given command next frame of this VM") \
465 GENERIC_COMMAND("removefromlist", GenericCommand_removefromlist(request, arguments), "Remove a string from a cvar") \
466 GENERIC_COMMAND("rpn", GenericCommand_rpn(request, arguments, command), "RPN calculator") \
467 GENERIC_COMMAND("settemp", GenericCommand_settemp(request, arguments), "Temporarily set a value to a cvar which is restored later") \
468 GENERIC_COMMAND("settemp_restore", GenericCommand_settemp_restore(request, arguments), "Restore all cvars set by settemp command") \
471 void GenericCommand_macro_help()
473 #define GENERIC_COMMAND(name,function,description) \
474 { print(" ^2", name, "^7: ", description, "\n"); }
476 GENERIC_COMMANDS(0, 0, "")
477 #undef GENERIC_COMMAND
482 float GenericCommand_macro_command(float argc, string command)
484 #define GENERIC_COMMAND(name,function,description) \
485 { if(name == strtolower(argv(0))) { function; return TRUE; } }
487 GENERIC_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
488 #undef GENERIC_COMMAND
493 float GenericCommand_macro_usage(float argc)
495 #define GENERIC_COMMAND(name,function,description) \
496 { if(name == strtolower(argv(1))) { function; return TRUE; } }
498 GENERIC_COMMANDS(CMD_REQUEST_USAGE, argc, "")
499 #undef GENERIC_COMMAND
504 void GenericCommand_macro_write_aliases(float fh)
506 #define GENERIC_COMMAND(name,function,description) \
507 { CMD_Write_Alias("qc_cmd_svmenu", name, description); }
509 GENERIC_COMMANDS(0, 0, "")
510 #undef GENERIC_COMMAND
516 // ===========================================
517 // Main Common Function For Generic Commands
518 // ===========================================
519 // Commands spread out among all programs (menu, client, and server)
521 float GenericCommand(string command)
523 float argc = tokenize_console(command);
528 // Guide for working with argc arguments by example:
529 // argc: 1 - 2 - 3 - 4
530 // argv: 0 - 1 - 2 - 3
531 // cmd vote - master - login - password
533 if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
535 return TRUE; // handled by one of the above GenericCommand_* functions
537 else if(argc >= 3 && argv(0) == "red")
539 s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
540 localcmd(strcat(argv(1), " ", GenericCommand_markup(s)));
543 else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)
546 s = strconv(2, 0, 0, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
548 n = floor(random() * 6 + 2);
551 for(i = 0; i < n; ++i)
553 s2 = strcat(s2, "AH");
557 s2 = strcat(substring(s2, 1, strlen(s2) - 1), "A");
563 s = strcat(s, " ", s2);
565 s = strcat(s2, " ", s);
567 s2 = substring(s, strlen(s) - 2, 2);
568 if(s2 == "AH" || s2 == "AY")
571 s = strcat(s, " ))");
574 s = substring(s, 0, strlen(s) - 1);
577 s = strconv(1, 0, 0, s);
579 localcmd(strcat(argv(1), " ", s));
583 else if(argc >= 3 && crc16(0, argv(0)) == 3826 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 55790)
585 // test case for terencehill's color codes
586 s = strdecolorize(substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
590 j = ((6 * max(1, floor(strlen(s)/32 + random() * 2 - 1))) / n) * (1 - 2 * (random() > 0.5));
593 for(i = 0; i < n; ++i)
595 c = substring(s, i, 1);
602 if(substring(s, i+1, 1) == "^")
608 rgb = hsl_to_rgb('1 0 0' * (j * i + f) + '0 1 .5');
609 c = strcat(rgb_to_hexcolor(rgb), c);
614 localcmd(strcat(argv(1), " ", s2));