LFGMgr.h

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#ifndef SF_LFGMGR_H
#define SF_LFGMGR_H
 
#include "DBCStructure.h"
#include "Field.h"
#include "LFG.h"
#include "LFGGroupData.h"
#include "LFGPlayerData.h"
#include "LFGQueue.h"
#include "Platform/Singleton.h"
 
class Group;
class Player;
class Quest;
 
namespace lfg
{
 
    enum LfgOptions
    {
        LFG_OPTION_ENABLE_DUNGEON_FINDER = 0x01,
        LFG_OPTION_ENABLE_RAID_BROWSER = 0x02,
    };
 
    enum LFGMgrEnum
    {
        LFG_TIME_ROLECHECK = 45,
        LFG_TIME_BOOT = 120,
        LFG_TIME_PROPOSAL = 45,
        LFG_QUEUEUPDATE_INTERVAL = 15 * IN_MILLISECONDS,
        LFG_SPELL_DUNGEON_COOLDOWN = 71328,
        LFG_SPELL_DUNGEON_DESERTER = 71041,
        LFG_SPELL_LUCK_OF_THE_DRAW = 72221,
        LFG_GROUP_KICK_VOTES_NEEDED = 3
    };
 
    enum LfgFlags
    {
        LFG_FLAG_NONE = 0x0,
        LFG_FLAG_UNK1 = 0x1,
        LFG_FLAG_UNK2 = 0x2,
        LFG_FLAG_SEASONAL = 0x4,
        LFG_FLAG_UNK3 = 0x8,
        LFG_FLAG_UNK4 = 0x10,
        LFG_FLAG_UNK5 = 0x20,
        LFG_FLAG_UNK6 = 0x40,
        LFG_FLAG_UNK7 = 0x80,
        LFG_FLAG_UNK8 = 0x100,
        LFG_FLAG_UNK9 = 0x200,
        LFG_FLAG_UNK10 = 0x400,
        LFG_FLAG_UNK11 = 0x800,
        LFG_FLAG_UNK12 = 0x1000, // FLEX + HEROIC SCENARIOS, requires premade flag?
    };

    enum LfgType
    {
        LFG_TYPE_NONE = 0,
        LFG_TYPE_DUNGEON = 1,
        LFG_TYPE_RAID = 2,
        LFG_TYPE_RANDOM = 6
    };

    enum LfgProposalState
    {
        LFG_PROPOSAL_INITIATING = 0,
        LFG_PROPOSAL_FAILED = 1,
        LFG_PROPOSAL_SUCCESS = 2
    };

    enum LfgTeleportError
    {
        // 7 = "You can't do that right now" | 5 = No client reaction
        LFG_TELEPORTERROR_OK = 0,      // Internal use
        LFG_TELEPORTERROR_PLAYER_DEAD = 1,
        LFG_TELEPORTERROR_FALLING = 2,
        LFG_TELEPORTERROR_IN_VEHICLE = 3,
        LFG_TELEPORTERROR_FATIGUE = 4,
        LFG_TELEPORTERROR_INVALID_LOCATION = 6,
        LFG_TELEPORTERROR_IN_COMBAT = 7,
        LFG_TELEPORTERROR_CHARMING = 8       // FIXME - It can be 7 or 8 (Need proper data)
    };

    enum LfgJoinResult
    {
        // 3 = No client reaction | 18 = "Rolecheck failed"
        LFG_JOIN_OK = 0x00,   // Joined (no client msg)
        LFG_JOIN_FAILED = 0x1C,   // RoleCheck has Failed
        LFG_JOIN_GROUP_FULL = 0x1E,
        LFG_JOIN_INTERNAL_ERROR = 0x1F,   // Internal LFG Error
        LFG_JOIN_NOT_MEET_REQS = 0x20,      // You do not meet the requirements for the chosen dungeons
        LFG_JOIN_MIXED_RAID_DUNGEON = 0x21,   // You cannot mix dungeons, raids, and random when picking dungeons
        LFG_JOIN_MULTI_REALM = 0x22,   // The dungeon you chose does not support players from multiple realms
        LFG_JOIN_DISCONNECTED = 0x23,   // One or more party members are pending invites or disconnected
        LFG_JOIN_PARTY_INFO_FAILED = 0x24,   // Could not retrieve information about some party members
        LFG_JOIN_DUNGEON_INVALID = 0x25,   // One or more dungeons was not valid
        LFG_JOIN_DESERTER = 0x26,   // You can not queue for dungeons until your deserter debuff wears off
        LFG_JOIN_PARTY_DESERTER = 0x27,   // One or more party members has a deserter debuff
        LFG_JOIN_RANDOM_COOLDOWN = 0x28,   // You can not queue for random dungeons while on random dungeon cooldown
        LFG_JOIN_PARTY_RANDOM_COOLDOWN = 0x29,   // One or more party members are on random dungeon cooldown
        LFG_JOIN_TOO_MUCH_MEMBERS = 0x2A,   // You can not enter dungeons with more that 5 party members
        LFG_JOIN_USING_BG_SYSTEM = 0x2B,   // You can not use the dungeon system while in BG or arenas
        LFG_JOIN_ROLE_CHECK_FAILED = 0x2C    // Role check failed, client shows special error
    };

