feat(DB/Module): introduce module_string table (#19475)

This commit is contained in:
Kitzunu
2024-08-13 19:53:16 +02:00
committed by GitHub
parent 67010623a0
commit 4b63aa9015
9 changed files with 176 additions and 0 deletions

View File

@@ -0,0 +1,21 @@
--
DROP TABLE IF EXISTS `module_string`;
CREATE TABLE IF NOT EXISTS `module_string` (
`module` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'module dir name, eg mod-cfbg',
`id` int unsigned NOT NULL,
`string` text CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
PRIMARY KEY (`module`, `id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
DROP TABLE IF EXISTS `module_string_locale`;
CREATE TABLE IF NOT EXISTS `module_string_locale` (
`module` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'Corresponds to an existing entry in module_string',
`id` int unsigned NOT NULL COMMENT 'Corresponds to an existing entry in module_string',
`locale` ENUM('koKR', 'frFR', 'deDE', 'zhCN', 'zhTW', 'esES', 'esMX', 'ruRU') NOT NULL,
`string` text CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
PRIMARY KEY (`module`, `id`, `locale`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
DELETE FROM `command` WHERE `name` = 'reload module_string';
INSERT INTO `command` (`name`, `security`, `help`) VALUES
('reload module_string', 3, 'Syntax: .reload module_string');

View File

@@ -45,6 +45,11 @@ char const* ChatHandler::GetAcoreString(uint32 entry) const
return m_session->GetAcoreString(entry);
}
std::string const* ChatHandler::GetModuleString(std::string module, uint32 id) const
{
return m_session->GetModuleString(module, id);
}
bool ChatHandler::IsAvailable(uint32 securityLevel) const
{
// check security level only for simple command (without child commands)

View File

@@ -158,6 +158,21 @@ public:
return Acore::StringFormatFmt(GetAcoreString(entry), std::forward<Args>(args)...);
}
std::string const* GetModuleString(std::string module, uint32 id) const;
template<typename... Args>
void PSendModuleSysMessage(std::string module, uint32 id, Args&&... args)
{
if (HasSession())
SendSysMessage(PGetParseModuleString(module, id, std::forward<Args>(args)...));
}
template<typename... Args>
std::string PGetParseModuleString(std::string module, uint32 id, Args&&... args) const
{
return Acore::StringFormatFmt(GetModuleString(module, id)->c_str(), std::forward<Args>(args)...);
}
void SendErrorMessage(uint32 entry);
void SendErrorMessage(std::string_view str, bool escapeCharacters);

View File

@@ -8544,6 +8544,98 @@ void ObjectMgr::LoadGameObjectForQuests()
LOG_INFO("server.loading", " ");
}
bool ObjectMgr::LoadModuleStrings()
{
uint32 oldMSTime = getMSTime();
_moduleStringStore.clear(); // for reload case
QueryResult result = WorldDatabase.Query("SELECT module, id, string FROM module_string");
if (!result)
{
LOG_WARN("server.loading", ">> Loaded 0 module strings. DB table `module_string` is empty.");
LOG_INFO("server.loading", " ");
return false;
}
do
{
Field* fields = result->Fetch();
std::string module = fields[0].Get<std::string>();
uint32 id = fields[1].Get<uint32>();
std::pair<std::string, uint32> pairKey = std::make_pair(module, id);
ModuleString& data = _moduleStringStore[pairKey];
AddLocaleString(fields[2].Get<std::string>(), LOCALE_enUS, data.Content);
} while (result->NextRow());
LOG_INFO("server.loading", ">> Loaded {} Module Strings in {} ms", _moduleStringStore.size(), GetMSTimeDiffToNow(oldMSTime));
LOG_INFO("server.loading", " ");
return true;
}
bool ObjectMgr::LoadModuleStringsLocale()
{
uint32 oldMSTime = getMSTime();
QueryResult result = WorldDatabase.Query("SELECT module, id, locale, string FROM module_string_locale");
if (!result)
{
LOG_WARN("server.loading", ">> Loaded 0 module strings locale. DB table `module_string_locale` is empty.");
LOG_INFO("server.loading", " ");
return false;
}
uint32 localeCount = 0;
do
{
Field* fields = result->Fetch();
std::string module = fields[0].Get<std::string>();
uint32 id = fields[1].Get<uint32>();
std::pair<std::string, uint32> pairKey = std::make_pair(module, id);
ModuleString& data = _moduleStringStore[pairKey];
ModuleStringContainer::iterator ms = _moduleStringStore.find(pairKey);
if (ms == _moduleStringStore.end())
{
LOG_ERROR("sql.sql", "ModuleString (Module: {} Id: {}) found in table `module_string_locale` but does not exist in `module_string`. Skipped!", module, id);
continue;
}
LocaleConstant locale = GetLocaleByName(fields[2].Get<std::string>());
if (locale == LOCALE_enUS)
continue;
AddLocaleString(fields[3].Get<std::string>(), locale, data.Content);
localeCount++;
} while (result->NextRow());
LOG_INFO("server.loading", ">> Loaded {} Module Strings Locales in {} ms", localeCount, GetMSTimeDiffToNow(oldMSTime));
LOG_INFO("server.loading", " ");
return true;
}
std::string const* ObjectMgr::GetModuleString(std::string module, uint32 id, LocaleConstant locale) const
{
ModuleString const* ms = GetModuleString(module, id);
if (ms->Content.size())
{
if (ms->Content.size() > size_t(locale) && !ms->Content[locale].empty())
return &ms->Content[locale];
return &ms->Content[DEFAULT_LOCALE];
}
LOG_ERROR("sql.sql", "Module string module {} id {} not found in DB.", module, id);
return (std::string*)"error";
}
bool ObjectMgr::LoadAcoreStrings()
{
uint32 oldMSTime = getMSTime();

View File

@@ -493,6 +493,11 @@ typedef std::unordered_map<uint32/*(mapid, spawnMode) pair*/, CellObjectGuidsMap
// Acore Trainer Reference start range
#define ACORE_TRAINER_START_REF 200000
struct ModuleString
{
std::vector<std::string> Content;
};
struct AcoreString
{
std::vector<std::string> Content;
@@ -511,6 +516,7 @@ typedef std::unordered_map<uint32, QuestOfferRewardLocale> QuestOfferRewardLocal
typedef std::unordered_map<uint32, QuestRequestItemsLocale> QuestRequestItemsLocaleContainer;
typedef std::unordered_map<uint32, NpcTextLocale> NpcTextLocaleContainer;
typedef std::unordered_map<uint32, PageTextLocale> PageTextLocaleContainer;
typedef std::map<std::pair<std::string, uint32>, ModuleString> ModuleStringContainer;
typedef std::unordered_map<int32, AcoreString> AcoreStringContainer;
typedef std::unordered_map<uint32, GossipMenuItemsLocale> GossipMenuItemsLocaleContainer;
typedef std::unordered_map<uint32, PointOfInterestLocale> PointOfInterestLocaleContainer;
@@ -1012,6 +1018,8 @@ public:
void ValidateSpellScripts();
void InitializeSpellInfoPrecomputedData();
bool LoadModuleStrings();
bool LoadModuleStringsLocale();
bool LoadAcoreStrings();
void LoadBroadcastTexts();
void LoadBroadcastTextLocales();
@@ -1310,6 +1318,17 @@ public:
GameObjectData& NewGOData(ObjectGuid::LowType guid) { return _gameObjectDataStore[guid]; }
void DeleteGOData(ObjectGuid::LowType guid);
[[nodiscard]] ModuleString const* GetModuleString(std::string module, uint32 id) const
{
std::pair<std::string, uint32> pairKey = std::make_pair(module, id);
ModuleStringContainer::const_iterator itr = _moduleStringStore.find(pairKey);
if (itr == _moduleStringStore.end())
return nullptr;
return &itr->second;
}
[[nodiscard]] std::string const* GetModuleString(std::string module, uint32 id, LocaleConstant locale) const;
[[nodiscard]] AcoreString const* GetAcoreString(uint32 entry) const
{
AcoreStringContainer::const_iterator itr = _acoreStringStore.find(entry);
@@ -1598,6 +1617,7 @@ private:
QuestRequestItemsLocaleContainer _questRequestItemsLocaleStore;
NpcTextLocaleContainer _npcTextLocaleStore;
PageTextLocaleContainer _pageTextLocaleStore;
ModuleStringContainer _moduleStringStore;
AcoreStringContainer _acoreStringStore;
GossipMenuItemsLocaleContainer _gossipMenuItemsLocaleStore;
PointOfInterestLocaleContainer _pointOfInterestLocaleStore;

View File

@@ -792,6 +792,11 @@ char const* WorldSession::GetAcoreString(uint32 entry) const
return sObjectMgr->GetAcoreString(entry, GetSessionDbLocaleIndex());
}
std::string const* WorldSession::GetModuleString(std::string module, uint32 id) const
{
return sObjectMgr->GetModuleString(module, id, GetSessionDbLocaleIndex());
}
void WorldSession::Handle_NULL(WorldPacket& null)
{
LOG_ERROR("network.opcode", "Received unhandled opcode {} from {}",

View File

@@ -497,6 +497,7 @@ public:
LocaleConstant GetSessionDbcLocale() const { return m_sessionDbcLocale; }
LocaleConstant GetSessionDbLocaleIndex() const { return m_sessionDbLocaleIndex; }
char const* GetAcoreString(uint32 entry) const;
std::string const* GetModuleString(std::string module, uint32 id) const;
uint32 GetLatency() const { return m_latency; }
void SetLatency(uint32 latency) { m_latency = latency; }

View File

@@ -1542,6 +1542,11 @@ void World::SetInitialWorldSettings()
if (!sObjectMgr->LoadAcoreStrings())
exit(1); // Error message displayed in function already
LOG_INFO("server.loading", "Loading Module Strings...");
sObjectMgr->LoadModuleStrings();
LOG_INFO("server.loading", "Loading Module Strings Locale...");
sObjectMgr->LoadModuleStringsLocale();
///- Update the realm entry in the database with the realm type from the config file
//No SQL injection as values are treated as integers

View File

@@ -166,6 +166,7 @@ public:
{ "spell_threats", HandleReloadSpellThreatsCommand, SEC_ADMINISTRATOR, Console::Yes },
{ "spell_group_stack_rules", HandleReloadSpellGroupStackRulesCommand, SEC_ADMINISTRATOR, Console::Yes },
{ "player_loot_template", HandleReloadLootTemplatesPlayerCommand, SEC_ADMINISTRATOR, Console::Yes },
{ "module_string", HandleReloadModuleStringCommand, SEC_ADMINISTRATOR, Console::Yes },
{ "acore_string", HandleReloadAcoreStringCommand, SEC_ADMINISTRATOR, Console::Yes },
{ "warden_action", HandleReloadWardenactionCommand, SEC_ADMINISTRATOR, Console::Yes },
{ "waypoint_scripts", HandleReloadWpScriptsCommand, SEC_ADMINISTRATOR, Console::Yes },
@@ -716,6 +717,17 @@ public:
return true;
}
static bool HandleReloadModuleStringCommand(ChatHandler* handler)
{
LOG_INFO("server.loading", "Reloading module_string Table!");
sObjectMgr->LoadModuleStrings();
handler->SendGlobalGMSysMessage("DB table `module_string` reloaded.");
LOG_INFO("server.loading", "Reloading module_string_locale Table!");
sObjectMgr->LoadModuleStringsLocale();
handler->SendGlobalGMSysMessage("DB table `module_string_locale` reloaded.");
return true;
}
static bool HandleReloadAcoreStringCommand(ChatHandler* handler)
{
LOG_INFO("server.loading", "Reloading acore_string Table!");