source: trunk/libtransmission/utils.h @ 10736

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

(trunk) #3262 "problems with '.' as the first character in a .torrent's filename" -- fixed in trunk for 2.00

  • Property svn:keywords set to Date Rev Author Id
File size: 17.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.h 10736 2010-06-07 14:25:31Z charles $
11 */
12
13#ifndef TR_UTILS_H
14#define TR_UTILS_H 1
15
16#include <inttypes.h>
17#include <stddef.h> /* size_t */
18#include <stdio.h> /* FILE* */
19#include <string.h> /* memcpy()* */
20#include <stdlib.h> /* malloc() */
21#include <time.h> /* time_t */
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/***
28****
29***/
30
31/**
32 * @addtogroup utils Utilities
33 * @{
34 */
35
36#ifndef FALSE
37 #define FALSE 0
38#endif
39
40#ifndef TRUE
41 #define TRUE 1
42#endif
43
44#ifndef UNUSED
45 #ifdef __GNUC__
46  #define UNUSED __attribute__ ( ( unused ) )
47 #else
48  #define UNUSED
49 #endif
50#endif
51
52#ifndef TR_GNUC_PRINTF
53 #ifdef __GNUC__
54  #define TR_GNUC_PRINTF( fmt, args ) __attribute__ ( ( format ( printf, fmt, args ) ) )
55 #else
56  #define TR_GNUC_PRINTF( fmt, args )
57 #endif
58#endif
59
60#ifndef TR_GNUC_NONNULL
61 #ifdef __GNUC__
62  #define TR_GNUC_NONNULL( ... ) __attribute__((nonnull (__VA_ARGS__)))
63 #else
64  #define TR_GNUC_NONNULL( ... )
65 #endif
66#endif
67
68#ifndef TR_GNUC_NULL_TERMINATED
69 #if __GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 3 )
70  #define TR_GNUC_NULL_TERMINATED __attribute__ ( ( __sentinel__ ) )
71  #define TR_GNUC_HOT __attribute ( ( hot ) )
72 #else
73  #define TR_GNUC_NULL_TERMINATED
74  #define TR_GNUC_HOT
75 #endif
76#endif
77
78#if __GNUC__ > 2 || ( __GNUC__ == 2 && __GNUC_MINOR__ >= 96 )
79 #define TR_GNUC_PURE __attribute__ ( ( __pure__ ) )
80 #define TR_GNUC_MALLOC __attribute__ ( ( __malloc__ ) )
81#else
82 #define TR_GNUC_PURE
83 #define TR_GNUC_MALLOC
84#endif
85
86
87/***
88****
89***/
90
91#if !defined( _ )
92 #if defined( HAVE_LIBINTL_H ) && !defined( SYS_DARWIN )
93  #include <libintl.h>
94  #define _( a ) gettext ( a )
95 #else
96  #define _( a ) ( a )
97 #endif
98#endif
99
100/* #define DISABLE_GETTEXT */
101#if defined(TR_EMBEDDED) && !defined(DISABLE_GETTEXT)
102 #define DISABLE_GETTEXT
103#endif
104#ifdef DISABLE_GETTEXT
105 const char * tr_strip_positional_args( const char * fmt );
106 #undef _
107 #define _( a ) tr_strip_positional_args( a )
108#endif
109
110/****
111*****
112****/
113
114void tr_msgInit( void );
115
116#define TR_MAX_MSG_LOG 10000
117
118extern int messageLevel;
119
120static inline tr_bool tr_msgLoggingIsActive( int level )
121{
122    return messageLevel >= level;
123}
124
125void tr_msg( const char * file, int line,
126             int level,
127             const char * torrent,
128             const char * fmt, ... ) TR_GNUC_PRINTF( 5, 6 );
129
130#define tr_nerr( n, ... ) \
131    do { \
132        if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
133            tr_msg( __FILE__, __LINE__, TR_MSG_ERR, n, __VA_ARGS__ ); \
134    } while( 0 )
135
136#define tr_ninf( n, ... ) \
137    do { \
138        if( tr_msgLoggingIsActive( TR_MSG_INF) ) \
139            tr_msg( __FILE__, __LINE__, TR_MSG_INF, n, __VA_ARGS__ ); \
140    } while( 0 )
141
142#define tr_ndbg( n, ... ) \
143    do { \
144        if( tr_msgLoggingIsActive( TR_MSG_DBG) ) \
145            tr_msg( __FILE__, __LINE__, TR_MSG_DBG, n, __VA_ARGS__ ); \
146    } while( 0 )
147
148#define tr_torerr( tor, ... ) \
149    do { \
150        if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
151            tr_msg( __FILE__, __LINE__, TR_MSG_ERR, tor->info.name, __VA_ARGS__ ); \
152    } while( 0 )
153
154#define tr_torinf( tor, ... ) \
155    do { \
156        if( tr_msgLoggingIsActive( TR_MSG_INF ) ) \
157            tr_msg( __FILE__, __LINE__, TR_MSG_INF, tor->info.name, __VA_ARGS__ ); \
158    } while( 0 )
159
160#define tr_tordbg( tor, ... ) \
161    do { \
162        if( tr_msgLoggingIsActive( TR_MSG_DBG ) ) \
163            tr_msg( __FILE__, __LINE__, TR_MSG_DBG, tor->info.name, __VA_ARGS__ ); \
164    } while( 0 )
165
166#define tr_err( ... ) \
167    do { \
168        if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
169            tr_msg( __FILE__, __LINE__, TR_MSG_ERR, NULL, __VA_ARGS__ ); \
170    } while( 0 )
171
172#define tr_inf( ... ) \
173    do { \
174        if( tr_msgLoggingIsActive( TR_MSG_INF ) ) \
175            tr_msg( __FILE__, __LINE__, TR_MSG_INF, NULL, __VA_ARGS__ ); \
176    } while( 0 )
177
178#define tr_dbg( ... ) \
179    do { \
180        if( tr_msgLoggingIsActive( TR_MSG_DBG ) ) \
181            tr_msg( __FILE__, __LINE__, TR_MSG_DBG, NULL, __VA_ARGS__ ); \
182    } while( 0 )
183
184
185
186FILE*          tr_getLog( void );
187
188/** @brief return true if deep logging has been enabled by the user; false otherwise */
189tr_bool tr_deepLoggingIsActive( void );
190
191void           tr_deepLog( const char * file,
192                           int          line,
193                           const char * name,
194                           const char * fmt,
195                           ... ) TR_GNUC_PRINTF( 4, 5 ) TR_GNUC_NONNULL(1,4);
196
197/** @brief set the buffer with the current time formatted for deep logging. */
198char* tr_getLogTimeStr( char * buf, int buflen ) TR_GNUC_NONNULL(1);
199
200
201/**
202 * @brief Rich Salz's classic implementation of shell-style pattern matching for ?, \, [], and * characters.
203 * @return 1 if the pattern matches, 0 if it doesn't, or -1 if an error occured
204 */
205int tr_wildmat( const char * text, const char * pattern ) TR_GNUC_NONNULL(1,2);
206
207/** @brief Portability wrapper for basename() that uses the system implementation if available */
208char* tr_basename( const char * path ) TR_GNUC_MALLOC;
209
210/** @brief Portability wrapper for dirname() that uses the system implementation if available */
211char* tr_dirname( const char * path ) TR_GNUC_MALLOC;
212
213/**
214 * @brief Portability wrapper for mkdir()
215 *
216 * A portability wrapper around mkdir().
217 * On WIN32, the `permissions' argument is unused.
218 *
219 * @return zero on success, or -1 if an error occurred
220 * (in which case errno is set appropriately).
221 */
222int tr_mkdir( const char * path, int permissions ) TR_GNUC_NONNULL(1);
223
224/**
225 * Like mkdir, but makes parent directories as needed.
226 *
227 * @return zero on success, or -1 if an error occurred
228 * (in which case errno is set appropriately).
229 */
230int tr_mkdirp( const char * path, int permissions ) TR_GNUC_NONNULL(1);
231
232
233/**
234 * @brief Loads a file and returns its contents.
235 * On failure, NULL is returned and errno is set.
236 */
237uint8_t* tr_loadFile( const char * filename, size_t * size ) TR_GNUC_MALLOC
238                                                             TR_GNUC_NONNULL(1);
239
240
241/** @brief build a filename from a series of elements using the
242           platform's correct directory separator. */
243char* tr_buildPath( const char * first_element, ... ) TR_GNUC_NULL_TERMINATED
244                                                      TR_GNUC_MALLOC;
245
246struct event;
247
248/**
249 * @brief Convenience wrapper around timer_add() to have a timer wake up in a number of seconds and microseconds
250 * @param timer
251 * @param seconds
252 * @param microseconds
253 */
254void tr_timerAdd( struct event * timer, int seconds, int microseconds ) TR_GNUC_NONNULL(1);
255
256/**
257 * @brief Convenience wrapper around timer_add() to have a timer wake up in a number of milliseconds
258 * @param timer
259 * @param milliseconds
260 */
261void tr_timerAddMsec( struct event * timer, int milliseconds ) TR_GNUC_NONNULL(1);
262
263
264/** @brief return the current date in milliseconds */
265uint64_t tr_date( void );
266
267/** @brief sleep the specified number of milliseconds */
268void tr_wait_msec( uint64_t delay_milliseconds );
269
270/**
271 * @brief make a copy of 'str' whose non-utf8 content has been corrected or stripped
272 * @return a newly-allocated string that must be freed with tr_free()
273 * @param str the string to make a clean copy of
274 * @param len the length of the string to copy.  If -1, the entire string is used.
275 * @param err if an error occurs and err is non-NULL, it's set to TRUE.
276 */
277char* tr_utf8clean( const char * str, int len, tr_bool * err ) TR_GNUC_MALLOC;
278
279
280/***
281****
282***/
283
284/* Sometimes the system defines MAX/MIN, sometimes not.
285   In the latter case, define those here since we will use them */
286#ifndef MAX
287 #define MAX( a, b ) ( ( a ) > ( b ) ? ( a ) : ( b ) )
288#endif
289#ifndef MIN
290 #define MIN( a, b ) ( ( a ) > ( b ) ? ( b ) : ( a ) )
291#endif
292
293/***
294****
295***/
296
297/** @brief Portability wrapper around malloc() in which `0' is a safe argument */
298static inline void* tr_malloc( size_t size )
299{
300    return size ? malloc( size ) : NULL;
301}
302
303/** @brief Portability wrapper around calloc() in which `0' is a safe argument */
304static inline void* tr_malloc0( size_t size )
305{
306    return size ? calloc( 1, size ) : NULL;
307}
308
309/** @brief Portability wrapper around free() in which `NULL' is a safe argument */
310static inline void tr_free( void * p )
311{
312    if( p != NULL )
313        free( p );
314}
315
316/**
317 * @brief make a newly-allocated copy of a chunk of memory
318 * @param src the memory to copy
319 * @param byteCount the number of bytes to copy
320 * @return a newly-allocated copy of `src' that can be freed with tr_free()
321 */
322static inline void* tr_memdup( const void * src, int byteCount )
323{
324    return memcpy( tr_malloc( byteCount ), src, byteCount );
325}
326
327#define tr_new( struct_type, n_structs )           \
328    ( (struct_type *) tr_malloc ( ( (size_t) sizeof ( struct_type ) ) * ( ( size_t) ( n_structs ) ) ) )
329
330#define tr_new0( struct_type, n_structs )          \
331    ( (struct_type *) tr_malloc0 ( ( (size_t) sizeof ( struct_type ) ) * ( ( size_t) ( n_structs ) ) ) )
332
333#define tr_renew( struct_type, mem, n_structs )    \
334    ( (struct_type *) realloc ( ( mem ), ( (size_t) sizeof ( struct_type ) ) * ( ( size_t) ( n_structs ) ) ) )
335
336void* tr_valloc( size_t bufLen );
337
338/**
339 * @brief make a newly-allocated copy of a substring
340 * @param in is a void* so that callers can pass in both signed & unsigned without a cast
341 * @param len length of the substring to copy.  if a length less than zero is passed in, strlen( len ) is used
342 * @return a newly-allocated copy of `in' that can be freed with tr_free()
343 */
344char* tr_strndup( const void * in, int len ) TR_GNUC_MALLOC;
345
346/**
347 * @brief make a newly-allocated copy of a string
348 * @param in is a void* so that callers can pass in both signed & unsigned without a cast
349 * @return a newly-allocated copy of `in' that can be freed with tr_free()
350 */
351static inline char* tr_strdup( const void * in )
352{
353    return tr_strndup( in, in ? strlen( (const char *) in ) : 0 );
354}
355
356/** @brief similar to bsearch() but returns the index of the lower bound */
357int tr_lowerBound( const void * key,
358                   const void * base,
359                   size_t       nmemb,
360                   size_t       size,
361                   int       (* compar)(const void* key, const void* arrayMember),
362                   tr_bool    * exact_match ) TR_GNUC_HOT TR_GNUC_NONNULL(1,5,6);
363
364
365/**
366 * @brief sprintf() a string into a newly-allocated buffer large enough to hold it
367 * @return a newly-allocated string that can be freed with tr_free()
368 */
369char* tr_strdup_printf( const char * fmt, ... ) TR_GNUC_PRINTF( 1, 2 )
370                                                TR_GNUC_MALLOC;
371
372/**
373 * @brief Translate a block of bytes into base64
374 * @return a newly-allocated string that can be freed with tr_free()
375 */
376char* tr_base64_encode( const void * input,
377                        int          inlen,
378                        int        * outlen ) TR_GNUC_MALLOC;
379
380/**
381 * @brief Translate a block of bytes from base64 into raw form
382 * @return a newly-allocated string that can be freed with tr_free()
383 */
384char* tr_base64_decode( const void * input,
385                        int          inlen,
386                        int        * outlen ) TR_GNUC_MALLOC;
387
388/** @brief Portability wrapper for strlcpy() that uses the system implementation if available */
389size_t tr_strlcpy( char * dst, const void * src, size_t siz );
390
391/** @brief Portability wrapper for snprintf() that uses the system implementation if available */
392int tr_snprintf( char * buf, size_t buflen,
393                 const char * fmt, ... ) TR_GNUC_PRINTF( 3, 4 ) TR_GNUC_NONNULL(1,3);
394
395/** @brief Convenience wrapper around strerorr() guaranteed to not return NULL
396    @param errno */
397const char* tr_strerror( int );
398
399/** @brief strips leading and trailing whitspace from a string
400    @return the stripped string */
401char* tr_strstrip( char * str );
402
403/** @brief Returns true if the string ends with the specified case-insensitive suffix */
404tr_bool tr_str_has_suffix( const char *str, const char *suffix );
405
406
407/** @brief Portability wrapper for memmem() that uses the system implementation if available */
408const char* tr_memmem( const char * haystack, size_t haystack_len,
409                       const char * needle, size_t needle_len );
410
411/***
412****
413***/
414
415typedef void ( tr_set_func )( void * element, void * userData );
416
417/**
418 * @brief find the differences and commonalities in two sorted sets
419 * @param a the first set
420 * @param aCount the number of elements in the set 'a'
421 * @param b the second set
422 * @param bCount the number of elements in the set 'b'
423 * @param compare the sorting method for both sets
424 * @param elementSize the sizeof the element in the two sorted sets
425 * @param in_a called for items in set 'a' but not set 'b'
426 * @param in_b called for items in set 'b' but not set 'a'
427 * @param in_both called for items that are in both sets
428 * @param userData user data passed along to in_a, in_b, and in_both
429 */
430void tr_set_compare( const void * a, size_t aCount,
431                     const void * b, size_t bCount,
432                     int compare( const void * a, const void * b ),
433                     size_t elementSize,
434                     tr_set_func in_a_cb,
435                     tr_set_func in_b_cb,
436                     tr_set_func in_both_cb,
437                     void * userData );
438
439void tr_sha1_to_hex( char * out, const uint8_t * sha1 ) TR_GNUC_NONNULL(1,2);
440
441void tr_hex_to_sha1( uint8_t * out, const char * hex ) TR_GNUC_NONNULL(1,2);
442
443/** @brief convenience function to determine if an address is an IP address (IPv4 or IPv6) */
444tr_bool tr_addressIsIP( const char * address );
445
446/** @brief return TRUE if the url is a http or https url that Transmission understands */
447tr_bool tr_urlIsValidTracker( const char * url ) TR_GNUC_NONNULL(1);
448
449/** @brief return TRUE if the url is a [ http, https, ftp, ftps ] url that Transmission understands */
450tr_bool tr_urlIsValid( const char * url ) TR_GNUC_NONNULL(1);
451
452/** @brief parse a URL into its component parts
453    @return zero on success or an error number if an error occurred */
454int  tr_urlParse( const char * url,
455                  int          url_len,
456                  char      ** setme_scheme,
457                  char      ** setme_host,
458                  int        * setme_port,
459                  char      ** setme_path ) TR_GNUC_NONNULL(1);
460
461
462/** @brief return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1]
463    @return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1] */
464double tr_getRatio( double numerator, double denominator );
465
466/**
467 * @brief Given a string like "1-4" or "1-4,6,9,14-51", this returns a
468 *        newly-allocated array of all the integers in the set.
469 * @return a newly-allocated array of integers that must be freed with tr_free(),
470 *         or NULL if a fragment of the string can't be parsed.
471 *
472 * For example, "5-8" will return [ 5, 6, 7, 8 ] and setmeCount will be 4.
473 */
474int* tr_parseNumberRange( const char * str,
475                          int str_len,
476                          int * setmeCount ) TR_GNUC_MALLOC TR_GNUC_NONNULL(1);
477
478
479/**
480 * @brief truncate a double value at a given number of decimal places.
481 *
482 * this can be used to prevent a printf() call from rounding up:
483 * call with the decimal_places argument equal to the number of
484 * decimal places in the printf()'s precision:
485 *
486 * - printf("%.2f%%",           99.999    ) ==> "100.00%"
487 *
488 * - printf("%.2f%%", tr_truncd(99.999, 2)) ==>  "99.99%"
489 *             ^                        ^
490 *             |   These should match   |
491 *             +------------------------+
492 */
493double tr_truncd( double x, int decimal_places );
494
495/**
496 * @param buf the buffer to write the string to
497 * @param buflef buf's size
498 * @param ratio the ratio to convert to a string
499 * @param the string represntation of "infinity"
500 */
501char* tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity ) TR_GNUC_NONNULL(1,4);
502
503/** @brief Portability wrapper for localtime_r() that uses the system implementation if available */
504struct tm * tr_localtime_r( const time_t *_clock, struct tm *_result );
505
506
507/**
508 * @brief move a file
509 * @return 0 on success; otherwise, return -1 and set errno
510 */
511int tr_moveFile( const char * oldpath, const char * newpath,
512                 tr_bool * renamed ) TR_GNUC_NONNULL(1,2);
513
514/** @brief convenience function to remove an item from an array */
515static inline void tr_removeElementFromArray( void   * array,
516                                              int      index_to_remove,
517                                              size_t   sizeof_element,
518                                              size_t   nmemb )
519{
520    char * a = (char*) array;
521
522    memmove( a + sizeof_element * index_to_remove,
523             a + sizeof_element * ( index_to_remove  + 1 ),
524             sizeof_element * ( --nmemb - index_to_remove ) );
525}
526
527/***
528****
529***/
530
531/** @brief Private libtransmission variable that's visible only for inlining in tr_time() */
532extern time_t transmission_now;
533
534/**
535 * @brief very inexpensive form of time(NULL)
536 * @return the current epoch time in seconds
537 *
538 * This function returns a second counter that is updated once per second.
539 * If something blocks the libtransmission thread for more than a second,
540 * that counter may be thrown off, so this function is not guaranteed
541 * to always be accurate.  However, it is *much* faster when 100% accuracy
542 * isn't needed
543 */
544static inline time_t tr_time( void ) { return transmission_now; }
545
546/** @brief Private libtransmission function to update tr_time()'s counter */
547static inline void tr_timeUpdate( time_t now ) { transmission_now = now; }
548
549/***
550****
551***/
552
553#ifdef __cplusplus
554}
555#endif
556
557/** @} */
558
559#endif
Note: See TracBrowser for help on using the repository browser.