    enum LfgRoleCheckState
    {
        LFG_ROLECHECK_DEFAULT = 0,      // Internal use = Not initialized.
        LFG_ROLECHECK_FINISHED = 1,      // Role check finished
        LFG_ROLECHECK_INITIALITING = 2,      // Role check begins
        LFG_ROLECHECK_MISSING_ROLE = 3,      // Someone didn't selected a role after 2 mins
        LFG_ROLECHECK_WRONG_ROLES = 4,      // Can't form a group with that role selection
        LFG_ROLECHECK_ABORTED = 5,      // Someone leave the group
        LFG_ROLECHECK_NO_ROLE = 6       // Someone selected no role
    };
 
    // Forward declaration (just to have all typedef together)
    struct LFGDungeonData;
    struct LfgReward;
    struct LfgQueueInfo;
    struct LfgRoleCheck;
    struct LfgProposal;
    struct LfgProposalPlayer;
    struct LfgPlayerBoot;
 
    typedef std::map<uint8, LFGQueue> LfgQueueContainer;
    typedef std::multimap<uint32, LfgReward const*> LfgRewardContainer;
    typedef std::pair<LfgRewardContainer::const_iterator, LfgRewardContainer::const_iterator> LfgRewardContainerBounds;
    typedef std::map<uint8, LfgDungeonSet> LfgCachedDungeonContainer;
    typedef std::map<uint64, LfgAnswer> LfgAnswerContainer;
    typedef std::map<uint64, LfgRoleCheck> LfgRoleCheckContainer;
    typedef std::map<uint32, LfgProposal> LfgProposalContainer;
    typedef std::map<uint64, LfgProposalPlayer> LfgProposalPlayerContainer;
    typedef std::map<uint64, LfgPlayerBoot> LfgPlayerBootContainer;
    typedef std::map<uint64, LfgGroupData> LfgGroupDataContainer;
    typedef std::map<uint64, LfgPlayerData> LfgPlayerDataContainer;
    typedef UNORDERED_MAP<uint32, LFGDungeonData> LFGDungeonContainer;
 
    // Data needed by SMSG_LFG_JOIN_RESULT
    struct LfgJoinResultData
    {
        LfgJoinResultData(LfgJoinResult _result = LFG_JOIN_OK, LfgRoleCheckState _state = LFG_ROLECHECK_DEFAULT) :
            result(_result), state(_state) { }
        LfgJoinResult result;
        LfgRoleCheckState state;
        LfgLockPartyMap lockmap;
    };
 
    // Data needed by SMSG_LFG_UPDATE_STATUS
    struct LfgUpdateData
    {
        LfgUpdateData(LfgUpdateType _type = LFG_UPDATETYPE_DEFAULT) : updateType(_type), state(LFG_STATE_NONE), comment("") { }
        LfgUpdateData(LfgUpdateType _type, LfgDungeonSet const& _dungeons, std::string const& _comment) :
            updateType(_type), state(LFG_STATE_NONE), dungeons(_dungeons), comment(_comment) { }
        LfgUpdateData(LfgUpdateType _type, LfgState _state, LfgDungeonSet const& _dungeons, std::string const& _comment = "") :
            updateType(_type), state(_state), dungeons(_dungeons), comment(_comment) { }
 
        LfgUpdateType updateType;
        LfgState state;
        LfgDungeonSet dungeons;
        std::string comment;
    };
 
