src/plugins/bogofilter/bogofilter_gtk.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Claws Mail Team
   4  * This file Copyright (C) 2006 Colin Leroy <colin@colino.net>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include "config.h"
  23 #endif
  24
  25 #include "defs.h"
  26
  27 #include <glib.h>
  28 #include <glib/gi18n.h>
  29 #include <gtk/gtk.h>
  30 #include <gtk/gtkutils.h>
  31
  32 #include "common/claws.h"
  33 #include "common/version.h"
  34 #include "plugin.h"
  35 #include "common/utils.h"
  36 #include "prefs.h"
  37 #include "folder.h"
  38 #include "prefs_gtk.h"
  39 #include "foldersel.h"
  40 #include "statusbar.h"
  41 #include "bogofilter.h"
  42 #include "menu.h"
  43
  44 struct BogofilterPage
  45 {
  46         PrefsPage page;
  47
  48         GtkWidget *process_emails;
  49         GtkWidget *receive_spam;
  50         GtkWidget *save_folder;
  51         GtkWidget *save_folder_select;
  52         GtkWidget *insert_header;
  53         GtkWidget *max_size;
  54         GtkWidget *bogopath;
  55         GtkWidget *whitelist_ab;
  56 };
  57
  58 static void foldersel_cb(GtkWidget *widget, gpointer data)
  59 {
  60         struct BogofilterPage *page = (struct BogofilterPage *) data;
  61         FolderItem *item;
  62         gchar *item_id;
  63         gint newpos = 0;
  64
  65         item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL);
  66         if (item && (item_id = folder_item_get_identifier(item)) != NULL) {
  67                 gtk_editable_delete_text(GTK_EDITABLE(page->save_folder), 0, -1);
  68                 gtk_editable_insert_text(GTK_EDITABLE(page->save_folder), item_id, strlen(item_id), &newpos);
  69                 g_free(item_id);
  70         }
  71 }
  72
  73 static void bogofilter_create_widget_func(PrefsPage * _page,
  74                                             GtkWindow * window,
  75                                             gpointer data)
  76 {
  77         struct BogofilterPage *page = (struct BogofilterPage *) _page;
  78         BogofilterConfig *config;
  79
  80         GtkWidget *vbox1, *vbox2;
  81         GtkWidget *hbox_max_size;
  82         GtkWidget *hbox_process_emails, *hbox_save_spam, *hbox_bogopath;
  83
  84         GtkWidget *max_size_label;
  85         GtkObject *max_size_spinbtn_adj;
  86         GtkWidget *max_size_spinbtn;
  87         GtkWidget *max_size_kb_label;
  88
  89         GtkWidget *process_emails_checkbtn;
  90
  91         GtkWidget *save_spam_checkbtn;
  92         GtkWidget *save_spam_folder_entry;
  93         GtkWidget *save_spam_folder_select;
  94
  95         GtkWidget *insert_header_chkbtn;
  96         GtkWidget *whitelist_ab_chkbtn;
  97         GtkWidget *bogopath_label;
  98         GtkWidget *bogopath_entry;
  99
 100         GtkTooltips *tooltips;
 101
 102         tooltips = gtk_tooltips_new();
 103
 104         vbox1 = gtk_vbox_new (FALSE, VSPACING);
 105         gtk_widget_show (vbox1);
 106         gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
 107
 108         vbox2 = gtk_vbox_new (FALSE, 4);
 109         gtk_widget_show (vbox2);
 110         gtk_box_pack_start (GTK_BOX (vbox1), vbox2, FALSE, FALSE, 0);
 111
 112         hbox_process_emails = gtk_hbox_new(FALSE, 8);
 113         gtk_widget_show(hbox_process_emails);
 114         gtk_box_pack_start (GTK_BOX (vbox2), hbox_process_emails, TRUE, TRUE, 0);
 115
 116         process_emails_checkbtn = gtk_check_button_new_with_label(
 117                         _("Process messages on receiving"));
 118         gtk_widget_show(process_emails_checkbtn);
 119         gtk_box_pack_start(GTK_BOX(hbox_process_emails), process_emails_checkbtn, TRUE, TRUE, 0);
 120
 121         hbox_max_size = gtk_hbox_new(FALSE, 8);
 122         gtk_widget_show(hbox_max_size);
 123         gtk_box_pack_start (GTK_BOX (vbox2), hbox_max_size, TRUE, TRUE, 0);
 124
 125         max_size_label = gtk_label_new(_("Maximum size"));
 126         gtk_widget_show(max_size_label);
 127         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_label, FALSE, FALSE, 0);
 128
 129         max_size_spinbtn_adj = gtk_adjustment_new(250, 0, 10000, 10, 10, 10);
 130         max_size_spinbtn = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_spinbtn_adj), 1, 0);
 131         gtk_widget_show(max_size_spinbtn);
 132         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_spinbtn, FALSE, FALSE, 0);
 133         gtk_tooltips_set_tip(tooltips, max_size_spinbtn,
 134                         _("Messages larger than this will not be checked"), NULL);
 135         gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size_spinbtn), TRUE);
 136
 137         max_size_kb_label = gtk_label_new(_("kB"));
 138         gtk_widget_show(max_size_kb_label);
 139         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_kb_label, FALSE, FALSE, 0);
 140
 141         hbox_save_spam = gtk_hbox_new(FALSE, 8);
 142         gtk_widget_show(hbox_save_spam);
 143         gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_spam, TRUE, TRUE, 0);
 144
 145         save_spam_checkbtn = gtk_check_button_new_with_label(_("Save spam in"));
 146         gtk_widget_show(save_spam_checkbtn);
 147         gtk_box_pack_start(GTK_BOX(hbox_save_spam), save_spam_checkbtn, FALSE, FALSE, 0);
 148
 149         save_spam_folder_entry = gtk_entry_new();
 150         gtk_widget_show (save_spam_folder_entry);
 151         gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_entry, TRUE, TRUE, 0);
 152         gtk_tooltips_set_tip(tooltips, save_spam_folder_entry,
 153                         _("Folder for storing identified spam. Leave empty to use the default trash folder"),
 154                         NULL);
 155
 156         save_spam_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
 157         gtk_widget_show (save_spam_folder_select);
 158         gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_select, FALSE, FALSE, 0);
 159         gtk_tooltips_set_tip(tooltips, save_spam_folder_select,
 160                         _("Click this button to select a folder for storing spam"),
 161                         NULL);
 162
 163         insert_header_chkbtn = gtk_check_button_new_with_label(_("Insert X-Bogosity header"));
 164         gtk_widget_show(insert_header_chkbtn);
 165         gtk_box_pack_start(GTK_BOX(vbox2), insert_header_chkbtn, FALSE, FALSE, 0);
 166         gtk_tooltips_set_tip(tooltips, insert_header_chkbtn,
 167                         _("Only done for messages in MH folders"),
 168                         NULL);
 169
 170         whitelist_ab_chkbtn = gtk_check_button_new_with_label(_("Whitelist senders present in addressbook"));
 171         gtk_widget_show(whitelist_ab_chkbtn);
 172         gtk_box_pack_start(GTK_BOX(vbox2), whitelist_ab_chkbtn, FALSE, FALSE, 0);
 173         gtk_tooltips_set_tip(tooltips, whitelist_ab_chkbtn,
 174                         _("Messages coming from your addressbook contacts will be received in the normal folder even if detected as spam"), NULL);
 175
 176         hbox_bogopath = gtk_hbox_new(FALSE, 8);
 177         gtk_widget_show(hbox_bogopath);
 178         gtk_box_pack_start (GTK_BOX (vbox2), hbox_bogopath, FALSE, FALSE, 0);
 179
 180         bogopath_label = gtk_label_new(_("Bogofilter call"));
 181         gtk_widget_show(bogopath_label);
 182         gtk_box_pack_start(GTK_BOX(hbox_bogopath), bogopath_label, FALSE, FALSE, 0);
 183
 184         bogopath_entry = gtk_entry_new();
 185         gtk_widget_show(bogopath_entry);
 186         gtk_box_pack_start(GTK_BOX(hbox_bogopath), bogopath_entry, FALSE, FALSE, 0);
 187         gtk_tooltips_set_tip(tooltips, bogopath_entry,
 188                         _("Path to bogofilter executable"),
 189                         NULL);
 190
 191         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_entry);
 192         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_select);
 193         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, insert_header_chkbtn);
 194
 195         config = bogofilter_get_config();
 196
 197         g_signal_connect(G_OBJECT(save_spam_folder_select), "clicked",
 198                         G_CALLBACK(foldersel_cb), page);
 199
 200         gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size_spinbtn), (float) config->max_size);
 201         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(process_emails_checkbtn), config->process_emails);
 202         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_spam_checkbtn), config->receive_spam);
 203         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(insert_header_chkbtn), config->insert_header);
 204         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(whitelist_ab_chkbtn), config->whitelist_ab);
 205         if (config->save_folder != NULL)
 206                 gtk_entry_set_text(GTK_ENTRY(save_spam_folder_entry), config->save_folder);
 207         if (config->bogopath != NULL)
 208                 gtk_entry_set_text(GTK_ENTRY(bogopath_entry), config->bogopath);
 209
 210         page->max_size = max_size_spinbtn;
 211         page->process_emails = process_emails_checkbtn;
 212         page->receive_spam = save_spam_checkbtn;
 213         page->insert_header = insert_header_chkbtn;
 214         page->whitelist_ab = whitelist_ab_chkbtn;
 215         page->save_folder = save_spam_folder_entry;
 216         page->save_folder_select = save_spam_folder_select;
 217         page->bogopath = bogopath_entry;
 218
 219         page->page.widget = vbox1;
 220 }
 221
 222 static void bogofilter_destroy_widget_func(PrefsPage *_page)
 223 {
 224         debug_print("Destroying Bogofilter widget\n");
 225 }
 226
 227 static void bogofilter_save_func(PrefsPage *_page)
 228 {
 229         struct BogofilterPage *page = (struct BogofilterPage *) _page;
 230         BogofilterConfig *config;
 231
 232         debug_print("Saving Bogofilter Page\n");
 233
 234         config = bogofilter_get_config();
 235
 236         /* process_emails */
 237         config->process_emails = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->process_emails));
 238
 239         /* receive_spam */
 240         config->receive_spam = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->receive_spam));
 241
 242         /* save_folder */
 243         g_free(config->save_folder);
 244         config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
 245
 246         /* insert_header */
 247         config->insert_header = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->insert_header));
 248
 249         /* whitelist_ab */
 250         config->whitelist_ab = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->whitelist_ab));
 251
 252         /* bogopath */
 253         g_free(config->bogopath);
 254         config->bogopath = gtk_editable_get_chars(GTK_EDITABLE(page->bogopath), 0, -1);
 255
 256         /* max_size */
 257         config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
 258
 259         if (config->process_emails) {
 260                 bogofilter_register_hook();
 261         } else {
 262                 bogofilter_unregister_hook();
 263         }
 264
 265         procmsg_register_spam_learner(bogofilter_learn);
 266         procmsg_spam_set_folder(config->save_folder);
 267
 268         bogofilter_save_config();
 269 }
 270
 271 typedef struct _BogoCbData {
 272         gchar *message;
 273         gint total;
 274         gint done;
 275 } BogoCbData;
 276
 277 static gboolean gtk_message_callback(gpointer data)
 278 {
 279         BogoCbData *cbdata = (BogoCbData *)data;
 280
 281         if (cbdata->message)
 282                 statusbar_print_all(cbdata->message);
 283         else if (cbdata->total == 0) {
 284                 statusbar_pop_all();
 285         }
 286         if (cbdata->total && cbdata->done)
 287                 statusbar_progress_all(cbdata->done, cbdata->total, 10);
 288         else
 289                 statusbar_progress_all(0,0,0);
 290         g_free(cbdata->message);
 291         g_free(cbdata);
 292         GTK_EVENTS_FLUSH();
 293         return FALSE;
 294 }
 295
 296 static void gtk_safe_message_callback(gchar *message, gint total, gint done, gboolean thread_safe)
 297 {
 298         BogoCbData *cbdata = g_new0(BogoCbData, 1);
 299         if (message)
 300                 cbdata->message = g_strdup(message);
 301         cbdata->total = total;
 302         cbdata->done = done;
 303         if (thread_safe)
 304                 g_timeout_add(0, gtk_message_callback, cbdata);
 305         else
 306                 gtk_message_callback(cbdata);
 307 }
 308
 309 static struct BogofilterPage bogofilter_page;
 310
 311 gint bogofilter_gtk_init(void)
 312 {
 313         static gchar *path[3];
 314
 315         path[0] = _("Plugins");
 316         path[1] = _("Bogofilter");
 317         path[2] = NULL;
 318
 319         bogofilter_page.page.path = path;
 320         bogofilter_page.page.create_widget = bogofilter_create_widget_func;
 321         bogofilter_page.page.destroy_widget = bogofilter_destroy_widget_func;
 322         bogofilter_page.page.save_page = bogofilter_save_func;
 323         bogofilter_page.page.weight = 35.0;
 324
 325         prefs_gtk_register_page((PrefsPage *) &bogofilter_page);
 326         bogofilter_set_message_callback(gtk_safe_message_callback);
 327
 328         debug_print("Bogofilter GTK plugin loaded\n");
 329         return 0;
 330 }
 331
 332 void bogofilter_gtk_done(void)
 333 {
 334         prefs_gtk_unregister_page((PrefsPage *) &bogofilter_page);
 335 }