source: trunk/libtransmission/announcer-http.c @ 12545

Last change on this file since 12545 was 12391, checked in by jordan, 11 years ago

(trunk libT) tweak the ABI of tr_bencToBuf() to match the way it's being used

  • Property svn:keywords set to Date Rev Author Id
File size: 14.3 KB
Line 
1/*
2 * This file Copyright (C) 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: announcer-http.c 12391 2011-04-27 21:22:08Z jordan $
11 */
12
13#include <limits.h> /* USHRT_MAX */
14#include <stdio.h> /* fprintf() */
15#include <stdlib.h> /* getenv() */
16#include <string.h> /* strchr(), memcmp(), memcpy() */
17
18#include <event2/buffer.h>
19#include <event2/http.h> /* for HTTP_OK */
20
21#define __LIBTRANSMISSION_ANNOUNCER_MODULE___
22
23#include "transmission.h"
24#include "announcer-common.h"
25#include "net.h" /* tr_globalIPv6() */
26#include "peer-mgr.h" /* pex */
27#include "torrent.h"
28#include "trevent.h" /* tr_runInEventThread() */
29#include "utils.h"
30#include "web.h" /* tr_http_escape() */
31
32#define dbgmsg( name, ... ) \
33if( tr_deepLoggingIsActive( ) ) do { \
34  tr_deepLog( __FILE__, __LINE__, name, __VA_ARGS__ ); \
35} while( 0 )
36
37/****
38*****
39*****  ANNOUNCE
40*****
41****/
42
43static const char*
44get_event_string( const tr_announce_request * req )
45{
46    if( req->partial_seed )
47        if( req->event != TR_ANNOUNCE_EVENT_STOPPED )
48            return "paused";
49
50    return tr_announce_event_get_string( req->event );
51}
52
53static struct evbuffer *
54announce_url_new( const tr_session * session, const tr_announce_request * req )
55{
56    const char * str;
57    const unsigned char * ipv6;
58    struct evbuffer * buf = evbuffer_new( );
59    char escaped_info_hash[SHA_DIGEST_LENGTH*3 + 1];
60
61    tr_http_escape_sha1( escaped_info_hash, req->info_hash );
62
63    evbuffer_expand( buf, 1024 );
64
65    evbuffer_add_printf( buf, "%s"
66                              "%c"
67                              "info_hash=%s"
68                              "&peer_id=%*.*s"
69                              "&port=%d"
70                              "&uploaded=%" PRIu64
71                              "&downloaded=%" PRIu64
72                              "&left=%" PRIu64
73                              "&numwant=%d"
74                              "&key=%x"
75                              "&compact=1"
76                              "&supportcrypto=1",
77                              req->url,
78                              strchr( req->url, '?' ) ? '&' : '?',
79                              escaped_info_hash,
80                              PEER_ID_LEN, PEER_ID_LEN, req->peer_id,
81                              req->port,
82                              req->up,
83                              req->down,
84                              req->left,
85                              req->numwant,
86                              req->key );
87
88    if( session->encryptionMode == TR_ENCRYPTION_REQUIRED )
89        evbuffer_add_printf( buf, "&requirecrypto=1" );
90
91    if( req->corrupt )
92        evbuffer_add_printf( buf, "&corrupt=%" PRIu64, req->corrupt );
93
94    str = get_event_string( req );
95    if( str && *str )
96        evbuffer_add_printf( buf, "&event=%s", str );
97
98    str = req->tracker_id_str;
99    if( str && *str )
100        evbuffer_add_printf( buf, "&trackerid=%s", str );
101
102    /* There are two incompatible techniques for announcing an IPv6 address.
103       BEP-7 suggests adding an "ipv6=" parameter to the announce URL,
104       while OpenTracker requires that peers announce twice, once over IPv4
105       and once over IPv6.
106
107       To be safe, we should do both: add the "ipv6=" parameter and
108       announce twice. At any rate, we're already computing our IPv6
109       address (for the LTEP handshake), so this comes for free. */
110
111    ipv6 = tr_globalIPv6( );
112    if( ipv6 ) {
113        char ipv6_readable[INET6_ADDRSTRLEN];
114        evutil_inet_ntop( AF_INET6, ipv6, ipv6_readable, INET6_ADDRSTRLEN );
115        evbuffer_add_printf( buf, "&ipv6=");
116        tr_http_escape( buf, ipv6_readable, -1, true );
117    }
118
119    return buf;
120}
121
122static tr_pex*
123listToPex( tr_benc * peerList, size_t * setme_len )
124{
125    size_t i;
126    size_t n;
127    const size_t len = tr_bencListSize( peerList );
128    tr_pex * pex = tr_new0( tr_pex, len );
129
130    for( i=n=0; i<len; ++i )
131    {
132        int64_t port;
133        const char * ip;
134        tr_address addr;
135        tr_benc * peer = tr_bencListChild( peerList, i );
136
137        if( peer == NULL )
138            continue;
139        if( !tr_bencDictFindStr( peer, "ip", &ip ) )
140            continue;
141        if( !tr_address_from_string( &addr, ip ) )
142            continue;
143        if( !tr_bencDictFindInt( peer, "port", &port ) )
144            continue;
145        if( ( port < 0 ) || ( port > USHRT_MAX ) )
146            continue;
147        if( !tr_address_is_valid_for_peers( &addr, port ) )
148            continue;
149
150        pex[n].addr = addr;
151        pex[n].port = htons( (uint16_t)port );
152        ++n;
153    }
154
155    *setme_len = n;
156    return pex;
157}
158
159struct announce_data
160{
161    tr_announce_response response;
162    tr_announce_response_func * response_func;
163    void * response_func_user_data;
164    char log_name[128];
165};
166
167static void
168on_announce_done_eventthread( void * vdata )
169{
170    struct announce_data * data = vdata;
171
172    if( data->response_func != NULL )
173        data->response_func( &data->response, data->response_func_user_data );
174
175    tr_free( data->response.pex6 );
176    tr_free( data->response.pex );
177    tr_free( data->response.tracker_id_str );
178    tr_free( data->response.warning );
179    tr_free( data->response.errmsg );
180    tr_free( data );
181}
182
183
184static void
185on_announce_done( tr_session   * session,
186                  bool           did_connect,
187                  bool           did_timeout,
188                  long           response_code,
189                  const void   * msg,
190                  size_t         msglen,
191                  void         * vdata )
192{
193    tr_announce_response * response;
194    struct announce_data * data = vdata;
195
196    response = &data->response;
197    response->did_connect = did_connect;
198    response->did_timeout = did_timeout;
199    dbgmsg( data->log_name, "Got announce response" );
200
201    if( response_code != HTTP_OK )
202    {
203        const char * fmt = _( "Tracker gave HTTP response code %1$ld (%2$s)" );
204        const char * response_str = tr_webGetResponseStr( response_code );
205        response->errmsg = tr_strdup_printf( fmt, response_code, response_str );
206    }
207    else
208    {
209        tr_benc benc;
210        const int benc_loaded = !tr_bencLoad( msg, msglen, &benc, NULL );
211
212        if( getenv( "TR_CURL_VERBOSE" ) != NULL )
213        {
214            struct evbuffer * buf = tr_bencToBuf( &benc, TR_FMT_JSON );
215            fprintf( stderr, "Announce response:\n< %s\n", evbuffer_pullup( buf, -1 ) );
216            tr_free( buf );
217        }
218
219        if( benc_loaded && tr_bencIsDict( &benc ) )
220        {
221            int64_t i;
222            size_t rawlen;
223            tr_benc * tmp;
224            const char * str;
225            const uint8_t * raw;
226
227            if( tr_bencDictFindStr( &benc, "failure reason", &str ) )
228                response->errmsg = tr_strdup( str );
229
230            if( tr_bencDictFindStr( &benc, "warning message", &str ) )
231                response->warning = tr_strdup( str );
232
233            if( tr_bencDictFindInt( &benc, "interval", &i ) )
234                response->interval = i;
235
236            if( tr_bencDictFindInt( &benc, "min interval", &i ) )
237                response->min_interval = i;
238
239            if( tr_bencDictFindStr( &benc, "tracker id", &str ) )
240                response->tracker_id_str = tr_strdup( str );
241
242            if( tr_bencDictFindInt( &benc, "complete", &i ) )
243                response->seeders = i;
244
245            if( tr_bencDictFindInt( &benc, "incomplete", &i ) )
246                response->leechers = i;
247
248            if( tr_bencDictFindInt( &benc, "downloaded", &i ) )
249                response->downloads = i;
250
251            if( tr_bencDictFindRaw( &benc, "peers6", &raw, &rawlen ) ) {
252                dbgmsg( data->log_name, "got a peers6 length of %zu", rawlen );
253                response->pex6 = tr_peerMgrCompact6ToPex( raw, rawlen,
254                                              NULL, 0, &response->pex6_count );
255            }
256
257            if( tr_bencDictFindRaw( &benc, "peers", &raw, &rawlen ) ) {
258                dbgmsg( data->log_name, "got a compact peers length of %zu", rawlen );
259                response->pex = tr_peerMgrCompactToPex( raw, rawlen,
260                                               NULL, 0, &response->pex_count );
261            } else if( tr_bencDictFindList( &benc, "peers", &tmp ) ) {
262                response->pex = listToPex( tmp, &response->pex_count );
263                dbgmsg( data->log_name, "got a peers list with %zu entries",
264                        response->pex_count );
265            }
266        }
267
268        if( benc_loaded )
269            tr_bencFree( &benc );
270    }
271
272    tr_runInEventThread( session, on_announce_done_eventthread, data );
273}
274
275void
276tr_tracker_http_announce( tr_session                 * session,
277                          const tr_announce_request  * request,
278                          tr_announce_response_func    response_func,
279                          void                       * response_func_user_data )
280{
281    struct announce_data * d;
282    struct evbuffer * buf = announce_url_new( session, request );
283    const char * url = (const char *) evbuffer_pullup( buf, -1 );
284
285    d = tr_new0( struct announce_data, 1 );
286    d->response_func = response_func;
287    d->response_func_user_data = response_func_user_data;
288    memcpy( d->response.info_hash, request->info_hash, SHA_DIGEST_LENGTH );
289    tr_strlcpy( d->log_name, request->log_name, sizeof( d->log_name ) );
290
291    dbgmsg( request->log_name, "Sending announce to libcurl: \"%s\"", url );
292    tr_webRun( session, url, NULL, NULL, on_announce_done, d );
293
294    evbuffer_free( buf );
295}
296
297/****
298*****
299*****  SCRAPE
300*****
301****/
302
303struct scrape_data
304{
305    tr_scrape_response response;
306    tr_scrape_response_func * response_func;
307    void * response_func_user_data;
308    char log_name[128];
309};
310
311static void
312on_scrape_done_eventthread( void * vdata )
313{
314    struct scrape_data * data = vdata;
315
316    if( data->response_func != NULL )
317        data->response_func( &data->response, data->response_func_user_data );
318
319    tr_free( data->response.errmsg );
320    tr_free( data->response.url );
321    tr_free( data );
322}
323
324static void
325on_scrape_done( tr_session   * session,
326                bool           did_connect,
327                bool           did_timeout,
328                long           response_code,
329                const void   * msg,
330                size_t         msglen,
331                void         * vdata )
332{
333    tr_scrape_response * response;
334    struct scrape_data * data = vdata;
335
336    response = &data->response;
337    response->did_connect = did_connect;
338    response->did_timeout = did_timeout;
339    dbgmsg( data->log_name, "Got scrape response for \"%s\"", response->url );
340
341    if( response_code != HTTP_OK )
342    {
343        const char * fmt = _( "Tracker gave HTTP response code %1$ld (%2$s)" );
344        const char * response_str = tr_webGetResponseStr( response_code );
345        response->errmsg = tr_strdup_printf( fmt, response_code, response_str );
346    }
347    else
348    {
349        tr_benc top;
350        int64_t intVal;
351        tr_benc * files;
352        const char * str;
353        const int benc_loaded = !tr_bencLoad( msg, msglen, &top, NULL );
354        if( benc_loaded )
355        {
356            if( tr_bencDictFindStr( &top, "failure reason", &str ) )
357                response->errmsg = tr_strdup( str );
358
359            if( tr_bencDictFindInt( &top, "min_request_interval", &intVal ) )
360                response->min_request_interval = intVal;
361
362            if( tr_bencDictFindDict( &top, "files", &files ) )
363            {
364                int i = 0;
365
366                for( ;; )
367                {
368                    int j;
369                    tr_benc * val;
370                    const char * key;
371
372                    /* get the next "file" */
373                    if( !tr_bencDictChild( files, i++, &key, &val ) )
374                        break;
375
376                    /* populate the corresponding row in our response array */
377                    for( j=0; j<response->row_count; ++j )
378                    {
379                        struct tr_scrape_response_row * row = &response->rows[j];
380                        if( !memcmp( key, row->info_hash, SHA_DIGEST_LENGTH ) )
381                        {
382                            if( tr_bencDictFindInt( val, "complete", &intVal ) )
383                                row->seeders = intVal;
384                            if( tr_bencDictFindInt( val, "incomplete", &intVal ) )
385                                row->leechers = intVal;
386                            if( tr_bencDictFindInt( val, "downloaded", &intVal ) )
387                                row->downloads = intVal;
388                            if( tr_bencDictFindInt( val, "downloaders", &intVal ) )
389                                row->downloaders = intVal;
390                            break;
391                        }
392                    }
393                }
394            }
395
396            tr_bencFree( &top );
397        }
398    }
399
400    tr_runInEventThread( session, on_scrape_done_eventthread, data );
401}
402
403static struct evbuffer *
404scrape_url_new( const tr_scrape_request * req )
405{
406    int i;
407    char delimiter;
408    struct evbuffer * buf = evbuffer_new( );
409
410    evbuffer_add_printf( buf, "%s", req->url );
411    delimiter = strchr( req->url, '?' ) ? '&' : '?';
412    for( i=0; i<req->info_hash_count; ++i )
413    {
414        char str[SHA_DIGEST_LENGTH*3 + 1];
415        tr_http_escape_sha1( str, req->info_hash[i] );
416        evbuffer_add_printf( buf, "%cinfo_hash=%s", delimiter, str );
417        delimiter = '&';
418    }
419
420    return buf;
421}
422
423void
424tr_tracker_http_scrape( tr_session               * session,
425                        const tr_scrape_request  * request,
426                        tr_scrape_response_func    response_func,
427                        void                     * response_func_user_data )
428{
429    int i;
430    struct scrape_data * d;
431    struct evbuffer * buf = scrape_url_new( request );
432    const char * url = (const char *) evbuffer_pullup( buf, -1 );
433
434    d = tr_new0( struct scrape_data, 1 );
435    d->response.url = tr_strdup( request->url );
436    d->response_func = response_func;
437    d->response_func_user_data = response_func_user_data;
438    d->response.row_count = request->info_hash_count;
439    for( i=0; i<d->response.row_count; ++i )
440        memcpy( d->response.rows[i].info_hash, request->info_hash[i], SHA_DIGEST_LENGTH );
441    tr_strlcpy( d->log_name, request->log_name, sizeof( d->log_name ) );
442
443    dbgmsg( request->log_name, "Sending scrape to libcurl: \"%s\"", url );
444    tr_webRun( session, url, NULL, NULL, on_scrape_done, d );
445
446    evbuffer_free( buf );
447}
Note: See TracBrowser for help on using the repository browser.