Skip to content

Miscellaneous improvements to MSI installers. #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhsmith merged 1 commit into from
May 29, 2026
Merged

Miscellaneous improvements to MSI installers. #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion {{ cookiecutter.format }}/extras/{{ cookiecutter.installer_path }}/run_post_install.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
setlocal enabledelayedexpansion
SET ALLUSERS=%1
SET INSTALLER_PATH=%2
SET INSTALLER_UNATTENDED=%3
{% for name in cookiecutter.install_options -%}
{%- set argn = loop.index + 2 -%}
{%- set argn = loop.index + 3 -%}
SET OPTION_{{ name.upper() }}=%{{ argn }}
{% endfor -%}

Expand Down
4 changes: 3 additions & 1 deletion {{ cookiecutter.format }}/extras/{{ cookiecutter.installer_path }}/run_pre_uninstall.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
@echo off
setlocal enabledelayedexpansion
SET INSTALLER_UNATTENDED=%1
{% for name in cookiecutter.uninstall_options -%}
SET OPTION_{{ name.upper() }}=%{{ loop.index }}
{%- set argn = loop.index + 1 -%}
SET OPTION_{{ name.upper() }}=%{{ argn }}
{% endfor -%}

CALL "%~dp0pre_uninstall.bat"
186 changes: 165 additions & 21 deletions {{ cookiecutter.format }}/{{ cookiecutter.app_name }}.wxs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,17 @@
Sequence="execute"
Condition="ALLUSERS = 1" />

<!--
If the installer is running in "quiet" mode (UILevel < 3), it must be treated as unattended.
-->
<Property Id="INSTALL_UNATTENDED" Value="0"/>
<SetProperty
Id="INSTALL_UNATTENDED"
Value="1"
After="CostFinalize"
Sequence="execute"
Condition="UILevel &lt; 3" />

{% if cookiecutter.console_app %}
<!-- If a Level evaluates to 0 at the start of either the UI or the execution
phase, then the feature cannot be re-enabled by any means, not even the ADDLOCAL
Expand Down Expand Up @@ -321,6 +332,82 @@
Size="!(loc.Advanced_Font_Emphasized_Size)"
Bold="yes" />
<Property Id="DefaultUIFont" Value="WixUI_Font_Normal" />

<!-- Define a custom InstallDirDlg so we can add a "Disk Usage" button
to the bottom button row. The layout is otherwise identical to
the standard InstallDirDlg -->
<Dialog
Id="CustomInstallDirDlg"
Width="370" Height="270"
Title="!(loc.InstallDirDlg_Title)">

<Control
Id="BannerBitmap"
Type="Bitmap"
X="0" Y="0" Width="370" Height="44"
TabSkip="no"
Text="!(loc.InstallDirDlgBannerBitmap)" />
<Control
Id="Title"
Type="Text"
X="15" Y="6" Width="200" Height="15"
Transparent="yes"
NoPrefix="yes"
Text="!(loc.InstallDirDlgTitle)" />
<Control
Id="Description"
Type="Text"
X="25" Y="23" Width="280" Height="15"
Transparent="yes"
NoPrefix="yes"
Text="!(loc.InstallDirDlgDescription)" />
<Control Id="BannerLine" Type="Line" X="0" Y="44" Width="373" Height="0" />

<Control
Id="FolderLabel"
Type="Text"
X="20" Y="60" Width="290" Height="30"
NoPrefix="yes"
Text="!(loc.InstallDirDlgFolderLabel)" />
<Control
Id="Folder"
Type="PathEdit"
X="20" Y="100" Width="320" Height="18"
Property="WIXUI_INSTALLDIR"
Indirect="yes" />
<Control
Id="ChangeFolder"
Type="PushButton"
X="20" Y="120" Width="56" Height="17"
Text="!(loc.InstallDirDlgChange)" />

<Control Id="BottomLine" Type="Line" X="0" Y="234" Width="373" Height="0" />
<Control
Id="DiskUsage"
Type="PushButton"
X="112" Y="243" Width="56" Height="17"
Text="Disk &amp;Usage" />
<Control
Id="Back"
Type="PushButton"
X="180" Y="243" Width="56" Height="17"
Text="!(loc.WixUIBack)" />
<Control
Id="Next"
Type="PushButton"
X="236" Y="243" Width="56" Height="17"
Default="yes"
Text="!(loc.WixUINext)" />
<Control
Id="Cancel"
Type="PushButton"
X="304" Y="243" Width="56" Height="17"
Cancel="yes"
Text="!(loc.WixUICancel)">
<Publish Event="SpawnDialog" Value="CancelDlg" />
</Control>
</Dialog>

