source: trunk/libtransmission/torrent.c @ 10687

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

(trunk libT) #3233 "torrent.c:1695: error: too few arguments to function `ctime_r'" on OpenSolaris?

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