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

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

slightly more efficient serving of static files & rpc responses

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