2008-05-12 [wwp] 3.4.0cvs30
[claws.git] / src / plugins / bogofilter / bogofilter_gtk.c
index b5b620690db91691c1111b4389a95cf323976f40..4198bfffe1ea6d7e5ea0b89a4eaed0d0443af195 100644 (file)
@@ -1,11 +1,11 @@
 /*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Claws Mail Team
- * This file Copyright (C) 2006 Colin Leroy <colin@colino.net>
+ * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 1999-2007 Colin Leroy <colin@colino.net> and 
+ * the Claws Mail team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
@@ -14,8 +14,8 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifdef HAVE_CONFIG_H
@@ -40,6 +40,8 @@
 #include "statusbar.h"
 #include "bogofilter.h"
 #include "menu.h"
+#include "addressbook.h"
+#include "combobox.h"
 
 struct BogofilterPage
 {
@@ -49,25 +51,47 @@ struct BogofilterPage
        GtkWidget *receive_spam;
        GtkWidget *save_folder;
        GtkWidget *save_folder_select;
+       GtkWidget *save_unsure;
+       GtkWidget *save_unsure_folder;
+       GtkWidget *save_unsure_folder_select;
+       GtkWidget *insert_header;
        GtkWidget *max_size;
        GtkWidget *bogopath;
+       GtkWidget *whitelist_ab;
+       GtkWidget *whitelist_ab_folder_combo;
+       GtkWidget *learn_from_whitelist_chkbtn;
+       GtkWidget *mark_as_read;
 };
 
 static void foldersel_cb(GtkWidget *widget, gpointer data)
 {
-       struct BogofilterPage *page = (struct BogofilterPage *) data;
+       GtkWidget *entry = (GtkWidget *) data;
        FolderItem *item;
        gchar *item_id;
        gint newpos = 0;
        
-       item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL);
+       item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL, FALSE);
        if (item && (item_id = folder_item_get_identifier(item)) != NULL) {
-               gtk_editable_delete_text(GTK_EDITABLE(page->save_folder), 0, -1);
-               gtk_editable_insert_text(GTK_EDITABLE(page->save_folder), item_id, strlen(item_id), &newpos);
+               gtk_editable_delete_text(GTK_EDITABLE(entry), 0, -1);
+               gtk_editable_insert_text(GTK_EDITABLE(entry), item_id, strlen(item_id), &newpos);
                g_free(item_id);
        }
 }
 
+static void bogofilter_whitelist_ab_select_cb(GtkWidget *widget, gpointer data)
+{
+       struct BogofilterPage *page = (struct BogofilterPage *) data;
+       const gchar *folderpath = NULL;
+       gchar *new_path = NULL;
+
+       folderpath = gtk_entry_get_text(GTK_ENTRY(GTK_BIN(page->whitelist_ab_folder_combo)->child));
+       new_path = addressbook_folder_selection(folderpath);
+       if (new_path) {
+               gtk_entry_set_text(GTK_ENTRY(GTK_BIN(page->whitelist_ab_folder_combo)->child), new_path);
+               g_free(new_path);
+       } 
+}
+
 static void bogofilter_create_widget_func(PrefsPage * _page,
                                            GtkWindow * window,
                                            gpointer data)
@@ -77,7 +101,9 @@ static void bogofilter_create_widget_func(PrefsPage * _page,
 
        GtkWidget *vbox1, *vbox2;
        GtkWidget *hbox_max_size;
-       GtkWidget *hbox_process_emails, *hbox_save_spam, *hbox_bogopath;
+       GtkWidget *hbox_process_emails, *hbox_save_spam, *hbox_save_unsure;
+       GtkWidget *hbox_bogopath, *hbox_whitelist;
+       GtkWidget *hbox_mark_as_read;
 
        GtkWidget *max_size_label;
        GtkObject *max_size_spinbtn_adj;
@@ -90,11 +116,23 @@ static void bogofilter_create_widget_func(PrefsPage * _page,
        GtkWidget *save_spam_folder_entry;
        GtkWidget *save_spam_folder_select;
 
+       GtkWidget *save_unsure_checkbtn;
+       GtkWidget *save_unsure_folder_entry;
+       GtkWidget *save_unsure_folder_select;
+
+       GtkWidget *insert_header_checkbtn;
+       GtkWidget *whitelist_ab_checkbtn;
+       GtkWidget *learn_from_whitelist_chkbtn;
        GtkWidget *bogopath_label;
        GtkWidget *bogopath_entry;
 
+       GtkWidget *mark_as_read_checkbtn;
+
        GtkTooltips *tooltips;
 
+       GtkWidget *whitelist_ab_folder_combo;
+       GtkWidget *whitelist_ab_select_btn;
+
        tooltips = gtk_tooltips_new();
 
        vbox1 = gtk_vbox_new (FALSE, VSPACING);
@@ -130,7 +168,7 @@ static void bogofilter_create_widget_func(PrefsPage * _page,
                        _("Messages larger than this will not be checked"), NULL);
        gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size_spinbtn), TRUE);
 
-       max_size_kb_label = gtk_label_new(_("kB"));
+       max_size_kb_label = gtk_label_new(_("KB"));
        gtk_widget_show(max_size_kb_label);
        gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_kb_label, FALSE, FALSE, 0);
 
@@ -146,7 +184,7 @@ static void bogofilter_create_widget_func(PrefsPage * _page,
        gtk_widget_show (save_spam_folder_entry);
        gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_entry, TRUE, TRUE, 0);
        gtk_tooltips_set_tip(tooltips, save_spam_folder_entry,
-                       _("Folder for storing identified spam. Leave empty to use the default trash folder"),
+                       _("Folder for storing identified spam. Leave empty to use the trash folder."),
                        NULL);
 
        save_spam_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
@@ -156,6 +194,63 @@ static void bogofilter_create_widget_func(PrefsPage * _page,
                        _("Click this button to select a folder for storing spam"),
                        NULL);
 
+       hbox_save_unsure = gtk_hbox_new(FALSE, 8);
+       gtk_widget_show(hbox_save_unsure);
+       gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_unsure, TRUE, TRUE, 0);
+
+       save_unsure_checkbtn = gtk_check_button_new_with_label(_("When unsure, move to"));
+       gtk_widget_show(save_unsure_checkbtn);
+       gtk_box_pack_start(GTK_BOX(hbox_save_unsure), save_unsure_checkbtn, FALSE, FALSE, 0);
+
+       save_unsure_folder_entry = gtk_entry_new();
+       gtk_widget_show (save_unsure_folder_entry);
+       gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_entry, TRUE, TRUE, 0);
+       gtk_tooltips_set_tip(tooltips, save_unsure_folder_entry,
+                       _("Folder for storing mail for which spam status is Unsure. Leave empty to use the Inbox folder."),
+                       NULL);
+
+       save_unsure_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
+       gtk_widget_show (save_unsure_folder_select);
+       gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_select, FALSE, FALSE, 0);
+       gtk_tooltips_set_tip(tooltips, save_unsure_folder_select,
+                       _("Click this button to select a folder for storing Unsure mails."),
+                       NULL);
+
+       insert_header_checkbtn = gtk_check_button_new_with_label(_("Insert X-Bogosity header"));
+       gtk_widget_show(insert_header_checkbtn);
+       gtk_box_pack_start(GTK_BOX(vbox2), insert_header_checkbtn, FALSE, FALSE, 0);
+       gtk_tooltips_set_tip(tooltips, insert_header_checkbtn,
+                       _("Only done for messages in MH folders"),
+                       NULL);
+
+       hbox_whitelist = gtk_hbox_new(FALSE, 8);
+       gtk_widget_show(hbox_whitelist);
+       gtk_box_pack_start (GTK_BOX (vbox2), hbox_whitelist, TRUE, TRUE, 0);
+
+       whitelist_ab_checkbtn = gtk_check_button_new_with_label(_("Whitelist senders found in address book/folder"));
+       gtk_widget_show(whitelist_ab_checkbtn);
+       gtk_box_pack_start(GTK_BOX(hbox_whitelist), whitelist_ab_checkbtn, FALSE, FALSE, 0);
+       gtk_tooltips_set_tip(tooltips, whitelist_ab_checkbtn,
+                       _("Messages coming from your address book contacts will be received in the normal folder even if detected as spam"), NULL);
+
+       whitelist_ab_folder_combo = combobox_text_new(TRUE, _("Any"), NULL);
+       gtk_widget_set_size_request(whitelist_ab_folder_combo, 100, -1);
+       gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_folder_combo, TRUE, TRUE, 0);
+
+       whitelist_ab_select_btn = gtk_button_new_with_label(_("Select ..."));
+       gtk_widget_show (whitelist_ab_select_btn);
+       gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_select_btn, FALSE, FALSE, 0);
+       gtk_tooltips_set_tip(tooltips, whitelist_ab_select_btn,
+                       _("Click this button to select a book or folder in the address book"),
+                       NULL);
+
+       learn_from_whitelist_chkbtn = gtk_check_button_new_with_label(_("Learn whitelisted emails as ham"));
+       gtk_tooltips_set_tip(tooltips, learn_from_whitelist_chkbtn,
+                       _("If Bogofilter thought an email was spam or unsure, but it was whitelisted, "
+                         "learn it as ham."), NULL);
+       gtk_widget_show(learn_from_whitelist_chkbtn);
+       gtk_box_pack_start (GTK_BOX (vbox2), learn_from_whitelist_chkbtn, TRUE, TRUE, 0);
+
        hbox_bogopath = gtk_hbox_new(FALSE, 8);
        gtk_widget_show(hbox_bogopath);
        gtk_box_pack_start (GTK_BOX (vbox2), hbox_bogopath, FALSE, FALSE, 0);
@@ -171,29 +266,80 @@ static void bogofilter_create_widget_func(PrefsPage * _page,
                        _("Path to bogofilter executable"),
                        NULL);
 
+       hbox_mark_as_read = gtk_hbox_new(FALSE, 8);
+       gtk_widget_show(hbox_mark_as_read);
+       gtk_box_pack_start (GTK_BOX (vbox2), hbox_mark_as_read, TRUE, TRUE, 0);
+
+       mark_as_read_checkbtn = gtk_check_button_new_with_label(_("Mark spam as read"));
+       gtk_widget_show(mark_as_read_checkbtn);
+       gtk_box_pack_start(GTK_BOX(hbox_mark_as_read), mark_as_read_checkbtn, FALSE, FALSE, 0);
+
        SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_entry);
        SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_select);
+       SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_entry);
+       SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_select);
+       SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_folder_combo);
+       SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_select_btn);
+       SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, learn_from_whitelist_chkbtn);
+       SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, mark_as_read_checkbtn);
 
        config = bogofilter_get_config();
 
        g_signal_connect(G_OBJECT(save_spam_folder_select), "clicked",
-                       G_CALLBACK(foldersel_cb), page);
+                       G_CALLBACK(foldersel_cb), save_spam_folder_entry);
+       g_signal_connect(G_OBJECT(save_unsure_folder_select), "clicked",
+                       G_CALLBACK(foldersel_cb), save_unsure_folder_entry);
+       g_signal_connect(G_OBJECT (whitelist_ab_select_btn), "clicked",
+                        G_CALLBACK(bogofilter_whitelist_ab_select_cb), page);
 
        gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size_spinbtn), (float) config->max_size);
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(process_emails_checkbtn), config->process_emails);
        gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_spam_checkbtn), config->receive_spam);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_unsure_checkbtn), config->save_unsure);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(insert_header_checkbtn), config->insert_header);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(whitelist_ab_checkbtn), config->whitelist_ab);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(learn_from_whitelist_chkbtn), config->learn_from_whitelist);
+       if (config->whitelist_ab_folder != NULL) {
+               /* translate "Any" (stored UNtranslated) */
+               if (strcasecmp(config->whitelist_ab_folder, "Any") == 0)
+                       gtk_entry_set_text(GTK_ENTRY(GTK_BIN(whitelist_ab_folder_combo)->child),
+                                       config->whitelist_ab_folder);
+               else
+               /* backward compatibility (when translated "Any" was stored) */
+               if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0)
+                       gtk_entry_set_text(GTK_ENTRY(GTK_BIN(whitelist_ab_folder_combo)->child),
+                                       config->whitelist_ab_folder);
+               else
+                       gtk_entry_set_text(GTK_ENTRY(GTK_BIN(whitelist_ab_folder_combo)->child),
+                                       config->whitelist_ab_folder);
+       }
        if (config->save_folder != NULL)
                gtk_entry_set_text(GTK_ENTRY(save_spam_folder_entry), config->save_folder);
