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