[Installer] Make the Inno Setup installer the default, with its failure hook.

COCKATRICE_WIN_INSTALLER now defaults to InnoSetup. NSIS stays selectable for
one release as the legacy fallback, and the two can still be built from one
tree and compared on a real upgrade.

The switches question from the previous commit is settled from Inno Setup's
source: the setup command line is an if/else-if chain over the switches it
knows, with no fallback that rejects the rest, so /R, /PID= and /D= are
ignored rather than refused. The client therefore sends one command line that
drives either installer:

- /R and /PID= for NSIS, which also needs /D= last and unquoted;
- /VERYSILENT and the CloseApplications set for Setup, which releases the
  mapped runtime DLLs through Restart Manager instead of waiting for a pid;
- /UPDATER as the client's own mark, read only by the Inno Setup script.

An older client that passes only the NSIS switches still installs; it walks
the wizard once instead of running silently.

The Sentry offer that AbortInstall carried is ported: a silent run the updater
launched, which began replacing files and never reached the end, offers to
send its log through the same helper. The helper is embedded with a [Files]
dontcopy entry and extracted at send time; a repeated [Files] section merges
with the generated one instead of being a compile error. Setup prefixes every
log line with a timestamp, so the helper's ABORT scan now allows that prefix.

CI installs Inno Setup next to NSIS, dumps ISCCOutput.log and the generated
script when the installer fails to compile, and --package NSIS|InnoSetup
selects the installer through the CMake option instead of adding a second
CPack generator to the run.
This commit is contained in:
Lukas Brübach 2026-10-26 08:29:22 +01:00
parent 2c8e47a0a4
commit 0403ac9354
8 changed files with 220 additions and 73 deletions

View file

@ -194,7 +194,14 @@ if [[ $USE_CCACHE ]]; then
fi fi
fi fi
if [[ $PACKAGE_TYPE ]]; then if [[ $PACKAGE_TYPE ]]; then
flags+=("-DCPACK_GENERATOR=$PACKAGE_TYPE") if [[ $PACKAGE_TYPE == NSIS || $PACKAGE_TYPE == InnoSetup ]]; then
# The Windows installer is chosen by a CMake option, and that option then adds its CPack
# generator itself. Passing CPACK_GENERATOR as well would list both installers and build
# both in one run.
flags+=("-DCOCKATRICE_WIN_INSTALLER=$PACKAGE_TYPE")
else
flags+=("-DCPACK_GENERATOR=$PACKAGE_TYPE")
fi
fi fi
if [[ $USE_VCPKG ]]; then if [[ $USE_VCPKG ]]; then
flags+=("-DUSE_VCPKG=1") flags+=("-DUSE_VCPKG=1")

View file

