From 858326389688b92ef8416aeb41e91ac689f505ff Mon Sep 17 00:00:00 2001 From: Aokromes Date: Sat, 29 Jul 2017 10:51:58 +0200 Subject: [PATCH] Core/Chat: Provide a fully-formed protocol for addons to interact with GM commands Send success/fail state, allow interleaving, and indicate end of output. Add framework for supporting non-human-readable output in commands. --- src/server/game/Chat/Chat.cpp | 154 +++++++++++++++++++---- src/server/game/Chat/Chat.h | 25 +++- src/server/game/Handlers/ChatHandler.cpp | 10 +- 3 files changed, 162 insertions(+), 27 deletions(-) diff --git a/src/server/game/Chat/Chat.cpp b/src/server/game/Chat/Chat.cpp index 606e0d0c484..b652f52529d 100644 --- a/src/server/game/Chat/Chat.cpp +++ b/src/server/game/Chat/Chat.cpp @@ -32,6 +32,7 @@ #include "ScriptMgr.h" #include "ChatLink.h" #include "Group.h" +#include // Lazy loading of the command table cache from commands and the // ScriptMgr should be thread safe since the player commands, @@ -330,6 +331,7 @@ bool ChatHandler::ExecuteCommandInTable(std::vector const& table, c SendSysMessage(table[i].Help.c_str()); else SendSysMessage(LANG_CMD_SYNTAX); + SetSentErrorMessage(true); } return true; @@ -393,41 +395,38 @@ bool ChatHandler::SetDataForCommandInTable(std::vector& table, char return false; } +bool ChatHandler::_ParseCommands(char const* text) +{ + if (ExecuteCommandInTable(getCommandTable(), text, text)) + return true; + + // Pretend commands don't exist for regular players + if (m_session && !m_session->HasPermission(rbac::RBAC_PERM_COMMANDS_NOTIFY_COMMAND_NOT_FOUND_ERROR)) + return false; + + // Send error message for GMs + SendSysMessage(LANG_NO_CMD); + SetSentErrorMessage(true); + return true; +} + bool ChatHandler::ParseCommands(char const* text) { ASSERT(text); ASSERT(*text); - std::string fullcmd = text; - /// chat case (.command or !command format) - if (m_session) - { - if (text[0] != '!' && text[0] != '.') - return false; - } + if (text[0] != '!' && text[0] != '.') + return false; /// ignore single . and ! in line - if (strlen(text) < 2) + if (!text[1]) return false; - // original `text` can't be used. It content destroyed in command code processing. /// ignore messages staring from many dots. - if ((text[0] == '.' && text[1] == '.') || (text[0] == '!' && text[1] == '!')) + if (text[1] == '!' || text[1] == '.') return false; - - /// skip first . or ! (in console allowed use command with . and ! and without its) - if (text[0] == '!' || text[0] == '.') - ++text; - - if (!ExecuteCommandInTable(getCommandTable(), text, fullcmd)) - { - if (m_session && !m_session->HasPermission(rbac::RBAC_PERM_COMMANDS_NOTIFY_COMMAND_NOT_FOUND_ERROR)) - return false; - - SendSysMessage(LANG_NO_CMD); - } - return true; + return _ParseCommands(text+1); } bool ChatHandler::isValidChatMessage(char const* message) @@ -1236,6 +1235,16 @@ void CliHandler::SendSysMessage(const char *str, bool /*escapeCharacters*/) m_print(m_callbackArg, "\r\n"); } +bool CliHandler::ParseCommands(char const* str) +{ + if (!str[0]) + return false; + // Console allows using commands both with and without leading indicator + if (str[0] == '.' || str[0] == '!') + ++str; + return _ParseCommands(str); +} + std::string CliHandler::GetNameLink() const { return GetTrinityString(LANG_CONSOLE_COMMAND); @@ -1299,3 +1308,102 @@ int CliHandler::GetSessionDbLocaleIndex() const { return sObjectMgr->GetDBCLocaleIndex(); } + +bool AddonChannelCommandHandler::ParseCommands(char const* str) +{ + if (memcmp(str, "TrinityCore\t", 12)) + return false; + char opcode = str[12]; + if (!opcode) // str[12] is opcode + return false; + if (!str[13] || !str[14] || !str[15] || !str[16]) // str[13] through str[16] is 4-character command counter + return false; + echo = str+13; + + switch (opcode) + { + case 'p': // p Ping + SendAck(); + return true; + case 'h': // h Issue human-readable command + case 'i': // i Issue command + if (!str[17]) + return false; + humanReadable = (opcode == 'h'); + if (_ParseCommands(str + 17)) // actual command starts at str[17] + { + if (!hadAck) + SendAck(); + if (HasSentErrorMessage()) + SendFailed(); + else + SendOK(); + } + else + { + SendSysMessage(LANG_NO_CMD); + SendFailed(); + } + return true; + default: + return false; + } +} + +void AddonChannelCommandHandler::Send(std::string const& msg) +{ + WorldPacket data; + ChatHandler::BuildChatPacket(data, CHAT_MSG_WHISPER, LANG_ADDON, GetSession()->GetPlayer(), GetSession()->GetPlayer(), msg); + GetSession()->SendPacket(&data); +} + +void AddonChannelCommandHandler::SendAck() // a Command acknowledged, no body +{ + ASSERT(echo); + char ack[18] = "TrinityCore\ta"; + memcpy(ack+13, echo, 4); + ack[17] = '\0'; + Send(ack); + hadAck = true; +} + +void AddonChannelCommandHandler::SendOK() // o Command OK, no body +{ + ASSERT(echo); + char ok[18] = "TrinityCore\to"; + memcpy(ok+13, echo, 4); + ok[17] = '\0'; + Send(ok); +} + +void AddonChannelCommandHandler::SendFailed() // f Command failed, no body +{ + ASSERT(echo); + char fail[18] = "TrinityCore\tf"; + memcpy(fail + 13, echo, 4); + fail[17] = '\0'; + Send(fail); +} + +// m Command message, message in body +void AddonChannelCommandHandler::SendSysMessage(char const* str, bool escapeCharacters) +{ + ASSERT(echo); + if (!hadAck) + SendAck(); + + std::string msg = "TrinityCore\tm"; + msg.append(echo, 4); + std::string body(str); + if (escapeCharacters) + boost::replace_all(body, "|", "||"); + size_t pos, lastpos; + for (lastpos = 0, pos = body.find('\n', lastpos); pos != std::string::npos; lastpos = pos + 1, pos = body.find('\n', lastpos)) + { + std::string line(msg); + line.append(body, lastpos, pos - lastpos); + Send(line); + } + msg.append(body, lastpos, pos - lastpos); + Send(msg); +} diff --git a/src/server/game/Chat/Chat.h b/src/server/game/Chat/Chat.h index 39ed70fb384..8b8e15b813b 100644 --- a/src/server/game/Chat/Chat.h +++ b/src/server/game/Chat/Chat.h @@ -94,7 +94,8 @@ class TC_GAME_API ChatHandler return Trinity::StringFormat(GetTrinityString(entry), std::forward(args)...); } - bool ParseCommands(char const* text); + bool _ParseCommands(char const* text); + virtual bool ParseCommands(char const* text); static std::vector const& getCommandTable(); static void invalidateCommandTable(); @@ -106,6 +107,7 @@ class TC_GAME_API ChatHandler // function with different implementation for chat/console virtual bool isAvailable(ChatCommand const& cmd) const; + virtual bool IsHumanReadable() const { return true; } virtual bool HasPermission(uint32 permission) const { return m_session->HasPermission(permission); } virtual std::string GetNameLink() const { return GetNameLink(m_session->GetPlayer()); } virtual bool needReportToTarget(Player* chr) const; @@ -172,6 +174,7 @@ class TC_GAME_API CliHandler : public ChatHandler bool isAvailable(ChatCommand const& cmd) const override; bool HasPermission(uint32 /*permission*/) const override { return true; } void SendSysMessage(const char *str, bool escapeCharacters) override; + bool ParseCommands(char const* str) override; std::string GetNameLink() const override; bool needReportToTarget(Player* chr) const override; LocaleConstant GetSessionDbcLocale() const override; @@ -182,4 +185,24 @@ class TC_GAME_API CliHandler : public ChatHandler Print* m_print; }; +class TC_GAME_API AddonChannelCommandHandler : public ChatHandler +{ + public: + using ChatHandler::ChatHandler; + bool ParseCommands(char const* str) override; + void SendSysMessage(char const* str, bool escapeCharacters) override; + using ChatHandler::SendSysMessage; + bool IsHumanReadable() const override { return humanReadable; } + + private: + void Send(std::string const& msg); + void SendAck(); + void SendOK(); + void SendFailed(); + + char const* echo = nullptr; + bool hadAck = false; + bool humanReadable = false; +}; + #endif diff --git a/src/server/game/Handlers/ChatHandler.cpp b/src/server/game/Handlers/ChatHandler.cpp index 25e165c5cac..59e7382d068 100644 --- a/src/server/game/Handlers/ChatHandler.cpp +++ b/src/server/game/Handlers/ChatHandler.cpp @@ -272,11 +272,15 @@ void WorldSession::HandleMessagechatOpcode(WorldPacket& recvData) if (msg.empty()) return; - if (ChatHandler(this).ParseCommands(msg.c_str())) - return; - + if (lang == LANG_ADDON) + { + if (AddonChannelCommandHandler(this).ParseCommands(msg.c_str())) + return; + } if (lang != LANG_ADDON) { + if (ChatHandler(this).ParseCommands(msg.c_str())) + return; // Strip invisible characters for non-addon messages if (sWorld->getBoolConfig(CONFIG_CHAT_FAKE_MESSAGE_PREVENTING)) stripLineInvisibleChars(msg);