aboutsummaryrefslogtreecommitdiffstats
path: root/Source/lib/utils/logger.c
diff options
context:
space:
mode:
Diffstat (limited to 'Source/lib/utils/logger.c')
-rw-r--r--Source/lib/utils/logger.c360
1 files changed, 360 insertions, 0 deletions
diff --git a/Source/lib/utils/logger.c b/Source/lib/utils/logger.c
new file mode 100644
index 000000000..c66de481e
--- /dev/null
+++ b/Source/lib/utils/logger.c
@@ -0,0 +1,360 @@
+/**
+ * @file logger.c
+ *
+ * @brief Implementation of logger_t.
+ *
+ */
+
+/*
+ * Copyright (C) 2005 Jan Hutter, Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * for more details.
+ */
+
+#include <syslog.h>
+#include <stdarg.h>
+#include <string.h>
+#include <stdio.h>
+#include <time.h>
+#include <pthread.h>
+
+#include "logger.h"
+
+#include <daemon.h>
+#include <utils/allocator.h>
+
+/**
+ * Maximum length of a log entry (only used for logger_s.log).
+ */
+#define MAX_LOG 8192
+
+
+typedef struct private_logger_t private_logger_t;
+
+/**
+ * @brief Private data of a logger_t object.
+ */
+struct private_logger_t {
+ /**
+ * Public data.
+ */
+ logger_t public;
+ /**
+ * Detail-level of logger.
+ */
+ log_level_t level;
+ /**
+ * Name of logger.
+ */
+ char *name;
+ /**
+ * File to write log output to.
+ * NULL for syslog.
+ */
+ FILE *output;
+
+ /**
+ * Should a thread_id be included in the log?
+ */
+ bool log_thread_id;
+
+ /**
+ * Applies a prefix to string and stores it in buffer.
+ *
+ * @warning: buffer must be at least have MAX_LOG size.
+ */
+ void (*prepend_prefix) (private_logger_t *this, log_level_t loglevel, char *string, char *buffer);
+};
+
+/**
+ * Implementation of private_logger_t.prepend_prefix.
+ */
+static void prepend_prefix(private_logger_t *this, log_level_t loglevel, char *string, char *buffer)
+{
+ char log_type, log_details;
+ if (loglevel & CONTROL)
+ {
+ log_type = '~';
+ }
+ else if (loglevel & ERROR)
+ {
+ log_type = '!';
+ }
+ else if (loglevel & RAW)
+ {
+ log_type = '#';
+ }
+ else if (loglevel & PRIVATE)
+ {
+ log_type = '?';
+ }
+ else if (loglevel & AUDIT)
+ {
+ log_type = '>';
+ }
+ else
+ {
+ log_type = '-';
+ }
+
+ if (loglevel & (LEVEL3 - LEVEL2))
+ {
+ log_details = '3';
+ }
+ else if (loglevel & (LEVEL2 - LEVEL1))
+ {
+ log_details = '2';
+ }
+ else if (loglevel & LEVEL1)
+ {
+ log_details = '1';
+ }
+ else
+ {
+ log_details = '0';
+ }
+
+ if (this->log_thread_id)
+ {
+ snprintf(buffer, MAX_LOG, "[%c%c] [%s] @%u %s", log_type, log_details, this->name, (int)pthread_self(), string);
+ }
+ else
+ {
+ snprintf(buffer, MAX_LOG, "[%c%c] [%s] %s", log_type, log_details, this->name, string);
+ }
+}
+
+/**
+ * Implementation of logger_t.log.
+ *
+ * Yes, logg is wrong written :-).
+ */
+static void logg(private_logger_t *this, log_level_t loglevel, char *format, ...)
+{
+ if ((this->level & loglevel) == loglevel)
+ {
+ char buffer[MAX_LOG];
+ va_list args;
+
+
+ if (this->output == NULL)
+ {
+ /* syslog */
+ this->prepend_prefix(this, loglevel, format, buffer);
+ va_start(args, format);
+ vsyslog(LOG_INFO, buffer, args);
+ va_end(args);
+ }
+ else
+ {
+ /* File output */
+ this->prepend_prefix(this, loglevel, format, buffer);
+ va_start(args, format);
+ vfprintf(this->output, buffer, args);
+ va_end(args);
+ fprintf(this->output, "\n");
+ }
+
+ }
+}
+
+/**
+ * Implementation of logger_t.log_bytes.
+ */
+static void log_bytes(private_logger_t *this, log_level_t loglevel, char *label, char *bytes, size_t len)
+{
+ static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
+
+
+ if ((this->level & loglevel) == loglevel)
+ {
+ char buffer[MAX_LOG];
+ char ascii_buffer[17];
+ char *format;
+ char *buffer_pos;
+ char *bytes_pos, *bytes_roof;
+ int i;
+ int line_start = 0;
+
+ /* since me can't do multi-line output to syslog,
+ * we must do multiple syslogs. To avoid
+ * problems in output order, lock this by a mutex.
+ */
+ pthread_mutex_lock(&mutex);
+
+
+ format = "%s (%d bytes @%p)";
+ this->prepend_prefix(this, loglevel, format, buffer);
+
+ if (this->output == NULL)
+ {
+ syslog(LOG_INFO, buffer, label, len);
+ }
+ else
+ {
+ fprintf(this->output, buffer, label, len, bytes);
+ fprintf(this->output, "\n");
+ }
+
+ bytes_pos = bytes;
+ bytes_roof = bytes + len;
+ buffer_pos = buffer;
+ memset(ascii_buffer, 0, 17);
+
+ for (i = 1; bytes_pos < bytes_roof; i++)
+ {
+ static char hexdig[] = "0123456789ABCDEF";
+ *buffer_pos++ = hexdig[(*bytes_pos >> 4) & 0xF];
+ *buffer_pos++ = hexdig[ *bytes_pos & 0xF];
+ if ((i % 16) == 0)
+ {
+ *buffer_pos++ = '\0';
+ buffer_pos = buffer;
+ if (this->output == NULL)
+ {
+ syslog(LOG_INFO, "[=>] [%5d ] %s %s", line_start, buffer, ascii_buffer);
+ }
+ else
+ {
+ fprintf(this->output, "[=>] [%5d ] %s %s\n", line_start, buffer, ascii_buffer);
+ }
+ memset(ascii_buffer, 0, 16);
+ line_start += 16;
+ }
+ else if ((i % 4) == 0)
+ {
+ *buffer_pos++ = ' ';
+ // *buffer_pos++ = ' ';
+ }
+ else
+ {
+ *buffer_pos++ = ' ';
+ }
+
+ if (*bytes_pos > 31 && *bytes_pos < 127)
+ {
+ ascii_buffer[(i % 16)] = *bytes_pos;
+ }
+ else
+ {
+ ascii_buffer[(i % 16)] = '*';
+ }
+
+ bytes_pos++;
+ }
+
+ *buffer_pos++ = '\0';
+ if (buffer_pos > buffer + 1)
+ {
+ buffer_pos = buffer;
+ if (this->output == NULL)
+ {
+ syslog(LOG_INFO, "[=>] [%5d ] %s %16s", line_start, buffer, ascii_buffer);
+ }
+ else
+ {
+ fprintf(this->output, "[=>] [%5d ] %s %16s\n", line_start, buffer, ascii_buffer);
+ }
+ }
+ pthread_mutex_unlock(&mutex);
+ }
+}
+
+/**
+ * Implementation of logger_t.log_chunk.
+ */
+static void log_chunk(logger_t *this, log_level_t loglevel, char *label, chunk_t chunk)
+{
+ this->log_bytes(this, loglevel, label, chunk.ptr, chunk.len);
+}
+
+/**
+ * Implementation of logger_t.enable_level.
+ */
+static void enable_level(private_logger_t *this, log_level_t log_level)
+{
+ this->level |= log_level;
+}
+
+/**
+ * Implementation of logger_t.disable_level.
+ */
+static void disable_level(private_logger_t *this, log_level_t log_level)
+{
+ this->level &= ~log_level;
+}
+
+/**
+ * Implementation of logger_t.set_output.
+ */
+static void set_output(private_logger_t *this, FILE * output)
+{
+ this->output = output;
+}
+
+/**
+ * Implementation of logger_t.get_level.
+ */
+static log_level_t get_level(private_logger_t *this)
+{
+ return this->level;
+}
+
+/**
+ * Implementation of logger_t.destroy.
+ */
+static void destroy(private_logger_t *this)
+{
+ allocator_free(this->name);
+ allocator_free(this);
+}
+
+/*
+ * Described in header.
+ */
+logger_t *logger_create(char *logger_name, log_level_t log_level, bool log_thread_id, FILE * output)
+{
+ private_logger_t *this = allocator_alloc_thing(private_logger_t);
+
+ /* public functions */
+ this->public.log = (void(*)(logger_t*,log_level_t,char*,...))logg;
+ this->public.log_bytes = (void(*)(logger_t*, log_level_t, char*,char*,size_t))log_bytes;
+ this->public.log_chunk = log_chunk;
+ this->public.enable_level = (void(*)(logger_t*,log_level_t))enable_level;
+ this->public.disable_level = (void(*)(logger_t*,log_level_t))disable_level;
+ this->public.get_level = (log_level_t(*)(logger_t*))get_level;
+ this->public.set_output = (void(*)(logger_t*,FILE*))set_output;
+ this->public.destroy = (void(*)(logger_t*))destroy;
+
+ /* private functions */
+ this->prepend_prefix = prepend_prefix;
+
+ if (logger_name == NULL)
+ {
+ logger_name = "";
+ }
+
+ /* private variables */
+ this->level = log_level;
+ this->log_thread_id = log_thread_id;
+ this->name = allocator_alloc(strlen(logger_name) + 1);
+
+ strcpy(this->name,logger_name);
+ this->output = output;
+
+ if (output == NULL)
+ {
+ openlog(DAEMON_NAME, 0, LOG_DAEMON);
+ }
+
+ return (logger_t*)this;
+}