source: trunk/libtransmission/metainfo.c @ 5112

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

added tr_sha1_to_hex()

  • Property svn:keywords set to Date Rev Author Id
File size: 20.2 KB
Line 
1/******************************************************************************
2 * $Id: metainfo.c 5112 2008-02-25 20:21:22Z charles $
3 *
4 * Copyright (c) 2005-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#include <assert.h>
26#include <ctype.h> /* isspace */
27#include <errno.h>
28#include <stdio.h>
29#include <stdlib.h>
30
31#include <sys/types.h>
32#include <sys/stat.h>
33#include <unistd.h> /* unlink, stat */
34
35#include <miniupnp/miniwget.h> /* parseURL */
36
37#include "transmission.h"
38#include "bencode.h"
39#include "crypto.h" /* tr_sha1 */
40#include "metainfo.h"
41#include "platform.h"
42#include "trcompat.h" /* strlcpy */
43#include "utils.h"
44
45
46static int
47tr_httpParseUrl( const char * url_in, int len,
48                 char ** setme_host, int * setme_port, char ** setme_path )
49{
50    char * url = tr_strndup( url_in, len );
51    char * path;
52    char host[4096+1];
53    unsigned short port;
54    int success;
55
56    success = parseURL( url, host, &port, &path );
57
58    if( success ) {
59        *setme_host = tr_strdup( host );
60        *setme_port = port;
61        *setme_path = tr_strdup( path );
62    }
63
64    tr_free( url );
65
66    return !success;
67}
68
69/***********************************************************************
70 * Local prototypes
71 **********************************************************************/
72static int getannounce( tr_info * inf, benc_val_t * meta );
73static char * announceToScrape( const char * announce );
74static int parseFiles( tr_info * inf, benc_val_t * name,
75                       benc_val_t * files, benc_val_t * length );
76
77/***
78****
79***/
80
81#define WANTBYTES( want, got ) \
82    if( (want) > (got) ) { return; } else { (got) -= (want); }
83static void
84strlcat_utf8( void * dest, const void * src, size_t len, char skip )
85{
86    char       * s      = dest;
87    const char * append = src;
88    const char * p;
89
90    /* don't overwrite the nul at the end */
91    len--;
92
93    /* Go to the end of the destination string */
94    while( s[0] )
95    {
96        s++;
97        len--;
98    }
99
100    /* Now start appending, converting on the fly if necessary */
101    for( p = append; p[0]; )
102    {
103        /* skip over the requested character */
104        if( skip == p[0] )
105        {
106            p++;
107            continue;
108        }
109
110        if( !( p[0] & 0x80 ) )
111        {
112            /* ASCII character */
113            WANTBYTES( 1, len );
114            *(s++) = *(p++);
115            continue;
116        }
117
118        if( ( p[0] & 0xE0 ) == 0xC0 && ( p[1] & 0xC0 ) == 0x80 )
119        {
120            /* 2-bytes UTF-8 character */
121            WANTBYTES( 2, len );
122            *(s++) = *(p++); *(s++) = *(p++);
123            continue;
124        }
125
126        if( ( p[0] & 0xF0 ) == 0xE0 && ( p[1] & 0xC0 ) == 0x80 &&
127            ( p[2] & 0xC0 ) == 0x80 )
128        {
129            /* 3-bytes UTF-8 character */
130            WANTBYTES( 3, len );
131            *(s++) = *(p++); *(s++) = *(p++);
132            *(s++) = *(p++);
133            continue;
134        }
135
136        if( ( p[0] & 0xF8 ) == 0xF0 && ( p[1] & 0xC0 ) == 0x80 &&
137            ( p[2] & 0xC0 ) == 0x80 && ( p[3] & 0xC0 ) == 0x80 )
138        {
139            /* 4-bytes UTF-8 character */
140            WANTBYTES( 4, len );
141            *(s++) = *(p++); *(s++) = *(p++);
142            *(s++) = *(p++); *(s++) = *(p++);
143            continue;
144        }
145
146        /* ISO 8859-1 -> UTF-8 conversion */
147        WANTBYTES( 2, len );
148        *(s++) = 0xC0 | ( ( *p & 0xFF ) >> 6 );
149        *(s++) = 0x80 | ( *(p++) & 0x3F );
150    }
151}
152
153static void
154savedname( char * name, size_t len, const char * hash, const char * tag )
155{
156    const char * torDir = tr_getTorrentsDirectory ();
157
158    if( tag == NULL )
159    {
160        tr_buildPath( name, len, torDir, hash, NULL );
161    }
162    else
163    {
164        char base[1024];
165        snprintf( base, sizeof(base), "%s-%s", hash, tag );
166        tr_buildPath( name, len, torDir, base, NULL );
167    }
168}
169
170
171int
172tr_metainfoParse( tr_info * inf, const benc_val_t * meta_in, const char * tag )
173{
174    int i;
175    benc_val_t * beInfo, * val, * val2;
176    benc_val_t * meta = (benc_val_t *) meta_in;
177    char buf[4096];
178
179    /* info_hash: urlencoded 20-byte SHA1 hash of the value of the info key
180     * from the Metainfo file. Note that the value will be a bencoded
181     * dictionary, given the definition of the info key above. */
182    if(( beInfo = tr_bencDictFindType( meta, "info", TYPE_DICT )))
183    {
184        int len;
185        char * str = tr_bencSave( beInfo, &len );
186        tr_sha1( inf->hash, str, len, NULL );
187        tr_free( str );
188    }
189    else
190    {
191        tr_err( "info dictionary not found!" );
192        return TR_EINVALID;
193    }
194
195    tr_sha1_to_hex( inf->hashString, inf->hash );
196    savedname( inf->torrent, sizeof( inf->torrent ), inf->hashString, tag );
197
198    /* comment */
199    memset( buf, '\0', sizeof( buf ) );
200    val = tr_bencDictFindFirst( meta, "comment.utf-8", "comment", NULL );
201    if( val && val->type == TYPE_STR )
202        strlcat_utf8( buf, val->val.s.s, sizeof( buf ), 0 );
203    tr_free( inf->comment );
204    inf->comment = tr_strdup( buf );
205   
206    /* creator */
207    memset( buf, '\0', sizeof( buf ) );
208    val = tr_bencDictFindFirst( meta, "created by.utf-8", "created by", NULL );
209    if( val && val->type == TYPE_STR )
210        strlcat_utf8( buf, val->val.s.s, sizeof( buf ), 0 );
211    tr_free( inf->creator );
212    inf->creator = tr_strdup( buf );
213   
214    /* Date created */
215    inf->dateCreated = 0;
216    val = tr_bencDictFind( meta, "creation date" );
217    if( NULL != val && TYPE_INT == val->type )
218    {
219        inf->dateCreated = val->val.i;
220    }
221   
222    /* Private torrent */
223    val  = tr_bencDictFind( beInfo, "private" );
224    val2 = tr_bencDictFind( meta,  "private" );
225    if( ( NULL != val  && ( TYPE_INT != val->type  || 0 != val->val.i ) ) ||
226        ( NULL != val2 && ( TYPE_INT != val2->type || 0 != val2->val.i ) ) )
227    {
228        inf->isPrivate = 1;
229    }
230   
231    /* Piece length */
232    val = tr_bencDictFind( beInfo, "piece length" );
233    if( NULL == val || TYPE_INT != val->type )
234    {
235        tr_err( "%s \"piece length\" entry", ( val ? "Invalid" : "Missing" ) );
236        goto fail;
237    }
238    inf->pieceSize = val->val.i;
239
240    /* Hashes */
241    val = tr_bencDictFind( beInfo, "pieces" );
242    if( NULL == val || TYPE_STR != val->type )
243    {
244        tr_err( "%s \"pieces\" entry", ( val ? "Invalid" : "Missing" ) );
245        goto fail;
246    }
247    if( val->val.s.i % SHA_DIGEST_LENGTH )
248    {
249        tr_err( "Invalid \"piece\" string (size is %d)", val->val.s.i );
250        goto fail;
251    }
252    inf->pieceCount = val->val.s.i / SHA_DIGEST_LENGTH;
253
254    inf->pieces = calloc ( inf->pieceCount, sizeof(tr_piece) );
255
256    for ( i=0; i<inf->pieceCount; ++i )
257    {
258        memcpy (inf->pieces[i].hash, &val->val.s.s[i*SHA_DIGEST_LENGTH], SHA_DIGEST_LENGTH);
259    }
260
261    /* get file or top directory name */
262    val = tr_bencDictFindFirst( beInfo, "name.utf-8", "name", NULL );
263    if( parseFiles( inf, tr_bencDictFindFirst( beInfo,
264                                               "name.utf-8", "name", NULL ),
265                    tr_bencDictFind( beInfo, "files" ),
266                    tr_bencDictFind( beInfo, "length" ) ) )
267    {
268        goto fail;
269    }
270
271    if( !inf->fileCount )
272    {
273        tr_err( "Torrent has no files." );
274        goto fail;
275    }
276
277    if( !inf->totalSize )
278    {
279        tr_err( "Torrent is zero bytes long." );
280        goto fail;
281    }
282
283    /* TODO add more tests so we don't crash on weird files */
284
285    if( (uint64_t) inf->pieceCount !=
286        ( inf->totalSize + inf->pieceSize - 1 ) / inf->pieceSize )
287    {
288        tr_err( "Size of hashes and files don't match" );
289        goto fail;
290    }
291
292    /* get announce or announce-list */
293    if( getannounce( inf, meta ) )
294    {
295        goto fail;
296    }
297
298    return TR_OK;
299
300  fail:
301    tr_metainfoFree( inf );
302    return TR_EINVALID;
303}
304
305void tr_metainfoFree( tr_info * inf )
306{
307    int i, j;
308
309    for( i=0; i<inf->fileCount; ++i )
310        tr_free( inf->files[i].name );
311
312    tr_free( inf->pieces );
313    tr_free( inf->files );
314    tr_free( inf->comment );
315    tr_free( inf->creator );
316    tr_free( inf->primaryAddress );
317   
318    for( i=0; i<inf->trackerTiers; ++i ) {
319        for( j=0; j<inf->trackerList[i].count; ++j )
320            tr_trackerInfoClear( &inf->trackerList[i].list[j] );
321        tr_free( inf->trackerList[i].list );
322    }
323    tr_free( inf->trackerList );
324
325    memset( inf, '\0', sizeof(tr_info) );
326}
327
328static int getfile( char ** setme,
329                    const char * prefix, benc_val_t * name )
330{
331    benc_val_t  * dir;
332    const char ** list;
333    int           ii, jj;
334    char          buf[4096];
335
336    if( TYPE_LIST != name->type )
337    {
338        return TR_EINVALID;
339    }
340
341    list = calloc( name->val.l.count, sizeof( list[0] ) );
342    if( NULL == list )
343    {
344        return TR_EINVALID;
345    }
346
347    for( ii = jj = 0; name->val.l.count > ii; ii++ )
348    {
349        dir = &name->val.l.vals[ii];
350        if( TYPE_STR != dir->type )
351        {
352            continue;
353        }
354        if( 0 == strcmp( "..", dir->val.s.s ) )
355        {
356            if( 0 < jj )
357            {
358                jj--;
359            }
360        }
361        else if( 0 != strcmp( ".", dir->val.s.s ) )
362        {
363            list[jj] = dir->val.s.s;
364            jj++;
365        }
366    }
367
368    if( 0 == jj )
369    {
370        free( list );
371        return TR_EINVALID;
372    }
373
374    memset( buf, 0, sizeof( buf ) );
375    strlcat_utf8( buf, prefix, sizeof(buf), 0 );
376    for( ii = 0; jj > ii; ii++ )
377    {
378        strlcat_utf8( buf, TR_PATH_DELIMITER_STR, sizeof(buf), 0 );
379        strlcat_utf8( buf, list[ii], sizeof(buf), TR_PATH_DELIMITER );
380    }
381    free( list );
382
383    tr_free( *setme );
384    *setme = tr_strdup( buf );
385
386    return TR_OK;
387}
388
389static int getannounce( tr_info * inf, benc_val_t * meta )
390{
391    benc_val_t        * val, * subval, * urlval;
392    char              * address, * announce;
393    int                 ii, jj, port, random, subcount;
394    tr_tracker_info   * sublist;
395    void * swapping;
396
397    /* Announce-list */
398    val = tr_bencDictFind( meta, "announce-list" );
399    if( NULL != val && TYPE_LIST == val->type && 0 < val->val.l.count )
400    {
401        inf->trackerTiers = 0;
402        inf->trackerList = calloc( val->val.l.count,
403                                   sizeof( inf->trackerList[0] ) );
404
405        /* iterate through the announce-list's tiers */
406        for( ii = 0; ii < val->val.l.count; ii++ )
407        {
408            subval = &val->val.l.vals[ii];
409            if( TYPE_LIST != subval->type || 0 >= subval->val.l.count )
410            {
411                continue;
412            }
413            subcount = 0;
414            sublist = calloc( subval->val.l.count, sizeof( sublist[0] ) );
415
416            /* iterate through the tier's items */
417            for( jj = 0; jj < subval->val.l.count; jj++ )
418            {
419                tr_tracker_info tmp;
420
421                urlval = &subval->val.l.vals[jj];
422                if( TYPE_STR != urlval->type ||
423                    tr_trackerInfoInit( &tmp, urlval->val.s.s, urlval->val.s.i ) )
424                {
425                    continue;
426                }
427
428                if( !inf->primaryAddress ) {
429                     char buf[1024];
430                     snprintf( buf, sizeof(buf), "%s:%d", tmp.address, tmp.port );
431                     inf->primaryAddress = tr_strdup( buf );
432                }
433
434                /* place the item info in a random location in the sublist */
435                random = tr_rand( subcount + 1 );
436                if( random != subcount )
437                    sublist[subcount] = sublist[random];
438                sublist[random] = tmp;
439                subcount++;
440            }
441
442            /* just use sublist as-is if it's full */
443            if( subcount == subval->val.l.count )
444            {
445                inf->trackerList[inf->trackerTiers].list = sublist;
446                inf->trackerList[inf->trackerTiers].count = subcount;
447                inf->trackerTiers++;
448            }
449            /* if we skipped some of the tier's items then trim the sublist */
450            else if( 0 < subcount )
451            {
452                inf->trackerList[inf->trackerTiers].list = calloc( subcount, sizeof( sublist[0] ) );
453                memcpy( inf->trackerList[inf->trackerTiers].list, sublist,
454                        sizeof( sublist[0] ) * subcount );
455                inf->trackerList[inf->trackerTiers].count = subcount;
456                inf->trackerTiers++;
457                free( sublist );
458            }
459            /* drop the whole sublist if we didn't use any items at all */
460            else
461            {
462                free( sublist );
463            }
464        }
465
466        /* did we use any of the tiers? */
467        if( 0 == inf->trackerTiers )
468        {
469            tr_inf( "No valid entries in \"announce-list\"" );
470            free( inf->trackerList );
471            inf->trackerList = NULL;
472        }
473        /* trim unused sublist pointers */
474        else if( inf->trackerTiers < val->val.l.count )
475        {
476            swapping = inf->trackerList;
477            inf->trackerList = calloc( inf->trackerTiers,
478                                       sizeof( inf->trackerList[0] ) );
479            memcpy( inf->trackerList, swapping,
480                    sizeof( inf->trackerList[0] ) * inf->trackerTiers );
481            free( swapping );
482        }
483    }
484
485    /* Regular announce value */
486    val = tr_bencDictFind( meta, "announce" );
487    if( NULL == val || TYPE_STR != val->type )
488    {
489        tr_err( "No \"announce\" entry" );
490        return TR_EINVALID;
491    }
492
493    if( !inf->trackerTiers )
494    {
495        char buf[4096], *pch;
496        strlcpy( buf, val->val.s.s, sizeof( buf ) );
497        pch = buf;
498        while( isspace( *pch ) )
499            ++pch;
500
501        if( tr_httpParseUrl( pch, -1, &address, &port, &announce ) )
502        {
503            tr_err( "Invalid announce URL (%s)", val->val.s.s );
504            return TR_EINVALID;
505        }
506        sublist                   = calloc( 1, sizeof( sublist[0] ) );
507        sublist[0].address        = address;
508        sublist[0].port           = port;
509        sublist[0].announce       = announce;
510        sublist[0].scrape         = announceToScrape( announce );
511        inf->trackerList          = calloc( 1, sizeof( inf->trackerList[0] ) );
512        inf->trackerList[0].list  = sublist;
513        inf->trackerList[0].count = 1;
514        inf->trackerTiers         = 1;
515
516        if( !inf->primaryAddress ) {
517            char buf[1024];
518            snprintf( buf, sizeof(buf), "%s:%d", sublist[0].address, sublist[0].port );
519            inf->primaryAddress = tr_strdup( buf );
520        }
521
522    }
523
524    return TR_OK;
525}
526
527static char * announceToScrape( const char * announce )
528{
529    char old[]  = "announce";
530    int  oldlen = 8;
531    char new[]  = "scrape";
532    int  newlen = 6;
533    char * slash, * scrape;
534    size_t scrapelen, used;
535
536    slash = strrchr( announce, '/' );
537    if( NULL == slash )
538    {
539        return NULL;
540    }
541    slash++;
542   
543    if( 0 != strncmp( slash, old, oldlen ) )
544    {
545        return NULL;
546    }
547
548    scrapelen = strlen( announce ) - oldlen + newlen;
549    scrape = calloc( scrapelen + 1, 1 );
550    if( NULL == scrape )
551    {
552        return NULL;
553    }
554    assert( ( size_t )( slash - announce ) < scrapelen );
555    memcpy( scrape, announce, slash - announce );
556    used = slash - announce;
557    strncat( scrape, new, scrapelen - used );
558    used += newlen;
559    assert( strlen( scrape ) == used );
560    if( used < scrapelen )
561    {
562        assert( strlen( slash + oldlen ) == scrapelen - used );
563        strncat( scrape, slash + oldlen, scrapelen - used );
564    }
565
566    return scrape;
567}
568
569int
570tr_trackerInfoInit( tr_tracker_info  * info,
571                    const char       * address,
572                    int                address_len )
573{
574    int ret = tr_httpParseUrl( address, address_len,
575                               &info->address,
576                               &info->port,
577                               &info->announce );
578    if( !ret )
579        info->scrape = announceToScrape( info->announce );
580
581    return ret;
582}
583
584void
585tr_trackerInfoClear( tr_tracker_info * info )
586{
587    tr_free( info->address );
588    tr_free( info->announce );
589    tr_free( info->scrape );
590    memset( info, '\0', sizeof(tr_tracker_info) );
591}
592
593void
594tr_metainfoRemoveSaved( const char * hashString, const char * tag )
595{
596    char file[MAX_PATH_LENGTH];
597    savedname( file, sizeof file, hashString, tag );
598    unlink( file );
599}
600
601/* Save a copy of the torrent file in the saved torrent directory */
602int
603tr_metainfoSave( const char * hash, const char * tag,
604                 const uint8_t * buf, size_t buflen )
605{
606    char   path[MAX_PATH_LENGTH];
607    FILE * file;
608
609    savedname( path, sizeof path, hash, tag );
610    file = fopen( path, "wb+" );
611    if( !file )
612    {
613        tr_err( "Could not open file (%s) (%s)", path, tr_strerror( errno ) );
614        return TR_EINVALID;
615    }
616    fseek( file, 0, SEEK_SET );
617    if( fwrite( buf, 1, buflen, file ) != buflen )
618    {
619        tr_err( "Could not write file (%s) (%s)", path, tr_strerror( errno ) );
620        fclose( file );
621        return TR_EINVALID;
622    }
623    fclose( file );
624
625    return TR_OK;
626}
627
628static int
629parseFiles( tr_info * inf, benc_val_t * name,
630            benc_val_t * files, benc_val_t * length )
631{
632    benc_val_t * item, * path;
633    int ii;
634
635    if( NULL == name || TYPE_STR != name->type )
636    {
637        tr_err( "%s \"name\" string", ( name ? "Invalid" : "Missing" ) );
638        return TR_EINVALID;
639    }
640
641    strlcat_utf8( inf->name, name->val.s.s, sizeof( inf->name ),
642                  TR_PATH_DELIMITER );
643    if( '\0' == inf->name[0] )
644    {
645        tr_err( "Invalid \"name\" string" );
646        return TR_EINVALID;
647    }
648    inf->totalSize = 0;
649
650    if( files && TYPE_LIST == files->type )
651    {
652        /* Multi-file mode */
653        inf->isMultifile = 1;
654        inf->fileCount = files->val.l.count;
655        inf->files     = calloc( inf->fileCount, sizeof( inf->files[0] ) );
656
657        if( !inf->files )
658            return TR_EINVALID;
659
660        for( ii = 0; files->val.l.count > ii; ii++ )
661        {
662            item = &files->val.l.vals[ii];
663            path = tr_bencDictFindFirst( item, "path.utf-8", "path", NULL );
664            if( getfile( &inf->files[ii].name, inf->name, path ) )
665            {
666                tr_err( "%s \"path\" entry",
667                        ( path ? "Invalid" : "Missing" ) );
668                return TR_EINVALID;
669            }
670            length = tr_bencDictFind( item, "length" );
671            if( NULL == length || TYPE_INT != length->type )
672            {
673                tr_err( "%s \"length\" entry",
674                        ( length ? "Invalid" : "Missing" ) );
675                return TR_EINVALID;
676            }
677            inf->files[ii].length = length->val.i;
678            inf->totalSize         += length->val.i;
679        }
680    }
681    else if( NULL != length && TYPE_INT == length->type )
682    {
683        char buf[4096];
684
685        /* Single-file mode */
686        inf->isMultifile = 0;
687        inf->fileCount = 1;
688        inf->files     = calloc( 1, sizeof( inf->files[0] ) );
689
690        if( !inf->files )
691            return TR_EINVALID;
692
693        memset( buf, 0, sizeof( buf ) );
694        strlcat_utf8( buf, name->val.s.s, sizeof(buf), TR_PATH_DELIMITER );
695        tr_free( inf->files[0].name );
696        inf->files[0].name = tr_strdup( buf );
697
698        inf->files[0].length = length->val.i;
699        inf->totalSize      += length->val.i;
700    }
701    else
702    {
703        tr_err( "%s \"files\" entry and %s \"length\" entry",
704                ( files ? "Invalid" : "Missing" ),
705                ( length ? "invalid" : "missing" ) );
706    }
707
708    return TR_OK;
709}
Note: See TracBrowser for help on using the repository browser.