src/utils/utils.c

   1 /*
   2 Copyright (C) 2005  Georgia Public Library Service
   3 Bill Erickson <highfalutin@gmail.com>
   4 Mike Rylander <mrylander@gmail.com>
   5
   6 This program is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU General Public License
   8 as published by the Free Software Foundation; either version 2
   9 of the License, or (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15 */
  16
  17 #include "utils.h"
  18 #include <errno.h>
  19
  20
  21 inline void* safe_malloc( int size ) {
  22         void* ptr = (void*) malloc( size );
  23         if( ptr == NULL ) {
  24                 perror("safe_malloc(): Out of Memory" );
  25                 exit(99);
  26         }
  27         memset( ptr, 0, size );
  28         return ptr;
  29 }
  30
  31
  32 char** __global_argv = NULL;
  33 int __global_argv_size = 0;
  34
  35 int init_proc_title( int argc, char* argv[] ) {
  36
  37         __global_argv = argv;
  38
  39         int i = 0;
  40         while( i < argc ) {
  41                 int len = strlen( __global_argv[i]);
  42                 bzero( __global_argv[i++], len );
  43                 __global_argv_size += len;
  44         }
  45
  46         __global_argv_size -= 2;
  47         return 0;
  48 }
  49
  50 int set_proc_title( char* format, ... ) {
  51         VA_LIST_TO_STRING(format);
  52         bzero( *(__global_argv), __global_argv_size );
  53         return snprintf( *(__global_argv), __global_argv_size, VA_BUF );
  54 }
  55
  56
  57 /* utility method for profiling */
  58 double get_timestamp_millis() {
  59         struct timeval tv;
  60         gettimeofday(&tv, NULL);
  61         double time     = (int)tv.tv_sec        + ( ((double)tv.tv_usec / 1000000) );
  62         return time;
  63 }
  64
  65
  66 /* setting/clearing file flags */
  67 int set_fl( int fd, int flags ) {
  68
  69         int val;
  70
  71         if( (val = fcntl( fd, F_GETFL, 0) ) < 0 ) {
  72                 fprintf(stderr, "fcntl F_GETFL error");
  73                 return -1;
  74         }
  75
  76         val |= flags;
  77
  78         if( fcntl( fd, F_SETFL, val ) < 0 ) {
  79                 fprintf(stderr, "fcntl F_SETFL error");
  80                 return -1;
  81         }
  82         return 0;
  83 }
  84
  85 int clr_fl( int fd, int flags ) {
  86
  87         int val;
  88
  89         if( (val = fcntl( fd, F_GETFL, 0) ) < 0 ) {
  90                 fprintf(stderr, "fcntl F_GETFL error" );
  91                 return -1;
  92         }
  93
  94         val &= ~flags;
  95
  96         if( fcntl( fd, F_SETFL, val ) < 0 ) {
  97                 fprintf( stderr, "fcntl F_SETFL error" );
  98                 return -1;
  99         }
 100         return 0;
 101 }
 102
 103 long va_list_size(const char* format, va_list args) {
 104         int len = 0;
 105         len = vsnprintf(NULL, 0, format, args);
 106         va_end(args);
 107         len += 2;
 108         return len;
 109 }
 110
 111
 112 char* va_list_to_string(const char* format, ...) {
 113
 114         long len = 0;
 115         va_list args;
 116         va_list a_copy;
 117
 118         va_copy(a_copy, args);
 119
 120         va_start(args, format);
 121         len = va_list_size(format, args);
 122
 123         char buf[len];
 124         memset(buf, 0, len);
 125
 126         va_start(a_copy, format);
 127         vsnprintf(buf, len - 1, format, a_copy);
 128         va_end(a_copy);
 129         return strdup(buf);
 130 }
 131
 132 // ---------------------------------------------------------------------------------
 133 // Flesh out a ubiqitous growing string buffer
 134 // ---------------------------------------------------------------------------------
 135
 136 growing_buffer* buffer_init(int num_initial_bytes) {
 137
 138         if( num_initial_bytes > BUFFER_MAX_SIZE ) return NULL;
 139
 140         size_t len = sizeof(growing_buffer);
 141
 142         growing_buffer* gb;
 143         OSRF_MALLOC(gb, len);
 144
 145         gb->n_used = 0;/* nothing stored so far */
 146         gb->size = num_initial_bytes;
 147         OSRF_MALLOC(gb->buf, gb->size + 1);
 148
 149         return gb;
 150 }
 151
 152
 153 int buffer_fadd(growing_buffer* gb, const char* format, ... ) {
 154
 155         if(!gb || !format) return 0;
 156
 157         long len = 0;
 158         va_list args;
 159         va_list a_copy;
 160
 161         va_copy(a_copy, args);
 162
 163         va_start(args, format);
 164         len = va_list_size(format, args);
 165
 166         char buf[len];
 167         memset(buf, 0, len);
 168
 169         va_start(a_copy, format);
 170         vsnprintf(buf, len - 1, format, a_copy);
 171         va_end(a_copy);
 172
 173         return buffer_add(gb, buf);
 174
 175 }
 176
 177
 178 int buffer_add(growing_buffer* gb, char* data) {
 179         if(!(gb && data)) return 0;
 180
 181         int data_len = strlen( data );
 182         int total_len = data_len + gb->n_used;
 183
 184         if( total_len >= gb->size ) {
 185                 while( total_len >= gb->size ) {
 186                         gb->size *= 2;
 187                 }
 188
 189                 if( gb->size > BUFFER_MAX_SIZE ) {
 190                         fprintf(stderr, "Buffer reached MAX_SIZE of %d", BUFFER_MAX_SIZE );
 191                         buffer_free( gb );
 192                         return 0;
 193                 }
 194
 195                 char* new_data;
 196                 OSRF_MALLOC(new_data, gb->size );
 197
 198                 strcpy( new_data, gb->buf );
 199                 free( gb->buf );
 200                 gb->buf = new_data;
 201         }
 202
 203         strcat( gb->buf, data );
 204         gb->n_used = total_len;
 205         return total_len;
 206 }
 207
 208
 209 int buffer_reset( growing_buffer *gb){
 210         if( gb == NULL ) { return 0; }
 211         if( gb->buf == NULL ) { return 0; }
 212         memset( gb->buf, 0, gb->size );
 213         gb->n_used = 0;
 214         return 1;
 215 }
 216
 217 int buffer_free( growing_buffer* gb ) {
 218         if( gb == NULL )
 219                 return 0;
 220         free( gb->buf );
 221         free( gb );
 222         return 1;
 223 }
 224
 225 char* buffer_data( growing_buffer *gb) {
 226         return strdup( gb->buf );
 227 }
 228
 229
 230 /*
 231 #define OSRF_BUFFER_ADD_CHAR(gb, c)\
 232         do {\
 233                 if(gb) {\
 234                         if(gb->n_used < gb->size - 1)\
 235                                 gb->buf[gb->n_used++] = c;\
 236                         else\
 237                                 buffer_add_char(gb, c);\
 238                 }\
 239         }while(0)
 240         */
 241
 242 int buffer_add_char(growing_buffer* gb, char c) {
 243         char buf[2];
 244         buf[0] = c;
 245         buf[1] = '\0';
 246         buffer_add(gb, buf);
 247         return 1;
 248 }
 249
 250
 251
 252 char* uescape( const char* string, int size, int full_escape ) {
 253
 254         growing_buffer* buf = buffer_init(size + 64);
 255         int idx = 0;
 256         long unsigned int c = 0;
 257
 258         while (string[idx]) {
 259
 260                 c ^= c;
 261
 262                 if ((string[idx] & 0xF0) == 0xF0) {
 263                         c = string[idx]<<18;
 264
 265                         if( size - idx < 4 ) return NULL;
 266
 267                         idx++;
 268                         c |= (string[idx] & 0x3F)<<12;
 269
 270                         idx++;
 271                         c |= (string[idx] & 0x3F)<<6;
 272
 273                         idx++;
 274                         c |= (string[idx] & 0x3F);
 275
 276                         c ^= 0xFF000000;
 277
 278                         buffer_fadd(buf, "\\u%0.4x", c);
 279
 280                 } else if ((string[idx] & 0xE0) == 0xE0) {
 281                         c = string[idx]<<12;
 282                         if( size - idx < 3 ) return NULL;
 283
 284                         idx++;
 285                         c |= (string[idx] & 0x3F)<<6;
 286
 287                         idx++;
 288                         c |= (string[idx] & 0x3F);
 289
 290                         c ^= 0xFFF80000;
 291
 292                         buffer_fadd(buf, "\\u%0.4x", c);
 293
 294                 } else if ((string[idx] & 0xC0) == 0xC0) {
 295                         // Two byte char
 296                         c = string[idx]<<6;
 297                         if( size - idx < 2 ) return NULL;
 298
 299                         idx++;
 300                         c |= (string[idx] & 0x3F);
 301
 302                         c ^= 0xFFFFF000;
 303
 304                         buffer_fadd(buf, "\\u%0.4x", c);
 305
 306                 } else {
 307                         c = string[idx];
 308
 309                         /* escape the usual suspects */
 310                         if(full_escape) {
 311                                 switch(c) {
 312                                         case '"':
 313                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
 314                                                 OSRF_BUFFER_ADD_CHAR(buf, '"');
 315                                                 break;
 316
 317                                         case '\b':
 318                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
 319                                                 OSRF_BUFFER_ADD_CHAR(buf, 'b');
 320                                                 break;
 321
 322                                         case '\f':
 323                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
 324                                                 OSRF_BUFFER_ADD_CHAR(buf, 'f');
 325                                                 break;
 326
 327                                         case '\t':
 328                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
 329                                                 OSRF_BUFFER_ADD_CHAR(buf, 't');
 330                                                 break;
 331
 332                                         case '\n':
 333                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
 334                                                 OSRF_BUFFER_ADD_CHAR(buf, 'n');
 335                                                 break;
 336
 337                                         case '\r':
 338                                                 OSRF_BUFFER_ADD_CHAR(buf, '\\');
 339                                                 OSRF_BUFFER_ADD_CHAR(buf, 'r');
 340                                                 break;
 341
 342                                         default:
 343                                                 OSRF_BUFFER_ADD_CHAR(buf, c);
 344                                 }
 345
 346                         } else {
 347                                 OSRF_BUFFER_ADD_CHAR(buf, c);
 348                         }
 349                 }
 350
 351                 idx++;
 352         }
 353
 354         char* d = buffer_data(buf);
 355         buffer_free(buf);
 356         return d;
 357 }
 358
 359
 360 // A function to turn a process into a daemon and set it's process name in ps/top
 361 int daemonize() {
 362         int f = fork();
 363
 364         if (f == -1) {
 365                 perror("Failed to fork!");
 366                 return -1;
 367
 368         } else if (f == 0) { // We're in the child now...
 369                 setsid();
 370                 return 0;
 371
 372         } else { // We're in the parent...
 373                 exit(0);
 374         }
 375 }
 376
 377 int stringisnum(char* s) {
 378         char* w = (char*) malloc(strlen(s) * sizeof(char*));
 379         bzero(w, strlen(s));
 380         strtol(s, &w, 10);
 381         if(strlen(w) > 0)
 382                 return 0;
 383         return 1;
 384 }
 385
 386
 387
 388 char* file_to_string(const char* filename) {
 389
 390         if(!filename) return NULL;
 391
 392         int len = 1024;
 393         char buf[len];
 394         bzero(buf, len);
 395         growing_buffer* gb = buffer_init(len);
 396
 397         FILE* file = fopen(filename, "r");
 398         if(!file) {
 399                 int l = strlen(filename) + 64;
 400                 char b[l];
 401                 snprintf(b,l,"Unable to open file [%s] in file_to_string()", filename);
 402                 perror(b);
 403                 return NULL;
 404         }
 405
 406         while(fgets(buf, len - 1, file)) {
 407                 buffer_add(gb, buf);
 408                 bzero(buf, len);
 409         }
 410
 411         fclose(file);
 412
 413         char* data = buffer_data(gb);
 414         buffer_free(gb);
 415         return data;
 416 }
 417
 418
 419 char* md5sum( char* text, ... ) {
 420
 421         struct md5_ctx ctx;
 422         unsigned char digest[16];
 423
 424         MD5_start (&ctx);
 425
 426         VA_LIST_TO_STRING(text);
 427
 428         int i;
 429         for ( i=0 ; i != strlen(VA_BUF) ; i++ )
 430                 MD5_feed (&ctx, VA_BUF[i]);
 431
 432         MD5_stop (&ctx, digest);
 433
 434         char buf[16];
 435         memset(buf,0,16);
 436
 437         char final[256];
 438         memset(final,0,256);
 439
 440         for ( i=0 ; i<16 ; i++ ) {
 441                 sprintf(buf, "%02x", digest[i]);
 442                 strcat( final, buf );
 443         }
 444
 445         return strdup(final);
 446
 447 }
 448
 449 int osrfUtilsCheckFileDescriptor( int fd ) {
 450
 451         fd_set tmpset;
 452         FD_ZERO(&tmpset);
 453         FD_SET(fd, &tmpset);
 454
 455         struct timeval tv;
 456         tv.tv_sec = 0;
 457         tv.tv_usec = 0;
 458
 459         if( select(fd + 1, &tmpset, NULL, NULL, &tv) == -1 ) {
 460                 if( errno == EBADF ) return -1;
 461         }
 462
 463         return 0;
 464 }
 465