Merge pull request #396 from BranchMetrics/white-listed-schemes

White listed schemes

Author: ahmednawar

Branch-SDK/Branch-SDK/Branch.h

@@ -357,6 +357,19 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 -(void)setDeepLinkDebugMode:(NSDictionary *)debugParams;
 
+/**
+ Add a scheme to a whitelist of URI schemes that will be tracked by Branch. Default to all schemes.
+ 
+ @param the scheme to add to the whitelist, i.e. @"http", @"https" or @"myapp"
+ */
+-(void)addWhiteListedScheme:(NSString *)scheme;
+
+/**
+ Add an array of schemes to a whitelist of URI schemes that will be tracked by Branch. Default to all schemes.
+ 
+ @param the array of schemes to add to the whitelist, i.e. @[@"http", @"https", @"myapp"]
+ */
+-(void)setWhiteListedSchemes:(NSArray *)schemes;
 
 /**
  Register your Facebook SDK's FBSDKAppLinkUtility class to be used by Branch for deferred deep linking from their platform

Branch-SDK/Branch-SDK/Branch.m

@@ -80,6 +80,7 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate, FABKit>
 @property (strong, nonatomic) NSDictionary *deepLinkDebugParams;
 @property (assign, nonatomic) BOOL accountForFacebookSDK;
 @property (assign, nonatomic) id FBSDKAppLinkUtility;
+@property (strong, nonatomic) NSMutableArray *whiteListedSchemeList;
 
 @end
 
@@ -147,6 +148,7 @@ - (id)initWithInterface:(BNCServerInterface *)interface queue:(BNCServerRequestQ
         _processing_sema = dispatch_semaphore_create(1);
         _networkCount = 0;
         _deepLinkControllers = [[NSMutableDictionary alloc] init];
+        _whiteListedSchemeList = [[NSMutableArray alloc] init];
         _useCookieBasedMatching = YES;
 
         NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];
@@ -320,12 +322,29 @@ - (void) setDeepLinkDebugMode:(NSDictionary *)debugParams {
     self.deepLinkDebugParams = debugParams;
 }
 
+-(void)setWhiteListedSchemes:(NSArray *)schemes {
+    self.whiteListedSchemeList = [schemes mutableCopy];
+}
+
+-(void)addWhiteListedScheme:(NSString *)scheme {
+    [self.whiteListedSchemeList addObject:scheme];
+}
 
 - (BOOL)handleDeepLink:(NSURL *)url {
     BOOL handled = NO;
     if (url && ![url isEqual:[NSNull null]]) {
-        //always save the incoming url in the preferenceHelper in the externalIntentURI field
-        self.preferenceHelper.externalIntentURI = [url absoluteString];
+        
+        // save the incoming url in the preferenceHelper in the externalIntentURI field
+        if ([self.whiteListedSchemeList count]) {
+            for (NSString *scheme in self.whiteListedSchemeList) {
+                if ([scheme isEqualToString:[url scheme]]) {
+                    self.preferenceHelper.externalIntentURI = [url absoluteString];
+                    break;
+                }
+            }
+        } else {
+            self.preferenceHelper.externalIntentURI = [url absoluteString];
+        }
 
         NSString *query = [url fragment];
         if (!query) {

Branch-TestBed/Branch-TestBed/AppDelegate.m

@@ -21,6 +21,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 
     Branch *branch = [Branch getInstance];
     [branch setDebug];
+    [branch setWhiteListedSchemes:@[@"branchtest"]];
 
     // Automatic Deeplinking on "deeplink_text"
     NavigationController *navigationController = [[UIStoryboard storyboardWithName:@"Main" bundle:[NSBundle mainBundle]] instantiateInitialViewController];