[stabilization/2106] bootstrap installer theme support (#1294)

5 years ago · 4af5faa0a9
parent f8cf4ba087 633de3d28b
commit 4af5faa0a9
6 changed files with 186 additions and 0 deletions
--- a/cmake/Platform/Windows/Packaging/Bootstrapper.wxs
+++ b/cmake/Platform/Windows/Packaging/Bootstrapper.wxs
@ -22,6 +22,8 @@
                <bal:WixStandardBootstrapperApplication
                    LicenseUrl="$(var.CPACK_LICENSE_URL)"
                    LogoFile="$(var.CPACK_WIX_PRODUCT_LOGO)"
+                    ThemeFile="$(var.CPACK_BOOTSTRAP_THEME_FILE).xml"
+                    LocalizationFile="$(var.CPACK_BOOTSTRAP_THEME_FILE).wxl"
                    ShowVersion="yes" />
            </BootstrapperApplicationRef>
        <?else?>
@ -29,6 +31,8 @@
                <bal:WixStandardBootstrapperApplication
                    LicenseFile="$(var.CPACK_WIX_LICENSE_RTF)"
                    LogoFile="$(var.CPACK_WIX_PRODUCT_LOGO)"
+                    ThemeFile="$(var.CPACK_BOOTSTRAP_THEME_FILE).xml"
+                    LocalizationFile="$(var.CPACK_BOOTSTRAP_THEME_FILE).wxl"
                    ShowVersion="yes" />
            </BootstrapperApplicationRef>
        <?endif?>
--- a/cmake/Platform/Windows/Packaging/BootstrapperTheme.wxl.in
+++ b/cmake/Platform/Windows/Packaging/BootstrapperTheme.wxl.in
@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<WixLocalization Culture="en-us"
+    Language="1033"
+    xmlns="http://schemas.microsoft.com/wix/2006/localization">
+
+    <!-- common -->
+    <String Id="WindowTitle">[WixBundleName] Setup</String>
+    <String Id="Title">[WixBundleName]</String>
+    <String Id="InstallVersion">Version [WixBundleVersion]</String>
+    <String Id="ConfirmCancelMessage">Are you sure you want to cancel?</String>
+
+    <!-- welcome page -->
+    <String Id="InstallHeader">Welcome</String>
+    <String Id="InstallMessage">
+Setup will install [WixBundleName] on your computer. Click install to continue, options to set the install directory or Close to exit.
+    </String>
+    <String Id="InstallLicenseLinkText">[WixBundleName] &lt;a href="#"&gt;license terms&lt;/a&gt;.</String>
+    <String Id="InstallAcceptCheckbox">I &amp;agree to the license terms and conditions</String>
+    <String Id="InstallOptionsButton">&amp;Options</String>
+    <String Id="InstallInstallButton">&amp;Install</String>
+    <String Id="InstallCloseButton">&amp;Close</String>
+
+    <!-- configure install page -->
+    <String Id="OptionsHeader">Setup Options</String>
+    <String Id="OptionsLocationLabel">Install location:</String>
+    <String Id="OptionsBrowseButton">&amp;Browse</String>
+    <String Id="OptionsOkButton">&amp;OK</String>
+    <String Id="OptionsCancelButton">&amp;Cancel</String>
+
+    <!-- edit existing install page -->
+    <String Id="ModifyHeader">Modify Setup</String>
+    <String Id="ModifyRepairButton">&amp;Repair</String>
+    <String Id="ModifyUninstallButton">&amp;Uninstall</String>
+    <String Id="ModifyCloseButton">&amp;Close</String>
+
+    <!-- action progress page -->
+    <String Id="ProgressHeader">Setup Progress</String>
+    <String Id="ProgressLabel">Processing:</String>
+    <String Id="OverallProgressPackageText">Initializing...</String>
+    <String Id="ProgressCancelButton">&amp;Cancel</String>
+
+    <!-- final page (success state) -->
+    <String Id="SuccessHeader">Setup Successful</String>
+    <String Id="SuccessInstallHeader">Installation Successfully Completed</String>
+    <String Id="SuccessRepairHeader">Repair Successfully Completed</String>
+    <String Id="SuccessUninstallHeader">Uninstall Successfully Completed</String>
+    <String Id="SuccessLaunchButton">&amp;Launch</String>
+    <String Id="SuccessCloseButton">&amp;Close</String>
+
+    <!-- final page (fail state) -->
+    <String Id="FailureHeader">Setup Failed</String>
+    <String Id="FailureInstallHeader">Setup Failed</String>
+    <String Id="FailureUninstallHeader">Uninstall Failed</String>
+    <String Id="FailureRepairHeader">Repair Failed</String>
+    <String Id="FailureHyperlinkLogText">
+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>
+    <String Id="FailureCloseButton">&amp;Close</String>
+
+    <!-- help page -->
+    <String Id="HelpHeader">Setup Help</String>
+    <String Id="HelpText">
+/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.
+
+/log log.txt - logs to a specific file. By default a log file is created in %TEMP%.
+    </String>
+    <String Id="HelpCloseButton">&amp;Close</String>
+</WixLocalization>
--- a/cmake/Platform/Windows/Packaging/BootstrapperTheme.xml.in
+++ b/cmake/Platform/Windows/Packaging/BootstrapperTheme.xml.in
@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Theme xmlns="http://wixtoolset.org/schemas/thmutil/2010">
+
+    <Window Width="485" Height="300" HexStyle="100a0000" FontId="0">#(loc.WindowTitle)</Window>
+
+    <Font Id="0" Height="-12" Weight="500" Foreground="000000" Background="FFFFFF">Segoe UI</Font>
+    <Font Id="1" Height="-24" Weight="500" Foreground="000000">Segoe UI</Font>
+    <Font Id="2" Height="-22" Weight="500" Foreground="666666">Segoe UI</Font>
+    <Font Id="3" Height="-12" Weight="500" Foreground="000000" Background="FFFFFF">Segoe UI</Font>
+
+    <!-- top banner -->
+    <Image X="11" Y="11" Width="64" Height="64" ImageFile="logo.png" Visible="yes"/>
+    <Text X="80" Y="11" Width="-11" Height="64" FontId="1" Visible="yes" DisablePrefix="yes">#(loc.Title)</Text>
+
+    <!-- welcome page -->
+    <Page Name="Install">
+        @WIX_THEME_INSTALL_LICENSE_ELEMENT@
+
+        <Checkbox Name="EulaAcceptCheckbox" X="-11" Y="-41" Width="260" Height="17" TabStop="yes" FontId="3" HideWhenDisabled="yes">#(loc.InstallAcceptCheckbox)</Checkbox>
+        <Button Name="OptionsButton" X="-171" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0" HideWhenDisabled="yes">#(loc.InstallOptionsButton)</Button>
+        <Button Name="InstallButton" X="-91" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.InstallInstallButton)</Button>
+        <Button Name="WelcomeCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.InstallCloseButton)</Button>
+    </Page>
+
+    <!-- configure install page -->
+    <Page Name="Options">
+        <Text X="11" Y="80" Width="-11" Height="30" FontId="2" DisablePrefix="yes">#(loc.OptionsHeader)</Text>
+
+        <Text X="11" Y="121" Width="-11" Height="17" FontId="3" DisablePrefix="yes">#(loc.OptionsLocationLabel)</Text>
+        <Editbox Name="FolderEditbox" X="11" Y="143" Width="-91" Height="21" TabStop="yes" FontId="3" FileSystemAutoComplete="yes" />
+        <Button Name="BrowseButton" X="-11" Y="142" Width="75" Height="23" TabStop="yes" FontId="3">#(loc.OptionsBrowseButton)</Button>
+
+        <Button Name="OptionsOkButton" X="-91" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.OptionsOkButton)</Button>
+        <Button Name="OptionsCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.OptionsCancelButton)</Button>
+    </Page>
+
+    <!-- edit existing install page -->
+    <Page Name="Modify">
+        <Text X="11" Y="80" Width="-11" Height="30" FontId="2" DisablePrefix="yes">#(loc.ModifyHeader)</Text>
+
+        <Button Name="RepairButton" X="-171" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0" HideWhenDisabled="yes">#(loc.ModifyRepairButton)</Button>
+        <Button Name="UninstallButton" X="-91" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.ModifyUninstallButton)</Button>
+        <Button Name="ModifyCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.ModifyCloseButton)</Button>
+    </Page>
+
+    <!-- action progress page -->
+    <Page Name="Progress">
+        <Text X="11" Y="80" Width="-11" Height="30" FontId="2" DisablePrefix="yes">#(loc.ProgressHeader)</Text>
+
+        <Text X="11" Y="121" Width="70" Height="17" FontId="3" DisablePrefix="yes">#(loc.ProgressLabel)</Text>
+        <Text Name="OverallProgressPackageText" X="85" Y="121" Width="-11" Height="17" FontId="3" DisablePrefix="yes">#(loc.OverallProgressPackageText)</Text>
+        <Progressbar Name="OverallCalculatedProgressbar" X="11" Y="143" Width="-11" Height="15" />
+
+        <Button Name="ProgressCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.ProgressCancelButton)</Button>
+    </Page>
+
+    <!-- final page (success state) -->
+    <Page Name="Success">
+        <Text Name="SuccessHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.SuccessHeader)</Text>
+        <Text Name="SuccessInstallHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.SuccessInstallHeader)</Text>
+        <Text Name="SuccessRepairHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.SuccessRepairHeader)</Text>
+        <Text Name="SuccessUninstallHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.SuccessUninstallHeader)</Text>
+
+        <Button Name="LaunchButton" X="-91" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0" HideWhenDisabled="yes">#(loc.SuccessLaunchButton)</Button>
+        <Button Name="SuccessCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.SuccessCloseButton)</Button>
+    </Page>
+
+    <!-- final page (failure state) -->
+    <Page Name="Failure">
+        <Text Name="FailureHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.FailureHeader)</Text>
+        <Text Name="FailureInstallHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.FailureInstallHeader)</Text>
+        <Text Name="FailureUninstallHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.FailureUninstallHeader)</Text>
+        <Text Name="FailureRepairHeader" X="11" Y="80" Width="-11" Height="30" FontId="2" HideWhenDisabled="yes" DisablePrefix="yes">#(loc.FailureRepairHeader)</Text>
+
+        <Hypertext Name="FailureLogFileLink" X="11" Y="121" Width="-11" Height="42" FontId="3" TabStop="yes" HideWhenDisabled="yes">#(loc.FailureHyperlinkLogText)</Hypertext>
+        <Hypertext Name="FailureMessageText" X="22" Y="163" Width="-11" Height="51" FontId="3" TabStop="yes" HideWhenDisabled="yes" />
+
+        <Button Name="FailureCloseButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.FailureCloseButton)</Button>
+    </Page>
+
+    <!-- help page -->
+    <Page Name="Help">
+        <Text X="11" Y="80" Width="-11" Height="30" FontId="2" DisablePrefix="yes">#(loc.HelpHeader)</Text>
+        <Text X="11" Y="112" Width="-11" Height="-35" FontId="3" DisablePrefix="yes">#(loc.HelpText)</Text>
+        <Button Name="HelpCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.HelpCloseButton)</Button>
+    </Page>
+</Theme>
--- a/cmake/Platform/Windows/PackagingPostBuild.cmake
+++ b/cmake/Platform/Windows/PackagingPostBuild.cmake
@ -25,6 +25,7 @@ set(_ext_flags
 )

 set(_addtional_defines
+    -dCPACK_BOOTSTRAP_THEME_FILE=${CPACK_BINARY_DIR}/BootstrapperTheme
    -dCPACK_BOOTSTRAP_UPGRADE_GUID=${CPACK_WIX_BOOTSTRAP_UPGRADE_GUID}
    -dCPACK_DOWNLOAD_SITE=${CPACK_DOWNLOAD_SITE}
    -dCPACK_LOCAL_INSTALLER_DIR=${_cpack_wix_out_dir}
--- a/cmake/Platform/Windows/Packaging_windows.cmake
+++ b/cmake/Platform/Windows/Packaging_windows.cmake
@ -92,6 +92,28 @@ set(CPACK_WIX_EXTENSIONS
 set(_embed_artifacts "yes")

 if(LY_INSTALLER_DOWNLOAD_URL)
+
+    if(LY_INSTALLER_LICENSE_URL)
+        set(WIX_THEME_INSTALL_LICENSE_ELEMENT
+            "<Hypertext Name=\"EulaHyperlink\" X=\"11\" Y=\"121\" Width=\"-11\" Height=\"51\" TabStop=\"yes\" FontId=\"3\" HideWhenDisabled=\"yes\">#(loc.InstallLicenseLinkText)</Hypertext>"
+        )
+    else()
+        set(WIX_THEME_INSTALL_LICENSE_ELEMENT
+            "<Richedit Name=\"EulaRichedit\" X=\"11\" Y=\"80\" Width=\"-11\" Height=\"-70\" TabStop=\"yes\" FontId=\"0\" HexStyle=\"0x800000\" />"
+        )
+    endif()
+
+    configure_file(
+        "${CPACK_SOURCE_DIR}/Platform/Windows/Packaging/BootstrapperTheme.xml.in"
+        "${CPACK_BINARY_DIR}/BootstrapperTheme.xml"
+        @ONLY
+    )
+    configure_file(
+        "${CPACK_SOURCE_DIR}/Platform/Windows/Packaging/BootstrapperTheme.wxl.in"
+        "${CPACK_BINARY_DIR}/BootstrapperTheme.wxl"
+        @ONLY
+    )
+
    set(_embed_artifacts "no")

    # the bootstrapper will at the very least need a different upgrade guid
--- a/cmake/Platform/Windows/platform_windows_files.cmake
+++ b/cmake/Platform/Windows/platform_windows_files.cmake
@ -26,6 +26,8 @@ set(FILES
    Packaging_windows.cmake
    PackagingPostBuild.cmake
    Packaging/Bootstrapper.wxs
+    Packaging/BootstrapperTheme.wxl.in
+    Packaging/BootstrapperTheme.xml.in
    Packaging/Shortcuts.wxs
    Packaging/Template.wxs.in
 )