Merge lp:~brian.curtin/ubuntuone-windows-installer/installer-fixes into lp:ubuntuone-windows-installer

[Brian Curtin]

- Make installer smarter by shutting down existing Ubuntu One applications, uninstalling the previous version, and installing on a clean base. (lp:1111899)

This proposal makes the installer a lot smarter in the case of an upgrade, which we sometimes see issues with, and upgrades are the likely case of ZipImportErrors we've been seeing.

There are several parts here:

1. Stop any existing Ubuntu One applications before continuing the installer. If we can find u1sdtool, run it with -q to safely stop syncdaemon. After that, we run a piece of vbscript to use WMI and query the system for all running U1 executables, then terminate all of them.

2. If we can find an uninstaller, back it up and run our uninstall. We have to put the backed up version back so future installers can do the same. We do this inside a progress bar display because this could take a few seconds that might leave people wondering what the installer is doing. On my VMs, it could take 10 seconds from click to the time you see the actual installation part begin, so displaying this progress bar holds them over.

3. I've added showMessageOnError=0 and abortOnError=0 to the places where we run programs that could possibly fail, especially in the pre-installation phase. All of the runProgram's where we're using those attributes should not cause the whole installation to fail, so we can move on from them if they cause problems. They'll be logged in the install.log file, but should present nothing to the user.

4. I've removed a special case of the installer to not start up U1CP on upgrade installs because of our previous issues with installing over the top of things. Now that we do an uninstall and then a clean install, we can safely start up the control panel regardless of whether it was a first-time install or upgrade.

I also had to update the unattendedModeUI to include dialogs for our uninstaller run. It's now minimalWithDialogs.

Note: This has been tested on XP, Vista, and 8. All of them are able to do a successful clean install followed by an upgrade.

[Mike McCracken (mikemc)]

Looks good to me, although I'd like to test it IRL but I'm not sure how.

I'm also not totally clear on why we need to run a backup of the uninstaller and then copy it back.
Why not just run the uninstaller in place?
And once we've done an uninstall followed by an install, why are we putting back the old uninstaller? Isn't there an uninstaller installed by the install step, and if there isn't anymore, why do we still need the old one?

review: Needs Information

[Brian Curtin (brian.curtin)]

The reason we do the backup is because once the installer finishes, it generates its own uninstaller. It fills the uninstall.dat with the files it created (including the dat file itself and uninstall.exe) so that when uninstall.exe runs, it knows what to remove.

If we run uninstall.exe during the process, it'll end up removing itself at the end of the uninstall, and then the *installer* gets confused at the end because it can't find that uninstall.dat from the previous install. This is true of "upgrade" install processes -- note on line 30 of the diff where we have to state it's an upgrade - not doing so throws other things off.

In order to work around this, we create a copy of uninstall.exe and uninstall.dat. We then run our backup copies so they don't get cleaned up in the uninstall process, then we put them back in place before the installer goes to read them and create the new versions. I don't know why the installer can't just say "oops, didn't find the previous uninstall, just create a new one as if this is a clean install", but it ends up just ignoring the uninstall regeneration part and then you have to delete everything manually.

[Mike McCracken (mikemc)]

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'scripts/ubuntuone.xml'
--- scripts/ubuntuone.xml	2013-01-28 20:33:17 +0000
+++ scripts/ubuntuone.xml	2013-01-31 23:50:27 +0000
@@ -78,18 +78,7 @@
                     <platforms>osx</platforms>
                 </folder>
             </folderList>
-            <preInstallationActionList>
-                <actionGroup>
-                    <actionList>
-                        <setInstallerVariable name="installationType" value="upgrade"/>
-                    </actionList>
 
-	<!-- We assume an existing installation if ${installdir}/uninstall.exe exists -->
-	<ruleList>
-                        <fileTest condition="exists" path="${installdir}/uninstall.exe"/>
-                    </ruleList>
-                </actionGroup>
-            </preInstallationActionList>
             <startMenuShortcutList>
                 <startMenuShortcut>
                     <comment>Uninstall ${product_fullname}</comment>
@@ -155,7 +144,117 @@
             </ruleList>
         </throwError>
     </initializationActionList>
