qcsrc/common/command/generic.qc

   1 // =========================================================
   2 //  Generic program common command code, reworked by Samual
   3 //  Last updated: December 28th, 2011
   4 // =========================================================
   5
   6 string GetProgamCommandPrefix()
   7 {
   8         #ifdef SVQC
   9         return "sv_cmd";
  10         #endif
  11         #ifdef CSQC
  12         return "cl_cmd";
  13         #endif
  14         #ifdef MENUQC
  15         return "menu_cmd";
  16         #endif
  17 }
  18
  19 #define NUM_MARKUPS     41
  20 float markup_init;
  21 string markup_from[NUM_MARKUPS];
  22 string markup_to[NUM_MARKUPS];
  23 void GameCommand_MarkupInit()
  24 {
  25         float i;
  26         if (markup_init)
  27                 return;
  28         markup_init = 1;
  29         i = 0;
  30         markup_from[i] = "&alien"; markup_to[i] = "\x12"; ++i;
  31         markup_from[i] = "&:-)"; markup_to[i] = "\x13"; ++i;
  32         markup_from[i] = "&:-("; markup_to[i] = "\x14"; ++i;
  33         markup_from[i] = "&x-P"; markup_to[i] = "\x15"; ++i;
  34         markup_from[i] = "&:-/"; markup_to[i] = "\x16"; ++i;
  35         markup_from[i] = "&:-D"; markup_to[i] = "\x17"; ++i;
  36         markup_from[i] = "&<<"; markup_to[i] = "\x18"; ++i;
  37         markup_from[i] = "&>>"; markup_to[i] = "\x19"; ++i;
  38         markup_from[i] = "&dot"; markup_to[i] = "\x1a"; ++i;
  39         markup_from[i] = "&^_"; markup_to[i] = "\x1b"; ++i;
  40         markup_from[i] = "&ysplat"; markup_to[i] = "\x1c"; ++i;
  41         markup_from[i] = "&-]"; markup_to[i] = "\x1d"; ++i;
  42         markup_from[i] = "&--"; markup_to[i] = "\x1e"; ++i;
  43         markup_from[i] = "&[-"; markup_to[i] = "\x1f"; ++i;
  44         markup_from[i] = "&s<"; markup_to[i] = "\x2c"; ++i;
  45         markup_from[i] = "&s>"; markup_to[i] = "\x2e"; ++i;
  46         markup_from[i] = "&<-"; markup_to[i] = "\x7f"; ++i;
  47         markup_from[i] = "&[="; markup_to[i] = "\x80"; ++i;
  48         markup_from[i] = "&=="; markup_to[i] = "\x81"; ++i;
  49         markup_from[i] = "&=]"; markup_to[i] = "\x82"; ++i;
  50         markup_from[i] = "&r!"; markup_to[i] = "\x84"; ++i;
  51         markup_from[i] = "&|o|"; markup_to[i] = "\x85"; ++i;
  52         markup_from[i] = "&|u|"; markup_to[i] = "\x86"; ++i;
  53         markup_from[i] = "&|i|"; markup_to[i] = "\x87"; ++i;
  54         markup_from[i] = "&|c|"; markup_to[i] = "\x88"; ++i;
  55         markup_from[i] = "&[c]"; markup_to[i] = "\x89"; ++i;
  56         markup_from[i] = "&[n]"; markup_to[i] = "\x8a"; ++i;
  57         markup_from[i] = "&[]"; markup_to[i] = "\x8b"; ++i;
  58         markup_from[i] = "&r?"; markup_to[i] = "\x8c"; ++i;
  59         markup_from[i] = "&|>"; markup_to[i] = "\x8d"; ++i;
  60         markup_from[i] = "&splat0"; markup_to[i] = "\x8e"; ++i;
  61         markup_from[i] = "&splat1"; markup_to[i] = "\x8f"; ++i;
  62         markup_from[i] = "&[["; markup_to[i] = "\x90"; ++i;
  63         markup_from[i] = "&]]"; markup_to[i] = "\x91"; ++i;
  64         markup_from[i] = "&splat2"; markup_to[i] = "\x9a"; ++i;
  65         markup_from[i] = "&)("; markup_to[i] = "\x9b"; ++i;
  66         markup_from[i] = "&splat3"; markup_to[i] = "\x9c"; ++i;
  67         markup_from[i] = "&(."; markup_to[i] = "\x9d"; ++i;
  68         markup_from[i] = "&.."; markup_to[i] = "\x9e"; ++i;
  69         markup_from[i] = "&.)"; markup_to[i] = "\x9f"; ++i;
  70         markup_from[i] = "&<|"; markup_to[i] = "\xff"; ++i;
  71 }
  72
  73 string GameCommand_Markup(string s2)
  74 {
  75         float red, ccase, i, j;
  76         string s, s3;
  77
  78         GameCommand_MarkupInit();
  79
  80         s = "";
  81
  82         red = 0;
  83         ccase = 0;
  84         for(i = 0; i < strlen(s2); ++i)
  85         {
  86                 for(j = 0; j < NUM_MARKUPS; ++j)
  87                 {
  88                         s3 = substring(s2, i, strlen(markup_from[j]));
  89                         if (s3 == markup_from[j])
  90                         {
  91                                 s = strcat(s, markup_to[j]);
  92                                 i += strlen(markup_from[j]) - 1;
  93                                 break;
  94                         }
  95                 }
  96
  97                 if(j == NUM_MARKUPS)
  98                 {
  99                         if(substring(s2, i, 2) == "&&")
 100                         {
 101                                 s = strcat(s, strconv(ccase, red, red, "&"));
 102                                 ++i;
 103                         }
 104                         else if(substring(s2, i, 2) == "&d")
 105                         {
 106                                 red = 2;
 107                                 ccase = 0;
 108                                 ++i;
 109                         }
 110                         else if(substring(s2, i, 2) == "&a")
 111                         {
 112                                 red = 2;
 113                                 ccase = 2;
 114                                 ++i;
 115                         }
 116                         else if(substring(s2, i, 2) == "&n")
 117                         {
 118                                 red = 0;
 119                                 ccase = 0;
 120                                 ++i;
 121                         }
 122                         else
 123                                 s = strcat(s, strconv(ccase, red, red, substring(s2, i, 1)));
 124                 }
 125         }
 126
 127         return s;
 128 }
 129
 130 void GenericCommand_addtolist(float request)
 131 {
 132         switch(request)
 133         {
 134                 case CMD_REQUEST_COMMAND:
 135                 {
 136                         if(argc >= 2)
 137                         {
 138                                 s = argv(1);
 139                                 s2 = argv(2);
 140                                 if(cvar_string(s) == "")
 141                                         cvar_set(s, s2);
 142                                 else
 143                                 {
 144                                         n = tokenizebyseparator(cvar_string(s), " ");
 145                                         for(i = 0; i < n; ++i)
 146                                                 if(argv(i) == s2)
 147                                                         return; // already in list
 148                                         cvar_set(s, strcat(s2, " ", cvar_string(s)));
 149                                 }
 150                         }
 151                         return;
 152                 }
 153
 154                 default:
 155                 case CMD_REQUEST_USAGE:
 156                 {
 157                         print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(caller), " ")));
 158                         print("  No arguments required.\n");
 159                         return;
 160                 }
 161         }
 162 }
 163
 164 void GenericCommand_maplist(float request, float argc)
 165 {
 166         switch(request)
 167         {
 168                 case CMD_REQUEST_COMMAND:
 169                 {
 170                         string tmp_string;
 171                         float i;
 172
 173                         switch(argv(1))
 174                         {
 175                                 case "add": // appends new maps to the maplist
 176                                 {
 177                                         if(argc == 3)
 178                                         {
 179                                                 if (!fexists(strcat("maps/", argv(2), ".bsp")))
 180                                                 {
 181                                                         print("maplist: ERROR: ", argv(2), " does not exist!\n");
 182                                                         break;
 183                                                 }
 184
 185                                                 if(cvar_string("g_maplist") == "")
 186                                                         cvar_set("g_maplist", argv(2));
 187                                                 else
 188                                                         cvar_set("g_maplist", strcat(argv(2), " ", cvar_string("g_maplist")));
 189
 190                                                 return;
 191                                         }
 192                                         break; // go to usage
 193                                 }
 194
 195                                 case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
 196                                 {
 197                                         if(argc == 3)
 198                                         {
 199                                                 argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
 200
 201                                                 for(i = 0; i < argc; ++i)
 202                                                         if(argv(i) != argv(2))
 203                                                                 tmp_string = strcat(tmp_string, " ", argv(i));
 204
 205                                                 tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
 206                                                 cvar_set("g_maplist", tmp_string);
 207
 208                                                 return;
 209                                         }
 210                                         break; // go to usage
 211                                 }
 212
 213                                 case "shuffle": // randomly shuffle the maplist
 214                                 {
 215                                         cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
 216                                         return;
 217                                 }
 218
 219                                 case "cleanup": // scans maplist and only adds back the ones which are really usable
 220                                 {
 221                                         MapInfo_Enumerate();
 222                                         MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
 223                                         argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
 224
 225                                         for(i = 0; i < argc; ++i)
 226                                                 if(MapInfo_CheckMap(argv(i)))
 227                                                         tmp_string = strcat(tmp_string, " ", argv(i));
 228
 229                                         tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
 230                                         cvar_set("g_maplist", tmp_string);
 231
 232                                         return;
 233                                 }
 234
 235                                 default: break;
 236                         }
 237                 }
 238
 239                 default:
 240                 case CMD_REQUEST_USAGE:
 241                 {
 242                         print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(caller), " maplist command [map]"))); // todo
 243                         print("  No arguments required.\n");
 244                         return;
 245                 }
 246         }
 247 }
 248
 249 void GenericCommand_settemp(float request, float argc)
 250 {
 251         switch(request)
 252         {
 253                 case CMD_REQUEST_COMMAND:
 254                 {
 255                         if(argc >= 3)
 256                         {
 257                                 if(cvar_settemp(argv(1), argv(2)))
 258                                         dprint("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n");
 259                                 else
 260                                         dprint("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
 261
 262                                 return;
 263                         }
 264                 }
 265
 266                 default:
 267                         print("Incorrect parameters for ^2settemp^7\n");
 268                 case CMD_REQUEST_USAGE:
 269                 {
 270                         print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(caller), " settemp \"cvar\" \"arguments\"\n"));
 271                         print("  Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
 272                         return;
 273                 }
 274         }
 275 }
 276
 277 void GenericCommand_settemp_restore(float request, float argc)
 278 {
 279         switch(request)
 280         {
 281                 case CMD_REQUEST_COMMAND:
 282                 {
 283                         float i = cvar_settemp_restore();
 284
 285                         if(i)
 286                                 dprint("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
 287                         else
 288                                 dprint("Nothing to restore.\n");
 289
 290                         return;
 291                 }
 292
 293                 default:
 294                 case CMD_REQUEST_USAGE:
 295                 {
 296                         print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(caller), " settemp_restore\n"));
 297                         print("  No arguments required.\n");
 298                         return;
 299                 }
 300         }
 301 }
 302
 303 /* use this when creating a new command, making sure to place it in alphabetical order... also,
 304 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
 305 void GenericCommand_(float request)
 306 {
 307         switch(request)
 308         {
 309                 case CMD_REQUEST_COMMAND:
 310                 {
 311
 312                         return;
 313                 }
 314
 315                 default:
 316                 case CMD_REQUEST_USAGE:
 317                 {
 318                         print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(caller), " ")));
 319                         print("  No arguments required.\n");
 320                         return;
 321                 }
 322         }
 323 }
 324 */
 325
 326 // ==================================
 327 //  Macro system for server commands
 328 // ==================================
 329
 330 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
 331 #define GENERIC_COMMANDS(request,arguments,command) \
 332         GENERIC_COMMAND("addtolist", GenericCommand_addtolist(request, arguments), "Add a string to a cvar at the end of a list") \
 333         GENERIC_COMMAND("maplist", GenericCommand_maplist(request, arguments), "Automatic control of maplist") \
 334         GENERIC_COMMAND("rpn", GenericCommand_rpn(request, arguments, command), "RPN calculator") \
 335         GENERIC_COMMAND("settemp", GenericCommand_settemp(request, arguments), "Temporarily set a value to a cvar which is restored later") \
 336         GENERIC_COMMAND("settemp_restore", GenericCommand_settemp_restore(request, arguments), "Restore all cvars set by settemp command") \
 337         /* nothing */
 338
 339 void GenericCommand_macro_help()
 340 {
 341         #define GENERIC_COMMAND(name,function,description) \
 342                 { print("  ^2", name, "^7: ", description, "\n"); }
 343
 344         GENERIC_COMMANDS(0, 0, "")
 345         #undef GENERIC_COMMAND
 346
 347         return;
 348 }
 349
 350 float GenericCommand_macro_command(float argc, string command)
 351 {
 352         #define GENERIC_COMMAND(name,function,description) \
 353                 { if(name == strtolower(argv(0))) { function; return TRUE; } }
 354
 355         GENERIC_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
 356         #undef GENERIC_COMMAND
 357
 358         return FALSE;
 359 }
 360
 361 float GenericCommand_macro_usage(float argc)
 362 {
 363         #define GENERIC_COMMAND(name,function,description) \
 364                 { if(name == strtolower(argv(1))) { function; return TRUE; } }
 365
 366         GENERIC_COMMANDS(CMD_REQUEST_USAGE, argc, "")
 367         #undef GENERIC_COMMAND
 368
 369         return FALSE;
 370 }
 371
 372
 373 // ===========================================
 374 //  Main Common Function For Generic Commands
 375 // ===========================================
 376 // Commands spread out among all programs (menu, client, and server)
 377
 378 float GenericCommand(string command)
 379 {
 380         float argc = tokenize_console(command);
 381
 382         // Guide for working with argc arguments by example:
 383         // argc:   1    - 2      - 3     - 4
 384         // argv:   0    - 1      - 2     - 3
 385         // cmd     vote - master - login - password
 386
 387         if(strtolower(argv(0)) == "help")
 388         {
 389                 if(argc == 1)
 390                 {
 391                         GenericCommand_macro_help();
 392                         return TRUE;
 393                 }
 394                 else if(GenericCommand_macro_usage(argc)) // Instead of trying to call a command, we're going to see detailed information about it
 395                 {
 396                         return TRUE;
 397                 }
 398         }
 399         else if(GenericCommand_macro_command(argc)) // continue as usual and scan for normal commands
 400         {
 401                 return TRUE; // handled by one of the above LocalCommand_* functions
 402         }
 403         else if(argc >= 3 && argv(0) == "red")
 404         {
 405                 s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
 406                 localcmd(strcat(argv(1), " ", GameCommand_Markup(s)));
 407                 return TRUE;
 408         }
 409         else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)
 410         {
 411                 // other test case
 412                 s = strconv(2, 0, 0, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
 413
 414                 n = floor(random() * 6 + 2);
 415
 416                 s2 = "";
 417                 for(i = 0; i < n; ++i)
 418                 {
 419                         s2 = strcat(s2, "AH");
 420                 }
 421
 422                 if(random() < 0.1)
 423                         s2 = strcat(substring(s2, 1, strlen(s2) - 1), "A");
 424
 425                 if(s == "")
 426                         s = s2;
 427                 else
 428                         if(random() < 0.8)
 429                                 s = strcat(s, " ", s2);
 430                         else
 431                                 s = strcat(s2, " ", s);
 432
 433                 s2 = substring(s, strlen(s) - 2, 2);
 434                 if(s2 == "AH" || s2 == "AY")
 435                         s = strcat(s, "))");
 436                 else
 437                         s = strcat(s, " ))");
 438
 439                 if(random() < 0.1)
 440                         s = substring(s, 0, strlen(s) - 1);
 441
 442                 if(random() < 0.1)
 443                         s = strconv(1, 0, 0, s);
 444
 445                 localcmd(strcat(argv(1), " ", s));
 446
 447                 return TRUE;
 448         }
 449         else if(argc >= 3 && crc16(0, argv(0)) == 3826 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 55790)
 450         {
 451                 // test case for terencehill's color codes
 452                 s = strdecolorize(substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
 453                 s2 = "";
 454
 455                 n = strlen(s);
 456                 j = ((6 * max(1, floor(strlen(s)/32 + random() * 2 - 1))) / n) * (1 - 2 * (random() > 0.5));
 457                 f = random() * 6;
 458
 459                 for(i = 0; i < n; ++i)
 460                 {
 461                         c = substring(s, i, 1);
 462
 463                         if(c == ";")
 464                                 c = ":";
 465                         else if(c == "^")
 466                         {
 467                                 c = "^^";
 468                                 if(substring(s, i+1, 1) == "^")
 469                                         ++i;
 470                         }
 471
 472                         if(c != " ")
 473                         {
 474                                 rgb = hsl_to_rgb('1 0 0' * (j * i + f) + '0 1 .5');
 475                                 c = strcat(rgb_to_hexcolor(rgb), c);
 476                         }
 477                         s2 = strcat(s2, c);
 478                 }
 479
 480                 localcmd(strcat(argv(1), " ", s2));
 481
 482                 return TRUE;
 483         }
 484
 485         return FALSE;
 486 }