source: trunk/libtransmission/torrent.c @ 9540

Last change on this file since 9540 was 9540, checked in by livings124, 13 years ago

a couple of more swarm speed removals

  • 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 9540 2009-11-22 01:12:44Z 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_sha1( tor->obfuscatedHash, "req2", 4,
628             info->hash, SHA_DIGEST_LENGTH,
629             NULL );
630
631    tr_peerMgrAddTorrent( session->peerMgr, tor );
632
633    assert( !tor->downloadedCur );
634    assert( !tor->uploadedCur );
635
636    tr_ctorInitTorrentPriorities( ctor, tor );
637
638    tr_ctorInitTorrentWanted( ctor, tor );
639
640    tor->error = TR_STAT_OK;
641
642    tr_bitfieldConstruct( &tor->checkedPieces, tor->info.pieceCount );
643    tr_torrentUncheck( tor );
644
645    tr_torrentSetAddedDate( tor, time( NULL ) ); /* this is a default value to be
646                                                    overwritten by the resume file */
647
648    loaded = tr_torrentLoadResume( tor, ~0, ctor );
649
650    refreshCurrentDir( tor );
651
652    doStart = tor->isRunning;
653    tor->isRunning = 0;
654
655    if( !( loaded & TR_FR_SPEEDLIMIT ) )
656    {
657        tr_torrentUseSpeedLimit( tor, TR_UP, FALSE );
658        tr_torrentSetSpeedLimit( tor, TR_UP, tr_sessionGetSpeedLimit( tor->session, TR_UP ) );
659        tr_torrentUseSpeedLimit( tor, TR_DOWN, FALSE );
660        tr_torrentSetSpeedLimit( tor, TR_DOWN, tr_sessionGetSpeedLimit( tor->session, TR_DOWN ) );
661        tr_torrentUseSessionLimits( tor, TRUE );
662    }
663
664    if( !( loaded & TR_FR_RATIOLIMIT ) )
665    {
666        tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_GLOBAL );
667        tr_torrentSetRatioLimit( tor, tr_sessionGetRatioLimit( tor->session ) );
668    }
669
670    tor->completeness = tr_cpGetStatus( &tor->completion );
671
672    {
673        tr_torrent * it = NULL;
674        tr_torrent * last = NULL;
675        while( ( it = tr_torrentNext( session, it ) ) )
676            last = it;
677
678        if( !last )
679            session->torrentList = tor;
680        else
681            last->next = tor;
682        ++session->torrentCount;
683    }
684
685    tr_globalUnlock( session );
686
687    /* maybe save our own copy of the metainfo */
688    if( tr_ctorGetSave( ctor ) )
689    {
690        const tr_benc * val;
691        if( !tr_ctorGetMetainfo( ctor, &val ) )
692        {
693            const char * filename = tor->info.torrent;
694            tr_bencToFile( val, TR_FMT_BENC, filename );
695            tr_sessionSetTorrentFile( tor->session, tor->info.hashString, filename );
696        }
697    }
698
699    tor->tiers = tr_announcerAddTorrent( session->announcer, tor );
700    tor->tiersSubscription = tr_announcerSubscribe( tor->tiers, onTrackerResponse, tor );
701
702    tr_metainfoMigrate( session, &tor->info );
703
704    if( doStart )
705        torrentStart( tor );
706}
707
708tr_parse_result
709tr_torrentParse( const tr_ctor * ctor, tr_info * setmeInfo )
710{
711    int             doFree;
712    tr_bool         didParse;
713    tr_info         tmp;
714    const tr_benc * metainfo;
715    tr_session    * session = tr_ctorGetSession( ctor );
716    tr_parse_result result = TR_PARSE_OK;
717
718    if( setmeInfo == NULL )
719        setmeInfo = &tmp;
720    memset( setmeInfo, 0, sizeof( tr_info ) );
721
722    if( tr_ctorGetMetainfo( ctor, &metainfo ) )
723        return TR_PARSE_ERR;
724
725    didParse = tr_metainfoParse( session, setmeInfo, metainfo );
726    doFree = didParse && ( setmeInfo == &tmp );
727
728    if( !didParse )
729        result = TR_PARSE_ERR;
730
731    if( didParse && !getBlockSize( setmeInfo->pieceSize ) )
732        result = TR_PARSE_ERR;
733
734    if( didParse && session && tr_torrentExists( session, setmeInfo->hash ) )
735        result = TR_PARSE_DUPLICATE;
736
737    if( doFree )
738        tr_metainfoFree( setmeInfo );
739
740    return result;
741}
742
743tr_torrent *
744tr_torrentNew( const tr_ctor  * ctor,
745               int            * setmeError )
746{
747    int          err;
748    tr_info      tmpInfo;
749    tr_torrent * tor = NULL;
750
751    assert( ctor != NULL );
752    assert( tr_isSession( tr_ctorGetSession( ctor ) ) );
753
754    err = tr_torrentParse( ctor, &tmpInfo );
755    if( !err )
756    {
757        tor = tr_new0( tr_torrent, 1 );
758        tor->info = tmpInfo;
759        torrentRealInit( tor, ctor );
760    }
761    else if( setmeError )
762    {
763        *setmeError = err;
764    }
765
766    return tor;
767}
768
769/**
770***
771**/
772
773void
774tr_torrentSetDownloadDir( tr_torrent * tor, const char * path )
775{
776    assert( tr_isTorrent( tor  ) );
777
778    if( !path || !tor->downloadDir || strcmp( path, tor->downloadDir ) )
779    {
780        tr_free( tor->downloadDir );
781        tor->downloadDir = tr_strdup( path );
782        tr_torrentSetDirty( tor );
783    }
784
785    refreshCurrentDir( tor );
786}
787
788const char*
789tr_torrentGetDownloadDir( const tr_torrent * tor )
790{
791    assert( tr_isTorrent( tor  ) );
792
793    return tor->downloadDir;
794}
795
796const char *
797tr_torrentGetCurrentDir( const tr_torrent * tor )
798{
799    assert( tr_isTorrent( tor  ) );
800
801    return tor->currentDir;
802}
803
804
805void
806tr_torrentChangeMyPort( tr_torrent * tor )
807{
808    assert( tr_isTorrent( tor  ) );
809
810    tr_announcerChangeMyPort( tor );
811}
812
813static TR_INLINE void
814tr_torrentManualUpdateImpl( void * vtor )
815{
816    tr_torrent * tor = vtor;
817
818    assert( tr_isTorrent( tor  ) );
819
820    if( tor->isRunning )
821        tr_announcerManualAnnounce( tor );
822}
823
824void
825tr_torrentManualUpdate( tr_torrent * tor )
826{
827    assert( tr_isTorrent( tor  ) );
828
829    tr_runInEventThread( tor->session, tr_torrentManualUpdateImpl, tor );
830}
831
832tr_bool
833tr_torrentCanManualUpdate( const tr_torrent * tor )
834{
835    return ( tr_isTorrent( tor  ) )
836        && ( tor->isRunning )
837        && ( tr_announcerCanManualAnnounce( tor ) );
838}
839
840const tr_info *
841tr_torrentInfo( const tr_torrent * tor )
842{
843    return tr_isTorrent( tor ) ? &tor->info : NULL;
844}
845
846const tr_stat *
847tr_torrentStatCached( tr_torrent * tor )
848{
849    const time_t now = time( NULL );
850
851    return tr_isTorrent( tor ) && ( now == tor->lastStatTime )
852         ? &tor->stats
853         : tr_torrentStat( tor );
854}
855
856void
857tr_torrentSetVerifyState( tr_torrent * tor, tr_verify_state state )
858{
859    assert( tr_isTorrent( tor ) );
860    assert( state==TR_VERIFY_NONE || state==TR_VERIFY_WAIT || state==TR_VERIFY_NOW );
861
862    tor->verifyState = state;
863    tor->anyDate = time( NULL );
864}
865
866tr_torrent_activity
867tr_torrentGetActivity( tr_torrent * tor )
868{
869    assert( tr_isTorrent( tor ) );
870
871    tr_torrentRecheckCompleteness( tor );
872
873    if( tor->verifyState == TR_VERIFY_NOW )
874        return TR_STATUS_CHECK;
875    if( tor->verifyState == TR_VERIFY_WAIT )
876        return TR_STATUS_CHECK_WAIT;
877    if( !tor->isRunning )
878        return TR_STATUS_STOPPED;
879    if( tor->completeness == TR_LEECH )
880        return TR_STATUS_DOWNLOAD;
881
882    return TR_STATUS_SEED;
883}
884
885const tr_stat *
886tr_torrentStat( tr_torrent * tor )
887{
888    tr_stat *               s;
889    int                     usableSeeds;
890    uint64_t                now;
891    double                  downloadedForRatio, seedRatio=0;
892    double                  d;
893    tr_bool                 checkSeedRatio;
894
895    if( !tor )
896        return NULL;
897
898    assert( tr_isTorrent( tor ) );
899    tr_torrentLock( tor );
900
901    tor->lastStatTime = time( NULL );
902
903    s = &tor->stats;
904    s->id = tor->uniqueId;
905    s->activity = tr_torrentGetActivity( tor );
906    s->error = tor->error;
907    memcpy( s->errorString, tor->errorString, sizeof( s->errorString ) );
908
909    s->manualAnnounceTime = tr_announcerNextManualAnnounce( tor );
910
911    tr_peerMgrTorrentStats( tor,
912                            &s->peersKnown,
913                            &s->peersConnected,
914                            &usableSeeds,
915                            &s->webseedsSendingToUs,
916                            &s->peersSendingToUs,
917                            &s->peersGettingFromUs,
918                            s->peersFrom );
919
920    now = tr_date( );
921    d = tr_peerMgrGetWebseedSpeed( tor, now );
922    s->rawUploadSpeed     = tr_bandwidthGetRawSpeed  ( tor->bandwidth, now, TR_UP );
923    s->pieceUploadSpeed   = tr_bandwidthGetPieceSpeed( tor->bandwidth, now, TR_UP );
924    s->rawDownloadSpeed   = d + tr_bandwidthGetRawSpeed  ( tor->bandwidth, now, TR_DOWN );
925    s->pieceDownloadSpeed = d + tr_bandwidthGetPieceSpeed( tor->bandwidth, now, TR_DOWN );
926
927    usableSeeds += tor->info.webseedCount;
928
929    s->percentComplete = tr_cpPercentComplete ( &tor->completion );
930
931    s->percentDone   = tr_cpPercentDone  ( &tor->completion );
932    s->leftUntilDone = tr_cpLeftUntilDone( &tor->completion );
933    s->sizeWhenDone  = tr_cpSizeWhenDone ( &tor->completion );
934
935    s->recheckProgress = s->activity == TR_STATUS_CHECK
936                       ? 1.0 -
937                         ( tr_torrentCountUncheckedPieces( tor ) /
938                           (double) tor->info.pieceCount )
939                       : 0.0;
940
941    s->activityDate = tor->activityDate;
942    s->addedDate    = tor->addedDate;
943    s->doneDate     = tor->doneDate;
944    s->startDate    = tor->startDate;
945
946    s->corruptEver     = tor->corruptCur    + tor->corruptPrev;
947    s->downloadedEver  = tor->downloadedCur + tor->downloadedPrev;
948    s->uploadedEver    = tor->uploadedCur   + tor->uploadedPrev;
949    s->haveValid       = tr_cpHaveValid( &tor->completion );
950    s->haveUnchecked   = tr_cpHaveTotal( &tor->completion ) - s->haveValid;
951
952    if( usableSeeds > 0 )
953    {
954        s->desiredAvailable = s->leftUntilDone;
955    }
956    else if( !s->leftUntilDone || !s->peersConnected )
957    {
958        s->desiredAvailable = 0;
959    }
960    else
961    {
962        tr_piece_index_t i;
963        tr_bitfield *    peerPieces = tr_peerMgrGetAvailable( tor );
964        s->desiredAvailable = 0;
965        for( i = 0; i < tor->info.pieceCount; ++i )
966            if( !tor->info.pieces[i].dnd && tr_bitfieldHasFast( peerPieces, i ) )
967                s->desiredAvailable += tr_cpMissingBlocksInPiece( &tor->completion, i );
968        s->desiredAvailable *= tor->blockSize;
969        tr_bitfieldFree( peerPieces );
970    }
971
972    downloadedForRatio = s->downloadedEver ? s->downloadedEver : s->haveValid;
973    s->ratio = tr_getRatio( s->uploadedEver, downloadedForRatio );
974
975    checkSeedRatio = tr_torrentGetSeedRatio( tor, &seedRatio );
976
977    switch( s->activity )
978    {
979        /* etaXLSpeed exists because if we use the piece speed directly,
980         * brief fluctuations cause the ETA to jump all over the place.
981         * so, etaXLSpeed is a smoothed-out version of the piece speed
982         * to dampen the effect of fluctuations */
983
984        case TR_STATUS_DOWNLOAD:
985            if( ( tor->etaDLSpeedCalculatedAt + 800 ) < now ) {
986                tor->etaDLSpeed = ( ( tor->etaDLSpeedCalculatedAt + 4000 ) < now )
987                    ? s->pieceDownloadSpeed /* if no recent previous speed, no need to smooth */
988                    : 0.8*tor->etaDLSpeed + 0.2*s->pieceDownloadSpeed; /* smooth across 5 readings */
989                tor->etaDLSpeedCalculatedAt = now;
990            }
991           
992            if( s->leftUntilDone > s->desiredAvailable )
993                s->eta = TR_ETA_NOT_AVAIL;
994            else if( s->pieceDownloadSpeed < 0.1 )
995                s->eta = TR_ETA_UNKNOWN;
996            else
997                s->eta = s->leftUntilDone / tor->etaDLSpeed / 1024.0;
998            break;
999
1000        case TR_STATUS_SEED:
1001            if( checkSeedRatio )
1002            {
1003                if( ( tor->etaULSpeedCalculatedAt + 800 ) < now ) {
1004                    tor->etaULSpeed = ( ( tor->etaULSpeedCalculatedAt + 4000 ) < now )
1005                        ? s->pieceUploadSpeed /* if no recent previous speed, no need to smooth */
1006                        : 0.8*tor->etaULSpeed + 0.2*s->pieceUploadSpeed; /* smooth across 5 readings */
1007                    tor->etaULSpeedCalculatedAt = now;
1008                }
1009               
1010                if( s->pieceUploadSpeed < 0.1 )
1011                    s->eta = TR_ETA_UNKNOWN;
1012                else
1013                    s->eta = (downloadedForRatio * (seedRatio - s->ratio)) / tor->etaULSpeed / 1024.0;
1014            }
1015            else
1016                s->eta = TR_ETA_NOT_AVAIL;
1017            break;
1018
1019        default:
1020            s->eta = TR_ETA_NOT_AVAIL;
1021            break;
1022    }
1023   
1024    if( !checkSeedRatio || s->ratio >= seedRatio || s->ratio == TR_RATIO_INF ) 
1025        s->percentRatio = 1.0; 
1026    else if( s->ratio == TR_RATIO_NA ) 
1027        s->percentRatio = 0.0; 
1028    else 
1029        s->percentRatio = s->ratio / seedRatio; 
1030
1031    tr_torrentUnlock( tor );
1032
1033    return s;
1034}
1035
1036/***
1037****
1038***/
1039
1040static uint64_t
1041fileBytesCompleted( const tr_torrent * tor, tr_file_index_t index )
1042{
1043    uint64_t total = 0;
1044    const tr_file * f = &tor->info.files[index];
1045
1046    if( f->length )
1047    {
1048        const tr_block_index_t firstBlock = f->offset / tor->blockSize;
1049        const uint64_t lastByte = f->offset + f->length - 1;
1050        const tr_block_index_t lastBlock = lastByte / tor->blockSize;
1051
1052        if( firstBlock == lastBlock )
1053        {
1054            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1055                total = f->length;
1056        }
1057        else
1058        {
1059            tr_block_index_t i;
1060
1061            /* the first block */
1062            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1063                total += tor->blockSize - ( f->offset % tor->blockSize );
1064
1065            /* the middle blocks */
1066            if( f->firstPiece == f->lastPiece )
1067            {
1068                for( i=firstBlock+1; i<lastBlock; ++i )
1069                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1070                        total += tor->blockSize;
1071            }
1072            else
1073            {
1074                uint64_t b = 0;
1075                const tr_block_index_t firstBlockOfLastPiece
1076                           = tr_torPieceFirstBlock( tor, f->lastPiece );
1077                const tr_block_index_t lastBlockOfFirstPiece
1078                           = tr_torPieceFirstBlock( tor, f->firstPiece )
1079                             + tr_torPieceCountBlocks( tor, f->firstPiece ) - 1;
1080
1081                /* the rest of the first piece */
1082                for( i=firstBlock+1; i<lastBlock && i<=lastBlockOfFirstPiece; ++i )
1083                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1084                        ++b;
1085
1086                /* the middle pieces */
1087                if( f->firstPiece + 1 < f->lastPiece )
1088                    for( i=f->firstPiece+1; i<f->lastPiece; ++i )
1089                        b += tor->blockCountInPiece - tr_cpMissingBlocksInPiece( &tor->completion, i );
1090
1091                /* the rest of the last piece */
1092                for( i=firstBlockOfLastPiece; i<lastBlock; ++i )
1093                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1094                        ++b;
1095
1096                b *= tor->blockSize;
1097                total += b;
1098            }
1099
1100            /* the last block */
1101            if( tr_cpBlockIsCompleteFast( &tor->completion, lastBlock ) )
1102                total += ( f->offset + f->length ) - ( tor->blockSize * lastBlock );
1103        }
1104    }
1105
1106    return total;
1107}
1108
1109tr_file_stat *
1110tr_torrentFiles( const tr_torrent * tor,
1111                 tr_file_index_t *  fileCount )
1112{
1113    tr_file_index_t       i;
1114    const tr_file_index_t n = tor->info.fileCount;
1115    tr_file_stat *        files = tr_new0( tr_file_stat, n );
1116    tr_file_stat *        walk = files;
1117    const tr_bool         isSeed = tor->completeness == TR_SEED;
1118
1119    assert( tr_isTorrent( tor ) );
1120
1121    for( i=0; i<n; ++i, ++walk ) {
1122        const uint64_t b = isSeed ? tor->info.files[i].length : fileBytesCompleted( tor, i );
1123        walk->bytesCompleted = b;
1124        walk->progress = tr_getRatio( b, tor->info.files[i].length );
1125    }
1126
1127    if( fileCount )
1128        *fileCount = n;
1129
1130    return files;
1131}
1132
1133void
1134tr_torrentFilesFree( tr_file_stat *            files,
1135                     tr_file_index_t fileCount UNUSED )
1136{
1137    tr_free( files );
1138}
1139
1140/***
1141****
1142***/
1143
1144float*
1145tr_torrentWebSpeeds( const tr_torrent * tor )
1146{
1147    return tr_isTorrent( tor )
1148         ? tr_peerMgrWebSpeeds( tor )
1149         : NULL;
1150}
1151
1152tr_peer_stat *
1153tr_torrentPeers( const tr_torrent * tor,
1154                 int *              peerCount )
1155{
1156    tr_peer_stat * ret = NULL;
1157
1158    if( tr_isTorrent( tor ) )
1159        ret = tr_peerMgrPeerStats( tor, peerCount );
1160
1161    return ret;
1162}
1163
1164void
1165tr_torrentPeersFree( tr_peer_stat * peers,
1166                     int peerCount  UNUSED )
1167{
1168    tr_free( peers );
1169}
1170
1171tr_tracker_stat *
1172tr_torrentTrackers( const tr_torrent * torrent,
1173                    int              * setmeTrackerCount )
1174{
1175    assert( tr_isTorrent( torrent ) );
1176
1177    return tr_announcerStats( torrent, setmeTrackerCount );
1178}
1179
1180void
1181tr_torrentTrackersFree( tr_tracker_stat * trackers,
1182                        int trackerCount )
1183{
1184    tr_announcerStatsFree( trackers, trackerCount );
1185}
1186
1187void
1188tr_torrentAvailability( const tr_torrent * tor,
1189                        int8_t *           tab,
1190                        int                size )
1191{
1192    tr_peerMgrTorrentAvailability( tor, tab, size );
1193}
1194
1195void
1196tr_torrentAmountFinished( const tr_torrent * tor,
1197                          float *            tab,
1198                          int                size )
1199{
1200    assert( tr_isTorrent( tor ) );
1201
1202    tr_torrentLock( tor );
1203    tr_cpGetAmountDone( &tor->completion, tab, size );
1204    tr_torrentUnlock( tor );
1205}
1206
1207static void
1208tr_torrentResetTransferStats( tr_torrent * tor )
1209{
1210    assert( tr_isTorrent( tor ) );
1211
1212    tr_torrentLock( tor );
1213
1214    tor->downloadedPrev += tor->downloadedCur;
1215    tor->downloadedCur   = 0;
1216    tor->uploadedPrev   += tor->uploadedCur;
1217    tor->uploadedCur     = 0;
1218    tor->corruptPrev    += tor->corruptCur;
1219    tor->corruptCur      = 0;
1220
1221    tr_torrentSetDirty( tor );
1222
1223    tr_torrentUnlock( tor );
1224}
1225
1226void
1227tr_torrentSetHasPiece( tr_torrent *     tor,
1228                       tr_piece_index_t pieceIndex,
1229                       tr_bool          has )
1230{
1231    assert( tr_isTorrent( tor ) );
1232    assert( pieceIndex < tor->info.pieceCount );
1233
1234    if( has )
1235        tr_cpPieceAdd( &tor->completion, pieceIndex );
1236    else
1237        tr_cpPieceRem( &tor->completion, pieceIndex );
1238}
1239
1240/***
1241****
1242***/
1243
1244static void
1245freeTorrent( tr_torrent * tor )
1246{
1247    tr_torrent * t;
1248    tr_session *  session = tor->session;
1249    tr_info *    inf = &tor->info;
1250
1251    assert( tr_isTorrent( tor ) );
1252    assert( !tor->isRunning );
1253
1254    tr_globalLock( session );
1255
1256    tr_peerMgrRemoveTorrent( tor );
1257
1258    tr_cpDestruct( &tor->completion );
1259
1260    tr_announcerUnsubscribe( tor->tiers, tor->tiersSubscription );
1261    tr_announcerRemoveTorrent( session->announcer, tor );
1262
1263    tr_bitfieldDestruct( &tor->checkedPieces );
1264
1265    tr_free( tor->downloadDir );
1266    tr_free( tor->incompleteDir );
1267    tr_free( tor->peer_id );
1268
1269    if( tor == session->torrentList )
1270        session->torrentList = tor->next;
1271    else for( t = session->torrentList; t != NULL; t = t->next ) {
1272        if( t->next == tor ) {
1273            t->next = tor->next;
1274            break;
1275        }
1276    }
1277
1278    assert( session->torrentCount >= 1 );
1279    session->torrentCount--;
1280
1281    tr_bandwidthFree( tor->bandwidth );
1282
1283    tr_metainfoFree( inf );
1284    tr_free( tor );
1285
1286    tr_globalUnlock( session );
1287}
1288
1289/**
1290***  Start/Stop Callback
1291**/
1292
1293static void
1294checkAndStartImpl( void * vtor )
1295{
1296    tr_torrent * tor = vtor;
1297
1298    assert( tr_isTorrent( tor ) );
1299
1300    tr_globalLock( tor->session );
1301
1302    /** If we had local data before, but it's disappeared,
1303        stop the torrent and log an error. */
1304    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1305    {
1306        tr_torrentSetLocalError( tor, _( "Can't find local data.  Try \"Set Location\" to find it, or restart the torrent to re-download." ) );
1307        tr_torrentStop( tor );
1308    }
1309    else
1310    {
1311        const time_t now = time( NULL );
1312        tor->isRunning = TRUE;
1313        tor->needsSeedRatioCheck = TRUE;
1314        tor->error = TR_STAT_OK;
1315        tor->errorString[0] = '\0';
1316        tor->completeness = tr_cpGetStatus( &tor->completion );
1317        tor->startDate = tor->anyDate = now;
1318
1319        tr_torrentResetTransferStats( tor );
1320        tr_announcerTorrentStarted( tor );
1321        tor->dhtAnnounceAt = now + tr_cryptoWeakRandInt( 20 );
1322        tr_peerMgrStartTorrent( tor );
1323    }
1324
1325    tr_globalUnlock( tor->session );
1326}
1327
1328static void
1329checkAndStartCB( tr_torrent * tor )
1330{
1331    assert( tr_isTorrent( tor ) );
1332    assert( tr_isSession( tor->session ) );
1333
1334    tr_runInEventThread( tor->session, checkAndStartImpl, tor );
1335}
1336
1337static void
1338torrentStart( tr_torrent * tor )
1339{
1340    assert( tr_isTorrent( tor ) );
1341
1342    tr_globalLock( tor->session );
1343
1344    if( !tor->isRunning )
1345    {
1346        tr_verifyRemove( tor );
1347
1348        /* corresponds to the peer_id sent as a tracker request parameter.
1349         * one tracker admin says: "When the same torrent is opened and
1350         * closed and opened again without quitting Transmission ...
1351         * change the peerid. It would help sometimes if a stopped event
1352         * was missed to ensure that we didn't think someone was cheating. */
1353        tr_free( tor->peer_id );
1354        tor->peer_id = tr_peerIdNew( );
1355
1356        tor->isRunning = 1;
1357        tr_torrentSetDirty( tor );
1358        tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1359        tr_verifyAdd( tor, checkAndStartCB );
1360    }
1361
1362    tr_globalUnlock( tor->session );
1363}
1364
1365void
1366tr_torrentStart( tr_torrent * tor )
1367{
1368    if( tr_isTorrent( tor ) )
1369        torrentStart( tor );
1370}
1371
1372static void
1373torrentRecheckDoneImpl( void * vtor )
1374{
1375    tr_torrent * tor = vtor;
1376
1377    assert( tr_isTorrent( tor ) );
1378    tr_torrentRecheckCompleteness( tor );
1379
1380    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1381    {
1382        tr_torrentSetLocalError( tor, _( "Can't find local data.  Try \"Set Location\" to find it, or restart the torrent to re-download." ) );
1383        tr_torrentStop( tor );
1384    }
1385    else if( tor->startAfterVerify )
1386    {
1387        tor->startAfterVerify = FALSE;
1388
1389        tr_torrentStart( tor );
1390    }
1391}
1392
1393static void
1394torrentRecheckDoneCB( tr_torrent * tor )
1395{
1396    assert( tr_isTorrent( tor ) );
1397
1398    tr_runInEventThread( tor->session, torrentRecheckDoneImpl, tor );
1399}
1400
1401static void
1402verifyTorrent( void * vtor )
1403{
1404    tr_torrent * tor = vtor;
1405
1406    assert( tr_isTorrent( tor ) );
1407    tr_globalLock( tor->session );
1408
1409    /* if the torrent's already being verified, stop it */
1410    tr_verifyRemove( tor );
1411
1412    /* if the torrent's running, stop it & set the restart-after-verify flag */
1413    if( tor->startAfterVerify || tor->isRunning ) {
1414        tr_torrentStop( tor );
1415        tor->startAfterVerify = TRUE;
1416    }
1417
1418    /* add the torrent to the recheck queue */
1419    tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1420    tr_torrentUncheck( tor );
1421    tr_verifyAdd( tor, torrentRecheckDoneCB );
1422
1423    tr_globalUnlock( tor->session );
1424}
1425
1426void
1427tr_torrentVerify( tr_torrent * tor )
1428{
1429    if( tr_isTorrent( tor ) )
1430        tr_runInEventThread( tor->session, verifyTorrent, tor );
1431}
1432
1433void
1434tr_torrentSave( tr_torrent * tor )
1435{
1436    assert( tr_isTorrent( tor ) );
1437
1438    if( tor->isDirty ) {
1439        tor->isDirty = FALSE;
1440        tr_torrentSaveResume( tor );
1441    }
1442}
1443
1444static void
1445stopTorrent( void * vtor )
1446{
1447    tr_torrent * tor = vtor;
1448
1449    assert( tr_isTorrent( tor ) );
1450
1451    tr_verifyRemove( tor );
1452    tr_peerMgrStopTorrent( tor );
1453    tr_announcerTorrentStopped( tor );
1454
1455    tr_fdTorrentClose( tor->session, tor->uniqueId );
1456
1457    if( !tor->isDeleting )
1458        tr_torrentSave( tor );
1459}
1460
1461void
1462tr_torrentStop( tr_torrent * tor )
1463{
1464    assert( tr_isTorrent( tor ) );
1465
1466    if( tr_isTorrent( tor ) )
1467    {
1468        tr_globalLock( tor->session );
1469
1470        tor->isRunning = 0;
1471        tr_torrentSetDirty( tor );
1472        tr_runInEventThread( tor->session, stopTorrent, tor );
1473
1474        tr_globalUnlock( tor->session );
1475    }
1476}
1477
1478static void
1479closeTorrent( void * vtor )
1480{
1481    tr_benc * d;
1482    tr_torrent * tor = vtor;
1483
1484    assert( tr_isTorrent( tor ) );
1485
1486    d = tr_bencListAddDict( &tor->session->removedTorrents, 2 );
1487    tr_bencDictAddInt( d, "id", tor->uniqueId );
1488    tr_bencDictAddInt( d, "date", time( NULL ) );
1489
1490    stopTorrent( tor );
1491
1492    if( tor->isDeleting )
1493    {
1494        tr_metainfoRemoveSaved( tor->session, &tor->info );
1495        tr_torrentRemoveResume( tor );
1496    }
1497
1498    tor->isRunning = 0;
1499    freeTorrent( tor );
1500}
1501
1502void
1503tr_torrentFree( tr_torrent * tor )
1504{
1505    if( tr_isTorrent( tor ) )
1506    {
1507        tr_session * session = tor->session;
1508        assert( tr_isSession( session ) );
1509        tr_globalLock( session );
1510
1511        tr_torrentClearCompletenessCallback( tor );
1512        tr_runInEventThread( session, closeTorrent, tor );
1513
1514        tr_globalUnlock( session );
1515    }
1516}
1517
1518void
1519tr_torrentRemove( tr_torrent * tor )
1520{
1521    assert( tr_isTorrent( tor ) );
1522
1523    tor->isDeleting = 1;
1524    tr_torrentFree( tor );
1525}
1526
1527/**
1528***  Completeness
1529**/
1530
1531static const char *
1532getCompletionString( int type )
1533{
1534    switch( type )
1535    {
1536        /* Translators: this is a minor point that's safe to skip over, but FYI:
1537           "Complete" and "Done" are specific, different terms in Transmission:
1538           "Complete" means we've downloaded every file in the torrent.
1539           "Done" means we're done downloading the files we wanted, but NOT all
1540           that exist */
1541        case TR_PARTIAL_SEED:
1542            return _( "Done" );
1543
1544        case TR_SEED:
1545            return _( "Complete" );
1546
1547        default:
1548            return _( "Incomplete" );
1549    }
1550}
1551
1552static void
1553fireCompletenessChange( tr_torrent       * tor,
1554                        tr_completeness    status )
1555{
1556    assert( tr_isTorrent( tor ) );
1557    assert( ( status == TR_LEECH )
1558         || ( status == TR_SEED )
1559         || ( status == TR_PARTIAL_SEED ) );
1560
1561    if( tor->completeness_func )
1562        tor->completeness_func( tor, status, tor->completeness_func_user_data );
1563}
1564
1565void
1566tr_torrentSetCompletenessCallback( tr_torrent                    * tor,
1567                                   tr_torrent_completeness_func    func,
1568                                   void                          * user_data )
1569{
1570    assert( tr_isTorrent( tor ) );
1571
1572    tor->completeness_func = func;
1573    tor->completeness_func_user_data = user_data;
1574}
1575
1576void
1577tr_torrentSetRatioLimitHitCallback( tr_torrent                     * tor,
1578                                    tr_torrent_ratio_limit_hit_func  func,
1579                                    void                           * user_data )
1580{
1581    assert( tr_isTorrent( tor ) );
1582
1583    tor->ratio_limit_hit_func = func;
1584    tor->ratio_limit_hit_func_user_data = user_data;
1585}
1586
1587void
1588tr_torrentClearCompletenessCallback( tr_torrent * torrent )
1589{
1590    tr_torrentSetCompletenessCallback( torrent, NULL, NULL );
1591}
1592
1593void
1594tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent )
1595{
1596    tr_torrentSetRatioLimitHitCallback( torrent, NULL, NULL );
1597}
1598
1599void
1600tr_torrentRecheckCompleteness( tr_torrent * tor )
1601{
1602    tr_completeness completeness;
1603
1604    assert( tr_isTorrent( tor ) );
1605
1606    tr_torrentLock( tor );
1607
1608    completeness = tr_cpGetStatus( &tor->completion );
1609
1610    if( completeness != tor->completeness )
1611    {
1612        const int recentChange = tor->downloadedCur != 0;
1613
1614        if( recentChange )
1615        {
1616            tr_torinf( tor, _( "State changed from \"%1$s\" to \"%2$s\"" ),
1617                      getCompletionString( tor->completeness ),
1618                      getCompletionString( completeness ) );
1619        }
1620
1621        tor->completeness = completeness;
1622        tor->needsSeedRatioCheck = TRUE;
1623        tr_fdTorrentClose( tor->session, tor->uniqueId );
1624
1625        /* if the torrent is a seed now,
1626         * and the files used to be in the incompleteDir,
1627         * then move them to the destination directory */
1628        if( tr_torrentIsSeed( tor ) && ( tor->currentDir == tor->incompleteDir ) )
1629            tr_torrentSetLocation( tor, tor->downloadDir, TRUE, NULL, NULL );
1630
1631        fireCompletenessChange( tor, completeness );
1632
1633        if( recentChange && ( completeness == TR_SEED ) )
1634        {
1635            tr_announcerTorrentCompleted( tor );
1636
1637            tor->doneDate = tor->anyDate = time( NULL );
1638        }
1639
1640        tr_torrentSetDirty( tor );
1641    }
1642
1643    tr_torrentUnlock( tor );
1644}
1645
1646/**
1647***  File priorities
1648**/
1649
1650void
1651tr_torrentInitFilePriority( tr_torrent *    tor,
1652                            tr_file_index_t fileIndex,
1653                            tr_priority_t   priority )
1654{
1655    tr_piece_index_t i;
1656    tr_file *        file;
1657
1658    assert( tr_isTorrent( tor ) );
1659    assert( fileIndex < tor->info.fileCount );
1660    assert( tr_isPriority( priority ) );
1661
1662    file = &tor->info.files[fileIndex];
1663    file->priority = priority;
1664    for( i = file->firstPiece; i <= file->lastPiece; ++i )
1665        tor->info.pieces[i].priority = calculatePiecePriority( tor, i, fileIndex );
1666}
1667
1668void
1669tr_torrentSetFilePriorities( tr_torrent *      tor,
1670                             tr_file_index_t * files,
1671                             tr_file_index_t   fileCount,
1672                             tr_priority_t     priority )
1673{
1674    tr_file_index_t i;
1675    assert( tr_isTorrent( tor ) );
1676    tr_torrentLock( tor );
1677
1678    for( i = 0; i < fileCount; ++i )
1679        tr_torrentInitFilePriority( tor, files[i], priority );
1680    tr_torrentSetDirty( tor );
1681    tr_peerMgrRebuildRequests( tor );
1682
1683    tr_torrentUnlock( tor );
1684}
1685
1686tr_priority_t
1687tr_torrentGetFilePriority( const tr_torrent * tor,
1688                           tr_file_index_t    file )
1689{
1690    tr_priority_t ret;
1691
1692    assert( tr_isTorrent( tor ) );
1693
1694    tr_torrentLock( tor );
1695    assert( tor );
1696    assert( file < tor->info.fileCount );
1697    ret = tor->info.files[file].priority;
1698    tr_torrentUnlock( tor );
1699
1700    return ret;
1701}
1702
1703tr_priority_t*
1704tr_torrentGetFilePriorities( const tr_torrent * tor )
1705{
1706    tr_file_index_t i;
1707    tr_priority_t * p;
1708
1709    assert( tr_isTorrent( tor ) );
1710
1711    tr_torrentLock( tor );
1712    p = tr_new0( tr_priority_t, tor->info.fileCount );
1713    for( i = 0; i < tor->info.fileCount; ++i )
1714        p[i] = tor->info.files[i].priority;
1715    tr_torrentUnlock( tor );
1716
1717    return p;
1718}
1719
1720/**
1721***  File DND
1722**/
1723
1724int
1725tr_torrentGetFileDL( const tr_torrent * tor,
1726                     tr_file_index_t    file )
1727{
1728    int doDownload;
1729
1730    assert( tr_isTorrent( tor ) );
1731
1732    tr_torrentLock( tor );
1733
1734    assert( file < tor->info.fileCount );
1735    doDownload = !tor->info.files[file].dnd;
1736
1737    tr_torrentUnlock( tor );
1738    return doDownload != 0;
1739}
1740
1741static void
1742setFileDND( tr_torrent * tor, tr_file_index_t fileIndex, int doDownload )
1743{
1744    tr_file *        file;
1745    const int        dnd = !doDownload;
1746    tr_piece_index_t firstPiece, firstPieceDND;
1747    tr_piece_index_t lastPiece, lastPieceDND;
1748    tr_file_index_t  i;
1749
1750    assert( tr_isTorrent( tor ) );
1751
1752    file = &tor->info.files[fileIndex];
1753    file->dnd = dnd;
1754    firstPiece = file->firstPiece;
1755    lastPiece = file->lastPiece;
1756
1757    /* can't set the first piece to DND unless
1758       every file using that piece is DND */
1759    firstPieceDND = dnd;
1760    if( fileIndex > 0 )
1761    {
1762        for( i = fileIndex - 1; firstPieceDND; --i )
1763        {
1764            if( tor->info.files[i].lastPiece != firstPiece )
1765                break;
1766            firstPieceDND = tor->info.files[i].dnd;
1767            if( !i )
1768                break;
1769        }
1770    }
1771
1772    /* can't set the last piece to DND unless
1773       every file using that piece is DND */
1774    lastPieceDND = dnd;
1775    for( i = fileIndex + 1; lastPieceDND && i < tor->info.fileCount; ++i )
1776    {
1777        if( tor->info.files[i].firstPiece != lastPiece )
1778            break;
1779        lastPieceDND = tor->info.files[i].dnd;
1780    }
1781
1782    if( firstPiece == lastPiece )
1783    {
1784        tor->info.pieces[firstPiece].dnd = firstPieceDND && lastPieceDND;
1785    }
1786    else
1787    {
1788        tr_piece_index_t pp;
1789        tor->info.pieces[firstPiece].dnd = firstPieceDND;
1790        tor->info.pieces[lastPiece].dnd = lastPieceDND;
1791        for( pp = firstPiece + 1; pp < lastPiece; ++pp )
1792            tor->info.pieces[pp].dnd = dnd;
1793    }
1794}
1795
1796void
1797tr_torrentInitFileDLs( tr_torrent      * tor,
1798                       tr_file_index_t * files,
1799                       tr_file_index_t   fileCount,
1800                       tr_bool           doDownload )
1801{
1802    tr_file_index_t i;
1803
1804    assert( tr_isTorrent( tor ) );
1805
1806    tr_torrentLock( tor );
1807
1808    for( i=0; i<fileCount; ++i )
1809        setFileDND( tor, files[i], doDownload );
1810    tr_cpInvalidateDND( &tor->completion );
1811    tor->needsSeedRatioCheck = TRUE;
1812
1813    tr_torrentUnlock( tor );
1814}
1815
1816void
1817tr_torrentSetFileDLs( tr_torrent *      tor,
1818                      tr_file_index_t * files,
1819                      tr_file_index_t   fileCount,
1820                      tr_bool           doDownload )
1821{
1822    assert( tr_isTorrent( tor ) );
1823    tr_torrentLock( tor );
1824
1825    tr_torrentInitFileDLs( tor, files, fileCount, doDownload );
1826    tr_torrentSetDirty( tor );
1827    tr_peerMgrRebuildRequests( tor );
1828
1829    tr_torrentUnlock( tor );
1830}
1831
1832/***
1833****
1834***/
1835
1836tr_priority_t
1837tr_torrentGetPriority( const tr_torrent * tor )
1838{
1839    assert( tr_isTorrent( tor ) );
1840
1841    return tor->bandwidth->priority;
1842}
1843
1844void
1845tr_torrentSetPriority( tr_torrent * tor, tr_priority_t priority )
1846{
1847    assert( tr_isTorrent( tor ) );
1848    assert( tr_isPriority( priority ) );
1849
1850    if( tor->bandwidth->priority != priority )
1851    {
1852        tor->bandwidth->priority = priority;
1853
1854        tr_torrentSetDirty( tor );
1855    }
1856}
1857
1858/***
1859****
1860***/
1861
1862void
1863tr_torrentSetPeerLimit( tr_torrent * tor,
1864                        uint16_t     maxConnectedPeers )
1865{
1866    assert( tr_isTorrent( tor ) );
1867
1868    if ( tor->maxConnectedPeers != maxConnectedPeers )
1869    {
1870        tor->maxConnectedPeers = maxConnectedPeers;
1871
1872        tr_torrentSetDirty( tor );
1873    }
1874}
1875
1876uint16_t
1877tr_torrentGetPeerLimit( const tr_torrent * tor )
1878{
1879    assert( tr_isTorrent( tor ) );
1880
1881    return tor->maxConnectedPeers;
1882}
1883
1884/***
1885****
1886***/
1887
1888tr_block_index_t
1889_tr_block( const tr_torrent * tor,
1890           tr_piece_index_t   index,
1891           uint32_t           offset )
1892{
1893    tr_block_index_t ret;
1894
1895    assert( tr_isTorrent( tor ) );
1896
1897    ret = index;
1898    ret *= ( tor->info.pieceSize / tor->blockSize );
1899    ret += offset / tor->blockSize;
1900    return ret;
1901}
1902
1903tr_bool
1904tr_torrentReqIsValid( const tr_torrent * tor,
1905                      tr_piece_index_t   index,
1906                      uint32_t           offset,
1907                      uint32_t           length )
1908{
1909    int err = 0;
1910
1911    assert( tr_isTorrent( tor ) );
1912
1913    if( index >= tor->info.pieceCount )
1914        err = 1;
1915    else if( length < 1 )
1916        err = 2;
1917    else if( ( offset + length ) > tr_torPieceCountBytes( tor, index ) )
1918        err = 3;
1919    else if( length > MAX_BLOCK_SIZE )
1920        err = 4;
1921    else if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
1922        err = 5;
1923
1924    if( err ) tr_tordbg( tor, "index %lu offset %lu length %lu err %d\n",
1925                              (unsigned long)index,
1926                              (unsigned long)offset,
1927                              (unsigned long)length,
1928                              err );
1929
1930    return !err;
1931}
1932
1933uint64_t
1934tr_pieceOffset( const tr_torrent * tor,
1935                tr_piece_index_t   index,
1936                uint32_t           offset,
1937                uint32_t           length )
1938{
1939    uint64_t ret;
1940
1941    assert( tr_isTorrent( tor ) );
1942
1943    ret = tor->info.pieceSize;
1944    ret *= index;
1945    ret += offset;
1946    ret += length;
1947    return ret;
1948}
1949
1950/***
1951****
1952***/
1953
1954void
1955tr_torrentSetPieceChecked( tr_torrent        * tor,
1956                           tr_piece_index_t    piece,
1957                           tr_bool             isChecked )
1958{
1959    assert( tr_isTorrent( tor ) );
1960
1961    if( isChecked )
1962        tr_bitfieldAdd( &tor->checkedPieces, piece );
1963    else
1964        tr_bitfieldRem( &tor->checkedPieces, piece );
1965}
1966
1967void
1968tr_torrentSetFileChecked( tr_torrent *    tor,
1969                          tr_file_index_t fileIndex,
1970                          tr_bool         isChecked )
1971{
1972    const tr_file *        file = &tor->info.files[fileIndex];
1973    const tr_piece_index_t begin = file->firstPiece;
1974    const tr_piece_index_t end = file->lastPiece + 1;
1975
1976    assert( tr_isTorrent( tor ) );
1977
1978    if( isChecked )
1979        tr_bitfieldAddRange( &tor->checkedPieces, begin, end );
1980    else
1981        tr_bitfieldRemRange( &tor->checkedPieces, begin, end );
1982}
1983
1984tr_bool
1985tr_torrentIsFileChecked( const tr_torrent * tor,
1986                         tr_file_index_t    fileIndex )
1987{
1988    const tr_file *        file = &tor->info.files[fileIndex];
1989    const tr_piece_index_t begin = file->firstPiece;
1990    const tr_piece_index_t end = file->lastPiece + 1;
1991    tr_piece_index_t       i;
1992    tr_bool                isChecked = TRUE;
1993
1994    assert( tr_isTorrent( tor ) );
1995
1996    for( i = begin; isChecked && i < end; ++i )
1997        if( !tr_torrentIsPieceChecked( tor, i ) )
1998            isChecked = FALSE;
1999
2000    return isChecked;
2001}
2002
2003void
2004tr_torrentUncheck( tr_torrent * tor )
2005{
2006    assert( tr_isTorrent( tor ) );
2007
2008    tr_bitfieldRemRange( &tor->checkedPieces, 0, tor->info.pieceCount );
2009}
2010
2011int
2012tr_torrentCountUncheckedPieces( const tr_torrent * tor )
2013{
2014    assert( tr_isTorrent( tor ) );
2015
2016    return tor->info.pieceCount - tr_bitfieldCountTrueBits( &tor->checkedPieces );
2017}
2018
2019time_t*
2020tr_torrentGetMTimes( const tr_torrent * tor, size_t * setme_n )
2021{
2022    size_t       i;
2023    const size_t n = tor->info.fileCount;
2024    time_t *     m = tr_new0( time_t, n );
2025
2026    assert( tr_isTorrent( tor ) );
2027
2028    for( i = 0; i < n; ++i )
2029    {
2030        struct stat sb;
2031        char * path = tr_torrentFindFile( tor, i );
2032        if( ( path != NULL ) && !stat( path, &sb ) && S_ISREG( sb.st_mode ) )
2033        {
2034#ifdef SYS_DARWIN
2035            m[i] = sb.st_mtimespec.tv_sec;
2036#else
2037            m[i] = sb.st_mtime;
2038#endif
2039        }
2040        tr_free( path );
2041    }
2042
2043    *setme_n = n;
2044    return m;
2045}
2046
2047/***
2048****
2049***/
2050
2051tr_announce_list_err
2052tr_torrentSetAnnounceList( tr_torrent *            tor,
2053                           const tr_tracker_info * trackers,
2054                           int                     trackerCount )
2055{
2056    int i, j;
2057    tr_benc metainfo;
2058
2059    assert( tr_isTorrent( tor ) );
2060
2061    /* look for bad URLs */
2062    for( i=0; i<trackerCount; ++i )
2063        if( !tr_httpIsValidURL( trackers[i].announce ) )
2064            return TR_ANNOUNCE_LIST_HAS_BAD;
2065
2066    /* look for duplicates */
2067    for( i=0; i<trackerCount; ++i )
2068        for( j=0; j<trackerCount; ++j )
2069            if( ( i != j ) && ( !strcmp( trackers[i].announce, trackers[j].announce ) ) )
2070                return TR_ANNOUNCE_LIST_HAS_DUPLICATES;
2071
2072    /* save to the .torrent file */
2073    if( !tr_bencLoadFile( &metainfo, TR_FMT_BENC, tor->info.torrent ) )
2074    {
2075        int       i;
2076        int       prevTier = -1;
2077        tr_benc * tier = NULL;
2078        tr_benc * announceList;
2079        tr_info   tmpInfo;
2080
2081        /* remove the old fields */
2082        tr_bencDictRemove( &metainfo, "announce" );
2083        tr_bencDictRemove( &metainfo, "announce-list" );
2084
2085        /* add the new fields */
2086        tr_bencDictAddStr( &metainfo, "announce", trackers[0].announce );
2087        announceList = tr_bencDictAddList( &metainfo, "announce-list", 0 );
2088        for( i = 0; i < trackerCount; ++i ) {
2089            if( prevTier != trackers[i].tier ) {
2090                prevTier = trackers[i].tier;
2091                tier = tr_bencListAddList( announceList, 0 );
2092            }
2093            tr_bencListAddStr( tier, trackers[i].announce );
2094        }
2095
2096        /* try to parse it back again, to make sure it's good */
2097        memset( &tmpInfo, 0, sizeof( tr_info ) );
2098        if( tr_metainfoParse( tor->session, &tmpInfo, &metainfo ) )
2099        {
2100            /* it's good, so keep these new trackers and free the old ones */
2101
2102            tr_info swap;
2103            swap.trackers = tor->info.trackers;
2104            swap.trackerCount = tor->info.trackerCount;
2105            tor->info.trackers = tmpInfo.trackers;
2106            tor->info.trackerCount = tmpInfo.trackerCount;
2107            tmpInfo.trackers = swap.trackers;
2108            tmpInfo.trackerCount = swap.trackerCount;
2109
2110            tr_metainfoFree( &tmpInfo );
2111            tr_bencToFile( &metainfo, TR_FMT_BENC, tor->info.torrent );
2112        }
2113
2114        /* cleanup */
2115        tr_bencFree( &metainfo );
2116
2117        /* tell the announcer to reload this torrent's tracker list */
2118        tr_announcerResetTorrent( tor->session->announcer, tor );
2119    }
2120
2121    return TR_ANNOUNCE_LIST_OK;
2122}
2123
2124/**
2125***
2126**/
2127
2128void
2129tr_torrentSetAddedDate( tr_torrent * tor,
2130                        time_t       t )
2131{
2132    assert( tr_isTorrent( tor ) );
2133
2134    tor->addedDate = t;
2135    tor->anyDate = MAX( tor->anyDate, tor->addedDate );
2136}
2137
2138void
2139tr_torrentSetActivityDate( tr_torrent * tor, time_t t )
2140{
2141    assert( tr_isTorrent( tor ) );
2142
2143    tor->activityDate = t;
2144    tor->anyDate = MAX( tor->anyDate, tor->activityDate );
2145}
2146
2147void
2148tr_torrentSetDoneDate( tr_torrent * tor,
2149                       time_t       t )
2150{
2151    assert( tr_isTorrent( tor ) );
2152
2153    tor->doneDate = t;
2154    tor->anyDate = MAX( tor->anyDate, tor->doneDate );
2155}
2156
2157/**
2158***
2159**/
2160
2161uint64_t
2162tr_torrentGetBytesLeftToAllocate( const tr_torrent * tor )
2163{
2164    tr_file_index_t i;
2165    uint64_t bytesLeft = 0;
2166
2167    assert( tr_isTorrent( tor ) );
2168
2169    for( i=0; i<tor->info.fileCount; ++i )
2170    {
2171        if( !tor->info.files[i].dnd )
2172        {
2173            struct stat sb;
2174            const uint64_t length = tor->info.files[i].length;
2175            char * path = tr_torrentFindFile( tor, i );
2176
2177            bytesLeft += length;
2178
2179            if( ( path != NULL ) && !stat( path, &sb )
2180                                 && S_ISREG( sb.st_mode )
2181                                 && ( (uint64_t)sb.st_size <= length ) )
2182                bytesLeft -= sb.st_size;
2183
2184            tr_free( path );
2185        }
2186    }
2187
2188    return bytesLeft;
2189}
2190
2191/****
2192*****  Removing the torrent's local data
2193****/
2194
2195static int
2196vstrcmp( const void * a, const void * b )
2197{
2198    return strcmp( a, b );
2199}
2200
2201static int
2202compareLongestFirst( const void * a, const void * b )
2203{
2204    const size_t alen = strlen( a );
2205    const size_t blen = strlen( b );
2206
2207    if( alen != blen )
2208        return alen > blen ? -1 : 1;
2209
2210    return vstrcmp( a, b );
2211}
2212
2213static void
2214addDirtyFile( const char  * root,
2215              const char  * filename,
2216              tr_ptrArray * dirtyFolders )
2217{
2218    char * dir = tr_dirname( filename );
2219
2220    /* add the parent folders to dirtyFolders until we reach the root or a known-dirty */
2221    while (     ( dir != NULL )
2222             && ( strlen( root ) <= strlen( dir ) )
2223             && ( tr_ptrArrayFindSorted( dirtyFolders, dir, vstrcmp ) == NULL ) )
2224    {
2225        char * tmp;
2226        tr_ptrArrayInsertSorted( dirtyFolders, tr_strdup( dir ), vstrcmp );
2227
2228        tmp = tr_dirname( dir );
2229        tr_free( dir );
2230        dir = tmp;
2231    }
2232
2233    tr_free( dir );
2234}
2235
2236static void
2237walkLocalData( const tr_torrent * tor,
2238               const char       * root,
2239               const char       * dir,
2240               const char       * base,
2241               tr_ptrArray      * torrentFiles,
2242               tr_ptrArray      * folders,
2243               tr_ptrArray      * dirtyFolders )
2244{
2245    int i;
2246    struct stat sb;
2247    char * buf;
2248
2249    assert( tr_isTorrent( tor ) );
2250
2251    buf = tr_buildPath( dir, base, NULL );
2252    i = stat( buf, &sb );
2253    if( !i )
2254    {
2255        DIR * odir = NULL;
2256
2257        if( S_ISDIR( sb.st_mode ) && ( ( odir = opendir ( buf ) ) ) )
2258        {
2259            struct dirent *d;
2260            tr_ptrArrayInsertSorted( folders, tr_strdup( buf ), vstrcmp );
2261            for( d = readdir( odir ); d != NULL; d = readdir( odir ) )
2262                if( d->d_name && d->d_name[0] != '.' ) /* skip dotfiles */
2263                    walkLocalData( tor, root, buf, d->d_name, torrentFiles, folders, dirtyFolders );
2264            closedir( odir );
2265        }
2266        else if( S_ISREG( sb.st_mode ) && ( sb.st_size > 0 ) )
2267        {
2268            const char * sub = buf + strlen( tor->currentDir ) + strlen( TR_PATH_DELIMITER_STR );
2269            const tr_bool isTorrentFile = tr_ptrArrayFindSorted( torrentFiles, sub, vstrcmp ) != NULL;
2270            if( !isTorrentFile )
2271                addDirtyFile( root, buf, dirtyFolders );
2272        }
2273    }
2274
2275    tr_free( buf );
2276}
2277
2278static void
2279deleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2280{
2281    int i, n;
2282    char ** s;
2283    tr_file_index_t f;
2284    tr_ptrArray torrentFiles = TR_PTR_ARRAY_INIT;
2285    tr_ptrArray folders      = TR_PTR_ARRAY_INIT;
2286    tr_ptrArray dirtyFolders = TR_PTR_ARRAY_INIT; /* dirty == contains non-torrent files */
2287
2288    const char * firstFile = tor->info.files[0].name;
2289    const char * cpch = strchr( firstFile, TR_PATH_DELIMITER );
2290    char * tmp = cpch ? tr_strndup( firstFile, cpch - firstFile ) : NULL;
2291    char * root = tr_buildPath( tor->currentDir, tmp, NULL );
2292
2293    assert( tr_isTorrent( tor ) );
2294
2295    for( f=0; f<tor->info.fileCount; ++f ) {
2296        tr_ptrArrayInsertSorted( &torrentFiles, tr_strdup( tor->info.files[f].name ), vstrcmp );
2297        tr_ptrArrayInsertSorted( &torrentFiles, tr_torrentBuildPartial( tor, f ), vstrcmp );
2298    }
2299
2300    /* build the set of folders and dirtyFolders */
2301    walkLocalData( tor, root, root, NULL, &torrentFiles, &folders, &dirtyFolders );
2302
2303    /* try to remove entire folders first, so that the recycle bin will be tidy */
2304    s = (char**) tr_ptrArrayPeek( &folders, &n );
2305    for( i=0; i<n; ++i )
2306        if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2307            fileFunc( s[i] );
2308
2309    /* now blow away any remaining torrent files, such as torrent files in dirty folders */
2310    for( f=0; f<tor->info.fileCount; ++f ) {
2311        char * path = tr_buildPath( tor->currentDir, tor->info.files[f].name, NULL );
2312        fileFunc( path );
2313        tr_free( path );
2314    }
2315
2316    /* Now clean out the directories left empty from the previous step.
2317     * Work from deepest to shallowest s.t. lower folders
2318     * won't prevent the upper folders from being deleted */
2319    {
2320        tr_ptrArray cleanFolders = TR_PTR_ARRAY_INIT;
2321        s = (char**) tr_ptrArrayPeek( &folders, &n );
2322        for( i=0; i<n; ++i )
2323            if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2324                tr_ptrArrayInsertSorted( &cleanFolders, s[i], compareLongestFirst );
2325        s = (char**) tr_ptrArrayPeek( &cleanFolders, &n );
2326        for( i=0; i<n; ++i ) {
2327#ifdef SYS_DARWIN
2328            char * dsStore = tr_buildPath( s[i], ".DS_Store", NULL );
2329            fileFunc( dsStore );
2330            tr_free( dsStore );
2331#endif
2332            fileFunc( s[i] );
2333        }
2334        tr_ptrArrayDestruct( &cleanFolders, NULL );
2335    }
2336
2337    /* cleanup */
2338    tr_ptrArrayDestruct( &dirtyFolders, tr_free );
2339    tr_ptrArrayDestruct( &folders, tr_free );
2340    tr_ptrArrayDestruct( &torrentFiles, tr_free );
2341    tr_free( root );
2342    tr_free( tmp );
2343}
2344
2345void
2346tr_torrentDeleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2347{
2348    assert( tr_isTorrent( tor ) );
2349
2350    if( fileFunc == NULL )
2351        fileFunc = remove;
2352
2353    /* close all the files because we're about to delete them */
2354    tr_fdTorrentClose( tor->session, tor->uniqueId );
2355
2356    if( tor->info.fileCount > 1 )
2357    {
2358        deleteLocalData( tor, fileFunc );
2359    }
2360    else
2361    {
2362        char * tmp;
2363
2364        /* torrent only has one file */
2365        char * path = tr_buildPath( tor->currentDir, tor->info.files[0].name, NULL );
2366        fileFunc( path );
2367        tr_free( path );
2368
2369       
2370        tmp = tr_torrentBuildPartial( tor, 0 );
2371        path = tr_buildPath( tor->currentDir, tmp, NULL );
2372        fileFunc( path );
2373        tr_free( path );
2374        tr_free( tmp );
2375    }
2376}
2377
2378/***
2379****
2380***/
2381
2382struct LocationData
2383{
2384    tr_bool move_from_old_location;
2385    int * setme_state;
2386    double * setme_progress;
2387    char * location;
2388    tr_torrent * tor;
2389};
2390
2391static void
2392setLocation( void * vdata )
2393{
2394    tr_bool err = FALSE;
2395    tr_bool verify_needed = FALSE;
2396    struct LocationData * data = vdata;
2397    tr_torrent * tor = data->tor;
2398    const tr_bool do_move = data->move_from_old_location;
2399    const char * location = data->location;
2400    double bytesHandled = 0;
2401
2402    assert( tr_isTorrent( tor ) );
2403
2404    if( strcmp( location, tor->currentDir ) )
2405    {
2406        tr_file_index_t i;
2407
2408        /* bad idea to move files while they're being verified... */
2409        tr_verifyRemove( tor );
2410
2411        /* if the torrent is running, stop it and set a flag to
2412         * restart after we're done */
2413        if( tor->isRunning )
2414        {
2415            tr_torrentStop( tor );
2416            tor->startAfterVerify = TRUE;
2417        }
2418
2419        /* try to move the files.
2420         * FIXME: there are still all kinds of nasty cases, like what
2421         * if the target directory runs out of space halfway through... */
2422        for( i=0; !err && i<tor->info.fileCount; ++i )
2423        {
2424            const tr_file * f = &tor->info.files[i];
2425            const char * oldbase;
2426            char * sub;
2427            if( tr_torrentFindFile2( tor, i, &oldbase, &sub ) )
2428            {
2429                char * oldpath = tr_buildPath( oldbase, sub, NULL );
2430                char * newpath = tr_buildPath( location, sub, NULL );
2431
2432                if( do_move )
2433                {
2434                    tr_bool renamed = FALSE;
2435                    errno = 0;
2436                    tr_torinf( tor, "moving \"%s\" to \"%s\"", oldpath, newpath );
2437                    if( tr_moveFile( oldpath, newpath, &renamed ) )
2438                    {
2439                        err = TRUE;
2440                        tr_torerr( tor, "error moving \"%s\" to \"%s\": %s",
2441                                        oldpath, newpath, tr_strerror( errno ) );
2442                    }
2443                    else if( !renamed )
2444                    {
2445                        verify_needed = TRUE;
2446                    }
2447                }
2448
2449                tr_free( newpath );
2450                tr_free( oldpath );
2451                tr_free( sub );
2452            }
2453
2454            if( data->setme_progress )
2455            {
2456                bytesHandled += f->length;
2457                *data->setme_progress = bytesHandled / tor->info.totalSize;
2458            }
2459        }
2460
2461        if( !err )
2462        {
2463            /* blow away the leftover subdirectories in the old location */
2464            if( do_move )
2465                tr_torrentDeleteLocalData( tor, remove );
2466
2467            /* set the new location and reverify */
2468            tr_torrentSetDownloadDir( tor, location );
2469            if( verify_needed )
2470                tr_torrentVerify( tor );
2471            else if( tor->startAfterVerify ) {
2472                tor->startAfterVerify = FALSE;
2473                tr_torrentStart( tor );
2474            }
2475        }
2476    }
2477
2478    if( data->setme_state )
2479        *data->setme_state = err ? TR_LOC_ERROR : TR_LOC_DONE;
2480
2481    /* cleanup */
2482    tr_free( data->location );
2483    tr_free( data );
2484}
2485
2486void
2487tr_torrentSetLocation( tr_torrent  * tor,
2488                       const char  * location,
2489                       tr_bool       move_from_old_location,
2490                       double      * setme_progress,
2491                       int         * setme_state )
2492{
2493    struct LocationData * data;
2494
2495    assert( tr_isTorrent( tor ) );
2496
2497    if( setme_state )
2498        *setme_state = TR_LOC_MOVING;
2499    if( setme_progress )
2500        *setme_progress = 0;
2501
2502    /* run this in the libtransmission thread */
2503    data = tr_new( struct LocationData, 1 );
2504    data->tor = tor;
2505    data->location = tr_strdup( location );
2506    data->move_from_old_location = move_from_old_location;
2507    data->setme_state = setme_state;
2508    data->setme_progress = setme_progress;
2509    tr_runInEventThread( tor->session, setLocation, data );
2510}
2511
2512/***
2513****
2514***/
2515
2516void
2517tr_torrentCheckSeedRatio( tr_torrent * tor )
2518{
2519    double seedRatio;
2520
2521    assert( tr_isTorrent( tor ) );
2522
2523    /* if we're seeding and we've reached our seed ratio limit, stop the torrent */
2524    if( tor->isRunning && tr_torrentIsSeed( tor ) && tr_torrentGetSeedRatio( tor, &seedRatio ) )
2525    {
2526        const uint64_t up = tor->uploadedCur + tor->uploadedPrev;
2527        uint64_t down = tor->downloadedCur + tor->downloadedPrev;
2528        double ratio;
2529
2530        /* maybe we're the initial seeder and never downloaded anything... */
2531        if( down == 0 )
2532            down = tr_cpHaveValid( &tor->completion );
2533
2534        ratio = tr_getRatio( up, down );
2535
2536        if( ratio >= seedRatio || ratio == TR_RATIO_INF )
2537        {
2538            tr_torrentStop( tor );
2539
2540            /* set to no ratio limit to allow easy restarting */
2541            tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_UNLIMITED );
2542
2543            /* maybe notify the client */
2544            if( tor->ratio_limit_hit_func != NULL )
2545                tor->ratio_limit_hit_func( tor, tor->ratio_limit_hit_func_user_data );
2546        }
2547    }
2548}
2549
2550/***
2551****
2552***/
2553
2554void
2555tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNum )
2556{
2557    char * sub;
2558    const char * base;
2559
2560    /* close the file so that we can reopen in read-only mode as needed */
2561    tr_fdFileClose( tor->session, tor, fileNum );
2562
2563    /* if the torrent's filename on disk isn't the same as the one in the metadata,
2564     * then it's been modified to denote that it was a partial file.
2565     * Now that it's complete, use the proper filename. */
2566    if( tr_torrentFindFile2( tor, fileNum, &base, &sub ) )
2567    {
2568        const tr_file * file = &tor->info.files[fileNum];
2569
2570        if( strcmp( sub, file->name ) )
2571        {
2572            char * oldpath = tr_buildPath( base, sub, NULL );
2573            char * newpath = tr_buildPath( base, file->name, NULL );
2574
2575            if( rename( oldpath, newpath ) )
2576                tr_torerr( tor, "Error moving \"%s\" to \"%s\": %s", oldpath, newpath, tr_strerror( errno ) );
2577
2578            tr_free( newpath );
2579            tr_free( oldpath );
2580        }
2581
2582        tr_free( sub );
2583    }
2584}
2585
2586/***
2587****
2588***/
2589
2590static tr_bool
2591fileExists( const char * filename )
2592{
2593    struct stat sb;
2594    const tr_bool ok = !stat( filename, &sb );
2595    return ok;
2596}
2597
2598tr_bool
2599tr_torrentFindFile2( const tr_torrent * tor, tr_file_index_t fileNum,
2600                     const char ** base, char ** subpath )
2601{
2602    char * part;
2603    const tr_file * file;
2604    const char * b = NULL;
2605    const char * s = NULL;
2606
2607    assert( tr_isTorrent( tor ) );
2608    assert( fileNum < tor->info.fileCount );
2609
2610    file = &tor->info.files[fileNum];
2611    part = tr_torrentBuildPartial( tor, fileNum );
2612
2613    if( b == NULL ) {
2614        char * filename = tr_buildPath( tor->downloadDir, file->name, NULL );
2615        if( fileExists( filename ) ) {
2616            b = tor->downloadDir;
2617            s = file->name;
2618        }
2619        tr_free( filename );
2620    }
2621
2622    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2623        char * filename = tr_buildPath( tor->incompleteDir, file->name, NULL );
2624        if( fileExists( filename ) ) {
2625            b = tor->incompleteDir;
2626            s = file->name;
2627        }
2628        tr_free( filename );
2629    }
2630
2631    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2632        char * filename = tr_buildPath( tor->incompleteDir, part, NULL );
2633        if( fileExists( filename ) ) {
2634            b = tor->incompleteDir;
2635            s = part;
2636        }
2637        tr_free( filename );
2638    }
2639
2640    if( b == NULL) {
2641        char * filename = tr_buildPath( tor->downloadDir, part, NULL );
2642        if( fileExists( filename ) ) {
2643            b = tor->downloadDir;
2644            s = part;
2645        }
2646        tr_free( filename );
2647    }
2648
2649    if( base != NULL )
2650        *base = b;
2651    if( subpath != NULL )
2652        *subpath = tr_strdup( s );
2653
2654    tr_free( part );
2655    return b != NULL;
2656}
2657
2658
2659char*
2660tr_torrentFindFile( const tr_torrent * tor, tr_file_index_t fileNum )
2661{
2662    char * subpath;
2663    char * ret = NULL;
2664    const char * base;
2665
2666    if( tr_torrentFindFile2( tor, fileNum, &base, &subpath ) )
2667    {
2668        ret = tr_buildPath( base, subpath, NULL );
2669        tr_free( subpath );
2670    }
2671
2672    return ret;
2673}
2674
2675/* Decide whether we should be looking for files in downloadDir or incompleteDir. */
2676static void
2677refreshCurrentDir( tr_torrent * tor )
2678{
2679    const char * dir = NULL;
2680    char * sub;
2681
2682    if( tor->incompleteDir == NULL )
2683        dir = tor->downloadDir;
2684    else if( !tr_torrentFindFile2( tor, 0, &dir, &sub ) )
2685        dir = tor->incompleteDir;
2686
2687    assert( dir != NULL );
2688    assert( ( dir == tor->downloadDir ) || ( dir == tor->incompleteDir ) );
2689    tor->currentDir = dir;
2690}
2691
2692char*
2693tr_torrentBuildPartial( const tr_torrent * tor, tr_file_index_t fileNum )
2694{
2695    return tr_strdup_printf( "%s.part", tor->info.files[fileNum].name );
2696}
Note: See TracBrowser for help on using the repository browser.