Merge pull request #72 from oblivioncth/dev

Merge to master for v0.9.8

.github/workflows/build-clifp-linux.yml

@@ -60,14 +60,21 @@ jobs:
     - name: Install Qt (custom build)
       uses: oblivioncth/actions/general/install-and-cache-qt-from-ffynnon@dev
       with:
-        version: 6.5.1
+        version: 6.6.0
         os: linux
         compiler: ${{ matrix.qt_comp }}
         linkage: ${{ matrix.lib_linkage }}
         path: ${{ env.qt_install_dir }}
         credentials: ${{ secrets.qt_ffynnon_cred }}
     - name: Update package index
       run: sudo apt-get update
+    - name: WORKAROUND FOR https://github.com/actions/runner-images/issues/8659
+      if: matrix.os == 'ubuntu-22.04'
+      run: |
+        echo "TEMPORARY WORKAROUND FOR GITHUB RUNNER BUG #8659\n\nRemoving GCC 13 as it breaks Clang14"
+        sudo rm -f /etc/apt/sources.list.d/ubuntu-toolchain-r-ubuntu-test-jammy.list
+        sudo apt-get update
+        sudo apt-get install -y --allow-downgrades libc6=2.35-0ubuntu3.4 libc6-dev=2.35-0ubuntu3.4 libstdc++6=12.3.0-1ubuntu1~22.04 libgcc-s1=12.3.0-1ubuntu1~22.04
     - name: Install OpenGL lib
       run: sudo apt-get install libglu1-mesa-dev
     - name: Install XCB Related libs
@@ -81,6 +88,8 @@ jobs:
     - name: Install EGL [22.04]
       if: matrix.os == 'ubuntu-22.04'
       run: sudo apt-get install libegl1-mesa-dev
+    - name: Install Wayland
+      run: sudo apt-get install libwayland-dev
     - name: Checkout CLIFp
       uses: actions/checkout@v3
       with:

.github/workflows/build-clifp-windows.yml

@@ -37,7 +37,7 @@ jobs:
     - name: Install Qt (custom build)
       uses: oblivioncth/actions/general/install-and-cache-qt-from-ffynnon@dev
       with:
-        version: 6.5.1
+        version: 6.6.0
         os: windows
         compiler: msvc2022
         linkage: ${{ matrix.lib_linkage }}

.github/workflows/master-pull-request-merge-reaction.yml

@@ -68,6 +68,30 @@ jobs:
     uses: ./.github/workflows/build-clifp-linux.yml
     secrets:
       qt_ffynnon_cred: ${{ secrets.OBYBOT_FFYNNON_CREDS }}
+
+  update-redirect:
+    name: Update redirect page
+    if: github.event.pull_request.merged == true
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.page-deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+    - name: Setup pages
+      uses: actions/configure-pages@v3
+    - name: Upload pages artifact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: ${{ github.workspace }}/redirector
+    - name: Deploy pages artifact
+      id: page-deployment
+      uses: actions/deploy-pages@v1
 
   create-release:
     name: Create GitHub release

CMakeLists.txt

@@ -6,22 +6,22 @@ cmake_minimum_required(VERSION 3.24.0...3.26.0)
 # Project
 # NOTE: DON'T USE TRAILING ZEROS IN VERSIONS
 project(CLIFp
-    VERSION 0.9.7
+    VERSION 0.9.8
     LANGUAGES CXX
     DESCRIPTION "Command-line Interface for Flashpoint Archive"
 )
 
 # Get helper scripts
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/FetchOBCMake.cmake)
-fetch_ob_cmake("v0.3.2")
+fetch_ob_cmake("v0.3.3")
 
 # Initialize project according to standard rules
 include(OB/Project)
 ob_standard_project_setup()
 
 # Additional Project Variables
 set(PROJECT_FORMAL_NAME "CLI Flashpoint")
-set(TARGET_FP_VERSION_PREFIX 12.0)
+set(TARGET_FP_VERSION_PREFIX 12.1)
 
 # Configuration options
 # Handled by fetched libs, but set this here formally since they aren't part of the main project
