BanMgr Class Reference

#include "BanMgr.h"

Public Member Functions
BanReturn	BanAccount (std::string const &AccountName, std::string const &Duration, std::string const &Reason, std::string const &Author)
	Ban an account, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.
BanReturn	BanAccountByPlayerName (std::string const &CharacterName, std::string const &Duration, std::string const &Reason, std::string const &Author)
	Ban an account by player name, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.
BanReturn	BanIP (std::string const &IP, std::string const &Duration, std::string const &Reason, std::string const &Author)
	Ban an IP address, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.
BanReturn	BanCharacter (std::string const &CharacterName, std::string const &Duration, std::string const &Reason, std::string const &Author)
	Ban an character, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.
bool	RemoveBanAccount (std::string const &AccountName)
	Remove a ban from an account.
bool	RemoveBanAccountByPlayerName (std::string const &CharacterName)
	Remove a ban from an player name.
bool	RemoveBanIP (std::string const &IP)
	Remove a ban from an account.
bool	RemoveBanCharacter (std::string const &CharacterName)
	Remove a ban from a character.

Static Public Member Functions
static BanMgr *	instance ()

Detailed Description

Member Function Documentation

BanAccount()

BanReturn BanMgr::BanAccount	(	std::string const &	AccountName,
		std::string const &	Duration,
		std::string const &	Reason,
		std::string const &	Author
	)

Ban an account, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.

• Disconnect all affected players (for IP it can be several)

{
    if (AccountName.empty() || Duration.empty())
        return BAN_SYNTAX_ERROR;
 
    uint32 DurationSecs = TimeStringToSecs(Duration);
 
    uint32 AccountID = AccountMgr::GetId(AccountName);
    if (!AccountID)
        return BAN_NOTFOUND;
 
    LoginDatabaseTransaction trans = LoginDatabase.BeginTransaction();
 
    // pussywizard: check existing ban to prevent overriding by a shorter one! >_>
    LoginDatabasePreparedStatement* stmtAccountBanned = LoginDatabase.GetPreparedStatement(LOGIN_SEL_ACCOUNT_BANNED);
    stmtAccountBanned->SetData(0, AccountID);
 
    PreparedQueryResult banresult = LoginDatabase.Query(stmtAccountBanned);
    if (banresult && ((*banresult)[0].Get<uint32>() == (*banresult)[1].Get<uint32>() || ((*banresult)[1].Get<uint32>() > GameTime::GetGameTime().count() + DurationSecs && DurationSecs)))
        return BAN_LONGER_EXISTS;
 
    // make sure there is only one active ban
    LoginDatabasePreparedStatement* stmt = LoginDatabase.GetPreparedStatement(LOGIN_UPD_ACCOUNT_NOT_BANNED);
    stmt->SetData(0, AccountID);
    trans->Append(stmt);
 
    // No SQL injection with prepared statements
    stmt = LoginDatabase.GetPreparedStatement(LOGIN_INS_ACCOUNT_BANNED);
    stmt->SetData(0, AccountID);
    stmt->SetData(1, DurationSecs);
    stmt->SetData(2, Author);
    stmt->SetData(3, Reason);
    trans->Append(stmt);
 
    if (WorldSession* session = sWorldSessionMgr->FindSession(AccountID))
        if (session->GetPlayerName() != Author)
            session->KickPlayer("Ban Account at condition 'FindSession(account)->GetPlayerName() != author'");
 
    if (WorldSession* session = sWorldSessionMgr->FindOfflineSession(AccountID))
        if (session->GetPlayerName() != Author)
            session->KickPlayer("Ban Account at condition 'FindOfflineSession(account)->GetPlayerName() != author'");
 
    LoginDatabase.CommitTransaction(trans);
 
    if (sWorld->getBoolConfig(CONFIG_SHOW_BAN_IN_WORLD))
    {
        bool IsPermanetly = true;
 
        if (TimeStringToSecs(Duration) > 0)
            IsPermanetly = false;
 
        if (!IsPermanetly)
            ChatHandler(nullptr).SendWorldText(LANG_BAN_ACCOUNT_YOUBANNEDMESSAGE_WORLD, Author, AccountName, secsToTimeString(TimeStringToSecs(Duration), true), Reason);
        else
            ChatHandler(nullptr).SendWorldText(LANG_BAN_ACCOUNT_YOUPERMBANNEDMESSAGE_WORLD, Author, AccountName, Reason);
    }
 
    return BAN_SUCCESS;
}