    // Data needed by SMSG_LFG_QUEUE_STATUS
    struct LfgQueueStatusData
    {
        LfgQueueStatusData(uint8 _queueId = 0, uint32 _dungeonId = 0, time_t _joinTime = 0, int32 _waitTime = -1, int32 _waitTimeAvg = -1, int32 _waitTimeTank = -1, int32 _waitTimeHealer = -1,
            int32 _waitTimeDps = -1, uint32 _queuedTime = 0, uint8 _tanks = 0, uint8 _healers = 0, uint8 _dps = 0) :
            queueId(_queueId), dungeonId(_dungeonId), joinTime(_joinTime), waitTime(_waitTime), waitTimeAvg(_waitTimeAvg), waitTimeTank(_waitTimeTank),
            waitTimeHealer(_waitTimeHealer), waitTimeDps(_waitTimeDps), queuedTime(_queuedTime), tanks(_tanks), healers(_healers), dps(_dps) { }
 
        uint8 queueId;
        uint32 dungeonId;
        time_t joinTime;
        int32 waitTime;
        int32 waitTimeAvg;
        int32 waitTimeTank;
        int32 waitTimeHealer;
        int32 waitTimeDps;
        uint32 queuedTime;
        uint8 tanks;
        uint8 healers;
        uint8 dps;
    };
 
    struct LfgPlayerRewardData
    {
        LfgPlayerRewardData(uint32 random, uint32 current, bool _done, Quest const* _quest) :
            rdungeonEntry(random), sdungeonEntry(current), done(_done), quest(_quest) { }
        uint32 rdungeonEntry;
        uint32 sdungeonEntry;
        bool done;
        Quest const* quest;
    };

    struct LfgReward
    {
        LfgReward(uint32 _maxLevel = 0, uint32 _firstQuest = 0, uint32 _otherQuest = 0) :
            maxLevel(_maxLevel), firstQuest(_firstQuest), otherQuest(_otherQuest) { }
 
        uint32 maxLevel;
        uint32 firstQuest;
        uint32 otherQuest;
    };

    struct LfgProposalPlayer
    {
        LfgProposalPlayer() : role(0), accept(LFG_ANSWER_PENDING), group(0) { }
        uint8 role;                                            
        LfgAnswer accept;                                      
        uint64 group;                                          
    };

    struct LfgProposal
    {
        LfgProposal(uint32 dungeon = 0) : id(0), dungeonId(dungeon), state(LFG_PROPOSAL_INITIATING),
            group(0), leader(0), cancelTime(0), encounters(0), isNew(true)
        { }
 
        uint32 id;                                             
        uint32 dungeonId;                                      
        LfgProposalState state;                                
        uint64 group;                                          
        uint64 leader;                                         
        time_t cancelTime;                                     
        uint32 encounters;                                     
        bool isNew;                                            
        LfgGuidList queues;                                    
        LfgGuidList showorder;                                 
        LfgProposalPlayerContainer players;                    
    };

    struct LfgRoleCheck
    {
        time_t cancelTime;                                     
        LfgRolesMap roles;                                     
        LfgRoleCheckState state;                               
        LfgDungeonSet dungeons;                                
        uint32 rDungeonId;                                     
        uint64 leader;                                         
    };

    struct LfgPlayerBoot
    {
        time_t cancelTime;                                     
        bool inProgress;                                       
        LfgAnswerContainer votes;                              
        uint64 victim;                                         
        std::string reason;                                    
    };
 
    struct LFGDungeonData
    {
        LFGDungeonData() : id(0), name(""), map(0), type(0), expansion(0), group(0), minlevel(0),
            maxlevel(0), difficulty(DIFFICULTY_NONE), category(0), requiredItemLevel(0), seasonal(false), x(0.0f), y(0.0f), z(0.0f), o(0.0f)
        { }
        LFGDungeonData(LFGDungeonEntry const* dbc) : id(dbc->m_ID), name(dbc->m_Name), map(dbc->m_ContinentID),
            type(dbc->m_Type), expansion(dbc->m_ExpansionLevel), group(dbc->m_GroupID),
            minlevel(dbc->m_MinLevel), maxlevel(dbc->m_MaxLevel), difficulty(DifficultyID(dbc->m_DifficultyID)),
            category(uint8(dbc->m_SubType)), requiredItemLevel(0), seasonal(dbc->m_Flags& LFG_FLAG_SEASONAL), x(0.0f), y(0.0f), z(0.0f), o(0.0f)
        { }
 