{% if cookiecutter.install_options %}
<!-- Define the custom Install Options dialog -->
<Dialog
Expand Down Expand Up @@ -531,20 +618,20 @@
Dialog="LicenseAgreementDlg"
Control="Next"
Event="NewDialog"
Value="InstallDirDlg"
Value="CustomInstallDirDlg"
Condition='LicenseAccepted = "1"'/>

<!-- Install Dir -->
<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="Back"
Event="NewDialog"
Value="LicenseAgreementDlg" />

{% if cookiecutter.install_options %}

<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="Next"
Event="NewDialog"
Value="InstallOptionsDlg" />
Expand All @@ -554,7 +641,7 @@
Dialog="InstallOptionsDlg"
Control="Back"
Event="NewDialog"
Value="InstallDirDlg" />
Value="CustomInstallDirDlg" />
<Publish
Dialog="InstallOptionsDlg"
Control="Next"
Expand All @@ -572,7 +659,7 @@
{% else %}

<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="Next"
Event="NewDialog"
Value="VerifyReadyDlg" />
Expand All @@ -582,7 +669,7 @@
Dialog="VerifyReadyDlg"
Control="Back"
Event="NewDialog"
Value="InstallDirDlg"
Value="CustomInstallDirDlg"
Order="1"
Condition="NOT Installed" />
{% endif %}
Expand Down Expand Up @@ -672,20 +759,20 @@
Dialog="InstallScopeDlg"
Control="Next"
Event="NewDialog"
Value="InstallDirDlg"
Value="CustomInstallDirDlg"
Order="99"/>

<!-- Install Dir -->
<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="Back"
Event="NewDialog"
Value="InstallScopeDlg" />

{% if cookiecutter.install_options %}

<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="Next"
Event="NewDialog"
Value="InstallOptionsDlg" />
Expand All @@ -695,7 +782,7 @@
Dialog="InstallOptionsDlg"
Control="Back"
Event="NewDialog"
Value="InstallDirDlg" />
Value="CustomInstallDirDlg" />
<Publish
Dialog="InstallOptionsDlg"
Control="Next"
Expand All @@ -712,7 +799,7 @@
Condition="NOT Installed" />
{% else %}
<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="Next"
Event="NewDialog"
Value="VerifyReadyDlg"
Expand All @@ -723,7 +810,7 @@
Dialog="VerifyReadyDlg"
Control="Back"
Event="NewDialog"
Value="InstallDirDlg"
Value="CustomInstallDirDlg"
Order="1"
Condition="NOT Installed" />
{% endif %}
Expand All @@ -732,18 +819,24 @@
<!-- Display the BrowseDlg when the "Change" button on InstallDirDlg
is pressed. -->
<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="ChangeFolder"
Event="[_BrowseProperty]"
Value="[WIXUI_INSTALLDIR]"
Order="1"/>
<Publish
Dialog="InstallDirDlg"
Dialog="CustomInstallDirDlg"
Control="ChangeFolder"
Event="SpawnDialog"
Value="BrowseDlg"
Order="2"/>

<!-- Display the standard DiskCostDlg (provided by WixUI_Common)
when the "Disk Usage" button on CustomInstallDirDlg is pressed. -->
<Publish
Dialog="CustomInstallDirDlg"
Control="DiskUsage"
Event="SpawnDialog"
Value="DiskCostDlg" />

<!-- Define the workflow through the uninstall dialogs.

Expand Down Expand Up @@ -822,29 +915,80 @@
<!-- Post-install and Pre-uninstall scripts -->
<!-- Execute="deferred" runs in server process where Impersonate="no" takes effect -->
<!-- This ensures scripts run with elevated privileges for per-machine installs -->
<SetProperty
Id="POST_INSTALL_CMD"
Value="&quot;[SystemFolder]cmd.exe&quot; /c &quot;&quot;[INSTALLFOLDER]{{ cookiecutter.installer_path }}\run_post_install.bat&quot; [OPTION_ALLUSERS] &quot;[OriginalDatabase]&quot; [INSTALL_UNATTENDED]{% for name in cookiecutter.install_options %} [OPTION_{{ name.upper() }}]{% endfor %}&quot;"
After="CostFinalize"
Sequence="execute"
Condition="NOT Installed" />

