source: trunk/libtransmission/torrent.c @ 10990

Last change on this file since 10990 was 10990, checked in by charles, 11 years ago

(trunk libT) #3388 "file completion percentage never updates" -- fixed.

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