source: trunk/libtransmission/torrent.c @ 9612

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

(trunk libT) remove unnecessary code

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