-
Notifications
You must be signed in to change notification settings - Fork 72
/
CKTransferRecord.m
753 lines (641 loc) · 19.9 KB
/
CKTransferRecord.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
/*
Copyright (c) 2006, Greg Hulands <ghulands@mac.com>
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
Neither the name of Greg Hulands nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "CKConnectionProtocol.h"
#import "CKTransferRecord.h"
#import "NSString+Connection.h"
NSString *CKTransferRecordProgressChangedNotification = @"CKTransferRecordProgressChangedNotification";
NSString *CKTransferRecordTransferDidBeginNotification = @"CKTransferRecordTransferDidBeginNotification";
NSString *CKTransferRecordTransferDidFinishNotification = @"CKTransferRecordTransferDidFinishNotification";
@implementation CKTransferRecord
- (BOOL)isUpload { return _isUpload; }
- (void)setUpload:(BOOL)flag { _isUpload = flag; }
- (NSString *)name { return _name; }
- (void)setName:(NSString *)name
{
if (_name != name)
{
[self willChangeValueForKey:@"name"];
name = [name copy];
[_name release];
_name = name;
[self didChangeValueForKey:@"name"];
}
}
- (NSError *)error { return _error; }
- (id <CKConnection>)connection { return _connection; }
- (void)setConnection:(id <CKConnection>)connection { _connection = connection; }
- (CKTransferRecord *)parent { return _parent; }
+ (id)recordWithName:(NSString *)name size:(unsigned long long)size
{
return [[[CKTransferRecord alloc] initWithName:name size:size] autorelease];
}
- (id)initWithName:(NSString *)name size:(unsigned long long)size
{
if ((self = [super init]))
{
_name = [name copy];
_size = size;
_contents = [[NSMutableArray array] retain];
_properties = [[NSMutableDictionary dictionary] retain];
_error = nil;
_progress = 0;
}
return self;
}
- (void)dealloc
{
[_name release];
[_contents makeObjectsPerformSelector:@selector(setParent:) withObject:nil];
[_contents release];
[_properties release];
[_error release];
[super dealloc];
}
- (void)cancel:(id)sender
{
if ([self connection])
{
[[self connection] cancelTransfer];
}
}
- (unsigned long long)size
{
//Have we already calculated our size with children?
if (_sizeWithChildren != 0)
return _sizeWithChildren;
//Calculate our size including our children
unsigned long long size = _size;
NSEnumerator *e = [[self contents] objectEnumerator];
CKTransferRecord *cur;
while ((cur = [e nextObject]))
{
if ([cur respondsToSelector:@selector(size)])
{
size += [cur size];
}
else
{
NSLog(@"CKTransferRecord content object does not have 'size'"); // work around bogus children?
}
}
_sizeWithChildren = size;
return size;
}
- (void)setSize:(unsigned long long)size
{
[self willChangeValueForKey:@"progress"];
if (_size != 0)
{
//We're updating our size. We need to update our parents' sizes too.
unsigned long long sizeDelta = size - _size;
[self _sizeWithChildrenChangedBy:sizeDelta];
}
_size = size;
[self didChangeValueForKey:@"progress"];
}
- (void)_sizeWithChildrenChangedBy:(unsigned long long)sizeDelta
{
_sizeWithChildren += sizeDelta;
if ([self parent])
[[self parent] _sizeWithChildrenChangedBy:sizeDelta];
}
- (unsigned long long)transferred
{
if ([self isDirectory])
{
unsigned long long rem = 0;
NSEnumerator *e = [[self contents] objectEnumerator];
CKTransferRecord *cur;
while ((cur = [e nextObject]))
{
rem += [cur transferred];
}
return rem;
}
if (_progress == -1) //if we have an error return it as if we transferred the lot of it
{
return _size;
}
return _transferred;
}
- (float)speed
{
if ([self isDirectory])
{
if (_transferStartTime == 0.0)
{
_transferStartTime = [NSDate timeIntervalSinceReferenceDate];
}
NSTimeInterval now = [NSDate timeIntervalSinceReferenceDate];
if (_lastDirectorySpeedUpdate == 0.0 || now - _lastDirectorySpeedUpdate >= 1.0)
{
_lastDirectorySpeedUpdate = now;
NSTimeInterval elapsedTime = now - _transferStartTime;
[self willChangeValueForKey:@"speed"];
if (elapsedTime == 0.0)
{
//If we don't catch this, we are effectively dividing by zero below. This would leave _speed as NaN.
_speed = 0.0;
}
else
{
unsigned long long transferred = [self transferred];
_speed = transferred / elapsedTime;
}
[self didChangeValueForKey:@"speed"];
}
}
return _speed;
}
- (void)setSpeed:(float)speed
{
if (speed != _speed)
{
[self willChangeValueForKey:@"speed"];
_speed = speed;
[self didChangeValueForKey:@"speed"];
}
}
- (void)forceAnimationUpdate
{
NSInteger i;
for (i = 1; i <= 4; i++)
{
[self willChangeValueForKey:@"progress"];
_progress = i * 25;
[self didChangeValueForKey:@"progress"];
[[NSNotificationCenter defaultCenter] postNotificationName:CKTransferRecordProgressChangedNotification
object:self];
}
}
- (void)setProgress:(NSInteger)progress
{
if (_progress != progress || progress == 100)
{
if (progress == 100 && _progress == 1)
{
[self forceAnimationUpdate];
return;
}
[self willChangeValueForKey:@"progress"];
_progress = progress;
[self didChangeValueForKey:@"progress"];
[[NSNotificationCenter defaultCenter] postNotificationName:CKTransferRecordProgressChangedNotification object:self];
}
}
- (NSInteger)progress
{
// Check if self of descendents have an error, so we can show that error.
if ([self hasError])
{
return -1;
}
if ([self isDirectory])
{
//get the real transfer progress of the whole directory
unsigned long long size = [self size];
unsigned long long transferred = [self transferred];
if (size == 0) size = 1;
NSInteger percent = (NSInteger)((transferred / (size * 1.0)) * 100);
return percent;
}
return _progress;
}
- (BOOL)problemsTransferringCountingErrors:(NSInteger *)outErrors successes:(NSInteger *)outSuccesses
{
if ([self isLeaf])
{
if (_error != nil)
{
(*outErrors)++;
}
else
{
(*outSuccesses)++;
}
}
else
{
// check children for errors
NSEnumerator *e = [[self contents] objectEnumerator];
CKTransferRecord *cur;
while ((cur = [e nextObject]))
{
(void) [cur problemsTransferringCountingErrors:outErrors successes:outSuccesses];
}
}
return (*outErrors > 0); // return if there were any problems
}
- (BOOL)hasError
{
return (_error != nil);
}
- (void)setError:(NSError *)error
{
if (error != _error)
{
[self willChangeValueForKey:@"progress"]; // we use this because we return -1 on an error
[_error autorelease];
_error = [error retain];
[self didChangeValueForKey:@"progress"];
[[NSNotificationCenter defaultCenter] postNotificationName:CKTransferRecordProgressChangedNotification object:self];
}
//Set the error on all parents, too.
if ([self parent])
[[self parent] setError:error];
}
- (void)setParent:(CKTransferRecord *)parent
{
_parent = parent;
if (_parent)
[_parent _sizeWithChildrenChangedBy:_size];
}
- (BOOL)isDirectory
{
return [_contents count] > 0;
}
- (void)willChangeValueForKey:(NSString *)key
{
//We override this because we need to call the same on the record's parents to update any bindings on them as well. This traverses all the way up the parental hierarchy.
[super willChangeValueForKey:key];
if ([self parent])
[[self parent] willChangeValueForKey:key];
}
- (void)didChangeValueForKey:(NSString *)key
{
//We override this because we need to call the same on the record's parents to update any bindings on them as well. This traverses all the way up the parental hierarchy.
[super didChangeValueForKey:key];
if ([self parent])
[[self parent] didChangeValueForKey:key];
}
- (CKTransferRecord *)root
{
if (_parent)
{
return [_parent root];
}
return self;
}
- (NSString *)path
{
if ([self parent])
{
return [[_parent path] stringByAppendingPathComponent:[self name]]; // Old code was @"%@/%@" but it broke if _parent was just /
}
else
{
return [self name];
}
}
- (void)addContent:(CKTransferRecord *)record
{
NSParameterAssert(record);
[self willChangeValueForKey:@"contents"];
[_contents addObject:record];
[record setParent:self];
[self didChangeValueForKey:@"contents"];
}
- (NSArray *)contents
{
return [[_contents copy] autorelease];
}
- (void)appendToDescription:(NSMutableString *)str indentation:(unsigned)indent
{
NSInteger i;
for (i = 0; i < indent; i++)
{
[str appendString:@"\t"];
}
[str appendFormat:@"\t%@", _name];
if ([self isDirectory])
{
[str appendString:@"/"];
}
[str appendFormat:@"\t(%lld of %lld bytes - %@%%)\n", [self transferred], [self size], [self progress]];
NSEnumerator *e = [[self contents] objectEnumerator];
CKTransferRecord *cur;
while ((cur = [e nextObject]))
{
[cur appendToDescription:str indentation:indent+1];
}
}
- (NSString *)description
{
NSMutableString *str = [NSMutableString stringWithString:@"\n"];
[self appendToDescription:str indentation:0];
return str;
}
- (void)setProperty:(id)property forKey:(NSString *)key
{
/// Terrence added this NSLog since the exception doesn't log the key
if ( nil == property )
{
NSLog(@"attempted to set nil property for key %@", key);
}
[_properties setObject:property forKey:key];
}
- (id)propertyForKey:(NSString *)key
{
return [_properties objectForKey:key];
}
// keep NSDictionary accessor compatible so we can move over internal use of this class
- (void)setObject:(id)object forKey:(id)key
{
[self setProperty:object forKey:key];
}
- (id)objectForKey:(id)key
{
return [self propertyForKey:key];
}
#pragma mark -
#pragma mark Connection Transfer Delegate
- (void)transferDidBegin:(CKTransferRecord *)transfer
{
_transferred = 0;
_intermediateTransferred = 0;
_lastTransferTime = [NSDate timeIntervalSinceReferenceDate];
[self setProgress:0];
[[NSNotificationCenter defaultCenter] postNotificationName:CKTransferRecordTransferDidBeginNotification object:self];
}
- (void)transfer:(CKTransferRecord *)transfer transferredDataOfLength:(unsigned long long)length
{
_transferred += length;
_intermediateTransferred += length;
NSTimeInterval now = [NSDate timeIntervalSinceReferenceDate];
NSTimeInterval difference = now - _lastTransferTime;
if (difference > 2.0 || _transferred == _size)
{
[self willChangeValueForKey:@"speed"];
if (_transferred == _size)
{
[self setSpeed:0.0];
}
else
{
[self setSpeed:((double)_intermediateTransferred) / difference];
}
_intermediateTransferred = 0;
_lastTransferTime = now;
[self didChangeValueForKey:@"speed"];
}
if ([self size]) [self setProgress:(100 * [self transferred] / [self size])];
}
- (void)transfer:(CKTransferRecord *)transfer progressedTo:(NSNumber *)percent
{
[self setProgress:[percent intValue]];
}
- (void)transfer:(CKTransferRecord *)transfer receivedError:(NSError *)error
{
//If we get _any_ error while we're uploading, we're "finished" albeit with an error. Handle it as such.
[self transferDidFinish:transfer error:error];
}
- (void)transferDidFinish:(CKTransferRecord *)transfer error:(NSError *)error
{
[self setError:error];
_intermediateTransferred = (_size - _transferred);
_transferred = _size;
_lastTransferTime = [NSDate timeIntervalSinceReferenceDate];
[self setProgress:100];
[[NSNotificationCenter defaultCenter] postNotificationName:CKTransferRecordTransferDidFinishNotification object:self];
//If parent is finished, they need notifications too.
CKTransferRecord *parent = [self parent];
if (parent && [parent transferred] == [parent size])
[parent transferDidFinish:parent error:error];
}
#pragma mark -
#pragma mark Recursive File Transfer Methods
+ (CKTransferRecord *)rootRecordWithPath:(NSString *)path
{
CKTransferRecord *result = [CKTransferRecord recordWithName:@"" size:0];
NSArray *pathComponents = [path pathComponents];
if ([pathComponents count] > 0)
{
[result setName:[[path pathComponents] objectAtIndex:0]]; // -firstPathComponent ignores the root dir for absolute paths
CKTransferRecord *thisNode, *subNode = result;
int i;
for (i = 1; i < [pathComponents count]; i++)
{
thisNode = [CKTransferRecord recordWithName:[pathComponents objectAtIndex:i] size:0];
[subNode addContent:thisNode];
subNode = thisNode;
}
}
return result;
}
+ (CKTransferRecord *)recursiveRecord:(CKTransferRecord *)record forFullPath:(NSString *)path
{
if ([[record name] isEqualToString:[path firstPathComponent]])
{
NSEnumerator *e = [[record contents] objectEnumerator];
CKTransferRecord *cur;
CKTransferRecord *child;
NSString *newPath = [path stringByDeletingFirstPathComponent2];
if ([newPath isEqualToString:@""]) return record; //we have our match
while ((cur = [e nextObject]))
{
child = [CKTransferRecord recursiveRecord:cur forFullPath:newPath];
if (child)
{
return child;
}
}
}
return nil;
}
+ (CKTransferRecord *)recordForFullPath:(NSString *)path withRoot:(CKTransferRecord *)root
{
return [self recursiveRecord:root forPath:path];
}
+ (CKTransferRecord *)recursiveRecord:(CKTransferRecord *)record forPath:(NSString *)path
{
NSArray *components = [path pathComponents];
if ([[record name] isEqualToString:[components objectAtIndex:0]])
{
NSString *newPath = [NSString pathWithComponents:
[components subarrayWithRange:NSMakeRange(1, [components count]-1)]];
if ([newPath isEqualToString:@""]) return record; // matched
for (CKTransferRecord *cur in [record contents])
{
CKTransferRecord *child = [CKTransferRecord recursiveRecord:cur forPath:newPath];
if (child)
{
return child;
}
}
}
return nil;
}
+ (CKTransferRecord *)recordForPath:(NSString *)path withRoot:(CKTransferRecord *)root
{
if ([path isEqualToString:@""])
return root;
NSEnumerator *e = [[root contents] objectEnumerator];
CKTransferRecord *cur;
CKTransferRecord *child;
while (cur = [e nextObject])
{
child = [self recursiveRecord:cur forPath:path];
if (child)
{
return child;
}
}
return nil;
}
+ (CKTransferRecord *)addFileRecord:(NSString *)file size:(unsigned long long)size withRoot:(CKTransferRecord *)root rootPath:(NSString *)rootPath
{
NSString *chompedStoragePath = [file substringFromIndex:[rootPath length]];
NSString *path = [chompedStoragePath stringByDeletingLastPathComponent];
NSString *filename = [file lastPathComponent];
NSEnumerator *pathCompEnum = [[path componentsSeparatedByString:@"/"] objectEnumerator];
NSString *builtupPath = [NSString stringWithString:@""];
NSString *cur;
CKTransferRecord *rec = nil, *lastRec = root;
while ((cur = [pathCompEnum nextObject]))
{
builtupPath = [builtupPath stringByAppendingPathComponent:cur];
rec = [CKTransferRecord recordForPath:builtupPath withRoot:root];
if (!rec)
{
//create a new record for the path
rec = [CKTransferRecord recordWithName:[builtupPath lastPathComponent] size:0];
if (lastRec == nil)
{
//we are at the root
[root addContent:rec];
} else
{
[lastRec addContent:rec];
}
}
lastRec = rec;
}
//last rec will be the directory to add the file name to
rec = [CKTransferRecord recordWithName:filename size:size];
[lastRec addContent:rec];
return rec;
}
+ (void)mergeRecord:(CKTransferRecord *)record withRoot:(CKTransferRecord *)root
{
CKTransferRecord *parent = [CKTransferRecord recordForPath:[[record name] stringByDeletingLastPathComponent]
withRoot:root];
[record setName:[[record name] lastPathComponent]];
[parent addContent:record];
}
+ (CKTransferRecord *)recursiveMergeRecordWithPath:(NSString *)path root:(CKTransferRecord *)root
{
NSString *first = [path firstPathComponent];
if ([[root name] isEqualToString:first])
{
CKTransferRecord *child = nil;
NSEnumerator *e = [[root contents] objectEnumerator];
CKTransferRecord *cur;
path = [path stringByDeletingFirstPathComponent];
if ([path isEqualToString:@"/"])
return root;
while ((cur = [e nextObject]))
{
child = [self recursiveMergeRecordWithPath:path root:cur];
if (child)
return child;
}
// if we get here we need to create the record
CKTransferRecord *tmp = root;
while (![path isEqualToString:@"/"])
{
cur = [CKTransferRecord recordWithName:[path firstPathComponent] size:0];
[tmp addContent:cur];
tmp = cur;
path = [path stringByDeletingFirstPathComponent];
}
return cur;
}
return nil;
}
+ (void)mergeTextPathRecord:(CKTransferRecord *)rec withRoot:(CKTransferRecord *)root
{
CKTransferRecord *parent = [CKTransferRecord recursiveMergeRecordWithPath:[[rec name] stringByDeletingLastPathComponent]
root:root];
[parent addContent:rec];
[rec setName:[[rec name] lastPathComponent]];
}
#pragma mark -
#pragma mark NSTreeController support
- (BOOL)isLeaf
{
return [_contents count] == 0;
}
- (NSDictionary *)nameWithProgress
{
NSNumber *progress = nil;
if ([self hasError])
{
progress = [NSNumber numberWithInt:-1];
}
else
{
progress = [NSNumber numberWithInt:[self progress]];
}
return [NSDictionary dictionaryWithObjectsAndKeys:progress, @"progress", [self name], @"name", nil];
}
+ (NSSet *)keyPathsForValuesAffectingNameWithProgress;
{
return [NSSet setWithObject:@"progress"];
}
- (void)setNameWithProgress:(id)notused
{
; // just for KVO bindings
}
/* The same as -nameWithProgress, but also includes the file size in brackets if appropriate
*/
- (NSDictionary *)nameWithProgressAndFileSize
{
NSDictionary *result = [self nameWithProgress];
// Directories should not display their size info
if (_size > 0 && [[self contents] count] == 0) // Use _size to ignore children's sizes
{
// Calculate the size of the transfer in a user-friendly manner
NSString *fileSize = [NSString formattedFileSize:(double)[self size]];
NSString *unattributedDescription = [[NSString alloc] initWithFormat:@"%@ (%@)", [self name], fileSize];
NSDictionary *attributes = [NSDictionary dictionaryWithObject:[NSFont systemFontOfSize:[NSFont systemFontSizeForControlSize:NSRegularControlSize]]
forKey:NSFontAttributeName];
NSMutableAttributedString *description = [[NSMutableAttributedString alloc] initWithString:unattributedDescription attributes:attributes];
[unattributedDescription release];
// Make the size info in grey
[description addAttribute:NSForegroundColorAttributeName
value:[NSColor grayColor]
range:NSMakeRange([[self name] length] + 1, [fileSize length] + 2)];
result = [NSDictionary dictionaryWithObjectsAndKeys:
[result objectForKey:@"progress"], @"progress",
description, @"name",
nil];
[description release];
}
return result;
}
+ (NSSet *)keyPathsForValuesAffectingNameWithProgressAndFileSize
{
return [NSSet setWithObjects:@"progress", @"name", @"size", nil];
}
@end