Added snprintf/vsnprintf wrappers for systems that don't have
[yaz-moved-to-github.git] / src / log.c
index 7885eab..351c0bd 100644 (file)
--- a/src/log.c
+++ b/src/log.c
@@ -1,13 +1,13 @@
 /*
- * Copyright (C) 1995-2005, Index Data ApS
+ * Copyright (C) 1995-2007, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: log.c,v 1.29 2005-09-16 21:46:24 adam Exp $
+ * $Id: log.c,v 1.48 2007-02-23 10:15:01 adam Exp $
  */
 
 /**
  * \file log.c
- * \brief Implements logging utility
+ * \brief Logging utility
  */
 
 #if HAVE_CONFIG_H
@@ -26,6 +26,7 @@
 #include <pth.h>
 #endif
 
+#include <sys/stat.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <ctype.h>
 #include <time.h>
 #include <yaz/nmem.h>
 #include <yaz/log.h>
+#include <yaz/snprintf.h>
 #include <yaz/xmalloc.h>
 
 static NMEM_MUTEX log_mutex = 0;
-static int mutex_init_flag = 0; /* not yet initialized */
 
 #define HAS_STRERROR 1
 
+
 #if HAS_STRERROR
 
 #else
@@ -53,20 +55,37 @@ char *strerror(int n)
 
 #endif
 
+
 static int l_level = YLOG_DEFAULT_LEVEL;
-static FILE *l_file = NULL;
+
+enum l_file_type { use_stderr, use_none, use_file };
+static enum l_file_type yaz_file_type = use_stderr;
+static FILE *yaz_global_log_file = NULL;
+
+static void (*start_hook_func)(int, const char *, void *) = NULL;
+static void *start_hook_info;
+
+static void (*end_hook_func)(int, const char *, void *) = NULL;
+static void *end_hook_info;
+
+static void (*hook_func)(int, const char *, void *) = NULL;
+static void *hook_info;
+
 static char l_prefix[512] = "";
 static char l_prefix2[512] = "";
 static char l_fname[512] = "";
 
+
 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
 #define TIMEFORMAT_LEN 50
 static char l_custom_format[TIMEFORMAT_LEN] = "";
 static char *l_actual_format = l_old_default_format;
 
-/** l_max_size tells when to rotate the log. Default to 1 GB */
-static const int l_def_max_size = 1024*1024*1024;
+/** l_max_size tells when to rotate the log. Default is 1 GB 
+    This is almost the same as never, but it saves applications in the
+    case of 2 or 4 GB file size limits..
+ */
 static int l_max_size = 1024*1024*1024;
 
 #define MAX_MASK_NAMES 35   /* 32 bits plus a few combo names */
