CORE-2088 backport the pasteboard feature

echo-branch · echo-branch · commit 3d7aa5fc5e10 · 2021-07-06T14:22:59.000-07:00
diff --git a/Branch-SDK/BNCPasteboard.h b/Branch-SDK/BNCPasteboard.h
@@ -0,0 +1,24 @@
+//
+//  BNCPasteboard.h
+//  Branch
+//
+//  Created by Ernest Cho on 6/24/21.
+//  Copyright © 2021 Branch, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface BNCPasteboard : NSObject
+
+// For v1, we only allow check on install requests
+@property (nonatomic,assign) BOOL checkOnInstall;
+
+- (nullable NSURL *)checkForBranchLink;
+
++ (BNCPasteboard *)sharedInstance;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/Branch-SDK/BNCPasteboard.m b/Branch-SDK/BNCPasteboard.m
@@ -0,0 +1,51 @@
+//
+//  BNCPasteboard.m
+//  Branch
+//
+//  Created by Ernest Cho on 6/24/21.
+//  Copyright © 2021 Branch, Inc. All rights reserved.
+//
+
+#import "BNCPasteboard.h"
+#import <UIKit/UIKit.h>
+
+@implementation BNCPasteboard
+
++ (BNCPasteboard *)sharedInstance {
+    static BNCPasteboard *pasteboard;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        pasteboard = [BNCPasteboard new];
+    });
+    return pasteboard;
+}
+
+- (instancetype)init {
+    self = [super init];
+    if (self) {
+        self.checkOnInstall = NO;
+    }
+    return self;
+}
+
+- (nullable NSURL *)checkForBranchLink {
+    // consider limiting this check to iOS 15+
+    if (@available(iOS 10.0, *)) {
+        if ([UIPasteboard.generalPasteboard hasURLs]) {
+            
+            // triggers the end user toast message
+            NSURL *tmp = UIPasteboard.generalPasteboard.URL;
+            if ([self isProbableBranchLink:tmp]) {
+                return tmp;
+            }
+        }
+    }
+    return nil;
+}
+
+- (BOOL)isProbableBranchLink:(NSURL *)url {
+    // TODO: check against info.plist
+    return YES;
+}
+
+@end
diff --git a/Branch-SDK/Branch.h b/Branch-SDK/Branch.h
@@ -676,6 +676,14 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)ignoreAppleSearchAdsTestData;
 
