source: branches/1.9x/libtransmission/web.c @ 10572

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

(1.9x libT) backport r10484 for #3140 "transmission doesn't buil with curl 7.15.5"

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