source: trunk/cli/transmissioncli.c @ 3484

Last change on this file since 3484 was 3484, checked in by charles, 15 years ago

Dead code removal (TR_STATUS_STOPPING)

  • Property svn:keywords set to Date Rev Author Id
File size: 13.3 KB
Line 
1/******************************************************************************
2 * $Id: transmissioncli.c 3484 2007-10-20 21:17:37Z charles $
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 <stdio.h>
26#include <stdlib.h>
27#include <string.h>
28#include <unistd.h>
29#include <getopt.h>
30#include <signal.h>
31
32#include <libtransmission/transmission.h>
33#include <libtransmission/makemeta.h>
34
35#ifdef __BEOS__
36    #include <kernel/OS.h>
37    #define wait_msecs(N)  snooze( (N) * 1000 )
38    #define wait_secs(N)   sleep( (N) )
39#elif defined(WIN32)
40    #include <windows.h>
41    #define wait_msecs(N)  Sleep( (N) )
42    #define wait_secs(N)   Sleep( (N) * 1000 )
43#else
44    #define wait_msecs(N)  usleep( (N) * 1000 )
45    #define wait_secs(N)   sleep( (N) )
46#endif
47
48/* macro to shut up "unused parameter" warnings */
49#ifdef __GNUC__
50#define UNUSED                  __attribute__((unused))
51#else
52#define UNUSED
53#endif
54
55const char * USAGE =
56"Usage: %s [options] file.torrent [options]\n\n"
57"Options:\n"
58"  -c, --create-from <file>  Create torrent from the specified source file.\n"
59"  -a, --announce <url> Used in conjunction with -c.\n"
60"  -r, --private        Used in conjunction with -c.\n"
61"  -m, --comment <text> Adds an optional comment when creating a torrent.\n"
62"  -d, --download <int> Maximum download rate (-1 = no limit, default = -1)\n"
63"  -f, --finish <shell script> Command you wish to run on completion\n" 
64"  -h, --help           Print this help and exit\n" 
65"  -i, --info           Print metainfo and exit\n"
66"  -n  --nat-traversal  Attempt NAT traversal using NAT-PMP or UPnP IGD\n"
67"  -p, --port <int>     Port we should listen on (default = %d)\n"
68#if 0
69"  -s, --scrape         Print counts of seeders/leechers and exit\n"
70#endif
71"  -u, --upload <int>   Maximum upload rate (-1 = no limit, default = 20)\n"
72"  -v, --verbose <int>  Verbose level (0 to 2, default = 0)\n";
73
74static int           showHelp      = 0;
75static int           showInfo      = 0;
76#if 0
77static int           showScrape    = 0;
78#endif
79static int           isPrivate     = 0;
80static int           verboseLevel  = 0;
81static int           bindPort      = TR_DEFAULT_PORT;
82static int           uploadLimit   = 20;
83static int           downloadLimit = -1;
84static char          * torrentPath = NULL;
85static int           natTraversal  = 0;
86static sig_atomic_t  gotsig        = 0;
87static sig_atomic_t  manualUpdate  = 0;
88static tr_torrent    * tor;
89
90static char          * finishCall   = NULL;
91static char          * announce     = NULL;
92static char          * sourceFile   = NULL;
93static char          * comment      = NULL;
94
95static int  parseCommandLine ( int argc, char ** argv );
96static void sigHandler       ( int signal );
97
98char * getStringRatio( float ratio )
99{
100    static char string[20];
101
102    if( ratio == TR_RATIO_NA )
103        return "n/a";
104    snprintf( string, sizeof string, "%.3f", ratio );
105    return string;
106}
107
108#define LINEWIDTH 80
109
110static void
111torrentStateChanged( tr_torrent   * torrent UNUSED,
112                     cp_status_t    status UNUSED,
113                     void         * user_data UNUSED )
114{
115    system( finishCall );
116}
117
118int main( int argc, char ** argv )
119{
120    int i, error;
121    tr_handle  * h;
122    const tr_stat    * s;
123    tr_handle_status * hstat;
124
125    printf( "Transmission %s - http://transmission.m0k.org/\n\n",
126            LONG_VERSION_STRING );
127
128    /* Get options */
129    if( parseCommandLine( argc, argv ) )
130    {
131        printf( USAGE, argv[0], TR_DEFAULT_PORT );
132        return EXIT_FAILURE;
133    }
134
135    if( showHelp )
136    {
137        printf( USAGE, argv[0], TR_DEFAULT_PORT );
138        return EXIT_SUCCESS;
139    }
140
141    if( verboseLevel < 0 )
142    {
143        verboseLevel = 0;
144    }
145    else if( verboseLevel > 9 )
146    {
147        verboseLevel = 9;
148    }
149    if( verboseLevel )
150    {
151        static char env[11];
152        snprintf( env, sizeof env, "TR_DEBUG=%d", verboseLevel );
153        putenv( env );
154    }
155
156    if( bindPort < 1 || bindPort > 65535 )
157    {
158        printf( "Invalid port '%d'\n", bindPort );
159        return EXIT_FAILURE;
160    }
161
162    /* Initialize libtransmission */
163    h = tr_init( "cli" );
164
165    if( sourceFile && *sourceFile ) /* creating a torrent */
166    {
167        int ret;
168        tr_metainfo_builder * builder = tr_metaInfoBuilderCreate( h, sourceFile );
169        tr_makeMetaInfo( builder, torrentPath, announce, comment, isPrivate );
170        while( !builder->isDone ) {
171            wait_msecs( 1 );
172            printf( "." );
173        }
174        ret = !builder->failed;
175        tr_metaInfoBuilderFree( builder );
176        return ret;
177    }
178
179    /* Open and parse torrent file */
180    if( !( tor = tr_torrentInit( h, torrentPath, ".", 0, &error ) ) )
181    {
182        printf( "Failed opening torrent file `%s'\n", torrentPath );
183        tr_close( h );
184        return EXIT_FAILURE;
185    }
186
187    if( showInfo )
188    {
189        const tr_info * info = tr_torrentInfo( tor );
190
191        s = tr_torrentStat( tor );
192
193        /* Print torrent info (quite à la btshowmetainfo) */
194        printf( "hash:     " );
195        for( i = 0; i < SHA_DIGEST_LENGTH; i++ )
196        {
197            printf( "%02x", info->hash[i] );
198        }
199        printf( "\n" );
200        printf( "tracker:  %s:%d\n",
201                s->tracker->address, s->tracker->port );
202        printf( "announce: %s\n", s->tracker->announce );
203        printf( "size:     %"PRIu64" (%"PRIu64" * %d + %"PRIu64")\n",
204                info->totalSize, info->totalSize / info->pieceSize,
205                info->pieceSize, info->totalSize % info->pieceSize );
206        if( info->comment[0] )
207        {
208            printf( "comment:  %s\n", info->comment );
209        }
210        if( info->creator[0] )
211        {
212            printf( "creator:  %s\n", info->creator );
213        }
214        if( info->isPrivate )
215        {
216            printf( "private flag set\n" );
217        }
218        printf( "file(s):\n" );
219        for( i = 0; i < info->fileCount; i++ )
220        {
221            printf( " %s (%"PRIu64")\n", info->files[i].name,
222                    info->files[i].length );
223        }
224
225        goto cleanup;
226    }
227
228#if 0
229    if( showScrape )
230    {
231        int seeders, leechers, downloaded;
232
233        if( tr_torrentScrape( tor, &seeders, &leechers, &downloaded ) )
234        {
235            printf( "Scrape failed.\n" );
236        }
237        else
238        {
239            printf( "%d seeder(s), %d leecher(s), %d download(s).\n",
240                    seeders, leechers, downloaded );
241        }
242
243        goto cleanup;
244    }
245#endif
246
247    signal( SIGINT, sigHandler );
248    signal( SIGHUP, sigHandler );
249
250    tr_setBindPort( h, bindPort );
251 
252    tr_setGlobalSpeedLimit   ( h, TR_UP,   uploadLimit );
253    tr_setUseGlobalSpeedLimit( h, TR_UP,   uploadLimit > 0 );
254    tr_setGlobalSpeedLimit   ( h, TR_DOWN, downloadLimit );
255    tr_setUseGlobalSpeedLimit( h, TR_DOWN, downloadLimit > 0 );
256
257    tr_natTraversalEnable( h, natTraversal );
258   
259    tr_torrentSetStatusCallback( tor, torrentStateChanged, NULL );
260    tr_torrentStart( tor );
261
262    for( ;; )
263    {
264        char string[LINEWIDTH];
265        int  chars = 0;
266
267        wait_secs( 1 );
268
269        if( gotsig )
270        {
271            gotsig = 0;
272            tr_torrentStop( tor );
273            tr_natTraversalEnable( h, 0 );
274        }
275       
276        if( manualUpdate )
277        {
278            manualUpdate = 0;
279            if ( !tr_torrentCanManualUpdate( tor ) )
280                fprintf( stderr, "\rReceived SIGHUP, but can't send a manual update now\n" );
281            else {
282                fprintf( stderr, "\rReceived SIGHUP: manual update scheduled\n" );
283                tr_manualUpdate( tor );
284            }
285        }
286
287        s = tr_torrentStat( tor );
288
289        if( s->status & TR_STATUS_CHECK_WAIT )
290        {
291            chars = snprintf( string, sizeof string,
292                "Waiting to verify local files... %.2f %%", 100.0 * s->percentDone );
293        }
294        else if( s->status & TR_STATUS_CHECK )
295        {
296            chars = snprintf( string, sizeof string,
297                "Verifying local files... %.2f %%", 100.0 * s->percentDone );
298        }
299        else if( s->status & TR_STATUS_DOWNLOAD )
300        {
301            chars = snprintf( string, sizeof string,
302                "Progress: %.2f %%, %d peer%s, dl from %d (%.2f KB/s), "
303                "ul to %d (%.2f KB/s) [%s]", 100.0 * s->percentDone,
304                s->peersConnected, ( s->peersConnected == 1 ) ? "" : "s",
305                s->peersSendingToUs, s->rateDownload,
306                s->peersGettingFromUs, s->rateUpload,
307                getStringRatio(s->ratio) );
308        }
309        else if( s->status & TR_STATUS_SEED )
310        {
311            chars = snprintf( string, sizeof string,
312                "Seeding, uploading to %d of %d peer(s), %.2f KB/s [%s]",
313                s->peersGettingFromUs, s->peersConnected,
314                s->rateUpload, getStringRatio(s->ratio) );
315        }
316        else if( s->status & TR_STATUS_INACTIVE )
317        {
318            break;
319        }
320        if( ( signed )sizeof string > chars )
321        {
322            memset( &string[chars], ' ', sizeof string - 1 - chars );
323        }
324        string[sizeof string - 1] = '\0';
325        fprintf( stderr, "\r%s", string );
326
327        if( s->error )
328        {
329            fprintf( stderr, "\n%s\n", s->errorString );
330        }
331        else if( verboseLevel > 0 )
332        {
333            fprintf( stderr, "\n" );
334        }
335    }
336    fprintf( stderr, "\n" );
337
338    /* Try for 5 seconds to delete any port mappings for nat traversal */
339    tr_natTraversalEnable( h, 0 );
340    for( i = 0; i < 10; i++ )
341    {
342        hstat = tr_handleStatus( h );
343        if( TR_NAT_TRAVERSAL_DISABLED == hstat->natTraversalStatus )
344        {
345            /* Port mappings were deleted */
346            break;
347        }
348        wait_msecs( 500 );
349    }
350   
351cleanup:
352    tr_torrentClose( tor );
353    tr_close( h );
354
355    return EXIT_SUCCESS;
356}
357
358static int parseCommandLine( int argc, char ** argv )
359{
360    for( ;; )
361    {
362        static struct option long_options[] =
363          { { "help",     no_argument,       NULL, 'h' },
364            { "info",     no_argument,       NULL, 'i' },
365            { "scrape",   no_argument,       NULL, 's' },
366            { "private",  no_argument,       NULL, 'r' },
367            { "verbose",  required_argument, NULL, 'v' },
368            { "port",     required_argument, NULL, 'p' },
369            { "upload",   required_argument, NULL, 'u' },
370            { "download", required_argument, NULL, 'd' },
371            { "finish",   required_argument, NULL, 'f' },
372            { "create",   required_argument, NULL, 'c' },
373            { "comment",  required_argument, NULL, 'm' },
374            { "announce", required_argument, NULL, 'a' },
375            { "nat-traversal", no_argument,  NULL, 'n' },
376            { 0, 0, 0, 0} };
377
378        int c, optind = 0;
379        c = getopt_long( argc, argv, "hisrv:p:u:d:f:c:m:a:n",
380                         long_options, &optind );
381        if( c < 0 )
382        {
383            break;
384        }
385        switch( c )
386        {
387            case 'h':
388                showHelp = 1;
389                break;
390            case 'i':
391                showInfo = 1;
392                break;
393#if 0
394            case 's':
395                showScrape = 1;
396                break;
397#endif
398            case 'r':
399                isPrivate = 1;
400                break;
401            case 'v':
402                verboseLevel = atoi( optarg );
403                break;
404            case 'p':
405                bindPort = atoi( optarg );
406                break;
407            case 'u':
408                uploadLimit = atoi( optarg );
409                break;
410            case 'd':
411                downloadLimit = atoi( optarg );
412                break;
413            case 'f':
414                finishCall = optarg;
415                break;
416            case 'c':
417                sourceFile = optarg;
418                break;
419            case 'm':
420                comment = optarg;
421                break;
422            case 'a':
423                announce = optarg;
424                break;
425            case 'n':
426                natTraversal = 1;
427                break;
428            default:
429                return 1;
430        }
431    }
432
433    if( optind > argc - 1  )
434    {
435        return !showHelp;
436    }
437
438    torrentPath = argv[optind];
439
440    return 0;
441}
442
443static void sigHandler( int signal )
444{
445    switch( signal )
446    {
447        case SIGINT:
448            gotsig = 1;
449            break;
450           
451        case SIGHUP:
452            manualUpdate = 1;
453            break;
454
455        default:
456            break;
457    }
458}
Note: See TracBrowser for help on using the repository browser.