+/**
+ Checks the pasteboard for a Branch Link.
+ This copied Branch Link in the install request and can provide deeplink data.
+ 
+ Note, this will display a toast message to the end user.
+ */
+- (void)checkPasteboardForBranchLinkOnInstall;
+
 /**
  Set the AppGroup used to share data between the App Clip and the Full App.
  
diff --git a/Branch-SDK/Branch.m b/Branch-SDK/Branch.m
@@ -45,6 +45,7 @@
 #import "BNCAppGroupsData.h"
 #import "BNCPartnerParameters.h"
 #import "BranchEvent.h"
+#import "BNCPasteboard.h"
 
 #if !TARGET_OS_TV
 #import "BNCUserAgentCollector.h"
@@ -800,26 +801,7 @@ - (BOOL)handleUniversalDeepLink_private:(NSString*)urlString sceneIdentifier:(NS
 
     [self initUserSessionAndCallCallback:YES sceneIdentifier:sceneIdentifier];
 
-    id branchUniversalLinkDomains = [self.preferenceHelper getBranchUniversalLinkDomains];
-    if ([branchUniversalLinkDomains isKindOfClass:[NSString class]] && [urlString bnc_containsString:branchUniversalLinkDomains]) {
-        return YES;
-    } else if ([branchUniversalLinkDomains isKindOfClass:[NSArray class]]) {
-        for (id oneDomain in branchUniversalLinkDomains) {
-            if ([oneDomain isKindOfClass:[NSString class]] && [urlString bnc_containsString:oneDomain]) {
-                return YES;
-            }
-        }
-    }
-
-    NSString *userActivityURL = urlString;
-    NSArray *branchDomains = [NSArray arrayWithObjects:@"bnc.lt", @"app.link", @"test-app.link", nil];
-    for (NSString* domain in branchDomains) {
-        if ([userActivityURL bnc_containsString:domain]) {
-            return YES;
-        }
-    }
-
-    return NO;
+    return [self isBranchLink:urlString];
 }
 
 - (BOOL)continueUserActivity:(NSUserActivity *)userActivity {
@@ -860,25 +842,27 @@ - (BOOL)continueUserActivity:(NSUserActivity *)userActivity sceneIdentifier:(NSS
     return spotlightIdentifier != nil;
 }
 
-- (BOOL)isBranchLink:(NSString*)urlString {
-    id branchUniversalLinkDomains = [self.preferenceHelper getBranchUniversalLinkDomains];
-    if ([branchUniversalLinkDomains isKindOfClass:[NSString class]] &&
-        [urlString containsString:branchUniversalLinkDomains]) {
+- (BOOL)isBranchLink:(NSString *)urlString {
+    id branchUniversalLinkDomains = [[[NSBundle mainBundle] infoDictionary] objectForKey:@"branch_universal_link_domains"];
+    
+    // check list in bundle
+    if ([branchUniversalLinkDomains isKindOfClass:[NSString class]] && [urlString containsString:branchUniversalLinkDomains]) {
         return YES;
-    }
-    else if ([branchUniversalLinkDomains isKindOfClass:[NSArray class]]) {
+    } else if ([branchUniversalLinkDomains isKindOfClass:[NSArray class]]) {
         for (id oneDomain in branchUniversalLinkDomains) {
             if ([oneDomain isKindOfClass:[NSString class]] && [urlString containsString:oneDomain]) {
                 return YES;
             }
         }
     }
 
+    // check default urls
     NSString *userActivityURL = urlString;
     NSArray *branchDomains = [NSArray arrayWithObjects:@"bnc.lt", @"app.link", @"test-app.link", nil];
     for (NSString* domain in branchDomains) {
-        if ([userActivityURL containsString:domain])
+        if ([userActivityURL containsString:domain]) {
             return YES;
+        }
     }
     return NO;
 }
@@ -950,6 +934,10 @@ - (void)ignoreAppleSearchAdsTestData {
     #endif
 }
 
+- (void)checkPasteboardForBranchLinkOnInstall {
+    [BNCPasteboard sharedInstance].checkOnInstall = YES;
+}
+
 - (void)checkAppleSearchAdsAttribution {
     #if !TARGET_OS_TV
     if (![BNCAppleSearchAds sharedInstance].enableAppleSearchAdsCheck) {
diff --git a/Branch-SDK/BranchConstants.h b/Branch-SDK/BranchConstants.h
@@ -59,6 +59,7 @@ extern NSString * const BRANCH_REQUEST_KEY_CHECKED_APPLE_AD_ATTRIBUTION;
 extern NSString * const BRANCH_REQUEST_KEY_LINK_IDENTIFIER;
 extern NSString * const BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER;
 extern NSString * const BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL;
+extern NSString * const BRANCH_REQUEST_KEY_LOCAL_URL;
 extern NSString * const BRANCH_REQUEST_KEY_BRAND;
 extern NSString * const BRANCH_REQUEST_KEY_MODEL;
 extern NSString * const BRANCH_REQUEST_KEY_SCREEN_WIDTH;
diff --git a/Branch-SDK/BranchConstants.m b/Branch-SDK/BranchConstants.m
@@ -55,6 +55,7 @@
 NSString * const BRANCH_REQUEST_KEY_CHECKED_APPLE_AD_ATTRIBUTION = @"apple_ad_attribution_checked";
 NSString * const BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER = @"spotlight_identifier";
 NSString * const BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL = @"universal_link_url";
+NSString * const BRANCH_REQUEST_KEY_LOCAL_URL = @"local_url";
 NSString * const BRANCH_REQUEST_KEY_BRAND = @"brand";
 NSString * const BRANCH_REQUEST_KEY_MODEL = @"model";
 NSString * const BRANCH_REQUEST_KEY_SCREEN_WIDTH = @"screen_width";
diff --git a/Branch-SDK/BranchInstallRequest.m b/Branch-SDK/BranchInstallRequest.m
@@ -15,6 +15,7 @@
 #import "BNCAppleReceipt.h"
 #import "BNCAppGroupsData.h"
 #import "BNCPartnerParameters.h"
+#import "BNCPasteboard.h"
 
 @implementation BranchInstallRequest
 
@@ -67,6 +68,13 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
                     onDict:params];
     }
     
+    if ([BNCPasteboard sharedInstance].checkOnInstall) {
+        NSURL *pasteboardURL = [[BNCPasteboard sharedInstance] checkForBranchLink];
+        if (pasteboardURL) {
+            [self safeSetValue:pasteboardURL.absoluteString forKey:BRANCH_REQUEST_KEY_LOCAL_URL onDict:params];
+        }
+    }
+    
     NSString *appleAttributionToken = [BNCSystemObserver appleAttributionToken];
     if (appleAttributionToken) {
         preferenceHelper.appleAttributionTokenChecked = YES;
diff --git a/Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj b/Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj
@@ -182,6 +182,8 @@
 		5F3D6718233061CB00454FF1 /* BranchCrossPlatformIDTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F3D6717233061CB00454FF1 /* BranchCrossPlatformIDTests.m */; };
 		5F3D671B233062FD00454FF1 /* BNCJsonLoader.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F3D671A233062FD00454FF1 /* BNCJsonLoader.m */; };
 		5F3D671C233062FD00454FF1 /* BNCJsonLoader.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F3D671A233062FD00454FF1 /* BNCJsonLoader.m */; };
