source: trunk/cli/cli.c @ 13191

Last change on this file since 13191 was 13191, checked in by jordan, 10 years ago

(trunk) remove trailing spaces from code lines ;)

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