source: trunk/libtransmission/torrent.c @ 10643

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

(trunk libT) minor API cleanup: constify array arguments in tr_torrentSetFilePriorities(), tr_torrentInitFileDLs(), and tr_torrentSetFileDLs()

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