CharacterDatabaseCleaner.cpp

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "Common.h"
#include "CriteriaHandler.h"
#include "CharacterDatabaseCleaner.h"
#include "DatabaseEnv.h"
#include "DB2Stores.h"
#include "Log.h"
#include "World.h"
#include "SpellMgr.h"
#include "SpellInfo.h"
#include <sstream>
 
void CharacterDatabaseCleaner::CleanDatabase()
{
 // config to disable
 if (!sWorld->getBoolConfig(CONFIG_CLEAN_CHARACTER_DB))
 return;
 
 TC_LOG_INFO("misc", "Cleaning character database...");
 
 uint32 oldMSTime = getMSTime();
 
 uint32 flags = sWorld->GetPersistentWorldVariable(World::CharacterDatabaseCleaningFlagsVarId);
 
 // clean up
 if (flags & CLEANING_FLAG_ACHIEVEMENT_PROGRESS)
 CleanCharacterAchievementProgress();
 
 if (flags & CLEANING_FLAG_SKILLS)
 CleanCharacterSkills();
 
 if (flags & CLEANING_FLAG_SPELLS)
 CleanCharacterSpell();
 
 if (flags & CLEANING_FLAG_TALENTS)
 CleanCharacterTalent();
 
 if (flags & CLEANING_FLAG_QUESTSTATUS)
 CleanCharacterQuestStatus();
 
 // NOTE: In order to have persistentFlags be set in worldstates for the next cleanup,
 // you need to define them at least once in worldstates.
 flags &= sWorld->getIntConfig(CONFIG_PERSISTENT_CHARACTER_CLEAN_FLAGS);
 sWorld->SetPersistentWorldVariable(World::CharacterDatabaseCleaningFlagsVarId, flags);
 
 sWorld->SetCleaningFlags(flags);
 
 TC_LOG_INFO("server.loading", ">> Cleaned character database in {} ms", GetMSTimeDiffToNow(oldMSTime));
}
 
void CharacterDatabaseCleaner::CheckUnique(char const* column, char const* table, bool (*check)(uint32))
{
 QueryResult result = CharacterDatabase.PQuery("SELECT DISTINCT {} FROM {}", column, table);
 if (!result)
 {
 TC_LOG_INFO("misc", "Table {} is empty.", table);
 return;
 }
 
 bool found = false;
 std::ostringstream ss;
 do
 {
 Field* fields = result->Fetch();
 
 uint32 id = fields[0].GetUInt32();
 
 if (!check(id))
 {
 if (!found)
 {
 ss << "DELETE FROM " << table << " WHERE " << column << " IN (";
 found = true;
 }
 else
 ss << ',';
 
 ss << id;
 }
 }
 while (result->NextRow());
 
 if (found)
 {
 ss << ')';
 CharacterDatabase.Execute(ss.str().c_str());
 }
}
 
bool CharacterDatabaseCleaner::AchievementProgressCheck(uint32 criteria)
{
 return sCriteriaMgr->GetCriteria(criteria) != nullptr;
}
 
void CharacterDatabaseCleaner::CleanCharacterAchievementProgress()
{
 CheckUnique("criteria", "character_achievement_progress", &AchievementProgressCheck);
}
 
bool CharacterDatabaseCleaner::SkillCheck(uint32 skill)
{
 return sSkillLineStore.LookupEntry(skill) != nullptr;
}
 
void CharacterDatabaseCleaner::CleanCharacterSkills()
{
 CheckUnique("skill", "character_skills", &SkillCheck);
}
 
bool CharacterDatabaseCleaner::SpellCheck(uint32 spell_id)
{
 SpellInfo const* spellInfo = sSpellMgr->GetSpellInfo(spell_id, DIFFICULTY_NONE);
 return spellInfo && !spellInfo->HasAttribute(SPELL_ATTR0_CU_IS_TALENT);
}
 
void CharacterDatabaseCleaner::CleanCharacterSpell()
{
 CheckUnique("spell", "character_spell", &SpellCheck);
}
 
bool CharacterDatabaseCleaner::TalentCheck(uint32 talent_id)
{
 TalentEntry const* talentInfo = sTalentStore.LookupEntry(talent_id);
 if (!talentInfo)
 return false;
 
 return sChrSpecializationStore.LookupEntry(talentInfo->SpecID) != nullptr;
}
 
void CharacterDatabaseCleaner::CleanCharacterTalent()
{
 CharacterDatabase.DirectPExecute("DELETE FROM character_talent WHERE talentGroup > {}", MAX_SPECIALIZATIONS);
 CheckUnique("talentId", "character_talent", &TalentCheck);
}
 
void CharacterDatabaseCleaner::CleanCharacterQuestStatus()
{
 CharacterDatabase.DirectExecute("DELETE FROM character_queststatus WHERE status = 0");
}