0.9.4claws58
[claws.git] / src / plugins / spamassassin / spamassassin_gtk.c
index 87088fb7ac42aa2421c0e0958b35229ab265e7ff..3a2bddf518cf0dfdee3394c6f0ad910becebf711 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2002 Hiroyuki Yamamoto and the Sylpheed-Claws Team
+ * Copyright (C) 1999-2003 Hiroyuki Yamamoto and the Sylpheed-Claws 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
 #include <glib.h>
 #include <gtk/gtk.h>
 
+#include "common/sylpheed.h"
+#include "common/version.h"
 #include "intl.h"
 #include "plugin.h"
 #include "common/utils.h"
 #include "prefs.h"
 #include "folder.h"
-#include "prefswindow.h"
+#include "prefs_gtk.h"
 #include "foldersel.h"
 #include "spamassassin.h"
 
@@ -42,9 +44,10 @@ struct SpamAssassinPage
        GtkWidget *enable;
        GtkWidget *hostname;
        GtkWidget *port;
-       GtkWidget *max_size;
        GtkWidget *receive_spam;
        GtkWidget *save_folder;
+       GtkWidget *max_size;
+       GtkWidget *timeout
 };
 
 static void foldersel_cb(GtkWidget *widget, gpointer data)
@@ -62,72 +65,65 @@ static void foldersel_cb(GtkWidget *widget, gpointer data)
        }
 }
 
