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

Last change on this file since 6847 was 6847, checked in by charles, 13 years ago

(rpc) #1319: possible fix for the deflate bug

  • Property svn:keywords set to Date Rev Author Id
File size: 18.7 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 6847 2008-10-03 23:20:44Z charles $
11 */
12
13#include <assert.h>
14#include <string.h> /* memcpy */
15#include <limits.h> /* INT_MAX */
16
17#include <sys/types.h> /* open */
18#include <sys/stat.h>  /* open */
19#include <fcntl.h>     /* open */
20#include <unistd.h>    /* close */
21
22#ifdef HAVE_LIBZ
23 #include <zlib.h>
24#endif
25
26#include <libevent/event.h>
27#include <libevent/evhttp.h>
28
29#include "transmission.h"
30#include "bencode.h"
31#include "list.h"
32#include "platform.h"
33#include "rpcimpl.h"
34#include "rpc-server.h"
35#include "trevent.h"
36#include "utils.h"
37#include "web.h"
38
39#define MY_NAME "RPC Server"
40#define MY_REALM "Transmission"
41#define TR_N_ELEMENTS( ary ) ( sizeof( ary ) / sizeof( *ary ) )
42
43struct tr_rpc_server
44{
45    unsigned int       isEnabled          : 1;
46    unsigned int       isPasswordEnabled  : 1;
47    unsigned int       isWhitelistEnabled : 1;
48    uint16_t           port;
49    struct evhttp *    httpd;
50    tr_handle *        session;
51    char *             username;
52    char *             password;
53    char *             whitelist;
54};
55
56#define dbgmsg( fmt ... ) tr_deepLog( __FILE__, __LINE__, MY_NAME, ## fmt )
57
58/**
59***
60**/
61
62static void
63send_simple_response( struct evhttp_request * req,
64                      int                     code,
65                      const char *            text )
66{
67    const char *      code_text = tr_webGetResponseStr( code );
68    struct evbuffer * body = evbuffer_new( );
69
70    evbuffer_add_printf( body, "<h1>%s</h1>", code_text );
71    if( text )
72        evbuffer_add_printf( body, "<h2>%s</h2>", text );
73    evhttp_send_reply( req, code, code_text, body );
74    evbuffer_free( body );
75}
76
77static const char*
78tr_memmem( const char * s1,
79           size_t       l1,
80           const char * s2,
81           size_t       l2 )
82{
83    if( !l2 ) return s1;
84    while( l1 >= l2 )
85    {
86        l1--;
87        if( !memcmp( s1, s2, l2 ) )
88            return s1;
89        s1++;
90    }
91
92    return NULL;
93}
94
95static void
96handle_upload( struct evhttp_request * req,
97               struct tr_rpc_server *  server )
98{
99    if( req->type != EVHTTP_REQ_POST )
100    {
101        send_simple_response( req, 405, NULL );
102    }
103    else
104    {
105        const char * content_type = evhttp_find_header( req->input_headers,
106                                                        "Content-Type" );
107
108        const char * query = strchr( req->uri, '?' );
109        const int    paused = query && strstr( query + 1, "paused=true" );
110
111        const char * in = (const char *) EVBUFFER_DATA( req->input_buffer );
112        size_t       inlen = EVBUFFER_LENGTH( req->input_buffer );
113
114        const char * boundary_key = "boundary=";
115        const char * boundary_key_begin = strstr( content_type,
116                                                  boundary_key );
117        const char * boundary_val =
118            boundary_key_begin ? boundary_key_begin +
119            strlen( boundary_key ) : "arglebargle";
120
121        char *       boundary = tr_strdup_printf( "--%s", boundary_val );
122        const size_t boundary_len = strlen( boundary );
123
124        const char * delim = tr_memmem( in, inlen, boundary, boundary_len );
125        while( delim )
126        {
127            size_t       part_len;
128            const char * part = delim + boundary_len;
129            inlen -= ( part - in );
130            in = part;
131            delim = tr_memmem( in, inlen, boundary, boundary_len );
132            part_len = delim ? (size_t)( delim - part ) : inlen;
133
134            if( part_len )
135            {
136                char * text = tr_strndup( part, part_len );
137                if( strstr( text, "filename=\"" ) )
138                {
139                    const char * body = strstr( text, "\r\n\r\n" );
140                    if( body )
141                    {
142                        char *  b64, *json, *freeme;
143                        int     json_len;
144                        size_t  body_len;
145                        tr_benc top, *args;
146
147                        body += 4;
148                        body_len = part_len - ( body - text );
149                        if( body_len >= 2
150                          && !memcmp( &body[body_len - 2], "\r\n", 2 ) )
151                            body_len -= 2;
152
153                        tr_bencInitDict( &top, 2 );
154                        args = tr_bencDictAddDict( &top, "arguments", 2 );
155                        tr_bencDictAddStr( &top, "method", "torrent-add" );
156                        b64 = tr_base64_encode( body, body_len, NULL );
157                        tr_bencDictAddStr( args, "metainfo", b64 );
158                        tr_bencDictAddInt( args, "paused", paused );
159                        json = tr_bencSaveAsJSON( &top, &json_len );
160                        freeme = tr_rpc_request_exec_json( server->session,
161                                                           json, json_len,
162                                                           NULL );
163
164                        tr_free( freeme );
165                        tr_free( json );
166                        tr_free( b64 );
167                        tr_bencFree( &top );
168                    }
169                }
170                tr_free( text );
171            }
172        }
173
174        tr_free( boundary );
175
176        /* use xml here because json responses to file uploads is trouble.
177         * see http://www.malsup.com/jquery/form/#sample7 for details */
178        evhttp_add_header( req->output_headers, "Content-Type",
179                           "text/xml; charset=UTF-8" );
180        send_simple_response( req, HTTP_OK, NULL );
181    }
182}
183
184static const char*
185mimetype_guess( const char * path )
186{
187    unsigned int i;
188
189    const struct
190    {
191        const char *    suffix;
192        const char *    mime_type;
193    } types[] = {
194        /* these are just the ones we need for serving clutch... */
195        { "css",  "text/css"                       },
196        { "gif",  "image/gif"                      },
197        { "html", "text/html"                      },
198        { "ico",  "image/vnd.microsoft.icon"       },
199        { "js",   "application/javascript"         },
200        { "png",  "image/png"                      }
201    };
202    const char * dot = strrchr( path, '.' );
203
204    for( i = 0; dot && i < TR_N_ELEMENTS( types ); ++i )
205        if( !strcmp( dot + 1, types[i].suffix ) )
206            return types[i].mime_type;
207
208    return "application/octet-stream";
209}
210
211#ifdef HAVE_LIBZ
212static int
213compress_evbuf( struct evbuffer * evbuf )
214{
215    int err = 0;
216    struct evbuffer  * out;
217    static z_stream    stream;
218
219    stream.zalloc = Z_NULL;
220    stream.zfree = Z_NULL;
221    stream.opaque = Z_NULL;
222    deflateInit( &stream, Z_DEFAULT_COMPRESSION );
223
224    stream.next_in = EVBUFFER_DATA( evbuf );
225    stream.avail_in = EVBUFFER_LENGTH( evbuf );
226    out = evbuffer_new( );
227
228    while( !err ) {
229        unsigned char buf[1024];
230        int state;
231        stream.next_out = buf;
232        stream.avail_out = sizeof( buf );
233        state = deflate( &stream, Z_FINISH );
234        if( ( state != Z_OK ) && ( state != Z_STREAM_END ) ) {
235            tr_nerr( MY_NAME, _( "Error deflating file: %s" ), zError( err ) );
236            err = state;
237            break;
238        }
239        evbuffer_add( out, buf, sizeof(buf) - stream.avail_out );
240        if( state == Z_STREAM_END )
241            break;
242    }
243
244    /* if the deflated form is larger, then just use the original */
245    if( !err && ( EVBUFFER_LENGTH( out ) >= EVBUFFER_LENGTH( evbuf ) ) )
246        err = -1;
247
248    if( !err ) {
249        tr_ninf( MY_NAME, "deflated response from %zu bytes to %zu",
250                          EVBUFFER_LENGTH( evbuf ),
251                          EVBUFFER_LENGTH( out ) );
252        evbuffer_drain( evbuf, EVBUFFER_LENGTH( evbuf ) );
253        evbuffer_add_buffer( evbuf, out );
254    }
255
256    deflateEnd( &stream );
257    evbuffer_free( out );
258    return err;
259}
260#endif
261
262static void
263maybe_deflate_response( struct evhttp_request * req,
264                        struct evbuffer *       response )
265{
266#ifdef HAVE_LIBZ
267    const char * accept_encoding = evhttp_find_header( req->input_headers,
268                                                       "Accept-Encoding" );
269    const int    do_deflate = accept_encoding && strstr( accept_encoding,
270                                                         "deflate" );
271    if( do_deflate && !compress_evbuf( response ) )
272        evhttp_add_header( req->output_headers, "Content-Encoding", "deflate" );
273#endif
274}
275
276static void
277serve_file( struct evhttp_request * req,
278            const char *            path )
279{
280    if( req->type != EVHTTP_REQ_GET )
281    {
282        evhttp_add_header( req->output_headers, "Allow", "GET" );
283        send_simple_response( req, 405, NULL );
284    }
285    else
286    {
287        const int fd = open( path, O_RDONLY, 0 );
288        if( fd == -1 )
289        {
290            send_simple_response( req, HTTP_NOTFOUND, NULL );
291        }
292        else
293        {
294            struct evbuffer * buf = evbuffer_new( );
295            for( ;; )
296                if( evbuffer_read( buf, fd, INT_MAX ) < 1 )
297                    break;
298            evhttp_add_header( req->output_headers, "Content-Type",
299                              mimetype_guess(
300                                  path ) );
301            maybe_deflate_response( req, buf );
302            evhttp_send_reply( req, HTTP_OK, "OK", buf );
303            evbuffer_free( buf );
304            close( fd );
305        }
306    }
307}
308
309static void
310handle_clutch( struct evhttp_request * req,
311               struct tr_rpc_server *  server )
312{
313    char * pch;
314    char * subpath;
315    char * filename;
316    const char * clutchDir = tr_getClutchDir( server->session );
317
318    assert( !strncmp( req->uri, "/transmission/web/", 18 ) );
319
320    subpath = tr_strdup( req->uri + 18 );
321    if(( pch = strchr( subpath, '?' )))
322        *pch = '\0';
323
324    filename = *subpath
325        ? tr_strdup_printf( "%s%s%s", clutchDir, TR_PATH_DELIMITER_STR, subpath )
326        : tr_strdup_printf( "%s%s%s", clutchDir, TR_PATH_DELIMITER_STR, "index.html" );
327
328    serve_file( req, filename );
329
330    tr_free( filename );
331    tr_free( subpath );
332}
333
334static void
335handle_rpc( struct evhttp_request * req,
336            struct tr_rpc_server *  server )
337{
338    int               len = 0;
339    char *            response = NULL;
340    struct evbuffer * buf;
341
342    if( req->type == EVHTTP_REQ_GET )
343    {
344        const char * q;
345        if( ( q = strchr( req->uri, '?' ) ) )
346            response = tr_rpc_request_exec_uri( server->session,
347                                                q + 1,
348                                                strlen( q + 1 ),
349                                                &len );
350    }
351    else if( req->type == EVHTTP_REQ_POST )
352    {
353        response = tr_rpc_request_exec_json( server->session,
354                                             EVBUFFER_DATA( req->
355                                                            input_buffer ),
356                                             EVBUFFER_LENGTH( req->
357                                                              input_buffer ),
358                                             &len );
359    }
360
361    buf = evbuffer_new( );
362    evbuffer_add( buf, response, len );
363    maybe_deflate_response( req, buf );
364    evhttp_add_header( req->output_headers, "Content-Type",
365                       "application/json; charset=UTF-8" );
366    evhttp_send_reply( req, HTTP_OK, "OK", buf );
367
368    /* cleanup */
369    evbuffer_free( buf );
370    tr_free( response );
371}
372
373static int
374isAddressAllowed( const tr_rpc_server * server,
375                  const char *          address )
376{
377    const char * str;
378
379    if( !server->isWhitelistEnabled )
380        return 1;
381
382    for( str = server->whitelist; str && *str; )
383    {
384        const char * delimiter = strchr( str, ',' );
385        const int    len = delimiter ? delimiter - str : (int)strlen( str );
386        char *       token = tr_strndup( str, len );
387        const int    match = tr_wildmat( address, token );
388        tr_free( token );
389        if( match )
390            return 1;
391        if( !delimiter )
392            break;
393        str = delimiter + 1;
394    }
395
396    return 0;
397}
398
399static void
400handle_request( struct evhttp_request * req,
401                void *                  arg )
402{
403    struct tr_rpc_server * server = arg;
404
405    if( req && req->evcon )
406    {
407        const char * auth;
408        char *       user = NULL;
409        char *       pass = NULL;
410
411        evhttp_add_header( req->output_headers, "Server", MY_REALM );
412
413        auth = evhttp_find_header( req->input_headers, "Authorization" );
414
415        if( auth && !strncasecmp( auth, "basic ", 6 ) )
416        {
417            int    plen;
418            char * p = tr_base64_decode( auth + 6, 0, &plen );
419            if( p && plen && ( ( pass = strchr( p, ':' ) ) ) )
420            {
421                user = p;
422                *pass++ = '\0';
423            }
424        }
425
426        if( !isAddressAllowed( server, req->remote_host ) )
427        {
428            send_simple_response( req, 401, "Unauthorized IP Address" );
429        }
430        else if( server->isPasswordEnabled && ( !pass
431                                              || !user
432                                              || strcmp( server->username,
433                                                         user )
434                                              || strcmp( server->password,
435                                                         pass ) ) )
436        {
437            evhttp_add_header( req->output_headers,
438                               "WWW-Authenticate",
439                               "Basic realm=\"" MY_REALM "\"" );
440            send_simple_response( req, 401, "Unauthorized User" );
441        }
442        else if( !strcmp( req->uri, "/transmission/web" )
443               || !strcmp( req->uri, "/transmission/clutch" )
444               || !strcmp( req->uri, "/" ) )
445        {
446            evhttp_add_header( req->output_headers, "Location",
447                               "/transmission/web/" );
448            send_simple_response( req, HTTP_MOVEPERM, NULL );
449        }
450        else if( !strncmp( req->uri, "/transmission/web/", 18 ) )
451        {
452            handle_clutch( req, server );
453        }
454        else if( !strncmp( req->uri, "/transmission/rpc", 17 ) )
455        {
456            handle_rpc( req, server );
457        }
458        else if( !strncmp( req->uri, "/transmission/upload", 20 ) )
459        {
460            handle_upload( req, server );
461        }
462        else
463        {
464            send_simple_response( req, HTTP_NOTFOUND, NULL );
465        }
466
467        tr_free( user );
468    }
469}
470
471static void
472startServer( void * vserver )
473{
474    tr_rpc_server * server  = vserver;
475
476    if( !server->httpd )
477    {
478        server->httpd = evhttp_new( tr_eventGetBase( server->session ) );
479        evhttp_bind_socket( server->httpd, "0.0.0.0", server->port );
480        evhttp_set_gencb( server->httpd, handle_request, server );
481    }
482}
483
484static void
485stopServer( tr_rpc_server * server )
486{
487    if( server->httpd )
488    {
489        evhttp_free( server->httpd );
490        server->httpd = NULL;
491    }
492}
493
494static void
495onEnabledChanged( void * vserver )
496{
497    tr_rpc_server * server = vserver;
498
499    if( !server->isEnabled )
500        stopServer( server );
501    else
502        startServer( server );
503}
504
505void
506tr_rpcSetEnabled( tr_rpc_server * server,
507                  int             isEnabled )
508{
509    server->isEnabled = isEnabled != 0;
510
511    tr_runInEventThread( server->session, onEnabledChanged, server );
512}
513
514int
515tr_rpcIsEnabled( const tr_rpc_server * server )
516{
517    return server->isEnabled;
518}
519
520static void
521restartServer( void * vserver )
522{
523    tr_rpc_server * server = vserver;
524
525    if( server->isEnabled )
526    {
527        stopServer( server );
528        startServer( server );
529    }
530}
531
532void
533tr_rpcSetPort( tr_rpc_server * server,
534               uint16_t        port )
535{
536    if( server->port != port )
537    {
538        server->port = port;
539
540        if( server->isEnabled )
541            tr_runInEventThread( server->session, restartServer, server );
542    }
543}
544
545uint16_t
546tr_rpcGetPort( const tr_rpc_server * server )
547{
548    return server->port;
549}
550
551void
552tr_rpcSetWhitelist( tr_rpc_server * server,
553                    const char *    whitelist )
554{
555    tr_free( server->whitelist );
556    server->whitelist = tr_strdup( whitelist );
557}
558
559char*
560tr_rpcGetWhitelist( const tr_rpc_server * server )
561{
562    return tr_strdup( server->whitelist ? server->whitelist : "" );
563}
564
565void
566tr_rpcSetWhitelistEnabled( tr_rpc_server  * server,
567                           int              isEnabled )
568{
569    server->isWhitelistEnabled = isEnabled != 0;
570}
571
572int
573tr_rpcGetWhitelistEnabled( const tr_rpc_server * server )
574{
575    return server->isWhitelistEnabled;
576}
577
578/****
579*****  PASSWORD
580****/
581
582void
583tr_rpcSetUsername( tr_rpc_server * server,
584                   const char *    username )
585{
586    tr_free( server->username );
587    server->username = tr_strdup( username );
588    dbgmsg( "setting our Username to [%s]", server->username );
589}
590
591char*
592tr_rpcGetUsername( const tr_rpc_server * server )
593{
594    return tr_strdup( server->username ? server->username : "" );
595}
596
597void
598tr_rpcSetPassword( tr_rpc_server * server,
599                   const char *    password )
600{
601    tr_free( server->password );
602    server->password = tr_strdup( password );
603    dbgmsg( "setting our Password to [%s]", server->password );
604}
605
606char*
607tr_rpcGetPassword( const tr_rpc_server * server )
608{
609    return tr_strdup( server->password ? server->password : "" );
610}
611
612void
613tr_rpcSetPasswordEnabled( tr_rpc_server * server,
614                          int             isEnabled )
615{
616    server->isPasswordEnabled = isEnabled != 0;
617    dbgmsg( "setting 'password enabled' to %d", isEnabled );
618}
619
620int
621tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
622{
623    return server->isPasswordEnabled;
624}
625
626/****
627*****  LIFE CYCLE
628****/
629
630static void
631closeServer( void * vserver )
632{
633    tr_rpc_server * s = vserver;
634
635    stopServer( s );
636    tr_free( s->whitelist );
637    tr_free( s->username );
638    tr_free( s->password );
639    tr_free( s );
640}
641
642void
643tr_rpcClose( tr_rpc_server ** ps )
644{
645    tr_runInEventThread( ( *ps )->session, closeServer, *ps );
646    *ps = NULL;
647}
648
649tr_rpc_server *
650tr_rpcInit( tr_handle *  session,
651            int          isEnabled,
652            uint16_t     port,
653            int          isWhitelistEnabled,
654            const char * whitelist,
655            int          isPasswordEnabled,
656            const char * username,
657            const char * password )
658{
659    tr_rpc_server * s;
660
661    s = tr_new0( tr_rpc_server, 1 );
662    s->session = session;
663    s->port = port;
664    s->whitelist = tr_strdup( whitelist && *whitelist ? whitelist : TR_DEFAULT_RPC_WHITELIST );
665    s->username = tr_strdup( username );
666    s->password = tr_strdup( password );
667    s->isWhitelistEnabled = isWhitelistEnabled != 0;
668    s->isPasswordEnabled = isPasswordEnabled != 0;
669    s->isEnabled = isEnabled != 0;
670    if( isEnabled )
671        tr_runInEventThread( session, startServer, s );
672    return s;
673}
674
Note: See TracBrowser for help on using the repository browser.