2006-04-06 [mones] 2.1.0cvs7
[claws.git] / src / plugins / spamassassin / spamassassin.c
index 16891120fe34af2347ff024b452af91705c7fa3e..9ac5dcf1d675de169afe3688aef6865921769d05 100644 (file)
@@ -45,6 +45,7 @@
 
 #include "libspamc.h"
 #include "spamassassin.h"
+#include "inc.h"
 #include "log.h"
 #include "prefs_common.h"
 
@@ -82,6 +83,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,
@@ -123,6 +126,9 @@ static gboolean msg_is_spam(FILE *fp)
        struct message m;
        gboolean is_spam = FALSE;
 
+       if (!config.enable)
+               return FALSE;
+
        transport_init(&trans);
        switch (config.transport) {
        case SPAMASSASSIN_TRANSPORT_LOCALHOST:
@@ -181,7 +187,8 @@ static gboolean mail_filtering_hook(gpointer source, gpointer data)
        int pid = 0;
        int status;
 
-       if (config.transport == SPAMASSASSIN_DISABLED) {
+       /* 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;
        }
@@ -258,24 +265,57 @@ SpamAssassinConfig *spamassassin_get_config(void)
        return &config;
 }
 
-void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
+gchar* spamassassin_create_tmp_spamc_wrapper(gboolean spam)
+{
+       gchar *contents;
+       gchar *fname = get_tmp_file();
+
+       if (fname != NULL) {
+               contents = g_strdup_printf(
+                                               "spamc -d %s -p %u -u %s -t %u -s %u -L %s<\"$*\";exit $?",
+                                               config.hostname, config.port, 
+                                               config.username, config.timeout,
+                                               config.max_size * 1024, spam?"spam":"ham");
+               if (str_write_to_file(contents, fname) < 0) {
+                       g_free(fname);
+                       fname = NULL;
+               }
+               g_free(contents);
+       }
+       /* returned pointer must be free'ed by caller */
+       return fname;
+}
+
+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;
 
-       if (msginfo == NULL && msglist == NULL)
-               return;
+       if (msginfo == NULL && msglist == NULL) {
+               return -1;
+       }
+
+       if (config.transport == SPAMASSASSIN_TRANSPORT_TCP
+       &&  prefs_common.work_offline
+       &&  !inc_offline_should_override(
+               _("Sylpheed-Claws needs network access in order "
+                 "to feed this mail(s) to the remote learner."))) {
+               return -1;
+       }
 
        if (msginfo) {
                file = procmsg_get_message_file(msginfo);
-               if (file == NULL)
-                       return;
+               if (file == NULL) {
+                       return -1;
+               }
                if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
-                       cmd = g_strdup_printf("spamc -d %s -p %u -u %s -t %u -s %u -L %s < %s",
-                                                       config.hostname, config.port, 
-                                                       config.username, config.timeout,
-                                                       config.max_size * 1024, spam?"spam":"ham", file);
+                       spamc_wrapper = spamassassin_create_tmp_spamc_wrapper(spam);
+                       if (spamc_wrapper != NULL) {
+                               cmd = g_strconcat(shell?shell:"sh", " ",
+                                                               spamc_wrapper, " ", file, NULL);
+                       }
                } else {
                        cmd = g_strdup_printf("sa-learn -u %s %s %s %s",
                                                        config.username,
@@ -288,29 +328,28 @@ void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
                MsgInfo *info;
 
                if (config.transport == SPAMASSASSIN_TRANSPORT_TCP) {
-                       cmd = g_strdup_printf("spamc -d %s -p %u -u %s -t %u -s %u -L %s",
-                                                       config.hostname, config.port,
-                                                       config.username, config.timeout,
-                                                       config.max_size * 1024, spam?"spam":"ham");
-
                        /* execute n-times the spamc command */
                        for (; cur; cur = cur->next) {
                                info = (MsgInfo *)cur->data;
                                gchar *tmpcmd = NULL;
                                gchar *tmpfile = get_tmp_file();
 
-                               if (tmpfile &&
-                               copy_file(procmsg_get_message_file(info), tmpfile, TRUE) == 0) {                        
-                                       tmpcmd = g_strconcat(cmd, " < ", tmpfile, NULL);
+                               if (spamc_wrapper == NULL) {
+                                       spamc_wrapper = spamassassin_create_tmp_spamc_wrapper(spam);
+                               }
+
+                               if (spamc_wrapper && tmpfile &&
+                               copy_file(procmsg_get_message_file(info), tmpfile, TRUE) == 0) {
+                                       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)
-                                       g_free(tmpfile);
+                               g_free(tmpfile);
                        }
-                       g_free(cmd);
-                       return;
+                       g_free(spamc_wrapper);
+                       return 0;
                } else {
                        cmd = g_strdup_printf("sa-learn -u %s %s %s",
                                        config.username,
@@ -329,20 +368,20 @@ void spamassassin_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam)
                                        g_free(cmd);
                                        cmd = tmpcmd;
                                }
-                               if (tmpfile)
-                                       g_free(tmpfile);
+                               g_free(tmpfile);
                        }
-                       async = TRUE;
                }
        }
-       if (cmd == NULL)
-               return;
+       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);
+       g_free(spamc_wrapper);
+
+       return 0;
 }
 
 void spamassassin_save_config(void)
@@ -421,11 +460,10 @@ gint plugin_init(gchar **error)
                spamassassin_register_hook();
        }
 
-       if (config.transport == SPAMASSASSIN_DISABLED) {
+       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);
@@ -456,14 +494,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)