        uint32 id;
        std::string name;
        uint16 map;
        uint8 type;
        uint8 expansion;
        uint8 group;
        uint8 minlevel;
        uint8 maxlevel;
        DifficultyID difficulty;
        uint8 category;
        uint32 requiredItemLevel;
        bool seasonal;
        float x, y, z, o;
 
        // Helpers
        uint32 Entry() const { return id + (type << 24); }
    };
 
    class LFGMgr
    {
        friend class Skyfire::Singleton<LFGMgr, Skyfire::NullMutex>;
 
    private:
        LFGMgr();
        ~LFGMgr();
 
    public:
        // Functions used outside lfg namespace
        void Update(uint32 diff);
 
        // World.cpp
        void FinishDungeon(uint64 gguid, uint32 dungeonId);
        void LoadRewards();
        void LoadLFGDungeons(bool reload = false);
 
        // Multiple files
        bool selectedRandomLfgDungeon(uint64 guid);
        bool inLfgDungeonMap(uint64 guid, uint32 map, DifficultyID difficulty);
        LfgDungeonSet const& GetSelectedDungeons(uint64 guid);
        LfgState GetState(uint64 guid);
        uint32 GetDungeon(uint64 guid, bool asId = true);
        uint32 GetDungeonMapId(uint64 guid);
        bool IsVoteKickActive(uint64 gguid);
        uint8 GetKicksLeft(uint64 gguid);
        void _LoadFromDB(Field* fields, uint64 guid);
        void SetupGroupMember(uint64 guid, uint64 gguid);
        bool RestoreActiveQueue(uint64 guid);
        bool SendActiveProposal(uint64 guid);
        uint32 GetLFGDungeonEntry(uint32 id);
        uint8 GetLFGDungeonCategory(uint32 id);
        bool IsRaidFinderDungeon(uint32 dungeonId);
        bool IsFlexibleRaidDungeon(uint32 dungeonId);
 
        // cs_lfg
        uint8 GetRoles(uint64 guid);
        uint8 GetActiveQueueId(uint64 guid);
        std::string const& GetComment(uint64 gguid);
        uint32 GetOptions();
        void SetOptions(uint32 options);
        bool isOptionEnabled(uint32 option);
        bool IsDebugRequirementOverrideEnabled() const { return m_debugRequirementOverride; }
        void SetDebugRequirementOverride(bool enabled) { m_debugRequirementOverride = enabled; }
        bool IsDebugFlexRaidMinimumOverrideEnabled() const { return m_debugFlexRaidMinimumOverride; }
        void SetDebugFlexRaidMinimumOverride(bool enabled) { m_debugFlexRaidMinimumOverride = enabled; }
        void Clean();
        std::string DumpQueueInfo(bool full = false);
        std::string DumpPlayerInfo(uint64 guid);
        std::string DumpGroupInfo(uint64 guid);
 
        // LFGScripts
        uint64 GetLeader(uint64 guid);
        void SetTeam(uint64 guid, uint8 team);
        void SetGroup(uint64 guid, uint64 group);
        uint64 GetGroup(uint64 guid);
        void SetLeader(uint64 gguid, uint64 leader);
        void RemoveGroupData(uint64 guid);
        void ClearDungeonGroupState(uint64 guid, uint32 dbGuid, char const* debugMsg, bool sendUpdate);
        uint8 RemovePlayerFromGroup(uint64 gguid, uint64 guid);
        void AddPlayerToGroup(uint64 gguid, uint64 guid);
 
        // LFGHandler
        LfgLockMap const GetLockedDungeons(uint64 guid);
        LfgUpdateData GetLfgStatus(uint64 guid);
        bool IsSeasonActive(uint32 dungeonId);
        LfgReward const* GetRandomDungeonReward(uint32 dungeon, uint8 level);
        LfgDungeonSet GetRandomAndSeasonalDungeons(uint8 level, uint8 expansion);
        void TeleportPlayer(Player* player, bool out, bool fromOpcode = false, bool forceChangeInstance = false);
        void TeleportDungeonGroupOut(Group* group);
        void InitBoot(uint64 gguid, uint64 kguid, uint64 vguid, std::string const& reason);
        void UpdateBoot(uint64 guid, bool accept);
        void UpdateProposal(uint32 proposalId, uint64 guid, bool accept);
        void UpdateRoleCheck(uint64 gguid, uint64 guid = 0, uint8 roles = PLAYER_ROLE_NONE);
        void SetRoles(uint64 guid, uint8 roles);
        void SetComment(uint64 guid, std::string const& comment);
        void JoinLfg(Player* player, uint8 roles, LfgDungeonSet& dungeons, std::string const& comment);
        void LeaveLfg(uint64 guid, bool disconnected = false);
        void LeaveSoloLfg(uint64 guid, uint32 queueID, bool disconnected = false);
 
