check for software updates

- automatically on launch by default, no less than 30 days from the last check, but can be disabled in Settings
- on-demand from Mariani > Check for Updates... menu item

Author: sh95014

source/frontends/mariani/AppDelegate.mm

@@ -222,6 +222,11 @@ - (void)applicationDidFinishLaunching:(NSNotification *)aNotification {
 #endif
 
     [self.emulatorVC start];
+    
+    if ([[UserDefaults sharedInstance] automaticallyCheckForUpdates]) {
+        // parameter must be nil for a silent check
+        [self checkForUpdates:nil];
+    }
 }
 
 - (void)applicationWillTerminate:(NSNotification *)aNotification {
@@ -409,6 +414,127 @@ - (IBAction)aboutLinkAction:(id)sender {
     [[NSWorkspace sharedWorkspace] openURL:[NSURL URLWithString:@"https://github.com/sh95014/AppleWin"]];
 }
 
+- (IBAction)checkForUpdates:(id)sender {
+    NSLog(@"%s", __PRETTY_FUNCTION__);
+    
+    if (sender == nil) {
+        // not user-initiated
+        NSDate *lastUpdateCheckDate = [[UserDefaults sharedInstance] lastUpdateCheckDate];
+        if (lastUpdateCheckDate != nil &&                                       // never checked
+            [lastUpdateCheckDate timeIntervalSinceNow] > -30 * 24 * 60 * 60) {  // checked over 30 days ago
+            NSLog(@"Skip, last check only %f seconds ago", -[lastUpdateCheckDate timeIntervalSinceNow]);
+            return;
+        }
+    }
+    
+    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0), ^{
+        enum {
+            UP_TO_DATE, UPDATE_AVAILABLE, UNEXPECTED_RESPONSE, FETCH_ERROR,
+        } updateAction = UNEXPECTED_RESPONSE;
+        NSString *updateURLString = nil;
+        NSURL *url = [NSURL URLWithString:@"https://api.github.com/repos/sh95014/AppleWin/releases/latest"];
+        NSData *data = [NSData dataWithContentsOfURL:url];
+        NSError *error = nil;
+        id object = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
+        if (error == nil) {
+            if ([object isKindOfClass:[NSDictionary class]]) {
+                NSDictionary *results = object;
+                if (![[results objectForKey:@"prerelease"] boolValue]) {
+                    // "prerelease": false
+                    if ((updateURLString = [[results objectForKey:@"html_url"] stringValue]) != nil) {
+                        // "html_url": "https://...",
+                        NSString *latestReleaseString = [[results objectForKey:@"name"] stringValue];
+                        // e.g., "name": "Mariani 1.5 (2)" => ["Mariani", "1.5", "(2)"]
+                        NSArray *latestReleaseParts = [latestReleaseString componentsSeparatedByCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
+                        if (latestReleaseParts.count == 3) {
+                            // e.g., "1.5" => ["1", "5"]
+                            NSArray<NSString *> *latestVersionParts = [latestReleaseParts[1] componentsSeparatedByString:@"."];
+                            // e.g., "(2)" => "2"
+                            NSCharacterSet *parentheses = [NSCharacterSet characterSetWithCharactersInString:@"()"];
+                            NSString *latestBuildString = [latestReleaseParts[2] stringByTrimmingCharactersInSet:parentheses];
+                            
+                            NSDictionary *infoDictionary = [[NSBundle mainBundle] infoDictionary];
+                            NSString *myVersionString = infoDictionary[@"CFBundleShortVersionString"];
+                            NSArray<NSString *> *myVersionParts = [myVersionString componentsSeparatedByString:@"."];
+                            NSString *myBuildString = infoDictionary[@"CFBundleVersion"];
+                            
+                            NSInteger latestVersion =
+                                latestVersionParts[0].integerValue * 1000000 +
+                                latestVersionParts[1].integerValue * 1000 +
+                                latestBuildString.integerValue;
+                            NSInteger myVersion =
+                                myVersionParts[0].integerValue * 1000000 +
+                                myVersionParts[1].integerValue * 1000 +
+                                myBuildString.integerValue;
+                            
+                            NSLog(@"Latest version: %ld.%ld (%ld)",
+                                  latestVersionParts[0].integerValue,
+                                  latestVersionParts[1].integerValue,
+                                  latestBuildString.integerValue);
+                            updateAction = (latestVersion > myVersion) ? UPDATE_AVAILABLE : UP_TO_DATE;
+                            [[UserDefaults sharedInstance] setLastUpdateCheckDate:[NSDate now]];
+                        }
+                        else {
+                            NSLog(@"Unexpected version '%@'", latestReleaseString);
+                        }
+                    }
+                    else {
+                        NSLog(@"Unexpected html_url");
+                    }
+                }
+            }
+            else {
+                NSLog(@"Unexpected data format");
+            }
+        }
+        else {
+            updateAction = FETCH_ERROR;
+            NSLog(@"Error: %@", error.localizedDescription);
+        }
+        if (updateAction == UPDATE_AVAILABLE || sender != nil) {
+            // pop a dialog if updates are available, or if this was initiated
+            // by the user from the menu.
+            dispatch_async(dispatch_get_main_queue(), ^{
+                NSAlert *alert = [[NSAlert alloc] init];
+                
+                switch (updateAction) {
+                    case UP_TO_DATE:
+                        alert.messageText = NSLocalizedString(@"Up-to-Date", @"");
+                        alert.informativeText = NSLocalizedString(@"No newer version of this software is available.", @"");
+                        alert.alertStyle = NSAlertStyleInformational;
+                        alert.icon = [NSImage imageWithSystemSymbolName:@"hand.thumbsup" accessibilityDescription:@""];
+                        break;
+                    case UPDATE_AVAILABLE:
+                        alert.messageText = NSLocalizedString(@"Update Available", @"");
+                        alert.informativeText = NSLocalizedString(@"A newer version of this software is available.", @"");
+                        alert.alertStyle = NSAlertStyleInformational;
+                        alert.icon = [NSImage imageWithSystemSymbolName:@"square.and.arrow.down" accessibilityDescription:@""];
+                        [alert addButtonWithTitle:NSLocalizedString(@"Download…", @"")];
+                        [alert addButtonWithTitle:NSLocalizedString(@"Cancel", @"")];
+                        break;
+                    case UNEXPECTED_RESPONSE:
+                        alert.messageText = NSLocalizedString(@"Error", @"");
+                        alert.informativeText = NSLocalizedString(@"Unexpected server response", @"");
+                        alert.alertStyle = NSAlertStyleWarning;
+                        alert.icon = [NSImage imageWithSystemSymbolName:@"exclamationmark.triangle" accessibilityDescription:@""];
+                        break;
+                    case FETCH_ERROR:
+                        alert.messageText = NSLocalizedString(@"Error", @"");
+                        alert.informativeText = error.localizedDescription;
+                        alert.alertStyle = NSAlertStyleWarning;
+                        alert.icon = [NSImage imageWithSystemSymbolName:@"exclamationmark.triangle" accessibilityDescription:@""];
+                        break;
+                }
+                [alert beginSheetModalForWindow:self.window completionHandler:^(NSModalResponse returnCode) {
+                    if (returnCode == NSAlertFirstButtonReturn) {
+                        [[NSWorkspace sharedWorkspace] openURL:[NSURL URLWithString:updateURLString]];
+                    }
+                }];
+            });
+        }
+    });
+}
+
 #pragma mark - App menu actions
 
 - (IBAction)preferencesAction:(id)sender {

source/frontends/mariani/Base.lproj/MainMenu.xib

@@ -56,6 +56,12 @@
                                     <action selector="preferencesAction:" target="Voe-Tx-rLC" id="1Hw-i2-VAj"/>
                                 </connections>
                             </menuItem>
+                            <menuItem title="Check for Updates…" id="aV1-6h-w7i">
+                                <modifierMask key="keyEquivalentModifierMask"/>
+                                <connections>
+                                    <action selector="checkForUpdates:" target="Voe-Tx-rLC" id="mJt-Z9-0nX"/>
+                                </connections>
+                            </menuItem>
                             <menuItem isSeparatorItem="YES" id="wFC-TO-SCJ"/>
                             <menuItem title="Services" id="NMo-om-nkz">
                                 <modifierMask key="keyEquivalentModifierMask"/>

source/frontends/mariani/Localizable.xcstrings

@@ -123,6 +123,16 @@
         }
       }
     },
