supd/supd.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #import <Foundation/Foundation.h>
  25 #import "supdProtocol.h"
  26
  27 @interface SFAnalyticsClient: NSObject
  28 @property (nonatomic) NSString* storePath;
  29 @property (nonatomic) NSString* name;
  30 @property (atomic) BOOL requireDeviceAnalytics;
  31 @property (atomic) BOOL requireiCloudAnalytics;
  32 @end
  33
  34 @interface SFAnalyticsTopic : NSObject <NSURLSessionDelegate>
  35 @property NSString* splunkTopicName;
  36 @property NSURL* splunkBagURL;
  37 @property NSString *internalTopicName;
  38 @property NSUInteger uploadSizeLimit;
  39
  40 @property NSArray<SFAnalyticsClient*>* topicClients;
  41
  42 // --------------------------------
  43 // Things below are for unit testing
  44 - (instancetype)initWithDictionary:(NSDictionary *)dictionary name:(NSString *)topicName samplingRates:(NSDictionary *)rates;
  45 - (BOOL)haveEligibleClients;
  46 - (NSArray<NSDictionary *> *)createChunkedLoggingJSON:(NSArray<NSDictionary *> *)healthSummaries failures:(NSArray<NSDictionary *> *)failures error:(NSError **)error;
  47 - (NSArray<NSArray *> *)chunkFailureSet:(size_t)sizeCapacity events:(NSArray<NSDictionary *> *)events error:(NSError **)error;
  48 - (size_t)serializedEventSize:(NSObject *)event error:(NSError**)error;
  49 + (NSString*)databasePathForCKKS;
  50 + (NSString*)databasePathForSOS;
  51 + (NSString*)databasePathForPCS;
  52 + (NSString*)databasePathForLocal;
  53 + (NSString*)databasePathForTrust;
  54 + (NSString*)databasePathForNetworking;
  55 + (NSString*)databasePathForSignIn;
  56 + (NSString*)databasePathForCloudServices;
  57
  58 #if TARGET_OS_OSX
  59 + (NSString*)databasePathForRootTrust;
  60 + (NSString*)databasePathForRootNetworking;
  61 #endif
  62 @end
  63
  64 @interface SFAnalyticsReporter : NSObject
  65 - (BOOL)saveReport:(NSData *)reportData fileName:(NSString *)fileName;
  66 @end
  67
  68 extern NSString* const SupdErrorDomain;
  69 typedef NS_ENUM(NSInteger, SupdError) {
  70     SupdNoError = 0,
  71     SupdGenericError,
  72     SupdInvalidJSONError,
  73 };
  74
  75 @interface supd : NSObject <supdProtocol>
  76 + (instancetype)instance;
  77 + (void)removeInstance;
  78 + (void)instantiate;
  79 - (instancetype)initWithReporter:(SFAnalyticsReporter *)reporter;
  80
  81 // --------------------------------
  82 // Things below are for unit testing
  83 @property (readonly) dispatch_queue_t queue;
  84 @property (readonly) NSArray<SFAnalyticsTopic*>* analyticsTopics;
  85 @property (readonly) SFAnalyticsReporter *reporter;
  86 - (void)sendNotificationForOncePerReportSamplers;
  87 @end
  88
  89 // --------------------------------
  90 // Things below are for unit testing
  91 extern BOOL runningTests;                // Do not use 'force' when obtaining logging json
  92 extern BOOL deviceAnalyticsOverride;
  93 extern BOOL deviceAnalyticsEnabled;
  94 extern BOOL iCloudAnalyticsOverride;
  95 extern BOOL iCloudAnalyticsEnabled;