source: trunk/libtransmission/torrent.c @ 9445

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

Adding term debug messages to help track down #2533 w/m1b

  • Property svn:keywords set to Date Rev Author Id
File size: 70.7 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 9445 2009-10-30 16:24:58Z 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
1066            /* the first block */
1067            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1068                total += tor->blockSize - ( f->offset % tor->blockSize );
1069
1070            /* the middle blocks */
1071            if( f->firstPiece == f->lastPiece )
1072            {
1073fprintf( stderr, "f->firstPiece == f->lastPiece\n" );
1074                for( i=firstBlock+1; i<lastBlock; ++i )
1075                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1076                        total += tor->blockSize;
1077            }
1078            else
1079            {
1080                int64_t b = 0;
1081                const tr_block_index_t firstBlockOfLastPiece
1082                           = tr_torPieceFirstBlock( tor, f->lastPiece );
1083                const tr_block_index_t lastBlockOfFirstPiece
1084                           = tr_torPieceFirstBlock( tor, f->firstPiece )
1085                             + tr_torPieceCountBlocks( tor, f->firstPiece ) - 1;
1086
1087                /* the rest of the first piece */
1088fprintf( stderr, "looping on the rest of the first piece\n" );
1089                for( i=firstBlock+1; i<lastBlock && i<=lastBlockOfFirstPiece; ++i )
1090                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1091                        ++b;
1092
1093                /* the middle pieces */
1094fprintf( stderr, "looking at the middle pieces\n" );
1095                if( f->firstPiece + 1 < f->lastPiece )
1096                    for( i=f->firstPiece+1; i<f->lastPiece; ++i )
1097                        b += tor->blockCountInPiece - tr_cpMissingBlocksInPiece( &tor->completion, i );
1098
1099                /* the rest of the last piece */
1100fprintf( stderr, "looping on the rest of the last piece\n" );
1101                for( i=firstBlockOfLastPiece; i<lastBlock; ++i )
1102                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1103                        ++b;
1104
1105                b *= tor->blockSize;
1106                total += b;
1107            }
1108
1109            /* the last block */
1110            if( tr_cpBlockIsCompleteFast( &tor->completion, lastBlock ) )
1111                total += ( f->offset + f->length ) - ( tor->blockSize * lastBlock );
1112        }
1113    }
1114fprintf( stderr, "finished fileBytesCompleted for file #%d\n", (int)index );
1115
1116    return total;
1117}
1118
1119tr_file_stat *
1120tr_torrentFiles( const tr_torrent * tor,
1121                 tr_file_index_t *  fileCount )
1122{
1123    tr_file_index_t       i;
1124    const tr_file_index_t n = tor->info.fileCount;
1125    tr_file_stat *        files = tr_new0( tr_file_stat, n );
1126    tr_file_stat *        walk = files;
1127    const tr_bool         isSeed = tor->completeness == TR_SEED;
1128static int numCalls = 0;
1129
1130fprintf( stderr, "entering tr_torrentFiles for the %d time\n", ++numCalls );
1131
1132    assert( tr_isTorrent( tor ) );
1133
1134    for( i=0; i<n; ++i, ++walk )
1135    {
1136fprintf( stderr, "looking at file #%d of %d\n", (int)i, (int)n );
1137        const uint64_t b = isSeed ? tor->info.files[i].length : fileBytesCompleted( tor, i );
1138fprintf( stderr, "file has %"PRIu64" out of %"PRIu64" bytes\n", b, tor->info.files[i].length );
1139        walk->bytesCompleted = b;
1140        walk->progress = tr_getRatio( b, tor->info.files[i].length );
1141fprintf( stderr, "walk->progress is %f\n", walk->progress );
1142    }
1143
1144    if( fileCount )
1145        *fileCount = n;
1146
1147fprintf( stderr, "tr_torrentFiles finished\n" );
1148
1149    return files;
1150}
1151
1152void
1153tr_torrentFilesFree( tr_file_stat *            files,
1154                     tr_file_index_t fileCount UNUSED )
1155{
1156    tr_free( files );
1157}
1158
1159/***
1160****
1161***/
1162
1163float*
1164tr_torrentWebSpeeds( const tr_torrent * tor )
1165{
1166    return tr_isTorrent( tor )
1167         ? tr_peerMgrWebSpeeds( tor )
1168         : NULL;
1169}
1170
1171tr_peer_stat *
1172tr_torrentPeers( const tr_torrent * tor,
1173                 int *              peerCount )
1174{
1175    tr_peer_stat * ret = NULL;
1176
1177    if( tr_isTorrent( tor ) )
1178        ret = tr_peerMgrPeerStats( tor, peerCount );
1179
1180    return ret;
1181}
1182
1183void
1184tr_torrentPeersFree( tr_peer_stat * peers,
1185                     int peerCount  UNUSED )
1186{
1187    tr_free( peers );
1188}
1189
1190tr_tracker_stat *
1191tr_torrentTrackers( const tr_torrent * torrent,
1192                    int              * setmeTrackerCount )
1193{
1194    assert( tr_isTorrent( torrent ) );
1195
1196    return tr_announcerStats( torrent, setmeTrackerCount );
1197}
1198
1199void
1200tr_torrentTrackersFree( tr_tracker_stat * trackers,
1201                        int trackerCount )
1202{
1203    tr_announcerStatsFree( trackers, trackerCount );
1204}
1205
1206void
1207tr_torrentAvailability( const tr_torrent * tor,
1208                        int8_t *           tab,
1209                        int                size )
1210{
1211    tr_peerMgrTorrentAvailability( tor, tab, size );
1212}
1213
1214void
1215tr_torrentAmountFinished( const tr_torrent * tor,
1216                          float *            tab,
1217                          int                size )
1218{
1219    assert( tr_isTorrent( tor ) );
1220
1221    tr_torrentLock( tor );
1222    tr_cpGetAmountDone( &tor->completion, tab, size );
1223    tr_torrentUnlock( tor );
1224}
1225
1226static void
1227tr_torrentResetTransferStats( tr_torrent * tor )
1228{
1229    assert( tr_isTorrent( tor ) );
1230
1231    tr_torrentLock( tor );
1232
1233    tor->downloadedPrev += tor->downloadedCur;
1234    tor->downloadedCur   = 0;
1235    tor->uploadedPrev   += tor->uploadedCur;
1236    tor->uploadedCur     = 0;
1237    tor->corruptPrev    += tor->corruptCur;
1238    tor->corruptCur      = 0;
1239
1240    tr_torrentSetDirty( tor );
1241
1242    tr_torrentUnlock( tor );
1243}
1244
1245void
1246tr_torrentSetHasPiece( tr_torrent *     tor,
1247                       tr_piece_index_t pieceIndex,
1248                       tr_bool          has )
1249{
1250    assert( tr_isTorrent( tor ) );
1251    assert( pieceIndex < tor->info.pieceCount );
1252
1253    if( has )
1254        tr_cpPieceAdd( &tor->completion, pieceIndex );
1255    else
1256        tr_cpPieceRem( &tor->completion, pieceIndex );
1257}
1258
1259/***
1260****
1261***/
1262
1263static void
1264freeTorrent( tr_torrent * tor )
1265{
1266    tr_torrent * t;
1267    tr_session *  session = tor->session;
1268    tr_info *    inf = &tor->info;
1269
1270    assert( tr_isTorrent( tor ) );
1271    assert( !tor->isRunning );
1272
1273    tr_globalLock( session );
1274
1275    tr_peerMgrRemoveTorrent( tor );
1276
1277    tr_cpDestruct( &tor->completion );
1278
1279    tr_rcDestruct( &tor->swarmSpeed );
1280
1281    tr_announcerUnsubscribe( tor->tiers, tor->tiersSubscription );
1282    tr_announcerRemoveTorrent( session->announcer, tor );
1283
1284    tr_bitfieldDestruct( &tor->checkedPieces );
1285
1286    tr_free( tor->downloadDir );
1287    tr_free( tor->incompleteDir );
1288    tr_free( tor->peer_id );
1289
1290    if( tor == session->torrentList )
1291        session->torrentList = tor->next;
1292    else for( t = session->torrentList; t != NULL; t = t->next ) {
1293        if( t->next == tor ) {
1294            t->next = tor->next;
1295            break;
1296        }
1297    }
1298
1299    assert( session->torrentCount >= 1 );
1300    session->torrentCount--;
1301
1302    tr_bandwidthFree( tor->bandwidth );
1303
1304    tr_metainfoFree( inf );
1305    tr_free( tor );
1306
1307    tr_globalUnlock( session );
1308}
1309
1310/**
1311***  Start/Stop Callback
1312**/
1313
1314static void
1315checkAndStartImpl( void * vtor )
1316{
1317    tr_torrent * tor = vtor;
1318
1319    assert( tr_isTorrent( tor ) );
1320
1321    tr_globalLock( tor->session );
1322
1323    /** If we had local data before, but it's disappeared,
1324        stop the torrent and log an error. */
1325    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1326    {
1327        tr_torrentSetLocalError( tor, _( "Can't find local data.  Try \"Set Location\" to find it, or restart the torrent to re-download." ) );
1328        tr_torrentStop( tor );
1329    }
1330    else
1331    {
1332        const time_t now = time( NULL );
1333        tor->isRunning = TRUE;
1334        tor->needsSeedRatioCheck = TRUE;
1335        tor->error = TR_STAT_OK;
1336        tor->errorString[0] = '\0';
1337        tor->completeness = tr_cpGetStatus( &tor->completion );
1338        tor->startDate = tor->anyDate = now;
1339
1340        tr_torrentResetTransferStats( tor );
1341        tr_announcerTorrentStarted( tor );
1342        tor->dhtAnnounceAt = now + tr_cryptoWeakRandInt( 20 );
1343        tr_peerMgrStartTorrent( tor );
1344    }
1345
1346    tr_globalUnlock( tor->session );
1347}
1348
1349static void
1350checkAndStartCB( tr_torrent * tor )
1351{
1352    assert( tr_isTorrent( tor ) );
1353    assert( tr_isSession( tor->session ) );
1354
1355    tr_runInEventThread( tor->session, checkAndStartImpl, tor );
1356}
1357
1358static void
1359torrentStart( tr_torrent * tor )
1360{
1361    assert( tr_isTorrent( tor ) );
1362
1363    tr_globalLock( tor->session );
1364
1365    if( !tor->isRunning )
1366    {
1367        tr_verifyRemove( tor );
1368
1369        /* corresponds to the peer_id sent as a tracker request parameter.
1370         * one tracker admin says: "When the same torrent is opened and
1371         * closed and opened again without quitting Transmission ...
1372         * change the peerid. It would help sometimes if a stopped event
1373         * was missed to ensure that we didn't think someone was cheating. */
1374        tr_free( tor->peer_id );
1375        tor->peer_id = tr_peerIdNew( );
1376
1377        tor->isRunning = 1;
1378        tr_torrentSetDirty( tor );
1379        tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1380        tr_verifyAdd( tor, checkAndStartCB );
1381    }
1382
1383    tr_globalUnlock( tor->session );
1384}
1385
1386void
1387tr_torrentStart( tr_torrent * tor )
1388{
1389    if( tr_isTorrent( tor ) )
1390        torrentStart( tor );
1391}
1392
1393static void
1394torrentRecheckDoneImpl( void * vtor )
1395{
1396    tr_torrent * tor = vtor;
1397
1398    assert( tr_isTorrent( tor ) );
1399    tr_torrentRecheckCompleteness( tor );
1400
1401    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1402    {
1403        tr_torrentSetLocalError( tor, _( "Can't find local data.  Try \"Set Location\" to find it, or restart the torrent to re-download." ) );
1404        tr_torrentStop( tor );
1405    }
1406    else if( tor->startAfterVerify )
1407    {
1408        tor->startAfterVerify = FALSE;
1409
1410        tr_torrentStart( tor );
1411    }
1412}
1413
1414static void
1415torrentRecheckDoneCB( tr_torrent * tor )
1416{
1417    assert( tr_isTorrent( tor ) );
1418
1419    tr_runInEventThread( tor->session, torrentRecheckDoneImpl, tor );
1420}
1421
1422static void
1423verifyTorrent( void * vtor )
1424{
1425    tr_torrent * tor = vtor;
1426
1427    assert( tr_isTorrent( tor ) );
1428    tr_globalLock( tor->session );
1429
1430    /* if the torrent's already being verified, stop it */
1431    tr_verifyRemove( tor );
1432
1433    /* if the torrent's running, stop it & set the restart-after-verify flag */
1434    if( tor->startAfterVerify || tor->isRunning ) {
1435        tr_torrentStop( tor );
1436        tor->startAfterVerify = TRUE;
1437    }
1438
1439    /* add the torrent to the recheck queue */
1440    tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1441    tr_torrentUncheck( tor );
1442    tr_verifyAdd( tor, torrentRecheckDoneCB );
1443
1444    tr_globalUnlock( tor->session );
1445}
1446
1447void
1448tr_torrentVerify( tr_torrent * tor )
1449{
1450    if( tr_isTorrent( tor ) )
1451        tr_runInEventThread( tor->session, verifyTorrent, tor );
1452}
1453
1454void
1455tr_torrentSave( tr_torrent * tor )
1456{
1457    assert( tr_isTorrent( tor ) );
1458
1459    if( tor->isDirty ) {
1460        tor->isDirty = FALSE;
1461        tr_torrentSaveResume( tor );
1462    }
1463}
1464
1465static void
1466stopTorrent( void * vtor )
1467{
1468    tr_torrent * tor = vtor;
1469
1470    assert( tr_isTorrent( tor ) );
1471
1472    tr_verifyRemove( tor );
1473    tr_peerMgrStopTorrent( tor );
1474    tr_announcerTorrentStopped( tor );
1475
1476    tr_fdTorrentClose( tor->session, tor->uniqueId );
1477
1478    if( !tor->isDeleting )
1479        tr_torrentSave( tor );
1480}
1481
1482void
1483tr_torrentStop( tr_torrent * tor )
1484{
1485    assert( tr_isTorrent( tor ) );
1486
1487    if( tr_isTorrent( tor ) )
1488    {
1489        tr_globalLock( tor->session );
1490
1491        tor->isRunning = 0;
1492        tr_torrentSetDirty( tor );
1493        tr_runInEventThread( tor->session, stopTorrent, tor );
1494
1495        tr_globalUnlock( tor->session );
1496    }
1497}
1498
1499static void
1500closeTorrent( void * vtor )
1501{
1502    tr_benc * d;
1503    tr_torrent * tor = vtor;
1504
1505    assert( tr_isTorrent( tor ) );
1506
1507    d = tr_bencListAddDict( &tor->session->removedTorrents, 2 );
1508    tr_bencDictAddInt( d, "id", tor->uniqueId );
1509    tr_bencDictAddInt( d, "date", time( NULL ) );
1510
1511    stopTorrent( tor );
1512
1513    if( tor->isDeleting )
1514    {
1515        tr_metainfoRemoveSaved( tor->session, &tor->info );
1516        tr_torrentRemoveResume( tor );
1517    }
1518
1519    tor->isRunning = 0;
1520    freeTorrent( tor );
1521}
1522
1523void
1524tr_torrentFree( tr_torrent * tor )
1525{
1526    if( tr_isTorrent( tor ) )
1527    {
1528        tr_session * session = tor->session;
1529        assert( tr_isSession( session ) );
1530        tr_globalLock( session );
1531
1532        tr_torrentClearCompletenessCallback( tor );
1533        tr_runInEventThread( session, closeTorrent, tor );
1534
1535        tr_globalUnlock( session );
1536    }
1537}
1538
1539void
1540tr_torrentRemove( tr_torrent * tor )
1541{
1542    assert( tr_isTorrent( tor ) );
1543
1544    tor->isDeleting = 1;
1545    tr_torrentFree( tor );
1546}
1547
1548/**
1549***  Completeness
1550**/
1551
1552static const char *
1553getCompletionString( int type )
1554{
1555    switch( type )
1556    {
1557        /* Translators: this is a minor point that's safe to skip over, but FYI:
1558           "Complete" and "Done" are specific, different terms in Transmission:
1559           "Complete" means we've downloaded every file in the torrent.
1560           "Done" means we're done downloading the files we wanted, but NOT all
1561           that exist */
1562        case TR_PARTIAL_SEED:
1563            return _( "Done" );
1564
1565        case TR_SEED:
1566            return _( "Complete" );
1567
1568        default:
1569            return _( "Incomplete" );
1570    }
1571}
1572
1573static void
1574fireCompletenessChange( tr_torrent       * tor,
1575                        tr_completeness    status )
1576{
1577    assert( tr_isTorrent( tor ) );
1578    assert( ( status == TR_LEECH )
1579         || ( status == TR_SEED )
1580         || ( status == TR_PARTIAL_SEED ) );
1581
1582    if( tor->completeness_func )
1583        tor->completeness_func( tor, status, tor->completeness_func_user_data );
1584}
1585
1586void
1587tr_torrentSetCompletenessCallback( tr_torrent                    * tor,
1588                                   tr_torrent_completeness_func    func,
1589                                   void                          * user_data )
1590{
1591    assert( tr_isTorrent( tor ) );
1592
1593    tor->completeness_func = func;
1594    tor->completeness_func_user_data = user_data;
1595}
1596
1597void
1598tr_torrentSetRatioLimitHitCallback( tr_torrent                     * tor,
1599                                    tr_torrent_ratio_limit_hit_func  func,
1600                                    void                           * user_data )
1601{
1602    assert( tr_isTorrent( tor ) );
1603
1604    tor->ratio_limit_hit_func = func;
1605    tor->ratio_limit_hit_func_user_data = user_data;
1606}
1607
1608void
1609tr_torrentClearCompletenessCallback( tr_torrent * torrent )
1610{
1611    tr_torrentSetCompletenessCallback( torrent, NULL, NULL );
1612}
1613
1614void
1615tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent )
1616{
1617    tr_torrentSetRatioLimitHitCallback( torrent, NULL, NULL );
1618}
1619
1620void
1621tr_torrentRecheckCompleteness( tr_torrent * tor )
1622{
1623    tr_completeness completeness;
1624
1625    assert( tr_isTorrent( tor ) );
1626
1627    tr_torrentLock( tor );
1628
1629    completeness = tr_cpGetStatus( &tor->completion );
1630
1631    if( completeness != tor->completeness )
1632    {
1633        const int recentChange = tor->downloadedCur != 0;
1634
1635        if( recentChange )
1636        {
1637            tr_torinf( tor, _( "State changed from \"%1$s\" to \"%2$s\"" ),
1638                      getCompletionString( tor->completeness ),
1639                      getCompletionString( completeness ) );
1640        }
1641
1642        tor->completeness = completeness;
1643        tor->needsSeedRatioCheck = TRUE;
1644        tr_fdTorrentClose( tor->session, tor->uniqueId );
1645
1646        /* if the torrent is a seed now,
1647         * and the files used to be in the incompleteDir,
1648         * then move them to the destination directory */
1649        if( tr_torrentIsSeed( tor ) && ( tor->currentDir == tor->incompleteDir ) )
1650            tr_torrentSetLocation( tor, tor->downloadDir, TRUE, NULL, NULL );
1651
1652        fireCompletenessChange( tor, completeness );
1653
1654        if( recentChange && ( completeness == TR_SEED ) )
1655        {
1656            tr_announcerTorrentCompleted( tor );
1657
1658            tor->doneDate = tor->anyDate = time( NULL );
1659        }
1660
1661        tr_torrentSetDirty( tor );
1662    }
1663
1664    tr_torrentUnlock( tor );
1665}
1666
1667/**
1668***  File priorities
1669**/
1670
1671void
1672tr_torrentInitFilePriority( tr_torrent *    tor,
1673                            tr_file_index_t fileIndex,
1674                            tr_priority_t   priority )
1675{
1676    tr_piece_index_t i;
1677    tr_file *        file;
1678
1679    assert( tr_isTorrent( tor ) );
1680    assert( fileIndex < tor->info.fileCount );
1681    assert( tr_isPriority( priority ) );
1682
1683    file = &tor->info.files[fileIndex];
1684    file->priority = priority;
1685    for( i = file->firstPiece; i <= file->lastPiece; ++i )
1686        tor->info.pieces[i].priority = calculatePiecePriority( tor, i, fileIndex );
1687}
1688
1689void
1690tr_torrentSetFilePriorities( tr_torrent *      tor,
1691                             tr_file_index_t * files,
1692                             tr_file_index_t   fileCount,
1693                             tr_priority_t     priority )
1694{
1695    tr_file_index_t i;
1696
1697    assert( tr_isTorrent( tor ) );
1698
1699    tr_torrentLock( tor );
1700
1701    for( i = 0; i < fileCount; ++i )
1702        tr_torrentInitFilePriority( tor, files[i], priority );
1703
1704    tr_torrentSetDirty( tor );
1705    tr_torrentUnlock( tor );
1706}
1707
1708tr_priority_t
1709tr_torrentGetFilePriority( const tr_torrent * tor,
1710                           tr_file_index_t    file )
1711{
1712    tr_priority_t ret;
1713
1714    assert( tr_isTorrent( tor ) );
1715
1716    tr_torrentLock( tor );
1717    assert( tor );
1718    assert( file < tor->info.fileCount );
1719    ret = tor->info.files[file].priority;
1720    tr_torrentUnlock( tor );
1721
1722    return ret;
1723}
1724
1725tr_priority_t*
1726tr_torrentGetFilePriorities( const tr_torrent * tor )
1727{
1728    tr_file_index_t i;
1729    tr_priority_t * p;
1730
1731    assert( tr_isTorrent( tor ) );
1732
1733    tr_torrentLock( tor );
1734    p = tr_new0( tr_priority_t, tor->info.fileCount );
1735    for( i = 0; i < tor->info.fileCount; ++i )
1736        p[i] = tor->info.files[i].priority;
1737    tr_torrentUnlock( tor );
1738
1739    return p;
1740}
1741
1742/**
1743***  File DND
1744**/
1745
1746int
1747tr_torrentGetFileDL( const tr_torrent * tor,
1748                     tr_file_index_t    file )
1749{
1750    int doDownload;
1751
1752    assert( tr_isTorrent( tor ) );
1753
1754    tr_torrentLock( tor );
1755
1756    assert( file < tor->info.fileCount );
1757    doDownload = !tor->info.files[file].dnd;
1758
1759    tr_torrentUnlock( tor );
1760    return doDownload != 0;
1761}
1762
1763static void
1764setFileDND( tr_torrent * tor, tr_file_index_t fileIndex, int doDownload )
1765{
1766    tr_file *        file;
1767    const int        dnd = !doDownload;
1768    tr_piece_index_t firstPiece, firstPieceDND;
1769    tr_piece_index_t lastPiece, lastPieceDND;
1770    tr_file_index_t  i;
1771
1772    assert( tr_isTorrent( tor ) );
1773
1774    file = &tor->info.files[fileIndex];
1775    file->dnd = dnd;
1776    firstPiece = file->firstPiece;
1777    lastPiece = file->lastPiece;
1778
1779    /* can't set the first piece to DND unless
1780       every file using that piece is DND */
1781    firstPieceDND = dnd;
1782    if( fileIndex > 0 )
1783    {
1784        for( i = fileIndex - 1; firstPieceDND; --i )
1785        {
1786            if( tor->info.files[i].lastPiece != firstPiece )
1787                break;
1788            firstPieceDND = tor->info.files[i].dnd;
1789            if( !i )
1790                break;
1791        }
1792    }
1793
1794    /* can't set the last piece to DND unless
1795       every file using that piece is DND */
1796    lastPieceDND = dnd;
1797    for( i = fileIndex + 1; lastPieceDND && i < tor->info.fileCount; ++i )
1798    {
1799        if( tor->info.files[i].firstPiece != lastPiece )
1800            break;
1801        lastPieceDND = tor->info.files[i].dnd;
1802    }
1803
1804    if( firstPiece == lastPiece )
1805    {
1806        tor->info.pieces[firstPiece].dnd = firstPieceDND && lastPieceDND;
1807    }
1808    else
1809    {
1810        tr_piece_index_t pp;
1811        tor->info.pieces[firstPiece].dnd = firstPieceDND;
1812        tor->info.pieces[lastPiece].dnd = lastPieceDND;
1813        for( pp = firstPiece + 1; pp < lastPiece; ++pp )
1814            tor->info.pieces[pp].dnd = dnd;
1815    }
1816}
1817
1818void
1819tr_torrentInitFileDLs( tr_torrent      * tor,
1820                       tr_file_index_t * files,
1821                       tr_file_index_t   fileCount,
1822                       tr_bool           doDownload )
1823{
1824    tr_file_index_t i;
1825
1826    assert( tr_isTorrent( tor ) );
1827
1828    tr_torrentLock( tor );
1829
1830    for( i=0; i<fileCount; ++i )
1831        setFileDND( tor, files[i], doDownload );
1832    tr_cpInvalidateDND( &tor->completion );
1833    tor->needsSeedRatioCheck = TRUE;
1834
1835    tr_torrentUnlock( tor );
1836}
1837
1838void
1839tr_torrentSetFileDLs( tr_torrent *      tor,
1840                      tr_file_index_t * files,
1841                      tr_file_index_t   fileCount,
1842                      tr_bool           doDownload )
1843{
1844    assert( tr_isTorrent( tor ) );
1845
1846    tr_torrentLock( tor );
1847    tr_torrentInitFileDLs( tor, files, fileCount, doDownload );
1848    tr_torrentSetDirty( tor );
1849    tr_torrentUnlock( tor );
1850}
1851
1852/***
1853****
1854***/
1855
1856tr_priority_t
1857tr_torrentGetPriority( const tr_torrent * tor )
1858{
1859    assert( tr_isTorrent( tor ) );
1860
1861    return tor->bandwidth->priority;
1862}
1863
1864void
1865tr_torrentSetPriority( tr_torrent * tor, tr_priority_t priority )
1866{
1867    assert( tr_isTorrent( tor ) );
1868    assert( tr_isPriority( priority ) );
1869
1870    if( tor->bandwidth->priority != priority )
1871    {
1872        tor->bandwidth->priority = priority;
1873
1874        tr_torrentSetDirty( tor );
1875    }
1876}
1877
1878/***
1879****
1880***/
1881
1882void
1883tr_torrentSetPeerLimit( tr_torrent * tor,
1884                        uint16_t     maxConnectedPeers )
1885{
1886    assert( tr_isTorrent( tor ) );
1887
1888    if ( tor->maxConnectedPeers != maxConnectedPeers )
1889    {
1890        tor->maxConnectedPeers = maxConnectedPeers;
1891
1892        tr_torrentSetDirty( tor );
1893    }
1894}
1895
1896uint16_t
1897tr_torrentGetPeerLimit( const tr_torrent * tor )
1898{
1899    assert( tr_isTorrent( tor ) );
1900
1901    return tor->maxConnectedPeers;
1902}
1903
1904/***
1905****
1906***/
1907
1908tr_block_index_t
1909_tr_block( const tr_torrent * tor,
1910           tr_piece_index_t   index,
1911           uint32_t           offset )
1912{
1913    tr_block_index_t ret;
1914
1915    assert( tr_isTorrent( tor ) );
1916
1917    ret = index;
1918    ret *= ( tor->info.pieceSize / tor->blockSize );
1919    ret += offset / tor->blockSize;
1920    return ret;
1921}
1922
1923tr_bool
1924tr_torrentReqIsValid( const tr_torrent * tor,
1925                      tr_piece_index_t   index,
1926                      uint32_t           offset,
1927                      uint32_t           length )
1928{
1929    int err = 0;
1930
1931    assert( tr_isTorrent( tor ) );
1932
1933    if( index >= tor->info.pieceCount )
1934        err = 1;
1935    else if( length < 1 )
1936        err = 2;
1937    else if( ( offset + length ) > tr_torPieceCountBytes( tor, index ) )
1938        err = 3;
1939    else if( length > MAX_BLOCK_SIZE )
1940        err = 4;
1941    else if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
1942        err = 5;
1943
1944    if( err ) tr_tordbg( tor, "index %lu offset %lu length %lu err %d\n",
1945                              (unsigned long)index,
1946                              (unsigned long)offset,
1947                              (unsigned long)length,
1948                              err );
1949
1950    return !err;
1951}
1952
1953uint64_t
1954tr_pieceOffset( const tr_torrent * tor,
1955                tr_piece_index_t   index,
1956                uint32_t           offset,
1957                uint32_t           length )
1958{
1959    uint64_t ret;
1960
1961    assert( tr_isTorrent( tor ) );
1962
1963    ret = tor->info.pieceSize;
1964    ret *= index;
1965    ret += offset;
1966    ret += length;
1967    return ret;
1968}
1969
1970/***
1971****
1972***/
1973
1974void
1975tr_torrentSetPieceChecked( tr_torrent        * tor,
1976                           tr_piece_index_t    piece,
1977                           tr_bool             isChecked )
1978{
1979    assert( tr_isTorrent( tor ) );
1980
1981    if( isChecked )
1982        tr_bitfieldAdd( &tor->checkedPieces, piece );
1983    else
1984        tr_bitfieldRem( &tor->checkedPieces, piece );
1985}
1986
1987void
1988tr_torrentSetFileChecked( tr_torrent *    tor,
1989                          tr_file_index_t fileIndex,
1990                          tr_bool         isChecked )
1991{
1992    const tr_file *        file = &tor->info.files[fileIndex];
1993    const tr_piece_index_t begin = file->firstPiece;
1994    const tr_piece_index_t end = file->lastPiece + 1;
1995
1996    assert( tr_isTorrent( tor ) );
1997
1998    if( isChecked )
1999        tr_bitfieldAddRange( &tor->checkedPieces, begin, end );
2000    else
2001        tr_bitfieldRemRange( &tor->checkedPieces, begin, end );
2002}
2003
2004tr_bool
2005tr_torrentIsFileChecked( const tr_torrent * tor,
2006                         tr_file_index_t    fileIndex )
2007{
2008    const tr_file *        file = &tor->info.files[fileIndex];
2009    const tr_piece_index_t begin = file->firstPiece;
2010    const tr_piece_index_t end = file->lastPiece + 1;
2011    tr_piece_index_t       i;
2012    tr_bool                isChecked = TRUE;
2013
2014    assert( tr_isTorrent( tor ) );
2015
2016    for( i = begin; isChecked && i < end; ++i )
2017        if( !tr_torrentIsPieceChecked( tor, i ) )
2018            isChecked = FALSE;
2019
2020    return isChecked;
2021}
2022
2023void
2024tr_torrentUncheck( tr_torrent * tor )
2025{
2026    assert( tr_isTorrent( tor ) );
2027
2028    tr_bitfieldRemRange( &tor->checkedPieces, 0, tor->info.pieceCount );
2029}
2030
2031int
2032tr_torrentCountUncheckedPieces( const tr_torrent * tor )
2033{
2034    assert( tr_isTorrent( tor ) );
2035
2036    return tor->info.pieceCount - tr_bitfieldCountTrueBits( &tor->checkedPieces );
2037}
2038
2039time_t*
2040tr_torrentGetMTimes( const tr_torrent * tor, size_t * setme_n )
2041{
2042    size_t       i;
2043    const size_t n = tor->info.fileCount;
2044    time_t *     m = tr_new0( time_t, n );
2045
2046    assert( tr_isTorrent( tor ) );
2047
2048    for( i = 0; i < n; ++i )
2049    {
2050        struct stat sb;
2051        char * path = tr_torrentFindFile( tor, i );
2052        if( ( path != NULL ) && !stat( path, &sb ) && S_ISREG( sb.st_mode ) )
2053        {
2054#ifdef SYS_DARWIN
2055            m[i] = sb.st_mtimespec.tv_sec;
2056#else
2057            m[i] = sb.st_mtime;
2058#endif
2059        }
2060        tr_free( path );
2061    }
2062
2063    *setme_n = n;
2064    return m;
2065}
2066
2067/***
2068****
2069***/
2070
2071tr_announce_list_err
2072tr_torrentSetAnnounceList( tr_torrent *            tor,
2073                           const tr_tracker_info * trackers,
2074                           int                     trackerCount )
2075{
2076    int i, j;
2077    tr_benc metainfo;
2078
2079    assert( tr_isTorrent( tor ) );
2080
2081    /* look for bad URLs */
2082    for( i=0; i<trackerCount; ++i )
2083        if( !tr_httpIsValidURL( trackers[i].announce ) )
2084            return TR_ANNOUNCE_LIST_HAS_BAD;
2085
2086    /* look for duplicates */
2087    for( i=0; i<trackerCount; ++i )
2088        for( j=0; j<trackerCount; ++j )
2089            if( ( i != j ) && ( !strcmp( trackers[i].announce, trackers[j].announce ) ) )
2090                return TR_ANNOUNCE_LIST_HAS_DUPLICATES;
2091
2092    /* save to the .torrent file */
2093    if( !tr_bencLoadFile( &metainfo, TR_FMT_BENC, tor->info.torrent ) )
2094    {
2095        int       i;
2096        int       prevTier = -1;
2097        tr_benc * tier = NULL;
2098        tr_benc * announceList;
2099        tr_info   tmpInfo;
2100
2101        /* remove the old fields */
2102        tr_bencDictRemove( &metainfo, "announce" );
2103        tr_bencDictRemove( &metainfo, "announce-list" );
2104
2105        /* add the new fields */
2106        tr_bencDictAddStr( &metainfo, "announce", trackers[0].announce );
2107        announceList = tr_bencDictAddList( &metainfo, "announce-list", 0 );
2108        for( i = 0; i < trackerCount; ++i ) {
2109            if( prevTier != trackers[i].tier ) {
2110                prevTier = trackers[i].tier;
2111                tier = tr_bencListAddList( announceList, 0 );
2112            }
2113            tr_bencListAddStr( tier, trackers[i].announce );
2114        }
2115
2116        /* try to parse it back again, to make sure it's good */
2117        memset( &tmpInfo, 0, sizeof( tr_info ) );
2118        if( tr_metainfoParse( tor->session, &tmpInfo, &metainfo ) )
2119        {
2120            /* it's good, so keep these new trackers and free the old ones */
2121
2122            tr_info swap;
2123            swap.trackers = tor->info.trackers;
2124            swap.trackerCount = tor->info.trackerCount;
2125            tor->info.trackers = tmpInfo.trackers;
2126            tor->info.trackerCount = tmpInfo.trackerCount;
2127            tmpInfo.trackers = swap.trackers;
2128            tmpInfo.trackerCount = swap.trackerCount;
2129
2130            tr_metainfoFree( &tmpInfo );
2131            tr_bencToFile( &metainfo, TR_FMT_BENC, tor->info.torrent );
2132        }
2133
2134        /* cleanup */
2135        tr_bencFree( &metainfo );
2136
2137        /* tell the announcer to reload this torrent's tracker list */
2138        tr_announcerResetTorrent( tor->session->announcer, tor );
2139    }
2140
2141    return TR_ANNOUNCE_LIST_OK;
2142}
2143
2144/**
2145***
2146**/
2147
2148void
2149tr_torrentSetAddedDate( tr_torrent * tor,
2150                        time_t       t )
2151{
2152    assert( tr_isTorrent( tor ) );
2153
2154    tor->addedDate = t;
2155    tor->anyDate = MAX( tor->anyDate, tor->addedDate );
2156}
2157
2158void
2159tr_torrentSetActivityDate( tr_torrent * tor, time_t t )
2160{
2161    assert( tr_isTorrent( tor ) );
2162
2163    tor->activityDate = t;
2164    tor->anyDate = MAX( tor->anyDate, tor->activityDate );
2165}
2166
2167void
2168tr_torrentSetDoneDate( tr_torrent * tor,
2169                       time_t       t )
2170{
2171    assert( tr_isTorrent( tor ) );
2172
2173    tor->doneDate = t;
2174    tor->anyDate = MAX( tor->anyDate, tor->doneDate );
2175}
2176
2177/**
2178***
2179**/
2180
2181uint64_t
2182tr_torrentGetBytesLeftToAllocate( const tr_torrent * tor )
2183{
2184    tr_file_index_t i;
2185    uint64_t bytesLeft = 0;
2186
2187    assert( tr_isTorrent( tor ) );
2188
2189    for( i=0; i<tor->info.fileCount; ++i )
2190    {
2191        if( !tor->info.files[i].dnd )
2192        {
2193            struct stat sb;
2194            const uint64_t length = tor->info.files[i].length;
2195            char * path = tr_torrentFindFile( tor, i );
2196
2197            bytesLeft += length;
2198
2199            if( ( path != NULL ) && !stat( path, &sb )
2200                                 && S_ISREG( sb.st_mode )
2201                                 && ( (uint64_t)sb.st_size <= length ) )
2202                bytesLeft -= sb.st_size;
2203
2204            tr_free( path );
2205        }
2206    }
2207
2208    return bytesLeft;
2209}
2210
2211/****
2212*****  Removing the torrent's local data
2213****/
2214
2215static int
2216vstrcmp( const void * a, const void * b )
2217{
2218    return strcmp( a, b );
2219}
2220
2221static int
2222compareLongestFirst( const void * a, const void * b )
2223{
2224    const size_t alen = strlen( a );
2225    const size_t blen = strlen( b );
2226
2227    if( alen != blen )
2228        return alen > blen ? -1 : 1;
2229
2230    return vstrcmp( a, b );
2231}
2232
2233static void
2234addDirtyFile( const char  * root,
2235              const char  * filename,
2236              tr_ptrArray * dirtyFolders )
2237{
2238    char * dir = tr_dirname( filename );
2239
2240    /* add the parent folders to dirtyFolders until we reach the root or a known-dirty */
2241    while (     ( dir != NULL )
2242             && ( strlen( root ) <= strlen( dir ) )
2243             && ( tr_ptrArrayFindSorted( dirtyFolders, dir, vstrcmp ) == NULL ) )
2244    {
2245        char * tmp;
2246        tr_ptrArrayInsertSorted( dirtyFolders, tr_strdup( dir ), vstrcmp );
2247
2248        tmp = tr_dirname( dir );
2249        tr_free( dir );
2250        dir = tmp;
2251    }
2252
2253    tr_free( dir );
2254}
2255
2256static void
2257walkLocalData( const tr_torrent * tor,
2258               const char       * root,
2259               const char       * dir,
2260               const char       * base,
2261               tr_ptrArray      * torrentFiles,
2262               tr_ptrArray      * folders,
2263               tr_ptrArray      * dirtyFolders )
2264{
2265    int i;
2266    struct stat sb;
2267    char * buf;
2268
2269    assert( tr_isTorrent( tor ) );
2270
2271    buf = tr_buildPath( dir, base, NULL );
2272    i = stat( buf, &sb );
2273    if( !i )
2274    {
2275        DIR * odir = NULL;
2276
2277        if( S_ISDIR( sb.st_mode ) && ( ( odir = opendir ( buf ) ) ) )
2278        {
2279            struct dirent *d;
2280            tr_ptrArrayInsertSorted( folders, tr_strdup( buf ), vstrcmp );
2281            for( d = readdir( odir ); d != NULL; d = readdir( odir ) )
2282                if( d->d_name && d->d_name[0] != '.' ) /* skip dotfiles */
2283                    walkLocalData( tor, root, buf, d->d_name, torrentFiles, folders, dirtyFolders );
2284            closedir( odir );
2285        }
2286        else if( S_ISREG( sb.st_mode ) && ( sb.st_size > 0 ) )
2287        {
2288            const char * sub = buf + strlen( tor->currentDir ) + strlen( TR_PATH_DELIMITER_STR );
2289            const tr_bool isTorrentFile = tr_ptrArrayFindSorted( torrentFiles, sub, vstrcmp ) != NULL;
2290            if( !isTorrentFile )
2291                addDirtyFile( root, buf, dirtyFolders );
2292        }
2293    }
2294
2295    tr_free( buf );
2296}
2297
2298static void
2299deleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2300{
2301    int i, n;
2302    char ** s;
2303    tr_file_index_t f;
2304    tr_ptrArray torrentFiles = TR_PTR_ARRAY_INIT;
2305    tr_ptrArray folders      = TR_PTR_ARRAY_INIT;
2306    tr_ptrArray dirtyFolders = TR_PTR_ARRAY_INIT; /* dirty == contains non-torrent files */
2307
2308    const char * firstFile = tor->info.files[0].name;
2309    const char * cpch = strchr( firstFile, TR_PATH_DELIMITER );
2310    char * tmp = cpch ? tr_strndup( firstFile, cpch - firstFile ) : NULL;
2311    char * root = tr_buildPath( tor->currentDir, tmp, NULL );
2312
2313    assert( tr_isTorrent( tor ) );
2314
2315    for( f=0; f<tor->info.fileCount; ++f ) {
2316        tr_ptrArrayInsertSorted( &torrentFiles, tr_strdup( tor->info.files[f].name ), vstrcmp );
2317        tr_ptrArrayInsertSorted( &torrentFiles, tr_torrentBuildPartial( tor, f ), vstrcmp );
2318    }
2319
2320    /* build the set of folders and dirtyFolders */
2321    walkLocalData( tor, root, root, NULL, &torrentFiles, &folders, &dirtyFolders );
2322
2323    /* try to remove entire folders first, so that the recycle bin will be tidy */
2324    s = (char**) tr_ptrArrayPeek( &folders, &n );
2325    for( i=0; i<n; ++i )
2326        if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2327            fileFunc( s[i] );
2328
2329    /* now blow away any remaining torrent files, such as torrent files in dirty folders */
2330    for( f=0; f<tor->info.fileCount; ++f ) {
2331        char * path = tr_buildPath( tor->currentDir, tor->info.files[f].name, NULL );
2332        fileFunc( path );
2333        tr_free( path );
2334    }
2335
2336    /* Now clean out the directories left empty from the previous step.
2337     * Work from deepest to shallowest s.t. lower folders
2338     * won't prevent the upper folders from being deleted */
2339    {
2340        tr_ptrArray cleanFolders = TR_PTR_ARRAY_INIT;
2341        s = (char**) tr_ptrArrayPeek( &folders, &n );
2342        for( i=0; i<n; ++i )
2343            if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2344                tr_ptrArrayInsertSorted( &cleanFolders, s[i], compareLongestFirst );
2345        s = (char**) tr_ptrArrayPeek( &cleanFolders, &n );
2346        for( i=0; i<n; ++i ) {
2347#ifdef SYS_DARWIN
2348            char * dsStore = tr_buildPath( s[i], ".DS_Store", NULL );
2349            fileFunc( dsStore );
2350            tr_free( dsStore );
2351#endif
2352            fileFunc( s[i] );
2353        }
2354        tr_ptrArrayDestruct( &cleanFolders, NULL );
2355    }
2356
2357    /* cleanup */
2358    tr_ptrArrayDestruct( &dirtyFolders, tr_free );
2359    tr_ptrArrayDestruct( &folders, tr_free );
2360    tr_ptrArrayDestruct( &torrentFiles, tr_free );
2361    tr_free( root );
2362    tr_free( tmp );
2363}
2364
2365void
2366tr_torrentDeleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2367{
2368    assert( tr_isTorrent( tor ) );
2369
2370    if( fileFunc == NULL )
2371        fileFunc = remove;
2372
2373    /* close all the files because we're about to delete them */
2374    tr_fdTorrentClose( tor->session, tor->uniqueId );
2375
2376    if( tor->info.fileCount > 1 )
2377    {
2378        deleteLocalData( tor, fileFunc );
2379    }
2380    else
2381    {
2382        char * tmp;
2383
2384        /* torrent only has one file */
2385        char * path = tr_buildPath( tor->currentDir, tor->info.files[0].name, NULL );
2386        fileFunc( path );
2387        tr_free( path );
2388
2389       
2390        tmp = tr_torrentBuildPartial( tor, 0 );
2391        path = tr_buildPath( tor->currentDir, tmp, NULL );
2392        fileFunc( path );
2393        tr_free( path );
2394        tr_free( tmp );
2395    }
2396}
2397
2398/***
2399****
2400***/
2401
2402struct LocationData
2403{
2404    tr_bool move_from_old_location;
2405    int * setme_state;
2406    double * setme_progress;
2407    char * location;
2408    tr_torrent * tor;
2409};
2410
2411static void
2412setLocation( void * vdata )
2413{
2414    tr_bool err = FALSE;
2415    tr_bool verify_needed = FALSE;
2416    struct LocationData * data = vdata;
2417    tr_torrent * tor = data->tor;
2418    const tr_bool do_move = data->move_from_old_location;
2419    const char * location = data->location;
2420    double bytesHandled = 0;
2421
2422    assert( tr_isTorrent( tor ) );
2423
2424    if( strcmp( location, tor->currentDir ) )
2425    {
2426        tr_file_index_t i;
2427
2428        /* bad idea to move files while they're being verified... */
2429        tr_verifyRemove( tor );
2430
2431        /* if the torrent is running, stop it and set a flag to
2432         * restart after we're done */
2433        if( tor->isRunning )
2434        {
2435            tr_torrentStop( tor );
2436            tor->startAfterVerify = TRUE;
2437        }
2438
2439        /* try to move the files.
2440         * FIXME: there are still all kinds of nasty cases, like what
2441         * if the target directory runs out of space halfway through... */
2442        for( i=0; !err && i<tor->info.fileCount; ++i )
2443        {
2444            const tr_file * f = &tor->info.files[i];
2445            const char * oldbase;
2446            char * sub;
2447            if( tr_torrentFindFile2( tor, i, &oldbase, &sub ) )
2448            {
2449                char * oldpath = tr_buildPath( oldbase, sub, NULL );
2450                char * newpath = tr_buildPath( location, sub, NULL );
2451
2452                if( do_move )
2453                {
2454                    tr_bool renamed = FALSE;
2455                    errno = 0;
2456                    tr_torinf( tor, "moving \"%s\" to \"%s\"", oldpath, newpath );
2457                    if( tr_moveFile( oldpath, newpath, &renamed ) )
2458                    {
2459                        err = TRUE;
2460                        tr_torerr( tor, "error moving \"%s\" to \"%s\": %s",
2461                                        oldpath, newpath, tr_strerror( errno ) );
2462                    }
2463                    else if( !renamed )
2464                    {
2465                        verify_needed = TRUE;
2466                    }
2467                }
2468
2469                tr_free( newpath );
2470                tr_free( oldpath );
2471                tr_free( sub );
2472            }
2473
2474            if( data->setme_progress )
2475            {
2476                bytesHandled += f->length;
2477                *data->setme_progress = bytesHandled / tor->info.totalSize;
2478            }
2479        }
2480
2481        if( !err )
2482        {
2483            /* blow away the leftover subdirectories in the old location */
2484            if( do_move )
2485                tr_torrentDeleteLocalData( tor, remove );
2486
2487            /* set the new location and reverify */
2488            tr_torrentSetDownloadDir( tor, location );
2489            if( verify_needed )
2490                tr_torrentVerify( tor );
2491            else if( tor->startAfterVerify ) {
2492                tor->startAfterVerify = FALSE;
2493                tr_torrentStart( tor );
2494            }
2495        }
2496    }
2497
2498    if( data->setme_state )
2499        *data->setme_state = err ? TR_LOC_ERROR : TR_LOC_DONE;
2500
2501    /* cleanup */
2502    tr_free( data->location );
2503    tr_free( data );
2504}
2505
2506void
2507tr_torrentSetLocation( tr_torrent  * tor,
2508                       const char  * location,
2509                       tr_bool       move_from_old_location,
2510                       double      * setme_progress,
2511                       int         * setme_state )
2512{
2513    struct LocationData * data;
2514
2515    assert( tr_isTorrent( tor ) );
2516
2517    if( setme_state )
2518        *setme_state = TR_LOC_MOVING;
2519    if( setme_progress )
2520        *setme_progress = 0;
2521
2522    /* run this in the libtransmission thread */
2523    data = tr_new( struct LocationData, 1 );
2524    data->tor = tor;
2525    data->location = tr_strdup( location );
2526    data->move_from_old_location = move_from_old_location;
2527    data->setme_state = setme_state;
2528    data->setme_progress = setme_progress;
2529    tr_runInEventThread( tor->session, setLocation, data );
2530}
2531
2532/***
2533****
2534***/
2535
2536void
2537tr_torrentCheckSeedRatio( tr_torrent * tor )
2538{
2539    double seedRatio;
2540
2541    assert( tr_isTorrent( tor ) );
2542
2543    /* if we're seeding and we've reached our seed ratio limit, stop the torrent */
2544    if( tor->isRunning && tr_torrentIsSeed( tor ) && tr_torrentGetSeedRatio( tor, &seedRatio ) )
2545    {
2546        const uint64_t up = tor->uploadedCur + tor->uploadedPrev;
2547        uint64_t down = tor->downloadedCur + tor->downloadedPrev;
2548        double ratio;
2549
2550        /* maybe we're the initial seeder and never downloaded anything... */
2551        if( down == 0 )
2552            down = tr_cpHaveValid( &tor->completion );
2553
2554        ratio = tr_getRatio( up, down );
2555
2556        if( ratio >= seedRatio || ratio == TR_RATIO_INF )
2557        {
2558            tr_torrentStop( tor );
2559
2560            /* set to no ratio limit to allow easy restarting */
2561            tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_UNLIMITED );
2562
2563            /* maybe notify the client */
2564            if( tor->ratio_limit_hit_func != NULL )
2565                tor->ratio_limit_hit_func( tor, tor->ratio_limit_hit_func_user_data );
2566        }
2567    }
2568}
2569
2570/***
2571****
2572***/
2573
2574void
2575tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNum )
2576{
2577    char * sub;
2578    const char * base;
2579
2580    /* close the file so that we can reopen in read-only mode as needed */
2581    tr_fdFileClose( tor->session, tor, fileNum );
2582
2583    /* if the torrent's filename on disk isn't the same as the one in the metadata,
2584     * then it's been modified to denote that it was a partial file.
2585     * Now that it's complete, use the proper filename. */
2586    if( tr_torrentFindFile2( tor, fileNum, &base, &sub ) )
2587    {
2588        const tr_file * file = &tor->info.files[fileNum];
2589
2590        if( strcmp( sub, file->name ) )
2591        {
2592            char * oldpath = tr_buildPath( base, sub, NULL );
2593            char * newpath = tr_buildPath( base, file->name, NULL );
2594
2595            if( rename( oldpath, newpath ) )
2596                tr_torerr( tor, "Error moving \"%s\" to \"%s\": %s", oldpath, newpath, tr_strerror( errno ) );
2597
2598            tr_free( newpath );
2599            tr_free( oldpath );
2600        }
2601
2602        tr_free( sub );
2603    }
2604}
2605
2606/***
2607****
2608***/
2609
2610static tr_bool
2611fileExists( const char * filename )
2612{
2613    struct stat sb;
2614    const tr_bool ok = !stat( filename, &sb );
2615    return ok;
2616}
2617
2618tr_bool
2619tr_torrentFindFile2( const tr_torrent * tor, tr_file_index_t fileNum,
2620                     const char ** base, char ** subpath )
2621{
2622    char * part;
2623    const tr_file * file;
2624    const char * b = NULL;
2625    const char * s = NULL;
2626
2627    assert( tr_isTorrent( tor ) );
2628    assert( fileNum < tor->info.fileCount );
2629
2630    file = &tor->info.files[fileNum];
2631    part = tr_torrentBuildPartial( tor, fileNum );
2632
2633    if( b == NULL ) {
2634        char * filename = tr_buildPath( tor->downloadDir, file->name, NULL );
2635        if( fileExists( filename ) ) {
2636            b = tor->downloadDir;
2637            s = file->name;
2638        }
2639        tr_free( filename );
2640    }
2641
2642    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2643        char * filename = tr_buildPath( tor->incompleteDir, file->name, NULL );
2644        if( fileExists( filename ) ) {
2645            b = tor->incompleteDir;
2646            s = file->name;
2647        }
2648        tr_free( filename );
2649    }
2650
2651    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2652        char * filename = tr_buildPath( tor->incompleteDir, part, NULL );
2653        if( fileExists( filename ) ) {
2654            b = tor->incompleteDir;
2655            s = part;
2656        }
2657        tr_free( filename );
2658    }
2659
2660    if( b == NULL) {
2661        char * filename = tr_buildPath( tor->downloadDir, part, NULL );
2662        if( fileExists( filename ) ) {
2663            b = tor->downloadDir;
2664            s = part;
2665        }
2666        tr_free( filename );
2667    }
2668
2669    if( base != NULL )
2670        *base = b;
2671    if( subpath != NULL )
2672        *subpath = tr_strdup( s );
2673
2674    tr_free( part );
2675    return b != NULL;
2676}
2677
2678
2679char*
2680tr_torrentFindFile( const tr_torrent * tor, tr_file_index_t fileNum )
2681{
2682    char * subpath;
2683    char * ret = NULL;
2684    const char * base;
2685
2686    if( tr_torrentFindFile2( tor, fileNum, &base, &subpath ) )
2687    {
2688        ret = tr_buildPath( base, subpath, NULL );
2689        tr_free( subpath );
2690    }
2691
2692    return ret;
2693}
2694
2695/* Decide whether we should be looking for files in downloadDir or incompleteDir. */
2696static void
2697refreshCurrentDir( tr_torrent * tor )
2698{
2699    const char * dir = NULL;
2700    char * sub;
2701
2702    if( tor->incompleteDir == NULL )
2703        dir = tor->downloadDir;
2704    else if( !tr_torrentFindFile2( tor, 0, &dir, &sub ) )
2705        dir = tor->incompleteDir;
2706
2707    assert( dir != NULL );
2708    assert( ( dir == tor->downloadDir ) || ( dir == tor->incompleteDir ) );
2709    tor->currentDir = dir;
2710}
2711
2712char*
2713tr_torrentBuildPartial( const tr_torrent * tor, tr_file_index_t fileNum )
2714{
2715    return tr_strdup_printf( "%s.part", tor->info.files[fileNum].name );
2716}
Note: See TracBrowser for help on using the repository browser.