source: trunk/libtransmission/web.c @ 11172

Last change on this file since 11172 was 11172, checked in by charles, 12 years ago

(trunk libT) hm, this debugging line wasn't supposed to get checked in...

  • Property svn:keywords set to Date Rev Author Id
File size: 13.9 KB
Line 
1/*
2 * This file Copyright (C) 2008-2010 Mnemosyne LLC
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: web.c 11172 2010-08-10 11:43:29Z charles $
11 */
12
13#ifdef WIN32
14  #include <ws2tcpip.h>
15#else
16  #include <sys/select.h>
17#endif
18
19#include <curl/curl.h>
20#include <event.h>
21
22#include "transmission.h"
23#include "list.h"
24#include "net.h" /* tr_address */
25#include "platform.h" /* mutex */
26#include "session.h"
27#include "trevent.h" /* tr_runInEventThread() */
28#include "utils.h"
29#include "version.h" /* User-Agent */
30#include "web.h"
31
32#if LIBCURL_VERSION_NUM >= 0x070F06 /* CURLOPT_SOCKOPT* was added in 7.15.6 */
33 #define USE_LIBCURL_SOCKOPT
34#endif
35
36enum
37{
38    THREADFUNC_MAX_SLEEP_MSEC = 1000,
39};
40
41#if 0
42#define dbgmsg(...) \
43    do { \
44        fprintf( stderr, __VA_ARGS__ ); \
45        fprintf( stderr, "\n" ); \
46    } while( 0 )
47#else
48#define dbgmsg( ... ) \
49    do { \
50        if( tr_deepLoggingIsActive( ) ) \
51            tr_deepLog( __FILE__, __LINE__, "web", __VA_ARGS__ ); \
52    } while( 0 )
53#endif
54
55/***
56****
57***/
58
59struct tr_web
60{
61    int close_mode;
62    tr_list * tasks;
63    tr_lock * taskLock;
64};
65
66
67/***
68****
69***/
70
71struct tr_web_task
72{
73    long code;
74    struct evbuffer * response;
75    char * url;
76    char * range;
77    tr_session * session;
78    tr_web_done_func * done_func;
79    void * done_func_user_data;
80};
81
82static void
83task_free( struct tr_web_task * task )
84{
85    evbuffer_free( task->response );
86    tr_free( task->range );
87    tr_free( task->url );
88    tr_free( task );
89}
90
91/***
92****
93***/
94
95static size_t
96writeFunc( void * ptr, size_t size, size_t nmemb, void * vtask )
97{
98    const size_t byteCount = size * nmemb;
99    struct tr_web_task * task = vtask;
100    evbuffer_add( task->response, ptr, byteCount );
101    dbgmsg( "wrote %zu bytes to task %p's buffer", byteCount, task );
102    return byteCount;
103}
104
105#ifdef USE_LIBCURL_SOCKOPT
106static int
107sockoptfunction( void * vtask, curl_socket_t fd, curlsocktype purpose UNUSED )
108{
109    struct tr_web_task * task = vtask;
110    const tr_bool isScrape = strstr( task->url, "scrape" ) != NULL;
111    const tr_bool isAnnounce = strstr( task->url, "announce" ) != NULL;
112
113    /* announce and scrape requests have tiny payloads. */
114    if( isScrape || isAnnounce )
115    {
116        const int sndbuf = 1024;
117        const int rcvbuf = isScrape ? 2048 : 3072;
118        setsockopt( fd, SOL_SOCKET, SO_SNDBUF, &sndbuf, sizeof(sndbuf) );
119        setsockopt( fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, sizeof(rcvbuf) );
120    }
121
122    /* return nonzero if this function encountered an error */
123    return 0;
124}
125#endif
126
127static int
128getCurlProxyType( tr_proxy_type t )
129{
130    if( t == TR_PROXY_SOCKS4 ) return CURLPROXY_SOCKS4;
131    if( t == TR_PROXY_SOCKS5 ) return CURLPROXY_SOCKS5;
132    return CURLPROXY_HTTP;
133}
134
135static long
136getTimeoutFromURL( const struct tr_web_task * task )
137{
138    long timeout;
139    const tr_session * session = task->session;
140
141    if( !session || session->isClosed ) timeout = 20L;
142    else if( strstr( task->url, "scrape" ) != NULL ) timeout = 30L;
143    else if( strstr( task->url, "announce" ) != NULL ) timeout = 90L;
144    else timeout = 240L;
145
146    return timeout;
147}
148
149static CURL *
150createEasy( tr_session * s, struct tr_web_task * task )
151{
152    const tr_address * addr;
153    CURL * e = curl_easy_init( );
154    const long verbose = getenv( "TR_CURL_VERBOSE" ) != NULL;
155
156    if( !task->range && s->isProxyEnabled ) {
157        const long proxyType = getCurlProxyType( s->proxyType );
158        curl_easy_setopt( e, CURLOPT_PROXY, s->proxy );
159        curl_easy_setopt( e, CURLOPT_PROXYAUTH, CURLAUTH_ANY );
160        curl_easy_setopt( e, CURLOPT_PROXYPORT, s->proxyPort );
161        curl_easy_setopt( e, CURLOPT_PROXYTYPE, proxyType );
162    }
163
164    if( !task->range && s->isProxyAuthEnabled ) {
165        char * str = tr_strdup_printf( "%s:%s", s->proxyUsername,
166                                                s->proxyPassword );
167        curl_easy_setopt( e, CURLOPT_PROXYUSERPWD, str );
168        tr_free( str );
169    }
170
171    curl_easy_setopt( e, CURLOPT_AUTOREFERER, 1L );
172    curl_easy_setopt( e, CURLOPT_ENCODING, "gzip;q=1.0, deflate, identity" );
173    curl_easy_setopt( e, CURLOPT_FOLLOWLOCATION, 1L );
174    curl_easy_setopt( e, CURLOPT_MAXREDIRS, -1L );
175    curl_easy_setopt( e, CURLOPT_NOSIGNAL, 1L );
176    curl_easy_setopt( e, CURLOPT_PRIVATE, task );
177#ifdef USE_LIBCURL_SOCKOPT
178    curl_easy_setopt( e, CURLOPT_SOCKOPTFUNCTION, sockoptfunction );
179    curl_easy_setopt( e, CURLOPT_SOCKOPTDATA, task );
180#endif
181    curl_easy_setopt( e, CURLOPT_SSL_VERIFYHOST, 0L );
182    curl_easy_setopt( e, CURLOPT_SSL_VERIFYPEER, 0L );
183    curl_easy_setopt( e, CURLOPT_TIMEOUT, getTimeoutFromURL( task ) );
184    curl_easy_setopt( e, CURLOPT_URL, task->url );
185    curl_easy_setopt( e, CURLOPT_USERAGENT, TR_NAME "/" SHORT_VERSION_STRING );
186    curl_easy_setopt( e, CURLOPT_VERBOSE, verbose );
187    curl_easy_setopt( e, CURLOPT_WRITEDATA, task );
188    curl_easy_setopt( e, CURLOPT_WRITEFUNCTION, writeFunc );
189
190    if(( addr = tr_sessionGetPublicAddress( s, TR_AF_INET )))
191        curl_easy_setopt( e, CURLOPT_INTERFACE, tr_ntop_non_ts( addr ) );
192
193    if( task->range )
194        curl_easy_setopt( e, CURLOPT_RANGE, task->range );
195
196    return e;
197}
198
199/***
200****
201***/
202
203static void
204task_finish_func( void * vtask )
205{
206    struct tr_web_task * task = vtask;
207    dbgmsg( "finished web task %p; got %ld", task, task->code );
208
209    if( task->done_func != NULL )
210        task->done_func( task->session,
211                         task->code,
212                         EVBUFFER_DATA( task->response ),
213                         EVBUFFER_LENGTH( task->response ),
214                         task->done_func_user_data );
215
216    task_free( task );
217}
218
219/****
220*****
221****/
222
223void
224tr_webRun( tr_session         * session,
225           const char         * url,
226           const char         * range,
227           tr_web_done_func     done_func,
228           void               * done_func_user_data )
229{
230    struct tr_web * web = session->web;
231
232    if( web != NULL )
233    {
234        struct tr_web_task * task = tr_new0( struct tr_web_task, 1 );
235
236        task->session = session;
237        task->url = tr_strdup( url );
238        task->range = tr_strdup( range );
239        task->done_func = done_func;
240        task->done_func_user_data = done_func_user_data;
241        task->response = evbuffer_new( );
242
243        tr_lockLock( web->taskLock );
244        tr_list_append( &web->tasks, task );
245        tr_lockUnlock( web->taskLock );
246    }
247}
248
249/**
250 * Portability wrapper for select().
251 *
252 * http://msdn.microsoft.com/en-us/library/ms740141%28VS.85%29.aspx
253 * On win32, any two of the parameters, readfds, writefds, or exceptfds,
254 * can be given as null. At least one must be non-null, and any non-null
255 * descriptor set must contain at least one handle to a socket.
256 */
257static void
258tr_select( int nfds,
259           fd_set * r_fd_set, fd_set * w_fd_set, fd_set * c_fd_set,
260           struct timeval  * t )
261{
262#ifdef WIN32
263    if( !r_fd_set->fd_count && !w_fd_set->fd_count && !c_fd_set->fd_count )
264    {
265        const long int msec = t->tv_sec*1000 + t->tv_usec/1000;
266        tr_wait_msec( msec );
267    }
268    else if( select( 0, r_fd_set->fd_count ? r_fd_set : NULL,
269                        w_fd_set->fd_count ? w_fd_set : NULL,
270                        c_fd_set->fd_count ? c_fd_set : NULL, t ) < 0 )
271    {
272        char errstr[512];
273        const int e = EVUTIL_SOCKET_ERROR( );
274        tr_net_strerror( errstr, sizeof( errstr ), e );
275        dbgmsg( "Error: select (%d) %s", e, errstr ); 
276    }
277#else
278    select( nfds, r_fd_set, w_fd_set, c_fd_set, t );
279#endif
280}
281
282static void
283tr_webThreadFunc( void * vsession )
284{
285    int unused;
286    CURLM * multi;
287    struct tr_web * web;
288    int taskCount = 0;
289    tr_session * session = vsession;
290
291    /* try to enable ssl for https support; but if that fails,
292     * try a plain vanilla init */
293    if( curl_global_init( CURL_GLOBAL_SSL ) )
294        curl_global_init( 0 );
295
296    web = tr_new0( struct tr_web, 1 );
297    web->close_mode = ~0;
298    web->taskLock = tr_lockNew( );
299    web->tasks = NULL;
300    multi = curl_multi_init( );
301    session->web = web;
302
303    for( ;; )
304    {
305        long msec;
306        CURLMsg * msg;
307        CURLMcode mcode;
308        struct tr_web_task * task;
309
310        if( web->close_mode == TR_WEB_CLOSE_NOW )
311            break;
312        if( ( web->close_mode == TR_WEB_CLOSE_WHEN_IDLE ) && !taskCount )
313            break;
314
315        /* add tasks from the queue */
316        tr_lockLock( web->taskLock );
317        while(( task = tr_list_pop_front( &web->tasks )))
318        {
319            dbgmsg( "adding task to curl: [%s]\n", task->url );
320            curl_multi_add_handle( multi, createEasy( session, task ));
321            /*fprintf( stderr, "adding a task.. taskCount is now %d\n", taskCount );*/
322            ++taskCount;
323        }
324        tr_lockUnlock( web->taskLock );
325
326        /* maybe wait a little while before calling curl_multi_perform() */
327        msec = 0;
328        curl_multi_timeout( multi, &msec );
329        if( msec < 0 )
330            msec = THREADFUNC_MAX_SLEEP_MSEC;
331        if( msec > 0 )
332        {
333            int usec;
334            int max_fd;
335            struct timeval t;
336            fd_set r_fd_set, w_fd_set, c_fd_set;
337
338            max_fd = 0;
339            FD_ZERO( &r_fd_set );
340            FD_ZERO( &w_fd_set );
341            FD_ZERO( &c_fd_set );
342            curl_multi_fdset( multi, &r_fd_set, &w_fd_set, &c_fd_set, &max_fd );
343
344            if( msec > THREADFUNC_MAX_SLEEP_MSEC )
345                msec = THREADFUNC_MAX_SLEEP_MSEC;
346
347            usec = msec * 1000;
348            t.tv_sec =  usec / 1000000;
349            t.tv_usec = usec % 1000000;
350
351            tr_select( max_fd+1, &r_fd_set, &w_fd_set, &c_fd_set, &t );
352        }
353
354        /* call curl_multi_perform() */
355        do {
356            mcode = curl_multi_perform( multi, &unused );
357        } while( mcode == CURLM_CALL_MULTI_PERFORM );
358
359        /* pump completed tasks from the multi */
360        while(( msg = curl_multi_info_read( multi, &unused )))
361        {
362            if(( msg->msg == CURLMSG_DONE ) && ( msg->easy_handle != NULL ))
363            {
364                struct tr_web_task * task;
365                CURL * e = msg->easy_handle;
366                curl_easy_getinfo( e, CURLINFO_PRIVATE, (void*)&task );
367                curl_easy_getinfo( e, CURLINFO_RESPONSE_CODE, &task->code );
368                curl_multi_remove_handle( multi, e );
369                curl_easy_cleanup( e );
370/*fprintf( stderr, "removing a completed task.. taskCount is now %d (response code: %d, response len: %d)\n", taskCount, (int)task->code, (int)EVBUFFER_LENGTH(task->response) );*/
371                tr_runInEventThread( task->session, task_finish_func, task );
372                --taskCount;
373            }
374        }
375    }
376
377    /* cleanup */
378    curl_multi_cleanup( multi );
379    tr_lockFree( web->taskLock );
380    tr_free( web );
381    session->web = NULL;
382}
383
384void
385tr_webInit( tr_session * session )
386{
387    tr_threadNew( tr_webThreadFunc, session );
388}
389
390void
391tr_webClose( tr_session * session, tr_web_close_mode close_mode )
392{
393    if( session->web != NULL )
394    {
395        session->web->close_mode = close_mode;
396
397        if( close_mode == TR_WEB_CLOSE_NOW )
398            while( session->web != NULL )
399                tr_wait_msec( 100 );
400    }
401}
402
403/*****
404******
405******
406*****/
407
408const char *
409tr_webGetResponseStr( long code )
410{
411    switch( code )
412    {
413        case   0: return "No Response";
414        case 101: return "Switching Protocols";
415        case 200: return "OK";
416        case 201: return "Created";
417        case 202: return "Accepted";
418        case 203: return "Non-Authoritative Information";
419        case 204: return "No Content";
420        case 205: return "Reset Content";
421        case 206: return "Partial Content";
422        case 300: return "Multiple Choices";
423        case 301: return "Moved Permanently";
424        case 302: return "Found";
425        case 303: return "See Other";
426        case 304: return "Not Modified";
427        case 305: return "Use Proxy";
428        case 306: return "(Unused)";
429        case 307: return "Temporary Redirect";
430        case 400: return "Bad Request";
431        case 401: return "Unauthorized";
432        case 402: return "Payment Required";
433        case 403: return "Forbidden";
434        case 404: return "Not Found";
435        case 405: return "Method Not Allowed";
436        case 406: return "Not Acceptable";
437        case 407: return "Proxy Authentication Required";
438        case 408: return "Request Timeout";
439        case 409: return "Conflict";
440        case 410: return "Gone";
441        case 411: return "Length Required";
442        case 412: return "Precondition Failed";
443        case 413: return "Request Entity Too Large";
444        case 414: return "Request-URI Too Long";
445        case 415: return "Unsupported Media Type";
446        case 416: return "Requested Range Not Satisfiable";
447        case 417: return "Expectation Failed";
448        case 500: return "Internal Server Error";
449        case 501: return "Not Implemented";
450        case 502: return "Bad Gateway";
451        case 503: return "Service Unavailable";
452        case 504: return "Gateway Timeout";
453        case 505: return "HTTP Version Not Supported";
454        default:  return "Unknown Error";
455    }
456}
457
458void
459tr_http_escape( struct evbuffer  * out,
460                const char * str, int len, tr_bool escape_slashes )
461{
462    const char * end;
463
464    if( ( len < 0 ) && ( str != NULL ) )
465        len = strlen( str );
466
467    for( end=str+len; str!=end; ++str ) {
468        if(    ( *str == ',' )
469            || ( *str == '-' )
470            || ( *str == '.' )
471            || ( ( '0' <= *str ) && ( *str <= '9' ) )
472            || ( ( 'A' <= *str ) && ( *str <= 'Z' ) )
473            || ( ( 'a' <= *str ) && ( *str <= 'z' ) )
474            || ( ( *str == '/' ) && ( !escape_slashes ) ) )
475            evbuffer_add( out, str, 1 );
476        else
477            evbuffer_add_printf( out, "%%%02X", (unsigned)(*str&0xFF) );
478    }
479}
480
481char *
482tr_http_unescape( const char * str, int len )
483{
484    char * tmp = curl_unescape( str, len );
485    char * ret = tr_strdup( tmp );
486    curl_free( tmp );
487    return ret;
488}
Note: See TracBrowser for help on using the repository browser.