source: trunk/daemon/remote.c @ 5860

Last change on this file since 5860 was 5860, checked in by charles, 14 years ago

(1) RPC "add-torrent" now lets clients embed base64-encoded metainfo directly into the request
(2) remove the RISON code; it didn't make the final cut
(3) add base64 encode/decode utilities and unit tests

  • Property svn:keywords set to Date Rev Author Id
File size: 13.9 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.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: remote.c 5860 2008-05-20 17:33:54Z charles $
11 */
12
13#include <stdio.h>
14#include <stdlib.h>
15#include <string.h> /* strcmp */
16
17#include <getopt.h>
18#include <unistd.h> /* getcwd */
19
20#include <libevent/event.h>
21#include <curl/curl.h>
22
23#include <libtransmission/transmission.h>
24#include <libtransmission/bencode.h>
25#include <libtransmission/rpc.h>
26#include <libtransmission/json.h>
27#include <libtransmission/utils.h>
28#include <libtransmission/version.h>
29
30#define MY_NAME "transmission-remote"
31#define DEFAULT_HOST "localhost"
32#define DEFAULT_PORT TR_DEFAULT_RPC_PORT
33
34enum { TAG_LIST };
35
36static void
37showUsage( void )
38{
39    puts( "Transmission "LONG_VERSION_STRING"  http://www.transmissionbt.com/\n"
40            "A fast and easy BitTorrent client\n"
41            "\n"
42            "Usage: "MY_NAME" [host] [options]\n"
43            "       "MY_NAME" [port] [options]\n"
44            "       "MY_NAME" [host:port] [options]\n"
45            "\n"
46            "Options:\n"
47            "  -a --add <torrent>        Add a torrent\n"
48            "  -c --encryption required  Require encryption for all peers\n"
49            "  -c --encryption preferred Prefer peers to use encryption\n"
50            "  -c --encryption tolerated Prefer peers to use plaintext\n"
51            "  -d --download-limit <int> Max download rate in KiB/s\n"
52            "  -D --download-unlimited   No download rate limit\n"
53            "  -e --enable-pex           Enable peer exchange\n"
54            "  -E --disable-pex          Disable peer exchange\n"
55            "  -f --folder <path>        Folder to set for new torrents\n"
56            "  -g --debug                Print debugging information\n"
57            "  -h --help                 Display this message and exit\n"
58            "  -l --list                 Long list of all torrent and status\n"
59            "  -m --port-mapping         Automatic port mapping via NAT-PMP or UPnP\n"
60            "  -M --no-port-mapping      Disable automatic port mapping\n"
61            "  -p --port <int>           Port to listen for incoming peers\n"
62            "  -r --remove <int>         Remove the torrent with the given ID\n"
63            "  -r --remove all           Remove all torrents\n"
64            "  -s --start <int>          Start the torrent with the given ID\n"
65            "  -s --start all            Start all stopped torrents\n"
66            "  -S --stop <int>           Stop the torrent with the given ID\n"
67            "  -S --stop all             Stop all running torrents\n"
68            "  -u --upload-limit <int>   Max upload rate in KiB/s\n"
69            "  -U --upload-unlimited     No upload rate limit\n"
70            "  -v --verify <id>          Verify the torrent's local data\n" );
71    exit( 0 );
72}
73
74static int
75numarg( const char * arg )
76{
77    char * end = NULL;
78    const long num = strtol( arg, &end, 10 );
79    if( *end ) {
80        fprintf( stderr, "Not a number: \"%s\"\n", arg );
81        showUsage( );
82    }
83    return num;
84}
85
86static char * reqs[256]; /* arbitrary max */
87static int reqCount = 0;
88static int debug = 0;
89
90static char*
91absolutify( char * buf, size_t len, const char * path )
92{
93    if( *path == '/' )
94        tr_strlcpy( buf, path, len );
95    else {
96        char cwd[MAX_PATH_LENGTH];
97        getcwd( cwd, sizeof( cwd ) );
98        tr_buildPath( buf, len, cwd, path, NULL );
99    }
100    return buf;
101}
102
103static char*
104getEncodedMetainfo( const char * filename )
105{
106    size_t len;
107    uint8_t * buf = tr_loadFile( filename, &len );
108    char * b64 = tr_base64_encode( buf, len, NULL );
109    tr_free( buf );
110    return b64;
111}
112
113static void
114readargs( int argc, char ** argv )
115{
116    int opt;
117    char optstr[] = "a:c:d:DeEf:ghlmMp:r:s:S:u:Uv:";
118   
119    const struct option longopts[] =
120    {
121        { "add",                required_argument, NULL, 'a' },
122        { "encryption",         required_argument, NULL, 'c' },
123        { "download-limit",     required_argument, NULL, 'd' },
124        { "download-unlimited", no_argument,       NULL, 'D' },
125        { "enable-pex",         no_argument,       NULL, 'e' },
126        { "disable-pex",        no_argument,       NULL, 'E' },
127        { "folder",             required_argument, NULL, 'f' },
128        { "debug",              no_argument,       NULL, 'g' },
129        { "help",               no_argument,       NULL, 'h' },
130        { "list",               no_argument,       NULL, 'l' },
131        { "port-mapping",       no_argument,       NULL, 'm' },
132        { "no-port-mapping",    no_argument,       NULL, 'M' },
133        { "port",               required_argument, NULL, 'p' },
134        { "remove",             required_argument, NULL, 'r' },
135        { "start",              required_argument, NULL, 's' },
136        { "stop",               required_argument, NULL, 'S' },
137        { "upload-limit",       required_argument, NULL, 'u' },
138        { "upload-unlimited",   no_argument,       NULL, 'U' },
139        { "verify",             required_argument, NULL, 'v' },
140        { NULL, 0, NULL, 0 }
141    };
142
143    while((( opt = getopt_long( argc, argv, optstr, longopts, NULL ))) != -1 )
144    {
145        char * tmp;
146        char buf[MAX_PATH_LENGTH];
147        tr_benc top, *args;
148        tr_bencInitDict( &top, 3 );
149        args = tr_bencDictAddDict( &top, "arguments", 0 );
150
151        switch( opt )
152        {
153            case 'g': debug = 1; break;
154            case 'h': showUsage( ); break;
155            case 'a': tr_bencDictAddStr( &top, "method", "torrent-add" );
156                      tr_bencDictAddStr( args, "metainfo", ((tmp=getEncodedMetainfo(optarg))) );
157                      tr_free( tmp );
158                      break;
159            case 'c': tr_bencDictAddStr( &top, "method", "session-set" );
160                      tr_bencDictAddStr( args, "encryption", optarg );
161                      break;
162            case 'd': tr_bencDictAddStr( &top, "method", "session-set" );
163                      tr_bencDictAddInt( args, "speed-limit-down", numarg( optarg ) );
164                      tr_bencDictAddInt( args, "speed-limit-down-enabled", 1 );
165                      break;
166            case 'D': tr_bencDictAddStr( &top, "method", "session-set" );
167                      tr_bencDictAddInt( args, "speed-limit-down-enabled", 0 );
168                      break;
169            case 'u': tr_bencDictAddStr( &top, "method", "session-set" );
170                      tr_bencDictAddInt( args, "speed-limit-up", numarg( optarg ) );
171                      tr_bencDictAddInt( args, "speed-limit-up-enabled", 1 );
172                      break;
173            case 'U': tr_bencDictAddStr( &top, "method", "session-set" );
174                      tr_bencDictAddInt( args, "speed-limit-up-enabled", 0 );
175                      break;
176            case 'e': tr_bencDictAddStr( &top, "method", "session-set" );
177                      tr_bencDictAddInt( args, "pex-allowed", 1 );
178                      break;
179            case 'E': tr_bencDictAddStr( &top, "method", "session-set" );
180                      tr_bencDictAddInt( args, "pex-allowed", 0 );
181                      break;
182            case 'f': tr_bencDictAddStr( &top, "method", "session-set" );
183                      tr_bencDictAddStr( args, "download-dir", absolutify(buf,sizeof(buf),optarg) );
184                      break;
185            case 'l': tr_bencDictAddStr( &top, "method", "torrent-list" );
186                      tr_bencDictAddInt( &top, "tag", TAG_LIST );
187                      break;
188            case 'm': tr_bencDictAddStr( &top, "method", "session-set" );
189                      tr_bencDictAddInt( args, "port-forwarding-enabled", 1 );
190                      break;
191            case 'M': tr_bencDictAddStr( &top, "method", "session-set" );
192                      tr_bencDictAddInt( args, "port-forwarding-enabled", 0 );
193                      break;
194            case 'p': tr_bencDictAddStr( &top, "method", "session-set" );
195                      tr_bencDictAddInt( args, "port", numarg( optarg ) );
196                      break;
197            case 'r': tr_bencDictAddStr( &top, "method", "torrent-remove" );
198                      if( strcmp( optarg, "all" ) )
199                          tr_bencDictAddStr( args, "ids", optarg );
200                      break;
201            case 's': tr_bencDictAddStr( &top, "method", "torrent-start" );
202                      if( strcmp( optarg, "all" ) )
203                          tr_bencDictAddStr( args, "ids", optarg );
204                      break;
205            case 'S': tr_bencDictAddStr( &top, "method", "torrent-stop" );
206                      if( strcmp( optarg, "all" ) )
207                          tr_bencDictAddStr( args, "ids", optarg );
208                      break;
209            case 'v': tr_bencDictAddStr( &top, "method", "torrent-verify" );
210                      if( strcmp( optarg, "all" ) )
211                          tr_bencDictAddStr( args, "ids", optarg );
212                      break;
213            default:
214                      showUsage( );
215                      break;
216        }
217
218        reqs[reqCount++] = tr_bencSaveAsJSON( &top, NULL );
219        tr_bencFree( &top );
220    }
221}
222
223/* [host:port] or [host] or [port] */
224static void
225getHostAndPort( int * argc, char ** argv, char ** host, int * port )
226{
227    if( *argv[1] != '-' )
228    {
229        int i;
230        const char * s = argv[1];
231        const char * delim = strchr( s, ':' );
232        if( delim ) { /* user passed in both host and port */
233            *host = tr_strndup( s, delim-s );
234            *port = atoi( delim+1 );
235        } else {
236            char * end;
237            const int i = strtol( s, &end, 10 );
238            if( !*end ) /* user passed in a port */
239                *port = i;
240            else /* user passed in a host */
241                *host = tr_strdup( s );
242        }
243
244        *argc -= 1;
245        for( i=1; i<*argc; ++i )
246            argv[i] = argv[i+1];
247    }
248}
249
250static size_t
251writeFunc( void * ptr, size_t size, size_t nmemb, void * buf )
252{
253    const size_t byteCount = size * nmemb;
254    evbuffer_add( buf, ptr, byteCount );
255    return byteCount;
256}
257
258static const char*
259torrentStatusToString( int i )
260{
261    switch( i )
262    {
263        case TR_STATUS_CHECK_WAIT: return "Will Verify";
264        case TR_STATUS_CHECK:      return "Verifying";
265        case TR_STATUS_DOWNLOAD:   return "Downloading";
266        case TR_STATUS_SEED:       return "Seeding";
267        case TR_STATUS_STOPPED:    return "Stopped";
268        default:                   return "Error";
269    }
270}
271
272static void
273processResponse( const char * host, int port,
274                 const void * response, size_t len )
275{
276    tr_benc top;
277
278    if( tr_jsonParse( response, len, &top, NULL ) )
279       tr_nerr( MY_NAME, "Unable to parse response" );
280    else
281    {
282        tr_benc *args, *list;
283        int64_t tag = -1;
284        const char * str;
285        tr_bencDictFindInt( &top, "tag", &tag );
286
287        if( tr_bencDictFindStr( &top, "result", &str ) )
288            printf( "%s:%d responded: \"%s\"\n", host, port, str );
289
290        if( ( tag == TAG_LIST ) &&
291            ( tr_bencDictFindDict( &top, "arguments", &args ) ) &&
292            ( tr_bencDictFindList( args, "list", &list ) ) )
293        {
294            int i, n;
295            for( i=0, n=tr_bencListSize( list ); i<n; ++i )
296            {
297                int64_t id, status;
298                const char *name, *ratiostr, *upstr, *dnstr;
299                tr_benc * d = tr_bencListChild( list, i );
300                if(    tr_bencDictFindInt( d, "id", &id )
301                    && tr_bencDictFindInt( d, "status", &status )
302                    && tr_bencDictFindStr( d, "name", &name )
303                    && tr_bencDictFindStr( d, "ratio", &ratiostr )
304                    && tr_bencDictFindStr( d, "rateUpload", &upstr )
305                    && tr_bencDictFindStr( d, "rateDownload", &dnstr ) )
306                {
307                    printf( "%4d.  Up: %5.1f  Down: %5.1f  Ratio: %4.1f  %-15s  %s\n",
308                            (int)id,
309                            strtod( upstr, NULL ),
310                            strtod( dnstr, NULL ),
311                            strtod( ratiostr, NULL ),
312                            torrentStatusToString( status ),
313                            name );
314                }
315            }
316        }
317
318        tr_bencFree( &top );
319    }
320}
321
322static void
323processRequests( const char * host, int port,
324                 const char ** reqs, int reqCount )
325{
326    int i;
327    CURL * curl;
328    struct evbuffer * buf = evbuffer_new( );
329    char * url = tr_strdup_printf( "http://%s:%d/transmission", host, port );
330
331    curl = curl_easy_init( );
332    curl_easy_setopt( curl, CURLOPT_VERBOSE, debug );
333    curl_easy_setopt( curl, CURLOPT_USERAGENT, MY_NAME"/"LONG_VERSION_STRING );
334    curl_easy_setopt( curl, CURLOPT_WRITEFUNCTION, writeFunc );
335    curl_easy_setopt( curl, CURLOPT_WRITEDATA, buf );
336    curl_easy_setopt( curl, CURLOPT_POST, 1 );
337    curl_easy_setopt( curl, CURLOPT_URL, url );
338
339    for( i=0; i<reqCount; ++i )
340    {
341        CURLcode res;
342        curl_easy_setopt( curl, CURLOPT_POSTFIELDS, reqs[i] );
343        if(( res = curl_easy_perform( curl )))
344            tr_nerr( MY_NAME, "(%s:%d) %s", host, port, curl_easy_strerror( res ) );
345        else
346            processResponse( host, port, EVBUFFER_DATA( buf ), EVBUFFER_LENGTH( buf ) );
347
348        evbuffer_drain( buf, EVBUFFER_LENGTH( buf ) );
349    }
350
351    /* cleanup */
352    tr_free( url );
353    evbuffer_free( buf );
354    curl_easy_cleanup( curl );
355}
356
357int
358main( int argc, char ** argv )
359{
360    int i;
361    int port = DEFAULT_PORT;
362    char * host = NULL;
363
364    if( argc < 2 )
365        showUsage( );
366
367    getHostAndPort( &argc, argv, &host, &port );
368    if( host == NULL )
369        host = tr_strdup( DEFAULT_HOST );
370
371    readargs( argc, argv );
372    if( reqCount )
373        processRequests( host, port, (const char**)reqs, reqCount );
374    else
375        showUsage( );
376
377    for( i=0; i<reqCount; ++i )
378        tr_free( reqs[i] );
379
380    tr_free( host );
381    return 0;
382}
Note: See TracBrowser for help on using the repository browser.