MapManager.cpp

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
*/
 
#include "CellImpl.h"
#include "Config.h"
#include "Corpse.h"
#include "DatabaseEnv.h"
#include "GridDefines.h"
#include "Group.h"
#include "InstanceSaveMgr.h"
#include "InstanceScript.h"
#include "Language.h"
#include "Log.h"
#include "MapInstanced.h"
#include "MapManager.h"
#include "ObjectAccessor.h"
#include "ObjectMgr.h"
#include "Opcodes.h"
#include "Player.h"
#include "RuntimeMetrics.h"
#include "Transport.h"
#include "TransportMgr.h"
#include "World.h"
#include "WorldPacket.h"
#include "WorldSession.h"
 
extern GridState* si_GridStates[];                          // debugging code, should be deleted some day
 
MapManager::MapManager() : i_gridCleanUpDelay(0), _nextInstanceId(0), i_GridStateErrorCount(0)
{
    i_gridCleanUpDelay = sWorld->getIntConfig(WorldIntConfigs::CONFIG_INTERVAL_GRIDCLEAN);
    i_timer.SetInterval(sWorld->getIntConfig(WorldIntConfigs::CONFIG_INTERVAL_MAPUPDATE));
}
 
MapManager::~MapManager() { }
 
void MapManager::Initialize()
{
    Map::InitStateMachine();
 
    // debugging code, should be deleted some day
    {
        for (uint8 i = 0; i < MAX_GRID_STATE; ++i)
            i_GridStates[i] = si_GridStates[i];
 
        i_GridStateErrorCount = 0;
    }
    int num_threads(sWorld->getIntConfig(WorldIntConfigs::CONFIG_NUMTHREADS));
    // Start mtmaps if needed.
    if (num_threads > 0 && m_updater.activate(num_threads) == -1)
        abort();
}
 
void MapManager::InitializeVisibilityDistanceInfo()
{
    for (MapMapType::iterator iter = i_maps.begin(); iter != i_maps.end(); ++iter)
        (*iter).second->InitVisibilityDistance();
}
 
// debugging code, should be deleted some day
void MapManager::checkAndCorrectGridStatesArray()
{
    bool ok = true;
    for (int i = 0; i < MAX_GRID_STATE; i++)
    {
        if (i_GridStates[i] != si_GridStates[i])
        {
            SF_LOG_ERROR("maps", "MapManager::checkGridStates(), GridState: si_GridStates is currupt !!!");
            ok = false;
            si_GridStates[i] = i_GridStates[i];
        }
#ifdef SKYFIRE_DEBUG
        // inner class checking only when compiled with debug
        if (!si_GridStates[i]->checkMagic())
        {
            ok = false;
            si_GridStates[i]->setMagic();
        }
#endif
    }
    if (!ok)
        ++i_GridStateErrorCount;
}
 
Map* MapManager::CreateBaseMap(uint32 id)
{
    Map* map = FindBaseMap(id);
 
    if (!map)
    {
        MapEntry const* entry = sMapStore.LookupEntry(id);
        if (entry->entrance_map != -1)
        {
            CreateBaseMap(entry->entrance_map);
 
            // must have been created by parent map
            map = FindBaseMap(id);
            ASSERT(entry);
        }
 
        std::lock_guard<std::mutex> guard(Lock);
        if (entry->Instanceable())
            map = new MapInstanced(entry->MapID, i_gridCleanUpDelay);
        else
            map = new Map(entry->MapID, i_gridCleanUpDelay, 0, DIFFICULTY_NONE);
 
        i_maps[entry->MapID] = map;
 
        if (!entry->Instanceable())
        {
            map->LoadRespawnTimes();
            sTransportMgr->SpawnLocalTransports(map);
        }
    }
 
    ASSERT(map);
    return map;
    /*
    if (map == NULL)
    {
        std::lock_guard<std::mutex> guard(Lock);
 
        MapEntry const* entry = sMapStore.LookupEntry(id);
        ASSERT(entry);
 
        if (entry->Instanceable())
            map = new MapInstanced(id, i_gridCleanUpDelay);
        else
        {
            map = new Map(id, i_gridCleanUpDelay, 0, DIFFICULTY_NONE);
            map->LoadRespawnTimes();
        }
 
        i_maps[id] = map;
    }
 
    ASSERT(map);
    return map;
    */
}
 
