Kelsidavis-WoWee/tools/editor/cli_chat_commands_catalog.cpp
Kelsi 5f5a696495 feat(pipeline): WCMD chat slash command catalog (143rd open format)
Novel replacement for the implicit slash-command registry
vanilla WoW carried in the client's ChatFrame.lua + server-side
per-command CommandHandler hooks (no formal data-driven catalog;
commands were registered ad-hoc with hard-coded security checks
scattered across LevelMgr / WorldMgr / CharacterMgr). Each WCMD
entry binds one command name to its aliases, minimum security
level required, argument schema string, help text, per-player
throttle in ms, hidden flag (for debug-only commands), and
category.

Three presets covering the security-tier spectrum:
  --gen-cmd-basic     4 standard player Info commands (/who
                      /played /time /ginfo) at Player security
                      with no throttle
  --gen-cmd-movement  3 emote-style Movement commands (/sit
                      /stand /sleep) with short typing-speed
                      aliases ("sd" / "su" / "sd")
  --gen-cmd-admin     3 GameMaster-only Admin commands
                      (/announce 5s throttle / /kick 2s
                      throttle / /ban 10s throttle —
                      demonstrating per-command rate-limiting
                      to prevent admin-spam abuse)

Validator catches: id+command required, minSecurityLevel 0..4,
category 0..4, no duplicate cmdIds. CRITICAL: command names
AND aliases share one flat namespace (chat parser dispatches
uniformly by typed string) — duplicate name across canonical+
aliases errors. Warns on uppercase chars in names (parser is
case-insensitive but convention is lowercase), Admin-category
command at Player/Helper security level (likely security
misconfiguration — admin commands usually require GameMaster+),
throttleMs > 60000 (likely ms-vs-s units typo — 60+ second
throttle is nearly unusable), self-alias (canonical already
matches), and empty helpText (/help would show the command
without description).

Format count 142 -> 143. CLI flag count 1481 -> 1488.
2026-05-10 05:47:23 -07:00

337 lines
12 KiB
C++

