Add support for using Ruffle, switch and config parse

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.5")
+ob_fetch_libfp("b857d257f95f53ab4e7c78f9bad91828bc118ece")
 
 # Fetch QI-QMP (build and import from source)
 include(OB/FetchQI-QMP)

README.md

@@ -176,9 +176,9 @@ Title Comamnd Shared Options:
 - **-S | --subtitle-strict:** Same as **-s**, but only exact matches are considered
 - **-r | --random:** Selects  a  random  title  from  the  database.  Must  be  followed  by  a  library  filter:  `all`/`any`,  `game`/`arcade`,  or `animation`/`theatre`
 
-The **-title** and **-subtitle** options are case-insensitive and will match any title that contains the value provided; however, the provided title should match as closely as possible to how it appears within Flashpoint, as checks for close matches are limited due to technical restrictions. If more than one entry is found, a dialog window with more information will be displayed so that the intended title can be selected, though there is a limit to the number of matches.
+The **--title** and **--subtitle** options are case-insensitive and will match any title that contains the value provided; however, the provided title should match as closely as possible to how it appears within Flashpoint, as checks for close matches are limited due to technical restrictions. If more than one entry is found, a dialog window with more information will be displayed so that the intended title can be selected, though there is a limit to the number of matches.
 
-The **-title-strict** and **-subtitle-strict** options only consider exact matches and are performed slightly faster than their more flexible counterparts.
+The **--title-strict** and **--subtitle-strict** options only consider exact matches and are performed slightly faster than their more flexible counterparts.
 
 Tip: You can use **-subtitle** with an empty string (i.e. `-s ""`) to see all of the additional-apps for a given title.
 
@@ -208,6 +208,8 @@ Notes:
 Options:
 
 - [Title Command](#title-commands) options
+- **--ruffle:** Forces the use of Ruffle for applicable Flash games. Takes precedence over **--flash**.
+- **--flash:** Forces the use of the standard app (usually Flash Player) for applicable Flash games.
 
 Notes:
  - You can use `--` to pass arguments directly to the title's underlying executable/script, which can be useful for testing or customizing your experience:

lib/backend/src/command/c-play.cpp

@@ -82,6 +82,13 @@ void CPlay::addPassthroughParameters(QString& param)
     }
 }
 
+void CPlay::addPassthroughParameters(QStringList& param)
+{
+    // See above method
+    QStringList ptp = mParser.positionalArguments();
+    param.append(ptp);
+}
+
 QString CPlay::getServerOverride(const Fp::GameData& gd)
 {
     QString override = gd.isNull() ? QString() : gd.parameters().server();
@@ -91,6 +98,36 @@ QString CPlay::getServerOverride(const Fp::GameData& gd)
     return override;
 }
 
+bool CPlay::useRuffle(const Fp::Game& game, Task::Stage stage)
+{
+    if(game.platformName() != u"Flash"_s || stage != Task::Stage::Primary)
+        return false;
+
+    auto& extCfg = mCore.fpInstall().extConfig();
+    if(mParser.isSet(CL_OPTION_RUFFLE))
+    {
+        logEvent(LOG_EVENT_FORCING_RUFFLE);
+        return true;
+    }
+    else if(mParser.isSet(CL_OPTION_FLASH))
+    {
+        logEvent(LOG_EVENT_FORCING_FLASH);
+        return false;
+    }
+    else if(extCfg.com_ruffle_enabled && !game.ruffleSupport().isEmpty())
+    {
+        logEvent(LOG_EVENT_USING_RUFFLE_SUPPORTED);
+        return true;
+    }
+    else if(extCfg.com_ruffle_enabled_all)
+    {
+        logEvent(LOG_EVENT_USING_RUFFLE_UNSUPPORTED);
+        return true;
+    }
+
+    return false;
+}
+
 Qx::Error CPlay::handleEntry(const Fp::Game& game)
 {
     logEvent(LOG_EVENT_ID_MATCH_TITLE.arg(game.title()));
@@ -150,12 +187,13 @@ Qx::Error CPlay::handleEntry(const Fp::Game& game)
         {
             logEvent(LOG_EVENT_FOUND_AUTORUN.arg(addApp.name()));
 
-            if(sError = enqueueAdditionalApp(addApp, game.platformName(), Task::Stage::Auxiliary); sError.isValid())
+            if(sError = enqueueAdditionalApp(addApp, game, Task::Stage::Auxiliary); sError.isValid())
                 return sError;
         }
     }
 
     // Enqueue game
