source: trunk/libtransmission/torrent.c @ 10663

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

(trunk libT) remove dead function tr_torrentPromoteTracker()

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