src/log.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 Index Data
   3  * See the file LICENSE for details.
   4  */
   5
   6 /**
   7  * \file log.c
   8  * \brief Logging utility
   9  */
  10
  11 #if HAVE_CONFIG_H
  12 #include <config.h>
  13 #endif
  14
  15 #ifdef WIN32
  16 #include <windows.h>
  17 #endif
  18
  19 #include <sys/stat.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <ctype.h>
  23 #include <string.h>
  24 #include <stdarg.h>
  25 #include <errno.h>
  26 #include <time.h>
  27 #include <yaz/nmem.h>
  28 #include <yaz/log.h>
  29 #include <yaz/snprintf.h>
  30 #include <yaz/xmalloc.h>
  31
  32 #define HAS_STRERROR 1
  33
  34
  35 #if HAS_STRERROR
  36
  37 #else
  38 char *strerror(int n)
  39 {
  40     extern char *sys_errlist[];
  41     return sys_errlist[n];
  42 }
  43
  44 #endif
  45
  46
  47 static int l_level = YLOG_DEFAULT_LEVEL;
  48
  49 enum l_file_type { use_stderr, use_none, use_file };
  50 static enum l_file_type yaz_file_type = use_stderr;
  51 static FILE *yaz_global_log_file = NULL;
  52
  53 static void (*start_hook_func)(int, const char *, void *) = NULL;
  54 static void *start_hook_info;
  55
  56 static void (*end_hook_func)(int, const char *, void *) = NULL;
  57 static void *end_hook_info;
  58
  59 static void (*hook_func)(int, const char *, void *) = NULL;
  60 static void *hook_info;
  61
  62 static char l_prefix[512] = "";
  63 static char l_prefix2[512] = "";
  64 static char l_fname[512] = "";
  65
  66
  67 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
  68 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
  69 #define TIMEFORMAT_LEN 50
  70 static char l_custom_format[TIMEFORMAT_LEN] = "";
  71 static char *l_actual_format = l_old_default_format;
  72
  73 /** l_max_size tells when to rotate the log. Default is 1 GB
  74     This is almost the same as never, but it saves applications in the
  75     case of 2 or 4 GB file size limits..
  76  */
  77 static int l_max_size = 1024*1024*1024;
  78
  79 #define MAX_MASK_NAMES 35   /* 32 bits plus a few combo names */
  80 static struct {
  81     int mask;
  82     char *name;
  83 } mask_names[MAX_MASK_NAMES] =
  84 {
  85     { YLOG_FATAL,  "fatal"},
  86     { YLOG_DEBUG,  "debug"},
  87     { YLOG_WARN,   "warn" },
  88     { YLOG_LOG,    "log"  },
  89     { YLOG_ERRNO,  ""},
  90     { YLOG_MALLOC, "malloc"},
  91     { YLOG_APP,    "app"  },
  92     { YLOG_NOTIME, "notime" },
  93     { YLOG_APP2,   "app2" },
  94     { YLOG_APP3,   "app3" },
  95     { YLOG_ALL,    "all"  },
  96     { YLOG_FLUSH,  "flush" },
  97     { YLOG_LOGLVL, "loglevel" },
  98     { 0,           "none" },
  99     { 0, NULL }
 100     /* the rest will be filled in if the user defines dynamic modules*/
 101 };
 102
 103 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
 104
 105 static void internal_log_init(void)
 106 {
 107     static int mutex_init_flag = 0; /* not yet initialized */
 108     char *env;
 109
 110     if (mutex_init_flag)
 111         return;
 112     mutex_init_flag = 1; /* here, 'cause nmem_mutex_create may call yaz_log */
 113
 114     env = getenv("YAZ_LOG");
 115     if (env)
 116         l_level = yaz_log_mask_str_x(env, l_level);
 117 }
 118
 119
 120 FILE *yaz_log_file(void)
 121 {
 122     FILE *f = 0;
 123     switch(yaz_file_type)
 124     {
 125         case use_stderr: f = stderr; break;
 126         case use_none: f = 0; break;
 127         case use_file: f = yaz_global_log_file; break;
 128     }
 129     return f;
 130 }
 131
 132 void yaz_log_close(void)
 133 {
 134     if (yaz_file_type == use_file && yaz_global_log_file)
 135     {
 136         fclose(yaz_global_log_file);
 137         yaz_global_log_file = 0;
 138     }
 139 }
 140
 141 void yaz_log_init_file(const char *fname)
 142 {
 143     internal_log_init();
 144
 145     yaz_log_close();
 146     if (fname)
 147     {
 148         if (*fname == '\0')
 149             yaz_file_type = use_stderr; /* empty name; use stderr */
 150         else
 151             yaz_file_type = use_file;
 152         strncpy(l_fname, fname, sizeof(l_fname)-1);
 153         l_fname[sizeof(l_fname)-1] = '\0';
 154     }
 155     else
 156     {
 157         yaz_file_type = use_none;  /* NULL name; use no file at all */
 158         l_fname[0] = '\0';
 159     }
 160     yaz_log_reopen();
 161 }
 162
 163 static void rotate_log(const char *cur_fname)
 164 {
 165     int i;
 166
 167 #ifdef WIN32
 168     /* windows can't rename a file if it is open */
 169     yaz_log_close();
 170 #endif
 171     for (i = 0; i<9; i++)
 172     {
 173         char fname_str[FILENAME_MAX];
 174         struct stat stat_buf;
 175
 176         yaz_snprintf(fname_str, sizeof(fname_str), "%s.%d", cur_fname, i);
 177         if (stat(fname_str, &stat_buf) != 0)
 178             break;
 179     }
 180     for (; i >= 0; --i)
 181     {
 182         char fname_str[2][FILENAME_MAX];
 183
 184         if (i > 0)
 185             yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
 186                          "%s.%d", cur_fname, i-1);
 187         else
 188             yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
 189                          "%s", cur_fname);
 190         yaz_snprintf(fname_str[1], sizeof(fname_str[1]),
 191                      "%s.%d", cur_fname, i);
 192 #ifdef WIN32
 193         MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING);
 194 #else
 195         rename(fname_str[0], fname_str[1]);
 196 #endif
 197     }
 198 }
 199
 200
 201 void yaz_log_init_level(int level)
 202 {
 203     internal_log_init();
 204     if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
 205     {
 206         l_level = level;
 207         yaz_log_reopen(); /* make sure we set buffering right */
 208     }
 209     else
 210         l_level = level;
 211
 212     if (l_level  & YLOG_LOGLVL)
 213     {  /* dump the log level bits */
 214         const char *bittype = "Static ";
 215         int i, sz;
 216
 217         yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
 218                 l_level, l_level);
 219         /* determine size of mask_names (locked) */
 220         for (sz = 0; mask_names[sz].name; sz++)
 221             ;
 222         /* second pass without lock */
 223         for (i = 0; i < sz; i++)
 224             if (mask_names[i].mask && *mask_names[i].name)
 225                 if (strcmp(mask_names[i].name, "all") != 0)
 226                 {
 227                     yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
 228                             bittype, mask_names[i].mask, mask_names[i].name,
 229                             (level & mask_names[i].mask)?  "ON": "off");
 230                     if (mask_names[i].mask > YLOG_LAST_BIT)
 231                         bittype = "Dynamic";
 232                 }
 233     }
 234 }
 235
 236 void yaz_log_init_prefix(const char *prefix)
 237 {
 238     if (prefix && *prefix)
 239         yaz_snprintf(l_prefix, sizeof(l_prefix), "%s ", prefix);
 240     else
 241         *l_prefix = 0;
 242 }
 243
 244 void yaz_log_init_prefix2(const char *prefix)
 245 {
 246     if (prefix && *prefix)
 247         yaz_snprintf(l_prefix2, sizeof(l_prefix2), "%s ", prefix);
 248     else
 249         *l_prefix2 = 0;
 250 }
 251
 252 void yaz_log_init(int level, const char *prefix, const char *fname)
 253 {
 254     internal_log_init();
 255     yaz_log_init_level(level);
 256     yaz_log_init_prefix(prefix);
 257     if (fname && *fname)
 258         yaz_log_init_file(fname);
 259 }
 260
 261 void yaz_log_init_max_size(int mx)
 262 {
 263     if (mx > 0)
 264         l_max_size = mx;
 265     else
 266         l_max_size = 0;
 267 }
 268
 269 void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
 270 {
 271     hook_func = func;
 272     hook_info = info;
 273 }
 274
 275 void log_event_start(void (*func)(int, const char *, void *), void *info)
 276 {
 277      start_hook_func = func;
 278      start_hook_info = info;
 279 }
 280
 281 void log_event_end(void (*func)(int, const char *, void *), void *info)
 282 {
 283      end_hook_func = func;
 284      end_hook_info = info;
 285 }
 286
 287 static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
 288 {
 289     char new_filename[512];
 290     static char cur_filename[512] = "";
 291
 292     if (yaz_file_type != use_file)
 293         return;
 294
 295     if (*l_fname)
 296     {
 297         strftime(new_filename, sizeof(new_filename)-1, l_fname, tm);
 298         if (strcmp(new_filename, cur_filename))
 299         {
 300             strcpy(cur_filename, new_filename);
 301             force = 1;
 302         }
 303     }
 304
 305     if (l_max_size > 0 && yaz_global_log_file)
 306     {
 307         long flen = ftell(yaz_global_log_file);
 308         if (flen > l_max_size)
 309         {
 310             rotate_log(cur_filename);
 311             force = 1;
 312         }
 313     }
 314     if (force && *cur_filename)
 315     {
 316         FILE *new_file;
 317 #ifdef WIN32
 318         yaz_log_close();
 319 #endif
 320         new_file = fopen(cur_filename, filemode);
 321         if (new_file)
 322         {
 323             yaz_log_close();
 324             yaz_global_log_file = new_file;
 325             if (l_level & YLOG_FLUSH)
 326                 setvbuf(yaz_global_log_file, 0, _IONBF, 0);
 327         }
 328         else
 329         {
 330             /* disable log rotate */
 331             l_max_size = 0;
 332         }
 333     }
 334 }
 335
 336 static void yaz_log_do_reopen(const char *filemode)
 337 {
 338     time_t cur_time = time(0);
 339 #if HAVE_LOCALTIME_R
 340     struct tm tm0, *tm = &tm0;
 341 #else
 342     struct tm *tm;
 343 #endif
 344
 345 #if HAVE_LOCALTIME_R
 346     localtime_r(&cur_time, tm);
 347 #else
 348     tm = localtime(&cur_time);
 349 #endif
 350     yaz_log_open_check(tm, 1, filemode);
 351 }
 352
 353
 354 void yaz_log_reopen()
 355 {
 356     yaz_log_do_reopen("a");
 357 }
 358
 359 void yaz_log_trunc()
 360 {
 361     yaz_log_do_reopen("w");
 362 }
 363
 364 static void yaz_strftime(char *dst, size_t sz,
 365                          const char *fmt, const struct tm *tm)
 366 {
 367     strftime(dst, sz, fmt, tm);
 368 }
 369
 370 static void yaz_log_to_file(int level, const char *log_message)
 371 {
 372     FILE *file;
 373     time_t ti = time(0);
 374 #if HAVE_LOCALTIME_R
 375     struct tm tm0, *tm = &tm0;
 376 #else
 377     struct tm *tm;
 378 #endif
 379
 380     internal_log_init();
 381
 382 #if HAVE_LOCALTIME_R
 383     localtime_r(&ti, tm);
 384 #else
 385     tm = localtime(&ti);
 386 #endif
 387
 388     yaz_log_open_check(tm, 0, "a");
 389     file = yaz_log_file(); /* file may change in yaz_log_open_check */
 390
 391     if (file)
 392     {
 393         char tbuf[TIMEFORMAT_LEN];
 394         char flags[1024];
 395         int i;
 396
 397         *flags = '\0';
 398         for (i = 0; level && mask_names[i].name; i++)
 399             if ( mask_names[i].mask & level)
 400             {
 401                 if (*mask_names[i].name && mask_names[i].mask &&
 402                     mask_names[i].mask != YLOG_ALL)
 403                 {
 404                     if (strlen(flags) + strlen(mask_names[i].name)
 405                                              <   sizeof(flags) - 4)
 406                     {
 407                         strcat(flags, "[");
 408                         strcat(flags, mask_names[i].name);
 409                         strcat(flags, "]");
 410                     }
 411                     level &= ~mask_names[i].mask;
 412                 }
 413             }
 414
 415         tbuf[0] = '\0';
 416         if (!(l_level & YLOG_NOTIME))
 417         {
 418             yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm);
 419             tbuf[TIMEFORMAT_LEN-2] = '\0';
 420         }
 421         if (tbuf[0])
 422             strcat(tbuf, " ");
 423         fprintf(file, "%s%s%s %s%s\n", tbuf, l_prefix, flags, l_prefix2,
 424                 log_message);
 425         if (l_level & YLOG_FLUSH)
 426             fflush(file);
 427     }
 428 }
 429
 430 void yaz_log(int level, const char *fmt, ...)
 431 {
 432     va_list ap;
 433     char buf[4096];
 434     FILE *file;
 435     int o_level = level;
 436
 437     internal_log_init();
 438     if (!(level & l_level))
 439         return;
 440     va_start(ap, fmt);
 441
 442     /* 30 is enough for our 'rest of output' message */
 443     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
 444     if (strlen(buf) >= sizeof(buf)-31)
 445         strcat(buf, " [rest of output omitted]");
 446
 447     if (o_level & YLOG_ERRNO)
 448     {
 449         int remain = sizeof(buf) - strlen(buf);
 450         if (remain > 100) /* reasonable minimum space for error */
 451         {
 452             strcat(buf, " [");
 453             yaz_strerror(buf+strlen(buf), remain-5); /* 5 due to extra [] */
 454             strcat(buf, "]");
 455         }
 456     }
 457     va_end (ap);
 458     if (start_hook_func)
 459         (*start_hook_func)(o_level, buf, start_hook_info);
 460     if (hook_func)
 461         (*hook_func)(o_level, buf, hook_info);
 462     file = yaz_log_file();
 463     if (file)
 464         yaz_log_to_file(level, buf);
 465     if (end_hook_func)
 466         (*end_hook_func)(o_level, buf, end_hook_info);
 467 }
 468
 469 void yaz_log_time_format(const char *fmt)
 470 {
 471     if ( !fmt || !*fmt)
 472     { /* no format, default to new */
 473         l_actual_format = l_new_default_format;
 474         return;
 475     }
 476     if (0==strcmp(fmt, "old"))
 477     { /* force the old format */
 478         l_actual_format = l_old_default_format;
 479         return;
 480     }
 481     /* else use custom format */
 482     strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
 483     l_custom_format[TIMEFORMAT_LEN-1] = '\0';
 484     l_actual_format = l_custom_format;
 485 }
 486
 487 /** cleans a loglevel name from leading paths and suffixes */
 488 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
 489 {
 490     char *p = namebuf;
 491     char *start = namebuf;
 492     if (buflen <= len)
 493         len = buflen-1;
 494     strncpy(namebuf, name, len);
 495     namebuf[len] = '\0';
 496     while ((p = strchr(start, '/')))
 497         start = p+1;
 498     if ((p = strrchr(start, '.')))
 499         *p = '\0';
 500     return start;
 501 }
 502
 503 static int define_module_bit(const char *name)
 504 {
 505     int i;
 506
 507     for (i = 0; mask_names[i].name; i++)
 508         if (0 == strcmp(mask_names[i].name, name))
 509         {
 510             return mask_names[i].mask;
 511         }
 512     if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1<<31) ))
 513     {
 514         yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
 515         return 0;
 516     }
 517     mask_names[i].mask = next_log_bit;
 518     next_log_bit = next_log_bit<<1;
 519     mask_names[i].name = (char *) malloc(strlen(name)+1);
 520     strcpy(mask_names[i].name, name);
 521     mask_names[i+1].name = NULL;
 522     mask_names[i+1].mask = 0;
 523     return mask_names[i].mask;
 524 }
 525
 526 int yaz_log_module_level(const char *name)
 527 {
 528     int i;
 529     char clean[255];
 530     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
 531     internal_log_init();
 532
 533     for (i = 0; mask_names[i].name; i++)
 534         if (0==strcmp(n, mask_names[i].name))
 535         {
 536             yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
 537                     mask_names[i].mask, n,
 538                     strcmp(n,name) ? name : "");
 539             return mask_names[i].mask;
 540         }
 541     yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
 542             strcmp(n, name) ? name : "" );
 543     return 0;
 544 }
 545
 546 int yaz_log_mask_str(const char *str)
 547 {
 548     internal_log_init(); /* since l_level may be affected */
 549     return yaz_log_mask_str_x(str, l_level);
 550 }
 551
 552 int yaz_log_mask_str_x(const char *str, int level)
 553 {
 554     const char *p;
 555
 556     internal_log_init();
 557     while (*str)
 558     {
 559         int negated = 0;
 560         for (p = str; *p && *p != ','; p++)
 561             ;
 562         if (*str=='-')
 563         {
 564             negated = 1;
 565             str++;
 566         }
 567         if (isdigit(*(unsigned char *) str))
 568         {
 569             level = atoi(str);
 570         }
 571         else
 572         {
 573             char clean[509];
 574             char *n = clean_name(str, p-str, clean, sizeof(clean));
 575             int mask = define_module_bit(n);
 576             if (!mask)
 577                 level = 0;  /* 'none' clears them all */
 578             else if (negated)
 579                 level &= ~mask;
 580             else
 581                 level |= mask;
 582         }
 583         if (*p == ',')
 584             p++;
 585         str = p;
 586     }
 587     return level;
 588 }
 589 /*
 590  * Local variables:
 591  * c-basic-offset: 4
 592  * indent-tabs-mode: nil
 593  * End:
 594  * vim: shiftwidth=4 tabstop=8 expandtab
 595  */