@@ -95,59 +114,112 @@ static struct {
 
 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
 
-static void init_mutex()
+static void internal_log_init(void)
 {
+    static int mutex_init_flag = 0; /* not yet initialized */
+    char *env;
+
     if (mutex_init_flag)
         return;
+    mutex_init_flag = 1; /* here, 'cause nmem_mutex_create may call yaz_log */
+
     nmem_mutex_create(&log_mutex);
-    mutex_init_flag = 1;
+
+    env = getenv("YAZ_LOG");
+    if (env)
+        l_level = yaz_log_mask_str_x(env, l_level);
 }
 
+
 FILE *yaz_log_file(void)
 {
-    if (!l_file)
-        l_file = stderr;
-    return l_file;
+    FILE *f = 0;
+    switch(yaz_file_type)
+    {
+        case use_stderr: f = stderr; break;
+        case use_none: f = 0; break;
+        case use_file: f = yaz_global_log_file; break;
+    }
+    return f;
+}
+
+void yaz_log_close(void)
+{
+    if (yaz_file_type == use_file && yaz_global_log_file)
+    {
+        fclose(yaz_global_log_file);
+        yaz_global_log_file = 0;
+    }
 }
 
 void yaz_log_init_file(const char *fname)
 {
-    init_mutex();
+    internal_log_init();
+
+    yaz_log_close();
     if (fname)
     {
+        if (*fname == '\0')
+            yaz_file_type = use_stderr; /* empty name; use stderr */
+        else
+            yaz_file_type = use_file;
         strncpy(l_fname, fname, sizeof(l_fname)-1);
         l_fname[sizeof(l_fname)-1] = '\0';
     }
     else
-        l_fname[0] = '\0';
+    {
+        yaz_file_type = use_none;  /* NULL name; use no file at all */
+        l_fname[0] = '\0'; 
+    }
     yaz_log_reopen();
 }
 
 static void rotate_log(const char *cur_fname)
 {
-    char newname[512];
-    strncpy(newname, cur_fname, 509);
-    newname[509] = '\0'; /* make sure it is terminated */
-    strcat(newname, ".1");
+    int i;
+
 #ifdef WIN32
     /* windows can't rename a file if it is open */
-    fclose(l_file);
-    l_file = 0;
-    MoveFileEx(cur_fname, newname, MOVEFILE_REPLACE_EXISTING);
+    yaz_log_close();
+#endif
+    for (i = 0; i<9; i++)
+    {
+        char fname_str[FILENAME_MAX];
+        struct stat stat_buf;
+
+        sprintf(fname_str, "%s.%d", cur_fname, i);
+        if (stat(fname_str, &stat_buf) != 0)
+            break;
+    }
+    for (; i >= 0; --i)
+    {
+        char fname_str[2][FILENAME_MAX];
+
+        if (i > 0)
+            sprintf(fname_str[0], "%s.%d", cur_fname, i-1);
+        else
+            sprintf(fname_str[0], "%s", cur_fname);
+        sprintf(fname_str[1], "%s.%d", cur_fname, i);
+#ifdef WIN32
+        MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING);
 #else
-    rename(cur_fname, newname);
+        rename(fname_str[0], fname_str[1]);
 #endif
+    }
 }
 
+
 void yaz_log_init_level(int level)
 {
-    init_mutex();
+    internal_log_init();
     if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
     {
         l_level = level;
         yaz_log_reopen(); /* make sure we set buffering right */
-    } else
+    } 
+    else
         l_level = level;
