WiX bundle update to support v5

.gitignore

@@ -35,6 +35,7 @@ release.txt
 /test/copyimg/copyimg
 /test/goecho/goecho
 /test/version/version
+/test/version/version.exe
 /test/testvol/testvol
 /test/tools/build
 /test/e2e/ginkgo-node-*
@@ -45,12 +46,13 @@ result
 /*runner_stats.log
 .generate-bindings
 contrib/win-installer/artifacts/
+contrib/win-installer/current/
 contrib/win-installer/docs/
+contrib/win-installer/en-US/
 contrib/win-installer/fetch/
-contrib/win-installer/podman.msi
 contrib/win-installer/podman-*setup.exe
 contrib/win-installer/engine.exe
+contrib/win-installer/obj/
 contrib/win-installer/shasums
-contrib/win-installer/pages.wxs
 contrib/win-installer/*.wixobj
 contrib/win-installer/*.wixpdb

build_windows.md

@@ -10,7 +10,7 @@ Windows.
   - [OS requirements](#os-requirements)
   - [Git and go](#git-and-go)
   - [Pandoc](#pandoc)
-  - [WiX Toolset v3](#wix-toolset-v3)
+  - [.NET SDK](#net-sdk)
   - [Virtualization Provider](#virtualization-provider)
     - [WSL](#wsl)
     - [Hyper-V](#hyper-v)
@@ -70,14 +70,22 @@ Pandoc can be installed from https://pandoc.org/installing.html. When performing
 the Pandoc installation one, has to choose the option "Install for all users"
 (to put the binaries into "Program Files" directory).
 
-### WiX Toolset v3
+### .NET SDK
 
-[WiX Toolset](https://wixtoolset.org) **v3** is used to develop and build the
-Podman Windows installer. It's not required for the Podman Windows client.
-Version 3 of the WiX Toolset can be obtained from
-https://wixtoolset.org/docs/wix3/. Installing it into a clean VM might require
-an additional installation of .NET Framework 3.5 in advance
-([instructions for adding .NET Framework 3.5 via enabling the Windows feature](https://learn.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows#enable-the-net-framework-35-in-control-panel))
+[.NET SDK](https://learn.microsoft.com/en-us/dotnet/core/sdk), version 6 or
+later, is required to develop and build the Podman Windows installer. It's not
+required for the Podman Windows client.
+
+```pwsh
+winget install -e Microsoft.DotNet.SDK.8
+```
+
+[WiX Toolset](https://wixtoolset.org) **v5**, distributed as a .NET SDK tool, is
+used too and can be installed using `dotnet install`:
+
+```pwsh
+dotnet tool install --global wix
+```
 
 ### Virtualization Provider
 
@@ -304,9 +312,9 @@ The `installer` target of `winmake.ps1` runs the script
 
 - `build-hooks.bat`: builds `podman-wslkerninst.exe` (WSL kernel installer) and
   `podman-msihooks.dll` (helper that checks if WSL and Hyper-V are installed).
-- `build-msi.bat`: builds `podman.msi` from the WiX source files `podman.wxs`,
+- `dotnet build podman.wixproj`: builds `podman.msi` from the WiX source files `podman.wxs`,
   `pages.wxs`, `podman-ui.wxs` and `welcome-install-dlg.wxs`.
-- `build-burn.bat`: builds `podman-setup.exe` file from
+- `dotnet build podman-setup.wixproj`: builds `podman-setup.exe` file from
   [WiX Burn bundle](https://wixtoolset.org/docs/tools/burn/) `burn.wxs`.
 
 ### Test the Windows installer
@@ -340,21 +348,20 @@ Podman is released (it's included in the `podman-setup.exe` bundle), it can be
 faster to build and test that rather than the full bundle during the development
 phase.
 
-Run the script `contrib\win-installer\build-msi.bat` to build the standalone
-`podman.msi` file:
+Run the command `dotnet build` to build the standalone `podman.msi` file:
 
 ```pwsh
 Push-Location .\contrib\win-installer\
-.\build-msi.bat 9.9.9
+dotnet build podman.wixproj /property:DefineConstants="VERSION=9.9.9" -o .
 Pop-Location
 ```
 
-It creates the file `.\contrib\win-installer\podman.msi`. Test it using the
+It creates the file `.\contrib\win-installer\en-US\podman.msi`. Test it using the
 [Microsoft Standard Installer](https://learn.microsoft.com/en-us/windows/win32/msi/standard-installer-command-line-options)
 command line tool:
 
 ```pwsh
-msiexec /package contrib\win-installer\podman.msi /l*v podman-msi.log
+msiexec /package contrib\win-installer\en-US\podman.msi /l*v podman-msi.log
 ```
 
 To run it in quiet, non-interactive mode, open the terminal **as an
@@ -364,7 +371,7 @@ of the installation, `0` otherwise) and `WITH_HYPERV` (`1` to install Hyper-V as
 part of the installation, `0` otherwise):
 
 ```pwsh
-msiexec /package contrib\win-installer\podman.msi /l*v podman-msi.log /quiet MACHINE_PROVIDER=wsl WITH_WSL=0 WITH_HYPERV=0
+msiexec /package contrib\win-installer\en-US\podman.msi /l*v podman-msi.log /quiet MACHINE_PROVIDER=wsl WITH_WSL=0 WITH_HYPERV=0
 ```
 
 :information_source: `podman.msi` GUI dialogs, defined in the file
@@ -390,12 +397,12 @@ Test-Path -Path "$ENV:PROGRAMFILES\RedHat\Podman\podman.exe"
 # Check the generation of the podman configuration file
 Test-Path -Path "$ENV:PROGRAMDATA\containers\containers.conf.d\99-podman-machine-provider.conf"
 # Check that the installer configured the right provider
-Get-Content '$ENV:PROGRAMDATA\containers\containers.conf.d\99-podman-machine-provider.conf' | Select -Skip 1 | ConvertFrom-StringData | % { $_.provider }
+Get-Content "$ENV:PROGRAMDATA\containers\containers.conf.d\99-podman-machine-provider.conf" | Select -Skip 1 | ConvertFrom-StringData | % { $_.provider }
 # Check the creation of the registry key
 Test-Path -Path "HKLM:\SOFTWARE\Red Hat\Podman"
 Get-ItemProperty "HKLM:\SOFTWARE\Red Hat\Podman" InstallDir
 # Check the podman.exe is in the $PATH
-$env:PATH | Select-String -Pattern "$ENV:PROGRAMFILES\RedHat\Podman"
+$env:PATH | Select-String -Pattern "Podman"
 ```
 
 :information_source: Podman CI uses script

contrib/win-installer/build.ps1

@@ -151,16 +151,18 @@ if ($gvExists) {
 # } else {
 #     $env:IncludePolicyJSON = "Skip"
 # }
-& 'C:\Program Files\dotnet\dotnet.exe' build podman.wixproj --property:VERSION=$ENV:INSTVER -o .; ExitOnError
-Move-Item -Path .\en-US\podman.msi -Destination .\podman.msi
-SignItem @("podman.msi")
+if (Test-Path ./obj) {
+    Remove-Item ./obj -Recurse -Force -Confirm:$false
+}
+& 'C:\Program Files\dotnet\dotnet.exe' build podman.wixproj /property:DefineConstants="VERSION=$ENV:INSTVER" -o .; ExitOnError
+SignItem @("en-US\podman.msi")
 
-.\build-burn.bat $ENV:INSTVER; ExitOnError
-insignia -ib podman-setup.exe -o engine.exe; ExitOnError
+dotnet build podman-setup.wixproj /property:DefineConstants="VERSION=$ENV:INSTVER" -o .; ExitOnError
+wix burn detach podman-setup.exe -engine engine.exe; ExitOnError
 SignItem @("engine.exe")
 
 $file = "podman-$version$suffix-setup.exe"
-insignia -ab engine.exe podman-setup.exe -o $file; ExitOnError
+wix burn reattach -engine engine.exe podman-setup.exe -o $file; ExitOnError
 SignItem @("$file")
 
 if (Test-Path -Path shasums) {

contrib/win-installer/burn.wxs

@@ -0,0 +1,37 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" xmlns:bal="http://wixtoolset.org/schemas/v4/wxs/bal" xmlns:util="http://wixtoolset.org/schemas/v4/wxs/util">
+  <?ifndef var.VERSION?>
+     <?error VERSION must be defined via command line argument?>
+  <?endif?>
+  <Bundle Name="Podman" Version="$(var.VERSION)" Manufacturer="Red Hat" UpgradeCode="f3e1f40a-a791-49b7-9bc6-050975293353" IconSourceFile="resources\podman-logo.ico" Compressed="yes">
+    <BootstrapperApplication>
+      <bal:WixStandardBootstrapperApplication LicenseUrl="" Theme="hyperlinkSidebarLicense" ThemeFile="podman-theme.xml" LocalizationFile="podman-theme.wxl" LogoFile="resources\podman-banner2.png" LogoSideFile="resources\podman-sidebar.png" SuppressOptionsUI="yes" ShowVersion="yes" />
+    </BootstrapperApplication>
+    <Variable Name="InstallFolder" Type="formatted" Value="[ProgramFiles64Folder]RedHat\Podman" bal:Overridable="yes" />
+    <Variable Name="VERSION" Value="$(var.VERSION)" />
+    <Variable Name="MachineProvider" Type="string" Value="wsl" bal:Overridable="yes" />
+    <Variable Name="WSLCheckbox" Type="numeric" Value="1" bal:Overridable="yes" />
+    <Variable Name="HyperVCheckbox" Type="numeric" Value="0" bal:Overridable="yes" />
+    <Variable Name="AllowOldWin" Type="numeric" Value="0" bal:Overridable="yes" />
+    <Variable Name="LaunchTarget" Value="explorer.exe" />
+    <Variable Name="LaunchArguments" Value="&quot;[InstallFolder]\podman-for-windows.html&quot;" />
+    <Variable Name="SkipConfigFileCreation" Value="0" />
+
+    <util:RegistrySearch Id="PreviousVersionSearch" Variable="PreviousVersion" Result="value" Root="HKLM" Key="SOFTWARE\[WixBundleManufacturer]\Updates\[WixBundleName]" Value="PackageVersion" />
+    <util:RegistrySearch Id="PreviousInstallFolderSearch" Root="HKLM" Key="SOFTWARE\[WixBundleManufacturer]\[WixBundleName]" Value="InstallDir" Variable="PreviousInstallFolder" Bitness="always64" />
+    <util:DirectorySearch Path="[PreviousInstallFolder]" Variable="InstallFolder" After="PreviousInstallFolderSearch" Condition="PreviousInstallFolder" />
+    <util:RegistrySearch Id="CurrentBuild" Variable="CBNumber" Result="value" Root="HKLM" Key="SOFTWARE\Microsoft\Windows NT\CurrentVersion" Value="CurrentBuildNumber" />
+    <bal:Condition Message="Windows 10 (19041) or later is required to run this application." Condition="VersionNT &gt;= v10.0 AND (CBNumber &gt;= 19041 OR AllowOldWin = 1)" />
+    <bal:Condition Message="You have an installed development, pre-release version, or alternative build identifying as the same version of this installer. You must uninstall the existing version of Podman first, before proceeding." Condition="WixBundleInstalled OR WixBundleForcedRestartPackage OR PreviousVersion &lt;&gt; VERSION" />
+    <Chain>
+      <MsiPackage Id="Setup" SourceFile="en-US\podman.msi" Vital="yes">
+        <MsiProperty Name="INSTALLDIR" Value="[InstallFolder]" />
+        <MsiProperty Name="MACHINE_PROVIDER" Value="[MachineProvider]" />
+        <MsiProperty Name="WITH_WSL" Value="[WSLCheckbox]" />
+        <MsiProperty Name="WITH_HYPERV" Value="[HyperVCheckbox]" />
+        <MsiProperty Name="SKIP_CONFIG_FILE_CREATION" Value="[SkipConfigFileCreation]" />
+      </MsiPackage>
+      <ExePackage DisplayName="WSL Kernel Install" InstallCondition="(MachineProvider = &quot;wsl&quot;) AND (WSLCheckbox = 1)" SourceFile="artifacts\podman-wslkerninst.exe" DetectCondition="" Permanent="true" />
+    </Chain>
+    <OptionalUpdateRegistration />
+  </Bundle>
+</Wix>

contrib/win-installer/podman-setup.wixproj

@@ -0,0 +1,12 @@
+<Project Sdk="WixToolset.Sdk/5.0.0">
+    <PropertyGroup>
+		<InstallerPlatform>x64</InstallerPlatform>
+		<EnableDefaultCompileItems>false</EnableDefaultCompileItems>
+		<OutputType>Bundle</OutputType>
+	</PropertyGroup>
+	<ItemGroup>
+		<PackageReference Include="WixToolset.BootstrapperApplications.wixext" Version="5.0.0" />
+		<PackageReference Include="WixToolset.Util.wixext" Version="5.0.0" />
+		<Compile Include="burn.wxs" />
+	 </ItemGroup>
+</Project>

contrib/win-installer/podman-theme.wxl

@@ -1,18 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. -->
 
 
 <WixLocalization Culture="en-us" Language="1033" xmlns="http://wixtoolset.org/schemas/v4/wxl">
   <String Id="Caption" Value="[WixBundleName] [VERSION] Setup" />
   <String Id="Title" Value="[WixBundleName] [VERSION]" />
   <String Id="InstallHeader" Value="Welcome to [WixBundleName] Setup" />
-  <String Id="InstallMessage" Value="Welcome to the [WixBundleName] [VERSION] setup wizard. This will install [WixBundleName] on your computer. Additionally, you have the option to also install WSL (required by podman) if it is not already enabled. This operation requires a reboot during the installation process. Alternatively, you can deselect the WSL checkbox, and install WSL manually using the wsl --install command. Finally, click install to continue, or Close to abort the installation." />
+  <String Id="InstallMessage" Value="Welcome to the [WixBundleName] [VERSION] setup wizard. This will install [WixBundleName] on your computer.
+
+Additionally, you have the option to also install WSL (required by podman) if it is not already enabled. This operation requires a reboot during the installation process. Alternatively, you can deselect the WSL checkbox, and install WSL manually using the wsl --install command.
+
+Finally, click install to continue, or Close to abort the installation." />
   <String Id="InstallVersion" Value="Version [WixBundleVersion]" />
   <String Id="ConfirmCancelMessage" Value="Are you sure you want to cancel?" />
   <String Id="ExecuteUpgradeRelatedBundleMessage" Value="Previous version" />
   <String Id="HelpHeader" Value="Setup Help" />
-  <String Id="HelpText" Value="/install | /repair | /uninstall | /layout [directory] - installs, repairs, uninstalls or creates a complete local copy of the bundle in directory. Install is the default. /passive | /quiet - displays minimal UI with no prompts or displays no UI and no prompts. By default UI and all prompts are displayed. /norestart - suppress any attempts to restart. By default UI will prompt before restart. /log log.txt - logs to a specific file. By default a log file is created in %TEMP%." />
+  <String Id="HelpText" Value="/install | /repair | /uninstall | /layout [directory] - installs, repairs, uninstalls or
+   creates a complete local copy of the bundle in directory. Install is the default.
+
+/passive | /quiet -  displays minimal UI with no prompts or displays no UI and
+   no prompts. By default UI and all prompts are displayed.
+
+/norestart   - suppress any attempts to restart. By default UI will prompt before restart.
+/log log.txt - logs to a specific file. By default a log file is created in %TEMP%." />
   <String Id="HelpCloseButton" Value="&amp;Close" />
-  <String Id="InstallLicenseLinkText" Value="[WixBundleName] &lt;a href=&quot;#&quot;&gt;license terms&lt;/a&gt;." />
+  <String Id="InstallLicenseLinkText" Value='[WixBundleName] &lt;a href="#"&gt;license terms&lt;/a&gt;.' />
   <String Id="InstallAcceptCheckbox" Value="I &amp;agree to the license terms and conditions" />
   <String Id="InstallOptionsButton" Value="&amp;Options" />
   <String Id="InstallInstallButton" Value="&amp;Install" />
@@ -42,7 +54,7 @@
   <String Id="FailureInstallHeader" Value="Setup Failed" />
   <String Id="FailureUninstallHeader" Value="Uninstall Failed" />
   <String Id="FailureRepairHeader" Value="Repair Failed" />
-  <String Id="FailureHyperlinkLogText" Value="One or more issues caused the setup to fail. Please fix the issues and then retry setup. For more information see the &lt;a href=&quot;#&quot;&gt;log file&lt;/a&gt;." />
+  <String Id="FailureHyperlinkLogText" Value='One or more issues caused the setup to fail. Please fix the issues and then retry setup. For more information see the &lt;a href="#"&gt;log file&lt;/a&gt;.' />
   <String Id="FailureRestartText" Value="You must restart your computer to complete the rollback of the software." />
   <String Id="FailureRestartButton" Value="&amp;Restart" />
   <String Id="FailureCloseButton" Value="&amp;Close" />