+    <preInstallationActionList>
+        <actionGroup>
+            <actionList>
+                <setInstallerVariable name="installationType" value="upgrade"/>
+            </actionList>
+            <ruleList>
+                <fileTest condition="exists" path="${installdir}/uninstall.exe"/>
+            </ruleList>
+        </actionGroup>
+        <!-- Don't go down if we can't find/run u1sdtool, this
+             case will still occur on a clean install. -->
+        <runProgram>
+            <abortOnError>0</abortOnError>
+            <showMessageOnError>0</showMessageOnError>
+            <program>${installdir}/dist/u1sdtool.exe</program>
+            <programArguments>-q</programArguments>
+            <ruleList>
+                <fileTest condition="exists" path="${installdir}/dist/u1sdtool.exe"/>
+            </ruleList>
+        </runProgram>
+        <!-- We need to kill any existing U1 executables. This script
+             will find any of the listed executables names which are
+             running and then terminate them. -->
+        <writeFile>
+            <path>${system_temp_directory}/killall.vbs</path>
+            <text>Option Explicit
+Dim wmi, process, processes 
+
+' Connect to the local machine
+Set wmi = GetObject("winmgmts:{impersonationLevel=impersonate}!\\.\root\cimv2") 
+
+' Find a list of all possible Ubuntu One executables that could be running.
+' NOTE: We expect ubuntuone-syncdaemon to have been shutdown via u1sdtool
+'       prior to running this, but if we get this far and it has failed to
+'       shutdown nicely, we do want to kill it before continuing.
+Set processes = wmi.ExecQuery _
+("Select * from Win32_Process Where Name Like '%ubuntu%'")
+
+' Terminate each process that isn't our installer.
+For Each process in processes 
+If InStr(1, process.Name, "windows-installer") = 0 Then
+    process.Terminate()
+End If
+Next
+
+WScript.Quit 0
+            </text>
+        </writeFile>
+        <runProgram>
+            <program>cscript</program>
+            <programArguments>/NOLOGO "${system_temp_directory}/killall.vbs"</programArguments>
+            <!-- Don't stop if this doesn't work. We can more than
+                 likely live just fine. -->
+            <abortOnError>0</abortOnError>
+            <showMessageOnError>0</showMessageOnError>
+            <ruleList>
+                <fileTest condition="exists" path="${system_temp_directory}/killall.vbs"/>
+            </ruleList>
+        </runProgram>
+        <showProgressDialog>
+            <title>Please wait...</title>
+            <actionList>
+                <!-- Make a backup of uninstall.exe. The uninstaller gets
+                     confused when it goes to access uninstall.dat so
+                     we operate on our own copies. -->
+                <copyFile>
+                    <destination>${installdir}/uninstall-backup.exe</destination>
+                    <origin>${installdir}/uninstall.exe</origin>
+                    <ruleList>
+                        <fileTest condition="exists" path="${installdir}/uninstall.exe"/>
+                    </ruleList>
+                </copyFile>
+                <copyFile>
+                    <destination>${installdir}/uninstall-backup.dat</destination>
+                    <origin>${installdir}/uninstall.dat</origin>
+                    <ruleList>
+                        <fileTest condition="exists" path="${installdir}/uninstall.dat"/>
+                    </ruleList>
+                </copyFile>
+                <runProgram>
+                    <program>${installdir}/uninstall-backup.exe</program>
+                    <programArguments>--mode unattended</programArguments>
+                    <progressText>Uninstalling previous version</progressText>
+                    <ruleList>
+                        <fileTest condition="exists" path="${installdir}/uninstall-backup.exe"/>
+                    </ruleList>
+                </runProgram>
+            </actionList>
+        </showProgressDialog>
+    </preInstallationActionList>
     <postInstallationActionList>
+         <!-- Replace the uninstaller and dat file so they
+              can be used by InstallBuilder -->
+         <copyFile>
+           <destination>${installdir}\uninstall.exe</destination>
+            <origin>${installdir}\uninstall-backup.exe</origin>
+            <ruleList>
+                <fileExists>
+                    <path>${installdir}\uninstall-backup.exe</path>
+                </fileExists>
+            </ruleList>
+        </copyFile>
+        <copyFile>
+            <destination>${installdir}\uninstall.dat</destination>
+            <origin>${installdir}\uninstall-backup.dat</origin>
+            <ruleList>
+                <fileExists>
+                    <path>${installdir}\uninstall-backup.dat</path>
+                </fileExists>
+            </ruleList>
+        </copyFile>
         <registrySet>
             <key>HKEY_LOCAL_MACHINE\SOFTWARE\${project.fullName}\</key>
             <name>path-ubuntuone-syncdaemon</name>
@@ -187,6 +286,8 @@
                 <platformTest type="windows-7" />
                 <platformTest type="windows-8" />
             </ruleList>
+            <abortOnError>0</abortOnError>
+            <showMessageOnError>0</showMessageOnError>
         </runProgram>
         <runProgram>
             <!-- Outbound Firewall allowance -->