+       if (config->save_unsure_folder != NULL)
+               gtk_entry_set_text(GTK_ENTRY(save_unsure_folder_entry), config->save_unsure_folder);
        if (config->bogopath != NULL)
                gtk_entry_set_text(GTK_ENTRY(bogopath_entry), config->bogopath);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mark_as_read_checkbtn), config->mark_as_read);
 
        page->max_size = max_size_spinbtn;
        page->process_emails = process_emails_checkbtn;
+
        page->receive_spam = save_spam_checkbtn;
        page->save_folder = save_spam_folder_entry;
        page->save_folder_select = save_spam_folder_select;
+
+       page->save_unsure = save_unsure_checkbtn;
+       page->save_unsure_folder = save_unsure_folder_entry;
+       page->save_unsure_folder_select = save_unsure_folder_select;
+
+       page->insert_header = insert_header_checkbtn;
+       page->whitelist_ab = whitelist_ab_checkbtn;
+       page->whitelist_ab_folder_combo = whitelist_ab_folder_combo;
+       page->learn_from_whitelist_chkbtn = learn_from_whitelist_chkbtn;
        page->bogopath = bogopath_entry;
 
+       page->mark_as_read = mark_as_read_checkbtn;
+
        page->page.widget = vbox1;
 }
 
@@ -221,6 +367,30 @@ static void bogofilter_save_func(PrefsPage *_page)
        g_free(config->save_folder);
        config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
 
