Changeset 7a72049

Timestamp:

Sep 23, 2018 3:33:29 AM (2 years ago)

Author:

meeh <meeh@…>

Branches:

master

Children:

e59d7a82

Parents:

3b38f5a

Message:

Mac OS X Launcher:

• Bugfixes as always
• Added Sparkle (native updater, ​https://sparkle-project.org/ )
• The launcher will now extract and overwrite older versions if found
• Rewrite of the java extraction part (to enable overwrite)
• Move more functionality to use EventManager? as it works quite well
• Added check for updates menu item

Location:

launchers/macosx

Files:

• I2PLauncher/Base.lproj/UserInterfaces.xib (modified) (2 diffs)
• I2PLauncher/I2PLauncher-Bridging-Header.h (modified) (1 diff)
• I2PLauncher/Info.plist (modified) (2 diffs)
• I2PLauncher/Storyboard.storyboard (modified) (1 diff)
• I2PLauncher/SwiftMainDelegate.swift (modified) (1 diff)
• I2PLauncher/routermgmt/RouterManager.swift (modified) (1 diff)
• I2PLauncher/routermgmt/RouterProcessStatus.swift (modified) (1 diff)
• I2PLauncher/userinterface/RouterStatusView.swift (modified) (3 diffs)
• I2PLauncher/userinterface/StatusBarController.swift (modified) (3 diffs)
• RouterTask.h (modified) (1 diff)
• RouterTask.mm (modified) (2 diffs)
• SBridge.h (modified) (1 diff)
• SBridge.mm (modified) (5 diffs)
• main.mm (modified) (3 diffs)
• src/main/java/net/i2p/launchers/BaseExtractor.java (modified) (3 diffs)

launchers/macosx/I2PLauncher/Base.lproj/UserInterfaces.xib

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="14113" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
+<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="14313.18" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
     <dependencies>
-        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="14113"/>
+        <deployment identifier="macosx"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="14313.18"/>
     </dependencies>
     <objects>
@@ -37 +38 @@
             <point key="canvasLocation" x="17" y="167"/>
         </menu>
+        <customObject id="xTS-ll-kWI" customClass="SUUpdater"/>
     </objects>
 </document>

launchers/macosx/I2PLauncher/I2PLauncher-Bridging-Header.h

@@ -6 +6 @@
 #import "AppDelegate.h"
 #import "RouterTask.h"
+#import "Sparkle/SUUpdater.h"
 

launchers/macosx/I2PLauncher/Info.plist

@@ -18 +18 @@
         <string>APPL</string>
         <key>CFBundleShortVersionString</key>
-        <string>1.0</string>
-        <key>CFBundleURLTypes</key>
-        <array>
-                <dict>
-                        <key>CFBundleTypeRole</key>
-                        <string>Editor</string>
-                        <key>CFBundleURLIconFile</key>
-                        <string>ItoopieTransparent</string>
-                        <key>CFBundleURLName</key>
-                        <string>http+i2p</string>
-                        <key>CFBundleURLSchemes</key>
-                        <array>
-                                <string>http+i2p</string>
-                        </array>
-                </dict>
-        </array>
+        <string>0.1.1</string>
         <key>CFBundleVersion</key>
-        <string>4</string>
+        <string>5</string>
         <key>LSApplicationCategoryType</key>
         <string>public.app-category.utilities</string>
@@ -55 +40 @@
         </array>
         <key>SUFeedURL</key>
-        <string>http://i2browser.i2p/updates/v1/appcast.xml</string>
+        <string>https://download.i2p2.de/macosx/sparkle/updates/v1/appcast.xml</string>
+        <key>SUPublicEDKey</key>
+        <string>weKSpHXfJzk+5qy3UVfqsUwTeLnT9WCFVMwd9yW0+DA=</string>
 </dict>
 </plist>

launchers/macosx/I2PLauncher/Storyboard.storyboard

@@ -155 +155 @@
                 </viewController>
                 <customObject id="d8g-wS-Zts" userLabel="First Responder" customClass="NSResponder" sceneMemberID="firstResponder"/>
+                <customObject id="4gn-BI-uSC" userLabel="Updater" customClass="SUUpdater"/>
             </objects>
             <point key="canvasLocation" x="-823" y="166"/>

launchers/macosx/I2PLauncher/SwiftMainDelegate.swift

@@ -70 +70 @@
   
   @objc func applicationDidFinishLaunching() {
-    print("Hello from swift!")
     var i2pPath = NSHomeDirectory()
     i2pPath += "/Library/I2P"
     
-    findInstalledI2PVersion()
+  }
+  
+  @objc func listenForEvent(eventName: String, callbackActionFn: @escaping ((Any?)->()) ) {
+    RouterManager.shared().eventManager.listenTo(eventName: eventName, action: callbackActionFn )
+  }
+  
+  @objc func triggerEvent(en: String, details: String? = nil) {
+    RouterManager.shared().eventManager.trigger(eventName: en, information: details)
   }
   

launchers/macosx/I2PLauncher/routermgmt/RouterManager.swift

@@ -39 +39 @@
     if (packedVersion.compare(currentVersion, options: .numeric) == .orderedDescending) {
       Swift.print("event! - router version: Packed version is newer, gonna re-deploy")
+      RouterManager.shared().eventManager.trigger(eventName: "router_must_upgrade", information: "got new version")
     } else {
       Swift.print("event! - router version: No update needed")

launchers/macosx/I2PLauncher/routermgmt/RouterProcessStatus.swift

@@ -37 +37 @@
     RouterManager.shared().eventManager.trigger(eventName: en, information: details)
   }
+
+  @objc func listenForEvent(eventName: String, callbackActionFn: @escaping ((Any?)->()) ) {
+    RouterManager.shared().eventManager.listenTo(eventName: eventName, action: callbackActionFn )
+  }
 }
 
 extension RouterProcessStatus {
-  static var isRouterRunning : Bool = false
-  static var isRouterChildProcess : Bool = false
+  static var isRouterRunning : Bool = (RouterManager.shared().getRouterTask() != nil)
+  static var isRouterChildProcess : Bool = (RouterManager.shared().getRouterTask() != nil)
   static var routerVersion : String? = Optional.none
-  static var routerUptime : String? = Optional.none{
-    //Called before the change
-    willSet(newValue){
-      print("RouterProcessStatus.routerUptime will change from ", (self.routerUptime ?? "nil"), " to "+(newValue ?? "nil"))
-    }
-    
-    //Called after the change
-    didSet{
-      print("RouterProcessStatus.routerUptime did change to "+self.routerUptime!)
-    }
-  }
   static var routerStartedAt : Date? = Optional.none
   static var knownJavaBinPath : String? = Optional.none

launchers/macosx/I2PLauncher/userinterface/RouterStatusView.swift

@@ -29 +29 @@
   @objc func actionBtnStartRouter(_ sender: Any?) {
     NSLog("START ROUTER")
-    if (!(RouterManager.shared().getRouterTask()?.isRunning())!) {
+    if (RouterManager.shared().getRouterTask() == nil) {
       SBridge.sharedInstance().startupI2PRouter(RouterProcessStatus.i2pDirectoryPath, javaBinPath: RouterProcessStatus.knownJavaBinPath!)
     }
@@ -37 +37 @@
   @objc func actionBtnStopRouter(_ sender: Any?) {
     NSLog("STOP ROUTER")
-    if ((RouterManager.shared().getRouterTask()?.isRunning())!) {
+    if (RouterManager.shared().getRouterTask() != nil) {
       NSLog("Found running router")
       RouterManager.shared().getRouterTask()?.requestShutdown()
@@ -45 +45 @@
   
   @objc func actionBtnRestartRouter(sender: Any?) {
-    if ((RouterManager.shared().getRouterTask()?.isRunning())!) {
+    if (RouterManager.shared().getRouterTask() != nil) {
       RouterManager.shared().getRouterTask()?.requestRestart()
     } else {

launchers/macosx/I2PLauncher/userinterface/StatusBarController.swift

@@ -10 +10 @@
 import Cocoa
 
-
 @objc class StatusBarController: NSObject, NSMenuDelegate {
   
   let popover = NSPopover()
   let statusItem = NSStatusBar.system().statusItem(withLength: NSVariableStatusItemLength)
-  //let storyboard = NSStoryboard(name: "Storyboard", bundle: nil)
+  let storyboard = NSStoryboard(name: "Storyboard", bundle: Bundle.main)
+  
+  var updateObjectRef : SUUpdater?
   
   @objc func handleOpenConsole(_ sender: Any?) {
@@ -24 +25 @@
     let menu = NSMenu()
     
+    let updateMenuItem = NSMenuItem(title: "Check for updates", action: #selector(self.updateObjectRef?.checkForUpdates(_:)), keyEquivalent: "U")
+    updateMenuItem.isEnabled = true
+    
     menu.addItem(NSMenuItem(title: "Open I2P Console", action: #selector(self.handleOpenConsole(_:)), keyEquivalent: "O"))
+    menu.addItem(NSMenuItem.separator())
+    menu.addItem(updateMenuItem)
     menu.addItem(NSMenuItem.separator())
     menu.addItem(NSMenuItem(title: "Quit I2P Launcher", action: #selector(SwiftMainDelegate.terminate(_:)), keyEquivalent: "q"))
@@ -35 +41 @@
     super.init()
     popover.contentViewController = PopoverViewController.freshController()
+    updateObjectRef = SUUpdater.shared()
+    updateObjectRef?.checkForUpdatesInBackground()
+    
     
     if let button = statusItem.button {

launchers/macosx/RouterTask.h

@@ -40 +40 @@
 @interface I2PRouterTask : NSObject
 @property (strong) NSTask* routerTask;
-
-// TODO: Not in use, remove?
-/*
-@property (strong) NSUserDefaults *userPreferences;
-@property (strong) NSFileHandle *readLogHandle;
-@property (strong) NSMutableData *totalLogData;
-@property (strong) NSFileHandle *input;
-*/
-
 @property (strong) NSPipe *processPipe;
 @property (atomic) BOOL isRouterRunning;

launchers/macosx/RouterTask.mm

@@ -45 +45 @@
         [self.routerTask setStandardError:self.processPipe];
 
-  /*
-  NSFileHandle *stdoutFileHandle = [self.processPipe fileHandleForReading];
-  dup2([[self.processPipe fileHandleForWriting] fileDescriptor], fileno(stdout));
-  auto source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, [stdoutFileHandle fileDescriptor], 0, dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0));
-  dispatch_source_set_event_handler(source, ^{
-    void* data = malloc(4096);
-    ssize_t readResult = 0;
-    do
-    {
-      errno = 0;
-      readResult = read([stdoutFileHandle fileDescriptor], data, 4096);
-    } while (readResult == -1 && errno == EINTR);
-    if (readResult > 0)
-    {
-      //AppKit UI should only be updated from the main thread
-      dispatch_async(dispatch_get_main_queue(),^{
-        NSString* stdOutString = [[NSString alloc] initWithBytesNoCopy:data length:readResult encoding:NSUTF8StringEncoding freeWhenDone:YES];
-        NSAttributedString* stdOutAttributedString = [[NSAttributedString alloc] initWithString:stdOutString];
-        NSLog(@"Router stdout: %@", stdOutString);
-        //auto logForwarder = new LogForwarder();
-        //[logForwarder appendLogViewWithLogLine:stdOutAttributedString];
-      });
-    }
-    else{free(data);}
-  });
-  dispatch_resume(source);
-  */
-  /*
-  [[NSNotificationCenter defaultCenter] addObserver:self
-      selector:@selector(routerStdoutData:)
-      name:NSFileHandleDataAvailableNotification
-      object:stdoutFileHandle];
-
-  [stdoutFileHandle waitForDataInBackgroundAndNotify];
-  */
-
   [self.routerTask setTerminationHandler:^(NSTask* task) {
     // Cleanup
@@ -113 +77 @@
 {
     @try {
-      auto swiftRouterStatus = [[RouterProcessStatus alloc] init];
-      [swiftRouterStatus triggerEventWithEn:@"router_start" details:@"normal start"];
       [self.routerTask launch];
       self.isRouterRunning = YES;

launchers/macosx/SBridge.h

@@ -19 +19 @@
 #include <vector>
 #include "include/fn.h"
-std::future<int> startupRouter(NSString* javaBin, NSArray<NSString*>* arguments, NSString* i2pBaseDir);
+//std::future<int> startupRouter(NSString* javaBin, NSArray<NSString*>* arguments, NSString* i2pBaseDir, RouterProcessStatus* routerStatus = nil);
 
 

launchers/macosx/SBridge.mm

@@ -27 +27 @@
 
 
-std::future<int> startupRouter(NSString* javaBin, NSArray<NSString*>* arguments, NSString* i2pBaseDir) {
+std::future<int> startupRouter(NSString* javaBin, NSArray<NSString*>* arguments, NSString* i2pBaseDir, RouterProcessStatus* routerStatus) {
   @try {
     RTaskOptions* options = [RTaskOptions alloc];
@@ -37 +37 @@
     [[SBridge sharedInstance] setCurrentRouterInstance:instance];
     [instance execute];
+    if (routerStatus != nil) {
+      [routerStatus setRouterStatus: true];
+      [routerStatus setRouterRanByUs: true];
+      [routerStatus triggerEventWithEn:@"router_start" details:@"normal start"];
+    }
     sendUserNotification(APP_IDSTR, @"The I2P router is starting up.");
     auto pid = [instance getPID];
     NSLog(@"Got pid: %d", pid);
     
-    auto swiftRouterStatus = [[RouterProcessStatus alloc] init];
-    [swiftRouterStatus triggerEventWithEn:@"router_pid" details:[NSString stringWithFormat:@"%d", pid]];
+    if (routerStatus != nil) [routerStatus triggerEventWithEn:@"router_pid" details:[NSString stringWithFormat:@"%d", pid]];
     
     return std::async(std::launch::async, [&pid]{
@@ -55 +59 @@
     [[SBridge sharedInstance] setCurrentRouterInstance:nil];
     
-    auto swiftRouterStatus = [[RouterProcessStatus alloc] init];
-    [swiftRouterStatus setRouterStatus: false];
-    [swiftRouterStatus setRouterRanByUs: false];
-    [swiftRouterStatus triggerEventWithEn:@"router_exception" details:errStr];
+    if (routerStatus != nil) {
+      [routerStatus setRouterStatus: false];
+      [routerStatus setRouterRanByUs: false];
+      [routerStatus triggerEventWithEn:@"router_exception" details:errStr];
+    }
     
     return std::async(std::launch::async, [&]{
@@ -101 +106 @@
   std::string basePath([i2pRootPath UTF8String]);
   
-  // Get paths
-  //NSBundle *launcherBundle = [NSBundle mainBundle];
   auto classPathStr = buildClassPathForObjC(basePath);
   
@@ -138 +141 @@
     auto nsBasePath = i2pRootPath;
     NSArray* arrArguments = [NSArray arrayWithObjects:&argList[0] count:argList.size()];
-    // We don't really know yet, but per now a workaround
-    [routerStatus setRouterStatus: true];
+    
     NSLog(@"Trying to run command: %@", javaBinPath);
     NSLog(@"With I2P Base dir: %@", i2pRootPath);
     NSLog(@"And Arguments: %@", arrArguments);
-    startupRouter(nsJavaBin, arrArguments, nsBasePath);
+    startupRouter(nsJavaBin, arrArguments, nsBasePath, routerStatus);
   } catch (std::exception &err) {
     auto errMsg = [NSString stringWithUTF8String:err.what()];

launchers/macosx/main.mm

@@ -201 +201 @@
   }
 
-  if (self.enableVerboseLogging) NSLog(@"processinfo %@", [[NSProcessInfo processInfo] arguments]);
-
-
   NSBundle *launcherBundle = [NSBundle mainBundle];
   
@@ -219 +216 @@
   jarfile += [self.metaInfo.zipFile UTF8String];
   
+  // Might be hard to read if you're not used to Objective-C
+  // But this is a "function call" that contains a "callback function"
+  [routerStatus listenForEventWithEventName:@"router_can_start" callbackActionFn:^(NSString* information) {
+    NSLog(@"Got signal, router can be started");
+    [[SBridge sharedInstance] startupI2PRouter:self.metaInfo.i2pBase javaBinPath:self.metaInfo.javaBinary];
+  }];
+  
+  // This will trigger the router start after an upgrade.
+  [routerStatus listenForEventWithEventName:@"router_must_upgrade" callbackActionFn:^(NSString* information) {
+    NSLog(@"Got signal, router must be upgraded");
+    [self extractI2PBaseDir:^(BOOL success, NSError *error) {
+      sendUserNotification(@"I2P is done extracting", @"I2P is now installed and ready to run!");
+      NSLog(@"Done extracting I2P");
+      [routerStatus triggerEventWithEn:@"router_can_start" details:@"upgrade complete"];
+    }];
+  }];
+  
   // Initialize the Swift environment (the UI components)
   [self.swiftRuntime applicationDidFinishLaunching];
@@ -227 +241 @@
     // I2P is not extracted.
     if (self.enableVerboseLogging) NSLog(@"I2P Directory don't exists!");
-
-    // Might be hard to read if you're not used to Objective-C
-    // But this is a "function call" that contains a "callback function"
-    [self extractI2PBaseDir:^(BOOL success, NSError *error) {
-      sendUserNotification(@"I2P is done extracting", @"I2P is now installed and ready to run!");
-      NSLog(@"Done extracting I2P");
-      
-      NSLog(@"Time to detect I2P version in install directory");
-      [self.swiftRuntime findInstalledI2PVersion];
-      if (shouldAutoStartRouter) {
-        [[SBridge sharedInstance] startupI2PRouter:self.metaInfo.i2pBase javaBinPath:self.metaInfo.javaBinary];
-        [routerStatus setRouterRanByUs: true];
-      }
-    }];
-
+    [routerStatus triggerEventWithEn:@"router_must_upgrade" details:@"deploy needed"];
   } else {
     // I2P was already found extracted
     NSLog(@"Time to detect I2P version in install directory");
     [self.swiftRuntime findInstalledI2PVersion];
-    
-    if (shouldAutoStartRouter) {
-      [[SBridge sharedInstance] startupI2PRouter:self.metaInfo.i2pBase javaBinPath:self.metaInfo.javaBinary];
-      [routerStatus setRouterRanByUs: true];
-    }
   }
   
 #endif
 }
-
-
 
 /**

launchers/macosx/src/main/java/net/i2p/launchers/BaseExtractor.java

@@ -14 +14 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
+import java.nio.file.*;
+import java.nio.file.attribute.BasicFileAttributes;
+
+import static java.nio.file.Files.*;
 
 /**
@@ -25 +29 @@
     public boolean printDebug = false;
 
-    public void runExtract(String zipFilename) {
-        String destinationPath = this.baseDirPath;
-        try(ZipFile file = new ZipFile(zipFilename)) {
-            FileSystem fileSystem = FileSystems.getDefault();
-            Enumeration<? extends ZipEntry> entries = file.entries();
-
-            try {
-                Files.createDirectory(fileSystem.getPath(destinationPath));
-            } catch (IOException e) {
-                // It's OK to fail here.
+    public void unzip(final Path zipFile) {
+        try {
+            String destinationPath = this.baseDirPath;
+            final Path destDir = Files.createDirectories(FileSystems.getDefault().getPath(destinationPath));
+            if (notExists(destDir)) {
+                createDirectories(destDir);
             }
 
-            while (entries.hasMoreElements()) {
-                ZipEntry entry = entries.nextElement();
-                if (printDebug) System.out.println("Found entry: "+entry.toString());
-                if (entry.isDirectory()) {
-                    if (printDebug) System.out.println("Creating Directory:" + destinationPath + "/" + entry.getName());
-                    Files.createDirectories(fileSystem.getPath(destinationPath + "/" + entry.getName()));
-                } else {
-                    InputStream is = file.getInputStream(entry);
-                    BufferedInputStream bis = new BufferedInputStream(is);
-                    String uncompressedFileName = destinationPath + "/" + entry.getName();
-                    Path uncompressedFilePath = fileSystem.getPath(uncompressedFileName);
-                    Files.createFile(uncompressedFilePath);
-                    BufferedOutputStream fileOutput = new BufferedOutputStream(new FileOutputStream(uncompressedFileName));
-                    while (bis.available() > 0) fileOutput.write(bis.read());
-                    fileOutput.close();
-                    if (printDebug) System.out.println("Written :" + entry.getName());
-                }
+            try (FileSystem zipFileSystem = FileSystems.newFileSystem(zipFile, null)) {
+                final Path root = zipFileSystem.getRootDirectories().iterator().next();
+
+                walkFileTree(root, new SimpleFileVisitor<Path>() {
+                    @Override
+                    public FileVisitResult visitFile(Path file,
+                                                     BasicFileAttributes attrs) throws IOException {
+                        final Path destFile = Paths.get(destDir.toString(), file.toString());
+                        try {
+                            copy(file, destFile, StandardCopyOption.REPLACE_EXISTING);
+                        } catch (DirectoryNotEmptyException ignore) {
+                        }
+                        return FileVisitResult.CONTINUE;
+                    }
+
+                    @Override
+                    public FileVisitResult preVisitDirectory(Path dir,
+                                                             BasicFileAttributes attrs) throws IOException {
+                        final Path dirToCreate = Paths.get(destDir.toString(), dir.toString());
+                        if (notExists(dirToCreate)) {
+                            createDirectory(dirToCreate);
+                        }
+                        return FileVisitResult.CONTINUE;
+                    }
+                });
             }
         } catch (IOException e) {
@@ -73 +81 @@
             be.printDebug = true;
         }
-        be.runExtract(System.getProperty("i2p.base.zip"));
+        be.unzip( FileSystems.getDefault().getPath(System.getProperty("i2p.base.zip")) );
     }
 }