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

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

(trunk) #4138 "use stdbool.h instead of tr_bool" -- done.

  • Property svn:keywords set to Date Rev Author Id
File size: 14.4 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 12204 2011-03-22 15:19:54Z 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 char*
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 evbuffer_free_to_str( 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_pton( ip, &addr ) == NULL )
142            continue;
143        if( !tr_bencDictFindInt( peer, "port", &port ) )
144            continue;
145        if( ( port < 0 ) || ( port > USHRT_MAX ) )
146            continue;
147        if( !tr_isValidPeerAddress( &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_session * session;
162    tr_announce_response response;
163    tr_announce_response_func * response_func;
164    void * response_func_user_data;
165    char log_name[128];
166};
167
168static void
169on_announce_done_eventthread( void * vdata )
170{
171    struct announce_data * data = vdata;
172
173    if( data->response_func != NULL )
174        data->response_func( data->session,
175                             &data->response,
176                             data->response_func_user_data );
177
178    tr_free( data->response.pex6 );
179    tr_free( data->response.pex );
180    tr_free( data->response.tracker_id_str );
181    tr_free( data->response.warning );
182    tr_free( data->response.errmsg );
183    tr_free( data );
184}
185
186
187static void
188on_announce_done( tr_session   * session,
189                  bool           did_connect,
190                  bool           did_timeout,
191                  long           response_code,
192                  const void   * msg,
193                  size_t         msglen,
194                  void         * vdata )
195{
196    tr_announce_response * response;
197    struct announce_data * data = vdata;
198
199    response = &data->response;
200    response->did_connect = did_connect;
201    response->did_timeout = did_timeout;
202    dbgmsg( data->log_name, "Got announce response" );
203
204    if( response_code != HTTP_OK )
205    {
206        const char * fmt = _( "Tracker gave HTTP response code %1$ld (%2$s)" );
207        const char * response_str = tr_webGetResponseStr( response_code );
208        response->errmsg = tr_strdup_printf( fmt, response_code, response_str );
209    }
210    else
211    {
212        tr_benc benc;
213        const int benc_loaded = !tr_bencLoad( msg, msglen, &benc, NULL );
214
215        if( getenv( "TR_CURL_VERBOSE" ) != NULL )
216        {
217            char * str = tr_bencToStr( &benc, TR_FMT_JSON, NULL );
218            fprintf( stderr, "Announce response:\n< %s\n", str );
219            tr_free( str );
220        }
221
222        if( benc_loaded && tr_bencIsDict( &benc ) )
223        {
224            int64_t i;
225            size_t rawlen;
226            tr_benc * tmp;
227            const char * str;
228            const uint8_t * raw;
229
230            if( tr_bencDictFindStr( &benc, "failure reason", &str ) )
231                response->errmsg = tr_strdup( str );
232
233            if( tr_bencDictFindStr( &benc, "warning message", &str ) )
234                response->warning = tr_strdup( str );
235
236            if( tr_bencDictFindInt( &benc, "interval", &i ) )
237                response->interval = i;
238
239            if( tr_bencDictFindInt( &benc, "min interval", &i ) )
240                response->min_interval = i;
241
242            if( tr_bencDictFindStr( &benc, "tracker id", &str ) )
243                response->tracker_id_str = tr_strdup( str );
244
245            if( tr_bencDictFindInt( &benc, "complete", &i ) )
246                response->seeders = i;
247
248            if( tr_bencDictFindInt( &benc, "incomplete", &i ) )
249                response->leechers = i;
250
251            if( tr_bencDictFindInt( &benc, "downloaded", &i ) )
252                response->downloads = i;
253
254            if( tr_bencDictFindRaw( &benc, "peers6", &raw, &rawlen ) ) {
255                dbgmsg( data->log_name, "got a peers6 length of %zu", rawlen );
256                response->pex6 = tr_peerMgrCompact6ToPex( raw, rawlen,
257                                              NULL, 0, &response->pex6_count );
258            }
259
260            if( tr_bencDictFindRaw( &benc, "peers", &raw, &rawlen ) ) {
261                dbgmsg( data->log_name, "got a compact peers length of %zu", rawlen );
262                response->pex = tr_peerMgrCompactToPex( raw, rawlen,
263                                               NULL, 0, &response->pex_count );
264            } else if( tr_bencDictFindList( &benc, "peers", &tmp ) ) {
265                response->pex = listToPex( tmp, &response->pex_count );
266                dbgmsg( data->log_name, "got a peers list with %zu entries",
267                        response->pex_count );
268            }
269        }
270
271        if( benc_loaded )
272            tr_bencFree( &benc );
273    }
274
275    tr_runInEventThread( session, on_announce_done_eventthread, data );
276}
277
278void
279tr_tracker_http_announce( tr_session                 * session,
280                          const tr_announce_request  * request,
281                          tr_announce_response_func    response_func,
282                          void                       * response_func_user_data )
283{
284    struct announce_data * d;
285    char * url = announce_url_new( session, request );
286
287    d = tr_new0( struct announce_data, 1 );
288    d->session = session;
289    d->response_func = response_func;
290    d->response_func_user_data = response_func_user_data;
291    memcpy( d->response.info_hash, request->info_hash, SHA_DIGEST_LENGTH );
292    tr_strlcpy( d->log_name, request->log_name, sizeof( d->log_name ) );
293
294    dbgmsg( request->log_name, "Sending announce to libcurl: \"%s\"", url );
295    tr_webRun( session, url, NULL, NULL, on_announce_done, d );
296    tr_free( url );
297}
298
299/****
300*****
301*****  SCRAPE
302*****
303****/
304
305struct scrape_data
306{
307    tr_session * session;
308    tr_scrape_response response;
309    tr_scrape_response_func * response_func;
310    void * response_func_user_data;
311    char log_name[128];
312};
313
314static void
315on_scrape_done_eventthread( void * vdata )
316{
317    struct scrape_data * data = vdata;
318
319    if( data->response_func != NULL )
320        data->response_func( data->session,
321                             &data->response,
322                             data->response_func_user_data );
323
324    tr_free( data->response.errmsg );
325    tr_free( data->response.url );
326    tr_free( data );
327}
328
329static void
330on_scrape_done( tr_session   * session,
331                bool           did_connect,
332                bool           did_timeout,
333                long           response_code,
334                const void   * msg,
335                size_t         msglen,
336                void         * vdata )
337{
338    tr_scrape_response * response;
339    struct scrape_data * data = vdata;
340
341    response = &data->response;
342    response->did_connect = did_connect;
343    response->did_timeout = did_timeout;
344    dbgmsg( data->log_name, "Got scrape response for \"%s\"", response->url );
345
346    if( response_code != HTTP_OK )
347    {
348        const char * fmt = _( "Tracker gave HTTP response code %1$ld (%2$s)" );
349        const char * response_str = tr_webGetResponseStr( response_code );
350        response->errmsg = tr_strdup_printf( fmt, response_code, response_str );
351    }
352    else
353    {
354        tr_benc top;
355        int64_t intVal;
356        tr_benc * files;
357        const char * str;
358        const int benc_loaded = !tr_bencLoad( msg, msglen, &top, NULL );
359        if( benc_loaded )
360        {
361            if( tr_bencDictFindStr( &top, "failure reason", &str ) )
362                response->errmsg = tr_strdup( str );
363
364            if( tr_bencDictFindInt( &top, "min_request_interval", &intVal ) )
365                response->min_request_interval = intVal;
366
367            if( tr_bencDictFindDict( &top, "files", &files ) )
368            {
369                int i = 0;
370
371                for( ;; )
372                {
373                    int j;
374                    tr_benc * val;
375                    const char * key;
376
377                    /* get the next "file" */
378                    if( !tr_bencDictChild( files, i++, &key, &val ) )
379                        break;
380
381                    /* populate the corresponding row in our response array */
382                    for( j=0; j<response->row_count; ++j )
383                    {
384                        struct tr_scrape_response_row * row = &response->rows[j];
385                        if( !memcmp( key, row->info_hash, SHA_DIGEST_LENGTH ) )
386                        {
387                            if( tr_bencDictFindInt( val, "complete", &intVal ) )
388                                row->seeders = intVal;
389                            if( tr_bencDictFindInt( val, "incomplete", &intVal ) )
390                                row->leechers = intVal;
391                            if( tr_bencDictFindInt( val, "downloaded", &intVal ) )
392                                row->downloads = intVal;
393                            if( tr_bencDictFindInt( val, "downloaders", &intVal ) )
394                                row->downloaders = intVal;
395                            break;
396                        }
397                    }
398                }
399            }
400
401            tr_bencFree( &top );
402        }
403    }
404
405    tr_runInEventThread( session, on_scrape_done_eventthread, data );
406}
407
408static char*
409scrape_url_new( const tr_scrape_request * req )
410{
411    int i;
412    char delimiter;
413    struct evbuffer * buf = evbuffer_new( );
414
415    evbuffer_add_printf( buf, "%s", req->url );
416    delimiter = strchr( req->url, '?' ) ? '&' : '?';
417    for( i=0; i<req->info_hash_count; ++i )
418    {
419        char str[SHA_DIGEST_LENGTH*3 + 1];
420        tr_http_escape_sha1( str, req->info_hash[i] );
421        evbuffer_add_printf( buf, "%cinfo_hash=%s", delimiter, str );
422        delimiter = '&';
423    }
424
425    return evbuffer_free_to_str( buf );
426}
427
428void
429tr_tracker_http_scrape( tr_session               * session,
430                        const tr_scrape_request  * request,
431                        tr_scrape_response_func    response_func,
432                        void                     * response_func_user_data )
433{
434    int i;
435    struct scrape_data * d;
436    char * url = scrape_url_new( request );
437
438    d = tr_new0( struct scrape_data, 1 );
439    d->session = session;
440    d->response.url = tr_strdup( request->url );
441    d->response_func = response_func;
442    d->response_func_user_data = response_func_user_data;
443    d->response.row_count = request->info_hash_count;
444    for( i=0; i<d->response.row_count; ++i )
445        memcpy( d->response.rows[i].info_hash, request->info_hash[i], SHA_DIGEST_LENGTH );
446    tr_strlcpy( d->log_name, request->log_name, sizeof( d->log_name ) );
447
448    dbgmsg( request->log_name, "Sending scrape to libcurl: \"%s\"", url );
449    tr_webRun( session, url, NULL, NULL, on_scrape_done, d );
450    tr_free( url );
451}
Note: See TracBrowser for help on using the repository browser.