/* Copyright 2013 MultiMC Contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include "OneSixVersionBuilder.h" #include #include #include #include #include #include #include #include #include #include #include "OneSixVersion.h" #include "OneSixInstance.h" #include "OneSixRule.h" #include "logger/QsLog.h" struct VersionFile { int order; QString name; QString fileId; QString version; // TODO use the mcVersion to determine if a version file should be removed on update QString mcVersion; QString filename; // TODO requirements // QMap requirements; QString id; QString mainClass; QString overwriteMinecraftArguments; QString addMinecraftArguments; QString removeMinecraftArguments; QString processArguments; QString type; QString releaseTime; QString time; QString assets; int minimumLauncherVersion = -1; bool shouldOverwriteTweakers = false; QStringList overwriteTweakers; QStringList addTweakers; QStringList removeTweakers; struct Library { QString name; QString url; QString hint; QString absoluteUrl; bool applyExcludes = false; QStringList excludes; bool applyNatives = false; QList> natives; bool applyRules = false; QList> rules; // user for '+' libraries enum InsertType { Apply, Append, Prepend, AppendIfNotExists, PrependIfNotExists, Replace }; InsertType insertType; QString insertData; }; bool shouldOverwriteLibs = false; QList overwriteLibs; QList addLibs; QList removeLibs; static Library fromLibraryJson(const QJsonObject &libObj, const QString &filename, bool &isError) { isError = true; Library out; if (!libObj.contains("name")) { QLOG_ERROR() << filename << "contains a library that doesn't have a 'name' field"; return out; } out.name = libObj.value("name").toString(); auto readString = [libObj, filename](const QString &key, QString &variable) { if (libObj.contains(key)) { QJsonValue val = libObj.value(key); if (!val.isString()) { QLOG_WARN() << key << "is not a string in" << filename << "(skipping)"; } else { variable = val.toString(); } } }; readString("url", out.url); readString("MMC-hint", out.hint); readString("MMC-absulute_url", out.absoluteUrl); readString("MMC-absoluteUrl", out.absoluteUrl); if (libObj.contains("extract")) { if (!libObj.value("extract").isObject()) { QLOG_ERROR() << filename << "contains a library with an 'extract' field that's not an object"; return out; } QJsonObject extractObj = libObj.value("extract").toObject(); if (!extractObj.contains("exclude") || !extractObj.value("exclude").isArray()) { QLOG_ERROR() << filename << "contains a library with an invalid 'extract' field"; return out; } out.applyExcludes = true; QJsonArray excludeArray = extractObj.value("exclude").toArray(); for (auto excludeVal : excludeArray) { if (!excludeVal.isString()) { QLOG_WARN() << filename << "contains a library that contains an 'extract' " "field that contains an invalid 'exclude' entry " "(skipping)"; } else { out.excludes.append(excludeVal.toString()); } } } if (libObj.contains("natives")) { if (!libObj.value("natives").isObject()) { QLOG_ERROR() << filename << "contains a library with a 'natives' field that's not an object"; return out; } out.applyNatives = true; QJsonObject nativesObj = libObj.value("natives").toObject(); for (auto it = nativesObj.begin(); it != nativesObj.end(); ++it) { if (!it.value().isString()) { QLOG_WARN() << filename << "contains an invalid native (skipping)"; } OpSys opSys = OpSys_fromString(it.key()); if (opSys != Os_Other) { out.natives.append(qMakePair(opSys, it.value().toString())); } } } if (libObj.contains("rules")) { out.applyRules = true; out.rules = rulesFromJsonV4(libObj); } isError = false; return out; } static VersionFile fromJson(const QJsonDocument &doc, const QString &filename, const bool requireOrder, bool &isError) { VersionFile out; isError = true; if (doc.isEmpty() || doc.isNull()) { QLOG_ERROR() << filename << "is empty or null"; return out; } if (!doc.isObject()) { QLOG_ERROR() << "The root of" << filename << "is not an object"; return out; } QJsonObject root = doc.object(); if (requireOrder) { if (root.contains("order")) { if (root.value("order").isDouble()) { out.order = root.value("order").toDouble(); } else { QLOG_ERROR() << "'order' field contains an invalid value in" << filename; return out; } } else { QLOG_ERROR() << 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, filename](const QString &key, QString &variable) { if (root.contains(key)) { QJsonValue val = root.value(key); if (!val.isString()) { QLOG_WARN() << key << "is not a string in" << filename << "(skipping)"; } else { variable = val.toString(); } } }; readString("id", out.id); readString("mainClass", out.mainClass); readString("processArguments", out.processArguments); readString("minecraftArguments", out.overwriteMinecraftArguments); readString("+minecraftArguments", out.addMinecraftArguments); readString("-minecraftArguments", out.removeMinecraftArguments); readString("type", out.type); readString("releaseTime", out.releaseTime); readString("time", out.time); readString("assets", out.assets); if (root.contains("minimumLauncherVersion")) { QJsonValue val = root.value("minimumLauncherVersion"); if (!val.isDouble()) { QLOG_WARN() << "minimumLauncherVersion is not an int in" << filename << "(skipping)"; } else { out.minimumLauncherVersion = val.toDouble(); } } if (root.contains("tweakers")) { QJsonValue tweakersVal = root.value("tweakers"); if (!tweakersVal.isArray()) { QLOG_ERROR() << filename << "contains a 'tweakers' field, but it's not an array"; return out; } out.shouldOverwriteTweakers = true; QJsonArray tweakers = root.value("tweakers").toArray(); for (auto tweakerVal : tweakers) { if (!tweakerVal.isString()) { QLOG_ERROR() << filename << "contains a 'tweakers' field entry that's not a string"; return out; } out.overwriteTweakers.append(tweakerVal.toString()); } } if (root.contains("+tweakers")) { QJsonValue tweakersVal = root.value("+tweakers"); if (!tweakersVal.isArray()) { QLOG_ERROR() << filename << "contains a '+tweakers' field, but it's not an array"; return out; } QJsonArray tweakers = root.value("+tweakers").toArray(); for (auto tweakerVal : tweakers) { if (!tweakerVal.isString()) { QLOG_ERROR() << filename << "contains a '+tweakers' field entry that's not a string"; return out; } out.addTweakers.append(tweakerVal.toString()); } } if (root.contains("-tweakers")) { QJsonValue tweakersVal = root.value("-tweakers"); if (!tweakersVal.isArray()) { QLOG_ERROR() << filename << "contains a '-tweakers' field, but it's not an array"; return out; } out.shouldOverwriteTweakers = true; QJsonArray tweakers = root.value("-tweakers").toArray(); for (auto tweakerVal : tweakers) { if (!tweakerVal.isString()) { QLOG_ERROR() << filename << "contains a '-tweakers' field entry that's not a string"; return out; } out.removeTweakers.append(tweakerVal.toString()); } } if (root.contains("libraries")) { out.shouldOverwriteLibs = true; QJsonValue librariesVal = root.value("libraries"); if (!librariesVal.isArray()) { QLOG_ERROR() << filename << "contains a 'libraries' field, but its not an array"; return out; } QJsonArray librariesArray = librariesVal.toArray(); for (auto libVal : librariesArray) { if (!libVal.isObject()) { QLOG_ERROR() << filename << "contains a library that's not an object"; return out; } QJsonObject libObj = libVal.toObject(); bool error; Library lib = fromLibraryJson(libObj, filename, error); if (error) { QLOG_ERROR() << "Error while reading a library entry in" << filename; return out; } out.overwriteLibs.append(lib); } } if (root.contains("+libraries")) { QJsonValue librariesVal = root.value("+libraries"); if (!librariesVal.isArray()) { QLOG_ERROR() << filename << "contains a '+libraries' field, but its not an array"; return out; } QJsonArray librariesArray = librariesVal.toArray(); for (auto libVal : librariesArray) { if (!libVal.isObject()) { QLOG_ERROR() << filename << "contains a library that's not an object"; return out; } QJsonObject libObj = libVal.toObject(); bool error; Library lib = fromLibraryJson(libObj, filename, error); if (error) { QLOG_ERROR() << "Error while reading a library entry in" << filename; return out; } if (!libObj.contains("insert")) { QLOG_ERROR() << "Missing 'insert' field in '+libraries' field in" << filename; return out; } QJsonValue insertVal = libObj.value("insert"); QString insertString; { if (insertVal.isString()) { insertString = insertVal.toString(); } else if (insertVal.isObject()) { QJsonObject insertObj = insertVal.toObject(); if (insertObj.isEmpty()) { QLOG_ERROR() << "One library has an empty insert object in" << filename; return out; } insertString = insertObj.keys().first(); lib.insertData = insertObj.value(insertString).toString(); } } if (insertString == "apply") { lib.insertType = Library::Apply; } else if (insertString == "append") { lib.insertType = Library::Append; } else if (insertString == "prepend") { lib.insertType = Library::Prepend; } else if (insertString == "prepend-if-not-exists") { lib.insertType = Library::PrependIfNotExists; } else if (insertString == "append-if-not-exists") { lib.insertType = Library::PrependIfNotExists; } else if (insertString == "replace") { lib.insertType = Library::Replace; } else { QLOG_ERROR() << "A '+' library in" << filename << "contains an invalid insert type"; return out; } out.addLibs.append(lib); } } if (root.contains("-libraries")) { QJsonValue librariesVal = root.value("-libraries"); if (!librariesVal.isArray()) { QLOG_ERROR() << filename << "contains a '-libraries' field, but its not an array"; return out; } QJsonArray librariesArray = librariesVal.toArray(); for (auto libVal : librariesArray) { if (!libVal.isObject()) { QLOG_ERROR() << filename << "contains a library that's not an object"; return out; } QJsonObject libObj = libVal.toObject(); if (!libObj.contains("name")) { QLOG_ERROR() << filename << "contains a library without a name"; return out; } if (!libObj.value("name").isString()) { QLOG_ERROR() << filename << "contains a library without a valid 'name' field"; return out; } out.removeLibs.append(libObj.value("name").toString()); } } isError = false; return out; } static std::shared_ptr createLibrary(const Library &lib) { std::shared_ptr out(new OneSixLibrary(lib.name)); if (!lib.url.isEmpty()) { out->setBaseUrl(lib.url); } out->setHint(lib.hint); if (!lib.absoluteUrl.isEmpty()) { out->setAbsoluteUrl(lib.absoluteUrl); } out->setAbsoluteUrl(lib.absoluteUrl); out->extract_excludes = lib.excludes; for (auto native : lib.natives) { out->addNative(native.first, native.second); } out->setRules(lib.rules); out->finalize(); return out; } int findLibrary(QList> haystack, const QString &needle) { for (int i = 0; i < haystack.size(); ++i) { if (QRegExp(needle, Qt::CaseSensitive, QRegExp::WildcardUnix) .indexIn(haystack.at(i)->rawName()) != -1) { return i; } } return -1; } void applyTo(OneSixVersion *version, bool &isError) { isError = true; if (!id.isNull()) { version->id = id; } if (!mainClass.isNull()) { version->mainClass = mainClass; } if (!processArguments.isNull()) { version->processArguments = processArguments; } if (!type.isNull()) { version->type = type; } if (!releaseTime.isNull()) { version->releaseTime = releaseTime; } if (!time.isNull()) { version->time = time; } if (!assets.isNull()) { version->assets = assets; } if (minimumLauncherVersion >= 0) { version->minimumLauncherVersion = minimumLauncherVersion; } if (!overwriteMinecraftArguments.isNull()) { 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); } if (shouldOverwriteLibs) { version->libraries.clear(); for (auto lib : overwriteLibs) { version->libraries.append(createLibrary(lib)); } } for (auto lib : addLibs) { switch (lib.insertType) { case Library::Apply: { int index = findLibrary(version->libraries, lib.name); if (index >= 0) { auto library = version->libraries[index]; if (!lib.url.isNull()) { library->setBaseUrl(lib.url); } if (!lib.hint.isNull()) { library->setHint(lib.hint); } if (!lib.absoluteUrl.isNull()) { library->setAbsoluteUrl(lib.absoluteUrl); } if (lib.applyExcludes) { library->extract_excludes = lib.excludes; } if (lib.applyNatives) { library->clearSuffixes(); for (auto native : lib.natives) { library->addNative(native.first, native.second); } } if (lib.applyRules) { library->setRules(lib.rules); } library->finalize(); } else { QLOG_WARN() << "Couldn't find" << lib.insertData << "(skipping)"; } break; } case Library::Append: version->libraries.append(createLibrary(lib)); break; case Library::Prepend: version->libraries.prepend(createLibrary(lib)); break; case Library::AppendIfNotExists: { int index = findLibrary(version->libraries, lib.name); if (index < 0) { version->libraries.append(createLibrary(lib)); } break; } case Library::PrependIfNotExists: { int index = findLibrary(version->libraries, lib.name); if (index < 0) { version->libraries.prepend(createLibrary(lib)); } break; } case Library::Replace: { int index = findLibrary(version->libraries, lib.insertData); if (index >= 0) { version->libraries.replace(index, createLibrary(lib)); } else { QLOG_WARN() << "Couldn't find" << lib.insertData << "(skipping)"; } break; } } } for (auto lib : removeLibs) { int index = findLibrary(version->libraries, lib); if (index >= 0) { version->libraries.removeAt(index); } else { QLOG_WARN() << "Couldn't find" << lib << "(skipping)"; } } OneSixVersion::VersionFile versionFile; versionFile.name = name; versionFile.id = fileId; versionFile.version = this->version; versionFile.mcVersion = mcVersion; versionFile.filename = filename; version->versionFiles.append(versionFile); isError = false; } }; OneSixVersionBuilder::OneSixVersionBuilder() { } bool OneSixVersionBuilder::build(OneSixVersion *version, OneSixInstance *instance, QWidget *widgetParent, const bool excludeCustom) { OneSixVersionBuilder builder; builder.m_version = version; builder.m_instance = instance; builder.m_widgetParent = widgetParent; return builder.build(excludeCustom); } bool OneSixVersionBuilder::read(OneSixVersion *version, const QJsonObject &obj) { OneSixVersionBuilder builder; builder.m_version = version; builder.m_instance = 0; builder.m_widgetParent = 0; return builder.read(obj); } bool OneSixVersionBuilder::build(const bool excludeCustom) { m_version->clear(); QDir root(m_instance->instanceRoot()); QDir patches(root.absoluteFilePath("patches/")); if (QFile::exists(root.absoluteFilePath("custom.json"))) { QLOG_INFO() << "Reading custom.json"; VersionFile file; if (!read(QFileInfo(root.absoluteFilePath("custom.json")), false, &file)) { return false; } file.name = "custom.json"; file.filename = "custom.json"; file.fileId = "org.multimc.custom.json"; file.version = QString(); bool isError = false; file.applyTo(m_version, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr( "Error while applying %1. Please check MultiMC-0.log for more info.") .arg(root.absoluteFilePath("custom.json"))); return false; } } else { // version.json -> patches/*.json -> user.json // version.json { QLOG_INFO() << "Reading version.json"; VersionFile file; if (!read(QFileInfo(root.absoluteFilePath("version.json")), false, &file)) { return false; } file.name = "version.json"; file.fileId = "org.multimc.version.json"; file.version = m_instance->intendedVersionId(); file.mcVersion = m_instance->intendedVersionId(); bool isError = false; file.applyTo(m_version, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr( "Error while applying %1. Please check MultiMC-0.log for more info.") .arg(root.absoluteFilePath("version.json"))); return false; } } // patches/ { // load all, put into map for ordering, apply in the right order QMap> files; for (auto info : patches.entryInfoList(QStringList() << "*.json", QDir::Files)) { QLOG_INFO() << "Reading" << info.fileName(); VersionFile file; if (!read(info, true, &file)) { return false; } files.insert(file.order, qMakePair(info.fileName(), file)); } for (auto order : files.keys()) { QLOG_DEBUG() << "Applying file with order" << order; auto filePair = files[order]; bool isError = false; filePair.second.applyTo(m_version, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr( "Error while applying %1. Please check MultiMC-0.log for more info.") .arg(filePair.first)); return false; } } } #if 0 // user.json if (!excludeCustom) { if (QFile::exists(root.absoluteFilePath("user.json"))) { QLOG_INFO() << "Reading user.json"; VersionFile file; if (!read(QFileInfo(root.absoluteFilePath("user.json")), false, &file)) { return false; } file.name = "user.json"; file.fileId = "org.multimc.user.json"; file.version = QString(); file.mcVersion = QString(); bool isError = false; file.applyTo(m_version, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr( "Error while applying %1. Please check MultiMC-0.log for more info.") .arg(root.absoluteFilePath("user.json"))); return false; } } } #endif } // some final touches { if (m_version->assets.isEmpty()) { m_version->assets = "legacy"; } if (m_version->minecraftArguments.isEmpty()) { QString toCompare = m_version->processArguments.toLower(); if (toCompare == "legacy") { m_version->minecraftArguments = " ${auth_player_name} ${auth_session}"; } else if (toCompare == "username_session") { m_version->minecraftArguments = "--username ${auth_player_name} --session ${auth_session}"; } else if (toCompare == "username_session_version") { m_version->minecraftArguments = "--username ${auth_player_name} " "--session ${auth_session} " "--version ${profile_name}"; } } } return true; } bool OneSixVersionBuilder::read(const QJsonObject &obj) { m_version->clear(); bool isError = false; VersionFile file = VersionFile::fromJson(QJsonDocument(obj), QString(), false, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr("Error while reading. Please check MultiMC-0.log for more info.")); return false; } file.applyTo(m_version, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr("Error while applying. Please check MultiMC-0.log for more info.")); return false; } return true; } bool OneSixVersionBuilder::read(const QFileInfo &fileInfo, const bool requireOrder, VersionFile *out) { QFile file(fileInfo.absoluteFilePath()); if (!file.open(QFile::ReadOnly)) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr("Unable to open %1: %2").arg(file.fileName(), file.errorString())); return false; } QJsonParseError error; QJsonDocument doc = QJsonDocument::fromJson(file.readAll(), &error); if (error.error != QJsonParseError::NoError) { QMessageBox::critical(m_widgetParent, QObject::tr("Error"), QObject::tr("Unable to parse %1: %2 at %3") .arg(file.fileName(), error.errorString()) .arg(error.offset)); return false; } bool isError = false; *out = VersionFile::fromJson(doc, file.fileName(), requireOrder, isError); if (isError) { QMessageBox::critical( m_widgetParent, QObject::tr("Error"), QObject::tr("Error while reading %1. Please check MultiMC-0.log for more info.") .arg(file.fileName())); ; } return true; }