source: trunk/libtransmission/web.c @ 5783

Last change on this file since 5783 was 5783, checked in by charles, 14 years ago

undo the curl timeout option from earlier today

  • Property svn:keywords set to Date Rev Author Id
File size: 8.6 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.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 5783 2008-05-09 04:00:14Z charles $
11 */
12
13#include <assert.h>
14#include <stdlib.h> /* bsearch */
15
16#include <event.h>
17#include <curl/curl.h>
18
19#include "transmission.h"
20#include "trevent.h"
21#include "utils.h"
22#include "web.h"
23
24#define CURL_CHECK_VERSION(major,minor,micro)    \
25    (LIBCURL_VERSION_MAJOR > (major) || \
26     (LIBCURL_VERSION_MAJOR == (major) && LIBCURL_VERSION_MINOR > (minor)) || \
27     (LIBCURL_VERSION_MAJOR == (major) && LIBCURL_VERSION_MINOR == (minor) && \
28      LIBCURL_VERSION_PATCH >= (micro)))
29
30#define PULSE_MSEC 500
31
32#define dbgmsg(fmt...) tr_deepLog( __FILE__, __LINE__, "web", ##fmt )
33
34struct tr_web
35{
36    unsigned int dying     : 1;
37    unsigned int running   : 1;
38    int remain;
39    CURLM * cm;
40    tr_session * session;
41    struct event timer;
42};
43
44struct tr_web_task
45{
46    unsigned long tag;
47    struct evbuffer * response;
48    char * url;
49    tr_session * session;
50    tr_web_done_func * done_func;
51    void * done_func_user_data;
52};
53
54static void
55processCompletedTasks( tr_web * web )
56{
57    CURL * easy;
58    CURLMsg * msg;
59    CURLcode res;
60
61    do {
62        /* this convoluted loop is from the "hiperinfo.c" sample which
63         * hints that removing an easy handle in curl_multi_info_read's
64         * loop may be unsafe */
65        int more;
66        easy = NULL;
67        while(( msg = curl_multi_info_read( web->cm, &more ))) {
68            if( msg->msg == CURLMSG_DONE ) {
69                easy = msg->easy_handle;
70                res = msg->data.result;
71                break;
72            }
73        }
74        if( easy ) {
75            struct tr_web_task * task;
76            long response_code;
77            curl_easy_getinfo( easy, CURLINFO_PRIVATE, &task );
78            curl_easy_getinfo( easy, CURLINFO_RESPONSE_CODE, &response_code );
79            --web->remain;
80            dbgmsg( "task #%lu done (%d remain)", task->tag, web->remain );
81            task->done_func( web->session,
82                             response_code,
83                             EVBUFFER_DATA(task->response),
84                             EVBUFFER_LENGTH(task->response),
85                             task->done_func_user_data );
86            curl_multi_remove_handle( web->cm, easy );
87            curl_easy_cleanup( easy );
88            evbuffer_free( task->response );
89            tr_free( task->url );
90            tr_free( task );
91        }
92    } while( easy );
93}
94
95static void
96pump( tr_web * web )
97{
98    int unused;
99    CURLMcode rc;
100    do {
101        rc = curl_multi_perform( web->cm, &unused );
102    } while( rc == CURLM_CALL_MULTI_PERFORM );
103    if ( rc == CURLM_OK  )
104        processCompletedTasks( web );
105    else
106        tr_err( "%s", curl_multi_strerror(rc) );
107}
108
109static size_t
110writeFunc( void * ptr, size_t size, size_t nmemb, void * task )
111{
112    const size_t byteCount = size * nmemb;
113    evbuffer_add( ((struct tr_web_task*)task)->response, ptr, byteCount );
114    return byteCount;
115}
116
117static void
118ensureTimerIsRunning( tr_web * web )
119{
120    if( !web->running )
121    {
122        struct timeval tv = tr_timevalMsec( PULSE_MSEC );
123        dbgmsg( "starting web timer" );
124        web->running = 1;
125        evtimer_add( &web->timer, &tv );
126    }
127}
128
129static void
130addTask( void * vtask )
131{
132    struct tr_web_task * task = vtask;
133
134    if( task->session && task->session->web )
135    {
136        struct tr_web * web = task->session->web;
137        CURL * ch;
138
139        ensureTimerIsRunning( web );
140
141        ++web->remain;
142        dbgmsg( "adding task #%lu [%s] (%d remain)", task->tag, task->url, web->remain );
143
144        ch = curl_easy_init( );
145        curl_easy_setopt( ch, CURLOPT_PRIVATE, task );
146        curl_easy_setopt( ch, CURLOPT_URL, task->url );
147        curl_easy_setopt( ch, CURLOPT_WRITEFUNCTION, writeFunc );
148        curl_easy_setopt( ch, CURLOPT_WRITEDATA, task );
149        curl_easy_setopt( ch, CURLOPT_USERAGENT, TR_NAME "/" LONG_VERSION_STRING );
150        curl_easy_setopt( ch, CURLOPT_SSL_VERIFYPEER, 0 );
151        curl_easy_setopt( ch, CURLOPT_FORBID_REUSE, 1 );
152        curl_easy_setopt( ch, CURLOPT_NOSIGNAL, 1 );
153        curl_easy_setopt( ch, CURLOPT_FOLLOWLOCATION, 1 );
154        curl_easy_setopt( ch, CURLOPT_MAXREDIRS, 5 );
155        curl_easy_setopt( ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4 );
156        curl_easy_setopt( ch, CURLOPT_ENCODING, "" );
157        curl_multi_add_handle( web->cm, ch );
158    }
159}
160
161void
162tr_webRun( tr_session         * session,
163           const char         * url,
164           tr_web_done_func   * done_func,
165           void               * done_func_user_data )
166{
167    if( session->web )
168    {
169        static unsigned long tag = 0;
170        struct tr_web_task * task;
171
172        task = tr_new0( struct tr_web_task, 1 );
173        task->session = session;
174        task->url = tr_strdup( url );
175        task->done_func = done_func;
176        task->done_func_user_data = done_func_user_data;
177        task->tag = ++tag;
178        task->response = evbuffer_new( );
179
180        tr_runInEventThread( session, addTask, task );
181    }
182}
183
184static void
185webDestroy( tr_web * web )
186{
187    dbgmsg( "deleting web timer" );
188    assert( !web->running );
189    evtimer_del( &web->timer );
190    curl_multi_cleanup( web->cm );
191    tr_free( web );
192}
193
194static void
195pulse( int socket UNUSED, short action UNUSED, void * vweb )
196{
197    tr_web * web = vweb;
198    assert( web->running );
199
200    pump( web );
201
202    evtimer_del( &web->timer );
203
204    web->running = web->remain > 0;
205
206    if( web->running ) {
207        struct timeval tv = tr_timevalMsec( PULSE_MSEC );
208        evtimer_add( &web->timer, &tv );
209    } else if( web->dying ) {
210        webDestroy( web );
211    } else {
212        dbgmsg( "stopping web timer" );
213    }
214}
215
216tr_web*
217tr_webInit( tr_session * session )
218{
219    static int curlInited = FALSE;
220    tr_web * web;
221
222    /* call curl_global_init if we haven't done it already.
223     * try to enable ssl for https support; but if that fails,
224     * try a plain vanilla init */ 
225    if( curlInited == FALSE ) {
226        curlInited = TRUE;
227        if( curl_global_init( CURL_GLOBAL_SSL ) )
228            curl_global_init( 0 );
229    }
230   
231    web = tr_new0( struct tr_web, 1 );
232    web->cm = curl_multi_init( );
233    web->session = session;
234
235    evtimer_set( &web->timer, pulse, web );
236#if CURL_CHECK_VERSION(7,16,3)
237    curl_multi_setopt( web->cm, CURLMOPT_MAXCONNECTS, 10 );
238#endif
239    pump( web );
240
241    return web;
242}
243
244void
245tr_webClose( tr_web ** web_in )
246{
247    tr_web * web = *web_in;
248    *web_in = NULL;
249
250    if( !web->running )
251        webDestroy( web );
252    else
253        web->dying = 1;
254}
255
256/***
257****
258***/
259
260static struct http_msg {
261    long code;
262    const char * text;
263} http_msg[] = {
264    { 101, "Switching Protocols" },
265    { 200, "OK" },
266    { 201, "Created" },
267    { 202, "Accepted" },
268    { 203, "Non-Authoritative Information" },
269    { 204, "No Content" },
270    { 205, "Reset Content" },
271    { 206, "Partial Content" },
272    { 300, "Multiple Choices" },
273    { 301, "Moved Permanently" },
274    { 302, "Found" },
275    { 303, "See Other" },
276    { 304, "Not Modified" },
277    { 305, "Use Proxy" },
278    { 306, "(Unused)" },
279    { 307, "Temporary Redirect" },
280    { 400, "Bad Request" },
281    { 401, "Unauthorized" },
282    { 402, "Payment Required" },
283    { 403, "Forbidden" },
284    { 404, "Not Found" },
285    { 405, "Method Not Allowed" },
286    { 406, "Not Acceptable" },
287    { 407, "Proxy Authentication Required" },
288    { 408, "Request Timeout" },
289    { 409, "Conflict" },
290    { 410, "Gone" },
291    { 411, "Length Required" },
292    { 412, "Precondition Failed" },
293    { 413, "Request Entity Too Large" },
294    { 414, "Request-URI Too Long" },
295    { 415, "Unsupported Media Type" },
296    { 416, "Requested Range Not Satisfiable" },
297    { 417, "Expectation Failed" },
298    { 500, "Internal Server Error" },
299    { 501, "Not Implemented" },
300    { 502, "Bad Gateway" },
301    { 503, "Service Unavailable" },
302    { 504, "Gateway Timeout" },
303    { 505, "HTTP Version Not Supported" },
304    { 0, NULL }
305};
306
307static int
308compareResponseCodes( const void * va, const void * vb )
309{
310    const long a = *(const long*) va;
311    const struct http_msg * b = vb;
312    return a - b->code;
313}
314
315const char *
316tr_webGetResponseStr( long code )
317{
318    struct http_msg * msg = bsearch( &code,
319                                     http_msg, 
320                                     sizeof( http_msg ) / sizeof( http_msg[0] ),
321                                     sizeof( http_msg[0] ),
322                                     compareResponseCodes );
323    return msg ? msg->text : "Unknown Error";
324}
Note: See TracBrowser for help on using the repository browser.