]> asedeno.scripts.mit.edu Git - PuTTY.git/commitdiff
New Windows installer system, using WiX to build an MSI.
authorSimon Tatham <anakin@pobox.com>
Wed, 9 Mar 2016 20:44:19 +0000 (20:44 +0000)
committerSimon Tatham <anakin@pobox.com>
Wed, 9 Mar 2016 20:55:38 +0000 (20:55 +0000)
Mostly this is a reaction to the reports of Inno Setup having a DLL
hijacking vulnerability. But also, the new installer has several other
nice features that our Inno Setup one didn't provide: it can put the
PuTTY install directory on PATH automatically, and it supports
completely automatic and silent install/uninstall via 'msiexec /q'
which should make it easier for sysadmins to roll out installation in
large organisations. Also, it just seems like good sense to be using
Windows's own native packaging system (or closest equivalent) rather
than going it alone.

(And on the developer side, I have to say I like the fact that WiX
lets me pass in the version number as a set of command-line #define-
equivalents, whereas for Inno Setup I had to have Buildscr apply Perl
rewriting to the source file.)

For the moment, I'm still building the old Inno Setup installer
alongside this one, but I expect to retire it once the WiX one has
survived in the wild for a while and proven itself more or less
stable.

I've found both MSI and WiX to be confusing and difficult
technologies, so this installer has some noticeable pieces missing
(e.g. retrospective reconfiguration of the installed feature set, and
per-user vs systemwide installation) simply because I couldn't get
them to work. I've commented the new installer source code heavily, in
the hope that a passing WiX expert can give me a hand!

Buildscr
sign.sh
windows/installer.wxs [new file with mode: 0644]

index 2a58507cba6d1ac64e8beea01a675a63a9f049f8..6e2bbc3b70481c21559063abe40455fde828492c 100644 (file)
--- a/Buildscr
+++ b/Buildscr
@@ -80,11 +80,12 @@ ifneq "$(PRERELEASE)" "" set Autoconfver $(PRERELEASE)~pre$(Ndate).$(vcsid)
 ifneq "$(SNAPSHOT)" "" set Autoconfver $(Lastver)-$(Date).$(vcsid)
 ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Autoconfver Custom.$(Date).$(vcsid)
 
-# Set up the filename for the Windows installer.
-ifneq "$(RELEASE)" "" set Ifilename putty-$(RELEASE)-installer.exe
-ifneq "$(PRERELEASE)" "" set Ifilename putty-$(PRERELEASE)-pre$(Ndate)-installer.exe
-ifneq "$(SNAPSHOT)" "" set Ifilename putty-$(Date)-installer.exe
-ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Ifilename putty-custom-$(Date)-installer.exe
+# Set up the filename for the Windows installer (minus extension,
+# which goes on later).
+ifneq "$(RELEASE)" "" set Ifilename putty-$(RELEASE)-installer
+ifneq "$(PRERELEASE)" "" set Ifilename putty-$(PRERELEASE)-pre$(Ndate)-installer
+ifneq "$(SNAPSHOT)" "" set Ifilename putty-$(Date)-installer
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Ifilename putty-custom-$(Date)-installer
 
 # Set up the version string for the Windows installer.
 ifneq "$(RELEASE)" "" set Iversion $(RELEASE)
@@ -148,24 +149,41 @@ in putty/windows do perl -i~ -pe 'BEGIN{$$a=shift@ARGV;}s/^(VersionInfoVersion=)
 # Windowsify LICENCE, since it's going in the Windows installer.
 in putty do perl -i~ -pe 'y/\015//d;s/$$/\015/' LICENCE
 
+# Some gratuitous theming for the MSI installer UI.
+in putty/icons do make
+in putty do convert -size 164x312 'gradient:blue-white' -distort SRT -90 -swirl 180 \( -size 329x312 canvas:white \) +append \( icons/putty-48.png -geometry +28+24 \) -composite \( icons/pscp-48.png -geometry +88+96 \) -composite \( icons/puttygen-48.png -geometry +28+168 \) -composite \( icons/pageant-48.png -geometry +88+240 \) -composite windows/msidialog.bmp
+in putty do convert -size 493x58 canvas:white \( icons/putty-48.png -geometry +440+5 \) -composite windows/msibanner.bmp
+
 delegate windows
-  # FIXME: Cygwin alternative?
+  # Build the main binaries.
   in putty/windows with visualstudio do/win nmake -f Makefile.vc $(Makeargs) all cleantestprogs
+
   # Code-sign the binaries, if the local bob config provides a script
   # to do so. We assume here that the script accepts an -i option to
   # provide a 'more info' URL, and an optional -n option to provide a
   # program name, and that it can take multiple .exe filename
   # arguments and sign them all in place.
   ifneq "$(winsigncode)" "" in putty/windows do $(winsigncode) -i http://www.chiark.greenend.org.uk/~sgtatham/putty/ *.exe
+
   # Ignore exit code from hhc, in favour of seeing whether the .chm
   # file was created. (Yuck; but hhc appears to return non-zero
   # exit codes on whim.)
   in putty/doc with htmlhelp do/win hhc putty.hhp & type putty.chm >nul
+
+  # Build the WiX MSI installer.
+  in putty/windows with wix do/win candle -dWinver="$(Winver)" -dPuttytextver="$(Puttytextver)" installer.wxs && light -ext WixUIExtension -sval installer.wixobj
+
+  # Build the old Inno Setup installer.
   in putty/windows with innosetup do/win iscc putty.iss
-  ifneq "$(winsigncode)" "" in putty/windows do $(winsigncode) -i http://www.chiark.greenend.org.uk/~sgtatham/putty/ -n "PuTTY Installer" Output/setup.exe
+
+  # Sign the installers.
+  ifneq "$(winsigncode)" "" in putty/windows do $(winsigncode) -i http://www.chiark.greenend.org.uk/~sgtatham/putty/ -n "PuTTY Installer" installer.msi Output/setup.exe
+
+  # Finished Windows builds.
   return putty/windows/*.exe
   return putty/windows/*.map
   return putty/doc/putty.chm
+  return putty/windows/installer.msi
   return putty/windows/Output/setup.exe
 enddelegate
 in putty/doc do make mostlyclean
@@ -176,7 +194,8 @@ in putty/doc do zip puttydoc.zip *.html
 # Deliver the actual PuTTY release directory into a subdir `putty'.
 deliver putty/windows/*.exe putty/x86/$@
 deliver putty/windows/putty.zip putty/x86/$@
-deliver putty/windows/Output/setup.exe putty/x86/$(Ifilename)
+deliver putty/windows/installer.msi putty/x86/$(Ifilename).msi
+deliver putty/windows/Output/setup.exe putty/x86/$(Ifilename).exe
 deliver putty/doc/puttydoc.zip putty/$@
 deliver putty/doc/putty.chm putty/$@
 deliver putty/doc/putty.hlp putty/$@
@@ -210,5 +229,5 @@ in-dest putty do echo "AddType application/octet-stream .chm" >> .htaccess
 in-dest putty do echo "AddType application/octet-stream .hlp" >> .htaccess
 in-dest putty do echo "AddType application/octet-stream .cnt" >> .htaccess
 in-dest putty do set -- putty*.tar.gz; for k in '' .gpg; do echo RedirectMatch temp '(.*/)'putty.tar.gz$$k\$$ '$$1'"$$1$$k" >> .htaccess; done
