2007-11-27 [wwp] 3.1.0cvs32
[claws.git] / src / prefs_logging.c
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2007 Tristan Chabredier <wwp@claws-mail.org> and 
4  * the Claws Mail team
5  *
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 3 of the License, or
9  * (at your option) any later version.
10  *
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.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  * 
19  */
20
21 #ifdef HAVE_CONFIG_H
22 #  include "config.h"
23 #endif
24
25 #include "defs.h"
26
27 #include <stdio.h>
28 #include <stdlib.h>
29
30 #include <glib.h>
31 #include <glib/gi18n.h>
32 #include <gtk/gtk.h>
33
34 #include "prefs_common.h"
35 #include "prefs_gtk.h"
36
37 #include "gtk/gtkutils.h"
38 #include "gtk/prefswindow.h"
39 #include "gtk/menu.h"
40
41 #include "manage_window.h"
42
43 #include "log.h"
44 #include "combobox.h"
45
46 typedef struct _LoggingPage
47 {
48         PrefsPage page;
49
50         GtkWidget *window;
51
52         GtkWidget *checkbtn_clip_network_log;
53         GtkWidget *spinbtn_network_log_length;
54         GtkWidget *checkbtn_log_standard;
55         GtkWidget *checkbtn_log_warning;
56         GtkWidget *checkbtn_log_error;
57         GtkWidget *checkbtn_log_status;
58         GtkWidget *checkbtn_clip_filtering_log;
59         GtkWidget *spinbtn_filtering_log_length;
60         GtkWidget *checkbtn_filtering_log;
61         GtkWidget *checkbtn_filtering_log_inc;
62         GtkWidget *checkbtn_filtering_log_manual;
63         GtkWidget *checkbtn_filtering_log_folder_proc;
64         GtkWidget *checkbtn_filtering_log_pre_proc;
65         GtkWidget *checkbtn_filtering_log_post_proc;
66         GtkWidget *optmenu_filtering_log_level;
67 } LoggingPage;
68
69 static GtkWidget *prefs_logging_create_check_buttons(GtkWidget **checkbtn1,
70                         gchar *label1, GtkWidget **checkbtn2, gchar *label2)
71 {
72         GtkWidget *hbox_checkbtn;
73
74         hbox_checkbtn = gtk_hbox_new(FALSE, VBOX_BORDER);
75         gtk_widget_show(hbox_checkbtn);
76         
77         PACK_CHECK_BUTTON (hbox_checkbtn, *checkbtn1, label1); 
78         gtk_label_set_line_wrap(GTK_LABEL(GTK_BIN(*checkbtn1)->child), TRUE);
79
80         PACK_CHECK_BUTTON (hbox_checkbtn, *checkbtn2, label2);
81         gtk_label_set_line_wrap(GTK_LABEL(GTK_BIN(*checkbtn2)->child), TRUE);
82         
83         return hbox_checkbtn;
84 }
85
86 static void prefs_logging_create_widget(PrefsPage *_page, GtkWindow *window, 
87                                   gpointer data)
88 {
89         LoggingPage *prefs_logging = (LoggingPage *) _page;
90         
91         GtkWidget *vbox1;
92
93         GtkWidget *frame_logging;
94         GtkWidget *vbox_network_log;
95         GtkWidget *hbox_clip_network_log;
96         GtkWidget *checkbtn_clip_network_log;
97         GtkWidget *spinbtn_network_log_length;
98         GtkObject *spinbtn_network_log_length_adj;
99         GtkTooltips *network_log_length_tooltip;
100         GtkWidget *vbox1_filtering_log;
101         GtkWidget *hbox_clip_filtering_log;
102         GtkWidget *checkbtn_clip_filtering_log;
103         GtkWidget *spinbtn_filtering_log_length;
104         GtkObject *spinbtn_filtering_log_length_adj;
105         GtkTooltips *filtering_log_length_tooltip;
106         GtkWidget *hbox_filtering_log;
107         GtkWidget *checkbtn_filtering_log;
108         GtkWidget *frame_filtering_log;
109         GtkWidget *vbox2_filtering_log;
110         GtkWidget *hbox_checkbtn;
111         GtkWidget *checkbtn_filtering_log_inc;
112         GtkWidget *checkbtn_filtering_log_manual;
113         GtkWidget *checkbtn_filtering_log_folder_proc;
114         GtkWidget *checkbtn_filtering_log_pre_proc;
115         GtkWidget *checkbtn_filtering_log_post_proc;
116         GtkTooltips *filtering_log_tooltip;
117         GtkWidget *hbox_filtering_log_level;
118         GtkWidget *label_filtering_log_level;
119         GtkWidget *optmenu_filtering_log_level;
120         GtkListStore *menu;
121         GtkTreeIter iter;
122         GtkTooltips *filtering_log_level_tooltip;
123         GtkWidget *frame_disc_log;
124         GtkWidget *vbox_disc_log;
125         GtkWidget *label;
126         GtkWidget *hbox;
127         GtkWidget *checkbtn_log_standard;
128         GtkWidget *checkbtn_log_warning;
129         GtkWidget *checkbtn_log_error;
130         GtkWidget *checkbtn_log_status;
131
132         vbox1 = gtk_vbox_new (FALSE, VSPACING);
133         gtk_widget_show (vbox1);
134         gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
135
136         /* Protocol log */
137         vbox_network_log = gtkut_get_options_frame(vbox1, &frame_logging, _("Network log"));
138
139         hbox_clip_network_log = gtk_hbox_new (FALSE, 8);
140         gtk_container_add (GTK_CONTAINER (vbox_network_log), hbox_clip_network_log);
141         gtk_widget_show (hbox_clip_network_log);
142
143         PACK_CHECK_BUTTON (hbox_clip_network_log, checkbtn_clip_network_log,
144                            _("Restrict the log window to"));
145         
146         network_log_length_tooltip = gtk_tooltips_new();
147
148         spinbtn_network_log_length_adj = gtk_adjustment_new (500, 0, G_MAXINT, 1, 10, 10);
149         spinbtn_network_log_length = gtk_spin_button_new
150                 (GTK_ADJUSTMENT (spinbtn_network_log_length_adj), 1, 0);
151         gtk_widget_show (spinbtn_network_log_length);
152         gtk_box_pack_start (GTK_BOX (hbox_clip_network_log), spinbtn_network_log_length,
153                             FALSE, FALSE, 0);
154         gtk_widget_set_size_request (GTK_WIDGET (spinbtn_network_log_length), 64, -1);
155         gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_network_log_length), TRUE);
156
157         gtk_tooltips_set_tip(GTK_TOOLTIPS(network_log_length_tooltip), spinbtn_network_log_length,
158                              _("0 to stop logging in the log window"),
159                              NULL);
160
161         label = gtk_label_new(_("lines"));
162         gtk_widget_show (label);
163         gtk_box_pack_start(GTK_BOX(hbox_clip_network_log), label, FALSE, FALSE, 0);
164
165         SET_TOGGLE_SENSITIVITY(checkbtn_clip_network_log, spinbtn_network_log_length);
166         SET_TOGGLE_SENSITIVITY(checkbtn_clip_network_log, label);
167
168         /* Filtering/processing debug log */
169         vbox1_filtering_log = gtkut_get_options_frame(vbox1,
170                                 &frame_logging, _("Filtering/processing log"));
171
172         PACK_CHECK_BUTTON (vbox1_filtering_log, checkbtn_filtering_log,
173                            _("Enable logging of filtering/processing rules"));
174         hbox_filtering_log = gtk_hbox_new (FALSE, 8);
175         gtk_container_add (GTK_CONTAINER (vbox1_filtering_log), hbox_filtering_log);
176         gtk_widget_show (hbox_filtering_log);
177
178         filtering_log_tooltip = gtk_tooltips_new();
179         gtk_tooltips_set_tip(GTK_TOOLTIPS(filtering_log_tooltip),
180                              checkbtn_filtering_log,
181                              _("If checked, turns on logging of filtering and processing rules.\n"
182                                 "The log is accessible from 'Tools/Filtering log'.\n"
183                                 "Caution: enabling this option will slow down the filtering/processing, "
184                                 "this might be critical when applying many rules upon thousands of "
185                                 "messages."),
186                                 NULL);
187
188         vbox2_filtering_log = gtkut_get_options_frame(vbox1_filtering_log, &frame_filtering_log,
189                                                         _("Log filtering/processing when..."));
190
191         hbox_checkbtn = prefs_logging_create_check_buttons(
192                                                 &checkbtn_filtering_log_inc,
193                                                 _("filtering at incorporation"),
194                                                 &checkbtn_filtering_log_pre_proc,
195                                                 _("pre-processing folders"));
196         gtk_box_pack_start(GTK_BOX(vbox2_filtering_log), hbox_checkbtn, FALSE, FALSE, 0);
197
198         hbox_checkbtn = prefs_logging_create_check_buttons(
199                                                 &checkbtn_filtering_log_manual,
200                                                 _("manually filtering"),
201                                                 &checkbtn_filtering_log_post_proc,
202                                                 _("post-processing folders"));
203         gtk_box_pack_start(GTK_BOX(vbox2_filtering_log), hbox_checkbtn, FALSE, FALSE, 0);
204         
205         hbox_checkbtn = gtk_hbox_new(TRUE, VBOX_BORDER);
206         gtk_widget_show(hbox_checkbtn);
207         gtk_box_pack_start(GTK_BOX(vbox2_filtering_log), hbox_checkbtn, FALSE, FALSE, 0);
208         PACK_CHECK_BUTTON (hbox_checkbtn, checkbtn_filtering_log_folder_proc,
209                            _("processing folders"));
210         gtk_box_pack_start(GTK_BOX(hbox_checkbtn), gtk_label_new(""),
211                            FALSE, TRUE, 0);
212
213         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, frame_filtering_log);
214
215         hbox_filtering_log_level = gtk_hbox_new (FALSE, 8);
216         gtk_widget_show (hbox_filtering_log_level);
217         gtk_box_pack_start(GTK_BOX (vbox1_filtering_log), hbox_filtering_log_level, FALSE, FALSE, 0);
218
219         label_filtering_log_level = gtk_label_new (_("Log level"));
220         gtk_widget_show (label_filtering_log_level);
221         gtk_box_pack_start(GTK_BOX(hbox_filtering_log_level), label_filtering_log_level, FALSE, FALSE, 0);
222
223         optmenu_filtering_log_level = gtkut_sc_combobox_create(NULL, FALSE);
224         gtk_widget_show (optmenu_filtering_log_level);
225         
226         menu = GTK_LIST_STORE(gtk_combo_box_get_model(
227                                 GTK_COMBO_BOX(optmenu_filtering_log_level)));
228         COMBOBOX_ADD (menu, _("Low"), 0);
229         COMBOBOX_ADD (menu, _("Medium"), 1);
230         COMBOBOX_ADD (menu, _("High"), 2);
231
232         gtk_box_pack_start(GTK_BOX(hbox_filtering_log_level), optmenu_filtering_log_level, FALSE, FALSE, 0);
233
234         filtering_log_level_tooltip = gtk_tooltips_new();
235         gtk_tooltips_set_tip(GTK_TOOLTIPS(filtering_log_level_tooltip),
236                              optmenu_filtering_log_level,
237                              _("Select the level of detail of the logging.\n"
238                                 "Choose Low to see when rules are applied, which "
239                                 "conditions match or don't match and what actions are "
240                                 "performed.\n"
241                                 "Choose Medium to see more details about the message "
242                                 "that is being processed, and why rules are skipped.\n"
243                                 "Choose High to explicitly show the reason why all "
244                                 "rules are processed or skipped, and why all conditions "
245                                 "are matched or not matched.\n"
246                                 "Caution: the higher the level, the greater the "
247                                 "impact on performance."),
248                              NULL);
249
250         hbox_clip_filtering_log = gtk_hbox_new (FALSE, 8);
251         gtk_container_add (GTK_CONTAINER (vbox1_filtering_log), hbox_clip_filtering_log);
252         gtk_widget_show (hbox_clip_filtering_log);
253         PACK_CHECK_BUTTON (hbox_clip_filtering_log, checkbtn_clip_filtering_log,
254                            _("Restrict the log window to"));
255         
256         filtering_log_length_tooltip = gtk_tooltips_new();
257
258         spinbtn_filtering_log_length_adj = gtk_adjustment_new (500, 0, G_MAXINT, 1, 10, 10);
259         spinbtn_filtering_log_length = gtk_spin_button_new
260                 (GTK_ADJUSTMENT (spinbtn_filtering_log_length_adj), 1, 0);
261         gtk_widget_show (spinbtn_filtering_log_length);
262         gtk_box_pack_start (GTK_BOX (hbox_clip_filtering_log), spinbtn_filtering_log_length,
263                             FALSE, FALSE, 0);
264         gtk_widget_set_size_request (GTK_WIDGET (spinbtn_filtering_log_length), 64, -1);
265         gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_filtering_log_length), TRUE);
266
267         gtk_tooltips_set_tip(GTK_TOOLTIPS(filtering_log_length_tooltip), spinbtn_filtering_log_length,
268                              _("0 to stop logging in the log window"),
269                              NULL);
270
271         label = gtk_label_new(_("lines"));
272         gtk_widget_show (label);
273         gtk_box_pack_start(GTK_BOX(hbox_clip_filtering_log), label, FALSE, FALSE, 0);
274
275         SET_TOGGLE_SENSITIVITY(checkbtn_clip_filtering_log, spinbtn_filtering_log_length);
276         SET_TOGGLE_SENSITIVITY(checkbtn_clip_filtering_log, label);
277         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, hbox_clip_filtering_log);
278         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, optmenu_filtering_log_level);
279         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, checkbtn_clip_filtering_log);
280         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, label_filtering_log_level);
281
282         /* disk log */
283         vbox_disc_log = gtkut_get_options_frame(vbox1, &frame_disc_log, _("Disc log"));
284
285         label = gtk_label_new(_("Write the following information to disc..."));
286         gtk_widget_show(label);
287         hbox = gtk_hbox_new (FALSE, 8);
288         gtk_container_add (GTK_CONTAINER (vbox_disc_log), hbox);
289         gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 0);
290         gtk_widget_show (hbox);
291
292         hbox_checkbtn = prefs_logging_create_check_buttons(&checkbtn_log_warning,
293                                 _("Warning messages"), &checkbtn_log_standard,
294                                 _("Network protocol messages"));
295         gtk_box_pack_start(GTK_BOX(vbox_disc_log), hbox_checkbtn, FALSE, FALSE, 0);
296
297         hbox_checkbtn = prefs_logging_create_check_buttons(&checkbtn_log_error, 
298                                 _("Error messages"), &checkbtn_log_status,
299                                 _("Status messages for filtering/processing log"));
300         gtk_box_pack_start(GTK_BOX(vbox_disc_log), hbox_checkbtn, FALSE, FALSE, 0);
301
302         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_clip_network_log), 
303                 prefs_common.cliplog);
304         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_clip_filtering_log), 
305                 prefs_common.filtering_debug_cliplog);
306         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_standard), 
307                 prefs_common.enable_log_standard);
308         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_warning), 
309                 prefs_common.enable_log_warning);
310         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_error), 
311                 prefs_common.enable_log_error);
312         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_status), 
313                 prefs_common.enable_log_status);
314         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log), 
315                 prefs_common.enable_filtering_debug);
316         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_inc), 
317                 prefs_common.enable_filtering_debug_inc);
318         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_manual), 
319                 prefs_common.enable_filtering_debug_manual);
320         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_folder_proc), 
321                 prefs_common.enable_filtering_debug_folder_proc);
322         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_pre_proc), 
323                 prefs_common.enable_filtering_debug_pre_proc);
324         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_post_proc), 
325                 prefs_common.enable_filtering_debug_post_proc);
326
327         gtk_spin_button_set_value(GTK_SPIN_BUTTON(spinbtn_network_log_length),
328                 prefs_common.loglength);
329         gtk_spin_button_set_value(GTK_SPIN_BUTTON(spinbtn_filtering_log_length),
330                 prefs_common.filtering_debug_loglength);
331
332         combobox_select_by_data(GTK_COMBO_BOX(optmenu_filtering_log_level),
333                         prefs_common.filtering_debug_level);
334
335         prefs_logging->checkbtn_clip_network_log = checkbtn_clip_network_log;
336         prefs_logging->spinbtn_network_log_length = spinbtn_network_log_length;
337         prefs_logging->checkbtn_log_standard = checkbtn_log_standard;
338         prefs_logging->checkbtn_log_warning = checkbtn_log_warning;
339         prefs_logging->checkbtn_log_error = checkbtn_log_error;
340         prefs_logging->checkbtn_log_status = checkbtn_log_status;
341         prefs_logging->checkbtn_clip_filtering_log = checkbtn_clip_filtering_log;
342         prefs_logging->spinbtn_filtering_log_length = spinbtn_filtering_log_length;
343         prefs_logging->checkbtn_filtering_log = checkbtn_filtering_log;
344         prefs_logging->checkbtn_filtering_log_inc = checkbtn_filtering_log_inc;
345         prefs_logging->checkbtn_filtering_log_manual = checkbtn_filtering_log_manual;
346         prefs_logging->checkbtn_filtering_log_folder_proc = checkbtn_filtering_log_folder_proc;
347         prefs_logging->checkbtn_filtering_log_pre_proc = checkbtn_filtering_log_pre_proc;
348         prefs_logging->checkbtn_filtering_log_post_proc = checkbtn_filtering_log_post_proc;
349         prefs_logging->optmenu_filtering_log_level = optmenu_filtering_log_level;
350
351         prefs_logging->page.widget = vbox1;
352 }
353
354 static void prefs_logging_save(PrefsPage *_page)
355 {
356         LoggingPage *page = (LoggingPage *) _page;
357         MainWindow *mainwindow;
358         gboolean filtering_debug_enabled;
359
360         prefs_common.filtering_debug_level =
361                 combobox_get_active_data(GTK_COMBO_BOX(page->optmenu_filtering_log_level));
362
363         prefs_common.cliplog = gtk_toggle_button_get_active(
364                 GTK_TOGGLE_BUTTON(page->checkbtn_clip_network_log));
365         prefs_common.loglength = gtk_spin_button_get_value_as_int(
366                 GTK_SPIN_BUTTON(page->spinbtn_network_log_length));
367         prefs_common.enable_log_standard = gtk_toggle_button_get_active(
368                 GTK_TOGGLE_BUTTON(page->checkbtn_log_standard));
369         prefs_common.enable_log_warning = gtk_toggle_button_get_active(
370                 GTK_TOGGLE_BUTTON(page->checkbtn_log_warning));
371         prefs_common.enable_log_error = gtk_toggle_button_get_active(
372                 GTK_TOGGLE_BUTTON(page->checkbtn_log_error));
373         prefs_common.enable_log_status = gtk_toggle_button_get_active(
374                 GTK_TOGGLE_BUTTON(page->checkbtn_log_status));
375         prefs_common.filtering_debug_cliplog = gtk_toggle_button_get_active(
376                 GTK_TOGGLE_BUTTON(page->checkbtn_clip_filtering_log));
377         prefs_common.filtering_debug_loglength = gtk_spin_button_get_value_as_int(
378                 GTK_SPIN_BUTTON(page->spinbtn_filtering_log_length));
379         filtering_debug_enabled = prefs_common.enable_filtering_debug;
380         prefs_common.enable_filtering_debug = gtk_toggle_button_get_active(
381                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log));
382         if (filtering_debug_enabled != prefs_common.enable_filtering_debug) {
383                 if (prefs_common.enable_filtering_debug)
384                         log_message(LOG_DEBUG_FILTERING, _("filtering log enabled\n"));
385                 else
386                         log_message(LOG_DEBUG_FILTERING, _("filtering log disabled\n"));
387         }
388         prefs_common.enable_filtering_debug_inc = gtk_toggle_button_get_active(
389                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_inc));
390         prefs_common.enable_filtering_debug_manual = gtk_toggle_button_get_active(
391                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_manual));
392         prefs_common.enable_filtering_debug_folder_proc = gtk_toggle_button_get_active(
393                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_folder_proc));
394         prefs_common.enable_filtering_debug_pre_proc = gtk_toggle_button_get_active(
395                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_pre_proc));
396         prefs_common.enable_filtering_debug_post_proc = gtk_toggle_button_get_active(
397                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_post_proc));
398
399         mainwindow = mainwindow_get_mainwindow();
400         log_window_set_clipping(mainwindow->logwin, prefs_common.cliplog,
401                                 prefs_common.loglength);
402         log_window_set_clipping(mainwindow->filtering_debugwin, prefs_common.filtering_debug_cliplog,
403                                 prefs_common.filtering_debug_loglength);
404 }
405
406 static void prefs_logging_destroy_widget(PrefsPage *_page)
407 {
408 }
409
410 LoggingPage *prefs_logging;
411
412 void prefs_logging_init(void)
413 {
414         LoggingPage *page;
415         static gchar *path[3];
416
417         path[0] = _("Other");
418         path[1] = _("Logging");
419         path[2] = NULL;
420
421         page = g_new0(LoggingPage, 1);
422         page->page.path = path;
423         page->page.create_widget = prefs_logging_create_widget;
424         page->page.destroy_widget = prefs_logging_destroy_widget;
425         page->page.save_page = prefs_logging_save;
426         page->page.weight = 5.0;
427         prefs_gtk_register_page((PrefsPage *) page);
428         prefs_logging = page;
429 }
430
431 void prefs_logging_done(void)
432 {
433         prefs_gtk_unregister_page((PrefsPage *) prefs_logging);
434         g_free(prefs_logging);
435 }