+    "A newer version of this software is available." : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "已有比本軟體較新的版本"
+          }
+        }
+      }
+    },
     "About %@" : {
       "localizations" : {
         "zh-Hant" : {
@@ -441,6 +451,16 @@
         }
       }
     },
+    "Download…" : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "前往下載⋯"
+          }
+        }
+      }
+    },
     "Echo (speech)" : {
       "localizations" : {
         "zh-Hant" : {
@@ -492,6 +512,16 @@
         }
       }
     },
+    "Error" : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "錯誤"
+          }
+        }
+      }
+    },
     "Examine…" : {
       "comment" : "browse disk image",
       "localizations" : {
@@ -726,6 +756,16 @@
         }
       }
     },
+    "No newer version of this software is available." : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "本軟體仍是最新版本"
+          }
+        }
+      }
+    },
     "None" : {
       "localizations" : {
         "zh-Hant" : {
@@ -1210,6 +1250,16 @@
         }
       }
     },
+    "Unexpected server response" : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "未預期的伺服器回應"
+          }
+        }
+      }
+    },
     "Unknown" : {
       "localizations" : {
         "zh-Hant" : {
@@ -1240,6 +1290,26 @@
         }
       }
     },
+    "Up-to-Date" : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "仍是最新"
+          }
+        }
+      }
+    },
+    "Update Available" : {
+      "localizations" : {
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "已有更新"
+          }
+        }
+      }
+    },
     "Uthernet I (network)" : {
       "localizations" : {
         "zh-Hant" : {

source/frontends/mariani/UserDefaults.h

@@ -21,6 +21,7 @@ extern NSString *GameControllerNumericKeypad;
 @property (nonatomic) NSURL *screenshotsFolder;
 @property (nonatomic) BOOL mapDeleteKeyToLeftArrow;
 @property (nonatomic) BOOL takeScreenshotsBasedOnWindowSize;
+@property (nonatomic) BOOL automaticallyCheckForUpdates;
 
 @property (nonatomic) NSString *gameController;
 @property (readonly) NSArray<NSString *> *joystickOptions;
@@ -31,6 +32,8 @@ extern NSString *GameControllerNumericKeypad;
 
 @property (nonatomic) BOOL showStatusBar;
 
+@property (nonatomic) NSDate *lastUpdateCheckDate;
+
 @end
 
 @interface GCController (Mariani)

source/frontends/mariani/UserDefaults.mm

@@ -13,11 +13,13 @@
 #define SCREENSHOTS_FOLDER_KEY                  @"ScreenshotsFolder"
 #define MAP_DELETE_KEY_TO_LEFT_ARROW            @"MapDeleteKeyToLeftArrow"
 #define TAKE_SCREENSHOTS_BASED_ON_WINDOW_SIZE   @"TakeScreenshotsBasedOnWindowSize"
+#define AUTOMATICALLY_CHECK_FOR_UPDATES         @"AutomaticallyCheckForUpdates"
 #define GAME_CONTROLLER_KEY                     @"GameController"
 #define JOYSTICK_MAPPING_KEY                    @"JoystickMapping"
 #define JOYSTICK_BUTTON0_MAPPING_KEY            @"JoystickButton0Mapping"
 #define JOYSTICK_BUTTON1_MAPPING_KEY            @"JoystickButton1Mapping"
 #define SHOW_STATUS_BAR                         @"ShowStatusBar"
+#define LAST_UPDATE_CHECK_DATE                  @"LastUpdateCheckDate"
 
 NSString *GameControllerNone = @"GameControllerNone";
 NSString *GameControllerNumericKeypad = @"GameControllerNumericKeypad";
@@ -79,6 +81,15 @@ - (void)setTakeScreenshotsBasedOnWindowSize:(BOOL)takeScreenshotsBasedOnWindowSi
     [[NSUserDefaults standardUserDefaults] setBool:takeScreenshotsBasedOnWindowSize forKey:TAKE_SCREENSHOTS_BASED_ON_WINDOW_SIZE];
 }
 
+- (BOOL)automaticallyCheckForUpdates {
+    NSNumber *value = [[NSUserDefaults standardUserDefaults] valueForKey:AUTOMATICALLY_CHECK_FOR_UPDATES];
+    return (value == nil) ? YES : [value boolValue];
+}
+
+- (void)setAutomaticallyCheckForUpdates:(BOOL)automaticallyCheckForUpdates {
+    [[NSUserDefaults standardUserDefaults] setBool:automaticallyCheckForUpdates forKey:AUTOMATICALLY_CHECK_FOR_UPDATES];
+}
+
 - (NSString *)gameController {
     NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
     NSString *fullName = [defaults stringForKey:GAME_CONTROLLER_KEY];
@@ -187,6 +198,14 @@ - (void)setShowStatusBar:(BOOL)showStatusBar {
     [[NSUserDefaults standardUserDefaults] setBool:showStatusBar forKey:SHOW_STATUS_BAR];
 }
 
+- (NSDate *)lastUpdateCheckDate {
+    return [[NSUserDefaults standardUserDefaults] valueForKey:LAST_UPDATE_CHECK_DATE];
+}
+
+- (void)setLastUpdateCheckDate:(NSDate *)date {
+    [[NSUserDefaults standardUserDefaults] setValue:date forKey:LAST_UPDATE_CHECK_DATE];
+}
+
 @end
 
 @implementation GCController (Mariani)

source/frontends/mariani/mul.lproj/MainMenu.xcstrings

@@ -181,6 +181,24 @@
         }
       }
     },
+    "aV1-6h-w7i.title" : {
+      "comment" : "Class = \"NSMenuItem\"; title = \"Check for Updates…\"; ObjectID = \"aV1-6h-w7i\";",
+      "extractionState" : "extracted_with_value",
+      "localizations" : {
+        "en" : {
+          "stringUnit" : {
+            "state" : "new",
+            "value" : "Check for Updates…"
+          }
+        },
+        "zh-Hant" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "查詢更新版本⋯"
+          }
+        }
+      }
+    },
     "AYu-sK-qS6.title" : {
       "comment" : "Class = \"NSMenu\"; title = \"Main Menu\"; ObjectID = \"AYu-sK-qS6\";",
       "extractionState" : "extracted_with_value",