source: trunk/libtransmission/utils.c @ 10912

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

(trunk libT) down the rabbit hole: various minor type correctness changes unearthed by -Wconversion

  • Property svn:keywords set to Date Rev Author Id
File size: 35.6 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 10912 2010-06-30 16:40:19Z 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
59tr_msg_level 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( tr_msg_level level )
118{
119    messageLevel = level;
120}
121
122tr_msg_level
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        tr_msg_level level,
259        const char * name,
260        const char * fmt, ... )
261{
262    const int err = errno; /* message logging shouldn't affect errno */
263    char buf[1024];
264    va_list ap;
265
266    if( messageLock != NULL )
267        tr_lockLock( messageLock );
268
269    /* build the text message */
270    *buf = '\0';
271    va_start( ap, fmt );
272    evutil_vsnprintf( buf, sizeof( buf ), fmt, ap );
273    va_end( ap );
274
275    OutputDebugString( buf );
276
277    if( *buf )
278    {
279        if( messageQueuing )
280        {
281            tr_msg_list * newmsg;
282            newmsg = tr_new0( tr_msg_list, 1 );
283            newmsg->level = level;
284            newmsg->when = tr_time( );
285            newmsg->message = tr_strdup( buf );
286            newmsg->file = file;
287            newmsg->line = line;
288            newmsg->name = tr_strdup( name );
289
290            *messageQueueTail = newmsg;
291            messageQueueTail = &newmsg->next;
292            ++messageQueueCount;
293
294            if( messageQueueCount > TR_MAX_MSG_LOG )
295            {
296                tr_msg_list * old = messageQueue;
297                messageQueue = old->next;
298                old->next = NULL;
299                tr_freeMessageList(old);
300
301                --messageQueueCount;
302
303                assert( messageQueueCount == TR_MAX_MSG_LOG );
304            }
305        }
306        else
307        {
308            char timestr[64];
309            FILE * fp;
310
311            fp = tr_getLog( );
312            if( fp == NULL )
313                fp = stderr;
314
315            tr_getLogTimeStr( timestr, sizeof( timestr ) );
316
317            if( name )
318                fprintf( fp, "[%s] %s: %s\n", timestr, name, buf );
319            else
320                fprintf( fp, "[%s] %s\n", timestr, buf );
321            fflush( fp );
322        }
323    }
324
325    if( messageLock != NULL )
326        tr_lockUnlock( messageLock );
327
328    errno = err;
329}
330
331/***
332****
333***/
334
335void
336tr_set_compare( const void * va,
337                size_t aCount,
338                const void * vb,
339                size_t bCount,
340                int compare( const void * a, const void * b ),
341                size_t elementSize,
342                tr_set_func in_a_cb,
343                tr_set_func in_b_cb,
344                tr_set_func in_both_cb,
345                void * userData )
346{
347    const uint8_t * a = (const uint8_t *) va;
348    const uint8_t * b = (const uint8_t *) vb;
349    const uint8_t * aend = a + elementSize * aCount;
350    const uint8_t * bend = b + elementSize * bCount;
351
352    while( a != aend || b != bend )
353    {
354        if( a == aend )
355        {
356            ( *in_b_cb )( (void*)b, userData );
357            b += elementSize;
358        }
359        else if( b == bend )
360        {
361            ( *in_a_cb )( (void*)a, userData );
362            a += elementSize;
363        }
364        else
365        {
366            const int val = ( *compare )( a, b );
367
368            if( !val )
369            {
370                ( *in_both_cb )( (void*)a, userData );
371                a += elementSize;
372                b += elementSize;
373            }
374            else if( val < 0 )
375            {
376                ( *in_a_cb )( (void*)a, userData );
377                a += elementSize;
378            }
379            else if( val > 0 )
380            {
381                ( *in_b_cb )( (void*)b, userData );
382                b += elementSize;
383            }
384        }
385    }
386}
387
388/***
389****
390***/
391
392const char*
393tr_strip_positional_args( const char* str )
394{
395    const char * in = str;
396    static size_t bufsize = 0;
397    static char * buf = NULL;
398    const size_t  len = strlen( str );
399    char *        out;
400
401    if( bufsize < len )
402    {
403        bufsize = len * 2;
404        buf = tr_renew( char, buf, bufsize );
405    }
406
407    for( out = buf; *str; ++str )
408    {
409        *out++ = *str;
410
411        if( ( *str == '%' ) && isdigit( str[1] ) )
412        {
413            const char * tmp = str + 1;
414            while( isdigit( *tmp ) )
415                ++tmp;
416            if( *tmp == '$' )
417                str = tmp[1]=='\'' ? tmp+1 : tmp;
418        }
419
420        if( ( *str == '%' ) && ( str[1] == '\'' ) )
421            str = str + 1;
422 
423    }
424    *out = '\0';
425
426    return strcmp( buf, in ) ? buf : in;
427}
428
429/**
430***
431**/
432
433void
434tr_timerAdd( struct event * timer, int seconds, int microseconds )
435{
436    struct timeval tv;
437    tv.tv_sec = seconds;
438    tv.tv_usec = microseconds;
439
440    assert( tv.tv_sec >= 0 );
441    assert( tv.tv_usec >= 0 );
442    assert( tv.tv_usec < 1000000 );
443
444    evtimer_add( timer, &tv );
445}
446
447void
448tr_timerAddMsec( struct event * timer, int msec )
449{
450    const int seconds =  msec / 1000;
451    const int usec = (msec%1000) * 1000;
452    tr_timerAdd( timer, seconds, usec );
453}
454
455/**
456***
457**/
458
459uint8_t *
460tr_loadFile( const char * path,
461             size_t *     size )
462{
463    uint8_t * buf;
464    struct stat  sb;
465    int fd;
466    ssize_t n;
467    const char * const err_fmt = _( "Couldn't read \"%1$s\": %2$s" );
468
469    /* try to stat the file */
470    errno = 0;
471    if( stat( path, &sb ) )
472    {
473        const int err = errno;
474        tr_dbg( err_fmt, path, tr_strerror( errno ) );
475        errno = err;
476        return NULL;
477    }
478
479    if( ( sb.st_mode & S_IFMT ) != S_IFREG )
480    {
481        tr_err( err_fmt, path, _( "Not a regular file" ) );
482        errno = EISDIR;
483        return NULL;
484    }
485
486    /* Load the torrent file into our buffer */
487    fd = tr_open_file_for_scanning( path );
488    if( fd < 0 )
489    {
490        const int err = errno;
491        tr_err( err_fmt, path, tr_strerror( errno ) );
492        errno = err;
493        return NULL;
494    }
495    buf = malloc( sb.st_size + 1 );
496    if( !buf )
497    {
498        const int err = errno;
499        tr_err( err_fmt, path, _( "Memory allocation failed" ) );
500        tr_close_file( fd );
501        errno = err;
502        return NULL;
503    }
504    n = read( fd, buf, (size_t)sb.st_size );
505    if( n == -1 )
506    {
507        const int err = errno;
508        tr_err( err_fmt, path, tr_strerror( errno ) );
509        tr_close_file( fd );
510        free( buf );
511        errno = err;
512        return NULL;
513    }
514
515    tr_close_file( fd );
516    buf[ sb.st_size ] = '\0';
517    *size = sb.st_size;
518    return buf;
519}
520
521char*
522tr_basename( const char * path )
523{
524    char * tmp = tr_strdup( path );
525    char * ret = tr_strdup( basename( tmp ) );
526    tr_free( tmp );
527    return ret;
528}
529
530char*
531tr_dirname( const char * path )
532{
533    char * tmp = tr_strdup( path );
534    char * ret = tr_strdup( dirname( tmp ) );
535    tr_free( tmp );
536    return ret;
537}
538
539int
540tr_mkdir( const char * path,
541          int permissions
542#ifdef WIN32
543                       UNUSED
544#endif
545        )
546{
547#ifdef WIN32
548    if( path && isalpha( path[0] ) && path[1] == ':' && !path[2] )
549        return 0;
550    return mkdir( path );
551#else
552    return mkdir( path, permissions );
553#endif
554}
555
556int
557tr_mkdirp( const char * path_in,
558           int          permissions )
559{
560    char *      path = tr_strdup( path_in );
561    char *      p, * pp;
562    struct stat sb;
563    int         done;
564
565    /* walk past the root */
566    p = path;
567    while( *p == TR_PATH_DELIMITER )
568        ++p;
569
570    pp = p;
571    done = 0;
572    while( ( p =
573                strchr( pp, TR_PATH_DELIMITER ) ) || ( p = strchr( pp, '\0' ) ) )
574    {
575        if( !*p )
576            done = 1;
577        else
578            *p = '\0';
579
580        if( stat( path, &sb ) )
581        {
582            /* Folder doesn't exist yet */
583            if( tr_mkdir( path, permissions ) )
584            {
585                const int err = errno;
586                tr_err( _(
587                           "Couldn't create \"%1$s\": %2$s" ), path,
588                       tr_strerror( err ) );
589                tr_free( path );
590                errno = err;
591                return -1;
592            }
593        }
594        else if( ( sb.st_mode & S_IFMT ) != S_IFDIR )
595        {
596            /* Node exists but isn't a folder */
597            char * buf = tr_strdup_printf( _( "File \"%s\" is in the way" ), path );
598            tr_err( _( "Couldn't create \"%1$s\": %2$s" ), path_in, buf );
599            tr_free( buf );
600            tr_free( path );
601            errno = ENOTDIR;
602            return -1;
603        }
604
605        if( done )
606            break;
607
608        *p = TR_PATH_DELIMITER;
609        p++;
610        pp = p;
611    }
612
613    tr_free( path );
614    return 0;
615}
616
617char*
618tr_buildPath( const char *first_element, ... )
619{
620    size_t bufLen = 0;
621    const char * element;
622    char * buf;
623    char * pch;
624    va_list vl;
625
626    /* pass 1: allocate enough space for the string */
627    va_start( vl, first_element );
628    element = first_element;
629    while( element ) {
630        bufLen += strlen( element ) + 1;
631        element = (const char*) va_arg( vl, const char* );
632    }
633    pch = buf = tr_new( char, bufLen );
634    va_end( vl );
635
636    /* pass 2: build the string piece by piece */
637    va_start( vl, first_element );
638    element = first_element;
639    while( element ) {
640        const size_t elementLen = strlen( element );
641        memcpy( pch, element, elementLen );
642        pch += elementLen;
643        *pch++ = TR_PATH_DELIMITER;
644        element = (const char*) va_arg( vl, const char* );
645    }
646    va_end( vl );
647
648    /* terminate the string.  if nonempty, eat the unwanted trailing slash */
649    if( pch != buf )
650        --pch;
651    *pch++ = '\0';
652
653    /* sanity checks & return */
654    assert( pch - buf == (off_t)bufLen );
655    return buf;
656}
657
658/****
659*****
660****/
661
662char*
663tr_strndup( const void * in, int len )
664{
665    char * out = NULL;
666
667    if( len < 0 )
668    {
669        out = tr_strdup( in );
670    }
671    else if( in )
672    {
673        out = tr_malloc( len + 1 );
674        memcpy( out, in, len );
675        out[len] = '\0';
676    }
677
678    return out;
679}
680
681const char*
682tr_memmem( const char * haystack, size_t haystacklen,
683           const char * needle, size_t needlelen )
684{
685#ifdef HAVE_MEMMEM
686    return memmem( haystack, haystacklen, needle, needlelen );
687#else
688    size_t i;
689    if( !needlelen )
690        return haystack;
691    if( needlelen > haystacklen || !haystack || !needle )
692        return NULL;
693    for( i=0; i<=haystacklen-needlelen; ++i )
694        if( !memcmp( haystack+i, needle, needlelen ) )
695            return haystack+i;
696    return NULL;
697#endif
698}
699
700char*
701tr_strdup_printf( const char * fmt, ... )
702{
703    va_list ap;
704    char * ret;
705    size_t len;
706    char statbuf[2048];
707
708    va_start( ap, fmt );
709    len = evutil_vsnprintf( statbuf, sizeof( statbuf ), fmt, ap );
710    va_end( ap );
711    if( len < sizeof( statbuf ) )
712        ret = tr_strndup( statbuf, len );
713    else {
714        ret = tr_new( char, len + 1 );
715        va_start( ap, fmt );
716        evutil_vsnprintf( ret, len + 1, fmt, ap );
717        va_end( ap );
718    }
719
720    return ret;
721}
722
723const char*
724tr_strerror( int i )
725{
726    const char * ret = strerror( i );
727
728    if( ret == NULL )
729        ret = "Unknown Error";
730    return ret;
731}
732
733/****
734*****
735****/
736
737char*
738tr_strstrip( char * str )
739{
740    if( str != NULL )
741    {
742        size_t pos;
743        size_t len = strlen( str );
744
745        while( len && isspace( str[len - 1] ) )
746            --len;
747
748        for( pos = 0; pos < len && isspace( str[pos] ); )
749            ++pos;
750
751        len -= pos;
752        memmove( str, str + pos, len );
753        str[len] = '\0';
754    }
755
756    return str;
757}
758
759tr_bool
760tr_str_has_suffix( const char *str, const char *suffix )
761{
762    size_t str_len;
763    size_t suffix_len;
764
765    if( !str )
766        return FALSE;
767    if( !suffix )
768        return TRUE;
769
770    str_len = strlen( str );
771    suffix_len = strlen( suffix );
772    if( str_len < suffix_len )
773        return FALSE;
774
775    return !strncasecmp( str + str_len - suffix_len, suffix, suffix_len );
776}
777
778/****
779*****
780****/
781
782uint64_t
783tr_date( void )
784{
785    struct timeval tv;
786
787    gettimeofday( &tv, NULL );
788    return (uint64_t) tv.tv_sec * 1000 + ( tv.tv_usec / 1000 );
789}
790
791void
792tr_wait_msec( uint64_t delay_milliseconds )
793{
794#ifdef WIN32
795    Sleep( (DWORD)delay_milliseconds );
796#else
797    usleep( 1000 * delay_milliseconds );
798#endif
799}
800
801/***
802****
803***/
804
805int
806tr_snprintf( char * buf, size_t buflen, const char * fmt, ... )
807{
808    int     len;
809    va_list args;
810
811    va_start( args, fmt );
812    len = evutil_vsnprintf( buf, buflen, fmt, args );
813    va_end( args );
814    return len;
815}
816
817/*
818 * Copy src to string dst of size siz.  At most siz-1 characters
819 * will be copied.  Always NUL terminates (unless siz == 0).
820 * Returns strlen(src); if retval >= siz, truncation occurred.
821 */
822size_t
823tr_strlcpy( char *       dst,
824            const void * src,
825            size_t       siz )
826{
827#ifdef HAVE_STRLCPY
828    return strlcpy( dst, src, siz );
829#else
830    char *      d = dst;
831    const char *s = src;
832    size_t      n = siz;
833
834    assert( s );
835    assert( d );
836
837    /* Copy as many bytes as will fit */
838    if( n != 0 )
839    {
840        while( --n != 0 )
841        {
842            if( ( *d++ = *s++ ) == '\0' )
843                break;
844        }
845    }
846
847    /* Not enough room in dst, add NUL and traverse rest of src */
848    if( n == 0 )
849    {
850        if( siz != 0 )
851            *d = '\0'; /* NUL-terminate dst */
852        while( *s++ )
853            ;
854    }
855
856    return s - (char*)src - 1;  /* count does not include NUL */
857#endif
858}
859
860/***
861****
862***/
863
864double
865tr_getRatio( double numerator, double denominator )
866{
867    double ratio;
868
869    if( fabs(denominator) > 0.01 )
870        ratio = numerator / denominator;
871    else if( fabs(numerator) > 0.01 )
872        ratio = TR_RATIO_INF;
873    else
874        ratio = TR_RATIO_NA;
875
876    return ratio;
877}
878
879void
880tr_sha1_to_hex( char * out, const uint8_t * sha1 )
881{
882    int i;
883    static const char hex[] = "0123456789abcdef";
884
885    for( i=0; i<20; ++i )
886    {
887        const unsigned int val = *sha1++;
888        *out++ = hex[val >> 4];
889        *out++ = hex[val & 0xf];
890    }
891
892    *out = '\0';
893}
894
895void
896tr_hex_to_sha1( uint8_t * out, const char * in )
897{
898    int i;
899    static const char hex[] = "0123456789abcdef";
900
901    for( i=0; i<20; ++i )
902    {
903        const int hi = strchr( hex, tolower( *in++ ) ) - hex;
904        const int lo = strchr( hex, tolower( *in++ ) ) - hex;
905        *out++ = (uint8_t)( (hi<<4) | lo );
906    }
907}
908
909/***
910****
911***/
912
913static tr_bool
914isValidURLChars( const char * url )
915{
916    const char * c;
917    static const char * rfc2396_valid_chars =
918        "abcdefghijklmnopqrstuvwxyz" /* lowalpha */
919        "ABCDEFGHIJKLMNOPQRSTUVWXYZ" /* upalpha */
920        "0123456789"                 /* digit */
921        "-_.!~*'()"                  /* mark */
922        ";/?:@&=+$,"                 /* reserved */
923        "<>#%<\""                    /* delims */
924        "{}|\\^[]`";                 /* unwise */
925
926    if( url == NULL )
927        return FALSE;
928
929    for( c = url; c && *c; ++c )
930        if( !strchr( rfc2396_valid_chars, *c ) )
931            return FALSE;
932
933    return TRUE;
934}
935
936/** @brief return TRUE if the url is a http or https url that Transmission understands */
937tr_bool
938tr_urlIsValidTracker( const char * url )
939{
940    tr_bool valid;
941    char * scheme = NULL;
942
943    valid = isValidURLChars( url )
944         && !tr_urlParse( url, -1, &scheme, NULL, NULL, NULL )
945         && ( scheme != NULL )
946         && ( !strcmp(scheme,"http") || !strcmp(scheme,"https") );
947
948    tr_free( scheme );
949    return valid;
950}
951
952/** @brief return TRUE if the url is a http or https or ftp or sftp url that Transmission understands */
953tr_bool
954tr_urlIsValid( const char * url )
955{
956    tr_bool valid;
957    char * scheme = NULL;
958
959    valid = isValidURLChars( url )
960         && !tr_urlParse( url, -1, &scheme, NULL, NULL, NULL )
961         && ( scheme != NULL )
962         && ( !strcmp(scheme,"http") || !strcmp(scheme,"https") || !strcmp(scheme,"ftp") || !strcmp(scheme,"sftp") );
963
964    tr_free( scheme );
965    return valid;
966}
967
968tr_bool
969tr_addressIsIP( const char * address )
970{
971    tr_address tempAddr;
972    return tr_pton(address, &tempAddr) != NULL;
973}
974
975int
976tr_urlParse( const char * url_in,
977             int          len,
978             char **      setme_protocol,
979             char **      setme_host,
980             int *        setme_port,
981             char **      setme_path )
982{
983    int          err;
984    int          port = 0;
985    int          n;
986    char *       tmp;
987    char *       pch;
988    const char * protocol = NULL;
989    const char * host = NULL;
990    const char * path = NULL;
991
992    tmp = tr_strndup( url_in, len );
993    if( ( pch = strstr( tmp, "://" ) ) )
994    {
995        *pch = '\0';
996        protocol = tmp;
997        pch += 3;
998/*fprintf( stderr, "protocol is [%s]... what's left is [%s]\n", protocol, pch);*/
999        if( ( n = strcspn( pch, ":/" ) ) )
1000        {
1001            const int havePort = pch[n] == ':';
1002            host = pch;
1003            pch += n;
1004            *pch++ = '\0';
1005/*fprintf( stderr, "host is [%s]... what's left is [%s]\n", host, pch );*/
1006            if( havePort )
1007            {
1008                char * end;
1009                port = strtol( pch, &end, 10 );
1010                pch = end;
1011/*fprintf( stderr, "port is [%d]... what's left is [%s]\n", port, pch );*/
1012            }
1013            path = pch;
1014/*fprintf( stderr, "path is [%s]\n", path );*/
1015        }
1016    }
1017
1018    err = !host || !path || !protocol;
1019
1020    if( !err && !port )
1021    {
1022        if( !strcmp( protocol, "ftp" ) ) port = 21;
1023        if( !strcmp( protocol, "sftp" ) ) port = 22;
1024        if( !strcmp( protocol, "http" ) ) port = 80;
1025        if( !strcmp( protocol, "https" ) ) port = 443;
1026    }
1027
1028    if( !err )
1029    {
1030        if( setme_protocol ) *setme_protocol = tr_strdup( protocol );
1031
1032        if( setme_host ){ ( (char*)host )[-3] = ':'; *setme_host =
1033                              tr_strdup( host ); }
1034        if( setme_path ){ if( path[0] == '/' ) *setme_path = tr_strdup( path );
1035                          else { ( (char*)path )[-1] = '/'; *setme_path = tr_strdup( path - 1 ); } }
1036        if( setme_port ) *setme_port = port;
1037    }
1038
1039
1040    tr_free( tmp );
1041    return err;
1042}
1043
1044#include <string.h>
1045#include <openssl/sha.h>
1046#include <openssl/hmac.h>
1047#include <openssl/evp.h>
1048#include <openssl/bio.h>
1049#include <openssl/buffer.h>
1050
1051char *
1052tr_base64_encode( const void * input, int length, int * setme_len )
1053{
1054    int retlen = 0;
1055    char * ret = NULL;
1056
1057    if( input != NULL )
1058    {
1059        BIO * b64;
1060        BIO * bmem;
1061        BUF_MEM * bptr;
1062
1063        if( length < 1 )
1064            length = strlen( input );
1065
1066        bmem = BIO_new( BIO_s_mem( ) );
1067        b64 = BIO_new( BIO_f_base64( ) );
1068        b64 = BIO_push( b64, bmem );
1069        BIO_write( b64, input, length );
1070        (void) BIO_flush( b64 );
1071        BIO_get_mem_ptr( b64, &bptr );
1072        ret = tr_strndup( bptr->data, bptr->length );
1073        retlen = bptr->length;
1074        BIO_free_all( b64 );
1075    }
1076
1077    if( setme_len )
1078        *setme_len = retlen;
1079
1080    return ret;
1081}
1082
1083char *
1084tr_base64_decode( const void * input,
1085                  int          length,
1086                  int *        setme_len )
1087{
1088    char * ret;
1089    BIO *  b64;
1090    BIO *  bmem;
1091    int    retlen;
1092
1093    if( length < 1 )
1094        length = strlen( input );
1095
1096    ret = tr_new0( char, length );
1097    b64 = BIO_new( BIO_f_base64( ) );
1098    bmem = BIO_new_mem_buf( (unsigned char*)input, length );
1099    bmem = BIO_push( b64, bmem );
1100    retlen = BIO_read( bmem, ret, length );
1101    if( !retlen )
1102    {
1103        /* try again, but with the BIO_FLAGS_BASE64_NO_NL flag */
1104        BIO_free_all( bmem );
1105        b64 = BIO_new( BIO_f_base64( ) );
1106        BIO_set_flags( b64, BIO_FLAGS_BASE64_NO_NL );
1107        bmem = BIO_new_mem_buf( (unsigned char*)input, length );
1108        bmem = BIO_push( b64, bmem );
1109        retlen = BIO_read( bmem, ret, length );
1110    }
1111
1112    if( setme_len )
1113        *setme_len = retlen;
1114
1115    BIO_free_all( bmem );
1116    return ret;
1117}
1118
1119/***
1120****
1121***/
1122
1123int
1124tr_lowerBound( const void * key,
1125               const void * base,
1126               size_t       nmemb,
1127               size_t       size,
1128               int       (* compar)(const void* key, const void* arrayMember),
1129               tr_bool    * exact_match )
1130{
1131    size_t first = 0;
1132    const char * cbase = base;
1133    tr_bool exact = FALSE;
1134
1135    while( nmemb != 0 )
1136    {
1137        const size_t half = nmemb / 2;
1138        const size_t middle = first + half;
1139        const int c = compar( key, cbase + size*middle );
1140
1141        if( c <= 0 ) {
1142            if( c == 0 )
1143                exact = TRUE;
1144            nmemb = half;
1145        } else {
1146            first = middle + 1;
1147            nmemb = nmemb - half - 1;
1148        }
1149    }
1150
1151    *exact_match = exact;
1152
1153    return first;
1154}
1155
1156/***
1157****
1158***/
1159
1160char*
1161tr_utf8clean( const char * str, int max_len, tr_bool * err )
1162{
1163    char * ret;
1164    const char * end;
1165
1166    if( max_len < 0 )
1167        max_len = (int) strlen( str );
1168
1169    if( err != NULL )
1170        *err = FALSE;
1171
1172    if( tr_utf8_validate( str, max_len, &end  ) )
1173    {
1174        ret = tr_strndup( str, max_len );
1175    }
1176    else
1177    {
1178        const char zero = '\0';
1179        struct evbuffer * buf = evbuffer_new( );
1180
1181        while( !tr_utf8_validate ( str, max_len, &end ) )
1182        {
1183            const int good_len = end - str;
1184
1185            evbuffer_add( buf, str, good_len );
1186            max_len -= ( good_len + 1 );
1187            str += ( good_len + 1 );
1188            evbuffer_add( buf, "?", 1 );
1189
1190            if( err != NULL )
1191                *err = TRUE;
1192        }
1193
1194        evbuffer_add( buf, str, max_len );
1195        evbuffer_add( buf, &zero, 1 );
1196        ret = tr_memdup( EVBUFFER_DATA( buf ), EVBUFFER_LENGTH( buf ) );
1197        evbuffer_free( buf );
1198    }
1199
1200    assert( tr_utf8_validate( ret, -1, NULL ) );
1201    return ret;
1202}
1203
1204/***
1205****
1206***/
1207
1208struct number_range
1209{
1210    int low;
1211    int high;
1212};
1213
1214/**
1215 * This should be a single number (ex. "6") or a range (ex. "6-9").
1216 * Anything else is an error and will return failure.
1217 */
1218static tr_bool
1219parseNumberSection( const char * str, int len, struct number_range * setme )
1220{
1221    long a, b;
1222    tr_bool success;
1223    char * end;
1224    const int error = errno;
1225    char * tmp = tr_strndup( str, len );
1226
1227    errno = 0;
1228    a = b = strtol( tmp, &end, 10 );
1229    if( errno || ( end == tmp ) ) {
1230        success = FALSE;
1231    } else if( *end != '-' ) {
1232        b = a;
1233        success = TRUE;
1234    } else {
1235        const char * pch = end + 1;
1236        b = strtol( pch, &end, 10 );
1237        if( errno || ( pch == end ) )
1238            success = FALSE;
1239        else if( *end ) /* trailing data */
1240            success = FALSE;
1241        else
1242            success = TRUE;
1243    }
1244    tr_free( tmp );
1245
1246    setme->low = MIN( a, b );
1247    setme->high = MAX( a, b );
1248
1249    errno = error;
1250    return success;
1251}
1252
1253static int
1254compareInt( const void * va, const void * vb )
1255{
1256    const int a = *(const int *)va;
1257    const int b = *(const int *)vb;
1258    return a - b;
1259}
1260
1261/**
1262 * Given a string like "1-4" or "1-4,6,9,14-51", this allocates and returns an
1263 * array of setmeCount ints of all the values in the array.
1264 * For example, "5-8" will return [ 5, 6, 7, 8 ] and setmeCount will be 4.
1265 * It's the caller's responsibility to call tr_free() on the returned array.
1266 * If a fragment of the string can't be parsed, NULL is returned.
1267 */
1268int*
1269tr_parseNumberRange( const char * str_in, int len, int * setmeCount )
1270{
1271    int n = 0;
1272    int * uniq = NULL;
1273    char * str = tr_strndup( str_in, len );
1274    const char * walk;
1275    tr_list * ranges = NULL;
1276    tr_bool success = TRUE;
1277
1278    walk = str;
1279    while( walk && *walk && success ) {
1280        struct number_range range;
1281        const char * pch = strchr( walk, ',' );
1282        if( pch ) {
1283            success = parseNumberSection( walk, pch-walk, &range );
1284            walk = pch + 1;
1285        } else {
1286            success = parseNumberSection( walk, strlen( walk ), &range );
1287            walk += strlen( walk );
1288        }
1289        if( success )
1290            tr_list_append( &ranges, tr_memdup( &range, sizeof( struct number_range ) ) );
1291    }
1292
1293    if( !success )
1294    {
1295        *setmeCount = 0;
1296        uniq = NULL;
1297    }
1298    else
1299    {
1300        int i;
1301        int n2;
1302        tr_list * l;
1303        int * sorted = NULL;
1304
1305        /* build a sorted number array */
1306        n = n2 = 0;
1307        for( l=ranges; l!=NULL; l=l->next ) {
1308            const struct number_range * r = l->data;
1309            n += r->high + 1 - r->low;
1310        }
1311        sorted = tr_new( int, n );
1312        for( l=ranges; l!=NULL; l=l->next ) {
1313            const struct number_range * r = l->data;
1314            int i;
1315            for( i=r->low; i<=r->high; ++i )
1316                sorted[n2++] = i;
1317        }
1318        qsort( sorted, n, sizeof( int ), compareInt );
1319        assert( n == n2 );
1320
1321        /* remove duplicates */
1322        uniq = tr_new( int, n );
1323        for( i=n=0; i<n2; ++i )
1324            if( !n || uniq[n-1] != sorted[i] )
1325                uniq[n++] = sorted[i];
1326
1327        tr_free( sorted );
1328    }
1329
1330    /* cleanup */
1331    tr_list_free( &ranges, tr_free );
1332    tr_free( str );
1333
1334    /* return the result */
1335    *setmeCount = n;
1336    return uniq;
1337}
1338
1339/***
1340****
1341***/
1342
1343double
1344tr_truncd( double x, int decimal_places )
1345{
1346    const int i = (int) pow( 10, decimal_places ); 
1347    double x2 = (int)(x*i);
1348    return x2 / i;
1349}
1350
1351char*
1352tr_strtruncd( char * buf, double x, int precision, size_t buflen )
1353{
1354    tr_snprintf( buf, buflen, "%.*f", precision, tr_truncd( x, precision ) );
1355
1356    return buf;
1357}
1358
1359char*
1360tr_strpercent( char * buf, double x, size_t buflen )
1361{
1362    if( x < 10.0 )
1363        tr_strtruncd( buf, x, 2, buflen );
1364    else if( x < 100.0 )
1365        tr_strtruncd( buf, x, 1, buflen );
1366    else
1367        tr_strtruncd( buf, x, 0, buflen );
1368    return buf;
1369}
1370
1371char*
1372tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity )
1373{
1374    if( (int)ratio == TR_RATIO_NA )
1375        tr_strlcpy( buf, _( "None" ), buflen );
1376    else if( (int)ratio == TR_RATIO_INF )
1377        tr_strlcpy( buf, infinity, buflen );
1378    else
1379        tr_strpercent( buf, ratio, buflen );
1380    return buf;
1381}
1382
1383/***
1384****
1385***/
1386
1387int
1388tr_moveFile( const char * oldpath, const char * newpath, tr_bool * renamed )
1389{
1390    int in;
1391    int out;
1392    char * buf;
1393    struct stat st;
1394    off_t bytesLeft;
1395    const size_t buflen = 1024 * 128; /* 128 KiB buffer */
1396
1397    /* make sure the old file exists */
1398    if( stat( oldpath, &st ) ) {
1399        const int err = errno;
1400        errno = err;
1401        return -1;
1402    }
1403    if( !S_ISREG( st.st_mode ) ) {
1404        errno = ENOENT;
1405        return -1;
1406    }
1407    bytesLeft = st.st_size;
1408
1409    /* make sure the target directory exists */
1410    {
1411        char * newdir = tr_dirname( newpath );
1412        int i = tr_mkdirp( newdir, 0777 );
1413        tr_free( newdir );
1414        if( i )
1415            return i;
1416    }
1417
1418    /* they might be on the same filesystem... */
1419    {
1420        const int i = rename( oldpath, newpath );
1421        if( renamed != NULL )
1422            *renamed = i == 0;
1423        if( !i )
1424            return 0;
1425    }
1426
1427    /* copy the file */
1428    in = tr_open_file_for_scanning( oldpath );
1429    out = tr_open_file_for_writing( newpath );
1430    buf = tr_valloc( buflen );
1431    while( bytesLeft > 0 )
1432    {
1433        ssize_t bytesWritten;
1434        const off_t bytesThisPass = MIN( bytesLeft, buflen );
1435        const int numRead = read( in, buf, bytesThisPass );
1436        if( numRead < 0 )
1437            break;
1438        bytesWritten = write( out, buf, numRead );
1439        if( bytesWritten < 0 )
1440            break;
1441        bytesLeft -= bytesWritten;
1442    }
1443
1444    /* cleanup */
1445    tr_free( buf );
1446    tr_close_file( out );
1447    tr_close_file( in );
1448    if( bytesLeft != 0 )
1449        return -1;
1450
1451    unlink( oldpath );
1452    return 0;
1453}
1454
1455/***
1456****
1457***/
1458
1459void*
1460tr_valloc( size_t bufLen )
1461{
1462    size_t allocLen;
1463    void * buf = NULL;
1464    static size_t pageSize = 0;
1465
1466    if( !pageSize ) {
1467#ifdef HAVE_GETPAGESIZE
1468        pageSize = getpagesize();
1469#else /* guess */
1470        pageSize = 4096;
1471#endif
1472    }
1473
1474    allocLen = pageSize;
1475    while( allocLen < bufLen )
1476        allocLen += pageSize;
1477
1478#ifdef HAVE_POSIX_MEMALIGN
1479    if( !buf )
1480        posix_memalign( &buf, pageSize, allocLen );
1481#endif
1482#ifdef HAVE_VALLOC
1483    if( !buf )
1484        buf = valloc( allocLen );
1485#endif
1486    if( !buf )
1487        buf = malloc( allocLen );
1488
1489    tr_dbg( "tr_valloc(%zu) allocating %zu bytes", bufLen, allocLen );
1490    return buf;
1491}
1492
1493char *
1494tr_realpath( const char * path, char * resolved_path )
1495{
1496#ifdef WIN32
1497    /* From a message to the Mingw-msys list, Jun 2, 2005 by Mark Junker. */
1498    if( GetFullPathNameA( path, TR_PATH_MAX, resolved_path, NULL ) == 0 )
1499        return NULL;
1500    return resolved_path;
1501#else
1502    return realpath( path, resolved_path );
1503#endif
1504}
1505
1506/***
1507****
1508****
1509****
1510***/
1511
1512struct formatter_unit
1513{
1514    char * name;
1515    double value;
1516};
1517 
1518struct formatter_units
1519{
1520    struct formatter_unit units[4];
1521};
1522
1523static void
1524formatter_init( struct formatter_units * units,
1525                double kilo,
1526                const char * b, const char * kb,
1527                const char * mb, const char * gb )
1528{
1529    units->units[TR_FMT_B].name = tr_strdup( b );
1530    units->units[TR_FMT_B].value = 1;
1531
1532    units->units[TR_FMT_KB].name = tr_strdup( kb );
1533    units->units[TR_FMT_KB].value = kilo;
1534
1535    units->units[TR_FMT_MB].name = tr_strdup( mb );
1536    units->units[TR_FMT_MB].value = pow( kilo, 2 );
1537
1538    units->units[TR_FMT_GB].name = tr_strdup( gb );
1539    units->units[TR_FMT_GB].value = pow( kilo, 3 );
1540}
1541
1542static const char*
1543tr_formatter_units( const struct formatter_units * u, int size )
1544{
1545    assert( u != NULL );
1546    assert( 0<=size && size<4 );
1547
1548    return u->units[size].name;
1549}
1550
1551static char*
1552formatter_get_size_str( const struct formatter_units * u,
1553                        char * buf, uint64_t bytes, size_t buflen )
1554{
1555    int precision;
1556    double value;
1557    const char * units;
1558    const struct formatter_unit * unit;
1559
1560         if( bytes < u->units[1].value ) unit = &u->units[0];
1561    else if( bytes < u->units[2].value ) unit = &u->units[1];
1562    else if( bytes < u->units[3].value ) unit = &u->units[2];
1563    else                                 unit = &u->units[3];
1564
1565    value = bytes / unit->value;
1566    units = unit->name;
1567    if( unit->value == 1 )
1568        precision = 0;
1569    else if( value < 100 )
1570        precision = 2;
1571    else
1572        precision = 1;
1573    tr_snprintf( buf, buflen, "%.*f %s", precision, value, units );
1574    return buf;
1575}
1576
1577static struct formatter_units size_units;
1578
1579void
1580tr_formatter_size_init( double kilo, const char * b, const char * kb,
1581                                     const char * mb, const char * gb )
1582{
1583    formatter_init( &size_units, kilo, b, kb, mb, gb );
1584}
1585
1586char*
1587tr_formatter_size( char * buf, uint64_t bytes, size_t buflen )
1588{
1589    return formatter_get_size_str( &size_units, buf, bytes, buflen );
1590}
1591
1592const char*
1593tr_formatter_size_units( int i )
1594{
1595    return tr_formatter_units( &size_units, i );
1596}
1597
1598static struct formatter_units speed_units;
1599
1600void
1601tr_formatter_speed_init( double kilo, const char * b, const char * kb,
1602                                      const char * mb, const char * gb )
1603{
1604    formatter_init( &speed_units, kilo, b, kb, mb, gb );
1605}
1606
1607char*
1608tr_formatter_speed( char * buf, uint64_t bytes_per_second, size_t buflen )
1609{
1610    return formatter_get_size_str( &speed_units, buf, bytes_per_second, buflen );
1611}
1612
1613const char*
1614tr_formatter_speed_units( int i )
1615{
1616    return tr_formatter_units( &speed_units, i );
1617}
Note: See TracBrowser for help on using the repository browser.