src/plugins/bogofilter/bogofilter_gtk.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2007 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 #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 #include "addressbook.h"
  44 #include "combobox.h"
  45
  46 struct BogofilterPage
  47 {
  48         PrefsPage page;
  49
  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;
  58         GtkWidget *max_size;
  59         GtkWidget *bogopath;
  60         GtkWidget *whitelist_ab;
  61         GtkWidget *whitelist_ab_folder_combo;
  62         GtkWidget *mark_as_read;
  63 };
  64
  65 static void foldersel_cb(GtkWidget *widget, gpointer data)
  66 {
  67         GtkWidget *entry = (GtkWidget *) data;
  68         FolderItem *item;
  69         gchar *item_id;
  70         gint newpos = 0;
  71
  72         item = foldersel_folder_sel(NULL, FOLDER_SEL_MOVE, NULL, FALSE);
  73         if (item && (item_id = folder_item_get_identifier(item)) != NULL) {
  74                 gtk_editable_delete_text(GTK_EDITABLE(entry), 0, -1);
  75                 gtk_editable_insert_text(GTK_EDITABLE(entry), item_id, strlen(item_id), &newpos);
  76                 g_free(item_id);
  77         }
  78 }
  79
  80 static void bogofilter_whitelist_ab_select_cb(GtkWidget *widget, gpointer data)
  81 {
  82         struct BogofilterPage *page = (struct BogofilterPage *) data;
  83         const gchar *folderpath = NULL;
  84         gchar *new_path = NULL;
  85
  86         folderpath = gtk_entry_get_text(GTK_ENTRY(GTK_BIN(page->whitelist_ab_folder_combo)->child));
  87         new_path = addressbook_folder_selection(folderpath);
  88         if (new_path) {
  89                 gtk_entry_set_text(GTK_ENTRY(GTK_BIN(page->whitelist_ab_folder_combo)->child), new_path);
  90                 g_free(new_path);
  91         }
  92 }
  93
  94 static void bogofilter_create_widget_func(PrefsPage * _page,
  95                                             GtkWindow * window,
  96                                             gpointer data)
  97 {
  98         struct BogofilterPage *page = (struct BogofilterPage *) _page;
  99         BogofilterConfig *config;
 100
 101         GtkWidget *vbox1, *vbox2;
 102         GtkWidget *hbox_max_size;
 103         GtkWidget *hbox_process_emails, *hbox_save_spam, *hbox_save_unsure;
 104         GtkWidget *hbox_bogopath, *hbox_whitelist;
 105         GtkWidget *hbox_mark_as_read;
 106
 107         GtkWidget *max_size_label;
 108         GtkObject *max_size_spinbtn_adj;
 109         GtkWidget *max_size_spinbtn;
 110         GtkWidget *max_size_kb_label;
 111
 112         GtkWidget *process_emails_checkbtn;
 113
 114         GtkWidget *save_spam_checkbtn;
 115         GtkWidget *save_spam_folder_entry;
 116         GtkWidget *save_spam_folder_select;
 117
 118         GtkWidget *save_unsure_checkbtn;
 119         GtkWidget *save_unsure_folder_entry;
 120         GtkWidget *save_unsure_folder_select;
 121
 122         GtkWidget *insert_header_checkbtn;
 123         GtkWidget *whitelist_ab_checkbtn;
 124         GtkWidget *bogopath_label;
 125         GtkWidget *bogopath_entry;
 126
 127         GtkWidget *mark_as_read_checkbtn;
 128
 129         GtkTooltips *tooltips;
 130
 131         GtkWidget *whitelist_ab_folder_combo;
 132         GtkWidget *whitelist_ab_select_btn;
 133
 134         tooltips = gtk_tooltips_new();
 135
 136         vbox1 = gtk_vbox_new (FALSE, VSPACING);
 137         gtk_widget_show (vbox1);
 138         gtk_container_set_border_width (GTK_CONTAINER (vbox1), VBOX_BORDER);
 139
 140         vbox2 = gtk_vbox_new (FALSE, 4);
 141         gtk_widget_show (vbox2);
 142         gtk_box_pack_start (GTK_BOX (vbox1), vbox2, FALSE, FALSE, 0);
 143
 144         hbox_process_emails = gtk_hbox_new(FALSE, 8);
 145         gtk_widget_show(hbox_process_emails);
 146         gtk_box_pack_start (GTK_BOX (vbox2), hbox_process_emails, TRUE, TRUE, 0);
 147
 148         process_emails_checkbtn = gtk_check_button_new_with_label(
 149                         _("Process messages on receiving"));
 150         gtk_widget_show(process_emails_checkbtn);
 151         gtk_box_pack_start(GTK_BOX(hbox_process_emails), process_emails_checkbtn, TRUE, TRUE, 0);
 152
 153         hbox_max_size = gtk_hbox_new(FALSE, 8);
 154         gtk_widget_show(hbox_max_size);
 155         gtk_box_pack_start (GTK_BOX (vbox2), hbox_max_size, TRUE, TRUE, 0);
 156
 157         max_size_label = gtk_label_new(_("Maximum size"));
 158         gtk_widget_show(max_size_label);
 159         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_label, FALSE, FALSE, 0);
 160
 161         max_size_spinbtn_adj = gtk_adjustment_new(250, 0, 10000, 10, 10, 10);
 162         max_size_spinbtn = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_spinbtn_adj), 1, 0);
 163         gtk_widget_show(max_size_spinbtn);
 164         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_spinbtn, FALSE, FALSE, 0);
 165         gtk_tooltips_set_tip(tooltips, max_size_spinbtn,
 166                         _("Messages larger than this will not be checked"), NULL);
 167         gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size_spinbtn), TRUE);
 168
 169         max_size_kb_label = gtk_label_new(_("KB"));
 170         gtk_widget_show(max_size_kb_label);
 171         gtk_box_pack_start(GTK_BOX(hbox_max_size), max_size_kb_label, FALSE, FALSE, 0);
 172
 173         hbox_save_spam = gtk_hbox_new(FALSE, 8);
 174         gtk_widget_show(hbox_save_spam);
 175         gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_spam, TRUE, TRUE, 0);
 176
 177         save_spam_checkbtn = gtk_check_button_new_with_label(_("Save spam in"));
 178         gtk_widget_show(save_spam_checkbtn);
 179         gtk_box_pack_start(GTK_BOX(hbox_save_spam), save_spam_checkbtn, FALSE, FALSE, 0);
 180
 181         save_spam_folder_entry = gtk_entry_new();
 182         gtk_widget_show (save_spam_folder_entry);
 183         gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_entry, TRUE, TRUE, 0);
 184         gtk_tooltips_set_tip(tooltips, save_spam_folder_entry,
 185                         _("Folder for storing identified spam. Leave empty to use the trash folder."),
 186                         NULL);
 187
 188         save_spam_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
 189         gtk_widget_show (save_spam_folder_select);
 190         gtk_box_pack_start (GTK_BOX (hbox_save_spam), save_spam_folder_select, FALSE, FALSE, 0);
 191         gtk_tooltips_set_tip(tooltips, save_spam_folder_select,
 192                         _("Click this button to select a folder for storing spam"),
 193                         NULL);
 194
 195         hbox_save_unsure = gtk_hbox_new(FALSE, 8);
 196         gtk_widget_show(hbox_save_unsure);
 197         gtk_box_pack_start (GTK_BOX (vbox2), hbox_save_unsure, TRUE, TRUE, 0);
 198
 199         save_unsure_checkbtn = gtk_check_button_new_with_label(_("When unsure, move to"));
 200         gtk_widget_show(save_unsure_checkbtn);
 201         gtk_box_pack_start(GTK_BOX(hbox_save_unsure), save_unsure_checkbtn, FALSE, FALSE, 0);
 202
 203         save_unsure_folder_entry = gtk_entry_new();
 204         gtk_widget_show (save_unsure_folder_entry);
 205         gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_entry, TRUE, TRUE, 0);
 206         gtk_tooltips_set_tip(tooltips, save_unsure_folder_entry,
 207                         _("Folder for storing mail for which spam status is Unsure. Leave empty to use the Inbox folder."),
 208                         NULL);
 209
 210         save_unsure_folder_select = gtkut_get_browse_directory_btn(_("_Browse"));
 211         gtk_widget_show (save_unsure_folder_select);
 212         gtk_box_pack_start (GTK_BOX (hbox_save_unsure), save_unsure_folder_select, FALSE, FALSE, 0);
 213         gtk_tooltips_set_tip(tooltips, save_unsure_folder_select,
 214                         _("Click this button to select a folder for storing Unsure mails."),
 215                         NULL);
 216
 217         insert_header_checkbtn = gtk_check_button_new_with_label(_("Insert X-Bogosity header"));
 218         gtk_widget_show(insert_header_checkbtn);
 219         gtk_box_pack_start(GTK_BOX(vbox2), insert_header_checkbtn, FALSE, FALSE, 0);
 220         gtk_tooltips_set_tip(tooltips, insert_header_checkbtn,
 221                         _("Only done for messages in MH folders"),
 222                         NULL);
 223
 224         hbox_whitelist = gtk_hbox_new(FALSE, 8);
 225         gtk_widget_show(hbox_whitelist);
 226         gtk_box_pack_start (GTK_BOX (vbox2), hbox_whitelist, TRUE, TRUE, 0);
 227
 228         whitelist_ab_checkbtn = gtk_check_button_new_with_label(_("Whitelist senders found in address book/folder"));
 229         gtk_widget_show(whitelist_ab_checkbtn);
 230         gtk_box_pack_start(GTK_BOX(hbox_whitelist), whitelist_ab_checkbtn, FALSE, FALSE, 0);
 231         gtk_tooltips_set_tip(tooltips, whitelist_ab_checkbtn,
 232                         _("Messages coming from your address book contacts will be received in the normal folder even if detected as spam"), NULL);
 233
 234         whitelist_ab_folder_combo = combobox_text_new(TRUE, _("Any"), NULL);
 235         gtk_widget_set_size_request(whitelist_ab_folder_combo, 100, -1);
 236         gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_folder_combo, TRUE, TRUE, 0);
 237
 238         whitelist_ab_select_btn = gtk_button_new_with_label(_("Select ..."));
 239         gtk_widget_show (whitelist_ab_select_btn);
 240         gtk_box_pack_start (GTK_BOX (hbox_whitelist), whitelist_ab_select_btn, FALSE, FALSE, 0);
 241         gtk_tooltips_set_tip(tooltips, whitelist_ab_select_btn,
 242                         _("Click this button to select a book or folder in the address book"),
 243                         NULL);
 244
 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);
 248
 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);
 252
 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         gtk_tooltips_set_tip(tooltips, bogopath_entry,
 257                         _("Path to bogofilter executable"),
 258                         NULL);
 259
 260         hbox_mark_as_read = gtk_hbox_new(FALSE, 8);
 261         gtk_widget_show(hbox_mark_as_read);
 262         gtk_box_pack_start (GTK_BOX (vbox2), hbox_mark_as_read, TRUE, TRUE, 0);
 263
 264         mark_as_read_checkbtn = gtk_check_button_new_with_label(_("Mark spam as read"));
 265         gtk_widget_show(mark_as_read_checkbtn);
 266         gtk_box_pack_start(GTK_BOX(hbox_mark_as_read), mark_as_read_checkbtn, FALSE, FALSE, 0);
 267
 268         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_entry);
 269         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, save_spam_folder_select);
 270         SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_entry);
 271         SET_TOGGLE_SENSITIVITY(save_unsure_checkbtn, save_unsure_folder_select);
 272         SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_folder_combo);
 273         SET_TOGGLE_SENSITIVITY(whitelist_ab_checkbtn, whitelist_ab_select_btn);
 274         SET_TOGGLE_SENSITIVITY(save_spam_checkbtn, mark_as_read_checkbtn);
 275
 276         config = bogofilter_get_config();
 277
 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);
 284
 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         if (config->whitelist_ab_folder != NULL)
 292                 gtk_entry_set_text(GTK_ENTRY(GTK_BIN(whitelist_ab_folder_combo)->child),
 293                                 config->whitelist_ab_folder);
 294         if (config->save_folder != NULL)
 295                 gtk_entry_set_text(GTK_ENTRY(save_spam_folder_entry), config->save_folder);
 296         if (config->save_unsure_folder != NULL)
 297                 gtk_entry_set_text(GTK_ENTRY(save_unsure_folder_entry), config->save_unsure_folder);
 298         if (config->bogopath != NULL)
 299                 gtk_entry_set_text(GTK_ENTRY(bogopath_entry), config->bogopath);
 300         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mark_as_read_checkbtn), config->mark_as_read);
 301
 302         page->max_size = max_size_spinbtn;
 303         page->process_emails = process_emails_checkbtn;
 304
 305         page->receive_spam = save_spam_checkbtn;
 306         page->save_folder = save_spam_folder_entry;
 307         page->save_folder_select = save_spam_folder_select;
 308
 309         page->save_unsure = save_unsure_checkbtn;
 310         page->save_unsure_folder = save_unsure_folder_entry;
 311         page->save_unsure_folder_select = save_unsure_folder_select;
 312
 313         page->insert_header = insert_header_checkbtn;
 314         page->whitelist_ab = whitelist_ab_checkbtn;
 315         page->whitelist_ab_folder_combo = whitelist_ab_folder_combo;
 316         page->bogopath = bogopath_entry;
 317
 318         page->mark_as_read = mark_as_read_checkbtn;
 319
 320         page->page.widget = vbox1;
 321 }
 322
 323 static void bogofilter_destroy_widget_func(PrefsPage *_page)
 324 {
 325         debug_print("Destroying Bogofilter widget\n");
 326 }
 327
 328 static void bogofilter_save_func(PrefsPage *_page)
 329 {
 330         struct BogofilterPage *page = (struct BogofilterPage *) _page;
 331         BogofilterConfig *config;
 332
 333         debug_print("Saving Bogofilter Page\n");
 334
 335         config = bogofilter_get_config();
 336
 337         /* process_emails */
 338         config->process_emails = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->process_emails));
 339
 340         /* receive_spam */
 341         config->receive_spam = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->receive_spam));
 342
 343         /* save_folder */
 344         g_free(config->save_folder);
 345         config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
 346
 347         /* save_unsure */
 348         config->save_unsure = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->save_unsure));
 349
 350         /* save_unsure_folder */
 351         g_free(config->save_unsure_folder);
 352         config->save_unsure_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_unsure_folder), 0, -1);
 353
 354         /* insert_header */
 355         config->insert_header = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->insert_header));
 356
 357         /* whitelist_ab */
 358         config->whitelist_ab = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->whitelist_ab));
 359         g_free(config->whitelist_ab_folder);
 360         config->whitelist_ab_folder = gtk_editable_get_chars(
 361                                 GTK_EDITABLE(GTK_BIN(page->whitelist_ab_folder_combo)->child), 0, -1);
 362
 363         /* bogopath */
 364         g_free(config->bogopath);
 365         config->bogopath = gtk_editable_get_chars(GTK_EDITABLE(page->bogopath), 0, -1);
 366
 367         /* max_size */
 368         config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
 369
 370         /* mark_as_read */
 371         config->mark_as_read = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->mark_as_read));
 372
 373         if (config->process_emails) {
 374                 bogofilter_register_hook();
 375         } else {
 376                 bogofilter_unregister_hook();
 377         }
 378
 379         procmsg_register_spam_learner(bogofilter_learn);
 380         procmsg_spam_set_folder(config->save_folder, bogofilter_get_spam_folder);
 381
 382         bogofilter_save_config();
 383 }
 384
 385 typedef struct _BogoCbData {
 386         gchar *message;
 387         gint total;
 388         gint done;
 389 } BogoCbData;
 390
 391 static gboolean gtk_message_callback(gpointer data)
 392 {
 393         BogoCbData *cbdata = (BogoCbData *)data;
 394
 395         if (cbdata->message)
 396                 statusbar_print_all("%s", cbdata->message);
 397         else if (cbdata->total == 0) {
 398                 statusbar_pop_all();
 399         }
 400         if (cbdata->total && cbdata->done)
 401                 statusbar_progress_all(cbdata->done, cbdata->total, 10);
 402         else
 403                 statusbar_progress_all(0,0,0);
 404         g_free(cbdata->message);
 405         g_free(cbdata);
 406         GTK_EVENTS_FLUSH();
 407         return FALSE;
 408 }
 409
 410 static void gtk_safe_message_callback(gchar *message, gint total, gint done, gboolean thread_safe)
 411 {
 412         BogoCbData *cbdata = g_new0(BogoCbData, 1);
 413         if (message)
 414                 cbdata->message = g_strdup(message);
 415         cbdata->total = total;
 416         cbdata->done = done;
 417         if (thread_safe)
 418                 g_timeout_add(0, gtk_message_callback, cbdata);
 419         else
 420                 gtk_message_callback(cbdata);
 421 }
 422
 423 static struct BogofilterPage bogofilter_page;
 424
 425 gint bogofilter_gtk_init(void)
 426 {
 427         static gchar *path[3];
 428
 429         path[0] = _("Plugins");
 430         path[1] = _("Bogofilter");
 431         path[2] = NULL;
 432
 433         bogofilter_page.page.path = path;
 434         bogofilter_page.page.create_widget = bogofilter_create_widget_func;
 435         bogofilter_page.page.destroy_widget = bogofilter_destroy_widget_func;
 436         bogofilter_page.page.save_page = bogofilter_save_func;
 437         bogofilter_page.page.weight = 35.0;
 438
 439         prefs_gtk_register_page((PrefsPage *) &bogofilter_page);
 440         bogofilter_set_message_callback(gtk_safe_message_callback);
 441
 442         debug_print("Bogofilter GTK plugin loaded\n");
 443         return 0;
 444 }
 445
 446 void bogofilter_gtk_done(void)
 447 {
 448         prefs_gtk_unregister_page((PrefsPage *) &bogofilter_page);
 449 }