01fd382672b3d832a55f5e4b9880b98295cb4c40
[OpenSRF.git] / src / libopensrf / utils.c
1 /*
2 Copyright (C) 2005  Georgia Public Library Service 
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 GNU General Public License for more details.
13 */
14
15 #include <opensrf/utils.h>
16 #include <opensrf/log.h>
17 #include <errno.h>
18
19 inline void* safe_malloc( int size ) {
20         void* ptr = (void*) malloc( size );
21         if( ptr == NULL ) {
22                 osrfLogError( OSRF_LOG_MARK, "Out of Memory" );
23                 exit(99);
24         }
25         memset( ptr, 0, size ); // remove this after safe_calloc transition
26         return ptr;
27 }
28
29 inline void* safe_calloc( int size ) {
30         void* ptr = (void*) calloc( 1, size );
31         if( ptr == NULL ) {
32                 osrfLogError( OSRF_LOG_MARK, "Out of Memory" );
33                 exit(99);
34         }
35         return ptr;
36 }
37
38 /****************
39  The following static variables, and the following two functions,
40  overwrite the argv array passed to main().  The purpose is to
41  change the program name as reported by ps and similar utilities.
42
43  Warning: this code makes the non-portable assumption that the
44  strings to which argv[] points are contiguous in memory.  The
45  C Standard makes no such guarantee.
46  ****************/
47 static char** global_argv = NULL;
48 static int global_argv_size = 0;
49
50 int init_proc_title( int argc, char* argv[] ) {
51
52         global_argv = argv;
53
54         int i = 0;
55         while( i < argc ) {
56                 int len = strlen( global_argv[i]);
57                 osrf_clearbuf( global_argv[i], len );
58                 global_argv_size += len;
59                 i++;
60         }
61
62         global_argv_size -= 2;
63         return 0;
64 }
65
66 int set_proc_title( const char* format, ... ) {
67         VA_LIST_TO_STRING(format);
68         osrf_clearbuf( *(global_argv), global_argv_size);
69         return snprintf( *(global_argv), global_argv_size, VA_BUF );
70 }
71
72
73 /* utility method for profiling */
74 double get_timestamp_millis( void ) {
75         struct timeval tv;
76         gettimeofday(&tv, NULL);
77         double time     = (int)tv.tv_sec        + ( ((double)tv.tv_usec / 1000000) );
78         return time;
79 }
80
81
82 /* setting/clearing file flags */
83 int set_fl( int fd, int flags ) {
84         
85         int val;
86
87         if( (val = fcntl( fd, F_GETFL, 0) ) < 0 ) 
88                 return -1;
89
90         val |= flags;
91
92         if( fcntl( fd, F_SETFL, val ) < 0 ) 
93                 return -1;
94
95         return 0;
96 }
97         
98 int clr_fl( int fd, int flags ) {
99         
100         int val;
101
102         if( (val = fcntl( fd, F_GETFL, 0) ) < 0 ) 
103                 return -1;
104
105         val &= ~flags;
106
107         if( fcntl( fd, F_SETFL, val ) < 0 ) 
108                 return -1;
109
110         return 0;
111 }
112
113 long va_list_size(const char* format, va_list args) {
114         int len = 0;
115         len = vsnprintf(NULL, 0, format, args);
116         va_end(args);
117         len += 2;
118         return len;
119 }
120
121
122 char* va_list_to_string(const char* format, ...) {
123
124         long len = 0;
125         va_list args;
126         va_list a_copy;
127
128         va_copy(a_copy, args);
129
130         va_start(args, format);
131         len = va_list_size(format, args);
132
133         char buf[len];
134         osrf_clearbuf(buf, sizeof(buf));
135
136         va_start(a_copy, format);
137         vsnprintf(buf, len - 1, format, a_copy);
138         va_end(a_copy);
139         return strdup(buf);
140 }
141
142 // ---------------------------------------------------------------------------------
143 // Flesh out a ubiqitous growing string buffer
144 // ---------------------------------------------------------------------------------
145
146 growing_buffer* buffer_init(int num_initial_bytes) {
147
148         if( num_initial_bytes > BUFFER_MAX_SIZE ) return NULL;
149
150         size_t len = sizeof(growing_buffer);
151
152         growing_buffer* gb;
153         OSRF_MALLOC(gb, len);
154
155         gb->n_used = 0;/* nothing stored so far */
156         gb->size = num_initial_bytes;
157         OSRF_MALLOC(gb->buf, gb->size + 1);
158
159         return gb;
160 }
161
162
163 /* Expand the internal buffer of a growing_buffer so that it */
164 /* will accommodate a specified string length.  Return 0 if  */
165 /* successful, or 1 otherwise. */
166
167 /* Note that we do not check to see if the buffer is already */
168 /* big enough.  It is the responsibility of the calling      */
169 /* function to call this only when necessary. */
170
171 static int buffer_expand( growing_buffer* gb, size_t total_len ) {
172
173         // Make sure the request is not excessive
174         
175         if( total_len >= BUFFER_MAX_SIZE ) {
176                 fprintf(stderr, "Buffer reached MAX_SIZE of %lu",
177                                 (unsigned long) BUFFER_MAX_SIZE );
178                 buffer_free( gb );
179                 return 1;
180         }
181
182         // Pick a big enough buffer size, but don't exceed a maximum
183         
184         while( total_len >= gb->size ) {
185                 gb->size *= 2;
186         }
187
188         if( gb->size > BUFFER_MAX_SIZE )
189                 gb->size = BUFFER_MAX_SIZE;
190
191         // Allocate and populate the new buffer
192         
193         char* new_data;
194         OSRF_MALLOC( new_data, gb->size );
195         memcpy( new_data, gb->buf, gb->n_used );
196         new_data[ gb->n_used ] = '\0';
197
198         // Replace the old buffer
199         
200         free( gb->buf );
201         gb->buf = new_data;
202         return 0;
203 }
204
205
206 int buffer_fadd(growing_buffer* gb, const char* format, ... ) {
207
208         if(!gb || !format) return 0; 
209
210         long len = 0;
211         va_list args;
212         va_list a_copy;
213
214         va_copy(a_copy, args);
215
216         va_start(args, format);
217         len = va_list_size(format, args);
218
219         char buf[len];
220         osrf_clearbuf(buf, sizeof(buf));
221
222         va_start(a_copy, format);
223         vsnprintf(buf, len - 1, format, a_copy);
224         va_end(a_copy);
225
226         return buffer_add(gb, buf);
227
228 }
229
230
231 int buffer_add(growing_buffer* gb, const char* data) {
232         if(!(gb && data)) return 0;
233
234         int data_len = strlen( data );
235
236         if(data_len == 0) return 0;
237
238         int total_len = data_len + gb->n_used;
239
240         if( total_len >= gb->size ) {
241                 if( buffer_expand( gb, total_len ) )
242                         return -1;
243         }
244
245         strcat( gb->buf, data );
246         gb->n_used = total_len;
247         return total_len;
248 }
249
250
251 int buffer_reset( growing_buffer *gb){
252         if( gb == NULL ) { return -1; }
253         if( gb->buf == NULL ) { return -1; }
254         osrf_clearbuf( gb->buf, sizeof(gb->buf) );
255         gb->n_used = 0;
256         return gb->n_used;
257 }
258
259 /* Return a pointer to the text within a growing_buffer, */
260 /* while destroying the growing_buffer itself.           */
261
262 char* buffer_release( growing_buffer* gb) {
263         char* s = gb->buf;
264         s[gb->n_used] = '\0';
265         free( gb );
266         return s;
267 }
268
269 /* Destroy a growing_buffer and the text it contains */
270
271 int buffer_free( growing_buffer* gb ) {
272         if( gb == NULL ) 
273                 return 0;
274         free( gb->buf );
275         free( gb );
276         return 1;
277 }
278
279 char* buffer_data( const growing_buffer *gb) {
280         return strdup( gb->buf );
281 }
282
283
284 /*
285 #define OSRF_BUFFER_ADD_CHAR(gb, c)\
286         do {\
287                 if(gb) {\
288                         if(gb->n_used < gb->size - 1)\
289                                 gb->buf[gb->n_used++] = c;\
290                         else\
291                                 buffer_add_char(gb, c);\
292                 }\
293         }while(0)
294         */
295
296 int buffer_add_char(growing_buffer* gb, char c ) {
297         if(gb && gb->buf) {
298
299                 int total_len = gb->n_used + 1;
300
301                 if( total_len >= gb->size ) {
302                         if( buffer_expand( gb, total_len ) )
303                                 return -1;
304                 }
305         
306                 gb->buf[ gb->n_used ]   = c;
307                 gb->buf[ ++gb->n_used ] = '\0';
308         }
309         
310         return gb->n_used;
311 }
312
313
314 char* uescape( const char* string, int size, int full_escape ) {
315
316         growing_buffer* buf = buffer_init(size + 64);
317         int clen = 0;
318         int idx = 0;
319         unsigned long int c = 0x0;
320
321         while (string[idx]) {
322
323                 c = 0x0;
324
325                 if ((unsigned char)string[idx] >= 0x80) { // not ASCII
326
327                         if ((unsigned char)string[idx] >= 0xC0 && (unsigned char)string[idx] <= 0xF4) { // starts a UTF8 string
328
329                                 clen = 1;
330                                 if (((unsigned char)string[idx] & 0xF0) == 0xF0) {
331                                         clen = 3;
332                                         c = (unsigned char)string[idx] ^ 0xF0;
333
334                                 } else if (((unsigned char)string[idx] & 0xE0) == 0xE0) {
335                                         clen = 2;
336                                         c = (unsigned char)string[idx] ^ 0xE0;
337
338                                 } else if (((unsigned char)string[idx] & 0xC0) == 0xC0) {
339                                         clen = 1;
340                                         c = (unsigned char)string[idx] ^ 0xC0;
341                                 }
342
343                                 for (;clen;clen--) {
344
345                                         idx++; // look at the next byte
346                                         c = (c << 6) | ((unsigned char)string[idx] & 0x3F); // add this byte worth
347
348                                 }
349
350                                 buffer_fadd(buf, "\\u%04x", c);
351
352                         } else {
353                                 buffer_free(buf);
354                                 return NULL;
355                         }
356
357                 } else {
358                         c = string[idx];
359
360                         /* escape the usual suspects */
361                         if(full_escape) {
362                                 switch(c) {
363                                         case '"':
364                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
365                                                 OSRF_BUFFER_ADD_CHAR(buf, '"');
366                                                 break;
367         
368                                         case '\b':
369                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
370                                                 OSRF_BUFFER_ADD_CHAR(buf, 'b');
371                                                 break;
372         
373                                         case '\f':
374                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
375                                                 OSRF_BUFFER_ADD_CHAR(buf, 'f');
376                                                 break;
377         
378                                         case '\t':
379                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
380                                                 OSRF_BUFFER_ADD_CHAR(buf, 't');
381                                                 break;
382         
383                                         case '\n':
384                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
385                                                 OSRF_BUFFER_ADD_CHAR(buf, 'n');
386                                                 break;
387         
388                                         case '\r':
389                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
390                                                 OSRF_BUFFER_ADD_CHAR(buf, 'r');
391                                                 break;
392
393                                         case '\\':
394                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
395                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
396                                                 break;
397
398                                         default:
399                                                 if( c < 32 ) buffer_fadd(buf, "\\u%04x", c);
400                                                 else OSRF_BUFFER_ADD_CHAR(buf, c);
401                                 }
402
403                         } else {
404                                 OSRF_BUFFER_ADD_CHAR(buf, c);
405                         }
406                 }
407
408                 idx++;
409         }
410
411         return buffer_release(buf);
412 }
413
414
415 // A function to turn a process into a daemon 
416 int daemonize( void ) {
417         pid_t f = fork();
418
419         if (f == -1) {
420                 osrfLogError( OSRF_LOG_MARK, "Failed to fork!" );
421                 return -1;
422
423         } else if (f == 0) { // We're in the child now...
424                 
425                 // Change directories.  Otherwise whatever directory
426                 // we're in couldn't be deleted until the program
427                 // terminated -- possibly causing some inconvenience.
428                 chdir( "/" );
429
430                 /* create new session */
431                 setsid();
432
433                 // Now that we're no longer attached to a terminal,
434                 // we don't want any traffic on the standard streams
435                 freopen( "/dev/null", "r", stdin );
436                 freopen( "/dev/null", "w", stdout );
437                 freopen( "/dev/null", "w", stderr );
438                 
439                 return 0;
440
441         } else { // We're in the parent...
442                 _exit(0);
443         }
444 }
445
446
447 /* Return 1 if the string represents an integer,  */
448 /* as recognized by strtol(); Otherwise return 0. */
449
450 int stringisnum(const char* s) {
451         char* w;
452         strtol(s, &w, 10);
453         return *w ? 0 : 1;
454 }
455         
456
457
458 char* file_to_string(const char* filename) {
459
460         if(!filename) return NULL;
461
462         FILE * file = fopen( filename, "r" );
463         if( !file ) {
464                 osrfLogError( OSRF_LOG_MARK, "Unable to open file [%s]", filename );
465                 return NULL;
466         }
467
468         size_t num_read;
469         char buf[ BUFSIZ + 1 ];
470         growing_buffer* gb = buffer_init(sizeof(buf));
471
472         while( ( num_read = fread( buf, 1, sizeof(buf) - 1, file) ) ) {
473                 buf[ num_read ] = '\0';
474                 buffer_add(gb, buf);
475         }
476
477         fclose(file);
478
479         return buffer_release(gb);
480 }
481
482
483 char* md5sum( const char* text, ... ) {
484
485         struct md5_ctx ctx;
486         unsigned char digest[16];
487
488         MD5_start (&ctx);
489
490         VA_LIST_TO_STRING(text);
491
492         int i;
493         for ( i=0 ; i != strlen(VA_BUF) ; i++ )
494                 MD5_feed (&ctx, VA_BUF[i]);
495
496         MD5_stop (&ctx, digest);
497
498         char buf[16];
499         char final[256];
500         osrf_clearbuf(final, sizeof(final));
501
502         for ( i=0 ; i<16 ; i++ ) {
503                 snprintf(buf, sizeof(buf), "%02x", digest[i]);
504                 strcat( final, buf );
505         }
506
507         return strdup(final);
508
509 }
510
511 int osrfUtilsCheckFileDescriptor( int fd ) {
512
513         fd_set tmpset;
514         FD_ZERO(&tmpset);
515         FD_SET(fd, &tmpset);
516
517         struct timeval tv;
518         tv.tv_sec = 0;
519         tv.tv_usec = 0;
520
521         if( select(fd + 1, &tmpset, NULL, NULL, &tv) == -1 ) {
522                 if( errno == EBADF ) return -1;
523         }
524
525         return 0;
526 }
527