+		5F4101F526851DC7003699AD /* BNCPasteboard.h in Headers */ = {isa = PBXBuildFile; fileRef = 5F4101F326851DC7003699AD /* BNCPasteboard.h */; };
+		5F4101F626851DC7003699AD /* BNCPasteboard.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F4101F426851DC7003699AD /* BNCPasteboard.m */; };
 		5F42763325DB3694005B9BBC /* AdServices.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5F42763225DB3694005B9BBC /* AdServices.framework */; };
 		5F437E35237DDF770052064B /* BNCTelephony.h in Headers */ = {isa = PBXBuildFile; fileRef = 5F437E33237DDF770052064B /* BNCTelephony.h */; };
 		5F437E36237DDF770052064B /* BNCTelephony.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F437E34237DDF770052064B /* BNCTelephony.m */; };
@@ -495,6 +497,8 @@
 		5F3D6717233061CB00454FF1 /* BranchCrossPlatformIDTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BranchCrossPlatformIDTests.m; sourceTree = "<group>"; };
 		5F3D6719233062FD00454FF1 /* BNCJsonLoader.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCJsonLoader.h; sourceTree = "<group>"; };
 		5F3D671A233062FD00454FF1 /* BNCJsonLoader.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCJsonLoader.m; sourceTree = "<group>"; };
+		5F4101F326851DC7003699AD /* BNCPasteboard.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCPasteboard.h; sourceTree = "<group>"; };
+		5F4101F426851DC7003699AD /* BNCPasteboard.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCPasteboard.m; sourceTree = "<group>"; };
 		5F42763225DB3694005B9BBC /* AdServices.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = AdServices.framework; path = System/Library/Frameworks/AdServices.framework; sourceTree = SDKROOT; };
 		5F437E33237DDF770052064B /* BNCTelephony.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BNCTelephony.h; sourceTree = "<group>"; };
 		5F437E34237DDF770052064B /* BNCTelephony.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCTelephony.m; sourceTree = "<group>"; };
@@ -989,6 +993,8 @@
 				5F437E34237DDF770052064B /* BNCTelephony.m */,
 				5F92B2372383703700CA909B /* BNCLocale.h */,
 				5F92B2382383703700CA909B /* BNCLocale.m */,
+				5F4101F326851DC7003699AD /* BNCPasteboard.h */,
+				5F4101F426851DC7003699AD /* BNCPasteboard.m */,
 				5FB0AA69231875B400A0F9EA /* BNCUserAgentCollector.h */,
 				5FB0AA6A231875B500A0F9EA /* BNCUserAgentCollector.m */,
 				464EA3991ACB38EC000E4094 /* BNCEncodingUtils.h */,
@@ -1114,6 +1120,7 @@
 				5F38022024DCC2E800E6FAFD /* BranchLogoutRequest.h in Headers */,
 				5F38023124DCC2E800E6FAFD /* BNCNetworkService.h in Headers */,
 				5F38021624DCC2E800E6FAFD /* BranchSpotlightUrlRequest.h in Headers */,
+				5F4101F526851DC7003699AD /* BNCPasteboard.h in Headers */,
 				4DCAC8181F426F7C00405D1D /* BranchLinkProperties.h in Headers */,
 				5F38022724DCC2E800E6FAFD /* BranchRedeemRewardsRequest.h in Headers */,
 				4DCAC81A1F426F7C00405D1D /* BranchUniversalObject.h in Headers */,
@@ -1427,6 +1434,7 @@
 				466B58551B17779C00A69EDE /* Branch.m in Sources */,
 				5F437E3E237E03C00052064B /* BNCDeviceSystem.m in Sources */,
 				5F38023B24DCC2E800E6FAFD /* BranchContentDiscoverer.m in Sources */,
+				5F4101F626851DC7003699AD /* BNCPasteboard.m in Sources */,
 				4DBC88651F3A55B700E119BF /* NSString+Branch.m in Sources */,
 				54FF1F8E1BD1D4AE0004CE2E /* BranchUniversalObject.m in Sources */,
 				4DA577181E67B1D600A43BDD /* BNCLog.m in Sources */,
diff --git a/Branch-TestBed/Branch-TestBed/AppDelegate.m b/Branch-TestBed/Branch-TestBed/AppDelegate.m
@@ -51,6 +51,8 @@ - (BOOL)application:(UIApplication *)application
     // partner parameter sample
     //[branch addFacebookPartnerParameterWithName:@"em" value:@"11234e56af071e9c79927651156bd7a10bca8ac34672aba121056e2698ee7088"];
     
+    [branch checkPasteboardForBranchLinkOnInstall];
+    
     /*
      *    Required: Initialize Branch, passing a deep link handler block:
      */