Map* MapManager::FindBaseNonInstanceMap(uint32 mapId) const
{
    Map* map = FindBaseMap(mapId);
    if (map && map->Instanceable())
        return NULL;
    return map;
}
 
Map* MapManager::CreateMap(uint32 id, Player* player)
{
    Map* m = CreateBaseMap(id);
 
    if (m && m->Instanceable())
        m = ((MapInstanced*)m)->CreateInstanceForPlayer(id, player);
 
    return m;
}
 
Map* MapManager::FindMap(uint32 mapid, uint32 instanceId) const
{
    Map* map = FindBaseMap(mapid);
    if (!map)
        return NULL;
 
    if (!map->Instanceable())
        return instanceId == 0 ? map : NULL;
 
    return ((MapInstanced*)map)->FindInstanceMap(instanceId);
}
 
bool MapManager::CanPlayerEnter(uint32 mapid, Player* player, bool loginCheck)
{
    MapEntry const* entry = sMapStore.LookupEntry(mapid);
    if (!entry)
        return false;
 
    if (!entry->IsInstance())
        return true;
 
    InstanceTemplate const* instance = sObjectMgr->GetInstanceTemplate(mapid);
    if (!instance)
        return false;
 
    DifficultyID targetDifficulty = player->GetDifficulty(entry);
    //The player has a heroic mode and tries to enter into instance which has no a heroic mode
    MapDifficulty const* mapDiff = GetMapDifficultyData(entry->MapID, targetDifficulty);
    if (!mapDiff)
    {
        // Send aborted message for dungeons
        if (entry->IsNonRaidInstance())
        {
            player->SendTransferAborted(mapid, TransferAbortReason::TRANSFER_ABORT_DIFFICULTY, player->GetDungeonDifficulty());
            return false;
        }
        else    // attempt to downscale
            mapDiff = GetDownscaledMapDifficultyData(entry->MapID, targetDifficulty);
    }
    // FIXME: mapDiff is never used
 
    //Bypass checks for GMs
    if (player->IsGameMaster())
        return true;
 
    char const* mapName = entry->name;
 
    Group* group = player->GetGroup();
    if (entry->IsRaid())
    {
        // can only enter in a raid group
        if ((!group || !group->isRaidGroup()) && !sWorld->GetBoolConfig(WorldBoolConfigs::CONFIG_INSTANCE_IGNORE_RAID))
        {
            // probably there must be special opcode, because client has this string constant in GlobalStrings.lua
            player->GetSession()->SendNotification(LANG_INSTANCE_RAID_GROUP_ONLY, mapName);
            SF_LOG_DEBUG("maps", "MAP: Player '%s' must be in a raid group to enter instance '%s'", player->GetName().c_str(), mapName);
            return false;
        }
    }
 
    if (!player->IsAlive())
    {
        if (Corpse* corpse = player->GetCorpse())
        {
            // let enter in ghost mode in instance that connected to inner instance with corpse
            uint32 corpseMap = corpse->GetMapId();
            do
            {
                if (corpseMap == mapid)
                    break;
 
                InstanceTemplate const* corpseInstance = sObjectMgr->GetInstanceTemplate(corpseMap);
                corpseMap = corpseInstance ? corpseInstance->Parent : 0;
            } while (corpseMap);
 
            if (!corpseMap)
            {
                WorldPacket data(SMSG_CORPSE_NOT_IN_INSTANCE);
                player->GetSession()->SendPacket(&data);
                SF_LOG_DEBUG("maps", "MAP: Player '%s' does not have a corpse in instance '%s' and cannot enter.", player->GetName().c_str(), mapName);
                return false;
            }
            SF_LOG_DEBUG("maps", "MAP: Player '%s' has corpse in instance '%s' and can enter.", player->GetName().c_str(), mapName);
            player->ResurrectPlayer(0.5f, false);
            player->SpawnCorpseBones();
        }
        else
            SF_LOG_DEBUG("maps", "Map::CanPlayerEnter - player '%s' is dead but does not have a corpse!", player->GetName().c_str());
    }
 
    //Get instance where player's group is bound & its map
    if (group)
    {
        InstanceGroupBind* boundInstance = group->GetBoundInstance(entry);
        if (boundInstance && boundInstance->save)
            if (Map* boundMap = sMapMgr->FindMap(mapid, boundInstance->save->GetInstanceId()))
                if (!loginCheck && !boundMap->CanEnter(player))
                    return false;
        /*
            This check has to be moved to InstanceMap::CanEnter()
            // Player permanently bounded to different instance than groups one
            InstancePlayerBind* playerBoundedInstance = player->GetBoundInstance(mapid, player->GetDifficulty(entry->IsRaid()));
            if (playerBoundedInstance && playerBoundedInstance->perm && playerBoundedInstance->save &&
                boundedInstance->save->GetInstanceId() != playerBoundedInstance->save->GetInstanceId())
            {
                return false;
            }*/
    }
 
    // players are only allowed to enter 5 instances per hour
    if (entry->IsInstance() && (!player->GetGroup() || (player->GetGroup() && !player->GetGroup()->isLFGGroup())))
    {
        uint32 instaceIdToCheck = 0;
        if (InstanceSave* save = player->GetInstanceSave(mapid))
            instaceIdToCheck = save->GetInstanceId();
 
        // instanceId can never be 0 - will not be found
        if (!player->CheckInstanceCount(instaceIdToCheck) && !player->isDead())
        {
            player->SendTransferAborted(mapid, TransferAbortReason::TRANSFER_ABORT_TOO_MANY_INSTANCES);
            return false;
        }
    }
 
    //Other requirements
    return player->Satisfy(sObjectMgr->GetAccessRequirement(mapid, targetDifficulty), mapid, true);
}
 
void MapManager::Update(uint32 diff)
{
    i_timer.Update(diff);
    if (!i_timer.Passed())
        return;
 
    Skyfire::Diagnostics::GetRuntimeMetrics().RecordMapUpdatePass(static_cast<uint32>(i_maps.size()));
 
    MapMapType::iterator iter = i_maps.begin();
    for (; iter != i_maps.end(); ++iter)
    {
        if (m_updater.activated())
            m_updater.schedule_update(*iter->second, uint32(i_timer.GetCurrent()));
        else
            iter->second->Update(uint32(i_timer.GetCurrent()));
    }
    if (m_updater.activated())
        m_updater.wait();
 
    for (iter = i_maps.begin(); iter != i_maps.end(); ++iter)
        iter->second->DelayedUpdate(uint32(i_timer.GetCurrent()));
 
    sObjectAccessor->Update(uint32(i_timer.GetCurrent()));
 
    i_timer.SetCurrent(0);
}
 
void MapManager::DoDelayedMovesAndRemoves() { }
 
bool MapManager::ExistMapAndVMap(uint32 mapid, float x, float y)
{
    GridCoord p = Skyfire::ComputeGridCoord(x, y);
 
    int gx = 63 - p.x_coord;
    int gy = 63 - p.y_coord;
 
    return Map::ExistMap(mapid, gx, gy) && Map::ExistVMap(mapid, gx, gy);
}
 
bool MapManager::IsValidMAP(uint32 mapid, bool startUp)
{
    MapEntry const* mEntry = sMapStore.LookupEntry(mapid);
 
    if (startUp)
        return mEntry ? true : false;
    else
        return mEntry && (!mEntry->IsInstance() || sObjectMgr->GetInstanceTemplate(mapid));

}
 
void MapManager::UnloadAll()
{
    for (MapMapType::iterator iter = i_maps.begin(); iter != i_maps.end();)
    {
        iter->second->UnloadAll();
        delete iter->second;
        i_maps.erase(iter++);
    }
 
    if (m_updater.activated())
        m_updater.deactivate();
 
    Map::DeleteStateMachine();
}
 
uint32 MapManager::GetNumInstances()
{
    std::lock_guard<std::mutex> guard(Lock);
 
    uint32 ret = 0;
    for (MapMapType::iterator itr = i_maps.begin(); itr != i_maps.end(); ++itr)
    {
        Map* map = itr->second;
        if (!map->Instanceable())
            continue;
        MapInstanced::InstancedMaps& maps = ((MapInstanced*)map)->GetInstancedMaps();
        for (MapInstanced::InstancedMaps::iterator mitr = maps.begin(); mitr != maps.end(); ++mitr)
            if (mitr->second->IsInstance()) ret++;
    }
    return ret;
}
 
uint32 MapManager::GetNumPlayersInInstances()
{
    std::lock_guard<std::mutex> guard(Lock);
 
    uint32 ret = 0;
    for (MapMapType::iterator itr = i_maps.begin(); itr != i_maps.end(); ++itr)
    {
        Map* map = itr->second;
        if (!map->Instanceable())
            continue;
        MapInstanced::InstancedMaps& maps = ((MapInstanced*)map)->GetInstancedMaps();
        for (MapInstanced::InstancedMaps::iterator mitr = maps.begin(); mitr != maps.end(); ++mitr)
            if (mitr->second->IsInstance())
                ret += ((InstanceMap*)mitr->second)->GetPlayers().getSize();
    }
    return ret;
}
 
void MapManager::InitInstanceIds()
{
    _nextInstanceId = 1;
 
    QueryResult result = CharacterDatabase.Query("SELECT MAX(id) FROM instance");
    if (result)
    {
        uint32 maxId = (*result)[0].GetUInt32();
 
        // Resize to multiples of 32 (vector<bool> allocates memory the same way)
        _instanceIds.resize((maxId / 32) * 32 + (maxId % 32 > 0 ? 32 : 0));
    }
}
 
void MapManager::RegisterInstanceId(uint32 instanceId)
{
    // Allocation and sizing was done in InitInstanceIds()
    _instanceIds[instanceId] = true;
}
 
uint32 MapManager::GenerateInstanceId()
{
    uint32 newInstanceId = _nextInstanceId;
 
    // Find the lowest available id starting from the current NextInstanceId (which should be the lowest according to the logic in FreeInstanceId()
    for (uint32 i = ++_nextInstanceId; i < 0xFFFFFFFF; ++i)
    {
        if ((i < _instanceIds.size() && !_instanceIds[i]) || i >= _instanceIds.size())
        {
            _nextInstanceId = i;
            break;
        }
    }
 
    if (newInstanceId == _nextInstanceId)
    {
        SF_LOG_ERROR("maps", "Instance ID overflow!! Can't continue, shutting down server. ");
        World::StopNow(ERROR_EXIT_CODE);
    }
 
    // Allocate space if necessary
    if (newInstanceId >= uint32(_instanceIds.size()))
    {
        // Due to the odd memory allocation behavior of vector<bool> we match size to capacity before triggering a new allocation
        if (_instanceIds.size() < _instanceIds.capacity())
        {
            _instanceIds.resize(_instanceIds.capacity());
        }
        else
            _instanceIds.resize((newInstanceId / 32) * 32 + (newInstanceId % 32 > 0 ? 32 : 0));
    }
 
    _instanceIds[newInstanceId] = true;
 
    return newInstanceId;
}
 
void MapManager::FreeInstanceId(uint32 instanceId)
{
    // If freed instance id is lower than the next id available for new instances, use the freed one instead
    if (instanceId < _nextInstanceId)
        SetNextInstanceId(instanceId);
 
    _instanceIds[instanceId] = false;
}