CharacterDatabaseCleaner Namespace Reference

Enumerations
enum	CleaningFlags {   CLEANING_FLAG_ACHIEVEMENT_PROGRESS = 0x1, CLEANING_FLAG_SKILLS = 0x2, CLEANING_FLAG_SPELLS = 0x4, CLEANING_FLAG_TALENTS = 0x8,   CLEANING_FLAG_QUESTSTATUS = 0x10 }

Functions
TC_GAME_API void	CleanDatabase ()
TC_GAME_API void	CheckUnique (const char *column, const char *table, bool(*check)(uint32))
TC_GAME_API bool	AchievementProgressCheck (uint32 criteria)
TC_GAME_API bool	SkillCheck (uint32 skill)
TC_GAME_API bool	SpellCheck (uint32 spell_id)
TC_GAME_API bool	TalentCheck (uint32 talent_id)
TC_GAME_API void	CleanCharacterAchievementProgress ()
TC_GAME_API void	CleanCharacterSkills ()
TC_GAME_API void	CleanCharacterSpell ()
TC_GAME_API void	CleanCharacterTalent ()
TC_GAME_API void	CleanCharacterQuestStatus ()

Enumeration Type Documentation

enum CharacterDatabaseCleaner::CleaningFlags

Enumerator
CLEANING_FLAG_ACHIEVEMENT_PROGRESS
CLEANING_FLAG_SKILLS
CLEANING_FLAG_SPELLS
CLEANING_FLAG_TALENTS
CLEANING_FLAG_QUESTSTATUS

 {
 CLEANING_FLAG_ACHIEVEMENT_PROGRESS = 0x1,
 CLEANING_FLAG_SKILLS = 0x2,
 CLEANING_FLAG_SPELLS = 0x4,
 CLEANING_FLAG_TALENTS = 0x8,
 CLEANING_FLAG_QUESTSTATUS = 0x10
 };

Function Documentation

bool CharacterDatabaseCleaner::AchievementProgressCheck

(

uint32

criteria

)

{
 return sAchievementMgr->GetAchievementCriteria(criteria) != nullptr;
}

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CheckUnique	(	const char *	column,
		const char *	table,
		bool(*)(uint32)	check
	)

{
 QueryResult result = CharacterDatabase.PQuery("SELECT DISTINCT %s FROM %s", column, table);
 if (!result)
 {
 TC_LOG_INFO("misc", "Table %s 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());
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CleanCharacterAchievementProgress

(

)

{
 CheckUnique("criteria", "character_achievement_progress", &AchievementProgressCheck);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CleanCharacterQuestStatus

(

)

{
 CharacterDatabase.DirectExecute("DELETE FROM character_queststatus WHERE status = 0");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CleanCharacterSkills

(

)

{
 CheckUnique("skill", "character_skills", &SkillCheck);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CleanCharacterSpell

(

)

{
 CheckUnique("spell", "character_spell", &SpellCheck);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CleanCharacterTalent

(

)

{
 CharacterDatabase.DirectPExecute("DELETE FROM character_talent WHERE spec > %u", MAX_TALENT_GROUPS);
 CheckUnique("spell", "character_talent", &TalentCheck);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CharacterDatabaseCleaner::CleanDatabase

(

)

{
 // config to disable
 if (!sWorld->getBoolConfig(CONFIG_CLEAN_CHARACTER_DB))
 return;

 TC_LOG_INFO("misc", "Cleaning character database...");

 uint32 oldMSTime = getMSTime();

 // check flags which clean ups are necessary
 QueryResult result = CharacterDatabase.PQuery("SELECT value FROM worldstates WHERE entry = %d", WS_CLEANING_FLAGS);
 if (!result)
 return;

 uint32 flags = (*result)[0].GetUInt32();

 // 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);
 CharacterDatabase.DirectPExecute("UPDATE worldstates SET value = %u WHERE entry = %d", flags, WS_CLEANING_FLAGS);

 sWorld->SetCleaningFlags(flags);

 TC_LOG_INFO("server.loading", ">> Cleaned character database in %u ms", GetMSTimeDiffToNow(oldMSTime));
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool CharacterDatabaseCleaner::SkillCheck

(

uint32

skill

)

{
 return sSkillLineStore.LookupEntry(skill) != nullptr;
}

Here is the caller graph for this function:

bool CharacterDatabaseCleaner::SpellCheck

(

uint32

spell_id

)

{
 SpellInfo const* spellInfo = sSpellMgr->GetSpellInfo(spell_id);
 return spellInfo && !spellInfo->HasAttribute(SPELL_ATTR0_CU_IS_TALENT);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool CharacterDatabaseCleaner::TalentCheck

(

uint32

talent_id

)

{
 TalentEntry const* talentInfo = sTalentStore.LookupEntry(talent_id);
 if (!talentInfo)
 return false;

 return sChrSpecializationStore.LookupEntry(talentInfo->SpecID) != nullptr;
}

Here is the caller graph for this function: