CWE-ou-minkata/Sources/Plasma/Apps/plPageOptimizer/plPageOptimizer.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 "plPageOptimizer.h"

#include "pnKeyedObject/plUoid.h"
#include "plResMgr/plResManager.h"
#include "plResMgr/plRegistryHelpers.h"
#include "plResMgr/plKeyFinder.h"
#include "plResMgr/plRegistryNode.h"

#include "pnFactory/plFactory.h"
#include "pnKeyedObject/plKeyImp.h"

#include "hsStream.h"

plPageOptimizer* plPageOptimizer::fInstance = nil;

plPageOptimizer::plPageOptimizer(const plFileName& pagePath) :
    fOptimized(true),
    fPageNode(nil),
    fPagePath(pagePath)
{
    fInstance = this;

    fTempPagePath = fPagePath.StripFileExt() + "_opt.prp";

    fResMgr = (plResManager*)hsgResMgr::ResMgr();
}

void plPageOptimizer::IFindLoc()
{
    class plPageIt : public plRegistryPageIterator 
    {
    public:
        plLocation fLoc;

        virtual bool EatPage(plRegistryPageNode* keyNode)
        {
            fLoc = keyNode->GetPageInfo().GetLocation();
            return true;
        }
    };

    plPageIt it;
    fResMgr->IterateAllPages(&it);
    fLoc = it.fLoc;
}

void plPageOptimizer::Optimize()
{
    fResMgr->AddSinglePage(fPagePath);

    // Get the location of the page we're optimizing
    IFindLoc();

    bool loaded = true;

    // Get the key for the scene node, we'll load it to force a load on all the objects
    plKey snKey = plKeyFinder::Instance().FindSceneNodeKey(fLoc);
    if (snKey)
    {
        // Load all the keys
        fPageNode = fResMgr->FindPage(fLoc);
        fResMgr->LoadPageKeys(fPageNode);

        // Put all the keys in a vector, so they won't get unreffed
        class plVecKeyCollector : public plRegistryKeyIterator
        {
        public:
            KeyVec& fKeys;
            plVecKeyCollector(KeyVec& keys) : fKeys(keys) {}
            virtual bool EatKey(const plKey& key) { fKeys.push_back(key); return true; }
        };
        plVecKeyCollector keyIt(fAllKeys);
        fResMgr->IterateKeys(&keyIt);

        // Set our load proc, which will track the order that objects are loaded
        fResMgr->SetProgressBarProc(KeyedObjectProc);

        // Load the page
        snKey->VerifyLoaded();

        // Unload everything
        snKey->RefObject();
        snKey->UnRefObject();
        snKey = nil;
    }
    else
    {
        loaded = false;
    }

    if (loaded)
        IRewritePage();

    uint64_t oldSize = plFileInfo(fPagePath).FileSize();
    uint64_t newSize = plFileInfo(fTempPagePath).FileSize();

    if (!loaded)
    {
        puts("no scene node.");
    }
    else if (fOptimized)
    {
        plFileSystem::Unlink(fTempPagePath);
        puts("already optimized.");
    }
    else if (oldSize == newSize)
    {
        plFileSystem::Unlink(fPagePath);
        plFileSystem::Move(fTempPagePath, fPagePath);

        puts("complete");
    }
    else
    {
        plFileSystem::Unlink(fTempPagePath);
        puts("failed.  File sizes different");
    }
}

void plPageOptimizer::KeyedObjectProc(plKey key)
{
    plString keyName = key->GetName();
    const char* className = plFactory::GetNameOfClass(key->GetUoid().GetClassType());

    // For now, ignore any key that isn't in the location we're looking at.  That means stuff like textures.
    if (fInstance->fLoc != key->GetUoid().GetLocation())
        return;

    KeySet& loadedKeys = fInstance->fLoadedKeys;
    KeyVec& loadOrder = fInstance->fKeyLoadOrder;

    KeySet::iterator it = loadedKeys.lower_bound(key);
    if (it != loadedKeys.end() && *it == key)
    {
        printf("Keyed object %s(%s) loaded more than once\n", keyName.c_str(), className);
    }
    else
    {
        loadedKeys.insert(it, key);
        loadOrder.push_back(key);
    }
}

void plPageOptimizer::IWriteKeyData(hsStream* oldPage, hsStream* newPage, plKey key)
{
    class plUpdateKeyImp : public plKeyImp
    {
    public:
        void SetStartPos(uint32_t startPos) { fStartPos = startPos; }
    };

    plUpdateKeyImp* keyImp = (plUpdateKeyImp*)(plKeyImp*)key;
    uint32_t startPos = keyImp->GetStartPos();
    uint32_t len = keyImp->GetDataLen();

    oldPage->SetPosition(startPos);
    if (len > fBuf.size())
        fBuf.resize(len);
    oldPage->Read(len, &fBuf[0]);

    uint32_t newStartPos = newPage->GetPosition();

    // If we move any buffers, this page wasn't optimized already
    if (newStartPos != startPos)
        fOptimized = false;

    keyImp->SetStartPos(newStartPos);
    newPage->Write(len, &fBuf[0]);
}

void plPageOptimizer::IRewritePage()
{
    hsUNIXStream newPage;

    if (newPage.Open(fTempPagePath, "wb"))
    {
        hsUNIXStream oldPage;
        oldPage.Open(fPagePath);

        const plPageInfo& pageInfo = fPageNode->GetPageInfo();

        uint32_t dataStart = pageInfo.GetDataStart();

        fBuf.resize(dataStart);

        oldPage.Read(dataStart, &fBuf[0]);
        newPage.Write(dataStart, &fBuf[0]);

        int size = (int)fKeyLoadOrder.size();
        for (int i = 0; i < size; i++)
            IWriteKeyData(&oldPage, &newPage, fKeyLoadOrder[i]);

        // If there are any objects that we didn't write (because they didn't load for
        // some reason), put them at the end
        for (int i = 0; i < fAllKeys.size(); i++)
        {
            bool found = (fLoadedKeys.find(fAllKeys[i]) != fLoadedKeys.end());
            if (!found)
                IWriteKeyData(&oldPage, &newPage, fAllKeys[i]);
        }

        uint32_t newKeyStart = newPage.GetPosition();
        uint32_t oldKeyStart = pageInfo.GetIndexStart();
        oldPage.SetPosition(oldKeyStart);

        uint32_t numTypes = oldPage.ReadLE32();
        newPage.WriteLE32(numTypes);

        for (uint32_t i = 0; i < numTypes; i++)
        {
            uint16_t classType = oldPage.ReadLE16();
            uint32_t len = oldPage.ReadLE32();
            uint8_t flags = oldPage.ReadByte();
            uint32_t numKeys = oldPage.ReadLE32();

            newPage.WriteLE16(classType);
            newPage.WriteLE32(len);
            newPage.WriteByte(flags);
            newPage.WriteLE32(numKeys);

            for (uint32_t j = 0; j < numKeys; j++)
            {
                plUoid uoid;
                uoid.Read(&oldPage);
                uint32_t startPos = oldPage.ReadLE32();
                uint32_t dataLen = oldPage.ReadLE32();

                // Get the new start pos
                plKeyImp* key = (plKeyImp*)fResMgr->FindKey(uoid);
                startPos = key->GetStartPos();

                uoid.Write(&newPage);
                newPage.WriteLE32(startPos);
                newPage.WriteLE32(dataLen);
            }
        }

        newPage.Close();
        oldPage.Close();
    }
}