2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2012 Colin Leroy <colin@colino.net> and
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.
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, see <http://www.gnu.org/licenses/>.
23 #include "claws-features.h"
29 #include <glib/gi18n.h>
31 #include "gtk/gtkutils.h"
33 #include "common/claws.h"
34 #include "common/version.h"
36 #include "common/utils.h"
39 #include "prefs_gtk.h"
40 #include "foldersel.h"
41 #include "statusbar.h"
42 #include "bogofilter.h"
44 #include "addressbook.h"
51 GtkWidget *process_emails;
52 GtkWidget *receive_spam;
53 GtkWidget *save_folder;
54 GtkWidget *save_folder_select;
55 GtkWidget *save_unsure;
56 GtkWidget *save_unsure_folder;
57 GtkWidget *save_unsure_folder_select;
58 GtkWidget *insert_header;
61 GtkWidget *whitelist_ab;
62 GtkWidget *whitelist_ab_folder_combo;
63 GtkWidget *learn_from_whitelist_chkbtn;
64 GtkWidget *mark_as_read;
67 static void foldersel_cb(GtkWidget *widget, gpointer data)
69 GtkWidget *entry = (GtkWidget *) data;
74 item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL, FALSE);
75 if (item && (item_id = folder_item_get_identifier(item)) != NULL) {
76 gtk_editable_delete_text(GTK_EDITABLE(entry), 0, -1);
77 gtk_editable_insert_text(GTK_EDITABLE(entry), item_id, strlen(item_id), &newpos);
82 static void spam_handle_combobox_callback(GtkWidget *widget, gpointer user_data)
84 GtkWidget *hbox = GTK_WIDGET(user_data);
86 if (gtk_combo_box_get_active(GTK_COMBO_BOX(widget)) == 1) {
87 gtk_widget_set_sensitive(hbox, TRUE);
89 gtk_widget_set_sensitive(hbox, FALSE);
93 #ifndef USE_NEW_ADDRBOOK
94 static void bogofilter_whitelist_ab_select_cb(GtkWidget *widget, gpointer data)
96 struct BogofilterPage *page = (struct BogofilterPage *) data;
97 const gchar *folderpath = NULL;
98 gchar *new_path = NULL;
100 folderpath = gtk_entry_get_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))));
101 new_path = addressbook_folder_selection(folderpath);
103 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))), new_path);
109 static void bogofilter_create_widget_func(PrefsPage * _page,
113 struct BogofilterPage *page = (struct BogofilterPage *) _page;
114 BogofilterConfig *config;
116 GtkWidget *vbox1, *vbox2;
117 GtkWidget *hbox_max_size;
118 GtkWidget *hbox_process_emails, *hbox_save_spam, *hbox_save_unsure;
119 GtkWidget *hbox_bogopath, *hbox_whitelist;
120 GtkWidget *hbox_mark_as_read;
122 GtkWidget *max_size_label;
123 GtkAdjustment *max_size_spinbtn_adj;
124 GtkWidget *max_size_spinbtn;
125 GtkWidget *max_size_kb_label;
127 GtkWidget *process_emails_checkbtn;
129 GtkWidget *spam_handle_combobox;
130 GtkWidget *save_spam_folder_entry;
131 GtkWidget *save_spam_folder_select;
133 GtkWidget *save_unsure_checkbtn;
134 GtkWidget *save_unsure_folder_entry;
135 GtkWidget *save_unsure_folder_select;
137 GtkWidget *insert_header_checkbtn;
138 GtkWidget *whitelist_ab_checkbtn;
139 GtkWidget *learn_from_whitelist_chkbtn;
140 GtkWidget *bogopath_label;
141 GtkWidget *bogopath_entry;
143 GtkWidget *mark_as_read_checkbtn;
145 GtkWidget *whitelist_ab_folder_combo;
146 GtkWidget *whitelist_ab_select_btn;
148 vbox1 = gtk_vbox_new (FALSE, VSPACING);
149 gtk_widget_show (vbox1);
150 gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
152 vbox2 = gtk_vbox_new (FALSE, 4);
153 gtk_widget_show (vbox2);
154 gtk_box_pack_start (GTK_BOX (vbox1), vbox2, FALSE, FALSE, 0);
156 hbox_process_emails = gtk_hbox_new(FALSE, 8);
157 gtk_widget_show(hbox_process_emails);
158 gtk_box_pack_start (GTK_BOX (vbox2), hbox_process_emails, TRUE, TRUE, 0);
160 process_emails_checkbtn = gtk_check_button_new_with_label(
161 _("Process messages on receiving"));
162 gtk_widget_show(process_emails_checkbtn);
163 gtk_box_pack_start(GTK_BOX(hbox_process_emails), process_emails_checkbtn, TRUE, TRUE, 0);
165 hbox_max_size = gtk_hbox_new(FALSE, 8);
166 gtk_widget_show(hbox_max_size);
167 gtk_box_pack_start (GTK_BOX (vbox2), hbox_max_size, TRUE, TRUE, 0);
169 max_size_label = gtk_label_new(_("Maximum size"));
170 gtk_widget_show(max_size_label);
171 gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_label, FALSE, FALSE, 0);
173 max_size_spinbtn_adj = GTK_ADJUSTMENT(gtk_adjustment_new(250, 0, 10000, 10, 10, 0));
174 max_size_spinbtn = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_spinbtn_adj), 1, 0);
175 gtk_widget_show(max_size_spinbtn);
176 gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_spinbtn, FALSE, FALSE, 0);
177 CLAWS_SET_TIP(max_size_spinbtn,
178 _("Messages larger than this will not be checked"));
179 gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size_spinbtn), TRUE);
181 max_size_kb_label = gtk_label_new(_("KB"));
182 gtk_widget_show(max_size_kb_label);
183 gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_kb_label, FALSE, FALSE, 0);
185 hbox_save_spam = gtk_hbox_new(FALSE, 8);
186 gtk_widget_show(hbox_save_spam);
187 gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_spam, TRUE, TRUE, 0);
189 #if !GTK_CHECK_VERSION(2, 24, 0)
190 spam_handle_combobox = gtk_combo_box_new_text();
192 spam_handle_combobox = gtk_combo_box_text_new();
195 #if !GTK_CHECK_VERSION(2, 24, 0)
196 gtk_combo_box_append_text(GTK_COMBO_BOX(spam_handle_combobox),
198 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(spam_handle_combobox),
202 #if !GTK_CHECK_VERSION(2, 24, 0)
203 gtk_combo_box_append_text(GTK_COMBO_BOX(spam_handle_combobox),
205 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(spam_handle_combobox),
207 _("Save spam in..."));
209 #if !GTK_CHECK_VERSION(2, 24, 0)
210 gtk_combo_box_append_text(GTK_COMBO_BOX(spam_handle_combobox),
212 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(spam_handle_combobox),
214 _("Only mark as spam"));
216 gtk_widget_show(spam_handle_combobox);
217 gtk_box_pack_start(GTK_BOX(hbox_save_spam), spam_handle_combobox, FALSE, FALSE, 0);
219 GtkWidget *hbox = gtk_hbox_new(FALSE, 8);
220 gtk_widget_show(hbox);
221 gtk_box_pack_start (GTK_BOX (hbox_save_spam), hbox, TRUE, TRUE, 0);
223 save_spam_folder_entry = gtk_entry_new();
224 gtk_widget_show (save_spam_folder_entry);
225 gtk_box_pack_start (GTK_BOX (hbox), save_spam_folder_entry, TRUE, TRUE, 0);
226 CLAWS_SET_TIP(save_spam_folder_entry,
227 _("Folder for storing identified spam. Leave empty to use the trash folder."));
229 save_spam_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
230 gtk_widget_show (save_spam_folder_select);
231 gtk_box_pack_start (GTK_BOX (hbox), save_spam_folder_select, FALSE, FALSE, 0);
232 CLAWS_SET_TIP(save_spam_folder_select,
233 _("Click this button to select a folder for storing spam"));
235 g_signal_connect(G_OBJECT(spam_handle_combobox), "changed",
236 G_CALLBACK(spam_handle_combobox_callback), (gpointer)hbox);
238 hbox_save_unsure = gtk_hbox_new(FALSE, 8);
239 gtk_widget_show(hbox_save_unsure);
240 gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_unsure, TRUE, TRUE, 0);
242 save_unsure_checkbtn = gtk_check_button_new_with_label(_("When unsure, move to"));
243 gtk_widget_show(save_unsure_checkbtn);
244 gtk_box_pack_start(GTK_BOX(hbox_save_unsure), save_unsure_checkbtn, FALSE, FALSE, 0);
246 save_unsure_folder_entry = gtk_entry_new();
247 gtk_widget_show (save_unsure_folder_entry);
248 gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_entry, TRUE, TRUE, 0);
249 CLAWS_SET_TIP(save_unsure_folder_entry,
250 _("Folder for storing mail for which spam status is Unsure. Leave empty to use the Inbox folder."));
252 save_unsure_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
253 gtk_widget_show (save_unsure_folder_select);
254 gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_select, FALSE, FALSE, 0);
255 CLAWS_SET_TIP(save_unsure_folder_select,
256 _("Click this button to select a folder for storing Unsure mails."));
258 insert_header_checkbtn = gtk_check_button_new_with_label(_("Insert X-Bogosity header"));
259 gtk_widget_show(insert_header_checkbtn);
260 gtk_box_pack_start(GTK_BOX(vbox2), insert_header_checkbtn, FALSE, FALSE, 0);
261 CLAWS_SET_TIP(insert_header_checkbtn,
262 _("Only done for messages in MH folders"));
264 hbox_whitelist = gtk_hbox_new(FALSE, 8);
265 gtk_widget_show(hbox_whitelist);
266 gtk_box_pack_start (GTK_BOX (vbox2), hbox_whitelist, TRUE, TRUE, 0);
268 whitelist_ab_checkbtn = gtk_check_button_new_with_label(_("Whitelist senders found in address book/folder"));
269 gtk_widget_show(whitelist_ab_checkbtn);
270 gtk_box_pack_start(GTK_BOX(hbox_whitelist), whitelist_ab_checkbtn, FALSE, FALSE, 0);
271 CLAWS_SET_TIP(whitelist_ab_checkbtn,
272 _("Messages coming from your address book contacts will be received in the normal folder even if detected as spam"));
274 whitelist_ab_folder_combo = combobox_text_new(TRUE, _("Any"), NULL);
275 gtk_widget_set_size_request(whitelist_ab_folder_combo, 100, -1);
276 gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_folder_combo, TRUE, TRUE, 0);
278 whitelist_ab_select_btn = gtk_button_new_with_label(_("Select..."));
279 gtk_widget_show (whitelist_ab_select_btn);
280 gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_select_btn, FALSE, FALSE, 0);
281 CLAWS_SET_TIP(whitelist_ab_select_btn,
282 _("Click this button to select a book or folder in the address book"));
284 learn_from_whitelist_chkbtn = gtk_check_button_new_with_label(_("Learn whitelisted emails as ham"));
285 CLAWS_SET_TIP(learn_from_whitelist_chkbtn,
286 _("If Bogofilter thought an email was spam or unsure, but it was whitelisted, "
287 "learn it as ham."));
288 gtk_widget_show(learn_from_whitelist_chkbtn);
289 gtk_box_pack_start (GTK_BOX (vbox2), learn_from_whitelist_chkbtn, TRUE, TRUE, 0);
291 hbox_bogopath = gtk_hbox_new(FALSE, 8);
292 gtk_widget_show(hbox_bogopath);
293 gtk_box_pack_start (GTK_BOX (vbox2), hbox_bogopath, FALSE, FALSE, 0);
295 bogopath_label = gtk_label_new(_("Bogofilter call"));
296 gtk_widget_show(bogopath_label);
297 gtk_box_pack_start(GTK_BOX(hbox_bogopath), bogopath_label, FALSE, FALSE, 0);
299 bogopath_entry = gtk_entry_new();
300 gtk_widget_show(bogopath_entry);
301 gtk_box_pack_start(GTK_BOX(hbox_bogopath), bogopath_entry, FALSE, FALSE, 0);
302 CLAWS_SET_TIP(bogopath_entry,
303 _("Path to bogofilter executable"));
305 hbox_mark_as_read = gtk_hbox_new(FALSE, 8);
306 gtk_widget_show(hbox_mark_as_read);
307 gtk_box_pack_start (GTK_BOX (vbox2), hbox_mark_as_read, TRUE, TRUE, 0);
309 mark_as_read_checkbtn = gtk_check_button_new_with_label(_("Mark spam as read"));
310 gtk_widget_show(mark_as_read_checkbtn);
311 gtk_box_pack_start(GTK_BOX(hbox_mark_as_read), mark_as_read_checkbtn, FALSE, FALSE, 0);
313 SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_entry);
314 SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_select);
315 SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_folder_combo);
316 #ifndef USE_NEW_ADDRBOOK
317 SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_select_btn);
319 SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, learn_from_whitelist_chkbtn);
321 config = bogofilter_get_config();
323 g_signal_connect(G_OBJECT(save_spam_folder_select), "clicked",
324 G_CALLBACK(foldersel_cb), save_spam_folder_entry);
325 g_signal_connect(G_OBJECT(save_unsure_folder_select), "clicked",
326 G_CALLBACK(foldersel_cb), save_unsure_folder_entry);
327 #ifndef USE_NEW_ADDRBOOK
328 g_signal_connect(G_OBJECT (whitelist_ab_select_btn), "clicked",
329 G_CALLBACK(bogofilter_whitelist_ab_select_cb), page);
331 gtk_widget_set_sensitive(GTK_WIDGET(whitelist_ab_select_btn), FALSE);
333 gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size_spinbtn), (float) config->max_size);
334 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(process_emails_checkbtn), config->process_emails);
335 gtk_combo_box_set_active(GTK_COMBO_BOX(spam_handle_combobox), config->receive_spam);
336 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_unsure_checkbtn), config->save_unsure);
337 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(insert_header_checkbtn), config->insert_header);
338 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(whitelist_ab_checkbtn), config->whitelist_ab);
339 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(learn_from_whitelist_chkbtn), config->learn_from_whitelist);
340 if (config->whitelist_ab_folder != NULL) {
341 /* translate "Any" (stored UNtranslated) */
342 if (strcasecmp(config->whitelist_ab_folder, "Any") == 0)
343 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
344 config->whitelist_ab_folder);
346 /* backward compatibility (when translated "Any" was stored) */
347 if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0)
348 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
349 config->whitelist_ab_folder);
351 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
352 config->whitelist_ab_folder);
354 if (config->save_folder != NULL)
355 gtk_entry_set_text(GTK_ENTRY(save_spam_folder_entry), config->save_folder);
356 if (config->save_unsure_folder != NULL)
357 gtk_entry_set_text(GTK_ENTRY(save_unsure_folder_entry), config->save_unsure_folder);
358 if (config->bogopath != NULL)
359 gtk_entry_set_text(GTK_ENTRY(bogopath_entry), config->bogopath);
360 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mark_as_read_checkbtn), config->mark_as_read);
362 page->max_size = max_size_spinbtn;
363 page->process_emails = process_emails_checkbtn;
365 page->receive_spam = spam_handle_combobox;
366 page->save_folder = save_spam_folder_entry;
367 page->save_folder_select = save_spam_folder_select;
369 page->save_unsure = save_unsure_checkbtn;
370 page->save_unsure_folder = save_unsure_folder_entry;
371 page->save_unsure_folder_select = save_unsure_folder_select;
373 page->insert_header = insert_header_checkbtn;
374 page->whitelist_ab = whitelist_ab_checkbtn;
375 page->whitelist_ab_folder_combo = whitelist_ab_folder_combo;
376 page->learn_from_whitelist_chkbtn = learn_from_whitelist_chkbtn;
377 page->bogopath = bogopath_entry;
379 page->mark_as_read = mark_as_read_checkbtn;
381 page->page.widget = vbox1;
384 static void bogofilter_destroy_widget_func(PrefsPage *_page)
386 debug_print("Destroying Bogofilter widget\n");
389 static void bogofilter_save_func(PrefsPage *_page)
391 struct BogofilterPage *page = (struct BogofilterPage *) _page;
392 BogofilterConfig *config;
394 debug_print("Saving Bogofilter Page\n");
396 config = bogofilter_get_config();
399 config->process_emails = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->process_emails));
402 config->receive_spam = gtk_combo_box_get_active(GTK_COMBO_BOX(page->receive_spam));
405 g_free(config->save_folder);
406 config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
409 config->save_unsure = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->save_unsure));
411 /* save_unsure_folder */
412 g_free(config->save_unsure_folder);
413 config->save_unsure_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_unsure_folder), 0, -1);
416 config->insert_header = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->insert_header));
419 config->whitelist_ab = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->whitelist_ab));
420 g_free(config->whitelist_ab_folder);
421 config->whitelist_ab_folder = gtk_editable_get_chars(
422 GTK_EDITABLE(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))), 0, -1);
423 /* store UNtranslated "Any" */
424 if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0) {
425 g_free(config->whitelist_ab_folder);
426 config->whitelist_ab_folder = g_strdup("Any");
429 /* learn_from_whitelist_chkbtn */
430 config->learn_from_whitelist = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->learn_from_whitelist_chkbtn));
433 g_free(config->bogopath);
434 config->bogopath = gtk_editable_get_chars(GTK_EDITABLE(page->bogopath), 0, -1);
437 config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
440 config->mark_as_read = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->mark_as_read));
442 if (config->process_emails) {
443 bogofilter_register_hook();
445 bogofilter_unregister_hook();
448 procmsg_register_spam_learner(bogofilter_learn);
449 procmsg_spam_set_folder(config->save_folder, bogofilter_get_spam_folder);
451 bogofilter_save_config();
454 typedef struct _BogoCbData {
460 static gboolean gtk_message_callback(gpointer data)
462 BogoCbData *cbdata = (BogoCbData *)data;
465 statusbar_print_all("%s", cbdata->message);
466 else if (cbdata->total == 0) {
469 if (cbdata->total && cbdata->done)
470 statusbar_progress_all(cbdata->done, cbdata->total, 10);
472 statusbar_progress_all(0,0,0);
473 g_free(cbdata->message);
479 static void gtk_safe_message_callback(gchar *message, gint total, gint done, gboolean thread_safe)
481 BogoCbData *cbdata = g_new0(BogoCbData, 1);
483 cbdata->message = g_strdup(message);
484 cbdata->total = total;
487 g_timeout_add(0, gtk_message_callback, cbdata);
489 gtk_message_callback(cbdata);
492 static struct BogofilterPage bogofilter_page;
494 gint bogofilter_gtk_init(void)
496 static gchar *path[3];
498 path[0] = _("Plugins");
499 path[1] = _("Bogofilter");
502 bogofilter_page.page.path = path;
503 bogofilter_page.page.create_widget = bogofilter_create_widget_func;
504 bogofilter_page.page.destroy_widget = bogofilter_destroy_widget_func;
505 bogofilter_page.page.save_page = bogofilter_save_func;
506 bogofilter_page.page.weight = 35.0;
508 prefs_gtk_register_page((PrefsPage *) &bogofilter_page);
509 bogofilter_set_message_callback(gtk_safe_message_callback);
511 debug_print("Bogofilter GTK plugin loaded\n");
515 void bogofilter_gtk_done(void)
517 prefs_gtk_unregister_page((PrefsPage *) &bogofilter_page);