-static void spamassassin_create_widget_func(PrefsPage * _page)
+static void spamassassin_create_widget_func(PrefsPage * _page,
+                                           GtkWindow * window,
+                                           gpointer data)
 {
        struct SpamAssassinPage *page = (struct SpamAssassinPage *) _page;
+       SpamAssassinConfig *config;
 
-       /* ------------------ code made by glade -------------------- */
+       /*
+        * BEGIN GLADE CODE
+        * DO NOT EDIT
+        */
        GtkWidget *table1;
        GtkWidget *label3;
        GtkWidget *label4;
-       GtkWidget *label6;
-       GtkWidget *label8;
-       GtkWidget *label9;
        GtkWidget *hbox1;
        GtkWidget *hostname;
        GtkWidget *label5;
        GtkObject *port_adj;
        GtkWidget *port;
        GtkWidget *enable;
+       GtkWidget *label9;
        GtkWidget *receive_spam;
-       GtkWidget *label10;
-       GtkObject *max_size_adj;
-       GtkWidget *max_size;
+       GtkWidget *label8;
        GtkWidget *save_folder;
        GtkWidget *button4;
+       GtkWidget *label6;
+       GtkWidget *hbox3;
+       GtkObject *max_size_adj;
+       GtkWidget *max_size;
        GtkWidget *label11;
+       GtkWidget *label12;
+       GtkWidget *label13;
+       GtkWidget *hbox4;
+       GtkObject *timeout_adj;
+       GtkWidget *timeout;
+       GtkTooltips *tooltips;
+
+       tooltips = gtk_tooltips_new();
 
        table1 = gtk_table_new(6, 3, FALSE);
        gtk_widget_show(table1);
+       gtk_container_set_border_width(GTK_CONTAINER(table1), 8);
        gtk_table_set_row_spacings(GTK_TABLE(table1), 4);
        gtk_table_set_col_spacings(GTK_TABLE(table1), 8);
 
-       label3 = gtk_label_new(_("Enable SpamAssassin Filtering"));
+       label3 = gtk_label_new(_("Enable"));
        gtk_widget_show(label3);
        gtk_table_attach(GTK_TABLE(table1), label3, 0, 1, 0, 1,
                         (GtkAttachOptions) (GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
        gtk_misc_set_alignment(GTK_MISC(label3), 0, 0.5);
 
-       label4 = gtk_label_new(_("SpamAssassin Server (spamd)"));
+       label4 = gtk_label_new(_("spamd "));
        gtk_widget_show(label4);
        gtk_table_attach(GTK_TABLE(table1), label4, 0, 1, 1, 2,
                         (GtkAttachOptions) (GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
        gtk_misc_set_alignment(GTK_MISC(label4), 0, 0.5);
 
-       label6 = gtk_label_new(_("Maximum Message Size"));
-       gtk_widget_show(label6);
-       gtk_table_attach(GTK_TABLE(table1), label6, 0, 1, 2, 3,
-                        (GtkAttachOptions) (GTK_FILL),
-                        (GtkAttachOptions) (0), 0, 0);
-       gtk_misc_set_alignment(GTK_MISC(label6), 0, 0.5);
-
-       label8 = gtk_label_new(_("Folder for saved Spam"));
-       gtk_widget_show(label8);
-       gtk_table_attach(GTK_TABLE(table1), label8, 0, 1, 4, 5,
-                        (GtkAttachOptions) (GTK_FILL),
-                        (GtkAttachOptions) (0), 0, 0);
-       gtk_label_set_justify(GTK_LABEL(label8), GTK_JUSTIFY_LEFT);
-       gtk_misc_set_alignment(GTK_MISC(label8), 0, 0.5);
-
-       label9 = gtk_label_new(_("Receive Spam"));
-       gtk_widget_show(label9);
-       gtk_table_attach(GTK_TABLE(table1), label9, 0, 1, 3, 4,
-                        (GtkAttachOptions) (GTK_FILL),
-                        (GtkAttachOptions) (0), 0, 0);
-       gtk_misc_set_alignment(GTK_MISC(label9), 0, 0.5);
-
        hbox1 = gtk_hbox_new(FALSE, 0);
        gtk_widget_show(hbox1);
        gtk_table_attach(GTK_TABLE(table1), hbox1, 1, 2, 1, 2,
@@ -137,6 +133,9 @@ static void spamassassin_create_widget_func(PrefsPage * _page)
        hostname = gtk_entry_new();
        gtk_widget_show(hostname);
        gtk_box_pack_start(GTK_BOX(hbox1), hostname, TRUE, TRUE, 0);
+       gtk_tooltips_set_tip(tooltips, hostname,
+                            _("Hostname or IP address of spamd server"),
+                            NULL);
 
        label5 = gtk_label_new(_(":"));
        gtk_widget_show(label5);
@@ -144,10 +143,12 @@ static void spamassassin_create_widget_func(PrefsPage * _page)
        gtk_misc_set_padding(GTK_MISC(label5), 8, 0);
 
        port_adj = gtk_adjustment_new(783, 1, 65535, 1, 10, 10);
-       port =
-           gtk_spin_button_new(GTK_ADJUSTMENT(port_adj), 1, 0);
+       port = gtk_spin_button_new(GTK_ADJUSTMENT(port_adj), 1, 0);
        gtk_widget_show(port);
-       gtk_box_pack_start(GTK_BOX(hbox1), port, FALSE, TRUE, 0);
+       gtk_box_pack_end(GTK_BOX(hbox1), port, FALSE, TRUE, 0);
+       gtk_widget_set_usize(port, 64, -2);
+       gtk_tooltips_set_tip(tooltips, port, _("Port of spamd server"),
+                            NULL);
        gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(port), TRUE);
 
        enable = gtk_check_button_new_with_label("");
@@ -155,66 +156,136 @@ static void spamassassin_create_widget_func(PrefsPage * _page)
        gtk_table_attach(GTK_TABLE(table1), enable, 1, 2, 0, 1,
                         (GtkAttachOptions) (GTK_EXPAND | GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
+       gtk_tooltips_set_tip(tooltips, enable,
+                            _("Enable SpamAssassin filtering"), NULL);
+
+       label9 = gtk_label_new(_("Save Spam"));
+       gtk_widget_show(label9);
+       gtk_table_attach(GTK_TABLE(table1), label9, 0, 1, 2, 3,
+                        (GtkAttachOptions) (GTK_FILL),
+                        (GtkAttachOptions) (0), 0, 0);
+       gtk_misc_set_alignment(GTK_MISC(label9), 0, 0.5);
 
        receive_spam = gtk_check_button_new_with_label("");
        gtk_widget_show(receive_spam);
-       gtk_table_attach(GTK_TABLE(table1), receive_spam, 1, 2, 3, 4,
+       gtk_table_attach(GTK_TABLE(table1), receive_spam, 1, 2, 2, 3,
                         (GtkAttachOptions) (GTK_EXPAND | GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
+       gtk_tooltips_set_tip(tooltips, receive_spam,
+                            _
+                            ("Save mails that where identified as spam to a folder"),
+                            NULL);
 
-       label10 =
-           gtk_label_new(_
-                         ("Leave empty to use the default trash folder"));
-       gtk_widget_show(label10);
-       gtk_table_attach(GTK_TABLE(table1), label10, 1, 2, 5, 6,
+       label8 = gtk_label_new(_("Save Folder"));
+       gtk_widget_show(label8);
+       gtk_table_attach(GTK_TABLE(table1), label8, 0, 1, 3, 4,
                         (GtkAttachOptions) (GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
-       gtk_label_set_justify(GTK_LABEL(label10), GTK_JUSTIFY_RIGHT);
-       gtk_misc_set_alignment(GTK_MISC(label10), 1, 0.5);
-
-       max_size_adj = gtk_adjustment_new(250, 0, 10000, 10, 10, 10);
-       max_size = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_adj), 1, 0);
-       gtk_widget_show(max_size);
-       gtk_table_attach(GTK_TABLE(table1), max_size, 1, 2, 2, 3,
-                        (GtkAttachOptions) (GTK_EXPAND | GTK_FILL),
-                        (GtkAttachOptions) (0), 0, 0);
+       gtk_label_set_justify(GTK_LABEL(label8), GTK_JUSTIFY_LEFT);
+       gtk_misc_set_alignment(GTK_MISC(label8), 0, 0.5);
 
        save_folder = gtk_entry_new();
        gtk_widget_show(save_folder);
-       gtk_table_attach(GTK_TABLE(table1), save_folder, 1, 2, 4, 5,
+       gtk_table_attach(GTK_TABLE(table1), save_folder, 1, 2, 3, 4,
                         (GtkAttachOptions) (GTK_EXPAND | GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
+       gtk_tooltips_set_tip(tooltips, save_folder,
+                            _
+                            ("Folder that will be used to save spam. Leave empty to use the default trash folder"),
+                            NULL);
 
        button4 = gtk_button_new_with_label(_("..."));
        gtk_widget_show(button4);
-       gtk_table_attach(GTK_TABLE(table1), button4, 2, 3, 4, 5,
+       gtk_table_attach(GTK_TABLE(table1), button4, 2, 3, 3, 4,
                         (GtkAttachOptions) (GTK_SHRINK | GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
 
+       label6 = gtk_label_new(_("Maximum Size"));
+       gtk_widget_show(label6);
+       gtk_table_attach(GTK_TABLE(table1), label6, 0, 1, 4, 5,
+                        (GtkAttachOptions) (GTK_FILL),
+                        (GtkAttachOptions) (0), 0, 0);
+       gtk_misc_set_alignment(GTK_MISC(label6), 0, 0.5);
+
+       hbox3 = gtk_hbox_new(FALSE, 0);
+       gtk_widget_show(hbox3);
+       gtk_table_attach(GTK_TABLE(table1), hbox3, 1, 2, 4, 5,
+                        (GtkAttachOptions) (GTK_EXPAND | GTK_FILL),
+                        (GtkAttachOptions) (GTK_FILL), 0, 0);
+
+       max_size_adj = gtk_adjustment_new(250, 0, 10000, 10, 10, 10);
+       max_size = gtk_spin_button_new(GTK_ADJUSTMENT(max_size_adj), 1, 0);
+       gtk_widget_show(max_size);
+       gtk_box_pack_end(GTK_BOX(hbox3), max_size, FALSE, TRUE, 0);
+       gtk_widget_set_usize(max_size, 64, -2);
+       gtk_tooltips_set_tip(tooltips, max_size,
+                            _
+                            ("Maximum size a message is allowed to have to be checked"),
+                            NULL);
+       gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(max_size), TRUE);
+
        label11 = gtk_label_new(_("kB"));
        gtk_widget_show(label11);
-       gtk_table_attach(GTK_TABLE(table1), label11, 2, 3, 2, 3,
+       gtk_table_attach(GTK_TABLE(table1), label11, 2, 3, 4, 5,
                         (GtkAttachOptions) (GTK_FILL),
                         (GtkAttachOptions) (0), 0, 0);
        gtk_misc_set_alignment(GTK_MISC(label11), 0, 0.5);
-       /* --------------------------------------------------------- */
 
-       gtk_widget_set_usize(GTK_WIDGET(port), 64, -1);
+       label12 = gtk_label_new(_("Timeout"));
+       gtk_widget_show(label12);
+       gtk_table_attach(GTK_TABLE(table1), label12, 0, 1, 5, 6,
+                        (GtkAttachOptions) (GTK_FILL),
+                        (GtkAttachOptions) (0), 0, 0);
+       gtk_misc_set_alignment(GTK_MISC(label12), 0, 0.5);
+
+       label13 = gtk_label_new(_("s"));
+       gtk_widget_show(label13);
+       gtk_table_attach(GTK_TABLE(table1), label13, 2, 3, 5, 6,
+                        (GtkAttachOptions) (GTK_FILL),
+                        (GtkAttachOptions) (0), 0, 0);
+       gtk_misc_set_alignment(GTK_MISC(label13), 0, 0.5);
+
+       hbox4 = gtk_hbox_new(FALSE, 0);
+       gtk_widget_show(hbox4);
+       gtk_table_attach(GTK_TABLE(table1), hbox4, 1, 2, 5, 6,
+                        (GtkAttachOptions) (GTK_FILL),
+                        (GtkAttachOptions) (GTK_FILL), 0, 0);
+
+       timeout_adj = gtk_adjustment_new(30, 5, 300, 1, 1, 1);
+       timeout = gtk_spin_button_new(GTK_ADJUSTMENT(timeout_adj), 1, 0);
+       gtk_widget_show(timeout);
+       gtk_box_pack_end(GTK_BOX(hbox4), timeout, FALSE, TRUE, 0);
+       gtk_widget_set_usize(timeout, 64, -2);
+       gtk_tooltips_set_tip(tooltips, timeout,
+                            _
+                            ("Maximum time allowed for the spam check. After the time the check will be aborted and the message delivered as none spam."),
+                            NULL);
+       gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(timeout), TRUE);
+       /*
+        * END GLADE CODE
+        */
+
+       config = spamassassin_get_config();
+
        gtk_signal_connect(GTK_OBJECT(button4), "released", GTK_SIGNAL_FUNC(foldersel_cb), page);
 
-       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(enable), spamassassin_enable);
-       gtk_entry_set_text(GTK_ENTRY(hostname), spamassassin_hostname);
-       gtk_spin_button_set_value(GTK_SPIN_BUTTON(port), (float) spamassassin_port);
-       gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size), (float) spamassassin_max_size);
-       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(receive_spam), spamassassin_receive_spam);
-       gtk_entry_set_text(GTK_ENTRY(save_folder), spamassassin_save_folder);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(enable), config->enable);
+       if (config->hostname != NULL)
+               gtk_entry_set_text(GTK_ENTRY(hostname), config->hostname);
+       gtk_spin_button_set_value(GTK_SPIN_BUTTON(port), (float) config->port);
+       gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(receive_spam), config->receive_spam);
+       if (config->save_folder != NULL)
+               gtk_entry_set_text(GTK_ENTRY(save_folder), config->save_folder);
+       gtk_spin_button_set_value(GTK_SPIN_BUTTON(max_size), (float) config->max_size);
+       gtk_spin_button_set_value(GTK_SPIN_BUTTON(timeout), (float) config->timeout);
        
        page->enable = enable;
        page->hostname = hostname;
        page->port = port;
-       page->max_size = max_size;
        page->receive_spam = receive_spam;
        page->save_folder = save_folder;
+       page->max_size = max_size;
+       page->timeout = timeout;
 
        page->page.widget = table1;
 }
@@ -227,71 +298,93 @@ static void spamassassin_destroy_widget_func(PrefsPage *_page)
 static void spamassassin_save_func(PrefsPage *_page)
 {
        struct SpamAssassinPage *page = (struct SpamAssassinPage *) _page;
-       gchar *tmp;
+       SpamAssassinConfig *config;
 
        debug_print("Saving SpamAssassin Page\n");
 
-       spamassassin_enable = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->enable));
-       if (spamassassin_hostname)
-               g_free(spamassassin_hostname);
-       spamassassin_hostname = gtk_editable_get_chars(GTK_EDITABLE(page->hostname), 0, -1);
-       tmp = gtk_editable_get_chars(GTK_EDITABLE(page->port), 0, -1);
-       spamassassin_port = atoi(tmp);
-       g_free(tmp);
-       spamassassin_max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
-       spamassassin_receive_spam = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->receive_spam));
-       if (spamassassin_save_folder)
-               g_free(spamassassin_save_folder);
-       spamassassin_save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
+       config = spamassassin_get_config();
+
+       /* enable */
+       config->enable = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->enable));
+
+       /* hostname */
+       g_free(config->hostname);
+       config->hostname = gtk_editable_get_chars(GTK_EDITABLE(page->hostname), 0, -1);
+
+       /* port */
+       config->port = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->port));
+
+       /* receive_spam */
+       config->receive_spam = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(page->receive_spam));
+
+       /* save_folder */
+       g_free(config->save_folder);
+       config->save_folder = gtk_editable_get_chars(GTK_EDITABLE(page->save_folder), 0, -1);
+
+       /* max_size */
+       config->max_size = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->max_size));
+
+       /* timeout */
+       config->timeout = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(page->timeout));
 
        spamassassin_save_config();
 }
 
