change: mod metadata improvements

- Use slug instead of name
- Keep temporary status before having local details

Signed-off-by: flow <flowlnlnln@gmail.com>

3 files changed, 31 insertions, 27 deletions

diff --git a/launcher/modplatform/packwiz/Packwiz.cpp b/launcher/modplatform/packwiz/Packwiz.cpp
index 8bd66088..c3561093 100644
--- a/launcher/modplatform/packwiz/Packwiz.cpp
+++ b/launcher/modplatform/packwiz/Packwiz.cpp
@@ -55,11 +55,11 @@ auto getRealIndexName(QDir& index_dir, QString normalized_fname, bool should_fin
 }
 
 // Helpers
-static inline auto indexFileName(QString const& mod_name) -> QString
+static inline auto indexFileName(QString const& mod_slug) -> QString
 {
-    if(mod_name.endsWith(".pw.toml"))
-        return mod_name;
-    return QString("%1.pw.toml").arg(mod_name);
+    if(mod_slug.endsWith(".pw.toml"))
+        return mod_slug;
+    return QString("%1.pw.toml").arg(mod_slug);
 }
 
 static ModPlatform::ProviderCapabilities ProviderCaps;
@@ -95,6 +95,7 @@ auto V1::createModFormat(QDir& index_dir, ModPlatform::IndexedPack& mod_pack, Mo
 {
     Mod mod;
 
+    mod.slug = mod_pack.slug;
     mod.name = mod_pack.name;
     mod.filename = mod_version.fileName;
 
@@ -116,12 +117,10 @@ auto V1::createModFormat(QDir& index_dir, ModPlatform::IndexedPack& mod_pack, Mo
     return mod;
 }
 
-auto V1::createModFormat(QDir& index_dir, ::Mod& internal_mod) -> Mod
+auto V1::createModFormat(QDir& index_dir, ::Mod& internal_mod, QString slug) -> Mod
 {
-    auto mod_name = internal_mod.name();
-
     // Try getting metadata if it exists
-    Mod mod { getIndexForMod(index_dir, mod_name) };
+    Mod mod { getIndexForMod(index_dir, slug) };
     if(mod.isValid())
         return mod;
 
@@ -139,7 +138,7 @@ void V1::updateModIndex(QDir& index_dir, Mod& mod)
 
     // Ensure the corresponding mod's info exists, and create it if not
 
-    auto normalized_fname = indexFileName(mod.name);
+    auto normalized_fname = indexFileName(mod.slug);
     auto real_fname = getRealIndexName(index_dir, normalized_fname);
 
     QFile index_file(index_dir.absoluteFilePath(real_fname));
@@ -187,12 +186,13 @@ void V1::updateModIndex(QDir& index_dir, Mod& mod)
         }
     }
 
+    index_file.flush();
     index_file.close();
 }
 
-void V1::deleteModIndex(QDir& index_dir, QString& mod_name)
+void V1::deleteModIndex(QDir& index_dir, QString& mod_slug)
 {
-    auto normalized_fname = indexFileName(mod_name);
+    auto normalized_fname = indexFileName(mod_slug);
     auto real_fname = getRealIndexName(index_dir, normalized_fname);
     if (real_fname.isEmpty())
         return;
@@ -200,12 +200,12 @@ void V1::deleteModIndex(QDir& index_dir, QString& mod_name)
     QFile index_file(index_dir.absoluteFilePath(real_fname));
 
     if (!index_file.exists()) {
-        qWarning() << QString("Tried to delete non-existent mod metadata for %1!").arg(mod_name);
+        qWarning() << QString("Tried to delete non-existent mod metadata for %1!").arg(mod_slug);
         return;
     }
 
     if (!index_file.remove()) {
-        qWarning() << QString("Failed to remove metadata for mod %1!").arg(mod_name);
+        qWarning() << QString("Failed to remove metadata for mod %1!").arg(mod_slug);
     }
 }
 
@@ -221,11 +221,11 @@ void V1::deleteModIndex(QDir& index_dir, QVariant& mod_id)
     }
 }
 
