source: trunk/libtransmission/bencode.c @ 3747

Last change on this file since 3747 was 3747, checked in by charles, 15 years ago

fix libevent #include quirk reported by SoftwareElves?

  • Property svn:keywords set to Date Rev Author Id
File size: 12.3 KB
Line 
1/******************************************************************************
2 * $Id: bencode.c 3747 2007-11-07 03:13:04Z charles $
3 *
4 * Copyright (c) 2005-2007 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 <stdarg.h>
28#include <stdio.h>
29#include <stdlib.h>
30
31#include <sys/queue.h> /* libevent needs this */
32#include <sys/types.h> /* libevent needs this */
33#include <event.h>
34
35#include "transmission.h"
36#include "bencode.h"
37#include "utils.h"
38
39/* setting to 1 to help expose bugs with tr_bencListAdd and tr_bencDictAdd */
40#define LIST_SIZE   20 /* number of items to increment list/dict buffer by */
41
42static int makeroom( benc_val_t * val, int count )
43{
44    assert( TYPE_LIST == val->type || TYPE_DICT == val->type );
45
46    if( val->val.l.count + count > val->val.l.alloc )
47    {
48        /* We need a bigger boat */
49        const int len = val->val.l.alloc + count +
50            ( count % LIST_SIZE ? LIST_SIZE - ( count % LIST_SIZE ) : 0 );
51        void * new = realloc( val->val.l.vals, len * sizeof( benc_val_t ) );
52        if( NULL == new )
53            return 1;
54
55        val->val.l.alloc = len;
56        val->val.l.vals  = new;
57    }
58
59    return 0;
60}
61
62int _tr_bencLoad( char * buf, int len, benc_val_t * val, char ** end )
63{
64    char * p, * e, * foo;
65
66    if( !end )
67    {
68        /* So we only have to check once */
69        end = &foo;
70    }
71
72    for( ;; )
73    {
74        if( !buf || len<1 ) /* no more text to parse... */
75            return 1;
76
77        if( *buf=='i' ) /* Integer: i1234e */
78        {
79            int64_t num;
80
81            e = memchr( &buf[1], 'e', len - 1 );
82            if( !e )
83                return 1;
84
85            *e = '\0';
86            num = strtoll( &buf[1], &p, 10 );
87            *e = 'e';
88
89            if( p != e )
90                return 1;
91
92            tr_bencInitInt( val, num );
93            *end = p + 1;
94            break;
95        }
96        else if( *buf=='l' || *buf=='d' )
97        {
98            /* List: l<item1><item2>e
99               Dict: d<string1><item1><string2><item2>e
100               A dictionary is just a special kind of list with an even
101               count of items, and where even items are strings. */
102            char * cur;
103            char   is_dict;
104            char   str_expected;
105
106            is_dict      = ( buf[0] == 'd' );
107            cur          = &buf[1];
108            str_expected = 1;
109            tr_bencInit( val, ( is_dict ? TYPE_DICT : TYPE_LIST ) );
110            while( cur - buf < len && cur[0] != 'e' )
111            {
112                if( makeroom( val, 1 ) ||
113                    tr_bencLoad( cur, len - (cur - buf),
114                                 &val->val.l.vals[val->val.l.count], &p ) )
115                {
116                    tr_bencFree( val );
117                    return 1;
118                }
119                val->val.l.count++;
120                if( is_dict && str_expected &&
121                    val->val.l.vals[val->val.l.count - 1].type != TYPE_STR )
122                {
123                    tr_bencFree( val );
124                    return 1;
125                }
126                str_expected = !str_expected;
127
128                cur = p;
129            }
130
131            if( is_dict && ( val->val.l.count & 1 ) )
132            {
133                tr_bencFree( val );
134                return 1;
135            }
136
137            *end = cur + 1;
138            break;
139        }
140        else if( isdigit(*buf) )
141        {
142            int    slen;
143            char * sbuf;
144
145            e = memchr( buf, ':', len );
146            if( NULL == e )
147            {
148                return 1;
149            }
150
151            /* String: 12:whateverword */
152            e[0] = '\0';
153            slen = strtol( buf, &p, 10 );
154            e[0] = ':';
155
156            if( p != e || 0 > slen || len - ( ( p + 1 ) - buf ) < slen )
157            {
158                return 1;
159            }
160
161            sbuf = malloc( slen + 1 );
162            if( NULL == sbuf )
163            {
164                return 1;
165            }
166
167            memcpy( sbuf, p + 1, slen );
168            sbuf[slen] = '\0';
169            tr_bencInitStr( val, sbuf, slen, 0 );
170
171            *end = p + 1 + val->val.s.i;
172            break;
173        }
174        else /* invalid bencoded text... march past it */
175        {
176            ++buf;
177            --len;
178        }
179    }
180
181    val->begin = buf;
182    val->end   = *end;
183
184    return 0;
185}
186
187static void __bencPrint( benc_val_t * val, int space )
188{
189    int ii;
190
191    for( ii = 0; ii < space; ii++ )
192    {
193        putc( ' ', stderr );
194    }
195
196    switch( val->type )
197    {
198        case TYPE_INT:
199            fprintf( stderr, "int:  %"PRId64"\n", val->val.i );
200            break;
201
202        case TYPE_STR:
203            for( ii = 0; val->val.s.i > ii; ii++ )
204            {
205                if( '\\' == val->val.s.s[ii] )
206                {
207                    putc( '\\', stderr );
208                    putc( '\\', stderr );
209                }
210                else if( isprint( val->val.s.s[ii] ) )
211                {
212                    putc( val->val.s.s[ii], stderr );
213                }
214                else
215                {
216                    fprintf( stderr, "\\x%02x", val->val.s.s[ii] );
217                }
218            }
219            putc( '\n', stderr );
220            break;
221
222        case TYPE_LIST:
223            fprintf( stderr, "list\n" );
224            for( ii = 0; ii < val->val.l.count; ii++ )
225            {
226                __bencPrint( &val->val.l.vals[ii], space + 1 );
227            }
228            break;
229
230        case TYPE_DICT:
231            fprintf( stderr, "dict\n" );
232            for( ii = 0; ii < val->val.l.count; ii++ )
233            {
234                __bencPrint( &val->val.l.vals[ii], space + 1 );
235            }
236            break;
237    }
238}
239
240void tr_bencPrint( benc_val_t * val )
241{
242    __bencPrint( val, 0 );
243}
244
245void tr_bencFree( benc_val_t * val )
246{
247    int i;
248
249    switch( val->type )
250    {
251        case TYPE_INT:
252            break;
253
254        case TYPE_STR:
255            if( !val->val.s.nofree )
256            {
257                free( val->val.s.s );
258            }
259            break;
260
261        case TYPE_LIST:
262        case TYPE_DICT:
263            for( i = 0; i < val->val.l.count; i++ )
264            {
265                tr_bencFree( &val->val.l.vals[i] );
266            }
267            free( val->val.l.vals );
268            break;
269    }
270}
271
272benc_val_t * tr_bencDictFind( benc_val_t * val, const char * key )
273{
274    int len, ii;
275
276    if( val->type != TYPE_DICT )
277    {
278        return NULL;
279    }
280
281    len = strlen( key );
282   
283    for( ii = 0; ii + 1 < val->val.l.count; ii += 2 )
284    {
285        if( TYPE_STR  != val->val.l.vals[ii].type ||
286            len       != val->val.l.vals[ii].val.s.i ||
287            0 != memcmp( val->val.l.vals[ii].val.s.s, key, len ) )
288        {
289            continue;
290        }
291        return &val->val.l.vals[ii+1];
292    }
293
294    return NULL;
295}
296
297benc_val_t * tr_bencDictFindFirst( benc_val_t * val, ... )
298{
299    const char * key;
300    benc_val_t * ret;
301    va_list      ap;
302
303    ret = NULL;
304    va_start( ap, val );
305    while( ( key = va_arg( ap, const char * ) ) )
306    {
307        ret = tr_bencDictFind( val, key );
308        if( NULL != ret )
309        {
310            break;
311        }
312    }
313    va_end( ap );
314
315    return ret;
316}
317
318char * tr_bencStealStr( benc_val_t * val )
319{
320    assert( TYPE_STR == val->type );
321    val->val.s.nofree = 1;
322    return val->val.s.s;
323}
324
325void _tr_bencInitStr( benc_val_t * val, char * str, int len, int nofree )
326{
327    tr_bencInit( val, TYPE_STR );
328    val->val.s.s      = str;
329    val->val.s.nofree = nofree;
330    if( 0 >= len )
331    {
332        len = ( NULL == str ? 0 : strlen( str ) );
333    }
334    val->val.s.i = len;
335}
336
337int tr_bencInitStrDup( benc_val_t * val, const char * str )
338{
339    char * newStr = tr_strdup( str );
340    if( newStr == NULL )
341        return 1;
342
343    _tr_bencInitStr( val, newStr, 0, 0 );
344    return 0;
345}
346
347void tr_bencInitInt( benc_val_t * val, int64_t num )
348{
349    tr_bencInit( val, TYPE_INT );
350    val->val.i = num;
351}
352
353int tr_bencListReserve( benc_val_t * val, int count )
354{
355    assert( TYPE_LIST == val->type );
356
357    return makeroom( val, count );
358}
359
360int tr_bencDictReserve( benc_val_t * val, int count )
361{
362    assert( TYPE_DICT == val->type );
363
364    return makeroom( val, count * 2 );
365}
366
367benc_val_t * tr_bencListAdd( benc_val_t * list )
368{
369    benc_val_t * item;
370
371    assert( tr_bencIsList( list ) );
372    assert( list->val.l.count < list->val.l.alloc );
373
374    item = &list->val.l.vals[list->val.l.count];
375    list->val.l.count++;
376    tr_bencInit( item, TYPE_INT );
377
378    return item;
379}
380
381benc_val_t * tr_bencDictAdd( benc_val_t * dict, const char * key )
382{
383    benc_val_t * keyval, * itemval;
384
385    assert( tr_bencIsDict( dict ) );
386    assert( dict->val.l.count + 2 <= dict->val.l.alloc );
387
388    keyval = dict->val.l.vals + dict->val.l.count++;
389    tr_bencInitStr( keyval, (char*)key, -1, 1 );
390
391    itemval = dict->val.l.vals + dict->val.l.count++;
392    tr_bencInit( itemval, TYPE_INT );
393
394    return itemval;
395}
396
397struct KeyIndex
398{
399    const char * key;
400    int index;
401};
402
403static int compareKeyIndex( const void * va, const void * vb )
404{
405    const struct KeyIndex * a = va;
406    const struct KeyIndex * b = vb;
407    return strcmp( a->key, b->key );
408}
409
410static void
411saveImpl( struct evbuffer * out, const benc_val_t * val )
412{
413    int ii;
414
415    switch( val->type )
416    {
417        case TYPE_INT:
418            evbuffer_add_printf( out, "i%"PRId64"e", val->val.i );
419            break;
420
421        case TYPE_STR:
422            evbuffer_add_printf( out, "%i:%s", (int)val->val.i, val->val.s.s );
423            break;
424
425        case TYPE_LIST:
426            evbuffer_add_printf( out, "l" );
427            for( ii = 0; val->val.l.count > ii; ii++ )
428                saveImpl( out, val->val.l.vals + ii );
429            evbuffer_add_printf( out, "e" );
430            break;
431
432        case TYPE_DICT:
433            /* Keys must be strings and appear in sorted order
434               (sorted as raw strings, not alphanumerics). */
435            evbuffer_add_printf( out, "d" );
436            if( 1 ) {
437                int i;
438                struct KeyIndex * indices = tr_new( struct KeyIndex, val->val.l.count );
439                for( ii=i=0; i<val->val.l.count; i+=2 ) {
440                    indices[ii].key = val->val.l.vals[i].val.s.s;
441                    indices[ii].index = i;
442                    ii++;
443                }
444                qsort( indices, ii, sizeof(struct KeyIndex), compareKeyIndex );
445                for( i=0; i<ii; ++i ) {
446                    const int index = indices[i].index;
447                    saveImpl( out, val->val.l.vals + index );
448                    saveImpl( out, val->val.l.vals + index + 1 );
449                }
450                tr_free( indices );
451            }
452            evbuffer_add_printf( out, "e" );
453            break;
454    }
455}
456
457char*
458tr_bencSave( const benc_val_t * val, int * len )
459{
460    struct evbuffer * buf = evbuffer_new( );
461    char * ret;
462    saveImpl( buf, val );
463    if( len != NULL )
464        *len = EVBUFFER_LENGTH( buf );
465    ret = tr_strndup( (char*) EVBUFFER_DATA( buf ), EVBUFFER_LENGTH( buf ) );
466    evbuffer_free( buf );
467    return ret;
468}
469
470/**
471***
472**/
473
474int
475tr_bencIsStr ( const benc_val_t * val )
476{
477    return val!=NULL && val->type==TYPE_STR;
478}
479
480int
481tr_bencIsInt ( const benc_val_t * val )
482{
483    return val!=NULL && val->type==TYPE_INT;
484}
485
486int
487tr_bencIsList( const benc_val_t * val )
488{
489    return val!=NULL && val->type==TYPE_LIST;
490}
491
492int
493tr_bencIsDict( const benc_val_t * val )
494{
495    return val!=NULL && val->type==TYPE_DICT;
496}
Note: See TracBrowser for help on using the repository browser.