source: trunk/libtransmission/metainfo.c @ 5963

Last change on this file since 5963 was 5963, checked in by charles, 13 years ago
  • When loading a torrent, warn if no announce URLs are found.
  • When possible, use the torrent name in metainfo warning messages.
  • Property svn:keywords set to Date Rev Author Id
File size: 17.8 KB
Line 
1/******************************************************************************
2 * $Id: metainfo.c 5963 2008-05-29 00:38:31Z 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 <event.h> /* struct evbuffer */
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 "utils.h"
43
44/***********************************************************************
45 * Local prototypes
46 **********************************************************************/
47static int parseFiles( tr_info * inf, tr_benc * name,
48                       tr_benc * files, tr_benc * length );
49
50/***
51****
52***/
53
54#define WANTBYTES( want, got ) \
55    if( (want) > (got) ) { return; } else { (got) -= (want); }
56static void
57strlcat_utf8( void * dest, const void * src, size_t len, char skip )
58{
59    char       * s      = dest;
60    const char * append = src;
61    const char * p;
62
63    /* don't overwrite the nul at the end */
64    len--;
65
66    /* Go to the end of the destination string */
67    while( s[0] )
68    {
69        s++;
70        len--;
71    }
72
73    /* Now start appending, converting on the fly if necessary */
74    for( p = append; p[0]; )
75    {
76        /* skip over the requested character */
77        if( skip == p[0] )
78        {
79            p++;
80            continue;
81        }
82
83        if( !( p[0] & 0x80 ) )
84        {
85            /* ASCII character */
86            WANTBYTES( 1, len );
87            *(s++) = *(p++);
88            continue;
89        }
90
91        if( ( p[0] & 0xE0 ) == 0xC0 && ( p[1] & 0xC0 ) == 0x80 )
92        {
93            /* 2-bytes UTF-8 character */
94            WANTBYTES( 2, len );
95            *(s++) = *(p++); *(s++) = *(p++);
96            continue;
97        }
98
99        if( ( p[0] & 0xF0 ) == 0xE0 && ( p[1] & 0xC0 ) == 0x80 &&
100            ( p[2] & 0xC0 ) == 0x80 )
101        {
102            /* 3-bytes UTF-8 character */
103            WANTBYTES( 3, len );
104            *(s++) = *(p++); *(s++) = *(p++);
105            *(s++) = *(p++);
106            continue;
107        }
108
109        if( ( p[0] & 0xF8 ) == 0xF0 && ( p[1] & 0xC0 ) == 0x80 &&
110            ( p[2] & 0xC0 ) == 0x80 && ( p[3] & 0xC0 ) == 0x80 )
111        {
112            /* 4-bytes UTF-8 character */
113            WANTBYTES( 4, len );
114            *(s++) = *(p++); *(s++) = *(p++);
115            *(s++) = *(p++); *(s++) = *(p++);
116            continue;
117        }
118
119        /* ISO 8859-1 -> UTF-8 conversion */
120        WANTBYTES( 2, len );
121        *(s++) = 0xC0 | ( ( *p & 0xFF ) >> 6 );
122        *(s++) = 0x80 | ( *(p++) & 0x3F );
123    }
124}
125
126static void
127getTorrentFilename( const tr_handle  * handle,
128                    const tr_info    * inf,
129                    char             * buf,
130                    size_t             buflen )
131{
132    const char * dir = tr_getTorrentDir( handle );
133    char base[MAX_PATH_LENGTH];
134    snprintf( base, sizeof( base ), "%s.%16.16s.torrent", inf->name, inf->hashString );
135    tr_buildPath( buf, buflen, dir, base, NULL );
136}
137
138static void
139getTorrentOldFilename( const tr_handle * handle,
140                       const tr_info   * info,
141                       char            * name,
142                       size_t            len )
143{
144    const char * torDir = tr_getTorrentDir( handle );
145
146    if( !handle->tag )
147    {
148        tr_buildPath( name, len, torDir, info->hashString, NULL );
149    }
150    else
151    {
152        char base[1024];
153        snprintf( base, sizeof(base), "%s-%s", info->hashString, handle->tag );
154        tr_buildPath( name, len, torDir, base, NULL );
155    }
156}
157
158void
159tr_metainfoMigrate( tr_handle * handle,
160                    tr_info   * inf )
161{
162    struct stat new_sb;
163    char new_name[MAX_PATH_LENGTH];
164
165    getTorrentFilename( handle, inf, new_name, sizeof( new_name ) );
166
167    if( stat( new_name, &new_sb ) || ( ( new_sb.st_mode & S_IFMT ) != S_IFREG ) )
168    {
169        char old_name[MAX_PATH_LENGTH];
170        size_t contentLen;
171        uint8_t * content;
172
173        tr_mkdirp( tr_getTorrentDir( handle ), 0777 );
174        getTorrentOldFilename( handle, inf, old_name, sizeof( old_name ) );
175        if(( content = tr_loadFile( old_name, &contentLen )))
176        {
177            FILE * out;
178            errno = 0;
179            out = fopen( new_name, "wb+" );
180            if( !out )
181            {
182                tr_nerr( inf->name, _( "Couldn't create \"%1$s\": %2$s" ), new_name, tr_strerror( errno ) );
183            }
184            else
185            {
186                if( fwrite( content, sizeof( uint8_t ), contentLen, out ) == contentLen )
187                {
188                    tr_free( inf->torrent );
189                    inf->torrent = tr_strdup( new_name );
190                    tr_sessionSetTorrentFile( handle, inf->hashString, new_name );
191                    unlink( old_name );
192                }
193                fclose( out );
194            }
195        }
196
197        tr_free( content );
198    }
199}
200
201static char *
202announceToScrape( const char * announce )
203{
204    char * scrape = NULL;
205    const char * s;
206
207    /* To derive the scrape URL use the following steps:
208     * Begin with the announce URL. Find the last '/' in it.
209     * If the text immediately following that '/' isn't 'announce'
210     * it will be taken as a sign that that tracker doesn't support
211     * the scrape convention. If it does, substitute 'scrape' for
212     * 'announce' to find the scrape page.  */
213    if((( s = strrchr( announce, '/' ))) && !strncmp( ++s, "announce", 8 ))
214    {
215        struct evbuffer * buf = evbuffer_new( );
216        evbuffer_add( buf, announce, s-announce );
217        evbuffer_add( buf, "scrape", 6 );
218        evbuffer_add_printf( buf, "%s", s+8 );
219        scrape = tr_strdup( ( char * ) EVBUFFER_DATA( buf ) );
220        evbuffer_free( buf );
221    }
222
223    return scrape;
224}
225
226static int
227getannounce( tr_info * inf, tr_benc * meta )
228{
229    const char * str;
230    tr_tracker_info * trackers = NULL;
231    int trackerCount = 0;
232    tr_benc * tiers;
233
234    /* Announce-list */
235    if( tr_bencDictFindList( meta, "announce-list", &tiers ) )
236    {
237        int n;
238        int i, j;
239
240        n = 0;
241        for( i=0; i<tiers->val.l.count; ++i )
242            n += tiers->val.l.vals[i].val.l.count;
243
244        trackers = tr_new0( tr_tracker_info, n );
245        trackerCount = 0;
246
247        for( i=0; i<tiers->val.l.count; ++i ) {
248            const tr_benc * tier = &tiers->val.l.vals[i];
249            for( j=0; tr_bencIsList(tier) && j<tier->val.l.count; ++j ) {
250                const tr_benc * a = &tier->val.l.vals[j];
251                if( tr_bencIsString( a ) && tr_httpIsValidURL( a->val.s.s ) ) {
252                    tr_tracker_info * t = trackers + trackerCount++;
253                    t->tier = i;
254                    t->announce = tr_strndup( a->val.s.s, a->val.s.i );
255                    t->scrape = announceToScrape( a->val.s.s );
256                    /*fprintf( stderr, "tier %d: %s\n", i, a->val.s.s );*/
257                }
258            }
259        }
260
261        /* did we use any of the tiers? */
262        if( !trackerCount ) {
263            tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "announce-list" );
264            tr_free( trackers );
265            trackers = NULL;
266        }
267    }
268
269    /* Regular announce value */
270    if( !trackerCount
271        && tr_bencDictFindStr( meta, "announce", &str )
272        && tr_httpIsValidURL( str ) )
273    {
274        trackers = tr_new0( tr_tracker_info, 1 );
275        trackers[trackerCount].tier = 0;
276        trackers[trackerCount].announce = tr_strdup( str );
277        trackers[trackerCount++].scrape = announceToScrape( str );
278        /*fprintf( stderr, "single announce: [%s]\n", str );*/
279    }
280
281    inf->trackers = trackers;
282    inf->trackerCount = trackerCount;
283
284    if( !inf->trackerCount )
285        tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "announce" );
286
287    return inf->trackerCount ? TR_OK : TR_ERROR;
288}
289
290int
291tr_metainfoParse( const tr_handle  * handle,
292                  tr_info          * inf,
293                  const tr_benc    * meta_in )
294{
295    tr_piece_index_t i;
296    tr_benc * beInfo, * val, * val2;
297    tr_benc * meta = (tr_benc *) meta_in;
298    char buf[4096];
299
300    /* info_hash: urlencoded 20-byte SHA1 hash of the value of the info key
301     * from the Metainfo file. Note that the value will be a bencoded
302     * dictionary, given the definition of the info key above. */
303    if(( beInfo = tr_bencDictFindType( meta, "info", TYPE_DICT )))
304    {
305        int len;
306        char * str = tr_bencSave( beInfo, &len );
307        tr_sha1( inf->hash, str, len, NULL );
308        tr_free( str );
309    }
310    else
311    {
312        tr_err( _( "Missing metadata entry \"%s\"" ), "info" );
313        return TR_EINVALID;
314    }
315
316    tr_sha1_to_hex( inf->hashString, inf->hash );
317
318    /* comment */
319    memset( buf, '\0', sizeof( buf ) );
320    val = tr_bencDictFindFirst( meta, "comment.utf-8", "comment", NULL );
321    if( tr_bencIsString( val ) )
322        strlcat_utf8( buf, val->val.s.s, sizeof( buf ), 0 );
323    tr_free( inf->comment );
324    inf->comment = tr_strdup( buf );
325   
326    /* creator */
327    memset( buf, '\0', sizeof( buf ) );
328    val = tr_bencDictFindFirst( meta, "created by.utf-8", "created by", NULL );
329    if( tr_bencIsString( val ) )
330        strlcat_utf8( buf, val->val.s.s, sizeof( buf ), 0 );
331    tr_free( inf->creator );
332    inf->creator = tr_strdup( buf );
333   
334    /* Date created */
335    inf->dateCreated = 0;
336    val = tr_bencDictFind( meta, "creation date" );
337    if( tr_bencIsInt( val ) )
338        inf->dateCreated = val->val.i;
339   
340    /* Private torrent */
341    val  = tr_bencDictFind( beInfo, "private" );
342    val2 = tr_bencDictFind( meta,  "private" );
343    if( ( tr_bencIsInt(val) && val->val.i ) ||
344        ( tr_bencIsInt(val2) && val2->val.i ) )
345    {
346        inf->isPrivate = 1;
347    }
348   
349    /* Piece length */
350    val = tr_bencDictFind( beInfo, "piece length" );
351    if( !tr_bencIsInt( val ) )
352    {
353        if( val )
354            tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "piece length" );
355        else
356            tr_nerr( inf->name, _( "Missing metadata entry \"%s\"" ), "piece length" );
357        goto fail;
358    }
359    inf->pieceSize = val->val.i;
360
361    /* Hashes */
362    val = tr_bencDictFind( beInfo, "pieces" );
363    if( !tr_bencIsString( val ) )
364    {
365        if( val )
366            tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "pieces" );
367        else
368            tr_nerr( inf->name, _( "Missing metadata entry \"%s\"" ), "pieces" );
369        goto fail;
370    }
371    if( val->val.s.i % SHA_DIGEST_LENGTH )
372    {
373        tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "pieces" );
374        goto fail;
375    }
376    inf->pieceCount = val->val.s.i / SHA_DIGEST_LENGTH;
377
378    inf->pieces = calloc ( inf->pieceCount, sizeof(tr_piece) );
379
380    for ( i=0; i<inf->pieceCount; ++i )
381    {
382        memcpy (inf->pieces[i].hash, &val->val.s.s[i*SHA_DIGEST_LENGTH], SHA_DIGEST_LENGTH);
383    }
384
385    /* get file or top directory name */
386    val = tr_bencDictFindFirst( beInfo, "name.utf-8", "name", NULL );
387    if( parseFiles( inf, tr_bencDictFindFirst( beInfo,
388                                               "name.utf-8", "name", NULL ),
389                    tr_bencDictFind( beInfo, "files" ),
390                    tr_bencDictFind( beInfo, "length" ) ) )
391    {
392        goto fail;
393    }
394
395    if( !inf->fileCount || !inf->totalSize )
396    {
397        tr_nerr( inf->name, _( "Torrent is corrupt" ) ); /* the content is missing! */
398        goto fail;
399    }
400
401    /* TODO add more tests so we don't crash on weird files */
402
403    if( (uint64_t) inf->pieceCount !=
404        ( inf->totalSize + inf->pieceSize - 1 ) / inf->pieceSize )
405    {
406        tr_nerr( inf->name, _( "Torrent is corrupt" ) ); /* size of hashes and files don't match */
407        goto fail;
408    }
409
410    /* get announce or announce-list */
411    if( getannounce( inf, meta ) )
412        goto fail;
413
414    /* filename of Transmission's copy */
415    getTorrentFilename( handle, inf, buf, sizeof( buf ) );
416    tr_free( inf->torrent );
417    inf->torrent = tr_strdup( buf );
418
419    return TR_OK;
420
421  fail:
422    tr_metainfoFree( inf );
423    return TR_EINVALID;
424}
425
426void tr_metainfoFree( tr_info * inf )
427{
428    tr_file_index_t ff;
429    int i;
430
431    for( ff=0; ff<inf->fileCount; ++ff )
432        tr_free( inf->files[ff].name );
433
434    tr_free( inf->pieces );
435    tr_free( inf->files );
436    tr_free( inf->comment );
437    tr_free( inf->creator );
438    tr_free( inf->torrent );
439    tr_free( inf->name );
440   
441    for( i=0; i<inf->trackerCount; ++i ) {
442        tr_free( inf->trackers[i].announce );
443        tr_free( inf->trackers[i].scrape );
444    }
445    tr_free( inf->trackers );
446
447    memset( inf, '\0', sizeof(tr_info) );
448}
449
450static int
451getfile( char ** setme, const char * prefix, tr_benc * name )
452{
453    const char ** list;
454    int           ii, jj;
455    char          buf[4096];
456
457    if( !tr_bencIsList( name ) )
458        return TR_EINVALID;
459
460    list = calloc( name->val.l.count, sizeof( list[0] ) );
461    if( !list )
462        return TR_EINVALID;
463
464    for( ii = jj = 0; name->val.l.count > ii; ii++ )
465    {
466        tr_benc * dir = &name->val.l.vals[ii];
467
468        if( !tr_bencIsString( dir ) )
469            continue;
470
471        if( 0 == strcmp( "..", dir->val.s.s ) )
472        {
473            if( 0 < jj )
474            {
475                jj--;
476            }
477        }
478        else if( 0 != strcmp( ".", dir->val.s.s ) )
479        {
480            list[jj] = dir->val.s.s;
481            jj++;
482        }
483    }
484
485    if( 0 == jj )
486    {
487        free( list );
488        return TR_EINVALID;
489    }
490
491    memset( buf, 0, sizeof( buf ) );
492    strlcat_utf8( buf, prefix, sizeof(buf), 0 );
493    for( ii = 0; jj > ii; ii++ )
494    {
495        strlcat_utf8( buf, TR_PATH_DELIMITER_STR, sizeof(buf), 0 );
496        strlcat_utf8( buf, list[ii], sizeof(buf), TR_PATH_DELIMITER );
497    }
498    free( list );
499
500    tr_free( *setme );
501    *setme = tr_strdup( buf );
502
503    return TR_OK;
504}
505
506void
507tr_metainfoRemoveSaved( const tr_handle * handle,
508                        const tr_info   * inf )
509{
510    char filename[MAX_PATH_LENGTH];
511
512    getTorrentFilename( handle, inf, filename, sizeof( filename ) );
513    unlink( filename );
514
515    getTorrentOldFilename( handle, inf, filename, sizeof( filename ) );
516    unlink( filename );
517}
518
519static int
520parseFiles( tr_info * inf, tr_benc * name,
521            tr_benc * files, tr_benc * length )
522{
523    tr_benc * item, * path;
524    int ii;
525    char buf[4096];
526
527    if( !tr_bencIsString( name ) )
528    {
529        if( name )
530            tr_err( _( "Invalid metadata entry \"%s\"" ), "name" );
531        else
532            tr_err( _( "Missing metadata entry \"%s\"" ), "name" );
533        return TR_EINVALID;
534    }
535
536    memset( buf, 0, sizeof( buf ) );
537    strlcat_utf8( buf, name->val.s.s, sizeof( buf ), 0 );
538    tr_free( inf->name );
539    inf->name = tr_strdup( buf );
540    if( !inf->name || !*inf->name )
541    {
542        tr_err( _( "Invalid metadata entry \"%s\"" ), "name" );
543        return TR_EINVALID;
544    }
545    inf->totalSize = 0;
546
547    if( tr_bencIsList( files ) )
548    {
549        /* Multi-file mode */
550        inf->isMultifile = 1;
551        inf->fileCount = files->val.l.count;
552        inf->files     = calloc( inf->fileCount, sizeof( inf->files[0] ) );
553
554        if( !inf->files )
555            return TR_EINVALID;
556
557        for( ii = 0; files->val.l.count > ii; ii++ )
558        {
559            item = &files->val.l.vals[ii];
560            path = tr_bencDictFindFirst( item, "path.utf-8", "path", NULL );
561            if( getfile( &inf->files[ii].name, inf->name, path ) )
562            {
563                if( path )
564                    tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "path" );
565                else
566                    tr_nerr( inf->name, _( "Missing metadata entry \"%s\"" ), "path" );
567                return TR_EINVALID;
568            }
569            length = tr_bencDictFind( item, "length" );
570            if( !tr_bencIsInt( length ) )
571            {
572                if( length )
573                    tr_nerr( inf->name, _( "Invalid metadata entry \"%s\"" ), "length" );
574                else
575                    tr_nerr( inf->name, _( "Missing metadata entry \"%s\"" ), "length" );
576                return TR_EINVALID;
577            }
578            inf->files[ii].length = length->val.i;
579            inf->totalSize         += length->val.i;
580        }
581    }
582    else if( tr_bencIsInt( length ) )
583    {
584        char buf[4096];
585
586        /* Single-file mode */
587        inf->isMultifile = 0;
588        inf->fileCount = 1;
589        inf->files     = calloc( 1, sizeof( inf->files[0] ) );
590
591        if( !inf->files )
592            return TR_EINVALID;
593
594        memset( buf, 0, sizeof( buf ) );
595        strlcat_utf8( buf, name->val.s.s, sizeof(buf), TR_PATH_DELIMITER );
596        tr_free( inf->files[0].name );
597        inf->files[0].name = tr_strdup( buf );
598
599        inf->files[0].length = length->val.i;
600        inf->totalSize      += length->val.i;
601    }
602    else
603    {
604        tr_nerr( inf->name, _( "Invalid or missing metadata entries \"length\" and \"files\"" ) );
605    }
606
607    return TR_OK;
608}
Note: See TracBrowser for help on using the repository browser.