@@ -72,14 +72,14 @@ endif()
 
 include(OB/FetchQx)
 ob_fetch_qx(
-    REF "v0.5.3"
+    REF "v0.5.4"
     COMPONENTS
         ${CLIFP_QX_COMPONENTS}
 )
 
 # Fetch libfp (build and import from source)
 include(OB/Fetchlibfp)
-ob_fetch_libfp("v0.5")
+ob_fetch_libfp("v0.5.1")
 
 # Fetch QI-QMP (build and import from source)
 include(OB/FetchQI-QMP)

README.md

@@ -82,6 +82,28 @@ If the application needs to use files from a Data Pack that pack will need to be
 
 The applications and arguments that are used for each game/animation can be found within the Flashpoint database ([FP Install Dir]\Data\flashpoint.sqlite)
 
+### Flashpoint Protocol
+CLIFp supports the "flashpoint" protocol, which means it can launch titles through URL with a custom scheme, followed by a title's UUID, like this:
+
+    flashpoint://37e5c215-9c39-4a3d-9912-b4343a17027e
+
+This makes it fast and easy to share games that you think your friends should try out.
+
+To register CLIFp as the handler for these URLs, simply run:
+
+    CLIFp share -c
+
+To easily create a share link if you don't already know the UUID of a game, you can use the **share** command with the **-t** switch followed by a title:
+
+    CLIFp share -t "Simple, Tasty Buttons"
+
+This will create a share link for that title which will be displayed via a message box and automatically copied to the system clipboard.
+
+If for whatever reason the service through which you wish to share a link does not support links with custom schemes, you can use the **-u** switch to generate a standard "https" link that utilizes a GitHub-hosted redirect page, enabling share links to be provided everywhere. 
+
+[!IMPORTANT]
+You will want to disable the "Register As Protocol Handler" option in the default launcher or else it will replace CLIFp as the "flashpoint" protocol handler every time it's started.
+
 ## All Commands/Options
 The recommended way to use all switches is to use their short form when the value for the switch has no spaces:
 
@@ -190,6 +212,29 @@ When using the **--exe** and **--param** switches all quotes that are part of th
 
 See http://www.robvanderwoude.com/escapechars.php for more information.
 
+--------------------------------------------------------------------------------
+
+**share** - Generates a URL for starting a Flashpoint title that can be shared to other users.
+
+Options:
+ -  **-i | --id:** UUID  of  title  to  make a share link for
+ -  **-t | --title:** Title to  make a share link for
+ -  **-T | --title-strict:** Same as **-t**, but only exact matches are considered
+ -  **-s | --subtitle:** Name of additional-app under the title to make a share link for. Must be used with **-t**/**-T**
+ -  **-S | --subtitle-strict:** Same as **-s**, but only exact matches are considered
+ -  **-u | --universal:** Creates a standard HTTPS link that utilizes a redirect page. May be easier to share on some platforms.
+ - **-c | --configure:** Registers CLIFp as the default handler for "flashpoint" protocol links.
+ - **-C | --unconfigure:** Removes CLIFp as the default handler for "flashpoint" protocol links.
+ -  **-h | --help | -?:** Prints command specific usage information
+
+Requires:
+**-i**, **-t** or **-c** 
+
+Notes: 
+
+ - By default, the standard Flashpoint launcher is registered to handle share links; therefore, its "Register As Protocol Handler" option should likely be disabled if you intend to use CLIFp instead.
+ - See the **play** command notes for information regarding the **t**/**T** and **s**/**S** switches.
+
 --------------------------------------------------------------------------------
 
  **show** - Display  a  message  or  extra  folder
@@ -203,7 +248,7 @@ Requires:
 **-m** or **-e** 
 
 ### Remarks
-With any use of the **--title** option for the commands that support it the title must be entered verbatim as it appears within Flashpoint, as close matches are not checked (due to technical limitations). If two entries happen to share the title specified, a dialog window with more information will be displayed so that the intended title can be selected.
+With any use of the **--title**/**--subtitle** options for the commands that support them, 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.
 
 ## Other Features
 CLIFp displays a system tray icon so that one can be sure it is still running. This icon also will display basic status messages when clicked on and features a context menu with an option to exit at any time.

app/CMakeLists.txt

@@ -18,6 +18,8 @@ set(CLIFP_SOURCE
     command/c-prepare.cpp
     command/c-run.h
     command/c-run.cpp
+    command/c-share.h
+    command/c-share.cpp
     command/c-show.cpp
     command/c-show.h
     command/title-command.h
@@ -50,6 +52,7 @@ set(CLIFP_SOURCE
     tools/mounter_qmp.cpp
     tools/mounter_router.h
     tools/mounter_router.cpp
+    frontend/message.h
     frontend/statusrelay.h
     frontend/statusrelay.cpp
     controller.h

app/src/command/c-link.h

@@ -7,7 +7,7 @@
 // Project Includes
 #include "command/title-command.h"
 
-class QX_ERROR_TYPE(CLinkError, "CLinkError", 1212)
+class QX_ERROR_TYPE(CLinkError, "CLinkError", 1213)
 {
     friend class CLink;
     //-Class Enums-------------------------------------------------------------

app/src/command/c-link_linux.cpp

@@ -29,7 +29,7 @@ Qx::Error CLink::createShortcut(const QString& name, const QDir& dir, QUuid id)
     ade.setName(name);
     ade.setIcon(PROJECT_SHORT_NAME);
     QString args = CPlay::NAME + u" -"_s + TitleCommand::CL_OPTION_ID.names().constFirst() + ' ' + id.toString(QUuid::WithoutBraces);
-    ade.setExec(CLIFP_DIR_PATH + '/' + CLIFP_CUR_APP_FILENAME + ' ' + args);
+    ade.setExec(CLIFP_PATH + ' ' + args);
     ade.setPath(CLIFP_DIR_PATH);
     ade.setComment(u"Generated by "_s PROJECT_SHORT_NAME " " PROJECT_VERSION_STR);
 

app/src/command/c-link_win.cpp

@@ -18,7 +18,7 @@ Qx::Error CLink::createShortcut(const QString& name, const QDir& dir, QUuid id)
 {
     // Create shortcut properties
     Qx::ShortcutProperties sp;
-    sp.target = CLIFP_DIR_PATH + '/' + CLIFP_CUR_APP_FILENAME;
+    sp.target = CLIFP_PATH;
     sp.targetArgs = CPlay::NAME + u" -"_s + TitleCommand::CL_OPTION_ID.names().constFirst() + ' ' + id.toString(QUuid::WithoutBraces);
     sp.comment = name;
 

app/src/command/c-play.cpp

@@ -12,6 +12,29 @@
 #include "../task/t-message.h"
 #include "../task/t-extra.h"
 
+//===============================================================================================================
+// CPlayError
+//===============================================================================================================
+
+//-Constructor-------------------------------------------------------------
+//Private:
+CPlayError::CPlayError(Type t, const QString& s) :
+    mType(t),
+    mSpecific(s)
+{}
+
+//-Instance Functions-------------------------------------------------------------
+//Public:
+bool CPlayError::isValid() const { return mType != NoError; }
+QString CPlayError::specific() const { return mSpecific; }
+CPlayError::Type CPlayError::type() const { return mType; }
+
+//Private:
+Qx::Severity CPlayError::deriveSeverity() const { return Qx::Critical; }
+quint32 CPlayError::deriveValue() const { return mType; }
+QString CPlayError::derivePrimary() const { return ERR_STRINGS.value(mType); }
+QString CPlayError::deriveSecondary() const { return mSpecific; }
+
 //===============================================================================================================
 // CPLAY
 //===============================================================================================================
@@ -193,8 +216,8 @@ Qx::Error CPlay::enqueueAdditionalApp(const Fp::AddApp& addApp, const QString& p
     {
         TMessage* messageTask = new TMessage(&mCore);
         messageTask->setStage(taskStage);
-        messageTask->setMessage(addApp.launchCommand());
-        messageTask->setModal(addApp.isWaitExit() || taskStage == Task::Stage::Primary);
+        messageTask->setText(addApp.launchCommand());
+        messageTask->setBlocking(addApp.isWaitExit());
 
         mCore.enqueueSingleTask(messageTask);
     }
@@ -262,15 +285,29 @@ Qx::Error CPlay::enqueueGame(const Fp::Game& game, const Fp::GameData& gameData,
 }
 
 //Protected:
+QList<const QCommandLineOption*> CPlay::options() { return CL_OPTIONS_SPECIFIC + TitleCommand::options(); }
 QString CPlay::name() { return NAME; }
 
 Qx::Error CPlay::perform()
 {
-    // Get ID of title to start
+    // Get ID of title to start, prioritizing URL
     QUuid titleId;
-    if(Qx::Error ide = getTitleId(titleId); ide.isValid())
+    if(mParser.isSet(CL_OPTION_URL))
+    {
+        QRegularExpressionMatch urlMatch = URL_REGEX.match(mParser.value(CL_OPTION_URL));
+        if(!urlMatch.hasMatch())
+        {
+            CPlayError err(CPlayError::InvalidUrl);
+            mCore.postError(NAME, err);
+            return err;
+        }
+
+        titleId = QUuid(urlMatch.captured(u"id"_s));
+    }
+    else if(Qx::Error ide = getTitleId(titleId); ide.isValid())
         return ide;
 
+
     Qx::Error errorStatus;
 
     // Enqueue required tasks

app/src/command/c-play.h

@@ -7,15 +7,70 @@
 // Project Includes
 #include "command/title-command.h"
 
+class QX_ERROR_TYPE(CPlayError, "CPlayError", 1212)
+{
+    friend class CPlay;
+    //-Class Enums-------------------------------------------------------------
+public:
+    enum Type
+    {
+        NoError = 0,
+        InvalidUrl = 1,
+    };
+
+    //-Class Variables-------------------------------------------------------------
+private:
+    static inline const QHash<Type, QString> ERR_STRINGS{
+        {NoError, u""_s},
+        {InvalidUrl, u"The provided 'flashpoint://' scheme URL is invalid."_s}
+    };
+
+    //-Instance Variables-------------------------------------------------------------
+private:
+    Type mType;
+    QString mSpecific;
+
+    //-Constructor-------------------------------------------------------------
+private:
+    CPlayError(Type t = NoError, const QString& s = {});
+
+    //-Instance Functions-------------------------------------------------------------
+public:
+    bool isValid() const;
+    Type type() const;
+    QString specific() const;
+
+private:
+    Qx::Severity deriveSeverity() const override;
+    quint32 deriveValue() const override;
+    QString derivePrimary() const override;
+    QString deriveSecondary() const override;
+};
+
 class CPlay : public TitleCommand
 {
 //-Class Variables------------------------------------------------------------------------------------------------------
 private:
     // Status
     static inline const QString STATUS_PLAY = u"Playing"_s;
 
+    // General
+    static inline const QRegularExpression URL_REGEX = QRegularExpression(
+        u"flashpoint:\\/\\/(?<id>[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12})\\/?$"_s
+    );
+
+    // Command line option strings
+    static inline const QString CL_OPT_URL_S_NAME = u"u"_s;
+    static inline const QString CL_OPT_URL_L_NAME = u"url"_s;
+    static inline const QString CL_OPT_URL_DESC = u""_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};
+
     // Logging - Messages
     static inline const QString LOG_EVENT_ENQ_AUTO = u"Enqueuing automatic tasks..."_s;
+    static inline const QString LOG_EVENT_URL_ID = u"ID from URL: %1"_s;
     static inline const QString LOG_EVENT_ID_MATCH_TITLE = u"ID matches main title: %1"_s;
     static inline const QString LOG_EVENT_ID_MATCH_ADDAPP = u"ID matches additional app: %1 (Child of %2)"_s;
     static inline const QString LOG_EVENT_QUEUE_CLEARED = u"Previous queue entries cleared due to auto task being a Message/Extra"_s;
@@ -45,6 +100,7 @@ class CPlay : public TitleCommand
     Qx::Error enqueueGame(const Fp::Game& game, const Fp::GameData& gameData, Task::Stage taskStage);
 
 protected:
+    QList<const QCommandLineOption*> options() override;
     QString name() override;
     Qx::Error perform() override;
 };