+
     if (l_level  & YLOG_LOGLVL)
     {  /* dump the log level bits */
         const char *bittype = "Static ";
@@ -192,7 +264,7 @@ void yaz_log_init_prefix2(const char *prefix)
 
 void yaz_log_init(int level, const char *prefix, const char *fname)
 {
-    init_mutex();
+    internal_log_init();
     yaz_log_init_level(level);
     yaz_log_init_prefix(prefix);
     if (fname && *fname)
@@ -201,36 +273,37 @@ void yaz_log_init(int level, const char *prefix, const char *fname)
 
 void yaz_log_init_max_size(int mx)
 {
-    if (mx <0)
-        l_max_size = l_def_max_size;
-    else
+    if (mx > 0)
         l_max_size = mx;
+    else
+        l_max_size = 0;
 }
 
-static void (*start_hook_func)(int, const char *, void *) = NULL;
-static void *start_hook_info;
-static void (*end_hook_func)(int, const char *, void *) = NULL;
-static void *end_hook_info;
+void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
+{
+    hook_func = func;
+    hook_info = info;
+}
 
 void log_event_start(void (*func)(int, const char *, void *), void *info)
 {
-    start_hook_func = func;
-    start_hook_info = info;
+     start_hook_func = func;
+     start_hook_info = info;
 }
 
 void log_event_end(void (*func)(int, const char *, void *), void *info)
 {
-    end_hook_func = func;
-    end_hook_info = info;
+     end_hook_func = func;
+     end_hook_info = info;
 }
 
-static void yaz_log_open_check(struct tm *tm, int force)
+static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
 {
     char new_filename[512];
     static char cur_filename[512] = "";
 
-    if (!l_file)
-        l_file = stderr;
+    if (yaz_file_type != use_file)
+        return;
 
     if (l_fname && *l_fname)
     {
@@ -240,27 +313,40 @@ static void yaz_log_open_check(struct tm *tm, int force)
             strcpy(cur_filename, new_filename);
             force = 1;
         }
-        if (l_max_size > 0 && (l_file && l_file != stderr))
+    }
+
+    if (l_max_size > 0 && yaz_global_log_file)
+    {
+        long flen = ftell(yaz_global_log_file);
+        if (flen > l_max_size)
         {
-            long flen = ftell(l_file);
-            if (flen > l_max_size)
-            {
-                rotate_log(cur_filename);
-                force = 1;
-            }
+            rotate_log(cur_filename);
+            force = 1;
         }
-        if (force)
+    }
+    if (force && *cur_filename)
+    {
+        FILE *new_file;
+#ifdef WIN32
+        yaz_log_close();
+#endif
+        new_file = fopen(cur_filename, filemode);
+        if (new_file)
         {
-            if (l_file && l_file != stderr)
-                fclose(l_file);
-            l_file = fopen(cur_filename, "a");
+            yaz_log_close();
+            yaz_global_log_file = new_file;
             if (l_level & YLOG_FLUSH)
-                setvbuf(l_file, 0, _IONBF, 0);
+                setvbuf(yaz_global_log_file, 0, _IONBF, 0);
+        }
+        else
+        {
+            /* disable log rotate */
+            l_max_size = 0;
         }
     }
 }
 
-void yaz_log_reopen()
+static void yaz_log_do_reopen(const char *filemode)
 {
     time_t cur_time = time(0);
 #if HAVE_LOCALTIME_R
@@ -275,65 +361,120 @@ void yaz_log_reopen()
 #else
     tm = localtime(&cur_time);
 #endif
-    yaz_log_open_check(tm, 1);
+    yaz_log_open_check(tm, 1, filemode);
     nmem_mutex_leave(log_mutex);
 }
 
-void yaz_log(int level, const char *fmt, ...)
+
+void yaz_log_reopen()
 {
-    va_list ap;
-    char buf[4096], flags[1024];
-    int i;
-    time_t ti;
+    yaz_log_do_reopen("a");
+}
+
+void yaz_log_trunc()
+{
+    yaz_log_do_reopen("w");
+}
+
+
+
+static void yaz_strftime(char *dst, size_t sz,
+                         const char *fmt, const struct tm *tm)
+{
+    const char *cp = strstr(fmt, "%!");
+    if (cp && strlen(fmt) < 60)
+    {
+        char fmt2[80];
+        char tpidstr[20];
+#ifdef WIN32
+        DWORD tid = GetCurrentThreadId();
+#else
+        pthread_t tid = 0;
+#if YAZ_POSIX_THREADS
+        tid = pthread_self();
+#endif
+#endif
+        memcpy(fmt2, fmt, cp-fmt);
+        fmt2[cp-fmt] = '\0';
+        sprintf(tpidstr, "%08lx", (long) tid);
+        strcat(fmt2, tpidstr);
+        strcat(fmt2, cp+2);
+        strftime(dst, sz, fmt2, tm);     
+    }
+    else
+        strftime(dst, sz, fmt, tm);
+}
+                            
+static void yaz_log_to_file(int level, const char *log_message)
+{
+    FILE *file;
+    time_t ti = time(0);
 #if HAVE_LOCALTIME_R
     struct tm tm0, *tm = &tm0;
 #else
     struct tm *tm;
 #endif
-    char tbuf[TIMEFORMAT_LEN] = "";
-    int o_level = level;
 
-    if (!(level & l_level))
-        return;
-    init_mutex();
+    internal_log_init();
 
     nmem_mutex_enter(log_mutex);
-    ti = time(0);
+    
 #if HAVE_LOCALTIME_R
     localtime_r(&ti, tm);
 #else
     tm = localtime(&ti);
 #endif
+    
+    yaz_log_open_check(tm, 0, "a");  
+    file = yaz_log_file(); /* file may change in yaz_log_open_check */
 
-    yaz_log_open_check(tm, 0);
-
-    if (!l_file)
-        l_file = stderr;
-
-    *flags = '\0';
-    for (i = 0; level && mask_names[i].name; i++)
-        if ( mask_names[i].mask & level)
-        {
-            if (*mask_names[i].name && mask_names[i].mask && 
-                 mask_names[i].mask != YLOG_ALL)
+    if (file)
+    {
+        char tbuf[TIMEFORMAT_LEN];
+        char flags[1024];
+        int i;
+        
+        *flags = '\0';
+        for (i = 0; level && mask_names[i].name; i++)
+            if ( mask_names[i].mask & level)
             {
-                sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
-                level &= ~mask_names[i].mask;
+                if (*mask_names[i].name && mask_names[i].mask && 
+                    mask_names[i].mask != YLOG_ALL)
+                {
+                    sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
+                    level &= ~mask_names[i].mask;
+                }
             }
+       
+        tbuf[0] = '\0';
+        if (!(l_level & YLOG_NOTIME))
+        {
+            yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm);
+            tbuf[TIMEFORMAT_LEN-2] = '\0';
         }
+        if (tbuf[0])
+            strcat(tbuf, " ");
+        fprintf(file, "%s%s%s %s%s\n", tbuf, l_prefix, flags, l_prefix2,
+                log_message);
+        if (l_level & YLOG_FLUSH)
+            fflush(file);
+    }
+    nmem_mutex_leave(log_mutex);
+}
 
+void yaz_log(int level, const char *fmt, ...)
+{
+    va_list ap;
+    char buf[4096];
+    FILE *file;
+    int o_level = level;
+
+    internal_log_init();
+    if (!(level & l_level))
+        return;
     va_start(ap, fmt);
-#ifdef WIN32
-    _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
-#else
-/* !WIN32 */
-#if HAVE_VSNPRINTF
-    vsnprintf(buf, sizeof(buf), fmt, ap);
-#else
-    vsprintf(buf, fmt, ap);
-#endif
-#endif
-/* WIN32 */
+
+    yaz_vsnprintf(buf, sizeof(buf)-1, fmt, ap);
     if (o_level & YLOG_ERRNO)
     {
         strcat(buf, " [");
@@ -343,18 +484,13 @@ void yaz_log(int level, const char *fmt, ...)
     va_end (ap);
     if (start_hook_func)
         (*start_hook_func)(o_level, buf, start_hook_info);
-    if (l_level & YLOG_NOTIME)
-        tbuf[0] = '\0';
-    else
-        strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tm);
-    tbuf[TIMEFORMAT_LEN-1] = '\0';
-    fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
-            l_prefix2, buf);
-    if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
-        fflush(l_file);
+    if (hook_func)
+        (*hook_func)(o_level, buf, hook_info);
+    file = yaz_log_file();
+    if (file)
+        yaz_log_to_file(level, buf);
     if (end_hook_func)
         (*end_hook_func)(o_level, buf, end_hook_info);
-    nmem_mutex_leave(log_mutex);
 }
 
 void yaz_log_time_format(const char *fmt)