        // LfgQueue
        LfgState GetOldState(uint64 guid);
        bool IsLfgGroup(uint64 guid);
        uint8 GetPlayerCount(uint64 guid);
        uint32 AddProposal(LfgProposal& proposal);
        uint8 GetQueueId(uint64 guid);
        bool AllQueued(LfgGuidList const& check);
        time_t GetQueueJoinTime(uint64 guid);
        static bool CheckGroupRoles(LfgRolesMap& groles);
        static bool CheckDpsOnlyRoles(LfgRolesMap& groles, uint8 neededDamage);
        static bool CheckFlexibleRaidRoles(LfgRolesMap& groles, uint8 maxPlayers);
        static bool HasIgnore(uint64 guid1, uint64 guid2);
        static void SendLfgQueueStatus(uint64 guid, LfgQueueStatusData const& data);
 
    private:
        uint8 GetTeam(uint64 guid);
        void RestoreState(uint64 guid, char const* debugMsg);
        void RestoreOrClearState(uint64 guid, char const* debugMsg);
        void ClearState(uint64 guid, char const* debugMsg);
        void ClearQueueState(uint64 guid, char const* debugMsg);
        void ClearGroupQueueState(uint64 guid, char const* debugMsg, bool sendUpdate);
        void SetActiveQueueId(uint64 guid, uint8 queueId);
        void SetDungeon(uint64 guid, uint32 dungeon);
        void SetSelectedDungeons(uint64 guid, LfgDungeonSet const& dungeons);
        void DecreaseKicksLeft(uint64 guid);
        void SetState(uint64 guid, LfgState state);
        void SetVoteKick(uint64 guid, bool active);
        void RemovePlayerData(uint64 guid);
        void GetCompatibleDungeons(LfgDungeonSet& dungeons, LfgGuidSet const& players, LfgLockPartyMap& lockMap, bool isContinue);
        void _SaveToDB(uint64 guid, uint32 db_guid);
        LFGDungeonData const* GetLFGDungeon(uint32 id);
 
        // Proposals
        void RemoveProposal(LfgProposalContainer::iterator itProposal, LfgUpdateType type);
        bool MakeNewGroup(LfgProposal const& proposal);
 
        // Generic
        LFGQueue& GetQueue(uint64 guid);
 
        LfgDungeonSet const& GetDungeonsByRandom(uint32 randomdungeon);
        LfgType GetDungeonType(uint32 dungeon);
 
        void SendLfgBootProposalUpdate(uint64 guid, LfgPlayerBoot const& boot);
        void SendLfgJoinResult(uint64 guid, LfgJoinResultData const& data);
        void SendLfgRoleChosen(uint64 guid, uint64 pguid, uint8 roles);
        void SendLfgRoleCheckUpdate(uint64 guid, LfgRoleCheck const& roleCheck);
        void SendLfgUpdateStatus(uint64 guid, LfgUpdateData const& data, bool party);
        void SendLfgUpdateProposal(uint64 guid, LfgProposal const& proposal);
 
        LfgGuidSet const& GetPlayers(uint64 guid);
 
        // General variables
        uint32 m_QueueTimer;                               
        uint32 m_lfgProposalId;                            
        uint32 m_options;                                  
        bool m_debugRequirementOverride;                   
        bool m_debugFlexRaidMinimumOverride;               
 
        LfgQueueContainer QueuesStore;                     
        LfgCachedDungeonContainer CachedDungeonMapStore;   
        // Reward System
        LfgRewardContainer RewardMapStore;                 
        LFGDungeonContainer  LfgDungeonStore;
        // Rolecheck - Proposal - Vote Kicks
        LfgRoleCheckContainer RoleChecksStore;             
        LfgProposalContainer ProposalsStore;               
        LfgPlayerBootContainer BootsStore;                 
        LfgPlayerDataContainer PlayersStore;               
        LfgGroupDataContainer GroupsStore;                 
    };
 
} // namespace lfg
 
#define sLFGMgr Skyfire::Singleton<lfg::LFGMgr, Skyfire::NullMutex>::instance()
#endif