source: trunk/libtransmission/torrent.c @ 9538

Last change on this file since 9538 was 9538, checked in by livings124, 12 years ago

#2592 remove swarm speed from libtransmission

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