@ -552,10 +552,13 @@ jobs:
modules: ${{ matrix.qt_modules }} modules: ${{ matrix.qt_modules }}
version: ${{ matrix.qt_version }} version: ${{ matrix.qt_version }}
- name: "[Windows] Install NSIS" # Inno Setup writes the default Windows installer (COCKATRICE_WIN_INSTALLER=InnoSetup);
# NSIS stays installed because the option still selects the old installer, and CI has to
# be able to build both to compare them on a real upgrade.
- name: "[Windows] Install installer tooling"
if: matrix.os == 'Windows' if: matrix.os == 'Windows'
shell: bash shell: bash
run: choco install nsis run: choco install nsis innosetup
# Ninja invokes cl.exe directly and needs the MSVC environment on PATH. # Ninja invokes cl.exe directly and needs the MSVC environment on PATH.
- name: "[Windows] Set up MSVC environment" - name: "[Windows] Set up MSVC environment"
@ -745,16 +748,26 @@ jobs:
# `debug-files upload` and DIFs are matched by debug ID, not release. # `debug-files upload` and DIFs are matched by debug ID, not release.
sentry-cli debug-files upload --org cockatrice --project cockatrice-desktop "${paths[@]}" sentry-cli debug-files upload --org cockatrice --project cockatrice-desktop "${paths[@]}"
# CPack reports a failed makensis run as "Problem running NSIS command" # CPack reports a failed installer compile only as a path to a log that lives on the
# plus a path to NSISOutput.log, and that log lives only on the runner, so # runner: NSISOutput.log for makensis, ISCCOutput.log for Inno Setup's compiler. The
# the actual compile error is otherwise nowhere in the workflow output. # Inno Setup error names a line of the script CPack generated, so that script is
# Dump it, or a broken installer script is undiagnosable from CI alone. # dumped too - without them a broken installer script is undiagnosable from CI alone.
# shell: bash matters here - the default pwsh resolves `find` to Windows' # shell: bash matters here - the default pwsh resolves `find` to Windows'
# text-search find.exe, which errors instead of searching. # text-search find.exe, which errors instead of searching.
- name: "Dump NSIS compile log" - name: "Dump installer compile log"
if: failure() && matrix.os == 'Windows' if: failure() && matrix.os == 'Windows'
shell: bash shell: bash
run: find . -name NSISOutput.log -exec cat {} + run: |
find . -name NSISOutput.log -o -name ISCCOutput.log | while read -r log; do
echo "::group::$log"
cat "$log"
echo "::endgroup::"
done
find . -path '*_CPack_Packages*' -name ISScript.iss | while read -r script; do
echo "::group::$script"
cat "$script"
echo "::endgroup::"
done
# A master run hands over the archives it had to build itself so that # A master run hands over the archives it had to build itself so that
# vcpkg-cache-import.yml, which runs in the default branch scope, can save them # vcpkg-cache-import.yml, which runs in the default branch scope, can save them

View file

@ -327,19 +327,32 @@ if(UNIX)
endif() endif()
endif() endif()
elseif(WIN32) elseif(WIN32)
# Which tool writes the installer. NSIS is the incumbent and stays the default; # Which tool writes the installer. InnoSetup, through CPack's own Inno Setup generator
# InnoSetup selects CPack's own Inno Setup generator (see cmake/InnoSetup.cmake). Both # (cmake/InnoSetup.cmake), is the default. NSIS stays selectable for one release as the
# consume the same install() rules, so this is a packaging choice, never a build change, # fallback for anyone who needs the old installer, and so the two can still be built from
# and the two installers can be built from one tree and compared on a real upgrade. # one tree and compared on a real upgrade. Both consume the same install() rules, so this
# is a packaging choice, never a build change.
set(COCKATRICE_WIN_INSTALLER set(COCKATRICE_WIN_INSTALLER
"NSIS" "InnoSetup"
CACHE STRING "Windows installer generator: NSIS (incumbent) or InnoSetup" CACHE STRING "Windows installer generator: InnoSetup (default) or NSIS (legacy)"
) )
set_property(CACHE COCKATRICE_WIN_INSTALLER PROPERTY STRINGS NSIS InnoSetup) set_property(CACHE COCKATRICE_WIN_INSTALLER PROPERTY STRINGS NSIS InnoSetup)
if(NOT COCKATRICE_WIN_INSTALLER MATCHES "^(NSIS|InnoSetup)$") if(NOT COCKATRICE_WIN_INSTALLER MATCHES "^(NSIS|InnoSetup)$")
message(FATAL_ERROR "COCKATRICE_WIN_INSTALLER must be NSIS or InnoSetup, not '${COCKATRICE_WIN_INSTALLER}'") message(FATAL_ERROR "COCKATRICE_WIN_INSTALLER must be NSIS or InnoSetup, not '${COCKATRICE_WIN_INSTALLER}'")
endif() endif()
# Installer-log sender for the failure hooks of both installers (values parsed out of
# COCKATRICE_SENTRY_DSN in cmake/CrashReporting.cmake). Generated only when a DSN was
# parsed: cmake/NSIS.template.in and cmake/InnoSetup.install.iss embed it under the same
# CPACK_SENTRY_ENABLED check, so a build without reporting never references or carries the
# helper. Configured above the installer choice because both branches consume it.
if(CPACK_SENTRY_ENABLED)
configure_file(
"${COCKATRICE_CMAKE_PATH}/SendInstallerLog.ps1.in" "${PROJECT_BINARY_DIR}/SendInstallerLog.ps1" @ONLY
)
set(COCKATRICE_SENTRY_INSTALLER_LOG "${PROJECT_BINARY_DIR}/SendInstallerLog.ps1")
endif()
if(COCKATRICE_WIN_INSTALLER STREQUAL "InnoSetup") if(COCKATRICE_WIN_INSTALLER STREQUAL "InnoSetup")
include(${COCKATRICE_CMAKE_PATH}/InnoSetup.cmake) include(${COCKATRICE_CMAKE_PATH}/InnoSetup.cmake)
else() else()
@ -354,15 +367,6 @@ elseif(WIN32)
configure_file("${COCKATRICE_CMAKE_PATH}/NSIS.definitions.nsh.in" "${PROJECT_BINARY_DIR}/NSIS.definitions.nsh") configure_file("${COCKATRICE_CMAKE_PATH}/NSIS.definitions.nsh.in" "${PROJECT_BINARY_DIR}/NSIS.definitions.nsh")
endif() endif()
# Installer-log sender for the AbortInstall Sentry hook (values parsed out of COCKATRICE_SENTRY_DSN in
# cmake/CrashReporting.cmake). Generated only when a DSN was parsed: cmake/NSIS.template.in embeds it under
# the same CPACK_SENTRY_ENABLED check, so a build without reporting never references or carries the helper.
if(CPACK_SENTRY_ENABLED)
configure_file(
"${COCKATRICE_CMAKE_PATH}/SendInstallerLog.ps1.in" "${PROJECT_BINARY_DIR}/SendInstallerLog.ps1" @ONLY
)
endif()
# Every runtime DLL a Windows install has to contain, as paths relative to the # Every runtime DLL a Windows install has to contain, as paths relative to the
# install root. .ci/compile.sh reads this and fails the build when the packaged # install root. .ci/compile.sh reads this and fails the build when the packaged
# installer is missing one of them, or carries a runtime it does not know about. # installer is missing one of them, or carries a runtime it does not know about.

