Add WixInternalUIBootstrapperApplication as a new built-in BA.

Implements 6835

4 files changed, 131 insertions, 15 deletions

diff --git a/src/ext/Bal/wixstdba/Resources/iuipreq.thm b/src/ext/Bal/wixstdba/Resources/iuipreq.thm
new file mode 100644
index 00000000..5429b3d2
--- /dev/null
+++ b/src/ext/Bal/wixstdba/Resources/iuipreq.thm
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Theme xmlns="http://wixtoolset.org/schemas/v4/thmutil">
+    <Font Id="0" Height="-12" Weight="500" Foreground="windowtext" Background="window">Segoe UI</Font>
+    <Font Id="1" Height="-24" Weight="500" Foreground="windowtext">Segoe UI</Font>
+    <Font Id="2" Height="-22" Weight="500" Foreground="graytext">Segoe UI</Font>
+    <Font Id="3" Height="-12" Weight="500" Foreground="windowtext" Background="window">Segoe UI</Font>
+
+    <Window Width="485" Height="300" HexStyle="100a0000" FontId="0" Caption="#(loc.Caption)">
+        <ImageControl X="11" Y="11" Width="64" Height="64" ImageFile="mbapreq.png" Visible="yes"/>
+        <Label X="80" Y="11" Width="-11" Height="96" FontId="1" Visible="yes" DisablePrefix="yes">
+            <Text>#(loc.Title)</Text>
+            <Text Condition="WixBundleAction = 2 OR WixBundleCommandLineAction = 1">#(loc.NonPrereqTitle)</Text>
+        </Label>
+
+        <Page Name="Help">
+            <Label X="11" Y="112" Width="-11" Height="30" FontId="2" DisablePrefix="yes">#(loc.HelpHeader)</Label>
+            <Label X="11" Y="153" Width="-11" Height="-35" FontId="3" DisablePrefix="yes">#(loc.HelpText)</Label>
+            <Button Name="HelpCloseButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">
+                <Text>#(loc.HelpCloseButton)</Text>
+                <CloseWindowAction />
+            </Button>
+        </Page>
+        <Page Name="Install">
+            <Hypertext Name="EulaHyperlink" X="11" Y="121" Width="-11" Height="34" TabStop="yes" FontId="3">#(loc.InstallLicenseTerms)</Hypertext>
+            <Button Name="InstallButton" X="-91" Y="-11" Width="130" Height="23" TabStop="yes" FontId="0">#(loc.InstallAcceptAndInstallButton)</Button>
+            <Button Name="InstallDeclineButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">
+                <Text>#(loc.InstallDeclineButton)</Text>
+                <CloseWindowAction />
+            </Button>
+        </Page>
+        <Page Name="Progress">
+            <Label X="11" Y="112" Width="-11" Height="30" FontId="2" DisablePrefix="yes">#(loc.ProgressHeader)</Label>
+            <Label X="11" Y="153" Width="70" Height="17" FontId="3" DisablePrefix="yes">#(loc.ProgressLabel)</Label>
+            <Label Name="OverallProgressPackageText" X="85" Y="153" Width="-11" Height="17" FontId="3" DisablePrefix="yes">[ProgressPackageName]</Label>
+            <Progressbar Name="OverallCalculatedProgressbar" X="11" Y="175" Width="-11" Height="15" />
+            <Button Name="ProgressCancelButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">#(loc.ProgressCancelButton)</Button>
+        </Page>
+        <Page Name="Success">
+            <Label X="11" Y="112" Width="-11" Height="30" FontId="2" DisablePrefix="yes">
+                <Text>#(loc.SuccessHeader)</Text>
+                <Text Condition="WixBundleAction = 2">#(loc.SuccessLayoutHeader)</Text>
+            </Label>
+            <Label X="-11" Y="-20" Width="400" Height="34" FontId="3" DisablePrefix="yes" VisibleCondition="WixStdBARestartRequired">
+                <Text>#(loc.SuccessRestartText)</Text>
+            </Label>
+            <Button Name="SuccessRestartButton" X="-91" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0" HideWhenDisabled="yes">#(loc.SuccessRestartButton)</Button>
+            <Button Name="SuccessCloseButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">
+                <Text>#(loc.SuccessCloseButton)</Text>
+                <CloseWindowAction />
+            </Button>
+        </Page>
+        <Page Name="Failure">
+            <Label X="11" Y="112" Width="-11" Height="30" FontId="2" DisablePrefix="yes">
+                <Text>#(loc.FailureHeader)</Text>
+                <Text Condition="WixBundleAction = 2">#(loc.FailureLayoutHeader)</Text>
+            </Label>
+            <Hypertext Name="FailureLogFileLink" X="11" Y="153" Width="-11" Height="51" FontId="3" TabStop="yes" HideWhenDisabled="yes">#(loc.FailureLogLinkText)</Hypertext>
+            <Hypertext Name="FailureMessageText" X="22" Y="190" Width="-11" Height="51" FontId="3" TabStop="yes" HideWhenDisabled="yes"/>
+            <Label X="-11" Y="-20" Width="400" Height="34" FontId="3" DisablePrefix="yes" VisibleCondition="WixStdBARestartRequired">#(loc.FailureRestartText)</Label>
+            <Button Name="FailureRestartButton" X="-91" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0" HideWhenDisabled="yes">#(loc.FailureRestartButton)</Button>
+            <Button Name="FailureCloseButton" X="-11" Y="-11" Width="75" Height="23" TabStop="yes" FontId="0">
+                <Text>#(loc.FailureCloseButton)</Text>
+                <CloseWindowAction />
+            </Button>
+        </Page>
+    </Window>
+</Theme>
diff --git a/src/ext/Bal/wixstdba/Resources/iuipreq.wxl b/src/ext/Bal/wixstdba/Resources/iuipreq.wxl
new file mode 100644
index 00000000..4afcd10f
--- /dev/null
+++ b/src/ext/Bal/wixstdba/Resources/iuipreq.wxl
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
+
+
+<WixLocalization Culture="en-us" Language="1033" xmlns="http://wixtoolset.org/schemas/v4/wxl">
+  <String Id="Caption">[WixBundleName] Prerequisite Setup</String>
+  <String Id="Title">Prerequisite required for [WixBundleName] setup</String>
+  <String Id="NonPrereqTitle">[WixBundleName] setup</String>
+  <String Id="ConfirmCancelMessage">Are you sure you want to cancel?</String>
+  <String Id="HelpHeader">Setup Help</String>
+  <String Id="HelpText">/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>
+  <String Id="InstallLicenseTerms">Click the "Accept and Install" button to accept the prerequisite &lt;a href="#"&gt;license terms&lt;/a&gt;.</String>
+  <String Id="InstallAcceptAndInstallButton">&amp;Accept and Install</String>
+  <String Id="InstallDeclineButton">&amp;Decline</String>
+  <String Id="ProgressHeader">Setup Progress</String>
+  <String Id="ProgressLabel">Processing:</String>
+  <String Id="ProgressCancelButton">&amp;Cancel</String>
+  <String Id="SuccessHeader">Prerequisite Setup Successful</String>
+  <String Id="SuccessLayoutHeader">Layout Successfully Completed</String>
+  <String Id="SuccessRestartText">You must restart your computer before [WixBundleName] setup can continue.</String>
+  <String Id="SuccessRestartButton">&amp;Restart</String>
+  <String Id="SuccessCloseButton">&amp;Close</String>
+  <String Id="FailureHeader">Setup Failed</String>
+  <String Id="FailureLayoutHeader">Layout Failed</String>
+  <String Id="FailureLogLinkText">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="FailureRestartText">You must restart your computer to complete the rollback of the software.</String>
+  <String Id="FailureRestartButton">&amp;Restart</String>
+  <String Id="FailureCloseButton">&amp;Close</String>
+  <String Id="ErrorFailNoActionReboot">No action was taken as a system reboot is required.</String>
+</WixLocalization>
diff --git a/src/ext/Bal/wixstdba/WixStandardBootstrapperApplication.cpp b/src/ext/Bal/wixstdba/WixStandardBootstrapperApplication.cpp
index 9aa58a28..1af1abeb 100644
--- a/src/ext/Bal/wixstdba/WixStandardBootstrapperApplication.cpp
+++ b/src/ext/Bal/wixstdba/WixStandardBootstrapperApplication.cpp
@@ -248,10 +248,20 @@ public: // IBootstrapperApplication
 
         if (m_fPrereq)
         {
-            // Pre-req BA should only show help or do an install (to launch the Managed BA which can then do the right action).
-            if (BOOTSTRAPPER_ACTION_HELP != m_command.action)
+            if (m_pPrereqData->fPerformLayout && BOOTSTRAPPER_ACTION_LAYOUT == m_command.action)
             {
-                m_command.action = BOOTSTRAPPER_ACTION_INSTALL;
+                // The parent BA has requested that this BA be in charge of layout.
+                m_fPrereq = FALSE;
+            }
+            else
+            {
+                m_fPreplanPrereqs = m_pPrereqData->fAlwaysInstallPrereqs;
+
+                // Pre-req BA should only show help or do an install (to launch the parent BA which can then do the right action).
+                if (BOOTSTRAPPER_ACTION_HELP != m_command.action)
+                {
+                    m_command.action = BOOTSTRAPPER_ACTION_INSTALL;
+                }
             }
         }
         else // maybe modify the action state if the bundle is or is not already installed.
