summaryrefslogtreecommitdiffstats
path: root/api/logic/minecraft
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@gmail.com>2019-08-03 05:30:46 +0200
committerPetr Mrázek <peterix@gmail.com>2019-08-03 05:30:46 +0200
commit7d13e3119801862b9fdf64b11a45c41a64b4fc46 (patch)
treebf57acec88e4c4f09605603291d5483da2a13ab6 /api/logic/minecraft
parent40c9af1a8b2f42f4c90c8d358eac43370c04a227 (diff)
downloadMultiMC-7d13e3119801862b9fdf64b11a45c41a64b4fc46.tar
MultiMC-7d13e3119801862b9fdf64b11a45c41a64b4fc46.tar.gz
MultiMC-7d13e3119801862b9fdf64b11a45c41a64b4fc46.tar.lz
MultiMC-7d13e3119801862b9fdf64b11a45c41a64b4fc46.tar.xz
MultiMC-7d13e3119801862b9fdf64b11a45c41a64b4fc46.zip
NOISSUE refactor Mod a bunch, get rid of dead code
Diffstat (limited to 'api/logic/minecraft')
-rw-r--r--api/logic/minecraft/Mod.cpp456
-rw-r--r--api/logic/minecraft/Mod.h91
-rw-r--r--api/logic/minecraft/SimpleModList.cpp11
-rw-r--r--api/logic/minecraft/World.cpp4
-rw-r--r--api/logic/minecraft/World.h1
-rw-r--r--api/logic/minecraft/legacy/LegacyInstance.cpp1
-rw-r--r--api/logic/minecraft/legacy/LegacyModList.h9
7 files changed, 270 insertions, 303 deletions
diff --git a/api/logic/minecraft/Mod.cpp b/api/logic/minecraft/Mod.cpp
index 6217c9d2..936ca00a 100644
--- a/api/logic/minecraft/Mod.cpp
+++ b/api/logic/minecraft/Mod.cpp
@@ -27,6 +27,183 @@
#include <FileSystem.h>
#include <QDebug>
+namespace {
+// NEW format
+// https://github.com/MinecraftForge/FML/wiki/FML-mod-information-file/6f62b37cea040daf350dc253eae6326dd9c822c3
+
+// OLD format:
+// https://github.com/MinecraftForge/FML/wiki/FML-mod-information-file/5bf6a2d05145ec79387acc0d45c958642fb049fc
+ModDetails ReadMCModInfo(QByteArray contents)
+{
+ auto getInfoFromArray = [&](QJsonArray arr)->ModDetails
+ {
+ ModDetails details;
+ if (!arr.at(0).isObject()) {
+ return details;
+ }
+ auto firstObj = arr.at(0).toObject();
+ details.mod_id = firstObj.value("modid").toString();
+ auto name = firstObj.value("name").toString();
+ // NOTE: ignore stupid example mods copies where the author didn't even bother to change the name
+ if(name != "Example Mod") {
+ details.name = name;
+ }
+ details.version = firstObj.value("version").toString();
+ details.updateurl = firstObj.value("updateUrl").toString();
+ auto homeurl = firstObj.value("url").toString().trimmed();
+ if(!homeurl.isEmpty())
+ {
+ // fix up url.
+ if (!homeurl.startsWith("http://") && !homeurl.startsWith("https://") && !homeurl.startsWith("ftp://"))
+ {
+ homeurl.prepend("http://");
+ }
+ }
+ details.homeurl = homeurl;
+ details.description = firstObj.value("description").toString();
+ QJsonArray authors = firstObj.value("authorList").toArray();
+ if (authors.size() == 0) {
+ // FIXME: what is the format of this? is there any?
+ authors = firstObj.value("authors").toArray();
+ }
+
+ for (auto author: authors)
+ {
+ details.authors.append(author.toString());
+ }
+ details.credits = firstObj.value("credits").toString();
+ details.valid = true;
+ return details;
+ };
+ QJsonParseError jsonError;
+ QJsonDocument jsonDoc = QJsonDocument::fromJson(contents, &jsonError);
+ // this is the very old format that had just the array
+ if (jsonDoc.isArray())
+ {
+ return getInfoFromArray(jsonDoc.array());
+ }
+ else if (jsonDoc.isObject())
+ {
+ auto val = jsonDoc.object().value("modinfoversion");
+ if(val.isUndefined()) {
+ val = jsonDoc.object().value("modListVersion");
+ }
+ int version = val.toDouble();
+ if (version != 2)
+ {
+ qCritical() << "BAD stuff happened to mod json:";
+ qCritical() << contents;
+ return ModDetails();
+ }
+ auto arrVal = jsonDoc.object().value("modlist");
+ if(arrVal.isUndefined()) {
+ arrVal = jsonDoc.object().value("modList");
+ }
+ if (arrVal.isArray())
+ {
+ return getInfoFromArray(arrVal.toArray());
+ }
+ }
+ return ModDetails();
+}
+
+// https://fabricmc.net/wiki/documentation:fabric_mod_json
+ModDetails ReadFabricModInfo(QByteArray contents)
+{
+ QJsonParseError jsonError;
+ QJsonDocument jsonDoc = QJsonDocument::fromJson(contents, &jsonError);
+ auto object = jsonDoc.object();
+ auto schemaVersion = object.contains("schemaVersion") ? object.value("schemaVersion").toInt(0) : 0;
+
+ ModDetails details;
+
+ details.mod_id = object.value("id").toString();
+ details.version = object.value("version").toString();
+
+ details.name = object.contains("name") ? object.value("name").toString() : details.mod_id;
+ details.description = object.value("description").toString();
+
+ if (schemaVersion >= 1)
+ {
+ QJsonArray authors = object.value("authors").toArray();
+ for (auto author: authors)
+ {
+ if(author.isObject()) {
+ details.authors.append(author.toObject().value("name").toString());
+ }
+ else {
+ details.authors.append(author.toString());
+ }
+ }
+
+ if (object.contains("contact"))
+ {
+ QJsonObject contact = object.value("contact").toObject();
+
+ if (contact.contains("homepage"))
+ {
+ details.homeurl = contact.value("homepage").toString();
+ }
+ }
+ }
+ details.valid = !details.name.isEmpty();
+ return details;
+}
+
+ModDetails ReadForgeInfo(QByteArray contents)
+{
+ ModDetails details;
+ // Read the data
+ details.name = "Minecraft Forge";
+ details.mod_id = "Forge";
+ details.homeurl = "http://www.minecraftforge.net/forum/";
+ details.valid = true;
+ INIFile ini;
+ if (!ini.loadFile(contents))
+ return details;
+
+ QString major = ini.get("forge.major.number", "0").toString();
+ QString minor = ini.get("forge.minor.number", "0").toString();
+ QString revision = ini.get("forge.revision.number", "0").toString();
+ QString build = ini.get("forge.build.number", "0").toString();
+
+ details.version = major + "." + minor + "." + revision + "." + build;
+ return details;
+}
+
+ModDetails ReadLiteModInfo(QByteArray contents)
+{
+ ModDetails details;
+ QJsonParseError jsonError;
+ QJsonDocument jsonDoc = QJsonDocument::fromJson(contents, &jsonError);
+ auto object = jsonDoc.object();
+ if (object.contains("name"))
+ {
+ details.mod_id = details.name = object.value("name").toString();
+ }
+ if (object.contains("version"))
+ {
+ details.version = object.value("version").toString("");
+ }
+ else
+ {
+ details.version = object.value("revision").toString("");
+ }
+ details.mcversion = object.value("mcversion").toString();
+ auto author = object.value("author").toString();
+ if(!author.isEmpty()) {
+ details.authors.append(author);
+ }
+ details.description = object.value("description").toString();
+ details.homeurl = object.value("url").toString();
+ return details;
+}
+
+ModDetails invalidDetails;
+
+}
+
+
Mod::Mod(const QFileInfo &file)
{
repath(file);
@@ -91,7 +268,7 @@ void Mod::repath(const QFileInfo &file)
return;
}
- ReadMCModInfo(file.readAll());
+ m_localDetails = ReadMCModInfo(file.readAll());
file.close();
zip.close();
return;
@@ -104,7 +281,7 @@ void Mod::repath(const QFileInfo &file)
return;
}
- ReadFabricModInfo(file.readAll());
+ m_localDetails = ReadFabricModInfo(file.readAll());
file.close();
zip.close();
return;
@@ -117,7 +294,7 @@ void Mod::repath(const QFileInfo &file)
return;
}
- ReadForgeInfo(file.readAll());
+ m_localDetails = ReadForgeInfo(file.readAll());
file.close();
zip.close();
return;
@@ -136,7 +313,7 @@ void Mod::repath(const QFileInfo &file)
auto data = mcmod.readAll();
if (data.isEmpty() || data.isNull())
return;
- ReadMCModInfo(data);
+ m_localDetails = ReadMCModInfo(data);
}
}
else if (m_type == MOD_LITEMOD)
@@ -155,202 +332,41 @@ void Mod::repath(const QFileInfo &file)
return;
}
- ReadLiteModInfo(file.readAll());
+ m_localDetails = ReadLiteModInfo(file.readAll());
file.close();
}
zip.close();
}
}
-// NEW format
-// https://github.com/MinecraftForge/FML/wiki/FML-mod-information-file/6f62b37cea040daf350dc253eae6326dd9c822c3
-
-// OLD format:
-// https://github.com/MinecraftForge/FML/wiki/FML-mod-information-file/5bf6a2d05145ec79387acc0d45c958642fb049fc
-void Mod::ReadMCModInfo(QByteArray contents)
-{
- auto getInfoFromArray = [&](QJsonArray arr)->void
- {
- if (!arr.at(0).isObject())
- return;
- auto firstObj = arr.at(0).toObject();
- m_mod_id = firstObj.value("modid").toString();
- m_name = firstObj.value("name").toString();
- m_version = firstObj.value("version").toString();
- m_homeurl = firstObj.value("url").toString();
- m_updateurl = firstObj.value("updateUrl").toString();
- m_homeurl = m_homeurl.trimmed();
- if(!m_homeurl.isEmpty())
- {
- // fix up url.
- if (!m_homeurl.startsWith("http://") && !m_homeurl.startsWith("https://") &&
- !m_homeurl.startsWith("ftp://"))
- {
- m_homeurl.prepend("http://");
- }
- }
- m_description = firstObj.value("description").toString();
- QJsonArray authors = firstObj.value("authorList").toArray();
- if (authors.size() == 0)
- authors = firstObj.value("authors").toArray();
-
- if (authors.size() == 0)
- m_authors = "";
- else if (authors.size() >= 1)
- {
- m_authors = authors.at(0).toString();
- for (int i = 1; i < authors.size(); i++)
- {
- m_authors += ", " + authors.at(i).toString();
- }
- }
- m_credits = firstObj.value("credits").toString();
- return;
- }
- ;
- QJsonParseError jsonError;
- QJsonDocument jsonDoc = QJsonDocument::fromJson(contents, &jsonError);
- // this is the very old format that had just the array
- if (jsonDoc.isArray())
- {
- getInfoFromArray(jsonDoc.array());
- }
- else if (jsonDoc.isObject())
- {
- auto val = jsonDoc.object().value("modinfoversion");
- if(val.isUndefined())
- val = jsonDoc.object().value("modListVersion");
- int version = val.toDouble();
- if (version != 2)
- {
- qCritical() << "BAD stuff happened to mod json:";
- qCritical() << contents;
- return;
- }
- auto arrVal = jsonDoc.object().value("modlist");
- if(arrVal.isUndefined())
- arrVal = jsonDoc.object().value("modList");
- if (arrVal.isArray())
- {
- getInfoFromArray(arrVal.toArray());
- }
- }
-}
-
-// https://fabricmc.net/wiki/documentation:fabric_mod_json
-void Mod::ReadFabricModInfo(QByteArray contents)
-{
- QJsonParseError jsonError;
- QJsonDocument jsonDoc = QJsonDocument::fromJson(contents, &jsonError);
- auto object = jsonDoc.object();
- auto schemaVersion = object.contains("schemaVersion") ? object.value("schemaVersion").toInt(0) : 0;
-
- m_mod_id = object.value("id").toString();
- m_version = object.value("version").toString();
-
- m_name = object.contains("name") ? object.value("name").toString() : m_mod_id;
- m_description = object.value("description").toString();
-
- if (schemaVersion >= 1)
- {
- QJsonArray authors = object.value("authors").toArray();
- m_authors = "";
-
- for (int i = 0; i < authors.size(); i++)
- {
- QString author_name = authors.at(i).isObject()
- ? authors.at(i).toObject().value("name").toString()
- : authors.at(i).toString();
-
- if (i > 0)
- m_authors += ", " + author_name;
- else {
- m_authors += author_name;
- }
- }
-
- if (object.contains("contact"))
- {
- QJsonObject contact = object.value("contact").toObject();
-
- if (contact.contains("homepage"))
- m_homeurl = contact.value("homepage").toString();
- }
- }
-}
-
-void Mod::ReadForgeInfo(QByteArray contents)
-{
- // Read the data
- m_name = "Minecraft Forge";
- m_mod_id = "Forge";
- m_homeurl = "http://www.minecraftforge.net/forum/";
- INIFile ini;
- if (!ini.loadFile(contents))
- return;
-
- QString major = ini.get("forge.major.number", "0").toString();
- QString minor = ini.get("forge.minor.number", "0").toString();
- QString revision = ini.get("forge.revision.number", "0").toString();
- QString build = ini.get("forge.build.number", "0").toString();
-
- m_version = major + "." + minor + "." + revision + "." + build;
-}
-
-void Mod::ReadLiteModInfo(QByteArray contents)
+bool Mod::enable(bool value)
{
- QJsonParseError jsonError;
- QJsonDocument jsonDoc = QJsonDocument::fromJson(contents, &jsonError);
- auto object = jsonDoc.object();
- if (object.contains("name"))
- {
- m_mod_id = m_name = object.value("name").toString();
- }
- if (object.contains("version"))
- {
- m_version = object.value("version").toString("");
- }
- else
- {
- m_version = object.value("revision").toString("");
- }
- m_mcversion = object.value("mcversion").toString();
- m_authors = object.value("author").toString();
- m_description = object.value("description").toString();
- m_homeurl = object.value("url").toString();
-}
+ if (m_type == Mod::MOD_UNKNOWN || m_type == Mod::MOD_FOLDER)
+ return false;
-bool Mod::replace(Mod &with)
-{
- if (!destroy())
+ if (m_enabled == value)
return false;
- bool success = false;
- auto t = with.type();
- if (t == MOD_ZIPFILE || t == MOD_SINGLEFILE || t == MOD_LITEMOD)
- {
- qDebug() << "Copy: " << with.m_file.filePath() << " to " << m_file.filePath();
- success = QFile::copy(with.m_file.filePath(), m_file.filePath());
- }
- if (t == MOD_FOLDER)
+ QString path = m_file.absoluteFilePath();
+ if (value)
{
- success = FS::copy(with.m_file.filePath(), m_file.path())();
+ QFile foo(path);
+ if (!path.endsWith(".disabled"))
+ return false;
+ path.chop(9);
+ if (!foo.rename(path))
+ return false;
}
- if (success)
+ else
{
- m_name = with.m_name;
- m_mmc_id = with.m_mmc_id;
- m_mod_id = with.m_mod_id;
- m_version = with.m_version;
- m_mcversion = with.m_mcversion;
- m_description = with.m_description;
- m_authors = with.m_authors;
- m_credits = with.m_credits;
- m_homeurl = with.m_homeurl;
- m_type = with.m_type;
- m_file.refresh();
+ QFile foo(path);
+ path += ".disabled";
+ if (!foo.rename(path))
+ return false;
}
- return success;
+ m_file = QFileInfo(path);
+ m_enabled = value;
+ return true;
}
bool Mod::destroy()
@@ -378,56 +394,40 @@ bool Mod::destroy()
return true;
}
-QString Mod::version() const
+
+const ModDetails & Mod::details() const
{
- switch (type())
- {
- case MOD_ZIPFILE:
- case MOD_LITEMOD:
- return m_version;
- case MOD_FOLDER:
- return "Folder";
- case MOD_SINGLEFILE:
- return "File";
- default:
- return "VOID";
- }
+ if(!m_localDetails)
+ return invalidDetails;
+ return m_localDetails;
}
-bool Mod::enable(bool value)
-{
- if (m_type == Mod::MOD_UNKNOWN || m_type == Mod::MOD_FOLDER)
- return false;
- if (m_enabled == value)
- return false;
+QString Mod::version() const
+{
+ return details().version;
+}
- QString path = m_file.absoluteFilePath();
- if (value)
- {
- QFile foo(path);
- if (!path.endsWith(".disabled"))
- return false;
- path.chop(9);
- if (!foo.rename(path))
- return false;
- }
- else
- {
- QFile foo(path);
- path += ".disabled";
- if (!foo.rename(path))
- return false;
+QString Mod::name() const
+{
+ auto & d = details();
+ if(d && !d.name.isEmpty()) {
+ return d.name;
}
- m_file = QFileInfo(path);
- m_enabled = value;
- return true;
+ return m_name;
+}
+
+QString Mod::homeurl() const
+{
+ return details().homeurl;
}
-bool Mod::operator==(const Mod &other) const
+
+QString Mod::description() const
{
- return mmc_id() == other.mmc_id();
+ return details().description;
}
-bool Mod::strongCompare(const Mod &other) const
+
+QStringList Mod::authors() const
{
- return mmc_id() == other.mmc_id() && version() == other.version() && type() == other.type();
+ return details().authors;
}
diff --git a/api/logic/minecraft/Mod.h b/api/logic/minecraft/Mod.h
index 6d36d525..890669ce 100644
--- a/api/logic/minecraft/Mod.h
+++ b/api/logic/minecraft/Mod.h
@@ -16,8 +16,26 @@
#pragma once
#include <QFileInfo>
#include <QDateTime>
+#include "multimc_logic_export.h"
-class Mod
+struct ModDetails
+{
+ operator bool() const {
+ return valid;
+ }
+ bool valid = false;
+ QString mod_id;
+ QString name;
+ QString version;
+ QString mcversion;
+ QString homeurl;
+ QString updateurl;
+ QString description;
+ QStringList authors;
+ QString credits;
+};
+
+class MULTIMC_LOGIC_EXPORT Mod
{
public:
enum ModType
@@ -39,10 +57,6 @@ public:
{
return m_mmc_id;
}
- QString mod_id() const
- {
- return m_mod_id;
- }
ModType type() const
{
return m_type;
@@ -51,37 +65,6 @@ public:
{
return m_type != MOD_UNKNOWN;
}
- QString name() const
- {
- QString name = m_name.trimmed();
- if(name.isEmpty() || name == "Example Mod")
- {
- return m_mmc_id;
- }
- return m_name;
- }
-
- QString version() const;
-
- QString homeurl() const
- {
- return m_homeurl;
- }
-
- QString description() const
- {
- return m_description;
- }
-
- QString authors() const
- {
- return m_authors;
- }
-
- QString credits() const
- {
- return m_credits;
- }
QDateTime dateTimeChanged() const
{
@@ -93,39 +76,29 @@ public:
return m_enabled;
}
+ const ModDetails &details() const;
+
+ QString name() const;
+ QString version() const;
+ QString homeurl() const;
+ QString description() const;
+ QStringList authors() const;
+
bool enable(bool value);
// delete all the files of this mod
bool destroy();
- // replace this mod with a copy of the other
- bool replace(Mod &with);
+
// change the mod's filesystem path (used by mod lists for *MAGIC* purposes)
void repath(const QFileInfo &file);
- // WEAK compare operator - used for replacing mods
- bool operator==(const Mod &other) const;
- bool strongCompare(const Mod &other) const;
-
-private:
- void ReadMCModInfo(QByteArray contents);
- void ReadFabricModInfo(QByteArray contents);
- void ReadForgeInfo(QByteArray contents);
- void ReadLiteModInfo(QByteArray contents);
-
protected:
QFileInfo m_file;
QDateTime m_changedDateTime;
QString m_mmc_id;
- QString m_mod_id;
- bool m_enabled = true;
QString m_name;
- QString m_version;
- QString m_mcversion;
- QString m_homeurl;
- QString m_updateurl;
- QString m_description;
- QString m_authors;
- QString m_credits;
-
- ModType m_type;
+ bool m_enabled = true;
+ ModType m_type = MOD_UNKNOWN;
+ bool m_bare = true;
+ ModDetails m_localDetails;
};
diff --git a/api/logic/minecraft/SimpleModList.cpp b/api/logic/minecraft/SimpleModList.cpp
index 5edd6856..b90b55c2 100644
--- a/api/logic/minecraft/SimpleModList.cpp
+++ b/api/logic/minecraft/SimpleModList.cpp
@@ -249,8 +249,17 @@ QVariant SimpleModList::data(const QModelIndex &index, int role) const
{
case NameColumn:
return mods[row].name();
- case VersionColumn:
+ case VersionColumn: {
+ switch(mods[row].type()) {
+ case Mod::MOD_FOLDER:
+ return tr("Folder");
+ case Mod::MOD_SINGLEFILE:
+ return tr("File");
+ default:
+ break;
+ }
return mods[row].version();
+ }
case DateColumn:
return mods[row].dateTimeChanged();
diff --git a/api/logic/minecraft/World.cpp b/api/logic/minecraft/World.cpp
index 79b8c22e..17dbf4ae 100644
--- a/api/logic/minecraft/World.cpp
+++ b/api/logic/minecraft/World.cpp
@@ -429,7 +429,3 @@ bool World::operator==(const World &other) const
{
return is_valid == other.is_valid && folderName() == other.folderName();
}
-bool World::strongCompare(const World &other) const
-{
- return is_valid == other.is_valid && folderName() == other.folderName();
-}
diff --git a/api/logic/minecraft/World.h b/api/logic/minecraft/World.h
index c29c8be5..818701fa 100644
--- a/api/logic/minecraft/World.h
+++ b/api/logic/minecraft/World.h
@@ -76,7 +76,6 @@ public:
// WEAK compare operator - used for replacing worlds
bool operator==(const World &other) const;
- bool strongCompare(const World &other) const;
private:
void readFromZip(const QFileInfo &file);
diff --git a/api/logic/minecraft/legacy/LegacyInstance.cpp b/api/logic/minecraft/legacy/LegacyInstance.cpp
index f00eb23f..b9d68a9c 100644
--- a/api/logic/minecraft/legacy/LegacyInstance.cpp
+++ b/api/logic/minecraft/legacy/LegacyInstance.cpp
@@ -21,7 +21,6 @@
#include "LegacyInstance.h"
#include "minecraft/legacy/LegacyModList.h"
-#include "minecraft/SimpleModList.h"
#include "minecraft/WorldList.h"
#include <MMCZip.h>
#include <FileSystem.h>
diff --git a/api/logic/minecraft/legacy/LegacyModList.h b/api/logic/minecraft/legacy/LegacyModList.h
index 4e91958d..9a7bea50 100644
--- a/api/logic/minecraft/legacy/LegacyModList.h
+++ b/api/logic/minecraft/legacy/LegacyModList.h
@@ -19,17 +19,8 @@
#include <QString>
#include <QDir>
-#include "minecraft/Mod.h"
-
#include "multimc_logic_export.h"
-class LegacyInstance;
-class BaseInstance;
-
-/**
- * A legacy mod list.
- * Backed by a folder.
- */
class MULTIMC_LOGIC_EXPORT LegacyModList
{
public: