/* fe-log.c : irssi Copyright (C) 1999-2000 Timo Sirainen 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. 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. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "module.h" #include "module-formats.h" #include "signals.h" #include "commands.h" #include "server.h" #include "levels.h" #include "misc.h" #include "log.h" #include "special-vars.h" #include "settings.h" #include "windows.h" #include "window-items.h" /* close autologs after 5 minutes of inactivity */ #define AUTOLOG_INACTIVITY_CLOSE (60*5) #define LOG_DIR_CREATE_MODE 0770 static int autolog_level; static int autoremove_tag; static const char *autolog_path; static void cmd_log_open(const char *data) { /* /LOG OPEN [-noopen] [-autoopen] [-targets ] [-window] [-rotate hour|day|week|month] [] */ GHashTable *optlist; char *targetarg, *rotatearg, *fname, *levels; void *free_arg; char window[MAX_INT_STRLEN]; LOG_REC *log; int level, rotate; if (!cmd_get_params(data, &free_arg, 2 | PARAM_FLAG_OPTIONS | PARAM_FLAG_GETREST, "log open", &optlist, &fname, &levels)) return; targetarg = g_hash_table_lookup(optlist, "targets"); rotatearg = g_hash_table_lookup(optlist, "rotate"); if (*fname == '\0') cmd_param_error(CMDERR_NOT_ENOUGH_PARAMS); rotate = LOG_ROTATE_NEVER; if (rotatearg != NULL) { rotate = log_str2rotate(rotatearg); if (rotate < 0) rotate = LOG_ROTATE_NEVER; } level = level2bits(levels); if (level == 0) level = MSGLEVEL_ALL; if (g_hash_table_lookup(optlist, "window")) { /* log by window ref# */ ltoa(window, active_win->refnum); targetarg = window; } log = log_create_rec(fname, level, targetarg); if (log != NULL) { if (g_hash_table_lookup(optlist, "autoopen")) log->autoopen = TRUE; log->rotate = rotate; log_update(log); if (log->handle == -1 && g_hash_table_lookup(optlist, "noopen") == NULL) { /* start logging */ if (log_start_logging(log)) { printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_OPENED, fname); } else { log_close(log); } } } cmd_params_free(free_arg); } static LOG_REC *log_find_from_data(const char *data) { GSList *tmp; if (!is_numeric(data, ' ')) return log_find(data); /* with index number */ tmp = g_slist_nth(logs, atoi(data)-1); return tmp == NULL ? NULL : tmp->data; } static void cmd_log_close(const char *data) { LOG_REC *log; log = log_find_from_data(data); if (log == NULL) printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, IRCTXT_LOG_NOT_OPEN, data); else { log_close(log); printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_CLOSED, data); } } static void cmd_log_start(const char *data) { LOG_REC *log; log = log_find_from_data(data); if (log != NULL) { log_start_logging(log); printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_OPENED, data); } } static void cmd_log_stop(const char *data) { LOG_REC *log; log = log_find_from_data(data); if (log == NULL || log->handle == -1) printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, IRCTXT_LOG_NOT_OPEN, data); else { log_stop_logging(log); printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_CLOSED, data); } } static void cmd_log_list(void) { GSList *tmp; char *levelstr, *items, *rotate; int index; printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, IRCTXT_LOG_LIST_HEADER); for (tmp = logs, index = 1; tmp != NULL; tmp = tmp->next, index++) { LOG_REC *rec = tmp->data; levelstr = bits2level(rec->level); items = rec->items == NULL ? NULL : g_strjoinv(",", rec->items); rotate = rec->rotate == 0 ? NULL : g_strdup_printf(" -rotate %s", log_rotate2str(rec->rotate)); printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, IRCTXT_LOG_LIST, index, rec->fname, items != NULL ? items : "", levelstr, rotate != NULL ? rotate : "", rec->autoopen ? " -autoopen" : ""); g_free_not_null(rotate); g_free_not_null(items); g_free(levelstr); } printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, IRCTXT_LOG_LIST_FOOTER); } static void cmd_log(const char *data, SERVER_REC *server, void *item) { if (*data == '\0') cmd_log_list(); else command_runsub("log", data, server, item); } static LOG_REC *log_find_item(const char *item) { GSList *tmp; for (tmp = logs; tmp != NULL; tmp = tmp->next) { LOG_REC *rec = tmp->data; if (rec->items != NULL && strarray_find(rec->items, item) != -1) return rec; } return NULL; } static void cmd_window_log(const char *data) { /* /WINDOW LOG ON|OFF|TOGGLE [] */ LOG_REC *log; char *set, *fname, window[MAX_INT_STRLEN]; void *free_arg; int open_log, close_log; if (!cmd_get_params(data, &free_arg, 2, &set, &fname)) return; ltoa(window, active_win->refnum); log = log_find_item(window); open_log = close_log = FALSE; if (g_strcasecmp(set, "ON") == 0) open_log = TRUE; else if (g_strcasecmp(set, "OFF") == 0) { close_log = TRUE; } else if (g_strcasecmp(set, "TOGGLE") == 0) { open_log = log == NULL; close_log = log != NULL; } else { printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_NOT_TOGGLE); cmd_params_free(free_arg); return; } if (open_log && log == NULL) { /* irc.log. or irc.log.Window */ fname = *fname != '\0' ? g_strdup(fname) : g_strdup_printf("~/irc.log.%s%s", active_win->name != NULL ? active_win->name : "Window", active_win->name != NULL ? "" : window); log = log_create_rec(fname, MSGLEVEL_ALL, window); if (log != NULL) log_update(log); g_free(fname); } if (open_log && log != NULL) { log_start_logging(log); printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_OPENED, log->fname); } else if (close_log && log != NULL && log->handle != -1) { log_stop_logging(log); printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_CLOSED, log->fname); } cmd_params_free(free_arg); } /* Create log file entry to window, but don't start logging */ static void cmd_window_logfile(const char *data) { LOG_REC *log; char window[MAX_INT_STRLEN]; ltoa(window, active_win->refnum); log = log_find_item(window); if (log != NULL) { printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_WINDOWLOG_FILE_LOGGING); return; } log = log_create_rec(data, MSGLEVEL_ALL, window); if (log == NULL) printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_WINDOWLOG_FILE, data); else log_update(log); } /* window's refnum changed - update the logs to log the new window refnum */ static void sig_window_refnum_changed(WINDOW_REC *window, gpointer old_refnum) { char winnum[MAX_INT_STRLEN]; LOG_REC *log; ltoa(winnum, GPOINTER_TO_INT(old_refnum)); log = log_find_item(winnum); if (log != NULL) { ltoa(winnum, window->refnum); g_strfreev(log->items); log->items = g_strsplit(winnum, " ", -1); } } static void autologs_close_all(void) { GSList *tmp, *next; for (tmp = logs; tmp != NULL; tmp = next) { LOG_REC *rec = tmp->data; next = tmp->next; if (rec->temp) log_close(rec); } } static void autolog_log(void *server, const char *target) { LOG_REC *log; char *fname, *dir, *str; log = log_find_item(target); if (log != NULL) { log_start_logging(log); return; } fname = parse_special_string(autolog_path, server, NULL, target, NULL); if (log_find(fname) == NULL) { str = convert_home(fname); dir = g_dirname(str); g_free(str); mkdir(dir, LOG_DIR_CREATE_MODE); g_free(dir); log = log_create_rec(fname, autolog_level, target); if (log != NULL) { log->temp = TRUE; log_update(log); log_start_logging(log); } } g_free(fname); } static void sig_printtext_stripped(WINDOW_REC *window, void *server, const char *target, gpointer levelp, const char *text) { char windownum[MAX_INT_STRLEN]; LOG_REC *log; int level; level = GPOINTER_TO_INT(levelp); if (level == MSGLEVEL_NEVER) return; /* let autolog create the log records */ if ((autolog_level & level) && target != NULL && *target != '\0') autolog_log(server, target); /* save to log created with /WINDOW LOG */ ltoa(windownum, window->refnum); log = log_find_item(windownum); if (log != NULL) log_write_rec(log, text); } static int sig_autoremove(void) { GSList *tmp, *next; time_t removetime; removetime = time(NULL)-AUTOLOG_INACTIVITY_CLOSE; for (tmp = logs; tmp != NULL; tmp = next) { LOG_REC *rec = tmp->data; next = tmp->next; /* FIXME: here is a small kludge - We don't want autolog to automatically close the logs with channels, only with private messages. However, this is CORE module and we don't know how to figure out if item is a channel or not, so just assume that channels are everything that don't start with alphanumeric character. */ if (!rec->temp || rec->last > removetime || rec->items == NULL || !isalnum(**rec->items)) continue; log_close(rec); } return 1; } static void sig_window_item_remove(WINDOW_REC *window, WI_ITEM_REC *item) { GSList *tmp; for (tmp = logs; tmp != NULL; tmp = tmp->next) { LOG_REC *rec = tmp->data; if (rec->temp && rec->items != NULL && g_strcasecmp(rec->items[0], item->name) == 0) { log_close(rec); break; } } } static void sig_log_locked(LOG_REC *log) { printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_LOCKED, log->fname); } static void sig_log_create_failed(LOG_REC *log) { printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_CREATE_FAILED, log->fname, g_strerror(errno)); } static void sig_awaylog_show(LOG_REC *log, gpointer pmsgs, gpointer pfilepos) { char *str; int msgs, filepos; msgs = GPOINTER_TO_INT(pmsgs); filepos = GPOINTER_TO_INT(pfilepos); if (msgs == 0) printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_NO_AWAY_MSGS, log->fname); else { printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, IRCTXT_LOG_AWAY_MSGS, log->fname, msgs); str = g_strdup_printf("\"%s\" %d", log->fname, filepos); signal_emit("command cat", 1, str); g_free(str); } } static void read_settings(void) { int old_autolog = autolog_level; autolog_path = settings_get_str("autolog_path"); autolog_level = !settings_get_bool("autolog") ? 0 : level2bits(settings_get_str("autolog_level")); if (old_autolog && !autolog_level) autologs_close_all(); } void fe_log_init(void) { autoremove_tag = g_timeout_add(60000, (GSourceFunc) sig_autoremove, NULL); settings_add_str("log", "autolog_path", "~/irclogs/$tag/$0.log"); settings_add_str("log", "autolog_level", "all"); settings_add_bool("log", "autolog", FALSE); autolog_level = 0; read_settings(); command_bind("log", NULL, (SIGNAL_FUNC) cmd_log); command_bind("log open", NULL, (SIGNAL_FUNC) cmd_log_open); command_bind("log close", NULL, (SIGNAL_FUNC) cmd_log_close); command_bind("log start", NULL, (SIGNAL_FUNC) cmd_log_start); command_bind("log stop", NULL, (SIGNAL_FUNC) cmd_log_stop); command_bind("window log", NULL, (SIGNAL_FUNC) cmd_window_log); command_bind("window logfile", NULL, (SIGNAL_FUNC) cmd_window_logfile); signal_add_first("print text stripped", (SIGNAL_FUNC) sig_printtext_stripped); signal_add("window item remove", (SIGNAL_FUNC) sig_window_item_remove); signal_add("window refnum changed", (SIGNAL_FUNC) sig_window_refnum_changed); signal_add("log locked", (SIGNAL_FUNC) sig_log_locked); signal_add("log create failed", (SIGNAL_FUNC) sig_log_create_failed); signal_add("awaylog show", (SIGNAL_FUNC) sig_awaylog_show); signal_add("setup changed", (SIGNAL_FUNC) read_settings); command_set_options("log open", "noopen autoopen -targets window -rotate"); } void fe_log_deinit(void) { g_source_remove(autoremove_tag); command_unbind("log", (SIGNAL_FUNC) cmd_log); command_unbind("log open", (SIGNAL_FUNC) cmd_log_open); command_unbind("log close", (SIGNAL_FUNC) cmd_log_close); command_unbind("log start", (SIGNAL_FUNC) cmd_log_start); command_unbind("log stop", (SIGNAL_FUNC) cmd_log_stop); command_unbind("window log", (SIGNAL_FUNC) cmd_window_log); command_unbind("window logfile", (SIGNAL_FUNC) cmd_window_logfile); signal_remove("print text stripped", (SIGNAL_FUNC) sig_printtext_stripped); signal_remove("window item remove", (SIGNAL_FUNC) sig_window_item_remove); signal_remove("window refnum changed", (SIGNAL_FUNC) sig_window_refnum_changed); signal_remove("log locked", (SIGNAL_FUNC) sig_log_locked); signal_remove("log create failed", (SIGNAL_FUNC) sig_log_create_failed); signal_remove("awaylog show", (SIGNAL_FUNC) sig_awaylog_show); signal_remove("setup changed", (SIGNAL_FUNC) read_settings); }