-# And one in the x86 directory, providing a link for the installer.
-in-dest putty/x86 do set -- putty*installer.exe; for k in '' .gpg; do echo RedirectMatch temp '(.*/)'putty-installer.exe$$k\$$ '$$1'"$$1$$k" >> .htaccess; done
+# And one in the x86 directory, providing links for the installers.
+in-dest putty/x86 do for ext in msi exe; do set -- putty*installer.$$ext; for k in '' .gpg; do echo RedirectMatch temp '(.*/)'putty-installer.$$ext$$k\$$ '$$1'"$$1$$k" >> .htaccess; done; done
diff --git a/sign.sh b/sign.sh
index ea63b4bf015ae01804e502eb2e63d35d82fb8ded..887704751ff296b00268d11f21b1e9410ec5229f 100755 (executable)
--- a/sign.sh
+++ b/sign.sh
@@ -27,7 +27,7 @@ sign() {
 
 cd "$1"
 echo "===== Signing with key '$keyname'"
-for i in putty*src.zip putty*.tar.gz x86/*.exe x86/*.zip; do
+for i in putty*src.zip putty*.tar.gz x86/*.exe x86/*.zip x86/*.msi; do
     sign --detach-sign "$i" "$i.gpg"
 done
 for i in md5sums sha1sums sha256sums sha512sums; do
diff --git a/windows/installer.wxs b/windows/installer.wxs
new file mode 100644 (file)
index 0000000..7be9777
--- /dev/null
@@ -0,0 +1,452 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- WiX source code for the PuTTY installer. -->
+
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+
+  <!--
+      Product tag. The Id component is set to "*", which causes WiX to
+      make up a new GUID every time it's run, whereas UpgradeCode is
+      set to a fixed GUID. This combination allows Windows to
+      recognise each new PuTTY installer as different (because of Id)
+      versions of the same underlying thing (because of the common
+      UpgradeCode).
+
+      $(var.Winver) is define on candle.exe's command line by the
+      build script, and is expected to be a dotted tuple of four
+      16-bit decimal integers (similar to a Windows VERSIONINFO
+      resource). For PuTTY's particular conventions, see comment in
+      Buildscr.
+  -->
+  <Product
+      Name="PuTTY"
+      Manufacturer="Simon Tatham"
+      Id="*"
+      UpgradeCode="dce70c63-8808-4646-b16b-a677bd298385"
+      Language="1033" Codepage="1252" Version="$(var.Winver)">
+
+    <!--
+        We force the install scope to perMachine, largely because I
+        don't really understand how to make it usefully switchable
+        between the two. If anyone is a WiX expert and does want to
+        install PuTTY locally in a user account, I hope they'll send a
+        well explained patch!
+
+        $(var.Puttytextver) is again defined on the candle command
+        line, and describes the version of PuTTY in human-readable
+        form, e.g. "PuTTY 0.67" or "PuTTY development snapshot [foo]".
+    -->
+    <Package Id="*" Keywords="Installer"
+             Description="$(var.Puttytextver) installer"
+             Manufacturer="Simon Tatham"
+             InstallerVersion="100" Languages="1033"
+             Compressed="yes" SummaryCodepage="1252"
+             InstallScope="perMachine" />
+
+    <!--
+        Permit installing an arbitrary one of these PuTTY installers
+        over the top of an existing one, whether it's an upgrade or a
+        downgrade. In particular, this makes it easy to switch between
+        trunk development snapshots and a release or prerelease, in
+        cases where you change your mind about whether you want the
+        features or the stability.
+
+        Setting the REINSTALLMODE property to "amus" (from its default
+        of "omus") forces every component replaced by a different
+        version of the installer to be _actually_ reinstalled; the 'o'
+        flag in the default setting breaks the downgrade case by
+        causing Windows to disallow installation of an older version
+        over the top of a newer one - and to do so _silently_, so the
+        installer claims to have worked fine but putty.exe isn't
+        there.
+    -->
+    <MajorUpgrade AllowDowngrades="yes" MigrateFeatures="yes" />
+    <Property Id="REINSTALLMODE" Value="amus"/>
+
+    <!-- Boilerplate -->
+    <Media Id="1" Cabinet="putty.cab" EmbedCab="yes" />
+
+    <!--
+        The actual directory structure and list of 'components'
+        (individual files or shortcuts or additions to PATH) that are
+        installed.
+
+        We install directly under "Program Files\PuTTY" rather than
+        the recommended three-level pathname including a manufacturer.
+        It's bad enough that I put my name irrevocably in everyone's
+        Registry without putting it in all of their filesystems as
+        well...
+    -->
+    <Directory Id="TARGETDIR" Name="SourceDir">
+      <Directory Id="ProgramFilesFolder" Name="PFiles">
+        <Directory Id="INSTALLDIR" Name="PuTTY">
+
+          <!--
+              The following components all install things in the main
+              install directory (implicitly, by being nested where
+              they are in the XML structure). Most of them also put a
+              shortcut in a subdir of the Start menu, though some of
+              the more obscure things like LICENCE are just there for
+              the sake of being _somewhere_ and don't rate a shortcut.
+          -->
+          <Component Id="PuTTY_Component"
+                     Guid="07ACF511-6DF6-4883-AABA-33BC14901324">
+            <File Id="PuTTY_File"
+                  Source="putty.exe" KeyPath="yes">
+              <Shortcut Id="startmenuPuTTY" Directory="ProgramMenuDir"
+                        WorkingDirectory="INSTALLDIR"
+                        Name="PuTTY" Advertise="no" />
+            </File>
+          </Component>
+          <Component Id="Pageant_Component"
+                     Guid="649F963E-21C4-4755-8CE4-D80598DCEE6D">
+            <File Id="Pageant_File"
+                  Source="pageant.exe" KeyPath="yes">
+              <Shortcut Id="startmenuPageant" Directory="ProgramMenuDir"
+                        WorkingDirectory="INSTALLDIR"
+                        Name="Pageant" Advertise="no" />
+            </File>
+          </Component>
+          <Component Id="PSFTP_Component"
+                     Guid="3D7B9536-EC0E-4A6A-A3DF-8D285474391A">
+            <File Id="PSFTP_File"
+                  Source="psftp.exe" KeyPath="yes">
+              <Shortcut Id="startmenuPSFTP" Directory="ProgramMenuDir"
+                        WorkingDirectory="INSTALLDIR"
+                        Name="PSFTP" Advertise="no" />
+            </File>
+          </Component>
+          <Component Id="PuTTYgen_Component"
+                     Guid="4774F6B3-8A07-42A5-9F4D-E7FE6AA78B84">
+            <File Id="PuTTYgen_File"
+                  Source="puttygen.exe" KeyPath="yes">
+              <Shortcut Id="startmenuPuTTYgen" Directory="ProgramMenuDir"
+                        WorkingDirectory="INSTALLDIR"
+                        Name="PuTTYgen" Advertise="no" />
+            </File>
+          </Component>
+          <Component Id="Plink_Component"
+                     Guid="7D96F9BB-4154-49D6-86AE-0D8F1379ACBC">
+            <File Id="Plink_File"
+                  Source="plink.exe" KeyPath="yes" />
+          </Component>
+          <Component Id="PSCP_Component"
+                     Guid="71519D4A-3ED5-4A46-A7E4-B6E4600A8684">
+            <File Id="PSCP_File"
+                  Source="pscp.exe" KeyPath="yes" />
+          </Component>
+
+          <Component Id="HelpFile_Component"
+                     Guid="72806A73-9D4D-49BF-8CAA-E90B0D83AEED">
+            <File Id="HelpFile_File"
+                  Source="..\doc\putty.chm" KeyPath="yes">
+              <Shortcut Id="startmenuManual" Directory="ProgramMenuDir"
+                        Name="PuTTY Manual"
+                        Advertise="no" />
+            </File>
+          </Component>
+          <Component Id="Website_Component"
+                     Guid="7DAD6536-C1A7-430C-BC8A-90176CCB78D0">
+            <File Id="Website_File"
+                  Source="website.url" KeyPath="yes">
+              <Shortcut Id="startmenuWebsite" Directory="ProgramMenuDir"
+                        Name="PuTTY Web Site"
+                        Advertise="no" />
+            </File>
+          </Component>
+          <Component Id="LICENCE_Component"
+                     Guid="6AB710C0-F7A1-4B7A-AC2E-6993D6E98332">
+            <File Id="LICENCE_File"
+                  Source="..\LICENCE" KeyPath="yes" />
+          </Component>
+          <Component Id="README_Component"
+                     Guid="0AB63F2A-0FD9-4961-B8F7-AB85C22D9986">
+            <File Id="README_File"
+                  Source="README.txt" KeyPath="yes" />
+          </Component>
+
+          <!--
+              This component sets up the file associations for the
+              .ppk private key file extension: right-clicking should
+              give options to launch both Pageant and PuTTYgen with a
+              given key.
+
+              Unlike all the above components, this one also puts a
+              registry entry in HKEY_LOCAL_MACHINE, which is the 'key
+              path' for the component, i.e. the thing Windows checks
+              to know whether this component is installed. Those have
+              to be either files or registry entries; so for all the
+              above things the key paths are the actual files we
+              wanted to install, whereas for this one we have to
+              invent a spurious extra thing to be the key path.
+          -->
+          <Component Id="PPK_Assoc_Component"
+                     Guid="13BBF036-F4C0-4F5B-9167-7BA35C673AAB">
+            <ProgId Id="PPK_Assoc_ProgId"
+                    Description="PuTTY Private Key File">
+              <Extension Id="ppk"
+                         ContentType="application/x-putty-private-key">
+                <Verb Id="open" Command="Load into Pageant"
+                      TargetFile="Pageant_File" Argument='"%1"'/>
+                <Verb Id="edit" Command="Edit with PuTTYgen"
+                      TargetFile="PuTTYgen_File" Argument='"%1"' />
+              </Extension>
+            </ProgId>
+            <RegistryValue Root="HKLM"
+                           Key="Software\SimonTatham\PuTTY\PPKAssociation"
+                           Type="string" Value="" KeyPath="yes" />
+          </Component>
+
+          <!--
+              This component appends the install directory to PATH, so
+              that command prompt windows automatically get the
+              ability to run the command-line utilities (PSCP, PSFTP
+              and Plink, though all the others are available too if
+              you want). Again, it needs a pointless registry entry to
+              act as a key path.
+          -->
+          <Component Id="Path_Component"
+                     Guid="D1F68AAA-D20D-4047-828F-D0AC443FAF64">
+            <Environment Id="Path_Environment"
+                         Name="PATH"
+                         Value="[INSTALLDIR]"
+                         Permanent="no"
+                         Part="last"
+                         Action="set"
+                         System="yes"/>
+            <RegistryValue Root="HKLM"
+                           Key="Software\SimonTatham\PuTTY\PathEntry"
+                           Type="string" Value="" KeyPath="yes" />
+          </Component>
+        </Directory>
+      </Directory>
+
+      <!--
+          This component doesn't actually install anything, but it
+          arranges for the Start Menu _directory_ to be removed again
+          on uninstall. All the actual shortcuts inside the directory
+          are placed by code above here.
+      -->
+      <Directory Id="ProgramMenuFolder" Name="Programs">
+        <Directory Id="ProgramMenuDir" Name="PuTTY">
+          <Component Id="ProgramMenuDir"
+                     Guid="C12C3BB3-EC24-4883-8349-4AC8017C9E6A">
+            <RemoveFolder Id="ProgramMenuDir" On="uninstall" />
+            <RegistryValue Root="HKLM"
+                           Key="Software\SimonTatham\PuTTY\StartMenu"
+                           Type="string" Value="" KeyPath="yes" />
+          </Component>
+        </Directory>
+      </Directory>
+
+      <!--
+          This component puts a shortcut to PuTTY itself on the
+          desktop.
+      -->
+      <Directory Id="DesktopFolder" Name="Desktop">
+        <Component Id="Desktop_Shortcut_Component"
+                   Guid="D039E3D1-CE42-488D-96CC-90E1DE3796F8">
+          <Shortcut Id="DesktopPuTTY"
+                    WorkingDirectory="INSTALLDIR" Target="[INSTALLDIR]putty.exe"
+                    Name="PuTTY" Advertise="no" />
+          <RegistryValue Root="HKLM"
+                         Key="Software\SimonTatham\PuTTY\DesktopEntry"
+                         Type="string" Value="" KeyPath="yes" />
+        </Component>
+      </Directory>
+    </Directory>
+
+    <!--
+        Detect an installation of PuTTY made by the old Inno Setup
+        installer, and refuse to run if we find one. I don't know what
+        would happen if you tried anyway, but since they install files
+        at the same pathnames, it surely wouldn't end well.
+
+        It could be argued that a better approach would be to actually
+        _launch_ the Inno Setup uninstaller automatically at this
+        point (prompting the user first, of course), but I'm not
+        nearly skilled enough with WiX to know how, or even if it's
+        feasible.
+    -->
+    <Property Id="LEGACYINNOSETUPINSTALLERNATIVE32PROPERTY">
+      <RegistrySearch
+          Id="LegacyInnoSetupInstallerNative32RegSearch"
+          Root="HKLM"
+          Key="SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\PuTTY_is1"
+          Name="QuietUninstallString" Type="raw" />
+    </Property>
+    <Property Id="LEGACYINNOSETUPINSTALLER32ON64PROPERTY">
+      <RegistrySearch
+          Id="LegacyInnoSetupInstaller32On64RegSearch"
+          Root="HKLM"
+          Key="SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\PuTTY_is1"
+          Name="QuietUninstallString" Type="raw" />
+    </Property>
+    <Condition Message="A version of PuTTY is already installed on this system using the old Inno Setup installer. Please uninstall that before running the new installer.">
+      <![CDATA[Installed OR
+               (LEGACYINNOSETUPINSTALLERNATIVE32PROPERTY = "" AND
+                LEGACYINNOSETUPINSTALLER32ON64PROPERTY = "")]]>
+    </Condition>
+
+    <!--
+        Separate the installation into 'features', which are parts of
+        the install that can be chosen separately.
+
+        Since PuTTY is tiny, I haven't bothered to separate the actual
+        _files_ into features; I've just put them all in a single
+        feature that's always installed. The only features that are
+        separately disableable are the auxiliary ones for desktop
+        shortcuts, .PPK file extension and modifying PATH.
+
+        (And even those are mostly historical - the first two were
+        checkbox options in Inno Setup, and the third was not done at
+        all by Inno Setup so people might be surprised by it when
+        switching to this installer. I don't actually know for sure
+        that anyone _wants_ to be without these pieces. So all of them
+        are enabled by default.)
+    -->
+    <Feature Id="FilesFeature" Level="1" Absent="disallow" AllowAdvertise="no"
+             Title="Install PuTTY files">
+      <ComponentRef Id="PuTTY_Component" />
+      <ComponentRef Id="Pageant_Component" />
+      <ComponentRef Id="PSFTP_Component" />
+      <ComponentRef Id="PuTTYgen_Component" />
+      <ComponentRef Id="Plink_Component" />
+      <ComponentRef Id="PSCP_Component" />
+      <ComponentRef Id="HelpFile_Component" />
+      <ComponentRef Id="Website_Component" />
+      <ComponentRef Id="LICENCE_Component" />
+      <ComponentRef Id="README_Component" />
+      <ComponentRef Id="ProgramMenuDir" />
+    </Feature>
+    <Feature Id="DesktopFeature" Level="1" Absent="allow" AllowAdvertise="no"
+             Title="Add shortcut to PuTTY on the Desktop">
+      <ComponentRef Id="Desktop_Shortcut_Component" />
+    </Feature>
+    <Feature Id="PathFeature" Level="1" Absent="allow" AllowAdvertise="no"
+             Title="Put install directory on the PATH for command prompts">
+      <ComponentRef Id="Path_Component" />
+    </Feature>
+    <Feature Id="PPKFeature" Level="1" Absent="allow" AllowAdvertise="no"
+             Title="Associate .PPK files with PuTTYgen and Pageant">
+      <ComponentRef Id="PPK_Assoc_Component" />
+    </Feature>
+
+    <!--
+        Installer user interface.
+
+        WiX provides several pre-cooked UIs, but annoyingly, every
+        single one of them has the wrong combination of features for
+        what I want. For example, WixUI_InstallDir lets me select the
+        install directory, but not the feature set. WixUI_Advanced
+        lets me select both, but also insists on giving me the option
+        of per-user vs systemwide install (and I haven't managed to
+        get per-user to behave sensibly). And _most_ of them insist on
+        having a click-through EULA page in the interface, which I
+        absolutely don't want - the MIT licence does not need to be
+        presented as a EULA at all (if you didn't accept it in your
+        mind you had no business copying the software in the first
+        place, and it's not imposing any scary restrictions anyway).
+
+        So what we see below is my own sequence of UI dialogs, all
+        included by reference from the WiX standard set. It's probably
+        most similar to WixUI_InstallDir, but I've removed LicenseDlg
+        and included FeaturesDlg.
+
+        (I'm not actually sure that FeaturesDlg is all that good a fit
+        for this particular project, with a treeview control that
+        doesn't really get used as a tree, and inappropriate wording
+        in the dropdown you use to select or deselect features.
+        Perhaps in future I might replace it with a simpler dialog box
+        containing a checkbox for each of the desktop shortcut, the
+        PATH addition and the PPK associations.)
+    -->
+    <UIRef Id="WixUI_Common" />
+
+    <UI>
+      <TextStyle Id="WixUI_Font_Normal" FaceName="Tahoma" Size="8" />
+      <TextStyle Id="WixUI_Font_Bigger" FaceName="Tahoma" Size="12" />
+      <TextStyle Id="WixUI_Font_Title" FaceName="Tahoma" Size="9" Bold="yes" />
+
+      <Property Id="DefaultUIFont" Value="WixUI_Font_Normal" />
+      <Property Id="WixUI_Mode" Value="InstallDir" />
+
+      <DialogRef Id="BrowseDlg" />
+      <DialogRef Id="DiskCostDlg" />
+      <DialogRef Id="ErrorDlg" />
+      <DialogRef Id="FatalError" />
+      <DialogRef Id="FilesInUse" />
+      <DialogRef Id="MsiRMFilesInUse" />
+      <DialogRef Id="PrepareDlg" />
+      <DialogRef Id="ProgressDlg" />
+      <DialogRef Id="ResumeDlg" />
+      <DialogRef Id="UserExit" />
+      <DialogRef Id="FeaturesDlg" />
+
+      <Publish Dialog="BrowseDlg" Control="OK" Event="DoAction" Value="WixUIValidatePath" Order="3">1</Publish>
+      <Publish Dialog="BrowseDlg" Control="OK" Event="SpawnDialog" Value="InvalidDirDlg" Order="4"><![CDATA[NOT WIXUI_DONTVALIDATEPATH AND WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>
+
+      <Publish Dialog="ExitDialog" Control="Finish" Event="EndDialog" Value="Return" Order="999">1</Publish>
+
+      <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="InstallDirDlg">NOT Installed</Publish>
+      <Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="FeaturesDlg">Installed</Publish>
+
+      <Publish Dialog="InstallDirDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">1</Publish>
+      <Publish Dialog="InstallDirDlg" Control="Next" Event="SetTargetPath" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
+      <Publish Dialog="InstallDirDlg" Control="Next" Event="DoAction" Value="WixUIValidatePath" Order="2">NOT WIXUI_DONTVALIDATEPATH</Publish>
+      <Publish Dialog="InstallDirDlg" Control="Next" Event="SpawnDialog" Value="InvalidDirDlg" Order="3"><![CDATA[NOT WIXUI_DONTVALIDATEPATH AND WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>
+      <Publish Dialog="InstallDirDlg" Control="Next" Event="NewDialog" Value="FeaturesDlg" Order="4">WIXUI_DONTVALIDATEPATH OR WIXUI_INSTALLDIR_VALID="1"</Publish>
+      <Publish Dialog="InstallDirDlg" Control="ChangeFolder" Property="_BrowseProperty" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
+      <Publish Dialog="InstallDirDlg" Control="ChangeFolder" Event="SpawnDialog" Value="BrowseDlg" Order="2">1</Publish>
+
+      <Publish Dialog="FeaturesDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">Installed</Publish>
+      <Publish Dialog="FeaturesDlg" Control="Back" Event="NewDialog" Value="InstallDirDlg">NOT Installed</Publish>
+      <Publish Dialog="FeaturesDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
+
+      <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="InstallDirDlg" Order="1">NOT Installed</Publish>
+      <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="MaintenanceTypeDlg" Order="2">Installed AND NOT PATCH</Publish>
+      <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg" Order="2">Installed AND PATCH</Publish>
+
+      <Publish Dialog="MaintenanceWelcomeDlg" Control="Next" Event="NewDialog" Value="MaintenanceTypeDlg">1</Publish>
+
+      <Publish Dialog="MaintenanceTypeDlg" Control="RepairButton" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
+      <Publish Dialog="MaintenanceTypeDlg" Control="RemoveButton" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
+      <Publish Dialog="MaintenanceTypeDlg" Control="Back" Event="NewDialog" Value="MaintenanceWelcomeDlg">1</Publish>
+
+      <!--
+          This ARPNOMODIFY flag prohibits changing the set of
+          installed features, which would otherwise be possible by
+          reactivating the same MSI (from its original disk file, or
+          in Add/Remove Programs, or I think also by GUID on the
+          msiexec command line) and selecting 'Change' from the
+          maintenance-type dialog.
+
+          The reason I've prohibited it is because I couldn't get it
+          to *work* in my initial testing - it would look as if it had
+          done the right thing, but in fact the features it should
+          have removed would still be there after the installer
+          finished running. So if any WiX expert can help me fix this,
+          I'd love to take this flag out and make the installation
+          retrospectively modifiable!
+
+          (As well as removing this flag and fixing whatever the
+          problem is, I'd also have to add a line in the above set of
+          Publish tags which points MaintenanceTypeDlg's ChangeButton
+          at FeaturesDlg.)
+      -->
+      <Property Id="ARPNOMODIFY" Value="1" />
+    </UI>
+
+    <!-- Glue: tell the install dir part of the UI what id my actual
+         install dir is known by. Otherwise the former won't know how
+         to alter the setting of the latter. -->
+    <Property Id="WIXUI_INSTALLDIR" Value="INSTALLDIR" />
+
+    <!--
+        Include my custom installer artwork, created in Buildscr.
+    -->
+    <WixVariable Id="WixUIDialogBmp" Value="msidialog.bmp" />
+    <WixVariable Id="WixUIBannerBmp" Value="msibanner.bmp" />
+
+  </Product>
+</Wix>