@@ -199,6 +300,8 @@
                 <platformTest type="windows-7" />
                 <platformTest type="windows-8" />
             </ruleList>
+            <abortOnError>0</abortOnError>
+            <showMessageOnError>0</showMessageOnError>
         </runProgram>
         <runProgram>
             <program>netsh.exe</program>
@@ -207,17 +310,14 @@
                 <!-- This usage of netsh is for XP. -->
                 <platformTest type="windows-xp" />
             </ruleList>
+            <abortOnError>0</abortOnError>
+            <showMessageOnError>0</showMessageOnError>
         </runProgram>
         <runProgram>
             <program>${windows_folder_system}\RunDll32.exe</program>
             <programArguments>"${installdir}\dist\VistaLib32.dll" RunNonElevated "${installdir}\dist\ubuntuone-control-panel-qt.exe" --installer --with-icon &amp;</programArguments>
             <useMSDOSPath>0</useMSDOSPath>
             <ruleList>
-                <compareText>
-                    <logic>does_not_equal</logic>
-                    <text>${installationType}</text>
-                    <value>upgrade</value>
-                </compareText>
                 <platformTest>
                     <type>windows-x86</type>
                 </platformTest>
@@ -228,27 +328,11 @@
             <programArguments>"${installdir}\dist\VistaLib64.dll" RunNonElevated "${installdir}\dist\ubuntuone-control-panel-qt.exe" --installer --with-icon &amp;</programArguments>
             <useMSDOSPath>0</useMSDOSPath>
             <ruleList>
-                <compareText>
-                    <logic>does_not_equal</logic>
-                    <text>${installationType}</text>
-                    <value>upgrade</value>
-                </compareText>
                 <platformTest>
                     <type>windows-x64</type>
                 </platformTest>
             </ruleList>
         </runProgram>
-        <!-- TODO: remove this showInfo? -->
-        <showInfo>
-            <text>Please reboot to finish upgrade.</text>
-            <ruleList>
-                <compareText>
-                    <logic>equals</logic>
-                    <text>${installationType}</text>
-                    <value>upgrade</value>
-                </compareText>
-            </ruleList>
-        </showInfo>
         <createDirectory>
             <path>${windows_folder_common_appdata}\ubuntuone</path>
         </createDirectory>
@@ -351,7 +435,46 @@
         <deleteFile>
             <path>c:\vc_red.cab</path>
         </deleteFile>
+        <deleteFile>
+            <path>${installdir}/uninstall-backup.exe</path>
+            <ruleList>
+                <fileExists>
+                    <path>${installdir}/uninstall-backup.exe</path>
+                </fileExists>
+            </ruleList>
+        </deleteFile>
+        <deleteFile>
+            <path>${installdir}/uninstall-backup.dat</path>
+            <ruleList>
+                <fileExists>
+                    <path>${installdir}/uninstall-backup.dat</path>
+                </fileExists>
+            </ruleList>
+        </deleteFile>
     </postInstallationActionList>
+    <preUninstallationActionList>
+        <deleteFile>
+            <!-- Since install.log is added programmatically by BitRock
+                 itself, rather than copied, it doesn't get removed on
+                 uninstall. -->
+            <path>${installDir}/install.log</path>
+            <ruleList>
+                <fileExists>
+                    <path>${installdir}\install.log</path>
+                </fileExists>
+            </ruleList>
+        </deleteFile>
+        <deleteFile>
+            <!-- Since update.ini is added programmatically rather than
+                 copied, it doesn't get removed on uninstall. -->
+            <path>${installDir}/update.ini</path>
+            <ruleList>
+                <fileExists>
+                    <path>${installdir}\update.ini</path>
+                </fileExists>
+            </ruleList>
+        </deleteFile>
+    </preUninstallationActionList>
     <compressionAlgorithm>lzma</compressionAlgorithm>
     <defaultInstallationMode>unattended</defaultInstallationMode>
     <disableSplashScreen>1</disableSplashScreen>
@@ -359,7 +482,7 @@
     <enableTimestamp>1</enableTimestamp>
     <installationLogFile>${installdir}/install.log</installationLogFile>
     <saveRelativePaths>1</saveRelativePaths>
-    <unattendedModeUI>minimal</unattendedModeUI>
+    <unattendedModeUI>minimalWithDialogs</unattendedModeUI>
     <vendor>Canonical</vendor>
     <windowsSoftwareRegistryPrefix>${product_fullname}</windowsSoftwareRegistryPrefix>
     <customLanguageFileList>