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 // =========================================================
30 // used by generic commands for better help/usage information
31 string GetProgramCommandPrefix()
44 // used by curl command
45 void Curl_URI_Get_Callback(int id, float status, string data)
47 int i = id - URI_GET_CURL;
48 float do_exec = curl_uri_get_exec[i];
49 string do_cvar = curl_uri_get_cvar[i];
52 LOG_TRACEF("error: status is %d\n", status);
61 cvar_set(do_cvar, data);
70 // =======================
71 // Command Sub-Functions
72 // =======================
74 void GenericCommand_addtolist(float request, float argc)
78 case CMD_REQUEST_COMMAND:
82 string original_cvar = argv(1);
83 string tmp_string = argv(2);
85 if(cvar_string(original_cvar) == "") // cvar was empty
87 cvar_set(original_cvar, tmp_string);
89 else // add it to the end of the list if the list doesn't already have it
91 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
93 for(i = 0; i < argc; ++i)
94 if(argv(i) == tmp_string)
95 return; // already in list
97 cvar_set(original_cvar, strcat(tmp_string, " ", cvar_string(original_cvar)));
104 LOG_INFO("Incorrect parameters for ^2addtolist^7\n");
105 case CMD_REQUEST_USAGE:
107 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " addtolist variable value\n"));
108 LOG_INFO(" Where 'variable' is what to add 'value' to.\n");
109 LOG_INFO("See also: ^2removefromlist^7\n");
115 void GenericCommand_qc_curl(float request, float argc)
119 case CMD_REQUEST_COMMAND:
121 bool do_exec = false;
122 string do_cvar = string_null;
125 for(i = 1; i+1 < argc; ++i)
127 if(argv(i) == "--cvar" && i+2 < argc)
130 do_cvar = strzone(argv(i));
133 if(argv(i) == "--exec")
138 if(argv(i) == "--key" && i+2 < argc)
147 // now, argv(i) is the URL
148 // following args may be POST parameters
149 string url = argv(i);
151 float buf = buf_create();
153 for(j = 0; i+1 < argc; i += 2)
154 bufstr_set(buf, ++j, sprintf("%s=%s", uri_escape(argv(i)), uri_escape(argv(i+1))));
156 bufstr_set(buf, ++j, sprintf("submit=%s", uri_escape(argv(i))));
159 if(j == 0) // no args: GET
160 r = crypto_uri_postbuf(url, URI_GET_CURL + curl_uri_get_pos, string_null, string_null, -1, key);
161 else // with args: POST
162 r = crypto_uri_postbuf(url, URI_GET_CURL + curl_uri_get_pos, "application/x-www-form-urlencoded", "&", buf, key);
166 curl_uri_get_exec[curl_uri_get_pos] = do_exec;
167 curl_uri_get_cvar[curl_uri_get_pos] = do_cvar;
168 curl_uri_get_pos = (curl_uri_get_pos + 1) % (URI_GET_CURL_END - URI_GET_CURL + 1);
171 LOG_INFO(_("error creating curl handle\n"));
179 case CMD_REQUEST_USAGE:
181 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " qc_curl [--key N] [--cvar] [--exec] URL [postargs...]"));
187 GENERIC_COMMAND(dumpcommands, "Dump all commands on the program to *_cmd_dump.txt")
191 case CMD_REQUEST_COMMAND:
194 string filename = strcat(GetProgramCommandPrefix(), "_dump.txt");
195 fh = fopen(filename, FILE_WRITE);
200 CMD_Write("dump of server console commands:\n");
201 GameCommand_macro_write_aliases(fh);
203 CMD_Write("\ndump of networked client only commands:\n");
204 ClientCommand_macro_write_aliases(fh);
206 CMD_Write("\ndump of common commands:\n");
207 CommonCommand_macro_write_aliases(fh);
209 CMD_Write("\ndump of ban commands:\n");
210 BanCommand_macro_write_aliases(fh);
214 CMD_Write("dump of client commands:\n");
215 LocalCommand_macro_write_aliases(fh);
218 CMD_Write("\ndump of generic commands:\n");
219 GenericCommand_macro_write_aliases(fh);
221 LOG_INFO("Completed dump of aliases in ^2data/data/", GetProgramCommandPrefix(), "_dump.txt^7.\n");
227 LOG_INFO("^1Error: ^7Could not dump to file!\n");
233 case CMD_REQUEST_USAGE:
235 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpcommands"));
236 LOG_INFO(" No arguments required.\n");
242 void GenericCommand_maplist(float request, float argc)
246 case CMD_REQUEST_COMMAND:
253 case "add": // appends new maps to the maplist
257 if (!fexists(strcat("maps/", argv(2), ".bsp")))
259 LOG_INFO("maplist: ERROR: ", argv(2), " does not exist!\n");
263 if(cvar_string("g_maplist") == "")
264 cvar_set("g_maplist", argv(2));
266 cvar_set("g_maplist", strcat(argv(2), " ", cvar_string("g_maplist")));
270 break; // go to usage
273 case "cleanup": // scans maplist and only adds back the ones which are really usable
276 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
277 string filtered = "";
278 FOREACH_WORD(cvar_string("g_maplist"), MapInfo_CheckMap(it), filtered = cons(filtered, it));
279 cvar_set("g_maplist", filtered);
283 case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
287 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
290 for(i = 0; i < argc; ++i)
291 if(argv(i) != argv(2))
292 tmp_string = strcat(tmp_string, " ", argv(i));
294 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
295 cvar_set("g_maplist", tmp_string);
299 break; // go to usage
302 case "shuffle": // randomly shuffle the maplist
304 cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
313 LOG_INFO("Incorrect parameters for ^2maplist^7\n");
314 case CMD_REQUEST_USAGE:
316 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist action [map]\n"));
317 LOG_INFO(" Where 'action' is the command to complete,\n");
318 LOG_INFO(" and 'map' is what it acts upon (if required).\n");
319 LOG_INFO(" Full list of commands here: \"add, cleanup, remove, shuffle.\"\n");
325 void GenericCommand_nextframe(float request, float arguments, string command)
329 case CMD_REQUEST_COMMAND:
331 queue_to_execute_next_frame(substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
336 case CMD_REQUEST_USAGE:
338 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " nextframe command...\n"));
339 LOG_INFO(" Where command will be executed next frame of this VM\n");
345 void GenericCommand_removefromlist(float request, float argc)
349 case CMD_REQUEST_COMMAND:
354 string original_cvar = argv(1);
355 string removal = argv(2);
358 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
361 for(i = 0; i < argc; ++i)
362 if(argv(i) != removal)
363 tmp_string = strcat(tmp_string, " ", argv(i));
365 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
366 cvar_set(original_cvar, tmp_string);
373 LOG_INFO("Incorrect parameters for ^2removefromlist^7\n");
374 case CMD_REQUEST_USAGE:
376 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " removefromlist variable value\n"));
377 LOG_INFO(" Where 'variable' is what cvar to remove 'value' from.\n");
378 LOG_INFO("See also: ^2addtolist^7\n");
384 void GenericCommand_restartnotifs(float request)
388 case CMD_REQUEST_COMMAND:
391 int NOTIF_ANNCE_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_ANNCE, { ++NOTIF_ANNCE_COUNT; });
392 int NOTIF_INFO_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_INFO, { ++NOTIF_INFO_COUNT; });
393 int NOTIF_CENTER_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_CENTER, { ++NOTIF_CENTER_COUNT; });
394 int NOTIF_MULTI_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_MULTI, { ++NOTIF_MULTI_COUNT; });
395 int NOTIF_CHOICE_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_CHOICE, { ++NOTIF_CHOICE_COUNT; });
398 "Restart_Notifications(): Restarting %d notifications... ",
399 "Counts: MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
414 Destroy_All_Notifications();
415 CALL_ACCUMULATED_FUNCTION(RegisterNotifications);
417 LOG_INFO(_("Notification restart command only works with cl_cmd and sv_cmd.\n"));
423 case CMD_REQUEST_USAGE:
425 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " restartnotifs"));
426 LOG_INFO(" No arguments required.\n");
432 void GenericCommand_settemp(float request, float argc)
436 case CMD_REQUEST_COMMAND:
440 float f = cvar_settemp(argv(1), argv(2));
442 LOG_TRACE("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n");
444 LOG_TRACE("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
445 // else cvar_settemp itself errors out
452 LOG_INFO("Incorrect parameters for ^2settemp^7\n");
453 case CMD_REQUEST_USAGE:
455 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp \"cvar\" \"arguments\"\n"));
456 LOG_INFO(" Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
457 LOG_INFO("See also: ^2settemp_restore^7\n");
463 void GenericCommand_settemp_restore(float request, float argc)
467 case CMD_REQUEST_COMMAND:
469 float i = cvar_settemp_restore();
472 LOG_TRACE("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
474 LOG_TRACE("Nothing to restore.\n");
480 case CMD_REQUEST_USAGE:
482 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp_restore\n"));
483 LOG_INFO(" No arguments required.\n");
484 LOG_INFO("See also: ^2settemp^7\n");
490 void GenericCommand_runtest(float request, float argc)
494 case CMD_REQUEST_COMMAND:
499 for(i = 1; i < argc; ++i)
508 case CMD_REQUEST_USAGE:
510 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " [function to run]"));
516 /* use this when creating a new command, making sure to place it in alphabetical order... also,
517 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
518 void GenericCommand_(float request)
522 case CMD_REQUEST_COMMAND:
529 case CMD_REQUEST_USAGE:
531 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " "));
532 print(" No arguments required.\n");
539 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
540 GENERIC_COMMAND(addtolist, "Add a string to a cvar") { GenericCommand_addtolist(request, arguments); }
541 GENERIC_COMMAND(maplist, "Automatic control of maplist") { GenericCommand_maplist(request, arguments); }
542 GENERIC_COMMAND(nextframe, "Execute the given command next frame of this VM") { GenericCommand_nextframe(request, arguments, command); }
543 GENERIC_COMMAND(qc_curl, "Queries a URL") { GenericCommand_qc_curl(request, arguments); }
544 GENERIC_COMMAND(removefromlist, "Remove a string from a cvar") { GenericCommand_removefromlist(request, arguments); }
545 GENERIC_COMMAND(restartnotifs, "Re-initialize all notifications") { GenericCommand_restartnotifs(request); }
546 GENERIC_COMMAND(rpn, "RPN calculator") { GenericCommand_rpn(request, arguments, command); }
547 GENERIC_COMMAND(settemp, "Temporarily set a value to a cvar which is restored later") { GenericCommand_settemp(request, arguments); }
548 GENERIC_COMMAND(settemp_restore, "Restore all cvars set by settemp command") { GenericCommand_settemp_restore(request, arguments); }
549 GENERIC_COMMAND(runtest, "Run unit tests") { GenericCommand_runtest(request, arguments); }
551 void GenericCommand_macro_help()
553 FOREACH(GENERIC_COMMANDS, true, LAMBDA(LOG_INFOF(" ^2%s^7: %s\n", it.m_name, it.m_description)));
556 float GenericCommand_macro_command(float argc, string command)
558 string c = strtolower(argv(0));
559 FOREACH(GENERIC_COMMANDS, it.m_name == c, LAMBDA(
560 it.m_invokecmd(CMD_REQUEST_COMMAND, NULL, argc, command);
566 float GenericCommand_macro_usage(float argc)
568 string c = strtolower(argv(1));
569 FOREACH(GENERIC_COMMANDS, it.m_name == c, LAMBDA(
570 it.m_invokecmd(CMD_REQUEST_USAGE, NULL, argc, "");
576 void GenericCommand_macro_write_aliases(float fh)
578 FOREACH(GENERIC_COMMANDS, true, LAMBDA(CMD_Write_Alias("qc_cmd_svmenu", it.m_name, it.m_description)));
582 // ===========================================
583 // Main Common Function For Generic Commands
584 // ===========================================
585 // Commands spread out among all programs (menu, client, and server)
587 float GenericCommand(string command)
589 float argc = tokenize_console(command);
594 // Guide for working with argc arguments by example:
595 // argc: 1 - 2 - 3 - 4
596 // argv: 0 - 1 - 2 - 3
597 // cmd vote - master - login - password
599 if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
601 return true; // handled by one of the above GenericCommand_* functions
603 else if(argc >= 3 && argv(0) == "red")
605 s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
606 localcmd(strcat(argv(1), " ", GenericCommand_markup(s)));
609 else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)
612 s = strconv(2, 0, 0, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
614 n = floor(random() * 6 + 2);
617 for(i = 0; i < n; ++i)
619 s2 = strcat(s2, "AH");
623 s2 = strcat(substring(s2, 1, strlen(s2) - 1), "A");
629 s = strcat(s, " ", s2);
631 s = strcat(s2, " ", s);
633 s2 = substring(s, strlen(s) - 2, 2);
634 if(s2 == "AH" || s2 == "AY")
637 s = strcat(s, " ))");
640 s = substring(s, 0, strlen(s) - 1);
643 s = strconv(1, 0, 0, s);
645 localcmd(strcat(argv(1), " ", s));
649 else if(argc >= 3 && crc16(0, argv(0)) == 3826 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 55790)
651 // test case for terencehill's color codes
652 s = strdecolorize(substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
656 j = ((6 * max(1, floor(strlen(s)/32 + random() * 2 - 1))) / n) * (1 - 2 * (random() > 0.5));
659 for(i = 0; i < n; ++i)
661 c = substring(s, i, 1);
668 if(substring(s, i+1, 1) == "^")
674 rgb = hsl_to_rgb('1 0 0' * (j * i + f) + '0 1 .5');
675 c = strcat(rgb_to_hexcolor(rgb), c);
680 localcmd(strcat(argv(1), " ", s2));