/* Copyright (C) 2012 Sebastian Herbord. All rights reserved. This file is part of Mod Organizer. Mod Organizer is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Mod Organizer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Mod Organizer. If not, see . */ #include "settings.h" #include "serverinfo.h" #include "appconfig.h" #include #include #include using namespace MOBase; template T convertVariant(const QVariant& v); template <> QByteArray convertVariant(const QVariant& v) { return v.toByteArray(); } template <> QString convertVariant(const QVariant& v) { return v.toString(); } template <> int convertVariant(const QVariant& v) { return v.toInt(); } template <> bool convertVariant(const QVariant& v) { return v.toBool(); } template <> QSize convertVariant(const QVariant& v) { return v.toSize(); } template std::optional getOptional(const QSettings& s, const QString& name) { if (s.contains(name)) { return convertVariant(s.value(name)); } return {}; } Settings *Settings::s_Instance = nullptr; Settings::Settings(const QString& path) : m_Settings(path, QSettings::IniFormat), m_Geometry(m_Settings) { if (s_Instance != nullptr) { throw std::runtime_error("second instance of \"Settings\" created"); } else { s_Instance = this; } } Settings::~Settings() { s_Instance = nullptr; } Settings &Settings::instance() { if (s_Instance == nullptr) { throw std::runtime_error("no instance of \"Settings\""); } return *s_Instance; } QString Settings::getFilename() const { return m_Settings.fileName(); } void Settings::clearPlugins() { m_Plugins.clear(); m_PluginSettings.clear(); m_PluginBlacklist.clear(); int count = m_Settings.beginReadArray("pluginBlacklist"); for (int i = 0; i < count; ++i) { m_Settings.setArrayIndex(i); m_PluginBlacklist.insert(m_Settings.value("name").toString()); } m_Settings.endArray(); } bool Settings::pluginBlacklisted(const QString &fileName) const { return m_PluginBlacklist.contains(fileName); } void Settings::registerAsNXMHandler(bool force) { const auto nxmPath = QCoreApplication::applicationDirPath() + "/nxmhandler.exe"; const auto executable = QCoreApplication::applicationFilePath(); QString mode = force ? "forcereg" : "reg"; QString parameters = mode + " " + m_GamePlugin->gameShortName(); for (const QString& altGame : m_GamePlugin->validShortNames()) { parameters += "," + altGame; } parameters += " \"" + executable + "\""; if (!shell::Execute(nxmPath, parameters)) { QMessageBox::critical( nullptr, tr("Failed"), tr("Failed to start the helper application")); } } bool Settings::colorSeparatorScrollbar() const { return m_Settings.value("Settings/colorSeparatorScrollbars", true).toBool(); } void Settings::managedGameChanged(IPluginGame const *gamePlugin) { m_GamePlugin = gamePlugin; } void Settings::registerPlugin(IPlugin *plugin) { m_Plugins.push_back(plugin); m_PluginSettings.insert(plugin->name(), QVariantMap()); m_PluginDescriptions.insert(plugin->name(), QVariantMap()); for (const PluginSetting &setting : plugin->settings()) { QVariant temp = m_Settings.value("Plugins/" + plugin->name() + "/" + setting.key, setting.defaultValue); if (!temp.convert(setting.defaultValue.type())) { log::warn( "failed to interpret \"{}\" as correct type for \"{}\" in plugin \"{}\", using default", temp.toString(), setting.key, plugin->name()); temp = setting.defaultValue; } m_PluginSettings[plugin->name()][setting.key] = temp; m_PluginDescriptions[plugin->name()][setting.key] = QString("%1 (default: %2)").arg(setting.description).arg(setting.defaultValue.toString()); } } bool Settings::obfuscate(const QString key, const QString data) { QString finalKey("ModOrganizer2_" + key); wchar_t* keyData = new wchar_t[finalKey.size()+1]; finalKey.toWCharArray(keyData); keyData[finalKey.size()] = L'\0'; bool result = false; if (data.isEmpty()) { result = CredDeleteW(keyData, CRED_TYPE_GENERIC, 0); if (!result) if (GetLastError() == ERROR_NOT_FOUND) result = true; } else { wchar_t* charData = new wchar_t[data.size()]; data.toWCharArray(charData); CREDENTIALW cred = {}; cred.Flags = 0; cred.Type = CRED_TYPE_GENERIC; cred.TargetName = keyData; cred.CredentialBlob = (LPBYTE)charData; cred.CredentialBlobSize = sizeof(wchar_t) * data.size(); cred.Persist = CRED_PERSIST_LOCAL_MACHINE; result = CredWriteW(&cred, 0); delete[] charData; } delete[] keyData; return result; } QString Settings::deObfuscate(const QString key) { QString result; QString finalKey("ModOrganizer2_" + key); wchar_t* keyData = new wchar_t[finalKey.size()+1]; finalKey.toWCharArray(keyData); keyData[finalKey.size()] = L'\0'; PCREDENTIALW creds; if (CredReadW(keyData, 1, 0, &creds)) { wchar_t *charData = (wchar_t *)creds->CredentialBlob; result = QString::fromWCharArray(charData, creds->CredentialBlobSize / sizeof(wchar_t)); CredFree(creds); } else { const auto e = GetLastError(); if (e != ERROR_NOT_FOUND) { log::error("Retrieving encrypted data failed: {}", formatSystemMessage(e)); } } delete[] keyData; return result; } QColor Settings::getIdealTextColor(const QColor& rBackgroundColor) { if (rBackgroundColor.alpha() == 0) return QColor(Qt::black); const int THRESHOLD = 106 * 255.0f / rBackgroundColor.alpha(); int BackgroundDelta = (rBackgroundColor.red() * 0.299) + (rBackgroundColor.green() * 0.587) + (rBackgroundColor.blue() * 0.114); return QColor((255 - BackgroundDelta <= THRESHOLD) ? Qt::black : Qt::white); } bool Settings::hideUncheckedPlugins() const { return m_Settings.value("Settings/hide_unchecked_plugins", false).toBool(); } bool Settings::forceEnableCoreFiles() const { return m_Settings.value("Settings/force_enable_core_files", true).toBool(); } bool Settings::lockGUI() const { return m_Settings.value("Settings/lock_gui", true).toBool(); } bool Settings::automaticLoginEnabled() const { return m_Settings.value("Settings/nexus_login", false).toBool(); } QString Settings::getSteamAppID() const { return m_Settings.value("Settings/app_id", m_GamePlugin->steamAPPId()).toString(); } bool Settings::usePrereleases() const { return m_Settings.value("Settings/use_prereleases", false).toBool(); } void Settings::setDownloadSpeed(const QString &serverName, int bytesPerSecond) { m_Settings.beginGroup("Servers"); for (const QString &serverKey : m_Settings.childKeys()) { QVariantMap data = m_Settings.value(serverKey).toMap(); if (serverKey == serverName) { data["downloadCount"] = data["downloadCount"].toInt() + 1; data["downloadSpeed"] = data["downloadSpeed"].toDouble() + static_cast(bytesPerSecond); m_Settings.setValue(serverKey, data); } } m_Settings.endGroup(); m_Settings.sync(); } std::map Settings::getPreferredServers() { std::map result; m_Settings.beginGroup("Servers"); for (const QString &serverKey : m_Settings.childKeys()) { QVariantMap data = m_Settings.value(serverKey).toMap(); int preference = data["preferred"].toInt(); if (preference > 0) { result[serverKey] = preference; } } m_Settings.endGroup(); return result; } QString Settings::getConfigurablePath(const QString &key, const QString &def, bool resolve) const { QString result = QDir::fromNativeSeparators( m_Settings.value(QString("settings/") + key, QString("%BASE_DIR%/") + def) .toString()); if (resolve) { result.replace("%BASE_DIR%", getBaseDirectory()); } return result; } QString Settings::getBaseDirectory() const { return QDir::fromNativeSeparators(m_Settings.value( "settings/base_directory", qApp->property("dataPath").toString()).toString()); } QString Settings::getDownloadDirectory(bool resolve) const { return getConfigurablePath("download_directory", ToQString(AppConfig::downloadPath()), resolve); } QString Settings::getCacheDirectory(bool resolve) const { return getConfigurablePath("cache_directory", ToQString(AppConfig::cachePath()), resolve); } QString Settings::getModDirectory(bool resolve) const { return getConfigurablePath("mod_directory", ToQString(AppConfig::modsPath()), resolve); } std::optional Settings::getManagedGameDirectory() const { if (auto v=getOptional(m_Settings, "gamePath")) { return QString::fromUtf8(*v); } return {}; } void Settings::setManagedGameDirectory(const QString& path) { m_Settings.setValue("gamePath", QDir::toNativeSeparators(path).toUtf8()); } std::optional Settings::getManagedGameName() const { return getOptional(m_Settings, "gameName"); } void Settings::setManagedGameName(const QString& name) { m_Settings.setValue("gameName", name); } std::optional Settings::getManagedGameEdition() const { return getOptional(m_Settings, "game_edition"); } void Settings::setManagedGameEdition(const QString& name) { m_Settings.setValue("game_edition", name); } std::optional Settings::getSelectedProfileName() const { if (auto v=getOptional(m_Settings, "selected_profile")) { return QString::fromUtf8(*v); } return {}; } void Settings::setSelectedProfileName(const QString& name) { m_Settings.setValue("selected_profile", name.toUtf8()); } std::optional Settings::getStyleName() const { return getOptional(m_Settings, "Settings/style"); } void Settings::setStyleName(const QString& name) { m_Settings.setValue("Settings/style", name); } std::optional Settings::getSelectedExecutable() const { return getOptional(m_Settings, "selected_executable"); } std::optional Settings::getUseProxy() const { return getOptional(m_Settings, "Settings/use_proxy"); } QString Settings::getProfileDirectory(bool resolve) const { return getConfigurablePath("profiles_directory", ToQString(AppConfig::profilesPath()), resolve); } QString Settings::getOverwriteDirectory(bool resolve) const { return getConfigurablePath("overwrite_directory", ToQString(AppConfig::overwritePath()), resolve); } bool Settings::getNexusApiKey(QString &apiKey) const { QString tempKey = deObfuscate("APIKEY"); if (tempKey.isEmpty()) return false; apiKey = tempKey; return true; } bool Settings::setNexusApiKey(const QString& apiKey) { if (!obfuscate("APIKEY", apiKey)) { const auto e = GetLastError(); log::error("Storing API key failed: {}", formatSystemMessage(e)); return false; } return true; } bool Settings::clearNexusApiKey() { return setNexusApiKey(""); } bool Settings::hasNexusApiKey() const { return !deObfuscate("APIKEY").isEmpty(); } bool Settings::getSteamLogin(QString &username, QString &password) const { username = m_Settings.value("Settings/steam_username", "").toString(); password = deObfuscate("steam_password"); return !username.isEmpty() && !password.isEmpty(); } bool Settings::compactDownloads() const { return m_Settings.value("Settings/compact_downloads", false).toBool(); } bool Settings::metaDownloads() const { return m_Settings.value("Settings/meta_downloads", false).toBool(); } bool Settings::offlineMode() const { return m_Settings.value("Settings/offline_mode", false).toBool(); } log::Levels Settings::logLevel() const { return static_cast(m_Settings.value("Settings/log_level").toInt()); } void Settings::setLogLevel(log::Levels level) { m_Settings.setValue("Settings/log_level", static_cast(level)); } int Settings::crashDumpsType() const { return m_Settings.value("Settings/crash_dumps_type", static_cast(CrashDumpsType::Mini)).toInt(); } int Settings::crashDumpsMax() const { return m_Settings.value("Settings/crash_dumps_max", 5).toInt(); } QColor Settings::modlistOverwrittenLooseColor() const { return m_Settings.value("Settings/overwrittenLooseFilesColor", QColor(0, 255, 0, 64)).value(); } QColor Settings::modlistOverwritingLooseColor() const { return m_Settings.value("Settings/overwritingLooseFilesColor", QColor(255, 0, 0, 64)).value(); } QColor Settings::modlistOverwrittenArchiveColor() const { return m_Settings.value("Settings/overwrittenArchiveFilesColor", QColor(0, 255, 255, 64)).value(); } QColor Settings::modlistOverwritingArchiveColor() const { return m_Settings.value("Settings/overwritingArchiveFilesColor", QColor(255, 0, 255, 64)).value(); } QColor Settings::modlistContainsPluginColor() const { return m_Settings.value("Settings/containsPluginColor", QColor(0, 0, 255, 64)).value(); } QColor Settings::pluginListContainedColor() const { return m_Settings.value("Settings/containedColor", QColor(0, 0, 255, 64)).value(); } QString Settings::executablesBlacklist() const { return m_Settings.value("Settings/executable_blacklist", ( QStringList() << "Chrome.exe" << "Firefox.exe" << "TSVNCache.exe" << "TGitCache.exe" << "Steam.exe" << "GameOverlayUI.exe" << "Discord.exe" << "GalaxyClient.exe" << "Spotify.exe" ).join(";") ).toString(); } void Settings::setSteamLogin(QString username, QString password) { if (username == "") { m_Settings.remove("Settings/steam_username"); password = ""; } else { m_Settings.setValue("Settings/steam_username", username); } if (!obfuscate("steam_password", password)) { const auto e = GetLastError(); log::error("Storing or deleting password failed: {}", formatSystemMessage(e)); } } LoadMechanism::EMechanism Settings::getLoadMechanism() const { const auto i = m_Settings.value("Settings/load_mechanism").toInt(); switch (i) { case LoadMechanism::LOAD_MODORGANIZER: return LoadMechanism::LOAD_MODORGANIZER; default: qCritical().nospace().noquote() << "invalid load mechanism " << i << ", reverting to modorganizer"; m_Settings.setValue("Settings/load_mechanism", LoadMechanism::LOAD_MODORGANIZER); return LoadMechanism::LOAD_MODORGANIZER; } } void Settings::setupLoadMechanism() { m_LoadMechanism.activate(getLoadMechanism()); } bool Settings::useProxy() const { return m_Settings.value("Settings/use_proxy", false).toBool(); } bool Settings::endorsementIntegration() const { return m_Settings.value("Settings/endorsement_integration", true).toBool(); } bool Settings::hideAPICounter() const { return m_Settings.value("Settings/hide_api_counter", false).toBool(); } bool Settings::displayForeign() const { return m_Settings.value("Settings/display_foreign", true).toBool(); } void Settings::setMotDHash(uint hash) { m_Settings.setValue("motd_hash", hash); } uint Settings::getMotDHash() const { return m_Settings.value("motd_hash", 0).toUInt(); } bool Settings::archiveParsing() const { return m_Settings.value("Settings/archive_parsing_experimental", false).toBool(); } QVariant Settings::pluginSetting(const QString &pluginName, const QString &key) const { auto iterPlugin = m_PluginSettings.find(pluginName); if (iterPlugin == m_PluginSettings.end()) { return QVariant(); } auto iterSetting = iterPlugin->find(key); if (iterSetting == iterPlugin->end()) { return QVariant(); } return *iterSetting; } void Settings::setPluginSetting(const QString &pluginName, const QString &key, const QVariant &value) { auto iterPlugin = m_PluginSettings.find(pluginName); if (iterPlugin == m_PluginSettings.end()) { throw MyException(tr("attempt to store setting for unknown plugin \"%1\"").arg(pluginName)); } // store the new setting both in memory and in the ini m_PluginSettings[pluginName][key] = value; m_Settings.setValue("Plugins/" + pluginName + "/" + key, value); } QVariant Settings::pluginPersistent(const QString &pluginName, const QString &key, const QVariant &def) const { if (!m_PluginSettings.contains(pluginName)) { return def; } return m_Settings.value("PluginPersistance/" + pluginName + "/" + key, def); } void Settings::setPluginPersistent(const QString &pluginName, const QString &key, const QVariant &value, bool sync) { if (!m_PluginSettings.contains(pluginName)) { throw MyException(tr("attempt to store setting for unknown plugin \"%1\"").arg(pluginName)); } m_Settings.setValue("PluginPersistance/" + pluginName + "/" + key, value); if (sync) { m_Settings.sync(); } } QString Settings::language() { QString result = m_Settings.value("Settings/language", "").toString(); if (result.isEmpty()) { QStringList languagePreferences = QLocale::system().uiLanguages(); if (languagePreferences.length() > 0) { // the users most favoritest language result = languagePreferences.at(0); } else { // fallback system locale result = QLocale::system().name(); } } return result; } void Settings::updateServers(const QList &servers) { m_Settings.beginGroup("Servers"); QStringList oldServerKeys = m_Settings.childKeys(); for (const ServerInfo &server : servers) { if (!oldServerKeys.contains(server.name)) { // not yet known server QVariantMap newVal; newVal["premium"] = server.premium; newVal["preferred"] = server.preferred ? 1 : 0; newVal["lastSeen"] = server.lastSeen; newVal["downloadCount"] = 0; newVal["downloadSpeed"] = 0.0; m_Settings.setValue(server.name, newVal); } else { QVariantMap data = m_Settings.value(server.name).toMap(); data["lastSeen"] = server.lastSeen; data["premium"] = server.premium; m_Settings.setValue(server.name, data); } } // clean up unavailable servers QDate now = QDate::currentDate(); for (const QString &key : m_Settings.childKeys()) { QVariantMap val = m_Settings.value(key).toMap(); QDate lastSeen = val["lastSeen"].toDate(); if (lastSeen.daysTo(now) > 30) { log::debug("removing server {} since it hasn't been available for downloads in over a month", key); m_Settings.remove(key); } } m_Settings.endGroup(); m_Settings.sync(); } void Settings::addBlacklistPlugin(const QString &fileName) { m_PluginBlacklist.insert(fileName); writePluginBlacklist(); } void Settings::writePluginBlacklist() { m_Settings.remove("pluginBlacklist"); m_Settings.beginWriteArray("pluginBlacklist"); int idx = 0; for (const QString &plugin : m_PluginBlacklist) { m_Settings.setArrayIndex(idx++); m_Settings.setValue("name", plugin); } m_Settings.endArray(); } GeometrySettings& Settings::geometry() { return m_Geometry; } const GeometrySettings& Settings::geometry() const { return m_Geometry; } QSettings::Status Settings::sync() const { m_Settings.sync(); return m_Settings.status(); } void Settings::dump() const { static const QStringList ignore({ "username", "password", "nexus_api_key" }); log::debug("settings:"); m_Settings.beginGroup("Settings"); for (auto k : m_Settings.allKeys()) { if (ignore.contains(k, Qt::CaseInsensitive)) { continue; } log::debug(" . {}={}", k, m_Settings.value(k).toString()); } m_Settings.endGroup(); } GeometrySettings::GeometrySettings(QSettings& s) : m_Settings(s) { } std::optional GeometrySettings::getMainWindow() const { return getOptional(m_Settings, "window_geometry"); } std::optional GeometrySettings::getMainWindowState() const { return getOptional(m_Settings, "window_state"); } std::optional GeometrySettings::getToolbarSize() const { return getOptional(m_Settings, "toolbar_size"); } std::optional GeometrySettings::getToolbarButtonStyle() const { if (auto v=getOptional(m_Settings, "toolbar_button_style")) { return static_cast(*v); } return {}; } std::optional GeometrySettings::getMenubarVisible() const { return getOptional(m_Settings, "menubar_visible"); } std::optional GeometrySettings::getStatusbarVisible() const { return getOptional(m_Settings, "statusbar_visible"); } std::optional GeometrySettings::getMainSplitterState() const { return getOptional(m_Settings, "window_split"); } std::optional GeometrySettings::getFiltersVisible() const { return getOptional(m_Settings, "filters_visible"); } std::optional GeometrySettings::getMainWindowMonitor() const { return getOptional(m_Settings, "window_monitor"); } void GeometrySettings::setDockSize(const QString& name, int size) { m_Settings.setValue("geometry/" + name + "_size", size); } std::optional GeometrySettings::getDockSize(const QString& name) const { return getOptional(m_Settings, "geometry/" + name + "_size"); } std::optional GeometrySettings::isCategoryListVisible() const { return getOptional(m_Settings, "categorylist_visible"); }