source: trunk/libtransmission/utils.c @ 10783

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

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