-auto V1::getIndexForMod(QDir& index_dir, QString& index_file_name) -> Mod
+auto V1::getIndexForMod(QDir& index_dir, QString slug) -> Mod
 {
     Mod mod;
 
-    auto normalized_fname = indexFileName(index_file_name);
+    auto normalized_fname = indexFileName(slug);
     auto real_fname = getRealIndexName(index_dir, normalized_fname, true);
     if (real_fname.isEmpty())
         return {};
@@ -233,7 +233,7 @@ auto V1::getIndexForMod(QDir& index_dir, QString& index_file_name) -> Mod
     QFile index_file(index_dir.absoluteFilePath(real_fname));
 
     if (!index_file.open(QIODevice::ReadOnly)) {
-        qWarning() << QString("Failed to open mod metadata for %1").arg(index_file_name);
+        qWarning() << QString("Failed to open mod metadata for %1").arg(slug);
         return {};
     }
 
@@ -247,11 +247,13 @@ auto V1::getIndexForMod(QDir& index_dir, QString& index_file_name) -> Mod
     index_file.close();
 
     if (!table) {
-        qWarning() << QString("Could not open file %1!").arg(indexFileName(index_file_name));
+        qWarning() << QString("Could not open file %1!").arg(normalized_fname);
         qWarning() << "Reason: " << QString(errbuf);
         return {};
     }
 
+    mod.slug = slug;
+
     {  // Basic info
         mod.name = stringEntry(table, "name");
         mod.filename = stringEntry(table, "filename");
diff --git a/launcher/modplatform/packwiz/Packwiz.h b/launcher/modplatform/packwiz/Packwiz.h
index 9d643703..3ec80377 100644
--- a/launcher/modplatform/packwiz/Packwiz.h
+++ b/launcher/modplatform/packwiz/Packwiz.h
@@ -40,6 +40,7 @@ auto intEntry(toml_table_t* parent, const char* entry_name) -> int;
 class V1 {
    public:
     struct Mod {
+        QString slug {};
         QString name {};
         QString filename {};
         // FIXME: make side an enum
@@ -58,7 +59,7 @@ class V1 {
 
        public:
         // This is a totally heuristic, but should work for now.
-        auto isValid() const -> bool { return !name.isEmpty() && !project_id.isNull(); }
+        auto isValid() const -> bool { return !slug.isEmpty() && !project_id.isNull(); }
 
         // Different providers can use different names for the same thing
         // Modrinth-specific
@@ -71,9 +72,9 @@ class V1 {
      * */
     static auto createModFormat(QDir& index_dir, ModPlatform::IndexedPack& mod_pack, ModPlatform::IndexedVersion& mod_version) -> Mod;
     /* Generates the object representing the information in a mod.pw.toml file via
-     * its common representation in the launcher.
+     * its common representation in the launcher, plus a necessary slug.
      * */
-    static auto createModFormat(QDir& index_dir, ::Mod& internal_mod) -> Mod;
+    static auto createModFormat(QDir& index_dir, ::Mod& internal_mod, QString slug) -> Mod;
 
     /* Updates the mod index for the provided mod.
      * This creates a new index if one does not exist already
@@ -81,16 +82,16 @@ class V1 {
      * */
     static void updateModIndex(QDir& index_dir, Mod& mod);
 
-    /* Deletes the metadata for the mod with the given name. If the metadata doesn't exist, it does nothing. */
-    static void deleteModIndex(QDir& index_dir, QString& mod_name);
+    /* Deletes the metadata for the mod with the given slug. If the metadata doesn't exist, it does nothing. */
+    static void deleteModIndex(QDir& index_dir, QString& mod_slug);
 
     /* Deletes the metadata for the mod with the given id. If the metadata doesn't exist, it does nothing. */
     static void deleteModIndex(QDir& index_dir, QVariant& mod_id);
 
-    /* Gets the metadata for a mod with a particular name.
+    /* Gets the metadata for a mod with a particular file name.
      * If the mod doesn't have a metadata, it simply returns an empty Mod object.
      * */
-    static auto getIndexForMod(QDir& index_dir, QString& index_file_name) -> Mod;
+    static auto getIndexForMod(QDir& index_dir, QString slug) -> Mod;
 
     /* Gets the metadata for a mod with a particular id.
      * If the mod doesn't have a metadata, it simply returns an empty Mod object.
diff --git a/launcher/modplatform/packwiz/Packwiz_test.cpp b/launcher/modplatform/packwiz/Packwiz_test.cpp
index d6251148..aa0c35df 100644
--- a/launcher/modplatform/packwiz/Packwiz_test.cpp
+++ b/launcher/modplatform/packwiz/Packwiz_test.cpp
@@ -32,10 +32,11 @@ class PackwizTest : public QObject {
         QString source = QFINDTESTDATA("testdata");
 
         QDir index_dir(source);
-        QString name_mod("borderless-mining.pw.toml");
-        QVERIFY(index_dir.entryList().contains(name_mod));
+        QString slug_mod("borderless-mining");
+        QString file_name = slug_mod + ".pw.toml";
+        QVERIFY(index_dir.entryList().contains(file_name));
 
-        auto metadata = Packwiz::V1::getIndexForMod(index_dir, name_mod);
+        auto metadata = Packwiz::V1::getIndexForMod(index_dir, slug_mod);
 
         QVERIFY(metadata.isValid());