source: trunk/libtransmission/torrent.c @ 9866

Last change on this file since 9866 was 9866, checked in by charles, 12 years ago

(trunk libT) #2711 "no metadata exchange when using magnet links and trackerless torrents" -- fixed

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