source: trunk/libtransmission/torrent.c @ 7892

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

have the mac ui use libT's ratio settings (attempt 1); when seed ratio is reached in libT, set the seed ratio setting to "seed forever"

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