2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2011 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/>.
28 #include <glib/gi18n.h>
30 #include "gtk/gtkutils.h"
32 #include "common/claws.h"
33 #include "common/version.h"
35 #include "common/utils.h"
38 #include "prefs_gtk.h"
39 #include "foldersel.h"
40 #include "statusbar.h"
41 #include "bogofilter.h"
43 #include "addressbook.h"
50 GtkWidget *process_emails;
51 GtkWidget *receive_spam;
52 GtkWidget *save_folder;
53 GtkWidget *save_folder_select;
54 GtkWidget *save_unsure;
55 GtkWidget *save_unsure_folder;
56 GtkWidget *save_unsure_folder_select;
57 GtkWidget *insert_header;
60 GtkWidget *whitelist_ab;
61 GtkWidget *whitelist_ab_folder_combo;
62 GtkWidget *learn_from_whitelist_chkbtn;
63 GtkWidget *mark_as_read;
66 static void foldersel_cb(GtkWidget *widget, gpointer data)
68 GtkWidget *entry = (GtkWidget *) data;
73 item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL, FALSE);
74 if (item && (item_id = folder_item_get_identifier(item)) != NULL) {
75 gtk_editable_delete_text(GTK_EDITABLE(entry), 0, -1);
76 gtk_editable_insert_text(GTK_EDITABLE(entry), item_id, strlen(item_id), &newpos);
81 static void bogofilter_whitelist_ab_select_cb(GtkWidget *widget, gpointer data)
83 struct BogofilterPage *page = (struct BogofilterPage *) data;
84 const gchar *folderpath = NULL;
85 gchar *new_path = NULL;
87 folderpath = gtk_entry_get_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))));
88 new_path = addressbook_folder_selection(folderpath);
90 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))), new_path);
95 static void bogofilter_create_widget_func(PrefsPage * _page,
99 struct BogofilterPage *page = (struct BogofilterPage *) _page;
100 BogofilterConfig *config;
102 GtkWidget *vbox1, *vbox2;
103 GtkWidget *hbox_max_size;
104 GtkWidget *hbox_process_emails, *hbox_save_spam, *hbox_save_unsure;
105 GtkWidget *hbox_bogopath, *hbox_whitelist;
106 GtkWidget *hbox_mark_as_read;
108 GtkWidget *max_size_label;
109 GtkAdjustment *max_size_spinbtn_adj;
110 GtkWidget *max_size_spinbtn;
111 GtkWidget *max_size_kb_label;
113 GtkWidget *process_emails_checkbtn;
115 GtkWidget *save_spam_checkbtn;
116 GtkWidget *save_spam_folder_entry;
117 GtkWidget *save_spam_folder_select;
119 GtkWidget *save_unsure_checkbtn;
120 GtkWidget *save_unsure_folder_entry;
121 GtkWidget *save_unsure_folder_select;
123 GtkWidget *insert_header_checkbtn;
124 GtkWidget *whitelist_ab_checkbtn;
125 GtkWidget *learn_from_whitelist_chkbtn;
126 GtkWidget *bogopath_label;
127 GtkWidget *bogopath_entry;
129 GtkWidget *mark_as_read_checkbtn;
131 GtkWidget *whitelist_ab_folder_combo;
132 GtkWidget *whitelist_ab_select_btn;
135 vbox1 = gtk_vbox_new (FALSE, VSPACING);
136 gtk_widget_show (vbox1);
137 gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
139 vbox2 = gtk_vbox_new (FALSE, 4);
140 gtk_widget_show (vbox2);
141 gtk_box_pack_start (GTK_BOX (vbox1), vbox2, FALSE, FALSE, 0);
143 hbox_process_emails = gtk_hbox_new(FALSE, 8);
144 gtk_widget_show(hbox_process_emails);
145 gtk_box_pack_start (GTK_BOX (vbox2), hbox_process_emails, TRUE, TRUE, 0);
147 process_emails_checkbtn = gtk_check_button_new_with_label(
148 _("Process messages on receiving"));
149 gtk_widget_show(process_emails_checkbtn);
150 gtk_box_pack_start(GTK_BOX(hbox_process_emails), process_emails_checkbtn, TRUE, TRUE, 0);
152 hbox_max_size = gtk_hbox_new(FALSE, 8);
153 gtk_widget_show(hbox_max_size);
154 gtk_box_pack_start (GTK_BOX (vbox2), hbox_max_size, TRUE, TRUE, 0);
156 max_size_label = gtk_label_new(_("Maximum size"));
157 gtk_widget_show(max_size_label);
158 gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_label, FALSE, FALSE, 0);
160 max_size_spinbtn_adj = gtk_adjustment_new(250, 0, 10000, 10, 10, 0);
161 max_size_spinbtn = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_spinbtn_adj), 1, 0);
162 gtk_widget_show(max_size_spinbtn);
163 gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_spinbtn, FALSE, FALSE, 0);
164 CLAWS_SET_TIP(max_size_spinbtn,
165 _("Messages larger than this will not be checked"));
166 gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size_spinbtn), TRUE);
168 max_size_kb_label = gtk_label_new(_("KB"));
169 gtk_widget_show(max_size_kb_label);
170 gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_kb_label, FALSE, FALSE, 0);
172 hbox_save_spam = gtk_hbox_new(FALSE, 8);
173 gtk_widget_show(hbox_save_spam);
174 gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_spam, TRUE, TRUE, 0);
176 save_spam_checkbtn = gtk_check_button_new_with_label(_("Save spam in"));
177 gtk_widget_show(save_spam_checkbtn);
178 gtk_box_pack_start(GTK_BOX(hbox_save_spam), save_spam_checkbtn, FALSE, FALSE, 0);
180 save_spam_folder_entry = gtk_entry_new();
181 gtk_widget_show (save_spam_folder_entry);
182 gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_entry, TRUE, TRUE, 0);
183 CLAWS_SET_TIP(save_spam_folder_entry,
184 _("Folder for storing identified spam. Leave empty to use the trash folder."));
186 save_spam_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
187 gtk_widget_show (save_spam_folder_select);
188 gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_select, FALSE, FALSE, 0);
189 CLAWS_SET_TIP(save_spam_folder_select,
190 _("Click this button to select a folder for storing spam"));
192 hbox_save_unsure = gtk_hbox_new(FALSE, 8);
193 gtk_widget_show(hbox_save_unsure);
194 gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_unsure, TRUE, TRUE, 0);
196 save_unsure_checkbtn = gtk_check_button_new_with_label(_("When unsure, move to"));
197 gtk_widget_show(save_unsure_checkbtn);
198 gtk_box_pack_start(GTK_BOX(hbox_save_unsure), save_unsure_checkbtn, FALSE, FALSE, 0);
200 save_unsure_folder_entry = gtk_entry_new();
201 gtk_widget_show (save_unsure_folder_entry);
202 gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_entry, TRUE, TRUE, 0);
203 CLAWS_SET_TIP(save_unsure_folder_entry,
204 _("Folder for storing mail for which spam status is Unsure. Leave empty to use the Inbox folder."));
206 save_unsure_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
207 gtk_widget_show (save_unsure_folder_select);
208 gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_select, FALSE, FALSE, 0);
209 CLAWS_SET_TIP(save_unsure_folder_select,
210 _("Click this button to select a folder for storing Unsure mails."));
212 insert_header_checkbtn = gtk_check_button_new_with_label(_("Insert X-Bogosity header"));
213 gtk_widget_show(insert_header_checkbtn);
214 gtk_box_pack_start(GTK_BOX(vbox2), insert_header_checkbtn, FALSE, FALSE, 0);
215 CLAWS_SET_TIP(insert_header_checkbtn,
216 _("Only done for messages in MH folders"));
218 hbox_whitelist = gtk_hbox_new(FALSE, 8);
219 gtk_widget_show(hbox_whitelist);
220 gtk_box_pack_start (GTK_BOX (vbox2), hbox_whitelist, TRUE, TRUE, 0);
222 whitelist_ab_checkbtn = gtk_check_button_new_with_label(_("Whitelist senders found in address book/folder"));
223 gtk_widget_show(whitelist_ab_checkbtn);
224 gtk_box_pack_start(GTK_BOX(hbox_whitelist), whitelist_ab_checkbtn, FALSE, FALSE, 0);
225 CLAWS_SET_TIP(whitelist_ab_checkbtn,
226 _("Messages coming from your address book contacts will be received in the normal folder even if detected as spam"));
228 whitelist_ab_folder_combo = combobox_text_new(TRUE, _("Any"), NULL);
229 gtk_widget_set_size_request(whitelist_ab_folder_combo, 100, -1);
230 gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_folder_combo, TRUE, TRUE, 0);
232 whitelist_ab_select_btn = gtk_button_new_with_label(_("Select ..."));
233 gtk_widget_show (whitelist_ab_select_btn);
234 gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_select_btn, FALSE, FALSE, 0);
235 CLAWS_SET_TIP(whitelist_ab_select_btn,
236 _("Click this button to select a book or folder in the address book"));
238 learn_from_whitelist_chkbtn = gtk_check_button_new_with_label(_("Learn whitelisted emails as ham"));
239 CLAWS_SET_TIP(learn_from_whitelist_chkbtn,
240 _("If Bogofilter thought an email was spam or unsure, but it was whitelisted, "
241 "learn it as ham."));
242 gtk_widget_show(learn_from_whitelist_chkbtn);
243 gtk_box_pack_start (GTK_BOX (vbox2), learn_from_whitelist_chkbtn, TRUE, TRUE, 0);
245 hbox_bogopath = gtk_hbox_new(FALSE, 8);
246 gtk_widget_show(hbox_bogopath);
247 gtk_box_pack_start (GTK_BOX (vbox2), hbox_bogopath, FALSE, FALSE, 0);
249 bogopath_label = gtk_label_new(_("Bogofilter call"));
250 gtk_widget_show(bogopath_label);
251 gtk_box_pack_start(GTK_BOX(hbox_bogopath), bogopath_label, FALSE, FALSE, 0);
253 bogopath_entry = gtk_entry_new();
254 gtk_widget_show(bogopath_entry);
255 gtk_box_pack_start(GTK_BOX(hbox_bogopath), bogopath_entry, FALSE, FALSE, 0);
256 CLAWS_SET_TIP(bogopath_entry,
257 _("Path to bogofilter executable"));
259 hbox_mark_as_read = gtk_hbox_new(FALSE, 8);
260 gtk_widget_show(hbox_mark_as_read);
261 gtk_box_pack_start (GTK_BOX (vbox2), hbox_mark_as_read, TRUE, TRUE, 0);
263 mark_as_read_checkbtn = gtk_check_button_new_with_label(_("Mark spam as read"));
264 gtk_widget_show(mark_as_read_checkbtn);
265 gtk_box_pack_start(GTK_BOX(hbox_mark_as_read), mark_as_read_checkbtn, FALSE, FALSE, 0);
267 SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_entry);
268 SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_select);
269 SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_entry);
270 SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_select);
271 SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_folder_combo);
272 SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_select_btn);
273 SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, learn_from_whitelist_chkbtn);
274 SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, mark_as_read_checkbtn);
276 config = bogofilter_get_config();
278 g_signal_connect(G_OBJECT(save_spam_folder_select), "clicked",
279 G_CALLBACK(foldersel_cb), save_spam_folder_entry);
280 g_signal_connect(G_OBJECT(save_unsure_folder_select), "clicked",
281 G_CALLBACK(foldersel_cb), save_unsure_folder_entry);
282 g_signal_connect(G_OBJECT (whitelist_ab_select_btn), "clicked",
283 G_CALLBACK(bogofilter_whitelist_ab_select_cb), page);
285 gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size_spinbtn), (float) config->max_size);
286 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(process_emails_checkbtn), config->process_emails);
287 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_spam_checkbtn), config->receive_spam);
288 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_unsure_checkbtn), config->save_unsure);
289 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(insert_header_checkbtn), config->insert_header);
290 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(whitelist_ab_checkbtn), config->whitelist_ab);
291 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(learn_from_whitelist_chkbtn), config->learn_from_whitelist);
292 if (config->whitelist_ab_folder != NULL) {
293 /* translate "Any" (stored UNtranslated) */
294 if (strcasecmp(config->whitelist_ab_folder, "Any") == 0)
295 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
296 config->whitelist_ab_folder);
298 /* backward compatibility (when translated "Any" was stored) */
299 if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0)
300 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
301 config->whitelist_ab_folder);
303 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
304 config->whitelist_ab_folder);
306 if (config->save_folder != NULL)
307 gtk_entry_set_text(GTK_ENTRY(save_spam_folder_entry), config->save_folder);
308 if (config->save_unsure_folder != NULL)
309 gtk_entry_set_text(GTK_ENTRY(save_unsure_folder_entry), config->save_unsure_folder);
310 if (config->bogopath != NULL)
311 gtk_entry_set_text(GTK_ENTRY(bogopath_entry), config->bogopath);
312 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mark_as_read_checkbtn), config->mark_as_read);
314 page->max_size = max_size_spinbtn;
315 page->process_emails = process_emails_checkbtn;
317 page->receive_spam = save_spam_checkbtn;
318 page->save_folder = save_spam_folder_entry;
319 page->save_folder_select = save_spam_folder_select;
321 page->save_unsure = save_unsure_checkbtn;
322 page->save_unsure_folder = save_unsure_folder_entry;
323 page->save_unsure_folder_select = save_unsure_folder_select;
325 page->insert_header = insert_header_checkbtn;
326 page->whitelist_ab = whitelist_ab_checkbtn;
327 page->whitelist_ab_folder_combo = whitelist_ab_folder_combo;
328 page->learn_from_whitelist_chkbtn = learn_from_whitelist_chkbtn;
329 page->bogopath = bogopath_entry;
331 page->mark_as_read = mark_as_read_checkbtn;
333 page->page.widget = vbox1;
336 static void bogofilter_destroy_widget_func(PrefsPage *_page)
338 debug_print("Destroying Bogofilter widget\n");
341 static void bogofilter_save_func(PrefsPage *_page)
343 struct BogofilterPage *page = (struct BogofilterPage *) _page;
344 BogofilterConfig *config;
346 debug_print("Saving Bogofilter Page\n");
348 config = bogofilter_get_config();
351 config->process_emails = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->process_emails));
354 config->receive_spam = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->receive_spam));
357 g_free(config->save_folder);
358 config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
361 config->save_unsure = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->save_unsure));
363 /* save_unsure_folder */
364 g_free(config->save_unsure_folder);
365 config->save_unsure_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_unsure_folder), 0, -1);
368 config->insert_header = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->insert_header));
371 config->whitelist_ab = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->whitelist_ab));
372 g_free(config->whitelist_ab_folder);
373 config->whitelist_ab_folder = gtk_editable_get_chars(
374 GTK_EDITABLE(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))), 0, -1);
375 /* store UNtranslated "Any" */
376 if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0) {
377 g_free(config->whitelist_ab_folder);
378 config->whitelist_ab_folder = g_strdup("Any");
381 /* learn_from_whitelist_chkbtn */
382 config->learn_from_whitelist = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->learn_from_whitelist_chkbtn));
385 g_free(config->bogopath);
386 config->bogopath = gtk_editable_get_chars(GTK_EDITABLE(page->bogopath), 0, -1);
389 config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
392 config->mark_as_read = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->mark_as_read));
394 if (config->process_emails) {
395 bogofilter_register_hook();
397 bogofilter_unregister_hook();
400 procmsg_register_spam_learner(bogofilter_learn);
401 procmsg_spam_set_folder(config->save_folder, bogofilter_get_spam_folder);
403 bogofilter_save_config();
406 typedef struct _BogoCbData {
412 static gboolean gtk_message_callback(gpointer data)
414 BogoCbData *cbdata = (BogoCbData *)data;
417 statusbar_print_all("%s", cbdata->message);
418 else if (cbdata->total == 0) {
421 if (cbdata->total && cbdata->done)
422 statusbar_progress_all(cbdata->done, cbdata->total, 10);
424 statusbar_progress_all(0,0,0);
425 g_free(cbdata->message);
431 static void gtk_safe_message_callback(gchar *message, gint total, gint done, gboolean thread_safe)
433 BogoCbData *cbdata = g_new0(BogoCbData, 1);
435 cbdata->message = g_strdup(message);
436 cbdata->total = total;
439 g_timeout_add(0, gtk_message_callback, cbdata);
441 gtk_message_callback(cbdata);
444 static struct BogofilterPage bogofilter_page;
446 gint bogofilter_gtk_init(void)
448 static gchar *path[3];
450 path[0] = _("Plugins");
451 path[1] = _("Bogofilter");
454 bogofilter_page.page.path = path;
455 bogofilter_page.page.create_widget = bogofilter_create_widget_func;
456 bogofilter_page.page.destroy_widget = bogofilter_destroy_widget_func;
457 bogofilter_page.page.save_page = bogofilter_save_func;
458 bogofilter_page.page.weight = 35.0;
460 prefs_gtk_register_page((PrefsPage *) &bogofilter_page);
461 bogofilter_set_message_callback(gtk_safe_message_callback);
463 debug_print("Bogofilter GTK plugin loaded\n");
467 void bogofilter_gtk_done(void)
469 prefs_gtk_unregister_page((PrefsPage *) &bogofilter_page);