source: trunk/libtransmission/rpc-server.c @ 6336

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

(gtk) #1088: when the gtk+ client is serving Clutch, torrents added via Clutch aren't shown in gtk+ client

  • Property svn:keywords set to Date Rev Author Id
File size: 17.6 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: rpc-server.c 6336 2008-07-15 19:25:46Z charles $
11 */
12
13#include <assert.h>
14#include <ctype.h> /* isdigit */
15#include <errno.h>
16#include <stdlib.h> /* strtol */
17#include <string.h>
18
19#include <unistd.h> /* unlink */
20
21#include <libevent/event.h>
22#include <shttpd/defs.h> /* edit_passwords */
23#include <shttpd/shttpd.h>
24
25#include "transmission.h"
26#include "bencode.h"
27#include "platform.h"
28#include "rpc.h"
29#include "rpc-server.h"
30#include "utils.h"
31
32#define MY_NAME "RPC Server"
33#define MY_REALM "Transmission RPC Server"
34
35#define BUSY_INTERVAL_MSEC 30
36#define IDLE_INTERVAL_MSEC 66
37#define UNUSED_INTERVAL_MSEC 100
38
39struct tr_rpc_server
40{
41    int port;
42    time_t lastRequestTime;
43    struct shttpd_ctx * ctx;
44    tr_handle * session;
45    struct evbuffer * in;
46    struct evbuffer * out;
47    struct event timer;
48    int isPasswordEnabled;
49    char * username;
50    char * password;
51    char * acl;
52};
53
54#define dbgmsg(fmt...) tr_deepLog(__FILE__, __LINE__, MY_NAME, ##fmt )
55
56static const char*
57tr_memmem( const char * s1, size_t l1,
58           const char * s2, size_t l2 )
59{
60        if (!l2) return s1;
61        while (l1 >= l2) {
62                l1--;
63                if (!memcmp(s1,s2,l2))
64                        return s1;
65                s1++;
66        }
67        return NULL;
68}
69
70static void
71handle_upload( struct shttpd_arg * arg )
72{
73    struct tr_rpc_server * s = arg->user_data;
74    s->lastRequestTime = time( NULL );
75
76    /* if we haven't parsed the POST, do that now */
77    if( !EVBUFFER_LENGTH( s->out ) )
78    {
79        /* if we haven't finished reading the POST, read more now */
80        evbuffer_add( s->in, arg->in.buf, arg->in.len );
81        arg->in.num_bytes = arg->in.len;
82        if( arg->flags & SHTTPD_MORE_POST_DATA )
83            return;
84
85        const char * query_string = shttpd_get_env( arg, "QUERY_STRING" );
86        const char * content_type = shttpd_get_header( arg, "Content-Type" );
87        const char * delim;
88        const char * in = (const char *) EVBUFFER_DATA( s->in );
89        size_t inlen = EVBUFFER_LENGTH( s->in );
90        char * boundary = tr_strdup_printf( "--%s", strstr( content_type, "boundary=" ) + strlen( "boundary=" ) );
91        const size_t boundary_len = strlen( boundary );
92        char buf[64];
93        int paused = ( query_string != NULL )
94                  && ( shttpd_get_var( "paused", query_string, strlen( query_string ), buf, sizeof( buf ) ) == 4 )
95                  && ( !strcmp( buf, "true" ) );
96
97        delim = tr_memmem( in, inlen, boundary, boundary_len );
98        if( delim ) do
99        {
100            size_t part_len;
101            const char * part = delim + boundary_len;
102            inlen -= ( part - in );
103            in = part;
104            delim = tr_memmem( in, inlen, boundary, boundary_len );
105            part_len = delim ? (size_t)(delim-part) : inlen;
106
107            if( part_len )
108            {
109                char * text = tr_strndup( part, part_len );
110                if( strstr( text, "filename=\"" ) )
111                {
112                    const char * body = strstr( text, "\r\n\r\n" );
113                    if( body )
114                    {
115                        char * b64, *json, *freeme;
116                        int json_len;
117                        size_t body_len;
118                        tr_benc top, *args;
119
120                        body += 4;
121                        body_len = part_len - ( body - text );
122                        if( body_len >= 2 && !memcmp(&body[body_len-2],"\r\n",2) )
123                            body_len -= 2;
124
125                        tr_bencInitDict( &top, 2 );
126                        args = tr_bencDictAddDict( &top, "arguments", 2 );
127                        tr_bencDictAddStr( &top, "method", "torrent-add" );
128                        b64 = tr_base64_encode( body, body_len, NULL );
129                        tr_bencDictAddStr( args, "metainfo", b64 );
130                        tr_bencDictAddInt( args, "paused", paused );
131                        json = tr_bencSaveAsJSON( &top, &json_len );
132                        freeme = tr_rpc_request_exec_json( s->session, json, json_len, NULL );
133
134                        tr_free( freeme );
135                        tr_free( json );
136                        tr_free( b64 );
137                        tr_bencFree( &top );
138                    }
139                }
140                tr_free( text );
141            }
142        }
143        while( delim );
144
145        evbuffer_drain( s->in, EVBUFFER_LENGTH( s->in ) );
146        tr_free( boundary );
147
148        {
149            /* use xml here because json responses to file uploads is trouble.
150             * see http://www.malsup.com/jquery/form/#sample7 for details */
151            const char * response = "<result>success</result>";
152            const int len = strlen( response );
153            evbuffer_add_printf( s->out, "HTTP/1.1 200 OK\r\n"
154                                         "Content-Type: text/xml\r\n"
155                                         "Content-Length: %d\r\n"
156                                         "\r\n"
157                                         "%s\r\n", len, response );
158        }
159    }
160
161    if( EVBUFFER_LENGTH( s->out ) )
162    {
163        const int n = MIN( ( int )EVBUFFER_LENGTH( s->out ), arg->out.len );
164        memcpy( arg->out.buf, EVBUFFER_DATA( s->out ), n );
165        evbuffer_drain( s->out, n );
166        arg->out.num_bytes = n;
167    }
168
169    if( !EVBUFFER_LENGTH( s->out ) )
170        arg->flags |= SHTTPD_END_OF_OUTPUT;
171}
172
173static void
174handle_rpc( struct shttpd_arg * arg )
175{
176    struct tr_rpc_server * s = arg->user_data;
177    s->lastRequestTime = time( NULL );
178
179    if( !EVBUFFER_LENGTH( s->out ) )
180    {
181        int len = 0;
182        char * response = NULL;
183        const char * request_method = shttpd_get_env( arg, "REQUEST_METHOD" );
184        const char * query_string = shttpd_get_env( arg, "QUERY_STRING" );
185
186        if( query_string && *query_string )
187            response = tr_rpc_request_exec_uri( s->session,
188                                                query_string,
189                                                strlen( query_string ),
190                                                &len );
191        else if( !strcmp( request_method, "POST" ) )
192        {
193            evbuffer_add( s->in, arg->in.buf, arg->in.len );
194            arg->in.num_bytes = arg->in.len;
195            if( arg->flags & SHTTPD_MORE_POST_DATA )
196                return;
197            response = tr_rpc_request_exec_json( s->session,
198                                                 EVBUFFER_DATA( s->in ),
199                                                 EVBUFFER_LENGTH( s->in ),
200                                                 &len );
201            evbuffer_drain( s->in, EVBUFFER_LENGTH( s->in ) );
202        }
203
204        evbuffer_add_printf( s->out, "HTTP/1.1 200 OK\r\n"
205                                     "Content-Type: application/json\r\n"
206                                     "Content-Length: %d\r\n"
207                                     "\r\n"
208                                     "%*.*s", len, len, len, response );
209        tr_free( response );
210    }
211
212    if( EVBUFFER_LENGTH( s->out ) )
213    {
214        const int n = MIN( ( int )EVBUFFER_LENGTH( s->out ), arg->out.len );
215        memcpy( arg->out.buf, EVBUFFER_DATA( s->out ), n );
216        evbuffer_drain( s->out, n );
217        arg->out.num_bytes = n;
218    }
219
220    if( !EVBUFFER_LENGTH( s->out ) )
221        arg->flags |= SHTTPD_END_OF_OUTPUT;
222}
223
224static void
225rpcPulse( int socket UNUSED, short action UNUSED, void * vserver )
226{
227    int interval;
228    struct timeval tv;
229    tr_rpc_server * server = vserver;
230    const time_t now = time( NULL );
231
232    assert( server );
233
234    if( server->ctx )
235        shttpd_poll( server->ctx, 1 );
236
237    /* set a timer for the next pulse */
238    if( EVBUFFER_LENGTH( server->in ) || EVBUFFER_LENGTH( server->out ) )
239        interval = BUSY_INTERVAL_MSEC;
240    else if( now - server->lastRequestTime < 300 )
241        interval = IDLE_INTERVAL_MSEC;
242    else
243        interval = UNUSED_INTERVAL_MSEC;
244    tv = tr_timevalMsec( interval );
245    evtimer_add( &server->timer, &tv );
246}
247
248static void
249getPasswordFile( tr_rpc_server * server, char * buf, int buflen )
250{
251    tr_buildPath( buf, buflen, tr_sessionGetConfigDir( server->session ),
252                               "htpasswd",
253                               NULL );
254}
255
256static void
257startServer( tr_rpc_server * server )
258{
259    dbgmsg( "in startServer; current context is %p", server->ctx );
260
261    if( !server->ctx )
262    {
263        char ports[128];
264        char passwd[MAX_PATH_LENGTH];
265        const char * clutchDir = tr_getClutchDir( server->session );
266        struct timeval tv = tr_timevalMsec( UNUSED_INTERVAL_MSEC );
267
268        getPasswordFile( server, passwd, sizeof( passwd ) );
269        if( !server->isPasswordEnabled )
270            unlink( passwd );
271        else
272            edit_passwords( passwd, MY_REALM, server->username, server->password );
273
274        server->ctx = shttpd_init( );
275        tr_snprintf( ports, sizeof( ports ), "%d", server->port );
276        shttpd_register_uri( server->ctx, "/transmission/rpc", handle_rpc, server );
277        shttpd_register_uri( server->ctx, "/transmission/upload", handle_upload, server );
278
279        if( clutchDir && *clutchDir ) {
280            char * clutchAlias = tr_strdup_printf( "%s=%s,%s=%s",
281                "/transmission/clutch", clutchDir,
282                "/transmission/web", clutchDir );
283            tr_inf( _( "Serving the web interface files from \"%s\"" ), clutchDir );
284            shttpd_set_option( server->ctx, "aliases", clutchAlias );
285            tr_free( clutchAlias );
286        }
287
288        shttpd_set_option( server->ctx, "ports", ports );
289        shttpd_set_option( server->ctx, "dir_list", "0" );
290        //shttpd_set_option( server->ctx, "root", "/dev/null" );
291        shttpd_set_option( server->ctx, "auth_realm", MY_REALM );
292        if( server->acl ) {
293            dbgmsg( "setting acl [%s]", server->acl );
294            shttpd_set_option( server->ctx, "acl", server->acl );
295        }
296        if( server->isPasswordEnabled ) {
297            char * buf = tr_strdup_printf( "/transmission/rpc=%s,"
298                                           "/transmission/upload=%s", passwd, passwd );
299            shttpd_set_option( server->ctx, "protect", buf );
300            tr_free( buf );
301        }
302
303        evtimer_set( &server->timer, rpcPulse, server );
304        evtimer_add( &server->timer, &tv );
305    }
306}
307
308static void
309stopServer( tr_rpc_server * server )
310{
311    if( server->ctx )
312    {
313        char passwd[MAX_PATH_LENGTH];
314        getPasswordFile( server, passwd, sizeof( passwd ) );
315        unlink( passwd );
316
317        evtimer_del( &server->timer );
318        shttpd_fini( server->ctx );
319        server->ctx = NULL;
320    }
321}
322
323void
324tr_rpcSetEnabled( tr_rpc_server * server, int isEnabled )
325{
326    if( !isEnabled && server->ctx )
327        stopServer( server );
328
329    if( isEnabled && !server->ctx )
330        startServer( server );
331}
332
333int
334tr_rpcIsEnabled( const tr_rpc_server * server )
335{
336    return server->ctx != NULL;
337}
338
339void
340tr_rpcSetPort( tr_rpc_server * server, int port )
341{
342    if( server->port != port )
343    {
344        server->port = port;
345
346        if( server->ctx )
347        {
348            stopServer( server );
349            startServer( server );
350        }
351    }
352}
353
354int
355tr_rpcGetPort( const tr_rpc_server * server )
356{
357    return server->port;
358}
359
360/****
361*****  ACL
362****/
363
364/*
365 * DELIM_CHARS, FOR_EACH_WORD_IN_LIST, isbyte, and testACL are from, or modified from,
366 * shttpd, written by Sergey Lyubka under this license:
367 * "THE BEER-WARE LICENSE" (Revision 42):
368 * Sergey Lyubka wrote this file.  As long as you retain this notice you
369 * can do whatever you want with this stuff. If we meet some day, and you think
370 * this stuff is worth it, you can buy me a beer in return.
371 */
372
373#define  DELIM_CHARS "," /* Separators for lists */
374
375#define FOR_EACH_WORD_IN_LIST(s,len)                                    \
376        for (; s != NULL && (len = strcspn(s, DELIM_CHARS)) != 0;       \
377                        s += len, s+= strspn(s, DELIM_CHARS))
378
379static int isbyte(int n) { return (n >= 0 && n <= 255); }
380
381static char*
382testACL( const char * s )
383{
384    int len;
385
386    FOR_EACH_WORD_IN_LIST(s, len)
387    {
388
389        char flag;
390        int  a, b, c, d, n, mask;
391
392        if( sscanf(s, "%c%d.%d.%d.%d%n",&flag,&a,&b,&c,&d,&n) != 5 )
393            return tr_strdup_printf( _( "[%s]: subnet must be [+|-]x.x.x.x[/x]" ), s );
394        if( flag != '+' && flag != '-')
395            return tr_strdup_printf( _( "[%s]: flag must be + or -" ), s );
396        if( !isbyte(a) || !isbyte(b) || !isbyte(c) || !isbyte(d) )
397            return tr_strdup_printf( _( "[%s]: bad ip address" ), s );
398        if( sscanf(s + n, "/%d", &mask) == 1 && ( mask<0 || mask>32 ) )
399            return tr_strdup_printf( _( "[%s]: bad subnet mask %d" ), s, n );
400    }
401
402    return NULL;
403}
404
405/* 192.*.*.* --> 192.0.0.0/8
406   192.64.*.* --> 192.64.0.0/16
407   192.64.1.* --> 192.64.1.0/24
408   192.64.1.2 --> 192.64.1.2/32 */
409static void
410cidrizeOne( const char * in, int len, struct evbuffer * out )
411{
412    int stars = 0;
413    const char * pch;
414    const char * end;
415    char zero = '0';
416    char huh = '?';
417
418    for( pch=in, end=pch+len; pch!=end; ++pch ) {
419        if( stars && isdigit(*pch) )
420            evbuffer_add( out, &huh, 1 ); 
421        else if( *pch!='*' )
422            evbuffer_add( out, pch, 1 );
423        else {
424            evbuffer_add( out, &zero, 1 );
425            ++stars;
426        }
427    }
428
429    evbuffer_add_printf( out, "/%d", (32-(stars*8)));
430}
431
432char*
433cidrize( const char * acl )
434{
435    int len;
436    const char * walk = acl;
437    char * ret;
438    struct evbuffer * out = evbuffer_new( );
439
440    FOR_EACH_WORD_IN_LIST( walk, len )
441    {
442        cidrizeOne( walk, len, out );
443        evbuffer_add_printf( out, "," );
444    }
445
446    /* the -1 is to eat the final ", " */
447    ret = tr_strndup( (char*) EVBUFFER_DATA(out), EVBUFFER_LENGTH(out)-1 );
448    evbuffer_free( out );
449    return ret;
450}
451
452int
453tr_rpcTestACL( const tr_rpc_server  * server UNUSED,
454               const char           * acl,
455               char                ** setme_errmsg )
456{
457    int err = 0;
458    char * cidr = cidrize( acl );
459    char * errmsg = testACL( cidr );
460    if( errmsg )
461    {
462        if( setme_errmsg )
463            *setme_errmsg = errmsg;
464        else
465            tr_free( errmsg );
466        err = -1;
467    }
468    tr_free( cidr );
469    return err;
470}
471
472int
473tr_rpcSetACL( tr_rpc_server   * server,
474              const char      * acl,
475              char           ** setme_errmsg )
476{
477    char * cidr = cidrize( acl );
478    const int err = tr_rpcTestACL( server, cidr, setme_errmsg );
479
480    if( !err )
481    {
482        const int isRunning = server->ctx != NULL;
483
484        if( isRunning )
485            stopServer( server );
486
487        tr_free( server->acl );
488        server->acl = tr_strdup( cidr );
489        dbgmsg( "setting our ACL to [%s]", server->acl );
490
491        if( isRunning )
492            startServer( server );
493    }
494    tr_free( cidr );
495
496    return err;
497}
498
499char*
500tr_rpcGetACL( const tr_rpc_server * server )
501{
502    return tr_strdup( server->acl ? server->acl : "" );
503}
504
505/****
506*****  PASSWORD
507****/
508
509void
510tr_rpcSetUsername( tr_rpc_server        * server,
511                   const char           * username )
512{
513    const int isRunning = server->ctx != NULL;
514
515    if( isRunning )
516        stopServer( server );
517
518    tr_free( server->username );
519    server->username = tr_strdup( username );
520    dbgmsg( "setting our Username to [%s]", server->username );
521
522    if( isRunning )
523        startServer( server );
524}
525
526char*
527tr_rpcGetUsername( const tr_rpc_server  * server )
528{
529    return tr_strdup( server->username ? server->username : "" );
530}
531
532void
533tr_rpcSetPassword( tr_rpc_server        * server,
534                   const char           * password )
535{
536    const int isRunning = server->ctx != NULL;
537
538    if( isRunning )
539        stopServer( server );
540
541    tr_free( server->password );
542    server->password = tr_strdup( password );
543    dbgmsg( "setting our Password to [%s]", server->password );
544
545    if( isRunning )
546        startServer( server );
547}
548
549char*
550tr_rpcGetPassword( const tr_rpc_server  * server )
551{
552    return tr_strdup( server->password ? server->password : "" );
553}
554
555void
556tr_rpcSetPasswordEnabled( tr_rpc_server  * server,
557                          int              isEnabled )
558{
559    const int isRunning = server->ctx != NULL;
560
561    if( isRunning )
562        stopServer( server );
563
564    server->isPasswordEnabled = isEnabled;
565    dbgmsg( "setting 'password enabled' to %d", isEnabled );
566
567    if( isRunning )
568        startServer( server );
569}
570
571int
572tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
573{
574    return server->isPasswordEnabled;
575}
576
577/****
578*****  LIFE CYCLE
579****/
580
581void
582tr_rpcClose( tr_rpc_server ** ps )
583{
584    tr_rpc_server * s = *ps;
585    *ps = NULL;
586
587    stopServer( s );
588    evbuffer_free( s->in );
589    evbuffer_free( s->out );
590    tr_free( s->acl );
591    tr_free( s );
592}
593
594tr_rpc_server *
595tr_rpcInit( tr_handle   * session,
596            int           isEnabled,
597            int           port,
598            const char  * acl,
599            int           isPasswordEnabled,
600            const char  * username,
601            const char  * password )
602{
603    char * errmsg;
604    tr_rpc_server * s;
605
606    if(( errmsg = testACL ( acl )))
607    {
608        tr_nerr( MY_NAME, errmsg );
609        tr_free( errmsg );
610        acl = TR_DEFAULT_RPC_ACL;
611        tr_nerr( MY_NAME, "using fallback ACL \"%s\"", acl );
612    }
613
614    s = tr_new0( tr_rpc_server, 1 );
615    s->session = session;
616    s->port = port;
617    s->in = evbuffer_new( );
618    s->out = evbuffer_new( );
619    s->acl = tr_strdup( acl );
620    s->username = tr_strdup( username );
621    s->password = tr_strdup( password );
622    s->isPasswordEnabled = isPasswordEnabled;
623   
624    if( isEnabled )
625        startServer( s );
626    return s;   
627}
Note: See TracBrowser for help on using the repository browser.