4 Copyright (C) 1999-2000 Timo Sirainen
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include "module-formats.h"
25 #include "chat-protocols.h"
30 #include "special-vars.h"
32 #include "lib-config/iconfig.h"
34 #include "fe-windows.h"
35 #include "window-items.h"
38 #include "printtext.h"
40 /* close autologs after 5 minutes of inactivity */
41 #define AUTOLOG_INACTIVITY_CLOSE (60*5)
43 static int autolog_level;
44 static int autoremove_tag;
45 static const char *autolog_path;
47 static THEME_REC *log_theme;
48 static int skip_next_printtext;
49 static const char *log_theme_name;
51 static char *log_colorizer_strip(const char *str)
53 return strip_codes(str);
56 static void log_add_targets(LOG_REC *log, const char *targets, const char *tag)
60 g_return_if_fail(log != NULL);
61 g_return_if_fail(targets != NULL);
63 items = g_strsplit(targets, " ", -1);
65 for (tmp = items; *tmp != NULL; tmp++)
66 log_item_add(log, LOG_ITEM_TARGET, *tmp, tag);
71 /* SYNTAX: LOG OPEN [-noopen] [-autoopen] [-window] [-<server tag>]
72 [-targets <targets>] [-colors]
74 static void cmd_log_open(const char *data)
78 char *targetarg, *fname, *levels, *servertag;
80 char window[MAX_INT_STRLEN];
84 if (!cmd_get_params(data, &free_arg, 2 | PARAM_FLAG_GETREST |
85 PARAM_FLAG_UNKNOWN_OPTIONS | PARAM_FLAG_OPTIONS,
86 "log open", &optlist, &fname, &levels))
88 if (*fname == '\0') cmd_param_error(CMDERR_NOT_ENOUGH_PARAMS);
90 level = level2bits(levels);
91 log = log_create_rec(fname, level != 0 ? level : MSGLEVEL_ALL);
94 server = cmd_options_get_server("log open", optlist, NULL);
95 servertag = server == NULL ? NULL : server->tag;
97 if (g_hash_table_lookup(optlist, "window")) {
98 /* log by window ref# */
99 targetarg = g_hash_table_lookup(optlist, "targets");
100 if (targetarg == NULL || !is_numeric(targetarg, '\0')) {
101 ltoa(window, active_win->refnum);
104 log_item_add(log, LOG_ITEM_WINDOW_REFNUM, targetarg,
107 targetarg = g_hash_table_lookup(optlist, "targets");
108 if (targetarg != NULL && *targetarg != '\0')
109 log_add_targets(log, targetarg, servertag);
112 if (g_hash_table_lookup(optlist, "autoopen"))
113 log->autoopen = TRUE;
115 if (g_hash_table_lookup(optlist, "colors") == NULL)
116 log->colorizer = log_colorizer_strip;
120 if (log->handle == -1 && g_hash_table_lookup(optlist, "noopen") == NULL) {
122 if (log_start_logging(log)) {
123 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE,
124 TXT_LOG_OPENED, fname);
130 cmd_params_free(free_arg);
133 static LOG_REC *log_find_from_data(const char *data)
137 if (!is_numeric(data, ' '))
138 return log_find(data);
140 /* with index number */
141 tmp = g_slist_nth(logs, atoi(data)-1);
142 return tmp == NULL ? NULL : tmp->data;
145 /* SYNTAX: LOG CLOSE <id>|<file> */
146 static void cmd_log_close(const char *data)
150 log = log_find_from_data(data);
152 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_LOG_NOT_OPEN, data);
155 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_CLOSED, data);
159 /* SYNTAX: LOG START <id>|<file> */
160 static void cmd_log_start(const char *data)
164 log = log_find_from_data(data);
166 log_start_logging(log);
167 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_OPENED, data);
171 /* SYNTAX: LOG STOP <id>|<file> */
172 static void cmd_log_stop(const char *data)
176 log = log_find_from_data(data);
177 if (log == NULL || log->handle == -1)
178 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_LOG_NOT_OPEN, data);
180 log_stop_logging(log);
181 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_CLOSED, data);
185 static char *log_items_get_list(LOG_REC *log)
191 g_return_val_if_fail(log != NULL, NULL);
192 g_return_val_if_fail(log->items != NULL, NULL);
194 str = g_string_new(NULL);
195 for (tmp = log->items; tmp != NULL; tmp = tmp->next) {
196 LOG_ITEM_REC *rec = tmp->data;
198 g_string_sprintfa(str, "%s, ", rec->name);
200 g_string_truncate(str, str->len-2);
203 g_string_free(str, FALSE);
207 static void cmd_log_list(void)
210 char *levelstr, *items;
213 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_LOG_LIST_HEADER);
214 for (tmp = logs, index = 1; tmp != NULL; tmp = tmp->next, index++) {
215 LOG_REC *rec = tmp->data;
217 levelstr = bits2level(rec->level);
218 items = rec->items == NULL ? NULL :
219 log_items_get_list(rec);
221 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_LOG_LIST,
222 index, rec->fname, items != NULL ? items : "",
223 levelstr, rec->autoopen ? " -autoopen" : "");
225 g_free_not_null(items);
228 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_LOG_LIST_FOOTER);
231 static void cmd_log(const char *data, SERVER_REC *server, void *item)
236 command_runsub("log", data, server, item);
239 static LOG_REC *logs_find_item(int type, const char *item,
240 const char *servertag, LOG_ITEM_REC **ret_item)
242 LOG_ITEM_REC *logitem;
245 for (tmp = logs; tmp != NULL; tmp = tmp->next) {
246 LOG_REC *log = tmp->data;
248 logitem = log_item_find(log, type, item, servertag);
249 if (logitem != NULL) {
250 if (ret_item != NULL) *ret_item = logitem;
258 /* SYNTAX: WINDOW LOG on|off|toggle [<filename>] */
259 static void cmd_window_log(const char *data)
262 char *set, *fname, window[MAX_INT_STRLEN];
264 int open_log, close_log;
266 if (!cmd_get_params(data, &free_arg, 2, &set, &fname))
269 ltoa(window, active_win->refnum);
270 log = logs_find_item(LOG_ITEM_WINDOW_REFNUM, window, NULL, NULL);
272 open_log = close_log = FALSE;
273 if (g_strcasecmp(set, "ON") == 0)
275 else if (g_strcasecmp(set, "OFF") == 0) {
277 } else if (g_strcasecmp(set, "TOGGLE") == 0) {
278 open_log = log == NULL;
279 close_log = log != NULL;
281 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_NOT_TOGGLE);
282 cmd_params_free(free_arg);
286 if (open_log && log == NULL) {
287 /* irc.log.<windowname> or irc.log.Window<ref#> */
288 fname = *fname != '\0' ? g_strdup(fname) :
289 g_strdup_printf("~/irc.log.%s%s",
290 active_win->name != NULL ? active_win->name : "Window",
291 active_win->name != NULL ? "" : window);
292 log = log_create_rec(fname, MSGLEVEL_ALL);
293 log->colorizer = log_colorizer_strip;
294 log_item_add(log, LOG_ITEM_WINDOW_REFNUM, window, NULL);
299 if (open_log && log != NULL) {
300 log_start_logging(log);
301 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_OPENED, log->fname);
302 } else if (close_log && log != NULL && log->handle != -1) {
303 log_stop_logging(log);
304 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_CLOSED, log->fname);
307 cmd_params_free(free_arg);
310 /* Create log file entry to window, but don't start logging */
311 /* SYNTAX: WINDOW LOGFILE <file> */
312 static void cmd_window_logfile(const char *data)
315 char window[MAX_INT_STRLEN];
317 ltoa(window, active_win->refnum);
318 log = logs_find_item(LOG_ITEM_WINDOW_REFNUM, window, NULL, NULL);
321 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_WINDOWLOG_FILE_LOGGING);
325 log = log_create_rec(data, MSGLEVEL_ALL);
326 log->colorizer = log_colorizer_strip;
327 log_item_add(log, LOG_ITEM_WINDOW_REFNUM, window, NULL);
330 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_WINDOWLOG_FILE, data);
333 /* window's refnum changed - update the logs to log the new window refnum */
334 static void sig_window_refnum_changed(WINDOW_REC *window, gpointer old_refnum)
336 char winnum[MAX_INT_STRLEN];
340 ltoa(winnum, GPOINTER_TO_INT(old_refnum));
341 log = logs_find_item(LOG_ITEM_WINDOW_REFNUM, winnum, NULL, &item);
344 ltoa(winnum, window->refnum);
347 item->name = g_strdup(winnum);
351 static void sig_server_disconnected(SERVER_REC *server)
353 LOG_ITEM_REC *logitem;
356 for (tmp = logs; tmp != NULL; tmp = next) {
357 LOG_REC *log = tmp->data;
360 if (!log->temp || log->items == NULL)
363 logitem = log->items->data;
364 if (logitem->type == LOG_ITEM_TARGET &&
365 logitem->servertag != NULL &&
366 g_strcasecmp(logitem->servertag, server->tag) == 0 &&
367 server_ischannel(server, logitem->name)) /* kludge again.. so we won't close dcc chats */
372 static void autologs_close_all(void)
376 for (tmp = logs; tmp != NULL; tmp = next) {
377 LOG_REC *rec = tmp->data;
380 if (rec->temp) log_close(rec);
384 /* '%' -> '%%', '/' -> '_' */
385 static char *escape_target(const char *target)
389 p = str = g_malloc(strlen(target)*2+1);
390 while (*target != '\0') {
406 static void autolog_open(SERVER_REC *server, const char *server_tag,
410 char *fname, *dir, *fixed_target;
412 log = logs_find_item(LOG_ITEM_TARGET, target, server_tag, NULL);
413 if (log != NULL && !log->failed) {
414 log_start_logging(log);
418 /* '/' -> '_' - don't even accidentally try to log to
419 #../../../file if you happen to join to such channel..
421 '%' -> '%%' - so strftime() won't mess with them */
422 fixed_target = escape_target(target);
423 if (CHAT_PROTOCOL(server)->case_insensitive)
424 g_strdown(fixed_target);
426 fname = parse_special_string(autolog_path, server, NULL,
427 fixed_target, NULL, 0);
428 g_free(fixed_target);
430 if (log_find(fname) == NULL) {
431 log = log_create_rec(fname, autolog_level);
432 if (!settings_get_bool("autolog_colors"))
433 log->colorizer = log_colorizer_strip;
434 log_item_add(log, LOG_ITEM_TARGET, target, server_tag);
436 dir = g_dirname(log->real_fname);
437 mkpath(dir, LOG_DIR_CREATE_MODE);
442 log_start_logging(log);
447 static void autolog_open_check(SERVER_REC *server, const char *server_tag,
448 const char *target, int level)
450 char **targets, **tmp;
452 /* FIXME: kind of a kludge, but we don't want to reopen logs when
453 we're parting the channel with /WINDOW CLOSE.. Maybe a small
454 timeout would be nice instead of immediately closing the log file
455 after "window item destroyed" */
456 if (level == MSGLEVEL_PARTS ||
457 (autolog_level & level) == 0 || target == NULL || *target == '\0')
460 /* there can be multiple targets separated with comma */
461 targets = g_strsplit(target, ",", -1);
462 for (tmp = targets; *tmp != NULL; tmp++)
463 autolog_open(server, server_tag, *tmp);
467 static void log_single_line(WINDOW_REC *window, const char *server_tag,
468 const char *target, int level, const char *text)
470 char windownum[MAX_INT_STRLEN];
471 char **targets, **tmp;
474 /* save to log created with /WINDOW LOG */
475 ltoa(windownum, window->refnum);
476 log = logs_find_item(LOG_ITEM_WINDOW_REFNUM,
477 windownum, NULL, NULL);
479 log_write_rec(log, text, level);
483 log_file_write(server_tag, NULL, level, text, FALSE);
485 /* there can be multiple items separated with comma */
486 targets = g_strsplit(target, ",", -1);
487 for (tmp = targets; *tmp != NULL; tmp++)
488 log_file_write(server_tag, *tmp, level, text, FALSE);
493 static void log_line(TEXT_DEST_REC *dest, const char *text)
497 if (dest->level == MSGLEVEL_NEVER)
500 /* let autolog open the log records */
501 autolog_open_check(dest->server, dest->server_tag,
502 dest->target, dest->level);
507 /* text may contain one or more lines, log wants to eat them one
509 lines = g_strsplit(text, "\n", -1);
510 for (tmp = lines; *tmp != NULL; tmp++)
511 log_single_line(dest->window, dest->server_tag,
512 dest->target, dest->level, *tmp);
516 static void sig_printtext(TEXT_DEST_REC *dest, const char *text,
517 const char *stripped)
519 if (skip_next_printtext) {
520 skip_next_printtext = FALSE;
524 log_line(dest, text);
527 static void sig_print_format(THEME_REC *theme, const char *module,
528 TEXT_DEST_REC *dest, void *formatnum, char **args)
530 char *str, *linestart, *tmp;
532 if (log_theme == NULL) {
533 /* theme isn't loaded for some reason (/reload destroys it),
535 log_theme = theme_load(log_theme_name);
536 if (log_theme == NULL) return;
539 if (theme == log_theme)
542 str = format_get_text_theme_charargs(log_theme, module, dest,
543 GPOINTER_TO_INT(formatnum), args);
544 skip_next_printtext = TRUE;
547 /* add the line start format */
548 linestart = format_get_level_tag(log_theme, dest);
550 str = format_add_linestart(tmp, linestart);
551 g_free_not_null(linestart);
554 /* strip colors from text, log it. */
561 static int sig_autoremove(void)
564 LOG_ITEM_REC *logitem;
568 removetime = time(NULL)-AUTOLOG_INACTIVITY_CLOSE;
569 for (tmp = logs; tmp != NULL; tmp = next) {
570 LOG_REC *log = tmp->data;
574 if (!log->temp || log->last > removetime || log->items == NULL)
577 /* Close only logs with private messages */
578 logitem = log->items->data;
579 if (logitem->servertag == NULL)
582 server = server_find_tag(logitem->servertag);
583 if (logitem->type == LOG_ITEM_TARGET &&
584 server != NULL && !server_ischannel(server, logitem->name))
590 static void sig_window_item_destroy(WINDOW_REC *window, WI_ITEM_REC *item)
594 log = logs_find_item(LOG_ITEM_TARGET, item->name,
595 item->server == NULL ? NULL :
596 item->server->tag, NULL);
597 if (log != NULL && log->temp)
601 static void sig_log_locked(LOG_REC *log)
603 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR,
604 TXT_LOG_LOCKED, log->fname);
607 static void sig_log_create_failed(LOG_REC *log)
609 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR,
610 TXT_LOG_CREATE_FAILED,
611 log->real_fname, g_strerror(errno));
614 static void sig_log_new(LOG_REC *log)
616 if (!settings_get_bool("awaylog_colors") &&
617 strcmp(log->fname, settings_get_str("awaylog_file")) == 0)
618 log->colorizer = log_colorizer_strip;
621 static void sig_log_config_read(LOG_REC *log, CONFIG_NODE *node)
623 if (!config_node_get_bool(node, "colors", FALSE))
624 log->colorizer = log_colorizer_strip;
627 static void sig_log_config_save(LOG_REC *log, CONFIG_NODE *node)
629 if (log->colorizer == NULL)
630 iconfig_node_set_bool(node, "colors", TRUE);
632 iconfig_node_set_str(node, "colors", NULL);
635 static void sig_awaylog_show(LOG_REC *log, gpointer pmsgs, gpointer pfilepos)
640 msgs = GPOINTER_TO_INT(pmsgs);
641 filepos = GPOINTER_TO_INT(pfilepos);
644 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_NO_AWAY_MSGS, log->fname);
646 printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_AWAY_MSGS, log->fname, msgs);
648 str = g_strdup_printf("\"%s\" %d", log->fname, filepos);
649 signal_emit("command cat", 1, str);
654 static void sig_theme_destroyed(THEME_REC *theme)
656 if (theme == log_theme)
660 static void read_settings(void)
662 int old_autolog = autolog_level;
664 autolog_path = settings_get_str("autolog_path");
665 autolog_level = !settings_get_bool("autolog") ? 0 :
666 level2bits(settings_get_str("autolog_level"));
668 if (old_autolog && !autolog_level)
669 autologs_close_all();
671 /* write to log files with different theme? */
672 if (log_theme_name != NULL)
673 signal_remove("print format", (SIGNAL_FUNC) sig_print_format);
674 log_theme_name = settings_get_str("log_theme");
675 if (*log_theme_name == '\0')
676 log_theme_name = NULL;
678 signal_add("print format", (SIGNAL_FUNC) sig_print_format);
680 log_theme = log_theme_name == NULL ? NULL :
681 theme_load(log_theme_name);
684 void fe_log_init(void)
686 autoremove_tag = g_timeout_add(60000, (GSourceFunc) sig_autoremove, NULL);
687 skip_next_printtext = FALSE;
689 settings_add_bool("log", "awaylog_colors", TRUE);
690 settings_add_bool("log", "autolog", FALSE);
691 settings_add_bool("log", "autolog_colors", FALSE);
692 settings_add_str("log", "autolog_path", "~/irclogs/$tag/$0.log");
693 settings_add_str("log", "autolog_level", "all -crap -clientcrap -ctcps");
694 settings_add_str("log", "log_theme", "");
697 log_theme_name = NULL;
700 command_bind("log", NULL, (SIGNAL_FUNC) cmd_log);
701 command_bind("log open", NULL, (SIGNAL_FUNC) cmd_log_open);
702 command_bind("log close", NULL, (SIGNAL_FUNC) cmd_log_close);
703 command_bind("log start", NULL, (SIGNAL_FUNC) cmd_log_start);
704 command_bind("log stop", NULL, (SIGNAL_FUNC) cmd_log_stop);
705 command_bind("window log", NULL, (SIGNAL_FUNC) cmd_window_log);
706 command_bind("window logfile", NULL, (SIGNAL_FUNC) cmd_window_logfile);
707 signal_add_first("print text", (SIGNAL_FUNC) sig_printtext);
708 signal_add("window item destroy", (SIGNAL_FUNC) sig_window_item_destroy);
709 signal_add("window refnum changed", (SIGNAL_FUNC) sig_window_refnum_changed);
710 signal_add("server disconnected", (SIGNAL_FUNC) sig_server_disconnected);
711 signal_add("log locked", (SIGNAL_FUNC) sig_log_locked);
712 signal_add("log create failed", (SIGNAL_FUNC) sig_log_create_failed);
713 signal_add("log new", (SIGNAL_FUNC) sig_log_new);
714 signal_add("log config read", (SIGNAL_FUNC) sig_log_config_read);
715 signal_add("log config save", (SIGNAL_FUNC) sig_log_config_save);
716 signal_add("awaylog show", (SIGNAL_FUNC) sig_awaylog_show);
717 signal_add("theme destroyed", (SIGNAL_FUNC) sig_theme_destroyed);
718 signal_add("setup changed", (SIGNAL_FUNC) read_settings);
720 command_set_options("log open", "noopen autoopen -targets window colors");
723 void fe_log_deinit(void)
725 g_source_remove(autoremove_tag);
726 if (log_theme_name != NULL)
727 signal_remove("print format", (SIGNAL_FUNC) sig_print_format);
729 command_unbind("log", (SIGNAL_FUNC) cmd_log);
730 command_unbind("log open", (SIGNAL_FUNC) cmd_log_open);
731 command_unbind("log close", (SIGNAL_FUNC) cmd_log_close);
732 command_unbind("log start", (SIGNAL_FUNC) cmd_log_start);
733 command_unbind("log stop", (SIGNAL_FUNC) cmd_log_stop);
734 command_unbind("window log", (SIGNAL_FUNC) cmd_window_log);
735 command_unbind("window logfile", (SIGNAL_FUNC) cmd_window_logfile);
736 signal_remove("print text", (SIGNAL_FUNC) sig_printtext);
737 signal_remove("window item destroy", (SIGNAL_FUNC) sig_window_item_destroy);
738 signal_remove("window refnum changed", (SIGNAL_FUNC) sig_window_refnum_changed);
739 signal_remove("server disconnected", (SIGNAL_FUNC) sig_server_disconnected);
740 signal_remove("log locked", (SIGNAL_FUNC) sig_log_locked);
741 signal_remove("log create failed", (SIGNAL_FUNC) sig_log_create_failed);
742 signal_remove("log new", (SIGNAL_FUNC) sig_log_new);
743 signal_remove("log config read", (SIGNAL_FUNC) sig_log_config_read);
744 signal_remove("log config save", (SIGNAL_FUNC) sig_log_config_save);
745 signal_remove("awaylog show", (SIGNAL_FUNC) sig_awaylog_show);
746 signal_remove("theme destroyed", (SIGNAL_FUNC) sig_theme_destroyed);
747 signal_remove("setup changed", (SIGNAL_FUNC) read_settings);