@@ -527,11 +537,11 @@ public: // IBootstrapperApplication
         )
     {
         HRESULT hr = S_OK;
-        BOOL fPlannedPrereqs = WIXSTDBA_STATE_PLANNING_PREREQS == m_state;
+        BOOL fPreplannedPrereqs = WIXSTDBA_STATE_PLANNING_PREREQS == m_state;
         WIXSTDBA_STATE completedState = WIXSTDBA_STATE_PLANNED;
         BOOL fApply = TRUE;
 
-        if (fPlannedPrereqs)
+        if (fPreplannedPrereqs)
         {
             if (SUCCEEDED(hrStatus) && !m_fPrereqPackagePlanned)
             {
@@ -547,7 +557,7 @@ public: // IBootstrapperApplication
                 // Need to force the state change since normally moving backwards is prevented.
                 ::PostMessageW(m_hWnd, WM_WIXSTDBA_CHANGE_STATE, 0, WIXSTDBA_STATE_HELP);
 
-                ::PostMessageW(m_hWnd, WM_WIXSTDBA_SHOW_HELP, 0, 0);                
+                ::PostMessageW(m_hWnd, WM_WIXSTDBA_SHOW_HELP, 0, 0);
 
                 ExitFunction();
             }
@@ -562,7 +572,7 @@ public: // IBootstrapperApplication
             ExitFunction();
         }
 
-        if (fPlannedPrereqs)
+        if (fPreplannedPrereqs)
         {
             // If the UI should be visible, display it now and hide the splash screen
             if (BOOTSTRAPPER_DISPLAY_NONE < m_command.display)
@@ -1056,13 +1066,14 @@ public: // IBootstrapperApplication
 
         hr = __super::OnExecutePackageComplete(wzPackageId, hrStatus, restart, recommendation, pAction);
 
-        BAL_INFO_PACKAGE* pPackage = NULL;
-        HRESULT hrPrereq = BalInfoFindPackageById(&m_Bundle.packages, wzPackageId, &pPackage);
-        if (SUCCEEDED(hrPrereq))
+        if (m_fPrereq && BOOTSTRAPPER_APPLY_RESTART_NONE != restart)
         {
+            BAL_INFO_PACKAGE* pPackage = NULL;
+            HRESULT hrPrereq = BalInfoFindPackageById(&m_Bundle.packages, wzPackageId, &pPackage);
+
             // If the prerequisite required a restart (any restart) then do an immediate
             // restart to ensure that the bundle will get launched again post reboot.
-            if (m_fPrereq && pPackage->fPrereqPackage && BOOTSTRAPPER_APPLY_RESTART_NONE != restart)
+            if (SUCCEEDED(hrPrereq) && pPackage->fPrereqPackage)
             {
                 *pAction = BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION_RESTART;
             }
@@ -2283,7 +2294,7 @@ private:
             // Okay, we're ready for packages now.
             pThis->SetState(WIXSTDBA_STATE_INITIALIZED, hr);
 
-            if (!pThis->m_fPreplanPrereqs && BOOTSTRAPPER_ACTION_HELP == pThis->m_command.action)
+            if (pThis->m_fPerformHelp && BOOTSTRAPPER_ACTION_HELP == pThis->m_command.action)
             {
                 firstAction = WM_WIXSTDBA_SHOW_HELP;
             }
@@ -4246,7 +4257,7 @@ public:
         m_hWnd = NULL;
 
         m_state = WIXSTDBA_STATE_INITIALIZING;
-        m_hrFinal = pPrereqData ? pPrereqData->hrHostInitialization : S_OK;
+        m_hrFinal = pPrereqData ? pPrereqData->hrFatalError : S_OK;
 
         m_restartResult = BOOTSTRAPPER_APPLY_RESTART_NONE;
         m_fRestartRequired = FALSE;
@@ -4269,7 +4280,8 @@ public:
 
         m_pPrereqData = pPrereqData;
         m_fPrereq = NULL != pPrereqData;
-        m_fPreplanPrereqs = m_fPrereq && m_pPrereqData->fAlwaysInstallPrereqs;
+        m_fPreplanPrereqs = FALSE;
+        m_fPerformHelp = !m_fPrereq || m_pPrereqData->fPerformHelp;
         m_fPrereqPackagePlanned = FALSE;
         m_fPrereqInstalled = FALSE;
         m_fPrereqSkipped = FALSE;
@@ -4554,6 +4566,7 @@ private:
     PREQBA_DATA* m_pPrereqData;
     BOOL m_fPrereq;
     BOOL m_fPreplanPrereqs;
+    BOOL m_fPerformHelp;
     BOOL m_fPrereqPackagePlanned;
     BOOL m_fPrereqInstalled;
     BOOL m_fPrereqSkipped;
diff --git a/src/ext/Bal/wixstdba/inc/preqba.h b/src/ext/Bal/wixstdba/inc/preqba.h
index ed339730..25fa7105 100644
--- a/src/ext/Bal/wixstdba/inc/preqba.h
+++ b/src/ext/Bal/wixstdba/inc/preqba.h
@@ -4,8 +4,10 @@
 
 struct PREQBA_DATA
 {
-    HRESULT hrHostInitialization;
+    HRESULT hrFatalError;
     BOOL fAlwaysInstallPrereqs;
+    BOOL fPerformHelp;
+    BOOL fPerformLayout;
     BOOL fCompleted;
 };