+       /* save_unsure */
+       config->save_unsure = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->save_unsure));
+
+       /* save_unsure_folder */
+       g_free(config->save_unsure_folder);
+       config->save_unsure_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_unsure_folder), 0, -1);
+
+       /* insert_header */
+       config->insert_header = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->insert_header));
+
+       /* whitelist_ab */
+       config->whitelist_ab = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->whitelist_ab));
+       g_free(config->whitelist_ab_folder);
+       config->whitelist_ab_folder = gtk_editable_get_chars(
+                               GTK_EDITABLE(GTK_BIN(page->whitelist_ab_folder_combo)->child), 0, -1);
+       /* store UNtranslated "Any" */
+       if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0) {
+               g_free(config->whitelist_ab_folder);
+               config->whitelist_ab_folder = g_strdup("Any");
+       }
+
+       /* learn_from_whitelist_chkbtn */
+       config->learn_from_whitelist = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->learn_from_whitelist_chkbtn));
+
        /* bogopath */
        g_free(config->bogopath);
        config->bogopath = gtk_editable_get_chars(GTK_EDITABLE(page->bogopath), 0, -1);
@@ -228,6 +398,9 @@ static void bogofilter_save_func(PrefsPage *_page)
        /* max_size */
        config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
 
+       /* mark_as_read */
+       config->mark_as_read = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->mark_as_read));
+
        if (config->process_emails) {
                bogofilter_register_hook();
        } else {
@@ -235,7 +408,7 @@ static void bogofilter_save_func(PrefsPage *_page)
        }
 
        procmsg_register_spam_learner(bogofilter_learn);
-       procmsg_spam_set_folder(config->save_folder);
+       procmsg_spam_set_folder(config->save_folder, bogofilter_get_spam_folder);
 
        bogofilter_save_config();
 }
@@ -251,7 +424,7 @@ static gboolean gtk_message_callback(gpointer data)
        BogoCbData *cbdata = (BogoCbData *)data;
 
        if (cbdata->message)
-               statusbar_print_all(cbdata->message);
+               statusbar_print_all("%s", cbdata->message);
        else if (cbdata->total == 0) {
                statusbar_pop_all();
        }