Allow an appcast to prevent the new version from being installed auto…

…matically (#1688)
sparkle-project · Dec 2, 2020 · 65eb63f · 65eb63f
1 parent d4d4c68
commit 65eb63f
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 3 deletions.
diff --git a/Sparkle/SUAppcastItem.h b/Sparkle/SUAppcastItem.h
@@ -34,6 +34,7 @@ SU_EXPORT @interface SUAppcastItem : NSObject
 @property (copy, readonly) NSDictionary *deltaUpdates;
 @property (strong, readonly) NSURL *infoURL;
 @property (copy, readonly) NSNumber* phasedRolloutInterval;
+@property (copy, readonly) NSString *minimumAutoupdateVersion;
 
 // Initializes with data from a dictionary provided by the RSS class.
 - (instancetype)initWithDictionary:(NSDictionary *)dict;

diff --git a/Sparkle/SUAppcastItem.m b/Sparkle/SUAppcastItem.m
@@ -29,6 +29,7 @@ @interface SUAppcastItem ()
 @property (strong, readwrite) NSURL *infoURL;
 @property (readwrite, copy) NSDictionary *propertiesDictionary;
 @property (copy, readwrite) NSNumber* phasedRolloutInterval;
+@property (copy, readwrite) NSString *minimumAutoupdateVersion;
 @end
 
 @implementation SUAppcastItem
@@ -48,6 +49,7 @@ @implementation SUAppcastItem
 @synthesize osString;
 @synthesize propertiesDictionary;
 @synthesize phasedRolloutInterval;
+@synthesize minimumAutoupdateVersion;
 
 - (BOOL)isDeltaUpdate
 {
@@ -154,7 +156,7 @@ - (instancetype)initWithDictionary:(NSDictionary *)dict failureReason:(NSString
             }
             return nil;
         }
-        
+
         if (enclosureURLString) {
             NSString *enclosureLengthString = [enclosure objectForKey:SURSSAttributeLength];
             long long contentLength = 0;
@@ -225,6 +227,8 @@ - (instancetype)initWithDictionary:(NSDictionary *)dict failureReason:(NSString
             }
             self.deltaUpdates = deltas;
         }
+
+        self.minimumAutoupdateVersion = [dict objectForKey:SUAppcastElementMinimumAutoupdateVersion];
     }
     return self;
 }

diff --git a/Sparkle/SUBasicUpdateDriver.h b/Sparkle/SUBasicUpdateDriver.h
@@ -25,6 +25,7 @@
 - (void)checkForUpdatesAtURL:(NSURL *)URL host:(SUHost *)host;
 
 - (BOOL)isItemNewer:(SUAppcastItem *)ui;
+- (BOOL)itemPreventsAutoupdate:(SUAppcastItem *)ui;
 - (BOOL)hostSupportsItem:(SUAppcastItem *)ui;
 - (BOOL)itemContainsSkippedVersion:(SUAppcastItem *)ui;
 - (BOOL)itemContainsValidUpdate:(SUAppcastItem *)ui;

diff --git a/Sparkle/SUBasicUpdateDriver.m b/Sparkle/SUBasicUpdateDriver.m
@@ -174,6 +174,11 @@ - (BOOL)isItemNewer:(SUAppcastItem *)ui
     return [[self versionComparator] compareVersion:[self.host version] toVersion:[ui versionString]] == NSOrderedAscending;
 }
 
+- (BOOL)itemPreventsAutoupdate:(SUAppcastItem *)ui
+{
+    return ([ui minimumAutoupdateVersion] && ! [[ui minimumAutoupdateVersion] isEqualToString:@""] && ([[self versionComparator] compareVersion:[self.host version] toVersion:[ui minimumAutoupdateVersion]] == NSOrderedAscending));
+}
+
 - (BOOL)itemContainsSkippedVersion:(SUAppcastItem *)ui
 {
     NSString *skippedVersion = [self.host objectForUserDefaultsKey:SUSkippedVersionKey];
@@ -239,6 +244,13 @@ - (void)didFindValidUpdate
 {
     assert(self.updateItem);
 
+    // Handle the case where the update indicates that an automatic update is only available for specific versions
+    if ([self itemPreventsAutoupdate:self.updateItem]) {
+        [self.updater setAutomaticallyDownloadsUpdates:NO]; // This call will persist this setting (automatic downloads will be permanently deactivated), but that is probably OK after the rare case of a non-automatically updateable update - the user can always reactivate this in the settings or when the update information window appears for the next time.
+        [self.updater checkForUpdatesInBackground]; // Will end up in SUUIBasedUpdateDriver instead of here
+        return;
+    }
+
     id<SUUpdaterPrivate> updater = self.updater;
 
     if ([[updater delegate] respondsToSelector:@selector(updater:didFindValidUpdate:)]) {

diff --git a/Sparkle/SUConstants.h b/Sparkle/SUConstants.h
@@ -75,6 +75,7 @@ extern NSString *const SUAppcastAttributePhasedRolloutInterval;
 
 extern NSString *const SUAppcastElementCriticalUpdate;
 extern NSString *const SUAppcastElementDeltas;
+extern NSString *const SUAppcastElementMinimumAutoupdateVersion;
 extern NSString *const SUAppcastElementMinimumSystemVersion;
 extern NSString *const SUAppcastElementMaximumSystemVersion;
 extern NSString *const SUAppcastElementReleaseNotesLink;

diff --git a/Sparkle/SUConstants.m b/Sparkle/SUConstants.m
@@ -65,6 +65,7 @@
 
 NSString *const SUAppcastElementCriticalUpdate = @"sparkle:criticalUpdate";
 NSString *const SUAppcastElementDeltas = @"sparkle:deltas";
+NSString *const SUAppcastElementMinimumAutoupdateVersion = @"sparkle:minimumAutoupdateVersion";
 NSString *const SUAppcastElementMinimumSystemVersion = @"sparkle:minimumSystemVersion";
 NSString *const SUAppcastElementMaximumSystemVersion = @"sparkle:maximumSystemVersion";
 NSString *const SUAppcastElementReleaseNotesLink = @"sparkle:releaseNotesLink";

diff --git a/Sparkle/SUUIBasedUpdateDriver.m b/Sparkle/SUUIBasedUpdateDriver.m
@@ -63,16 +63,21 @@ - (BOOL)shouldShowUpdateAlertForItem:(SUAppcastItem *)__unused item {
 - (void)didFindValidUpdate
 {
     id<SUUpdaterPrivate> updater = self.updater;
+    SUAppcastItem *updateItem = self.updateItem;
     if ([[updater delegate] respondsToSelector:@selector(updater:didFindValidUpdate:)]) {
-        [[updater delegate] updater:self.updater didFindValidUpdate:self.updateItem];
+        [[updater delegate] updater:self.updater didFindValidUpdate:updateItem];
+    }
+
+    // Handle the case where the update indicates that an automatic update is only available for specific versions
+    if ([self itemPreventsAutoupdate:self.updateItem]) {
+        self.automaticallyInstallUpdates = NO;
     }
 
     if (self.automaticallyInstallUpdates) {
         [self updateAlertFinishedWithChoice:SUInstallUpdateChoice forItem:nil];
         return;
     }
 
-    SUAppcastItem *updateItem = self.updateItem;
     if (![self shouldShowUpdateAlertForItem:updateItem]) {
         [self abortUpdate];
         return;