+    postDirective<DStatusUpdate>(STATUS_PLAY, game.title());
     if(sError = enqueueGame(game, gameData, Task::Stage::Primary); sError.isValid())
         return sError;
 
@@ -168,19 +206,32 @@ Qx::Error CPlay::handleEntry(const Fp::Game& game)
 Qx::Error CPlay::handleEntry(const Fp::AddApp& addApp)
 {
     logEvent(LOG_EVENT_ID_MATCH_ADDAPP.arg(addApp.name(),
-                                                       addApp.parentId().toString(QUuid::WithoutBraces)));
+                                           addApp.parentId().toString(QUuid::WithoutBraces)));
 
     Qx::Error sError;
     Fp::Db* db = mCore.fpInstall().database();
 
-    // Check if parent entry uses a data pack
+    // Get parent info
     QUuid parentId = addApp.parentId();
+    Fp::Entry parentEntry;
+    Fp::Game parentGame;
     Fp::GameData parentGameData;
+
+    if(Fp::DbError gdErr = db->getEntry(parentEntry, parentId); gdErr.isValid())
+    {
+        postDirective<DError>(gdErr);
+        return gdErr;
+    }
+    Q_ASSERT(std::holds_alternative<Fp::Game>(parentEntry));
+    parentGame = std::get<Fp::Game>(parentEntry);
+
     if(Fp::DbError gdErr = db->getGameData(parentGameData, parentId); gdErr.isValid())
     {
         postDirective<DError>(gdErr);
         return gdErr;
     }
+
+    // Check if parent entry uses a data pack
     bool hasDatapack = !parentGameData.isNull();
 
     // Get server override (if not present, will result in the default server being used)
@@ -200,27 +251,9 @@ Qx::Error CPlay::handleEntry(const Fp::AddApp& addApp)
             return sError;
     }
 
-    // Get parent info to determine platform
-    Fp::Db::EntryFilter parentFilter{.type = Fp::Db::EntryType::Primary, .id = parentId};
-
-    Fp::Db::QueryBuffer parentResult;
-
-    if(Fp::DbError pge = db->queryEntrys(parentResult, parentFilter); pge.isValid())
-    {
-        postDirective<DError>(pge);
-        return pge;
-    }
-
-    // Advance result to only record
-    parentResult.result.next();
-
-    // Determine platform (don't bother building entire game object since only one value is needed)
-    QString platformName = parentResult.result.value(Fp::Db::Table_Game::COL_PLATFORM_NAME).toString();
-
     // Enqueue
     postDirective<DStatusUpdate>(STATUS_PLAY, addApp.name());
-
-    if(sError = enqueueAdditionalApp(addApp, platformName, Task::Stage::Primary); sError.isValid())
+    if(sError = enqueueAdditionalApp(addApp, parentGame, Task::Stage::Primary); sError.isValid())
         return sError;
 
     // Enqueue service shutdown if needed
@@ -230,7 +263,7 @@ Qx::Error CPlay::handleEntry(const Fp::AddApp& addApp)
     return Qx::Error();
 }
 