#include "cli_chat_commands_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_chat_commands.hpp"
#include <nlohmann/json.hpp>
#include <cctype>
#include <cstdint>
#include <cstdio>
#include <cstring>
#include <fstream>
#include <set>
#include <string>
#include <vector>
namespace wowee {
namespace editor {
namespace cli {
namespace {
std::string stripWcmdExt(std::string base) {
stripExt(base, ".wcmd");
return base;
}
const char* securityLevelName(uint8_t s) {
using W = wowee::pipeline::WoweeChatCommands;
switch (s) {
case W::Player: return "player";
case W::Helper: return "helper";
case W::Moderator: return "moderator";
case W::GameMaster: return "gamemaster";
case W::Admin: return "admin";
default: return "?";
}
}
const char* categoryName(uint8_t c) {
using W = wowee::pipeline::WoweeChatCommands;
switch (c) {
case W::Info: return "info";
case W::Movement: return "movement";
case W::Communication: return "communication";
case W::AdminCmd: return "admincmd";
case W::Debug: return "debug";
default: return "?";
}
}
bool saveOrError(const wowee::pipeline::WoweeChatCommands& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeChatCommandsLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.wcmd\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeChatCommands& c,
const std::string& base) {
std::printf("Wrote %s.wcmd\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" commands: %zu\n", c.entries.size());
}
int handleGenBasic(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "BasicChatCommands";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWcmdExt(base);
auto c = wowee::pipeline::WoweeChatCommandsLoader::
makeBasicCommands(name);
if (!saveOrError(c, base, "gen-cmd-basic")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenMovement(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "MovementChatCommands";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWcmdExt(base);
auto c = wowee::pipeline::WoweeChatCommandsLoader::
makeMovementCommands(name);
if (!saveOrError(c, base, "gen-cmd-movement")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenAdmin(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "AdminChatCommands";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWcmdExt(base);
auto c = wowee::pipeline::WoweeChatCommandsLoader::
makeAdminCommands(name);
if (!saveOrError(c, base, "gen-cmd-admin")) return 1;
printGenSummary(c, base);
return 0;
}
int handleInfo(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWcmdExt(base);
if (!wowee::pipeline::WoweeChatCommandsLoader::exists(base)) {
std::fprintf(stderr, "WCMD not found: %s.wcmd\n",
base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeChatCommandsLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["wcmd"] = base + ".wcmd";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"cmdId", e.cmdId},
{"command", e.command},
{"minSecurityLevel", e.minSecurityLevel},
{"minSecurityLevelName",
securityLevelName(e.minSecurityLevel)},
{"category", e.category},
{"categoryName",
categoryName(e.category)},
{"isHidden", e.isHidden != 0},
{"throttleMs", e.throttleMs},
{"argSchema", e.argSchema},
{"helpText", e.helpText},
{"aliases", e.aliases},
});
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WCMD: %s.wcmd\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" commands: %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id /command security category hide throttleMs aliases argSchema\n");
for (const auto& e : c.entries) {
std::printf(" %4u /%-15s %-10s %-13s %s %8u %5zu %s\n",
e.cmdId, e.command.c_str(),
securityLevelName(e.minSecurityLevel),
categoryName(e.category),
e.isHidden ? "Y" : "n",
e.throttleMs,
e.aliases.size(),
e.argSchema.c_str());
}
return 0;
}
int handleValidate(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWcmdExt(base);
if (!wowee::pipeline::WoweeChatCommandsLoader::exists(base)) {
std::fprintf(stderr,
"validate-wcmd: WCMD not found: %s.wcmd\n",
base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeChatCommandsLoader::load(base);
std::vector<std::string> errors;
std::vector<std::string> warnings;
if (c.entries.empty()) {
warnings.push_back("catalog has zero entries");
}
std::set<uint32_t> idsSeen;
// Per-name uniqueness: tracks ALL command names
// (canonical + aliases) since chat parser
// dispatches uniformly.
std::set<std::string> allNamesSeen;
auto addName = [&](const std::string& nm,
const std::string& ctx,
const std::string& source) {
if (nm.empty()) return;
if (!allNamesSeen.insert(nm).second) {
errors.push_back(ctx +
": " + source + " '" + nm +
"' collides with another command name "
"or alias — chat parser would dispatch "
"ambiguously");
}
// Lowercase check: chat parser is case-
// insensitive but storing canonical lowercase
// is the convention.
for (char ch : nm) {
if (ch >= 'A' && ch <= 'Z') {
warnings.push_back(ctx +
": " + source + " '" + nm +
"' contains uppercase — convention "
"is canonical lowercase (chat parser "
"is case-insensitive)");
break;
}
}
};
for (size_t k = 0; k < c.entries.size(); ++k) {
const auto& e = c.entries[k];
std::string ctx = "entry " + std::to_string(k) +
" (cmdId=" + std::to_string(e.cmdId);
if (!e.command.empty())
ctx += " /" + e.command;
ctx += ")";
if (e.cmdId == 0)
errors.push_back(ctx + ": cmdId is 0");
if (e.command.empty())
errors.push_back(ctx +
": command name is empty");
if (e.minSecurityLevel > 4) {
errors.push_back(ctx +
": minSecurityLevel " +
std::to_string(e.minSecurityLevel) +
" out of range (0..4)");
}
if (e.category > 4) {
errors.push_back(ctx + ": category " +
std::to_string(e.category) +
" out of range (0..4)");
}
if (e.helpText.empty()) {
warnings.push_back(ctx +
": helpText is empty — /help would "
"show this command without "
"description");
}
// Throttle > 60s is almost certainly a typo
// (units mismatch — milliseconds vs seconds).
if (e.throttleMs > 60000) {
warnings.push_back(ctx +
": throttleMs=" +
std::to_string(e.throttleMs) +
" exceeds 60000ms (60s) — verify "
"intentional or check units (ms vs s "
"typo)");
}
// Admin-category command at Player security
// level is a security hole — warn.
using W = wowee::pipeline::WoweeChatCommands;
if (e.category == W::AdminCmd &&
e.minSecurityLevel <= W::Helper) {
warnings.push_back(ctx +
": Admin category command at security "
"level " +
std::to_string(e.minSecurityLevel) +
" (Player/Helper) — likely security "
"misconfiguration; admin commands "
"usually require GameMaster+");
}
// Per-name uniqueness check (canonical +
// aliases share same flat namespace).
addName(e.command, ctx, "command");
for (const auto& a : e.aliases) {
addName(a, ctx, "alias");
// Self-alias is meaningless (canonical
// already matches).
if (a == e.command) {
warnings.push_back(ctx +
": alias '" + a + "' equals "
"canonical command name — "
"redundant entry");
}
}
if (!idsSeen.insert(e.cmdId).second) {
errors.push_back(ctx + ": duplicate cmdId");
}
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["wcmd"] = base + ".wcmd";
j["ok"] = ok;
j["errors"] = errors;
j["warnings"] = warnings;
std::printf("%s\n", j.dump(2).c_str());
return ok ? 0 : 1;
}
std::printf("validate-wcmd: %s.wcmd\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu commands, all cmdIds + "
"names + aliases unique across flat "
"namespace, security 0..4, category "
"0..4, all command/alias names "
"lowercase\n",
c.entries.size());
return 0;
}
if (!warnings.empty()) {
std::printf(" warnings (%zu):\n", warnings.size());
for (const auto& w : warnings)
std::printf(" - %s\n", w.c_str());
}
if (!errors.empty()) {
std::printf(" ERRORS (%zu):\n", errors.size());
for (const auto& e : errors)
std::printf(" - %s\n", e.c_str());
}
return ok ? 0 : 1;
}
} // namespace
bool handleChatCommandsCatalog(int& i, int argc, char** argv,
int& outRc) {
if (std::strcmp(argv[i], "--gen-cmd-basic") == 0 &&
i + 1 < argc) {
outRc = handleGenBasic(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-cmd-movement") == 0 &&
i + 1 < argc) {
outRc = handleGenMovement(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-cmd-admin") == 0 &&
i + 1 < argc) {
outRc = handleGenAdmin(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-wcmd") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-wcmd") == 0 &&
i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee