source: trunk/libtransmission/utils.c @ 10274

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

(trunk libT) add a wrapper function tr_valloc() to try posix_memalign(), getpagesize(), valloc() etc

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