6 #include "../mapinfo.qh"
9 #include "../notifications.qh"
13 #include "../../client/command/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(void)
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 void GenericCommand_dumpcommands(float request)
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");
243 void effectinfo_dump(int fh, bool alsoprint);
245 void GenericCommand_dumpeffectinfo(float request)
248 case CMD_REQUEST_COMMAND: {
250 string filename = argv(1);
251 bool alsoprint = false;
252 if (filename == "") {
253 filename = "effectinfo_dump.txt";
255 } else if (filename == "-") {
256 filename = "effectinfo_dump.txt";
259 int fh = fopen(filename, FILE_WRITE);
261 effectinfo_dump(fh, alsoprint);
262 LOG_INFOF("Dumping effectinfo... File located at ^2data/data/%s^7.\n", filename);
263 LOG_INFOF("Reload with ^2cl_particles_reloadeffects data/%s^7.\n", filename);
266 LOG_WARNINGF("Could not open file '%s'!\n", filename);
269 LOG_INFO(_("Effectinfo dump command only works with cl_cmd and sv_cmd.\n"));
274 case CMD_REQUEST_USAGE: {
275 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpeffectinfo [filename]"));
276 LOG_INFO(" Where 'filename' is the file to write (default is effectinfo_dump.txt),\n");
277 LOG_INFO(" if supplied with '-' output to console as well as default,\n");
278 LOG_INFO(" if left blank, it will only write to default.\n");
283 STATIC_INIT(dumpeffectinfo) { localcmd("alias dumpeffectinfo \"qc_cmd_svcl dumpeffectinfo ${* ?}\"\n"); }
285 void GenericCommand_dumpitems(float request)
289 case CMD_REQUEST_COMMAND:
296 case CMD_REQUEST_USAGE:
298 LOG_INFOF("\nUsage:^3 %s dumpitems", GetProgramCommandPrefix());
304 void GenericCommand_dumpnotifs(float request)
308 case CMD_REQUEST_COMMAND:
311 float fh, alsoprint = false;
312 string filename = argv(1);
316 filename = "notifications_dump.cfg";
319 else if(filename == "-")
321 filename = "notifications_dump.cfg";
324 fh = fopen(filename, FILE_WRITE);
328 Dump_Notifications(fh, alsoprint);
329 LOG_INFOF("Dumping notifications... File located in ^2data/data/%s^7.\n", filename);
334 LOG_INFOF("^1Error: ^7Could not open file '%s'!\n", filename);
337 LOG_INFO(_("Notification dump command only works with cl_cmd and sv_cmd.\n"));
343 case CMD_REQUEST_USAGE:
345 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [filename]"));
346 LOG_INFO(" Where 'filename' is the file to write (default is notifications_dump.cfg),\n");
347 LOG_INFO(" if supplied with '-' output to console as well as default,\n");
348 LOG_INFO(" if left blank, it will only write to default.\n");
354 void GenericCommand_dumpweapons(float request) // WEAPONTODO: make this work with other progs than just server
358 case CMD_REQUEST_COMMAND:
361 wep_config_file = -1;
362 wep_config_alsoprint = -1;
363 string filename = argv(1);
367 filename = "weapons_dump.cfg";
368 wep_config_alsoprint = false;
370 else if(filename == "-")
372 filename = "weapons_dump.cfg";
373 wep_config_alsoprint = true;
375 wep_config_file = fopen(filename, FILE_WRITE);
377 if(wep_config_file >= 0)
379 Dump_Weapon_Settings();
380 LOG_INFO(sprintf("Dumping weapons... File located in ^2data/data/%s^7.\n", filename));
381 fclose(wep_config_file);
382 wep_config_file = -1;
383 wep_config_alsoprint = -1;
387 LOG_INFO(sprintf("^1Error: ^7Could not open file '%s'!\n", filename));
390 LOG_INFO(_("Weapons dump command only works with sv_cmd.\n"));
396 case CMD_REQUEST_USAGE:
398 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpweapons [filename]"));
399 LOG_INFO(" Where 'filename' is the file to write (default is weapons_dump.cfg),\n");
400 LOG_INFO(" if supplied with '-' output to console as well as default,\n");
401 LOG_INFO(" if left blank, it will only write to default.\n");
407 void GenericCommand_dumpturrets(float request)
411 case CMD_REQUEST_COMMAND:
414 tur_config_file = -1;
415 tur_config_alsoprint = -1;
416 string filename = argv(1);
420 filename = "turrets_dump.cfg";
421 tur_config_alsoprint = FALSE;
423 else if(filename == "-")
425 filename = "turrets_dump.cfg";
426 tur_config_alsoprint = TRUE;
428 tur_config_file = fopen(filename, FILE_WRITE);
430 if(tur_config_file >= 0)
432 Dump_Turret_Settings();
433 LOG_INFO(sprintf("Dumping turrets... File located in ^2data/data/%s^7.\n", filename));
434 fclose(tur_config_file);
435 tur_config_file = -1;
436 tur_config_alsoprint = -1;
440 LOG_INFO(sprintf("^1Error: ^7Could not open file '%s'!\n", filename));
443 LOG_INFO(_("Turrets dump command only works with sv_cmd.\n"));
449 case CMD_REQUEST_USAGE:
451 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpturrets [filename]"));
452 LOG_INFO(" Where 'filename' is the file to write (default is turrets_dump.cfg),\n");
453 LOG_INFO(" if supplied with '-' output to console as well as default,\n");
454 LOG_INFO(" if left blank, it will only write to default.\n");
460 void GenericCommand_maplist(float request, float argc)
464 case CMD_REQUEST_COMMAND:
471 case "add": // appends new maps to the maplist
475 if (!fexists(strcat("maps/", argv(2), ".bsp")))
477 LOG_INFO("maplist: ERROR: ", argv(2), " does not exist!\n");
481 if(cvar_string("g_maplist") == "")
482 cvar_set("g_maplist", argv(2));
484 cvar_set("g_maplist", strcat(argv(2), " ", cvar_string("g_maplist")));
488 break; // go to usage
491 case "cleanup": // scans maplist and only adds back the ones which are really usable
494 MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
495 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
498 for(i = 0; i < argc; ++i)
499 if(MapInfo_CheckMap(argv(i)))
500 tmp_string = strcat(tmp_string, " ", argv(i));
502 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
503 cvar_set("g_maplist", tmp_string);
508 case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
512 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
515 for(i = 0; i < argc; ++i)
516 if(argv(i) != argv(2))
517 tmp_string = strcat(tmp_string, " ", argv(i));
519 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
520 cvar_set("g_maplist", tmp_string);
524 break; // go to usage
527 case "shuffle": // randomly shuffle the maplist
529 cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
538 LOG_INFO("Incorrect parameters for ^2maplist^7\n");
539 case CMD_REQUEST_USAGE:
541 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist action [map]\n"));
542 LOG_INFO(" Where 'action' is the command to complete,\n");
543 LOG_INFO(" and 'map' is what it acts upon (if required).\n");
544 LOG_INFO(" Full list of commands here: \"add, cleanup, remove, shuffle.\"\n");
550 void GenericCommand_nextframe(float request, float arguments, string command)
554 case CMD_REQUEST_COMMAND:
556 queue_to_execute_next_frame(substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
561 case CMD_REQUEST_USAGE:
563 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " nextframe command...\n"));
564 LOG_INFO(" Where command will be executed next frame of this VM\n");
570 void GenericCommand_removefromlist(float request, float argc)
574 case CMD_REQUEST_COMMAND:
579 string original_cvar = argv(1);
580 string removal = argv(2);
583 argc = tokenizebyseparator(cvar_string(original_cvar), " ");
586 for(i = 0; i < argc; ++i)
587 if(argv(i) != removal)
588 tmp_string = strcat(tmp_string, " ", argv(i));
590 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
591 cvar_set(original_cvar, tmp_string);
598 LOG_INFO("Incorrect parameters for ^2removefromlist^7\n");
599 case CMD_REQUEST_USAGE:
601 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " removefromlist variable value\n"));
602 LOG_INFO(" Where 'variable' is what cvar to remove 'value' from.\n");
603 LOG_INFO("See also: ^2addtolist^7\n");
609 void GenericCommand_restartnotifs(float request)
613 case CMD_REQUEST_COMMAND:
618 "Restart_Notifications(): Restarting %d notifications... ",
619 "Counts: MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
634 Destroy_All_Notifications();
635 CALL_ACCUMULATED_FUNCTION(RegisterNotifications);
637 LOG_INFO(_("Notification restart command only works with cl_cmd and sv_cmd.\n"));
643 case CMD_REQUEST_USAGE:
645 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " restartnotifs"));
646 LOG_INFO(" No arguments required.\n");
652 void GenericCommand_settemp(float request, float argc)
656 case CMD_REQUEST_COMMAND:
660 float f = cvar_settemp(argv(1), argv(2));
662 LOG_TRACE("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n");
664 LOG_TRACE("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
665 // else cvar_settemp itself errors out
672 LOG_INFO("Incorrect parameters for ^2settemp^7\n");
673 case CMD_REQUEST_USAGE:
675 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp \"cvar\" \"arguments\"\n"));
676 LOG_INFO(" Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
677 LOG_INFO("See also: ^2settemp_restore^7\n");
683 void GenericCommand_settemp_restore(float request, float argc)
687 case CMD_REQUEST_COMMAND:
689 float i = cvar_settemp_restore();
692 LOG_TRACE("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
694 LOG_TRACE("Nothing to restore.\n");
700 case CMD_REQUEST_USAGE:
702 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp_restore\n"));
703 LOG_INFO(" No arguments required.\n");
704 LOG_INFO("See also: ^2settemp^7\n");
710 void GenericCommand_runtest(float request, float argc)
714 case CMD_REQUEST_COMMAND:
719 for(i = 1; i < argc; ++i)
728 case CMD_REQUEST_USAGE:
730 LOG_INFO(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " [function to run]"));
736 /* use this when creating a new command, making sure to place it in alphabetical order... also,
737 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
738 void GenericCommand_(float request)
742 case CMD_REQUEST_COMMAND:
749 case CMD_REQUEST_USAGE:
751 print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " "));
752 print(" No arguments required.\n");
759 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
760 GENERIC_COMMAND(addtolist, "Add a string to a cvar") { GenericCommand_addtolist(request, arguments); }
761 GENERIC_COMMAND(dumpcommands, "Dump all commands on the program to *_cmd_dump.txt") { GenericCommand_dumpcommands(request); }
762 GENERIC_COMMAND(dumpeffectinfo, "Dump all effectinfo to effectinfo_dump.txt") { GenericCommand_dumpeffectinfo(request); }
763 GENERIC_COMMAND(dumpitems, "Dump all items to the console") { GenericCommand_dumpitems(request); }
764 GENERIC_COMMAND(dumpnotifs, "Dump all notifications into notifications_dump.txt") { GenericCommand_dumpnotifs(request); }
765 GENERIC_COMMAND(dumpturrets, "Dump all turrets into turrets_dump.txt") { GenericCommand_dumpturrets(request); }
766 GENERIC_COMMAND(dumpweapons, "Dump all weapons into weapons_dump.txt") { GenericCommand_dumpweapons(request); }
767 GENERIC_COMMAND(maplist, "Automatic control of maplist") { GenericCommand_maplist(request, arguments); }
768 GENERIC_COMMAND(nextframe, "Execute the given command next frame of this VM") { GenericCommand_nextframe(request, arguments, command); }
769 GENERIC_COMMAND(qc_curl, "Queries a URL") { GenericCommand_qc_curl(request, arguments); }
770 GENERIC_COMMAND(removefromlist, "Remove a string from a cvar") { GenericCommand_removefromlist(request, arguments); }
771 GENERIC_COMMAND(restartnotifs, "Re-initialize all notifications") { GenericCommand_restartnotifs(request); }
772 GENERIC_COMMAND(rpn, "RPN calculator") { GenericCommand_rpn(request, arguments, command); }
773 GENERIC_COMMAND(settemp, "Temporarily set a value to a cvar which is restored later") { GenericCommand_settemp(request, arguments); }
774 GENERIC_COMMAND(settemp_restore, "Restore all cvars set by settemp command") { GenericCommand_settemp_restore(request, arguments); }
775 GENERIC_COMMAND(runtest, "Run unit tests") { GenericCommand_runtest(request, arguments); }
777 void GenericCommand_macro_help()
779 FOREACH(GENERIC_COMMANDS, true, LAMBDA(LOG_INFOF(" ^2%s^7: %s\n", it.m_name, it.m_description)));
782 float GenericCommand_macro_command(float argc, string command)
784 string c = strtolower(argv(0));
785 FOREACH(GENERIC_COMMANDS, it.m_name == c, LAMBDA(
786 it.m_invokecmd(CMD_REQUEST_COMMAND, argc, command);
792 float GenericCommand_macro_usage(float argc)
794 string c = strtolower(argv(1));
795 FOREACH(GENERIC_COMMANDS, it.m_name == c, LAMBDA(
796 it.m_invokecmd(CMD_REQUEST_USAGE, argc, "");
802 void GenericCommand_macro_write_aliases(float fh)
804 FOREACH(GENERIC_COMMANDS, true, LAMBDA(CMD_Write_Alias("qc_cmd_svmenu", it.m_name, it.m_description)));
808 // ===========================================
809 // Main Common Function For Generic Commands
810 // ===========================================
811 // Commands spread out among all programs (menu, client, and server)
813 float GenericCommand(string command)
815 float argc = tokenize_console(command);
820 // Guide for working with argc arguments by example:
821 // argc: 1 - 2 - 3 - 4
822 // argv: 0 - 1 - 2 - 3
823 // cmd vote - master - login - password
825 if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
827 return true; // handled by one of the above GenericCommand_* functions
829 else if(argc >= 3 && argv(0) == "red")
831 s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
832 localcmd(strcat(argv(1), " ", GenericCommand_markup(s)));
835 else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)
838 s = strconv(2, 0, 0, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
840 n = floor(random() * 6 + 2);
843 for(i = 0; i < n; ++i)
845 s2 = strcat(s2, "AH");
849 s2 = strcat(substring(s2, 1, strlen(s2) - 1), "A");
855 s = strcat(s, " ", s2);
857 s = strcat(s2, " ", s);
859 s2 = substring(s, strlen(s) - 2, 2);
860 if(s2 == "AH" || s2 == "AY")
863 s = strcat(s, " ))");
866 s = substring(s, 0, strlen(s) - 1);
869 s = strconv(1, 0, 0, s);
871 localcmd(strcat(argv(1), " ", s));
875 else if(argc >= 3 && crc16(0, argv(0)) == 3826 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 55790)
877 // test case for terencehill's color codes
878 s = strdecolorize(substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
882 j = ((6 * max(1, floor(strlen(s)/32 + random() * 2 - 1))) / n) * (1 - 2 * (random() > 0.5));
885 for(i = 0; i < n; ++i)
887 c = substring(s, i, 1);
894 if(substring(s, i+1, 1) == "^")
900 rgb = hsl_to_rgb('1 0 0' * (j * i + f) + '0 1 .5');
901 c = strcat(rgb_to_hexcolor(rgb), c);
906 localcmd(strcat(argv(1), " ", s2));