source: trunk/libtransmission/torrent.c @ 9842

Last change on this file since 9842 was 9842, checked in by livings124, 12 years ago

some more insignificant changes I have sitting around locally

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