-Qx::Error CPlay::enqueueAdditionalApp(const Fp::AddApp& addApp, const QString& platform, Task::Stage taskStage)
+Qx::Error CPlay::enqueueAdditionalApp(const Fp::AddApp& addApp, const Fp::Game& parent, Task::Stage taskStage)
 {
     if(addApp.appPath() == Fp::Db::Table_Add_App::ENTRY_MESSAGE)
     {
@@ -249,9 +282,11 @@ Qx::Error CPlay::enqueueAdditionalApp(const Fp::AddApp& addApp, const QString& p
 
         mCore.enqueueSingleTask(extraTask);
     }
+    else if(useRuffle(parent, taskStage))
+        enqueueRuffleTask(addApp.name(), addApp.launchCommand());
     else
     {
-        QString addAppPath = mCore.resolveFullAppPath(addApp.appPath(), platform);
+        QString addAppPath = mCore.resolveFullAppPath(addApp.appPath(), parent.platformName());
         QFileInfo addAppPathInfo(addAppPath);
         QString param = addApp.launchCommand();
         addPassthroughParameters(param);
@@ -280,10 +315,18 @@ Qx::Error CPlay::enqueueAdditionalApp(const Fp::AddApp& addApp, const QString& p
 
 Qx::Error CPlay::enqueueGame(const Fp::Game& game, const Fp::GameData& gameData, Task::Stage taskStage)
 {
+    QString param = !gameData.isNull() ? gameData.launchCommand() : game.launchCommand();
+
+    if(useRuffle(game, taskStage))
+    {
+        enqueueRuffleTask(game.title(), param);
+        return Qx::Error();
+    }
+
     QString gamePath = mCore.resolveFullAppPath(!gameData.isNull() ? gameData.appPath() : game.appPath(),
                                                 game.platformName());
     QFileInfo gamePathInfo(gamePath);
-    QString param = !gameData.isNull() ? gameData.launchCommand() : game.launchCommand();
+
     addPassthroughParameters(param);
 
     TExec* gameTask = new TExec(mCore);
@@ -296,7 +339,6 @@ Qx::Error CPlay::enqueueGame(const Fp::Game& game, const Fp::GameData& gameData,
     gameTask->setProcessType(TExec::ProcessType::Blocking);
 
     mCore.enqueueSingleTask(gameTask);
-    postDirective<DStatusUpdate>(STATUS_PLAY, game.title());
 
 #ifdef _WIN32
     // Add wait task if required
@@ -308,6 +350,55 @@ Qx::Error CPlay::enqueueGame(const Fp::Game& game, const Fp::GameData& gameData,
     return Qx::Error();
 }
 
+void CPlay::enqueueRuffleTask(const QString& name, const QString& originalParams)
+{
+    /* Replicating:
+     *
+     * https://github.com/FlashpointProject/launcher/blob/54c5dd8357b9083271d36912ea9546bcd8d1cb18/extensions/core-ruffle/src/extension.ts#L65
+     * https://github.com/FlashpointProject/launcher/blob/54c5dd8357b9083271d36912ea9546bcd8d1cb18/extensions/core-ruffle/src/middleware/standalone.ts#L181
+     *
+     * There is a whole system for supporting different versions of Ruffle, as well as game-specific config options, but current it's unused so we
+     * can ignore it. Also if it isn't obvious we can only make use of standalone ruffle.
+     *
+     * If the ruffle config schema really starts getting used, we might want to move its setup to libfp so that it just comes with the game entry.
+     *
+     * The ruffle executable path should also likely be part of libfp. Then with this the chmod change should be done at startup using that path.
+     *
+     * TODO: Download ruffle if it's missing.
+     */
+#if defined(_WIN32)
+    static const QString RUFFLE_EXE = u"Ruffle.exe"_s;
+#elif defined(__linux__)
+    static const QString RUFFLE_EXE = u"ruffle"_s;
+#endif
+    auto& fp = mCore.fpInstall();
+    static QFileInfo ruffle = [&]{
+        QFile file = mCore.fpInstall().dir().absoluteFilePath(u"Data/Ruffle/standalone/latest/"_s + RUFFLE_EXE);
+        auto exec = QFile::ExeOwner | QFile::ExeGroup | QFile::ExeOther;
+        file.setPermissions(file.permissions() | exec);
+        return QFileInfo(file);
+    }();
+
+    // This likely will need to be dynamic per game/ruffle version at some point
+    QStringList newParams = {
+        u"--proxy"_s,
+        fp.preferences().browserModeProxy
+    };
+    addPassthroughParameters(newParams);
+    newParams.append(QProcess::splitCommand(originalParams));
+
+    TExec* gameTask = new TExec(mCore);
+    gameTask->setIdentifier(name);
+    gameTask->setStage(Task::Stage::Primary);
+    gameTask->setExecutable(ruffle.absoluteFilePath());
+    gameTask->setDirectory(ruffle.absoluteDir());
+    gameTask->setParameters(newParams);
+    gameTask->setEnvironment(mCore.childTitleProcessEnvironment());
+    gameTask->setProcessType(TExec::ProcessType::Blocking);
+
+    mCore.enqueueSingleTask(gameTask);
+}
+
 //Protected:
 QList<const QCommandLineOption*> CPlay::options() const { return CL_OPTIONS_SPECIFIC + TitleCommand::options(); }
 QString CPlay::name() const { return NAME; }

lib/backend/src/command/c-play.h

@@ -65,9 +65,17 @@ class CPlay : public TitleCommand
     static inline const QString CL_OPT_URL_L_NAME = u"url"_s;
     static inline const QString CL_OPT_URL_DESC = u""_s;
 
+    static inline const QString CL_OPT_RUFFLE_L_NAME = u"ruffle"_s;
+    static inline const QString CL_OPT_RUFFLE_DESC = u"Forces the use of Ruffle for Flash games."_s;
+
+    static inline const QString CL_OPT_FLASH_L_NAME = u"flash"_s;
+    static inline const QString CL_OPT_FLASH_DESC = u"Forces the use of the standard app (usually Flash Player) for Flash games."_s;
+
     // Command line options
     static inline const QCommandLineOption CL_OPTION_URL{{CL_OPT_URL_S_NAME, CL_OPT_URL_L_NAME}, CL_OPT_URL_DESC, u"url"_s}; // Takes value
-    static inline const QList<const QCommandLineOption*> CL_OPTIONS_SPECIFIC{&CL_OPTION_URL};
+    static inline const QCommandLineOption CL_OPTION_RUFFLE{{CL_OPT_RUFFLE_L_NAME}, CL_OPT_URL_DESC}; // Boolean
+    static inline const QCommandLineOption CL_OPTION_FLASH{{CL_OPT_FLASH_L_NAME}, CL_OPT_FLASH_DESC}; // Boolean
+    static inline const QList<const QCommandLineOption*> CL_OPTIONS_SPECIFIC{&CL_OPTION_URL, &CL_OPTION_RUFFLE, &CL_OPTION_FLASH};
 
     // Logging - Messages
     static inline const QString LOG_EVENT_HANDLING_AUTO = u"Handling automatic tasks..."_s;
@@ -77,6 +85,10 @@ class CPlay : public TitleCommand
     static inline const QString LOG_EVENT_FOUND_AUTORUN = u"Found autorun-before additional app: %1"_s;
     static inline const QString LOG_EVENT_DATA_PACK_TITLE = u"Selected title uses a data pack"_s;
     static inline const QString LOG_EVENT_SERVER_OVERRIDE = u"Selected title overrides the server to: %1"_s;
+    static inline const QString LOG_EVENT_USING_RUFFLE_SUPPORTED = u"Using Ruffle for this title (supported)"_s;
+    static inline const QString LOG_EVENT_USING_RUFFLE_UNSUPPORTED = u"Using Ruffle for this title (unsupported)"_s;
+    static inline const QString LOG_EVENT_FORCING_RUFFLE = u"Forcing the use of Ruffle for this title"_s;
+    static inline const QString LOG_EVENT_FORCING_FLASH = u"Forcing the use of the standard Flash application for this title"_s;
 
 public:
     // Meta
@@ -95,11 +107,14 @@ class CPlay : public TitleCommand
 //-Instance Functions------------------------------------------------------------------------------------------------------
 private:
     void addPassthroughParameters(QString& param);
+    void addPassthroughParameters(QStringList& param);
     QString getServerOverride(const Fp::GameData& gd);
+    bool useRuffle(const Fp::Game& game, Task::Stage stage);
     Qx::Error handleEntry(const Fp::Game& game);
     Qx::Error handleEntry(const Fp::AddApp& addApp);
-    Qx::Error enqueueAdditionalApp(const Fp::AddApp& addApp, const QString& platform, Task::Stage taskStage);
+    Qx::Error enqueueAdditionalApp(const Fp::AddApp& addApp, const Fp::Game& parent, Task::Stage taskStage);
     Qx::Error enqueueGame(const Fp::Game& game, const Fp::GameData& gameData, Task::Stage taskStage);
+    void enqueueRuffleTask(const QString& name, const QString& originalParams);
 
 protected:
     QList<const QCommandLineOption*> options() const override;

lib/backend/src/kernel/core.h

@@ -21,7 +21,10 @@
 #include "task/task.h"
 #include "_backend_project_vars.h"
 
-// TODO: It's time to cleanout the old unused mounter support (i.e. docker, QEMU, etc).
+/* TODO: It's time to cleanout the old unused mounter support (i.e. docker, QEMU, etc),
+ * though maybe keep them a bit longer for if we ever get to adding support for other
+ * BM projects, as those might still use that tech
+ */
 
 class QX_ERROR_TYPE(CoreError, "CoreError", 1200)
 {