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
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
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
-#include "silcincludes.h"
-
-/* Minimum time delay for log flushing calls (in seconds) */
-#define SILC_LOG_FLUSH_MIN_DELAY 2
-
-/* nice macro for looping through all logs -- makes the code more readable */
-#define SILC_FOREACH_LOG(__x__) for (__x__ = 0; __x__ < SILC_LOG_MAX; __x__++)
-
-/* Our working struct -- at the moment we keep it private, but this could
- * change in the future */
-struct SilcLogStruct {
+#include "silc.h"
+
+/* SilcLogSettings context */
+typedef struct {
+ SilcUInt32 flushdelay;
+
+ char debug_string[128];
+ SilcLogDebugCb debug_cb;
+ void *debug_context;
+ SilcLogHexdumpCb hexdump_cb;
+ void *hexdump_context;
+
+ unsigned int timestamp : 1;
+ unsigned int quick : 1;
+ unsigned int debug : 1;
+ unsigned int debug_hexdump : 1;
+ unsigned int scheduled : 1;
+ unsigned int no_init : 1;
+ unsigned int starting : 1;
+} *SilcLogSettings, SilcLogSettingsStruct;
+
+/* SilcLog context */
+typedef struct {
-/* These are the known logging channels. We initialize this struct with most
- * of the fields set to NULL, because we'll fill in those values at runtime. */
-static struct SilcLogStruct silclogs[SILC_LOG_MAX] = {
+#endif /* !SILC_SYMBIAN */
+
+/* Default log contexts */
+#ifndef SILC_SYMBIAN
+static SilcLogStruct silclogs[4] =
+#else
+const SilcLogStruct silclogs[4] =
+#endif /* !SILC_SYMBIAN */
+{
{"", NULL, 0, "Info", SILC_LOG_INFO, NULL, NULL},
{"", NULL, 0, "Warning", SILC_LOG_WARNING, NULL, NULL},
{"", NULL, 0, "Error", SILC_LOG_ERROR, NULL, NULL},
{"", NULL, 0, "Fatal", SILC_LOG_FATAL, NULL, NULL},
};
{"", NULL, 0, "Info", SILC_LOG_INFO, NULL, NULL},
{"", NULL, 0, "Warning", SILC_LOG_WARNING, NULL, NULL},
{"", NULL, 0, "Error", SILC_LOG_ERROR, NULL, NULL},
{"", NULL, 0, "Fatal", SILC_LOG_FATAL, NULL, NULL},
};
-/* Causes logging output to contain timestamps */
-bool silc_log_timestamp = TRUE;
-
-/* If TRUE, log files will be flushed for each log input */
-bool silc_log_quick = FALSE;
-
-/* Set TRUE/FALSE to enable/disable debugging */
-bool silc_debug = FALSE;
-bool silc_debug_hexdump = FALSE;
-
-/* Flush delay (in seconds) */
-long silc_log_flushdelay = 300;
-
-/* Regular pattern matching expression for the debug output */
-char silc_log_debug_string[128];
+/* Return log context by type */
-/* Debug callbacks. If set, these are triggered for each specific output. */
-static SilcLogDebugCb silc_log_debug_cb = NULL;
-static void *silc_log_debug_context = NULL;
-static SilcLogHexdumpCb silc_log_hexdump_cb = NULL;
-static void *silc_log_hexdump_context = NULL;
-
-/* Did we register already our functions to the scheduler? */
-static bool silc_log_scheduled = FALSE;
-static bool silc_log_no_init = FALSE;
-
-/* This is only needed during starting up -- don't lose any logging message */
-static bool silc_log_starting = TRUE;
-
-/* The type wrapper utility. Translates a SilcLogType id to the corresponding
- * logfile, or NULL if not found. */
-static SilcLog silc_log_find_by_type(SilcLogType type)
+static SilcLog silc_log_get_context(SilcLogType type)
- /* this is not really needed, but i think it's more secure */
- switch (type) {
- case SILC_LOG_INFO:
- return &silclogs[SILC_LOG_INFO];
- case SILC_LOG_WARNING:
- return &silclogs[SILC_LOG_WARNING];
- case SILC_LOG_ERROR:
- return &silclogs[SILC_LOG_ERROR];
- case SILC_LOG_FATAL:
- return &silclogs[SILC_LOG_FATAL];
- default:
- return NULL;
- }
- return NULL;
+ if (type < 1 || type > 4)
+ return NULL;
+ return (SilcLog)&silclogs[(int)type - 1];
- return; /* we are not interested */
-
- if ((size = ftell(log->fp)) < 0) {
- /* OMG, EBADF is here.. we'll try our best.. */
- FILE *oldfp = log->fp;
- fclose(oldfp); /* we can discard the error */
- log->fp = NULL; /* make sure we don't get here recursively */
- SILC_LOG_ERROR(("Error while checking size of the log file %s, fp=%p",
- log->filename, oldfp));
- /* It's too big */
- fprintf(log->fp, "[%s] [%s] Cycling log file, over max "
- "logsize (%lu kilobytes)\n",
- silc_get_time(0), log->typename, log->maxsize / 1024);
+ /* Cycle log file */
+ fprintf(log->fp,
+ "[%s] [%s] Cycling log file, over max log size (%lu kilobytes)\n",
+ silc_time_string(0), log->typename,
+ (unsigned long)log->maxsize / 1024);
- snprintf(newname, sizeof(newname) - 1, "%s.old", log->filename);
+ silc_snprintf(newname, sizeof(newname) - 1, "%s.old", log->filename);
- if (!(log->fp = fopen(log->filename, "w")))
- SILC_LOG_WARNING(("Couldn't reopen logfile %s for type \"%s\": %s",
- log->filename, log->typename, strerror(errno)));
-}
-
-/* Reset a logging channel (close and reopen) */
-static bool silc_log_reset(SilcLog log)
-{
- if (!log) return FALSE;
- if (log->fp) {
- fflush(log->fp);
- fclose(log->fp);
- }
- if (!log->filename[0]) return FALSE;
- if (!(log->fp = fopen(log->filename, "a+"))) {
- SILC_LOG_WARNING(("Couldn't reset logfile %s for type \"%s\": %s",
+ log->fp = fopen(log->filename, "w");
+ if (!log->fp)
+ SILC_LOG_WARNING(("Couldn't reopen log file '%s' for type '%s': %s",
}
/* Internal timeout callback to flush log channels and check file sizes */
SILC_TASK_CALLBACK(silc_log_fflush_callback)
{
}
/* Internal timeout callback to flush log channels and check file sizes */
SILC_TASK_CALLBACK(silc_log_fflush_callback)
{
- SILC_FOREACH_LOG(u)
- silc_log_checksize(&silclogs[u]);
+ log = silc_log_get_context(SILC_LOG_INFO);
+ silc_log_checksize(log);
+ log = silc_log_get_context(SILC_LOG_WARNING);
+ silc_log_checksize(log);
+ log = silc_log_get_context(SILC_LOG_ERROR);
+ silc_log_checksize(log);
+ log = silc_log_get_context(SILC_LOG_FATAL);
+ silc_log_checksize(log);
- silc_log_starting = FALSE;
- if (silc_log_flushdelay < SILC_LOG_FLUSH_MIN_DELAY)
- silc_log_flushdelay = SILC_LOG_FLUSH_MIN_DELAY;
- silc_schedule_task_add((SilcSchedule) context, 0, silc_log_fflush_callback,
- context, silc_log_flushdelay, 0, SILC_TASK_TIMEOUT,
- SILC_TASK_PRI_NORMAL);
+
+ silclog.starting = FALSE;
+
+ if (silclog.flushdelay < 2)
+ silclog.flushdelay = 2;
+ silc_schedule_task_add_timeout(context, silc_log_fflush_callback, context,
+ silclog.flushdelay, 0);
+#endif /* !SILC_SYMBIAN */
-/* Outputs the log message to the first available channel. Channels are
- * ordered by importance (see SilcLogType documentation).
- * More important channels can be printed on less important ones, but not
- * vice-versa. */
+/* Output log message to log file */
void silc_log_output(SilcLogType type, char *string)
{
const char *typename = NULL;
void silc_log_output(SilcLogType type, char *string)
{
const char *typename = NULL;
- /* Save the original typename, because even if we redirect the message
- * to another channel we'll keep however the original channel name */
- typename = log->typename;
-
- /* If there is a custom callback set, use it and return. */
- if (log->cb) {
+ /* Forward to callback if set */
+ if (log->cb)
- if (!silc_log_scheduled) {
- if (silc_log_no_init == FALSE) {
+ typename = log->typename;
+
+#ifndef SILC_SYMBIAN
+ if (!silclog.scheduled) {
+ if (silclog.no_init == FALSE) {
- /* ok, now we have to find an open stream */
- while (TRUE) {
- if (log && (fp = log->fp)) goto found;
- if (type == 0) break;
- log = silc_log_find_by_type(--type);
- }
+ /* Find open log file */
+ while (log) {
+ if (log->fp) {
+ fp = log->fp;
+ break;
+ }
- /* writes the logging string to the selected channel */
- if (silc_log_timestamp)
- fprintf(fp, "[%s] [%s] %s\n", silc_get_time(0), typename, string);
+ if (silclog.timestamp)
+ fprintf(fp, "[%s] [%s] %s\n", silc_time_string(0), typename, string);
else
fprintf(fp, "[%s] %s\n", typename, string);
else
fprintf(fp, "[%s] %s\n", typename, string);
- /* If debugging, also output the logging message to the console */
- if (typename && silc_debug) {
+#ifndef SILC_SYMBIAN
+ /* Output log to stderr if debugging */
+ if (typename && silclog.debug) {
fprintf(stderr, "[Logging] [%s] %s\n", typename, string);
fflush(stderr);
}
fprintf(stderr, "[Logging] [%s] %s\n", typename, string);
fflush(stderr);
}
-/* returns an internally allocated pointer to a logging channel file */
-char *silc_log_get_file(SilcLogType type)
-{
- SilcLog log;
-
- if (!(log = silc_log_find_by_type(type)))
- return NULL;
- if (log->fp)
- return log->filename;
- return NULL;
-}
+/* Set and initialize the specified log file. */
-/* Set and initialize the specified logging channel. See the API reference */
-bool silc_log_set_file(SilcLogType type, char *filename, SilcUInt32 maxsize,
- SilcSchedule scheduler)
+SilcBool silc_log_set_file(SilcLogType type, char *filename,
+ SilcUInt32 maxsize, SilcSchedule scheduler)
- if (!(fp = fopen(filename, "a+"))) {
- fprintf(stderr, "warning: couldn't open log file %s: %s\n",
+ fp = fopen(filename, "a+");
+ if (!fp) {
+ fprintf(stderr, "warning: couldn't open log file '%s': %s\n",
- memset(log->filename, 0, sizeof(log->filename));
- strncpy(log->filename, filename,
- strlen(filename) < sizeof(log->filename) ? strlen(filename) :
- sizeof(log->filename) - 1);
+
+ memset(log->filename, 0, sizeof(log->filename));
+ silc_strncat(log->filename, sizeof(log->filename), filename,
+ strlen(filename));
- if (silc_log_scheduled)
- return TRUE;
-
- /* Add schedule hook with a short delay to make sure we'll use
- right delay */
- silc_schedule_task_add(scheduler, 0, silc_log_fflush_callback,
- (void *) scheduler, 10, 0,
- SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
- silc_log_scheduled = TRUE;
+ silc_schedule_task_del_by_callback(scheduler, silc_log_fflush_callback);
+ silc_schedule_task_add_timeout(scheduler, silc_log_fflush_callback,
+ scheduler, 10, 0);
+ silclog.scheduled = TRUE;
/* Sets a log callback, set callback to NULL to return to default behaviour */
void silc_log_set_callback(SilcLogType type, SilcLogCb cb, void *context)
{
/* Sets a log callback, set callback to NULL to return to default behaviour */
void silc_log_set_callback(SilcLogType type, SilcLogCb cb, void *context)
{
- log->cb = cb;
- log->context = context;
+void silc_log_reset_callbacks(void)
+{
+#ifndef SILC_SYMBIAN
+ SilcLog log;
+ log = silc_log_get_context(SILC_LOG_INFO);
+ log->cb = log->context = NULL;
+ log = silc_log_get_context(SILC_LOG_WARNING);
+ log->cb = log->context = NULL;
+ log = silc_log_get_context(SILC_LOG_ERROR);
+ log->cb = log->context = NULL;
+ log = silc_log_get_context(SILC_LOG_FATAL);
+ log->cb = log->context = NULL;
+#endif /* !SILC_SYMBIAN */
- unsigned int u;
- SILC_FOREACH_LOG(u) {
- silclogs[u].cb = NULL;
- silclogs[u].context = NULL;
- }
+ SilcLog log;
+ log = silc_log_get_context(SILC_LOG_INFO);
+ if (log->fp)
+ fflush(log->fp);
+ log = silc_log_get_context(SILC_LOG_WARNING);
+ if (log->fp)
+ fflush(log->fp);
+ log = silc_log_get_context(SILC_LOG_ERROR);
+ if (log->fp)
+ fflush(log->fp);
+ log = silc_log_get_context(SILC_LOG_FATAL);
+ if (log->fp)
+ fflush(log->fp);
+
+ if (!strlen(log->filename))
+ return;
+
+ log->fp = fopen(log->filename, "a+");
+ if (!log->fp)
+ SILC_LOG_WARNING(("Couldn't reset log file '%s' for type '%s': %s",
+ log->filename, log->typename, strerror(errno)));
-void silc_log_reset_all() {
- unsigned int u;
- SILC_LOG_DEBUG(("Resetting all logs"));
- SILC_FOREACH_LOG(u)
- silc_log_reset(&silclogs[u]);
- /* Immediately flush any possible warning message */
+void silc_log_reset_all(void)
+{
+ SilcLog log;
+ log = silc_log_get_context(SILC_LOG_INFO);
+ if (log->fp)
+ silc_log_reset(log);
+ log = silc_log_get_context(SILC_LOG_WARNING);
+ if (log->fp)
+ silc_log_reset(log);
+ log = silc_log_get_context(SILC_LOG_ERROR);
+ if (log->fp)
+ silc_log_reset(log);
+ log = silc_log_get_context(SILC_LOG_FATAL);
+ if (log->fp)
+ silc_log_reset(log);
-void silc_log_output_debug(char *file, char *function,
- int line, char *string)
+void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
+ void *debug_context,
+ SilcLogHexdumpCb hexdump_cb,
+ void *hexdump_context)
- if (!silc_debug)
- goto end;
+#ifndef SILC_SYMBIAN
+ silclog.debug_cb = debug_cb;
+ silclog.debug_context = debug_context;
+ silclog.hexdump_cb = hexdump_cb;
+ silclog.hexdump_context = hexdump_context;
+#endif /* !SILC_SYMBIAN */
+}
- if (silc_log_debug_string &&
- !silc_string_regex_match(silc_log_debug_string, file) &&
- !silc_string_regex_match(silc_log_debug_string, function))
- goto end;
+/* Resets debug callbacks */
- if (silc_log_debug_cb) {
- if ((*silc_log_debug_cb)(file, function, line, string,
- silc_log_debug_context))
- goto end;
- }
+void silc_log_reset_debug_callbacks()
+{
+#ifndef SILC_SYMBIAN
+ silclog.debug_cb = NULL;
+ silclog.debug_context = NULL;
+ silclog.hexdump_cb = NULL;
+ silclog.hexdump_context = NULL;
+#endif /* !SILC_SYMBIAN */
+}
+void silc_log_set_debug_string(const char *debug_string)
+{
+#ifndef SILC_SYMBIAN
+ char *string;
+ int len;
+ if ((strchr(debug_string, '(') && strchr(debug_string, ')')) ||
+ strchr(debug_string, '$'))
+ string = silc_strdup(debug_string);
+ else
+ string = silc_string_regexify(debug_string);
+ len = strlen(string);
+ if (len >= sizeof(silclog.debug_string))
+ len = sizeof(silclog.debug_string) - 1;
+ memset(silclog.debug_string, 0, sizeof(silclog.debug_string));
+ strncpy(silclog.debug_string, string, len);
-void silc_log_output_hexdump(char *file, char *function,
- int line, void *data_in,
- SilcUInt32 len, char *string)
+void silc_log_timestamp(SilcBool enable)
- if (silc_log_hexdump_cb) {
- if ((*silc_log_hexdump_cb)(file, function, line, data_in, len, string,
- silc_log_hexdump_context))
- goto end;
- }
+void silc_log_flushdelay(SilcUInt32 flushdelay)
+{
+#ifndef SILC_SYMBIAN
+ silclog.flushdelay = flushdelay;
+#endif /* !SILC_SYMBIAN */
+}
- for (i = 0; i < count; i++) {
- fprintf(stderr, "%02X ", data[pos + i]);
+void silc_log_debug(SilcBool enable)
+{
+#ifndef SILC_SYMBIAN
+ silclog.debug = enable;
+#endif /* !SILC_SYMBIAN */
+}
- if ((j + count + 1) % 4 == 0)
- fprintf(stderr, " ");
- }
- }
+void silc_log_output_debug(char *file, const char *function,
+ int line, char *string)
+{
+ SilcTimeStruct curtime;
- fprintf(stderr, "%c", ch);
- pos++;
- }
+ if (silclog.debug_cb) {
+ if ((*silclog.debug_cb)(file, (char *)function, line, string,
+ silclog.debug_context))
+ goto end;
+ }
+#endif /* !SILC_SYMBIAN */
- if (count < 16)
- break;
- }
+#ifdef SILC_WIN32
+ if (strrchr(function, '\\'))
+ fprintf(stderr, "%s:%d: %s\n", strrchr(function, '\\') + 1, line, string);
+ else
+#endif /* SILC_WIN32 */
+#ifdef SILC_SYMBIAN
+ silc_symbian_debug(function, line, string);
+#else
+ fprintf(stderr, "%02d:%02d:%02d %s:%d: %s\n", curtime.hour,
+ curtime.minute, curtime.second, function, line,
+ string);
+ fflush(stderr);
+#endif /* SILC_SYMBIAN */
-void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
- void *debug_context,
- SilcLogHexdumpCb hexdump_cb,
- void *hexdump_context)
+void silc_log_output_hexdump(char *file, const char *function,
+ int line, void *data_in,
+ SilcUInt32 len, char *string)
- silc_log_debug_cb = debug_cb;
- silc_log_debug_context = debug_context;
- silc_log_hexdump_cb = hexdump_cb;
- silc_log_hexdump_context = hexdump_context;
-}
+#ifndef SILC_SYMBIAN
+ if (!silclog.debug_hexdump)
+ goto end;
-void silc_log_reset_debug_callbacks()
-{
- silc_log_debug_cb = NULL;
- silc_log_debug_context = NULL;
- silc_log_hexdump_cb = NULL;
- silc_log_hexdump_context = NULL;
-}
+ if (silclog.hexdump_cb) {
+ if ((*silclog.hexdump_cb)(file, (char *)function, line,
+ data_in, len, string, silclog.hexdump_context))
+ goto end;
+ }
+#endif /* !SILC_SYMBIAN */
-void silc_log_set_debug_string(const char *debug_string)
-{
- char *string;
- int len;
- if ((strchr(debug_string, '(') && strchr(debug_string, ')')) ||
- strchr(debug_string, '$'))
- string = strdup(debug_string);
- else
- string = silc_string_regexify(debug_string);
- len = strlen(string);
- if (len >= sizeof(silc_log_debug_string))
- len = sizeof(silc_log_debug_string) - 1;
- memset(silc_log_debug_string, 0, sizeof(silc_log_debug_string));
- strncpy(silc_log_debug_string, string, len);
+ silc_hexdump(data_in, len, stderr);
+
+ end: