CWE-ou-minkata/Sources/Plasma/PubUtilLib/plStatGather/plAutoProfile.cpp

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#include "plAutoProfile.h"

#include "plgDispatch.h"
#include "plNetClient/plNetClientMgr.h"
#include "plNetClient/plNetLinkingMgr.h"

#include "hsStream.h"
#include "hsTimer.h"
#include "plMessage/plAgeLoadedMsg.h"
#include "pnTimer/plTimerCallbackManager.h"
#include "plMessage/plTimerCallbackMsg.h"
#include "plAvatar/plAvatarMgr.h"
#include "plAvatar/plArmatureMod.h"
#include "plModifier/plSpawnModifier.h"
#include "plMessage/plConsoleMsg.h"
#include "pnMessage/plClientMsg.h"
#include "plAgeLoader/plAgeLoader.h"
#include "plProfileManagerFull.h"

#include "plPipeline/plDebugText.h"
#include "pnMessage/plTimeMsg.h"

#include "plStatusLog/plStatusLog.h"
#include "plVault/plVault.h"

#include "plContainer/plConfigInfo.h" // for plStringList

// For taking screenshots
#include "plGImage/plMipmap.h"
#include "../../Apps/plClient/plClient.h"
#include "plGImage/plJPEG.h"
#include "plPipeline.h"

#include <algorithm>

class plAutoProfileImp : public plAutoProfile
{
protected:
    plStringList fAges;
    int fNextAge;
    int fNextSpawnPoint;
    plString fLastSpawnPointName;
    // For profiling a single age
    std::string fAgeName;
    bool fLinkedToSingleAge;
    bool fJustLinkToAges;

    uint64_t fLinkTime;

    plString fStatusMessage;

    void INextProfile();
    bool INextAge();
    bool INextSpawnPoint();

    void IInit();
    void IShutdown();

public:
    plAutoProfileImp();

    virtual void StartProfile(const char* ageName);
    virtual void LinkToAllAges();

    virtual bool MsgReceive(plMessage* msg);
};

plAutoProfile* plAutoProfile::Instance()
{
    static plAutoProfileImp theInstance;
    return &theInstance;
}

////////////////////////////////////////////////////////////////////////////////

plAutoProfileImp::plAutoProfileImp() : fNextAge(0), fNextSpawnPoint(0), fLinkedToSingleAge(false), fJustLinkToAges(false)
{
}

void plAutoProfileImp::StartProfile(const char* ageName)
{
    if (ageName)
        fAgeName = ageName;
    else
        fAgeName = "";

    IInit();

    plProfileManagerFull::Instance().ActivateAllStats();
}

void plAutoProfileImp::LinkToAllAges()
{
    fJustLinkToAges = true;
    IInit();
}

void plAutoProfileImp::IInit()
{
    // TODO: Find a better way to grab a list of age names, since the old data server
    // no longer exists
    /*plIDataServer* dataServer = plNetClientMgr::GetInstance()->GetDataServer();
    if (!dataServer)
        return;

    dataServer->GetDatasetAges(fAges);*/

    // The first age we link into is AvatarCustomization, since we have a new avatar.
    // Coincidentally, the first age in our list is AvatarCustomization.  However,
    // sometimes linking from ACA to ACA causes a crash.  To get around that, we just
    // reverse the list, so it's last.
    std::reverse(fAges.begin(), fAges.end());

    fNextAge = 0;

    RegisterAs(kAutoProfile_KEY);

    plgDispatch::Dispatch()->RegisterForExactType(plAgeBeginLoadingMsg::Index(), GetKey());
    plgDispatch::Dispatch()->RegisterForExactType(plAgeLoadedMsg::Index(), GetKey());
    plgDispatch::Dispatch()->RegisterForExactType(plInitialAgeStateLoadedMsg::Index(), GetKey());
    plgDispatch::Dispatch()->RegisterForExactType(plEvalMsg::Index(), GetKey());

    plConsoleMsg* consoleMsg = new plConsoleMsg(plConsoleMsg::kExecuteLine, "Camera.AlwaysCut true");
    consoleMsg->Send();
}

#ifdef HS_BUILD_FOR_WIN32

#include <shellapi.h>
#endif

void plAutoProfileImp::IShutdown()
{
    // KLUDGE - Copy the load timing log, in case we used it
    #define kTimingLog      "readtimings.0.log"
    #define kAgeTimingLog   "agetimings.0.log"

    plFileSystem::Copy(plFileName::Join(plFileSystem::GetLogPath(), kTimingLog),
                       plFileName::Join(plProfileManagerFull::Instance().GetProfilePath(), kTimingLog));
    plFileSystem::Copy(plFileName::Join(plFileSystem::GetLogPath(), kAgeTimingLog),
                       plFileName::Join(plProfileManagerFull::Instance().GetProfilePath(), kAgeTimingLog));

#ifdef HS_BUILD_FOR_WIN32
    ShellExecute(nil, nil, "PostRun.bat", nil, nil, SW_SHOWNORMAL);
#endif

    plgDispatch::Dispatch()->UnRegisterForExactType(plEvalMsg::Index(), GetKey());
    plgDispatch::Dispatch()->UnRegisterForExactType(plInitialAgeStateLoadedMsg::Index(), GetKey());
    plgDispatch::Dispatch()->UnRegisterForExactType(plAgeLoadedMsg::Index(), GetKey());

    UnRegisterAs(kAutoProfile_KEY);
    // Pump the queue so we get fully unregistered
    plgDispatch::Dispatch()->MsgQueueProcess();

    plClientMsg* clientMsg = new plClientMsg(plClientMsg::kQuit);
    clientMsg->Send(hsgResMgr::ResMgr()->FindKey(kClient_KEY));
}

void plAutoProfileImp::INextProfile()
{
    // Haven't linked to our first age yet, do that before we start profiling
    if (fNextAge == 0)
    {
        if (!INextAge())
            IShutdown();
    }
    else
    {
        // Log the stats for this spawn point
        if (!fLastSpawnPointName.IsNull())
        {
            plString ageName = NetCommGetAge()->ageDatasetName;
            plProfileManagerFull::Instance().LogStats(ageName, fLastSpawnPointName);

            plMipmap mipmap;
            if (plClient::GetInstance()->GetPipeline()->CaptureScreen(&mipmap))
            {
                plString fileName = plFormat("{}\\{}_{}.jpg",
                    plProfileManagerFull::Instance().GetProfilePath(),
                    ageName, fLastSpawnPointName);

                plJPEG::Instance().SetWriteQuality(100);
                plJPEG::Instance().WriteToFile(fileName.c_str(), &mipmap);
            }

            fLastSpawnPointName = plString::Null;
        }

        // Try to go to the next spawn point
        if (!INextSpawnPoint())
        {
            // Link to the next age
            if (!INextAge())
            {
                // We've done all the ages, shut down
                IShutdown();
            }
        }
    }
}

bool plAutoProfileImp::INextAge()
{
    const char* ageName = nil;

    if (fAgeName.length() > 0)
    {
        if (fLinkedToSingleAge)
            return false;

        fLinkedToSingleAge = true;
        ageName = fAgeName.c_str();
    }
    else
    {
        if (fNextAge >= fAges.size())
            return false;

        ageName = fAges[fNextAge].c_str();
    }

    fNextAge++;
    fNextSpawnPoint = 0;

    plAgeLinkStruct link;
    link.GetAgeInfo()->SetAgeFilename(ageName);
    link.SetLinkingRules(plNetCommon::LinkingRules::kBasicLink);
    plNetLinkingMgr::GetInstance()->LinkToAge(&link);

    fStatusMessage = "Linking to age ";
    fStatusMessage += ageName;

    return true;
}

bool plAutoProfileImp::INextSpawnPoint()
{
    if (fJustLinkToAges)
        return false;

    const char* kPerfSpawnPrefix = "cPerf-";
    int kPerfSpawnLen = strlen(kPerfSpawnPrefix);

    // Find the next perf spawn point
    bool foundGood = false;
    while (fNextSpawnPoint < plAvatarMgr::GetInstance()->NumSpawnPoints())
    {
        const plSpawnModifier* spawnMod = plAvatarMgr::GetInstance()->GetSpawnPoint(fNextSpawnPoint);
        fLastSpawnPointName = spawnMod->GetKeyName();

        if (fLastSpawnPointName.CompareN(kPerfSpawnPrefix, kPerfSpawnLen) == 0)
        {
            fStatusMessage = "Profiling spawn point ";
            fStatusMessage += fLastSpawnPointName;

            foundGood = true;
            break;
        }
        else
            fNextSpawnPoint++;
    }

    if (!foundGood)
    {
        fLastSpawnPointName = plString::Null;
        fStatusMessage = "No profile spawn point found";
        return false;
    }

    plArmatureMod *avatar = plAvatarMgr::GetInstance()->GetLocalAvatar();
    if (avatar)
    {
        double fakeTime = 0.0f;
        avatar->SpawnAt(fNextSpawnPoint, fakeTime);
    }

    fNextSpawnPoint++;

    plTimerCallbackMsg* timerMsg = new plTimerCallbackMsg(GetKey());
    plgTimerCallbackMgr::NewTimer(30, timerMsg);

    return true;
}

bool plAutoProfileImp::MsgReceive(plMessage* msg)
{
    plEvalMsg* evalMsg = plEvalMsg::ConvertNoRef(msg);
    if (evalMsg)
    {
        if (fStatusMessage.GetSize() > 0)
            plDebugText::Instance().DrawString(10, 10, fStatusMessage.c_str());
    }

    plAgeLoadedMsg* ageLoaded = plAgeLoadedMsg::ConvertNoRef(msg);
    if (ageLoaded)
    {
        if (!ageLoaded->fLoaded)
        {
            fLinkTime = hsTimer::GetTicks();
            hsStatusMessage("Age unloaded");
        }
        return true;
    }

    plInitialAgeStateLoadedMsg* ageStateLoaded = plInitialAgeStateLoadedMsg::ConvertNoRef(msg);
    if (ageStateLoaded)
    {
        if (fNextAge > 0)
        {
            fLinkTime = hsTimer::GetTicks() - fLinkTime;
            float ms = hsTimer::GetMilliSeconds<float>(fLinkTime);

            hsStatusMessageF("Age %s finished load, took %.1f ms",
                fAges[fNextAge-1].c_str(),
                ms);

            plStatusLog::AddLineS("agetimings.log", "Age %s took %.1f ms",
                fAges[fNextAge-1].c_str(),
                ms);
        }

        fStatusMessage = "Age loaded.  Preparing to profile.";

        // Age is loaded, start profiling in 5 seconds (to make sure the avatar is linked in all the way)
        plTimerCallbackMsg* timerMsg = new plTimerCallbackMsg(GetKey());
        plgTimerCallbackMgr::NewTimer(5, timerMsg);
        return true;
    }

    plTimerCallbackMsg* timerMsg = plTimerCallbackMsg::ConvertNoRef(msg);
    if (timerMsg)
    {
        INextProfile();
        return true;
    }

    // When the first age starts to load, register the stupid avatar customization variable
    // so the calibration screen won't pop up and ruin everything.  I'm sure I could try
    // and do this earlier, but I'm not sure when that player folder is set so screw it, it works here.
    plAgeBeginLoadingMsg* ageBeginLoadingMsg = plAgeBeginLoadingMsg::ConvertNoRef(msg);
    if (ageBeginLoadingMsg)
    {
        plgDispatch::Dispatch()->UnRegisterForExactType(plAgeBeginLoadingMsg::Index(), GetKey());
        VaultAddChronicleEntryAndWait("InitialAvCursomizationsDone", 0, "1");
        return true;
    }

    return false;
}