diff --git a/apps/components_tests/config/testlaunchersettings.cpp b/apps/components_tests/config/testlaunchersettings.cpp index 617b3015a5..be919b3010 100644 --- a/apps/components_tests/config/testlaunchersettings.cpp +++ b/apps/components_tests/config/testlaunchersettings.cpp @@ -7,10 +7,18 @@ namespace { - void read(Config::LauncherSettings& settings, QString text) + void read(Config::LauncherSettings& settings, QString text, bool missingOnly = false) { QTextStream stream(&text); - settings.readFile(stream); + settings.readFile(stream, missingOnly); + } + + Config::LauncherSettings restore(const QString& main, const QString& backup) + { + Config::LauncherSettings settings; + read(settings, main); + read(settings, backup, true); + return settings; } Config::LauncherSettings parse(const QString& text) @@ -63,6 +71,7 @@ thing=5 EXPECT_EQ(write(settings).toStdString(), R"( [Settings] language=en +watchdog=true future=1 [Profiles] @@ -149,7 +158,7 @@ thing=5 EXPECT_TRUE(write(settings).contains("Default/future=one\nDefault/future=two\nDefault/future=three\n")); } - TEST(LauncherSettingsTest, ContentOrderSurvivesAWriteAndRead) + TEST(LauncherSettingsTest, contentOrderSurvivesAWriteAndRead) { Config::LauncherSettings settings; settings.setContentList("Default", { "/games/morrowind/Data Files" }, { "Morrowind.bsa" }, @@ -162,7 +171,7 @@ thing=5 EXPECT_EQ(reread.getContentListFiles("Default"), QStringList({ "Morrowind.esm", "Tribunal.esm" })); } - TEST(LauncherSettingsTest, ALauncherConfigWrittenBeforeTheOrderKeyStillLoads) + TEST(LauncherSettingsTest, launcherConfigWrittenBeforeTheOrderKeyStillLoads) { const Config::LauncherSettings settings = parse(QString::fromUtf8(sConfig)); @@ -171,7 +180,7 @@ thing=5 EXPECT_TRUE(settings.getUserFilesInOrder("Default").isEmpty()); } - TEST(LauncherSettingsTest, TheOrderKeyDoesNotLeakIntoTheOtherProfileLists) + TEST(LauncherSettingsTest, orderKeyDoesNotLeakIntoTheOtherProfileLists) { const Config::LauncherSettings settings = parse(QString::fromUtf8(sConfig) + "Default/order=Morrowind.esm\n" @@ -184,4 +193,52 @@ thing=5 EXPECT_EQ(settings.getDataDirectoryList("Default"), QStringList({ "/games/morrowind/Data Files" })); EXPECT_EQ(settings.getArchiveList("Default"), QStringList({ "Morrowind.bsa" })); } + + TEST(LauncherSettingsTest, watchdogRestoreShouldAddMissingKeysAndMaintainFileOrder) + { + const QString current = QString::fromUtf8(sConfig); + const QString backup = QString::fromUtf8(sConfig) + + "Default/order=Morrowind.esm\n" + "Default/order=SomethingDisabled.esp\n" + "Default/order=Tribunal.esm\n"; + + const Config::LauncherSettings settings = restore(current, backup); + + EXPECT_EQ(settings.getUserFilesInOrder("Default"), + QStringList({ "Morrowind.esm", "SomethingDisabled.esp", "Tribunal.esm" })); + EXPECT_EQ(settings.getContentListFiles("Default"), QStringList({ "Morrowind.esm", "Tribunal.esm" })); + } + + TEST(LauncherSettingsTest, watchdogRestoreShouldMaintainExistingKeyValues) + { + const QString current = QString::fromUtf8(sConfig) + + "Default/order=Morrowind.esm\n" + "Default/order=SomethingDisabled.esp\n" + "Default/order=Tribunal.esm\n"; + const QString backup = QString::fromUtf8(sConfig) + + "Default/order=SomethingDisabled.esp\n" + "Default/order=Morrowind.esm\n" + "Default/order=Tribunal.esm\n"; + + const Config::LauncherSettings settings = restore(current, backup); + + EXPECT_EQ(settings.getCurrentContentListName(), "Default"); + EXPECT_EQ(settings.getUserFilesInOrder("Default"), + QStringList({ "Morrowind.esm", "SomethingDisabled.esp", "Tribunal.esm" })); + } + + TEST(LauncherSettingsTest, watchdogShouldBeUnsetByDefault) + { + const Config::LauncherSettings settings = parse(QString::fromUtf8(sConfig)); + + EXPECT_FALSE(settings.getWatchdog()); + } + + TEST(LauncherSettingsTest, watchdogShouldBeSetOnSuccessfulWrite) + { + const QString written = write(parse("[Settings]\nlanguage=English\n")); + + EXPECT_EQ(written.count("watchdog="), 1); + EXPECT_TRUE(written.contains("watchdog=true\n")); + } } diff --git a/apps/launcher/maindialog.cpp b/apps/launcher/maindialog.cpp index 63612f061e..08f660085f 100644 --- a/apps/launcher/maindialog.cpp +++ b/apps/launcher/maindialog.cpp @@ -314,18 +314,19 @@ bool Launcher::MainDialog::setupLauncherSettings() { mLauncherSettings.clear(); + // Launcher settings const QString path = Files::pathToQString(mCfgMgr.getUserConfigPath() / Config::LauncherSettings::sLauncherConfigFileName); if (!QFile::exists(path)) return true; - Log(Debug::Info) << "Loading config file: " << path.toUtf8().constData(); + Log(Debug::Info) << "Loading Launcher config file: " << path.toUtf8().constData(); QFile file(path); if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) { - cfgError(tr("Error opening OpenMW configuration file"), + cfgError(tr("Error opening Launcher configuration file"), tr("
Could not open %0 for reading:

%1

" "Please make sure you have the right permissions " "and try again.
") @@ -338,6 +339,35 @@ bool Launcher::MainDialog::setupLauncherSettings() Misc::ensureUtf8Encoding(stream); mLauncherSettings.readFile(stream); + file.close(); + + // Launcher settings backup + file.setFileName( + Files::pathToQString(mCfgMgr.getUserConfigPath() / Config::LauncherSettings::sLauncherConfigBackupFileName)); + + // Read from the backup only if the watchdog is unset and the backup exists + if (mLauncherSettings.getWatchdog() || !file.exists()) + return true; + + Log(Debug::Warning) << "Watchdog unset. Restoring missing keys from Launcher config backup file: " + << file.fileName().toUtf8().constData(); + + if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) + { + cfgError(tr("Error opening Launcher configuration backup file"), + tr("
Could not open %0 for reading:

%1

" + "Please make sure you have the right permissions " + "and try again.
") + .arg(file.fileName().toHtmlEscaped()) + .arg(file.errorString().toHtmlEscaped())); + return true; + } + + QTextStream backupStream(&file); + Misc::ensureUtf8Encoding(backupStream); + + mLauncherSettings.readFile(backupStream, true); // Restore missing settings + file.close(); return true; } @@ -543,12 +573,34 @@ bool Launcher::MainDialog::writeSettings() } QTextStream stream(&file); - stream.setDevice(&file); Misc::ensureUtf8Encoding(stream); mLauncherSettings.writeFile(stream); file.close(); + // Launcher settings backup + file.setFileName(Files::pathToQString(userPath / Config::LauncherSettings::sLauncherConfigBackupFileName)); + + if (!file.open(QIODevice::ReadWrite | QIODevice::Text | QIODevice::Truncate)) + { + // File cannot be opened or created + cfgError(tr("Error writing Launcher configuration backup file"), + tr("
Could not open or create %0 for writing

" + "Please make sure you have the right permissions " + "and try again.
") + .arg(file.fileName().toHtmlEscaped())); + return false; + } + + QTextStream backupStream(&file); + Misc::ensureUtf8Encoding(backupStream); + + backupStream << "# Backup file written automatically by the OpenMW launcher. Do not edit or rename.\n" + "# Your settings are located in launcher.cfg\n"; + + mLauncherSettings.writeFile(backupStream); + file.close(); + return true; } diff --git a/components/config/launchersettings.cpp b/components/config/launchersettings.cpp index 8b510d6e30..d1831e07e6 100644 --- a/components/config/launchersettings.cpp +++ b/components/config/launchersettings.cpp @@ -34,6 +34,7 @@ namespace Config constexpr char sMainWindowHeightKey[] = "MainWindow/height"; constexpr char sMainWindowPosXKey[] = "MainWindow/posx"; constexpr char sMainWindowPosYKey[] = "MainWindow/posy"; + constexpr char sWatchdogKey[] = "watchdog"; QString makeNewContentListName() { @@ -122,6 +123,8 @@ namespace Config settings.mLanguage = value; return true; } + if (key == sWatchdogKey) + return parseBool(value, settings.mWatchdog); settings.mUnknown.emplaceBack(key, value); return true; @@ -210,6 +213,7 @@ namespace Config { writeSectionHeader(sSettingsSection, stream); writeKeyValue(sLanguageKey, value.mLanguage, stream); + writeKeyValue(sWatchdogKey, true, stream); // Set so future reads check for dropped launcher settings writeUnknownKeys(value.mUnknown, stream); } @@ -411,11 +415,13 @@ bool Config::LauncherSettings::setValue(const QString& sectionPrefix, const QStr return true; } -void Config::LauncherSettings::readFile(QTextStream& stream) +void Config::LauncherSettings::readFile(QTextStream& stream, bool missingOnly) { const QRegularExpression sectionRe("^\\[([^]]+)\\]$"); const QRegularExpression keyRe("^([^=]+)\\s*=\\s*(.+)$"); + QSet readKeys; + QString section; while (!stream.atEnd()) @@ -442,11 +448,18 @@ void Config::LauncherSettings::readFile(QTextStream& stream) const QString key = keyMatch.captured(1).trimmed(); const QString value = keyMatch.captured(2).trimmed(); + const QString id = "[" + section + "]." + key; + if (missingOnly && mReadKeys.contains(id)) + continue; + if (!setValue(section, key, value)) Log(Debug::Warning) << "Invalid value in the launcher config file: section: " << section.toUtf8().constData() << " key: " << key.toUtf8().constData() << " value: " << value.toUtf8().constData(); + else + readKeys.insert(id); } + mReadKeys.unite(readKeys); } const Config::LauncherSettings::Profile* Config::LauncherSettings::findProfile(const QString& name) const @@ -463,5 +476,6 @@ void Config::LauncherSettings::clear() mGeneral = General{}; mProfiles = Profiles{}; mImporter = Importer{}; + mReadKeys.clear(); mUnknownSections.clear(); } diff --git a/components/config/launchersettings.hpp b/components/config/launchersettings.hpp index 28b248698d..8d16f9fd81 100644 --- a/components/config/launchersettings.hpp +++ b/components/config/launchersettings.hpp @@ -4,6 +4,7 @@ #include #include #include +#include #include #include @@ -19,6 +20,7 @@ namespace Config { public: static constexpr char sLauncherConfigFileName[] = "launcher.cfg"; + static constexpr char sLauncherConfigBackupFileName[] = "launcher-wd.dat"; /// Keys of a section this version does not use, in file order, written back as read using UnknownKeys = QList>; @@ -26,6 +28,7 @@ namespace Config struct Settings { QString mLanguage; + bool mWatchdog = false; UnknownKeys mUnknown; }; @@ -66,7 +69,7 @@ namespace Config UnknownKeys mUnknown; }; - void readFile(QTextStream& stream); + void readFile(QTextStream& stream, bool missingOnly = false); void clear(); @@ -101,6 +104,8 @@ namespace Config void setLanguage(const QString& value) { mSettings.mLanguage = value; } + bool getWatchdog() const { return mSettings.mWatchdog; } + MainWindow getMainWindow() const { return mGeneral.mMainWindow; } void setMainWindow(const MainWindow& value) { mGeneral.mMainWindow = value; } @@ -118,6 +123,7 @@ namespace Config Profiles mProfiles; General mGeneral; Importer mImporter; + QSet mReadKeys; /// Sections this version does not know at all, in name order, written back as read QMap mUnknownSections; diff --git a/files/lang/launcher_bg.ts b/files/lang/launcher_bg.ts index 514c454450..4e4f49627c 100644 --- a/files/lang/launcher_bg.ts +++ b/files/lang/launcher_bg.ts @@ -569,6 +569,18 @@ to default Morrowind fonts. Check this box if you still prefer original fonts ov <br><b>You do not have a game file selected.</b><br><br>OpenMW will not start without a game file selected.<br> <br><b>Не сте избрали файл на играта.</b><br><br>OpenMW няма да стартира без избран файл на играта.<br> + + Error writing Launcher configuration backup file + Грешка при записване на резервното копие на конфигурационния файл на стартиращата програма + + + Error opening Launcher configuration file + Грешка при отваряне на конфигурационния файл на стартиращата програма + + + Error opening Launcher configuration backup file + Грешка при отваряне на резервното копие на конфигурационния файл на стартиращата програма + Launcher::SettingsPage diff --git a/files/lang/launcher_de.ts b/files/lang/launcher_de.ts index bccf216a88..ccedf760f2 100644 --- a/files/lang/launcher_de.ts +++ b/files/lang/launcher_de.ts @@ -567,6 +567,18 @@ to default Morrowind fonts. Check this box if you still prefer original fonts ov <br><b>Could not create directory %0</b><br><br>%1<br> + + Error opening Launcher configuration file + + + + Error opening Launcher configuration backup file + + + + Error writing Launcher configuration backup file + + Launcher::SettingsPage diff --git a/files/lang/launcher_en.ts b/files/lang/launcher_en.ts index 933cf35853..76808578e0 100644 --- a/files/lang/launcher_en.ts +++ b/files/lang/launcher_en.ts @@ -567,6 +567,18 @@ to default Morrowind fonts. Check this box if you still prefer original fonts ov <br><b>You do not have a game file selected.</b><br><br>OpenMW will not start without a game file selected.<br> + + Error writing Launcher configuration backup file + + + + Error opening Launcher configuration file + + + + Error opening Launcher configuration backup file + + Launcher::SettingsPage diff --git a/files/lang/launcher_fr.ts b/files/lang/launcher_fr.ts index def0448d6c..1801af7a89 100644 --- a/files/lang/launcher_fr.ts +++ b/files/lang/launcher_fr.ts @@ -567,6 +567,18 @@ to default Morrowind fonts. Check this box if you still prefer original fonts ov <br><b>Could not create directory %0</b><br><br>%1<br> <br><b>Impossible de créer le dossier %0</b><br><br>%1<br> + + Error writing Launcher configuration backup file + Erreur lors de l'écriture du fichier de sauvegarde des paramètres du Lanceur + + + Error opening Launcher configuration file + Erreur lors de l'ouverture du fichier de paramètres du Lanceur + + + Error opening Launcher configuration backup file + Erreur lors de l'ouverture du fichier de sauvegarde des paramètres du Lanceur + Launcher::SettingsPage diff --git a/files/lang/launcher_pl.ts b/files/lang/launcher_pl.ts index 78cc00ccda..3cdc32b1c0 100644 --- a/files/lang/launcher_pl.ts +++ b/files/lang/launcher_pl.ts @@ -561,7 +561,7 @@ do domyślnych czcionek Morrowind. Zaznacz to pole, jeśli nadal wolisz oryginal Error writing Launcher configuration file - Błąd zapisu pliku konfiguracyjnego programu uruchamiącego + Błąd zapisu pliku konfiguracyjnego programu uruchamiającego No game file selected @@ -571,6 +571,18 @@ do domyślnych czcionek Morrowind. Zaznacz to pole, jeśli nadal wolisz oryginal <br><b>You do not have a game file selected.</b><br><br>OpenMW will not start without a game file selected.<br> <br><b>Nie wybrano pliku gry.</b><br><br>OpenMW nie uruchomi się bez wybranego pliku gry.<br> + + Error writing Launcher configuration backup file + Błąd zapisu kopii zapasowej pliku konfiguracyjnego programu uruchamiającego + + + Error opening Launcher configuration file + Wystąpił błąd podczas otwierania pliku konfiguracyjnego programu uruchamiającego + + + Error opening Launcher configuration backup file + Wystąpił błąd podczas otwierania kopii zapasowej pliku konfiguracyjnego programu uruchamiającego + Launcher::SettingsPage diff --git a/files/lang/launcher_ru.ts b/files/lang/launcher_ru.ts index 23290e9592..cb0a4014f4 100644 --- a/files/lang/launcher_ru.ts +++ b/files/lang/launcher_ru.ts @@ -569,6 +569,18 @@ to default Morrowind fonts. Check this box if you still prefer original fonts ov <br><b>Could not create directory %0</b><br><br>%1<br> <br><b>Не удалось создать директорию %0</b><br><br>%1<br> + + Error writing Launcher configuration backup file + Не удалось сохранить данные в резервную копию файла с настройками лаунчера + + + Error opening Launcher configuration file + Не удалось открыть файл с настройками лаунчера + + + Error opening Launcher configuration backup file + Не удалось открыть резервную копию файла с настройками лаунчера + Launcher::SettingsPage diff --git a/files/lang/launcher_sv.ts b/files/lang/launcher_sv.ts index c8181b0c01..dcecc246ba 100644 --- a/files/lang/launcher_sv.ts +++ b/files/lang/launcher_sv.ts @@ -570,6 +570,18 @@ de ordinarie fonterna i Morrowind. Bocka denna ruta om du ändå föredrar ordin <br><b>Could not create directory %0</b><br><br>%1<br> <br><b>Kunde inte skapa katalog %0</b><br><br>%1<br> + + Error writing Launcher configuration backup file + Fel när säkerhetskopia av Startarens-konfigurationsfil skulle skrivas + + + Error opening Launcher configuration file + Fel när Startarens-konfigurationsfil skulle öppnas + + + Error opening Launcher configuration backup file + Fel när säkerhetskopia av Startarens-konfigurationsfil skulle öppnas + Launcher::SettingsPage