source: trunk/cli/cli.c @ 10937

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

(trunk) #3045 "speed units" -- change the public API of libtransmission based on feedback from livings

  • Property svn:keywords set to Date Rev Author Id
File size: 13.6 KB
Line 
1/******************************************************************************
2 * $Id: cli.c 10937 2010-07-04 06:07:21Z 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 <signal.h>
30
31#include <libtransmission/transmission.h>
32#include <libtransmission/bencode.h>
33#include <libtransmission/tr-getopt.h>
34#include <libtransmission/utils.h> /* tr_wait_msec */
35#include <libtransmission/version.h>
36#include <libtransmission/web.h> /* tr_webRun */
37
38/***
39****
40***/
41
42#define MEM_K 1024
43#define MEM_B_STR "B"
44#define MEM_K_STR "KiB"
45#define MEM_M_STR "MiB"
46#define MEM_G_STR "GiB"
47
48#define DISK_K 1000
49#define DISK_B_STR "B"
50#define DISK_K_STR "kB"
51#define DISK_M_STR "MB"
52#define DISK_G_STR "GB"
53
54#define SPEED_K 1000
55#define SPEED_B_STR "B/s"
56#define SPEED_K_STR "kB/s"
57#define SPEED_M_STR "MB/s"
58#define SPEED_G_STR "GB/s"
59
60/***
61****
62***/
63
64#define LINEWIDTH 80
65#define MY_NAME "transmissioncli"
66
67static tr_bool verify                = 0;
68static sig_atomic_t gotsig           = 0;
69static sig_atomic_t manualUpdate     = 0;
70
71static const char * torrentPath  = NULL;
72
73static const struct tr_option options[] =
74{
75    { 'b', "blocklist",            "Enable peer blocklists", "b",  0, NULL },
76    { 'B', "no-blocklist",         "Disable peer blocklists", "B",  0, NULL },
77    { 'd', "downlimit",            "Set max download speed in "SPEED_K_STR, "d",  1, "<speed>" },
78    { 'D', "no-downlimit",         "Don't limit the download speed", "D",  0, NULL },
79    { 910, "encryption-required",  "Encrypt all peer connections", "er", 0, NULL },
80    { 911, "encryption-preferred", "Prefer encrypted peer connections", "ep", 0, NULL },
81    { 912, "encryption-tolerated", "Prefer unencrypted peer connections", "et", 0, NULL },
82    { 'f', "finish",               "Run a script when the torrent finishes", "f", 1, "<script>" },
83    { 'g', "config-dir",           "Where to find configuration files", "g", 1, "<path>" },
84    { 'm', "portmap",              "Enable portmapping via NAT-PMP or UPnP", "m",  0, NULL },
85    { 'M', "no-portmap",           "Disable portmapping", "M",  0, NULL },
86    { 'p', "port", "Port for incoming peers (Default: " TR_DEFAULT_PEER_PORT_STR ")", "p", 1, "<port>" },
87    { 't', "tos", "Peer socket TOS (0 to 255, default=" TR_DEFAULT_PEER_SOCKET_TOS_STR ")", "t", 1, "<tos>" },
88    { 'u', "uplimit",              "Set max upload speed in "SPEED_K_STR, "u",  1, "<speed>"   },
89    { 'U', "no-uplimit",           "Don't limit the upload speed", "U",  0, NULL        },
90    { 'v', "verify",               "Verify the specified torrent", "v",  0, NULL        },
91    { 'w', "download-dir",         "Where to save downloaded data", "w",  1, "<path>"    },
92    { 0, NULL, NULL, NULL, 0, NULL }
93};
94
95static const char *
96getUsage( void )
97{
98    return "A fast and easy BitTorrent client\n"
99           "\n"
100           "Usage: " MY_NAME " [options] <file|url|magnet>";
101}
102
103static int parseCommandLine( tr_benc*, int argc, const char ** argv );
104
105static void         sigHandler( int signal );
106
107static char*
108tr_strlratio( char * buf,
109              double ratio,
110              size_t buflen )
111{
112    if( (int)ratio == TR_RATIO_NA )
113        tr_strlcpy( buf, _( "None" ), buflen );
114    else if( (int)ratio == TR_RATIO_INF )
115        tr_strlcpy( buf, "Inf", buflen );
116    else if( ratio < 10.0 )
117        tr_snprintf( buf, buflen, "%.2f", ratio );
118    else if( ratio < 100.0 )
119        tr_snprintf( buf, buflen, "%.1f", ratio );
120    else
121        tr_snprintf( buf, buflen, "%.0f", ratio );
122    return buf;
123}
124
125static tr_bool waitingOnWeb;
126
127static void
128onTorrentFileDownloaded( tr_session   * session UNUSED,
129                         long           response_code UNUSED,
130                         const void   * response,
131                         size_t         response_byte_count,
132                         void         * ctor )
133{
134    tr_ctorSetMetainfo( ctor, response, response_byte_count );
135    waitingOnWeb = FALSE;
136}
137
138static void
139getStatusStr( const tr_stat * st,
140              char *          buf,
141              size_t          buflen )
142{
143    if( st->activity & TR_STATUS_CHECK_WAIT )
144    {
145        tr_snprintf( buf, buflen, "Waiting to verify local files" );
146    }
147    else if( st->activity & TR_STATUS_CHECK )
148    {
149        tr_snprintf( buf, buflen,
150                     "Verifying local files (%.2f%%, %.2f%% valid)",
151                     tr_truncd( 100 * st->recheckProgress, 2 ),
152                     tr_truncd( 100 * st->percentDone, 2 ) );
153    }
154    else if( st->activity & TR_STATUS_DOWNLOAD )
155    {
156        char upStr[80];
157        char dnStr[80];
158        char ratioStr[80];
159
160        tr_formatter_speed_KBps( upStr, st->pieceUploadSpeed_KBps, sizeof( upStr ) );
161        tr_formatter_speed_KBps( dnStr, st->pieceDownloadSpeed_KBps, sizeof( dnStr ) );
162        tr_strlratio( ratioStr, st->ratio, sizeof( ratioStr ) );
163
164        tr_snprintf( buf, buflen,
165            "Progress: %.1f%%, "
166            "dl from %d of %d peers (%s), "
167            "ul to %d (%s) "
168            "[%s]",
169            tr_truncd( 100 * st->percentDone, 1 ),
170            st->peersSendingToUs, st->peersConnected, upStr,
171            st->peersGettingFromUs, dnStr,
172            ratioStr );
173    }
174    else if( st->activity & TR_STATUS_SEED )
175    {
176        char upStr[80];
177        char ratioStr[80];
178
179        tr_formatter_speed_KBps( upStr, st->pieceUploadSpeed_KBps, sizeof( upStr ) );
180        tr_strlratio( ratioStr, st->ratio, sizeof( ratioStr ) );
181
182        tr_snprintf( buf, buflen,
183                     "Seeding, uploading to %d of %d peer(s), %s [%s]",
184                     st->peersGettingFromUs, st->peersConnected, upStr, ratioStr );
185    }
186    else *buf = '\0';
187}
188
189static const char*
190getConfigDir( int argc, const char ** argv )
191{
192    int c;
193    const char * configDir = NULL;
194    const char * optarg;
195    const int ind = tr_optind;
196
197    while(( c = tr_getopt( getUsage( ), argc, argv, options, &optarg ))) {
198        if( c == 'g' ) {
199            configDir = optarg;
200            break;
201        }
202    }
203
204    tr_optind = ind;
205
206    if( configDir == NULL )
207        configDir = tr_getDefaultConfigDir( MY_NAME );
208
209    return configDir;
210}
211
212int
213main( int argc, char ** argv )
214{
215    int           error;
216    tr_session  * h;
217    tr_ctor     * ctor;
218    tr_torrent  * tor = NULL;
219    tr_benc       settings;
220    const char  * configDir;
221    uint8_t     * fileContents;
222    size_t        fileLength;
223
224    tr_formatter_mem_init( MEM_K, MEM_B_STR, MEM_K_STR, MEM_M_STR, MEM_G_STR );
225    tr_formatter_size_init( DISK_K,DISK_B_STR, DISK_K_STR, DISK_M_STR, DISK_G_STR );
226    tr_formatter_speed_init( SPEED_K, SPEED_B_STR, SPEED_K_STR, SPEED_M_STR, SPEED_G_STR );
227
228    printf( "Transmission %s - http://www.transmissionbt.com/\n",
229            LONG_VERSION_STRING );
230
231    /* user needs to pass in at least one argument */
232    if( argc < 2 ) {
233        tr_getopt_usage( MY_NAME, getUsage( ), options );
234        return EXIT_FAILURE;
235    }
236
237    /* load the defaults from config file + libtransmission defaults */
238    tr_bencInitDict( &settings, 0 );
239    configDir = getConfigDir( argc, (const char**)argv );
240    tr_sessionLoadSettings( &settings, configDir, MY_NAME );
241
242    /* the command line overrides defaults */
243    if( parseCommandLine( &settings, argc, (const char**)argv ) )
244        return EXIT_FAILURE;
245
246    /* Check the options for validity */
247    if( !torrentPath ) {
248        fprintf( stderr, "No torrent specified!\n" );
249        return EXIT_FAILURE;
250    }
251
252    h = tr_sessionInit( "cli", configDir, FALSE, &settings );
253
254    ctor = tr_ctorNew( h );
255
256    fileContents = tr_loadFile( torrentPath, &fileLength );
257    tr_ctorSetPaused( ctor, TR_FORCE, FALSE );
258    if( fileContents != NULL ) {
259        tr_ctorSetMetainfo( ctor, fileContents, fileLength );
260    } else if( !memcmp( torrentPath, "magnet:?", 8 ) ) {
261        tr_ctorSetMetainfoFromMagnetLink( ctor, torrentPath );
262    } else if( !memcmp( torrentPath, "http", 4 ) ) {
263        tr_webRun( h, torrentPath, NULL, onTorrentFileDownloaded, ctor );
264        waitingOnWeb = TRUE;
265        while( waitingOnWeb ) tr_wait_msec( 1000 );
266    }
267    tr_free( fileContents );
268
269    tor = tr_torrentNew( ctor, &error );
270    tr_ctorFree( ctor );
271    if( !tor )
272    {
273        fprintf( stderr, "Failed opening torrent file `%s'\n", torrentPath );
274        tr_sessionClose( h );
275        return EXIT_FAILURE;
276    }
277
278    signal( SIGINT, sigHandler );
279#ifndef WIN32
280    signal( SIGHUP, sigHandler );
281#endif
282    tr_torrentStart( tor );
283
284    if( verify )
285    {
286        verify = 0;
287        tr_torrentVerify( tor );
288    }
289
290    for( ; ; )
291    {
292        char            line[LINEWIDTH];
293        const tr_stat * st;
294        const char * messageName[] = { NULL, "Tracker gave a warning:",
295                                             "Tracker gave an error:",
296                                             "Error:" };
297
298        tr_wait_msec( 200 );
299
300        if( gotsig )
301        {
302            gotsig = 0;
303            printf( "\nStopping torrent...\n" );
304            tr_torrentStop( tor );
305        }
306
307        if( manualUpdate )
308        {
309            manualUpdate = 0;
310            if( !tr_torrentCanManualUpdate( tor ) )
311                fprintf(
312                    stderr,
313                    "\nReceived SIGHUP, but can't send a manual update now\n" );
314            else
315            {
316                fprintf( stderr,
317                         "\nReceived SIGHUP: manual update scheduled\n" );
318                tr_torrentManualUpdate( tor );
319            }
320        }
321
322        st = tr_torrentStat( tor );
323        if( st->activity & TR_STATUS_STOPPED )
324            break;
325
326        getStatusStr( st, line, sizeof( line ) );
327        printf( "\r%-*s", LINEWIDTH, line );
328
329        if( messageName[st->error] )
330            fprintf( stderr, "\n%s: %s\n", messageName[st->error], st->errorString );
331    }
332
333    tr_sessionSaveSettings( h, configDir, &settings );
334
335    printf( "\n" );
336    tr_bencFree( &settings );
337    tr_sessionClose( h );
338    return EXIT_SUCCESS;
339}
340
341/***
342****
343****
344****
345***/
346
347static int
348parseCommandLine( tr_benc * d, int argc, const char ** argv )
349{
350    int          c;
351    const char * optarg;
352
353    while(( c = tr_getopt( getUsage( ), argc, argv, options, &optarg )))
354    {
355        switch( c )
356        {
357            case 'b': tr_bencDictAddBool( d, TR_PREFS_KEY_BLOCKLIST_ENABLED, TRUE );
358                      break;
359            case 'B': tr_bencDictAddBool( d, TR_PREFS_KEY_BLOCKLIST_ENABLED, FALSE );
360                      break;
361            case 'd': tr_bencDictAddInt ( d, TR_PREFS_KEY_DSPEED_KBps, atoi( optarg ) );
362                      tr_bencDictAddBool( d, TR_PREFS_KEY_DSPEED_ENABLED, TRUE );
363                      break;
364            case 'D': tr_bencDictAddBool( d, TR_PREFS_KEY_DSPEED_ENABLED, FALSE );
365                      break;
366            case 'f': tr_bencDictAddStr( d, TR_PREFS_KEY_SCRIPT_TORRENT_DONE_FILENAME, optarg );
367                      tr_bencDictAddBool( d, TR_PREFS_KEY_SCRIPT_TORRENT_DONE_ENABLED, TRUE );
368                      break;
369            case 'g': /* handled above */
370                      break;
371            case 'm': tr_bencDictAddBool( d, TR_PREFS_KEY_PORT_FORWARDING, TRUE );
372                      break;
373            case 'M': tr_bencDictAddBool( d, TR_PREFS_KEY_PORT_FORWARDING, FALSE );
374                      break;
375            case 'p': tr_bencDictAddInt( d, TR_PREFS_KEY_PEER_PORT, atoi( optarg ) );
376                      break;
377            case 't': tr_bencDictAddInt( d, TR_PREFS_KEY_PEER_SOCKET_TOS, atoi( optarg ) );
378                      break;
379            case 'u': tr_bencDictAddInt( d, TR_PREFS_KEY_USPEED_KBps, atoi( optarg ) );
380                      tr_bencDictAddBool( d, TR_PREFS_KEY_USPEED_ENABLED, TRUE );
381                      break;
382            case 'U': tr_bencDictAddBool( d, TR_PREFS_KEY_USPEED_ENABLED, FALSE );
383                      break;
384            case 'v': verify = 1;
385                      break;
386            case 'w': tr_bencDictAddStr( d, TR_PREFS_KEY_DOWNLOAD_DIR, optarg );
387                      break;
388            case 910: tr_bencDictAddInt( d, TR_PREFS_KEY_ENCRYPTION, TR_ENCRYPTION_REQUIRED );
389                      break;
390            case 911: tr_bencDictAddInt( d, TR_PREFS_KEY_ENCRYPTION, TR_ENCRYPTION_PREFERRED );
391                      break;
392            case 912: tr_bencDictAddInt( d, TR_PREFS_KEY_ENCRYPTION, TR_CLEAR_PREFERRED );
393                      break;
394            case TR_OPT_UNK:
395                      torrentPath = optarg;
396                      break;
397            default: return 1;
398        }
399    }
400
401    return 0;
402}
403
404static void
405sigHandler( int signal )
406{
407    switch( signal )
408    {
409        case SIGINT:
410            gotsig = 1; break;
411
412#ifndef WIN32
413        case SIGHUP:
414            manualUpdate = 1; break;
415
416#endif
417        default:
418            break;
419    }
420}
421
Note: See TracBrowser for help on using the repository browser.