source: trunk/libtransmission/utils.c @ 10365

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

(trunk libT) make tr_updateTime() inlined

  • 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 10365 2010-03-12 19:24:45Z 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
776/****
777*****
778****/
779
780uint64_t
781tr_date( void )
782{
783    struct timeval tv;
784
785    gettimeofday( &tv, NULL );
786    return (uint64_t) tv.tv_sec * 1000 + ( tv.tv_usec / 1000 );
787}
788
789void
790tr_wait_msec( uint64_t delay_milliseconds )
791{
792#ifdef WIN32
793    Sleep( (DWORD)delay_milliseconds );
794#else
795    usleep( 1000 * delay_milliseconds );
796#endif
797}
798
799/***
800****
801***/
802
803int
804tr_snprintf( char * buf, size_t buflen, const char * fmt, ... )
805{
806    int     len;
807    va_list args;
808
809    va_start( args, fmt );
810    len = evutil_vsnprintf( buf, buflen, fmt, args );
811    va_end( args );
812    return len;
813}
814
815/*
816 * Copy src to string dst of size siz.  At most siz-1 characters
817 * will be copied.  Always NUL terminates (unless siz == 0).
818 * Returns strlen(src); if retval >= siz, truncation occurred.
819 */
820size_t
821tr_strlcpy( char *       dst,
822            const void * src,
823            size_t       siz )
824{
825#ifdef HAVE_STRLCPY
826    return strlcpy( dst, src, siz );
827#else
828    char *      d = dst;
829    const char *s = src;
830    size_t      n = siz;
831
832    assert( s );
833    assert( d );
834
835    /* Copy as many bytes as will fit */
836    if( n != 0 )
837    {
838        while( --n != 0 )
839        {
840            if( ( *d++ = *s++ ) == '\0' )
841                break;
842        }
843    }
844
845    /* Not enough room in dst, add NUL and traverse rest of src */
846    if( n == 0 )
847    {
848        if( siz != 0 )
849            *d = '\0'; /* NUL-terminate dst */
850        while( *s++ )
851            ;
852    }
853
854    return s - (char*)src - 1;  /* count does not include NUL */
855#endif
856}
857
858/***
859****
860***/
861
862double
863tr_getRatio( double numerator,
864             double denominator )
865{
866    double ratio;
867
868    if( denominator )
869        ratio = numerator / denominator;
870    else if( numerator )
871        ratio = TR_RATIO_INF;
872    else
873        ratio = TR_RATIO_NA;
874
875    return ratio;
876}
877
878void
879tr_sha1_to_hex( char * out, const uint8_t * sha1 )
880{
881    int i;
882    static const char hex[] = "0123456789abcdef";
883
884    for( i=0; i<20; ++i )
885    {
886        const unsigned int val = *sha1++;
887        *out++ = hex[val >> 4];
888        *out++ = hex[val & 0xf];
889    }
890
891    *out = '\0';
892}
893
894void
895tr_hex_to_sha1( uint8_t * out, const char * in )
896{
897    int i;
898    static const char hex[] = "0123456789abcdef";
899
900    for( i=0; i<20; ++i )
901    {
902        const int hi = strchr( hex, tolower( *in++ ) ) - hex;
903        const int lo = strchr( hex, tolower( *in++ ) ) - hex;
904        *out++ = (uint8_t)( (hi<<4) | lo );
905    }
906}
907
908/***
909****
910***/
911
912static tr_bool
913isValidURLChars( const char * url )
914{
915    const char * c;
916    static const char * rfc2396_valid_chars =
917        "abcdefghijklmnopqrstuvwxyz" /* lowalpha */
918        "ABCDEFGHIJKLMNOPQRSTUVWXYZ" /* upalpha */
919        "0123456789"                 /* digit */
920        "-_.!~*'()"                  /* mark */
921        ";/?:@&=+$,"                 /* reserved */
922        "<>#%<\""                    /* delims */
923        "{}|\\^[]`";                 /* unwise */
924
925    if( url == NULL )
926        return FALSE;
927
928    for( c = url; c && *c; ++c )
929        if( !strchr( rfc2396_valid_chars, *c ) )
930            return FALSE;
931
932    return TRUE;
933}
934
935/** @brief return TRUE if the url is a http or https url that Transmission understands */
936tr_bool
937tr_urlIsValidTracker( const char * url )
938{
939    tr_bool valid;
940    char * scheme = NULL;
941
942    valid = isValidURLChars( url ) 
943         && !tr_urlParse( url, -1, &scheme, NULL, NULL, NULL )
944         && ( scheme != NULL )
945         && ( !strcmp(scheme,"http") || !strcmp(scheme,"https") );
946
947    tr_free( scheme );
948    return valid;
949}
950
951/** @brief return TRUE if the url is a http or https or ftp or sftp url that Transmission understands */
952tr_bool
953tr_urlIsValid( const char * url )
954{
955    tr_bool valid;
956    char * scheme = NULL;
957
958    valid = isValidURLChars( url ) 
959         && !tr_urlParse( url, -1, &scheme, NULL, NULL, NULL )
960         && ( scheme != NULL )
961         && ( !strcmp(scheme,"http") || !strcmp(scheme,"https") || !strcmp(scheme,"ftp") || !strcmp(scheme,"sftp") );
962
963    tr_free( scheme );
964    return valid;
965}
966
967tr_bool
968tr_addressIsIP( const char * address )
969{
970    tr_address tempAddr;
971    return tr_pton(address, &tempAddr) != NULL;
972}
973
974int
975tr_urlParse( const char * url_in,
976             int          len,
977             char **      setme_protocol,
978             char **      setme_host,
979             int *        setme_port,
980             char **      setme_path )
981{
982    int          err;
983    int          port = 0;
984    int          n;
985    char *       tmp;
986    char *       pch;
987    const char * protocol = NULL;
988    const char * host = NULL;
989    const char * path = NULL;
990
991    tmp = tr_strndup( url_in, len );
992    if( ( pch = strstr( tmp, "://" ) ) )
993    {
994        *pch = '\0';
995        protocol = tmp;
996        pch += 3;
997/*fprintf( stderr, "protocol is [%s]... what's left is [%s]\n", protocol, pch);*/
998        if( ( n = strcspn( pch, ":/" ) ) )
999        {
1000            const int havePort = pch[n] == ':';
1001            host = pch;
1002            pch += n;
1003            *pch++ = '\0';
1004/*fprintf( stderr, "host is [%s]... what's left is [%s]\n", host, pch );*/
1005            if( havePort )
1006            {
1007                char * end;
1008                port = strtol( pch, &end, 10 );
1009                pch = end;
1010/*fprintf( stderr, "port is [%d]... what's left is [%s]\n", port, pch );*/
1011            }
1012            path = pch;
1013/*fprintf( stderr, "path is [%s]\n", path );*/
1014        }
1015    }
1016
1017    err = !host || !path || !protocol;
1018
1019    if( !err && !port )
1020    {
1021        if( !strcmp( protocol, "ftp" ) ) port = 21;
1022        if( !strcmp( protocol, "sftp" ) ) port = 22;
1023        if( !strcmp( protocol, "http" ) ) port = 80;
1024        if( !strcmp( protocol, "https" ) ) port = 443;
1025    }
1026
1027    if( !err )
1028    {
1029        if( setme_protocol ) *setme_protocol = tr_strdup( protocol );
1030
1031        if( setme_host ){ ( (char*)host )[-3] = ':'; *setme_host =
1032                              tr_strdup( host ); }
1033        if( setme_path ){ if( path[0] == '/' ) *setme_path = tr_strdup( path );
1034                          else { ( (char*)path )[-1] = '/'; *setme_path = tr_strdup( path - 1 ); } }
1035        if( setme_port ) *setme_port = port;
1036    }
1037
1038
1039    tr_free( tmp );
1040    return err;
1041}
1042
1043#include <string.h>
1044#include <openssl/sha.h>
1045#include <openssl/hmac.h>
1046#include <openssl/evp.h>
1047#include <openssl/bio.h>
1048#include <openssl/buffer.h>
1049
1050char *
1051tr_base64_encode( const void * input, int length, int * setme_len )
1052{
1053    int retlen = 0;
1054    char * ret = NULL;
1055
1056    if( input != NULL )
1057    {
1058        BIO * b64;
1059        BIO * bmem;
1060        BUF_MEM * bptr;
1061
1062        if( length < 1 )
1063            length = strlen( input );
1064
1065        bmem = BIO_new( BIO_s_mem( ) );
1066        b64 = BIO_new( BIO_f_base64( ) );
1067        b64 = BIO_push( b64, bmem );
1068        BIO_write( b64, input, length );
1069        (void) BIO_flush( b64 );
1070        BIO_get_mem_ptr( b64, &bptr );
1071        ret = tr_strndup( bptr->data, bptr->length );
1072        retlen = bptr->length;
1073        BIO_free_all( b64 );
1074    }
1075
1076    if( setme_len )
1077        *setme_len = retlen;
1078
1079    return ret;
1080}
1081
1082char *
1083tr_base64_decode( const void * input,
1084                  int          length,
1085                  int *        setme_len )
1086{
1087    char * ret;
1088    BIO *  b64;
1089    BIO *  bmem;
1090    int    retlen;
1091
1092    if( length < 1 )
1093        length = strlen( input );
1094
1095    ret = tr_new0( char, length );
1096    b64 = BIO_new( BIO_f_base64( ) );
1097    bmem = BIO_new_mem_buf( (unsigned char*)input, length );
1098    bmem = BIO_push( b64, bmem );
1099    retlen = BIO_read( bmem, ret, length );
1100    if( !retlen )
1101    {
1102        /* try again, but with the BIO_FLAGS_BASE64_NO_NL flag */
1103        BIO_free_all( bmem );
1104        b64 = BIO_new( BIO_f_base64( ) );
1105        BIO_set_flags( b64, BIO_FLAGS_BASE64_NO_NL );
1106        bmem = BIO_new_mem_buf( (unsigned char*)input, length );
1107        bmem = BIO_push( b64, bmem );
1108        retlen = BIO_read( bmem, ret, length );
1109    }
1110
1111    if( setme_len )
1112        *setme_len = retlen;
1113
1114    BIO_free_all( bmem );
1115    return ret;
1116}
1117
1118/***
1119****
1120***/
1121
1122int
1123tr_lowerBound( const void * key,
1124               const void * base,
1125               size_t       nmemb,
1126               size_t       size,
1127               int       (* compar)(const void* key, const void* arrayMember),
1128               tr_bool    * exact_match )
1129{
1130    size_t first = 0;
1131    const char * cbase = base;
1132    tr_bool exact = FALSE;
1133
1134    while( nmemb != 0 )
1135    {
1136        const size_t half = nmemb / 2;
1137        const size_t middle = first + half;
1138        const int c = compar( key, cbase + size*middle );
1139
1140        if( c <= 0 ) {
1141            if( c == 0 )
1142                exact = TRUE;
1143            nmemb = half;
1144        } else {
1145            first = middle + 1;
1146            nmemb = nmemb - half - 1;
1147        }
1148    }
1149
1150    *exact_match = exact;
1151
1152    return first;
1153}
1154
1155/***
1156****
1157***/
1158
1159char*
1160tr_utf8clean( const char * str, int max_len, tr_bool * err )
1161{
1162    char * ret;
1163    const char * end;
1164
1165    if( max_len < 0 )
1166        max_len = (int) strlen( str );
1167
1168    if( err != NULL )
1169        *err = FALSE;
1170
1171    if( tr_utf8_validate( str, max_len, &end  ) )
1172    {
1173        ret = tr_strndup( str, max_len );
1174    }
1175    else
1176    {
1177        const char zero = '\0';
1178        struct evbuffer * buf = evbuffer_new( );
1179
1180        while( !tr_utf8_validate ( str, max_len, &end ) )
1181        {
1182            const int good_len = end - str;
1183
1184            evbuffer_add( buf, str, good_len );
1185            max_len -= ( good_len + 1 );
1186            str += ( good_len + 1 );
1187            evbuffer_add( buf, "?", 1 );
1188
1189            if( err != NULL )
1190                *err = TRUE;
1191        }
1192
1193        evbuffer_add( buf, str, max_len );
1194        evbuffer_add( buf, &zero, 1 );
1195        ret = tr_memdup( EVBUFFER_DATA( buf ), EVBUFFER_LENGTH( buf ) );
1196        evbuffer_free( buf );
1197    }
1198
1199    assert( tr_utf8_validate( ret, -1, NULL ) );
1200    return ret;
1201}
1202
1203/***
1204****
1205***/
1206
1207struct number_range
1208{
1209    int low;
1210    int high;
1211};
1212
1213/**
1214 * This should be a single number (ex. "6") or a range (ex. "6-9").
1215 * Anything else is an error and will return failure.
1216 */
1217static tr_bool
1218parseNumberSection( const char * str, int len, struct number_range * setme )
1219{
1220    long a, b;
1221    tr_bool success;
1222    char * end;
1223    const int error = errno;
1224    char * tmp = tr_strndup( str, len );
1225
1226    errno = 0;
1227    a = b = strtol( tmp, &end, 10 );
1228    if( errno || ( end == tmp ) ) {
1229        success = FALSE;
1230    } else if( *end != '-' ) {
1231        b = a;
1232        success = TRUE;
1233    } else {
1234        const char * pch = end + 1;
1235        b = strtol( pch, &end, 10 );
1236        if( errno || ( pch == end ) )
1237            success = FALSE;
1238        else if( *end ) /* trailing data */
1239            success = FALSE;
1240        else
1241            success = TRUE;
1242    }
1243    tr_free( tmp );
1244
1245    setme->low = MIN( a, b );
1246    setme->high = MAX( a, b );
1247
1248    errno = error;
1249    return success;
1250}
1251
1252static int
1253compareInt( const void * va, const void * vb )
1254{
1255    const int a = *(const int *)va;
1256    const int b = *(const int *)vb;
1257    return a - b;
1258}
1259
1260/**
1261 * Given a string like "1-4" or "1-4,6,9,14-51", this allocates and returns an
1262 * array of setmeCount ints of all the values in the array.
1263 * For example, "5-8" will return [ 5, 6, 7, 8 ] and setmeCount will be 4.
1264 * It's the caller's responsibility to call tr_free() on the returned array.
1265 * If a fragment of the string can't be parsed, NULL is returned.
1266 */
1267int*
1268tr_parseNumberRange( const char * str_in, int len, int * setmeCount )
1269{
1270    int n = 0;
1271    int * uniq = NULL;
1272    char * str = tr_strndup( str_in, len );
1273    const char * walk;
1274    tr_list * ranges = NULL;
1275    tr_bool success = TRUE;
1276
1277    walk = str;
1278    while( walk && *walk && success ) {
1279        struct number_range range;
1280        const char * pch = strchr( walk, ',' );
1281        if( pch ) {
1282            success = parseNumberSection( walk, pch-walk, &range );
1283            walk = pch + 1;
1284        } else {
1285            success = parseNumberSection( walk, strlen( walk ), &range );
1286            walk += strlen( walk );
1287        }
1288        if( success )
1289            tr_list_append( &ranges, tr_memdup( &range, sizeof( struct number_range ) ) );
1290    }
1291
1292    if( !success )
1293    {
1294        *setmeCount = 0;
1295        uniq = NULL;
1296    }
1297    else
1298    {
1299        int i;
1300        int n2;
1301        tr_list * l;
1302        int * sorted = NULL;
1303
1304        /* build a sorted number array */
1305        n = n2 = 0;
1306        for( l=ranges; l!=NULL; l=l->next ) {
1307            const struct number_range * r = l->data;
1308            n += r->high + 1 - r->low;
1309        }
1310        sorted = tr_new( int, n );
1311        for( l=ranges; l!=NULL; l=l->next ) {
1312            const struct number_range * r = l->data;
1313            int i;
1314            for( i=r->low; i<=r->high; ++i )
1315                sorted[n2++] = i;
1316        }
1317        qsort( sorted, n, sizeof( int ), compareInt );
1318        assert( n == n2 );
1319
1320        /* remove duplicates */
1321        uniq = tr_new( int, n );
1322        for( i=n=0; i<n2; ++i )
1323            if( !n || uniq[n-1] != sorted[i] )
1324                uniq[n++] = sorted[i];
1325
1326        tr_free( sorted );
1327    }
1328
1329    /* cleanup */
1330    tr_list_free( &ranges, tr_free );
1331    tr_free( str );
1332
1333    /* return the result */
1334    *setmeCount = n;
1335    return uniq;
1336}
1337
1338/***
1339****
1340***/
1341
1342double
1343tr_truncd( double x, int decimal_places )
1344{
1345    static const int multiplier[] = { 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000 };
1346    const int64_t i = multiplier[decimal_places];
1347    double x2 = (int64_t)(x*i);
1348    return x2 / i;
1349}
1350
1351char*
1352tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity )
1353{
1354    if( (int)ratio == TR_RATIO_NA )
1355        tr_strlcpy( buf, _( "None" ), buflen );
1356    else if( (int)ratio == TR_RATIO_INF )
1357        tr_strlcpy( buf, infinity, buflen );
1358    else if( ratio < 10.0 )
1359        tr_snprintf( buf, buflen, "%.2f", tr_truncd( ratio, 2 ) );
1360    else if( ratio < 100.0 )
1361        tr_snprintf( buf, buflen, "%.1f", tr_truncd( ratio, 1 ) );
1362    else
1363        tr_snprintf( buf, buflen, "%'.0f", ratio );
1364    return buf;
1365}
1366
1367/***
1368****
1369***/
1370
1371int
1372tr_moveFile( const char * oldpath, const char * newpath, tr_bool * renamed )
1373{
1374    int in;
1375    int out;
1376    char * buf;
1377    struct stat st;
1378    off_t bytesLeft;
1379    off_t buflen;
1380
1381    /* make sure the old file exists */
1382    if( stat( oldpath, &st ) ) {
1383        const int err = errno;
1384        errno = err;
1385        return -1;
1386    }
1387    if( !S_ISREG( st.st_mode ) ) {
1388        errno = ENOENT;
1389        return -1;
1390    }
1391    bytesLeft = st.st_size;
1392
1393    /* make sure the target directory exists */
1394    {
1395        char * newdir = tr_dirname( newpath );
1396        int i = tr_mkdirp( newdir, 0777 );
1397        tr_free( newdir );
1398        if( i )
1399            return i;
1400    }
1401
1402    /* they might be on the same filesystem... */
1403    {
1404        const int i = rename( oldpath, newpath );
1405        if( renamed != NULL )
1406            *renamed = i == 0;
1407        if( !i )
1408            return 0;
1409    }
1410
1411    /* copy the file */
1412    in = tr_open_file_for_scanning( oldpath );
1413    out = tr_open_file_for_writing( newpath );
1414    buflen = stat( newpath, &st ) ? 4096 : st.st_blksize;
1415    buf = tr_valloc( buflen );
1416    while( bytesLeft > 0 )
1417    {
1418        ssize_t bytesWritten;
1419        const off_t bytesThisPass = MIN( bytesLeft, buflen );
1420        const int numRead = read( in, buf, bytesThisPass );
1421        if( numRead < 0 )
1422            break;
1423        bytesWritten = write( out, buf, numRead );
1424        if( bytesWritten < 0 )
1425            break;
1426        bytesLeft -= bytesWritten;
1427    }
1428
1429    /* cleanup */
1430    tr_free( buf );
1431    tr_close_file( out );
1432    tr_close_file( in );
1433    if( bytesLeft != 0 )
1434        return -1;
1435
1436    unlink( oldpath );
1437    return 0;
1438}
1439
1440/***
1441****
1442***/
1443
1444void*
1445tr_valloc( size_t bufLen )
1446{
1447    size_t allocLen;
1448    void * buf = NULL;
1449    static size_t pageSize = 0;
1450
1451    if( !pageSize ) {
1452#ifdef HAVE_GETPAGESIZE
1453        pageSize = getpagesize();
1454#else /* guess */
1455        pageSize = 4096;
1456#endif
1457    }
1458
1459    allocLen = pageSize;
1460    while( allocLen < bufLen )
1461        allocLen += pageSize;
1462
1463#ifdef HAVE_POSIX_MEMALIGN
1464    if( !buf )
1465        posix_memalign( &buf, pageSize, allocLen );
1466#endif
1467#ifdef HAVE_VALLOC
1468    if( !buf )
1469        buf = valloc( allocLen );
1470#endif
1471    if( !buf )
1472        buf = malloc( allocLen );
1473
1474    tr_dbg( "tr_valloc(%zu) allocating %zu bytes", bufLen, allocLen );
1475    return buf;
1476}
Note: See TracBrowser for help on using the repository browser.