@@ -394,7 +530,7 @@ static char *clean_name(const char *name, int len, char *namebuf, int buflen)
 static int define_module_bit(const char *name)
 {
     int i;
-    init_mutex();
+
     nmem_mutex_enter(log_mutex);
     for (i = 0; mask_names[i].name; i++)
         if (0 == strcmp(mask_names[i].name, name))
@@ -402,7 +538,7 @@ static int define_module_bit(const char *name)
             nmem_mutex_leave(log_mutex);
             return mask_names[i].mask;
         }
-    if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
+    if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1<<31) ))
     {
         nmem_mutex_leave(log_mutex);
         yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
@@ -423,7 +559,7 @@ int yaz_log_module_level(const char *name)
     int i;
     char clean[255];
     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
-    init_mutex();
+    internal_log_init();
     
     nmem_mutex_enter(log_mutex);
     for (i = 0; mask_names[i].name; i++)
@@ -437,19 +573,21 @@ int yaz_log_module_level(const char *name)
         }
     nmem_mutex_leave(log_mutex);
     yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n, 
-                    strcmp(n, name) ? name : "" );
+            strcmp(n, name) ? name : "" );
     return 0;
 }
 
 int yaz_log_mask_str(const char *str)
 {
-    return yaz_log_mask_str_x(str, YLOG_DEFAULT_LEVEL);
+    internal_log_init(); /* since l_level may be affected */
+    return yaz_log_mask_str_x(str, l_level);
 }
 
 int yaz_log_mask_str_x(const char *str, int level)
 {
     const char *p;
 
+    internal_log_init();
     while (*str)
     {
         int negated = 0;
@@ -489,4 +627,3 @@ int yaz_log_mask_str_x(const char *str, int level)
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
-