mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/libtransmission/web.c

696 lines
20 KiB
C
Raw Blame History

/*
* This file Copyright (C) 2008-2009 Charles Kerr <charles@transmissionbt.com>
*
* This file is licensed by the GPL version 2. Works owned by the
* Transmission project are granted a special exemption to clause 2(b)
* so that the bulk of its code can remain under the MIT license.
* This exemption does not extend to derived works not owned by
* the Transmission project.
*
* $Id$
*/
#include <assert.h>
#include <stdlib.h> /* bsearch */
#include <event.h>
#define CURL_DISABLE_TYPECHECK /* otherwise -Wunreachable-code goes insane */
#include <curl/curl.h>
#include "transmission.h"
#include "list.h"
#include "net.h" /* socklen_t */
#include "session.h"
#include "trevent.h"
#include "utils.h"
#include "version.h"
#include "web.h"
static tr_bool
useCurlMultiSocketAction( void )
{
static tr_bool tested = FALSE;
static tr_bool useMultiSocketAction;
if( !tested )
{
#ifdef SYS_DARWIN /* for some reason, curl_multi_socket_action() + libevent
keeps crashing in event_queue_insert() on OS X 10.5 & 10.6 */
useMultiSocketAction = FALSE;
#else
curl_version_info_data * data = curl_version_info( CURLVERSION_NOW );
tr_inf( "Using libcurl %s", data->version );
/* Use curl_multi_socket_action() instead of curl_multi_perform()
* if libcurl >= 7.18.2. See http://trac.transmissionbt.com/ticket/1844 */
useMultiSocketAction = data->version_num >= 0x071202;
#endif
tested = TRUE;
}
return useMultiSocketAction;
}
enum
{
/* arbitrary number */
DEFAULT_TIMER_MSEC = 2500
};
#if 0
#define dbgmsg(...) \
do { \
fprintf( stderr, __VA_ARGS__ ); \
fprintf( stderr, "\n" ); \
} while( 0 )
#else
#define dbgmsg( ... ) \
do { \
if( tr_deepLoggingIsActive( ) ) \
tr_deepLog( __FILE__, __LINE__, "web", __VA_ARGS__ ); \
} while( 0 )
#endif
struct tr_web_sockinfo
{
int fd;
tr_bool evset;
struct event ev;
};
struct tr_web
{
tr_bool closing;
int prev_running;
int still_running;
long timer_ms;
CURLM * multi;
tr_session * session;
tr_bool haveAddr;
tr_address addr;
struct event timer_event;
tr_list * fds;
};
/***
****
***/
static struct tr_web_sockinfo *
getSockinfo( tr_web * web, int fd, tr_bool createIfMissing )
{
tr_list * l;
for( l=web->fds; l!=NULL; l=l->next ) {
struct tr_web_sockinfo * s = l->data;
if( s->fd == fd ) {
dbgmsg( "looked up sockinfo %p for fd %d", s, fd );
return s;
}
}
if( createIfMissing ) {
struct tr_web_sockinfo * s = tr_new0( struct tr_web_sockinfo, 1 );
s->fd = fd;
tr_list_prepend( &web->fds, s );
dbgmsg( "created sockinfo %p for fd %d... we now have %d sockinfos", s, fd, tr_list_size(web->fds) );
return s;
}
return NULL;
}
static void
clearSockinfoEvent( struct tr_web_sockinfo * s )
{
if( s && s->evset )
{
dbgmsg( "clearing libevent polling for sockinfo %p, fd %d", s, s->fd );
event_del( &s->ev );
s->evset = FALSE;
}
}
static void
purgeSockinfo( tr_web * web, int fd )
{
struct tr_web_sockinfo * s = getSockinfo( web, fd, FALSE );
if( s != NULL )
{
tr_list_remove_data( &web->fds, s );
clearSockinfoEvent( s );
dbgmsg( "freeing sockinfo %p, fd %d", s, s->fd );
tr_free( s );
}
}
/***
****
***/
struct tr_web_task
{
unsigned long tag;
struct evbuffer * response;
char * url;
char * range;
tr_session * session;
tr_web_done_func * done_func;
void * done_func_user_data;
};
static size_t
writeFunc( void * ptr, size_t size, size_t nmemb, void * vtask )
{
const size_t byteCount = size * nmemb;
struct tr_web_task * task = vtask;
evbuffer_add( task->response, ptr, byteCount );
dbgmsg( "wrote %zu bytes to task %p's buffer", byteCount, task );
return byteCount;
}
static int
getCurlProxyType( tr_proxy_type t )
{
switch( t )
{
case TR_PROXY_SOCKS4: return CURLPROXY_SOCKS4;
case TR_PROXY_SOCKS5: return CURLPROXY_SOCKS5;
default: return CURLPROXY_HTTP;
}
}
static void
addTask( void * vtask )
{
struct tr_web_task * task = vtask;
const tr_session * session = task->session;
if( session && session->web )
{
struct tr_web * web = session->web;
CURL * easy;
long timeout;
dbgmsg( "adding task #%lu [%s]", task->tag, task->url );
easy = curl_easy_init( );
if( !task->range && session->isProxyEnabled ) {
curl_easy_setopt( easy, CURLOPT_PROXY, session->proxy );
curl_easy_setopt( easy, CURLOPT_PROXYAUTH, CURLAUTH_ANY );
curl_easy_setopt( easy, CURLOPT_PROXYPORT, session->proxyPort );
curl_easy_setopt( easy, CURLOPT_PROXYTYPE,
getCurlProxyType( session->proxyType ) );
}
if( !task->range && session->isProxyAuthEnabled ) {
char * str = tr_strdup_printf( "%s:%s", session->proxyUsername,
session->proxyPassword );
curl_easy_setopt( easy, CURLOPT_PROXYUSERPWD, str );
tr_free( str );
}
curl_easy_setopt( easy, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4 );
/* set a time limit for announces & scrapes */
if( strstr( task->url, "scrape" ) != NULL )
timeout = 20L;
else if( strstr( task->url, "announce" ) != NULL )
timeout = 30L;
else
timeout = 240L;
curl_easy_setopt( easy, CURLOPT_TIMEOUT, timeout );
curl_easy_setopt( easy, CURLOPT_CONNECTTIMEOUT, timeout-5 );
dbgmsg( "new task's timeout is %ld\n", timeout );
curl_easy_setopt( easy, CURLOPT_DNS_CACHE_TIMEOUT, 600L );
curl_easy_setopt( easy, CURLOPT_FOLLOWLOCATION, 1L );
curl_easy_setopt( easy, CURLOPT_AUTOREFERER, 1L );
curl_easy_setopt( easy, CURLOPT_FORBID_REUSE, 1L );
curl_easy_setopt( easy, CURLOPT_MAXREDIRS, -1L );
curl_easy_setopt( easy, CURLOPT_NOSIGNAL, 1L );
curl_easy_setopt( easy, CURLOPT_PRIVATE, task );
curl_easy_setopt( easy, CURLOPT_SSL_VERIFYHOST, 0L );
curl_easy_setopt( easy, CURLOPT_SSL_VERIFYPEER, 0L );
curl_easy_setopt( easy, CURLOPT_URL, task->url );
curl_easy_setopt( easy, CURLOPT_USERAGENT,
TR_NAME "/" LONG_VERSION_STRING );
curl_easy_setopt( easy, CURLOPT_VERBOSE,
getenv( "TR_CURL_VERBOSE" ) != NULL );
if( web->haveAddr )
curl_easy_setopt( easy, CURLOPT_INTERFACE, tr_ntop_non_ts( &web->addr ) );
curl_easy_setopt( easy, CURLOPT_WRITEDATA, task );
curl_easy_setopt( easy, CURLOPT_WRITEFUNCTION, writeFunc );
if( task->range )
curl_easy_setopt( easy, CURLOPT_RANGE, task->range );
else /* don't set encoding on webseeds; it messes up binary data */
curl_easy_setopt( easy, CURLOPT_ENCODING, "" );
{
const CURLMcode mcode = curl_multi_add_handle( web->multi, easy );
tr_assert( mcode == CURLM_OK, "curl_multi_add_handle() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
if( mcode == CURLM_OK )
++web->still_running;
else
tr_err( "%s", curl_multi_strerror( mcode ) );
}
}
}
/***
****
***/
static void
task_free( struct tr_web_task * task )
{
evbuffer_free( task->response );
tr_free( task->range );
tr_free( task->url );
tr_free( task );
}
static void
task_finish( struct tr_web_task * task, long response_code )
{
dbgmsg( "finished a web task... response code is %ld", response_code );
dbgmsg( "===================================================" );
if( task->done_func != NULL )
task->done_func( task->session,
response_code,
EVBUFFER_DATA( task->response ),
EVBUFFER_LENGTH( task->response ),
task->done_func_user_data );
task_free( task );
}
static void
remove_finished_tasks( tr_web * g )
{
CURL * easy;
do
{
CURLMsg * msg;
int msgs_left;
easy = NULL;
while(( msg = curl_multi_info_read( g->multi, &msgs_left ))) {
if( msg->msg == CURLMSG_DONE ) {
easy = msg->easy_handle;
break;
}
}
if( easy ) {
long code;
long fd;
struct tr_web_task * task;
CURLcode ecode;
CURLMcode mcode;
ecode = curl_easy_getinfo( easy, CURLINFO_PRIVATE, (void*)&task );
tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
ecode = curl_easy_getinfo( easy, CURLINFO_RESPONSE_CODE, &code );
tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
ecode = curl_easy_getinfo( easy, CURLINFO_LASTSOCKET, &fd );
tr_assert( ecode == CURLE_OK, "curl_easy_getinfo() failed: %d (%s)", ecode, curl_easy_strerror( ecode ) );
if( fd != -1L )
purgeSockinfo( g, fd );
mcode = curl_multi_remove_handle( g->multi, easy );
tr_assert( mcode == CURLM_OK, "curl_multi_remove_handle() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
curl_easy_cleanup( easy );
task_finish( task, code );
}
}
while ( easy );
g->prev_running = g->still_running;
}
static void
stop_timer( tr_web* g )
{
if( evtimer_pending( &g->timer_event, NULL ) )
{
dbgmsg( "deleting the pending global timer" );
evtimer_del( &g->timer_event );
}
}
static void
restart_timer( tr_web * g )
{
struct timeval interval;
assert( tr_amInEventThread( g->session ) );
assert( g->session != NULL );
assert( g->session->events != NULL );
stop_timer( g );
dbgmsg( "adding a timeout for %.1f seconds from now", g->timer_ms/1000.0 );
tr_timevalMsec( g->timer_ms, &interval );
evtimer_add( &g->timer_event, &interval );
}
static void
web_close( tr_web * g )
{
CURLMcode mcode;
stop_timer( g );
mcode = curl_multi_cleanup( g->multi );
tr_assert( mcode == CURLM_OK, "curl_multi_cleanup() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
if( mcode != CURLM_OK )
tr_err( "%s", curl_multi_strerror( mcode ) );
tr_free( g );
}
/* note: this function can free the tr_web if its 'closing' flag is set
and no tasks remain. callers must not reference their g pointer
after calling this function */
static void
tr_multi_perform( tr_web * g, int fd )
{
int closed = FALSE;
CURLMcode mcode;
dbgmsg( "check_run_count: prev_running %d, still_running %d",
g->prev_running, g->still_running );
/* invoke libcurl's processing */
if( useCurlMultiSocketAction( ) )
{
do {
dbgmsg( "calling curl_multi_socket_action..." );
mcode = curl_multi_socket_action( g->multi, fd, 0, &g->still_running );
fd = CURL_SOCKET_TIMEOUT;
dbgmsg( "done calling curl_multi_socket_action..." );
} while( mcode == CURLM_CALL_MULTI_SOCKET );
}
else
{
do {
dbgmsg( "calling curl_multi_perform..." );
mcode = curl_multi_perform( g->multi, &g->still_running );
dbgmsg( "done calling curl_multi_perform..." );
} while( mcode == CURLM_CALL_MULTI_PERFORM );
}
tr_assert( mcode == CURLM_OK, "curl_multi_perform() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
if( mcode != CURLM_OK )
tr_err( "%s", curl_multi_strerror( mcode ) );
remove_finished_tasks( g );
if( !g->still_running ) {
assert( tr_list_size( g->fds ) == 0 );
stop_timer( g );
if( g->closing ) {
web_close( g );
closed = TRUE;
}
}
if( !closed )
restart_timer( g );
}
/* libevent says that sock is ready to be processed, so wake up libcurl */
static void
event_cb( int fd, short kind UNUSED, void * g )
{
tr_multi_perform( g, fd );
}
/* libevent says that timer_ms have passed, so wake up libcurl */
static void
timer_cb( int socket UNUSED, short action UNUSED, void * g )
{
dbgmsg( "libevent timer is done" );
tr_multi_perform( g, CURL_SOCKET_TIMEOUT );
}
/* CURLMOPT_SOCKETFUNCTION */
static int
sock_cb( CURL * e UNUSED,
curl_socket_t fd,
int action,
void * vweb,
void * unused UNUSED)
{
struct tr_web * web = vweb;
dbgmsg( "sock_cb: action is %d, fd is %d", action, (int)fd );
if( action == CURL_POLL_REMOVE )
{
purgeSockinfo( web, fd );
}
else
{
struct tr_web_sockinfo * sockinfo = getSockinfo( web, fd, TRUE );
const int kind = EV_PERSIST
| (( action & CURL_POLL_IN ) ? EV_READ : 0 )
| (( action & CURL_POLL_OUT ) ? EV_WRITE : 0 );
dbgmsg( "setsock: fd is %d, curl action is %d, libevent action is %d", fd, action, kind );
assert( tr_amInEventThread( web->session ) );
assert( kind != EV_PERSIST );
/* clear any old polling on this fd */
clearSockinfoEvent( sockinfo );
/* set the new polling on this fd */
dbgmsg( "enabling (libevent %d, libcurl %d) polling on sockinfo %p, fd %d", action, kind, sockinfo, fd );
event_set( &sockinfo->ev, fd, kind, event_cb, web );
event_add( &sockinfo->ev, NULL );
sockinfo->evset = TRUE;
}
return 0;
}
/* libcurl documentation: "If 0, it means you should proceed immediately
* without waiting for anything. If it returns -1, there's no timeout at all
* set ... (but) you must not wait too long (more than a few seconds perhaps)
* before you call curl_multi_perform() again." */
static void
multi_timer_cb( CURLM *multi UNUSED, long timer_ms, void * vg )
{
tr_web * g = vg;
if( timer_ms < 1 ) {
if( timer_ms == 0 ) /* call it immediately */
timer_cb( 0, 0, g );
timer_ms = DEFAULT_TIMER_MSEC;
}
g->timer_ms = timer_ms;
restart_timer( g );
}
/****
*****
****/
void
tr_webRun( tr_session * session,
const char * url,
const char * range,
tr_web_done_func done_func,
void * done_func_user_data )
{
if( session->web )
{
static unsigned long tag = 0;
struct tr_web_task * task;
task = tr_new0( struct tr_web_task, 1 );
task->session = session;
task->url = tr_strdup( url );
task->range = tr_strdup( range );
task->done_func = done_func;
task->done_func_user_data = done_func_user_data;
task->tag = ++tag;
task->response = evbuffer_new( );
tr_runInEventThread( session, addTask, task );
}
}
void
tr_webSetInterface( tr_web * web, const tr_address * addr )
{
if(( web->haveAddr = ( addr != NULL )))
web->addr = *addr;
}
tr_web*
tr_webInit( tr_session * session )
{
CURLMcode mcode;
static int curlInited = FALSE;
tr_web * web;
/* call curl_global_init if we haven't done it already.
* try to enable ssl for https support; but if that fails,
* try a plain vanilla init */
if( curlInited == FALSE ) {
curlInited = TRUE;
if( curl_global_init( CURL_GLOBAL_SSL ) )
curl_global_init( 0 );
}
web = tr_new0( struct tr_web, 1 );
web->multi = curl_multi_init( );
web->session = session;
web->timer_ms = DEFAULT_TIMER_MSEC; /* overwritten by multi_timer_cb() */
evtimer_set( &web->timer_event, timer_cb, web );
mcode = curl_multi_setopt( web->multi, CURLMOPT_SOCKETDATA, web );
tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
mcode = curl_multi_setopt( web->multi, CURLMOPT_SOCKETFUNCTION, sock_cb );
tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
mcode = curl_multi_setopt( web->multi, CURLMOPT_TIMERDATA, web );
tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
mcode = curl_multi_setopt( web->multi, CURLMOPT_TIMERFUNCTION, multi_timer_cb );
tr_assert( mcode == CURLM_OK, "curl_mutli_setopt() failed: %d (%s)", mcode, curl_multi_strerror( mcode ) );
return web;
}
void
tr_webClose( tr_web ** web_in )
{
tr_web * web = *web_in;
*web_in = NULL;
if( web->still_running < 1 )
web_close( web );
else
web->closing = 1;
}
/*****
******
******
*****/
static struct http_msg {
long code;
const char * text;
} http_msg[] = {
{ 0, "No Response" },
{ 101, "Switching Protocols" },
{ 200, "OK" },
{ 201, "Created" },
{ 202, "Accepted" },
{ 203, "Non-Authoritative Information" },
{ 204, "No Content" },
{ 205, "Reset Content" },
{ 206, "Partial Content" },
{ 300, "Multiple Choices" },
{ 301, "Moved Permanently" },
{ 302, "Found" },
{ 303, "See Other" },
{ 304, "Not Modified" },
{ 305, "Use Proxy" },
{ 306, "(Unused)" },
{ 307, "Temporary Redirect" },
{ 400, "Bad Request" },
{ 401, "Unauthorized" },
{ 402, "Payment Required" },
{ 403, "Forbidden" },
{ 404, "Not Found" },
{ 405, "Method Not Allowed" },
{ 406, "Not Acceptable" },
{ 407, "Proxy Authentication Required" },
{ 408, "Request Timeout" },
{ 409, "Conflict" },
{ 410, "Gone" },
{ 411, "Length Required" },
{ 412, "Precondition Failed" },
{ 413, "Request Entity Too Large" },
{ 414, "Request-URI Too Long" },
{ 415, "Unsupported Media Type" },
{ 416, "Requested Range Not Satisfiable" },
{ 417, "Expectation Failed" },
{ 500, "Internal Server Error" },
{ 501, "Not Implemented" },
{ 502, "Bad Gateway" },
{ 503, "Service Unavailable" },
{ 504, "Gateway Timeout" },
{ 505, "HTTP Version Not Supported" }
};
static int
compareResponseCodes( const void * va, const void * vb )
{
const long a = *(const long*) va;
const struct http_msg * b = vb;
return a - b->code;
}
const char *
tr_webGetResponseStr( long code )
{
struct http_msg * msg = bsearch( &code,
http_msg,
sizeof( http_msg ) / sizeof( http_msg[0] ),
sizeof( http_msg[0] ),
compareResponseCodes );
return msg ? msg->text : "Unknown Error";
}
/* escapes a string to be URI-legal as per RFC 2396.
like curl_escape() but can optionally avoid munging slashes. */
void
tr_http_escape( struct evbuffer *out, const char *str, int len, int keep_slashes )
{
int i;
for( i = 0; i < len; i++ ) {
switch( str[i] ) {
case ',': case '-': case '.':
case '0': case '1': case '2': case '3': case '4':
case '5': case '6': case '7': case '8': case '9':
case 'a': case 'b': case 'c': case 'd': case 'e':
case 'f': case 'g': case 'h': case 'i': case 'j':
case 'k': case 'l': case 'm': case 'n': case 'o':
case 'p': case 'q': case 'r': case 's': case 't':
case 'u': case 'v': case 'w': case 'x': case 'y': case 'z':
case 'A': case 'B': case 'C': case 'D': case 'E':
case 'F': case 'G': case 'H': case 'I': case 'J':
case 'K': case 'L': case 'M': case 'N': case 'O':
case 'P': case 'Q': case 'R': case 'S': case 'T':
case 'U': case 'V': case 'W': case 'X': case 'Y': case 'Z':
evbuffer_add( out, &str[i], 1 );
break;
case '/':
if(keep_slashes) {
evbuffer_add( out, &str[i], 1 );
break;
}
/* Fall through. */
default:
evbuffer_add_printf( out, "%%%02X", (unsigned)(str[i]&0xFF) );
break;
}
}
}
char*
tr_http_unescape( const char * str, int len )
{
char * tmp = curl_unescape( str, len );
char * ret = tr_strdup( tmp );
curl_free( tmp );
return ret;
}
Reference in New Issue View Git Blame Copy Permalink