source: trunk/libtransmission/torrent.c @ 12918

Last change on this file since 12918 was 12917, checked in by jordan, 10 years ago

in freeTorrent(), don't destruct the torrent's completion field until after calling tr_announceRemoveTorrent()

  • Property svn:keywords set to Date Rev Author Id
File size: 87.1 KB
Line 
1/*
2 * This file Copyright (C) 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 12917 2011-09-26 05:57:03Z jordan $
11 */
12
13#include <signal.h> /* signal() */
14#include <sys/types.h> /* stat */
15#include <sys/stat.h> /* stat */
16#ifndef WIN32
17 #include <sys/wait.h> /* wait() */
18#else
19 #include <process.h>
20 #define waitpid(pid, status, options)  _cwait(status, pid, WAIT_CHILD)
21#endif
22#include <unistd.h> /* stat */
23#include <dirent.h>
24
25#include <assert.h>
26#include <math.h>
27#include <stdarg.h>
28#include <string.h> /* memcmp */
29#include <stdlib.h> /* qsort */
30#include <stdio.h> /* remove() */
31
32#include <event2/util.h> /* evutil_vsnprintf() */
33
34#include "transmission.h"
35#include "announcer.h"
36#include "bandwidth.h"
37#include "bencode.h"
38#include "cache.h"
39#include "completion.h"
40#include "crypto.h" /* for tr_sha1 */
41#include "resume.h"
42#include "fdlimit.h" /* tr_fdTorrentClose */
43#include "inout.h" /* tr_ioTestPiece() */
44#include "magnet.h"
45#include "metainfo.h"
46#include "peer-common.h" /* MAX_BLOCK_SIZE */
47#include "peer-mgr.h"
48#include "platform.h" /* TR_PATH_DELIMITER_STR */
49#include "ptrarray.h"
50#include "session.h"
51#include "torrent.h"
52#include "torrent-magnet.h"
53#include "trevent.h" /* tr_runInEventThread() */
54#include "utils.h"
55#include "verify.h"
56#include "version.h"
57
58/***
59****
60***/
61
62#define tr_deeplog_tor( tor, ... ) \
63    do { \
64        if( tr_deepLoggingIsActive( ) ) \
65            tr_deepLog( __FILE__, __LINE__, tr_torrentName( tor ), __VA_ARGS__ ); \
66    } while( 0 )
67
68/***
69****
70***/
71
72const char *
73tr_torrentName( const tr_torrent * tor )
74{
75    assert( tr_isTorrent( tor ) );
76
77    return tor->info.name;
78}
79
80int
81tr_torrentId( const tr_torrent * tor )
82{
83    return tor->uniqueId;
84}
85
86tr_torrent*
87tr_torrentFindFromId( tr_session * session, int id )
88{
89    tr_torrent * tor = NULL;
90
91    while(( tor = tr_torrentNext( session, tor )))
92        if( tor->uniqueId == id )
93            return tor;
94
95    return NULL;
96}
97
98tr_torrent*
99tr_torrentFindFromHashString( tr_session *  session, const char * str )
100{
101    tr_torrent * tor = NULL;
102
103    while(( tor = tr_torrentNext( session, tor )))
104        if( !evutil_ascii_strcasecmp( str, tor->info.hashString ) )
105            return tor;
106
107    return NULL;
108}
109
110tr_torrent*
111tr_torrentFindFromHash( tr_session * session, const uint8_t * torrentHash )
112{
113    tr_torrent * tor = NULL;
114
115    while(( tor = tr_torrentNext( session, tor )))
116        if( *tor->info.hash == *torrentHash )
117            if( !memcmp( tor->info.hash, torrentHash, SHA_DIGEST_LENGTH ) )
118                return tor;
119
120    return NULL;
121}
122
123tr_torrent*
124tr_torrentFindFromMagnetLink( tr_session * session, const char * magnet )
125{
126    tr_magnet_info * info;
127    tr_torrent * tor = NULL;
128
129    if(( info = tr_magnetParse( magnet )))
130    {
131        tor = tr_torrentFindFromHash( session, info->hash );
132        tr_magnetFree( info );
133    }
134
135    return tor;
136}
137
138tr_torrent*
139tr_torrentFindFromObfuscatedHash( tr_session * session,
140                                  const uint8_t * obfuscatedTorrentHash )
141{
142    tr_torrent * tor = NULL;
143
144    while(( tor = tr_torrentNext( session, tor )))
145        if( !memcmp( tor->obfuscatedHash, obfuscatedTorrentHash,
146                     SHA_DIGEST_LENGTH ) )
147            return tor;
148
149    return NULL;
150}
151
152bool
153tr_torrentIsPieceTransferAllowed( const tr_torrent  * tor,
154                                  tr_direction        direction )
155{
156    int limit;
157    bool allowed = true;
158
159    if( tr_torrentUsesSpeedLimit( tor, direction ) )
160        if( tr_torrentGetSpeedLimit_Bps( tor, direction ) <= 0 )
161            allowed = false;
162
163    if( tr_torrentUsesSessionLimits( tor ) )
164        if( tr_sessionGetActiveSpeedLimit_Bps( tor->session, direction, &limit ) )
165            if( limit <= 0 )
166                allowed = false;
167
168    return allowed;
169}
170
171/***
172****  PER-TORRENT UL / DL SPEEDS
173***/
174
175void
176tr_torrentSetSpeedLimit_Bps( tr_torrent * tor, tr_direction dir, int Bps )
177{
178    assert( tr_isTorrent( tor ) );
179    assert( tr_isDirection( dir ) );
180    assert( Bps >= 0 );
181
182    if( tr_bandwidthSetDesiredSpeed_Bps( &tor->bandwidth, dir, Bps ) )
183        tr_torrentSetDirty( tor );
184}
185void
186tr_torrentSetSpeedLimit_KBps( tr_torrent * tor, tr_direction dir, int KBps )
187{
188    tr_torrentSetSpeedLimit_Bps( tor, dir, toSpeedBytes( KBps ) );
189}
190
191int
192tr_torrentGetSpeedLimit_Bps( const tr_torrent * tor, tr_direction dir )
193{
194    assert( tr_isTorrent( tor ) );
195    assert( tr_isDirection( dir ) );
196
197    return tr_bandwidthGetDesiredSpeed_Bps( &tor->bandwidth, dir );
198}
199int
200tr_torrentGetSpeedLimit_KBps( const tr_torrent * tor, tr_direction dir )
201{
202    return toSpeedKBps( tr_torrentGetSpeedLimit_Bps( tor, dir ) );
203}
204
205void
206tr_torrentUseSpeedLimit( tr_torrent * tor, tr_direction dir, bool do_use )
207{
208    assert( tr_isTorrent( tor ) );
209    assert( tr_isDirection( dir ) );
210
211    if( tr_bandwidthSetLimited( &tor->bandwidth, dir, do_use ) )
212        tr_torrentSetDirty( tor );
213}
214
215bool
216tr_torrentUsesSpeedLimit( const tr_torrent * tor, tr_direction dir )
217{
218    assert( tr_isTorrent( tor ) );
219    assert( tr_isDirection( dir ) );
220
221    return tr_bandwidthIsLimited( &tor->bandwidth, dir );
222}
223
224void
225tr_torrentUseSessionLimits( tr_torrent * tor, bool doUse )
226{
227    bool changed;
228
229    assert( tr_isTorrent( tor ) );
230
231    changed = tr_bandwidthHonorParentLimits( &tor->bandwidth, TR_UP, doUse );
232    changed |= tr_bandwidthHonorParentLimits( &tor->bandwidth, TR_DOWN, doUse );
233
234    if( changed )
235        tr_torrentSetDirty( tor );
236}
237
238bool
239tr_torrentUsesSessionLimits( const tr_torrent * tor )
240{
241    assert( tr_isTorrent( tor ) );
242
243    return tr_bandwidthAreParentLimitsHonored( &tor->bandwidth, TR_UP );
244}
245
246/***
247****
248***/
249
250void
251tr_torrentSetRatioMode( tr_torrent *  tor, tr_ratiolimit mode )
252{
253    assert( tr_isTorrent( tor ) );
254    assert( mode==TR_RATIOLIMIT_GLOBAL || mode==TR_RATIOLIMIT_SINGLE || mode==TR_RATIOLIMIT_UNLIMITED  );
255
256    if( mode != tor->ratioLimitMode )
257    {
258        tor->ratioLimitMode = mode;
259
260        tr_torrentSetDirty( tor );
261    }
262}
263
264tr_ratiolimit
265tr_torrentGetRatioMode( const tr_torrent * tor )
266{
267    assert( tr_isTorrent( tor ) );
268
269    return tor->ratioLimitMode;
270}
271
272void
273tr_torrentSetRatioLimit( tr_torrent * tor, double desiredRatio )
274{
275    assert( tr_isTorrent( tor ) );
276
277    if( (int)(desiredRatio*100.0) != (int)(tor->desiredRatio*100.0) )
278    {
279        tor->desiredRatio = desiredRatio;
280
281        tr_torrentSetDirty( tor );
282    }
283}
284
285double
286tr_torrentGetRatioLimit( const tr_torrent * tor )
287{
288    assert( tr_isTorrent( tor ) );
289
290    return tor->desiredRatio;
291}
292
293bool
294tr_torrentGetSeedRatio( const tr_torrent * tor, double * ratio )
295{
296    bool isLimited;
297
298    switch( tr_torrentGetRatioMode( tor ) )
299    {
300        case TR_RATIOLIMIT_SINGLE:
301            isLimited = true;
302            if( ratio )
303                *ratio = tr_torrentGetRatioLimit( tor );
304            break;
305
306        case TR_RATIOLIMIT_GLOBAL:
307            isLimited = tr_sessionIsRatioLimited( tor->session );
308            if( isLimited && ratio )
309                *ratio = tr_sessionGetRatioLimit( tor->session );
310            break;
311
312        default: /* TR_RATIOLIMIT_UNLIMITED */
313            isLimited = false;
314            break;
315    }
316
317    return isLimited;
318}
319
320/* returns true if the seed ratio applies --
321 * it applies if the torrent's a seed AND it has a seed ratio set */
322static bool
323tr_torrentGetSeedRatioBytes( tr_torrent  * tor,
324                             uint64_t    * setmeLeft,
325                             uint64_t    * setmeGoal )
326{
327    double seedRatio;
328    bool seedRatioApplies = false;
329
330    if( tr_torrentGetSeedRatio( tor, &seedRatio ) )
331    {
332        const uint64_t u = tor->uploadedCur + tor->uploadedPrev;
333        const uint64_t d = tor->downloadedCur + tor->downloadedPrev;
334        const uint64_t baseline = d ? d : tr_cpSizeWhenDone( &tor->completion );
335        const uint64_t goal = baseline * seedRatio;
336        if( setmeLeft ) *setmeLeft = goal > u ? goal - u : 0;
337        if( setmeGoal ) *setmeGoal = goal;
338        seedRatioApplies = tr_torrentIsSeed( tor );
339    }
340
341    return seedRatioApplies;
342}
343
344static bool
345tr_torrentIsSeedRatioDone( tr_torrent * tor )
346{
347    uint64_t bytesLeft;
348    return tr_torrentGetSeedRatioBytes( tor, &bytesLeft, NULL ) && !bytesLeft;
349}
350
351/***
352****
353***/
354
355void
356tr_torrentSetIdleMode( tr_torrent *  tor, tr_idlelimit mode )
357{
358    assert( tr_isTorrent( tor ) );
359    assert( mode==TR_IDLELIMIT_GLOBAL || mode==TR_IDLELIMIT_SINGLE || mode==TR_IDLELIMIT_UNLIMITED  );
360
361    if( mode != tor->idleLimitMode )
362    {
363        tor->idleLimitMode = mode;
364
365        tr_torrentSetDirty( tor );
366    }
367}
368
369tr_idlelimit
370tr_torrentGetIdleMode( const tr_torrent * tor )
371{
372    assert( tr_isTorrent( tor ) );
373
374    return tor->idleLimitMode;
375}
376
377void
378tr_torrentSetIdleLimit( tr_torrent * tor, uint16_t idleMinutes )
379{
380    assert( tr_isTorrent( tor ) );
381
382    if( idleMinutes > 0 )
383    {
384        tor->idleLimitMinutes = idleMinutes;
385
386        tr_torrentSetDirty( tor );
387    }
388}
389
390uint16_t
391tr_torrentGetIdleLimit( const tr_torrent * tor )
392{
393    assert( tr_isTorrent( tor ) );
394
395    return tor->idleLimitMinutes;
396}
397
398bool
399tr_torrentGetSeedIdle( const tr_torrent * tor, uint16_t * idleMinutes )
400{
401    bool isLimited;
402
403    switch( tr_torrentGetIdleMode( tor ) )
404    {
405        case TR_IDLELIMIT_SINGLE:
406            isLimited = true;
407            if( idleMinutes )
408                *idleMinutes = tr_torrentGetIdleLimit( tor );
409            break;
410
411        case TR_IDLELIMIT_GLOBAL:
412            isLimited = tr_sessionIsIdleLimited( tor->session );
413            if( isLimited && idleMinutes )
414                *idleMinutes = tr_sessionGetIdleLimit( tor->session );
415            break;
416
417        default: /* TR_IDLELIMIT_UNLIMITED */
418            isLimited = false;
419            break;
420    }
421
422    return isLimited;
423}
424
425static bool
426tr_torrentIsSeedIdleLimitDone( tr_torrent * tor )
427{
428    uint16_t idleMinutes;
429    return tr_torrentGetSeedIdle( tor, &idleMinutes )
430        && difftime(tr_time(), MAX(tor->startDate, tor->activityDate)) >= idleMinutes * 60u;
431}
432
433/***
434****
435***/
436
437void
438tr_torrentCheckSeedLimit( tr_torrent * tor )
439{
440    assert( tr_isTorrent( tor ) );
441
442    if( !tor->isRunning || !tr_torrentIsSeed( tor ) )
443        return;
444
445    /* if we're seeding and reach our seed ratio limit, stop the torrent */
446    if( tr_torrentIsSeedRatioDone( tor ) )
447    {
448        tr_torinf( tor, "Seed ratio reached; pausing torrent" );
449
450        tor->isStopping = true;
451
452        /* maybe notify the client */
453        if( tor->ratio_limit_hit_func != NULL )
454            tor->ratio_limit_hit_func( tor, tor->ratio_limit_hit_func_user_data );
455    }
456    /* if we're seeding and reach our inactiviy limit, stop the torrent */
457    else if( tr_torrentIsSeedIdleLimitDone( tor ) )
458    {
459        tr_torinf( tor, "Seeding idle limit reached; pausing torrent" );
460
461        tor->isStopping = true;
462        tor->finishedSeedingByIdle = true;
463
464        /* maybe notify the client */
465        if( tor->idle_limit_hit_func != NULL )
466            tor->idle_limit_hit_func( tor, tor->idle_limit_hit_func_user_data );
467    }
468}
469
470/***
471****
472***/
473
474void
475tr_torrentSetLocalError( tr_torrent * tor, const char * fmt, ... )
476{
477    va_list ap;
478
479    assert( tr_isTorrent( tor ) );
480
481    va_start( ap, fmt );
482    tor->error = TR_STAT_LOCAL_ERROR;
483    tor->errorTracker[0] = '\0';
484    evutil_vsnprintf( tor->errorString, sizeof( tor->errorString ), fmt, ap );
485    va_end( ap );
486
487    tr_torerr( tor, "%s", tor->errorString );
488
489    if( tor->isRunning )
490        tor->isStopping = true;
491}
492
493static void
494tr_torrentClearError( tr_torrent * tor )
495{
496    tor->error = TR_STAT_OK;
497    tor->errorString[0] = '\0';
498    tor->errorTracker[0] = '\0';
499}
500
501static void
502onTrackerResponse( tr_torrent * tor, const tr_tracker_event * event, void * unused UNUSED )
503{
504    switch( event->messageType )
505    {
506        case TR_TRACKER_PEERS:
507        {
508            size_t i;
509            const int8_t seedProbability = event->seedProbability;
510            const bool allAreSeeds = seedProbability == 100;
511
512             if( allAreSeeds )
513                tr_tordbg( tor, "Got %zu seeds from tracker", event->pexCount );
514            else
515                tr_tordbg( tor, "Got %zu peers from tracker", event->pexCount );
516
517            for( i = 0; i < event->pexCount; ++i )
518                tr_peerMgrAddPex( tor, TR_PEER_FROM_TRACKER, &event->pex[i], seedProbability );
519
520            break;
521        }
522
523        case TR_TRACKER_WARNING:
524            tr_torerr( tor, _( "Tracker warning: \"%s\"" ), event->text );
525            tor->error = TR_STAT_TRACKER_WARNING;
526            tr_strlcpy( tor->errorTracker, event->tracker, sizeof( tor->errorTracker ) );
527            tr_strlcpy( tor->errorString, event->text, sizeof( tor->errorString ) );
528            break;
529
530        case TR_TRACKER_ERROR:
531            tr_torerr( tor, _( "Tracker error: \"%s\"" ), event->text );
532            tor->error = TR_STAT_TRACKER_ERROR;
533            tr_strlcpy( tor->errorTracker, event->tracker, sizeof( tor->errorTracker ) );
534            tr_strlcpy( tor->errorString, event->text, sizeof( tor->errorString ) );
535            break;
536
537        case TR_TRACKER_ERROR_CLEAR:
538            if( tor->error != TR_STAT_LOCAL_ERROR )
539                tr_torrentClearError( tor );
540            break;
541    }
542}
543
544/***
545****
546****  TORRENT INSTANTIATION
547****
548***/
549
550static tr_piece_index_t
551getBytePiece( const tr_info * info, uint64_t byteOffset )
552{
553    assert( info );
554    assert( info->pieceSize != 0 );
555
556    return byteOffset / info->pieceSize;
557}
558
559static void
560initFilePieces( tr_info *       info,
561                tr_file_index_t fileIndex )
562{
563    tr_file * file;
564    uint64_t  firstByte, lastByte;
565
566    assert( info );
567    assert( fileIndex < info->fileCount );
568
569    file = &info->files[fileIndex];
570    firstByte = file->offset;
571    lastByte = firstByte + ( file->length ? file->length - 1 : 0 );
572    file->firstPiece = getBytePiece( info, firstByte );
573    file->lastPiece = getBytePiece( info, lastByte );
574}
575
576static int
577pieceHasFile( tr_piece_index_t piece,
578              const tr_file *  file )
579{
580    return ( file->firstPiece <= piece ) && ( piece <= file->lastPiece );
581}
582
583static tr_priority_t
584calculatePiecePriority( const tr_torrent * tor,
585                        tr_piece_index_t   piece,
586                        int                fileHint )
587{
588    tr_file_index_t i;
589    tr_priority_t priority = TR_PRI_LOW;
590
591    /* find the first file that has data in this piece */
592    if( fileHint >= 0 ) {
593        i = fileHint;
594        while( i > 0 && pieceHasFile( piece, &tor->info.files[i - 1] ) )
595            --i;
596    } else {
597        for( i = 0; i < tor->info.fileCount; ++i )
598            if( pieceHasFile( piece, &tor->info.files[i] ) )
599                break;
600    }
601
602    /* the piece's priority is the max of the priorities
603     * of all the files in that piece */
604    for( ; i < tor->info.fileCount; ++i )
605    {
606        const tr_file * file = &tor->info.files[i];
607
608        if( !pieceHasFile( piece, file ) )
609            break;
610
611        priority = MAX( priority, file->priority );
612
613        /* when dealing with multimedia files, getting the first and
614           last pieces can sometimes allow you to preview it a bit
615           before it's fully downloaded... */
616        if( file->priority >= TR_PRI_NORMAL )
617            if( file->firstPiece == piece || file->lastPiece == piece )
618                priority = TR_PRI_HIGH;
619    }
620
621    return priority;
622}
623
624static void
625tr_torrentInitFilePieces( tr_torrent * tor )
626{
627    int * firstFiles;
628    tr_file_index_t f;
629    tr_piece_index_t p;
630    uint64_t offset = 0;
631    tr_info * inf = &tor->info;
632
633    /* assign the file offsets */
634    for( f=0; f<inf->fileCount; ++f ) {
635        inf->files[f].offset = offset;
636        offset += inf->files[f].length;
637        initFilePieces( inf, f );
638    }
639
640    /* build the array of first-file hints to give calculatePiecePriority */
641    firstFiles = tr_new( int, inf->pieceCount );
642    for( p=f=0; p<inf->pieceCount; ++p ) {
643        while( inf->files[f].lastPiece < p )
644            ++f;
645        firstFiles[p] = f;
646    }
647
648#if 0
649    /* test to confirm the first-file hints are correct */
650    for( p=0; p<inf->pieceCount; ++p ) {
651        f = firstFiles[p];
652        assert( inf->files[f].firstPiece <= p );
653        assert( inf->files[f].lastPiece >= p );
654        if( f > 0 )
655            assert( inf->files[f-1].lastPiece < p );
656        for( f=0; f<inf->fileCount; ++f )
657            if( pieceHasFile( p, &inf->files[f] ) )
658                break;
659        assert( (int)f == firstFiles[p] );
660    }
661#endif
662
663    for( p=0; p<inf->pieceCount; ++p )
664        inf->pieces[p].priority = calculatePiecePriority( tor, p, firstFiles[p] );
665
666    tr_free( firstFiles );
667}
668
669static void torrentStart( tr_torrent * tor, bool bypass_queue );
670
671/**
672 * Decide on a block size. Constraints:
673 * (1) most clients decline requests over 16 KiB
674 * (2) pieceSize must be a multiple of block size
675 */
676uint32_t
677tr_getBlockSize( uint32_t pieceSize )
678{
679    uint32_t b = pieceSize;
680
681    while( b > MAX_BLOCK_SIZE )
682        b /= 2u;
683
684    if( !b || ( pieceSize % b ) ) /* not cleanly divisible */
685        return 0;
686    return b;
687}
688
689static void refreshCurrentDir( tr_torrent * tor );
690
691static void
692torrentInitFromInfo( tr_torrent * tor )
693{
694    uint64_t t;
695    tr_info * info = &tor->info;
696
697    tor->blockSize = tr_getBlockSize( info->pieceSize );
698
699    if( info->pieceSize )
700        tor->lastPieceSize = (uint32_t)(info->totalSize % info->pieceSize);
701
702    if( !tor->lastPieceSize )
703        tor->lastPieceSize = info->pieceSize;
704
705    if( tor->blockSize )
706        tor->lastBlockSize = info->totalSize % tor->blockSize;
707
708    if( !tor->lastBlockSize )
709        tor->lastBlockSize = tor->blockSize;
710
711    tor->blockCount = tor->blockSize
712        ? ( info->totalSize + tor->blockSize - 1 ) / tor->blockSize
713        : 0;
714
715    tor->blockCountInPiece = tor->blockSize
716        ? info->pieceSize / tor->blockSize
717        : 0;
718
719    tor->blockCountInLastPiece = tor->blockSize
720        ? ( tor->lastPieceSize + tor->blockSize - 1 ) / tor->blockSize
721        : 0;
722
723    /* check our work */
724    if( tor->blockSize != 0 )
725        assert( ( info->pieceSize % tor->blockSize ) == 0 );
726    t = info->pieceCount - 1;
727    t *= info->pieceSize;
728    t += tor->lastPieceSize;
729    assert( t == info->totalSize );
730    t = tor->blockCount - 1;
731    t *= tor->blockSize;
732    t += tor->lastBlockSize;
733    assert( t == info->totalSize );
734    t = info->pieceCount - 1;
735    t *= tor->blockCountInPiece;
736    t += tor->blockCountInLastPiece;
737    assert( t == (uint64_t)tor->blockCount );
738
739    tr_cpConstruct( &tor->completion, tor );
740
741    tr_torrentInitFilePieces( tor );
742
743    tor->completeness = tr_cpGetStatus( &tor->completion );
744}
745
746static void tr_torrentFireMetadataCompleted( tr_torrent * tor );
747
748void
749tr_torrentGotNewInfoDict( tr_torrent * tor )
750{
751    torrentInitFromInfo( tor );
752
753    tr_peerMgrOnTorrentGotMetainfo( tor );
754
755    tr_torrentFireMetadataCompleted( tor );
756}
757
758static bool
759hasAnyLocalData( const tr_torrent * tor )
760{
761    tr_file_index_t i;
762
763    for( i=0; i<tor->info.fileCount; ++i )
764        if( tr_torrentFindFile2( tor, i, NULL, NULL, NULL ) )
765            return true;
766
767    return false;
768}
769
770static bool
771setLocalErrorIfFilesDisappeared( tr_torrent * tor )
772{
773    const bool disappeared = ( tr_cpHaveTotal( &tor->completion ) > 0 ) && !hasAnyLocalData( tor );
774
775    if( disappeared )
776    {
777        tr_deeplog_tor( tor, "%s", "[LAZY] uh oh, the files disappeared" );
778        tr_torrentSetLocalError( tor, "%s", _( "No data found! Ensure your drives are connected or use \"Set Location\". To re-download, remove the torrent and re-add it." ) );
779    }
780
781    return disappeared;
782}
783
784static void
785torrentInit( tr_torrent * tor, const tr_ctor * ctor )
786{
787    int doStart;
788    uint64_t loaded;
789    const char * dir;
790    bool isNewTorrent;
791    struct stat st;
792    static int nextUniqueId = 1;
793    tr_session * session = tr_ctorGetSession( ctor );
794
795    assert( session != NULL );
796
797    tr_sessionLock( session );
798
799    tor->session   = session;
800    tor->uniqueId = nextUniqueId++;
801    tor->magicNumber = TORRENT_MAGIC_NUMBER;
802    tor->queuePosition = session->torrentCount;
803
804    tr_peerIdInit( tor->peer_id );
805
806    tr_sha1( tor->obfuscatedHash, "req2", 4,
807             tor->info.hash, SHA_DIGEST_LENGTH,
808             NULL );
809
810    if( !tr_ctorGetDownloadDir( ctor, TR_FORCE, &dir ) ||
811        !tr_ctorGetDownloadDir( ctor, TR_FALLBACK, &dir ) )
812            tor->downloadDir = tr_strdup( dir );
813
814    if( tr_ctorGetIncompleteDir( ctor, &dir ) )
815        dir = tr_sessionGetIncompleteDir( session );
816    if( tr_sessionIsIncompleteDirEnabled( session ) )
817        tor->incompleteDir = tr_strdup( dir );
818
819    tr_bandwidthConstruct( &tor->bandwidth, session, &session->bandwidth );
820
821    tor->bandwidth.priority = tr_ctorGetBandwidthPriority( ctor );
822
823    tor->error = TR_STAT_OK;
824
825    tor->finishedSeedingByIdle = false;
826
827    tr_peerMgrAddTorrent( session->peerMgr, tor );
828
829    assert( !tor->downloadedCur );
830    assert( !tor->uploadedCur );
831
832    tr_torrentSetAddedDate( tor, tr_time( ) ); /* this is a default value to be
833                                                  overwritten by the resume file */
834
835    torrentInitFromInfo( tor );
836    loaded = tr_torrentLoadResume( tor, ~0, ctor );
837    tor->completeness = tr_cpGetStatus( &tor->completion );
838    setLocalErrorIfFilesDisappeared( tor );
839
840    tr_ctorInitTorrentPriorities( ctor, tor );
841    tr_ctorInitTorrentWanted( ctor, tor );
842
843    refreshCurrentDir( tor );
844
845    doStart = tor->isRunning;
846    tor->isRunning = 0;
847
848    if( !( loaded & TR_FR_SPEEDLIMIT ) )
849    {
850        tr_torrentUseSpeedLimit( tor, TR_UP, false );
851        tr_torrentSetSpeedLimit_Bps( tor, TR_UP, tr_sessionGetSpeedLimit_Bps( tor->session, TR_UP ) );
852        tr_torrentUseSpeedLimit( tor, TR_DOWN, false );
853        tr_torrentSetSpeedLimit_Bps( tor, TR_DOWN, tr_sessionGetSpeedLimit_Bps( tor->session, TR_DOWN ) );
854        tr_torrentUseSessionLimits( tor, true );
855    }
856
857    if( !( loaded & TR_FR_RATIOLIMIT ) )
858    {
859        tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_GLOBAL );
860        tr_torrentSetRatioLimit( tor, tr_sessionGetRatioLimit( tor->session ) );
861    }
862
863    if( !( loaded & TR_FR_IDLELIMIT ) )
864    {
865        tr_torrentSetIdleMode( tor, TR_IDLELIMIT_GLOBAL );
866        tr_torrentSetIdleLimit( tor, tr_sessionGetIdleLimit( tor->session ) );
867    }
868
869    /* add the torrent to tr_session.torrentList */
870    session->torrentCount++;
871    if( session->torrentList == NULL )
872        session->torrentList = tor;
873    else {
874        tr_torrent * it = session->torrentList;
875        while( it->next != NULL )
876            it = it->next;
877        it->next = tor;
878    }
879
880    /* if we don't have a local .torrent file already, assume the torrent is new */
881    isNewTorrent = stat( tor->info.torrent, &st );
882
883    /* maybe save our own copy of the metainfo */
884    if( tr_ctorGetSave( ctor ) )
885    {
886        const tr_benc * val;
887        if( !tr_ctorGetMetainfo( ctor, &val ) )
888        {
889            const char * path = tor->info.torrent;
890            const int err = tr_bencToFile( val, TR_FMT_BENC, path );
891            if( err )
892                tr_torrentSetLocalError( tor, "Unable to save torrent file: %s", tr_strerror( err ) );
893            tr_sessionSetTorrentFile( tor->session, tor->info.hashString, path );
894        }
895    }
896
897    tor->tiers = tr_announcerAddTorrent( tor, onTrackerResponse, NULL );
898
899    if( isNewTorrent )
900    {
901        tor->startAfterVerify = doStart;
902        tr_torrentVerify( tor );
903    }
904    else if( doStart )
905    {
906        tr_torrentStart( tor );
907    }
908
909    tr_sessionUnlock( session );
910}
911
912static tr_parse_result
913torrentParseImpl( const tr_ctor * ctor, tr_info * setmeInfo,
914                  bool * setmeHasInfo, int * dictLength )
915{
916    int             doFree;
917    bool            didParse;
918    bool            hasInfo = false;
919    tr_info         tmp;
920    const tr_benc * metainfo;
921    tr_session    * session = tr_ctorGetSession( ctor );
922    tr_parse_result result = TR_PARSE_OK;
923
924    if( setmeInfo == NULL )
925        setmeInfo = &tmp;
926    memset( setmeInfo, 0, sizeof( tr_info ) );
927
928    if( tr_ctorGetMetainfo( ctor, &metainfo ) )
929        return TR_PARSE_ERR;
930
931    didParse = tr_metainfoParse( session, metainfo, setmeInfo,
932                                 &hasInfo, dictLength );
933    doFree = didParse && ( setmeInfo == &tmp );
934
935    if( !didParse )
936        result = TR_PARSE_ERR;
937
938    if( didParse && hasInfo && !tr_getBlockSize( setmeInfo->pieceSize ) )
939        result = TR_PARSE_ERR;
940
941    if( didParse && session && tr_torrentExists( session, setmeInfo->hash ) )
942        result = TR_PARSE_DUPLICATE;
943
944    if( doFree )
945        tr_metainfoFree( setmeInfo );
946
947    if( setmeHasInfo != NULL )
948        *setmeHasInfo = hasInfo;
949
950    return result;
951}
952
953tr_parse_result
954tr_torrentParse( const tr_ctor * ctor, tr_info * setmeInfo )
955{
956    return torrentParseImpl( ctor, setmeInfo, NULL, NULL );
957}
958
959tr_torrent *
960tr_torrentNew( const tr_ctor * ctor, int * setmeError )
961{
962    int len;
963    bool hasInfo;
964    tr_info tmpInfo;
965    tr_parse_result r;
966    tr_torrent * tor = NULL;
967
968    assert( ctor != NULL );
969    assert( tr_isSession( tr_ctorGetSession( ctor ) ) );
970
971    r = torrentParseImpl( ctor, &tmpInfo, &hasInfo, &len );
972    if( r == TR_PARSE_OK )
973    {
974        tor = tr_new0( tr_torrent, 1 );
975        tor->info = tmpInfo;
976        if( hasInfo )
977            tor->infoDictLength = len;
978        torrentInit( tor, ctor );
979    }
980    else
981    {
982        if( r == TR_PARSE_DUPLICATE )
983            tr_metainfoFree( &tmpInfo );
984
985        if( setmeError )
986            *setmeError = r;
987    }
988
989    return tor;
990}
991
992/**
993***
994**/
995
996void
997tr_torrentSetDownloadDir( tr_torrent * tor, const char * path )
998{
999    assert( tr_isTorrent( tor  ) );
1000
1001    if( !path || !tor->downloadDir || strcmp( path, tor->downloadDir ) )
1002    {
1003        tr_free( tor->downloadDir );
1004        tor->downloadDir = tr_strdup( path );
1005        tr_torrentSetDirty( tor );
1006    }
1007
1008    refreshCurrentDir( tor );
1009}
1010
1011const char*
1012tr_torrentGetDownloadDir( const tr_torrent * tor )
1013{
1014    assert( tr_isTorrent( tor  ) );
1015
1016    return tor->downloadDir;
1017}
1018
1019const char *
1020tr_torrentGetCurrentDir( const tr_torrent * tor )
1021{
1022    assert( tr_isTorrent( tor  ) );
1023
1024    return tor->currentDir;
1025}
1026
1027
1028void
1029tr_torrentChangeMyPort( tr_torrent * tor )
1030{
1031    assert( tr_isTorrent( tor  ) );
1032
1033    if( tor->isRunning )
1034        tr_announcerChangeMyPort( tor );
1035}
1036
1037static inline void
1038tr_torrentManualUpdateImpl( void * vtor )
1039{
1040    tr_torrent * tor = vtor;
1041
1042    assert( tr_isTorrent( tor  ) );
1043
1044    if( tor->isRunning )
1045        tr_announcerManualAnnounce( tor );
1046}
1047
1048void
1049tr_torrentManualUpdate( tr_torrent * tor )
1050{
1051    assert( tr_isTorrent( tor  ) );
1052
1053    tr_runInEventThread( tor->session, tr_torrentManualUpdateImpl, tor );
1054}
1055
1056bool
1057tr_torrentCanManualUpdate( const tr_torrent * tor )
1058{
1059    return ( tr_isTorrent( tor  ) )
1060        && ( tor->isRunning )
1061        && ( tr_announcerCanManualAnnounce( tor ) );
1062}
1063
1064const tr_info *
1065tr_torrentInfo( const tr_torrent * tor )
1066{
1067    return tr_isTorrent( tor ) ? &tor->info : NULL;
1068}
1069
1070const tr_stat *
1071tr_torrentStatCached( tr_torrent * tor )
1072{
1073    const time_t now = tr_time( );
1074
1075    return tr_isTorrent( tor ) && ( now == tor->lastStatTime )
1076         ? &tor->stats
1077         : tr_torrentStat( tor );
1078}
1079
1080void
1081tr_torrentSetVerifyState( tr_torrent * tor, tr_verify_state state )
1082{
1083    assert( tr_isTorrent( tor ) );
1084    assert( state==TR_VERIFY_NONE || state==TR_VERIFY_WAIT || state==TR_VERIFY_NOW );
1085
1086    tor->verifyState = state;
1087    tor->anyDate = tr_time( );
1088}
1089
1090static tr_torrent_activity
1091torrentGetActivity( const tr_torrent * tor )
1092{
1093    const bool is_seed = tr_torrentIsSeed( tor );
1094    assert( tr_isTorrent( tor ) );
1095
1096    if( tor->verifyState == TR_VERIFY_NOW )
1097        return TR_STATUS_CHECK;
1098
1099    if( tor->verifyState == TR_VERIFY_WAIT )
1100        return TR_STATUS_CHECK_WAIT;
1101
1102    if( tor->isRunning )
1103        return is_seed ? TR_STATUS_SEED : TR_STATUS_DOWNLOAD;
1104
1105    if( tr_torrentIsQueued( tor ) ) {
1106        if( is_seed && tr_sessionGetQueueEnabled( tor->session, TR_UP ) )
1107            return TR_STATUS_SEED_WAIT;
1108        if( !is_seed && tr_sessionGetQueueEnabled( tor->session, TR_DOWN ) )
1109            return TR_STATUS_DOWNLOAD_WAIT;
1110    }
1111
1112    return TR_STATUS_STOPPED;
1113}
1114
1115tr_torrent_activity
1116tr_torrentGetActivity( tr_torrent * tor )
1117{
1118    /* FIXME: is this call still needed? */
1119    tr_torrentRecheckCompleteness( tor );
1120
1121    return torrentGetActivity( tor );
1122}
1123
1124static time_t
1125torrentGetIdleSecs( const tr_torrent * tor )
1126{
1127    int idle_secs;
1128    const tr_torrent_activity activity = torrentGetActivity( tor );
1129
1130    if ((activity == TR_STATUS_DOWNLOAD || activity == TR_STATUS_SEED) && tor->startDate != 0)
1131        idle_secs = difftime(tr_time(), MAX(tor->startDate, tor->activityDate));
1132    else
1133        idle_secs = -1;
1134
1135    return idle_secs;
1136}
1137
1138bool
1139tr_torrentIsStalled( const tr_torrent * tor )
1140{
1141    return tr_sessionGetQueueStalledEnabled( tor->session )
1142        && ( torrentGetIdleSecs( tor ) > ( tr_sessionGetQueueStalledMinutes( tor->session ) * 60 ) );
1143}
1144
1145
1146static double
1147getVerifyProgress( const tr_torrent * tor )
1148{
1149    tr_piece_index_t i, n;
1150    tr_piece_index_t checked = 0;
1151
1152    assert( tr_isTorrent( tor ) );
1153
1154    for( i=0, n=tor->info.pieceCount; i!=n; ++i )
1155        if( tor->info.pieces[i].timeChecked )
1156            ++checked;
1157
1158    return checked / (double)tor->info.pieceCount;
1159}
1160
1161const tr_stat *
1162tr_torrentStat( tr_torrent * tor )
1163{
1164    tr_stat *               s;
1165    uint64_t                now;
1166    uint64_t                seedRatioBytesLeft;
1167    uint64_t                seedRatioBytesGoal;
1168    bool                    seedRatioApplies;
1169    uint16_t                seedIdleMinutes;
1170
1171    if( !tor )
1172        return NULL;
1173
1174    assert( tr_isTorrent( tor ) );
1175    tr_torrentLock( tor );
1176
1177    tor->lastStatTime = tr_time( );
1178
1179    s = &tor->stats;
1180    s->id = tor->uniqueId;
1181    s->activity = tr_torrentGetActivity( tor );
1182    s->error = tor->error;
1183    s->queuePosition = tor->queuePosition;
1184    s->isStalled = tr_torrentIsStalled( tor );
1185    tr_strlcpy( s->errorString, tor->errorString, sizeof( s->errorString ) );
1186
1187    s->manualAnnounceTime = tr_announcerNextManualAnnounce( tor );
1188
1189    tr_peerMgrTorrentStats( tor,
1190                            &s->peersConnected,
1191                            &s->webseedsSendingToUs,
1192                            &s->peersSendingToUs,
1193                            &s->peersGettingFromUs,
1194                            s->peersFrom );
1195
1196    now = tr_time_msec( );
1197    s->rawUploadSpeed_KBps     = toSpeedKBps( tr_bandwidthGetRawSpeed_Bps  ( &tor->bandwidth, now, TR_UP ) );
1198    s->pieceUploadSpeed_KBps   = toSpeedKBps( tr_bandwidthGetPieceSpeed_Bps( &tor->bandwidth, now, TR_UP ) );
1199    s->rawDownloadSpeed_KBps   = toSpeedKBps( tr_bandwidthGetRawSpeed_Bps  ( &tor->bandwidth, now, TR_DOWN ) );
1200    s->pieceDownloadSpeed_KBps = toSpeedKBps( tr_bandwidthGetPieceSpeed_Bps( &tor->bandwidth, now, TR_DOWN ) );
1201
1202    s->percentComplete = tr_cpPercentComplete ( &tor->completion );
1203    s->metadataPercentComplete = tr_torrentGetMetadataPercent( tor );
1204
1205    s->percentDone         = tr_cpPercentDone  ( &tor->completion );
1206    s->leftUntilDone       = tr_cpLeftUntilDone( &tor->completion );
1207    s->sizeWhenDone        = tr_cpSizeWhenDone ( &tor->completion );
1208    s->recheckProgress     = s->activity == TR_STATUS_CHECK ? getVerifyProgress( tor ) : 0;
1209    s->activityDate        = tor->activityDate;
1210    s->addedDate           = tor->addedDate;
1211    s->doneDate            = tor->doneDate;
1212    s->startDate           = tor->startDate;
1213    s->secondsSeeding      = tor->secondsSeeding;
1214    s->secondsDownloading  = tor->secondsDownloading;
1215    s->idleSecs            = torrentGetIdleSecs( tor );
1216
1217    s->corruptEver      = tor->corruptCur    + tor->corruptPrev;
1218    s->downloadedEver   = tor->downloadedCur + tor->downloadedPrev;
1219    s->uploadedEver     = tor->uploadedCur   + tor->uploadedPrev;
1220    s->haveValid        = tr_cpHaveValid( &tor->completion );
1221    s->haveUnchecked    = tr_cpHaveTotal( &tor->completion ) - s->haveValid;
1222    s->desiredAvailable = tr_peerMgrGetDesiredAvailable( tor );
1223
1224    s->ratio = tr_getRatio( s->uploadedEver,
1225                            s->downloadedEver ? s->downloadedEver : s->haveValid );
1226
1227    seedRatioApplies = tr_torrentGetSeedRatioBytes( tor, &seedRatioBytesLeft,
1228                                                         &seedRatioBytesGoal );
1229
1230    switch( s->activity )
1231    {
1232        /* etaXLSpeed exists because if we use the piece speed directly,
1233         * brief fluctuations cause the ETA to jump all over the place.
1234         * so, etaXLSpeed is a smoothed-out version of the piece speed
1235         * to dampen the effect of fluctuations */
1236
1237        case TR_STATUS_DOWNLOAD:
1238            if( ( tor->etaDLSpeedCalculatedAt + 800 ) < now ) {
1239                tor->etaDLSpeed_KBps = ( ( tor->etaDLSpeedCalculatedAt + 4000 ) < now )
1240                    ? s->pieceDownloadSpeed_KBps /* if no recent previous speed, no need to smooth */
1241                    : ((tor->etaDLSpeed_KBps*4.0) + s->pieceDownloadSpeed_KBps)/5.0; /* smooth across 5 readings */
1242                tor->etaDLSpeedCalculatedAt = now;
1243            }
1244
1245            if( s->leftUntilDone > s->desiredAvailable )
1246                s->eta = TR_ETA_NOT_AVAIL;
1247            else if( tor->etaDLSpeed_KBps < 1 )
1248                s->eta = TR_ETA_UNKNOWN;
1249            else
1250                s->eta = s->leftUntilDone / toSpeedBytes(tor->etaDLSpeed_KBps);
1251
1252            s->etaIdle = TR_ETA_NOT_AVAIL;
1253            break;
1254
1255        case TR_STATUS_SEED: {
1256            if( !seedRatioApplies )
1257                s->eta = TR_ETA_NOT_AVAIL;
1258            else {
1259                if( ( tor->etaULSpeedCalculatedAt + 800 ) < now ) {
1260                    tor->etaULSpeed_KBps = ( ( tor->etaULSpeedCalculatedAt + 4000 ) < now )
1261                        ? s->pieceUploadSpeed_KBps /* if no recent previous speed, no need to smooth */
1262                        : ((tor->etaULSpeed_KBps*4.0) + s->pieceUploadSpeed_KBps)/5.0; /* smooth across 5 readings */
1263                    tor->etaULSpeedCalculatedAt = now;
1264                }
1265                if( tor->etaULSpeed_KBps < 1 )
1266                    s->eta = TR_ETA_UNKNOWN;
1267                else
1268                    s->eta = seedRatioBytesLeft / toSpeedBytes(tor->etaULSpeed_KBps);
1269            }
1270
1271            if( tor->etaULSpeed_KBps < 1 && tr_torrentGetSeedIdle( tor, &seedIdleMinutes ) )
1272                s->etaIdle = seedIdleMinutes * 60 - s->idleSecs;
1273            else
1274                s->etaIdle = TR_ETA_NOT_AVAIL;
1275            break;
1276        }
1277
1278        default:
1279            s->eta = TR_ETA_NOT_AVAIL;
1280            s->etaIdle = TR_ETA_NOT_AVAIL;
1281            break;
1282    }
1283
1284    /* s->haveValid is here to make sure a torrent isn't marked 'finished'
1285     * when the user hits "uncheck all" prior to starting the torrent... */
1286    s->finished = tor->finishedSeedingByIdle || (seedRatioApplies && !seedRatioBytesLeft && s->haveValid);
1287
1288    if( !seedRatioApplies || s->finished )
1289        s->seedRatioPercentDone = 1;
1290    else if( !seedRatioBytesGoal ) /* impossible? safeguard for div by zero */
1291        s->seedRatioPercentDone = 0;
1292    else
1293        s->seedRatioPercentDone = (double)(seedRatioBytesGoal - seedRatioBytesLeft) / seedRatioBytesGoal;
1294
1295    tr_torrentUnlock( tor );
1296
1297    /* test some of the constraints */
1298    assert( s->sizeWhenDone <= tor->info.totalSize );
1299    assert( s->leftUntilDone <= s->sizeWhenDone );
1300    assert( s->desiredAvailable <= s->leftUntilDone );
1301    return s;
1302}
1303
1304/***
1305****
1306***/
1307
1308static uint64_t
1309fileBytesCompleted( const tr_torrent * tor, tr_file_index_t index )
1310{
1311    uint64_t total = 0;
1312    const tr_file * f = &tor->info.files[index];
1313
1314    if( f->length )
1315    {
1316        tr_block_index_t first;
1317        tr_block_index_t last;
1318        tr_torGetFileBlockRange( tor, index, &first, &last );
1319
1320        if( first == last )
1321        {
1322            if( tr_cpBlockIsComplete( &tor->completion, first ) )
1323                total = f->length;
1324        }
1325        else
1326        {
1327            /* the first block */
1328            if( tr_cpBlockIsComplete( &tor->completion, first ) )
1329                total += tor->blockSize - ( f->offset % tor->blockSize );
1330
1331            /* the middle blocks */
1332            if( first + 1 < last ) {
1333                uint64_t u = tr_bitfieldCountRange( &tor->completion.blockBitfield, first+1, last );
1334                u *= tor->blockSize;
1335                total += u;
1336            }
1337
1338            /* the last block */
1339            if( tr_cpBlockIsComplete( &tor->completion, last ) )
1340                total += ( f->offset + f->length ) - ( (uint64_t)tor->blockSize * last );
1341        }
1342    }
1343
1344    return total;
1345}
1346
1347tr_file_stat *
1348tr_torrentFiles( const tr_torrent * tor,
1349                 tr_file_index_t *  fileCount )
1350{
1351    tr_file_index_t       i;
1352    const tr_file_index_t n = tor->info.fileCount;
1353    tr_file_stat *        files = tr_new0( tr_file_stat, n );
1354    tr_file_stat *        walk = files;
1355    const bool            isSeed = tor->completeness == TR_SEED;
1356
1357    assert( tr_isTorrent( tor ) );
1358
1359    for( i=0; i<n; ++i, ++walk ) {
1360        const uint64_t b = isSeed ? tor->info.files[i].length : fileBytesCompleted( tor, i );
1361        walk->bytesCompleted = b;
1362        walk->progress = tor->info.files[i].length > 0 ? ( (float)b / tor->info.files[i].length ) : 1.0f;
1363    }
1364
1365    if( fileCount )
1366        *fileCount = n;
1367
1368    return files;
1369}
1370
1371void
1372tr_torrentFilesFree( tr_file_stat *            files,
1373                     tr_file_index_t fileCount UNUSED )
1374{
1375    tr_free( files );
1376}
1377
1378/***
1379****
1380***/
1381
1382double*
1383tr_torrentWebSpeeds_KBps( const tr_torrent * tor )
1384{
1385    double * ret = NULL;
1386
1387    if( tr_isTorrent( tor ) )
1388    {
1389        tr_torrentLock( tor );
1390        ret = tr_peerMgrWebSpeeds_KBps( tor );
1391        tr_torrentUnlock( tor );
1392    }
1393
1394    return ret;
1395}
1396
1397tr_peer_stat *
1398tr_torrentPeers( const tr_torrent * tor, int * peerCount )
1399{
1400    tr_peer_stat * ret = NULL;
1401
1402    if( tr_isTorrent( tor ) )
1403    {
1404        tr_torrentLock( tor );
1405        ret = tr_peerMgrPeerStats( tor, peerCount );
1406        tr_torrentUnlock( tor );
1407    }
1408
1409    return ret;
1410}
1411
1412void
1413tr_torrentPeersFree( tr_peer_stat * peers, int peerCount UNUSED )
1414{
1415    tr_free( peers );
1416}
1417
1418tr_tracker_stat *
1419tr_torrentTrackers( const tr_torrent * torrent, int * setmeTrackerCount )
1420{
1421    tr_tracker_stat * ret = NULL;
1422
1423    if( tr_isTorrent( torrent ) )
1424    {
1425        tr_torrentLock( torrent );
1426        ret = tr_announcerStats( torrent, setmeTrackerCount );
1427        tr_torrentUnlock( torrent );
1428    }
1429
1430    return ret;
1431}
1432
1433void
1434tr_torrentTrackersFree( tr_tracker_stat * trackers, int trackerCount )
1435{
1436    tr_announcerStatsFree( trackers, trackerCount );
1437}
1438
1439void
1440tr_torrentAvailability( const tr_torrent * tor, int8_t * tab, int size )
1441{
1442    if( tr_isTorrent( tor ) && ( tab != NULL ) && ( size > 0 ) )
1443    {
1444        tr_torrentLock( tor );
1445        tr_peerMgrTorrentAvailability( tor, tab, size );
1446        tr_torrentUnlock( tor );
1447    }
1448}
1449
1450void
1451tr_torrentAmountFinished( const tr_torrent * tor,
1452                          float *            tab,
1453                          int                size )
1454{
1455    assert( tr_isTorrent( tor ) );
1456
1457    tr_torrentLock( tor );
1458    tr_cpGetAmountDone( &tor->completion, tab, size );
1459    tr_torrentUnlock( tor );
1460}
1461
1462static void
1463tr_torrentResetTransferStats( tr_torrent * tor )
1464{
1465    tr_torrentLock( tor );
1466
1467    tor->downloadedPrev += tor->downloadedCur;
1468    tor->downloadedCur   = 0;
1469    tor->uploadedPrev   += tor->uploadedCur;
1470    tor->uploadedCur     = 0;
1471    tor->corruptPrev    += tor->corruptCur;
1472    tor->corruptCur      = 0;
1473
1474    tr_torrentSetDirty( tor );
1475
1476    tr_torrentUnlock( tor );
1477}
1478
1479void
1480tr_torrentSetHasPiece( tr_torrent *     tor,
1481                       tr_piece_index_t pieceIndex,
1482                       bool             has )
1483{
1484    assert( tr_isTorrent( tor ) );
1485    assert( pieceIndex < tor->info.pieceCount );
1486
1487    if( has )
1488        tr_cpPieceAdd( &tor->completion, pieceIndex );
1489    else
1490        tr_cpPieceRem( &tor->completion, pieceIndex );
1491}
1492
1493/***
1494****
1495***/
1496
1497#ifndef NDEBUG
1498static bool queueIsSequenced( tr_session * );
1499#endif
1500
1501static void
1502freeTorrent( tr_torrent * tor )
1503{
1504    tr_torrent * t;
1505    tr_session *  session = tor->session;
1506    tr_info *    inf = &tor->info;
1507    const time_t now = tr_time( );
1508
1509    assert( !tor->isRunning );
1510
1511    tr_sessionLock( session );
1512
1513    tr_peerMgrRemoveTorrent( tor );
1514
1515    tr_announcerRemoveTorrent( session->announcer, tor );
1516
1517    tr_cpDestruct( &tor->completion );
1518
1519    tr_free( tor->downloadDir );
1520    tr_free( tor->incompleteDir );
1521
1522    if( tor == session->torrentList )
1523        session->torrentList = tor->next;
1524    else for( t = session->torrentList; t != NULL; t = t->next ) {
1525        if( t->next == tor ) {
1526            t->next = tor->next;
1527            break;
1528        }
1529    }
1530
1531    /* decrement the torrent count */
1532    assert( session->torrentCount >= 1 );
1533    session->torrentCount--;
1534
1535    /* resequence the queue positions */
1536    t = NULL;
1537    while(( t = tr_torrentNext( session, t ))) {
1538        if( t->queuePosition > tor->queuePosition ) {
1539            t->queuePosition--;
1540            t->anyDate = now;
1541        }
1542    }
1543    assert( queueIsSequenced( session ) );
1544
1545    tr_bandwidthDestruct( &tor->bandwidth );
1546
1547    tr_metainfoFree( inf );
1548    tr_free( tor );
1549
1550    tr_sessionUnlock( session );
1551}
1552
1553/**
1554***  Start/Stop Callback
1555**/
1556
1557static void torrentSetQueued( tr_torrent * tor, bool queued );
1558
1559static void
1560torrentStartImpl( void * vtor )
1561{
1562    time_t now;
1563    tr_torrent * tor = vtor;
1564
1565    assert( tr_isTorrent( tor ) );
1566
1567    tr_sessionLock( tor->session );
1568
1569    tr_torrentRecheckCompleteness( tor );
1570    torrentSetQueued( tor, false );
1571
1572    now = tr_time( );
1573    tor->isRunning = true;
1574    tor->completeness = tr_cpGetStatus( &tor->completion );
1575    tor->startDate = tor->anyDate = now;
1576    tr_torrentClearError( tor );
1577    tor->finishedSeedingByIdle = false;
1578
1579    tr_torrentResetTransferStats( tor );
1580    tr_announcerTorrentStarted( tor );
1581    tor->dhtAnnounceAt = now + tr_cryptoWeakRandInt( 20 );
1582    tor->dhtAnnounce6At = now + tr_cryptoWeakRandInt( 20 );
1583    tor->lpdAnnounceAt = now;
1584    tr_peerMgrStartTorrent( tor );
1585
1586    tr_sessionUnlock( tor->session );
1587}
1588
1589uint64_t
1590tr_torrentGetCurrentSizeOnDisk( const tr_torrent * tor )
1591{
1592    tr_file_index_t i;
1593    uint64_t byte_count = 0;
1594    const tr_file_index_t n = tor->info.fileCount;
1595
1596    for( i=0; i<n; ++i )
1597    {
1598        struct stat sb;
1599        char * filename = tr_torrentFindFile( tor, i );
1600
1601        sb.st_size = 0;
1602        if( filename && !stat( filename, &sb ) )
1603            byte_count += sb.st_size;
1604
1605        tr_free( filename );
1606    }
1607
1608    return byte_count;
1609}
1610
1611static bool
1612torrentShouldQueue( const tr_torrent * tor )
1613{
1614    const tr_direction dir = tr_torrentGetQueueDirection( tor );
1615
1616    return tr_sessionCountQueueFreeSlots( tor->session, dir ) == 0;
1617}
1618
1619static void
1620torrentStart( tr_torrent * tor, bool bypass_queue )
1621{
1622    switch( torrentGetActivity( tor ) )
1623    {
1624        case TR_STATUS_SEED:
1625        case TR_STATUS_DOWNLOAD:
1626            return; /* already started */
1627            break;
1628
1629        case TR_STATUS_SEED_WAIT:
1630        case TR_STATUS_DOWNLOAD_WAIT:
1631            if( !bypass_queue )
1632                return; /* already queued */
1633            break;
1634
1635        case TR_STATUS_CHECK:
1636        case TR_STATUS_CHECK_WAIT:
1637            /* verifying right now... wait until that's done so
1638             * we'll know what completeness to use/announce */
1639            tor->startAfterVerify = true;
1640            return;
1641            break;
1642
1643        case TR_STATUS_STOPPED:
1644            if( !bypass_queue && torrentShouldQueue( tor ) ) {
1645                torrentSetQueued( tor, true );
1646                return;
1647            }
1648            break;
1649    }
1650
1651    /* don't allow the torrent to be started if the files disappeared */
1652    if( setLocalErrorIfFilesDisappeared( tor ) )
1653        return;
1654
1655    /* otherwise, start it now... */
1656    tr_sessionLock( tor->session );
1657
1658    /* allow finished torrents to be resumed */
1659    if( tr_torrentIsSeedRatioDone( tor ) ) {
1660        tr_torinf( tor, _( "Restarted manually -- disabling its seed ratio" ) );
1661        tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_UNLIMITED );
1662    }
1663
1664    /* corresponds to the peer_id sent as a tracker request parameter.
1665     * one tracker admin says: "When the same torrent is opened and
1666     * closed and opened again without quitting Transmission ...
1667     * change the peerid. It would help sometimes if a stopped event
1668     * was missed to ensure that we didn't think someone was cheating. */
1669    tr_peerIdInit( tor->peer_id );
1670    tor->isRunning = 1;
1671    tr_torrentSetDirty( tor );
1672    tr_runInEventThread( tor->session, torrentStartImpl, tor );
1673
1674    tr_sessionUnlock( tor->session );
1675}
1676
1677void
1678tr_torrentStart( tr_torrent * tor )
1679{
1680    if( tr_isTorrent( tor ) )
1681        torrentStart( tor, false );
1682}
1683
1684void
1685tr_torrentStartNow( tr_torrent * tor )
1686{
1687    if( tr_isTorrent( tor ) )
1688        torrentStart( tor, true );
1689}
1690
1691static void
1692torrentRecheckDoneImpl( void * vtor )
1693{
1694    tr_torrent * tor = vtor;
1695    assert( tr_isTorrent( tor ) );
1696
1697    tr_torrentRecheckCompleteness( tor );
1698
1699    if( tor->startAfterVerify ) {
1700        tor->startAfterVerify = false;
1701        torrentStart( tor, false );
1702    }
1703}
1704
1705static void
1706torrentRecheckDoneCB( tr_torrent * tor )
1707{
1708    assert( tr_isTorrent( tor ) );
1709
1710    tr_runInEventThread( tor->session, torrentRecheckDoneImpl, tor );
1711}
1712
1713static void
1714verifyTorrent( void * vtor )
1715{
1716    tr_torrent * tor = vtor;
1717
1718    tr_sessionLock( tor->session );
1719
1720    /* if the torrent's already being verified, stop it */
1721    tr_verifyRemove( tor );
1722
1723    /* if the torrent's running, stop it & set the restart-after-verify flag */
1724    if( tor->startAfterVerify || tor->isRunning ) {
1725        /* don't clobber isStopping */
1726        const bool startAfter = tor->isStopping ? false : true;
1727        tr_torrentStop( tor );
1728        tor->startAfterVerify = startAfter;
1729    }
1730
1731    if( setLocalErrorIfFilesDisappeared( tor ) )
1732        tor->startAfterVerify = false;
1733    else
1734        tr_verifyAdd( tor, torrentRecheckDoneCB );
1735
1736    tr_sessionUnlock( tor->session );
1737}
1738
1739void
1740tr_torrentVerify( tr_torrent * tor )
1741{
1742    if( tr_isTorrent( tor ) )
1743        tr_runInEventThread( tor->session, verifyTorrent, tor );
1744}
1745
1746void
1747tr_torrentSave( tr_torrent * tor )
1748{
1749    assert( tr_isTorrent( tor ) );
1750
1751    if( tor->isDirty )
1752    {
1753        tor->isDirty = false;
1754        tr_torrentSaveResume( tor );
1755    }
1756}
1757
1758static void
1759stopTorrent( void * vtor )
1760{
1761    tr_torrent * tor = vtor;
1762    tr_torinf( tor, "Pausing" );
1763
1764    assert( tr_isTorrent( tor ) );
1765
1766    tr_torrentLock( tor );
1767
1768    tr_verifyRemove( tor );
1769    torrentSetQueued( tor, false );
1770    tr_peerMgrStopTorrent( tor );
1771    tr_announcerTorrentStopped( tor );
1772    tr_cacheFlushTorrent( tor->session->cache, tor );
1773
1774    tr_fdTorrentClose( tor->session, tor->uniqueId );
1775
1776    if( !tor->isDeleting )
1777        tr_torrentSave( tor );
1778
1779    tr_torrentUnlock( tor );
1780}
1781
1782void
1783tr_torrentStop( tr_torrent * tor )
1784{
1785    assert( tr_isTorrent( tor ) );
1786
1787    if( tr_isTorrent( tor ) )
1788    {
1789        tr_sessionLock( tor->session );
1790
1791        tor->isRunning = 0;
1792        tor->isStopping = 0;
1793        tr_torrentSetDirty( tor );
1794        tr_runInEventThread( tor->session, stopTorrent, tor );
1795
1796        tr_sessionUnlock( tor->session );
1797    }
1798}
1799
1800static void
1801closeTorrent( void * vtor )
1802{
1803    tr_benc * d;
1804    tr_torrent * tor = vtor;
1805
1806    assert( tr_isTorrent( tor ) );
1807
1808    d = tr_bencListAddDict( &tor->session->removedTorrents, 2 );
1809    tr_bencDictAddInt( d, "id", tor->uniqueId );
1810    tr_bencDictAddInt( d, "date", tr_time( ) );
1811
1812    tr_torinf( tor, "%s", _( "Removing torrent" ) );
1813
1814    stopTorrent( tor );
1815
1816    if( tor->isDeleting )
1817    {
1818        tr_metainfoRemoveSaved( tor->session, &tor->info );
1819        tr_torrentRemoveResume( tor );
1820    }
1821
1822    tor->isRunning = 0;
1823    freeTorrent( tor );
1824}
1825
1826void
1827tr_torrentFree( tr_torrent * tor )
1828{
1829    if( tr_isTorrent( tor ) )
1830    {
1831        tr_session * session = tor->session;
1832        assert( tr_isSession( session ) );
1833        tr_sessionLock( session );
1834
1835        tr_torrentClearCompletenessCallback( tor );
1836        tr_runInEventThread( session, closeTorrent, tor );
1837
1838        tr_sessionUnlock( session );
1839    }
1840}
1841
1842struct remove_data
1843{
1844    tr_torrent   * tor;
1845    bool           deleteFlag;
1846    tr_fileFunc  * deleteFunc;
1847};
1848
1849static void tr_torrentDeleteLocalData( tr_torrent *, tr_fileFunc );
1850
1851static void
1852removeTorrent( void * vdata )
1853{
1854    struct remove_data * data = vdata;
1855
1856    if( data->deleteFlag )
1857        tr_torrentDeleteLocalData( data->tor, data->deleteFunc );
1858
1859    tr_torrentClearCompletenessCallback( data->tor );
1860    closeTorrent( data->tor );
1861    tr_free( data );
1862}
1863
1864void
1865tr_torrentRemove( tr_torrent   * tor,
1866                  bool           deleteFlag,
1867                  tr_fileFunc    deleteFunc )
1868{
1869    struct remove_data * data;
1870
1871    assert( tr_isTorrent( tor ) );
1872    tor->isDeleting = 1;
1873
1874    data = tr_new0( struct remove_data, 1 );
1875    data->tor = tor;
1876    data->deleteFlag = deleteFlag;
1877    data->deleteFunc = deleteFunc;
1878    tr_runInEventThread( tor->session, removeTorrent, data );
1879}
1880
1881/**
1882***  Completeness
1883**/
1884
1885static const char *
1886getCompletionString( int type )
1887{
1888    switch( type )
1889    {
1890        /* Translators: this is a minor point that's safe to skip over, but FYI:
1891           "Complete" and "Done" are specific, different terms in Transmission:
1892           "Complete" means we've downloaded every file in the torrent.
1893           "Done" means we're done downloading the files we wanted, but NOT all
1894           that exist */
1895        case TR_PARTIAL_SEED:
1896            return _( "Done" );
1897
1898        case TR_SEED:
1899            return _( "Complete" );
1900
1901        default:
1902            return _( "Incomplete" );
1903    }
1904}
1905
1906static void
1907fireCompletenessChange( tr_torrent       * tor,
1908                        tr_completeness    status,
1909                        bool               wasRunning )
1910{
1911    assert( ( status == TR_LEECH )
1912         || ( status == TR_SEED )
1913         || ( status == TR_PARTIAL_SEED ) );
1914
1915    if( tor->completeness_func )
1916        tor->completeness_func( tor, status, wasRunning,
1917                                tor->completeness_func_user_data );
1918}
1919
1920void
1921tr_torrentSetCompletenessCallback( tr_torrent                    * tor,
1922                                   tr_torrent_completeness_func    func,
1923                                   void                          * user_data )
1924{
1925    assert( tr_isTorrent( tor ) );
1926
1927    tor->completeness_func = func;
1928    tor->completeness_func_user_data = user_data;
1929}
1930
1931void
1932tr_torrentClearCompletenessCallback( tr_torrent * torrent )
1933{
1934    tr_torrentSetCompletenessCallback( torrent, NULL, NULL );
1935}
1936
1937void
1938tr_torrentSetRatioLimitHitCallback( tr_torrent                     * tor,
1939                                    tr_torrent_ratio_limit_hit_func  func,
1940                                    void                           * user_data )
1941{
1942    assert( tr_isTorrent( tor ) );
1943
1944    tor->ratio_limit_hit_func = func;
1945    tor->ratio_limit_hit_func_user_data = user_data;
1946}
1947
1948void
1949tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent )
1950{
1951    tr_torrentSetRatioLimitHitCallback( torrent, NULL, NULL );
1952}
1953
1954void
1955tr_torrentSetIdleLimitHitCallback( tr_torrent                    * tor,
1956                                   tr_torrent_idle_limit_hit_func  func,
1957                                   void                          * user_data )
1958{
1959    assert( tr_isTorrent( tor ) );
1960
1961    tor->idle_limit_hit_func = func;
1962    tor->idle_limit_hit_func_user_data = user_data;
1963}
1964
1965void
1966tr_torrentClearIdleLimitHitCallback( tr_torrent * torrent )
1967{
1968    tr_torrentSetIdleLimitHitCallback( torrent, NULL, NULL );
1969}
1970
1971static void
1972onSigCHLD( int i UNUSED )
1973{
1974    waitpid( -1, NULL, WNOHANG );
1975}
1976
1977static void
1978torrentCallScript( const tr_torrent * tor, const char * script )
1979{
1980    char timeStr[128];
1981    const time_t now = tr_time( );
1982
1983    tr_strlcpy( timeStr, ctime( &now ), sizeof( timeStr ) );
1984    *strchr( timeStr,'\n' ) = '\0';
1985
1986    if( script && *script )
1987    {
1988        int i;
1989        char * cmd[] = { tr_strdup( script ), NULL };
1990        char * env[] = {
1991            tr_strdup_printf( "TR_APP_VERSION=%s", SHORT_VERSION_STRING ),
1992            tr_strdup_printf( "TR_TIME_LOCALTIME=%s", timeStr ),
1993            tr_strdup_printf( "TR_TORRENT_DIR=%s", tor->currentDir ),
1994            tr_strdup_printf( "TR_TORRENT_ID=%d", tr_torrentId( tor ) ),
1995            tr_strdup_printf( "TR_TORRENT_HASH=%s", tor->info.hashString ),
1996            tr_strdup_printf( "TR_TORRENT_NAME=%s", tr_torrentName( tor ) ),
1997            NULL };
1998
1999        tr_torinf( tor, "Calling script \"%s\"", script );
2000
2001#ifdef WIN32
2002        _spawnvpe( _P_NOWAIT, script, (const char*)cmd, env );
2003#else
2004        signal( SIGCHLD, onSigCHLD );
2005
2006        if( !fork( ) )
2007        {
2008            for (i=0; env[i]; ++i)
2009                putenv(env[i]);
2010            execvp( script, cmd );
2011            _exit( 0 );
2012        }
2013#endif
2014
2015        for( i=0; cmd[i]; ++i ) tr_free( cmd[i] );
2016        for( i=0; env[i]; ++i ) tr_free( env[i] );
2017    }
2018}
2019
2020void
2021tr_torrentRecheckCompleteness( tr_torrent * tor )
2022{
2023    tr_completeness completeness;
2024
2025    assert( tr_isTorrent( tor ) );
2026
2027    tr_torrentLock( tor );
2028
2029    completeness = tr_cpGetStatus( &tor->completion );
2030
2031    if( completeness != tor->completeness )
2032    {
2033        const int recentChange = tor->downloadedCur != 0;
2034        const bool wasLeeching = !tr_torrentIsSeed( tor );
2035        const bool wasRunning = tor->isRunning;
2036
2037        if( recentChange )
2038        {
2039            tr_torinf( tor, _( "State changed from \"%1$s\" to \"%2$s\"" ),
2040                      getCompletionString( tor->completeness ),
2041                      getCompletionString( completeness ) );
2042        }
2043
2044        tor->completeness = completeness;
2045        tr_fdTorrentClose( tor->session, tor->uniqueId );
2046
2047        if( tr_torrentIsSeed( tor ) )
2048        {
2049            if( recentChange )
2050            {
2051                tr_announcerTorrentCompleted( tor );
2052                tor->doneDate = tor->anyDate = tr_time( );
2053            }
2054
2055            if( wasLeeching && wasRunning )
2056            {
2057                /* clear interested flag on all peers */
2058                tr_peerMgrClearInterest( tor );
2059
2060                /* if completeness was TR_LEECH then the seed limit check will have been skipped in bandwidthPulse */
2061                tr_torrentCheckSeedLimit( tor );
2062            }
2063
2064            if( tor->currentDir == tor->incompleteDir )
2065                tr_torrentSetLocation( tor, tor->downloadDir, true, NULL, NULL );
2066
2067            if( tr_sessionIsTorrentDoneScriptEnabled( tor->session ) )
2068                torrentCallScript( tor, tr_sessionGetTorrentDoneScript( tor->session ) );
2069        }
2070
2071        fireCompletenessChange( tor, completeness, wasRunning );
2072
2073        tr_torrentSetDirty( tor );
2074    }
2075
2076    tr_torrentUnlock( tor );
2077}
2078
2079/***
2080****
2081***/
2082
2083static void
2084tr_torrentFireMetadataCompleted( tr_torrent * tor )
2085{
2086    assert( tr_isTorrent( tor ) );
2087
2088    if( tor->metadata_func )
2089        tor->metadata_func( tor, tor->metadata_func_user_data );
2090}
2091
2092void
2093tr_torrentSetMetadataCallback( tr_torrent                * tor,
2094                               tr_torrent_metadata_func    func,
2095                               void                      * user_data )
2096{
2097    assert( tr_isTorrent( tor ) );
2098
2099    tor->metadata_func = func;
2100    tor->metadata_func_user_data = user_data;
2101}
2102
2103
2104/**
2105***  File priorities
2106**/
2107
2108void
2109tr_torrentInitFilePriority( tr_torrent *    tor,
2110                            tr_file_index_t fileIndex,
2111                            tr_priority_t   priority )
2112{
2113    tr_piece_index_t i;
2114    tr_file *        file;
2115
2116    assert( tr_isTorrent( tor ) );
2117    assert( fileIndex < tor->info.fileCount );
2118    assert( tr_isPriority( priority ) );
2119
2120    file = &tor->info.files[fileIndex];
2121    file->priority = priority;
2122    for( i = file->firstPiece; i <= file->lastPiece; ++i )
2123        tor->info.pieces[i].priority = calculatePiecePriority( tor, i, fileIndex );
2124}
2125
2126void
2127tr_torrentSetFilePriorities( tr_torrent             * tor,
2128                             const tr_file_index_t  * files,
2129                             tr_file_index_t          fileCount,
2130                             tr_priority_t            priority )
2131{
2132    tr_file_index_t i;
2133    assert( tr_isTorrent( tor ) );
2134    tr_torrentLock( tor );
2135
2136    for( i = 0; i < fileCount; ++i )
2137        if( files[i] < tor->info.fileCount )
2138            tr_torrentInitFilePriority( tor, files[i], priority );
2139    tr_torrentSetDirty( tor );
2140    tr_peerMgrRebuildRequests( tor );
2141
2142    tr_torrentUnlock( tor );
2143}
2144
2145tr_priority_t*
2146tr_torrentGetFilePriorities( const tr_torrent * tor )
2147{
2148    tr_file_index_t i;
2149    tr_priority_t * p;
2150
2151    assert( tr_isTorrent( tor ) );
2152
2153    tr_torrentLock( tor );
2154    p = tr_new0( tr_priority_t, tor->info.fileCount );
2155    for( i = 0; i < tor->info.fileCount; ++i )
2156        p[i] = tor->info.files[i].priority;
2157    tr_torrentUnlock( tor );
2158
2159    return p;
2160}
2161
2162/**
2163***  File DND
2164**/
2165
2166static void
2167setFileDND( tr_torrent * tor, tr_file_index_t fileIndex, int doDownload )
2168{
2169    const int8_t     dnd = !doDownload;
2170    tr_piece_index_t firstPiece;
2171    int8_t           firstPieceDND;
2172    tr_piece_index_t lastPiece;
2173    int8_t           lastPieceDND;
2174    tr_file_index_t  i;
2175    tr_file *        file = &tor->info.files[fileIndex];
2176
2177    file->dnd = dnd;
2178    firstPiece = file->firstPiece;
2179    lastPiece = file->lastPiece;
2180
2181    /* can't set the first piece to DND unless
2182       every file using that piece is DND */
2183    firstPieceDND = dnd;
2184    if( fileIndex > 0 )
2185    {
2186        for( i = fileIndex - 1; firstPieceDND; --i )
2187        {
2188            if( tor->info.files[i].lastPiece != firstPiece )
2189                break;
2190            firstPieceDND = tor->info.files[i].dnd;
2191            if( !i )
2192                break;
2193        }
2194    }
2195
2196    /* can't set the last piece to DND unless
2197       every file using that piece is DND */
2198    lastPieceDND = dnd;
2199    for( i = fileIndex + 1; lastPieceDND && i < tor->info.fileCount; ++i )
2200    {
2201        if( tor->info.files[i].firstPiece != lastPiece )
2202            break;
2203        lastPieceDND = tor->info.files[i].dnd;
2204    }
2205
2206    if( firstPiece == lastPiece )
2207    {
2208        tor->info.pieces[firstPiece].dnd = firstPieceDND && lastPieceDND;
2209    }
2210    else
2211    {
2212        tr_piece_index_t pp;
2213        tor->info.pieces[firstPiece].dnd = firstPieceDND;
2214        tor->info.pieces[lastPiece].dnd = lastPieceDND;
2215        for( pp = firstPiece + 1; pp < lastPiece; ++pp )
2216            tor->info.pieces[pp].dnd = dnd;
2217    }
2218}
2219
2220void
2221tr_torrentInitFileDLs( tr_torrent             * tor,
2222                       const tr_file_index_t  * files,
2223                       tr_file_index_t          fileCount,
2224                       bool                     doDownload )
2225{
2226    tr_file_index_t i;
2227
2228    assert( tr_isTorrent( tor ) );
2229
2230    tr_torrentLock( tor );
2231
2232    for( i=0; i<fileCount; ++i )
2233        if( files[i] < tor->info.fileCount )
2234            setFileDND( tor, files[i], doDownload );
2235
2236    tr_cpInvalidateDND( &tor->completion );
2237
2238    tr_torrentUnlock( tor );
2239}
2240
2241void
2242tr_torrentSetFileDLs( tr_torrent             * tor,
2243                      const tr_file_index_t  * files,
2244                      tr_file_index_t          fileCount,
2245                      bool                     doDownload )
2246{
2247    assert( tr_isTorrent( tor ) );
2248    tr_torrentLock( tor );
2249
2250    tr_torrentInitFileDLs( tor, files, fileCount, doDownload );
2251    tr_torrentSetDirty( tor );
2252    tr_peerMgrRebuildRequests( tor );
2253
2254    tr_torrentUnlock( tor );
2255}
2256
2257/***
2258****
2259***/
2260
2261tr_priority_t
2262tr_torrentGetPriority( const tr_torrent * tor )
2263{
2264    assert( tr_isTorrent( tor ) );
2265
2266    return tor->bandwidth.priority;
2267}
2268
2269void
2270tr_torrentSetPriority( tr_torrent * tor, tr_priority_t priority )
2271{
2272    assert( tr_isTorrent( tor ) );
2273    assert( tr_isPriority( priority ) );
2274
2275    if( tor->bandwidth.priority != priority )
2276    {
2277        tor->bandwidth.priority = priority;
2278
2279        tr_torrentSetDirty( tor );
2280    }
2281}
2282
2283/***
2284****
2285***/
2286
2287void
2288tr_torrentSetPeerLimit( tr_torrent * tor,
2289                        uint16_t     maxConnectedPeers )
2290{
2291    assert( tr_isTorrent( tor ) );
2292
2293    if ( tor->maxConnectedPeers != maxConnectedPeers )
2294    {
2295        tor->maxConnectedPeers = maxConnectedPeers;
2296
2297        tr_torrentSetDirty( tor );
2298    }
2299}
2300
2301uint16_t
2302tr_torrentGetPeerLimit( const tr_torrent * tor )
2303{
2304    assert( tr_isTorrent( tor ) );
2305
2306    return tor->maxConnectedPeers;
2307}
2308
2309/***
2310****
2311***/
2312
2313void
2314tr_torrentGetBlockLocation( const tr_torrent * tor,
2315                            tr_block_index_t   block,
2316                            tr_piece_index_t * piece,
2317                            uint32_t         * offset,
2318                            uint32_t         * length )
2319{
2320    uint64_t pos = block;
2321    pos *= tor->blockSize;
2322    *piece = pos / tor->info.pieceSize;
2323    *offset = pos - ( *piece * tor->info.pieceSize );
2324    *length = tr_torBlockCountBytes( tor, block );
2325}
2326
2327
2328tr_block_index_t
2329_tr_block( const tr_torrent * tor,
2330           tr_piece_index_t   index,
2331           uint32_t           offset )
2332{
2333    tr_block_index_t ret;
2334
2335    assert( tr_isTorrent( tor ) );
2336
2337    ret = index;
2338    ret *= ( tor->info.pieceSize / tor->blockSize );
2339    ret += offset / tor->blockSize;
2340    return ret;
2341}
2342
2343bool
2344tr_torrentReqIsValid( const tr_torrent * tor,
2345                      tr_piece_index_t   index,
2346                      uint32_t           offset,
2347                      uint32_t           length )
2348{
2349    int err = 0;
2350
2351    assert( tr_isTorrent( tor ) );
2352
2353    if( index >= tor->info.pieceCount )
2354        err = 1;
2355    else if( length < 1 )
2356        err = 2;
2357    else if( ( offset + length ) > tr_torPieceCountBytes( tor, index ) )
2358        err = 3;
2359    else if( length > MAX_BLOCK_SIZE )
2360        err = 4;
2361    else if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
2362        err = 5;
2363
2364    if( err ) tr_tordbg( tor, "index %lu offset %lu length %lu err %d\n",
2365                              (unsigned long)index,
2366                              (unsigned long)offset,
2367                              (unsigned long)length,
2368                              err );
2369
2370    return !err;
2371}
2372
2373uint64_t
2374tr_pieceOffset( const tr_torrent * tor,
2375                tr_piece_index_t   index,
2376                uint32_t           offset,
2377                uint32_t           length )
2378{
2379    uint64_t ret;
2380
2381    assert( tr_isTorrent( tor ) );
2382
2383    ret = tor->info.pieceSize;
2384    ret *= index;
2385    ret += offset;
2386    ret += length;
2387    return ret;
2388}
2389
2390void
2391tr_torGetFileBlockRange( const tr_torrent        * tor,
2392                         const tr_file_index_t     file,
2393                         tr_block_index_t        * first,
2394                         tr_block_index_t        * last )
2395{
2396    const tr_file * f = &tor->info.files[file];
2397    uint64_t offset = f->offset;
2398    *first = offset / tor->blockSize;
2399    if( !f->length )
2400        *last = *first;
2401    else {
2402        offset += f->length - 1;
2403        *last = offset / tor->blockSize;
2404    }
2405}
2406
2407void
2408tr_torGetPieceBlockRange( const tr_torrent        * tor,
2409                          const tr_piece_index_t    piece,
2410                          tr_block_index_t        * first,
2411                          tr_block_index_t        * last )
2412{
2413    uint64_t offset = tor->info.pieceSize;
2414    offset *= piece;
2415    *first = offset / tor->blockSize;
2416    offset += ( tr_torPieceCountBytes( tor, piece ) - 1 );
2417    *last = offset / tor->blockSize;
2418}
2419
2420
2421/***
2422****
2423***/
2424
2425void
2426tr_torrentSetPieceChecked( tr_torrent * tor, tr_piece_index_t pieceIndex )
2427{
2428    assert( tr_isTorrent( tor ) );
2429    assert( pieceIndex < tor->info.pieceCount );
2430
2431    tor->info.pieces[pieceIndex].timeChecked = tr_time( );
2432}
2433
2434void
2435tr_torrentSetChecked( tr_torrent * tor, time_t when )
2436{
2437    tr_piece_index_t i, n;
2438
2439    assert( tr_isTorrent( tor ) );
2440
2441    for( i=0, n=tor->info.pieceCount; i!=n; ++i )
2442        tor->info.pieces[i].timeChecked = when;
2443}
2444
2445bool
2446tr_torrentCheckPiece( tr_torrent * tor, tr_piece_index_t pieceIndex )
2447{
2448    const bool pass = tr_ioTestPiece( tor, pieceIndex );
2449
2450    tr_deeplog_tor( tor, "[LAZY] tr_torrentCheckPiece tested piece %zu, pass==%d", (size_t)pieceIndex, (int)pass );
2451    tr_torrentSetHasPiece( tor, pieceIndex, pass );
2452    tr_torrentSetPieceChecked( tor, pieceIndex );
2453    tor->anyDate = tr_time( );
2454    tr_torrentSetDirty( tor );
2455
2456    return pass;
2457}
2458
2459time_t
2460tr_torrentGetFileMTime( const tr_torrent * tor, tr_file_index_t i )
2461{
2462    time_t mtime = 0;
2463    if( !tr_fdFileGetCachedMTime( tor->session, tor->uniqueId, i, &mtime ) )
2464        tr_torrentFindFile2( tor, i, NULL, NULL, &mtime );
2465    return mtime;
2466}
2467
2468bool
2469tr_torrentPieceNeedsCheck( const tr_torrent * tor, tr_piece_index_t p )
2470{
2471    uint64_t unused;
2472    tr_file_index_t f;
2473    const tr_info * inf = tr_torrentInfo( tor );
2474
2475    /* if we've never checked this piece, then it needs to be checked */
2476    if( !inf->pieces[p].timeChecked )
2477        return true;
2478
2479    /* If we think we've completed one of the files in this piece,
2480     * but it's been modified since we last checked it,
2481     * then it needs to be rechecked */
2482    tr_ioFindFileLocation( tor, p, 0, &f, &unused );
2483    for( ; f < inf->fileCount && pieceHasFile( p, &inf->files[f] ); ++f )
2484        if( tr_cpFileIsComplete( &tor->completion, f ) )
2485            if( tr_torrentGetFileMTime( tor, f ) > inf->pieces[p].timeChecked )
2486                return true;
2487
2488    return false;
2489}
2490
2491/***
2492****
2493***/
2494
2495static int
2496compareTrackerByTier( const void * va, const void * vb )
2497{
2498    const tr_tracker_info * a = va;
2499    const tr_tracker_info * b = vb;
2500
2501    /* sort by tier */
2502    if( a->tier != b->tier )
2503        return a->tier - b->tier;
2504
2505    /* get the effects of a stable sort by comparing the two elements' addresses */
2506    return a - b;
2507}
2508
2509bool
2510tr_torrentSetAnnounceList( tr_torrent             * tor,
2511                           const tr_tracker_info  * trackers_in,
2512                           int                      trackerCount )
2513{
2514    int i;
2515    tr_benc metainfo;
2516    bool ok = true;
2517    tr_tracker_info * trackers;
2518
2519    tr_torrentLock( tor );
2520
2521    assert( tr_isTorrent( tor ) );
2522
2523    /* ensure the trackers' tiers are in ascending order */
2524    trackers = tr_memdup( trackers_in, sizeof( tr_tracker_info ) * trackerCount );
2525    qsort( trackers, trackerCount, sizeof( tr_tracker_info ), compareTrackerByTier );
2526
2527    /* look for bad URLs */
2528    for( i=0; ok && i<trackerCount; ++i )
2529        if( !tr_urlIsValidTracker( trackers[i].announce ) )
2530            ok = false;
2531
2532    /* save to the .torrent file */
2533    if( ok && !tr_bencLoadFile( &metainfo, TR_FMT_BENC, tor->info.torrent ) )
2534    {
2535        bool hasInfo;
2536        tr_info tmpInfo;
2537
2538        /* remove the old fields */
2539        tr_bencDictRemove( &metainfo, "announce" );
2540        tr_bencDictRemove( &metainfo, "announce-list" );
2541
2542        /* add the new fields */
2543        if( trackerCount > 0 )
2544        {
2545            tr_bencDictAddStr( &metainfo, "announce", trackers[0].announce );
2546        }
2547        if( trackerCount > 1 )
2548        {
2549            int i;
2550            int prevTier = -1;
2551            tr_benc * tier = NULL;
2552            tr_benc * announceList = tr_bencDictAddList( &metainfo, "announce-list", 0 );
2553
2554            for( i=0; i<trackerCount; ++i ) {
2555                if( prevTier != trackers[i].tier ) {
2556                    prevTier = trackers[i].tier;
2557                    tier = tr_bencListAddList( announceList, 0 );
2558                }
2559                tr_bencListAddStr( tier, trackers[i].announce );
2560            }
2561        }
2562
2563        /* try to parse it back again, to make sure it's good */
2564        memset( &tmpInfo, 0, sizeof( tr_info ) );
2565        if( tr_metainfoParse( tor->session, &metainfo, &tmpInfo,
2566                              &hasInfo, &tor->infoDictLength ) )
2567        {
2568            /* it's good, so keep these new trackers and free the old ones */
2569
2570            tr_info swap;
2571            swap.trackers = tor->info.trackers;
2572            swap.trackerCount = tor->info.trackerCount;
2573            tor->info.trackers = tmpInfo.trackers;
2574            tor->info.trackerCount = tmpInfo.trackerCount;
2575            tmpInfo.trackers = swap.trackers;
2576            tmpInfo.trackerCount = swap.trackerCount;
2577
2578            tr_metainfoFree( &tmpInfo );
2579            tr_bencToFile( &metainfo, TR_FMT_BENC, tor->info.torrent );
2580        }
2581
2582        /* cleanup */
2583        tr_bencFree( &metainfo );
2584
2585        /* if we had a tracker-related error on this torrent,
2586         * and that tracker's been removed,
2587         * then clear the error */
2588        if(    ( tor->error == TR_STAT_TRACKER_WARNING )
2589            || ( tor->error == TR_STAT_TRACKER_ERROR ) )
2590        {
2591            bool clear = true;
2592
2593            for( i=0; clear && i<trackerCount; ++i )
2594                if( !strcmp( trackers[i].announce, tor->errorTracker ) )
2595                    clear = false;
2596
2597            if( clear )
2598                tr_torrentClearError( tor );
2599        }
2600
2601        /* tell the announcer to reload this torrent's tracker list */
2602        tr_announcerResetTorrent( tor->session->announcer, tor );
2603    }
2604
2605    tr_torrentUnlock( tor );
2606
2607    tr_free( trackers );
2608    return ok;
2609}
2610
2611/**
2612***
2613**/
2614
2615void
2616tr_torrentSetAddedDate( tr_torrent * tor,
2617                        time_t       t )
2618{
2619    assert( tr_isTorrent( tor ) );
2620
2621    tor->addedDate = t;
2622    tor->anyDate = MAX( tor->anyDate, tor->addedDate );
2623}
2624
2625void
2626tr_torrentSetActivityDate( tr_torrent * tor, time_t t )
2627{
2628    assert( tr_isTorrent( tor ) );
2629
2630    tor->activityDate = t;
2631    tor->anyDate = MAX( tor->anyDate, tor->activityDate );
2632}
2633
2634void
2635tr_torrentSetDoneDate( tr_torrent * tor,
2636                       time_t       t )
2637{
2638    assert( tr_isTorrent( tor ) );
2639
2640    tor->doneDate = t;
2641    tor->anyDate = MAX( tor->anyDate, tor->doneDate );
2642}
2643
2644/**
2645***
2646**/
2647
2648uint64_t
2649tr_torrentGetBytesLeftToAllocate( const tr_torrent * tor )
2650{
2651    tr_file_index_t i;
2652    uint64_t bytesLeft = 0;
2653
2654    assert( tr_isTorrent( tor ) );
2655
2656    for( i=0; i<tor->info.fileCount; ++i )
2657    {
2658        if( !tor->info.files[i].dnd )
2659        {
2660            struct stat sb;
2661            const uint64_t length = tor->info.files[i].length;
2662            char * path = tr_torrentFindFile( tor, i );
2663
2664            bytesLeft += length;
2665
2666            if( ( path != NULL ) && !stat( path, &sb )
2667                                 && S_ISREG( sb.st_mode )
2668                                 && ( (uint64_t)sb.st_size <= length ) )
2669                bytesLeft -= sb.st_size;
2670
2671            tr_free( path );
2672        }
2673    }
2674
2675    return bytesLeft;
2676}
2677
2678/****
2679*****  Removing the torrent's local data
2680****/
2681
2682static bool
2683isJunkFile( const char * base )
2684{
2685    int i;
2686    static const char * files[] = { ".DS_Store", "desktop.ini", "Thumbs.db" };
2687    static const int file_count = sizeof(files) / sizeof(files[0]);
2688
2689    for( i=0; i<file_count; ++i )
2690        if( !strcmp( base, files[i] ) )
2691            return true;
2692
2693#ifdef SYS_DARWIN
2694    /* check for resource forks. <http://support.apple.com/kb/TA20578> */
2695    if( !memcmp( base, "._", 2 ) )
2696        return true;
2697#endif
2698
2699    return false;
2700}
2701
2702static void
2703removeEmptyFoldersAndJunkFiles( const char * folder )
2704{
2705    DIR * odir;
2706    if(( odir = opendir( folder ))) {
2707        struct dirent * d;
2708        while(( d = readdir( odir ))) {
2709            if( strcmp( d->d_name, "." ) && strcmp( d->d_name, ".." ) ) {
2710                struct stat sb;
2711                char * filename = tr_buildPath( folder, d->d_name, NULL );
2712                if( !stat( filename, &sb ) && S_ISDIR( sb.st_mode ) )
2713                    removeEmptyFoldersAndJunkFiles( filename );
2714                else if( isJunkFile( d->d_name ) )
2715                    remove( filename );
2716                tr_free( filename );
2717            }
2718        }
2719        remove( folder );
2720        closedir( odir );
2721    }
2722}
2723
2724static bool fileExists( const char * filename, time_t * optional_mtime );
2725
2726/**
2727 * This convoluted code does something (seemingly) simple:
2728 * remove the torrent's local files.
2729 *
2730 * Fun complications:
2731 * 1. Try to preserve the directory hierarchy in the recycle bin.
2732 * 2. If there are nontorrent files, don't delete them...
2733 * 3. ...unless the other files are "junk", such as .DS_Store
2734 */
2735static void
2736deleteLocalData( tr_torrent * tor, tr_fileFunc func )
2737{
2738    int i, n;
2739    tr_file_index_t f;
2740    char * base;
2741    DIR * odir;
2742    char * tmpdir = NULL;
2743    tr_ptrArray files = TR_PTR_ARRAY_INIT;
2744    tr_ptrArray folders = TR_PTR_ARRAY_INIT;
2745    const void * const vstrcmp = strcmp;
2746    const char * const top = tor->currentDir;
2747
2748    /* if it's a magnet link, there's nothing to move... */
2749    if( !tr_torrentHasMetadata( tor ) )
2750        return;
2751
2752    /***
2753    ****  Move the local data to a new tmpdir
2754    ***/
2755
2756    base = tr_strdup_printf( "%s__XXXXXX", tr_torrentName( tor ) );
2757    tmpdir = tr_buildPath( top, base, NULL );
2758    mkdtemp( tmpdir );
2759    tr_free( base );
2760
2761    for( f=0; f<tor->info.fileCount; ++f )
2762    {
2763        char * filename = tr_buildPath( top, tor->info.files[f].name, NULL );
2764        if( !fileExists( filename, NULL ) ) {
2765                char * partial = tr_torrentBuildPartial( tor, f );
2766                tr_free( filename );
2767                filename = tr_buildPath( top, partial, NULL );
2768                tr_free( partial );
2769                if( !fileExists( filename, NULL ) ) {
2770                        tr_free( filename );
2771                        filename = NULL;
2772                }
2773        }
2774
2775        if( filename != NULL )
2776        {
2777            char * target = tr_buildPath( tmpdir, tor->info.files[f].name, NULL );
2778            char * target_dir = tr_dirname( target );
2779            tr_mkdirp( target_dir, 0777 );
2780            rename( filename, target );
2781            tr_ptrArrayAppend( &files, target );
2782            tr_free( target_dir );
2783            tr_free( filename );
2784        }
2785    }
2786
2787    /***
2788    ****  Remove tmpdir.
2789    ****
2790    ****  Try deleting the top-level files & folders to preserve
2791    ****  the directory hierarchy in the recycle bin.
2792    ****  If case that fails -- for example, rmdir() doesn't
2793    ****  delete nonempty folders -- go from the bottom up too.
2794    ***/
2795
2796    /* try deleting the local data's top-level files & folders */
2797    if(( odir = opendir( tmpdir )))
2798    {
2799        struct dirent * d;
2800        while(( d = readdir( odir )))
2801        {
2802            if( strcmp( d->d_name, "." ) && strcmp( d->d_name, ".." ) )
2803            {
2804                char * file = tr_buildPath( tmpdir, d->d_name, NULL );
2805                func( file );
2806                tr_free( file );
2807            }
2808        }
2809        closedir( odir );
2810    }
2811
2812    /* go from the bottom up */
2813    for( i=0, n=tr_ptrArraySize(&files); i<n; ++i )
2814    {
2815        char * walk = tr_strdup( tr_ptrArrayNth( &files, i ) );
2816        while( fileExists( walk, NULL ) && !tr_is_same_file( tmpdir, walk ) )
2817        {
2818            char * tmp = tr_dirname( walk );
2819            func( walk );
2820            tr_free( walk );
2821            walk = tmp;
2822        }
2823        tr_free( walk );
2824    }
2825
2826    /***
2827    ****  The local data has been removed.
2828    ****  What's left in top are empty folders, junk, and user-generated files.
2829    ****  Remove the first two categories and leave the third.
2830    ***/
2831
2832    /* build a list of 'top's child directories that belong to this torrent */
2833    for( f=0; f<tor->info.fileCount; ++f )
2834    {
2835        char * dir;
2836        char * filename;
2837
2838        /* get the directory that this file goes in... */
2839        filename = tr_buildPath( top, tor->info.files[f].name, NULL );
2840        dir = tr_dirname( filename );
2841        tr_free( filename );
2842        if( !tr_is_same_file( top, dir ) && strcmp( top, dir ) ) {
2843            for( ;; ) {
2844                char * parent = tr_dirname( dir );
2845                if( tr_is_same_file( top, parent ) || !strcmp( top, parent ) ) {
2846                    if( tr_ptrArrayFindSorted( &folders, dir, vstrcmp ) == NULL ) {
2847                        tr_ptrArrayInsertSorted( &folders, tr_strdup( dir ), vstrcmp );
2848                    }
2849                    break;
2850                }
2851                tr_free( dir );
2852                dir = parent;
2853            }
2854        }
2855    }
2856    for( i=0, n=tr_ptrArraySize(&folders); i<n; ++i )
2857        removeEmptyFoldersAndJunkFiles( tr_ptrArrayNth( &folders, i ) );
2858
2859    /* cleanup */
2860    rmdir( tmpdir );
2861    tr_free( tmpdir );
2862    tr_ptrArrayDestruct( &folders, tr_free );
2863    tr_ptrArrayDestruct( &files, tr_free );
2864}
2865
2866static void
2867tr_torrentDeleteLocalData( tr_torrent * tor, tr_fileFunc func )
2868{
2869    assert( tr_isTorrent( tor ) );
2870
2871    if( func == NULL )
2872        func = remove;
2873
2874    /* close all the files because we're about to delete them */
2875    tr_cacheFlushTorrent( tor->session->cache, tor );
2876    tr_fdTorrentClose( tor->session, tor->uniqueId );
2877
2878    deleteLocalData( tor, func );
2879}
2880
2881/***
2882****
2883***/
2884
2885struct LocationData
2886{
2887    bool move_from_old_location;
2888    volatile int * setme_state;
2889    volatile double * setme_progress;
2890    char * location;
2891    tr_torrent * tor;
2892};
2893
2894static void
2895setLocation( void * vdata )
2896{
2897    bool err = false;
2898    struct LocationData * data = vdata;
2899    tr_torrent * tor = data->tor;
2900    const bool do_move = data->move_from_old_location;
2901    const char * location = data->location;
2902    double bytesHandled = 0;
2903
2904    assert( tr_isTorrent( tor ) );
2905
2906    tr_dbg( "Moving \"%s\" location from currentDir \"%s\" to \"%s\"",
2907            tr_torrentName(tor), tor->currentDir, location );
2908
2909    tr_mkdirp( location, 0777 );
2910
2911    if( !tr_is_same_file( location, tor->currentDir ) )
2912    {
2913        tr_file_index_t i;
2914
2915        /* bad idea to move files while they're being verified... */
2916        tr_verifyRemove( tor );
2917
2918        /* try to move the files.
2919         * FIXME: there are still all kinds of nasty cases, like what
2920         * if the target directory runs out of space halfway through... */
2921        for( i=0; !err && i<tor->info.fileCount; ++i )
2922        {
2923            const tr_file * f = &tor->info.files[i];
2924            const char * oldbase;
2925            char * sub;
2926            if( tr_torrentFindFile2( tor, i, &oldbase, &sub, NULL ) )
2927            {
2928                char * oldpath = tr_buildPath( oldbase, sub, NULL );
2929                char * newpath = tr_buildPath( location, sub, NULL );
2930
2931                tr_dbg( "Found file #%d: %s", (int)i, oldpath );
2932
2933                if( do_move && !tr_is_same_file( oldpath, newpath ) )
2934                {
2935                    bool renamed = false;
2936                    errno = 0;
2937                    tr_torinf( tor, "moving \"%s\" to \"%s\"", oldpath, newpath );
2938                    if( tr_moveFile( oldpath, newpath, &renamed ) )
2939                    {
2940                        err = true;
2941                        tr_torerr( tor, "error moving \"%s\" to \"%s\": %s",
2942                                        oldpath, newpath, tr_strerror( errno ) );
2943                    }
2944                }
2945
2946                tr_free( newpath );
2947                tr_free( oldpath );
2948                tr_free( sub );
2949            }
2950
2951            if( data->setme_progress )
2952            {
2953                bytesHandled += f->length;
2954                *data->setme_progress = bytesHandled / tor->info.totalSize;
2955            }
2956        }
2957
2958        if( !err )
2959        {
2960            /* blow away the leftover subdirectories in the old location */
2961            if( do_move )
2962                tr_torrentDeleteLocalData( tor, remove );
2963
2964            /* set the new location and reverify */
2965            tr_torrentSetDownloadDir( tor, location );
2966        }
2967    }
2968
2969    if( !err && do_move )
2970    {
2971        tr_free( tor->incompleteDir );
2972        tor->incompleteDir = NULL;
2973        tor->currentDir = tor->downloadDir;
2974    }
2975
2976    if( data->setme_state )
2977        *data->setme_state = err ? TR_LOC_ERROR : TR_LOC_DONE;
2978
2979    /* cleanup */
2980    tr_free( data->location );
2981    tr_free( data );
2982}
2983
2984void
2985tr_torrentSetLocation( tr_torrent       * tor,
2986                       const char       * location,
2987                       bool               move_from_old_location,
2988                       volatile double  * setme_progress,
2989                       volatile int     * setme_state )
2990{
2991    struct LocationData * data;
2992
2993    assert( tr_isTorrent( tor ) );
2994
2995    if( setme_state )
2996        *setme_state = TR_LOC_MOVING;
2997    if( setme_progress )
2998        *setme_progress = 0;
2999
3000    /* run this in the libtransmission thread */
3001    data = tr_new( struct LocationData, 1 );
3002    data->tor = tor;
3003    data->location = tr_strdup( location );
3004    data->move_from_old_location = move_from_old_location;
3005    data->setme_state = setme_state;
3006    data->setme_progress = setme_progress;
3007    tr_runInEventThread( tor->session, setLocation, data );
3008}
3009
3010/***
3011****
3012***/
3013
3014void
3015tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNum )
3016{
3017    char * sub;
3018    const char * base;
3019    const tr_info * inf = &tor->info;
3020    const tr_file * f = &inf->files[fileNum];
3021    tr_piece * p;
3022    const tr_piece * pend;
3023    const time_t now = tr_time( );
3024
3025    /* close the file so that we can reopen in read-only mode as needed */
3026    tr_fdFileClose( tor->session, tor, fileNum );
3027
3028    /* now that the file is complete and closed, we can start watching its
3029     * mtime timestamp for changes to know if we need to reverify pieces */
3030    for( p=&inf->pieces[f->firstPiece], pend=&inf->pieces[f->lastPiece]; p!=pend; ++p )
3031        p->timeChecked = now;
3032
3033    /* if the torrent's current filename isn't the same as the one in the
3034     * metadata -- for example, if it had the ".part" suffix appended to
3035     * it until now -- then rename it to match the one in the metadata */
3036    if( tr_torrentFindFile2( tor, fileNum, &base, &sub, NULL ) )
3037    {
3038        if( strcmp( sub, f->name ) )
3039        {
3040            char * oldpath = tr_buildPath( base, sub, NULL );
3041            char * newpath = tr_buildPath( base, f->name, NULL );
3042
3043            if( rename( oldpath, newpath ) )
3044                tr_torerr( tor, "Error moving \"%s\" to \"%s\": %s", oldpath, newpath, tr_strerror( errno ) );
3045
3046            tr_free( newpath );
3047            tr_free( oldpath );
3048        }
3049
3050        tr_free( sub );
3051    }
3052}
3053
3054/***
3055****
3056***/
3057
3058#ifdef SYS_DARWIN
3059 #define TR_STAT_MTIME(sb) ((sb).st_mtimespec.tv_sec)
3060#else
3061 #define TR_STAT_MTIME(sb) ((sb).st_mtime)
3062#endif
3063
3064
3065static bool
3066fileExists( const char * filename, time_t * mtime )
3067{
3068    struct stat sb;
3069    const bool ok = !stat( filename, &sb );
3070
3071    if( ok && ( mtime != NULL ) )
3072        *mtime = TR_STAT_MTIME( sb );
3073
3074    return ok;
3075}
3076
3077bool
3078tr_torrentFindFile2( const tr_torrent * tor, tr_file_index_t fileNum,
3079                     const char ** base, char ** subpath, time_t * mtime )
3080{
3081    char * part = NULL;
3082    const tr_file * file;
3083    const char * b = NULL;
3084    const char * s = NULL;
3085
3086    assert( tr_isTorrent( tor ) );
3087    assert( fileNum < tor->info.fileCount );
3088
3089    file = &tor->info.files[fileNum];
3090
3091    if( b == NULL ) {
3092        char * filename = tr_buildPath( tor->downloadDir, file->name, NULL );
3093        if( fileExists( filename, mtime ) ) {
3094            b = tor->downloadDir;
3095            s = file->name;
3096        }
3097        tr_free( filename );
3098    }
3099
3100    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
3101        char * filename = tr_buildPath( tor->incompleteDir, file->name, NULL );
3102        if( fileExists( filename, mtime ) ) {
3103            b = tor->incompleteDir;
3104            s = file->name;
3105        }
3106        tr_free( filename );
3107    }
3108
3109    if( b == NULL )
3110        part = tr_torrentBuildPartial( tor, fileNum );
3111
3112    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
3113        char * filename = tr_buildPath( tor->incompleteDir, part, NULL );
3114        if( fileExists( filename, mtime ) ) {
3115            b = tor->incompleteDir;
3116            s = part;
3117        }
3118        tr_free( filename );
3119    }
3120
3121    if( b == NULL) {
3122        char * filename = tr_buildPath( tor->downloadDir, part, NULL );
3123        if( fileExists( filename, mtime ) ) {
3124            b = tor->downloadDir;
3125            s = part;
3126        }
3127        tr_free( filename );
3128    }
3129
3130    if( base != NULL )
3131        *base = b;
3132    if( subpath != NULL )
3133        *subpath = tr_strdup( s );
3134
3135    tr_free( part );
3136    return b != NULL;
3137}
3138
3139char*
3140tr_torrentFindFile( const tr_torrent * tor, tr_file_index_t fileNum )
3141{
3142    char * subpath;
3143    char * ret = NULL;
3144    const char * base;
3145
3146    if( tr_torrentFindFile2( tor, fileNum, &base, &subpath, NULL ) )
3147    {
3148        ret = tr_buildPath( base, subpath, NULL );
3149        tr_free( subpath );
3150    }
3151
3152    return ret;
3153}
3154
3155/* Decide whether we should be looking for files in downloadDir or incompleteDir. */
3156static void
3157refreshCurrentDir( tr_torrent * tor )
3158{
3159    const char * dir = NULL;
3160
3161    if( tor->incompleteDir == NULL )
3162        dir = tor->downloadDir;
3163    else if( !tr_torrentHasMetadata( tor ) ) /* no files to find */
3164        dir = tor->incompleteDir;
3165    else if( !tr_torrentFindFile2( tor, 0, &dir, NULL, NULL ) )
3166        dir = tor->incompleteDir;
3167
3168    assert( dir != NULL );
3169    assert( ( dir == tor->downloadDir ) || ( dir == tor->incompleteDir ) );
3170    tor->currentDir = dir;
3171}
3172
3173char*
3174tr_torrentBuildPartial( const tr_torrent * tor, tr_file_index_t fileNum )
3175{
3176    return tr_strdup_printf( "%s.part", tor->info.files[fileNum].name );
3177}
3178
3179/***
3180****
3181***/
3182
3183static int
3184compareTorrentByQueuePosition( const void * va, const void * vb )
3185{
3186    const tr_torrent * a = * (const tr_torrent **) va;
3187    const tr_torrent * b = * (const tr_torrent **) vb;
3188
3189    return a->queuePosition - b->queuePosition;
3190}
3191
3192#ifndef NDEBUG
3193static bool
3194queueIsSequenced( tr_session * session )
3195{
3196    int i ;
3197    int n ;
3198    bool is_sequenced = true;
3199    tr_torrent * tor;
3200    tr_torrent ** tmp = tr_new( tr_torrent *, session->torrentCount );
3201
3202    /* get all the torrents */
3203    n = 0;
3204    tor = NULL;
3205    while(( tor = tr_torrentNext( session, tor )))
3206        tmp[n++] = tor;
3207
3208    /* sort them by position */
3209    qsort( tmp, n, sizeof( tr_torrent * ), compareTorrentByQueuePosition );
3210
3211#if 0
3212    fprintf( stderr, "%s", "queue: " );
3213    for( i=0; i<n; ++i )
3214        fprintf( stderr, "%d ", tmp[i]->queuePosition );
3215    fputc( '\n', stderr );
3216#endif
3217
3218    /* test them */
3219    for( i=0; is_sequenced && i<n; ++i )
3220        if( tmp[i]->queuePosition != i )
3221            is_sequenced = false;
3222
3223    tr_free( tmp );
3224    return is_sequenced;
3225}
3226#endif
3227
3228int
3229tr_torrentGetQueuePosition( const tr_torrent * tor )
3230{
3231    return tor->queuePosition;
3232}
3233
3234void
3235tr_torrentSetQueuePosition( tr_torrent * tor, int pos )
3236{
3237    int back = -1;
3238    tr_torrent * walk;
3239    const int old_pos = tor->queuePosition;
3240    const time_t now = tr_time( );
3241
3242    if( pos < 0 )
3243        pos = 0;
3244
3245    tor->queuePosition = -1;
3246
3247    walk = NULL;
3248    while(( walk = tr_torrentNext( tor->session, walk )))
3249    {
3250        if( old_pos < pos ) {
3251            if( ( old_pos <= walk->queuePosition ) && ( walk->queuePosition <= pos ) ) {
3252                walk->queuePosition--;
3253                walk->anyDate = now;
3254            }
3255        }
3256
3257        if( old_pos > pos ) {
3258            if( ( pos <= walk->queuePosition ) && ( walk->queuePosition < old_pos ) ) {
3259                walk->queuePosition++;
3260                walk->anyDate = now;
3261            }
3262        }
3263
3264        if( back < walk->queuePosition )
3265            back = walk->queuePosition;
3266    }
3267
3268    tor->queuePosition = MIN( pos, (back+1) );
3269    tor->anyDate = now;
3270
3271    assert( queueIsSequenced( tor->session ) );
3272}
3273
3274void
3275tr_torrentsQueueMoveTop( tr_torrent ** torrents_in, int n )
3276{
3277    int i;
3278    tr_torrent ** torrents = tr_memdup( torrents_in, sizeof( tr_torrent * ) * n );
3279    qsort( torrents, n, sizeof( tr_torrent * ), compareTorrentByQueuePosition );
3280    for( i=n-1; i>=0; --i )
3281        tr_torrentSetQueuePosition( torrents[i], 0 );
3282    tr_free( torrents );
3283}
3284
3285void
3286tr_torrentsQueueMoveUp( tr_torrent ** torrents_in, int n )
3287{
3288    int i;
3289    tr_torrent ** torrents = tr_memdup( torrents_in, sizeof( tr_torrent * ) * n );
3290    qsort( torrents, n, sizeof( tr_torrent * ), compareTorrentByQueuePosition );
3291    for( i=0; i<n; ++i )
3292        tr_torrentSetQueuePosition( torrents[i], torrents[i]->queuePosition - 1 );
3293    tr_free( torrents );
3294}
3295
3296void
3297tr_torrentsQueueMoveDown( tr_torrent ** torrents_in, int n )
3298{
3299    int i;
3300    tr_torrent ** torrents = tr_memdup( torrents_in, sizeof( tr_torrent * ) * n );
3301    qsort( torrents, n, sizeof( tr_torrent * ), compareTorrentByQueuePosition );
3302    for( i=n-1; i>=0; --i )
3303        tr_torrentSetQueuePosition( torrents[i], torrents[i]->queuePosition + 1 );
3304    tr_free( torrents );
3305}
3306
3307void
3308tr_torrentsQueueMoveBottom( tr_torrent ** torrents_in, int n )
3309{
3310    int i;
3311    tr_torrent ** torrents = tr_memdup( torrents_in, sizeof( tr_torrent * ) * n );
3312    qsort( torrents, n, sizeof( tr_torrent * ), compareTorrentByQueuePosition );
3313    for( i=0; i<n; ++i )
3314        tr_torrentSetQueuePosition( torrents[i], INT_MAX );
3315    tr_free( torrents );
3316}
3317
3318static void
3319torrentSetQueued( tr_torrent * tor, bool queued )
3320{
3321    assert( tr_isTorrent( tor ) );
3322    assert( tr_isBool( queued ) );
3323
3324    if( tr_torrentIsQueued( tor ) != queued )
3325    {
3326        tor->isQueued = queued;
3327        tor->anyDate = tr_time( );
3328    }
3329}
3330
3331void
3332tr_torrentSetQueueStartCallback( tr_torrent * torrent, void (*callback)( tr_torrent *, void * ), void * user_data )
3333{
3334    torrent->queue_started_callback = callback;
3335    torrent->queue_started_user_data = user_data;
3336}
3337
3338
Note: See TracBrowser for help on using the repository browser.