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   /* Purge the log file if the max size is defined. */
  99   if (maxsize) {
 100     fp = fopen(filename, "r");
 101     if (fp) {
 102       int filelen;
 103
 104       filelen = fseek(fp, (off_t)0L, SEEK_END);
 105       fseek(fp, (off_t)0L, SEEK_SET);
 106
 107       /* Purge? */
 108       if (filelen >= maxsize)
 109         unlink(filename);
 110
 111       fclose(fp);
 112     }
 113   }
 114
 115   /* Open the log file */
 116   if ((fp = fopen(filename, "a+")) == NULL) {
 117     fprintf(stderr, "warning: could not open log file "
 118             "%s: %s\n", filename, strerror(errno));
 119     fprintf(stderr, "warning: log messages will be displayed on the screen\n");
 120     fp = stderr;
 121   }
 122
 123   /* Get the log type name */
 124   for(np = silc_log_types; np->name; np++) {
 125     if (np->type == type)
 126       break;
 127   }
 128
 129   fprintf(fp, "[%s] [%s] %s\n", silc_get_time(), np->name, string);
 130   fflush(fp);
 131   if (fp != stderr)
 132     fclose(fp);
 133   silc_free(string);
 134 }
 135
 136 /* Outputs the debug message to stderr. */
 137
 138 void silc_log_output_debug(char *file, char *function,
 139                            int line, char *string)
 140 {
 141   if (!silc_debug) {
 142     silc_free(string);
 143     return;
 144   }
 145
 146   if (debug_cb)
 147     {
 148       (*debug_cb)(file, function, line, string);
 149       silc_free(string);
 150       return;
 151     }
 152
 153   fprintf(stderr, "%s:%d: %s\n", function, line, string);
 154   fflush(stderr);
 155   silc_free(string);
 156 }
 157
 158 /* Hexdumps a message */
 159
 160 void silc_log_output_hexdump(char *file, char *function,
 161                              int line, void *data_in,
 162                              uint32 len, char *string)
 163 {
 164   int i, k;
 165   int off, pos, count;
 166   unsigned char *data = (unsigned char *)data_in;
 167
 168   if (!silc_debug) {
 169     silc_free(string);
 170     return;
 171   }
 172
 173   if (debug_hexdump_cb)
 174     {
 175       (*debug_hexdump_cb)(file, function, line, data_in, len, string);
 176       silc_free(string);
 177       return;
 178     }
 179
 180   fprintf(stderr, "%s:%d: %s\n", function, line, string);
 181   silc_free(string);
 182
 183   k = 0;
 184   off = len % 16;
 185   pos = 0;
 186   count = 16;
 187   while (1) {
 188
 189     if (off) {
 190       if ((len - pos) < 16 && (len - pos <= len - off))
 191         count = off;
 192     } else {
 193       if (pos == len)
 194         count = 0;
 195     }
 196     if (off == len)
 197       count = len;
 198
 199     if (count)
 200       fprintf(stderr, "%08X  ", k++ * 16);
 201
 202     for (i = 0; i < count; i++) {
 203       fprintf(stderr, "%02X ", data[pos + i]);
 204
 205       if ((i + 1) % 4 == 0)
 206         fprintf(stderr, " ");
 207     }
 208
 209     if (count && count < 16) {
 210       int j;
 211
 212       for (j = 0; j < 16 - count; j++) {
 213         fprintf(stderr, "   ");
 214
 215         if ((j + count + 1) % 4 == 0)
 216           fprintf(stderr, " ");
 217       }
 218     }
 219
 220     for (i = 0; i < count; i++) {
 221       char ch;
 222
 223       if (data[pos] < 32 || data[pos] >= 127)
 224         ch = '.';
 225       else
 226         ch = data[pos];
 227
 228       fprintf(stderr, "%c", ch);
 229       pos++;
 230     }
 231
 232     if (count)
 233       fprintf(stderr, "\n");
 234
 235     if (count < 16)
 236       break;
 237   }
 238 }
 239
 240 /* Sets log files */
 241
 242 void silc_log_set_files(char *info, uint32 info_size,
 243                         char *warning, uint32 warning_size,
 244                         char *error, uint32 error_size,
 245                         char *fatal, uint32 fatal_size)
 246 {
 247   log_info_file = info;
 248   log_warning_file = warning;
 249   log_error_file = error;
 250   log_fatal_file = fatal;
 251
 252   log_info_size = info_size;
 253   log_warning_size = warning_size;
 254   log_error_size = error_size;
 255   log_fatal_size = fatal_size;
 256 }
 257
 258 /* Sets log callbacks */
 259
 260 void silc_log_set_callbacks(SilcLogCb info, SilcLogCb warning,
 261                             SilcLogCb error, SilcLogCb fatal)
 262 {
 263   info_cb = info;
 264   warning_cb = warning;
 265   error_cb = error;
 266   fatal_cb = fatal;
 267 }
 268
 269 /* Resets log callbacks */
 270
 271 void silc_log_reset_callbacks()
 272 {
 273   info_cb = warning_cb = error_cb = fatal_cb = NULL;
 274 }
 275
 276 /* Sets debug callbacks */
 277
 278 void silc_log_set_debug_callbacks(SilcDebugCb debug,
 279                                   SilcDebugHexdumpCb debug_hexdump)
 280 {
 281   debug_cb = debug;
 282   debug_hexdump_cb = debug_hexdump;
 283 }
 284
 285 /* Resets debug callbacks */
 286
 287 void silc_log_reset_debug_callbacks()
 288 {
 289   debug_cb = NULL;
 290   debug_hexdump_cb = NULL;
 291 }