References BAN_LONGER_EXISTS, BAN_NOTFOUND, BAN_SUCCESS, BAN_SYNTAX_ERROR, CONFIG_SHOW_BAN_IN_WORLD, GameTime::GetGameTime(), AccountMgr::GetId(), LANG_BAN_ACCOUNT_YOUBANNEDMESSAGE_WORLD, LANG_BAN_ACCOUNT_YOUPERMBANNEDMESSAGE_WORLD, LOGIN_INS_ACCOUNT_BANNED, LOGIN_SEL_ACCOUNT_BANNED, LOGIN_UPD_ACCOUNT_NOT_BANNED, LoginDatabase, secsToTimeString(), ChatHandler::SendWorldText(), PreparedStatementBase::SetData(), sWorld, sWorldSessionMgr, and TimeStringToSecs().

BanAccountByPlayerName()

BanReturn BanMgr::BanAccountByPlayerName	(	std::string const &	CharacterName,
		std::string const &	Duration,
		std::string const &	Reason,
		std::string const &	Author
	)

Ban an account by player name, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.

• Disconnect all affected players (for IP it can be several)

{
    if (CharacterName.empty() || Duration.empty())
        return BAN_SYNTAX_ERROR;
 
    uint32 DurationSecs = TimeStringToSecs(Duration);
 
    uint32 AccountID = sCharacterCache->GetCharacterAccountIdByName(CharacterName);
    if (!AccountID)
        return BAN_NOTFOUND;
 
    LoginDatabaseTransaction trans = LoginDatabase.BeginTransaction();
 
    // pussywizard: check existing ban to prevent overriding by a shorter one! >_>
    LoginDatabasePreparedStatement* stmtAccountBanned = LoginDatabase.GetPreparedStatement(LOGIN_SEL_ACCOUNT_BANNED);
    stmtAccountBanned->SetData(0, AccountID);
 
    PreparedQueryResult banresult = LoginDatabase.Query(stmtAccountBanned);
    if (banresult && ((*banresult)[0].Get<uint32>() == (*banresult)[1].Get<uint32>() || ((*banresult)[1].Get<uint32>() > GameTime::GetGameTime().count() + DurationSecs && DurationSecs)))
        return BAN_LONGER_EXISTS;
 
    // make sure there is only one active ban
    LoginDatabasePreparedStatement* stmt = LoginDatabase.GetPreparedStatement(LOGIN_UPD_ACCOUNT_NOT_BANNED);
    stmt->SetData(0, AccountID);
    trans->Append(stmt);
 
    // No SQL injection with prepared statements
    stmt = LoginDatabase.GetPreparedStatement(LOGIN_INS_ACCOUNT_BANNED);
    stmt->SetData(0, AccountID);
    stmt->SetData(1, DurationSecs);
    stmt->SetData(2, Author);
    stmt->SetData(3, Reason);
    trans->Append(stmt);
 
    if (WorldSession* session = sWorldSessionMgr->FindSession(AccountID))
        if (session->GetPlayerName() != Author)
            session->KickPlayer("Ban Account at condition 'FindSession(account)->GetPlayerName() != author'");
 
    if (WorldSession* session = sWorldSessionMgr->FindOfflineSession(AccountID))
        if (session->GetPlayerName() != Author)
            session->KickPlayer("Ban Account at condition 'FindOfflineSession(account)->GetPlayerName() != author'");
 
    LoginDatabase.CommitTransaction(trans);
 
    if (sWorld->getBoolConfig(CONFIG_SHOW_BAN_IN_WORLD))
    {
        bool IsPermanetly = true;
 
        if (TimeStringToSecs(Duration) > 0)
            IsPermanetly = false;
 
        std::string AccountName;
 
        AccountMgr::GetName(AccountID, AccountName);
 
        if (!IsPermanetly)
            ChatHandler(nullptr).SendWorldText(LANG_BAN_ACCOUNT_YOUBANNEDMESSAGE_WORLD, Author, AccountName, secsToTimeString(TimeStringToSecs(Duration), true), Reason);
        else
            ChatHandler(nullptr).SendWorldText(LANG_BAN_ACCOUNT_YOUPERMBANNEDMESSAGE_WORLD, Author, AccountName, Reason);
    }
 
    return BAN_SUCCESS;
}

References BAN_LONGER_EXISTS, BAN_NOTFOUND, BAN_SUCCESS, BAN_SYNTAX_ERROR, CONFIG_SHOW_BAN_IN_WORLD, GameTime::GetGameTime(), AccountMgr::GetName(), LANG_BAN_ACCOUNT_YOUBANNEDMESSAGE_WORLD, LANG_BAN_ACCOUNT_YOUPERMBANNEDMESSAGE_WORLD, LOGIN_INS_ACCOUNT_BANNED, LOGIN_SEL_ACCOUNT_BANNED, LOGIN_UPD_ACCOUNT_NOT_BANNED, LoginDatabase, sCharacterCache, secsToTimeString(), ChatHandler::SendWorldText(), PreparedStatementBase::SetData(), sWorld, sWorldSessionMgr, and TimeStringToSecs().

