src/plugins/bsfilter/bsfilter_gtk.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2009 Colin Leroy <colin@colino.net> 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 #include "claws-features.h"
  24 #endif
  25
  26 #include <glib.h>
  27 #include <glib/gi18n.h>
  28
  29 #include "defs.h"
  30
  31 #include <gtk/gtk.h>
  32 #include "gtk/gtkutils.h"
  33
  34 #include "common/claws.h"
  35 #include "common/version.h"
  36 #include "plugin.h"
  37 #include "common/utils.h"
  38 #include "prefs.h"
  39 #include "folder.h"
  40 #include "prefs_gtk.h"
  41 #include "foldersel.h"
  42 #include "statusbar.h"
  43 #include "bsfilter.h"
  44 #include "menu.h"
  45 #include "addressbook.h"
  46 #include "combobox.h"
  47
  48 struct BsfilterPage
  49 {
  50         PrefsPage page;
  51
  52         GtkWidget *process_emails;
  53         GtkWidget *receive_spam;
  54         GtkWidget *save_folder;
  55         GtkWidget *save_folder_select;
  56         GtkWidget *max_size;
  57         GtkWidget *bspath;
  58         GtkWidget *whitelist_ab;
  59         GtkWidget *whitelist_ab_folder_combo;
  60         GtkWidget *learn_from_whitelist_chkbtn;
  61         GtkWidget *mark_as_read;
  62 };
  63
  64 static void foldersel_cb(GtkWidget *widget, gpointer data)
  65 {
  66         GtkWidget *entry = (GtkWidget *) data;
  67         FolderItem *item;
  68         gchar *item_id;
  69         gint newpos = 0;
  70
  71         item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL, FALSE, NULL);
  72         if (item && (item_id = folder_item_get_identifier(item)) != NULL) {
  73                 gtk_editable_delete_text(GTK_EDITABLE(entry), 0, -1);
  74                 gtk_editable_insert_text(GTK_EDITABLE(entry), item_id, strlen(item_id), &newpos);
  75                 g_free(item_id);
  76         }
  77 }
  78
  79 #ifndef USE_ALT_ADDRBOOK
  80 static void bsfilter_whitelist_ab_select_cb(GtkWidget *widget, gpointer data)
  81 {
  82         struct BsfilterPage *page = (struct BsfilterPage *) data;
  83         const gchar *folderpath = NULL;
  84         gchar *new_path = NULL;
  85
  86         folderpath = gtk_entry_get_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))));
  87         new_path = addressbook_folder_selection(folderpath);
  88         if (new_path) {
  89                 gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))), new_path);
  90                 g_free(new_path);
  91         }
  92 }
  93 #endif
  94
  95 static void bsfilter_create_widget_func(PrefsPage * _page,
  96                                             GtkWindow * window,
  97                                             gpointer data)
  98 {
  99         struct BsfilterPage *page = (struct BsfilterPage *) _page;
 100         BsfilterConfig *config;
 101
 102         GtkWidget *vbox1, *vbox2;
 103         GtkWidget *hbox_max_size;
 104         GtkWidget *hbox_process_emails, *hbox_save_spam;
 105         GtkWidget *hbox_bspath, *hbox_whitelist;
 106         GtkWidget *hbox_mark_as_read;
 107
 108         GtkWidget *max_size_label;
 109         GtkAdjustment *max_size_spinbtn_adj;
 110         GtkWidget *max_size_spinbtn;
 111         GtkWidget *max_size_kb_label;
 112
 113         GtkWidget *process_emails_checkbtn;
 114
 115         GtkWidget *save_spam_checkbtn;
 116         GtkWidget *save_spam_folder_entry;
 117         GtkWidget *save_spam_folder_select;
 118
 119         GtkWidget *whitelist_ab_checkbtn;
 120         GtkWidget *learn_from_whitelist_chkbtn;
 121         GtkWidget *bspath_label;
 122         GtkWidget *bspath_entry;
 123
 124         GtkWidget *mark_as_read_checkbtn;
 125
 126         GtkWidget *whitelist_ab_folder_combo;
 127         GtkWidget *whitelist_ab_select_btn;
 128
 129         vbox1 = gtk_box_new(GTK_ORIENTATION_VERTICAL, VSPACING);
 130         gtk_widget_show (vbox1);
 131         gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
 132
 133         vbox2 = gtk_box_new(GTK_ORIENTATION_VERTICAL, 4);
 134         gtk_widget_show (vbox2);
 135         gtk_box_pack_start (GTK_BOX (vbox1), vbox2, FALSE, FALSE, 0);
 136
 137         hbox_process_emails = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 138         gtk_widget_show(hbox_process_emails);
 139         gtk_box_pack_start (GTK_BOX (vbox2), hbox_process_emails, TRUE, TRUE, 0);
 140
 141         process_emails_checkbtn = gtk_check_button_new_with_label(
 142                         _("Process messages on receiving"));
 143         gtk_widget_show(process_emails_checkbtn);
 144         gtk_box_pack_start(GTK_BOX(hbox_process_emails), process_emails_checkbtn, TRUE, TRUE, 0);
 145
 146         hbox_max_size = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 147         gtk_widget_show(hbox_max_size);
 148         gtk_box_pack_start (GTK_BOX (vbox2), hbox_max_size, TRUE, TRUE, 0);
 149
 150         max_size_label = gtk_label_new(_("Maximum size"));
 151         gtk_widget_show(max_size_label);
 152         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_label, FALSE, FALSE, 0);
 153
 154         max_size_spinbtn_adj = gtk_adjustment_new(250, 0, 10000, 10, 10, 0);
 155         max_size_spinbtn = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_spinbtn_adj), 1, 0);
 156         gtk_widget_show(max_size_spinbtn);
 157         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_spinbtn, FALSE, FALSE, 0);
 158         CLAWS_SET_TIP(max_size_spinbtn,
 159                         _("Messages larger than this will not be checked"));
 160         gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size_spinbtn), TRUE);
 161
 162         max_size_kb_label = gtk_label_new(_("KiB"));
 163         gtk_widget_show(max_size_kb_label);
 164         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_kb_label, FALSE, FALSE, 0);
 165
 166         hbox_save_spam = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 167         gtk_widget_show(hbox_save_spam);
 168         gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_spam, TRUE, TRUE, 0);
 169
 170         save_spam_checkbtn = gtk_check_button_new_with_label(_("Save spam in"));
 171         gtk_widget_show(save_spam_checkbtn);
 172         gtk_box_pack_start(GTK_BOX(hbox_save_spam), save_spam_checkbtn, FALSE, FALSE, 0);
 173
 174         save_spam_folder_entry = gtk_entry_new();
 175         gtk_widget_show (save_spam_folder_entry);
 176         gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_entry, TRUE, TRUE, 0);
 177         CLAWS_SET_TIP(save_spam_folder_entry,
 178                         _("Folder for storing identified spam. Leave empty to use the trash folder."));
 179
 180         save_spam_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
 181         gtk_widget_show (save_spam_folder_select);
 182         gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_select, FALSE, FALSE, 0);
 183         CLAWS_SET_TIP(save_spam_folder_select,
 184                         _("Click this button to select a folder for storing spam"));
 185
 186         hbox_whitelist = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 187         gtk_widget_show(hbox_whitelist);
 188         gtk_box_pack_start (GTK_BOX (vbox2), hbox_whitelist, TRUE, TRUE, 0);
 189
 190         whitelist_ab_checkbtn = gtk_check_button_new_with_label(_("Whitelist senders found in address book/folder"));
 191         gtk_widget_show(whitelist_ab_checkbtn);
 192         gtk_box_pack_start(GTK_BOX(hbox_whitelist), whitelist_ab_checkbtn, FALSE, FALSE, 0);
 193         CLAWS_SET_TIP(whitelist_ab_checkbtn,
 194                         _("Messages coming from your address book contacts will be received in the normal folder even if detected as spam"));
 195
 196         whitelist_ab_folder_combo = combobox_text_new(TRUE, _("Any"), NULL);
 197         gtk_widget_set_size_request(whitelist_ab_folder_combo, 100, -1);
 198         gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_folder_combo, TRUE, TRUE, 0);
 199
 200         whitelist_ab_select_btn = gtk_button_new_with_label(_("Select..."));
 201         gtk_widget_show (whitelist_ab_select_btn);
 202         gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_select_btn, FALSE, FALSE, 0);
 203         CLAWS_SET_TIP(whitelist_ab_select_btn,
 204                         _("Click this button to select a book or folder in the address book"));
 205
 206         learn_from_whitelist_chkbtn = gtk_check_button_new_with_label(_("Learn whitelisted emails as ham"));
 207         CLAWS_SET_TIP(learn_from_whitelist_chkbtn,
 208                         _("If Bsfilter thought an email was spam or unsure, but it was whitelisted, "
 209                           "learn it as ham."));
 210         gtk_widget_show(learn_from_whitelist_chkbtn);
 211         gtk_box_pack_start (GTK_BOX (vbox2), learn_from_whitelist_chkbtn, TRUE, TRUE, 0);
 212
 213         hbox_bspath = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 214         gtk_widget_show(hbox_bspath);
 215         gtk_box_pack_start (GTK_BOX (vbox2), hbox_bspath, FALSE, FALSE, 0);
 216
 217         bspath_label = gtk_label_new(_("Bsfilter call"));
 218         gtk_widget_show(bspath_label);
 219         gtk_box_pack_start(GTK_BOX(hbox_bspath), bspath_label, FALSE, FALSE, 0);
 220
 221         bspath_entry = gtk_entry_new();
 222         gtk_widget_show(bspath_entry);
 223         gtk_box_pack_start(GTK_BOX(hbox_bspath), bspath_entry, FALSE, FALSE, 0);
 224         CLAWS_SET_TIP(bspath_entry,
 225                         _("Path to bsfilter executable"));
 226
 227         hbox_mark_as_read = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 228         gtk_widget_show(hbox_mark_as_read);
 229         gtk_box_pack_start (GTK_BOX (vbox2), hbox_mark_as_read, TRUE, TRUE, 0);
 230
 231         mark_as_read_checkbtn = gtk_check_button_new_with_label(_("Mark spam as read"));
 232         gtk_widget_show(mark_as_read_checkbtn);
 233         gtk_box_pack_start(GTK_BOX(hbox_mark_as_read), mark_as_read_checkbtn, FALSE, FALSE, 0);
 234
 235         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_entry);
 236         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_select);
 237         SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_folder_combo);
 238         SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_select_btn);
 239         SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, learn_from_whitelist_chkbtn);
 240         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, mark_as_read_checkbtn);
 241
 242         config = bsfilter_get_config();
 243
 244         g_signal_connect(G_OBJECT(save_spam_folder_select), "clicked",
 245                         G_CALLBACK(foldersel_cb), save_spam_folder_entry);
 246 #ifndef USE_ALT_ADDRBOOK
 247         g_signal_connect(G_OBJECT (whitelist_ab_select_btn), "clicked",
 248                          G_CALLBACK(bsfilter_whitelist_ab_select_cb), page);
 249 #else
 250         gtk_widget_set_sensitive(whitelist_ab_select_btn, FALSE);
 251 #endif
 252
 253         gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size_spinbtn), (float) config->max_size);
 254         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(process_emails_checkbtn), config->process_emails);
 255         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(save_spam_checkbtn), config->receive_spam);
 256         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(whitelist_ab_checkbtn), config->whitelist_ab);
 257         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(learn_from_whitelist_chkbtn), config->learn_from_whitelist);
 258         if (config->whitelist_ab_folder != NULL) {
 259                 /* translate "Any" (stored UNtranslated) */
 260                 if (strcasecmp(config->whitelist_ab_folder, "Any") == 0)
 261                         gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
 262                                         config->whitelist_ab_folder);
 263                 else
 264                 /* backward compatibility (when translated "Any" was stored) */
 265                 if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0)
 266                         gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
 267                                         config->whitelist_ab_folder);
 268                 else
 269                         gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((whitelist_ab_folder_combo)))),
 270                                         config->whitelist_ab_folder);
 271         }
 272         if (config->save_folder != NULL)
 273                 gtk_entry_set_text(GTK_ENTRY(save_spam_folder_entry), config->save_folder);
 274         if (config->bspath != NULL)
 275                 gtk_entry_set_text(GTK_ENTRY(bspath_entry), config->bspath);
 276         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mark_as_read_checkbtn), config->mark_as_read);
 277
 278         page->max_size = max_size_spinbtn;
 279         page->process_emails = process_emails_checkbtn;
 280
 281         page->receive_spam = save_spam_checkbtn;
 282         page->save_folder = save_spam_folder_entry;
 283         page->save_folder_select = save_spam_folder_select;
 284
 285         page->whitelist_ab = whitelist_ab_checkbtn;
 286         page->whitelist_ab_folder_combo = whitelist_ab_folder_combo;
 287         page->learn_from_whitelist_chkbtn = learn_from_whitelist_chkbtn;
 288         page->bspath = bspath_entry;
 289
 290         page->mark_as_read = mark_as_read_checkbtn;
 291
 292         page->page.widget = vbox1;
 293 }
 294
 295 static void bsfilter_destroy_widget_func(PrefsPage *_page)
 296 {
 297         debug_print("Destroying Bsfilter widget\n");
 298 }
 299
 300 static void bsfilter_save_func(PrefsPage *_page)
 301 {
 302         struct BsfilterPage *page = (struct BsfilterPage *) _page;
 303         BsfilterConfig *config;
 304
 305         debug_print("Saving Bsfilter Page\n");
 306
 307         config = bsfilter_get_config();
 308
 309         /* process_emails */
 310         config->process_emails = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->process_emails));
 311
 312         /* receive_spam */
 313         config->receive_spam = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->receive_spam));
 314
 315         /* save_folder */
 316         g_free(config->save_folder);
 317         config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
 318
 319         /* whitelist_ab */
 320         config->whitelist_ab = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->whitelist_ab));
 321         g_free(config->whitelist_ab_folder);
 322         config->whitelist_ab_folder = gtk_editable_get_chars(
 323                                 GTK_EDITABLE(gtk_bin_get_child(GTK_BIN((page->whitelist_ab_folder_combo)))), 0, -1);
 324         /* store UNtranslated "Any" */
 325         if (g_utf8_collate(config->whitelist_ab_folder, _("Any")) == 0) {
 326                 g_free(config->whitelist_ab_folder);
 327                 config->whitelist_ab_folder = g_strdup("Any");
 328         }
 329
 330         /* learn_from_whitelist_chkbtn */
 331         config->learn_from_whitelist = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->learn_from_whitelist_chkbtn));
 332
 333         /* bspath */
 334         g_free(config->bspath);
 335         config->bspath = gtk_editable_get_chars(GTK_EDITABLE(page->bspath), 0, -1);
 336
 337         /* max_size */
 338         config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
 339
 340         /* mark_as_read */
 341         config->mark_as_read = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->mark_as_read));
 342
 343         if (config->process_emails) {
 344                 bsfilter_register_hook();
 345         } else {
 346                 bsfilter_unregister_hook();
 347         }
 348
 349         procmsg_register_spam_learner(bsfilter_learn);
 350         procmsg_spam_set_folder(config->save_folder, bsfilter_get_spam_folder);
 351
 352         bsfilter_save_config();
 353 }
 354
 355 typedef struct _BsCbData {
 356         gchar *message;
 357         gint total;
 358         gint done;
 359 } BsCbData;
 360
 361 static gboolean gtk_message_callback(gpointer data)
 362 {
 363         BsCbData *cbdata = (BsCbData *)data;
 364
 365         if (cbdata->message)
 366                 statusbar_print_all("%s", cbdata->message);
 367         else if (cbdata->total == 0) {
 368                 statusbar_pop_all();
 369         }
 370         if (cbdata->total && cbdata->done)
 371                 statusbar_progress_all(cbdata->done, cbdata->total, 10);
 372         else
 373                 statusbar_progress_all(0,0,0);
 374         g_free(cbdata->message);
 375         g_free(cbdata);
 376         GTK_EVENTS_FLUSH();
 377         return FALSE;
 378 }
 379
 380 static void gtk_safe_message_callback(gchar *message, gint total, gint done, gboolean thread_safe)
 381 {
 382         BsCbData *cbdata = g_new0(BsCbData, 1);
 383         if (message)
 384                 cbdata->message = g_strdup(message);
 385         cbdata->total = total;
 386         cbdata->done = done;
 387         if (thread_safe)
 388                 g_timeout_add(0, gtk_message_callback, cbdata);
 389         else
 390                 gtk_message_callback(cbdata);
 391 }
 392
 393 static struct BsfilterPage bsfilter_page;
 394
 395 gint bsfilter_gtk_init(void)
 396 {
 397         static gchar *path[3];
 398
 399         path[0] = _("Plugins");
 400         path[1] = _("Bsfilter");
 401         path[2] = NULL;
 402
 403         bsfilter_page.page.path = path;
 404         bsfilter_page.page.create_widget = bsfilter_create_widget_func;
 405         bsfilter_page.page.destroy_widget = bsfilter_destroy_widget_func;
 406         bsfilter_page.page.save_page = bsfilter_save_func;
 407         bsfilter_page.page.weight = 35.0;
 408
 409         prefs_gtk_register_page((PrefsPage *) &bsfilter_page);
 410         bsfilter_set_message_callback(gtk_safe_message_callback);
 411
 412         debug_print("Bsfilter GTK plugin loaded\n");
 413         return 0;
 414 }
 415
 416 void bsfilter_gtk_done(void)
 417 {
 418         prefs_gtk_unregister_page((PrefsPage *) &bsfilter_page);
 419 }