source: trunk/libtransmission/torrent.c @ 10647

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

(trunk libT) #1869 "new status for torrents that reached the seed ratio" -- use suggestion from Longinus00 to ensure torrents don't get flagged as finished if the user hits "download none" in the "add torrent" dialog

  • Property svn:keywords set to Date Rev Author Id
File size: 74.1 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 10647 2010-05-15 22:26:25Z 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->haveValid is here to make sure a torrent isn't marked 'finished'
1105     * when the user hits "uncheck all" prior to starting the torrent... */
1106    s->finished = seedRatioApplies && !seedRatioBytesLeft && s->haveValid;
1107
1108    if( !seedRatioApplies || s->finished )
1109        s->seedRatioPercentDone = 1;
1110    else if( !seedRatioBytesGoal ) /* impossible? safeguard for div by zero */
1111        s->seedRatioPercentDone = 0;
1112    else
1113        s->seedRatioPercentDone = (double)(seedRatioBytesGoal - seedRatioBytesLeft) / seedRatioBytesGoal;
1114
1115    tr_torrentUnlock( tor );
1116
1117    return s;
1118}
1119
1120/***
1121****
1122***/
1123
1124static uint64_t
1125fileBytesCompleted( const tr_torrent * tor, tr_file_index_t index )
1126{
1127    uint64_t total = 0;
1128    const tr_file * f = &tor->info.files[index];
1129
1130    if( f->length )
1131    {
1132        const tr_block_index_t firstBlock = f->offset / tor->blockSize;
1133        const uint64_t lastByte = f->offset + f->length - 1;
1134        const tr_block_index_t lastBlock = lastByte / tor->blockSize;
1135
1136        if( firstBlock == lastBlock )
1137        {
1138            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1139                total = f->length;
1140        }
1141        else
1142        {
1143            tr_block_index_t i;
1144
1145            /* the first block */
1146            if( tr_cpBlockIsCompleteFast( &tor->completion, firstBlock ) )
1147                total += tor->blockSize - ( f->offset % tor->blockSize );
1148
1149            /* the middle blocks */
1150            if( f->firstPiece == f->lastPiece )
1151            {
1152                for( i=firstBlock+1; i<lastBlock; ++i )
1153                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1154                        total += tor->blockSize;
1155            }
1156            else
1157            {
1158                uint64_t b = 0;
1159                const tr_block_index_t firstBlockOfLastPiece
1160                           = tr_torPieceFirstBlock( tor, f->lastPiece );
1161                const tr_block_index_t lastBlockOfFirstPiece
1162                           = tr_torPieceFirstBlock( tor, f->firstPiece )
1163                             + tr_torPieceCountBlocks( tor, f->firstPiece ) - 1;
1164
1165                /* the rest of the first piece */
1166                for( i=firstBlock+1; i<lastBlock && i<=lastBlockOfFirstPiece; ++i )
1167                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1168                        ++b;
1169
1170                /* the middle pieces */
1171                if( f->firstPiece + 1 < f->lastPiece )
1172                    for( i=f->firstPiece+1; i<f->lastPiece; ++i )
1173                        b += tor->blockCountInPiece - tr_cpMissingBlocksInPiece( &tor->completion, i );
1174
1175                /* the rest of the last piece */
1176                for( i=firstBlockOfLastPiece; i<lastBlock; ++i )
1177                    if( tr_cpBlockIsCompleteFast( &tor->completion, i ) )
1178                        ++b;
1179
1180                b *= tor->blockSize;
1181                total += b;
1182            }
1183
1184            /* the last block */
1185            if( tr_cpBlockIsCompleteFast( &tor->completion, lastBlock ) )
1186                total += ( f->offset + f->length ) - ( tor->blockSize * lastBlock );
1187        }
1188    }
1189
1190    return total;
1191}
1192
1193tr_file_stat *
1194tr_torrentFiles( const tr_torrent * tor,
1195                 tr_file_index_t *  fileCount )
1196{
1197    tr_file_index_t       i;
1198    const tr_file_index_t n = tor->info.fileCount;
1199    tr_file_stat *        files = tr_new0( tr_file_stat, n );
1200    tr_file_stat *        walk = files;
1201    const tr_bool         isSeed = tor->completeness == TR_SEED;
1202
1203    assert( tr_isTorrent( tor ) );
1204
1205    for( i=0; i<n; ++i, ++walk ) {
1206        const uint64_t b = isSeed ? tor->info.files[i].length : fileBytesCompleted( tor, i );
1207        walk->bytesCompleted = b;
1208        walk->progress = tor->info.files[i].length > 0 ? ( (float)b / tor->info.files[i].length ) : 1.0;
1209    }
1210
1211    if( fileCount )
1212        *fileCount = n;
1213
1214    return files;
1215}
1216
1217void
1218tr_torrentFilesFree( tr_file_stat *            files,
1219                     tr_file_index_t fileCount UNUSED )
1220{
1221    tr_free( files );
1222}
1223
1224/***
1225****
1226***/
1227
1228float*
1229tr_torrentWebSpeeds( const tr_torrent * tor )
1230{
1231    return tr_isTorrent( tor )
1232         ? tr_peerMgrWebSpeeds( tor )
1233         : NULL;
1234}
1235
1236tr_peer_stat *
1237tr_torrentPeers( const tr_torrent * tor,
1238                 int *              peerCount )
1239{
1240    tr_peer_stat * ret = NULL;
1241
1242    if( tr_isTorrent( tor ) )
1243        ret = tr_peerMgrPeerStats( tor, peerCount );
1244
1245    return ret;
1246}
1247
1248void
1249tr_torrentPeersFree( tr_peer_stat * peers,
1250                     int peerCount  UNUSED )
1251{
1252    tr_free( peers );
1253}
1254
1255tr_tracker_stat *
1256tr_torrentTrackers( const tr_torrent * torrent,
1257                    int              * setmeTrackerCount )
1258{
1259    assert( tr_isTorrent( torrent ) );
1260
1261    return tr_announcerStats( torrent, setmeTrackerCount );
1262}
1263
1264void
1265tr_torrentTrackersFree( tr_tracker_stat * trackers,
1266                        int trackerCount )
1267{
1268    tr_announcerStatsFree( trackers, trackerCount );
1269}
1270
1271void
1272tr_torrentAvailability( const tr_torrent * tor,
1273                        int8_t *           tab,
1274                        int                size )
1275{
1276    tr_peerMgrTorrentAvailability( tor, tab, size );
1277}
1278
1279void
1280tr_torrentAmountFinished( const tr_torrent * tor,
1281                          float *            tab,
1282                          int                size )
1283{
1284    assert( tr_isTorrent( tor ) );
1285
1286    tr_torrentLock( tor );
1287    tr_cpGetAmountDone( &tor->completion, tab, size );
1288    tr_torrentUnlock( tor );
1289}
1290
1291static void
1292tr_torrentResetTransferStats( tr_torrent * tor )
1293{
1294    assert( tr_isTorrent( tor ) );
1295
1296    tr_torrentLock( tor );
1297
1298    tor->downloadedPrev += tor->downloadedCur;
1299    tor->downloadedCur   = 0;
1300    tor->uploadedPrev   += tor->uploadedCur;
1301    tor->uploadedCur     = 0;
1302    tor->corruptPrev    += tor->corruptCur;
1303    tor->corruptCur      = 0;
1304
1305    tr_torrentSetDirty( tor );
1306
1307    tr_torrentUnlock( tor );
1308}
1309
1310void
1311tr_torrentSetHasPiece( tr_torrent *     tor,
1312                       tr_piece_index_t pieceIndex,
1313                       tr_bool          has )
1314{
1315    assert( tr_isTorrent( tor ) );
1316    assert( pieceIndex < tor->info.pieceCount );
1317
1318    if( has )
1319        tr_cpPieceAdd( &tor->completion, pieceIndex );
1320    else
1321        tr_cpPieceRem( &tor->completion, pieceIndex );
1322}
1323
1324/***
1325****
1326***/
1327
1328static void
1329freeTorrent( tr_torrent * tor )
1330{
1331    tr_torrent * t;
1332    tr_session *  session = tor->session;
1333    tr_info *    inf = &tor->info;
1334
1335    assert( tr_isTorrent( tor ) );
1336    assert( !tor->isRunning );
1337
1338    tr_sessionLock( session );
1339
1340    tr_peerMgrRemoveTorrent( tor );
1341
1342    tr_cpDestruct( &tor->completion );
1343
1344    tr_announcerUnsubscribe( tor->tiers, tor->tiersSubscription );
1345    tr_announcerRemoveTorrent( session->announcer, tor );
1346
1347    tr_bitfieldDestruct( &tor->checkedPieces );
1348
1349    tr_free( tor->downloadDir );
1350    tr_free( tor->incompleteDir );
1351    tr_free( tor->peer_id );
1352
1353    if( tor == session->torrentList )
1354        session->torrentList = tor->next;
1355    else for( t = session->torrentList; t != NULL; t = t->next ) {
1356        if( t->next == tor ) {
1357            t->next = tor->next;
1358            break;
1359        }
1360    }
1361
1362    assert( session->torrentCount >= 1 );
1363    session->torrentCount--;
1364
1365    tr_bandwidthFree( tor->bandwidth );
1366
1367    tr_metainfoFree( inf );
1368    tr_free( tor );
1369
1370    tr_sessionUnlock( session );
1371}
1372
1373/**
1374***  Start/Stop Callback
1375**/
1376
1377static void
1378checkAndStartImpl( void * vtor )
1379{
1380    tr_torrent * tor = vtor;
1381
1382    assert( tr_isTorrent( tor ) );
1383
1384    tr_sessionLock( tor->session );
1385
1386    /** If we had local data before, but it's disappeared,
1387        stop the torrent and log an error. */
1388    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1389    {
1390        tr_torrentSetLocalError( tor, _( "No data found!  Reconnect any disconnected drives, use \"Set Location\", or restart the torrent to re-download." ) );
1391        tr_torrentStop( tor );
1392    }
1393    else
1394    {
1395        const time_t now = tr_time( );
1396        tor->isRunning = TRUE;
1397        tor->error = TR_STAT_OK;
1398        tor->errorString[0] = '\0';
1399        tor->completeness = tr_cpGetStatus( &tor->completion );
1400        tor->startDate = tor->anyDate = now;
1401
1402        tr_torrentResetTransferStats( tor );
1403        tr_announcerTorrentStarted( tor );
1404        tor->dhtAnnounceAt = now + tr_cryptoWeakRandInt( 20 );
1405        tor->dhtAnnounce6At = now + tr_cryptoWeakRandInt( 20 );
1406        tor->lpdAnnounceAt = now;
1407        tr_peerMgrStartTorrent( tor );
1408    }
1409
1410    tr_sessionUnlock( tor->session );
1411}
1412
1413static void
1414checkAndStartCB( tr_torrent * tor )
1415{
1416    assert( tr_isTorrent( tor ) );
1417    assert( tr_isSession( tor->session ) );
1418
1419    tr_runInEventThread( tor->session, checkAndStartImpl, tor );
1420}
1421
1422static void
1423torrentStart( tr_torrent * tor )
1424{
1425    assert( tr_isTorrent( tor ) );
1426
1427    tr_sessionLock( tor->session );
1428
1429    if( !tor->isRunning )
1430    {
1431        /* allow finished torrents to be resumed */
1432        if( tr_torrentIsSeedRatioDone( tor ) )
1433        {
1434            tr_torinf( tor, "Restarted manually -- disabling its seed ratio" );
1435            tr_torrentSetRatioMode( tor, TR_RATIOLIMIT_UNLIMITED );
1436        }
1437
1438        tr_verifyRemove( tor );
1439
1440        /* corresponds to the peer_id sent as a tracker request parameter.
1441         * one tracker admin says: "When the same torrent is opened and
1442         * closed and opened again without quitting Transmission ...
1443         * change the peerid. It would help sometimes if a stopped event
1444         * was missed to ensure that we didn't think someone was cheating. */
1445        tr_free( tor->peer_id );
1446        tor->peer_id = tr_peerIdNew( );
1447
1448        tor->isRunning = 1;
1449        tr_torrentSetDirty( tor );
1450        tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1451        tr_verifyAdd( tor, checkAndStartCB );
1452    }
1453
1454    tr_sessionUnlock( tor->session );
1455}
1456
1457void
1458tr_torrentStart( tr_torrent * tor )
1459{
1460    if( tr_isTorrent( tor ) )
1461        torrentStart( tor );
1462}
1463
1464static void
1465torrentRecheckDoneImpl( void * vtor )
1466{
1467    tr_torrent * tor = vtor;
1468
1469    assert( tr_isTorrent( tor ) );
1470    tr_torrentRecheckCompleteness( tor );
1471
1472    if( tor->preVerifyTotal && !tr_cpHaveTotal( &tor->completion ) )
1473    {
1474        tr_torrentSetLocalError( tor, _( "Can't find local data.  Try \"Set Location\" to find it, or restart the torrent to re-download." ) );
1475        tr_torrentStop( tor );
1476    }
1477    else if( tor->startAfterVerify )
1478    {
1479        tor->startAfterVerify = FALSE;
1480
1481        tr_torrentStart( tor );
1482    }
1483}
1484
1485static void
1486torrentRecheckDoneCB( tr_torrent * tor )
1487{
1488    assert( tr_isTorrent( tor ) );
1489
1490    tr_runInEventThread( tor->session, torrentRecheckDoneImpl, tor );
1491}
1492
1493static void
1494verifyTorrent( void * vtor )
1495{
1496    tr_torrent * tor = vtor;
1497
1498    assert( tr_isTorrent( tor ) );
1499    tr_sessionLock( tor->session );
1500
1501    /* if the torrent's already being verified, stop it */
1502    tr_verifyRemove( tor );
1503
1504    /* if the torrent's running, stop it & set the restart-after-verify flag */
1505    if( tor->startAfterVerify || tor->isRunning ) {
1506        tr_torrentStop( tor );
1507        tor->startAfterVerify = TRUE;
1508    }
1509
1510    /* add the torrent to the recheck queue */
1511    tor->preVerifyTotal = tr_cpHaveTotal( &tor->completion );
1512    tr_torrentUncheck( tor );
1513    tr_verifyAdd( tor, torrentRecheckDoneCB );
1514
1515    tr_sessionUnlock( tor->session );
1516}
1517
1518void
1519tr_torrentVerify( tr_torrent * tor )
1520{
1521    if( tr_isTorrent( tor ) )
1522        tr_runInEventThread( tor->session, verifyTorrent, tor );
1523}
1524
1525void
1526tr_torrentSave( tr_torrent * tor )
1527{
1528    assert( tr_isTorrent( tor ) );
1529
1530    if( tor->isDirty )
1531    {
1532        tor->isDirty = FALSE;
1533        tr_torrentSaveResume( tor );
1534    }
1535}
1536
1537static void
1538stopTorrent( void * vtor )
1539{
1540    tr_torrent * tor = vtor;
1541    tr_torinf( tor, "Pausing" );
1542
1543    assert( tr_isTorrent( tor ) );
1544
1545    tr_verifyRemove( tor );
1546    tr_peerMgrStopTorrent( tor );
1547    tr_announcerTorrentStopped( tor );
1548
1549    tr_fdTorrentClose( tor->session, tor->uniqueId );
1550
1551    if( !tor->isDeleting )
1552        tr_torrentSave( tor );
1553}
1554
1555void
1556tr_torrentStop( tr_torrent * tor )
1557{
1558    assert( tr_isTorrent( tor ) );
1559
1560    if( tr_isTorrent( tor ) )
1561    {
1562        tr_sessionLock( tor->session );
1563
1564        tor->isRunning = 0;
1565        tr_torrentSetDirty( tor );
1566        tr_runInEventThread( tor->session, stopTorrent, tor );
1567
1568        tr_sessionUnlock( tor->session );
1569    }
1570}
1571
1572static void
1573closeTorrent( void * vtor )
1574{
1575    tr_benc * d;
1576    tr_torrent * tor = vtor;
1577
1578    assert( tr_isTorrent( tor ) );
1579
1580    d = tr_bencListAddDict( &tor->session->removedTorrents, 2 );
1581    tr_bencDictAddInt( d, "id", tor->uniqueId );
1582    tr_bencDictAddInt( d, "date", tr_time( ) );
1583
1584    tr_torinf( tor, _( "Removing torrent" ) );
1585
1586    stopTorrent( tor );
1587
1588    if( tor->isDeleting )
1589    {
1590        tr_metainfoRemoveSaved( tor->session, &tor->info );
1591        tr_torrentRemoveResume( tor );
1592    }
1593
1594    tor->isRunning = 0;
1595    freeTorrent( tor );
1596}
1597
1598void
1599tr_torrentFree( tr_torrent * tor )
1600{
1601    if( tr_isTorrent( tor ) )
1602    {
1603        tr_session * session = tor->session;
1604        assert( tr_isSession( session ) );
1605        tr_sessionLock( session );
1606
1607        tr_torrentClearCompletenessCallback( tor );
1608        tr_runInEventThread( session, closeTorrent, tor );
1609
1610        tr_sessionUnlock( session );
1611    }
1612}
1613
1614void
1615tr_torrentRemove( tr_torrent * tor )
1616{
1617    assert( tr_isTorrent( tor ) );
1618
1619    tor->isDeleting = 1;
1620    tr_torrentFree( tor );
1621}
1622
1623/**
1624***  Completeness
1625**/
1626
1627static const char *
1628getCompletionString( int type )
1629{
1630    switch( type )
1631    {
1632        /* Translators: this is a minor point that's safe to skip over, but FYI:
1633           "Complete" and "Done" are specific, different terms in Transmission:
1634           "Complete" means we've downloaded every file in the torrent.
1635           "Done" means we're done downloading the files we wanted, but NOT all
1636           that exist */
1637        case TR_PARTIAL_SEED:
1638            return _( "Done" );
1639
1640        case TR_SEED:
1641            return _( "Complete" );
1642
1643        default:
1644            return _( "Incomplete" );
1645    }
1646}
1647
1648static void
1649fireCompletenessChange( tr_torrent       * tor,
1650                        tr_completeness    status )
1651{
1652    assert( tr_isTorrent( tor ) );
1653    assert( ( status == TR_LEECH )
1654         || ( status == TR_SEED )
1655         || ( status == TR_PARTIAL_SEED ) );
1656
1657    if( tor->completeness_func )
1658        tor->completeness_func( tor, status, tor->completeness_func_user_data );
1659}
1660
1661void
1662tr_torrentSetCompletenessCallback( tr_torrent                    * tor,
1663                                   tr_torrent_completeness_func    func,
1664                                   void                          * user_data )
1665{
1666    assert( tr_isTorrent( tor ) );
1667
1668    tor->completeness_func = func;
1669    tor->completeness_func_user_data = user_data;
1670}
1671
1672void
1673tr_torrentClearCompletenessCallback( tr_torrent * torrent )
1674{
1675    tr_torrentSetCompletenessCallback( torrent, NULL, NULL );
1676}
1677
1678void
1679tr_torrentSetRatioLimitHitCallback( tr_torrent                     * tor,
1680                                    tr_torrent_ratio_limit_hit_func  func,
1681                                    void                           * user_data )
1682{
1683    assert( tr_isTorrent( tor ) );
1684
1685    tor->ratio_limit_hit_func = func;
1686    tor->ratio_limit_hit_func_user_data = user_data;
1687}
1688
1689void
1690tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent )
1691{
1692    tr_torrentSetRatioLimitHitCallback( torrent, NULL, NULL );
1693}
1694
1695
1696static void
1697torrentCallScript( tr_torrent * tor, const char * script )
1698{
1699    assert( tr_isTorrent( tor ) );
1700
1701    if( script && *script )
1702    {
1703        char buf[128];
1704        const time_t now = tr_time( );
1705
1706#ifdef HAVE_CLEARENV
1707        clearenv( );
1708#endif
1709
1710        setenv( "TR_APP_VERSION", SHORT_VERSION_STRING, 1 );
1711
1712        tr_snprintf( buf, sizeof( buf ), "%d", tr_torrentId( tor ) );
1713        setenv( "TR_TORRENT_ID", buf, 1 );
1714        setenv( "TR_TORRENT_NAME", tr_torrentName( tor ), 1 );
1715        setenv( "TR_TORRENT_DIR", tor->currentDir, 1 );
1716        setenv( "TR_TORRENT_HASH", tor->info.hashString, 1 );
1717        ctime_r( &now, buf );
1718        *strchr( buf,'\n' ) = '\0';
1719        setenv( "TR_TIME_LOCALTIME", buf, 1 );
1720        tr_torinf( tor, "Calling script \"%s\"", script );
1721        system( script );
1722    }
1723}
1724
1725void
1726tr_torrentRecheckCompleteness( tr_torrent * tor )
1727{
1728    tr_completeness completeness;
1729
1730    assert( tr_isTorrent( tor ) );
1731
1732    tr_torrentLock( tor );
1733
1734    completeness = tr_cpGetStatus( &tor->completion );
1735
1736    if( completeness != tor->completeness )
1737    {
1738        const int recentChange = tor->downloadedCur != 0;
1739
1740        if( recentChange )
1741        {
1742            tr_torinf( tor, _( "State changed from \"%1$s\" to \"%2$s\"" ),
1743                      getCompletionString( tor->completeness ),
1744                      getCompletionString( completeness ) );
1745        }
1746
1747        tor->completeness = completeness;
1748        tr_fdTorrentClose( tor->session, tor->uniqueId );
1749
1750        if( tr_torrentIsSeed( tor ) )
1751        {
1752            tr_torrentCheckSeedRatio( tor );
1753
1754            if( tor->currentDir == tor->incompleteDir )
1755                tr_torrentSetLocation( tor, tor->downloadDir, TRUE, NULL, NULL );
1756
1757            if( tr_sessionIsTorrentDoneScriptEnabled( tor->session ) )
1758                torrentCallScript( tor, tr_sessionGetTorrentDoneScript( tor->session ) );
1759        }
1760
1761        fireCompletenessChange( tor, completeness );
1762
1763        if( recentChange && tr_torrentIsSeed( tor ) )
1764        {
1765            tr_announcerTorrentCompleted( tor );
1766
1767            tor->doneDate = tor->anyDate = tr_time( );
1768        }
1769
1770        tr_torrentSetDirty( tor );
1771    }
1772
1773    tr_torrentUnlock( tor );
1774}
1775
1776/***
1777****
1778***/
1779
1780static void
1781tr_torrentFireMetadataCompleted( tr_torrent * tor )
1782{
1783    assert( tr_isTorrent( tor ) );
1784
1785    if( tor->metadata_func )
1786        tor->metadata_func( tor, tor->metadata_func_user_data );
1787}
1788
1789void
1790tr_torrentSetMetadataCallback( tr_torrent                * tor,
1791                               tr_torrent_metadata_func    func,
1792                               void                      * user_data )
1793{
1794    assert( tr_isTorrent( tor ) );
1795
1796    tor->metadata_func = func;
1797    tor->metadata_func_user_data = user_data;
1798}
1799
1800
1801/**
1802***  File priorities
1803**/
1804
1805void
1806tr_torrentInitFilePriority( tr_torrent *    tor,
1807                            tr_file_index_t fileIndex,
1808                            tr_priority_t   priority )
1809{
1810    tr_piece_index_t i;
1811    tr_file *        file;
1812
1813    assert( tr_isTorrent( tor ) );
1814    assert( fileIndex < tor->info.fileCount );
1815    assert( tr_isPriority( priority ) );
1816
1817    file = &tor->info.files[fileIndex];
1818    file->priority = priority;
1819    for( i = file->firstPiece; i <= file->lastPiece; ++i )
1820        tor->info.pieces[i].priority = calculatePiecePriority( tor, i, fileIndex );
1821}
1822
1823void
1824tr_torrentSetFilePriorities( tr_torrent             * tor,
1825                             const tr_file_index_t  * files,
1826                             tr_file_index_t          fileCount,
1827                             tr_priority_t            priority )
1828{
1829    tr_file_index_t i;
1830    assert( tr_isTorrent( tor ) );
1831    tr_torrentLock( tor );
1832
1833    for( i = 0; i < fileCount; ++i )
1834        if( files[i] < tor->info.fileCount )
1835            tr_torrentInitFilePriority( tor, files[i], priority );
1836    tr_torrentSetDirty( tor );
1837    tr_peerMgrRebuildRequests( tor );
1838
1839    tr_torrentUnlock( tor );
1840}
1841
1842tr_priority_t*
1843tr_torrentGetFilePriorities( const tr_torrent * tor )
1844{
1845    tr_file_index_t i;
1846    tr_priority_t * p;
1847
1848    assert( tr_isTorrent( tor ) );
1849
1850    tr_torrentLock( tor );
1851    p = tr_new0( tr_priority_t, tor->info.fileCount );
1852    for( i = 0; i < tor->info.fileCount; ++i )
1853        p[i] = tor->info.files[i].priority;
1854    tr_torrentUnlock( tor );
1855
1856    return p;
1857}
1858
1859/**
1860***  File DND
1861**/
1862
1863static void
1864setFileDND( tr_torrent * tor, tr_file_index_t fileIndex, int doDownload )
1865{
1866    tr_file *        file;
1867    const int        dnd = !doDownload;
1868    tr_piece_index_t firstPiece, firstPieceDND;
1869    tr_piece_index_t lastPiece, lastPieceDND;
1870    tr_file_index_t  i;
1871
1872    assert( tr_isTorrent( tor ) );
1873
1874    file = &tor->info.files[fileIndex];
1875    file->dnd = dnd;
1876    firstPiece = file->firstPiece;
1877    lastPiece = file->lastPiece;
1878
1879    /* can't set the first piece to DND unless
1880       every file using that piece is DND */
1881    firstPieceDND = dnd;
1882    if( fileIndex > 0 )
1883    {
1884        for( i = fileIndex - 1; firstPieceDND; --i )
1885        {
1886            if( tor->info.files[i].lastPiece != firstPiece )
1887                break;
1888            firstPieceDND = tor->info.files[i].dnd;
1889            if( !i )
1890                break;
1891        }
1892    }
1893
1894    /* can't set the last piece to DND unless
1895       every file using that piece is DND */
1896    lastPieceDND = dnd;
1897    for( i = fileIndex + 1; lastPieceDND && i < tor->info.fileCount; ++i )
1898    {
1899        if( tor->info.files[i].firstPiece != lastPiece )
1900            break;
1901        lastPieceDND = tor->info.files[i].dnd;
1902    }
1903
1904    if( firstPiece == lastPiece )
1905    {
1906        tor->info.pieces[firstPiece].dnd = firstPieceDND && lastPieceDND;
1907    }
1908    else
1909    {
1910        tr_piece_index_t pp;
1911        tor->info.pieces[firstPiece].dnd = firstPieceDND;
1912        tor->info.pieces[lastPiece].dnd = lastPieceDND;
1913        for( pp = firstPiece + 1; pp < lastPiece; ++pp )
1914            tor->info.pieces[pp].dnd = dnd;
1915    }
1916}
1917
1918void
1919tr_torrentInitFileDLs( tr_torrent             * tor,
1920                       const tr_file_index_t  * files,
1921                       tr_file_index_t          fileCount,
1922                       tr_bool                  doDownload )
1923{
1924    tr_file_index_t i;
1925
1926    assert( tr_isTorrent( tor ) );
1927
1928    tr_torrentLock( tor );
1929
1930    for( i=0; i<fileCount; ++i )
1931        if( files[i] < tor->info.fileCount )
1932            setFileDND( tor, files[i], doDownload );
1933
1934    tr_cpInvalidateDND( &tor->completion );
1935
1936    tr_torrentUnlock( tor );
1937}
1938
1939void
1940tr_torrentSetFileDLs( tr_torrent             * tor,
1941                      const tr_file_index_t  * files,
1942                      tr_file_index_t          fileCount,
1943                      tr_bool                  doDownload )
1944{
1945    assert( tr_isTorrent( tor ) );
1946    tr_torrentLock( tor );
1947
1948    tr_torrentInitFileDLs( tor, files, fileCount, doDownload );
1949    tr_torrentSetDirty( tor );
1950    tr_peerMgrRebuildRequests( tor );
1951
1952    tr_torrentUnlock( tor );
1953}
1954
1955/***
1956****
1957***/
1958
1959tr_priority_t
1960tr_torrentGetPriority( const tr_torrent * tor )
1961{
1962    assert( tr_isTorrent( tor ) );
1963
1964    return tor->bandwidth->priority;
1965}
1966
1967void
1968tr_torrentSetPriority( tr_torrent * tor, tr_priority_t priority )
1969{
1970    assert( tr_isTorrent( tor ) );
1971    assert( tr_isPriority( priority ) );
1972
1973    if( tor->bandwidth->priority != priority )
1974    {
1975        tor->bandwidth->priority = priority;
1976
1977        tr_torrentSetDirty( tor );
1978    }
1979}
1980
1981/***
1982****
1983***/
1984
1985void
1986tr_torrentSetPeerLimit( tr_torrent * tor,
1987                        uint16_t     maxConnectedPeers )
1988{
1989    assert( tr_isTorrent( tor ) );
1990
1991    if ( tor->maxConnectedPeers != maxConnectedPeers )
1992    {
1993        tor->maxConnectedPeers = maxConnectedPeers;
1994
1995        tr_torrentSetDirty( tor );
1996    }
1997}
1998
1999uint16_t
2000tr_torrentGetPeerLimit( const tr_torrent * tor )
2001{
2002    assert( tr_isTorrent( tor ) );
2003
2004    return tor->maxConnectedPeers;
2005}
2006
2007/***
2008****
2009***/
2010
2011tr_block_index_t
2012_tr_block( const tr_torrent * tor,
2013           tr_piece_index_t   index,
2014           uint32_t           offset )
2015{
2016    tr_block_index_t ret;
2017
2018    assert( tr_isTorrent( tor ) );
2019
2020    ret = index;
2021    ret *= ( tor->info.pieceSize / tor->blockSize );
2022    ret += offset / tor->blockSize;
2023    return ret;
2024}
2025
2026tr_bool
2027tr_torrentReqIsValid( const tr_torrent * tor,
2028                      tr_piece_index_t   index,
2029                      uint32_t           offset,
2030                      uint32_t           length )
2031{
2032    int err = 0;
2033
2034    assert( tr_isTorrent( tor ) );
2035
2036    if( index >= tor->info.pieceCount )
2037        err = 1;
2038    else if( length < 1 )
2039        err = 2;
2040    else if( ( offset + length ) > tr_torPieceCountBytes( tor, index ) )
2041        err = 3;
2042    else if( length > MAX_BLOCK_SIZE )
2043        err = 4;
2044    else if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
2045        err = 5;
2046
2047    if( err ) tr_tordbg( tor, "index %lu offset %lu length %lu err %d\n",
2048                              (unsigned long)index,
2049                              (unsigned long)offset,
2050                              (unsigned long)length,
2051                              err );
2052
2053    return !err;
2054}
2055
2056uint64_t
2057tr_pieceOffset( const tr_torrent * tor,
2058                tr_piece_index_t   index,
2059                uint32_t           offset,
2060                uint32_t           length )
2061{
2062    uint64_t ret;
2063
2064    assert( tr_isTorrent( tor ) );
2065
2066    ret = tor->info.pieceSize;
2067    ret *= index;
2068    ret += offset;
2069    ret += length;
2070    return ret;
2071}
2072
2073/***
2074****
2075***/
2076
2077void
2078tr_torrentSetPieceChecked( tr_torrent        * tor,
2079                           tr_piece_index_t    piece,
2080                           tr_bool             isChecked )
2081{
2082    assert( tr_isTorrent( tor ) );
2083
2084    if( isChecked )
2085        tr_bitfieldAdd( &tor->checkedPieces, piece );
2086    else
2087        tr_bitfieldRem( &tor->checkedPieces, piece );
2088}
2089
2090void
2091tr_torrentSetFileChecked( tr_torrent *    tor,
2092                          tr_file_index_t fileIndex,
2093                          tr_bool         isChecked )
2094{
2095    const tr_file *        file = &tor->info.files[fileIndex];
2096    const tr_piece_index_t begin = file->firstPiece;
2097    const tr_piece_index_t end = file->lastPiece + 1;
2098
2099    assert( tr_isTorrent( tor ) );
2100
2101    if( isChecked )
2102        tr_bitfieldAddRange( &tor->checkedPieces, begin, end );
2103    else
2104        tr_bitfieldRemRange( &tor->checkedPieces, begin, end );
2105}
2106
2107tr_bool
2108tr_torrentIsFileChecked( const tr_torrent * tor,
2109                         tr_file_index_t    fileIndex )
2110{
2111    const tr_file *        file = &tor->info.files[fileIndex];
2112    const tr_piece_index_t begin = file->firstPiece;
2113    const tr_piece_index_t end = file->lastPiece + 1;
2114    tr_piece_index_t       i;
2115    tr_bool                isChecked = TRUE;
2116
2117    assert( tr_isTorrent( tor ) );
2118
2119    for( i = begin; isChecked && i < end; ++i )
2120        if( !tr_torrentIsPieceChecked( tor, i ) )
2121            isChecked = FALSE;
2122
2123    return isChecked;
2124}
2125
2126void
2127tr_torrentUncheck( tr_torrent * tor )
2128{
2129    assert( tr_isTorrent( tor ) );
2130
2131    tr_bitfieldRemRange( &tor->checkedPieces, 0, tor->info.pieceCount );
2132}
2133
2134int
2135tr_torrentCountUncheckedPieces( const tr_torrent * tor )
2136{
2137    assert( tr_isTorrent( tor ) );
2138
2139    return tor->info.pieceCount - tr_bitfieldCountTrueBits( &tor->checkedPieces );
2140}
2141
2142time_t*
2143tr_torrentGetMTimes( const tr_torrent * tor, size_t * setme_n )
2144{
2145    size_t       i;
2146    const size_t n = tor->info.fileCount;
2147    time_t *     m = tr_new0( time_t, n );
2148
2149    assert( tr_isTorrent( tor ) );
2150
2151    for( i = 0; i < n; ++i )
2152    {
2153        struct stat sb;
2154        char * path = tr_torrentFindFile( tor, i );
2155        if( ( path != NULL ) && !stat( path, &sb ) && S_ISREG( sb.st_mode ) )
2156        {
2157#ifdef SYS_DARWIN
2158            m[i] = sb.st_mtimespec.tv_sec;
2159#else
2160            m[i] = sb.st_mtime;
2161#endif
2162        }
2163        tr_free( path );
2164    }
2165
2166    *setme_n = n;
2167    return m;
2168}
2169
2170/***
2171****
2172***/
2173
2174tr_bool
2175tr_torrentSetAnnounceList( tr_torrent             * tor,
2176                           const tr_tracker_info  * trackers,
2177                           int                      trackerCount )
2178{
2179    int i;
2180    tr_benc metainfo;
2181    tr_bool ok = TRUE;
2182    tr_torrentLock( tor );
2183
2184    assert( tr_isTorrent( tor ) );
2185
2186    /* look for bad URLs */
2187    for( i=0; ok && i<trackerCount; ++i )
2188        if( !tr_urlIsValidTracker( trackers[i].announce ) )
2189            ok = FALSE;
2190
2191    /* save to the .torrent file */
2192    if( ok && !tr_bencLoadFile( &metainfo, TR_FMT_BENC, tor->info.torrent ) )
2193    {
2194        tr_bool hasInfo;
2195        tr_info tmpInfo;
2196
2197        /* remove the old fields */
2198        tr_bencDictRemove( &metainfo, "announce" );
2199        tr_bencDictRemove( &metainfo, "announce-list" );
2200
2201        /* add the new fields */
2202        if( trackerCount > 0 )
2203        {
2204            tr_bencDictAddStr( &metainfo, "announce", trackers[0].announce );
2205        }
2206        if( trackerCount > 1 )
2207        {
2208            int i;
2209            int prevTier = -1;
2210            tr_benc * tier = NULL;
2211            tr_benc * announceList = tr_bencDictAddList( &metainfo, "announce-list", 0 );
2212
2213            for( i=0; i<trackerCount; ++i ) {
2214                if( prevTier != trackers[i].tier ) {
2215                    prevTier = trackers[i].tier;
2216                    tier = tr_bencListAddList( announceList, 0 );
2217                }
2218                tr_bencListAddStr( tier, trackers[i].announce );
2219            }
2220        }
2221
2222        /* try to parse it back again, to make sure it's good */
2223        memset( &tmpInfo, 0, sizeof( tr_info ) );
2224        if( tr_metainfoParse( tor->session, &metainfo, &tmpInfo,
2225                              &hasInfo, &tor->infoDictOffset, &tor->infoDictLength ) )
2226        {
2227            /* it's good, so keep these new trackers and free the old ones */
2228
2229            tr_info swap;
2230            swap.trackers = tor->info.trackers;
2231            swap.trackerCount = tor->info.trackerCount;
2232            tor->info.trackers = tmpInfo.trackers;
2233            tor->info.trackerCount = tmpInfo.trackerCount;
2234            tmpInfo.trackers = swap.trackers;
2235            tmpInfo.trackerCount = swap.trackerCount;
2236
2237            tr_metainfoFree( &tmpInfo );
2238            tr_bencToFile( &metainfo, TR_FMT_BENC, tor->info.torrent );
2239        }
2240
2241        /* cleanup */
2242        tr_bencFree( &metainfo );
2243
2244        /* tell the announcer to reload this torrent's tracker list */
2245        tr_announcerResetTorrent( tor->session->announcer, tor );
2246    }
2247
2248    tr_torrentUnlock( tor );
2249    return ok;
2250}
2251
2252/**
2253***
2254**/
2255
2256void
2257tr_torrentSetAddedDate( tr_torrent * tor,
2258                        time_t       t )
2259{
2260    assert( tr_isTorrent( tor ) );
2261
2262    tor->addedDate = t;
2263    tor->anyDate = MAX( tor->anyDate, tor->addedDate );
2264}
2265
2266void
2267tr_torrentSetActivityDate( tr_torrent * tor, time_t t )
2268{
2269    assert( tr_isTorrent( tor ) );
2270
2271    tor->activityDate = t;
2272    tor->anyDate = MAX( tor->anyDate, tor->activityDate );
2273}
2274
2275void
2276tr_torrentSetDoneDate( tr_torrent * tor,
2277                       time_t       t )
2278{
2279    assert( tr_isTorrent( tor ) );
2280
2281    tor->doneDate = t;
2282    tor->anyDate = MAX( tor->anyDate, tor->doneDate );
2283}
2284
2285/**
2286***
2287**/
2288
2289uint64_t
2290tr_torrentGetBytesLeftToAllocate( const tr_torrent * tor )
2291{
2292    tr_file_index_t i;
2293    uint64_t bytesLeft = 0;
2294
2295    assert( tr_isTorrent( tor ) );
2296
2297    for( i=0; i<tor->info.fileCount; ++i )
2298    {
2299        if( !tor->info.files[i].dnd )
2300        {
2301            struct stat sb;
2302            const uint64_t length = tor->info.files[i].length;
2303            char * path = tr_torrentFindFile( tor, i );
2304
2305            bytesLeft += length;
2306
2307            if( ( path != NULL ) && !stat( path, &sb )
2308                                 && S_ISREG( sb.st_mode )
2309                                 && ( (uint64_t)sb.st_size <= length ) )
2310                bytesLeft -= sb.st_size;
2311
2312            tr_free( path );
2313        }
2314    }
2315
2316    return bytesLeft;
2317}
2318
2319/****
2320*****  Removing the torrent's local data
2321****/
2322
2323static int
2324vstrcmp( const void * a, const void * b )
2325{
2326    return strcmp( a, b );
2327}
2328
2329static int
2330compareLongestFirst( const void * a, const void * b )
2331{
2332    const size_t alen = strlen( a );
2333    const size_t blen = strlen( b );
2334
2335    if( alen != blen )
2336        return alen > blen ? -1 : 1;
2337
2338    return vstrcmp( a, b );
2339}
2340
2341static void
2342addDirtyFile( const char  * root,
2343              const char  * filename,
2344              tr_ptrArray * dirtyFolders )
2345{
2346    char * dir = tr_dirname( filename );
2347
2348    /* add the parent folders to dirtyFolders until we reach the root or a known-dirty */
2349    while (     ( dir != NULL )
2350             && ( strlen( root ) <= strlen( dir ) )
2351             && ( tr_ptrArrayFindSorted( dirtyFolders, dir, vstrcmp ) == NULL ) )
2352    {
2353        char * tmp;
2354        tr_ptrArrayInsertSorted( dirtyFolders, tr_strdup( dir ), vstrcmp );
2355
2356        tmp = tr_dirname( dir );
2357        tr_free( dir );
2358        dir = tmp;
2359    }
2360
2361    tr_free( dir );
2362}
2363
2364static void
2365walkLocalData( const tr_torrent * tor,
2366               const char       * root,
2367               const char       * dir,
2368               const char       * base,
2369               tr_ptrArray      * torrentFiles,
2370               tr_ptrArray      * folders,
2371               tr_ptrArray      * dirtyFolders )
2372{
2373    int i;
2374    struct stat sb;
2375    char * buf;
2376
2377    assert( tr_isTorrent( tor ) );
2378
2379    buf = tr_buildPath( dir, base, NULL );
2380    i = stat( buf, &sb );
2381    if( !i )
2382    {
2383        DIR * odir = NULL;
2384
2385        if( S_ISDIR( sb.st_mode ) && ( ( odir = opendir ( buf ) ) ) )
2386        {
2387            struct dirent *d;
2388            tr_ptrArrayInsertSorted( folders, tr_strdup( buf ), vstrcmp );
2389            for( d = readdir( odir ); d != NULL; d = readdir( odir ) )
2390                if( d->d_name && d->d_name[0] != '.' ) /* skip dotfiles */
2391                    walkLocalData( tor, root, buf, d->d_name, torrentFiles, folders, dirtyFolders );
2392            closedir( odir );
2393        }
2394        else if( S_ISREG( sb.st_mode ) && ( sb.st_size > 0 ) )
2395        {
2396            const char * sub = buf + strlen( tor->currentDir ) + strlen( TR_PATH_DELIMITER_STR );
2397            const tr_bool isTorrentFile = tr_ptrArrayFindSorted( torrentFiles, sub, vstrcmp ) != NULL;
2398            if( !isTorrentFile )
2399                addDirtyFile( root, buf, dirtyFolders );
2400        }
2401    }
2402
2403    tr_free( buf );
2404}
2405
2406static void
2407deleteLocalFile( const char * filename, tr_fileFunc fileFunc )
2408{
2409    struct stat sb;
2410    if( !stat( filename, &sb ) ) /* if file exists... */
2411        fileFunc( filename );
2412}
2413
2414static void
2415deleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2416{
2417    int i, n;
2418    char ** s;
2419    tr_file_index_t f;
2420    tr_ptrArray torrentFiles = TR_PTR_ARRAY_INIT;
2421    tr_ptrArray folders      = TR_PTR_ARRAY_INIT;
2422    tr_ptrArray dirtyFolders = TR_PTR_ARRAY_INIT; /* dirty == contains non-torrent files */
2423
2424    const char * firstFile = tor->info.files[0].name;
2425    const char * cpch = strchr( firstFile, TR_PATH_DELIMITER );
2426    char * tmp = cpch ? tr_strndup( firstFile, cpch - firstFile ) : NULL;
2427    char * root = tr_buildPath( tor->currentDir, tmp, NULL );
2428
2429    assert( tr_isTorrent( tor ) );
2430
2431    for( f=0; f<tor->info.fileCount; ++f ) {
2432        tr_ptrArrayInsertSorted( &torrentFiles, tr_strdup( tor->info.files[f].name ), vstrcmp );
2433        tr_ptrArrayInsertSorted( &torrentFiles, tr_torrentBuildPartial( tor, f ), vstrcmp );
2434    }
2435
2436    /* build the set of folders and dirtyFolders */
2437    walkLocalData( tor, root, root, NULL, &torrentFiles, &folders, &dirtyFolders );
2438
2439    /* try to remove entire folders first, so that the recycle bin will be tidy */
2440    s = (char**) tr_ptrArrayPeek( &folders, &n );
2441    for( i=0; i<n; ++i )
2442        if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2443            deleteLocalFile( s[i], fileFunc );
2444
2445    /* now blow away any remaining torrent files, such as torrent files in dirty folders */
2446    for( i=0, n=tr_ptrArraySize( &torrentFiles ); i<n; ++i ) {
2447        char * path = tr_buildPath( tor->currentDir, tr_ptrArrayNth( &torrentFiles, i ), NULL );
2448        deleteLocalFile( path, fileFunc );
2449        tr_free( path );
2450    }
2451
2452    /* Now clean out the directories left empty from the previous step.
2453     * Work from deepest to shallowest s.t. lower folders
2454     * won't prevent the upper folders from being deleted */
2455    {
2456        tr_ptrArray cleanFolders = TR_PTR_ARRAY_INIT;
2457        s = (char**) tr_ptrArrayPeek( &folders, &n );
2458        for( i=0; i<n; ++i )
2459            if( tr_ptrArrayFindSorted( &dirtyFolders, s[i], vstrcmp ) == NULL )
2460                tr_ptrArrayInsertSorted( &cleanFolders, s[i], compareLongestFirst );
2461        s = (char**) tr_ptrArrayPeek( &cleanFolders, &n );
2462        for( i=0; i<n; ++i ) {
2463#ifdef SYS_DARWIN
2464            char * dsStore = tr_buildPath( s[i], ".DS_Store", NULL );
2465            deleteLocalFile( dsStore, fileFunc );
2466            tr_free( dsStore );
2467#endif
2468            deleteLocalFile( s[i], fileFunc );
2469        }
2470        tr_ptrArrayDestruct( &cleanFolders, NULL );
2471    }
2472
2473    /* cleanup */
2474    tr_ptrArrayDestruct( &dirtyFolders, tr_free );
2475    tr_ptrArrayDestruct( &folders, tr_free );
2476    tr_ptrArrayDestruct( &torrentFiles, tr_free );
2477    tr_free( root );
2478    tr_free( tmp );
2479}
2480
2481void
2482tr_torrentDeleteLocalData( tr_torrent * tor, tr_fileFunc fileFunc )
2483{
2484    assert( tr_isTorrent( tor ) );
2485
2486    if( fileFunc == NULL )
2487        fileFunc = remove;
2488
2489    /* close all the files because we're about to delete them */
2490    tr_fdTorrentClose( tor->session, tor->uniqueId );
2491
2492    if( tor->info.fileCount > 1 )
2493    {
2494        deleteLocalData( tor, fileFunc );
2495    }
2496    else if( tor->info.fileCount == 1 )
2497    {
2498        char * tmp;
2499
2500        /* torrent only has one file */
2501        char * path = tr_buildPath( tor->currentDir, tor->info.files[0].name, NULL );
2502        deleteLocalFile( path, fileFunc );
2503        tr_free( path );
2504
2505        tmp = tr_torrentBuildPartial( tor, 0 );
2506        path = tr_buildPath( tor->currentDir, tmp, NULL );
2507        deleteLocalFile( path, fileFunc );
2508        tr_free( path );
2509        tr_free( tmp );
2510    }
2511}
2512
2513/***
2514****
2515***/
2516
2517struct LocationData
2518{
2519    tr_bool move_from_old_location;
2520    int * setme_state;
2521    double * setme_progress;
2522    char * location;
2523    tr_torrent * tor;
2524};
2525
2526static tr_bool
2527sameInode( const char * path1, const char * path2 )
2528{
2529    int i1, i2;
2530    struct stat s1, s2;
2531
2532    s1.st_ino = 1;
2533    i1 = stat( path1, &s1 );
2534
2535    s2.st_ino = 2;
2536    i2 = stat( path2, &s2 );
2537
2538    if( !i1 && !i2 ) {
2539        tr_dbg( "path1 inode is %"PRIu64"; path2 inode is %"PRIu64,
2540                (uint64_t)s1.st_ino,
2541                (uint64_t)s2.st_ino );
2542        return s1.st_ino == s2.st_ino;
2543    }
2544
2545    /* either one, or the other, or both don't exist... */
2546    tr_dbg( "stat(%s) returned %d\n", path1, i1 );
2547    tr_dbg( "stat(%s) returned %d\n", path2, i2 );
2548    return FALSE;
2549}
2550
2551static void
2552setLocation( void * vdata )
2553{
2554    tr_bool err = FALSE;
2555    tr_bool verify_needed = FALSE;
2556    struct LocationData * data = vdata;
2557    tr_torrent * tor = data->tor;
2558    const tr_bool do_move = data->move_from_old_location;
2559    const char * location = data->location;
2560    double bytesHandled = 0;
2561
2562    assert( tr_isTorrent( tor ) );
2563
2564    tr_dbg( "Moving \"%s\" location from currentDir \"%s\" to \"%s\"",
2565            tr_torrentName(tor), tor->currentDir, location );
2566
2567    tr_mkdirp( location, 0777 );
2568
2569    if( !sameInode( location, tor->currentDir ) )
2570    {
2571        tr_file_index_t i;
2572
2573        /* bad idea to move files while they're being verified... */
2574        tr_verifyRemove( tor );
2575
2576        /* if the torrent is running, stop it and set a flag to
2577         * restart after we're done */
2578        if( tor->isRunning )
2579        {
2580            tr_torrentStop( tor );
2581            tor->startAfterVerify = TRUE;
2582        }
2583
2584        /* try to move the files.
2585         * FIXME: there are still all kinds of nasty cases, like what
2586         * if the target directory runs out of space halfway through... */
2587        for( i=0; !err && i<tor->info.fileCount; ++i )
2588        {
2589            const tr_file * f = &tor->info.files[i];
2590            const char * oldbase;
2591            char * sub;
2592            if( tr_torrentFindFile2( tor, i, &oldbase, &sub ) )
2593            {
2594                char * oldpath = tr_buildPath( oldbase, sub, NULL );
2595                char * newpath = tr_buildPath( location, sub, NULL );
2596
2597                tr_dbg( "Found file #%d: %s", (int)i, oldpath );
2598
2599                if( do_move )
2600                {
2601                    tr_bool renamed = FALSE;
2602                    errno = 0;
2603                    tr_torinf( tor, "moving \"%s\" to \"%s\"", oldpath, newpath );
2604                    if( tr_moveFile( oldpath, newpath, &renamed ) )
2605                    {
2606                        err = TRUE;
2607                        tr_torerr( tor, "error moving \"%s\" to \"%s\": %s",
2608                                        oldpath, newpath, tr_strerror( errno ) );
2609                    }
2610                    else if( !renamed )
2611                    {
2612                        verify_needed = TRUE;
2613                    }
2614                }
2615
2616                tr_free( newpath );
2617                tr_free( oldpath );
2618                tr_free( sub );
2619            }
2620
2621            if( data->setme_progress )
2622            {
2623                bytesHandled += f->length;
2624                *data->setme_progress = bytesHandled / tor->info.totalSize;
2625            }
2626        }
2627
2628        if( !err )
2629        {
2630            /* blow away the leftover subdirectories in the old location */
2631            if( do_move )
2632                tr_torrentDeleteLocalData( tor, remove );
2633
2634            /* set the new location and reverify */
2635            tr_torrentSetDownloadDir( tor, location );
2636            if( verify_needed )
2637                tr_torrentVerify( tor );
2638            else if( tor->startAfterVerify ) {
2639                tor->startAfterVerify = FALSE;
2640                tr_torrentStart( tor );
2641            }
2642        }
2643    }
2644
2645    if( !err && do_move )
2646    {
2647        tr_free( tor->incompleteDir );
2648        tor->incompleteDir = NULL;
2649        tor->currentDir = tor->downloadDir;
2650    }
2651
2652    if( data->setme_state )
2653        *data->setme_state = err ? TR_LOC_ERROR : TR_LOC_DONE;
2654
2655    /* cleanup */
2656    tr_free( data->location );
2657    tr_free( data );
2658}
2659
2660void
2661tr_torrentSetLocation( tr_torrent  * tor,
2662                       const char  * location,
2663                       tr_bool       move_from_old_location,
2664                       double      * setme_progress,
2665                       int         * setme_state )
2666{
2667    struct LocationData * data;
2668
2669    assert( tr_isTorrent( tor ) );
2670
2671    if( setme_state )
2672        *setme_state = TR_LOC_MOVING;
2673    if( setme_progress )
2674        *setme_progress = 0;
2675
2676    /* run this in the libtransmission thread */
2677    data = tr_new( struct LocationData, 1 );
2678    data->tor = tor;
2679    data->location = tr_strdup( location );
2680    data->move_from_old_location = move_from_old_location;
2681    data->setme_state = setme_state;
2682    data->setme_progress = setme_progress;
2683    tr_runInEventThread( tor->session, setLocation, data );
2684}
2685
2686/***
2687****
2688***/
2689
2690void
2691tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNum )
2692{
2693    char * sub;
2694    const char * base;
2695
2696    /* close the file so that we can reopen in read-only mode as needed */
2697    tr_fdFileClose( tor->session, tor, fileNum );
2698
2699    /* if the torrent's current filename isn't the same as the one in the
2700     * metadata -- for example, if it had the ".part" suffix appended to
2701     * it until now -- then rename it to match the one in the metadata */
2702    if( tr_torrentFindFile2( tor, fileNum, &base, &sub ) )
2703    {
2704        const tr_file * file = &tor->info.files[fileNum];
2705
2706        if( strcmp( sub, file->name ) )
2707        {
2708            char * oldpath = tr_buildPath( base, sub, NULL );
2709            char * newpath = tr_buildPath( base, file->name, NULL );
2710
2711            if( rename( oldpath, newpath ) )
2712                tr_torerr( tor, "Error moving \"%s\" to \"%s\": %s", oldpath, newpath, tr_strerror( errno ) );
2713
2714            tr_free( newpath );
2715            tr_free( oldpath );
2716        }
2717
2718        tr_free( sub );
2719    }
2720}
2721
2722/***
2723****
2724***/
2725
2726static tr_bool
2727fileExists( const char * filename )
2728{
2729    struct stat sb;
2730    const tr_bool ok = !stat( filename, &sb );
2731    return ok;
2732}
2733
2734tr_bool
2735tr_torrentFindFile2( const tr_torrent * tor, tr_file_index_t fileNum,
2736                     const char ** base, char ** subpath )
2737{
2738    char * part;
2739    const tr_file * file;
2740    const char * b = NULL;
2741    const char * s = NULL;
2742
2743    assert( tr_isTorrent( tor ) );
2744    assert( fileNum < tor->info.fileCount );
2745
2746    file = &tor->info.files[fileNum];
2747    part = tr_torrentBuildPartial( tor, fileNum );
2748
2749    if( b == NULL ) {
2750        char * filename = tr_buildPath( tor->downloadDir, file->name, NULL );
2751        if( fileExists( filename ) ) {
2752            b = tor->downloadDir;
2753            s = file->name;
2754        }
2755        tr_free( filename );
2756    }
2757
2758    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2759        char * filename = tr_buildPath( tor->incompleteDir, file->name, NULL );
2760        if( fileExists( filename ) ) {
2761            b = tor->incompleteDir;
2762            s = file->name;
2763        }
2764        tr_free( filename );
2765    }
2766
2767    if( ( b == NULL ) && ( tor->incompleteDir != NULL ) ) {
2768        char * filename = tr_buildPath( tor->incompleteDir, part, NULL );
2769        if( fileExists( filename ) ) {
2770            b = tor->incompleteDir;
2771            s = part;
2772        }
2773        tr_free( filename );
2774    }
2775
2776    if( b == NULL) {
2777        char * filename = tr_buildPath( tor->downloadDir, part, NULL );
2778        if( fileExists( filename ) ) {
2779            b = tor->downloadDir;
2780            s = part;
2781        }
2782        tr_free( filename );
2783    }
2784
2785    if( base != NULL )
2786        *base = b;
2787    if( subpath != NULL )
2788        *subpath = tr_strdup( s );
2789
2790    tr_free( part );
2791    return b != NULL;
2792}
2793
2794char*
2795tr_torrentFindFile( const tr_torrent * tor, tr_file_index_t fileNum )
2796{
2797    char * subpath;
2798    char * ret = NULL;
2799    const char * base;
2800
2801    if( tr_torrentFindFile2( tor, fileNum, &base, &subpath ) )
2802    {
2803        ret = tr_buildPath( base, subpath, NULL );
2804        tr_free( subpath );
2805    }
2806
2807    return ret;
2808}
2809
2810/* Decide whether we should be looking for files in downloadDir or incompleteDir. */
2811static void
2812refreshCurrentDir( tr_torrent * tor )
2813{
2814    const char * dir = NULL;
2815    char * sub;
2816
2817    if( tor->incompleteDir == NULL )
2818        dir = tor->downloadDir;
2819    else if( !tr_torrentHasMetadata( tor ) ) /* no files to find */
2820        dir = tor->incompleteDir;
2821    else if( !tr_torrentFindFile2( tor, 0, &dir, &sub ) )
2822        dir = tor->incompleteDir;
2823
2824    assert( dir != NULL );
2825    assert( ( dir == tor->downloadDir ) || ( dir == tor->incompleteDir ) );
2826    tor->currentDir = dir;
2827}
2828
2829char*
2830tr_torrentBuildPartial( const tr_torrent * tor, tr_file_index_t fileNum )
2831{
2832    return tr_strdup_printf( "%s.part", tor->info.files[fileNum].name );
2833}
Note: See TracBrowser for help on using the repository browser.