allow default map from local path for Flatpak

Author: nschimme

.github/workflows/build-flatpak.yml

@@ -3,17 +3,17 @@ name: build-flatpak
 on:
   push:
     tags:
-      - 'v*'
+    - 'v*'
     branches:
-      - master
+    - master
   pull_request:
   workflow_dispatch:
 
 jobs:
   build-flatpak:
     runs-on: ubuntu-latest
     container:
-      image: bilelmoussaoui/flatpak-github-actions:gnome-47
+      image: ghcr.io/flathub-infra/flatpak-github-actions:freedesktop-23.08
       options: --privileged
 
     steps:
@@ -26,7 +26,9 @@ jobs:
       id: git_info
       run: |
         git config --global --add safe.directory $(pwd)
-        VERSION=$(git describe --tags --always --long)
+        VERSION=$(git tag --points-at HEAD | grep '^v' | sed 's/^v//' || true)
+        VERSION=${VERSION:-$(git rev-parse --short HEAD || true)}
+        VERSION=${VERSION:-$(cat MMAPPER_VERSION)}
         ARCHITECTURE=$(uname -m)
         FILE="org.mume.MMapper-${VERSION}-Linux-${ARCHITECTURE}.flatpak"
         echo "VERSION=${VERSION}" >> $GITHUB_ENV

CMakeLists.txt

@@ -23,7 +23,7 @@ if(NOT APPLE)
 endif()
 option(WITH_WEBSOCKET "Allow connecting to MUME over WebSockets" OFF)
 option(WITH_QTKEYCHAIN "Use QtKeychain to securely store your account credentials" OFF)
-option(WITH_MAP "Download the default map" ON)
+option(WITH_MAP "Download the default map or use the provided map path" ON)
 option(WITH_TESTS "Compile unit tests" ON)
 option(USE_TIDY "Run clang-tidy with the compiler" OFF)
 option(USE_IWYU "Run include-what-you-use with the compiler" OFF)
@@ -379,33 +379,7 @@ endif()
 
 # Download arda.mm2
 if(WITH_MAP)
-    set(MMAPPER_MAP_FILE "${CMAKE_BINARY_DIR}/map/arda.mm2")
-    if(NOT EXISTS ${MMAPPER_MAP_FILE})
-        set(MMAPPER_MAP_URL "https://github.com/MUME/MMapper/releases/download/v${MMAPPER_VERSION}/arda.mm2")
-        message(STATUS "Fetching MMapper Map from: ${MMAPPER_MAP_URL}")
-
-        file(DOWNLOAD ${MMAPPER_MAP_URL} ${MMAPPER_MAP_FILE} STATUS MMAPPER_MAP_HTTP_STATUS)
-        list(GET MMAPPER_MAP_HTTP_STATUS 0 MMAPPER_MAP_STATUS)
-
-        if(MMAPPER_MAP_STATUS)
-            file(REMOVE ${MMAPPER_MAP_FILE})
-            if(GIT_LAST_ANNOTATED_TAG)
-                set(MMAPPER_MAP_URL "https://github.com/MUME/MMapper/releases/download/${GIT_LAST_ANNOTATED_TAG}/arda.mm2")
-                message(STATUS "Map not found. Fetching alternative map from: ${MMAPPER_MAP_URL}")
-                file(DOWNLOAD ${MMAPPER_MAP_URL} ${MMAPPER_MAP_FILE} STATUS MMAPPER_MAP_HTTP_STATUS)
-                list(GET MMAPPER_MAP_HTTP_STATUS 0 MMAPPER_MAP_STATUS)
-            endif()
-        endif()
-
-        if(MMAPPER_MAP_STATUS)
-            file(REMOVE ${MMAPPER_MAP_FILE})
-            message(FATAL_ERROR "Unable to download map: use `-DWITH_MAP=OFF` to not require a map")
-        else()
-            message(STATUS "Downloaded map to: ${MMAPPER_MAP_FILE}")
-        endif()
-    else()
-        message(STATUS "Using cached MMapper map: ${MMAPPER_MAP_FILE}")
-    endif()
+    add_subdirectory(external/map)
 else()
     message(STATUS "Building without default map as a resource")
     add_definitions(/DMMAPPER_NO_MAP)

external/map/CMakeLists.txt

