transmission/macosx/Torrent.m

752 lines
20 KiB
Objective-C

/******************************************************************************
* $Id$
*
* Copyright (c) 2006 Transmission authors and contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*****************************************************************************/
#import "Torrent.h"
#import "StringAdditions.h"
@interface Torrent (Private)
- (id) initWithHash: (NSString *) hashString path: (NSString *) path lib: (tr_handle_t *) lib
privateTorrent: (NSNumber *) privateTorrent publicTorrent: (NSNumber *) publicTorrent
date: (NSDate *) date stopRatioSetting: (NSNumber *) stopRatioSetting
ratioLimit: (NSNumber *) ratioLimit waitToStart: (NSNumber *) waitToStart
orderValue: (NSNumber *) orderValue;
- (void) trashFile: (NSString *) path;
@end
@implementation Torrent
- (id) initWithPath: (NSString *) path lib: (tr_handle_t *) lib
{
self = [self initWithHash: nil path: path lib: lib privateTorrent: nil publicTorrent: nil
date: nil stopRatioSetting: nil ratioLimit: nil waitToStart: nil orderValue: nil];
if (self)
{
if (!fPublicTorrent)
[self trashFile: path];
}
return self;
}
- (id) initWithHistory: (NSDictionary *) history lib: (tr_handle_t *) lib
{
self = [self initWithHash: [history objectForKey: @"TorrentHash"]
path: [history objectForKey: @"TorrentPath"] lib: lib
privateTorrent: [history objectForKey: @"PrivateCopy"]
publicTorrent: [history objectForKey: @"PublicCopy"]
date: [history objectForKey: @"Date"]
stopRatioSetting: [history objectForKey: @"StopRatioSetting"]
ratioLimit: [history objectForKey: @"RatioLimit"]
waitToStart: [history objectForKey: @"WaitToStart"]
orderValue: [history objectForKey: @"OrderValue"]];
if (self)
{
NSString * downloadFolder;
if (!(downloadFolder = [history objectForKey: @"DownloadFolder"]))
downloadFolder = [[fDefaults stringForKey: @"DownloadFolder"] stringByExpandingTildeInPath];
[self setDownloadFolder: downloadFolder];
NSString * paused;
if (!(paused = [history objectForKey: @"Paused"]) || [paused isEqualToString: @"NO"])
tr_torrentStart(fHandle);
}
return self;
}
- (NSDictionary *) history
{
NSMutableDictionary * history = [NSMutableDictionary dictionaryWithObjectsAndKeys:
[NSNumber numberWithBool: fPrivateTorrent], @"PrivateCopy",
[NSNumber numberWithBool: fPublicTorrent], @"PublicCopy",
[self downloadFolder], @"DownloadFolder",
[self isActive] ? @"NO" : @"YES", @"Paused",
[self date], @"Date",
[NSNumber numberWithInt: fStopRatioSetting], @"StopRatioSetting",
[NSNumber numberWithFloat: fRatioLimit], @"RatioLimit",
[NSNumber numberWithBool: fWaitToStart], @"WaitToStart",
[self orderValue], @"OrderValue", nil];
if (fPrivateTorrent)
[history setObject: [self hashString] forKey: @"TorrentHash"];
if (fPublicTorrent)
[history setObject: [self publicTorrentLocation] forKey: @"TorrentPath"];
return history;
}
- (void) dealloc
{
if (fHandle)
{
tr_torrentClose(fLib, fHandle);
if (fPublicTorrentLocation)
[fPublicTorrentLocation release];
[fDate release];
[fIcon release];
[fIconFlipped release];
[fIconSmall release];
[fProgressString release];
[fStatusString release];
[fShortStatusString release];
[fRemainingTimeString release];
}
[super dealloc];
}
- (void) setDownloadFolder: (NSString *) path
{
tr_torrentSetFolder(fHandle, [path UTF8String]);
}
- (NSString *) downloadFolder
{
return [NSString stringWithUTF8String: tr_torrentGetFolder(fHandle)];
}
- (void) getAvailability: (int8_t *) tab size: (int) size
{
tr_torrentAvailability(fHandle, tab, size);
}
- (void) update
{
fStat = tr_torrentStat(fHandle);
//notification when downloading finished
if ([self justFinished])
[[NSNotificationCenter defaultCenter] postNotificationName: @"TorrentFinishedDownloading" object: self];
//check to stop for ratio
if ([self isSeeding] && ((fStopRatioSetting == RATIO_CHECK && [self ratio] >= fRatioLimit)
|| (fStopRatioSetting == RATIO_GLOBAL && [fDefaults boolForKey: @"RatioCheck"]
&& [self ratio] >= [fDefaults floatForKey: @"RatioLimit"])))
{
[self stopTransfer];
[self setStopRatioSetting: RATIO_NO_CHECK];
fFinishedSeeding = YES;
fStat = tr_torrentStat(fHandle);
[[NSNotificationCenter defaultCenter] postNotificationName: @"TorrentStoppedForRatio" object: self];
}
[fProgressString setString: @""];
if ([self progress] < 1.0)
[fProgressString appendFormat: @"%@ of %@ (%.2f%%)", [NSString stringForFileSize:
[self downloadedValid]], [NSString stringForFileSize: [self size]], 100.0 * [self progress]];
else
[fProgressString appendFormat: @"%@, uploaded %@ (Ratio: %@)", [NSString stringForFileSize:
[self size]], [NSString stringForFileSize: [self uploadedTotal]],
[NSString stringForRatioWithDownload: [self downloadedTotal] upload: [self uploadedTotal]]];
switch (fStat->status)
{
NSString * tempString;
case TR_STATUS_PAUSE:
if (fFinishedSeeding)
tempString = @"Seeding complete";
else if (fWaitToStart && [[fDefaults stringForKey: @"StartSetting"] isEqualToString: @"Wait"])
tempString = [@"Waiting to start" stringByAppendingEllipsis];
else
tempString = @"Paused";
[fStatusString setString: tempString];
[fShortStatusString setString: tempString];
break;
case TR_STATUS_CHECK:
tempString = [@"Checking existing files" stringByAppendingEllipsis];
[fStatusString setString: tempString];
[fShortStatusString setString: tempString];
[fRemainingTimeString setString: tempString];
break;
case TR_STATUS_DOWNLOAD:
[fStatusString setString: @""];
[fStatusString appendFormat:
@"Downloading from %d of %d peer%s", [self peersUploading], [self totalPeers],
[self totalPeers] == 1 ? "" : "s"];
[fRemainingTimeString setString: @""];
int eta = [self eta];
if (eta < 0)
{
[fRemainingTimeString setString: @"Unknown"];
[fProgressString appendString: @" - remaining time unknown"];
}
else
{
if (eta < 60)
[fRemainingTimeString appendFormat: @"%d sec", eta];
else if (eta < 3600) //60 * 60
[fRemainingTimeString appendFormat: @"%d min %02d sec", eta / 60, eta % 60];
else if (eta < 86400) //24 * 60 * 60
[fRemainingTimeString appendFormat: @"%d hr %02d min", eta / 3600, (eta / 60) % 60];
else
[fRemainingTimeString appendFormat: @"%d day%s %d hr",
eta / 86400, eta / 86400 == 1 ? "" : "s", (eta / 3600) % 24];
[fProgressString appendFormat: @" - %@ remaining", fRemainingTimeString];
}
break;
case TR_STATUS_SEED:
[fStatusString setString: @""];
[fStatusString appendFormat:
@"Seeding to %d of %d peer%s",
[self peersDownloading], [self totalPeers], [self totalPeers] == 1 ? "" : "s"];
break;
case TR_STATUS_STOPPING:
tempString = [@"Stopping" stringByAppendingEllipsis];
[fStatusString setString: tempString];
[fShortStatusString setString: tempString];
break;
}
if( fStat->error & TR_ETRACKER )
[fStatusString setString: [@"Error: " stringByAppendingString:
[NSString stringWithUTF8String: fStat->trackerError]]];
if ([self isActive])
{
NSString * stringToAppend = @"";
if ([self progress] < 1.0)
{
stringToAppend = [NSString stringWithFormat: @"DL: %@, ", [NSString stringForSpeed: [self downloadRate]]];
[fShortStatusString setString: @""];
}
else
{
NSString * ratioString = [NSString stringForRatioWithDownload: [self downloadedTotal]
upload: [self uploadedTotal]];
[fShortStatusString setString: [NSString stringWithFormat: @"Ratio: %@, ", ratioString]];
[fRemainingTimeString setString: [@"Ratio: " stringByAppendingString: ratioString]];
}
stringToAppend = [stringToAppend stringByAppendingString: [@"UL: " stringByAppendingString:
[NSString stringForSpeed: [self uploadRate]]]];
[fStatusString appendFormat: @" - %@", stringToAppend];
[fShortStatusString appendString: stringToAppend];
}
}
- (void) startTransfer
{
if (![self isActive])
{
tr_torrentStart(fHandle);
fFinishedSeeding = NO;
fWaitToStart = NO;
[[NSNotificationCenter defaultCenter] postNotificationName: @"TorrentSettingChange" object: self];
}
}
- (void) stopTransfer
{
if ([self isActive])
{
BOOL wasSeeding = [self isSeeding];
tr_torrentStop(fHandle);
if (!wasSeeding)
[[NSNotificationCenter defaultCenter] postNotificationName: @"StoppedDownloading" object: self];
}
}
- (void) stopTransferForQuit
{
if ([self isActive])
tr_torrentStop(fHandle);
}
- (void) removeForever
{
if (fPrivateTorrent)
tr_torrentRemoveSaved(fHandle);
}
- (void) sleep
{
if ((fResumeOnWake = [self isActive]))
tr_torrentStop(fHandle);
}
- (void) wakeUp
{
if (fResumeOnWake)
tr_torrentStart(fHandle);
}
- (float) ratio
{
float downloaded = [self downloadedTotal];
return downloaded > 0 ? (float)[self uploadedTotal] / downloaded : -1;
}
- (int) stopRatioSetting
{
return fStopRatioSetting;
}
- (void) setStopRatioSetting: (int) setting
{
fStopRatioSetting = setting;
}
- (float) ratioLimit
{
return fRatioLimit;
}
- (void) setRatioLimit: (float) limit
{
if (limit >= 0)
fRatioLimit = limit;
}
- (void) setWaitToStart: (BOOL) wait
{
fWaitToStart = wait;
}
- (BOOL) waitingToStart
{
return fWaitToStart;
}
- (void) revealData
{
[[NSWorkspace sharedWorkspace] selectFile: [self dataLocation] inFileViewerRootedAtPath: nil];
}
- (void) trashData
{
[self trashFile: [self dataLocation]];
}
- (void) trashTorrent
{
if (fPublicTorrent)
[self trashFile: [self publicTorrentLocation]];
}
- (NSImage *) icon
{
return fIcon;
}
- (NSImage *) iconFlipped
{
return fIconFlipped;
}
- (NSImage *) iconSmall
{
return fIconSmall;
}
- (NSString *) name
{
return [NSString stringWithUTF8String: fInfo->name];
}
- (uint64_t) size
{
return fInfo->totalSize;
}
- (NSString *) tracker
{
return [NSString stringWithFormat: @"%s:%d", fInfo->trackerAddress, fInfo->trackerPort];
}
- (NSString *) announce
{
return [NSString stringWithUTF8String: fInfo->trackerAnnounce];
}
- (int) pieceSize
{
return fInfo->pieceSize;
}
- (int) pieceCount
{
return fInfo->pieceCount;
}
- (NSString *) hashString
{
return [NSString stringWithUTF8String: fInfo->hashString];
}
- (NSString *) torrentLocation
{
return [NSString stringWithUTF8String: fInfo->torrent];
}
- (NSString *) publicTorrentLocation
{
return fPublicTorrentLocation;
}
- (NSString *) torrentLocationString
{
return fPrivateTorrent ? @"Transmission Support Folder"
: [fPublicTorrentLocation stringByAbbreviatingWithTildeInPath];
}
- (NSString *) dataLocation
{
return [[self downloadFolder] stringByAppendingPathComponent: [self name]];
}
- (BOOL) publicTorrent
{
return fPublicTorrent;
}
- (BOOL) privateTorrent
{
return fPrivateTorrent;
}
- (NSString *) stateString
{
switch( fStat->status )
{
case TR_STATUS_PAUSE:
return @"Paused";
break;
case TR_STATUS_CHECK:
return [@"Checking existing files" stringByAppendingEllipsis];
break;
case TR_STATUS_DOWNLOAD:
return @"Downloading";
break;
case TR_STATUS_SEED:
return @"Seeding";
break;
case TR_STATUS_STOPPING:
return [@"Stopping" stringByAppendingEllipsis];
break;
default:
return @"N/A";
}
}
- (float) progress
{
return fStat->progress;
}
- (int) eta
{
return fStat->eta;
}
- (BOOL) isActive
{
return fStat->status & TR_STATUS_ACTIVE;
}
- (BOOL) isSeeding
{
return fStat->status == TR_STATUS_SEED;
}
- (BOOL) isPaused
{
return fStat->status == TR_STATUS_PAUSE;
}
- (BOOL) justFinished
{
return tr_getFinished(fHandle);
}
- (NSArray *) peers
{
int totalPeers, i;
tr_peer_stat_t * peers = tr_torrentPeers(fHandle, & totalPeers);
NSMutableArray * peerDics = [NSMutableArray arrayWithCapacity: totalPeers];
tr_peer_stat_t peer;
NSString * client;
for (i = 0; i < totalPeers; i++)
{
peer = peers[i];
[peerDics addObject: [NSDictionary dictionaryWithObjectsAndKeys:
[NSNumber numberWithBool: peer.isConnected], @"Connected",
[NSString stringWithCString: (char *) peer.addr encoding: NSUTF8StringEncoding], @"IP",
[NSString stringWithCString: (char *) peer.client encoding: NSUTF8StringEncoding], @"Client",
[NSNumber numberWithBool: peer.isDownloading], @"UL To",
[NSNumber numberWithBool: peer.isUploading], @"DL From", nil]];
}
tr_torrentPeersFree(peers, totalPeers);
return peerDics;
}
- (NSString *) progressString
{
return fProgressString;
}
- (NSString *) statusString
{
return fStatusString;
}
- (NSString *) shortStatusString
{
return fShortStatusString;
}
- (NSString *) remainingTimeString
{
return fRemainingTimeString;
}
- (int) seeders
{
return fStat->seeders;
}
- (int) leechers
{
return fStat->leechers;
}
- (int) totalPeers
{
return fStat->peersTotal;
}
//peers uploading to you
- (int) peersUploading
{
return fStat->peersUploading;
}
//peers downloading from you
- (int) peersDownloading
{
return fStat->peersDownloading;
}
- (float) downloadRate
{
return fStat->rateDownload;
}
- (float) uploadRate
{
return fStat->rateUpload;
}
- (float) downloadedValid
{
return [self progress] * [self size];
}
- (uint64_t) downloadedTotal
{
return fStat->downloaded;
}
- (uint64_t) uploadedTotal
{
return fStat->uploaded;
}
- (float) swarmSpeed
{
return fStat->swarmspeed;
}
- (NSNumber *) orderValue
{
return [NSNumber numberWithInt: fOrderValue];
}
- (void) setOrderValue: (int) orderValue
{
fOrderValue = orderValue;
}
- (NSArray *) fileList
{
int count = fInfo->fileCount, i;
tr_file_t file;
NSMutableArray * files = [NSMutableArray arrayWithCapacity: count];
for (i = 0; i < count; i++)
{
file = fInfo->files[i];
[files addObject: [NSDictionary dictionaryWithObjectsAndKeys: [[self downloadFolder]
stringByAppendingPathComponent: [NSString stringWithUTF8String: file.name]], @"Name",
[NSNumber numberWithUnsignedLongLong: file.length], @"Size", nil]];
}
return files;
}
- (NSDate *) date
{
return fDate;
}
- (NSNumber *) stateSortKey
{
if (![self isActive])
return [NSNumber numberWithInt: 0];
else if ([self isSeeding])
return [NSNumber numberWithInt: 1];
else
return [NSNumber numberWithInt: 2];
}
- (NSNumber *) progressSortKey
{
//if finished downloading sort by ratio instead of progress
float progress = [self progress];
return [NSNumber numberWithFloat: progress < 1.0 ? progress : 2.0 + [self ratio]];
}
@end
@implementation Torrent (Private)
//if a hash is given, attempt to load that; otherwise, attempt to open file at path
- (id) initWithHash: (NSString *) hashString path: (NSString *) path lib: (tr_handle_t *) lib
privateTorrent: (NSNumber *) privateTorrent publicTorrent: (NSNumber *) publicTorrent
date: (NSDate *) date stopRatioSetting: (NSNumber *) stopRatioSetting
ratioLimit: (NSNumber *) ratioLimit waitToStart: (NSNumber *) waitToStart
orderValue: (NSNumber *) orderValue
{
if (!(self = [super init]))
return nil;
fLib = lib;
fDefaults = [NSUserDefaults standardUserDefaults];
fPrivateTorrent = privateTorrent ? [privateTorrent boolValue] : [fDefaults boolForKey: @"SavePrivateTorrent"];
fPublicTorrent = !fPrivateTorrent || (publicTorrent ? [publicTorrent boolValue]
: ![fDefaults boolForKey: @"DeleteOriginalTorrent"]);
int error;
if (fPrivateTorrent && hashString)
fHandle = tr_torrentInitSaved(fLib, [hashString UTF8String], TR_FSAVEPRIVATE, & error);
if (!fHandle && path)
fHandle = tr_torrentInit(fLib, [path UTF8String], fPrivateTorrent ? TR_FSAVEPRIVATE : 0, & error);
if (!fHandle)
{
[self release];
return nil;
}
fInfo = tr_torrentInfo( fHandle );
if (fPublicTorrent)
fPublicTorrentLocation = [path retain];
fDate = date ? [date retain] : [[NSDate alloc] init];
fStopRatioSetting = stopRatioSetting ? [stopRatioSetting intValue] : -1;
fRatioLimit = ratioLimit ? [ratioLimit floatValue] : [fDefaults floatForKey: @"RatioLimit"];
fFinishedSeeding = NO;
fWaitToStart = waitToStart ? [waitToStart boolValue]
: ![[fDefaults stringForKey: @"StartSetting"] isEqualToString: @"Manual"];
fOrderValue = orderValue ? [orderValue intValue] : tr_torrentCount(fLib) - 1;
NSString * fileType = fInfo->multifile ? NSFileTypeForHFSTypeCode('fldr') : [[self name] pathExtension];
fIcon = [[NSWorkspace sharedWorkspace] iconForFileType: fileType];
[fIcon retain];
fIconFlipped = [fIcon copy];
[fIconFlipped setFlipped: YES];
fIconSmall = [fIconFlipped copy];
[fIconSmall setScalesWhenResized: YES];
[fIconSmall setSize: NSMakeSize(16.0, 16.0)];
fProgressString = [[NSMutableString alloc] initWithCapacity: 50];
fStatusString = [[NSMutableString alloc] initWithCapacity: 75];
fShortStatusString = [[NSMutableString alloc] initWithCapacity: 30];
fRemainingTimeString = [[NSMutableString alloc] initWithCapacity: 30];
[self update];
return self;
}
- (void) trashFile: (NSString *) path
{
//attempt to move to trash
if (![[NSWorkspace sharedWorkspace] performFileOperation: NSWorkspaceRecycleOperation
source: [path stringByDeletingLastPathComponent] destination: @""
files: [NSArray arrayWithObject: [path lastPathComponent]] tag: nil])
{
//if cannot trash, just delete it (will work if it is on a remote volume)
if (![[NSFileManager defaultManager] removeFileAtPath: path handler: nil])
NSLog([@"Could not trash " stringByAppendingString: path]);
}
}
@end