source: trunk/libtransmission/metainfo.c @ 5843

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

RPC/IPC redesign

  • Property svn:keywords set to Date Rev Author Id
File size: 17.2 KB
Line 
1/******************************************************************************
2 * $Id: metainfo.c 5843 2008-05-18 16:44:30Z 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        getTorrentOldFilename( handle, inf, old_name, sizeof( old_name ) );
174        if(( content = tr_loadFile( old_name, &contentLen )))
175        {
176            FILE * out = fopen( new_name, "wb+" );
177            if( fwrite( content, sizeof( uint8_t ), contentLen, out ) == contentLen )
178            {
179                tr_free( inf->torrent );
180                inf->torrent = tr_strdup( new_name );
181                tr_sessionSetTorrentFile( handle, inf->hashString, new_name );
182                unlink( old_name );
183            }
184            fclose( out );
185        }
186
187        tr_free( content );
188    }
189}
190
191static char *
192announceToScrape( const char * announce )
193{
194    char * scrape = NULL;
195    const char * s;
196
197    /* To derive the scrape URL use the following steps:
198     * Begin with the announce URL. Find the last '/' in it.
199     * If the text immediately following that '/' isn't 'announce'
200     * it will be taken as a sign that that tracker doesn't support
201     * the scrape convention. If it does, substitute 'scrape' for
202     * 'announce' to find the scrape page.  */
203    if((( s = strrchr( announce, '/' ))) && !strncmp( ++s, "announce", 8 ))
204    {
205        struct evbuffer * buf = evbuffer_new( );
206        evbuffer_add( buf, announce, s-announce );
207        evbuffer_add( buf, "scrape", 6 );
208        evbuffer_add_printf( buf, "%s", s+8 );
209        scrape = tr_strdup( ( char * ) EVBUFFER_DATA( buf ) );
210        evbuffer_free( buf );
211    }
212
213    return scrape;
214}
215
216static int
217getannounce( tr_info * inf, tr_benc * meta )
218{
219    const char * str;
220    tr_tracker_info * trackers = NULL;
221    int trackerCount = 0;
222    tr_benc * tiers;
223
224    /* Announce-list */
225    if( tr_bencDictFindList( meta, "announce-list", &tiers ) )
226    {
227        int n;
228        int i, j;
229
230        n = 0;
231        for( i=0; i<tiers->val.l.count; ++i )
232            n += tiers->val.l.vals[i].val.l.count;
233
234        trackers = tr_new0( tr_tracker_info, n );
235        trackerCount = 0;
236
237        for( i=0; i<tiers->val.l.count; ++i ) {
238            const tr_benc * tier = &tiers->val.l.vals[i];
239            for( j=0; tr_bencIsList(tier) && j<tier->val.l.count; ++j ) {
240                const tr_benc * a = &tier->val.l.vals[j];
241                if( tr_bencIsString( a ) && tr_httpIsValidURL( a->val.s.s ) ) {
242                    tr_tracker_info * t = trackers + trackerCount++;
243                    t->tier = i;
244                    t->announce = tr_strndup( a->val.s.s, a->val.s.i );
245                    t->scrape = announceToScrape( a->val.s.s );
246                    /*fprintf( stderr, "tier %d: %s\n", i, a->val.s.s );*/
247                }
248            }
249        }
250
251        /* did we use any of the tiers? */
252        if( !trackerCount ) {
253            tr_inf( _( "Invalid metadata entry \"%s\"" ), "announce-list" );
254            tr_free( trackers );
255            trackers = NULL;
256        }
257    }
258
259    /* Regular announce value */
260    if( !trackerCount
261        && tr_bencDictFindStr( meta, "announce", &str )
262        && tr_httpIsValidURL( str ) )
263    {
264        trackers = tr_new0( tr_tracker_info, 1 );
265        trackers[trackerCount].tier = 0;
266        trackers[trackerCount].announce = tr_strdup( str );
267        trackers[trackerCount++].scrape = announceToScrape( str );
268        /*fprintf( stderr, "single announce: [%s]\n", str );*/
269    }
270
271    inf->trackers = trackers;
272    inf->trackerCount = trackerCount;
273
274    return inf->trackerCount ? TR_OK : TR_ERROR;
275}
276
277int
278tr_metainfoParse( const tr_handle  * handle,
279                  tr_info          * inf,
280                  const tr_benc    * meta_in )
281{
282    tr_piece_index_t i;
283    tr_benc * beInfo, * val, * val2;
284    tr_benc * meta = (tr_benc *) meta_in;
285    char buf[4096];
286
287    /* info_hash: urlencoded 20-byte SHA1 hash of the value of the info key
288     * from the Metainfo file. Note that the value will be a bencoded
289     * dictionary, given the definition of the info key above. */
290    if(( beInfo = tr_bencDictFindType( meta, "info", TYPE_DICT )))
291    {
292        int len;
293        char * str = tr_bencSave( beInfo, &len );
294        tr_sha1( inf->hash, str, len, NULL );
295        tr_free( str );
296    }
297    else
298    {
299        tr_err( _( "Missing metadata entry \"%s\"" ), "info" );
300        return TR_EINVALID;
301    }
302
303    tr_sha1_to_hex( inf->hashString, inf->hash );
304
305    /* comment */
306    memset( buf, '\0', sizeof( buf ) );
307    val = tr_bencDictFindFirst( meta, "comment.utf-8", "comment", NULL );
308    if( tr_bencIsString( val ) )
309        strlcat_utf8( buf, val->val.s.s, sizeof( buf ), 0 );
310    tr_free( inf->comment );
311    inf->comment = tr_strdup( buf );
312   
313    /* creator */
314    memset( buf, '\0', sizeof( buf ) );
315    val = tr_bencDictFindFirst( meta, "created by.utf-8", "created by", NULL );
316    if( tr_bencIsString( val ) )
317        strlcat_utf8( buf, val->val.s.s, sizeof( buf ), 0 );
318    tr_free( inf->creator );
319    inf->creator = tr_strdup( buf );
320   
321    /* Date created */
322    inf->dateCreated = 0;
323    val = tr_bencDictFind( meta, "creation date" );
324    if( tr_bencIsInt( val ) )
325        inf->dateCreated = val->val.i;
326   
327    /* Private torrent */
328    val  = tr_bencDictFind( beInfo, "private" );
329    val2 = tr_bencDictFind( meta,  "private" );
330    if( ( tr_bencIsInt(val) && val->val.i ) ||
331        ( tr_bencIsInt(val2) && val2->val.i ) )
332    {
333        inf->isPrivate = 1;
334    }
335   
336    /* Piece length */
337    val = tr_bencDictFind( beInfo, "piece length" );
338    if( !tr_bencIsInt( val ) )
339    {
340        if( val )
341            tr_err( _( "Invalid metadata entry \"%s\"" ), "piece length" );
342        else
343            tr_err( _( "Missing metadata entry \"%s\"" ), "piece length" );
344        goto fail;
345    }
346    inf->pieceSize = val->val.i;
347
348    /* Hashes */
349    val = tr_bencDictFind( beInfo, "pieces" );
350    if( !tr_bencIsString( val ) )
351    {
352        if( val )
353            tr_err( _( "Invalid metadata entry \"%s\"" ), "pieces" );
354        else
355            tr_err( _( "Missing metadata entry \"%s\"" ), "pieces" );
356        goto fail;
357    }
358    if( val->val.s.i % SHA_DIGEST_LENGTH )
359    {
360        tr_err( _( "Invalid metadata entry \"%s\"" ), "pieces" );
361        goto fail;
362    }
363    inf->pieceCount = val->val.s.i / SHA_DIGEST_LENGTH;
364
365    inf->pieces = calloc ( inf->pieceCount, sizeof(tr_piece) );
366
367    for ( i=0; i<inf->pieceCount; ++i )
368    {
369        memcpy (inf->pieces[i].hash, &val->val.s.s[i*SHA_DIGEST_LENGTH], SHA_DIGEST_LENGTH);
370    }
371
372    /* get file or top directory name */
373    val = tr_bencDictFindFirst( beInfo, "name.utf-8", "name", NULL );
374    if( parseFiles( inf, tr_bencDictFindFirst( beInfo,
375                                               "name.utf-8", "name", NULL ),
376                    tr_bencDictFind( beInfo, "files" ),
377                    tr_bencDictFind( beInfo, "length" ) ) )
378    {
379        goto fail;
380    }
381
382    if( !inf->fileCount || !inf->totalSize )
383    {
384        tr_err( _( "Torrent is corrupt" ) ); /* the content is missing! */
385        goto fail;
386    }
387
388    /* TODO add more tests so we don't crash on weird files */
389
390    if( (uint64_t) inf->pieceCount !=
391        ( inf->totalSize + inf->pieceSize - 1 ) / inf->pieceSize )
392    {
393        tr_err( _( "Torrent is corrupt" ) ); /* size of hashes and files don't match */
394        goto fail;
395    }
396
397    /* get announce or announce-list */
398    if( getannounce( inf, meta ) )
399        goto fail;
400
401    /* filename of Transmission's copy */
402    getTorrentFilename( handle, inf, buf, sizeof( buf ) );
403    tr_free( inf->torrent );
404    inf->torrent = tr_strdup( buf );
405
406    return TR_OK;
407
408  fail:
409    tr_metainfoFree( inf );
410    return TR_EINVALID;
411}
412
413void tr_metainfoFree( tr_info * inf )
414{
415    tr_file_index_t ff;
416    int i;
417
418    for( ff=0; ff<inf->fileCount; ++ff )
419        tr_free( inf->files[ff].name );
420
421    tr_free( inf->pieces );
422    tr_free( inf->files );
423    tr_free( inf->comment );
424    tr_free( inf->creator );
425    tr_free( inf->torrent );
426    tr_free( inf->name );
427   
428    for( i=0; i<inf->trackerCount; ++i ) {
429        tr_free( inf->trackers[i].announce );
430        tr_free( inf->trackers[i].scrape );
431    }
432    tr_free( inf->trackers );
433
434    memset( inf, '\0', sizeof(tr_info) );
435}
436
437static int
438getfile( char ** setme, const char * prefix, tr_benc * name )
439{
440    const char ** list;
441    int           ii, jj;
442    char          buf[4096];
443
444    if( !tr_bencIsList( name ) )
445        return TR_EINVALID;
446
447    list = calloc( name->val.l.count, sizeof( list[0] ) );
448    if( !list )
449        return TR_EINVALID;
450
451    for( ii = jj = 0; name->val.l.count > ii; ii++ )
452    {
453        tr_benc * dir = &name->val.l.vals[ii];
454
455        if( !tr_bencIsString( dir ) )
456            continue;
457
458        if( 0 == strcmp( "..", dir->val.s.s ) )
459        {
460            if( 0 < jj )
461            {
462                jj--;
463            }
464        }
465        else if( 0 != strcmp( ".", dir->val.s.s ) )
466        {
467            list[jj] = dir->val.s.s;
468            jj++;
469        }
470    }
471
472    if( 0 == jj )
473    {
474        free( list );
475        return TR_EINVALID;
476    }
477
478    memset( buf, 0, sizeof( buf ) );
479    strlcat_utf8( buf, prefix, sizeof(buf), 0 );
480    for( ii = 0; jj > ii; ii++ )
481    {
482        strlcat_utf8( buf, TR_PATH_DELIMITER_STR, sizeof(buf), 0 );
483        strlcat_utf8( buf, list[ii], sizeof(buf), TR_PATH_DELIMITER );
484    }
485    free( list );
486
487    tr_free( *setme );
488    *setme = tr_strdup( buf );
489
490    return TR_OK;
491}
492
493void
494tr_metainfoRemoveSaved( const tr_handle * handle,
495                        const tr_info   * inf )
496{
497    char filename[MAX_PATH_LENGTH];
498
499    getTorrentFilename( handle, inf, filename, sizeof( filename ) );
500    unlink( filename );
501
502    getTorrentOldFilename( handle, inf, filename, sizeof( filename ) );
503    unlink( filename );
504}
505
506static int
507parseFiles( tr_info * inf, tr_benc * name,
508            tr_benc * files, tr_benc * length )
509{
510    tr_benc * item, * path;
511    int ii;
512    char buf[4096];
513
514    if( !tr_bencIsString( name ) )
515    {
516        if( name )
517            tr_err( _( "Invalid metadata entry \"%s\"" ), "name" );
518        else
519            tr_err( _( "Missing metadata entry \"%s\"" ), "name" );
520        return TR_EINVALID;
521    }
522
523    memset( buf, 0, sizeof( buf ) );
524    strlcat_utf8( buf, name->val.s.s, sizeof( buf ), 0 );
525    tr_free( inf->name );
526    inf->name = tr_strdup( buf );
527    if( !inf->name || !*inf->name )
528    {
529        tr_err( _( "Invalid metadata entry \"%s\"" ), "name" );
530        return TR_EINVALID;
531    }
532    inf->totalSize = 0;
533
534    if( tr_bencIsList( files ) )
535    {
536        /* Multi-file mode */
537        inf->isMultifile = 1;
538        inf->fileCount = files->val.l.count;
539        inf->files     = calloc( inf->fileCount, sizeof( inf->files[0] ) );
540
541        if( !inf->files )
542            return TR_EINVALID;
543
544        for( ii = 0; files->val.l.count > ii; ii++ )
545        {
546            item = &files->val.l.vals[ii];
547            path = tr_bencDictFindFirst( item, "path.utf-8", "path", NULL );
548            if( getfile( &inf->files[ii].name, inf->name, path ) )
549            {
550                if( path )
551                    tr_err( _( "Invalid metadata entry \"%s\"" ), "path" );
552                else
553                    tr_err( _( "Missing metadata entry \"%s\"" ), "path" );
554                return TR_EINVALID;
555            }
556            length = tr_bencDictFind( item, "length" );
557            if( !tr_bencIsInt( length ) )
558            {
559                if( length )
560                    tr_err( _( "Invalid metadata entry \"%s\"" ), "length" );
561                else
562                    tr_err( _( "Missing metadata entry \"%s\"" ), "length" );
563                return TR_EINVALID;
564            }
565            inf->files[ii].length = length->val.i;
566            inf->totalSize         += length->val.i;
567        }
568    }
569    else if( tr_bencIsInt( length ) )
570    {
571        char buf[4096];
572
573        /* Single-file mode */
574        inf->isMultifile = 0;
575        inf->fileCount = 1;
576        inf->files     = calloc( 1, sizeof( inf->files[0] ) );
577
578        if( !inf->files )
579            return TR_EINVALID;
580
581        memset( buf, 0, sizeof( buf ) );
582        strlcat_utf8( buf, name->val.s.s, sizeof(buf), TR_PATH_DELIMITER );
583        tr_free( inf->files[0].name );
584        inf->files[0].name = tr_strdup( buf );
585
586        inf->files[0].length = length->val.i;
587        inf->totalSize      += length->val.i;
588    }
589    else
590    {
591        tr_err( _( "Invalid or missing metadata entries \"length\" and \"files\"" ) );
592    }
593
594    return TR_OK;
595}
Note: See TracBrowser for help on using the repository browser.