Merge pull request #511 from BranchMetrics/Safari-Key-Window-AIS-122

Creating a SFSafariViewController and adding a temporary key window was interfering with partners applications:

Losing the keyWindow focus stalled UI initialization.
Controls would lose firstResponder status.
The Facebook login controller wouldn't appear correctly.
This patch fixes those problems.

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCStrongMatchHelper.h

@@ -6,14 +6,17 @@
 //  Copyright © 2015 Branch Metrics. All rights reserved.
 //
 
+
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
 
+
 @interface BNCStrongMatchHelper : NSObject
 
 + (BNCStrongMatchHelper *)strongMatchHelper;
 - (void)createStrongMatchWithBranchKey:(NSString *)branchKey;
 - (BOOL)shouldDelayInstallRequest;
-+ (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey redirectUrl:(NSString *)redirectUrl;
++ (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey
+                                         redirectUrl:(NSString *)redirectUrl;
 
 @end

Branch-SDK/Branch-SDK/BNCStrongMatchHelper.m

@@ -6,36 +6,95 @@
 //  Copyright © 2015 Branch Metrics. All rights reserved.
 //
 
+
 #import "BNCStrongMatchHelper.h"
+#import <objc/runtime.h>
 #import "BNCConfig.h"
 #import "BNCPreferenceHelper.h"
 #import "BNCSystemObserver.h"
 #import "BranchConstants.h"
 
+
+#pragma mark BNCStrongMatchHelper iOS 8.0
+
+
 // Stub the class for older Xcode versions, methods don't actually do anything.
 #if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && __IPHONE_OS_VERSION_MAX_ALLOWED < 90000
 
 @implementation BNCStrongMatchHelper
 
-+ (BNCStrongMatchHelper *)strongMatchHelper { return nil; }
-- (void)createStrongMatchWithBranchKey:(NSString *)branchKey { }
-- (BOOL)shouldDelayInstallRequest { return NO; }
-+ (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey redirectUrl:(NSString *)redirectUrl { return nil; }
++ (BNCStrongMatchHelper *)strongMatchHelper {
+    return nil;
+}
+
+- (void)createStrongMatchWithBranchKey:(NSString *)branchKey {
+}
+
+- (BOOL)shouldDelayInstallRequest {
+    return NO;
+}
+
++ (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey
+                                         redirectUrl:(NSString *)redirectUrl {
+    return nil;
+}
 
 @end
 
-#else
 
-NSInteger const ABOUT_30_DAYS_TIME_IN_SECONDS = 60 * 60 * 24 * 30;
+#else   // ------------------------------------------------------------------------------ iOS >= 9.0
+
+
+#pragma mark - BNCMatchViewController
+
+
+#import <SafariServices/SafariServices.h>
+
+
+// This is a class interface that will be dynamically subclassed to the SFSafariViewController
+@interface BNCMatchViewController : UIViewController
+@end
+
+
+@implementation BNCMatchViewController
+
+- (instancetype) initWithURL:(NSURL*)URL {
+    self = [super init];
+    return self;
+}
+
+- (BOOL) canBecomeFirstResponder {
+    //NSLog(@"Can be!!! Responder.");
+    return NO;
+}
+
+- (BOOL) becomeFirstResponder {
+    //NSLog(@"First!! Responder.");
+    return NO;
+}
+
+- (UIResponder*) nextResponder {
+    //NSLog(@"Next!! Responder.");
+    return nil;
+}
+
+- (void) setDelegate:(id)delegate {
+}
+
+@end
+
+
+#pragma mark - BNCStrongMatchHelper iOS 9.0
 
-@interface BNCStrongMatchHelper ()
 
-@property (strong, nonatomic) UIWindow *secondWindow;
+@interface BNCStrongMatchHelper ()
 @property (assign, nonatomic) BOOL requestInProgress;
 @property (assign, nonatomic) BOOL shouldDelayInstallRequest;
-
+@property (strong, nonatomic) UIWindow *primaryWindow;
+@property (strong, nonatomic) BNCMatchViewController *matchViewController;
 @end
 
+
 @implementation BNCStrongMatchHelper
 
 + (BNCStrongMatchHelper *)strongMatchHelper {
@@ -49,7 +108,8 @@ + (BNCStrongMatchHelper *)strongMatchHelper {
     return strongMatchHelper;
 }
 
-+ (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey redirectUrl:(NSString *)redirectUrl {
++ (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey
+                                         redirectUrl:(NSString *)redirectUrl {
     if (!branchKey) {
         return nil;
     }
@@ -95,69 +155,123 @@ + (NSURL *)getUrlForCookieBasedMatchingWithBranchKey:(NSString *)branchKey redir
 }
 
 - (void)createStrongMatchWithBranchKey:(NSString *)branchKey {
-    if (self.requestInProgress) {
-        return;
-    }
+    @synchronized (self) {
+        if (self.requestInProgress) return;
 
-    self.requestInProgress = YES;
-    
-    NSDate *thirtyDaysAgo = [NSDate dateWithTimeIntervalSinceNow:-ABOUT_30_DAYS_TIME_IN_SECONDS];
-    NSDate *lastCheck = [BNCPreferenceHelper preferenceHelper].lastStrongMatchDate;
-    if ([lastCheck compare:thirtyDaysAgo] == NSOrderedDescending) {
-        self.requestInProgress = NO;
-        return;
-    }
-    
-    self.shouldDelayInstallRequest = YES;
-    [self presentSafariVCWithBranchKey:branchKey];
-}
+        NSInteger const ABOUT_30_DAYS_TIME_IN_SECONDS = 60 * 60 * 24 * 30;
+        NSDate *thirtyDaysAgo = [NSDate dateWithTimeIntervalSinceNow:-ABOUT_30_DAYS_TIME_IN_SECONDS];
+        NSDate *lastCheck = [BNCPreferenceHelper preferenceHelper].lastStrongMatchDate;
+        if ([lastCheck compare:thirtyDaysAgo] == NSOrderedDescending) return;
+
+        NSURL *strongMatchUrl =
+            [BNCStrongMatchHelper
+                getUrlForCookieBasedMatchingWithBranchKey:branchKey
+                redirectUrl:nil];
+        if (!strongMatchUrl) return;
+
+        self.requestInProgress = YES;
+        self.shouldDelayInstallRequest = YES;
 
-- (void)presentSafariVCWithBranchKey:(NSString *)branchKey {
-    NSURL *strongMatchUrl = [BNCStrongMatchHelper getUrlForCookieBasedMatchingWithBranchKey:branchKey redirectUrl:nil];
-    if (!strongMatchUrl) {
-        self.shouldDelayInstallRequest = NO;
-        self.requestInProgress = NO;
-        return;
-    }
-    
-    Class SFSafariViewControllerClass = NSClassFromString(@"SFSafariViewController");
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
-    if (SFSafariViewControllerClass) {
-        
         // Must be on next run loop to avoid a warning
         dispatch_async(dispatch_get_main_queue(), ^{
-            UIViewController * safController = [[SFSafariViewControllerClass alloc] initWithURL:strongMatchUrl];
-            self.secondWindow = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
-            self.secondWindow.rootViewController = safController;
-            self.secondWindow.windowLevel = UIWindowLevelNormal - 100;
-            [self.secondWindow setHidden:NO];
-            UIWindow *keyWindow = [[UIApplicationClass sharedApplication] keyWindow];
-            [self.secondWindow makeKeyWindow];
-            
-            // Give enough time for Safari to load the request (optimized for 3G)
-            dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(3 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
-                [keyWindow makeKeyWindow];
-                
-                // Remove the window and release it's strong reference. This is important to ensure that
-                // applications using view controller based status bar appearance are restored.
-                [self.secondWindow removeFromSuperview];
-                self.secondWindow = nil;
-                
-                [BNCPreferenceHelper preferenceHelper].lastStrongMatchDate = [NSDate date];
+
+            if (![self willLoadViewControllerWithURL:strongMatchUrl]) {
+                self.shouldDelayInstallRequest = NO;
                 self.requestInProgress = NO;
-            });
+                return;
+            }
+
+            // Give enough time for Safari to load the request (optimized for 3G)
+            dispatch_after(
+                dispatch_time(DISPATCH_TIME_NOW, (int64_t)(3 * NSEC_PER_SEC)),
+                dispatch_get_main_queue(),
+                ^{ [self unloadViewController]; }
+            );
         });
     }
-    else {
-        self.requestInProgress = NO;
+}
+
+- (BOOL) subclass:(Class)subclass selector:(SEL)selector {
+    Class templateClass = objc_getClass("BNCMatchViewController");
+    if (!templateClass) return NO;
+
+    Method method = class_getInstanceMethod(templateClass, selector);
+    if (!method) return NO;
+
+    const char * typeEncoding = method_getTypeEncoding(method);
+    if (!typeEncoding) return NO;
+
+    IMP implementation = class_getMethodImplementation(templateClass, selector);
+    if (!implementation) return NO;
+
+    class_addMethod(subclass, selector, implementation, typeEncoding);
+    return YES;
+}
+
+- (BOOL) willLoadViewControllerWithURL:(NSURL*)matchURL {
+    if (self.primaryWindow) return NO;
+
+    //  Dynamically subclass the SFSafariViewController if available.
+    //  This allows us to compile and link to an app that doesn't
+    //  include SafariServices, but is also able to compile and link
+    //  when it is.
+
+    Class SFSafariViewControllerClass = NSClassFromString(@"SFSafariViewController");
+    if (!SFSafariViewControllerClass) return NO;
+
+    Class BNCMatchViewControllerSubclass = NSClassFromString(@"BNCMatchViewController_Safari");
+    if (!BNCMatchViewControllerSubclass) {
+        //  The class isn't registered.  Create it:
+
+        BNCMatchViewControllerSubclass =
+            objc_allocateClassPair(SFSafariViewControllerClass, "BNCMatchViewController_Safari", 0);
+        if (!BNCMatchViewControllerSubclass) return NO;
+
+        BOOL fail = NO;
+        fail |= ![self subclass:BNCMatchViewControllerSubclass selector:@selector(becomeFirstResponder)];
+        fail |= ![self subclass:BNCMatchViewControllerSubclass selector:@selector(canBecomeFirstResponder)];
+        fail |= ![self subclass:BNCMatchViewControllerSubclass selector:@selector(nextResponder)];
+        if (fail) {
+            objc_disposeClassPair(BNCMatchViewControllerSubclass);
+            return NO;
+        }
+        objc_registerClassPair(BNCMatchViewControllerSubclass);
     }
+
+    self.matchViewController = [[BNCMatchViewControllerSubclass alloc] initWithURL:matchURL];
+    if (!self.matchViewController) return NO;
+    
+    self.primaryWindow = [[UIApplication sharedApplication] keyWindow];
+    self.matchViewController.delegate = self;
+    self.matchViewController.view.frame = self.primaryWindow.bounds;
+
+    [self.primaryWindow.rootViewController addChildViewController:self.matchViewController];
+    [self.primaryWindow insertSubview:self.matchViewController.view atIndex:0];
+    [self.matchViewController didMoveToParentViewController:self.primaryWindow.rootViewController];
+
+    return YES;
 }
 
-- (BOOL)shouldDelayInstallRequest {
-    return _shouldDelayInstallRequest;
+- (void) unloadViewController {
+    //NSLog(@"unloadViewController");
+    [self.matchViewController willMoveToParentViewController:nil];
+    [self.matchViewController.view removeFromSuperview];
+    [self.matchViewController removeFromParentViewController];
+     self.matchViewController.delegate = nil;
+     self.matchViewController = nil;
+     self.primaryWindow = nil;
+
+    [BNCPreferenceHelper preferenceHelper].lastStrongMatchDate = [NSDate date];
+    self.shouldDelayInstallRequest = NO;
+    self.requestInProgress = NO;
 }
 
+- (void)safariViewController:(SFSafariViewController *)controller
+      didCompleteInitialLoad:(BOOL)didLoadSuccessfully {
+    NSLog(@"Safari Did load. Success: %d.", didLoadSuccessfully);
+    [self unloadViewController];
+}
 
 @end
 
-#endif
+#endif  // ------------------------------------------------------------------------------ iOS >= 9.0