source: trunk/libtransmission/torrent.c @ 10800

Last change on this file since 10800 was 10800, checked in by charles, 12 years ago

(trunk) #3256 "libtransmission/publish.[ch] should be replaced" -- apply publish.diff for 2.10

  • Property svn:keywords set to Date Rev Author Id
File size: 74.1 KB
Line 
1/*
2 * This file Copyright (C) 2009-2010 Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: torrent.c 10800 2010-06-19 14:33:10Z charles $
11 */
12
13#include <sys/types.h> /* stat */
14#include <sys/stat.h> /* stat */
15#include <unistd.h> /* stat */
16#include <dirent.h>
17
18#include <assert.h>
19#include <limits.h> /* INT_MAX */
20#include <math.h>
21#include <stdarg.h>
22#include <string.h> /* memcmp */
23#include <stdlib.h> /* qsort */
24
25#include <stdarg.h> /* some 1.4.x versions of evutil.h need this */
26#include <evutil.h> /* evutil_vsnprintf() */
27
28#include "transmission.h"
29#include "announcer.h"
30#include "bandwidth.h"
31#include "bencode.h"
32#include "cache.h"
33#include "completion.h"
34#include "crypto.h" /* for tr_sha1 */
35#include "resume.h"
36#include "fdlimit.h" /* tr_fdTorrentClose */
37#include "magnet.h"
38#include "metainfo.h"
39#include "peer-common.h" /* MAX_BLOCK_SIZE */
40#include "peer-mgr.h"
41#include "platform.h" /* TR_PATH_DELIMITER_STR */
42#include "ptrarray.h"
43#include "session.h"
44#include "torrent.h"
45#include "torrent-magnet.h"
46#include "trevent.h" /* tr_runInEventThread() */
47#include "utils.h"
48#include "verify.h"
49#include "version.h"
50
51/***
52****
53***/
54
55int
56tr_torrentId( const tr_torrent * tor )
57{
58    return tor->uniqueId;
59}
60
61tr_torrent*
62tr_torrentFindFromId( tr_session * session, int id )
63{
64    tr_torrent * tor = NULL;
65
66    while(( tor = tr_torrentNext( session, tor )))
67        if( tor->uniqueId == id )
68            return tor;
69
70    return NULL;
71}
72
73tr_torrent*
74tr_torrentFindFromHashString( tr_session *  session, const char * str )
75{
76    tr_torrent * tor = NULL;
77
78    while(( tor = tr_torrentNext( session, tor )))
79        if( !strcasecmp( str, tor->info.hashString ) )
80            return tor;
81
82    return NULL;
83}
84
85tr_torrent*
86tr_torrentFindFromHash( tr_session * session, const uint8_t * torrentHash )
87{
88    tr_torrent * tor = NULL;
89
90    while(( tor = tr_torrentNext( session, tor )))
91        if( *tor->info.hash == *torrentHash )
92            if( !memcmp( tor->info.hash, torrentHash, SHA_DIGEST_LENGTH ) )
93                return tor;
94
95    return NULL;
96}
97
98tr_torrent*
99tr_torrentFindFromMagnetLink( tr_session * session, const char * magnet )
100{
101    tr_magnet_info * info;
102    tr_torrent * tor = NULL;
103
104    if(( info = tr_magnetParse( magnet )))
105    {
106        tor = tr_torrentFindFromHash( session, info->hash );
107        tr_magnetFree( info );
108    }
109
110    return tor;
111}
112
113tr_torrent*
114tr_torrentFindFromObfuscatedHash( tr_session * session,
115                                  const uint8_t * obfuscatedTorrentHash )
116{
117    tr_torrent * tor = NULL;
118
119    while(( tor = tr_torrentNext( session, tor )))
120        if( !memcmp( tor->obfuscatedHash, obfuscatedTorrentHash,
121                     SHA_DIGEST_LENGTH ) )
122            return tor;
123
124    return NULL;
125}
126
127/***
128****  PER-TORRENT UL / DL SPEEDS
129***/
130
131void
132tr_torrentSetSpeedLimit( tr_torrent * tor, tr_direction dir, int KiB_sec )
133{
134    assert( tr_isTorrent( tor ) );
135    assert( tr_isDirection( dir ) );
136
137    if( tr_bandwidthSetDesiredSpeed( tor->bandwidth, dir, KiB_sec ) )
138        tr_torrentSetDirty( tor );
139}
140
141int
142tr_torrentGetSpeedLimit( const tr_torrent * tor, tr_direction dir )
143{
144    assert( tr_isTorrent( tor ) );
145    assert( tr_isDirection( dir ) );
146
147    return tr_bandwidthGetDesiredSpeed( tor->bandwidth, dir );
148}
149
150void
151tr_torrentUseSpeedLimit( tr_torrent * tor, tr_direction dir, tr_bool do_use )
152{
153    assert( tr_isTorrent( tor ) );
154    assert( tr_isDirection( dir ) );
155
156    if( tr_bandwidthSetLimited( tor->bandwidth, dir, do_use ) )
157        tr_torrentSetDirty( tor );
158}
159
160tr_bool
161tr_torrentUsesSpeedLimit( const tr_torrent * tor, tr_direction dir )
162{
163    assert( tr_isTorrent( tor ) );
164    assert( tr_isDirection( dir ) );
165
166    return tr_bandwidthIsLimited( tor->bandwidth, dir );
167}
168
169void
170tr_torrentUseSessionLimits( tr_torrent * tor, tr_bool doUse )
171{
172    tr_bool changed;
173
174    assert( tr_isTorrent( tor ) );
175
176    changed = tr_bandwidthHonorParentLimits( tor->bandwidth, TR_UP, doUse );
177    changed |= tr_bandwidthHonorParentLimits( tor->bandwidth, TR_DOWN, doUse );
178
179    if( changed )
180        tr_torrentSetDirty( tor );
181}
182
183tr_bool
184tr_torrentUsesSessionLimits( const tr_torrent * tor )
185{
186    assert( tr_isTorrent( tor ) );
187
188    return tr_bandwidthAreParentLimitsHonored( tor->bandwidth, TR_UP );
189}
190
191/***
192****
193***/
194
195void
196tr_torrentSetRatioMode( tr_torrent *  tor, tr_ratiolimit mode )
197{
198    assert( tr_isTorrent( tor ) );
199    assert( mode==TR_RATIOLIMIT_GLOBAL || mode==TR_RATIOLIMIT_SINGLE || mode==TR_RATIOLIMIT_UNLIMITED  );
200
201    if( mode != tor->ratioLimitMode )
202    {
203        tor->ratioLimitMode = mode;
204
205        tr_torrentSetDirty( tor );
206    }
207}
208
209tr_ratiolimit
210tr_torrentGetRatioMode( const tr_torrent * tor )
211{
212    assert( tr_isTorrent( tor ) );
213
214    return tor->ratioLimitMode;
215}
216
217void
218tr_torrentSetRatioLimit( tr_torrent * tor, double desiredRatio )
219{
220    assert( tr_isTorrent( tor ) );
221
222    if( (int)(desiredRatio*100.0) != (int)(tor->desiredRatio*100.0) )
223    {
224        tor->desiredRatio = desiredRatio;
225
226        tr_torrentSetDirty( tor );
227    }
228}
229
230double
231tr_torrentGetRatioLimit( const tr_torrent * tor )
232{
233    assert( tr_isTorrent( tor ) );
234
235    return tor->desiredRatio;
236}
237
238tr_bool
239tr_torrentIsPieceTransferAllowed( const tr_torrent  * tor,
240                                  tr_direction        direction )
241{
242    int limit;
243    tr_bool allowed = TRUE;
244
245    if( tr_torrentUsesSpeedLimit( tor, direction ) )
246        if( tr_torrentGetSpeedLimit( tor, direction ) <= 0 )
247            allowed = FALSE;
248
249    if( tr_torrentUsesSessionLimits( tor ) )
250        if( tr_sessionGetActiveSpeedLimit( tor->session, direction, &limit ) )
251            if( limit <= 0 )
252                allowed = FALSE;
253
254    return allowed;
255}
256
257tr_bool
258tr_torrentGetSeedRatio( const tr_torrent * tor, double * ratio )
259{
260    tr_bool isLimited;
261
262    switch( tr_torrentGetRatioMode( tor ) )
263    {
264        case TR_RATIOLIMIT_SINGLE:
265            isLimited = TRUE;
266            if( ratio )
267                *ratio = tr_torrentGetRatioLimit( tor );
268            break;
269
270        case TR_RATIOLIMIT_GLOBAL:
271            isLimited = tr_sessionIsRatioLimited( tor->session );
272            if( isLimited && ratio )
273                *ratio = tr_sessionGetRatioLimit( tor->session );
274            break;
275
276        default: /* TR_RATIOLIMIT_UNLIMITED */
277            isLimited = FALSE;
278            break;
279    }
280
281    return isLimited;
282}
283
284/* returns true if the seed ratio applies --
285 * it applies if the torrent's a seed AND it has a seed ratio set */
286static tr_bool
287tr_torrentGetSeedRatioBytes( tr_torrent  * tor,
288                             uint64_t    * setmeLeft,
289                             uint64_t    * setmeGoal )
290{
291    double seedRatio;
292    tr_bool seedRatioApplies = FALSE;
293
294    if( tr_torrentGetSeedRatio( tor, &seedRatio ) )
295    {
296        const uint64_t u = tor->uploadedCur + tor->uploadedPrev;
297        const uint64_t d = tor->downloadedCur + tor->downloadedPrev;
298        const uint64_t baseline = d ? d : tr_cpSizeWhenDone( &tor->completion );
299        const uint64_t goal = baseline * seedRatio;
300        if( setmeLeft ) *setmeLeft = goal > u ? goal - u : 0;
301        if( setmeGoal ) *setmeGoal = goal;
302        seedRatioApplies = tr_torrentIsSeed( tor );
303    }
304
305    return seedRatioApplies;
306}
307
308static tr_bool
309tr_torrentIsSeedRatioDone( tr_torrent * tor )
310{
311    uint64_t bytesLeft;
312    return tr_torrentGetSeedRatioBytes( tor, &bytesLeft, NULL ) && !bytesLeft;
313}
314
315void
316tr_torrentCheckSeedRatio( tr_torrent * tor )
317{
318    assert( tr_isTorrent( tor ) );
319
320    /* if we're seeding and reach our seed ratio limit, stop the torrent */
321    if( tor->isRunning && tr_torrentIsSeedRatioDone( tor ) )
322    {
323        tr_torinf( tor, "Seed ratio reached; pausing torrent" );
324
325        tr_torrentStop( tor );
326
327        /* maybe notify the client */
328        if( tor->ratio_limit_hit_func != NULL )
329            tor->ratio_limit_hit_func( tor, tor->ratio_limit_hit_func_user_data );
330    }
331}
332
333
334/***
335****
336***/
337
338void
339tr_torrentSetLocalError( tr_torrent * tor, const char * fmt, ... )
340{
341    va_list ap;
342
343    assert( tr_isTorrent( tor ) );
344
345    va_start( ap, fmt );
346    tor->error = TR_STAT_LOCAL_ERROR;
347    tor->errorTracker[0] = '\0';
348    evutil_vsnprintf( tor->errorString, sizeof( tor->errorString ), fmt, ap );
349    va_end( ap );
350}
351
352static void
353tr_torrentClearError( tr_torrent * tor )
354{
355    assert( tr_isTorrent( tor ) );
356
357    tor->error = TR_STAT_OK;
358    tor->errorString[0] = '\0';
359    tor->errorTracker[0] = '\0';
360}
361
362static void
363onTrackerResponse( tr_torrent * tor, const tr_tracker_event * event, void * unused UNUSED )
364{
365    switch( event->messageType )
366    {
367        case TR_TRACKER_PEERS:
368        {
369            size_t i, n;
370            const int seedProbability = event->seedProbability;
371            const tr_bool allAreSeeds = seedProbability == 100;
372            tr_pex * pex = tr_peerMgrArrayToPex( event->compact,
373                                                 event->compactLen, &n );
374             if( allAreSeeds )
375                tr_tordbg( tor, "Got %d seeds from tracker", (int)n );
376            else
377                tr_tordbg( tor, "Got %d peers from tracker", (int)n );
378
379            for( i = 0; i < n; ++i )
380                tr_peerMgrAddPex( tor, TR_PEER_FROM_TRACKER, pex+i, seedProbability );
381
382            if( allAreSeeds && tr_torrentIsPrivate( tor ) )
383                tr_peerMgrMarkAllAsSeeds( tor );
384
385            tr_free( pex );
386            break;
387        }
388
389        case TR_TRACKER_WARNING:
390            tr_torerr( tor, _( "Tracker warning: \"%s\"" ), event->text );
391            tor->error = TR_STAT_TRACKER_WARNING;
392            tr_strlcpy( tor->errorTracker, event->tracker, sizeof( tor->errorTracker ) );
393            tr_strlcpy( tor->errorString, event->text, sizeof( tor->errorString ) );
394            break;
395
396        case TR_TRACKER_ERROR:
397            tr_torerr( tor, _( "Tracker error: \"%s\"" ), event->text );
398            tor->error = TR_STAT_TRACKER_ERROR;
399            tr_strlcpy( tor->errorTracker, event->tracker, sizeof( tor->errorTracker ) );
400            tr_strlcpy( tor->errorString, event->text, sizeof( tor->errorString ) );
401            break;
402
403        case TR_TRACKER_ERROR_CLEAR:
404            if( tor->error != TR_STAT_LOCAL_ERROR )
405                tr_torrentClearError( tor );
406            break;
407    }
408}
409
410/***
411****
412****  TORRENT INSTANTIATION
413****
414***/
415
416static int
417getBytePiece( const tr_info * info,
418              uint64_t        byteOffset )
419{
420    assert( info );
421    assert( info->pieceSize != 0 );
422
423    return byteOffset / info->pieceSize;
424}
425
426static void
427initFilePieces( tr_info *       info,
428                tr_file_index_t fileIndex )
429{
430    tr_file * file;
431    uint64_t  firstByte, lastByte;
432
433    assert( info );
434    assert( fileIndex < info->fileCount );
435
436    file = &info->files[fileIndex];
437    firstByte = file->offset;
438    lastByte = firstByte + ( file->length ? file->length - 1 : 0 );
439    file->firstPiece = getBytePiece( info, firstByte );
440    file->lastPiece = getBytePiece( info, lastByte );
441}
442
443static int
444pieceHasFile( tr_piece_index_t piece,
445              const tr_file *  file )
446{
447    return ( file->firstPiece <= piece ) && ( piece <= file->lastPiece );
448}
449
450static tr_priority_t
451calculatePiecePriority( const tr_torrent * tor,
452                        tr_piece_index_t   piece,
453                        int                fileHint )
454{
455    tr_file_index_t i;
456    int             priority = TR_PRI_LOW;
457
458    /* find the first file that has data in this piece */
459    if( fileHint >= 0 ) {
460        i = fileHint;
461        while( i > 0 && pieceHasFile( piece, &tor->info.files[i - 1] ) )
462            --i;
463    } else {
464        for( i = 0; i < tor->info.fileCount; ++i )
465            if( pieceHasFile( piece, &tor->info.files[i] ) )
466                break;
467    }
468
469    /* the piece's priority is the max of the priorities
470     * of all the files in that piece */
471    for( ; i < tor->info.fileCount; ++i )
472    {
473        const tr_file * file = &tor->info.files[i];
474
475        if( !pieceHasFile( piece, file ) )
476            break;
477
478        priority = MAX( priority, file->priority );
479
480        /* when dealing with multimedia files, getting the first and
481           last pieces can sometimes allow you to preview it a bit
482           before it's fully downloaded... */
483        if( file->priority >= TR_PRI_NORMAL )
484            if( file->firstPiece == piece || file->lastPiece == piece )
485                priority = TR_PRI_HIGH;
486    }
487
488    return priority;
489}
490
491static void
492tr_torrentInitFilePieces( tr_torrent * tor )
493{
494    tr_file_index_t  f;
495    tr_piece_index_t p;
496    uint64_t offset = 0;
497    tr_info * inf = &tor->info;
498    int * firstFiles;
499
500    /* assign the file offsets */
501    for( f=0; f<inf->fileCount; ++f ) {
502        inf->files[f].offset = offset;
503        offset += inf->files[f].length;
504        initFilePieces( inf, f );
505    }
506
507    /* build the array of first-file hints to give calculatePiecePriority */
508    firstFiles = tr_new( int, inf->pieceCount );
509    for( p=f=0; p<inf->pieceCount; ++p ) {
510        while( inf->files[f].lastPiece < p )
511            ++f;
512        firstFiles[p] = f;
513    }
514
515#if 0
516    /* test to confirm the first-file hints are correct */
517    for( p=0; p<inf->pieceCount; ++p ) {
518        f = firstFiles[p];
519        assert( inf->files[f].firstPiece <= p );
520        assert( inf->files[f].lastPiece >= p );
521        if( f > 0 )
522            assert( inf->files[f-1].lastPiece < p );
523        for( f=0; f<inf->fileCount; ++f )
524            if( pieceHasFile( p, &inf->files[f] ) )
525                break;
526        assert( (int)f == firstFiles[p] );
527    }
528#endif
529
530    for( p=0; p<inf->pieceCount; ++p )
531        inf->pieces[p].priority = calculatePiecePriority( tor, p, firstFiles[p] );
532
533    tr_free( firstFiles );
534}
535
536static void torrentStart( tr_torrent * tor );
537
538/**
539 * Decide on a block size.  constraints:
540 * (1) most clients decline requests over 16 KiB
541 * (2) pieceSize must be a multiple of block size
542 */
543static uint32_t
544getBlockSize( uint32_t pieceSize )
545{
546    uint32_t b = pieceSize;
547
548    while( b > MAX_BLOCK_SIZE )
549        b /= 2u;
550
551    if( !b || ( pieceSize % b ) ) /* not cleanly divisible */
552        return 0;
553    return b;
554}
555
556static void refreshCurrentDir( tr_torrent * tor );
557
558static void
559torrentInitFromInfo( tr_torrent * tor )
560{
561    uint64_t t;
562    tr_info * info = &tor->info;
563
564    tor->blockSize = getBlockSize( info->pieceSize );
565
566    if( info->pieceSize )
567        tor->lastPieceSize = info->totalSize % info->pieceSize;
568
569    if( !tor->lastPieceSize )
570        tor->lastPieceSize = info->pieceSize;
571
572    if( tor->blockSize )
573        tor->lastBlockSize = info->totalSize % tor->blockSize;
574
575    if( !tor->lastBlockSize )
576        tor->lastBlockSize = tor->blockSize;
577
578    tor->blockCount = tor->blockSize
579        ? ( info->totalSize + tor->blockSize - 1 ) / tor->blockSize
580        : 0;
581
582    tor->blockCountInPiece = tor->blockSize
583        ? info->pieceSize / tor->blockSize
584        : 0;
585
586    tor->blockCountInLastPiece = tor->blockSize
587        ? ( tor->lastPieceSize + tor->blockSize - 1 ) / tor->blockSize
588        : 0;
589
590    /* check our work */
591    if( tor->blockSize != 0 )
592        assert( ( info->pieceSize % tor->blockSize ) == 0 );
593    t = info->pieceCount - 1;
594    t *= info->pieceSize;
595    t += tor->lastPieceSize;
596    assert( t == info->totalSize );
597    t = tor->blockCount - 1;
598    t *= tor->blockSize;
599    t += tor->lastBlockSize;
600    assert( t == info->totalSize );
601    t = info->pieceCount - 1;
602    t *= tor->blockCountInPiece;
603    t += tor->blockCountInLastPiece;
604    assert( t == (uint64_t)tor->blockCount );
605
606    tr_cpConstruct( &tor->completion, tor );
607
608    tr_torrentInitFilePieces( tor );
609
610    tr_bitfieldConstruct( &tor->checkedPieces, tor->info.pieceCount );
611
612    tor->completeness = tr_cpGetStatus( &tor->completion );
613}
614
615static void tr_torrentFireMetadataCompleted( tr_torrent * tor );
616
617void
618tr_torrentGotNewInfoDict( tr_torrent * tor )
619{
620    torrentInitFromInfo( tor );
621
622    tr_torrentFireMetadataCompleted( tor );
623}
624
625static void
626torrentInit( tr_torrent * tor, const tr_ctor * ctor )
627{
628    int doStart;
629    uint64_t loaded;
630    const char * dir;
631    static int nextUniqueId = 1;
632    tr_session * session = tr_ctorGetSession( ctor );
633
634    assert( session != NULL );
635
636    tr_sessionLock( session );
637
638    tor->session   = session;
639    tor->uniqueId = nextUniqueId++;
640    tor->magicNumber = TORRENT_MAGIC_NUMBER;
641
642    tr_sha1( tor->obfuscatedHash, "req2", 4,
643             tor->info.hash, SHA_DIGEST_LENGTH,
644             NULL );
645
646    if( !tr_ctorGetDownloadDir( ctor, TR_FORCE, &dir ) ||
647        !tr_ctorGetDownloadDir( ctor, TR_FALLBACK, &dir ) )
648            tor->downloadDir = tr_strdup( dir );
649
650    if( tr_ctorGetIncompleteDir( ctor, &dir ) )
651        dir = tr_sessionGetIncompleteDir( session );
652    if( tr_sessionIsIncompleteDirEnabled( session ) )
653        tor->incompleteDir = tr_strdup( dir );
654
655    tor->bandwidth = tr_bandwidthNew( session, session->bandwidth );
656
657    tor->bandwidth->priority = tr_ctorGetBandwidthPriority( ctor );
658
659    tor->error = TR_STAT_OK;
660
661    tr_peerMgrAddTorrent( session->peerMgr, tor );
662
663    assert( !tor->downloadedCur );
664    assert( !tor->uploadedCur );
665
666    tr_torrentUncheck( tor );
667
668    tr_torrentSetAddedDate( tor, tr_time( ) ); /* this is a default value to be
669                                                  overwritten by the resume file */
670
671    torrentInitFromInfo( tor );
672    loaded = tr_torrentLoadResume( tor, ~0, ctor );
673    tor->completeness = tr_cpGetStatus( &tor->completion );
674
675    tr_ctorInitTorrentPriorities( ctor, tor );
676    tr_ctorInitTorrentWanted( ctor, tor );
677
678    refreshCurrentDir( tor );
679
680    doStart = tor->isRunning;
681    tor->isRunning = 0;
682
683    if( !( loaded & TR_FR_SPEEDLIMIT ) )
684    {
685        tr_torrentUseSpeedLimit( tor, TR_UP, FALSE );
686        tr_torrentSetSpeedLimit( tor, TR_UP, tr_sessionGetSpeedLimit( tor->session, TR_UP ) );
687        tr_torrentUseSpeedLimit( tor, TR_DOWN, FALSE );
688        tr_torrentSetSpeedLimit( tor, TR_DOWN, tr_sessionGetSpeedLimit( tor->session, TR_DOWN ) );
689        tr_torrentUseSessionLimits( tor, TRUE );
690    }
691
692    if( !( loaded & TR_FR_RATIOLIMIT ) )
693    {
694        tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_GLOBAL );
695        tr_torrentSetRatioLimit( tor, tr_sessionGetRatioLimit( tor->session ) );
696    }
697
698    {
699        tr_torrent * it = NULL;
700        tr_torrent * last = NULL;
701        while( ( it = tr_torrentNext( session, it ) ) )
702            last = it;
703
704        if( !last )
705            session->torrentList = tor;
706        else
707            last->next = tor;
708        ++session->torrentCount;
709    }
710
711    /* maybe save our own copy of the metainfo */
712    if( tr_ctorGetSave( ctor ) )
713    {
714        const tr_benc * val;
715        if( !tr_ctorGetMetainfo( ctor, &val ) )
716        {
717            const char * path = tor->info.torrent;
718            const int err = tr_bencToFile( val, TR_FMT_BENC, path );
719            if( err )
720                tr_torrentSetLocalError( tor, "Unable to save torrent file: %s", tr_strerror( err ) );
721            tr_sessionSetTorrentFile( tor->session, tor->info.hashString, path );
722        }
723    }
724
725    tor->tiers = tr_announcerAddTorrent( tor->session->announcer, tor, onTrackerResponse, NULL );
726
727    if( doStart )
728        torrentStart( tor );
729
730    tr_sessionUnlock( session );
731}
732
733static tr_parse_result
734torrentParseImpl( const tr_ctor * ctor, tr_info * setmeInfo,
735                  tr_bool * setmeHasInfo, int * dictLength )
736{
737    int             doFree;
738    tr_bool         didParse;
739    tr_bool         hasInfo = FALSE;
740    tr_info         tmp;
741    const tr_benc * metainfo;
742    tr_session    * session = tr_ctorGetSession( ctor );
743    tr_parse_result result = TR_PARSE_OK;
744
745    if( setmeInfo == NULL )
746        setmeInfo = &tmp;
747    memset( setmeInfo, 0, sizeof( tr_info ) );
748
749    if( tr_ctorGetMetainfo( ctor, &metainfo ) )
750        return TR_PARSE_ERR;
751
752    didParse = tr_metainfoParse( session, metainfo, setmeInfo,
753                                 &hasInfo, dictLength );
754    doFree = didParse && ( setmeInfo == &tmp );
755
756    if( !didParse )
757        result = TR_PARSE_ERR;
758
759    if( didParse && hasInfo && !getBlockSize( setmeInfo->pieceSize ) )
760        result = TR_PARSE_ERR;
761
762    if( didParse && session && tr_torrentExists( session, setmeInfo->hash ) )
763        result = TR_PARSE_DUPLICATE;
764
765    if( doFree )
766        tr_metainfoFree( setmeInfo );
767
768    if( setmeHasInfo != NULL )
769        *setmeHasInfo = hasInfo;
770
771    return result;
772}
773
774tr_parse_result
775tr_torrentParse( const tr_ctor * ctor, tr_info * setmeInfo )
776{
777    return torrentParseImpl( ctor, setmeInfo, NULL, NULL );
778}
779
780tr_torrent *
781tr_torrentNew( const tr_ctor * ctor, int * setmeError )
782{
783    int len;
784    tr_bool hasInfo;
785    tr_info tmpInfo;
786    tr_parse_result r;
787    tr_torrent * tor = NULL;
788
789    assert( ctor != NULL );
790    assert( tr_isSession( tr_ctorGetSession( ctor ) ) );
791
792    r = torrentParseImpl( ctor, &tmpInfo, &hasInfo, &len );
793    if( r == TR_PARSE_OK )
794    {
795        tor = tr_new0( tr_torrent, 1 );
796        tor->info = tmpInfo;
797        if( hasInfo )
798            tor->infoDictLength = len;
799        torrentInit( tor, ctor );
800    }
801    else
802    {
803        if( r == TR_PARSE_DUPLICATE )
804            tr_metainfoFree( &tmpInfo );
805
806        if( setmeError )
807            *setmeError = r;
808    }
809
810    return tor;
811}
812
813/**
814***
815**/
816
817void
818tr_torrentSetDownloadDir( tr_torrent * tor, const char * path )
819{
820    assert( tr_isTorrent( tor  ) );
821
822    if( !path || !tor->downloadDir || strcmp( path, tor->downloadDir ) )
823    {
824        tr_free( tor->downloadDir );
825        tor->downloadDir = tr_strdup( path );
826        tr_torrentSetDirty( tor );
827    }
828
829    refreshCurrentDir( tor );
830}
831
832const char*
833tr_torrentGetDownloadDir( const tr_torrent * tor )
834{
835    assert( tr_isTorrent( tor  ) );
836
837    return tor->downloadDir;
838}
839
840const char *
841tr_torrentGetCurrentDir( const tr_torrent * tor )
842{
843    assert( tr_isTorrent( tor  ) );
844
845    return tor->currentDir;
846}
847
848
849void
850tr_torrentChangeMyPort( tr_torrent * tor )
851{
852    assert( tr_isTorrent( tor  ) );
853
854    if( tor->isRunning )
855        tr_announcerChangeMyPort( tor );
856}
857
858static inline void
859tr_torrentManualUpdateImpl( void * vtor )
860{
861    tr_torrent * tor = vtor;
862
863    assert( tr_isTorrent( tor  ) );
864
865    if( tor->isRunning )
866        tr_announcerManualAnnounce( tor );
867}
868
869void
870tr_torrentManualUpdate( tr_torrent * tor )
871{
872    assert( tr_isTorrent( tor  ) );
873
874    tr_runInEventThread( tor->session, tr_torrentManualUpdateImpl, tor );
875}
876
877tr_bool
878tr_torrentCanManualUpdate( const tr_torrent * tor )
879{
880    return ( tr_isTorrent( tor  ) )
881        && ( tor->isRunning )
882        && ( tr_announcerCanManualAnnounce( tor ) );
883}
884
885const tr_info *
886tr_torrentInfo( const tr_torrent * tor )
887{
888    return tr_isTorrent( tor ) ? &tor->info : NULL;
889}
890
891const tr_stat *
892tr_torrentStatCached( tr_torrent * tor )
893{
894    const time_t now = tr_time( );
895
896    return tr_isTorrent( tor ) && ( now == tor->lastStatTime )
897         ? &tor->stats
898         : tr_torrentStat( tor );
899}
900
901void
902tr_torrentSetVerifyState( tr_torrent * tor, tr_verify_state state )
903{
904    assert( tr_isTorrent( tor ) );
905    assert( state==TR_VERIFY_NONE || state==TR_VERIFY_WAIT || state==TR_VERIFY_NOW );
906
907    tor->verifyState = state;
908    tor->anyDate = tr_time( );
909}
910
911tr_torrent_activity
912tr_torrentGetActivity( tr_torrent * tor )
913{
914    assert( tr_isTorrent( tor ) );
915
916    tr_torrentRecheckCompleteness( tor );
917
918    if( tor->verifyState == TR_VERIFY_NOW )
919        return TR_STATUS_CHECK;
920    if( tor->verifyState == TR_VERIFY_WAIT )
921        return TR_STATUS_CHECK_WAIT;
922    if( !tor->isRunning )
923        return TR_STATUS_STOPPED;
924    if( tor->completeness == TR_LEECH )
925        return TR_STATUS_DOWNLOAD;
926
927    return TR_STATUS_SEED;
928}
929
930const tr_stat *
931tr_torrentStat( tr_torrent * tor )
932{
933    tr_stat *               s;
934    int                     usableSeeds;
935    uint64_t                now;
936    double                  d;
937    uint64_t                seedRatioBytesLeft;
938    uint64_t                seedRatioBytesGoal;
939    tr_bool                 seedRatioApplies;
940
941    if( !tor )
942        return NULL;
943
944    assert( tr_isTorrent( tor ) );
945    tr_torrentLock( tor );
946
947    tor->lastStatTime = tr_time( );
948
949    s = &tor->stats;
950    s->id = tor->uniqueId;
951    s->activity = tr_torrentGetActivity( tor );
952    s->error = tor->error;
953    memcpy( s->errorString, tor->errorString, sizeof( s->errorString ) );
954
955    s->manualAnnounceTime = tr_announcerNextManualAnnounce( tor );
956
957    tr_peerMgrTorrentStats( tor,
958                            &s->peersKnown,
959                            &s->peersConnected,
960                            &usableSeeds,
961                            &s->webseedsSendingToUs,
962                            &s->peersSendingToUs,
963                            &s->peersGettingFromUs,
964                            s->peersFrom );
965
966    now = tr_date( );
967    d = tr_peerMgrGetWebseedSpeed( tor, now );
968    s->rawUploadSpeed     = tr_bandwidthGetRawSpeed  ( tor->bandwidth, now, TR_UP );
969    s->pieceUploadSpeed   = tr_bandwidthGetPieceSpeed( tor->bandwidth, now, TR_UP );
970    s->rawDownloadSpeed   = d + tr_bandwidthGetRawSpeed  ( tor->bandwidth, now, TR_DOWN );
971    s->pieceDownloadSpeed = d + tr_bandwidthGetPieceSpeed( tor->bandwidth, now, TR_DOWN );
972
973    usableSeeds += tor->info.webseedCount;
974
975    s->percentComplete = tr_cpPercentComplete ( &tor->completion );
976    s->metadataPercentComplete = tr_torrentGetMetadataPercent( tor );
977
978    s->percentDone   = tr_cpPercentDone  ( &tor->completion );
979    s->leftUntilDone = tr_cpLeftUntilDone( &tor->completion );
980    s->sizeWhenDone  = tr_cpSizeWhenDone ( &tor->completion );
981
982    s->recheckProgress = s->activity == TR_STATUS_CHECK
983                       ? 1.0 -
984                         ( tr_torrentCountUncheckedPieces( tor ) /
985                           (double) tor->info.pieceCount )
986                       : 0.0;
987
988    s->activityDate = tor->activityDate;
989    s->addedDate    = tor->addedDate;
990    s->doneDate     = tor->doneDate;
991    s->startDate    = tor->startDate;
992
993    s->corruptEver     = tor->corruptCur    + tor->corruptPrev;
994    s->downloadedEver  = tor->downloadedCur + tor->downloadedPrev;
995    s->uploadedEver    = tor->uploadedCur   + tor->uploadedPrev;
996    s->haveValid       = tr_cpHaveValid( &tor->completion );
997    s->haveUnchecked   = tr_cpHaveTotal( &tor->completion ) - s->haveValid;
998
999    if( usableSeeds > 0 )
1000    {
1001        s->desiredAvailable = s->leftUntilDone;
1002    }
1003    else if( !s->leftUntilDone || !s->peersConnected )
1004    {
1005        s->desiredAvailable = 0;
1006    }
1007    else
1008    {
1009        tr_piece_index_t i;
1010        tr_bitfield *    peerPieces = tr_peerMgrGetAvailable( tor );
1011        s->desiredAvailable = 0;
1012        for( i = 0; i < tor->info.pieceCount; ++i )
1013            if( !tor->info.pieces[i].dnd && tr_bitfieldHasFast( peerPieces, i ) )
1014                s->desiredAvailable += tr_cpMissingBlocksInPiece( &tor->completion, i );
1015        s->desiredAvailable *= tor->blockSize;
1016        tr_bitfieldFree( peerPieces );
1017    }
1018
1019    s->ratio = tr_getRatio( s->uploadedEver,
1020                            s->downloadedEver ? s->downloadedEver : s->haveValid );
1021
1022    seedRatioApplies = tr_torrentGetSeedRatioBytes( tor, &seedRatioBytesLeft,
1023                                                         &seedRatioBytesGoal );
1024
1025    switch( s->activity )
1026    {
1027        /* etaXLSpeed exists because if we use the piece speed directly,
1028         * brief fluctuations cause the ETA to jump all over the place.
1029         * so, etaXLSpeed is a smoothed-out version of the piece speed
1030         * to dampen the effect of fluctuations */
1031
1032        case TR_STATUS_DOWNLOAD:
1033            if( ( tor->etaDLSpeedCalculatedAt + 800 ) < now ) {
1034                tor->etaDLSpeed = ( ( tor->etaDLSpeedCalculatedAt + 4000 ) < now )
1035                    ? s->pieceDownloadSpeed /* if no recent previous speed, no need to smooth */
1036                    : 0.8*tor->etaDLSpeed + 0.2*s->pieceDownloadSpeed; /* smooth across 5 readings */
1037                tor->etaDLSpeedCalculatedAt = now;
1038            }
1039
1040            if( s->leftUntilDone > s->desiredAvailable )
1041                s->eta = TR_ETA_NOT_AVAIL;
1042            else if( s->pieceDownloadSpeed < 0.1 )
1043                s->eta = TR_ETA_UNKNOWN;
1044            else
1045                s->eta = s->leftUntilDone / tor->etaDLSpeed / 1024.0;
1046            break;
1047
1048        case TR_STATUS_SEED: {
1049            if( !seedRatioApplies )
1050                s->eta = TR_ETA_NOT_AVAIL;
1051            else {
1052                if( ( tor->etaULSpeedCalculatedAt + 800 ) < now ) {
1053                    tor->etaULSpeed = ( ( tor->etaULSpeedCalculatedAt + 4000 ) < now )
1054                        ? s->pieceUploadSpeed /* if no recent previous speed, no need to smooth */
1055                        : 0.8*tor->etaULSpeed + 0.2*s->pieceUploadSpeed; /* smooth across 5 readings */
1056                    tor->etaULSpeedCalculatedAt = now;
1057                }
1058                if( s->pieceUploadSpeed < 0.1 )
1059                    s->eta = TR_ETA_UNKNOWN;
1060                else
1061                    s->eta = seedRatioBytesLeft / tor->etaULSpeed / 1024.0;
1062            }
1063            break;
1064        }
1065
1066        default:
1067            s->eta = TR_ETA_NOT_AVAIL;
1068            break;
1069    }
1070
1071    /* s->haveValid is here to make sure a torrent isn't marked 'finished'
1072     * when the user hits "uncheck all" prior to starting the torrent... */
1073    s->finished = seedRatioApplies && !seedRatioBytesLeft && s->haveValid;
1074
1075    if( !seedRatioApplies || s->finished )
1076        s->seedRatioPercentDone = 1;
1077    else if( !seedRatioBytesGoal ) /* impossible? safeguard for div by zero */
1078        s->seedRatioPercentDone = 0;
1079    else
1080        s->seedRatioPercentDone = (double)(seedRatioBytesGoal - seedRatioBytesLeft) / seedRatioBytesGoal;
1081
1082    tr_torrentUnlock( tor );
1083
1084    return s;
1085}
1086
1087/***
1088****
1089***/
1090
1091static uint64_t
1092fileBytesCompleted( const tr_torrent * tor, tr_file_index_t index )
1093{
1094    uint64_t total = 0;
1095    const tr_file * f = &tor->info.files[index];
1096
1097    if( f->length )
1098    {
1099        const tr_block_index_t firstBlock = f->offset / tor->blockSize;
1100        const uint64_t lastByte = f->offset + f->length - 1;
1101        const tr_block_index_t lastBlock = lastByte / tor->blockSize;
1102
1103        if( firstBlock == lastBlock )
1104        {
1105            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1106                total = f->length;
1107        }
1108        else
1109        {
1110            tr_block_index_t i;
1111
1112            /* the first block */
1113            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1114                total += tor->blockSize - ( f->offset % tor->blockSize );
1115
1116            /* the middle blocks */
1117            if( f->firstPiece == f->lastPiece )
1118            {
1119                for( i=firstBlock+1; i<lastBlock; ++i )
1120                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1121                        total += tor->blockSize;
1122            }
1123            else
1124            {
1125                uint64_t b = 0;
1126                const tr_block_index_t firstBlockOfLastPiece
1127                           = tr_torPieceFirstBlock( tor, f->lastPiece );
1128                const tr_block_index_t lastBlockOfFirstPiece
1129                           = tr_torPieceFirstBlock( tor, f->firstPiece )
1130                             + tr_torPieceCountBlocks( tor, f->firstPiece ) - 1;
1131
1132                /* the rest of the first piece */
1133                for( i=firstBlock+1; i<lastBlock && i<=lastBlockOfFirstPiece; ++i )
1134                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1135                        ++b;
1136
1137                /* the middle pieces */
1138                if( f->firstPiece + 1 < f->lastPiece )
1139                    for( i=f->firstPiece+1; i<f->lastPiece; ++i )
1140                        b += tor->blockCountInPiece - tr_cpMissingBlocksInPiece( &tor->completion, i );
1141
1142                /* the rest of the last piece */
1143                for( i=firstBlockOfLastPiece; i<lastBlock; ++i )
1144                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1145                        ++b;
1146
1147                b *= tor->blockSize;
1148                total += b;
1149            }
1150
1151            /* the last block */
1152            if( tr_cpBlockIsCompleteFast( &tor->completion, lastBlock ) )
1153                total += ( f->offset + f->length ) - ( tor->blockSize * lastBlock );
1154        }
1155    }
1156
1157    return total;
1158}
1159
1160tr_file_stat *
1161tr_torrentFiles( const tr_torrent * tor,
1162                 tr_file_index_t *  fileCount )
1163{
1164    tr_file_index_t       i;
1165    const tr_file_index_t n = tor->info.fileCount;
1166    tr_file_stat *        files = tr_new0( tr_file_stat, n );
1167    tr_file_stat *        walk = files;
1168    const tr_bool         isSeed = tor->completeness == TR_SEED;
1169
1170    assert( tr_isTorrent( tor ) );
1171
1172    for( i=0; i<n; ++i, ++walk ) {
1173        const uint64_t b = isSeed ? tor->info.files[i].length : fileBytesCompleted( tor, i );
1174        walk->bytesCompleted = b;
1175        walk->progress = tor->info.files[i].length > 0 ? ( (float)b / tor->info.files[i].length ) : 1.0;
1176    }
1177
1178    if( fileCount )
1179        *fileCount = n;
1180
1181    return files;
1182}
1183
1184void
1185tr_torrentFilesFree( tr_file_stat *            files,
1186                     tr_file_index_t fileCount UNUSED )
1187{
1188    tr_free( files );
1189}
1190
1191/***
1192****
1193***/
1194
1195float*
1196tr_torrentWebSpeeds( const tr_torrent * tor )
1197{
1198    return tr_isTorrent( tor )
1199         ? tr_peerMgrWebSpeeds( tor )
1200         : NULL;
1201}
1202
1203tr_peer_stat *
1204tr_torrentPeers( const tr_torrent * tor,
1205                 int *              peerCount )
1206{
1207    tr_peer_stat * ret = NULL;
1208
1209    if( tr_isTorrent( tor ) )
1210        ret = tr_peerMgrPeerStats( tor, peerCount );
1211
1212    return ret;
1213}
1214
1215void
1216tr_torrentPeersFree( tr_peer_stat * peers,
1217                     int peerCount  UNUSED )
1218{
1219    tr_free( peers );
1220}
1221
1222tr_tracker_stat *
1223tr_torrentTrackers( const tr_torrent * torrent,
1224                    int              * setmeTrackerCount )
1225{
1226    assert( tr_isTorrent( torrent ) );
1227
1228    return tr_announcerStats( torrent, setmeTrackerCount );
1229}
1230
1231void
1232tr_torrentTrackersFree( tr_tracker_stat * trackers,
1233                        int trackerCount )
1234{
1235    tr_announcerStatsFree( trackers, trackerCount );
1236}
1237
1238void
1239tr_torrentAvailability( const tr_torrent * tor,
1240                        int8_t *           tab,
1241                        int                size )
1242{
1243    tr_peerMgrTorrentAvailability( tor, tab, size );
1244}
1245
1246void
1247tr_torrentAmountFinished( const tr_torrent * tor,
1248                          float *            tab,
1249                          int                size )
1250{
1251    assert( tr_isTorrent( tor ) );
1252
1253    tr_torrentLock( tor );
1254    tr_cpGetAmountDone( &tor->completion, tab, size );
1255    tr_torrentUnlock( tor );
1256}
1257
1258static void
1259tr_torrentResetTransferStats( tr_torrent * tor )
1260{
1261    assert( tr_isTorrent( tor ) );
1262
1263    tr_torrentLock( tor );
1264
1265    tor->downloadedPrev += tor->downloadedCur;
1266    tor->downloadedCur   = 0;
1267    tor->uploadedPrev   += tor->uploadedCur;
1268    tor->uploadedCur     = 0;
1269    tor->corruptPrev    += tor->corruptCur;
1270    tor->corruptCur      = 0;
1271
1272    tr_torrentSetDirty( tor );
1273
1274    tr_torrentUnlock( tor );
1275}
1276
1277void
1278tr_torrentSetHasPiece( tr_torrent *     tor,
1279                       tr_piece_index_t pieceIndex,
1280                       tr_bool          has )
1281{
1282    assert( tr_isTorrent( tor ) );
1283    assert( pieceIndex < tor->info.pieceCount );
1284
1285    if( has )
1286        tr_cpPieceAdd( &tor->completion, pieceIndex );
1287    else
1288        tr_cpPieceRem( &tor->completion, pieceIndex );
1289}
1290
1291/***
1292****
1293***/
1294
1295static void
1296freeTorrent( tr_torrent * tor )
1297{
1298    tr_torrent * t;
1299    tr_session *  session = tor->session;
1300    tr_info *    inf = &tor->info;
1301
1302    assert( tr_isTorrent( tor ) );
1303    assert( !tor->isRunning );
1304
1305    tr_sessionLock( session );
1306
1307    tr_peerMgrRemoveTorrent( tor );
1308
1309    tr_cpDestruct( &tor->completion );
1310
1311    tr_announcerRemoveTorrent( session->announcer, tor );
1312
1313    tr_bitfieldDestruct( &tor->checkedPieces );
1314
1315    tr_free( tor->downloadDir );
1316    tr_free( tor->incompleteDir );
1317    tr_free( tor->peer_id );
1318
1319    if( tor == session->torrentList )
1320        session->torrentList = tor->next;
1321    else for( t = session->torrentList; t != NULL; t = t->next ) {
1322        if( t->next == tor ) {
1323            t->next = tor->next;
1324            break;
1325        }
1326    }
1327
1328    assert( session->torrentCount >= 1 );
1329    session->torrentCount--;
1330
1331    tr_bandwidthFree( tor->bandwidth );
1332
1333    tr_metainfoFree( inf );
1334    tr_free( tor );
1335
1336    tr_sessionUnlock( session );
1337}
1338
1339/**
1340***  Start/Stop Callback
1341**/
1342
1343static void
1344checkAndStartImpl( void * vtor )
1345{
1346    tr_torrent * tor = vtor;
1347
1348    assert( tr_isTorrent( tor ) );
1349
1350    tr_sessionLock( tor->session );
1351
1352    /** If we had local data before, but it's disappeared,
1353        stop the torrent and log an error. */
1354    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1355    {
1356        tr_torrentSetLocalError( tor, _( "No data found!  Reconnect any disconnected drives, use \"Set Location\", or restart the torrent to re-download." ) );
1357        tr_torrentStop( tor );
1358    }
1359    else
1360    {
1361        const time_t now = tr_time( );
1362        tor->isRunning = TRUE;
1363        tor->completeness = tr_cpGetStatus( &tor->completion );
1364        tor->startDate = tor->anyDate = now;
1365        tr_torrentClearError( tor );
1366
1367        tr_torrentResetTransferStats( tor );
1368        tr_announcerTorrentStarted( tor );
1369        tor->dhtAnnounceAt = now + tr_cryptoWeakRandInt( 20 );
1370        tor->dhtAnnounce6At = now + tr_cryptoWeakRandInt( 20 );
1371        tor->lpdAnnounceAt = now;
1372        tr_peerMgrStartTorrent( tor );
1373    }
1374
1375    tr_sessionUnlock( tor->session );
1376}
1377
1378static void
1379checkAndStartCB( tr_torrent * tor )
1380{
1381    assert( tr_isTorrent( tor ) );
1382    assert( tr_isSession( tor->session ) );
1383
1384    tr_runInEventThread( tor->session, checkAndStartImpl, tor );
1385}
1386
1387static void
1388torrentStart( tr_torrent * tor )
1389{
1390    assert( tr_isTorrent( tor ) );
1391
1392    tr_sessionLock( tor->session );
1393
1394    if( !tor->isRunning )
1395    {
1396        /* allow finished torrents to be resumed */
1397        if( tr_torrentIsSeedRatioDone( tor ) )
1398        {
1399            tr_torinf( tor, "Restarted manually -- disabling its seed ratio" );
1400            tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_UNLIMITED );
1401        }
1402
1403        tr_verifyRemove( tor );
1404
1405        /* corresponds to the peer_id sent as a tracker request parameter.
1406         * one tracker admin says: "When the same torrent is opened and
1407         * closed and opened again without quitting Transmission ...
1408         * change the peerid. It would help sometimes if a stopped event
1409         * was missed to ensure that we didn't think someone was cheating. */
1410        tr_free( tor->peer_id );
1411        tor->peer_id = tr_peerIdNew( );
1412
1413        tor->isRunning = 1;
1414        tr_torrentSetDirty( tor );
1415        tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1416        tr_verifyAdd( tor, checkAndStartCB );
1417    }
1418
1419    tr_sessionUnlock( tor->session );
1420}
1421
1422void
1423tr_torrentStart( tr_torrent * tor )
1424{
1425    if( tr_isTorrent( tor ) )
1426        torrentStart( tor );
1427}
1428
1429static void
1430torrentRecheckDoneImpl( void * vtor )
1431{
1432    tr_torrent * tor = vtor;
1433
1434    assert( tr_isTorrent( tor ) );
1435    tr_torrentRecheckCompleteness( tor );
1436
1437    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1438    {
1439        tr_torrentSetLocalError( tor, _( "Can't find local data.  Try \"Set Location\" to find it, or restart the torrent to re-download." ) );
1440        tr_torrentStop( tor );
1441    }
1442    else if( tor->startAfterVerify )
1443    {
1444        tor->startAfterVerify = FALSE;
1445
1446        tr_torrentStart( tor );
1447    }
1448}
1449
1450static void
1451torrentRecheckDoneCB( tr_torrent * tor )
1452{
1453    assert( tr_isTorrent( tor ) );
1454
1455    tr_runInEventThread( tor->session, torrentRecheckDoneImpl, tor );
1456}
1457
1458static void
1459verifyTorrent( void * vtor )
1460{
1461    tr_torrent * tor = vtor;
1462
1463    assert( tr_isTorrent( tor ) );
1464    tr_sessionLock( tor->session );
1465
1466    /* if the torrent's already being verified, stop it */
1467    tr_verifyRemove( tor );
1468
1469    /* if the torrent's running, stop it & set the restart-after-verify flag */
1470    if( tor->startAfterVerify || tor->isRunning ) {
1471        tr_torrentStop( tor );
1472        tor->startAfterVerify = TRUE;
1473    }
1474
1475    /* add the torrent to the recheck queue */
1476    tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1477    tr_torrentUncheck( tor );
1478    tr_verifyAdd( tor, torrentRecheckDoneCB );
1479
1480    tr_sessionUnlock( tor->session );
1481}
1482
1483void
1484tr_torrentVerify( tr_torrent * tor )
1485{
1486    if( tr_isTorrent( tor ) )
1487        tr_runInEventThread( tor->session, verifyTorrent, tor );
1488}
1489
1490void
1491tr_torrentSave( tr_torrent * tor )
1492{
1493    assert( tr_isTorrent( tor ) );
1494
1495    if( tor->isDirty )
1496    {
1497        tor->isDirty = FALSE;
1498        tr_torrentSaveResume( tor );
1499    }
1500}
1501
1502static void
1503stopTorrent( void * vtor )
1504{
1505    tr_torrent * tor = vtor;
1506    tr_torinf( tor, "Pausing" );
1507
1508    assert( tr_isTorrent( tor ) );
1509
1510    tr_verifyRemove( tor );
1511    tr_peerMgrStopTorrent( tor );
1512    tr_announcerTorrentStopped( tor );
1513    tr_cacheFlushTorrent( tor->session->cache, tor );
1514
1515    tr_fdTorrentClose( tor->session, tor->uniqueId );
1516
1517    if( !tor->isDeleting )
1518        tr_torrentSave( tor );
1519}
1520
1521void
1522tr_torrentStop( tr_torrent * tor )
1523{
1524    assert( tr_isTorrent( tor ) );
1525
1526    if( tr_isTorrent( tor ) )
1527    {
1528        tr_sessionLock( tor->session );
1529
1530        tor->isRunning = 0;
1531        tr_torrentSetDirty( tor );
1532        tr_runInEventThread( tor->session, stopTorrent, tor );
1533
1534        tr_sessionUnlock( tor->session );
1535    }
1536}
1537
1538static void
1539closeTorrent( void * vtor )
1540{
1541    tr_benc * d;
1542    tr_torrent * tor = vtor;
1543
1544    assert( tr_isTorrent( tor ) );
1545
1546    d = tr_bencListAddDict( &tor->session->removedTorrents, 2 );
1547    tr_bencDictAddInt( d, "id", tor->uniqueId );
1548    tr_bencDictAddInt( d, "date", tr_time( ) );
1549
1550    tr_torinf( tor, _( "Removing torrent" ) );
1551
1552    stopTorrent( tor );
1553
1554    if( tor->isDeleting )
1555    {
1556        tr_metainfoRemoveSaved( tor->session, &tor->info );
1557        tr_torrentRemoveResume( tor );
1558    }
1559
1560    tor->isRunning = 0;
1561    freeTorrent( tor );
1562}
1563
1564void
1565tr_torrentFree( tr_torrent * tor )
1566{
1567    if( tr_isTorrent( tor ) )
1568    {
1569        tr_session * session = tor->session;
1570        assert( tr_isSession( session ) );
1571        tr_sessionLock( session );
1572
1573        tr_torrentClearCompletenessCallback( tor );
1574        tr_runInEventThread( session, closeTorrent, tor );
1575
1576        tr_sessionUnlock( session );
1577    }
1578}
1579
1580void
1581tr_torrentRemove( tr_torrent * tor )
1582{
1583    assert( tr_isTorrent( tor ) );
1584
1585    tor->isDeleting = 1;
1586    tr_torrentFree( tor );
1587}
1588
1589/**
1590***  Completeness
1591**/
1592
1593static const char *
1594getCompletionString( int type )
1595{
1596    switch( type )
1597    {
1598        /* Translators: this is a minor point that's safe to skip over, but FYI:
1599           "Complete" and "Done" are specific, different terms in Transmission:
1600           "Complete" means we've downloaded every file in the torrent.
1601           "Done" means we're done downloading the files we wanted, but NOT all
1602           that exist */
1603        case TR_PARTIAL_SEED:
1604            return _( "Done" );
1605
1606        case TR_SEED:
1607            return _( "Complete" );
1608
1609        default:
1610            return _( "Incomplete" );
1611    }
1612}
1613
1614static void
1615fireCompletenessChange( tr_torrent       * tor,
1616                        tr_completeness    status )
1617{
1618    assert( tr_isTorrent( tor ) );
1619    assert( ( status == TR_LEECH )
1620         || ( status == TR_SEED )
1621         || ( status == TR_PARTIAL_SEED ) );
1622
1623    if( tor->completeness_func )
1624        tor->completeness_func( tor, status, tor->completeness_func_user_data );
1625}
1626
1627void
1628tr_torrentSetCompletenessCallback( tr_torrent                    * tor,
1629                                   tr_torrent_completeness_func    func,
1630                                   void                          * user_data )
1631{
1632    assert( tr_isTorrent( tor ) );
1633
1634    tor->completeness_func = func;
1635    tor->completeness_func_user_data = user_data;
1636}
1637
1638void
1639tr_torrentClearCompletenessCallback( tr_torrent * torrent )
1640{
1641    tr_torrentSetCompletenessCallback( torrent, NULL, NULL );
1642}
1643
1644void
1645tr_torrentSetRatioLimitHitCallback( tr_torrent                     * tor,
1646                                    tr_torrent_ratio_limit_hit_func  func,
1647                                    void                           * user_data )
1648{
1649    assert( tr_isTorrent( tor ) );
1650
1651    tor->ratio_limit_hit_func = func;
1652    tor->ratio_limit_hit_func_user_data = user_data;
1653}
1654
1655void
1656tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent )
1657{
1658    tr_torrentSetRatioLimitHitCallback( torrent, NULL, NULL );
1659}
1660
1661
1662static void
1663torrentCallScript( tr_torrent * tor, const char * script )
1664{
1665    assert( tr_isTorrent( tor ) );
1666
1667    if( script && *script )
1668    {
1669        char buf[128];
1670        const time_t now = tr_time( );
1671
1672#ifdef HAVE_CLEARENV
1673        clearenv( );
1674#endif
1675
1676        setenv( "TR_APP_VERSION", SHORT_VERSION_STRING, 1 );
1677
1678        tr_snprintf( buf, sizeof( buf ), "%d", tr_torrentId( tor ) );
1679        setenv( "TR_TORRENT_ID", buf, 1 );
1680        setenv( "TR_TORRENT_NAME", tr_torrentName( tor ), 1 );
1681        setenv( "TR_TORRENT_DIR", tor->currentDir, 1 );
1682        setenv( "TR_TORRENT_HASH", tor->info.hashString, 1 );
1683        tr_strlcpy( buf, ctime( &now ), sizeof( buf ) );
1684        *strchr( buf,'\n' ) = '\0';
1685        setenv( "TR_TIME_LOCALTIME", buf, 1 );
1686        tr_torinf( tor, "Calling script \"%s\"", script );
1687        system( script );
1688    }
1689}
1690
1691void
1692tr_torrentRecheckCompleteness( tr_torrent * tor )
1693{
1694    tr_completeness completeness;
1695
1696    assert( tr_isTorrent( tor ) );
1697
1698    tr_torrentLock( tor );
1699
1700    completeness = tr_cpGetStatus( &tor->completion );
1701
1702    if( completeness != tor->completeness )
1703    {
1704        const int recentChange = tor->downloadedCur != 0;
1705
1706        if( recentChange )
1707        {
1708            tr_torinf( tor, _( "State changed from \"%1$s\" to \"%2$s\"" ),
1709                      getCompletionString( tor->completeness ),
1710                      getCompletionString( completeness ) );
1711        }
1712
1713        tor->completeness = completeness;
1714        tr_fdTorrentClose( tor->session, tor->uniqueId );
1715
1716        if( tr_torrentIsSeed( tor ) )
1717        {
1718            if( recentChange )
1719            {
1720                tr_announcerTorrentCompleted( tor );
1721                tor->doneDate = tor->anyDate = tr_time( );
1722            }
1723
1724            tr_torrentCheckSeedRatio( tor );
1725
1726            if( tor->currentDir == tor->incompleteDir )
1727                tr_torrentSetLocation( tor, tor->downloadDir, TRUE, NULL, NULL );
1728
1729            if( tr_sessionIsTorrentDoneScriptEnabled( tor->session ) )
1730                torrentCallScript( tor, tr_sessionGetTorrentDoneScript( tor->session ) );
1731        }
1732
1733        fireCompletenessChange( tor, completeness );
1734
1735        tr_torrentSetDirty( tor );
1736    }
1737
1738    tr_torrentUnlock( tor );
1739}
1740
1741/***
1742****
1743***/
1744
1745static void
1746tr_torrentFireMetadataCompleted( tr_torrent * tor )
1747{
1748    assert( tr_isTorrent( tor ) );
1749
1750    if( tor->metadata_func )
1751        tor->metadata_func( tor, tor->metadata_func_user_data );
1752}
1753
1754void
1755tr_torrentSetMetadataCallback( tr_torrent                * tor,
1756                               tr_torrent_metadata_func    func,
1757                               void                      * user_data )
1758{
1759    assert( tr_isTorrent( tor ) );
1760
1761    tor->metadata_func = func;
1762    tor->metadata_func_user_data = user_data;
1763}
1764
1765
1766/**
1767***  File priorities
1768**/
1769
1770void
1771tr_torrentInitFilePriority( tr_torrent *    tor,
1772                            tr_file_index_t fileIndex,
1773                            tr_priority_t   priority )
1774{
1775    tr_piece_index_t i;
1776    tr_file *        file;
1777
1778    assert( tr_isTorrent( tor ) );
1779    assert( fileIndex < tor->info.fileCount );
1780    assert( tr_isPriority( priority ) );
1781
1782    file = &tor->info.files[fileIndex];
1783    file->priority = priority;
1784    for( i = file->firstPiece; i <= file->lastPiece; ++i )
1785        tor->info.pieces[i].priority = calculatePiecePriority( tor, i, fileIndex );
1786}
1787
1788void
1789tr_torrentSetFilePriorities( tr_torrent             * tor,
1790                             const tr_file_index_t  * files,
1791                             tr_file_index_t          fileCount,
1792                             tr_priority_t            priority )
1793{
1794    tr_file_index_t i;
1795    assert( tr_isTorrent( tor ) );
1796    tr_torrentLock( tor );
1797
1798    for( i = 0; i < fileCount; ++i )
1799        if( files[i] < tor->info.fileCount )
1800            tr_torrentInitFilePriority( tor, files[i], priority );
1801    tr_torrentSetDirty( tor );
1802    tr_peerMgrRebuildRequests( tor );
1803
1804    tr_torrentUnlock( tor );
1805}
1806
1807tr_priority_t*
1808tr_torrentGetFilePriorities( const tr_torrent * tor )
1809{
1810    tr_file_index_t i;
1811    tr_priority_t * p;
1812
1813    assert( tr_isTorrent( tor ) );
1814
1815    tr_torrentLock( tor );
1816    p = tr_new0( tr_priority_t, tor->info.fileCount );
1817    for( i = 0; i < tor->info.fileCount; ++i )
1818        p[i] = tor->info.files[i].priority;
1819    tr_torrentUnlock( tor );
1820
1821    return p;
1822}
1823
1824/**
1825***  File DND
1826**/
1827
1828static void
1829setFileDND( tr_torrent * tor, tr_file_index_t fileIndex, int doDownload )
1830{
1831    tr_file *        file;
1832    const int        dnd = !doDownload;
1833    tr_piece_index_t firstPiece, firstPieceDND;
1834    tr_piece_index_t lastPiece, lastPieceDND;
1835    tr_file_index_t  i;
1836
1837    assert( tr_isTorrent( tor ) );
1838
1839    file = &tor->info.files[fileIndex];
1840    file->dnd = dnd;
1841    firstPiece = file->firstPiece;
1842    lastPiece = file->lastPiece;
1843
1844    /* can't set the first piece to DND unless
1845       every file using that piece is DND */
1846    firstPieceDND = dnd;
1847    if( fileIndex > 0 )
1848    {
1849        for( i = fileIndex - 1; firstPieceDND; --i )
1850        {
1851            if( tor->info.files[i].lastPiece != firstPiece )
1852                break;
1853            firstPieceDND = tor->info.files[i].dnd;
1854            if( !i )
1855                break;
1856        }
1857    }
1858
1859    /* can't set the last piece to DND unless
1860       every file using that piece is DND */
1861    lastPieceDND = dnd;
1862    for( i = fileIndex + 1; lastPieceDND && i < tor->info.fileCount; ++i )
1863    {
1864        if( tor->info.files[i].firstPiece != lastPiece )
1865            break;
1866        lastPieceDND = tor->info.files[i].dnd;
1867    }
1868
1869    if( firstPiece == lastPiece )
1870    {
1871        tor->info.pieces[firstPiece].dnd = firstPieceDND && lastPieceDND;
1872    }
1873    else
1874    {
1875        tr_piece_index_t pp;
1876        tor->info.pieces[firstPiece].dnd = firstPieceDND;
1877        tor->info.pieces[lastPiece].dnd = lastPieceDND;
1878        for( pp = firstPiece + 1; pp < lastPiece; ++pp )
1879            tor->info.pieces[pp].dnd = dnd;
1880    }
1881}
1882
1883void
1884tr_torrentInitFileDLs( tr_torrent             * tor,
1885                       const tr_file_index_t  * files,
1886                       tr_file_index_t          fileCount,
1887                       tr_bool                  doDownload )
1888{
1889    tr_file_index_t i;
1890
1891    assert( tr_isTorrent( tor ) );
1892
1893    tr_torrentLock( tor );
1894
1895    for( i=0; i<fileCount; ++i )
1896        if( files[i] < tor->info.fileCount )
1897            setFileDND( tor, files[i], doDownload );
1898
1899    tr_cpInvalidateDND( &tor->completion );
1900
1901    tr_torrentUnlock( tor );
1902}
1903
1904void
1905tr_torrentSetFileDLs( tr_torrent             * tor,
1906                      const tr_file_index_t  * files,
1907                      tr_file_index_t          fileCount,
1908                      tr_bool                  doDownload )
1909{
1910    assert( tr_isTorrent( tor ) );
1911    tr_torrentLock( tor );
1912
1913    tr_torrentInitFileDLs( tor, files, fileCount, doDownload );
1914    tr_torrentSetDirty( tor );
1915    tr_peerMgrRebuildRequests( tor );
1916
1917    tr_torrentUnlock( tor );
1918}
1919
1920/***
1921****
1922***/
1923
1924tr_priority_t
1925tr_torrentGetPriority( const tr_torrent * tor )
1926{
1927    assert( tr_isTorrent( tor ) );
1928
1929    return tor->bandwidth->priority;
1930}
1931
1932void
1933tr_torrentSetPriority( tr_torrent * tor, tr_priority_t priority )
1934{
1935    assert( tr_isTorrent( tor ) );
1936    assert( tr_isPriority( priority ) );
1937
1938    if( tor->bandwidth->priority != priority )
1939    {
1940        tor->bandwidth->priority = priority;
1941
1942        tr_torrentSetDirty( tor );
1943    }
1944}
1945
1946/***
1947****
1948***/
1949
1950void
1951tr_torrentSetPeerLimit( tr_torrent * tor,
1952                        uint16_t     maxConnectedPeers )
1953{
1954    assert( tr_isTorrent( tor ) );
1955
1956    if ( tor->maxConnectedPeers != maxConnectedPeers )
1957    {
1958        tor->maxConnectedPeers = maxConnectedPeers;
1959
1960        tr_torrentSetDirty( tor );
1961    }
1962}
1963
1964uint16_t
1965tr_torrentGetPeerLimit( const tr_torrent * tor )
1966{
1967    assert( tr_isTorrent( tor ) );
1968
1969    return tor->maxConnectedPeers;
1970}
1971
1972/***
1973****
1974***/
1975
1976tr_block_index_t
1977_tr_block( const tr_torrent * tor,
1978           tr_piece_index_t   index,
1979           uint32_t           offset )
1980{
1981    tr_block_index_t ret;
1982
1983    assert( tr_isTorrent( tor ) );
1984
1985    ret = index;
1986    ret *= ( tor->info.pieceSize / tor->blockSize );
1987    ret += offset / tor->blockSize;
1988    return ret;
1989}
1990
1991tr_bool
1992tr_torrentReqIsValid( const tr_torrent * tor,
1993                      tr_piece_index_t   index,
1994                      uint32_t           offset,
1995                      uint32_t           length )
1996{
1997    int err = 0;
1998
1999    assert( tr_isTorrent( tor ) );
2000
2001    if( index >= tor->info.pieceCount )
2002        err = 1;
2003    else if( length < 1 )
2004        err = 2;
2005    else if( ( offset + length ) > tr_torPieceCountBytes( tor, index ) )
2006        err = 3;
2007    else if( length > MAX_BLOCK_SIZE )
2008        err = 4;
2009    else if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
2010        err = 5;
2011
2012    if( err ) tr_tordbg( tor, "index %lu offset %lu length %lu err %d\n",
2013                              (unsigned long)index,
2014                              (unsigned long)offset,
2015                              (unsigned long)length,
2016                              err );
2017
2018    return !err;
2019}
2020
2021uint64_t
2022tr_pieceOffset( const tr_torrent * tor,
2023                tr_piece_index_t   index,
2024                uint32_t           offset,
2025                uint32_t           length )
2026{
2027    uint64_t ret;
2028
2029    assert( tr_isTorrent( tor ) );
2030
2031    ret = tor->info.pieceSize;
2032    ret *= index;
2033    ret += offset;
2034    ret += length;
2035    return ret;
2036}
2037
2038/***
2039****
2040***/
2041
2042void
2043tr_torrentSetPieceChecked( tr_torrent        * tor,
2044                           tr_piece_index_t    piece,
2045                           tr_bool             isChecked )
2046{
2047    assert( tr_isTorrent( tor ) );
2048
2049    if( isChecked )
2050        tr_bitfieldAdd( &tor->checkedPieces, piece );
2051    else
2052        tr_bitfieldRem( &tor->checkedPieces, piece );
2053}
2054
2055void
2056tr_torrentSetFileChecked( tr_torrent *    tor,
2057                          tr_file_index_t fileIndex,
2058                          tr_bool         isChecked )
2059{
2060    const tr_file *        file = &tor->info.files[fileIndex];
2061    const tr_piece_index_t begin = file->firstPiece;
2062    const tr_piece_index_t end = file->lastPiece + 1;
2063
2064    assert( tr_isTorrent( tor ) );
2065
2066    if( isChecked )
2067        tr_bitfieldAddRange( &tor->checkedPieces, begin, end );
2068    else
2069        tr_bitfieldRemRange( &tor->checkedPieces, begin, end );
2070}
2071
2072tr_bool
2073tr_torrentIsFileChecked( const tr_torrent * tor,
2074                         tr_file_index_t    fileIndex )
2075{
2076    const tr_file *        file = &tor->info.files[fileIndex];
2077    const tr_piece_index_t begin = file->firstPiece;
2078    const tr_piece_index_t end = file->lastPiece + 1;
2079    tr_piece_index_t       i;
2080    tr_bool                isChecked = TRUE;
2081
2082    assert( tr_isTorrent( tor ) );
2083
2084    for( i = begin; isChecked && i < end; ++i )
2085        if( !tr_torrentIsPieceChecked( tor, i ) )
2086            isChecked = FALSE;
2087
2088    return isChecked;
2089}
2090
2091void
2092tr_torrentUncheck( tr_torrent * tor )
2093{
2094    assert( tr_isTorrent( tor ) );
2095
2096    tr_bitfieldRemRange( &tor->checkedPieces, 0, tor->info.pieceCount );
2097}
2098
2099int
2100tr_torrentCountUncheckedPieces( const tr_torrent * tor )
2101{
2102    assert( tr_isTorrent( tor ) );
2103
2104    return tor->info.pieceCount - tr_bitfieldCountTrueBits( &tor->checkedPieces );
2105}
2106
2107time_t*
2108tr_torrentGetMTimes( const tr_torrent * tor, size_t * setme_n )
2109{
2110    size_t       i;
2111    const size_t n = tor->info.fileCount;
2112    time_t *     m = tr_new0( time_t, n );
2113
2114    assert( tr_isTorrent( tor ) );
2115
2116    for( i = 0; i < n; ++i )
2117    {
2118        struct stat sb;
2119        char * path = tr_torrentFindFile( tor, i );
2120        if( ( path != NULL ) && !stat( path, &sb ) && S_ISREG( sb.st_mode ) )
2121        {
2122#ifdef SYS_DARWIN
2123            m[i] = sb.st_mtimespec.tv_sec;
2124#else
2125            m[i] = sb.st_mtime;
2126#endif
2127        }
2128        tr_free( path );
2129    }
2130
2131    *setme_n = n;
2132    return m;
2133}
2134
2135/***
2136****
2137***/
2138
2139tr_bool
2140tr_torrentSetAnnounceList( tr_torrent             * tor,
2141                           const tr_tracker_info  * trackers,
2142                           int                      trackerCount )
2143{
2144    int i;
2145    tr_benc metainfo;
2146    tr_bool ok = TRUE;
2147    tr_torrentLock( tor );
2148
2149    assert( tr_isTorrent( tor ) );
2150
2151    /* look for bad URLs */
2152    for( i=0; ok && i<trackerCount; ++i )
2153        if( !tr_urlIsValidTracker( trackers[i].announce ) )
2154            ok = FALSE;
2155
2156    /* save to the .torrent file */
2157    if( ok && !tr_bencLoadFile( &metainfo, TR_FMT_BENC, tor->info.torrent ) )
2158    {
2159        tr_bool hasInfo;
2160        tr_info tmpInfo;
2161
2162        /* remove the old fields */
2163        tr_bencDictRemove( &metainfo, "announce" );
2164        tr_bencDictRemove( &metainfo, "announce-list" );
2165
2166        /* add the new fields */
2167        if( trackerCount > 0 )
2168        {
2169            tr_bencDictAddStr( &metainfo, "announce", trackers[0].announce );
2170        }
2171        if( trackerCount > 1 )
2172        {
2173            int i;
2174            int prevTier = -1;
2175            tr_benc * tier = NULL;
2176            tr_benc * announceList = tr_bencDictAddList( &metainfo, "announce-list", 0 );
2177
2178            for( i=0; i<trackerCount; ++i ) {
2179                if( prevTier != trackers[i].tier ) {
2180                    prevTier = trackers[i].tier;
2181                    tier = tr_bencListAddList( announceList, 0 );
2182                }
2183                tr_bencListAddStr( tier, trackers[i].announce );
2184            }
2185        }
2186
2187        /* try to parse it back again, to make sure it's good */
2188        memset( &tmpInfo, 0, sizeof( tr_info ) );
2189        if( tr_metainfoParse( tor->session, &metainfo, &tmpInfo,
2190                              &hasInfo, &tor->infoDictLength ) )
2191        {
2192            /* it's good, so keep these new trackers and free the old ones */
2193
2194            tr_info swap;
2195            swap.trackers = tor->info.trackers;
2196            swap.trackerCount = tor->info.trackerCount;
2197            tor->info.trackers = tmpInfo.trackers;
2198            tor->info.trackerCount = tmpInfo.trackerCount;
2199            tmpInfo.trackers = swap.trackers;
2200            tmpInfo.trackerCount = swap.trackerCount;
2201
2202            tr_metainfoFree( &tmpInfo );
2203            tr_bencToFile( &metainfo, TR_FMT_BENC, tor->info.torrent );
2204        }
2205
2206        /* cleanup */
2207        tr_bencFree( &metainfo );
2208
2209        /* if we had a tracker-related error on this torrent,
2210         * and that tracker's been removed,
2211         * then clear the error */
2212        if(    ( tor->error == TR_STAT_TRACKER_WARNING )
2213            || ( tor->error == TR_STAT_TRACKER_ERROR ) )
2214        {
2215            tr_bool clear = TRUE;
2216
2217            for( i=0; clear && i<trackerCount; ++i )
2218                if( !strcmp( trackers[i].announce, tor->errorTracker ) )
2219                    clear = FALSE;
2220
2221            if( clear )
2222                tr_torrentClearError( tor );
2223        }
2224
2225        /* tell the announcer to reload this torrent's tracker list */
2226        tr_announcerResetTorrent( tor->session->announcer, tor );
2227    }
2228
2229    tr_torrentUnlock( tor );
2230    return ok;
2231}
2232
2233/**
2234***
2235**/
2236
2237void
2238tr_torrentSetAddedDate( tr_torrent * tor,
2239                        time_t       t )
2240{
2241    assert( tr_isTorrent( tor ) );
2242
2243    tor->addedDate = t;
2244    tor->anyDate = MAX( tor->anyDate, tor->addedDate );
2245}
2246
2247void
2248tr_torrentSetActivityDate( tr_torrent * tor, time_t t )
2249{
2250    assert( tr_isTorrent( tor ) );
2251
2252    tor->activityDate = t;
2253    tor->anyDate = MAX( tor->anyDate, tor->activityDate );
2254}
2255
2256void
2257tr_torrentSetDoneDate( tr_torrent * tor,
2258                       time_t       t )
2259{
2260    assert( tr_isTorrent( tor ) );
2261
2262    tor->doneDate = t;
2263    tor->anyDate = MAX( tor->anyDate, tor->doneDate );
2264}
2265
2266/**
2267***
2268**/
2269
2270uint64_t
2271tr_torrentGetBytesLeftToAllocate( const tr_torrent * tor )
2272{
2273    tr_file_index_t i;
2274    uint64_t bytesLeft = 0;
2275
2276    assert( tr_isTorrent( tor ) );
2277
2278    for( i=0; i<tor->info.fileCount; ++i )
2279    {
2280        if( !tor->info.files[i].dnd )
2281        {
2282            struct stat sb;
2283            const uint64_t length = tor->info.files[i].length;
2284            char * path = tr_torrentFindFile( tor, i );
2285
2286            bytesLeft += length;
2287
2288            if( ( path != NULL ) && !stat( path, &sb )
2289                                 && S_ISREG( sb.st_mode )
2290                                 && ( (uint64_t)sb.st_size <= length ) )
2291                bytesLeft -= sb.st_size;
2292
2293            tr_free( path );
2294        }
2295    }
2296
2297    return bytesLeft;
2298}
2299
2300/****
2301*****  Removing the torrent's local data
2302****/
2303
2304static int
2305vstrcmp( const void * a, const void * b )
2306{
2307    return strcmp( a, b );
2308}
2309
2310static int
2311compareLongestFirst( const void * a, const void * b )
2312{
2313    const size_t alen = strlen( a );
2314    const size_t blen = strlen( b );
2315
2316    if( alen != blen )
2317        return alen > blen ? -1 : 1;
2318
2319    return vstrcmp( a, b );
2320}
2321
2322static void
2323addDirtyFile( const char  * root,
2324              const char  * filename,
2325              tr_ptrArray * dirtyFolders )
2326{
2327    char * dir = tr_dirname( filename );
2328
2329    /* add the parent folders to dirtyFolders until we reach the root or a known-dirty */
2330    while (     ( dir != NULL )
2331             && ( strlen( root ) <= strlen( dir ) )
2332             && ( tr_ptrArrayFindSorted( dirtyFolders, dir, vstrcmp ) == NULL ) )
2333    {
2334        char * tmp;
2335        tr_ptrArrayInsertSorted( dirtyFolders, tr_strdup( dir ), vstrcmp );
2336
2337        tmp = tr_dirname( dir );
2338        tr_free( dir );
2339        dir = tmp;
2340    }
2341
2342    tr_free( dir );
2343}
2344
2345static void
2346walkLocalData( const tr_torrent * tor,
2347               const char       * root,
2348               const char       * dir,
2349               const char       * base,
2350               tr_ptrArray      * torrentFiles,
2351               tr_ptrArray      * folders,
2352               tr_ptrArray      * dirtyFolders )
2353{
2354    int i;
2355    struct stat sb;
2356    char * buf;
2357
2358    assert( tr_isTorrent( tor ) );
2359
2360    buf = tr_buildPath( dir, base, NULL );
2361    i = stat( buf, &sb );
2362    if( !i )
2363    {
2364        DIR * odir = NULL;
2365
2366        if( S_ISDIR( sb.st_mode ) && ( ( odir = opendir ( buf ) ) ) )
2367        {
2368            struct dirent *d;
2369            tr_ptrArrayInsertSorted( folders, tr_strdup( buf ), vstrcmp );
2370            for( d = readdir( odir ); d != NULL; d = readdir( odir ) )
2371                if( d->d_name && strcmp( d->d_name, "." ) && strcmp( d->d_name, ".." ) )
2372                    walkLocalData( tor, root, buf, d->d_name, torrentFiles, folders, dirtyFolders );
2373            closedir( odir );
2374        }
2375        else if( S_ISREG( sb.st_mode ) && ( sb.st_size > 0 ) )
2376        {
2377            const char * sub = buf + strlen( tor->currentDir ) + strlen( TR_PATH_DELIMITER_STR );
2378            const tr_bool isTorrentFile = tr_ptrArrayFindSorted( torrentFiles, sub, vstrcmp ) != NULL;
2379            if( !isTorrentFile )
2380                addDirtyFile( root, buf, dirtyFolders );
2381        }
2382    }
2383
2384    tr_free( buf );
2385}
2386
2387static void
2388deleteLocalFile( const char * filename, tr_fileFunc fileFunc )
2389{
2390    struct stat sb;
2391    if( !stat( filename, &sb ) ) /* if file exists... */
2392        fileFunc( filename );
2393}
2394
2395static void
2396deleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2397{
2398    int i, n;
2399    char ** s;
2400    tr_file_index_t f;
2401    tr_ptrArray torrentFiles = TR_PTR_ARRAY_INIT;
2402    tr_ptrArray folders      = TR_PTR_ARRAY_INIT;
2403    tr_ptrArray dirtyFolders = TR_PTR_ARRAY_INIT; /* dirty == contains non-torrent files */
2404
2405    const char * firstFile = tor->info.files[0].name;
2406    const char * cpch = strchr( firstFile, TR_PATH_DELIMITER );
2407    char * tmp = cpch ? tr_strndup( firstFile, cpch - firstFile ) : NULL;
2408    char * root = tr_buildPath( tor->currentDir, tmp, NULL );
2409
2410    assert( tr_isTorrent( tor ) );
2411
2412    for( f=0; f<tor->info.fileCount; ++f ) {
2413        tr_ptrArrayInsertSorted( &torrentFiles, tr_strdup( tor->info.files[f].name ), vstrcmp );
2414        tr_ptrArrayInsertSorted( &torrentFiles, tr_torrentBuildPartial( tor, f ), vstrcmp );
2415    }
2416
2417    /* build the set of folders and dirtyFolders */
2418    walkLocalData( tor, root, root, NULL, &torrentFiles, &folders, &dirtyFolders );
2419
2420    /* try to remove entire folders first, so that the recycle bin will be tidy */
2421    s = (char**) tr_ptrArrayPeek( &folders, &n );
2422    for( i=0; i<n; ++i )
2423        if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2424            deleteLocalFile( s[i], fileFunc );
2425
2426    /* now blow away any remaining torrent files, such as torrent files in dirty folders */
2427    for( i=0, n=tr_ptrArraySize( &torrentFiles ); i<n; ++i ) {
2428        char * path = tr_buildPath( tor->currentDir, tr_ptrArrayNth( &torrentFiles, i ), NULL );
2429        deleteLocalFile( path, fileFunc );
2430        tr_free( path );
2431    }
2432
2433    /* Now clean out the directories left empty from the previous step.
2434     * Work from deepest to shallowest s.t. lower folders
2435     * won't prevent the upper folders from being deleted */
2436    {
2437        tr_ptrArray cleanFolders = TR_PTR_ARRAY_INIT;
2438        s = (char**) tr_ptrArrayPeek( &folders, &n );
2439        for( i=0; i<n; ++i )
2440            if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2441                tr_ptrArrayInsertSorted( &cleanFolders, s[i], compareLongestFirst );
2442        s = (char**) tr_ptrArrayPeek( &cleanFolders, &n );
2443        for( i=0; i<n; ++i ) {
2444#ifdef SYS_DARWIN
2445            char * dsStore = tr_buildPath( s[i], ".DS_Store", NULL );
2446            deleteLocalFile( dsStore, fileFunc );
2447            tr_free( dsStore );
2448#endif
2449            deleteLocalFile( s[i], fileFunc );
2450        }
2451        tr_ptrArrayDestruct( &cleanFolders, NULL );
2452    }
2453
2454    /* cleanup */
2455    tr_ptrArrayDestruct( &dirtyFolders, tr_free );
2456    tr_ptrArrayDestruct( &folders, tr_free );
2457    tr_ptrArrayDestruct( &torrentFiles, tr_free );
2458    tr_free( root );
2459    tr_free( tmp );
2460}
2461
2462void
2463tr_torrentDeleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2464{
2465    assert( tr_isTorrent( tor ) );
2466
2467    if( fileFunc == NULL )
2468        fileFunc = remove;
2469
2470    /* close all the files because we're about to delete them */
2471    tr_fdTorrentClose( tor->session, tor->uniqueId );
2472
2473    if( tor->info.fileCount > 1 )
2474    {
2475        deleteLocalData( tor, fileFunc );
2476    }
2477    else if( tor->info.fileCount == 1 )
2478    {
2479        char * tmp;
2480
2481        /* torrent only has one file */
2482        char * path = tr_buildPath( tor->currentDir, tor->info.files[0].name, NULL );
2483        deleteLocalFile( path, fileFunc );
2484        tr_free( path );
2485
2486        tmp = tr_torrentBuildPartial( tor, 0 );
2487        path = tr_buildPath( tor->currentDir, tmp, NULL );
2488        deleteLocalFile( path, fileFunc );
2489        tr_free( path );
2490        tr_free( tmp );
2491    }
2492}
2493
2494/***
2495****
2496***/
2497
2498struct LocationData
2499{
2500    tr_bool move_from_old_location;
2501    int * setme_state;
2502    double * setme_progress;
2503    char * location;
2504    tr_torrent * tor;
2505};
2506
2507static tr_bool
2508isSameLocation( const char * path1, const char * path2 )
2509{
2510    struct stat s1, s2;
2511    const int err1 = stat( path1, &s1 );
2512    const int err2 = stat( path2, &s2 );
2513
2514    if( !err1 && !err2 ) {
2515        tr_dbg( "path1 dev:inode is %"PRIu64":%"PRIu64"; "
2516                "path2 dev:inode is %"PRIu64":%"PRIu64,
2517                (uint64_t)s1.st_dev, (uint64_t)s1.st_ino,
2518                (uint64_t)s2.st_dev, (uint64_t)s2.st_ino );
2519        return ( s1.st_dev == s2.st_dev )
2520            && ( s1.st_ino == s2.st_ino );
2521    }
2522
2523    /* either one, or the other, or both don't exist... */
2524    tr_dbg( "stat(%s) returned %d\n", path1, err1 );
2525    tr_dbg( "stat(%s) returned %d\n", path2, err2 );
2526    return FALSE;
2527}
2528
2529static void
2530setLocation( void * vdata )
2531{
2532    tr_bool err = FALSE;
2533    tr_bool verify_needed = FALSE;
2534    struct LocationData * data = vdata;
2535    tr_torrent * tor = data->tor;
2536    const tr_bool do_move = data->move_from_old_location;
2537    const char * location = data->location;
2538    double bytesHandled = 0;
2539
2540    assert( tr_isTorrent( tor ) );
2541
2542    tr_dbg( "Moving \"%s\" location from currentDir \"%s\" to \"%s\"",
2543            tr_torrentName(tor), tor->currentDir, location );
2544
2545    tr_mkdirp( location, 0777 );
2546
2547    if( !isSameLocation( location, tor->currentDir ) )
2548    {
2549        tr_file_index_t i;
2550
2551        /* bad idea to move files while they're being verified... */
2552        tr_verifyRemove( tor );
2553
2554        /* if the torrent is running, stop it and set a flag to
2555         * restart after we're done */
2556        if( tor->isRunning )
2557        {
2558            tr_torrentStop( tor );
2559            tor->startAfterVerify = TRUE;
2560        }
2561
2562        /* try to move the files.
2563         * FIXME: there are still all kinds of nasty cases, like what
2564         * if the target directory runs out of space halfway through... */
2565        for( i=0; !err && i<tor->info.fileCount; ++i )
2566        {
2567            const tr_file * f = &tor->info.files[i];
2568            const char * oldbase;
2569            char * sub;
2570            if( tr_torrentFindFile2( tor, i, &oldbase, &sub ) )
2571            {
2572                char * oldpath = tr_buildPath( oldbase, sub, NULL );
2573                char * newpath = tr_buildPath( location, sub, NULL );
2574
2575                tr_dbg( "Found file #%d: %s", (int)i, oldpath );
2576
2577                if( do_move )
2578                {
2579                    tr_bool renamed = FALSE;
2580                    errno = 0;
2581                    tr_torinf( tor, "moving \"%s\" to \"%s\"", oldpath, newpath );
2582                    if( tr_moveFile( oldpath, newpath, &renamed ) )
2583                    {
2584                        err = TRUE;
2585                        tr_torerr( tor, "error moving \"%s\" to \"%s\": %s",
2586                                        oldpath, newpath, tr_strerror( errno ) );
2587                    }
2588                    else if( !renamed )
2589                    {
2590                        verify_needed = TRUE;
2591                    }
2592                }
2593
2594                tr_free( newpath );
2595                tr_free( oldpath );
2596                tr_free( sub );
2597            }
2598
2599            if( data->setme_progress )
2600            {
2601                bytesHandled += f->length;
2602                *data->setme_progress = bytesHandled / tor->info.totalSize;
2603            }
2604        }
2605
2606        if( !err )
2607        {
2608            /* blow away the leftover subdirectories in the old location */
2609            if( do_move )
2610                tr_torrentDeleteLocalData( tor, remove );
2611
2612            /* set the new location and reverify */
2613            tr_torrentSetDownloadDir( tor, location );
2614            if( verify_needed )
2615                tr_torrentVerify( tor );
2616            else if( tor->startAfterVerify ) {
2617                tor->startAfterVerify = FALSE;
2618                tr_torrentStart( tor );
2619            }
2620        }
2621    }
2622
2623    if( !err && do_move )
2624    {
2625        tr_free( tor->incompleteDir );
2626        tor->incompleteDir = NULL;
2627        tor->currentDir = tor->downloadDir;
2628    }
2629
2630    if( data->setme_state )
2631        *data->setme_state = err ? TR_LOC_ERROR : TR_LOC_DONE;
2632
2633    /* cleanup */
2634    tr_free( data->location );
2635    tr_free( data );
2636}
2637
2638void
2639tr_torrentSetLocation( tr_torrent  * tor,
2640                       const char  * location,
2641                       tr_bool       move_from_old_location,
2642                       double      * setme_progress,
2643                       int         * setme_state )
2644{
2645    struct LocationData * data;
2646
2647    assert( tr_isTorrent( tor ) );
2648
2649    if( setme_state )
2650        *setme_state = TR_LOC_MOVING;
2651    if( setme_progress )
2652        *setme_progress = 0;
2653
2654    /* run this in the libtransmission thread */
2655    data = tr_new( struct LocationData, 1 );
2656    data->tor = tor;
2657    data->location = tr_strdup( location );
2658    data->move_from_old_location = move_from_old_location;
2659    data->setme_state = setme_state;
2660    data->setme_progress = setme_progress;
2661    tr_runInEventThread( tor->session, setLocation, data );
2662}
2663
2664/***
2665****
2666***/
2667
2668void
2669tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNum )
2670{
2671    char * sub;
2672    const char * base;
2673
2674    /* close the file so that we can reopen in read-only mode as needed */
2675    tr_fdFileClose( tor->session, tor, fileNum );
2676
2677    /* if the torrent's current filename isn't the same as the one in the
2678     * metadata -- for example, if it had the ".part" suffix appended to
2679     * it until now -- then rename it to match the one in the metadata */
2680    if( tr_torrentFindFile2( tor, fileNum, &base, &sub ) )
2681    {
2682        const tr_file * file = &tor->info.files[fileNum];
2683
2684        if( strcmp( sub, file->name ) )
2685        {
2686            char * oldpath = tr_buildPath( base, sub, NULL );
2687            char * newpath = tr_buildPath( base, file->name, NULL );
2688
2689            if( rename( oldpath, newpath ) )
2690                tr_torerr( tor, "Error moving \"%s\" to \"%s\": %s", oldpath, newpath, tr_strerror( errno ) );
2691
2692            tr_free( newpath );
2693            tr_free( oldpath );
2694        }
2695
2696        tr_free( sub );
2697    }
2698}
2699
2700/***
2701****
2702***/
2703
2704static tr_bool
2705fileExists( const char * filename )
2706{
2707    struct stat sb;
2708    const tr_bool ok = !stat( filename, &sb );
2709    return ok;
2710}
2711
2712tr_bool
2713tr_torrentFindFile2( const tr_torrent * tor, tr_file_index_t fileNum,
2714                     const char ** base, char ** subpath )
2715{
2716    char * part;
2717    const tr_file * file;
2718    const char * b = NULL;
2719    const char * s = NULL;
2720
2721    assert( tr_isTorrent( tor ) );
2722    assert( fileNum < tor->info.fileCount );
2723
2724    file = &tor->info.files[fileNum];
2725    part = tr_torrentBuildPartial( tor, fileNum );
2726
2727    if( b == NULL ) {
2728        char * filename = tr_buildPath( tor->downloadDir, file->name, NULL );
2729        if( fileExists( filename ) ) {
2730            b = tor->downloadDir;
2731            s = file->name;
2732        }
2733        tr_free( filename );
2734    }
2735
2736    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2737        char * filename = tr_buildPath( tor->incompleteDir, file->name, NULL );
2738        if( fileExists( filename ) ) {
2739            b = tor->incompleteDir;
2740            s = file->name;
2741        }
2742        tr_free( filename );
2743    }
2744
2745    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2746        char * filename = tr_buildPath( tor->incompleteDir, part, NULL );
2747        if( fileExists( filename ) ) {
2748            b = tor->incompleteDir;
2749            s = part;
2750        }
2751        tr_free( filename );
2752    }
2753
2754    if( b == NULL) {
2755        char * filename = tr_buildPath( tor->downloadDir, part, NULL );
2756        if( fileExists( filename ) ) {
2757            b = tor->downloadDir;
2758            s = part;
2759        }
2760        tr_free( filename );
2761    }
2762
2763    if( base != NULL )
2764        *base = b;
2765    if( subpath != NULL )
2766        *subpath = tr_strdup( s );
2767
2768    tr_free( part );
2769    return b != NULL;
2770}
2771
2772char*
2773tr_torrentFindFile( const tr_torrent * tor, tr_file_index_t fileNum )
2774{
2775    char * subpath;
2776    char * ret = NULL;
2777    const char * base;
2778
2779    if( tr_torrentFindFile2( tor, fileNum, &base, &subpath ) )
2780    {
2781        ret = tr_buildPath( base, subpath, NULL );
2782        tr_free( subpath );
2783    }
2784
2785    return ret;
2786}
2787
2788/* Decide whether we should be looking for files in downloadDir or incompleteDir. */
2789static void
2790refreshCurrentDir( tr_torrent * tor )
2791{
2792    const char * dir = NULL;
2793    char * sub;
2794
2795    if( tor->incompleteDir == NULL )
2796        dir = tor->downloadDir;
2797    else if( !tr_torrentHasMetadata( tor ) ) /* no files to find */
2798        dir = tor->incompleteDir;
2799    else if( !tr_torrentFindFile2( tor, 0, &dir, &sub ) )
2800        dir = tor->incompleteDir;
2801
2802    assert( dir != NULL );
2803    assert( ( dir == tor->downloadDir ) || ( dir == tor->incompleteDir ) );
2804    tor->currentDir = dir;
2805}
2806
2807char*
2808tr_torrentBuildPartial( const tr_torrent * tor, tr_file_index_t fileNum )
2809{
2810    return tr_strdup_printf( "%s.part", tor->info.files[fileNum].name );
2811}
Note: See TracBrowser for help on using the repository browser.