source: trunk/libtransmission/torrent.c @ 8214

Last change on this file since 8214 was 8214, checked in by charles, 13 years ago

(trunk libT) startup uses less cpu now on big torrents. another cachegrind discovery

  • Property svn:keywords set to Date Rev Author Id
File size: 55.6 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 8214 2009-04-11 06:58:14Z charles $
11 */
12
13#include <sys/types.h> /* stat */
14#include <sys/stat.h> /* stat */
15#include <unistd.h> /* stat */
16#include <dirent.h>
17
18#include <assert.h>
19#include <limits.h> /* INT_MAX */
20#include <string.h> /* memcmp */
21#include <stdlib.h> /* qsort */
22
23#include <event.h> /* evbuffer */
24
25#include "transmission.h"
26#include "session.h"
27#include "bandwidth.h"
28#include "bencode.h"
29#include "completion.h"
30#include "crypto.h" /* for tr_sha1 */
31#include "resume.h"
32#include "fdlimit.h" /* tr_fdFileClose */
33#include "metainfo.h"
34#include "peer-mgr.h"
35#include "platform.h" /* TR_PATH_DELIMITER_STR */
36#include "ptrarray.h"
37#include "ratecontrol.h"
38#include "torrent.h"
39#include "tracker.h"
40#include "trevent.h"
41#include "utils.h"
42#include "verify.h"
43
44#define MAX_BLOCK_SIZE ( 1024 * 16 )
45
46/***
47****
48***/
49
50int
51tr_torrentId( const tr_torrent * tor )
52{
53    return tor->uniqueId;
54}
55
56tr_torrent*
57tr_torrentFindFromId( tr_session * session, int id )
58{
59    tr_torrent * tor = NULL;
60
61    while(( tor = tr_torrentNext( session, tor )))
62        if( tor->uniqueId == id )
63            return tor;
64
65    return NULL;
66}
67
68tr_torrent*
69tr_torrentFindFromHashString( tr_session *  session, const char * str )
70{
71    tr_torrent * tor = NULL;
72
73    while(( tor = tr_torrentNext( session, tor )))
74        if( !strcmp( str, tor->info.hashString ) )
75            return tor;
76
77    return NULL;
78}
79
80tr_torrent*
81tr_torrentFindFromHash( tr_session * session, const uint8_t * torrentHash )
82{
83    tr_torrent * tor = NULL;
84
85    while(( tor = tr_torrentNext( session, tor )))
86        if( *tor->info.hash == *torrentHash )
87            if( !memcmp( tor->info.hash, torrentHash, SHA_DIGEST_LENGTH ) )
88                return tor;
89
90    return NULL;
91}
92
93tr_torrent*
94tr_torrentFindFromObfuscatedHash( tr_session * session,
95                                  const uint8_t * obfuscatedTorrentHash )
96{
97    tr_torrent * tor = NULL;
98
99    while(( tor = tr_torrentNext( session, tor )))
100        if( !memcmp( tor->obfuscatedHash, obfuscatedTorrentHash,
101                     SHA_DIGEST_LENGTH ) )
102            return tor;
103
104    return NULL;
105}
106
107/***
108****  PER-TORRENT UL / DL SPEEDS
109***/
110
111void
112tr_torrentSetSpeedLimit( tr_torrent * tor, tr_direction dir, int KiB_sec )
113{
114    assert( tr_isTorrent( tor ) );
115    assert( tr_isDirection( dir ) );
116
117    tr_bandwidthSetDesiredSpeed( tor->bandwidth, dir, KiB_sec );
118}
119
120int
121tr_torrentGetSpeedLimit( const tr_torrent * tor, tr_direction dir )
122{
123    assert( tr_isTorrent( tor ) );
124    assert( tr_isDirection( dir ) );
125
126    return tr_bandwidthGetDesiredSpeed( tor->bandwidth, dir );
127}
128
129void
130tr_torrentUseSpeedLimit( tr_torrent * tor, tr_direction dir, tr_bool do_use )
131{
132    assert( tr_isTorrent( tor ) );
133    assert( tr_isDirection( dir ) );
134
135    tr_bandwidthSetLimited( tor->bandwidth, dir, do_use );
136}
137
138tr_bool
139tr_torrentUsesSpeedLimit( const tr_torrent * tor, tr_direction dir )
140{
141    assert( tr_isTorrent( tor ) );
142    assert( tr_isDirection( dir ) );
143
144    return tr_bandwidthIsLimited( tor->bandwidth, dir );
145}
146
147void
148tr_torrentUseSessionLimits( tr_torrent * tor, tr_bool doUse )
149{
150    assert( tr_isTorrent( tor ) );
151
152    tr_bandwidthHonorParentLimits( tor->bandwidth, TR_UP, doUse );
153    tr_bandwidthHonorParentLimits( tor->bandwidth, TR_DOWN, doUse );
154}
155
156tr_bool
157tr_torrentUsesSessionLimits( const tr_torrent * tor )
158{
159    assert( tr_isTorrent( tor ) );
160
161    return tr_bandwidthAreParentLimitsHonored( tor->bandwidth, TR_UP );
162}
163
164/***
165****
166***/
167
168void
169tr_torrentSetRatioMode( tr_torrent *  tor, tr_ratiolimit mode )
170{
171    assert( tr_isTorrent( tor ) );
172    assert( mode==TR_RATIOLIMIT_GLOBAL || mode==TR_RATIOLIMIT_SINGLE || mode==TR_RATIOLIMIT_UNLIMITED  );
173
174    tor->ratioLimitMode = mode;
175    tor->needsSeedRatioCheck = TRUE;
176}
177
178tr_ratiolimit
179tr_torrentGetRatioMode( const tr_torrent * tor )
180{
181    assert( tr_isTorrent( tor ) );
182
183    return tor->ratioLimitMode;
184}
185
186void
187tr_torrentSetRatioLimit( tr_torrent * tor, double desiredRatio )
188{
189    assert( tr_isTorrent( tor ) );
190
191    tor->desiredRatio = desiredRatio;
192
193    tor->needsSeedRatioCheck = TRUE;
194}
195
196double
197tr_torrentGetRatioLimit( const tr_torrent * tor )
198{
199    assert( tr_isTorrent( tor ) );
200
201    return tor->desiredRatio;
202}
203
204tr_bool
205tr_torrentIsPieceTransferAllowed( const tr_torrent  * tor,
206                                  tr_direction        direction )
207{
208    int limit;
209    tr_bool allowed = TRUE;
210
211    if( tr_torrentUsesSpeedLimit( tor, direction ) )
212        if( tr_torrentGetSpeedLimit( tor, direction ) <= 0 )
213            allowed = FALSE;
214
215    if( tr_torrentUsesSessionLimits( tor ) )
216        if( tr_sessionGetActiveSpeedLimit( tor->session, direction, &limit ) )
217            if( limit <= 0 )
218                allowed = FALSE;
219
220    return allowed;
221}
222
223tr_bool
224tr_torrentGetSeedRatio( const tr_torrent * tor, double * ratio )
225{
226    tr_bool isLimited;
227
228    switch( tr_torrentGetRatioMode( tor ) )
229    {
230        case TR_RATIOLIMIT_SINGLE:
231            isLimited = TRUE;
232            if( ratio )
233                *ratio = tr_torrentGetRatioLimit( tor );
234            break;
235
236        case TR_RATIOLIMIT_GLOBAL:
237            isLimited = tr_sessionIsRatioLimited( tor->session );
238            if( isLimited && ratio )
239                *ratio = tr_sessionGetRatioLimit( tor->session );
240            break;
241
242        case TR_RATIOLIMIT_UNLIMITED:
243            isLimited = FALSE;
244            break;
245    }
246
247    return isLimited;
248}
249
250/***
251****
252***/
253
254static void
255onTrackerResponse( void * tracker UNUSED,
256                   void *         vevent,
257                   void *         user_data )
258{
259    tr_torrent *       tor = user_data;
260    tr_tracker_event * event = vevent;
261
262    switch( event->messageType )
263    {
264        case TR_TRACKER_PEERS:
265        {
266            size_t   i, n;
267            tr_pex * pex = tr_peerMgrArrayToPex( event->compact,
268                                                 event->compactLen, &n );
269             if( event->allAreSeeds )
270                tr_tordbg( tor, "Got %d seeds from tracker", (int)n );
271            else
272                tr_torinf( tor, _( "Got %d peers from tracker" ), (int)n );
273
274            for( i = 0; i < n; ++i )
275            {
276                if( event->allAreSeeds )
277                    pex[i].flags |= ADDED_F_SEED_FLAG;
278                tr_peerMgrAddPex( tor, TR_PEER_FROM_TRACKER, pex + i );
279            }
280
281            tr_free( pex );
282            break;
283        }
284
285        case TR_TRACKER_WARNING:
286            tr_torerr( tor, _( "Tracker warning: \"%s\"" ), event->text );
287            tor->error = -1;
288            tr_strlcpy( tor->errorString, event->text,
289                       sizeof( tor->errorString ) );
290            break;
291
292        case TR_TRACKER_ERROR:
293            tr_torerr( tor, _( "Tracker error: \"%s\"" ), event->text );
294            tor->error = -2;
295            tr_strlcpy( tor->errorString, event->text,
296                       sizeof( tor->errorString ) );
297            break;
298
299        case TR_TRACKER_ERROR_CLEAR:
300            tor->error = 0;
301            tor->errorString[0] = '\0';
302            break;
303    }
304}
305
306/***
307****
308****  TORRENT INSTANTIATION
309****
310***/
311
312static int
313getBytePiece( const tr_info * info,
314              uint64_t        byteOffset )
315{
316    assert( info );
317    assert( info->pieceSize != 0 );
318
319    return byteOffset / info->pieceSize;
320}
321
322static void
323initFilePieces( tr_info *       info,
324                tr_file_index_t fileIndex )
325{
326    tr_file * file;
327    uint64_t  firstByte, lastByte;
328
329    assert( info );
330    assert( fileIndex < info->fileCount );
331
332    file = &info->files[fileIndex];
333    firstByte = file->offset;
334    lastByte = firstByte + ( file->length ? file->length - 1 : 0 );
335    file->firstPiece = getBytePiece( info, firstByte );
336    file->lastPiece = getBytePiece( info, lastByte );
337}
338
339static int
340pieceHasFile( tr_piece_index_t piece,
341              const tr_file *  file )
342{
343    return ( file->firstPiece <= piece ) && ( piece <= file->lastPiece );
344}
345
346static tr_priority_t
347calculatePiecePriority( const tr_torrent * tor,
348                        tr_piece_index_t   piece,
349                        int                fileHint )
350{
351    tr_file_index_t i;
352    int             priority = TR_PRI_LOW;
353
354    /* find the first file that has data in this piece */
355    if( fileHint >= 0 ) {
356        i = fileHint;
357        while( i > 0 && pieceHasFile( piece, &tor->info.files[i - 1] ) )
358            --i;
359    } else {
360        for( i = 0; i < tor->info.fileCount; ++i )
361            if( pieceHasFile( piece, &tor->info.files[i] ) )
362                break;
363    }
364
365    /* the piece's priority is the max of the priorities
366     * of all the files in that piece */
367    for( ; i < tor->info.fileCount; ++i )
368    {
369        const tr_file * file = &tor->info.files[i];
370
371        if( !pieceHasFile( piece, file ) )
372            break;
373
374        priority = MAX( priority, file->priority );
375
376        /* when dealing with multimedia files, getting the first and
377           last pieces can sometimes allow you to preview it a bit
378           before it's fully downloaded... */
379        if( file->priority >= TR_PRI_NORMAL )
380            if( file->firstPiece == piece || file->lastPiece == piece )
381                priority = TR_PRI_HIGH;
382    }
383
384    return priority;
385}
386
387static void
388tr_torrentInitFilePieces( tr_torrent * tor )
389{
390    tr_file_index_t  f;
391    tr_piece_index_t p;
392    uint64_t offset = 0;
393    tr_info * inf = &tor->info;
394    int * firstFiles;
395
396    /* assign the file offsets */
397    for( f=0; f<inf->fileCount; ++f ) {
398        inf->files[f].offset = offset;
399        offset += inf->files[f].length;
400        initFilePieces( inf, f );
401    }
402
403    /* build the array of first-file hints to give calculatePiecePriority */
404    firstFiles = tr_new( int, inf->pieceCount );
405    for( p=f=0; p<inf->pieceCount; ++p ) {
406        if( inf->files[f].lastPiece < p )
407            ++f;
408        firstFiles[p] = f;
409    }
410
411
412#if 0
413    /* test to confirm the first-file hints are correct */
414    for( p=0; p<inf->pieceCount; ++p ) {
415        f = firstFiles[p];
416        assert( inf->files[f].firstPiece <= p );
417        assert( inf->files[f].lastPiece >= p );
418        if( f > 0 )
419            assert( inf->files[f-1].lastPiece < p );
420    }
421#endif
422
423    for( p=0; p<inf->pieceCount; ++p )
424        inf->pieces[p].priority = calculatePiecePriority( tor, p, firstFiles[p] );
425
426    tr_free( firstFiles );
427}
428
429int
430tr_torrentPromoteTracker( tr_torrent * tor,
431                          int          pos )
432{
433    int i;
434    int tier;
435
436    assert( tor );
437    assert( ( 0 <= pos ) && ( pos < tor->info.trackerCount ) );
438
439    /* the tier of the tracker we're promoting */
440    tier = tor->info.trackers[pos].tier;
441
442    /* find the index of that tier's first tracker */
443    for( i = 0; i < tor->info.trackerCount; ++i )
444        if( tor->info.trackers[i].tier == tier )
445            break;
446
447    assert( i < tor->info.trackerCount );
448
449    /* promote the tracker at `pos' to the front of the tier */
450    if( i != pos )
451    {
452        const tr_tracker_info tmp = tor->info.trackers[i];
453        tor->info.trackers[i] = tor->info.trackers[pos];
454        tor->info.trackers[pos] = tmp;
455    }
456
457    /* return the new position of the tracker that started out at [pos] */
458    return i;
459}
460
461struct RandomTracker
462{
463    tr_tracker_info    tracker;
464    int                random_value;
465};
466
467/* the tiers will be sorted from lowest to highest,
468 * and trackers are randomized within the tiers */
469static TR_INLINE int
470compareRandomTracker( const void * va,
471                      const void * vb )
472{
473    const struct RandomTracker * a = va;
474    const struct RandomTracker * b = vb;
475
476    if( a->tracker.tier != b->tracker.tier )
477        return a->tracker.tier - b->tracker.tier;
478
479    return a->random_value - b->random_value;
480}
481
482static void
483randomizeTiers( tr_info * info )
484{
485    int                    i;
486    const int              n = info->trackerCount;
487    struct RandomTracker * r = tr_new0( struct RandomTracker, n );
488
489    for( i = 0; i < n; ++i )
490    {
491        r[i].tracker = info->trackers[i];
492        r[i].random_value = tr_cryptoRandInt( INT_MAX );
493    }
494    qsort( r, n, sizeof( struct RandomTracker ), compareRandomTracker );
495    for( i = 0; i < n; ++i )
496        info->trackers[i] = r[i].tracker;
497    tr_free( r );
498}
499
500static void torrentStart( tr_torrent * tor,
501                          int          reloadProgress );
502
503/**
504 * Decide on a block size.  constraints:
505 * (1) most clients decline requests over 16 KiB
506 * (2) pieceSize must be a multiple of block size
507 */
508static uint32_t
509getBlockSize( uint32_t pieceSize )
510{
511    uint32_t b = pieceSize;
512
513    while( b > MAX_BLOCK_SIZE )
514        b /= 2u;
515
516    if( !b || ( pieceSize % b ) ) /* not cleanly divisible */
517        return 0;
518    return b;
519}
520
521static void
522torrentRealInit( tr_torrent * tor, const tr_ctor * ctor )
523{
524    int          doStart;
525    uint64_t     loaded;
526    uint64_t     t;
527    const char * dir;
528    static int   nextUniqueId = 1;
529    tr_info    * info = &tor->info;
530    tr_session * session = tr_ctorGetSession( ctor );
531
532    assert( session != NULL );
533
534    tr_globalLock( session );
535
536    tor->session   = session;
537    tor->uniqueId = nextUniqueId++;
538    tor->magicNumber = TORRENT_MAGIC_NUMBER;
539
540    randomizeTiers( info );
541
542    tor->bandwidth = tr_bandwidthNew( session, session->bandwidth );
543
544    tor->blockSize = getBlockSize( info->pieceSize );
545
546    if( !tr_ctorGetDownloadDir( ctor, TR_FORCE, &dir ) ||
547        !tr_ctorGetDownloadDir( ctor, TR_FALLBACK, &dir ) )
548            tor->downloadDir = tr_strdup( dir );
549
550    tor->lastPieceSize = info->totalSize % info->pieceSize;
551
552    if( !tor->lastPieceSize )
553        tor->lastPieceSize = info->pieceSize;
554
555    tor->lastBlockSize = info->totalSize % tor->blockSize;
556
557    if( !tor->lastBlockSize )
558        tor->lastBlockSize = tor->blockSize;
559
560    tor->blockCount =
561        ( info->totalSize + tor->blockSize - 1 ) / tor->blockSize;
562
563    tor->blockCountInPiece =
564        info->pieceSize / tor->blockSize;
565
566    tor->blockCountInLastPiece =
567        ( tor->lastPieceSize + tor->blockSize - 1 ) / tor->blockSize;
568
569    /* check our work */
570    assert( ( info->pieceSize % tor->blockSize ) == 0 );
571    t = info->pieceCount - 1;
572    t *= info->pieceSize;
573    t += tor->lastPieceSize;
574    assert( t == info->totalSize );
575    t = tor->blockCount - 1;
576    t *= tor->blockSize;
577    t += tor->lastBlockSize;
578    assert( t == info->totalSize );
579    t = info->pieceCount - 1;
580    t *= tor->blockCountInPiece;
581    t += tor->blockCountInLastPiece;
582    assert( t == (uint64_t)tor->blockCount );
583
584    tr_cpConstruct( &tor->completion, tor );
585
586    tr_torrentInitFilePieces( tor );
587
588    tr_rcConstruct( &tor->swarmSpeed );
589
590    tr_sha1( tor->obfuscatedHash, "req2", 4,
591             info->hash, SHA_DIGEST_LENGTH,
592             NULL );
593
594    tr_peerMgrAddTorrent( session->peerMgr, tor );
595
596    assert( session->isPortSet );
597    assert( !tor->downloadedCur );
598    assert( !tor->uploadedCur );
599
600    tr_ctorInitTorrentPriorities( ctor, tor );
601
602    tr_ctorInitTorrentWanted( ctor, tor );
603
604    tor->error   = 0;
605
606    tr_bitfieldConstruct( &tor->checkedPieces, tor->info.pieceCount );
607    tr_torrentUncheck( tor );
608
609    tr_torrentSetAddedDate( tor, time( NULL ) ); /* this is a default value to be
610                                                    overwritten by the resume file */
611
612    loaded = tr_torrentLoadResume( tor, ~0, ctor );
613
614    doStart = tor->isRunning;
615    tor->isRunning = 0;
616
617    if( !( loaded & TR_FR_SPEEDLIMIT ) )
618    {
619        tr_torrentUseSpeedLimit( tor, TR_UP, FALSE );
620        tr_torrentUseSpeedLimit( tor, TR_DOWN, FALSE );
621        tr_torrentUseSessionLimits( tor, TRUE );
622    }
623
624    if( !( loaded & TR_FR_RATIOLIMIT ) )
625    {
626        tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_GLOBAL );
627        tr_torrentSetRatioLimit( tor, tr_sessionGetRatioLimit( tor->session ) );
628    }
629
630    tor->completeness = tr_cpGetStatus( &tor->completion );
631
632    tor->tracker = tr_trackerNew( tor );
633    tor->trackerSubscription =
634        tr_trackerSubscribe( tor->tracker, onTrackerResponse,
635                             tor );
636
637    {
638        tr_torrent * it = NULL;
639        tr_torrent * last = NULL;
640        while( ( it = tr_torrentNext( session, it ) ) )
641            last = it;
642
643        if( !last )
644            session->torrentList = tor;
645        else
646            last->next = tor;
647        ++session->torrentCount;
648    }
649
650    tr_globalUnlock( session );
651
652    /* maybe save our own copy of the metainfo */
653    if( tr_ctorGetSave( ctor ) )
654    {
655        const tr_benc * val;
656        if( !tr_ctorGetMetainfo( ctor, &val ) )
657        {
658            const char * filename = tor->info.torrent;
659            tr_bencSaveFile( filename, val );
660            tr_sessionSetTorrentFile( tor->session, tor->info.hashString,
661                                      filename );
662        }
663    }
664
665    tr_metainfoMigrate( session, &tor->info );
666
667    if( doStart )
668        torrentStart( tor, FALSE );
669}
670
671int
672tr_torrentParse( const tr_ctor     * ctor,
673                 tr_info           * setmeInfo )
674{
675    int             err = 0;
676    int             doFree;
677    tr_info         tmp;
678    const tr_benc * metainfo;
679    tr_session    * session = tr_ctorGetSession( ctor );
680
681    if( setmeInfo == NULL )
682        setmeInfo = &tmp;
683    memset( setmeInfo, 0, sizeof( tr_info ) );
684
685    if( !err && tr_ctorGetMetainfo( ctor, &metainfo ) )
686        return TR_EINVALID;
687
688    err = tr_metainfoParse( session, setmeInfo, metainfo );
689    doFree = !err && ( setmeInfo == &tmp );
690
691    if( !err && !getBlockSize( setmeInfo->pieceSize ) )
692        err = TR_EINVALID;
693
694    if( !err && session && tr_torrentExists( session, setmeInfo->hash ) )
695        err = TR_EDUPLICATE;
696
697    if( doFree )
698        tr_metainfoFree( setmeInfo );
699
700    return err;
701}
702
703tr_torrent *
704tr_torrentNew( const tr_ctor  * ctor,
705               int            * setmeError )
706{
707    int          err;
708    tr_info      tmpInfo;
709    tr_torrent * tor = NULL;
710
711    assert( ctor != NULL );
712    assert( tr_isSession( tr_ctorGetSession( ctor ) ) );
713
714    err = tr_torrentParse( ctor, &tmpInfo );
715    if( !err )
716    {
717        tor = tr_new0( tr_torrent, 1 );
718        tor->info = tmpInfo;
719        torrentRealInit( tor, ctor );
720    }
721    else if( setmeError )
722    {
723        *setmeError = err;
724    }
725
726    return tor;
727}
728
729/**
730***
731**/
732
733void
734tr_torrentSetDownloadDir( tr_torrent * tor,
735                          const char * path )
736{
737    assert( tr_isTorrent( tor  ) );
738
739    if( !path || !tor->downloadDir || strcmp( path, tor->downloadDir ) )
740    {
741        tr_free( tor->downloadDir );
742        tor->downloadDir = tr_strdup( path );
743        tr_torrentSaveResume( tor );
744    }
745}
746
747const char*
748tr_torrentGetDownloadDir( const tr_torrent * tor )
749{
750    assert( tr_isTorrent( tor  ) );
751
752    return tor->downloadDir;
753}
754
755void
756tr_torrentChangeMyPort( tr_torrent * tor )
757{
758    assert( tr_isTorrent( tor  ) );
759
760    if( tor->tracker )
761        tr_trackerChangeMyPort( tor->tracker );
762}
763
764static TR_INLINE void
765tr_torrentManualUpdateImpl( void * vtor )
766{
767    tr_torrent * tor = vtor;
768
769    assert( tr_isTorrent( tor  ) );
770
771    if( tor->isRunning )
772        tr_trackerReannounce( tor->tracker );
773}
774
775void
776tr_torrentManualUpdate( tr_torrent * tor )
777{
778    assert( tr_isTorrent( tor  ) );
779
780    tr_runInEventThread( tor->session, tr_torrentManualUpdateImpl, tor );
781}
782
783tr_bool
784tr_torrentCanManualUpdate( const tr_torrent * tor )
785{
786    return ( tr_isTorrent( tor  ) )
787        && ( tor->isRunning )
788        && ( tr_trackerCanManualAnnounce( tor->tracker ) );
789}
790
791const tr_info *
792tr_torrentInfo( const tr_torrent * tor )
793{
794    return tr_isTorrent( tor ) ? &tor->info : NULL;
795}
796
797const tr_stat *
798tr_torrentStatCached( tr_torrent * tor )
799{
800    const time_t now = time( NULL );
801
802    return tr_isTorrent( tor ) && ( now == tor->lastStatTime )
803         ? &tor->stats
804         : tr_torrentStat( tor );
805}
806
807void
808tr_torrentSetVerifyState( tr_torrent * tor, tr_verify_state state )
809{
810    assert( tr_isTorrent( tor ) );
811    assert( state==TR_VERIFY_NONE || state==TR_VERIFY_WAIT || state==TR_VERIFY_NOW );
812
813    tor->verifyState = state;
814    tor->anyDate = time( NULL );
815}
816
817tr_torrent_activity
818tr_torrentGetActivity( tr_torrent * tor )
819{
820    assert( tr_isTorrent( tor ) );
821
822    tr_torrentRecheckCompleteness( tor );
823
824    if( tor->verifyState == TR_VERIFY_NOW )
825        return TR_STATUS_CHECK;
826    if( tor->verifyState == TR_VERIFY_WAIT )
827        return TR_STATUS_CHECK_WAIT;
828    if( !tor->isRunning )
829        return TR_STATUS_STOPPED;
830    if( tor->completeness == TR_LEECH )
831        return TR_STATUS_DOWNLOAD;
832
833    return TR_STATUS_SEED;
834}
835
836const tr_stat *
837tr_torrentStat( tr_torrent * tor )
838{
839    tr_stat *               s;
840    struct tr_tracker *     tc;
841    const tr_tracker_info * ti;
842    int                     usableSeeds = 0;
843    uint64_t                now;
844    double                  downloadedForRatio, seedRatio;
845    tr_bool                 checkSeedRatio;
846
847    if( !tor )
848        return NULL;
849
850    assert( tr_isTorrent( tor ) );
851    tr_torrentLock( tor );
852
853    tor->lastStatTime = time( NULL );
854
855    s = &tor->stats;
856    s->id = tor->uniqueId;
857    s->activity = tr_torrentGetActivity( tor );
858    s->error  = tor->error;
859    memcpy( s->errorString, tor->errorString,
860           sizeof( s->errorString ) );
861
862    tc = tor->tracker;
863    ti = tr_trackerGetAddress( tor->tracker, tor );
864    s->announceURL = ti ? ti->announce : NULL;
865    s->scrapeURL   = ti ? ti->scrape   : NULL;
866    tr_trackerStat( tc, s );
867
868    tr_trackerGetCounts( tc, &s->timesCompleted,
869                             &s->leechers,
870                             &s->seeders,
871                             &s->downloaders );
872
873    tr_peerMgrTorrentStats( tor,
874                            &s->peersKnown,
875                            &s->peersConnected,
876                            &usableSeeds,
877                            &s->webseedsSendingToUs,
878                            &s->peersSendingToUs,
879                            &s->peersGettingFromUs,
880                            s->peersFrom );
881
882    now = tr_date( );
883    s->swarmSpeed         = tr_rcRate( &tor->swarmSpeed, now );
884    s->rawUploadSpeed     = tr_bandwidthGetRawSpeed  ( tor->bandwidth, now, TR_UP );
885    s->rawDownloadSpeed   = tr_bandwidthGetRawSpeed  ( tor->bandwidth, now, TR_DOWN );
886    s->pieceUploadSpeed   = tr_bandwidthGetPieceSpeed( tor->bandwidth, now, TR_UP );
887    s->pieceDownloadSpeed = tr_bandwidthGetPieceSpeed( tor->bandwidth, now, TR_DOWN );
888
889    usableSeeds += tor->info.webseedCount;
890
891    s->percentComplete = tr_cpPercentComplete ( &tor->completion );
892
893    s->percentDone   = tr_cpPercentDone  ( &tor->completion );
894    s->leftUntilDone = tr_cpLeftUntilDone( &tor->completion );
895    s->sizeWhenDone  = tr_cpSizeWhenDone ( &tor->completion );
896
897    s->recheckProgress = s->activity == TR_STATUS_CHECK
898                       ? 1.0 -
899                         ( tr_torrentCountUncheckedPieces( tor ) /
900                           (double) tor->info.pieceCount )
901                       : 0.0;
902
903    s->activityDate = tor->activityDate;
904    s->addedDate    = tor->addedDate;
905    s->doneDate     = tor->doneDate;
906    s->startDate    = tor->startDate;
907
908    s->corruptEver     = tor->corruptCur    + tor->corruptPrev;
909    s->downloadedEver  = tor->downloadedCur + tor->downloadedPrev;
910    s->uploadedEver    = tor->uploadedCur   + tor->uploadedPrev;
911    s->haveValid       = tr_cpHaveValid( &tor->completion );
912    s->haveUnchecked   = tr_cpHaveTotal( &tor->completion ) - s->haveValid;
913
914    if( usableSeeds > 0 )
915    {
916        s->desiredAvailable = s->leftUntilDone;
917    }
918    else if( !s->leftUntilDone || !s->peersConnected )
919    {
920        s->desiredAvailable = 0;
921    }
922    else
923    {
924        tr_piece_index_t i;
925        tr_bitfield *    peerPieces = tr_peerMgrGetAvailable( tor );
926        s->desiredAvailable = 0;
927        for( i = 0; i < tor->info.pieceCount; ++i )
928            if( !tor->info.pieces[i].dnd && tr_bitfieldHasFast( peerPieces, i ) )
929                s->desiredAvailable += tr_cpMissingBlocksInPiece( &tor->completion, i );
930        s->desiredAvailable *= tor->blockSize;
931        tr_bitfieldFree( peerPieces );
932    }
933
934    downloadedForRatio = s->downloadedEver ? s->downloadedEver : s->haveValid;
935    s->ratio = tr_getRatio( s->uploadedEver, downloadedForRatio );
936
937    checkSeedRatio = tr_torrentGetSeedRatio( tor, &seedRatio );
938
939    switch( s->activity )
940    {
941        case TR_STATUS_DOWNLOAD:
942            if( s->leftUntilDone > s->desiredAvailable )
943                s->eta = TR_ETA_NOT_AVAIL;
944            else if( s->pieceDownloadSpeed < 0.1 )
945                s->eta = TR_ETA_UNKNOWN;
946            else
947                s->eta = s->leftUntilDone / s->pieceDownloadSpeed / 1024.0;
948            break;
949
950        case TR_STATUS_SEED:
951            if( checkSeedRatio )
952            {
953                if( s->pieceUploadSpeed < 0.1 )
954                    s->eta = TR_ETA_UNKNOWN;
955                else
956                    s->eta = (downloadedForRatio * (seedRatio - s->ratio)) / s->pieceUploadSpeed / 1024.0;
957            }
958            else
959                s->eta = TR_ETA_NOT_AVAIL;
960            break;
961
962        default:
963            s->eta = TR_ETA_NOT_AVAIL;
964            break;
965    }
966
967    if( !checkSeedRatio || s->ratio >= seedRatio || s->ratio == TR_RATIO_INF )
968        s->percentRatio = 1.0;
969    else if( s->ratio == TR_RATIO_NA )
970        s->percentRatio = 0.0;
971    else 
972        s->percentRatio = s->ratio / seedRatio;
973
974    tr_torrentUnlock( tor );
975
976    return s;
977}
978
979/***
980****
981***/
982
983static uint64_t
984fileBytesCompleted( const tr_torrent * tor,
985                    tr_file_index_t    fileIndex )
986{
987    const tr_file *        file     =  &tor->info.files[fileIndex];
988    const tr_block_index_t firstBlock       =  file->offset /
989                                              tor->blockSize;
990    const uint64_t         firstBlockOffset =  file->offset %
991                                              tor->blockSize;
992    const uint64_t         lastOffset       =
993        file->length ? ( file->length - 1 ) : 0;
994    const tr_block_index_t lastBlock        =
995        ( file->offset + lastOffset ) / tor->blockSize;
996    const uint64_t         lastBlockOffset  =
997        ( file->offset + lastOffset ) % tor->blockSize;
998    uint64_t               haveBytes = 0;
999
1000    assert( tr_isTorrent( tor ) );
1001    assert( fileIndex < tor->info.fileCount );
1002    assert( file->offset + file->length <= tor->info.totalSize );
1003    assert( ( firstBlock < tor->blockCount )
1004          || ( !file->length && file->offset == tor->info.totalSize ) );
1005    assert( ( lastBlock < tor->blockCount )
1006          || ( !file->length && file->offset == tor->info.totalSize ) );
1007    assert( firstBlock <= lastBlock );
1008    assert( tr_torBlockPiece( tor, firstBlock ) == file->firstPiece );
1009    assert( tr_torBlockPiece( tor, lastBlock ) == file->lastPiece );
1010
1011    if( firstBlock == lastBlock )
1012    {
1013        if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1014            haveBytes += lastBlockOffset + 1 - firstBlockOffset;
1015    }
1016    else
1017    {
1018        tr_block_index_t i;
1019
1020        if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1021            haveBytes += tor->blockSize - firstBlockOffset;
1022
1023        for( i = firstBlock + 1; i < lastBlock; ++i )
1024            if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1025                haveBytes += tor->blockSize;
1026
1027        if( tr_cpBlockIsCompleteFast( &tor->completion, lastBlock ) )
1028            haveBytes += lastBlockOffset + 1;
1029    }
1030
1031    return haveBytes;
1032}
1033
1034tr_file_stat *
1035tr_torrentFiles( const tr_torrent * tor,
1036                 tr_file_index_t *  fileCount )
1037{
1038    tr_file_index_t       i;
1039    const tr_file_index_t n = tor->info.fileCount;
1040    tr_file_stat *        files = tr_new0( tr_file_stat, n );
1041    tr_file_stat *        walk = files;
1042
1043    assert( tr_isTorrent( tor ) );
1044
1045    for( i = 0; i < n; ++i, ++walk )
1046    {
1047        const uint64_t b = fileBytesCompleted( tor, i );
1048        walk->bytesCompleted = b;
1049        walk->progress = tr_getRatio( b, tor->info.files[i].length );
1050    }
1051
1052    if( fileCount )
1053        *fileCount = n;
1054
1055    return files;
1056}
1057
1058void
1059tr_torrentFilesFree( tr_file_stat *            files,
1060                     tr_file_index_t fileCount UNUSED )
1061{
1062    tr_free( files );
1063}
1064
1065/***
1066****
1067***/
1068
1069float*
1070tr_torrentWebSpeeds( const tr_torrent * tor )
1071{
1072    return tr_isTorrent( tor )
1073         ? tr_peerMgrWebSpeeds( tor )
1074         : NULL;
1075}
1076
1077tr_peer_stat *
1078tr_torrentPeers( const tr_torrent * tor,
1079                 int *              peerCount )
1080{
1081    tr_peer_stat * ret = NULL;
1082
1083    if( tr_isTorrent( tor ) )
1084        ret = tr_peerMgrPeerStats( tor, peerCount );
1085
1086    return ret;
1087}
1088
1089void
1090tr_torrentPeersFree( tr_peer_stat * peers,
1091                     int peerCount  UNUSED )
1092{
1093    tr_free( peers );
1094}
1095
1096void
1097tr_torrentAvailability( const tr_torrent * tor,
1098                        int8_t *           tab,
1099                        int                size )
1100{
1101    tr_peerMgrTorrentAvailability( tor, tab, size );
1102}
1103
1104void
1105tr_torrentAmountFinished( const tr_torrent * tor,
1106                          float *            tab,
1107                          int                size )
1108{
1109    assert( tr_isTorrent( tor ) );
1110
1111    tr_torrentLock( tor );
1112    tr_cpGetAmountDone( &tor->completion, tab, size );
1113    tr_torrentUnlock( tor );
1114}
1115
1116void
1117tr_torrentResetTransferStats( tr_torrent * tor )
1118{
1119    assert( tr_isTorrent( tor ) );
1120
1121    tr_torrentLock( tor );
1122
1123    tor->downloadedPrev += tor->downloadedCur;
1124    tor->downloadedCur   = 0;
1125    tor->uploadedPrev   += tor->uploadedCur;
1126    tor->uploadedCur     = 0;
1127    tor->corruptPrev    += tor->corruptCur;
1128    tor->corruptCur      = 0;
1129
1130    tr_torrentUnlock( tor );
1131}
1132
1133void
1134tr_torrentSetHasPiece( tr_torrent *     tor,
1135                       tr_piece_index_t pieceIndex,
1136                       tr_bool          has )
1137{
1138    assert( tr_isTorrent( tor ) );
1139    assert( pieceIndex < tor->info.pieceCount );
1140
1141    if( has )
1142        tr_cpPieceAdd( &tor->completion, pieceIndex );
1143    else
1144        tr_cpPieceRem( &tor->completion, pieceIndex );
1145}
1146
1147/***
1148****
1149***/
1150
1151static void
1152freeTorrent( tr_torrent * tor )
1153{
1154    tr_torrent * t;
1155    tr_session *  session = tor->session;
1156    tr_info *    inf = &tor->info;
1157
1158    assert( tr_isTorrent( tor ) );
1159    assert( !tor->isRunning );
1160
1161    tr_globalLock( session );
1162
1163    tr_peerMgrRemoveTorrent( tor );
1164
1165    tr_cpDestruct( &tor->completion );
1166
1167    tr_rcDestruct( &tor->swarmSpeed );
1168
1169    tr_trackerUnsubscribe( tor->tracker, tor->trackerSubscription );
1170    tr_trackerFree( tor->tracker );
1171    tor->tracker = NULL;
1172
1173    tr_bitfieldDestruct( &tor->checkedPieces );
1174
1175    tr_free( tor->downloadDir );
1176    tr_free( tor->peer_id );
1177
1178    if( tor == session->torrentList )
1179        session->torrentList = tor->next;
1180    else for( t = session->torrentList; t != NULL; t = t->next ) {
1181        if( t->next == tor ) {
1182            t->next = tor->next;
1183            break;
1184        }
1185    }
1186
1187    assert( session->torrentCount >= 1 );
1188    session->torrentCount--;
1189
1190    tr_bandwidthFree( tor->bandwidth );
1191
1192    tr_metainfoFree( inf );
1193    tr_free( tor );
1194
1195    tr_globalUnlock( session );
1196}
1197
1198/**
1199***  Start/Stop Callback
1200**/
1201
1202static void
1203checkAndStartImpl( void * vtor )
1204{
1205    tr_torrent * tor = vtor;
1206
1207    assert( tr_isTorrent( tor ) );
1208
1209    tr_globalLock( tor->session );
1210
1211    tor->isRunning = TRUE;
1212    tor->needsSeedRatioCheck = TRUE;
1213    *tor->errorString = '\0';
1214    tr_torrentResetTransferStats( tor );
1215    tor->completeness = tr_cpGetStatus( &tor->completion );
1216    tr_torrentSaveResume( tor );
1217    tor->startDate = tor->anyDate = time( NULL );
1218    tr_trackerStart( tor->tracker );
1219    tr_peerMgrStartTorrent( tor );
1220
1221    tr_globalUnlock( tor->session );
1222}
1223
1224static void
1225checkAndStartCB( tr_torrent * tor )
1226{
1227    assert( tr_isTorrent( tor ) );
1228    assert( tr_isSession( tor->session ) );
1229
1230    tr_runInEventThread( tor->session, checkAndStartImpl, tor );
1231}
1232
1233static void
1234torrentStart( tr_torrent * tor,
1235              int          reloadProgress )
1236{
1237    assert( tr_isTorrent( tor ) );
1238
1239    tr_globalLock( tor->session );
1240
1241    if( !tor->isRunning )
1242    {
1243        const int isVerifying = tr_verifyInProgress( tor );
1244
1245        if( !isVerifying && reloadProgress )
1246            tr_torrentLoadResume( tor, TR_FR_PROGRESS, NULL );
1247
1248        tor->isRunning = 1;
1249
1250        if( !isVerifying )
1251            tr_verifyAdd( tor, checkAndStartCB );
1252    }
1253
1254    tr_globalUnlock( tor->session );
1255}
1256
1257void
1258tr_torrentStart( tr_torrent * tor )
1259{
1260    if( tr_isTorrent( tor ) )
1261        torrentStart( tor, TRUE );
1262}
1263
1264static void
1265torrentRecheckDoneImpl( void * vtor )
1266{
1267    tr_torrent * tor = vtor;
1268
1269    assert( tr_isTorrent( tor ) );
1270    tr_torrentRecheckCompleteness( tor );
1271}
1272
1273static void
1274torrentRecheckDoneCB( tr_torrent * tor )
1275{
1276    assert( tr_isTorrent( tor ) );
1277
1278    tr_runInEventThread( tor->session, torrentRecheckDoneImpl, tor );
1279}
1280
1281void
1282tr_torrentVerify( tr_torrent * tor )
1283{
1284    assert( tr_isTorrent( tor ) );
1285
1286    tr_verifyRemove( tor );
1287
1288    tr_globalLock( tor->session );
1289
1290    tr_torrentUncheck( tor );
1291    tr_verifyAdd( tor, torrentRecheckDoneCB );
1292
1293    tr_globalUnlock( tor->session );
1294}
1295
1296static void
1297tr_torrentCloseLocalFiles( const tr_torrent * tor )
1298{
1299    tr_file_index_t i;
1300    struct evbuffer * buf = evbuffer_new( );
1301
1302    assert( tr_isTorrent( tor ) );
1303
1304    for( i=0; i<tor->info.fileCount; ++i )
1305    {
1306        const tr_file * file = &tor->info.files[i];
1307        evbuffer_drain( buf, EVBUFFER_LENGTH( buf ) );
1308        evbuffer_add_printf( buf, "%s%s%s", tor->downloadDir, TR_PATH_DELIMITER_STR, file->name );
1309        tr_fdFileClose( (const char*) EVBUFFER_DATA( buf ) );
1310    }
1311
1312    evbuffer_free( buf );
1313}
1314
1315
1316static void
1317stopTorrent( void * vtor )
1318{
1319    tr_torrent * tor = vtor;
1320
1321    assert( tr_isTorrent( tor ) );
1322
1323    tr_verifyRemove( tor );
1324    tr_peerMgrStopTorrent( tor );
1325    tr_trackerStop( tor->tracker );
1326
1327    tr_torrentCloseLocalFiles( tor );
1328}
1329
1330void
1331tr_torrentStop( tr_torrent * tor )
1332{
1333    if( tr_isTorrent( tor ) )
1334    {
1335        tr_globalLock( tor->session );
1336
1337        tor->isRunning = 0;
1338        if( !tor->isDeleting )
1339            tr_torrentSaveResume( tor );
1340        tr_runInEventThread( tor->session, stopTorrent, tor );
1341
1342        tr_globalUnlock( tor->session );
1343    }
1344}
1345
1346static void
1347closeTorrent( void * vtor )
1348{
1349    tr_benc * d;
1350    tr_torrent * tor = vtor;
1351
1352    assert( tr_isTorrent( tor ) );
1353
1354    d = tr_bencListAddDict( &tor->session->removedTorrents, 2 );
1355    tr_bencDictAddInt( d, "id", tor->uniqueId );
1356    tr_bencDictAddInt( d, "date", time( NULL ) );
1357
1358    tr_torrentSaveResume( tor );
1359    tor->isRunning = 0;
1360    stopTorrent( tor );
1361    if( tor->isDeleting )
1362    {
1363        tr_metainfoRemoveSaved( tor->session, &tor->info );
1364        tr_torrentRemoveResume( tor );
1365    }
1366    freeTorrent( tor );
1367}
1368
1369void
1370tr_torrentFree( tr_torrent * tor )
1371{
1372    if( tr_isTorrent( tor ) )
1373    {
1374        tr_session * session = tor->session;
1375        assert( tr_isSession( session ) );
1376        tr_globalLock( session );
1377
1378        tr_torrentClearCompletenessCallback( tor );
1379        tr_runInEventThread( session, closeTorrent, tor );
1380
1381        tr_globalUnlock( session );
1382    }
1383}
1384
1385void
1386tr_torrentRemove( tr_torrent * tor )
1387{
1388    assert( tr_isTorrent( tor ) );
1389
1390    tor->isDeleting = 1;
1391    tr_torrentFree( tor );
1392}
1393
1394/**
1395***  Completeness
1396**/
1397
1398static const char *
1399getCompletionString( int type )
1400{
1401    switch( type )
1402    {
1403        /* Translators: this is a minor point that's safe to skip over, but FYI:
1404           "Complete" and "Done" are specific, different terms in Transmission:
1405           "Complete" means we've downloaded every file in the torrent.
1406           "Done" means we're done downloading the files we wanted, but NOT all
1407           that exist */
1408        case TR_PARTIAL_SEED:
1409            return _( "Done" );
1410
1411        case TR_SEED:
1412            return _( "Complete" );
1413
1414        default:
1415            return _( "Incomplete" );
1416    }
1417}
1418
1419static void
1420fireCompletenessChange( tr_torrent       * tor,
1421                        tr_completeness    status )
1422{
1423    assert( tr_isTorrent( tor ) );
1424    assert( ( status == TR_LEECH )
1425         || ( status == TR_SEED )
1426         || ( status == TR_PARTIAL_SEED ) );
1427
1428    if( tor->completeness_func )
1429        tor->completeness_func( tor, status, tor->completeness_func_user_data );
1430}
1431
1432void
1433tr_torrentSetCompletenessCallback( tr_torrent                    * tor,
1434                                   tr_torrent_completeness_func    func,
1435                                   void                          * user_data )
1436{
1437    assert( tr_isTorrent( tor ) );
1438
1439    tor->completeness_func = func;
1440    tor->completeness_func_user_data = user_data;
1441}
1442
1443void
1444tr_torrentSetRatioLimitHitCallback( tr_torrent                     * tor,
1445                                    tr_torrent_ratio_limit_hit_func  func,
1446                                    void                           * user_data )
1447{
1448    assert( tr_isTorrent( tor ) );
1449
1450    tor->ratio_limit_hit_func = func;
1451    tor->ratio_limit_hit_func_user_data = user_data;
1452}
1453
1454void
1455tr_torrentClearCompletenessCallback( tr_torrent * torrent )
1456{
1457    tr_torrentSetCompletenessCallback( torrent, NULL, NULL );
1458}
1459
1460void
1461tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent )
1462{
1463    tr_torrentSetRatioLimitHitCallback( torrent, NULL, NULL );
1464}
1465
1466void
1467tr_torrentRecheckCompleteness( tr_torrent * tor )
1468{
1469    tr_completeness completeness;
1470
1471    assert( tr_isTorrent( tor ) );
1472
1473    tr_torrentLock( tor );
1474
1475    completeness = tr_cpGetStatus( &tor->completion );
1476
1477    if( completeness != tor->completeness )
1478    {
1479        const int recentChange = tor->downloadedCur != 0;
1480
1481        if( recentChange )
1482        {
1483            tr_torinf( tor, _( "State changed from \"%1$s\" to \"%2$s\"" ),
1484                      getCompletionString( tor->completeness ),
1485                      getCompletionString( completeness ) );
1486        }
1487
1488        tor->completeness = completeness;
1489        tor->needsSeedRatioCheck = TRUE;
1490        tr_torrentCloseLocalFiles( tor );
1491        fireCompletenessChange( tor, completeness );
1492
1493        if( recentChange && ( completeness == TR_SEED ) )
1494        {
1495            tr_trackerCompleted( tor->tracker );
1496
1497            tor->doneDate = tor->anyDate = time( NULL );
1498        }
1499
1500        tr_torrentSaveResume( tor );
1501    }
1502
1503    tr_torrentUnlock( tor );
1504}
1505
1506/**
1507***  File priorities
1508**/
1509
1510void
1511tr_torrentInitFilePriority( tr_torrent *    tor,
1512                            tr_file_index_t fileIndex,
1513                            tr_priority_t   priority )
1514{
1515    tr_piece_index_t i;
1516    tr_file *        file;
1517
1518    assert( tr_isTorrent( tor ) );
1519    assert( fileIndex < tor->info.fileCount );
1520    assert( priority == TR_PRI_LOW || priority == TR_PRI_NORMAL || priority == TR_PRI_HIGH );
1521
1522    file = &tor->info.files[fileIndex];
1523    file->priority = priority;
1524    for( i = file->firstPiece; i <= file->lastPiece; ++i )
1525        tor->info.pieces[i].priority = calculatePiecePriority( tor, i, fileIndex );
1526}
1527
1528void
1529tr_torrentSetFilePriorities( tr_torrent *      tor,
1530                             tr_file_index_t * files,
1531                             tr_file_index_t   fileCount,
1532                             tr_priority_t     priority )
1533{
1534    tr_file_index_t i;
1535
1536    assert( tr_isTorrent( tor ) );
1537
1538    tr_torrentLock( tor );
1539
1540    for( i = 0; i < fileCount; ++i )
1541        tr_torrentInitFilePriority( tor, files[i], priority );
1542
1543    tr_torrentSaveResume( tor );
1544    tr_torrentUnlock( tor );
1545}
1546
1547tr_priority_t
1548tr_torrentGetFilePriority( const tr_torrent * tor,
1549                           tr_file_index_t    file )
1550{
1551    tr_priority_t ret;
1552
1553    assert( tr_isTorrent( tor ) );
1554
1555    tr_torrentLock( tor );
1556    assert( tor );
1557    assert( file < tor->info.fileCount );
1558    ret = tor->info.files[file].priority;
1559    tr_torrentUnlock( tor );
1560
1561    return ret;
1562}
1563
1564tr_priority_t*
1565tr_torrentGetFilePriorities( const tr_torrent * tor )
1566{
1567    tr_file_index_t i;
1568    tr_priority_t * p;
1569
1570    assert( tr_isTorrent( tor ) );
1571
1572    tr_torrentLock( tor );
1573    p = tr_new0( tr_priority_t, tor->info.fileCount );
1574    for( i = 0; i < tor->info.fileCount; ++i )
1575        p[i] = tor->info.files[i].priority;
1576    tr_torrentUnlock( tor );
1577
1578    return p;
1579}
1580
1581/**
1582***  File DND
1583**/
1584
1585int
1586tr_torrentGetFileDL( const tr_torrent * tor,
1587                     tr_file_index_t    file )
1588{
1589    int doDownload;
1590
1591    assert( tr_isTorrent( tor ) );
1592
1593    tr_torrentLock( tor );
1594
1595    assert( file < tor->info.fileCount );
1596    doDownload = !tor->info.files[file].dnd;
1597
1598    tr_torrentUnlock( tor );
1599    return doDownload != 0;
1600}
1601
1602static void
1603setFileDND( tr_torrent * tor, tr_file_index_t fileIndex, int doDownload )
1604{
1605    tr_file *        file;
1606    const int        dnd = !doDownload;
1607    tr_piece_index_t firstPiece, firstPieceDND;
1608    tr_piece_index_t lastPiece, lastPieceDND;
1609    tr_file_index_t  i;
1610
1611    assert( tr_isTorrent( tor ) );
1612
1613    file = &tor->info.files[fileIndex];
1614    file->dnd = dnd;
1615    firstPiece = file->firstPiece;
1616    lastPiece = file->lastPiece;
1617
1618    /* can't set the first piece to DND unless
1619       every file using that piece is DND */
1620    firstPieceDND = dnd;
1621    if( fileIndex > 0 )
1622    {
1623        for( i = fileIndex - 1; firstPieceDND; --i )
1624        {
1625            if( tor->info.files[i].lastPiece != firstPiece )
1626                break;
1627            firstPieceDND = tor->info.files[i].dnd;
1628            if( !i )
1629                break;
1630        }
1631    }
1632
1633    /* can't set the last piece to DND unless
1634       every file using that piece is DND */
1635    lastPieceDND = dnd;
1636    for( i = fileIndex + 1; lastPieceDND && i < tor->info.fileCount; ++i )
1637    {
1638        if( tor->info.files[i].firstPiece != lastPiece )
1639            break;
1640        lastPieceDND = tor->info.files[i].dnd;
1641    }
1642
1643    if( firstPiece == lastPiece )
1644    {
1645        tor->info.pieces[firstPiece].dnd = firstPieceDND && lastPieceDND;
1646    }
1647    else
1648    {
1649        tr_piece_index_t pp;
1650        tor->info.pieces[firstPiece].dnd = firstPieceDND;
1651        tor->info.pieces[lastPiece].dnd = lastPieceDND;
1652        for( pp = firstPiece + 1; pp < lastPiece; ++pp )
1653            tor->info.pieces[pp].dnd = dnd;
1654    }
1655}
1656
1657void
1658tr_torrentInitFileDLs( tr_torrent      * tor,
1659                       tr_file_index_t * files,
1660                       tr_file_index_t   fileCount,
1661                       tr_bool           doDownload )
1662{
1663    tr_file_index_t i;
1664
1665    assert( tr_isTorrent( tor ) );
1666
1667    tr_torrentLock( tor );
1668
1669    for( i=0; i<fileCount; ++i )
1670        setFileDND( tor, files[i], doDownload );
1671    tr_cpInvalidateDND( &tor->completion );
1672    tor->needsSeedRatioCheck = TRUE;
1673
1674    tr_torrentUnlock( tor );
1675}
1676
1677void
1678tr_torrentSetFileDLs( tr_torrent *      tor,
1679                      tr_file_index_t * files,
1680                      tr_file_index_t   fileCount,
1681                      tr_bool           doDownload )
1682{
1683    assert( tr_isTorrent( tor ) );
1684
1685    tr_torrentLock( tor );
1686    tr_torrentInitFileDLs( tor, files, fileCount, doDownload );
1687    tr_torrentSaveResume( tor );
1688    tr_torrentUnlock( tor );
1689}
1690
1691/***
1692****
1693***/
1694
1695void
1696tr_torrentSetPeerLimit( tr_torrent * tor,
1697                        uint16_t     maxConnectedPeers )
1698{
1699    assert( tr_isTorrent( tor ) );
1700
1701    tor->maxConnectedPeers = maxConnectedPeers;
1702}
1703
1704uint16_t
1705tr_torrentGetPeerLimit( const tr_torrent * tor )
1706{
1707    assert( tr_isTorrent( tor ) );
1708
1709    return tor->maxConnectedPeers;
1710}
1711
1712/***
1713****
1714***/
1715
1716tr_block_index_t
1717_tr_block( const tr_torrent * tor,
1718           tr_piece_index_t   index,
1719           uint32_t           offset )
1720{
1721    tr_block_index_t ret;
1722
1723    assert( tr_isTorrent( tor ) );
1724
1725    ret = index;
1726    ret *= ( tor->info.pieceSize / tor->blockSize );
1727    ret += offset / tor->blockSize;
1728    return ret;
1729}
1730
1731tr_bool
1732tr_torrentReqIsValid( const tr_torrent * tor,
1733                      tr_piece_index_t   index,
1734                      uint32_t           offset,
1735                      uint32_t           length )
1736{
1737    int err = 0;
1738
1739    assert( tr_isTorrent( tor ) );
1740
1741    if( index >= tor->info.pieceCount )
1742        err = 1;
1743    else if( length < 1 )
1744        err = 2;
1745    else if( ( offset + length ) > tr_torPieceCountBytes( tor, index ) )
1746        err = 3;
1747    else if( length > MAX_BLOCK_SIZE )
1748        err = 4;
1749    else if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
1750        err = 5;
1751
1752    if( err ) fprintf( stderr, "index %lu offset %lu length %lu err %d\n",
1753                       (unsigned long)index, (unsigned long)offset,
1754                       (unsigned long)length,
1755                       err );
1756
1757    return !err;
1758}
1759
1760uint64_t
1761tr_pieceOffset( const tr_torrent * tor,
1762                tr_piece_index_t   index,
1763                uint32_t           offset,
1764                uint32_t           length )
1765{
1766    uint64_t ret;
1767
1768    assert( tr_isTorrent( tor ) );
1769
1770    ret = tor->info.pieceSize;
1771    ret *= index;
1772    ret += offset;
1773    ret += length;
1774    return ret;
1775}
1776
1777/***
1778****
1779***/
1780
1781void
1782tr_torrentSetPieceChecked( tr_torrent        * tor,
1783                           tr_piece_index_t    piece,
1784                           tr_bool             isChecked )
1785{
1786    assert( tr_isTorrent( tor ) );
1787
1788    if( isChecked )
1789        tr_bitfieldAdd( &tor->checkedPieces, piece );
1790    else
1791        tr_bitfieldRem( &tor->checkedPieces, piece );
1792}
1793
1794void
1795tr_torrentSetFileChecked( tr_torrent *    tor,
1796                          tr_file_index_t fileIndex,
1797                          tr_bool         isChecked )
1798{
1799    const tr_file *        file = &tor->info.files[fileIndex];
1800    const tr_piece_index_t begin = file->firstPiece;
1801    const tr_piece_index_t end = file->lastPiece + 1;
1802
1803    assert( tr_isTorrent( tor ) );
1804
1805    if( isChecked )
1806        tr_bitfieldAddRange( &tor->checkedPieces, begin, end );
1807    else
1808        tr_bitfieldRemRange( &tor->checkedPieces, begin, end );
1809}
1810
1811tr_bool
1812tr_torrentIsFileChecked( const tr_torrent * tor,
1813                         tr_file_index_t    fileIndex )
1814{
1815    const tr_file *        file = &tor->info.files[fileIndex];
1816    const tr_piece_index_t begin = file->firstPiece;
1817    const tr_piece_index_t end = file->lastPiece + 1;
1818    tr_piece_index_t       i;
1819    tr_bool                isChecked = TRUE;
1820
1821    assert( tr_isTorrent( tor ) );
1822
1823    for( i = begin; isChecked && i < end; ++i )
1824        if( !tr_torrentIsPieceChecked( tor, i ) )
1825            isChecked = FALSE;
1826
1827    return isChecked;
1828}
1829
1830void
1831tr_torrentUncheck( tr_torrent * tor )
1832{
1833    assert( tr_isTorrent( tor ) );
1834
1835    tr_bitfieldRemRange( &tor->checkedPieces, 0, tor->info.pieceCount );
1836}
1837
1838int
1839tr_torrentCountUncheckedPieces( const tr_torrent * tor )
1840{
1841    assert( tr_isTorrent( tor ) );
1842
1843    return tor->info.pieceCount - tr_bitfieldCountTrueBits( &tor->checkedPieces );
1844}
1845
1846time_t*
1847tr_torrentGetMTimes( const tr_torrent * tor,
1848                     size_t *           setme_n )
1849{
1850    size_t       i;
1851    const size_t n = tor->info.fileCount;
1852    time_t *     m = tr_new0( time_t, n );
1853
1854    assert( tr_isTorrent( tor ) );
1855
1856    for( i = 0; i < n; ++i )
1857    {
1858        struct stat sb;
1859        char * path = tr_buildPath( tor->downloadDir, tor->info.files[i].name, NULL );
1860        if( !stat( path, &sb ) )
1861        {
1862#ifdef SYS_DARWIN
1863            m[i] = sb.st_mtimespec.tv_sec;
1864#else
1865            m[i] = sb.st_mtime;
1866#endif
1867        }
1868        tr_free( path );
1869    }
1870
1871    *setme_n = n;
1872    return m;
1873}
1874
1875/***
1876****
1877***/
1878
1879void
1880tr_torrentSetAnnounceList( tr_torrent *            tor,
1881                           const tr_tracker_info * trackers,
1882                           int                     trackerCount )
1883{
1884    tr_benc metainfo;
1885
1886    assert( tr_isTorrent( tor ) );
1887
1888    /* save to the .torrent file */
1889    if( !tr_bencLoadFile( tor->info.torrent, &metainfo ) )
1890    {
1891        int       i;
1892        int       prevTier = -1;
1893        tr_benc * tier = NULL;
1894        tr_benc * announceList;
1895        tr_info   tmpInfo;
1896
1897        /* remove the old fields */
1898        tr_bencDictRemove( &metainfo, "announce" );
1899        tr_bencDictRemove( &metainfo, "announce-list" );
1900
1901        /* add the new fields */
1902        tr_bencDictAddStr( &metainfo, "announce", trackers[0].announce );
1903        announceList = tr_bencDictAddList( &metainfo, "announce-list", 0 );
1904        for( i = 0; i < trackerCount; ++i ) {
1905            if( prevTier != trackers[i].tier ) {
1906                prevTier = trackers[i].tier;
1907                tier = tr_bencListAddList( announceList, 0 );
1908            }
1909            tr_bencListAddStr( tier, trackers[i].announce );
1910        }
1911
1912        /* try to parse it back again, to make sure it's good */
1913        memset( &tmpInfo, 0, sizeof( tr_info ) );
1914        if( !tr_metainfoParse( tor->session, &tmpInfo, &metainfo ) )
1915        {
1916            /* it's good, so keep these new trackers and free the old ones */
1917
1918            tr_info swap;
1919            swap.trackers = tor->info.trackers;
1920            swap.trackerCount = tor->info.trackerCount;
1921            tor->info.trackers = tmpInfo.trackers;
1922            tor->info.trackerCount = tmpInfo.trackerCount;
1923            tmpInfo.trackers = swap.trackers;
1924            tmpInfo.trackerCount = swap.trackerCount;
1925
1926            tr_metainfoFree( &tmpInfo );
1927            tr_bencSaveFile( tor->info.torrent, &metainfo );
1928        }
1929
1930        /* cleanup */
1931        tr_bencFree( &metainfo );
1932    }
1933}
1934
1935/**
1936***
1937**/
1938
1939void
1940tr_torrentSetAddedDate( tr_torrent * tor,
1941                        time_t       t )
1942{
1943    assert( tr_isTorrent( tor ) );
1944
1945    tor->addedDate = t;
1946    tor->anyDate = MAX( tor->anyDate, tor->addedDate );
1947}
1948
1949void
1950tr_torrentSetActivityDate( tr_torrent * tor,
1951                           time_t       t )
1952{
1953    assert( tr_isTorrent( tor ) );
1954
1955    tor->activityDate = t;
1956    tor->anyDate = MAX( tor->anyDate, tor->activityDate );
1957}
1958
1959void
1960tr_torrentSetDoneDate( tr_torrent * tor,
1961                       time_t       t )
1962{
1963    assert( tr_isTorrent( tor ) );
1964
1965    tor->doneDate = t;
1966    tor->anyDate = MAX( tor->anyDate, tor->doneDate );
1967}
1968
1969/**
1970***
1971**/
1972
1973uint64_t
1974tr_torrentGetBytesLeftToAllocate( const tr_torrent * tor )
1975{
1976    const tr_file * it;
1977    const tr_file * end;
1978    struct stat sb;
1979    uint64_t bytesLeft = 0;
1980
1981    assert( tr_isTorrent( tor ) );
1982
1983    for( it=tor->info.files, end=it+tor->info.fileCount; it!=end; ++it )
1984    {
1985        if( !it->dnd )
1986        {
1987            char * path = tr_buildPath( tor->downloadDir, it->name, NULL );
1988
1989            bytesLeft += it->length;
1990
1991            if( !stat( path, &sb )
1992                    && S_ISREG( sb.st_mode )
1993                    && ( (uint64_t)sb.st_size <= it->length ) )
1994                bytesLeft -= sb.st_size;
1995
1996            tr_free( path );
1997        }
1998    }
1999
2000    return bytesLeft;
2001}
2002
2003/****
2004*****  Removing the torrent's local data
2005****/
2006
2007static int
2008vstrcmp( const void * a, const void * b )
2009{
2010    return strcmp( a, b );
2011}
2012
2013static int
2014compareLongestFirst( const void * a, const void * b )
2015{
2016    const size_t alen = strlen( a );
2017    const size_t blen = strlen( b );
2018
2019    if( alen != blen )
2020        return alen > blen ? -1 : 1;
2021
2022    return vstrcmp( a, b );
2023}
2024
2025static void
2026addDirtyFile( const char  * root,
2027              const char  * filename,
2028              tr_ptrArray * dirtyFolders )
2029{
2030    char * dir = tr_dirname( filename );
2031
2032    /* add the parent folders to dirtyFolders until we reach the root or a known-dirty */
2033    while (     ( dir != NULL )
2034             && ( strlen( root ) <= strlen( dir ) )
2035             && ( tr_ptrArrayFindSorted( dirtyFolders, dir, vstrcmp ) == NULL ) )
2036    {
2037        char * tmp;
2038        tr_ptrArrayInsertSorted( dirtyFolders, tr_strdup( dir ), vstrcmp );
2039
2040        tmp = tr_dirname( dir );
2041        tr_free( dir );
2042        dir = tmp;
2043    }
2044
2045    tr_free( dir );
2046}
2047
2048static void
2049walkLocalData( const tr_torrent * tor,
2050               const char       * root,
2051               const char       * dir,
2052               const char       * base,
2053               tr_ptrArray      * torrentFiles,
2054               tr_ptrArray      * folders,
2055               tr_ptrArray      * dirtyFolders )
2056{
2057    int i;
2058    struct stat sb;
2059    char * buf;
2060
2061    assert( tr_isTorrent( tor ) );
2062
2063    buf = tr_buildPath( dir, base, NULL );
2064    i = stat( buf, &sb );
2065    if( !i )
2066    {
2067        DIR * odir = NULL;
2068
2069        if( S_ISDIR( sb.st_mode ) && ( ( odir = opendir ( buf ) ) ) )
2070        {
2071            struct dirent *d;
2072            tr_ptrArrayInsertSorted( folders, tr_strdup( buf ), vstrcmp );
2073            for( d = readdir( odir ); d != NULL; d = readdir( odir ) )
2074                if( d->d_name && d->d_name[0] != '.' ) /* skip dotfiles */
2075                    walkLocalData( tor, root, buf, d->d_name, torrentFiles, folders, dirtyFolders );
2076            closedir( odir );
2077        }
2078        else if( S_ISREG( sb.st_mode ) && ( sb.st_size > 0 ) )
2079        {
2080            const char * sub = buf + strlen( tor->downloadDir ) + strlen( TR_PATH_DELIMITER_STR );
2081            const tr_bool isTorrentFile = tr_ptrArrayFindSorted( torrentFiles, sub, vstrcmp ) != NULL;
2082            if( !isTorrentFile )
2083                addDirtyFile( root, buf, dirtyFolders );
2084        }
2085    }
2086
2087    tr_free( buf );
2088}
2089
2090static void
2091deleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2092{
2093    int i, n;
2094    char ** s;
2095    tr_file_index_t f;
2096    tr_ptrArray torrentFiles = TR_PTR_ARRAY_INIT;
2097    tr_ptrArray folders      = TR_PTR_ARRAY_INIT;
2098    tr_ptrArray dirtyFolders = TR_PTR_ARRAY_INIT; /* dirty == contains non-torrent files */
2099
2100    const char * firstFile = tor->info.files[0].name;
2101    const char * cpch = strchr( firstFile, TR_PATH_DELIMITER );
2102    char * tmp = cpch ? tr_strndup( firstFile, cpch - firstFile ) : NULL;
2103    char * root = tr_buildPath( tor->downloadDir, tmp, NULL );
2104
2105    assert( tr_isTorrent( tor ) );
2106
2107    for( f=0; f<tor->info.fileCount; ++f )
2108        tr_ptrArrayInsertSorted( &torrentFiles, tor->info.files[f].name, vstrcmp );
2109
2110    /* build the set of folders and dirtyFolders */
2111    walkLocalData( tor, root, root, NULL, &torrentFiles, &folders, &dirtyFolders );
2112
2113    /* try to remove entire folders first, so that the recycle bin will be tidy */
2114    s = (char**) tr_ptrArrayPeek( &folders, &n );
2115    for( i=0; i<n; ++i )
2116        if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2117            fileFunc( s[i] );
2118
2119    /* now blow away any remaining torrent files, such as torrent files in dirty folders */
2120    for( f=0; f<tor->info.fileCount; ++f ) {
2121        char * path = tr_buildPath( tor->downloadDir, tor->info.files[f].name, NULL );
2122        fileFunc( path );
2123        tr_free( path );
2124    }
2125
2126    /* Now clean out the directories left empty from the previous step.
2127     * Work from deepest to shallowest s.t. lower folders
2128     * won't prevent the upper folders from being deleted */
2129    {
2130        tr_ptrArray cleanFolders = TR_PTR_ARRAY_INIT;
2131        s = (char**) tr_ptrArrayPeek( &folders, &n );
2132        for( i=0; i<n; ++i )
2133            if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2134                tr_ptrArrayInsertSorted( &cleanFolders, s[i], compareLongestFirst );
2135        s = (char**) tr_ptrArrayPeek( &cleanFolders, &n );
2136        for( i=0; i<n; ++i )
2137            fileFunc( s[i] );
2138        tr_ptrArrayDestruct( &cleanFolders, NULL );
2139    }
2140
2141    /* cleanup */
2142    tr_ptrArrayDestruct( &dirtyFolders, tr_free );
2143    tr_ptrArrayDestruct( &folders, tr_free );
2144    tr_ptrArrayDestruct( &torrentFiles, NULL );
2145    tr_free( root );
2146    tr_free( tmp );
2147}
2148
2149void
2150tr_torrentDeleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2151{
2152    assert( tr_isTorrent( tor ) );
2153
2154    if( fileFunc == NULL )
2155        fileFunc = remove;
2156
2157    /* close all the files because we're about to delete them */
2158    tr_torrentCloseLocalFiles( tor );
2159
2160    if( tor->info.fileCount > 1 )
2161        deleteLocalData( tor, fileFunc );
2162    else {
2163        /* torrent only has one file */
2164        char * path = tr_buildPath( tor->downloadDir, tor->info.files[0].name, NULL );
2165        fileFunc( path );
2166        tr_free( path );
2167    }
2168}
2169
2170/***
2171****
2172***/
2173
2174void
2175tr_torrentCheckSeedRatio( tr_torrent * tor )
2176{
2177    double seedRatio;
2178
2179    assert( tr_isTorrent( tor ) );
2180
2181    /* if we're seeding and we've reached our seed ratio limit, stop the torrent */
2182    if( tor->isRunning && tr_torrentIsSeed( tor ) && tr_torrentGetSeedRatio( tor, &seedRatio ) )
2183    {
2184        const uint64_t up = tor->uploadedCur + tor->uploadedPrev;
2185        uint64_t down = tor->downloadedCur + tor->downloadedPrev;
2186        double ratio;
2187
2188        /* maybe we're the initial seeder and never downloaded anything... */
2189        if( down == 0 )
2190            down = tr_cpHaveValid( &tor->completion );
2191
2192        ratio = tr_getRatio( up, down );
2193
2194        if( ratio >= seedRatio || ratio == TR_RATIO_INF )
2195        {
2196            tr_torrentStop( tor );
2197
2198            /* set to no ratio limit to allow easy restarting */
2199            tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_UNLIMITED );
2200
2201            /* maybe notify the client */
2202            if( tor->ratio_limit_hit_func != NULL )
2203                tor->ratio_limit_hit_func( tor, tor->ratio_limit_hit_func_user_data );
2204        }
2205    }
2206}
Note: See TracBrowser for help on using the repository browser.