source: trunk/libtransmission/utils.c @ 11250

Last change on this file since 11250 was 11250, checked in by charles, 11 years ago

(trunk daemon) #3511, part 2 of 2: get rid of the TR_DEBUG environment variable

  • Property svn:keywords set to Date Rev Author Id
File size: 38.3 KB
Line 
1/*
2 * This file Copyright (C) 2009-2010 Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: utils.c 11250 2010-09-22 15:17:16Z charles $
11 */
12
13#ifdef HAVE_MEMMEM
14 #define _GNU_SOURCE /* glibc's string.h needs this to pick up memmem */
15#endif
16
17#if defined(SYS_DARWIN)
18 #define HAVE_GETPAGESIZE
19 #define HAVE_ICONV_OPEN
20 #define HAVE_VALLOC
21 #undef HAVE_POSIX_MEMALIGN /* not supported on OS X 10.5 and lower */
22#endif
23
24#include <assert.h>
25#include <ctype.h> /* isalpha(), tolower() */
26#include <errno.h>
27#include <math.h> /* pow(), fabs() */
28#include <stdarg.h>
29#include <stdio.h>
30#include <stdlib.h>
31#include <string.h> /* strerror(), memset(), memmem() */
32#include <time.h> /* nanosleep() */
33
34#ifdef HAVE_ICONV_OPEN
35 #include <iconv.h>
36#endif
37#include <libgen.h> /* basename() */
38#include <sys/time.h>
39#include <sys/types.h>
40#include <sys/stat.h>
41#include <unistd.h> /* stat(), getcwd(), getpagesize() */
42
43#include "event.h"
44
45#ifdef WIN32
46 #include <w32api.h>
47 #define WINVER WindowsXP /* freeaddrinfo(), getaddrinfo(), getnameinfo() */
48 #include <direct.h> /* _getcwd() */
49 #include <windows.h> /* Sleep() */
50#endif
51
52#include "transmission.h"
53#include "bencode.h"
54#include "fdlimit.h"
55#include "ConvertUTF.h"
56#include "list.h"
57#include "net.h"
58#include "utils.h"
59#include "platform.h"
60#include "version.h"
61
62
63time_t transmission_now = 0;
64
65tr_msg_level messageLevel = TR_MSG_ERR;
66static tr_bool        messageQueuing = FALSE;
67static tr_msg_list *  messageQueue = NULL;
68static tr_msg_list ** messageQueueTail = &messageQueue;
69static int            messageQueueCount = 0;
70
71#ifndef WIN32
72    /* make null versions of these win32 functions */
73    static inline int IsDebuggerPresent( void ) { return FALSE; }
74    static inline void OutputDebugString( const void * unused UNUSED ) { }
75#endif
76
77/***
78****
79***/
80
81static tr_lock*
82getMessageLock( void )
83{
84    static tr_lock * l = NULL;
85
86    if( !l )
87        l = tr_lockNew( );
88
89    return l;
90}
91
92FILE*
93tr_getLog( void )
94{
95    static tr_bool initialized = FALSE;
96    static FILE * file = NULL;
97
98    if( !initialized )
99    {
100        const char * str = getenv( "TR_DEBUG_FD" );
101        int          fd = 0;
102        if( str && *str )
103            fd = atoi( str );
104        switch( fd )
105        {
106            case 1:
107                file = stdout; break;
108
109            case 2:
110                file = stderr; break;
111
112            default:
113                file = NULL; break;
114        }
115        initialized = TRUE;
116    }
117
118    return file;
119}
120
121void
122tr_setMessageLevel( tr_msg_level level )
123{
124    messageLevel = level;
125}
126
127tr_msg_level
128tr_getMessageLevel( void )
129{
130    return messageLevel;
131}
132
133void
134tr_setMessageQueuing( tr_bool enabled )
135{
136    messageQueuing = enabled;
137}
138
139tr_bool
140tr_getMessageQueuing( void )
141{
142    return messageQueuing != 0;
143}
144
145tr_msg_list *
146tr_getQueuedMessages( void )
147{
148    tr_msg_list * ret;
149    tr_lockLock( getMessageLock( ) );
150
151    ret = messageQueue;
152    messageQueue = NULL;
153    messageQueueTail = &messageQueue;
154
155    messageQueueCount = 0;
156
157    tr_lockUnlock( getMessageLock( ) );
158    return ret;
159}
160
161void
162tr_freeMessageList( tr_msg_list * list )
163{
164    tr_msg_list * next;
165
166    while( NULL != list )
167    {
168        next = list->next;
169        free( list->message );
170        free( list->name );
171        free( list );
172        list = next;
173    }
174}
175
176/**
177***
178**/
179
180struct tm *
181tr_localtime_r( const time_t *_clock, struct tm *_result )
182{
183#ifdef HAVE_LOCALTIME_R
184    return localtime_r( _clock, _result );
185#else
186    struct tm *p = localtime( _clock );
187    if( p )
188        *(_result) = *p;
189    return p;
190#endif
191}
192
193char*
194tr_getLogTimeStr( char * buf, int buflen )
195{
196    char           tmp[64];
197    struct tm      now_tm;
198    struct timeval tv;
199    time_t         seconds;
200    int            milliseconds;
201
202    gettimeofday( &tv, NULL );
203
204    seconds = tv.tv_sec;
205    tr_localtime_r( &seconds, &now_tm );
206    strftime( tmp, sizeof( tmp ), "%H:%M:%S", &now_tm );
207    milliseconds = (int)( tv.tv_usec / 1000 );
208    tr_snprintf( buf, buflen, "%s.%03d", tmp, milliseconds );
209
210    return buf;
211}
212
213tr_bool
214tr_deepLoggingIsActive( void )
215{
216    static int8_t deepLoggingIsActive = -1;
217
218    if( deepLoggingIsActive < 0 )
219        deepLoggingIsActive = IsDebuggerPresent() || (tr_getLog()!=NULL);
220
221    return deepLoggingIsActive != 0;
222}
223
224void
225tr_deepLog( const char  * file,
226            int           line,
227            const char  * name,
228            const char  * fmt,
229            ... )
230{
231    FILE * fp = tr_getLog( );
232    if( fp || IsDebuggerPresent( ) )
233    {
234        va_list           args;
235        char              timestr[64];
236        struct evbuffer * buf = evbuffer_new( );
237        char *            base = tr_basename( file );
238
239        evbuffer_add_printf( buf, "[%s] ",
240                            tr_getLogTimeStr( timestr, sizeof( timestr ) ) );
241        if( name )
242            evbuffer_add_printf( buf, "%s ", name );
243        va_start( args, fmt );
244        evbuffer_add_vprintf( buf, fmt, args );
245        va_end( args );
246        evbuffer_add_printf( buf, " (%s:%d)\n", base, line );
247        /* FIXME(libevent2) ifdef this out for nonwindows platforms */
248        OutputDebugString( EVBUFFER_DATA( buf ) );
249        if(fp) /* FIXME(libevent2) tr_getLog() should return an fd, then use evbuffer_write() here ) */
250            (void) fwrite( EVBUFFER_DATA( buf ), 1, EVBUFFER_LENGTH( buf ), fp );
251
252        tr_free( base );
253        evbuffer_free( buf );
254    }
255}
256
257/***
258****
259***/
260
261void
262tr_msg( const char * file, int line,
263        tr_msg_level level,
264        const char * name,
265        const char * fmt, ... )
266{
267    const int err = errno; /* message logging shouldn't affect errno */
268    char buf[1024];
269    va_list ap;
270    tr_lockLock( getMessageLock( ) );
271
272    /* build the text message */
273    *buf = '\0';
274    va_start( ap, fmt );
275    evutil_vsnprintf( buf, sizeof( buf ), fmt, ap );
276    va_end( ap );
277
278    OutputDebugString( buf );
279
280    if( *buf )
281    {
282        if( messageQueuing )
283        {
284            tr_msg_list * newmsg;
285            newmsg = tr_new0( tr_msg_list, 1 );
286            newmsg->level = level;
287            newmsg->when = tr_time( );
288            newmsg->message = tr_strdup( buf );
289            newmsg->file = file;
290            newmsg->line = line;
291            newmsg->name = tr_strdup( name );
292
293            *messageQueueTail = newmsg;
294            messageQueueTail = &newmsg->next;
295            ++messageQueueCount;
296
297            if( messageQueueCount > TR_MAX_MSG_LOG )
298            {
299                tr_msg_list * old = messageQueue;
300                messageQueue = old->next;
301                old->next = NULL;
302                tr_freeMessageList(old);
303
304                --messageQueueCount;
305
306                assert( messageQueueCount == TR_MAX_MSG_LOG );
307            }
308        }
309        else
310        {
311            char timestr[64];
312            FILE * fp;
313
314            fp = tr_getLog( );
315            if( fp == NULL )
316                fp = stderr;
317
318            tr_getLogTimeStr( timestr, sizeof( timestr ) );
319
320            if( name )
321                fprintf( fp, "[%s] %s: %s\n", timestr, name, buf );
322            else
323                fprintf( fp, "[%s] %s\n", timestr, buf );
324            fflush( fp );
325        }
326    }
327
328    tr_lockUnlock( getMessageLock( ) );
329    errno = err;
330}
331
332/***
333****
334***/
335
336void
337tr_set_compare( const void * va,
338                size_t aCount,
339                const void * vb,
340                size_t bCount,
341                int compare( const void * a, const void * b ),
342                size_t elementSize,
343                tr_set_func in_a_cb,
344                tr_set_func in_b_cb,
345                tr_set_func in_both_cb,
346                void * userData )
347{
348    const uint8_t * a = (const uint8_t *) va;
349    const uint8_t * b = (const uint8_t *) vb;
350    const uint8_t * aend = a + elementSize * aCount;
351    const uint8_t * bend = b + elementSize * bCount;
352
353    while( a != aend || b != bend )
354    {
355        if( a == aend )
356        {
357            ( *in_b_cb )( (void*)b, userData );
358            b += elementSize;
359        }
360        else if( b == bend )
361        {
362            ( *in_a_cb )( (void*)a, userData );
363            a += elementSize;
364        }
365        else
366        {
367            const int val = ( *compare )( a, b );
368
369            if( !val )
370            {
371                ( *in_both_cb )( (void*)a, userData );
372                a += elementSize;
373                b += elementSize;
374            }
375            else if( val < 0 )
376            {
377                ( *in_a_cb )( (void*)a, userData );
378                a += elementSize;
379            }
380            else if( val > 0 )
381            {
382                ( *in_b_cb )( (void*)b, userData );
383                b += elementSize;
384            }
385        }
386    }
387}
388
389/***
390****
391***/
392
393const char*
394tr_strip_positional_args( const char* str )
395{
396    const char * in = str;
397    static size_t bufsize = 0;
398    static char * buf = NULL;
399    const size_t  len = strlen( str );
400    char *        out;
401
402    if( bufsize < len )
403    {
404        bufsize = len * 2;
405        buf = tr_renew( char, buf, bufsize );
406    }
407
408    for( out = buf; *str; ++str )
409    {
410        *out++ = *str;
411
412        if( ( *str == '%' ) && isdigit( str[1] ) )
413        {
414            const char * tmp = str + 1;
415            while( isdigit( *tmp ) )
416                ++tmp;
417            if( *tmp == '$' )
418                str = tmp[1]=='\'' ? tmp+1 : tmp;
419        }
420
421        if( ( *str == '%' ) && ( str[1] == '\'' ) )
422            str = str + 1;
423 
424    }
425    *out = '\0';
426
427    return strcmp( buf, in ) ? buf : in;
428}
429
430/**
431***
432**/
433
434void
435tr_timerAdd( struct event * timer, int seconds, int microseconds )
436{
437    struct timeval tv;
438    tv.tv_sec = seconds;
439    tv.tv_usec = microseconds;
440
441    assert( tv.tv_sec >= 0 );
442    assert( tv.tv_usec >= 0 );
443    assert( tv.tv_usec < 1000000 );
444
445    evtimer_add( timer, &tv );
446}
447
448void
449tr_timerAddMsec( struct event * timer, int msec )
450{
451    const int seconds =  msec / 1000;
452    const int usec = (msec%1000) * 1000;
453    tr_timerAdd( timer, seconds, usec );
454}
455
456/**
457***
458**/
459
460uint8_t *
461tr_loadFile( const char * path,
462             size_t *     size )
463{
464    uint8_t * buf;
465    struct stat  sb;
466    int fd;
467    ssize_t n;
468    const char * const err_fmt = _( "Couldn't read \"%1$s\": %2$s" );
469
470    /* try to stat the file */
471    errno = 0;
472    if( stat( path, &sb ) )
473    {
474        const int err = errno;
475        tr_dbg( err_fmt, path, tr_strerror( errno ) );
476        errno = err;
477        return NULL;
478    }
479
480    if( ( sb.st_mode & S_IFMT ) != S_IFREG )
481    {
482        tr_err( err_fmt, path, _( "Not a regular file" ) );
483        errno = EISDIR;
484        return NULL;
485    }
486
487    /* Load the torrent file into our buffer */
488    fd = tr_open_file_for_scanning( path );
489    if( fd < 0 )
490    {
491        const int err = errno;
492        tr_err( err_fmt, path, tr_strerror( errno ) );
493        errno = err;
494        return NULL;
495    }
496    buf = malloc( sb.st_size + 1 );
497    if( !buf )
498    {
499        const int err = errno;
500        tr_err( err_fmt, path, _( "Memory allocation failed" ) );
501        tr_close_file( fd );
502        errno = err;
503        return NULL;
504    }
505    n = read( fd, buf, (size_t)sb.st_size );
506    if( n == -1 )
507    {
508        const int err = errno;
509        tr_err( err_fmt, path, tr_strerror( errno ) );
510        tr_close_file( fd );
511        free( buf );
512        errno = err;
513        return NULL;
514    }
515
516    tr_close_file( fd );
517    buf[ sb.st_size ] = '\0';
518    *size = sb.st_size;
519    return buf;
520}
521
522char*
523tr_basename( const char * path )
524{
525    char * tmp = tr_strdup( path );
526    char * ret = tr_strdup( basename( tmp ) );
527    tr_free( tmp );
528    return ret;
529}
530
531char*
532tr_dirname( const char * path )
533{
534    char * tmp = tr_strdup( path );
535    char * ret = tr_strdup( dirname( tmp ) );
536    tr_free( tmp );
537    return ret;
538}
539
540int
541tr_mkdir( const char * path,
542          int permissions
543#ifdef WIN32
544                       UNUSED
545#endif
546        )
547{
548#ifdef WIN32
549    if( path && isalpha( path[0] ) && path[1] == ':' && !path[2] )
550        return 0;
551    return mkdir( path );
552#else
553    return mkdir( path, permissions );
554#endif
555}
556
557int
558tr_mkdirp( const char * path_in,
559           int          permissions )
560{
561    char *      path = tr_strdup( path_in );
562    char *      p, * pp;
563    struct stat sb;
564    int         done;
565
566    /* walk past the root */
567    p = path;
568    while( *p == TR_PATH_DELIMITER )
569        ++p;
570
571    pp = p;
572    done = 0;
573    while( ( p =
574                strchr( pp, TR_PATH_DELIMITER ) ) || ( p = strchr( pp, '\0' ) ) )
575    {
576        if( !*p )
577            done = 1;
578        else
579            *p = '\0';
580
581        if( stat( path, &sb ) )
582        {
583            /* Folder doesn't exist yet */
584            if( tr_mkdir( path, permissions ) )
585            {
586                const int err = errno;
587                tr_err( _(
588                           "Couldn't create \"%1$s\": %2$s" ), path,
589                       tr_strerror( err ) );
590                tr_free( path );
591                errno = err;
592                return -1;
593            }
594        }
595        else if( ( sb.st_mode & S_IFMT ) != S_IFDIR )
596        {
597            /* Node exists but isn't a folder */
598            char * buf = tr_strdup_printf( _( "File \"%s\" is in the way" ), path );
599            tr_err( _( "Couldn't create \"%1$s\": %2$s" ), path_in, buf );
600            tr_free( buf );
601            tr_free( path );
602            errno = ENOTDIR;
603            return -1;
604        }
605
606        if( done )
607            break;
608
609        *p = TR_PATH_DELIMITER;
610        p++;
611        pp = p;
612    }
613
614    tr_free( path );
615    return 0;
616}
617
618char*
619tr_buildPath( const char *first_element, ... )
620{
621    size_t bufLen = 0;
622    const char * element;
623    char * buf;
624    char * pch;
625    va_list vl;
626
627    /* pass 1: allocate enough space for the string */
628    va_start( vl, first_element );
629    element = first_element;
630    while( element ) {
631        bufLen += strlen( element ) + 1;
632        element = (const char*) va_arg( vl, const char* );
633    }
634    pch = buf = tr_new( char, bufLen );
635    va_end( vl );
636
637    /* pass 2: build the string piece by piece */
638    va_start( vl, first_element );
639    element = first_element;
640    while( element ) {
641        const size_t elementLen = strlen( element );
642        memcpy( pch, element, elementLen );
643        pch += elementLen;
644        *pch++ = TR_PATH_DELIMITER;
645        element = (const char*) va_arg( vl, const char* );
646    }
647    va_end( vl );
648
649    /* terminate the string.  if nonempty, eat the unwanted trailing slash */
650    if( pch != buf )
651        --pch;
652    *pch++ = '\0';
653
654    /* sanity checks & return */
655    assert( pch - buf == (off_t)bufLen );
656    return buf;
657}
658
659/****
660*****
661****/
662
663char*
664tr_strndup( const void * in, int len )
665{
666    char * out = NULL;
667
668    if( len < 0 )
669    {
670        out = tr_strdup( in );
671    }
672    else if( in )
673    {
674        out = tr_malloc( len + 1 );
675        memcpy( out, in, len );
676        out[len] = '\0';
677    }
678
679    return out;
680}
681
682const char*
683tr_memmem( const char * haystack, size_t haystacklen,
684           const char * needle, size_t needlelen )
685{
686#ifdef HAVE_MEMMEM
687    return memmem( haystack, haystacklen, needle, needlelen );
688#else
689    size_t i;
690    if( !needlelen )
691        return haystack;
692    if( needlelen > haystacklen || !haystack || !needle )
693        return NULL;
694    for( i=0; i<=haystacklen-needlelen; ++i )
695        if( !memcmp( haystack+i, needle, needlelen ) )
696            return haystack+i;
697    return NULL;
698#endif
699}
700
701char*
702tr_strdup_printf( const char * fmt, ... )
703{
704    va_list ap;
705    char * ret;
706    size_t len;
707    char statbuf[2048];
708
709    va_start( ap, fmt );
710    len = evutil_vsnprintf( statbuf, sizeof( statbuf ), fmt, ap );
711    va_end( ap );
712    if( len < sizeof( statbuf ) )
713        ret = tr_strndup( statbuf, len );
714    else {
715        ret = tr_new( char, len + 1 );
716        va_start( ap, fmt );
717        evutil_vsnprintf( ret, len + 1, fmt, ap );
718        va_end( ap );
719    }
720
721    return ret;
722}
723
724const char*
725tr_strerror( int i )
726{
727    const char * ret = strerror( i );
728
729    if( ret == NULL )
730        ret = "Unknown Error";
731    return ret;
732}
733
734/****
735*****
736****/
737
738char*
739tr_strstrip( char * str )
740{
741    if( str != NULL )
742    {
743        size_t pos;
744        size_t len = strlen( str );
745
746        while( len && isspace( str[len - 1] ) )
747            --len;
748
749        for( pos = 0; pos < len && isspace( str[pos] ); )
750            ++pos;
751
752        len -= pos;
753        memmove( str, str + pos, len );
754        str[len] = '\0';
755    }
756
757    return str;
758}
759
760tr_bool
761tr_str_has_suffix( const char *str, const char *suffix )
762{
763    size_t str_len;
764    size_t suffix_len;
765
766    if( !str )
767        return FALSE;
768    if( !suffix )
769        return TRUE;
770
771    str_len = strlen( str );
772    suffix_len = strlen( suffix );
773    if( str_len < suffix_len )
774        return FALSE;
775
776    return !strncasecmp( str + str_len - suffix_len, suffix, suffix_len );
777}
778
779/****
780*****
781****/
782
783uint64_t
784tr_time_msec( void )
785{
786    struct timeval tv;
787
788    gettimeofday( &tv, NULL );
789    return (uint64_t) tv.tv_sec * 1000 + ( tv.tv_usec / 1000 );
790}
791
792void
793tr_wait_msec( long int msec )
794{
795#ifdef WIN32
796    Sleep( (DWORD)msec );
797#else
798    struct timespec ts;
799    ts.tv_sec = msec / 1000;
800    ts.tv_nsec = ( msec % 1000 ) * 1000000;
801    nanosleep( &ts, NULL );
802#endif
803}
804
805/***
806****
807***/
808
809int
810tr_snprintf( char * buf, size_t buflen, const char * fmt, ... )
811{
812    int     len;
813    va_list args;
814
815    va_start( args, fmt );
816    len = evutil_vsnprintf( buf, buflen, fmt, args );
817    va_end( args );
818    return len;
819}
820
821/*
822 * Copy src to string dst of size siz.  At most siz-1 characters
823 * will be copied.  Always NUL terminates (unless siz == 0).
824 * Returns strlen(src); if retval >= siz, truncation occurred.
825 */
826size_t
827tr_strlcpy( char *       dst,
828            const void * src,
829            size_t       siz )
830{
831#ifdef HAVE_STRLCPY
832    return strlcpy( dst, src, siz );
833#else
834    char *      d = dst;
835    const char *s = src;
836    size_t      n = siz;
837
838    assert( s );
839    assert( d );
840
841    /* Copy as many bytes as will fit */
842    if( n != 0 )
843    {
844        while( --n != 0 )
845        {
846            if( ( *d++ = *s++ ) == '\0' )
847                break;
848        }
849    }
850
851    /* Not enough room in dst, add NUL and traverse rest of src */
852    if( n == 0 )
853    {
854        if( siz != 0 )
855            *d = '\0'; /* NUL-terminate dst */
856        while( *s++ )
857            ;
858    }
859
860    return s - (char*)src - 1;  /* count does not include NUL */
861#endif
862}
863
864/***
865****
866***/
867
868double
869tr_getRatio( uint64_t numerator, uint64_t denominator )
870{
871    double ratio;
872
873    if( denominator > 0 )
874        ratio = numerator / (double)denominator;
875    else if( numerator > 0 )
876        ratio = TR_RATIO_INF;
877    else
878        ratio = TR_RATIO_NA;
879
880    return ratio;
881}
882
883void
884tr_sha1_to_hex( char * out, const uint8_t * sha1 )
885{
886    int i;
887    static const char hex[] = "0123456789abcdef";
888
889    for( i=0; i<20; ++i )
890    {
891        const unsigned int val = *sha1++;
892        *out++ = hex[val >> 4];
893        *out++ = hex[val & 0xf];
894    }
895
896    *out = '\0';
897}
898
899void
900tr_hex_to_sha1( uint8_t * out, const char * in )
901{
902    int i;
903    static const char hex[] = "0123456789abcdef";
904
905    for( i=0; i<20; ++i )
906    {
907        const int hi = strchr( hex, tolower( *in++ ) ) - hex;
908        const int lo = strchr( hex, tolower( *in++ ) ) - hex;
909        *out++ = (uint8_t)( (hi<<4) | lo );
910    }
911}
912
913/***
914****
915***/
916
917static tr_bool
918isValidURLChars( const char * url, int url_len )
919{
920    const char * c;
921    const char * end;
922    static const char * rfc2396_valid_chars =
923        "abcdefghijklmnopqrstuvwxyz" /* lowalpha */
924        "ABCDEFGHIJKLMNOPQRSTUVWXYZ" /* upalpha */
925        "0123456789"                 /* digit */
926        "-_.!~*'()"                  /* mark */
927        ";/?:@&=+$,"                 /* reserved */
928        "<>#%<\""                    /* delims */
929        "{}|\\^[]`";                 /* unwise */
930
931    if( url == NULL )
932        return FALSE;
933
934    for( c=url, end=c+url_len; c && *c && c!=end; ++c )
935        if( !strchr( rfc2396_valid_chars, *c ) )
936            return FALSE;
937
938    return TRUE;
939}
940
941/** @brief return TRUE if the url is a http or https url that Transmission understands */
942tr_bool
943tr_urlIsValidTracker( const char * url )
944{
945    tr_bool valid;
946    char * scheme = NULL;
947    const int len = url ? strlen(url) : 0;
948
949    valid = isValidURLChars( url, len )
950         && !tr_urlParse( url, len, &scheme, NULL, NULL, NULL )
951         && ( scheme != NULL )
952         && ( !strcmp(scheme,"http") || !strcmp(scheme,"https") );
953
954    tr_free( scheme );
955    return valid;
956}
957
958/** @brief return TRUE if the url is a http or https or ftp or sftp url that Transmission understands */
959tr_bool
960tr_urlIsValid( const char * url, int url_len )
961{
962    tr_bool valid;
963    char * scheme = NULL;
964    if( ( url_len < 0 ) && ( url != NULL ) )
965        url_len = strlen( url );
966
967    valid = isValidURLChars( url, url_len )
968         && !tr_urlParse( url, url_len, &scheme, NULL, NULL, NULL )
969         && ( scheme != NULL )
970         && ( !strcmp(scheme,"http") || !strcmp(scheme,"https") || !strcmp(scheme,"ftp") || !strcmp(scheme,"sftp") );
971
972    tr_free( scheme );
973    return valid;
974}
975
976tr_bool
977tr_addressIsIP( const char * address )
978{
979    tr_address tempAddr;
980    return tr_pton(address, &tempAddr) != NULL;
981}
982
983int
984tr_urlParse( const char * url_in,
985             int          len,
986             char **      setme_protocol,
987             char **      setme_host,
988             int *        setme_port,
989             char **      setme_path )
990{
991    int          err;
992    int          port = 0;
993    int          n;
994    char *       tmp;
995    char *       pch;
996    const char * protocol = NULL;
997    const char * host = NULL;
998    const char * path = NULL;
999
1000    tmp = tr_strndup( url_in, len );
1001    if( ( pch = strstr( tmp, "://" ) ) )
1002    {
1003        *pch = '\0';
1004        protocol = tmp;
1005        pch += 3;
1006/*fprintf( stderr, "protocol is [%s]... what's left is [%s]\n", protocol, pch);*/
1007        if( ( n = strcspn( pch, ":/" ) ) )
1008        {
1009            const int havePort = pch[n] == ':';
1010            host = pch;
1011            pch += n;
1012            *pch++ = '\0';
1013/*fprintf( stderr, "host is [%s]... what's left is [%s]\n", host, pch );*/
1014            if( havePort )
1015            {
1016                char * end;
1017                port = strtol( pch, &end, 10 );
1018                pch = end;
1019/*fprintf( stderr, "port is [%d]... what's left is [%s]\n", port, pch );*/
1020            }
1021            path = pch;
1022/*fprintf( stderr, "path is [%s]\n", path );*/
1023        }
1024    }
1025
1026    err = !host || !path || !protocol;
1027
1028    if( !err && !port )
1029    {
1030        if( !strcmp( protocol, "ftp" ) ) port = 21;
1031        if( !strcmp( protocol, "sftp" ) ) port = 22;
1032        if( !strcmp( protocol, "http" ) ) port = 80;
1033        if( !strcmp( protocol, "https" ) ) port = 443;
1034    }
1035
1036    if( !err )
1037    {
1038        if( setme_protocol ) *setme_protocol = tr_strdup( protocol );
1039
1040        if( setme_host ){ ( (char*)host )[-3] = ':'; *setme_host =
1041                              tr_strdup( host ); }
1042        if( setme_path ){ if( path[0] == '/' ) *setme_path = tr_strdup( path );
1043                          else { ( (char*)path )[-1] = '/'; *setme_path = tr_strdup( path - 1 ); } }
1044        if( setme_port ) *setme_port = port;
1045    }
1046
1047
1048    tr_free( tmp );
1049    return err;
1050}
1051
1052#include <string.h>
1053#include <openssl/sha.h>
1054#include <openssl/hmac.h>
1055#include <openssl/evp.h>
1056#include <openssl/bio.h>
1057#include <openssl/buffer.h>
1058
1059char *
1060tr_base64_encode( const void * input, int length, int * setme_len )
1061{
1062    int retlen = 0;
1063    char * ret = NULL;
1064
1065    if( input != NULL )
1066    {
1067        BIO * b64;
1068        BIO * bmem;
1069        BUF_MEM * bptr;
1070
1071        if( length < 1 )
1072            length = (int)strlen( input );
1073
1074        bmem = BIO_new( BIO_s_mem( ) );
1075        b64 = BIO_new( BIO_f_base64( ) );
1076        b64 = BIO_push( b64, bmem );
1077        BIO_write( b64, input, length );
1078        (void) BIO_flush( b64 );
1079        BIO_get_mem_ptr( b64, &bptr );
1080        ret = tr_strndup( bptr->data, bptr->length );
1081        retlen = bptr->length;
1082        BIO_free_all( b64 );
1083    }
1084
1085    if( setme_len )
1086        *setme_len = retlen;
1087
1088    return ret;
1089}
1090
1091char *
1092tr_base64_decode( const void * input,
1093                  int          length,
1094                  int *        setme_len )
1095{
1096    char * ret;
1097    BIO *  b64;
1098    BIO *  bmem;
1099    int    retlen;
1100
1101    if( length < 1 )
1102        length = strlen( input );
1103
1104    ret = tr_new0( char, length );
1105    b64 = BIO_new( BIO_f_base64( ) );
1106    bmem = BIO_new_mem_buf( (unsigned char*)input, length );
1107    bmem = BIO_push( b64, bmem );
1108    retlen = BIO_read( bmem, ret, length );
1109    if( !retlen )
1110    {
1111        /* try again, but with the BIO_FLAGS_BASE64_NO_NL flag */
1112        BIO_free_all( bmem );
1113        b64 = BIO_new( BIO_f_base64( ) );
1114        BIO_set_flags( b64, BIO_FLAGS_BASE64_NO_NL );
1115        bmem = BIO_new_mem_buf( (unsigned char*)input, length );
1116        bmem = BIO_push( b64, bmem );
1117        retlen = BIO_read( bmem, ret, length );
1118    }
1119
1120    if( setme_len )
1121        *setme_len = retlen;
1122
1123    BIO_free_all( bmem );
1124    return ret;
1125}
1126
1127/***
1128****
1129***/
1130
1131int
1132tr_lowerBound( const void * key,
1133               const void * base,
1134               size_t       nmemb,
1135               size_t       size,
1136               int       (* compar)(const void* key, const void* arrayMember),
1137               tr_bool    * exact_match )
1138{
1139    size_t first = 0;
1140    const char * cbase = base;
1141    tr_bool exact = FALSE;
1142
1143    while( nmemb != 0 )
1144    {
1145        const size_t half = nmemb / 2;
1146        const size_t middle = first + half;
1147        const int c = compar( key, cbase + size*middle );
1148
1149        if( c <= 0 ) {
1150            if( c == 0 )
1151                exact = TRUE;
1152            nmemb = half;
1153        } else {
1154            first = middle + 1;
1155            nmemb = nmemb - half - 1;
1156        }
1157    }
1158
1159    *exact_match = exact;
1160
1161    return first;
1162}
1163
1164/***
1165****
1166***/
1167
1168static char*
1169strip_non_utf8( const char * in, size_t inlen )
1170{
1171    char * ret;
1172    const char * end;
1173    const char zero = '\0';
1174    struct evbuffer * buf = evbuffer_new( );
1175 
1176    while( !tr_utf8_validate( in, inlen, &end ) )
1177    {
1178        const int good_len = end - in;
1179
1180        evbuffer_add( buf, in, good_len );
1181        inlen -= ( good_len + 1 );
1182        in += ( good_len + 1 );
1183        evbuffer_add( buf, "?", 1 );
1184    }
1185 
1186    evbuffer_add( buf, in, inlen );
1187    evbuffer_add( buf, &zero, 1 );
1188    ret = tr_memdup( EVBUFFER_DATA( buf ), EVBUFFER_LENGTH( buf ) );
1189    evbuffer_free( buf );
1190    return ret;
1191}
1192
1193static char*
1194to_utf8( const char * in, size_t inlen )
1195{
1196    char * ret = NULL;
1197
1198#ifdef HAVE_ICONV_OPEN
1199    int i;
1200    const char * encodings[] = { "CURRENT", "ISO-8859-15" };
1201    const int encoding_count = sizeof(encodings) / sizeof(encodings[1]);
1202    const size_t buflen = inlen*4 + 10;
1203    char * out = tr_new( char, buflen );
1204
1205    for( i=0; !ret && i<encoding_count; ++i )
1206    {
1207        char * inbuf = (char*) in;
1208        char * outbuf = out;
1209        size_t inbytesleft = inlen;
1210        size_t outbytesleft = buflen;
1211        const char * test_encoding = encodings[i];
1212
1213        iconv_t cd = iconv_open( "UTF-8", test_encoding );
1214        if( cd != (iconv_t)-1 ) {
1215            if( iconv( cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft ) != (size_t)-1 )
1216                ret = tr_strndup( out, buflen-outbytesleft );
1217            iconv_close( cd );
1218        }
1219    }
1220#endif
1221
1222    if( ret == NULL )
1223        ret = strip_non_utf8( in, inlen );
1224
1225    return ret;
1226}
1227
1228char*
1229tr_utf8clean( const char * str, int max_len )
1230{
1231    char * ret;
1232    const char * end;
1233
1234    if( max_len < 0 )
1235        max_len = (int) strlen( str );
1236
1237    if( tr_utf8_validate( str, max_len, &end  ) )
1238        ret = tr_strndup( str, max_len );
1239    else
1240        ret = to_utf8( str, max_len );
1241
1242    assert( tr_utf8_validate( ret, -1, NULL ) );
1243    return ret;
1244}
1245
1246/***
1247****
1248***/
1249
1250struct number_range
1251{
1252    int low;
1253    int high;
1254};
1255
1256/**
1257 * This should be a single number (ex. "6") or a range (ex. "6-9").
1258 * Anything else is an error and will return failure.
1259 */
1260static tr_bool
1261parseNumberSection( const char * str, int len, struct number_range * setme )
1262{
1263    long a, b;
1264    tr_bool success;
1265    char * end;
1266    const int error = errno;
1267    char * tmp = tr_strndup( str, len );
1268
1269    errno = 0;
1270    a = b = strtol( tmp, &end, 10 );
1271    if( errno || ( end == tmp ) ) {
1272        success = FALSE;
1273    } else if( *end != '-' ) {
1274        b = a;
1275        success = TRUE;
1276    } else {
1277        const char * pch = end + 1;
1278        b = strtol( pch, &end, 10 );
1279        if( errno || ( pch == end ) )
1280            success = FALSE;
1281        else if( *end ) /* trailing data */
1282            success = FALSE;
1283        else
1284            success = TRUE;
1285    }
1286    tr_free( tmp );
1287
1288    setme->low = MIN( a, b );
1289    setme->high = MAX( a, b );
1290
1291    errno = error;
1292    return success;
1293}
1294
1295int
1296compareInt( const void * va, const void * vb )
1297{
1298    const int a = *(const int *)va;
1299    const int b = *(const int *)vb;
1300    return a - b;
1301}
1302
1303/**
1304 * Given a string like "1-4" or "1-4,6,9,14-51", this allocates and returns an
1305 * array of setmeCount ints of all the values in the array.
1306 * For example, "5-8" will return [ 5, 6, 7, 8 ] and setmeCount will be 4.
1307 * It's the caller's responsibility to call tr_free() on the returned array.
1308 * If a fragment of the string can't be parsed, NULL is returned.
1309 */
1310int*
1311tr_parseNumberRange( const char * str_in, int len, int * setmeCount )
1312{
1313    int n = 0;
1314    int * uniq = NULL;
1315    char * str = tr_strndup( str_in, len );
1316    const char * walk;
1317    tr_list * ranges = NULL;
1318    tr_bool success = TRUE;
1319
1320    walk = str;
1321    while( walk && *walk && success ) {
1322        struct number_range range;
1323        const char * pch = strchr( walk, ',' );
1324        if( pch ) {
1325            success = parseNumberSection( walk, pch-walk, &range );
1326            walk = pch + 1;
1327        } else {
1328            success = parseNumberSection( walk, strlen( walk ), &range );
1329            walk += strlen( walk );
1330        }
1331        if( success )
1332            tr_list_append( &ranges, tr_memdup( &range, sizeof( struct number_range ) ) );
1333    }
1334
1335    if( !success )
1336    {
1337        *setmeCount = 0;
1338        uniq = NULL;
1339    }
1340    else
1341    {
1342        int i;
1343        int n2;
1344        tr_list * l;
1345        int * sorted = NULL;
1346
1347        /* build a sorted number array */
1348        n = n2 = 0;
1349        for( l=ranges; l!=NULL; l=l->next ) {
1350            const struct number_range * r = l->data;
1351            n += r->high + 1 - r->low;
1352        }
1353        sorted = tr_new( int, n );
1354        for( l=ranges; l!=NULL; l=l->next ) {
1355            const struct number_range * r = l->data;
1356            int i;
1357            for( i=r->low; i<=r->high; ++i )
1358                sorted[n2++] = i;
1359        }
1360        qsort( sorted, n, sizeof( int ), compareInt );
1361        assert( n == n2 );
1362
1363        /* remove duplicates */
1364        uniq = tr_new( int, n );
1365        for( i=n=0; i<n2; ++i )
1366            if( !n || uniq[n-1] != sorted[i] )
1367                uniq[n++] = sorted[i];
1368
1369        tr_free( sorted );
1370    }
1371
1372    /* cleanup */
1373    tr_list_free( &ranges, tr_free );
1374    tr_free( str );
1375
1376    /* return the result */
1377    *setmeCount = n;
1378    return uniq;
1379}
1380
1381/***
1382****
1383***/
1384
1385double
1386tr_truncd( double x, int decimal_places )
1387{
1388    const int i = (int) pow( 10, decimal_places ); 
1389    const double x2 = (int64_t)(x * i);
1390    return x2 / i;
1391}
1392
1393char*
1394tr_strtruncd( char * buf, double x, int precision, size_t buflen )
1395{
1396    tr_snprintf( buf, buflen, "%.*f", precision, tr_truncd( x, precision ) );
1397
1398    return buf;
1399}
1400
1401char*
1402tr_strpercent( char * buf, double x, size_t buflen )
1403{
1404    if( x < 10.0 )
1405        tr_strtruncd( buf, x, 2, buflen );
1406    else if( x < 100.0 )
1407        tr_strtruncd( buf, x, 1, buflen );
1408    else
1409        tr_strtruncd( buf, x, 0, buflen );
1410    return buf;
1411}
1412
1413char*
1414tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity )
1415{
1416    if( (int)ratio == TR_RATIO_NA )
1417        tr_strlcpy( buf, _( "None" ), buflen );
1418    else if( (int)ratio == TR_RATIO_INF )
1419        tr_strlcpy( buf, infinity, buflen );
1420    else
1421        tr_strpercent( buf, ratio, buflen );
1422    return buf;
1423}
1424
1425/***
1426****
1427***/
1428
1429int
1430tr_moveFile( const char * oldpath, const char * newpath, tr_bool * renamed )
1431{
1432    int in;
1433    int out;
1434    char * buf;
1435    struct stat st;
1436    off_t bytesLeft;
1437    const size_t buflen = 1024 * 128; /* 128 KiB buffer */
1438
1439    /* make sure the old file exists */
1440    if( stat( oldpath, &st ) ) {
1441        const int err = errno;
1442        errno = err;
1443        return -1;
1444    }
1445    if( !S_ISREG( st.st_mode ) ) {
1446        errno = ENOENT;
1447        return -1;
1448    }
1449    bytesLeft = st.st_size;
1450
1451    /* make sure the target directory exists */
1452    {
1453        char * newdir = tr_dirname( newpath );
1454        int i = tr_mkdirp( newdir, 0777 );
1455        tr_free( newdir );
1456        if( i )
1457            return i;
1458    }
1459
1460    /* they might be on the same filesystem... */
1461    {
1462        const int i = rename( oldpath, newpath );
1463        if( renamed != NULL )
1464            *renamed = i == 0;
1465        if( !i )
1466            return 0;
1467    }
1468
1469    /* copy the file */
1470    in = tr_open_file_for_scanning( oldpath );
1471    out = tr_open_file_for_writing( newpath );
1472    buf = tr_valloc( buflen );
1473    while( bytesLeft > 0 )
1474    {
1475        ssize_t bytesWritten;
1476        const off_t bytesThisPass = MIN( bytesLeft, (off_t)buflen );
1477        const int numRead = read( in, buf, bytesThisPass );
1478        if( numRead < 0 )
1479            break;
1480        bytesWritten = write( out, buf, numRead );
1481        if( bytesWritten < 0 )
1482            break;
1483        bytesLeft -= bytesWritten;
1484    }
1485
1486    /* cleanup */
1487    tr_free( buf );
1488    tr_close_file( out );
1489    tr_close_file( in );
1490    if( bytesLeft != 0 )
1491        return -1;
1492
1493    unlink( oldpath );
1494    return 0;
1495}
1496
1497/***
1498****
1499***/
1500
1501void*
1502tr_valloc( size_t bufLen )
1503{
1504    size_t allocLen;
1505    void * buf = NULL;
1506    static size_t pageSize = 0;
1507
1508    if( !pageSize ) {
1509#ifdef HAVE_GETPAGESIZE
1510        pageSize = (size_t) getpagesize();
1511#else /* guess */
1512        pageSize = 4096;
1513#endif
1514    }
1515
1516    allocLen = pageSize;
1517    while( allocLen < bufLen )
1518        allocLen += pageSize;
1519
1520#ifdef HAVE_POSIX_MEMALIGN
1521    if( !buf )
1522        posix_memalign( &buf, pageSize, allocLen );
1523#endif
1524#ifdef HAVE_VALLOC
1525    if( !buf )
1526        buf = valloc( allocLen );
1527#endif
1528    if( !buf )
1529        buf = malloc( allocLen );
1530
1531    return buf;
1532}
1533
1534char *
1535tr_realpath( const char * path, char * resolved_path )
1536{
1537#ifdef WIN32
1538    /* From a message to the Mingw-msys list, Jun 2, 2005 by Mark Junker. */
1539    if( GetFullPathNameA( path, TR_PATH_MAX, resolved_path, NULL ) == 0 )
1540        return NULL;
1541    return resolved_path;
1542#else
1543    return realpath( path, resolved_path );
1544#endif
1545}
1546
1547/***
1548****
1549****
1550****
1551***/
1552
1553struct formatter_unit
1554{
1555    char * name;
1556    uint64_t value;
1557};
1558 
1559struct formatter_units
1560{
1561    struct formatter_unit units[4];
1562};
1563
1564enum { TR_FMT_KB, TR_FMT_MB, TR_FMT_GB, TR_FMT_TB };
1565
1566static void
1567formatter_init( struct formatter_units * units,
1568                unsigned int kilo,
1569                const char * kb, const char * mb,
1570                const char * gb, const char * tb )
1571{
1572    uint64_t value = kilo;
1573    units->units[TR_FMT_KB].name = tr_strdup( kb );
1574    units->units[TR_FMT_KB].value = value;
1575
1576    value *= kilo;
1577    units->units[TR_FMT_MB].name = tr_strdup( mb );
1578    units->units[TR_FMT_MB].value = value;
1579
1580    value *= kilo;
1581    units->units[TR_FMT_GB].name = tr_strdup( gb );
1582    units->units[TR_FMT_GB].value = value;
1583
1584    value *= kilo;
1585    units->units[TR_FMT_TB].name = tr_strdup( tb );
1586    units->units[TR_FMT_TB].value = value;
1587}
1588
1589static char*
1590formatter_get_size_str( const struct formatter_units * u,
1591                        char * buf, uint64_t bytes, size_t buflen )
1592{
1593    int precision;
1594    double value;
1595    const char * units;
1596    const struct formatter_unit * unit;
1597
1598         if( bytes < u->units[1].value ) unit = &u->units[0];
1599    else if( bytes < u->units[2].value ) unit = &u->units[1];
1600    else if( bytes < u->units[3].value ) unit = &u->units[2];
1601    else                                 unit = &u->units[3];
1602
1603    value = (double)bytes / unit->value;
1604    units = unit->name;
1605    if( unit->value == 1 )
1606        precision = 0;
1607    else if( value < 100 )
1608        precision = 2;
1609    else
1610        precision = 1;
1611    tr_snprintf( buf, buflen, "%.*f %s", precision, value, units );
1612    return buf;
1613}
1614
1615static struct formatter_units size_units;
1616
1617void
1618tr_formatter_size_init( unsigned int kilo,
1619                        const char * kb, const char * mb,
1620                        const char * gb, const char * tb )
1621{
1622    formatter_init( &size_units, kilo, kb, mb, gb, tb );
1623}
1624
1625char*
1626tr_formatter_size_B( char * buf, uint64_t bytes, size_t buflen )
1627{
1628    return formatter_get_size_str( &size_units, buf, bytes, buflen );
1629}
1630
1631static struct formatter_units speed_units;
1632
1633unsigned int tr_speed_K = 0u;
1634
1635void
1636tr_formatter_speed_init( unsigned int kilo,
1637                         const char * kb, const char * mb,
1638                         const char * gb, const char * tb )
1639{
1640    tr_speed_K = kilo;
1641    formatter_init( &speed_units, kilo, kb, mb, gb, tb );
1642}
1643
1644char*
1645tr_formatter_speed_KBps( char * buf, double KBps, size_t buflen )
1646{
1647    const double K = speed_units.units[TR_FMT_KB].value;
1648    double speed = KBps;
1649
1650    if( speed <= 999.95 ) /* 0.0 KB to 999.9 KB */
1651        tr_snprintf( buf, buflen, "%.2f %s", speed, speed_units.units[TR_FMT_KB].name );
1652    else {
1653        speed /= K;
1654        if( speed <= 99.995 ) /* 0.98 MB to 99.99 MB */
1655            tr_snprintf( buf, buflen, "%.2f %s", speed, speed_units.units[TR_FMT_MB].name );
1656        else if (speed <= 999.95) /* 100.0 MB to 999.9 MB */
1657            tr_snprintf( buf, buflen, "%.1f %s", speed, speed_units.units[TR_FMT_MB].name );
1658        else {
1659            speed /= K;
1660            tr_snprintf( buf, buflen, "%.1f %s", speed, speed_units.units[TR_FMT_GB].name );
1661        }
1662    }
1663
1664    return buf;
1665}
1666
1667static struct formatter_units mem_units;
1668
1669unsigned int tr_mem_K = 0u;
1670 
1671void
1672tr_formatter_mem_init( unsigned int kilo,
1673                       const char * kb, const char * mb,
1674                       const char * gb, const char * tb )
1675{
1676    tr_mem_K = kilo;
1677    formatter_init( &mem_units, kilo, kb, mb, gb, tb );
1678}
1679
1680char*
1681tr_formatter_mem_B( char * buf, uint64_t bytes_per_second, size_t buflen )
1682{
1683    return formatter_get_size_str( &mem_units, buf, bytes_per_second, buflen );
1684}
1685
1686void
1687tr_formatter_get_units( tr_benc * d )
1688{
1689    int i;
1690    tr_benc * l;
1691
1692    tr_bencDictReserve( d, 6 );
1693
1694    tr_bencDictAddInt( d, "memory-bytes", mem_units.units[TR_FMT_KB].value );
1695    l = tr_bencDictAddList( d, "memory-units", 4 );
1696    for( i=0; i<4; i++ ) tr_bencListAddStr( l, mem_units.units[i].name );
1697
1698    tr_bencDictAddInt( d, "size-bytes",   size_units.units[TR_FMT_KB].value );
1699    l = tr_bencDictAddList( d, "size-units", 4 );
1700    for( i=0; i<4; i++ ) tr_bencListAddStr( l, size_units.units[i].name );
1701
1702    tr_bencDictAddInt( d, "speed-bytes",  speed_units.units[TR_FMT_KB].value );
1703    l = tr_bencDictAddList( d, "speed-units", 4 );
1704    for( i=0; i<4; i++ ) tr_bencListAddStr( l, speed_units.units[i].name );
1705}
1706
Note: See TracBrowser for help on using the repository browser.