source: trunk/libtransmission/bencode.c @ 5611

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

'resume' cleanup

  • Property svn:keywords set to Date Rev Author Id
File size: 26.5 KB
Line 
1/******************************************************************************
2 * $Id: bencode.c 5611 2008-04-14 11:52:50Z 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> /* isdigit, isprint */
27#include <errno.h>
28#include <stdarg.h>
29#include <stdio.h>
30#include <stdlib.h>
31
32#include <event.h> /* evbuffer */
33
34#include "transmission.h"
35#include "bencode.h"
36#include "list.h"
37#include "ptrarray.h"
38#include "utils.h" /* tr_new(), tr_free() */
39
40/**
41***
42**/
43
44int
45tr_bencIsType( const tr_benc * val, int type )
46{
47    return ( ( val != NULL ) && ( val->type == type ) );
48}
49
50static int
51isContainer( const tr_benc * val )
52{
53    return tr_bencIsList(val) || tr_bencIsDict(val);
54}
55static int
56isSomething( const tr_benc * val )
57{
58    return isContainer(val) || tr_bencIsInt(val) || tr_bencIsString(val);
59}
60
61/***
62****  tr_bencParse()
63****  tr_bencLoad()
64***/
65
66/**
67 * The initial i and trailing e are beginning and ending delimiters.
68 * You can have negative numbers such as i-3e. You cannot prefix the
69 * number with a zero such as i04e. However, i0e is valid. 
70 * Example: i3e represents the integer "3"
71 * NOTE: The maximum number of bit of this integer is unspecified,
72 * but to handle it as a signed 64bit integer is mandatory to handle
73 * "large files" aka .torrent for more that 4Gbyte
74 */
75int
76tr_bencParseInt( const uint8_t  * buf,
77                 const uint8_t  * bufend,
78                 const uint8_t ** setme_end, 
79                 int64_t        * setme_val )
80{
81    int err = TR_OK;
82    char * endptr;
83    const void * begin;
84    const void * end;
85    int64_t val;
86
87    if( buf >= bufend )
88        return TR_ERROR;
89    if( *buf != 'i' )
90        return TR_ERROR;
91
92    begin = buf + 1;
93    end = memchr( begin, 'e', (bufend-buf)-1 );
94    if( end == NULL )
95        return TR_ERROR;
96
97    errno = 0;
98    val = strtoll( begin, &endptr, 10 );
99    if( errno || ( endptr != end ) ) /* incomplete parse */
100        err = TR_ERROR;
101    else if( val && *(const char*)begin=='0' ) /* no leading zeroes! */
102        err = TR_ERROR;
103    else {
104        *setme_end = end + 1;
105        *setme_val = val;
106    }
107
108    return err;
109}
110
111
112/**
113 * Byte strings are encoded as follows:
114 * <string length encoded in base ten ASCII>:<string data>
115 * Note that there is no constant beginning delimiter, and no ending delimiter.
116 * Example: 4:spam represents the string "spam"
117 */
118int
119tr_bencParseStr( const uint8_t  * buf,
120                 const uint8_t  * bufend,
121                 const uint8_t ** setme_end,
122                 uint8_t       ** setme_str,
123                 size_t         * setme_strlen )
124{
125    size_t len;
126    const void * end;
127    char * endptr;
128
129    if( buf >= bufend )
130        return TR_ERROR;
131
132    if( !isdigit( *buf  ) )
133        return TR_ERROR;
134
135    end = memchr( buf, ':', bufend-buf );
136    if( end == NULL )
137        return TR_ERROR;
138
139    errno = 0;
140    len = strtoul( (const char*)buf, &endptr, 10 );
141    if( errno || endptr!=end )
142        return TR_ERROR;
143
144    if( (const uint8_t*)end + 1 + len > bufend )
145        return TR_ERROR;
146
147    *setme_end = end + 1 + len;
148    *setme_str = (uint8_t*) tr_strndup( end + 1, len );
149    *setme_strlen = len;
150    return TR_OK;
151}
152
153/* setting to 1 to help expose bugs with tr_bencListAdd and tr_bencDictAdd */
154#define LIST_SIZE 8 /* number of items to increment list/dict buffer by */
155
156static int
157makeroom( tr_benc * val, int count )
158{
159    assert( TYPE_LIST == val->type || TYPE_DICT == val->type );
160
161    if( val->val.l.count + count > val->val.l.alloc )
162    {
163        /* We need a bigger boat */
164        const int len = val->val.l.alloc + count +
165            ( count % LIST_SIZE ? LIST_SIZE - ( count % LIST_SIZE ) : 0 );
166        void * new = realloc( val->val.l.vals, len * sizeof( tr_benc ) );
167        if( NULL == new )
168            return 1;
169
170        val->val.l.alloc = len;
171        val->val.l.vals  = new;
172    }
173
174    return 0;
175}
176
177static tr_benc*
178getNode( tr_benc * top, tr_ptrArray * parentStack, int type )
179{
180    tr_benc * parent;
181
182    assert( top != NULL );
183    assert( parentStack != NULL );
184
185    if( tr_ptrArrayEmpty( parentStack ) )
186        return top;
187
188    parent = tr_ptrArrayBack( parentStack );
189    assert( parent != NULL );
190
191    /* dictionary keys must be strings */
192    if( ( parent->type == TYPE_DICT )
193        && ( type != TYPE_STR )
194        && ( ! ( parent->val.l.count % 2 ) ) )
195        return NULL;
196
197    makeroom( parent, 1 );
198    return parent->val.l.vals + parent->val.l.count++;
199}
200
201/**
202 * This function's previous recursive implementation was
203 * easier to read, but was vulnerable to a smash-stacking
204 * attack via maliciously-crafted bencoded data. (#667)
205 */
206int
207tr_bencParse( const void     * buf_in,
208              const void     * bufend_in,
209              tr_benc     * top,
210              const uint8_t ** setme_end )
211{
212    int err;
213    const uint8_t * buf = buf_in;
214    const uint8_t * bufend = bufend_in;
215    tr_ptrArray * parentStack = tr_ptrArrayNew( );
216
217    tr_bencInit( top, 0 );
218
219    while( buf != bufend )
220    {
221        if( buf > bufend ) /* no more text to parse... */
222            return 1;
223
224        if( *buf=='i' ) /* int */
225        {
226            int64_t val;
227            const uint8_t * end;
228            int err;
229            tr_benc * node;
230
231            if(( err = tr_bencParseInt( buf, bufend, &end, &val )))
232                return err;
233
234            node = getNode( top, parentStack, TYPE_INT );
235            if( !node )
236                return TR_ERROR;
237
238            tr_bencInitInt( node, val );
239            buf = end;
240
241            if( tr_ptrArrayEmpty( parentStack ) )
242                break;
243        }
244        else if( *buf=='l' ) /* list */
245        {
246            tr_benc * node = getNode( top, parentStack, TYPE_LIST );
247            if( !node )
248                return TR_ERROR;
249            tr_bencInit( node, TYPE_LIST );
250            tr_ptrArrayAppend( parentStack, node );
251            ++buf;
252        }
253        else if( *buf=='d' ) /* dict */
254        {
255            tr_benc * node = getNode( top, parentStack, TYPE_DICT );
256            if( !node )
257                return TR_ERROR;
258            tr_bencInit( node, TYPE_DICT );
259            tr_ptrArrayAppend( parentStack, node );
260            ++buf;
261        }
262        else if( *buf=='e' ) /* end of list or dict */
263        {
264            tr_benc * node;
265            ++buf;
266            if( tr_ptrArrayEmpty( parentStack ) )
267                return TR_ERROR;
268
269            node = tr_ptrArrayBack( parentStack );
270            if( tr_bencIsDict( node ) && ( node->val.l.count % 2 ) )
271                return TR_ERROR; /* odd # of children in dict */
272
273            tr_ptrArrayPop( parentStack );
274            if( tr_ptrArrayEmpty( parentStack ) )
275                break;
276        }
277        else if( isdigit(*buf) ) /* string? */
278        {
279            const uint8_t * end;
280            uint8_t * str;
281            size_t str_len;
282            int err;
283            tr_benc * node;
284
285            if(( err = tr_bencParseStr( buf, bufend, &end, &str, &str_len )))
286                return err;
287
288            node = getNode( top, parentStack, TYPE_STR );
289            if( !node )
290                return TR_ERROR;
291
292            tr_bencInitStr( node, str, str_len, 0 );
293            buf = end;
294
295            if( tr_ptrArrayEmpty( parentStack ) )
296                break;
297        }
298        else /* invalid bencoded text... march past it */
299        {
300            ++buf;
301        }
302    }
303
304    err = !isSomething( top ) || !tr_ptrArrayEmpty( parentStack );
305
306    if( !err && ( setme_end != NULL ) )
307        *setme_end = buf;
308
309    tr_ptrArrayFree( parentStack, NULL );
310    return err;
311}
312
313int
314tr_bencLoad( const void  * buf_in,
315             int           buflen,
316             tr_benc     * setme_benc,
317             char       ** setme_end )
318{
319    const uint8_t * buf = buf_in;
320    const uint8_t * end;
321    const int ret = tr_bencParse( buf, buf+buflen, setme_benc, &end );
322    if( !ret && setme_end )
323        *setme_end = (char*) end;
324    return ret;
325}
326
327/***
328****
329***/
330
331tr_benc *
332tr_bencDictFind( tr_benc * val, const char * key )
333{
334    int len, ii;
335
336    if( !tr_bencIsDict( val ) )
337        return NULL;
338
339    len = strlen( key );
340   
341    for( ii = 0; ii + 1 < val->val.l.count; ii += 2 )
342    {
343        if( TYPE_STR  != val->val.l.vals[ii].type ||
344            len       != val->val.l.vals[ii].val.s.i ||
345            0 != memcmp( val->val.l.vals[ii].val.s.s, key, len ) )
346        {
347            continue;
348        }
349        return &val->val.l.vals[ii+1];
350    }
351
352    return NULL;
353}
354
355tr_benc*
356tr_bencDictFindType( tr_benc * val, const char * key, int type )
357{
358    tr_benc * ret = tr_bencDictFind( val, key );
359    return ret && ret->type == type ? ret : NULL;
360}
361
362tr_benc *
363tr_bencDictFindFirst( tr_benc * val, ... )
364{
365    const char * key;
366    tr_benc * ret;
367    va_list      ap;
368
369    ret = NULL;
370    va_start( ap, val );
371    while(( key = va_arg( ap, const char * )))
372        if(( ret = tr_bencDictFind( val, key )))
373            break;
374    va_end( ap );
375
376    return ret;
377}
378
379tr_benc*
380tr_bencListGetNthChild( tr_benc * val, int i )
381{
382    tr_benc * ret = NULL;
383    if( tr_bencIsList( val ) && ( i >= 0 ) && ( i < val->val.l.count ) )
384        ret = val->val.l.vals + i;
385    return ret;
386}
387
388int
389tr_bencGetInt ( const tr_benc * val, int64_t * setme )
390{
391    int success = FALSE;
392    if( tr_bencIsInt( val )) {
393        *setme = val->val.i ;
394        success = TRUE;
395    }
396    return success;
397}
398
399char *
400tr_bencStealStr( tr_benc * val )
401{
402    assert( tr_bencIsString( val ) );
403    val->val.s.nofree = 1;
404    return val->val.s.s;
405}
406
407int
408tr_bencDictFindInt( tr_benc * dict, const char * key, int64_t * setme )
409{
410    int found = FALSE;
411    tr_benc * child = tr_bencDictFindType( dict, key, TYPE_INT );
412    if( child )
413        found = tr_bencGetInt( child, setme );
414    return found;
415}
416
417int
418tr_bencDictFindList( tr_benc * dict, const char * key, tr_benc ** setme )
419{
420    int found = FALSE;
421    tr_benc * child = tr_bencDictFindType( dict, key, TYPE_LIST );
422    if( child ) {
423        *setme = child;
424        found = TRUE;
425    }
426    return found;
427}
428
429int
430tr_bencDictFindDict( tr_benc * dict, const char * key, tr_benc ** setme )
431{
432    int found = FALSE;
433    tr_benc * child = tr_bencDictFindType( dict, key, TYPE_DICT );
434    if( child ) {
435        *setme = child;
436        found = TRUE;
437    }
438    return found;
439}
440
441int
442tr_bencDictFindStr( tr_benc * dict, const char * key, const char ** setme )
443{
444    int found = FALSE;
445    tr_benc * child = tr_bencDictFindType( dict, key, TYPE_STR );
446    if( child ) {
447        *setme = child->val.s.s;
448        found = TRUE;
449    }
450    return found;
451}
452
453tr_benc*
454tr_bencDictAddInt( tr_benc * dict, const char * key, int64_t val )
455{
456    tr_benc * child = tr_bencDictAdd( dict, key );
457    tr_bencInitInt( child, val );
458    return child;
459}
460
461tr_benc*
462tr_bencDictAddStr( tr_benc * dict, const char * key, const char * val )
463{
464    tr_benc * child = tr_bencDictAdd( dict, key );
465    tr_bencInitStrDup( child, val );
466    return child;
467}
468
469tr_benc*
470tr_bencDictAddList( tr_benc * dict, const char * key, int reserveCount )
471{
472    tr_benc * child = tr_bencDictAdd( dict, key );
473    tr_bencInitList( child, reserveCount );
474    return child;
475}
476
477tr_benc*
478tr_bencDictAddDict( tr_benc * dict, const char * key, int reserveCount )
479{
480    tr_benc * child = tr_bencDictAdd( dict, key );
481    tr_bencInitDict( child, reserveCount );
482    return child;
483}
484
485/***
486****
487***/
488
489void
490_tr_bencInitStr( tr_benc * val, char * str, int len, int nofree )
491{
492    tr_bencInit( val, TYPE_STR );
493    val->val.s.s      = str;
494    val->val.s.nofree = nofree;
495    if( 0 >= len )
496    {
497        len = ( NULL == str ? 0 : strlen( str ) );
498    }
499    val->val.s.i = len;
500}
501
502int
503tr_bencInitStrDupLen( tr_benc * val, const char * str, int len )
504{
505    char * newStr = tr_strndup( str, len );
506    if( newStr == NULL )
507        return 1;
508
509    _tr_bencInitStr( val, newStr, 0, 0 );
510    return 0;
511}
512
513int
514tr_bencInitStrDup( tr_benc * val, const char * str )
515{
516    return tr_bencInitStrDupLen( val, str, -1 );
517}
518
519void
520tr_bencInitInt( tr_benc * val, int64_t num )
521{
522    tr_bencInit( val, TYPE_INT );
523    val->val.i = num;
524}
525
526int
527tr_bencInitList( tr_benc * val, int reserveCount )
528{
529    tr_bencInit( val, TYPE_LIST );
530    return tr_bencListReserve( val, reserveCount );
531}
532
533int
534tr_bencListReserve( tr_benc * val, int count )
535{
536    assert( tr_bencIsList( val ) );
537    return makeroom( val, count );
538}
539
540int
541tr_bencInitDict( tr_benc * val, int reserveCount )
542{
543    tr_bencInit( val, TYPE_DICT );
544    return tr_bencDictReserve( val, reserveCount );
545}
546
547int
548tr_bencDictReserve( tr_benc * val, int count )
549{
550    assert( tr_bencIsDict( val ) );
551    return makeroom( val, count * 2 );
552}
553
554tr_benc *
555tr_bencListAdd( tr_benc * list )
556{
557    tr_benc * item;
558
559    assert( tr_bencIsList( list ) );
560
561    if( list->val.l.count == list->val.l.alloc )
562        tr_bencListReserve( list, LIST_SIZE );
563
564    assert( list->val.l.count < list->val.l.alloc );
565
566    item = &list->val.l.vals[list->val.l.count];
567    list->val.l.count++;
568    tr_bencInit( item, TYPE_INT );
569
570    return item;
571}
572
573tr_benc *
574tr_bencListAddInt( tr_benc * list, int64_t i )
575{
576    tr_benc * node = tr_bencListAdd( list );
577    tr_bencInitInt( node, i );
578    return node;
579}
580
581tr_benc *
582tr_bencDictAdd( tr_benc * dict, const char * key )
583{
584    tr_benc * keyval, * itemval;
585
586    assert( tr_bencIsDict( dict ) );
587    assert( dict->val.l.count + 2 <= dict->val.l.alloc );
588
589    keyval = dict->val.l.vals + dict->val.l.count++;
590    tr_bencInitStr( keyval, (char*)key, -1, 1 );
591
592    itemval = dict->val.l.vals + dict->val.l.count++;
593    tr_bencInit( itemval, TYPE_INT );
594
595    return itemval;
596}
597
598/***
599****  BENC WALKING
600***/
601
602struct KeyIndex
603{
604    const char * key;
605    int index;
606};
607
608static int
609compareKeyIndex( const void * va, const void * vb )
610{
611    const struct KeyIndex * a = va;
612    const struct KeyIndex * b = vb;
613    return strcmp( a->key, b->key );
614}
615
616struct SaveNode
617{
618    const tr_benc * val;
619    int valIsVisited;
620    int childCount;
621    int childIndex;
622    int * children;
623};
624
625static struct SaveNode*
626nodeNewDict( const tr_benc * val )
627{
628    int i, j;
629    int nKeys;
630    struct SaveNode * node;
631    struct KeyIndex * indices;
632
633    assert( tr_bencIsDict( val ) );
634
635    nKeys = val->val.l.count / 2;
636    node = tr_new0( struct SaveNode, 1 );
637    node->val = val;
638    node->children = tr_new0( int, nKeys * 2 );
639
640    /* ugh, a dictionary's children have to be sorted by key... */
641    indices = tr_new( struct KeyIndex, nKeys );
642    for( i=j=0; i<(nKeys*2); i+=2, ++j ) {
643        indices[j].key = val->val.l.vals[i].val.s.s;
644        indices[j].index = i;
645    }
646    qsort( indices, j, sizeof(struct KeyIndex), compareKeyIndex );
647    for( i=0; i<j; ++i ) {
648        const int index = indices[i].index;
649        node->children[ node->childCount++ ] = index;
650        node->children[ node->childCount++ ] = index + 1;
651    }
652
653    assert( node->childCount == nKeys * 2 );
654    tr_free( indices );
655    return node;
656}
657
658static struct SaveNode*
659nodeNewList( const tr_benc * val )
660{
661    int i, n;
662    struct SaveNode * node;
663
664    assert( tr_bencIsList( val ) );
665
666    n = val->val.l.count;
667    node = tr_new0( struct SaveNode, 1 );
668    node->val = val;
669    node->childCount = n;
670    node->children = tr_new0( int, n );
671    for( i=0; i<n; ++i ) /* a list's children don't need to be reordered */
672        node->children[i] = i;
673
674    return node;
675}
676
677static struct SaveNode*
678nodeNewLeaf( const tr_benc * val )
679{
680    struct SaveNode * node;
681
682    assert( !isContainer( val ) );
683
684    node = tr_new0( struct SaveNode, 1 );
685    node->val = val;
686    return node;
687}
688
689static struct SaveNode*
690nodeNew( const tr_benc * val )
691{
692    struct SaveNode * node;
693
694    if( tr_bencIsList( val ) )
695        node = nodeNewList( val );
696    else if( tr_bencIsDict( val ) )
697        node = nodeNewDict( val );
698    else
699        node = nodeNewLeaf( val );
700
701    return node;
702}
703
704typedef void (*BencWalkFunc)( const tr_benc * val, void * user_data );
705
706struct WalkFuncs
707{
708    BencWalkFunc intFunc;
709    BencWalkFunc stringFunc;
710    BencWalkFunc dictBeginFunc;
711    BencWalkFunc listBeginFunc;
712    BencWalkFunc containerEndFunc;
713};
714
715/**
716 * This function's previous recursive implementation was
717 * easier to read, but was vulnerable to a smash-stacking
718 * attack via maliciously-crafted bencoded data. (#667)
719 */
720static void
721bencWalk( const tr_benc   * top,
722          struct WalkFuncs   * walkFuncs,
723          void               * user_data )
724{
725    tr_ptrArray * stack = tr_ptrArrayNew( );
726    tr_ptrArrayAppend( stack, nodeNew( top ) );
727
728    while( !tr_ptrArrayEmpty( stack ) )
729    {
730        struct SaveNode * node = tr_ptrArrayBack( stack );
731        const tr_benc * val;
732
733        if( !node->valIsVisited )
734        {
735            val = node->val;
736            node->valIsVisited = TRUE;
737        }
738        else if( node->childIndex < node->childCount )
739        {
740            const int index = node->children[ node->childIndex++ ];
741            val = node->val->val.l.vals +  index;
742        }
743        else /* done with this node */
744        {
745            if( isContainer( node->val ) )
746                walkFuncs->containerEndFunc( node->val, user_data );
747            tr_ptrArrayPop( stack );
748            tr_free( node->children );
749            tr_free( node );
750            continue;
751        }
752
753        switch( val->type )
754        {
755            case TYPE_INT:
756                walkFuncs->intFunc( val, user_data );
757                break;
758
759            case TYPE_STR:
760                walkFuncs->stringFunc( val, user_data );
761                break;
762
763            case TYPE_LIST:
764                if( val != node->val )
765                    tr_ptrArrayAppend( stack, nodeNew( val ) );
766                else
767                    walkFuncs->listBeginFunc( val, user_data );
768                break;
769
770            case TYPE_DICT:
771                if( val != node->val )
772                    tr_ptrArrayAppend( stack, nodeNew( val ) );
773                else
774                    walkFuncs->dictBeginFunc( val, user_data );
775                break;
776
777            default:
778                /* did caller give us an uninitialized val? */
779                tr_err( _( "Invalid metadata" ) );
780                break;
781        }
782    }
783
784    tr_ptrArrayFree( stack, NULL );
785}
786
787/****
788*****
789****/
790
791static void
792saveIntFunc( const tr_benc * val, void * evbuf )
793{
794    evbuffer_add_printf( evbuf, "i%"PRId64"e", val->val.i );
795}
796static void
797saveStringFunc( const tr_benc * val, void * vevbuf )
798{
799    struct evbuffer * evbuf = vevbuf;
800    evbuffer_add_printf( evbuf, "%d:", val->val.s.i );
801    evbuffer_add( evbuf, val->val.s.s, val->val.s.i );
802}
803static void
804saveDictBeginFunc( const tr_benc * val UNUSED, void * evbuf )
805{
806    evbuffer_add_printf( evbuf, "d" );
807}
808static void
809saveListBeginFunc( const tr_benc * val UNUSED, void * evbuf )
810{
811    evbuffer_add_printf( evbuf, "l" );
812}
813static void
814saveContainerEndFunc( const tr_benc * val UNUSED, void * evbuf )
815{
816    evbuffer_add_printf( evbuf, "e" );
817}
818char*
819tr_bencSave( const tr_benc * top, int * len )
820{
821    char * ret;
822    struct WalkFuncs walkFuncs;
823    struct evbuffer * out = evbuffer_new( );
824
825    walkFuncs.intFunc = saveIntFunc;
826    walkFuncs.stringFunc = saveStringFunc;
827    walkFuncs.dictBeginFunc = saveDictBeginFunc;
828    walkFuncs.listBeginFunc = saveListBeginFunc;
829    walkFuncs.containerEndFunc = saveContainerEndFunc;
830    bencWalk( top, &walkFuncs, out );
831   
832    if( len != NULL )
833        *len = EVBUFFER_LENGTH( out );
834    ret = tr_strndup( (char*) EVBUFFER_DATA( out ), EVBUFFER_LENGTH( out ) );
835    evbuffer_free( out );
836    return ret;
837}
838
839/***
840****
841***/
842
843static void
844freeDummyFunc( const tr_benc * val UNUSED, void * buf UNUSED  )
845{
846}
847static void
848freeStringFunc( const tr_benc * val, void * freeme )
849{
850    if( !val->val.s.nofree )
851        tr_ptrArrayAppend( freeme, val->val.s.s );
852}
853static void
854freeContainerBeginFunc( const tr_benc * val, void * freeme )
855{
856    tr_ptrArrayAppend( freeme, val->val.l.vals );
857}
858void
859tr_bencFree( tr_benc * val )
860{
861    if( val != NULL )
862    {
863        tr_ptrArray * freeme = tr_ptrArrayNew( );
864        struct WalkFuncs walkFuncs;
865
866        walkFuncs.intFunc = freeDummyFunc;
867        walkFuncs.stringFunc = freeStringFunc;
868        walkFuncs.dictBeginFunc = freeContainerBeginFunc;
869        walkFuncs.listBeginFunc = freeContainerBeginFunc;
870        walkFuncs.containerEndFunc = freeDummyFunc;
871        bencWalk( val, &walkFuncs, freeme );
872
873        tr_ptrArrayFree( freeme, tr_free );
874    }
875}
876
877/***
878****
879***/
880
881struct WalkPrint
882{
883    int depth;
884    FILE * out;
885};
886static void
887printLeadingSpaces( struct WalkPrint * data )
888{
889    const int width = data->depth * 2;
890    fprintf( data->out, "%*.*s", width, width, " " );
891}
892static void
893printIntFunc( const tr_benc * val, void * vdata )
894{
895    struct WalkPrint * data = vdata;
896    printLeadingSpaces( data );
897    fprintf( data->out, "int:  %"PRId64"\n", val->val.i );
898}
899static void
900printStringFunc( const tr_benc * val, void * vdata )
901{
902    int ii;
903    struct WalkPrint * data = vdata;
904    printLeadingSpaces( data );
905    fprintf( data->out, "string:  " );
906    for( ii = 0; val->val.s.i > ii; ii++ )
907    {
908        if( '\\' == val->val.s.s[ii] ) {
909            putc( '\\', data->out );
910            putc( '\\', data->out );
911        } else if( isprint( val->val.s.s[ii] ) ) {
912            putc( val->val.s.s[ii], data->out );
913        } else {
914            fprintf( data->out, "\\x%02x", val->val.s.s[ii] );
915        }
916    }
917    fprintf( data->out, "\n" );
918}
919static void
920printListBeginFunc( const tr_benc * val UNUSED, void * vdata )
921{
922    struct WalkPrint * data = vdata;
923    printLeadingSpaces( data );
924    fprintf( data->out, "list\n" );
925    ++data->depth;
926}
927static void
928printDictBeginFunc( const tr_benc * val UNUSED, void * vdata )
929{
930    struct WalkPrint * data = vdata;
931    printLeadingSpaces( data );
932    fprintf( data->out, "dict\n" );
933    ++data->depth;
934}
935static void
936printContainerEndFunc( const tr_benc * val UNUSED, void * vdata )
937{
938    struct WalkPrint * data = vdata;
939    --data->depth;
940}
941void
942tr_bencPrint( const tr_benc * val )
943{
944    struct WalkFuncs walkFuncs;
945    struct WalkPrint walkPrint;
946
947    walkFuncs.intFunc = printIntFunc;
948    walkFuncs.stringFunc = printStringFunc;
949    walkFuncs.dictBeginFunc = printDictBeginFunc;
950    walkFuncs.listBeginFunc = printListBeginFunc;
951    walkFuncs.containerEndFunc = printContainerEndFunc;
952
953    walkPrint.out = stderr;
954    walkPrint.depth = 0;
955    bencWalk( val, &walkFuncs, &walkPrint );
956}
957
958/***
959****
960***/
961
962struct ParentState
963{
964    int type;
965    int index;
966};
967 
968struct phpWalk
969{
970    tr_list * parents;
971    struct evbuffer * out;
972};
973
974static void
975phpChildFunc( struct phpWalk * data )
976{
977    if( data->parents )
978    {
979        struct ParentState * parentState = data->parents->data;
980
981        if( parentState->type == TYPE_LIST )
982            evbuffer_add_printf( data->out, "i:%d;", parentState->index++ );
983    }
984}
985
986static void
987phpPushParent( struct phpWalk * data, int type )
988{
989    struct ParentState * parentState = tr_new( struct ParentState, 1 );
990    parentState->type = type;
991    parentState->index = 0;
992    tr_list_prepend( &data->parents, parentState );
993}
994
995static void
996phpPopParent( struct phpWalk * data )
997{
998    tr_free( tr_list_pop_front( &data->parents ) );
999}
1000
1001static void
1002phpIntFunc( const tr_benc * val, void * vdata )
1003{
1004    struct phpWalk * data = vdata;
1005    phpChildFunc( data );
1006    evbuffer_add_printf( data->out, "i:%"PRId64";", val->val.i );
1007}
1008static void
1009phpStringFunc( const tr_benc * val, void * vdata )
1010{
1011    struct phpWalk * data = vdata;
1012    phpChildFunc( data );
1013    evbuffer_add_printf( data->out, "s:%d:\"%s\";", val->val.s.i, val->val.s.s );
1014}
1015static void
1016phpDictBeginFunc( const tr_benc * val, void * vdata )
1017{
1018    struct phpWalk * data = vdata;
1019    phpChildFunc( data );
1020    phpPushParent( data, TYPE_DICT );
1021    evbuffer_add_printf( data->out, "a:%d:{", val->val.l.count/2 );
1022}
1023static void
1024phpListBeginFunc( const tr_benc * val, void * vdata )
1025{
1026    struct phpWalk * data = vdata;
1027    phpChildFunc( data );
1028    phpPushParent( data, TYPE_LIST );
1029    evbuffer_add_printf( data->out, "a:%d:{", val->val.l.count );
1030}
1031static void
1032phpContainerEndFunc( const tr_benc * val UNUSED, void * vdata )
1033{
1034    struct phpWalk * data = vdata;
1035    phpPopParent( data );
1036    evbuffer_add_printf( data->out, "}" );
1037}
1038char*
1039tr_bencSaveAsSerializedPHP( const tr_benc * top, int * len )
1040{
1041    char * ret;
1042    struct WalkFuncs walkFuncs;
1043    struct phpWalk data;
1044
1045    data.out = evbuffer_new( );
1046    data.parents = NULL;
1047
1048    walkFuncs.intFunc = phpIntFunc;
1049    walkFuncs.stringFunc = phpStringFunc;
1050    walkFuncs.dictBeginFunc = phpDictBeginFunc;
1051    walkFuncs.listBeginFunc = phpListBeginFunc;
1052    walkFuncs.containerEndFunc = phpContainerEndFunc;
1053
1054    bencWalk( top, &walkFuncs, &data );
1055   
1056    if( len != NULL )
1057        *len = EVBUFFER_LENGTH( data.out );
1058    ret = tr_strndup( (char*) EVBUFFER_DATA( data.out ), EVBUFFER_LENGTH( data.out ) );
1059    evbuffer_free( data.out );
1060    return ret;
1061}
1062
1063/***
1064****
1065***/
1066
1067int
1068tr_bencSaveFile( const char * filename,  const tr_benc * b )
1069{
1070    int ret = TR_OK;
1071    int len;
1072    char * content = tr_bencSave( b, &len );
1073    FILE * out = NULL;
1074
1075    out = fopen( filename, "wb+" );
1076    if( !out )
1077    {
1078        tr_err( _( "Couldn't open \"%1$s\": %2$s" ),
1079                filename, tr_strerror( errno ) );
1080        ret = TR_EINVALID;
1081    }
1082    else if( fwrite( content, sizeof( char ), len, out ) != (size_t)len )
1083    {
1084        tr_err( _( "Couldn't save file \"%1$s\": %2$s" ),
1085                filename, tr_strerror( errno ) );
1086        ret = TR_EINVALID;
1087    }
1088
1089    tr_dbg( "tr_bencSaveFile returned %d when saving \"%s\"", ret, filename );
1090    tr_free( content );
1091    if( out )
1092        fclose( out );
1093    return ret;
1094}
1095
1096int
1097tr_bencLoadFile( const char * filename, tr_benc * b )
1098{
1099    int ret = TR_ERROR;
1100    size_t contentLen;
1101    uint8_t * content = tr_loadFile( filename, &contentLen );
1102    ret = content ? tr_bencLoad( content, contentLen, b, NULL )
1103                  : TR_ERROR_IO_OTHER;
1104    tr_free( content );
1105    return ret;
1106}
Note: See TracBrowser for help on using the repository browser.