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 int log_dir_create_mode;
53
static char *log_colorizer_strip(const char *str)
55
return strip_codes(str);
58
static void log_add_targets(LOG_REC *log, const char *targets, const char *tag)
62
g_return_if_fail(log != NULL);
63
g_return_if_fail(targets != NULL);
65
items = g_strsplit(targets, " ", -1);
67
for (tmp = items; *tmp != NULL; tmp++)
68
log_item_add(log, LOG_ITEM_TARGET, *tmp, tag);
73
/* SYNTAX: LOG OPEN [-noopen] [-autoopen] [-window] [-<server tag>]
74
[-targets <targets>] [-colors]
76
static void cmd_log_open(const char *data)
80
char *targetarg, *fname, *levels, *servertag;
82
char window[MAX_INT_STRLEN];
86
if (!cmd_get_params(data, &free_arg, 2 | PARAM_FLAG_GETREST |
87
PARAM_FLAG_UNKNOWN_OPTIONS | PARAM_FLAG_OPTIONS,
88
"log open", &optlist, &fname, &levels))
90
if (*fname == '\0') cmd_param_error(CMDERR_NOT_ENOUGH_PARAMS);
92
level = level2bits(levels);
93
log = log_create_rec(fname, level != 0 ? level : MSGLEVEL_ALL);
96
server = cmd_options_get_server("log open", optlist, NULL);
97
servertag = server == NULL ? NULL : server->tag;
99
if (g_hash_table_lookup(optlist, "window")) {
100
/* log by window ref# */
101
targetarg = g_hash_table_lookup(optlist, "targets");
102
if (targetarg == NULL || !is_numeric(targetarg, '\0')) {
103
ltoa(window, active_win->refnum);
106
log_item_add(log, LOG_ITEM_WINDOW_REFNUM, targetarg,
109
targetarg = g_hash_table_lookup(optlist, "targets");
110
if (targetarg != NULL && *targetarg != '\0')
111
log_add_targets(log, targetarg, servertag);
112
else if (servertag != NULL)
113
log_add_targets(log, "*", servertag);
116
if (g_hash_table_lookup(optlist, "autoopen"))
117
log->autoopen = TRUE;
119
if (g_hash_table_lookup(optlist, "colors") == NULL)
120
log->colorizer = log_colorizer_strip;
124
if (log->handle == -1 && g_hash_table_lookup(optlist, "noopen") == NULL) {
126
if (log_start_logging(log)) {
127
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE,
128
TXT_LOG_OPENED, fname);
134
cmd_params_free(free_arg);
137
static LOG_REC *log_find_from_data(const char *data)
141
if (!is_numeric(data, ' '))
142
return log_find(data);
144
/* with index number */
145
tmp = g_slist_nth(logs, atoi(data)-1);
146
return tmp == NULL ? NULL : tmp->data;
149
/* SYNTAX: LOG CLOSE <id>|<file> */
150
static void cmd_log_close(const char *data)
154
log = log_find_from_data(data);
156
printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_LOG_NOT_OPEN, data);
159
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_CLOSED, data);
163
/* SYNTAX: LOG START <id>|<file> */
164
static void cmd_log_start(const char *data)
168
log = log_find_from_data(data);
170
log_start_logging(log);
171
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_OPENED, data);
175
/* SYNTAX: LOG STOP <id>|<file> */
176
static void cmd_log_stop(const char *data)
180
log = log_find_from_data(data);
181
if (log == NULL || log->handle == -1)
182
printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_LOG_NOT_OPEN, data);
184
log_stop_logging(log);
185
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_CLOSED, data);
189
static char *log_items_get_list(LOG_REC *log)
194
LOG_ITEM_REC *rec = NULL;
196
g_return_val_if_fail(log != NULL, NULL);
197
g_return_val_if_fail(log->items != NULL, NULL);
199
str = g_string_new(NULL);
200
for (tmp = log->items; tmp != NULL; tmp = tmp->next) {
203
g_string_sprintfa(str, "%s, ", rec->name);
205
g_string_truncate(str, str->len-2);
206
if(rec->servertag != NULL)
207
g_string_sprintfa(str, " (%s)", rec->servertag);
210
g_string_free(str, FALSE);
214
static void cmd_log_list(void)
217
char *levelstr, *items;
220
printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_LOG_LIST_HEADER);
221
for (tmp = logs, index = 1; tmp != NULL; tmp = tmp->next, index++) {
222
LOG_REC *rec = tmp->data;
224
levelstr = bits2level(rec->level);
225
items = rec->items == NULL ? NULL :
226
log_items_get_list(rec);
228
printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_LOG_LIST,
229
index, rec->fname, items != NULL ? items : "",
230
levelstr, rec->autoopen ? " -autoopen" : "");
232
g_free_not_null(items);
235
printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_LOG_LIST_FOOTER);
238
static void cmd_log(const char *data, SERVER_REC *server, void *item)
243
command_runsub("log", data, server, item);
246
static LOG_REC *logs_find_item(int type, const char *item,
247
const char *servertag, LOG_ITEM_REC **ret_item)
249
LOG_ITEM_REC *logitem;
252
for (tmp = logs; tmp != NULL; tmp = tmp->next) {
253
LOG_REC *log = tmp->data;
255
logitem = log_item_find(log, type, item, servertag);
256
if (logitem != NULL) {
257
if (ret_item != NULL) *ret_item = logitem;
265
/* SYNTAX: WINDOW LOG on|off|toggle [<filename>] */
266
static void cmd_window_log(const char *data)
269
char *set, *fname, window[MAX_INT_STRLEN];
271
int open_log, close_log;
273
if (!cmd_get_params(data, &free_arg, 2, &set, &fname))
276
ltoa(window, active_win->refnum);
277
log = logs_find_item(LOG_ITEM_WINDOW_REFNUM, window, NULL, NULL);
279
open_log = close_log = FALSE;
280
if (g_strcasecmp(set, "ON") == 0)
282
else if (g_strcasecmp(set, "OFF") == 0) {
284
} else if (g_strcasecmp(set, "TOGGLE") == 0) {
285
open_log = log == NULL;
286
close_log = log != NULL;
288
printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_NOT_TOGGLE);
289
cmd_params_free(free_arg);
293
if (open_log && log == NULL) {
294
/* irc.log.<windowname> or irc.log.Window<ref#> */
295
fname = *fname != '\0' ? g_strdup(fname) :
296
g_strdup_printf("~/irc.log.%s%s",
297
active_win->name != NULL ? active_win->name : "Window",
298
active_win->name != NULL ? "" : window);
299
log = log_create_rec(fname, MSGLEVEL_ALL);
300
log->colorizer = log_colorizer_strip;
301
log_item_add(log, LOG_ITEM_WINDOW_REFNUM, window, NULL);
306
if (open_log && log != NULL) {
307
log_start_logging(log);
308
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_OPENED, log->fname);
309
} else if (close_log && log != NULL && log->handle != -1) {
310
log_stop_logging(log);
311
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_CLOSED, log->fname);
314
cmd_params_free(free_arg);
317
/* Create log file entry to window, but don't start logging */
318
/* SYNTAX: WINDOW LOGFILE <file> */
319
static void cmd_window_logfile(const char *data)
322
char window[MAX_INT_STRLEN];
324
ltoa(window, active_win->refnum);
325
log = logs_find_item(LOG_ITEM_WINDOW_REFNUM, window, NULL, NULL);
328
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_WINDOWLOG_FILE_LOGGING);
332
log = log_create_rec(data, MSGLEVEL_ALL);
333
log->colorizer = log_colorizer_strip;
334
log_item_add(log, LOG_ITEM_WINDOW_REFNUM, window, NULL);
337
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_WINDOWLOG_FILE, data);
340
/* window's refnum changed - update the logs to log the new window refnum */
341
static void sig_window_refnum_changed(WINDOW_REC *window, gpointer old_refnum)
343
char winnum[MAX_INT_STRLEN];
347
ltoa(winnum, GPOINTER_TO_INT(old_refnum));
348
log = logs_find_item(LOG_ITEM_WINDOW_REFNUM, winnum, NULL, &item);
351
ltoa(winnum, window->refnum);
354
item->name = g_strdup(winnum);
358
static void sig_server_disconnected(SERVER_REC *server)
360
LOG_ITEM_REC *logitem;
363
for (tmp = logs; tmp != NULL; tmp = next) {
364
LOG_REC *log = tmp->data;
367
if (!log->temp || log->items == NULL)
370
logitem = log->items->data;
371
if (logitem->type == LOG_ITEM_TARGET &&
372
logitem->servertag != NULL &&
373
g_strcasecmp(logitem->servertag, server->tag) == 0 &&
374
server_ischannel(server, logitem->name)) /* kludge again.. so we won't close dcc chats */
379
static void autologs_close_all(void)
383
for (tmp = logs; tmp != NULL; tmp = next) {
384
LOG_REC *rec = tmp->data;
387
if (rec->temp) log_close(rec);
391
/* '%' -> '%%', '/' -> '_' */
392
static char *escape_target(const char *target)
396
p = str = g_malloc(strlen(target)*2+1);
397
while (*target != '\0') {
413
static void autolog_open(SERVER_REC *server, const char *server_tag,
417
char *fname, *dir, *fixed_target, *params;
419
log = logs_find_item(LOG_ITEM_TARGET, target, server_tag, NULL);
420
if (log != NULL && !log->failed) {
421
log_start_logging(log);
425
/* '/' -> '_' - don't even accidentally try to log to
426
#../../../file if you happen to join to such channel..
428
'%' -> '%%' - so strftime() won't mess with them */
429
fixed_target = escape_target(target);
430
if (CHAT_PROTOCOL(server)->case_insensitive)
431
g_strdown(fixed_target);
433
/* $0 = target, $1 = server tag */
434
params = g_strconcat(fixed_target, " ", server_tag, NULL);
435
g_free(fixed_target);
437
fname = parse_special_string(autolog_path, server, NULL,
441
if (log_find(fname) == NULL) {
442
log = log_create_rec(fname, autolog_level);
443
if (!settings_get_bool("autolog_colors"))
444
log->colorizer = log_colorizer_strip;
445
log_item_add(log, LOG_ITEM_TARGET, target, server_tag);
447
dir = g_dirname(log->real_fname);
448
mkpath(dir, log_dir_create_mode);
453
log_start_logging(log);
458
static void autolog_open_check(SERVER_REC *server, const char *server_tag,
459
const char *target, int level)
461
char **targets, **tmp;
463
/* FIXME: kind of a kludge, but we don't want to reopen logs when
464
we're parting the channel with /WINDOW CLOSE.. Maybe a small
465
timeout would be nice instead of immediately closing the log file
466
after "window item destroyed" */
467
if (level == MSGLEVEL_PARTS ||
468
(autolog_level & level) == 0 || target == NULL || *target == '\0')
471
/* there can be multiple targets separated with comma */
472
targets = g_strsplit(target, ",", -1);
473
for (tmp = targets; *tmp != NULL; tmp++)
474
autolog_open(server, server_tag, *tmp);
478
static void log_single_line(WINDOW_REC *window, const char *server_tag,
479
const char *target, int level, const char *text)
481
char windownum[MAX_INT_STRLEN];
482
char **targets, **tmp;
485
if (window != NULL) {
486
/* save to log created with /WINDOW LOG */
487
ltoa(windownum, window->refnum);
488
log = logs_find_item(LOG_ITEM_WINDOW_REFNUM,
489
windownum, NULL, NULL);
491
log_write_rec(log, text, level);
495
log_file_write(server_tag, NULL, level, text, FALSE);
497
/* there can be multiple items separated with comma */
498
targets = g_strsplit(target, ",", -1);
499
for (tmp = targets; *tmp != NULL; tmp++)
500
log_file_write(server_tag, *tmp, level, text, FALSE);
505
static void log_line(TEXT_DEST_REC *dest, const char *text)
509
if (dest->level == MSGLEVEL_NEVER)
512
/* let autolog open the log records */
513
autolog_open_check(dest->server, dest->server_tag,
514
dest->target, dest->level);
519
/* text may contain one or more lines, log wants to eat them one
521
lines = g_strsplit(text, "\n", -1);
522
for (tmp = lines; *tmp != NULL; tmp++)
523
log_single_line(dest->window, dest->server_tag,
524
dest->target, dest->level, *tmp);
528
static void sig_printtext(TEXT_DEST_REC *dest, const char *text,
529
const char *stripped)
531
if (skip_next_printtext) {
532
skip_next_printtext = FALSE;
536
log_line(dest, text);
539
static void sig_print_format(THEME_REC *theme, const char *module,
540
TEXT_DEST_REC *dest, void *formatnum, char **args)
542
char *str, *linestart, *tmp;
544
if (log_theme == NULL) {
545
/* theme isn't loaded for some reason (/reload destroys it),
547
log_theme = theme_load(log_theme_name);
548
if (log_theme == NULL) return;
551
if (theme == log_theme)
554
str = format_get_text_theme_charargs(log_theme, module, dest,
555
GPOINTER_TO_INT(formatnum), args);
556
skip_next_printtext = TRUE;
559
/* add the line start format */
560
linestart = format_get_level_tag(log_theme, dest);
562
str = format_add_linestart(tmp, linestart);
563
g_free_not_null(linestart);
566
/* strip colors from text, log it. */
573
static int sig_autoremove(void)
576
LOG_ITEM_REC *logitem;
580
removetime = time(NULL)-AUTOLOG_INACTIVITY_CLOSE;
581
for (tmp = logs; tmp != NULL; tmp = next) {
582
LOG_REC *log = tmp->data;
586
if (!log->temp || log->last > removetime || log->items == NULL)
589
/* Close only logs with private messages */
590
logitem = log->items->data;
591
if (logitem->servertag == NULL)
594
server = server_find_tag(logitem->servertag);
595
if (logitem->type == LOG_ITEM_TARGET &&
596
server != NULL && !server_ischannel(server, logitem->name))
602
static void sig_window_item_remove(WINDOW_REC *window, WI_ITEM_REC *item)
606
log = logs_find_item(LOG_ITEM_TARGET, item->visible_name,
607
item->server == NULL ? NULL :
608
item->server->tag, NULL);
609
if (log != NULL && log->temp)
613
static void sig_log_locked(LOG_REC *log)
615
printformat(NULL, NULL, MSGLEVEL_CLIENTERROR,
616
TXT_LOG_LOCKED, log->fname);
619
static void sig_log_create_failed(LOG_REC *log)
621
printformat(NULL, NULL, MSGLEVEL_CLIENTERROR,
622
TXT_LOG_CREATE_FAILED,
623
log->real_fname, g_strerror(errno));
626
static void sig_log_new(LOG_REC *log)
628
if (!settings_get_bool("awaylog_colors") &&
629
strcmp(log->fname, settings_get_str("awaylog_file")) == 0)
630
log->colorizer = log_colorizer_strip;
633
static void sig_log_config_read(LOG_REC *log, CONFIG_NODE *node)
635
if (!config_node_get_bool(node, "colors", FALSE))
636
log->colorizer = log_colorizer_strip;
639
static void sig_log_config_save(LOG_REC *log, CONFIG_NODE *node)
641
if (log->colorizer == NULL)
642
iconfig_node_set_bool(node, "colors", TRUE);
644
iconfig_node_set_str(node, "colors", NULL);
647
static void sig_awaylog_show(LOG_REC *log, gpointer pmsgs, gpointer pfilepos)
652
msgs = GPOINTER_TO_INT(pmsgs);
653
filepos = GPOINTER_TO_INT(pfilepos);
656
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_NO_AWAY_MSGS, log->fname);
658
printformat(NULL, NULL, MSGLEVEL_CLIENTNOTICE, TXT_LOG_AWAY_MSGS, log->fname, msgs);
660
str = g_strdup_printf("\"%s\" %d", log->fname, filepos);
661
signal_emit("command cat", 1, str);
666
static void sig_theme_destroyed(THEME_REC *theme)
668
if (theme == log_theme)
672
static void read_settings(void)
674
int old_autolog = autolog_level;
675
int log_file_create_mode;
677
autolog_path = settings_get_str("autolog_path");
678
autolog_level = !settings_get_bool("autolog") ? 0 :
679
settings_get_level("autolog_level");
681
if (old_autolog && !autolog_level)
682
autologs_close_all();
684
/* write to log files with different theme? */
685
if (log_theme_name != NULL)
686
signal_remove("print format", (SIGNAL_FUNC) sig_print_format);
687
log_theme_name = settings_get_str("log_theme");
688
if (*log_theme_name == '\0')
689
log_theme_name = NULL;
691
signal_add("print format", (SIGNAL_FUNC) sig_print_format);
693
log_theme = log_theme_name == NULL ? NULL :
694
theme_load(log_theme_name);
696
log_file_create_mode = octal2dec(settings_get_int("log_create_mode"));
697
log_dir_create_mode = log_file_create_mode;
698
if (log_file_create_mode & 0400) log_dir_create_mode |= 0100;
699
if (log_file_create_mode & 0040) log_dir_create_mode |= 0010;
700
if (log_file_create_mode & 0004) log_dir_create_mode |= 0001;
703
void fe_log_init(void)
705
autoremove_tag = g_timeout_add(60000, (GSourceFunc) sig_autoremove, NULL);
706
skip_next_printtext = FALSE;
708
settings_add_bool("log", "awaylog_colors", TRUE);
709
settings_add_bool("log", "autolog", FALSE);
710
settings_add_bool("log", "autolog_colors", FALSE);
711
settings_add_str("log", "autolog_path", "~/irclogs/$tag/$0.log");
712
settings_add_level("log", "autolog_level", "all -crap -clientcrap -ctcps");
713
settings_add_str("log", "log_theme", "");
716
log_theme_name = NULL;
719
command_bind("log", NULL, (SIGNAL_FUNC) cmd_log);
720
command_bind("log open", NULL, (SIGNAL_FUNC) cmd_log_open);
721
command_bind("log close", NULL, (SIGNAL_FUNC) cmd_log_close);
722
command_bind("log start", NULL, (SIGNAL_FUNC) cmd_log_start);
723
command_bind("log stop", NULL, (SIGNAL_FUNC) cmd_log_stop);
724
command_bind("window log", NULL, (SIGNAL_FUNC) cmd_window_log);
725
command_bind("window logfile", NULL, (SIGNAL_FUNC) cmd_window_logfile);
726
signal_add_first("print text", (SIGNAL_FUNC) sig_printtext);
727
signal_add("window item remove", (SIGNAL_FUNC) sig_window_item_remove);
728
signal_add("window refnum changed", (SIGNAL_FUNC) sig_window_refnum_changed);
729
signal_add("server disconnected", (SIGNAL_FUNC) sig_server_disconnected);
730
signal_add("log locked", (SIGNAL_FUNC) sig_log_locked);
731
signal_add("log create failed", (SIGNAL_FUNC) sig_log_create_failed);
732
signal_add("log new", (SIGNAL_FUNC) sig_log_new);
733
signal_add("log config read", (SIGNAL_FUNC) sig_log_config_read);
734
signal_add("log config save", (SIGNAL_FUNC) sig_log_config_save);
735
signal_add("awaylog show", (SIGNAL_FUNC) sig_awaylog_show);
736
signal_add("theme destroyed", (SIGNAL_FUNC) sig_theme_destroyed);
737
signal_add("setup changed", (SIGNAL_FUNC) read_settings);
739
command_set_options("log open", "noopen autoopen -targets window colors");
742
void fe_log_deinit(void)
744
g_source_remove(autoremove_tag);
745
if (log_theme_name != NULL)
746
signal_remove("print format", (SIGNAL_FUNC) sig_print_format);
748
command_unbind("log", (SIGNAL_FUNC) cmd_log);
749
command_unbind("log open", (SIGNAL_FUNC) cmd_log_open);
750
command_unbind("log close", (SIGNAL_FUNC) cmd_log_close);
751
command_unbind("log start", (SIGNAL_FUNC) cmd_log_start);
752
command_unbind("log stop", (SIGNAL_FUNC) cmd_log_stop);
753
command_unbind("window log", (SIGNAL_FUNC) cmd_window_log);
754
command_unbind("window logfile", (SIGNAL_FUNC) cmd_window_logfile);
755
signal_remove("print text", (SIGNAL_FUNC) sig_printtext);
756
signal_remove("window item remove", (SIGNAL_FUNC) sig_window_item_remove);
757
signal_remove("window refnum changed", (SIGNAL_FUNC) sig_window_refnum_changed);
758
signal_remove("server disconnected", (SIGNAL_FUNC) sig_server_disconnected);
759
signal_remove("log locked", (SIGNAL_FUNC) sig_log_locked);
760
signal_remove("log create failed", (SIGNAL_FUNC) sig_log_create_failed);
761
signal_remove("log new", (SIGNAL_FUNC) sig_log_new);
762
signal_remove("log config read", (SIGNAL_FUNC) sig_log_config_read);
763
signal_remove("log config save", (SIGNAL_FUNC) sig_log_config_save);
764
signal_remove("awaylog show", (SIGNAL_FUNC) sig_awaylog_show);
765
signal_remove("theme destroyed", (SIGNAL_FUNC) sig_theme_destroyed);
766
signal_remove("setup changed", (SIGNAL_FUNC) read_settings);