forked from amplitude/Amplitude-iOS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAmplitude.m
1121 lines (957 loc) · 46 KB
/
Amplitude.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// Amplitude.m
// Fawkes
//
// Created by Spenser Skates on 7/26/12.
// Copyright (c) 2012 Sonalight, Inc. All rights reserved.
//
#import "Amplitude.h"
#import "AmplitudeLocationManagerDelegate.h"
#import "AmplitudeARCMacros.h"
#import <math.h>
#import <sys/socket.h>
#import <sys/sysctl.h>
#import <net/if.h>
#import <net/if_dl.h>
#import <CommonCrypto/CommonDigest.h>
#import <UIKit/UIKit.h>
#include <sys/types.h>
#include <sys/sysctl.h>
static int apiVersion = 2;
static NSString *_apiKey;
static NSString *_userId;
static NSString *_deviceId;
static NSString *_versionName;
static NSString *_buildVersionRelease;
static NSString *_platformString;
static NSString *_phoneModel;
static NSString *_phoneCarrier;
static NSString *_country;
static NSString *_language;
static NSDictionary *_globalProperties;
static NSString *_campaignInformation;
static bool isCurrentlyTrackingCampaign = NO;
static long long _sessionId = -1;
static bool sessionStarted = NO;
static bool updateScheduled = NO;
static bool updatingCurrently = NO;
static NSMutableDictionary *propertyList;
static NSString *propertyListPath;
static NSMutableDictionary *eventsData;
static NSString *eventsDataPath;
static NSOperationQueue *mainQueue;
static NSOperationQueue *initializerQueue;
static NSOperationQueue *backgroundQueue;
static UIBackgroundTaskIdentifier uploadTaskID;
static bool locationListeningEnabled = YES;
static CLLocationManager *locationManager;
static CLLocation *lastKnownLocation;
static AmplitudeLocationManagerDelegate *locationManagerDelegate;
@implementation Amplitude
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
+ (void)initialize
{
initializerQueue = [[NSOperationQueue alloc] init];
backgroundQueue = [[NSOperationQueue alloc] init];
// Force method calls to happen in FIFO order by only allowing 1 concurrent operation
[backgroundQueue setMaxConcurrentOperationCount:1];
// Ensure initialize finishes running asynchronously before other calls are run
[backgroundQueue setSuspended:YES];
[initializerQueue addOperationWithBlock:^{
_versionName = SAFE_ARC_RETAIN([[[NSBundle mainBundle] infoDictionary] valueForKey:@"CFBundleShortVersionString"]);
_buildVersionRelease = SAFE_ARC_RETAIN([[UIDevice currentDevice] systemVersion]);
_platformString = SAFE_ARC_RETAIN([self getPlatformString]);
_phoneModel = SAFE_ARC_RETAIN([self getPhoneModel]);
Class CTTelephonyNetworkInfo = NSClassFromString(@"CTTelephonyNetworkInfo");
SEL subscriberCellularProvider = NSSelectorFromString(@"subscriberCellularProvider");
SEL carrierName = NSSelectorFromString(@"carrierName");
if (CTTelephonyNetworkInfo && subscriberCellularProvider && carrierName) {
NSObject *info = [[NSClassFromString(@"CTTelephonyNetworkInfo") alloc] init];
_phoneCarrier = SAFE_ARC_RETAIN([[info performSelector:subscriberCellularProvider] performSelector:carrierName]);
SAFE_ARC_RELEASE(info);
}
NSLocale *developerLanguage = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US"];
_country = SAFE_ARC_RETAIN([developerLanguage displayNameForKey:NSLocaleCountryCode value:[[NSLocale currentLocale] objectForKey:NSLocaleCountryCode]]);
_language = SAFE_ARC_RETAIN([developerLanguage displayNameForKey:NSLocaleLanguageCode value:[[NSLocale preferredLanguages] objectAtIndex:0]]);
SAFE_ARC_RELEASE(developerLanguage);
mainQueue = SAFE_ARC_RETAIN([NSOperationQueue mainQueue]);
uploadTaskID = UIBackgroundTaskInvalid;
NSString *eventsDataDirectory = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) objectAtIndex: 0];
// Load propertyList object
propertyListPath = SAFE_ARC_RETAIN([eventsDataDirectory stringByAppendingPathComponent:@"com.amplitude.plist"]);
bool successfullyLoadedPropertyList = NO;
if ([[NSFileManager defaultManager] fileExistsAtPath:propertyListPath]) {
NSData *propertyListData = [[NSFileManager defaultManager] contentsAtPath:propertyListPath];
if (propertyListData != nil) {
NSError *error = nil;
propertyList = SAFE_ARC_RETAIN((NSMutableDictionary *)[NSPropertyListSerialization
propertyListWithData:propertyListData
options:NSPropertyListMutableContainersAndLeaves
format:NULL error:&error]);
if (error == nil) {
if (propertyList != nil) {
successfullyLoadedPropertyList = YES;
}
} else {
NSLog(@"ERROR: propertyList deserialization error:%@", error);
error = nil;
[[NSFileManager defaultManager] removeItemAtPath:eventsDataPath error:&error];
if (error != nil) {
NSLog(@"ERROR: Can't remove corrupt propertyList file:%@", error);
}
}
}
}
if (!successfullyLoadedPropertyList) {
propertyList = SAFE_ARC_RETAIN([NSMutableDictionary dictionary]);
[propertyList setObject:[NSNumber numberWithLongLong:0LL] forKey:@"max_id"];
NSError *error = nil;
NSData *propertyListData = [NSPropertyListSerialization
dataWithPropertyList:propertyList
format:NSPropertyListXMLFormat_v1_0
options:0 error:&error];
if (error == nil) {
if (propertyListData != nil) {
bool success = [propertyListData writeToFile:propertyListPath atomically:YES];
if (!success) {
NSLog(@"ERROR: Unable to save propertyList to file on initialization");
}
} else {
NSLog(@"ERROR: propertyListData is nil on initialization");
}
} else {
NSLog(@"ERROR: Unable to serialize propertyList on initialization:%@", error);
}
}
// Load eventData object
eventsDataPath = SAFE_ARC_RETAIN([eventsDataDirectory stringByAppendingPathComponent:@"com.amplitude.archiveDict"]);
bool successfullyLoadedEventsData = NO;
if ([[NSFileManager defaultManager] fileExistsAtPath:eventsDataPath]) {
@try {
eventsData = SAFE_ARC_RETAIN([NSKeyedUnarchiver unarchiveObjectWithFile:eventsDataPath]);
if (eventsData != nil) {
successfullyLoadedEventsData = YES;
}
}
@catch (NSException *e) {
NSLog(@"EXCEPTION: Corrupt file %@: %@", [e name], [e reason]);
NSError *error = nil;
[[NSFileManager defaultManager] removeItemAtPath:eventsDataPath error:&error];
if (error != nil) {
NSLog(@"ERROR: Can't remove corrupt archiveDict file:%@", error);
}
}
}
if (!successfullyLoadedEventsData) {
eventsData = SAFE_ARC_RETAIN([NSMutableDictionary dictionary]);
[eventsData setObject:[NSMutableArray array] forKey:@"events"];
[eventsData setObject:[NSNumber numberWithLongLong:0LL] forKey:@"max_id"];
[eventsData setObject:@"{\"tracked\": false}" forKey:@"campaign_information"];
bool success = [NSKeyedArchiver archiveRootObject:eventsData toFile:eventsDataPath];
if (!success) {
NSLog(@"ERROR: Unable to save eventsData to file on initialization");
}
}
_campaignInformation = SAFE_ARC_RETAIN([eventsData objectForKey:@"campaign_information"]);
[backgroundQueue setSuspended:NO];
}];
// Location manager callbacks must be fired on a thread with a run loop (eg the main thread)
Class CLLocationManager = NSClassFromString(@"CLLocationManager");
locationManager = [[CLLocationManager alloc] init];
locationManagerDelegate = [[AmplitudeLocationManagerDelegate alloc] init];
SEL setDelegate = NSSelectorFromString(@"setDelegate:");
[locationManager performSelector:setDelegate withObject:locationManagerDelegate];
}
+ (void)initializeApiKey:(NSString*) apiKey
{
[Amplitude initializeApiKey:apiKey userId:nil];
}
+ (void)initializeApiKey:(NSString*) apiKey userId:(NSString*) userId
{
[Amplitude initializeApiKey:apiKey userId:userId trackCampaignSource:NO];
}
+ (void)initializeApiKey:(NSString*) apiKey trackCampaignSource:(bool) trackCampaignSource
{
[Amplitude initializeApiKey:apiKey userId:nil trackCampaignSource:trackCampaignSource];
}
+ (void)initializeApiKey:(NSString*) apiKey userId:(NSString*) userId trackCampaignSource:(bool) trackCampaignSource
{
if (apiKey == nil) {
NSLog(@"ERROR: apiKey cannot be nil in initializeApiKey:");
return;
}
if (![Amplitude isArgument:apiKey validType:[NSString class] methodName:@"initializeApiKey:"]) {
return;
}
if (userId != nil && ![Amplitude isArgument:userId validType:[NSString class] methodName:@"initializeApiKey:"]) {
return;
}
if ([apiKey length] == 0) {
NSLog(@"ERROR: apiKey cannot be blank in initializeApiKey:");
return;
}
(void) SAFE_ARC_RETAIN(apiKey);
SAFE_ARC_RELEASE(_apiKey);
_apiKey = apiKey;
[backgroundQueue addOperationWithBlock:^{
@synchronized (eventsData) {
if (_deviceId == nil) {
_deviceId = SAFE_ARC_RETAIN([eventsData objectForKey:@"device_id"]);
if (_deviceId == nil) {
_deviceId = SAFE_ARC_RETAIN([Amplitude getDeviceId]);
[eventsData setObject:_deviceId forKey:@"device_id"];
}
}
if (userId != nil) {
(void) SAFE_ARC_RETAIN(userId);
SAFE_ARC_RELEASE(_userId);
_userId = userId;
[eventsData setObject:_userId forKey:@"user_id"];
} else {
_userId = SAFE_ARC_RETAIN([eventsData objectForKey:@"user_id"]);
}
}
NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
[center addObserver:self
selector:@selector(enterForeground)
name:UIApplicationWillEnterForegroundNotification
object:nil];
[center addObserver:self
selector:@selector(enterBackground)
name:UIApplicationDidEnterBackgroundNotification
object:nil];
if (trackCampaignSource) {
[Amplitude trackCampaignSource];
}
}];
[Amplitude enterForeground];
}
+ (void)enableCampaignTrackingApiKey:(NSString*) apiKey
{
if (apiKey == nil) {
NSLog(@"ERROR: apiKey cannot be nil in enableCampaignTrackingApiKey:");
return;
}
if (![Amplitude isArgument:apiKey validType:[NSString class] methodName:@"enableCampaignTrackingApiKey:"]) {
return;
}
if ([apiKey length] == 0) {
NSLog(@"ERROR: apiKey cannot be blank in enableCampaignTrackingApiKey:");
return;
}
[backgroundQueue addOperationWithBlock:^{
(void) SAFE_ARC_RETAIN(apiKey);
SAFE_ARC_RELEASE(_apiKey);
_apiKey = apiKey;
[Amplitude trackCampaignSource];
}];
}
+ (void)trackCampaignSource
{
NSNumber *hasTrackedCampaign = [NSNumber numberWithBool:NO];
@synchronized (eventsData) {
hasTrackedCampaign = [eventsData objectForKey:@"has_tracked_campaign"];
}
if (![hasTrackedCampaign boolValue] && !isCurrentlyTrackingCampaign) {
isCurrentlyTrackingCampaign = YES;
NSMutableDictionary *fingerprint = [NSMutableDictionary dictionary];
[fingerprint setObject:[Amplitude replaceWithJSONNull:_deviceId] forKey:@"device_id"];
[fingerprint setObject:@"ios" forKey:@"client"];
[fingerprint setObject:[Amplitude replaceWithJSONNull:_country] forKey:@"country"];
[fingerprint setObject:[Amplitude replaceWithJSONNull:_language] forKey:@"language"];
[fingerprint setObject:[Amplitude replaceWithJSONNull:_phoneModel] forKey:@"phone_model"];
[fingerprint setObject:[Amplitude replaceWithJSONNull:_buildVersionRelease] forKey:@"build_version_release"];
[fingerprint setObject:[Amplitude replaceWithJSONNull:_phoneCarrier] forKey:@"carrier"];
NSError *error = nil;
NSData *fingerprintData = [NSJSONSerialization dataWithJSONObject:fingerprint options:0 error:&error];
if (error != nil) {
NSLog(@"ERROR: NSJSONSerialization error: %@", error);
isCurrentlyTrackingCampaign = NO;
return;
}
NSString *fingerprintString = SAFE_ARC_AUTORELEASE([[NSString alloc] initWithData:fingerprintData encoding:NSUTF8StringEncoding]);
[Amplitude makeCampaignTrackingPostRequest:@"https://ref.amplitude.com/install" fingerprint:fingerprintString];
}
}
+ (void)makeCampaignTrackingPostRequest:(NSString*) url fingerprint:(NSString*) fingerprintString
{
NSMutableURLRequest *request =[NSMutableURLRequest requestWithURL:[NSURL URLWithString:url]];
[request setTimeoutInterval:60.0];
NSMutableData *postData = [[NSMutableData alloc] init];
[postData appendData:[@"key=" dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[_apiKey dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[@"&fingerprint=" dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[[Amplitude urlEncodeString:fingerprintString] dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPMethod:@"POST"];
[request setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
[request setValue:[NSString stringWithFormat:@"%d", [postData length]] forHTTPHeaderField:@"Content-Length"];
[request setHTTPBody:postData];
SAFE_ARC_RELEASE(postData);
[NSURLConnection sendAsynchronousRequest:request queue:backgroundQueue completionHandler:^(NSURLResponse *response, NSData *data, NSError *error)
{
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse*)response;
if (response != nil) {
if ([httpResponse statusCode] == 200) {
NSError *error = nil;
NSDictionary *result = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
if (error != nil) {
NSLog(@"ERROR: Deserialization error:%@", error);
} else if (![result isKindOfClass:[NSDictionary class]]) {
NSLog(@"ERROR: JSON Dictionary not returned from server, invalid type:%@", [result class]);
} else {
// success, save successful campaign tracking
NSString *jsonString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
@synchronized (eventsData) {
[eventsData setObject:[NSNumber numberWithBool:YES] forKey:@"has_tracked_campaign"];
[eventsData setObject:jsonString forKey:@"campaign_information"];
}
_campaignInformation = jsonString;
}
} else {
NSLog(@"ERROR: Connection response received:%d, %@", [httpResponse statusCode],
SAFE_ARC_AUTORELEASE([[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]));
}
} else if (error != nil) {
if ([error code] == -1009) {
//NSLog(@"No internet connection (not connected to internet), unable to track campaign");
} else if ([error code] == -1003) {
//NSLog(@"No internet connection (hostname not found), unable to track campaign");
} else if ([error code] == -1001) {
//NSLog(@"No internet connection (request timed out), unable to track campaign");
} else {
NSLog(@"ERROR: Connection error:%@", error);
}
} else {
NSLog(@"ERROR: response empty, error empty for NSURLConnection");
}
isCurrentlyTrackingCampaign = NO;
}];
}
+ (NSDictionary*)getCampaignInformation
{
if (_apiKey == nil) {
NSLog(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling getCampaignInformation");
return [NSDictionary dictionary];
}
NSError *error = nil;
NSDictionary *result = [NSJSONSerialization JSONObjectWithData:[_campaignInformation dataUsingEncoding:NSUTF8StringEncoding] options:0 error:&error];
if (error != nil) {
NSLog(@"ERROR: Deserialization error:%@", error);
} else if (![result isKindOfClass:[NSDictionary class]]) {
NSLog(@"ERROR: JSON Dictionary not stored locally, invalid type:%@", [result class]);
return [NSDictionary dictionary];
}
return result;
}
+ (void)logEvent:(NSString*) eventType
{
if (![Amplitude isArgument:eventType validType:[NSString class] methodName:@"logEvent"]) {
return;
}
[Amplitude logEvent:eventType withCustomProperties:nil];
}
+ (void)logEvent:(NSString*) eventType withCustomProperties:(NSDictionary*) customProperties
{
if (![Amplitude isArgument:eventType validType:[NSString class] methodName:@"logEvent:withCustomProperties:"]) {
return;
}
if (customProperties != nil && ![Amplitude isArgument:customProperties validType:[NSDictionary class] methodName:@"logEvent:withCustomProperties:"]) {
return;
}
[Amplitude logEvent:eventType withCustomProperties:customProperties apiProperties:nil];
}
+ (void)logEvent:(NSString*) eventType withCustomProperties:(NSDictionary*) customProperties apiProperties:(NSDictionary*) apiProperties
{
if (_apiKey == nil) {
NSLog(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling logEvent:");
return;
}
NSNumber *timestamp = [NSNumber numberWithLongLong:[[NSDate date] timeIntervalSince1970] * 1000];
[backgroundQueue addOperationWithBlock:^{
NSMutableDictionary *event = [NSMutableDictionary dictionary];
@synchronized (eventsData) {
// Increment propertyList max_id and save immediately
NSNumber *propertyListMaxId = [NSNumber numberWithLongLong:[[propertyList objectForKey:@"max_id"] longLongValue] + 1];
[propertyList setObject: propertyListMaxId forKey:@"max_id"];
[Amplitude savePropertyList];
// Increment eventsData max_id
long long newId = [[eventsData objectForKey:@"max_id"] longLongValue] + 1;
[event setValue:[Amplitude replaceWithJSONNull:eventType] forKey:@"event_type"];
[event setValue:[NSNumber numberWithLongLong:newId] forKey:@"event_id"];
[event setValue:[Amplitude replaceWithEmptyJSON:customProperties] forKey:@"custom_properties"];
[event setValue:[Amplitude replaceWithEmptyJSON:apiProperties] forKey:@"properties"];
[event setValue:[Amplitude replaceWithEmptyJSON:apiProperties] forKey:@"api_properties"];
[event setValue:[Amplitude replaceWithEmptyJSON:_globalProperties] forKey:@"global_properties"];
[Amplitude addBoilerplate:event timestamp:timestamp maxIdCheck:propertyListMaxId];
[[eventsData objectForKey:@"events"] addObject:event];
[eventsData setObject:[NSNumber numberWithLongLong:newId] forKey:@"max_id"];
if ([[eventsData objectForKey:@"events"] count] >= 1020) {
// Delete old events if list starting to become too large to comfortably work with in memory
[[eventsData objectForKey:@"events"] removeObjectsInRange:NSMakeRange(0, 20)];
[Amplitude saveEventsData];
} else if ([[eventsData objectForKey:@"events"] count] >= 20 && [[eventsData objectForKey:@"events"] count] % 20 == 0) {
[Amplitude saveEventsData];
}
if ([[eventsData objectForKey:@"events"] count] >= 30) {
[Amplitude uploadEvents];
} else {
[Amplitude uploadEventsLater];
}
}
}];
}
+ (void)addBoilerplate:(NSMutableDictionary*) event timestamp:(NSNumber*) timestamp maxIdCheck:(NSNumber*) propertyListMaxId
{
[event setValue:timestamp forKey:@"timestamp"];
[event setValue:(_userId != nil ?
[Amplitude replaceWithJSONNull:_userId] :
[Amplitude replaceWithJSONNull:_deviceId]) forKey:@"user_id"];
[event setValue:[Amplitude replaceWithJSONNull:_deviceId] forKey:@"device_id"];
[event setValue:[NSNumber numberWithLongLong:_sessionId] forKey:@"session_id"];
[event setValue:[Amplitude replaceWithJSONNull:_versionName] forKey:@"version_name"];
[event setValue:[Amplitude replaceWithJSONNull:_buildVersionRelease] forKey:@"build_version_release"];
[event setValue:[Amplitude replaceWithJSONNull:_platformString] forKey:@"platform_string"];
[event setValue:[Amplitude replaceWithJSONNull:_phoneModel] forKey:@"phone_model"];
[event setValue:[Amplitude replaceWithJSONNull:_phoneCarrier] forKey:@"phone_carrier"];
[event setValue:[Amplitude replaceWithJSONNull:_country] forKey:@"country"];
[event setValue:[Amplitude replaceWithJSONNull:_language] forKey:@"language"];
[event setValue:@"ios" forKey:@"client"];
NSMutableDictionary *apiProperties = [event valueForKey:@"api_properties"];
[apiProperties setValue:[Amplitude replaceWithJSONNull:propertyListMaxId] forKey:@"max_id"];
if (lastKnownLocation != nil) {
@synchronized (locationManager) {
NSMutableDictionary *location = [NSMutableDictionary dictionary];
// Need to use NSInvocation because coordinate selector returns a C struct
SEL coordinateSelector = NSSelectorFromString(@"coordinate");
NSMethodSignature *coordinateMethodSignature = [lastKnownLocation methodSignatureForSelector:coordinateSelector];
NSInvocation *coordinateInvocation = [NSInvocation invocationWithMethodSignature:coordinateMethodSignature];
[coordinateInvocation setTarget:lastKnownLocation];
[coordinateInvocation setSelector:coordinateSelector];
[coordinateInvocation invoke];
CLLocationCoordinate2D lastKnownLocationCoordinate;
[coordinateInvocation getReturnValue:&lastKnownLocationCoordinate];
[location setValue:[Amplitude replaceWithJSONNull:[NSNumber numberWithDouble:lastKnownLocationCoordinate.latitude]] forKey:@"lat"];
[location setValue:[Amplitude replaceWithJSONNull:[NSNumber numberWithDouble:lastKnownLocationCoordinate.longitude]] forKey:@"lng"];
[apiProperties setValue:location forKey:@"location"];
}
}
if (sessionStarted) {
[Amplitude refreshSessionTime:timestamp];
}
}
+ (void)uploadEventsLater
{
if (!updateScheduled) {
updateScheduled = YES;
[mainQueue addOperationWithBlock:^{
[[Amplitude class] performSelector:@selector(uploadEventsLaterExecute) withObject:[Amplitude class] afterDelay:30];
}];
}
}
+ (void)uploadEventsLaterExecute
{
updateScheduled = NO;
[backgroundQueue addOperationWithBlock:^{
[Amplitude uploadEvents];
}];
}
+ (void)uploadEvents
{
[Amplitude uploadEventsLimit:YES];
}
+ (void)uploadEventsLimit:(bool) limit
{
if (_apiKey == nil) {
NSLog(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling uploadEvents:");
return;
}
@synchronized ([Amplitude class]) {
if (updatingCurrently) {
return;
}
updatingCurrently = YES;
}
[backgroundQueue addOperationWithBlock:^{
@synchronized (eventsData) {
NSMutableArray *events = [eventsData objectForKey:@"events"];
long long numEvents = limit ? fminl([events count], 100) : [events count];
if (numEvents == 0) {
updatingCurrently = NO;
return;
}
NSArray *uploadEvents = [events subarrayWithRange:NSMakeRange(0, numEvents)];
long long lastEventIDUploaded = [[[uploadEvents lastObject] objectForKey:@"event_id"] longLongValue];
NSError *error = nil;
NSData *eventsDataLocal = [NSJSONSerialization dataWithJSONObject:uploadEvents options:0 error:&error];
if (error != nil) {
NSLog(@"ERROR: NSJSONSerialization error: %@", error);
updatingCurrently = NO;
return;
}
NSString *eventsString = SAFE_ARC_AUTORELEASE([[NSString alloc] initWithData:eventsDataLocal encoding:NSUTF8StringEncoding]);
[Amplitude makeEventUploadPostRequest:@"https://api.amplitude.com/" events:eventsString lastEventIDUploaded:lastEventIDUploaded];
}
}];
}
+ (void)makeEventUploadPostRequest:(NSString*) url events:(NSString*) events lastEventIDUploaded:(long long) lastEventIDUploaded
{
NSMutableURLRequest *request =[NSMutableURLRequest requestWithURL:[NSURL URLWithString:url]];
[request setTimeoutInterval:60.0];
NSString *apiVersionString = [[NSNumber numberWithInt:apiVersion] stringValue];
NSMutableData *postData = [[NSMutableData alloc] init];
[postData appendData:[@"v=" dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[apiVersionString dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[@"&client=" dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[_apiKey dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[@"&e=" dataUsingEncoding:NSUTF8StringEncoding]];
[postData appendData:[[Amplitude urlEncodeString:events] dataUsingEncoding:NSUTF8StringEncoding]];
// Add timestamp of upload
[postData appendData:[@"&upload_time=" dataUsingEncoding:NSUTF8StringEncoding]];
NSString *timestampString = [[NSNumber numberWithLongLong:[[NSDate date] timeIntervalSince1970] * 1000] stringValue];
[postData appendData:[timestampString dataUsingEncoding:NSUTF8StringEncoding]];
// Add checksum
[postData appendData:[@"&checksum=" dataUsingEncoding:NSUTF8StringEncoding]];
NSString *checksumData = [NSString stringWithFormat: @"%@%@%@%@", apiVersionString, _apiKey, events, timestampString];
NSString *checksum = [Amplitude md5HexDigest: checksumData];
[postData appendData:[checksum dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPMethod:@"POST"];
[request setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
[request setValue:[NSString stringWithFormat:@"%d", [postData length]] forHTTPHeaderField:@"Content-Length"];
[request setHTTPBody:postData];
SAFE_ARC_RELEASE(postData);
[NSURLConnection sendAsynchronousRequest:request queue:backgroundQueue completionHandler:^(NSURLResponse *response, NSData *data, NSError *error)
{
bool uploadSuccessful = NO;
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse*)response;
if (response != nil) {
if ([httpResponse statusCode] == 200) {
NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
if ([result isEqualToString:@"success"]) {
// success, remove existing events from dictionary
uploadSuccessful = YES;
@synchronized (eventsData) {
long long numberToRemove = 0;
long long i = 0;
for (id event in [eventsData objectForKey:@"events"]) {
i++;
if ([[event objectForKey:@"event_id"] longLongValue] == lastEventIDUploaded) {
numberToRemove = i;
break;
}
}
[[eventsData objectForKey:@"events"] removeObjectsInRange:NSMakeRange(0, numberToRemove)];
[Amplitude saveEventsData];
}
} else if ([result isEqualToString:@"invalid_api_key"]) {
NSLog(@"ERROR: Invalid API Key, make sure your API key is correct in initializeApiKey:");
} else if ([result isEqualToString:@"bad_checksum"]) {
NSLog(@"ERROR: Bad checksum, post request was mangled in transit, will attempt to reupload later");
} else if ([result isEqualToString:@"request_db_write_failed"]) {
NSLog(@"ERROR: Couldn't write to request database on server, will attempt to reupload later");
} else {
NSLog(@"ERROR: %@, will attempt to reupload later", result);
}
SAFE_ARC_RELEASE(result);
} else {
NSLog(@"ERROR: Connection response received:%d, %@", [httpResponse statusCode],
SAFE_ARC_AUTORELEASE([[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]));
}
} else if (error != nil) {
if ([error code] == -1009) {
//NSLog(@"No internet connection (not connected to internet), unable to upload events");
} else if ([error code] == -1003) {
//NSLog(@"No internet connection (hostname not found), unable to upload events");
} else if ([error code] == -1001) {
//NSLog(@"No internet connection (request timed out), unable to upload events");
} else {
NSLog(@"ERROR: Connection error:%@", error);
}
} else {
NSLog(@"ERROR: response empty, error empty for NSURLConnection");
}
updatingCurrently = NO;
if (uploadSuccessful && [[eventsData objectForKey:@"events"] count] > 0) {
[Amplitude uploadEventsLimit:NO];
} else if (uploadTaskID != UIBackgroundTaskInvalid) {
// Upload finished, allow background task to be ended
[[UIApplication sharedApplication] endBackgroundTask:uploadTaskID];
uploadTaskID = UIBackgroundTaskInvalid;
}
}];
}
+ (NSString*)urlEncodeString:(NSString*) string
{
NSString *newString;
#if __has_feature(objc_arc)
newString = (__bridge_transfer NSString*)
CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault,
(__bridge CFStringRef)string,
NULL,
CFSTR(":/?#[]@!$ &'()*+,;=\"<>%{}|\\^~`"),
CFStringConvertNSStringEncodingToEncoding(NSUTF8StringEncoding));
#else
newString = NSMakeCollectable(CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault,
(CFStringRef)string,
NULL,
CFSTR(":/?#[]@!$ &'()*+,;=\"<>%{}|\\^~`"),
CFStringConvertNSStringEncodingToEncoding(NSUTF8StringEncoding)));
SAFE_ARC_AUTORELEASE(newString);
#endif
if (newString) {
return newString;
}
return @"";
}
+ (void)enterForeground
{
[Amplitude updateLocation];
[Amplitude startSession];
[backgroundQueue addOperationWithBlock:^{
[Amplitude uploadEvents];
}];
}
+ (void)enterBackground
{
uploadTaskID = [[UIApplication sharedApplication] beginBackgroundTaskWithExpirationHandler:^{
//Took too long, manually stop
[[UIApplication sharedApplication] endBackgroundTask:uploadTaskID];
uploadTaskID = UIBackgroundTaskInvalid;
}];
[Amplitude endSession];
[backgroundQueue addOperationWithBlock:^{
[Amplitude saveEventsData];
[Amplitude uploadEventsLimit:NO];
}];
}
+ (void)startSession
{
NSNumber *now = [NSNumber numberWithLongLong:[[NSDate date] timeIntervalSince1970] * 1000];
[mainQueue addOperationWithBlock:^{
// Remove turn off session later callback
[NSObject cancelPreviousPerformRequestsWithTarget:[Amplitude class]
selector:@selector(turnOffSessionLaterExecute)
object:[Amplitude class]];
}];
if (!sessionStarted) {
[backgroundQueue addOperationWithBlock:^{
@synchronized (eventsData) {
// Session has not been started yet, check overlap with previous session
NSNumber *previousSessionTime = [eventsData objectForKey:@"previous_session_time"];
if ([now longLongValue] - [previousSessionTime longLongValue] < 10000) {
_sessionId = [[eventsData objectForKey:@"previous_session_id"] longLongValue];
} else {
_sessionId = [now longLongValue];
[eventsData setValue:[NSNumber numberWithLongLong:_sessionId] forKey:@"previous_session_id"];
}
}
sessionStarted = YES;
}];
}
NSMutableDictionary *apiProperties = [NSMutableDictionary dictionary];
[apiProperties setValue:@"session_start" forKey:@"special"];
[Amplitude logEvent:@"session_start" withCustomProperties:nil apiProperties:apiProperties];
}
+ (void)endSession
{
NSDictionary *apiProperties = [NSMutableDictionary dictionary];
[apiProperties setValue:@"session_end" forKey:@"special"];
[Amplitude logEvent:@"session_end" withCustomProperties:nil apiProperties:apiProperties];
[backgroundQueue addOperationWithBlock:^{
sessionStarted = NO;
}];
[mainQueue addOperationWithBlock:^{
[[Amplitude class] performSelector:@selector(turnOffSessionLaterExecute) withObject:[Amplitude class] afterDelay:10];
}];
}
// amount is a double in units of dollars
// ex. $3.99 would be passed as [NSNumber numberWithDouble:3.99]
+ (void)logRevenue:(NSNumber*) amount
{
if (_apiKey == nil) {
NSLog(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling logRevenue:");
return;
}
if (![Amplitude isArgument:amount validType:[NSNumber class] methodName:@"logRevenue:"]) {
return;
}
NSDictionary *apiProperties = [NSMutableDictionary dictionary];
[apiProperties setValue:@"revenue_amount" forKey:@"special"];
[apiProperties setValue:amount forKey:@"revenue"];
[Amplitude logEvent:@"revenue_amount" withCustomProperties:nil apiProperties:apiProperties];
}
+ (void)refreshSessionTime:(NSNumber*) timestamp
{
@synchronized (eventsData) {
[eventsData setValue:timestamp forKey:@"previous_session_time"];
}
}
+ (void)turnOffSessionLaterExecute
{
if (!sessionStarted) {
_sessionId = -1;
}
}
+ (void)setGlobalUserProperties:(NSDictionary*) globalProperties
{
if (![Amplitude isArgument:globalProperties validType:[NSDictionary class] methodName:@"setGlobalUserProperties:"]) {
return;
}
(void) SAFE_ARC_RETAIN(globalProperties);
SAFE_ARC_RELEASE(_globalProperties);
_globalProperties = globalProperties;
}
+ (void)setUserId:(NSString*) userId
{
if (![Amplitude isArgument:userId validType:[NSString class] methodName:@"setUserId:"]) {
return;
}
[backgroundQueue addOperationWithBlock:^{
(void) SAFE_ARC_RETAIN(userId);
SAFE_ARC_RELEASE(_userId);
_userId = userId;
@synchronized (eventsData) {
[eventsData setObject:_userId forKey:@"user_id"];
}
}];
}
+ (void)updateLocation
{
if (locationListeningEnabled) {
CLLocation *location = [locationManager location];
@synchronized (locationManager) {
if (location != nil) {
(void) SAFE_ARC_RETAIN(location);
SAFE_ARC_RELEASE(lastKnownLocation);
lastKnownLocation = location;
}
}
}
}
+ (void)enableLocationListening
{
locationListeningEnabled = YES;
[Amplitude updateLocation];
}
+ (void)disableLocationListening
{
locationListeningEnabled = NO;
}
+ (void)savePropertyList
{
@synchronized (propertyList) {
NSError *error = nil;
NSData *propertyListData = [NSPropertyListSerialization
dataWithPropertyList:propertyList
format:NSPropertyListXMLFormat_v1_0
options:0 error:&error];
if (error == nil) {
if (propertyListData != nil) {
bool success = [propertyListData writeToFile:propertyListPath atomically:YES];
if (!success) {
NSLog(@"ERROR: Unable to save propertyList to file");
}
} else {
NSLog(@"ERROR: propertyListData is nil");
}
} else {
NSLog(@"ERROR: Unable to serialize propertyList:%@", error);
}
}
}
+ (void)saveEventsData
{
@synchronized (eventsData) {
bool success = [NSKeyedArchiver archiveRootObject:eventsData toFile:eventsDataPath];
if (!success) {
NSLog(@"ERROR: Unable to save eventsData to file");
}
}
}
+ (NSString*)getDeviceId
{
// On iOS 7+, return advertiser ID
if ([[[UIDevice currentDevice] systemVersion] floatValue] >= (float) 7.0) {
NSString *advertiserId = [Amplitude getAdvertiserID:0];
if (advertiserId != nil && ![advertiserId isEqualToString:@"00000000-0000-0000-0000-000000000000"]) {
return advertiserId;
}
}
// On iOS 6 and below, md5 hash of the mac address
NSString *macAddress = [Amplitude getMacAddress];
if (macAddress != nil && ![macAddress isEqualToString:@"020000000000"]) {
return [Amplitude md5HexDigest:macAddress];
}
NSString *randomId = [Amplitude generateRandomId];
return randomId;
}
+ (NSString*)getAdvertiserID:(int) timesCalled
{
Class ASIdentifierManager = NSClassFromString(@"ASIdentifierManager");
SEL sharedManager = NSSelectorFromString(@"sharedManager");
SEL advertisingIdentifier = NSSelectorFromString(@"advertisingIdentifier");
SEL UUIDString = NSSelectorFromString(@"UUIDString");
if (ASIdentifierManager && sharedManager && advertisingIdentifier && UUIDString) {
NSString *identifier = [[[ASIdentifierManager performSelector: sharedManager] performSelector: advertisingIdentifier] performSelector: UUIDString];
if (identifier == nil && timesCalled < 5) {
// Try again every 5 seconds
[NSThread sleepForTimeInterval:5.0];
return [Amplitude getAdvertiserID:timesCalled + 1];
} else {
return identifier;
}
} else {
return nil;
}
}
+ (NSString*)generateRandomId
{
CFUUIDRef uuid = CFUUIDCreate(kCFAllocatorDefault);
#if __has_feature(objc_arc)
NSString *uuidStr = (__bridge_transfer NSString *)CFUUIDCreateString(kCFAllocatorDefault, uuid);
#else
NSString *uuidStr = (NSString *) CFUUIDCreateString(kCFAllocatorDefault, uuid);
#endif
CFRelease(uuid);
// Add "R" at the end of the ID to distinguish it from advertiserId
return [uuidStr stringByAppendingString:@"R"];
}
+ (id)replaceWithJSONNull:(id) obj
{
return obj == nil ? [NSNull null] : obj;
}
+ (NSDictionary*)replaceWithEmptyJSON:(NSDictionary*) dictionary
{
return dictionary == nil ? [NSMutableDictionary dictionary] : dictionary;
}
+ (bool)isArgument:(id) argument validType:(Class) class methodName:(NSString*) methodName
{
if ([argument isKindOfClass:class]) {
return YES;
} else {
NSLog(@"ERROR: Invalid type argument to method %@, expected %@, recieved %@, ", methodName, class, [argument class]);
return NO;
}
}
+ (NSString*)getMacAddress
{
int mgmtInfoBase[6];
char *msgBuffer = NULL;
size_t length;
unsigned char macAddress[6];
struct if_msghdr *interfaceMsgStruct;
struct sockaddr_dl *socketStruct;
NSString *errorFlag = NULL;
bool msgBufferAllocated = false;
// Setup the management Information Base (mib)
mgmtInfoBase[0] = CTL_NET; // Request network subsystem
mgmtInfoBase[1] = AF_ROUTE; // Routing table info
mgmtInfoBase[2] = 0;
mgmtInfoBase[3] = AF_LINK; // Request link layer information
mgmtInfoBase[4] = NET_RT_IFLIST; // Request all configured interfaces