Add experimental support for pulling Data Packs from Ultimate archives

Author: oblivioncth

CMakeLists.txt

@@ -84,7 +84,7 @@ ob_fetch_qx(
 
 # Fetch libfp (build and import from source)
 include(OB/Fetchlibfp)
-ob_fetch_libfp("v0.5.6")
+ob_fetch_libfp("ed105fc35b92cd64c1cddfc35b51cc0027974afb")
 
 # Fetch QI-QMP (build and import from source)
 include(OB/FetchQI-QMP)

lib/backend/CMakeLists.txt

@@ -57,6 +57,8 @@ set(BACKEND_IMPLEMENTATION
     task/t-mount.cpp
     task/t-sleep.h
     task/t-sleep.cpp
+    tools/archiveaccess.h
+    tools/archiveaccess.cpp
     tools/blockingprocessmanager.h
     tools/blockingprocessmanager.cpp
     tools/deferredprocessmanager.h

lib/backend/src/kernel/core.cpp

@@ -4,6 +4,7 @@
 // Qx Includes
 #include <qx/utility/qx-helpers.h>
 #include <qx/core/qx-system.h>
+#include <qx/core/qx-integrity.h>
 
 // libfp Includes
 #include <fp/fp-install.h>
@@ -25,6 +26,7 @@
 #ifdef __linux__
     #include "task/t-awaitdocker.h"
 #endif
+#include "tools/archiveaccess.h"
 #include "utility.h"
 #include "_buildinfo.h"
 
@@ -428,6 +430,10 @@ void Core::attachFlashpoint(std::unique_ptr<Fp::Install> flashpointInstall)
      * or a future feature (hopefully not). Either way it just points to the PHP server port.
      */
 #endif
+
+    // Setup archive access
+    if(info->edition() == Fp::Install::VersionInfo::Ultimate)
+        mGamesArchive = std::make_unique<ArchiveAccess>(*this, ArchiveAccess::GameData);
 }
 
 QString Core::resolveFullAppPath(const QString& appPath, const QString& platform)
@@ -679,36 +685,76 @@ Qx::Error Core::enqueueDataPackTasks(const Fp::GameData& gameData)
     QString packFilename = tk->datapackFilename(gameData);
     logEvent(LOG_EVENT_DATA_PACK_PATH.arg(packPath));
 
-    // Enqueue pack download if it's not available
+    // Try to acquire data pack if it's not present
     if(!tk->datapackIsPresent(gameData))
     {
         logEvent(LOG_EVENT_DATA_PACK_MISS);
 
-        TDownload* downloadTask = new TDownload(*this);
-        downloadTask->setStage(Task::Stage::Auxiliary);
-        downloadTask->setDescription(u"data pack "_s + packFilename);
-        TDownloadError packError = downloadTask->addDatapack(tk, &gameData);
-        if(packError.isValid())
+        auto edition = mFlashpointInstall->versionInfo()->edition();
+        if(edition == Fp::Install::VersionInfo::Ultimate)
         {
-            postDirective<DError>(packError);
-            return packError;
+            /* TODO: Might want to make all of this its own task, and have a static, singleton, manager
+             * type (e.g. ArchiveAccessManager) that holds the archive instances, instead of core,
+             * which is then used by that task, and then here we just setup the task. This way we
+             * can also have more specific errors instead of just the one (with events).
+             */
+            Q_ASSERT(mGamesArchive);
+            logEvent(LOG_EVENT_DATA_PACK_FROM_ARCHIVE);
+
+            // Check archive
+            QByteArray datapackData = mGamesArchive->getFileContents(DATA_PACK_FROM_ARCHIVE_TEMPLATE.arg(packFilename));
+            if(datapackData.isEmpty())
+            {
+                logEvent(LOG_EVENT_DATA_PACK_FROM_ARCHIVE_NOT_FOUND);
+                CoreError err(CoreError::CannotObtainDatapack);
+                postDirective<DError>(err);
+                return err;
+            }
+
+            logEvent(LOG_EVENT_DATA_PACK_FROM_ARCHIVE_FOUND);
+            if(Qx::Integrity::crc32(datapackData) != gameData.crc32())
+            {
+                logEvent(LOG_EVENT_DATA_PACK_FROM_ARCHIVE_CORRUPT);
+                CoreError err(CoreError::CannotObtainDatapack);
+                postDirective<DError>(err);
+                return err;
+            }
+
+            // Save to disk
+            QFile packFile(packPath);
+            if(auto writeOp = Qx::writeBytesToFile(packFile, datapackData); writeOp.isFailure())
+                return writeOp;
+
+            logEvent(LOG_EVENT_DATA_PACK_FROM_ARCHIVE_SAVED);
+        }
+        else // Basically just Infinity
+        {
+            TDownload* downloadTask = new TDownload(*this);
+            downloadTask->setStage(Task::Stage::Auxiliary);
+            downloadTask->setDescription(u"data pack "_s + packFilename);
+            TDownloadError packError = downloadTask->addDatapack(tk, &gameData);
+            if(packError.isValid())
+            {
+                postDirective<DError>(packError);
+                return packError;
+            }
+
+            mTaskQueue.push(downloadTask);
+            logTask(downloadTask);
+
+            // Add task to update DB with onDiskState
+            int gameDataId = gameData.id();
+
+            TGeneric* onDiskUpdateTask = new TGeneric(*this);
+            onDiskUpdateTask->setStage(Task::Stage::Auxiliary);
+            onDiskUpdateTask->setDescription(u"Update GameData onDisk state."_s);
+            onDiskUpdateTask->setAction([gameDataId, this]{
+                return mFlashpointInstall->database()->updateGameDataOnDiskState({gameDataId}, true);
+            });
+
+            mTaskQueue.push(onDiskUpdateTask);
+            logTask(onDiskUpdateTask);
         }
-
-        mTaskQueue.push(downloadTask);
-        logTask(downloadTask);
-
-        // Add task to update DB with onDiskState
-        int gameDataId = gameData.id();
-
-        TGeneric* onDiskUpdateTask = new TGeneric(*this);
-        onDiskUpdateTask->setStage(Task::Stage::Auxiliary);
-        onDiskUpdateTask->setDescription(u"Update GameData onDisk state."_s);
-        onDiskUpdateTask->setAction([gameDataId, this]{
-            return mFlashpointInstall->database()->updateGameDataOnDiskState({gameDataId}, true);
-        });
-
-        mTaskQueue.push(onDiskUpdateTask);
-        logTask(onDiskUpdateTask);
     }
     else
         logEvent(LOG_EVENT_DATA_PACK_FOUND);

lib/backend/src/kernel/core.h

@@ -39,7 +39,8 @@ class QX_ERROR_TYPE(CoreError, "CoreError", 1200)
         TitleNotFound,
         TooManyResults,
         ConfiguredServerMissing,
-        UnknownDatapackParam
+        UnknownDatapackParam,
+        CannotObtainDatapack
     };
 
 //-Class Variables-------------------------------------------------------------
