Clean up code relating to interactive pkg installations (#2803)

Author: zorgiepoo

Autoupdate/AppInstaller.m

@@ -599,7 +599,7 @@ - (void)handleMessageWithIdentifier:(int32_t)identifier data:(NSData *)data
     } else if (identifier == SPUSentUpdateAppcastItemData) {
         SUAppcastItem *updateItem = (data != nil) ? (SUAppcastItem *)SPUUnarchiveRootObjectSecurely(data, [SUAppcastItem class]) : nil;
         if (updateItem != nil) {
-            SPUInstallationInfo *installationInfo = [[SPUInstallationInfo alloc] initWithAppcastItem:updateItem canSilentlyInstall:[_installer canInstallSilently]];
+            SPUInstallationInfo *installationInfo = [[SPUInstallationInfo alloc] initWithAppcastItem:updateItem];
 
             NSData *archivedData = SPUArchiveRootObjectSecurely(installationInfo);
             if (archivedData != nil) {
@@ -612,7 +612,7 @@ - (void)handleMessageWithIdentifier:(int32_t)identifier data:(NSData *)data
         uint8_t showsUI = *((const uint8_t *)data.bytes + 1);
 
         dispatch_async(dispatch_get_main_queue(), ^{
-            // This flag has an impact on interactive type installations and showing UI progress during non-interactive installations
+            // This flag has an impact on showing UI progress during installations
             self->_shouldShowUI = (BOOL)showsUI;
             // Don't test if the application was alive initially, leave that to the progress agent if we decide to relaunch
             self->_shouldRelaunch = (BOOL)relaunch;
@@ -679,18 +679,16 @@ - (void)startInstallation SPU_OBJC_DIRECT
             return;
         }
 
-        uint8_t canPerformSilentInstall = (uint8_t)[installer canInstallSilently];
-        
         dispatch_async(dispatch_get_main_queue(), ^{
             self->_installer = installer;
 
             os_unfair_lock_lock(&self->_newConnectionLock);
             self->_performedStage1Installation = YES;
             os_unfair_lock_unlock(&self->_newConnectionLock);
 
-            uint8_t sendInformation[] = {canPerformSilentInstall, (uint8_t)self->_targetTerminated};
+            uint8_t targetTerminated = (uint8_t)self->_targetTerminated;
 
-            NSData *sendData = [NSData dataWithBytes:sendInformation length:sizeof(sendInformation)];
+            NSData *sendData = [NSData dataWithBytes:&targetTerminated length:sizeof(targetTerminated)];
 
             [self->_communicator handleMessageWithIdentifier:SPUInstallationFinishedStage1 data:sendData];
 
@@ -705,37 +703,27 @@ - (void)startInstallation SPU_OBJC_DIRECT
 
 - (void)performStage2Installation SPU_OBJC_DIRECT
 {
-    BOOL canPerformSecondStage = _shouldShowUI || [_installer canInstallSilently];
-    if (canPerformSecondStage) {
-        _performedStage2Installation = YES;
+    _performedStage2Installation = YES;
+    
+    dispatch_async(dispatch_get_main_queue(), ^{
+        uint8_t targetTerminated = (uint8_t)self->_targetTerminated;
 
-        dispatch_async(dispatch_get_main_queue(), ^{
-            uint8_t targetTerminated = (uint8_t)self->_targetTerminated;
-            
-            NSData *sendData = [NSData dataWithBytes:&targetTerminated length:sizeof(targetTerminated)];
-            [self->_communicator handleMessageWithIdentifier:SPUInstallationFinishedStage2 data:sendData];
-            
-            // Don't check if the target is already terminated, leave that to the progress agent
-            // We could be slightly off if there were multiple instances running
-            [self->_agentConnection.agent sendTerminationSignal];
-        });
-    } else {
-        _installer = nil;
+        NSData *sendData = [NSData dataWithBytes:&targetTerminated length:sizeof(targetTerminated)];
+        [self->_communicator handleMessageWithIdentifier:SPUInstallationFinishedStage2 data:sendData];
 
-        dispatch_async(dispatch_get_main_queue(), ^{
-            [self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to resume installer on stage 2 because installation cannot be installed silently" }]];
-        });
-    }
+        // Don't check if the target is already terminated, leave that to the progress agent
+        // We could be slightly off if there were multiple instances running
+        [self->_agentConnection.agent sendTerminationSignal];
+    });
 }
 
 - (void)finishInstallationAfterHostTermination SPU_OBJC_DIRECT
 {
     assert(self->_targetTerminated);
 
-    // Show our installer progress UI tool if only after a certain amount of time passes,
-    // and if our installer is silent (i.e, doesn't show progress on its own)
+    // Show our installer progress UI tool if only after a certain amount of time passes
     __block BOOL shouldShowUIProgress = YES;
-    if (self->_shouldShowUI && [self->_installer canInstallSilently]) {
+    if (self->_shouldShowUI) {
         // Ask the updater if it is still alive
         // If they are, we will receive a pong response back
         // Reset if we received a pong just to be on the safe side

Autoupdate/SPUInstallationInfo.h

@@ -14,10 +14,9 @@ NS_ASSUME_NONNULL_BEGIN
 
 SPU_OBJC_DIRECT_MEMBERS @interface SPUInstallationInfo : NSObject <NSSecureCoding>
 
-- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem canSilentlyInstall:(BOOL)canSilentlyInstall;
+- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem;
 
 @property (nonatomic, readonly) SUAppcastItem *appcastItem;
-@property (nonatomic, readonly) BOOL canSilentlyInstall;
 
 @property (nonatomic) BOOL systemDomain;
 

Autoupdate/SPUInstallationInfo.m

@@ -19,23 +19,21 @@
 @implementation SPUInstallationInfo
 
 @synthesize appcastItem = _appcastItem;
-@synthesize canSilentlyInstall = _canSilentlyInstall;
 @synthesize systemDomain = _systemDomain;
 
-- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem canSilentlyInstall:(BOOL)canSilentlyInstall systemDomain:(BOOL)systemDomain
+- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem systemDomain:(BOOL)systemDomain
 {
     self = [super init];
     if (self != nil) {
         _appcastItem = appcastItem;
-        _canSilentlyInstall = canSilentlyInstall;
         _systemDomain = systemDomain;
     }
     return self;
 }
 
-- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem canSilentlyInstall:(BOOL)canSilentlyInstall
+- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem
 {
-    return [self initWithAppcastItem:appcastItem canSilentlyInstall:canSilentlyInstall systemDomain:NO];
+    return [self initWithAppcastItem:appcastItem systemDomain:NO];
 }
 
 - (nullable instancetype)initWithCoder:(NSCoder *)decoder
@@ -45,16 +43,18 @@ - (nullable instancetype)initWithCoder:(NSCoder *)decoder
         return nil;
     }
 
-    BOOL canSilentlyInstall = [decoder decodeBoolForKey:SUCanSilentlyInstallKey];
     BOOL systemDomain = [decoder decodeBoolForKey:SUSystemDomainKey];
-    return [self initWithAppcastItem:appcastItem canSilentlyInstall:canSilentlyInstall systemDomain:systemDomain];
+    return [self initWithAppcastItem:appcastItem systemDomain:systemDomain];
 }
 
 - (void)encodeWithCoder:(NSCoder *)coder
 {
     [coder encodeObject:_appcastItem forKey:SUAppcastItemKey];
-    [coder encodeBool:_canSilentlyInstall forKey:SUCanSilentlyInstallKey];
     [coder encodeBool:_systemDomain forKey:SUSystemDomainKey];
+    
+    // Installation types can always be silently installed for newer versions of Sparkle
+    // Still encode this key to maintain backwards compatibility with older Sparkle clients
+    [coder encodeBool:YES forKey:SUCanSilentlyInstallKey];
 }
 
 + (BOOL)supportsSecureCoding

Autoupdate/SUGuidedPackageInstaller.m

@@ -82,11 +82,6 @@ - (void)performCleanup
 {
 }
 
-- (BOOL)canInstallSilently
-{
-    return YES;
-}
-
 @end
 
 #endif

Autoupdate/SUInstallerProtocol.h

@@ -28,11 +28,6 @@ NS_ASSUME_NONNULL_BEGIN
 // Should be able to be called from any thread
 - (void)performCleanup;
 
-// Indicates whether or not this installer can install the update silently in the background, without hindering the user
-// If this returns NO, then the installation can fail if the user did not directly request for the install to occur.
-// Should be thread safe
-- (BOOL)canInstallSilently;
-
 @end
 
 NS_ASSUME_NONNULL_END

Autoupdate/SUPlainInstaller.m

@@ -406,9 +406,4 @@ - (void)performCleanup
     }
 }
 
-- (BOOL)canInstallSilently
-{
-    return YES;
-}
-
 @end

Sparkle/SPUAutomaticUpdateDriver.m

@@ -31,7 +31,7 @@ @implementation SPUAutomaticUpdateDriver
     __weak id<SPUUserDriver> _userDriver;
     __weak id _updaterDelegate;
 
-    BOOL _willInstallSilently;
+    BOOL _installerDidFinishPreparation;
 }
 
 - (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id <SPUUserDriver>)userDriver updaterDelegate:(nullable id <SPUUpdaterDelegate>)updaterDelegate
@@ -95,14 +95,14 @@ - (BOOL)showingUpdate
     return NO;
 }
 
-- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately silently:(BOOL)willInstallSilently
+- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately
 {
-    _willInstallSilently = willInstallSilently;
+    _installerDidFinishPreparation = YES;
 
     if (!willInstallImmediately) {
         BOOL installationHandledByDelegate = NO;
         id<SPUUpdaterDelegate> updaterDelegate = _updaterDelegate;
-        if (_willInstallSilently && [updaterDelegate respondsToSelector:@selector(updater:willInstallUpdateOnQuit:immediateInstallationBlock:)]) {
+        if ([updaterDelegate respondsToSelector:@selector(updater:willInstallUpdateOnQuit:immediateInstallationBlock:)]) {
             __weak __typeof__(self) weakSelf = self;
             installationHandledByDelegate = [updaterDelegate updater:_updater willInstallUpdateOnQuit:_updateItem immediateInstallationBlock:^{
                 dispatch_async(dispatch_get_main_queue(), ^{
@@ -139,7 +139,7 @@ - (void)abortUpdate
 
 - (void)abortUpdateWithError:(NSError *)error
 {
-    BOOL showNextUpdateImmediately = (error == nil || error.code == SUInstallationAuthorizeLaterError) && (!_willInstallSilently || _updateItem.criticalUpdate || _updateItem.isInformationOnlyUpdate);
+    BOOL showNextUpdateImmediately = (error == nil || error.code == SUInstallationAuthorizeLaterError) && (!_installerDidFinishPreparation || _updateItem.criticalUpdate || _updateItem.isInformationOnlyUpdate);
 
     [_coreDriver abortUpdateAndShowNextUpdateImmediately:showNextUpdateImmediately error:error];
 }

Sparkle/SPUCoreBasedUpdateDriver.h

@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryAppcastItem;
 
-- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately silently:(BOOL)willInstallSilently;
+- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately;
 
 - (void)coreDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error;
 

Sparkle/SPUCoreBasedUpdateDriver.m

@@ -295,9 +295,9 @@ - (void)installerDidExtractUpdateWithProgress:(double)progress
     }
 }
 
-- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately silently:(BOOL)willInstallSilently
+- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately
 {
-    [_delegate installerDidFinishPreparationAndWillInstallImmediately:willInstallImmediately silently:willInstallSilently];
+    [_delegate installerDidFinishPreparationAndWillInstallImmediately:willInstallImmediately];
 }
 
 - (void)finishInstallationWithResponse:(SPUUserUpdateChoice)response displayingUserInterface:(BOOL)displayingUserInterface

Sparkle/SPUInstallationType.h

@@ -11,7 +11,7 @@
 
 #define SPUInstallationTypeApplication @"application" // the default installation type for ordinary application updates
 #define SPUInstallationTypeGuidedPackage @"package" // the preferred installation type for package installations
-#define SPUInstallationTypeInteractivePackage @"interactive-package" // the deprecated installation type; use guided package instead
+#define SPUInstallationTypeInteractivePackage @"interactive-package" // removed installation type; use guided package instead
 
 #define SPUInstallationTypesArray (@[SPUInstallationTypeApplication, SPUInstallationTypeGuidedPackage])
 #define SPUValidInstallationType(x) ((x != nil) && [SPUInstallationTypesArray containsObject:(NSString * _Nonnull)x])