source: trunk/libtransmission/utils.c @ 10305

Last change on this file since 10305 was 10305, checked in by charles, 12 years ago

(trunk libT) fix BSD build issue

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