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

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

add support for compressing the content served by the rpc server -- rpc responses and clutch html/css/js files

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