include/opensrf/utils.h

   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 #ifndef UTILS_H
  18 #define UTILS_H
  19
  20 #include <stdio.h>
  21 #include <stdarg.h>
  22 #include <fcntl.h>
  23 #include <unistd.h>
  24 #include <sys/time.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <sys/types.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 //#include <sys/timeb.h>
  31
  32 #include "md5.h"
  33
  34 #define OSRF_MALLOC(ptr, size) \
  35         do {\
  36                 ptr = (void*) malloc( size ); \
  37                 if( ptr == NULL ) { \
  38                         perror("OSRF_MALLOC(): Out of Memory" );\
  39                         exit(99); \
  40                 } \
  41                 memset( ptr, 0, size );\
  42         } while(0)
  43
  44
  45 #define OSRF_BUFFER_ADD(gb, data) \
  46         do {\
  47                 int __tl; \
  48                 if(gb && data) {\
  49                         __tl = strlen(data) + gb->n_used;\
  50                         if( __tl < gb->size ) {\
  51                                 strcat(gb->buf, data);\
  52                                 gb->n_used = __tl; \
  53                         } else { buffer_add(gb, data); }\
  54                 }\
  55         } while(0)
  56
  57 #define OSRF_BUFFER_ADD_CHAR(gb, c)\
  58         do {\
  59                 if(gb) {\
  60                         if(gb->n_used < gb->size - 1)\
  61                                 gb->buf[gb->n_used++] = c;\
  62                         else\
  63                                 buffer_add_char(gb, c);\
  64                 }\
  65         }while(0)
  66
  67 #define OSRF_BUFFER_RESET(gb) \
  68     memset(gb->buf, 0, gb->size);\
  69     gb->n_used = 0;
  70
  71
  72
  73
  74 /* turns a va_list into a string */
  75 #define VA_LIST_TO_STRING(x) \
  76         unsigned long __len = 0;\
  77         va_list args; \
  78         va_list a_copy;\
  79         va_copy(a_copy, args); \
  80         va_start(args, x); \
  81         __len = vsnprintf(NULL, 0, x, args); \
  82         va_end(args); \
  83         __len += 2; \
  84         char _b[__len]; \
  85         bzero(_b, __len); \
  86         va_start(a_copy, x); \
  87         vsnprintf(_b, __len - 1, x, a_copy); \
  88         va_end(a_copy); \
  89         char* VA_BUF = _b; \
  90
  91 /* turns a long into a string */
  92 #define LONG_TO_STRING(l) \
  93         unsigned int __len = snprintf(NULL, 0, "%ld", l) + 2;\
  94         char __b[__len]; \
  95         bzero(__b, __len); \
  96         snprintf(__b, __len - 1, "%ld", l); \
  97         char* LONGSTR = __b;
  98
  99 #define DOUBLE_TO_STRING(l) \
 100         unsigned int __len = snprintf(NULL, 0, "%f", l) + 2; \
 101         char __b[__len]; \
 102         bzero(__b, __len); \
 103         snprintf(__b, __len - 1, "%f", l); \
 104         char* DOUBLESTR = __b;
 105
 106 #define LONG_DOUBLE_TO_STRING(l) \
 107         unsigned int __len = snprintf(NULL, 0, "%Lf", l) + 2; \
 108         char __b[__len]; \
 109         bzero(__b, __len); \
 110         snprintf(__b, __len - 1, "%Lf", l); \
 111         char* LONGDOUBLESTR = __b;
 112
 113
 114 #define INT_TO_STRING(l) \
 115         unsigned int __len = snprintf(NULL, 0, "%d", l) + 2; \
 116         char __b[__len]; \
 117         bzero(__b, __len); \
 118         snprintf(__b, __len - 1, "%d", l); \
 119         char* INTSTR = __b;
 120
 121
 122 /*
 123 #define MD5SUM(s) \
 124         struct md5_ctx ctx; \
 125         unsigned char digest[16];\
 126         MD5_start (&ctx);\
 127         int i;\
 128         for ( i=0 ; i != strlen(text) ; i++ ) MD5_feed (&ctx, text[i]);\
 129         MD5_stop (&ctx, digest);\
 130         char buf[16];\
 131         memset(buf,0,16);\
 132         char final[256];\
 133         memset(final,0,256);\
 134         for ( i=0 ; i<16 ; i++ ) {\
 135                 sprintf(buf, "%02x", digest[i]);\
 136                 strcat( final, buf );\
 137         }\
 138         char* MD5STR = final;
 139         */
 140
 141
 142
 143
 144
 145 #define BUFFER_MAX_SIZE 10485760
 146
 147 /* these are evil and should be condemned
 148         ! Only use these if you are done with argv[].
 149         call init_proc_title() first, then call
 150         set_proc_title.
 151         the title is only allowed to be as big as the
 152         initial process name of the process (full size of argv[]).
 153         truncation may occurr.
 154  */
 155 int init_proc_title( int argc, char* argv[] );
 156 int set_proc_title( char* format, ... );
 157
 158
 159 int daemonize();
 160
 161 void* safe_malloc(int size);
 162
 163 // ---------------------------------------------------------------------------------
 164 // Generic growing buffer. Add data all you want
 165 // ---------------------------------------------------------------------------------
 166 struct growing_buffer_struct {
 167         char *buf;
 168         int n_used;
 169         int size;
 170 };
 171 typedef struct growing_buffer_struct growing_buffer;
 172
 173 growing_buffer* buffer_init( int initial_num_bytes);
 174
 175 // XXX This isn't defined in utils.c!! removing for now...
 176 //int buffer_addchar(growing_buffer* gb, char c);
 177
 178 int buffer_add(growing_buffer* gb, char* c);
 179 int buffer_fadd(growing_buffer* gb, const char* format, ... );
 180 int buffer_reset( growing_buffer* gb);
 181 char* buffer_data( growing_buffer* gb);
 182 char* buffer_release( growing_buffer* gb );
 183 int buffer_free( growing_buffer* gb );
 184 int buffer_add_char(growing_buffer* gb, char c);
 185
 186 /* returns the size needed to fill in the vsnprintf buffer.
 187         * ! this calls va_end on the va_list argument*
 188         */
 189 long va_list_size(const char* format, va_list);
 190
 191 /* turns a va list into a string, caller must free the
 192         allocated char */
 193 char* va_list_to_string(const char* format, ...);
 194
 195
 196 /* string escape utility method.  escapes unicode embeded characters.
 197         escapes the usual \n, \t, etc.
 198         for example, if you provide a string like so:
 199
 200         hello,
 201                 you
 202
 203         you would get back:
 204         hello,\n\tyou
 205
 206  */
 207 char* uescape( const char* string, int size, int full_escape );
 208
 209 /* utility methods */
 210 int set_fl( int fd, int flags );
 211 int clr_fl( int fd, int flags );
 212
 213
 214
 215 // Utility method
 216 double get_timestamp_millis();
 217
 218
 219 /* returns true if the whole string is a number */
 220 int stringisnum(char* s);
 221
 222 /* reads a file and returns the string version of the file
 223         user is responsible for freeing the returned char*
 224         */
 225 char* file_to_string(const char* filename);
 226
 227
 228
 229 /**
 230   Calculates the md5 of the text provided.
 231   The returned string must be freed by the caller.
 232   */
 233 char* md5sum( char* text, ... );
 234
 235
 236 /**
 237   Checks the validity of the file descriptor
 238   returns -1 if the file descriptor is invalid
 239   returns 0 if the descriptor is OK
 240   */
 241 int osrfUtilsCheckFileDescriptor( int fd );
 242
 243 #endif