-static void spamassassin_destroy_func(PrefsPage *_page)
-{
-       debug_print("Destroying SpamAssassin Page\n");
-       g_free(_page);
-}
+static struct SpamAssassinPage spamassassin_page;
 
 gint plugin_init(gchar **error)
 {
-       struct SpamAssassinPage *page;
+       if ((sylpheed_get_version() > VERSION_NUMERIC)) {
+               *error = g_strdup("Your sylpheed version is newer than the version the plugin was built with");
+               return -1;
+       }
 
-       page = g_new0(struct SpamAssassinPage, 1);
-       page->page.path = _("Filtering/SpamAssassin");
-       page->page.create_widget = spamassassin_create_widget_func;
-       page->page.destroy_widget = spamassassin_destroy_widget_func;
-       page->page.save_page = spamassassin_save_func;
-       page->page.destroy_page = spamassassin_destroy_func;
-       prefswindow_register_new_page((PrefsPage *) page);
+       if ((sylpheed_get_version() < MAKE_NUMERIC_VERSION(0, 9, 3, 86))) {
+               *error = g_strdup("Your sylpheed version is too old");
+               return -1;
+       }
 
-       debug_print("SpamAssassin GTK plugin loaded\n");
+       spamassassin_page.page.path = _("Filtering/SpamAssassin");
+       spamassassin_page.page.create_widget = spamassassin_create_widget_func;
+       spamassassin_page.page.destroy_widget = spamassassin_destroy_widget_func;
+       spamassassin_page.page.save_page = spamassassin_save_func;
+       spamassassin_page.page.weight = 35.0;
+
+       prefs_gtk_register_page((PrefsPage *) &spamassassin_page);
 
+       debug_print("SpamAssassin GTK plugin loaded\n");
        return 0;       
 }
 
