source: trunk/libtransmission/utils.c @ 10736

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

(trunk) #3262 "problems with '.' as the first character in a .torrent's filename" -- fixed in trunk for 2.00

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