lib/silcutil/silclog.c

   1 /*
   2
   3   silclog.c
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2000 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20 /* $Id$ */
  21
  22 #include "silcincludes.h"
  23
  24 /* Set TRUE/FALSE to enable/disable debugging */
  25 int silc_debug = FALSE;
  26
  27 /* SILC Log name strings. These strings are printed to the log file. */
  28 const SilcLogTypeName silc_log_types[] =
  29 {
  30   { "Info", SILC_LOG_INFO },
  31   { "Warning", SILC_LOG_WARNING },
  32   { "Error", SILC_LOG_ERROR },
  33   { "Fatal", SILC_LOG_FATAL },
  34
  35   { NULL, -1 },
  36 };
  37
  38 char *log_info_file;
  39 char *log_warning_file;
  40 char *log_error_file;
  41 char *log_fatal_file;
  42 uint32 log_info_size;
  43 uint32 log_warning_size;
  44 uint32 log_error_size;
  45 uint32 log_fatal_size;
  46
  47 /* Log callbacks. If these are set by the application these are used
  48    instead of the default functions in this file. */
  49 static SilcLogCb info_cb = NULL;
  50 static SilcLogCb warning_cb = NULL;
  51 static SilcLogCb error_cb = NULL;
  52 static SilcLogCb fatal_cb = NULL;
  53
  54 /* Debug callbacks. If set these are used instead of default ones. */
  55 static SilcDebugCb debug_cb = NULL;
  56 static SilcDebugHexdumpCb debug_hexdump_cb = NULL;
  57
  58 /* Outputs the log message to what ever log file selected. */
  59
  60 void silc_log_output(const char *filename, uint32 maxsize,
  61                      SilcLogType type, char *string)
  62 {
  63   FILE *fp;
  64   const SilcLogTypeName *np;
  65
  66   switch(type)
  67     {
  68     case SILC_LOG_INFO:
  69       if (info_cb) {
  70         (*info_cb)(string);
  71         silc_free(string);
  72         return;
  73       }
  74       break;
  75     case SILC_LOG_WARNING:
  76       if (warning_cb) {
  77         (*warning_cb)(string);
  78         silc_free(string);
  79         return;
  80       }
  81       break;
  82     case SILC_LOG_ERROR:
  83       if (error_cb) {
  84         (*error_cb)(string);
  85         silc_free(string);
  86         return;
  87       }
  88       break;
  89     case SILC_LOG_FATAL:
  90       if (fatal_cb) {
  91         (*fatal_cb)(string);
  92         silc_free(string);
  93         return;
  94       }
  95       break;
  96     }
  97
  98   if (!filename)
  99     filename = " ";
 100
 101   /* Purge the log file if the max size is defined. */
 102   if (maxsize) {
 103     fp = fopen(filename, "r");
 104     if (fp) {
 105       int filelen;
 106
 107       filelen = fseek(fp, (off_t)0L, SEEK_END);
 108       fseek(fp, (off_t)0L, SEEK_SET);
 109
 110       /* Purge? */
 111       if (filelen >= maxsize)
 112         unlink(filename);
 113
 114       fclose(fp);
 115     }
 116   }
 117
 118   /* Open the log file */
 119   if ((fp = fopen(filename, "a+")) == NULL) {
 120     fprintf(stderr, "warning: could not open log file "
 121             "%s: %s\n", filename, strerror(errno));
 122     fprintf(stderr, "warning: log messages will be displayed on the screen\n");
 123     fp = stderr;
 124   }
 125
 126   /* Get the log type name */
 127   for(np = silc_log_types; np->name; np++) {
 128     if (np->type == type)
 129       break;
 130   }
 131
 132   fprintf(fp, "[%s] [%s] %s\n", silc_get_time(), np->name, string);
 133   fflush(fp);
 134   if (fp != stderr)
 135     fclose(fp);
 136   silc_free(string);
 137 }
 138
 139 /* Outputs the debug message to stderr. */
 140
 141 void silc_log_output_debug(char *file, char *function,
 142                            int line, char *string)
 143 {
 144   if (!silc_debug) {
 145     silc_free(string);
 146     return;
 147   }
 148
 149   if (debug_cb)
 150     {
 151       (*debug_cb)(file, function, line, string);
 152       silc_free(string);
 153       return;
 154     }
 155
 156   fprintf(stderr, "%s:%d: %s\n", function, line, string);
 157   fflush(stderr);
 158   silc_free(string);
 159 }
 160
 161 /* Hexdumps a message */
 162
 163 void silc_log_output_hexdump(char *file, char *function,
 164                              int line, void *data_in,
 165                              uint32 len, char *string)
 166 {
 167   int i, k;
 168   int off, pos, count;
 169   unsigned char *data = (unsigned char *)data_in;
 170
 171   if (!silc_debug) {
 172     silc_free(string);
 173     return;
 174   }
 175
 176   if (debug_hexdump_cb)
 177     {
 178       (*debug_hexdump_cb)(file, function, line, data_in, len, string);
 179       silc_free(string);
 180       return;
 181     }
 182
 183   fprintf(stderr, "%s:%d: %s\n", function, line, string);
 184   silc_free(string);
 185
 186   k = 0;
 187   off = len % 16;
 188   pos = 0;
 189   count = 16;
 190   while (1) {
 191
 192     if (off) {
 193       if ((len - pos) < 16 && (len - pos <= len - off))
 194         count = off;
 195     } else {
 196       if (pos == len)
 197         count = 0;
 198     }
 199     if (off == len)
 200       count = len;
 201
 202     if (count)
 203       fprintf(stderr, "%08X  ", k++ * 16);
 204
 205     for (i = 0; i < count; i++) {
 206       fprintf(stderr, "%02X ", data[pos + i]);
 207
 208       if ((i + 1) % 4 == 0)
 209         fprintf(stderr, " ");
 210     }
 211
 212     if (count && count < 16) {
 213       int j;
 214
 215       for (j = 0; j < 16 - count; j++) {
 216         fprintf(stderr, "   ");
 217
 218         if ((j + count + 1) % 4 == 0)
 219           fprintf(stderr, " ");
 220       }
 221     }
 222
 223     for (i = 0; i < count; i++) {
 224       char ch;
 225
 226       if (data[pos] < 32 || data[pos] >= 127)
 227         ch = '.';
 228       else
 229         ch = data[pos];
 230
 231       fprintf(stderr, "%c", ch);
 232       pos++;
 233     }
 234
 235     if (count)
 236       fprintf(stderr, "\n");
 237
 238     if (count < 16)
 239       break;
 240   }
 241 }
 242
 243 /* Sets log files */
 244
 245 void silc_log_set_files(char *info, uint32 info_size,
 246                         char *warning, uint32 warning_size,
 247                         char *error, uint32 error_size,
 248                         char *fatal, uint32 fatal_size)
 249 {
 250   log_info_file = info;
 251   log_warning_file = warning;
 252   log_error_file = error;
 253   log_fatal_file = fatal;
 254
 255   log_info_size = info_size;
 256   log_warning_size = warning_size;
 257   log_error_size = error_size;
 258   log_fatal_size = fatal_size;
 259 }
 260
 261 /* Sets log callbacks */
 262
 263 void silc_log_set_callbacks(SilcLogCb info, SilcLogCb warning,
 264                             SilcLogCb error, SilcLogCb fatal)
 265 {
 266   info_cb = info;
 267   warning_cb = warning;
 268   error_cb = error;
 269   fatal_cb = fatal;
 270 }
 271
 272 /* Resets log callbacks */
 273
 274 void silc_log_reset_callbacks()
 275 {
 276   info_cb = warning_cb = error_cb = fatal_cb = NULL;
 277 }
 278
 279 /* Sets debug callbacks */
 280
 281 void silc_log_set_debug_callbacks(SilcDebugCb debug,
 282                                   SilcDebugHexdumpCb debug_hexdump)
 283 {
 284   debug_cb = debug;
 285   debug_hexdump_cb = debug_hexdump;
 286 }
 287
 288 /* Resets debug callbacks */
 289
 290 void silc_log_reset_debug_callbacks()
 291 {
 292   debug_cb = NULL;
 293   debug_hexdump_cb = NULL;
 294 }