source: trunk/libtransmission/torrent.c @ 8090

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

(trunk) rpc changes:

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