-void plugin_done()
+void plugin_done(void)
 {
+       prefs_gtk_unregister_page((PrefsPage *) &spamassassin_page);
+
        debug_print("SpamAssassin GTK plugin unloaded\n");
 }
 
-const gchar *plugin_name()
+const gchar *plugin_name(void)
+{
+       return _("SpamAssassin GTK");
+}
+
+const gchar *plugin_desc(void)
 {
-       return "SpamAssassin GTK";
+       return _("This plugin provides a Preferences page for the SpamAssassin "
+                "plugin.\n"
+                "\n"
+                "You will find the options in the Other Preferences window "
+                "under Filtering/SpamAssassin.\n"
+                "\n"
+                "With this plugin you can enable the filtering, change the "
+                "SpamAssassin server host and port, set the maximum size of "
+                "messages to be checked, (if the message is larger it will "
+                "not be checked), configure whether spam mail should be received "
+                "(default: Yes) and select the folder where spam mail will be "
+                "saved.\n");
 }
 
-const gchar *plugin_desc()
+const gchar *plugin_type(void)
 {
-       return "This plugin provides a Preferences page for the SpamAssassin "
-              "plugin.\n"
-              "\n"
-              "You will find the options in the Preferences window under "
-              "Filtering/SpamAssassin.\n"
-              "\n"
-              "With this plugin you can enable the filtering, change the "
-              "SpamAssassin server's host  and port, the maximum size that "
-              "a message is allowed to have (if the message is larger it "
-              "will not be checked), set the option if spam mails "
-              "should be received at all (default) and select the folder "
-              "where spam mails will be saved.\n";
+       return "GTK";
 }