RankManager.h

Go to the documentation of this file.

 
// RankManager.h
 
// Declares the cRankManager class that represents the rank manager responsible for assigning permissions and message visuals to players
 
 
 
 
#pragma once
 
#include "SQLiteCpp/Database.h"
#include "SQLiteCpp/Transaction.h"
 
 
 
 
class cUUID;
class cMojangAPI;
 
 
 
 
 
class cRankManager
{
public:
    class cMassChangeLock
    {
    public:
        cMassChangeLock(cRankManager & a_RankManager) :
            m_Lock(a_RankManager.m_CS),
            m_Transaction(a_RankManager.m_DB)
        {
        }
 
        ~cMassChangeLock()
        {
            m_Transaction.commit();
        }
 
    protected:
        cCSLock m_Lock;
        SQLite::Transaction m_Transaction;
    };
 
 
    cRankManager(void);
 
    ~cRankManager();
 
    void Initialize(cMojangAPI & a_MojangAPI);
 
    AString GetPlayerRankName(const cUUID & a_PlayerUUID);
 
    AString GetPlayerName(const cUUID & a_PlayerUUID);
 
    AStringVector GetPlayerGroups(const cUUID & a_PlayerUUID);
 
    AStringVector GetPlayerPermissions(const cUUID & a_PlayerUUID);
 
    AStringVector GetPlayerRestrictions(const cUUID & a_PlayerUUID);
 
    AStringVector GetRankGroups(const AString & a_RankName);
 
    AStringVector GetGroupPermissions(const AString & a_GroupName);
 
    AStringVector GetGroupRestrictions(const AString & a_GroupName);
 
    AStringVector GetRankPermissions(const AString & a_RankName);
 
    AStringVector GetRankRestrictions(const AString & a_RankName);
 
    std::vector<cUUID> GetAllPlayerUUIDs(void);
 
    AStringVector GetAllRanks(void);
 
    AStringVector GetAllGroups(void);
 
    AStringVector GetAllPermissions(void);
 
    AStringVector GetAllRestrictions(void);
 
    AStringVector GetAllPermissionsRestrictions(void);
 
    bool GetPlayerMsgVisuals(
        const cUUID & a_PlayerUUID,
        AString & a_MsgPrefix,
        AString & a_MsgSuffix,
        AString & a_MsgNameColorCode
    );
 
    void AddRank(
        const AString & a_RankName,
        const AString & a_MsgPrefix,
        const AString & a_MsgSuffix,
        const AString & a_MsgNameColorCode
    );
 
    void AddGroup(const AString & a_GroupName);
 
    void AddGroups(const AStringVector & a_GroupNames);
 
    bool AddGroupToRank(const AString & a_GroupName, const AString & a_RankName);
 
    bool AddPermissionToGroup(const AString & a_Permission, const AString & a_GroupName);
 
    bool AddRestrictionToGroup(const AString & a_Restriction, const AString & a_GroupName);
 
    bool AddPermissionsToGroup(const AStringVector & a_Permissions, const AString & a_GroupName);
 
    bool AddRestrictionsToGroup(const AStringVector & a_Restrictions, const AString & a_GroupName);
 
    void RemoveRank(const AString & a_RankName, const AString & a_ReplacementRankName);
 
    void RemoveGroup(const AString & a_GroupName);
 
    void RemoveGroupFromRank(const AString & a_GroupName, const AString & a_RankName);
 
    void RemovePermissionFromGroup(const AString & a_Permission, const AString & a_GroupName);
 
    void RemoveRestrictionFromGroup(const AString & a_Restriction, const AString & a_GroupName);
 
    bool RenameRank(const AString & a_OldName, const AString & a_NewName);
 
    bool RenameGroup(const AString & a_OldName, const AString & a_NewName);
 
    void SetPlayerRank(const cUUID & a_PlayerUUID, const AString & a_PlayerName, const AString & a_RankName);
 
    void RemovePlayerRank(const cUUID & a_PlayerUUID);
 
    void SetRankVisuals(
        const AString & a_RankName,
        const AString & a_MsgPrefix,
        const AString & a_MsgSuffix,
        const AString & a_MsgNameColorCode
    );
 
    bool GetRankVisuals(
        const AString & a_RankName,
        AString & a_MsgPrefix,
        AString & a_MsgSuffix,
        AString & a_MsgNameColorCode
    );
 
    bool RankExists(const AString & a_RankName);
 
    bool GroupExists(const AString & a_GroupName);
 
    bool IsPlayerRankSet(const cUUID & a_PlayerUUID);
 
    bool IsGroupInRank(const AString & a_GroupName, const AString & a_RankName);
 
    bool IsPermissionInGroup(const AString & a_Permission, const AString & a_GroupName);
 
    bool IsRestrictionInGroup(const AString & a_Restriction, const AString & a_GroupName);
 
    void NotifyNameUUID(const AString & a_PlayerName, const cUUID & a_UUID);
 
    bool SetDefaultRank(const AString & a_RankName);
 
    const AString & GetDefaultRank(void) const { return m_DefaultRank; }
 
    void ClearPlayerRanks(void);
 
    bool UpdatePlayerName(const cUUID & a_PlayerUUID, const AString & a_NewPlayerName);
 
protected:
 
    SQLite::Database m_DB;
 
    AString m_DefaultRank;
 
    cCriticalSection m_CS;
 
    bool m_IsInitialized;
 
    cMojangAPI * m_MojangAPI;
 
 
    bool AreDBTablesEmpty(void);
 
    bool IsDBTableEmpty(const AString & a_TableName);
 
    void CreateDefaults(void);
 
    bool DoesColumnExist(const char * a_TableName, const char * a_ColumnName);
 
    void CreateColumnIfNotExists(const char * a_TableName, const char * a_ColumnName, const char * a_ColumnType = "");
} ;