sneedmc/logic/minecraft/VersionFile.cpp
Petr Mrázek 24db645167 NOISSUE sanitize Json
Removes magical parameter madness.
All require* can throw
All ensure* need a default value and never throw
2015-06-06 21:23:05 +02:00

513 lines
13 KiB
C++

#include <QJsonArray>
#include <QJsonDocument>
#include <modutils.h>
#include <QDebug>
#include "minecraft/VersionFile.h"
#include "minecraft/OneSixLibrary.h"
#include "minecraft/MinecraftProfile.h"
#include "minecraft/JarMod.h"
#include "ParseUtils.h"
#include "Json.h"
using namespace Json;
#include "VersionBuildError.h"
#define CURRENT_MINIMUM_LAUNCHER_VERSION 14
int findLibraryByName(QList<OneSixLibraryPtr> haystack, const GradleSpecifier &needle)
{
int retval = -1;
for (int i = 0; i < haystack.size(); ++i)
{
if (haystack.at(i)->rawName().matchName(needle))
{
// only one is allowed.
if (retval != -1)
return -1;
retval = i;
}
}
return retval;
}
VersionFilePtr VersionFile::fromJson(const QJsonDocument &doc, const QString &filename,
const bool requireOrder)
{
VersionFilePtr out(new VersionFile());
if (doc.isEmpty() || doc.isNull())
{
throw JSONValidationError(filename + " is empty or null");
}
if (!doc.isObject())
{
throw JSONValidationError(filename + " is not an object");
}
QJsonObject root = doc.object();
if (requireOrder)
{
if (root.contains("order"))
{
out->order = requireInteger(root.value("order"));
}
else
{
// FIXME: evaluate if we don't want to throw exceptions here instead
qCritical() << filename << "doesn't contain an order field";
}
}
out->name = root.value("name").toString();
out->fileId = root.value("fileId").toString();
out->version = root.value("version").toString();
out->mcVersion = root.value("mcVersion").toString();
out->filename = filename;
auto readString = [root](const QString &key, QString &variable)
{
if (root.contains(key))
{
variable = requireString(root.value(key));
}
};
auto readStringRet = [root](const QString &key) -> QString
{
if (root.contains(key))
{
return requireString(root.value(key));
}
return QString();
};
readString("id", out->id);
readString("mainClass", out->mainClass);
readString("appletClass", out->appletClass);
readString("processArguments", out->processArguments);
readString("minecraftArguments", out->overwriteMinecraftArguments);
readString("+minecraftArguments", out->addMinecraftArguments);
readString("-minecraftArguments", out->removeMinecraftArguments);
readString("type", out->type);
parse_timestamp(readStringRet("releaseTime"), out->m_releaseTimeString, out->m_releaseTime);
parse_timestamp(readStringRet("time"), out->m_updateTimeString, out->m_updateTime);
readString("assets", out->assets);
if (root.contains("minimumLauncherVersion"))
{
out->minimumLauncherVersion = requireInteger(root.value("minimumLauncherVersion"));
}
if (root.contains("tweakers"))
{
out->shouldOverwriteTweakers = true;
for (auto tweakerVal : requireArray(root.value("tweakers")))
{
out->overwriteTweakers.append(requireString(tweakerVal));
}
}
if (root.contains("+tweakers"))
{
for (auto tweakerVal : requireArray(root.value("+tweakers")))
{
out->addTweakers.append(requireString(tweakerVal));
}
}
if (root.contains("-tweakers"))
{
for (auto tweakerVal : requireArray(root.value("-tweakers")))
{
out->removeTweakers.append(requireString(tweakerVal));
}
}
if (root.contains("+traits"))
{
for (auto tweakerVal : requireArray(root.value("+traits")))
{
out->traits.insert(requireString(tweakerVal));
}
}
if (root.contains("libraries"))
{
out->shouldOverwriteLibs = true;
for (auto libVal : requireArray(root.value("libraries")))
{
auto libObj = requireObject(libVal);
auto lib = RawLibrary::fromJson(libObj, filename);
out->overwriteLibs.append(lib);
}
}
if (root.contains("+jarMods"))
{
for (auto libVal : requireArray(root.value("+jarMods")))
{
QJsonObject libObj = requireObject(libVal);
// parse the jarmod
auto lib = Jarmod::fromJson(libObj, filename, out->name);
if(lib->originalName.isEmpty())
{
auto fixed = out->name;
fixed.remove(" (jar mod)");
lib->originalName = out->name;
}
// and add to jar mods
out->jarMods.append(lib);
}
}
if (root.contains("+libraries"))
{
for (auto libVal : requireArray(root.value("+libraries")))
{
QJsonObject libObj = requireObject(libVal);
// parse the library
auto lib = RawLibrary::fromJsonPlus(libObj, filename);
out->addLibs.append(lib);
}
}
if (root.contains("-libraries"))
{
for (auto libVal : requireArray(root.value("-libraries")))
{
auto libObj = requireObject(libVal);
out->removeLibs.append(requireString(libObj.value("name")));
}
}
return out;
}
QJsonDocument VersionFile::toJson(bool saveOrder)
{
QJsonObject root;
if (saveOrder)
{
root.insert("order", order);
}
writeString(root, "name", name);
writeString(root, "fileId", fileId);
writeString(root, "version", version);
writeString(root, "mcVersion", mcVersion);
writeString(root, "id", id);
writeString(root, "mainClass", mainClass);
writeString(root, "appletClass", appletClass);
writeString(root, "processArguments", processArguments);
writeString(root, "minecraftArguments", overwriteMinecraftArguments);
writeString(root, "+minecraftArguments", addMinecraftArguments);
writeString(root, "-minecraftArguments", removeMinecraftArguments);
writeString(root, "type", type);
writeString(root, "assets", assets);
if (isMinecraftVersion())
{
writeString(root, "releaseTime", m_releaseTimeString);
writeString(root, "time", m_updateTimeString);
}
if (minimumLauncherVersion != -1)
{
root.insert("minimumLauncherVersion", minimumLauncherVersion);
}
writeStringList(root, "tweakers", overwriteTweakers);
writeStringList(root, "+tweakers", addTweakers);
writeStringList(root, "-tweakers", removeTweakers);
writeStringList(root, "+traits", traits.toList());
writeObjectList(root, "libraries", overwriteLibs);
writeObjectList(root, "+libraries", addLibs);
writeObjectList(root, "+jarMods", jarMods);
// FIXME: removed libs are special snowflakes.
if (removeLibs.size())
{
QJsonArray array;
for (auto lib : removeLibs)
{
QJsonObject rmlibobj;
rmlibobj.insert("name", lib);
array.append(rmlibobj);
}
root.insert("-libraries", array);
}
// write the contents to a json document.
{
QJsonDocument out;
out.setObject(root);
return out;
}
}
bool VersionFile::isMinecraftVersion()
{
return fileId == "net.minecraft";
}
bool VersionFile::hasJarMods()
{
return !jarMods.isEmpty();
}
void VersionFile::applyTo(MinecraftProfile *version)
{
if (minimumLauncherVersion != -1)
{
if (minimumLauncherVersion > CURRENT_MINIMUM_LAUNCHER_VERSION)
{
throw LauncherVersionError(minimumLauncherVersion,
CURRENT_MINIMUM_LAUNCHER_VERSION);
}
}
if (!version->id.isNull() && !mcVersion.isNull())
{
if (QRegExp(mcVersion, Qt::CaseInsensitive, QRegExp::Wildcard).indexIn(version->id) ==
-1)
{
throw MinecraftVersionMismatch(fileId, mcVersion, version->id);
}
}
if (!id.isNull())
{
version->id = id;
}
if (!mainClass.isNull())
{
version->mainClass = mainClass;
}
if (!appletClass.isNull())
{
version->appletClass = appletClass;
}
if (!processArguments.isNull())
{
if (isMinecraftVersion())
{
version->vanillaProcessArguments = processArguments;
}
version->processArguments = processArguments;
}
if (isMinecraftVersion())
{
if (!type.isNull())
{
version->type = type;
}
if (!m_releaseTimeString.isNull())
{
version->m_releaseTimeString = m_releaseTimeString;
version->m_releaseTime = m_releaseTime;
}
if (!m_updateTimeString.isNull())
{
version->m_updateTimeString = m_updateTimeString;
version->m_updateTime = m_updateTime;
}
}
if (!assets.isNull())
{
version->assets = assets;
}
if (minimumLauncherVersion >= 0)
{
if (version->minimumLauncherVersion < minimumLauncherVersion)
version->minimumLauncherVersion = minimumLauncherVersion;
}
if (!overwriteMinecraftArguments.isNull())
{
if (isMinecraftVersion())
{
version->vanillaMinecraftArguments = overwriteMinecraftArguments;
}
version->minecraftArguments = overwriteMinecraftArguments;
}
if (!addMinecraftArguments.isNull())
{
version->minecraftArguments += addMinecraftArguments;
}
if (!removeMinecraftArguments.isNull())
{
version->minecraftArguments.remove(removeMinecraftArguments);
}
if (shouldOverwriteTweakers)
{
version->tweakers = overwriteTweakers;
}
for (auto tweaker : addTweakers)
{
version->tweakers += tweaker;
}
for (auto tweaker : removeTweakers)
{
version->tweakers.removeAll(tweaker);
}
version->jarMods.append(jarMods);
version->traits.unite(traits);
if (shouldOverwriteLibs)
{
QList<OneSixLibraryPtr> libs;
for (auto lib : overwriteLibs)
{
libs.append(OneSixLibrary::fromRawLibrary(lib));
}
if (isMinecraftVersion())
{
version->vanillaLibraries = libs;
}
version->libraries = libs;
}
for (auto addedLibrary : addLibs)
{
switch (addedLibrary->insertType)
{
case RawLibrary::Apply:
{
// qDebug() << "Applying lib " << lib->name;
int index = findLibraryByName(version->libraries, addedLibrary->rawName());
if (index >= 0)
{
auto existingLibrary = version->libraries[index];
if (!addedLibrary->m_base_url.isEmpty())
{
existingLibrary->setBaseUrl(addedLibrary->m_base_url);
}
if (!addedLibrary->m_hint.isNull())
{
existingLibrary->setHint(addedLibrary->m_hint);
}
if (!addedLibrary->m_absolute_url.isNull())
{
existingLibrary->setAbsoluteUrl(addedLibrary->m_absolute_url);
}
if (addedLibrary->applyExcludes)
{
existingLibrary->extract_excludes = addedLibrary->extract_excludes;
}
if (addedLibrary->isNative())
{
existingLibrary->m_native_classifiers = addedLibrary->m_native_classifiers;
}
if (addedLibrary->applyRules)
{
existingLibrary->setRules(addedLibrary->m_rules);
}
}
else
{
qWarning() << "Couldn't find" << addedLibrary->rawName() << "(skipping)";
}
break;
}
case RawLibrary::Append:
case RawLibrary::Prepend:
{
// find the library by name.
const int index = findLibraryByName(version->libraries, addedLibrary->rawName());
// library not found? just add it.
if (index < 0)
{
if (addedLibrary->insertType == RawLibrary::Append)
{
version->libraries.append(OneSixLibrary::fromRawLibrary(addedLibrary));
}
else
{
version->libraries.prepend(OneSixLibrary::fromRawLibrary(addedLibrary));
}
break;
}
// otherwise apply differences, if allowed
auto existingLibrary = version->libraries.at(index);
const Util::Version addedVersion = addedLibrary->version();
const Util::Version existingVersion = existingLibrary->version();
// if the existing version is a hard dependency we can either use it or
// fail, but we can't change it
if (existingLibrary->dependType == OneSixLibrary::Hard)
{
// we need a higher version, or we're hard to and the versions aren't
// equal
if (addedVersion > existingVersion ||
(addedLibrary->dependType == RawLibrary::Hard && addedVersion != existingVersion))
{
throw VersionBuildError(QObject::tr(
"Error resolving library dependencies between %1 and %2 in %3.")
.arg(existingLibrary->rawName(),
addedLibrary->rawName(), filename));
}
else
{
// the library is already existing, so we don't have to do anything
}
}
else if (existingLibrary->dependType == OneSixLibrary::Soft)
{
// if we are higher it means we should update
if (addedVersion > existingVersion)
{
auto library = OneSixLibrary::fromRawLibrary(addedLibrary);
version->libraries.replace(index, library);
}
else
{
// our version is smaller than the existing version, but we require
// it: fail
if (addedLibrary->dependType == RawLibrary::Hard)
{
throw VersionBuildError(QObject::tr(
"Error resolving library dependencies between %1 and %2 in %3.")
.arg(existingLibrary->rawName(),
addedLibrary->rawName(), filename));
}
}
}
break;
}
case RawLibrary::Replace:
{
GradleSpecifier toReplace;
if (addedLibrary->insertData.isEmpty())
{
toReplace = addedLibrary->rawName();
}
else
{
toReplace = addedLibrary->insertData;
}
// qDebug() << "Replacing lib " << toReplace << " with " << lib->name;
int index = findLibraryByName(version->libraries, toReplace);
if (index >= 0)
{
version->libraries.replace(index, OneSixLibrary::fromRawLibrary(addedLibrary));
}
else
{
qWarning() << "Couldn't find" << toReplace << "(skipping)";
}
break;
}
}
}
for (auto lib : removeLibs)
{
int index = findLibraryByName(version->libraries, lib);
if (index >= 0)
{
// qDebug() << "Removing lib " << lib;
version->libraries.removeAt(index);
}
else
{
qWarning() << "Couldn't find" << lib << "(skipping)";
}
}
}