@@ -0,0 +1,44 @@
+string(TOUPPER "${WITH_MAP}" WITH_MAP_UPPER)
+if(WITH_MAP_UPPER STREQUAL "OFF" OR WITH_MAP_UPPER STREQUAL "FALSE")
+    message(STATUS "Map is disabled")
+else()
+    set(MAP_DOWNLOAD_DIR "${CMAKE_BINARY_DIR}/map")
+    file(MAKE_DIRECTORY "${MAP_DOWNLOAD_DIR}")
+    if(IS_ABSOLUTE "${WITH_MAP}" OR EXISTS "${WITH_MAP}")
+        get_filename_component(PROVIDED_MAP_ABS "${WITH_MAP}" ABSOLUTE BASE_DIR "${CMAKE_SOURCE_DIR}")
+        get_filename_component(MAP_FILENAME "${WITH_MAP}" NAME)
+        set(MMAPPER_MAP_FILE "${MAP_DOWNLOAD_DIR}/${MAP_FILENAME}")
+
+        if(NOT EXISTS "${PROVIDED_MAP_ABS}")
+            message(FATAL_ERROR "Provided map file does not exist: ${PROVIDED_MAP_ABS}")
+        endif()
+
+        add_custom_command(
+            OUTPUT "${MMAPPER_MAP_FILE}"
+            COMMAND ${CMAKE_COMMAND} -E copy_if_different "${PROVIDED_MAP_ABS}" "${MMAPPER_MAP_FILE}"
+            DEPENDS "${PROVIDED_MAP_ABS}"
+            COMMENT "Copying provided map to build directory"
+            VERBATIM
+        )
+        add_custom_target(map ALL DEPENDS "${MMAPPER_MAP_FILE}")
+    else()
+        set(MMAPPER_MAP_FILENAME "arda.xml")
+        set(MMAPPER_MAP_SCHEMA "41")
+        set(MMAPPER_MAP_FILE "${MAP_DOWNLOAD_DIR}/${MMAPPER_MAP_FILENAME}")
+        include(ExternalProject)
+        ExternalProject_Add(map
+            GIT_REPOSITORY "https://github.com/MUME/arda"
+            GIT_TAG "${MMAPPER_MAP_SCHEMA}"
+
+            CONFIGURE_COMMAND ""
+            BUILD_COMMAND ""
+            INSTALL_COMMAND ${CMAKE_COMMAND} -E copy_if_different <SOURCE_DIR>/${MMAPPER_MAP_FILENAME} ${MMAPPER_MAP_FILE}
+
+            UPDATE_COMMAND ""
+            BUILD_BYPRODUCTS "${MMAPPER_MAP_FILE}"
+        )
+    endif()
+endif()
+
+message(STATUS "Map will be included: ${MMAPPER_MAP_FILE}")
+set(MMAPPER_MAP_FILE "${MMAPPER_MAP_FILE}" PARENT_SCOPE)

manifest.json

@@ -39,6 +39,9 @@
           "tag": "0.9.9.7"
         }
       ],
+      "build-options": {
+        "build-only": true
+      },
       "build-commands": [
         "cp -r glm /app/include/"
       ]
@@ -88,6 +91,23 @@
         "-DCMAKE_PREFIX_PATH=/app"
       ]
     },
+    {
+      "name": "map",
+      "buildsystem": "simple",
+      "sources": [
+        {
+          "type": "git",
+          "url": "https://github.com/MUME/arda.git",
+          "tag": "41"
+        }
+      ],
+      "build-options": {
+        "build-only": true
+      },
+      "build-commands": [
+        "cp arda.xml /app/"
+      ]
+    },
     {
       "name": "mmapper",
       "buildsystem": "cmake-ninja",
@@ -102,7 +122,7 @@
         "-DCMAKE_BUILD_TYPE=Release",
         "-DWITH_WEBSOCKET=ON",
         "-DWITH_QTKEYCHAIN=ON",
-        "-DWITH_MAP=OFF",
+        "-DWITH_MAP=/app/arda.xml",
         "-DWITH_TESTS=OFF",
         "-DOPENSSL_ROOT_DIR=/app",
         "-DCMAKE_PREFIX_PATH=/app/lib/qt5:/app"

src/CMakeLists.txt

@@ -536,7 +536,7 @@ endif()
 list(APPEND mmapper_RCS "resources/macosx/m-${MMAPPER_BRAND_SUFFIX}.icns")
 
 if(WITH_MAP)
-    configure_file(resources/arda.qrc ${CMAKE_BINARY_DIR}/map/arda.qrc COPYONLY)
+    configure_file(resources/arda.qrc.in ${CMAKE_BINARY_DIR}/map/arda.qrc)
     list(APPEND mmapper_RCS "${CMAKE_BINARY_DIR}/map/arda.qrc")
 endif()
 
@@ -699,6 +699,10 @@ if(WIN32)
     target_link_libraries(mmapper PUBLIC ws2_32)
 endif()
 
+if(WITH_MAP)
+  add_dependencies(mmapper map)
+endif()
+
 if(WITH_ZLIB)
     target_include_directories(mmapper SYSTEM PUBLIC ${ZLIB_INCLUDE_DIRS})
     target_include_directories(mm_global SYSTEM PUBLIC ${ZLIB_INCLUDE_DIRS})

src/main.cpp

@@ -138,7 +138,7 @@ static void tryAutoLoadMap(MainWindow &mw)
             && tryLoad(mw, QDir{settings.lastMapDirectory}, settings.fileName)) {
             return;
         }
-        if (!NO_MAP_RESOURCE && tryLoad(mw, QDir(":/"), "arda.mm2")) {
+        if (!NO_MAP_RESOURCE && tryLoad(mw, QDir(":/"), "arda")) {
             return;
         }
         qInfo() << "[main] Unable to autoload map";

src/preferences/generalpage.ui

@@ -252,7 +252,7 @@
             </sizepolicy>
            </property>
            <property name="placeholderText">
-            <string>:/arda.mm2</string>
+            <string>:/arda</string>
            </property>
           </widget>
          </item>

src/resources/arda.qrc renamed to src/resources/arda.qrc.in

@@ -1,6 +1,6 @@
 <!-- This generated file exists to load the default map as a resource. -->
 <!DOCTYPE RCC><RCC version="1.0">
     <qresource>
-        <file compress-algo="none">arda.mm2</file>
+        <file compress-algo="best" alias="arda">${MMAPPER_MAP_FILE}</file>
     </qresource>
 </RCC>