mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-11-05 09:33:25 -08:00
[Installer][Client] Fix review findings: subdir backup, portable warning, backup API
NSIS: - Back up unknown top-level install subdirs (e.g. <installdir>\decks), not just loose deck files, so the 3.1.1 -> new upgrade no longer loses data folders the old RMDir /r deletes before the client ever runs. Payload dirs (plugins/translations/sounds/themes) stay in place to avoid restoring stale DLLs; restore + relocate handle the new backup set and the one-time notice covers both decks and folders. - Restart the %TEMP% backup when the 32/64-bit passes point at different dirs instead of merging (which restored one dir's files into the other); document that only the last pass relocates and the %TEMP% copy is not a durable second copy. Client: - Drop the portable at-risk warning: portable installs never shipped an uninstaller and portable updates preserve data/, so every portable user got a spurious dialog plus daily host-machine copies. - AtRiskDataWarning is now a plain class with Q_DECLARE_TR_FUNCTIONS instead of QObject+Q_OBJECT; logging category renamed to at_risk_data_warning; MainWindow wrapper inlined into startupConfigCheck. - Lower the synchronous startup backup cap 500 -> 200 MB. Utility/tests: - Remove test-only backupAtRiskPath()/findRecentBackupSession() and the no-marker/no-manifest legacy paths; isBackupSessionComplete() now requires the complete marker; tests updated to the plural API.
This commit is contained in:
Lukas Brübach
parent
202c0d6561
commit
a23e02b5a4
8 changed files with 229 additions and 345 deletions
|
|
@ -12,7 +12,7 @@
|
|||
#include <libcockatrice/settings/paths_settings.h>
|
||||
#include <libcockatrice/utility/user_data_backup.h>
|
||||
|
||||
inline Q_LOGGING_CATEGORY(AtRiskDataWarningLog, "main_window");
|
||||
Q_LOGGING_CATEGORY(AtRiskDataWarningLog, "at_risk_data_warning");
|
||||
|
||||
static bool isDeckFileSuffix(const QString &suffix)
|
||||
{
|
||||
|
|
@ -30,22 +30,6 @@ static bool isInsideAnyDir(const QString &path, const QStringList &bases)
|
|||
return false;
|
||||
}
|
||||
|
||||
// Merges an at-risk offender into the backup source list: offenders already covered by a
|
||||
// collected source are skipped, while an offender that is a parent of collected sources
|
||||
// supersedes them.
|
||||
static void mergeCoveringSource(QStringList &sources, const QString &offender)
|
||||
{
|
||||
if (isInsideAnyDir(offender, sources)) {
|
||||
return;
|
||||
}
|
||||
for (int i = sources.size() - 1; i >= 0; --i) {
|
||||
if (PathsSettings::isInsideDir(sources.at(i), offender)) {
|
||||
sources.removeAt(i);
|
||||
}
|
||||
}
|
||||
sources.append(offender);
|
||||
}
|
||||
|
||||
static bool hasLooseDeckFile(const QStringList &offenders)
|
||||
{
|
||||
for (const QString &offender : offenders) {
|
||||
|
|
@ -65,125 +49,6 @@ static QString resolveBackupRoot(const QString &appDir)
|
|||
return backupRoot;
|
||||
}
|
||||
|
||||
// True when a portable offender must stay out of the safety backup: replays (size),
|
||||
// downloaded pictures (large and re-downloadable - everything under pics/ except the
|
||||
// seeded CUSTOM dir) and the regenerable redirect/cache dir.
|
||||
static bool isPortableBackupExcluded(const QString &offender)
|
||||
{
|
||||
auto &paths = SettingsCache::instance().paths();
|
||||
const QString replaysPath = QDir::cleanPath(paths.getReplaysPath());
|
||||
const QString picsPath = QDir::cleanPath(paths.getPicsPath());
|
||||
const QString customPicsPath = QDir::cleanPath(paths.getCustomPicsPath());
|
||||
const QString redirectsPath = QDir::cleanPath(paths.getRedirectCachePath());
|
||||
const QString cacheDir = QDir::cleanPath(SettingsCache::instance().getCachePath());
|
||||
|
||||
if (!replaysPath.isEmpty() && PathsSettings::isInsideDir(offender, replaysPath)) {
|
||||
return true;
|
||||
}
|
||||
if (!picsPath.isEmpty() && PathsSettings::isInsideDir(offender, picsPath) &&
|
||||
(customPicsPath.isEmpty() || !PathsSettings::isInsideDir(offender, customPicsPath))) {
|
||||
return true;
|
||||
}
|
||||
if (!redirectsPath.isEmpty() && PathsSettings::isInsideDir(offender, redirectsPath)) {
|
||||
return true;
|
||||
}
|
||||
if (!cacheDir.isEmpty() && PathsSettings::isInsideDir(offender, cacheDir)) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
AtRiskDataWarning::AtRiskPaths AtRiskDataWarning::collectPortableAtRiskPaths(const QString &appDir)
|
||||
{
|
||||
auto &paths = SettingsCache::instance().paths();
|
||||
AtRiskPaths atRisk;
|
||||
|
||||
// Portable data lives inside the install directory by design, so there is
|
||||
// nothing to reconfigure. Back up the small irreplaceable data instead.
|
||||
// Downloaded pictures are deliberately excluded: they are large and can
|
||||
// always be re-downloaded (the installer's pre-uninstall backup drops
|
||||
// them for the same reason). Replays are excluded here for size; the
|
||||
// installer backup covers them during installer-driven upgrades, but a
|
||||
// manual run of the old uninstall.exe is not covered - hence the note
|
||||
// in the warning text below.
|
||||
const QString dataDir = SettingsCache::instance().getDataPath();
|
||||
for (const QString &sub :
|
||||
QStringList{QStringLiteral("decks"), QStringLiteral("customsets"), QStringLiteral("settings"),
|
||||
QStringLiteral("filters"), QStringLiteral("themes"), QStringLiteral("sounds"),
|
||||
QStringLiteral("pics/CUSTOM")}) {
|
||||
const QString candidate = QDir::cleanPath(QDir(dataDir).absoluteFilePath(sub));
|
||||
if (QFileInfo::exists(candidate)) {
|
||||
atRisk.sourcesToBackUp.append(candidate);
|
||||
}
|
||||
}
|
||||
|
||||
// Card database files live in dataDir by default but are not in the list above. Seed them
|
||||
// explicitly so they do not depend on the offender merge below to be backed up.
|
||||
for (const QString &dbFile :
|
||||
QStringList{paths.getCardDatabasePath(), paths.getTokenDatabasePath(), paths.getSpoilerCardDatabasePath()}) {
|
||||
if (dbFile.isEmpty()) {
|
||||
continue;
|
||||
}
|
||||
const QString cleanedDbFile = QDir::cleanPath(dbFile);
|
||||
if (!QFileInfo::exists(cleanedDbFile) || !PathsSettings::isInsideDir(cleanedDbFile, appDir)) {
|
||||
continue;
|
||||
}
|
||||
// isInsideDir is equality-aware and case-insensitive on Windows/macOS,
|
||||
// so it also covers exact duplicates with different casing or separators.
|
||||
if (!isInsideAnyDir(cleanedDbFile, atRisk.sourcesToBackUp)) {
|
||||
atRisk.sourcesToBackUp.append(cleanedDbFile);
|
||||
}
|
||||
}
|
||||
|
||||
// A portable user may also have pointed a custom path inside the install
|
||||
// dir. Offenders outside data/ (e.g. appDir/mydecks) would be wiped by the
|
||||
// old uninstaller but are not in the hardcoded list above - and neither
|
||||
// is a custom folder inside data/ itself (e.g. dataDir/mydecks), which the
|
||||
// old uninstaller deletes all the same. Cover any offender that is not
|
||||
// already inside a backed-up source; when an offender is a parent of
|
||||
// already-collected sources it supersedes them.
|
||||
for (const QString &offender : paths.pathsInsideDir(appDir)) {
|
||||
if (!QFileInfo::exists(offender)) {
|
||||
continue;
|
||||
}
|
||||
const QString cleanedOffender = QDir::cleanPath(offender);
|
||||
if (isPortableBackupExcluded(cleanedOffender)) {
|
||||
continue;
|
||||
}
|
||||
mergeCoveringSource(atRisk.sourcesToBackUp, cleanedOffender);
|
||||
}
|
||||
|
||||
// A fresh portable install has no data on disk yet, but the user still
|
||||
// needs to know their data will live where the 3.1.0/3.1.1 uninstaller
|
||||
// deletes it - so fall through to the warning with an empty backup
|
||||
// instead of returning silently.
|
||||
if (atRisk.sourcesToBackUp.isEmpty()) {
|
||||
qCInfo(AtRiskDataWarningLog) << "Portable install with no existing data files, warning without backup";
|
||||
}
|
||||
return atRisk;
|
||||
}
|
||||
|
||||
QStringList AtRiskDataWarning::collectInstalledAtRiskPaths(const QString &appDir)
|
||||
{
|
||||
QStringList offenders = SettingsCache::instance().paths().pathsInsideDir(appDir);
|
||||
|
||||
// Loose decks sitting directly in the program folder are wiped by the old uninstaller
|
||||
// just like configured paths. Mirror the installer backup set (DeckLoader extensions
|
||||
// minus *.txt) so a manual run of the old uninstall.exe is covered too.
|
||||
const QDir appDirHandle(appDir);
|
||||
const QStringList topLevelFiles = appDirHandle.entryList(QDir::Files | QDir::Hidden | QDir::NoDotAndDotDot);
|
||||
for (const QString &fileName : topLevelFiles) {
|
||||
if (!isDeckFileSuffix(QFileInfo(fileName).suffix().toLower())) {
|
||||
continue;
|
||||
}
|
||||
const QString looseDeck = QDir::cleanPath(appDirHandle.absoluteFilePath(fileName));
|
||||
if (!isInsideAnyDir(looseDeck, offenders)) {
|
||||
offenders.append(looseDeck);
|
||||
}
|
||||
}
|
||||
return offenders;
|
||||
}
|
||||
|
||||
AtRiskDataWarning::AtRiskBackupOutcome AtRiskDataWarning::backUpAtRiskPaths(const QStringList &sources,
|
||||
const QString &appDir)
|
||||
{
|
||||
|
|
@ -208,8 +73,6 @@ AtRiskDataWarning::AtRiskBackupOutcome AtRiskDataWarning::backUpAtRiskPaths(cons
|
|||
// The copy runs synchronously on the UI thread at startup, so cap it: a
|
||||
// pictures folder pointed into the program dir can be gigabytes, and freezing
|
||||
// the client to duplicate it is worse than asking for a manual copy.
|
||||
// Portable sources are small by construction (downloaded pictures and replays
|
||||
// are excluded above); this guard bites for non-portable offenders.
|
||||
outcome.bytes = UserDataBackup::estimateBackupSize(sources);
|
||||
if (outcome.bytes >= UserDataBackup::MAX_AUTO_BACKUP_BYTES) {
|
||||
outcome.skippedDueToSize = true;
|
||||
|
|
@ -244,50 +107,6 @@ AtRiskDataWarning::AtRiskBackupOutcome AtRiskDataWarning::backUpAtRiskPaths(cons
|
|||
return outcome;
|
||||
}
|
||||
|
||||
QString AtRiskDataWarning::buildPortableAtRiskMessage(const AtRiskBackupOutcome &outcome, bool emptySources)
|
||||
{
|
||||
const QString backupVerb = outcome.reused ? tr("is already available") : tr("has been created");
|
||||
const QString sizeInfo = tr("%1 MB (automatic backups are capped at %2 MB)")
|
||||
.arg(QString::number(outcome.bytes / 1048576.0, 'f', 1),
|
||||
QString::number(UserDataBackup::MAX_AUTO_BACKUP_BYTES / 1048576));
|
||||
if (!outcome.locations.isEmpty()) {
|
||||
QString message =
|
||||
tr("This portable install keeps its data inside the program directory, where the "
|
||||
"uninstallers shipped in Cockatrice 3.1.0/3.1.1 delete everything on uninstall or "
|
||||
"update.\n\nA safety backup of your decks, custom sets, settings, filters, themes, sounds and "
|
||||
"custom "
|
||||
"pictures %1 "
|
||||
"at:\n%2\n\nReplays and downloaded pictures are not included in this backup. Uninstalling "
|
||||
"with the old uninstaller still deletes the program "
|
||||
"directory, so keep your own copy of that backup until you have updated once.")
|
||||
.arg(backupVerb, outcome.locations.join(QLatin1Char('\n')));
|
||||
if (!outcome.complete) {
|
||||
message += tr("\n\nThe backup may be incomplete; please back up these folders manually as well.");
|
||||
}
|
||||
return message;
|
||||
}
|
||||
if (outcome.skippedDueToSize) {
|
||||
return tr("This portable install keeps its data inside the program directory, where the "
|
||||
"uninstallers shipped in Cockatrice 3.1.0/3.1.1 delete everything on uninstall or "
|
||||
"update.\n\nThe automatic safety backup was skipped because of its size: %1. "
|
||||
"Please back up your data folder manually "
|
||||
"before uninstalling or updating.\n\nReplays and downloaded pictures would not have been "
|
||||
"included in that backup either.")
|
||||
.arg(sizeInfo);
|
||||
}
|
||||
if (emptySources) {
|
||||
return tr("This portable install keeps its data inside the program directory, where the "
|
||||
"uninstallers shipped in Cockatrice 3.1.0/3.1.1 delete everything on uninstall or "
|
||||
"update.\n\nNone of your data files exist on disk yet, so there was nothing to back up. "
|
||||
"Files created there later are still at risk until you have updated once.");
|
||||
}
|
||||
return tr("This portable install keeps its data inside the program directory, where the "
|
||||
"uninstallers shipped in Cockatrice 3.1.0/3.1.1 delete everything on uninstall or "
|
||||
"update.\n\nThe automatic safety backup failed; please back up your data folder manually "
|
||||
"before uninstalling or updating.\n\nReplays and downloaded pictures would not have been "
|
||||
"included in that backup either.");
|
||||
}
|
||||
|
||||
QString AtRiskDataWarning::buildInstalledAtRiskMessage(const QStringList &offenders,
|
||||
const QStringList &sources,
|
||||
const AtRiskBackupOutcome &outcome)
|
||||
|
|
@ -342,36 +161,34 @@ void AtRiskDataWarning::warnAboutDataPathsInProgramDir(QWidget *parent)
|
|||
return;
|
||||
}
|
||||
|
||||
// Portable installs keep their data inside the program directory by design, but they
|
||||
// never shipped an uninstaller, and portable updates use the installer's payload
|
||||
// purge, which preserves data/ - so there is nothing destructive to warn about.
|
||||
if (SettingsCache::instance().getIsPortableBuild()) {
|
||||
return;
|
||||
}
|
||||
|
||||
const QString appDir = QCoreApplication::applicationDirPath();
|
||||
const bool isPortable = SettingsCache::instance().getIsPortableBuild();
|
||||
|
||||
// Sources to back up outside the install directory before warning. The uninstallers
|
||||
// shipped in 3.1.0/3.1.1 delete the whole install tree, so a safety copy is kept
|
||||
// even though the fixed uninstaller preserves foreign files - the destructive one
|
||||
// is already on disk on affected machines.
|
||||
AtRiskPaths atRisk;
|
||||
if (isPortable) {
|
||||
atRisk = collectPortableAtRiskPaths(appDir);
|
||||
} else {
|
||||
atRisk.offendersForDisplay = collectInstalledAtRiskPaths(appDir);
|
||||
if (atRisk.offendersForDisplay.isEmpty()) {
|
||||
return;
|
||||
}
|
||||
// Only existing paths can be copied; a configured-but-never-created path has
|
||||
// nothing to lose yet and must not turn the warning into a bogus "failed".
|
||||
for (const QString &existingOffender : atRisk.offendersForDisplay) {
|
||||
if (QFileInfo::exists(existingOffender)) {
|
||||
atRisk.sourcesToBackUp.append(existingOffender);
|
||||
}
|
||||
const QStringList offenders = collectInstalledAtRiskPaths(appDir);
|
||||
if (offenders.isEmpty()) {
|
||||
return;
|
||||
}
|
||||
// Only existing paths can be copied; a configured-but-never-created path has
|
||||
// nothing to lose yet and must not turn the warning into a bogus "failed".
|
||||
QStringList sourcesToBackUp;
|
||||
for (const QString &offender : offenders) {
|
||||
if (QFileInfo::exists(offender)) {
|
||||
sourcesToBackUp.append(offender);
|
||||
}
|
||||
}
|
||||
|
||||
const AtRiskBackupOutcome outcome = backUpAtRiskPaths(atRisk.sourcesToBackUp, appDir);
|
||||
const AtRiskBackupOutcome outcome = backUpAtRiskPaths(sourcesToBackUp, appDir);
|
||||
|
||||
const QString title =
|
||||
isPortable ? tr("Portable data at risk on uninstall") : tr("Data paths inside the program directory");
|
||||
const QString message =
|
||||
isPortable ? buildPortableAtRiskMessage(outcome, atRisk.sourcesToBackUp.isEmpty())
|
||||
: buildInstalledAtRiskMessage(atRisk.offendersForDisplay, atRisk.sourcesToBackUp, outcome);
|
||||
showAtRiskDataWarning(parent, title, message);
|
||||
const QString message = buildInstalledAtRiskMessage(offenders, sourcesToBackUp, outcome);
|
||||
showAtRiskDataWarning(parent, tr("Data paths inside the program directory"), message);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue