source: trunk/libtransmission/web.c @ 9895

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

(trunk libT) #2416 "crash in event_queue_insert" -- continue throwing the kitchen sink at this ticket. (1) disable proxies to see if that makes any difference (2) rearrange the sequencing in sock_cb() to unconditionally delete the active event before doing anything else (3) use a libevent timer instead of CURLOPT_TIMEOUT to workaround curl bug http://tinyurl.com/ycm5d3e

  • Property svn:keywords set to Date Rev Author Id
File size: 15.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 9895 2010-01-08 21:45:56Z charles $
11 */
12
13#include <assert.h>
14
15#include <curl/curl.h>
16#include <event.h>
17
18#include "transmission.h"
19#include "net.h"
20#include "session.h"
21#include "trevent.h"
22#include "utils.h"
23#include "version.h"
24#include "web.h"
25
26enum
27{
28    TR_MEMORY_TRASH = 0xCC,
29
30    DEFAULT_TIMER_MSEC = 1500 /* arbitrary */
31};
32
33#if 0
34#define dbgmsg(...) \
35    do { \
36        fprintf( stderr, __VA_ARGS__ ); \
37        fprintf( stderr, "\n" ); \
38    } while( 0 )
39#else
40#define dbgmsg( ... ) \
41    do { \
42        if( tr_deepLoggingIsActive( ) ) \
43            tr_deepLog( __FILE__, __LINE__, "web", __VA_ARGS__ ); \
44    } while( 0 )
45#endif
46
47/***
48****
49***/
50
51struct tr_web
52{
53    tr_bool closing;
54    tr_bool haveAddr;
55    int taskCount;
56    long timer_msec;
57    CURLM * multi;
58    tr_session * session;
59    tr_address addr;
60    struct event timer_event;
61};
62
63static void
64web_free( tr_web * g )
65{
66    curl_multi_cleanup( g->multi );
67    evtimer_del( &g->timer_event );
68    memset( g, TR_MEMORY_TRASH, sizeof( struct tr_web ) );
69    tr_free( g );
70}
71
72/***
73****
74***/
75
76struct tr_web_task
77{
78    unsigned long tag;
79    struct evbuffer * response;
80    char * url;
81    char * range;
82    tr_session * session;
83    tr_web_done_func * done_func;
84    void * done_func_user_data;
85    struct event timer_event;
86    CURL * easy;
87};
88
89static void
90task_free( struct tr_web_task * task )
91{
92    evtimer_del( &task->timer_event );
93    evbuffer_free( task->response );
94    tr_free( task->range );
95    tr_free( task->url );
96    memset( task, TR_MEMORY_TRASH, sizeof( struct tr_web_task ) );
97    tr_free( task );
98}
99
100/***
101****
102***/
103
104static size_t
105writeFunc( void * ptr, size_t size, size_t nmemb, void * vtask )
106{
107    const size_t byteCount = size * nmemb;
108    struct tr_web_task * task = vtask;
109    evbuffer_add( task->response, ptr, byteCount );
110    dbgmsg( "wrote %zu bytes to task %p's buffer", byteCount, task );
111    return byteCount;
112}
113
114static int
115sockoptfunction( void * vtask, curl_socket_t fd, curlsocktype purpose UNUSED )
116{
117    struct tr_web_task * task = vtask;
118    const tr_bool isScrape = strstr( task->url, "scrape" ) != NULL;
119    const tr_bool isAnnounce = strstr( task->url, "announce" ) != NULL;
120
121    /* announce and scrape requests have tiny payloads. */
122    if( isScrape || isAnnounce )
123    {
124        const int sndbuf = 1024;
125        const int rcvbuf = isScrape ? 2048 : 3072;
126        setsockopt( fd, SOL_SOCKET, SO_SNDBUF, &sndbuf, sizeof(sndbuf) );
127        setsockopt( fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, sizeof(rcvbuf) );
128    }
129
130    /* return nonzero if this function encountered an error */
131    return 0;
132}
133
134#if 0
135static int
136getCurlProxyType( tr_proxy_type t )
137{
138    if( t == TR_PROXY_SOCKS4 ) return CURLPROXY_SOCKS4;
139    if( t == TR_PROXY_SOCKS5 ) return CURLPROXY_SOCKS5;
140    return CURLPROXY_HTTP;
141}
142#endif
143
144static int
145getTimeoutFromURL( const char * url )
146{
147    if( strstr( url, "scrape" ) != NULL ) return 20;
148    if( strstr( url, "announce" ) != NULL ) return 30;
149    return 240;
150}
151
152static void task_timeout_cb( int fd UNUSED, short what UNUSED, void * task );
153
154static void
155addTask( void * vtask )
156{
157    struct tr_web_task * task = vtask;
158    const tr_session * session = task->session;
159
160    if( session && session->web )
161    {
162        CURL * e = curl_easy_init( );
163        struct tr_web * web = session->web;
164        const int timeout = getTimeoutFromURL( task->url );
165        const long verbose = getenv( "TR_CURL_VERBOSE" ) != NULL;
166        const char * user_agent = TR_NAME "/" LONG_VERSION_STRING;
167
168        dbgmsg( "adding task #%lu [%s]", task->tag, task->url );
169
170/* experimentally disable proxies to see if that has any effect on the libevent crashes */
171#if 0
172        if( !task->range && session->isProxyEnabled ) {
173            curl_easy_setopt( e, CURLOPT_PROXY, session->proxy );
174            curl_easy_setopt( e, CURLOPT_PROXYAUTH, CURLAUTH_ANY );
175            curl_easy_setopt( e, CURLOPT_PROXYPORT, session->proxyPort );
176            curl_easy_setopt( e, CURLOPT_PROXYTYPE,
177                                      getCurlProxyType( session->proxyType ) );
178        }
179        if( !task->range && session->isProxyAuthEnabled ) {
180            char * str = tr_strdup_printf( "%s:%s", session->proxyUsername,
181                                                    session->proxyPassword );
182            curl_easy_setopt( e, CURLOPT_PROXYUSERPWD, str );
183            tr_free( str );
184        }
185#endif
186
187        task->easy = e;
188
189        /* use our own timeout instead of CURLOPT_TIMEOUT because the latter
190         * doesn't play nicely with curl_multi.  See curl bug #2501457 */
191        evtimer_set( &task->timer_event, task_timeout_cb, task );
192        tr_timerAdd( &task->timer_event, timeout, 0 );
193
194        curl_easy_setopt( e, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4 );
195        curl_easy_setopt( e, CURLOPT_SOCKOPTFUNCTION, sockoptfunction );
196        curl_easy_setopt( e, CURLOPT_SOCKOPTDATA, task );
197        curl_easy_setopt( e, CURLOPT_WRITEDATA, task );
198        curl_easy_setopt( e, CURLOPT_WRITEFUNCTION, writeFunc );
199        curl_easy_setopt( e, CURLOPT_DNS_CACHE_TIMEOUT, 1800L );
200        curl_easy_setopt( e, CURLOPT_FOLLOWLOCATION, 1L );
201        curl_easy_setopt( e, CURLOPT_AUTOREFERER, 1L );
202        curl_easy_setopt( e, CURLOPT_FORBID_REUSE, 1L );
203        curl_easy_setopt( e, CURLOPT_MAXREDIRS, -1L );
204        curl_easy_setopt( e, CURLOPT_NOSIGNAL, 1L );
205        curl_easy_setopt( e, CURLOPT_PRIVATE, task );
206        curl_easy_setopt( e, CURLOPT_SSL_VERIFYHOST, 0L );
207        curl_easy_setopt( e, CURLOPT_SSL_VERIFYPEER, 0L );
208        curl_easy_setopt( e, CURLOPT_URL, task->url );
209        curl_easy_setopt( e, CURLOPT_USERAGENT, user_agent );
210        curl_easy_setopt( e, CURLOPT_VERBOSE, verbose );
211        if( web->haveAddr )
212            curl_easy_setopt( e, CURLOPT_INTERFACE, tr_ntop_non_ts( &web->addr ) );
213        if( task->range )
214            curl_easy_setopt( e, CURLOPT_RANGE, task->range );
215
216        if( curl_multi_add_handle( web->multi, e ) == CURLM_OK )
217            ++web->taskCount;
218    }
219}
220
221/***
222****
223***/
224
225static void
226task_finish( struct tr_web_task * task, long response_code )
227{
228    dbgmsg( "finished web task %lu; got %ld", task->tag, response_code );
229
230    if( task->done_func != NULL )
231        task->done_func( task->session,
232                         response_code,
233                         EVBUFFER_DATA( task->response ),
234                         EVBUFFER_LENGTH( task->response ),
235                         task->done_func_user_data );
236    task_free( task );
237}
238
239static void
240remove_task( struct tr_web_task * task )
241{
242    long code;
243    tr_web * g = task->session->web;
244
245    curl_easy_getinfo( task->easy, CURLINFO_RESPONSE_CODE, &code );
246    curl_multi_remove_handle( g->multi, task->easy );
247    curl_easy_cleanup( task->easy );
248    task_finish( task, code );
249}
250
251static void
252task_timeout_cb( int fd UNUSED, short what UNUSED, void * task )
253{
254    remove_task( task );
255}
256
257static void
258remove_finished_tasks( tr_web * g )
259{
260    CURLMsg * msg;
261    int msgs_left;
262
263    while(( msg = curl_multi_info_read( g->multi, &msgs_left ))) {
264        if(( msg->msg == CURLMSG_DONE ) && ( msg->easy_handle != NULL )) {
265            struct tr_web_task * task;
266            CURL * e = msg->easy_handle;
267            curl_easy_getinfo( e, CURLINFO_PRIVATE, (void*)&task );
268            assert( e == task->easy );
269            remove_task( task );
270        }
271    }
272}
273
274static void
275restart_timer( tr_web * g )
276{
277    dbgmsg( "adding a timeout for %.1f seconds from now", g->timer_msec/1000.0 );
278    evtimer_del( &g->timer_event );
279    tr_timerAddMsec( &g->timer_event, g->timer_msec );
280}
281
282static void
283tr_multi_perform( tr_web * g, int fd, int curl_what )
284{
285    CURLMcode m;
286
287    dbgmsg( "check_run_count: %d taskCount", g->taskCount );
288
289    /* invoke libcurl's processing */
290    do
291        m = curl_multi_socket_action( g->multi, fd, curl_what, &g->taskCount );
292    while( m == CURLM_CALL_MULTI_SOCKET );
293
294    remove_finished_tasks( g );
295
296    if( g->closing && !g->taskCount )
297        web_free( g );
298    else
299        restart_timer( g );
300}
301
302/* libevent says that sock is ready to be processed, so wake up libcurl */
303static void
304event_cb( int fd, short ev_what, void * g )
305{
306    int curl_what = 0;
307    if( ev_what & EV_READ ) curl_what |= CURL_POLL_IN;
308    if( ev_what & EV_WRITE ) curl_what |= CURL_POLL_OUT;
309    tr_multi_perform( g, fd, curl_what );
310}
311
312/* CURLMOPT_SOCKETFUNCTION */
313static int
314sock_cb( CURL * e UNUSED, curl_socket_t fd, int curl_what,
315         void * vweb, void * vevent )
316{
317    /*static int num_events = 0;*/
318    struct tr_web * web = vweb;
319    struct event * io_event = vevent;
320    dbgmsg( "sock_cb: curl_what %d, fd %d, io_event %p",
321            curl_what, (int)fd, io_event );
322
323    if( io_event != NULL )
324        event_del( io_event );
325
326    if( curl_what & ( CURL_POLL_IN | CURL_POLL_OUT ) )
327    {
328        const short ev_what = EV_PERSIST
329                           | (( curl_what & CURL_POLL_IN ) ? EV_READ : 0 )
330                           | (( curl_what & CURL_POLL_OUT ) ? EV_WRITE : 0 );
331
332        if( io_event == NULL ) {
333            io_event = tr_new0( struct event, 1 );
334            curl_multi_assign( web->multi, fd, io_event );
335            /*fprintf( stderr, "+1 io_events to %d\n", ++num_events );*/
336        }
337
338        dbgmsg( "enabling (libevent %hd, libcurl %d) on io_event %p, fd %d",
339                ev_what, curl_what, io_event, fd );
340        event_set( io_event, fd, ev_what, event_cb, web );
341        event_add( io_event, NULL );
342    }
343
344    if( ( io_event != NULL ) && ( curl_what & CURL_POLL_REMOVE ) )
345    {
346        CURLMcode m;
347        tr_free( io_event );
348        m = curl_multi_assign( web->multi, fd, NULL );
349        assert( m == CURLM_OK );
350        /*fprintf( stderr, "-1 io_events to %d\n", --num_events );*/
351    }
352
353    return 0; /* libcurl documentation: "The callback MUST return 0." */
354}
355
356/* libevent says that timer_msec have passed, so wake up libcurl */
357static void
358libevent_timer_cb( int fd UNUSED, short what UNUSED, void * g )
359{
360    dbgmsg( "libevent timer is done" );
361    tr_multi_perform( g, CURL_SOCKET_TIMEOUT, 0 );
362}
363
364/* libcurl documentation: "If 0, it means you should proceed immediately
365 * without waiting for anything. If it returns -1, there's no timeout at all
366 * set ... (but) you must not wait too long (more than a few seconds perhaps)
367 * before you call curl_multi_perform() again."  */
368static void
369multi_timer_cb( CURLM * multi UNUSED, long timer_msec, void * vg )
370{
371    tr_web * g = vg;
372
373    g->timer_msec = timer_msec > 0 ? timer_msec : DEFAULT_TIMER_MSEC;
374
375    if( timer_msec < 1 )
376        tr_multi_perform( g, CURL_SOCKET_TIMEOUT, 0 );
377    else
378        restart_timer( g );
379}
380
381/****
382*****
383****/
384
385void
386tr_webRun( tr_session         * session,
387           const char         * url,
388           const char         * range,
389           tr_web_done_func     done_func,
390           void               * done_func_user_data )
391{
392    if( session->web != NULL )
393    {
394        static unsigned long tag = 0;
395        struct tr_web_task * task = tr_new0( struct tr_web_task, 1 );
396        task->session = session;
397        task->url = tr_strdup( url );
398        task->range = tr_strdup( range );
399        task->done_func = done_func;
400        task->done_func_user_data = done_func_user_data;
401        task->tag = ++tag;
402        task->response = evbuffer_new( );
403        tr_runInEventThread( session, addTask, task );
404    }
405}
406
407void
408tr_webSetInterface( tr_web * web, const tr_address * addr )
409{
410    if(( web->haveAddr = ( addr != NULL )))
411        web->addr = *addr;
412}
413
414tr_web*
415tr_webInit( tr_session * session )
416{
417    tr_web * web;
418
419    /* try to enable ssl for https support; but if that fails,
420     * try a plain vanilla init */
421    if( curl_global_init( CURL_GLOBAL_SSL ) )
422        curl_global_init( 0 );
423
424    web = tr_new0( struct tr_web, 1 );
425    web->session = session;
426    web->timer_msec = DEFAULT_TIMER_MSEC; /* overwritten by multi_timer_cb() */
427    evtimer_set( &web->timer_event, libevent_timer_cb, web );
428
429    web->multi = curl_multi_init( );
430    curl_multi_setopt( web->multi, CURLMOPT_SOCKETDATA, web );
431    curl_multi_setopt( web->multi, CURLMOPT_SOCKETFUNCTION, sock_cb );
432    curl_multi_setopt( web->multi, CURLMOPT_TIMERDATA, web );
433    curl_multi_setopt( web->multi, CURLMOPT_TIMERFUNCTION, multi_timer_cb );
434
435    return web;
436}
437
438void
439tr_webClose( tr_web ** web_in )
440{
441    tr_web * web = *web_in;
442    *web_in = NULL;
443    if( web->taskCount < 1 )
444        web_free( web );
445    else
446        web->closing = 1;
447}
448
449/*****
450******
451******
452*****/
453
454const char *
455tr_webGetResponseStr( long code )
456{
457    switch( code )
458    {
459        case   0: return "No Response";
460        case 101: return "Switching Protocols";
461        case 200: return "OK";
462        case 201: return "Created";
463        case 202: return "Accepted";
464        case 203: return "Non-Authoritative Information";
465        case 204: return "No Content";
466        case 205: return "Reset Content";
467        case 206: return "Partial Content";
468        case 300: return "Multiple Choices";
469        case 301: return "Moved Permanently";
470        case 302: return "Found";
471        case 303: return "See Other";
472        case 304: return "Not Modified";
473        case 305: return "Use Proxy";
474        case 306: return "(Unused)";
475        case 307: return "Temporary Redirect";
476        case 400: return "Bad Request";
477        case 401: return "Unauthorized";
478        case 402: return "Payment Required";
479        case 403: return "Forbidden";
480        case 404: return "Not Found";
481        case 405: return "Method Not Allowed";
482        case 406: return "Not Acceptable";
483        case 407: return "Proxy Authentication Required";
484        case 408: return "Request Timeout";
485        case 409: return "Conflict";
486        case 410: return "Gone";
487        case 411: return "Length Required";
488        case 412: return "Precondition Failed";
489        case 413: return "Request Entity Too Large";
490        case 414: return "Request-URI Too Long";
491        case 415: return "Unsupported Media Type";
492        case 416: return "Requested Range Not Satisfiable";
493        case 417: return "Expectation Failed";
494        case 500: return "Internal Server Error";
495        case 501: return "Not Implemented";
496        case 502: return "Bad Gateway";
497        case 503: return "Service Unavailable";
498        case 504: return "Gateway Timeout";
499        case 505: return "HTTP Version Not Supported";
500        default:  return "Unknown Error";
501    }
502}
503
504void
505tr_http_escape( struct evbuffer  * out,
506                const char * str, int len, tr_bool escape_slashes )
507{
508    int i;
509
510    if( ( len < 0 ) && ( str != NULL ) )
511        len = strlen( str );
512
513    for( i = 0; i < len; i++ ) {
514        switch( str[i] ) {
515        case ',': case '-': case '.':
516        case '0': case '1': case '2': case '3': case '4':
517        case '5': case '6': case '7': case '8': case '9':
518        case 'a': case 'b': case 'c': case 'd': case 'e':
519        case 'f': case 'g': case 'h': case 'i': case 'j':
520        case 'k': case 'l': case 'm': case 'n': case 'o':
521        case 'p': case 'q': case 'r': case 's': case 't':
522        case 'u': case 'v': case 'w': case 'x': case 'y': case 'z':
523        case 'A': case 'B': case 'C': case 'D': case 'E':
524        case 'F': case 'G': case 'H': case 'I': case 'J':
525        case 'K': case 'L': case 'M': case 'N': case 'O':
526        case 'P': case 'Q': case 'R': case 'S': case 'T':
527        case 'U': case 'V': case 'W': case 'X': case 'Y': case 'Z':
528            evbuffer_add( out, &str[i], 1 );
529            break;
530        case '/':
531            if(!escape_slashes) {
532                evbuffer_add( out, &str[i], 1 );
533                break;
534            }
535            /* Fall through. */
536        default:
537            evbuffer_add_printf( out, "%%%02X", (unsigned)(str[i]&0xFF) );
538            break;
539        }
540    }
541}
542
543char *
544tr_http_unescape( const char * str, int len )
545{
546    char * tmp = curl_unescape( str, len );
547    char * ret = tr_strdup( tmp );
548    curl_free( tmp );
549    return ret;
550}
Note: See TracBrowser for help on using the repository browser.