source: trunk/libtransmission/utils.c @ 10911

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

(trunk libT) fix a couple of minor warnings found by -Wfloat-equal

  • Property svn:keywords set to Date Rev Author Id
File size: 35.5 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 10911 2010-06-30 15:05:43Z 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(), fabs() */
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 <w32api.h>
42 #define WINVER WindowsXP /* freeaddrinfo(), getaddrinfo(), getnameinfo() */
43 #include <direct.h> /* _getcwd() */
44 #include <windows.h> /* Sleep() */
45#endif
46
47#include "transmission.h"
48#include "fdlimit.h"
49#include "ConvertUTF.h"
50#include "list.h"
51#include "net.h"
52#include "utils.h"
53#include "platform.h"
54#include "version.h"
55
56
57time_t transmission_now = 0;
58
59int                   messageLevel = TR_MSG_INF;
60static tr_lock *      messageLock = NULL;
61static tr_bool        messageQueuing = FALSE;
62static tr_msg_list *  messageQueue = NULL;
63static tr_msg_list ** messageQueueTail = &messageQueue;
64static int            messageQueueCount = 0;
65
66#ifndef WIN32
67    /* make null versions of these win32 functions */
68    static inline int IsDebuggerPresent( void ) { return FALSE; }
69    static inline void OutputDebugString( const void * unused UNUSED ) { }
70#endif
71
72/***
73****
74***/
75
76void
77tr_msgInit( void )
78{
79    const char * env = getenv( "TR_DEBUG" );
80    messageLevel = ( env ? atoi( env ) : 0 ) + 1;
81    messageLevel = MAX( 1, messageLevel );
82
83    if( messageLock == NULL )
84        messageLock = tr_lockNew( );
85}
86
87FILE*
88tr_getLog( void )
89{
90    static tr_bool initialized = FALSE;
91    static FILE * file = NULL;
92
93    if( !initialized )
94    {
95        const char * str = getenv( "TR_DEBUG_FD" );
96        int          fd = 0;
97        if( str && *str )
98            fd = atoi( str );
99        switch( fd )
100        {
101            case 1:
102                file = stdout; break;
103
104            case 2:
105                file = stderr; break;
106
107            default:
108                file = NULL; break;
109        }
110        initialized = TRUE;
111    }
112
113    return file;
114}
115
116void
117tr_setMessageLevel( int level )
118{
119    messageLevel = MAX( 0, level );
120}
121
122int
123tr_getMessageLevel( void )
124{
125    return messageLevel;
126}
127
128void
129tr_setMessageQueuing( tr_bool enabled )
130{
131    messageQueuing = enabled;
132}
133
134tr_bool
135tr_getMessageQueuing( void )
136{
137    return messageQueuing != 0;
138}
139
140tr_msg_list *
141tr_getQueuedMessages( void )
142{
143    tr_msg_list * ret;
144    tr_lockLock( messageLock );
145
146    ret = messageQueue;
147    messageQueue = NULL;
148    messageQueueTail = &messageQueue;
149
150    messageQueueCount = 0;
151
152    tr_lockUnlock( messageLock );
153    return ret;
154}
155
156void
157tr_freeMessageList( tr_msg_list * list )
158{
159    tr_msg_list * next;
160
161    while( NULL != list )
162    {
163        next = list->next;
164        free( list->message );
165        free( list->name );
166        free( list );
167        list = next;
168    }
169}
170
171/**
172***
173**/
174
175struct tm *
176tr_localtime_r( const time_t *_clock, struct tm *_result )
177{
178#ifdef HAVE_LOCALTIME_R
179    return localtime_r( _clock, _result );
180#else
181    struct tm *p = localtime( _clock );
182    if( p )
183        *(_result) = *p;
184    return p;
185#endif
186}
187
188char*
189tr_getLogTimeStr( char * buf, int buflen )
190{
191    char           tmp[64];
192    struct tm      now_tm;
193    struct timeval tv;
194    time_t         seconds;
195    int            milliseconds;
196
197    gettimeofday( &tv, NULL );
198
199    seconds = tv.tv_sec;
200    tr_localtime_r( &seconds, &now_tm );
201    strftime( tmp, sizeof( tmp ), "%H:%M:%S", &now_tm );
202    milliseconds = (int)( tv.tv_usec / 1000 );
203    tr_snprintf( buf, buflen, "%s.%03d", tmp, milliseconds );
204
205    return buf;
206}
207
208tr_bool
209tr_deepLoggingIsActive( void )
210{
211    static int8_t deepLoggingIsActive = -1;
212
213    if( deepLoggingIsActive < 0 )
214        deepLoggingIsActive = IsDebuggerPresent() || (tr_getLog()!=NULL);
215
216    return deepLoggingIsActive != 0;
217}
218
219void
220tr_deepLog( const char  * file,
221            int           line,
222            const char  * name,
223            const char  * fmt,
224            ... )
225{
226    FILE * fp = tr_getLog( );
227    if( fp || IsDebuggerPresent( ) )
228    {
229        va_list           args;
230        char              timestr[64];
231        struct evbuffer * buf = evbuffer_new( );
232        char *            base = tr_basename( file );
233
234        evbuffer_add_printf( buf, "[%s] ",
235                            tr_getLogTimeStr( timestr, sizeof( timestr ) ) );
236        if( name )
237            evbuffer_add_printf( buf, "%s ", name );
238        va_start( args, fmt );
239        evbuffer_add_vprintf( buf, fmt, args );
240        va_end( args );
241        evbuffer_add_printf( buf, " (%s:%d)\n", base, line );
242        /* FIXME(libevent2) ifdef this out for nonwindows platforms */
243        OutputDebugString( EVBUFFER_DATA( buf ) );
244        if(fp) /* FIXME(libevent2) tr_getLog() should return an fd, then use evbuffer_write() here ) */
245            (void) fwrite( EVBUFFER_DATA( buf ), 1, EVBUFFER_LENGTH( buf ), fp );
246
247        tr_free( base );
248        evbuffer_free( buf );
249    }
250}
251
252/***
253****
254***/
255
256void
257tr_msg( const char * file, int line,
258        int level, const char * name,
259        const char * fmt, ... )
260{
261    const int err = errno; /* message logging shouldn't affect errno */
262    char buf[1024];
263    va_list ap;
264
265    if( messageLock != NULL )
266        tr_lockLock( messageLock );
267
268    /* build the text message */
269    *buf = '\0';
270    va_start( ap, fmt );
271    evutil_vsnprintf( buf, sizeof( buf ), fmt, ap );
272    va_end( ap );
273
274    OutputDebugString( buf );
275
276    if( *buf )
277    {
278        if( messageQueuing )
279        {
280            tr_msg_list * newmsg;
281            newmsg = tr_new0( tr_msg_list, 1 );
282            newmsg->level = level;
283            newmsg->when = tr_time( );
284            newmsg->message = tr_strdup( buf );
285            newmsg->file = file;
286            newmsg->line = line;
287            newmsg->name = tr_strdup( name );
288
289            *messageQueueTail = newmsg;
290            messageQueueTail = &newmsg->next;
291            ++messageQueueCount;
292
293            if( messageQueueCount > TR_MAX_MSG_LOG )
294            {
295                tr_msg_list * old = messageQueue;
296                messageQueue = old->next;
297                old->next = NULL;
298                tr_freeMessageList(old);
299
300                --messageQueueCount;
301
302                assert( messageQueueCount == TR_MAX_MSG_LOG );
303            }
304        }
305        else
306        {
307            char timestr[64];
308            FILE * fp;
309
310            fp = tr_getLog( );
311            if( fp == NULL )
312                fp = stderr;
313
314            tr_getLogTimeStr( timestr, sizeof( timestr ) );
315
316            if( name )
317                fprintf( fp, "[%s] %s: %s\n", timestr, name, buf );
318            else
319                fprintf( fp, "[%s] %s\n", timestr, buf );
320            fflush( fp );
321        }
322    }
323
324    if( messageLock != NULL )
325        tr_lockUnlock( messageLock );
326
327    errno = err;
328}
329
330/***
331****
332***/
333
334void
335tr_set_compare( const void * va,
336                size_t aCount,
337                const void * vb,
338                size_t bCount,
339                int compare( const void * a, const void * b ),
340                size_t elementSize,
341                tr_set_func in_a_cb,
342                tr_set_func in_b_cb,
343                tr_set_func in_both_cb,
344                void * userData )
345{
346    const uint8_t * a = (const uint8_t *) va;
347    const uint8_t * b = (const uint8_t *) vb;
348    const uint8_t * aend = a + elementSize * aCount;
349    const uint8_t * bend = b + elementSize * bCount;
350
351    while( a != aend || b != bend )
352    {
353        if( a == aend )
354        {
355            ( *in_b_cb )( (void*)b, userData );
356            b += elementSize;
357        }
358        else if( b == bend )
359        {
360            ( *in_a_cb )( (void*)a, userData );
361            a += elementSize;
362        }
363        else
364        {
365            const int val = ( *compare )( a, b );
366
367            if( !val )
368            {
369                ( *in_both_cb )( (void*)a, userData );
370                a += elementSize;
371                b += elementSize;
372            }
373            else if( val < 0 )
374            {
375                ( *in_a_cb )( (void*)a, userData );
376                a += elementSize;
377            }
378            else if( val > 0 )
379            {
380                ( *in_b_cb )( (void*)b, userData );
381                b += elementSize;
382            }
383        }
384    }
385}
386
387/***
388****
389***/
390
391const char*
392tr_strip_positional_args( const char* str )
393{
394    const char * in = str;
395    static size_t bufsize = 0;
396    static char * buf = NULL;
397    const size_t  len = strlen( str );
398    char *        out;
399
400    if( bufsize < len )
401    {
402        bufsize = len * 2;
403        buf = tr_renew( char, buf, bufsize );
404    }
405
406    for( out = buf; *str; ++str )
407    {
408        *out++ = *str;
409
410        if( ( *str == '%' ) && isdigit( str[1] ) )
411        {
412            const char * tmp = str + 1;
413            while( isdigit( *tmp ) )
414                ++tmp;
415            if( *tmp == '$' )
416                str = tmp[1]=='\'' ? tmp+1 : tmp;
417        }
418
419        if( ( *str == '%' ) && ( str[1] == '\'' ) )
420            str = str + 1;
421 
422    }
423    *out = '\0';
424
425    return strcmp( buf, in ) ? buf : in;
426}
427
428/**
429***
430**/
431
432void
433tr_timerAdd( struct event * timer, int seconds, int microseconds )
434{
435    struct timeval tv;
436    tv.tv_sec = seconds;
437    tv.tv_usec = microseconds;
438
439    assert( tv.tv_sec >= 0 );
440    assert( tv.tv_usec >= 0 );
441    assert( tv.tv_usec < 1000000 );
442
443    evtimer_add( timer, &tv );
444}
445
446void
447tr_timerAddMsec( struct event * timer, int msec )
448{
449    const int seconds =  msec / 1000;
450    const int usec = (msec%1000) * 1000;
451    tr_timerAdd( timer, seconds, usec );
452}
453
454/**
455***
456**/
457
458uint8_t *
459tr_loadFile( const char * path,
460             size_t *     size )
461{
462    uint8_t * buf;
463    struct stat  sb;
464    int fd;
465    ssize_t n;
466    const char * err_fmt = _( "Couldn't read \"%1$s\": %2$s" );
467
468    /* try to stat the file */
469    errno = 0;
470    if( stat( path, &sb ) )
471    {
472        const int err = errno;
473        tr_dbg( err_fmt, path, tr_strerror( errno ) );
474        errno = err;
475        return NULL;
476    }
477
478    if( ( sb.st_mode & S_IFMT ) != S_IFREG )
479    {
480        tr_err( err_fmt, path, _( "Not a regular file" ) );
481        errno = EISDIR;
482        return NULL;
483    }
484
485    /* Load the torrent file into our buffer */
486    fd = tr_open_file_for_scanning( path );
487    if( fd < 0 )
488    {
489        const int err = errno;
490        tr_err( err_fmt, path, tr_strerror( errno ) );
491        errno = err;
492        return NULL;
493    }
494    buf = malloc( sb.st_size + 1 );
495    if( !buf )
496    {
497        const int err = errno;
498        tr_err( err_fmt, path, _( "Memory allocation failed" ) );
499        tr_close_file( fd );
500        errno = err;
501        return NULL;
502    }
503    n = read( fd, buf, sb.st_size );
504    if( n == -1 )
505    {
506        const int err = errno;
507        tr_err( err_fmt, path, tr_strerror( errno ) );
508        tr_close_file( fd );
509        free( buf );
510        errno = err;
511        return NULL;
512    }
513
514    tr_close_file( fd );
515    buf[ sb.st_size ] = '\0';
516    *size = sb.st_size;
517    return buf;
518}
519
520char*
521tr_basename( const char * path )
522{
523    char * tmp = tr_strdup( path );
524    char * ret = tr_strdup( basename( tmp ) );
525    tr_free( tmp );
526    return ret;
527}
528
529char*
530tr_dirname( const char * path )
531{
532    char * tmp = tr_strdup( path );
533    char * ret = tr_strdup( dirname( tmp ) );
534    tr_free( tmp );
535    return ret;
536}
537
538int
539tr_mkdir( const char * path,
540          int permissions
541#ifdef WIN32
542                       UNUSED
543#endif
544        )
545{
546#ifdef WIN32
547    if( path && isalpha( path[0] ) && path[1] == ':' && !path[2] )
548        return 0;
549    return mkdir( path );
550#else
551    return mkdir( path, permissions );
552#endif
553}
554
555int
556tr_mkdirp( const char * path_in,
557           int          permissions )
558{
559    char *      path = tr_strdup( path_in );
560    char *      p, * pp;
561    struct stat sb;
562    int         done;
563
564    /* walk past the root */
565    p = path;
566    while( *p == TR_PATH_DELIMITER )
567        ++p;
568
569    pp = p;
570    done = 0;
571    while( ( p =
572                strchr( pp, TR_PATH_DELIMITER ) ) || ( p = strchr( pp, '\0' ) ) )
573    {
574        if( !*p )
575            done = 1;
576        else
577            *p = '\0';
578
579        if( stat( path, &sb ) )
580        {
581            /* Folder doesn't exist yet */
582            if( tr_mkdir( path, permissions ) )
583            {
584                const int err = errno;
585                tr_err( _(
586                           "Couldn't create \"%1$s\": %2$s" ), path,
587                       tr_strerror( err ) );
588                tr_free( path );
589                errno = err;
590                return -1;
591            }
592        }
593        else if( ( sb.st_mode & S_IFMT ) != S_IFDIR )
594        {
595            /* Node exists but isn't a folder */
596            char * buf = tr_strdup_printf( _( "File \"%s\" is in the way" ), path );
597            tr_err( _( "Couldn't create \"%1$s\": %2$s" ), path_in, buf );
598            tr_free( buf );
599            tr_free( path );
600            errno = ENOTDIR;
601            return -1;
602        }
603
604        if( done )
605            break;
606
607        *p = TR_PATH_DELIMITER;
608        p++;
609        pp = p;
610    }
611
612    tr_free( path );
613    return 0;
614}
615
616char*
617tr_buildPath( const char *first_element, ... )
618{
619    size_t bufLen = 0;
620    const char * element;
621    char * buf;
622    char * pch;
623    va_list vl;
624
625    /* pass 1: allocate enough space for the string */
626    va_start( vl, first_element );
627    element = first_element;
628    while( element ) {
629        bufLen += strlen( element ) + 1;
630        element = (const char*) va_arg( vl, const char* );
631    }
632    pch = buf = tr_new( char, bufLen );
633    va_end( vl );
634
635    /* pass 2: build the string piece by piece */
636    va_start( vl, first_element );
637    element = first_element;
638    while( element ) {
639        const size_t elementLen = strlen( element );
640        memcpy( pch, element, elementLen );
641        pch += elementLen;
642        *pch++ = TR_PATH_DELIMITER;
643        element = (const char*) va_arg( vl, const char* );
644    }
645    va_end( vl );
646
647    /* terminate the string.  if nonempty, eat the unwanted trailing slash */
648    if( pch != buf )
649        --pch;
650    *pch++ = '\0';
651
652    /* sanity checks & return */
653    assert( pch - buf == (off_t)bufLen );
654    return buf;
655}
656
657/****
658*****
659****/
660
661char*
662tr_strndup( const void * in, int len )
663{
664    char * out = NULL;
665
666    if( len < 0 )
667    {
668        out = tr_strdup( in );
669    }
670    else if( in )
671    {
672        out = tr_malloc( len + 1 );
673        memcpy( out, in, len );
674        out[len] = '\0';
675    }
676
677    return out;
678}
679
680const char*
681tr_memmem( const char * haystack, size_t haystacklen,
682           const char * needle, size_t needlelen )
683{
684#ifdef HAVE_MEMMEM
685    return memmem( haystack, haystacklen, needle, needlelen );
686#else
687    size_t i;
688    if( !needlelen )
689        return haystack;
690    if( needlelen > haystacklen || !haystack || !needle )
691        return NULL;
692    for( i=0; i<=haystacklen-needlelen; ++i )
693        if( !memcmp( haystack+i, needle, needlelen ) )
694            return haystack+i;
695    return NULL;
696#endif
697}
698
699char*
700tr_strdup_printf( const char * fmt, ... )
701{
702    va_list ap;
703    char * ret;
704    size_t len;
705    char statbuf[2048];
706
707    va_start( ap, fmt );
708    len = evutil_vsnprintf( statbuf, sizeof( statbuf ), fmt, ap );
709    va_end( ap );
710    if( len < sizeof( statbuf ) )
711        ret = tr_strndup( statbuf, len );
712    else {
713        ret = tr_new( char, len + 1 );
714        va_start( ap, fmt );
715        evutil_vsnprintf( ret, len + 1, fmt, ap );
716        va_end( ap );
717    }
718
719    return ret;
720}
721
722const char*
723tr_strerror( int i )
724{
725    const char * ret = strerror( i );
726
727    if( ret == NULL )
728        ret = "Unknown Error";
729    return ret;
730}
731
732/****
733*****
734****/
735
736char*
737tr_strstrip( char * str )
738{
739    if( str != NULL )
740    {
741        size_t pos;
742        size_t len = strlen( str );
743
744        while( len && isspace( str[len - 1] ) )
745            --len;
746
747        for( pos = 0; pos < len && isspace( str[pos] ); )
748            ++pos;
749
750        len -= pos;
751        memmove( str, str + pos, len );
752        str[len] = '\0';
753    }
754
755    return str;
756}
757
758tr_bool
759tr_str_has_suffix( const char *str, const char *suffix )
760{
761    size_t str_len;
762    size_t suffix_len;
763
764    if( !str )
765        return FALSE;
766    if( !suffix )
767        return TRUE;
768
769    str_len = strlen( str );
770    suffix_len = strlen( suffix );
771    if( str_len < suffix_len )
772        return FALSE;
773
774    return !strncasecmp( str + str_len - suffix_len, suffix, suffix_len );
775}
776
777/****
778*****
779****/
780
781uint64_t
782tr_date( void )
783{
784    struct timeval tv;
785
786    gettimeofday( &tv, NULL );
787    return (uint64_t) tv.tv_sec * 1000 + ( tv.tv_usec / 1000 );
788}
789
790void
791tr_wait_msec( uint64_t delay_milliseconds )
792{
793#ifdef WIN32
794    Sleep( (DWORD)delay_milliseconds );
795#else
796    usleep( 1000 * delay_milliseconds );
797#endif
798}
799
800/***
801****
802***/
803
804int
805tr_snprintf( char * buf, size_t buflen, const char * fmt, ... )
806{
807    int     len;
808    va_list args;
809
810    va_start( args, fmt );
811    len = evutil_vsnprintf( buf, buflen, fmt, args );
812    va_end( args );
813    return len;
814}
815
816/*
817 * Copy src to string dst of size siz.  At most siz-1 characters
818 * will be copied.  Always NUL terminates (unless siz == 0).
819 * Returns strlen(src); if retval >= siz, truncation occurred.
820 */
821size_t
822tr_strlcpy( char *       dst,
823            const void * src,
824            size_t       siz )
825{
826#ifdef HAVE_STRLCPY
827    return strlcpy( dst, src, siz );
828#else
829    char *      d = dst;
830    const char *s = src;
831    size_t      n = siz;
832
833    assert( s );
834    assert( d );
835
836    /* Copy as many bytes as will fit */
837    if( n != 0 )
838    {
839        while( --n != 0 )
840        {
841            if( ( *d++ = *s++ ) == '\0' )
842                break;
843        }
844    }
845
846    /* Not enough room in dst, add NUL and traverse rest of src */
847    if( n == 0 )
848    {
849        if( siz != 0 )
850            *d = '\0'; /* NUL-terminate dst */
851        while( *s++ )
852            ;
853    }
854
855    return s - (char*)src - 1;  /* count does not include NUL */
856#endif
857}
858
859/***
860****
861***/
862
863double
864tr_getRatio( double numerator, double denominator )
865{
866    double ratio;
867
868    if( fabs(denominator) > 0.01 )
869        ratio = numerator / denominator;
870    else if( fabs(numerator) > 0.01 )
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    const int i = (int) pow( 10, decimal_places ); 
1346    double x2 = (int)(x*i);
1347    return x2 / i;
1348}
1349
1350char*
1351tr_strtruncd( char * buf, double x, int precision, size_t buflen )
1352{
1353    tr_snprintf( buf, buflen, "%.*f", precision, tr_truncd( x, precision ) );
1354
1355    return buf;
1356}
1357
1358char*
1359tr_strpercent( char * buf, double x, size_t buflen )
1360{
1361    if( x < 10.0 )
1362        tr_strtruncd( buf, x, 2, buflen );
1363    else if( x < 100.0 )
1364        tr_strtruncd( buf, x, 1, buflen );
1365    else
1366        tr_strtruncd( buf, x, 0, buflen );
1367    return buf;
1368}
1369
1370char*
1371tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity )
1372{
1373    if( (int)ratio == TR_RATIO_NA )
1374        tr_strlcpy( buf, _( "None" ), buflen );
1375    else if( (int)ratio == TR_RATIO_INF )
1376        tr_strlcpy( buf, infinity, buflen );
1377    else
1378        tr_strpercent( buf, ratio, buflen );
1379    return buf;
1380}
1381
1382/***
1383****
1384***/
1385
1386int
1387tr_moveFile( const char * oldpath, const char * newpath, tr_bool * renamed )
1388{
1389    int in;
1390    int out;
1391    char * buf;
1392    struct stat st;
1393    off_t bytesLeft;
1394    const off_t buflen = 1024 * 128; /* 128 KiB buffer */
1395
1396    /* make sure the old file exists */
1397    if( stat( oldpath, &st ) ) {
1398        const int err = errno;
1399        errno = err;
1400        return -1;
1401    }
1402    if( !S_ISREG( st.st_mode ) ) {
1403        errno = ENOENT;
1404        return -1;
1405    }
1406    bytesLeft = st.st_size;
1407
1408    /* make sure the target directory exists */
1409    {
1410        char * newdir = tr_dirname( newpath );
1411        int i = tr_mkdirp( newdir, 0777 );
1412        tr_free( newdir );
1413        if( i )
1414            return i;
1415    }
1416
1417    /* they might be on the same filesystem... */
1418    {
1419        const int i = rename( oldpath, newpath );
1420        if( renamed != NULL )
1421            *renamed = i == 0;
1422        if( !i )
1423            return 0;
1424    }
1425
1426    /* copy the file */
1427    in = tr_open_file_for_scanning( oldpath );
1428    out = tr_open_file_for_writing( newpath );
1429    buf = tr_valloc( buflen );
1430    while( bytesLeft > 0 )
1431    {
1432        ssize_t bytesWritten;
1433        const off_t bytesThisPass = MIN( bytesLeft, buflen );
1434        const int numRead = read( in, buf, bytesThisPass );
1435        if( numRead < 0 )
1436            break;
1437        bytesWritten = write( out, buf, numRead );
1438        if( bytesWritten < 0 )
1439            break;
1440        bytesLeft -= bytesWritten;
1441    }
1442
1443    /* cleanup */
1444    tr_free( buf );
1445    tr_close_file( out );
1446    tr_close_file( in );
1447    if( bytesLeft != 0 )
1448        return -1;
1449
1450    unlink( oldpath );
1451    return 0;
1452}
1453
1454/***
1455****
1456***/
1457
1458void*
1459tr_valloc( size_t bufLen )
1460{
1461    size_t allocLen;
1462    void * buf = NULL;
1463    static size_t pageSize = 0;
1464
1465    if( !pageSize ) {
1466#ifdef HAVE_GETPAGESIZE
1467        pageSize = getpagesize();
1468#else /* guess */
1469        pageSize = 4096;
1470#endif
1471    }
1472
1473    allocLen = pageSize;
1474    while( allocLen < bufLen )
1475        allocLen += pageSize;
1476
1477#ifdef HAVE_POSIX_MEMALIGN
1478    if( !buf )
1479        posix_memalign( &buf, pageSize, allocLen );
1480#endif
1481#ifdef HAVE_VALLOC
1482    if( !buf )
1483        buf = valloc( allocLen );
1484#endif
1485    if( !buf )
1486        buf = malloc( allocLen );
1487
1488    tr_dbg( "tr_valloc(%zu) allocating %zu bytes", bufLen, allocLen );
1489    return buf;
1490}
1491
1492char *
1493tr_realpath( const char * path, char * resolved_path )
1494{
1495#ifdef WIN32
1496    /* From a message to the Mingw-msys list, Jun 2, 2005 by Mark Junker. */
1497    if( GetFullPathNameA( path, TR_PATH_MAX, resolved_path, NULL ) == 0 )
1498        return NULL;
1499    return resolved_path;
1500#else
1501    return realpath( path, resolved_path );
1502#endif
1503}
1504
1505/***
1506****
1507****
1508****
1509***/
1510
1511struct formatter_unit
1512{
1513    char * name;
1514    double value;
1515};
1516 
1517struct formatter_units
1518{
1519    struct formatter_unit units[4];
1520};
1521
1522static void
1523formatter_init( struct formatter_units * units,
1524                double kilo,
1525                const char * b, const char * kb,
1526                const char * mb, const char * gb )
1527{
1528    units->units[TR_FMT_B].name = tr_strdup( b );
1529    units->units[TR_FMT_B].value = 1;
1530
1531    units->units[TR_FMT_KB].name = tr_strdup( kb );
1532    units->units[TR_FMT_KB].value = kilo;
1533
1534    units->units[TR_FMT_MB].name = tr_strdup( mb );
1535    units->units[TR_FMT_MB].value = pow( kilo, 2 );
1536
1537    units->units[TR_FMT_GB].name = tr_strdup( gb );
1538    units->units[TR_FMT_GB].value = pow( kilo, 3 );
1539}
1540
1541static const char*
1542tr_formatter_units( const struct formatter_units * u, int size )
1543{
1544    assert( u != NULL );
1545    assert( 0<=size && size<4 );
1546
1547    return u->units[size].name;
1548}
1549
1550static char*
1551formatter_get_size_str( const struct formatter_units * u,
1552                        char * buf, uint64_t bytes, size_t buflen )
1553{
1554    int precision;
1555    double value;
1556    const char * units;
1557    const struct formatter_unit * unit;
1558
1559         if( bytes < u->units[1].value ) unit = &u->units[0];
1560    else if( bytes < u->units[2].value ) unit = &u->units[1];
1561    else if( bytes < u->units[3].value ) unit = &u->units[2];
1562    else                                 unit = &u->units[3];
1563
1564    value = bytes / unit->value;
1565    units = unit->name;
1566    if( unit->value == 1 )
1567        precision = 0;
1568    else if( value < 100 )
1569        precision = 2;
1570    else
1571        precision = 1;
1572    tr_snprintf( buf, buflen, "%.*f %s", precision, value, units );
1573    return buf;
1574}
1575
1576static struct formatter_units size_units;
1577
1578void
1579tr_formatter_size_init( double kilo, const char * b, const char * kb,
1580                                     const char * mb, const char * gb )
1581{
1582    formatter_init( &size_units, kilo, b, kb, mb, gb );
1583}
1584
1585char*
1586tr_formatter_size( char * buf, uint64_t bytes, size_t buflen )
1587{
1588    return formatter_get_size_str( &size_units, buf, bytes, buflen );
1589}
1590
1591const char*
1592tr_formatter_size_units( int i )
1593{
1594    return tr_formatter_units( &size_units, i );
1595}
1596
1597static struct formatter_units speed_units;
1598
1599void
1600tr_formatter_speed_init( double kilo, const char * b, const char * kb,
1601                                      const char * mb, const char * gb )
1602{
1603    formatter_init( &speed_units, kilo, b, kb, mb, gb );
1604}
1605
1606char*
1607tr_formatter_speed( char * buf, uint64_t bytes_per_second, size_t buflen )
1608{
1609    return formatter_get_size_str( &speed_units, buf, bytes_per_second, buflen );
1610}
1611
1612const char*
1613tr_formatter_speed_units( int i )
1614{
1615    return tr_formatter_units( &speed_units, i );
1616}
Note: See TracBrowser for help on using the repository browser.