@@ -52,7 +53,8 @@ class QX_ERROR_TYPE(CoreError, "CoreError", 1200)
         {TitleNotFound, u"Could not find the title in the Flashpoint database."_s},
         {TooManyResults, u"More results than can be presented were returned in a search."_s},
         {ConfiguredServerMissing, u"The configured server was not found within the Flashpoint services store."_s},
-        {UnknownDatapackParam, u"Unrecognized datapack parameters were present. The game likely won't work correctly."_s}
+        {UnknownDatapackParam, u"Unrecognized datapack parameters were present. The game likely won't work correctly."_s},
+        {CannotObtainDatapack, u"The specified datapack could not be obtained via edition appropriate means."_s}
     };
 
 //-Instance Variables-------------------------------------------------------------
@@ -84,6 +86,7 @@ class Install;
 class GameData;
 }
 class TExec;
+class ArchiveAccess;
 
 class Core : public QObject, public Directorate
 {
@@ -133,6 +136,11 @@ class Core : public QObject, public Directorate
     static inline const QString LOG_EVENT_DATA_PACK_NEEDS_MOUNT = u"Title Data Pack requires mounting"_s;
     static inline const QString LOG_EVENT_DATA_PACK_NEEDS_EXTRACT = u"Title Data Pack requires extraction"_s;
     static inline const QString LOG_EVENT_DATA_PACK_ALREADY_EXTRACTED = u"Extracted files already present"_s;
+    static inline const QString LOG_EVENT_DATA_PACK_FROM_ARCHIVE = u"Retrieving Data Pack from archive"_s;
+    static inline const QString LOG_EVENT_DATA_PACK_FROM_ARCHIVE_NOT_FOUND = u"Data Pack could not be found in the archive!"_s;
+    static inline const QString LOG_EVENT_DATA_PACK_FROM_ARCHIVE_CORRUPT = u"Data Pack from archive is corrupted!"_s;
+    static inline const QString LOG_EVENT_DATA_PACK_FROM_ARCHIVE_FOUND = u"Data Pack found in archive."_s;
+    static inline const QString LOG_EVENT_DATA_PACK_FROM_ARCHIVE_SAVED = u"Sourced Data Pack from archive."_s;
     static inline const QString LOG_EVENT_APP_PATH_ALT = u"App path \"%1\" maps to alternative \"%2\"."_s;
     static inline const QString LOG_EVENT_SERVICES_FROM_LAUNCHER = u"Using services from standard Launcher due to companion mode."_s;
     static inline const QString LOG_EVENT_LAUNCHER_WATCH = u"Starting bide on Launcher process..."_s;
@@ -203,6 +211,7 @@ class Core : public QObject, public Directorate
 
     // Helper
     static const int FIND_ENTRY_LIMIT = 20;
+    static inline const QString DATA_PACK_FROM_ARCHIVE_TEMPLATE = u"Flashpoint Ultimate/Data/Games/%1"_s;
 
     // Protocol
     static inline const QString FLASHPOINT_PROTOCOL_SCHEME = u"flashpoint://"_s;
@@ -217,6 +226,7 @@ class Core : public QObject, public Directorate
 
     // Handles
     std::unique_ptr<Fp::Install> mFlashpointInstall;
+    std::unique_ptr<ArchiveAccess> mGamesArchive;
 
     // Processing
     ServicesMode mServicesMode;

lib/backend/src/tools/archiveaccess.cpp

@@ -0,0 +1,117 @@
+// Unit Include
+#include "archiveaccess.h"
+
+// Qx Includes
+#include <qx/io/qx-common-io.h>
+
+// Project Includes
+#include "kernel/core.h"
+#include "utility.h"
+
+//===============================================================================================================
+// MounterError
+//===============================================================================================================
+
+//-Constructor-------------------------------------------------------------
+//Private:
+ArchiveAccessError::ArchiveAccessError(Type t, const QString& s) :
+    mType(t),
+    mSpecific(s)
+{}
+
+//-Instance Functions-------------------------------------------------------------
+//Public:
+bool ArchiveAccessError::isValid() const { return mType != NoError; }
+QString ArchiveAccessError::specific() const { return mSpecific; }
+ArchiveAccessError::Type ArchiveAccessError::type() const { return mType; }
+
+//Private:
+Qx::Severity ArchiveAccessError::deriveSeverity() const { return Qx::Warning; }
+quint32 ArchiveAccessError::deriveValue() const { return mType; }
+QString ArchiveAccessError::derivePrimary() const { return ERR_STRINGS.value(mType); }
+QString ArchiveAccessError::deriveSecondary() const { return mSpecific; }
+
+//===============================================================================================================
+// ArchiveAccess
+//===============================================================================================================
+
+//-Constructor-------------------------------------------------------------
+//Public:
+ArchiveAccess::ArchiveAccess(Core& core, Type type) :
+    Directorate(core.director()),
+    mType(type)
+{
+    logEvent(MSG_INIT.arg(ENUM_NAME(mType)));
+
+    // Initialize parts
+    QStringList partPaths;
+    if(auto archDirOp = Qx::dirContentList(partPaths, mArchivesDir, { ZIP_FILTER_TEMPLATE.arg(ENUM_NAME(type)) }); archDirOp.isFailure())
+    {
+        logError(archDirOp);
+        return;
+    }
+
+    if(partPaths.isEmpty())
+    {
+        logError(ArchiveAccessError(ArchiveAccessError::NoParts, ENUM_NAME(type)));
+        return;
+    }
+    logEvent(MSG_PART_COUNT.arg(mParts.size()));
+
+    for(const auto& pp : std::as_const(partPaths))
+        mParts.emplace_back(pp);
+}
+
+//-Instance Functions-------------------------------------------------------------
+//Private:
+bool ArchiveAccess::readyPart(QuaZip& part)
+{
+    if(part.isOpen())
+    {
+        logEvent(MSG_PART_OPEN);
+        return true;
+    }
+
+    logEvent(MSG_PREPARING_PART.arg(part.getZipName()));
+    if(!part.open(QuaZip::mdUnzip))
+    {
+        logError(ArchiveAccessError(ArchiveAccessError::NoParts, part.getZipName()));
+        return false;
+    }
+
+    return true;
+}
+
+//Public:
+QString ArchiveAccess::name() const { return NAME; }
+
+QByteArray ArchiveAccess::getFileContents(const QString& inZipPath)
+{
+    /* Maybe return an ArchiveAccessError, for cases where something unexpected happened
+     * (can't open zip, or file not found), and treat those cases as an error instead
+     * of a warning.
+     */
+    logEvent(MSG_FILE_SEARCH.arg(ENUM_NAME(mType), inZipPath));
+
+    // Simply search all parts (what the stock launcher does, though I'm sure it could be more optimal)
+    for(auto& part : mParts)
+    {
+        if(!readyPart(part))
+            continue;
+
+        if(part.setCurrentFile(inZipPath))
+        {
+            QuaZipFile file(&part); // auto-closes on destruct
+            if(!file.open(QIODevice::ReadOnly))
+            {
+                logError(ArchiveAccessError(ArchiveAccessError::CantOpenFile, part.getZipName()));
+                break;
+            }
+
+            return file.readAll();
+        }
+    }
+
+    logError(ArchiveAccessError(ArchiveAccessError::FileNotFound));
+    return {};
+}