2006-08-29 [wwp] 2.4.0cvs110
[claws.git] / src / plugins / spamassassin / spamassassin.c
index 755e20d754d46b443c24ed69d7c9246a8ec02579..23085ac19e9033323e3c3503021806b5aa1c5e95 100644 (file)
@@ -48,6 +48,7 @@
 #include "inc.h"
 #include "log.h"
 #include "prefs_common.h"
+#include "alertpanel.h"
 
 #ifdef HAVE_SYSEXITS_H
 #include <sysexits.h>
@@ -83,6 +84,8 @@ static MessageCallback message_callback;
 static SpamAssassinConfig config;
 
 static PrefParam param[] = {
+       {"enable", "FALSE", &config.enable, P_BOOL,
+       NULL, NULL, NULL},
        {"transport", "0", &config.transport, P_INT,
         NULL, NULL, NULL},
        {"hostname", "localhost", &config.hostname, P_STRING,
@@ -118,12 +121,21 @@ gboolean timeout_func(gpointer data)
        return FALSE;
 }
 
-static gboolean msg_is_spam(FILE *fp)
+typedef enum {
+       MSG_IS_HAM = 0,
+       MSG_IS_SPAM = 1,
+       MSG_FILTERING_ERROR = 2
+} MsgStatus;
+
+static MsgStatus msg_is_spam(FILE *fp)
 {
        struct transport trans;
        struct message m;
        gboolean is_spam = FALSE;
 
+       if (!config.enable)
+               return MSG_IS_HAM;
+
        transport_init(&trans);
        switch (config.transport) {
        case SPAMASSASSIN_TRANSPORT_LOCALHOST:
@@ -140,13 +152,13 @@ static gboolean msg_is_spam(FILE *fp)
                trans.socketpath = config.socket;
                break;
        default:
-               return FALSE;
+               return MSG_IS_HAM;
        }
 
        if (transport_setup(&trans, flags) != EX_OK) {
-               log_error("Spamassassin plugin couldn't connect to spamd.\n");
+               log_error(_("SpamAssassin plugin couldn't connect to spamd.\n"));
                debug_print("failed to setup transport\n");
-               return FALSE;
+               return MSG_FILTERING_ERROR;
        }
 
        m.type = MESSAGE_NONE;
@@ -156,13 +168,14 @@ static gboolean msg_is_spam(FILE *fp)
        if (message_read(fileno(fp), flags, &m) != EX_OK) {
                debug_print("failed to read message\n");
                message_cleanup(&m);
-               return FALSE;
+               return MSG_FILTERING_ERROR;
        }
 
        if (message_filter(&trans, config.username, flags, &m) != EX_OK) {
+               log_error(_("SpamAssassin plugin filtering failed.\n"));
                debug_print("filtering the message failed\n");
                message_cleanup(&m);
-               return FALSE;
+               return MSG_FILTERING_ERROR;
        }
 
        if (m.is_spam == EX_ISSPAM)
@@ -170,20 +183,22 @@ static gboolean msg_is_spam(FILE *fp)
 
        message_cleanup(&m);
 
-       return is_spam;
+       return is_spam ? MSG_IS_SPAM:MSG_IS_HAM;
 }
 
 static gboolean mail_filtering_hook(gpointer source, gpointer data)
 {
        MailFilteringData *mail_filtering_data = (MailFilteringData *) source;
        MsgInfo *msginfo = mail_filtering_data->msginfo;
-       gboolean is_spam = FALSE;
+       gboolean is_spam = FALSE, error = FALSE;
+       static gboolean warned_error = FALSE;
        FILE *fp = NULL;
        int pid = 0;
        int status;
 
-       if (config.transport == SPAMASSASSIN_DISABLED) {
-               log_error("Spamassassin plugin is disabled by its preferences.\n");
+       /* SPAMASSASSIN_DISABLED : keep test for compatibility purpose */
+       if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
+               log_error(_("SpamAssassin plugin is disabled by its preferences.\n"));
                return FALSE;
        }
        debug_print("Filtering message %d\n", msginfo->msgnum);
@@ -197,7 +212,7 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
 
        pid = fork();
        if (pid == 0) {
-               _exit(msg_is_spam(fp) ? 1 : 0);
+               _exit(msg_is_spam(fp));
        } else {
                gint running = 0;
 
@@ -212,8 +227,11 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
                        ret = waitpid(pid, &status, WNOHANG);
                        if (ret == pid) {
                                if (WIFEXITED(status)) {
+                                       MsgStatus result = MSG_IS_HAM;
                                        running &= ~CHILD_RUNNING;
-                                       is_spam = WEXITSTATUS(status) == 1 ? TRUE : FALSE;
+                                       result = WEXITSTATUS(status);
+                                       is_spam = (result == MSG_IS_SPAM) ? TRUE : FALSE;
+                                       error = (result == MSG_FILTERING_ERROR);
                                }
                        } if (ret < 0) {
                                running &= ~CHILD_RUNNING;
@@ -251,6 +269,24 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
                debug_print("message is ham\n");
                procmsg_msginfo_unset_flags(msginfo, MSG_SPAM, 0);
        }
+       
+       if (error) {
+               gchar *msg = _("The SpamAssassin plugin couldn't filter "
+                                          "a message. The probable cause of the error "
+                                          "is an unreachable spamd daemon. Please make "
+                                          "sure spamd is running and accessible.");
+               if (!prefs_common.no_recv_err_panel) {
+                       if (!warned_error) {
+                               alertpanel_error(msg);
+                       }
+                       warned_error = TRUE;
+               } else {
+                       gchar *tmp = g_strdup_printf("%s\n", msg);
+                       log_error(tmp);
+                       g_free(tmp);
+               }
+       }
+       
        return FALSE;
 }
 
@@ -263,7 +299,6 @@ gchar* spamassassin_create_tmp_spamc_wrapper(gboolean spam)
 {
        gchar *contents;
        gchar *fname = get_tmp_file();
-       GError *err;
 
        if (fname != NULL) {
                contents = g_strdup_printf(
@@ -271,10 +306,7 @@ gchar* spamassassin_create_tmp_spamc_wrapper(gboolean spam)
                                                config.hostname, config.port, 
                                                config.username, config.timeout,
                                                config.max_size * 1024, spam?"spam":"ham");
-               if (!g_file_set_contents(fname, contents,
-                                                       strlen(contents), &err)) {
-                       g_warning(err->message);
-                       g_error_free(err);
+               if (str_write_to_file(contents, fname) < 0) {
                        g_free(fname);
                        fname = NULL;
                }
@@ -288,7 +320,6 @@ int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
 {
        gchar *cmd = NULL;
        gchar *file = NULL;
-       gboolean async = FALSE;
        const gchar *shell = g_getenv("SHELL");
        gchar *spamc_wrapper = NULL;
 
@@ -298,7 +329,9 @@ int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
 
        if (config.transport == SPAMASSASSIN_TRANSPORT_TCP
        &&  prefs_common.work_offline
-       &&  !inc_offline_should_override()) {
+       &&  !inc_offline_should_override(
+               _("Sylpheed-Claws needs network access in order "
+                 "to feed this mail(s) to the remote learner."))) {
                return -1;
        }
 
@@ -340,16 +373,12 @@ int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
                                        tmpcmd = g_strconcat(shell?shell:"sh", " ", spamc_wrapper, " ",
                                                                                tmpfile, NULL);
                                        debug_print("%s\n", tmpcmd);
-                                       execute_command_line(tmpcmd, TRUE);
+                                       execute_command_line(tmpcmd, FALSE);
                                        g_free(tmpcmd);
                                }
-                               if (tmpfile != NULL) {
-                                       g_free(tmpfile);
-                               }
-                       }
-                       if (spamc_wrapper != NULL) {
-                               g_free(spamc_wrapper);
+                               g_free(tmpfile);
                        }
+                       g_free(spamc_wrapper);
                        return 0;
                } else {
                        cmd = g_strdup_printf("sa-learn -u %s %s %s",
@@ -369,25 +398,19 @@ int spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
                                        g_free(cmd);
                                        cmd = tmpcmd;
                                }
-                               if (tmpfile != NULL) {
-                                       g_free(tmpfile);
-                               }
+                               g_free(tmpfile);
                        }
-                       async = TRUE;
                }
        }
        if (cmd == NULL) {
                return -1;
        }
        debug_print("%s\n", cmd);
-       /* only run async if we have a list, or we could end up
-        * forking lots of perl processes and bury the machine */
-       
-       execute_command_line(cmd, async);
+       /* only run sync calls to sa-learn/spamc to prevent system lockdown */
+       execute_command_line(cmd, FALSE);
        g_free(cmd);
-       if (spamc_wrapper != NULL) {
-               g_free(spamc_wrapper);
-       }
+       g_free(spamc_wrapper);
+
        return 0;
 }
 