<CustomAction
Id="PostInstallAction"
Id="PostInstallActionInteractive"
Directory="INSTALLFOLDER"
ExeCommand="[SystemFolder]cmd.exe /c &quot;&quot;[INSTALLFOLDER]{{ cookiecutter.installer_path }}\run_post_install.bat&quot; [OPTION_ALLUSERS] &quot;[OriginalDatabase]&quot;{% for name in cookiecutter.install_options %} [OPTION_{{ name.upper() }}]{% endfor %}&quot;"
ExeCommand="[POST_INSTALL_CMD]"
Execute="deferred"
Return="check"
Impersonate="no"/>

<CustomAction
Id="SetPostInstallQuietCmd"
Property="PostInstallActionQuiet"
Value="[POST_INSTALL_CMD]"
Execute="immediate"/>

<CustomAction
Id="PostInstallActionQuiet"
BinaryRef="Wix4UtilCA_$(sys.BUILDARCHSHORT)"
DllEntry="WixQuietExec"
Execute="deferred"
Return="check"
Impersonate="no"/>
{% endif %}
{% if cookiecutter.pre_uninstall_script %}
<SetProperty
Id="PRE_UNINSTALL_CMD"
Value="&quot;[SystemFolder]cmd.exe&quot; /c &quot;&quot;[INSTALLFOLDER]{{ cookiecutter.installer_path }}\run_pre_uninstall.bat&quot; [INSTALL_UNATTENDED]{% for name in cookiecutter.uninstall_options %} [OPTION_{{ name.upper() }}]{% endfor %}&quot;"
After="CostFinalize"
Sequence="execute"
Condition='REMOVE="ALL"' />

<CustomAction
Id="PreUninstallAction"
Id="PreUninstallActionInteractive"
Directory="INSTALLFOLDER"
ExeCommand="[SystemFolder]cmd.exe /c &quot;&quot;[INSTALLFOLDER]{{ cookiecutter.installer_path }}\run_pre_uninstall.bat&quot;{% for name in cookiecutter.uninstall_options %} [OPTION_{{ name.upper() }}]{% endfor %}&quot;"
ExeCommand="[PRE_UNINSTALL_CMD]"
Execute="deferred"
Return="check"
Impersonate="no"/>

<CustomAction
Id="SetPreUninstallQuietCmd"
Property="PreUninstallActionQuiet"
Value="[PRE_UNINSTALL_CMD]"
Execute="immediate"/>
<CustomAction
Id="PreUninstallActionQuiet"
BinaryRef="Wix4UtilCA_$(sys.BUILDARCHSHORT)"
DllEntry="WixQuietExec"
Execute="deferred"
Return="check"
Impersonate="no"/>
{% endif %}
<InstallExecuteSequence>
{% if cookiecutter.post_install_script %}
<Custom Action="PostInstallAction" Before="InstallFinalize" Condition="NOT Installed" />
<!-- Interactive install -->
<Custom Action="PostInstallActionInteractive" Before="InstallFinalize" Condition='NOT Installed AND INSTALL_UNATTENDED = "0"' />

<!-- Quiet install -->
<Custom Action="SetPostInstallQuietCmd" Before="PostInstallActionQuiet" Condition='NOT Installed AND INSTALL_UNATTENDED = "1"' />
<Custom Action="PostInstallActionQuiet" Before="InstallFinalize" Condition='NOT Installed AND INSTALL_UNATTENDED = "1"' />
{% endif %}
{% if cookiecutter.pre_uninstall_script %}
<Custom Action="PreUninstallAction" After="InstallInitialize" Condition='REMOVE="ALL"'/>
<!-- Interactive uninstall -->
<Custom Action="PreUninstallActionInteractive" After="InstallInitialize" Condition='REMOVE="ALL" AND INSTALL_UNATTENDED = "0"' />

<!-- Quiet uninstall -->
<Custom Action="SetPreUninstallQuietCmd" Before="PreUninstallActionQuiet" Condition='REMOVE="ALL" AND INSTALL_UNATTENDED = "1"' />
<Custom Action="PreUninstallActionQuiet" After="InstallInitialize" Condition='REMOVE="ALL" AND INSTALL_UNATTENDED = "1"' />
{% endif %}
</InstallExecuteSequence>
</Package>
Expand Down