View file

@ -1,9 +1,9 @@
# Windows installer written by Inno Setup, through CPack's own InnoSetup generator. # Windows installer written by Inno Setup, through CPack's own InnoSetup generator.
# #
# Included from the WIN32 branch of the top-level CMakeLists.txt when # Included from the WIN32 branch of the top-level CMakeLists.txt when
# COCKATRICE_WIN_INSTALLER is InnoSetup. It sits next to the NSIS template rather than # COCKATRICE_WIN_INSTALLER is InnoSetup, which is the default. The NSIS template is kept
# replacing it so both installers can be built from the same tree and compared on a real # next to this file rather than deleted so both installers can still be built from one tree
# upgrade. # and compared on a real upgrade.
# #
# The generator writes [Files], [Dirs], [Icons], [Run] and [Registry] from the install() # The generator writes [Files], [Dirs], [Icons], [Run] and [Registry] from the install()
# rules the project already declares, so nothing here repeats them. What is added is only # rules the project already declares, so nothing here repeats them. What is added is only
@ -17,8 +17,10 @@ if(CMAKE_VERSION VERSION_LESS 3.27)
message(FATAL_ERROR "COCKATRICE_WIN_INSTALLER=InnoSetup needs CMake >= 3.27 (found ${CMAKE_VERSION})") message(FATAL_ERROR "COCKATRICE_WIN_INSTALLER=InnoSetup needs CMake >= 3.27 (found ${CMAKE_VERSION})")
endif() endif()
# CPack is allowed to be told -DCPACK_GENERATOR=... by the caller; do not list the # CPack may be told -DCPACK_GENERATOR=... by the caller. For the Windows installers the
# generator twice when that caller already asked for it. # choice is made by COCKATRICE_WIN_INSTALLER instead (.ci/compile.sh --package NSIS or
# InnoSetup maps to it), because picking the generator here and the installer tool there can
# silently build both in one run. Only guard against asking for InnoSetup twice.
if(NOT "InnoSetup" IN_LIST CPACK_GENERATOR) if(NOT "InnoSetup" IN_LIST CPACK_GENERATOR)
set(CPACK_GENERATOR InnoSetup ${CPACK_GENERATOR}) set(CPACK_GENERATOR InnoSetup ${CPACK_GENERATOR})
endif() endif()
@ -89,4 +91,13 @@ set(CPACK_INNOSETUP_SETUP_UninstallDisplayIcon "{app}\\cockatrice.exe")
set(CPACK_INNOSETUP_EXTRA_SCRIPTS "${COCKATRICE_CMAKE_PATH}/InnoSetup.install.iss") set(CPACK_INNOSETUP_EXTRA_SCRIPTS "${COCKATRICE_CMAKE_PATH}/InnoSetup.install.iss")
set(CPACK_INNOSETUP_CODE_FILES "${COCKATRICE_CMAKE_PATH}/InnoSetup.code.iss") set(CPACK_INNOSETUP_CODE_FILES "${COCKATRICE_CMAKE_PATH}/InnoSetup.code.iss")
# The installer-log sender the failure hook in InnoSetup.code.iss offers after an upgrade
# that did not finish. CPack passes these as public ISCC macros (/Dname=value), so the extra
# script can embed the helper with a [Files] dontcopy entry and the code can extract it at
# send time. Undefined when the build carries no reporting, which is what the ifdef guards in
# both scripts test.
if(CPACK_SENTRY_ENABLED)
set(CPACK_INNOSETUP_DEFINE_SentryHelperPath "${COCKATRICE_SENTRY_INSTALLER_LOG}")
endif()
message(STATUS "Windows installer: Inno Setup (CPack InnoSetup generator, ${CPACK_INNOSETUP_ARCHITECTURE})") message(STATUS "Windows installer: Inno Setup (CPack InnoSetup generator, ${CPACK_INNOSETUP_ARCHITECTURE})")

