source: trunk/libtransmission/web.c @ 8233

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

(trunk) make it possible to #include "version.h" without having to add -I${TOP}/libtransmission/ to your CFLAGS

  • Property svn:keywords set to Date Rev Author Id
File size: 18.1 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 8233 2009-04-13 19:04:21Z 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 "session.h"
23#include "list.h"
24#include "net.h" /* socklen_t */
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 = web->fds;
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        curl_easy_setopt( easy, CURLOPT_FOLLOWLOCATION, 1L );
201        curl_easy_setopt( easy, CURLOPT_FORBID_REUSE, 1L );
202        curl_easy_setopt( easy, CURLOPT_MAXREDIRS, 16L );
203        curl_easy_setopt( easy, CURLOPT_NOSIGNAL, 1L );
204        curl_easy_setopt( easy, CURLOPT_PRIVATE, task );
205        curl_easy_setopt( easy, CURLOPT_SSL_VERIFYHOST, 0L );
206        curl_easy_setopt( easy, CURLOPT_SSL_VERIFYPEER, 0L );
207        curl_easy_setopt( easy, CURLOPT_URL, task->url );
208        curl_easy_setopt( easy, CURLOPT_USERAGENT,
209                                           TR_NAME "/" LONG_VERSION_STRING );
210        curl_easy_setopt( easy, CURLOPT_VERBOSE,
211                                       getenv( "TR_CURL_VERBOSE" ) != NULL );
212        curl_easy_setopt( easy, CURLOPT_WRITEDATA, task );
213        curl_easy_setopt( easy, CURLOPT_WRITEFUNCTION, writeFunc );
214        if( task->range )
215            curl_easy_setopt( easy, CURLOPT_RANGE, task->range );
216        else /* don't set encoding on webseeds; it messes up binary data */
217            curl_easy_setopt( easy, CURLOPT_ENCODING, "" );
218
219        if( web->still_running >= MAX_CONCURRENT_TASKS ) {
220            tr_list_append( &web->easy_queue, easy );
221            dbgmsg( ">> enqueueing a task... size is now %d", tr_list_size( web->easy_queue ) );
222        } else {
223            const CURLMcode mcode = curl_multi_add_handle( web->multi, easy );
224            tr_assert( mcode == CURLM_OK, "curl_multi_add_handle() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
225            if( mcode == CURLM_OK )
226                ++web->still_running;
227            else
228                tr_err( "%s", curl_multi_strerror( mcode ) );
229        }
230    }
231}
232
233/***
234****
235***/
236
237static void
238task_free( struct tr_web_task * task )
239{
240    evbuffer_free( task->response );
241    tr_free( task->range );
242    tr_free( task->url );
243    tr_free( task );
244}
245
246static void
247task_finish( struct tr_web_task * task, long response_code )
248{
249    dbgmsg( "finished a web task... response code is %ld", response_code );
250    dbgmsg( "===================================================" );
251    task->done_func( task->session,
252                     response_code,
253                     EVBUFFER_DATA( task->response ),
254                     EVBUFFER_LENGTH( task->response ),
255                     task->done_func_user_data );
256    task_free( task );
257}
258
259static void
260remove_finished_tasks( tr_web * g )
261{
262    CURL * easy;
263
264    do
265    {
266        CURLMsg * msg;
267        int msgs_left;
268
269        easy = NULL;
270        while(( msg = curl_multi_info_read( g->multi, &msgs_left ))) {
271            if( msg->msg == CURLMSG_DONE ) {
272                easy = msg->easy_handle;
273                break;
274            }
275        }
276
277        if( easy ) {
278            long code;
279            long fd;
280            struct tr_web_task * task;
281            CURLcode ecode;
282            CURLMcode mcode;
283
284            ecode = curl_easy_getinfo( easy, CURLINFO_PRIVATE, (void*)&task );
285            tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
286
287            ecode = curl_easy_getinfo( easy, CURLINFO_RESPONSE_CODE, &code );
288            tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
289
290            ecode = curl_easy_getinfo( easy, CURLINFO_LASTSOCKET, &fd );
291            tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
292            if( fd != -1L )
293                purgeSockinfo( g, fd );
294
295            mcode = curl_multi_remove_handle( g->multi, easy );
296            tr_assert( mcode == CURLM_OK, "curl_multi_remove_handle() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
297
298            curl_easy_cleanup( easy );
299            task_finish( task, code );
300        }
301    }
302    while ( easy );
303
304    g->prev_running = g->still_running;
305}
306
307static void
308stop_timer( tr_web* g )
309{
310    if( evtimer_pending( &g->timer_event, NULL ) )
311    {
312        dbgmsg( "deleting the pending global timer" );
313        evtimer_del( &g->timer_event );
314    }
315}
316
317static void
318restart_timer( tr_web * g )
319{
320    struct timeval interval;
321
322    assert( tr_amInEventThread( g->session ) );
323    assert( g->session != NULL );
324    assert( g->session->events != NULL );
325
326    stop_timer( g );
327    dbgmsg( "adding a timeout for %ld seconds from now", g->timer_ms/1000L );
328    tr_timevalMsec( g->timer_ms, &interval );
329    evtimer_add( &g->timer_event, &interval );
330}
331
332static void
333add_tasks_from_queue( tr_web * g )
334{
335    while( ( g->still_running < MAX_CONCURRENT_TASKS ) 
336        && ( tr_list_size( g->easy_queue ) > 0 ) )
337    {
338        CURL * easy = tr_list_pop_front( &g->easy_queue );
339        if( easy )
340        {
341            const CURLMcode rc = curl_multi_add_handle( g->multi, easy );
342            if( rc != CURLM_OK )
343                tr_err( "%s", curl_multi_strerror( rc ) );
344            else {
345                dbgmsg( "pumped the task queue, %d remain",
346                        tr_list_size( g->easy_queue ) );
347                ++g->still_running;
348            }
349        }
350    }
351}
352
353static void
354web_close( tr_web * g )
355{
356    CURLMcode mcode;
357
358    stop_timer( g );
359
360    mcode = curl_multi_cleanup( g->multi );
361    tr_assert( mcode == CURLM_OK, "curl_multi_cleanup() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
362    if( mcode != CURLM_OK )
363        tr_err( "%s", curl_multi_strerror( mcode ) );
364
365    tr_free( g );
366}
367
368/* note: this function can free the tr_web if its 'closing' flag is set
369   and no tasks remain.  callers must not reference their g pointer
370   after calling this function */
371static void
372tr_multi_perform( tr_web * g, int fd )
373{
374    int closed = FALSE;
375    CURLMcode mcode;
376
377    dbgmsg( "check_run_count: prev_running %d, still_running %d",
378            g->prev_running, g->still_running );
379
380    /* invoke libcurl's processing */
381#ifdef USE_CURL_MULTI_SOCKET_ACTION
382    do {
383        dbgmsg( "calling curl_multi_socket_action..." );
384        mcode = curl_multi_socket_action( g->multi, fd, 0, &g->still_running );
385        fd = CURL_SOCKET_TIMEOUT;
386        dbgmsg( "done calling curl_multi_socket_action..." );
387    } while( mcode == CURLM_CALL_MULTI_SOCKET );
388#else
389    do {
390        dbgmsg( "calling curl_multi_perform..." );
391        mcode = curl_multi_perform( g->multi, &g->still_running );
392        dbgmsg( "done calling curl_multi_perform..." );
393    } while( mcode == CURLM_CALL_MULTI_PERFORM );
394#endif
395    tr_assert( mcode == CURLM_OK, "curl_multi_perform() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
396    if( mcode != CURLM_OK )
397        tr_err( "%s", curl_multi_strerror( mcode ) );
398
399    remove_finished_tasks( g );
400
401    add_tasks_from_queue( g );
402
403    if( !g->still_running ) {
404        assert( tr_list_size( g->fds ) == 0 );
405        stop_timer( g );
406        if( g->closing ) {
407            web_close( g );
408            closed = TRUE;
409        }
410    }
411
412    if( !closed )
413        restart_timer( g );
414}
415
416/* libevent says that sock is ready to be processed, so wake up libcurl */
417static void
418event_cb( int fd, short kind UNUSED, void * g )
419{
420    tr_multi_perform( g, fd );
421}
422
423/* libevent says that timer_ms have passed, so wake up libcurl */
424static void
425timer_cb( int socket UNUSED, short action UNUSED, void * g )
426{
427    dbgmsg( "libevent timer is done" );
428    tr_multi_perform( g, CURL_SOCKET_TIMEOUT );
429}
430
431/* CURLMOPT_SOCKETFUNCTION */
432static int
433sock_cb( CURL            * e UNUSED,
434         curl_socket_t     fd,
435         int               action,
436         void            * vweb,
437         void            * unused UNUSED)
438{
439    struct tr_web * web = vweb;
440    dbgmsg( "sock_cb: action is %d, fd is %d", action, (int)fd );
441
442    if( action == CURL_POLL_REMOVE )
443    {
444        purgeSockinfo( web, fd );
445    }
446    else
447    {
448        struct tr_web_sockinfo * sockinfo = getSockinfo( web, fd, TRUE );
449        const int kind = EV_PERSIST
450                       | (( action & CURL_POLL_IN ) ? EV_READ : 0 )
451                       | (( action & CURL_POLL_OUT ) ? EV_WRITE : 0 );
452        dbgmsg( "setsock: fd is %d, curl action is %d, libevent action is %d", fd, action, kind );
453        assert( tr_amInEventThread( web->session ) );
454        assert( kind != EV_PERSIST );
455
456        /* clear any old polling on this fd */
457        clearSockinfoEvent( sockinfo );
458
459        /* set the new polling on this fd */
460        dbgmsg( "enabling (libevent %d, libcurl %d) polling on sockinfo %p, fd %d", action, kind, sockinfo, fd );
461        event_set( &sockinfo->ev, fd, kind, event_cb, web );
462        event_add( &sockinfo->ev, NULL );
463        sockinfo->evset = TRUE;
464    }
465
466    return 0;
467}
468
469
470/* libcurl documentation: "If 0, it means you should proceed immediately
471 * without waiting for anything. If it returns -1, there's no timeout at all
472 * set ... (but) you must not wait too long (more than a few seconds perhaps)
473 * before you call curl_multi_perform() again."  */
474static void
475multi_timer_cb( CURLM *multi UNUSED, long timer_ms, void * vg )
476{
477    tr_web * g = vg;
478
479    if( timer_ms < 1 ) {
480        if( timer_ms == 0 ) /* call it immediately */
481            timer_cb( 0, 0, g );
482        timer_ms = DEFAULT_TIMER_MSEC;
483    }
484
485    g->timer_ms = timer_ms;
486    restart_timer( g );
487}
488
489/****
490*****
491****/
492
493void
494tr_webRun( tr_session         * session,
495           const char         * url,
496           const char         * range,
497           tr_web_done_func     done_func,
498           void               * done_func_user_data )
499{
500    if( session->web )
501    {
502        static unsigned long tag = 0;
503        struct tr_web_task * task;
504
505        task = tr_new0( struct tr_web_task, 1 );
506        task->session = session;
507        task->url = tr_strdup( url );
508        task->range = tr_strdup( range );
509        task->done_func = done_func;
510        task->done_func_user_data = done_func_user_data;
511        task->tag = ++tag;
512        task->response = evbuffer_new( );
513
514        tr_runInEventThread( session, addTask, task );
515    }
516}
517
518tr_web*
519tr_webInit( tr_session * session )
520{
521    CURLMcode mcode;
522    static int curlInited = FALSE;
523    tr_web * web;
524
525    /* call curl_global_init if we haven't done it already.
526     * try to enable ssl for https support; but if that fails,
527     * try a plain vanilla init */ 
528    if( curlInited == FALSE ) {
529        curlInited = TRUE;
530        if( curl_global_init( CURL_GLOBAL_SSL ) )
531            curl_global_init( 0 );
532    }
533   
534    web = tr_new0( struct tr_web, 1 );
535    web->multi = curl_multi_init( );
536    web->session = session;
537    web->timer_ms = DEFAULT_TIMER_MSEC; /* overwritten by multi_timer_cb() */
538
539    evtimer_set( &web->timer_event, timer_cb, web );
540    mcode = curl_multi_setopt( web->multi, CURLMOPT_SOCKETDATA, web );
541    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
542    mcode = curl_multi_setopt( web->multi, CURLMOPT_SOCKETFUNCTION, sock_cb );
543    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
544    mcode = curl_multi_setopt( web->multi, CURLMOPT_TIMERDATA, web );
545    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
546    mcode = curl_multi_setopt( web->multi, CURLMOPT_TIMERFUNCTION, multi_timer_cb );
547    tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
548
549    return web;
550}
551
552void
553tr_webClose( tr_web ** web_in )
554{
555    tr_web * web = *web_in;
556    *web_in = NULL;
557    if( web->still_running < 1 )
558        web_close( web );
559    else
560        web->closing = 1;
561}
562
563/*****
564******
565******
566*****/
567
568static struct http_msg {
569    long code;
570    const char * text;
571} http_msg[] = {
572    {   0, "No Response" },
573    { 101, "Switching Protocols" },
574    { 200, "OK" },
575    { 201, "Created" },
576    { 202, "Accepted" },
577    { 203, "Non-Authoritative Information" },
578    { 204, "No Content" },
579    { 205, "Reset Content" },
580    { 206, "Partial Content" },
581    { 300, "Multiple Choices" },
582    { 301, "Moved Permanently" },
583    { 302, "Found" },
584    { 303, "See Other" },
585    { 304, "Not Modified" },
586    { 305, "Use Proxy" },
587    { 306, "(Unused)" },
588    { 307, "Temporary Redirect" },
589    { 400, "Bad Request" },
590    { 401, "Unauthorized" },
591    { 402, "Payment Required" },
592    { 403, "Forbidden" },
593    { 404, "Not Found" },
594    { 405, "Method Not Allowed" },
595    { 406, "Not Acceptable" },
596    { 407, "Proxy Authentication Required" },
597    { 408, "Request Timeout" },
598    { 409, "Conflict" },
599    { 410, "Gone" },
600    { 411, "Length Required" },
601    { 412, "Precondition Failed" },
602    { 413, "Request Entity Too Large" },
603    { 414, "Request-URI Too Long" },
604    { 415, "Unsupported Media Type" },
605    { 416, "Requested Range Not Satisfiable" },
606    { 417, "Expectation Failed" },
607    { 500, "Internal Server Error" },
608    { 501, "Not Implemented" },
609    { 502, "Bad Gateway" },
610    { 503, "Service Unavailable" },
611    { 504, "Gateway Timeout" },
612    { 505, "HTTP Version Not Supported" }
613};
614
615static int
616compareResponseCodes( const void * va, const void * vb )
617{
618    const long a = *(const long*) va;
619    const struct http_msg * b = vb;
620    return a - b->code;
621}
622
623const char *
624tr_webGetResponseStr( long code )
625{
626    struct http_msg * msg = bsearch( &code,
627                                     http_msg, 
628                                     sizeof( http_msg ) / sizeof( http_msg[0] ),
629                                     sizeof( http_msg[0] ),
630                                     compareResponseCodes );
631    return msg ? msg->text : "Unknown Error";
632}
Note: See TracBrowser for help on using the repository browser.