source: trunk/libtransmission/transmission.c @ 310

Last change on this file since 310 was 310, checked in by joshe, 15 years ago

Add support to libtransmission and the MacOS X GUI for saving private copies of

torrent files.

  • Property svn:keywords set to Date Rev Author Id
File size: 21.2 KB
Line 
1/******************************************************************************
2 * $Id: transmission.c 310 2006-06-09 19:53:35Z joshe $
3 *
4 * Copyright (c) 2005-2006 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#include "transmission.h"
26
27/***********************************************************************
28 * Local prototypes
29 **********************************************************************/
30static tr_torrent_t * torrentRealInit( tr_handle_t *, tr_torrent_t * tor,
31                                       int flags, int * error );
32static void torrentReallyStop( tr_torrent_t * );
33static void  downloadLoop( void * );
34static void  acceptLoop( void * );
35static void acceptStop( tr_handle_t * h );
36
37/***********************************************************************
38 * tr_init
39 ***********************************************************************
40 * Allocates a tr_handle_t structure and initializes a few things
41 **********************************************************************/
42tr_handle_t * tr_init()
43{
44    tr_handle_t * h;
45    int           i, r;
46
47    tr_netResolveThreadInit();
48
49    h = calloc( sizeof( tr_handle_t ), 1 );
50
51    /* Generate a peer id : "-TRxxyy-" + 12 random alphanumeric
52       characters, where xx is the major version number and yy the
53       minor version number (Azureus-style) */
54    sprintf( h->id, "-TR%02d%02d-", VERSION_MAJOR, VERSION_MINOR );
55    for( i = 8; i < 20; i++ )
56    {
57        r        = tr_rand( 36 );
58        h->id[i] = ( r < 26 ) ? ( 'a' + r ) : ( '0' + r - 26 ) ;
59    }
60
61    /* Random key */
62    for( i = 0; i < 20; i++ )
63    {
64        r         = tr_rand( 36 );
65        h->key[i] = ( r < 26 ) ? ( 'a' + r ) : ( '0' + r - 26 ) ;
66    }
67
68    /* Don't exit when writing on a broken socket */
69    signal( SIGPIPE, SIG_IGN );
70
71    /* Initialize rate and file descripts controls */
72    h->upload   = tr_rcInit();
73    h->download = tr_rcInit();
74    h->fdlimit  = tr_fdInit();
75    h->choking  = tr_chokingInit( h );
76
77    h->bindPort = -1;
78    h->bindSocket = -1;
79
80    h->acceptDie = 0;
81    tr_lockInit( &h->acceptLock );
82    tr_threadCreate( &h->acceptThread, acceptLoop, h );
83
84    return h;
85}
86
87/***********************************************************************
88 * tr_setBindPort
89 ***********************************************************************
90 *
91 **********************************************************************/
92void tr_setBindPort( tr_handle_t * h, int port )
93{
94    int sock = -1;
95    tr_torrent_t * tor;
96
97    if( h->bindPort == port )
98      return;
99
100#ifndef BEOS_NETSERVER
101    /* BeOS net_server seems to be unable to set incoming connections to
102       non-blocking. Too bad. */
103    if( !tr_fdSocketWillCreate( h->fdlimit, 0 ) )
104    {
105        /* XXX should handle failure here in a better way */
106        sock = tr_netBind( port );
107    }
108#else
109    return;
110#endif
111
112    tr_lockLock( &h->acceptLock );
113
114    h->bindPort = port;
115
116    for( tor = h->torrentList; tor; tor = tor->next )
117    {
118        tr_lockLock( &tor->lock );
119        if( NULL != tor->tracker )
120        {
121            tr_trackerChangePort( tor->tracker, port );
122        }
123        tr_lockUnlock( &tor->lock );
124    }
125
126    if( h->bindSocket > -1 )
127    {
128        tr_netClose( h->bindSocket );
129        tr_fdSocketClosed( h->fdlimit, 0 );
130    }
131
132    h->bindSocket = sock;
133
134    tr_lockUnlock( &h->acceptLock );
135}
136
137/***********************************************************************
138 * tr_setUploadLimit
139 ***********************************************************************
140 *
141 **********************************************************************/
142void tr_setUploadLimit( tr_handle_t * h, int limit )
143{
144    tr_rcSetLimit( h->upload, limit );
145    tr_chokingSetLimit( h->choking, limit );
146}
147
148/***********************************************************************
149 * tr_setDownloadLimit
150 ***********************************************************************
151 *
152 **********************************************************************/
153void tr_setDownloadLimit( tr_handle_t * h, int limit )
154{
155    tr_rcSetLimit( h->download, limit );
156}
157
158/***********************************************************************
159 * tr_torrentRates
160 ***********************************************************************
161 *
162 **********************************************************************/
163void tr_torrentRates( tr_handle_t * h, float * dl, float * ul )
164{
165    tr_torrent_t * tor;
166
167    *dl = 0.0;
168    *ul = 0.0;
169    for( tor = h->torrentList; tor; tor = tor->next )
170    {
171        tr_lockLock( &tor->lock );
172        if( tor->status & TR_STATUS_DOWNLOAD )
173            *dl += tr_rcRate( tor->download );
174        *ul += tr_rcRate( tor->upload );
175        tr_lockUnlock( &tor->lock );
176    }
177}
178
179tr_torrent_t * tr_torrentInit( tr_handle_t * h, const char * path,
180                               int flags, int * error )
181{
182    tr_torrent_t  * tor = calloc( sizeof( tr_torrent_t ), 1 );
183    int             saveCopy = ( TR_FSAVEPRIVATE & flags );
184
185    /* Parse torrent file */
186    if( tr_metainfoParse( &tor->info, path, NULL, saveCopy ) )
187    {
188        *error = TR_EINVALID;
189        free( tor );
190        return NULL;
191    }
192
193    return torrentRealInit( h, tor, flags, error );
194}
195
196tr_torrent_t * tr_torrentInitSaved( tr_handle_t * h, const char * hashStr,
197                                    int flags, int * error )
198{
199    tr_torrent_t  * tor = calloc( sizeof( tr_torrent_t ), 1 );
200
201    /* Parse torrent file */
202    if( tr_metainfoParse( &tor->info, NULL, hashStr, 0 ) )
203    {
204        *error = TR_EINVALID;
205        free( tor );
206        return NULL;
207    }
208
209    return torrentRealInit( h, tor, ( TR_FSAVEPRIVATE | flags ), error );
210}
211
212/***********************************************************************
213 * tr_torrentInit
214 ***********************************************************************
215 * Allocates a tr_torrent_t structure, then relies on tr_metainfoParse
216 * to fill it.
217 **********************************************************************/
218static tr_torrent_t * torrentRealInit( tr_handle_t * h, tr_torrent_t * tor,
219                                       int flags, int * error )
220{
221    tr_torrent_t  * tor_tmp;
222    tr_info_t     * inf;
223    int             i;
224    char          * s1, * s2;
225
226    inf        = &tor->info;
227    inf->flags = flags;
228
229    /* Make sure this torrent is not already open */
230    for( tor_tmp = h->torrentList; tor_tmp; tor_tmp = tor_tmp->next )
231    {
232        if( !memcmp( tor->info.hash, tor_tmp->info.hash,
233                     SHA_DIGEST_LENGTH ) )
234        {
235            *error = TR_EDUPLICATE;
236            free( tor );
237            return NULL;
238        }
239    }
240
241    tor->status = TR_STATUS_PAUSE;
242    tor->id     = h->id;
243    tor->key    = h->key;
244    tor->bindPort = &h->bindPort;
245        tor->finished = 0;
246
247
248    /* Guess scrape URL */
249    s1 = strchr( inf->trackerAnnounce, '/' );
250    while( ( s2 = strchr( s1 + 1, '/' ) ) )
251    {
252        s1 = s2;
253    }
254    s1++;
255    if( !strncmp( s1, "announce", 8 ) )
256    {
257        int pre  = (long) s1 - (long) inf->trackerAnnounce;
258        int post = strlen( inf->trackerAnnounce ) - pre - 8;
259        memcpy( tor->scrape, inf->trackerAnnounce, pre );
260        sprintf( &tor->scrape[pre], "scrape" );
261        memcpy( &tor->scrape[pre+6], &inf->trackerAnnounce[pre+8], post );
262    }
263
264    /* Escaped info hash for HTTP queries */
265    for( i = 0; i < SHA_DIGEST_LENGTH; i++ )
266    {
267        sprintf( &tor->hashString[3*i], "%%%02x", inf->hash[i] );
268    }
269
270    /* Block size: usually 16 ko, or less if we have to */
271    tor->blockSize  = MIN( inf->pieceSize, 1 << 14 );
272    tor->blockCount = ( inf->totalSize + tor->blockSize - 1 ) /
273                        tor->blockSize;
274    tor->completion = tr_cpInit( tor );
275
276    tr_lockInit( &tor->lock );
277
278    tor->globalUpload   = h->upload;
279    tor->globalDownload = h->download;
280    tor->fdlimit        = h->fdlimit;
281    tor->upload         = tr_rcInit();
282    tor->download       = tr_rcInit();
283 
284    /* We have a new torrent */
285    tr_lockLock( &h->acceptLock );
286    tor->prev = NULL;
287    tor->next = h->torrentList;
288    if( tor->next )
289    {
290        tor->next->prev = tor;
291    }
292    h->torrentList = tor;
293    (h->torrentCount)++;
294    tr_lockUnlock( &h->acceptLock );
295
296    if( 0 > h->bindPort )
297    {
298        tr_setBindPort( h, TR_DEFAULT_PORT );
299    }
300
301    return tor;
302}
303
304tr_info_t * tr_torrentInfo( tr_torrent_t * tor )
305{
306    return &tor->info;
307}
308
309/***********************************************************************
310 * tr_torrentScrape
311 **********************************************************************/
312int tr_torrentScrape( tr_torrent_t * tor, int * s, int * l )
313{
314    return tr_trackerScrape( tor, s, l );
315}
316
317void tr_torrentSetFolder( tr_torrent_t * tor, const char * path )
318{
319    tor->destination = strdup( path );
320}
321
322char * tr_torrentGetFolder( tr_torrent_t * tor )
323{
324    return tor->destination;
325}
326
327void tr_torrentStart( tr_torrent_t * tor )
328{
329    if( tor->status & ( TR_STATUS_STOPPING | TR_STATUS_STOPPED ) )
330    {
331        /* Join the thread first */
332        torrentReallyStop( tor );
333    }
334
335    tor->status  = TR_STATUS_CHECK;
336
337    tor->date = tr_date();
338    tor->die = 0;
339    tr_threadCreate( &tor->thread, downloadLoop, tor );
340}
341
342void tr_torrentStop( tr_torrent_t * tor )
343{
344    tr_lockLock( &tor->lock );
345    tr_trackerStopped( tor->tracker );
346    tr_rcReset( tor->download );
347    tr_rcReset( tor->upload );
348    tor->status = TR_STATUS_STOPPING;
349    tor->stopDate = tr_date();
350    tr_lockUnlock( &tor->lock );
351}
352
353/***********************************************************************
354 * torrentReallyStop
355 ***********************************************************************
356 * Joins the download thread and frees/closes everything related to it.
357 **********************************************************************/
358static void torrentReallyStop( tr_torrent_t * tor )
359{
360    tor->die = 1;
361    tr_threadJoin( &tor->thread );
362    tr_dbg( "Thread joined" );
363
364    tr_trackerClose( tor->tracker );
365    tor->tracker = NULL;
366
367    while( tor->peerCount > 0 )
368    {
369        tr_peerRem( tor, 0 );
370    }
371}
372
373/***********************************************************************
374 * tr_torrentCount
375 ***********************************************************************
376 *
377 **********************************************************************/
378int tr_torrentCount( tr_handle_t * h )
379{
380    return h->torrentCount;
381}
382
383void tr_torrentIterate( tr_handle_t * h, tr_callback_t func, void * d )
384{
385    tr_torrent_t * tor;
386
387    for( tor = h->torrentList; tor; tor = tor->next )
388    {
389        func( tor, d );
390    }
391}
392
393int tr_getFinished( tr_torrent_t * tor )
394{
395    if( tor->finished )
396    {
397        tor->finished = 0;
398        return 1;
399    }
400    return 0;
401}
402
403tr_stat_t * tr_torrentStat( tr_torrent_t * tor )
404{
405    tr_stat_t * s;
406    tr_info_t * inf = &tor->info;
407    int i;
408
409    tor->statCur = ( tor->statCur + 1 ) % 2;
410    s = &tor->stats[tor->statCur];
411
412    if( ( tor->status & TR_STATUS_STOPPED ) ||
413        ( ( tor->status & TR_STATUS_STOPPING ) &&
414          tr_date() > tor->stopDate + 60000 ) )
415    {
416        torrentReallyStop( tor );
417        tor->status = TR_STATUS_PAUSE;
418    }
419
420    tr_lockLock( &tor->lock );
421
422    s->status = tor->status;
423    s->error  = tor->error;
424    memcpy( s->trackerError, tor->trackerError,
425            sizeof( s->trackerError ) );
426
427    s->peersTotal       = 0;
428    s->peersUploading   = 0;
429    s->peersDownloading = 0;
430
431    for( i = 0; i < tor->peerCount; i++ )
432    {
433        if( tr_peerIsConnected( tor->peers[i] ) )
434        {
435            (s->peersTotal)++;
436            if( tr_peerIsUploading( tor->peers[i] ) )
437            {
438                (s->peersUploading)++;
439            }
440            if( tr_peerIsDownloading( tor->peers[i] ) )
441            {
442                (s->peersDownloading)++;
443            }
444        }
445    }
446
447    s->progress = tr_cpCompletionAsFloat( tor->completion );
448    if( tor->status & TR_STATUS_DOWNLOAD )
449        s->rateDownload = tr_rcRate( tor->download );
450    else
451        /* tr_rcRate() doesn't make the difference between 'piece'
452           messages and other messages, which causes a non-zero
453           download rate even tough we are not downloading. So we
454           force it to zero not to confuse the user. */
455        s->rateDownload = 0.0;
456    s->rateUpload = tr_rcRate( tor->upload );
457   
458    s->seeders  = tr_trackerSeeders(tor->tracker);
459        s->leechers = tr_trackerLeechers(tor->tracker);
460
461    if( s->rateDownload < 0.1 )
462    {
463        s->eta = -1;
464    }
465    else
466    {
467        s->eta = (float) ( 1.0 - s->progress ) *
468            (float) inf->totalSize / s->rateDownload / 1024.0;
469        if( s->eta > 99 * 3600 + 59 * 60 + 59 )
470        {
471            s->eta = -1;
472        }
473    }
474
475    s->downloaded = tor->downloaded;
476    s->uploaded   = tor->uploaded;
477
478    tr_lockUnlock( &tor->lock );
479
480    return s;
481}
482
483void tr_torrentAvailability( tr_torrent_t * tor, int8_t * tab, int size )
484{
485    int i, j, piece;
486
487    tr_lockLock( &tor->lock );
488    for( i = 0; i < size; i++ )
489    {
490        piece = i * tor->info.pieceCount / size;
491
492        if( tr_cpPieceIsComplete( tor->completion, piece ) )
493        {
494            tab[i] = -1;
495            continue;
496        }
497
498        tab[i] = 0;
499        for( j = 0; j < tor->peerCount; j++ )
500        {
501            if( tr_peerBitfield( tor->peers[j] ) &&
502                tr_bitfieldHas( tr_peerBitfield( tor->peers[j] ), piece ) )
503            {
504                (tab[i])++;
505            }
506        }
507    }
508    tr_lockUnlock( &tor->lock );
509}
510
511void tr_torrentRemoveSaved( tr_torrent_t * tor ) {
512    tr_metainfoRemoveSaved( tor->info.hashString );
513}
514
515/***********************************************************************
516 * tr_torrentClose
517 ***********************************************************************
518 * Frees memory allocated by tr_torrentInit.
519 **********************************************************************/
520void tr_torrentClose( tr_handle_t * h, tr_torrent_t * tor )
521{
522    tr_info_t * inf = &tor->info;
523
524    if( tor->status & ( TR_STATUS_STOPPING | TR_STATUS_STOPPED ) )
525    {
526        /* Join the thread first */
527        torrentReallyStop( tor );
528    }
529
530    tr_lockLock( &h->acceptLock );
531
532    h->torrentCount--;
533
534    tr_lockClose( &tor->lock );
535    tr_cpClose( tor->completion );
536
537    tr_rcClose( tor->upload );
538    tr_rcClose( tor->download );
539
540    if( tor->destination )
541    {
542        free( tor->destination );
543    }
544    free( inf->pieces );
545    free( inf->files );
546
547    if( tor->prev )
548    {
549        tor->prev->next = tor->next;
550    }
551    else
552    {
553        h->torrentList = tor->next;
554    }
555    if( tor->next )
556    {
557        tor->next->prev = tor->prev;
558    }
559    free( tor );
560
561    tr_lockUnlock( &h->acceptLock );
562}
563
564void tr_close( tr_handle_t * h )
565{
566    acceptStop( h );
567    tr_chokingClose( h->choking );
568    tr_fdClose( h->fdlimit );
569    tr_rcClose( h->upload );
570    tr_rcClose( h->download );
571    free( h );
572
573    tr_netResolveThreadClose();
574}
575
576/***********************************************************************
577 * downloadLoop
578 **********************************************************************/
579static void downloadLoop( void * _tor )
580{
581    tr_torrent_t * tor = _tor;
582    uint64_t       date1, date2;
583
584    tr_dbg( "Thread started" );
585
586#ifdef SYS_BEOS
587    /* This is required because on BeOS, SIGINT is sent to each thread,
588       which kills them not nicely */
589    signal( SIGINT, SIG_IGN );
590#endif
591
592    tr_lockLock( &tor->lock );
593
594    tr_cpReset( tor->completion );
595    tor->io     = tr_ioInit( tor );
596    tor->status = tr_cpIsSeeding( tor->completion ) ?
597                      TR_STATUS_SEED : TR_STATUS_DOWNLOAD;
598    tor->tracker = tr_trackerInit( tor );
599
600    while( !tor->die )
601    {
602        date1 = tr_date();
603
604        /* Are we finished ? */
605        if( ( tor->status & TR_STATUS_DOWNLOAD ) &&
606            tr_cpIsSeeding( tor->completion ) )
607        {
608            /* Done */
609            tor->status = TR_STATUS_SEED;
610                        tor->finished = 1;
611            tr_trackerCompleted( tor->tracker );
612            tr_ioSaveResume( tor->io );
613        }
614
615        /* Receive/send messages */
616        tr_peerPulse( tor );
617
618        /* Try to get new peers or to send a message to the tracker */
619        tr_trackerPulse( tor->tracker );
620
621        if( tor->status & TR_STATUS_STOPPED )
622        {
623            break;
624        }
625
626        /* Wait up to 20 ms */
627        date2 = tr_date();
628        if( date2 < date1 + 20 )
629        {
630            tr_lockUnlock( &tor->lock );
631            tr_wait( date1 + 20 - date2 );
632            tr_lockLock( &tor->lock );
633        }
634    }
635
636    tr_lockUnlock( &tor->lock );
637
638    tr_ioClose( tor->io );
639
640    tor->status = TR_STATUS_STOPPED;
641
642    tr_dbg( "Thread exited" );
643}
644
645/***********************************************************************
646 * acceptLoop
647 **********************************************************************/
648static void acceptLoop( void * _h )
649{
650    tr_handle_t * h = _h;
651    uint64_t      date1, date2, lastchoke = 0;
652    int           ii;
653    uint8_t     * hash;
654    tr_torrent_t * tor;
655
656    tr_dbg( "Accept thread started" );
657
658#ifdef SYS_BEOS
659    /* This is required because on BeOS, SIGINT is sent to each thread,
660       which kills them not nicely */
661    signal( SIGINT, SIG_IGN );
662#endif
663
664    tr_lockLock( &h->acceptLock );
665
666    while( !h->acceptDie )
667    {
668        date1 = tr_date();
669
670        /* Check for incoming connections */
671        if( h->bindSocket > -1 &&
672            h->acceptPeerCount < TR_MAX_PEER_COUNT &&
673            !tr_fdSocketWillCreate( h->fdlimit, 0 ) )
674        {
675            int            s;
676            struct in_addr addr;
677            in_port_t      port;
678            s = tr_netAccept( h->bindSocket, &addr, &port );
679            if( s > -1 )
680            {
681                h->acceptPeers[h->acceptPeerCount++] = tr_peerInit( addr, port, s );
682            }
683            else
684            {
685                tr_fdSocketClosed( h->fdlimit, 0 );
686            }
687        }
688
689        for( ii = 0; ii < h->acceptPeerCount; )
690        {
691            if( tr_peerRead( NULL, h->acceptPeers[ii] ) )
692            {
693                tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
694                goto removePeer;
695            }
696            if( NULL != ( hash = tr_peerHash( h->acceptPeers[ii] ) ) )
697            {
698                for( tor = h->torrentList; tor; tor = tor->next )
699                {
700                    tr_lockLock( &tor->lock );
701                    if( 0 == memcmp( tor->info.hash, hash,
702                                     SHA_DIGEST_LENGTH ) )
703                    {
704                      tr_peerAttach( tor, h->acceptPeers[ii] );
705                      tr_lockUnlock( &tor->lock );
706                      goto removePeer;
707                    }
708                    tr_lockUnlock( &tor->lock );
709                }
710                tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
711                goto removePeer;
712            }
713            if( date1 > tr_peerDate( h->acceptPeers[ii] ) + 10000 )
714            {
715                /* Give them 10 seconds to send the handshake */
716                tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
717                goto removePeer;
718            }
719            ii++;
720            continue;
721           removePeer:
722            h->acceptPeerCount--;
723            memmove( &h->acceptPeers[ii], &h->acceptPeers[ii+1],
724                     ( h->acceptPeerCount - ii ) * sizeof( tr_peer_t * ) );
725        }
726
727        if( date1 > lastchoke + 2000 )
728        {
729            tr_chokingPulse( h->choking );
730            lastchoke = date1;
731        }
732
733        /* Wait up to 20 ms */
734        date2 = tr_date();
735        if( date2 < date1 + 20 )
736        {
737            tr_lockUnlock( &h->acceptLock );
738            tr_wait( date1 + 20 - date2 );
739            tr_lockLock( &h->acceptLock );
740        }
741    }
742
743    tr_lockUnlock( &h->acceptLock );
744
745    tr_dbg( "Accept thread exited" );
746}
747
748/***********************************************************************
749 * acceptStop
750 ***********************************************************************
751 * Joins the accept thread and frees/closes everything related to it.
752 **********************************************************************/
753static void acceptStop( tr_handle_t * h )
754{
755    int ii;
756
757    h->acceptDie = 1;
758    tr_threadJoin( &h->acceptThread );
759    tr_lockClose( &h->acceptLock );
760    tr_dbg( "Accept thread joined" );
761
762    for( ii = 0; ii < h->acceptPeerCount; ii++ )
763    {
764        tr_peerDestroy( h->fdlimit, h->acceptPeers[ii] );
765    }
766
767    if( h->bindSocket > -1 )
768    {
769        tr_netClose( h->bindSocket );
770        tr_fdSocketClosed( h->fdlimit, 0 );
771    }
772}
Note: See TracBrowser for help on using the repository browser.