BanCharacter()

BanReturn BanMgr::BanCharacter	(	std::string const &	CharacterName,
		std::string const &	Duration,
		std::string const &	Reason,
		std::string const &	Author
	)

Ban an character, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.

Pick a player to ban if not online

{
    Player* target = ObjectAccessor::FindPlayerByName(CharacterName, false);
    uint32 DurationSecs = TimeStringToSecs(Duration);
    ObjectGuid TargetGUID;
 
    if (!target)
    {
        TargetGUID = sCharacterCache->GetCharacterGuidByName(CharacterName);
        if (!TargetGUID)
            return BAN_NOTFOUND;
    }
    else
        TargetGUID = target->GetGUID();
 
    // make sure there is only one active ban
    CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_UPD_CHARACTER_BAN);
    stmt->SetData(0, TargetGUID.GetCounter());
    CharacterDatabase.Execute(stmt);
 
    stmt = CharacterDatabase.GetPreparedStatement(CHAR_INS_CHARACTER_BAN);
    stmt->SetData(0, TargetGUID.GetCounter());
    stmt->SetData(1, DurationSecs);
    stmt->SetData(2, Author);
    stmt->SetData(3, Reason);
    CharacterDatabase.Execute(stmt);
 
    if (target)
        target->GetSession()->KickPlayer("Ban");
 
    if (sWorld->getBoolConfig(CONFIG_SHOW_BAN_IN_WORLD))
    {
        bool IsPermanetly = true;
 
        if (TimeStringToSecs(Duration) > 0)
            IsPermanetly = false;
 
        if (!IsPermanetly)
            ChatHandler(nullptr).SendWorldText(LANG_BAN_CHARACTER_YOUBANNEDMESSAGE_WORLD, Author, CharacterName, secsToTimeString(TimeStringToSecs(Duration), true), Reason);
        else
            ChatHandler(nullptr).SendWorldText(LANG_BAN_CHARACTER_YOUPERMBANNEDMESSAGE_WORLD, Author, CharacterName, Reason);
    }
 
    return BAN_SUCCESS;
}

References BAN_NOTFOUND, BAN_SUCCESS, CHAR_INS_CHARACTER_BAN, CHAR_UPD_CHARACTER_BAN, CharacterDatabase, CONFIG_SHOW_BAN_IN_WORLD, ObjectAccessor::FindPlayerByName(), ObjectGuid::GetCounter(), Object::GetGUID(), Player::GetSession(), WorldSession::KickPlayer(), LANG_BAN_CHARACTER_YOUBANNEDMESSAGE_WORLD, LANG_BAN_CHARACTER_YOUPERMBANNEDMESSAGE_WORLD, sCharacterCache, secsToTimeString(), ChatHandler::SendWorldText(), PreparedStatementBase::SetData(), sWorld, and TimeStringToSecs().

BanIP()

BanReturn BanMgr::BanIP	(	std::string const &	IP,
		std::string const &	Duration,
		std::string const &	Reason,
		std::string const &	Author
	)

Ban an IP address, duration will be parsed using TimeStringToSecs if it is positive, otherwise permban.

• Disconnect all affected players (for IP it can be several)

{
    if (IP.empty() || Duration.empty())
        return BAN_SYNTAX_ERROR;
 
    uint32 DurationSecs = TimeStringToSecs(Duration);
 
    // No SQL injection with prepared statements
    LoginDatabasePreparedStatement* stmt = LoginDatabase.GetPreparedStatement(LOGIN_SEL_ACCOUNT_BY_IP);
    stmt->SetData(0, IP);
    PreparedQueryResult resultAccounts = LoginDatabase.Query(stmt);
 
    stmt = LoginDatabase.GetPreparedStatement(LOGIN_INS_IP_BANNED);
    stmt->SetData(0, IP);
    stmt->SetData(1, DurationSecs);
    stmt->SetData(2, Author);
    stmt->SetData(3, Reason);
    LoginDatabase.Execute(stmt);
 
    if (sWorld->getBoolConfig(CONFIG_SHOW_BAN_IN_WORLD))
    {
        bool IsPermanetly = true;
 
        if (TimeStringToSecs(Duration) > 0)
            IsPermanetly = false;
 
        if (IsPermanetly)
            ChatHandler(nullptr).SendWorldText(LANG_BAN_IP_YOUPERMBANNEDMESSAGE_WORLD, Author, IP, Reason);
        else
            ChatHandler(nullptr).SendWorldText(LANG_BAN_IP_YOUBANNEDMESSAGE_WORLD, Author, IP, secsToTimeString(TimeStringToSecs(Duration), true), Reason);
    }
 
    if (!resultAccounts)
        return BAN_SUCCESS;
 
    LoginDatabaseTransaction trans = LoginDatabase.BeginTransaction();
 
    do
    {
        Field* fields = resultAccounts->Fetch();
        uint32 AccountID = fields[0].Get<uint32>();
 
        if (WorldSession* session = sWorldSessionMgr->FindSession(AccountID))
            if (session->GetPlayerName() != Author)
                session->KickPlayer("Ban IP at condition 'FindSession(account)->GetPlayerName() != author'");
 
        if (WorldSession* session = sWorldSessionMgr->FindOfflineSession(AccountID))
            if (session->GetPlayerName() != Author)
                session->KickPlayer("Ban IP at condition 'FindOfflineSession(account)->GetPlayerName() != author'");
    } while (resultAccounts->NextRow());
 
    LoginDatabase.CommitTransaction(trans);
 
    return BAN_SUCCESS;
}

