source: trunk/libtransmission/web.c @ 8986

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

(trunk libT) tell libcurl to set a time limit of 120 seconds for announces; 30 seconds for scrapes

  • Property svn:keywords set to Date Rev Author Id
File size: 18.3 KB
Line 
1/*
2 * This file Copyright (C) 2008-2009 Charles Kerr <charles@transmissionbt.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: web.c 8986 2009-08-22 23:22:50Z charles $
11 */
12
13#include <assert.h>
14#include <stdlib.h> /* bsearch */
15
16#include <event.h>
17
18#define CURL_DISABLE_TYPECHECK /* otherwise -Wunreachable-code goes insane */
19#include <curl/curl.h>
20
21#include "transmission.h"
22#include "list.h"
23#include "net.h" /* socklen_t */
24#include "session.h"
25#include "trevent.h"
26#include "utils.h"
27#include "version.h"
28#include "web.h"
29
30/* Use curl_multi_socket_action() instead of curl_multi_perform()
31   if libcurl >= 7.18.2.  See http://trac.transmissionbt.com/ticket/1844 */
32#if LIBCURL_VERSION_NUM >= 0x071202
33    #define USE_CURL_MULTI_SOCKET_ACTION
34#endif
35
36
37enum
38{
39    /* arbitrary number */
40    MAX_CONCURRENT_TASKS = 100,
41
42    /* arbitrary number */
43    DEFAULT_TIMER_MSEC = 2500
44};
45
46#if 0
47#define dbgmsg(...) \
48    do { \
49        fprintf( stderr, __VA_ARGS__ ); \
50        fprintf( stderr, "\n" ); \
51    } while( 0 )
52#else
53#define dbgmsg( ... ) \
54    do { \
55        if( tr_deepLoggingIsActive( ) ) \
56            tr_deepLog( __FILE__, __LINE__, "web", __VA_ARGS__ ); \
57    } while( 0 )
58#endif
59
60struct tr_web_sockinfo
61{
62    int fd;
63    tr_bool evset;
64    struct event ev;
65};
66
67struct tr_web
68{
69    tr_bool closing;
70    int prev_running;
71    int still_running;
72    long timer_ms;
73    CURLM * multi;
74    tr_session * session;
75    struct event timer_event;
76    tr_list * easy_queue;
77    tr_list * fds;
78};
79
80/***
81****
82***/
83
84static struct tr_web_sockinfo *
85getSockinfo( tr_web * web, int fd, tr_bool createIfMissing )
86{
87    tr_list * l;
88
89    for( l=web->fds; l!=NULL; l=l->next ) {
90        struct tr_web_sockinfo * s =  l->data;
91        if( s->fd == fd ) {
92            dbgmsg( "looked up sockinfo %p for fd %d", s, fd );
93            return s;
94        }
95    }
96
97    if( createIfMissing ) {
98        struct tr_web_sockinfo * s =  tr_new0( struct tr_web_sockinfo, 1 );
99        s->fd = fd;
100        tr_list_prepend( &web->fds, s );
101        dbgmsg( "created sockinfo %p for fd %d... we now have %d sockinfos", s, fd, tr_list_size(web->fds) );
102        return s;
103    }
104
105    return NULL;
106}
107
108static void
109clearSockinfoEvent( struct tr_web_sockinfo * s )
110{
111    if( s && s->evset )
112    {
113        dbgmsg( "clearing libevent polling for sockinfo %p, fd %d", s, s->fd );
114        event_del( &s->ev );
115        s->evset = FALSE;
116    }
117}
118
119static void
120purgeSockinfo( tr_web * web, int fd )
121{
122    struct tr_web_sockinfo * s = getSockinfo( web, fd, FALSE );
123
124    if( s != NULL )
125    {
126        tr_list_remove_data( &web->fds, s );
127        clearSockinfoEvent( s );
128        dbgmsg( "freeing sockinfo %p, fd %d", s, s->fd );
129        tr_free( s );
130    }
131}
132
133/***
134****
135***/
136
137struct tr_web_task
138{
139    unsigned long tag;
140    struct evbuffer * response;
141    char * url;
142    char * range;
143    tr_session * session;
144    tr_web_done_func * done_func;
145    void * done_func_user_data;
146};
147
148static size_t
149writeFunc( void * ptr, size_t size, size_t nmemb, void * task )
150{
151    const size_t byteCount = size * nmemb;
152    evbuffer_add( ((struct tr_web_task*)task)->response, ptr, byteCount );
153    dbgmsg( "wrote %zu bytes to task %p's buffer", byteCount, task );
154    return byteCount;
155}
156
157static int
158getCurlProxyType( tr_proxy_type t )
159{
160    switch( t )
161    {
162        case TR_PROXY_SOCKS4: return CURLPROXY_SOCKS4;
163        case TR_PROXY_SOCKS5: return CURLPROXY_SOCKS5;
164        default:              return CURLPROXY_HTTP;
165    }
166}
167
168static void
169addTask( void * vtask )
170{
171    struct tr_web_task * task = vtask;
172    const tr_session * session = task->session;
173
174    if( session && session->web )
175    {
176        struct tr_web * web = session->web;
177        CURL * easy;
178
179        dbgmsg( "adding task #%lu [%s]", task->tag, task->url );
180
181        easy = curl_easy_init( );
182
183        if( !task->range && session->isProxyEnabled ) {
184            curl_easy_setopt( easy, CURLOPT_PROXY, session->proxy );
185            curl_easy_setopt( easy, CURLOPT_PROXYAUTH, CURLAUTH_ANY );
186            curl_easy_setopt( easy, CURLOPT_PROXYPORT, session->proxyPort );
187            curl_easy_setopt( easy, CURLOPT_PROXYTYPE,
188                                      getCurlProxyType( session->proxyType ) );
189        }
190        if( !task->range && session->isProxyAuthEnabled ) {
191            char * str = tr_strdup_printf( "%s:%s", session->proxyUsername,
192                                                    session->proxyPassword );
193            curl_easy_setopt( easy, CURLOPT_PROXYUSERPWD, str );
194            tr_free( str );
195        }
196
197        curl_easy_setopt( easy, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4 );
198        curl_easy_setopt( easy, CURLOPT_DNS_CACHE_TIMEOUT, 360L );
199        curl_easy_setopt( easy, CURLOPT_CONNECTTIMEOUT, 60L );
200
201        /* set a time limit for announces & scrapes */
202        if( strstr( task->url, "announce" ) )
203            curl_easy_setopt( easy, CURLOPT_TIMEOUT, 120L );
204        else if( strstr( task->url, "scrape" ) )
205            curl_easy_setopt( easy, CURLOPT_TIMEOUT, 30L );
206
207        curl_easy_setopt( easy, CURLOPT_FOLLOWLOCATION, 1L );
208        curl_easy_setopt( easy, CURLOPT_FORBID_REUSE, 1L );
209        curl_easy_setopt( easy, CURLOPT_MAXREDIRS, 16L );
210        curl_easy_setopt( easy, CURLOPT_NOSIGNAL, 1L );
211        curl_easy_setopt( easy, CURLOPT_PRIVATE, task );
212        curl_easy_setopt( easy, CURLOPT_SSL_VERIFYHOST, 0L );
213        curl_easy_setopt( easy, CURLOPT_SSL_VERIFYPEER, 0L );
214        curl_easy_setopt( easy, CURLOPT_URL, task->url );
215        curl_easy_setopt( easy, CURLOPT_USERAGENT,
216                                           TR_NAME "/" LONG_VERSION_STRING );
217        curl_easy_setopt( easy, CURLOPT_VERBOSE,
218                                       getenv( "TR_CURL_VERBOSE" ) != NULL );
219        curl_easy_setopt( easy, CURLOPT_WRITEDATA, task );
220        curl_easy_setopt( easy, CURLOPT_WRITEFUNCTION, writeFunc );
221        if( task->range )
222            curl_easy_setopt( easy, CURLOPT_RANGE, task->range );
223        else /* don't set encoding on webseeds; it messes up binary data */
224            curl_easy_setopt( easy, CURLOPT_ENCODING, "" );
225
226        if( web->still_running >= MAX_CONCURRENT_TASKS ) {
227            tr_list_append( &web->easy_queue, easy );
228            dbgmsg( ">> enqueueing a task... size is now %d", tr_list_size( web->easy_queue ) );
229        } else {
230            const CURLMcode mcode = curl_multi_add_handle( web->multi, easy );
231            tr_assert( mcode == CURLM_OK, "curl_multi_add_handle() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
232            if( mcode == CURLM_OK )
233                ++web->still_running;
234            else
235                tr_err( "%s", curl_multi_strerror( mcode ) );
236        }
237    }
238}
239
240/***
241****
242***/
243
244static void
245task_free( struct tr_web_task * task )
246{
247    evbuffer_free( task->response );
248    tr_free( task->range );
249    tr_free( task->url );
250    tr_free( task );
251}
252
253static void
254task_finish( struct tr_web_task * task, long response_code )
255{
256    dbgmsg( "finished a web task... response code is %ld", response_code );
257    dbgmsg( "===================================================" );
258    task->done_func( task->session,
259                     response_code,
260                     EVBUFFER_DATA( task->response ),
261                     EVBUFFER_LENGTH( task->response ),
262                     task->done_func_user_data );
263    task_free( task );
264}
265
266static void
267remove_finished_tasks( tr_web * g )
268{
269    CURL * easy;
270
271    do
272    {
273        CURLMsg * msg;
274        int msgs_left;
275
276        easy = NULL;
277        while(( msg = curl_multi_info_read( g->multi, &msgs_left ))) {
278            if( msg->msg == CURLMSG_DONE ) {
279                easy = msg->easy_handle;
280                break;
281            }
282        }
283
284        if( easy ) {
285            long code;
286            long fd;
287            struct tr_web_task * task;
288            CURLcode ecode;
289            CURLMcode mcode;
290
291            ecode = curl_easy_getinfo( easy, CURLINFO_PRIVATE, (void*)&task );
292            tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
293
294            ecode = curl_easy_getinfo( easy, CURLINFO_RESPONSE_CODE, &code );
295            tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
296
297            ecode = curl_easy_getinfo( easy, CURLINFO_LASTSOCKET, &fd );
298            tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
299            if( fd != -1L )
300                purgeSockinfo( g, fd );
301
302            mcode = curl_multi_remove_handle( g->multi, easy );
303            tr_assert( mcode == CURLM_OK, "curl_multi_remove_handle() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
304
305            curl_easy_cleanup( easy );
306            task_finish( task, code );
307        }
308    }
309    while ( easy );
310
311    g->prev_running = g->still_running;
312}
313
314static void
315stop_timer( tr_web* g )
316{
317    if( evtimer_pending( &g->timer_event, NULL ) )
318    {
319        dbgmsg( "deleting the pending global timer" );
320        evtimer_del( &g->timer_event );
321    }
322}
323
324static void
325restart_timer( tr_web * g )
326{
327    struct timeval interval;
328
329    assert( tr_amInEventThread( g->session ) );
330    assert( g->session != NULL );
331    assert( g->session->events != NULL );
332
333    stop_timer( g );
334    dbgmsg( "adding a timeout for %ld seconds from now", g->timer_ms/1000L );
335    tr_timevalMsec( g->timer_ms, &interval );
336    evtimer_add( &g->timer_event, &interval );
337}
338
339static void
340add_tasks_from_queue( tr_web * g )
341{
342    while( ( g->still_running < MAX_CONCURRENT_TASKS )
343        && ( tr_list_size( g->easy_queue ) > 0 ) )
344    {
345        CURL * easy = tr_list_pop_front( &g->easy_queue );
346        if( easy )
347        {
348            const CURLMcode rc = curl_multi_add_handle( g->multi, easy );
349            if( rc != CURLM_OK )
350                tr_err( "%s", curl_multi_strerror( rc ) );
351            else {
352                dbgmsg( "pumped the task queue, %d remain",
353                        tr_list_size( g->easy_queue ) );
354                ++g->still_running;
355            }
356        }
357    }
358}
359
360static void
361web_close( tr_web * g )
362{
363    CURLMcode mcode;
364
365    stop_timer( g );
366
367    mcode = curl_multi_cleanup( g->multi );
368    tr_assert( mcode == CURLM_OK, "curl_multi_cleanup() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
369    if( mcode != CURLM_OK )
370        tr_err( "%s", curl_multi_strerror( mcode ) );
371
372    tr_free( g );
373}
374
375/* note: this function can free the tr_web if its 'closing' flag is set
376   and no tasks remain.  callers must not reference their g pointer
377   after calling this function */
378static void
379tr_multi_perform( tr_web * g, int fd )
380{
381    int closed = FALSE;
382    CURLMcode mcode;
383
384    dbgmsg( "check_run_count: prev_running %d, still_running %d",
385            g->prev_running, g->still_running );
386
387    /* invoke libcurl's processing */
388#ifdef USE_CURL_MULTI_SOCKET_ACTION
389    do {
390        dbgmsg( "calling curl_multi_socket_action..." );
391        mcode = curl_multi_socket_action( g->multi, fd, 0, &g->still_running );
392        fd = CURL_SOCKET_TIMEOUT;
393        dbgmsg( "done calling curl_multi_socket_action..." );
394    } while( mcode == CURLM_CALL_MULTI_SOCKET );
395#else
396    do {
397        dbgmsg( "calling curl_multi_perform..." );
398        mcode = curl_multi_perform( g->multi, &g->still_running );
399        dbgmsg( "done calling curl_multi_perform..." );
400    } while( mcode == CURLM_CALL_MULTI_PERFORM );
401#endif
402    tr_assert( mcode == CURLM_OK, "curl_multi_perform() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
403    if( mcode != CURLM_OK )
404        tr_err( "%s", curl_multi_strerror( mcode ) );
405
406    remove_finished_tasks( g );
407
408    add_tasks_from_queue( g );
409
410    if( !g->still_running ) {
411        assert( tr_list_size( g->fds ) == 0 );
412        stop_timer( g );
413        if( g->closing ) {
414            web_close( g );
415            closed = TRUE;
416        }
417    }
418
419    if( !closed )
420        restart_timer( g );
421}
422
423/* libevent says that sock is ready to be processed, so wake up libcurl */
424static void
425event_cb( int fd, short kind UNUSED, void * g )
426{
427    tr_multi_perform( g, fd );
428}
429
430/* libevent says that timer_ms have passed, so wake up libcurl */
431static void
432timer_cb( int socket UNUSED, short action UNUSED, void * g )
433{
434    dbgmsg( "libevent timer is done" );
435    tr_multi_perform( g, CURL_SOCKET_TIMEOUT );
436}
437
438/* CURLMOPT_SOCKETFUNCTION */
439static int
440sock_cb( CURL            * e UNUSED,
441         curl_socket_t     fd,
442         int               action,
443         void            * vweb,
444         void            * unused UNUSED)
445{
446    struct tr_web * web = vweb;
447    dbgmsg( "sock_cb: action is %d, fd is %d", action, (int)fd );
448
449    if( action == CURL_POLL_REMOVE )
450    {
451        purgeSockinfo( web, fd );
452    }
453    else
454    {
455        struct tr_web_sockinfo * sockinfo = getSockinfo( web, fd, TRUE );
456        const int kind = EV_PERSIST
457                       | (( action & CURL_POLL_IN ) ? EV_READ : 0 )
458                       | (( action & CURL_POLL_OUT ) ? EV_WRITE : 0 );
459        dbgmsg( "setsock: fd is %d, curl action is %d, libevent action is %d", fd, action, kind );
460        assert( tr_amInEventThread( web->session ) );
461        assert( kind != EV_PERSIST );
462
463        /* clear any old polling on this fd */
464        clearSockinfoEvent( sockinfo );
465
466        /* set the new polling on this fd */
467        dbgmsg( "enabling (libevent %d, libcurl %d) polling on sockinfo %p, fd %d", action, kind, sockinfo, fd );
468        event_set( &sockinfo->ev, fd, kind, event_cb, web );
469        event_add( &sockinfo->ev, NULL );
470        sockinfo->evset = TRUE;
471    }
472
473    return 0;
474}
475
476
477/* libcurl documentation: "If 0, it means you should proceed immediately
478 * without waiting for anything. If it returns -1, there's no timeout at all
479 * set ... (but) you must not wait too long (more than a few seconds perhaps)
480 * before you call curl_multi_perform() again."  */
481static void
482multi_timer_cb( CURLM *multi UNUSED, long timer_ms, void * vg )
483{
484    tr_web * g = vg;
485
486    if( timer_ms < 1 ) {
487        if( timer_ms == 0 ) /* call it immediately */
488            timer_cb( 0, 0, g );
489        timer_ms = DEFAULT_TIMER_MSEC;
490    }
491
492    g->timer_ms = timer_ms;
493    restart_timer( g );
494}
495
496/****
497*****
498****/
499
500void
501tr_webRun( tr_session         * session,
502           const char         * url,
503           const char         * range,
504           tr_web_done_func     done_func,
505           void               * done_func_user_data )
506{
507    if( session->web )
508    {
509        static unsigned long tag = 0;
510        struct tr_web_task * task;
511
512        task = tr_new0( struct tr_web_task, 1 );
513        task->session = session;
514        task->url = tr_strdup( url );
515        task->range = tr_strdup( range );
516        task->done_func = done_func;
517        task->done_func_user_data = done_func_user_data;
518        task->tag = ++tag;
519        task->response = evbuffer_new( );
520
521        tr_runInEventThread( session, addTask, task );
522    }
523}
524
525tr_web*
526tr_webInit( tr_session * session )
527{
528    CURLMcode mcode;
529    static int curlInited = FALSE;
530    tr_web * web;
531
532    /* call curl_global_init if we haven't done it already.
533     * try to enable ssl for https support; but if that fails,
534     * try a plain vanilla init */
535    if( curlInited == FALSE ) {
536        curlInited = TRUE;
537        if( curl_global_init( CURL_GLOBAL_SSL ) )
538            curl_global_init( 0 );
539    }
540
541    web = tr_new0( struct tr_web, 1 );
542    web->multi = curl_multi_init( );
543    web->session = session;
544    web->timer_ms = DEFAULT_TIMER_MSEC; /* overwritten by multi_timer_cb() */
545
546    evtimer_set( &web->timer_event, timer_cb, web );
547    mcode = curl_multi_setopt( web->multi, CURLMOPT_SOCKETDATA, web );
548    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
549    mcode = curl_multi_setopt( web->multi, CURLMOPT_SOCKETFUNCTION, sock_cb );
550    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
551    mcode = curl_multi_setopt( web->multi, CURLMOPT_TIMERDATA, web );
552    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
553    mcode = curl_multi_setopt( web->multi, CURLMOPT_TIMERFUNCTION, multi_timer_cb );
554    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
555
556    return web;
557}
558
559void
560tr_webClose( tr_web ** web_in )
561{
562    tr_web * web = *web_in;
563    *web_in = NULL;
564    if( web->still_running < 1 )
565        web_close( web );
566    else
567        web->closing = 1;
568}
569
570/*****
571******
572******
573*****/
574
575static struct http_msg {
576    long code;
577    const char * text;
578} http_msg[] = {
579    {   0, "No Response" },
580    { 101, "Switching Protocols" },
581    { 200, "OK" },
582    { 201, "Created" },
583    { 202, "Accepted" },
584    { 203, "Non-Authoritative Information" },
585    { 204, "No Content" },
586    { 205, "Reset Content" },
587    { 206, "Partial Content" },
588    { 300, "Multiple Choices" },
589    { 301, "Moved Permanently" },
590    { 302, "Found" },
591    { 303, "See Other" },
592    { 304, "Not Modified" },
593    { 305, "Use Proxy" },
594    { 306, "(Unused)" },
595    { 307, "Temporary Redirect" },
596    { 400, "Bad Request" },
597    { 401, "Unauthorized" },
598    { 402, "Payment Required" },
599    { 403, "Forbidden" },
600    { 404, "Not Found" },
601    { 405, "Method Not Allowed" },
602    { 406, "Not Acceptable" },
603    { 407, "Proxy Authentication Required" },
604    { 408, "Request Timeout" },
605    { 409, "Conflict" },
606    { 410, "Gone" },
607    { 411, "Length Required" },
608    { 412, "Precondition Failed" },
609    { 413, "Request Entity Too Large" },
610    { 414, "Request-URI Too Long" },
611    { 415, "Unsupported Media Type" },
612    { 416, "Requested Range Not Satisfiable" },
613    { 417, "Expectation Failed" },
614    { 500, "Internal Server Error" },
615    { 501, "Not Implemented" },
616    { 502, "Bad Gateway" },
617    { 503, "Service Unavailable" },
618    { 504, "Gateway Timeout" },
619    { 505, "HTTP Version Not Supported" }
620};
621
622static int
623compareResponseCodes( const void * va, const void * vb )
624{
625    const long a = *(const long*) va;
626    const struct http_msg * b = vb;
627    return a - b->code;
628}
629
630const char *
631tr_webGetResponseStr( long code )
632{
633    struct http_msg * msg = bsearch( &code,
634                                     http_msg,
635                                     sizeof( http_msg ) / sizeof( http_msg[0] ),
636                                     sizeof( http_msg[0] ),
637                                     compareResponseCodes );
638    return msg ? msg->text : "Unknown Error";
639}
Note: See TracBrowser for help on using the repository browser.