@@ -461,17 +484,16 @@ gint plugin_init(gchar **error)
        }
        spamassassin_gtk_init();
                
-       debug_print("Spamassassin plugin loaded\n");
+       debug_print("SpamAssassin plugin loaded\n");
 
        if (config.process_emails) {
                spamassassin_register_hook();
        }
 
-       if (config.transport == SPAMASSASSIN_DISABLED) {
-               log_error("Spamassassin plugin is loaded but disabled by its preferences.\n");
+       if (!config.enable || config.transport == SPAMASSASSIN_DISABLED) {
+               log_error(_("SpamAssassin plugin is loaded but disabled by its preferences.\n"));
        }
-
-       if (config.transport != SPAMASSASSIN_DISABLED) {
+       else {
                if (config.transport == SPAMASSASSIN_TRANSPORT_TCP)
                        debug_print("Enabling learner with a remote spamassassin server requires spamc/spamd 3.1.x\n");
                procmsg_register_spam_learner(spamassassin_learn);
@@ -492,7 +514,7 @@ void plugin_done(void)
        spamassassin_gtk_done();
        procmsg_unregister_spam_learner(spamassassin_learn);
        procmsg_spam_set_folder(NULL);
-       debug_print("Spamassassin plugin unloaded\n");
+       debug_print("SpamAssassin plugin unloaded\n");
 }
 
 const gchar *plugin_name(void)
@@ -502,14 +524,17 @@ const gchar *plugin_name(void)
 
 const gchar *plugin_desc(void)
 {
-       return _("This plugin checks all messages that are received from an "
+       return _("This plugin can check all messages that are received from an "
                 "IMAP, LOCAL or POP account for spam using a SpamAssassin "
                 "server. You will need a SpamAssassin Server (spamd) running "
                 "somewhere.\n"
                 "\n"
+                "It can also be used for marking messages as Ham or Spam.\n"
+                "\n"
                 "When a message is identified as spam it can be deleted or "
-                "saved into a special folder.\n"
-                "\n");
+                "saved in a specially designated folder.\n"
+                "\n"
+                "Options can be found in /Configuration/Preferences/Plugins/SpamAssassin");
 }
 
 const gchar *plugin_type(void)
@@ -527,6 +552,15 @@ const gchar *plugin_version(void)
        return VERSION;
 }
 
+struct PluginFeature *plugin_provides(void)
+{
+       static struct PluginFeature features[] = 
+               { {PLUGIN_FILTERING, N_("Spam detection")},
+                 {PLUGIN_FILTERING, N_("Spam learning")},
+                 {PLUGIN_NOTHING, NULL}};
+       return features;
+}
+
 void spamassassin_register_hook(void)
 {
        hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST, mail_filtering_hook, NULL);