-
Notifications
You must be signed in to change notification settings - Fork 45
/
Copy pathHWIFileDownloader.m
1503 lines (1323 loc) · 70.7 KB
/
HWIFileDownloader.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
/*
* Project: HWIFileDownload
* File: HWIFileDownloader.m
*
*/
/***************************************************************************
Copyright (c) 2014-2018 Heiko Wichmann
https://github.com/Heikowi/HWIFileDownload
This software is provided 'as-is', without any expressed or implied warranty.
In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented;
you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment
in the product documentation would be appreciated
but is not required.
2. Altered source versions must be plainly marked as such,
and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
***************************************************************************/
#import "HWIFileDownloader.h"
#import "HWIFileDownloadItem.h"
@interface HWIFileDownloader()<NSURLSessionDelegate, NSURLSessionTaskDelegate, NSURLSessionDataDelegate, NSURLSessionDownloadDelegate, NSURLConnectionDelegate>
@property (nonatomic, copy, nonnull) NSString *backgroundSessionIdentifier;
@property (nonatomic, strong, nullable) NSURLSession *backgroundSession;
@property (nonatomic, strong, nonnull) NSMutableDictionary<NSNumber *, HWIFileDownloadItem *> *activeDownloadsDictionary;
@property (nonatomic, strong, nonnull) NSMutableArray<NSDictionary <NSString *, NSObject *> *> *waitingDownloadsArray;
@property (nonatomic, weak, nullable) NSObject<HWIFileDownloadDelegate>* fileDownloadDelegate;
@property (nonatomic, copy, nullable) HWIBackgroundSessionCompletionHandlerBlock bgSessionCompletionHandlerBlock;
@property (nonatomic, assign) NSInteger maxConcurrentFileDownloadsCount;
@property (nonatomic, assign) NSUInteger highestDownloadID;
@property (nonatomic, strong, nullable) dispatch_queue_t downloadFileSerialWriterDispatchQueue;
@end
@implementation HWIFileDownloader
#pragma mark - Initialization
- (nonnull instancetype)initWithDelegate:(nonnull NSObject<HWIFileDownloadDelegate>*)aDelegate
{
return [self initWithDelegate:aDelegate maxConcurrentDownloads:-1];
}
- (nonnull instancetype)initWithDelegate:(nonnull NSObject<HWIFileDownloadDelegate>*)aDelegate maxConcurrentDownloads:(NSInteger)aMaxConcurrentFileDownloadsCount
{
NSString *aBackgroundDownloadSessionIdentifier = [NSString stringWithFormat:@"%@.HWIFileDownload.%@", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleIdentifier"], [NSUUID new].UUIDString];
return [self initWithDelegate:aDelegate maxConcurrentDownloads:aMaxConcurrentFileDownloadsCount backgroundSessionIdentifier:aBackgroundDownloadSessionIdentifier];
}
- (nonnull instancetype)initWithDelegate:(nonnull NSObject<HWIFileDownloadDelegate>*)aDelegate maxConcurrentDownloads:(NSInteger)aMaxConcurrentFileDownloadsCount backgroundSessionIdentifier:(nonnull NSString *)aBackgroundSessionIdentifier
{
self = [super init];
if (self)
{
self.backgroundSessionIdentifier = aBackgroundSessionIdentifier;
self.maxConcurrentFileDownloadsCount = -1;
if (aMaxConcurrentFileDownloadsCount > 0)
{
self.maxConcurrentFileDownloadsCount = aMaxConcurrentFileDownloadsCount;
}
self.fileDownloadDelegate = aDelegate;
self.activeDownloadsDictionary = [NSMutableDictionary dictionary];
self.waitingDownloadsArray = [NSMutableArray array];
self.highestDownloadID = 0;
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_6_1)
{
NSURLSessionConfiguration *aBackgroundSessionConfiguration = nil;
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_7_1)
{
aBackgroundSessionConfiguration = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier:self.backgroundSessionIdentifier];
}
else
{
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
aBackgroundSessionConfiguration = [NSURLSessionConfiguration backgroundSessionConfiguration:self.backgroundSessionIdentifier];
#pragma GCC diagnostic pop
}
if ([self.fileDownloadDelegate respondsToSelector:@selector(customizeBackgroundSessionConfiguration:)])
{
[self.fileDownloadDelegate customizeBackgroundSessionConfiguration:aBackgroundSessionConfiguration];
}
self.backgroundSession = [NSURLSession sessionWithConfiguration:aBackgroundSessionConfiguration
delegate:self
delegateQueue:[NSOperationQueue mainQueue]];
}
else
{
self.downloadFileSerialWriterDispatchQueue = dispatch_queue_create([[NSString stringWithFormat:@"%@.downloadFileWriter", [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleIdentifier"]] UTF8String], DISPATCH_QUEUE_SERIAL);
}
}
return self;
}
- (void)setupWithCompletionBlock:(nullable void (^)(void))aSetupCompletionBlock
{
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_6_1)
{
[self.backgroundSession getTasksWithCompletionHandler:^(NSArray * _Nonnull aDataTasksArray, NSArray * _Nonnull anUploadTasksArray, NSArray * _Nonnull aDownloadTasksArray) {
for (NSURLSessionDownloadTask *aDownloadTask in aDownloadTasksArray)
{
NSString *aDownloadToken = [aDownloadTask.taskDescription copy];
if (aDownloadToken)
{
NSProgress *aRootProgress = nil;
if ([self.fileDownloadDelegate respondsToSelector:@selector(rootProgress)])
{
aRootProgress = [self.fileDownloadDelegate rootProgress];
}
aRootProgress.totalUnitCount++;
[aRootProgress becomeCurrentWithPendingUnitCount:1];
HWIFileDownloadItem *aDownloadItem = [[HWIFileDownloadItem alloc] initWithDownloadToken:aDownloadToken
sessionDownloadTask:aDownloadTask
urlConnection:nil];
[aRootProgress resignCurrent];
if (aDownloadItem)
{
[self.activeDownloadsDictionary setObject:aDownloadItem forKey:@(aDownloadTask.taskIdentifier)];
NSString *aDownloadToken = [aDownloadItem.downloadToken copy];
[aDownloadItem.progress setPausingHandler:^{
dispatch_async(dispatch_get_main_queue(), ^{
[self pauseDownloadWithIdentifier:aDownloadToken];
});
}];
[aDownloadItem.progress setCancellationHandler:^{
dispatch_async(dispatch_get_main_queue(), ^{
[self cancelDownloadWithIdentifier:aDownloadToken];
});
}];
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_8_4)
{
[aDownloadItem.progress setResumingHandler:^{
dispatch_async(dispatch_get_main_queue(), ^{
[self resumeDownloadWithIdentifier:aDownloadToken];
});
}];
}
}
[self.fileDownloadDelegate incrementNetworkActivityIndicatorActivityCount];
}
else
{
NSLog(@"ERR: Missing task description (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
if (aSetupCompletionBlock)
{
aSetupCompletionBlock();
}
}];
}
else
{
if (aSetupCompletionBlock)
{
aSetupCompletionBlock();
}
}
}
- (void)dealloc
{
[self.backgroundSession finishTasksAndInvalidate];
}
#pragma mark - Download Start
- (void)startDownloadWithIdentifier:(nonnull NSString *)aDownloadIdentifier
fromRemoteURL:(nonnull NSURL *)aRemoteURL
{
[self startDownloadWithDownloadToken:aDownloadIdentifier fromRemoteURL:aRemoteURL usingResumeData:nil];
}
- (void)startDownloadWithIdentifier:(nonnull NSString *)aDownloadIdentifier
usingResumeData:(nonnull NSData *)aResumeData
{
[self startDownloadWithDownloadToken:aDownloadIdentifier fromRemoteURL:nil usingResumeData:aResumeData];
}
- (void)startDownloadWithDownloadToken:(nonnull NSString *)aDownloadToken
fromRemoteURL:(nullable NSURL *)aRemoteURL
usingResumeData:(nullable NSData *)aResumeData
{
NSUInteger aDownloadID = 0;
if ((self.maxConcurrentFileDownloadsCount == -1) || ((NSInteger)self.activeDownloadsDictionary.count < self.maxConcurrentFileDownloadsCount))
{
NSURLSessionDownloadTask *aDownloadTask = nil;
NSURLConnection *aURLConnection = nil;
HWIFileDownloadItem *aDownloadItem = nil;
NSProgress *aRootProgress = nil;
if ([self.fileDownloadDelegate respondsToSelector:@selector(rootProgress)])
{
aRootProgress = [self.fileDownloadDelegate rootProgress];
}
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_6_1)
{
if (aResumeData)
{
aDownloadTask = [self.backgroundSession downloadTaskWithResumeData:aResumeData];
}
else if (aRemoteURL)
{
NSURLRequest *aURLRequest = nil;
if ([self.fileDownloadDelegate respondsToSelector:@selector(urlRequestForRemoteURL:)])
{
aURLRequest = [self.fileDownloadDelegate urlRequestForRemoteURL:aRemoteURL];
}
else
{
NSTimeInterval aRequestTimeoutInterval = 60.0; // iOS default value
aURLRequest = [[NSURLRequest alloc] initWithURL:aRemoteURL cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:aRequestTimeoutInterval];
}
if (aURLRequest)
{
aDownloadTask = [self.backgroundSession downloadTaskWithRequest:aURLRequest];
}
else
{
NSLog(@"ERR: No url request (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
aDownloadID = aDownloadTask.taskIdentifier;
aDownloadTask.taskDescription = aDownloadToken;
aRootProgress.totalUnitCount++;
[aRootProgress becomeCurrentWithPendingUnitCount:1];
aDownloadItem = [[HWIFileDownloadItem alloc] initWithDownloadToken:aDownloadToken
sessionDownloadTask:aDownloadTask
urlConnection:nil];
if (aResumeData)
{
aDownloadItem.resumedFileSizeInBytes = aResumeData.length;
aDownloadItem.downloadStartDate = [NSDate date];
aDownloadItem.bytesPerSecondSpeed = 0;
}
[aRootProgress resignCurrent];
}
else
{
if (aRemoteURL == nil)
{
NSLog(@"ERR: Missing remote url (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
else
{
aDownloadID = self.highestDownloadID++;
NSURLRequest *aURLRequest = nil;
if ([self.fileDownloadDelegate respondsToSelector:@selector(urlRequestForRemoteURL:)])
{
aURLRequest = [self.fileDownloadDelegate urlRequestForRemoteURL:aRemoteURL];
}
else
{
NSTimeInterval aRequestTimeoutInterval = 60.0; // iOS default value
aURLRequest = [[NSURLRequest alloc] initWithURL:aRemoteURL cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:aRequestTimeoutInterval];
}
if (aURLRequest)
{
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
aURLConnection = [[NSURLConnection alloc] initWithRequest:aURLRequest delegate:self startImmediately:NO];
#pragma GCC diagnostic pop
aRootProgress.totalUnitCount++;
[aRootProgress becomeCurrentWithPendingUnitCount:1];
aDownloadItem = [[HWIFileDownloadItem alloc] initWithDownloadToken:aDownloadToken
sessionDownloadTask:nil
urlConnection:aURLConnection];
[aRootProgress resignCurrent];
}
else
{
NSLog(@"ERR: No url request (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
}
if (aDownloadItem)
{
[self.activeDownloadsDictionary setObject:aDownloadItem forKey:@(aDownloadID)];
NSString *aDownloadToken = [aDownloadItem.downloadToken copy];
[aDownloadItem.progress setPausingHandler:^{
dispatch_async(dispatch_get_main_queue(), ^{
[self pauseDownloadWithIdentifier:aDownloadToken];
});
}];
[aDownloadItem.progress setCancellationHandler:^{
dispatch_async(dispatch_get_main_queue(), ^{
[self cancelDownloadWithIdentifier:aDownloadToken];
});
}];
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_8_4)
{
[aDownloadItem.progress setResumingHandler:^{
dispatch_async(dispatch_get_main_queue(), ^{
[self resumeDownloadWithIdentifier:aDownloadToken];
});
}];
}
[self.fileDownloadDelegate incrementNetworkActivityIndicatorActivityCount];
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_6_1)
{
[aDownloadTask resume];
}
else
{
[aURLConnection start];
}
}
else
{
NSLog(@"ERR: No download item (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
else
{
NSMutableDictionary *aWaitingDownloadDict = [NSMutableDictionary dictionary];
[aWaitingDownloadDict setObject:aDownloadToken forKey:@"downloadToken"];
if (aResumeData)
{
[aWaitingDownloadDict setObject:aResumeData forKey:@"resumeData"];
}
else if (aRemoteURL)
{
[aWaitingDownloadDict setObject:aRemoteURL forKey:@"remoteURL"];
}
[self.waitingDownloadsArray addObject:aWaitingDownloadDict];
}
}
- (void)resumeDownloadWithIdentifier:(nonnull NSString *)aDownloadIdentifier
{
BOOL isDownloading = [self isDownloadingIdentifier:aDownloadIdentifier];
if (isDownloading == NO)
{
if ([self.fileDownloadDelegate respondsToSelector:@selector(resumeDownloadWithIdentifier:)])
{
[self.fileDownloadDelegate resumeDownloadWithIdentifier:aDownloadIdentifier];
}
else
{
NSLog(@"ERR: Resume action called without implementation (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
}
#pragma mark - Download Stop
- (void)pauseDownloadWithIdentifier:(nonnull NSString *)aDownloadIdentifier
{
BOOL isDownloading = [self isDownloadingIdentifier:aDownloadIdentifier];
if (isDownloading)
{
[self pauseDownloadWithIdentifier:aDownloadIdentifier resumeDataBlock:^(NSData *aResumeData) {
if ([self.fileDownloadDelegate respondsToSelector:@selector(downloadPausedWithIdentifier:resumeData:)])
{
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_8_4)
{
// resume data is managed by the system and used when calling resume with NSProgress
aResumeData = nil;
}
[self.fileDownloadDelegate downloadPausedWithIdentifier:aDownloadIdentifier
resumeData:aResumeData];
}
}];
}
}
- (void)pauseDownloadWithIdentifier:(nonnull NSString *)aDownloadIdentifier resumeDataBlock:(nullable HWIFileDownloaderPauseResumeDataBlock)aResumeDataBlock
{
NSInteger aDownloadID = [self downloadIDForActiveDownloadToken:aDownloadIdentifier];
if (aDownloadID > -1)
{
[self pauseDownloadWithDownloadID:aDownloadID resumeDataBlock:aResumeDataBlock];
}
else
{
NSInteger aFoundIndex = -1;
for (NSUInteger anIndex = 0; anIndex < self.waitingDownloadsArray.count; anIndex++)
{
NSDictionary *aWaitingDownloadDict = self.waitingDownloadsArray[anIndex];
if ([aWaitingDownloadDict[@"downloadToken"] isEqualToString:aDownloadIdentifier])
{
aFoundIndex = anIndex;
break;
}
aFoundIndex++;
}
if (aFoundIndex > -1)
{
[self.waitingDownloadsArray removeObjectAtIndex:aFoundIndex];
}
}
}
- (void)pauseDownloadWithDownloadID:(NSUInteger)aDownloadID resumeDataBlock:(nullable HWIFileDownloaderPauseResumeDataBlock)aResumeDataBlock
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadID)];
if (aDownloadItem)
{
NSURLSessionDownloadTask *aDownloadTask = aDownloadItem.sessionDownloadTask;
if (aDownloadTask)
{
if (aResumeDataBlock)
{
[aDownloadTask cancelByProducingResumeData:^(NSData *aResumeData) {
aResumeDataBlock(aResumeData);
}];
}
else
{
[aDownloadTask cancel];
}
// NSURLSessionTaskDelegate method is called
// URLSession:task:didCompleteWithError:
}
else
{
NSLog(@"INFO: NSURLSessionDownloadTask cancelled (task not found): %@ (%@, %d)", aDownloadItem.downloadToken, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
NSError *aPauseError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:@{NSURLErrorFailingURLStringErrorKey: aDownloadTask.currentRequest.URL.absoluteString, NSURLErrorFailingURLErrorKey: aDownloadTask.currentRequest.URL}];
[self handleDownloadWithError:aPauseError downloadItem:aDownloadItem downloadID:aDownloadID resumeData:nil];
}
}
}
- (void)cancelDownloadWithIdentifier:(nonnull NSString *)aDownloadIdentifier
{
NSInteger aDownloadID = [self downloadIDForActiveDownloadToken:aDownloadIdentifier];
if (aDownloadID > -1)
{
[self cancelDownloadWithDownloadID:aDownloadID];
}
else
{
NSInteger aFoundIndex = -1;
for (NSUInteger anIndex = 0; anIndex < self.waitingDownloadsArray.count; anIndex++)
{
NSDictionary *aWaitingDownloadDict = self.waitingDownloadsArray[anIndex];
if ([aWaitingDownloadDict[@"downloadToken"] isEqualToString:aDownloadIdentifier])
{
aFoundIndex = anIndex;
break;
}
aFoundIndex++;
}
if (aFoundIndex > -1)
{
[self.waitingDownloadsArray removeObjectAtIndex:aFoundIndex];
NSError *aCancelledError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:nil];
[self.fileDownloadDelegate downloadFailedWithIdentifier:aDownloadIdentifier
error:aCancelledError
httpStatusCode:0
errorMessagesStack:nil
resumeData:nil];
[self startNextWaitingDownload];
}
}
}
- (void)cancelDownloadWithDownloadID:(NSUInteger)aDownloadID
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadID)];
if (aDownloadItem)
{
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_6_1)
{
NSURLSessionDownloadTask *aDownloadTask = aDownloadItem.sessionDownloadTask;
if (aDownloadTask)
{
[aDownloadTask cancel];
// NSURLSessionTaskDelegate method is called
// URLSession:task:didCompleteWithError:
}
else
{
NSLog(@"INFO: NSURLSessionDownloadTask cancelled (task not found): %@ (%@, %d)", aDownloadItem.downloadToken, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
NSError *aCancelError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:@{NSURLErrorFailingURLStringErrorKey: aDownloadTask.currentRequest.URL.absoluteString, NSURLErrorFailingURLErrorKey: aDownloadTask.currentRequest.URL}];
[self handleDownloadWithError:aCancelError downloadItem:aDownloadItem downloadID:aDownloadID resumeData:nil];
}
}
else
{
NSURLConnection *aDownloadURLConnection = aDownloadItem.urlConnection;
if (aDownloadURLConnection)
{
[self cancelURLConnection:aDownloadURLConnection downloadID:aDownloadID];
}
else
{
NSLog(@"INFO: NSURLConnection cancelled (connection not found): %@ (%@, %d)", aDownloadItem.downloadToken, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
NSError *aCancelError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:nil];
[self handleDownloadWithError:aCancelError downloadItem:aDownloadItem downloadID:aDownloadID resumeData:nil];
}
}
}
}
- (void)cancelURLConnection:(NSURLConnection *)aDownloadURLConnection downloadID:(NSUInteger)aDownloadID
{
[aDownloadURLConnection cancel];
// delegate method is not necessarily called
NSURL *aTempFileURL = [self tempLocalFileURLForDownloadFromURL:aDownloadURLConnection.originalRequest.URL];
__weak HWIFileDownloader *weakSelf = self;
dispatch_async(self.downloadFileSerialWriterDispatchQueue, ^{
HWIFileDownloader *strongSelf = weakSelf;
NSError *aRemoveError = nil;
[[NSFileManager defaultManager] removeItemAtURL:aTempFileURL error:&aRemoveError];
if (aRemoveError)
{
NSLog(@"ERR: Unable to remove file at %@: %@ (%@, %d)", aTempFileURL, aRemoveError.localizedDescription, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
__weak HWIFileDownloader *anotherWeakSelf = strongSelf;
dispatch_async(dispatch_get_main_queue(), ^{
HWIFileDownloader *anotherStrongSelf = anotherWeakSelf;
HWIFileDownloadItem *aFoundDownloadItem = [strongSelf.activeDownloadsDictionary objectForKey:@(aDownloadID)];
if (aFoundDownloadItem)
{
NSLog(@"INFO: NSURLConnection cancelled: %@", aFoundDownloadItem.downloadToken);
NSError *aCancelError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:nil];
[anotherStrongSelf handleDownloadWithError:aCancelError downloadItem:aFoundDownloadItem downloadID:aDownloadID resumeData:nil];
}
});
});
}
#pragma mark - Download Status
- (BOOL)isDownloadingIdentifier:(nonnull NSString *)aDownloadIdentifier
{
BOOL isDownloading = NO;
NSInteger aDownloadID = [self downloadIDForActiveDownloadToken:aDownloadIdentifier];
if (aDownloadID > -1)
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadID)];
if (aDownloadItem)
{
isDownloading = YES;
}
}
if (isDownloading == NO)
{
for (NSDictionary *aWaitingDownloadDict in self.waitingDownloadsArray)
{
if ([aWaitingDownloadDict[@"downloadToken"] isEqualToString:aDownloadIdentifier])
{
isDownloading = YES;
break;
}
}
}
return isDownloading;
}
- (BOOL)isWaitingForDownloadOfIdentifier:(nonnull NSString *)aDownloadIdentifier
{
BOOL isWaitingForDownload = NO;
for (NSDictionary *aWaitingDownloadDict in self.waitingDownloadsArray)
{
if ([aWaitingDownloadDict[@"downloadToken"] isEqualToString:aDownloadIdentifier])
{
isWaitingForDownload = YES;
break;
}
}
NSInteger aDownloadID = [self downloadIDForActiveDownloadToken:aDownloadIdentifier];
if (aDownloadID > -1)
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadID)];
if (aDownloadItem && (aDownloadItem.receivedFileSizeInBytes == 0))
{
isWaitingForDownload = YES;
}
}
return isWaitingForDownload;
}
- (BOOL)hasActiveDownloads
{
BOOL aHasActiveDownloadsFlag = NO;
if ((self.activeDownloadsDictionary.count > 0) || (self.waitingDownloadsArray.count > 0))
{
aHasActiveDownloadsFlag = YES;
}
return aHasActiveDownloadsFlag;
}
- (nonnull NSURL *)tempLocalFileURLForDownloadFromURL:(nonnull NSURL *)aRemoteURL
{
NSString *anOfflineDownloadDirectory = NSTemporaryDirectory();
anOfflineDownloadDirectory = [anOfflineDownloadDirectory stringByAppendingPathComponent:@"file-download"];
if ([[NSFileManager defaultManager] fileExistsAtPath:anOfflineDownloadDirectory] == NO)
{
[[NSFileManager defaultManager] createDirectoryAtPath:anOfflineDownloadDirectory withIntermediateDirectories:YES attributes:nil error:NULL];
}
NSURL *anOfflineDownloadDirectoryURL = [NSURL fileURLWithPath:anOfflineDownloadDirectory isDirectory:YES];
[anOfflineDownloadDirectoryURL setResourceValue:@YES forKey:NSURLIsExcludedFromBackupKey error:NULL];
NSString *aFilePathName = [anOfflineDownloadDirectory stringByAppendingPathComponent:[aRemoteURL lastPathComponent]];
NSURL *aLocalFileURL = [NSURL fileURLWithPath:aFilePathName isDirectory:NO];
return aLocalFileURL;
}
#pragma mark - BackgroundSessionCompletionHandler
- (void)setBackgroundSessionCompletionHandlerBlock:(nullable HWIBackgroundSessionCompletionHandlerBlock)aBackgroundSessionCompletionHandlerBlock
{
self.bgSessionCompletionHandlerBlock = aBackgroundSessionCompletionHandlerBlock;
}
#pragma mark - NSURLSession
#pragma mark - NSURLSessionDownloadDelegate
- (void)URLSession:(nonnull NSURLSession *)aSession downloadTask:(nonnull NSURLSessionDownloadTask *)aDownloadTask didFinishDownloadingToURL:(nonnull NSURL *)aDownloadURL
{
NSString *anErrorString = nil;
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadTask.taskIdentifier)];
if (aDownloadItem)
{
// move download item to final local location
NSURL *aLocalDestinationFileURL = nil;
if ([self.fileDownloadDelegate respondsToSelector:@selector(localFileURLForIdentifier:remoteURL:)])
{
NSURL *aRemoteURL = [[aDownloadTask.originalRequest URL] copy];
if (aRemoteURL)
{
aLocalDestinationFileURL = [self.fileDownloadDelegate localFileURLForIdentifier:aDownloadItem.downloadToken remoteURL:aRemoteURL];
}
else
{
anErrorString = [NSString stringWithFormat:@"ERR: Missing information: Remote URL (token: %@) (%@, %d)", aDownloadItem.downloadToken, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anErrorString);
}
}
else
{
aLocalDestinationFileURL = [HWIFileDownloader localFileURLForRemoteURL:aDownloadTask.originalRequest.URL];
}
if (aLocalDestinationFileURL)
{
if ([[NSFileManager defaultManager] fileExistsAtPath:aLocalDestinationFileURL.path] == YES)
{
NSError *aRemoveError = nil;
[[NSFileManager defaultManager] removeItemAtURL:aLocalDestinationFileURL error:&aRemoveError];
if (aRemoveError)
{
anErrorString = [NSString stringWithFormat:@"ERR: Error on removing file at %@: %@ (%@, %d)", aLocalDestinationFileURL, aRemoveError, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anErrorString);
}
}
NSError *anError = nil;
BOOL aSuccessFlag = [[NSFileManager defaultManager] moveItemAtURL:aDownloadURL toURL:aLocalDestinationFileURL error:&anError];
if (aSuccessFlag == NO)
{
NSError *aMoveError = anError;
if (aMoveError == nil)
{
aMoveError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorCannotMoveFile userInfo:nil];
}
anErrorString = [NSString stringWithFormat:@"ERR: Unable to move file from %@ to %@ (%@) (%@, %d)", aDownloadURL, aLocalDestinationFileURL, aMoveError.localizedDescription, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anErrorString);
}
else
{
NSError *anError = nil;
NSDictionary *aFileAttributesDictionary = [[NSFileManager defaultManager] attributesOfItemAtPath:aLocalDestinationFileURL.path error:&anError];
if (anError)
{
anErrorString = [NSString stringWithFormat:@"ERR: Error on getting file size for item at %@: %@ (%@, %d)", aLocalDestinationFileURL, anError.localizedDescription, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anErrorString);
}
else
{
unsigned long long aFileSize = [aFileAttributesDictionary fileSize];
if (aFileSize == 0)
{
NSError *aFileSizeZeroError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorZeroByteResource userInfo:nil];
anErrorString = [NSString stringWithFormat:@"ERR: Zero file size for item at %@: %@ (%@, %d)", aLocalDestinationFileURL, aFileSizeZeroError.localizedDescription, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anErrorString);
}
else
{
if ([self.fileDownloadDelegate respondsToSelector:@selector(downloadAtLocalFileURL:isValidForDownloadIdentifier:)])
{
BOOL anIsValidDownloadFlag = [self.fileDownloadDelegate downloadAtLocalFileURL:aLocalDestinationFileURL isValidForDownloadIdentifier:aDownloadItem.downloadToken];
if (anIsValidDownloadFlag == NO)
{
anErrorString = [NSString stringWithFormat:@"ERR: Download check failed for item at %@", aLocalDestinationFileURL];
NSLog(@"%@", anErrorString);
}
}
}
}
}
}
else
{
anErrorString = [NSString stringWithFormat:@"ERR: Missing information: Local file URL (token: %@) (%@, %d)", aDownloadItem.downloadToken, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anErrorString);
}
if (anErrorString)
{
NSMutableArray<NSString *> *anErrorMessagesStackArray = [aDownloadItem.errorMessagesStack mutableCopy];
if (anErrorMessagesStackArray == nil)
{
anErrorMessagesStackArray = [NSMutableArray array];
}
[anErrorMessagesStackArray insertObject:anErrorString atIndex:0];
[aDownloadItem setErrorMessagesStack:anErrorMessagesStackArray];
}
else
{
aDownloadItem.finalLocalFileURL = aLocalDestinationFileURL;
}
}
else
{
NSLog(@"ERR: Missing download item for taskIdentifier: %@ (%@, %d)", @(aDownloadTask.taskIdentifier), [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
- (void)URLSession:(nonnull NSURLSession *)aSession downloadTask:(nonnull NSURLSessionDownloadTask *)aDownloadTask didWriteData:(int64_t)aBytesWrittenCount totalBytesWritten:(int64_t)aTotalBytesWrittenCount totalBytesExpectedToWrite:(int64_t)aTotalBytesExpectedToWriteCount
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadTask.taskIdentifier)];
if (aDownloadItem)
{
if (aDownloadItem.downloadStartDate == nil)
{
aDownloadItem.downloadStartDate = [NSDate date];
}
aDownloadItem.receivedFileSizeInBytes = aTotalBytesWrittenCount;
aDownloadItem.expectedFileSizeInBytes = aTotalBytesExpectedToWriteCount;
if ([self.fileDownloadDelegate respondsToSelector:@selector(downloadProgressChangedForIdentifier:)])
{
NSString *aTaskDescription = [aDownloadTask.taskDescription copy];
if (aTaskDescription)
{
[self.fileDownloadDelegate downloadProgressChangedForIdentifier:aTaskDescription];
}
}
}
}
- (void)URLSession:(nonnull NSURLSession *)aSession downloadTask:(nonnull NSURLSessionDownloadTask *)aDownloadTask didResumeAtOffset:(int64_t)aFileOffset expectedTotalBytes:(int64_t)aTotalBytesExpectedCount
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadTask.taskIdentifier)];
if (aDownloadItem)
{
aDownloadItem.resumedFileSizeInBytes = aFileOffset;
aDownloadItem.downloadStartDate = [NSDate date];
aDownloadItem.bytesPerSecondSpeed = 0;
NSLog(@"INFO: Download (id: %@) resumed (offset: %@ bytes, expected: %@ bytes", aDownloadTask.taskDescription, @(aFileOffset), @(aTotalBytesExpectedCount));
}
}
#pragma mark - NSURLSessionTaskDelegate
- (void)URLSession:(nonnull NSURLSession *)aSession task:(nonnull NSURLSessionTask *)aDownloadTask didCompleteWithError:(nullable NSError *)anError
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:@(aDownloadTask.taskIdentifier)];
if (aDownloadItem)
{
NSHTTPURLResponse *aHttpResponse = (NSHTTPURLResponse *)aDownloadTask.response;
NSInteger aHttpStatusCode = aHttpResponse.statusCode;
aDownloadItem.lastHttpStatusCode = aHttpStatusCode;
if (anError == nil)
{
BOOL aHttpStatusCodeIsCorrectFlag = NO;
if ([self.fileDownloadDelegate respondsToSelector:@selector(httpStatusCode:isValidForDownloadIdentifier:)])
{
aHttpStatusCodeIsCorrectFlag = [self.fileDownloadDelegate httpStatusCode:aHttpStatusCode isValidForDownloadIdentifier:aDownloadItem.downloadToken];
}
else
{
aHttpStatusCodeIsCorrectFlag = [HWIFileDownloader httpStatusCode:aHttpStatusCode isValidForDownloadIdentifier:aDownloadItem.downloadToken];
}
if (aHttpStatusCodeIsCorrectFlag == YES)
{
NSURL *aFinalLocalFileURL = aDownloadItem.finalLocalFileURL;
if (aFinalLocalFileURL)
{
[self handleSuccessfulDownloadToLocalFileURL:aFinalLocalFileURL
downloadItem:aDownloadItem
downloadID:aDownloadTask.taskIdentifier];
}
else
{
NSError *aFinalError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorResourceUnavailable userInfo:nil];
[self handleDownloadWithError:aFinalError downloadItem:aDownloadItem downloadID:aDownloadTask.taskIdentifier resumeData:nil];
}
}
else
{
NSString *anErrorString = [NSString stringWithFormat:@"Invalid http status code: %@", @(aHttpStatusCode)];
NSMutableArray<NSString *> *anErrorMessagesStackArray = [aDownloadItem.errorMessagesStack mutableCopy];
if (anErrorMessagesStackArray == nil)
{
anErrorMessagesStackArray = [NSMutableArray array];
}
[anErrorMessagesStackArray insertObject:anErrorString atIndex:0];
[aDownloadItem setErrorMessagesStack:anErrorMessagesStackArray];
NSError *aFinalError = [[NSError alloc] initWithDomain:NSURLErrorDomain code:NSURLErrorBadServerResponse userInfo:@{NSURLErrorFailingURLStringErrorKey: aHttpResponse.URL.absoluteString, NSURLErrorFailingURLErrorKey: aHttpResponse.URL}];
[self handleDownloadWithError:aFinalError downloadItem:aDownloadItem downloadID:aDownloadTask.taskIdentifier resumeData:nil];
}
}
else
{
NSData *aSessionDownloadTaskResumeData = [anError.userInfo objectForKey:NSURLSessionDownloadTaskResumeData];
//NSString *aFailingURLStringErrorKeyString = [anError.userInfo objectForKey:NSURLErrorFailingURLStringErrorKey];
//NSNumber *aBackgroundTaskCancelledReasonKeyNumber = [anError.userInfo objectForKey:NSURLErrorBackgroundTaskCancelledReasonKey];
[self handleDownloadWithError:anError downloadItem:aDownloadItem downloadID:aDownloadTask.taskIdentifier resumeData:aSessionDownloadTaskResumeData];
}
}
else
{
NSLog(@"ERR: Download item not found for download task: %@ (%@, %d)", aDownloadTask, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
- (void)URLSession:(NSURLSession *)aSession
task:(NSURLSessionTask *)aTask
didReceiveChallenge:(NSURLAuthenticationChallenge *)aChallenge
completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))aCompletionHandler
{
if ([self.fileDownloadDelegate respondsToSelector:@selector(onAuthenticationChallenge:downloadIdentifier:completionHandler:)])
{
NSString *aDownloadToken = [aTask.taskDescription copy];
if (aDownloadToken)
{
[self.fileDownloadDelegate onAuthenticationChallenge:aChallenge
downloadIdentifier:aDownloadToken
completionHandler:^(NSURLCredential * _Nullable aCredential, NSURLSessionAuthChallengeDisposition aDisposition) {
aCompletionHandler(aDisposition, aCredential);
}];
}
else
{
NSLog(@"ERR: Missing task description (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
aCompletionHandler(NSURLSessionAuthChallengePerformDefaultHandling, nil);
}
}
else
{
NSLog(@"ERR: Received authentication challenge with no delegate method implemented (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
aCompletionHandler(NSURLSessionAuthChallengePerformDefaultHandling, nil);
}
}
#pragma mark - NSURLSessionDelegate
- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)aSession
{
if (self.bgSessionCompletionHandlerBlock)
{
void (^completionHandler)(void) = self.bgSessionCompletionHandlerBlock;
self.bgSessionCompletionHandlerBlock = nil;
completionHandler();
}
}
- (void)URLSession:(NSURLSession *)aSession didBecomeInvalidWithError:(nullable NSError *)anError
{
if (anError) {
NSLog(@"ERR: Session did become invalid with error: %@ (%@, %d)", anError, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
else {
NSLog(@"INFO: Session has been intentionally invalidated (%@, %d)", [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__);
}
}
#pragma mark - NSURLConnection
#pragma mark - NSURLConnectionDataDelegate
- (void)connectionDidFinishLoading:(nonnull NSURLConnection *)aConnection
{
NSNumber *aDownloadID = [self downloadIDForConnection:aConnection];
if (aDownloadID)
{
HWIFileDownloadItem *aDownloadItem = [self.activeDownloadsDictionary objectForKey:aDownloadID];
if (aDownloadItem)
{
NSURL *aLocalFileURL = nil;
if ([self.fileDownloadDelegate respondsToSelector:@selector(localFileURLForIdentifier:remoteURL:)])
{
aLocalFileURL = [self.fileDownloadDelegate localFileURLForIdentifier:aDownloadItem.downloadToken remoteURL:aConnection.originalRequest.URL];
}
else
{
aLocalFileURL = [HWIFileDownloader localFileURLForRemoteURL:aConnection.originalRequest.URL];
}
if (aLocalFileURL)
{
NSURL *aTempFileURL = [self tempLocalFileURLForDownloadFromURL:aConnection.originalRequest.URL];
__weak HWIFileDownloader *weakSelf = self;
dispatch_async(self.downloadFileSerialWriterDispatchQueue, ^{
HWIFileDownloader *strongSelf = weakSelf;
NSError *aMoveError = nil;
BOOL aMoveSuccessFlag = [[NSFileManager defaultManager] moveItemAtURL:aTempFileURL toURL:aLocalFileURL error:&aMoveError];
if (aMoveSuccessFlag == NO)
{
NSString *anUnableToMoveErrorString = [NSString stringWithFormat:@"ERR: Unable to move file from %@ to %@ (%@) (%@, %d)", aTempFileURL, aLocalFileURL, aMoveError.localizedDescription, [NSString stringWithUTF8String:__FILE__].lastPathComponent, __LINE__];
NSLog(@"%@", anUnableToMoveErrorString);
NSMutableArray<NSString *> *anErrorMessagesStackArray = [aDownloadItem.errorMessagesStack mutableCopy];
if (anErrorMessagesStackArray == nil)
{
anErrorMessagesStackArray = [NSMutableArray array];
}
[anErrorMessagesStackArray insertObject:anUnableToMoveErrorString atIndex:0];
[aDownloadItem setErrorMessagesStack:anErrorMessagesStackArray];
__weak HWIFileDownloader *anotherWeakSelf = strongSelf;
dispatch_async(dispatch_get_main_queue(), ^{
HWIFileDownloader *anotherStrongSelf = anotherWeakSelf;
if ([self isDownloadingIdentifier:aDownloadItem.downloadToken]) // check for meanwhile cancelled download
{
[anotherStrongSelf handleDownloadWithError:aMoveError downloadItem:aDownloadItem downloadID:[aDownloadID unsignedIntegerValue] resumeData:nil];
}
});
}
else
{
__weak HWIFileDownloader *anotherWeakSelf = strongSelf;
dispatch_async(dispatch_get_main_queue(), ^{
HWIFileDownloader *anotherStrongSelf = anotherWeakSelf;
if ([self isDownloadingIdentifier:aDownloadItem.downloadToken] == NO)
{