View file

@ -14,6 +14,12 @@ const
var var
PortablePage: TCustomPage; PortablePage: TCustomPage;
PortableCheck: TNewCheckBox; PortableCheck: TNewCheckBox;
// Progress of this run, for the failure hook further down. Setup has no "the installation
// failed" callback, and DeinitializeSetup runs on every way out of the wizard, so the two
// steps that bracket the file work are what distinguishes those ways.
InstallStarted: Boolean;
InstallCompleted: Boolean;
UserCancelled: Boolean;
// True when the given switch appears on the setup command line. Used for the legacy // True when the given switch appears on the setup command line. Used for the legacy
// portable switch, which the in-app updater and the older installers pass. // portable switch, which the in-app updater and the older installers pass.
@ -147,20 +153,93 @@ end;
procedure CurStepChanged(CurStep: TSetupStep); procedure CurStepChanged(CurStep: TSetupStep);
begin begin
if CurStep = ssInstall then
InstallStarted := True;
if CurStep = ssPostInstall then if CurStep = ssPostInstall then
begin begin
InstallVCRedist(); InstallVCRedist();
WritePortableMarker(); WritePortableMarker();
RemoveLegacyNSISRegistration(); RemoveLegacyNSISRegistration();
end; end;
if CurStep = ssDone then
InstallCompleted := True;
end; end;
// The 3.1.x client launches the installer with two switches that belong to the NSIS build: // Cancel is a decision, not a failure, so the hook below stays quiet after one.
// /R (silent reinstall) and /PID= (the process to wait for). Recording them from the log is procedure CancelButtonClick(CurPageID: Integer; var Cancel, Confirm: Boolean);
// how the first test of this installer answers the one open question about the migration: begin
// whether Inno Setup reaches this point at all with them on the command line. If it does, UserCancelled := True;
// the updater keeps working across the switch; if it does not, Setup rejects them before end;
// running any script and the updater needs a version gate instead.
#ifdef SentryHelperPath
// The failure hook, which is what the NSIS template's AbortInstall did for updates that
// stopped half way. The three conditions it watched for - the application would not close,
// the stale runtime could not be purged, the launcher did not exit - are Restart Manager's
// and the [InstallDelete] section's job here, so what is left is the outcome rather than the
// cause: a silent run the in-app updater started, which began replacing files and never
// reached the end. That run is the one that needs it, because the updater quits after
// launching Setup and leaves no window on screen to read an error from; an interactive user
// sees the message Setup shows and can find the log in the temporary directory themselves.
procedure OfferToSendInstallerLog();
var
LogPath, Params: String;
ResultCode: Integer;
begin
LogPath := ExpandConstant('{log}');
if LogPath = '' then
Exit;
// The sender takes the reason from the log (see SendInstallerLog.ps1.in), so record it
// whether or not the user agrees: it is the first thing to look at in a report either way.
Log('ABORT: the update did not finish installing');
Log('full installer log: ' + LogPath);
if MsgBox('Send the installer log to the developers to help fix this? The log contains'
+ ' file paths from this machine, which may include your Windows user name.',
mbConfirmation, MB_YESNO) <> IDYES then
begin
Log('Sentry send: declined by user');
Exit;
end;
ExtractTemporaryFile('SendInstallerLog.ps1');
Params := '-NoProfile -NonInteractive -ExecutionPolicy Bypass -File "'
+ ExpandConstant('{tmp}\SendInstallerLog.ps1') + '" -LogPath "' + LogPath + '"';
ResultCode := -1;
if Exec('powershell.exe', Params, '', SW_HIDE, ewWaitUntilTerminated, ResultCode)
and (ResultCode = 0) then
begin
Log('Sentry send: result=' + IntToStr(ResultCode));
MsgBox('The installer log was sent. Thank you for helping improve Cockatrice!',
mbInformation, MB_OK);
end
else
begin
Log('Sentry send: result=' + IntToStr(ResultCode));
MsgBox('The installer log could not be sent. You can still share it manually; it was'
+ ' written to:' + #13#10 + LogPath, mbError, MB_OK);
end;
end;
#endif
// Runs after logging has started and while the log is still open and flushed, which is what
// makes the log of this run available to the sender.
procedure DeinitializeSetup();
begin
#ifdef SentryHelperPath
// /UPDATER is the client's own mark on the command lines it hands either installer.
// Requiring it keeps this offer out of a package manager's silent install, where a message
// box that nobody answers would block the install - the case the NSIS template kept clear
// of by prompting on its /R switch rather than on silence alone.
if WizardSilent and HasSwitch('/UPDATER') and InstallStarted and not InstallCompleted
and not UserCancelled then
OfferToSendInstallerLog();
#endif
end;
// The in-app updater used to pass two switches that belong to the NSIS build: /R (silent
// reinstall) and /PID= (the process to wait for). Setup ignores switches it does not know -
// its command line is an if/else-if chain over the ones it does know, with no fallback that
// rejects the rest (ProcessCommandLine in Setup.MainFunc.pas) - so an older client still
// installs from this one, it just walks the wizard instead of running silently. Logging the
// switches keeps both cases visible in the log of the first upgrade that comes through here.
function InitializeSetup(): Boolean; function InitializeSetup(): Boolean;
var var
I: Integer; I: Integer;
@ -170,8 +249,9 @@ begin
for I := 1 to ParamCount do for I := 1 to ParamCount do
begin begin
Param := ParamStr(I); Param := ParamStr(I);
if (CompareText(Param, '/R') = 0) or (CompareText(Copy(Param, 1, 5), '/PID=') = 0) then if (CompareText(Param, '/R') = 0) or (CompareText(Param, '/UPDATER') = 0)
Log('Legacy in-app updater switch: ' + Param); or (CompareText(Copy(Param, 1, 5), '/PID=') = 0) then
Log('In-app updater switch: ' + Param);
end; end;
Result := True; Result := True;
end; end;

View file

@ -1,9 +1,11 @@
; Sections added to the setup script CPack's Inno Setup generator writes. ; Sections added to the setup script CPack's Inno Setup generator writes.
; ;
; Included through CPACK_INNOSETUP_EXTRA_SCRIPTS, which prepends this file to the ; Included through CPACK_INNOSETUP_EXTRA_SCRIPTS, which prepends this file to the
; generated script. Only sections the generator never emits may appear here: it writes ; generated script. Repeating a section that the generator also writes is not an error: the
; [Files], [Dirs], [Icons], [Run] and [Registry] from the install() rules, and a second ; compiler re-tests every [Header] against the section it is collecting and enumerates the
; section of one of those is a compile error. Behaviour belongs in InnoSetup.code.iss. ; lines of each occurrence (FoundSection in TSetupCompiler.EnumIniSection,
; Compiler.SetupCompiler.pas), so the [Files] and [InstallDelete] below merge with the ones
; built from the install() rules. Behaviour belongs in InnoSetup.code.iss.
[InstallDelete] [InstallDelete]
; The previous version's runtime, whatever it was called. Replacing a DLL in place is not ; The previous version's runtime, whatever it was called. Replacing a DLL in place is not
@ -21,3 +23,14 @@ Type: filesandordirs; Name: "{app}\Plugins"
; install (RemoveLegacyNSISRegistration in InnoSetup.code.iss); the binary itself has no ; install (RemoveLegacyNSISRegistration in InnoSetup.code.iss); the binary itself has no
; business staying next to the new one. ; business staying next to the new one.
Type: files; Name: "{app}\Uninstall.exe" Type: files; Name: "{app}\Uninstall.exe"
; The installer-log sender behind the failure hook in InnoSetup.code.iss. dontcopy embeds
; the file in the setup image without installing it, and ExtractTemporaryFile pulls it out
; into the temporary directory only when something went wrong - what the NSIS template did
; by writing the same helper into $PLUGINSDIR. The path arrives from CMake as a public ISCC
; macro defined only for a build that carries a Sentry DSN; without one there is nothing to
; send, so nothing is embedded and the hook compiles out.
#ifdef SentryHelperPath
[Files]
Source: "{#SentryHelperPath}"; Flags: dontcopy
#endif

View file

@ -1,5 +1,5 @@
# Sends the NSIS installer log to Sentry as an envelope carrying one error # Sends the installer log, from either installer, to Sentry as an envelope carrying one
# event plus the log as an attachment. # error event plus the log as an attachment.
# #
# Generated at configure time from this template by CMake configure_file: the # Generated at configure time from this template by CMake configure_file: the
# CPACK_SENTRY_* placeholders are baked in then, so the real values only ever # CPACK_SENTRY_* placeholders are baked in then, so the real values only ever
@ -44,16 +44,20 @@ try {
} }
# --- Abort reason, read from the log itself -------------------------------- # --- Abort reason, read from the log itself --------------------------------
# AbortInstall logs "ABORT: ..." first, so the reason travels inside the file # Each installer records the reason before offering to send, so it travels inside the
# and nothing reason-shaped crosses the command line (no quoting hazards). # file and nothing reason-shaped crosses the command line (no quoting hazards).
# Select-String yields the matching line alone, so the reason is already one # NSIS writes the line as "ABORT: ..." through CockLog. Inno Setup prefixes every line
# physical line for the message; anything else stays in the attached log. # of its log with a timestamp and three spaces, so that prefix is optional here and
# Non-ASCII paths may garble here; the attachment is byte-exact regardless. # removed together with the marker. Select-String yields the matching line alone, so
# the reason is already one physical line for the message; anything else stays in the
# attached log. Non-ASCII paths may garble here; the attachment is byte-exact
# regardless.
$stamp = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}\s+'
$Reason = 'unknown (no ABORT line in log)' $Reason = 'unknown (no ABORT line in log)'
if (Test-Path -LiteralPath $LogPath) { if (Test-Path -LiteralPath $LogPath) {
$abortLine = Select-String -LiteralPath $LogPath -Pattern '^ABORT: ' | Select-Object -Last 1 $abortLine = Select-String -LiteralPath $LogPath -Pattern ('^(' + $stamp + ')?ABORT: ') | Select-Object -Last 1
if ($abortLine) { if ($abortLine) {
$Reason = ($abortLine.Line -replace '^ABORT:\s*', '') $Reason = ($abortLine.Line -replace ('^(' + $stamp + ')?ABORT:\s*'), '')
} }
} }

