6 #include "../mapinfo.qh"
9 #include "../notifications/all.qh"
13 #include <client/commands/cl_cmd.qh>
17 #include <server/command/banning.qh>
18 #include <server/command/cmd.qh>
19 #include <server/command/common.qh>
20 #include <server/command/sv_cmd.qh>
21 #include <common/turrets/config.qh>
22 #include <common/weapons/config.qh>
25 // =========================================================
26 // Generic program common command code, written by Samual
27 // Last updated: February 19th, 2012
28 // =========================================================
31 // used by curl command
32 void Curl_URI_Get_Callback(int id, float status, string data)
34 int i = id - URI_GET_CURL;
35 float do_exec = curl_uri_get_exec[i];
36 string do_cvar = curl_uri_get_cvar[i];
39 LOG_TRACEF("error: status is %d\n", status);
48 cvar_set(do_cvar, data);
57 // =======================
58 // Command Sub-Functions
59 // =======================
61 void GenericCommand_addtolist(float request, float argc)
65 case CMD_REQUEST_COMMAND:
69 string original_cvar = argv(1);
70 string tmp_string = argv(2);
72 if(cvar_string(original_cvar) == "") // cvar was empty
74 cvar_set(original_cvar, tmp_string);
76 else // add it to the end of the list if the list doesn't already have it
78 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
80 for(i = 0; i < argc; ++i)
81 if(argv(i) == tmp_string)
82 return; // already in list
84 cvar_set(original_cvar, strcat(tmp_string, " ", cvar_string(original_cvar)));
91 LOG_INFO("Incorrect parameters for ^2addtolist^7\n");
92 case CMD_REQUEST_USAGE:
94 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " addtolist variable value\n"));
95 LOG_INFO(" Where 'variable' is what to add 'value' to.\n");
96 LOG_INFO("See also: ^2removefromlist^7\n");
102 void GenericCommand_qc_curl(float request, float argc)
106 case CMD_REQUEST_COMMAND:
108 bool do_exec = false;
109 string do_cvar = string_null;
112 for(i = 1; i+1 < argc; ++i)
114 if(argv(i) == "--cvar" && i+2 < argc)
117 do_cvar = strzone(argv(i));
120 if(argv(i) == "--exec")
125 if(argv(i) == "--key" && i+2 < argc)
134 // now, argv(i) is the URL
135 // following args may be POST parameters
136 string url = argv(i);
138 float buf = buf_create();
140 for(j = 0; i+1 < argc; i += 2)
141 bufstr_set(buf, ++j, sprintf("%s=%s", uri_escape(argv(i)), uri_escape(argv(i+1))));
143 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 = (curl_uri_get_pos + 1) % (URI_GET_CURL_END - URI_GET_CURL + 1);
158 LOG_INFO(_("error creating curl handle\n"));
166 case CMD_REQUEST_USAGE:
168 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " qc_curl [--key N] [--cvar] [--exec] URL [postargs...]"));
174 GENERIC_COMMAND(dumpcommands, "Dump all commands on the program to *_cmd_dump.txt")
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 LOG_INFO("Completed dump of aliases in ^2data/data/", GetProgramCommandPrefix(), "_dump.txt^7.\n");
214 LOG_INFO("^1Error: ^7Could not dump to file!\n");
220 case CMD_REQUEST_USAGE:
222 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpcommands"));
223 LOG_INFO(" 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 LOG_INFO("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 string filtered = "";
265 FOREACH_WORD(cvar_string("g_maplist"), MapInfo_CheckMap(it), filtered = cons(filtered, it));
266 cvar_set("g_maplist", filtered);
270 case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
274 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
277 for(i = 0; i < argc; ++i)
278 if(argv(i) != argv(2))
279 tmp_string = strcat(tmp_string, " ", argv(i));
281 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
282 cvar_set("g_maplist", tmp_string);
286 break; // go to usage
289 case "shuffle": // randomly shuffle the maplist
291 cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
300 LOG_INFO("Incorrect parameters for ^2maplist^7\n");
301 case CMD_REQUEST_USAGE:
303 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist action [map]\n"));
304 LOG_INFO(" Where 'action' is the command to complete,\n");
305 LOG_INFO(" and 'map' is what it acts upon (if required).\n");
306 LOG_INFO(" Full list of commands here: \"add, cleanup, remove, shuffle.\"\n");
312 void GenericCommand_nextframe(float request, float arguments, string command)
316 case CMD_REQUEST_COMMAND:
318 queue_to_execute_next_frame(substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
323 case CMD_REQUEST_USAGE:
325 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " nextframe command...\n"));
326 LOG_INFO(" Where command will be executed next frame of this VM\n");
332 void GenericCommand_removefromlist(float request, float argc)
336 case CMD_REQUEST_COMMAND:
341 string original_cvar = argv(1);
342 string removal = argv(2);
345 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
348 for(i = 0; i < argc; ++i)
349 if(argv(i) != removal)
350 tmp_string = strcat(tmp_string, " ", argv(i));
352 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
353 cvar_set(original_cvar, tmp_string);
360 LOG_INFO("Incorrect parameters for ^2removefromlist^7\n");
361 case CMD_REQUEST_USAGE:
363 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " removefromlist variable value\n"));
364 LOG_INFO(" Where 'variable' is what cvar to remove 'value' from.\n");
365 LOG_INFO("See also: ^2addtolist^7\n");
371 void GenericCommand_restartnotifs(float request)
375 case CMD_REQUEST_COMMAND:
378 int NOTIF_ANNCE_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_ANNCE, { ++NOTIF_ANNCE_COUNT; });
379 int NOTIF_INFO_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_INFO, { ++NOTIF_INFO_COUNT; });
380 int NOTIF_CENTER_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_CENTER, { ++NOTIF_CENTER_COUNT; });
381 int NOTIF_MULTI_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_MULTI, { ++NOTIF_MULTI_COUNT; });
382 int NOTIF_CHOICE_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_CHOICE, { ++NOTIF_CHOICE_COUNT; });
385 "Restart_Notifications(): Restarting %d notifications... ",
386 "Counts: MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
401 Destroy_All_Notifications();
402 CALL_ACCUMULATED_FUNCTION(RegisterNotifications);
404 LOG_INFO(_("Notification restart command only works with cl_cmd and sv_cmd.\n"));
410 case CMD_REQUEST_USAGE:
412 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " restartnotifs"));
413 LOG_INFO(" No arguments required.\n");
419 void GenericCommand_settemp(float request, float argc)
423 case CMD_REQUEST_COMMAND:
427 float f = cvar_settemp(argv(1), argv(2));
429 LOG_TRACE("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n");
431 LOG_TRACE("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
432 // else cvar_settemp itself errors out
439 LOG_INFO("Incorrect parameters for ^2settemp^7\n");
440 case CMD_REQUEST_USAGE:
442 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp \"cvar\" \"arguments\"\n"));
443 LOG_INFO(" Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
444 LOG_INFO("See also: ^2settemp_restore^7\n");
450 void GenericCommand_settemp_restore(float request, float argc)
454 case CMD_REQUEST_COMMAND:
456 float i = cvar_settemp_restore();
459 LOG_TRACE("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
461 LOG_TRACE("Nothing to restore.\n");
467 case CMD_REQUEST_USAGE:
469 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp_restore\n"));
470 LOG_INFO(" No arguments required.\n");
471 LOG_INFO("See also: ^2settemp^7\n");
477 void GenericCommand_runtest(float request, float argc)
481 case CMD_REQUEST_COMMAND:
486 for(i = 1; i < argc; ++i)
495 case CMD_REQUEST_USAGE:
497 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " [function to run]"));
503 /* use this when creating a new command, making sure to place it in alphabetical order... also,
504 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
505 void GenericCommand_(float request)
509 case CMD_REQUEST_COMMAND:
516 case CMD_REQUEST_USAGE:
518 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " "));
519 print(" No arguments required.\n");
526 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
527 GENERIC_COMMAND(addtolist, "Add a string to a cvar") { GenericCommand_addtolist(request, arguments); }
528 GENERIC_COMMAND(maplist, "Automatic control of maplist") { GenericCommand_maplist(request, arguments); }
529 GENERIC_COMMAND(nextframe, "Execute the given command next frame of this VM") { GenericCommand_nextframe(request, arguments, command); }
530 GENERIC_COMMAND(qc_curl, "Queries a URL") { GenericCommand_qc_curl(request, arguments); }
531 GENERIC_COMMAND(removefromlist, "Remove a string from a cvar") { GenericCommand_removefromlist(request, arguments); }
532 GENERIC_COMMAND(restartnotifs, "Re-initialize all notifications") { GenericCommand_restartnotifs(request); }
533 GENERIC_COMMAND(rpn, "RPN calculator") { GenericCommand_rpn(request, arguments, command); }
534 GENERIC_COMMAND(settemp, "Temporarily set a value to a cvar which is restored later") { GenericCommand_settemp(request, arguments); }
535 GENERIC_COMMAND(settemp_restore, "Restore all cvars set by settemp command") { GenericCommand_settemp_restore(request, arguments); }
536 GENERIC_COMMAND(runtest, "Run unit tests") { GenericCommand_runtest(request, arguments); }
538 void GenericCommand_macro_help()
540 FOREACH(GENERIC_COMMANDS, true, LOG_INFOF(" ^2%s^7: %s\n", it.m_name, it.m_description));
543 float GenericCommand_macro_command(float argc, string command)
545 string c = strtolower(argv(0));
546 FOREACH(GENERIC_COMMANDS, it.m_name == c, {
547 it.m_invokecmd(CMD_REQUEST_COMMAND, NULL, argc, command);
553 float GenericCommand_macro_usage(float argc)
555 string c = strtolower(argv(1));
556 FOREACH(GENERIC_COMMANDS, it.m_name == c, {
557 it.m_invokecmd(CMD_REQUEST_USAGE, NULL, argc, "");
563 void GenericCommand_macro_write_aliases(float fh)
565 FOREACH(GENERIC_COMMANDS, true, CMD_Write_Alias("qc_cmd_svmenu", it.m_name, it.m_description));
569 // ===========================================
570 // Main Common Function For Generic Commands
571 // ===========================================
572 // Commands spread out among all programs (menu, client, and server)
574 float GenericCommand(string command)
576 float argc = tokenize_console(command);
581 // Guide for working with argc arguments by example:
582 // argc: 1 - 2 - 3 - 4
583 // argv: 0 - 1 - 2 - 3
584 // cmd vote - master - login - password
586 if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
588 return true; // handled by one of the above GenericCommand_* functions
590 else if(argc >= 3 && argv(0) == "red")
592 s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
593 localcmd(strcat(argv(1), " ", GenericCommand_markup(s)));
596 else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)
599 s = strconv(2, 0, 0, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
601 n = floor(random() * 6 + 2);
604 for(i = 0; i < n; ++i)
606 s2 = strcat(s2, "AH");
610 s2 = strcat(substring(s2, 1, strlen(s2) - 1), "A");
616 s = strcat(s, " ", s2);
618 s = strcat(s2, " ", s);
620 s2 = substring(s, strlen(s) - 2, 2);
621 if(s2 == "AH" || s2 == "AY")
624 s = strcat(s, " ))");
627 s = substring(s, 0, strlen(s) - 1);
630 s = strconv(1, 0, 0, s);
632 localcmd(strcat(argv(1), " ", s));
636 else if(argc >= 3 && crc16(0, argv(0)) == 3826 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 55790)
638 // test case for terencehill's color codes
639 s = strdecolorize(substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
643 j = ((6 * max(1, floor(strlen(s)/32 + random() * 2 - 1))) / n) * (1 - 2 * (random() > 0.5));
646 for(i = 0; i < n; ++i)
648 c = substring(s, i, 1);
655 if(substring(s, i+1, 1) == "^")
661 rgb = hsl_to_rgb('1 0 0' * (j * i + f) + '0 1 .5');
662 c = strcat(rgb_to_hexcolor(rgb), c);
667 localcmd(strcat(argv(1), " ", s2));