source: trunk/libtransmission/web.c @ 5700

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

add tr_webClose()

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