Added [UIViewController bnc_currentViewController] category. (#755)

* Simplifies code in a number of cases.
* Added the category.
* Updated all uses of similar existing code.
* Updated search window order.
* Update case for split view controllers.

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCSpotlightService.m

@@ -318,7 +318,7 @@ - (dispatch_queue_t) workQueue {
 - (void)indexUsingNSUserActivity:(NSDictionary *)params {
     self.userInfo = params[@"userInfo"];
     self.userInfo[CSSearchableItemActivityIdentifier] = params[@"spotlightId"];
-    UIViewController *activeViewController = [self getActiveViewController];
+    UIViewController *activeViewController = [UIViewController bnc_currentViewController];
     if (!activeViewController) {
         // if no view controller, don't index. Current use case: iMessage extensions
         return;
@@ -404,37 +404,7 @@ - (void)indexUsingSearchableItem:(NSDictionary*)indexingParam
     #undef IndexingNotAvalable
 }
 
-#pragma mark Helper Methods
-
-- (UIViewController *)getActiveViewController {
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
-    UIViewController *rootViewController = [UIApplicationClass sharedApplication].keyWindow.rootViewController;
-    UIViewController *activeController;
-    if ([rootViewController isKindOfClass:[UINavigationController class]]) {
-        activeController = ((UINavigationController *)rootViewController).topViewController;
-    } else if ([rootViewController isKindOfClass:[UITabBarController class]]) {
-        activeController = ((UITabBarController *)rootViewController).selectedViewController;
-    } else {
-        activeController = rootViewController;
-    }
-    return activeController;
-}
-
-- (UIViewController *)currentViewController {
-    // TODO: Create a general 'currentViewController' utility function.
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
-    if (!UIApplicationClass) return nil;
-
-    UIViewController *current =
-        [UIApplicationClass sharedApplication].keyWindow.rootViewController;
-    while (current.presentedViewController &&
-        ![current.presentedViewController isKindOfClass:UIAlertController.class]) {
-        current = current.presentedViewController;
-    }
-    return current;
-}
-
-#pragma mark userActivity Delegate Methods
+#pragma mark - UserActivity Delegate Methods
 
 - (void)userActivityWillSave:(NSUserActivity *)userActivity {
     [userActivity addUserInfoEntriesFromDictionary:self.userInfo];

Branch-SDK/Branch-SDK/BNCStrongMatchHelper.m

@@ -13,6 +13,7 @@
 #import "BNCSystemObserver.h"
 #import "BranchConstants.h"
 #import "BNCLog.h"
+#import "UIViewController+Branch.h"
 #import <objc/runtime.h>
 
 
@@ -259,37 +260,6 @@ - (BOOL) subclass:(Class)subclass selector:(SEL)selector {
     return YES;
 }
 
-- (UIWindow*) keyWindow {
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
-    UIWindow *keyWindow = [UIApplicationClass sharedApplication].keyWindow;
-    if (keyWindow) return keyWindow;
-	// ToDo: Put different code for extensions here.
-    return nil;
-}
-
-/**
-  Find the top view controller that is not of type UINavigationController, UITabBarController, UISplitViewController
- */
-- (UIViewController *)topViewController:(UIViewController *)baseViewController {
-    if ([baseViewController isKindOfClass:[UINavigationController class]]) {
-        return [self topViewController: ((UINavigationController *)baseViewController).visibleViewController];
-    }
-
-    if ([baseViewController isKindOfClass:[UITabBarController class]]) {
-        return [self topViewController: ((UITabBarController *)baseViewController).selectedViewController];
-    }
-
-    if ([baseViewController isKindOfClass:[UISplitViewController class]]) {
-        return [self topViewController: ((UISplitViewController *)baseViewController).viewControllers.firstObject];
-    }
-
-    if ([baseViewController presentedViewController] != nil) {
-        return [self topViewController: [baseViewController presentedViewController]];
-    }
-
-    return baseViewController;
-}
-
 - (BOOL) willLoadViewControllerWithURL:(NSURL*)matchURL {
     if (self.primaryWindow) return NO;
 
@@ -324,7 +294,7 @@ - (BOOL) willLoadViewControllerWithURL:(NSURL*)matchURL {
     }
 
     BNCLogDebugSDK(@"Safari is initializing.");
-    self.primaryWindow = [self keyWindow];
+    self.primaryWindow = [UIViewController bnc_currentWindow];
 
     self.matchViewController = [[BNCMatchViewControllerSubclass alloc] initWithURL:matchURL];
     if (!self.matchViewController) return NO;
@@ -336,7 +306,7 @@ - (BOOL) willLoadViewControllerWithURL:(NSURL*)matchURL {
     self.matchView.alpha = 1.0;
     [self.matchView addSubview:self.matchViewController.view];
 
-    UIViewController *rootViewController = [self topViewController:self.primaryWindow.rootViewController];
+    UIViewController *rootViewController = [self.primaryWindow.rootViewController bnc_currentViewController];
 
     [rootViewController addChildViewController:self.matchViewController];
     UIView *parentView = rootViewController.view ?: self.primaryWindow;

Branch-SDK/Branch-SDK/Branch.h

@@ -35,6 +35,7 @@
 #import "BranchUniversalObject.h"
 #import "BranchView.h"
 #import "BranchViewHandler.h"
+#import "UIViewController+Branch.h"
 
 /**
  `Branch` is the primary interface of the Branch iOS SDK. Currently, all interactions you will make are funneled through this class. It is not meant to be instantiated or subclassed, usage should be limited to the global instance.

Branch-SDK/Branch-SDK/Branch.m

@@ -83,6 +83,7 @@ void ForceCategoriesToLoad(void) {
     BNCForceNSErrorCategoryToLoad();
     BNCForceNSStringCategoryToLoad();
     BNCForceNSMutableDictionaryCategoryToLoad();
+    BNCForceUIViewControllerCategoryToLoad();
 }
 
 #pragma mark - BranchLink
@@ -1778,10 +1779,8 @@ - (BNCLinkData *)prepareLinkDataFor:(NSArray *)tags
     return post;
 }
 
-
 #pragma mark - BranchUniversalObject methods
 
-
 - (void)registerViewWithParams:(NSDictionary *)params andCallback:(callbackWithParams)callback {
     [self initSessionIfNeededAndNotInProgress];
     BranchUniversalObject *buo = [[BranchUniversalObject alloc] init];
@@ -1790,7 +1789,6 @@ - (void)registerViewWithParams:(NSDictionary *)params andCallback:(callbackWithP
     if (callback) callback(@{}, nil);
 }
 
-
 #pragma mark - Application State Change methods
 
 - (void)applicationDidBecomeActive {
@@ -1826,7 +1824,6 @@ - (void)callClose {
     }
 }
 
-
 #pragma mark - Queue management
 
 - (NSInteger) networkCount {
@@ -2086,7 +2083,6 @@ - (void)handleInitSuccess {
     }
     [self sendOpenNotificationWithLinkParameters:latestReferringParams error:nil];
 
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
     if (self.shouldAutomaticallyDeepLink) {
         // Find any matched keys, then launch any controllers that match
         // TODO which one to launch if more than one match?
@@ -2105,8 +2101,8 @@ - (void)handleInitSuccess {
                 BNCLogWarning(@"The automatic deeplink view controller '%@' for key '%@' does not implement 'configureControlWithData:'.",
                     branchSharingController, key);
             }
-            self.deepLinkPresentingController = [[[UIApplicationClass sharedApplication].delegate window] rootViewController];
-
+            
+            self.deepLinkPresentingController = [UIViewController bnc_currentViewController];
             if([self.deepLinkControllers[key] isKindOfClass:[BNCDeepLinkViewControllerInstance class]]) {
                 BNCDeepLinkViewControllerInstance* deepLinkInstance = self.deepLinkControllers[key];
                 UIViewController <BranchDeepLinkingController> *branchSharingController = deepLinkInstance.viewController;

Branch-SDK/Branch-SDK/BranchContentDiscoverer.m

@@ -6,7 +6,6 @@
 //  Copyright © 2016 Branch Metrics. All rights reserved.
 //
 
-
 #import <CommonCrypto/CommonDigest.h>
 #import "BranchContentDiscoverer.h"
 #import "BranchContentDiscoveryManifest.h"
@@ -15,7 +14,7 @@
 #import "BranchConstants.h"
 #import "BNCEncodingUtils.h"
 #import "BNCLog.h"
-
+#import "UIViewController+Branch.h"
 
 @interface BranchContentDiscoverer ()
 @property (nonatomic, strong) NSString *lastViewControllerName;
@@ -73,7 +72,7 @@ - (void)stopDiscoveryTask {
 
 - (void)readContentDataIfNeeded {
     if (_numOfViewsDiscovered < self.contentManifest.maxViewHistoryLength) {
-        UIViewController *presentingViewController = [self getActiveViewController];
+        UIViewController *presentingViewController = [UIViewController bnc_currentViewController];
         if (presentingViewController) {
             NSString *presentingViewControllerName = NSStringFromClass([presentingViewController class]);
             if (_lastViewControllerName == nil || ![_lastViewControllerName isEqualToString:presentingViewControllerName]) {
@@ -247,25 +246,6 @@ - (NSString *)getViewText:(NSString *)viewId
     return viewTxt;
 }
 
-- (UIViewController *)getActiveViewController {
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
-    UIViewController *rootViewController = [UIApplicationClass sharedApplication].keyWindow.rootViewController;
-    return [self getActiveViewController:rootViewController];
-    
-}
-
-- (UIViewController *)getActiveViewController:(UIViewController *)rootViewController {
-    UIViewController *activeController;
-    if ([rootViewController isKindOfClass:[UINavigationController class]]) {
-        activeController = ((UINavigationController *)rootViewController).topViewController;
-    } else if ([rootViewController isKindOfClass:[UITabBarController class]]) {
-        activeController = ((UITabBarController *)rootViewController).selectedViewController;
-    } else {
-        activeController = rootViewController;
-    }
-    return activeController;
-}
-
 - (void)addFormattedContentData:(NSMutableArray *)contentDataArray
                        withText:(NSString *)contentData
                       clearText:(BOOL)isClearText {

Branch-SDK/Branch-SDK/BranchShareLink.m

@@ -193,9 +193,7 @@ - (void) presentActivityViewControllerFromViewController:(UIViewController*_Null
     if ([viewController respondsToSelector:@selector(presentViewController:animated:completion:)]) {
         presentingViewController = viewController;
     } else {
-        Class UIApplicationClass = NSClassFromString(@"UIApplication");
-        UIViewController *rootController =
-            [UIApplicationClass sharedApplication].delegate.window.rootViewController;
+        UIViewController *rootController = [UIViewController bnc_currentViewController];
         if ([rootController respondsToSelector:@selector(presentViewController:animated:completion:)]) {
             presentingViewController = rootController;
         }

Branch-SDK/Branch-SDK/BranchUniversalObject.m

@@ -493,15 +493,14 @@ - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties
         #pragma clang diagnostic pop
     }
 
-    UIViewController *presentingViewController;
+    UIViewController *presentingViewController = nil;
     if (viewController && [viewController respondsToSelector:@selector(presentViewController:animated:completion:)]) {
         presentingViewController = viewController;
     }
     else {
-        Class UIApplicationClass = NSClassFromString(@"UIApplication");
-        if ([[[[UIApplicationClass sharedApplication].delegate window] rootViewController]
-               respondsToSelector:@selector(presentViewController:animated:completion:)]) {
-            presentingViewController = [[[UIApplicationClass sharedApplication].delegate window] rootViewController];
+        UIViewController *rootViewController = [UIViewController bnc_currentViewController];
+        if ([rootViewController respondsToSelector:@selector(presentViewController:animated:completion:)]) {
+            presentingViewController = rootViewController;
         }
     }
 

Branch-SDK/Branch-SDK/BranchViewHandler.m

@@ -85,8 +85,7 @@ - (void)showView:(BranchView *)branchView {
 }
 
 - (void)closeBranchView {
-    Class UIApplicationClass = NSClassFromString(@"UIApplication");
-    UIViewController *presentingViewController = [[[[UIApplicationClass sharedApplication] windows] firstObject] rootViewController];
+    UIViewController *presentingViewController = [UIViewController bnc_currentViewController];
     [presentingViewController dismissViewControllerAnimated:YES completion:nil];
 
     if (self.branchViewCallback) {
@@ -114,8 +113,8 @@ - (void)webViewDidFinishLoad:(UIWebView *)webView {
         if (self.pendingBranchView != nil && self.pendingWebview != nil) {
             UIViewController *holderView = [[UIViewController alloc] init];
             [holderView.view insertSubview:self.pendingWebview atIndex:0];
-            Class UIApplicationClass = NSClassFromString(@"UIApplication");
-            UIViewController *presentingViewController = [[[[UIApplicationClass sharedApplication] windows] firstObject] rootViewController];
+
+            UIViewController *presentingViewController = [UIViewController bnc_currentViewController];
             [presentingViewController presentViewController:holderView animated:YES completion:nil];
 
             [self.pendingBranchView updateUsageCount];

Branch-SDK/Branch-SDK/UIViewController+Branch.h

@@ -0,0 +1,21 @@
+//
+//  UIViewController+Branch.h
+//  Branch-SDK
+//
+//  Created by Edward Smith on 11/16/17.
+//  Copyright © 2017 Branch. All rights reserved.
+//
+
+#if __has_feature(modules)
+@import UIKit;
+#else
+#import <UIKit/UIKit.h>
+#endif
+
+@interface UIViewController (Branch)
++ (UIWindow*_Nullable) bnc_currentWindow;
++ (UIViewController*_Nullable) bnc_currentViewController;
+- (UIViewController*_Nonnull)  bnc_currentViewController;
+@end
+
+void BNCForceUIViewControllerCategoryToLoad(void) __attribute__((constructor));

Branch-SDK/Branch-SDK/UIViewController+Branch.m

@@ -0,0 +1,67 @@
+//
+//  UIViewController+Branch.m
+//  Branch-SDK
+//
+//  Created by Edward Smith on 11/16/17.
+//  Copyright © 2017 Branch. All rights reserved.
+//
+
+#import "UIViewController+Branch.h"
+
+@implementation UIViewController (Branch)
+
++ (UIWindow*_Nullable) bnc_currentWindow {
+    Class UIApplicationClass = NSClassFromString(@"UIApplication");
+    if (UIApplicationClass) {
+        UIWindow *keyWindow = nil;
+
+        keyWindow = [UIApplicationClass sharedApplication].delegate.window;
+        if (keyWindow && !keyWindow.isHidden && keyWindow.rootViewController) return keyWindow;
+
+        keyWindow = [UIApplicationClass sharedApplication].keyWindow;
+        if (keyWindow && !keyWindow.isHidden && keyWindow.rootViewController) return keyWindow;
+
+        for (keyWindow in [UIApplicationClass sharedApplication].windows.reverseObjectEnumerator) {
+            if (!keyWindow.isHidden && keyWindow.rootViewController) return keyWindow;
+        }
+    }
+
+    // ToDo: Put different code for extensions here.
+
+    return nil;
+}
+
++ (UIViewController*_Nullable) bnc_currentViewController {
+    UIWindow *window = [UIViewController bnc_currentWindow];
+    return [window.rootViewController bnc_currentViewController];
+}
+
+- (UIViewController*_Nonnull) bnc_currentViewController {
+    if ([self isKindOfClass:[UINavigationController class]]) {
+        return [((UINavigationController *)self).visibleViewController bnc_currentViewController];
+    }
+
+    if ([self isKindOfClass:[UITabBarController class]]) {
+        return [((UITabBarController *)self).selectedViewController bnc_currentViewController];
+    }
+
+    if ([self isKindOfClass:[UISplitViewController class]]) {
+        return [((UISplitViewController *)self).viewControllers.lastObject bnc_currentViewController];
+    }
+
+    if ([self isKindOfClass:[UIPageViewController class]]) {
+        return [((UIPageViewController*)self).viewControllers.lastObject bnc_currentViewController];
+    }
+
+    if (self.presentedViewController != nil && !self.presentedViewController.isBeingDismissed) {
+        return [self.presentedViewController bnc_currentViewController];
+    }
+
+    return self;
+}
+
+@end
+
+__attribute__((constructor)) void BNCForceUIViewControllerCategoryToLoad() {
+    //  Nothing here, but forces linker to load the category.
+}