source: trunk/libtransmission/web.c @ 11512

Last change on this file since 11512 was 11512, checked in by charles, 11 years ago

(trunk) #3817 "use the OS' proxy support" -- implemented for libtransmission, transmission-gtk

  • Property svn:keywords set to Date Rev Author Id
File size: 13.4 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 11512 2010-12-10 18:51:05Z 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 long
128getTimeoutFromURL( const struct tr_web_task * task )
129{
130    long timeout;
131    const tr_session * session = task->session;
132
133    if( !session || session->isClosed ) timeout = 20L;
134    else if( strstr( task->url, "scrape" ) != NULL ) timeout = 30L;
135    else if( strstr( task->url, "announce" ) != NULL ) timeout = 90L;
136    else timeout = 240L;
137
138    return timeout;
139}
140
141static CURL *
142createEasy( tr_session * s, struct tr_web_task * task )
143{
144    const tr_address * addr;
145    CURL * e = curl_easy_init( );
146    const long verbose = getenv( "TR_CURL_VERBOSE" ) != NULL;
147    char * cookie_filename = tr_buildPath( s->configDir, "cookies.txt", NULL );
148
149    curl_easy_setopt( e, CURLOPT_AUTOREFERER, 1L );
150    curl_easy_setopt( e, CURLOPT_COOKIEFILE, cookie_filename );
151    curl_easy_setopt( e, CURLOPT_ENCODING, "gzip;q=1.0, deflate, identity" );
152    curl_easy_setopt( e, CURLOPT_FOLLOWLOCATION, 1L );
153    curl_easy_setopt( e, CURLOPT_MAXREDIRS, -1L );
154    curl_easy_setopt( e, CURLOPT_NOSIGNAL, 1L );
155    curl_easy_setopt( e, CURLOPT_PRIVATE, task );
156#ifdef USE_LIBCURL_SOCKOPT
157    curl_easy_setopt( e, CURLOPT_SOCKOPTFUNCTION, sockoptfunction );
158    curl_easy_setopt( e, CURLOPT_SOCKOPTDATA, task );
159#endif
160    curl_easy_setopt( e, CURLOPT_SSL_VERIFYHOST, 0L );
161    curl_easy_setopt( e, CURLOPT_SSL_VERIFYPEER, 0L );
162    curl_easy_setopt( e, CURLOPT_TIMEOUT, getTimeoutFromURL( task ) );
163    curl_easy_setopt( e, CURLOPT_URL, task->url );
164    curl_easy_setopt( e, CURLOPT_USERAGENT, TR_NAME "/" SHORT_VERSION_STRING );
165    curl_easy_setopt( e, CURLOPT_VERBOSE, verbose );
166    curl_easy_setopt( e, CURLOPT_WRITEDATA, task );
167    curl_easy_setopt( e, CURLOPT_WRITEFUNCTION, writeFunc );
168
169    if(( addr = tr_sessionGetPublicAddress( s, TR_AF_INET )))
170        curl_easy_setopt( e, CURLOPT_INTERFACE, tr_ntop_non_ts( addr ) );
171
172    if( task->range )
173        curl_easy_setopt( e, CURLOPT_RANGE, task->range );
174
175    if( s->curl_easy_config_func != NULL )
176        s->curl_easy_config_func( s, e, task->url );
177
178    tr_free( cookie_filename );
179    return e;
180}
181
182/***
183****
184***/
185
186static void
187task_finish_func( void * vtask )
188{
189    struct tr_web_task * task = vtask;
190    dbgmsg( "finished web task %p; got %ld", task, task->code );
191
192    if( task->done_func != NULL )
193        task->done_func( task->session,
194                         task->code,
195                         EVBUFFER_DATA( task->response ),
196                         EVBUFFER_LENGTH( task->response ),
197                         task->done_func_user_data );
198
199    task_free( task );
200}
201
202/****
203*****
204****/
205
206void
207tr_webRun( tr_session         * session,
208           const char         * url,
209           const char         * range,
210           tr_web_done_func     done_func,
211           void               * done_func_user_data )
212{
213    struct tr_web * web = session->web;
214
215    if( web != NULL )
216    {
217        struct tr_web_task * task = tr_new0( struct tr_web_task, 1 );
218
219        task->session = session;
220        task->url = tr_strdup( url );
221        task->range = tr_strdup( range );
222        task->done_func = done_func;
223        task->done_func_user_data = done_func_user_data;
224        task->response = evbuffer_new( );
225
226        tr_lockLock( web->taskLock );
227        tr_list_append( &web->tasks, task );
228        tr_lockUnlock( web->taskLock );
229    }
230}
231
232/**
233 * Portability wrapper for select().
234 *
235 * http://msdn.microsoft.com/en-us/library/ms740141%28VS.85%29.aspx
236 * On win32, any two of the parameters, readfds, writefds, or exceptfds,
237 * can be given as null. At least one must be non-null, and any non-null
238 * descriptor set must contain at least one handle to a socket.
239 */
240static void
241tr_select( int nfds,
242           fd_set * r_fd_set, fd_set * w_fd_set, fd_set * c_fd_set,
243           struct timeval  * t )
244{
245#ifdef WIN32
246    if( !r_fd_set->fd_count && !w_fd_set->fd_count && !c_fd_set->fd_count )
247    {
248        const long int msec = t->tv_sec*1000 + t->tv_usec/1000;
249        tr_wait_msec( msec );
250    }
251    else if( select( 0, r_fd_set->fd_count ? r_fd_set : NULL,
252                        w_fd_set->fd_count ? w_fd_set : NULL,
253                        c_fd_set->fd_count ? c_fd_set : NULL, t ) < 0 )
254    {
255        char errstr[512];
256        const int e = EVUTIL_SOCKET_ERROR( );
257        tr_net_strerror( errstr, sizeof( errstr ), e );
258        dbgmsg( "Error: select (%d) %s", e, errstr );
259    }
260#else
261    select( nfds, r_fd_set, w_fd_set, c_fd_set, t );
262#endif
263}
264
265static void
266tr_webThreadFunc( void * vsession )
267{
268    int unused;
269    CURLM * multi;
270    struct tr_web * web;
271    int taskCount = 0;
272    tr_session * session = vsession;
273
274    /* try to enable ssl for https support; but if that fails,
275     * try a plain vanilla init */
276    if( curl_global_init( CURL_GLOBAL_SSL ) )
277        curl_global_init( 0 );
278
279    web = tr_new0( struct tr_web, 1 );
280    web->close_mode = ~0;
281    web->taskLock = tr_lockNew( );
282    web->tasks = NULL;
283    multi = curl_multi_init( );
284    session->web = web;
285
286    for( ;; )
287    {
288        long msec;
289        CURLMsg * msg;
290        CURLMcode mcode;
291        struct tr_web_task * task;
292
293        if( web->close_mode == TR_WEB_CLOSE_NOW )
294            break;
295        if( ( web->close_mode == TR_WEB_CLOSE_WHEN_IDLE ) && !taskCount )
296            break;
297
298        /* add tasks from the queue */
299        tr_lockLock( web->taskLock );
300        while(( task = tr_list_pop_front( &web->tasks )))
301        {
302            dbgmsg( "adding task to curl: [%s]\n", task->url );
303            curl_multi_add_handle( multi, createEasy( session, task ));
304            /*fprintf( stderr, "adding a task.. taskCount is now %d\n", taskCount );*/
305            ++taskCount;
306        }
307        tr_lockUnlock( web->taskLock );
308
309        /* maybe wait a little while before calling curl_multi_perform() */
310        msec = 0;
311        curl_multi_timeout( multi, &msec );
312        if( msec < 0 )
313            msec = THREADFUNC_MAX_SLEEP_MSEC;
314        if( msec > 0 )
315        {
316            int usec;
317            int max_fd;
318            struct timeval t;
319            fd_set r_fd_set, w_fd_set, c_fd_set;
320
321            max_fd = 0;
322            FD_ZERO( &r_fd_set );
323            FD_ZERO( &w_fd_set );
324            FD_ZERO( &c_fd_set );
325            curl_multi_fdset( multi, &r_fd_set, &w_fd_set, &c_fd_set, &max_fd );
326
327            if( msec > THREADFUNC_MAX_SLEEP_MSEC )
328                msec = THREADFUNC_MAX_SLEEP_MSEC;
329
330            usec = msec * 1000;
331            t.tv_sec =  usec / 1000000;
332            t.tv_usec = usec % 1000000;
333
334            tr_select( max_fd+1, &r_fd_set, &w_fd_set, &c_fd_set, &t );
335        }
336
337        /* call curl_multi_perform() */
338        do {
339            mcode = curl_multi_perform( multi, &unused );
340        } while( mcode == CURLM_CALL_MULTI_PERFORM );
341
342        /* pump completed tasks from the multi */
343        while(( msg = curl_multi_info_read( multi, &unused )))
344        {
345            if(( msg->msg == CURLMSG_DONE ) && ( msg->easy_handle != NULL ))
346            {
347                struct tr_web_task * task;
348                CURL * e = msg->easy_handle;
349                curl_easy_getinfo( e, CURLINFO_PRIVATE, (void*)&task );
350                curl_easy_getinfo( e, CURLINFO_RESPONSE_CODE, &task->code );
351                curl_multi_remove_handle( multi, e );
352                curl_easy_cleanup( e );
353/*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) );*/
354                tr_runInEventThread( task->session, task_finish_func, task );
355                --taskCount;
356            }
357        }
358    }
359
360    /* cleanup */
361    curl_multi_cleanup( multi );
362    tr_lockFree( web->taskLock );
363    tr_free( web );
364    session->web = NULL;
365}
366
367void
368tr_webInit( tr_session * session )
369{
370    tr_threadNew( tr_webThreadFunc, session );
371}
372
373void
374tr_webClose( tr_session * session, tr_web_close_mode close_mode )
375{
376    if( session->web != NULL )
377    {
378        session->web->close_mode = close_mode;
379
380        if( close_mode == TR_WEB_CLOSE_NOW )
381            while( session->web != NULL )
382                tr_wait_msec( 100 );
383    }
384}
385
386/*****
387******
388******
389*****/
390
391const char *
392tr_webGetResponseStr( long code )
393{
394    switch( code )
395    {
396        case   0: return "No Response";
397        case 101: return "Switching Protocols";
398        case 200: return "OK";
399        case 201: return "Created";
400        case 202: return "Accepted";
401        case 203: return "Non-Authoritative Information";
402        case 204: return "No Content";
403        case 205: return "Reset Content";
404        case 206: return "Partial Content";
405        case 300: return "Multiple Choices";
406        case 301: return "Moved Permanently";
407        case 302: return "Found";
408        case 303: return "See Other";
409        case 304: return "Not Modified";
410        case 305: return "Use Proxy";
411        case 306: return "(Unused)";
412        case 307: return "Temporary Redirect";
413        case 400: return "Bad Request";
414        case 401: return "Unauthorized";
415        case 402: return "Payment Required";
416        case 403: return "Forbidden";
417        case 404: return "Not Found";
418        case 405: return "Method Not Allowed";
419        case 406: return "Not Acceptable";
420        case 407: return "Proxy Authentication Required";
421        case 408: return "Request Timeout";
422        case 409: return "Conflict";
423        case 410: return "Gone";
424        case 411: return "Length Required";
425        case 412: return "Precondition Failed";
426        case 413: return "Request Entity Too Large";
427        case 414: return "Request-URI Too Long";
428        case 415: return "Unsupported Media Type";
429        case 416: return "Requested Range Not Satisfiable";
430        case 417: return "Expectation Failed";
431        case 500: return "Internal Server Error";
432        case 501: return "Not Implemented";
433        case 502: return "Bad Gateway";
434        case 503: return "Service Unavailable";
435        case 504: return "Gateway Timeout";
436        case 505: return "HTTP Version Not Supported";
437        default:  return "Unknown Error";
438    }
439}
440
441void
442tr_http_escape( struct evbuffer  * out,
443                const char * str, int len, tr_bool escape_slashes )
444{
445    const char * end;
446
447    if( ( len < 0 ) && ( str != NULL ) )
448        len = strlen( str );
449
450    for( end=str+len; str && str!=end; ++str ) {
451        if(    ( *str == ',' )
452            || ( *str == '-' )
453            || ( *str == '.' )
454            || ( ( '0' <= *str ) && ( *str <= '9' ) )
455            || ( ( 'A' <= *str ) && ( *str <= 'Z' ) )
456            || ( ( 'a' <= *str ) && ( *str <= 'z' ) )
457            || ( ( *str == '/' ) && ( !escape_slashes ) ) )
458            evbuffer_add( out, str, 1 );
459        else
460            evbuffer_add_printf( out, "%%%02X", (unsigned)(*str&0xFF) );
461    }
462}
463
464char *
465tr_http_unescape( const char * str, int len )
466{
467    char * tmp = curl_unescape( str, len );
468    char * ret = tr_strdup( tmp );
469    curl_free( tmp );
470    return ret;
471}
Note: See TracBrowser for help on using the repository browser.