View file

@ -228,16 +228,16 @@ void DlgUpdate::setLabel(const QString &newText)
void DlgUpdate::warnInstallerIsWaiting() void DlgUpdate::warnInstallerIsWaiting()
{ {
// Modeless on purpose: the installer asks the application to close exactly once (see // Modeless on purpose: the installer asks the application to close exactly once - the NSIS
// CloseMatchingApps in NSIS.template.in) and only polls afterwards, while Qt drops spontaneous // template closes matching windows itself (CloseMatchingApps in NSIS.template.in), Setup asks
// close events - a WM_CLOSE from the installer - for windows that are blocked by a modal // through Restart Manager - and then gives up on the update, while Qt drops spontaneous close
// widget (QGuiApplicationPrivate::processCloseEvent). An application modal message box here // events - a WM_CLOSE from the installer - for windows that are blocked by a modal widget
// would therefore swallow the installer's one and only request for the rest of its wait. // (QGuiApplicationPrivate::processCloseEvent). An application modal message box here would
// therefore swallow the installer's one and only request.
auto *notification = new QMessageBox(QMessageBox::Warning, tr("Update"), auto *notification = new QMessageBox(QMessageBox::Warning, tr("Update"),
tr("The update installer is already running and waits about a " tr("The update installer is waiting for Cockatrice to close. "
"minute for Cockatrice to close. Cockatrice is still busy, so " "Cockatrice is still busy, so save your work and close it. "
"save your work and close it before then. Otherwise the " "Otherwise the update cannot be installed and is cancelled."),
"installer gives up and the update is cancelled."),
QMessageBox::Ok, parentWidget()); QMessageBox::Ok, parentWidget());
notification->setWindowModality(Qt::NonModal); notification->setWindowModality(Qt::NonModal);
notification->setAttribute(Qt::WA_DeleteOnClose); notification->setAttribute(Qt::WA_DeleteOnClose);
@ -275,19 +275,35 @@ void DlgUpdate::downloadSuccessful(const QUrl &filepath)
QProcess process; QProcess process;
process.setProgram(installerPath); process.setProgram(installerPath);
// NSIS needs the /D= argument to be an UNQUOTED string, even if it contains spaces. Qt likes to quote arguments if // One command line has to drive either installer, because a package can be built with either
// they contain spaces, so we use the windows exclusive QProcess::setNativeArguments in the only case where this is // one and the client cannot tell which it downloaded:
// relevant, which preserves the argument unquoted. // - /R runs the NSIS installer silently and reinstalls over the existing installation. Setup
// // ignores the switches it does not know, and that covers /R, /PID= and /D=.
// /PID= tells the installer which process to wait for before it replaces anything. We launch the installer first // - /VERYSILENT and the switches around it are Setup's spelling of the same thing.
// and only quit afterwards, so it starts while this process is still alive and still has every Qt runtime DLL // /CLOSEAPPLICATIONS lets Restart Manager close Cockatrice if this process is still shutting
// mapped, and a mapped DLL cannot be deleted. Without the handle the installer can only poll for an image name and // down once Setup reaches the files, and /NOFORCECLOSEAPPLICATIONS keeps that from ever
// guess, and a wrong guess is what leaves the update writing new executables next to runtime files of the previous // forcing it: a window that refuses to close still cancels the update rather than losing the
// version, which fails on the next start with "The procedure entry point ... could not be located in the dynamic // user's work.
// link library // - /PID= tells the NSIS installer which process to wait for before it replaces anything. We
// ...Qt6QuickWidgets.dll". /D= has to stay the last parameter, which is why it is last here too. // launch the installer first and only quit afterwards, so it starts while this process is
// still alive and still has every Qt runtime DLL mapped, and a mapped DLL cannot be deleted.
// Without the handle the installer can only poll for an image name and guess, and a wrong
// guess is what leaves the update writing new executables next to runtime files of the
// previous version, which fails on the next start with "The procedure entry point ... could
// not be located in the dynamic link library ...Qt6QuickWidgets.dll". Setup ignores the
// switch; Restart Manager releases the same handles, which is what /CLOSEAPPLICATIONS above
// asks it to do.
// - /UPDATER marks an install that the in-app updater launched. Both installers ignore it
// while running, and only the Inno Setup package reads it: it is what lets the failure
// hook offer the log of a silent update that did not finish, without ever putting a
// message box in front of a package manager's silent install.
// NSIS honours /D= only as the last parameter and requires it unquoted even when it has spaces,
// so it stays last here and the whole line goes through QProcess::setNativeArguments.
#ifdef Q_OS_WIN #ifdef Q_OS_WIN
process.setNativeArguments(QString("/R /PID=%1 /D=%2").arg(QCoreApplication::applicationPid()).arg(appDir)); process.setNativeArguments(QString("/R /PID=%1 /UPDATER /VERYSILENT /SUPPRESSMSGBOXES /NORESTART"
" /CLOSEAPPLICATIONS /NOFORCECLOSEAPPLICATIONS /D=%2")
.arg(QCoreApplication::applicationPid())
.arg(appDir));
#else #else
// Linux/macOS: normal argument passing (not relevant since they update differently.) // Linux/macOS: normal argument passing (not relevant since they update differently.)
process.setArguments({"/R", QString("/D=%1").arg(appDir)}); process.setArguments({"/R", QString("/D=%1").arg(appDir)});
@ -296,14 +312,13 @@ void DlgUpdate::downloadSuccessful(const QUrl &filepath)
// Try to open the installer. If it opens, quit Cockatrice // Try to open the installer. If it opens, quit Cockatrice
if (process.startDetached()) { if (process.startDetached()) {
qCInfo(DlgUpdateLog) << "Opened update installer successfully - closing Cockatrice"; qCInfo(DlgUpdateLog) << "Opened update installer successfully - closing Cockatrice";
// Close the main window synchronously so file locks are released before the NSIS installer // Close the main window synchronously so file locks are released before the installer
// (already launched) starts replacing files. This also flushes settings and shuts down the // (already launched) starts replacing files. This also flushes settings and shuts down the
// tabs, but only when the close is actually accepted: MainWindow may veto it for a running // tabs, but only when the close is actually accepted: MainWindow may veto it for a running
// card DB update, an open game, or an unsaved deck, and closeForUpdate() also reports a // card DB update, an open game, or an unsaved deck, and closeForUpdate() also reports a
// close already in progress (reached from a nested event loop while a shutdown prompt is // close already in progress (reached from a nested event loop while a shutdown prompt is
// up). Only quit when the shutdown really ran - otherwise keep running so the user can // up). Only quit when the shutdown really ran - otherwise keep running so the user can
// resolve the blocker, and warn them that the installer only waits about a minute // resolve the blocker, and warn them that the installer cannot finish until it closes.
// before it gives up and cancels the update.
if (auto *window = qobject_cast<MainWindow *>(parent())) { if (auto *window = qobject_cast<MainWindow *>(parent())) {
if (window->closeForUpdate()) { if (window->closeForUpdate()) {
QTimer::singleShot(0, qApp, [] { QCoreApplication::exit(0); }); QTimer::singleShot(0, qApp, [] { QCoreApplication::exit(0); });