source: trunk/libtransmission/torrent.c @ 10798

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

(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies.

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