Merge pull request #1034 from BranchMetrics/SDK-863-AppleTV

SDK-863 apple tv

Author: echo-branch

Branch-SDK/Branch-SDK/BNCApplication.m

@@ -116,38 +116,48 @@ + (NSDate*) firstInstallBuildDate {
     return firstBuildDate;
 }
 
-+ (NSDate*) currentInstallDate {
++ (NSDate *) currentInstallDate {
+    NSDate *installDate = [NSDate date];
+    
+    #if !TARGET_OS_TV
+    // tvOS always returns a creation date of Unix epoch 0 on device
+    installDate = [self creationDateForLibraryDirectory];
+    #endif
+    
+    if (installDate == nil || [installDate timeIntervalSince1970] <= 0.0) {
+        BNCLogWarning(@"Invalid install date, using [NSDate date].");
+    }
+    return installDate;
+}
+
++ (NSDate *)creationDateForLibraryDirectory {
     NSError *error = nil;
     NSFileManager *fileManager = [NSFileManager defaultManager];
-    NSURL *libraryURL =
-        [[fileManager URLsForDirectory:NSLibraryDirectory inDomains:NSUserDomainMask] firstObject];
-    NSDictionary *attributes = [fileManager attributesOfItemAtPath:libraryURL.path error:&error];
+    NSURL *directoryURL = [[fileManager URLsForDirectory:NSLibraryDirectory inDomains:NSUserDomainMask] firstObject];
+    NSDictionary *attributes = [fileManager attributesOfItemAtPath:directoryURL.path error:&error];
     if (error) {
-        BNCLogError(@"Can't get library date: %@.", error);
-        return nil;
-    }
-    NSDate *installDate = [attributes fileCreationDate];
-    if (installDate == nil || [installDate timeIntervalSince1970] <= 0.0) {
-        BNCLogError(@"Invalid install date.");
+        BNCLogError(@"Can't get creation date for Library directory: %@", error);
+       return nil;
     }
-    return installDate;
+    return [attributes fileCreationDate];
 }
 
 + (NSDate*) firstInstallDate {
+    // check keychain for stored install date, on iOS this is lost on app deletion.
     NSError *error = nil;
-    NSDate* firstInstallDate =
-        [BNCKeyChain retrieveValueForService:kBranchKeychainService
-            key:kBranchKeychainFirstInstalldKey
-            error:&error];
-    if (firstInstallDate)
+    NSDate* firstInstallDate = [BNCKeyChain retrieveValueForService:kBranchKeychainService key:kBranchKeychainFirstInstalldKey error:&error];
+    if (firstInstallDate) {
         return firstInstallDate;
-
+    }
+    
+    // check filesytem for creation date
     firstInstallDate = [self currentInstallDate];
-    error = [BNCKeyChain storeValue:firstInstallDate
-        forService:kBranchKeychainService
-        key:kBranchKeychainFirstInstalldKey
-        cloudAccessGroup:nil];
-    if (error) BNCLogError(@"Keychain store: %@.", error);
+    
+    // save filesystem time to keychain
+    error = [BNCKeyChain storeValue:firstInstallDate forService:kBranchKeychainService key:kBranchKeychainFirstInstalldKey cloudAccessGroup:nil];
+    if (error) {
+        BNCLogError(@"Keychain store: %@.", error);
+    }
     return firstInstallDate;
 }
 

Branch-SDK/Branch-SDK/BNCDeviceInfo.m

@@ -12,13 +12,17 @@
 #import "BNCLog.h"
 #import "BNCConfig.h"
 #import "BNCNetworkInterface.h"
-#import "BNCUserAgentCollector.h"
-#import "BNCTelephony.h"
 #import "BNCReachability.h"
 #import "BNCLocale.h"
 #import "NSMutableDictionary+Branch.h"
 #import "BNCDeviceSystem.h"
 
+#if !TARGET_OS_TV
+// tvOS does not support webkit or telephony
+#import "BNCTelephony.h"
+#import "BNCUserAgentCollector.h"
+#endif
+
 #if __has_feature(modules)
 @import UIKit;
 #else
@@ -60,31 +64,34 @@ - (void)registerPluginName:(NSString *)name version:(NSString *)version {
 }
 
 - (void)loadDeviceInfo {
-    
+
     BNCLocale *locale = [BNCLocale new];
-    BNCTelephony *telephony = [BNCTelephony new];
     BNCDeviceSystem *deviceSystem = [BNCDeviceSystem new];
-        
+
     // The random id is regenerated per app launch.  This maintains existing behavior.
     self.randomId = [[NSUUID UUID] UUIDString];
     self.vendorId = [BNCSystemObserver getVendorId];
     [self checkAdvertisingIdentifier];
-    
+
     self.brandName = [BNCSystemObserver getBrand];
     self.modelName = [BNCSystemObserver getModel];
     self.osName = [BNCSystemObserver getOS];
     self.osVersion = [BNCSystemObserver getOSVersion];
     self.osBuildVersion = deviceSystem.systemBuildVersion;
-    
+
     if (deviceSystem.cpuType) {
         self.cpuType = [deviceSystem.cpuType stringValue];
     }
-    
+
     self.screenWidth = [BNCSystemObserver getScreenWidth];
     self.screenHeight = [BNCSystemObserver getScreenHeight];
     self.screenScale = @([UIScreen mainScreen].scale);
+
+    #if !TARGET_OS_TV
+    BNCTelephony *telephony = [BNCTelephony new];
     self.carrierName = telephony.carrierName;
-    
+    #endif
+
     self.locale = [NSLocale currentLocale].localeIdentifier;
     self.country = [locale country];
     self.language = [locale language];
@@ -114,25 +121,30 @@ - (NSString *)connectionType {
 }
 
 - (NSString *)userAgentString {
+    #if !TARGET_OS_TV
     return [BNCUserAgentCollector instance].userAgent;
+    #else
+    // tvOS has no web browser or webview
+    return @"";
+    #endif
 }
 
 // IDFA should never be cached
 - (void)checkAdvertisingIdentifier {
     self.isAdTrackingEnabled = [BNCSystemObserver adTrackingSafe];
     self.advertiserId = [BNCSystemObserver getAdId];
     BOOL ignoreIdfa = [BNCPreferenceHelper preferenceHelper].isDebug;
-    
+
     if (self.advertiserId && !ignoreIdfa) {
         self.hardwareId = self.advertiserId;
         self.hardwareIdType = @"idfa";
         self.isRealHardwareId = YES;
-    
+
     } else if (self.vendorId) {
         self.hardwareId = self.vendorId;
         self.hardwareIdType = @"vendor_id";
         self.isRealHardwareId = YES;
-        
+
     } else {
         self.hardwareId = self.randomId;
         self.hardwareIdType = @"random";
@@ -144,24 +156,24 @@ - (NSDictionary *)v2dictionary {
     NSMutableDictionary *dictionary = [NSMutableDictionary new];
     @synchronized (self) {
         [self checkAdvertisingIdentifier];
-        
+
         BOOL disableAdNetworkCallouts = [BNCPreferenceHelper preferenceHelper].disableAdNetworkCallouts;
         if (disableAdNetworkCallouts) {
             dictionary[@"disable_ad_network_callouts"] = [NSNumber numberWithBool:disableAdNetworkCallouts];
         }
-        
+
         if ([BNCPreferenceHelper preferenceHelper].isDebug) {
             dictionary[@"unidentified_device"] = @(YES);
         } else {
             [dictionary bnc_safeSetObject:self.vendorId forKey:@"idfv"];
             [dictionary bnc_safeSetObject:self.advertiserId forKey:@"idfa"];
         }
         [dictionary bnc_safeSetObject:[self localIPAddress] forKey:@"local_ip"];
-        
+
         if (!self.isAdTrackingEnabled) {
             dictionary[@"limit_ad_tracking"] = @(YES);
         }
-        
+
         if ([BNCPreferenceHelper preferenceHelper].limitFacebookTracking) {
             dictionary[@"limit_facebook_tracking"] = @(YES);
         }
@@ -184,9 +196,9 @@ - (NSDictionary *)v2dictionary {
 
         [dictionary bnc_safeSetObject:[BNCPreferenceHelper preferenceHelper].userIdentity forKey:@"developer_identity"];
         [dictionary bnc_safeSetObject:[BNCPreferenceHelper preferenceHelper].deviceFingerprintID forKey:@"device_fingerprint_id"];
-        
+
         [dictionary bnc_safeSetObject:self.applicationVersion forKey:@"app_version"];
-        
+
         [dictionary bnc_safeSetObject:self.pluginName forKey:@"plugin_name"];
         [dictionary bnc_safeSetObject:self.pluginVersion forKey:@"plugin_version"];
         dictionary[@"sdk_version"] = BNC_SDK_VERSION;

Branch-SDK/Branch-SDK/BNCLocale.m

@@ -26,7 +26,7 @@ - (nullable NSString *)country {
 
 - (nullable NSString *)countryOS10 {
     NSString *country = nil;
-    if (@available(iOS 10, *)) {
+    if (@available(iOS 10, tvOS 10, *)) {
         country = [[NSLocale currentLocale] countryCode];
     }
     return country;
@@ -63,15 +63,15 @@ - (nullable NSString *)language {
 
 - (nullable NSString *)languageOS10 {
     NSString *language = nil;
-    if (@available(iOS 10, *)) {
+    if (@available(iOS 10, tvOS 10, *)) {
         language = [[NSLocale currentLocale] languageCode];
     }
     return language;
 }
 
 - (nullable NSString *)languageOS9 {
     NSString *language = nil;
-    if (@available(iOS 9, *)) {
+    if (@available(iOS 9, tvOS 9, *)) {
         NSString *rawLanguage = [[NSLocale preferredLanguages] firstObject];
         NSDictionary *languageDictionary = [NSLocale componentsFromLocaleIdentifier:rawLanguage];
         language = [languageDictionary objectForKey:@"kCFLocaleLanguageCodeKey"];

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -911,27 +911,35 @@ + (void) initialize {
         if (success) {
             return branchURL;
         } else  {
-            BNCLogWarning(@"CreateBranchURL failed: %@ URL: %@.", error, branchURL);
+            // BNCLog is dependent on BNCCreateDirectoryForBranchURLWithSearchPath_Unthreaded and cannot be used to log errors from it.
+            NSLog(@"CreateBranchURL failed: %@ URL: %@.", error, branchURL);
         }
     }
     return nil;
 }
 
 NSURL* _Nonnull BNCURLForBranchDirectory_Unthreaded() {
+    #if TARGET_OS_TV
+    // tvOS only allows the caches or temp directory
+    NSArray *kSearchDirectories = @[
+        @(NSCachesDirectory)
+    ];
+    #else
     NSArray *kSearchDirectories = @[
         @(NSApplicationSupportDirectory),
         @(NSLibraryDirectory),
         @(NSCachesDirectory),
         @(NSDocumentDirectory),
     ];
-
+    #endif
+    
     for (NSNumber *directory in kSearchDirectories) {
         NSSearchPathDirectory directoryValue = [directory unsignedLongValue];
         NSURL *URL = BNCCreateDirectoryForBranchURLWithSearchPath_Unthreaded(directoryValue);
         if (URL) return URL;
     }
 
-    //  Worst case backup plan:
+    //  Worst case backup plan.  This does NOT work on tvOS.
     NSString *path = [@"~/Library/io.branch" stringByExpandingTildeInPath];
     NSURL *branchURL = [NSURL fileURLWithPath:path isDirectory:YES];
     NSFileManager *fileManager = [NSFileManager defaultManager];
@@ -943,7 +951,8 @@ + (void) initialize {
             attributes:nil
             error:&error];
     if (!success) {
-        BNCLogError(@"Worst case CreateBranchURL error was: %@ URL: %@.", error, branchURL);
+        // BNCLog is dependent on BNCURLForBranchDirectory_Unthreaded and cannot be used to log errors from it.
+        NSLog(@"Worst case CreateBranchURL error was: %@ URL: %@.", error, branchURL);
     }
     return branchURL;
 }

Branch-SDK/Branch-SDK/BNCSystemObserver.m

@@ -142,7 +142,11 @@ + (BOOL)isSimulator {
 }
 
 + (NSString *)getOS {
+    #if TARGET_OS_TV
+    return @"tv_OS";
+    #else
     return @"iOS";
+    #endif
 }
 
 + (NSString *)getOSVersion {

Branch-SDK/Branch-SDK/Branch.h

@@ -8,10 +8,8 @@
 
 #if __has_feature(modules)
 @import Foundation;
-@import UIKit;
 #else
 #import <Foundation/Foundation.h>
-#import <UIKit/UIKit.h>
 #endif
 
 #import "BNCCallbacks.h"
@@ -25,21 +23,25 @@
 #import "BNCServerInterface.h"
 #import "BNCServerRequestQueue.h"
 #import "BNCAvailability.h"
-#import "BranchActivityItemProvider.h"
 #import "BranchConstants.h"
-#import "BranchCSSearchableItemAttributeSet.h"
 #import "BranchDeepLinkingController.h"
 #import "BranchEvent.h"
 #import "BranchLinkProperties.h"
 #import "BranchDelegate.h"
-#import "BranchShareLink.h"
 #import "BranchUniversalObject.h"
 #import "BranchCrossPlatformID.h"
 #import "BranchLastAttributedTouchData.h"
 #import "BNCInitSessionResponse.h"
 #import "UIViewController+Branch.h"
 #import "BranchScene.h"
 
+#if !TARGET_OS_TV
+// tvOS does not support these features
+#import "BranchShareLink.h"
+#import "BranchActivityItemProvider.h"
+#import "BranchCSSearchableItemAttributeSet.h"
+#endif
+
 NS_ASSUME_NONNULL_BEGIN
 
 /**
@@ -277,7 +279,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 @property (weak, nullable) NSObject<BranchDelegate>* delegate;
 
 #pragma mark - BranchActivityItemProvider methods
-
+#if !TARGET_OS_TV
 ///-----------------------------------------
 /// @name BranchActivityItemProvider methods
 ///-----------------------------------------
@@ -366,7 +368,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 + (BranchActivityItemProvider *)getBranchActivityItemWithParams:(NSDictionary *)params feature:(nullable NSString *)feature stage:(nullable NSString *)stage tags:(nullable NSArray *)tags alias:(nullable NSString *)alias delegate:(nullable id <BranchActivityItemProviderDelegate>)delegate;
 
-
+#endif
 
 #pragma mark - Initialization methods
 
@@ -1576,6 +1578,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 - (void)getSpotlightUrlWithParams:(NSDictionary *)params callback:(callbackWithParams)callback;
 
 #pragma mark - Content Discovery methods
+#if !TARGET_OS_TV
 
 ///--------------------------------
 /// @name Content Discovery methods
@@ -1829,6 +1832,8 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)removeAllPrivateContentFromSpotLightWithCallback:(void (^_Nullable)(NSError * _Nullable error))completion;
 
+#endif
+
 /**
  Method for creating a one of Branch instance and specifying its dependencies.