CORE-1950 backport install referrer

Author: echo-branch

Branch-SDK/BNCPreferenceHelper.h

@@ -28,6 +28,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (strong, nonatomic) NSString *linkClickIdentifier;
 @property (strong, nonatomic) NSString *spotlightIdentifier;
 @property (strong, atomic)    NSString *universalLinkUrl;
+@property (strong, atomic)    NSString *initialReferrer;
 @property (strong, nonatomic) NSString *userUrl;
 @property (strong, nonatomic) NSString *userIdentity;
 @property (strong, nonatomic) NSString *sessionParams;

Branch-SDK/BNCPreferenceHelper.m

@@ -33,6 +33,7 @@
 static NSString * const BRANCH_PREFS_KEY_LINK_CLICK_IDENTIFIER = @"bnc_link_click_identifier";
 static NSString * const BRANCH_PREFS_KEY_SPOTLIGHT_IDENTIFIER = @"bnc_spotlight_identifier";
 static NSString * const BRANCH_PREFS_KEY_UNIVERSAL_LINK_URL = @"bnc_universal_link_url";
+static NSString * const BRANCH_PREFS_KEY_INITIAL_REFERRER = @"bnc_initial_referrer";
 static NSString * const BRANCH_PREFS_KEY_SESSION_PARAMS = @"bnc_session_params";
 static NSString * const BRANCH_PREFS_KEY_INSTALL_PARAMS = @"bnc_install_params";
 static NSString * const BRANCH_PREFS_KEY_USER_URL = @"bnc_user_url";
@@ -75,6 +76,7 @@ @implementation BNCPreferenceHelper
             sessionParams = _sessionParams,
             installParams = _installParams,
             universalLinkUrl = _universalLinkUrl,
+            initialReferrer = _initialReferrer,
             externalIntentURI = _externalIntentURI,
             isDebug = _isDebug,
             retryCount = _retryCount,
@@ -315,6 +317,13 @@ - (void)setUniversalLinkUrl:(NSString *)universalLinkUrl {
     [self writeObjectToDefaults:BRANCH_PREFS_KEY_UNIVERSAL_LINK_URL value:universalLinkUrl];
 }
 
+- (NSString *)initialReferrer {
+    return [self readStringFromDefaults:BRANCH_REQUEST_KEY_INITIAL_REFERRER];
+}
+
+- (void)setInitialReferrer:(NSString *)initialReferrer {
+    [self writeObjectToDefaults:BRANCH_REQUEST_KEY_INITIAL_REFERRER value:initialReferrer];
+}
 - (NSString *)sessionParams {
     @synchronized (self) {
         if (!_sessionParams) {
@@ -659,6 +668,7 @@ - (void) clearTrackingInformation {
         self.spotlightIdentifier = nil;
         self.referringURL = nil;
         self.universalLinkUrl = nil;
+        self.initialReferrer = nil;
         self.installParams = nil;
         self.appleSearchAdDetails = nil;
         self.appleSearchAdNeedsSend = NO;

Branch-SDK/Branch.m

@@ -811,6 +811,12 @@ - (BOOL)continueUserActivity:(NSUserActivity *)userActivity {
 - (BOOL)continueUserActivity:(NSUserActivity *)userActivity sceneIdentifier:(NSString *)sceneIdentifier {
     BNCLogDebugSDK(@"continueUserActivity:");
 
+    if (@available(iOS 11.0, *)) {
+        if (userActivity.referrerURL) {
+            self.preferenceHelper.initialReferrer = userActivity.referrerURL.absoluteString;
+        }
+    }
+    
     // Check to see if a browser activity needs to be handled
     if ([userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb]) {
         return [self handleDeepLink:userActivity.webpageURL sceneIdentifier:sceneIdentifier];

Branch-SDK/BranchConstants.h

@@ -60,6 +60,7 @@ 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_INITIAL_REFERRER;
 extern NSString * const BRANCH_REQUEST_KEY_BRAND;
 extern NSString * const BRANCH_REQUEST_KEY_MODEL;
 extern NSString * const BRANCH_REQUEST_KEY_SCREEN_WIDTH;

Branch-SDK/BranchConstants.m

@@ -56,6 +56,7 @@
 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_INITIAL_REFERRER = @"initial_referrer";
 NSString * const BRANCH_REQUEST_KEY_BRAND = @"brand";
 NSString * const BRANCH_REQUEST_KEY_MODEL = @"model";
 NSString * const BRANCH_REQUEST_KEY_SCREEN_WIDTH = @"screen_width";

Branch-SDK/BranchInstallRequest.m

@@ -38,7 +38,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
-
+    [self safeSetValue:preferenceHelper.initialReferrer forKey:BRANCH_REQUEST_KEY_INITIAL_REFERRER onDict:params];
     [self safeSetValue:[[BNCAppleReceipt sharedInstance] installReceipt] forKey:BRANCH_REQUEST_KEY_APPLE_RECEIPT onDict:params];
     [self safeSetValue:[NSNumber numberWithBool:[[BNCAppleReceipt sharedInstance] isTestFlight]] forKey:BRANCH_REQUEST_KEY_APPLE_TESTFLIGHT onDict:params];
 

Branch-SDK/BranchOpenRequest.m

@@ -64,6 +64,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
+    [self safeSetValue:preferenceHelper.initialReferrer forKey:BRANCH_REQUEST_KEY_INITIAL_REFERRER onDict:params];
     [self safeSetValue:preferenceHelper.externalIntentURI forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:params];
     if (preferenceHelper.limitFacebookTracking)
         params[@"limit_facebook_tracking"] = (__bridge NSNumber*) kCFBooleanTrue;