2008-08-27 [colin] 3.5.0cvs76
[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_get_child(GTK_BIN((*checkbtn1)))), TRUE);
79
80         PACK_CHECK_BUTTON (hbox_checkbtn, *checkbtn2, label2);
81         gtk_label_set_line_wrap(GTK_LABEL(gtk_bin_get_child(GTK_BIN((*checkbtn2)))), 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         GtkWidget *vbox1_filtering_log;
100         GtkWidget *hbox_clip_filtering_log;
101         GtkWidget *checkbtn_clip_filtering_log;
102         GtkWidget *spinbtn_filtering_log_length;
103         GtkObject *spinbtn_filtering_log_length_adj;
104         GtkWidget *hbox_filtering_log;
105         GtkWidget *checkbtn_filtering_log;
106         GtkWidget *frame_filtering_log;
107         GtkWidget *vbox2_filtering_log;
108         GtkWidget *hbox_checkbtn;
109         GtkWidget *checkbtn_filtering_log_inc;
110         GtkWidget *checkbtn_filtering_log_manual;
111         GtkWidget *checkbtn_filtering_log_folder_proc;
112         GtkWidget *checkbtn_filtering_log_pre_proc;
113         GtkWidget *checkbtn_filtering_log_post_proc;
114         GtkWidget *hbox_filtering_log_level;
115         GtkWidget *label_filtering_log_level;
116         GtkWidget *optmenu_filtering_log_level;
117         GtkListStore *menu;
118         GtkTreeIter iter;
119         GtkWidget *frame_disk_log;
120         GtkWidget *vbox_disk_log;
121         GtkWidget *label;
122         GtkWidget *hbox;
123         GtkWidget *checkbtn_log_standard;
124         GtkWidget *checkbtn_log_warning;
125         GtkWidget *checkbtn_log_error;
126         GtkWidget *checkbtn_log_status;
127         GtkSizeGroup *log_size_group;
128         GtkSizeGroup *filter_size_group;
129         CLAWS_TIP_DECL();
130         
131         vbox1 = gtk_vbox_new (FALSE, VSPACING);
132         gtk_widget_show (vbox1);
133         gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
134
135         /* Protocol log */
136         vbox_network_log = gtkut_get_options_frame(vbox1, &frame_logging, _("Network log"));
137
138         hbox_clip_network_log = gtk_hbox_new (FALSE, 8);
139         gtk_container_add (GTK_CONTAINER (vbox_network_log), hbox_clip_network_log);
140         gtk_widget_show (hbox_clip_network_log);
141
142         PACK_CHECK_BUTTON (hbox_clip_network_log, checkbtn_clip_network_log,
143                            _("Restrict the log window to"));
144         
145         spinbtn_network_log_length_adj = gtk_adjustment_new (500, 0, G_MAXINT, 1, 10, 10);
146         spinbtn_network_log_length = gtk_spin_button_new
147                 (GTK_ADJUSTMENT (spinbtn_network_log_length_adj), 1, 0);
148         gtk_widget_show (spinbtn_network_log_length);
149         gtk_box_pack_start (GTK_BOX (hbox_clip_network_log), spinbtn_network_log_length,
150                             FALSE, FALSE, 0);
151         gtk_widget_set_size_request (GTK_WIDGET (spinbtn_network_log_length), 64, -1);
152         gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_network_log_length), TRUE);
153
154         CLAWS_SET_TIP(spinbtn_network_log_length,
155                              _("0 to stop logging in the log window"));
156
157         label = gtk_label_new(_("lines"));
158         gtk_widget_show (label);
159         gtk_box_pack_start(GTK_BOX(hbox_clip_network_log), label, FALSE, FALSE, 0);
160
161         SET_TOGGLE_SENSITIVITY(checkbtn_clip_network_log, spinbtn_network_log_length);
162         SET_TOGGLE_SENSITIVITY(checkbtn_clip_network_log, label);
163
164         /* Filtering/processing debug log */
165         vbox1_filtering_log = gtkut_get_options_frame(vbox1,
166                                 &frame_logging, _("Filtering/processing log"));
167
168         PACK_CHECK_BUTTON (vbox1_filtering_log, checkbtn_filtering_log,
169                            _("Enable logging of filtering/processing rules"));
170         hbox_filtering_log = gtk_hbox_new (FALSE, 8);
171         gtk_container_add (GTK_CONTAINER (vbox1_filtering_log), hbox_filtering_log);
172         gtk_widget_show (hbox_filtering_log);
173
174         CLAWS_SET_TIP(checkbtn_filtering_log,
175                              _("If checked, turns on logging of filtering and processing rules.\n"
176                                 "The log is accessible from 'Tools/Filtering log'.\n"
177                                 "Caution: enabling this option will slow down the filtering/processing, "
178                                 "this might be critical when applying many rules upon thousands of "
179                                 "messages."));
180
181         vbox2_filtering_log = gtkut_get_options_frame(vbox1_filtering_log, &frame_filtering_log,
182                                                         _("Log filtering/processing when..."));
183
184         hbox_checkbtn = prefs_logging_create_check_buttons(
185                                                 &checkbtn_filtering_log_inc,
186                                                 _("filtering at incorporation"),
187                                                 &checkbtn_filtering_log_pre_proc,
188                                                 _("pre-processing folders"));
189         gtk_box_pack_start(GTK_BOX(vbox2_filtering_log), hbox_checkbtn, FALSE, FALSE, 0);
190
191         hbox_checkbtn = prefs_logging_create_check_buttons(
192                                                 &checkbtn_filtering_log_manual,
193                                                 _("manually filtering"),
194                                                 &checkbtn_filtering_log_post_proc,
195                                                 _("post-processing folders"));
196         gtk_box_pack_start(GTK_BOX(vbox2_filtering_log), hbox_checkbtn, FALSE, FALSE, 0);
197         
198         hbox_checkbtn = gtk_hbox_new(TRUE, VBOX_BORDER);
199         gtk_widget_show(hbox_checkbtn);
200         gtk_box_pack_start(GTK_BOX(vbox2_filtering_log), hbox_checkbtn, FALSE, FALSE, 0);
201         PACK_CHECK_BUTTON (hbox_checkbtn, checkbtn_filtering_log_folder_proc,
202                            _("processing folders"));
203         gtk_box_pack_start(GTK_BOX(hbox_checkbtn), gtk_label_new(""),
204                            FALSE, TRUE, 0);
205
206         filter_size_group = gtk_size_group_new(GTK_SIZE_GROUP_HORIZONTAL);
207         gtk_size_group_add_widget(filter_size_group, checkbtn_filtering_log_inc);
208         gtk_size_group_add_widget(filter_size_group, checkbtn_filtering_log_manual);
209         gtk_size_group_add_widget(filter_size_group, checkbtn_filtering_log_folder_proc);
210
211         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, frame_filtering_log);
212
213         hbox_filtering_log_level = gtk_hbox_new (FALSE, 8);
214         gtk_widget_show (hbox_filtering_log_level);
215         gtk_box_pack_start(GTK_BOX (vbox1_filtering_log), hbox_filtering_log_level, FALSE, FALSE, 0);
216
217         label_filtering_log_level = gtk_label_new (_("Log level"));
218         gtk_widget_show (label_filtering_log_level);
219         gtk_box_pack_start(GTK_BOX(hbox_filtering_log_level), label_filtering_log_level, FALSE, FALSE, 0);
220
221         optmenu_filtering_log_level = gtkut_sc_combobox_create(NULL, FALSE);
222         gtk_widget_show (optmenu_filtering_log_level);
223         
224         menu = GTK_LIST_STORE(gtk_combo_box_get_model(
225                                 GTK_COMBO_BOX(optmenu_filtering_log_level)));
226         COMBOBOX_ADD (menu, _("Low"), 0);
227         COMBOBOX_ADD (menu, _("Medium"), 1);
228         COMBOBOX_ADD (menu, _("High"), 2);
229
230         gtk_box_pack_start(GTK_BOX(hbox_filtering_log_level), optmenu_filtering_log_level, FALSE, FALSE, 0);
231
232         CLAWS_SET_TIP(optmenu_filtering_log_level,
233                              _("Select the level of detail of the logging.\n"
234                                 "Choose Low to see when rules are applied, which "
235                                 "conditions match or don't match and what actions are "
236                                 "performed.\n"
237                                 "Choose Medium to see more details about the message "
238                                 "that is being processed, and why rules are skipped.\n"
239                                 "Choose High to explicitly show the reason why all "
240                                 "rules are processed or skipped, and why all conditions "
241                                 "are matched or not matched.\n"
242                                 "Caution: the higher the level, the greater the "
243                                 "impact on performance."));
244
245         hbox_clip_filtering_log = gtk_hbox_new (FALSE, 8);
246         gtk_container_add (GTK_CONTAINER (vbox1_filtering_log), hbox_clip_filtering_log);
247         gtk_widget_show (hbox_clip_filtering_log);
248         PACK_CHECK_BUTTON (hbox_clip_filtering_log, checkbtn_clip_filtering_log,
249                            _("Restrict the log window to"));
250         
251         spinbtn_filtering_log_length_adj = gtk_adjustment_new (500, 0, G_MAXINT, 1, 10, 10);
252         spinbtn_filtering_log_length = gtk_spin_button_new
253                 (GTK_ADJUSTMENT (spinbtn_filtering_log_length_adj), 1, 0);
254         gtk_widget_show (spinbtn_filtering_log_length);
255         gtk_box_pack_start (GTK_BOX (hbox_clip_filtering_log), spinbtn_filtering_log_length,
256                             FALSE, FALSE, 0);
257         gtk_widget_set_size_request (GTK_WIDGET (spinbtn_filtering_log_length), 64, -1);
258         gtk_spin_button_set_numeric (GTK_SPIN_BUTTON (spinbtn_filtering_log_length), TRUE);
259
260         CLAWS_SET_TIP(spinbtn_filtering_log_length,
261                              _("0 to stop logging in the log window"));
262
263         label = gtk_label_new(_("lines"));
264         gtk_widget_show (label);
265         gtk_box_pack_start(GTK_BOX(hbox_clip_filtering_log), label, FALSE, FALSE, 0);
266
267         SET_TOGGLE_SENSITIVITY(checkbtn_clip_filtering_log, spinbtn_filtering_log_length);
268         SET_TOGGLE_SENSITIVITY(checkbtn_clip_filtering_log, label);
269         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, hbox_clip_filtering_log);
270         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, optmenu_filtering_log_level);
271         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, checkbtn_clip_filtering_log);
272         SET_TOGGLE_SENSITIVITY(checkbtn_filtering_log, label_filtering_log_level);
273
274         /* disk log */
275         vbox_disk_log = gtkut_get_options_frame(vbox1, &frame_disk_log, _("Disk log"));
276
277         label = gtk_label_new(_("Write the following information to disk..."));
278         gtk_widget_show(label);
279         hbox = gtk_hbox_new (FALSE, 8);
280         gtk_container_add (GTK_CONTAINER (vbox_disk_log), hbox);
281         gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 0);
282         gtk_widget_show (hbox);
283
284         hbox_checkbtn = prefs_logging_create_check_buttons(&checkbtn_log_warning,
285                                 _("Warning messages"), &checkbtn_log_standard,
286                                 _("Network protocol messages"));
287         gtk_box_pack_start(GTK_BOX(vbox_disk_log), hbox_checkbtn, FALSE, FALSE, 0);
288
289         hbox_checkbtn = prefs_logging_create_check_buttons(&checkbtn_log_error, 
290                                 _("Error messages"), &checkbtn_log_status,
291                                 _("Status messages for filtering/processing log"));
292         gtk_box_pack_start(GTK_BOX(vbox_disk_log), hbox_checkbtn, FALSE, FALSE, 0);
293         
294         log_size_group = gtk_size_group_new(GTK_SIZE_GROUP_HORIZONTAL);
295         gtk_size_group_add_widget(log_size_group, checkbtn_log_warning);
296         gtk_size_group_add_widget(log_size_group, checkbtn_log_error);
297
298         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_clip_network_log), 
299                 prefs_common.cliplog);
300         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_clip_filtering_log), 
301                 prefs_common.filtering_debug_cliplog);
302         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_standard), 
303                 prefs_common.enable_log_standard);
304         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_warning), 
305                 prefs_common.enable_log_warning);
306         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_error), 
307                 prefs_common.enable_log_error);
308         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_log_status), 
309                 prefs_common.enable_log_status);
310         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log), 
311                 prefs_common.enable_filtering_debug);
312         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_inc), 
313                 prefs_common.enable_filtering_debug_inc);
314         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_manual), 
315                 prefs_common.enable_filtering_debug_manual);
316         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_folder_proc), 
317                 prefs_common.enable_filtering_debug_folder_proc);
318         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_pre_proc), 
319                 prefs_common.enable_filtering_debug_pre_proc);
320         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(checkbtn_filtering_log_post_proc), 
321                 prefs_common.enable_filtering_debug_post_proc);
322
323         gtk_spin_button_set_value(GTK_SPIN_BUTTON(spinbtn_network_log_length),
324                 prefs_common.loglength);
325         gtk_spin_button_set_value(GTK_SPIN_BUTTON(spinbtn_filtering_log_length),
326                 prefs_common.filtering_debug_loglength);
327
328         combobox_select_by_data(GTK_COMBO_BOX(optmenu_filtering_log_level),
329                         prefs_common.filtering_debug_level);
330
331         prefs_logging->checkbtn_clip_network_log = checkbtn_clip_network_log;
332         prefs_logging->spinbtn_network_log_length = spinbtn_network_log_length;
333         prefs_logging->checkbtn_log_standard = checkbtn_log_standard;
334         prefs_logging->checkbtn_log_warning = checkbtn_log_warning;
335         prefs_logging->checkbtn_log_error = checkbtn_log_error;
336         prefs_logging->checkbtn_log_status = checkbtn_log_status;
337         prefs_logging->checkbtn_clip_filtering_log = checkbtn_clip_filtering_log;
338         prefs_logging->spinbtn_filtering_log_length = spinbtn_filtering_log_length;
339         prefs_logging->checkbtn_filtering_log = checkbtn_filtering_log;
340         prefs_logging->checkbtn_filtering_log_inc = checkbtn_filtering_log_inc;
341         prefs_logging->checkbtn_filtering_log_manual = checkbtn_filtering_log_manual;
342         prefs_logging->checkbtn_filtering_log_folder_proc = checkbtn_filtering_log_folder_proc;
343         prefs_logging->checkbtn_filtering_log_pre_proc = checkbtn_filtering_log_pre_proc;
344         prefs_logging->checkbtn_filtering_log_post_proc = checkbtn_filtering_log_post_proc;
345         prefs_logging->optmenu_filtering_log_level = optmenu_filtering_log_level;
346
347         prefs_logging->page.widget = vbox1;
348 }
349
350 static void prefs_logging_save(PrefsPage *_page)
351 {
352         LoggingPage *page = (LoggingPage *) _page;
353         MainWindow *mainwindow;
354         gboolean filtering_debug_enabled;
355
356         prefs_common.filtering_debug_level =
357                 combobox_get_active_data(GTK_COMBO_BOX(page->optmenu_filtering_log_level));
358
359         prefs_common.cliplog = gtk_toggle_button_get_active(
360                 GTK_TOGGLE_BUTTON(page->checkbtn_clip_network_log));
361         prefs_common.loglength = gtk_spin_button_get_value_as_int(
362                 GTK_SPIN_BUTTON(page->spinbtn_network_log_length));
363         prefs_common.enable_log_standard = gtk_toggle_button_get_active(
364                 GTK_TOGGLE_BUTTON(page->checkbtn_log_standard));
365         prefs_common.enable_log_warning = gtk_toggle_button_get_active(
366                 GTK_TOGGLE_BUTTON(page->checkbtn_log_warning));
367         prefs_common.enable_log_error = gtk_toggle_button_get_active(
368                 GTK_TOGGLE_BUTTON(page->checkbtn_log_error));
369         prefs_common.enable_log_status = gtk_toggle_button_get_active(
370                 GTK_TOGGLE_BUTTON(page->checkbtn_log_status));
371         prefs_common.filtering_debug_cliplog = gtk_toggle_button_get_active(
372                 GTK_TOGGLE_BUTTON(page->checkbtn_clip_filtering_log));
373         prefs_common.filtering_debug_loglength = gtk_spin_button_get_value_as_int(
374                 GTK_SPIN_BUTTON(page->spinbtn_filtering_log_length));
375         filtering_debug_enabled = prefs_common.enable_filtering_debug;
376         prefs_common.enable_filtering_debug = gtk_toggle_button_get_active(
377                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log));
378         if (filtering_debug_enabled != prefs_common.enable_filtering_debug) {
379                 if (prefs_common.enable_filtering_debug)
380                         log_message(LOG_DEBUG_FILTERING, _("filtering log enabled\n"));
381                 else
382                         log_message(LOG_DEBUG_FILTERING, _("filtering log disabled\n"));
383         }
384         prefs_common.enable_filtering_debug_inc = gtk_toggle_button_get_active(
385                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_inc));
386         prefs_common.enable_filtering_debug_manual = gtk_toggle_button_get_active(
387                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_manual));
388         prefs_common.enable_filtering_debug_folder_proc = gtk_toggle_button_get_active(
389                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_folder_proc));
390         prefs_common.enable_filtering_debug_pre_proc = gtk_toggle_button_get_active(
391                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_pre_proc));
392         prefs_common.enable_filtering_debug_post_proc = gtk_toggle_button_get_active(
393                 GTK_TOGGLE_BUTTON(page->checkbtn_filtering_log_post_proc));
394
395         mainwindow = mainwindow_get_mainwindow();
396         log_window_set_clipping(mainwindow->logwin, prefs_common.cliplog,
397                                 prefs_common.loglength);
398         log_window_set_clipping(mainwindow->filtering_debugwin, prefs_common.filtering_debug_cliplog,
399                                 prefs_common.filtering_debug_loglength);
400 }
401
402 static void prefs_logging_destroy_widget(PrefsPage *_page)
403 {
404 }
405
406 LoggingPage *prefs_logging;
407
408 void prefs_logging_init(void)
409 {
410         LoggingPage *page;
411         static gchar *path[3];
412
413         path[0] = _("Other");
414         path[1] = _("Logging");
415         path[2] = NULL;
416
417         page = g_new0(LoggingPage, 1);
418         page->page.path = path;
419         page->page.create_widget = prefs_logging_create_widget;
420         page->page.destroy_widget = prefs_logging_destroy_widget;
421         page->page.save_page = prefs_logging_save;
422         page->page.weight = 5.0;
423         prefs_gtk_register_page((PrefsPage *) page);
424         prefs_logging = page;
425 }
426
427 void prefs_logging_done(void)
428 {
429         prefs_gtk_unregister_page((PrefsPage *) prefs_logging);
430         g_free(prefs_logging);
431 }