References BAN_SUCCESS, BAN_SYNTAX_ERROR, CONFIG_SHOW_BAN_IN_WORLD, Field::Get(), LANG_BAN_IP_YOUBANNEDMESSAGE_WORLD, LANG_BAN_IP_YOUPERMBANNEDMESSAGE_WORLD, LOGIN_INS_IP_BANNED, LOGIN_SEL_ACCOUNT_BY_IP, LoginDatabase, secsToTimeString(), ChatHandler::SendWorldText(), PreparedStatementBase::SetData(), sWorld, sWorldSessionMgr, and TimeStringToSecs().

instance()

BanMgr * BanMgr::instance ( )

static

{
    static BanMgr instance;
    return &instance;
}

References instance().

Referenced by instance().

RemoveBanAccount()

bool BanMgr::RemoveBanAccount

(

std::string const &

AccountName

)

Remove a ban from an account.

{
    uint32 AccountID = AccountMgr::GetId(AccountName);
    if (!AccountID)
        return false;
 
    // NO SQL injection as account is uint32
    LoginDatabasePreparedStatement* stmt = LoginDatabase.GetPreparedStatement(LOGIN_UPD_ACCOUNT_NOT_BANNED);
    stmt->SetData(0, AccountID);
    LoginDatabase.Execute(stmt);
 
    return true;
}

References AccountMgr::GetId(), LOGIN_UPD_ACCOUNT_NOT_BANNED, LoginDatabase, and PreparedStatementBase::SetData().

RemoveBanAccountByPlayerName()

bool BanMgr::RemoveBanAccountByPlayerName

(

std::string const &

CharacterName

)

Remove a ban from an player name.

{
    uint32 AccountID = sCharacterCache->GetCharacterAccountIdByName(CharacterName);
    if (!AccountID)
        return false;
 
    // NO SQL injection as account is uint32
    LoginDatabasePreparedStatement* stmt = LoginDatabase.GetPreparedStatement(LOGIN_UPD_ACCOUNT_NOT_BANNED);
    stmt->SetData(0, AccountID);
    LoginDatabase.Execute(stmt);
 
    return true;
}

References LOGIN_UPD_ACCOUNT_NOT_BANNED, LoginDatabase, sCharacterCache, and PreparedStatementBase::SetData().

RemoveBanCharacter()

bool BanMgr::RemoveBanCharacter

(

std::string const &

CharacterName

)

Remove a ban from a character.

Pick a player to ban if not online

{
    Player* pBanned = ObjectAccessor::FindPlayerByName(CharacterName, false);
    ObjectGuid guid;
 
    if (!pBanned)
        guid = sCharacterCache->GetCharacterGuidByName(CharacterName);
    else
        guid = pBanned->GetGUID();
 
    if (!guid)
        return false;
 
    CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_UPD_CHARACTER_BAN);
    stmt->SetData(0, guid.GetCounter());
    CharacterDatabase.Execute(stmt);
    return true;
}

References CHAR_UPD_CHARACTER_BAN, CharacterDatabase, ObjectAccessor::FindPlayerByName(), ObjectGuid::GetCounter(), Object::GetGUID(), sCharacterCache, and PreparedStatementBase::SetData().

RemoveBanIP()

bool BanMgr::RemoveBanIP

(

std::string const &

IP

)

Remove a ban from an account.

{
    LoginDatabasePreparedStatement* stmt = LoginDatabase.GetPreparedStatement(LOGIN_DEL_IP_NOT_BANNED);
    stmt->SetData(0, IP);
    LoginDatabase.Execute(stmt);
 
    return true;
}

References LOGIN_DEL_IP_NOT_BANNED, LoginDatabase, and PreparedStatementBase::SetData().

---

The documentation for this class was generated from the following files:

• azerothcore-wotlk/src/server/game/Misc/BanMgr.h
• azerothcore-wotlk/src/server/game/Misc/BanMgr.cpp