source: trunk/libtransmission/torrent.c @ 9446

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

(trunk libT) Adding term debug messages to help track down #2533 w/m1b and *acrocivious

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